step_rest_client 1.0.0__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.
Files changed (117) hide show
  1. step_rest_client/__init__.py +136 -0
  2. step_rest_client/api/__init__.py +26 -0
  3. step_rest_client/api/assets_api.py +7960 -0
  4. step_rest_client/api/attributes_api.py +340 -0
  5. step_rest_client/api/background_process_types_api.py +640 -0
  6. step_rest_client/api/background_processes_api.py +1577 -0
  7. step_rest_client/api/classifications_api.py +7991 -0
  8. step_rest_client/api/data_container_types_api.py +340 -0
  9. step_rest_client/api/data_type_groups_api.py +340 -0
  10. step_rest_client/api/entities_api.py +8680 -0
  11. step_rest_client/api/event_processors_api.py +3337 -0
  12. step_rest_client/api/export_api.py +383 -0
  13. step_rest_client/api/gateway_integration_endpoints_api.py +1232 -0
  14. step_rest_client/api/import_api.py +390 -0
  15. step_rest_client/api/inbound_integration_endpoints_api.py +2815 -0
  16. step_rest_client/api/lists_of_values_api.py +642 -0
  17. step_rest_client/api/object_types_api.py +340 -0
  18. step_rest_client/api/outbound_integration_endpoints_api.py +3655 -0
  19. step_rest_client/api/products_api.py +8007 -0
  20. step_rest_client/api/reference_types_api.py +340 -0
  21. step_rest_client/api/reporting_api.py +707 -0
  22. step_rest_client/api/units_api.py +340 -0
  23. step_rest_client/api/workflow_tasks_api.py +1887 -0
  24. step_rest_client/api/workflows_api.py +1270 -0
  25. step_rest_client/api_client.py +797 -0
  26. step_rest_client/api_response.py +21 -0
  27. step_rest_client/configuration.py +597 -0
  28. step_rest_client/exceptions.py +216 -0
  29. step_rest_client/models/__init__.py +98 -0
  30. step_rest_client/models/amount.py +89 -0
  31. step_rest_client/models/and_condition.py +107 -0
  32. step_rest_client/models/approval_response.py +87 -0
  33. step_rest_client/models/approval_status.py +99 -0
  34. step_rest_client/models/asset.py +129 -0
  35. step_rest_client/models/attribute.py +120 -0
  36. step_rest_client/models/attribute_link.py +102 -0
  37. step_rest_client/models/background_process.py +139 -0
  38. step_rest_client/models/background_process_attachment_metadata.py +105 -0
  39. step_rest_client/models/background_process_identification.py +89 -0
  40. step_rest_client/models/background_process_type.py +89 -0
  41. step_rest_client/models/classification.py +135 -0
  42. step_rest_client/models/condition.py +265 -0
  43. step_rest_client/models/data_container.py +139 -0
  44. step_rest_client/models/data_container_entry.py +117 -0
  45. step_rest_client/models/data_container_object_condition.py +181 -0
  46. step_rest_client/models/data_container_type.py +106 -0
  47. step_rest_client/models/data_type_group.py +108 -0
  48. step_rest_client/models/endpoint_statistics.py +109 -0
  49. step_rest_client/models/endpoint_status.py +99 -0
  50. step_rest_client/models/entity.py +142 -0
  51. step_rest_client/models/error.py +91 -0
  52. step_rest_client/models/event_processor.py +93 -0
  53. step_rest_client/models/event_processor_statistics.py +97 -0
  54. step_rest_client/models/event_processor_status.py +99 -0
  55. step_rest_client/models/event_queue_status.py +89 -0
  56. step_rest_client/models/execution_report_entry.py +103 -0
  57. step_rest_client/models/export_specification.py +89 -0
  58. step_rest_client/models/find_similar_business_rule_result.py +91 -0
  59. step_rest_client/models/find_similar_entities_request.py +95 -0
  60. step_rest_client/models/find_similar_entities_response.py +103 -0
  61. step_rest_client/models/find_similar_entities_response_record.py +95 -0
  62. step_rest_client/models/find_similar_execution_report.py +103 -0
  63. step_rest_client/models/gateway_integration_endpoint.py +93 -0
  64. step_rest_client/models/has_data_container_object_condition.py +106 -0
  65. step_rest_client/models/has_reference_to_condition.py +108 -0
  66. step_rest_client/models/id_condition.py +105 -0
  67. step_rest_client/models/inbound_integration_endpoint.py +93 -0
  68. step_rest_client/models/incoming_reference_entry.py +118 -0
  69. step_rest_client/models/list_of_values.py +110 -0
  70. step_rest_client/models/list_of_values_entry.py +91 -0
  71. step_rest_client/models/lov_value_condition.py +100 -0
  72. step_rest_client/models/match_and_merge_execution_report.py +119 -0
  73. step_rest_client/models/match_and_merge_general_execution_report.py +91 -0
  74. step_rest_client/models/match_and_merge_potential_duplicate.py +93 -0
  75. step_rest_client/models/match_and_merge_record_in.py +95 -0
  76. step_rest_client/models/match_and_merge_record_out.py +117 -0
  77. step_rest_client/models/match_and_merge_response.py +103 -0
  78. step_rest_client/models/multi_data_container.py +101 -0
  79. step_rest_client/models/multi_reference.py +97 -0
  80. step_rest_client/models/multi_value.py +103 -0
  81. step_rest_client/models/name_condition.py +107 -0
  82. step_rest_client/models/numeric_value_condition.py +111 -0
  83. step_rest_client/models/object_type.py +104 -0
  84. step_rest_client/models/object_type_condition.py +96 -0
  85. step_rest_client/models/or_condition.py +107 -0
  86. step_rest_client/models/outbound_integration_endpoint.py +93 -0
  87. step_rest_client/models/product.py +150 -0
  88. step_rest_client/models/query.py +91 -0
  89. step_rest_client/models/query_result.py +99 -0
  90. step_rest_client/models/reference.py +139 -0
  91. step_rest_client/models/reference_entry.py +141 -0
  92. step_rest_client/models/reference_metadata_condition.py +181 -0
  93. step_rest_client/models/reference_type.py +114 -0
  94. step_rest_client/models/rejected_by_business_condition.py +93 -0
  95. step_rest_client/models/simple_below_condition.py +105 -0
  96. step_rest_client/models/single_data_container.py +97 -0
  97. step_rest_client/models/single_reference.py +93 -0
  98. step_rest_client/models/single_value.py +103 -0
  99. step_rest_client/models/status_flag.py +89 -0
  100. step_rest_client/models/text_value_condition.py +111 -0
  101. step_rest_client/models/trigger_workflow_event.py +93 -0
  102. step_rest_client/models/unit.py +104 -0
  103. step_rest_client/models/value.py +137 -0
  104. step_rest_client/models/value_entry.py +91 -0
  105. step_rest_client/models/workflow.py +91 -0
  106. step_rest_client/models/workflow_event.py +89 -0
  107. step_rest_client/models/workflow_instance.py +87 -0
  108. step_rest_client/models/workflow_instance_creation.py +93 -0
  109. step_rest_client/models/workflow_node.py +99 -0
  110. step_rest_client/models/workflow_task.py +113 -0
  111. step_rest_client/models/workflow_task_query.py +101 -0
  112. step_rest_client/py.typed +0 -0
  113. step_rest_client/rest.py +258 -0
  114. step_rest_client-1.0.0.dist-info/METADATA +23 -0
  115. step_rest_client-1.0.0.dist-info/RECORD +117 -0
  116. step_rest_client-1.0.0.dist-info/WHEEL +5 -0
  117. step_rest_client-1.0.0.dist-info/top_level.txt +1 -0
