@stack-spot/portal-network 0.116.2 → 0.116.4

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.
@@ -14,6 +14,30 @@ const oazapfts = Oazapfts.runtime(defaults);
14
14
  export const servers = {
15
15
  generatedServerUrl: "https://account-account-api.dev.stackspot.com"
16
16
  };
17
+ /**
18
+ * Retrieves a list of rate limit with the associated service credential.
19
+ */
20
+ export function getAllServiceCredentialRateLimit({ size, page, sort, direction, search }, opts) {
21
+ return oazapfts.ok(oazapfts.fetchJson(`/v2/service-credentials/rate-limit${QS.query(QS.explode({
22
+ size,
23
+ page,
24
+ sort,
25
+ direction,
26
+ search
27
+ }))}`, {
28
+ ...opts
29
+ }));
30
+ }
31
+ /**
32
+ * Updates the rate limit of a service credential.
33
+ */
34
+ export function updateServiceCredentialRateLimit({ serviceCredentialRateLimitRequest }, opts) {
35
+ return oazapfts.ok(oazapfts.fetchJson("/v2/service-credentials/rate-limit", oazapfts.json({
36
+ ...opts,
37
+ method: "PUT",
38
+ body: serviceCredentialRateLimitRequest
39
+ })));
40
+ }
17
41
  /**
18
42
  * Retrieves a list of SCM credentials associated with the current user's account, including secret names and provider details.
19
43
  */
@@ -354,7 +378,7 @@ export function createServiceCredential({ serviceCredentialCreateRequestV2 }, op
354
378
  })));
355
379
  }
356
380
  /**
357
- * Get Service Credentials
381
+ * Retrieves a list of service credentials with their associated owner information if available.
358
382
  */
