pluggy-sdk 1.0.0.post2__py3-none-any.whl

pluggy_sdk/rest.py

@@ -0,0 +1,258 @@
+# coding: utf-8
+
+"""
+    Pluggy API
+
+    Pluggy's main API to review data and execute connectors
+
+    The version of the OpenAPI document: 1.0.0
+    Contact: hello@pluggy.ai
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import io
+import json
+import re
+import ssl
+
+import urllib3
+
+from pluggy_sdk.exceptions import ApiException, ApiValueError
+
+SUPPORTED_SOCKS_PROXIES = {"socks5", "socks5h", "socks4", "socks4a"}
+RESTResponseType = urllib3.HTTPResponse
+
+
+def is_socks_proxy_url(url):
+    if url is None:
+        return False
+    split_section = url.split("://")
+    if len(split_section) < 2:
+        return False
+    else:
+        return split_section[0].lower() in SUPPORTED_SOCKS_PROXIES
+
+
+class RESTResponse(io.IOBase):
+
+    def __init__(self, resp) -> None:
+        self.response = resp
+        self.status = resp.status
+        self.reason = resp.reason
+        self.data = None
+
+    def read(self):
+        if self.data is None:
+            self.data = self.response.data
+        return self.data
+
+    def getheaders(self):
+        """Returns a dictionary of the response headers."""
+        return self.response.headers
+
+    def getheader(self, name, default=None):
+        """Returns a given response header."""
+        return self.response.headers.get(name, default)
+
+
+class RESTClientObject:
+
+    def __init__(self, configuration) -> 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
+        # 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
+
+        pool_args = {
+            "cert_reqs": cert_reqs,
+            "ca_certs": configuration.ssl_ca_cert,
+            "cert_file": configuration.cert_file,
+            "key_file": configuration.key_file,
+        }
+        if configuration.assert_hostname is not None:
+            pool_args['assert_hostname'] = (
+                configuration.assert_hostname
+            )
+
+        if configuration.retries is not None:
+            pool_args['retries'] = configuration.retries
+
+        if configuration.tls_server_name:
+            pool_args['server_hostname'] = configuration.tls_server_name
+
+
+        if configuration.socket_options is not None:
+            pool_args['socket_options'] = configuration.socket_options
+
+        if configuration.connection_pool_maxsize is not None:
+            pool_args['maxsize'] = configuration.connection_pool_maxsize
+
+        # https pool manager
+        self.pool_manager: urllib3.PoolManager
+
+        if configuration.proxy:
+            if is_socks_proxy_url(configuration.proxy):
+                from urllib3.contrib.socks import SOCKSProxyManager
+                pool_args["proxy_url"] = configuration.proxy
+                pool_args["headers"] = configuration.proxy_headers
+                self.pool_manager = SOCKSProxyManager(**pool_args)
+            else:
+                pool_args["proxy_url"] = configuration.proxy
+                pool_args["proxy_headers"] = configuration.proxy_headers
+                self.pool_manager = urllib3.ProxyManager(**pool_args)
+        else:
+            self.pool_manager = urllib3.PoolManager(**pool_args)
+
+    def request(
+        self,
+        method,
+        url,
+        headers=None,
+        body=None,
+        post_params=None,
+        _request_timeout=None
+    ):
+        """Perform requests.
+
+        :param method: http request method
+        :param url: http request 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 _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)):
+                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']:
+
+                # no content type provided or payload is json
+                content_type = headers.get('Content-Type')
+                if (
+                    not content_type
+                    or re.search('json', 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,
+                        timeout=timeout,
+                        headers=headers,
+                        preload_content=False
+                    )
+                elif content_type == 'application/x-www-form-urlencoded':
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        fields=post_params,
+                        encode_multipart=False,
+                        timeout=timeout,
+                        headers=headers,
+                        preload_content=False
+                    )
+                elif 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']
+                    # Ensures that dict objects are serialized
+                    post_params = [(a, json.dumps(b)) if isinstance(b, dict) else (a,b) for a, b in post_params]
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        fields=post_params,
+                        encode_multipart=True,
+                        timeout=timeout,
+                        headers=headers,
+                        preload_content=False
+                    )
+                # 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):
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        body=body,
+                        timeout=timeout,
+                        headers=headers,
+                        preload_content=False
+                    )
+                elif headers['Content-Type'] == 'text/plain' and isinstance(body, bool):
+                    request_body = "true" if body else "false"
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        body=request_body,
+                        preload_content=False,
+                        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={},
+                    timeout=timeout,
+                    headers=headers,
+                    preload_content=False
+                )
+        except urllib3.exceptions.SSLError as e:
+            msg = "\n".join([type(e).__name__, str(e)])
+            raise ApiException(status=0, reason=msg)
+
+        return RESTResponse(r)

