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,3655 @@
1
+ # coding: utf-8
2
+
3
+ """
4
+ STEP REST API V2
5
+
6
+ <h1>About</h1><p>The STEP REST API V2 provides read and write access to a set of core STEP objects using the HTTP operations GET, PUT, POST, PATCH and DELETE.</p><h1>Resource Representation</h1><p>With the exception of a few resource operations for retrieving and uploading binary data, all request and response bodies are JSON, compliant with the schema documented here.</p><h1>Context and Workspace</h1><p>All requests are handled in a specific STEP context and workspace and both can be specified via query parameters available for all resource operations. A context must always be specified while requests per default will be handled in the &quot;Main&quot; workspace.</p><h1>Polymorphism</h1><p>In STEP, attributes, reference types and data container types can all be either single- or multivalued. The STEP REST API V2 uses polymorphism to address this complexity with resources that include values, references and data containers specified to produce and consume a common &quot;abstract&quot; supertype that always will be one of either the single- or multivalued subtype.<br/>As an example, the GET /entities/{id}/values/{attributeId} resource operation is specified to return a &quot;Value&quot; but as evident from the model, the &quot;Value&quot; will always be &quot;oneOf&quot; either &quot;SingleValue&quot;, that has a &quot;value&quot; property for which the value is an object, or &quot;MultiValue&quot;, that has a &quot;values&quot; property for which the value is an array.<br/>Clients are advised to use the presence or absence of the plural array property (&quot;values&quot;, &quot;references&quot; and &quot;dataContainers&quot;) to determine the concrete type.</p><h1>Authentication</h1><p>The REST API is protected by HTTP Basic Authentication or if OAuth2-based authentication is enabled (SaaS customers only), by Bearer Authentication. With Basic Authentication, user name and password are supplied with each request and it is therefore highly recommended to only use the API in conjunction with HTTPS. For more information about OAuth2-based authentication for SaaS customers, please see the STEP Authentication Guide.</p><h1>Versioning</h1><p>The STEP REST API V2 is versioned using semantic versioning. Stibo Systems reserve the right to make non-breaking, minor / patch changes in any release without warning and clients must be coded / configured to be 'tolerant' and capable of handling such changes.</p><p>Examples of breaking, major changes:</p><ul><li>Renaming of a property</li><li>Removal of a property</li><li>Property type change</li><li>Addition of new property required for write operations</li><li>Marking existing property as required for write operations</li><li>Removal of resource or resource operation</li><li>Materially different behavior for existing resource operation</li></ul><p>Examples of non-breaking, minor / patch changes:</p><ul><li>Addition of new properties in request responses</li><li>Addition of new query parameter not required for write operations</li><li>Addition of new resource or resource operation</li><li>Bug fixes that do not change the schema or resource operations as described here</li><li>Inclusion of a response body for resource operations specified to return a 200 response with no body</li><li>Change of response &quot;Model&quot; / &quot;schema&quot; to type extending the previously specified type</li><li>Renaming a &quot;Model&quot; / &quot;schema&quot; type</li></ul><p>In addition, error message texts may change without warning within the same version. Client program logic should not depend upon the message content.</p><h1>Error Handling</h1><p>The STEP REST API V2 responds with standard HTTP status codes, with 2** responses indicating a success, 4** responses indicating a client error and 5** indicating a server error. Notice that this specification does not specify common error responses like 500 (internal server error) or 401 (unauthorized) for the individual resource operations. Clients should however be capable of handling such responses.</p><p>Error responses have a JSON response body (see Error schema below) containing HTTP status code information in addition to a message providing details about the error. As mentioned above, client program logic should not depend upon the message content.</p><p>The specific status codes used in the API are:</p><ul><li>200 (OK): Success, response may or may not have a body</li><li>201 (Created): Entity successfully created, response may or may not have a body</li><li>400 (Bad request): The server cannot or will not process the request due to an apparent client error</li><li>401 (Unauthorized): Returned only in relation to failed authentication</li><li>404 (Not Found): Returned only in relation to objects specified via path parameters (variable parts of the URL). If STEP objects referenced in request bodies or via query parameters cannot be found, the response will be 400.</li><li>429 (Too Many Requests): Clients are per default limited to 100 requests per second. Returned if the rate limit is exceeded.</li><li>500 (Internal Server Error): Unexpected error (could potentially cover an issue that rightfully should be a 400)</li></ul>
7
+
8
+ The version of the OpenAPI document: 1.3.0
9
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
10
+
11
+ Do not edit the class manually.
12
+ """ # noqa: E501
13
+
14
+ import warnings
15
+ from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
16
+ from typing import Any, Dict, List, Optional, Tuple, Union
17
+ from typing_extensions import Annotated
18
+
19
+ from pydantic import Field, StrictStr, field_validator
20
+ from typing import List, Optional
21
+ from typing_extensions import Annotated
22
+ from step_rest_client.models.amount import Amount
23
+ from step_rest_client.models.endpoint_statistics import EndpointStatistics
24
+ from step_rest_client.models.endpoint_status import EndpointStatus
25
+ from step_rest_client.models.event_queue_status import EventQueueStatus
26
+ from step_rest_client.models.execution_report_entry import ExecutionReportEntry
27
+ from step_rest_client.models.outbound_integration_endpoint import OutboundIntegrationEndpoint
28
+
29
+ from step_rest_client.api_client import ApiClient, RequestSerialized
30
+ from step_rest_client.api_response import ApiResponse
31
+ from step_rest_client.rest import RESTResponseType
32
+
33
+
34
+ class OutboundIntegrationEndpointsApi:
35
+ """NOTE: This class is auto generated by OpenAPI Generator
36
+ Ref: https://openapi-generator.tech
37
+
38
+ Do not edit the class manually.
39
+ """
40
+
41
+ def __init__(self, api_client=None) -> None:
42
+ if api_client is None:
43
+ api_client = ApiClient.get_default()
44
+ self.api_client = api_client
45
+
46
+
47
+ @validate_call
48
+ def outbound_integration_endpoints_get(
49
+ self,
50
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
51
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
52
+ _request_timeout: Union[
53
+ None,
54
+ Annotated[StrictFloat, Field(gt=0)],
55
+ Tuple[
56
+ Annotated[StrictFloat, Field(gt=0)],
57
+ Annotated[StrictFloat, Field(gt=0)]
58
+ ]
59
+ ] = None,
60
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
61
+ _content_type: Optional[StrictStr] = None,
62
+ _headers: Optional[Dict[StrictStr, Any]] = None,
63
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
64
+ ) -> List[OutboundIntegrationEndpoint]:
65
+ """Returns basic outbound integration endpoint representations
66
+
67
+ Operation for retrieving an array of basic outbound integration endpoint representations for all accessible endpoints
68
+
69
+ :param context: ID of the context in which to perform the operation (required)
70
+ :type context: str
71
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
72
+ :type workspace: str
73
+ :param _request_timeout: timeout setting for this request. If one
74
+ number provided, it will be total request
75
+ timeout. It can also be a pair (tuple) of
76
+ (connection, read) timeouts.
77
+ :type _request_timeout: int, tuple(int, int), optional
78
+ :param _request_auth: set to override the auth_settings for an a single
79
+ request; this effectively ignores the
80
+ authentication in the spec for a single request.
81
+ :type _request_auth: dict, optional
82
+ :param _content_type: force content-type for the request.
83
+ :type _content_type: str, Optional
84
+ :param _headers: set to override the headers for a single
85
+ request; this effectively ignores the headers
86
+ in the spec for a single request.
87
+ :type _headers: dict, optional
88
+ :param _host_index: set to override the host_index for a single
89
+ request; this effectively ignores the host_index
90
+ in the spec for a single request.
91
+ :type _host_index: int, optional
92
+ :return: Returns the result object.
93
+ """ # noqa: E501
94
+
95
+ _param = self._outbound_integration_endpoints_get_serialize(
96
+ context=context,
97
+ workspace=workspace,
98
+ _request_auth=_request_auth,
99
+ _content_type=_content_type,
100
+ _headers=_headers,
101
+ _host_index=_host_index
102
+ )
103
+
104
+ _response_types_map: Dict[str, Optional[str]] = {
105
+ '200': "List[OutboundIntegrationEndpoint]",
106
+ '400': "Error",
107
+ }
108
+ response_data = self.api_client.call_api(
109
+ *_param,
110
+ _request_timeout=_request_timeout
111
+ )
112
+ response_data.read()
113
+ return self.api_client.response_deserialize(
114
+ response_data=response_data,
115
+ response_types_map=_response_types_map,
116
+ ).data
117
+
118
+
119
+ @validate_call
120
+ def outbound_integration_endpoints_get_with_http_info(
121
+ self,
122
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
123
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
124
+ _request_timeout: Union[
125
+ None,
126
+ Annotated[StrictFloat, Field(gt=0)],
127
+ Tuple[
128
+ Annotated[StrictFloat, Field(gt=0)],
129
+ Annotated[StrictFloat, Field(gt=0)]
130
+ ]
131
+ ] = None,
132
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
133
+ _content_type: Optional[StrictStr] = None,
134
+ _headers: Optional[Dict[StrictStr, Any]] = None,
135
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
136
+ ) -> ApiResponse[List[OutboundIntegrationEndpoint]]:
137
+ """Returns basic outbound integration endpoint representations
138
+
139
+ Operation for retrieving an array of basic outbound integration endpoint representations for all accessible endpoints
140
+
141
+ :param context: ID of the context in which to perform the operation (required)
142
+ :type context: str
143
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
144
+ :type workspace: str
145
+ :param _request_timeout: timeout setting for this request. If one
146
+ number provided, it will be total request
147
+ timeout. It can also be a pair (tuple) of
148
+ (connection, read) timeouts.
149
+ :type _request_timeout: int, tuple(int, int), optional
150
+ :param _request_auth: set to override the auth_settings for an a single
151
+ request; this effectively ignores the
152
+ authentication in the spec for a single request.
153
+ :type _request_auth: dict, optional
154
+ :param _content_type: force content-type for the request.
155
+ :type _content_type: str, Optional
156
+ :param _headers: set to override the headers for a single
157
+ request; this effectively ignores the headers
158
+ in the spec for a single request.
159
+ :type _headers: dict, optional
160
+ :param _host_index: set to override the host_index for a single
161
+ request; this effectively ignores the host_index
162
+ in the spec for a single request.
163
+ :type _host_index: int, optional
164
+ :return: Returns the result object.
165
+ """ # noqa: E501
166
+
167
+ _param = self._outbound_integration_endpoints_get_serialize(
168
+ context=context,
169
+ workspace=workspace,
170
+ _request_auth=_request_auth,
171
+ _content_type=_content_type,
172
+ _headers=_headers,
173
+ _host_index=_host_index
174
+ )
175
+
176
+ _response_types_map: Dict[str, Optional[str]] = {
177
+ '200': "List[OutboundIntegrationEndpoint]",
178
+ '400': "Error",
179
+ }
180
+ response_data = self.api_client.call_api(
181
+ *_param,
182
+ _request_timeout=_request_timeout
183
+ )
184
+ response_data.read()
185
+ return self.api_client.response_deserialize(
186
+ response_data=response_data,
187
+ response_types_map=_response_types_map,
188
+ )
189
+
190
+
191
+ @validate_call
192
+ def outbound_integration_endpoints_get_without_preload_content(
193
+ self,
194
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
195
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
196
+ _request_timeout: Union[
197
+ None,
198
+ Annotated[StrictFloat, Field(gt=0)],
199
+ Tuple[
200
+ Annotated[StrictFloat, Field(gt=0)],
201
+ Annotated[StrictFloat, Field(gt=0)]
202
+ ]
203
+ ] = None,
204
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
205
+ _content_type: Optional[StrictStr] = None,
206
+ _headers: Optional[Dict[StrictStr, Any]] = None,
207
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
208
+ ) -> RESTResponseType:
209
+ """Returns basic outbound integration endpoint representations
210
+
211
+ Operation for retrieving an array of basic outbound integration endpoint representations for all accessible endpoints
212
+
213
+ :param context: ID of the context in which to perform the operation (required)
214
+ :type context: str
215
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
216
+ :type workspace: str
217
+ :param _request_timeout: timeout setting for this request. If one
218
+ number provided, it will be total request
219
+ timeout. It can also be a pair (tuple) of
220
+ (connection, read) timeouts.
221
+ :type _request_timeout: int, tuple(int, int), optional
222
+ :param _request_auth: set to override the auth_settings for an a single
223
+ request; this effectively ignores the
224
+ authentication in the spec for a single request.
225
+ :type _request_auth: dict, optional
226
+ :param _content_type: force content-type for the request.
227
+ :type _content_type: str, Optional
228
+ :param _headers: set to override the headers for a single
229
+ request; this effectively ignores the headers
230
+ in the spec for a single request.
231
+ :type _headers: dict, optional
232
+ :param _host_index: set to override the host_index for a single
233
+ request; this effectively ignores the host_index
234
+ in the spec for a single request.
235
+ :type _host_index: int, optional
236
+ :return: Returns the result object.
237
+ """ # noqa: E501
238
+
239
+ _param = self._outbound_integration_endpoints_get_serialize(
240
+ context=context,
241
+ workspace=workspace,
242
+ _request_auth=_request_auth,
243
+ _content_type=_content_type,
244
+ _headers=_headers,
245
+ _host_index=_host_index
246
+ )
247
+
248
+ _response_types_map: Dict[str, Optional[str]] = {
249
+ '200': "List[OutboundIntegrationEndpoint]",
250
+ '400': "Error",
251
+ }
252
+ response_data = self.api_client.call_api(
253
+ *_param,
254
+ _request_timeout=_request_timeout
255
+ )
256
+ return response_data.response
257
+
258
+
259
+ def _outbound_integration_endpoints_get_serialize(
260
+ self,
261
+ context,
262
+ workspace,
263
+ _request_auth,
264
+ _content_type,
265
+ _headers,
266
+ _host_index,
267
+ ) -> RequestSerialized:
268
+
269
+ _host = None
270
+
271
+ _collection_formats: Dict[str, str] = {
272
+ }
273
+
274
+ _path_params: Dict[str, str] = {}
275
+ _query_params: List[Tuple[str, str]] = []
276
+ _header_params: Dict[str, Optional[str]] = _headers or {}
277
+ _form_params: List[Tuple[str, str]] = []
278
+ _files: Dict[
279
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
280
+ ] = {}
281
+ _body_params: Optional[bytes] = None
282
+
283
+ # process the path parameters
284
+ # process the query parameters
285
+ if context is not None:
286
+
287
+ _query_params.append(('context', context))
288
+
289
+ if workspace is not None:
290
+
291
+ _query_params.append(('workspace', workspace))
292
+
293
+ # process the header parameters
294
+ # process the form parameters
295
+ # process the body parameter
296
+
297
+
298
+ # set the HTTP header `Accept`
299
+ if 'Accept' not in _header_params:
300
+ _header_params['Accept'] = self.api_client.select_header_accept(
301
+ [
302
+ 'application/json'
303
+ ]
304
+ )
305
+
306
+
307
+ # authentication setting
308
+ _auth_settings: List[str] = [
309
+ 'basicAuth'
310
+ ]
311
+
312
+ return self.api_client.param_serialize(
313
+ method='GET',
314
+ resource_path='/outbound-integration-endpoints',
315
+ path_params=_path_params,
316
+ query_params=_query_params,
317
+ header_params=_header_params,
318
+ body=_body_params,
319
+ post_params=_form_params,
320
+ files=_files,
321
+ auth_settings=_auth_settings,
322
+ collection_formats=_collection_formats,
323
+ _host=_host,
324
+ _request_auth=_request_auth
325
+ )
326
+
327
+
328
+
329
+
330
+ @validate_call
331
+ def outbound_integration_endpoints_id_disable_post(
332
+ self,
333
+ id: Annotated[StrictStr, Field(description="ID of the outbound integration endpoint to disable")],
334
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
335
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
336
+ _request_timeout: Union[
337
+ None,
338
+ Annotated[StrictFloat, Field(gt=0)],
339
+ Tuple[
340
+ Annotated[StrictFloat, Field(gt=0)],
341
+ Annotated[StrictFloat, Field(gt=0)]
342
+ ]
343
+ ] = None,
344
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
345
+ _content_type: Optional[StrictStr] = None,
346
+ _headers: Optional[Dict[StrictStr, Any]] = None,
347
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
348
+ ) -> None:
349
+ """Disables the specified outbound integration endpoint
350
+
351
+ Operation for disabling an outbound integration endpoint. Can be called regardless of the endpoint status.
352
+
353
+ :param id: ID of the outbound integration endpoint to disable (required)
354
+ :type id: str
355
+ :param context: ID of the context in which to perform the operation (required)
356
+ :type context: str
357
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
358
+ :type workspace: str
359
+ :param _request_timeout: timeout setting for this request. If one
360
+ number provided, it will be total request
361
+ timeout. It can also be a pair (tuple) of
362
+ (connection, read) timeouts.
363
+ :type _request_timeout: int, tuple(int, int), optional
364
+ :param _request_auth: set to override the auth_settings for an a single
365
+ request; this effectively ignores the
366
+ authentication in the spec for a single request.
367
+ :type _request_auth: dict, optional
368
+ :param _content_type: force content-type for the request.
369
+ :type _content_type: str, Optional
370
+ :param _headers: set to override the headers for a single
371
+ request; this effectively ignores the headers
372
+ in the spec for a single request.
373
+ :type _headers: dict, optional
374
+ :param _host_index: set to override the host_index for a single
375
+ request; this effectively ignores the host_index
376
+ in the spec for a single request.
377
+ :type _host_index: int, optional
378
+ :return: Returns the result object.
379
+ """ # noqa: E501
380
+
381
+ _param = self._outbound_integration_endpoints_id_disable_post_serialize(
382
+ id=id,
383
+ context=context,
384
+ workspace=workspace,
385
+ _request_auth=_request_auth,
386
+ _content_type=_content_type,
387
+ _headers=_headers,
388
+ _host_index=_host_index
389
+ )
390
+
391
+ _response_types_map: Dict[str, Optional[str]] = {
392
+ '200': None,
393
+ '400': "Error",
394
+ '404': "Error",
395
+ }
396
+ response_data = self.api_client.call_api(
397
+ *_param,
398
+ _request_timeout=_request_timeout
399
+ )
400
+ response_data.read()
401
+ return self.api_client.response_deserialize(
402
+ response_data=response_data,
403
+ response_types_map=_response_types_map,
404
+ ).data
405
+
406
+
407
+ @validate_call
408
+ def outbound_integration_endpoints_id_disable_post_with_http_info(
409
+ self,
410
+ id: Annotated[StrictStr, Field(description="ID of the outbound integration endpoint to disable")],
411
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
412
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
413
+ _request_timeout: Union[
414
+ None,
415
+ Annotated[StrictFloat, Field(gt=0)],
416
+ Tuple[
417
+ Annotated[StrictFloat, Field(gt=0)],
418
+ Annotated[StrictFloat, Field(gt=0)]
419
+ ]
420
+ ] = None,
421
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
422
+ _content_type: Optional[StrictStr] = None,
423
+ _headers: Optional[Dict[StrictStr, Any]] = None,
424
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
425
+ ) -> ApiResponse[None]:
426
+ """Disables the specified outbound integration endpoint
427
+
428
+ Operation for disabling an outbound integration endpoint. Can be called regardless of the endpoint status.
429
+
430
+ :param id: ID of the outbound integration endpoint to disable (required)
431
+ :type id: str
432
+ :param context: ID of the context in which to perform the operation (required)
433
+ :type context: str
434
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
435
+ :type workspace: str
436
+ :param _request_timeout: timeout setting for this request. If one
437
+ number provided, it will be total request
438
+ timeout. It can also be a pair (tuple) of
439
+ (connection, read) timeouts.
440
+ :type _request_timeout: int, tuple(int, int), optional
441
+ :param _request_auth: set to override the auth_settings for an a single
442
+ request; this effectively ignores the
443
+ authentication in the spec for a single request.
444
+ :type _request_auth: dict, optional
445
+ :param _content_type: force content-type for the request.
446
+ :type _content_type: str, Optional
447
+ :param _headers: set to override the headers for a single
448
+ request; this effectively ignores the headers
449
+ in the spec for a single request.
450
+ :type _headers: dict, optional
451
+ :param _host_index: set to override the host_index for a single
452
+ request; this effectively ignores the host_index
453
+ in the spec for a single request.
454
+ :type _host_index: int, optional
455
+ :return: Returns the result object.
456
+ """ # noqa: E501
457
+
458
+ _param = self._outbound_integration_endpoints_id_disable_post_serialize(
459
+ id=id,
460
+ context=context,
461
+ workspace=workspace,
462
+ _request_auth=_request_auth,
463
+ _content_type=_content_type,
464
+ _headers=_headers,
465
+ _host_index=_host_index
466
+ )
467
+
468
+ _response_types_map: Dict[str, Optional[str]] = {
469
+ '200': None,
470
+ '400': "Error",
471
+ '404': "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 outbound_integration_endpoints_id_disable_post_without_preload_content(
486
+ self,
487
+ id: Annotated[StrictStr, Field(description="ID of the outbound 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 outbound integration endpoint
504
+
505
+ Operation for disabling an outbound integration endpoint. Can be called regardless of the endpoint status.
506
+
507
+ :param id: ID of the outbound 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._outbound_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
+ }
550
+ response_data = self.api_client.call_api(
551
+ *_param,
552
+ _request_timeout=_request_timeout
553
+ )
554
+ return response_data.response
555
+
556
+
557
+ def _outbound_integration_endpoints_id_disable_post_serialize(
558
+ self,
559
+ id,
560
+ context,
561
+ workspace,
562
+ _request_auth,
563
+ _content_type,
564
+ _headers,
565
+ _host_index,
566
+ ) -> RequestSerialized:
567
+
568
+ _host = None
569
+
570
+ _collection_formats: Dict[str, str] = {
571
+ }
572
+
573
+ _path_params: Dict[str, str] = {}
574
+ _query_params: List[Tuple[str, str]] = []
575
+ _header_params: Dict[str, Optional[str]] = _headers or {}
576
+ _form_params: List[Tuple[str, str]] = []
577
+ _files: Dict[
578
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
579
+ ] = {}
580
+ _body_params: Optional[bytes] = None
581
+
582
+ # process the path parameters
583
+ if id is not None:
584
+ _path_params['id'] = id
585
+ # process the query parameters
586
+ if context is not None:
587
+
588
+ _query_params.append(('context', context))
589
+
590
+ if workspace is not None:
591
+
592
+ _query_params.append(('workspace', workspace))
593
+
594
+ # process the header parameters
595
+ # process the form parameters
596
+ # process the body parameter
597
+
598
+
599
+ # set the HTTP header `Accept`
600
+ if 'Accept' not in _header_params:
601
+ _header_params['Accept'] = self.api_client.select_header_accept(
602
+ [
603
+ 'application/json'
604
+ ]
605
+ )
606
+
607
+
608
+ # authentication setting
609
+ _auth_settings: List[str] = [
610
+ 'basicAuth'
611
+ ]
612
+
613
+ return self.api_client.param_serialize(
614
+ method='POST',
615
+ resource_path='/outbound-integration-endpoints/{id}/disable',
616
+ path_params=_path_params,
617
+ query_params=_query_params,
618
+ header_params=_header_params,
619
+ body=_body_params,
620
+ post_params=_form_params,
621
+ files=_files,
622
+ auth_settings=_auth_settings,
623
+ collection_formats=_collection_formats,
624
+ _host=_host,
625
+ _request_auth=_request_auth
626
+ )
627
+
628
+
629
+
630
+
631
+ @validate_call
632
+ def outbound_integration_endpoints_id_enable_post(
633
+ self,
634
+ id: Annotated[StrictStr, Field(description="ID of the outbound integration endpoint to enable")],
635
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
636
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
637
+ _request_timeout: Union[
638
+ None,
639
+ Annotated[StrictFloat, Field(gt=0)],
640
+ Tuple[
641
+ Annotated[StrictFloat, Field(gt=0)],
642
+ Annotated[StrictFloat, Field(gt=0)]
643
+ ]
644
+ ] = None,
645
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
646
+ _content_type: Optional[StrictStr] = None,
647
+ _headers: Optional[Dict[StrictStr, Any]] = None,
648
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
649
+ ) -> None:
650
+ """Enables the specified outbound integration endpoint
651
+
652
+ Operation for enabling an outbound integration endpoint. Can be called regardless of the endpoint status. Endpoints with status 'failed' will be resumed.
653
+
654
+ :param id: ID of the outbound integration endpoint to enable (required)
655
+ :type id: str
656
+ :param context: ID of the context in which to perform the operation (required)
657
+ :type context: str
658
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
659
+ :type workspace: str
660
+ :param _request_timeout: timeout setting for this request. If one
661
+ number provided, it will be total request
662
+ timeout. It can also be a pair (tuple) of
663
+ (connection, read) timeouts.
664
+ :type _request_timeout: int, tuple(int, int), optional
665
+ :param _request_auth: set to override the auth_settings for an a single
666
+ request; this effectively ignores the
667
+ authentication in the spec for a single request.
668
+ :type _request_auth: dict, optional
669
+ :param _content_type: force content-type for the request.
670
+ :type _content_type: str, Optional
671
+ :param _headers: set to override the headers for a single
672
+ request; this effectively ignores the headers
673
+ in the spec for a single request.
674
+ :type _headers: dict, optional
675
+ :param _host_index: set to override the host_index for a single
676
+ request; this effectively ignores the host_index
677
+ in the spec for a single request.
678
+ :type _host_index: int, optional
679
+ :return: Returns the result object.
680
+ """ # noqa: E501
681
+
682
+ _param = self._outbound_integration_endpoints_id_enable_post_serialize(
683
+ id=id,
684
+ context=context,
685
+ workspace=workspace,
686
+ _request_auth=_request_auth,
687
+ _content_type=_content_type,
688
+ _headers=_headers,
689
+ _host_index=_host_index
690
+ )
691
+
692
+ _response_types_map: Dict[str, Optional[str]] = {
693
+ '200': None,
694
+ '400': "Error",
695
+ '404': "Error",
696
+ }
697
+ response_data = self.api_client.call_api(
698
+ *_param,
699
+ _request_timeout=_request_timeout
700
+ )
701
+ response_data.read()
702
+ return self.api_client.response_deserialize(
703
+ response_data=response_data,
704
+ response_types_map=_response_types_map,
705
+ ).data
706
+
707
+
708
+ @validate_call
709
+ def outbound_integration_endpoints_id_enable_post_with_http_info(
710
+ self,
711
+ id: Annotated[StrictStr, Field(description="ID of the outbound integration endpoint to enable")],
712
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
713
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
714
+ _request_timeout: Union[
715
+ None,
716
+ Annotated[StrictFloat, Field(gt=0)],
717
+ Tuple[
718
+ Annotated[StrictFloat, Field(gt=0)],
719
+ Annotated[StrictFloat, Field(gt=0)]
720
+ ]
721
+ ] = None,
722
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
723
+ _content_type: Optional[StrictStr] = None,
724
+ _headers: Optional[Dict[StrictStr, Any]] = None,
725
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
726
+ ) -> ApiResponse[None]:
727
+ """Enables the specified outbound integration endpoint
728
+
729
+ Operation for enabling an outbound integration endpoint. Can be called regardless of the endpoint status. Endpoints with status 'failed' will be resumed.
730
+
731
+ :param id: ID of the outbound integration endpoint to enable (required)
732
+ :type id: str
733
+ :param context: ID of the context in which to perform the operation (required)
734
+ :type context: str
735
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
736
+ :type workspace: str
737
+ :param _request_timeout: timeout setting for this request. If one
738
+ number provided, it will be total request
739
+ timeout. It can also be a pair (tuple) of
740
+ (connection, read) timeouts.
741
+ :type _request_timeout: int, tuple(int, int), optional
742
+ :param _request_auth: set to override the auth_settings for an a single
743
+ request; this effectively ignores the
744
+ authentication in the spec for a single request.
745
+ :type _request_auth: dict, optional
746
+ :param _content_type: force content-type for the request.
747
+ :type _content_type: str, Optional
748
+ :param _headers: set to override the headers for a single
749
+ request; this effectively ignores the headers
750
+ in the spec for a single request.
751
+ :type _headers: dict, optional
752
+ :param _host_index: set to override the host_index for a single
753
+ request; this effectively ignores the host_index
754
+ in the spec for a single request.
755
+ :type _host_index: int, optional
756
+ :return: Returns the result object.
757
+ """ # noqa: E501
758
+
759
+ _param = self._outbound_integration_endpoints_id_enable_post_serialize(
760
+ id=id,
761
+ context=context,
762
+ workspace=workspace,
763
+ _request_auth=_request_auth,
764
+ _content_type=_content_type,
765
+ _headers=_headers,
766
+ _host_index=_host_index
767
+ )
768
+
769
+ _response_types_map: Dict[str, Optional[str]] = {
770
+ '200': None,
771
+ '400': "Error",
772
+ '404': "Error",
773
+ }
774
+ response_data = self.api_client.call_api(
775
+ *_param,
776
+ _request_timeout=_request_timeout
777
+ )
778
+ response_data.read()
779
+ return self.api_client.response_deserialize(
780
+ response_data=response_data,
781
+ response_types_map=_response_types_map,
782
+ )
783
+
784
+
785
+ @validate_call
786
+ def outbound_integration_endpoints_id_enable_post_without_preload_content(
787
+ self,
788
+ id: Annotated[StrictStr, Field(description="ID of the outbound integration endpoint to enable")],
789
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
790
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
791
+ _request_timeout: Union[
792
+ None,
793
+ Annotated[StrictFloat, Field(gt=0)],
794
+ Tuple[
795
+ Annotated[StrictFloat, Field(gt=0)],
796
+ Annotated[StrictFloat, Field(gt=0)]
797
+ ]
798
+ ] = None,
799
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
800
+ _content_type: Optional[StrictStr] = None,
801
+ _headers: Optional[Dict[StrictStr, Any]] = None,
802
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
803
+ ) -> RESTResponseType:
804
+ """Enables the specified outbound integration endpoint
805
+
806
+ Operation for enabling an outbound integration endpoint. Can be called regardless of the endpoint status. Endpoints with status 'failed' will be resumed.
807
+
808
+ :param id: ID of the outbound integration endpoint to enable (required)
809
+ :type id: str
810
+ :param context: ID of the context in which to perform the operation (required)
811
+ :type context: str
812
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
813
+ :type workspace: str
814
+ :param _request_timeout: timeout setting for this request. If one
815
+ number provided, it will be total request
816
+ timeout. It can also be a pair (tuple) of
817
+ (connection, read) timeouts.
818
+ :type _request_timeout: int, tuple(int, int), optional
819
+ :param _request_auth: set to override the auth_settings for an a single
820
+ request; this effectively ignores the
821
+ authentication in the spec for a single request.
822
+ :type _request_auth: dict, optional
823
+ :param _content_type: force content-type for the request.
824
+ :type _content_type: str, Optional
825
+ :param _headers: set to override the headers for a single
826
+ request; this effectively ignores the headers
827
+ in the spec for a single request.
828
+ :type _headers: dict, optional
829
+ :param _host_index: set to override the host_index for a single
830
+ request; this effectively ignores the host_index
831
+ in the spec for a single request.
832
+ :type _host_index: int, optional
833
+ :return: Returns the result object.
834
+ """ # noqa: E501
835
+
836
+ _param = self._outbound_integration_endpoints_id_enable_post_serialize(
837
+ id=id,
838
+ context=context,
839
+ workspace=workspace,
840
+ _request_auth=_request_auth,
841
+ _content_type=_content_type,
842
+ _headers=_headers,
843
+ _host_index=_host_index
844
+ )
845
+
846
+ _response_types_map: Dict[str, Optional[str]] = {
847
+ '200': None,
848
+ '400': "Error",
849
+ '404': "Error",
850
+ }
851
+ response_data = self.api_client.call_api(
852
+ *_param,
853
+ _request_timeout=_request_timeout
854
+ )
855
+ return response_data.response
856
+
857
+
858
+ def _outbound_integration_endpoints_id_enable_post_serialize(
859
+ self,
860
+ id,
861
+ context,
862
+ workspace,
863
+ _request_auth,
864
+ _content_type,
865
+ _headers,
866
+ _host_index,
867
+ ) -> RequestSerialized:
868
+
869
+ _host = None
870
+
871
+ _collection_formats: Dict[str, str] = {
872
+ }
873
+
874
+ _path_params: Dict[str, str] = {}
875
+ _query_params: List[Tuple[str, str]] = []
876
+ _header_params: Dict[str, Optional[str]] = _headers or {}
877
+ _form_params: List[Tuple[str, str]] = []
878
+ _files: Dict[
879
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
880
+ ] = {}
881
+ _body_params: Optional[bytes] = None
882
+
883
+ # process the path parameters
884
+ if id is not None:
885
+ _path_params['id'] = id
886
+ # process the query parameters
887
+ if context is not None:
888
+
889
+ _query_params.append(('context', context))
890
+
891
+ if workspace is not None:
892
+
893
+ _query_params.append(('workspace', workspace))
894
+
895
+ # process the header parameters
896
+ # process the form parameters
897
+ # process the body parameter
898
+
899
+
900
+ # set the HTTP header `Accept`
901
+ if 'Accept' not in _header_params:
902
+ _header_params['Accept'] = self.api_client.select_header_accept(
903
+ [
904
+ 'application/json'
905
+ ]
906
+ )
907
+
908
+
909
+ # authentication setting
910
+ _auth_settings: List[str] = [
911
+ 'basicAuth'
912
+ ]
913
+
914
+ return self.api_client.param_serialize(
915
+ method='POST',
916
+ resource_path='/outbound-integration-endpoints/{id}/enable',
917
+ path_params=_path_params,
918
+ query_params=_query_params,
919
+ header_params=_header_params,
920
+ body=_body_params,
921
+ post_params=_form_params,
922
+ files=_files,
923
+ auth_settings=_auth_settings,
924
+ collection_formats=_collection_formats,
925
+ _host=_host,
926
+ _request_auth=_request_auth
927
+ )
928
+
929
+
930
+
931
+
932
+ @validate_call
933
+ def outbound_integration_endpoints_id_execution_report_get(
934
+ self,
935
+ id: Annotated[StrictStr, Field(description="ID of the outbound integration endpoint for which to retrieve the execution report")],
936
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
937
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
938
+ _request_timeout: Union[
939
+ None,
940
+ Annotated[StrictFloat, Field(gt=0)],
941
+ Tuple[
942
+ Annotated[StrictFloat, Field(gt=0)],
943
+ Annotated[StrictFloat, Field(gt=0)]
944
+ ]
945
+ ] = None,
946
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
947
+ _content_type: Optional[StrictStr] = None,
948
+ _headers: Optional[Dict[StrictStr, Any]] = None,
949
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
950
+ ) -> List[ExecutionReportEntry]:
951
+ """Returns the execution report for the specified outbound integration endpoint
952
+
953
+ Operation for retrieving the execution report for the main process of a specific outbound integration endpoint
954
+
955
+ :param id: ID of the outbound integration endpoint for which to retrieve the execution report (required)
956
+ :type id: str
957
+ :param context: ID of the context in which to perform the operation (required)
958
+ :type context: str
959
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
960
+ :type workspace: str
961
+ :param _request_timeout: timeout setting for this request. If one
962
+ number provided, it will be total request
963
+ timeout. It can also be a pair (tuple) of
964
+ (connection, read) timeouts.
965
+ :type _request_timeout: int, tuple(int, int), optional
966
+ :param _request_auth: set to override the auth_settings for an a single
967
+ request; this effectively ignores the
968
+ authentication in the spec for a single request.
969
+ :type _request_auth: dict, optional
970
+ :param _content_type: force content-type for the request.
971
+ :type _content_type: str, Optional
972
+ :param _headers: set to override the headers for a single
973
+ request; this effectively ignores the headers
974
+ in the spec for a single request.
975
+ :type _headers: dict, optional
976
+ :param _host_index: set to override the host_index for a single
977
+ request; this effectively ignores the host_index
978
+ in the spec for a single request.
979
+ :type _host_index: int, optional
980
+ :return: Returns the result object.
981
+ """ # noqa: E501
982
+
983
+ _param = self._outbound_integration_endpoints_id_execution_report_get_serialize(
984
+ id=id,
985
+ context=context,
986
+ workspace=workspace,
987
+ _request_auth=_request_auth,
988
+ _content_type=_content_type,
989
+ _headers=_headers,
990
+ _host_index=_host_index
991
+ )
992
+
993
+ _response_types_map: Dict[str, Optional[str]] = {
994
+ '200': "List[ExecutionReportEntry]",
995
+ '400': "Error",
996
+ '404': "Error",
997
+ }
998
+ response_data = self.api_client.call_api(
999
+ *_param,
1000
+ _request_timeout=_request_timeout
1001
+ )
1002
+ response_data.read()
1003
+ return self.api_client.response_deserialize(
1004
+ response_data=response_data,
1005
+ response_types_map=_response_types_map,
1006
+ ).data
1007
+
1008
+
1009
+ @validate_call
1010
+ def outbound_integration_endpoints_id_execution_report_get_with_http_info(
1011
+ self,
1012
+ id: Annotated[StrictStr, Field(description="ID of the outbound integration endpoint for which to retrieve the execution report")],
1013
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
1014
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
1015
+ _request_timeout: Union[
1016
+ None,
1017
+ Annotated[StrictFloat, Field(gt=0)],
1018
+ Tuple[
1019
+ Annotated[StrictFloat, Field(gt=0)],
1020
+ Annotated[StrictFloat, Field(gt=0)]
1021
+ ]
1022
+ ] = None,
1023
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1024
+ _content_type: Optional[StrictStr] = None,
1025
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1026
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1027
+ ) -> ApiResponse[List[ExecutionReportEntry]]:
1028
+ """Returns the execution report for the specified outbound integration endpoint
1029
+
1030
+ Operation for retrieving the execution report for the main process of a specific outbound integration endpoint
1031
+
1032
+ :param id: ID of the outbound integration endpoint for which to retrieve the execution report (required)
1033
+ :type id: str
1034
+ :param context: ID of the context in which to perform the operation (required)
1035
+ :type context: str
1036
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
1037
+ :type workspace: str
1038
+ :param _request_timeout: timeout setting for this request. If one
1039
+ number provided, it will be total request
1040
+ timeout. It can also be a pair (tuple) of
1041
+ (connection, read) timeouts.
1042
+ :type _request_timeout: int, tuple(int, int), optional
1043
+ :param _request_auth: set to override the auth_settings for an a single
1044
+ request; this effectively ignores the
1045
+ authentication in the spec for a single request.
1046
+ :type _request_auth: dict, optional
1047
+ :param _content_type: force content-type for the request.
1048
+ :type _content_type: str, Optional
1049
+ :param _headers: set to override the headers for a single
1050
+ request; this effectively ignores the headers
1051
+ in the spec for a single request.
1052
+ :type _headers: dict, optional
1053
+ :param _host_index: set to override the host_index for a single
1054
+ request; this effectively ignores the host_index
1055
+ in the spec for a single request.
1056
+ :type _host_index: int, optional
1057
+ :return: Returns the result object.
1058
+ """ # noqa: E501
1059
+
1060
+ _param = self._outbound_integration_endpoints_id_execution_report_get_serialize(
1061
+ id=id,
1062
+ context=context,
1063
+ workspace=workspace,
1064
+ _request_auth=_request_auth,
1065
+ _content_type=_content_type,
1066
+ _headers=_headers,
1067
+ _host_index=_host_index
1068
+ )
1069
+
1070
+ _response_types_map: Dict[str, Optional[str]] = {
1071
+ '200': "List[ExecutionReportEntry]",
1072
+ '400': "Error",
1073
+ '404': "Error",
1074
+ }
1075
+ response_data = self.api_client.call_api(
1076
+ *_param,
1077
+ _request_timeout=_request_timeout
1078
+ )
1079
+ response_data.read()
1080
+ return self.api_client.response_deserialize(
1081
+ response_data=response_data,
1082
+ response_types_map=_response_types_map,
1083
+ )
1084
+
1085
+
1086
+ @validate_call
1087
+ def outbound_integration_endpoints_id_execution_report_get_without_preload_content(
1088
+ self,
1089
+ id: Annotated[StrictStr, Field(description="ID of the outbound integration endpoint for which to retrieve the execution report")],
1090
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
1091
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
1092
+ _request_timeout: Union[
1093
+ None,
1094
+ Annotated[StrictFloat, Field(gt=0)],
1095
+ Tuple[
1096
+ Annotated[StrictFloat, Field(gt=0)],
1097
+ Annotated[StrictFloat, Field(gt=0)]
1098
+ ]
1099
+ ] = None,
1100
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1101
+ _content_type: Optional[StrictStr] = None,
1102
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1103
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1104
+ ) -> RESTResponseType:
1105
+ """Returns the execution report for the specified outbound integration endpoint
1106
+
1107
+ Operation for retrieving the execution report for the main process of a specific outbound integration endpoint
1108
+
1109
+ :param id: ID of the outbound integration endpoint for which to retrieve the execution report (required)
1110
+ :type id: str
1111
+ :param context: ID of the context in which to perform the operation (required)
1112
+ :type context: str
1113
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
1114
+ :type workspace: str
1115
+ :param _request_timeout: timeout setting for this request. If one
1116
+ number provided, it will be total request
1117
+ timeout. It can also be a pair (tuple) of
1118
+ (connection, read) timeouts.
1119
+ :type _request_timeout: int, tuple(int, int), optional
1120
+ :param _request_auth: set to override the auth_settings for an a single
1121
+ request; this effectively ignores the
1122
+ authentication in the spec for a single request.
1123
+ :type _request_auth: dict, optional
1124
+ :param _content_type: force content-type for the request.
1125
+ :type _content_type: str, Optional
1126
+ :param _headers: set to override the headers for a single
1127
+ request; this effectively ignores the headers
1128
+ in the spec for a single request.
1129
+ :type _headers: dict, optional
1130
+ :param _host_index: set to override the host_index for a single
1131
+ request; this effectively ignores the host_index
1132
+ in the spec for a single request.
1133
+ :type _host_index: int, optional
1134
+ :return: Returns the result object.
1135
+ """ # noqa: E501
1136
+
1137
+ _param = self._outbound_integration_endpoints_id_execution_report_get_serialize(
1138
+ id=id,
1139
+ context=context,
1140
+ workspace=workspace,
1141
+ _request_auth=_request_auth,
1142
+ _content_type=_content_type,
1143
+ _headers=_headers,
1144
+ _host_index=_host_index
1145
+ )
1146
+
1147
+ _response_types_map: Dict[str, Optional[str]] = {
1148
+ '200': "List[ExecutionReportEntry]",
1149
+ '400': "Error",
1150
+ '404': "Error",
1151
+ }
1152
+ response_data = self.api_client.call_api(
1153
+ *_param,
1154
+ _request_timeout=_request_timeout
1155
+ )
1156
+ return response_data.response
1157
+
1158
+
1159
+ def _outbound_integration_endpoints_id_execution_report_get_serialize(
1160
+ self,
1161
+ id,
1162
+ context,
1163
+ workspace,
1164
+ _request_auth,
1165
+ _content_type,
1166
+ _headers,
1167
+ _host_index,
1168
+ ) -> RequestSerialized:
1169
+
1170
+ _host = None
1171
+
1172
+ _collection_formats: Dict[str, str] = {
1173
+ }
1174
+
1175
+ _path_params: Dict[str, str] = {}
1176
+ _query_params: List[Tuple[str, str]] = []
1177
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1178
+ _form_params: List[Tuple[str, str]] = []
1179
+ _files: Dict[
1180
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1181
+ ] = {}
1182
+ _body_params: Optional[bytes] = None
1183
+
1184
+ # process the path parameters
1185
+ if id is not None:
1186
+ _path_params['id'] = id
1187
+ # process the query parameters
1188
+ if context is not None:
1189
+
1190
+ _query_params.append(('context', context))
1191
+
1192
+ if workspace is not None:
1193
+
1194
+ _query_params.append(('workspace', workspace))
1195
+
1196
+ # process the header parameters
1197
+ # process the form parameters
1198
+ # process the body parameter
1199
+
1200
+
1201
+ # set the HTTP header `Accept`
1202
+ if 'Accept' not in _header_params:
1203
+ _header_params['Accept'] = self.api_client.select_header_accept(
1204
+ [
1205
+ 'application/json'
1206
+ ]
1207
+ )
1208
+
1209
+
1210
+ # authentication setting
1211
+ _auth_settings: List[str] = [
1212
+ 'basicAuth'
1213
+ ]
1214
+
1215
+ return self.api_client.param_serialize(
1216
+ method='GET',
1217
+ resource_path='/outbound-integration-endpoints/{id}/execution-report',
1218
+ path_params=_path_params,
1219
+ query_params=_query_params,
1220
+ header_params=_header_params,
1221
+ body=_body_params,
1222
+ post_params=_form_params,
1223
+ files=_files,
1224
+ auth_settings=_auth_settings,
1225
+ collection_formats=_collection_formats,
1226
+ _host=_host,
1227
+ _request_auth=_request_auth
1228
+ )
1229
+
1230
+
1231
+
1232
+
1233
+ @validate_call
1234
+ def outbound_integration_endpoints_id_invoke_post(
1235
+ self,
1236
+ id: Annotated[StrictStr, Field(description="ID of the outbound integration endpoint to invoke")],
1237
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
1238
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
1239
+ _request_timeout: Union[
1240
+ None,
1241
+ Annotated[StrictFloat, Field(gt=0)],
1242
+ Tuple[
1243
+ Annotated[StrictFloat, Field(gt=0)],
1244
+ Annotated[StrictFloat, Field(gt=0)]
1245
+ ]
1246
+ ] = None,
1247
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1248
+ _content_type: Optional[StrictStr] = None,
1249
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1250
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1251
+ ) -> None:
1252
+ """Invokes the specified outbound integration endpoint
1253
+
1254
+ Operation for invoking an outbound integration endpoint. Can be called only for endpoints with status 'enabled'.
1255
+
1256
+ :param id: ID of the outbound integration endpoint to invoke (required)
1257
+ :type id: str
1258
+ :param context: ID of the context in which to perform the operation (required)
1259
+ :type context: str
1260
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
1261
+ :type workspace: str
1262
+ :param _request_timeout: timeout setting for this request. If one
1263
+ number provided, it will be total request
1264
+ timeout. It can also be a pair (tuple) of
1265
+ (connection, read) timeouts.
1266
+ :type _request_timeout: int, tuple(int, int), optional
1267
+ :param _request_auth: set to override the auth_settings for an a single
1268
+ request; this effectively ignores the
1269
+ authentication in the spec for a single request.
1270
+ :type _request_auth: dict, optional
1271
+ :param _content_type: force content-type for the request.
1272
+ :type _content_type: str, Optional
1273
+ :param _headers: set to override the headers for a single
1274
+ request; this effectively ignores the headers
1275
+ in the spec for a single request.
1276
+ :type _headers: dict, optional
1277
+ :param _host_index: set to override the host_index for a single
1278
+ request; this effectively ignores the host_index
1279
+ in the spec for a single request.
1280
+ :type _host_index: int, optional
1281
+ :return: Returns the result object.
1282
+ """ # noqa: E501
1283
+
1284
+ _param = self._outbound_integration_endpoints_id_invoke_post_serialize(
1285
+ id=id,
1286
+ context=context,
1287
+ workspace=workspace,
1288
+ _request_auth=_request_auth,
1289
+ _content_type=_content_type,
1290
+ _headers=_headers,
1291
+ _host_index=_host_index
1292
+ )
1293
+
1294
+ _response_types_map: Dict[str, Optional[str]] = {
1295
+ '200': None,
1296
+ '400': "Error",
1297
+ '404': "Error",
1298
+ }
1299
+ response_data = self.api_client.call_api(
1300
+ *_param,
1301
+ _request_timeout=_request_timeout
1302
+ )
1303
+ response_data.read()
1304
+ return self.api_client.response_deserialize(
1305
+ response_data=response_data,
1306
+ response_types_map=_response_types_map,
1307
+ ).data
1308
+
1309
+
1310
+ @validate_call
1311
+ def outbound_integration_endpoints_id_invoke_post_with_http_info(
1312
+ self,
1313
+ id: Annotated[StrictStr, Field(description="ID of the outbound integration endpoint to invoke")],
1314
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
1315
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
1316
+ _request_timeout: Union[
1317
+ None,
1318
+ Annotated[StrictFloat, Field(gt=0)],
1319
+ Tuple[
1320
+ Annotated[StrictFloat, Field(gt=0)],
1321
+ Annotated[StrictFloat, Field(gt=0)]
1322
+ ]
1323
+ ] = None,
1324
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1325
+ _content_type: Optional[StrictStr] = None,
1326
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1327
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1328
+ ) -> ApiResponse[None]:
1329
+ """Invokes the specified outbound integration endpoint
1330
+
1331
+ Operation for invoking an outbound integration endpoint. Can be called only for endpoints with status 'enabled'.
1332
+
1333
+ :param id: ID of the outbound integration endpoint to invoke (required)
1334
+ :type id: str
1335
+ :param context: ID of the context in which to perform the operation (required)
1336
+ :type context: str
1337
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
1338
+ :type workspace: str
1339
+ :param _request_timeout: timeout setting for this request. If one
1340
+ number provided, it will be total request
1341
+ timeout. It can also be a pair (tuple) of
1342
+ (connection, read) timeouts.
1343
+ :type _request_timeout: int, tuple(int, int), optional
1344
+ :param _request_auth: set to override the auth_settings for an a single
1345
+ request; this effectively ignores the
1346
+ authentication in the spec for a single request.
1347
+ :type _request_auth: dict, optional
1348
+ :param _content_type: force content-type for the request.
1349
+ :type _content_type: str, Optional
1350
+ :param _headers: set to override the headers for a single
1351
+ request; this effectively ignores the headers
1352
+ in the spec for a single request.
1353
+ :type _headers: dict, optional
1354
+ :param _host_index: set to override the host_index for a single
1355
+ request; this effectively ignores the host_index
1356
+ in the spec for a single request.
1357
+ :type _host_index: int, optional
1358
+ :return: Returns the result object.
1359
+ """ # noqa: E501
1360
+
1361
+ _param = self._outbound_integration_endpoints_id_invoke_post_serialize(
1362
+ id=id,
1363
+ context=context,
1364
+ workspace=workspace,
1365
+ _request_auth=_request_auth,
1366
+ _content_type=_content_type,
1367
+ _headers=_headers,
1368
+ _host_index=_host_index
1369
+ )
1370
+
1371
+ _response_types_map: Dict[str, Optional[str]] = {
1372
+ '200': None,
1373
+ '400': "Error",
1374
+ '404': "Error",
1375
+ }
1376
+ response_data = self.api_client.call_api(
1377
+ *_param,
1378
+ _request_timeout=_request_timeout
1379
+ )
1380
+ response_data.read()
1381
+ return self.api_client.response_deserialize(
1382
+ response_data=response_data,
1383
+ response_types_map=_response_types_map,
1384
+ )
1385
+
1386
+
1387
+ @validate_call
1388
+ def outbound_integration_endpoints_id_invoke_post_without_preload_content(
1389
+ self,
1390
+ id: Annotated[StrictStr, Field(description="ID of the outbound integration endpoint to invoke")],
1391
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
1392
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
1393
+ _request_timeout: Union[
1394
+ None,
1395
+ Annotated[StrictFloat, Field(gt=0)],
1396
+ Tuple[
1397
+ Annotated[StrictFloat, Field(gt=0)],
1398
+ Annotated[StrictFloat, Field(gt=0)]
1399
+ ]
1400
+ ] = None,
1401
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1402
+ _content_type: Optional[StrictStr] = None,
1403
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1404
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1405
+ ) -> RESTResponseType:
1406
+ """Invokes the specified outbound integration endpoint
1407
+
1408
+ Operation for invoking an outbound integration endpoint. Can be called only for endpoints with status 'enabled'.
1409
+
1410
+ :param id: ID of the outbound integration endpoint to invoke (required)
1411
+ :type id: str
1412
+ :param context: ID of the context in which to perform the operation (required)
1413
+ :type context: str
1414
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
1415
+ :type workspace: str
1416
+ :param _request_timeout: timeout setting for this request. If one
1417
+ number provided, it will be total request
1418
+ timeout. It can also be a pair (tuple) of
1419
+ (connection, read) timeouts.
1420
+ :type _request_timeout: int, tuple(int, int), optional
1421
+ :param _request_auth: set to override the auth_settings for an a single
1422
+ request; this effectively ignores the
1423
+ authentication in the spec for a single request.
1424
+ :type _request_auth: dict, optional
1425
+ :param _content_type: force content-type for the request.
1426
+ :type _content_type: str, Optional
1427
+ :param _headers: set to override the headers for a single
1428
+ request; this effectively ignores the headers
1429
+ in the spec for a single request.
1430
+ :type _headers: dict, optional
1431
+ :param _host_index: set to override the host_index for a single
1432
+ request; this effectively ignores the host_index
1433
+ in the spec for a single request.
1434
+ :type _host_index: int, optional
1435
+ :return: Returns the result object.
1436
+ """ # noqa: E501
1437
+
1438
+ _param = self._outbound_integration_endpoints_id_invoke_post_serialize(
1439
+ id=id,
1440
+ context=context,
1441
+ workspace=workspace,
1442
+ _request_auth=_request_auth,
1443
+ _content_type=_content_type,
1444
+ _headers=_headers,
1445
+ _host_index=_host_index
1446
+ )
1447
+
1448
+ _response_types_map: Dict[str, Optional[str]] = {
1449
+ '200': None,
1450
+ '400': "Error",
1451
+ '404': "Error",
1452
+ }
1453
+ response_data = self.api_client.call_api(
1454
+ *_param,
1455
+ _request_timeout=_request_timeout
1456
+ )
1457
+ return response_data.response
1458
+
1459
+
1460
+ def _outbound_integration_endpoints_id_invoke_post_serialize(
1461
+ self,
1462
+ id,
1463
+ context,
1464
+ workspace,
1465
+ _request_auth,
1466
+ _content_type,
1467
+ _headers,
1468
+ _host_index,
1469
+ ) -> RequestSerialized:
1470
+
1471
+ _host = None
1472
+
1473
+ _collection_formats: Dict[str, str] = {
1474
+ }
1475
+
1476
+ _path_params: Dict[str, str] = {}
1477
+ _query_params: List[Tuple[str, str]] = []
1478
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1479
+ _form_params: List[Tuple[str, str]] = []
1480
+ _files: Dict[
1481
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1482
+ ] = {}
1483
+ _body_params: Optional[bytes] = None
1484
+
1485
+ # process the path parameters
1486
+ if id is not None:
1487
+ _path_params['id'] = id
1488
+ # process the query parameters
1489
+ if context is not None:
1490
+
1491
+ _query_params.append(('context', context))
1492
+
1493
+ if workspace is not None:
1494
+
1495
+ _query_params.append(('workspace', workspace))
1496
+
1497
+ # process the header parameters
1498
+ # process the form parameters
1499
+ # process the body parameter
1500
+
1501
+
1502
+ # set the HTTP header `Accept`
1503
+ if 'Accept' not in _header_params:
1504
+ _header_params['Accept'] = self.api_client.select_header_accept(
1505
+ [
1506
+ 'application/json'
1507
+ ]
1508
+ )
1509
+
1510
+
1511
+ # authentication setting
1512
+ _auth_settings: List[str] = [
1513
+ 'basicAuth'
1514
+ ]
1515
+
1516
+ return self.api_client.param_serialize(
1517
+ method='POST',
1518
+ resource_path='/outbound-integration-endpoints/{id}/invoke',
1519
+ path_params=_path_params,
1520
+ query_params=_query_params,
1521
+ header_params=_header_params,
1522
+ body=_body_params,
1523
+ post_params=_form_params,
1524
+ files=_files,
1525
+ auth_settings=_auth_settings,
1526
+ collection_formats=_collection_formats,
1527
+ _host=_host,
1528
+ _request_auth=_request_auth
1529
+ )
1530
+
1531
+
1532
+
1533
+
1534
+ @validate_call
1535
+ def outbound_integration_endpoints_id_queue_disable_post(
1536
+ self,
1537
+ id: Annotated[StrictStr, Field(description="ID of the outbound integration endpoint for which to disable the event queue")],
1538
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
1539
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
1540
+ _request_timeout: Union[
1541
+ None,
1542
+ Annotated[StrictFloat, Field(gt=0)],
1543
+ Tuple[
1544
+ Annotated[StrictFloat, Field(gt=0)],
1545
+ Annotated[StrictFloat, Field(gt=0)]
1546
+ ]
1547
+ ] = None,
1548
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1549
+ _content_type: Optional[StrictStr] = None,
1550
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1551
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1552
+ ) -> None:
1553
+ """Disables the event queue associated with the outbound integration endpoint
1554
+
1555
+ Operation for disabling an event queue associated with an outbound integration endpoint. A 400 response is returned if the endpoint does not have an associated event queue.
1556
+
1557
+ :param id: ID of the outbound integration endpoint for which to disable the event queue (required)
1558
+ :type id: str
1559
+ :param context: ID of the context in which to perform the operation (required)
1560
+ :type context: str
1561
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
1562
+ :type workspace: str
1563
+ :param _request_timeout: timeout setting for this request. If one
1564
+ number provided, it will be total request
1565
+ timeout. It can also be a pair (tuple) of
1566
+ (connection, read) timeouts.
1567
+ :type _request_timeout: int, tuple(int, int), optional
1568
+ :param _request_auth: set to override the auth_settings for an a single
1569
+ request; this effectively ignores the
1570
+ authentication in the spec for a single request.
1571
+ :type _request_auth: dict, optional
1572
+ :param _content_type: force content-type for the request.
1573
+ :type _content_type: str, Optional
1574
+ :param _headers: set to override the headers for a single
1575
+ request; this effectively ignores the headers
1576
+ in the spec for a single request.
1577
+ :type _headers: dict, optional
1578
+ :param _host_index: set to override the host_index for a single
1579
+ request; this effectively ignores the host_index
1580
+ in the spec for a single request.
1581
+ :type _host_index: int, optional
1582
+ :return: Returns the result object.
1583
+ """ # noqa: E501
1584
+
1585
+ _param = self._outbound_integration_endpoints_id_queue_disable_post_serialize(
1586
+ id=id,
1587
+ context=context,
1588
+ workspace=workspace,
1589
+ _request_auth=_request_auth,
1590
+ _content_type=_content_type,
1591
+ _headers=_headers,
1592
+ _host_index=_host_index
1593
+ )
1594
+
1595
+ _response_types_map: Dict[str, Optional[str]] = {
1596
+ '200': None,
1597
+ '400': "Error",
1598
+ '404': "Error",
1599
+ }
1600
+ response_data = self.api_client.call_api(
1601
+ *_param,
1602
+ _request_timeout=_request_timeout
1603
+ )
1604
+ response_data.read()
1605
+ return self.api_client.response_deserialize(
1606
+ response_data=response_data,
1607
+ response_types_map=_response_types_map,
1608
+ ).data
1609
+
1610
+
1611
+ @validate_call
1612
+ def outbound_integration_endpoints_id_queue_disable_post_with_http_info(
1613
+ self,
1614
+ id: Annotated[StrictStr, Field(description="ID of the outbound integration endpoint for which to disable the event queue")],
1615
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
1616
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
1617
+ _request_timeout: Union[
1618
+ None,
1619
+ Annotated[StrictFloat, Field(gt=0)],
1620
+ Tuple[
1621
+ Annotated[StrictFloat, Field(gt=0)],
1622
+ Annotated[StrictFloat, Field(gt=0)]
1623
+ ]
1624
+ ] = None,
1625
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1626
+ _content_type: Optional[StrictStr] = None,
1627
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1628
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1629
+ ) -> ApiResponse[None]:
1630
+ """Disables the event queue associated with the outbound integration endpoint
1631
+
1632
+ Operation for disabling an event queue associated with an outbound integration endpoint. A 400 response is returned if the endpoint does not have an associated event queue.
1633
+
1634
+ :param id: ID of the outbound integration endpoint for which to disable the event queue (required)
1635
+ :type id: str
1636
+ :param context: ID of the context in which to perform the operation (required)
1637
+ :type context: str
1638
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
1639
+ :type workspace: str
1640
+ :param _request_timeout: timeout setting for this request. If one
1641
+ number provided, it will be total request
1642
+ timeout. It can also be a pair (tuple) of
1643
+ (connection, read) timeouts.
1644
+ :type _request_timeout: int, tuple(int, int), optional
1645
+ :param _request_auth: set to override the auth_settings for an a single
1646
+ request; this effectively ignores the
1647
+ authentication in the spec for a single request.
1648
+ :type _request_auth: dict, optional
1649
+ :param _content_type: force content-type for the request.
1650
+ :type _content_type: str, Optional
1651
+ :param _headers: set to override the headers for a single
1652
+ request; this effectively ignores the headers
1653
+ in the spec for a single request.
1654
+ :type _headers: dict, optional
1655
+ :param _host_index: set to override the host_index for a single
1656
+ request; this effectively ignores the host_index
1657
+ in the spec for a single request.
1658
+ :type _host_index: int, optional
1659
+ :return: Returns the result object.
1660
+ """ # noqa: E501
1661
+
1662
+ _param = self._outbound_integration_endpoints_id_queue_disable_post_serialize(
1663
+ id=id,
1664
+ context=context,
1665
+ workspace=workspace,
1666
+ _request_auth=_request_auth,
1667
+ _content_type=_content_type,
1668
+ _headers=_headers,
1669
+ _host_index=_host_index
1670
+ )
1671
+
1672
+ _response_types_map: Dict[str, Optional[str]] = {
1673
+ '200': None,
1674
+ '400': "Error",
1675
+ '404': "Error",
1676
+ }
1677
+ response_data = self.api_client.call_api(
1678
+ *_param,
1679
+ _request_timeout=_request_timeout
1680
+ )
1681
+ response_data.read()
1682
+ return self.api_client.response_deserialize(
1683
+ response_data=response_data,
1684
+ response_types_map=_response_types_map,
1685
+ )
1686
+
1687
+
1688
+ @validate_call
1689
+ def outbound_integration_endpoints_id_queue_disable_post_without_preload_content(
1690
+ self,
1691
+ id: Annotated[StrictStr, Field(description="ID of the outbound integration endpoint for which to disable the event queue")],
1692
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
1693
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
1694
+ _request_timeout: Union[
1695
+ None,
1696
+ Annotated[StrictFloat, Field(gt=0)],
1697
+ Tuple[
1698
+ Annotated[StrictFloat, Field(gt=0)],
1699
+ Annotated[StrictFloat, Field(gt=0)]
1700
+ ]
1701
+ ] = None,
1702
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1703
+ _content_type: Optional[StrictStr] = None,
1704
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1705
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1706
+ ) -> RESTResponseType:
1707
+ """Disables the event queue associated with the outbound integration endpoint
1708
+
1709
+ Operation for disabling an event queue associated with an outbound integration endpoint. A 400 response is returned if the endpoint does not have an associated event queue.
1710
+
1711
+ :param id: ID of the outbound integration endpoint for which to disable the event queue (required)
1712
+ :type id: str
1713
+ :param context: ID of the context in which to perform the operation (required)
1714
+ :type context: str
1715
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
1716
+ :type workspace: str
1717
+ :param _request_timeout: timeout setting for this request. If one
1718
+ number provided, it will be total request
1719
+ timeout. It can also be a pair (tuple) of
1720
+ (connection, read) timeouts.
1721
+ :type _request_timeout: int, tuple(int, int), optional
1722
+ :param _request_auth: set to override the auth_settings for an a single
1723
+ request; this effectively ignores the
1724
+ authentication in the spec for a single request.
1725
+ :type _request_auth: dict, optional
1726
+ :param _content_type: force content-type for the request.
1727
+ :type _content_type: str, Optional
1728
+ :param _headers: set to override the headers for a single
1729
+ request; this effectively ignores the headers
1730
+ in the spec for a single request.
1731
+ :type _headers: dict, optional
1732
+ :param _host_index: set to override the host_index for a single
1733
+ request; this effectively ignores the host_index
1734
+ in the spec for a single request.
1735
+ :type _host_index: int, optional
1736
+ :return: Returns the result object.
1737
+ """ # noqa: E501
1738
+
1739
+ _param = self._outbound_integration_endpoints_id_queue_disable_post_serialize(
1740
+ id=id,
1741
+ context=context,
1742
+ workspace=workspace,
1743
+ _request_auth=_request_auth,
1744
+ _content_type=_content_type,
1745
+ _headers=_headers,
1746
+ _host_index=_host_index
1747
+ )
1748
+
1749
+ _response_types_map: Dict[str, Optional[str]] = {
1750
+ '200': None,
1751
+ '400': "Error",
1752
+ '404': "Error",
1753
+ }
1754
+ response_data = self.api_client.call_api(
1755
+ *_param,
1756
+ _request_timeout=_request_timeout
1757
+ )
1758
+ return response_data.response
1759
+
1760
+
1761
+ def _outbound_integration_endpoints_id_queue_disable_post_serialize(
1762
+ self,
1763
+ id,
1764
+ context,
1765
+ workspace,
1766
+ _request_auth,
1767
+ _content_type,
1768
+ _headers,
1769
+ _host_index,
1770
+ ) -> RequestSerialized:
1771
+
1772
+ _host = None
1773
+
1774
+ _collection_formats: Dict[str, str] = {
1775
+ }
1776
+
1777
+ _path_params: Dict[str, str] = {}
1778
+ _query_params: List[Tuple[str, str]] = []
1779
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1780
+ _form_params: List[Tuple[str, str]] = []
1781
+ _files: Dict[
1782
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1783
+ ] = {}
1784
+ _body_params: Optional[bytes] = None
1785
+
1786
+ # process the path parameters
1787
+ if id is not None:
1788
+ _path_params['id'] = id
1789
+ # process the query parameters
1790
+ if context is not None:
1791
+
1792
+ _query_params.append(('context', context))
1793
+
1794
+ if workspace is not None:
1795
+
1796
+ _query_params.append(('workspace', workspace))
1797
+
1798
+ # process the header parameters
1799
+ # process the form parameters
1800
+ # process the body parameter
1801
+
1802
+
1803
+ # set the HTTP header `Accept`
1804
+ if 'Accept' not in _header_params:
1805
+ _header_params['Accept'] = self.api_client.select_header_accept(
1806
+ [
1807
+ 'application/json'
1808
+ ]
1809
+ )
1810
+
1811
+
1812
+ # authentication setting
1813
+ _auth_settings: List[str] = [
1814
+ 'basicAuth'
1815
+ ]
1816
+
1817
+ return self.api_client.param_serialize(
1818
+ method='POST',
1819
+ resource_path='/outbound-integration-endpoints/{id}/queue/disable',
1820
+ path_params=_path_params,
1821
+ query_params=_query_params,
1822
+ header_params=_header_params,
1823
+ body=_body_params,
1824
+ post_params=_form_params,
1825
+ files=_files,
1826
+ auth_settings=_auth_settings,
1827
+ collection_formats=_collection_formats,
1828
+ _host=_host,
1829
+ _request_auth=_request_auth
1830
+ )
1831
+
1832
+
1833
+
1834
+
1835
+ @validate_call
1836
+ def outbound_integration_endpoints_id_queue_enable_post(
1837
+ self,
1838
+ id: Annotated[StrictStr, Field(description="ID of the outbound integration endpoint for which to enable the event queue")],
1839
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
1840
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
1841
+ _request_timeout: Union[
1842
+ None,
1843
+ Annotated[StrictFloat, Field(gt=0)],
1844
+ Tuple[
1845
+ Annotated[StrictFloat, Field(gt=0)],
1846
+ Annotated[StrictFloat, Field(gt=0)]
1847
+ ]
1848
+ ] = None,
1849
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1850
+ _content_type: Optional[StrictStr] = None,
1851
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1852
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1853
+ ) -> None:
1854
+ """Enables the event queue associated with the outbound integration endpoint
1855
+
1856
+ Operation for enabling an event queue associated with an outbound integration endpoint. A 400 response is returned if the endpoint does not have an associated event queue.
1857
+
1858
+ :param id: ID of the outbound integration endpoint for which to enable the event queue (required)
1859
+ :type id: str
1860
+ :param context: ID of the context in which to perform the operation (required)
1861
+ :type context: str
1862
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
1863
+ :type workspace: str
1864
+ :param _request_timeout: timeout setting for this request. If one
1865
+ number provided, it will be total request
1866
+ timeout. It can also be a pair (tuple) of
1867
+ (connection, read) timeouts.
1868
+ :type _request_timeout: int, tuple(int, int), optional
1869
+ :param _request_auth: set to override the auth_settings for an a single
1870
+ request; this effectively ignores the
1871
+ authentication in the spec for a single request.
1872
+ :type _request_auth: dict, optional
1873
+ :param _content_type: force content-type for the request.
1874
+ :type _content_type: str, Optional
1875
+ :param _headers: set to override the headers for a single
1876
+ request; this effectively ignores the headers
1877
+ in the spec for a single request.
1878
+ :type _headers: dict, optional
1879
+ :param _host_index: set to override the host_index for a single
1880
+ request; this effectively ignores the host_index
1881
+ in the spec for a single request.
1882
+ :type _host_index: int, optional
1883
+ :return: Returns the result object.
1884
+ """ # noqa: E501
1885
+
1886
+ _param = self._outbound_integration_endpoints_id_queue_enable_post_serialize(
1887
+ id=id,
1888
+ context=context,
1889
+ workspace=workspace,
1890
+ _request_auth=_request_auth,
1891
+ _content_type=_content_type,
1892
+ _headers=_headers,
1893
+ _host_index=_host_index
1894
+ )
1895
+
1896
+ _response_types_map: Dict[str, Optional[str]] = {
1897
+ '200': None,
1898
+ '400': "Error",
1899
+ '404': "Error",
1900
+ }
1901
+ response_data = self.api_client.call_api(
1902
+ *_param,
1903
+ _request_timeout=_request_timeout
1904
+ )
1905
+ response_data.read()
1906
+ return self.api_client.response_deserialize(
1907
+ response_data=response_data,
1908
+ response_types_map=_response_types_map,
1909
+ ).data
1910
+
1911
+
1912
+ @validate_call
1913
+ def outbound_integration_endpoints_id_queue_enable_post_with_http_info(
1914
+ self,
1915
+ id: Annotated[StrictStr, Field(description="ID of the outbound integration endpoint for which to enable the event queue")],
1916
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
1917
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
1918
+ _request_timeout: Union[
1919
+ None,
1920
+ Annotated[StrictFloat, Field(gt=0)],
1921
+ Tuple[
1922
+ Annotated[StrictFloat, Field(gt=0)],
1923
+ Annotated[StrictFloat, Field(gt=0)]
1924
+ ]
1925
+ ] = None,
1926
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1927
+ _content_type: Optional[StrictStr] = None,
1928
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1929
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1930
+ ) -> ApiResponse[None]:
1931
+ """Enables the event queue associated with the outbound integration endpoint
1932
+
1933
+ Operation for enabling an event queue associated with an outbound integration endpoint. A 400 response is returned if the endpoint does not have an associated event queue.
1934
+
1935
+ :param id: ID of the outbound integration endpoint for which to enable the event queue (required)
1936
+ :type id: str
1937
+ :param context: ID of the context in which to perform the operation (required)
1938
+ :type context: str
1939
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
1940
+ :type workspace: str
1941
+ :param _request_timeout: timeout setting for this request. If one
1942
+ number provided, it will be total request
1943
+ timeout. It can also be a pair (tuple) of
1944
+ (connection, read) timeouts.
1945
+ :type _request_timeout: int, tuple(int, int), optional
1946
+ :param _request_auth: set to override the auth_settings for an a single
1947
+ request; this effectively ignores the
1948
+ authentication in the spec for a single request.
1949
+ :type _request_auth: dict, optional
1950
+ :param _content_type: force content-type for the request.
1951
+ :type _content_type: str, Optional
1952
+ :param _headers: set to override the headers for a single
1953
+ request; this effectively ignores the headers
1954
+ in the spec for a single request.
1955
+ :type _headers: dict, optional
1956
+ :param _host_index: set to override the host_index for a single
1957
+ request; this effectively ignores the host_index
1958
+ in the spec for a single request.
1959
+ :type _host_index: int, optional
1960
+ :return: Returns the result object.
1961
+ """ # noqa: E501
1962
+
1963
+ _param = self._outbound_integration_endpoints_id_queue_enable_post_serialize(
1964
+ id=id,
1965
+ context=context,
1966
+ workspace=workspace,
1967
+ _request_auth=_request_auth,
1968
+ _content_type=_content_type,
1969
+ _headers=_headers,
1970
+ _host_index=_host_index
1971
+ )
1972
+
1973
+ _response_types_map: Dict[str, Optional[str]] = {
1974
+ '200': None,
1975
+ '400': "Error",
1976
+ '404': "Error",
1977
+ }
1978
+ response_data = self.api_client.call_api(
1979
+ *_param,
1980
+ _request_timeout=_request_timeout
1981
+ )
1982
+ response_data.read()
1983
+ return self.api_client.response_deserialize(
1984
+ response_data=response_data,
1985
+ response_types_map=_response_types_map,
1986
+ )
1987
+
1988
+
1989
+ @validate_call
1990
+ def outbound_integration_endpoints_id_queue_enable_post_without_preload_content(
1991
+ self,
1992
+ id: Annotated[StrictStr, Field(description="ID of the outbound integration endpoint for which to enable the event queue")],
1993
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
1994
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
1995
+ _request_timeout: Union[
1996
+ None,
1997
+ Annotated[StrictFloat, Field(gt=0)],
1998
+ Tuple[
1999
+ Annotated[StrictFloat, Field(gt=0)],
2000
+ Annotated[StrictFloat, Field(gt=0)]
2001
+ ]
2002
+ ] = None,
2003
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2004
+ _content_type: Optional[StrictStr] = None,
2005
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2006
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2007
+ ) -> RESTResponseType:
2008
+ """Enables the event queue associated with the outbound integration endpoint
2009
+
2010
+ Operation for enabling an event queue associated with an outbound integration endpoint. A 400 response is returned if the endpoint does not have an associated event queue.
2011
+
2012
+ :param id: ID of the outbound integration endpoint for which to enable the event queue (required)
2013
+ :type id: str
2014
+ :param context: ID of the context in which to perform the operation (required)
2015
+ :type context: str
2016
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
2017
+ :type workspace: str
2018
+ :param _request_timeout: timeout setting for this request. If one
2019
+ number provided, it will be total request
2020
+ timeout. It can also be a pair (tuple) of
2021
+ (connection, read) timeouts.
2022
+ :type _request_timeout: int, tuple(int, int), optional
2023
+ :param _request_auth: set to override the auth_settings for an a single
2024
+ request; this effectively ignores the
2025
+ authentication in the spec for a single request.
2026
+ :type _request_auth: dict, optional
2027
+ :param _content_type: force content-type for the request.
2028
+ :type _content_type: str, Optional
2029
+ :param _headers: set to override the headers for a single
2030
+ request; this effectively ignores the headers
2031
+ in the spec for a single request.
2032
+ :type _headers: dict, optional
2033
+ :param _host_index: set to override the host_index for a single
2034
+ request; this effectively ignores the host_index
2035
+ in the spec for a single request.
2036
+ :type _host_index: int, optional
2037
+ :return: Returns the result object.
2038
+ """ # noqa: E501
2039
+
2040
+ _param = self._outbound_integration_endpoints_id_queue_enable_post_serialize(
2041
+ id=id,
2042
+ context=context,
2043
+ workspace=workspace,
2044
+ _request_auth=_request_auth,
2045
+ _content_type=_content_type,
2046
+ _headers=_headers,
2047
+ _host_index=_host_index
2048
+ )
2049
+
2050
+ _response_types_map: Dict[str, Optional[str]] = {
2051
+ '200': None,
2052
+ '400': "Error",
2053
+ '404': "Error",
2054
+ }
2055
+ response_data = self.api_client.call_api(
2056
+ *_param,
2057
+ _request_timeout=_request_timeout
2058
+ )
2059
+ return response_data.response
2060
+
2061
+
2062
+ def _outbound_integration_endpoints_id_queue_enable_post_serialize(
2063
+ self,
2064
+ id,
2065
+ context,
2066
+ workspace,
2067
+ _request_auth,
2068
+ _content_type,
2069
+ _headers,
2070
+ _host_index,
2071
+ ) -> RequestSerialized:
2072
+
2073
+ _host = None
2074
+
2075
+ _collection_formats: Dict[str, str] = {
2076
+ }
2077
+
2078
+ _path_params: Dict[str, str] = {}
2079
+ _query_params: List[Tuple[str, str]] = []
2080
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2081
+ _form_params: List[Tuple[str, str]] = []
2082
+ _files: Dict[
2083
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2084
+ ] = {}
2085
+ _body_params: Optional[bytes] = None
2086
+
2087
+ # process the path parameters
2088
+ if id is not None:
2089
+ _path_params['id'] = id
2090
+ # process the query parameters
2091
+ if context is not None:
2092
+
2093
+ _query_params.append(('context', context))
2094
+
2095
+ if workspace is not None:
2096
+
2097
+ _query_params.append(('workspace', workspace))
2098
+
2099
+ # process the header parameters
2100
+ # process the form parameters
2101
+ # process the body parameter
2102
+
2103
+
2104
+ # set the HTTP header `Accept`
2105
+ if 'Accept' not in _header_params:
2106
+ _header_params['Accept'] = self.api_client.select_header_accept(
2107
+ [
2108
+ 'application/json'
2109
+ ]
2110
+ )
2111
+
2112
+
2113
+ # authentication setting
2114
+ _auth_settings: List[str] = [
2115
+ 'basicAuth'
2116
+ ]
2117
+
2118
+ return self.api_client.param_serialize(
2119
+ method='POST',
2120
+ resource_path='/outbound-integration-endpoints/{id}/queue/enable',
2121
+ path_params=_path_params,
2122
+ query_params=_query_params,
2123
+ header_params=_header_params,
2124
+ body=_body_params,
2125
+ post_params=_form_params,
2126
+ files=_files,
2127
+ auth_settings=_auth_settings,
2128
+ collection_formats=_collection_formats,
2129
+ _host=_host,
2130
+ _request_auth=_request_auth
2131
+ )
2132
+
2133
+
2134
+
2135
+
2136
+ @validate_call
2137
+ def outbound_integration_endpoints_id_queue_number_of_unread_events_get(
2138
+ self,
2139
+ id: Annotated[StrictStr, Field(description="ID of the outbound integration endpoint for which to retrieve the number of unread events")],
2140
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
2141
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
2142
+ _request_timeout: Union[
2143
+ None,
2144
+ Annotated[StrictFloat, Field(gt=0)],
2145
+ Tuple[
2146
+ Annotated[StrictFloat, Field(gt=0)],
2147
+ Annotated[StrictFloat, Field(gt=0)]
2148
+ ]
2149
+ ] = None,
2150
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2151
+ _content_type: Optional[StrictStr] = None,
2152
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2153
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2154
+ ) -> Amount:
2155
+ """Returns the number of unread events for the associated event queue
2156
+
2157
+ Operation for retrieving the number of unread events for event queue associated with a specific outbound integration endpoint. The count will be cached for up to 15 seconds server-side. A 400 response is returned if the endpoint does not have an associated event queue.
2158
+
2159
+ :param id: ID of the outbound integration endpoint for which to retrieve the number of unread events (required)
2160
+ :type id: str
2161
+ :param context: ID of the context in which to perform the operation (required)
2162
+ :type context: str
2163
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
2164
+ :type workspace: str
2165
+ :param _request_timeout: timeout setting for this request. If one
2166
+ number provided, it will be total request
2167
+ timeout. It can also be a pair (tuple) of
2168
+ (connection, read) timeouts.
2169
+ :type _request_timeout: int, tuple(int, int), optional
2170
+ :param _request_auth: set to override the auth_settings for an a single
2171
+ request; this effectively ignores the
2172
+ authentication in the spec for a single request.
2173
+ :type _request_auth: dict, optional
2174
+ :param _content_type: force content-type for the request.
2175
+ :type _content_type: str, Optional
2176
+ :param _headers: set to override the headers for a single
2177
+ request; this effectively ignores the headers
2178
+ in the spec for a single request.
2179
+ :type _headers: dict, optional
2180
+ :param _host_index: set to override the host_index for a single
2181
+ request; this effectively ignores the host_index
2182
+ in the spec for a single request.
2183
+ :type _host_index: int, optional
2184
+ :return: Returns the result object.
2185
+ """ # noqa: E501
2186
+
2187
+ _param = self._outbound_integration_endpoints_id_queue_number_of_unread_events_get_serialize(
2188
+ id=id,
2189
+ context=context,
2190
+ workspace=workspace,
2191
+ _request_auth=_request_auth,
2192
+ _content_type=_content_type,
2193
+ _headers=_headers,
2194
+ _host_index=_host_index
2195
+ )
2196
+
2197
+ _response_types_map: Dict[str, Optional[str]] = {
2198
+ '200': "Amount",
2199
+ '400': "Error",
2200
+ '404': "Error",
2201
+ }
2202
+ response_data = self.api_client.call_api(
2203
+ *_param,
2204
+ _request_timeout=_request_timeout
2205
+ )
2206
+ response_data.read()
2207
+ return self.api_client.response_deserialize(
2208
+ response_data=response_data,
2209
+ response_types_map=_response_types_map,
2210
+ ).data
2211
+
2212
+
2213
+ @validate_call
2214
+ def outbound_integration_endpoints_id_queue_number_of_unread_events_get_with_http_info(
2215
+ self,
2216
+ id: Annotated[StrictStr, Field(description="ID of the outbound integration endpoint for which to retrieve the number of unread events")],
2217
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
2218
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
2219
+ _request_timeout: Union[
2220
+ None,
2221
+ Annotated[StrictFloat, Field(gt=0)],
2222
+ Tuple[
2223
+ Annotated[StrictFloat, Field(gt=0)],
2224
+ Annotated[StrictFloat, Field(gt=0)]
2225
+ ]
2226
+ ] = None,
2227
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2228
+ _content_type: Optional[StrictStr] = None,
2229
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2230
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2231
+ ) -> ApiResponse[Amount]:
2232
+ """Returns the number of unread events for the associated event queue
2233
+
2234
+ Operation for retrieving the number of unread events for event queue associated with a specific outbound integration endpoint. The count will be cached for up to 15 seconds server-side. A 400 response is returned if the endpoint does not have an associated event queue.
2235
+
2236
+ :param id: ID of the outbound integration endpoint for which to retrieve the number of unread events (required)
2237
+ :type id: str
2238
+ :param context: ID of the context in which to perform the operation (required)
2239
+ :type context: str
2240
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
2241
+ :type workspace: str
2242
+ :param _request_timeout: timeout setting for this request. If one
2243
+ number provided, it will be total request
2244
+ timeout. It can also be a pair (tuple) of
2245
+ (connection, read) timeouts.
2246
+ :type _request_timeout: int, tuple(int, int), optional
2247
+ :param _request_auth: set to override the auth_settings for an a single
2248
+ request; this effectively ignores the
2249
+ authentication in the spec for a single request.
2250
+ :type _request_auth: dict, optional
2251
+ :param _content_type: force content-type for the request.
2252
+ :type _content_type: str, Optional
2253
+ :param _headers: set to override the headers for a single
2254
+ request; this effectively ignores the headers
2255
+ in the spec for a single request.
2256
+ :type _headers: dict, optional
2257
+ :param _host_index: set to override the host_index for a single
2258
+ request; this effectively ignores the host_index
2259
+ in the spec for a single request.
2260
+ :type _host_index: int, optional
2261
+ :return: Returns the result object.
2262
+ """ # noqa: E501
2263
+
2264
+ _param = self._outbound_integration_endpoints_id_queue_number_of_unread_events_get_serialize(
2265
+ id=id,
2266
+ context=context,
2267
+ workspace=workspace,
2268
+ _request_auth=_request_auth,
2269
+ _content_type=_content_type,
2270
+ _headers=_headers,
2271
+ _host_index=_host_index
2272
+ )
2273
+
2274
+ _response_types_map: Dict[str, Optional[str]] = {
2275
+ '200': "Amount",
2276
+ '400': "Error",
2277
+ '404': "Error",
2278
+ }
2279
+ response_data = self.api_client.call_api(
2280
+ *_param,
2281
+ _request_timeout=_request_timeout
2282
+ )
2283
+ response_data.read()
2284
+ return self.api_client.response_deserialize(
2285
+ response_data=response_data,
2286
+ response_types_map=_response_types_map,
2287
+ )
2288
+
2289
+
2290
+ @validate_call
2291
+ def outbound_integration_endpoints_id_queue_number_of_unread_events_get_without_preload_content(
2292
+ self,
2293
+ id: Annotated[StrictStr, Field(description="ID of the outbound integration endpoint for which to retrieve the number of unread events")],
2294
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
2295
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
2296
+ _request_timeout: Union[
2297
+ None,
2298
+ Annotated[StrictFloat, Field(gt=0)],
2299
+ Tuple[
2300
+ Annotated[StrictFloat, Field(gt=0)],
2301
+ Annotated[StrictFloat, Field(gt=0)]
2302
+ ]
2303
+ ] = None,
2304
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2305
+ _content_type: Optional[StrictStr] = None,
2306
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2307
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2308
+ ) -> RESTResponseType:
2309
+ """Returns the number of unread events for the associated event queue
2310
+
2311
+ Operation for retrieving the number of unread events for event queue associated with a specific outbound integration endpoint. The count will be cached for up to 15 seconds server-side. A 400 response is returned if the endpoint does not have an associated event queue.
2312
+
2313
+ :param id: ID of the outbound integration endpoint for which to retrieve the number of unread events (required)
2314
+ :type id: str
2315
+ :param context: ID of the context in which to perform the operation (required)
2316
+ :type context: str
2317
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
2318
+ :type workspace: str
2319
+ :param _request_timeout: timeout setting for this request. If one
2320
+ number provided, it will be total request
2321
+ timeout. It can also be a pair (tuple) of
2322
+ (connection, read) timeouts.
2323
+ :type _request_timeout: int, tuple(int, int), optional
2324
+ :param _request_auth: set to override the auth_settings for an a single
2325
+ request; this effectively ignores the
2326
+ authentication in the spec for a single request.
2327
+ :type _request_auth: dict, optional
2328
+ :param _content_type: force content-type for the request.
2329
+ :type _content_type: str, Optional
2330
+ :param _headers: set to override the headers for a single
2331
+ request; this effectively ignores the headers
2332
+ in the spec for a single request.
2333
+ :type _headers: dict, optional
2334
+ :param _host_index: set to override the host_index for a single
2335
+ request; this effectively ignores the host_index
2336
+ in the spec for a single request.
2337
+ :type _host_index: int, optional
2338
+ :return: Returns the result object.
2339
+ """ # noqa: E501
2340
+
2341
+ _param = self._outbound_integration_endpoints_id_queue_number_of_unread_events_get_serialize(
2342
+ id=id,
2343
+ context=context,
2344
+ workspace=workspace,
2345
+ _request_auth=_request_auth,
2346
+ _content_type=_content_type,
2347
+ _headers=_headers,
2348
+ _host_index=_host_index
2349
+ )
2350
+
2351
+ _response_types_map: Dict[str, Optional[str]] = {
2352
+ '200': "Amount",
2353
+ '400': "Error",
2354
+ '404': "Error",
2355
+ }
2356
+ response_data = self.api_client.call_api(
2357
+ *_param,
2358
+ _request_timeout=_request_timeout
2359
+ )
2360
+ return response_data.response
2361
+
2362
+
2363
+ def _outbound_integration_endpoints_id_queue_number_of_unread_events_get_serialize(
2364
+ self,
2365
+ id,
2366
+ context,
2367
+ workspace,
2368
+ _request_auth,
2369
+ _content_type,
2370
+ _headers,
2371
+ _host_index,
2372
+ ) -> RequestSerialized:
2373
+
2374
+ _host = None
2375
+
2376
+ _collection_formats: Dict[str, str] = {
2377
+ }
2378
+
2379
+ _path_params: Dict[str, str] = {}
2380
+ _query_params: List[Tuple[str, str]] = []
2381
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2382
+ _form_params: List[Tuple[str, str]] = []
2383
+ _files: Dict[
2384
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2385
+ ] = {}
2386
+ _body_params: Optional[bytes] = None
2387
+
2388
+ # process the path parameters
2389
+ if id is not None:
2390
+ _path_params['id'] = id
2391
+ # process the query parameters
2392
+ if context is not None:
2393
+
2394
+ _query_params.append(('context', context))
2395
+
2396
+ if workspace is not None:
2397
+
2398
+ _query_params.append(('workspace', workspace))
2399
+
2400
+ # process the header parameters
2401
+ # process the form parameters
2402
+ # process the body parameter
2403
+
2404
+
2405
+ # set the HTTP header `Accept`
2406
+ if 'Accept' not in _header_params:
2407
+ _header_params['Accept'] = self.api_client.select_header_accept(
2408
+ [
2409
+ 'application/json'
2410
+ ]
2411
+ )
2412
+
2413
+
2414
+ # authentication setting
2415
+ _auth_settings: List[str] = [
2416
+ 'basicAuth'
2417
+ ]
2418
+
2419
+ return self.api_client.param_serialize(
2420
+ method='GET',
2421
+ resource_path='/outbound-integration-endpoints/{id}/queue/number-of-unread-events',
2422
+ path_params=_path_params,
2423
+ query_params=_query_params,
2424
+ header_params=_header_params,
2425
+ body=_body_params,
2426
+ post_params=_form_params,
2427
+ files=_files,
2428
+ auth_settings=_auth_settings,
2429
+ collection_formats=_collection_formats,
2430
+ _host=_host,
2431
+ _request_auth=_request_auth
2432
+ )
2433
+
2434
+
2435
+
2436
+
2437
+ @validate_call
2438
+ def outbound_integration_endpoints_id_queue_status_get(
2439
+ self,
2440
+ id: Annotated[StrictStr, Field(description="ID of the outbound integration endpoint for which to retrieve the event queue status")],
2441
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
2442
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
2443
+ _request_timeout: Union[
2444
+ None,
2445
+ Annotated[StrictFloat, Field(gt=0)],
2446
+ Tuple[
2447
+ Annotated[StrictFloat, Field(gt=0)],
2448
+ Annotated[StrictFloat, Field(gt=0)]
2449
+ ]
2450
+ ] = None,
2451
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2452
+ _content_type: Optional[StrictStr] = None,
2453
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2454
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2455
+ ) -> EventQueueStatus:
2456
+ """Returns the status of the event queue associated with the outbound integration endpoint
2457
+
2458
+ Operation for retrieving status information for an event queue associated with an outbound integration endpoint. A 400 response is returned if the endpoint does not have an associated event queue.
2459
+
2460
+ :param id: ID of the outbound integration endpoint for which to retrieve the event queue status (required)
2461
+ :type id: str
2462
+ :param context: ID of the context in which to perform the operation (required)
2463
+ :type context: str
2464
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
2465
+ :type workspace: str
2466
+ :param _request_timeout: timeout setting for this request. If one
2467
+ number provided, it will be total request
2468
+ timeout. It can also be a pair (tuple) of
2469
+ (connection, read) timeouts.
2470
+ :type _request_timeout: int, tuple(int, int), optional
2471
+ :param _request_auth: set to override the auth_settings for an a single
2472
+ request; this effectively ignores the
2473
+ authentication in the spec for a single request.
2474
+ :type _request_auth: dict, optional
2475
+ :param _content_type: force content-type for the request.
2476
+ :type _content_type: str, Optional
2477
+ :param _headers: set to override the headers for a single
2478
+ request; this effectively ignores the headers
2479
+ in the spec for a single request.
2480
+ :type _headers: dict, optional
2481
+ :param _host_index: set to override the host_index for a single
2482
+ request; this effectively ignores the host_index
2483
+ in the spec for a single request.
2484
+ :type _host_index: int, optional
2485
+ :return: Returns the result object.
2486
+ """ # noqa: E501
2487
+
2488
+ _param = self._outbound_integration_endpoints_id_queue_status_get_serialize(
2489
+ id=id,
2490
+ context=context,
2491
+ workspace=workspace,
2492
+ _request_auth=_request_auth,
2493
+ _content_type=_content_type,
2494
+ _headers=_headers,
2495
+ _host_index=_host_index
2496
+ )
2497
+
2498
+ _response_types_map: Dict[str, Optional[str]] = {
2499
+ '200': "EventQueueStatus",
2500
+ '400': "Error",
2501
+ '404': "Error",
2502
+ }
2503
+ response_data = self.api_client.call_api(
2504
+ *_param,
2505
+ _request_timeout=_request_timeout
2506
+ )
2507
+ response_data.read()
2508
+ return self.api_client.response_deserialize(
2509
+ response_data=response_data,
2510
+ response_types_map=_response_types_map,
2511
+ ).data
2512
+
2513
+
2514
+ @validate_call
2515
+ def outbound_integration_endpoints_id_queue_status_get_with_http_info(
2516
+ self,
2517
+ id: Annotated[StrictStr, Field(description="ID of the outbound integration endpoint for which to retrieve the event queue status")],
2518
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
2519
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
2520
+ _request_timeout: Union[
2521
+ None,
2522
+ Annotated[StrictFloat, Field(gt=0)],
2523
+ Tuple[
2524
+ Annotated[StrictFloat, Field(gt=0)],
2525
+ Annotated[StrictFloat, Field(gt=0)]
2526
+ ]
2527
+ ] = None,
2528
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2529
+ _content_type: Optional[StrictStr] = None,
2530
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2531
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2532
+ ) -> ApiResponse[EventQueueStatus]:
2533
+ """Returns the status of the event queue associated with the outbound integration endpoint
2534
+
2535
+ Operation for retrieving status information for an event queue associated with an outbound integration endpoint. A 400 response is returned if the endpoint does not have an associated event queue.
2536
+
2537
+ :param id: ID of the outbound integration endpoint for which to retrieve the event queue status (required)
2538
+ :type id: str
2539
+ :param context: ID of the context in which to perform the operation (required)
2540
+ :type context: str
2541
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
2542
+ :type workspace: str
2543
+ :param _request_timeout: timeout setting for this request. If one
2544
+ number provided, it will be total request
2545
+ timeout. It can also be a pair (tuple) of
2546
+ (connection, read) timeouts.
2547
+ :type _request_timeout: int, tuple(int, int), optional
2548
+ :param _request_auth: set to override the auth_settings for an a single
2549
+ request; this effectively ignores the
2550
+ authentication in the spec for a single request.
2551
+ :type _request_auth: dict, optional
2552
+ :param _content_type: force content-type for the request.
2553
+ :type _content_type: str, Optional
2554
+ :param _headers: set to override the headers for a single
2555
+ request; this effectively ignores the headers
2556
+ in the spec for a single request.
2557
+ :type _headers: dict, optional
2558
+ :param _host_index: set to override the host_index for a single
2559
+ request; this effectively ignores the host_index
2560
+ in the spec for a single request.
2561
+ :type _host_index: int, optional
2562
+ :return: Returns the result object.
2563
+ """ # noqa: E501
2564
+
2565
+ _param = self._outbound_integration_endpoints_id_queue_status_get_serialize(
2566
+ id=id,
2567
+ context=context,
2568
+ workspace=workspace,
2569
+ _request_auth=_request_auth,
2570
+ _content_type=_content_type,
2571
+ _headers=_headers,
2572
+ _host_index=_host_index
2573
+ )
2574
+
2575
+ _response_types_map: Dict[str, Optional[str]] = {
2576
+ '200': "EventQueueStatus",
2577
+ '400': "Error",
2578
+ '404': "Error",
2579
+ }
2580
+ response_data = self.api_client.call_api(
2581
+ *_param,
2582
+ _request_timeout=_request_timeout
2583
+ )
2584
+ response_data.read()
2585
+ return self.api_client.response_deserialize(
2586
+ response_data=response_data,
2587
+ response_types_map=_response_types_map,
2588
+ )
2589
+
2590
+
2591
+ @validate_call
2592
+ def outbound_integration_endpoints_id_queue_status_get_without_preload_content(
2593
+ self,
2594
+ id: Annotated[StrictStr, Field(description="ID of the outbound integration endpoint for which to retrieve the event queue status")],
2595
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
2596
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
2597
+ _request_timeout: Union[
2598
+ None,
2599
+ Annotated[StrictFloat, Field(gt=0)],
2600
+ Tuple[
2601
+ Annotated[StrictFloat, Field(gt=0)],
2602
+ Annotated[StrictFloat, Field(gt=0)]
2603
+ ]
2604
+ ] = None,
2605
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2606
+ _content_type: Optional[StrictStr] = None,
2607
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2608
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2609
+ ) -> RESTResponseType:
2610
+ """Returns the status of the event queue associated with the outbound integration endpoint
2611
+
2612
+ Operation for retrieving status information for an event queue associated with an outbound integration endpoint. A 400 response is returned if the endpoint does not have an associated event queue.
2613
+
2614
+ :param id: ID of the outbound integration endpoint for which to retrieve the event queue status (required)
2615
+ :type id: str
2616
+ :param context: ID of the context in which to perform the operation (required)
2617
+ :type context: str
2618
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
2619
+ :type workspace: str
2620
+ :param _request_timeout: timeout setting for this request. If one
2621
+ number provided, it will be total request
2622
+ timeout. It can also be a pair (tuple) of
2623
+ (connection, read) timeouts.
2624
+ :type _request_timeout: int, tuple(int, int), optional
2625
+ :param _request_auth: set to override the auth_settings for an a single
2626
+ request; this effectively ignores the
2627
+ authentication in the spec for a single request.
2628
+ :type _request_auth: dict, optional
2629
+ :param _content_type: force content-type for the request.
2630
+ :type _content_type: str, Optional
2631
+ :param _headers: set to override the headers for a single
2632
+ request; this effectively ignores the headers
2633
+ in the spec for a single request.
2634
+ :type _headers: dict, optional
2635
+ :param _host_index: set to override the host_index for a single
2636
+ request; this effectively ignores the host_index
2637
+ in the spec for a single request.
2638
+ :type _host_index: int, optional
2639
+ :return: Returns the result object.
2640
+ """ # noqa: E501
2641
+
2642
+ _param = self._outbound_integration_endpoints_id_queue_status_get_serialize(
2643
+ id=id,
2644
+ context=context,
2645
+ workspace=workspace,
2646
+ _request_auth=_request_auth,
2647
+ _content_type=_content_type,
2648
+ _headers=_headers,
2649
+ _host_index=_host_index
2650
+ )
2651
+
2652
+ _response_types_map: Dict[str, Optional[str]] = {
2653
+ '200': "EventQueueStatus",
2654
+ '400': "Error",
2655
+ '404': "Error",
2656
+ }
2657
+ response_data = self.api_client.call_api(
2658
+ *_param,
2659
+ _request_timeout=_request_timeout
2660
+ )
2661
+ return response_data.response
2662
+
2663
+
2664
+ def _outbound_integration_endpoints_id_queue_status_get_serialize(
2665
+ self,
2666
+ id,
2667
+ context,
2668
+ workspace,
2669
+ _request_auth,
2670
+ _content_type,
2671
+ _headers,
2672
+ _host_index,
2673
+ ) -> RequestSerialized:
2674
+
2675
+ _host = None
2676
+
2677
+ _collection_formats: Dict[str, str] = {
2678
+ }
2679
+
2680
+ _path_params: Dict[str, str] = {}
2681
+ _query_params: List[Tuple[str, str]] = []
2682
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2683
+ _form_params: List[Tuple[str, str]] = []
2684
+ _files: Dict[
2685
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2686
+ ] = {}
2687
+ _body_params: Optional[bytes] = None
2688
+
2689
+ # process the path parameters
2690
+ if id is not None:
2691
+ _path_params['id'] = id
2692
+ # process the query parameters
2693
+ if context is not None:
2694
+
2695
+ _query_params.append(('context', context))
2696
+
2697
+ if workspace is not None:
2698
+
2699
+ _query_params.append(('workspace', workspace))
2700
+
2701
+ # process the header parameters
2702
+ # process the form parameters
2703
+ # process the body parameter
2704
+
2705
+
2706
+ # set the HTTP header `Accept`
2707
+ if 'Accept' not in _header_params:
2708
+ _header_params['Accept'] = self.api_client.select_header_accept(
2709
+ [
2710
+ 'application/json'
2711
+ ]
2712
+ )
2713
+
2714
+
2715
+ # authentication setting
2716
+ _auth_settings: List[str] = [
2717
+ 'basicAuth'
2718
+ ]
2719
+
2720
+ return self.api_client.param_serialize(
2721
+ method='GET',
2722
+ resource_path='/outbound-integration-endpoints/{id}/queue/status',
2723
+ path_params=_path_params,
2724
+ query_params=_query_params,
2725
+ header_params=_header_params,
2726
+ body=_body_params,
2727
+ post_params=_form_params,
2728
+ files=_files,
2729
+ auth_settings=_auth_settings,
2730
+ collection_formats=_collection_formats,
2731
+ _host=_host,
2732
+ _request_auth=_request_auth
2733
+ )
2734
+
2735
+
2736
+
2737
+
2738
+ @validate_call
2739
+ def outbound_integration_endpoints_id_statistics_get(
2740
+ self,
2741
+ id: Annotated[StrictStr, Field(description="ID of the outbound integration endpoint for which to retrieve the statistics")],
2742
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
2743
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
2744
+ _request_timeout: Union[
2745
+ None,
2746
+ Annotated[StrictFloat, Field(gt=0)],
2747
+ Tuple[
2748
+ Annotated[StrictFloat, Field(gt=0)],
2749
+ Annotated[StrictFloat, Field(gt=0)]
2750
+ ]
2751
+ ] = None,
2752
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2753
+ _content_type: Optional[StrictStr] = None,
2754
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2755
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2756
+ ) -> EndpointStatistics:
2757
+ """Returns statistics for the specified outbound integration endpoint
2758
+
2759
+ Operation for retrieving statistics for a specific outbound integration endpoint
2760
+
2761
+ :param id: ID of the outbound integration endpoint for which to retrieve the statistics (required)
2762
+ :type id: str
2763
+ :param context: ID of the context in which to perform the operation (required)
2764
+ :type context: str
2765
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
2766
+ :type workspace: str
2767
+ :param _request_timeout: timeout setting for this request. If one
2768
+ number provided, it will be total request
2769
+ timeout. It can also be a pair (tuple) of
2770
+ (connection, read) timeouts.
2771
+ :type _request_timeout: int, tuple(int, int), optional
2772
+ :param _request_auth: set to override the auth_settings for an a single
2773
+ request; this effectively ignores the
2774
+ authentication in the spec for a single request.
2775
+ :type _request_auth: dict, optional
2776
+ :param _content_type: force content-type for the request.
2777
+ :type _content_type: str, Optional
2778
+ :param _headers: set to override the headers for a single
2779
+ request; this effectively ignores the headers
2780
+ in the spec for a single request.
2781
+ :type _headers: dict, optional
2782
+ :param _host_index: set to override the host_index for a single
2783
+ request; this effectively ignores the host_index
2784
+ in the spec for a single request.
2785
+ :type _host_index: int, optional
2786
+ :return: Returns the result object.
2787
+ """ # noqa: E501
2788
+
2789
+ _param = self._outbound_integration_endpoints_id_statistics_get_serialize(
2790
+ id=id,
2791
+ context=context,
2792
+ workspace=workspace,
2793
+ _request_auth=_request_auth,
2794
+ _content_type=_content_type,
2795
+ _headers=_headers,
2796
+ _host_index=_host_index
2797
+ )
2798
+
2799
+ _response_types_map: Dict[str, Optional[str]] = {
2800
+ '200': "EndpointStatistics",
2801
+ '400': "Error",
2802
+ '404': "Error",
2803
+ }
2804
+ response_data = self.api_client.call_api(
2805
+ *_param,
2806
+ _request_timeout=_request_timeout
2807
+ )
2808
+ response_data.read()
2809
+ return self.api_client.response_deserialize(
2810
+ response_data=response_data,
2811
+ response_types_map=_response_types_map,
2812
+ ).data
2813
+
2814
+
2815
+ @validate_call
2816
+ def outbound_integration_endpoints_id_statistics_get_with_http_info(
2817
+ self,
2818
+ id: Annotated[StrictStr, Field(description="ID of the outbound integration endpoint for which to retrieve the statistics")],
2819
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
2820
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
2821
+ _request_timeout: Union[
2822
+ None,
2823
+ Annotated[StrictFloat, Field(gt=0)],
2824
+ Tuple[
2825
+ Annotated[StrictFloat, Field(gt=0)],
2826
+ Annotated[StrictFloat, Field(gt=0)]
2827
+ ]
2828
+ ] = None,
2829
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2830
+ _content_type: Optional[StrictStr] = None,
2831
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2832
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2833
+ ) -> ApiResponse[EndpointStatistics]:
2834
+ """Returns statistics for the specified outbound integration endpoint
2835
+
2836
+ Operation for retrieving statistics for a specific outbound integration endpoint
2837
+
2838
+ :param id: ID of the outbound integration endpoint for which to retrieve the statistics (required)
2839
+ :type id: str
2840
+ :param context: ID of the context in which to perform the operation (required)
2841
+ :type context: str
2842
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
2843
+ :type workspace: str
2844
+ :param _request_timeout: timeout setting for this request. If one
2845
+ number provided, it will be total request
2846
+ timeout. It can also be a pair (tuple) of
2847
+ (connection, read) timeouts.
2848
+ :type _request_timeout: int, tuple(int, int), optional
2849
+ :param _request_auth: set to override the auth_settings for an a single
2850
+ request; this effectively ignores the
2851
+ authentication in the spec for a single request.
2852
+ :type _request_auth: dict, optional
2853
+ :param _content_type: force content-type for the request.
2854
+ :type _content_type: str, Optional
2855
+ :param _headers: set to override the headers for a single
2856
+ request; this effectively ignores the headers
2857
+ in the spec for a single request.
2858
+ :type _headers: dict, optional
2859
+ :param _host_index: set to override the host_index for a single
2860
+ request; this effectively ignores the host_index
2861
+ in the spec for a single request.
2862
+ :type _host_index: int, optional
2863
+ :return: Returns the result object.
2864
+ """ # noqa: E501
2865
+
2866
+ _param = self._outbound_integration_endpoints_id_statistics_get_serialize(
2867
+ id=id,
2868
+ context=context,
2869
+ workspace=workspace,
2870
+ _request_auth=_request_auth,
2871
+ _content_type=_content_type,
2872
+ _headers=_headers,
2873
+ _host_index=_host_index
2874
+ )
2875
+
2876
+ _response_types_map: Dict[str, Optional[str]] = {
2877
+ '200': "EndpointStatistics",
2878
+ '400': "Error",
2879
+ '404': "Error",
2880
+ }
2881
+ response_data = self.api_client.call_api(
2882
+ *_param,
2883
+ _request_timeout=_request_timeout
2884
+ )
2885
+ response_data.read()
2886
+ return self.api_client.response_deserialize(
2887
+ response_data=response_data,
2888
+ response_types_map=_response_types_map,
2889
+ )
2890
+
2891
+
2892
+ @validate_call
2893
+ def outbound_integration_endpoints_id_statistics_get_without_preload_content(
2894
+ self,
2895
+ id: Annotated[StrictStr, Field(description="ID of the outbound integration endpoint for which to retrieve the statistics")],
2896
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
2897
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
2898
+ _request_timeout: Union[
2899
+ None,
2900
+ Annotated[StrictFloat, Field(gt=0)],
2901
+ Tuple[
2902
+ Annotated[StrictFloat, Field(gt=0)],
2903
+ Annotated[StrictFloat, Field(gt=0)]
2904
+ ]
2905
+ ] = None,
2906
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2907
+ _content_type: Optional[StrictStr] = None,
2908
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2909
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2910
+ ) -> RESTResponseType:
2911
+ """Returns statistics for the specified outbound integration endpoint
2912
+
2913
+ Operation for retrieving statistics for a specific outbound integration endpoint
2914
+
2915
+ :param id: ID of the outbound integration endpoint for which to retrieve the statistics (required)
2916
+ :type id: str
2917
+ :param context: ID of the context in which to perform the operation (required)
2918
+ :type context: str
2919
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
2920
+ :type workspace: str
2921
+ :param _request_timeout: timeout setting for this request. If one
2922
+ number provided, it will be total request
2923
+ timeout. It can also be a pair (tuple) of
2924
+ (connection, read) timeouts.
2925
+ :type _request_timeout: int, tuple(int, int), optional
2926
+ :param _request_auth: set to override the auth_settings for an a single
2927
+ request; this effectively ignores the
2928
+ authentication in the spec for a single request.
2929
+ :type _request_auth: dict, optional
2930
+ :param _content_type: force content-type for the request.
2931
+ :type _content_type: str, Optional
2932
+ :param _headers: set to override the headers for a single
2933
+ request; this effectively ignores the headers
2934
+ in the spec for a single request.
2935
+ :type _headers: dict, optional
2936
+ :param _host_index: set to override the host_index for a single
2937
+ request; this effectively ignores the host_index
2938
+ in the spec for a single request.
2939
+ :type _host_index: int, optional
2940
+ :return: Returns the result object.
2941
+ """ # noqa: E501
2942
+
2943
+ _param = self._outbound_integration_endpoints_id_statistics_get_serialize(
2944
+ id=id,
2945
+ context=context,
2946
+ workspace=workspace,
2947
+ _request_auth=_request_auth,
2948
+ _content_type=_content_type,
2949
+ _headers=_headers,
2950
+ _host_index=_host_index
2951
+ )
2952
+
2953
+ _response_types_map: Dict[str, Optional[str]] = {
2954
+ '200': "EndpointStatistics",
2955
+ '400': "Error",
2956
+ '404': "Error",
2957
+ }
2958
+ response_data = self.api_client.call_api(
2959
+ *_param,
2960
+ _request_timeout=_request_timeout
2961
+ )
2962
+ return response_data.response
2963
+
2964
+
2965
+ def _outbound_integration_endpoints_id_statistics_get_serialize(
2966
+ self,
2967
+ id,
2968
+ context,
2969
+ workspace,
2970
+ _request_auth,
2971
+ _content_type,
2972
+ _headers,
2973
+ _host_index,
2974
+ ) -> RequestSerialized:
2975
+
2976
+ _host = None
2977
+
2978
+ _collection_formats: Dict[str, str] = {
2979
+ }
2980
+
2981
+ _path_params: Dict[str, str] = {}
2982
+ _query_params: List[Tuple[str, str]] = []
2983
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2984
+ _form_params: List[Tuple[str, str]] = []
2985
+ _files: Dict[
2986
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2987
+ ] = {}
2988
+ _body_params: Optional[bytes] = None
2989
+
2990
+ # process the path parameters
2991
+ if id is not None:
2992
+ _path_params['id'] = id
2993
+ # process the query parameters
2994
+ if context is not None:
2995
+
2996
+ _query_params.append(('context', context))
2997
+
2998
+ if workspace is not None:
2999
+
3000
+ _query_params.append(('workspace', workspace))
3001
+
3002
+ # process the header parameters
3003
+ # process the form parameters
3004
+ # process the body parameter
3005
+
3006
+
3007
+ # set the HTTP header `Accept`
3008
+ if 'Accept' not in _header_params:
3009
+ _header_params['Accept'] = self.api_client.select_header_accept(
3010
+ [
3011
+ 'application/json'
3012
+ ]
3013
+ )
3014
+
3015
+
3016
+ # authentication setting
3017
+ _auth_settings: List[str] = [
3018
+ 'basicAuth'
3019
+ ]
3020
+
3021
+ return self.api_client.param_serialize(
3022
+ method='GET',
3023
+ resource_path='/outbound-integration-endpoints/{id}/statistics',
3024
+ path_params=_path_params,
3025
+ query_params=_query_params,
3026
+ header_params=_header_params,
3027
+ body=_body_params,
3028
+ post_params=_form_params,
3029
+ files=_files,
3030
+ auth_settings=_auth_settings,
3031
+ collection_formats=_collection_formats,
3032
+ _host=_host,
3033
+ _request_auth=_request_auth
3034
+ )
3035
+
3036
+
3037
+
3038
+
3039
+ @validate_call
3040
+ def outbound_integration_endpoints_id_status_get(
3041
+ self,
3042
+ id: Annotated[StrictStr, Field(description="ID of the outbound integration endpoint for which to retrieve the status")],
3043
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
3044
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
3045
+ _request_timeout: Union[
3046
+ None,
3047
+ Annotated[StrictFloat, Field(gt=0)],
3048
+ Tuple[
3049
+ Annotated[StrictFloat, Field(gt=0)],
3050
+ Annotated[StrictFloat, Field(gt=0)]
3051
+ ]
3052
+ ] = None,
3053
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3054
+ _content_type: Optional[StrictStr] = None,
3055
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3056
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3057
+ ) -> EndpointStatus:
3058
+ """Returns the status of the specified outbound integration endpoint
3059
+
3060
+ Operation for retrieving status information for a specific outbound integration endpoint
3061
+
3062
+ :param id: ID of the outbound integration endpoint for which to retrieve the status (required)
3063
+ :type id: str
3064
+ :param context: ID of the context in which to perform the operation (required)
3065
+ :type context: str
3066
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
3067
+ :type workspace: str
3068
+ :param _request_timeout: timeout setting for this request. If one
3069
+ number provided, it will be total request
3070
+ timeout. It can also be a pair (tuple) of
3071
+ (connection, read) timeouts.
3072
+ :type _request_timeout: int, tuple(int, int), optional
3073
+ :param _request_auth: set to override the auth_settings for an a single
3074
+ request; this effectively ignores the
3075
+ authentication in the spec for a single request.
3076
+ :type _request_auth: dict, optional
3077
+ :param _content_type: force content-type for the request.
3078
+ :type _content_type: str, Optional
3079
+ :param _headers: set to override the headers for a single
3080
+ request; this effectively ignores the headers
3081
+ in the spec for a single request.
3082
+ :type _headers: dict, optional
3083
+ :param _host_index: set to override the host_index for a single
3084
+ request; this effectively ignores the host_index
3085
+ in the spec for a single request.
3086
+ :type _host_index: int, optional
3087
+ :return: Returns the result object.
3088
+ """ # noqa: E501
3089
+
3090
+ _param = self._outbound_integration_endpoints_id_status_get_serialize(
3091
+ id=id,
3092
+ context=context,
3093
+ workspace=workspace,
3094
+ _request_auth=_request_auth,
3095
+ _content_type=_content_type,
3096
+ _headers=_headers,
3097
+ _host_index=_host_index
3098
+ )
3099
+
3100
+ _response_types_map: Dict[str, Optional[str]] = {
3101
+ '200': "EndpointStatus",
3102
+ '400': "Error",
3103
+ '404': "Error",
3104
+ }
3105
+ response_data = self.api_client.call_api(
3106
+ *_param,
3107
+ _request_timeout=_request_timeout
3108
+ )
3109
+ response_data.read()
3110
+ return self.api_client.response_deserialize(
3111
+ response_data=response_data,
3112
+ response_types_map=_response_types_map,
3113
+ ).data
3114
+
3115
+
3116
+ @validate_call
3117
+ def outbound_integration_endpoints_id_status_get_with_http_info(
3118
+ self,
3119
+ id: Annotated[StrictStr, Field(description="ID of the outbound integration endpoint for which to retrieve the status")],
3120
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
3121
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
3122
+ _request_timeout: Union[
3123
+ None,
3124
+ Annotated[StrictFloat, Field(gt=0)],
3125
+ Tuple[
3126
+ Annotated[StrictFloat, Field(gt=0)],
3127
+ Annotated[StrictFloat, Field(gt=0)]
3128
+ ]
3129
+ ] = None,
3130
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3131
+ _content_type: Optional[StrictStr] = None,
3132
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3133
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3134
+ ) -> ApiResponse[EndpointStatus]:
3135
+ """Returns the status of the specified outbound integration endpoint
3136
+
3137
+ Operation for retrieving status information for a specific outbound integration endpoint
3138
+
3139
+ :param id: ID of the outbound integration endpoint for which to retrieve the status (required)
3140
+ :type id: str
3141
+ :param context: ID of the context in which to perform the operation (required)
3142
+ :type context: str
3143
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
3144
+ :type workspace: str
3145
+ :param _request_timeout: timeout setting for this request. If one
3146
+ number provided, it will be total request
3147
+ timeout. It can also be a pair (tuple) of
3148
+ (connection, read) timeouts.
3149
+ :type _request_timeout: int, tuple(int, int), optional
3150
+ :param _request_auth: set to override the auth_settings for an a single
3151
+ request; this effectively ignores the
3152
+ authentication in the spec for a single request.
3153
+ :type _request_auth: dict, optional
3154
+ :param _content_type: force content-type for the request.
3155
+ :type _content_type: str, Optional
3156
+ :param _headers: set to override the headers for a single
3157
+ request; this effectively ignores the headers
3158
+ in the spec for a single request.
3159
+ :type _headers: dict, optional
3160
+ :param _host_index: set to override the host_index for a single
3161
+ request; this effectively ignores the host_index
3162
+ in the spec for a single request.
3163
+ :type _host_index: int, optional
3164
+ :return: Returns the result object.
3165
+ """ # noqa: E501
3166
+
3167
+ _param = self._outbound_integration_endpoints_id_status_get_serialize(
3168
+ id=id,
3169
+ context=context,
3170
+ workspace=workspace,
3171
+ _request_auth=_request_auth,
3172
+ _content_type=_content_type,
3173
+ _headers=_headers,
3174
+ _host_index=_host_index
3175
+ )
3176
+
3177
+ _response_types_map: Dict[str, Optional[str]] = {
3178
+ '200': "EndpointStatus",
3179
+ '400': "Error",
3180
+ '404': "Error",
3181
+ }
3182
+ response_data = self.api_client.call_api(
3183
+ *_param,
3184
+ _request_timeout=_request_timeout
3185
+ )
3186
+ response_data.read()
3187
+ return self.api_client.response_deserialize(
3188
+ response_data=response_data,
3189
+ response_types_map=_response_types_map,
3190
+ )
3191
+
3192
+
3193
+ @validate_call
3194
+ def outbound_integration_endpoints_id_status_get_without_preload_content(
3195
+ self,
3196
+ id: Annotated[StrictStr, Field(description="ID of the outbound integration endpoint for which to retrieve the status")],
3197
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
3198
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
3199
+ _request_timeout: Union[
3200
+ None,
3201
+ Annotated[StrictFloat, Field(gt=0)],
3202
+ Tuple[
3203
+ Annotated[StrictFloat, Field(gt=0)],
3204
+ Annotated[StrictFloat, Field(gt=0)]
3205
+ ]
3206
+ ] = None,
3207
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3208
+ _content_type: Optional[StrictStr] = None,
3209
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3210
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3211
+ ) -> RESTResponseType:
3212
+ """Returns the status of the specified outbound integration endpoint
3213
+
3214
+ Operation for retrieving status information for a specific outbound integration endpoint
3215
+
3216
+ :param id: ID of the outbound integration endpoint for which to retrieve the status (required)
3217
+ :type id: str
3218
+ :param context: ID of the context in which to perform the operation (required)
3219
+ :type context: str
3220
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
3221
+ :type workspace: str
3222
+ :param _request_timeout: timeout setting for this request. If one
3223
+ number provided, it will be total request
3224
+ timeout. It can also be a pair (tuple) of
3225
+ (connection, read) timeouts.
3226
+ :type _request_timeout: int, tuple(int, int), optional
3227
+ :param _request_auth: set to override the auth_settings for an a single
3228
+ request; this effectively ignores the
3229
+ authentication in the spec for a single request.
3230
+ :type _request_auth: dict, optional
3231
+ :param _content_type: force content-type for the request.
3232
+ :type _content_type: str, Optional
3233
+ :param _headers: set to override the headers for a single
3234
+ request; this effectively ignores the headers
3235
+ in the spec for a single request.
3236
+ :type _headers: dict, optional
3237
+ :param _host_index: set to override the host_index for a single
3238
+ request; this effectively ignores the host_index
3239
+ in the spec for a single request.
3240
+ :type _host_index: int, optional
3241
+ :return: Returns the result object.
3242
+ """ # noqa: E501
3243
+
3244
+ _param = self._outbound_integration_endpoints_id_status_get_serialize(
3245
+ id=id,
3246
+ context=context,
3247
+ workspace=workspace,
3248
+ _request_auth=_request_auth,
3249
+ _content_type=_content_type,
3250
+ _headers=_headers,
3251
+ _host_index=_host_index
3252
+ )
3253
+
3254
+ _response_types_map: Dict[str, Optional[str]] = {
3255
+ '200': "EndpointStatus",
3256
+ '400': "Error",
3257
+ '404': "Error",
3258
+ }
3259
+ response_data = self.api_client.call_api(
3260
+ *_param,
3261
+ _request_timeout=_request_timeout
3262
+ )
3263
+ return response_data.response
3264
+
3265
+
3266
+ def _outbound_integration_endpoints_id_status_get_serialize(
3267
+ self,
3268
+ id,
3269
+ context,
3270
+ workspace,
3271
+ _request_auth,
3272
+ _content_type,
3273
+ _headers,
3274
+ _host_index,
3275
+ ) -> RequestSerialized:
3276
+
3277
+ _host = None
3278
+
3279
+ _collection_formats: Dict[str, str] = {
3280
+ }
3281
+
3282
+ _path_params: Dict[str, str] = {}
3283
+ _query_params: List[Tuple[str, str]] = []
3284
+ _header_params: Dict[str, Optional[str]] = _headers or {}
3285
+ _form_params: List[Tuple[str, str]] = []
3286
+ _files: Dict[
3287
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
3288
+ ] = {}
3289
+ _body_params: Optional[bytes] = None
3290
+
3291
+ # process the path parameters
3292
+ if id is not None:
3293
+ _path_params['id'] = id
3294
+ # process the query parameters
3295
+ if context is not None:
3296
+
3297
+ _query_params.append(('context', context))
3298
+
3299
+ if workspace is not None:
3300
+
3301
+ _query_params.append(('workspace', workspace))
3302
+
3303
+ # process the header parameters
3304
+ # process the form parameters
3305
+ # process the body parameter
3306
+
3307
+
3308
+ # set the HTTP header `Accept`
3309
+ if 'Accept' not in _header_params:
3310
+ _header_params['Accept'] = self.api_client.select_header_accept(
3311
+ [
3312
+ 'application/json'
3313
+ ]
3314
+ )
3315
+
3316
+
3317
+ # authentication setting
3318
+ _auth_settings: List[str] = [
3319
+ 'basicAuth'
3320
+ ]
3321
+
3322
+ return self.api_client.param_serialize(
3323
+ method='GET',
3324
+ resource_path='/outbound-integration-endpoints/{id}/status',
3325
+ path_params=_path_params,
3326
+ query_params=_query_params,
3327
+ header_params=_header_params,
3328
+ body=_body_params,
3329
+ post_params=_form_params,
3330
+ files=_files,
3331
+ auth_settings=_auth_settings,
3332
+ collection_formats=_collection_formats,
3333
+ _host=_host,
3334
+ _request_auth=_request_auth
3335
+ )
3336
+
3337
+
3338
+
3339
+
3340
+ @validate_call
3341
+ def outbound_integration_endpoints_id_worker_processes_get(
3342
+ self,
3343
+ id: Annotated[StrictStr, Field(description="ID of the outbound integration endpoint for which to retrieve processes")],
3344
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
3345
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
3346
+ status: Annotated[Optional[StrictStr], Field(description="Background process status filter")] = None,
3347
+ _request_timeout: Union[
3348
+ None,
3349
+ Annotated[StrictFloat, Field(gt=0)],
3350
+ Tuple[
3351
+ Annotated[StrictFloat, Field(gt=0)],
3352
+ Annotated[StrictFloat, Field(gt=0)]
3353
+ ]
3354
+ ] = None,
3355
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3356
+ _content_type: Optional[StrictStr] = None,
3357
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3358
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3359
+ ) -> List[str]:
3360
+ """Returns background process IDs for processes started by the endpoint
3361
+
3362
+ Operation for retrieving background process IDs for processes started by the endpoint. Can be filtered on process status.
3363
+
3364
+ :param id: ID of the outbound integration endpoint for which to retrieve processes (required)
3365
+ :type id: str
3366
+ :param context: ID of the context in which to perform the operation (required)
3367
+ :type context: str
3368
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
3369
+ :type workspace: str
3370
+ :param status: Background process status filter
3371
+ :type status: str
3372
+ :param _request_timeout: timeout setting for this request. If one
3373
+ number provided, it will be total request
3374
+ timeout. It can also be a pair (tuple) of
3375
+ (connection, read) timeouts.
3376
+ :type _request_timeout: int, tuple(int, int), optional
3377
+ :param _request_auth: set to override the auth_settings for an a single
3378
+ request; this effectively ignores the
3379
+ authentication in the spec for a single request.
3380
+ :type _request_auth: dict, optional
3381
+ :param _content_type: force content-type for the request.
3382
+ :type _content_type: str, Optional
3383
+ :param _headers: set to override the headers for a single
3384
+ request; this effectively ignores the headers
3385
+ in the spec for a single request.
3386
+ :type _headers: dict, optional
3387
+ :param _host_index: set to override the host_index for a single
3388
+ request; this effectively ignores the host_index
3389
+ in the spec for a single request.
3390
+ :type _host_index: int, optional
3391
+ :return: Returns the result object.
3392
+ """ # noqa: E501
3393
+
3394
+ _param = self._outbound_integration_endpoints_id_worker_processes_get_serialize(
3395
+ id=id,
3396
+ context=context,
3397
+ workspace=workspace,
3398
+ status=status,
3399
+ _request_auth=_request_auth,
3400
+ _content_type=_content_type,
3401
+ _headers=_headers,
3402
+ _host_index=_host_index
3403
+ )
3404
+
3405
+ _response_types_map: Dict[str, Optional[str]] = {
3406
+ '200': "List[str]",
3407
+ '400': "Error",
3408
+ '404': "Error",
3409
+ }
3410
+ response_data = self.api_client.call_api(
3411
+ *_param,
3412
+ _request_timeout=_request_timeout
3413
+ )
3414
+ response_data.read()
3415
+ return self.api_client.response_deserialize(
3416
+ response_data=response_data,
3417
+ response_types_map=_response_types_map,
3418
+ ).data
3419
+
3420
+
3421
+ @validate_call
3422
+ def outbound_integration_endpoints_id_worker_processes_get_with_http_info(
3423
+ self,
3424
+ id: Annotated[StrictStr, Field(description="ID of the outbound integration endpoint for which to retrieve processes")],
3425
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
3426
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
3427
+ status: Annotated[Optional[StrictStr], Field(description="Background process status filter")] = None,
3428
+ _request_timeout: Union[
3429
+ None,
3430
+ Annotated[StrictFloat, Field(gt=0)],
3431
+ Tuple[
3432
+ Annotated[StrictFloat, Field(gt=0)],
3433
+ Annotated[StrictFloat, Field(gt=0)]
3434
+ ]
3435
+ ] = None,
3436
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3437
+ _content_type: Optional[StrictStr] = None,
3438
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3439
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3440
+ ) -> ApiResponse[List[str]]:
3441
+ """Returns background process IDs for processes started by the endpoint
3442
+
3443
+ Operation for retrieving background process IDs for processes started by the endpoint. Can be filtered on process status.
3444
+
3445
+ :param id: ID of the outbound integration endpoint for which to retrieve processes (required)
3446
+ :type id: str
3447
+ :param context: ID of the context in which to perform the operation (required)
3448
+ :type context: str
3449
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
3450
+ :type workspace: str
3451
+ :param status: Background process status filter
3452
+ :type status: str
3453
+ :param _request_timeout: timeout setting for this request. If one
3454
+ number provided, it will be total request
3455
+ timeout. It can also be a pair (tuple) of
3456
+ (connection, read) timeouts.
3457
+ :type _request_timeout: int, tuple(int, int), optional
3458
+ :param _request_auth: set to override the auth_settings for an a single
3459
+ request; this effectively ignores the
3460
+ authentication in the spec for a single request.
3461
+ :type _request_auth: dict, optional
3462
+ :param _content_type: force content-type for the request.
3463
+ :type _content_type: str, Optional
3464
+ :param _headers: set to override the headers for a single
3465
+ request; this effectively ignores the headers
3466
+ in the spec for a single request.
3467
+ :type _headers: dict, optional
3468
+ :param _host_index: set to override the host_index for a single
3469
+ request; this effectively ignores the host_index
3470
+ in the spec for a single request.
3471
+ :type _host_index: int, optional
3472
+ :return: Returns the result object.
3473
+ """ # noqa: E501
3474
+
3475
+ _param = self._outbound_integration_endpoints_id_worker_processes_get_serialize(
3476
+ id=id,
3477
+ context=context,
3478
+ workspace=workspace,
3479
+ status=status,
3480
+ _request_auth=_request_auth,
3481
+ _content_type=_content_type,
3482
+ _headers=_headers,
3483
+ _host_index=_host_index
3484
+ )
3485
+
3486
+ _response_types_map: Dict[str, Optional[str]] = {
3487
+ '200': "List[str]",
3488
+ '400': "Error",
3489
+ '404': "Error",
3490
+ }
3491
+ response_data = self.api_client.call_api(
3492
+ *_param,
3493
+ _request_timeout=_request_timeout
3494
+ )
3495
+ response_data.read()
3496
+ return self.api_client.response_deserialize(
3497
+ response_data=response_data,
3498
+ response_types_map=_response_types_map,
3499
+ )
3500
+
3501
+
3502
+ @validate_call
3503
+ def outbound_integration_endpoints_id_worker_processes_get_without_preload_content(
3504
+ self,
3505
+ id: Annotated[StrictStr, Field(description="ID of the outbound integration endpoint for which to retrieve processes")],
3506
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
3507
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
3508
+ status: Annotated[Optional[StrictStr], Field(description="Background process status filter")] = None,
3509
+ _request_timeout: Union[
3510
+ None,
3511
+ Annotated[StrictFloat, Field(gt=0)],
3512
+ Tuple[
3513
+ Annotated[StrictFloat, Field(gt=0)],
3514
+ Annotated[StrictFloat, Field(gt=0)]
3515
+ ]
3516
+ ] = None,
3517
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3518
+ _content_type: Optional[StrictStr] = None,
3519
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3520
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3521
+ ) -> RESTResponseType:
3522
+ """Returns background process IDs for processes started by the endpoint
3523
+
3524
+ Operation for retrieving background process IDs for processes started by the endpoint. Can be filtered on process status.
3525
+
3526
+ :param id: ID of the outbound integration endpoint for which to retrieve processes (required)
3527
+ :type id: str
3528
+ :param context: ID of the context in which to perform the operation (required)
3529
+ :type context: str
3530
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
3531
+ :type workspace: str
3532
+ :param status: Background process status filter
3533
+ :type status: str
3534
+ :param _request_timeout: timeout setting for this request. If one
3535
+ number provided, it will be total request
3536
+ timeout. It can also be a pair (tuple) of
3537
+ (connection, read) timeouts.
3538
+ :type _request_timeout: int, tuple(int, int), optional
3539
+ :param _request_auth: set to override the auth_settings for an a single
3540
+ request; this effectively ignores the
3541
+ authentication in the spec for a single request.
3542
+ :type _request_auth: dict, optional
3543
+ :param _content_type: force content-type for the request.
3544
+ :type _content_type: str, Optional
3545
+ :param _headers: set to override the headers for a single
3546
+ request; this effectively ignores the headers
3547
+ in the spec for a single request.
3548
+ :type _headers: dict, optional
3549
+ :param _host_index: set to override the host_index for a single
3550
+ request; this effectively ignores the host_index
3551
+ in the spec for a single request.
3552
+ :type _host_index: int, optional
3553
+ :return: Returns the result object.
3554
+ """ # noqa: E501
3555
+
3556
+ _param = self._outbound_integration_endpoints_id_worker_processes_get_serialize(
3557
+ id=id,
3558
+ context=context,
3559
+ workspace=workspace,
3560
+ status=status,
3561
+ _request_auth=_request_auth,
3562
+ _content_type=_content_type,
3563
+ _headers=_headers,
3564
+ _host_index=_host_index
3565
+ )
3566
+
3567
+ _response_types_map: Dict[str, Optional[str]] = {
3568
+ '200': "List[str]",
3569
+ '400': "Error",
3570
+ '404': "Error",
3571
+ }
3572
+ response_data = self.api_client.call_api(
3573
+ *_param,
3574
+ _request_timeout=_request_timeout
3575
+ )
3576
+ return response_data.response
3577
+
3578
+
3579
+ def _outbound_integration_endpoints_id_worker_processes_get_serialize(
3580
+ self,
3581
+ id,
3582
+ context,
3583
+ workspace,
3584
+ status,
3585
+ _request_auth,
3586
+ _content_type,
3587
+ _headers,
3588
+ _host_index,
3589
+ ) -> RequestSerialized:
3590
+
3591
+ _host = None
3592
+
3593
+ _collection_formats: Dict[str, str] = {
3594
+ }
3595
+
3596
+ _path_params: Dict[str, str] = {}
3597
+ _query_params: List[Tuple[str, str]] = []
3598
+ _header_params: Dict[str, Optional[str]] = _headers or {}
3599
+ _form_params: List[Tuple[str, str]] = []
3600
+ _files: Dict[
3601
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
3602
+ ] = {}
3603
+ _body_params: Optional[bytes] = None
3604
+
3605
+ # process the path parameters
3606
+ if id is not None:
3607
+ _path_params['id'] = id
3608
+ # process the query parameters
3609
+ if context is not None:
3610
+
3611
+ _query_params.append(('context', context))
3612
+
3613
+ if workspace is not None:
3614
+
3615
+ _query_params.append(('workspace', workspace))
3616
+
3617
+ if status is not None:
3618
+
3619
+ _query_params.append(('status', status))
3620
+
3621
+ # process the header parameters
3622
+ # process the form parameters
3623
+ # process the body parameter
3624
+
3625
+
3626
+ # set the HTTP header `Accept`
3627
+ if 'Accept' not in _header_params:
3628
+ _header_params['Accept'] = self.api_client.select_header_accept(
3629
+ [
3630
+ 'application/json'
3631
+ ]
3632
+ )
3633
+
3634
+
3635
+ # authentication setting
3636
+ _auth_settings: List[str] = [
3637
+ 'basicAuth'
3638
+ ]
3639
+
3640
+ return self.api_client.param_serialize(
3641
+ method='GET',
3642
+ resource_path='/outbound-integration-endpoints/{id}/worker-processes',
3643
+ path_params=_path_params,
3644
+ query_params=_query_params,
3645
+ header_params=_header_params,
3646
+ body=_body_params,
3647
+ post_params=_form_params,
3648
+ files=_files,
3649
+ auth_settings=_auth_settings,
3650
+ collection_formats=_collection_formats,
3651
+ _host=_host,
3652
+ _request_auth=_request_auth
3653
+ )
3654
+
3655
+