@stack-spot/portal-network 0.116.3 → 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,11 +14,29 @@ const oazapfts = Oazapfts.runtime(defaults);
14
14
  export const servers = {
15
15
  generatedServerUrl: "https://account-account-api.dev.stackspot.com"
16
16
  };
17
- export type UserScmInfoResponse = {
18
- /** Secrets name */
19
- secretName: string;
20
- /** Provider type */
21
- provider: "GITHUB" | "GITLAB" | "BITBUCKET" | "AZURE" | "GITLAB_ONPRM";
17
+ export type RateLimitValue = {
18
+ "type": "ACCOUNT" | "SERVICE_CREDENTIAL";
19
+ value: number;
20
+ };
21
+ export type ServiceCredentialRateLimitResponse = {
22
+ /** Service credential ID */
23
+ id: string;
24
+ /** Service credential name */
25
+ name: string;
26
+ scMaxPerMin: RateLimitValue;
27
+ scMaxPerDay: RateLimitValue;
28
+ };
29
+ export type PageResponseServiceCredentialRateLimitResponse = {
30
+ /** Current page content */
31
+ items?: ServiceCredentialRateLimitResponse[];
32
+ /** Total elements found */
33
+ totalElements: number;
34
+ /** Current page number */
35
+ page: number;
36
+ /** Length of current page items */
37
+ size: number;
38
+ /** Total pages found */
39
+ totalPages: number;
22
40
  };
23
41
  export type ValidationDetails = {
24
42
  code: string;
@@ -32,6 +50,20 @@ export type ErrorResponse = {
32
50
  details: string;
33
51
  validationDetails?: ValidationDetails[];
34
52
  };
53
+ export type ServiceCredentialRateLimitRequest = {
54
+ /** Maximum number of executions allowed per minute. Use -1 for no limit. */
55
+ scMaxPerMin?: number;
56
+ /** Maximum number of executions allowed per day. Use -1 for no limit. */
57
+ scMaxPerDay?: number;
58
+ /** List of service credential IDs */
59
+ serviceCredentialIds: string[];
60
+ };
61
+ export type UserScmInfoResponse = {
62
+ /** Secrets name */
63
+ secretName: string;
64
+ /** Provider type */
65
+ provider: "GITHUB" | "GITLAB" | "BITBUCKET" | "AZURE" | "GITLAB_ONPRM";
66
+ };
35
67
  export type UserScmInfoRequest = {
36
68
  /** Repository Username */
37
69
  user: string;
@@ -629,9 +661,9 @@ export type IamCreateScopeRequest = {
629
661
  };
630
662
  };
631
663
  export type PermissionActionResponse = {
632
- /** The action id from StackSpot IAM */
664
+ /** The action ID */
633
665
  id: string;
634
- /** The client ID from StackSpot IAM */
666
+ /** The client ID */
635
667
  clientId?: string;
636
668
  /** Action's name */
637
669
  name: string;
@@ -641,9 +673,9 @@ export type PermissionActionResponse = {
641
673
  createdAt: string;
642
674
  };
643
675
  export type PermissionTypeResponse = {
644
- /** Resource type ID from StackSpot IAM */
676
+ /** Resource type ID */
645
677
  id: string;
646
- /** Resource type client ID from StackSpot IAM */
678
+ /** Resource type client ID */
647
679
  clientId?: string;
648
680
  /** Resource type name */
649
681
  name: string;
@@ -653,9 +685,9 @@ export type PermissionTypeResponse = {
653
685
  createdAt: string;
654
686
  };
655
687
  export type PermissionResourceResponse = {
656
- /** Resource ID from StackSpot IAM */
688
+ /** Resource ID */
657
689
  id: string;
658
- /** Resource's client ID from StackSpot IAM */
690
+ /** Resource's client ID */
659
691
  clientId?: string;
660
692
  /** Resource's name */
661
693
  name: string;
@@ -670,7 +702,7 @@ export type PermissionStatementResponse = {
670
702
  resource: PermissionResourceResponse;
671
703
  };
672
704
  export type PermissionResponse = {
673
- /** Permission ID from StackSpot IAM */
705
+ /** Permission ID */
674
706
  id: string;
675
707
  /** Permission's name */
676
708
  name: string;
@@ -682,7 +714,7 @@ export type PermissionResponse = {
682
714
  statements: PermissionStatementResponse[];
683
715
  };
684
716
  export type RoleResponse = {
685
- /** Role id from Keycloak */
717
+ /** Role id */
686
718
  id: string;
687
719
  /** Role name */
688
720
  name: string;
@@ -1233,6 +1265,24 @@ export type CreateAccountOrderRequest = {
1233
1265
  /** Email list of the sales representatives responsible for this request. */
1234
1266
  salesRepresentatives: string[];
1235
1267
  };
1268
+ export type UpdateTrialSsoSettingsRequest = {
1269
+ /** github */
1270
+ github: boolean;
1271
+ /** microsoft */
1272
+ microsoft: boolean;
1273
+ /** google */
1274
+ google: boolean;
1275
+ };
1276
+ export type UpdateTrialSsoSettingsResponse = {
1277
+ /** Entity id */
1278
+ id: number;
1279
+ /** Is github SSO enabled */
1280
+ github: boolean;
1281
+ /** Is microsoft SSO enabled */
1282
+ microsoft: boolean;
1283
+ /** Is google SSO enabled */
1284
+ google: boolean;
1285
+ };
1236
1286
  export type AccountTrialCreateRequest = {
1237
1287
  /** The slug to use in URL as unique identifying part representing the account (https://developer.mozilla.org/en-US/docs/Glossary/Slug). Example: zup */
1238
1288
  slug: string;
@@ -1251,6 +1301,16 @@ export type AccountTrialCreateRequest = {
1251
1301
  /** The custom channel used for the trial user to reach Stackspot */
1252
1302
  customReachedBy?: string;
1253
1303
  };
1304
+ export type PersonalAccountExpirationDataResponse = {
1305
+ /** Account id */
1306
+ accountId: string;
1307
+ /** Account name */
1308
+ name: string;
1309
+ /** Account remaining trial days */
1310
+ remainingTrialDays: number;
1311
+ /** Date that trial Account will be blocked */
1312
+ validUntil: string;
1313
+ };
1254
1314
  export type AccountCollaboratorRequest = {
1255
1315
  /** The API id of account requester */
1256
1316
  accountApiId: string;
@@ -1384,44 +1444,6 @@ export type UpdateServiceCredentialScopesRequest = {
1384
1444
  /** Service credential statements */
1385
1445
  scopes: string[];
1386
1446
  };
1387
- export type ServiceCredentialRateLimitResponse = {
1388
- /** Service credential ID */
1389
- serviceCredentialId: string;
1390
- /** Service credential name */
1391
- name: string;
1392
- /** When was created */
1393
- createdAt?: string;
1394
- /** Who created */
1395
- createdBy?: string;
1396
- /** Who updated */
1397
- updatedBy?: string;
1398
- /** When was updated */
1399
- updatedAt?: string;
1400
- /** Limit of executions per minute */
1401
- scMaxPerMin: number;
1402
- /** Limit of executions per day */
1403
- scMaxPerDay: number;
1404
- };
1405
- export type PageResponseServiceCredentialRateLimitResponse = {
1406
- /** Current page content */
1407
- items?: ServiceCredentialRateLimitResponse[];
1408
- /** Total elements found */
1409
- totalElements: number;
1410
- /** Current page number */
1411
- page: number;
1412
- /** Length of current page items */
1413
- size: number;
1414
- /** Total pages found */
1415
- totalPages: number;
1416
- };
1417
- export type ServiceCredentialRateLimitRequest = {
1418
- /** Limit of executions per minute */
1419
- scMaxPerMin?: number;
1420
- /** Limit of executions per day */
1421
- scMaxPerDay?: number;
1422
- /** List of service credentials IDs */
1423
- serviceCredentialIds: string[];
1424
- };
1425
1447
  export type DeleteMemberPermissionsRequest = {
1426
1448
  /** Permission Action */
1427
1449
  actionName: string;
@@ -1447,7 +1469,7 @@ export type DeleteGroupPermissionsRequest = {
1447
1469
  resourceSlug: string;
1448
1470
  };
1449
1471
  export type UpdateGroupPermissionsRequest = {
1450
- /** Permission Action */
1472
+ /** Permission Action name */
1451
1473
  actionName: string;
1452
1474
  /** Slug from resource type */
1453
1475
  resourceTypeSlug: string;
@@ -1589,15 +1611,15 @@ export type RateLimitResponse = {
1589
1611
  scMaxPerDay: number;
1590
1612
  };
1591
1613
  export type UpdateRateLimitRequest = {
1592
- /** Maximum number of executions per day */
1614
+ /** Maximum number of executions allowed per day for Personal Access Tokens (PAT). Set to -1 for unlimited executions. */
1593
1615
  patMaxExecPerDay?: number;
1594
- /** default number of executions per min */
1616
+ /** Default maximum number of executions allowed per minute for Service Clients (SC). */
1595
1617
  scDefaultMaxPerMin?: number;
1596
- /** default number of executions per day */
1618
+ /** Default maximum number of executions allowed per day for Service Clients (SC). */
1597
1619
  scDefaultMaxPerDay?: number;
1598
- /** number of executions per min */
1620
+ /** Maximum number of executions allowed per minute for a specific Service Client (SC). Set to -1 for unlimited executions. */
1599
1621
  scMaxPerMin?: number;
1600
- /** number of executions per min */
1622
+ /** Maximum number of executions allowed per day for a specific Service Client (SC). Set to -1 for unlimited executions. */
1601
1623
  scMaxPerDay?: number;
1602
1624
  };
1603
1625
  export type AccountPartnerAccountDataUpdateRequest = {
@@ -1878,7 +1900,7 @@ export type AccountScmStatusResponse = {
1878
1900
  };
1879
1901
  export type RolePermissionResponse = {
1880
1902
  status?: boolean;
1881
- /** Permission ID from StackSpot IAM */
1903
+ /** Permission ID */
1882
1904
  id: string;
1883
1905
  /** Permission's name */
1884
1906
  name: string;
@@ -1941,6 +1963,14 @@ export type AccountSlugResponse = {
1941
1963
  /** Account slug */
1942
1964
  slug: string;
1943
1965
  };
1966
+ export type TrialSsoSettingsResponse = {
1967
+ /** Is github SSO enabled */
1968
+ github: boolean;
1969
+ /** Is microsoft SSO enabled */
1970
+ microsoft: boolean;
1971
+ /** Is google SSO enabled */
1972
+ google: boolean;
1973
+ };
1944
1974
  export type PersonalAccountDetailsResponse = {
1945
1975
  /** Unique identifier of the personal account. */
1946
1976
  id: number;
@@ -1963,20 +1993,6 @@ export type PersonalAccountDetailsResponse = {
1963
1993
  /** Date and time until the account is valid. */
1964
1994
  validUntil: string;
1965
1995
  };
1966
- export type PersonalAccountExpirationDataResponse = {
1967
- /** Account id */
1968
- accountId: string;
1969
- /** Account name */
1970
- name: string;
1971
- /** Account remaining trial days */
1972
- remainingTrialDays: number;
1973
- /** Date that trial Account will be blocked */
1974
- validUntil: string;
1975
- };
1976
- export type AccountDataAvailableResponse = {
1977
- /** Account data (name and slug) is available to be registered */
1978
- available: boolean;
1979
- };
1980
1996
  export type AccountSsoResponse = {
1981
1997
  /** SSO configuration name */
1982
1998
  name: string;
@@ -2024,6 +2040,58 @@ export type AccountPartnerResponse = {
2024
2040
  /** Account current status */
2025
2041
  isActive: boolean;
2026
2042
  };
2043
+ /**
2044
+ * Retrieves a list of rate limit with the associated service credential.
2045
+ */
2046
+ export function getAllServiceCredentialRateLimit({ size, page, sort, direction, search }: {
2047
+ size?: number;
2048
+ page?: number;
2049
+ sort?: string;
2050
+ direction: "ASC" | "DESC";
2051
+ search?: string;
2052
+ }, opts?: Oazapfts.RequestOpts) {
2053
+ return oazapfts.ok(oazapfts.fetchJson<{
2054
+ status: 200;
2055
+ data: PageResponseServiceCredentialRateLimitResponse;
2056
+ } | {
2057
+ status: 403;
2058
+ data: ErrorResponse;
2059
+ } | {
2060
+ status: 500;
2061
+ data: ErrorResponse;
2062
+ }>(`/v2/service-credentials/rate-limit${QS.query(QS.explode({
2063
+ size,
2064
+ page,
2065
+ sort,
2066
+ direction,
2067
+ search
2068
+ }))}`, {
2069
+ ...opts
2070
+ }));
2071
+ }
2072
+ /**
2073
+ * Updates the rate limit of a service credential.
2074
+ */
2075
+ export function updateServiceCredentialRateLimit({ serviceCredentialRateLimitRequest }: {
2076
+ serviceCredentialRateLimitRequest: ServiceCredentialRateLimitRequest;
2077
+ }, opts?: Oazapfts.RequestOpts) {
2078
+ return oazapfts.ok(oazapfts.fetchJson<{
2079
+ status: 200;
2080
+ } | {
2081
+ status: 403;
2082
+ data: ErrorResponse;
2083
+ } | {
2084
+ status: 422;
2085
+ data: ErrorResponse;
2086
+ } | {
2087
+ status: 500;
2088
+ data: ErrorResponse;
2089
+ }>("/v2/service-credentials/rate-limit", oazapfts.json({
2090
+ ...opts,
2091
+ method: "PUT",
2092
+ body: serviceCredentialRateLimitRequest
2093
+ })));
2094
+ }
2027
2095
  /**
2028
2096
  * Retrieves a list of SCM credentials associated with the current user's account, including secret names and provider details.
2029
2097
  */
@@ -2810,7 +2878,7 @@ export function createServiceCredential({ serviceCredentialCreateRequestV2 }: {
2810
2878
  })));
2811
2879
  }
2812
2880
  /**
2813
- * Get Service Credentials
2881
+ * Retrieves a list of service credentials with their associated owner information if available.
2814
2882
  */
2815
2883
  export function getServiceCredentials1({ name, status, page, size }: {
2816
2884
  name?: string;
@@ -2837,7 +2905,7 @@ export function getServiceCredentials1({ name, status, page, size }: {
2837
2905
  }));
2838
2906
  }
2839
2907
  /**
2840
- * Create Service Credential
2908
+ * Creates a new service credential for an account.
2841
2909
  */
2842
2910
  export function createServiceCredential1({ serviceCredentialCreateRequest }: {
2843
2911
  serviceCredentialCreateRequest: ServiceCredentialCreateRequest;
@@ -2864,7 +2932,7 @@ export function createServiceCredential1({ serviceCredentialCreateRequest }: {
2864
2932
  })));
2865
2933
  }
2866
2934
  /**
2867
- * Notify about Service Credential expiration
2935
+ * Notifies the user about the expiration of the service credential via email.
2868
2936
  */
2869
2937
  export function notifyServiceCredentialExpiration({ serviceCredentialExpirationRequest }: {
2870
2938
  serviceCredentialExpirationRequest: ServiceCredentialExpirationNotifyRequest;
@@ -3502,7 +3570,7 @@ export function bindToGroups({ memberId, memberIdsCommonRequest }: {
3502
3570
  })));
3503
3571
  }
3504
3572
  /**
3505
- * Get account member favorite resources
3573
+ * Lists all favorite resources associated with a specific member.
3506
3574
  */
3507
3575
  export function listAccountMemberFavorites({ memberId }: {
3508
3576
  memberId: string;
@@ -3521,7 +3589,7 @@ export function listAccountMemberFavorites({ memberId }: {
3521
3589
  }));
3522
3590
  }
3523
3591
  /**
3524
- * Add account member favorite resource
3592
+ * Adds a favorite resource to a member.
3525
3593
  */
3526
3594
  export function addAccountMemberFavorite({ memberId, createFavoriteResourceRequest }: {
3527
3595
  memberId: string;
@@ -3695,7 +3763,7 @@ export function createUserInvitation({ createUserInvitationRequest }: {
3695
3763
  })));
3696
3764
  }
3697
3765
  /**
3698
- * Get Groups
3766
+ * Returns a list of group information.
3699
3767
  */
3700
3768
  export function getGroups1({ size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn, includeDefaultGroup }: {
3701
3769
  size?: any;
@@ -3736,7 +3804,7 @@ export function getGroups1({ size, page, sort, direction, search, filterMode, fi
3736
3804
  }));
3737
3805
  }
3738
3806
  /**
3739
- * Create Group
3807
+ * Creates a new group.
3740
3808
  */
3741
3809
  export function save({ newGroupRequest }: {
3742
3810
  newGroupRequest: NewGroupRequest;
@@ -3760,7 +3828,7 @@ export function save({ newGroupRequest }: {
3760
3828
  })));
3761
3829
  }
3762
3830
  /**
3763
- * Get Group members
3831
+ * Retrieves a list of roles for a specified group.
3764
3832
  */
3765
3833
  export function getRoles5({ groupId, size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }: {
3766
3834
  groupId: string;
@@ -3800,7 +3868,7 @@ export function getRoles5({ groupId, size, page, sort, direction, search, filter
3800
3868
  }));
3801
3869
  }
3802
3870
  /**
3803
- * Bind Group roles
3871
+ * Binds a list of roles to a specified group.
3804
3872
  */
3805
3873
  export function bindRoles({ groupId, groupRoleIdsRequest }: {
3806
3874
  groupId: string;
@@ -3826,7 +3894,7 @@ export function bindRoles({ groupId, groupRoleIdsRequest }: {
3826
3894
  })));
3827
3895
  }
3828
3896
  /**
3829
- * Get Group Resources
3897
+ * Retrieves a list of resource associated with a specific group.
3830
3898
  */
3831
3899
  export function getGroupResources1({ groupId, size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }: {
3832
3900
  groupId: string;
@@ -3866,7 +3934,7 @@ export function getGroupResources1({ groupId, size, page, sort, direction, searc
3866
3934
  }));
3867
3935
  }
3868
3936
  /**
3869
- * Add Multiple Resources to Group
3937
+ * Adds a list of resources to a specified group.
3870
3938
  */
3871
3939
  export function addResourcesToGroup({ groupId, addResourcesToGroupRequest }: {
3872
3940
  groupId: string;
@@ -3887,7 +3955,7 @@ export function addResourcesToGroup({ groupId, addResourcesToGroupRequest }: {
3887
3955
  })));
3888
3956
  }
3889
3957
  /**
3890
- * Get Group members
3958
+ * Retrieves a list of members fir a specific group.
3891
3959
  */
3892
3960
  export function getMembers1({ groupId, size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }: {
3893
3961
  groupId: string;
@@ -3927,7 +3995,7 @@ export function getMembers1({ groupId, size, page, sort, direction, search, filt
3927
3995
  }));
3928
3996
  }
3929
3997
  /**
3930
- * Bind Group member
3998
+ * Bind members to a specified group.
3931
3999
  */
3932
4000
  export function bindGroupMembers({ groupId, groupMemberIdsRequest }: {
3933
4001
  groupId: string;
@@ -3992,7 +4060,7 @@ export function create({ createFeatureFlagRequest }: {
3992
4060
  })));
3993
4061
  }
3994
4062
  /**
3995
- * List all Account Extensions
4063
+ * Retrieves a list of extensions associated with the current user's account.
3996
4064
  */
3997
4065
  export function listExtensions(opts?: Oazapfts.RequestOpts) {
3998
4066
  return oazapfts.ok(oazapfts.fetchJson<{
@@ -4015,7 +4083,7 @@ export function listExtensions(opts?: Oazapfts.RequestOpts) {
4015
4083
  }));
4016
4084
  }
4017
4085
  /**
4018
- * Create Account Extension
4086
+ * Creates a new extension for the account.
4019
4087
  */
4020
4088
  export function createExtension({ extensionCreateRequest }: {
4021
4089
  extensionCreateRequest: ExtensionCreateRequest;
@@ -4041,7 +4109,7 @@ export function createExtension({ extensionCreateRequest }: {
4041
4109
  })));
4042
4110
  }
4043
4111
  /**
4044
- * List all Account Extension Versions
4112
+ * Retrieves a list of available versions for a specified extension.
4045
4113
  */
4046
4114
  export function listExtensionVersions({ slug }: {
4047
4115
  slug: string;
@@ -4066,7 +4134,7 @@ export function listExtensionVersions({ slug }: {
4066
4134
  }));
4067
4135
  }
4068
4136
  /**
4069
- * Create Account Extension Version
4137
+ * Creates a new version of an extension.
4070
4138
  */
4071
4139
  export function createExtensionVersion({ slug, name, body }: {
4072
4140
  slug: string;
@@ -4099,7 +4167,7 @@ export function createExtensionVersion({ slug, name, body }: {
4099
4167
  })));
4100
4168
  }
4101
4169
  /**
4102
- * List all Account Extension Links
4170
+ * Lists all account's extension links.
4103
4171
  */
4104
4172
  export function listExtensionLinks({ workspaceId, $type, extensionSlug, showOnlyActive }: {
4105
4173
  workspaceId?: string;
@@ -4132,7 +4200,7 @@ export function listExtensionLinks({ workspaceId, $type, extensionSlug, showOnly
4132
4200
  }));
4133
4201
  }
4134
4202
  /**
4135
- * Create Account Extension Link
4203
+ * Creates a new extension link for the account.
4136
4204
  */
4137
4205
  export function createExtensionLink({ extensionLinkCreateRequest }: {
4138
4206
  extensionLinkCreateRequest: ExtensionLinkCreateRequest;
@@ -4159,7 +4227,7 @@ export function createExtensionLink({ extensionLinkCreateRequest }: {
4159
4227
  })));
4160
4228
  }
4161
4229
  /**
4162
- * Send Welcome Email
4230
+ * Sends a welcome email to a new user.
4163
4231
  */
4164
4232
  export function sendWelcomeEmail({ welcomeEmailRequest }: {
4165
4233
  welcomeEmailRequest: WelcomeEmailRequest;
@@ -4179,7 +4247,7 @@ export function sendWelcomeEmail({ welcomeEmailRequest }: {
4179
4247
  })));
4180
4248
  }
4181
4249
  /**
4182
- * Send Download Email
4250
+ * Sends a download email to the current user.
4183
4251
  */
4184
4252
  export function sendDownloadEmail(opts?: Oazapfts.RequestOpts) {
4185
4253
  return oazapfts.ok(oazapfts.fetchJson<{
@@ -4199,7 +4267,7 @@ export function sendDownloadEmail(opts?: Oazapfts.RequestOpts) {
4199
4267
  }));
4200
4268
  }
4201
4269
  /**
4202
- * Send contact email
4270
+ * Sends a contact email.
4203
4271
  */
4204
4272
  export function sendContactEmail({ contactEmailRequest }: {
4205
4273
  contactEmailRequest: ContactEmailRequest;
@@ -4219,7 +4287,7 @@ export function sendContactEmail({ contactEmailRequest }: {
4219
4287
  })));
4220
4288
  }
