pluggy-sdk 1.0.0.post34__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- pluggy_sdk/__init__.py +200 -0
- pluggy_sdk/api/__init__.py +25 -0
- pluggy_sdk/api/account_api.py +588 -0
- pluggy_sdk/api/acquirer_anticipation_api.py +664 -0
- pluggy_sdk/api/acquirer_receivable_api.py +664 -0
- pluggy_sdk/api/acquirer_sale_api.py +664 -0
- pluggy_sdk/api/auth_api.py +605 -0
- pluggy_sdk/api/benefit_api.py +567 -0
- pluggy_sdk/api/bill_api.py +567 -0
- pluggy_sdk/api/bulk_payment_api.py +1127 -0
- pluggy_sdk/api/category_api.py +1096 -0
- pluggy_sdk/api/connector_api.py +979 -0
- pluggy_sdk/api/consent_api.py +576 -0
- pluggy_sdk/api/identity_api.py +581 -0
- pluggy_sdk/api/income_report_api.py +311 -0
- pluggy_sdk/api/investment_api.py +918 -0
- pluggy_sdk/api/items_api.py +1456 -0
- pluggy_sdk/api/loan_api.py +567 -0
- pluggy_sdk/api/payment_customer_api.py +1414 -0
- pluggy_sdk/api/payment_intent_api.py +842 -0
- pluggy_sdk/api/payment_receipts_api.py +842 -0
- pluggy_sdk/api/payment_recipient_api.py +1997 -0
- pluggy_sdk/api/payment_request_api.py +2739 -0
- pluggy_sdk/api/payment_schedule_api.py +823 -0
- pluggy_sdk/api/payroll_loan_api.py +561 -0
- pluggy_sdk/api/portfolio_yield_api.py +580 -0
- pluggy_sdk/api/smart_account_api.py +1704 -0
- pluggy_sdk/api/smart_account_transfer_api.py +610 -0
- pluggy_sdk/api/smart_transfer_api.py +1406 -0
- pluggy_sdk/api/transaction_api.py +963 -0
- pluggy_sdk/api/webhook_api.py +1406 -0
- pluggy_sdk/api_client.py +798 -0
- pluggy_sdk/api_response.py +21 -0
- pluggy_sdk/configuration.py +596 -0
- pluggy_sdk/exceptions.py +217 -0
- pluggy_sdk/models/__init__.py +163 -0
- pluggy_sdk/models/account.py +134 -0
- pluggy_sdk/models/accounts_list200_response.py +102 -0
- pluggy_sdk/models/acquirer_anticipation.py +117 -0
- pluggy_sdk/models/acquirer_anticipation_data.py +101 -0
- pluggy_sdk/models/acquirer_data.py +113 -0
- pluggy_sdk/models/acquirer_receivable.py +143 -0
- pluggy_sdk/models/acquirer_receivable_data.py +108 -0
- pluggy_sdk/models/acquirer_receivable_data_establishment.py +96 -0
- pluggy_sdk/models/acquirer_receivable_destination_account.py +92 -0
- pluggy_sdk/models/acquirer_receivable_related_sale.py +99 -0
- pluggy_sdk/models/acquirer_sale.py +171 -0
- pluggy_sdk/models/acquirer_sale_data.py +150 -0
- pluggy_sdk/models/acquirer_sale_installment.py +93 -0
- pluggy_sdk/models/acquirer_sale_installment_data.py +95 -0
- pluggy_sdk/models/address.py +110 -0
- pluggy_sdk/models/aggregated_portfolio.py +120 -0
- pluggy_sdk/models/aggregated_portfolio_response.py +102 -0
- pluggy_sdk/models/asset_distribution.py +88 -0
- pluggy_sdk/models/auth_request.py +90 -0
- pluggy_sdk/models/auth_response.py +88 -0
- pluggy_sdk/models/bank_data.py +92 -0
- pluggy_sdk/models/benefit_loan.py +121 -0
- pluggy_sdk/models/benefit_loan_client.py +102 -0
- pluggy_sdk/models/benefit_response.py +118 -0
- pluggy_sdk/models/benefit_response_paying_institution.py +94 -0
- pluggy_sdk/models/benefits_list200_response.py +102 -0
- pluggy_sdk/models/bill.py +109 -0
- pluggy_sdk/models/bill_finance_charge.py +103 -0
- pluggy_sdk/models/bills_list200_response.py +102 -0
- pluggy_sdk/models/boleto.py +121 -0
- pluggy_sdk/models/boleto_payer.py +90 -0
- pluggy_sdk/models/boleto_recipient.py +90 -0
- pluggy_sdk/models/bulk_payment.py +128 -0
- pluggy_sdk/models/bulk_payments_list200_response.py +102 -0
- pluggy_sdk/models/category.py +96 -0
- pluggy_sdk/models/client_category_rule.py +98 -0
- pluggy_sdk/models/company.py +90 -0
- pluggy_sdk/models/connect_token_request.py +94 -0
- pluggy_sdk/models/connect_token_response.py +88 -0
- pluggy_sdk/models/connector.py +145 -0
- pluggy_sdk/models/connector_credential.py +121 -0
- pluggy_sdk/models/connector_health.py +96 -0
- pluggy_sdk/models/connector_health_details.py +90 -0
- pluggy_sdk/models/connector_list_response.py +102 -0
- pluggy_sdk/models/connector_user_action.py +93 -0
- pluggy_sdk/models/consent.py +120 -0
- pluggy_sdk/models/create_boleto_payment_request.py +98 -0
- pluggy_sdk/models/create_bulk_payment.py +96 -0
- pluggy_sdk/models/create_client_category_rule.py +96 -0
- pluggy_sdk/models/create_item.py +115 -0
- pluggy_sdk/models/create_item_parameters.py +144 -0
- pluggy_sdk/models/create_or_update_payment_customer.py +105 -0
- pluggy_sdk/models/create_payment_customer_request_body.py +103 -0
- pluggy_sdk/models/create_payment_intent.py +110 -0
- pluggy_sdk/models/create_payment_recipient.py +104 -0
- pluggy_sdk/models/create_payment_request.py +115 -0
- pluggy_sdk/models/create_payment_request_schedule.py +189 -0
- pluggy_sdk/models/create_pix_qr_payment_request.py +96 -0
- pluggy_sdk/models/create_smart_account_request.py +104 -0
- pluggy_sdk/models/create_smart_account_transfer_request.py +92 -0
- pluggy_sdk/models/create_smart_transfer_payment.py +96 -0
- pluggy_sdk/models/create_smart_transfer_preauthorization.py +104 -0
- pluggy_sdk/models/create_webhook.py +99 -0
- pluggy_sdk/models/credential_select_option.py +90 -0
- pluggy_sdk/models/credit_card_metadata.py +101 -0
- pluggy_sdk/models/credit_data.py +127 -0
- pluggy_sdk/models/custom.py +100 -0
- pluggy_sdk/models/daily.py +101 -0
- pluggy_sdk/models/document.py +100 -0
- pluggy_sdk/models/email.py +100 -0
- pluggy_sdk/models/global_error_response.py +94 -0
- pluggy_sdk/models/i_count_response.py +88 -0
- pluggy_sdk/models/identity_relation.py +102 -0
- pluggy_sdk/models/identity_response.py +173 -0
- pluggy_sdk/models/identity_response_financial_relationships.py +111 -0
- pluggy_sdk/models/identity_response_financial_relationships_accounts_inner.py +98 -0
- pluggy_sdk/models/identity_response_financial_relationships_procurators_inner.py +101 -0
- pluggy_sdk/models/identity_response_qualifications.py +112 -0
- pluggy_sdk/models/identity_response_qualifications_informed_income.py +100 -0
- pluggy_sdk/models/identity_response_qualifications_informed_patrimony.py +90 -0
- pluggy_sdk/models/income_report.py +90 -0
- pluggy_sdk/models/income_reports_response.py +102 -0
- pluggy_sdk/models/investment.py +192 -0
- pluggy_sdk/models/investment_expenses.py +108 -0
- pluggy_sdk/models/investment_metadata.py +100 -0
- pluggy_sdk/models/investment_transaction.py +124 -0
- pluggy_sdk/models/investments_list200_response.py +102 -0
- pluggy_sdk/models/item.py +150 -0
- pluggy_sdk/models/item_creation_error_response.py +102 -0
- pluggy_sdk/models/item_error.py +94 -0
- pluggy_sdk/models/item_options.py +94 -0
- pluggy_sdk/models/loan.py +199 -0
- pluggy_sdk/models/loan_contracted_fee.py +118 -0
- pluggy_sdk/models/loan_contracted_finance_charge.py +92 -0
- pluggy_sdk/models/loan_installment_balloon_payment.py +95 -0
- pluggy_sdk/models/loan_installment_balloon_payment_amount.py +90 -0
- pluggy_sdk/models/loan_installments.py +130 -0
- pluggy_sdk/models/loan_interest_rate.py +136 -0
- pluggy_sdk/models/loan_payment_release.py +103 -0
- pluggy_sdk/models/loan_payment_release_over_parcel.py +106 -0
- pluggy_sdk/models/loan_payment_release_over_parcel_charge.py +92 -0
- pluggy_sdk/models/loan_payment_release_over_parcel_fee.py +92 -0
- pluggy_sdk/models/loan_payments.py +98 -0
- pluggy_sdk/models/loan_warranty.py +94 -0
- pluggy_sdk/models/loans_list200_response.py +102 -0
- pluggy_sdk/models/merchant.py +96 -0
- pluggy_sdk/models/monthly.py +103 -0
- pluggy_sdk/models/monthly_portfolio.py +100 -0
- pluggy_sdk/models/monthly_portfolio_response.py +102 -0
- pluggy_sdk/models/not_authenticated_response.py +90 -0
- pluggy_sdk/models/page_response_acquirer_anticipations.py +102 -0
- pluggy_sdk/models/page_response_acquirer_receivables.py +102 -0
- pluggy_sdk/models/page_response_acquirer_sales.py +102 -0
- pluggy_sdk/models/page_response_category_rules.py +102 -0
- pluggy_sdk/models/page_response_consents.py +102 -0
- pluggy_sdk/models/page_response_investment_transactions.py +102 -0
- pluggy_sdk/models/page_response_transactions.py +102 -0
- pluggy_sdk/models/parameter_validation_error.py +92 -0
- pluggy_sdk/models/parameter_validation_response.py +98 -0
- pluggy_sdk/models/payment_customer.py +105 -0
- pluggy_sdk/models/payment_customers_list200_response.py +102 -0
- pluggy_sdk/models/payment_data.py +111 -0
- pluggy_sdk/models/payment_data_boleto_metadata.py +98 -0
- pluggy_sdk/models/payment_data_participant.py +102 -0
- pluggy_sdk/models/payment_institution.py +101 -0
- pluggy_sdk/models/payment_intent.py +145 -0
- pluggy_sdk/models/payment_intent_parameter.py +90 -0
- pluggy_sdk/models/payment_intents_list200_response.py +102 -0
- pluggy_sdk/models/payment_receipt.py +120 -0
- pluggy_sdk/models/payment_receipt_bank_account.py +92 -0
- pluggy_sdk/models/payment_receipt_person.py +96 -0
- pluggy_sdk/models/payment_recipient.py +110 -0
- pluggy_sdk/models/payment_recipient_account.py +92 -0
- pluggy_sdk/models/payment_recipients_institution_list200_response.py +102 -0
- pluggy_sdk/models/payment_recipients_list200_response.py +102 -0
- pluggy_sdk/models/payment_request.py +132 -0
- pluggy_sdk/models/payment_request_callback_urls.py +92 -0
- pluggy_sdk/models/payment_request_receipt_list200_response.py +102 -0
- pluggy_sdk/models/payment_request_schedule.py +183 -0
- pluggy_sdk/models/payment_requests_list200_response.py +102 -0
- pluggy_sdk/models/payment_schedules_list200_response.py +102 -0
- pluggy_sdk/models/payroll_loan.py +121 -0
- pluggy_sdk/models/payroll_loan_client.py +102 -0
- pluggy_sdk/models/payroll_loan_response.py +125 -0
- pluggy_sdk/models/payroll_loan_response_client.py +102 -0
- pluggy_sdk/models/payroll_loans_list200_response.py +102 -0
- pluggy_sdk/models/percentage_over_index.py +90 -0
- pluggy_sdk/models/phone_number.py +100 -0
- pluggy_sdk/models/pix_data.py +90 -0
- pluggy_sdk/models/schedule_payment.py +102 -0
- pluggy_sdk/models/schedule_type_custom.py +100 -0
- pluggy_sdk/models/schedule_type_daily.py +101 -0
- pluggy_sdk/models/schedule_type_monthly.py +103 -0
- pluggy_sdk/models/schedule_type_single.py +98 -0
- pluggy_sdk/models/schedule_type_weekly.py +110 -0
- pluggy_sdk/models/single.py +98 -0
- pluggy_sdk/models/smart_account.py +107 -0
- pluggy_sdk/models/smart_account_address.py +112 -0
- pluggy_sdk/models/smart_account_balance.py +95 -0
- pluggy_sdk/models/smart_account_transfer.py +123 -0
- pluggy_sdk/models/smart_accounts_list200_response.py +102 -0
- pluggy_sdk/models/smart_tranfers_preauthorizations_list200_response.py +102 -0
- pluggy_sdk/models/smart_transfer_callback_urls.py +90 -0
- pluggy_sdk/models/smart_transfer_payment.py +116 -0
- pluggy_sdk/models/smart_transfer_preauthorization.py +128 -0
- pluggy_sdk/models/smart_transfer_preauthorization_parameter.py +90 -0
- pluggy_sdk/models/status_detail.py +127 -0
- pluggy_sdk/models/status_detail_product.py +101 -0
- pluggy_sdk/models/status_detail_product_warning.py +92 -0
- pluggy_sdk/models/transaction.py +141 -0
- pluggy_sdk/models/update_item.py +109 -0
- pluggy_sdk/models/update_item_parameters.py +144 -0
- pluggy_sdk/models/update_payment_recipient.py +102 -0
- pluggy_sdk/models/update_payment_request.py +102 -0
- pluggy_sdk/models/update_transaction.py +88 -0
- pluggy_sdk/models/webhook.py +106 -0
- pluggy_sdk/models/webhook_creation_error_response.py +90 -0
- pluggy_sdk/models/webhooks_list200_response.py +102 -0
- pluggy_sdk/models/weekly.py +110 -0
- pluggy_sdk/py.typed +0 -0
- pluggy_sdk/rest.py +258 -0
- pluggy_sdk-1.0.0.post34.dist-info/METADATA +373 -0
- pluggy_sdk-1.0.0.post34.dist-info/RECORD +221 -0
- pluggy_sdk-1.0.0.post34.dist-info/WHEEL +5 -0
- pluggy_sdk-1.0.0.post34.dist-info/top_level.txt +1 -0
@@ -0,0 +1,979 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
|
3
|
+
"""
|
4
|
+
Pluggy API
|
5
|
+
|
6
|
+
Pluggy's main API to review data and execute connectors
|
7
|
+
|
8
|
+
The version of the OpenAPI document: 1.0.0
|
9
|
+
Contact: hello@pluggy.ai
|
10
|
+
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
11
|
+
|
12
|
+
Do not edit the class manually.
|
13
|
+
""" # noqa: E501
|
14
|
+
|
15
|
+
import warnings
|
16
|
+
from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
|
17
|
+
from typing import Any, Dict, List, Optional, Tuple, Union
|
18
|
+
from typing_extensions import Annotated
|
19
|
+
|
20
|
+
from pydantic import Field, StrictBool, StrictFloat, StrictInt, StrictStr, field_validator
|
21
|
+
from typing import Dict, List, Optional, Union
|
22
|
+
from typing_extensions import Annotated
|
23
|
+
from pluggy_sdk.models.connector import Connector
|
24
|
+
from pluggy_sdk.models.connector_list_response import ConnectorListResponse
|
25
|
+
from pluggy_sdk.models.parameter_validation_response import ParameterValidationResponse
|
26
|
+
|
27
|
+
from pluggy_sdk.api_client import ApiClient, RequestSerialized
|
28
|
+
from pluggy_sdk.api_response import ApiResponse
|
29
|
+
from pluggy_sdk.rest import RESTResponseType
|
30
|
+
|
31
|
+
|
32
|
+
class ConnectorApi:
|
33
|
+
"""NOTE: This class is auto generated by OpenAPI Generator
|
34
|
+
Ref: https://openapi-generator.tech
|
35
|
+
|
36
|
+
Do not edit the class manually.
|
37
|
+
"""
|
38
|
+
|
39
|
+
def __init__(self, api_client=None) -> None:
|
40
|
+
if api_client is None:
|
41
|
+
api_client = ApiClient.get_default()
|
42
|
+
self.api_client = api_client
|
43
|
+
|
44
|
+
|
45
|
+
@validate_call
|
46
|
+
def connector_retrieve(
|
47
|
+
self,
|
48
|
+
id: Annotated[Union[StrictFloat, StrictInt], Field(description="Connector primary identifier")],
|
49
|
+
health_details: Annotated[Optional[StrictBool], Field(description="Include health details about latest connections and percentage of errors (connection rate)")] = None,
|
50
|
+
_request_timeout: Union[
|
51
|
+
None,
|
52
|
+
Annotated[StrictFloat, Field(gt=0)],
|
53
|
+
Tuple[
|
54
|
+
Annotated[StrictFloat, Field(gt=0)],
|
55
|
+
Annotated[StrictFloat, Field(gt=0)]
|
56
|
+
]
|
57
|
+
] = None,
|
58
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
59
|
+
_content_type: Optional[StrictStr] = None,
|
60
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
61
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
62
|
+
) -> Connector:
|
63
|
+
"""Retrieve
|
64
|
+
|
65
|
+
This endpoint retrieves a specific connector.
|
66
|
+
|
67
|
+
:param id: Connector primary identifier (required)
|
68
|
+
:type id: float
|
69
|
+
:param health_details: Include health details about latest connections and percentage of errors (connection rate)
|
70
|
+
:type health_details: bool
|
71
|
+
:param _request_timeout: timeout setting for this request. If one
|
72
|
+
number provided, it will be total request
|
73
|
+
timeout. It can also be a pair (tuple) of
|
74
|
+
(connection, read) timeouts.
|
75
|
+
:type _request_timeout: int, tuple(int, int), optional
|
76
|
+
:param _request_auth: set to override the auth_settings for an a single
|
77
|
+
request; this effectively ignores the
|
78
|
+
authentication in the spec for a single request.
|
79
|
+
:type _request_auth: dict, optional
|
80
|
+
:param _content_type: force content-type for the request.
|
81
|
+
:type _content_type: str, Optional
|
82
|
+
:param _headers: set to override the headers for a single
|
83
|
+
request; this effectively ignores the headers
|
84
|
+
in the spec for a single request.
|
85
|
+
:type _headers: dict, optional
|
86
|
+
:param _host_index: set to override the host_index for a single
|
87
|
+
request; this effectively ignores the host_index
|
88
|
+
in the spec for a single request.
|
89
|
+
:type _host_index: int, optional
|
90
|
+
:return: Returns the result object.
|
91
|
+
""" # noqa: E501
|
92
|
+
|
93
|
+
_param = self._connector_retrieve_serialize(
|
94
|
+
id=id,
|
95
|
+
health_details=health_details,
|
96
|
+
_request_auth=_request_auth,
|
97
|
+
_content_type=_content_type,
|
98
|
+
_headers=_headers,
|
99
|
+
_host_index=_host_index
|
100
|
+
)
|
101
|
+
|
102
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
103
|
+
'200': "Connector",
|
104
|
+
'404': "GlobalErrorResponse",
|
105
|
+
}
|
106
|
+
response_data = self.api_client.call_api(
|
107
|
+
*_param,
|
108
|
+
_request_timeout=_request_timeout
|
109
|
+
)
|
110
|
+
response_data.read()
|
111
|
+
return self.api_client.response_deserialize(
|
112
|
+
response_data=response_data,
|
113
|
+
response_types_map=_response_types_map,
|
114
|
+
).data
|
115
|
+
|
116
|
+
|
117
|
+
@validate_call
|
118
|
+
def connector_retrieve_with_http_info(
|
119
|
+
self,
|
120
|
+
id: Annotated[Union[StrictFloat, StrictInt], Field(description="Connector primary identifier")],
|
121
|
+
health_details: Annotated[Optional[StrictBool], Field(description="Include health details about latest connections and percentage of errors (connection rate)")] = None,
|
122
|
+
_request_timeout: Union[
|
123
|
+
None,
|
124
|
+
Annotated[StrictFloat, Field(gt=0)],
|
125
|
+
Tuple[
|
126
|
+
Annotated[StrictFloat, Field(gt=0)],
|
127
|
+
Annotated[StrictFloat, Field(gt=0)]
|
128
|
+
]
|
129
|
+
] = None,
|
130
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
131
|
+
_content_type: Optional[StrictStr] = None,
|
132
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
133
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
134
|
+
) -> ApiResponse[Connector]:
|
135
|
+
"""Retrieve
|
136
|
+
|
137
|
+
This endpoint retrieves a specific connector.
|
138
|
+
|
139
|
+
:param id: Connector primary identifier (required)
|
140
|
+
:type id: float
|
141
|
+
:param health_details: Include health details about latest connections and percentage of errors (connection rate)
|
142
|
+
:type health_details: bool
|
143
|
+
:param _request_timeout: timeout setting for this request. If one
|
144
|
+
number provided, it will be total request
|
145
|
+
timeout. It can also be a pair (tuple) of
|
146
|
+
(connection, read) timeouts.
|
147
|
+
:type _request_timeout: int, tuple(int, int), optional
|
148
|
+
:param _request_auth: set to override the auth_settings for an a single
|
149
|
+
request; this effectively ignores the
|
150
|
+
authentication in the spec for a single request.
|
151
|
+
:type _request_auth: dict, optional
|
152
|
+
:param _content_type: force content-type for the request.
|
153
|
+
:type _content_type: str, Optional
|
154
|
+
:param _headers: set to override the headers for a single
|
155
|
+
request; this effectively ignores the headers
|
156
|
+
in the spec for a single request.
|
157
|
+
:type _headers: dict, optional
|
158
|
+
:param _host_index: set to override the host_index for a single
|
159
|
+
request; this effectively ignores the host_index
|
160
|
+
in the spec for a single request.
|
161
|
+
:type _host_index: int, optional
|
162
|
+
:return: Returns the result object.
|
163
|
+
""" # noqa: E501
|
164
|
+
|
165
|
+
_param = self._connector_retrieve_serialize(
|
166
|
+
id=id,
|
167
|
+
health_details=health_details,
|
168
|
+
_request_auth=_request_auth,
|
169
|
+
_content_type=_content_type,
|
170
|
+
_headers=_headers,
|
171
|
+
_host_index=_host_index
|
172
|
+
)
|
173
|
+
|
174
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
175
|
+
'200': "Connector",
|
176
|
+
'404': "GlobalErrorResponse",
|
177
|
+
}
|
178
|
+
response_data = self.api_client.call_api(
|
179
|
+
*_param,
|
180
|
+
_request_timeout=_request_timeout
|
181
|
+
)
|
182
|
+
response_data.read()
|
183
|
+
return self.api_client.response_deserialize(
|
184
|
+
response_data=response_data,
|
185
|
+
response_types_map=_response_types_map,
|
186
|
+
)
|
187
|
+
|
188
|
+
|
189
|
+
@validate_call
|
190
|
+
def connector_retrieve_without_preload_content(
|
191
|
+
self,
|
192
|
+
id: Annotated[Union[StrictFloat, StrictInt], Field(description="Connector primary identifier")],
|
193
|
+
health_details: Annotated[Optional[StrictBool], Field(description="Include health details about latest connections and percentage of errors (connection rate)")] = None,
|
194
|
+
_request_timeout: Union[
|
195
|
+
None,
|
196
|
+
Annotated[StrictFloat, Field(gt=0)],
|
197
|
+
Tuple[
|
198
|
+
Annotated[StrictFloat, Field(gt=0)],
|
199
|
+
Annotated[StrictFloat, Field(gt=0)]
|
200
|
+
]
|
201
|
+
] = None,
|
202
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
203
|
+
_content_type: Optional[StrictStr] = None,
|
204
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
205
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
206
|
+
) -> RESTResponseType:
|
207
|
+
"""Retrieve
|
208
|
+
|
209
|
+
This endpoint retrieves a specific connector.
|
210
|
+
|
211
|
+
:param id: Connector primary identifier (required)
|
212
|
+
:type id: float
|
213
|
+
:param health_details: Include health details about latest connections and percentage of errors (connection rate)
|
214
|
+
:type health_details: bool
|
215
|
+
:param _request_timeout: timeout setting for this request. If one
|
216
|
+
number provided, it will be total request
|
217
|
+
timeout. It can also be a pair (tuple) of
|
218
|
+
(connection, read) timeouts.
|
219
|
+
:type _request_timeout: int, tuple(int, int), optional
|
220
|
+
:param _request_auth: set to override the auth_settings for an a single
|
221
|
+
request; this effectively ignores the
|
222
|
+
authentication in the spec for a single request.
|
223
|
+
:type _request_auth: dict, optional
|
224
|
+
:param _content_type: force content-type for the request.
|
225
|
+
:type _content_type: str, Optional
|
226
|
+
:param _headers: set to override the headers for a single
|
227
|
+
request; this effectively ignores the headers
|
228
|
+
in the spec for a single request.
|
229
|
+
:type _headers: dict, optional
|
230
|
+
:param _host_index: set to override the host_index for a single
|
231
|
+
request; this effectively ignores the host_index
|
232
|
+
in the spec for a single request.
|
233
|
+
:type _host_index: int, optional
|
234
|
+
:return: Returns the result object.
|
235
|
+
""" # noqa: E501
|
236
|
+
|
237
|
+
_param = self._connector_retrieve_serialize(
|
238
|
+
id=id,
|
239
|
+
health_details=health_details,
|
240
|
+
_request_auth=_request_auth,
|
241
|
+
_content_type=_content_type,
|
242
|
+
_headers=_headers,
|
243
|
+
_host_index=_host_index
|
244
|
+
)
|
245
|
+
|
246
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
247
|
+
'200': "Connector",
|
248
|
+
'404': "GlobalErrorResponse",
|
249
|
+
}
|
250
|
+
response_data = self.api_client.call_api(
|
251
|
+
*_param,
|
252
|
+
_request_timeout=_request_timeout
|
253
|
+
)
|
254
|
+
return response_data.response
|
255
|
+
|
256
|
+
|
257
|
+
def _connector_retrieve_serialize(
|
258
|
+
self,
|
259
|
+
id,
|
260
|
+
health_details,
|
261
|
+
_request_auth,
|
262
|
+
_content_type,
|
263
|
+
_headers,
|
264
|
+
_host_index,
|
265
|
+
) -> RequestSerialized:
|
266
|
+
|
267
|
+
_host = None
|
268
|
+
|
269
|
+
_collection_formats: Dict[str, str] = {
|
270
|
+
}
|
271
|
+
|
272
|
+
_path_params: Dict[str, str] = {}
|
273
|
+
_query_params: List[Tuple[str, str]] = []
|
274
|
+
_header_params: Dict[str, Optional[str]] = _headers or {}
|
275
|
+
_form_params: List[Tuple[str, str]] = []
|
276
|
+
_files: Dict[
|
277
|
+
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
|
278
|
+
] = {}
|
279
|
+
_body_params: Optional[bytes] = None
|
280
|
+
|
281
|
+
# process the path parameters
|
282
|
+
if id is not None:
|
283
|
+
_path_params['id'] = id
|
284
|
+
# process the query parameters
|
285
|
+
if health_details is not None:
|
286
|
+
|
287
|
+
_query_params.append(('healthDetails', health_details))
|
288
|
+
|
289
|
+
# process the header parameters
|
290
|
+
# process the form parameters
|
291
|
+
# process the body parameter
|
292
|
+
|
293
|
+
|
294
|
+
# set the HTTP header `Accept`
|
295
|
+
if 'Accept' not in _header_params:
|
296
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
297
|
+
[
|
298
|
+
'application/json'
|
299
|
+
]
|
300
|
+
)
|
301
|
+
|
302
|
+
|
303
|
+
# authentication setting
|
304
|
+
_auth_settings: List[str] = [
|
305
|
+
'default'
|
306
|
+
]
|
307
|
+
|
308
|
+
return self.api_client.param_serialize(
|
309
|
+
method='GET',
|
310
|
+
resource_path='/connectors/{id}',
|
311
|
+
path_params=_path_params,
|
312
|
+
query_params=_query_params,
|
313
|
+
header_params=_header_params,
|
314
|
+
body=_body_params,
|
315
|
+
post_params=_form_params,
|
316
|
+
files=_files,
|
317
|
+
auth_settings=_auth_settings,
|
318
|
+
collection_formats=_collection_formats,
|
319
|
+
_host=_host,
|
320
|
+
_request_auth=_request_auth
|
321
|
+
)
|
322
|
+
|
323
|
+
|
324
|
+
|
325
|
+
|
326
|
+
@validate_call
|
327
|
+
def connectors_list(
|
328
|
+
self,
|
329
|
+
countries: Annotated[Optional[List[StrictStr]], Field(description="A list of countries of connectors to filter.")] = None,
|
330
|
+
types: Annotated[Optional[List[StrictStr]], Field(description="A list of types of connectors to filter.")] = None,
|
331
|
+
name: Annotated[Optional[StrictStr], Field(description="Name alike look up of the connector")] = None,
|
332
|
+
sandbox: Annotated[Optional[StrictBool], Field(description="Include sandbox connectors if set to true (default: false).")] = None,
|
333
|
+
health_details: Annotated[Optional[StrictBool], Field(description="Include health details about latest connections and percentage of errors (connection rate)")] = None,
|
334
|
+
is_open_finance: Annotated[Optional[StrictBool], Field(description="Filter connectors by the `isOpenFinance` attribute. If not sent, it won't filter.")] = None,
|
335
|
+
supports_payment_initiation: Annotated[Optional[StrictBool], Field(description="Filter connectors by the `supportsPaymentInitiation` attribute. If not sent, it won't filter.")] = None,
|
336
|
+
_request_timeout: Union[
|
337
|
+
None,
|
338
|
+
Annotated[StrictFloat, Field(gt=0)],
|
339
|
+
Tuple[
|
340
|
+
Annotated[StrictFloat, Field(gt=0)],
|
341
|
+
Annotated[StrictFloat, Field(gt=0)]
|
342
|
+
]
|
343
|
+
] = None,
|
344
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
345
|
+
_content_type: Optional[StrictStr] = None,
|
346
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
347
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
348
|
+
) -> ConnectorListResponse:
|
349
|
+
"""List
|
350
|
+
|
351
|
+
This endpoint retrieves all available connectors.
|
352
|
+
|
353
|
+
:param countries: A list of countries of connectors to filter.
|
354
|
+
:type countries: List[str]
|
355
|
+
:param types: A list of types of connectors to filter.
|
356
|
+
:type types: List[str]
|
357
|
+
:param name: Name alike look up of the connector
|
358
|
+
:type name: str
|
359
|
+
:param sandbox: Include sandbox connectors if set to true (default: false).
|
360
|
+
:type sandbox: bool
|
361
|
+
:param health_details: Include health details about latest connections and percentage of errors (connection rate)
|
362
|
+
:type health_details: bool
|
363
|
+
:param is_open_finance: Filter connectors by the `isOpenFinance` attribute. If not sent, it won't filter.
|
364
|
+
:type is_open_finance: bool
|
365
|
+
:param supports_payment_initiation: Filter connectors by the `supportsPaymentInitiation` attribute. If not sent, it won't filter.
|
366
|
+
:type supports_payment_initiation: bool
|
367
|
+
:param _request_timeout: timeout setting for this request. If one
|
368
|
+
number provided, it will be total request
|
369
|
+
timeout. It can also be a pair (tuple) of
|
370
|
+
(connection, read) timeouts.
|
371
|
+
:type _request_timeout: int, tuple(int, int), optional
|
372
|
+
:param _request_auth: set to override the auth_settings for an a single
|
373
|
+
request; this effectively ignores the
|
374
|
+
authentication in the spec for a single request.
|
375
|
+
:type _request_auth: dict, optional
|
376
|
+
:param _content_type: force content-type for the request.
|
377
|
+
:type _content_type: str, Optional
|
378
|
+
:param _headers: set to override the headers for a single
|
379
|
+
request; this effectively ignores the headers
|
380
|
+
in the spec for a single request.
|
381
|
+
:type _headers: dict, optional
|
382
|
+
:param _host_index: set to override the host_index for a single
|
383
|
+
request; this effectively ignores the host_index
|
384
|
+
in the spec for a single request.
|
385
|
+
:type _host_index: int, optional
|
386
|
+
:return: Returns the result object.
|
387
|
+
""" # noqa: E501
|
388
|
+
|
389
|
+
_param = self._connectors_list_serialize(
|
390
|
+
countries=countries,
|
391
|
+
types=types,
|
392
|
+
name=name,
|
393
|
+
sandbox=sandbox,
|
394
|
+
health_details=health_details,
|
395
|
+
is_open_finance=is_open_finance,
|
396
|
+
supports_payment_initiation=supports_payment_initiation,
|
397
|
+
_request_auth=_request_auth,
|
398
|
+
_content_type=_content_type,
|
399
|
+
_headers=_headers,
|
400
|
+
_host_index=_host_index
|
401
|
+
)
|
402
|
+
|
403
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
404
|
+
'200': "ConnectorListResponse",
|
405
|
+
}
|
406
|
+
response_data = self.api_client.call_api(
|
407
|
+
*_param,
|
408
|
+
_request_timeout=_request_timeout
|
409
|
+
)
|
410
|
+
response_data.read()
|
411
|
+
return self.api_client.response_deserialize(
|
412
|
+
response_data=response_data,
|
413
|
+
response_types_map=_response_types_map,
|
414
|
+
).data
|
415
|
+
|
416
|
+
|
417
|
+
@validate_call
|
418
|
+
def connectors_list_with_http_info(
|
419
|
+
self,
|
420
|
+
countries: Annotated[Optional[List[StrictStr]], Field(description="A list of countries of connectors to filter.")] = None,
|
421
|
+
types: Annotated[Optional[List[StrictStr]], Field(description="A list of types of connectors to filter.")] = None,
|
422
|
+
name: Annotated[Optional[StrictStr], Field(description="Name alike look up of the connector")] = None,
|
423
|
+
sandbox: Annotated[Optional[StrictBool], Field(description="Include sandbox connectors if set to true (default: false).")] = None,
|
424
|
+
health_details: Annotated[Optional[StrictBool], Field(description="Include health details about latest connections and percentage of errors (connection rate)")] = None,
|
425
|
+
is_open_finance: Annotated[Optional[StrictBool], Field(description="Filter connectors by the `isOpenFinance` attribute. If not sent, it won't filter.")] = None,
|
426
|
+
supports_payment_initiation: Annotated[Optional[StrictBool], Field(description="Filter connectors by the `supportsPaymentInitiation` attribute. If not sent, it won't filter.")] = None,
|
427
|
+
_request_timeout: Union[
|
428
|
+
None,
|
429
|
+
Annotated[StrictFloat, Field(gt=0)],
|
430
|
+
Tuple[
|
431
|
+
Annotated[StrictFloat, Field(gt=0)],
|
432
|
+
Annotated[StrictFloat, Field(gt=0)]
|
433
|
+
]
|
434
|
+
] = None,
|
435
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
436
|
+
_content_type: Optional[StrictStr] = None,
|
437
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
438
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
439
|
+
) -> ApiResponse[ConnectorListResponse]:
|
440
|
+
"""List
|
441
|
+
|
442
|
+
This endpoint retrieves all available connectors.
|
443
|
+
|
444
|
+
:param countries: A list of countries of connectors to filter.
|
445
|
+
:type countries: List[str]
|
446
|
+
:param types: A list of types of connectors to filter.
|
447
|
+
:type types: List[str]
|
448
|
+
:param name: Name alike look up of the connector
|
449
|
+
:type name: str
|
450
|
+
:param sandbox: Include sandbox connectors if set to true (default: false).
|
451
|
+
:type sandbox: bool
|
452
|
+
:param health_details: Include health details about latest connections and percentage of errors (connection rate)
|
453
|
+
:type health_details: bool
|
454
|
+
:param is_open_finance: Filter connectors by the `isOpenFinance` attribute. If not sent, it won't filter.
|
455
|
+
:type is_open_finance: bool
|
456
|
+
:param supports_payment_initiation: Filter connectors by the `supportsPaymentInitiation` attribute. If not sent, it won't filter.
|
457
|
+
:type supports_payment_initiation: bool
|
458
|
+
:param _request_timeout: timeout setting for this request. If one
|
459
|
+
number provided, it will be total request
|
460
|
+
timeout. It can also be a pair (tuple) of
|
461
|
+
(connection, read) timeouts.
|
462
|
+
:type _request_timeout: int, tuple(int, int), optional
|
463
|
+
:param _request_auth: set to override the auth_settings for an a single
|
464
|
+
request; this effectively ignores the
|
465
|
+
authentication in the spec for a single request.
|
466
|
+
:type _request_auth: dict, optional
|
467
|
+
:param _content_type: force content-type for the request.
|
468
|
+
:type _content_type: str, Optional
|
469
|
+
:param _headers: set to override the headers for a single
|
470
|
+
request; this effectively ignores the headers
|
471
|
+
in the spec for a single request.
|
472
|
+
:type _headers: dict, optional
|
473
|
+
:param _host_index: set to override the host_index for a single
|
474
|
+
request; this effectively ignores the host_index
|
475
|
+
in the spec for a single request.
|
476
|
+
:type _host_index: int, optional
|
477
|
+
:return: Returns the result object.
|
478
|
+
""" # noqa: E501
|
479
|
+
|
480
|
+
_param = self._connectors_list_serialize(
|
481
|
+
countries=countries,
|
482
|
+
types=types,
|
483
|
+
name=name,
|
484
|
+
sandbox=sandbox,
|
485
|
+
health_details=health_details,
|
486
|
+
is_open_finance=is_open_finance,
|
487
|
+
supports_payment_initiation=supports_payment_initiation,
|
488
|
+
_request_auth=_request_auth,
|
489
|
+
_content_type=_content_type,
|
490
|
+
_headers=_headers,
|
491
|
+
_host_index=_host_index
|
492
|
+
)
|
493
|
+
|
494
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
495
|
+
'200': "ConnectorListResponse",
|
496
|
+
}
|
497
|
+
response_data = self.api_client.call_api(
|
498
|
+
*_param,
|
499
|
+
_request_timeout=_request_timeout
|
500
|
+
)
|
501
|
+
response_data.read()
|
502
|
+
return self.api_client.response_deserialize(
|
503
|
+
response_data=response_data,
|
504
|
+
response_types_map=_response_types_map,
|
505
|
+
)
|
506
|
+
|
507
|
+
|
508
|
+
@validate_call
|
509
|
+
def connectors_list_without_preload_content(
|
510
|
+
self,
|
511
|
+
countries: Annotated[Optional[List[StrictStr]], Field(description="A list of countries of connectors to filter.")] = None,
|
512
|
+
types: Annotated[Optional[List[StrictStr]], Field(description="A list of types of connectors to filter.")] = None,
|
513
|
+
name: Annotated[Optional[StrictStr], Field(description="Name alike look up of the connector")] = None,
|
514
|
+
sandbox: Annotated[Optional[StrictBool], Field(description="Include sandbox connectors if set to true (default: false).")] = None,
|
515
|
+
health_details: Annotated[Optional[StrictBool], Field(description="Include health details about latest connections and percentage of errors (connection rate)")] = None,
|
516
|
+
is_open_finance: Annotated[Optional[StrictBool], Field(description="Filter connectors by the `isOpenFinance` attribute. If not sent, it won't filter.")] = None,
|
517
|
+
supports_payment_initiation: Annotated[Optional[StrictBool], Field(description="Filter connectors by the `supportsPaymentInitiation` attribute. If not sent, it won't filter.")] = None,
|
518
|
+
_request_timeout: Union[
|
519
|
+
None,
|
520
|
+
Annotated[StrictFloat, Field(gt=0)],
|
521
|
+
Tuple[
|
522
|
+
Annotated[StrictFloat, Field(gt=0)],
|
523
|
+
Annotated[StrictFloat, Field(gt=0)]
|
524
|
+
]
|
525
|
+
] = None,
|
526
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
527
|
+
_content_type: Optional[StrictStr] = None,
|
528
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
529
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
530
|
+
) -> RESTResponseType:
|
531
|
+
"""List
|
532
|
+
|
533
|
+
This endpoint retrieves all available connectors.
|
534
|
+
|
535
|
+
:param countries: A list of countries of connectors to filter.
|
536
|
+
:type countries: List[str]
|
537
|
+
:param types: A list of types of connectors to filter.
|
538
|
+
:type types: List[str]
|
539
|
+
:param name: Name alike look up of the connector
|
540
|
+
:type name: str
|
541
|
+
:param sandbox: Include sandbox connectors if set to true (default: false).
|
542
|
+
:type sandbox: bool
|
543
|
+
:param health_details: Include health details about latest connections and percentage of errors (connection rate)
|
544
|
+
:type health_details: bool
|
545
|
+
:param is_open_finance: Filter connectors by the `isOpenFinance` attribute. If not sent, it won't filter.
|
546
|
+
:type is_open_finance: bool
|
547
|
+
:param supports_payment_initiation: Filter connectors by the `supportsPaymentInitiation` attribute. If not sent, it won't filter.
|
548
|
+
:type supports_payment_initiation: bool
|
549
|
+
:param _request_timeout: timeout setting for this request. If one
|
550
|
+
number provided, it will be total request
|
551
|
+
timeout. It can also be a pair (tuple) of
|
552
|
+
(connection, read) timeouts.
|
553
|
+
:type _request_timeout: int, tuple(int, int), optional
|
554
|
+
:param _request_auth: set to override the auth_settings for an a single
|
555
|
+
request; this effectively ignores the
|
556
|
+
authentication in the spec for a single request.
|
557
|
+
:type _request_auth: dict, optional
|
558
|
+
:param _content_type: force content-type for the request.
|
559
|
+
:type _content_type: str, Optional
|
560
|
+
:param _headers: set to override the headers for a single
|
561
|
+
request; this effectively ignores the headers
|
562
|
+
in the spec for a single request.
|
563
|
+
:type _headers: dict, optional
|
564
|
+
:param _host_index: set to override the host_index for a single
|
565
|
+
request; this effectively ignores the host_index
|
566
|
+
in the spec for a single request.
|
567
|
+
:type _host_index: int, optional
|
568
|
+
:return: Returns the result object.
|
569
|
+
""" # noqa: E501
|
570
|
+
|
571
|
+
_param = self._connectors_list_serialize(
|
572
|
+
countries=countries,
|
573
|
+
types=types,
|
574
|
+
name=name,
|
575
|
+
sandbox=sandbox,
|
576
|
+
health_details=health_details,
|
577
|
+
is_open_finance=is_open_finance,
|
578
|
+
supports_payment_initiation=supports_payment_initiation,
|
579
|
+
_request_auth=_request_auth,
|
580
|
+
_content_type=_content_type,
|
581
|
+
_headers=_headers,
|
582
|
+
_host_index=_host_index
|
583
|
+
)
|
584
|
+
|
585
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
586
|
+
'200': "ConnectorListResponse",
|
587
|
+
}
|
588
|
+
response_data = self.api_client.call_api(
|
589
|
+
*_param,
|
590
|
+
_request_timeout=_request_timeout
|
591
|
+
)
|
592
|
+
return response_data.response
|
593
|
+
|
594
|
+
|
595
|
+
def _connectors_list_serialize(
|
596
|
+
self,
|
597
|
+
countries,
|
598
|
+
types,
|
599
|
+
name,
|
600
|
+
sandbox,
|
601
|
+
health_details,
|
602
|
+
is_open_finance,
|
603
|
+
supports_payment_initiation,
|
604
|
+
_request_auth,
|
605
|
+
_content_type,
|
606
|
+
_headers,
|
607
|
+
_host_index,
|
608
|
+
) -> RequestSerialized:
|
609
|
+
|
610
|
+
_host = None
|
611
|
+
|
612
|
+
_collection_formats: Dict[str, str] = {
|
613
|
+
'countries': 'csv',
|
614
|
+
'types': 'csv',
|
615
|
+
}
|
616
|
+
|
617
|
+
_path_params: Dict[str, str] = {}
|
618
|
+
_query_params: List[Tuple[str, str]] = []
|
619
|
+
_header_params: Dict[str, Optional[str]] = _headers or {}
|
620
|
+
_form_params: List[Tuple[str, str]] = []
|
621
|
+
_files: Dict[
|
622
|
+
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
|
623
|
+
] = {}
|
624
|
+
_body_params: Optional[bytes] = None
|
625
|
+
|
626
|
+
# process the path parameters
|
627
|
+
# process the query parameters
|
628
|
+
if countries is not None:
|
629
|
+
|
630
|
+
_query_params.append(('countries', countries))
|
631
|
+
|
632
|
+
if types is not None:
|
633
|
+
|
634
|
+
_query_params.append(('types', types))
|
635
|
+
|
636
|
+
if name is not None:
|
637
|
+
|
638
|
+
_query_params.append(('name', name))
|
639
|
+
|
640
|
+
if sandbox is not None:
|
641
|
+
|
642
|
+
_query_params.append(('sandbox', sandbox))
|
643
|
+
|
644
|
+
if health_details is not None:
|
645
|
+
|
646
|
+
_query_params.append(('healthDetails', health_details))
|
647
|
+
|
648
|
+
if is_open_finance is not None:
|
649
|
+
|
650
|
+
_query_params.append(('isOpenFinance', is_open_finance))
|
651
|
+
|
652
|
+
if supports_payment_initiation is not None:
|
653
|
+
|
654
|
+
_query_params.append(('supportsPaymentInitiation', supports_payment_initiation))
|
655
|
+
|
656
|
+
# process the header parameters
|
657
|
+
# process the form parameters
|
658
|
+
# process the body parameter
|
659
|
+
|
660
|
+
|
661
|
+
# set the HTTP header `Accept`
|
662
|
+
if 'Accept' not in _header_params:
|
663
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
664
|
+
[
|
665
|
+
'application/json'
|
666
|
+
]
|
667
|
+
)
|
668
|
+
|
669
|
+
|
670
|
+
# authentication setting
|
671
|
+
_auth_settings: List[str] = [
|
672
|
+
'default'
|
673
|
+
]
|
674
|
+
|
675
|
+
return self.api_client.param_serialize(
|
676
|
+
method='GET',
|
677
|
+
resource_path='/connectors',
|
678
|
+
path_params=_path_params,
|
679
|
+
query_params=_query_params,
|
680
|
+
header_params=_header_params,
|
681
|
+
body=_body_params,
|
682
|
+
post_params=_form_params,
|
683
|
+
files=_files,
|
684
|
+
auth_settings=_auth_settings,
|
685
|
+
collection_formats=_collection_formats,
|
686
|
+
_host=_host,
|
687
|
+
_request_auth=_request_auth
|
688
|
+
)
|
689
|
+
|
690
|
+
|
691
|
+
|
692
|
+
|
693
|
+
@validate_call
|
694
|
+
def connectors_validate(
|
695
|
+
self,
|
696
|
+
id: Annotated[Union[StrictFloat, StrictInt], Field(description="Connector's primary identifier")],
|
697
|
+
request_body: Annotated[Dict[str, StrictStr], Field(description="Connector's input credentials in a key-value object.")],
|
698
|
+
_request_timeout: Union[
|
699
|
+
None,
|
700
|
+
Annotated[StrictFloat, Field(gt=0)],
|
701
|
+
Tuple[
|
702
|
+
Annotated[StrictFloat, Field(gt=0)],
|
703
|
+
Annotated[StrictFloat, Field(gt=0)]
|
704
|
+
]
|
705
|
+
] = None,
|
706
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
707
|
+
_content_type: Optional[StrictStr] = None,
|
708
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
709
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
710
|
+
) -> ParameterValidationResponse:
|
711
|
+
"""Validate
|
712
|
+
|
713
|
+
Validates a connector parameters usign the connector validation
|
714
|
+
|
715
|
+
:param id: Connector's primary identifier (required)
|
716
|
+
:type id: float
|
717
|
+
:param request_body: Connector's input credentials in a key-value object. (required)
|
718
|
+
:type request_body: Dict[str, str]
|
719
|
+
:param _request_timeout: timeout setting for this request. If one
|
720
|
+
number provided, it will be total request
|
721
|
+
timeout. It can also be a pair (tuple) of
|
722
|
+
(connection, read) timeouts.
|
723
|
+
:type _request_timeout: int, tuple(int, int), optional
|
724
|
+
:param _request_auth: set to override the auth_settings for an a single
|
725
|
+
request; this effectively ignores the
|
726
|
+
authentication in the spec for a single request.
|
727
|
+
:type _request_auth: dict, optional
|
728
|
+
:param _content_type: force content-type for the request.
|
729
|
+
:type _content_type: str, Optional
|
730
|
+
:param _headers: set to override the headers for a single
|
731
|
+
request; this effectively ignores the headers
|
732
|
+
in the spec for a single request.
|
733
|
+
:type _headers: dict, optional
|
734
|
+
:param _host_index: set to override the host_index for a single
|
735
|
+
request; this effectively ignores the host_index
|
736
|
+
in the spec for a single request.
|
737
|
+
:type _host_index: int, optional
|
738
|
+
:return: Returns the result object.
|
739
|
+
""" # noqa: E501
|
740
|
+
|
741
|
+
_param = self._connectors_validate_serialize(
|
742
|
+
id=id,
|
743
|
+
request_body=request_body,
|
744
|
+
_request_auth=_request_auth,
|
745
|
+
_content_type=_content_type,
|
746
|
+
_headers=_headers,
|
747
|
+
_host_index=_host_index
|
748
|
+
)
|
749
|
+
|
750
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
751
|
+
'200': "ParameterValidationResponse",
|
752
|
+
}
|
753
|
+
response_data = self.api_client.call_api(
|
754
|
+
*_param,
|
755
|
+
_request_timeout=_request_timeout
|
756
|
+
)
|
757
|
+
response_data.read()
|
758
|
+
return self.api_client.response_deserialize(
|
759
|
+
response_data=response_data,
|
760
|
+
response_types_map=_response_types_map,
|
761
|
+
).data
|
762
|
+
|
763
|
+
|
764
|
+
@validate_call
|
765
|
+
def connectors_validate_with_http_info(
|
766
|
+
self,
|
767
|
+
id: Annotated[Union[StrictFloat, StrictInt], Field(description="Connector's primary identifier")],
|
768
|
+
request_body: Annotated[Dict[str, StrictStr], Field(description="Connector's input credentials in a key-value object.")],
|
769
|
+
_request_timeout: Union[
|
770
|
+
None,
|
771
|
+
Annotated[StrictFloat, Field(gt=0)],
|
772
|
+
Tuple[
|
773
|
+
Annotated[StrictFloat, Field(gt=0)],
|
774
|
+
Annotated[StrictFloat, Field(gt=0)]
|
775
|
+
]
|
776
|
+
] = None,
|
777
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
778
|
+
_content_type: Optional[StrictStr] = None,
|
779
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
780
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
781
|
+
) -> ApiResponse[ParameterValidationResponse]:
|
782
|
+
"""Validate
|
783
|
+
|
784
|
+
Validates a connector parameters usign the connector validation
|
785
|
+
|
786
|
+
:param id: Connector's primary identifier (required)
|
787
|
+
:type id: float
|
788
|
+
:param request_body: Connector's input credentials in a key-value object. (required)
|
789
|
+
:type request_body: Dict[str, str]
|
790
|
+
:param _request_timeout: timeout setting for this request. If one
|
791
|
+
number provided, it will be total request
|
792
|
+
timeout. It can also be a pair (tuple) of
|
793
|
+
(connection, read) timeouts.
|
794
|
+
:type _request_timeout: int, tuple(int, int), optional
|
795
|
+
:param _request_auth: set to override the auth_settings for an a single
|
796
|
+
request; this effectively ignores the
|
797
|
+
authentication in the spec for a single request.
|
798
|
+
:type _request_auth: dict, optional
|
799
|
+
:param _content_type: force content-type for the request.
|
800
|
+
:type _content_type: str, Optional
|
801
|
+
:param _headers: set to override the headers for a single
|
802
|
+
request; this effectively ignores the headers
|
803
|
+
in the spec for a single request.
|
804
|
+
:type _headers: dict, optional
|
805
|
+
:param _host_index: set to override the host_index for a single
|
806
|
+
request; this effectively ignores the host_index
|
807
|
+
in the spec for a single request.
|
808
|
+
:type _host_index: int, optional
|
809
|
+
:return: Returns the result object.
|
810
|
+
""" # noqa: E501
|
811
|
+
|
812
|
+
_param = self._connectors_validate_serialize(
|
813
|
+
id=id,
|
814
|
+
request_body=request_body,
|
815
|
+
_request_auth=_request_auth,
|
816
|
+
_content_type=_content_type,
|
817
|
+
_headers=_headers,
|
818
|
+
_host_index=_host_index
|
819
|
+
)
|
820
|
+
|
821
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
822
|
+
'200': "ParameterValidationResponse",
|
823
|
+
}
|
824
|
+
response_data = self.api_client.call_api(
|
825
|
+
*_param,
|
826
|
+
_request_timeout=_request_timeout
|
827
|
+
)
|
828
|
+
response_data.read()
|
829
|
+
return self.api_client.response_deserialize(
|
830
|
+
response_data=response_data,
|
831
|
+
response_types_map=_response_types_map,
|
832
|
+
)
|
833
|
+
|
834
|
+
|
835
|
+
@validate_call
|
836
|
+
def connectors_validate_without_preload_content(
|
837
|
+
self,
|
838
|
+
id: Annotated[Union[StrictFloat, StrictInt], Field(description="Connector's primary identifier")],
|
839
|
+
request_body: Annotated[Dict[str, StrictStr], Field(description="Connector's input credentials in a key-value object.")],
|
840
|
+
_request_timeout: Union[
|
841
|
+
None,
|
842
|
+
Annotated[StrictFloat, Field(gt=0)],
|
843
|
+
Tuple[
|
844
|
+
Annotated[StrictFloat, Field(gt=0)],
|
845
|
+
Annotated[StrictFloat, Field(gt=0)]
|
846
|
+
]
|
847
|
+
] = None,
|
848
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
849
|
+
_content_type: Optional[StrictStr] = None,
|
850
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
851
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
852
|
+
) -> RESTResponseType:
|
853
|
+
"""Validate
|
854
|
+
|
855
|
+
Validates a connector parameters usign the connector validation
|
856
|
+
|
857
|
+
:param id: Connector's primary identifier (required)
|
858
|
+
:type id: float
|
859
|
+
:param request_body: Connector's input credentials in a key-value object. (required)
|
860
|
+
:type request_body: Dict[str, str]
|
861
|
+
:param _request_timeout: timeout setting for this request. If one
|
862
|
+
number provided, it will be total request
|
863
|
+
timeout. It can also be a pair (tuple) of
|
864
|
+
(connection, read) timeouts.
|
865
|
+
:type _request_timeout: int, tuple(int, int), optional
|
866
|
+
:param _request_auth: set to override the auth_settings for an a single
|
867
|
+
request; this effectively ignores the
|
868
|
+
authentication in the spec for a single request.
|
869
|
+
:type _request_auth: dict, optional
|
870
|
+
:param _content_type: force content-type for the request.
|
871
|
+
:type _content_type: str, Optional
|
872
|
+
:param _headers: set to override the headers for a single
|
873
|
+
request; this effectively ignores the headers
|
874
|
+
in the spec for a single request.
|
875
|
+
:type _headers: dict, optional
|
876
|
+
:param _host_index: set to override the host_index for a single
|
877
|
+
request; this effectively ignores the host_index
|
878
|
+
in the spec for a single request.
|
879
|
+
:type _host_index: int, optional
|
880
|
+
:return: Returns the result object.
|
881
|
+
""" # noqa: E501
|
882
|
+
|
883
|
+
_param = self._connectors_validate_serialize(
|
884
|
+
id=id,
|
885
|
+
request_body=request_body,
|
886
|
+
_request_auth=_request_auth,
|
887
|
+
_content_type=_content_type,
|
888
|
+
_headers=_headers,
|
889
|
+
_host_index=_host_index
|
890
|
+
)
|
891
|
+
|
892
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
893
|
+
'200': "ParameterValidationResponse",
|
894
|
+
}
|
895
|
+
response_data = self.api_client.call_api(
|
896
|
+
*_param,
|
897
|
+
_request_timeout=_request_timeout
|
898
|
+
)
|
899
|
+
return response_data.response
|
900
|
+
|
901
|
+
|
902
|
+
def _connectors_validate_serialize(
|
903
|
+
self,
|
904
|
+
id,
|
905
|
+
request_body,
|
906
|
+
_request_auth,
|
907
|
+
_content_type,
|
908
|
+
_headers,
|
909
|
+
_host_index,
|
910
|
+
) -> RequestSerialized:
|
911
|
+
|
912
|
+
_host = None
|
913
|
+
|
914
|
+
_collection_formats: Dict[str, str] = {
|
915
|
+
}
|
916
|
+
|
917
|
+
_path_params: Dict[str, str] = {}
|
918
|
+
_query_params: List[Tuple[str, str]] = []
|
919
|
+
_header_params: Dict[str, Optional[str]] = _headers or {}
|
920
|
+
_form_params: List[Tuple[str, str]] = []
|
921
|
+
_files: Dict[
|
922
|
+
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
|
923
|
+
] = {}
|
924
|
+
_body_params: Optional[bytes] = None
|
925
|
+
|
926
|
+
# process the path parameters
|
927
|
+
if id is not None:
|
928
|
+
_path_params['id'] = id
|
929
|
+
# process the query parameters
|
930
|
+
# process the header parameters
|
931
|
+
# process the form parameters
|
932
|
+
# process the body parameter
|
933
|
+
if request_body is not None:
|
934
|
+
_body_params = request_body
|
935
|
+
|
936
|
+
|
937
|
+
# set the HTTP header `Accept`
|
938
|
+
if 'Accept' not in _header_params:
|
939
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
940
|
+
[
|
941
|
+
'application/json'
|
942
|
+
]
|
943
|
+
)
|
944
|
+
|
945
|
+
# set the HTTP header `Content-Type`
|
946
|
+
if _content_type:
|
947
|
+
_header_params['Content-Type'] = _content_type
|
948
|
+
else:
|
949
|
+
_default_content_type = (
|
950
|
+
self.api_client.select_header_content_type(
|
951
|
+
[
|
952
|
+
'application/json'
|
953
|
+
]
|
954
|
+
)
|
955
|
+
)
|
956
|
+
if _default_content_type is not None:
|
957
|
+
_header_params['Content-Type'] = _default_content_type
|
958
|
+
|
959
|
+
# authentication setting
|
960
|
+
_auth_settings: List[str] = [
|
961
|
+
'default'
|
962
|
+
]
|
963
|
+
|
964
|
+
return self.api_client.param_serialize(
|
965
|
+
method='POST',
|
966
|
+
resource_path='/connectors/{id}/validate',
|
967
|
+
path_params=_path_params,
|
968
|
+
query_params=_query_params,
|
969
|
+
header_params=_header_params,
|
970
|
+
body=_body_params,
|
971
|
+
post_params=_form_params,
|
972
|
+
files=_files,
|
973
|
+
auth_settings=_auth_settings,
|
974
|
+
collection_formats=_collection_formats,
|
975
|
+
_host=_host,
|
976
|
+
_request_auth=_request_auth
|
977
|
+
)
|
978
|
+
|
979
|
+
|