pluggy_sdk-1.0.0.post2.dist-info/METADATA

@@ -0,0 +1,336 @@
+Metadata-Version: 2.1
+Name: pluggy-sdk
+Version: 1.0.0.post2
+Summary: Pluggy API
+Home-page: https://github.com/diraol/pluggy-python
+Author: Pluggy
+Author-email: hello@pluggy.ai
+License: MIT
+Keywords: OpenAPI,OpenAPI-Generator,Pluggy API
+Description-Content-Type: text/markdown
+Requires-Dist: urllib3 <2.1.0,>=1.25.3
+Requires-Dist: python-dateutil
+Requires-Dist: pydantic >=2
+Requires-Dist: typing-extensions >=4.7.1
+
+# pluggy-sdk
+Pluggy's main API to review data and execute connectors
+
+This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 1.0.0
+- Package version: 1.0.0.post2
+- Generator version: 7.5.0-SNAPSHOT
+- Build package: org.openapitools.codegen.languages.PythonClientCodegen
+For more information, please visit [https://pluggy.ai](https://pluggy.ai)
+
+## Requirements.
+
+Python 3.7+
+
+## 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/GIT_USER_ID/GIT_REPO_ID.git
+```
+(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
+
+Then import the package:
+```python
+import pluggy_sdk
+```
+
+### 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 pluggy_sdk
+```
+
+### Tests
+
+Execute `pytest` to run the tests.
+
+## Getting Started
+
+Please follow the [installation procedure](#installation--usage) and then run the following:
+
+```python
+
+import pluggy_sdk
+from pluggy_sdk.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to https://api.pluggy.ai
+# See configuration.py for a list of all supported configuration parameters.
+configuration = pluggy_sdk.Configuration(
+    host = "https://api.pluggy.ai"
+)
+
+# 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: default
+configuration.api_key['default'] = os.environ["API_KEY"]
+
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# configuration.api_key_prefix['default'] = 'Bearer'
+
+
+# Enter a context with an instance of the API client
+with pluggy_sdk.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = pluggy_sdk.AccountApi(api_client)
+    item_id = 'd0f8a8c0-e8e3-11e9-b210-d663bd873d93' # str | Item primary identifier
+    type = 'BANK' # str | Parameter to filter between bank accounts and credit accounts (optional)
+
+    try:
+        # List
+        api_response = api_instance.accounts_list(item_id, type=type)
+        print("The response of AccountApi->accounts_list:\n")
+        pprint(api_response)
+    except ApiException as e:
+        print("Exception when calling AccountApi->accounts_list: %s\n" % e)
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.pluggy.ai*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*AccountApi* | [**accounts_list**](docs/AccountApi.md#accounts_list) | **GET** /accounts | List
+*AccountApi* | [**accounts_retrieve**](docs/AccountApi.md#accounts_retrieve) | **GET** /accounts/{id} | Retrieve
+*AcquirerAnticipationApi* | [**acquirer_anticipation_retrieve**](docs/AcquirerAnticipationApi.md#acquirer_anticipation_retrieve) | **GET** /acquirer-anticipations/{id} | Retrieve
+*AcquirerAnticipationApi* | [**acquirer_anticipations_list**](docs/AcquirerAnticipationApi.md#acquirer_anticipations_list) | **GET** /acquirer-anticipations | List
+*AcquirerReceivableApi* | [**acquirer_receivable_retrieve**](docs/AcquirerReceivableApi.md#acquirer_receivable_retrieve) | **GET** /acquirer-receivables/{id} | Retrieve
+*AcquirerReceivableApi* | [**acquirer_receivables_list**](docs/AcquirerReceivableApi.md#acquirer_receivables_list) | **GET** /acquirer-receivables | List
+*AcquirerSaleApi* | [**acquirer_sales_list**](docs/AcquirerSaleApi.md#acquirer_sales_list) | **GET** /acquirer-sales | List
+*AcquirerSaleApi* | [**acquirer_sales_retrieve**](docs/AcquirerSaleApi.md#acquirer_sales_retrieve) | **GET** /acquirer-sales/{id} | Retrieve
+*AuthApi* | [**auth_create**](docs/AuthApi.md#auth_create) | **POST** /auth | Create API Key
+*AuthApi* | [**connect_token_create**](docs/AuthApi.md#connect_token_create) | **POST** /connect_token | Create Connect Token
+*BillApi* | [**bills_list**](docs/BillApi.md#bills_list) | **GET** /bills | List
+*BillApi* | [**bills_retrieve**](docs/BillApi.md#bills_retrieve) | **GET** /bills/{id} | Retrieve
+*BulkPaymentApi* | [**bulk_payment_create**](docs/BulkPaymentApi.md#bulk_payment_create) | **POST** /payments/bulk | Create
+*BulkPaymentApi* | [**bulk_payment_retrieve**](docs/BulkPaymentApi.md#bulk_payment_retrieve) | **GET** /payments/bulk/{id} | Retrieve
+*BulkPaymentApi* | [**bulk_payments_list**](docs/BulkPaymentApi.md#bulk_payments_list) | **GET** /payments/bulk | List
+*CategoryApi* | [**categories_list**](docs/CategoryApi.md#categories_list) | **GET** /categories | List
+*CategoryApi* | [**categories_retrieve**](docs/CategoryApi.md#categories_retrieve) | **GET** /categories/{id} | Retrieve
+*CategoryApi* | [**client_category_rules_create**](docs/CategoryApi.md#client_category_rules_create) | **POST** /categories/rules | Create Category Rule
+*CategoryApi* | [**client_category_rules_list**](docs/CategoryApi.md#client_category_rules_list) | **GET** /categories/rules | List Category Rules
+*ConnectorApi* | [**connector_retrieve**](docs/ConnectorApi.md#connector_retrieve) | **GET** /connectors/{id} | Retrieve
+*ConnectorApi* | [**connectors_list**](docs/ConnectorApi.md#connectors_list) | **GET** /connectors | List
+*ConnectorApi* | [**connectors_validate**](docs/ConnectorApi.md#connectors_validate) | **POST** /connectors/{id}/validate | Validate
+*IdentityApi* | [**identity_find_by_item**](docs/IdentityApi.md#identity_find_by_item) | **GET** /identity | Find by item
+*IdentityApi* | [**identity_retrieve**](docs/IdentityApi.md#identity_retrieve) | **GET** /identity/{id} | Retrieve
+*IncomeReportApi* | [**income_reports_find_by_item**](docs/IncomeReportApi.md#income_reports_find_by_item) | **GET** /income-reports | Find income reports by item
+*InvestmentApi* | [**investment_transactions_list**](docs/InvestmentApi.md#investment_transactions_list) | **GET** /investments/{id}/transactions | List investment transactions
+*InvestmentApi* | [**investments_list**](docs/InvestmentApi.md#investments_list) | **GET** /investments | List
+*InvestmentApi* | [**investments_retrieve**](docs/InvestmentApi.md#investments_retrieve) | **GET** /investments/{id} | Retrieve
+*ItemsApi* | [**items_create**](docs/ItemsApi.md#items_create) | **POST** /items | Create
+*ItemsApi* | [**items_delete**](docs/ItemsApi.md#items_delete) | **DELETE** /items/{id} | Delete
+*ItemsApi* | [**items_retrieve**](docs/ItemsApi.md#items_retrieve) | **GET** /items/{id} | Retrieve
+*ItemsApi* | [**items_send_mfa**](docs/ItemsApi.md#items_send_mfa) | **POST** /items/{id}/mfa | Send MFA
+*ItemsApi* | [**items_update**](docs/ItemsApi.md#items_update) | **PATCH** /items/{id} | Update
+*LoanApi* | [**loans_list**](docs/LoanApi.md#loans_list) | **GET** /loans | List
+*LoanApi* | [**loans_retrieve**](docs/LoanApi.md#loans_retrieve) | **GET** /loans/{id} | Retrieve
+*PaymentCustomerApi* | [**payment_customer_create**](docs/PaymentCustomerApi.md#payment_customer_create) | **POST** /payments/customers | Create
+*PaymentCustomerApi* | [**payment_customer_delete**](docs/PaymentCustomerApi.md#payment_customer_delete) | **DELETE** /payments/customers/{id} | Delete
+*PaymentCustomerApi* | [**payment_customer_retrieve**](docs/PaymentCustomerApi.md#payment_customer_retrieve) | **GET** /payments/customers/{id} | Retrieve
+*PaymentCustomerApi* | [**payment_customer_update**](docs/PaymentCustomerApi.md#payment_customer_update) | **PATCH** /payments/customers/{id} | Update
+*PaymentCustomerApi* | [**payment_customers_list**](docs/PaymentCustomerApi.md#payment_customers_list) | **GET** /payments/customers | List
+*PaymentIntentApi* | [**payment_intent_create**](docs/PaymentIntentApi.md#payment_intent_create) | **POST** /payments/intents | Create
+*PaymentIntentApi* | [**payment_intent_retrieve**](docs/PaymentIntentApi.md#payment_intent_retrieve) | **GET** /payments/intents/{id} | Retrieve
+*PaymentIntentApi* | [**payment_intents_list**](docs/PaymentIntentApi.md#payment_intents_list) | **GET** /payments/intents | List
+*PaymentRecipientApi* | [**payment_recipient_create**](docs/PaymentRecipientApi.md#payment_recipient_create) | **POST** /payments/recipients | Create
+*PaymentRecipientApi* | [**payment_recipient_delete**](docs/PaymentRecipientApi.md#payment_recipient_delete) | **DELETE** /payments/recipients/{id} | Delete
+*PaymentRecipientApi* | [**payment_recipient_institutions_retrieve**](docs/PaymentRecipientApi.md#payment_recipient_institutions_retrieve) | **GET** /payments/recipients/institutions/{id} | Retrieve Institution
+*PaymentRecipientApi* | [**payment_recipient_retrieve**](docs/PaymentRecipientApi.md#payment_recipient_retrieve) | **GET** /payments/recipients/{id} | Retrieve
+*PaymentRecipientApi* | [**payment_recipient_update**](docs/PaymentRecipientApi.md#payment_recipient_update) | **PATCH** /payments/recipients/{id} | Update
+*PaymentRecipientApi* | [**payment_recipients_institution_list**](docs/PaymentRecipientApi.md#payment_recipients_institution_list) | **GET** /payments/recipients/institutions | List Institutions
+*PaymentRecipientApi* | [**payment_recipients_list**](docs/PaymentRecipientApi.md#payment_recipients_list) | **GET** /payments/recipients | List
+*PaymentRequestApi* | [**payment_request_create**](docs/PaymentRequestApi.md#payment_request_create) | **POST** /payments/requests | Create
+*PaymentRequestApi* | [**payment_request_create_pix_qr**](docs/PaymentRequestApi.md#payment_request_create_pix_qr) | **POST** /payments/requests/pix-qr | Create PIX QR payment request
+*PaymentRequestApi* | [**payment_request_delete**](docs/PaymentRequestApi.md#payment_request_delete) | **DELETE** /payments/requests/{id} | Delete
+*PaymentRequestApi* | [**payment_request_retrieve**](docs/PaymentRequestApi.md#payment_request_retrieve) | **GET** /payments/requests/{id} | Retrieve
+*PaymentRequestApi* | [**payment_request_update**](docs/PaymentRequestApi.md#payment_request_update) | **PATCH** /payments/requests/{id} | Update
+*PaymentRequestApi* | [**payment_requests_list**](docs/PaymentRequestApi.md#payment_requests_list) | **GET** /payments/requests | List
+*PortfolioYieldApi* | [**aggregated_portfolio_find_by_item**](docs/PortfolioYieldApi.md#aggregated_portfolio_find_by_item) | **GET** /portfolio/{itemId} | Find aggregated portfolio yield by item
+*PortfolioYieldApi* | [**monthly_portfolio_find_by_item**](docs/PortfolioYieldApi.md#monthly_portfolio_find_by_item) | **GET** /portfolio/{itemId}/monthly | Find monthly portfolio yield by item
+*SmartAccountApi* | [**smart_account_balance_retrieve**](docs/SmartAccountApi.md#smart_account_balance_retrieve) | **GET** /payments/smart-accounts/{id}/balance | Retrieve Balance
+*SmartAccountApi* | [**smart_account_create**](docs/SmartAccountApi.md#smart_account_create) | **POST** /payments/smart-accounts | Create
+*SmartAccountApi* | [**smart_account_retrieve**](docs/SmartAccountApi.md#smart_account_retrieve) | **GET** /payments/smart-accounts/{id} | Retrieve
+*SmartAccountApi* | [**smart_accounts_list**](docs/SmartAccountApi.md#smart_accounts_list) | **GET** /payments/smart-accounts | List
+*TransactionApi* | [**transactions_list**](docs/TransactionApi.md#transactions_list) | **GET** /transactions | List
+*TransactionApi* | [**transactions_retrieve**](docs/TransactionApi.md#transactions_retrieve) | **GET** /transactions/{id} | Retrieve
+*TransactionApi* | [**transactions_update**](docs/TransactionApi.md#transactions_update) | **PATCH** /transactions/{id} | Update
+*WebhookApi* | [**webhooks_create**](docs/WebhookApi.md#webhooks_create) | **POST** /webhooks | Create
+*WebhookApi* | [**webhooks_delete**](docs/WebhookApi.md#webhooks_delete) | **DELETE** /webhooks/{id} | Delete
+*WebhookApi* | [**webhooks_list**](docs/WebhookApi.md#webhooks_list) | **GET** /webhooks | List
+*WebhookApi* | [**webhooks_retrieve**](docs/WebhookApi.md#webhooks_retrieve) | **GET** /webhooks/{id} | Retrieve
+*WebhookApi* | [**webhooks_update**](docs/WebhookApi.md#webhooks_update) | **PATCH** /webhooks/{id} | Update
+
+
+## Documentation For Models
+
+ - [Account](docs/Account.md)
+ - [AccountsList200Response](docs/AccountsList200Response.md)
+ - [AcquirerAnticipation](docs/AcquirerAnticipation.md)
+ - [AcquirerAnticipationData](docs/AcquirerAnticipationData.md)
+ - [AcquirerData](docs/AcquirerData.md)
+ - [AcquirerReceivable](docs/AcquirerReceivable.md)
+ - [AcquirerReceivableData](docs/AcquirerReceivableData.md)
+ - [AcquirerReceivableDataEstablishment](docs/AcquirerReceivableDataEstablishment.md)
+ - [AcquirerReceivableDestinationAccount](docs/AcquirerReceivableDestinationAccount.md)
+ - [AcquirerReceivableRelatedSale](docs/AcquirerReceivableRelatedSale.md)
+ - [AcquirerSale](docs/AcquirerSale.md)
+ - [AcquirerSaleData](docs/AcquirerSaleData.md)
+ - [AcquirerSaleInstallment](docs/AcquirerSaleInstallment.md)
+ - [AcquirerSaleInstallmentData](docs/AcquirerSaleInstallmentData.md)
+ - [Address](docs/Address.md)
+ - [AggregatedPortfolio](docs/AggregatedPortfolio.md)
+ - [AggregatedPortfolioResponse](docs/AggregatedPortfolioResponse.md)
+ - [AssetDistribution](docs/AssetDistribution.md)
+ - [AuthRequest](docs/AuthRequest.md)
+ - [AuthResponse](docs/AuthResponse.md)
+ - [BankData](docs/BankData.md)
+ - [Bill](docs/Bill.md)
+ - [BillFinanceCharge](docs/BillFinanceCharge.md)
+ - [BillsList200Response](docs/BillsList200Response.md)
+ - [BulkPayment](docs/BulkPayment.md)
+ - [BulkPaymentsList200Response](docs/BulkPaymentsList200Response.md)
+ - [Category](docs/Category.md)
+ - [ClientCategoryRule](docs/ClientCategoryRule.md)
+ - [Company](docs/Company.md)
+ - [ConnectTokenRequest](docs/ConnectTokenRequest.md)
+ - [ConnectTokenResponse](docs/ConnectTokenResponse.md)
+ - [Connector](docs/Connector.md)
+ - [ConnectorCredential](docs/ConnectorCredential.md)
+ - [ConnectorHealth](docs/ConnectorHealth.md)
+ - [ConnectorHealthDetails](docs/ConnectorHealthDetails.md)
+ - [ConnectorListResponse](docs/ConnectorListResponse.md)
+ - [ConnectorUserAction](docs/ConnectorUserAction.md)
+ - [CreateBulkPayment](docs/CreateBulkPayment.md)
+ - [CreateClientCategoryRule](docs/CreateClientCategoryRule.md)
+ - [CreateItem](docs/CreateItem.md)
+ - [CreateItemParameters](docs/CreateItemParameters.md)
+ - [CreateOrUpdatePaymentCustomer](docs/CreateOrUpdatePaymentCustomer.md)
+ - [CreatePaymentCustomerRequestBody](docs/CreatePaymentCustomerRequestBody.md)
+ - [CreatePaymentIntent](docs/CreatePaymentIntent.md)
+ - [CreatePaymentRecipient](docs/CreatePaymentRecipient.md)
+ - [CreatePaymentRequest](docs/CreatePaymentRequest.md)
+ - [CreatePixQrPaymentRequest](docs/CreatePixQrPaymentRequest.md)
+ - [CreateSmartAccountRequest](docs/CreateSmartAccountRequest.md)
+ - [CreateWebhook](docs/CreateWebhook.md)
+ - [CredentialSelectOption](docs/CredentialSelectOption.md)
+ - [CreditCardMetadata](docs/CreditCardMetadata.md)
+ - [CreditData](docs/CreditData.md)
+ - [Document](docs/Document.md)
+ - [Email](docs/Email.md)
+ - [GlobalErrorResponse](docs/GlobalErrorResponse.md)
+ - [ICountResponse](docs/ICountResponse.md)
+ - [IdentityRelation](docs/IdentityRelation.md)
+ - [IdentityResponse](docs/IdentityResponse.md)
+ - [IncomeReport](docs/IncomeReport.md)
+ - [IncomeReportsResponse](docs/IncomeReportsResponse.md)
+ - [Investment](docs/Investment.md)
+ - [InvestmentExpenses](docs/InvestmentExpenses.md)
+ - [InvestmentMetadata](docs/InvestmentMetadata.md)
+ - [InvestmentTransaction](docs/InvestmentTransaction.md)
+ - [InvestmentsList200Response](docs/InvestmentsList200Response.md)
+ - [Item](docs/Item.md)
+ - [ItemCreationErrorResponse](docs/ItemCreationErrorResponse.md)
+ - [ItemError](docs/ItemError.md)
+ - [ItemOptions](docs/ItemOptions.md)
+ - [Loan](docs/Loan.md)
+ - [LoanContractedFee](docs/LoanContractedFee.md)
+ - [LoanContractedFinanceCharge](docs/LoanContractedFinanceCharge.md)
+ - [LoanInstallmentBalloonPayment](docs/LoanInstallmentBalloonPayment.md)
+ - [LoanInstallmentBalloonPaymentAmount](docs/LoanInstallmentBalloonPaymentAmount.md)
+ - [LoanInstallments](docs/LoanInstallments.md)
+ - [LoanInterestRate](docs/LoanInterestRate.md)
+ - [LoanPaymentRelease](docs/LoanPaymentRelease.md)
+ - [LoanPaymentReleaseOverParcel](docs/LoanPaymentReleaseOverParcel.md)
+ - [LoanPaymentReleaseOverParcelCharge](docs/LoanPaymentReleaseOverParcelCharge.md)
+ - [LoanPaymentReleaseOverParcelFee](docs/LoanPaymentReleaseOverParcelFee.md)
+ - [LoanPayments](docs/LoanPayments.md)
+ - [LoanWarranty](docs/LoanWarranty.md)
+ - [LoansList200Response](docs/LoansList200Response.md)
+ - [Merchant](docs/Merchant.md)
+ - [MonthlyPortfolio](docs/MonthlyPortfolio.md)
+ - [MonthlyPortfolioResponse](docs/MonthlyPortfolioResponse.md)
+ - [NotAuthenticatedResponse](docs/NotAuthenticatedResponse.md)
+ - [PageResponseAcquirerAnticipations](docs/PageResponseAcquirerAnticipations.md)
+ - [PageResponseAcquirerReceivables](docs/PageResponseAcquirerReceivables.md)
+ - [PageResponseAcquirerSales](docs/PageResponseAcquirerSales.md)
+ - [PageResponseCategoryRules](docs/PageResponseCategoryRules.md)
+ - [PageResponseInvestmentTransactions](docs/PageResponseInvestmentTransactions.md)
+ - [PageResponseTransactions](docs/PageResponseTransactions.md)
+ - [ParameterValidationError](docs/ParameterValidationError.md)
+ - [ParameterValidationResponse](docs/ParameterValidationResponse.md)
+ - [PaymentCustomer](docs/PaymentCustomer.md)
+ - [PaymentCustomersList200Response](docs/PaymentCustomersList200Response.md)
+ - [PaymentData](docs/PaymentData.md)
+ - [PaymentDataParticipant](docs/PaymentDataParticipant.md)
+ - [PaymentInstitution](docs/PaymentInstitution.md)
+ - [PaymentIntent](docs/PaymentIntent.md)
+ - [PaymentIntentsList200Response](docs/PaymentIntentsList200Response.md)
+ - [PaymentRecipient](docs/PaymentRecipient.md)
+ - [PaymentRecipientAccount](docs/PaymentRecipientAccount.md)
+ - [PaymentRecipientsInstitutionList200Response](docs/PaymentRecipientsInstitutionList200Response.md)
+ - [PaymentRecipientsList200Response](docs/PaymentRecipientsList200Response.md)
+ - [PaymentRequest](docs/PaymentRequest.md)
+ - [PaymentRequestCallbackUrls](docs/PaymentRequestCallbackUrls.md)
+ - [PaymentRequestsList200Response](docs/PaymentRequestsList200Response.md)
+ - [PercentageOverIndex](docs/PercentageOverIndex.md)
+ - [PhoneNumber](docs/PhoneNumber.md)
+ - [PixData](docs/PixData.md)
+ - [SmartAccount](docs/SmartAccount.md)
+ - [SmartAccountAddress](docs/SmartAccountAddress.md)
+ - [SmartAccountBalance](docs/SmartAccountBalance.md)
+ - [SmartAccountsList200Response](docs/SmartAccountsList200Response.md)
+ - [StatusDetail](docs/StatusDetail.md)
+ - [StatusDetailProduct](docs/StatusDetailProduct.md)
+ - [StatusDetailProductWarning](docs/StatusDetailProductWarning.md)
+ - [Transaction](docs/Transaction.md)
+ - [UpdateItem](docs/UpdateItem.md)
+ - [UpdateItemParameters](docs/UpdateItemParameters.md)
+ - [UpdatePaymentRecipient](docs/UpdatePaymentRecipient.md)
+ - [UpdatePaymentRequest](docs/UpdatePaymentRequest.md)
+ - [UpdateTransaction](docs/UpdateTransaction.md)
+ - [Webhook](docs/Webhook.md)
+ - [WebhookCreationErrorResponse](docs/WebhookCreationErrorResponse.md)
+ - [WebhooksList200Response](docs/WebhooksList200Response.md)
+
+
+<a id="documentation-for-authorization"></a>
+## Documentation For Authorization
+
+
+Authentication schemes defined for the API:
+<a id="default"></a>
+### default
+
+- **Type**: API key
+- **API key parameter name**: X-API-KEY
+- **Location**: HTTP header
+
+
+## Author
+
+hello@pluggy.ai
+
+