4221
4289
  /**
4222
- * Switch user to account passed in the body
4290
+ * Switches the user to the account specified in the body.
4223
4291
  */
4224
4292
  export function switchAccount({ switchAccountRequest }: {
4225
4293
  switchAccountRequest: SwitchAccountRequest;
@@ -4246,7 +4314,7 @@ export function switchAccount({ switchAccountRequest }: {
4246
4314
  })));
4247
4315
  }
4248
4316
  /**
4249
- * Get credentials from personal service client (create if not exists one to the logged user).
4317
+ * Gets credentials from personal service client (create if not exists one to the logged user).
4250
4318
  */
4251
4319
  export function getPersonalClientCredentials(opts?: Oazapfts.RequestOpts) {
4252
4320
  return oazapfts.ok(oazapfts.fetchJson<{
@@ -4295,7 +4363,7 @@ export function getPersonalAccessToken1({ apiAuthorization, generateTokenFromPer
4295
4363
  })));
4296
4364
  }
4297
4365
  /**
4298
- * Disable client that generates Personal Access Tokens.
4366
+ * Disables the client that generates Personal Access Tokens.
4299
4367
  */
4300
4368
  export function disablePersonalAccessTokenGeneration(opts?: Oazapfts.RequestOpts) {
4301
4369
  return oazapfts.ok(oazapfts.fetchJson<{
@@ -4312,7 +4380,7 @@ export function disablePersonalAccessTokenGeneration(opts?: Oazapfts.RequestOpts
4312
4380
  }));
4313
4381
  }
