@stack-spot/portal-network 0.96.0 → 0.97.1

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [0.97.1](https://github.com/stack-spot/portal-commons/compare/portal-network@v0.97.0...portal-network@v0.97.1) (2025-03-17)
+
+
+### Features
+
+* Rate Limit ([ba18cf9](https://github.com/stack-spot/portal-commons/commit/ba18cf940104a099e1c79bf859795d5d5f4d075f))
+
+## [0.97.0](https://github.com/stack-spot/portal-commons/compare/portal-network@v0.96.0...portal-network@v0.97.0) (2025-03-17)
+
+
+### Features
+
+* update workflow API ([#803](https://github.com/stack-spot/portal-commons/issues/803)) ([69abbfd](https://github.com/stack-spot/portal-commons/commit/69abbfd41d02a1dcb7a8ed7e3d0064db8f510956))
+
 ## [0.96.0](https://github.com/stack-spot/portal-commons/compare/portal-network@v0.95.0...portal-network@v0.96.0) (2025-03-17)
 
 

package/dist/api/account.d.ts

@@ -1307,6 +1307,10 @@ export type RotateServiceCredentialSecretRequest = {
 export type RotateServiceCredentialSecretResponse = {
     secret?: string;
 };
+export type UpdateServiceCredentialScopesRequest = {
+    /** Service credential statements */
+    scopes: string[];
+};
 export type DeleteMemberPermissionsRequest = {
     /** Permission Action */
     actionName: string;
@@ -1445,6 +1449,30 @@ export type AccountSsoAddAttributesConfigRequest = {
     /** SSO Last Name attribute configuration */
     lastName?: string;
 };
+export type RateLimitResponse = {
+    /** Maximum number of executions per day */
+    patMaxExecPerDay: number;
+    /** default number of executions per min */
+    scDefaultMaxPerMin: number;
+    /** default number of executions per day */
+    scDefaultMaxPerDay: number;
+    /** number of executions per min */
+    scMaxPerMin: number;
+    /** number of executions per min */
+    scMaxPerDay: number;
+};
+export type UpdateRateLimitRequest = {
+    /** Maximum number of executions per day */
+    patMaxExecPerDay?: number;
+    /** default number of executions per min */
+    scDefaultMaxPerMin?: number;
+    /** default number of executions per day */
+    scDefaultMaxPerDay?: number;
+    /** number of executions per min */
+    scMaxPerMin?: number;
+    /** number of executions per min */
+    scMaxPerDay?: number;
+};
 export type AccountPartnerAccountDataUpdateRequest = {
     /** The account's name. Example: Zup IT Innovation */
     name?: string;
@@ -2003,20 +2031,20 @@ export declare function updateAccountStatus({ accountId, accountStatusRequest }:
     accountStatusRequest: AccountStatusRequest;
 }, opts?: Oazapfts.RequestOpts): Promise<unknown>;
 /**
- * Get a configured SSO from account
+ * Retrieves detailed SSO information for a specified account.
  */
 export declare function getAccountSso({ id }: {
     id: string;
 }, opts?: Oazapfts.RequestOpts): Promise<AccountSsoDetailedResponse>;
 /**
- * Update a configured SSO from account
+ * Updates an existing SSO configuration for a specified ID.
  */
 export declare function updateSso({ id, accountSsoUpdateRequest }: {
     id: string;
     accountSsoUpdateRequest: AccountSsoUpdateRequest;
 }, opts?: Oazapfts.RequestOpts): Promise<unknown>;
 /**
- * Delete a configured Account SSO from account
+ * Deletes a SSO configuration by its ID.
  */
 export declare function deleteSso({ id }: {
     id: string;
@@ -2029,14 +2057,14 @@ export declare function partialUpdateSso({ id, accountSsoPartialUpdateRequest }:
     accountSsoPartialUpdateRequest: AccountSsoPartialUpdateRequest;
 }, opts?: Oazapfts.RequestOpts): Promise<unknown>;
 /**
- * Get SSO Group Mapping By Id
+ * Retrieves the details of a SSO group mapping by its ID.
  */
 export declare function getGroupMapById({ id, attributeImporterId }: {
     id: string;
     attributeImporterId: string;
 }, opts?: Oazapfts.RequestOpts): Promise<AccountSsoGroupMappingResponse>;
 /**
- * Update SSO Group Mapping
+ * Updates the SSO group mapping.
  */
 export declare function updateGroupMapping({ id, attributeImporterId, accountGroupMappingUpdateRequest }: {
     id: string;
@@ -2044,14 +2072,14 @@ export declare function updateGroupMapping({ id, attributeImporterId, accountGro
     accountGroupMappingUpdateRequest: AccountGroupMappingUpdateRequest;
 }, opts?: Oazapfts.RequestOpts): Promise<unknown>;
 /**
- * Delete SSO Group Mapping
+ * Deletes SSO Group Mapping.
  */
 export declare function deleteGroupMapping({ id, attributeImporterId }: {
     id: string;
     attributeImporterId: string;
 }, opts?: Oazapfts.RequestOpts): Promise<unknown>;
 /**
- * Get Service Credentials
+ * Retrieves a list of service credentials associated with the current user
  */
 export declare function getServiceCredentials({ size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn, name, status }: {
     size?: any;
@@ -2068,13 +2096,13 @@ export declare function getServiceCredentials({ size, page, sort, direction, sea
     status?: string;
 }, opts?: Oazapfts.RequestOpts): Promise<PageResponseServiceCredentialResponse>;
 /**
- * Create Service Credential v2
+ * Creates a new service credential for the current user.
  */
 export declare function createServiceCredential({ serviceCredentialCreateRequestV2 }: {
     serviceCredentialCreateRequestV2: ServiceCredentialCreateRequestV2;
 }, opts?: Oazapfts.RequestOpts): Promise<ServiceCredentialCreateResponseV2>;
 /**
- * Get Service Credentials
+ * Retrieves a list of service credentials with their associated owner information if available.
  */
 export declare function getServiceCredentials1({ name, status, page, size }: {
     name?: string;
@@ -2083,13 +2111,13 @@ export declare function getServiceCredentials1({ name, status, page, size }: {
     size?: string;
 }, opts?: Oazapfts.RequestOpts): Promise<ServiceCredentialResponse[]>;
 /**
- * Create Service Credential
+ * Creates a new service credential for an account.
  */
 export declare function createServiceCredential1({ serviceCredentialCreateRequest }: {
     serviceCredentialCreateRequest: ServiceCredentialCreateRequest;
 }, opts?: Oazapfts.RequestOpts): Promise<ServiceCredentialCreateResponse>;
 /**
- * Notify about Service Credential expiration
+ * Notifies the user about the expiration of the service credential via email.
  */
 export declare function notifyServiceCredentialExpiration({ serviceCredentialExpirationRequest }: {
     serviceCredentialExpirationRequest: ServiceCredentialExpirationNotifyRequest;
@@ -2201,7 +2229,7 @@ export declare function bindRoleGroups({ roleId, roleGroupIdsRequest }: {
     roleGroupIdsRequest: RoleGroupIdsRequest;
 }, opts?: Oazapfts.RequestOpts): Promise<unknown>;
 /**
- * Get Resources
+ * Retrieves a list of resources.
  */
 export declare function getResources1({ size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }: {
     size?: any;
@@ -2216,7 +2244,7 @@ export declare function getResources1({ size, page, sort, direction, search, fil
     filterIn?: any;
 }, opts?: Oazapfts.RequestOpts): Promise<ResourceResponse[]>;
 /**
- * Create a new resource for Account
+ * Creates a new resource for the account.
  */
 export declare function createResource({ createResourceRequest }: {
     createResourceRequest: CreateResourceRequest;
@@ -2295,13 +2323,13 @@ export declare function bindToGroups({ memberId, memberIdsCommonRequest }: {
     memberIdsCommonRequest: MemberIdsCommonRequest;
 }, opts?: Oazapfts.RequestOpts): Promise<unknown>;
 /**
- * Get account member favorite resources
+ * Lists all favorite resources associated with a specific member.
  */
 export declare function listAccountMemberFavorites({ memberId }: {
     memberId: string;
 }, opts?: Oazapfts.RequestOpts): Promise<FavoriteResourcesResponse[]>;
 /**
- * Add account member favorite resource
+ * Adds a favorite resource to a member.
  */
 export declare function addAccountMemberFavorite({ memberId, createFavoriteResourceRequest }: {
     memberId: string;
@@ -2556,7 +2584,7 @@ export declare function create1({ createAccountOrderRequest }: {
     createAccountOrderRequest: CreateAccountOrderRequest;
 }, opts?: Oazapfts.RequestOpts): Promise<unknown>;
 /**
- * Get All SSO Group Mapping
+ * Retrieves a list of SSO group mappings.
  */
 export declare function getAllGroupMapping({ id, size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }: {
     id: string;
@@ -2572,21 +2600,21 @@ export declare function getAllGroupMapping({ id, size, page, sort, direction, se
     filterIn?: any;
 }, opts?: Oazapfts.RequestOpts): Promise<PageResponseAccountSsoGroupMappingResponse>;
 /**
- * Create SSO Group Mapping
+ * Creates a new SSO group mapping.
  */
 export declare function createGroupMapping({ id, accountGroupMappingCreateRequest }: {
     id: string;
     accountGroupMappingCreateRequest: AccountGroupMappingCreateRequest;
 }, opts?: Oazapfts.RequestOpts): Promise<unknown>;
 /**
- * Configure new SSO in account
+ * Configures new SSO in account.
  */
 export declare function ssoConfigure({ protocol, accountSsoCreateRequest }: {
     protocol: "SAML" | "OPENID";
     accountSsoCreateRequest: AccountSsoCreateRequest;
 }, opts?: Oazapfts.RequestOpts): Promise<SsoIdResponse>;
 /**
- * Parse SSO configuration file
+ * Parses an SSO configuration file and returns the parsed data with a callback URL.
  */
 export declare function ssoParseConfigurationFile({ protocol, body }: {
     protocol: "SAML" | "OPENID";
@@ -2621,14 +2649,21 @@ export declare function validateNewPartnerData({ validateAccountPartnerDataReque
     validateAccountPartnerDataRequest: ValidateAccountPartnerDataRequest;
 }, opts?: Oazapfts.RequestOpts): Promise<unknown>;
 /**
- * Rotate Service Credential Secret v2
+ * Rotates the secret of a service credential.
  */
 export declare function rotateServiceCredentialSecret({ id, rotateServiceCredentialSecretRequest }: {
     id: string;
     rotateServiceCredentialSecretRequest: RotateServiceCredentialSecretRequest;
 }, opts?: Oazapfts.RequestOpts): Promise<RotateServiceCredentialSecretResponse>;
 /**
- * Revoke Service Credential v2
+ * Updates the scopes of a service credential
+ */
+export declare function updateServiceCredentialScopes({ id, updateServiceCredentialScopesRequest }: {
+    id: string;
+    updateServiceCredentialScopesRequest: UpdateServiceCredentialScopesRequest;
+}, opts?: Oazapfts.RequestOpts): Promise<unknown>;
+/**
+ * Revokes a service account for the current user.
  */
 export declare function revokeServiceCredential({ id }: {
     id: string;
@@ -2669,7 +2704,7 @@ export declare function associateGroupToServiceCredential({ id, serviceCredentia
     serviceCredentialAssociateGroupRequest: ServiceCredentialAssociateGroupRequest;
 }, opts?: Oazapfts.RequestOpts): Promise<unknown>;
 /**
- * Revoke Service Credential
+ * Revokes a service credential.
  */
 export declare function revokeServiceCredential1({ id }: {
     id: string;
@@ -2832,18 +2867,28 @@ export declare function addNewEmailDomain({ accountId, addNewEmailDomainRequest
     addNewEmailDomainRequest: AddNewEmailDomainRequest;
 }, opts?: Oazapfts.RequestOpts): Promise<unknown>;
 /**
- * Get configured account SSO attributes
+ * Retrieves the SSO attributes configuration for a given SSO ID.
  */
 export declare function ssoGetAttributesConfig({ id }: {
     id: string;
 }, opts?: Oazapfts.RequestOpts): Promise<AccountSsoAttributesConfigResponse>;
 /**
- * Configure account SSO attributes
+ * Updates the configuration of SSO attributes for a specified SSO.
  */
 export declare function ssoAddAttributes({ id, accountSsoAddAttributesConfigRequest }: {
     id: string;
     accountSsoAddAttributesConfigRequest: AccountSsoAddAttributesConfigRequest;
 }, opts?: Oazapfts.RequestOpts): Promise<unknown>;
+/**
+ * Get account rate limit
+ */
+export declare function getAccountRateLimit(opts?: Oazapfts.RequestOpts): Promise<RateLimitResponse>;
+/**
+ * Update Account rate limit
+ */
+export declare function updateRateLimit({ updateRateLimitRequest }: {
+    updateRateLimitRequest: UpdateRateLimitRequest;
+}, opts?: Oazapfts.RequestOpts): Promise<RateLimitResponse>;
 /**
  * Get Partner by account Id
  */
@@ -2871,7 +2916,7 @@ export declare function updatePartnerAccountAdminData({ id, accountPartnerAdminD
     accountPartnerAdminDataUpdateRequest: AccountPartnerAdminDataUpdateRequest;
 }, opts?: Oazapfts.RequestOpts): Promise<unknown>;
 /**
- * List service credential groups
+ * Retrieves a paginated list of groups associated with a service credential for a given client ID.
  */
 export declare function getServiceCredentialGroups({ id }: {
     id: string;
@@ -2940,7 +2985,7 @@ export declare function getRoleGroups({ roleId, size, page, sort, direction, sea
     filterIn?: any;
 }, opts?: Oazapfts.RequestOpts): Promise<PageResponseRoleGroupResponse>;
 /**
- * Get Resources
+ * Retrieves a list of resources.
  */
 export declare function getResources({ size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }: {
     size?: any;
@@ -2955,7 +3000,7 @@ export declare function getResources({ size, page, sort, direction, search, filt
     filterIn?: any;
 }, opts?: Oazapfts.RequestOpts): Promise<PageResponseResourceResponse>;
 /**
- * Get Members from Resource
+ * Retrieves a list of members for a specified resource.
  */
 export declare function getResourceMembers({ resourceId, size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }: {
     resourceId: string;
@@ -2971,7 +3016,7 @@ export declare function getResourceMembers({ resourceId, size, page, sort, direc
     filterIn?: any;
 }, opts?: Oazapfts.RequestOpts): Promise<PageResponseMembersFromResourceResponse>;
 /**
- * Get Groups from Resource
+ * Retrieves a list of groups associated with a specified resource.
  */
 export declare function getResourceGroups({ resourceId, size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }: {
     resourceId: string;
@@ -3151,7 +3196,7 @@ export declare function getAccountMembers1({ id, size, page, sort, direction, se
     filterIn?: any;
 }, opts?: Oazapfts.RequestOpts): Promise<AccountMemberResponse[]>;
 /**
- * Get Service Credential by ID (Client ID)
+ * Retrieves the service credential details for a given client ID.
  */
 export declare function getServiceCredential({ id }: {
     id: string;
@@ -3163,7 +3208,7 @@ export declare function getServiceCredentialPermissions({ id }: {
     id: string;
 }, opts?: Oazapfts.RequestOpts): Promise<FullResourceResponse[]>;
 /**
- * List service credential groups
+ * Retrieves a list of service credential groups associated with a specific client ID.
  */
 export declare function getServiceCredentialGroups1({ id }: {
     id: string;
@@ -3199,7 +3244,7 @@ export declare function getPermissionsWithStatus({ roleId, size, page, sort, dir
     filterIn?: any;
 }, opts?: Oazapfts.RequestOpts): Promise<RolePermissionResponse[]>;
 /**
- * Get Members from Resource
+ * Retrieves a list of members for a specified resource.
  */
 export declare function getResourceMembers1({ resourceId, size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }: {
     resourceId: string;
@@ -3215,7 +3260,7 @@ export declare function getResourceMembers1({ resourceId, size, page, sort, dire
     filterIn?: any;
 }, opts?: Oazapfts.RequestOpts): Promise<MembersFromResourceResponse[]>;
 /**
- * Get Groups from Resource
+ * Retrieves a list of resource groups associated with a specific resource.
  */
 export declare function getResourceGroups1({ resourceId, size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }: {
     resourceId: string;
@@ -3261,12 +3306,12 @@ export declare function getResources2({ memberId }: {
     memberId: string;
 }, opts?: Oazapfts.RequestOpts): Promise<ResourceDto[]>;
 /**
- * Get member favorite resources by type
+ * Lists the IDs of a member's favorite resources of a specified type.
  */
 export declare function listMemberFavoritesByResource({ memberId, resourceType }: {
     memberId: string;
     resourceType: string;
-}, opts?: Oazapfts.RequestOpts): Promise<any>;
+}, opts?: Oazapfts.RequestOpts): Promise<string[]>;
 /**
  * Retrieves a list of account members and collaborators associated with the current user's account.
  */
@@ -3327,7 +3372,7 @@ export declare function getAccountSlug({ accountId }: {
     accountId: string;
 }, opts?: Oazapfts.RequestOpts): Promise<AccountSlugResponse>;
 /**
- * Get all SSO configured in account
+ * Retrieves a list of SSO for the current account.
  */
 export declare function getAllAccountSso({ size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }: {
     size?: any;
@@ -3365,7 +3410,7 @@ export declare function getPartnersSharingAllowed({ name }: {
  */
 export declare function validatePartnerAssociationLimit(opts?: Oazapfts.RequestOpts): Promise<unknown>;
 /**
- * Disassociate Group to Service Credential
+ * Disassociates a group from a service credential.
  */
 export declare function disassociateGroupToServiceCredential({ id, groupId }: {
     id: string;
@@ -3379,7 +3424,7 @@ export declare function removeRoleFromMember({ roleId, memberId }: {
     memberId: string;
 }, opts?: Oazapfts.RequestOpts): Promise<unknown>;
 /**
- * Delete a resource from Account
+ * Deletes a resource from the account.
  */
 export declare function deleteResource({ resourceId }: {
     resourceId: string;
@@ -3391,7 +3436,7 @@ export declare function deleteProfileImage({ memberId }: {
     memberId: string;
 }, opts?: Oazapfts.RequestOpts): Promise<unknown>;
 /**
- * Remove resource from member favorites
+ * Removes a specified resource from a member favorites.
  */
 export declare function deleteMemberFavorite({ memberId, resourceType, resourceId }: {
     memberId: string;