@globus/sdk 5.8.0 → 6.0.0-rc.2

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 (116) hide show
  1. package/README.md +8 -7
  2. package/dist/cjs/core/authorization/index.js.map +1 -1
  3. package/dist/cjs/index.js +0 -4
  4. package/dist/cjs/index.js.map +2 -2
  5. package/dist/cjs/services/globus-connect-server/client.js.map +2 -2
  6. package/dist/esm/apps/web.d.ts +1 -1
  7. package/dist/esm/apps/web.d.ts.map +1 -1
  8. package/dist/esm/core/authorization/RedirectTransport.d.ts +1 -1
  9. package/dist/esm/core/authorization/RedirectTransport.d.ts.map +1 -1
  10. package/dist/esm/index.d.ts.map +1 -1
  11. package/dist/esm/index.js +0 -4
  12. package/dist/esm/index.js.map +1 -1
  13. package/dist/esm/open-api/types/compute.d.ts +3759 -0
  14. package/dist/esm/open-api/types/compute.d.ts.map +1 -0
  15. package/dist/esm/open-api/types/compute.js +2 -0
  16. package/dist/esm/open-api/types/compute.js.map +1 -0
  17. package/dist/esm/open-api/types/gcs/v5.4.d.ts +12052 -0
  18. package/dist/esm/open-api/types/gcs/v5.4.d.ts.map +1 -0
  19. package/dist/esm/open-api/types/gcs/v5.4.js +2 -0
  20. package/dist/esm/open-api/types/gcs/v5.4.js.map +1 -0
  21. package/dist/esm/open-api/types/groups.d.ts +2382 -0
  22. package/dist/esm/open-api/types/groups.d.ts.map +1 -0
  23. package/dist/esm/open-api/types/groups.js +2 -0
  24. package/dist/esm/open-api/types/groups.js.map +1 -0
  25. package/dist/esm/open-api/types/search.d.ts +2191 -0
  26. package/dist/esm/open-api/types/search.d.ts.map +1 -0
  27. package/dist/esm/open-api/types/search.js +2 -0
  28. package/dist/esm/open-api/types/search.js.map +1 -0
  29. package/dist/esm/open-api/types/timer.d.ts +942 -0
  30. package/dist/esm/open-api/types/timer.d.ts.map +1 -0
  31. package/dist/esm/open-api/types/timer.js +2 -0
  32. package/dist/esm/open-api/types/timer.js.map +1 -0
  33. package/dist/esm/package.json +1 -1
  34. package/dist/esm/services/auth/utils.d.ts +1 -1
  35. package/dist/esm/services/auth/utils.d.ts.map +1 -1
  36. package/dist/esm/services/compute/index.d.ts +1 -0
  37. package/dist/esm/services/compute/index.d.ts.map +1 -1
  38. package/dist/esm/services/compute/index.js.map +1 -1
  39. package/dist/esm/services/compute/service/endpoints.d.ts +5 -5
  40. package/dist/esm/services/compute/service/endpoints.d.ts.map +1 -1
  41. package/dist/esm/services/compute/service/endpoints.js.map +1 -1
  42. package/dist/esm/services/globus-connect-server/client.d.ts +646 -261
  43. package/dist/esm/services/globus-connect-server/client.d.ts.map +1 -1
  44. package/dist/esm/services/globus-connect-server/index.d.ts +1 -0
  45. package/dist/esm/services/globus-connect-server/index.d.ts.map +1 -1
  46. package/dist/esm/services/globus-connect-server/index.js.map +1 -1
  47. package/dist/esm/services/globus-connect-server/service/collections.d.ts +40 -40
  48. package/dist/esm/services/globus-connect-server/service/collections.d.ts.map +1 -1
  49. package/dist/esm/services/globus-connect-server/service/collections.js.map +1 -1
  50. package/dist/esm/services/globus-connect-server/service/endpoint.d.ts +35 -35
  51. package/dist/esm/services/globus-connect-server/service/endpoint.d.ts.map +1 -1
  52. package/dist/esm/services/globus-connect-server/service/endpoint.js.map +1 -1
  53. package/dist/esm/services/globus-connect-server/service/nodes.d.ts +30 -30
  54. package/dist/esm/services/globus-connect-server/service/nodes.d.ts.map +1 -1
  55. package/dist/esm/services/globus-connect-server/service/nodes.js.map +1 -1
  56. package/dist/esm/services/globus-connect-server/service/roles.d.ts +20 -20
  57. package/dist/esm/services/globus-connect-server/service/roles.d.ts.map +1 -1
  58. package/dist/esm/services/globus-connect-server/service/roles.js.map +1 -1
  59. package/dist/esm/services/globus-connect-server/service/storage-gateways.d.ts +31 -31
  60. package/dist/esm/services/globus-connect-server/service/storage-gateways.d.ts.map +1 -1
  61. package/dist/esm/services/globus-connect-server/service/storage-gateways.js.map +1 -1
  62. package/dist/esm/services/globus-connect-server/service/user-credentials.d.ts +30 -30
  63. package/dist/esm/services/globus-connect-server/service/user-credentials.d.ts.map +1 -1
  64. package/dist/esm/services/globus-connect-server/service/user-credentials.js.map +1 -1
  65. package/dist/esm/services/globus-connect-server/service/versioning.d.ts +6 -6
  66. package/dist/esm/services/globus-connect-server/service/versioning.d.ts.map +1 -1
  67. package/dist/esm/services/globus-connect-server/service/versioning.js.map +1 -1
  68. package/dist/esm/services/groups/index.d.ts +1 -0
  69. package/dist/esm/services/groups/index.d.ts.map +1 -1
  70. package/dist/esm/services/groups/index.js.map +1 -1
  71. package/dist/esm/services/groups/service/groups.d.ts +5 -5
  72. package/dist/esm/services/groups/service/groups.d.ts.map +1 -1
  73. package/dist/esm/services/groups/service/groups.js.map +1 -1
  74. package/dist/esm/services/groups/service/membership.d.ts +3 -3
  75. package/dist/esm/services/groups/service/membership.d.ts.map +1 -1
  76. package/dist/esm/services/groups/service/membership.js.map +1 -1
  77. package/dist/esm/services/groups/service/policies.d.ts +2 -2
  78. package/dist/esm/services/groups/service/policies.d.ts.map +1 -1
  79. package/dist/esm/services/groups/service/policies.js.map +1 -1
  80. package/dist/esm/services/search/index.d.ts +1 -0
  81. package/dist/esm/services/search/index.d.ts.map +1 -1
  82. package/dist/esm/services/search/index.js.map +1 -1
  83. package/dist/esm/services/timer/index.d.ts +1 -0
  84. package/dist/esm/services/timer/index.d.ts.map +1 -1
  85. package/dist/esm/services/timer/index.js.map +1 -1
  86. package/dist/esm/services/timer/service/timer.d.ts +28 -2
  87. package/dist/esm/services/timer/service/timer.d.ts.map +1 -1
  88. package/dist/esm/services/timer/service/timer.js.map +1 -1
  89. package/dist/esm/services/transfer/service/access.d.ts +28 -5
  90. package/dist/esm/services/transfer/service/access.d.ts.map +1 -1
  91. package/dist/esm/services/transfer/service/access.js.map +1 -1
  92. package/dist/esm/services/transfer/service/collection-bookmarks.d.ts +20 -6
  93. package/dist/esm/services/transfer/service/collection-bookmarks.d.ts.map +1 -1
  94. package/dist/esm/services/transfer/service/collection-bookmarks.js.map +1 -1
  95. package/dist/esm/services/transfer/service/endpoint-manager/endpoint.d.ts +14 -6
  96. package/dist/esm/services/transfer/service/endpoint-manager/endpoint.d.ts.map +1 -1
  97. package/dist/esm/services/transfer/service/endpoint-manager/endpoint.js.map +1 -1
  98. package/dist/esm/services/transfer/service/endpoint-manager/pause-rule.d.ts +28 -6
  99. package/dist/esm/services/transfer/service/endpoint-manager/pause-rule.d.ts.map +1 -1
  100. package/dist/esm/services/transfer/service/endpoint-manager/pause-rule.js.map +1 -1
  101. package/dist/esm/services/transfer/service/endpoint-manager/task.d.ts +93 -15
  102. package/dist/esm/services/transfer/service/endpoint-manager/task.d.ts.map +1 -1
  103. package/dist/esm/services/transfer/service/endpoint-manager/task.js +1 -1
  104. package/dist/esm/services/transfer/service/endpoint-manager/task.js.map +1 -1
  105. package/dist/esm/services/transfer/service/endpoint-search.d.ts +20 -12
  106. package/dist/esm/services/transfer/service/endpoint-search.d.ts.map +1 -1
  107. package/dist/esm/services/transfer/service/endpoint-search.js +2 -11
  108. package/dist/esm/services/transfer/service/endpoint-search.js.map +1 -1
  109. package/dist/esm/services/transfer/service/task.d.ts +157 -11
  110. package/dist/esm/services/transfer/service/task.d.ts.map +1 -1
  111. package/dist/esm/services/transfer/service/task.js.map +1 -1
  112. package/dist/esm/services/transfer/types.d.ts +16 -3
  113. package/dist/esm/services/transfer/types.d.ts.map +1 -1
  114. package/dist/umd/globus.production.js +2 -2
  115. package/dist/umd/globus.production.js.map +2 -2
  116. package/package.json +3 -10