4314
4382
  /**
4315
- * Verify if exists a client created (authorized) to generate Access Token on logged user behalf.
4383
+ * Checks whether a client exists and is authorized to generate an Access Token on behalf of the logged-in user.
4316
4384
  */
4317
4385
  export function personalAccessTokenAuthorization(opts?: Oazapfts.RequestOpts) {
4318
4386
  return oazapfts.ok(oazapfts.fetchJson<{
@@ -4331,7 +4399,7 @@ export function personalAccessTokenAuthorization(opts?: Oazapfts.RequestOpts) {
4331
4399
  }));
4332
4400
  }
4333
4401
  /**
4334
- * Authorize creating a client to generate Personal Access Tokens on your behalf.
4402
+ * Authorizes the creation of a client to generate Personal Access Tokens on your behalf.
4335
4403
  */
4336
4404
  export function createPersonalAccessToken(opts?: Oazapfts.RequestOpts) {
4337
4405
  return oazapfts.ok(oazapfts.fetchJson<{
@@ -4354,7 +4422,7 @@ export function createPersonalAccessToken(opts?: Oazapfts.RequestOpts) {
4354
4422
  }));
4355
4423
  }
4356
4424
  /**
4357
- * Get an Access Token generated on logged user's service account behalf, since previously authorized.
4425
+ * Retrieves an Access Token generated on behalf of the logged-in user's service account, provided that prior authorization has been granted.
4358
4426
  */
