arthur-client 1.4.0__py3-none-any.whl → 1.4.1055__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (970) hide show
  1. arthur_client/__version__.py +1 -0
  2. arthur_client/api_bindings/__init__.py +330 -0
  3. arthur_client/api_bindings/api/__init__.py +30 -0
  4. arthur_client/api_bindings/api/alert_rules_v1_api.py +1627 -0
  5. arthur_client/api_bindings/api/alerts_v1_api.py +1042 -0
  6. arthur_client/api_bindings/api/authorization_v1_api.py +3926 -0
  7. arthur_client/api_bindings/api/connector_schemas_v1_api.py +559 -0
  8. arthur_client/api_bindings/api/connectors_v1_api.py +2165 -0
  9. arthur_client/api_bindings/api/data_plane_associations_v1_api.py +1699 -0
  10. arthur_client/api_bindings/api/data_planes_v1_api.py +1832 -0
  11. arthur_client/api_bindings/api/data_retrieval_v1_api.py +2403 -0
  12. arthur_client/api_bindings/api/datasets_v1_api.py +4343 -0
  13. arthur_client/api_bindings/api/default_api.py +284 -0
  14. arthur_client/api_bindings/api/feature_flags_v1_api.py +284 -0
  15. arthur_client/api_bindings/api/groups_v1_api.py +2803 -0
  16. arthur_client/api_bindings/api/jobs_v1_api.py +3809 -0
  17. arthur_client/api_bindings/api/metric_functions_v1_api.py +285 -0
  18. arthur_client/api_bindings/api/metrics_v1_api.py +1297 -0
  19. arthur_client/api_bindings/api/models_v1_api.py +2739 -0
  20. arthur_client/api_bindings/api/o_auth_v1_api.py +284 -0
  21. arthur_client/api_bindings/api/organizations_v1_api.py +827 -0
  22. arthur_client/api_bindings/api/projects_v1_api.py +1541 -0
  23. arthur_client/api_bindings/api/registration_v1_api.py +319 -0
  24. arthur_client/api_bindings/api/roles_v1_api.py +307 -0
  25. arthur_client/api_bindings/api/tasks_v1_api.py +3173 -0
  26. arthur_client/api_bindings/api/upsolve_v1_api.py +320 -0
  27. arthur_client/api_bindings/api/users_v1_api.py +2930 -0
  28. arthur_client/api_bindings/api/webhooks_v1_api.py +1843 -0
  29. arthur_client/api_bindings/api/workspaces_v1_api.py +1511 -0
  30. arthur_client/api_bindings/api_client.py +797 -0
  31. arthur_client/api_bindings/api_response.py +21 -0
  32. arthur_client/api_bindings/configuration.py +458 -0
  33. arthur_client/api_bindings/docs/AggregationMetricType.md +12 -0
  34. arthur_client/api_bindings/docs/AggregationSpec.md +31 -0
  35. arthur_client/api_bindings/docs/AggregationSpecSchema.md +34 -0
  36. arthur_client/api_bindings/docs/AggregationSpecSchemaInitArgsInner.md +39 -0
  37. arthur_client/api_bindings/docs/Alert.md +43 -0
  38. arthur_client/api_bindings/docs/AlertBound.md +12 -0
  39. arthur_client/api_bindings/docs/AlertCheckJobSpec.md +32 -0
  40. arthur_client/api_bindings/docs/AlertRule.md +40 -0
  41. arthur_client/api_bindings/docs/AlertRuleNotificationWebhook.md +30 -0
  42. arthur_client/api_bindings/docs/AlertRuleSort.md +12 -0
  43. arthur_client/api_bindings/docs/AlertRulesV1Api.md +431 -0
  44. arthur_client/api_bindings/docs/AlertSort.md +12 -0
  45. arthur_client/api_bindings/docs/AlertWebhookCalled.md +31 -0
  46. arthur_client/api_bindings/docs/AlertsV1Api.md +268 -0
  47. arthur_client/api_bindings/docs/AuthorizationV1Api.md +1039 -0
  48. arthur_client/api_bindings/docs/AvailableDataset.md +39 -0
  49. arthur_client/api_bindings/docs/AvailableDatasetsSort.md +14 -0
  50. arthur_client/api_bindings/docs/BadRequestError.md +29 -0
  51. arthur_client/api_bindings/docs/BaseRole.md +31 -0
  52. arthur_client/api_bindings/docs/BoundMember.md +30 -0
  53. arthur_client/api_bindings/docs/BoundMemberKind.md +12 -0
  54. arthur_client/api_bindings/docs/BoundResource.md +31 -0
  55. arthur_client/api_bindings/docs/BoundResourceKind.md +16 -0
  56. arthur_client/api_bindings/docs/BoundRole.md +30 -0
  57. arthur_client/api_bindings/docs/Config.md +37 -0
  58. arthur_client/api_bindings/docs/ConflictError.md +29 -0
  59. arthur_client/api_bindings/docs/ConnectorCheckJobSpec.md +30 -0
  60. arthur_client/api_bindings/docs/ConnectorCheckOutcome.md +12 -0
  61. arthur_client/api_bindings/docs/ConnectorCheckResult.md +30 -0
  62. arthur_client/api_bindings/docs/ConnectorFieldDataType.md +16 -0
  63. arthur_client/api_bindings/docs/ConnectorPaginationOptions.md +30 -0
  64. arthur_client/api_bindings/docs/ConnectorSchemasV1Api.md +161 -0
  65. arthur_client/api_bindings/docs/ConnectorSpec.md +39 -0
  66. arthur_client/api_bindings/docs/ConnectorSpecField.md +30 -0
  67. arthur_client/api_bindings/docs/ConnectorSpecFieldWithMetadata.md +32 -0
  68. arthur_client/api_bindings/docs/ConnectorSpecSchema.md +34 -0
  69. arthur_client/api_bindings/docs/ConnectorSpecSchemaField.md +34 -0
  70. arthur_client/api_bindings/docs/ConnectorType.md +18 -0
  71. arthur_client/api_bindings/docs/ConnectorsSort.md +14 -0
  72. arthur_client/api_bindings/docs/ConnectorsV1Api.md +586 -0
  73. arthur_client/api_bindings/docs/CreateModelLinkTaskJobSpec.md +32 -0
  74. arthur_client/api_bindings/docs/CreateModelTaskJobSpec.md +33 -0
  75. arthur_client/api_bindings/docs/CreatedAlerts.md +30 -0
  76. arthur_client/api_bindings/docs/Credentials.md +32 -0
  77. arthur_client/api_bindings/docs/DType.md +26 -0
  78. arthur_client/api_bindings/docs/DataPlane.md +37 -0
  79. arthur_client/api_bindings/docs/DataPlaneAssociation.md +35 -0
  80. arthur_client/api_bindings/docs/DataPlaneAssociationSort.md +12 -0
  81. arthur_client/api_bindings/docs/DataPlaneAssociationsV1Api.md +443 -0
  82. arthur_client/api_bindings/docs/DataPlaneCapabilities.md +29 -0
  83. arthur_client/api_bindings/docs/DataPlaneSort.md +14 -0
  84. arthur_client/api_bindings/docs/DataPlanesV1Api.md +502 -0
  85. arthur_client/api_bindings/docs/DataResultFilter.md +31 -0
  86. arthur_client/api_bindings/docs/DataResultFilterOp.md +24 -0
  87. arthur_client/api_bindings/docs/DataRetrievalData.md +30 -0
  88. arthur_client/api_bindings/docs/DataRetrievalOperation.md +32 -0
  89. arthur_client/api_bindings/docs/DataRetrievalStatus.md +14 -0
  90. arthur_client/api_bindings/docs/DataRetrievalV1Api.md +656 -0
  91. arthur_client/api_bindings/docs/Dataset.md +39 -0
  92. arthur_client/api_bindings/docs/DatasetColumn.md +31 -0
  93. arthur_client/api_bindings/docs/DatasetConnector.md +31 -0
  94. arthur_client/api_bindings/docs/DatasetJoinKind.md +16 -0
  95. arthur_client/api_bindings/docs/DatasetJoinSpec.md +31 -0
  96. arthur_client/api_bindings/docs/DatasetListType.md +32 -0
  97. arthur_client/api_bindings/docs/DatasetLocator.md +29 -0
  98. arthur_client/api_bindings/docs/DatasetLocatorField.md +30 -0
  99. arthur_client/api_bindings/docs/DatasetLocatorFieldDataType.md +14 -0
  100. arthur_client/api_bindings/docs/DatasetLocatorSchema.md +29 -0
  101. arthur_client/api_bindings/docs/DatasetLocatorSchemaField.md +33 -0
  102. arthur_client/api_bindings/docs/DatasetObjectType.md +32 -0
  103. arthur_client/api_bindings/docs/DatasetReference.md +31 -0
  104. arthur_client/api_bindings/docs/DatasetScalarType.md +32 -0
  105. arthur_client/api_bindings/docs/DatasetSchema.md +31 -0
  106. arthur_client/api_bindings/docs/DatasetsSort.md +12 -0
  107. arthur_client/api_bindings/docs/DatasetsV1Api.md +1174 -0
  108. arthur_client/api_bindings/docs/DefaultApi.md +74 -0
  109. arthur_client/api_bindings/docs/Definition.md +34 -0
  110. arthur_client/api_bindings/docs/DeleteGroupMembership.md +29 -0
  111. arthur_client/api_bindings/docs/DeleteModelTaskJobSpec.md +30 -0
  112. arthur_client/api_bindings/docs/Dimension.md +30 -0
  113. arthur_client/api_bindings/docs/ExampleConfig.md +30 -0
  114. arthur_client/api_bindings/docs/ExamplesConfig.md +30 -0
  115. arthur_client/api_bindings/docs/ExtendedRole.md +39 -0
  116. arthur_client/api_bindings/docs/FeatureFlagsV1Api.md +73 -0
  117. arthur_client/api_bindings/docs/FetchDataJobSpec.md +36 -0
  118. arthur_client/api_bindings/docs/FetchModelTaskJobSpec.md +30 -0
  119. arthur_client/api_bindings/docs/GenerateMetricsSpecRequest.md +29 -0
  120. arthur_client/api_bindings/docs/Group.md +35 -0
  121. arthur_client/api_bindings/docs/GroupMembership.md +33 -0
  122. arthur_client/api_bindings/docs/GroupSort.md +14 -0
  123. arthur_client/api_bindings/docs/GroupsV1Api.md +756 -0
  124. arthur_client/api_bindings/docs/HTTPValidationError.md +29 -0
  125. arthur_client/api_bindings/docs/HealthStatus.md +29 -0
  126. arthur_client/api_bindings/docs/InfinitePagination.md +30 -0
  127. arthur_client/api_bindings/docs/InfiniteResourceListAlert.md +30 -0
  128. arthur_client/api_bindings/docs/InfiniteResourceListJob.md +30 -0
  129. arthur_client/api_bindings/docs/InternalServerError.md +29 -0
  130. arthur_client/api_bindings/docs/InviteNewUser.md +31 -0
  131. arthur_client/api_bindings/docs/Items.md +34 -0
  132. arthur_client/api_bindings/docs/Items1.md +31 -0
  133. arthur_client/api_bindings/docs/Job.md +48 -0
  134. arthur_client/api_bindings/docs/JobDequeueParameters.md +29 -0
  135. arthur_client/api_bindings/docs/JobError.md +29 -0
  136. arthur_client/api_bindings/docs/JobErrors.md +29 -0
  137. arthur_client/api_bindings/docs/JobKind.md +34 -0
  138. arthur_client/api_bindings/docs/JobLog.md +31 -0
  139. arthur_client/api_bindings/docs/JobLogLevel.md +18 -0
  140. arthur_client/api_bindings/docs/JobLogs.md +29 -0
  141. arthur_client/api_bindings/docs/JobPriority.md +16 -0
  142. arthur_client/api_bindings/docs/JobRun.md +34 -0
  143. arthur_client/api_bindings/docs/JobSpec.md +49 -0
  144. arthur_client/api_bindings/docs/JobState.md +18 -0
  145. arthur_client/api_bindings/docs/JobTrigger.md +14 -0
  146. arthur_client/api_bindings/docs/JobsBatch.md +29 -0
  147. arthur_client/api_bindings/docs/JobsSort.md +14 -0
  148. arthur_client/api_bindings/docs/JobsV1Api.md +960 -0
  149. arthur_client/api_bindings/docs/JoinedDataset.md +32 -0
  150. arthur_client/api_bindings/docs/KeywordsConfig.md +29 -0
  151. arthur_client/api_bindings/docs/ListDatasetsJobSpec.md +30 -0
  152. arthur_client/api_bindings/docs/ListType.md +29 -0
  153. arthur_client/api_bindings/docs/MetricFunctionsV1Api.md +81 -0
  154. arthur_client/api_bindings/docs/MetricsArgSpec.md +30 -0
  155. arthur_client/api_bindings/docs/MetricsCalculationJobSpec.md +32 -0
  156. arthur_client/api_bindings/docs/MetricsColumnListParameterSchema.md +33 -0
  157. arthur_client/api_bindings/docs/MetricsColumnParameterSchema.md +37 -0
  158. arthur_client/api_bindings/docs/MetricsColumnParameterSchemaAllowedColumnTypesInner.md +31 -0
  159. arthur_client/api_bindings/docs/MetricsDatasetParameterSchema.md +34 -0
  160. arthur_client/api_bindings/docs/MetricsLiteralParameterSchema.md +34 -0
  161. arthur_client/api_bindings/docs/MetricsQueryResult.md +29 -0
  162. arthur_client/api_bindings/docs/MetricsResultFilterOp.md +24 -0
  163. arthur_client/api_bindings/docs/MetricsUpload.md +30 -0
  164. arthur_client/api_bindings/docs/MetricsUploadMetricsInner.md +31 -0
  165. arthur_client/api_bindings/docs/MetricsUploadResult.md +32 -0
  166. arthur_client/api_bindings/docs/MetricsV1Api.md +346 -0
  167. arthur_client/api_bindings/docs/MetricsVersion.md +34 -0
  168. arthur_client/api_bindings/docs/MetricsVersionsSort.md +16 -0
  169. arthur_client/api_bindings/docs/Model.md +41 -0
  170. arthur_client/api_bindings/docs/ModelMetricSpec.md +30 -0
  171. arthur_client/api_bindings/docs/ModelMetricsSchedule.md +32 -0
  172. arthur_client/api_bindings/docs/ModelProblemType.md +18 -0
  173. arthur_client/api_bindings/docs/ModelsSort.md +14 -0
  174. arthur_client/api_bindings/docs/ModelsV1Api.md +742 -0
  175. arthur_client/api_bindings/docs/NewRuleRequest.md +33 -0
  176. arthur_client/api_bindings/docs/NotFoundError.md +29 -0
  177. arthur_client/api_bindings/docs/NumericMetric.md +30 -0
  178. arthur_client/api_bindings/docs/NumericPoint.md +30 -0
  179. arthur_client/api_bindings/docs/NumericTimeSeries.md +30 -0
  180. arthur_client/api_bindings/docs/OAuthV1Api.md +73 -0
  181. arthur_client/api_bindings/docs/ObjectType.md +29 -0
  182. arthur_client/api_bindings/docs/ObjectValue.md +34 -0
  183. arthur_client/api_bindings/docs/Organization.md +32 -0
  184. arthur_client/api_bindings/docs/OrganizationsV1Api.md +234 -0
  185. arthur_client/api_bindings/docs/PIIConfig.md +31 -0
  186. arthur_client/api_bindings/docs/Pagination.md +32 -0
  187. arthur_client/api_bindings/docs/PatchAlertRule.md +35 -0
  188. arthur_client/api_bindings/docs/PatchConnectorSpec.md +31 -0
  189. arthur_client/api_bindings/docs/PatchDataPlane.md +31 -0
  190. arthur_client/api_bindings/docs/PatchDataPlaneCapabilities.md +29 -0
  191. arthur_client/api_bindings/docs/PatchDataset.md +31 -0
  192. arthur_client/api_bindings/docs/PatchDatasetLocator.md +29 -0
  193. arthur_client/api_bindings/docs/PatchGroup.md +30 -0
  194. arthur_client/api_bindings/docs/PatchJob.md +29 -0
  195. arthur_client/api_bindings/docs/PatchModel.md +31 -0
  196. arthur_client/api_bindings/docs/PatchOrganization.md +29 -0
  197. arthur_client/api_bindings/docs/PatchProject.md +30 -0
  198. arthur_client/api_bindings/docs/PatchServiceAccountUser.md +29 -0
  199. arthur_client/api_bindings/docs/PatchTaskRequest.md +32 -0
  200. arthur_client/api_bindings/docs/PatchUser.md +32 -0
  201. arthur_client/api_bindings/docs/PatchWebhook.md +32 -0
  202. arthur_client/api_bindings/docs/PatchWorkspace.md +29 -0
  203. arthur_client/api_bindings/docs/Permission.md +31 -0
  204. arthur_client/api_bindings/docs/PermissionName.md +272 -0
  205. arthur_client/api_bindings/docs/PermissionRequestItem.md +31 -0
  206. arthur_client/api_bindings/docs/PermissionResponseItem.md +32 -0
  207. arthur_client/api_bindings/docs/PermissionsRequest.md +29 -0
  208. arthur_client/api_bindings/docs/PermissionsResponse.md +29 -0
  209. arthur_client/api_bindings/docs/PostAlert.md +36 -0
  210. arthur_client/api_bindings/docs/PostAlertRule.md +35 -0
  211. arthur_client/api_bindings/docs/PostAlerts.md +29 -0
  212. arthur_client/api_bindings/docs/PostConnectorSpec.md +33 -0
  213. arthur_client/api_bindings/docs/PostDataPlane.md +31 -0
  214. arthur_client/api_bindings/docs/PostDataPlaneAssociation.md +30 -0
  215. arthur_client/api_bindings/docs/PostDataRetrievalOperation.md +32 -0
  216. arthur_client/api_bindings/docs/PostDataset.md +33 -0
  217. arthur_client/api_bindings/docs/PostDatasetJoinSpec.md +33 -0
  218. arthur_client/api_bindings/docs/PostEndUser.md +33 -0
  219. arthur_client/api_bindings/docs/PostGlobalRoleBinding.md +31 -0
  220. arthur_client/api_bindings/docs/PostGroup.md +30 -0
  221. arthur_client/api_bindings/docs/PostGroupMembership.md +29 -0
  222. arthur_client/api_bindings/docs/PostJob.md +34 -0
  223. arthur_client/api_bindings/docs/PostJobBatch.md +29 -0
  224. arthur_client/api_bindings/docs/PostJobKind.md +21 -0
  225. arthur_client/api_bindings/docs/PostJobSpec.md +37 -0
  226. arthur_client/api_bindings/docs/PostLinkTaskRequest.md +31 -0
  227. arthur_client/api_bindings/docs/PostMetricsQuery.md +32 -0
  228. arthur_client/api_bindings/docs/PostMetricsQueryResultFilter.md +31 -0
  229. arthur_client/api_bindings/docs/PostMetricsQueryResultFilterAndGroup.md +29 -0
  230. arthur_client/api_bindings/docs/PostMetricsQueryResultFilterAndGroupAndInner.md +33 -0
  231. arthur_client/api_bindings/docs/PostMetricsQueryResultFilterOrGroup.md +29 -0
  232. arthur_client/api_bindings/docs/PostMetricsQueryResultFilterOrGroupOrInner.md +33 -0
  233. arthur_client/api_bindings/docs/PostMetricsQueryTimeRange.md +30 -0
  234. arthur_client/api_bindings/docs/PostMetricsVersions.md +30 -0
  235. arthur_client/api_bindings/docs/PostModel.md +33 -0
  236. arthur_client/api_bindings/docs/PostProject.md +30 -0
  237. arthur_client/api_bindings/docs/PostRoleBinding.md +31 -0
  238. arthur_client/api_bindings/docs/PostServiceAccount.md +29 -0
  239. arthur_client/api_bindings/docs/PostTaskRequest.md +32 -0
  240. arthur_client/api_bindings/docs/PostTaskValidationAPIKey.md +31 -0
  241. arthur_client/api_bindings/docs/PostUpsolveTenant.md +30 -0
  242. arthur_client/api_bindings/docs/PostWebhook.md +32 -0
  243. arthur_client/api_bindings/docs/PostWorkspace.md +29 -0
  244. arthur_client/api_bindings/docs/Project.md +35 -0
  245. arthur_client/api_bindings/docs/ProjectBoundResourceMetadata.md +30 -0
  246. arthur_client/api_bindings/docs/ProjectSort.md +14 -0
  247. arthur_client/api_bindings/docs/ProjectsV1Api.md +420 -0
  248. arthur_client/api_bindings/docs/PutAvailableDataset.md +33 -0
  249. arthur_client/api_bindings/docs/PutAvailableDatasets.md +29 -0
  250. arthur_client/api_bindings/docs/PutDatasetSchema.md +30 -0
  251. arthur_client/api_bindings/docs/PutJobState.md +29 -0
  252. arthur_client/api_bindings/docs/PutModelMetricSpec.md +29 -0
  253. arthur_client/api_bindings/docs/PutModelMetricsSchedule.md +31 -0
  254. arthur_client/api_bindings/docs/PutRetrievedData.md +29 -0
  255. arthur_client/api_bindings/docs/PutTaskConnectionInfo.md +30 -0
  256. arthur_client/api_bindings/docs/PutTaskStateCacheRequest.md +29 -0
  257. arthur_client/api_bindings/docs/RegenerateTaskValidationKeyJobSpec.md +30 -0
  258. arthur_client/api_bindings/docs/RegexConfig.md +29 -0
  259. arthur_client/api_bindings/docs/RegisterUser.md +29 -0
  260. arthur_client/api_bindings/docs/RegistrationV1Api.md +80 -0
  261. arthur_client/api_bindings/docs/ResourceKind.md +40 -0
  262. arthur_client/api_bindings/docs/ResourceListAggregationSpecSchema.md +30 -0
  263. arthur_client/api_bindings/docs/ResourceListAlertRule.md +30 -0
  264. arthur_client/api_bindings/docs/ResourceListAvailableDataset.md +30 -0
  265. arthur_client/api_bindings/docs/ResourceListConnectorSpec.md +30 -0
  266. arthur_client/api_bindings/docs/ResourceListConnectorType.md +30 -0
  267. arthur_client/api_bindings/docs/ResourceListDataPlane.md +30 -0
  268. arthur_client/api_bindings/docs/ResourceListDataPlaneAssociation.md +30 -0
  269. arthur_client/api_bindings/docs/ResourceListDataset.md +30 -0
  270. arthur_client/api_bindings/docs/ResourceListGroup.md +30 -0
  271. arthur_client/api_bindings/docs/ResourceListGroupMembership.md +30 -0
  272. arthur_client/api_bindings/docs/ResourceListJobError.md +30 -0
  273. arthur_client/api_bindings/docs/ResourceListJobLog.md +30 -0
  274. arthur_client/api_bindings/docs/ResourceListJobRun.md +30 -0
  275. arthur_client/api_bindings/docs/ResourceListMetricsVersion.md +30 -0
  276. arthur_client/api_bindings/docs/ResourceListModel.md +30 -0
  277. arthur_client/api_bindings/docs/ResourceListPermission.md +30 -0
  278. arthur_client/api_bindings/docs/ResourceListProject.md +30 -0
  279. arthur_client/api_bindings/docs/ResourceListRole.md +30 -0
  280. arthur_client/api_bindings/docs/ResourceListRoleBinding.md +30 -0
  281. arthur_client/api_bindings/docs/ResourceListUser.md +30 -0
  282. arthur_client/api_bindings/docs/ResourceListWebhook.md +30 -0
  283. arthur_client/api_bindings/docs/ResourceListWorkspace.md +30 -0
  284. arthur_client/api_bindings/docs/ResultFilter.md +34 -0
  285. arthur_client/api_bindings/docs/Role.md +39 -0
  286. arthur_client/api_bindings/docs/RoleBinding.md +36 -0
  287. arthur_client/api_bindings/docs/RoleSort.md +14 -0
  288. arthur_client/api_bindings/docs/RolesV1Api.md +87 -0
  289. arthur_client/api_bindings/docs/RuleResponse.md +38 -0
  290. arthur_client/api_bindings/docs/RuleResponseConfig.md +37 -0
  291. arthur_client/api_bindings/docs/RuleScope.md +12 -0
  292. arthur_client/api_bindings/docs/RuleType.md +26 -0
  293. arthur_client/api_bindings/docs/ScalarType.md +29 -0
  294. arthur_client/api_bindings/docs/ScheduleJobsJobSpec.md +31 -0
  295. arthur_client/api_bindings/docs/SchemaInspectionJobSpec.md +31 -0
  296. arthur_client/api_bindings/docs/ScopeSchemaTag.md +26 -0
  297. arthur_client/api_bindings/docs/SensitiveDataPlane.md +39 -0
  298. arthur_client/api_bindings/docs/SensitiveUser.md +41 -0
  299. arthur_client/api_bindings/docs/ServiceAccountCredentials.md +30 -0
  300. arthur_client/api_bindings/docs/SketchMetric.md +30 -0
  301. arthur_client/api_bindings/docs/SketchPoint.md +30 -0
  302. arthur_client/api_bindings/docs/SketchTimeSeries.md +30 -0
  303. arthur_client/api_bindings/docs/SortOrder.md +12 -0
  304. arthur_client/api_bindings/docs/TaskConnectionInfo.md +32 -0
  305. arthur_client/api_bindings/docs/TaskMutationResponse.md +29 -0
  306. arthur_client/api_bindings/docs/TaskReadResponse.md +31 -0
  307. arthur_client/api_bindings/docs/TaskResponse.md +33 -0
  308. arthur_client/api_bindings/docs/TaskValidationAPIKey.md +31 -0
  309. arthur_client/api_bindings/docs/TaskValidationKeyRegenerationResponse.md +29 -0
  310. arthur_client/api_bindings/docs/TasksV1Api.md +892 -0
  311. arthur_client/api_bindings/docs/ToxicityConfig.md +29 -0
  312. arthur_client/api_bindings/docs/UpdateModelTaskRulesJobSpec.md +34 -0
  313. arthur_client/api_bindings/docs/UpsolveToken.md +29 -0
  314. arthur_client/api_bindings/docs/UpsolveV1Api.md +88 -0
  315. arthur_client/api_bindings/docs/User.md +40 -0
  316. arthur_client/api_bindings/docs/UserCredentials.md +29 -0
  317. arthur_client/api_bindings/docs/UserServiceAccountCredentials.md +41 -0
  318. arthur_client/api_bindings/docs/UserSort.md +16 -0
  319. arthur_client/api_bindings/docs/UserType.md +14 -0
  320. arthur_client/api_bindings/docs/UsersV1Api.md +810 -0
  321. arthur_client/api_bindings/docs/ValidationError.md +31 -0
  322. arthur_client/api_bindings/docs/ValidationErrorLocInner.md +28 -0
  323. arthur_client/api_bindings/docs/Webhook.md +37 -0
  324. arthur_client/api_bindings/docs/WebhookResponse.md +30 -0
  325. arthur_client/api_bindings/docs/WebhookResult.md +30 -0
  326. arthur_client/api_bindings/docs/WebhookSort.md +14 -0
  327. arthur_client/api_bindings/docs/WebhooksV1Api.md +503 -0
  328. arthur_client/api_bindings/docs/Workspace.md +33 -0
  329. arthur_client/api_bindings/docs/WorkspaceSort.md +14 -0
  330. arthur_client/api_bindings/docs/WorkspacesV1Api.md +416 -0
  331. arthur_client/api_bindings/exceptions.py +199 -0
  332. arthur_client/api_bindings/models/__init__.py +288 -0
  333. arthur_client/api_bindings/models/aggregation_metric_type.py +37 -0
  334. arthur_client/api_bindings/models/aggregation_spec.py +106 -0
  335. arthur_client/api_bindings/models/aggregation_spec_schema.py +113 -0
  336. arthur_client/api_bindings/models/aggregation_spec_schema_init_args_inner.py +164 -0
  337. arthur_client/api_bindings/models/alert.py +137 -0
  338. arthur_client/api_bindings/models/alert_bound.py +37 -0
  339. arthur_client/api_bindings/models/alert_check_job_spec.py +104 -0
  340. arthur_client/api_bindings/models/alert_rule.py +133 -0
  341. arthur_client/api_bindings/models/alert_rule_notification_webhook.py +89 -0
  342. arthur_client/api_bindings/models/alert_rule_sort.py +37 -0
  343. arthur_client/api_bindings/models/alert_sort.py +37 -0
  344. arthur_client/api_bindings/models/alert_webhook_called.py +95 -0
  345. arthur_client/api_bindings/models/available_dataset.py +151 -0
  346. arthur_client/api_bindings/models/available_datasets_sort.py +38 -0
  347. arthur_client/api_bindings/models/bad_request_error.py +87 -0
  348. arthur_client/api_bindings/models/base_role.py +96 -0
  349. arthur_client/api_bindings/models/bound_member.py +89 -0
  350. arthur_client/api_bindings/models/bound_member_kind.py +37 -0
  351. arthur_client/api_bindings/models/bound_resource.py +100 -0
  352. arthur_client/api_bindings/models/bound_resource_kind.py +39 -0
  353. arthur_client/api_bindings/models/bound_role.py +89 -0
  354. arthur_client/api_bindings/models/config.py +185 -0
  355. arthur_client/api_bindings/models/conflict_error.py +87 -0
  356. arthur_client/api_bindings/models/connector_check_job_spec.py +99 -0
  357. arthur_client/api_bindings/models/connector_check_outcome.py +37 -0
  358. arthur_client/api_bindings/models/connector_check_result.py +95 -0
  359. arthur_client/api_bindings/models/connector_field_data_type.py +39 -0
  360. arthur_client/api_bindings/models/connector_pagination_options.py +90 -0
  361. arthur_client/api_bindings/models/connector_spec.py +135 -0
  362. arthur_client/api_bindings/models/connector_spec_field.py +89 -0
  363. arthur_client/api_bindings/models/connector_spec_field_with_metadata.py +94 -0
  364. arthur_client/api_bindings/models/connector_spec_schema.py +111 -0
  365. arthur_client/api_bindings/models/connector_spec_schema_field.py +103 -0
  366. arthur_client/api_bindings/models/connector_type.py +40 -0
  367. arthur_client/api_bindings/models/connectors_sort.py +38 -0
  368. arthur_client/api_bindings/models/create_model_link_task_job_spec.py +108 -0
  369. arthur_client/api_bindings/models/create_model_task_job_spec.py +118 -0
  370. arthur_client/api_bindings/models/created_alerts.py +110 -0
  371. arthur_client/api_bindings/models/credentials.py +134 -0
  372. arthur_client/api_bindings/models/d_type.py +44 -0
  373. arthur_client/api_bindings/models/data_plane.py +113 -0
  374. arthur_client/api_bindings/models/data_plane_association.py +118 -0
  375. arthur_client/api_bindings/models/data_plane_association_sort.py +37 -0
  376. arthur_client/api_bindings/models/data_plane_capabilities.py +87 -0
  377. arthur_client/api_bindings/models/data_plane_sort.py +38 -0
  378. arthur_client/api_bindings/models/data_result_filter.py +97 -0
  379. arthur_client/api_bindings/models/data_result_filter_op.py +43 -0
  380. arthur_client/api_bindings/models/data_retrieval_data.py +94 -0
  381. arthur_client/api_bindings/models/data_retrieval_operation.py +103 -0
  382. arthur_client/api_bindings/models/data_retrieval_status.py +38 -0
  383. arthur_client/api_bindings/models/dataset.py +145 -0
  384. arthur_client/api_bindings/models/dataset_column.py +95 -0
  385. arthur_client/api_bindings/models/dataset_connector.py +92 -0
  386. arthur_client/api_bindings/models/dataset_join_kind.py +39 -0
  387. arthur_client/api_bindings/models/dataset_join_spec.py +99 -0
  388. arthur_client/api_bindings/models/dataset_list_type.py +105 -0
  389. arthur_client/api_bindings/models/dataset_locator.py +95 -0
  390. arthur_client/api_bindings/models/dataset_locator_field.py +89 -0
  391. arthur_client/api_bindings/models/dataset_locator_field_data_type.py +38 -0
  392. arthur_client/api_bindings/models/dataset_locator_schema.py +95 -0
  393. arthur_client/api_bindings/models/dataset_locator_schema_field.py +101 -0
  394. arthur_client/api_bindings/models/dataset_object_type.py +114 -0
  395. arthur_client/api_bindings/models/dataset_reference.py +97 -0
  396. arthur_client/api_bindings/models/dataset_scalar_type.py +100 -0
  397. arthur_client/api_bindings/models/dataset_schema.py +101 -0
  398. arthur_client/api_bindings/models/datasets_sort.py +37 -0
  399. arthur_client/api_bindings/models/definition.py +149 -0
  400. arthur_client/api_bindings/models/delete_group_membership.py +87 -0
  401. arthur_client/api_bindings/models/delete_model_task_job_spec.py +99 -0
  402. arthur_client/api_bindings/models/dimension.py +89 -0
  403. arthur_client/api_bindings/models/example_config.py +89 -0
  404. arthur_client/api_bindings/models/examples_config.py +102 -0
  405. arthur_client/api_bindings/models/extended_role.py +129 -0
  406. arthur_client/api_bindings/models/fetch_data_job_spec.py +134 -0
  407. arthur_client/api_bindings/models/fetch_model_task_job_spec.py +99 -0
  408. arthur_client/api_bindings/models/generate_metrics_spec_request.py +87 -0
  409. arthur_client/api_bindings/models/group.py +105 -0
  410. arthur_client/api_bindings/models/group_membership.py +100 -0
  411. arthur_client/api_bindings/models/group_sort.py +38 -0
  412. arthur_client/api_bindings/models/health_status.py +87 -0
  413. arthur_client/api_bindings/models/http_validation_error.py +95 -0
  414. arthur_client/api_bindings/models/infinite_pagination.py +89 -0
  415. arthur_client/api_bindings/models/infinite_resource_list_alert.py +101 -0
  416. arthur_client/api_bindings/models/infinite_resource_list_job.py +101 -0
  417. arthur_client/api_bindings/models/internal_server_error.py +87 -0
  418. arthur_client/api_bindings/models/invite_new_user.py +105 -0
  419. arthur_client/api_bindings/models/items.py +151 -0
  420. arthur_client/api_bindings/models/items1.py +151 -0
  421. arthur_client/api_bindings/models/job.py +178 -0
  422. arthur_client/api_bindings/models/job_dequeue_parameters.py +87 -0
  423. arthur_client/api_bindings/models/job_error.py +87 -0
  424. arthur_client/api_bindings/models/job_errors.py +95 -0
  425. arthur_client/api_bindings/models/job_kind.py +48 -0
  426. arthur_client/api_bindings/models/job_log.py +93 -0
  427. arthur_client/api_bindings/models/job_log_level.py +40 -0
  428. arthur_client/api_bindings/models/job_logs.py +95 -0
  429. arthur_client/api_bindings/models/job_priority.py +39 -0
  430. arthur_client/api_bindings/models/job_run.py +104 -0
  431. arthur_client/api_bindings/models/job_spec.py +299 -0
  432. arthur_client/api_bindings/models/job_state.py +40 -0
  433. arthur_client/api_bindings/models/job_trigger.py +38 -0
  434. arthur_client/api_bindings/models/jobs_batch.py +95 -0
  435. arthur_client/api_bindings/models/jobs_sort.py +38 -0
  436. arthur_client/api_bindings/models/joined_dataset.py +98 -0
  437. arthur_client/api_bindings/models/keywords_config.py +87 -0
  438. arthur_client/api_bindings/models/list_datasets_job_spec.py +99 -0
  439. arthur_client/api_bindings/models/list_type.py +93 -0
  440. arthur_client/api_bindings/models/metrics_arg_spec.py +94 -0
  441. arthur_client/api_bindings/models/metrics_calculation_job_spec.py +104 -0
  442. arthur_client/api_bindings/models/metrics_column_list_parameter_schema.py +105 -0
  443. arthur_client/api_bindings/models/metrics_column_parameter_schema.py +127 -0
  444. arthur_client/api_bindings/models/metrics_column_parameter_schema_allowed_column_types_inner.py +151 -0
  445. arthur_client/api_bindings/models/metrics_dataset_parameter_schema.py +113 -0
  446. arthur_client/api_bindings/models/metrics_literal_parameter_schema.py +108 -0
  447. arthur_client/api_bindings/models/metrics_query_result.py +87 -0
  448. arthur_client/api_bindings/models/metrics_result_filter_op.py +43 -0
  449. arthur_client/api_bindings/models/metrics_upload.py +95 -0
  450. arthur_client/api_bindings/models/metrics_upload_metrics_inner.py +134 -0
  451. arthur_client/api_bindings/models/metrics_upload_result.py +93 -0
  452. arthur_client/api_bindings/models/metrics_version.py +98 -0
  453. arthur_client/api_bindings/models/metrics_versions_sort.py +39 -0
  454. arthur_client/api_bindings/models/model.py +153 -0
  455. arthur_client/api_bindings/models/model_metric_spec.py +97 -0
  456. arthur_client/api_bindings/models/model_metrics_schedule.py +98 -0
  457. arthur_client/api_bindings/models/model_problem_type.py +40 -0
  458. arthur_client/api_bindings/models/models_sort.py +38 -0
  459. arthur_client/api_bindings/models/new_rule_request.py +104 -0
  460. arthur_client/api_bindings/models/not_found_error.py +87 -0
  461. arthur_client/api_bindings/models/numeric_metric.py +97 -0
  462. arthur_client/api_bindings/models/numeric_point.py +90 -0
  463. arthur_client/api_bindings/models/numeric_time_series.py +105 -0
  464. arthur_client/api_bindings/models/object_type.py +102 -0
  465. arthur_client/api_bindings/models/object_value.py +151 -0
  466. arthur_client/api_bindings/models/organization.py +94 -0
  467. arthur_client/api_bindings/models/pagination.py +93 -0
  468. arthur_client/api_bindings/models/patch_alert_rule.py +135 -0
  469. arthur_client/api_bindings/models/patch_connector_spec.py +109 -0
  470. arthur_client/api_bindings/models/patch_data_plane.py +110 -0
  471. arthur_client/api_bindings/models/patch_data_plane_capabilities.py +92 -0
  472. arthur_client/api_bindings/models/patch_dataset.py +111 -0
  473. arthur_client/api_bindings/models/patch_dataset_locator.py +100 -0
  474. arthur_client/api_bindings/models/patch_group.py +99 -0
  475. arthur_client/api_bindings/models/patch_job.py +92 -0
  476. arthur_client/api_bindings/models/patch_model.py +106 -0
  477. arthur_client/api_bindings/models/patch_organization.py +92 -0
  478. arthur_client/api_bindings/models/patch_project.py +99 -0
  479. arthur_client/api_bindings/models/patch_service_account_user.py +92 -0
  480. arthur_client/api_bindings/models/patch_task_request.py +101 -0
  481. arthur_client/api_bindings/models/patch_user.py +113 -0
  482. arthur_client/api_bindings/models/patch_webhook.py +113 -0
  483. arthur_client/api_bindings/models/patch_workspace.py +87 -0
  484. arthur_client/api_bindings/models/permission.py +93 -0
  485. arthur_client/api_bindings/models/permission_name.py +167 -0
  486. arthur_client/api_bindings/models/permission_request_item.py +93 -0
  487. arthur_client/api_bindings/models/permission_response_item.py +95 -0
  488. arthur_client/api_bindings/models/permissions_request.py +96 -0
  489. arthur_client/api_bindings/models/permissions_response.py +95 -0
  490. arthur_client/api_bindings/models/pii_config.py +106 -0
  491. arthur_client/api_bindings/models/post_alert.py +118 -0
  492. arthur_client/api_bindings/models/post_alert_rule.py +105 -0
  493. arthur_client/api_bindings/models/post_alerts.py +96 -0
  494. arthur_client/api_bindings/models/post_connector_spec.py +104 -0
  495. arthur_client/api_bindings/models/post_data_plane.py +95 -0
  496. arthur_client/api_bindings/models/post_data_plane_association.py +89 -0
  497. arthur_client/api_bindings/models/post_data_retrieval_operation.py +106 -0
  498. arthur_client/api_bindings/models/post_dataset.py +128 -0
  499. arthur_client/api_bindings/models/post_dataset_join_spec.py +96 -0
  500. arthur_client/api_bindings/models/post_end_user.py +105 -0
  501. arthur_client/api_bindings/models/post_global_role_binding.py +92 -0
  502. arthur_client/api_bindings/models/post_group.py +94 -0
  503. arthur_client/api_bindings/models/post_group_membership.py +87 -0
  504. arthur_client/api_bindings/models/post_job.py +124 -0
  505. arthur_client/api_bindings/models/post_job_batch.py +95 -0
  506. arthur_client/api_bindings/models/post_job_kind.py +41 -0
  507. arthur_client/api_bindings/models/post_job_spec.py +194 -0
  508. arthur_client/api_bindings/models/post_link_task_request.py +96 -0
  509. arthur_client/api_bindings/models/post_metrics_query.py +106 -0
  510. arthur_client/api_bindings/models/post_metrics_query_result_filter.py +97 -0
  511. arthur_client/api_bindings/models/post_metrics_query_result_filter_and_group.py +97 -0
  512. arthur_client/api_bindings/models/post_metrics_query_result_filter_and_group_and_inner.py +151 -0
  513. arthur_client/api_bindings/models/post_metrics_query_result_filter_or_group.py +97 -0
  514. arthur_client/api_bindings/models/post_metrics_query_result_filter_or_group_or_inner.py +151 -0
  515. arthur_client/api_bindings/models/post_metrics_query_time_range.py +90 -0
  516. arthur_client/api_bindings/models/post_metrics_versions.py +90 -0
  517. arthur_client/api_bindings/models/post_model.py +115 -0
  518. arthur_client/api_bindings/models/post_project.py +94 -0
  519. arthur_client/api_bindings/models/post_role_binding.py +101 -0
  520. arthur_client/api_bindings/models/post_service_account.py +87 -0
  521. arthur_client/api_bindings/models/post_task_request.py +107 -0
  522. arthur_client/api_bindings/models/post_task_validation_api_key.py +91 -0
  523. arthur_client/api_bindings/models/post_upsolve_tenant.py +90 -0
  524. arthur_client/api_bindings/models/post_webhook.py +93 -0
  525. arthur_client/api_bindings/models/post_workspace.py +87 -0
  526. arthur_client/api_bindings/models/project.py +105 -0
  527. arthur_client/api_bindings/models/project_bound_resource_metadata.py +89 -0
  528. arthur_client/api_bindings/models/project_sort.py +38 -0
  529. arthur_client/api_bindings/models/put_available_dataset.py +133 -0
  530. arthur_client/api_bindings/models/put_available_datasets.py +95 -0
  531. arthur_client/api_bindings/models/put_dataset_schema.py +97 -0
  532. arthur_client/api_bindings/models/put_job_state.py +88 -0
  533. arthur_client/api_bindings/models/put_model_metric_spec.py +95 -0
  534. arthur_client/api_bindings/models/put_model_metrics_schedule.py +96 -0
  535. arthur_client/api_bindings/models/put_retrieved_data.py +87 -0
  536. arthur_client/api_bindings/models/put_task_connection_info.py +93 -0
  537. arthur_client/api_bindings/models/put_task_state_cache_request.py +91 -0
  538. arthur_client/api_bindings/models/regenerate_task_validation_key_job_spec.py +99 -0
  539. arthur_client/api_bindings/models/regex_config.py +87 -0
  540. arthur_client/api_bindings/models/register_user.py +87 -0
  541. arthur_client/api_bindings/models/resource_kind.py +51 -0
  542. arthur_client/api_bindings/models/resource_list_aggregation_spec_schema.py +101 -0
  543. arthur_client/api_bindings/models/resource_list_alert_rule.py +101 -0
  544. arthur_client/api_bindings/models/resource_list_available_dataset.py +101 -0
  545. arthur_client/api_bindings/models/resource_list_connector_spec.py +101 -0
  546. arthur_client/api_bindings/models/resource_list_connector_type.py +94 -0
  547. arthur_client/api_bindings/models/resource_list_data_plane.py +101 -0
  548. arthur_client/api_bindings/models/resource_list_data_plane_association.py +101 -0
  549. arthur_client/api_bindings/models/resource_list_dataset.py +101 -0
  550. arthur_client/api_bindings/models/resource_list_group.py +101 -0
  551. arthur_client/api_bindings/models/resource_list_group_membership.py +101 -0
  552. arthur_client/api_bindings/models/resource_list_job_error.py +101 -0
  553. arthur_client/api_bindings/models/resource_list_job_log.py +101 -0
  554. arthur_client/api_bindings/models/resource_list_job_run.py +101 -0
  555. arthur_client/api_bindings/models/resource_list_metrics_version.py +101 -0
  556. arthur_client/api_bindings/models/resource_list_model.py +101 -0
  557. arthur_client/api_bindings/models/resource_list_permission.py +101 -0
  558. arthur_client/api_bindings/models/resource_list_project.py +101 -0
  559. arthur_client/api_bindings/models/resource_list_role.py +101 -0
  560. arthur_client/api_bindings/models/resource_list_role_binding.py +101 -0
  561. arthur_client/api_bindings/models/resource_list_user.py +101 -0
  562. arthur_client/api_bindings/models/resource_list_webhook.py +101 -0
  563. arthur_client/api_bindings/models/resource_list_workspace.py +101 -0
  564. arthur_client/api_bindings/models/result_filter.py +155 -0
  565. arthur_client/api_bindings/models/role.py +114 -0
  566. arthur_client/api_bindings/models/role_binding.py +116 -0
  567. arthur_client/api_bindings/models/role_sort.py +38 -0
  568. arthur_client/api_bindings/models/rule_response.py +121 -0
  569. arthur_client/api_bindings/models/rule_response_config.py +185 -0
  570. arthur_client/api_bindings/models/rule_scope.py +37 -0
  571. arthur_client/api_bindings/models/rule_type.py +44 -0
  572. arthur_client/api_bindings/models/scalar_type.py +88 -0
  573. arthur_client/api_bindings/models/schedule_jobs_job_spec.py +102 -0
  574. arthur_client/api_bindings/models/schema_inspection_job_spec.py +101 -0
  575. arthur_client/api_bindings/models/scope_schema_tag.py +44 -0
  576. arthur_client/api_bindings/models/sensitive_data_plane.py +117 -0
  577. arthur_client/api_bindings/models/sensitive_user.py +142 -0
  578. arthur_client/api_bindings/models/service_account_credentials.py +89 -0
  579. arthur_client/api_bindings/models/sketch_metric.py +97 -0
  580. arthur_client/api_bindings/models/sketch_point.py +90 -0
  581. arthur_client/api_bindings/models/sketch_time_series.py +105 -0
  582. arthur_client/api_bindings/models/sort_order.py +37 -0
  583. arthur_client/api_bindings/models/task_connection_info.py +98 -0
  584. arthur_client/api_bindings/models/task_mutation_response.py +87 -0
  585. arthur_client/api_bindings/models/task_read_response.py +106 -0
  586. arthur_client/api_bindings/models/task_response.py +103 -0
  587. arthur_client/api_bindings/models/task_validation_api_key.py +91 -0
  588. arthur_client/api_bindings/models/task_validation_key_regeneration_response.py +87 -0
  589. arthur_client/api_bindings/models/toxicity_config.py +100 -0
  590. arthur_client/api_bindings/models/update_model_task_rules_job_spec.py +115 -0
  591. arthur_client/api_bindings/models/upsolve_token.py +87 -0
  592. arthur_client/api_bindings/models/user.py +136 -0
  593. arthur_client/api_bindings/models/user_credentials.py +87 -0
  594. arthur_client/api_bindings/models/user_service_account_credentials.py +142 -0
  595. arthur_client/api_bindings/models/user_sort.py +39 -0
  596. arthur_client/api_bindings/models/user_type.py +38 -0
  597. arthur_client/api_bindings/models/validation_error.py +99 -0
  598. arthur_client/api_bindings/models/validation_error_loc_inner.py +138 -0
  599. arthur_client/api_bindings/models/webhook.py +113 -0
  600. arthur_client/api_bindings/models/webhook_response.py +99 -0
  601. arthur_client/api_bindings/models/webhook_result.py +103 -0
  602. arthur_client/api_bindings/models/webhook_sort.py +38 -0
  603. arthur_client/api_bindings/models/workspace.py +96 -0
  604. arthur_client/api_bindings/models/workspace_sort.py +38 -0
  605. arthur_client/api_bindings/rest.py +257 -0
  606. arthur_client/api_bindings/test/test_aggregation_metric_type.py +33 -0
  607. arthur_client/api_bindings/test/test_aggregation_spec.py +72 -0
  608. arthur_client/api_bindings/test/test_aggregation_spec_schema.py +70 -0
  609. arthur_client/api_bindings/test/test_aggregation_spec_schema_init_args_inner.py +70 -0
  610. arthur_client/api_bindings/test/test_alert.py +78 -0
  611. arthur_client/api_bindings/test/test_alert_bound.py +33 -0
  612. arthur_client/api_bindings/test/test_alert_check_job_spec.py +57 -0
  613. arthur_client/api_bindings/test/test_alert_rule.py +92 -0
  614. arthur_client/api_bindings/test/test_alert_rule_notification_webhook.py +54 -0
  615. arthur_client/api_bindings/test/test_alert_rule_sort.py +33 -0
  616. arthur_client/api_bindings/test/test_alert_rules_v1_api.py +66 -0
  617. arthur_client/api_bindings/test/test_alert_sort.py +33 -0
  618. arthur_client/api_bindings/test/test_alert_webhook_called.py +64 -0
  619. arthur_client/api_bindings/test/test_alerts_v1_api.py +52 -0
  620. arthur_client/api_bindings/test/test_authorization_v1_api.py +115 -0
  621. arthur_client/api_bindings/test/test_available_dataset.py +94 -0
  622. arthur_client/api_bindings/test/test_available_datasets_sort.py +33 -0
  623. arthur_client/api_bindings/test/test_bad_request_error.py +51 -0
  624. arthur_client/api_bindings/test/test_base_role.py +56 -0
  625. arthur_client/api_bindings/test/test_bound_member.py +54 -0
  626. arthur_client/api_bindings/test/test_bound_member_kind.py +33 -0
  627. arthur_client/api_bindings/test/test_bound_resource.py +57 -0
  628. arthur_client/api_bindings/test/test_bound_resource_kind.py +33 -0
  629. arthur_client/api_bindings/test/test_bound_role.py +54 -0
  630. arthur_client/api_bindings/test/test_config.py +77 -0
  631. arthur_client/api_bindings/test/test_conflict_error.py +51 -0
  632. arthur_client/api_bindings/test/test_connector_check_job_spec.py +53 -0
  633. arthur_client/api_bindings/test/test_connector_check_outcome.py +33 -0
  634. arthur_client/api_bindings/test/test_connector_check_result.py +53 -0
  635. arthur_client/api_bindings/test/test_connector_field_data_type.py +33 -0
  636. arthur_client/api_bindings/test/test_connector_pagination_options.py +52 -0
  637. arthur_client/api_bindings/test/test_connector_schemas_v1_api.py +45 -0
  638. arthur_client/api_bindings/test/test_connector_spec.py +96 -0
  639. arthur_client/api_bindings/test/test_connector_spec_field.py +54 -0
  640. arthur_client/api_bindings/test/test_connector_spec_field_with_metadata.py +58 -0
  641. arthur_client/api_bindings/test/test_connector_spec_schema.py +102 -0
  642. arthur_client/api_bindings/test/test_connector_spec_schema_field.py +63 -0
  643. arthur_client/api_bindings/test/test_connector_type.py +33 -0
  644. arthur_client/api_bindings/test/test_connectors_sort.py +33 -0
  645. arthur_client/api_bindings/test/test_connectors_v1_api.py +80 -0
  646. arthur_client/api_bindings/test/test_create_model_link_task_job_spec.py +56 -0
  647. arthur_client/api_bindings/test/test_create_model_task_job_spec.py +72 -0
  648. arthur_client/api_bindings/test/test_created_alerts.py +96 -0
  649. arthur_client/api_bindings/test/test_credentials.py +56 -0
  650. arthur_client/api_bindings/test/test_d_type.py +33 -0
  651. arthur_client/api_bindings/test/test_data_plane.py +70 -0
  652. arthur_client/api_bindings/test/test_data_plane_association.py +79 -0
  653. arthur_client/api_bindings/test/test_data_plane_association_sort.py +33 -0
  654. arthur_client/api_bindings/test/test_data_plane_associations_v1_api.py +66 -0
  655. arthur_client/api_bindings/test/test_data_plane_capabilities.py +51 -0
  656. arthur_client/api_bindings/test/test_data_plane_sort.py +33 -0
  657. arthur_client/api_bindings/test/test_data_planes_v1_api.py +73 -0
  658. arthur_client/api_bindings/test/test_data_result_filter.py +56 -0
  659. arthur_client/api_bindings/test/test_data_result_filter_op.py +33 -0
  660. arthur_client/api_bindings/test/test_data_retrieval_data.py +54 -0
  661. arthur_client/api_bindings/test/test_data_retrieval_operation.py +59 -0
  662. arthur_client/api_bindings/test/test_data_retrieval_status.py +33 -0
  663. arthur_client/api_bindings/test/test_data_retrieval_v1_api.py +87 -0
  664. arthur_client/api_bindings/test/test_dataset.py +117 -0
  665. arthur_client/api_bindings/test/test_dataset_column.py +55 -0
  666. arthur_client/api_bindings/test/test_dataset_connector.py +56 -0
  667. arthur_client/api_bindings/test/test_dataset_join_kind.py +33 -0
  668. arthur_client/api_bindings/test/test_dataset_join_spec.py +71 -0
  669. arthur_client/api_bindings/test/test_dataset_list_type.py +57 -0
  670. arthur_client/api_bindings/test/test_dataset_locator.py +60 -0
  671. arthur_client/api_bindings/test/test_dataset_locator_field.py +54 -0
  672. arthur_client/api_bindings/test/test_dataset_locator_field_data_type.py +33 -0
  673. arthur_client/api_bindings/test/test_dataset_locator_schema.py +70 -0
  674. arthur_client/api_bindings/test/test_dataset_locator_schema_field.py +61 -0
  675. arthur_client/api_bindings/test/test_dataset_object_type.py +61 -0
  676. arthur_client/api_bindings/test/test_dataset_reference.py +56 -0
  677. arthur_client/api_bindings/test/test_dataset_scalar_type.py +57 -0
  678. arthur_client/api_bindings/test/test_dataset_schema.py +74 -0
  679. arthur_client/api_bindings/test/test_datasets_sort.py +33 -0
  680. arthur_client/api_bindings/test/test_datasets_v1_api.py +129 -0
  681. arthur_client/api_bindings/test/test_default_api.py +38 -0
  682. arthur_client/api_bindings/test/test_definition.py +65 -0
  683. arthur_client/api_bindings/test/test_delete_group_membership.py +56 -0
  684. arthur_client/api_bindings/test/test_delete_model_task_job_spec.py +53 -0
  685. arthur_client/api_bindings/test/test_dimension.py +54 -0
  686. arthur_client/api_bindings/test/test_example_config.py +54 -0
  687. arthur_client/api_bindings/test/test_examples_config.py +57 -0
  688. arthur_client/api_bindings/test/test_extended_role.py +92 -0
  689. arthur_client/api_bindings/test/test_feature_flags_v1_api.py +38 -0
  690. arthur_client/api_bindings/test/test_fetch_data_job_spec.py +77 -0
  691. arthur_client/api_bindings/test/test_fetch_model_task_job_spec.py +53 -0
  692. arthur_client/api_bindings/test/test_generate_metrics_spec_request.py +56 -0
  693. arthur_client/api_bindings/test/test_group.py +63 -0
  694. arthur_client/api_bindings/test/test_group_membership.py +74 -0
  695. arthur_client/api_bindings/test/test_group_sort.py +33 -0
  696. arthur_client/api_bindings/test/test_groups_v1_api.py +94 -0
  697. arthur_client/api_bindings/test/test_health_status.py +51 -0
  698. arthur_client/api_bindings/test/test_http_validation_error.py +58 -0
  699. arthur_client/api_bindings/test/test_infinite_pagination.py +52 -0
  700. arthur_client/api_bindings/test/test_infinite_resource_list_alert.py +92 -0
  701. arthur_client/api_bindings/test/test_infinite_resource_list_job.py +126 -0
  702. arthur_client/api_bindings/test/test_internal_server_error.py +51 -0
  703. arthur_client/api_bindings/test/test_invite_new_user.py +59 -0
  704. arthur_client/api_bindings/test/test_items.py +65 -0
  705. arthur_client/api_bindings/test/test_items1.py +60 -0
  706. arthur_client/api_bindings/test/test_job.py +94 -0
  707. arthur_client/api_bindings/test/test_job_dequeue_parameters.py +52 -0
  708. arthur_client/api_bindings/test/test_job_error.py +52 -0
  709. arthur_client/api_bindings/test/test_job_errors.py +58 -0
  710. arthur_client/api_bindings/test/test_job_kind.py +33 -0
  711. arthur_client/api_bindings/test/test_job_log.py +56 -0
  712. arthur_client/api_bindings/test/test_job_log_level.py +33 -0
  713. arthur_client/api_bindings/test/test_job_logs.py +62 -0
  714. arthur_client/api_bindings/test/test_job_priority.py +33 -0
  715. arthur_client/api_bindings/test/test_job_run.py +61 -0
  716. arthur_client/api_bindings/test/test_job_spec.py +124 -0
  717. arthur_client/api_bindings/test/test_job_state.py +33 -0
  718. arthur_client/api_bindings/test/test_job_trigger.py +33 -0
  719. arthur_client/api_bindings/test/test_jobs_batch.py +120 -0
  720. arthur_client/api_bindings/test/test_jobs_sort.py +33 -0
  721. arthur_client/api_bindings/test/test_jobs_v1_api.py +108 -0
  722. arthur_client/api_bindings/test/test_joined_dataset.py +58 -0
  723. arthur_client/api_bindings/test/test_keywords_config.py +56 -0
  724. arthur_client/api_bindings/test/test_list_datasets_job_spec.py +53 -0
  725. arthur_client/api_bindings/test/test_list_type.py +52 -0
  726. arthur_client/api_bindings/test/test_metric_functions_v1_api.py +38 -0
  727. arthur_client/api_bindings/test/test_metrics_arg_spec.py +54 -0
  728. arthur_client/api_bindings/test/test_metrics_calculation_job_spec.py +57 -0
  729. arthur_client/api_bindings/test/test_metrics_column_list_parameter_schema.py +58 -0
  730. arthur_client/api_bindings/test/test_metrics_column_parameter_schema.py +67 -0
  731. arthur_client/api_bindings/test/test_metrics_column_parameter_schema_allowed_column_types_inner.py +60 -0
  732. arthur_client/api_bindings/test/test_metrics_dataset_parameter_schema.py +59 -0
  733. arthur_client/api_bindings/test/test_metrics_literal_parameter_schema.py +60 -0
  734. arthur_client/api_bindings/test/test_metrics_query_result.py +56 -0
  735. arthur_client/api_bindings/test/test_metrics_result_filter_op.py +33 -0
  736. arthur_client/api_bindings/test/test_metrics_upload.py +56 -0
  737. arthur_client/api_bindings/test/test_metrics_upload_metrics_inner.py +104 -0
  738. arthur_client/api_bindings/test/test_metrics_upload_result.py +58 -0
  739. arthur_client/api_bindings/test/test_metrics_v1_api.py +59 -0
  740. arthur_client/api_bindings/test/test_metrics_version.py +62 -0
  741. arthur_client/api_bindings/test/test_metrics_versions_sort.py +33 -0
  742. arthur_client/api_bindings/test/test_model.py +133 -0
  743. arthur_client/api_bindings/test/test_model_metric_spec.py +80 -0
  744. arthur_client/api_bindings/test/test_model_metrics_schedule.py +57 -0
  745. arthur_client/api_bindings/test/test_model_problem_type.py +33 -0
  746. arthur_client/api_bindings/test/test_models_sort.py +33 -0
  747. arthur_client/api_bindings/test/test_models_v1_api.py +94 -0
  748. arthur_client/api_bindings/test/test_new_rule_request.py +59 -0
  749. arthur_client/api_bindings/test/test_not_found_error.py +51 -0
  750. arthur_client/api_bindings/test/test_numeric_metric.py +78 -0
  751. arthur_client/api_bindings/test/test_numeric_point.py +54 -0
  752. arthur_client/api_bindings/test/test_numeric_time_series.py +70 -0
  753. arthur_client/api_bindings/test/test_o_auth_v1_api.py +38 -0
  754. arthur_client/api_bindings/test/test_object_type.py +56 -0
  755. arthur_client/api_bindings/test/test_object_value.py +65 -0
  756. arthur_client/api_bindings/test/test_organization.py +58 -0
  757. arthur_client/api_bindings/test/test_organizations_v1_api.py +52 -0
  758. arthur_client/api_bindings/test/test_pagination.py +56 -0
  759. arthur_client/api_bindings/test/test_patch_alert_rule.py +59 -0
  760. arthur_client/api_bindings/test/test_patch_connector_spec.py +57 -0
  761. arthur_client/api_bindings/test/test_patch_data_plane.py +54 -0
  762. arthur_client/api_bindings/test/test_patch_data_plane_capabilities.py +51 -0
  763. arthur_client/api_bindings/test/test_patch_dataset.py +58 -0
  764. arthur_client/api_bindings/test/test_patch_dataset_locator.py +55 -0
  765. arthur_client/api_bindings/test/test_patch_group.py +52 -0
  766. arthur_client/api_bindings/test/test_patch_job.py +52 -0
  767. arthur_client/api_bindings/test/test_patch_model.py +55 -0
  768. arthur_client/api_bindings/test/test_patch_organization.py +51 -0
  769. arthur_client/api_bindings/test/test_patch_project.py +52 -0
  770. arthur_client/api_bindings/test/test_patch_service_account_user.py +51 -0
  771. arthur_client/api_bindings/test/test_patch_task_request.py +67 -0
  772. arthur_client/api_bindings/test/test_patch_user.py +54 -0
  773. arthur_client/api_bindings/test/test_patch_webhook.py +58 -0
  774. arthur_client/api_bindings/test/test_patch_workspace.py +52 -0
  775. arthur_client/api_bindings/test/test_permission.py +56 -0
  776. arthur_client/api_bindings/test/test_permission_name.py +33 -0
  777. arthur_client/api_bindings/test/test_permission_request_item.py +56 -0
  778. arthur_client/api_bindings/test/test_permission_response_item.py +58 -0
  779. arthur_client/api_bindings/test/test_permissions_request.py +62 -0
  780. arthur_client/api_bindings/test/test_permissions_response.py +64 -0
  781. arthur_client/api_bindings/test/test_pii_config.py +57 -0
  782. arthur_client/api_bindings/test/test_post_alert.py +65 -0
  783. arthur_client/api_bindings/test/test_post_alert_rule.py +64 -0
  784. arthur_client/api_bindings/test/test_post_alerts.py +72 -0
  785. arthur_client/api_bindings/test/test_post_connector_spec.py +67 -0
  786. arthur_client/api_bindings/test/test_post_data_plane.py +56 -0
  787. arthur_client/api_bindings/test/test_post_data_plane_association.py +54 -0
  788. arthur_client/api_bindings/test/test_post_data_retrieval_operation.py +63 -0
  789. arthur_client/api_bindings/test/test_post_dataset.py +75 -0
  790. arthur_client/api_bindings/test/test_post_dataset_join_spec.py +59 -0
  791. arthur_client/api_bindings/test/test_post_end_user.py +58 -0
  792. arthur_client/api_bindings/test/test_post_global_role_binding.py +56 -0
  793. arthur_client/api_bindings/test/test_post_group.py +53 -0
  794. arthur_client/api_bindings/test/test_post_group_membership.py +56 -0
  795. arthur_client/api_bindings/test/test_post_job.py +58 -0
  796. arthur_client/api_bindings/test/test_post_job_batch.py +68 -0
  797. arthur_client/api_bindings/test/test_post_job_kind.py +33 -0
  798. arthur_client/api_bindings/test/test_post_job_spec.py +65 -0
  799. arthur_client/api_bindings/test/test_post_link_task_request.py +55 -0
  800. arthur_client/api_bindings/test/test_post_metrics_query.py +60 -0
  801. arthur_client/api_bindings/test/test_post_metrics_query_result_filter.py +56 -0
  802. arthur_client/api_bindings/test/test_post_metrics_query_result_filter_and_group.py +56 -0
  803. arthur_client/api_bindings/test/test_post_metrics_query_result_filter_and_group_and_inner.py +68 -0
  804. arthur_client/api_bindings/test/test_post_metrics_query_result_filter_or_group.py +56 -0
  805. arthur_client/api_bindings/test/test_post_metrics_query_result_filter_or_group_or_inner.py +68 -0
  806. arthur_client/api_bindings/test/test_post_metrics_query_time_range.py +54 -0
  807. arthur_client/api_bindings/test/test_post_metrics_versions.py +54 -0
  808. arthur_client/api_bindings/test/test_post_model.py +75 -0
  809. arthur_client/api_bindings/test/test_post_project.py +53 -0
  810. arthur_client/api_bindings/test/test_post_role_binding.py +54 -0
  811. arthur_client/api_bindings/test/test_post_service_account.py +52 -0
  812. arthur_client/api_bindings/test/test_post_task_request.py +63 -0
  813. arthur_client/api_bindings/test/test_post_task_validation_api_key.py +56 -0
  814. arthur_client/api_bindings/test/test_post_upsolve_tenant.py +54 -0
  815. arthur_client/api_bindings/test/test_post_webhook.py +61 -0
  816. arthur_client/api_bindings/test/test_post_workspace.py +52 -0
  817. arthur_client/api_bindings/test/test_project.py +63 -0
  818. arthur_client/api_bindings/test/test_project_bound_resource_metadata.py +54 -0
  819. arthur_client/api_bindings/test/test_project_sort.py +33 -0
  820. arthur_client/api_bindings/test/test_projects_v1_api.py +66 -0
  821. arthur_client/api_bindings/test/test_put_available_dataset.py +74 -0
  822. arthur_client/api_bindings/test/test_put_available_datasets.py +104 -0
  823. arthur_client/api_bindings/test/test_put_dataset_schema.py +68 -0
  824. arthur_client/api_bindings/test/test_put_job_state.py +52 -0
  825. arthur_client/api_bindings/test/test_put_model_metric_spec.py +78 -0
  826. arthur_client/api_bindings/test/test_put_model_metrics_schedule.py +55 -0
  827. arthur_client/api_bindings/test/test_put_retrieved_data.py +52 -0
  828. arthur_client/api_bindings/test/test_put_task_connection_info.py +60 -0
  829. arthur_client/api_bindings/test/test_put_task_state_cache_request.py +86 -0
  830. arthur_client/api_bindings/test/test_regenerate_task_validation_key_job_spec.py +53 -0
  831. arthur_client/api_bindings/test/test_regex_config.py +56 -0
  832. arthur_client/api_bindings/test/test_register_user.py +52 -0
  833. arthur_client/api_bindings/test/test_registration_v1_api.py +38 -0
  834. arthur_client/api_bindings/test/test_resource_kind.py +33 -0
  835. arthur_client/api_bindings/test/test_resource_list_aggregation_spec_schema.py +86 -0
  836. arthur_client/api_bindings/test/test_resource_list_alert_rule.py +122 -0
  837. arthur_client/api_bindings/test/test_resource_list_available_dataset.py +144 -0
  838. arthur_client/api_bindings/test/test_resource_list_connector_spec.py +128 -0
  839. arthur_client/api_bindings/test/test_resource_list_connector_type.py +66 -0
  840. arthur_client/api_bindings/test/test_resource_list_data_plane.py +86 -0
  841. arthur_client/api_bindings/test/test_resource_list_data_plane_association.py +114 -0
  842. arthur_client/api_bindings/test/test_resource_list_dataset.py +150 -0
  843. arthur_client/api_bindings/test/test_resource_list_group.py +80 -0
  844. arthur_client/api_bindings/test/test_resource_list_group_membership.py +90 -0
  845. arthur_client/api_bindings/test/test_resource_list_job_error.py +68 -0
  846. arthur_client/api_bindings/test/test_resource_list_job_log.py +72 -0
  847. arthur_client/api_bindings/test/test_resource_list_job_run.py +78 -0
  848. arthur_client/api_bindings/test/test_resource_list_metrics_version.py +78 -0
  849. arthur_client/api_bindings/test/test_resource_list_model.py +168 -0
  850. arthur_client/api_bindings/test/test_resource_list_permission.py +72 -0
  851. arthur_client/api_bindings/test/test_resource_list_project.py +80 -0
  852. arthur_client/api_bindings/test/test_resource_list_role.py +96 -0
  853. arthur_client/api_bindings/test/test_resource_list_role_binding.py +100 -0
  854. arthur_client/api_bindings/test/test_resource_list_user.py +90 -0
  855. arthur_client/api_bindings/test/test_resource_list_webhook.py +116 -0
  856. arthur_client/api_bindings/test/test_resource_list_workspace.py +76 -0
  857. arthur_client/api_bindings/test/test_result_filter.py +68 -0
  858. arthur_client/api_bindings/test/test_role.py +80 -0
  859. arthur_client/api_bindings/test/test_role_binding.py +84 -0
  860. arthur_client/api_bindings/test/test_role_sort.py +33 -0
  861. arthur_client/api_bindings/test/test_roles_v1_api.py +38 -0
  862. arthur_client/api_bindings/test/test_rule_response.py +68 -0
  863. arthur_client/api_bindings/test/test_rule_response_config.py +77 -0
  864. arthur_client/api_bindings/test/test_rule_scope.py +33 -0
  865. arthur_client/api_bindings/test/test_rule_type.py +33 -0
  866. arthur_client/api_bindings/test/test_scalar_type.py +52 -0
  867. arthur_client/api_bindings/test/test_schedule_jobs_job_spec.py +55 -0
  868. arthur_client/api_bindings/test/test_schema_inspection_job_spec.py +55 -0
  869. arthur_client/api_bindings/test/test_scope_schema_tag.py +33 -0
  870. arthur_client/api_bindings/test/test_sensitive_data_plane.py +74 -0
  871. arthur_client/api_bindings/test/test_sensitive_user.py +72 -0
  872. arthur_client/api_bindings/test/test_service_account_credentials.py +54 -0
  873. arthur_client/api_bindings/test/test_sketch_metric.py +78 -0
  874. arthur_client/api_bindings/test/test_sketch_point.py +54 -0
  875. arthur_client/api_bindings/test/test_sketch_time_series.py +70 -0
  876. arthur_client/api_bindings/test/test_sort_order.py +33 -0
  877. arthur_client/api_bindings/test/test_task_connection_info.py +64 -0
  878. arthur_client/api_bindings/test/test_task_mutation_response.py +52 -0
  879. arthur_client/api_bindings/test/test_task_read_response.py +71 -0
  880. arthur_client/api_bindings/test/test_task_response.py +84 -0
  881. arthur_client/api_bindings/test/test_task_validation_api_key.py +56 -0
  882. arthur_client/api_bindings/test/test_task_validation_key_regeneration_response.py +52 -0
  883. arthur_client/api_bindings/test/test_tasks_v1_api.py +108 -0
  884. arthur_client/api_bindings/test/test_toxicity_config.py +51 -0
  885. arthur_client/api_bindings/test/test_update_model_task_rules_job_spec.py +70 -0
  886. arthur_client/api_bindings/test/test_upsolve_token.py +52 -0
  887. arthur_client/api_bindings/test/test_upsolve_v1_api.py +38 -0
  888. arthur_client/api_bindings/test/test_user.py +70 -0
  889. arthur_client/api_bindings/test/test_user_credentials.py +52 -0
  890. arthur_client/api_bindings/test/test_user_service_account_credentials.py +76 -0
  891. arthur_client/api_bindings/test/test_user_sort.py +33 -0
  892. arthur_client/api_bindings/test/test_user_type.py +33 -0
  893. arthur_client/api_bindings/test/test_users_v1_api.py +101 -0
  894. arthur_client/api_bindings/test/test_validation_error.py +60 -0
  895. arthur_client/api_bindings/test/test_validation_error_loc_inner.py +50 -0
  896. arthur_client/api_bindings/test/test_webhook.py +82 -0
  897. arthur_client/api_bindings/test/test_webhook_response.py +54 -0
  898. arthur_client/api_bindings/test/test_webhook_result.py +58 -0
  899. arthur_client/api_bindings/test/test_webhook_sort.py +33 -0
  900. arthur_client/api_bindings/test/test_webhooks_v1_api.py +73 -0
  901. arthur_client/api_bindings/test/test_workspace.py +60 -0
  902. arthur_client/api_bindings/test/test_workspace_sort.py +33 -0
  903. arthur_client/api_bindings/test/test_workspaces_v1_api.py +66 -0
  904. arthur_client/api_bindings_README.md +509 -0
  905. arthur_client/auth/__init__.py +4 -0
  906. arthur_client/auth/constants.py +1 -0
  907. arthur_client/auth/device_authorizer.py +74 -0
  908. arthur_client/auth/discovery.py +40 -0
  909. arthur_client/auth/oauth_api_config.py +38 -0
  910. arthur_client/auth/session.py +84 -0
  911. arthur_client-1.4.1055.dist-info/METADATA +40 -0
  912. arthur_client-1.4.1055.dist-info/RECORD +915 -0
  913. {arthur_client-1.4.0.dist-info → arthur_client-1.4.1055.dist-info}/WHEEL +1 -2
  914. arthur/client/__init__.py +0 -3
  915. arthur/client/auth/helpers.py +0 -123
  916. arthur/client/auth/refresh.py +0 -67
  917. arthur/client/helpers.py +0 -48
  918. arthur/client/http/helper.py +0 -47
  919. arthur/client/http/requests.py +0 -654
  920. arthur/client/http/validation.py +0 -197
  921. arthur/client/rest/__init__.py +0 -16
  922. arthur/client/rest/admin/__init__.py +0 -2
  923. arthur/client/rest/admin/client.py +0 -330
  924. arthur/client/rest/admin/models.py +0 -457
  925. arthur/client/rest/alerts/__init__.py +0 -2
  926. arthur/client/rest/alerts/client.py +0 -589
  927. arthur/client/rest/alerts/models.py +0 -695
  928. arthur/client/rest/bench/__init__.py +0 -2
  929. arthur/client/rest/bench/client.py +0 -280
  930. arthur/client/rest/bench/models.py +0 -229
  931. arthur/client/rest/client.py +0 -158
  932. arthur/client/rest/common/__init__.py +0 -2
  933. arthur/client/rest/common/client.py +0 -25
  934. arthur/client/rest/common/models.py +0 -317
  935. arthur/client/rest/enrichments/__init__.py +0 -2
  936. arthur/client/rest/enrichments/client.py +0 -352
  937. arthur/client/rest/enrichments/models.py +0 -483
  938. arthur/client/rest/inferences/__init__.py +0 -2
  939. arthur/client/rest/inferences/client.py +0 -268
  940. arthur/client/rest/inferences/models.py +0 -432
  941. arthur/client/rest/insights/__init__.py +0 -2
  942. arthur/client/rest/insights/client.py +0 -199
  943. arthur/client/rest/insights/models.py +0 -182
  944. arthur/client/rest/metrics/__init__.py +0 -2
  945. arthur/client/rest/metrics/client.py +0 -296
  946. arthur/client/rest/metrics/models.py +0 -325
  947. arthur/client/rest/model_groups/__init__.py +0 -2
  948. arthur/client/rest/model_groups/client.py +0 -153
  949. arthur/client/rest/model_groups/models.py +0 -80
  950. arthur/client/rest/models/__init__.py +0 -2
  951. arthur/client/rest/models/client.py +0 -534
  952. arthur/client/rest/models/models.py +0 -565
  953. arthur/client/rest/query/__init__.py +0 -2
  954. arthur/client/rest/query/client.py +0 -123
  955. arthur/client/rest/query/models.py +0 -133
  956. arthur/client/rest/users/__init__.py +0 -2
  957. arthur/client/rest/users/client.py +0 -171
  958. arthur/client/rest/users/models.py +0 -317
  959. arthur/client/types.py +0 -9
  960. arthur/client/version.py +0 -2
  961. arthur/common/__init__.py +0 -3
  962. arthur/common/constants.py +0 -5
  963. arthur/common/exceptions.py +0 -183
  964. arthur/common/log.py +0 -79
  965. arthur_client-1.4.0.dist-info/LICENSE +0 -21
  966. arthur_client-1.4.0.dist-info/METADATA +0 -49
  967. arthur_client-1.4.0.dist-info/RECORD +0 -58
  968. arthur_client-1.4.0.dist-info/top_level.txt +0 -1
  969. {arthur/client/auth → arthur_client}/__init__.py +0 -0
  970. {arthur/client/http → arthur_client/api_bindings/test}/__init__.py +0 -0
