gamsapi 52.2.0__cp313-cp313-win_amd64.whl → 52.4.0__cp313-cp313-win_amd64.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 (294) hide show
  1. gams/__init__.py +2 -2
  2. gams/_version.py +1 -1
  3. gams/connect/__init__.py +2 -2
  4. gams/connect/agents/__init__.py +2 -2
  5. gams/connect/agents/_excel/__init__.py +2 -2
  6. gams/connect/agents/_excel/excelagent.py +2 -2
  7. gams/connect/agents/_excel/workbook.py +2 -2
  8. gams/connect/agents/_sqlconnectors/__init__.py +2 -2
  9. gams/connect/agents/_sqlconnectors/_accesshandler.py +2 -2
  10. gams/connect/agents/_sqlconnectors/_databasehandler.py +2 -2
  11. gams/connect/agents/_sqlconnectors/_mysqlhandler.py +2 -2
  12. gams/connect/agents/_sqlconnectors/_postgreshandler.py +2 -2
  13. gams/connect/agents/_sqlconnectors/_pyodbchandler.py +2 -2
  14. gams/connect/agents/_sqlconnectors/_sqlalchemyhandler.py +2 -2
  15. gams/connect/agents/_sqlconnectors/_sqlitehandler.py +2 -2
  16. gams/connect/agents/_sqlconnectors/_sqlserverhandler.py +2 -2
  17. gams/connect/agents/concatenate.py +2 -2
  18. gams/connect/agents/connectagent.py +2 -2
  19. gams/connect/agents/csvreader.py +2 -2
  20. gams/connect/agents/csvwriter.py +2 -2
  21. gams/connect/agents/domainwriter.py +2 -2
  22. gams/connect/agents/excelreader.py +2 -2
  23. gams/connect/agents/excelwriter.py +2 -2
  24. gams/connect/agents/filter.py +2 -2
  25. gams/connect/agents/gamsreader.py +2 -2
  26. gams/connect/agents/gamswriter.py +2 -2
  27. gams/connect/agents/gdxreader.py +2 -2
  28. gams/connect/agents/gdxwriter.py +2 -2
  29. gams/connect/agents/labelmanipulator.py +2 -2
  30. gams/connect/agents/projection.py +2 -2
  31. gams/connect/agents/pythoncode.py +2 -2
  32. gams/connect/agents/rawcsvreader.py +2 -2
  33. gams/connect/agents/rawexcelreader.py +2 -2
  34. gams/connect/agents/sqlreader.py +2 -2
  35. gams/connect/agents/sqlwriter.py +2 -2
  36. gams/connect/connectdatabase.py +2 -2
  37. gams/connect/connectvalidator.py +2 -2
  38. gams/connect/errors.py +2 -2
  39. gams/control/__init__.py +2 -2
  40. gams/control/database.py +2 -2
  41. gams/control/execution.py +2 -2
  42. gams/control/options.py +2 -2
  43. gams/control/workspace.py +2 -2
  44. gams/core/__init__.py +2 -2
  45. gams/core/cfg/__init__.py +2 -2
  46. gams/core/cfg/_cfgmcc.cp313-win_amd64.pyd +0 -0
  47. gams/core/dct/__init__.py +2 -2
  48. gams/core/dct/_dctmcc.cp313-win_amd64.pyd +0 -0
  49. gams/core/embedded/__init__.py +2 -2
  50. gams/core/embedded/gamsemb.py +2 -2
  51. gams/core/emp/__init__.py +2 -2
  52. gams/core/emp/emplexer.py +2 -2
  53. gams/core/emp/empyacc.py +2 -2
  54. gams/core/gdx/__init__.py +2 -2
  55. gams/core/gdx/_gdxcc.cp313-win_amd64.pyd +0 -0
  56. gams/core/gev/__init__.py +2 -2
  57. gams/core/gev/_gevmcc.cp313-win_amd64.pyd +0 -0
  58. gams/core/gmd/__init__.py +2 -2
  59. gams/core/gmd/_gmdcc.cp313-win_amd64.pyd +0 -0
  60. gams/core/gmo/__init__.py +2 -2
  61. gams/core/gmo/_gmomcc.cp313-win_amd64.pyd +0 -0
  62. gams/core/idx/__init__.py +2 -2
  63. gams/core/idx/_idxcc.cp313-win_amd64.pyd +0 -0
  64. gams/core/numpy/__init__.py +2 -2
  65. gams/core/numpy/_gams2numpy.cp313-win_amd64.pyd +0 -0
  66. gams/core/numpy/gams2numpy.py +2 -2
  67. gams/core/opt/__init__.py +2 -2
  68. gams/core/opt/_optcc.cp313-win_amd64.pyd +0 -0
  69. gams/engine/__init__.py +193 -16
  70. gams/engine/api/__init__.py +13 -3
  71. gams/engine/api/auth_api.py +7545 -3618
  72. gams/engine/api/cleanup_api.py +712 -320
  73. gams/engine/api/default_api.py +838 -369
  74. gams/engine/api/hypercube_api.py +2576 -1198
  75. gams/engine/api/jobs_api.py +5170 -2458
  76. gams/engine/api/licenses_api.py +2170 -1014
  77. gams/engine/api/namespaces_api.py +7663 -3557
  78. gams/engine/api/usage_api.py +5575 -1867
  79. gams/engine/api/users_api.py +5880 -2382
  80. gams/engine/api_client.py +579 -641
  81. gams/engine/api_response.py +21 -0
  82. gams/engine/configuration.py +233 -102
  83. gams/engine/exceptions.py +86 -29
  84. gams/engine/models/__init__.py +83 -68
  85. gams/engine/models/bad_input.py +89 -0
  86. gams/engine/models/cleanable_job_result.py +104 -0
  87. gams/engine/models/cleanable_job_result_page.py +113 -0
  88. gams/engine/models/engine_license.py +107 -0
  89. gams/engine/models/files_not_found.py +93 -0
  90. gams/engine/models/forwarded_token_response.py +112 -0
  91. gams/engine/models/generic_key_value_pair.py +89 -0
  92. gams/engine/models/hypercube.py +160 -0
  93. gams/engine/models/hypercube_page.py +111 -0
  94. gams/engine/models/hypercube_summary.py +91 -0
  95. gams/engine/models/hypercube_token.py +97 -0
  96. gams/engine/models/identity_provider.py +107 -0
  97. gams/engine/models/identity_provider_ldap.py +121 -0
  98. gams/engine/models/identity_provider_oauth2.py +146 -0
  99. gams/engine/models/identity_provider_oauth2_scope.py +89 -0
  100. gams/engine/models/identity_provider_oauth2_with_secret.py +152 -0
  101. gams/engine/models/identity_provider_oidc.py +133 -0
  102. gams/engine/models/identity_provider_oidc_with_secret.py +143 -0
  103. gams/engine/models/inex.py +91 -0
  104. gams/engine/models/invitation.py +136 -0
  105. gams/engine/models/invitation_quota.py +106 -0
  106. gams/engine/models/invitation_token.py +87 -0
  107. gams/engine/models/job.py +165 -0
  108. gams/engine/models/job_no_text_entry.py +138 -0
  109. gams/engine/models/job_no_text_entry_page.py +111 -0
  110. gams/engine/models/license.py +91 -0
  111. gams/engine/models/log_piece.py +96 -0
  112. gams/engine/models/message.py +87 -0
  113. gams/engine/models/message_and_token.py +99 -0
  114. gams/engine/models/message_with_webhook_id.py +89 -0
  115. gams/engine/models/model_auth_token.py +87 -0
  116. gams/engine/models/model_configuration.py +125 -0
  117. gams/engine/models/model_default_instance.py +99 -0
  118. gams/engine/models/model_default_user_instance.py +98 -0
  119. gams/engine/models/model_hypercube_job.py +106 -0
  120. gams/engine/models/model_hypercube_usage.py +130 -0
  121. gams/engine/models/model_instance_info.py +116 -0
  122. gams/engine/models/model_instance_info_full.py +123 -0
  123. gams/engine/models/model_instance_pool_info.py +112 -0
  124. gams/engine/models/model_job_labels.py +179 -0
  125. gams/engine/models/model_job_usage.py +133 -0
  126. gams/engine/models/model_pool_usage.py +124 -0
  127. gams/engine/models/model_usage.py +115 -0
  128. gams/engine/models/model_user.py +96 -0
  129. gams/engine/models/model_userinstance_info.py +119 -0
  130. gams/engine/models/model_userinstancepool_info.py +95 -0
  131. gams/engine/models/model_version.py +91 -0
  132. gams/engine/models/models.py +120 -0
  133. gams/engine/models/namespace.py +104 -0
  134. gams/engine/models/namespace_quota.py +96 -0
  135. gams/engine/models/namespace_with_permission.py +96 -0
  136. gams/engine/models/not_found.py +91 -0
  137. gams/engine/models/password_policy.py +97 -0
  138. gams/engine/models/perm_and_username.py +89 -0
  139. gams/engine/models/quota.py +117 -0
  140. gams/engine/models/quota_exceeded.py +97 -0
  141. gams/engine/models/status_code_meaning.py +89 -0
  142. gams/engine/models/stream_entry.py +89 -0
  143. gams/engine/models/system_wide_license.py +92 -0
  144. gams/engine/models/text_entries.py +87 -0
  145. gams/engine/models/text_entry.py +101 -0
  146. gams/engine/models/time_span.py +95 -0
  147. gams/engine/models/time_span_pool_worker.py +99 -0
  148. gams/engine/models/token_forward_error.py +87 -0
  149. gams/engine/models/user.py +127 -0
  150. gams/engine/models/user_group_member.py +96 -0
  151. gams/engine/models/user_groups.py +108 -0
  152. gams/engine/models/vapid_info.py +87 -0
  153. gams/engine/models/webhook.py +138 -0
  154. gams/engine/models/webhook_parameterized_event.py +99 -0
  155. gams/engine/py.typed +0 -0
  156. gams/engine/rest.py +141 -229
  157. gams/magic/__init__.py +2 -2
  158. gams/magic/gams_magic.py +2 -2
  159. gams/magic/interactive.py +2 -2
  160. gams/tools/__init__.py +2 -2
  161. gams/tools/errors.py +2 -2
  162. gams/tools/toolcollection/__init__.py +2 -2
  163. gams/tools/toolcollection/alg/__init__.py +2 -2
  164. gams/tools/toolcollection/alg/rank.py +2 -2
  165. gams/tools/toolcollection/data/__init__.py +2 -2
  166. gams/tools/toolcollection/data/csvread.py +2 -2
  167. gams/tools/toolcollection/data/exceldump.py +2 -2
  168. gams/tools/toolcollection/data/sqlitewrite.py +2 -2
  169. gams/tools/toolcollection/gdxservice/__init__.py +2 -2
  170. gams/tools/toolcollection/gdxservice/gdxencoding.py +2 -2
  171. gams/tools/toolcollection/gdxservice/gdxrename.py +2 -2
  172. gams/tools/toolcollection/linalg/__init__.py +2 -2
  173. gams/tools/toolcollection/linalg/cholesky.py +2 -2
  174. gams/tools/toolcollection/linalg/eigenvalue.py +2 -2
  175. gams/tools/toolcollection/linalg/eigenvector.py +2 -2
  176. gams/tools/toolcollection/linalg/invert.py +2 -2
  177. gams/tools/toolcollection/linalg/ols.py +2 -2
  178. gams/tools/toolcollection/tooltemplate.py +2 -2
  179. gams/tools/toolcollection/win32/__init__.py +2 -2
  180. gams/tools/toolcollection/win32/excelmerge.py +2 -2
  181. gams/tools/toolcollection/win32/exceltalk.py +2 -2
  182. gams/tools/toolcollection/win32/msappavail.py +2 -2
  183. gams/tools/toolcollection/win32/shellexecute.py +2 -2
  184. gams/tools/tools.py +2 -2
  185. gams/transfer/__init__.py +2 -2
  186. gams/transfer/_abcs/__init__.py +2 -2
  187. gams/transfer/_abcs/container_abcs.py +2 -2
  188. gams/transfer/_internals/__init__.py +2 -2
  189. gams/transfer/_internals/algorithms.py +2 -2
  190. gams/transfer/_internals/casepreservingdict.py +2 -2
  191. gams/transfer/_internals/constants.py +2 -2
  192. gams/transfer/_internals/domainviolation.py +2 -2
  193. gams/transfer/_internals/specialvalues.py +2 -2
  194. gams/transfer/containers/__init__.py +2 -2
  195. gams/transfer/containers/_container.py +2 -2
  196. gams/transfer/containers/_io/__init__.py +2 -2
  197. gams/transfer/containers/_io/containers.py +2 -2
  198. gams/transfer/containers/_io/gdx.py +2 -2
  199. gams/transfer/containers/_io/gmd.py +2 -2
  200. gams/transfer/containers/_mixins/__init__.py +2 -2
  201. gams/transfer/containers/_mixins/ccc.py +2 -2
  202. gams/transfer/syms/__init__.py +2 -2
  203. gams/transfer/syms/_methods/__init__.py +2 -2
  204. gams/transfer/syms/_methods/tables.py +2 -2
  205. gams/transfer/syms/_methods/toDict.py +2 -2
  206. gams/transfer/syms/_methods/toList.py +2 -2
  207. gams/transfer/syms/_methods/toValue.py +2 -2
  208. gams/transfer/syms/_mixins/__init__.py +2 -2
  209. gams/transfer/syms/_mixins/equals.py +2 -2
  210. gams/transfer/syms/_mixins/generateRecords.py +2 -2
  211. gams/transfer/syms/_mixins/pivot.py +2 -2
  212. gams/transfer/syms/_mixins/pve.py +2 -2
  213. gams/transfer/syms/_mixins/sa.py +2 -2
  214. gams/transfer/syms/_mixins/sapve.py +2 -2
  215. gams/transfer/syms/_mixins/saua.py +2 -2
  216. gams/transfer/syms/_mixins/sauapve.py +2 -2
  217. gams/transfer/syms/_mixins/spve.py +2 -2
  218. gams/transfer/syms/_mixins/ve.py +2 -2
  219. gams/transfer/syms/container_syms/__init__.py +2 -2
  220. gams/transfer/syms/container_syms/_alias.py +2 -2
  221. gams/transfer/syms/container_syms/_equation.py +2 -2
  222. gams/transfer/syms/container_syms/_parameter.py +2 -2
  223. gams/transfer/syms/container_syms/_set.py +2 -2
  224. gams/transfer/syms/container_syms/_universe_alias.py +2 -2
  225. gams/transfer/syms/container_syms/_variable.py +2 -2
  226. {gamsapi-52.2.0.dist-info → gamsapi-52.4.0.dist-info}/METADATA +12 -10
  227. gamsapi-52.4.0.dist-info/RECORD +257 -0
  228. {gamsapi-52.2.0.dist-info → gamsapi-52.4.0.dist-info}/licenses/LICENSE +2 -2
  229. gams/engine/apis/__init__.py +0 -25
  230. gams/engine/model/__init__.py +0 -5
  231. gams/engine/model/bad_input.py +0 -259
  232. gams/engine/model/cleanable_job_result.py +0 -285
  233. gams/engine/model/cleanable_job_result_page.py +0 -277
  234. gams/engine/model/engine_license.py +0 -263
  235. gams/engine/model/files_not_found.py +0 -267
  236. gams/engine/model/forwarded_token_response.py +0 -275
  237. gams/engine/model/generic_key_value_pair.py +0 -259
  238. gams/engine/model/hypercube.py +0 -331
  239. gams/engine/model/hypercube_page.py +0 -273
  240. gams/engine/model/hypercube_summary.py +0 -263
  241. gams/engine/model/hypercube_token.py +0 -265
  242. gams/engine/model/identity_provider.py +0 -287
  243. gams/engine/model/identity_provider_ldap.py +0 -303
  244. gams/engine/model/identity_provider_oauth2.py +0 -309
  245. gams/engine/model/identity_provider_oauth2_scope.py +0 -259
  246. gams/engine/model/identity_provider_oauth2_with_secret.py +0 -321
  247. gams/engine/model/identity_provider_oidc.py +0 -299
  248. gams/engine/model/identity_provider_oidc_with_secret.py +0 -319
  249. gams/engine/model/inex.py +0 -259
  250. gams/engine/model/invitation.py +0 -309
  251. gams/engine/model/invitation_quota.py +0 -263
  252. gams/engine/model/invitation_token.py +0 -255
  253. gams/engine/model/job.py +0 -337
  254. gams/engine/model/job_no_text_entry.py +0 -313
  255. gams/engine/model/job_no_text_entry_page.py +0 -273
  256. gams/engine/model/license.py +0 -263
  257. gams/engine/model/log_piece.py +0 -263
  258. gams/engine/model/message.py +0 -255
  259. gams/engine/model/message_and_token.py +0 -269
  260. gams/engine/model/model_auth_token.py +0 -255
  261. gams/engine/model/model_configuration.py +0 -268
  262. gams/engine/model/model_hypercube_job.py +0 -273
  263. gams/engine/model/model_hypercube_usage.py +0 -303
  264. gams/engine/model/model_instance_info.py +0 -285
  265. gams/engine/model/model_instance_info_full.py +0 -289
  266. gams/engine/model/model_job_labels.py +0 -295
  267. gams/engine/model/model_job_usage.py +0 -299
  268. gams/engine/model/model_usage.py +0 -267
  269. gams/engine/model/model_userinstance_info.py +0 -273
  270. gams/engine/model/model_version.py +0 -263
  271. gams/engine/model/models.py +0 -297
  272. gams/engine/model/namespace.py +0 -269
  273. gams/engine/model/namespace_quota.py +0 -263
  274. gams/engine/model/namespace_with_permission.py +0 -263
  275. gams/engine/model/not_found.py +0 -263
  276. gams/engine/model/perm_and_username.py +0 -259
  277. gams/engine/model/quota.py +0 -275
  278. gams/engine/model/quota_exceeded.py +0 -265
  279. gams/engine/model/result_user.py +0 -263
  280. gams/engine/model/status_code_meaning.py +0 -259
  281. gams/engine/model/stream_entry.py +0 -259
  282. gams/engine/model/system_wide_license.py +0 -255
  283. gams/engine/model/text_entries.py +0 -255
  284. gams/engine/model/text_entry.py +0 -263
  285. gams/engine/model/time_span.py +0 -259
  286. gams/engine/model/token_forward_error.py +0 -255
  287. gams/engine/model/user.py +0 -283
  288. gams/engine/model/user_group_member.py +0 -269
  289. gams/engine/model/user_groups.py +0 -279
  290. gams/engine/model/webhook.py +0 -292
  291. gams/engine/model_utils.py +0 -2037
  292. gamsapi-52.2.0.dist-info/RECORD +0 -248
  293. {gamsapi-52.2.0.dist-info → gamsapi-52.4.0.dist-info}/WHEEL +0 -0
  294. {gamsapi-52.2.0.dist-info → gamsapi-52.4.0.dist-info}/top_level.txt +0 -0