4359
4427
  export function getPersonalAccessTokenFromServiceAccountOnly(opts?: Oazapfts.RequestOpts) {
4360
4428
  return oazapfts.ok(oazapfts.fetchJson<{
@@ -4378,7 +4446,7 @@ export function getPersonalAccessTokenFromServiceAccountOnly(opts?: Oazapfts.Req
4378
4446
  }));
4379
4447
  }
4380
4448
  /**
4381
- * Generate device code.
4449
+ * Generates a device code data for a user.
4382
4450
  */
4383
4451
  export function deviceCode({ email, freemiumAccess, codeChallenge, body }: {
4384
4452
  email: string;
@@ -4469,6 +4537,30 @@ export function create1({ createAccountOrderRequest }: {
4469
4537
  body: createAccountOrderRequest
4470
4538
  })));
4471
4539
  }
4540
+ /**
4541
+ * Allows to enable or disable trial SSO integrations.
4542
+ */
4543
+ export function updateTrialSsoSettings({ updateTrialSsoSettingsRequest }: {
4544
+ updateTrialSsoSettingsRequest: UpdateTrialSsoSettingsRequest;
4545
+ }, opts?: Oazapfts.RequestOpts) {
4546
+ return oazapfts.ok(oazapfts.fetchJson<{
4547
+ status: 204;
4548
+ data: UpdateTrialSsoSettingsResponse;
4549
+ } | {
4550
+ status: 403;
4551
+ data: ErrorResponse;
4552
+ } | {
4553
+ status: 422;
4554
+ data: ErrorResponse;
4555
+ } | {
4556
+ status: 500;
4557
+ data: ErrorResponse;
4558
+ }>("/v1/admin/accounts/trial/sso", oazapfts.json({
4559
+ ...opts,
4560
+ method: "POST",
4561
+ body: updateTrialSsoSettingsRequest
4562
+ })));
4563
+ }
4472
4564
  /**
4473
4565
  * Creates a Trial account.
4474
4566
  */
