@stack-spot/portal-network 0.84.0 → 0.85.0

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.
@@ -15,7 +15,7 @@ export const servers = {
15
15
  generatedServerUrl: "https://account-account-api.dev.stackspot.com"
16
16
  };
17
17
  /**
18
- * List User repository credential's.
18
+ * Retrieves a list of SCM credentials associated with the current user's account, including secret names and provider details.
19
19
  */
20
20
  export function listScmCredentials(opts) {
21
21
  return oazapfts.ok(oazapfts.fetchJson("/v1/users/scm-credentials", {
@@ -23,7 +23,7 @@ export function listScmCredentials(opts) {
23
23
  }));
24
24
  }
25
25
  /**
26
- * Update User repository credential's.
26
+ * Updates the SCM credentials for a user by saving the new secret information and triggering an update event.
27
27
  */
28
28
  export function scmCredentialUpdate({ userScmInfoRequest }, opts) {
29
29
  return oazapfts.ok(oazapfts.fetchJson("/v1/users/scm-credentials", oazapfts.json({
@@ -33,7 +33,7 @@ export function scmCredentialUpdate({ userScmInfoRequest }, opts) {
33
33
  })));
34
34
  }
35
35
  /**
36
- * Save User repository credential's.
36
+ * Saves user SCM credentials by validating the user, storing the credentials securely, and triggering a creation event.
37
37
  */
38
38
  export function scmCredentialSave({ userScmInfoRequest }, opts) {
39
39
  return oazapfts.ok(oazapfts.fetchJson("/v1/users/scm-credentials", oazapfts.json({
@@ -43,7 +43,7 @@ export function scmCredentialSave({ userScmInfoRequest }, opts) {
43
43
  })));
44
44
  }
45
45
  /**
46
- * Delete an user SCM credentials.
46
+ * Deletes the SCM credentials of a user from the repository and secrets manager, and sends a deletion event if the credentials exist.
47
47
  */
48
48
  export function scmDelete(opts) {
49
49
  return oazapfts.ok(oazapfts.fetchJson("/v1/users/scm-credentials", {
@@ -52,34 +52,61 @@ export function scmDelete(opts) {
52
52
  }));
53
53
  }
54
54
  /**
55
- * Get scope by ID
55
+ * Get secret by ID
56
56
  */
57
- export function getById({ scopeId }, opts) {
57
+ export function getById({ secretId }, opts) {
58
+ return oazapfts.ok(oazapfts.fetchJson(`/v1/secrets/${encodeURIComponent(secretId)}`, {
59
+ ...opts
60
+ }));
61
+ }
62
+ /**
63
+ * Update secret information
64
+ */
65
+ export function updateSecret({ secretId, updateSecretRequest }, opts) {
66
+ return oazapfts.ok(oazapfts.fetchText(`/v1/secrets/${encodeURIComponent(secretId)}`, oazapfts.json({
67
+ ...opts,
68
+ method: "PUT",
69
+ body: updateSecretRequest
70
+ })));
71
+ }
72
+ /**
73
+ * Delete secret by ID
74
+ */
75
+ export function deleteSecret({ secretId }, opts) {
76
+ return oazapfts.ok(oazapfts.fetchText(`/v1/secrets/${encodeURIComponent(secretId)}`, {
77
+ ...opts,
78
+ method: "DELETE"
79
+ }));
80
+ }
81
+ /**
82
+ * Retrieves a specific scope by its ID for the current user's tenant and returns it.
83
+ */
84
+ export function getById1({ scopeId }, opts) {
58
85
  return oazapfts.ok(oazapfts.fetchJson(`/v1/scopes/${encodeURIComponent(scopeId)}`, {
59
86
  ...opts
60
87
  }));
61
88
  }
62
89
  /**
63
- * Update scope information
90
+ * Updates the details of a specific scope within the tenant using the provided scope ID and update request.
64
91
  */
65
92
  export function updateScope({ scopeId, iamUpdateScopeRequest }, opts) {
66
- return oazapfts.ok(oazapfts.fetchText(`/v1/scopes/${encodeURIComponent(scopeId)}`, oazapfts.json({
93
+ return oazapfts.ok(oazapfts.fetchJson(`/v1/scopes/${encodeURIComponent(scopeId)}`, oazapfts.json({
67
94
  ...opts,
68
95
  method: "PUT",
69
96
  body: iamUpdateScopeRequest
70
97
  })));
71
98
  }
72
99
  /**
73
- * Delete scope by ID
100
+ * Deletes a specific scope identified by its ID within the user's current tenant.
74
101
  */
75
102
  export function deleteScope({ scopeId }, opts) {
76
- return oazapfts.ok(oazapfts.fetchText(`/v1/scopes/${encodeURIComponent(scopeId)}`, {
103
+ return oazapfts.ok(oazapfts.fetchJson(`/v1/scopes/${encodeURIComponent(scopeId)}`, {
77
104
  ...opts,
78
105
  method: "DELETE"
79
106
  }));
80
107
  }
81
108
  /**
82
- * List repository credential's.
109
+ * Retrieves a list of SCM credentials associated with the current user's account.
83
110
  */
84
111
  export function listScmCredentials1(opts) {
85
112
  return oazapfts.ok(oazapfts.fetchJson("/v1/scm-credentials", {
@@ -87,7 +114,7 @@ export function listScmCredentials1(opts) {
87
114
  }));
88
115
  }
89
116
  /**
90
- * Update repository credential's.
117
+ * Updates the SCM credentials for the current user's account, saving the changes and triggering an update event.
91
118
  */
92
119
  export function scmCredentialUpdate1({ accountScmInfoUpdateRequest }, opts) {
93
120
  return oazapfts.ok(oazapfts.fetchJson("/v1/scm-credentials", oazapfts.json({
@@ -97,7 +124,7 @@ export function scmCredentialUpdate1({ accountScmInfoUpdateRequest }, opts) {
97
124
  })));
98
125
  }
99
126
  /**
100
- * Save repository credential's.
127
+ * Saves SCM credentials for a user's account.
101
128
  */
102
129
  export function scmCredentialSave1({ accountScmInfoSaveRequest }, opts) {
103
130
  return oazapfts.ok(oazapfts.fetchJson("/v1/scm-credentials", oazapfts.json({
@@ -107,7 +134,7 @@ export function scmCredentialSave1({ accountScmInfoSaveRequest }, opts) {
107
134
  })));
108
135
  }
109
136
  /**
110
- * Update a new role for Account
137
+ * Updates the role of an account.
111
138
  */
112
139
  export function updateAccountRole({ roleId, updateAccountRoleRequest }, opts) {
113
140
  return oazapfts.ok(oazapfts.fetchJson(`/v1/roles/${encodeURIComponent(roleId)}`, oazapfts.json({
@@ -117,7 +144,7 @@ export function updateAccountRole({ roleId, updateAccountRoleRequest }, opts) {
117
144
  })));
118
145
  }
119
146
  /**
120
- * Delete a role for Account
147
+ * Deletes a specific account role by its ID.
121
148
  */
122
149
  export function deleteAccountRole({ roleId }, opts) {
123
150
  return oazapfts.ok(oazapfts.fetchJson(`/v1/roles/${encodeURIComponent(roleId)}`, {
@@ -126,7 +153,7 @@ export function deleteAccountRole({ roleId }, opts) {
126
153
  }));
127
154
  }
128
155
  /**
129
- * Get all Global Resources and Actions compared to role
156
+ * Retrieves a of resources and their associated actions with their status compared to a specified role.
130
157
  */
131
158
  export function getResourcesAndActionsWithStatus1({ roleId, size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }, opts) {
132
159
  return oazapfts.ok(oazapfts.fetchJson(`/v1/roles/${encodeURIComponent(roleId)}/resources${QS.query(QS.explode({
@@ -145,7 +172,7 @@ export function getResourcesAndActionsWithStatus1({ roleId, size, page, sort, di
145
172
  }));
146
173
  }
147
174
  /**
148
- * Update role with new resource and actions
175
+ * Updates the role of an account with new resource-action statements.
149
176
  */
150
177
  export function updateRoleWithNewActions({ roleId, body }, opts) {
151
178
  return oazapfts.ok(oazapfts.fetchJson(`/v1/roles/${encodeURIComponent(roleId)}/resources`, oazapfts.json({
@@ -155,7 +182,7 @@ export function updateRoleWithNewActions({ roleId, body }, opts) {
155
182
  })));
156
183
  }
157
184
  /**
158
- * Updates actions from a resource
185
+ * Updates the actions associated with a specific resource in a role.
159
186
  */
160
187
  export function updateResourceActions({ roleId, resourceId, updateResourceActionsRequest }, opts) {
161
188
  return oazapfts.ok(oazapfts.fetchJson(`/v1/roles/${encodeURIComponent(roleId)}/resources/${encodeURIComponent(resourceId)}`, oazapfts.json({
@@ -165,7 +192,7 @@ export function updateResourceActions({ roleId, resourceId, updateResourceAction
165
192
  })));
166
193
  }
167
194
  /**
168
- * Get user by id
195
+ * Retrieves account member details by their unique identifier.
169
196
  */
170
197
  export function getMemberById({ memberId }, opts) {
171
198
  return oazapfts.ok(oazapfts.fetchJson(`/v1/members/${encodeURIComponent(memberId)}`, {
@@ -173,7 +200,7 @@ export function getMemberById({ memberId }, opts) {
173
200
  }));
174
201
  }
175
202
  /**
176
- * Update user on current tenant
203
+ * Updates the information of an existing user.
177
204
  */
178
205
  export function updateUser({ memberId, updateUserRequest }, opts) {
179
206
  return oazapfts.ok(oazapfts.fetchJson(`/v1/members/${encodeURIComponent(memberId)}`, oazapfts.json({
@@ -183,7 +210,7 @@ export function updateUser({ memberId, updateUserRequest }, opts) {
183
210
  })));
184
211
  }
185
212
  /**
186
- * Update user password on current tenant
213
+ * Updates the password of a specified user.
187
214
  */
188
215
  export function updateUserPassword({ memberId, updatePasswordRequest }, opts) {
189
216
  return oazapfts.ok(oazapfts.fetchJson(`/v1/members/${encodeURIComponent(memberId)}/password`, oazapfts.json({
@@ -193,7 +220,7 @@ export function updateUserPassword({ memberId, updatePasswordRequest }, opts) {
193
220
  })));
194
221
  }
195
222
  /**
196
- * Accept user invitation
223
+ * Accepts an invitation for a user to collaborate on an account.
197
224
  */
198
225
  export function accept({ id }, opts) {
199
226
  return oazapfts.ok(oazapfts.fetchJson(`/v1/invitations/${encodeURIComponent(id)}/accept`, {
@@ -360,7 +387,46 @@ export function notifyServiceCredentialExpiration({ serviceCredentialExpirationR
360
387
  })));
361
388
  }
362
389
  /**
363
- * Find all the existing scopes
390
+ * Find secrets with multiple filters and conditions
391
+ */
392
+ export function findSecrets1({ size, page, sort, direction, search, filterByScope, filterByType, filterByScopedBy, filterByScopedValue, authorizedOnly }, opts) {
393
+ return oazapfts.ok(oazapfts.fetchJson(`/v1/secrets${QS.query(QS.explode({
394
+ size,
395
+ page,
396
+ sort,
397
+ direction,
398
+ search,
399
+ filterByScope,
400
+ filterByType,
401
+ filterByScopedBy,
402
+ filterByScopedValue,
403
+ authorizedOnly
404
+ }))}`, {
405
+ ...opts
406
+ }));
407
+ }
408
+ /**
409
+ * Create a new secret
410
+ */
411
+ export function createSecret({ createSecretRequest }, opts) {
412
+ return oazapfts.ok(oazapfts.fetchJson("/v1/secrets", oazapfts.json({
413
+ ...opts,
414
+ method: "POST",
415
+ body: createSecretRequest
416
+ })));
417
+ }
418
+ /**
419
+ * Check if user has access to secret
420
+ */
421
+ export function findSecrets({ checkSecretAccessRequest }, opts) {
422
+ return oazapfts.ok(oazapfts.fetchJson("/v1/secrets/check-access", oazapfts.json({
423
+ ...opts,
424
+ method: "POST",
425
+ body: checkSecretAccessRequest
426
+ })));
427
+ }
428
+ /**
429
+ * Retrieves a paginated list of scope details for the current user's tenant.
364
430
  */
365
431
  export function findScopes({ page }, opts) {
366
432
  return oazapfts.ok(oazapfts.fetchJson(`/v1/scopes${QS.query(QS.explode({
@@ -370,17 +436,17 @@ export function findScopes({ page }, opts) {
370
436
  }));
371
437
  }
372
438
  /**
373
- * Create a new scope
439
+ * Creates a new IAM scope for the current user's tenant using the provided request details.
374
440
  */
375
441
  export function createScope({ iamCreateScopeRequest }, opts) {
376
- return oazapfts.ok(oazapfts.fetchText("/v1/scopes", oazapfts.json({
442
+ return oazapfts.ok(oazapfts.fetchJson("/v1/scopes", oazapfts.json({
377
443
  ...opts,
378
444
  method: "POST",
379
445
  body: iamCreateScopeRequest
380
446
  })));
381
447
  }
382
448
  /**
383
- * Get Roles
449
+ * Retrieves a list of roles available to the current account.
384
450
  */
385
451
  export function getRoles3({ size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }, opts) {
386
452
  return oazapfts.ok(oazapfts.fetchJson(`/v1/roles${QS.query(QS.explode({
@@ -399,7 +465,7 @@ export function getRoles3({ size, page, sort, direction, search, filterMode, fil
399
465
  }));
400
466
  }
401
467
  /**
402
- * Create a new role for Account
468
+ * Creates a new account role.
403
469
  */
404
470
  export function createAccountRole({ createAccountRoleRequest }, opts) {
405
471
  return oazapfts.ok(oazapfts.fetchJson("/v1/roles", oazapfts.json({
@@ -409,7 +475,7 @@ export function createAccountRole({ createAccountRoleRequest }, opts) {
409
475
  })));
410
476
  }
411
477
  /**
412
- * Get role members
478
+ * Retrieves a list of role members for a specified role.
413
479
  */
414
480
  export function getRoleMembers1({ roleId, size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }, opts) {
415
481
  return oazapfts.ok(oazapfts.fetchJson(`/v1/roles/${encodeURIComponent(roleId)}/members${QS.query(QS.explode({
@@ -428,7 +494,7 @@ export function getRoleMembers1({ roleId, size, page, sort, direction, search, f
428
494
  }));
429
495
  }
430
496
  /**
431
- * Add Role to Member
497
+ * Assigns a specified role to a list of members.
432
498
  */
433
499
  export function addRoleToMember({ roleId, addRoleToMemberRequest }, opts) {
434
500
  return oazapfts.ok(oazapfts.fetchJson(`/v1/roles/${encodeURIComponent(roleId)}/members`, oazapfts.json({
@@ -438,7 +504,7 @@ export function addRoleToMember({ roleId, addRoleToMemberRequest }, opts) {
438
504
  })));
439
505
  }
440
506
  /**
441
- * Get Groups from role
507
+ * Retrieves a list of role groups associated with a specific group ID.
442
508
  */
443
509
  export function getRoleGroups1({ roleId, size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }, opts) {
444
510
  return oazapfts.ok(oazapfts.fetchJson(`/v1/roles/${encodeURIComponent(roleId)}/groups${QS.query(QS.explode({
@@ -457,7 +523,7 @@ export function getRoleGroups1({ roleId, size, page, sort, direction, search, fi
457
523
  }));
458
524
  }
459
525
  /**
460
- * Bind roles groups
526
+ * Bind a role to a group.
461
527
  */
462
528
  export function bindRoleGroups({ roleId, roleGroupIdsRequest }, opts) {
463
529
  return oazapfts.ok(oazapfts.fetchJson(`/v1/roles/${encodeURIComponent(roleId)}/groups`, oazapfts.json({
@@ -496,7 +562,7 @@ export function createResource({ createResourceRequest }, opts) {
496
562
  })));
497
563
  }
498
564
  /**
499
- * Get Account Members
565
+ * Retrieves a list of account members for a specified account.
500
566
  */
501
567
  export function getAccountMembers2({ size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }, opts) {
502
568
  return oazapfts.ok(oazapfts.fetchJson(`/v1/members${QS.query(QS.explode({
@@ -515,7 +581,7 @@ export function getAccountMembers2({ size, page, sort, direction, search, filter
515
581
  }));
516
582
  }
517
583
  /**
518
- * Create user on current tenant
584
+ * Creates a new user in the account.
519
585
  */
520
586
  export function createUser({ createUserRequest }, opts) {
521
587
  return oazapfts.ok(oazapfts.fetchJson("/v1/members", oazapfts.json({
@@ -525,7 +591,7 @@ export function createUser({ createUserRequest }, opts) {
525
591
  })));
526
592
  }
527
593
  /**
528
- * Get member roles
594
+ * Retrieves a paginated list of roles associated with a specific member.
529
595
  */
530
596
  export function getRoles4({ memberId, size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }, opts) {
531
597
  return oazapfts.ok(oazapfts.fetchJson(`/v1/members/${encodeURIComponent(memberId)}/roles${QS.query(QS.explode({
@@ -544,7 +610,7 @@ export function getRoles4({ memberId, size, page, sort, direction, search, filte
544
610
  }));
545
611
  }
546
612
  /**
547
- * Bind users to roles
613
+ * Binds a member to a list of roles.
548
614
  */
549
615
  export function bindToRoles({ memberId, memberIdsCommonRequest }, opts) {
550
616
  return oazapfts.ok(oazapfts.fetchJson(`/v1/members/${encodeURIComponent(memberId)}/roles`, oazapfts.json({
@@ -554,7 +620,7 @@ export function bindToRoles({ memberId, memberIdsCommonRequest }, opts) {
554
620
  })));
555
621
  }
556
622
  /**
557
- * Reset member OTP
623
+ * Resets the OTP configuration for a specified member.
558
624
  */
559
625
  export function resetOtp({ memberId }, opts) {
560
626
  return oazapfts.ok(oazapfts.fetchJson(`/v1/members/${encodeURIComponent(memberId)}/reset-otp`, {
@@ -563,7 +629,7 @@ export function resetOtp({ memberId }, opts) {
563
629
  }));
564
630
  }
565
631
  /**
566
- * Get member Groups
632
+ * Retrieves a list of groups associated with a specific member.
567
633
  */
568
634
  export function getMemberGroups1({ memberId, size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }, opts) {
569
635
  return oazapfts.ok(oazapfts.fetchJson(`/v1/members/${encodeURIComponent(memberId)}/groups${QS.query(QS.explode({
@@ -582,7 +648,7 @@ export function getMemberGroups1({ memberId, size, page, sort, direction, search
582
648
  }));
583
649
  }
584
650
  /**
585
- * Bind users to groups
651
+ * Binds a member to a list of groups.
586
652
  */
587
653
  export function bindToGroups({ memberId, memberIdsCommonRequest }, opts) {
588
654
  return oazapfts.ok(oazapfts.fetchJson(`/v1/members/${encodeURIComponent(memberId)}/groups`, oazapfts.json({
@@ -610,7 +676,7 @@ export function addAccountMemberFavorite({ memberId, createFavoriteResourceReque
610
676
  })));
611
677
  }
612
678
  /**
613
- * Send Email to reset password
679
+ * Resets the password for a user by generating a magic link and sending it to their email.
614
680
  */
615
681
  export function resetPassword({ memberEmailRequest }, opts) {
616
682
  return oazapfts.ok(oazapfts.fetchJson("/v1/members/reset-password", oazapfts.json({
@@ -620,7 +686,7 @@ export function resetPassword({ memberEmailRequest }, opts) {
620
686
  })));
621
687
  }
622
688
  /**
623
- * Invite new members to account
689
+ * Invites new members to an account and assigns them to the default group based on the account type.
624
690
  */
625
691
  export function inviteMembers({ body }, opts) {
626
692
  return oazapfts.ok(oazapfts.fetchJson("/v1/members/invitation", oazapfts.json({
@@ -630,7 +696,7 @@ export function inviteMembers({ body }, opts) {
630
696
  })));
631
697
  }
632
698
  /**
633
- * List user invitations for account
699
+ * Lists user invitations for account
634
700
  */
635
701
  export function listUserInvitations({ filterBy, filterValue, page, size }, opts) {
636
702
  return oazapfts.ok(oazapfts.fetchJson(`/v1/invitations${QS.query(QS.explode({
@@ -643,7 +709,7 @@ export function listUserInvitations({ filterBy, filterValue, page, size }, opts)
643
709
  }));
644
710
  }
645
711
  /**
646
- * Create user invitations for account
712
+ * Creates and sends an invitation to a user to join an account.
647
713
  */
648
714
  export function createUserInvitation({ createUserInvitationRequest }, opts) {
649
715
  return oazapfts.ok(oazapfts.fetchJson("/v1/invitations", oazapfts.json({
@@ -1095,6 +1161,46 @@ export function revokeServiceCredential({ id }, opts) {
1095
1161
  method: "PATCH"
1096
1162
  }));
1097
1163
  }
1164
+ /**
1165
+ * Delete a member permissions
1166
+ */
1167
+ export function deleteMemberPermissions({ memberId, body }, opts) {
1168
+ return oazapfts.ok(oazapfts.fetchJson(`/v2/members/${encodeURIComponent(memberId)}/permissions`, oazapfts.json({
1169
+ ...opts,
1170
+ method: "DELETE",
1171
+ body
1172
+ })));
1173
+ }
1174
+ /**
1175
+ * Update a member's permissions by assigning resources and actions, creating a default role if necessary.
1176
+ */
1177
+ export function updateMemberPermissions({ memberId, body }, opts) {
1178
+ return oazapfts.ok(oazapfts.fetchJson(`/v2/members/${encodeURIComponent(memberId)}/permissions`, oazapfts.json({
1179
+ ...opts,
1180
+ method: "PATCH",
1181
+ body
1182
+ })));
1183
+ }
1184
+ /**
1185
+ * Delete Group permissions
1186
+ */
1187
+ export function deleteGroupPermissions({ groupId, body }, opts) {
1188
+ return oazapfts.ok(oazapfts.fetchJson(`/v2/groups/${encodeURIComponent(groupId)}/permissions`, oazapfts.json({
1189
+ ...opts,
1190
+ method: "DELETE",
1191
+ body
1192
+ })));
1193
+ }
1194
+ /**
1195
+ * Update Group permissions
1196
+ */
1197
+ export function updateGroupPermissions({ groupId, body }, opts) {
1198
+ return oazapfts.ok(oazapfts.fetchJson(`/v2/groups/${encodeURIComponent(groupId)}/permissions`, oazapfts.json({
1199
+ ...opts,
1200
+ method: "PATCH",
1201
+ body
1202
+ })));
1203
+ }
1098
1204
  /**
1099
1205
  * Associate Group to Service Credential
1100
1206
  */
@@ -1115,7 +1221,25 @@ export function revokeServiceCredential1({ id }, opts) {
1115
1221
  }));
1116
1222
  }
1117
1223
  /**
1118
- * Update member preferences
1224
+ * Enable secret by ID
1225
+ */
1226
+ export function enableSecret({ secretId }, opts) {
1227
+ return oazapfts.ok(oazapfts.fetchText(`/v1/secrets/${encodeURIComponent(secretId)}/enable`, {
1228
+ ...opts,
1229
+ method: "PATCH"
1230
+ }));
1231
+ }
1232
+ /**
1233
+ * Disable secret by ID
1234
+ */
1235
+ export function disableSecret({ secretId }, opts) {
1236
+ return oazapfts.ok(oazapfts.fetchText(`/v1/secrets/${encodeURIComponent(secretId)}/disable`, {
1237
+ ...opts,
1238
+ method: "PATCH"
1239
+ }));
1240
+ }
1241
+ /**
1242
+ * Retrieves the preferences of a specific member.
1119
1243
  */
1120
1244
  export function getMemberPreferences({ memberId }, opts) {
1121
1245
  return oazapfts.ok(oazapfts.fetchJson(`/v1/members/${encodeURIComponent(memberId)}/preferences`, {
@@ -1123,7 +1247,7 @@ export function getMemberPreferences({ memberId }, opts) {
1123
1247
  }));
1124
1248
  }
1125
1249
  /**
1126
- * Update member preferences
1250
+ * Updates the preferences of a specific member.
1127
1251
  */
1128
1252
  export function updateMemberPreferences({ memberId, updateMemberPreferencesRequest }, opts) {
1129
1253
  return oazapfts.ok(oazapfts.fetchJson(`/v1/members/${encodeURIComponent(memberId)}/preferences`, oazapfts.json({
@@ -1133,9 +1257,9 @@ export function updateMemberPreferences({ memberId, updateMemberPreferencesReque
1133
1257
  })));
1134
1258
  }
1135
1259
  /**
1136
- * Delete a member permissions
1260
+ * Deletes specific permissions from a member's role.
1137
1261
  */
1138
- export function deleteMemberPermissions({ memberId, deleteMemberPermissionsRequest }, opts) {
1262
+ export function deleteMemberPermissions1({ memberId, deleteMemberPermissionsRequest }, opts) {
1139
1263
  return oazapfts.ok(oazapfts.fetchJson(`/v1/members/${encodeURIComponent(memberId)}/permissions`, oazapfts.json({
1140
1264
  ...opts,
1141
1265
  method: "DELETE",
@@ -1143,9 +1267,9 @@ export function deleteMemberPermissions({ memberId, deleteMemberPermissionsReque
1143
1267
  })));
1144
1268
  }
1145
1269
  /**
1146
- * Update member permissions
1270
+ * Update a member's permissions by assigning resources and actions, creating a default role if necessary.
1147
1271
  */
1148
- export function updateMemberPermissions({ memberId, updateMemberPermissionsRequest }, opts) {
1272
+ export function updateMemberPermissions1({ memberId, updateMemberPermissionsRequest }, opts) {
1149
1273
  return oazapfts.ok(oazapfts.fetchJson(`/v1/members/${encodeURIComponent(memberId)}/permissions`, oazapfts.json({
1150
1274
  ...opts,
1151
1275
  method: "PATCH",
@@ -1153,7 +1277,7 @@ export function updateMemberPermissions({ memberId, updateMemberPermissionsReque
1153
1277
  })));
1154
1278
  }
1155
1279
  /**
1156
- * Get All Fido credentials for given user
1280
+ * Retrieves a paginated list of Fido user credentials for a specific member.
1157
1281
  */
1158
1282
  export function getAllMemberFidoCredentials({ memberId, size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }, opts) {
1159
1283
  return oazapfts.ok(oazapfts.fetchJson(`/v1/members/${encodeURIComponent(memberId)}/fido-credentials${QS.query(QS.explode({
@@ -1172,7 +1296,7 @@ export function getAllMemberFidoCredentials({ memberId, size, page, sort, direct
1172
1296
  }));
1173
1297
  }
1174
1298
  /**
1175
- * Disables Fido credentials for given user
1299
+ * Deactivates all Fido credentials associated with a specific member.
1176
1300
  */
1177
1301
  export function deactivateFidoCredentials({ memberId }, opts) {
1178
1302
  return oazapfts.ok(oazapfts.fetchJson(`/v1/members/${encodeURIComponent(memberId)}/fido-credentials`, {
@@ -1181,7 +1305,7 @@ export function deactivateFidoCredentials({ memberId }, opts) {
1181
1305
  }));
1182
1306
  }
1183
1307
  /**
1184
- * Enable Fido credentials for given user
1308
+ * Enables Fido credentials for a specified member.
1185
1309
  */
1186
1310
  export function enableFidoCredentials({ memberId }, opts) {
1187
1311
  return oazapfts.ok(oazapfts.fetchJson(`/v1/members/${encodeURIComponent(memberId)}/fido-credentials`, {
@@ -1190,7 +1314,7 @@ export function enableFidoCredentials({ memberId }, opts) {
1190
1314
  }));
1191
1315
  }
1192
1316
  /**
1193
- * Revoke user invitation
1317
+ * Cancel a user invitation.
1194
1318
  */
1195
1319
  export function cancelUserInvitation({ id }, opts) {
1196
1320
  return oazapfts.ok(oazapfts.fetchJson(`/v1/invitations/${encodeURIComponent(id)}`, {
@@ -1199,7 +1323,7 @@ export function cancelUserInvitation({ id }, opts) {
1199
1323
  }));
1200
1324
  }
1201
1325
  /**
1202
- * Resend user invitation
1326
+ * Resends a user invitation for a specified account.
1203
1327
  */
1204
1328
  export function resendUserInvitation({ id }, opts) {
1205
1329
  return oazapfts.ok(oazapfts.fetchJson(`/v1/invitations/${encodeURIComponent(id)}`, {
@@ -1237,7 +1361,7 @@ export function update1({ groupId, updateGroupRequest }, opts) {
1237
1361
  /**
1238
1362
  * Delete Group permissions
1239
1363
  */
1240
- export function deleteGroupPermissions({ groupId, deleteGroupPermissionsRequest }, opts) {
1364
+ export function deleteGroupPermissions1({ groupId, deleteGroupPermissionsRequest }, opts) {
1241
1365
  return oazapfts.ok(oazapfts.fetchJson(`/v1/groups/${encodeURIComponent(groupId)}/permissions`, oazapfts.json({
1242
1366
  ...opts,
1243
1367
  method: "DELETE",
@@ -1247,7 +1371,7 @@ export function deleteGroupPermissions({ groupId, deleteGroupPermissionsRequest
1247
1371
  /**
1248
1372
  * Update Group permissions
1249
1373
  */
1250
- export function updateGroupPermissions({ groupId, updateGroupPermissionsRequest }, opts) {
1374
+ export function updateGroupPermissions1({ groupId, updateGroupPermissionsRequest }, opts) {
1251
1375
  return oazapfts.ok(oazapfts.fetchJson(`/v1/groups/${encodeURIComponent(groupId)}/permissions`, oazapfts.json({
1252
1376
  ...opts,
1253
1377
  method: "PATCH",
@@ -1536,7 +1660,7 @@ export function getResourceTypes({ size, page, sort, direction, search, filterMo
1536
1660
  }));
1537
1661
  }
1538
1662
  /**
1539
- * Get Account Members
1663
+ * Retrieves a list of account members.
1540
1664
  */
1541
1665
  export function getAccountMembers({ size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }, opts) {
1542
1666
  return oazapfts.ok(oazapfts.fetchJson(`/v2/members${QS.query(QS.explode({
@@ -1555,7 +1679,7 @@ export function getAccountMembers({ size, page, sort, direction, search, filterM
1555
1679
  }));
1556
1680
  }
1557
1681
  /**
1558
- * Get member roles
1682
+ * Retrieves a list of roles associated with a specific member.
1559
1683
  */
1560
1684
  export function getRoles1({ memberId, size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }, opts) {
1561
1685
  return oazapfts.ok(oazapfts.fetchJson(`/v2/members/${encodeURIComponent(memberId)}/roles${QS.query(QS.explode({
@@ -1574,7 +1698,7 @@ export function getRoles1({ memberId, size, page, sort, direction, search, filte
1574
1698
  }));
1575
1699
  }
1576
1700
  /**
1577
- * Get member Groups
1701
+ * Retrieves a list of groups for a specified member.
1578
1702
  */
1579
1703
  export function getMemberGroups({ memberId, size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }, opts) {
1580
1704
  return oazapfts.ok(oazapfts.fetchJson(`/v2/members/${encodeURIComponent(memberId)}/groups${QS.query(QS.explode({
@@ -1670,7 +1794,7 @@ export function getMembers({ groupId, size, page, sort, direction, search, filte
1670
1794
  }));
1671
1795
  }
1672
1796
  /**
1673
- * Verify User repository credential configuration status.
1797
+ * Verifies if SCM credentials exist for the current user's account and email, throwing an error if not found.
1674
1798
  */
1675
1799
  export function isCreatedScmCredentials(opts) {
1676
1800
  return oazapfts.ok(oazapfts.fetchJson("/v1/users/scm-credentials/configuration-status", {
@@ -1678,7 +1802,7 @@ export function isCreatedScmCredentials(opts) {
1678
1802
  }));
1679
1803
  }
1680
1804
  /**
1681
- * List Accounts of User can use and collaborate.
1805
+ * Retrieves a list of user accounts along with their collaboration roles for the current authenticated user.
1682
1806
  */
1683
1807
  export function getUserAccountWithRole(opts) {
1684
1808
  return oazapfts.ok(oazapfts.fetchJson("/v1/users/accounts", {
@@ -1749,7 +1873,15 @@ export function getServiceCredentialGroups1({ id }, opts) {
1749
1873
  }));
1750
1874
  }
1751
1875
  /**
1752
- * Get SCM provider.
1876
+ * Retrieve secret value
1877
+ */
1878
+ export function getSecretValue({ secretId }, opts) {
1879
+ return oazapfts.ok(oazapfts.fetchJson(`/v1/secrets/${encodeURIComponent(secretId)}/value`, {
1880
+ ...opts
1881
+ }));
1882
+ }
1883
+ /**
1884
+ * Retrieves the SCM provider information for the current user's account.
1753
1885
  */
1754
1886
  export function getScmProvider(opts) {
1755
1887
  return oazapfts.ok(oazapfts.fetchJson("/v1/scm-credentials/provider", {
@@ -1757,7 +1889,7 @@ export function getScmProvider(opts) {
1757
1889
  }));
1758
1890
  }
1759
1891
  /**
1760
- * Verify repository credential configuration status.
1892
+ * Verifies the SCM credentials configuration for the current user's account and returns its status, indicating if the mandate or user-specific configuration exists.
1761
1893
  */
1762
1894
  export function isCreatedScmCredentials1(opts) {
1763
1895
  return oazapfts.ok(oazapfts.fetchJson("/v1/scm-credentials/configuration-status", {
@@ -1765,7 +1897,7 @@ export function isCreatedScmCredentials1(opts) {
1765
1897
  }));
1766
1898
  }
1767
1899
  /**
1768
- * Get Permissions from role
1900
+ * Retrieves a list of permissions with their status for a specified role.
1769
1901
  */
1770
1902
  export function getPermissionsWithStatus({ roleId, size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }, opts) {
1771
1903
  return oazapfts.ok(oazapfts.fetchJson(`/v1/roles/${encodeURIComponent(roleId)}/permissions${QS.query(QS.explode({
@@ -1854,7 +1986,7 @@ export function getAccess({ resourceType, resource, action, attribute }, opts) {
1854
1986
  }));
1855
1987
  }
1856
1988
  /**
1857
- * Get Resources Members
1989
+ * Retrieves a list of resources associated with the specified member.
1858
1990
  */
1859
1991
  export function getResources2({ memberId }, opts) {
1860
1992
  return oazapfts.ok(oazapfts.fetchJson(`/v1/members/${encodeURIComponent(memberId)}/resources`, {
@@ -1870,7 +2002,7 @@ export function listMemberFavoritesByResource({ memberId, resourceType }, opts)
1870
2002
  }));
1871
2003
  }
1872
2004
  /**
1873
- * Get Account Collaborators Members
2005
+ * Retrieves a list of account members and collaborators associated with the current user's account.
1874
2006
  */
1875
2007
  export function getAccountMembersToCollaborators({ size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }, opts) {
1876
2008
  return oazapfts.ok(oazapfts.fetchJson(`/v1/members/collaborators${QS.query(QS.explode({
@@ -2017,7 +2149,7 @@ export function disassociateGroupToServiceCredential({ id, groupId }, opts) {
2017
2149
  }));
2018
2150
  }
2019
2151
  /**
2020
- * Remove Role from Member
2152
+ * Removes a specified role from a member.
2021
2153
  */
2022
2154
  export function removeRoleFromMember({ roleId, memberId }, opts) {
2023
2155
  return oazapfts.ok(oazapfts.fetchJson(`/v1/roles/${encodeURIComponent(roleId)}/members/${encodeURIComponent(memberId)}`, {
@@ -2035,7 +2167,7 @@ export function deleteResource({ resourceId }, opts) {
2035
2167
  }));
2036
2168
  }
2037
2169
  /**
2038
- * Removes member profile image
2170
+ * Deletes the profile image of a member.
2039
2171
  */
2040
2172
  export function deleteProfileImage({ memberId }, opts) {
2041
2173
  return oazapfts.ok(oazapfts.fetchJson(`/v1/members/${encodeURIComponent(memberId)}/profile-image`, {