gamsapi 52.2.0__cp314-cp314-win_amd64.whl → 52.4.0__cp314-cp314-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.cp314-win_amd64.pyd +0 -0
  47. gams/core/dct/__init__.py +2 -2
  48. gams/core/dct/_dctmcc.cp314-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.cp314-win_amd64.pyd +0 -0
  56. gams/core/gev/__init__.py +2 -2
  57. gams/core/gev/_gevmcc.cp314-win_amd64.pyd +0 -0
  58. gams/core/gmd/__init__.py +2 -2
  59. gams/core/gmd/_gmdcc.cp314-win_amd64.pyd +0 -0
  60. gams/core/gmo/__init__.py +2 -2
  61. gams/core/gmo/_gmomcc.cp314-win_amd64.pyd +0 -0
  62. gams/core/idx/__init__.py +2 -2
  63. gams/core/idx/_idxcc.cp314-win_amd64.pyd +0 -0
  64. gams/core/numpy/__init__.py +2 -2
  65. gams/core/numpy/_gams2numpy.cp314-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.cp314-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,418 +1,887 @@
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 pydantic import Field, StrictStr, field_validator
20
+ from typing import Optional
21
+ from typing_extensions import Annotated
22
+ from gams.engine.models.message import Message
23
+ from gams.engine.models.model_configuration import ModelConfiguration
24
+ from gams.engine.models.model_version import ModelVersion
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.message import Message
25
- from gams.engine.model.model_configuration import ModelConfiguration
26
- from gams.engine.model.model_version import ModelVersion
26
+ from gams.engine.api_client import ApiClient, RequestSerialized
27
+ from gams.engine.api_response import ApiResponse
28
+ from gams.engine.rest import RESTResponseType
27
29
 
28
30
 
29
- class DefaultApi(object):
31
+ class DefaultApi:
30
32
  """NOTE: This class is auto generated by OpenAPI Generator
31
33
  Ref: https://openapi-generator.tech
32
34
 
33
35
  Do not edit the class manually.
34
36
  """
35
37
 
36
- def __init__(self, api_client=None):
38
+ def __init__(self, api_client=None) -> None:
37
39
  if api_client is None:
38
- api_client = ApiClient()
40
+ api_client = ApiClient.get_default()
39
41
  self.api_client = api_client
40
- self.get_configuration_endpoint = _Endpoint(
41
- settings={
42
- 'response_type': (ModelConfiguration,),
43
- 'auth': [],
44
- 'endpoint_path': '/configuration',
45
- 'operation_id': 'get_configuration',
46
- 'http_method': 'GET',
47
- 'servers': None,
48
- },
49
- params_map={
50
- 'all': [
51
- ],
52
- 'required': [],
53
- 'nullable': [
54
- ],
55
- 'enum': [
56
- ],
57
- 'validation': [
58
- ]
59
- },
60
- root_map={
61
- 'validations': {
62
- },
63
- 'allowed_values': {
64
- },
65
- 'openapi_types': {
66
- },
67
- 'attribute_map': {
68
- },
69
- 'location_map': {
70
- },
71
- 'collection_format_map': {
72
- }
73
- },
74
- headers_map={
75
- 'accept': [
76
- 'application/json'
77
- ],
78
- 'content_type': [],
79
- },
80
- api_client=api_client
81
- )
82
- self.get_version_endpoint = _Endpoint(
83
- settings={
84
- 'response_type': (ModelVersion,),
85
- 'auth': [],
86
- 'endpoint_path': '/version',
87
- 'operation_id': 'get_version',
88
- 'http_method': 'GET',
89
- 'servers': None,
90
- },
91
- params_map={
92
- 'all': [
93
- ],
94
- 'required': [],
95
- 'nullable': [
96
- ],
97
- 'enum': [
98
- ],
99
- 'validation': [
100
- ]
101
- },
102
- root_map={
103
- 'validations': {
104
- },
105
- 'allowed_values': {
106
- },
107
- 'openapi_types': {
108
- },
109
- 'attribute_map': {
110
- },
111
- 'location_map': {
112
- },
113
- 'collection_format_map': {
114
- }
115
- },
116
- headers_map={
117
- 'accept': [
118
- 'application/json'
119
- ],
120
- 'content_type': [],
121
- },
122
- api_client=api_client
123
- )
124
- self.update_configuration_endpoint = _Endpoint(
125
- settings={
126
- 'response_type': (Message,),
127
- 'auth': [
128
- 'BasicAuth'
129
- ],
130
- 'endpoint_path': '/configuration',
131
- 'operation_id': 'update_configuration',
132
- 'http_method': 'PATCH',
133
- 'servers': None,
134
- },
135
- params_map={
136
- 'all': [
137
- 'webhook_access',
138
- 'text_entries_max_size',
139
- 'hostname',
140
- ],
141
- 'required': [],
142
- 'nullable': [
143
- ],
144
- 'enum': [
145
- 'webhook_access',
146
- ],
147
- 'validation': [
148
- 'text_entries_max_size',
149
- ]
150
- },
151
- root_map={
152
- 'validations': {
153
- ('text_entries_max_size',): {
154
-
155
- 'inclusive_maximum': 1000000000,
156
- 'inclusive_minimum': 0,
157
- },
158
- },
159
- 'allowed_values': {
160
- ('webhook_access',): {
161
-
162
- "DISABLED": "DISABLED",
163
- "ADMIN_ONLY": "ADMIN_ONLY",
164
- "ENABLED": "ENABLED"
165
- },
166
- },
167
- 'openapi_types': {
168
- 'webhook_access':
169
- (str,),
170
- 'text_entries_max_size':
171
- (int,),
172
- 'hostname':
173
- (str,),
174
- },
175
- 'attribute_map': {
176
- 'webhook_access': 'webhook_access',
177
- 'text_entries_max_size': 'text_entries_max_size',
178
- 'hostname': 'hostname',
179
- },
180
- 'location_map': {
181
- 'webhook_access': 'form',
182
- 'text_entries_max_size': 'form',
183
- 'hostname': 'form',
184
- },
185
- 'collection_format_map': {
186
- }
187
- },
188
- headers_map={
189
- 'accept': [
190
- 'application/json'
191
- ],
192
- 'content_type': [
193
- 'application/x-www-form-urlencoded',
194
- 'multipart/form-data'
195
- ]
196
- },
197
- api_client=api_client
198
- )
199
42
 