@@ -4477,6 +4569,7 @@ export function createTrialAccount({ accountTrialCreateRequest }: {
4477
4569
  }, opts?: Oazapfts.RequestOpts) {
4478
4570
  return oazapfts.ok(oazapfts.fetchJson<{
4479
4571
  status: 201;
4572
+ data: PersonalAccountExpirationDataResponse;
4480
4573
  } | {
4481
4574
  status: 400;
4482
4575
  data: ErrorResponse;
@@ -4651,7 +4744,7 @@ export function ssoParseConfigurationFile({ protocol, body }: {
4651
4744
  })));
4652
4745
  }
4653
4746
  /**
4654
- * Create an Account Order for Partner
4747
+ * Creates a partner account order.
4655
4748
  */
4656
4749
  export function createPartner({ createAccountPartnerOrderRequest }: {
4657
4750
  createAccountPartnerOrderRequest: CreateAccountPartnerOrderRequest;
@@ -4667,7 +4760,7 @@ export function createPartner({ createAccountPartnerOrderRequest }: {
4667
4760
  data: ErrorResponse;
4668
4761
  } | {
4669
4762
  status: 500;
4670
- data: IdDefaultResponse;
4763
+ data: ErrorResponse;
4671
4764
  }>("/v1/account-orders/partners", oazapfts.json({
4672
4765
  ...opts,
4673
4766
  method: "POST",
@@ -4675,7 +4768,7 @@ export function createPartner({ createAccountPartnerOrderRequest }: {
4675
4768
  })));
4676
4769
  }
4677
4770
  /**
4678
- * Validate new Partner account data
4771
+ * Validates new Partner account data.
4679
4772
  */
4680
4773
  export function validateNewPartnerData({ validateAccountPartnerDataRequest }: {
4681
4774
  validateAccountPartnerDataRequest: ValidateAccountPartnerDataRequest;
@@ -4690,6 +4783,7 @@ export function validateNewPartnerData({ validateAccountPartnerDataRequest }: {
4690
4783
  data: ErrorResponse;
4691
4784
  } | {
4692
4785
  status: 500;
4786
+ data: ErrorResponse;
4693
4787
  }>("/v1/account-orders/partners/validations/creation-data", oazapfts.json({
4694
4788
  ...opts,
4695
4789
  method: "POST",
@@ -4769,68 +4863,6 @@ export function revokeServiceCredential({ id }: {
4769
4863
  method: "PATCH"
4770
4864
  }));
4771
4865
  }
4772
- /**
4773
- * Retrieves a list of rate limit with the associated service credential.
4774
- */
4775
- export function getAllServiceCredentialRateLimit({ size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }: {
4776
- size?: any;
4777
- page?: any;
4778
- sort?: string;
4779
- direction?: "ASC" | "DESC";
4780
- search?: string;
4781
- filterMode?: "MATCH" | "CONTAINS" | "IN";
4782
- filterBy?: string;
4783
- filterValue?: string;
4784
- multiFilterMode?: string;
4785
- filterIn?: any;
4786
- }, opts?: Oazapfts.RequestOpts) {
4787
- return oazapfts.ok(oazapfts.fetchJson<{
4788
- status: 200;
4789
- data: PageResponseServiceCredentialRateLimitResponse;
4790
- } | {
4791
- status: 403;
4792
- data: ErrorResponse;
4793
- } | {
4794
- status: 500;
4795
- data: ErrorResponse;
4796
- }>(`/v2/service-credentials/rate-limit${QS.query(QS.explode({
4797
- size,
4798
- page,
4799
- sort,
4800
- direction,
4801
- search,
4802
- filterMode,
4803
- filterBy,
4804
- filterValue,
4805
- multiFilterMode,
4806
- filterIn
4807
- }))}`, {
4808
- ...opts
4809
- }));
4810
- }
4811
- /**
4812
- * Updates the rate limit of a service credential.
4813
- */
4814
- export function updateServiceCredentialRateLimit({ serviceCredentialRateLimitRequest }: {
4815
- serviceCredentialRateLimitRequest: ServiceCredentialRateLimitRequest;
4816
- }, opts?: Oazapfts.RequestOpts) {
4817
- return oazapfts.ok(oazapfts.fetchJson<{
4818
- status: 200;
4819
- } | {
4820
- status: 403;
4821
- data: ErrorResponse;
4822
- } | {
4823
- status: 422;
4824
- data: ErrorResponse;
4825
- } | {
4826
- status: 500;
4827
- data: ErrorResponse;
4828
- }>("/v2/service-credentials/rate-limit", oazapfts.json({
4829
- ...opts,
4830
- method: "PATCH",
4831
- body: serviceCredentialRateLimitRequest
4832
- })));
4833
- }
4834
4866
  /**
4835
4867
  * Delete a member permissions
4836
4868
  */
@@ -4880,7 +4912,7 @@ export function updateMemberPermissions({ memberId, body }: {
4880
4912
  })));
4881
4913
  }
4882
4914
  /**
4883
- * Delete Group permissions
4915
+ * Deletes specific permissions from a group.
4884
4916
  */
4885
4917
  export function deleteGroupPermissions({ groupId, body }: {
4886
4918
  groupId: string;
@@ -4904,7 +4936,7 @@ export function deleteGroupPermissions({ groupId, body }: {
4904
4936
  })));
4905
4937
  }
4906
4938
  /**
4907
- * Update Group permissions
4939
+ * Updates the permissions of a specified group.
4908
4940
  */
4909
4941
  export function updateGroupPermissions({ groupId, body }: {
4910
4942
  groupId: string;
@@ -4949,7 +4981,7 @@ export function associateGroupToServiceCredential({ id, serviceCredentialAssocia
4949
4981
  })));
4950
4982
  }
4951
4983
  /**
4952
- * Revoke Service Credential
4984
+ * Revokes a service credential.
4953
4985
  */
4954
4986
  export function revokeServiceCredential1({ id }: {
4955
4987
  id: string;
@@ -5227,7 +5259,7 @@ export function resendUserInvitation({ id }: {
5227
5259
  }));
5228
5260
  }
5229
5261
  /**
5230
- * Get Group by ID
5262
+ * Retrieves information about a specific group by its ID.
5231
5263
  */
5232
5264
  export function getGroupById({ groupId }: {
5233
5265
  groupId: string;
@@ -5249,7 +5281,7 @@ export function getGroupById({ groupId }: {
5249
5281
  }));
5250
5282
  }
5251
5283
  /**
5252
- * Delete Group
5284
+ * Deletes a group by its ID.
5253
5285
  */
5254
5286
  export function deleteV1GroupsByGroupId({ groupId }: {
5255
5287
  groupId: string;
@@ -5271,7 +5303,7 @@ export function deleteV1GroupsByGroupId({ groupId }: {
5271
5303
  }));
5272
5304
  }
5273
5305
  /**
5274
- * Update Group
5306
+ * Updates an existing group.
5275
5307
  */
5276
5308
  export function update1({ groupId, updateGroupRequest }: {
5277
5309
  groupId: string;
@@ -5299,7 +5331,7 @@ export function update1({ groupId, updateGroupRequest }: {
5299
5331
  })));
5300
5332
  }
5301
5333
  /**
5302
- * Delete Group permissions
5334
+ * Deletes specific permissions from a group.
5303
5335
  */
5304
5336
  export function deleteGroupPermissions1({ groupId, deleteGroupPermissionsRequest }: {
5305
5337
  groupId: string;
@@ -5323,7 +5355,7 @@ export function deleteGroupPermissions1({ groupId, deleteGroupPermissionsRequest
5323
5355
  })));
5324
5356
  }
