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,642 @@
1
+ # coding: utf-8
2
+
3
+ """
4
+ STEP REST API V2
5
+
6
+ <h1>About</h1><p>The STEP REST API V2 provides read and write access to a set of core STEP objects using the HTTP operations GET, PUT, POST, PATCH and DELETE.</p><h1>Resource Representation</h1><p>With the exception of a few resource operations for retrieving and uploading binary data, all request and response bodies are JSON, compliant with the schema documented here.</p><h1>Context and Workspace</h1><p>All requests are handled in a specific STEP context and workspace and both can be specified via query parameters available for all resource operations. A context must always be specified while requests per default will be handled in the &quot;Main&quot; workspace.</p><h1>Polymorphism</h1><p>In STEP, attributes, reference types and data container types can all be either single- or multivalued. The STEP REST API V2 uses polymorphism to address this complexity with resources that include values, references and data containers specified to produce and consume a common &quot;abstract&quot; supertype that always will be one of either the single- or multivalued subtype.<br/>As an example, the GET /entities/{id}/values/{attributeId} resource operation is specified to return a &quot;Value&quot; but as evident from the model, the &quot;Value&quot; will always be &quot;oneOf&quot; either &quot;SingleValue&quot;, that has a &quot;value&quot; property for which the value is an object, or &quot;MultiValue&quot;, that has a &quot;values&quot; property for which the value is an array.<br/>Clients are advised to use the presence or absence of the plural array property (&quot;values&quot;, &quot;references&quot; and &quot;dataContainers&quot;) to determine the concrete type.</p><h1>Authentication</h1><p>The REST API is protected by HTTP Basic Authentication or if OAuth2-based authentication is enabled (SaaS customers only), by Bearer Authentication. With Basic Authentication, user name and password are supplied with each request and it is therefore highly recommended to only use the API in conjunction with HTTPS. For more information about OAuth2-based authentication for SaaS customers, please see the STEP Authentication Guide.</p><h1>Versioning</h1><p>The STEP REST API V2 is versioned using semantic versioning. Stibo Systems reserve the right to make non-breaking, minor / patch changes in any release without warning and clients must be coded / configured to be 'tolerant' and capable of handling such changes.</p><p>Examples of breaking, major changes:</p><ul><li>Renaming of a property</li><li>Removal of a property</li><li>Property type change</li><li>Addition of new property required for write operations</li><li>Marking existing property as required for write operations</li><li>Removal of resource or resource operation</li><li>Materially different behavior for existing resource operation</li></ul><p>Examples of non-breaking, minor / patch changes:</p><ul><li>Addition of new properties in request responses</li><li>Addition of new query parameter not required for write operations</li><li>Addition of new resource or resource operation</li><li>Bug fixes that do not change the schema or resource operations as described here</li><li>Inclusion of a response body for resource operations specified to return a 200 response with no body</li><li>Change of response &quot;Model&quot; / &quot;schema&quot; to type extending the previously specified type</li><li>Renaming a &quot;Model&quot; / &quot;schema&quot; type</li></ul><p>In addition, error message texts may change without warning within the same version. Client program logic should not depend upon the message content.</p><h1>Error Handling</h1><p>The STEP REST API V2 responds with standard HTTP status codes, with 2** responses indicating a success, 4** responses indicating a client error and 5** indicating a server error. Notice that this specification does not specify common error responses like 500 (internal server error) or 401 (unauthorized) for the individual resource operations. Clients should however be capable of handling such responses.</p><p>Error responses have a JSON response body (see Error schema below) containing HTTP status code information in addition to a message providing details about the error. As mentioned above, client program logic should not depend upon the message content.</p><p>The specific status codes used in the API are:</p><ul><li>200 (OK): Success, response may or may not have a body</li><li>201 (Created): Entity successfully created, response may or may not have a body</li><li>400 (Bad request): The server cannot or will not process the request due to an apparent client error</li><li>401 (Unauthorized): Returned only in relation to failed authentication</li><li>404 (Not Found): Returned only in relation to objects specified via path parameters (variable parts of the URL). If STEP objects referenced in request bodies or via query parameters cannot be found, the response will be 400.</li><li>429 (Too Many Requests): Clients are per default limited to 100 requests per second. Returned if the rate limit is exceeded.</li><li>500 (Internal Server Error): Unexpected error (could potentially cover an issue that rightfully should be a 400)</li></ul>
7
+
8
+ The version of the OpenAPI document: 1.3.0
9
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
10
+
11
+ Do not edit the class manually.
12
+ """ # noqa: E501
13
+
14
+ import warnings
15
+ from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
16
+ from typing import Any, Dict, List, Optional, Tuple, Union
17
+ from typing_extensions import Annotated
18
+
19
+ from pydantic import Field, StrictStr
20
+ from typing import List, Optional
21
+ from typing_extensions import Annotated
22
+ from step_rest_client.models.list_of_values import ListOfValues
23
+ from step_rest_client.models.list_of_values_entry import ListOfValuesEntry
24
+
25
+ from step_rest_client.api_client import ApiClient, RequestSerialized
26
+ from step_rest_client.api_response import ApiResponse
27
+ from step_rest_client.rest import RESTResponseType
28
+
29
+
30
+ class ListsOfValuesApi:
31
+ """NOTE: This class is auto generated by OpenAPI Generator
32
+ Ref: https://openapi-generator.tech
33
+
34
+ Do not edit the class manually.
35
+ """
36
+
37
+ def __init__(self, api_client=None) -> None:
38
+ if api_client is None:
39
+ api_client = ApiClient.get_default()
40
+ self.api_client = api_client
41
+
42
+
43
+ @validate_call
44
+ def list_of_values_id_get(
45
+ self,
46
+ id: Annotated[StrictStr, Field(description="ID of the list of values for which to retrieve data")],
47
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
48
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
49
+ _request_timeout: Union[
50
+ None,
51
+ Annotated[StrictFloat, Field(gt=0)],
52
+ Tuple[
53
+ Annotated[StrictFloat, Field(gt=0)],
54
+ Annotated[StrictFloat, Field(gt=0)]
55
+ ]
56
+ ] = None,
57
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
58
+ _content_type: Optional[StrictStr] = None,
59
+ _headers: Optional[Dict[StrictStr, Any]] = None,
60
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
61
+ ) -> ListOfValues:
62
+ """Returns the list of values with the specified ID
63
+
64
+ Operation for retrieving information about a specific list of values object. Notice that the response does not contain the list of values value entries. Use GET /lists-of-values/{id}/value-entries to retrieve these as a streamed array.
65
+
66
+ :param id: ID of the list of values for which to retrieve data (required)
67
+ :type id: str
68
+ :param context: ID of the context in which to perform the operation (required)
69
+ :type context: str
70
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
71
+ :type workspace: str
72
+ :param _request_timeout: timeout setting for this request. If one
73
+ number provided, it will be total request
74
+ timeout. It can also be a pair (tuple) of
75
+ (connection, read) timeouts.
76
+ :type _request_timeout: int, tuple(int, int), optional
77
+ :param _request_auth: set to override the auth_settings for an a single
78
+ request; this effectively ignores the
79
+ authentication in the spec for a single request.
80
+ :type _request_auth: dict, optional
81
+ :param _content_type: force content-type for the request.
82
+ :type _content_type: str, Optional
83
+ :param _headers: set to override the headers for a single
84
+ request; this effectively ignores the headers
85
+ in the spec for a single request.
86
+ :type _headers: dict, optional
87
+ :param _host_index: set to override the host_index for a single
88
+ request; this effectively ignores the host_index
89
+ in the spec for a single request.
90
+ :type _host_index: int, optional
91
+ :return: Returns the result object.
92
+ """ # noqa: E501
93
+
94
+ _param = self._list_of_values_id_get_serialize(
95
+ id=id,
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': "ListOfValues",
106
+ '400': "Error",
107
+ '404': "Error",
108
+ }
109
+ response_data = self.api_client.call_api(
110
+ *_param,
111
+ _request_timeout=_request_timeout
112
+ )
113
+ response_data.read()
114
+ return self.api_client.response_deserialize(
115
+ response_data=response_data,
116
+ response_types_map=_response_types_map,
117
+ ).data
118
+
119
+
120
+ @validate_call
121
+ def list_of_values_id_get_with_http_info(
122
+ self,
123
+ id: Annotated[StrictStr, Field(description="ID of the list of values for which to retrieve data")],
124
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
125
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
126
+ _request_timeout: Union[
127
+ None,
128
+ Annotated[StrictFloat, Field(gt=0)],
129
+ Tuple[
130
+ Annotated[StrictFloat, Field(gt=0)],
131
+ Annotated[StrictFloat, Field(gt=0)]
132
+ ]
133
+ ] = None,
134
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
135
+ _content_type: Optional[StrictStr] = None,
136
+ _headers: Optional[Dict[StrictStr, Any]] = None,
137
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
138
+ ) -> ApiResponse[ListOfValues]:
139
+ """Returns the list of values with the specified ID
140
+
141
+ Operation for retrieving information about a specific list of values object. Notice that the response does not contain the list of values value entries. Use GET /lists-of-values/{id}/value-entries to retrieve these as a streamed array.
142
+
143
+ :param id: ID of the list of values for which to retrieve data (required)
144
+ :type id: str
145
+ :param context: ID of the context in which to perform the operation (required)
146
+ :type context: str
147
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
148
+ :type workspace: str
149
+ :param _request_timeout: timeout setting for this request. If one
150
+ number provided, it will be total request
151
+ timeout. It can also be a pair (tuple) of
152
+ (connection, read) timeouts.
153
+ :type _request_timeout: int, tuple(int, int), optional
154
+ :param _request_auth: set to override the auth_settings for an a single
155
+ request; this effectively ignores the
156
+ authentication in the spec for a single request.
157
+ :type _request_auth: dict, optional
158
+ :param _content_type: force content-type for the request.
159
+ :type _content_type: str, Optional
160
+ :param _headers: set to override the headers for a single
161
+ request; this effectively ignores the headers
162
+ in the spec for a single request.
163
+ :type _headers: dict, optional
164
+ :param _host_index: set to override the host_index for a single
165
+ request; this effectively ignores the host_index
166
+ in the spec for a single request.
167
+ :type _host_index: int, optional
168
+ :return: Returns the result object.
169
+ """ # noqa: E501
170
+
171
+ _param = self._list_of_values_id_get_serialize(
172
+ id=id,
173
+ context=context,
174
+ workspace=workspace,
175
+ _request_auth=_request_auth,
176
+ _content_type=_content_type,
177
+ _headers=_headers,
178
+ _host_index=_host_index
179
+ )
180
+
181
+ _response_types_map: Dict[str, Optional[str]] = {
182
+ '200': "ListOfValues",
183
+ '400': "Error",
184
+ '404': "Error",
185
+ }
186
+ response_data = self.api_client.call_api(
187
+ *_param,
188
+ _request_timeout=_request_timeout
189
+ )
190
+ response_data.read()
191
+ return self.api_client.response_deserialize(
192
+ response_data=response_data,
193
+ response_types_map=_response_types_map,
194
+ )
195
+
196
+
197
+ @validate_call
198
+ def list_of_values_id_get_without_preload_content(
199
+ self,
200
+ id: Annotated[StrictStr, Field(description="ID of the list of values for which to retrieve data")],
201
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
202
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
203
+ _request_timeout: Union[
204
+ None,
205
+ Annotated[StrictFloat, Field(gt=0)],
206
+ Tuple[
207
+ Annotated[StrictFloat, Field(gt=0)],
208
+ Annotated[StrictFloat, Field(gt=0)]
209
+ ]
210
+ ] = None,
211
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
212
+ _content_type: Optional[StrictStr] = None,
213
+ _headers: Optional[Dict[StrictStr, Any]] = None,
214
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
215
+ ) -> RESTResponseType:
216
+ """Returns the list of values with the specified ID
217
+
218
+ Operation for retrieving information about a specific list of values object. Notice that the response does not contain the list of values value entries. Use GET /lists-of-values/{id}/value-entries to retrieve these as a streamed array.
219
+
220
+ :param id: ID of the list of values for which to retrieve data (required)
221
+ :type id: str
222
+ :param context: ID of the context in which to perform the operation (required)
223
+ :type context: str
224
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
225
+ :type workspace: str
226
+ :param _request_timeout: timeout setting for this request. If one
227
+ number provided, it will be total request
228
+ timeout. It can also be a pair (tuple) of
229
+ (connection, read) timeouts.
230
+ :type _request_timeout: int, tuple(int, int), optional
231
+ :param _request_auth: set to override the auth_settings for an a single
232
+ request; this effectively ignores the
233
+ authentication in the spec for a single request.
234
+ :type _request_auth: dict, optional
235
+ :param _content_type: force content-type for the request.
236
+ :type _content_type: str, Optional
237
+ :param _headers: set to override the headers for a single
238
+ request; this effectively ignores the headers
239
+ in the spec for a single request.
240
+ :type _headers: dict, optional
241
+ :param _host_index: set to override the host_index for a single
242
+ request; this effectively ignores the host_index
243
+ in the spec for a single request.
244
+ :type _host_index: int, optional
245
+ :return: Returns the result object.
246
+ """ # noqa: E501
247
+
248
+ _param = self._list_of_values_id_get_serialize(
249
+ id=id,
250
+ context=context,
251
+ workspace=workspace,
252
+ _request_auth=_request_auth,
253
+ _content_type=_content_type,
254
+ _headers=_headers,
255
+ _host_index=_host_index
256
+ )
257
+
258
+ _response_types_map: Dict[str, Optional[str]] = {
259
+ '200': "ListOfValues",
260
+ '400': "Error",
261
+ '404': "Error",
262
+ }
263
+ response_data = self.api_client.call_api(
264
+ *_param,
265
+ _request_timeout=_request_timeout
266
+ )
267
+ return response_data.response
268
+
269
+
270
+ def _list_of_values_id_get_serialize(
271
+ self,
272
+ id,
273
+ context,
274
+ workspace,
275
+ _request_auth,
276
+ _content_type,
277
+ _headers,
278
+ _host_index,
279
+ ) -> RequestSerialized:
280
+
281
+ _host = None
282
+
283
+ _collection_formats: Dict[str, str] = {
284
+ }
285
+
286
+ _path_params: Dict[str, str] = {}
287
+ _query_params: List[Tuple[str, str]] = []
288
+ _header_params: Dict[str, Optional[str]] = _headers or {}
289
+ _form_params: List[Tuple[str, str]] = []
290
+ _files: Dict[
291
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
292
+ ] = {}
293
+ _body_params: Optional[bytes] = None
294
+
295
+ # process the path parameters
296
+ if id is not None:
297
+ _path_params['id'] = id
298
+ # process the query parameters
299
+ if context is not None:
300
+
301
+ _query_params.append(('context', context))
302
+
303
+ if workspace is not None:
304
+
305
+ _query_params.append(('workspace', workspace))
306
+
307
+ # process the header parameters
308
+ # process the form parameters
309
+ # process the body parameter
310
+
311
+
312
+ # set the HTTP header `Accept`
313
+ if 'Accept' not in _header_params:
314
+ _header_params['Accept'] = self.api_client.select_header_accept(
315
+ [
316
+ 'application/json'
317
+ ]
318
+ )
319
+
320
+
321
+ # authentication setting
322
+ _auth_settings: List[str] = [
323
+ 'basicAuth'
324
+ ]
325
+
326
+ return self.api_client.param_serialize(
327
+ method='GET',
328
+ resource_path='/list-of-values/{id}',
329
+ path_params=_path_params,
330
+ query_params=_query_params,
331
+ header_params=_header_params,
332
+ body=_body_params,
333
+ post_params=_form_params,
334
+ files=_files,
335
+ auth_settings=_auth_settings,
336
+ collection_formats=_collection_formats,
337
+ _host=_host,
338
+ _request_auth=_request_auth
339
+ )
340
+
341
+
342
+
343
+
344
+ @validate_call
345
+ def list_of_values_id_value_entries_get(
346
+ self,
347
+ id: Annotated[StrictStr, Field(description="ID of the list of values for which to retrieve value entries")],
348
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
349
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
350
+ _request_timeout: Union[
351
+ None,
352
+ Annotated[StrictFloat, Field(gt=0)],
353
+ Tuple[
354
+ Annotated[StrictFloat, Field(gt=0)],
355
+ Annotated[StrictFloat, Field(gt=0)]
356
+ ]
357
+ ] = None,
358
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
359
+ _content_type: Optional[StrictStr] = None,
360
+ _headers: Optional[Dict[StrictStr, Any]] = None,
361
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
362
+ ) -> List[ListOfValuesEntry]:
363
+ """Returns a streamed array of value entries (ListOfValuesEntry)
364
+
365
+ Returns a streamed array of value entries (ListOfValuesEntry) for the list of values with the specified ID.
366
+
367
+ :param id: ID of the list of values for which to retrieve value entries (required)
368
+ :type id: str
369
+ :param context: ID of the context in which to perform the operation (required)
370
+ :type context: str
371
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
372
+ :type workspace: str
373
+ :param _request_timeout: timeout setting for this request. If one
374
+ number provided, it will be total request
375
+ timeout. It can also be a pair (tuple) of
376
+ (connection, read) timeouts.
377
+ :type _request_timeout: int, tuple(int, int), optional
378
+ :param _request_auth: set to override the auth_settings for an a single
379
+ request; this effectively ignores the
380
+ authentication in the spec for a single request.
381
+ :type _request_auth: dict, optional
382
+ :param _content_type: force content-type for the request.
383
+ :type _content_type: str, Optional
384
+ :param _headers: set to override the headers for a single
385
+ request; this effectively ignores the headers
386
+ in the spec for a single request.
387
+ :type _headers: dict, optional
388
+ :param _host_index: set to override the host_index for a single
389
+ request; this effectively ignores the host_index
390
+ in the spec for a single request.
391
+ :type _host_index: int, optional
392
+ :return: Returns the result object.
393
+ """ # noqa: E501
394
+
395
+ _param = self._list_of_values_id_value_entries_get_serialize(
396
+ id=id,
397
+ context=context,
398
+ workspace=workspace,
399
+ _request_auth=_request_auth,
400
+ _content_type=_content_type,
401
+ _headers=_headers,
402
+ _host_index=_host_index
403
+ )
404
+
405
+ _response_types_map: Dict[str, Optional[str]] = {
406
+ '200': "List[ListOfValuesEntry]",
407
+ '400': "Error",
408
+ '404': "Error",
409
+ }
410
+ response_data = self.api_client.call_api(
411
+ *_param,
412
+ _request_timeout=_request_timeout
413
+ )
414
+ response_data.read()
415
+ return self.api_client.response_deserialize(
416
+ response_data=response_data,
417
+ response_types_map=_response_types_map,
418
+ ).data
419
+
420
+
421
+ @validate_call
422
+ def list_of_values_id_value_entries_get_with_http_info(
423
+ self,
424
+ id: Annotated[StrictStr, Field(description="ID of the list of values for which to retrieve value entries")],
425
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
426
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
427
+ _request_timeout: Union[
428
+ None,
429
+ Annotated[StrictFloat, Field(gt=0)],
430
+ Tuple[
431
+ Annotated[StrictFloat, Field(gt=0)],
432
+ Annotated[StrictFloat, Field(gt=0)]
433
+ ]
434
+ ] = None,
435
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
436
+ _content_type: Optional[StrictStr] = None,
437
+ _headers: Optional[Dict[StrictStr, Any]] = None,
438
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
439
+ ) -> ApiResponse[List[ListOfValuesEntry]]:
440
+ """Returns a streamed array of value entries (ListOfValuesEntry)
441
+
442
+ Returns a streamed array of value entries (ListOfValuesEntry) for the list of values with the specified ID.
443
+
444
+ :param id: ID of the list of values for which to retrieve value entries (required)
445
+ :type id: str
446
+ :param context: ID of the context in which to perform the operation (required)
447
+ :type context: str
448
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
449
+ :type workspace: str
450
+ :param _request_timeout: timeout setting for this request. If one
451
+ number provided, it will be total request
452
+ timeout. It can also be a pair (tuple) of
453
+ (connection, read) timeouts.
454
+ :type _request_timeout: int, tuple(int, int), optional
455
+ :param _request_auth: set to override the auth_settings for an a single
456
+ request; this effectively ignores the
457
+ authentication in the spec for a single request.
458
+ :type _request_auth: dict, optional
459
+ :param _content_type: force content-type for the request.
460
+ :type _content_type: str, Optional
461
+ :param _headers: set to override the headers for a single
462
+ request; this effectively ignores the headers
463
+ in the spec for a single request.
464
+ :type _headers: dict, optional
465
+ :param _host_index: set to override the host_index for a single
466
+ request; this effectively ignores the host_index
467
+ in the spec for a single request.
468
+ :type _host_index: int, optional
469
+ :return: Returns the result object.
470
+ """ # noqa: E501
471
+
472
+ _param = self._list_of_values_id_value_entries_get_serialize(
473
+ id=id,
474
+ context=context,
475
+ workspace=workspace,
476
+ _request_auth=_request_auth,
477
+ _content_type=_content_type,
478
+ _headers=_headers,
479
+ _host_index=_host_index
480
+ )
481
+
482
+ _response_types_map: Dict[str, Optional[str]] = {
483
+ '200': "List[ListOfValuesEntry]",
484
+ '400': "Error",
485
+ '404': "Error",
486
+ }
487
+ response_data = self.api_client.call_api(
488
+ *_param,
489
+ _request_timeout=_request_timeout
490
+ )
491
+ response_data.read()
492
+ return self.api_client.response_deserialize(
493
+ response_data=response_data,
494
+ response_types_map=_response_types_map,
495
+ )
496
+
497
+
498
+ @validate_call
499
+ def list_of_values_id_value_entries_get_without_preload_content(
500
+ self,
501
+ id: Annotated[StrictStr, Field(description="ID of the list of values for which to retrieve value entries")],
502
+ context: Annotated[StrictStr, Field(description="ID of the context in which to perform the operation")],
503
+ workspace: Annotated[Optional[StrictStr], Field(description="ID of the workspace in which to perform the operation. Defaults to \"Main\".")] = None,
504
+ _request_timeout: Union[
505
+ None,
506
+ Annotated[StrictFloat, Field(gt=0)],
507
+ Tuple[
508
+ Annotated[StrictFloat, Field(gt=0)],
509
+ Annotated[StrictFloat, Field(gt=0)]
510
+ ]
511
+ ] = None,
512
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
513
+ _content_type: Optional[StrictStr] = None,
514
+ _headers: Optional[Dict[StrictStr, Any]] = None,
515
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
516
+ ) -> RESTResponseType:
517
+ """Returns a streamed array of value entries (ListOfValuesEntry)
518
+
519
+ Returns a streamed array of value entries (ListOfValuesEntry) for the list of values with the specified ID.
520
+
521
+ :param id: ID of the list of values for which to retrieve value entries (required)
522
+ :type id: str
523
+ :param context: ID of the context in which to perform the operation (required)
524
+ :type context: str
525
+ :param workspace: ID of the workspace in which to perform the operation. Defaults to \"Main\".
526
+ :type workspace: str
527
+ :param _request_timeout: timeout setting for this request. If one
528
+ number provided, it will be total request
529
+ timeout. It can also be a pair (tuple) of
530
+ (connection, read) timeouts.
531
+ :type _request_timeout: int, tuple(int, int), optional
532
+ :param _request_auth: set to override the auth_settings for an a single
533
+ request; this effectively ignores the
534
+ authentication in the spec for a single request.
535
+ :type _request_auth: dict, optional
536
+ :param _content_type: force content-type for the request.
537
+ :type _content_type: str, Optional
538
+ :param _headers: set to override the headers for a single
539
+ request; this effectively ignores the headers
540
+ in the spec for a single request.
541
+ :type _headers: dict, optional
542
+ :param _host_index: set to override the host_index for a single
543
+ request; this effectively ignores the host_index
544
+ in the spec for a single request.
545
+ :type _host_index: int, optional
546
+ :return: Returns the result object.
547
+ """ # noqa: E501
548
+
549
+ _param = self._list_of_values_id_value_entries_get_serialize(
550
+ id=id,
551
+ context=context,
552
+ workspace=workspace,
553
+ _request_auth=_request_auth,
554
+ _content_type=_content_type,
555
+ _headers=_headers,
556
+ _host_index=_host_index
557
+ )
558
+
559
+ _response_types_map: Dict[str, Optional[str]] = {
560
+ '200': "List[ListOfValuesEntry]",
561
+ '400': "Error",
562
+ '404': "Error",
563
+ }
564
+ response_data = self.api_client.call_api(
565
+ *_param,
566
+ _request_timeout=_request_timeout
567
+ )
568
+ return response_data.response
569
+
570
+
571
+ def _list_of_values_id_value_entries_get_serialize(
572
+ self,
573
+ id,
574
+ context,
575
+ workspace,
576
+ _request_auth,
577
+ _content_type,
578
+ _headers,
579
+ _host_index,
580
+ ) -> RequestSerialized:
581
+
582
+ _host = None
583
+
584
+ _collection_formats: Dict[str, str] = {
585
+ }
586
+
587
+ _path_params: Dict[str, str] = {}
588
+ _query_params: List[Tuple[str, str]] = []
589
+ _header_params: Dict[str, Optional[str]] = _headers or {}
590
+ _form_params: List[Tuple[str, str]] = []
591
+ _files: Dict[
592
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
593
+ ] = {}
594
+ _body_params: Optional[bytes] = None
595
+
596
+ # process the path parameters
597
+ if id is not None:
598
+ _path_params['id'] = id
599
+ # process the query parameters
600
+ if context is not None:
601
+
602
+ _query_params.append(('context', context))
603
+
604
+ if workspace is not None:
605
+
606
+ _query_params.append(('workspace', workspace))
607
+
608
+ # process the header parameters
609
+ # process the form parameters
610
+ # process the body parameter
611
+
612
+
613
+ # set the HTTP header `Accept`
614
+ if 'Accept' not in _header_params:
615
+ _header_params['Accept'] = self.api_client.select_header_accept(
616
+ [
617
+ 'application/json'
618
+ ]
619
+ )
620
+
621
+
622
+ # authentication setting
623
+ _auth_settings: List[str] = [
624
+ 'basicAuth'
625
+ ]
626
+
627
+ return self.api_client.param_serialize(
628
+ method='GET',
629
+ resource_path='/list-of-values/{id}/value-entries',
630
+ path_params=_path_params,
631
+ query_params=_query_params,
632
+ header_params=_header_params,
633
+ body=_body_params,
634
+ post_params=_form_params,
635
+ files=_files,
636
+ auth_settings=_auth_settings,
637
+ collection_formats=_collection_formats,
638
+ _host=_host,
639
+ _request_auth=_request_auth
640
+ )
641
+
642
+