43
+
44
+ @validate_call
200
45
  def get_configuration(
201
46
  self,
202
- **kwargs
203
- ):
204
- """get_configuration # noqa: E501
205
-
206
- This method makes a synchronous HTTP request by default. To make an
207
- asynchronous HTTP request, please pass async_req=True
208
-
209
- >>> thread = api.get_configuration(async_req=True)
210
- >>> result = thread.get()
211
-
212
-
213
- Keyword Args:
214
- _return_http_data_only (bool): response data without head status
215
- code and headers. Default is True.
216
- _preload_content (bool): if False, the urllib3.HTTPResponse object
217
- will be returned without reading/decoding response data.
218
- Default is True.
219
- _request_timeout (int/float/tuple): timeout setting for this request. If
220
- one number provided, it will be total request timeout. It can also
221
- be a pair (tuple) of (connection, read) timeouts.
222
- Default is None.
223
- _check_input_type (bool): specifies if type checking
224
- should be done one the data sent to the server.
225
- Default is True.
226
- _check_return_type (bool): specifies if type checking
227
- should be done one the data received from the server.
228
- Default is True.
229
- _spec_property_naming (bool): True if the variable names in the input data
230
- are serialized names, as specified in the OpenAPI document.
231
- False if the variable names in the input data
232
- are pythonic names, e.g. snake case (default)
233
- _content_type (str/None): force body content-type.
234
- Default is None and content-type will be predicted by allowed
235
- content-types and body.
236
- _host_index (int/None): specifies the index of the server
237
- that we want to use.
238
- Default is read from the configuration.
239
- async_req (bool): execute request asynchronously
240
-
241
- Returns:
242
- ModelConfiguration
243
- If the method is called asynchronously, returns the request
244
- thread.
245
- """
246
- kwargs['async_req'] = kwargs.get(
247
- 'async_req', False
47
+ _request_timeout: Union[
48
+ None,
49
+ Annotated[StrictFloat, Field(gt=0)],
50
+ Tuple[
51
+ Annotated[StrictFloat, Field(gt=0)],
52
+ Annotated[StrictFloat, Field(gt=0)]
53
+ ]
54
+ ] = None,
55
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
56
+ _content_type: Optional[StrictStr] = None,
57
+ _headers: Optional[Dict[StrictStr, Any]] = None,
58
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
59
+ ) -> ModelConfiguration:
60
+ """Returns current configuration
61
+
62
+
63
+ :param _request_timeout: timeout setting for this request. If one
64
+ number provided, it will be total request
65
+ timeout. It can also be a pair (tuple) of
66
+ (connection, read) timeouts.
67
+ :type _request_timeout: int, tuple(int, int), optional
68
+ :param _request_auth: set to override the auth_settings for an a single
69
+ request; this effectively ignores the
70
+ authentication in the spec for a single request.
71
+ :type _request_auth: dict, optional
72
+ :param _content_type: force content-type for the request.
73
+ :type _content_type: str, Optional
74
+ :param _headers: set to override the headers for a single
75
+ request; this effectively ignores the headers
76
+ in the spec for a single request.
77
+ :type _headers: dict, optional
78
+ :param _host_index: set to override the host_index for a single
79
+ request; this effectively ignores the host_index
80
+ in the spec for a single request.
81
+ :type _host_index: int, optional
82
+ :return: Returns the result object.
83
+ """ # noqa: E501
84
+
85
+ _param = self._get_configuration_serialize(
86
+ _request_auth=_request_auth,
87
+ _content_type=_content_type,
88
+ _headers=_headers,
89
+ _host_index=_host_index
248
90
  )