5325
5357
  /**
5326
- * Update Group permissions
5358
+ * Updates the permissions of a specified group.
5327
5359
  */
5328
5360
  export function updateGroupPermissions1({ groupId, updateGroupPermissionsRequest }: {
5329
5361
  groupId: string;
@@ -5389,7 +5421,7 @@ export function disable({ id }: {
5389
5421
  }));
5390
5422
  }
5391
5423
  /**
5392
- * Delete Account Extension
5424
+ * Deletes an account's extension.
5393
5425
  */
5394
5426
  export function deleteExtension({ slug }: {
5395
5427
  slug: string;
@@ -5414,7 +5446,7 @@ export function deleteExtension({ slug }: {
5414
5446
  }));
5415
5447
  }
5416
5448
  /**
5417
- * Update Account Extension
5449
+ * Updates an account's extension.
5418
5450
  */
5419
5451
  export function updateExtension({ slug, extensionUpdateRequest }: {
5420
5452
  slug: string;
@@ -5443,7 +5475,7 @@ export function updateExtension({ slug, extensionUpdateRequest }: {
5443
5475
  })));
5444
5476
  }
5445
5477
  /**
5446
- * Delete Account Extension Link
5478
+ * Deletes an extension link by its ID.
5447
5479
  */
5448
5480
  export function deleteExtensionLink({ id }: {
5449
5481
  id: string;
@@ -5468,7 +5500,7 @@ export function deleteExtensionLink({ id }: {
5468
5500
  }));
5469
5501
  }
5470
5502
  /**
5471
- * Update Account Extension Link
5503
+ * Updates a specified account's extension link.
5472
5504
  */
5473
5505
  export function updateExtensionLink({ id, extensionLinkUpdateRequest }: {
5474
5506
  id: string;
@@ -5620,7 +5652,7 @@ export function updateRateLimit({ updateRateLimitRequest }: {
5620
5652
  })));
5621
5653
  }
5622
5654
  /**
5623
- * Get Partner by account Id
5655
+ * Retrieves partner account details by account Id.
5624
5656
  */
5625
5657
  export function getPartnerAccount({ id }: {
5626
5658
  id: string;
@@ -5642,7 +5674,7 @@ export function getPartnerAccount({ id }: {
5642
5674
  }));
5643
5675
  }
5644
5676
  /**
5645
- * Delete Partner
5677
+ * Inactivates a partner account by disabling its associated tenant and updating its status.
5646
5678
  */
5647
5679
  export function deletePartner({ id }: {
5648
5680
  id: string;
@@ -5664,7 +5696,7 @@ export function deletePartner({ id }: {
5664
5696
  }));
5665
5697
  }
5666
5698
  /**
5667
- * Update Partner Account data.
5699
+ * Updates the partner account data.
5668
5700
  */
5669
5701
  export function updatePartnerAccountData({ id, accountPartnerAccountDataUpdateRequest }: {
5670
5702
  id: string;
@@ -5688,7 +5720,7 @@ export function updatePartnerAccountData({ id, accountPartnerAccountDataUpdateRe
5688
5720
  })));
5689
5721
  }
5690
5722
  /**
5691
- * Update Partner Account Admin data.
5723
+ * Updates the partner admin data for a specific account.
5692
5724
  */
5693
5725
  export function updatePartnerAccountAdminData({ id, accountPartnerAdminDataUpdateRequest }: {
5694
5726
  id: string;
@@ -5750,7 +5782,7 @@ export function getServiceCredentialByIdRateLimit({ clientId }: {
5750
5782
  }));
5751
5783
  }
5752
5784
  /**
5753
- * Get Roles
5785
+ * Retrieves a list of roles for the current tenant.
5754
5786
  */
5755
5787
  export function getRoles({ size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }: {
5756
5788
  size?: any;
@@ -5789,7 +5821,7 @@ export function getRoles({ size, page, sort, direction, search, filterMode, filt
5789
5821
  }));
5790
5822
  }
5791
5823
  /**
5792
- * Get all Global Resources and Actions compared to role
5824
+ * Retrieves a list of all global resources and their associated actions for a specified role.
5793
5825
  */
5794
5826
  export function getResourcesAndActionsWithStatus({ roleId, size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }: {
5795
5827
  roleId: string;
@@ -5829,7 +5861,7 @@ export function getResourcesAndActionsWithStatus({ roleId, size, page, sort, dir
5829
5861
  }));
5830
5862
  }
5831
5863
  /**
5832
- * Get role members
5864
+ * Retrieves a list of members associated with a specific role.
5833
5865
  */
5834
5866
  export function getRoleMembers({ roleId, size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }: {
5835
5867
  roleId: string;
@@ -5869,7 +5901,7 @@ export function getRoleMembers({ roleId, size, page, sort, direction, search, fi
5869
5901
  }));
5870
5902
  }
5871
5903
  /**
5872
- * Get Groups from role
5904
+ * Retrieves a list of role groups associated with a specific role ID.
5873
5905
  */
5874
5906
  export function getRoleGroups({ roleId, size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }: {
5875
5907
  roleId: string;
@@ -6028,7 +6060,7 @@ export function getResourceGroups({ resourceId, size, page, sort, direction, sea
6028
6060
  }));
6029
6061
  }
6030
6062
  /**
6031
- * Get Resource Types
6063
+ * Finds and retrieves a list of resource types for the current account.
6032
6064
  */
6033
6065
  export function getResourceTypes({ size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }: {
6034
6066
  size?: any;
@@ -6186,7 +6218,7 @@ export function getMemberGroups({ memberId, size, page, sort, direction, search,
6186
6218
  }));
6187
6219
  }
6188
6220
  /**
6189
- * Get Groups
6221
+ * Returns a list of group details.
6190
6222
  */
6191
6223
  export function getGroups({ size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn, includeDefaultGroup }: {
6192
6224
  size?: any;
@@ -6227,7 +6259,7 @@ export function getGroups({ size, page, sort, direction, search, filterMode, fil
6227
6259
  }));
6228
6260
  }
6229
6261
  /**
6230
- * Get Group roles
6262
+ * Retrieves a list of roles for a specified group.
6231
6263
  */
6232
6264
  export function getRoles2({ groupId, size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }: {
6233
6265
  groupId: string;
@@ -6267,7 +6299,7 @@ export function getRoles2({ groupId, size, page, sort, direction, search, filter
6267
6299
  }));
6268
6300
  }
6269
6301
  /**
6270
- * Get Group Resources
6302
+ * Finds and returns a list of resources associated with a specific group.
6271
6303
  */
6272
6304
  export function getGroupResources({ groupId, size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }: {
6273
6305
  groupId: string;
@@ -6307,7 +6339,7 @@ export function getGroupResources({ groupId, size, page, sort, direction, search
6307
6339
  }));
6308
6340
  }
