kiban-link 1.0.0__tar.gz

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.
Files changed (53) hide show
  1. kiban_link-1.0.0/LICENSE +202 -0
  2. kiban_link-1.0.0/NOTICE +6 -0
  3. kiban_link-1.0.0/PKG-INFO +173 -0
  4. kiban_link-1.0.0/README.md +151 -0
  5. kiban_link-1.0.0/kiban/link/__init__.py +75 -0
  6. kiban_link-1.0.0/kiban/link/api/__init__.py +6 -0
  7. kiban_link-1.0.0/kiban/link/api/link_api.py +1682 -0
  8. kiban_link-1.0.0/kiban/link/api/vault_api.py +1881 -0
  9. kiban_link-1.0.0/kiban/link/api_client.py +820 -0
  10. kiban_link-1.0.0/kiban/link/api_response.py +21 -0
  11. kiban_link-1.0.0/kiban/link/configuration.py +648 -0
  12. kiban_link-1.0.0/kiban/link/exceptions.py +219 -0
  13. kiban_link-1.0.0/kiban/link/models/__init__.py +29 -0
  14. kiban_link-1.0.0/kiban/link/models/controller_microservice_model_api_data_detail_dto.py +132 -0
  15. kiban_link-1.0.0/kiban/link/models/controller_microservice_model_api_data_event_dto.py +96 -0
  16. kiban_link-1.0.0/kiban/link/models/controller_microservice_model_api_data_file_dto.py +93 -0
  17. kiban_link-1.0.0/kiban/link/models/controller_microservice_model_api_data_http_dto.py +105 -0
  18. kiban_link-1.0.0/kiban/link/models/controller_microservice_model_event_dto.py +93 -0
  19. kiban_link-1.0.0/kiban/link/models/controller_microservice_model_execution_page.py +106 -0
  20. kiban_link-1.0.0/kiban/link/models/controller_microservice_model_microservice_detail_dto.py +156 -0
  21. kiban_link-1.0.0/kiban/link/models/controller_microservice_model_microservice_resume_dto.py +130 -0
  22. kiban_link-1.0.0/kiban/link/models/controller_microservice_model_validation_error_dto.py +109 -0
  23. kiban_link-1.0.0/kiban/link/models/controller_microservice_model_vault_name_dto.py +89 -0
  24. kiban_link-1.0.0/kiban/link/models/controller_microservice_model_vault_validation_dto.py +99 -0
  25. kiban_link-1.0.0/kiban/link/models/controller_test_case_model_test_case_output_many.py +101 -0
  26. kiban_link-1.0.0/kiban/link/models/domain_vault_model_vault_dto.py +101 -0
  27. kiban_link-1.0.0/kiban/link/models/domain_vault_model_vault_edit_dto.py +101 -0
  28. kiban_link-1.0.0/kiban/link/py.typed +0 -0
  29. kiban_link-1.0.0/kiban/link/rest.py +314 -0
  30. kiban_link-1.0.0/kiban_link.egg-info/PKG-INFO +173 -0
  31. kiban_link-1.0.0/kiban_link.egg-info/SOURCES.txt +52 -0
  32. kiban_link-1.0.0/kiban_link.egg-info/dependency_links.txt +1 -0
  33. kiban_link-1.0.0/kiban_link.egg-info/requires.txt +4 -0
  34. kiban_link-1.0.0/kiban_link.egg-info/top_level.txt +1 -0
  35. kiban_link-1.0.0/pyproject.toml +95 -0
  36. kiban_link-1.0.0/setup.cfg +7 -0
  37. kiban_link-1.0.0/setup.py +49 -0
  38. kiban_link-1.0.0/test/test_controller_microservice_model_api_data_detail_dto.py +78 -0
  39. kiban_link-1.0.0/test/test_controller_microservice_model_api_data_event_dto.py +53 -0
  40. kiban_link-1.0.0/test/test_controller_microservice_model_api_data_file_dto.py +54 -0
  41. kiban_link-1.0.0/test/test_controller_microservice_model_api_data_http_dto.py +57 -0
  42. kiban_link-1.0.0/test/test_controller_microservice_model_event_dto.py +54 -0
  43. kiban_link-1.0.0/test/test_controller_microservice_model_execution_page.py +71 -0
  44. kiban_link-1.0.0/test/test_controller_microservice_model_microservice_detail_dto.py +96 -0
  45. kiban_link-1.0.0/test/test_controller_microservice_model_microservice_resume_dto.py +66 -0
  46. kiban_link-1.0.0/test/test_controller_microservice_model_validation_error_dto.py +66 -0
  47. kiban_link-1.0.0/test/test_controller_microservice_model_vault_name_dto.py +52 -0
  48. kiban_link-1.0.0/test/test_controller_microservice_model_vault_validation_dto.py +52 -0
  49. kiban_link-1.0.0/test/test_controller_test_case_model_test_case_output_many.py +58 -0
  50. kiban_link-1.0.0/test/test_domain_vault_model_vault_dto.py +61 -0
  51. kiban_link-1.0.0/test/test_domain_vault_model_vault_edit_dto.py +61 -0
  52. kiban_link-1.0.0/test/test_link_api.py +67 -0
  53. kiban_link-1.0.0/test/test_vault_api.py +74 -0
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
@@ -0,0 +1,6 @@
1
+ kiban SDKs
2
+ Copyright 2026 Nkonect S.A. de C.V.
3
+
4
+ Este producto se distribuye bajo la licencia Apache License, Version 2.0
5
+ (ver el archivo LICENSE). "kiban" y sus logotipos son marcas de Nkonect S.A. de C.V.;
6
+ esta licencia no otorga derechos sobre ellas.
@@ -0,0 +1,173 @@
1
+ Metadata-Version: 2.4
2
+ Name: kiban-link
3
+ Version: 1.0.0
4
+ Summary: Link API
5
+ Home-page: https://github.com/kiban-cloud/kiban-sdk
6
+ Author: kiban
7
+ Author-email: kiban <hola@kiban.com>
8
+ License-Expression: Apache-2.0
9
+ Project-URL: Repository, https://github.com/kiban-cloud/kiban-sdk
10
+ Keywords: kiban,link,sdk,api
11
+ Requires-Python: >=3.9
12
+ Description-Content-Type: text/markdown
13
+ License-File: LICENSE
14
+ License-File: NOTICE
15
+ Requires-Dist: urllib3<3.0.0,>=2.6.3
16
+ Requires-Dist: python-dateutil>=2.8.2
17
+ Requires-Dist: pydantic>=2.11
18
+ Requires-Dist: typing-extensions>=4.7.1
19
+ Dynamic: author
20
+ Dynamic: home-page
21
+ Dynamic: license-file
22
+
23
+ # kiban-link
24
+ Servicios de consulta y validación de kiban (CURP, SAT, IMSS, Buró, etc.) y administración de credenciales. En sandbox (sandbox.link.kiban.com) las ejecuciones responden test cases en lugar de llamar al proveedor.
25
+
26
+ This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
27
+
28
+ - API version: 1.0
29
+ - Package version: 1.0.0
30
+ - Generator version: 7.24.0
31
+ - Build package: org.openapitools.codegen.languages.PythonClientCodegen
32
+ For more information, please visit [https://kiban.com](https://kiban.com)
33
+
34
+ ## Requirements.
35
+
36
+ Python 3.10+
37
+
38
+ ## Installation & Usage
39
+ ### pip install
40
+
41
+ If the python package is hosted on a repository, you can install directly using:
42
+
43
+ ```sh
44
+ pip install git+https://github.com/kiban-cloud/kiban-sdk.git
45
+ ```
46
+ (you may need to run `pip` with root permission: `sudo pip install git+https://github.com/kiban-cloud/kiban-sdk.git`)
47
+
48
+ Then import the package:
49
+ ```python
50
+ import kiban.link
51
+ ```
52
+
53
+ ### Setuptools
54
+
55
+ Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
56
+
57
+ ```sh
58
+ python setup.py install --user
59
+ ```
60
+ (or `sudo python setup.py install` to install the package for all users)
61
+
62
+ Then import the package:
63
+ ```python
64
+ import kiban.link
65
+ ```
66
+
67
+ ### Tests
68
+
69
+ Execute `pytest` to run the tests.
70
+
71
+ ## Getting Started
72
+
73
+ Please follow the [installation procedure](#installation--usage) and then run the following:
74
+
75
+ ```python
76
+
77
+ import kiban.link
78
+ from kiban.link.rest import ApiException
79
+ from pprint import pprint
80
+
81
+ # Defining the host is optional and defaults to https://link.kiban.com
82
+ # See configuration.py for a list of all supported configuration parameters.
83
+ configuration = kiban.link.Configuration(
84
+ host = "https://link.kiban.com"
85
+ )
86
+
87
+ # The client must configure the authentication and authorization parameters
88
+ # in accordance with the API server security policy.
89
+ # Examples for each auth method are provided below, use the example that
90
+ # satisfies your auth use case.
91
+
92
+ # Configure API key authorization: ApiKeyAuth
93
+ configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]
94
+
95
+ # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
96
+ # configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'
97
+
98
+
99
+ # Enter a context with an instance of the API client
100
+ with kiban.link.ApiClient(configuration) as api_client:
101
+ # Create an instance of the API class
102
+ api_instance = kiban.link.LinkApi(api_client)
103
+ service = 'service_example' # str | Servicio del catálogo (p. ej. curp, sat, imss, bc_pf)
104
+ subservice = 'subservice_example' # str | Operación del servicio (p. ej. validate, query)
105
+ body = None # object | Datos del servicio; cada servicio define sus campos
106
+ sandbox = True # bool | Modo sandbox. Tiene que coincidir con el modo de la API key: una key de sandbox exige sandbox=true y una de producción no lo acepta. Se ignora en el host sandbox, donde ya es implícito (optional)
107
+ test_case = 'test_case_example' # str | Sandbox: nombre del test case que debe responder (optional)
108
+ test_case_id = 'test_case_id_example' # str | Sandbox: id del test case que debe responder (optional)
109
+ origin = 'origin_example' # str | Identificador libre del origen de la petición (optional)
110
+
111
+ try:
112
+ # Ejecutar un servicio de link
113
+ api_response = api_instance.execute_service(service, subservice, body, sandbox=sandbox, test_case=test_case, test_case_id=test_case_id, origin=origin)
114
+ print("The response of LinkApi->execute_service:\n")
115
+ pprint(api_response)
116
+ except ApiException as e:
117
+ print("Exception when calling LinkApi->execute_service: %s\n" % e)
118
+
119
+ ```
120
+
121
+ ## Documentation for API Endpoints
122
+
123
+ All URIs are relative to *https://link.kiban.com*
124
+
125
+ Class | Method | HTTP request | Description
126
+ ------------ | ------------- | ------------- | -------------
127
+ *LinkApi* | [**execute_service**](docs/LinkApi.md#execute_service) | **POST** /api/v3/{service}/{subservice} | Ejecutar un servicio de link
128
+ *LinkApi* | [**get_execution**](docs/LinkApi.md#get_execution) | **GET** /api/v1/{service}/{subservice}/{id} | Detalle de una ejecución
129
+ *LinkApi* | [**get_file**](docs/LinkApi.md#get_file) | **GET** /api/v1/file | Descargar un archivo de una ejecución
130
+ *LinkApi* | [**list_executions**](docs/LinkApi.md#list_executions) | **GET** /api/v1/{service}/{subservice} | Historial de ejecuciones de un servicio
131
+ *LinkApi* | [**list_test_cases**](docs/LinkApi.md#list_test_cases) | **GET** /api/v3/{service}/{subservice}/test_case | Test cases de un servicio
132
+ *VaultApi* | [**create_vault**](docs/VaultApi.md#create_vault) | **POST** /api/v3/vault/na | Crear una credencial
133
+ *VaultApi* | [**delete_vault**](docs/VaultApi.md#delete_vault) | **DELETE** /api/v3/vault/na/{id} | Borrar una credencial
134
+ *VaultApi* | [**get_vault**](docs/VaultApi.md#get_vault) | **GET** /api/v1/vault/na/{id} | Detalle de una credencial
135
+ *VaultApi* | [**list_vaults**](docs/VaultApi.md#list_vaults) | **GET** /api/v1/vault/na | Listar credenciales
136
+ *VaultApi* | [**update_vault**](docs/VaultApi.md#update_vault) | **PUT** /api/v3/vault/na/{id} | Editar una credencial
137
+ *VaultApi* | [**validate_vault**](docs/VaultApi.md#validate_vault) | **POST** /api/v3/{service}/{subservice}/vault | Validar una credencial para un servicio
138
+
139
+
140
+ ## Documentation For Models
141
+
142
+ - [ControllerMicroserviceModelApiDataDetailDto](docs/ControllerMicroserviceModelApiDataDetailDto.md)
143
+ - [ControllerMicroserviceModelApiDataEventDto](docs/ControllerMicroserviceModelApiDataEventDto.md)
144
+ - [ControllerMicroserviceModelApiDataFileDto](docs/ControllerMicroserviceModelApiDataFileDto.md)
145
+ - [ControllerMicroserviceModelApiDataHttpDto](docs/ControllerMicroserviceModelApiDataHttpDto.md)
146
+ - [ControllerMicroserviceModelEventDto](docs/ControllerMicroserviceModelEventDto.md)
147
+ - [ControllerMicroserviceModelExecutionPage](docs/ControllerMicroserviceModelExecutionPage.md)
148
+ - [ControllerMicroserviceModelMicroserviceDetailDto](docs/ControllerMicroserviceModelMicroserviceDetailDto.md)
149
+ - [ControllerMicroserviceModelMicroserviceResumeDto](docs/ControllerMicroserviceModelMicroserviceResumeDto.md)
150
+ - [ControllerMicroserviceModelValidationErrorDto](docs/ControllerMicroserviceModelValidationErrorDto.md)
151
+ - [ControllerMicroserviceModelVaultNameDto](docs/ControllerMicroserviceModelVaultNameDto.md)
152
+ - [ControllerMicroserviceModelVaultValidationDto](docs/ControllerMicroserviceModelVaultValidationDto.md)
153
+ - [ControllerTestCaseModelTestCaseOutputMany](docs/ControllerTestCaseModelTestCaseOutputMany.md)
154
+
155
+
156
+ <a id="documentation-for-authorization"></a>
157
+ ## Documentation For Authorization
158
+
159
+
160
+ Authentication schemes defined for the API:
161
+ <a id="ApiKeyAuth"></a>
162
+ ### ApiKeyAuth
163
+
164
+ - **Type**: API key
165
+ - **API key parameter name**: x-api-key
166
+ - **Location**: HTTP header
167
+
168
+
169
+ ## Author
170
+
171
+ hola@kiban.com
172
+
173
+
@@ -0,0 +1,151 @@
1
+ # kiban-link
2
+ Servicios de consulta y validación de kiban (CURP, SAT, IMSS, Buró, etc.) y administración de credenciales. En sandbox (sandbox.link.kiban.com) las ejecuciones responden test cases en lugar de llamar al proveedor.
3
+
4
+ This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
5
+
6
+ - API version: 1.0
7
+ - Package version: 1.0.0
8
+ - Generator version: 7.24.0
9
+ - Build package: org.openapitools.codegen.languages.PythonClientCodegen
10
+ For more information, please visit [https://kiban.com](https://kiban.com)
11
+
12
+ ## Requirements.
13
+
14
+ Python 3.10+
15
+
16
+ ## Installation & Usage
17
+ ### pip install
18
+
19
+ If the python package is hosted on a repository, you can install directly using:
20
+
21
+ ```sh
22
+ pip install git+https://github.com/kiban-cloud/kiban-sdk.git
23
+ ```
24
+ (you may need to run `pip` with root permission: `sudo pip install git+https://github.com/kiban-cloud/kiban-sdk.git`)
25
+
26
+ Then import the package:
27
+ ```python
28
+ import kiban.link
29
+ ```
30
+
31
+ ### Setuptools
32
+
33
+ Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
34
+
35
+ ```sh
36
+ python setup.py install --user
37
+ ```
38
+ (or `sudo python setup.py install` to install the package for all users)
39
+
40
+ Then import the package:
41
+ ```python
42
+ import kiban.link
43
+ ```
44
+
45
+ ### Tests
46
+
47
+ Execute `pytest` to run the tests.
48
+
49
+ ## Getting Started
50
+
51
+ Please follow the [installation procedure](#installation--usage) and then run the following:
52
+
53
+ ```python
54
+
55
+ import kiban.link
56
+ from kiban.link.rest import ApiException
57
+ from pprint import pprint
58
+
59
+ # Defining the host is optional and defaults to https://link.kiban.com
60
+ # See configuration.py for a list of all supported configuration parameters.
61
+ configuration = kiban.link.Configuration(
62
+ host = "https://link.kiban.com"
63
+ )
64
+
65
+ # The client must configure the authentication and authorization parameters
66
+ # in accordance with the API server security policy.
67
+ # Examples for each auth method are provided below, use the example that
68
+ # satisfies your auth use case.
69
+
70
+ # Configure API key authorization: ApiKeyAuth
71
+ configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]
72
+
73
+ # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
74
+ # configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'
75
+
76
+
77
+ # Enter a context with an instance of the API client
78
+ with kiban.link.ApiClient(configuration) as api_client:
79
+ # Create an instance of the API class
80
+ api_instance = kiban.link.LinkApi(api_client)
81
+ service = 'service_example' # str | Servicio del catálogo (p. ej. curp, sat, imss, bc_pf)
82
+ subservice = 'subservice_example' # str | Operación del servicio (p. ej. validate, query)
83
+ body = None # object | Datos del servicio; cada servicio define sus campos
84
+ sandbox = True # bool | Modo sandbox. Tiene que coincidir con el modo de la API key: una key de sandbox exige sandbox=true y una de producción no lo acepta. Se ignora en el host sandbox, donde ya es implícito (optional)
85
+ test_case = 'test_case_example' # str | Sandbox: nombre del test case que debe responder (optional)
86
+ test_case_id = 'test_case_id_example' # str | Sandbox: id del test case que debe responder (optional)
87
+ origin = 'origin_example' # str | Identificador libre del origen de la petición (optional)
88
+
89
+ try:
90
+ # Ejecutar un servicio de link
91
+ api_response = api_instance.execute_service(service, subservice, body, sandbox=sandbox, test_case=test_case, test_case_id=test_case_id, origin=origin)
92
+ print("The response of LinkApi->execute_service:\n")
93
+ pprint(api_response)
94
+ except ApiException as e:
95
+ print("Exception when calling LinkApi->execute_service: %s\n" % e)
96
+
97
+ ```
98
+
99
+ ## Documentation for API Endpoints
100
+
101
+ All URIs are relative to *https://link.kiban.com*
102
+
103
+ Class | Method | HTTP request | Description
104
+ ------------ | ------------- | ------------- | -------------
105
+ *LinkApi* | [**execute_service**](docs/LinkApi.md#execute_service) | **POST** /api/v3/{service}/{subservice} | Ejecutar un servicio de link
106
+ *LinkApi* | [**get_execution**](docs/LinkApi.md#get_execution) | **GET** /api/v1/{service}/{subservice}/{id} | Detalle de una ejecución
107
+ *LinkApi* | [**get_file**](docs/LinkApi.md#get_file) | **GET** /api/v1/file | Descargar un archivo de una ejecución
108
+ *LinkApi* | [**list_executions**](docs/LinkApi.md#list_executions) | **GET** /api/v1/{service}/{subservice} | Historial de ejecuciones de un servicio
109
+ *LinkApi* | [**list_test_cases**](docs/LinkApi.md#list_test_cases) | **GET** /api/v3/{service}/{subservice}/test_case | Test cases de un servicio
110
+ *VaultApi* | [**create_vault**](docs/VaultApi.md#create_vault) | **POST** /api/v3/vault/na | Crear una credencial
111
+ *VaultApi* | [**delete_vault**](docs/VaultApi.md#delete_vault) | **DELETE** /api/v3/vault/na/{id} | Borrar una credencial
112
+ *VaultApi* | [**get_vault**](docs/VaultApi.md#get_vault) | **GET** /api/v1/vault/na/{id} | Detalle de una credencial
113
+ *VaultApi* | [**list_vaults**](docs/VaultApi.md#list_vaults) | **GET** /api/v1/vault/na | Listar credenciales
114
+ *VaultApi* | [**update_vault**](docs/VaultApi.md#update_vault) | **PUT** /api/v3/vault/na/{id} | Editar una credencial
115
+ *VaultApi* | [**validate_vault**](docs/VaultApi.md#validate_vault) | **POST** /api/v3/{service}/{subservice}/vault | Validar una credencial para un servicio
116
+
117
+
118
+ ## Documentation For Models
119
+
120
+ - [ControllerMicroserviceModelApiDataDetailDto](docs/ControllerMicroserviceModelApiDataDetailDto.md)
121
+ - [ControllerMicroserviceModelApiDataEventDto](docs/ControllerMicroserviceModelApiDataEventDto.md)
122
+ - [ControllerMicroserviceModelApiDataFileDto](docs/ControllerMicroserviceModelApiDataFileDto.md)
123
+ - [ControllerMicroserviceModelApiDataHttpDto](docs/ControllerMicroserviceModelApiDataHttpDto.md)
124
+ - [ControllerMicroserviceModelEventDto](docs/ControllerMicroserviceModelEventDto.md)
125
+ - [ControllerMicroserviceModelExecutionPage](docs/ControllerMicroserviceModelExecutionPage.md)
126
+ - [ControllerMicroserviceModelMicroserviceDetailDto](docs/ControllerMicroserviceModelMicroserviceDetailDto.md)
127
+ - [ControllerMicroserviceModelMicroserviceResumeDto](docs/ControllerMicroserviceModelMicroserviceResumeDto.md)
128
+ - [ControllerMicroserviceModelValidationErrorDto](docs/ControllerMicroserviceModelValidationErrorDto.md)
129
+ - [ControllerMicroserviceModelVaultNameDto](docs/ControllerMicroserviceModelVaultNameDto.md)
130
+ - [ControllerMicroserviceModelVaultValidationDto](docs/ControllerMicroserviceModelVaultValidationDto.md)
131
+ - [ControllerTestCaseModelTestCaseOutputMany](docs/ControllerTestCaseModelTestCaseOutputMany.md)
132
+
133
+
134
+ <a id="documentation-for-authorization"></a>
135
+ ## Documentation For Authorization
136
+
137
+
138
+ Authentication schemes defined for the API:
139
+ <a id="ApiKeyAuth"></a>
140
+ ### ApiKeyAuth
141
+
142
+ - **Type**: API key
143
+ - **API key parameter name**: x-api-key
144
+ - **Location**: HTTP header
145
+
146
+
147
+ ## Author
148
+
149
+ hola@kiban.com
150
+
151
+
@@ -0,0 +1,75 @@
1
+ # coding: utf-8
2
+
3
+ # flake8: noqa
4
+
5
+ """
6
+ Link API
7
+
8
+ Servicios de consulta y validación de kiban (CURP, SAT, IMSS, Buró, etc.) y administración de credenciales. En sandbox (sandbox.link.kiban.com) las ejecuciones responden test cases en lugar de llamar al proveedor.
9
+
10
+ The version of the OpenAPI document: 1.0
11
+ Contact: hola@kiban.com
12
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
13
+
14
+ Do not edit the class manually.
15
+ """ # noqa: E501
16
+
17
+
18
+ __version__ = "1.0.0"
19
+
20
+ # Define package exports
21
+ __all__ = [
22
+ "LinkApi",
23
+ "VaultApi",
24
+ "ApiResponse",
25
+ "ApiClient",
26
+ "Configuration",
27
+ "OpenApiException",
28
+ "ApiTypeError",
29
+ "ApiValueError",
30
+ "ApiKeyError",
31
+ "ApiAttributeError",
32
+ "ApiException",
33
+ "ControllerMicroserviceModelApiDataDetailDto",
34
+ "ControllerMicroserviceModelApiDataEventDto",
35
+ "ControllerMicroserviceModelApiDataFileDto",
36
+ "ControllerMicroserviceModelApiDataHttpDto",
37
+ "ControllerMicroserviceModelEventDto",
38
+ "ControllerMicroserviceModelExecutionPage",
39
+ "ControllerMicroserviceModelMicroserviceDetailDto",
40
+ "ControllerMicroserviceModelMicroserviceResumeDto",
41
+ "ControllerMicroserviceModelValidationErrorDto",
42
+ "ControllerMicroserviceModelVaultNameDto",
43
+ "ControllerMicroserviceModelVaultValidationDto",
44
+ "ControllerTestCaseModelTestCaseOutputMany",
45
+ ]
46
+
47
+ # import apis into sdk package
48
+ from kiban.link.api.link_api import LinkApi as LinkApi
49
+ from kiban.link.api.vault_api import VaultApi as VaultApi
50
+
51
+ # import ApiClient
52
+ from kiban.link.api_response import ApiResponse as ApiResponse
53
+ from kiban.link.api_client import ApiClient as ApiClient
54
+ from kiban.link.configuration import Configuration as Configuration
55
+ from kiban.link.exceptions import OpenApiException as OpenApiException
56
+ from kiban.link.exceptions import ApiTypeError as ApiTypeError
57
+ from kiban.link.exceptions import ApiValueError as ApiValueError
58
+ from kiban.link.exceptions import ApiKeyError as ApiKeyError
59
+ from kiban.link.exceptions import ApiAttributeError as ApiAttributeError
60
+ from kiban.link.exceptions import ApiException as ApiException
61
+
62
+ # import models into sdk package
63
+ from kiban.link.models.controller_microservice_model_api_data_detail_dto import ControllerMicroserviceModelApiDataDetailDto as ControllerMicroserviceModelApiDataDetailDto
64
+ from kiban.link.models.controller_microservice_model_api_data_event_dto import ControllerMicroserviceModelApiDataEventDto as ControllerMicroserviceModelApiDataEventDto
65
+ from kiban.link.models.controller_microservice_model_api_data_file_dto import ControllerMicroserviceModelApiDataFileDto as ControllerMicroserviceModelApiDataFileDto
66
+ from kiban.link.models.controller_microservice_model_api_data_http_dto import ControllerMicroserviceModelApiDataHttpDto as ControllerMicroserviceModelApiDataHttpDto
67
+ from kiban.link.models.controller_microservice_model_event_dto import ControllerMicroserviceModelEventDto as ControllerMicroserviceModelEventDto
68
+ from kiban.link.models.controller_microservice_model_execution_page import ControllerMicroserviceModelExecutionPage as ControllerMicroserviceModelExecutionPage
69
+ from kiban.link.models.controller_microservice_model_microservice_detail_dto import ControllerMicroserviceModelMicroserviceDetailDto as ControllerMicroserviceModelMicroserviceDetailDto
70
+ from kiban.link.models.controller_microservice_model_microservice_resume_dto import ControllerMicroserviceModelMicroserviceResumeDto as ControllerMicroserviceModelMicroserviceResumeDto
71
+ from kiban.link.models.controller_microservice_model_validation_error_dto import ControllerMicroserviceModelValidationErrorDto as ControllerMicroserviceModelValidationErrorDto
72
+ from kiban.link.models.controller_microservice_model_vault_name_dto import ControllerMicroserviceModelVaultNameDto as ControllerMicroserviceModelVaultNameDto
73
+ from kiban.link.models.controller_microservice_model_vault_validation_dto import ControllerMicroserviceModelVaultValidationDto as ControllerMicroserviceModelVaultValidationDto
74
+ from kiban.link.models.controller_test_case_model_test_case_output_many import ControllerTestCaseModelTestCaseOutputMany as ControllerTestCaseModelTestCaseOutputMany
75
+
@@ -0,0 +1,6 @@
1
+ # flake8: noqa
2
+
3
+ # import apis into api package
4
+ from kiban.link.api.link_api import LinkApi
5
+ from kiban.link.api.vault_api import VaultApi
6
+