@@ -0,0 +1,2382 @@
1
+ export interface paths {
2
+ "/v2/groups/my_groups": {
3
+ parameters: {
4
+ query?: never;
5
+ header?: never;
6
+ path?: never;
7
+ cookie?: never;
8
+ };
9
+ /**
10
+ * Retrieve your groups and memberships
11
+ * @description This endpoint returns, as an array, all groups in which the user and
12
+ * its linked identities is an active member, manager, or admin, by default.
13
+ *
14
+ * The my_memberships field is included by default.
15
+ *
16
+ * The optional query parameter, `statuses`, results in the array containing
17
+ * those memberships with one of the specified status(es). The default value
18
+ * is `active`.
19
+ */
20
+ get: operations["get_my_groups_and_memberships_v2_groups_my_groups_get"];
21
+ put?: never;
22
+ post?: never;
23
+ delete?: never;
24
+ options?: never;
25
+ head?: never;
26
+ patch?: never;
27
+ trace?: never;
28
+ };
29
+ "/v2/groups/statuses": {
30
+ parameters: {
31
+ query?: never;
32
+ header?: never;
33
+ path?: never;
34
+ cookie?: never;
35
+ };
36
+ /**
37
+ * Get the status counts of memberships for each group you are an admin or manager of.
38
+ * @description This endpoint retreives all the membership counts for groups where the caller is
39
+ * either an admin or manager.
40
+ */
41
+ get: operations["get_statuses_v2_groups_statuses_get"];
42
+ put?: never;
43
+ post?: never;
44
+ delete?: never;
45
+ options?: never;
46
+ head?: never;
47
+ patch?: never;
48
+ trace?: never;
49
+ };
50
+ "/v2/groups/{group_id}": {
51
+ parameters: {
52
+ query?: never;
53
+ header?: never;
54
+ path?: never;
55
+ cookie?: never;
56
+ };
57
+ /**
58
+ * Get Group
59
+ * @description Get details and members of a group by group id.
60
+ *
61
+ * If `memberships` or `my_memberships` are in the `include` parameter and the
62
+ * scopes in the provided authorization token allow memberships to be viewed,
63
+ * the memberships will be returned in the response.
64
+ *
65
+ * If `allowed_actions` are in the `include` parameter, and the scopes in the
66
+ * tokens allow managing memberships, an object will be returned detailing which
67
+ * membership actions each identity in the user's set is allowed to perform.
68
+ *
69
+ * A group can be viewed if:
70
+ * - The group policy is that any authenticated user can view it.
71
+ * - The group is private, and the user has an active/invited/pending membership.
72
+ *
73
+ * Group memberships can only be viewed by active members. Depending on group policy,
74
+ * this may be further restricted to only admins and managers. Note that future
75
+ * versions may relax this restriction for specific cases, such as allowing invited
76
+ * or pending members to view the membership of the user that invited them.
77
+ */
78
+ get: operations["get_group_v2_groups__group_id__get"];
79
+ /**
80
+ * Update an existing group
81
+ * @description Update the details of a group by group id.
82
+ *
83
+ * If `allowed_actions` are in the `include` parameter, and the scopes in the
84
+ * tokens allow managing memberships, an object will be returned detailing which
85
+ * membership actions each identity in the user's set is allowed to perform.
86
+ *
87
+ * A group can be updated if:
88
+ * - The user is an admin.
89
+ *
90
+ * Group memberships should be updated using the membership endpoint.
91
+ */
92
+ put: operations["update_group_v2_groups__group_id__put"];
93
+ /**
94
+ * Perform actions on members of the group.
95
+ * @description This endpoint supports bulk actions on collections of members of the group.
96
+ * Currently the following actions are supported:
97
+ *
98
+ * - **accept**: Identities in the `accept` list which are in the users identity set
99
+ * will be accepted into the group. Only `invited` memberships can `accept`.
100
+ * - **add**: Identities in the `add` list will be added to the group as long
101
+ * as the identity exists and they have not previously left the group, or indicated
102
+ * via settings that they can not be added to any group. Adding an identity which
103
+ * already have an active membership in the group will not modify the membership,
104
+ * and is an error for informational purposes. All active admins and managers are
105
+ * permitted to add members to a group. Active admins are also permitted to add
106
+ * admins and managers to a group. Role is an optional parameter to set the
107
+ * membership role on addition.
108
+ * - **approve**: Identities in the `approve` list will be
109
+ * accepted into the group. Only `pending` memberships can be included in
110
+ * the `approve` list. All active admins and managers are permitted to approve
111
+ * pending members to a group.
112
+ * - **change_role**: Identities in the `change_role` list whose roles in the group are
113
+ * to be updated. Only admins can change member roles. Only `active` memberships
114
+ * are eligible for role changes.
115
+ * - **decline**: Identities in the `decline` list which are in the users identity set
116
+ * will be rejected from the group. Only `invited` memberships can `decline`.
117
+ * - **invite**: Identities in the `invite` list will be invited to join the group.
118
+ * All active admins and managers are permitted to invite members to a group. Members
119
+ * may also invite other members if the policy allows it. Role is an optional
120
+ * parameter to set the membership role on invitation.
121
+ * - **join**: Identities in the `join` list which are in the users identity set
122
+ * will join the group, if the group policy is to allow users to join. High Assurance
123
+ * groups cannot use this action.
124
+ * - **leave**: Identities in the `leave` list which are in the users identity set
125
+ * will be removed from the group. Only `active` memberships can `leave`. If the
126
+ * identity is the last remaining `admin` of the group leaving is not allowed,
127
+ * since this would leave the group in an orphaned state.
128
+ * - **reject**: Identities in the `reject` list will be
129
+ * rejected from the group. Only `pending` memberships can be included in
130
+ * the `reject` list. All active admins and managers are permitted to reject pending
131
+ * members from a group.
132
+ * - **remove**: Identities in the `remove` list will be removed from the group.
133
+ * Admins can remove admins, managers, and members. Managers can remove managers and
134
+ * members. Regular members cannot remove any members. Only `active` and `invited`
135
+ * memberships can be removed, and users cannot remove their own memberships.
136
+ * - **request_join**: Identities in the `request_join` list which are in the users
137
+ * identity set will be set as pending memberships for the group if the group policy
138
+ * requires membership approval. Pending memberships must be approved or rejected by
139
+ * administrators or managers.
140
+ *
141
+ * The response will include the current state of any membership that was
142
+ * successfully processed. The response will also include a list of errors
143
+ * indicating the identity of any requested membership action that failed to
144
+ * be processed.
145
+ *
146
+ * Identity IDs must be unique across all actions in the same call. For example,
147
+ * trying to add and remove the same identity in the same request will cause the
148
+ * entire request to fail.
149
+ */
150
+ post: operations["group_membership_post_actions_v2_groups__group_id__post"];
151
+ /**
152
+ * Delete a group
153
+ * @description This endpoint allows a group to be deleted by an admin.
154
+ *
155
+ * > Note: Groups can only be deleted by admins.
156
+ */
157
+ delete: operations["delete_group_v2_groups__group_id__delete"];
158
+ options?: never;
159
+ head?: never;
160
+ patch?: never;
161
+ trace?: never;
162
+ };
163
+ "/v2/groups/{group_id}/children": {
164
+ parameters: {
165
+ query?: never;
166
+ header?: never;
167
+ path?: never;
168
+ cookie?: never;
169
+ };
170
+ /**
171
+ * Get Children
172
+ * @description Get the children of the group.
173
+ */
174
+ get: operations["get_children_v2_groups__group_id__children_get"];
175
+ put?: never;
176
+ post?: never;
177
+ delete?: never;
178
+ options?: never;
179
+ head?: never;
180
+ patch?: never;
181
+ trace?: never;
182
+ };
183
+ "/v2/groups": {
184
+ parameters: {
185
+ query?: never;
186
+ header?: never;
187
+ path?: never;
188
+ cookie?: never;
189
+ };
190
+ get?: never;
191
+ put?: never;
192
+ /**
193
+ * Create a new group
194
+ * @description MVP limitations:
195
+ *
196
+ * - For users with more than one linked identity, ability to specify
197
+ * which identity becomes the admin will be added later.
198
+ * - Non-default policies can not be specified. They can be adjusted using the
199
+ * Globus web app.
200
+ *
201
+ * Create a new group with the given name. The effective identity (typically
202
+ * the user's primary identity) of the Auth token used for the call will be
203
+ * added to the group as an administrator. The group will be created with
204
+ * default polices that:
205
+ *
206
+ * * Allow membership requests only to be approved by admins and managers
207
+ * * Allow subgroups to be created only by admins
208
+ * * Allow the group to be visible only to members
209
+ * * Allow member names to be visible only to managers and admins
210
+ * * Allow invititations to be sent by managers and admins
211
+ * * Disallow requests to join
212
+ *
213
+ * Groups can only be created by users with 1000 or fewer active memberships.
214
+ */
215
+ post: operations["create_group_v2_groups_post"];
216
+ delete?: never;
217
+ options?: never;
218
+ head?: never;
219
+ patch?: never;
220
+ trace?: never;
221
+ };
222
+ "/v2/groups/{group_id}/policies": {
223
+ parameters: {
224
+ query?: never;
225
+ header?: never;
226
+ path?: never;
227
+ cookie?: never;
228
+ };
229
+ /**
230
+ * Get the policies for the group.
231
+ * @description Get the policies for a group.
232
+ */
233
+ get: operations["get_policies_v2_groups__group_id__policies_get"];
234
+ /**
235
+ * Set the policies for the group.
236
+ * @description Update the policies for a group.
237
+ */
238
+ put: operations["update_policies_v2_groups__group_id__policies_put"];
239
+ post?: never;
240
+ delete?: never;
241
+ options?: never;
242
+ head?: never;
243
+ patch?: never;
244
+ trace?: never;
245
+ };
246
+ "/v2/preferences": {
247
+ parameters: {
248
+ query?: never;
249
+ header?: never;
250
+ path?: never;
251
+ cookie?: never;
252
+ };
253
+ /**
254
+ * Get the preferences for your identity set.
255
+ * @description This endpoint allows users to get preferences for each of their
256
+ * identities that affect how their identity can be used in groups.
257
+ * Currently, the supported preferences are:
258
+ *
259
+ * - **allow_add**: Whether or not an identity can be added
260
+ */
261
+ get: operations["get_identity_set_preferences_v2_preferences_get"];
262
+ /**
263
+ * Set the preferences for your identity set.
264
+ * @description This endpoint allows users to set preferences for each of their
265
+ * identities that affect how their identity can be used in groups.
266
+ * Currently, the supported preferences are:
267
+ *
268
+ * - **allow_add**: Whether or not an identity can be added
269
+ */
270
+ put: operations["put_identity_set_preferences_v2_preferences_put"];
271
+ post?: never;
272
+ delete?: never;
273
+ options?: never;
274
+ head?: never;
275
+ patch?: never;
276
+ trace?: never;
277
+ };
278
+ "/v2/groups/{group_id}/membership_fields": {
279
+ parameters: {
280
+ query?: never;
281
+ header?: never;
282
+ path?: never;
283
+ cookie?: never;
284
+ };
285
+ /**
286
+ * Get the membership fields for your identity set.
287
+ * @description This endpoint allows users to get preferences for each of their identities
288
+ * that affect how their identity can be used in groups. Currently, the
289
+ * supported preferences are:
290
+ */
291
+ get: operations["get_membership_fields_v2_groups__group_id__membership_fields_get"];
292
+ /**
293
+ * Set the membership fields for your identity set.
294
+ * @description This endpoint allows users to set preferences for each of their identities
295
+ * that affect how their identity can be used in groups. Currently, the supported
296
+ * preferences are:
297
+ */
298
+ put: operations["put_membership_fields_v2_groups__group_id__membership_fields_put"];
299
+ post?: never;
300
+ delete?: never;
301
+ options?: never;
302
+ head?: never;
303
+ patch?: never;
304
+ trace?: never;
305
+ };
306
+ "/v2/subscription_info/{subscription_id}": {
307
+ parameters: {
308
+ query?: never;
309
+ header?: never;
310
+ path?: never;
311
+ cookie?: never;
312
+ };
313
+ /**
314
+ * Get groups by subscription_id
315
+ * @description This endpoint allows users to retrieve limited information about all groups that
316
+ * have the given subscription_id. Currently, the fields returned for each group are:
317
+ *
318
+ * - **group_id**: The unique UUID for the group
319
+ * - **subscription_id**: The unique UUID for the subscription; identical to the id
320
+ * provided in the request
321
+ * - **subscription_info**: Basic information about the subscription; excludes the
322
+ * subscription name for privacy purposes
323
+ */
324
+ get: operations["get_group_by_subscription_id_v2_subscription_info__subscription_id__get"];
325
+ put?: never;
326
+ post?: never;
327
+ delete?: never;
328
+ options?: never;
329
+ head?: never;
330
+ patch?: never;
331
+ trace?: never;
332
+ };
333
+ "/v2/groups/{group_id}/subscription_admin_verified": {
334
+ parameters: {
335
+ query?: never;
336
+ header?: never;
337
+ path?: never;
338
+ cookie?: never;
339
+ };
340
+ get?: never;
341
+ /**
342
+ * Update the subscription_admin_verified_id
343
+ * @description Update the subscription_admin_verified_id on a group.
344
+ *
345
+ * If the group already has a subscription_admin_verified_id associated with it, then
346
+ * the user must be an admin of the subscription group whose subscription_id
347
+ * corresponds to the old value.
348
+ *
349
+ * If the user is setting the subscription_admin_verified_id to a non-null value,
350
+ * then they must be an admin of the subscription group whose subscription_id
351
+ * corresponds to the new value.
352
+ *
353
+ * Group admins can clear the value by using the regular groups update endpoint.
354
+ */
355
+ put: operations["update_subscription_admin_verified_id_v2_groups__group_id__subscription_admin_verified_put"];
356
+ post?: never;
357
+ delete?: never;
358
+ options?: never;
359
+ head?: never;
360
+ patch?: never;
361
+ trace?: never;
362
+ };
363
+ }
364
+ export type webhooks = Record<string, never>;
365
+ export interface components {
366
+ schemas: {
367
+ /**
368
+ * AllowedActionsModel
369
+ * @description Specifies which identities associated with the current token, if any, are
370
+ * in principle allowed to perform various actions.
371
+ *
372
+ * Attempting to perform an action which no identity has permissions for is a
373
+ * transactional error, and the entire request will fail.
374
+ */
375
+ AllowedActionsModel: {
376
+ /**
377
+ * Add
378
+ * @description User's identities which are allowed to add members to the group.
379
+ */
380
+ add: string[];
381
+ /**
382
+ * Change Role
383
+ * @description User's identities which are allowed to change group members' roles.
384
+ */
385
+ change_role: string[];
386
+ /**
387
+ * Invite
388
+ * @description User's identities which are allowed to invite members to the group.
389
+ */
390
+ invite: string[];
391
+ /**
392
+ * Remove
393
+ * @description User's identities which are allowed to remove members from the group.
394
+ */
395
+ remove: string[];
396
+ /**
397
+ * Join
398
+ * @description User's identities which can join the group, becoming active members.
399
+ */
400
+ join: string[];
401
+ /**
402
+ * Request Join
403
+ * @description User's identities which can request to join the group, pending admin/manager approval.
404
+ */
405
+ request_join: string[];
406
+ /**
407
+ * Approve
408
+ * @description Identities that are approved to join the group.
409
+ */
410
+ approve: string[];
411
+ /**
412
+ * Reject
413
+ * @description Identities that are rejected from joining the group.
414
+ */
415
+ reject: string[];
416
+ /**
417
+ * Accept
418
+ * @description User's identities which can accept an invitation to the group, pending admin/manager approval.
419
+ */
420
+ accept: string[];
421
+ /**
422
+ * Leave
423
+ * @description User's active identities which can leave the group.
424
+ */
425
+ leave: string[];
426
+ /**
427
+ * Decline
428
+ * @description User's invited identities which can decline an invitation.
429
+ */
430
+ decline: string[];
431
+ };
432
+ /** AuthErrorModel */
433
+ AuthErrorModel: {
434
+ /**
435
+ * Code
436
+ * @description A machine parsable string representing the type of error.
437
+ */
438
+ code: string;
439
+ /**
440
+ * Detail
441
+ * @description A human readable explanation of the error.
442
+ */
443
+ detail: string;
444
+ /** @description Additional fields in compliance with the Globus Auth Requirements Error format. */
445
+ authorization_parameters: components["schemas"]["AuthParamsModel"];
446
+ };
447
+ /** AuthParamsModel */
448
+ AuthParamsModel: {
449
+ /**
450
+ * Session Message
451
+ * @description A message to be displayed to the user.
452
+ */
453
+ session_message?: string;
454
+ /**
455
+ * Session Required Identities
456
+ * @description A list of identities required for the session.
457
+ */
458
+ session_required_identities?: string[];
459
+ /**
460
+ * Session Required Policies
461
+ * @description A list of policies required for the session.
462
+ */
463
+ session_required_policies?: string[];
464
+ /**
465
+ * Session Required Single Domain
466
+ * @description A list of domains required for the session.
467
+ */
468
+ session_required_single_domain?: string[];
469
+ /**
470
+ * Session Required Mfa
471
+ * @description Whether MFA is required for the session.
472
+ */
473
+ session_required_mfa?: boolean;
474
+ /**
475
+ * Required Scopes
476
+ * @description A list of scopes for which consent is required.
477
+ */
478
+ required_scopes?: string[];
479
+ /**
480
+ * Extra
481
+ * @description A dictionary of additional fields that were provided.
482
+ */
483
+ extra?: {
484
+ [key: string]: unknown;
485
+ };
486
+ };
487
+ /** BadRequestErrorModel */
488
+ BadRequestErrorModel: {
489
+ /**
490
+ * Code
491
+ * @description A machine parsable string representing the type of error.
492
+ */
493
+ code: string;
494
+ /**
495
+ * Detail
496
+ * @description A human readable explanation of the error.
497
+ */
498
+ detail: string;
499
+ /**
500
+ * Ambiguous Identities
501
+ * @description List of duplicate identities that caused the exception.
502
+ */
503
+ ambiguous_identities: string[];
504
+ };
505
+ /** BaseErrorModel */
506
+ BaseErrorModel: {
507
+ /**
508
+ * Code
509
+ * @description A machine parsable string representing the type of error.
510
+ */
511
+ code: string;
512
+ /**
513
+ * Detail
514
+ * @description A human readable explanation of the error.
515
+ */
516
+ detail: string;
517
+ };
518
+ /** ConnectorSubscriptionInfo */
519
+ ConnectorSubscriptionInfo: {
520
+ /**
521
+ * Is Ha
522
+ * @description True if HA connector subscription.
523
+ */
524
+ is_ha: boolean;
525
+ /**
526
+ * Is Baa
527
+ * @description True if BAA connector subscription.
528
+ */
529
+ is_baa: boolean;
530
+ };
531
+ /** ForbiddenErrorModel */
532
+ ForbiddenErrorModel: {
533
+ /**
534
+ * Code
535
+ * @description A machine parsable string representing the type of error.
536
+ */
537
+ code: string;
538
+ /**
539
+ * Detail
540
+ * @description A human readable explanation of the error.
541
+ */
542
+ detail: string;
543
+ /**
544
+ * Provided Scopes
545
+ * @description List of all scopes provided to the user.
546
+ */
547
+ provided_scopes?: string[] | null;
548
+ };
549
+ /** GroupChildrenReadModel */
550
+ GroupChildrenReadModel: {
551
+ /**
552
+ * Children
553
+ * @description The children of the group.
554
+ */
555
+ children: components["schemas"]["GroupReadModel"][];
556
+ };
557
+ /** GroupCreateModel */
558
+ GroupCreateModel: {
559
+ /**
560
+ * Description
561
+ * @description The description of the group.
562
+ */
563
+ description?: string | null;
564
+ /**
565
+ * Terms And Conditions
566
+ * @description The terms and conditions for group membership
567
+ */
568
+ terms_and_conditions?: string | null;
569
+ /**
570
+ * Name
571
+ * @description The name of the group.
572
+ */
573
+ name: string;
574
+ /**
575
+ * Parent Id
576
+ * @description The ID of the parent of the group to be created. The identity creating this group must be an admin of the parent group.
577
+ */
578
+ parent_id?: string | null;
579
+ /** @description Policies for the group regarding members etc. */
580
+ policies?: components["schemas"]["GroupPolicyWriteModel"];
581
+ };
582
+ /**
583
+ * GroupMemberVisibilityPolicyEnum
584
+ * @description Who can view group memberships.
585
+ *
586
+ * - **members**: All members of the group.
587
+ * - **managers**: Only admins and managers.
588
+ * @enum {string}
589
+ */
590
+ GroupMemberVisibilityPolicyEnum: "members" | "managers";
591
+ /** GroupMembershipPostAction */
592
+ GroupMembershipPostAction: {
593
+ /**
594
+ * Accept
595
+ * @description List of identities that have been invited and should be accepted to the group.
596
+ */
597
+ accept?: components["schemas"]["MembershipActionStatusModel"][] | null;
598
+ /**
599
+ * Add
600
+ * @description List of identities to add as active members of the group
601
+ */
602
+ add?: components["schemas"]["MembershipActionStatusAndRoleModel"][] | null;
603
+ /**
604
+ * Change Role
605
+ * @description List of identities whose roles are to be changed
606
+ */
607
+ change_role?: components["schemas"]["MembershipsActionChangeRoleModel"][] | null;
608
+ /**
609
+ * Decline
610
+ * @description List of identities that are declining an invitation to join.
611
+ */
612
+ decline?: components["schemas"]["MembershipActionStatusModel"][] | null;
613
+ /**
614
+ * Invite
615
+ * @description List of identities to invite to the group.
616
+ */
617
+ invite?: components["schemas"]["MembershipActionInviteModel"][] | null;
618
+ /**
619
+ * Leave
620
+ * @description List of user's active memberships to leave the group
621
+ */
622
+ leave?: components["schemas"]["MembershipActionStatusModel"][] | null;
623
+ /**
624
+ * Join
625
+ * @description List of identities that will join the group if policies allow directly joining. These must be identities in the authenticated user's identity set.
626
+ */
627
+ join?: components["schemas"]["MembershipActionBaseModel"][] | null;
628
+ /**
629
+ * Remove
630
+ * @description List of identities to remove from the group
631
+ */
632
+ remove?: components["schemas"]["MembershipActionStatusModel"][] | null;
633
+ /**
634
+ * Request Join
635
+ * @description List of identities that are requesting to join the group. These must be identities in the authenticated user's identity set.
636
+ */
637
+ request_join?: components["schemas"]["MembershipActionBaseModel"][] | null;
638
+ /**
639
+ * Approve
640
+ * @description List of pending identities that will be approved to join the group.
641
+ */
642
+ approve?: components["schemas"]["MembershipActionStatusModel"][] | null;
643
+ /**
644
+ * Reject
645
+ * @description List of pending identities that will be rejected from joining the group.
646
+ */
647
+ reject?: components["schemas"]["MembershipActionStatusModel"][] | null;
648
+ };
649
+ /** GroupMembershipPostActionErrors */
650
+ GroupMembershipPostActionErrors: {
651
+ /** Accept */
652
+ accept?: components["schemas"]["MembershipError"][] | null;
653
+ /** Add */
654
+ add?: components["schemas"]["MembershipError"][] | null;
655
+ /** Change Role */
656
+ change_role?: components["schemas"]["MembershipError"][] | null;
657
+ /** Decline */
658
+ decline?: components["schemas"]["MembershipError"][] | null;
659
+ /** Invite */
660
+ invite?: components["schemas"]["MembershipError"][] | null;
661
+ /** Join */
662
+ join?: components["schemas"]["MembershipError"][] | null;
663
+ /** Leave */
664
+ leave?: components["schemas"]["MembershipError"][] | null;
665
+ /** Remove */
666
+ remove?: components["schemas"]["MembershipError"][] | null;
667
+ /** Request Join */
668
+ request_join?: components["schemas"]["MembershipError"][] | null;
669
+ /** Approve */
670
+ approve?: components["schemas"]["MembershipError"][] | null;
671
+ /** Reject */
672
+ reject?: components["schemas"]["MembershipError"][] | null;
673
+ };
674
+ /** GroupMembershipPostActionResponse */
675
+ GroupMembershipPostActionResponse: {
676
+ /** Accept */
677
+ accept?: components["schemas"]["MembershipReadModel"][] | null;
678
+ /** Add */
679
+ add?: components["schemas"]["MembershipReadModel"][] | null;
680
+ /** Change Role */
681
+ change_role?: components["schemas"]["MembershipReadModel"][] | null;
682
+ /** Decline */
683
+ decline?: components["schemas"]["MembershipReadModel"][] | null;
684
+ /** Invite */
685
+ invite?: components["schemas"]["MembershipReadModel"][] | null;
686
+ /** Join */
687
+ join?: components["schemas"]["MembershipReadModel"][] | null;
688
+ /** Leave */
689
+ leave?: components["schemas"]["MembershipReadModel"][] | null;
690
+ /** Remove */
691
+ remove?: components["schemas"]["MembershipReadModel"][] | null;
692
+ /** Request Join */
693
+ request_join?: components["schemas"]["MembershipReadModel"][] | null;
694
+ /** Approve */
695
+ approve?: components["schemas"]["MembershipReadModel"][] | null;
696
+ /** Reject */
697
+ reject?: components["schemas"]["MembershipReadModel"][] | null;
698
+ errors?: components["schemas"]["GroupMembershipPostActionErrors"] | null;
699
+ };
700
+ /** GroupPolicyReadModel */
701
+ GroupPolicyReadModel: {
702
+ /** Is High Assurance */
703
+ is_high_assurance: boolean;
704
+ /**
705
+ * Authentication Assurance Timeout
706
+ * @description Maximum allowed seconds before a user must reauthenticate to access the group if is set to High Assurance. Defaults to 28800 for HA groups.
707
+ */
708
+ authentication_assurance_timeout?: number | null;
709
+ group_visibility: components["schemas"]["GroupVisibilityPolicyEnum"];
710
+ group_members_visibility: components["schemas"]["GroupMemberVisibilityPolicyEnum"];
711
+ /**
712
+ * Join Requests
713
+ * @description If true then users may request to join the group.
714
+ */
715
+ join_requests?: boolean;
716
+ /** Signup Fields */
717
+ signup_fields: components["schemas"]["SignupFieldsEnum"][];
718
+ };
719
+ /** GroupPolicyWriteModel */
720
+ GroupPolicyWriteModel: {
721
+ /** Is High Assurance */
722
+ is_high_assurance?: boolean | null;
723
+ /**
724
+ * Authentication Assurance Timeout
725
+ * @description Maximum allowed seconds before a user must reauthenticate to access the group if is set to High Assurance. Defaults to 28800 for HA groups.
726
+ */
727
+ authentication_assurance_timeout?: number | null;
728
+ group_visibility?: components["schemas"]["GroupVisibilityPolicyEnum"] | null;
729
+ group_members_visibility?: components["schemas"]["GroupMemberVisibilityPolicyEnum"] | null;
730
+ /**
731
+ * Join Requests
732
+ * @description If true then users may request to join the group.
733
+ */
734
+ join_requests?: boolean | null;
735
+ /** Signup Fields */
736
+ signup_fields?: components["schemas"]["SignupFieldsEnum"][] | null;
737
+ };
738
+ /** GroupReadModel */
739
+ GroupReadModel: {
740
+ /**
741
+ * Description
742
+ * @description The description of the group.
743
+ */
744
+ description?: string | null;
745
+ /**
746
+ * Terms And Conditions
747
+ * @description The terms and conditions for group membership
748
+ */
749
+ terms_and_conditions?: string | null;
750
+ /**
751
+ * Name
752
+ * @description The name of the group.
753
+ */
754
+ name: string;
755
+ /**
756
+ * Id
757
+ * Format: uuid
758
+ * @description The ID of the group.
759
+ */
760
+ id: string;
761
+ /**
762
+ * @description The type of group (regular or Globus Plus).
763
+ * @default regular
764
+ */
765
+ group_type: components["schemas"]["GroupTypeEnum"];
766
+ /**
767
+ * Child Ids
768
+ * @description IDs of the children groups (some of the groups in this list might be private).
769
+ */
770
+ child_ids?: string[] | null;
771
+ /**
772
+ * Enforce Session
773
+ * @default false
774
+ */
775
+ enforce_session: boolean;
776
+ /**
777
+ * Session Limit
778
+ * @description Number of seconds required for most recent authentication token
779
+ */
780
+ session_limit?: number | null;
781
+ /**
782
+ * Session Timeouts
783
+ * @description A mapping of identity_ids to data about when that identity's authentication falls out of this group's session limit. Only identities in the session will be included here.
784
+ * @default {}
785
+ */
786
+ session_timeouts: {
787
+ [key: string]: components["schemas"]["TimeoutData"];
788
+ };
789
+ /**
790
+ * My Memberships
791
+ * @description Optional list of memberships the authenticated user has in the group.
792
+ */
793
+ my_memberships?: components["schemas"]["MembershipReadModel"][] | null;
794
+ /**
795
+ * Memberships
796
+ * @description Optional list of all memberships in the group.
797
+ */
798
+ memberships?: components["schemas"]["MembershipReadModel"][] | null;
799
+ /** @description The actions allowed for the authenticated user's identities. This is intended to assist clients in determining which actions are possible for a given user. */
800
+ allowed_actions?: components["schemas"]["AllowedActionsModel"] | null;
801
+ /**
802
+ * Subscription Id
803
+ * @description The subscription ID
804
+ */
805
+ subscription_id?: string | null;
806
+ /** @description Detailed information regarding the subscription. */
807
+ subscription_info?: components["schemas"]["SubscriptionModel"] | null;
808
+ /** @description Policies for the group regarding members etc. */
809
+ policies?: components["schemas"]["GroupPolicyReadModel"];
810
+ /**
811
+ * Parent Id
812
+ * @description The ID of the parent of the group to be created. The identity creating this group must be an admin of the parent group.
813
+ */
814
+ parent_id: string | null;
815
+ /**
816
+ * Subscription Admin Verified Id
817
+ * @description The ID of the subscription whose admin has verified this resource.
818
+ */
819
+ subscription_admin_verified_id?: string | null;
820
+ };
821
+ /** GroupStatusCounts */
822
+ GroupStatusCounts: {
823
+ /**
824
+ * Active
825
+ * @description Count of active group members
826
+ * @default 0
827
+ */
828
+ active: number;
829
+ /**
830
+ * Invited
831
+ * @description Count of identities invited to join the group.
832
+ * @default 0
833
+ */
834
+ invited: number;
835
+ /**
836
+ * Pending
837
+ * @description Count of identities pending acceptance to join the group.
838
+ * @default 0
839
+ */
840
+ pending: number;
841
+ /**
842
+ * Rejected
843
+ * @description Count of indentities that were rejected.
844
+ * @default 0
845
+ */
846
+ rejected: number;
847
+ /**
848
+ * Removed
849
+ * @description Count of former group members who were removed.
850
+ * @default 0
851
+ */
852
+ removed: number;
853
+ /**
854
+ * Left
855
+ * @description Count of former group members who left the group.
856
+ * @default 0
857
+ */
858
+ left: number;
859
+ /**
860
+ * Declined
861
+ * @description Count of declined group members.
862
+ * @default 0
863
+ */
864
+ declined: number;
865
+ };
866
+ /** GroupSubscriptionModel */
867
+ GroupSubscriptionModel: {
868
+ /**
869
+ * Group Id
870
+ * Format: uuid
871
+ * @description The ID of the group.
872
+ */
873
+ group_id: string;
874
+ /**
875
+ * Subscription Id
876
+ * Format: uuid
877
+ * @description The subscription ID
878
+ */
879
+ subscription_id: string;
880
+ /** @description Detailed information regarding the subscription. */
881
+ subscription_info: components["schemas"]["SubscriptionModelLimited"];
882
+ };
883
+ /**
884
+ * GroupTypeEnum
885
+ * @enum {string}
886
+ */
887
+ GroupTypeEnum: "regular" | "plus";
888
+ /**
889
+ * GroupVisibilityPolicyEnum
890
+ * @description Who can view the group.
891
+ *
892
+ * - **authenticated**: Any authenticated user.
893
+ * - **private**: Only active/invited/pending members of the group.
894
+ * @enum {string}
895
+ */
896
+ GroupVisibilityPolicyEnum: "authenticated" | "private";
897
+ /** GroupWriteModel */
898
+ GroupWriteModel: {
899
+ /**
900
+ * Description
901
+ * @description The description of the group.
902
+ */
903
+ description?: string | null;
904
+ /**
905
+ * Terms And Conditions
906
+ * @description The terms and conditions for group membership
907
+ */
908
+ terms_and_conditions?: string | null;
909
+ /**
910
+ * Name
911
+ * @description The name of the group.
912
+ */
913
+ name?: string | null;
914
+ /**
915
+ * Subscription Admin Verified Id
916
+ * @description The ID of the subscription whose admin has verified this resource.
917
+ */
918
+ subscription_admin_verified_id?: string | null;
919
+ };
920
+ /** HTTPValidationError */
921
+ HTTPValidationError: {
922
+ /** Detail */
923
+ detail?: components["schemas"]["ValidationError"][];
924
+ };
925
+ /** IdentityPreferences */
926
+ IdentityPreferences: {
927
+ /**
928
+ * Allow Add
929
+ * @description If false, then this identity can not be added directly to a group by an admin.
930
+ */
931
+ allow_add: boolean | null;
932
+ };
933
+ /** MembershipActionBaseModel */
934
+ MembershipActionBaseModel: {
935
+ /**
936
+ * Identity Id
937
+ * Format: uuid
938
+ * @description The identity of the user whose membership is being created or updated.
939
+ */
940
+ identity_id: string;
941
+ };
942
+ /** MembershipActionInviteModel */
943
+ MembershipActionInviteModel: {
944
+ /**
945
+ * @description The membership role for the user that is being added, invited, or changed.
946
+ * @default member
947
+ */
948
+ role: components["schemas"]["RoleEnum"] | null;
949
+ /**
950
+ * Identity Id
951
+ * Format: uuid
952
+ * @description The identity of the user whose membership is being created or updated.
953
+ */
954
+ identity_id: string;
955
+ /**
956
+ * Status Reason
957
+ * @description The reason provided when changing the member status.
958
+ */
959
+ status_reason?: string | null;
960
+ /**
961
+ * Invite Email Address
962
+ * @description Send the group invitation to the specified email address.
963
+ */
964
+ invite_email_address?: string | null;
965
+ };
966
+ /** MembershipActionStatusAndRoleModel */
967
+ MembershipActionStatusAndRoleModel: {
968
+ /**
969
+ * @description The membership role for the user that is being added, invited, or changed.
970
+ * @default member
971
+ */
972
+ role: components["schemas"]["RoleEnum"] | null;
973
+ /**
974
+ * Identity Id
975
+ * Format: uuid
976
+ * @description The identity of the user whose membership is being created or updated.
977
+ */
978
+ identity_id: string;
979
+ /**
980
+ * Status Reason
981
+ * @description The reason provided when changing the member status.
982
+ */
983
+ status_reason?: string | null;
984
+ };
985
+ /** MembershipActionStatusModel */
986
+ MembershipActionStatusModel: {
987
+ /**
988
+ * Identity Id
989
+ * Format: uuid
990
+ * @description The identity of the user whose membership is being created or updated.
991
+ */
992
+ identity_id: string;
993
+ /**
994
+ * Status Reason
995
+ * @description The reason provided when changing the member status.
996
+ */
997
+ status_reason?: string | null;
998
+ };
999
+ /** MembershipError */
1000
+ MembershipError: {
1001
+ /**
1002
+ * Identity Id
1003
+ * @description The identity from the request that caused the error.
1004
+ */
1005
+ identity_id: string;
1006
+ /**
1007
+ * Code
1008
+ * @description A machine parsable string representing the type of error.
1009
+ */
1010
+ code: string;
1011
+ /**
1012
+ * Detail
1013
+ * @description A human readable explanation of the error.
1014
+ */
1015
+ detail: string;
1016
+ };
1017
+ /** MembershipFields */
1018
+ MembershipFields: {
1019
+ /** First Name */
1020
+ first_name?: string | null;
1021
+ /** Last Name */
1022
+ last_name?: string | null;
1023
+ /** Organization */
1024
+ organization?: string | null;
1025
+ /** Institution */
1026
+ institution?: string | null;
1027
+ /** Current Project Name */
1028
+ current_project_name?: string | null;
1029
+ /** Address */
1030
+ address?: string | null;
1031
+ /** City */
1032
+ city?: string | null;
1033
+ /** State */
1034
+ state?: string | null;
1035
+ /** Country */
1036
+ country?: string | null;
1037
+ /** Address1 */
1038
+ address1?: string | null;
1039
+ /** Address2 */
1040
+ address2?: string | null;
1041
+ /** Zip */
1042
+ zip?: string | null;
1043
+ /** Phone */
1044
+ phone?: string | null;
1045
+ /** Department */
1046
+ department?: string | null;
1047
+ /** Field Of Science */
1048
+ field_of_science?: string | null;
1049
+ };
1050
+ /** MembershipReadModel */
1051
+ MembershipReadModel: {
1052
+ /**
1053
+ * Group Id
1054
+ * Format: uuid
1055
+ * @description The id of the group the member belongs to.
1056
+ */
1057
+ group_id: string;
1058
+ /**
1059
+ * Source Group Id
1060
+ * Format: uuid
1061
+ * @description The subgroup that the identity is a member of causing membership to be implied in this group.
1062
+ */
1063
+ source_group_id?: string;
1064
+ /**
1065
+ * Identity Id
1066
+ * Format: uuid
1067
+ * @description The identity of the user that is a member.
1068
+ */
1069
+ identity_id: string;
1070
+ /**
1071
+ * Username
1072
+ * @description The username of the user that is a member.
1073
+ */
1074
+ username: string;
1075
+ /** @description The role of the member in the group. */
1076
+ role: components["schemas"]["RoleEnum"];
1077
+ /** @description The status of the member in the group. */
1078
+ status: components["schemas"]["StatusEnum"];
1079
+ /**
1080
+ * Status Reason
1081
+ * @description The reason provided when changing the member status.
1082
+ */
1083
+ status_reason?: string | null;
1084
+ /**
1085
+ * Invite Email Address
1086
+ * @description Email address for the group invitation.
1087
+ */
1088
+ invite_email_address?: string | null;
1089
+ /**
1090
+ * Updated
1091
+ * @description RFC 8601 format date and time when the membership was last updated.
1092
+ */
1093
+ updated?: string | null;
1094
+ /**
1095
+ * Invite Time
1096
+ * @description RFC 8601 format date and time when the user was invited to the group.
1097
+ */
1098
+ invite_time?: string | null;
1099
+ /**
1100
+ * Membership Fields
1101
+ * @description The additional sign-up fields required by the group.
1102
+ * @default {}
1103
+ */
1104
+ membership_fields: {
1105
+ [key: string]: unknown;
1106
+ } | null;
1107
+ };
1108
+ /** MembershipsActionChangeRoleModel */
1109
+ MembershipsActionChangeRoleModel: {
1110
+ /**
1111
+ * @description The membership role for the user that is being added, invited, or changed.
1112
+ * @default member
1113
+ */
1114
+ role: components["schemas"]["RoleEnum"] | null;
1115
+ /**
1116
+ * Identity Id
1117
+ * Format: uuid
1118
+ * @description The identity of the user whose membership is being created or updated.
1119
+ */
1120
+ identity_id: string;
1121
+ };
1122
+ /**
1123
+ * RoleEnum
1124
+ * @enum {string}
1125
+ */
1126
+ RoleEnum: "member" | "manager" | "admin";
1127
+ /**
1128
+ * SignupFieldsEnum
1129
+ * @description The available signup fields.
1130
+ * @enum {string}
1131
+ */
1132
+ SignupFieldsEnum: "institution" | "current_project_name" | "address" | "city" | "state" | "country" | "address1" | "address2" | "zip" | "phone" | "department" | "field_of_science";
1133
+ /**
1134
+ * StatusEnum
1135
+ * @enum {string}
1136
+ */
1137
+ StatusEnum: "active" | "invited" | "pending" | "rejected" | "removed" | "left" | "declined";
1138
+ /** SubscriptionModel */
1139
+ SubscriptionModel: {
1140
+ /**
1141
+ * Name
1142
+ * @description The subscription name.
1143
+ */
1144
+ name: string;
1145
+ /**
1146
+ * Subscriber Name
1147
+ * @description The subscriber's name.
1148
+ */
1149
+ subscriber_name: string;
1150
+ /**
1151
+ * Is High Assurance
1152
+ * @description True if HA subscriber.
1153
+ * @default false
1154
+ */
1155
+ is_high_assurance: boolean;
1156
+ /**
1157
+ * Is Baa
1158
+ * @description True if BAA subscriber.
1159
+ * @default false
1160
+ */
1161
+ is_baa: boolean;
1162
+ /**
1163
+ * Connectors
1164
+ * @description A mapping of connector UUIDs to connector subscription data.
1165
+ * @default {}
1166
+ */
1167
+ connectors: {
1168
+ [key: string]: components["schemas"]["ConnectorSubscriptionInfo"];
1169
+ };
1170
+ };
1171
+ /** SubscriptionModelLimited */
1172
+ SubscriptionModelLimited: {
1173
+ /**
1174
+ * Is High Assurance
1175
+ * @description True if HA subscriber.
1176
+ * @default false
1177
+ */
1178
+ is_high_assurance: boolean;
1179
+ /**
1180
+ * Is Baa
1181
+ * @description True if BAA subscriber.
1182
+ * @default false
1183
+ */
1184
+ is_baa: boolean;
1185
+ /**
1186
+ * Connectors
1187
+ * @description A mapping of connector UUIDs to connector subscription data.
1188
+ * @default {}
1189
+ */
1190
+ connectors: {
1191
+ [key: string]: components["schemas"]["ConnectorSubscriptionInfo"];
1192
+ };
1193
+ };
1194
+ /** SubscriptionVerifiedReadModel */
1195
+ SubscriptionVerifiedReadModel: {
1196
+ /**
1197
+ * Subscription Admin Verified Id
1198
+ * @description The ID of the subscription whose admin has verified this resource.
1199
+ */
1200
+ subscription_admin_verified_id: string | null;
1201
+ /**
1202
+ * Group Id
1203
+ * Format: uuid
1204
+ * @description The ID of the group.
1205
+ */
1206
+ group_id: string;
1207
+ };
1208
+ /** SubscriptionVerifiedWriteModel */
1209
+ SubscriptionVerifiedWriteModel: {
1210
+ /**
1211
+ * Subscription Admin Verified Id
1212
+ * @description The ID of the subscription whose admin has verified this resource.
1213
+ */
1214
+ subscription_admin_verified_id: string | null;
1215
+ };
1216
+ /** TimeoutData */
1217
+ TimeoutData: {
1218
+ /**
1219
+ * Expire Time
1220
+ * Format: date-time
1221
+ * @description RFC 8601 format date and time when the identity will have passed the session limit
1222
+ */
1223
+ expire_time: string;
1224
+ /**
1225
+ * Expires In
1226
+ * @description Seconds until authentication will have passed the session limit.
1227
+ */
1228
+ expires_in: number;
1229
+ };
1230
+ /** ValidationError */
1231
+ ValidationError: {
1232
+ /** Location */
1233
+ loc: (string | number)[];
1234
+ /** Message */
1235
+ msg: string;
1236
+ /** Error Type */
1237
+ type: string;
1238
+ };
1239
+ };
1240
+ responses: never;
1241
+ parameters: never;
1242
+ requestBodies: never;
1243
+ headers: never;
1244
+ pathItems: never;
1245
+ }
1246
+ export type $defs = Record<string, never>;
1247
+ export interface operations {
1248
+ get_my_groups_and_memberships_v2_groups_my_groups_get: {
1249
+ parameters: {
1250
+ query?: {
1251
+ /** @description Form-encoded or comma-separated list of statuses. Memberships with these statuses will be included in the memberships array. Valid values are `active`, `invited`, `pending`, `rejected`, `removed`, `left`, and `declined`. */
1252
+ statuses?: string[];
1253
+ };
1254
+ header?: never;
1255
+ path?: never;
1256
+ cookie?: never;
1257
+ };
1258
+ requestBody?: never;
1259
+ responses: {
1260
+ /** @description Successful Response */
1261
+ 200: {
1262
+ headers: {
1263
+ [name: string]: unknown;
1264
+ };
1265
+ content: {
1266
+ "application/json": components["schemas"]["GroupReadModel"][];
1267
+ };
1268
+ };
1269
+ /** @description Unauthorized */
1270
+ 401: {
1271
+ headers: {
1272
+ [name: string]: unknown;
1273
+ };
1274
+ content: {
1275
+ "application/json": components["schemas"]["AuthErrorModel"];
1276
+ };
1277
+ };
1278
+ /** @description Forbidden */
1279
+ 403: {
1280
+ headers: {
1281
+ [name: string]: unknown;
1282
+ };
1283
+ content: {
1284
+ "application/json": components["schemas"]["ForbiddenErrorModel"];
1285
+ };
1286
+ };
1287
+ /** @description Not Found */
1288
+ 404: {
1289
+ headers: {
1290
+ [name: string]: unknown;
1291
+ };
1292
+ content: {
1293
+ "application/json": components["schemas"]["BaseErrorModel"];
1294
+ };
1295
+ };
1296
+ /** @description Unprocessable Entity */
1297
+ 422: {
1298
+ headers: {
1299
+ [name: string]: unknown;
1300
+ };
1301
+ content: {
1302
+ "application/json": components["schemas"]["BaseErrorModel"];
1303
+ };
1304
+ };
1305
+ /** @description Internal Server Error */
1306
+ 500: {
1307
+ headers: {
1308
+ [name: string]: unknown;
1309
+ };
1310
+ content: {
1311
+ "application/json": components["schemas"]["BaseErrorModel"];
1312
+ };
1313
+ };
1314
+ };
1315
+ };
1316
+ get_statuses_v2_groups_statuses_get: {
1317
+ parameters: {
1318
+ query?: never;
1319
+ header?: never;
1320
+ path?: never;
1321
+ cookie?: never;
1322
+ };
1323
+ requestBody?: never;
1324
+ responses: {
1325
+ /** @description A mapping from group_id to an object of status counts for memberships */
1326
+ 200: {
1327
+ headers: {
1328
+ [name: string]: unknown;
1329
+ };
1330
+ content: {
1331
+ "application/json": {
1332
+ [key: string]: components["schemas"]["GroupStatusCounts"];
1333
+ };
1334
+ };
1335
+ };
1336
+ /** @description Unauthorized */
1337
+ 401: {
1338
+ headers: {
1339
+ [name: string]: unknown;
1340
+ };
1341
+ content: {
1342
+ "application/json": components["schemas"]["AuthErrorModel"];
1343
+ };
1344
+ };
1345
+ /** @description Forbidden */
1346
+ 403: {
1347
+ headers: {
1348
+ [name: string]: unknown;
1349
+ };
1350
+ content: {
1351
+ "application/json": components["schemas"]["ForbiddenErrorModel"];
1352
+ };
1353
+ };
1354
+ /** @description Not Found */
1355
+ 404: {
1356
+ headers: {
1357
+ [name: string]: unknown;
1358
+ };
1359
+ content: {
1360
+ "application/json": components["schemas"]["BaseErrorModel"];
1361
+ };
1362
+ };
1363
+ /** @description Internal Server Error */
1364
+ 500: {
1365
+ headers: {
1366
+ [name: string]: unknown;
1367
+ };
1368
+ content: {
1369
+ "application/json": components["schemas"]["BaseErrorModel"];
1370
+ };
1371
+ };
1372
+ };
1373
+ };
1374
+ get_group_v2_groups__group_id__get: {
1375
+ parameters: {
1376
+ query?: {
1377
+ /** @description Form encoded or comma separated list of additional fields to include (allowed fields are `memberships`, `my_memberships`,`policies`, `allowed_actions`, and `child_ids` ) */
1378
+ include?: string[] | null;
1379
+ };
1380
+ header?: never;
1381
+ path: {
1382
+ group_id: string;
1383
+ };
1384
+ cookie?: never;
1385
+ };
1386
+ requestBody?: never;
1387
+ responses: {
1388
+ /** @description Successful Response */
1389
+ 200: {
1390
+ headers: {
1391
+ [name: string]: unknown;
1392
+ };
1393
+ content: {
1394
+ "application/json": components["schemas"]["GroupReadModel"];
1395
+ };
1396
+ };
1397
+ /** @description Unauthorized */
1398
+ 401: {
1399
+ headers: {
1400
+ [name: string]: unknown;
1401
+ };
1402
+ content: {
1403
+ "application/json": components["schemas"]["AuthErrorModel"];
1404
+ };
1405
+ };
1406
+ /** @description Forbidden */
1407
+ 403: {
1408
+ headers: {
1409
+ [name: string]: unknown;
1410
+ };
1411
+ content: {
1412
+ "application/json": components["schemas"]["ForbiddenErrorModel"];
1413
+ };
1414
+ };
1415
+ /** @description Not Found */
1416
+ 404: {
1417
+ headers: {
1418
+ [name: string]: unknown;
1419
+ };
1420
+ content: {
1421
+ "application/json": components["schemas"]["BaseErrorModel"];
1422
+ };
1423
+ };
1424
+ /** @description Validation Error */
1425
+ 422: {
1426
+ headers: {
1427
+ [name: string]: unknown;
1428
+ };
1429
+ content: {
1430
+ "application/json": components["schemas"]["HTTPValidationError"];
1431
+ };
1432
+ };
1433
+ /** @description Internal Server Error */
1434
+ 500: {
1435
+ headers: {
1436
+ [name: string]: unknown;
1437
+ };
1438
+ content: {
1439
+ "application/json": components["schemas"]["BaseErrorModel"];
1440
+ };
1441
+ };
1442
+ };
1443
+ };
1444
+ update_group_v2_groups__group_id__put: {
1445
+ parameters: {
1446
+ query?: never;
1447
+ header?: never;
1448
+ path: {
1449
+ group_id: string;
1450
+ };
1451
+ cookie?: never;
1452
+ };
1453
+ requestBody: {
1454
+ content: {
1455
+ "application/json": components["schemas"]["GroupWriteModel"];
1456
+ };
1457
+ };
1458
+ responses: {
1459
+ /** @description The updated group. */
1460
+ 200: {
1461
+ headers: {
1462
+ [name: string]: unknown;
1463
+ };
1464
+ content: {
1465
+ "application/json": components["schemas"]["GroupReadModel"];
1466
+ };
1467
+ };
1468
+ /** @description Unauthorized */
1469
+ 401: {
1470
+ headers: {
1471
+ [name: string]: unknown;
1472
+ };
1473
+ content: {
1474
+ "application/json": components["schemas"]["AuthErrorModel"];
1475
+ };
1476
+ };
1477
+ /** @description Forbidden */
1478
+ 403: {
1479
+ headers: {
1480
+ [name: string]: unknown;
1481
+ };
1482
+ content: {
1483
+ "application/json": components["schemas"]["ForbiddenErrorModel"];
1484
+ };
1485
+ };
1486
+ /** @description Not Found */
1487
+ 404: {
1488
+ headers: {
1489
+ [name: string]: unknown;
1490
+ };
1491
+ content: {
1492
+ "application/json": components["schemas"]["BaseErrorModel"];
1493
+ };
1494
+ };
1495
+ /** @description Validation Error */
1496
+ 422: {
1497
+ headers: {
1498
+ [name: string]: unknown;
1499
+ };
1500
+ content: {
1501
+ "application/json": components["schemas"]["HTTPValidationError"];
1502
+ };
1503
+ };
1504
+ /** @description Internal Server Error */
1505
+ 500: {
1506
+ headers: {
1507
+ [name: string]: unknown;
1508
+ };
1509
+ content: {
1510
+ "application/json": components["schemas"]["BaseErrorModel"];
1511
+ };
1512
+ };
1513
+ };
1514
+ };
1515
+ group_membership_post_actions_v2_groups__group_id__post: {
1516
+ parameters: {
1517
+ query?: never;
1518
+ header?: {
1519
+ "community-context"?: string | null;
1520
+ };
1521
+ path: {
1522
+ group_id: string;
1523
+ };
1524
+ cookie?: never;
1525
+ };
1526
+ requestBody: {
1527
+ content: {
1528
+ "application/json": components["schemas"]["GroupMembershipPostAction"];
1529
+ };
1530
+ };
1531
+ responses: {
1532
+ /** @description A list of the changed memberships and a list of errors that occurred */
1533
+ 200: {
1534
+ headers: {
1535
+ [name: string]: unknown;
1536
+ };
1537
+ content: {
1538
+ "application/json": components["schemas"]["GroupMembershipPostActionResponse"];
1539
+ };
1540
+ };
1541
+ /** @description Bad Request */
1542
+ 400: {
1543
+ headers: {
1544
+ [name: string]: unknown;
1545
+ };
1546
+ content: {
1547
+ "application/json": components["schemas"]["BadRequestErrorModel"];
1548
+ };
1549
+ };
1550
+ /** @description Unauthorized */
1551
+ 401: {
1552
+ headers: {
1553
+ [name: string]: unknown;
1554
+ };
1555
+ content: {
1556
+ "application/json": components["schemas"]["AuthErrorModel"];
1557
+ };
1558
+ };
1559
+ /** @description Forbidden */
1560
+ 403: {
1561
+ headers: {
1562
+ [name: string]: unknown;
1563
+ };
1564
+ content: {
1565
+ "application/json": components["schemas"]["ForbiddenErrorModel"];
1566
+ };
1567
+ };
1568
+ /** @description Not Found */
1569
+ 404: {
1570
+ headers: {
1571
+ [name: string]: unknown;
1572
+ };
1573
+ content: {
1574
+ "application/json": components["schemas"]["BaseErrorModel"];
1575
+ };
1576
+ };
1577
+ /** @description Conflict */
1578
+ 409: {
1579
+ headers: {
1580
+ [name: string]: unknown;
1581
+ };
1582
+ content: {
1583
+ "application/json": components["schemas"]["BaseErrorModel"];
1584
+ };
1585
+ };
1586
+ /** @description Validation Error */
1587
+ 422: {
1588
+ headers: {
1589
+ [name: string]: unknown;
1590
+ };
1591
+ content: {
1592
+ "application/json": components["schemas"]["HTTPValidationError"];
1593
+ };
1594
+ };
1595
+ /** @description Internal Server Error */
1596
+ 500: {
1597
+ headers: {
1598
+ [name: string]: unknown;
1599
+ };
1600
+ content: {
1601
+ "application/json": components["schemas"]["BaseErrorModel"];
1602
+ };
1603
+ };
1604
+ };
1605
+ };
1606
+ delete_group_v2_groups__group_id__delete: {
1607
+ parameters: {
1608
+ query?: never;
1609
+ header?: never;
1610
+ path: {
1611
+ group_id: string;
1612
+ };
1613
+ cookie?: never;
1614
+ };
1615
+ requestBody?: never;
1616
+ responses: {
1617
+ /** @description Successful Response */
1618
+ 200: {
1619
+ headers: {
1620
+ [name: string]: unknown;
1621
+ };
1622
+ content: {
1623
+ "application/json": components["schemas"]["GroupReadModel"];
1624
+ };
1625
+ };
1626
+ /** @description Bad Request */
1627
+ 400: {
1628
+ headers: {
1629
+ [name: string]: unknown;
1630
+ };
1631
+ content: {
1632
+ "application/json": components["schemas"]["BadRequestErrorModel"];
1633
+ };
1634
+ };
1635
+ /** @description Unauthorized */
1636
+ 401: {
1637
+ headers: {
1638
+ [name: string]: unknown;
1639
+ };
1640
+ content: {
1641
+ "application/json": components["schemas"]["AuthErrorModel"];
1642
+ };
1643
+ };
1644
+ /** @description Forbidden */
1645
+ 403: {
1646
+ headers: {
1647
+ [name: string]: unknown;
1648
+ };
1649
+ content: {
1650
+ "application/json": components["schemas"]["ForbiddenErrorModel"];
1651
+ };
1652
+ };
1653
+ /** @description Not Found */
1654
+ 404: {
1655
+ headers: {
1656
+ [name: string]: unknown;
1657
+ };
1658
+ content: {
1659
+ "application/json": components["schemas"]["BaseErrorModel"];
1660
+ };
1661
+ };
1662
+ /** @description Validation Error */
1663
+ 422: {
1664
+ headers: {
1665
+ [name: string]: unknown;
1666
+ };
1667
+ content: {
1668
+ "application/json": components["schemas"]["HTTPValidationError"];
1669
+ };
1670
+ };
1671
+ /** @description Internal Server Error */
1672
+ 500: {
1673
+ headers: {
1674
+ [name: string]: unknown;
1675
+ };
1676
+ content: {
1677
+ "application/json": components["schemas"]["BaseErrorModel"];
1678
+ };
1679
+ };
1680
+ };
1681
+ };
1682
+ get_children_v2_groups__group_id__children_get: {
1683
+ parameters: {
1684
+ query?: {
1685
+ /** @description Form encoded or comma separated list of additional fields to include (allowed fields are `memberships`, `my_memberships`,`policies`, `allowed_actions`, and `child_ids` ) */
1686
+ include?: string[] | null;
1687
+ };
1688
+ header?: never;
1689
+ path: {
1690
+ group_id: string;
1691
+ };
1692
+ cookie?: never;
1693
+ };
1694
+ requestBody?: never;
1695
+ responses: {
1696
+ /** @description Successful Response */
1697
+ 200: {
1698
+ headers: {
1699
+ [name: string]: unknown;
1700
+ };
1701
+ content: {
1702
+ "application/json": components["schemas"]["GroupChildrenReadModel"];
1703
+ };
1704
+ };
1705
+ /** @description Unauthorized */
1706
+ 401: {
1707
+ headers: {
1708
+ [name: string]: unknown;
1709
+ };
1710
+ content: {
1711
+ "application/json": components["schemas"]["AuthErrorModel"];
1712
+ };
1713
+ };
1714
+ /** @description Forbidden */
1715
+ 403: {
1716
+ headers: {
1717
+ [name: string]: unknown;
1718
+ };
1719
+ content: {
1720
+ "application/json": components["schemas"]["ForbiddenErrorModel"];
1721
+ };
1722
+ };
1723
+ /** @description Not Found */
1724
+ 404: {
1725
+ headers: {
1726
+ [name: string]: unknown;
1727
+ };
1728
+ content: {
1729
+ "application/json": components["schemas"]["BaseErrorModel"];
1730
+ };
1731
+ };
1732
+ /** @description Validation Error */
1733
+ 422: {
1734
+ headers: {
1735
+ [name: string]: unknown;
1736
+ };
1737
+ content: {
1738
+ "application/json": components["schemas"]["HTTPValidationError"];
1739
+ };
1740
+ };
1741
+ /** @description Internal Server Error */
1742
+ 500: {
1743
+ headers: {
1744
+ [name: string]: unknown;
1745
+ };
1746
+ content: {
1747
+ "application/json": components["schemas"]["BaseErrorModel"];
1748
+ };
1749
+ };
1750
+ };
1751
+ };
1752
+ create_group_v2_groups_post: {
1753
+ parameters: {
1754
+ query?: never;
1755
+ header?: never;
1756
+ path?: never;
1757
+ cookie?: never;
1758
+ };
1759
+ requestBody: {
1760
+ content: {
1761
+ "application/json": components["schemas"]["GroupCreateModel"];
1762
+ };
1763
+ };
1764
+ responses: {
1765
+ /** @description Successful Response */
1766
+ 201: {
1767
+ headers: {
1768
+ [name: string]: unknown;
1769
+ };
1770
+ content: {
1771
+ "application/json": components["schemas"]["GroupReadModel"];
1772
+ };
1773
+ };
1774
+ /** @description Bad Request */
1775
+ 400: {
1776
+ headers: {
1777
+ [name: string]: unknown;
1778
+ };
1779
+ content: {
1780
+ "application/json": components["schemas"]["BadRequestErrorModel"];
1781
+ };
1782
+ };
1783
+ /** @description Unauthorized */
1784
+ 401: {
1785
+ headers: {
1786
+ [name: string]: unknown;
1787
+ };
1788
+ content: {
1789
+ "application/json": components["schemas"]["AuthErrorModel"];
1790
+ };
1791
+ };
1792
+ /** @description Forbidden */
1793
+ 403: {
1794
+ headers: {
1795
+ [name: string]: unknown;
1796
+ };
1797
+ content: {
1798
+ "application/json": components["schemas"]["ForbiddenErrorModel"];
1799
+ };
1800
+ };
1801
+ /** @description Not Found */
1802
+ 404: {
1803
+ headers: {
1804
+ [name: string]: unknown;
1805
+ };
1806
+ content: {
1807
+ "application/json": components["schemas"]["BaseErrorModel"];
1808
+ };
1809
+ };
1810
+ /** @description Validation Error */
1811
+ 422: {
1812
+ headers: {
1813
+ [name: string]: unknown;
1814
+ };
1815
+ content: {
1816
+ "application/json": components["schemas"]["HTTPValidationError"];
1817
+ };
1818
+ };
1819
+ /** @description Internal Server Error */
1820
+ 500: {
1821
+ headers: {
1822
+ [name: string]: unknown;
1823
+ };
1824
+ content: {
1825
+ "application/json": components["schemas"]["BaseErrorModel"];
1826
+ };
1827
+ };
1828
+ };
1829
+ };
1830
+ get_policies_v2_groups__group_id__policies_get: {
1831
+ parameters: {
1832
+ query?: never;
1833
+ header?: never;
1834
+ path: {
1835
+ group_id: string;
1836
+ };
1837
+ cookie?: never;
1838
+ };
1839
+ requestBody?: never;
1840
+ responses: {
1841
+ /** @description The current group policies. */
1842
+ 200: {
1843
+ headers: {
1844
+ [name: string]: unknown;
1845
+ };
1846
+ content: {
1847
+ "application/json": components["schemas"]["GroupPolicyReadModel"];
1848
+ };
1849
+ };
1850
+ /** @description Unauthorized */
1851
+ 401: {
1852
+ headers: {
1853
+ [name: string]: unknown;
1854
+ };
1855
+ content: {
1856
+ "application/json": components["schemas"]["AuthErrorModel"];
1857
+ };
1858
+ };
1859
+ /** @description Forbidden */
1860
+ 403: {
1861
+ headers: {
1862
+ [name: string]: unknown;
1863
+ };
1864
+ content: {
1865
+ "application/json": components["schemas"]["ForbiddenErrorModel"];
1866
+ };
1867
+ };
1868
+ /** @description Not Found */
1869
+ 404: {
1870
+ headers: {
1871
+ [name: string]: unknown;
1872
+ };
1873
+ content: {
1874
+ "application/json": components["schemas"]["BaseErrorModel"];
1875
+ };
1876
+ };
1877
+ /** @description Validation Error */
1878
+ 422: {
1879
+ headers: {
1880
+ [name: string]: unknown;
1881
+ };
1882
+ content: {
1883
+ "application/json": components["schemas"]["HTTPValidationError"];
1884
+ };
1885
+ };
1886
+ /** @description Internal Server Error */
1887
+ 500: {
1888
+ headers: {
1889
+ [name: string]: unknown;
1890
+ };
1891
+ content: {
1892
+ "application/json": components["schemas"]["BaseErrorModel"];
1893
+ };
1894
+ };
1895
+ };
1896
+ };
1897
+ update_policies_v2_groups__group_id__policies_put: {
1898
+ parameters: {
1899
+ query?: never;
1900
+ header?: never;
1901
+ path: {
1902
+ group_id: string;
1903
+ };
1904
+ cookie?: never;
1905
+ };
1906
+ requestBody: {
1907
+ content: {
1908
+ "application/json": components["schemas"]["GroupPolicyWriteModel"];
1909
+ };
1910
+ };
1911
+ responses: {
1912
+ /** @description The updated set of policies. */
1913
+ 200: {
1914
+ headers: {
1915
+ [name: string]: unknown;
1916
+ };
1917
+ content: {
1918
+ "application/json": components["schemas"]["GroupPolicyReadModel"];
1919
+ };
1920
+ };
1921
+ /** @description Unauthorized */
1922
+ 401: {
1923
+ headers: {
1924
+ [name: string]: unknown;
1925
+ };
1926
+ content: {
1927
+ "application/json": components["schemas"]["AuthErrorModel"];
1928
+ };
1929
+ };
1930
+ /** @description Forbidden */
1931
+ 403: {
1932
+ headers: {
1933
+ [name: string]: unknown;
1934
+ };
1935
+ content: {
1936
+ "application/json": components["schemas"]["ForbiddenErrorModel"];
1937
+ };
1938
+ };
1939
+ /** @description Not Found */
1940
+ 404: {
1941
+ headers: {
1942
+ [name: string]: unknown;
1943
+ };
1944
+ content: {
1945
+ "application/json": components["schemas"]["BaseErrorModel"];
1946
+ };
1947
+ };
1948
+ /** @description Validation Error */
1949
+ 422: {
1950
+ headers: {
1951
+ [name: string]: unknown;
1952
+ };
1953
+ content: {
1954
+ "application/json": components["schemas"]["HTTPValidationError"];
1955
+ };
1956
+ };
1957
+ /** @description Internal Server Error */
1958
+ 500: {
1959
+ headers: {
1960
+ [name: string]: unknown;
1961
+ };
1962
+ content: {
1963
+ "application/json": components["schemas"]["BaseErrorModel"];
1964
+ };
1965
+ };
1966
+ };
1967
+ };
1968
+ get_identity_set_preferences_v2_preferences_get: {
1969
+ parameters: {
1970
+ query?: never;
1971
+ header?: never;
1972
+ path?: never;
1973
+ cookie?: never;
1974
+ };
1975
+ requestBody?: never;
1976
+ responses: {
1977
+ /** @description A mapping from identity_id to a list of preferences. */
1978
+ 200: {
1979
+ headers: {
1980
+ [name: string]: unknown;
1981
+ };
1982
+ content: {
1983
+ "application/json": {
1984
+ [key: string]: components["schemas"]["IdentityPreferences"];
1985
+ };
1986
+ };
1987
+ };
1988
+ /** @description Unauthorized */
1989
+ 401: {
1990
+ headers: {
1991
+ [name: string]: unknown;
1992
+ };
1993
+ content: {
1994
+ "application/json": components["schemas"]["AuthErrorModel"];
1995
+ };
1996
+ };
1997
+ /** @description Forbidden */
1998
+ 403: {
1999
+ headers: {
2000
+ [name: string]: unknown;
2001
+ };
2002
+ content: {
2003
+ "application/json": components["schemas"]["ForbiddenErrorModel"];
2004
+ };
2005
+ };
2006
+ /** @description Not Found */
2007
+ 404: {
2008
+ headers: {
2009
+ [name: string]: unknown;
2010
+ };
2011
+ content: {
2012
+ "application/json": components["schemas"]["BaseErrorModel"];
2013
+ };
2014
+ };
2015
+ /** @description Internal Server Error */
2016
+ 500: {
2017
+ headers: {
2018
+ [name: string]: unknown;
2019
+ };
2020
+ content: {
2021
+ "application/json": components["schemas"]["BaseErrorModel"];
2022
+ };
2023
+ };
2024
+ };
2025
+ };
2026
+ put_identity_set_preferences_v2_preferences_put: {
2027
+ parameters: {
2028
+ query?: never;
2029
+ header?: never;
2030
+ path?: never;
2031
+ cookie?: never;
2032
+ };
2033
+ requestBody: {
2034
+ content: {
2035
+ "application/json": {
2036
+ [key: string]: components["schemas"]["IdentityPreferences"];
2037
+ };
2038
+ };
2039
+ };
2040
+ responses: {
2041
+ /** @description A mapping from identity_id to a list of preferences. */
2042
+ 200: {
2043
+ headers: {
2044
+ [name: string]: unknown;
2045
+ };
2046
+ content: {
2047
+ "application/json": {
2048
+ [key: string]: components["schemas"]["IdentityPreferences"];
2049
+ };
2050
+ };
2051
+ };
2052
+ /** @description Unauthorized */
2053
+ 401: {
2054
+ headers: {
2055
+ [name: string]: unknown;
2056
+ };
2057
+ content: {
2058
+ "application/json": components["schemas"]["AuthErrorModel"];
2059
+ };
2060
+ };
2061
+ /** @description Forbidden */
2062
+ 403: {
2063
+ headers: {
2064
+ [name: string]: unknown;
2065
+ };
2066
+ content: {
2067
+ "application/json": components["schemas"]["ForbiddenErrorModel"];
2068
+ };
2069
+ };
2070
+ /** @description Not Found */
2071
+ 404: {
2072
+ headers: {
2073
+ [name: string]: unknown;
2074
+ };
2075
+ content: {
2076
+ "application/json": components["schemas"]["BaseErrorModel"];
2077
+ };
2078
+ };
2079
+ /** @description Validation Error */
2080
+ 422: {
2081
+ headers: {
2082
+ [name: string]: unknown;
2083
+ };
2084
+ content: {
2085
+ "application/json": components["schemas"]["HTTPValidationError"];
2086
+ };
2087
+ };
2088
+ /** @description Internal Server Error */
2089
+ 500: {
2090
+ headers: {
2091
+ [name: string]: unknown;
2092
+ };
2093
+ content: {
2094
+ "application/json": components["schemas"]["BaseErrorModel"];
2095
+ };
2096
+ };
2097
+ };
2098
+ };
2099
+ get_membership_fields_v2_groups__group_id__membership_fields_get: {
2100
+ parameters: {
2101
+ query?: never;
2102
+ header?: never;
2103
+ path: {
2104
+ group_id: string;
2105
+ };
2106
+ cookie?: never;
2107
+ };
2108
+ requestBody?: never;
2109
+ responses: {
2110
+ /** @description A mapping from identity_id to an object of membership fields. */
2111
+ 200: {
2112
+ headers: {
2113
+ [name: string]: unknown;
2114
+ };
2115
+ content: {
2116
+ "application/json": {
2117
+ [key: string]: components["schemas"]["MembershipFields"];
2118
+ };
2119
+ };
2120
+ };
2121
+ /** @description Unauthorized */
2122
+ 401: {
2123
+ headers: {
2124
+ [name: string]: unknown;
2125
+ };
2126
+ content: {
2127
+ "application/json": components["schemas"]["AuthErrorModel"];
2128
+ };
2129
+ };
2130
+ /** @description Forbidden */
2131
+ 403: {
2132
+ headers: {
2133
+ [name: string]: unknown;
2134
+ };
2135
+ content: {
2136
+ "application/json": components["schemas"]["ForbiddenErrorModel"];
2137
+ };
2138
+ };
2139
+ /** @description Not Found */
2140
+ 404: {
2141
+ headers: {
2142
+ [name: string]: unknown;
2143
+ };
2144
+ content: {
2145
+ "application/json": components["schemas"]["BaseErrorModel"];
2146
+ };
2147
+ };
2148
+ /** @description Validation Error */
2149
+ 422: {
2150
+ headers: {
2151
+ [name: string]: unknown;
2152
+ };
2153
+ content: {
2154
+ "application/json": components["schemas"]["HTTPValidationError"];
2155
+ };
2156
+ };
2157
+ /** @description Internal Server Error */
2158
+ 500: {
2159
+ headers: {
2160
+ [name: string]: unknown;
2161
+ };
2162
+ content: {
2163
+ "application/json": components["schemas"]["BaseErrorModel"];
2164
+ };
2165
+ };
2166
+ };
2167
+ };
2168
+ put_membership_fields_v2_groups__group_id__membership_fields_put: {
2169
+ parameters: {
2170
+ query?: never;
2171
+ header?: never;
2172
+ path: {
2173
+ group_id: string;
2174
+ };
2175
+ cookie?: never;
2176
+ };
2177
+ requestBody: {
2178
+ content: {
2179
+ "application/json": {
2180
+ [key: string]: components["schemas"]["MembershipFields"];
2181
+ };
2182
+ };
2183
+ };
2184
+ responses: {
2185
+ /** @description A mapping from identity_id to a list of membership fields. */
2186
+ 200: {
2187
+ headers: {
2188
+ [name: string]: unknown;
2189
+ };
2190
+ content: {
2191
+ "application/json": {
2192
+ [key: string]: components["schemas"]["MembershipFields"];
2193
+ };
2194
+ };
2195
+ };
2196
+ /** @description Unauthorized */
2197
+ 401: {
2198
+ headers: {
2199
+ [name: string]: unknown;
2200
+ };
2201
+ content: {
2202
+ "application/json": components["schemas"]["AuthErrorModel"];
2203
+ };
2204
+ };
2205
+ /** @description Forbidden */
2206
+ 403: {
2207
+ headers: {
2208
+ [name: string]: unknown;
2209
+ };
2210
+ content: {
2211
+ "application/json": components["schemas"]["ForbiddenErrorModel"];
2212
+ };
2213
+ };
2214
+ /** @description Not Found */
2215
+ 404: {
2216
+ headers: {
2217
+ [name: string]: unknown;
2218
+ };
2219
+ content: {
2220
+ "application/json": components["schemas"]["BaseErrorModel"];
2221
+ };
2222
+ };
2223
+ /** @description Validation Error */
2224
+ 422: {
2225
+ headers: {
2226
+ [name: string]: unknown;
2227
+ };
2228
+ content: {
2229
+ "application/json": components["schemas"]["HTTPValidationError"];
2230
+ };
2231
+ };
2232
+ /** @description Internal Server Error */
2233
+ 500: {
2234
+ headers: {
2235
+ [name: string]: unknown;
2236
+ };
2237
+ content: {
2238
+ "application/json": components["schemas"]["BaseErrorModel"];
2239
+ };
2240
+ };
2241
+ };
2242
+ };
2243
+ get_group_by_subscription_id_v2_subscription_info__subscription_id__get: {
2244
+ parameters: {
2245
+ query?: never;
2246
+ header?: never;
2247
+ path: {
2248
+ subscription_id: string;
2249
+ };
2250
+ cookie?: never;
2251
+ };
2252
+ requestBody?: never;
2253
+ responses: {
2254
+ /** @description A list of groups with the given subscription_id. */
2255
+ 200: {
2256
+ headers: {
2257
+ [name: string]: unknown;
2258
+ };
2259
+ content: {
2260
+ "application/json": components["schemas"]["GroupSubscriptionModel"];
2261
+ };
2262
+ };
2263
+ /** @description Unauthorized */
2264
+ 401: {
2265
+ headers: {
2266
+ [name: string]: unknown;
2267
+ };
2268
+ content: {
2269
+ "application/json": components["schemas"]["AuthErrorModel"];
2270
+ };
2271
+ };
2272
+ /** @description Forbidden */
2273
+ 403: {
2274
+ headers: {
2275
+ [name: string]: unknown;
2276
+ };
2277
+ content: {
2278
+ "application/json": components["schemas"]["ForbiddenErrorModel"];
2279
+ };
2280
+ };
2281
+ /** @description Not Found */
2282
+ 404: {
2283
+ headers: {
2284
+ [name: string]: unknown;
2285
+ };
2286
+ content: {
2287
+ "application/json": components["schemas"]["BaseErrorModel"];
2288
+ };
2289
+ };
2290
+ /** @description Validation Error */
2291
+ 422: {
2292
+ headers: {
2293
+ [name: string]: unknown;
2294
+ };
2295
+ content: {
2296
+ "application/json": components["schemas"]["HTTPValidationError"];
2297
+ };
2298
+ };
2299
+ /** @description Internal Server Error */
2300
+ 500: {
2301
+ headers: {
2302
+ [name: string]: unknown;
2303
+ };
2304
+ content: {
2305
+ "application/json": components["schemas"]["BaseErrorModel"];
2306
+ };
2307
+ };
2308
+ };
2309
+ };
2310
+ update_subscription_admin_verified_id_v2_groups__group_id__subscription_admin_verified_put: {
2311
+ parameters: {
2312
+ query?: never;
2313
+ header?: never;
2314
+ path: {
2315
+ group_id: string;
2316
+ };
2317
+ cookie?: never;
2318
+ };
2319
+ requestBody: {
2320
+ content: {
2321
+ "application/json": components["schemas"]["SubscriptionVerifiedWriteModel"];
2322
+ };
2323
+ };
2324
+ responses: {
2325
+ /** @description The updated group. */
2326
+ 200: {
2327
+ headers: {
2328
+ [name: string]: unknown;
2329
+ };
2330
+ content: {
2331
+ "application/json": components["schemas"]["SubscriptionVerifiedReadModel"];
2332
+ };
2333
+ };
2334
+ /** @description Unauthorized */
2335
+ 401: {
2336
+ headers: {
2337
+ [name: string]: unknown;
2338
+ };
2339
+ content: {
2340
+ "application/json": components["schemas"]["AuthErrorModel"];
2341
+ };
2342
+ };
2343
+ /** @description Forbidden */
2344
+ 403: {
2345
+ headers: {
2346
+ [name: string]: unknown;
2347
+ };
2348
+ content: {
2349
+ "application/json": components["schemas"]["ForbiddenErrorModel"];
2350
+ };
2351
+ };
2352
+ /** @description Not Found */
2353
+ 404: {
2354
+ headers: {
2355
+ [name: string]: unknown;
2356
+ };
2357
+ content: {
2358
+ "application/json": components["schemas"]["BaseErrorModel"];
2359
+ };
2360
+ };
2361
+ /** @description Validation Error */
2362
+ 422: {
2363
+ headers: {
2364
+ [name: string]: unknown;
2365
+ };
2366
+ content: {
2367
+ "application/json": components["schemas"]["HTTPValidationError"];
2368
+ };
2369
+ };
2370
+ /** @description Internal Server Error */
2371
+ 500: {
2372
+ headers: {
2373
+ [name: string]: unknown;
2374
+ };
2375
+ content: {
2376
+ "application/json": components["schemas"]["BaseErrorModel"];
2377
+ };
2378
+ };
2379
+ };
2380
+ };
2381
+ }
2382
+ //# sourceMappingURL=groups.d.ts.map