6309
6341
  /**
6310
- * Get Group members
6342
+ * Returns a list of members from a specified group.
6311
6343
  */
6312
6344
  export function getMembers({ groupId, size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }: {
6313
6345
  groupId: string;
@@ -6386,7 +6418,7 @@ export function getUserAccountWithRole(opts?: Oazapfts.RequestOpts) {
6386
6418
  }));
6387
6419
  }
6388
6420
  /**
6389
- * Get Accounts
6421
+ * Finds and returns a list of active accounts.
6390
6422
  */
6391
6423
  export function getAccounts({ accountType, slug, id }: {
6392
6424
  accountType?: string;
@@ -6411,7 +6443,7 @@ export function getAccounts({ accountType, slug, id }: {
6411
6443
  }));
6412
6444
  }
6413
6445
  /**
6414
- * Get Account by id
6446
+ * Finds and retrieves active account details by the provided account ID.
6415
6447
  */
6416
6448
  export function getAccount({ id }: {
6417
6449
  id: string;
@@ -6433,7 +6465,7 @@ export function getAccount({ id }: {
6433
6465
  }));
6434
6466
  }
6435
6467
  /**
6436
- * Get Account Members
6468
+ * Returns a list of account members for a specified account.
6437
6469
  */
6438
6470
  export function getAccountMembers1({ id, size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }: {
6439
6471
  id: string;
@@ -6473,7 +6505,7 @@ export function getAccountMembers1({ id, size, page, sort, direction, search, fi
6473
6505
  }));
6474
6506
  }
6475
6507
  /**
6476
- * Get Service Credential by ID (Client ID)
6508
+ * Retrieves the service credential details for a given client ID.
6477
6509
  */
6478
6510
  export function getServiceCredential({ id }: {
6479
6511
  id: string;
@@ -6511,7 +6543,7 @@ export function getServiceCredentialPermissions({ id }: {
6511
6543
  }));
6512
6544
  }
6513
6545
  /**
6514
- * List service credential groups
6546
+ * Retrieves a list of service credential groups associated with a specific client ID.
6515
6547
  */
6516
6548
  export function getServiceCredentialGroups1({ id }: {
6517
6549
  id: string;
@@ -6715,7 +6747,7 @@ export function getResourceGroups1({ resourceId, size, page, sort, direction, se
6715
6747
  }));
6716
6748
  }
6717
6749
  /**
6718
- * Get Resource Types
6750
+ * Finds and retrieves a list of resource types for the current account.
6719
6751
  */
6720
6752
  export function getResourceTypes1({ size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }: {
6721
6753
  size?: any;
@@ -6754,7 +6786,7 @@ export function getResourceTypes1({ size, page, sort, direction, search, filterM
6754
6786
  }));
6755
6787
  }
6756
6788
  /**
6757
- * Validate permission access
6789
+ * Validates user permission access for resources.
6758
6790
  */
6759
6791
  export function getAccess({ resourceType, resource, action, attribute }: {
6760
6792
  resourceType: string;
@@ -6797,7 +6829,29 @@ export function getResources2({ memberId }: {
6797
6829
  }));
6798
6830
  }
6799
6831
  /**
6800
- * Get member favorite resources by type
6832
+ * Retrieves a magic link to create a new FIDO key.
6833
+ */
6834
+ export function getFidoMagicLink({ memberId }: {
6835
+ memberId: string;
6836
+ }, opts?: Oazapfts.RequestOpts) {
6837
+ return oazapfts.ok(oazapfts.fetchJson<{
6838
+ status: 200;
6839
+ data: string;
6840
+ } | {
6841
+ status: 400;
6842
+ data: ErrorResponse;
6843
+ } | {
6844
+ status: 404;
6845
+ data: ErrorResponse;
6846
+ } | {
6847
+ status: 500;
6848
+ data: ErrorResponse;
6849
+ }>(`/v1/members/${encodeURIComponent(memberId)}/fido-credentials/magic-link`, {
6850
+ ...opts
6851
+ }));
6852
+ }
6853
+ /**
6854
+ * Lists the IDs of a member's favorite resources of a specified type.
6801
6855
  */