@@ -1,359 +1,751 @@
1
+ # coding: utf-8
2
+
1
3
  """
2
4
  GAMS Engine
3
5
 
4
- With GAMS Engine you can register and solve GAMS models. It has a namespace management system, so you can restrict your users to certain models. # noqa: E501
6
+ With GAMS Engine you can register and solve GAMS models. It has a namespace management system, so you can restrict your users to certain models.
5
7
 
6
8
  The version of the OpenAPI document: latest
7
- Generated by: https://openapi-generator.tech
8
- """
9
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
10
+
11
+ Do not edit the class manually.
12
+ """ # noqa: E501
9
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
10
18
 
11
- import re # noqa: F401
12
- import sys # noqa: F401
19
+ from datetime import datetime
20
+ from pydantic import Field, StrictBool, StrictStr, field_validator
21
+ from typing import List, Optional
22
+ from typing_extensions import Annotated
23
+ from gams.engine.models.cleanable_job_result_page import CleanableJobResultPage
24
+ from gams.engine.models.message import Message
13
25
 
14
- from gams.engine.api_client import ApiClient, Endpoint as _Endpoint
15
- from gams.engine.model_utils import ( # noqa: F401
16
- check_allowed_values,
17
- check_validations,
18
- date,
19
- datetime,
20
- file_type,
21
- none_type,
22
- validate_and_convert_types
23
- )
24
- from gams.engine.model.bad_input import BadInput
25
- from gams.engine.model.cleanable_job_result_page import CleanableJobResultPage
26
- from gams.engine.model.files_not_found import FilesNotFound
27
- from gams.engine.model.message import Message
26
+ from gams.engine.api_client import ApiClient, RequestSerialized
27
+ from gams.engine.api_response import ApiResponse
28
+ from gams.engine.rest import RESTResponseType
28
29
 
29
30
 
30
- class CleanupApi(object):
31
+ class CleanupApi:
31
32
  """NOTE: This class is auto generated by OpenAPI Generator