249
- kwargs['_return_http_data_only'] = kwargs.get(
250
- '_return_http_data_only', True
91
+
92
+ _response_types_map: Dict[str, Optional[str]] = {
93
+ '200': "ModelConfiguration",
94
+ }
95
+ response_data = self.api_client.call_api(
96
+ *_param,
97
+ _request_timeout=_request_timeout
251
98
  )
252
- kwargs['_preload_content'] = kwargs.get(
253
- '_preload_content', True
99
+ response_data.read()
100
+ return self.api_client.response_deserialize(
101
+ response_data=response_data,
102
+ response_types_map=_response_types_map,
103
+ ).data
104
+
105
+
106
+ @validate_call
107
+ def get_configuration_with_http_info(
108
+ self,
109
+ _request_timeout: Union[
110
+ None,
111
+ Annotated[StrictFloat, Field(gt=0)],
112
+ Tuple[
113
+ Annotated[StrictFloat, Field(gt=0)],
114
+ Annotated[StrictFloat, Field(gt=0)]
115
+ ]
116
+ ] = None,
117
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
118
+ _content_type: Optional[StrictStr] = None,
119
+ _headers: Optional[Dict[StrictStr, Any]] = None,
120
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
121
+ ) -> ApiResponse[ModelConfiguration]:
122
+ """Returns current configuration
123
+
124
+
125
+ :param _request_timeout: timeout setting for this request. If one
126
+ number provided, it will be total request
127
+ timeout. It can also be a pair (tuple) of
128
+ (connection, read) timeouts.
129
+ :type _request_timeout: int, tuple(int, int), optional
130
+ :param _request_auth: set to override the auth_settings for an a single
131
+ request; this effectively ignores the
132
+ authentication in the spec for a single request.
133
+ :type _request_auth: dict, optional
134
+ :param _content_type: force content-type for the request.
135
+ :type _content_type: str, Optional
136
+ :param _headers: set to override the headers for a single
137
+ request; this effectively ignores the headers
138
+ in the spec for a single request.
139
+ :type _headers: dict, optional
140
+ :param _host_index: set to override the host_index for a single
141
+ request; this effectively ignores the host_index
142
+ in the spec for a single request.
143
+ :type _host_index: int, optional
144
+ :return: Returns the result object.
145
+ """ # noqa: E501
146
+
147
+ _param = self._get_configuration_serialize(
148
+ _request_auth=_request_auth,
149
+ _content_type=_content_type,
150
+ _headers=_headers,
151
+ _host_index=_host_index
254
152
  )
255
- kwargs['_request_timeout'] = kwargs.get(
256
- '_request_timeout', None
153
+
154
+ _response_types_map: Dict[str, Optional[str]] = {
155
+ '200': "ModelConfiguration",
156
+ }
157
+ response_data = self.api_client.call_api(
158
+ *_param,
159
+ _request_timeout=_request_timeout
257
160
  )
258
- kwargs['_check_input_type'] = kwargs.get(
259
- '_check_input_type', True
161
+ response_data.read()
162
+ return self.api_client.response_deserialize(
163
+ response_data=response_data,
164
+ response_types_map=_response_types_map,
260
165
  )
261
- kwargs['_check_return_type'] = kwargs.get(
262
- '_check_return_type', True
166
+
167
+
168
+ @validate_call
169
+ def get_configuration_without_preload_content(
170
+ self,
171
+ _request_timeout: Union[
172
+ None,
173
+ Annotated[StrictFloat, Field(gt=0)],
174
+ Tuple[
175
+ Annotated[StrictFloat, Field(gt=0)],
176
+ Annotated[StrictFloat, Field(gt=0)]
177
+ ]
178
+ ] = None,
179
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
180
+ _content_type: Optional[StrictStr] = None,
181
+ _headers: Optional[Dict[StrictStr, Any]] = None,
182
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
183
+ ) -> RESTResponseType:
184
+ """Returns current configuration
185
+
186
+
187
+ :param _request_timeout: timeout setting for this request. If one
188
+ number provided, it will be total request
189
+ timeout. It can also be a pair (tuple) of
190
+ (connection, read) timeouts.
191
+ :type _request_timeout: int, tuple(int, int), optional
192
+ :param _request_auth: set to override the auth_settings for an a single
193
+ request; this effectively ignores the
194
+ authentication in the spec for a single request.
195
+ :type _request_auth: dict, optional
196
+ :param _content_type: force content-type for the request.
197
+ :type _content_type: str, Optional
198
+ :param _headers: set to override the headers for a single
199
+ request; this effectively ignores the headers
200
+ in the spec for a single request.
201
+ :type _headers: dict, optional
202
+ :param _host_index: set to override the host_index for a single
203
+ request; this effectively ignores the host_index
204
+ in the spec for a single request.
205
+ :type _host_index: int, optional
206
+ :return: Returns the result object.
207
+ """ # noqa: E501
208
+
209
+ _param = self._get_configuration_serialize(
210
+ _request_auth=_request_auth,
211
+ _content_type=_content_type,
212
+ _headers=_headers,
213
+ _host_index=_host_index
214
+ )
215
+
216
+ _response_types_map: Dict[str, Optional[str]] = {
217
+ '200': "ModelConfiguration",
218
+ }
219
+ response_data = self.api_client.call_api(
220
+ *_param,
221
+ _request_timeout=_request_timeout
263
222
  )
264
- kwargs['_spec_property_naming'] = kwargs.get(
265
- '_spec_property_naming', False
223
+ return response_data.response
224
+
225
+
226
+ def _get_configuration_serialize(
227
+ self,
228
+ _request_auth,
229
+ _content_type,
230
+ _headers,
231
+ _host_index,
232
+ ) -> RequestSerialized:
233
+
234
+ _host = None
235
+
236
+ _collection_formats: Dict[str, str] = {
237
+ }
238
+
239
+ _path_params: Dict[str, str] = {}
240
+ _query_params: List[Tuple[str, str]] = []
241
+ _header_params: Dict[str, Optional[str]] = _headers or {}
242
+ _form_params: List[Tuple[str, str]] = []
243
+ _files: Dict[
244
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
245
+ ] = {}
246
+ _body_params: Optional[bytes] = None
247
+
248
+ # process the path parameters
249
+ # process the query parameters
250
+ # process the header parameters
251
+ # process the form parameters
252
+ # process the body parameter
253
+
254
+
255
+ # set the HTTP header `Accept`
256
+ if 'Accept' not in _header_params:
257
+ _header_params['Accept'] = self.api_client.select_header_accept(
258
+ [
259
+ 'application/json'
260
+ ]
261
+ )
262
+
263
+
264
+ # authentication setting
265
+ _auth_settings: List[str] = [
266
+ ]
267
+
268
+ return self.api_client.param_serialize(
269
+ method='GET',
270
+ resource_path='/configuration',
271
+ path_params=_path_params,
272
+ query_params=_query_params,
273
+ header_params=_header_params,
274
+ body=_body_params,
275
+ post_params=_form_params,
276
+ files=_files,
277
+ auth_settings=_auth_settings,
278
+ collection_formats=_collection_formats,
279
+ _host=_host,
280
+ _request_auth=_request_auth
266
281
  )
267
- kwargs['_content_type'] = kwargs.get(
268
- '_content_type')
269
- kwargs['_host_index'] = kwargs.get('_host_index')
270
- return self.get_configuration_endpoint.call_with_http_info(**kwargs)
271
282
 
283
+
284
+
285
+
286
+ @validate_call
272
287
  def get_version(
273
288
  self,
274
- **kwargs
275
- ):
276
- """Returns Engine and GAMS versions # noqa: E501
277
-
278
- This method makes a synchronous HTTP request by default. To make an
279
- asynchronous HTTP request, please pass async_req=True
280
-
281
- >>> thread = api.get_version(async_req=True)
282
- >>> result = thread.get()
283
-
284
-
285
- Keyword Args:
286
- _return_http_data_only (bool): response data without head status
287
- code and headers. Default is True.
288
- _preload_content (bool): if False, the urllib3.HTTPResponse object
289
- will be returned without reading/decoding response data.
290
- Default is True.
291
- _request_timeout (int/float/tuple): timeout setting for this request. If
292
- one number provided, it will be total request timeout. It can also
293
- be a pair (tuple) of (connection, read) timeouts.
294
- Default is None.
295
- _check_input_type (bool): specifies if type checking
296
- should be done one the data sent to the server.
297
- Default is True.
298
- _check_return_type (bool): specifies if type checking
299
- should be done one the data received from the server.
300
- Default is True.
301
- _spec_property_naming (bool): True if the variable names in the input data
302
- are serialized names, as specified in the OpenAPI document.
303
- False if the variable names in the input data
304
- are pythonic names, e.g. snake case (default)
305
- _content_type (str/None): force body content-type.
306
- Default is None and content-type will be predicted by allowed
307
- content-types and body.
308
- _host_index (int/None): specifies the index of the server
309
- that we want to use.
310
- Default is read from the configuration.
311
- async_req (bool): execute request asynchronously
312
-
313
- Returns:
314
- ModelVersion
315
- If the method is called asynchronously, returns the request
316
- thread.
317
- """
318
- kwargs['async_req'] = kwargs.get(
319
- 'async_req', False
289
+ _request_timeout: Union[
290
+ None,
291
+ Annotated[StrictFloat, Field(gt=0)],
292
+ Tuple[
293
+ Annotated[StrictFloat, Field(gt=0)],
294
+ Annotated[StrictFloat, Field(gt=0)]
295
+ ]
296
+ ] = None,
297
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
298
+ _content_type: Optional[StrictStr] = None,
299
+ _headers: Optional[Dict[StrictStr, Any]] = None,
300
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
301
+ ) -> ModelVersion:
302
+ """Returns Engine and GAMS versions
303
+
304
+
305
+ :param _request_timeout: timeout setting for this request. If one
306
+ number provided, it will be total request
307
+ timeout. It can also be a pair (tuple) of
308
+ (connection, read) timeouts.
309
+ :type _request_timeout: int, tuple(int, int), optional
310
+ :param _request_auth: set to override the auth_settings for an a single
311
+ request; this effectively ignores the
312
+ authentication in the spec for a single request.
313
+ :type _request_auth: dict, optional
314
+ :param _content_type: force content-type for the request.
315
+ :type _content_type: str, Optional
316
+ :param _headers: set to override the headers for a single
317
+ request; this effectively ignores the headers
318
+ in the spec for a single request.
319
+ :type _headers: dict, optional
320
+ :param _host_index: set to override the host_index for a single
321
+ request; this effectively ignores the host_index
322
+ in the spec for a single request.
323
+ :type _host_index: int, optional
324
+ :return: Returns the result object.
325
+ """ # noqa: E501
326
+
327
+ _param = self._get_version_serialize(
328
+ _request_auth=_request_auth,
329
+ _content_type=_content_type,
330
+ _headers=_headers,
331
+ _host_index=_host_index
320
332
  )
321
- kwargs['_return_http_data_only'] = kwargs.get(
322
- '_return_http_data_only', True
333
+
334
+ _response_types_map: Dict[str, Optional[str]] = {
335
+ '200': "ModelVersion",
336
+ }
337
+ response_data = self.api_client.call_api(
338
+ *_param,
339
+ _request_timeout=_request_timeout
323
340
  )
324
- kwargs['_preload_content'] = kwargs.get(
325
- '_preload_content', True
341
+ response_data.read()
342
+ return self.api_client.response_deserialize(
343
+ response_data=response_data,
344
+ response_types_map=_response_types_map,
345
+ ).data
346
+
347
+
348
+ @validate_call
349
+ def get_version_with_http_info(
350
+ self,
351
+ _request_timeout: Union[
352
+ None,
353
+ Annotated[StrictFloat, Field(gt=0)],
354
+ Tuple[
355
+ Annotated[StrictFloat, Field(gt=0)],
356
+ Annotated[StrictFloat, Field(gt=0)]
357
+ ]
358
+ ] = None,
359
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
360
+ _content_type: Optional[StrictStr] = None,
361
+ _headers: Optional[Dict[StrictStr, Any]] = None,
362
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
363
+ ) -> ApiResponse[ModelVersion]:
364
+ """Returns Engine and GAMS versions
365
+
366
+
367
+ :param _request_timeout: timeout setting for this request. If one
368
+ number provided, it will be total request
369
+ timeout. It can also be a pair (tuple) of
370
+ (connection, read) timeouts.
371
+ :type _request_timeout: int, tuple(int, int), optional
372
+ :param _request_auth: set to override the auth_settings for an a single
373
+ request; this effectively ignores the
374
+ authentication in the spec for a single request.
375
+ :type _request_auth: dict, optional
376
+ :param _content_type: force content-type for the request.
377
+ :type _content_type: str, Optional
378
+ :param _headers: set to override the headers for a single
379
+ request; this effectively ignores the headers
380
+ in the spec for a single request.
381
+ :type _headers: dict, optional
382
+ :param _host_index: set to override the host_index for a single
383
+ request; this effectively ignores the host_index
384
+ in the spec for a single request.
385
+ :type _host_index: int, optional
386
+ :return: Returns the result object.
387
+ """ # noqa: E501
388
+
389
+ _param = self._get_version_serialize(
390
+ _request_auth=_request_auth,
391
+ _content_type=_content_type,
392
+ _headers=_headers,
393
+ _host_index=_host_index
326
394
  )
327
- kwargs['_request_timeout'] = kwargs.get(
328
- '_request_timeout', None
395
+
396
+ _response_types_map: Dict[str, Optional[str]] = {
397
+ '200': "ModelVersion",
398
+ }
399
+ response_data = self.api_client.call_api(
400
+ *_param,
401
+ _request_timeout=_request_timeout
329
402
  )
330
- kwargs['_check_input_type'] = kwargs.get(
331
- '_check_input_type', True
403
+ response_data.read()
404
+ return self.api_client.response_deserialize(
405
+ response_data=response_data,
406
+ response_types_map=_response_types_map,
332
407
  )
333
- kwargs['_check_return_type'] = kwargs.get(
334
- '_check_return_type', True
408
+
409
+
410
+ @validate_call
411
+ def get_version_without_preload_content(
412
+ self,
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
+ ) -> RESTResponseType:
426
+ """Returns Engine and GAMS versions
427
+
428
+
429
+ :param _request_timeout: timeout setting for this request. If one
430
+ number provided, it will be total request
431
+ timeout. It can also be a pair (tuple) of
432
+ (connection, read) timeouts.
433
+ :type _request_timeout: int, tuple(int, int), optional
434
+ :param _request_auth: set to override the auth_settings for an a single
435
+ request; this effectively ignores the
436
+ authentication in the spec for a single request.
437
+ :type _request_auth: dict, optional
438
+ :param _content_type: force content-type for the request.
439
+ :type _content_type: str, Optional
440
+ :param _headers: set to override the headers for a single
441
+ request; this effectively ignores the headers
442
+ in the spec for a single request.
443
+ :type _headers: dict, optional
444
+ :param _host_index: set to override the host_index for a single
445
+ request; this effectively ignores the host_index
446
+ in the spec for a single request.
447
+ :type _host_index: int, optional
448
+ :return: Returns the result object.
449
+ """ # noqa: E501
450
+
451
+ _param = self._get_version_serialize(
452
+ _request_auth=_request_auth,
453
+ _content_type=_content_type,
454
+ _headers=_headers,
455
+ _host_index=_host_index
335
456
  )
336
- kwargs['_spec_property_naming'] = kwargs.get(
337
- '_spec_property_naming', False
457
+
458
+ _response_types_map: Dict[str, Optional[str]] = {
459
+ '200': "ModelVersion",
460
+ }
461
+ response_data = self.api_client.call_api(
462
+ *_param,
463
+ _request_timeout=_request_timeout
464
+ )
465
+ return response_data.response
466
+
467
+
468
+ def _get_version_serialize(
469
+ self,
470
+ _request_auth,
471
+ _content_type,
472
+ _headers,
473
+ _host_index,
474
+ ) -> RequestSerialized:
475
+
476
+ _host = None
477
+
478
+ _collection_formats: Dict[str, str] = {
479
+ }
480
+
481
+ _path_params: Dict[str, str] = {}
482
+ _query_params: List[Tuple[str, str]] = []
483
+ _header_params: Dict[str, Optional[str]] = _headers or {}
484
+ _form_params: List[Tuple[str, str]] = []
485
+ _files: Dict[
486
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
487
+ ] = {}
488
+ _body_params: Optional[bytes] = None
489
+
490
+ # process the path parameters
491
+ # process the query parameters
492
+ # process the header parameters
493
+ # process the form parameters
494
+ # process the body parameter
495
+
496
+
497
+ # set the HTTP header `Accept`
498
+ if 'Accept' not in _header_params:
499
+ _header_params['Accept'] = self.api_client.select_header_accept(
500
+ [
501
+ 'application/json'
502
+ ]
503
+ )
504
+
505
+
506
+ # authentication setting
507
+ _auth_settings: List[str] = [
508
+ ]
509
+
510
+ return self.api_client.param_serialize(
511
+ method='GET',
512
+ resource_path='/version',
513
+ path_params=_path_params,
514
+ query_params=_query_params,
515
+ header_params=_header_params,
516
+ body=_body_params,
517
+ post_params=_form_params,
518
+ files=_files,
519
+ auth_settings=_auth_settings,
520
+ collection_formats=_collection_formats,
521
+ _host=_host,
522
+ _request_auth=_request_auth
338
523
  )
339
- kwargs['_content_type'] = kwargs.get(
340
- '_content_type')
341
- kwargs['_host_index'] = kwargs.get('_host_index')
342
- return self.get_version_endpoint.call_with_http_info(**kwargs)
343
524
 
525
+
526
+
527
+
528
+ @validate_call
344
529
  def update_configuration(
345
530
  self,
346
- **kwargs
347
- ):
348
- """Updates configuration # noqa: E501
349
-
350
- This method makes a synchronous HTTP request by default. To make an
351
- asynchronous HTTP request, please pass async_req=True
352
-
353
- >>> thread = api.update_configuration(async_req=True)
354
- >>> result = thread.get()
355
-
356
-
357
- Keyword Args:
358
- webhook_access (str): Whether to enable webhook access or enable it for admins only. Possible values are: ['DISABLED', 'ADMIN_ONLY', 'ENABLED']. [optional]
359
- text_entries_max_size (int): Maximum size (in bytes) for text entries. Text entries that exceed this size will be truncated.. [optional]
360
- hostname (str): Hostname of the Engine API. It is used for authentication purposes. It must match value from the authorization server. For example, https://engine.gams.com/api. [optional]
361
- _return_http_data_only (bool): response data without head status
362
- code and headers. Default is True.
363
- _preload_content (bool): if False, the urllib3.HTTPResponse object
364
- will be returned without reading/decoding response data.
365
- Default is True.
366
- _request_timeout (int/float/tuple): timeout setting for this request. If
367
- one number provided, it will be total request timeout. It can also
368
- be a pair (tuple) of (connection, read) timeouts.
369
- Default is None.
370
- _check_input_type (bool): specifies if type checking
371
- should be done one the data sent to the server.
372
- Default is True.
373
- _check_return_type (bool): specifies if type checking
374
- should be done one the data received from the server.
375
- Default is True.
376
- _spec_property_naming (bool): True if the variable names in the input data
377
- are serialized names, as specified in the OpenAPI document.
378
- False if the variable names in the input data
379
- are pythonic names, e.g. snake case (default)
380
- _content_type (str/None): force body content-type.
381
- Default is None and content-type will be predicted by allowed
382
- content-types and body.
383
- _host_index (int/None): specifies the index of the server
384
- that we want to use.
385
- Default is read from the configuration.
386
- async_req (bool): execute request asynchronously
387
-
388
- Returns:
389
- Message
390
- If the method is called asynchronously, returns the request
391
- thread.
392
- """
393
- kwargs['async_req'] = kwargs.get(
394
- 'async_req', False
531
+ webhook_access: Annotated[Optional[StrictStr], Field(description="Whether to enable webhook access or enable it for admins only. Possible values are: ['DISABLED', 'ADMIN_ONLY', 'ENABLED']")] = None,
532
+ instance_pool_access: Annotated[Optional[StrictStr], Field(description="Whether to enable instance pool access, enable it for admins or inviters only. If access to instance pools is removed for specific user roles or for all, existing instance pools are not affected. Only new pools cannot be created by these users. Existing instance pools can still be deleted. Possible values are: ['DISABLED', 'ADMIN_ONLY', 'INVITER_ONLY', 'ENABLED']")] = None,
533
+ job_priorities_access: Annotated[Optional[StrictStr], Field(description="Whether to enable job priorities. WARNING: Enable/disable job priorities when the system is not in use, as jobs submitted while the feature is enabled/disabled may end up in an inconsistent state. Possible values are: ['DISABLED', 'ENABLED']")] = None,
534
+ text_entries_max_size: Annotated[Optional[Annotated[int, Field(le=1000000000, strict=True, ge=0)]], Field(description="Maximum size (in bytes) for text entries. Text entries that exceed this size will be truncated.")] = None,
535
+ hostname: Annotated[Optional[StrictStr], Field(description="Hostname of the Engine API. It is used for authentication purposes. It must match value from the authorization server. For example, https://engine.gams.com/api")] = None,
536
+ custom_cas: Annotated[Optional[StrictStr], Field(description="Custom certificate authorities that are used when validating SSL certificates e.g. when sending webhooks, connecting to identity providers etc.The certificates must be provided in PEM format (RFC 1422). Set to empty string to remove custom CAs.")] = None,
537
+ _request_timeout: Union[
538
+ None,
539
+ Annotated[StrictFloat, Field(gt=0)],
540
+ Tuple[
541
+ Annotated[StrictFloat, Field(gt=0)],
542
+ Annotated[StrictFloat, Field(gt=0)]
543
+ ]
544
+ ] = None,
545
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
546
+ _content_type: Optional[StrictStr] = None,
547
+ _headers: Optional[Dict[StrictStr, Any]] = None,
548
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
549
+ ) -> Message:
550
+ """Updates configuration
551
+
552
+ Requires admin role.
553
+
554
+ :param webhook_access: Whether to enable webhook access or enable it for admins only. Possible values are: ['DISABLED', 'ADMIN_ONLY', 'ENABLED']
555
+ :type webhook_access: str
556
+ :param instance_pool_access: Whether to enable instance pool access, enable it for admins or inviters only. If access to instance pools is removed for specific user roles or for all, existing instance pools are not affected. Only new pools cannot be created by these users. Existing instance pools can still be deleted. Possible values are: ['DISABLED', 'ADMIN_ONLY', 'INVITER_ONLY', 'ENABLED']
557
+ :type instance_pool_access: str
558
+ :param job_priorities_access: Whether to enable job priorities. WARNING: Enable/disable job priorities when the system is not in use, as jobs submitted while the feature is enabled/disabled may end up in an inconsistent state. Possible values are: ['DISABLED', 'ENABLED']
559
+ :type job_priorities_access: str
560
+ :param text_entries_max_size: Maximum size (in bytes) for text entries. Text entries that exceed this size will be truncated.
561
+ :type text_entries_max_size: int
562
+ :param hostname: Hostname of the Engine API. It is used for authentication purposes. It must match value from the authorization server. For example, https://engine.gams.com/api
563
+ :type hostname: str
564
+ :param custom_cas: Custom certificate authorities that are used when validating SSL certificates e.g. when sending webhooks, connecting to identity providers etc.The certificates must be provided in PEM format (RFC 1422). Set to empty string to remove custom CAs.
565
+ :type custom_cas: str
566
+ :param _request_timeout: timeout setting for this request. If one
567
+ number provided, it will be total request
568
+ timeout. It can also be a pair (tuple) of
569
+ (connection, read) timeouts.
570
+ :type _request_timeout: int, tuple(int, int), optional
571
+ :param _request_auth: set to override the auth_settings for an a single
572
+ request; this effectively ignores the
573
+ authentication in the spec for a single request.
574
+ :type _request_auth: dict, optional
575
+ :param _content_type: force content-type for the request.
576
+ :type _content_type: str, Optional
577
+ :param _headers: set to override the headers for a single
578
+ request; this effectively ignores the headers
579
+ in the spec for a single request.
580
+ :type _headers: dict, optional
581
+ :param _host_index: set to override the host_index for a single
582
+ request; this effectively ignores the host_index
583
+ in the spec for a single request.
584
+ :type _host_index: int, optional
585
+ :return: Returns the result object.
586
+ """ # noqa: E501
587
+
588
+ _param = self._update_configuration_serialize(
589
+ webhook_access=webhook_access,
590
+ instance_pool_access=instance_pool_access,
591
+ job_priorities_access=job_priorities_access,
592
+ text_entries_max_size=text_entries_max_size,
593
+ hostname=hostname,
594
+ custom_cas=custom_cas,
595
+ _request_auth=_request_auth,
596
+ _content_type=_content_type,
597
+ _headers=_headers,
598
+ _host_index=_host_index
599
+ )
600
+
601
+ _response_types_map: Dict[str, Optional[str]] = {
602
+ '200': "Message",
603
+ '400': "Message",
604
+ '403': "Message",
605
+ '404': "Message",
606
+ '405': "Message",
607
+ }
608
+ response_data = self.api_client.call_api(
609
+ *_param,
610
+ _request_timeout=_request_timeout
395
611
  )
396
- kwargs['_return_http_data_only'] = kwargs.get(
397
- '_return_http_data_only', True
612
+ response_data.read()
613
+ return self.api_client.response_deserialize(
614
+ response_data=response_data,
615
+ response_types_map=_response_types_map,
616
+ ).data
617
+
618
+
619
+ @validate_call
620
+ def update_configuration_with_http_info(
621
+ self,
622
+ webhook_access: Annotated[Optional[StrictStr], Field(description="Whether to enable webhook access or enable it for admins only. Possible values are: ['DISABLED', 'ADMIN_ONLY', 'ENABLED']")] = None,
623
+ instance_pool_access: Annotated[Optional[StrictStr], Field(description="Whether to enable instance pool access, enable it for admins or inviters only. If access to instance pools is removed for specific user roles or for all, existing instance pools are not affected. Only new pools cannot be created by these users. Existing instance pools can still be deleted. Possible values are: ['DISABLED', 'ADMIN_ONLY', 'INVITER_ONLY', 'ENABLED']")] = None,
624
+ job_priorities_access: Annotated[Optional[StrictStr], Field(description="Whether to enable job priorities. WARNING: Enable/disable job priorities when the system is not in use, as jobs submitted while the feature is enabled/disabled may end up in an inconsistent state. Possible values are: ['DISABLED', 'ENABLED']")] = None,
625
+ text_entries_max_size: Annotated[Optional[Annotated[int, Field(le=1000000000, strict=True, ge=0)]], Field(description="Maximum size (in bytes) for text entries. Text entries that exceed this size will be truncated.")] = None,
626
+ hostname: Annotated[Optional[StrictStr], Field(description="Hostname of the Engine API. It is used for authentication purposes. It must match value from the authorization server. For example, https://engine.gams.com/api")] = None,
627
+ custom_cas: Annotated[Optional[StrictStr], Field(description="Custom certificate authorities that are used when validating SSL certificates e.g. when sending webhooks, connecting to identity providers etc.The certificates must be provided in PEM format (RFC 1422). Set to empty string to remove custom CAs.")] = None,
628
+ _request_timeout: Union[
629
+ None,
630
+ Annotated[StrictFloat, Field(gt=0)],
631
+ Tuple[
632
+ Annotated[StrictFloat, Field(gt=0)],
633
+ Annotated[StrictFloat, Field(gt=0)]
634
+ ]
635
+ ] = None,
636
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
637
+ _content_type: Optional[StrictStr] = None,
638
+ _headers: Optional[Dict[StrictStr, Any]] = None,
639
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
640
+ ) -> ApiResponse[Message]:
641
+ """Updates configuration
642
+
643
+ Requires admin role.
644
+
645
+ :param webhook_access: Whether to enable webhook access or enable it for admins only. Possible values are: ['DISABLED', 'ADMIN_ONLY', 'ENABLED']
646
+ :type webhook_access: str
647
+ :param instance_pool_access: Whether to enable instance pool access, enable it for admins or inviters only. If access to instance pools is removed for specific user roles or for all, existing instance pools are not affected. Only new pools cannot be created by these users. Existing instance pools can still be deleted. Possible values are: ['DISABLED', 'ADMIN_ONLY', 'INVITER_ONLY', 'ENABLED']
648
+ :type instance_pool_access: str
649
+ :param job_priorities_access: Whether to enable job priorities. WARNING: Enable/disable job priorities when the system is not in use, as jobs submitted while the feature is enabled/disabled may end up in an inconsistent state. Possible values are: ['DISABLED', 'ENABLED']
650
+ :type job_priorities_access: str
651
+ :param text_entries_max_size: Maximum size (in bytes) for text entries. Text entries that exceed this size will be truncated.
652
+ :type text_entries_max_size: int
653
+ :param hostname: Hostname of the Engine API. It is used for authentication purposes. It must match value from the authorization server. For example, https://engine.gams.com/api
654
+ :type hostname: str
655
+ :param custom_cas: Custom certificate authorities that are used when validating SSL certificates e.g. when sending webhooks, connecting to identity providers etc.The certificates must be provided in PEM format (RFC 1422). Set to empty string to remove custom CAs.
656
+ :type custom_cas: str
657
+ :param _request_timeout: timeout setting for this request. If one
658
+ number provided, it will be total request
659
+ timeout. It can also be a pair (tuple) of
660
+ (connection, read) timeouts.
661
+ :type _request_timeout: int, tuple(int, int), optional
662
+ :param _request_auth: set to override the auth_settings for an a single
663
+ request; this effectively ignores the
664
+ authentication in the spec for a single request.
665
+ :type _request_auth: dict, optional
666
+ :param _content_type: force content-type for the request.
667
+ :type _content_type: str, Optional
668
+ :param _headers: set to override the headers for a single
669
+ request; this effectively ignores the headers
670
+ in the spec for a single request.
671
+ :type _headers: dict, optional
672
+ :param _host_index: set to override the host_index for a single
673
+ request; this effectively ignores the host_index
674
+ in the spec for a single request.
675
+ :type _host_index: int, optional
676
+ :return: Returns the result object.
677
+ """ # noqa: E501
678
+
679
+ _param = self._update_configuration_serialize(
680
+ webhook_access=webhook_access,
681
+ instance_pool_access=instance_pool_access,
682
+ job_priorities_access=job_priorities_access,
683
+ text_entries_max_size=text_entries_max_size,
684
+ hostname=hostname,
685
+ custom_cas=custom_cas,
686
+ _request_auth=_request_auth,
687
+ _content_type=_content_type,
688
+ _headers=_headers,
689
+ _host_index=_host_index
398
690
  )
399
- kwargs['_preload_content'] = kwargs.get(
400
- '_preload_content', True
691
+
692
+ _response_types_map: Dict[str, Optional[str]] = {
693
+ '200': "Message",
694
+ '400': "Message",
695
+ '403': "Message",
696
+ '404': "Message",
697
+ '405': "Message",
698
+ }
699
+ response_data = self.api_client.call_api(
700
+ *_param,
701
+ _request_timeout=_request_timeout
401
702
  )
402
- kwargs['_request_timeout'] = kwargs.get(
403
- '_request_timeout', None
703
+ response_data.read()
704
+ return self.api_client.response_deserialize(
705
+ response_data=response_data,
706
+ response_types_map=_response_types_map,
404
707
  )
405
- kwargs['_check_input_type'] = kwargs.get(
406
- '_check_input_type', True
708
+
709
+
710
+ @validate_call
711
+ def update_configuration_without_preload_content(
712
+ self,
713
+ webhook_access: Annotated[Optional[StrictStr], Field(description="Whether to enable webhook access or enable it for admins only. Possible values are: ['DISABLED', 'ADMIN_ONLY', 'ENABLED']")] = None,
714
+ instance_pool_access: Annotated[Optional[StrictStr], Field(description="Whether to enable instance pool access, enable it for admins or inviters only. If access to instance pools is removed for specific user roles or for all, existing instance pools are not affected. Only new pools cannot be created by these users. Existing instance pools can still be deleted. Possible values are: ['DISABLED', 'ADMIN_ONLY', 'INVITER_ONLY', 'ENABLED']")] = None,
715
+ job_priorities_access: Annotated[Optional[StrictStr], Field(description="Whether to enable job priorities. WARNING: Enable/disable job priorities when the system is not in use, as jobs submitted while the feature is enabled/disabled may end up in an inconsistent state. Possible values are: ['DISABLED', 'ENABLED']")] = None,
716
+ text_entries_max_size: Annotated[Optional[Annotated[int, Field(le=1000000000, strict=True, ge=0)]], Field(description="Maximum size (in bytes) for text entries. Text entries that exceed this size will be truncated.")] = None,
717
+ hostname: Annotated[Optional[StrictStr], Field(description="Hostname of the Engine API. It is used for authentication purposes. It must match value from the authorization server. For example, https://engine.gams.com/api")] = None,
718
+ custom_cas: Annotated[Optional[StrictStr], Field(description="Custom certificate authorities that are used when validating SSL certificates e.g. when sending webhooks, connecting to identity providers etc.The certificates must be provided in PEM format (RFC 1422). Set to empty string to remove custom CAs.")] = None,
719
+ _request_timeout: Union[
720
+ None,
721
+ Annotated[StrictFloat, Field(gt=0)],
722
+ Tuple[
723
+ Annotated[StrictFloat, Field(gt=0)],
724
+ Annotated[StrictFloat, Field(gt=0)]
725
+ ]
726
+ ] = None,
727
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
728
+ _content_type: Optional[StrictStr] = None,
729
+ _headers: Optional[Dict[StrictStr, Any]] = None,
730
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
731
+ ) -> RESTResponseType:
732
+ """Updates configuration
733
+
734
+ Requires admin role.
735
+
736
+ :param webhook_access: Whether to enable webhook access or enable it for admins only. Possible values are: ['DISABLED', 'ADMIN_ONLY', 'ENABLED']
737
+ :type webhook_access: str
738
+ :param instance_pool_access: Whether to enable instance pool access, enable it for admins or inviters only. If access to instance pools is removed for specific user roles or for all, existing instance pools are not affected. Only new pools cannot be created by these users. Existing instance pools can still be deleted. Possible values are: ['DISABLED', 'ADMIN_ONLY', 'INVITER_ONLY', 'ENABLED']
739
+ :type instance_pool_access: str
740
+ :param job_priorities_access: Whether to enable job priorities. WARNING: Enable/disable job priorities when the system is not in use, as jobs submitted while the feature is enabled/disabled may end up in an inconsistent state. Possible values are: ['DISABLED', 'ENABLED']
741
+ :type job_priorities_access: str
742
+ :param text_entries_max_size: Maximum size (in bytes) for text entries. Text entries that exceed this size will be truncated.
743
+ :type text_entries_max_size: int
744
+ :param hostname: Hostname of the Engine API. It is used for authentication purposes. It must match value from the authorization server. For example, https://engine.gams.com/api
745
+ :type hostname: str
746
+ :param custom_cas: Custom certificate authorities that are used when validating SSL certificates e.g. when sending webhooks, connecting to identity providers etc.The certificates must be provided in PEM format (RFC 1422). Set to empty string to remove custom CAs.
747
+ :type custom_cas: str
748
+ :param _request_timeout: timeout setting for this request. If one
749
+ number provided, it will be total request
750
+ timeout. It can also be a pair (tuple) of
751
+ (connection, read) timeouts.
752
+ :type _request_timeout: int, tuple(int, int), optional
753
+ :param _request_auth: set to override the auth_settings for an a single
754
+ request; this effectively ignores the
755
+ authentication in the spec for a single request.
756
+ :type _request_auth: dict, optional
757
+ :param _content_type: force content-type for the request.
758
+ :type _content_type: str, Optional
759
+ :param _headers: set to override the headers for a single
760
+ request; this effectively ignores the headers
761
+ in the spec for a single request.
762
+ :type _headers: dict, optional
763
+ :param _host_index: set to override the host_index for a single
764
+ request; this effectively ignores the host_index
765
+ in the spec for a single request.
766
+ :type _host_index: int, optional
767
+ :return: Returns the result object.
768
+ """ # noqa: E501
769
+
770
+ _param = self._update_configuration_serialize(
771
+ webhook_access=webhook_access,
772
+ instance_pool_access=instance_pool_access,
773
+ job_priorities_access=job_priorities_access,
774
+ text_entries_max_size=text_entries_max_size,
775
+ hostname=hostname,
776
+ custom_cas=custom_cas,
777
+ _request_auth=_request_auth,
778
+ _content_type=_content_type,
779
+ _headers=_headers,
780
+ _host_index=_host_index
407
781
  )
408
- kwargs['_check_return_type'] = kwargs.get(
409
- '_check_return_type', True
782
+
783
+ _response_types_map: Dict[str, Optional[str]] = {
784
+ '200': "Message",
785
+ '400': "Message",
786
+ '403': "Message",
787
+ '404': "Message",
788
+ '405': "Message",
789
+ }
790
+ response_data = self.api_client.call_api(
791
+ *_param,
792
+ _request_timeout=_request_timeout
410
793
  )
411
- kwargs['_spec_property_naming'] = kwargs.get(
412
- '_spec_property_naming', False
794
+ return response_data.response
795
+
796
+
797
+ def _update_configuration_serialize(
798
+ self,
799
+ webhook_access,
800
+ instance_pool_access,
801
+ job_priorities_access,
802
+ text_entries_max_size,
803
+ hostname,
804
+ custom_cas,
805
+ _request_auth,
806
+ _content_type,
807
+ _headers,
808
+ _host_index,
809
+ ) -> RequestSerialized:
810
+
811
+ _host = None
812
+
813
+ _collection_formats: Dict[str, str] = {
814
+ }
815
+
816
+ _path_params: Dict[str, str] = {}
817
+ _query_params: List[Tuple[str, str]] = []
818
+ _header_params: Dict[str, Optional[str]] = _headers or {}
819
+ _form_params: List[Tuple[str, str]] = []
820
+ _files: Dict[
821
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
822
+ ] = {}
823
+ _body_params: Optional[bytes] = None
824
+
825
+ # process the path parameters
826
+ # process the query parameters
827
+ # process the header parameters
828
+ # process the form parameters
829
+ if webhook_access is not None:
830
+ _form_params.append(('webhook_access', webhook_access))
831
+ if instance_pool_access is not None:
832
+ _form_params.append(('instance_pool_access', instance_pool_access))
833
+ if job_priorities_access is not None:
834
+ _form_params.append(('job_priorities_access', job_priorities_access))
835
+ if text_entries_max_size is not None:
836
+ _form_params.append(('text_entries_max_size', text_entries_max_size))
837
+ if hostname is not None:
838
+ _form_params.append(('hostname', hostname))
839
+ if custom_cas is not None:
840
+ _form_params.append(('custom_cas', custom_cas))
841
+ # process the body parameter
842
+
843
+
844
+ # set the HTTP header `Accept`
845
+ if 'Accept' not in _header_params:
846
+ _header_params['Accept'] = self.api_client.select_header_accept(
847
+ [
848
+ 'application/json'
849
+ ]
850
+ )
851
+
852
+ # set the HTTP header `Content-Type`
853
+ if _content_type:
854
+ _header_params['Content-Type'] = _content_type
855
+ else:
856
+ _default_content_type = (
857
+ self.api_client.select_header_content_type(
858
+ [
859
+ 'application/x-www-form-urlencoded',
860
+ 'multipart/form-data'
861
+ ]
862
+ )
863
+ )
864
+ if _default_content_type is not None:
865
+ _header_params['Content-Type'] = _default_content_type
866
+
867
+ # authentication setting
868
+ _auth_settings: List[str] = [
869
+ 'BasicAuth'
870
+ ]
871
+
872
+ return self.api_client.param_serialize(
873
+ method='PATCH',
874
+ resource_path='/configuration',
875
+ path_params=_path_params,
876
+ query_params=_query_params,
877
+ header_params=_header_params,
878
+ body=_body_params,
879
+ post_params=_form_params,
880
+ files=_files,
881
+ auth_settings=_auth_settings,
882
+ collection_formats=_collection_formats,
883
+ _host=_host,
884
+ _request_auth=_request_auth
413
885
  )
414
- kwargs['_content_type'] = kwargs.get(
415
- '_content_type')
416
- kwargs['_host_index'] = kwargs.get('_host_index')
417
- return self.update_configuration_endpoint.call_with_http_info(**kwargs)
886
+
418
887