@@ -0,0 +1,2803 @@
1
+ # coding: utf-8
2
+
3
+ """
4
+ Arthur Scope
5
+
6
+ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
7
+
8
+ The version of the OpenAPI document: 0.1.0
9
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
10
+
11
+ Do not edit the class manually.
12
+ """ # noqa: E501
13
+
14
+ import warnings
15
+ from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
16
+ from typing import Any, Dict, List, Optional, Tuple, Union
17
+ from typing_extensions import Annotated
18
+
19
+ from pydantic import Field, StrictStr
20
+ from typing import List, Optional
21
+ from typing_extensions import Annotated
22
+ from arthur_client.api_bindings.models.delete_group_membership import DeleteGroupMembership
23
+ from arthur_client.api_bindings.models.group import Group
24
+ from arthur_client.api_bindings.models.group_sort import GroupSort
25
+ from arthur_client.api_bindings.models.patch_group import PatchGroup
26
+ from arthur_client.api_bindings.models.post_group import PostGroup
27
+ from arthur_client.api_bindings.models.post_group_membership import PostGroupMembership
28
+ from arthur_client.api_bindings.models.resource_list_group import ResourceListGroup
29
+ from arthur_client.api_bindings.models.resource_list_group_membership import ResourceListGroupMembership
30
+ from arthur_client.api_bindings.models.resource_list_user import ResourceListUser
31
+ from arthur_client.api_bindings.models.sort_order import SortOrder
32
+ from arthur_client.api_bindings.models.user_sort import UserSort
33
+
34
+ from arthur_client.api_bindings.api_client import ApiClient, RequestSerialized
35
+ from arthur_client.api_bindings.api_response import ApiResponse
36
+ from arthur_client.api_bindings.rest import RESTResponseType
37
+
38
+
39
+ class GroupsV1Api:
40
+ """NOTE: This class is auto generated by OpenAPI Generator
41
+ Ref: https://openapi-generator.tech
42
+
43
+ Do not edit the class manually.
44
+ """
45
+
46
+ def __init__(self, api_client=None) -> None:
47
+ if api_client is None:
48
+ api_client = ApiClient.get_default()
49
+ self.api_client = api_client
50
+
51
+
52
+ @validate_call
53
+ def assign_users_to_group(
54
+ self,
55
+ group_id: StrictStr,
56
+ post_group_membership: PostGroupMembership,
57
+ _request_timeout: Union[
58
+ None,
59
+ Annotated[StrictFloat, Field(gt=0)],
60
+ Tuple[
61
+ Annotated[StrictFloat, Field(gt=0)],
62
+ Annotated[StrictFloat, Field(gt=0)]
63
+ ]
64
+ ] = None,
65
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
66
+ _content_type: Optional[StrictStr] = None,
67
+ _headers: Optional[Dict[StrictStr, Any]] = None,
68
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
69
+ ) -> Group:
70
+ """Assign User To Group
71
+
72
+ Assign user to group by group ID. Requires group_create_group_membership permission.
73
+
74
+ :param group_id: (required)
75
+ :type group_id: str
76
+ :param post_group_membership: (required)
77
+ :type post_group_membership: PostGroupMembership
78
+ :param _request_timeout: timeout setting for this request. If one
79
+ number provided, it will be total request
80
+ timeout. It can also be a pair (tuple) of
81
+ (connection, read) timeouts.
82
+ :type _request_timeout: int, tuple(int, int), optional
83
+ :param _request_auth: set to override the auth_settings for an a single
84
+ request; this effectively ignores the
85
+ authentication in the spec for a single request.
86
+ :type _request_auth: dict, optional
87
+ :param _content_type: force content-type for the request.
88
+ :type _content_type: str, Optional
89
+ :param _headers: set to override the headers for a single
90
+ request; this effectively ignores the headers
91
+ in the spec for a single request.
92
+ :type _headers: dict, optional
93
+ :param _host_index: set to override the host_index for a single
94
+ request; this effectively ignores the host_index
95
+ in the spec for a single request.
96
+ :type _host_index: int, optional
97
+ :return: Returns the result object.
98
+ """ # noqa: E501
99
+
100
+ _param = self._assign_users_to_group_serialize(
101
+ group_id=group_id,
102
+ post_group_membership=post_group_membership,
103
+ _request_auth=_request_auth,
104
+ _content_type=_content_type,
105
+ _headers=_headers,
106
+ _host_index=_host_index
107
+ )
108
+
109
+ _response_types_map: Dict[str, Optional[str]] = {
110
+ '200': "Group",
111
+ '500': "InternalServerError",
112
+ '404': "NotFoundError",
113
+ '422': "HTTPValidationError",
114
+ }
115
+ response_data = self.api_client.call_api(
116
+ *_param,
117
+ _request_timeout=_request_timeout
118
+ )
119
+ response_data.read()
120
+ return self.api_client.response_deserialize(
121
+ response_data=response_data,
122
+ response_types_map=_response_types_map,
123
+ ).data
124
+
125
+
126
+ @validate_call
127
+ def assign_users_to_group_with_http_info(
128
+ self,
129
+ group_id: StrictStr,
130
+ post_group_membership: PostGroupMembership,
131
+ _request_timeout: Union[
132
+ None,
133
+ Annotated[StrictFloat, Field(gt=0)],
134
+ Tuple[
135
+ Annotated[StrictFloat, Field(gt=0)],
136
+ Annotated[StrictFloat, Field(gt=0)]
137
+ ]
138
+ ] = None,
139
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
140
+ _content_type: Optional[StrictStr] = None,
141
+ _headers: Optional[Dict[StrictStr, Any]] = None,
142
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
143
+ ) -> ApiResponse[Group]:
144
+ """Assign User To Group
145
+
146
+ Assign user to group by group ID. Requires group_create_group_membership permission.
147
+
148
+ :param group_id: (required)
149
+ :type group_id: str
150
+ :param post_group_membership: (required)
151
+ :type post_group_membership: PostGroupMembership
152
+ :param _request_timeout: timeout setting for this request. If one
153
+ number provided, it will be total request
154
+ timeout. It can also be a pair (tuple) of
155
+ (connection, read) timeouts.
156
+ :type _request_timeout: int, tuple(int, int), optional
157
+ :param _request_auth: set to override the auth_settings for an a single
158
+ request; this effectively ignores the
159
+ authentication in the spec for a single request.
160
+ :type _request_auth: dict, optional
161
+ :param _content_type: force content-type for the request.
162
+ :type _content_type: str, Optional
163
+ :param _headers: set to override the headers for a single
164
+ request; this effectively ignores the headers
165
+ in the spec for a single request.
166
+ :type _headers: dict, optional
167
+ :param _host_index: set to override the host_index for a single
168
+ request; this effectively ignores the host_index
169
+ in the spec for a single request.
170
+ :type _host_index: int, optional
171
+ :return: Returns the result object.
172
+ """ # noqa: E501
173
+
174
+ _param = self._assign_users_to_group_serialize(
175
+ group_id=group_id,
176
+ post_group_membership=post_group_membership,
177
+ _request_auth=_request_auth,
178
+ _content_type=_content_type,
179
+ _headers=_headers,
180
+ _host_index=_host_index
181
+ )
182
+
183
+ _response_types_map: Dict[str, Optional[str]] = {
184
+ '200': "Group",
185
+ '500': "InternalServerError",
186
+ '404': "NotFoundError",
187
+ '422': "HTTPValidationError",
188
+ }
189
+ response_data = self.api_client.call_api(
190
+ *_param,
191
+ _request_timeout=_request_timeout
192
+ )
193
+ response_data.read()
194
+ return self.api_client.response_deserialize(
195
+ response_data=response_data,
196
+ response_types_map=_response_types_map,
197
+ )
198
+
199
+
200
+ @validate_call
201
+ def assign_users_to_group_without_preload_content(
202
+ self,
203
+ group_id: StrictStr,
204
+ post_group_membership: PostGroupMembership,
205
+ _request_timeout: Union[
206
+ None,
207
+ Annotated[StrictFloat, Field(gt=0)],
208
+ Tuple[
209
+ Annotated[StrictFloat, Field(gt=0)],
210
+ Annotated[StrictFloat, Field(gt=0)]
211
+ ]
212
+ ] = None,
213
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
214
+ _content_type: Optional[StrictStr] = None,
215
+ _headers: Optional[Dict[StrictStr, Any]] = None,
216
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
217
+ ) -> RESTResponseType:
218
+ """Assign User To Group
219
+
220
+ Assign user to group by group ID. Requires group_create_group_membership permission.
221
+
222
+ :param group_id: (required)
223
+ :type group_id: str
224
+ :param post_group_membership: (required)
225
+ :type post_group_membership: PostGroupMembership
226
+ :param _request_timeout: timeout setting for this request. If one
227
+ number provided, it will be total request
228
+ timeout. It can also be a pair (tuple) of
229
+ (connection, read) timeouts.
230
+ :type _request_timeout: int, tuple(int, int), optional
231
+ :param _request_auth: set to override the auth_settings for an a single
232
+ request; this effectively ignores the
233
+ authentication in the spec for a single request.
234
+ :type _request_auth: dict, optional
235
+ :param _content_type: force content-type for the request.
236
+ :type _content_type: str, Optional
237
+ :param _headers: set to override the headers for a single
238
+ request; this effectively ignores the headers
239
+ in the spec for a single request.
240
+ :type _headers: dict, optional
241
+ :param _host_index: set to override the host_index for a single
242
+ request; this effectively ignores the host_index
243
+ in the spec for a single request.
244
+ :type _host_index: int, optional
245
+ :return: Returns the result object.
246
+ """ # noqa: E501
247
+
248
+ _param = self._assign_users_to_group_serialize(
249
+ group_id=group_id,
250
+ post_group_membership=post_group_membership,
251
+ _request_auth=_request_auth,
252
+ _content_type=_content_type,
253
+ _headers=_headers,
254
+ _host_index=_host_index
255
+ )
256
+
257
+ _response_types_map: Dict[str, Optional[str]] = {
258
+ '200': "Group",
259
+ '500': "InternalServerError",
260
+ '404': "NotFoundError",
261
+ '422': "HTTPValidationError",
262
+ }
263
+ response_data = self.api_client.call_api(
264
+ *_param,
265
+ _request_timeout=_request_timeout
266
+ )
267
+ return response_data.response
268
+
269
+
270
+ def _assign_users_to_group_serialize(
271
+ self,
272
+ group_id,
273
+ post_group_membership,
274
+ _request_auth,
275
+ _content_type,
276
+ _headers,
277
+ _host_index,
278
+ ) -> RequestSerialized:
279
+
280
+ _host = None
281
+
282
+ _collection_formats: Dict[str, str] = {
283
+ }
284
+
285
+ _path_params: Dict[str, str] = {}
286
+ _query_params: List[Tuple[str, str]] = []
287
+ _header_params: Dict[str, Optional[str]] = _headers or {}
288
+ _form_params: List[Tuple[str, str]] = []
289
+ _files: Dict[
290
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
291
+ ] = {}
292
+ _body_params: Optional[bytes] = None
293
+
294
+ # process the path parameters
295
+ if group_id is not None:
296
+ _path_params['group_id'] = group_id
297
+ # process the query parameters
298
+ # process the header parameters
299
+ # process the form parameters
300
+ # process the body parameter
301
+ if post_group_membership is not None:
302
+ _body_params = post_group_membership
303
+
304
+
305
+ # set the HTTP header `Accept`
306
+ if 'Accept' not in _header_params:
307
+ _header_params['Accept'] = self.api_client.select_header_accept(
308
+ [
309
+ 'application/json'
310
+ ]
311
+ )
312
+
313
+ # set the HTTP header `Content-Type`
314
+ if _content_type:
315
+ _header_params['Content-Type'] = _content_type
316
+ else:
317
+ _default_content_type = (
318
+ self.api_client.select_header_content_type(
319
+ [
320
+ 'application/json'
321
+ ]
322
+ )
323
+ )
324
+ if _default_content_type is not None:
325
+ _header_params['Content-Type'] = _default_content_type
326
+
327
+ # authentication setting
328
+ _auth_settings: List[str] = [
329
+ 'OAuth2AuthorizationCode'
330
+ ]
331
+
332
+ return self.api_client.param_serialize(
333
+ method='POST',
334
+ resource_path='/api/v1/groups/{group_id}/users',
335
+ path_params=_path_params,
336
+ query_params=_query_params,
337
+ header_params=_header_params,
338
+ body=_body_params,
339
+ post_params=_form_params,
340
+ files=_files,
341
+ auth_settings=_auth_settings,
342
+ collection_formats=_collection_formats,
343
+ _host=_host,
344
+ _request_auth=_request_auth
345
+ )
346
+
347
+
348
+
349
+
350
+ @validate_call
351
+ def delete_group(
352
+ self,
353
+ group_id: StrictStr,
354
+ _request_timeout: Union[
355
+ None,
356
+ Annotated[StrictFloat, Field(gt=0)],
357
+ Tuple[
358
+ Annotated[StrictFloat, Field(gt=0)],
359
+ Annotated[StrictFloat, Field(gt=0)]
360
+ ]
361
+ ] = None,
362
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
363
+ _content_type: Optional[StrictStr] = None,
364
+ _headers: Optional[Dict[StrictStr, Any]] = None,
365
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
366
+ ) -> None:
367
+ """Delete Group
368
+
369
+ Deletes group by ID. Requires group_delete permission.
370
+
371
+ :param group_id: (required)
372
+ :type group_id: str
373
+ :param _request_timeout: timeout setting for this request. If one
374
+ number provided, it will be total request
375
+ timeout. It can also be a pair (tuple) of
376
+ (connection, read) timeouts.
377
+ :type _request_timeout: int, tuple(int, int), optional
378
+ :param _request_auth: set to override the auth_settings for an a single
379
+ request; this effectively ignores the
380
+ authentication in the spec for a single request.
381
+ :type _request_auth: dict, optional
382
+ :param _content_type: force content-type for the request.
383
+ :type _content_type: str, Optional
384
+ :param _headers: set to override the headers for a single
385
+ request; this effectively ignores the headers
386
+ in the spec for a single request.
387
+ :type _headers: dict, optional
388
+ :param _host_index: set to override the host_index for a single
389
+ request; this effectively ignores the host_index
390
+ in the spec for a single request.
391
+ :type _host_index: int, optional
392
+ :return: Returns the result object.
393
+ """ # noqa: E501
394
+
395
+ _param = self._delete_group_serialize(
396
+ group_id=group_id,
397
+ _request_auth=_request_auth,
398
+ _content_type=_content_type,
399
+ _headers=_headers,
400
+ _host_index=_host_index
401
+ )
402
+
403
+ _response_types_map: Dict[str, Optional[str]] = {
404
+ '204': None,
405
+ '500': "InternalServerError",
406
+ '422': "HTTPValidationError",
407
+ }
408
+ response_data = self.api_client.call_api(
409
+ *_param,
410
+ _request_timeout=_request_timeout
411
+ )
412
+ response_data.read()
413
+ return self.api_client.response_deserialize(
414
+ response_data=response_data,
415
+ response_types_map=_response_types_map,
416
+ ).data
417
+
418
+
419
+ @validate_call
420
+ def delete_group_with_http_info(
421
+ self,
422
+ group_id: StrictStr,
423
+ _request_timeout: Union[
424
+ None,
425
+ Annotated[StrictFloat, Field(gt=0)],
426
+ Tuple[
427
+ Annotated[StrictFloat, Field(gt=0)],
428
+ Annotated[StrictFloat, Field(gt=0)]
429
+ ]
430
+ ] = None,
431
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
432
+ _content_type: Optional[StrictStr] = None,
433
+ _headers: Optional[Dict[StrictStr, Any]] = None,
434
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
435
+ ) -> ApiResponse[None]:
436
+ """Delete Group
437
+
438
+ Deletes group by ID. Requires group_delete permission.
439
+
440
+ :param group_id: (required)
441
+ :type group_id: str
442
+ :param _request_timeout: timeout setting for this request. If one
443
+ number provided, it will be total request
444
+ timeout. It can also be a pair (tuple) of
445
+ (connection, read) timeouts.
446
+ :type _request_timeout: int, tuple(int, int), optional
447
+ :param _request_auth: set to override the auth_settings for an a single
448
+ request; this effectively ignores the
449
+ authentication in the spec for a single request.
450
+ :type _request_auth: dict, optional
451
+ :param _content_type: force content-type for the request.
452
+ :type _content_type: str, Optional
453
+ :param _headers: set to override the headers for a single
454
+ request; this effectively ignores the headers
455
+ in the spec for a single request.
456
+ :type _headers: dict, optional
457
+ :param _host_index: set to override the host_index for a single
458
+ request; this effectively ignores the host_index
459
+ in the spec for a single request.
460
+ :type _host_index: int, optional
461
+ :return: Returns the result object.
462
+ """ # noqa: E501
463
+
464
+ _param = self._delete_group_serialize(
465
+ group_id=group_id,
466
+ _request_auth=_request_auth,
467
+ _content_type=_content_type,
468
+ _headers=_headers,
469
+ _host_index=_host_index
470
+ )
471
+
472
+ _response_types_map: Dict[str, Optional[str]] = {
473
+ '204': None,
474
+ '500': "InternalServerError",
475
+ '422': "HTTPValidationError",
476
+ }
477
+ response_data = self.api_client.call_api(
478
+ *_param,
479
+ _request_timeout=_request_timeout
480
+ )
481
+ response_data.read()
482
+ return self.api_client.response_deserialize(
483
+ response_data=response_data,
484
+ response_types_map=_response_types_map,
485
+ )
486
+
487
+
488
+ @validate_call
489
+ def delete_group_without_preload_content(
490
+ self,
491
+ group_id: StrictStr,
492
+ _request_timeout: Union[
493
+ None,
494
+ Annotated[StrictFloat, Field(gt=0)],
495
+ Tuple[
496
+ Annotated[StrictFloat, Field(gt=0)],
497
+ Annotated[StrictFloat, Field(gt=0)]
498
+ ]
499
+ ] = None,
500
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
501
+ _content_type: Optional[StrictStr] = None,
502
+ _headers: Optional[Dict[StrictStr, Any]] = None,
503
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
504
+ ) -> RESTResponseType:
505
+ """Delete Group
506
+
507
+ Deletes group by ID. Requires group_delete permission.
508
+
509
+ :param group_id: (required)
510
+ :type group_id: str
511
+ :param _request_timeout: timeout setting for this request. If one
512
+ number provided, it will be total request
513
+ timeout. It can also be a pair (tuple) of
514
+ (connection, read) timeouts.
515
+ :type _request_timeout: int, tuple(int, int), optional
516
+ :param _request_auth: set to override the auth_settings for an a single
517
+ request; this effectively ignores the
518
+ authentication in the spec for a single request.
519
+ :type _request_auth: dict, optional
520
+ :param _content_type: force content-type for the request.
521
+ :type _content_type: str, Optional
522
+ :param _headers: set to override the headers for a single
523
+ request; this effectively ignores the headers
524
+ in the spec for a single request.
525
+ :type _headers: dict, optional
526
+ :param _host_index: set to override the host_index for a single
527
+ request; this effectively ignores the host_index
528
+ in the spec for a single request.
529
+ :type _host_index: int, optional
530
+ :return: Returns the result object.
531
+ """ # noqa: E501
532
+
533
+ _param = self._delete_group_serialize(
534
+ group_id=group_id,
535
+ _request_auth=_request_auth,
536
+ _content_type=_content_type,
537
+ _headers=_headers,
538
+ _host_index=_host_index
539
+ )
540
+
541
+ _response_types_map: Dict[str, Optional[str]] = {
542
+ '204': None,
543
+ '500': "InternalServerError",
544
+ '422': "HTTPValidationError",
545
+ }
546
+ response_data = self.api_client.call_api(
547
+ *_param,
548
+ _request_timeout=_request_timeout
549
+ )
550
+ return response_data.response
551
+
552
+
553
+ def _delete_group_serialize(
554
+ self,
555
+ group_id,
556
+ _request_auth,
557
+ _content_type,
558
+ _headers,
559
+ _host_index,
560
+ ) -> RequestSerialized:
561
+
562
+ _host = None
563
+
564
+ _collection_formats: Dict[str, str] = {
565
+ }
566
+
567
+ _path_params: Dict[str, str] = {}
568
+ _query_params: List[Tuple[str, str]] = []
569
+ _header_params: Dict[str, Optional[str]] = _headers or {}
570
+ _form_params: List[Tuple[str, str]] = []
571
+ _files: Dict[
572
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
573
+ ] = {}
574
+ _body_params: Optional[bytes] = None
575
+
576
+ # process the path parameters
577
+ if group_id is not None:
578
+ _path_params['group_id'] = group_id
579
+ # process the query parameters
580
+ # process the header parameters
581
+ # process the form parameters
582
+ # process the body parameter
583
+
584
+
585
+ # set the HTTP header `Accept`
586
+ if 'Accept' not in _header_params:
587
+ _header_params['Accept'] = self.api_client.select_header_accept(
588
+ [
589
+ 'application/json'
590
+ ]
591
+ )
592
+
593
+
594
+ # authentication setting
595
+ _auth_settings: List[str] = [
596
+ 'OAuth2AuthorizationCode'
597
+ ]
598
+
599
+ return self.api_client.param_serialize(
600
+ method='DELETE',
601
+ resource_path='/api/v1/groups/{group_id}',
602
+ path_params=_path_params,
603
+ query_params=_query_params,
604
+ header_params=_header_params,
605
+ body=_body_params,
606
+ post_params=_form_params,
607
+ files=_files,
608
+ auth_settings=_auth_settings,
609
+ collection_formats=_collection_formats,
610
+ _host=_host,
611
+ _request_auth=_request_auth
612
+ )
613
+
614
+
615
+
616
+
617
+ @validate_call
618
+ def get_group(
619
+ self,
620
+ group_id: StrictStr,
621
+ _request_timeout: Union[
622
+ None,
623
+ Annotated[StrictFloat, Field(gt=0)],
624
+ Tuple[
625
+ Annotated[StrictFloat, Field(gt=0)],
626
+ Annotated[StrictFloat, Field(gt=0)]
627
+ ]
628
+ ] = None,
629
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
630
+ _content_type: Optional[StrictStr] = None,
631
+ _headers: Optional[Dict[StrictStr, Any]] = None,
632
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
633
+ ) -> Group:
634
+ """Get Group
635
+
636
+ Fetches group by ID. Requires group_read permission.
637
+
638
+ :param group_id: (required)
639
+ :type group_id: str
640
+ :param _request_timeout: timeout setting for this request. If one
641
+ number provided, it will be total request
642
+ timeout. It can also be a pair (tuple) of
643
+ (connection, read) timeouts.
644
+ :type _request_timeout: int, tuple(int, int), optional
645
+ :param _request_auth: set to override the auth_settings for an a single
646
+ request; this effectively ignores the
647
+ authentication in the spec for a single request.
648
+ :type _request_auth: dict, optional
649
+ :param _content_type: force content-type for the request.
650
+ :type _content_type: str, Optional
651
+ :param _headers: set to override the headers for a single
652
+ request; this effectively ignores the headers
653
+ in the spec for a single request.
654
+ :type _headers: dict, optional
655
+ :param _host_index: set to override the host_index for a single
656
+ request; this effectively ignores the host_index
657
+ in the spec for a single request.
658
+ :type _host_index: int, optional
659
+ :return: Returns the result object.
660
+ """ # noqa: E501
661
+
662
+ _param = self._get_group_serialize(
663
+ group_id=group_id,
664
+ _request_auth=_request_auth,
665
+ _content_type=_content_type,
666
+ _headers=_headers,
667
+ _host_index=_host_index
668
+ )
669
+
670
+ _response_types_map: Dict[str, Optional[str]] = {
671
+ '200': "Group",
672
+ '500': "InternalServerError",
673
+ '404': "NotFoundError",
674
+ '422': "HTTPValidationError",
675
+ }
676
+ response_data = self.api_client.call_api(
677
+ *_param,
678
+ _request_timeout=_request_timeout
679
+ )
680
+ response_data.read()
681
+ return self.api_client.response_deserialize(
682
+ response_data=response_data,
683
+ response_types_map=_response_types_map,
684
+ ).data
685
+
686
+
687
+ @validate_call
688
+ def get_group_with_http_info(
689
+ self,
690
+ group_id: StrictStr,
691
+ _request_timeout: Union[
692
+ None,
693
+ Annotated[StrictFloat, Field(gt=0)],
694
+ Tuple[
695
+ Annotated[StrictFloat, Field(gt=0)],
696
+ Annotated[StrictFloat, Field(gt=0)]
697
+ ]
698
+ ] = None,
699
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
700
+ _content_type: Optional[StrictStr] = None,
701
+ _headers: Optional[Dict[StrictStr, Any]] = None,
702
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
703
+ ) -> ApiResponse[Group]:
704
+ """Get Group
705
+
706
+ Fetches group by ID. Requires group_read permission.
707
+
708
+ :param group_id: (required)
709
+ :type group_id: str
710
+ :param _request_timeout: timeout setting for this request. If one
711
+ number provided, it will be total request
712
+ timeout. It can also be a pair (tuple) of
713
+ (connection, read) timeouts.
714
+ :type _request_timeout: int, tuple(int, int), optional
715
+ :param _request_auth: set to override the auth_settings for an a single
716
+ request; this effectively ignores the
717
+ authentication in the spec for a single request.
718
+ :type _request_auth: dict, optional
719
+ :param _content_type: force content-type for the request.
720
+ :type _content_type: str, Optional
721
+ :param _headers: set to override the headers for a single
722
+ request; this effectively ignores the headers
723
+ in the spec for a single request.
724
+ :type _headers: dict, optional
725
+ :param _host_index: set to override the host_index for a single
726
+ request; this effectively ignores the host_index
727
+ in the spec for a single request.
728
+ :type _host_index: int, optional
729
+ :return: Returns the result object.
730
+ """ # noqa: E501
731
+
732
+ _param = self._get_group_serialize(
733
+ group_id=group_id,
734
+ _request_auth=_request_auth,
735
+ _content_type=_content_type,
736
+ _headers=_headers,
737
+ _host_index=_host_index
738
+ )
739
+
740
+ _response_types_map: Dict[str, Optional[str]] = {
741
+ '200': "Group",
742
+ '500': "InternalServerError",
743
+ '404': "NotFoundError",
744
+ '422': "HTTPValidationError",
745
+ }
746
+ response_data = self.api_client.call_api(
747
+ *_param,
748
+ _request_timeout=_request_timeout
749
+ )
750
+ response_data.read()
751
+ return self.api_client.response_deserialize(
752
+ response_data=response_data,
753
+ response_types_map=_response_types_map,
754
+ )
755
+
756
+
757
+ @validate_call
758
+ def get_group_without_preload_content(
759
+ self,
760
+ group_id: StrictStr,
761
+ _request_timeout: Union[
762
+ None,
763
+ Annotated[StrictFloat, Field(gt=0)],
764
+ Tuple[
765
+ Annotated[StrictFloat, Field(gt=0)],
766
+ Annotated[StrictFloat, Field(gt=0)]
767
+ ]
768
+ ] = None,
769
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
770
+ _content_type: Optional[StrictStr] = None,
771
+ _headers: Optional[Dict[StrictStr, Any]] = None,
772
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
773
+ ) -> RESTResponseType:
774
+ """Get Group
775
+
776
+ Fetches group by ID. Requires group_read permission.
777
+
778
+ :param group_id: (required)
779
+ :type group_id: str
780
+ :param _request_timeout: timeout setting for this request. If one
781
+ number provided, it will be total request
782
+ timeout. It can also be a pair (tuple) of
783
+ (connection, read) timeouts.
784
+ :type _request_timeout: int, tuple(int, int), optional
785
+ :param _request_auth: set to override the auth_settings for an a single
786
+ request; this effectively ignores the
787
+ authentication in the spec for a single request.
788
+ :type _request_auth: dict, optional
789
+ :param _content_type: force content-type for the request.
790
+ :type _content_type: str, Optional
791
+ :param _headers: set to override the headers for a single
792
+ request; this effectively ignores the headers
793
+ in the spec for a single request.
794
+ :type _headers: dict, optional
795
+ :param _host_index: set to override the host_index for a single
796
+ request; this effectively ignores the host_index
797
+ in the spec for a single request.
798
+ :type _host_index: int, optional
799
+ :return: Returns the result object.
800
+ """ # noqa: E501
801
+
802
+ _param = self._get_group_serialize(
803
+ group_id=group_id,
804
+ _request_auth=_request_auth,
805
+ _content_type=_content_type,
806
+ _headers=_headers,
807
+ _host_index=_host_index
808
+ )
809
+
810
+ _response_types_map: Dict[str, Optional[str]] = {
811
+ '200': "Group",
812
+ '500': "InternalServerError",
813
+ '404': "NotFoundError",
814
+ '422': "HTTPValidationError",
815
+ }
816
+ response_data = self.api_client.call_api(
817
+ *_param,
818
+ _request_timeout=_request_timeout
819
+ )
820
+ return response_data.response
821
+
822
+
823
+ def _get_group_serialize(
824
+ self,
825
+ group_id,
826
+ _request_auth,
827
+ _content_type,
828
+ _headers,
829
+ _host_index,
830
+ ) -> RequestSerialized:
831
+
832
+ _host = None
833
+
834
+ _collection_formats: Dict[str, str] = {
835
+ }
836
+
837
+ _path_params: Dict[str, str] = {}
838
+ _query_params: List[Tuple[str, str]] = []
839
+ _header_params: Dict[str, Optional[str]] = _headers or {}
840
+ _form_params: List[Tuple[str, str]] = []
841
+ _files: Dict[
842
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
843
+ ] = {}
844
+ _body_params: Optional[bytes] = None
845
+
846
+ # process the path parameters
847
+ if group_id is not None:
848
+ _path_params['group_id'] = group_id
849
+ # process the query parameters
850
+ # process the header parameters
851
+ # process the form parameters
852
+ # process the body parameter
853
+
854
+
855
+ # set the HTTP header `Accept`
856
+ if 'Accept' not in _header_params:
857
+ _header_params['Accept'] = self.api_client.select_header_accept(
858
+ [
859
+ 'application/json'
860
+ ]
861
+ )
862
+
863
+
864
+ # authentication setting
865
+ _auth_settings: List[str] = [
866
+ 'OAuth2AuthorizationCode'
867
+ ]
868
+
869
+ return self.api_client.param_serialize(
870
+ method='GET',
871
+ resource_path='/api/v1/groups/{group_id}',
872
+ path_params=_path_params,
873
+ query_params=_query_params,
874
+ header_params=_header_params,
875
+ body=_body_params,
876
+ post_params=_form_params,
877
+ files=_files,
878
+ auth_settings=_auth_settings,
879
+ collection_formats=_collection_formats,
880
+ _host=_host,
881
+ _request_auth=_request_auth
882
+ )
883
+
884
+
885
+
886
+
887
+ @validate_call
888
+ def get_group_users(
889
+ self,
890
+ group_id: StrictStr,
891
+ sort: Annotated[Optional[UserSort], Field(description="Override the field used for sorting the returned list. Optional.")] = None,
892
+ order: Annotated[Optional[SortOrder], Field(description="Override the sort order used. Optional.")] = None,
893
+ search: Annotated[Optional[StrictStr], Field(description="Search for users by name or email.")] = None,
894
+ page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="The page to return starting from 1 up to total_pages.")] = None,
895
+ page_size: Annotated[Optional[Annotated[int, Field(le=1000, strict=True, ge=1)]], Field(description="The number of records per page. The max is 1000.")] = None,
896
+ _request_timeout: Union[
897
+ None,
898
+ Annotated[StrictFloat, Field(gt=0)],
899
+ Tuple[
900
+ Annotated[StrictFloat, Field(gt=0)],
901
+ Annotated[StrictFloat, Field(gt=0)]
902
+ ]
903
+ ] = None,
904
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
905
+ _content_type: Optional[StrictStr] = None,
906
+ _headers: Optional[Dict[StrictStr, Any]] = None,
907
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
908
+ ) -> ResourceListUser:
909
+ """Get Group Users
910
+
911
+ Fetches group users by group ID. Requires group_list_users permission.
912
+
913
+ :param group_id: (required)
914
+ :type group_id: str
915
+ :param sort: Override the field used for sorting the returned list. Optional.
916
+ :type sort: UserSort
917
+ :param order: Override the sort order used. Optional.
918
+ :type order: SortOrder
919
+ :param search: Search for users by name or email.
920
+ :type search: str
921
+ :param page: The page to return starting from 1 up to total_pages.
922
+ :type page: int
923
+ :param page_size: The number of records per page. The max is 1000.
924
+ :type page_size: int
925
+ :param _request_timeout: timeout setting for this request. If one
926
+ number provided, it will be total request
927
+ timeout. It can also be a pair (tuple) of
928
+ (connection, read) timeouts.
929
+ :type _request_timeout: int, tuple(int, int), optional
930
+ :param _request_auth: set to override the auth_settings for an a single
931
+ request; this effectively ignores the
932
+ authentication in the spec for a single request.
933
+ :type _request_auth: dict, optional
934
+ :param _content_type: force content-type for the request.
935
+ :type _content_type: str, Optional
936
+ :param _headers: set to override the headers for a single
937
+ request; this effectively ignores the headers
938
+ in the spec for a single request.
939
+ :type _headers: dict, optional
940
+ :param _host_index: set to override the host_index for a single
941
+ request; this effectively ignores the host_index
942
+ in the spec for a single request.
943
+ :type _host_index: int, optional
944
+ :return: Returns the result object.
945
+ """ # noqa: E501
946
+
947
+ _param = self._get_group_users_serialize(
948
+ group_id=group_id,
949
+ sort=sort,
950
+ order=order,
951
+ search=search,
952
+ page=page,
953
+ page_size=page_size,
954
+ _request_auth=_request_auth,
955
+ _content_type=_content_type,
956
+ _headers=_headers,
957
+ _host_index=_host_index
958
+ )
959
+
960
+ _response_types_map: Dict[str, Optional[str]] = {
961
+ '200': "ResourceListUser",
962
+ '500': "InternalServerError",
963
+ '404': "NotFoundError",
964
+ '422': "HTTPValidationError",
965
+ }
966
+ response_data = self.api_client.call_api(
967
+ *_param,
968
+ _request_timeout=_request_timeout
969
+ )
970
+ response_data.read()
971
+ return self.api_client.response_deserialize(
972
+ response_data=response_data,
973
+ response_types_map=_response_types_map,
974
+ ).data
975
+
976
+
977
+ @validate_call
978
+ def get_group_users_with_http_info(
979
+ self,
980
+ group_id: StrictStr,
981
+ sort: Annotated[Optional[UserSort], Field(description="Override the field used for sorting the returned list. Optional.")] = None,
982
+ order: Annotated[Optional[SortOrder], Field(description="Override the sort order used. Optional.")] = None,
983
+ search: Annotated[Optional[StrictStr], Field(description="Search for users by name or email.")] = None,
984
+ page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="The page to return starting from 1 up to total_pages.")] = None,
985
+ page_size: Annotated[Optional[Annotated[int, Field(le=1000, strict=True, ge=1)]], Field(description="The number of records per page. The max is 1000.")] = None,
986
+ _request_timeout: Union[
987
+ None,
988
+ Annotated[StrictFloat, Field(gt=0)],
989
+ Tuple[
990
+ Annotated[StrictFloat, Field(gt=0)],
991
+ Annotated[StrictFloat, Field(gt=0)]
992
+ ]
993
+ ] = None,
994
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
995
+ _content_type: Optional[StrictStr] = None,
996
+ _headers: Optional[Dict[StrictStr, Any]] = None,
997
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
998
+ ) -> ApiResponse[ResourceListUser]:
999
+ """Get Group Users
1000
+
1001
+ Fetches group users by group ID. Requires group_list_users permission.
1002
+
1003
+ :param group_id: (required)
1004
+ :type group_id: str
1005
+ :param sort: Override the field used for sorting the returned list. Optional.
1006
+ :type sort: UserSort
1007
+ :param order: Override the sort order used. Optional.
1008
+ :type order: SortOrder
1009
+ :param search: Search for users by name or email.
1010
+ :type search: str
1011
+ :param page: The page to return starting from 1 up to total_pages.
1012
+ :type page: int
1013
+ :param page_size: The number of records per page. The max is 1000.
1014
+ :type page_size: int
1015
+ :param _request_timeout: timeout setting for this request. If one
1016
+ number provided, it will be total request
1017
+ timeout. It can also be a pair (tuple) of
1018
+ (connection, read) timeouts.
1019
+ :type _request_timeout: int, tuple(int, int), optional
1020
+ :param _request_auth: set to override the auth_settings for an a single
1021
+ request; this effectively ignores the
1022
+ authentication in the spec for a single request.
1023
+ :type _request_auth: dict, optional
1024
+ :param _content_type: force content-type for the request.
1025
+ :type _content_type: str, Optional
1026
+ :param _headers: set to override the headers for a single
1027
+ request; this effectively ignores the headers
1028
+ in the spec for a single request.
1029
+ :type _headers: dict, optional
1030
+ :param _host_index: set to override the host_index for a single
1031
+ request; this effectively ignores the host_index
1032
+ in the spec for a single request.
1033
+ :type _host_index: int, optional
1034
+ :return: Returns the result object.
1035
+ """ # noqa: E501
1036
+
1037
+ _param = self._get_group_users_serialize(
1038
+ group_id=group_id,
1039
+ sort=sort,
1040
+ order=order,
1041
+ search=search,
1042
+ page=page,
1043
+ page_size=page_size,
1044
+ _request_auth=_request_auth,
1045
+ _content_type=_content_type,
1046
+ _headers=_headers,
1047
+ _host_index=_host_index
1048
+ )
1049
+
1050
+ _response_types_map: Dict[str, Optional[str]] = {
1051
+ '200': "ResourceListUser",
1052
+ '500': "InternalServerError",
1053
+ '404': "NotFoundError",
1054
+ '422': "HTTPValidationError",
1055
+ }
1056
+ response_data = self.api_client.call_api(
1057
+ *_param,
1058
+ _request_timeout=_request_timeout
1059
+ )
1060
+ response_data.read()
1061
+ return self.api_client.response_deserialize(
1062
+ response_data=response_data,
1063
+ response_types_map=_response_types_map,
1064
+ )
1065
+
1066
+
1067
+ @validate_call
1068
+ def get_group_users_without_preload_content(
1069
+ self,
1070
+ group_id: StrictStr,
1071
+ sort: Annotated[Optional[UserSort], Field(description="Override the field used for sorting the returned list. Optional.")] = None,
1072
+ order: Annotated[Optional[SortOrder], Field(description="Override the sort order used. Optional.")] = None,
1073
+ search: Annotated[Optional[StrictStr], Field(description="Search for users by name or email.")] = None,
1074
+ page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="The page to return starting from 1 up to total_pages.")] = None,
1075
+ page_size: Annotated[Optional[Annotated[int, Field(le=1000, strict=True, ge=1)]], Field(description="The number of records per page. The max is 1000.")] = None,
1076
+ _request_timeout: Union[
1077
+ None,
1078
+ Annotated[StrictFloat, Field(gt=0)],
1079
+ Tuple[
1080
+ Annotated[StrictFloat, Field(gt=0)],
1081
+ Annotated[StrictFloat, Field(gt=0)]
1082
+ ]
1083
+ ] = None,
1084
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1085
+ _content_type: Optional[StrictStr] = None,
1086
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1087
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1088
+ ) -> RESTResponseType:
1089
+ """Get Group Users
1090
+
1091
+ Fetches group users by group ID. Requires group_list_users permission.
1092
+
1093
+ :param group_id: (required)
1094
+ :type group_id: str
1095
+ :param sort: Override the field used for sorting the returned list. Optional.
1096
+ :type sort: UserSort
1097
+ :param order: Override the sort order used. Optional.
1098
+ :type order: SortOrder
1099
+ :param search: Search for users by name or email.
1100
+ :type search: str
1101
+ :param page: The page to return starting from 1 up to total_pages.
1102
+ :type page: int
1103
+ :param page_size: The number of records per page. The max is 1000.
1104
+ :type page_size: int
1105
+ :param _request_timeout: timeout setting for this request. If one
1106
+ number provided, it will be total request
1107
+ timeout. It can also be a pair (tuple) of
1108
+ (connection, read) timeouts.
1109
+ :type _request_timeout: int, tuple(int, int), optional
1110
+ :param _request_auth: set to override the auth_settings for an a single
1111
+ request; this effectively ignores the
1112
+ authentication in the spec for a single request.
1113
+ :type _request_auth: dict, optional
1114
+ :param _content_type: force content-type for the request.
1115
+ :type _content_type: str, Optional
1116
+ :param _headers: set to override the headers for a single
1117
+ request; this effectively ignores the headers
1118
+ in the spec for a single request.
1119
+ :type _headers: dict, optional
1120
+ :param _host_index: set to override the host_index for a single
1121
+ request; this effectively ignores the host_index
1122
+ in the spec for a single request.
1123
+ :type _host_index: int, optional
1124
+ :return: Returns the result object.
1125
+ """ # noqa: E501
1126
+
1127
+ _param = self._get_group_users_serialize(
1128
+ group_id=group_id,
1129
+ sort=sort,
1130
+ order=order,
1131
+ search=search,
1132
+ page=page,
1133
+ page_size=page_size,
1134
+ _request_auth=_request_auth,
1135
+ _content_type=_content_type,
1136
+ _headers=_headers,
1137
+ _host_index=_host_index
1138
+ )
1139
+
1140
+ _response_types_map: Dict[str, Optional[str]] = {
1141
+ '200': "ResourceListUser",
1142
+ '500': "InternalServerError",
1143
+ '404': "NotFoundError",
1144
+ '422': "HTTPValidationError",
1145
+ }
1146
+ response_data = self.api_client.call_api(
1147
+ *_param,
1148
+ _request_timeout=_request_timeout
1149
+ )
1150
+ return response_data.response
1151
+
1152
+
1153
+ def _get_group_users_serialize(
1154
+ self,
1155
+ group_id,
1156
+ sort,
1157
+ order,
1158
+ search,
1159
+ page,
1160
+ page_size,
1161
+ _request_auth,
1162
+ _content_type,
1163
+ _headers,
1164
+ _host_index,
1165
+ ) -> RequestSerialized:
1166
+
1167
+ _host = None
1168
+
1169
+ _collection_formats: Dict[str, str] = {
1170
+ }
1171
+
1172
+ _path_params: Dict[str, str] = {}
1173
+ _query_params: List[Tuple[str, str]] = []
1174
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1175
+ _form_params: List[Tuple[str, str]] = []
1176
+ _files: Dict[
1177
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1178
+ ] = {}
1179
+ _body_params: Optional[bytes] = None
1180
+
1181
+ # process the path parameters
1182
+ if group_id is not None:
1183
+ _path_params['group_id'] = group_id
1184
+ # process the query parameters
1185
+ if sort is not None:
1186
+
1187
+ _query_params.append(('sort', sort.value))
1188
+
1189
+ if order is not None:
1190
+
1191
+ _query_params.append(('order', order.value))
1192
+
1193
+ if search is not None:
1194
+
1195
+ _query_params.append(('search', search))
1196
+
1197
+ if page is not None:
1198
+
1199
+ _query_params.append(('page', page))
1200
+
1201
+ if page_size is not None:
1202
+
1203
+ _query_params.append(('page_size', page_size))
1204
+
1205
+ # process the header parameters
1206
+ # process the form parameters
1207
+ # process the body parameter
1208
+
1209
+
1210
+ # set the HTTP header `Accept`
1211
+ if 'Accept' not in _header_params:
1212
+ _header_params['Accept'] = self.api_client.select_header_accept(
1213
+ [
1214
+ 'application/json'
1215
+ ]
1216
+ )
1217
+
1218
+
1219
+ # authentication setting
1220
+ _auth_settings: List[str] = [
1221
+ 'OAuth2AuthorizationCode'
1222
+ ]
1223
+
1224
+ return self.api_client.param_serialize(
1225
+ method='GET',
1226
+ resource_path='/api/v1/groups/{group_id}/users',
1227
+ path_params=_path_params,
1228
+ query_params=_query_params,
1229
+ header_params=_header_params,
1230
+ body=_body_params,
1231
+ post_params=_form_params,
1232
+ files=_files,
1233
+ auth_settings=_auth_settings,
1234
+ collection_formats=_collection_formats,
1235
+ _host=_host,
1236
+ _request_auth=_request_auth
1237
+ )
1238
+
1239
+
1240
+
1241
+
1242
+ @validate_call
1243
+ def get_groups(
1244
+ self,
1245
+ sort: Annotated[Optional[GroupSort], Field(description="Override the field used for sorting. Optional.")] = None,
1246
+ order: Annotated[Optional[SortOrder], Field(description="Override the sort order of the returned list. Optional.")] = None,
1247
+ name: Annotated[Optional[StrictStr], Field(description="Filter the list of groups by name. Optional.")] = None,
1248
+ page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="The page to return starting from 1 up to total_pages.")] = None,
1249
+ page_size: Annotated[Optional[Annotated[int, Field(le=1000, strict=True, ge=1)]], Field(description="The number of records per page. The max is 1000.")] = None,
1250
+ _request_timeout: Union[
1251
+ None,
1252
+ Annotated[StrictFloat, Field(gt=0)],
1253
+ Tuple[
1254
+ Annotated[StrictFloat, Field(gt=0)],
1255
+ Annotated[StrictFloat, Field(gt=0)]
1256
+ ]
1257
+ ] = None,
1258
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1259
+ _content_type: Optional[StrictStr] = None,
1260
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1261
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1262
+ ) -> ResourceListGroup:
1263
+ """List Groups
1264
+
1265
+ Fetches all groups. Requires organization_list_groups permission.
1266
+
1267
+ :param sort: Override the field used for sorting. Optional.
1268
+ :type sort: GroupSort
1269
+ :param order: Override the sort order of the returned list. Optional.
1270
+ :type order: SortOrder
1271
+ :param name: Filter the list of groups by name. Optional.
1272
+ :type name: str
1273
+ :param page: The page to return starting from 1 up to total_pages.
1274
+ :type page: int
1275
+ :param page_size: The number of records per page. The max is 1000.
1276
+ :type page_size: int
1277
+ :param _request_timeout: timeout setting for this request. If one
1278
+ number provided, it will be total request
1279
+ timeout. It can also be a pair (tuple) of
1280
+ (connection, read) timeouts.
1281
+ :type _request_timeout: int, tuple(int, int), optional
1282
+ :param _request_auth: set to override the auth_settings for an a single
1283
+ request; this effectively ignores the
1284
+ authentication in the spec for a single request.
1285
+ :type _request_auth: dict, optional
1286
+ :param _content_type: force content-type for the request.
1287
+ :type _content_type: str, Optional
1288
+ :param _headers: set to override the headers for a single
1289
+ request; this effectively ignores the headers
1290
+ in the spec for a single request.
1291
+ :type _headers: dict, optional
1292
+ :param _host_index: set to override the host_index for a single
1293
+ request; this effectively ignores the host_index
1294
+ in the spec for a single request.
1295
+ :type _host_index: int, optional
1296
+ :return: Returns the result object.
1297
+ """ # noqa: E501
1298
+
1299
+ _param = self._get_groups_serialize(
1300
+ sort=sort,
1301
+ order=order,
1302
+ name=name,
1303
+ page=page,
1304
+ page_size=page_size,
1305
+ _request_auth=_request_auth,
1306
+ _content_type=_content_type,
1307
+ _headers=_headers,
1308
+ _host_index=_host_index
1309
+ )
1310
+
1311
+ _response_types_map: Dict[str, Optional[str]] = {
1312
+ '200': "ResourceListGroup",
1313
+ '500': "InternalServerError",
1314
+ '404': "NotFoundError",
1315
+ '422': "HTTPValidationError",
1316
+ }
1317
+ response_data = self.api_client.call_api(
1318
+ *_param,
1319
+ _request_timeout=_request_timeout
1320
+ )
1321
+ response_data.read()
1322
+ return self.api_client.response_deserialize(
1323
+ response_data=response_data,
1324
+ response_types_map=_response_types_map,
1325
+ ).data
1326
+
1327
+
1328
+ @validate_call
1329
+ def get_groups_with_http_info(
1330
+ self,
1331
+ sort: Annotated[Optional[GroupSort], Field(description="Override the field used for sorting. Optional.")] = None,
1332
+ order: Annotated[Optional[SortOrder], Field(description="Override the sort order of the returned list. Optional.")] = None,
1333
+ name: Annotated[Optional[StrictStr], Field(description="Filter the list of groups by name. Optional.")] = None,
1334
+ page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="The page to return starting from 1 up to total_pages.")] = None,
1335
+ page_size: Annotated[Optional[Annotated[int, Field(le=1000, strict=True, ge=1)]], Field(description="The number of records per page. The max is 1000.")] = None,
1336
+ _request_timeout: Union[
1337
+ None,
1338
+ Annotated[StrictFloat, Field(gt=0)],
1339
+ Tuple[
1340
+ Annotated[StrictFloat, Field(gt=0)],
1341
+ Annotated[StrictFloat, Field(gt=0)]
1342
+ ]
1343
+ ] = None,
1344
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1345
+ _content_type: Optional[StrictStr] = None,
1346
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1347
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1348
+ ) -> ApiResponse[ResourceListGroup]:
1349
+ """List Groups
1350
+
1351
+ Fetches all groups. Requires organization_list_groups permission.
1352
+
1353
+ :param sort: Override the field used for sorting. Optional.
1354
+ :type sort: GroupSort
1355
+ :param order: Override the sort order of the returned list. Optional.
1356
+ :type order: SortOrder
1357
+ :param name: Filter the list of groups by name. Optional.
1358
+ :type name: str
1359
+ :param page: The page to return starting from 1 up to total_pages.
1360
+ :type page: int
1361
+ :param page_size: The number of records per page. The max is 1000.
1362
+ :type page_size: int
1363
+ :param _request_timeout: timeout setting for this request. If one
1364
+ number provided, it will be total request
1365
+ timeout. It can also be a pair (tuple) of
1366
+ (connection, read) timeouts.
1367
+ :type _request_timeout: int, tuple(int, int), optional
1368
+ :param _request_auth: set to override the auth_settings for an a single
1369
+ request; this effectively ignores the
1370
+ authentication in the spec for a single request.
1371
+ :type _request_auth: dict, optional
1372
+ :param _content_type: force content-type for the request.
1373
+ :type _content_type: str, Optional
1374
+ :param _headers: set to override the headers for a single
1375
+ request; this effectively ignores the headers
1376
+ in the spec for a single request.
1377
+ :type _headers: dict, optional
1378
+ :param _host_index: set to override the host_index for a single
1379
+ request; this effectively ignores the host_index
1380
+ in the spec for a single request.
1381
+ :type _host_index: int, optional
1382
+ :return: Returns the result object.
1383
+ """ # noqa: E501
1384
+
1385
+ _param = self._get_groups_serialize(
1386
+ sort=sort,
1387
+ order=order,
1388
+ name=name,
1389
+ page=page,
1390
+ page_size=page_size,
1391
+ _request_auth=_request_auth,
1392
+ _content_type=_content_type,
1393
+ _headers=_headers,
1394
+ _host_index=_host_index
1395
+ )
1396
+
1397
+ _response_types_map: Dict[str, Optional[str]] = {
1398
+ '200': "ResourceListGroup",
1399
+ '500': "InternalServerError",
1400
+ '404': "NotFoundError",
1401
+ '422': "HTTPValidationError",
1402
+ }
1403
+ response_data = self.api_client.call_api(
1404
+ *_param,
1405
+ _request_timeout=_request_timeout
1406
+ )
1407
+ response_data.read()
1408
+ return self.api_client.response_deserialize(
1409
+ response_data=response_data,
1410
+ response_types_map=_response_types_map,
1411
+ )
1412
+
1413
+
1414
+ @validate_call
1415
+ def get_groups_without_preload_content(
1416
+ self,
1417
+ sort: Annotated[Optional[GroupSort], Field(description="Override the field used for sorting. Optional.")] = None,
1418
+ order: Annotated[Optional[SortOrder], Field(description="Override the sort order of the returned list. Optional.")] = None,
1419
+ name: Annotated[Optional[StrictStr], Field(description="Filter the list of groups by name. Optional.")] = None,
1420
+ page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="The page to return starting from 1 up to total_pages.")] = None,
1421
+ page_size: Annotated[Optional[Annotated[int, Field(le=1000, strict=True, ge=1)]], Field(description="The number of records per page. The max is 1000.")] = None,
1422
+ _request_timeout: Union[
1423
+ None,
1424
+ Annotated[StrictFloat, Field(gt=0)],
1425
+ Tuple[
1426
+ Annotated[StrictFloat, Field(gt=0)],
1427
+ Annotated[StrictFloat, Field(gt=0)]
1428
+ ]
1429
+ ] = None,
1430
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1431
+ _content_type: Optional[StrictStr] = None,
1432
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1433
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1434
+ ) -> RESTResponseType:
1435
+ """List Groups
1436
+
1437
+ Fetches all groups. Requires organization_list_groups permission.
1438
+
1439
+ :param sort: Override the field used for sorting. Optional.
1440
+ :type sort: GroupSort
1441
+ :param order: Override the sort order of the returned list. Optional.
1442
+ :type order: SortOrder
1443
+ :param name: Filter the list of groups by name. Optional.
1444
+ :type name: str
1445
+ :param page: The page to return starting from 1 up to total_pages.
1446
+ :type page: int
1447
+ :param page_size: The number of records per page. The max is 1000.
1448
+ :type page_size: int
1449
+ :param _request_timeout: timeout setting for this request. If one
1450
+ number provided, it will be total request
1451
+ timeout. It can also be a pair (tuple) of
1452
+ (connection, read) timeouts.
1453
+ :type _request_timeout: int, tuple(int, int), optional
1454
+ :param _request_auth: set to override the auth_settings for an a single
1455
+ request; this effectively ignores the
1456
+ authentication in the spec for a single request.
1457
+ :type _request_auth: dict, optional
1458
+ :param _content_type: force content-type for the request.
1459
+ :type _content_type: str, Optional
1460
+ :param _headers: set to override the headers for a single
1461
+ request; this effectively ignores the headers
1462
+ in the spec for a single request.
1463
+ :type _headers: dict, optional
1464
+ :param _host_index: set to override the host_index for a single
1465
+ request; this effectively ignores the host_index
1466
+ in the spec for a single request.
1467
+ :type _host_index: int, optional
1468
+ :return: Returns the result object.
1469
+ """ # noqa: E501
1470
+
1471
+ _param = self._get_groups_serialize(
1472
+ sort=sort,
1473
+ order=order,
1474
+ name=name,
1475
+ page=page,
1476
+ page_size=page_size,
1477
+ _request_auth=_request_auth,
1478
+ _content_type=_content_type,
1479
+ _headers=_headers,
1480
+ _host_index=_host_index
1481
+ )
1482
+
1483
+ _response_types_map: Dict[str, Optional[str]] = {
1484
+ '200': "ResourceListGroup",
1485
+ '500': "InternalServerError",
1486
+ '404': "NotFoundError",
1487
+ '422': "HTTPValidationError",
1488
+ }
1489
+ response_data = self.api_client.call_api(
1490
+ *_param,
1491
+ _request_timeout=_request_timeout
1492
+ )
1493
+ return response_data.response
1494
+
1495
+
1496
+ def _get_groups_serialize(
1497
+ self,
1498
+ sort,
1499
+ order,
1500
+ name,
1501
+ page,
1502
+ page_size,
1503
+ _request_auth,
1504
+ _content_type,
1505
+ _headers,
1506
+ _host_index,
1507
+ ) -> RequestSerialized:
1508
+
1509
+ _host = None
1510
+
1511
+ _collection_formats: Dict[str, str] = {
1512
+ }
1513
+
1514
+ _path_params: Dict[str, str] = {}
1515
+ _query_params: List[Tuple[str, str]] = []
1516
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1517
+ _form_params: List[Tuple[str, str]] = []
1518
+ _files: Dict[
1519
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1520
+ ] = {}
1521
+ _body_params: Optional[bytes] = None
1522
+
1523
+ # process the path parameters
1524
+ # process the query parameters
1525
+ if sort is not None:
1526
+
1527
+ _query_params.append(('sort', sort.value))
1528
+
1529
+ if order is not None:
1530
+
1531
+ _query_params.append(('order', order.value))
1532
+
1533
+ if name is not None:
1534
+
1535
+ _query_params.append(('name', name))
1536
+
1537
+ if page is not None:
1538
+
1539
+ _query_params.append(('page', page))
1540
+
1541
+ if page_size is not None:
1542
+
1543
+ _query_params.append(('page_size', page_size))
1544
+
1545
+ # process the header parameters
1546
+ # process the form parameters
1547
+ # process the body parameter
1548
+
1549
+
1550
+ # set the HTTP header `Accept`
1551
+ if 'Accept' not in _header_params:
1552
+ _header_params['Accept'] = self.api_client.select_header_accept(
1553
+ [
1554
+ 'application/json'
1555
+ ]
1556
+ )
1557
+
1558
+
1559
+ # authentication setting
1560
+ _auth_settings: List[str] = [
1561
+ 'OAuth2AuthorizationCode'
1562
+ ]
1563
+
1564
+ return self.api_client.param_serialize(
1565
+ method='GET',
1566
+ resource_path='/api/v1/organization/groups',
1567
+ path_params=_path_params,
1568
+ query_params=_query_params,
1569
+ header_params=_header_params,
1570
+ body=_body_params,
1571
+ post_params=_form_params,
1572
+ files=_files,
1573
+ auth_settings=_auth_settings,
1574
+ collection_formats=_collection_formats,
1575
+ _host=_host,
1576
+ _request_auth=_request_auth
1577
+ )
1578
+
1579
+
1580
+
1581
+
1582
+ @validate_call
1583
+ def patch_group(
1584
+ self,
1585
+ group_id: StrictStr,
1586
+ patch_group: PatchGroup,
1587
+ _request_timeout: Union[
1588
+ None,
1589
+ Annotated[StrictFloat, Field(gt=0)],
1590
+ Tuple[
1591
+ Annotated[StrictFloat, Field(gt=0)],
1592
+ Annotated[StrictFloat, Field(gt=0)]
1593
+ ]
1594
+ ] = None,
1595
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1596
+ _content_type: Optional[StrictStr] = None,
1597
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1598
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1599
+ ) -> Group:
1600
+ """Update Group
1601
+
1602
+ Updates group by ID. Requires group_update permission.
1603
+
1604
+ :param group_id: (required)
1605
+ :type group_id: str
1606
+ :param patch_group: (required)
1607
+ :type patch_group: PatchGroup
1608
+ :param _request_timeout: timeout setting for this request. If one
1609
+ number provided, it will be total request
1610
+ timeout. It can also be a pair (tuple) of
1611
+ (connection, read) timeouts.
1612
+ :type _request_timeout: int, tuple(int, int), optional
1613
+ :param _request_auth: set to override the auth_settings for an a single
1614
+ request; this effectively ignores the
1615
+ authentication in the spec for a single request.
1616
+ :type _request_auth: dict, optional
1617
+ :param _content_type: force content-type for the request.
1618
+ :type _content_type: str, Optional
1619
+ :param _headers: set to override the headers for a single
1620
+ request; this effectively ignores the headers
1621
+ in the spec for a single request.
1622
+ :type _headers: dict, optional
1623
+ :param _host_index: set to override the host_index for a single
1624
+ request; this effectively ignores the host_index
1625
+ in the spec for a single request.
1626
+ :type _host_index: int, optional
1627
+ :return: Returns the result object.
1628
+ """ # noqa: E501
1629
+
1630
+ _param = self._patch_group_serialize(
1631
+ group_id=group_id,
1632
+ patch_group=patch_group,
1633
+ _request_auth=_request_auth,
1634
+ _content_type=_content_type,
1635
+ _headers=_headers,
1636
+ _host_index=_host_index
1637
+ )
1638
+
1639
+ _response_types_map: Dict[str, Optional[str]] = {
1640
+ '200': "Group",
1641
+ '500': "InternalServerError",
1642
+ '404': "NotFoundError",
1643
+ '422': "HTTPValidationError",
1644
+ }
1645
+ response_data = self.api_client.call_api(
1646
+ *_param,
1647
+ _request_timeout=_request_timeout
1648
+ )
1649
+ response_data.read()
1650
+ return self.api_client.response_deserialize(
1651
+ response_data=response_data,
1652
+ response_types_map=_response_types_map,
1653
+ ).data
1654
+
1655
+
1656
+ @validate_call
1657
+ def patch_group_with_http_info(
1658
+ self,
1659
+ group_id: StrictStr,
1660
+ patch_group: PatchGroup,
1661
+ _request_timeout: Union[
1662
+ None,
1663
+ Annotated[StrictFloat, Field(gt=0)],
1664
+ Tuple[
1665
+ Annotated[StrictFloat, Field(gt=0)],
1666
+ Annotated[StrictFloat, Field(gt=0)]
1667
+ ]
1668
+ ] = None,
1669
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1670
+ _content_type: Optional[StrictStr] = None,
1671
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1672
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1673
+ ) -> ApiResponse[Group]:
1674
+ """Update Group
1675
+
1676
+ Updates group by ID. Requires group_update permission.
1677
+
1678
+ :param group_id: (required)
1679
+ :type group_id: str
1680
+ :param patch_group: (required)
1681
+ :type patch_group: PatchGroup
1682
+ :param _request_timeout: timeout setting for this request. If one
1683
+ number provided, it will be total request
1684
+ timeout. It can also be a pair (tuple) of
1685
+ (connection, read) timeouts.
1686
+ :type _request_timeout: int, tuple(int, int), optional
1687
+ :param _request_auth: set to override the auth_settings for an a single
1688
+ request; this effectively ignores the
1689
+ authentication in the spec for a single request.
1690
+ :type _request_auth: dict, optional
1691
+ :param _content_type: force content-type for the request.
1692
+ :type _content_type: str, Optional
1693
+ :param _headers: set to override the headers for a single
1694
+ request; this effectively ignores the headers
1695
+ in the spec for a single request.
1696
+ :type _headers: dict, optional
1697
+ :param _host_index: set to override the host_index for a single
1698
+ request; this effectively ignores the host_index
1699
+ in the spec for a single request.
1700
+ :type _host_index: int, optional
1701
+ :return: Returns the result object.
1702
+ """ # noqa: E501
1703
+
1704
+ _param = self._patch_group_serialize(
1705
+ group_id=group_id,
1706
+ patch_group=patch_group,
1707
+ _request_auth=_request_auth,
1708
+ _content_type=_content_type,
1709
+ _headers=_headers,
1710
+ _host_index=_host_index
1711
+ )
1712
+
1713
+ _response_types_map: Dict[str, Optional[str]] = {
1714
+ '200': "Group",
1715
+ '500': "InternalServerError",
1716
+ '404': "NotFoundError",
1717
+ '422': "HTTPValidationError",
1718
+ }
1719
+ response_data = self.api_client.call_api(
1720
+ *_param,
1721
+ _request_timeout=_request_timeout
1722
+ )
1723
+ response_data.read()
1724
+ return self.api_client.response_deserialize(
1725
+ response_data=response_data,
1726
+ response_types_map=_response_types_map,
1727
+ )
1728
+
1729
+
1730
+ @validate_call
1731
+ def patch_group_without_preload_content(
1732
+ self,
1733
+ group_id: StrictStr,
1734
+ patch_group: PatchGroup,
1735
+ _request_timeout: Union[
1736
+ None,
1737
+ Annotated[StrictFloat, Field(gt=0)],
1738
+ Tuple[
1739
+ Annotated[StrictFloat, Field(gt=0)],
1740
+ Annotated[StrictFloat, Field(gt=0)]
1741
+ ]
1742
+ ] = None,
1743
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1744
+ _content_type: Optional[StrictStr] = None,
1745
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1746
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1747
+ ) -> RESTResponseType:
1748
+ """Update Group
1749
+
1750
+ Updates group by ID. Requires group_update permission.
1751
+
1752
+ :param group_id: (required)
1753
+ :type group_id: str
1754
+ :param patch_group: (required)
1755
+ :type patch_group: PatchGroup
1756
+ :param _request_timeout: timeout setting for this request. If one
1757
+ number provided, it will be total request
1758
+ timeout. It can also be a pair (tuple) of
1759
+ (connection, read) timeouts.
1760
+ :type _request_timeout: int, tuple(int, int), optional
1761
+ :param _request_auth: set to override the auth_settings for an a single
1762
+ request; this effectively ignores the
1763
+ authentication in the spec for a single request.
1764
+ :type _request_auth: dict, optional
1765
+ :param _content_type: force content-type for the request.
1766
+ :type _content_type: str, Optional
1767
+ :param _headers: set to override the headers for a single
1768
+ request; this effectively ignores the headers
1769
+ in the spec for a single request.
1770
+ :type _headers: dict, optional
1771
+ :param _host_index: set to override the host_index for a single
1772
+ request; this effectively ignores the host_index
1773
+ in the spec for a single request.
1774
+ :type _host_index: int, optional
1775
+ :return: Returns the result object.
1776
+ """ # noqa: E501
1777
+
1778
+ _param = self._patch_group_serialize(
1779
+ group_id=group_id,
1780
+ patch_group=patch_group,
1781
+ _request_auth=_request_auth,
1782
+ _content_type=_content_type,
1783
+ _headers=_headers,
1784
+ _host_index=_host_index
1785
+ )
1786
+
1787
+ _response_types_map: Dict[str, Optional[str]] = {
1788
+ '200': "Group",
1789
+ '500': "InternalServerError",
1790
+ '404': "NotFoundError",
1791
+ '422': "HTTPValidationError",
1792
+ }
1793
+ response_data = self.api_client.call_api(
1794
+ *_param,
1795
+ _request_timeout=_request_timeout
1796
+ )
1797
+ return response_data.response
1798
+
1799
+
1800
+ def _patch_group_serialize(
1801
+ self,
1802
+ group_id,
1803
+ patch_group,
1804
+ _request_auth,
1805
+ _content_type,
1806
+ _headers,
1807
+ _host_index,
1808
+ ) -> RequestSerialized:
1809
+
1810
+ _host = None
1811
+
1812
+ _collection_formats: Dict[str, str] = {
1813
+ }
1814
+
1815
+ _path_params: Dict[str, str] = {}
1816
+ _query_params: List[Tuple[str, str]] = []
1817
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1818
+ _form_params: List[Tuple[str, str]] = []
1819
+ _files: Dict[
1820
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1821
+ ] = {}
1822
+ _body_params: Optional[bytes] = None
1823
+
1824
+ # process the path parameters
1825
+ if group_id is not None:
1826
+ _path_params['group_id'] = group_id
1827
+ # process the query parameters
1828
+ # process the header parameters
1829
+ # process the form parameters
1830
+ # process the body parameter
1831
+ if patch_group is not None:
1832
+ _body_params = patch_group
1833
+
1834
+
1835
+ # set the HTTP header `Accept`
1836
+ if 'Accept' not in _header_params:
1837
+ _header_params['Accept'] = self.api_client.select_header_accept(
1838
+ [
1839
+ 'application/json'
1840
+ ]
1841
+ )
1842
+
1843
+ # set the HTTP header `Content-Type`
1844
+ if _content_type:
1845
+ _header_params['Content-Type'] = _content_type
1846
+ else:
1847
+ _default_content_type = (
1848
+ self.api_client.select_header_content_type(
1849
+ [
1850
+ 'application/json'
1851
+ ]
1852
+ )
1853
+ )
1854
+ if _default_content_type is not None:
1855
+ _header_params['Content-Type'] = _default_content_type
1856
+
1857
+ # authentication setting
1858
+ _auth_settings: List[str] = [
1859
+ 'OAuth2AuthorizationCode'
1860
+ ]
1861
+
1862
+ return self.api_client.param_serialize(
1863
+ method='PATCH',
1864
+ resource_path='/api/v1/groups/{group_id}',
1865
+ path_params=_path_params,
1866
+ query_params=_query_params,
1867
+ header_params=_header_params,
1868
+ body=_body_params,
1869
+ post_params=_form_params,
1870
+ files=_files,
1871
+ auth_settings=_auth_settings,
1872
+ collection_formats=_collection_formats,
1873
+ _host=_host,
1874
+ _request_auth=_request_auth
1875
+ )
1876
+
1877
+
1878
+
1879
+
1880
+ @validate_call
1881
+ def post_group(
1882
+ self,
1883
+ post_group: PostGroup,
1884
+ _request_timeout: Union[
1885
+ None,
1886
+ Annotated[StrictFloat, Field(gt=0)],
1887
+ Tuple[
1888
+ Annotated[StrictFloat, Field(gt=0)],
1889
+ Annotated[StrictFloat, Field(gt=0)]
1890
+ ]
1891
+ ] = None,
1892
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1893
+ _content_type: Optional[StrictStr] = None,
1894
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1895
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1896
+ ) -> Group:
1897
+ """Create Group
1898
+
1899
+ Requires organization_create_group permission.
1900
+
1901
+ :param post_group: (required)
1902
+ :type post_group: PostGroup
1903
+ :param _request_timeout: timeout setting for this request. If one
1904
+ number provided, it will be total request
1905
+ timeout. It can also be a pair (tuple) of
1906
+ (connection, read) timeouts.
1907
+ :type _request_timeout: int, tuple(int, int), optional
1908
+ :param _request_auth: set to override the auth_settings for an a single
1909
+ request; this effectively ignores the
1910
+ authentication in the spec for a single request.
1911
+ :type _request_auth: dict, optional
1912
+ :param _content_type: force content-type for the request.
1913
+ :type _content_type: str, Optional
1914
+ :param _headers: set to override the headers for a single
1915
+ request; this effectively ignores the headers
1916
+ in the spec for a single request.
1917
+ :type _headers: dict, optional
1918
+ :param _host_index: set to override the host_index for a single
1919
+ request; this effectively ignores the host_index
1920
+ in the spec for a single request.
1921
+ :type _host_index: int, optional
1922
+ :return: Returns the result object.
1923
+ """ # noqa: E501
1924
+
1925
+ _param = self._post_group_serialize(
1926
+ post_group=post_group,
1927
+ _request_auth=_request_auth,
1928
+ _content_type=_content_type,
1929
+ _headers=_headers,
1930
+ _host_index=_host_index
1931
+ )
1932
+
1933
+ _response_types_map: Dict[str, Optional[str]] = {
1934
+ '200': "Group",
1935
+ '500': "InternalServerError",
1936
+ '400': "BadRequestError",
1937
+ '404': "NotFoundError",
1938
+ '422': "HTTPValidationError",
1939
+ }
1940
+ response_data = self.api_client.call_api(
1941
+ *_param,
1942
+ _request_timeout=_request_timeout
1943
+ )
1944
+ response_data.read()
1945
+ return self.api_client.response_deserialize(
1946
+ response_data=response_data,
1947
+ response_types_map=_response_types_map,
1948
+ ).data
1949
+
1950
+
1951
+ @validate_call
1952
+ def post_group_with_http_info(
1953
+ self,
1954
+ post_group: PostGroup,
1955
+ _request_timeout: Union[
1956
+ None,
1957
+ Annotated[StrictFloat, Field(gt=0)],
1958
+ Tuple[
1959
+ Annotated[StrictFloat, Field(gt=0)],
1960
+ Annotated[StrictFloat, Field(gt=0)]
1961
+ ]
1962
+ ] = None,
1963
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1964
+ _content_type: Optional[StrictStr] = None,
1965
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1966
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1967
+ ) -> ApiResponse[Group]:
1968
+ """Create Group
1969
+
1970
+ Requires organization_create_group permission.
1971
+
1972
+ :param post_group: (required)
1973
+ :type post_group: PostGroup
1974
+ :param _request_timeout: timeout setting for this request. If one
1975
+ number provided, it will be total request
1976
+ timeout. It can also be a pair (tuple) of
1977
+ (connection, read) timeouts.
1978
+ :type _request_timeout: int, tuple(int, int), optional
1979
+ :param _request_auth: set to override the auth_settings for an a single
1980
+ request; this effectively ignores the
1981
+ authentication in the spec for a single request.
1982
+ :type _request_auth: dict, optional
1983
+ :param _content_type: force content-type for the request.
1984
+ :type _content_type: str, Optional
1985
+ :param _headers: set to override the headers for a single
1986
+ request; this effectively ignores the headers
1987
+ in the spec for a single request.
1988
+ :type _headers: dict, optional
1989
+ :param _host_index: set to override the host_index for a single
1990
+ request; this effectively ignores the host_index
1991
+ in the spec for a single request.
1992
+ :type _host_index: int, optional
1993
+ :return: Returns the result object.
1994
+ """ # noqa: E501
1995
+
1996
+ _param = self._post_group_serialize(
1997
+ post_group=post_group,
1998
+ _request_auth=_request_auth,
1999
+ _content_type=_content_type,
2000
+ _headers=_headers,
2001
+ _host_index=_host_index
2002
+ )
2003
+
2004
+ _response_types_map: Dict[str, Optional[str]] = {
2005
+ '200': "Group",
2006
+ '500': "InternalServerError",
2007
+ '400': "BadRequestError",
2008
+ '404': "NotFoundError",
2009
+ '422': "HTTPValidationError",
2010
+ }
2011
+ response_data = self.api_client.call_api(
2012
+ *_param,
2013
+ _request_timeout=_request_timeout
2014
+ )
2015
+ response_data.read()
2016
+ return self.api_client.response_deserialize(
2017
+ response_data=response_data,
2018
+ response_types_map=_response_types_map,
2019
+ )
2020
+
2021
+
2022
+ @validate_call
2023
+ def post_group_without_preload_content(
2024
+ self,
2025
+ post_group: PostGroup,
2026
+ _request_timeout: Union[
2027
+ None,
2028
+ Annotated[StrictFloat, Field(gt=0)],
2029
+ Tuple[
2030
+ Annotated[StrictFloat, Field(gt=0)],
2031
+ Annotated[StrictFloat, Field(gt=0)]
2032
+ ]
2033
+ ] = None,
2034
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2035
+ _content_type: Optional[StrictStr] = None,
2036
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2037
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2038
+ ) -> RESTResponseType:
2039
+ """Create Group
2040
+
2041
+ Requires organization_create_group permission.
2042
+
2043
+ :param post_group: (required)
2044
+ :type post_group: PostGroup
2045
+ :param _request_timeout: timeout setting for this request. If one
2046
+ number provided, it will be total request
2047
+ timeout. It can also be a pair (tuple) of
2048
+ (connection, read) timeouts.
2049
+ :type _request_timeout: int, tuple(int, int), optional
2050
+ :param _request_auth: set to override the auth_settings for an a single
2051
+ request; this effectively ignores the
2052
+ authentication in the spec for a single request.
2053
+ :type _request_auth: dict, optional
2054
+ :param _content_type: force content-type for the request.
2055
+ :type _content_type: str, Optional
2056
+ :param _headers: set to override the headers for a single
2057
+ request; this effectively ignores the headers
2058
+ in the spec for a single request.
2059
+ :type _headers: dict, optional
2060
+ :param _host_index: set to override the host_index for a single
2061
+ request; this effectively ignores the host_index
2062
+ in the spec for a single request.
2063
+ :type _host_index: int, optional
2064
+ :return: Returns the result object.
2065
+ """ # noqa: E501
2066
+
2067
+ _param = self._post_group_serialize(
2068
+ post_group=post_group,
2069
+ _request_auth=_request_auth,
2070
+ _content_type=_content_type,
2071
+ _headers=_headers,
2072
+ _host_index=_host_index
2073
+ )
2074
+
2075
+ _response_types_map: Dict[str, Optional[str]] = {
2076
+ '200': "Group",
2077
+ '500': "InternalServerError",
2078
+ '400': "BadRequestError",
2079
+ '404': "NotFoundError",
2080
+ '422': "HTTPValidationError",
2081
+ }
2082
+ response_data = self.api_client.call_api(
2083
+ *_param,
2084
+ _request_timeout=_request_timeout
2085
+ )
2086
+ return response_data.response
2087
+
2088
+
2089
+ def _post_group_serialize(
2090
+ self,
2091
+ post_group,
2092
+ _request_auth,
2093
+ _content_type,
2094
+ _headers,
2095
+ _host_index,
2096
+ ) -> RequestSerialized:
2097
+
2098
+ _host = None
2099
+
2100
+ _collection_formats: Dict[str, str] = {
2101
+ }
2102
+
2103
+ _path_params: Dict[str, str] = {}
2104
+ _query_params: List[Tuple[str, str]] = []
2105
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2106
+ _form_params: List[Tuple[str, str]] = []
2107
+ _files: Dict[
2108
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2109
+ ] = {}
2110
+ _body_params: Optional[bytes] = None
2111
+
2112
+ # process the path parameters
2113
+ # process the query parameters
2114
+ # process the header parameters
2115
+ # process the form parameters
2116
+ # process the body parameter
2117
+ if post_group is not None:
2118
+ _body_params = post_group
2119
+
2120
+
2121
+ # set the HTTP header `Accept`
2122
+ if 'Accept' not in _header_params:
2123
+ _header_params['Accept'] = self.api_client.select_header_accept(
2124
+ [
2125
+ 'application/json'
2126
+ ]
2127
+ )
2128
+
2129
+ # set the HTTP header `Content-Type`
2130
+ if _content_type:
2131
+ _header_params['Content-Type'] = _content_type
2132
+ else:
2133
+ _default_content_type = (
2134
+ self.api_client.select_header_content_type(
2135
+ [
2136
+ 'application/json'
2137
+ ]
2138
+ )
2139
+ )
2140
+ if _default_content_type is not None:
2141
+ _header_params['Content-Type'] = _default_content_type
2142
+
2143
+ # authentication setting
2144
+ _auth_settings: List[str] = [
2145
+ 'OAuth2AuthorizationCode'
2146
+ ]
2147
+
2148
+ return self.api_client.param_serialize(
2149
+ method='POST',
2150
+ resource_path='/api/v1/organization/groups',
2151
+ path_params=_path_params,
2152
+ query_params=_query_params,
2153
+ header_params=_header_params,
2154
+ body=_body_params,
2155
+ post_params=_form_params,
2156
+ files=_files,
2157
+ auth_settings=_auth_settings,
2158
+ collection_formats=_collection_formats,
2159
+ _host=_host,
2160
+ _request_auth=_request_auth
2161
+ )
2162
+
2163
+
2164
+
2165
+
2166
+ @validate_call
2167
+ def remove_users_from_group(
2168
+ self,
2169
+ group_id: StrictStr,
2170
+ delete_group_membership: DeleteGroupMembership,
2171
+ _request_timeout: Union[
2172
+ None,
2173
+ Annotated[StrictFloat, Field(gt=0)],
2174
+ Tuple[
2175
+ Annotated[StrictFloat, Field(gt=0)],
2176
+ Annotated[StrictFloat, Field(gt=0)]
2177
+ ]
2178
+ ] = None,
2179
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2180
+ _content_type: Optional[StrictStr] = None,
2181
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2182
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2183
+ ) -> Group:
2184
+ """Remove Users From Group In Bulk
2185
+
2186
+ Remove all users from group by group ID. Requires group_delete_group_membership permission.
2187
+
2188
+ :param group_id: (required)
2189
+ :type group_id: str
2190
+ :param delete_group_membership: (required)
2191
+ :type delete_group_membership: DeleteGroupMembership
2192
+ :param _request_timeout: timeout setting for this request. If one
2193
+ number provided, it will be total request
2194
+ timeout. It can also be a pair (tuple) of
2195
+ (connection, read) timeouts.
2196
+ :type _request_timeout: int, tuple(int, int), optional
2197
+ :param _request_auth: set to override the auth_settings for an a single
2198
+ request; this effectively ignores the
2199
+ authentication in the spec for a single request.
2200
+ :type _request_auth: dict, optional
2201
+ :param _content_type: force content-type for the request.
2202
+ :type _content_type: str, Optional
2203
+ :param _headers: set to override the headers for a single
2204
+ request; this effectively ignores the headers
2205
+ in the spec for a single request.
2206
+ :type _headers: dict, optional
2207
+ :param _host_index: set to override the host_index for a single
2208
+ request; this effectively ignores the host_index
2209
+ in the spec for a single request.
2210
+ :type _host_index: int, optional
2211
+ :return: Returns the result object.
2212
+ """ # noqa: E501
2213
+
2214
+ _param = self._remove_users_from_group_serialize(
2215
+ group_id=group_id,
2216
+ delete_group_membership=delete_group_membership,
2217
+ _request_auth=_request_auth,
2218
+ _content_type=_content_type,
2219
+ _headers=_headers,
2220
+ _host_index=_host_index
2221
+ )
2222
+
2223
+ _response_types_map: Dict[str, Optional[str]] = {
2224
+ '200': "Group",
2225
+ '500': "InternalServerError",
2226
+ '404': "NotFoundError",
2227
+ '422': "HTTPValidationError",
2228
+ }
2229
+ response_data = self.api_client.call_api(
2230
+ *_param,
2231
+ _request_timeout=_request_timeout
2232
+ )
2233
+ response_data.read()
2234
+ return self.api_client.response_deserialize(
2235
+ response_data=response_data,
2236
+ response_types_map=_response_types_map,
2237
+ ).data
2238
+
2239
+
2240
+ @validate_call
2241
+ def remove_users_from_group_with_http_info(
2242
+ self,
2243
+ group_id: StrictStr,
2244
+ delete_group_membership: DeleteGroupMembership,
2245
+ _request_timeout: Union[
2246
+ None,
2247
+ Annotated[StrictFloat, Field(gt=0)],
2248
+ Tuple[
2249
+ Annotated[StrictFloat, Field(gt=0)],
2250
+ Annotated[StrictFloat, Field(gt=0)]
2251
+ ]
2252
+ ] = None,
2253
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2254
+ _content_type: Optional[StrictStr] = None,
2255
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2256
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2257
+ ) -> ApiResponse[Group]:
2258
+ """Remove Users From Group In Bulk
2259
+
2260
+ Remove all users from group by group ID. Requires group_delete_group_membership permission.
2261
+
2262
+ :param group_id: (required)
2263
+ :type group_id: str
2264
+ :param delete_group_membership: (required)
2265
+ :type delete_group_membership: DeleteGroupMembership
2266
+ :param _request_timeout: timeout setting for this request. If one
2267
+ number provided, it will be total request
2268
+ timeout. It can also be a pair (tuple) of
2269
+ (connection, read) timeouts.
2270
+ :type _request_timeout: int, tuple(int, int), optional
2271
+ :param _request_auth: set to override the auth_settings for an a single
2272
+ request; this effectively ignores the
2273
+ authentication in the spec for a single request.
2274
+ :type _request_auth: dict, optional
2275
+ :param _content_type: force content-type for the request.
2276
+ :type _content_type: str, Optional
2277
+ :param _headers: set to override the headers for a single
2278
+ request; this effectively ignores the headers
2279
+ in the spec for a single request.
2280
+ :type _headers: dict, optional
2281
+ :param _host_index: set to override the host_index for a single
2282
+ request; this effectively ignores the host_index
2283
+ in the spec for a single request.
2284
+ :type _host_index: int, optional
2285
+ :return: Returns the result object.
2286
+ """ # noqa: E501
2287
+
2288
+ _param = self._remove_users_from_group_serialize(
2289
+ group_id=group_id,
2290
+ delete_group_membership=delete_group_membership,
2291
+ _request_auth=_request_auth,
2292
+ _content_type=_content_type,
2293
+ _headers=_headers,
2294
+ _host_index=_host_index
2295
+ )
2296
+
2297
+ _response_types_map: Dict[str, Optional[str]] = {
2298
+ '200': "Group",
2299
+ '500': "InternalServerError",
2300
+ '404': "NotFoundError",
2301
+ '422': "HTTPValidationError",
2302
+ }
2303
+ response_data = self.api_client.call_api(
2304
+ *_param,
2305
+ _request_timeout=_request_timeout
2306
+ )
2307
+ response_data.read()
2308
+ return self.api_client.response_deserialize(
2309
+ response_data=response_data,
2310
+ response_types_map=_response_types_map,
2311
+ )
2312
+
2313
+
2314
+ @validate_call
2315
+ def remove_users_from_group_without_preload_content(
2316
+ self,
2317
+ group_id: StrictStr,
2318
+ delete_group_membership: DeleteGroupMembership,
2319
+ _request_timeout: Union[
2320
+ None,
2321
+ Annotated[StrictFloat, Field(gt=0)],
2322
+ Tuple[
2323
+ Annotated[StrictFloat, Field(gt=0)],
2324
+ Annotated[StrictFloat, Field(gt=0)]
2325
+ ]
2326
+ ] = None,
2327
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2328
+ _content_type: Optional[StrictStr] = None,
2329
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2330
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2331
+ ) -> RESTResponseType:
2332
+ """Remove Users From Group In Bulk
2333
+
2334
+ Remove all users from group by group ID. Requires group_delete_group_membership permission.
2335
+
2336
+ :param group_id: (required)
2337
+ :type group_id: str
2338
+ :param delete_group_membership: (required)
2339
+ :type delete_group_membership: DeleteGroupMembership
2340
+ :param _request_timeout: timeout setting for this request. If one
2341
+ number provided, it will be total request
2342
+ timeout. It can also be a pair (tuple) of
2343
+ (connection, read) timeouts.
2344
+ :type _request_timeout: int, tuple(int, int), optional
2345
+ :param _request_auth: set to override the auth_settings for an a single
2346
+ request; this effectively ignores the
2347
+ authentication in the spec for a single request.
2348
+ :type _request_auth: dict, optional
2349
+ :param _content_type: force content-type for the request.
2350
+ :type _content_type: str, Optional
2351
+ :param _headers: set to override the headers for a single
2352
+ request; this effectively ignores the headers
2353
+ in the spec for a single request.
2354
+ :type _headers: dict, optional
2355
+ :param _host_index: set to override the host_index for a single
2356
+ request; this effectively ignores the host_index
2357
+ in the spec for a single request.
2358
+ :type _host_index: int, optional
2359
+ :return: Returns the result object.
2360
+ """ # noqa: E501
2361
+
2362
+ _param = self._remove_users_from_group_serialize(
2363
+ group_id=group_id,
2364
+ delete_group_membership=delete_group_membership,
2365
+ _request_auth=_request_auth,
2366
+ _content_type=_content_type,
2367
+ _headers=_headers,
2368
+ _host_index=_host_index
2369
+ )
2370
+
2371
+ _response_types_map: Dict[str, Optional[str]] = {
2372
+ '200': "Group",
2373
+ '500': "InternalServerError",
2374
+ '404': "NotFoundError",
2375
+ '422': "HTTPValidationError",
2376
+ }
2377
+ response_data = self.api_client.call_api(
2378
+ *_param,
2379
+ _request_timeout=_request_timeout
2380
+ )
2381
+ return response_data.response
2382
+
2383
+
2384
+ def _remove_users_from_group_serialize(
2385
+ self,
2386
+ group_id,
2387
+ delete_group_membership,
2388
+ _request_auth,
2389
+ _content_type,
2390
+ _headers,
2391
+ _host_index,
2392
+ ) -> RequestSerialized:
2393
+
2394
+ _host = None
2395
+
2396
+ _collection_formats: Dict[str, str] = {
2397
+ }
2398
+
2399
+ _path_params: Dict[str, str] = {}
2400
+ _query_params: List[Tuple[str, str]] = []
2401
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2402
+ _form_params: List[Tuple[str, str]] = []
2403
+ _files: Dict[
2404
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2405
+ ] = {}
2406
+ _body_params: Optional[bytes] = None
2407
+
2408
+ # process the path parameters
2409
+ if group_id is not None:
2410
+ _path_params['group_id'] = group_id
2411
+ # process the query parameters
2412
+ # process the header parameters
2413
+ # process the form parameters
2414
+ # process the body parameter
2415
+ if delete_group_membership is not None:
2416
+ _body_params = delete_group_membership
2417
+
2418
+
2419
+ # set the HTTP header `Accept`
2420
+ if 'Accept' not in _header_params:
2421
+ _header_params['Accept'] = self.api_client.select_header_accept(
2422
+ [
2423
+ 'application/json'
2424
+ ]
2425
+ )
2426
+
2427
+ # set the HTTP header `Content-Type`
2428
+ if _content_type:
2429
+ _header_params['Content-Type'] = _content_type
2430
+ else:
2431
+ _default_content_type = (
2432
+ self.api_client.select_header_content_type(
2433
+ [
2434
+ 'application/json'
2435
+ ]
2436
+ )
2437
+ )
2438
+ if _default_content_type is not None:
2439
+ _header_params['Content-Type'] = _default_content_type
2440
+
2441
+ # authentication setting
2442
+ _auth_settings: List[str] = [
2443
+ 'OAuth2AuthorizationCode'
2444
+ ]
2445
+
2446
+ return self.api_client.param_serialize(
2447
+ method='DELETE',
2448
+ resource_path='/api/v1/groups/{group_id}/users',
2449
+ path_params=_path_params,
2450
+ query_params=_query_params,
2451
+ header_params=_header_params,
2452
+ body=_body_params,
2453
+ post_params=_form_params,
2454
+ files=_files,
2455
+ auth_settings=_auth_settings,
2456
+ collection_formats=_collection_formats,
2457
+ _host=_host,
2458
+ _request_auth=_request_auth
2459
+ )
2460
+
2461
+
2462
+
2463
+
2464
+ @validate_call
2465
+ def search_group_memberships(
2466
+ self,
2467
+ user_ids: Annotated[Optional[List[Optional[StrictStr]]], Field(description="Filter memberships to select user IDs.")] = None,
2468
+ group_ids: Annotated[Optional[List[Optional[StrictStr]]], Field(description="Filter memberships to select group IDs.")] = None,
2469
+ group_name: Annotated[Optional[StrictStr], Field(description="Filter memberships by group name. A name matches if it contains the input string case-insensitive.")] = None,
2470
+ page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="The page to return starting from 1 up to total_pages.")] = None,
2471
+ page_size: Annotated[Optional[Annotated[int, Field(le=1000, strict=True, ge=1)]], Field(description="The number of records per page. The max is 1000.")] = None,
2472
+ _request_timeout: Union[
2473
+ None,
2474
+ Annotated[StrictFloat, Field(gt=0)],
2475
+ Tuple[
2476
+ Annotated[StrictFloat, Field(gt=0)],
2477
+ Annotated[StrictFloat, Field(gt=0)]
2478
+ ]
2479
+ ] = None,
2480
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2481
+ _content_type: Optional[StrictStr] = None,
2482
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2483
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2484
+ ) -> ResourceListGroupMembership:
2485
+ """Search Group Memberships
2486
+
2487
+ Searches memberships for the intersection of user and group IDs. Requires organization_list_group_memberships permission.
2488
+
2489
+ :param user_ids: Filter memberships to select user IDs.
2490
+ :type user_ids: List[Optional[str]]
2491
+ :param group_ids: Filter memberships to select group IDs.
2492
+ :type group_ids: List[Optional[str]]
2493
+ :param group_name: Filter memberships by group name. A name matches if it contains the input string case-insensitive.
2494
+ :type group_name: str
2495
+ :param page: The page to return starting from 1 up to total_pages.
2496
+ :type page: int
2497
+ :param page_size: The number of records per page. The max is 1000.
2498
+ :type page_size: int
2499
+ :param _request_timeout: timeout setting for this request. If one
2500
+ number provided, it will be total request
2501
+ timeout. It can also be a pair (tuple) of
2502
+ (connection, read) timeouts.
2503
+ :type _request_timeout: int, tuple(int, int), optional
2504
+ :param _request_auth: set to override the auth_settings for an a single
2505
+ request; this effectively ignores the
2506
+ authentication in the spec for a single request.
2507
+ :type _request_auth: dict, optional
2508
+ :param _content_type: force content-type for the request.
2509
+ :type _content_type: str, Optional
2510
+ :param _headers: set to override the headers for a single
2511
+ request; this effectively ignores the headers
2512
+ in the spec for a single request.
2513
+ :type _headers: dict, optional
2514
+ :param _host_index: set to override the host_index for a single
2515
+ request; this effectively ignores the host_index
2516
+ in the spec for a single request.
2517
+ :type _host_index: int, optional
2518
+ :return: Returns the result object.
2519
+ """ # noqa: E501
2520
+
2521
+ _param = self._search_group_memberships_serialize(
2522
+ user_ids=user_ids,
2523
+ group_ids=group_ids,
2524
+ group_name=group_name,
2525
+ page=page,
2526
+ page_size=page_size,
2527
+ _request_auth=_request_auth,
2528
+ _content_type=_content_type,
2529
+ _headers=_headers,
2530
+ _host_index=_host_index
2531
+ )
2532
+
2533
+ _response_types_map: Dict[str, Optional[str]] = {
2534
+ '200': "ResourceListGroupMembership",
2535
+ '500': "InternalServerError",
2536
+ '404': "NotFoundError",
2537
+ '422': "HTTPValidationError",
2538
+ }
2539
+ response_data = self.api_client.call_api(
2540
+ *_param,
2541
+ _request_timeout=_request_timeout
2542
+ )
2543
+ response_data.read()
2544
+ return self.api_client.response_deserialize(
2545
+ response_data=response_data,
2546
+ response_types_map=_response_types_map,
2547
+ ).data
2548
+
2549
+
2550
+ @validate_call
2551
+ def search_group_memberships_with_http_info(
2552
+ self,
2553
+ user_ids: Annotated[Optional[List[Optional[StrictStr]]], Field(description="Filter memberships to select user IDs.")] = None,
2554
+ group_ids: Annotated[Optional[List[Optional[StrictStr]]], Field(description="Filter memberships to select group IDs.")] = None,
2555
+ group_name: Annotated[Optional[StrictStr], Field(description="Filter memberships by group name. A name matches if it contains the input string case-insensitive.")] = None,
2556
+ page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="The page to return starting from 1 up to total_pages.")] = None,
2557
+ page_size: Annotated[Optional[Annotated[int, Field(le=1000, strict=True, ge=1)]], Field(description="The number of records per page. The max is 1000.")] = None,
2558
+ _request_timeout: Union[
2559
+ None,
2560
+ Annotated[StrictFloat, Field(gt=0)],
2561
+ Tuple[
2562
+ Annotated[StrictFloat, Field(gt=0)],
2563
+ Annotated[StrictFloat, Field(gt=0)]
2564
+ ]
2565
+ ] = None,
2566
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2567
+ _content_type: Optional[StrictStr] = None,
2568
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2569
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2570
+ ) -> ApiResponse[ResourceListGroupMembership]:
2571
+ """Search Group Memberships
2572
+
2573
+ Searches memberships for the intersection of user and group IDs. Requires organization_list_group_memberships permission.
2574
+
2575
+ :param user_ids: Filter memberships to select user IDs.
2576
+ :type user_ids: List[Optional[str]]
2577
+ :param group_ids: Filter memberships to select group IDs.
2578
+ :type group_ids: List[Optional[str]]
2579
+ :param group_name: Filter memberships by group name. A name matches if it contains the input string case-insensitive.
2580
+ :type group_name: str
2581
+ :param page: The page to return starting from 1 up to total_pages.
2582
+ :type page: int
2583
+ :param page_size: The number of records per page. The max is 1000.
2584
+ :type page_size: int
2585
+ :param _request_timeout: timeout setting for this request. If one
2586
+ number provided, it will be total request
2587
+ timeout. It can also be a pair (tuple) of
2588
+ (connection, read) timeouts.
2589
+ :type _request_timeout: int, tuple(int, int), optional
2590
+ :param _request_auth: set to override the auth_settings for an a single
2591
+ request; this effectively ignores the
2592
+ authentication in the spec for a single request.
2593
+ :type _request_auth: dict, optional
2594
+ :param _content_type: force content-type for the request.
2595
+ :type _content_type: str, Optional
2596
+ :param _headers: set to override the headers for a single
2597
+ request; this effectively ignores the headers
2598
+ in the spec for a single request.
2599
+ :type _headers: dict, optional
2600
+ :param _host_index: set to override the host_index for a single
2601
+ request; this effectively ignores the host_index
2602
+ in the spec for a single request.
2603
+ :type _host_index: int, optional
2604
+ :return: Returns the result object.
2605
+ """ # noqa: E501
2606
+
2607
+ _param = self._search_group_memberships_serialize(
2608
+ user_ids=user_ids,
2609
+ group_ids=group_ids,
2610
+ group_name=group_name,
2611
+ page=page,
2612
+ page_size=page_size,
2613
+ _request_auth=_request_auth,
2614
+ _content_type=_content_type,
2615
+ _headers=_headers,
2616
+ _host_index=_host_index
2617
+ )
2618
+
2619
+ _response_types_map: Dict[str, Optional[str]] = {
2620
+ '200': "ResourceListGroupMembership",
2621
+ '500': "InternalServerError",
2622
+ '404': "NotFoundError",
2623
+ '422': "HTTPValidationError",
2624
+ }
2625
+ response_data = self.api_client.call_api(
2626
+ *_param,
2627
+ _request_timeout=_request_timeout
2628
+ )
2629
+ response_data.read()
2630
+ return self.api_client.response_deserialize(
2631
+ response_data=response_data,
2632
+ response_types_map=_response_types_map,
2633
+ )
2634
+
2635
+
2636
+ @validate_call
2637
+ def search_group_memberships_without_preload_content(
2638
+ self,
2639
+ user_ids: Annotated[Optional[List[Optional[StrictStr]]], Field(description="Filter memberships to select user IDs.")] = None,
2640
+ group_ids: Annotated[Optional[List[Optional[StrictStr]]], Field(description="Filter memberships to select group IDs.")] = None,
2641
+ group_name: Annotated[Optional[StrictStr], Field(description="Filter memberships by group name. A name matches if it contains the input string case-insensitive.")] = None,
2642
+ page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="The page to return starting from 1 up to total_pages.")] = None,
2643
+ page_size: Annotated[Optional[Annotated[int, Field(le=1000, strict=True, ge=1)]], Field(description="The number of records per page. The max is 1000.")] = None,
2644
+ _request_timeout: Union[
2645
+ None,
2646
+ Annotated[StrictFloat, Field(gt=0)],
2647
+ Tuple[
2648
+ Annotated[StrictFloat, Field(gt=0)],
2649
+ Annotated[StrictFloat, Field(gt=0)]
2650
+ ]
2651
+ ] = None,
2652
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2653
+ _content_type: Optional[StrictStr] = None,
2654
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2655
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2656
+ ) -> RESTResponseType:
2657
+ """Search Group Memberships
2658
+
2659
+ Searches memberships for the intersection of user and group IDs. Requires organization_list_group_memberships permission.
2660
+
2661
+ :param user_ids: Filter memberships to select user IDs.
2662
+ :type user_ids: List[Optional[str]]
2663
+ :param group_ids: Filter memberships to select group IDs.
2664
+ :type group_ids: List[Optional[str]]
2665
+ :param group_name: Filter memberships by group name. A name matches if it contains the input string case-insensitive.
2666
+ :type group_name: str
2667
+ :param page: The page to return starting from 1 up to total_pages.
2668
+ :type page: int
2669
+ :param page_size: The number of records per page. The max is 1000.
2670
+ :type page_size: int
2671
+ :param _request_timeout: timeout setting for this request. If one
2672
+ number provided, it will be total request
2673
+ timeout. It can also be a pair (tuple) of
2674
+ (connection, read) timeouts.
2675
+ :type _request_timeout: int, tuple(int, int), optional
2676
+ :param _request_auth: set to override the auth_settings for an a single
2677
+ request; this effectively ignores the
2678
+ authentication in the spec for a single request.
2679
+ :type _request_auth: dict, optional
2680
+ :param _content_type: force content-type for the request.
2681
+ :type _content_type: str, Optional
2682
+ :param _headers: set to override the headers for a single
2683
+ request; this effectively ignores the headers
2684
+ in the spec for a single request.
2685
+ :type _headers: dict, optional
2686
+ :param _host_index: set to override the host_index for a single
2687
+ request; this effectively ignores the host_index
2688
+ in the spec for a single request.
2689
+ :type _host_index: int, optional
2690
+ :return: Returns the result object.
2691
+ """ # noqa: E501
2692
+
2693
+ _param = self._search_group_memberships_serialize(
2694
+ user_ids=user_ids,
2695
+ group_ids=group_ids,
2696
+ group_name=group_name,
2697
+ page=page,
2698
+ page_size=page_size,
2699
+ _request_auth=_request_auth,
2700
+ _content_type=_content_type,
2701
+ _headers=_headers,
2702
+ _host_index=_host_index
2703
+ )
2704
+
2705
+ _response_types_map: Dict[str, Optional[str]] = {
2706
+ '200': "ResourceListGroupMembership",
2707
+ '500': "InternalServerError",
2708
+ '404': "NotFoundError",
2709
+ '422': "HTTPValidationError",
2710
+ }
2711
+ response_data = self.api_client.call_api(
2712
+ *_param,
2713
+ _request_timeout=_request_timeout
2714
+ )
2715
+ return response_data.response
2716
+
2717
+
2718
+ def _search_group_memberships_serialize(
2719
+ self,
2720
+ user_ids,
2721
+ group_ids,
2722
+ group_name,
2723
+ page,
2724
+ page_size,
2725
+ _request_auth,
2726
+ _content_type,
2727
+ _headers,
2728
+ _host_index,
2729
+ ) -> RequestSerialized:
2730
+
2731
+ _host = None
2732
+
2733
+ _collection_formats: Dict[str, str] = {
2734
+ 'user_ids': 'multi',
2735
+ 'group_ids': 'multi',
2736
+ }
2737
+
2738
+ _path_params: Dict[str, str] = {}
2739
+ _query_params: List[Tuple[str, str]] = []
2740
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2741
+ _form_params: List[Tuple[str, str]] = []
2742
+ _files: Dict[
2743
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2744
+ ] = {}
2745
+ _body_params: Optional[bytes] = None
2746
+
2747
+ # process the path parameters
2748
+ # process the query parameters
2749
+ if user_ids is not None:
2750
+
2751
+ _query_params.append(('user_ids', user_ids))
2752
+
2753
+ if group_ids is not None:
2754
+
2755
+ _query_params.append(('group_ids', group_ids))
2756
+
2757
+ if group_name is not None:
2758
+
2759
+ _query_params.append(('group_name', group_name))
2760
+
2761
+ if page is not None:
2762
+
2763
+ _query_params.append(('page', page))
2764
+
2765
+ if page_size is not None:
2766
+
2767
+ _query_params.append(('page_size', page_size))
2768
+
2769
+ # process the header parameters
2770
+ # process the form parameters
2771
+ # process the body parameter
2772
+
2773
+
2774
+ # set the HTTP header `Accept`
2775
+ if 'Accept' not in _header_params:
2776
+ _header_params['Accept'] = self.api_client.select_header_accept(
2777
+ [
2778
+ 'application/json'
2779
+ ]
2780
+ )
2781
+
2782
+
2783
+ # authentication setting
2784
+ _auth_settings: List[str] = [
2785
+ 'OAuth2AuthorizationCode'
2786
+ ]
2787
+
2788
+ return self.api_client.param_serialize(
2789
+ method='GET',
2790
+ resource_path='/api/v1/organization/group_memberships',
2791
+ path_params=_path_params,
2792
+ query_params=_query_params,
2793
+ header_params=_header_params,
2794
+ body=_body_params,
2795
+ post_params=_form_params,
2796
+ files=_files,
2797
+ auth_settings=_auth_settings,
2798
+ collection_formats=_collection_formats,
2799
+ _host=_host,
2800
+ _request_auth=_request_auth
2801
+ )
2802
+
2803
+