32
33
  Ref: https://openapi-generator.tech
33
34
 
34
35
  Do not edit the class manually.
35
36
  """
36
37
 
37
- def __init__(self, api_client=None):
38
+ def __init__(self, api_client=None) -> None:
38
39
  if api_client is None:
39
- api_client = ApiClient()
40
+ api_client = ApiClient.get_default()
40
41
  self.api_client = api_client
41
- self.list_results_endpoint = _Endpoint(
42
- settings={
43
- 'response_type': (CleanableJobResultPage,),
44
- 'auth': [
45
- 'BasicAuth'
46
- ],
47
- 'endpoint_path': '/cleanup/results',
48
- 'operation_id': 'list_results',
49
- 'http_method': 'GET',
50
- 'servers': None,
51
- },
52
- params_map={
53
- 'all': [
54
- 'page',
55
- 'per_page',
56
- 'order_by',
57
- 'order_asc',
58
- 'from_datetime',
59
- 'to_datetime',
60
- 'namespace',
61
- ],
62
- 'required': [],
63
- 'nullable': [
64
- ],
65
- 'enum': [
66
- 'order_by',
67
- ],
68
- 'validation': [
69
- 'page',
70
- 'per_page',
71
- ]
72
- },
73
- root_map={
74
- 'validations': {
75
- ('page',): {
76
-
77
- 'inclusive_maximum': 2147483647,
78
- 'inclusive_minimum': 1,
79
- },
80
- ('per_page',): {
81
-
82
- 'inclusive_maximum': 2147483647,
83
- 'inclusive_minimum': 0,
84
- },
85
- },
86
- 'allowed_values': {
87
- ('order_by',): {
88
-
89
- "FILENAME": "filename",
90
- "USERNAME": "username",
91
- "NAMESPACE": "namespace",
92
- "LENGTH": "length",
93
- "UPLOAD_DATE": "upload_date"
94
- },
95
- },
96
- 'openapi_types': {
97
- 'page':
98
- (int,),
99
- 'per_page':
100
- (int,),
101
- 'order_by':
102
- (str,),
103
- 'order_asc':
104
- (bool,),
105
- 'from_datetime':
106
- (datetime,),
107
- 'to_datetime':
108
- (datetime,),
109
- 'namespace':
110
- (str,),
111
- },
112
- 'attribute_map': {
113
- 'page': 'page',
114
- 'per_page': 'per_page',
115
- 'order_by': 'order_by',
116
- 'order_asc': 'order_asc',
117
- 'from_datetime': 'from_datetime',
118
- 'to_datetime': 'to_datetime',
119
- 'namespace': 'namespace',
120
- },
121
- 'location_map': {
122
- 'page': 'query',
123
- 'per_page': 'query',
124
- 'order_by': 'query',
125
- 'order_asc': 'query',
126
- 'from_datetime': 'query',
127
- 'to_datetime': 'query',
128
- 'namespace': 'query',
129
- },
130
- 'collection_format_map': {
131
- }
132
- },
133
- headers_map={
134
- 'accept': [
135
- 'application/json'
136
- ],
137
- 'content_type': [],
138
- },
139
- api_client=api_client
140
- )
141
- self.remove_results_endpoint = _Endpoint(
142
- settings={
143
- 'response_type': (Message,),
144
- 'auth': [
145
- 'BasicAuth'
146
- ],
147
- 'endpoint_path': '/cleanup/results',
148
- 'operation_id': 'remove_results',
149
- 'http_method': 'DELETE',
150
- 'servers': None,
151
- },
152
- params_map={
153
- 'all': [
154
- 'filename',
155
- 'token',
156
- 'hypercube_token',
157
- ],
158
- 'required': [],
159
- 'nullable': [
160
- ],
161
- 'enum': [
162
- ],
163
- 'validation': [
164
- ]
165
- },
166
- root_map={
167
- 'validations': {
168
- },
169
- 'allowed_values': {
170
- },
171
- 'openapi_types': {
172
- 'filename':
173
- ([str],),
174
- 'token':
175
- ([str],),
176
- 'hypercube_token':
177
- ([str],),
178
- },
179
- 'attribute_map': {
180
- 'filename': 'filename',
181
- 'token': 'token',
182
- 'hypercube_token': 'hypercube_token',
183
- },
184
- 'location_map': {
185
- 'filename': 'query',
186
- 'token': 'query',
187
- 'hypercube_token': 'query',
188
- },
189
- 'collection_format_map': {
190
- 'filename': 'multi',
191
- 'token': 'multi',
192
- 'hypercube_token': 'multi',
193
- }
194
- },
195
- headers_map={
196
- 'accept': [
197
- 'application/json'
198
- ],
199
- 'content_type': [],
200
- },
201
- api_client=api_client
202
- )
203
42
 
43
+
44
+ @validate_call
204
45
  def list_results(
205
46
  self,
206
- **kwargs
207
- ):
208
- """Lists all job and Hypercube results # noqa: E501
209
-
210
- Admins can see everyone's results. Inviters can see results of their own jobs as well as jobs of their invitees. Users can only see results of their own jobs. Note that jobs that are shared with the logged in user via access groups are not listed here. If the page is not one and there are no elements on this page, throws 404. # noqa: E501
211
- This method makes a synchronous HTTP request by default. To make an
212
- asynchronous HTTP request, please pass async_req=True
213
-
214
- >>> thread = api.list_results(async_req=True)
215
- >>> result = thread.get()
216
-
217
-
218
- Keyword Args:
219
- page (int): [optional] if omitted the server will use the default value of 1
220
- per_page (int): [optional] if omitted the server will use the default value of 0
221
- order_by (str): [optional] if omitted the server will use the default value of "upload_date"
222
- order_asc (bool): [optional] if omitted the server will use the default value of False
223
- from_datetime (datetime): iso8601 Datetime to select the results if they are uploaded before.. [optional]
224
- to_datetime (datetime): iso8601 Datetime to select the results if they are uploaded after.. [optional]
225
- namespace (str): Filter results by namespace.. [optional]
226
- _return_http_data_only (bool): response data without head status
227
- code and headers. Default is True.
228
- _preload_content (bool): if False, the urllib3.HTTPResponse object
229
- will be returned without reading/decoding response data.
230
- Default is True.
231
- _request_timeout (int/float/tuple): timeout setting for this request. If
232
- one number provided, it will be total request timeout. It can also
233
- be a pair (tuple) of (connection, read) timeouts.
234
- Default is None.
235
- _check_input_type (bool): specifies if type checking
236
- should be done one the data sent to the server.
237
- Default is True.
238
- _check_return_type (bool): specifies if type checking
239
- should be done one the data received from the server.
240
- Default is True.
241
- _spec_property_naming (bool): True if the variable names in the input data
242
- are serialized names, as specified in the OpenAPI document.
243
- False if the variable names in the input data
244
- are pythonic names, e.g. snake case (default)
245
- _content_type (str/None): force body content-type.
246
- Default is None and content-type will be predicted by allowed
247
- content-types and body.
248
- _host_index (int/None): specifies the index of the server
249
- that we want to use.
250
- Default is read from the configuration.
251
- async_req (bool): execute request asynchronously
252
-
253
- Returns:
254
- CleanableJobResultPage
255
- If the method is called asynchronously, returns the request
256
- thread.
257
- """
258
- kwargs['async_req'] = kwargs.get(
259
- 'async_req', False
47
+ page: Optional[Annotated[int, Field(le=2147483647, strict=True, ge=1)]] = None,
48
+ per_page: Optional[Annotated[int, Field(le=2147483647, strict=True, ge=0)]] = None,
49
+ order_by: Optional[StrictStr] = None,
50
+ order_asc: Optional[StrictBool] = None,
51
+ from_datetime: Annotated[Optional[datetime], Field(description="iso8601 Datetime to select the results if they are uploaded before.")] = None,
52
+ to_datetime: Annotated[Optional[datetime], Field(description="iso8601 Datetime to select the results if they are uploaded after.")] = None,
53
+ namespace: Annotated[Optional[StrictStr], Field(description="Filter results by namespace.")] = None,
54
+ _request_timeout: Union[
55
+ None,
56
+ Annotated[StrictFloat, Field(gt=0)],
57
+ Tuple[
58
+ Annotated[StrictFloat, Field(gt=0)],
59
+ Annotated[StrictFloat, Field(gt=0)]
60
+ ]
61
+ ] = None,
62
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
63
+ _content_type: Optional[StrictStr] = None,
64
+ _headers: Optional[Dict[StrictStr, Any]] = None,
65
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
66
+ ) -> CleanableJobResultPage:
67
+ """Lists all job and Hypercube results
68
+
69
+ Admins can see everyone's results. Inviters can see results of their own jobs as well as jobs of their invitees. Users can only see results of their own jobs. Note that jobs that are shared with the logged in user via access groups are not listed here. If the page is not one and there are no elements on this page, throws 404.
70
+
71
+ :param page:
72
+ :type page: int
73
+ :param per_page:
74
+ :type per_page: int
75
+ :param order_by:
76
+ :type order_by: str
77
+ :param order_asc:
78
+ :type order_asc: bool
79
+ :param from_datetime: iso8601 Datetime to select the results if they are uploaded before.
80
+ :type from_datetime: datetime
81
+ :param to_datetime: iso8601 Datetime to select the results if they are uploaded after.
82
+ :type to_datetime: datetime
83
+ :param namespace: Filter results by namespace.
84
+ :type namespace: str
85
+ :param _request_timeout: timeout setting for this request. If one
86
+ number provided, it will be total request
87
+ timeout. It can also be a pair (tuple) of
88
+ (connection, read) timeouts.
89
+ :type _request_timeout: int, tuple(int, int), optional
90
+ :param _request_auth: set to override the auth_settings for an a single
91
+ request; this effectively ignores the
92
+ authentication in the spec for a single request.
93
+ :type _request_auth: dict, optional
94
+ :param _content_type: force content-type for the request.
95
+ :type _content_type: str, Optional
96
+ :param _headers: set to override the headers for a single
97
+ request; this effectively ignores the headers
98
+ in the spec for a single request.
99
+ :type _headers: dict, optional
100
+ :param _host_index: set to override the host_index for a single
101
+ request; this effectively ignores the host_index
102
+ in the spec for a single request.
103
+ :type _host_index: int, optional
104
+ :return: Returns the result object.
105
+ """ # noqa: E501
106
+
107
+ _param = self._list_results_serialize(
108
+ page=page,
109
+ per_page=per_page,
110
+ order_by=order_by,
111
+ order_asc=order_asc,
112
+ from_datetime=from_datetime,
113
+ to_datetime=to_datetime,
114
+ namespace=namespace,
115
+ _request_auth=_request_auth,
116
+ _content_type=_content_type,
117
+ _headers=_headers,
118
+ _host_index=_host_index
260
119
  )
261
- kwargs['_return_http_data_only'] = kwargs.get(
262
- '_return_http_data_only', True
120
+
121
+ _response_types_map: Dict[str, Optional[str]] = {
122
+ '200': "CleanableJobResultPage",
123
+ '400': "Message",
124
+ '403': "Message",
125
+ '404': None,
126
+ '500': "Message",
127
+ }
128
+ response_data = self.api_client.call_api(
129
+ *_param,
130
+ _request_timeout=_request_timeout
263
131
  )
264
- kwargs['_preload_content'] = kwargs.get(
265
- '_preload_content', True
132
+ response_data.read()
133
+ return self.api_client.response_deserialize(
134
+ response_data=response_data,
135
+ response_types_map=_response_types_map,
136
+ ).data
137
+
138
+
139
+ @validate_call
140
+ def list_results_with_http_info(
141
+ self,
142
+ page: Optional[Annotated[int, Field(le=2147483647, strict=True, ge=1)]] = None,
143
+ per_page: Optional[Annotated[int, Field(le=2147483647, strict=True, ge=0)]] = None,
144
+ order_by: Optional[StrictStr] = None,
145
+ order_asc: Optional[StrictBool] = None,
146
+ from_datetime: Annotated[Optional[datetime], Field(description="iso8601 Datetime to select the results if they are uploaded before.")] = None,
147
+ to_datetime: Annotated[Optional[datetime], Field(description="iso8601 Datetime to select the results if they are uploaded after.")] = None,
148
+ namespace: Annotated[Optional[StrictStr], Field(description="Filter results by namespace.")] = None,
149
+ _request_timeout: Union[
150
+ None,
151
+ Annotated[StrictFloat, Field(gt=0)],
152
+ Tuple[
153
+ Annotated[StrictFloat, Field(gt=0)],
154
+ Annotated[StrictFloat, Field(gt=0)]
155
+ ]
156
+ ] = None,
157
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
158
+ _content_type: Optional[StrictStr] = None,
159
+ _headers: Optional[Dict[StrictStr, Any]] = None,
160
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
161
+ ) -> ApiResponse[CleanableJobResultPage]:
162
+ """Lists all job and Hypercube results
163
+
164
+ Admins can see everyone's results. Inviters can see results of their own jobs as well as jobs of their invitees. Users can only see results of their own jobs. Note that jobs that are shared with the logged in user via access groups are not listed here. If the page is not one and there are no elements on this page, throws 404.
165
+
166
+ :param page:
167
+ :type page: int
168
+ :param per_page:
169
+ :type per_page: int
170
+ :param order_by:
171
+ :type order_by: str
172
+ :param order_asc:
173
+ :type order_asc: bool
174
+ :param from_datetime: iso8601 Datetime to select the results if they are uploaded before.
175
+ :type from_datetime: datetime
176
+ :param to_datetime: iso8601 Datetime to select the results if they are uploaded after.
177
+ :type to_datetime: datetime
178
+ :param namespace: Filter results by namespace.
179
+ :type namespace: str
180
+ :param _request_timeout: timeout setting for this request. If one
181
+ number provided, it will be total request
182
+ timeout. It can also be a pair (tuple) of
183
+ (connection, read) timeouts.
184
+ :type _request_timeout: int, tuple(int, int), optional
185
+ :param _request_auth: set to override the auth_settings for an a single
186
+ request; this effectively ignores the
187
+ authentication in the spec for a single request.
188
+ :type _request_auth: dict, optional
189
+ :param _content_type: force content-type for the request.
190
+ :type _content_type: str, Optional
191
+ :param _headers: set to override the headers for a single
192
+ request; this effectively ignores the headers
193
+ in the spec for a single request.
194
+ :type _headers: dict, optional
195
+ :param _host_index: set to override the host_index for a single
196
+ request; this effectively ignores the host_index
197
+ in the spec for a single request.
198
+ :type _host_index: int, optional
199
+ :return: Returns the result object.
200
+ """ # noqa: E501
201
+
202
+ _param = self._list_results_serialize(
203
+ page=page,
204
+ per_page=per_page,
205
+ order_by=order_by,
206
+ order_asc=order_asc,
207
+ from_datetime=from_datetime,
208
+ to_datetime=to_datetime,
209
+ namespace=namespace,
210
+ _request_auth=_request_auth,
211
+ _content_type=_content_type,
212
+ _headers=_headers,
213
+ _host_index=_host_index
266
214
  )
267
- kwargs['_request_timeout'] = kwargs.get(
268
- '_request_timeout', None
215
+
216
+ _response_types_map: Dict[str, Optional[str]] = {
217
+ '200': "CleanableJobResultPage",
218
+ '400': "Message",
219
+ '403': "Message",
220
+ '404': None,
221
+ '500': "Message",
222
+ }
223
+ response_data = self.api_client.call_api(
224
+ *_param,
225
+ _request_timeout=_request_timeout
269
226
  )
270
- kwargs['_check_input_type'] = kwargs.get(
271
- '_check_input_type', True
227
+ response_data.read()
228
+ return self.api_client.response_deserialize(
229
+ response_data=response_data,
230
+ response_types_map=_response_types_map,
272
231
  )
273
- kwargs['_check_return_type'] = kwargs.get(
274
- '_check_return_type', True
232
+
233
+
234
+ @validate_call
235
+ def list_results_without_preload_content(
236
+ self,
237
+ page: Optional[Annotated[int, Field(le=2147483647, strict=True, ge=1)]] = None,
238
+ per_page: Optional[Annotated[int, Field(le=2147483647, strict=True, ge=0)]] = None,
239
+ order_by: Optional[StrictStr] = None,
240
+ order_asc: Optional[StrictBool] = None,
241
+ from_datetime: Annotated[Optional[datetime], Field(description="iso8601 Datetime to select the results if they are uploaded before.")] = None,
242
+ to_datetime: Annotated[Optional[datetime], Field(description="iso8601 Datetime to select the results if they are uploaded after.")] = None,
243
+ namespace: Annotated[Optional[StrictStr], Field(description="Filter results by namespace.")] = None,
244
+ _request_timeout: Union[
245
+ None,
246
+ Annotated[StrictFloat, Field(gt=0)],
247
+ Tuple[
248
+ Annotated[StrictFloat, Field(gt=0)],
249
+ Annotated[StrictFloat, Field(gt=0)]
250
+ ]
251
+ ] = None,
252
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
253
+ _content_type: Optional[StrictStr] = None,
254
+ _headers: Optional[Dict[StrictStr, Any]] = None,
255
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
256
+ ) -> RESTResponseType:
257
+ """Lists all job and Hypercube results
258
+
259
+ Admins can see everyone's results. Inviters can see results of their own jobs as well as jobs of their invitees. Users can only see results of their own jobs. Note that jobs that are shared with the logged in user via access groups are not listed here. If the page is not one and there are no elements on this page, throws 404.
260
+
261
+ :param page:
262
+ :type page: int
263
+ :param per_page:
264
+ :type per_page: int
265
+ :param order_by:
266
+ :type order_by: str
267
+ :param order_asc:
268
+ :type order_asc: bool
269
+ :param from_datetime: iso8601 Datetime to select the results if they are uploaded before.
270
+ :type from_datetime: datetime
271
+ :param to_datetime: iso8601 Datetime to select the results if they are uploaded after.
272
+ :type to_datetime: datetime
273
+ :param namespace: Filter results by namespace.
274
+ :type namespace: str
275
+ :param _request_timeout: timeout setting for this request. If one
276
+ number provided, it will be total request
277
+ timeout. It can also be a pair (tuple) of
278
+ (connection, read) timeouts.
279
+ :type _request_timeout: int, tuple(int, int), optional
280
+ :param _request_auth: set to override the auth_settings for an a single
281
+ request; this effectively ignores the
282
+ authentication in the spec for a single request.
283
+ :type _request_auth: dict, optional
284
+ :param _content_type: force content-type for the request.
285
+ :type _content_type: str, Optional
286
+ :param _headers: set to override the headers for a single
287
+ request; this effectively ignores the headers
288
+ in the spec for a single request.
289
+ :type _headers: dict, optional
290
+ :param _host_index: set to override the host_index for a single
291
+ request; this effectively ignores the host_index
292
+ in the spec for a single request.
293
+ :type _host_index: int, optional
294
+ :return: Returns the result object.
295
+ """ # noqa: E501
296
+
297
+ _param = self._list_results_serialize(
298
+ page=page,
299
+ per_page=per_page,
300
+ order_by=order_by,
301
+ order_asc=order_asc,
302
+ from_datetime=from_datetime,
303
+ to_datetime=to_datetime,
304
+ namespace=namespace,
305
+ _request_auth=_request_auth,
306
+ _content_type=_content_type,
307
+ _headers=_headers,
308
+ _host_index=_host_index
275
309
  )
276
- kwargs['_spec_property_naming'] = kwargs.get(
277
- '_spec_property_naming', False
310
+
311
+ _response_types_map: Dict[str, Optional[str]] = {
312
+ '200': "CleanableJobResultPage",
313
+ '400': "Message",
314
+ '403': "Message",
315
+ '404': None,
316
+ '500': "Message",
317
+ }
318
+ response_data = self.api_client.call_api(
319
+ *_param,
320
+ _request_timeout=_request_timeout
278
321
  )
279
- kwargs['_content_type'] = kwargs.get(
280
- '_content_type')
281
- kwargs['_host_index'] = kwargs.get('_host_index')
282
- return self.list_results_endpoint.call_with_http_info(**kwargs)
322
+ return response_data.response
323
+
324
+
325
+ def _list_results_serialize(
326
+ self,
327
+ page,
328
+ per_page,
329
+ order_by,
330
+ order_asc,
331
+ from_datetime,
332
+ to_datetime,
333
+ namespace,
334
+ _request_auth,
335
+ _content_type,
336
+ _headers,
337
+ _host_index,
338
+ ) -> RequestSerialized:
339
+
340
+ _host = None
341
+
342
+ _collection_formats: Dict[str, str] = {
343
+ }
344
+
345
+ _path_params: Dict[str, str] = {}
346
+ _query_params: List[Tuple[str, str]] = []
347
+ _header_params: Dict[str, Optional[str]] = _headers or {}
348
+ _form_params: List[Tuple[str, str]] = []
349
+ _files: Dict[
350
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
351
+ ] = {}
352
+ _body_params: Optional[bytes] = None
353
+
354
+ # process the path parameters
355
+ # process the query parameters
356
+ if page is not None:
357
+
358
+ _query_params.append(('page', page))
359
+
360
+ if per_page is not None:
361
+
362
+ _query_params.append(('per_page', per_page))
363
+
364
+ if order_by is not None:
365
+
366
+ _query_params.append(('order_by', order_by))
367
+
368
+ if order_asc is not None:
369
+
370
+ _query_params.append(('order_asc', order_asc))
371
+
372
+ if from_datetime is not None:
373
+ if isinstance(from_datetime, datetime):
374
+ _query_params.append(
375
+ (
376
+ 'from_datetime',
377
+ from_datetime.strftime(
378
+ self.api_client.configuration.datetime_format
379
+ )
380
+ )
381
+ )
382
+ else:
383
+ _query_params.append(('from_datetime', from_datetime))
384
+
385
+ if to_datetime is not None:
386
+ if isinstance(to_datetime, datetime):
387
+ _query_params.append(
388
+ (
389
+ 'to_datetime',
390
+ to_datetime.strftime(
391
+ self.api_client.configuration.datetime_format
392
+ )
393
+ )
394
+ )
395
+ else:
396
+ _query_params.append(('to_datetime', to_datetime))
397
+
398
+ if namespace is not None:
399
+
400
+ _query_params.append(('namespace', namespace))
401
+
402
+ # process the header parameters
403
+ # process the form parameters
404
+ # process the body parameter
405
+
406
+
407
+ # set the HTTP header `Accept`
408
+ if 'Accept' not in _header_params:
409
+ _header_params['Accept'] = self.api_client.select_header_accept(
410
+ [
411
+ 'application/json'
412
+ ]
413
+ )
414
+
283
415
 
416
+ # authentication setting
417
+ _auth_settings: List[str] = [
418
+ 'BasicAuth'
419
+ ]
420
+
421
+ return self.api_client.param_serialize(
422
+ method='GET',
423
+ resource_path='/cleanup/results',
424
+ path_params=_path_params,
425
+ query_params=_query_params,
426
+ header_params=_header_params,
427
+ body=_body_params,
428
+ post_params=_form_params,
429
+ files=_files,
430
+ auth_settings=_auth_settings,
431
+ collection_formats=_collection_formats,
432
+ _host=_host,
433
+ _request_auth=_request_auth
434
+ )
435
+
436
+
437
+
438
+
439
+ @validate_call
284
440
  def remove_results(
285
441
  self,
286
- **kwargs
287
- ):
288
- """Deletes job results and Hypercube results # noqa: E501
289
-
290
- If a submission token is specified, text entries are also deleted. Admins can delete everyone's results. Inviters can delete results of their own jobs as well as jobs of their invitees. Users can only delete results of their own jobs. Note that jobs that are shared with the logged in user via access groups cannot be deleted via this endpoint. At most 10000 files can be deleted with a single request. # noqa: E501
291
- This method makes a synchronous HTTP request by default. To make an
292
- asynchronous HTTP request, please pass async_req=True
293
-
294
- >>> thread = api.remove_results(async_req=True)
295
- >>> result = thread.get()
296
-
297
-
298
- Keyword Args:
299
- filename ([str]): [optional]
300
- token ([str]): [optional]
301
- hypercube_token ([str]): [optional]
302
- _return_http_data_only (bool): response data without head status
303
- code and headers. Default is True.
304
- _preload_content (bool): if False, the urllib3.HTTPResponse object
305
- will be returned without reading/decoding response data.
306
- Default is True.
307
- _request_timeout (int/float/tuple): timeout setting for this request. If
308
- one number provided, it will be total request timeout. It can also
309
- be a pair (tuple) of (connection, read) timeouts.
310
- Default is None.
311
- _check_input_type (bool): specifies if type checking
312
- should be done one the data sent to the server.
313
- Default is True.
314
- _check_return_type (bool): specifies if type checking
315
- should be done one the data received from the server.
316
- Default is True.
317
- _spec_property_naming (bool): True if the variable names in the input data
318
- are serialized names, as specified in the OpenAPI document.
319
- False if the variable names in the input data
320
- are pythonic names, e.g. snake case (default)
321
- _content_type (str/None): force body content-type.
322
- Default is None and content-type will be predicted by allowed
323
- content-types and body.
324
- _host_index (int/None): specifies the index of the server
325
- that we want to use.
326
- Default is read from the configuration.
327
- async_req (bool): execute request asynchronously
328
-
329
- Returns:
330
- Message
331
- If the method is called asynchronously, returns the request
332
- thread.
333
- """
334
- kwargs['async_req'] = kwargs.get(
335
- 'async_req', False
442
+ filename: Optional[List[StrictStr]] = None,
443
+ token: Optional[List[StrictStr]] = None,
444
+ hypercube_token: Optional[List[StrictStr]] = None,
445
+ _request_timeout: Union[
446
+ None,
447
+ Annotated[StrictFloat, Field(gt=0)],
448
+ Tuple[
449
+ Annotated[StrictFloat, Field(gt=0)],
450
+ Annotated[StrictFloat, Field(gt=0)]
451
+ ]
452
+ ] = None,
453
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
454
+ _content_type: Optional[StrictStr] = None,
455
+ _headers: Optional[Dict[StrictStr, Any]] = None,
456
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
457
+ ) -> Message:
458
+ """Deletes job results and Hypercube results
459
+
460
+ If a submission token is specified, text entries are also deleted. Admins can delete everyone's results. Inviters can delete results of their own jobs as well as jobs of their invitees. Users can only delete results of their own jobs. Note that jobs that are shared with the logged in user via access groups cannot be deleted via this endpoint. At most 1000 files can be deleted with a single request.
461
+
462
+ :param filename:
463
+ :type filename: List[str]
464
+ :param token:
465
+ :type token: List[str]
466
+ :param hypercube_token:
467
+ :type hypercube_token: List[str]
468
+ :param _request_timeout: timeout setting for this request. If one
469
+ number provided, it will be total request
470
+ timeout. It can also be a pair (tuple) of
471
+ (connection, read) timeouts.
472
+ :type _request_timeout: int, tuple(int, int), optional
473
+ :param _request_auth: set to override the auth_settings for an a single
474
+ request; this effectively ignores the
475
+ authentication in the spec for a single request.
476
+ :type _request_auth: dict, optional
477
+ :param _content_type: force content-type for the request.
478
+ :type _content_type: str, Optional
479
+ :param _headers: set to override the headers for a single
480
+ request; this effectively ignores the headers
481
+ in the spec for a single request.
482
+ :type _headers: dict, optional
483
+ :param _host_index: set to override the host_index for a single
484
+ request; this effectively ignores the host_index
485
+ in the spec for a single request.
486
+ :type _host_index: int, optional
487
+ :return: Returns the result object.
488
+ """ # noqa: E501
489
+
490
+ _param = self._remove_results_serialize(
491
+ filename=filename,
492
+ token=token,
493
+ hypercube_token=hypercube_token,
494
+ _request_auth=_request_auth,
495
+ _content_type=_content_type,
496
+ _headers=_headers,
497
+ _host_index=_host_index
498
+ )
499
+
500
+ _response_types_map: Dict[str, Optional[str]] = {
501
+ '200': "Message",
502
+ '400': "BadInput",
503
+ '403': "Message",
504
+ '404': "FilesNotFound",
505
+ '413': "Message",
506
+ '500': "Message",
507
+ }
508
+ response_data = self.api_client.call_api(
509
+ *_param,
510
+ _request_timeout=_request_timeout
336
511
  )
337
- kwargs['_return_http_data_only'] = kwargs.get(
338
- '_return_http_data_only', True
512
+ response_data.read()
513
+ return self.api_client.response_deserialize(
514
+ response_data=response_data,
515
+ response_types_map=_response_types_map,
516
+ ).data
517
+
518
+
519
+ @validate_call
520
+ def remove_results_with_http_info(
521
+ self,
522
+ filename: Optional[List[StrictStr]] = None,
523
+ token: Optional[List[StrictStr]] = None,
524
+ hypercube_token: Optional[List[StrictStr]] = None,
525
+ _request_timeout: Union[
526
+ None,
527
+ Annotated[StrictFloat, Field(gt=0)],
528
+ Tuple[
529
+ Annotated[StrictFloat, Field(gt=0)],
530
+ Annotated[StrictFloat, Field(gt=0)]
531
+ ]
532
+ ] = None,
533
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
534
+ _content_type: Optional[StrictStr] = None,
535
+ _headers: Optional[Dict[StrictStr, Any]] = None,
536
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
537
+ ) -> ApiResponse[Message]:
538
+ """Deletes job results and Hypercube results
539
+
540
+ If a submission token is specified, text entries are also deleted. Admins can delete everyone's results. Inviters can delete results of their own jobs as well as jobs of their invitees. Users can only delete results of their own jobs. Note that jobs that are shared with the logged in user via access groups cannot be deleted via this endpoint. At most 1000 files can be deleted with a single request.
541
+
542
+ :param filename:
543
+ :type filename: List[str]
544
+ :param token:
545
+ :type token: List[str]
546
+ :param hypercube_token:
547
+ :type hypercube_token: List[str]
548
+ :param _request_timeout: timeout setting for this request. If one
549
+ number provided, it will be total request
550
+ timeout. It can also be a pair (tuple) of
551
+ (connection, read) timeouts.
552
+ :type _request_timeout: int, tuple(int, int), optional
553
+ :param _request_auth: set to override the auth_settings for an a single
554
+ request; this effectively ignores the
555
+ authentication in the spec for a single request.
556
+ :type _request_auth: dict, optional
557
+ :param _content_type: force content-type for the request.
558
+ :type _content_type: str, Optional
559
+ :param _headers: set to override the headers for a single
560
+ request; this effectively ignores the headers
561
+ in the spec for a single request.
562
+ :type _headers: dict, optional
563
+ :param _host_index: set to override the host_index for a single
564
+ request; this effectively ignores the host_index
565
+ in the spec for a single request.
566
+ :type _host_index: int, optional
567
+ :return: Returns the result object.
568
+ """ # noqa: E501
569
+
570
+ _param = self._remove_results_serialize(
571
+ filename=filename,
572
+ token=token,
573
+ hypercube_token=hypercube_token,
574
+ _request_auth=_request_auth,
575
+ _content_type=_content_type,
576
+ _headers=_headers,
577
+ _host_index=_host_index
339
578
  )
340
- kwargs['_preload_content'] = kwargs.get(
341
- '_preload_content', True
579
+
580
+ _response_types_map: Dict[str, Optional[str]] = {
581
+ '200': "Message",
582
+ '400': "BadInput",
583
+ '403': "Message",
584
+ '404': "FilesNotFound",
585
+ '413': "Message",
586
+ '500': "Message",
587
+ }
588
+ response_data = self.api_client.call_api(
589
+ *_param,
590
+ _request_timeout=_request_timeout
342
591
  )
343
- kwargs['_request_timeout'] = kwargs.get(
344
- '_request_timeout', None
592
+ response_data.read()
593
+ return self.api_client.response_deserialize(
594
+ response_data=response_data,
595
+ response_types_map=_response_types_map,
345
596
  )
346
- kwargs['_check_input_type'] = kwargs.get(
347
- '_check_input_type', True
597
+
598
+
599
+ @validate_call
600
+ def remove_results_without_preload_content(
601
+ self,
602
+ filename: Optional[List[StrictStr]] = None,
603
+ token: Optional[List[StrictStr]] = None,
604
+ hypercube_token: Optional[List[StrictStr]] = None,
605
+ _request_timeout: Union[
606
+ None,
607
+ Annotated[StrictFloat, Field(gt=0)],
608
+ Tuple[
609
+ Annotated[StrictFloat, Field(gt=0)],
610
+ Annotated[StrictFloat, Field(gt=0)]
611
+ ]
612
+ ] = None,
613
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
614
+ _content_type: Optional[StrictStr] = None,
615
+ _headers: Optional[Dict[StrictStr, Any]] = None,
616
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
617
+ ) -> RESTResponseType:
618
+ """Deletes job results and Hypercube results
619
+
620
+ If a submission token is specified, text entries are also deleted. Admins can delete everyone's results. Inviters can delete results of their own jobs as well as jobs of their invitees. Users can only delete results of their own jobs. Note that jobs that are shared with the logged in user via access groups cannot be deleted via this endpoint. At most 1000 files can be deleted with a single request.
621
+
622
+ :param filename:
623
+ :type filename: List[str]
624
+ :param token:
625
+ :type token: List[str]
626
+ :param hypercube_token:
627
+ :type hypercube_token: List[str]
628
+ :param _request_timeout: timeout setting for this request. If one
629
+ number provided, it will be total request
630
+ timeout. It can also be a pair (tuple) of
631
+ (connection, read) timeouts.
632
+ :type _request_timeout: int, tuple(int, int), optional
633
+ :param _request_auth: set to override the auth_settings for an a single
634
+ request; this effectively ignores the
635
+ authentication in the spec for a single request.
636
+ :type _request_auth: dict, optional
637
+ :param _content_type: force content-type for the request.
638
+ :type _content_type: str, Optional
639
+ :param _headers: set to override the headers for a single
640
+ request; this effectively ignores the headers
641
+ in the spec for a single request.
642
+ :type _headers: dict, optional
643
+ :param _host_index: set to override the host_index for a single
644
+ request; this effectively ignores the host_index
645
+ in the spec for a single request.
646
+ :type _host_index: int, optional
647
+ :return: Returns the result object.
648
+ """ # noqa: E501
649
+
650
+ _param = self._remove_results_serialize(
651
+ filename=filename,
652
+ token=token,
653
+ hypercube_token=hypercube_token,
654
+ _request_auth=_request_auth,
655
+ _content_type=_content_type,
656
+ _headers=_headers,
657
+ _host_index=_host_index
348
658
  )
349
- kwargs['_check_return_type'] = kwargs.get(
350
- '_check_return_type', True
659
+
660
+ _response_types_map: Dict[str, Optional[str]] = {
661
+ '200': "Message",
662
+ '400': "BadInput",
663
+ '403': "Message",
664
+ '404': "FilesNotFound",
665
+ '413': "Message",
666
+ '500': "Message",
667
+ }
668
+ response_data = self.api_client.call_api(
669
+ *_param,
670
+ _request_timeout=_request_timeout
351
671
  )
352
- kwargs['_spec_property_naming'] = kwargs.get(
353
- '_spec_property_naming', False
672
+ return response_data.response
673
+
674
+
675
+ def _remove_results_serialize(
676
+ self,
677
+ filename,
678
+ token,
679
+ hypercube_token,
680
+ _request_auth,
681
+ _content_type,
682
+ _headers,
683
+ _host_index,
684
+ ) -> RequestSerialized:
685
+
686
+ _host = None
687
+
688
+ _collection_formats: Dict[str, str] = {
689
+ 'filename': 'multi',
690
+ 'token': 'multi',
691
+ 'hypercube_token': 'multi',
692
+ }
693
+
694
+ _path_params: Dict[str, str] = {}
695
+ _query_params: List[Tuple[str, str]] = []
696
+ _header_params: Dict[str, Optional[str]] = _headers or {}
697
+ _form_params: List[Tuple[str, str]] = []
698
+ _files: Dict[
699
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
700
+ ] = {}
701
+ _body_params: Optional[bytes] = None
702
+
703
+ # process the path parameters
704
+ # process the query parameters
705
+ if filename is not None:
706
+
707
+ _query_params.append(('filename', filename))
708
+
709
+ if token is not None:
710
+
711
+ _query_params.append(('token', token))
712
+
713
+ if hypercube_token is not None:
714
+
715
+ _query_params.append(('hypercube_token', hypercube_token))
716
+
717
+ # process the header parameters
718
+ # process the form parameters
719
+ # process the body parameter
720
+
721
+
722
+ # set the HTTP header `Accept`
723
+ if 'Accept' not in _header_params:
724
+ _header_params['Accept'] = self.api_client.select_header_accept(
725
+ [
726
+ 'application/json'
727
+ ]
728
+ )
729
+
730
+
731
+ # authentication setting
732
+ _auth_settings: List[str] = [
733
+ 'BasicAuth'
734
+ ]
735
+
736
+ return self.api_client.param_serialize(
737
+ method='DELETE',
738
+ resource_path='/cleanup/results',
739
+ path_params=_path_params,
740
+ query_params=_query_params,
741
+ header_params=_header_params,
742
+ body=_body_params,
743
+ post_params=_form_params,
744
+ files=_files,
745
+ auth_settings=_auth_settings,
746
+ collection_formats=_collection_formats,
747
+ _host=_host,
748
+ _request_auth=_request_auth
354
749
  )
355
- kwargs['_content_type'] = kwargs.get(
356
- '_content_type')
357
- kwargs['_host_index'] = kwargs.get('_host_index')
358
- return self.remove_results_endpoint.call_with_http_info(**kwargs)
750
+
359
751