6802
6856
  export function listMemberFavoritesByResource({ memberId, resourceType }: {
6803
6857
  memberId: string;
@@ -6805,7 +6859,7 @@ export function listMemberFavoritesByResource({ memberId, resourceType }: {
6805
6859
  }, opts?: Oazapfts.RequestOpts) {
6806
6860
  return oazapfts.ok(oazapfts.fetchJson<{
6807
6861
  status: 200;
6808
- data: any;
6862
+ data: string[];
6809
6863
  } | {
6810
6864
  status: 404;
6811
6865
  data: ErrorResponse;
@@ -6856,7 +6910,7 @@ export function getAccountMembersToCollaborators({ size, page, sort, direction,
6856
6910
  }));
6857
6911
  }
6858
6912
  /**
6859
- * Get a Account Extension Version
6913
+ * Retrieves the details of a specific extension version.
6860
6914
  */
6861
6915
  export function getExtensionVersion({ slug, versionName }: {
6862
6916
  slug: string;
@@ -6882,7 +6936,7 @@ export function getExtensionVersion({ slug, versionName }: {
6882
6936
  }));
6883
6937
  }
6884
6938
  /**
6885
- * Delete Account Extension Version
6939
+ * Deletes a specific version of an extension.
6886
6940
  */
6887
6941
  export function deleteExtensionVersion({ slug, versionName }: {
6888
6942
  slug: string;
@@ -6908,7 +6962,7 @@ export function deleteExtensionVersion({ slug, versionName }: {
6908
6962
  }));
6909
6963
  }
6910
6964
  /**
6911
- * Get the active Extension Version
6965
+ * Retrieves the details of the extension's active version.
6912
6966
  */
6913
6967
  export function getActiveExtensionVersion({ slug }: {
6914
6968
  slug: string;
@@ -6933,7 +6987,7 @@ export function getActiveExtensionVersion({ slug }: {
6933
6987
  }));
6934
6988
  }
6935
6989
  /**
6936
- * Get Authentication Configuration for account
6990
+ * Gets the Authentication Configuration for an account.
6937
6991
  */
6938
6992
  export function getAuthenticationConfig({ tenantSlug }: {
6939
6993
  tenantSlug: string;
@@ -7025,32 +7079,29 @@ export function getAccountSlug({ accountId }: {
7025
7079
  }));
7026
7080
  }
7027
7081
  /**
7028
- * Finds and returns personal account details.
7082
+ * Retrieves the current status of trial SSO integrations.
7029
7083
  */
7030
- export function getPersonalAccountDetails(opts?: Oazapfts.RequestOpts) {
7084
+ export function getTrialSsoSettings(opts?: Oazapfts.RequestOpts) {
7031
7085
  return oazapfts.ok(oazapfts.fetchJson<{
7032
7086
  status: 200;
7033
- data: PersonalAccountDetailsResponse;
7087
+ data: TrialSsoSettingsResponse;
7034
7088
  } | {
7035
- status: 400;
7036
- data: ErrorResponse;
7037
- } | {
7038
- status: 404;
7089
+ status: 403;
7039
7090
  data: ErrorResponse;
7040
7091
  } | {
7041
7092
  status: 500;
7042
7093
  data: ErrorResponse;
7043
- }>("/v1/accounts/trial/personal-details", {
7094
+ }>("/v1/accounts/trial/sso", {
7044
7095
  ...opts
7045
7096
  }));
7046
7097
  }
7047
7098
  /**
7048
- * Finds and returns personal account expiration data associated with the provided token.
7099
+ * Finds and returns personal account details.
7049
7100
  */
7050
- export function getPersonalAccountExpirationData(opts?: Oazapfts.RequestOpts) {
7101
+ export function getPersonalAccountDetails(opts?: Oazapfts.RequestOpts) {
7051
7102
  return oazapfts.ok(oazapfts.fetchJson<{
7052
7103
  status: 200;
7053
- data: PersonalAccountExpirationDataResponse;
7104
+ data: PersonalAccountDetailsResponse;
7054
7105
  } | {
7055
7106
  status: 400;
7056
7107
  data: ErrorResponse;
@@ -7060,33 +7111,27 @@ export function getPersonalAccountExpirationData(opts?: Oazapfts.RequestOpts) {
7060
7111
  } | {
7061
7112
  status: 500;
7062
7113
  data: ErrorResponse;
7063
- }>("/v1/accounts/trial/expiration", {
7114
+ }>("/v1/accounts/trial/personal-details", {
7064
7115
  ...opts
7065
7116
  }));
7066
7117
  }
7067
7118
  /**
7068
- * Determines whether account data is available for registration based on the provided name and slug.
7119
+ * Finds and returns personal account expiration data associated with the provided token.
7069
7120
  */
7070
- export function accountDataIsAvailable({ name, slug }: {
7071
- name: string;
7072
- slug: string;
7073
- }, opts?: Oazapfts.RequestOpts) {
7121
+ export function getPersonalAccountExpirationData(opts?: Oazapfts.RequestOpts) {
7074
7122
  return oazapfts.ok(oazapfts.fetchJson<{
7075
7123
  status: 200;
7076
- data: AccountDataAvailableResponse;
7124
+ data: PersonalAccountExpirationDataResponse;
7077
7125
  } | {
7078
7126
  status: 400;
7079
7127
  data: ErrorResponse;
7080
7128
  } | {
7081
- status: 403;
7129
+ status: 404;
7082
7130
  data: ErrorResponse;
7083
7131
  } | {
7084
7132
  status: 500;
7085
7133
  data: ErrorResponse;
7086
- }>(`/v1/accounts/trial/available${QS.query(QS.explode({
7087
- name,
7088
- slug
7089
- }))}`, {
7134
+ }>("/v1/accounts/trial/expiration", {
7090
7135
  ...opts
7091
7136
  }));
7092
7137
  }
@@ -7133,7 +7178,7 @@ export function getAllAccountSso({ size, page, sort, direction, search, filterMo
7133
7178
  }));
7134
7179
  }
7135
7180
  /**
7136
- * Get Partners who are sharing content.
7181
+ * Finds and returns a list of partners who are sharing content.
7137
7182
  */
7138
7183
  export function getSharingPartners({ name }: {
7139
7184
  name?: string;
@@ -7157,7 +7202,7 @@ export function getSharingPartners({ name }: {
7157
7202
  }));
7158
7203
  }
7159
7204
  /**
7160
- * Get Partners with whom it is allowed to share content.
7205
+ * Finds and returns a list of partners with whom sharing content is allowed.
7161
7206
  */
7162
7207
  export function getPartnersSharingAllowed({ name }: {
7163
7208
  name?: string;
@@ -7181,7 +7226,7 @@ export function getPartnersSharingAllowed({ name }: {
7181
7226
  }));
7182
7227
  }
7183
7228
  /**
7184
- * Validate Partner association limit
7229
+ * Validates Partner association limit.
7185
7230
  */
7186
7231
  export function validatePartnerAssociationLimit(opts?: Oazapfts.RequestOpts) {
7187
7232
  return oazapfts.ok(oazapfts.fetchJson<{
@@ -7194,12 +7239,13 @@ export function validatePartnerAssociationLimit(opts?: Oazapfts.RequestOpts) {
7194
7239
  data: ErrorResponse;
7195
7240
  } | {
7196
7241
  status: 500;
7242
+ data: ErrorResponse;
7197
7243
  }>("/v1/account-orders/partners/validations/association-limit", {
7198
7244
  ...opts
7199
7245
  }));
7200
7246
  }
7201
7247
  /**
7202
- * Disassociate Group to Service Credential
7248
+ * Disassociates a group from a service credential.
7203
7249
  */
7204
7250
  export function disassociateGroupToServiceCredential({ id, groupId }: {
7205
7251
  id: string;
@@ -7291,7 +7337,30 @@ export function deleteProfileImage({ memberId }: {
7291
7337
  }));
7292
7338
  }
7293
7339
  /**
7294
- * Remove resource from member favorites
7340
+ * Deletes a specific FIDO key.
7341
+ */
7342
+ export function deleteFidoKey({ memberId, keyId }: {
7343
+ memberId: string;
7344
+ keyId: number;
7345
+ }, opts?: Oazapfts.RequestOpts) {
7346
+ return oazapfts.ok(oazapfts.fetchJson<{
7347
+ status: 200;
7348
+ } | {
7349
+ status: 400;
7350
+ data: ErrorResponse;
7351
+ } | {
7352
+ status: 404;
7353
+ data: ErrorResponse;
7354
+ } | {
7355
+ status: 500;
7356
+ data: ErrorResponse;
7357
+ }>(`/v1/members/${encodeURIComponent(memberId)}/fido-credentials/${encodeURIComponent(keyId)}`, {
7358
+ ...opts,
7359
+ method: "DELETE"
7360
+ }));
7361
+ }
7362
+ /**
7363
+ * Removes a specified resource from a member favorites.
7295
7364
  */
7296
7365
  export function deleteMemberFavorite({ memberId, resourceType, resourceId }: {
7297
7366
  memberId: string;
@@ -7312,7 +7381,7 @@ export function deleteMemberFavorite({ memberId, resourceType, resourceId }: {
7312
7381
  }));
7313
7382
  }
7314
7383
  /**
7315
- * Delete Group role
7384
+ * Deletes a specific role from a group.
7316
7385
  */
7317
7386
  export function deleteRole({ groupId, roleId }: {
7318
7387
  groupId: string;
@@ -7335,7 +7404,7 @@ export function deleteRole({ groupId, roleId }: {
7335
7404
  }));
7336
7405
  }
7337
7406
  /**
7338
- * Delete Resource from Group
7407
+ * Removes a resource from a specified group.
7339
7408
  */
7340
7409
  export function deleteResourceFromGroup({ groupId, resourceId }: {
7341
7410
  groupId: string;
@@ -7355,7 +7424,7 @@ export function deleteResourceFromGroup({ groupId, resourceId }: {
7355
7424
  }));
7356
7425
  }
7357
7426
  /**
7358
- * Delete Group member
7427
+ * Deletes a member from a specified group.
7359
7428
  */
7360
7429
  export function deleteMember({ groupId, memberId }: {
7361
7430
  groupId: string;