359
383
  export function getServiceCredentials1({ name, status, page, size }, opts) {
360
384
  return oazapfts.ok(oazapfts.fetchJson(`/v1/service-credentials${QS.query(QS.explode({
@@ -367,7 +391,7 @@ export function getServiceCredentials1({ name, status, page, size }, opts) {
367
391
  }));
368
392
  }
369
393
  /**
370
- * Create Service Credential
394
+ * Creates a new service credential for an account.
371
395
  */
372
396
  export function createServiceCredential1({ serviceCredentialCreateRequest }, opts) {
373
397
  return oazapfts.ok(oazapfts.fetchJson("/v1/service-credentials", oazapfts.json({
@@ -377,7 +401,7 @@ export function createServiceCredential1({ serviceCredentialCreateRequest }, opt
377
401
  })));
378
402
  }
379
403
  /**
380
- * Notify about Service Credential expiration
404
+ * Notifies the user about the expiration of the service credential via email.
381
405
  */
382
406
  export function notifyServiceCredentialExpiration({ serviceCredentialExpirationRequest }, opts) {
383
407
  return oazapfts.ok(oazapfts.fetchJson("/v1/service-credentials/expiration", oazapfts.json({
@@ -658,7 +682,7 @@ export function bindToGroups({ memberId, memberIdsCommonRequest }, opts) {
658
682
  })));
659
683
  }
660
684
  /**
661
- * Get account member favorite resources
685
+ * Lists all favorite resources associated with a specific member.
662
686
  */
663
687
  export function listAccountMemberFavorites({ memberId }, opts) {
664
688
  return oazapfts.ok(oazapfts.fetchJson(`/v1/members/${encodeURIComponent(memberId)}/favorites`, {
@@ -666,7 +690,7 @@ export function listAccountMemberFavorites({ memberId }, opts) {
666
690
  }));
667
691
  }
668
692
  /**
669
- * Add account member favorite resource
693
+ * Adds a favorite resource to a member.
670
694
  */
671
695
  export function addAccountMemberFavorite({ memberId, createFavoriteResourceRequest }, opts) {
672
696
  return oazapfts.ok(oazapfts.fetchJson(`/v1/members/${encodeURIComponent(memberId)}/favorites`, oazapfts.json({
@@ -739,7 +763,7 @@ export function createUserInvitation({ createUserInvitationRequest }, opts) {
739
763
  })));
740
764
  }
741
765
  /**
742
- * Get Groups
766
+ * Returns a list of group information.
743
767
  */
744
768
  export function getGroups1({ size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn, includeDefaultGroup }, opts) {
745
769
  return oazapfts.ok(oazapfts.fetchJson(`/v1/groups${QS.query(QS.explode({
@@ -759,7 +783,7 @@ export function getGroups1({ size, page, sort, direction, search, filterMode, fi
759
783
  }));
760
784
  }
761
785
  /**
762
- * Create Group
786
+ * Creates a new group.
763
787
  */
764
788
  export function save({ newGroupRequest }, opts) {
765
789
  return oazapfts.ok(oazapfts.fetchJson("/v1/groups", oazapfts.json({
@@ -769,7 +793,7 @@ export function save({ newGroupRequest }, opts) {
769
793
  })));
770
794
  }
771
795
  /**
772
- * Get Group members
796
+ * Retrieves a list of roles for a specified group.
773
797
  */
774
798
  export function getRoles5({ groupId, size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }, opts) {
775
799
  return oazapfts.ok(oazapfts.fetchJson(`/v1/groups/${encodeURIComponent(groupId)}/roles${QS.query(QS.explode({
@@ -788,7 +812,7 @@ export function getRoles5({ groupId, size, page, sort, direction, search, filter
788
812
  }));
789
813
  }
790
814
  /**
791
- * Bind Group roles
815
+ * Binds a list of roles to a specified group.
792
816
  */
793
817
  export function bindRoles({ groupId, groupRoleIdsRequest }, opts) {
794
818
  return oazapfts.ok(oazapfts.fetchJson(`/v1/groups/${encodeURIComponent(groupId)}/roles`, oazapfts.json({
@@ -798,7 +822,7 @@ export function bindRoles({ groupId, groupRoleIdsRequest }, opts) {
798
822
  })));
799
823
  }
800
824
  /**
801
- * Get Group Resources
825
+ * Retrieves a list of resource associated with a specific group.
802
826
  */
803
827
  export function getGroupResources1({ groupId, size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }, opts) {
804
828
  return oazapfts.ok(oazapfts.fetchJson(`/v1/groups/${encodeURIComponent(groupId)}/resources${QS.query(QS.explode({
@@ -817,7 +841,7 @@ export function getGroupResources1({ groupId, size, page, sort, direction, searc
817
841
  }));
818
842
  }
819
843
  /**
820
- * Add Multiple Resources to Group
844
+ * Adds a list of resources to a specified group.
821
845
  */
822
846
  export function addResourcesToGroup({ groupId, addResourcesToGroupRequest }, opts) {
823
847
  return oazapfts.ok(oazapfts.fetchJson(`/v1/groups/${encodeURIComponent(groupId)}/resources`, oazapfts.json({
@@ -827,7 +851,7 @@ export function addResourcesToGroup({ groupId, addResourcesToGroupRequest }, opt
827
851
  })));
828
852
  }
829
853
  /**
830
- * Get Group members
854
+ * Retrieves a list of members fir a specific group.
831
855
  */
832
856
  export function getMembers1({ groupId, size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }, opts) {
833
857
  return oazapfts.ok(oazapfts.fetchJson(`/v1/groups/${encodeURIComponent(groupId)}/members${QS.query(QS.explode({
@@ -846,7 +870,7 @@ export function getMembers1({ groupId, size, page, sort, direction, search, filt
846
870
  }));
847
871
  }
848
872
  /**
849
- * Bind Group member
873
+ * Bind members to a specified group.
850
874
  */
851
875
  export function bindGroupMembers({ groupId, groupMemberIdsRequest }, opts) {
852
876
  return oazapfts.ok(oazapfts.fetchJson(`/v1/groups/${encodeURIComponent(groupId)}/members`, oazapfts.json({
@@ -874,7 +898,7 @@ export function create({ createFeatureFlagRequest }, opts) {
874
898
  })));
875
899
  }
876
900
  /**
877
- * List all Account Extensions
901
+ * Retrieves a list of extensions associated with the current user's account.
878
902
  */
879
903
  export function listExtensions(opts) {
880
904
  return oazapfts.ok(oazapfts.fetchJson("/v1/extensions", {
@@ -882,7 +906,7 @@ export function listExtensions(opts) {
882
906
  }));
883
907
  }
884
908
  /**
885
- * Create Account Extension
909
+ * Creates a new extension for the account.
886
910
  */
887
911
  export function createExtension({ extensionCreateRequest }, opts) {
888
912
  return oazapfts.ok(oazapfts.fetchJson("/v1/extensions", oazapfts.json({
@@ -892,7 +916,7 @@ export function createExtension({ extensionCreateRequest }, opts) {
892
916
  })));
893
917
  }
894
918
  /**
895
- * List all Account Extension Versions
919
+ * Retrieves a list of available versions for a specified extension.
896
920
  */
897
921
  export function listExtensionVersions({ slug }, opts) {
898
922
  return oazapfts.ok(oazapfts.fetchJson(`/v1/extensions/${encodeURIComponent(slug)}/versions`, {
@@ -900,7 +924,7 @@ export function listExtensionVersions({ slug }, opts) {
900
924
  }));
901
925
  }
902
926
  /**
903
- * Create Account Extension Version
927
+ * Creates a new version of an extension.
904
928
  */
905
929
  export function createExtensionVersion({ slug, name, body }, opts) {
906
930
  return oazapfts.ok(oazapfts.fetchJson(`/v1/extensions/${encodeURIComponent(slug)}/versions${QS.query(QS.explode({
@@ -912,7 +936,7 @@ export function createExtensionVersion({ slug, name, body }, opts) {
912
936
  })));
913
937
  }
914
938
  /**
915
- * List all Account Extension Links
939
+ * Lists all account's extension links.
916
940
  */
917
941
  export function listExtensionLinks({ workspaceId, $type, extensionSlug, showOnlyActive }, opts) {
918
942
  return oazapfts.ok(oazapfts.fetchJson(`/v1/extension-links${QS.query(QS.explode({
@@ -925,7 +949,7 @@ export function listExtensionLinks({ workspaceId, $type, extensionSlug, showOnly
925
949
  }));
926
950
  }
927
951
  /**
928
- * Create Account Extension Link
952
+ * Creates a new extension link for the account.
929
953
  */
930
954
  export function createExtensionLink({ extensionLinkCreateRequest }, opts) {
931
955
  return oazapfts.ok(oazapfts.fetchJson("/v1/extension-links", oazapfts.json({
@@ -935,7 +959,7 @@ export function createExtensionLink({ extensionLinkCreateRequest }, opts) {
935
959
  })));
936
960
  }
937
961
  /**
938
- * Send Welcome Email
962
+ * Sends a welcome email to a new user.
939
963
  */
940
964
  export function sendWelcomeEmail({ welcomeEmailRequest }, opts) {
941
965
  return oazapfts.ok(oazapfts.fetchJson("/v1/emails/welcome", oazapfts.json({
@@ -945,7 +969,7 @@ export function sendWelcomeEmail({ welcomeEmailRequest }, opts) {
945
969
  })));
946
970
  }
947
971
  /**
948
- * Send Download Email
972
+ * Sends a download email to the current user.
949
973
  */
950
974
  export function sendDownloadEmail(opts) {
951
975
  return oazapfts.ok(oazapfts.fetchJson("/v1/emails/download", {
@@ -954,7 +978,7 @@ export function sendDownloadEmail(opts) {
954
978
  }));
955
979
  }
956
980
  /**
957
- * Send contact email
981
+ * Sends a contact email.
958
982
  */
959
983
  export function sendContactEmail({ contactEmailRequest }, opts) {
960
984
  return oazapfts.ok(oazapfts.fetchJson("/v1/emails/contact", oazapfts.json({
@@ -964,7 +988,7 @@ export function sendContactEmail({ contactEmailRequest }, opts) {
964
988
  })));
965
989
  }
966
990
  /**
967
- * Switch user to account passed in the body
991
+ * Switches the user to the account specified in the body.
968
992
  */
969
993
  export function switchAccount({ switchAccountRequest }, opts) {
970
994
  return oazapfts.ok(oazapfts.fetchJson("/v1/authentication/switch-account", oazapfts.json({
@@ -974,7 +998,7 @@ export function switchAccount({ switchAccountRequest }, opts) {
974
998
  })));
975
999
  }
976
1000
  /**
977
- * Get credentials from personal service client (create if not exists one to the logged user).
1001
+ * Gets credentials from personal service client (create if not exists one to the logged user).
978
1002
  */
979
1003
  export function getPersonalClientCredentials(opts) {
980
1004
  return oazapfts.ok(oazapfts.fetchJson("/v1/authentication/personal-client-credentials", {
@@ -996,7 +1020,7 @@ export function getPersonalAccessToken1({ apiAuthorization, generateTokenFromPer
996
1020
  })));
997
1021
  }
998
1022
  /**
999
- * Disable client that generates Personal Access Tokens.
1023
+ * Disables the client that generates Personal Access Tokens.
1000
1024
  */
1001
1025
  export function disablePersonalAccessTokenGeneration(opts) {
1002
1026
  return oazapfts.ok(oazapfts.fetchJson("/v1/authentication/personal-access-token/unauthorize", {
@@ -1005,7 +1029,7 @@ export function disablePersonalAccessTokenGeneration(opts) {
1005
1029
  }));
1006
1030
  }
1007
1031
  /**
1008
- * Verify if exists a client created (authorized) to generate Access Token on logged user behalf.
1032
+ * Checks whether a client exists and is authorized to generate an Access Token on behalf of the logged-in user.
1009
1033
  */
1010
1034
  export function personalAccessTokenAuthorization(opts) {
1011
1035
  return oazapfts.ok(oazapfts.fetchJson("/v1/authentication/personal-access-token/authorize", {
@@ -1013,7 +1037,7 @@ export function personalAccessTokenAuthorization(opts) {
1013
1037
  }));
1014
1038
  }
1015
1039
  /**
1016
- * Authorize creating a client to generate Personal Access Tokens on your behalf.
1040
+ * Authorizes the creation of a client to generate Personal Access Tokens on your behalf.
1017
1041
  */
1018
1042
  export function createPersonalAccessToken(opts) {
1019
1043
  return oazapfts.ok(oazapfts.fetchJson("/v1/authentication/personal-access-token/authorize", {
@@ -1022,7 +1046,7 @@ export function createPersonalAccessToken(opts) {
1022
1046
  }));
1023
1047
  }
1024
1048
  /**
1025
- * Get an Access Token generated on logged user's service account behalf, since previously authorized.
1049
+ * Retrieves an Access Token generated on behalf of the logged-in user's service account, provided that prior authorization has been granted.
1026
1050
  */
1027
1051
  export function getPersonalAccessTokenFromServiceAccountOnly(opts) {
1028
1052
  return oazapfts.ok(oazapfts.fetchJson("/v1/authentication/personal-access-token-sa", {
@@ -1031,7 +1055,7 @@ export function getPersonalAccessTokenFromServiceAccountOnly(opts) {
1031
1055
  }));
1032
1056
  }
1033
1057
  /**
1034
- * Generate device code.
1058
+ * Generates a device code data for a user.
1035
1059
  */
1036
1060
  export function deviceCode({ email, freemiumAccess, codeChallenge, body }, opts) {
1037
1061
  return oazapfts.ok(oazapfts.fetchJson(`/v1/authentication/device-code${QS.query(QS.explode({
@@ -1073,6 +1097,16 @@ export function create1({ createAccountOrderRequest }, opts) {
1073
1097
  body: createAccountOrderRequest
1074
1098
  })));
1075
1099
  }
1100
+ /**
1101
+ * Allows to enable or disable trial SSO integrations.
1102
+ */
1103
+ export function updateTrialSsoSettings({ updateTrialSsoSettingsRequest }, opts) {
1104
+ return oazapfts.ok(oazapfts.fetchJson("/v1/admin/accounts/trial/sso", oazapfts.json({
1105
+ ...opts,
1106
+ method: "POST",
1107
+ body: updateTrialSsoSettingsRequest
1108
+ })));
1109
+ }
1076
1110
  /**
1077
1111
  * Creates a Trial account.
1078
1112
  */
@@ -1152,7 +1186,7 @@ export function ssoParseConfigurationFile({ protocol, body }, opts) {
1152
1186
  })));
1153
1187
  }
1154
1188
  /**
1155
- * Create an Account Order for Partner
1189
+ * Creates a partner account order.
1156
1190
  */
1157
1191
  export function createPartner({ createAccountPartnerOrderRequest }, opts) {
1158
1192
  return oazapfts.ok(oazapfts.fetchJson("/v1/account-orders/partners", oazapfts.json({
@@ -1162,7 +1196,7 @@ export function createPartner({ createAccountPartnerOrderRequest }, opts) {
1162
1196
  })));
1163
1197
  }
1164
1198
  /**
1165
- * Validate new Partner account data
1199
+ * Validates new Partner account data.
1166
1200
  */
1167
1201
  export function validateNewPartnerData({ validateAccountPartnerDataRequest }, opts) {
1168
1202
  return oazapfts.ok(oazapfts.fetchJson("/v1/account-orders/partners/validations/creation-data", oazapfts.json({
@@ -1200,35 +1234,6 @@ export function revokeServiceCredential({ id }, opts) {
1200
1234
  method: "PATCH"
1201
1235
  }));
1202
1236
  }
1203
- /**
1204
- * Retrieves a list of rate limit with the associated service credential.
1205
- */
1206
- export function getAllServiceCredentialRateLimit({ size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }, opts) {
1207
- return oazapfts.ok(oazapfts.fetchJson(`/v2/service-credentials/rate-limit${QS.query(QS.explode({
1208
- size,
1209
- page,
1210
- sort,
1211
- direction,
1212
- search,
1213
- filterMode,
1214
- filterBy,
1215
- filterValue,
1216
- multiFilterMode,
1217
- filterIn
1218
- }))}`, {
1219
- ...opts
1220
- }));
1221
- }
1222
- /**
1223
- * Updates the rate limit of a service credential.
1224
- */
1225
- export function updateServiceCredentialRateLimit({ serviceCredentialRateLimitRequest }, opts) {
1226
- return oazapfts.ok(oazapfts.fetchJson("/v2/service-credentials/rate-limit", oazapfts.json({
1227
- ...opts,
1228
- method: "PATCH",
1229
- body: serviceCredentialRateLimitRequest
1230
- })));
1231
- }
1232
1237
  /**
1233
1238
  * Delete a member permissions
1234
1239
  */
@@ -1250,7 +1255,7 @@ export function updateMemberPermissions({ memberId, body }, opts) {
1250
1255
  })));
1251
1256
  }
1252
1257
  /**
1253
- * Delete Group permissions
1258
+ * Deletes specific permissions from a group.
1254
1259
  */
1255
1260
  export function deleteGroupPermissions({ groupId, body }, opts) {
1256
1261
  return oazapfts.ok(oazapfts.fetchJson(`/v2/groups/${encodeURIComponent(groupId)}/permissions`, oazapfts.json({
@@ -1260,7 +1265,7 @@ export function deleteGroupPermissions({ groupId, body }, opts) {
1260
1265
  })));
1261
1266
  }
1262
1267
  /**
1263
- * Update Group permissions
1268
+ * Updates the permissions of a specified group.
1264
1269
  */
1265
1270
  export function updateGroupPermissions({ groupId, body }, opts) {
1266
1271
  return oazapfts.ok(oazapfts.fetchJson(`/v2/groups/${encodeURIComponent(groupId)}/permissions`, oazapfts.json({
@@ -1280,7 +1285,7 @@ export function associateGroupToServiceCredential({ id, serviceCredentialAssocia
1280
1285
  })));
1281
1286
  }
1282
1287
  /**
1283
- * Revoke Service Credential
1288
+ * Revokes a service credential.
1284
1289
  */
1285
1290
  export function revokeServiceCredential1({ id }, opts) {
1286
1291
  return oazapfts.ok(oazapfts.fetchJson(`/v1/service-credentials/${encodeURIComponent(id)}/revocation`, {
@@ -1400,7 +1405,7 @@ export function resendUserInvitation({ id }, opts) {
1400
1405
  }));
1401
1406
  }
1402
1407
  /**
1403
- * Get Group by ID
1408
+ * Retrieves information about a specific group by its ID.
1404
1409
  */
1405
1410
  export function getGroupById({ groupId }, opts) {
1406
1411
  return oazapfts.ok(oazapfts.fetchJson(`/v1/groups/${encodeURIComponent(groupId)}`, {
@@ -1408,7 +1413,7 @@ export function getGroupById({ groupId }, opts) {
1408
1413
  }));
1409
1414
  }
1410
1415
  /**
1411
- * Delete Group
1416
+ * Deletes a group by its ID.
1412
1417
  */
1413
1418
  export function deleteV1GroupsByGroupId({ groupId }, opts) {
1414
1419
  return oazapfts.ok(oazapfts.fetchJson(`/v1/groups/${encodeURIComponent(groupId)}`, {
@@ -1417,7 +1422,7 @@ export function deleteV1GroupsByGroupId({ groupId }, opts) {
1417
1422
  }));
1418
1423
  }
1419
1424
  /**
1420
- * Update Group
1425
+ * Updates an existing group.
1421
1426
  */
1422
1427
  export function update1({ groupId, updateGroupRequest }, opts) {
1423
1428
  return oazapfts.ok(oazapfts.fetchJson(`/v1/groups/${encodeURIComponent(groupId)}`, oazapfts.json({
@@ -1427,7 +1432,7 @@ export function update1({ groupId, updateGroupRequest }, opts) {
1427
1432
  })));
1428
1433
  }
1429
1434
  /**
1430
- * Delete Group permissions
1435
+ * Deletes specific permissions from a group.
1431
1436
  */
1432
1437
  export function deleteGroupPermissions1({ groupId, deleteGroupPermissionsRequest }, opts) {
1433
1438
  return oazapfts.ok(oazapfts.fetchJson(`/v1/groups/${encodeURIComponent(groupId)}/permissions`, oazapfts.json({
@@ -1437,7 +1442,7 @@ export function deleteGroupPermissions1({ groupId, deleteGroupPermissionsRequest
1437
1442
  })));
1438
1443
  }
1439
1444
  /**
1440
- * Update Group permissions
1445
+ * Updates the permissions of a specified group.
1441
1446
  */
1442
1447
  export function updateGroupPermissions1({ groupId, updateGroupPermissionsRequest }, opts) {
1443
1448
  return oazapfts.ok(oazapfts.fetchJson(`/v1/groups/${encodeURIComponent(groupId)}/permissions`, oazapfts.json({
@@ -1465,7 +1470,7 @@ export function disable({ id }, opts) {
1465
1470
  }));
1466
1471
  }
1467
1472
  /**
1468
- * Delete Account Extension
1473
+ * Deletes an account's extension.
1469
1474
  */
1470
1475
  export function deleteExtension({ slug }, opts) {
1471
1476
  return oazapfts.ok(oazapfts.fetchJson(`/v1/extensions/${encodeURIComponent(slug)}`, {
@@ -1474,7 +1479,7 @@ export function deleteExtension({ slug }, opts) {
1474
1479
  }));
1475
1480
  }
1476
1481
  /**
1477
- * Update Account Extension
1482
+ * Updates an account's extension.
1478
1483
  */
1479
1484
  export function updateExtension({ slug, extensionUpdateRequest }, opts) {
1480
1485
  return oazapfts.ok(oazapfts.fetchJson(`/v1/extensions/${encodeURIComponent(slug)}`, oazapfts.json({
@@ -1484,7 +1489,7 @@ export function updateExtension({ slug, extensionUpdateRequest }, opts) {
1484
1489
  })));
1485
1490
  }
1486
1491
  /**
1487
- * Delete Account Extension Link
1492
+ * Deletes an extension link by its ID.
1488
1493
  */
1489
1494
  export function deleteExtensionLink({ id }, opts) {
1490
1495
  return oazapfts.ok(oazapfts.fetchJson(`/v1/extension-links/${encodeURIComponent(id)}`, {
@@ -1493,7 +1498,7 @@ export function deleteExtensionLink({ id }, opts) {
1493
1498
  }));
1494
1499
  }
1495
1500
  /**
1496
- * Update Account Extension Link
1501
+ * Updates a specified account's extension link.
1497
1502
  */
1498
1503
  export function updateExtensionLink({ id, extensionLinkUpdateRequest }, opts) {
1499
1504
  return oazapfts.ok(oazapfts.fetchJson(`/v1/extension-links/${encodeURIComponent(id)}`, oazapfts.json({
@@ -1559,7 +1564,7 @@ export function updateRateLimit({ updateRateLimitRequest }, opts) {
1559
1564
  })));
1560
1565
  }
1561
1566
  /**
1562
- * Get Partner by account Id
1567
+ * Retrieves partner account details by account Id.
1563
1568
  */
1564
1569
  export function getPartnerAccount({ id }, opts) {
1565
1570
  return oazapfts.ok(oazapfts.fetchJson(`/v1/account-partners/${encodeURIComponent(id)}`, {
@@ -1567,7 +1572,7 @@ export function getPartnerAccount({ id }, opts) {
1567
1572
  }));
1568
1573
  }
1569
1574
  /**
1570
- * Delete Partner
1575
+ * Inactivates a partner account by disabling its associated tenant and updating its status.
1571
1576
  */
1572
1577
  export function deletePartner({ id }, opts) {
1573
1578
  return oazapfts.ok(oazapfts.fetchJson(`/v1/account-partners/${encodeURIComponent(id)}`, {
@@ -1576,7 +1581,7 @@ export function deletePartner({ id }, opts) {
1576
1581
  }));
1577
1582
  }
1578
1583
  /**
1579
- * Update Partner Account data.
1584
+ * Updates the partner account data.
1580
1585
  */
1581
1586
  export function updatePartnerAccountData({ id, accountPartnerAccountDataUpdateRequest }, opts) {
1582
1587
  return oazapfts.ok(oazapfts.fetchJson(`/v1/account-partners/${encodeURIComponent(id)}`, oazapfts.json({
@@ -1586,7 +1591,7 @@ export function updatePartnerAccountData({ id, accountPartnerAccountDataUpdateRe
1586
1591
  })));
1587
1592
  }
1588
1593
  /**
1589
- * Update Partner Account Admin data.
1594
+ * Updates the partner admin data for a specific account.
1590
1595
  */
1591
1596
  export function updatePartnerAccountAdminData({ id, accountPartnerAdminDataUpdateRequest }, opts) {
1592
1597
  return oazapfts.ok(oazapfts.fetchJson(`/v1/account-partners/${encodeURIComponent(id)}/admin`, oazapfts.json({
@@ -1612,7 +1617,7 @@ export function getServiceCredentialByIdRateLimit({ clientId }, opts) {
1612
1617
  }));
1613
1618
  }
1614
1619
  /**
1615
- * Get Roles
1620
+ * Retrieves a list of roles for the current tenant.
1616
1621
  */
1617
1622
  export function getRoles({ size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }, opts) {
1618
1623
  return oazapfts.ok(oazapfts.fetchJson(`/v2/roles${QS.query(QS.explode({
@@ -1631,7 +1636,7 @@ export function getRoles({ size, page, sort, direction, search, filterMode, filt
1631
1636
  }));
1632
1637
  }
1633
1638
  /**
1634
- * Get all Global Resources and Actions compared to role
1639
+ * Retrieves a list of all global resources and their associated actions for a specified role.
1635
1640
  */
1636
1641
  export function getResourcesAndActionsWithStatus({ roleId, size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }, opts) {
1637
1642
  return oazapfts.ok(oazapfts.fetchJson(`/v2/roles/${encodeURIComponent(roleId)}/resources${QS.query(QS.explode({
@@ -1650,7 +1655,7 @@ export function getResourcesAndActionsWithStatus({ roleId, size, page, sort, dir
1650
1655
  }));
1651
1656
  }
1652
1657
  /**
1653
- * Get role members
1658
+ * Retrieves a list of members associated with a specific role.
1654
1659
  */
1655
1660
  export function getRoleMembers({ roleId, size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }, opts) {
1656
1661
  return oazapfts.ok(oazapfts.fetchJson(`/v2/roles/${encodeURIComponent(roleId)}/members${QS.query(QS.explode({
@@ -1669,7 +1674,7 @@ export function getRoleMembers({ roleId, size, page, sort, direction, search, fi
1669
1674
  }));
1670
1675
  }
1671
1676
  /**
1672
- * Get Groups from role
1677
+ * Retrieves a list of role groups associated with a specific role ID.
1673
1678
  */
1674
1679
  export function getRoleGroups({ roleId, size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }, opts) {
1675
1680
  return oazapfts.ok(oazapfts.fetchJson(`/v2/roles/${encodeURIComponent(roleId)}/groups${QS.query(QS.explode({
@@ -1745,7 +1750,7 @@ export function getResourceGroups({ resourceId, size, page, sort, direction, sea
1745
1750
  }));
1746
1751
  }
1747
1752
  /**
1748
- * Get Resource Types
1753
+ * Finds and retrieves a list of resource types for the current account.
1749
1754
  */
1750
1755
  export function getResourceTypes({ size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }, opts) {
1751
1756
  return oazapfts.ok(oazapfts.fetchJson(`/v2/resource-types${QS.query(QS.explode({
@@ -1821,7 +1826,7 @@ export function getMemberGroups({ memberId, size, page, sort, direction, search,
1821
1826
  }));
1822
1827
  }
1823
1828
  /**
1824
- * Get Groups
1829
+ * Returns a list of group details.
1825
1830
  */
1826
1831
  export function getGroups({ size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn, includeDefaultGroup }, opts) {
1827
1832
  return oazapfts.ok(oazapfts.fetchJson(`/v2/groups${QS.query(QS.explode({
@@ -1841,7 +1846,7 @@ export function getGroups({ size, page, sort, direction, search, filterMode, fil
1841
1846
  }));
1842
1847
  }
1843
1848
  /**
1844
- * Get Group roles
1849
+ * Retrieves a list of roles for a specified group.
1845
1850
  */
1846
1851
  export function getRoles2({ groupId, size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }, opts) {
1847
1852
  return oazapfts.ok(oazapfts.fetchJson(`/v2/groups/${encodeURIComponent(groupId)}/roles${QS.query(QS.explode({
@@ -1860,7 +1865,7 @@ export function getRoles2({ groupId, size, page, sort, direction, search, filter
1860
1865
  }));
1861
1866
  }
1862
1867
  /**
1863
- * Get Group Resources
1868
+ * Finds and returns a list of resources associated with a specific group.
1864
1869
  */
1865
1870
  export function getGroupResources({ groupId, size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }, opts) {
1866
1871
  return oazapfts.ok(oazapfts.fetchJson(`/v2/groups/${encodeURIComponent(groupId)}/resources${QS.query(QS.explode({
@@ -1879,7 +1884,7 @@ export function getGroupResources({ groupId, size, page, sort, direction, search
1879
1884
  }));
1880
1885
  }
1881
1886
  /**
1882
- * Get Group members
1887
+ * Returns a list of members from a specified group.
1883
1888
  */
1884
1889
  export function getMembers({ groupId, size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }, opts) {
1885
1890
  return oazapfts.ok(oazapfts.fetchJson(`/v2/groups/${encodeURIComponent(groupId)}/members${QS.query(QS.explode({
@@ -1914,7 +1919,7 @@ export function getUserAccountWithRole(opts) {
1914
1919
  }));
1915
1920
  }
1916
1921
  /**
1917
- * Get Accounts
1922
+ * Finds and returns a list of active accounts.
1918
1923
  */
1919
1924
  export function getAccounts({ accountType, slug, id }, opts) {
1920
1925
  return oazapfts.ok(oazapfts.fetchJson(`/v1/stackspot/accounts${QS.query(QS.explode({
@@ -1926,7 +1931,7 @@ export function getAccounts({ accountType, slug, id }, opts) {
1926
1931
  }));
1927
1932
  }
1928
1933
  /**
1929
- * Get Account by id
1934
+ * Finds and retrieves active account details by the provided account ID.
1930
1935
  */
1931
1936
  export function getAccount({ id }, opts) {
1932
1937
  return oazapfts.ok(oazapfts.fetchJson(`/v1/stackspot/accounts/${encodeURIComponent(id)}`, {
@@ -1934,7 +1939,7 @@ export function getAccount({ id }, opts) {
1934
1939
  }));
1935
1940
  }
1936
1941
  /**
1937
- * Get Account Members
1942
+ * Returns a list of account members for a specified account.
1938
1943
  */
1939
1944
  export function getAccountMembers1({ id, size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }, opts) {
1940
1945
  return oazapfts.ok(oazapfts.fetchJson(`/v1/stackspot/accounts/${encodeURIComponent(id)}/members${QS.query(QS.explode({
@@ -1953,7 +1958,7 @@ export function getAccountMembers1({ id, size, page, sort, direction, search, fi
1953
1958
  }));
1954
1959
  }
1955
1960
  /**
1956
- * Get Service Credential by ID (Client ID)
1961
+ * Retrieves the service credential details for a given client ID.
1957
1962
  */
1958
1963
  export function getServiceCredential({ id }, opts) {
1959
1964
  return oazapfts.ok(oazapfts.fetchJson(`/v1/service-credentials/${encodeURIComponent(id)}`, {
@@ -1969,7 +1974,7 @@ export function getServiceCredentialPermissions({ id }, opts) {
1969
1974
  }));
1970
1975
  }
1971
1976
  /**
1972
- * List service credential groups
1977
+ * Retrieves a list of service credential groups associated with a specific client ID.
1973
1978
  */
1974
1979
  export function getServiceCredentialGroups1({ id }, opts) {
1975
1980
  return oazapfts.ok(oazapfts.fetchJson(`/v1/service-credentials/${encodeURIComponent(id)}/groups`, {
@@ -2058,7 +2063,7 @@ export function getResourceGroups1({ resourceId, size, page, sort, direction, se
2058
2063
  }));
2059
2064
  }
2060
2065
  /**
2061
- * Get Resource Types
2066
+ * Finds and retrieves a list of resource types for the current account.
2062
2067
  */
2063
2068
  export function getResourceTypes1({ size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }, opts) {
2064
2069
  return oazapfts.ok(oazapfts.fetchJson(`/v1/resource-types${QS.query(QS.explode({
@@ -2077,7 +2082,7 @@ export function getResourceTypes1({ size, page, sort, direction, search, filterM
2077
2082
  }));
2078
2083
  }
2079
2084
  /**
2080
- * Validate permission access
2085
+ * Validates user permission access for resources.
2081
2086
  */
2082
2087
  export function getAccess({ resourceType, resource, action, attribute }, opts) {
2083
2088
  return oazapfts.ok(oazapfts.fetchJson(`/v1/permissions/access${QS.query(QS.explode({
@@ -2098,7 +2103,15 @@ export function getResources2({ memberId }, opts) {
2098
2103
  }));
2099
2104
  }
2100
2105
  /**
2101
- * Get member favorite resources by type
2106
+ * Retrieves a magic link to create a new FIDO key.
2107
+ */
2108
+ export function getFidoMagicLink({ memberId }, opts) {
2109
+ return oazapfts.ok(oazapfts.fetchJson(`/v1/members/${encodeURIComponent(memberId)}/fido-credentials/magic-link`, {
2110
+ ...opts
2111
+ }));
2112
+ }
2113
+ /**
2114
+ * Lists the IDs of a member's favorite resources of a specified type.
2102
2115
  */
2103
2116
  export function listMemberFavoritesByResource({ memberId, resourceType }, opts) {
2104
2117
  return oazapfts.ok(oazapfts.fetchJson(`/v1/members/${encodeURIComponent(memberId)}/favorites/resources/${encodeURIComponent(resourceType)}`, {
@@ -2125,7 +2138,7 @@ export function getAccountMembersToCollaborators({ size, page, sort, direction,
2125
2138
  }));
2126
2139
  }
2127
2140
  /**
2128
- * Get a Account Extension Version
2141
+ * Retrieves the details of a specific extension version.
2129
2142
  */
2130
2143
  export function getExtensionVersion({ slug, versionName }, opts) {
2131
2144
  return oazapfts.ok(oazapfts.fetchJson(`/v1/extensions/${encodeURIComponent(slug)}/versions/${encodeURIComponent(versionName)}`, {
@@ -2133,7 +2146,7 @@ export function getExtensionVersion({ slug, versionName }, opts) {
2133
2146
  }));
2134
2147
  }
2135
2148
  /**
2136
- * Delete Account Extension Version
2149
+ * Deletes a specific version of an extension.
2137
2150
  */
2138
2151
  export function deleteExtensionVersion({ slug, versionName }, opts) {
2139
2152
  return oazapfts.ok(oazapfts.fetchJson(`/v1/extensions/${encodeURIComponent(slug)}/versions/${encodeURIComponent(versionName)}`, {
@@ -2142,7 +2155,7 @@ export function deleteExtensionVersion({ slug, versionName }, opts) {
2142
2155
  }));
2143
2156
  }
2144
2157
  /**
2145
- * Get the active Extension Version
2158
+ * Retrieves the details of the extension's active version.
2146
2159
  */
2147
2160
  export function getActiveExtensionVersion({ slug }, opts) {
2148
2161
  return oazapfts.ok(oazapfts.fetchJson(`/v1/extensions/${encodeURIComponent(slug)}/active`, {
@@ -2150,7 +2163,7 @@ export function getActiveExtensionVersion({ slug }, opts) {
2150
2163
  }));
2151
2164
  }
2152
2165
  /**
2153
- * Get Authentication Configuration for account
2166
+ * Gets the Authentication Configuration for an account.
2154
2167
  */
2155
2168
  export function getAuthenticationConfig({ tenantSlug }, opts) {
2156
2169
  return oazapfts.ok(oazapfts.fetchJson(`/v1/authentication/config${QS.query(QS.explode({
@@ -2185,6 +2198,14 @@ export function getAccountSlug({ accountId }, opts) {
2185
2198
  ...opts
2186
2199
  }));
2187
2200
  }
2201
+ /**
2202
+ * Retrieves the current status of trial SSO integrations.
2203
+ */
2204
+ export function getTrialSsoSettings(opts) {
2205
+ return oazapfts.ok(oazapfts.fetchJson("/v1/accounts/trial/sso", {
2206
+ ...opts
2207
+ }));
2208
+ }
2188
2209
  /**
2189
2210
  * Finds and returns personal account details.
2190
2211
  */
@@ -2201,17 +2222,6 @@ export function getPersonalAccountExpirationData(opts) {
2201
2222
  ...opts
2202
2223
  }));
2203
2224
  }
2204
- /**
2205
- * Determines whether account data is available for registration based on the provided name and slug.
2206
- */
2207
- export function accountDataIsAvailable({ name, slug }, opts) {
2208
- return oazapfts.ok(oazapfts.fetchJson(`/v1/accounts/trial/available${QS.query(QS.explode({
2209
- name,
2210
- slug
2211
- }))}`, {
2212
- ...opts
2213
- }));
2214
- }
2215
2225
  /**
2216
2226
  * Retrieves a list of SSO for the current account.
2217
2227
  */
@@ -2232,7 +2242,7 @@ export function getAllAccountSso({ size, page, sort, direction, search, filterMo
2232
2242
  }));
2233
2243
  }
2234
2244
  /**
2235
- * Get Partners who are sharing content.
2245
+ * Finds and returns a list of partners who are sharing content.
2236
2246
  */
2237
2247
  export function getSharingPartners({ name }, opts) {
2238
2248
  return oazapfts.ok(oazapfts.fetchJson(`/v1/account-partners/sharing${QS.query(QS.explode({
@@ -2242,7 +2252,7 @@ export function getSharingPartners({ name }, opts) {
2242
2252
  }));
2243
2253
  }
2244
2254
  /**
2245
- * Get Partners with whom it is allowed to share content.
2255
+ * Finds and returns a list of partners with whom sharing content is allowed.
2246
2256
  */
2247
2257
  export function getPartnersSharingAllowed({ name }, opts) {
2248
2258
  return oazapfts.ok(oazapfts.fetchJson(`/v1/account-partners/sharing-allowed${QS.query(QS.explode({
@@ -2252,7 +2262,7 @@ export function getPartnersSharingAllowed({ name }, opts) {
2252
2262
  }));
2253
2263
  }
2254
2264
  /**
2255
- * Validate Partner association limit
2265
+ * Validates Partner association limit.
2256
2266
  */
2257
2267
  export function validatePartnerAssociationLimit(opts) {
2258
2268
  return oazapfts.ok(oazapfts.fetchJson("/v1/account-orders/partners/validations/association-limit", {
@@ -2260,7 +2270,7 @@ export function validatePartnerAssociationLimit(opts) {
2260
2270
  }));
2261
2271
  }
2262
2272
  /**
2263
- * Disassociate Group to Service Credential
2273
+ * Disassociates a group from a service credential.
2264
2274
  */
2265
2275
  export function disassociateGroupToServiceCredential({ id, groupId }, opts) {
2266
2276
  return oazapfts.ok(oazapfts.fetchJson(`/v1/service-credentials/${encodeURIComponent(id)}/teams/${encodeURIComponent(groupId)}`, {
@@ -2296,7 +2306,16 @@ export function deleteProfileImage({ memberId }, opts) {
2296
2306
  }));
2297
2307
  }
2298
2308
  /**
2299
- * Remove resource from member favorites
2309
+ * Deletes a specific FIDO key.
2310
+ */
2311
+ export function deleteFidoKey({ memberId, keyId }, opts) {
2312
+ return oazapfts.ok(oazapfts.fetchJson(`/v1/members/${encodeURIComponent(memberId)}/fido-credentials/${encodeURIComponent(keyId)}`, {
2313
+ ...opts,
2314
+ method: "DELETE"
2315
+ }));
2316
+ }
2317
+ /**
2318
+ * Removes a specified resource from a member favorites.
2300
2319
  */
2301
2320
  export function deleteMemberFavorite({ memberId, resourceType, resourceId }, opts) {
2302
2321
  return oazapfts.ok(oazapfts.fetchJson(`/v1/members/${encodeURIComponent(memberId)}/favorites/${encodeURIComponent(resourceType)}/${encodeURIComponent(resourceId)}`, {
@@ -2305,7 +2324,7 @@ export function deleteMemberFavorite({ memberId, resourceType, resourceId }, opt
2305
2324
  }));
2306
2325
  }
2307
2326
  /**
2308
- * Delete Group role
2327
+ * Deletes a specific role from a group.
2309
2328
  */
2310
2329
  export function deleteRole({ groupId, roleId }, opts) {
2311
2330
  return oazapfts.ok(oazapfts.fetchJson(`/v1/groups/${encodeURIComponent(groupId)}/roles/${encodeURIComponent(roleId)}`, {
@@ -2314,7 +2333,7 @@ export function deleteRole({ groupId, roleId }, opts) {
2314
2333
  }));
2315
2334
  }
2316
2335
  /**
2317
- * Delete Resource from Group
2336
+ * Removes a resource from a specified group.
2318
2337
  */
2319
2338
  export function deleteResourceFromGroup({ groupId, resourceId }, opts) {
2320
2339
  return oazapfts.ok(oazapfts.fetchJson(`/v1/groups/${encodeURIComponent(groupId)}/resources/${encodeURIComponent(resourceId)}`, {
@@ -2323,7 +2342,7 @@ export function deleteResourceFromGroup({ groupId, resourceId }, opts) {
2323
2342
  }));
2324
2343
  }
2325
2344
  /**
2326
- * Delete Group member
2345
+ * Deletes a member from a specified group.
2327
2346
  */
2328
2347
  export function deleteMember({ groupId, memberId }, opts) {
2329
2348
  return oazapfts.ok(oazapfts.fetchJson(`/v1/groups/${encodeURIComponent(groupId)}/members/${encodeURIComponent(memberId)}`, {