From 7030051f537a8268438341d06a2ac749c56114f6 Mon Sep 17 00:00:00 2001 From: Balamurali Pandranki Date: Thu, 10 Mar 2022 10:34:29 +0000 Subject: [PATCH] Regenerate API SDKs --- README.md | 2 + docs/DataConsentsApi.md | 134 +++++++++++ mydatamyconsent/api/data_consents_api.py | 272 +++++++++++++++++++++++ 3 files changed, 408 insertions(+) diff --git a/README.md b/README.md index d1828ab..a89554f 100644 --- a/README.md +++ b/README.md @@ -95,6 +95,7 @@ Class | Method | HTTP request | Description *DataConsentRequestsApi* | [**get_all_consent_requests_to_organizations**](docs/DataConsentRequestsApi.md#get_all_consent_requests_to_organizations) | **GET** /v1/consent-requests/organizations | Get All Consent Requests sent to Organizations. *DataConsentRequestsApi* | [**get_individual_consent_request_by_id**](docs/DataConsentRequestsApi.md#get_individual_consent_request_by_id) | **GET** /v1/consent-requests/individuals/{requestId} | Get a Consent Request by ID. *DataConsentRequestsApi* | [**get_organization_consent_request_by_id**](docs/DataConsentRequestsApi.md#get_organization_consent_request_by_id) | **GET** /v1/consent-requests/organizations/{requestId} | Get a OrganizationConsent Request by Id. +*DataConsentsApi* | [**download_consented_document_analysis**](docs/DataConsentsApi.md#download_consented_document_analysis) | **GET** /v1/consents/{consentId}/documents/{documentId}/analysis | Get analysis of a consented document. *DataConsentsApi* | [**download_consented_document_by_id**](docs/DataConsentsApi.md#download_consented_document_by_id) | **GET** /v1/consents/individuals/{consentId}/documents/{documentId}/download | Download a individuals consented document. *DataConsentsApi* | [**download_org_consented_document_by_id**](docs/DataConsentsApi.md#download_org_consented_document_by_id) | **GET** /v1/consents/organizations/{consentId}/documents/{documentId}/download | Download a organizations consented document. *DataConsentsApi* | [**get_all_consented_documents**](docs/DataConsentsApi.md#get_all_consented_documents) | **GET** /v1/consents/individuals/{consentId}/documents | Get the individual documents based on ConsentId. @@ -105,6 +106,7 @@ Class | Method | HTTP request | Description *DataConsentsApi* | [**get_consented_account_by_id**](docs/DataConsentsApi.md#get_consented_account_by_id) | **GET** /v1/consents/individuals/{consentId}/financial-accounts/{accountId} | Get individual consented financial account details based on account id. *DataConsentsApi* | [**get_consented_document_by_id**](docs/DataConsentsApi.md#get_consented_document_by_id) | **GET** /v1/consents/individuals/{consentId}/documents/{documentId} | Get individuals consent document based on document id. *DataConsentsApi* | [**get_consented_financial_account**](docs/DataConsentsApi.md#get_consented_financial_account) | **GET** /v1/consents/organizations/{consentId}/financial-accounts/{accountId} | Get organization consented financial account details based on account id. +*DataConsentsApi* | [**get_consented_financial_account_insights**](docs/DataConsentsApi.md#get_consented_financial_account_insights) | **GET** /v1/consents/{consentId}/financial-accounts/{accountId}/insights | Get consented financial account insights. *DataConsentsApi* | [**get_consented_financial_account_transactions**](docs/DataConsentsApi.md#get_consented_financial_account_transactions) | **GET** /v1/consents/individuals/{consentId}/financial-accounts/{accountId}/transactions | Get individual consented financial account transactions of an individual based on accountId. *DataConsentsApi* | [**get_consents_for_organizations**](docs/DataConsentsApi.md#get_consents_for_organizations) | **GET** /v1/consents/organizations | Get the list of data consents sent for organizations. *DataConsentsApi* | [**get_consents_sent_to_individuals**](docs/DataConsentsApi.md#get_consents_sent_to_individuals) | **GET** /v1/consents/individuals | Get the list of Consents Sent to Individuals. diff --git a/docs/DataConsentsApi.md b/docs/DataConsentsApi.md index 28ab767..99cb996 100644 --- a/docs/DataConsentsApi.md +++ b/docs/DataConsentsApi.md @@ -4,6 +4,7 @@ All URIs are relative to *https://api.mydatamyconsent.com* Method | HTTP request | Description ------------- | ------------- | ------------- +[**download_consented_document_analysis**](DataConsentsApi.md#download_consented_document_analysis) | **GET** /v1/consents/{consentId}/documents/{documentId}/analysis | Get analysis of a consented document. [**download_consented_document_by_id**](DataConsentsApi.md#download_consented_document_by_id) | **GET** /v1/consents/individuals/{consentId}/documents/{documentId}/download | Download a individuals consented document. [**download_org_consented_document_by_id**](DataConsentsApi.md#download_org_consented_document_by_id) | **GET** /v1/consents/organizations/{consentId}/documents/{documentId}/download | Download a organizations consented document. [**get_all_consented_documents**](DataConsentsApi.md#get_all_consented_documents) | **GET** /v1/consents/individuals/{consentId}/documents | Get the individual documents based on ConsentId. @@ -14,6 +15,7 @@ Method | HTTP request | Description [**get_consented_account_by_id**](DataConsentsApi.md#get_consented_account_by_id) | **GET** /v1/consents/individuals/{consentId}/financial-accounts/{accountId} | Get individual consented financial account details based on account id. [**get_consented_document_by_id**](DataConsentsApi.md#get_consented_document_by_id) | **GET** /v1/consents/individuals/{consentId}/documents/{documentId} | Get individuals consent document based on document id. [**get_consented_financial_account**](DataConsentsApi.md#get_consented_financial_account) | **GET** /v1/consents/organizations/{consentId}/financial-accounts/{accountId} | Get organization consented financial account details based on account id. +[**get_consented_financial_account_insights**](DataConsentsApi.md#get_consented_financial_account_insights) | **GET** /v1/consents/{consentId}/financial-accounts/{accountId}/insights | Get consented financial account insights. [**get_consented_financial_account_transactions**](DataConsentsApi.md#get_consented_financial_account_transactions) | **GET** /v1/consents/individuals/{consentId}/financial-accounts/{accountId}/transactions | Get individual consented financial account transactions of an individual based on accountId. [**get_consents_for_organizations**](DataConsentsApi.md#get_consents_for_organizations) | **GET** /v1/consents/organizations | Get the list of data consents sent for organizations. [**get_consents_sent_to_individuals**](DataConsentsApi.md#get_consents_sent_to_individuals) | **GET** /v1/consents/individuals | Get the list of Consents Sent to Individuals. @@ -22,6 +24,72 @@ Method | HTTP request | Description [**get_organization_consented_document_by_id**](DataConsentsApi.md#get_organization_consented_document_by_id) | **GET** /v1/consents/organizations/{consentId}/documents/{documentId} | Get organization consent document based on document id. +# **download_consented_document_analysis** +> download_consented_document_analysis(consent_id, document_id) + +Get analysis of a consented document. + +### Example + + +```python +import time +import mydatamyconsent +from mydatamyconsent.api import data_consents_api +from pprint import pprint +# Defining the host is optional and defaults to https://api.mydatamyconsent.com +# See configuration.py for a list of all supported configuration parameters. +configuration = mydatamyconsent.Configuration( + host = "https://api.mydatamyconsent.com" +) + + +# Enter a context with an instance of the API client +with mydatamyconsent.ApiClient() as api_client: + # Create an instance of the API class + api_instance = data_consents_api.DataConsentsApi(api_client) + consent_id = "consentId_example" # str | + document_id = "documentId_example" # str | Document Id. + + # example passing only required values which don't have defaults set + try: + # Get analysis of a consented document. + api_instance.download_consented_document_analysis(consent_id, document_id) + except mydatamyconsent.ApiException as e: + print("Exception when calling DataConsentsApi->download_consented_document_analysis: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **consent_id** | **str**| | + **document_id** | **str**| Document Id. | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**500** | Server 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) + # **download_consented_document_by_id** > UserDocumentDownload download_consented_document_by_id(consent_id, document_id) @@ -683,6 +751,72 @@ No authorization required - **Accept**: application/json +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | +**500** | Server 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) + +# **get_consented_financial_account_insights** +> get_consented_financial_account_insights(consent_id, account_id) + +Get consented financial account insights. + +### Example + + +```python +import time +import mydatamyconsent +from mydatamyconsent.api import data_consents_api +from pprint import pprint +# Defining the host is optional and defaults to https://api.mydatamyconsent.com +# See configuration.py for a list of all supported configuration parameters. +configuration = mydatamyconsent.Configuration( + host = "https://api.mydatamyconsent.com" +) + + +# Enter a context with an instance of the API client +with mydatamyconsent.ApiClient() as api_client: + # Create an instance of the API class + api_instance = data_consents_api.DataConsentsApi(api_client) + consent_id = "consentId_example" # str | + account_id = "accountId_example" # str | + + # example passing only required values which don't have defaults set + try: + # Get consented financial account insights. + api_instance.get_consented_financial_account_insights(consent_id, account_id) + except mydatamyconsent.ApiException as e: + print("Exception when calling DataConsentsApi->get_consented_financial_account_insights: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **consent_id** | **str**| | + **account_id** | **str**| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + ### HTTP response details | Status code | Description | Response headers | diff --git a/mydatamyconsent/api/data_consents_api.py b/mydatamyconsent/api/data_consents_api.py index f85fe4b..7b1faf2 100644 --- a/mydatamyconsent/api/data_consents_api.py +++ b/mydatamyconsent/api/data_consents_api.py @@ -49,6 +49,61 @@ def __init__(self, api_client=None): if api_client is None: api_client = ApiClient() self.api_client = api_client + self.download_consented_document_analysis_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/v1/consents/{consentId}/documents/{documentId}/analysis', + 'operation_id': 'download_consented_document_analysis', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'consent_id', + 'document_id', + ], + 'required': [ + 'consent_id', + 'document_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'consent_id': + (str,), + 'document_id': + (str,), + }, + 'attribute_map': { + 'consent_id': 'consentId', + 'document_id': 'documentId', + }, + 'location_map': { + 'consent_id': 'path', + 'document_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) self.download_consented_document_by_id_endpoint = _Endpoint( settings={ 'response_type': (UserDocumentDownload,), @@ -569,6 +624,61 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.get_consented_financial_account_insights_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/v1/consents/{consentId}/financial-accounts/{accountId}/insights', + 'operation_id': 'get_consented_financial_account_insights', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'consent_id', + 'account_id', + ], + 'required': [ + 'consent_id', + 'account_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'consent_id': + (str,), + 'account_id': + (str,), + }, + 'attribute_map': { + 'consent_id': 'consentId', + 'account_id': 'accountId', + }, + 'location_map': { + 'consent_id': 'path', + 'account_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) self.get_consented_financial_account_transactions_endpoint = _Endpoint( settings={ 'response_type': (UserAccountFinancialTransactionsDtoPaginatedList,), @@ -968,6 +1078,87 @@ def __init__(self, api_client=None): api_client=api_client ) + def download_consented_document_analysis( + self, + consent_id, + document_id, + **kwargs + ): + """Get analysis of a consented document. # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.download_consented_document_analysis(consent_id, document_id, async_req=True) + >>> result = thread.get() + + Args: + consent_id (str): + document_id (str): Document Id. + + Keyword Args: + _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['consent_id'] = \ + consent_id + kwargs['document_id'] = \ + document_id + return self.download_consented_document_analysis_endpoint.call_with_http_info(**kwargs) + def download_consented_document_by_id( self, consent_id, @@ -1758,6 +1949,87 @@ def get_consented_financial_account( account_id return self.get_consented_financial_account_endpoint.call_with_http_info(**kwargs) + def get_consented_financial_account_insights( + self, + consent_id, + account_id, + **kwargs + ): + """Get consented financial account insights. # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_consented_financial_account_insights(consent_id, account_id, async_req=True) + >>> result = thread.get() + + Args: + consent_id (str): + account_id (str): + + Keyword Args: + _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['consent_id'] = \ + consent_id + kwargs['account_id'] = \ + account_id + return self.get_consented_financial_account_insights_endpoint.call_with_http_info(**kwargs) + def get_consented_financial_account_transactions( self, consent_id,