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,2815 @@
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, StrictBytes, StrictStr, field_validator
20
+ from typing import List, Optional, Tuple, Union
21
+ from typing_extensions import Annotated
22
+ from step_rest_client.models.endpoint_statistics import EndpointStatistics
23
+ from step_rest_client.models.endpoint_status import EndpointStatus
24
+ from step_rest_client.models.execution_report_entry import ExecutionReportEntry
25
+ from step_rest_client.models.inbound_integration_endpoint import InboundIntegrationEndpoint
26
+
27
+ from step_rest_client.api_client import ApiClient, RequestSerialized
28
+ from step_rest_client.api_response import ApiResponse
29
+ from step_rest_client.rest import RESTResponseType
30
+
31
+
32
+ class InboundIntegrationEndpointsApi:
33
+ """NOTE: This class is auto generated by OpenAPI Generator
34
+ Ref: https://openapi-generator.tech
35
+
36
+ Do not edit the class manually.
37
+ """
38
+
39
+ def __init__(self, api_client=None) -> None:
40
+ if api_client is None:
41
+ api_client = ApiClient.get_default()
42
+ self.api_client = api_client
43
+
44
+
45
+ @validate_call
46
+ def inbound_integration_endpoints_get(
47
+ self,
48
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
49
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
50
+ _request_timeout: Union[
51
+ None,
52
+ Annotated[StrictFloat, Field(gt=0)],
53
+ Tuple[
54
+ Annotated[StrictFloat, Field(gt=0)],
55
+ Annotated[StrictFloat, Field(gt=0)]
56
+ ]
57
+ ] = None,
58
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
59
+ _content_type: Optional[StrictStr] = None,
60
+ _headers: Optional[Dict[StrictStr, Any]] = None,
61
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
62
+ ) -> List[InboundIntegrationEndpoint]:
63
+ """Returns basic inbound integration endpoint representations
64
+
65
+ Operation for retrieving an array of basic inbound integration endpoint representations for all accessible endpoints
66
+
67
+ :param context: ID of the context in which to perform the operation (required)
68
+ :type context: str
69
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
70
+ :type workspace: str
71
+ :param _request_timeout: timeout setting for this request. If one
72
+ number provided, it will be total request
73
+ timeout. It can also be a pair (tuple) of
74
+ (connection, read) timeouts.
75
+ :type _request_timeout: int, tuple(int, int), optional
76
+ :param _request_auth: set to override the auth_settings for an a single
77
+ request; this effectively ignores the
78
+ authentication in the spec for a single request.
79
+ :type _request_auth: dict, optional
80
+ :param _content_type: force content-type for the request.
81
+ :type _content_type: str, Optional
82
+ :param _headers: set to override the headers for a single
83
+ request; this effectively ignores the headers
84
+ in the spec for a single request.
85
+ :type _headers: dict, optional
86
+ :param _host_index: set to override the host_index for a single
87
+ request; this effectively ignores the host_index
88
+ in the spec for a single request.
89
+ :type _host_index: int, optional
90
+ :return: Returns the result object.
91
+ """ # noqa: E501
92
+
93
+ _param = self._inbound_integration_endpoints_get_serialize(
94
+ context=context,
95
+ workspace=workspace,
96
+ _request_auth=_request_auth,
97
+ _content_type=_content_type,
98
+ _headers=_headers,
99
+ _host_index=_host_index
100
+ )
101
+
102
+ _response_types_map: Dict[str, Optional[str]] = {
103
+ '200': "List[InboundIntegrationEndpoint]",
104
+ '400': "Error",
105
+ }
106
+ response_data = self.api_client.call_api(
107
+ *_param,
108
+ _request_timeout=_request_timeout
109
+ )
110
+ response_data.read()
111
+ return self.api_client.response_deserialize(
112
+ response_data=response_data,
113
+ response_types_map=_response_types_map,
114
+ ).data
115
+
116
+
117
+ @validate_call
118
+ def inbound_integration_endpoints_get_with_http_info(
119
+ self,
120
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
121
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
122
+ _request_timeout: Union[
123
+ None,
124
+ Annotated[StrictFloat, Field(gt=0)],
125
+ Tuple[
126
+ Annotated[StrictFloat, Field(gt=0)],
127
+ Annotated[StrictFloat, Field(gt=0)]
128
+ ]
129
+ ] = None,
130
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
131
+ _content_type: Optional[StrictStr] = None,
132
+ _headers: Optional[Dict[StrictStr, Any]] = None,
133
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
134
+ ) -> ApiResponse[List[InboundIntegrationEndpoint]]:
135
+ """Returns basic inbound integration endpoint representations
136
+
137
+ Operation for retrieving an array of basic inbound integration endpoint representations for all accessible endpoints
138
+
139
+ :param context: ID of the context in which to perform the operation (required)
140
+ :type context: str
141
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
142
+ :type workspace: str
143
+ :param _request_timeout: timeout setting for this request. If one
144
+ number provided, it will be total request
145
+ timeout. It can also be a pair (tuple) of
146
+ (connection, read) timeouts.
147
+ :type _request_timeout: int, tuple(int, int), optional
148
+ :param _request_auth: set to override the auth_settings for an a single
149
+ request; this effectively ignores the
150
+ authentication in the spec for a single request.
151
+ :type _request_auth: dict, optional
152
+ :param _content_type: force content-type for the request.
153
+ :type _content_type: str, Optional
154
+ :param _headers: set to override the headers for a single
155
+ request; this effectively ignores the headers
156
+ in the spec for a single request.
157
+ :type _headers: dict, optional
158
+ :param _host_index: set to override the host_index for a single
159
+ request; this effectively ignores the host_index
160
+ in the spec for a single request.
161
+ :type _host_index: int, optional
162
+ :return: Returns the result object.
163
+ """ # noqa: E501
164
+
165
+ _param = self._inbound_integration_endpoints_get_serialize(
166
+ context=context,
167
+ workspace=workspace,
168
+ _request_auth=_request_auth,
169
+ _content_type=_content_type,
170
+ _headers=_headers,
171
+ _host_index=_host_index
172
+ )
173
+
174
+ _response_types_map: Dict[str, Optional[str]] = {
175
+ '200': "List[InboundIntegrationEndpoint]",
176
+ '400': "Error",
177
+ }
178
+ response_data = self.api_client.call_api(
179
+ *_param,
180
+ _request_timeout=_request_timeout
181
+ )
182
+ response_data.read()
183
+ return self.api_client.response_deserialize(
184
+ response_data=response_data,
185
+ response_types_map=_response_types_map,
186
+ )
187
+
188
+
189
+ @validate_call
190
+ def inbound_integration_endpoints_get_without_preload_content(
191
+ self,
192
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
193
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
194
+ _request_timeout: Union[
195
+ None,
196
+ Annotated[StrictFloat, Field(gt=0)],
197
+ Tuple[
198
+ Annotated[StrictFloat, Field(gt=0)],
199
+ Annotated[StrictFloat, Field(gt=0)]
200
+ ]
201
+ ] = None,
202
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
203
+ _content_type: Optional[StrictStr] = None,
204
+ _headers: Optional[Dict[StrictStr, Any]] = None,
205
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
206
+ ) -> RESTResponseType:
207
+ """Returns basic inbound integration endpoint representations
208
+
209
+ Operation for retrieving an array of basic inbound integration endpoint representations for all accessible endpoints
210
+
211
+ :param context: ID of the context in which to perform the operation (required)
212
+ :type context: str
213
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
214
+ :type workspace: str
215
+ :param _request_timeout: timeout setting for this request. If one
216
+ number provided, it will be total request
217
+ timeout. It can also be a pair (tuple) of
218
+ (connection, read) timeouts.
219
+ :type _request_timeout: int, tuple(int, int), optional
220
+ :param _request_auth: set to override the auth_settings for an a single
221
+ request; this effectively ignores the
222
+ authentication in the spec for a single request.
223
+ :type _request_auth: dict, optional
224
+ :param _content_type: force content-type for the request.
225
+ :type _content_type: str, Optional
226
+ :param _headers: set to override the headers for a single
227
+ request; this effectively ignores the headers
228
+ in the spec for a single request.
229
+ :type _headers: dict, optional
230
+ :param _host_index: set to override the host_index for a single
231
+ request; this effectively ignores the host_index
232
+ in the spec for a single request.
233
+ :type _host_index: int, optional
234
+ :return: Returns the result object.
235
+ """ # noqa: E501
236
+
237
+ _param = self._inbound_integration_endpoints_get_serialize(
238
+ context=context,
239
+ workspace=workspace,
240
+ _request_auth=_request_auth,
241
+ _content_type=_content_type,
242
+ _headers=_headers,
243
+ _host_index=_host_index
244
+ )
245
+
246
+ _response_types_map: Dict[str, Optional[str]] = {
247
+ '200': "List[InboundIntegrationEndpoint]",
248
+ '400': "Error",
249
+ }
250
+ response_data = self.api_client.call_api(
251
+ *_param,
252
+ _request_timeout=_request_timeout
253
+ )
254
+ return response_data.response
255
+
256
+
257
+ def _inbound_integration_endpoints_get_serialize(
258
+ self,
259
+ context,
260
+ workspace,
261
+ _request_auth,
262
+ _content_type,
263
+ _headers,
264
+ _host_index,
265
+ ) -> RequestSerialized:
266
+
267
+ _host = None
268
+
269
+ _collection_formats: Dict[str, str] = {
270
+ }
271
+
272
+ _path_params: Dict[str, str] = {}
273
+ _query_params: List[Tuple[str, str]] = []
274
+ _header_params: Dict[str, Optional[str]] = _headers or {}
275
+ _form_params: List[Tuple[str, str]] = []
276
+ _files: Dict[
277
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
278
+ ] = {}
279
+ _body_params: Optional[bytes] = None
280
+
281
+ # process the path parameters
282
+ # process the query parameters
283
+ if context is not None:
284
+
285
+ _query_params.append(('context', context))
286
+
287
+ if workspace is not None:
288
+
289
+ _query_params.append(('workspace', workspace))
290
+
291
+ # process the header parameters
292
+ # process the form parameters
293
+ # process the body parameter
294
+
295
+
296
+ # set the HTTP header `Accept`
297
+ if 'Accept' not in _header_params:
298
+ _header_params['Accept'] = self.api_client.select_header_accept(
299
+ [
300
+ 'application/json'
301
+ ]
302
+ )
303
+
304
+
305
+ # authentication setting
306
+ _auth_settings: List[str] = [
307
+ 'basicAuth'
308
+ ]
309
+
310
+ return self.api_client.param_serialize(
311
+ method='GET',
312
+ resource_path='/inbound-integration-endpoints',
313
+ path_params=_path_params,
314
+ query_params=_query_params,
315
+ header_params=_header_params,
316
+ body=_body_params,
317
+ post_params=_form_params,
318
+ files=_files,
319
+ auth_settings=_auth_settings,
320
+ collection_formats=_collection_formats,
321
+ _host=_host,
322
+ _request_auth=_request_auth
323
+ )
324
+
325
+
326
+
327
+
328
+ @validate_call
329
+ def inbound_integration_endpoints_id_disable_post(
330
+ self,
331
+ id: Annotated[StrictStr, Field(description="ID of the inbound integration endpoint to disable")],
332
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
333
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
334
+ _request_timeout: Union[
335
+ None,
336
+ Annotated[StrictFloat, Field(gt=0)],
337
+ Tuple[
338
+ Annotated[StrictFloat, Field(gt=0)],
339
+ Annotated[StrictFloat, Field(gt=0)]
340
+ ]
341
+ ] = None,
342
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
343
+ _content_type: Optional[StrictStr] = None,
344
+ _headers: Optional[Dict[StrictStr, Any]] = None,
345
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
346
+ ) -> None:
347
+ """Disables the specified inbound integration endpoint
348
+
349
+ Operation for disabling an inbound integration endpoint. Can be called regardless of the endpoint status.
350
+
351
+ :param id: ID of the inbound integration endpoint to disable (required)
352
+ :type id: str
353
+ :param context: ID of the context in which to perform the operation (required)
354
+ :type context: str
355
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
356
+ :type workspace: str
357
+ :param _request_timeout: timeout setting for this request. If one
358
+ number provided, it will be total request
359
+ timeout. It can also be a pair (tuple) of
360
+ (connection, read) timeouts.
361
+ :type _request_timeout: int, tuple(int, int), optional
362
+ :param _request_auth: set to override the auth_settings for an a single
363
+ request; this effectively ignores the
364
+ authentication in the spec for a single request.
365
+ :type _request_auth: dict, optional
366
+ :param _content_type: force content-type for the request.
367
+ :type _content_type: str, Optional
368
+ :param _headers: set to override the headers for a single
369
+ request; this effectively ignores the headers
370
+ in the spec for a single request.
371
+ :type _headers: dict, optional
372
+ :param _host_index: set to override the host_index for a single
373
+ request; this effectively ignores the host_index
374
+ in the spec for a single request.
375
+ :type _host_index: int, optional
376
+ :return: Returns the result object.
377
+ """ # noqa: E501
378
+
379
+ _param = self._inbound_integration_endpoints_id_disable_post_serialize(
380
+ id=id,
381
+ context=context,
382
+ workspace=workspace,
383
+ _request_auth=_request_auth,
384
+ _content_type=_content_type,
385
+ _headers=_headers,
386
+ _host_index=_host_index
387
+ )
388
+
389
+ _response_types_map: Dict[str, Optional[str]] = {
390
+ '200': None,
391
+ '400': "Error",
392
+ '404': "Error",
393
+ '503': "Error",
394
+ }
395
+ response_data = self.api_client.call_api(
396
+ *_param,
397
+ _request_timeout=_request_timeout
398
+ )
399
+ response_data.read()
400
+ return self.api_client.response_deserialize(
401
+ response_data=response_data,
402
+ response_types_map=_response_types_map,
403
+ ).data
404
+
405
+
406
+ @validate_call
407
+ def inbound_integration_endpoints_id_disable_post_with_http_info(
408
+ self,
409
+ id: Annotated[StrictStr, Field(description="ID of the inbound integration endpoint to disable")],
410
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
411
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
412
+ _request_timeout: Union[
413
+ None,
414
+ Annotated[StrictFloat, Field(gt=0)],
415
+ Tuple[
416
+ Annotated[StrictFloat, Field(gt=0)],
417
+ Annotated[StrictFloat, Field(gt=0)]
418
+ ]
419
+ ] = None,
420
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
421
+ _content_type: Optional[StrictStr] = None,
422
+ _headers: Optional[Dict[StrictStr, Any]] = None,
423
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
424
+ ) -> ApiResponse[None]:
425
+ """Disables the specified inbound integration endpoint
426
+
427
+ Operation for disabling an inbound integration endpoint. Can be called regardless of the endpoint status.
428
+
429
+ :param id: ID of the inbound integration endpoint to disable (required)
430
+ :type id: str
431
+ :param context: ID of the context in which to perform the operation (required)
432
+ :type context: str
433
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
434
+ :type workspace: str
435
+ :param _request_timeout: timeout setting for this request. If one
436
+ number provided, it will be total request
437
+ timeout. It can also be a pair (tuple) of
438
+ (connection, read) timeouts.
439
+ :type _request_timeout: int, tuple(int, int), optional
440
+ :param _request_auth: set to override the auth_settings for an a single
441
+ request; this effectively ignores the
442
+ authentication in the spec for a single request.
443
+ :type _request_auth: dict, optional
444
+ :param _content_type: force content-type for the request.
445
+ :type _content_type: str, Optional
446
+ :param _headers: set to override the headers for a single
447
+ request; this effectively ignores the headers
448
+ in the spec for a single request.
449
+ :type _headers: dict, optional
450
+ :param _host_index: set to override the host_index for a single
451
+ request; this effectively ignores the host_index
452
+ in the spec for a single request.
453
+ :type _host_index: int, optional
454
+ :return: Returns the result object.
455
+ """ # noqa: E501
456
+
457
+ _param = self._inbound_integration_endpoints_id_disable_post_serialize(
458
+ id=id,
459
+ context=context,
460
+ workspace=workspace,
461
+ _request_auth=_request_auth,
462
+ _content_type=_content_type,
463
+ _headers=_headers,
464
+ _host_index=_host_index
465
+ )
466
+
467
+ _response_types_map: Dict[str, Optional[str]] = {
468
+ '200': None,
469
+ '400': "Error",
470
+ '404': "Error",
471
+ '503': "Error",
472
+ }
473
+ response_data = self.api_client.call_api(
474
+ *_param,
475
+ _request_timeout=_request_timeout
476
+ )
477
+ response_data.read()
478
+ return self.api_client.response_deserialize(
479
+ response_data=response_data,
480
+ response_types_map=_response_types_map,
481
+ )
482
+
483
+
484
+ @validate_call
485
+ def inbound_integration_endpoints_id_disable_post_without_preload_content(
486
+ self,
487
+ id: Annotated[StrictStr, Field(description="ID of the inbound integration endpoint to disable")],
488
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
489
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
490
+ _request_timeout: Union[
491
+ None,
492
+ Annotated[StrictFloat, Field(gt=0)],
493
+ Tuple[
494
+ Annotated[StrictFloat, Field(gt=0)],
495
+ Annotated[StrictFloat, Field(gt=0)]
496
+ ]
497
+ ] = None,
498
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
499
+ _content_type: Optional[StrictStr] = None,
500
+ _headers: Optional[Dict[StrictStr, Any]] = None,
501
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
502
+ ) -> RESTResponseType:
503
+ """Disables the specified inbound integration endpoint
504
+
505
+ Operation for disabling an inbound integration endpoint. Can be called regardless of the endpoint status.
506
+
507
+ :param id: ID of the inbound integration endpoint to disable (required)
508
+ :type id: str
509
+ :param context: ID of the context in which to perform the operation (required)
510
+ :type context: str
511
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
512
+ :type workspace: str
513
+ :param _request_timeout: timeout setting for this request. If one
514
+ number provided, it will be total request
515
+ timeout. It can also be a pair (tuple) of
516
+ (connection, read) timeouts.
517
+ :type _request_timeout: int, tuple(int, int), optional
518
+ :param _request_auth: set to override the auth_settings for an a single
519
+ request; this effectively ignores the
520
+ authentication in the spec for a single request.
521
+ :type _request_auth: dict, optional
522
+ :param _content_type: force content-type for the request.
523
+ :type _content_type: str, Optional
524
+ :param _headers: set to override the headers for a single
525
+ request; this effectively ignores the headers
526
+ in the spec for a single request.
527
+ :type _headers: dict, optional
528
+ :param _host_index: set to override the host_index for a single
529
+ request; this effectively ignores the host_index
530
+ in the spec for a single request.
531
+ :type _host_index: int, optional
532
+ :return: Returns the result object.
533
+ """ # noqa: E501
534
+
535
+ _param = self._inbound_integration_endpoints_id_disable_post_serialize(
536
+ id=id,
537
+ context=context,
538
+ workspace=workspace,
539
+ _request_auth=_request_auth,
540
+ _content_type=_content_type,
541
+ _headers=_headers,
542
+ _host_index=_host_index
543
+ )
544
+
545
+ _response_types_map: Dict[str, Optional[str]] = {
546
+ '200': None,
547
+ '400': "Error",
548
+ '404': "Error",
549
+ '503': "Error",
550
+ }
551
+ response_data = self.api_client.call_api(
552
+ *_param,
553
+ _request_timeout=_request_timeout
554
+ )
555
+ return response_data.response
556
+
557
+
558
+ def _inbound_integration_endpoints_id_disable_post_serialize(
559
+ self,
560
+ id,
561
+ context,
562
+ workspace,
563
+ _request_auth,
564
+ _content_type,
565
+ _headers,
566
+ _host_index,
567
+ ) -> RequestSerialized:
568
+
569
+ _host = None
570
+
571
+ _collection_formats: Dict[str, str] = {
572
+ }
573
+
574
+ _path_params: Dict[str, str] = {}
575
+ _query_params: List[Tuple[str, str]] = []
576
+ _header_params: Dict[str, Optional[str]] = _headers or {}
577
+ _form_params: List[Tuple[str, str]] = []
578
+ _files: Dict[
579
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
580
+ ] = {}
581
+ _body_params: Optional[bytes] = None
582
+
583
+ # process the path parameters
584
+ if id is not None:
585
+ _path_params['id'] = id
586
+ # process the query parameters
587
+ if context is not None:
588
+
589
+ _query_params.append(('context', context))
590
+
591
+ if workspace is not None:
592
+
593
+ _query_params.append(('workspace', workspace))
594
+
595
+ # process the header parameters
596
+ # process the form parameters
597
+ # process the body parameter
598
+
599
+
600
+ # set the HTTP header `Accept`
601
+ if 'Accept' not in _header_params:
602
+ _header_params['Accept'] = self.api_client.select_header_accept(
603
+ [
604
+ 'application/json'
605
+ ]
606
+ )
607
+
608
+
609
+ # authentication setting
610
+ _auth_settings: List[str] = [
611
+ 'basicAuth'
612
+ ]
613
+
614
+ return self.api_client.param_serialize(
615
+ method='POST',
616
+ resource_path='/inbound-integration-endpoints/{id}/disable',
617
+ path_params=_path_params,
618
+ query_params=_query_params,
619
+ header_params=_header_params,
620
+ body=_body_params,
621
+ post_params=_form_params,
622
+ files=_files,
623
+ auth_settings=_auth_settings,
624
+ collection_formats=_collection_formats,
625
+ _host=_host,
626
+ _request_auth=_request_auth
627
+ )
628
+
629
+
630
+
631
+
632
+ @validate_call
633
+ def inbound_integration_endpoints_id_enable_post(
634
+ self,
635
+ id: Annotated[StrictStr, Field(description="ID of the inbound integration endpoint to enable")],
636
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
637
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
638
+ _request_timeout: Union[
639
+ None,
640
+ Annotated[StrictFloat, Field(gt=0)],
641
+ Tuple[
642
+ Annotated[StrictFloat, Field(gt=0)],
643
+ Annotated[StrictFloat, Field(gt=0)]
644
+ ]
645
+ ] = None,
646
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
647
+ _content_type: Optional[StrictStr] = None,
648
+ _headers: Optional[Dict[StrictStr, Any]] = None,
649
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
650
+ ) -> None:
651
+ """Enables the specified inbound integration endpoint
652
+
653
+ Operation for enabling an inbound integration endpoint. Can be called regardless of the endpoint status. Endpoints with status 'failed' will be resumed.
654
+
655
+ :param id: ID of the inbound integration endpoint to enable (required)
656
+ :type id: str
657
+ :param context: ID of the context in which to perform the operation (required)
658
+ :type context: str
659
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
660
+ :type workspace: str
661
+ :param _request_timeout: timeout setting for this request. If one
662
+ number provided, it will be total request
663
+ timeout. It can also be a pair (tuple) of
664
+ (connection, read) timeouts.
665
+ :type _request_timeout: int, tuple(int, int), optional
666
+ :param _request_auth: set to override the auth_settings for an a single
667
+ request; this effectively ignores the
668
+ authentication in the spec for a single request.
669
+ :type _request_auth: dict, optional
670
+ :param _content_type: force content-type for the request.
671
+ :type _content_type: str, Optional
672
+ :param _headers: set to override the headers for a single
673
+ request; this effectively ignores the headers
674
+ in the spec for a single request.
675
+ :type _headers: dict, optional
676
+ :param _host_index: set to override the host_index for a single
677
+ request; this effectively ignores the host_index
678
+ in the spec for a single request.
679
+ :type _host_index: int, optional
680
+ :return: Returns the result object.
681
+ """ # noqa: E501
682
+
683
+ _param = self._inbound_integration_endpoints_id_enable_post_serialize(
684
+ id=id,
685
+ context=context,
686
+ workspace=workspace,
687
+ _request_auth=_request_auth,
688
+ _content_type=_content_type,
689
+ _headers=_headers,
690
+ _host_index=_host_index
691
+ )
692
+
693
+ _response_types_map: Dict[str, Optional[str]] = {
694
+ '200': None,
695
+ '400': "Error",
696
+ '404': "Error",
697
+ '503': "Error",
698
+ }
699
+ response_data = self.api_client.call_api(
700
+ *_param,
701
+ _request_timeout=_request_timeout
702
+ )
703
+ response_data.read()
704
+ return self.api_client.response_deserialize(
705
+ response_data=response_data,
706
+ response_types_map=_response_types_map,
707
+ ).data
708
+
709
+
710
+ @validate_call
711
+ def inbound_integration_endpoints_id_enable_post_with_http_info(
712
+ self,
713
+ id: Annotated[StrictStr, Field(description="ID of the inbound integration endpoint to enable")],
714
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
715
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
716
+ _request_timeout: Union[
717
+ None,
718
+ Annotated[StrictFloat, Field(gt=0)],
719
+ Tuple[
720
+ Annotated[StrictFloat, Field(gt=0)],
721
+ Annotated[StrictFloat, Field(gt=0)]
722
+ ]
723
+ ] = None,
724
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
725
+ _content_type: Optional[StrictStr] = None,
726
+ _headers: Optional[Dict[StrictStr, Any]] = None,
727
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
728
+ ) -> ApiResponse[None]:
729
+ """Enables the specified inbound integration endpoint
730
+
731
+ Operation for enabling an inbound integration endpoint. Can be called regardless of the endpoint status. Endpoints with status 'failed' will be resumed.
732
+
733
+ :param id: ID of the inbound integration endpoint to enable (required)
734
+ :type id: str
735
+ :param context: ID of the context in which to perform the operation (required)
736
+ :type context: str
737
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
738
+ :type workspace: str
739
+ :param _request_timeout: timeout setting for this request. If one
740
+ number provided, it will be total request
741
+ timeout. It can also be a pair (tuple) of
742
+ (connection, read) timeouts.
743
+ :type _request_timeout: int, tuple(int, int), optional
744
+ :param _request_auth: set to override the auth_settings for an a single
745
+ request; this effectively ignores the
746
+ authentication in the spec for a single request.
747
+ :type _request_auth: dict, optional
748
+ :param _content_type: force content-type for the request.
749
+ :type _content_type: str, Optional
750
+ :param _headers: set to override the headers for a single
751
+ request; this effectively ignores the headers
752
+ in the spec for a single request.
753
+ :type _headers: dict, optional
754
+ :param _host_index: set to override the host_index for a single
755
+ request; this effectively ignores the host_index
756
+ in the spec for a single request.
757
+ :type _host_index: int, optional
758
+ :return: Returns the result object.
759
+ """ # noqa: E501
760
+
761
+ _param = self._inbound_integration_endpoints_id_enable_post_serialize(
762
+ id=id,
763
+ context=context,
764
+ workspace=workspace,
765
+ _request_auth=_request_auth,
766
+ _content_type=_content_type,
767
+ _headers=_headers,
768
+ _host_index=_host_index
769
+ )
770
+
771
+ _response_types_map: Dict[str, Optional[str]] = {
772
+ '200': None,
773
+ '400': "Error",
774
+ '404': "Error",
775
+ '503': "Error",
776
+ }
777
+ response_data = self.api_client.call_api(
778
+ *_param,
779
+ _request_timeout=_request_timeout
780
+ )
781
+ response_data.read()
782
+ return self.api_client.response_deserialize(
783
+ response_data=response_data,
784
+ response_types_map=_response_types_map,
785
+ )
786
+
787
+
788
+ @validate_call
789
+ def inbound_integration_endpoints_id_enable_post_without_preload_content(
790
+ self,
791
+ id: Annotated[StrictStr, Field(description="ID of the inbound integration endpoint to enable")],
792
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
793
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
794
+ _request_timeout: Union[
795
+ None,
796
+ Annotated[StrictFloat, Field(gt=0)],
797
+ Tuple[
798
+ Annotated[StrictFloat, Field(gt=0)],
799
+ Annotated[StrictFloat, Field(gt=0)]
800
+ ]
801
+ ] = None,
802
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
803
+ _content_type: Optional[StrictStr] = None,
804
+ _headers: Optional[Dict[StrictStr, Any]] = None,
805
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
806
+ ) -> RESTResponseType:
807
+ """Enables the specified inbound integration endpoint
808
+
809
+ Operation for enabling an inbound integration endpoint. Can be called regardless of the endpoint status. Endpoints with status 'failed' will be resumed.
810
+
811
+ :param id: ID of the inbound integration endpoint to enable (required)
812
+ :type id: str
813
+ :param context: ID of the context in which to perform the operation (required)
814
+ :type context: str
815
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
816
+ :type workspace: str
817
+ :param _request_timeout: timeout setting for this request. If one
818
+ number provided, it will be total request
819
+ timeout. It can also be a pair (tuple) of
820
+ (connection, read) timeouts.
821
+ :type _request_timeout: int, tuple(int, int), optional
822
+ :param _request_auth: set to override the auth_settings for an a single
823
+ request; this effectively ignores the
824
+ authentication in the spec for a single request.
825
+ :type _request_auth: dict, optional
826
+ :param _content_type: force content-type for the request.
827
+ :type _content_type: str, Optional
828
+ :param _headers: set to override the headers for a single
829
+ request; this effectively ignores the headers
830
+ in the spec for a single request.
831
+ :type _headers: dict, optional
832
+ :param _host_index: set to override the host_index for a single
833
+ request; this effectively ignores the host_index
834
+ in the spec for a single request.
835
+ :type _host_index: int, optional
836
+ :return: Returns the result object.
837
+ """ # noqa: E501
838
+
839
+ _param = self._inbound_integration_endpoints_id_enable_post_serialize(
840
+ id=id,
841
+ context=context,
842
+ workspace=workspace,
843
+ _request_auth=_request_auth,
844
+ _content_type=_content_type,
845
+ _headers=_headers,
846
+ _host_index=_host_index
847
+ )
848
+
849
+ _response_types_map: Dict[str, Optional[str]] = {
850
+ '200': None,
851
+ '400': "Error",
852
+ '404': "Error",
853
+ '503': "Error",
854
+ }
855
+ response_data = self.api_client.call_api(
856
+ *_param,
857
+ _request_timeout=_request_timeout
858
+ )
859
+ return response_data.response
860
+
861
+
862
+ def _inbound_integration_endpoints_id_enable_post_serialize(
863
+ self,
864
+ id,
865
+ context,
866
+ workspace,
867
+ _request_auth,
868
+ _content_type,
869
+ _headers,
870
+ _host_index,
871
+ ) -> RequestSerialized:
872
+
873
+ _host = None
874
+
875
+ _collection_formats: Dict[str, str] = {
876
+ }
877
+
878
+ _path_params: Dict[str, str] = {}
879
+ _query_params: List[Tuple[str, str]] = []
880
+ _header_params: Dict[str, Optional[str]] = _headers or {}
881
+ _form_params: List[Tuple[str, str]] = []
882
+ _files: Dict[
883
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
884
+ ] = {}
885
+ _body_params: Optional[bytes] = None
886
+
887
+ # process the path parameters
888
+ if id is not None:
889
+ _path_params['id'] = id
890
+ # process the query parameters
891
+ if context is not None:
892
+
893
+ _query_params.append(('context', context))
894
+
895
+ if workspace is not None:
896
+
897
+ _query_params.append(('workspace', workspace))
898
+
899
+ # process the header parameters
900
+ # process the form parameters
901
+ # process the body parameter
902
+
903
+
904
+ # set the HTTP header `Accept`
905
+ if 'Accept' not in _header_params:
906
+ _header_params['Accept'] = self.api_client.select_header_accept(
907
+ [
908
+ 'application/json'
909
+ ]
910
+ )
911
+
912
+
913
+ # authentication setting
914
+ _auth_settings: List[str] = [
915
+ 'basicAuth'
916
+ ]
917
+
918
+ return self.api_client.param_serialize(
919
+ method='POST',
920
+ resource_path='/inbound-integration-endpoints/{id}/enable',
921
+ path_params=_path_params,
922
+ query_params=_query_params,
923
+ header_params=_header_params,
924
+ body=_body_params,
925
+ post_params=_form_params,
926
+ files=_files,
927
+ auth_settings=_auth_settings,
928
+ collection_formats=_collection_formats,
929
+ _host=_host,
930
+ _request_auth=_request_auth
931
+ )
932
+
933
+
934
+
935
+
936
+ @validate_call
937
+ def inbound_integration_endpoints_id_execution_report_get(
938
+ self,
939
+ id: Annotated[StrictStr, Field(description="ID of the inbound integration endpoint for which to retrieve the execution report")],
940
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
941
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
942
+ _request_timeout: Union[
943
+ None,
944
+ Annotated[StrictFloat, Field(gt=0)],
945
+ Tuple[
946
+ Annotated[StrictFloat, Field(gt=0)],
947
+ Annotated[StrictFloat, Field(gt=0)]
948
+ ]
949
+ ] = None,
950
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
951
+ _content_type: Optional[StrictStr] = None,
952
+ _headers: Optional[Dict[StrictStr, Any]] = None,
953
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
954
+ ) -> List[ExecutionReportEntry]:
955
+ """Returns the execution report for the specified inbound integration endpoint
956
+
957
+ Operation for retrieving the execution report for the main process of a specific inbound integration endpoint
958
+
959
+ :param id: ID of the inbound integration endpoint for which to retrieve the execution report (required)
960
+ :type id: str
961
+ :param context: ID of the context in which to perform the operation (required)
962
+ :type context: str
963
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
964
+ :type workspace: str
965
+ :param _request_timeout: timeout setting for this request. If one
966
+ number provided, it will be total request
967
+ timeout. It can also be a pair (tuple) of
968
+ (connection, read) timeouts.
969
+ :type _request_timeout: int, tuple(int, int), optional
970
+ :param _request_auth: set to override the auth_settings for an a single
971
+ request; this effectively ignores the
972
+ authentication in the spec for a single request.
973
+ :type _request_auth: dict, optional
974
+ :param _content_type: force content-type for the request.
975
+ :type _content_type: str, Optional
976
+ :param _headers: set to override the headers for a single
977
+ request; this effectively ignores the headers
978
+ in the spec for a single request.
979
+ :type _headers: dict, optional
980
+ :param _host_index: set to override the host_index for a single
981
+ request; this effectively ignores the host_index
982
+ in the spec for a single request.
983
+ :type _host_index: int, optional
984
+ :return: Returns the result object.
985
+ """ # noqa: E501
986
+
987
+ _param = self._inbound_integration_endpoints_id_execution_report_get_serialize(
988
+ id=id,
989
+ context=context,
990
+ workspace=workspace,
991
+ _request_auth=_request_auth,
992
+ _content_type=_content_type,
993
+ _headers=_headers,
994
+ _host_index=_host_index
995
+ )
996
+
997
+ _response_types_map: Dict[str, Optional[str]] = {
998
+ '200': "List[ExecutionReportEntry]",
999
+ '400': "Error",
1000
+ '404': "Error",
1001
+ }
1002
+ response_data = self.api_client.call_api(
1003
+ *_param,
1004
+ _request_timeout=_request_timeout
1005
+ )
1006
+ response_data.read()
1007
+ return self.api_client.response_deserialize(
1008
+ response_data=response_data,
1009
+ response_types_map=_response_types_map,
1010
+ ).data
1011
+
1012
+
1013
+ @validate_call
1014
+ def inbound_integration_endpoints_id_execution_report_get_with_http_info(
1015
+ self,
1016
+ id: Annotated[StrictStr, Field(description="ID of the inbound integration endpoint for which to retrieve the execution report")],
1017
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
1018
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
1019
+ _request_timeout: Union[
1020
+ None,
1021
+ Annotated[StrictFloat, Field(gt=0)],
1022
+ Tuple[
1023
+ Annotated[StrictFloat, Field(gt=0)],
1024
+ Annotated[StrictFloat, Field(gt=0)]
1025
+ ]
1026
+ ] = None,
1027
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1028
+ _content_type: Optional[StrictStr] = None,
1029
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1030
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1031
+ ) -> ApiResponse[List[ExecutionReportEntry]]:
1032
+ """Returns the execution report for the specified inbound integration endpoint
1033
+
1034
+ Operation for retrieving the execution report for the main process of a specific inbound integration endpoint
1035
+
1036
+ :param id: ID of the inbound integration endpoint for which to retrieve the execution report (required)
1037
+ :type id: str
1038
+ :param context: ID of the context in which to perform the operation (required)
1039
+ :type context: str
1040
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
1041
+ :type workspace: str
1042
+ :param _request_timeout: timeout setting for this request. If one
1043
+ number provided, it will be total request
1044
+ timeout. It can also be a pair (tuple) of
1045
+ (connection, read) timeouts.
1046
+ :type _request_timeout: int, tuple(int, int), optional
1047
+ :param _request_auth: set to override the auth_settings for an a single
1048
+ request; this effectively ignores the
1049
+ authentication in the spec for a single request.
1050
+ :type _request_auth: dict, optional
1051
+ :param _content_type: force content-type for the request.
1052
+ :type _content_type: str, Optional
1053
+ :param _headers: set to override the headers for a single
1054
+ request; this effectively ignores the headers
1055
+ in the spec for a single request.
1056
+ :type _headers: dict, optional
1057
+ :param _host_index: set to override the host_index for a single
1058
+ request; this effectively ignores the host_index
1059
+ in the spec for a single request.
1060
+ :type _host_index: int, optional
1061
+ :return: Returns the result object.
1062
+ """ # noqa: E501
1063
+
1064
+ _param = self._inbound_integration_endpoints_id_execution_report_get_serialize(
1065
+ id=id,
1066
+ context=context,
1067
+ workspace=workspace,
1068
+ _request_auth=_request_auth,
1069
+ _content_type=_content_type,
1070
+ _headers=_headers,
1071
+ _host_index=_host_index
1072
+ )
1073
+
1074
+ _response_types_map: Dict[str, Optional[str]] = {
1075
+ '200': "List[ExecutionReportEntry]",
1076
+ '400': "Error",
1077
+ '404': "Error",
1078
+ }
1079
+ response_data = self.api_client.call_api(
1080
+ *_param,
1081
+ _request_timeout=_request_timeout
1082
+ )
1083
+ response_data.read()
1084
+ return self.api_client.response_deserialize(
1085
+ response_data=response_data,
1086
+ response_types_map=_response_types_map,
1087
+ )
1088
+
1089
+
1090
+ @validate_call
1091
+ def inbound_integration_endpoints_id_execution_report_get_without_preload_content(
1092
+ self,
1093
+ id: Annotated[StrictStr, Field(description="ID of the inbound integration endpoint for which to retrieve the execution report")],
1094
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
1095
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
1096
+ _request_timeout: Union[
1097
+ None,
1098
+ Annotated[StrictFloat, Field(gt=0)],
1099
+ Tuple[
1100
+ Annotated[StrictFloat, Field(gt=0)],
1101
+ Annotated[StrictFloat, Field(gt=0)]
1102
+ ]
1103
+ ] = None,
1104
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1105
+ _content_type: Optional[StrictStr] = None,
1106
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1107
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1108
+ ) -> RESTResponseType:
1109
+ """Returns the execution report for the specified inbound integration endpoint
1110
+
1111
+ Operation for retrieving the execution report for the main process of a specific inbound integration endpoint
1112
+
1113
+ :param id: ID of the inbound integration endpoint for which to retrieve the execution report (required)
1114
+ :type id: str
1115
+ :param context: ID of the context in which to perform the operation (required)
1116
+ :type context: str
1117
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
1118
+ :type workspace: str
1119
+ :param _request_timeout: timeout setting for this request. If one
1120
+ number provided, it will be total request
1121
+ timeout. It can also be a pair (tuple) of
1122
+ (connection, read) timeouts.
1123
+ :type _request_timeout: int, tuple(int, int), optional
1124
+ :param _request_auth: set to override the auth_settings for an a single
1125
+ request; this effectively ignores the
1126
+ authentication in the spec for a single request.
1127
+ :type _request_auth: dict, optional
1128
+ :param _content_type: force content-type for the request.
1129
+ :type _content_type: str, Optional
1130
+ :param _headers: set to override the headers for a single
1131
+ request; this effectively ignores the headers
1132
+ in the spec for a single request.
1133
+ :type _headers: dict, optional
1134
+ :param _host_index: set to override the host_index for a single
1135
+ request; this effectively ignores the host_index
1136
+ in the spec for a single request.
1137
+ :type _host_index: int, optional
1138
+ :return: Returns the result object.
1139
+ """ # noqa: E501
1140
+
1141
+ _param = self._inbound_integration_endpoints_id_execution_report_get_serialize(
1142
+ id=id,
1143
+ context=context,
1144
+ workspace=workspace,
1145
+ _request_auth=_request_auth,
1146
+ _content_type=_content_type,
1147
+ _headers=_headers,
1148
+ _host_index=_host_index
1149
+ )
1150
+
1151
+ _response_types_map: Dict[str, Optional[str]] = {
1152
+ '200': "List[ExecutionReportEntry]",
1153
+ '400': "Error",
1154
+ '404': "Error",
1155
+ }
1156
+ response_data = self.api_client.call_api(
1157
+ *_param,
1158
+ _request_timeout=_request_timeout
1159
+ )
1160
+ return response_data.response
1161
+
1162
+
1163
+ def _inbound_integration_endpoints_id_execution_report_get_serialize(
1164
+ self,
1165
+ id,
1166
+ context,
1167
+ workspace,
1168
+ _request_auth,
1169
+ _content_type,
1170
+ _headers,
1171
+ _host_index,
1172
+ ) -> RequestSerialized:
1173
+
1174
+ _host = None
1175
+
1176
+ _collection_formats: Dict[str, str] = {
1177
+ }
1178
+
1179
+ _path_params: Dict[str, str] = {}
1180
+ _query_params: List[Tuple[str, str]] = []
1181
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1182
+ _form_params: List[Tuple[str, str]] = []
1183
+ _files: Dict[
1184
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1185
+ ] = {}
1186
+ _body_params: Optional[bytes] = None
1187
+
1188
+ # process the path parameters
1189
+ if id is not None:
1190
+ _path_params['id'] = id
1191
+ # process the query parameters
1192
+ if context is not None:
1193
+
1194
+ _query_params.append(('context', context))
1195
+
1196
+ if workspace is not None:
1197
+
1198
+ _query_params.append(('workspace', workspace))
1199
+
1200
+ # process the header parameters
1201
+ # process the form parameters
1202
+ # process the body parameter
1203
+
1204
+
1205
+ # set the HTTP header `Accept`
1206
+ if 'Accept' not in _header_params:
1207
+ _header_params['Accept'] = self.api_client.select_header_accept(
1208
+ [
1209
+ 'application/json'
1210
+ ]
1211
+ )
1212
+
1213
+
1214
+ # authentication setting
1215
+ _auth_settings: List[str] = [
1216
+ 'basicAuth'
1217
+ ]
1218
+
1219
+ return self.api_client.param_serialize(
1220
+ method='GET',
1221
+ resource_path='/inbound-integration-endpoints/{id}/execution-report',
1222
+ path_params=_path_params,
1223
+ query_params=_query_params,
1224
+ header_params=_header_params,
1225
+ body=_body_params,
1226
+ post_params=_form_params,
1227
+ files=_files,
1228
+ auth_settings=_auth_settings,
1229
+ collection_formats=_collection_formats,
1230
+ _host=_host,
1231
+ _request_auth=_request_auth
1232
+ )
1233
+
1234
+
1235
+
1236
+
1237
+ @validate_call
1238
+ def inbound_integration_endpoints_id_invoke_post(
1239
+ self,
1240
+ id: Annotated[StrictStr, Field(description="ID of the inbound integration endpoint to invoke")],
1241
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
1242
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
1243
+ _request_timeout: Union[
1244
+ None,
1245
+ Annotated[StrictFloat, Field(gt=0)],
1246
+ Tuple[
1247
+ Annotated[StrictFloat, Field(gt=0)],
1248
+ Annotated[StrictFloat, Field(gt=0)]
1249
+ ]
1250
+ ] = None,
1251
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1252
+ _content_type: Optional[StrictStr] = None,
1253
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1254
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1255
+ ) -> None:
1256
+ """Invokes the specified inbound integration endpoint
1257
+
1258
+ Operation for invoking an inbound integration endpoint. Can be called only for endpoints with status 'enabled'.
1259
+
1260
+ :param id: ID of the inbound integration endpoint to invoke (required)
1261
+ :type id: str
1262
+ :param context: ID of the context in which to perform the operation (required)
1263
+ :type context: str
1264
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
1265
+ :type workspace: str
1266
+ :param _request_timeout: timeout setting for this request. If one
1267
+ number provided, it will be total request
1268
+ timeout. It can also be a pair (tuple) of
1269
+ (connection, read) timeouts.
1270
+ :type _request_timeout: int, tuple(int, int), optional
1271
+ :param _request_auth: set to override the auth_settings for an a single
1272
+ request; this effectively ignores the
1273
+ authentication in the spec for a single request.
1274
+ :type _request_auth: dict, optional
1275
+ :param _content_type: force content-type for the request.
1276
+ :type _content_type: str, Optional
1277
+ :param _headers: set to override the headers for a single
1278
+ request; this effectively ignores the headers
1279
+ in the spec for a single request.
1280
+ :type _headers: dict, optional
1281
+ :param _host_index: set to override the host_index for a single
1282
+ request; this effectively ignores the host_index
1283
+ in the spec for a single request.
1284
+ :type _host_index: int, optional
1285
+ :return: Returns the result object.
1286
+ """ # noqa: E501
1287
+
1288
+ _param = self._inbound_integration_endpoints_id_invoke_post_serialize(
1289
+ id=id,
1290
+ context=context,
1291
+ workspace=workspace,
1292
+ _request_auth=_request_auth,
1293
+ _content_type=_content_type,
1294
+ _headers=_headers,
1295
+ _host_index=_host_index
1296
+ )
1297
+
1298
+ _response_types_map: Dict[str, Optional[str]] = {
1299
+ '200': None,
1300
+ '400': "Error",
1301
+ '404': "Error",
1302
+ '503': "Error",
1303
+ }
1304
+ response_data = self.api_client.call_api(
1305
+ *_param,
1306
+ _request_timeout=_request_timeout
1307
+ )
1308
+ response_data.read()
1309
+ return self.api_client.response_deserialize(
1310
+ response_data=response_data,
1311
+ response_types_map=_response_types_map,
1312
+ ).data
1313
+
1314
+
1315
+ @validate_call
1316
+ def inbound_integration_endpoints_id_invoke_post_with_http_info(
1317
+ self,
1318
+ id: Annotated[StrictStr, Field(description="ID of the inbound integration endpoint to invoke")],
1319
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
1320
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
1321
+ _request_timeout: Union[
1322
+ None,
1323
+ Annotated[StrictFloat, Field(gt=0)],
1324
+ Tuple[
1325
+ Annotated[StrictFloat, Field(gt=0)],
1326
+ Annotated[StrictFloat, Field(gt=0)]
1327
+ ]
1328
+ ] = None,
1329
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1330
+ _content_type: Optional[StrictStr] = None,
1331
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1332
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1333
+ ) -> ApiResponse[None]:
1334
+ """Invokes the specified inbound integration endpoint
1335
+
1336
+ Operation for invoking an inbound integration endpoint. Can be called only for endpoints with status 'enabled'.
1337
+
1338
+ :param id: ID of the inbound integration endpoint to invoke (required)
1339
+ :type id: str
1340
+ :param context: ID of the context in which to perform the operation (required)
1341
+ :type context: str
1342
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
1343
+ :type workspace: str
1344
+ :param _request_timeout: timeout setting for this request. If one
1345
+ number provided, it will be total request
1346
+ timeout. It can also be a pair (tuple) of
1347
+ (connection, read) timeouts.
1348
+ :type _request_timeout: int, tuple(int, int), optional
1349
+ :param _request_auth: set to override the auth_settings for an a single
1350
+ request; this effectively ignores the
1351
+ authentication in the spec for a single request.
1352
+ :type _request_auth: dict, optional
1353
+ :param _content_type: force content-type for the request.
1354
+ :type _content_type: str, Optional
1355
+ :param _headers: set to override the headers for a single
1356
+ request; this effectively ignores the headers
1357
+ in the spec for a single request.
1358
+ :type _headers: dict, optional
1359
+ :param _host_index: set to override the host_index for a single
1360
+ request; this effectively ignores the host_index
1361
+ in the spec for a single request.
1362
+ :type _host_index: int, optional
1363
+ :return: Returns the result object.
1364
+ """ # noqa: E501
1365
+
1366
+ _param = self._inbound_integration_endpoints_id_invoke_post_serialize(
1367
+ id=id,
1368
+ context=context,
1369
+ workspace=workspace,
1370
+ _request_auth=_request_auth,
1371
+ _content_type=_content_type,
1372
+ _headers=_headers,
1373
+ _host_index=_host_index
1374
+ )
1375
+
1376
+ _response_types_map: Dict[str, Optional[str]] = {
1377
+ '200': None,
1378
+ '400': "Error",
1379
+ '404': "Error",
1380
+ '503': "Error",
1381
+ }
1382
+ response_data = self.api_client.call_api(
1383
+ *_param,
1384
+ _request_timeout=_request_timeout
1385
+ )
1386
+ response_data.read()
1387
+ return self.api_client.response_deserialize(
1388
+ response_data=response_data,
1389
+ response_types_map=_response_types_map,
1390
+ )
1391
+
1392
+
1393
+ @validate_call
1394
+ def inbound_integration_endpoints_id_invoke_post_without_preload_content(
1395
+ self,
1396
+ id: Annotated[StrictStr, Field(description="ID of the inbound integration endpoint to invoke")],
1397
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
1398
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
1399
+ _request_timeout: Union[
1400
+ None,
1401
+ Annotated[StrictFloat, Field(gt=0)],
1402
+ Tuple[
1403
+ Annotated[StrictFloat, Field(gt=0)],
1404
+ Annotated[StrictFloat, Field(gt=0)]
1405
+ ]
1406
+ ] = None,
1407
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1408
+ _content_type: Optional[StrictStr] = None,
1409
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1410
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1411
+ ) -> RESTResponseType:
1412
+ """Invokes the specified inbound integration endpoint
1413
+
1414
+ Operation for invoking an inbound integration endpoint. Can be called only for endpoints with status 'enabled'.
1415
+
1416
+ :param id: ID of the inbound integration endpoint to invoke (required)
1417
+ :type id: str
1418
+ :param context: ID of the context in which to perform the operation (required)
1419
+ :type context: str
1420
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
1421
+ :type workspace: str
1422
+ :param _request_timeout: timeout setting for this request. If one
1423
+ number provided, it will be total request
1424
+ timeout. It can also be a pair (tuple) of
1425
+ (connection, read) timeouts.
1426
+ :type _request_timeout: int, tuple(int, int), optional
1427
+ :param _request_auth: set to override the auth_settings for an a single
1428
+ request; this effectively ignores the
1429
+ authentication in the spec for a single request.
1430
+ :type _request_auth: dict, optional
1431
+ :param _content_type: force content-type for the request.
1432
+ :type _content_type: str, Optional
1433
+ :param _headers: set to override the headers for a single
1434
+ request; this effectively ignores the headers
1435
+ in the spec for a single request.
1436
+ :type _headers: dict, optional
1437
+ :param _host_index: set to override the host_index for a single
1438
+ request; this effectively ignores the host_index
1439
+ in the spec for a single request.
1440
+ :type _host_index: int, optional
1441
+ :return: Returns the result object.
1442
+ """ # noqa: E501
1443
+
1444
+ _param = self._inbound_integration_endpoints_id_invoke_post_serialize(
1445
+ id=id,
1446
+ context=context,
1447
+ workspace=workspace,
1448
+ _request_auth=_request_auth,
1449
+ _content_type=_content_type,
1450
+ _headers=_headers,
1451
+ _host_index=_host_index
1452
+ )
1453
+
1454
+ _response_types_map: Dict[str, Optional[str]] = {
1455
+ '200': None,
1456
+ '400': "Error",
1457
+ '404': "Error",
1458
+ '503': "Error",
1459
+ }
1460
+ response_data = self.api_client.call_api(
1461
+ *_param,
1462
+ _request_timeout=_request_timeout
1463
+ )
1464
+ return response_data.response
1465
+
1466
+
1467
+ def _inbound_integration_endpoints_id_invoke_post_serialize(
1468
+ self,
1469
+ id,
1470
+ context,
1471
+ workspace,
1472
+ _request_auth,
1473
+ _content_type,
1474
+ _headers,
1475
+ _host_index,
1476
+ ) -> RequestSerialized:
1477
+
1478
+ _host = None
1479
+
1480
+ _collection_formats: Dict[str, str] = {
1481
+ }
1482
+
1483
+ _path_params: Dict[str, str] = {}
1484
+ _query_params: List[Tuple[str, str]] = []
1485
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1486
+ _form_params: List[Tuple[str, str]] = []
1487
+ _files: Dict[
1488
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1489
+ ] = {}
1490
+ _body_params: Optional[bytes] = None
1491
+
1492
+ # process the path parameters
1493
+ if id is not None:
1494
+ _path_params['id'] = id
1495
+ # process the query parameters
1496
+ if context is not None:
1497
+
1498
+ _query_params.append(('context', context))
1499
+
1500
+ if workspace is not None:
1501
+
1502
+ _query_params.append(('workspace', workspace))
1503
+
1504
+ # process the header parameters
1505
+ # process the form parameters
1506
+ # process the body parameter
1507
+
1508
+
1509
+ # set the HTTP header `Accept`
1510
+ if 'Accept' not in _header_params:
1511
+ _header_params['Accept'] = self.api_client.select_header_accept(
1512
+ [
1513
+ 'application/json'
1514
+ ]
1515
+ )
1516
+
1517
+
1518
+ # authentication setting
1519
+ _auth_settings: List[str] = [
1520
+ 'basicAuth'
1521
+ ]
1522
+
1523
+ return self.api_client.param_serialize(
1524
+ method='POST',
1525
+ resource_path='/inbound-integration-endpoints/{id}/invoke',
1526
+ path_params=_path_params,
1527
+ query_params=_query_params,
1528
+ header_params=_header_params,
1529
+ body=_body_params,
1530
+ post_params=_form_params,
1531
+ files=_files,
1532
+ auth_settings=_auth_settings,
1533
+ collection_formats=_collection_formats,
1534
+ _host=_host,
1535
+ _request_auth=_request_auth
1536
+ )
1537
+
1538
+
1539
+
1540
+
1541
+ @validate_call
1542
+ def inbound_integration_endpoints_id_statistics_get(
1543
+ self,
1544
+ id: Annotated[StrictStr, Field(description="ID of the inbound integration endpoint for which to retrieve the statistics")],
1545
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
1546
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
1547
+ _request_timeout: Union[
1548
+ None,
1549
+ Annotated[StrictFloat, Field(gt=0)],
1550
+ Tuple[
1551
+ Annotated[StrictFloat, Field(gt=0)],
1552
+ Annotated[StrictFloat, Field(gt=0)]
1553
+ ]
1554
+ ] = None,
1555
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1556
+ _content_type: Optional[StrictStr] = None,
1557
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1558
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1559
+ ) -> EndpointStatistics:
1560
+ """Returns statistics for the specified inbound integration endpoint
1561
+
1562
+ Operation for retrieving statistics for a specific inbound integration endpoint
1563
+
1564
+ :param id: ID of the inbound integration endpoint for which to retrieve the statistics (required)
1565
+ :type id: str
1566
+ :param context: ID of the context in which to perform the operation (required)
1567
+ :type context: str
1568
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
1569
+ :type workspace: str
1570
+ :param _request_timeout: timeout setting for this request. If one
1571
+ number provided, it will be total request
1572
+ timeout. It can also be a pair (tuple) of
1573
+ (connection, read) timeouts.
1574
+ :type _request_timeout: int, tuple(int, int), optional
1575
+ :param _request_auth: set to override the auth_settings for an a single
1576
+ request; this effectively ignores the
1577
+ authentication in the spec for a single request.
1578
+ :type _request_auth: dict, optional
1579
+ :param _content_type: force content-type for the request.
1580
+ :type _content_type: str, Optional
1581
+ :param _headers: set to override the headers for a single
1582
+ request; this effectively ignores the headers
1583
+ in the spec for a single request.
1584
+ :type _headers: dict, optional
1585
+ :param _host_index: set to override the host_index for a single
1586
+ request; this effectively ignores the host_index
1587
+ in the spec for a single request.
1588
+ :type _host_index: int, optional
1589
+ :return: Returns the result object.
1590
+ """ # noqa: E501
1591
+
1592
+ _param = self._inbound_integration_endpoints_id_statistics_get_serialize(
1593
+ id=id,
1594
+ context=context,
1595
+ workspace=workspace,
1596
+ _request_auth=_request_auth,
1597
+ _content_type=_content_type,
1598
+ _headers=_headers,
1599
+ _host_index=_host_index
1600
+ )
1601
+
1602
+ _response_types_map: Dict[str, Optional[str]] = {
1603
+ '200': "EndpointStatistics",
1604
+ '400': "Error",
1605
+ '404': "Error",
1606
+ }
1607
+ response_data = self.api_client.call_api(
1608
+ *_param,
1609
+ _request_timeout=_request_timeout
1610
+ )
1611
+ response_data.read()
1612
+ return self.api_client.response_deserialize(
1613
+ response_data=response_data,
1614
+ response_types_map=_response_types_map,
1615
+ ).data
1616
+
1617
+
1618
+ @validate_call
1619
+ def inbound_integration_endpoints_id_statistics_get_with_http_info(
1620
+ self,
1621
+ id: Annotated[StrictStr, Field(description="ID of the inbound integration endpoint for which to retrieve the statistics")],
1622
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
1623
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
1624
+ _request_timeout: Union[
1625
+ None,
1626
+ Annotated[StrictFloat, Field(gt=0)],
1627
+ Tuple[
1628
+ Annotated[StrictFloat, Field(gt=0)],
1629
+ Annotated[StrictFloat, Field(gt=0)]
1630
+ ]
1631
+ ] = None,
1632
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1633
+ _content_type: Optional[StrictStr] = None,
1634
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1635
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1636
+ ) -> ApiResponse[EndpointStatistics]:
1637
+ """Returns statistics for the specified inbound integration endpoint
1638
+
1639
+ Operation for retrieving statistics for a specific inbound integration endpoint
1640
+
1641
+ :param id: ID of the inbound integration endpoint for which to retrieve the statistics (required)
1642
+ :type id: str
1643
+ :param context: ID of the context in which to perform the operation (required)
1644
+ :type context: str
1645
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
1646
+ :type workspace: str
1647
+ :param _request_timeout: timeout setting for this request. If one
1648
+ number provided, it will be total request
1649
+ timeout. It can also be a pair (tuple) of
1650
+ (connection, read) timeouts.
1651
+ :type _request_timeout: int, tuple(int, int), optional
1652
+ :param _request_auth: set to override the auth_settings for an a single
1653
+ request; this effectively ignores the
1654
+ authentication in the spec for a single request.
1655
+ :type _request_auth: dict, optional
1656
+ :param _content_type: force content-type for the request.
1657
+ :type _content_type: str, Optional
1658
+ :param _headers: set to override the headers for a single
1659
+ request; this effectively ignores the headers
1660
+ in the spec for a single request.
1661
+ :type _headers: dict, optional
1662
+ :param _host_index: set to override the host_index for a single
1663
+ request; this effectively ignores the host_index
1664
+ in the spec for a single request.
1665
+ :type _host_index: int, optional
1666
+ :return: Returns the result object.
1667
+ """ # noqa: E501
1668
+
1669
+ _param = self._inbound_integration_endpoints_id_statistics_get_serialize(
1670
+ id=id,
1671
+ context=context,
1672
+ workspace=workspace,
1673
+ _request_auth=_request_auth,
1674
+ _content_type=_content_type,
1675
+ _headers=_headers,
1676
+ _host_index=_host_index
1677
+ )
1678
+
1679
+ _response_types_map: Dict[str, Optional[str]] = {
1680
+ '200': "EndpointStatistics",
1681
+ '400': "Error",
1682
+ '404': "Error",
1683
+ }
1684
+ response_data = self.api_client.call_api(
1685
+ *_param,
1686
+ _request_timeout=_request_timeout
1687
+ )
1688
+ response_data.read()
1689
+ return self.api_client.response_deserialize(
1690
+ response_data=response_data,
1691
+ response_types_map=_response_types_map,
1692
+ )
1693
+
1694
+
1695
+ @validate_call
1696
+ def inbound_integration_endpoints_id_statistics_get_without_preload_content(
1697
+ self,
1698
+ id: Annotated[StrictStr, Field(description="ID of the inbound integration endpoint for which to retrieve the statistics")],
1699
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
1700
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
1701
+ _request_timeout: Union[
1702
+ None,
1703
+ Annotated[StrictFloat, Field(gt=0)],
1704
+ Tuple[
1705
+ Annotated[StrictFloat, Field(gt=0)],
1706
+ Annotated[StrictFloat, Field(gt=0)]
1707
+ ]
1708
+ ] = None,
1709
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1710
+ _content_type: Optional[StrictStr] = None,
1711
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1712
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1713
+ ) -> RESTResponseType:
1714
+ """Returns statistics for the specified inbound integration endpoint
1715
+
1716
+ Operation for retrieving statistics for a specific inbound integration endpoint
1717
+
1718
+ :param id: ID of the inbound integration endpoint for which to retrieve the statistics (required)
1719
+ :type id: str
1720
+ :param context: ID of the context in which to perform the operation (required)
1721
+ :type context: str
1722
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
1723
+ :type workspace: str
1724
+ :param _request_timeout: timeout setting for this request. If one
1725
+ number provided, it will be total request
1726
+ timeout. It can also be a pair (tuple) of
1727
+ (connection, read) timeouts.
1728
+ :type _request_timeout: int, tuple(int, int), optional
1729
+ :param _request_auth: set to override the auth_settings for an a single
1730
+ request; this effectively ignores the
1731
+ authentication in the spec for a single request.
1732
+ :type _request_auth: dict, optional
1733
+ :param _content_type: force content-type for the request.
1734
+ :type _content_type: str, Optional
1735
+ :param _headers: set to override the headers for a single
1736
+ request; this effectively ignores the headers
1737
+ in the spec for a single request.
1738
+ :type _headers: dict, optional
1739
+ :param _host_index: set to override the host_index for a single
1740
+ request; this effectively ignores the host_index
1741
+ in the spec for a single request.
1742
+ :type _host_index: int, optional
1743
+ :return: Returns the result object.
1744
+ """ # noqa: E501
1745
+
1746
+ _param = self._inbound_integration_endpoints_id_statistics_get_serialize(
1747
+ id=id,
1748
+ context=context,
1749
+ workspace=workspace,
1750
+ _request_auth=_request_auth,
1751
+ _content_type=_content_type,
1752
+ _headers=_headers,
1753
+ _host_index=_host_index
1754
+ )
1755
+
1756
+ _response_types_map: Dict[str, Optional[str]] = {
1757
+ '200': "EndpointStatistics",
1758
+ '400': "Error",
1759
+ '404': "Error",
1760
+ }
1761
+ response_data = self.api_client.call_api(
1762
+ *_param,
1763
+ _request_timeout=_request_timeout
1764
+ )
1765
+ return response_data.response
1766
+
1767
+
1768
+ def _inbound_integration_endpoints_id_statistics_get_serialize(
1769
+ self,
1770
+ id,
1771
+ context,
1772
+ workspace,
1773
+ _request_auth,
1774
+ _content_type,
1775
+ _headers,
1776
+ _host_index,
1777
+ ) -> RequestSerialized:
1778
+
1779
+ _host = None
1780
+
1781
+ _collection_formats: Dict[str, str] = {
1782
+ }
1783
+
1784
+ _path_params: Dict[str, str] = {}
1785
+ _query_params: List[Tuple[str, str]] = []
1786
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1787
+ _form_params: List[Tuple[str, str]] = []
1788
+ _files: Dict[
1789
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1790
+ ] = {}
1791
+ _body_params: Optional[bytes] = None
1792
+
1793
+ # process the path parameters
1794
+ if id is not None:
1795
+ _path_params['id'] = id
1796
+ # process the query parameters
1797
+ if context is not None:
1798
+
1799
+ _query_params.append(('context', context))
1800
+
1801
+ if workspace is not None:
1802
+
1803
+ _query_params.append(('workspace', workspace))
1804
+
1805
+ # process the header parameters
1806
+ # process the form parameters
1807
+ # process the body parameter
1808
+
1809
+
1810
+ # set the HTTP header `Accept`
1811
+ if 'Accept' not in _header_params:
1812
+ _header_params['Accept'] = self.api_client.select_header_accept(
1813
+ [
1814
+ 'application/json'
1815
+ ]
1816
+ )
1817
+
1818
+
1819
+ # authentication setting
1820
+ _auth_settings: List[str] = [
1821
+ 'basicAuth'
1822
+ ]
1823
+
1824
+ return self.api_client.param_serialize(
1825
+ method='GET',
1826
+ resource_path='/inbound-integration-endpoints/{id}/statistics',
1827
+ path_params=_path_params,
1828
+ query_params=_query_params,
1829
+ header_params=_header_params,
1830
+ body=_body_params,
1831
+ post_params=_form_params,
1832
+ files=_files,
1833
+ auth_settings=_auth_settings,
1834
+ collection_formats=_collection_formats,
1835
+ _host=_host,
1836
+ _request_auth=_request_auth
1837
+ )
1838
+
1839
+
1840
+
1841
+
1842
+ @validate_call
1843
+ def inbound_integration_endpoints_id_status_get(
1844
+ self,
1845
+ id: Annotated[StrictStr, Field(description="ID of the inbound integration endpoint for which to retrieve the status")],
1846
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
1847
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
1848
+ _request_timeout: Union[
1849
+ None,
1850
+ Annotated[StrictFloat, Field(gt=0)],
1851
+ Tuple[
1852
+ Annotated[StrictFloat, Field(gt=0)],
1853
+ Annotated[StrictFloat, Field(gt=0)]
1854
+ ]
1855
+ ] = None,
1856
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1857
+ _content_type: Optional[StrictStr] = None,
1858
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1859
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1860
+ ) -> EndpointStatus:
1861
+ """Returns the status of the specified inbound integration endpoint
1862
+
1863
+ Operation for retrieving status information for a specific inbound integration endpoint
1864
+
1865
+ :param id: ID of the inbound integration endpoint for which to retrieve the status (required)
1866
+ :type id: str
1867
+ :param context: ID of the context in which to perform the operation (required)
1868
+ :type context: str
1869
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
1870
+ :type workspace: str
1871
+ :param _request_timeout: timeout setting for this request. If one
1872
+ number provided, it will be total request
1873
+ timeout. It can also be a pair (tuple) of
1874
+ (connection, read) timeouts.
1875
+ :type _request_timeout: int, tuple(int, int), optional
1876
+ :param _request_auth: set to override the auth_settings for an a single
1877
+ request; this effectively ignores the
1878
+ authentication in the spec for a single request.
1879
+ :type _request_auth: dict, optional
1880
+ :param _content_type: force content-type for the request.
1881
+ :type _content_type: str, Optional
1882
+ :param _headers: set to override the headers for a single
1883
+ request; this effectively ignores the headers
1884
+ in the spec for a single request.
1885
+ :type _headers: dict, optional
1886
+ :param _host_index: set to override the host_index for a single
1887
+ request; this effectively ignores the host_index
1888
+ in the spec for a single request.
1889
+ :type _host_index: int, optional
1890
+ :return: Returns the result object.
1891
+ """ # noqa: E501
1892
+
1893
+ _param = self._inbound_integration_endpoints_id_status_get_serialize(
1894
+ id=id,
1895
+ context=context,
1896
+ workspace=workspace,
1897
+ _request_auth=_request_auth,
1898
+ _content_type=_content_type,
1899
+ _headers=_headers,
1900
+ _host_index=_host_index
1901
+ )
1902
+
1903
+ _response_types_map: Dict[str, Optional[str]] = {
1904
+ '200': "EndpointStatus",
1905
+ '400': "Error",
1906
+ '404': "Error",
1907
+ }
1908
+ response_data = self.api_client.call_api(
1909
+ *_param,
1910
+ _request_timeout=_request_timeout
1911
+ )
1912
+ response_data.read()
1913
+ return self.api_client.response_deserialize(
1914
+ response_data=response_data,
1915
+ response_types_map=_response_types_map,
1916
+ ).data
1917
+
1918
+
1919
+ @validate_call
1920
+ def inbound_integration_endpoints_id_status_get_with_http_info(
1921
+ self,
1922
+ id: Annotated[StrictStr, Field(description="ID of the inbound integration endpoint for which to retrieve the status")],
1923
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
1924
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
1925
+ _request_timeout: Union[
1926
+ None,
1927
+ Annotated[StrictFloat, Field(gt=0)],
1928
+ Tuple[
1929
+ Annotated[StrictFloat, Field(gt=0)],
1930
+ Annotated[StrictFloat, Field(gt=0)]
1931
+ ]
1932
+ ] = None,
1933
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1934
+ _content_type: Optional[StrictStr] = None,
1935
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1936
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1937
+ ) -> ApiResponse[EndpointStatus]:
1938
+ """Returns the status of the specified inbound integration endpoint
1939
+
1940
+ Operation for retrieving status information for a specific inbound integration endpoint
1941
+
1942
+ :param id: ID of the inbound integration endpoint for which to retrieve the status (required)
1943
+ :type id: str
1944
+ :param context: ID of the context in which to perform the operation (required)
1945
+ :type context: str
1946
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
1947
+ :type workspace: str
1948
+ :param _request_timeout: timeout setting for this request. If one
1949
+ number provided, it will be total request
1950
+ timeout. It can also be a pair (tuple) of
1951
+ (connection, read) timeouts.
1952
+ :type _request_timeout: int, tuple(int, int), optional
1953
+ :param _request_auth: set to override the auth_settings for an a single
1954
+ request; this effectively ignores the
1955
+ authentication in the spec for a single request.
1956
+ :type _request_auth: dict, optional
1957
+ :param _content_type: force content-type for the request.
1958
+ :type _content_type: str, Optional
1959
+ :param _headers: set to override the headers for a single
1960
+ request; this effectively ignores the headers
1961
+ in the spec for a single request.
1962
+ :type _headers: dict, optional
1963
+ :param _host_index: set to override the host_index for a single
1964
+ request; this effectively ignores the host_index
1965
+ in the spec for a single request.
1966
+ :type _host_index: int, optional
1967
+ :return: Returns the result object.
1968
+ """ # noqa: E501
1969
+
1970
+ _param = self._inbound_integration_endpoints_id_status_get_serialize(
1971
+ id=id,
1972
+ context=context,
1973
+ workspace=workspace,
1974
+ _request_auth=_request_auth,
1975
+ _content_type=_content_type,
1976
+ _headers=_headers,
1977
+ _host_index=_host_index
1978
+ )
1979
+
1980
+ _response_types_map: Dict[str, Optional[str]] = {
1981
+ '200': "EndpointStatus",
1982
+ '400': "Error",
1983
+ '404': "Error",
1984
+ }
1985
+ response_data = self.api_client.call_api(
1986
+ *_param,
1987
+ _request_timeout=_request_timeout
1988
+ )
1989
+ response_data.read()
1990
+ return self.api_client.response_deserialize(
1991
+ response_data=response_data,
1992
+ response_types_map=_response_types_map,
1993
+ )
1994
+
1995
+
1996
+ @validate_call
1997
+ def inbound_integration_endpoints_id_status_get_without_preload_content(
1998
+ self,
1999
+ id: Annotated[StrictStr, Field(description="ID of the inbound integration endpoint for which to retrieve the status")],
2000
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
2001
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
2002
+ _request_timeout: Union[
2003
+ None,
2004
+ Annotated[StrictFloat, Field(gt=0)],
2005
+ Tuple[
2006
+ Annotated[StrictFloat, Field(gt=0)],
2007
+ Annotated[StrictFloat, Field(gt=0)]
2008
+ ]
2009
+ ] = None,
2010
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2011
+ _content_type: Optional[StrictStr] = None,
2012
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2013
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2014
+ ) -> RESTResponseType:
2015
+ """Returns the status of the specified inbound integration endpoint
2016
+
2017
+ Operation for retrieving status information for a specific inbound integration endpoint
2018
+
2019
+ :param id: ID of the inbound integration endpoint for which to retrieve the status (required)
2020
+ :type id: str
2021
+ :param context: ID of the context in which to perform the operation (required)
2022
+ :type context: str
2023
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
2024
+ :type workspace: str
2025
+ :param _request_timeout: timeout setting for this request. If one
2026
+ number provided, it will be total request
2027
+ timeout. It can also be a pair (tuple) of
2028
+ (connection, read) timeouts.
2029
+ :type _request_timeout: int, tuple(int, int), optional
2030
+ :param _request_auth: set to override the auth_settings for an a single
2031
+ request; this effectively ignores the
2032
+ authentication in the spec for a single request.
2033
+ :type _request_auth: dict, optional
2034
+ :param _content_type: force content-type for the request.
2035
+ :type _content_type: str, Optional
2036
+ :param _headers: set to override the headers for a single
2037
+ request; this effectively ignores the headers
2038
+ in the spec for a single request.
2039
+ :type _headers: dict, optional
2040
+ :param _host_index: set to override the host_index for a single
2041
+ request; this effectively ignores the host_index
2042
+ in the spec for a single request.
2043
+ :type _host_index: int, optional
2044
+ :return: Returns the result object.
2045
+ """ # noqa: E501
2046
+
2047
+ _param = self._inbound_integration_endpoints_id_status_get_serialize(
2048
+ id=id,
2049
+ context=context,
2050
+ workspace=workspace,
2051
+ _request_auth=_request_auth,
2052
+ _content_type=_content_type,
2053
+ _headers=_headers,
2054
+ _host_index=_host_index
2055
+ )
2056
+
2057
+ _response_types_map: Dict[str, Optional[str]] = {
2058
+ '200': "EndpointStatus",
2059
+ '400': "Error",
2060
+ '404': "Error",
2061
+ }
2062
+ response_data = self.api_client.call_api(
2063
+ *_param,
2064
+ _request_timeout=_request_timeout
2065
+ )
2066
+ return response_data.response
2067
+
2068
+
2069
+ def _inbound_integration_endpoints_id_status_get_serialize(
2070
+ self,
2071
+ id,
2072
+ context,
2073
+ workspace,
2074
+ _request_auth,
2075
+ _content_type,
2076
+ _headers,
2077
+ _host_index,
2078
+ ) -> RequestSerialized:
2079
+
2080
+ _host = None
2081
+
2082
+ _collection_formats: Dict[str, str] = {
2083
+ }
2084
+
2085
+ _path_params: Dict[str, str] = {}
2086
+ _query_params: List[Tuple[str, str]] = []
2087
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2088
+ _form_params: List[Tuple[str, str]] = []
2089
+ _files: Dict[
2090
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2091
+ ] = {}
2092
+ _body_params: Optional[bytes] = None
2093
+
2094
+ # process the path parameters
2095
+ if id is not None:
2096
+ _path_params['id'] = id
2097
+ # process the query parameters
2098
+ if context is not None:
2099
+
2100
+ _query_params.append(('context', context))
2101
+
2102
+ if workspace is not None:
2103
+
2104
+ _query_params.append(('workspace', workspace))
2105
+
2106
+ # process the header parameters
2107
+ # process the form parameters
2108
+ # process the body parameter
2109
+
2110
+
2111
+ # set the HTTP header `Accept`
2112
+ if 'Accept' not in _header_params:
2113
+ _header_params['Accept'] = self.api_client.select_header_accept(
2114
+ [
2115
+ 'application/json'
2116
+ ]
2117
+ )
2118
+
2119
+
2120
+ # authentication setting
2121
+ _auth_settings: List[str] = [
2122
+ 'basicAuth'
2123
+ ]
2124
+
2125
+ return self.api_client.param_serialize(
2126
+ method='GET',
2127
+ resource_path='/inbound-integration-endpoints/{id}/status',
2128
+ path_params=_path_params,
2129
+ query_params=_query_params,
2130
+ header_params=_header_params,
2131
+ body=_body_params,
2132
+ post_params=_form_params,
2133
+ files=_files,
2134
+ auth_settings=_auth_settings,
2135
+ collection_formats=_collection_formats,
2136
+ _host=_host,
2137
+ _request_auth=_request_auth
2138
+ )
2139
+
2140
+
2141
+
2142
+
2143
+ @validate_call
2144
+ def inbound_integration_endpoints_id_upload_and_invoke_post(
2145
+ self,
2146
+ id: Annotated[StrictStr, Field(description="ID of the inbound integration endpoint")],
2147
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
2148
+ file_name: Annotated[Optional[StrictStr], Field(description="Optional file name (including extension) for the supplied binary data")] = None,
2149
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
2150
+ body: Optional[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]] = None,
2151
+ _request_timeout: Union[
2152
+ None,
2153
+ Annotated[StrictFloat, Field(gt=0)],
2154
+ Tuple[
2155
+ Annotated[StrictFloat, Field(gt=0)],
2156
+ Annotated[StrictFloat, Field(gt=0)]
2157
+ ]
2158
+ ] = None,
2159
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2160
+ _content_type: Optional[StrictStr] = None,
2161
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2162
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2163
+ ) -> None:
2164
+ """Posts message/file to endpoint with REST receiver
2165
+
2166
+ Operation for posting a message/file to an inbound integration endpoint with a configured REST receiver and invoking the endpoint. A 400 response is returned if the endpoint does not have a REST-enabled receiver plugin or if the endpoint is not enabled.
2167
+
2168
+ :param id: ID of the inbound integration endpoint (required)
2169
+ :type id: str
2170
+ :param context: ID of the context in which to perform the operation (required)
2171
+ :type context: str
2172
+ :param file_name: Optional file name (including extension) for the supplied binary data
2173
+ :type file_name: str
2174
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
2175
+ :type workspace: str
2176
+ :param body:
2177
+ :type body: bytearray
2178
+ :param _request_timeout: timeout setting for this request. If one
2179
+ number provided, it will be total request
2180
+ timeout. It can also be a pair (tuple) of
2181
+ (connection, read) timeouts.
2182
+ :type _request_timeout: int, tuple(int, int), optional
2183
+ :param _request_auth: set to override the auth_settings for an a single
2184
+ request; this effectively ignores the
2185
+ authentication in the spec for a single request.
2186
+ :type _request_auth: dict, optional
2187
+ :param _content_type: force content-type for the request.
2188
+ :type _content_type: str, Optional
2189
+ :param _headers: set to override the headers for a single
2190
+ request; this effectively ignores the headers
2191
+ in the spec for a single request.
2192
+ :type _headers: dict, optional
2193
+ :param _host_index: set to override the host_index for a single
2194
+ request; this effectively ignores the host_index
2195
+ in the spec for a single request.
2196
+ :type _host_index: int, optional
2197
+ :return: Returns the result object.
2198
+ """ # noqa: E501
2199
+
2200
+ _param = self._inbound_integration_endpoints_id_upload_and_invoke_post_serialize(
2201
+ id=id,
2202
+ context=context,
2203
+ file_name=file_name,
2204
+ workspace=workspace,
2205
+ body=body,
2206
+ _request_auth=_request_auth,
2207
+ _content_type=_content_type,
2208
+ _headers=_headers,
2209
+ _host_index=_host_index
2210
+ )
2211
+
2212
+ _response_types_map: Dict[str, Optional[str]] = {
2213
+ '200': None,
2214
+ '400': "Error",
2215
+ '404': "Error",
2216
+ '503': "Error",
2217
+ }
2218
+ response_data = self.api_client.call_api(
2219
+ *_param,
2220
+ _request_timeout=_request_timeout
2221
+ )
2222
+ response_data.read()
2223
+ return self.api_client.response_deserialize(
2224
+ response_data=response_data,
2225
+ response_types_map=_response_types_map,
2226
+ ).data
2227
+
2228
+
2229
+ @validate_call
2230
+ def inbound_integration_endpoints_id_upload_and_invoke_post_with_http_info(
2231
+ self,
2232
+ id: Annotated[StrictStr, Field(description="ID of the inbound integration endpoint")],
2233
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
2234
+ file_name: Annotated[Optional[StrictStr], Field(description="Optional file name (including extension) for the supplied binary data")] = None,
2235
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
2236
+ body: Optional[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]] = None,
2237
+ _request_timeout: Union[
2238
+ None,
2239
+ Annotated[StrictFloat, Field(gt=0)],
2240
+ Tuple[
2241
+ Annotated[StrictFloat, Field(gt=0)],
2242
+ Annotated[StrictFloat, Field(gt=0)]
2243
+ ]
2244
+ ] = None,
2245
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2246
+ _content_type: Optional[StrictStr] = None,
2247
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2248
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2249
+ ) -> ApiResponse[None]:
2250
+ """Posts message/file to endpoint with REST receiver
2251
+
2252
+ Operation for posting a message/file to an inbound integration endpoint with a configured REST receiver and invoking the endpoint. A 400 response is returned if the endpoint does not have a REST-enabled receiver plugin or if the endpoint is not enabled.
2253
+
2254
+ :param id: ID of the inbound integration endpoint (required)
2255
+ :type id: str
2256
+ :param context: ID of the context in which to perform the operation (required)
2257
+ :type context: str
2258
+ :param file_name: Optional file name (including extension) for the supplied binary data
2259
+ :type file_name: str
2260
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
2261
+ :type workspace: str
2262
+ :param body:
2263
+ :type body: bytearray
2264
+ :param _request_timeout: timeout setting for this request. If one
2265
+ number provided, it will be total request
2266
+ timeout. It can also be a pair (tuple) of
2267
+ (connection, read) timeouts.
2268
+ :type _request_timeout: int, tuple(int, int), optional
2269
+ :param _request_auth: set to override the auth_settings for an a single
2270
+ request; this effectively ignores the
2271
+ authentication in the spec for a single request.
2272
+ :type _request_auth: dict, optional
2273
+ :param _content_type: force content-type for the request.
2274
+ :type _content_type: str, Optional
2275
+ :param _headers: set to override the headers for a single
2276
+ request; this effectively ignores the headers
2277
+ in the spec for a single request.
2278
+ :type _headers: dict, optional
2279
+ :param _host_index: set to override the host_index for a single
2280
+ request; this effectively ignores the host_index
2281
+ in the spec for a single request.
2282
+ :type _host_index: int, optional
2283
+ :return: Returns the result object.
2284
+ """ # noqa: E501
2285
+
2286
+ _param = self._inbound_integration_endpoints_id_upload_and_invoke_post_serialize(
2287
+ id=id,
2288
+ context=context,
2289
+ file_name=file_name,
2290
+ workspace=workspace,
2291
+ body=body,
2292
+ _request_auth=_request_auth,
2293
+ _content_type=_content_type,
2294
+ _headers=_headers,
2295
+ _host_index=_host_index
2296
+ )
2297
+
2298
+ _response_types_map: Dict[str, Optional[str]] = {
2299
+ '200': None,
2300
+ '400': "Error",
2301
+ '404': "Error",
2302
+ '503': "Error",
2303
+ }
2304
+ response_data = self.api_client.call_api(
2305
+ *_param,
2306
+ _request_timeout=_request_timeout
2307
+ )
2308
+ response_data.read()
2309
+ return self.api_client.response_deserialize(
2310
+ response_data=response_data,
2311
+ response_types_map=_response_types_map,
2312
+ )
2313
+
2314
+
2315
+ @validate_call
2316
+ def inbound_integration_endpoints_id_upload_and_invoke_post_without_preload_content(
2317
+ self,
2318
+ id: Annotated[StrictStr, Field(description="ID of the inbound integration endpoint")],
2319
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
2320
+ file_name: Annotated[Optional[StrictStr], Field(description="Optional file name (including extension) for the supplied binary data")] = None,
2321
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
2322
+ body: Optional[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]] = None,
2323
+ _request_timeout: Union[
2324
+ None,
2325
+ Annotated[StrictFloat, Field(gt=0)],
2326
+ Tuple[
2327
+ Annotated[StrictFloat, Field(gt=0)],
2328
+ Annotated[StrictFloat, Field(gt=0)]
2329
+ ]
2330
+ ] = None,
2331
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2332
+ _content_type: Optional[StrictStr] = None,
2333
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2334
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2335
+ ) -> RESTResponseType:
2336
+ """Posts message/file to endpoint with REST receiver
2337
+
2338
+ Operation for posting a message/file to an inbound integration endpoint with a configured REST receiver and invoking the endpoint. A 400 response is returned if the endpoint does not have a REST-enabled receiver plugin or if the endpoint is not enabled.
2339
+
2340
+ :param id: ID of the inbound integration endpoint (required)
2341
+ :type id: str
2342
+ :param context: ID of the context in which to perform the operation (required)
2343
+ :type context: str
2344
+ :param file_name: Optional file name (including extension) for the supplied binary data
2345
+ :type file_name: str
2346
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
2347
+ :type workspace: str
2348
+ :param body:
2349
+ :type body: bytearray
2350
+ :param _request_timeout: timeout setting for this request. If one
2351
+ number provided, it will be total request
2352
+ timeout. It can also be a pair (tuple) of
2353
+ (connection, read) timeouts.
2354
+ :type _request_timeout: int, tuple(int, int), optional
2355
+ :param _request_auth: set to override the auth_settings for an a single
2356
+ request; this effectively ignores the
2357
+ authentication in the spec for a single request.
2358
+ :type _request_auth: dict, optional
2359
+ :param _content_type: force content-type for the request.
2360
+ :type _content_type: str, Optional
2361
+ :param _headers: set to override the headers for a single
2362
+ request; this effectively ignores the headers
2363
+ in the spec for a single request.
2364
+ :type _headers: dict, optional
2365
+ :param _host_index: set to override the host_index for a single
2366
+ request; this effectively ignores the host_index
2367
+ in the spec for a single request.
2368
+ :type _host_index: int, optional
2369
+ :return: Returns the result object.
2370
+ """ # noqa: E501
2371
+
2372
+ _param = self._inbound_integration_endpoints_id_upload_and_invoke_post_serialize(
2373
+ id=id,
2374
+ context=context,
2375
+ file_name=file_name,
2376
+ workspace=workspace,
2377
+ body=body,
2378
+ _request_auth=_request_auth,
2379
+ _content_type=_content_type,
2380
+ _headers=_headers,
2381
+ _host_index=_host_index
2382
+ )
2383
+
2384
+ _response_types_map: Dict[str, Optional[str]] = {
2385
+ '200': None,
2386
+ '400': "Error",
2387
+ '404': "Error",
2388
+ '503': "Error",
2389
+ }
2390
+ response_data = self.api_client.call_api(
2391
+ *_param,
2392
+ _request_timeout=_request_timeout
2393
+ )
2394
+ return response_data.response
2395
+
2396
+
2397
+ def _inbound_integration_endpoints_id_upload_and_invoke_post_serialize(
2398
+ self,
2399
+ id,
2400
+ context,
2401
+ file_name,
2402
+ workspace,
2403
+ body,
2404
+ _request_auth,
2405
+ _content_type,
2406
+ _headers,
2407
+ _host_index,
2408
+ ) -> RequestSerialized:
2409
+
2410
+ _host = None
2411
+
2412
+ _collection_formats: Dict[str, str] = {
2413
+ }
2414
+
2415
+ _path_params: Dict[str, str] = {}
2416
+ _query_params: List[Tuple[str, str]] = []
2417
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2418
+ _form_params: List[Tuple[str, str]] = []
2419
+ _files: Dict[
2420
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2421
+ ] = {}
2422
+ _body_params: Optional[bytes] = None
2423
+
2424
+ # process the path parameters
2425
+ if id is not None:
2426
+ _path_params['id'] = id
2427
+ # process the query parameters
2428
+ if file_name is not None:
2429
+
2430
+ _query_params.append(('fileName', file_name))
2431
+
2432
+ if context is not None:
2433
+
2434
+ _query_params.append(('context', context))
2435
+
2436
+ if workspace is not None:
2437
+
2438
+ _query_params.append(('workspace', workspace))
2439
+
2440
+ # process the header parameters
2441
+ # process the form parameters
2442
+ # process the body parameter
2443
+ if body is not None:
2444
+ # convert to byte array if the input is a file name (str)
2445
+ if isinstance(body, str):
2446
+ with open(body, "rb") as _fp:
2447
+ _body_params = _fp.read()
2448
+ elif isinstance(body, tuple):
2449
+ # drop the filename from the tuple
2450
+ _body_params = body[1]
2451
+ else:
2452
+ _body_params = body
2453
+
2454
+
2455
+ # set the HTTP header `Accept`
2456
+ if 'Accept' not in _header_params:
2457
+ _header_params['Accept'] = self.api_client.select_header_accept(
2458
+ [
2459
+ 'application/json'
2460
+ ]
2461
+ )
2462
+
2463
+ # set the HTTP header `Content-Type`
2464
+ if _content_type:
2465
+ _header_params['Content-Type'] = _content_type
2466
+ else:
2467
+ _default_content_type = (
2468
+ self.api_client.select_header_content_type(
2469
+ [
2470
+ 'application/octet-stream'
2471
+ ]
2472
+ )
2473
+ )
2474
+ if _default_content_type is not None:
2475
+ _header_params['Content-Type'] = _default_content_type
2476
+
2477
+ # authentication setting
2478
+ _auth_settings: List[str] = [
2479
+ 'basicAuth'
2480
+ ]
2481
+
2482
+ return self.api_client.param_serialize(
2483
+ method='POST',
2484
+ resource_path='/inbound-integration-endpoints/{id}/upload-and-invoke',
2485
+ path_params=_path_params,
2486
+ query_params=_query_params,
2487
+ header_params=_header_params,
2488
+ body=_body_params,
2489
+ post_params=_form_params,
2490
+ files=_files,
2491
+ auth_settings=_auth_settings,
2492
+ collection_formats=_collection_formats,
2493
+ _host=_host,
2494
+ _request_auth=_request_auth
2495
+ )
2496
+
2497
+
2498
+
2499
+
2500
+ @validate_call
2501
+ def inbound_integration_endpoints_id_worker_processes_get(
2502
+ self,
2503
+ id: Annotated[StrictStr, Field(description="ID of the inbound integration endpoint for which to retrieve processes")],
2504
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
2505
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
2506
+ status: Annotated[Optional[StrictStr], Field(description="Background process status filter")] = None,
2507
+ _request_timeout: Union[
2508
+ None,
2509
+ Annotated[StrictFloat, Field(gt=0)],
2510
+ Tuple[
2511
+ Annotated[StrictFloat, Field(gt=0)],
2512
+ Annotated[StrictFloat, Field(gt=0)]
2513
+ ]
2514
+ ] = None,
2515
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2516
+ _content_type: Optional[StrictStr] = None,
2517
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2518
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2519
+ ) -> List[str]:
2520
+ """Returns background process IDs for processes started by the endpoint
2521
+
2522
+ Operation for retrieving background process IDs for processes started by the endpoint. Can be filtered on process status.
2523
+
2524
+ :param id: ID of the inbound integration endpoint for which to retrieve processes (required)
2525
+ :type id: str
2526
+ :param context: ID of the context in which to perform the operation (required)
2527
+ :type context: str
2528
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
2529
+ :type workspace: str
2530
+ :param status: Background process status filter
2531
+ :type status: str
2532
+ :param _request_timeout: timeout setting for this request. If one
2533
+ number provided, it will be total request
2534
+ timeout. It can also be a pair (tuple) of
2535
+ (connection, read) timeouts.
2536
+ :type _request_timeout: int, tuple(int, int), optional
2537
+ :param _request_auth: set to override the auth_settings for an a single
2538
+ request; this effectively ignores the
2539
+ authentication in the spec for a single request.
2540
+ :type _request_auth: dict, optional
2541
+ :param _content_type: force content-type for the request.
2542
+ :type _content_type: str, Optional
2543
+ :param _headers: set to override the headers for a single
2544
+ request; this effectively ignores the headers
2545
+ in the spec for a single request.
2546
+ :type _headers: dict, optional
2547
+ :param _host_index: set to override the host_index for a single
2548
+ request; this effectively ignores the host_index
2549
+ in the spec for a single request.
2550
+ :type _host_index: int, optional
2551
+ :return: Returns the result object.
2552
+ """ # noqa: E501
2553
+
2554
+ _param = self._inbound_integration_endpoints_id_worker_processes_get_serialize(
2555
+ id=id,
2556
+ context=context,
2557
+ workspace=workspace,
2558
+ status=status,
2559
+ _request_auth=_request_auth,
2560
+ _content_type=_content_type,
2561
+ _headers=_headers,
2562
+ _host_index=_host_index
2563
+ )
2564
+
2565
+ _response_types_map: Dict[str, Optional[str]] = {
2566
+ '200': "List[str]",
2567
+ '400': "Error",
2568
+ '404': "Error",
2569
+ }
2570
+ response_data = self.api_client.call_api(
2571
+ *_param,
2572
+ _request_timeout=_request_timeout
2573
+ )
2574
+ response_data.read()
2575
+ return self.api_client.response_deserialize(
2576
+ response_data=response_data,
2577
+ response_types_map=_response_types_map,
2578
+ ).data
2579
+
2580
+
2581
+ @validate_call
2582
+ def inbound_integration_endpoints_id_worker_processes_get_with_http_info(
2583
+ self,
2584
+ id: Annotated[StrictStr, Field(description="ID of the inbound integration endpoint for which to retrieve processes")],
2585
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
2586
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
2587
+ status: Annotated[Optional[StrictStr], Field(description="Background process status filter")] = None,
2588
+ _request_timeout: Union[
2589
+ None,
2590
+ Annotated[StrictFloat, Field(gt=0)],
2591
+ Tuple[
2592
+ Annotated[StrictFloat, Field(gt=0)],
2593
+ Annotated[StrictFloat, Field(gt=0)]
2594
+ ]
2595
+ ] = None,
2596
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2597
+ _content_type: Optional[StrictStr] = None,
2598
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2599
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2600
+ ) -> ApiResponse[List[str]]:
2601
+ """Returns background process IDs for processes started by the endpoint
2602
+
2603
+ Operation for retrieving background process IDs for processes started by the endpoint. Can be filtered on process status.
2604
+
2605
+ :param id: ID of the inbound integration endpoint for which to retrieve processes (required)
2606
+ :type id: str
2607
+ :param context: ID of the context in which to perform the operation (required)
2608
+ :type context: str
2609
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
2610
+ :type workspace: str
2611
+ :param status: Background process status filter
2612
+ :type status: str
2613
+ :param _request_timeout: timeout setting for this request. If one
2614
+ number provided, it will be total request
2615
+ timeout. It can also be a pair (tuple) of
2616
+ (connection, read) timeouts.
2617
+ :type _request_timeout: int, tuple(int, int), optional
2618
+ :param _request_auth: set to override the auth_settings for an a single
2619
+ request; this effectively ignores the
2620
+ authentication in the spec for a single request.
2621
+ :type _request_auth: dict, optional
2622
+ :param _content_type: force content-type for the request.
2623
+ :type _content_type: str, Optional
2624
+ :param _headers: set to override the headers for a single
2625
+ request; this effectively ignores the headers
2626
+ in the spec for a single request.
2627
+ :type _headers: dict, optional
2628
+ :param _host_index: set to override the host_index for a single
2629
+ request; this effectively ignores the host_index
2630
+ in the spec for a single request.
2631
+ :type _host_index: int, optional
2632
+ :return: Returns the result object.
2633
+ """ # noqa: E501
2634
+
2635
+ _param = self._inbound_integration_endpoints_id_worker_processes_get_serialize(
2636
+ id=id,
2637
+ context=context,
2638
+ workspace=workspace,
2639
+ status=status,
2640
+ _request_auth=_request_auth,
2641
+ _content_type=_content_type,
2642
+ _headers=_headers,
2643
+ _host_index=_host_index
2644
+ )
2645
+
2646
+ _response_types_map: Dict[str, Optional[str]] = {
2647
+ '200': "List[str]",
2648
+ '400': "Error",
2649
+ '404': "Error",
2650
+ }
2651
+ response_data = self.api_client.call_api(
2652
+ *_param,
2653
+ _request_timeout=_request_timeout
2654
+ )
2655
+ response_data.read()
2656
+ return self.api_client.response_deserialize(
2657
+ response_data=response_data,
2658
+ response_types_map=_response_types_map,
2659
+ )
2660
+
2661
+
2662
+ @validate_call
2663
+ def inbound_integration_endpoints_id_worker_processes_get_without_preload_content(
2664
+ self,
2665
+ id: Annotated[StrictStr, Field(description="ID of the inbound integration endpoint for which to retrieve processes")],
2666
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
2667
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
2668
+ status: Annotated[Optional[StrictStr], Field(description="Background process status filter")] = None,
2669
+ _request_timeout: Union[
2670
+ None,
2671
+ Annotated[StrictFloat, Field(gt=0)],
2672
+ Tuple[
2673
+ Annotated[StrictFloat, Field(gt=0)],
2674
+ Annotated[StrictFloat, Field(gt=0)]
2675
+ ]
2676
+ ] = None,
2677
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2678
+ _content_type: Optional[StrictStr] = None,
2679
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2680
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2681
+ ) -> RESTResponseType:
2682
+ """Returns background process IDs for processes started by the endpoint
2683
+
2684
+ Operation for retrieving background process IDs for processes started by the endpoint. Can be filtered on process status.
2685
+
2686
+ :param id: ID of the inbound integration endpoint for which to retrieve processes (required)
2687
+ :type id: str
2688
+ :param context: ID of the context in which to perform the operation (required)
2689
+ :type context: str
2690
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
2691
+ :type workspace: str
2692
+ :param status: Background process status filter
2693
+ :type status: str
2694
+ :param _request_timeout: timeout setting for this request. If one
2695
+ number provided, it will be total request
2696
+ timeout. It can also be a pair (tuple) of
2697
+ (connection, read) timeouts.
2698
+ :type _request_timeout: int, tuple(int, int), optional
2699
+ :param _request_auth: set to override the auth_settings for an a single
2700
+ request; this effectively ignores the
2701
+ authentication in the spec for a single request.
2702
+ :type _request_auth: dict, optional
2703
+ :param _content_type: force content-type for the request.
2704
+ :type _content_type: str, Optional
2705
+ :param _headers: set to override the headers for a single
2706
+ request; this effectively ignores the headers
2707
+ in the spec for a single request.
2708
+ :type _headers: dict, optional
2709
+ :param _host_index: set to override the host_index for a single
2710
+ request; this effectively ignores the host_index
2711
+ in the spec for a single request.
2712
+ :type _host_index: int, optional
2713
+ :return: Returns the result object.
2714
+ """ # noqa: E501
2715
+
2716
+ _param = self._inbound_integration_endpoints_id_worker_processes_get_serialize(
2717
+ id=id,
2718
+ context=context,
2719
+ workspace=workspace,
2720
+ status=status,
2721
+ _request_auth=_request_auth,
2722
+ _content_type=_content_type,
2723
+ _headers=_headers,
2724
+ _host_index=_host_index
2725
+ )
2726
+
2727
+ _response_types_map: Dict[str, Optional[str]] = {
2728
+ '200': "List[str]",
2729
+ '400': "Error",
2730
+ '404': "Error",
2731
+ }
2732
+ response_data = self.api_client.call_api(
2733
+ *_param,
2734
+ _request_timeout=_request_timeout
2735
+ )
2736
+ return response_data.response
2737
+
2738
+
2739
+ def _inbound_integration_endpoints_id_worker_processes_get_serialize(
2740
+ self,
2741
+ id,
2742
+ context,
2743
+ workspace,
2744
+ status,
2745
+ _request_auth,
2746
+ _content_type,
2747
+ _headers,
2748
+ _host_index,
2749
+ ) -> RequestSerialized:
2750
+
2751
+ _host = None
2752
+
2753
+ _collection_formats: Dict[str, str] = {
2754
+ }
2755
+
2756
+ _path_params: Dict[str, str] = {}
2757
+ _query_params: List[Tuple[str, str]] = []
2758
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2759
+ _form_params: List[Tuple[str, str]] = []
2760
+ _files: Dict[
2761
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2762
+ ] = {}
2763
+ _body_params: Optional[bytes] = None
2764
+
2765
+ # process the path parameters
2766
+ if id is not None:
2767
+ _path_params['id'] = id
2768
+ # process the query parameters
2769
+ if context is not None:
2770
+
2771
+ _query_params.append(('context', context))
2772
+
2773
+ if workspace is not None:
2774
+
2775
+ _query_params.append(('workspace', workspace))
2776
+
2777
+ if status is not None:
2778
+
2779
+ _query_params.append(('status', status))
2780
+
2781
+ # process the header parameters
2782
+ # process the form parameters
2783
+ # process the body parameter
2784
+
2785
+
2786
+ # set the HTTP header `Accept`
2787
+ if 'Accept' not in _header_params:
2788
+ _header_params['Accept'] = self.api_client.select_header_accept(
2789
+ [
2790
+ 'application/json'
2791
+ ]
2792
+ )
2793
+
2794
+
2795
+ # authentication setting
2796
+ _auth_settings: List[str] = [
2797
+ 'basicAuth'
2798
+ ]
2799
+
2800
+ return self.api_client.param_serialize(
2801
+ method='GET',
2802
+ resource_path='/inbound-integration-endpoints/{id}/worker-processes',
2803
+ path_params=_path_params,
2804
+ query_params=_query_params,
2805
+ header_params=_header_params,
2806
+ body=_body_params,
2807
+ post_params=_form_params,
2808
+ files=_files,
2809
+ auth_settings=_auth_settings,
2810
+ collection_formats=_collection_formats,
2811
+ _host=_host,
2812
+ _request_auth=_request_auth
2813
+ )
2814
+
2815
+