@@ -0,0 +1,1232 @@
1
+ # coding: utf-8
2
+
3
+ """
4
+ STEP REST API V2
5
+
6
+ <h1>About</h1><p>The STEP REST API V2 provides read and write access to a set of core STEP objects using the HTTP operations GET, PUT, POST, PATCH and DELETE.</p><h1>Resource Representation</h1><p>With the exception of a few resource operations for retrieving and uploading binary data, all request and response bodies are JSON, compliant with the schema documented here.</p><h1>Context and Workspace</h1><p>All requests are handled in a specific STEP context and workspace and both can be specified via query parameters available for all resource operations. A context must always be specified while requests per default will be handled in the &quot;Main&quot; workspace.</p><h1>Polymorphism</h1><p>In STEP, attributes, reference types and data container types can all be either single- or multivalued. The STEP REST API V2 uses polymorphism to address this complexity with resources that include values, references and data containers specified to produce and consume a common &quot;abstract&quot; supertype that always will be one of either the single- or multivalued subtype.<br/>As an example, the GET /entities/{id}/values/{attributeId} resource operation is specified to return a &quot;Value&quot; but as evident from the model, the &quot;Value&quot; will always be &quot;oneOf&quot; either &quot;SingleValue&quot;, that has a &quot;value&quot; property for which the value is an object, or &quot;MultiValue&quot;, that has a &quot;values&quot; property for which the value is an array.<br/>Clients are advised to use the presence or absence of the plural array property (&quot;values&quot;, &quot;references&quot; and &quot;dataContainers&quot;) to determine the concrete type.</p><h1>Authentication</h1><p>The REST API is protected by HTTP Basic Authentication or if OAuth2-based authentication is enabled (SaaS customers only), by Bearer Authentication. With Basic Authentication, user name and password are supplied with each request and it is therefore highly recommended to only use the API in conjunction with HTTPS. For more information about OAuth2-based authentication for SaaS customers, please see the STEP Authentication Guide.</p><h1>Versioning</h1><p>The STEP REST API V2 is versioned using semantic versioning. Stibo Systems reserve the right to make non-breaking, minor / patch changes in any release without warning and clients must be coded / configured to be 'tolerant' and capable of handling such changes.</p><p>Examples of breaking, major changes:</p><ul><li>Renaming of a property</li><li>Removal of a property</li><li>Property type change</li><li>Addition of new property required for write operations</li><li>Marking existing property as required for write operations</li><li>Removal of resource or resource operation</li><li>Materially different behavior for existing resource operation</li></ul><p>Examples of non-breaking, minor / patch changes:</p><ul><li>Addition of new properties in request responses</li><li>Addition of new query parameter not required for write operations</li><li>Addition of new resource or resource operation</li><li>Bug fixes that do not change the schema or resource operations as described here</li><li>Inclusion of a response body for resource operations specified to return a 200 response with no body</li><li>Change of response &quot;Model&quot; / &quot;schema&quot; to type extending the previously specified type</li><li>Renaming a &quot;Model&quot; / &quot;schema&quot; type</li></ul><p>In addition, error message texts may change without warning within the same version. Client program logic should not depend upon the message content.</p><h1>Error Handling</h1><p>The STEP REST API V2 responds with standard HTTP status codes, with 2** responses indicating a success, 4** responses indicating a client error and 5** indicating a server error. Notice that this specification does not specify common error responses like 500 (internal server error) or 401 (unauthorized) for the individual resource operations. Clients should however be capable of handling such responses.</p><p>Error responses have a JSON response body (see Error schema below) containing HTTP status code information in addition to a message providing details about the error. As mentioned above, client program logic should not depend upon the message content.</p><p>The specific status codes used in the API are:</p><ul><li>200 (OK): Success, response may or may not have a body</li><li>201 (Created): Entity successfully created, response may or may not have a body</li><li>400 (Bad request): The server cannot or will not process the request due to an apparent client error</li><li>401 (Unauthorized): Returned only in relation to failed authentication</li><li>404 (Not Found): Returned only in relation to objects specified via path parameters (variable parts of the URL). If STEP objects referenced in request bodies or via query parameters cannot be found, the response will be 400.</li><li>429 (Too Many Requests): Clients are per default limited to 100 requests per second. Returned if the rate limit is exceeded.</li><li>500 (Internal Server Error): Unexpected error (could potentially cover an issue that rightfully should be a 400)</li></ul>
7
+
8
+ The version of the OpenAPI document: 1.3.0
9
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
10
+
11
+ Do not edit the class manually.
12
+ """ # noqa: E501
13
+
14
+ import warnings
15
+ from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
16
+ from typing import Any, Dict, List, Optional, Tuple, Union
17
+ from typing_extensions import Annotated
18
+
19
+ from pydantic import Field, StrictStr
20
+ from typing import List, Optional
21
+ from typing_extensions import Annotated
22
+ from step_rest_client.models.endpoint_status import EndpointStatus
23
+ from step_rest_client.models.gateway_integration_endpoint import GatewayIntegrationEndpoint
24
+
25
+ from step_rest_client.api_client import ApiClient, RequestSerialized
26
+ from step_rest_client.api_response import ApiResponse
27
+ from step_rest_client.rest import RESTResponseType
28
+
29
+
30
+ class GatewayIntegrationEndpointsApi:
31
+ """NOTE: This class is auto generated by OpenAPI Generator
32
+ Ref: https://openapi-generator.tech
33
+
34
+ Do not edit the class manually.
35
+ """
36
+
37
+ def __init__(self, api_client=None) -> None:
38
+ if api_client is None:
39
+ api_client = ApiClient.get_default()
40
+ self.api_client = api_client
41
+
42
+
43
+ @validate_call
44
+ def gateway_integration_endpoints_get(
45
+ self,
46
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
47
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
48
+ _request_timeout: Union[
49
+ None,
50
+ Annotated[StrictFloat, Field(gt=0)],
51
+ Tuple[
52
+ Annotated[StrictFloat, Field(gt=0)],
53
+ Annotated[StrictFloat, Field(gt=0)]
54
+ ]
55
+ ] = None,
56
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
57
+ _content_type: Optional[StrictStr] = None,
58
+ _headers: Optional[Dict[StrictStr, Any]] = None,
59
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
60
+ ) -> List[GatewayIntegrationEndpoint]:
61
+ """Returns basic gateway integration endpoint representations
62
+
63
+ Operation for retrieving an array of basic gateway integration endpoint representations for all accessible gateway endpoints.
64
+
65
+ :param context: ID of the context in which to perform the operation (required)
66
+ :type context: str
67
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
68
+ :type workspace: str
69
+ :param _request_timeout: timeout setting for this request. If one
70
+ number provided, it will be total request
71
+ timeout. It can also be a pair (tuple) of
72
+ (connection, read) timeouts.
73
+ :type _request_timeout: int, tuple(int, int), optional
74
+ :param _request_auth: set to override the auth_settings for an a single
75
+ request; this effectively ignores the
76
+ authentication in the spec for a single request.
77
+ :type _request_auth: dict, optional
78
+ :param _content_type: force content-type for the request.
79
+ :type _content_type: str, Optional
80
+ :param _headers: set to override the headers for a single
81
+ request; this effectively ignores the headers
82
+ in the spec for a single request.
83
+ :type _headers: dict, optional
84
+ :param _host_index: set to override the host_index for a single
85
+ request; this effectively ignores the host_index
86
+ in the spec for a single request.
87
+ :type _host_index: int, optional
88
+ :return: Returns the result object.
89
+ """ # noqa: E501
90
+
91
+ _param = self._gateway_integration_endpoints_get_serialize(
92
+ context=context,
93
+ workspace=workspace,
94
+ _request_auth=_request_auth,
95
+ _content_type=_content_type,
96
+ _headers=_headers,
97
+ _host_index=_host_index
98
+ )
99
+
100
+ _response_types_map: Dict[str, Optional[str]] = {
101
+ '200': "List[GatewayIntegrationEndpoint]",
102
+ '400': "Error",
103
+ }
104
+ response_data = self.api_client.call_api(
105
+ *_param,
106
+ _request_timeout=_request_timeout
107
+ )
108
+ response_data.read()
109
+ return self.api_client.response_deserialize(
110
+ response_data=response_data,
111
+ response_types_map=_response_types_map,
112
+ ).data
113
+
114
+
115
+ @validate_call
116
+ def gateway_integration_endpoints_get_with_http_info(
117
+ self,
118
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
119
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
120
+ _request_timeout: Union[
121
+ None,
122
+ Annotated[StrictFloat, Field(gt=0)],
123
+ Tuple[
124
+ Annotated[StrictFloat, Field(gt=0)],
125
+ Annotated[StrictFloat, Field(gt=0)]
126
+ ]
127
+ ] = None,
128
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
129
+ _content_type: Optional[StrictStr] = None,
130
+ _headers: Optional[Dict[StrictStr, Any]] = None,
131
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
132
+ ) -> ApiResponse[List[GatewayIntegrationEndpoint]]:
133
+ """Returns basic gateway integration endpoint representations
134
+
135
+ Operation for retrieving an array of basic gateway integration endpoint representations for all accessible gateway endpoints.
136
+
137
+ :param context: ID of the context in which to perform the operation (required)
138
+ :type context: str
139
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
140
+ :type workspace: str
141
+ :param _request_timeout: timeout setting for this request. If one
142
+ number provided, it will be total request
143
+ timeout. It can also be a pair (tuple) of
144
+ (connection, read) timeouts.
145
+ :type _request_timeout: int, tuple(int, int), optional
146
+ :param _request_auth: set to override the auth_settings for an a single
147
+ request; this effectively ignores the
148
+ authentication in the spec for a single request.
149
+ :type _request_auth: dict, optional
150
+ :param _content_type: force content-type for the request.
151
+ :type _content_type: str, Optional
152
+ :param _headers: set to override the headers for a single
153
+ request; this effectively ignores the headers
154
+ in the spec for a single request.
155
+ :type _headers: dict, optional
156
+ :param _host_index: set to override the host_index for a single
157
+ request; this effectively ignores the host_index
158
+ in the spec for a single request.
159
+ :type _host_index: int, optional
160
+ :return: Returns the result object.
161
+ """ # noqa: E501
162
+
163
+ _param = self._gateway_integration_endpoints_get_serialize(
164
+ context=context,
165
+ workspace=workspace,
166
+ _request_auth=_request_auth,
167
+ _content_type=_content_type,
168
+ _headers=_headers,
169
+ _host_index=_host_index
170
+ )
171
+
172
+ _response_types_map: Dict[str, Optional[str]] = {
173
+ '200': "List[GatewayIntegrationEndpoint]",
174
+ '400': "Error",
175
+ }
176
+ response_data = self.api_client.call_api(
177
+ *_param,
178
+ _request_timeout=_request_timeout
179
+ )
180
+ response_data.read()
181
+ return self.api_client.response_deserialize(
182
+ response_data=response_data,
183
+ response_types_map=_response_types_map,
184
+ )
185
+
186
+
187
+ @validate_call
188
+ def gateway_integration_endpoints_get_without_preload_content(
189
+ self,
190
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
191
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
192
+ _request_timeout: Union[
193
+ None,
194
+ Annotated[StrictFloat, Field(gt=0)],
195
+ Tuple[
196
+ Annotated[StrictFloat, Field(gt=0)],
197
+ Annotated[StrictFloat, Field(gt=0)]
198
+ ]
199
+ ] = None,
200
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
201
+ _content_type: Optional[StrictStr] = None,
202
+ _headers: Optional[Dict[StrictStr, Any]] = None,
203
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
204
+ ) -> RESTResponseType:
205
+ """Returns basic gateway integration endpoint representations
206
+
207
+ Operation for retrieving an array of basic gateway integration endpoint representations for all accessible gateway endpoints.
208
+
209
+ :param context: ID of the context in which to perform the operation (required)
210
+ :type context: str
211
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
212
+ :type workspace: str
213
+ :param _request_timeout: timeout setting for this request. If one
214
+ number provided, it will be total request
215
+ timeout. It can also be a pair (tuple) of
216
+ (connection, read) timeouts.
217
+ :type _request_timeout: int, tuple(int, int), optional
218
+ :param _request_auth: set to override the auth_settings for an a single
219
+ request; this effectively ignores the
220
+ authentication in the spec for a single request.
221
+ :type _request_auth: dict, optional
222
+ :param _content_type: force content-type for the request.
223
+ :type _content_type: str, Optional
224
+ :param _headers: set to override the headers for a single
225
+ request; this effectively ignores the headers
226
+ in the spec for a single request.
227
+ :type _headers: dict, optional
228
+ :param _host_index: set to override the host_index for a single
229
+ request; this effectively ignores the host_index
230
+ in the spec for a single request.
231
+ :type _host_index: int, optional
232
+ :return: Returns the result object.
233
+ """ # noqa: E501
234
+
235
+ _param = self._gateway_integration_endpoints_get_serialize(
236
+ context=context,
237
+ workspace=workspace,
238
+ _request_auth=_request_auth,
239
+ _content_type=_content_type,
240
+ _headers=_headers,
241
+ _host_index=_host_index
242
+ )
243
+
244
+ _response_types_map: Dict[str, Optional[str]] = {
245
+ '200': "List[GatewayIntegrationEndpoint]",
246
+ '400': "Error",
247
+ }
248
+ response_data = self.api_client.call_api(
249
+ *_param,
250
+ _request_timeout=_request_timeout
251
+ )
252
+ return response_data.response
253
+
254
+
255
+ def _gateway_integration_endpoints_get_serialize(
256
+ self,
257
+ context,
258
+ workspace,
259
+ _request_auth,
260
+ _content_type,
261
+ _headers,
262
+ _host_index,
263
+ ) -> RequestSerialized:
264
+
265
+ _host = None
266
+
267
+ _collection_formats: Dict[str, str] = {
268
+ }
269
+
270
+ _path_params: Dict[str, str] = {}
271
+ _query_params: List[Tuple[str, str]] = []
272
+ _header_params: Dict[str, Optional[str]] = _headers or {}
273
+ _form_params: List[Tuple[str, str]] = []
274
+ _files: Dict[
275
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
276
+ ] = {}
277
+ _body_params: Optional[bytes] = None
278
+
279
+ # process the path parameters
280
+ # process the query parameters
281
+ if context is not None:
282
+
283
+ _query_params.append(('context', context))
284
+
285
+ if workspace is not None:
286
+
287
+ _query_params.append(('workspace', workspace))
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
+ 'basicAuth'
306
+ ]
307
+
308
+ return self.api_client.param_serialize(
309
+ method='GET',
310
+ resource_path='/gateway-integration-endpoints',
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 gateway_integration_endpoints_id_disable_post(
328
+ self,
329
+ id: Annotated[StrictStr, Field(description="ID of the gateway integration endpoint that should be disable.")],
330
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
331
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
332
+ _request_timeout: Union[
333
+ None,
334
+ Annotated[StrictFloat, Field(gt=0)],
335
+ Tuple[
336
+ Annotated[StrictFloat, Field(gt=0)],
337
+ Annotated[StrictFloat, Field(gt=0)]
338
+ ]
339
+ ] = None,
340
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
341
+ _content_type: Optional[StrictStr] = None,
342
+ _headers: Optional[Dict[StrictStr, Any]] = None,
343
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
344
+ ) -> None:
345
+ """Disables the gateway integration endpoint
346
+
347
+ Operation for disabling a gateway integration endpoint. A 400 response is returned if the endpoint cannot be disabled.
348
+
349
+ :param id: ID of the gateway integration endpoint that should be disable. (required)
350
+ :type id: str
351
+ :param context: ID of the context in which to perform the operation (required)
352
+ :type context: str
353
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
354
+ :type workspace: str
355
+ :param _request_timeout: timeout setting for this request. If one
356
+ number provided, it will be total request
357
+ timeout. It can also be a pair (tuple) of
358
+ (connection, read) timeouts.
359
+ :type _request_timeout: int, tuple(int, int), optional
360
+ :param _request_auth: set to override the auth_settings for an a single
361
+ request; this effectively ignores the
362
+ authentication in the spec for a single request.
363
+ :type _request_auth: dict, optional
364
+ :param _content_type: force content-type for the request.
365
+ :type _content_type: str, Optional
366
+ :param _headers: set to override the headers for a single
367
+ request; this effectively ignores the headers
368
+ in the spec for a single request.
369
+ :type _headers: dict, optional
370
+ :param _host_index: set to override the host_index for a single
371
+ request; this effectively ignores the host_index
372
+ in the spec for a single request.
373
+ :type _host_index: int, optional
374
+ :return: Returns the result object.
375
+ """ # noqa: E501
376
+
377
+ _param = self._gateway_integration_endpoints_id_disable_post_serialize(
378
+ id=id,
379
+ context=context,
380
+ workspace=workspace,
381
+ _request_auth=_request_auth,
382
+ _content_type=_content_type,
383
+ _headers=_headers,
384
+ _host_index=_host_index
385
+ )
386
+
387
+ _response_types_map: Dict[str, Optional[str]] = {
388
+ '200': None,
389
+ '400': "Error",
390
+ '404': "Error",
391
+ '503': "Error",
392
+ }
393
+ response_data = self.api_client.call_api(
394
+ *_param,
395
+ _request_timeout=_request_timeout
396
+ )
397
+ response_data.read()
398
+ return self.api_client.response_deserialize(
399
+ response_data=response_data,
400
+ response_types_map=_response_types_map,
401
+ ).data
402
+
403
+
404
+ @validate_call
405
+ def gateway_integration_endpoints_id_disable_post_with_http_info(
406
+ self,
407
+ id: Annotated[StrictStr, Field(description="ID of the gateway integration endpoint that should be disable.")],
408
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
409
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
410
+ _request_timeout: Union[
411
+ None,
412
+ Annotated[StrictFloat, Field(gt=0)],
413
+ Tuple[
414
+ Annotated[StrictFloat, Field(gt=0)],
415
+ Annotated[StrictFloat, Field(gt=0)]
416
+ ]
417
+ ] = None,
418
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
419
+ _content_type: Optional[StrictStr] = None,
420
+ _headers: Optional[Dict[StrictStr, Any]] = None,
421
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
422
+ ) -> ApiResponse[None]:
423
+ """Disables the gateway integration endpoint
424
+
425
+ Operation for disabling a gateway integration endpoint. A 400 response is returned if the endpoint cannot be disabled.
426
+
427
+ :param id: ID of the gateway integration endpoint that should be disable. (required)
428
+ :type id: str
429
+ :param context: ID of the context in which to perform the operation (required)
430
+ :type context: str
431
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
432
+ :type workspace: str
433
+ :param _request_timeout: timeout setting for this request. If one
434
+ number provided, it will be total request
435
+ timeout. It can also be a pair (tuple) of
436
+ (connection, read) timeouts.
437
+ :type _request_timeout: int, tuple(int, int), optional
438
+ :param _request_auth: set to override the auth_settings for an a single
439
+ request; this effectively ignores the
440
+ authentication in the spec for a single request.
441
+ :type _request_auth: dict, optional
442
+ :param _content_type: force content-type for the request.
443
+ :type _content_type: str, Optional
444
+ :param _headers: set to override the headers for a single
445
+ request; this effectively ignores the headers
446
+ in the spec for a single request.
447
+ :type _headers: dict, optional
448
+ :param _host_index: set to override the host_index for a single
449
+ request; this effectively ignores the host_index
450
+ in the spec for a single request.
451
+ :type _host_index: int, optional
452
+ :return: Returns the result object.
453
+ """ # noqa: E501
454
+
455
+ _param = self._gateway_integration_endpoints_id_disable_post_serialize(
456
+ id=id,
457
+ context=context,
458
+ workspace=workspace,
459
+ _request_auth=_request_auth,
460
+ _content_type=_content_type,
461
+ _headers=_headers,
462
+ _host_index=_host_index
463
+ )
464
+
465
+ _response_types_map: Dict[str, Optional[str]] = {
466
+ '200': None,
467
+ '400': "Error",
468
+ '404': "Error",
469
+ '503': "Error",
470
+ }
471
+ response_data = self.api_client.call_api(
472
+ *_param,
473
+ _request_timeout=_request_timeout
474
+ )
475
+ response_data.read()
476
+ return self.api_client.response_deserialize(
477
+ response_data=response_data,
478
+ response_types_map=_response_types_map,
479
+ )
480
+
481
+
482
+ @validate_call
483
+ def gateway_integration_endpoints_id_disable_post_without_preload_content(
484
+ self,
485
+ id: Annotated[StrictStr, Field(description="ID of the gateway integration endpoint that should be disable.")],
486
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
487
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
488
+ _request_timeout: Union[
489
+ None,
490
+ Annotated[StrictFloat, Field(gt=0)],
491
+ Tuple[
492
+ Annotated[StrictFloat, Field(gt=0)],
493
+ Annotated[StrictFloat, Field(gt=0)]
494
+ ]
495
+ ] = None,
496
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
497
+ _content_type: Optional[StrictStr] = None,
498
+ _headers: Optional[Dict[StrictStr, Any]] = None,
499
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
500
+ ) -> RESTResponseType:
501
+ """Disables the gateway integration endpoint
502
+
503
+ Operation for disabling a gateway integration endpoint. A 400 response is returned if the endpoint cannot be disabled.
504
+
505
+ :param id: ID of the gateway integration endpoint that should be disable. (required)
506
+ :type id: str
507
+ :param context: ID of the context in which to perform the operation (required)
508
+ :type context: str
509
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
510
+ :type workspace: str
511
+ :param _request_timeout: timeout setting for this request. If one
512
+ number provided, it will be total request
513
+ timeout. It can also be a pair (tuple) of
514
+ (connection, read) timeouts.
515
+ :type _request_timeout: int, tuple(int, int), optional
516
+ :param _request_auth: set to override the auth_settings for an a single
517
+ request; this effectively ignores the
518
+ authentication in the spec for a single request.
519
+ :type _request_auth: dict, optional
520
+ :param _content_type: force content-type for the request.
521
+ :type _content_type: str, Optional
522
+ :param _headers: set to override the headers for a single
523
+ request; this effectively ignores the headers
524
+ in the spec for a single request.
525
+ :type _headers: dict, optional
526
+ :param _host_index: set to override the host_index for a single
527
+ request; this effectively ignores the host_index
528
+ in the spec for a single request.
529
+ :type _host_index: int, optional
530
+ :return: Returns the result object.
531
+ """ # noqa: E501
532
+
533
+ _param = self._gateway_integration_endpoints_id_disable_post_serialize(
534
+ id=id,
535
+ context=context,
536
+ workspace=workspace,
537
+ _request_auth=_request_auth,
538
+ _content_type=_content_type,
539
+ _headers=_headers,
540
+ _host_index=_host_index
541
+ )
542
+
543
+ _response_types_map: Dict[str, Optional[str]] = {
544
+ '200': None,
545
+ '400': "Error",
546
+ '404': "Error",
547
+ '503': "Error",
548
+ }
549
+ response_data = self.api_client.call_api(
550
+ *_param,
551
+ _request_timeout=_request_timeout
552
+ )
553
+ return response_data.response
554
+
555
+
556
+ def _gateway_integration_endpoints_id_disable_post_serialize(
557
+ self,
558
+ id,
559
+ context,
560
+ workspace,
561
+ _request_auth,
562
+ _content_type,
563
+ _headers,
564
+ _host_index,
565
+ ) -> RequestSerialized:
566
+
567
+ _host = None
568
+
569
+ _collection_formats: Dict[str, str] = {
570
+ }
571
+
572
+ _path_params: Dict[str, str] = {}
573
+ _query_params: List[Tuple[str, str]] = []
574
+ _header_params: Dict[str, Optional[str]] = _headers or {}
575
+ _form_params: List[Tuple[str, str]] = []
576
+ _files: Dict[
577
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
578
+ ] = {}
579
+ _body_params: Optional[bytes] = None
580
+
581
+ # process the path parameters
582
+ if id is not None:
583
+ _path_params['id'] = id
584
+ # process the query parameters
585
+ if context is not None:
586
+
587
+ _query_params.append(('context', context))
588
+
589
+ if workspace is not None:
590
+
591
+ _query_params.append(('workspace', workspace))
592
+
593
+ # process the header parameters
594
+ # process the form parameters
595
+ # process the body parameter
596
+
597
+
598
+ # set the HTTP header `Accept`
599
+ if 'Accept' not in _header_params:
600
+ _header_params['Accept'] = self.api_client.select_header_accept(
601
+ [
602
+ 'application/json'
603
+ ]
604
+ )
605
+
606
+
607
+ # authentication setting
608
+ _auth_settings: List[str] = [
609
+ 'basicAuth'
610
+ ]
611
+
612
+ return self.api_client.param_serialize(
613
+ method='POST',
614
+ resource_path='/gateway-integration-endpoints/{id}/disable',
615
+ path_params=_path_params,
616
+ query_params=_query_params,
617
+ header_params=_header_params,
618
+ body=_body_params,
619
+ post_params=_form_params,
620
+ files=_files,
621
+ auth_settings=_auth_settings,
622
+ collection_formats=_collection_formats,
623
+ _host=_host,
624
+ _request_auth=_request_auth
625
+ )
626
+
627
+
628
+
629
+
630
+ @validate_call
631
+ def gateway_integration_endpoints_id_enable_post(
632
+ self,
633
+ id: Annotated[StrictStr, Field(description="ID of the gateway integration endpoint that should be enabled.")],
634
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
635
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
636
+ _request_timeout: Union[
637
+ None,
638
+ Annotated[StrictFloat, Field(gt=0)],
639
+ Tuple[
640
+ Annotated[StrictFloat, Field(gt=0)],
641
+ Annotated[StrictFloat, Field(gt=0)]
642
+ ]
643
+ ] = None,
644
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
645
+ _content_type: Optional[StrictStr] = None,
646
+ _headers: Optional[Dict[StrictStr, Any]] = None,
647
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
648
+ ) -> None:
649
+ """Enables the gateway integration endpoint
650
+
651
+ Operation for enabling a gateway integration endpoint. A 400 response is returned if the endpoint cannot be enabled.
652
+
653
+ :param id: ID of the gateway integration endpoint that should be enabled. (required)
654
+ :type id: str
655
+ :param context: ID of the context in which to perform the operation (required)
656
+ :type context: str
657
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
658
+ :type workspace: str
659
+ :param _request_timeout: timeout setting for this request. If one
660
+ number provided, it will be total request
661
+ timeout. It can also be a pair (tuple) of
662
+ (connection, read) timeouts.
663
+ :type _request_timeout: int, tuple(int, int), optional
664
+ :param _request_auth: set to override the auth_settings for an a single
665
+ request; this effectively ignores the
666
+ authentication in the spec for a single request.
667
+ :type _request_auth: dict, optional
668
+ :param _content_type: force content-type for the request.
669
+ :type _content_type: str, Optional
670
+ :param _headers: set to override the headers for a single
671
+ request; this effectively ignores the headers
672
+ in the spec for a single request.
673
+ :type _headers: dict, optional
674
+ :param _host_index: set to override the host_index for a single
675
+ request; this effectively ignores the host_index
676
+ in the spec for a single request.
677
+ :type _host_index: int, optional
678
+ :return: Returns the result object.
679
+ """ # noqa: E501
680
+
681
+ _param = self._gateway_integration_endpoints_id_enable_post_serialize(
682
+ id=id,
683
+ context=context,
684
+ workspace=workspace,
685
+ _request_auth=_request_auth,
686
+ _content_type=_content_type,
687
+ _headers=_headers,
688
+ _host_index=_host_index
689
+ )
690
+
691
+ _response_types_map: Dict[str, Optional[str]] = {
692
+ '200': None,
693
+ '400': "Error",
694
+ '404': "Error",
695
+ '503': "Error",
696
+ }
697
+ response_data = self.api_client.call_api(
698
+ *_param,
699
+ _request_timeout=_request_timeout
700
+ )
701
+ response_data.read()
702
+ return self.api_client.response_deserialize(
703
+ response_data=response_data,
704
+ response_types_map=_response_types_map,
705
+ ).data
706
+
707
+
708
+ @validate_call
709
+ def gateway_integration_endpoints_id_enable_post_with_http_info(
710
+ self,
711
+ id: Annotated[StrictStr, Field(description="ID of the gateway integration endpoint that should be enabled.")],
712
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
713
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
714
+ _request_timeout: Union[
715
+ None,
716
+ Annotated[StrictFloat, Field(gt=0)],
717
+ Tuple[
718
+ Annotated[StrictFloat, Field(gt=0)],
719
+ Annotated[StrictFloat, Field(gt=0)]
720
+ ]
721
+ ] = None,
722
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
723
+ _content_type: Optional[StrictStr] = None,
724
+ _headers: Optional[Dict[StrictStr, Any]] = None,
725
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
726
+ ) -> ApiResponse[None]:
727
+ """Enables the gateway integration endpoint
728
+
729
+ Operation for enabling a gateway integration endpoint. A 400 response is returned if the endpoint cannot be enabled.
730
+
731
+ :param id: ID of the gateway integration endpoint that should be enabled. (required)
732
+ :type id: str
733
+ :param context: ID of the context in which to perform the operation (required)
734
+ :type context: str
735
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
736
+ :type workspace: str
737
+ :param _request_timeout: timeout setting for this request. If one
738
+ number provided, it will be total request
739
+ timeout. It can also be a pair (tuple) of
740
+ (connection, read) timeouts.
741
+ :type _request_timeout: int, tuple(int, int), optional
742
+ :param _request_auth: set to override the auth_settings for an a single
743
+ request; this effectively ignores the
744
+ authentication in the spec for a single request.
745
+ :type _request_auth: dict, optional
746
+ :param _content_type: force content-type for the request.
747
+ :type _content_type: str, Optional
748
+ :param _headers: set to override the headers for a single
749
+ request; this effectively ignores the headers
750
+ in the spec for a single request.
751
+ :type _headers: dict, optional
752
+ :param _host_index: set to override the host_index for a single
753
+ request; this effectively ignores the host_index
754
+ in the spec for a single request.
755
+ :type _host_index: int, optional
756
+ :return: Returns the result object.
757
+ """ # noqa: E501
758
+
759
+ _param = self._gateway_integration_endpoints_id_enable_post_serialize(
760
+ id=id,
761
+ context=context,
762
+ workspace=workspace,
763
+ _request_auth=_request_auth,
764
+ _content_type=_content_type,
765
+ _headers=_headers,
766
+ _host_index=_host_index
767
+ )
768
+
769
+ _response_types_map: Dict[str, Optional[str]] = {
770
+ '200': None,
771
+ '400': "Error",
772
+ '404': "Error",
773
+ '503': "Error",
774
+ }
775
+ response_data = self.api_client.call_api(
776
+ *_param,
777
+ _request_timeout=_request_timeout
778
+ )
779
+ response_data.read()
780
+ return self.api_client.response_deserialize(
781
+ response_data=response_data,
782
+ response_types_map=_response_types_map,
783
+ )
784
+
785
+
786
+ @validate_call
787
+ def gateway_integration_endpoints_id_enable_post_without_preload_content(
788
+ self,
789
+ id: Annotated[StrictStr, Field(description="ID of the gateway integration endpoint that should be enabled.")],
790
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
791
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
792
+ _request_timeout: Union[
793
+ None,
794
+ Annotated[StrictFloat, Field(gt=0)],
795
+ Tuple[
796
+ Annotated[StrictFloat, Field(gt=0)],
797
+ Annotated[StrictFloat, Field(gt=0)]
798
+ ]
799
+ ] = None,
800
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
801
+ _content_type: Optional[StrictStr] = None,
802
+ _headers: Optional[Dict[StrictStr, Any]] = None,
803
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
804
+ ) -> RESTResponseType:
805
+ """Enables the gateway integration endpoint
806
+
807
+ Operation for enabling a gateway integration endpoint. A 400 response is returned if the endpoint cannot be enabled.
808
+
809
+ :param id: ID of the gateway integration endpoint that should be enabled. (required)
810
+ :type id: str
811
+ :param context: ID of the context in which to perform the operation (required)
812
+ :type context: str
813
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
814
+ :type workspace: str
815
+ :param _request_timeout: timeout setting for this request. If one
816
+ number provided, it will be total request
817
+ timeout. It can also be a pair (tuple) of
818
+ (connection, read) timeouts.
819
+ :type _request_timeout: int, tuple(int, int), optional
820
+ :param _request_auth: set to override the auth_settings for an a single
821
+ request; this effectively ignores the
822
+ authentication in the spec for a single request.
823
+ :type _request_auth: dict, optional
824
+ :param _content_type: force content-type for the request.
825
+ :type _content_type: str, Optional
826
+ :param _headers: set to override the headers for a single
827
+ request; this effectively ignores the headers
828
+ in the spec for a single request.
829
+ :type _headers: dict, optional
830
+ :param _host_index: set to override the host_index for a single
831
+ request; this effectively ignores the host_index
832
+ in the spec for a single request.
833
+ :type _host_index: int, optional
834
+ :return: Returns the result object.
835
+ """ # noqa: E501
836
+
837
+ _param = self._gateway_integration_endpoints_id_enable_post_serialize(
838
+ id=id,
839
+ context=context,
840
+ workspace=workspace,
841
+ _request_auth=_request_auth,
842
+ _content_type=_content_type,
843
+ _headers=_headers,
844
+ _host_index=_host_index
845
+ )
846
+
847
+ _response_types_map: Dict[str, Optional[str]] = {
848
+ '200': None,
849
+ '400': "Error",
850
+ '404': "Error",
851
+ '503': "Error",
852
+ }
853
+ response_data = self.api_client.call_api(
854
+ *_param,
855
+ _request_timeout=_request_timeout
856
+ )
857
+ return response_data.response
858
+
859
+
860
+ def _gateway_integration_endpoints_id_enable_post_serialize(
861
+ self,
862
+ id,
863
+ context,
864
+ workspace,
865
+ _request_auth,
866
+ _content_type,
867
+ _headers,
868
+ _host_index,
869
+ ) -> RequestSerialized:
870
+
871
+ _host = None
872
+
873
+ _collection_formats: Dict[str, str] = {
874
+ }
875
+
876
+ _path_params: Dict[str, str] = {}
877
+ _query_params: List[Tuple[str, str]] = []
878
+ _header_params: Dict[str, Optional[str]] = _headers or {}
879
+ _form_params: List[Tuple[str, str]] = []
880
+ _files: Dict[
881
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
882
+ ] = {}
883
+ _body_params: Optional[bytes] = None
884
+
885
+ # process the path parameters
886
+ if id is not None:
887
+ _path_params['id'] = id
888
+ # process the query parameters
889
+ if context is not None:
890
+
891
+ _query_params.append(('context', context))
892
+
893
+ if workspace is not None:
894
+
895
+ _query_params.append(('workspace', workspace))
896
+
897
+ # process the header parameters
898
+ # process the form parameters
899
+ # process the body parameter
900
+
901
+
902
+ # set the HTTP header `Accept`
903
+ if 'Accept' not in _header_params:
904
+ _header_params['Accept'] = self.api_client.select_header_accept(
905
+ [
906
+ 'application/json'
907
+ ]
908
+ )
909
+
910
+
911
+ # authentication setting
912
+ _auth_settings: List[str] = [
913
+ 'basicAuth'
914
+ ]
915
+
916
+ return self.api_client.param_serialize(
917
+ method='POST',
918
+ resource_path='/gateway-integration-endpoints/{id}/enable',
919
+ path_params=_path_params,
920
+ query_params=_query_params,
921
+ header_params=_header_params,
922
+ body=_body_params,
923
+ post_params=_form_params,
924
+ files=_files,
925
+ auth_settings=_auth_settings,
926
+ collection_formats=_collection_formats,
927
+ _host=_host,
928
+ _request_auth=_request_auth
929
+ )
930
+
931
+
932
+
933
+
934
+ @validate_call
935
+ def gateway_integration_endpoints_id_status_get(
936
+ self,
937
+ id: Annotated[StrictStr, Field(description="ID of the gateway integration endpoint for which to retrieve the status.")],
938
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
939
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
940
+ _request_timeout: Union[
941
+ None,
942
+ Annotated[StrictFloat, Field(gt=0)],
943
+ Tuple[
944
+ Annotated[StrictFloat, Field(gt=0)],
945
+ Annotated[StrictFloat, Field(gt=0)]
946
+ ]
947
+ ] = None,
948
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
949
+ _content_type: Optional[StrictStr] = None,
950
+ _headers: Optional[Dict[StrictStr, Any]] = None,
951
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
952
+ ) -> EndpointStatus:
953
+ """Returns the status of the specified gateway integration endpoint
954
+
955
+ Operation for retrieving status information for a specific gateway integration endpoint.
956
+
957
+ :param id: ID of the gateway integration endpoint for which to retrieve the status. (required)
958
+ :type id: str
959
+ :param context: ID of the context in which to perform the operation (required)
960
+ :type context: str
961
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
962
+ :type workspace: str
963
+ :param _request_timeout: timeout setting for this request. If one
964
+ number provided, it will be total request
965
+ timeout. It can also be a pair (tuple) of
966
+ (connection, read) timeouts.
967
+ :type _request_timeout: int, tuple(int, int), optional
968
+ :param _request_auth: set to override the auth_settings for an a single
969
+ request; this effectively ignores the
970
+ authentication in the spec for a single request.
971
+ :type _request_auth: dict, optional
972
+ :param _content_type: force content-type for the request.
973
+ :type _content_type: str, Optional
974
+ :param _headers: set to override the headers for a single
975
+ request; this effectively ignores the headers
976
+ in the spec for a single request.
977
+ :type _headers: dict, optional
978
+ :param _host_index: set to override the host_index for a single
979
+ request; this effectively ignores the host_index
980
+ in the spec for a single request.
981
+ :type _host_index: int, optional
982
+ :return: Returns the result object.
983
+ """ # noqa: E501
984
+
985
+ _param = self._gateway_integration_endpoints_id_status_get_serialize(
986
+ id=id,
987
+ context=context,
988
+ workspace=workspace,
989
+ _request_auth=_request_auth,
990
+ _content_type=_content_type,
991
+ _headers=_headers,
992
+ _host_index=_host_index
993
+ )
994
+
995
+ _response_types_map: Dict[str, Optional[str]] = {
996
+ '200': "EndpointStatus",
997
+ '400': "Error",
998
+ '404': "Error",
999
+ }
1000
+ response_data = self.api_client.call_api(
1001
+ *_param,
1002
+ _request_timeout=_request_timeout
1003
+ )
1004
+ response_data.read()
1005
+ return self.api_client.response_deserialize(
1006
+ response_data=response_data,
1007
+ response_types_map=_response_types_map,
1008
+ ).data
1009
+
1010
+
1011
+ @validate_call
1012
+ def gateway_integration_endpoints_id_status_get_with_http_info(
1013
+ self,
1014
+ id: Annotated[StrictStr, Field(description="ID of the gateway integration endpoint for which to retrieve the status.")],
1015
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
1016
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
1017
+ _request_timeout: Union[
1018
+ None,
1019
+ Annotated[StrictFloat, Field(gt=0)],
1020
+ Tuple[
1021
+ Annotated[StrictFloat, Field(gt=0)],
1022
+ Annotated[StrictFloat, Field(gt=0)]
1023
+ ]
1024
+ ] = None,
1025
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1026
+ _content_type: Optional[StrictStr] = None,
1027
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1028
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1029
+ ) -> ApiResponse[EndpointStatus]:
1030
+ """Returns the status of the specified gateway integration endpoint
1031
+
1032
+ Operation for retrieving status information for a specific gateway integration endpoint.
1033
+
1034
+ :param id: ID of the gateway integration endpoint for which to retrieve the status. (required)
1035
+ :type id: str
1036
+ :param context: ID of the context in which to perform the operation (required)
1037
+ :type context: str
1038
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
1039
+ :type workspace: str
1040
+ :param _request_timeout: timeout setting for this request. If one
1041
+ number provided, it will be total request
1042
+ timeout. It can also be a pair (tuple) of
1043
+ (connection, read) timeouts.
1044
+ :type _request_timeout: int, tuple(int, int), optional
1045
+ :param _request_auth: set to override the auth_settings for an a single
1046
+ request; this effectively ignores the
1047
+ authentication in the spec for a single request.
1048
+ :type _request_auth: dict, optional
1049
+ :param _content_type: force content-type for the request.
1050
+ :type _content_type: str, Optional
1051
+ :param _headers: set to override the headers for a single
1052
+ request; this effectively ignores the headers
1053
+ in the spec for a single request.
1054
+ :type _headers: dict, optional
1055
+ :param _host_index: set to override the host_index for a single
1056
+ request; this effectively ignores the host_index
1057
+ in the spec for a single request.
1058
+ :type _host_index: int, optional
1059
+ :return: Returns the result object.
1060
+ """ # noqa: E501
1061
+
1062
+ _param = self._gateway_integration_endpoints_id_status_get_serialize(
1063
+ id=id,
1064
+ context=context,
1065
+ workspace=workspace,
1066
+ _request_auth=_request_auth,
1067
+ _content_type=_content_type,
1068
+ _headers=_headers,
1069
+ _host_index=_host_index
1070
+ )
1071
+
1072
+ _response_types_map: Dict[str, Optional[str]] = {
1073
+ '200': "EndpointStatus",
1074
+ '400': "Error",
1075
+ '404': "Error",
1076
+ }
1077
+ response_data = self.api_client.call_api(
1078
+ *_param,
1079
+ _request_timeout=_request_timeout
1080
+ )
1081
+ response_data.read()
1082
+ return self.api_client.response_deserialize(
1083
+ response_data=response_data,
1084
+ response_types_map=_response_types_map,
1085
+ )
1086
+
1087
+
1088
+ @validate_call
1089
+ def gateway_integration_endpoints_id_status_get_without_preload_content(
1090
+ self,
1091
+ id: Annotated[StrictStr, Field(description="ID of the gateway integration endpoint for which to retrieve the status.")],
1092
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
1093
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
1094
+ _request_timeout: Union[
1095
+ None,
1096
+ Annotated[StrictFloat, Field(gt=0)],
1097
+ Tuple[
1098
+ Annotated[StrictFloat, Field(gt=0)],
1099
+ Annotated[StrictFloat, Field(gt=0)]
1100
+ ]
1101
+ ] = None,
1102
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1103
+ _content_type: Optional[StrictStr] = None,
1104
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1105
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1106
+ ) -> RESTResponseType:
1107
+ """Returns the status of the specified gateway integration endpoint
1108
+
1109
+ Operation for retrieving status information for a specific gateway integration endpoint.
1110
+
1111
+ :param id: ID of the gateway integration endpoint for which to retrieve the status. (required)
1112
+ :type id: str
1113
+ :param context: ID of the context in which to perform the operation (required)
1114
+ :type context: str
1115
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
1116
+ :type workspace: str
1117
+ :param _request_timeout: timeout setting for this request. If one
1118
+ number provided, it will be total request
1119
+ timeout. It can also be a pair (tuple) of
1120
+ (connection, read) timeouts.
1121
+ :type _request_timeout: int, tuple(int, int), optional
1122
+ :param _request_auth: set to override the auth_settings for an a single
1123
+ request; this effectively ignores the
1124
+ authentication in the spec for a single request.
1125
+ :type _request_auth: dict, optional
1126
+ :param _content_type: force content-type for the request.
1127
+ :type _content_type: str, Optional
1128
+ :param _headers: set to override the headers for a single
1129
+ request; this effectively ignores the headers
1130
+ in the spec for a single request.
1131
+ :type _headers: dict, optional
1132
+ :param _host_index: set to override the host_index for a single
1133
+ request; this effectively ignores the host_index
1134
+ in the spec for a single request.
1135
+ :type _host_index: int, optional
1136
+ :return: Returns the result object.
1137
+ """ # noqa: E501
1138
+
1139
+ _param = self._gateway_integration_endpoints_id_status_get_serialize(
1140
+ id=id,
1141
+ context=context,
1142
+ workspace=workspace,
1143
+ _request_auth=_request_auth,
1144
+ _content_type=_content_type,
1145
+ _headers=_headers,
1146
+ _host_index=_host_index
1147
+ )
1148
+
1149
+ _response_types_map: Dict[str, Optional[str]] = {
1150
+ '200': "EndpointStatus",
1151
+ '400': "Error",
1152
+ '404': "Error",
1153
+ }
1154
+ response_data = self.api_client.call_api(
1155
+ *_param,
1156
+ _request_timeout=_request_timeout
1157
+ )
1158
+ return response_data.response
1159
+
1160
+
1161
+ def _gateway_integration_endpoints_id_status_get_serialize(
1162
+ self,
1163
+ id,
1164
+ context,
1165
+ workspace,
1166
+ _request_auth,
1167
+ _content_type,
1168
+ _headers,
1169
+ _host_index,
1170
+ ) -> RequestSerialized:
1171
+
1172
+ _host = None
1173
+
1174
+ _collection_formats: Dict[str, str] = {
1175
+ }
1176
+
1177
+ _path_params: Dict[str, str] = {}
1178
+ _query_params: List[Tuple[str, str]] = []
1179
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1180
+ _form_params: List[Tuple[str, str]] = []
1181
+ _files: Dict[
1182
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1183
+ ] = {}
1184
+ _body_params: Optional[bytes] = None
1185
+
1186
+ # process the path parameters
1187
+ if id is not None:
1188
+ _path_params['id'] = id
1189
+ # process the query parameters
1190
+ if context is not None:
1191
+
1192
+ _query_params.append(('context', context))
1193
+
1194
+ if workspace is not None:
1195
+
1196
+ _query_params.append(('workspace', workspace))
1197
+
1198
+ # process the header parameters
1199
+ # process the form parameters
1200
+ # process the body parameter
1201
+
1202
+
1203
+ # set the HTTP header `Accept`
1204
+ if 'Accept' not in _header_params:
1205
+ _header_params['Accept'] = self.api_client.select_header_accept(
1206
+ [
1207
+ 'application/json'
1208
+ ]
1209
+ )
1210
+
1211
+
1212
+ # authentication setting
1213
+ _auth_settings: List[str] = [
1214
+ 'basicAuth'
1215
+ ]
1216
+
1217
+ return self.api_client.param_serialize(
1218
+ method='GET',
1219
+ resource_path='/gateway-integration-endpoints/{id}/status',
1220
+ path_params=_path_params,
1221
+ query_params=_query_params,
1222
+ header_params=_header_params,
1223
+ body=_body_params,
1224
+ post_params=_form_params,
1225
+ files=_files,
1226
+ auth_settings=_auth_settings,
1227
+ collection_formats=_collection_formats,
1228
+ _host=_host,
1229
+ _request_auth=_request_auth
1230
+ )
1231
+
1232
+