@stack-spot/portal-network 0.202.1 → 0.203.0-beta.1

package/dist/api/account.d.ts

@@ -158,6 +158,8 @@ export type UserScmInfoResponse = {
     secretName: string;
     /** Provider type */
     provider: "GITHUB" | "GITLAB" | "BITBUCKET" | "AZURE" | "GITLAB_ONPRM";
+    /** User email */
+    email: string;
 };
 export type UserScmInfoRequest = {
     /** Repository Username */
@@ -278,21 +280,21 @@ export type AccountScmInfoResponse = {
 export type Value = object;
 export type Basic = Value & {
     /** PAT repository Username */
-    user?: string;
+    user: string;
     /** PAT repository password */
-    pass?: string;
+    pass: string;
 };
 export type GithubApp = Value & {
     /** GithubApp App Id */
-    appId?: string;
+    appId: string;
     /** GithubApp Client Id */
-    clientId?: string;
+    clientId: string;
     /** GithubApp Client Secret */
-    clientSecret?: string;
+    clientSecret: string;
     /** GithubApp Installer Id */
-    installationId?: string;
+    installationId: string;
     /** GithubApp private key */
-    privateKey?: string;
+    privateKey: string;
 };
 export type AccountScmInfoUpdateRequest = {
     /** SCM Type */
@@ -400,8 +402,6 @@ export type AccountMemberStackspotIamDto = {
 export type UpdateUserRequest = {
     /** User username */
     username?: string;
-    /** User email */
-    email?: string;
     /** User first name */
     firstName?: string;
     /** User last name */
@@ -449,14 +449,14 @@ export type UpdatePasswordRequest = {
     /** New password */
     password: string;
 };
-export type UpdateSalesRepresentativesRequest = {
-    /** List of emails from sales representatives responsible for the account. */
-    salesRepresentatives: string[];
-};
 export type AccountStatusRequest = {
     /** Account enabled */
     enabled: boolean;
 };
+export type UpdateSalesRepresentativesRequest = {
+    /** List of emails from sales representatives responsible for the account. */
+    salesRepresentatives: string[];
+};
 export type AttributeImporter = {
     /** External user attribute */
     externalUserAttribute?: string;
@@ -640,6 +640,66 @@ export type ServiceCredentialCreateResponseV2 = {
     /** Account tenant */
     tenant: string;
 };
+export type ResourceTypeDto = {
+    /** Id of resource type. */
+    id: string;
+    /** Name of resource type. */
+    name: string;
+    /** Slug of resource type. */
+    slug: string;
+    /** Description of resource type. */
+    description: string;
+    /** Creation date of resource type. */
+    createdAt: string;
+};
+export type ResourceResponse = {
+    /** Id of resource. */
+    id: string;
+    /** Name of resource. */
+    name: string;
+    /** Description of resource. */
+    description?: string;
+    "type"?: ResourceTypeDto;
+    /** Name of resource. */
+    slug: string;
+};
+export type PageResponseResourceResponse = {
+    /** Current page content */
+    items?: ResourceResponse[];
+    /** Total elements found */
+    totalElements: number;
+    /** Current page number */
+    page: number;
+    /** Length of current page items */
+    size: number;
+    /** Total pages found */
+    totalPages: number;
+};
+export type ResourceTypeRequest = {
+    id?: string;
+    slug?: string;
+};
+export type CreateResourceV2Request = {
+    /** Resource name */
+    name: string;
+    /** Resource slug */
+    slug: string;
+    "type": ResourceTypeRequest;
+    /** Resource description */
+    description: string;
+    /** Resource Parent ID */
+    parentId?: string;
+};
+export type IdResponse = {
+    /** Id response. */
+    id: string;
+};
+export type AddResourceToGroupBySlugAndTypeRequest = {
+    /** Resource slug. */
+    slug: string;
+    /** Resource Type. */
+    "type": string;
+};
 export type FeatureFlagPageRequest = {
     size?: number;
     page: number;
@@ -928,10 +988,6 @@ export type CreateAccountRoleRequest = {
     /** Account Role description */
     description?: string;
 };
-export type IdResponse = {
-    /** Id response. */
-    id: string;
-};
 export type RoleMemberResponse = {
     /** Member ID */
     id: string;
@@ -967,29 +1023,6 @@ export type RoleGroupIdsRequest = {
     /** List of group IDs to be bound to the role. */
     ids: string[];
 };
-export type ResourceTypeDto = {
-    /** Id of resource type. */
-    id: string;
-    /** Name of resource type. */
-    name: string;
-    /** Slug of resource type. */
-    slug: string;
-    /** Description of resource type. */
-    description: string;
-    /** Creation date of resource type. */
-    createdAt: string;
-};
-export type ResourceResponse = {
-    /** Id of resource. */
-    id: string;
-    /** Name of resource. */
-    name: string;
-    /** Description of resource. */
-    description?: string;
-    "type"?: ResourceTypeDto;
-    /** Name of resource. */
-    slug: string;
-};
 export type CreateResourceRequest = {
     /** Account resource name */
     name: string;
@@ -1000,6 +1033,46 @@ export type CreateResourceRequest = {
     /** Account resource description */
     description?: string;
 };
+export type ResourceReviewAnswerDto = {
+    id: string;
+    memberId: string;
+    comment: string;
+    createdAt: string;
+    updatedAt?: string;
+};
+export type ViewResourceReviewResponse = {
+    id: string;
+    memberId: string;
+    rating: number;
+    comment?: string;
+    resourceType: string;
+    resourceSlug: string;
+    createdAt: string;
+    updatedAt?: string;
+    reviewAnswers?: ResourceReviewAnswerDto[];
+};
+export type PageResponseViewResourceReviewResponse = {
+    /** Current page content */
+    items?: ViewResourceReviewResponse[];
+    /** Total elements found */
+    totalElements: number;
+    /** Current page number */
+    page: number;
+    /** Length of current page items */
+    size: number;
+    /** Total pages found */
+    totalPages: number;
+};
+export type CreateResourceReviewRequest = {
+    /** Evaluation grade, represented by an integer between 1 and 5. */
+    rating: number;
+    /** Evaluation comment */
+    comment?: string;
+};
+export type CreateReviewAnswerRequest = {
+    /** Comment of the review. */
+    answer: string;
+};
 export type AccountMemberResponse = {
     /** Account member id */
     id: string;
@@ -1511,6 +1584,14 @@ export type AccountTrialCreateRequest = {
     reachedBy?: ("GOOGLE_SEARCH" | "REFERRAL" | "SOCIAL_MEDIA" | "ONLINE_AD" | "EVENT_CONFERENCE" | "EMAIL_CAMPAIGN" | "FRIEND_COLLEAGUE" | "BLOG_ARTICLE" | "YOUTUBE_VIDEO_CONTENT" | "ZUP_OFFICIAL_CHANNELS" | "OTHER")[];
     /** The custom channel used for the trial user to reach Stackspot */
     customReachedBy?: string;
+    /** Identify the source of the access (LinkedIn, Facebook, Instagram, etc.) */
+    utmSource?: string;
+    /** Identifies the campaign medium */
+    utmMedium?: string;
+    /** Identifies the campaign name, specific promotion, or slogan. */
+    utmCampaign?: string;
+    /** Identifies the paid term in paid search campaigns (keyword). */
+    utmTerm?: string;
 };
 export type PersonalAccountExpirationDataResponse = {
     /** Account id */
@@ -1640,6 +1721,43 @@ export type ValidateAccountPartnerDataRequest = {
     /** Email domains list that account users will use to login into StackSpot. Example: zup.com.br */
     domains?: string[];
 };
+export type PrivilegeResourceTypeIdentificationRequest = {
+    /** Slug of the resource type. */
+    slug?: string;
+    /** ID of the resource type. */
+    id?: string;
+};
+export type PrivilegeResourceIdentificationRequest = {
+    "type": PrivilegeResourceTypeIdentificationRequest;
+    /** Slug of the resource. */
+    slug: string;
+};
+export type PrivilegeActionIdentificationRequest = {
+    /** ID of the action. */
+    id?: string;
+    /** Slug of the action. */
+    slug?: string;
+};
+export type RemovePrivilegeToGroupRequest = {
+    /** List of resources to which the privilege applies. */
+    resources: PrivilegeResourceIdentificationRequest[];
+    /** List of resource types to which the privilege applies. */
+    resource_types: PrivilegeResourceTypeIdentificationRequest[];
+    /** List of actions to which the privilege applies. */
+    actions: PrivilegeActionIdentificationRequest[];
+    /** Whether the privilege is inheritable by child resources. */
+    inheritable: boolean;
+};
+export type AddPrivilegeToGroupRequest = {
+    /** List of resources to which the privilege applies. */
+    resources: PrivilegeResourceIdentificationRequest[];
+    /** List of resource types to which the privilege applies. */
+    resource_types: PrivilegeResourceTypeIdentificationRequest[];
+    /** List of actions to which the privilege applies. */
+    actions: PrivilegeActionIdentificationRequest[];
+    /** Whether the privilege is inheritable by child resources. */
+    inheritable: boolean;
+};
 export type RotateServiceCredentialSecretRequest = {
     /** Service credential secret */
     secret: string;
@@ -1687,6 +1805,16 @@ export type ServiceCredentialAssociateGroupRequest = {
     /** Service credential groups ids */
     teams: string[];
 };
+export type UpdateResourceReviewRequest = {
+    /** Evaluation grade, represented by an integer between 1 and 5. */
+    rating?: number;
+    /** Evaluation comment */
+    comment?: string;
+};
+export type UpdateReviewAnswerRequest = {
+    /** Comment of the review. */
+    answer: string;
+};
 export type ReadPreferencesResponse = {
     /** Dashboard widgets preferences */
     dashboardWidgets?: string[];
@@ -1903,18 +2031,6 @@ export type PageResponseRoleGroupResponse = {
     /** Total pages found */
     totalPages: number;
 };
-export type PageResponseResourceResponse = {
-    /** Current page content */
-    items?: ResourceResponse[];
-    /** Total elements found */
-    totalElements: number;
-    /** Current page number */
-    page: number;
-    /** Length of current page items */
-    size: number;
-    /** Total pages found */
-    totalPages: number;
-};
 export type MembersFromResourceResponse = {
     /** Member ID */
     id: string;
@@ -2232,7 +2348,7 @@ export type PersonalAccountDetailsResponse = {
     /** Custom position of the account owner in the company, if not listed. */
     otherPosition?: string | null;
     /** How the account owner was reached. */
-    reachedBy?: (("GOOGLE_SEARCH" | "REFERRAL" | "SOCIAL_MEDIA" | "ONLINE_AD" | "EVENT_CONFERENCE" | "EMAIL_CAMPAIGN" | "FRIEND_COLLEAGUE" | "BLOG_ARTICLE" | "YOUTUBE_VIDEO_CONTENT" | "ZUP_OFFICIAL_CHANNELS" | "OTHER") | null)[] | null;
+    reachedBy?: ("GOOGLE_SEARCH" | "REFERRAL" | "SOCIAL_MEDIA" | "ONLINE_AD" | "EVENT_CONFERENCE" | "EMAIL_CAMPAIGN" | "FRIEND_COLLEAGUE" | "BLOG_ARTICLE" | "YOUTUBE_VIDEO_CONTENT" | "ZUP_OFFICIAL_CHANNELS" | "OTHER")[] | null;
     /** Custom description of how the account owner was reached, if not listed. */
     customReachedBy?: string | null;
 };
@@ -2283,6 +2399,35 @@ export type AccountPartnerResponse = {
     /** Account current status */
     isActive: boolean;
 };
+export type ResourceTypeIdentifierRequest = {
+    /** Slug of the resource type. */
+    slug?: string;
+    /** ID of the resource type. */
+    id?: string;
+};
+export type DeleteResourceRequestV3 = {
+    "type": ResourceTypeIdentifierRequest;
+    /** Slug of the resource to be deleted */
+    slug: string;
+};
+export type DeleteResourceResponseV3 = {
+    /** Unique identifier of the resource. */
+    id: string;
+    /** Name of the resource. */
+    name: string;
+    /** Slug version of the resource name. */
+    slug: string;
+    /** Optional description of the resource. */
+    description?: string;
+    "type"?: ResourceTypeDto;
+};
+export type PageDtoDeleteResourceResponseV3 = {
+    items: DeleteResourceResponseV3[];
+    size: number;
+    totalElements: number;
+    page: number;
+    totalPages: number;
+};
 /**
  * Retrieves a list of rate limit with the associated service credential.
  */
@@ -2493,6 +2638,13 @@ export declare function updateUserPassword({ memberId, updatePasswordRequest }:
     memberId: string;
     updatePasswordRequest: UpdatePasswordRequest;
 }, opts?: Oazapfts.RequestOpts): Promise<unknown>;
+/**
+ * Updates an account status based on the provided account ID.
+ */
+export declare function updateAccountStatus({ accountId, accountStatusRequest }: {
+    accountId: string;
+    accountStatusRequest: AccountStatusRequest;
+}, opts?: Oazapfts.RequestOpts): Promise<unknown>;
 /**
  * Updates the sales representatives associated with an active account.
  */
@@ -2503,7 +2655,7 @@ export declare function updateSalesRepresentatives({ accountId, updateSalesRepre
 /**
  * Enables an account by updating its status.
  */
-export declare function updateAccountStatus({ accountId, accountStatusRequest }: {
+export declare function updateAccountStatus1({ accountId, accountStatusRequest }: {
     accountId: string;
     accountStatusRequest: AccountStatusRequest;
 }, opts?: Oazapfts.RequestOpts): Promise<unknown>;
@@ -2578,6 +2730,50 @@ export declare function getServiceCredentials({ size, page, sort, direction, sea
 export declare function createServiceCredential({ serviceCredentialCreateRequestV2 }: {
     serviceCredentialCreateRequestV2: ServiceCredentialCreateRequestV2;
 }, opts?: Oazapfts.RequestOpts): Promise<ServiceCredentialCreateResponseV2>;
+/**
+ * Retrieves a list of resources.
+ */
+export declare function getResources({ size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }: {
+    size?: any;
+    page?: any;
+    sort?: string;
+    direction?: "ASC" | "DESC";
+    search?: string;
+    filterMode?: "MATCH" | "CONTAINS" | "IN";
+    filterBy?: string;
+    filterValue?: string;
+    multiFilterMode?: string;
+    filterIn?: any;
+}, opts?: Oazapfts.RequestOpts): Promise<PageResponseResourceResponse>;
+/**
+ * Creates a new resource for the account.
+ */
+export declare function createResource({ createResourceV2Request }: {
+    createResourceV2Request: CreateResourceV2Request;
+}, opts?: Oazapfts.RequestOpts): Promise<IdResponse>;
+/**
+ * Get Group Resources
+ */
+export declare function getGroupResources({ groupId, size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }: {
+    groupId: string;
+    size?: any;
+    page?: any;
+    sort?: string;
+    direction?: "ASC" | "DESC";
+    search?: string;
+    filterMode?: "MATCH" | "CONTAINS" | "IN";
+    filterBy?: string;
+    filterValue?: string;
+    multiFilterMode?: string;
+    filterIn?: any;
+}, opts?: Oazapfts.RequestOpts): Promise<PageResponseResourceResponse>;
+/**
+ * Add Multiple Resources to Group
+ */
+export declare function addResourcesToGroupBySlugAndType({ groupId, body }: {
+    groupId: string;
+    body: AddResourceToGroupBySlugAndTypeRequest[];
+}, opts?: Oazapfts.RequestOpts): Promise<unknown>;
 /**
  * Returns a paged list of Feature Flags associated with the current user's account.
  */
@@ -2770,7 +2966,7 @@ export declare function bindRoleGroups({ roleId, roleGroupIdsRequest }: {
 /**
  * Retrieves a list of resources.
  */
-export declare function getResources({ size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }: {
+export declare function getResources1({ size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }: {
     size?: any;
     page?: any;
     sort?: string;
@@ -2785,9 +2981,43 @@ export declare function getResources({ size, page, sort, direction, search, filt
 /**
  * Creates a new resource for the account.
  */
-export declare function createResource({ createResourceRequest }: {
+export declare function createResource1({ createResourceRequest }: {
     createResourceRequest: CreateResourceRequest;
 }, opts?: Oazapfts.RequestOpts): Promise<IdResponse>;
+/**
+ * Get all resources reviews
+ */
+export declare function getReviews({ resourceSlug, resourceTypeSlug, size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }: {
+    resourceSlug: string;
+    resourceTypeSlug: string;
+    size?: any;
+    page?: any;
+    sort?: string;
+    direction?: "ASC" | "DESC";
+    search?: string;
+    filterMode?: "MATCH" | "CONTAINS" | "IN";
+    filterBy?: string;
+    filterValue?: string;
+    multiFilterMode?: string;
+    filterIn?: any;
+}, opts?: Oazapfts.RequestOpts): Promise<PageResponseViewResourceReviewResponse>;
+/**
+ * Create a resource review
+ */
+export declare function createReview({ resourceSlug, resourceTypeSlug, xMemberId, createResourceReviewRequest }: {
+    resourceSlug: string;
+    resourceTypeSlug: string;
+    xMemberId: string;
+    createResourceReviewRequest: CreateResourceReviewRequest;
+}, opts?: Oazapfts.RequestOpts): Promise<never>;
+/**
+ * Create an answer to a review
+ */
+export declare function createReviewAnswer({ reviewId, xMemberId, createReviewAnswerRequest }: {
+    reviewId: string;
+    xMemberId: string;
+    createReviewAnswerRequest: CreateReviewAnswerRequest;
+}, opts?: Oazapfts.RequestOpts): Promise<never>;
 /**
  * Retrieves a list of account members for a specified account.
  */
@@ -2947,7 +3177,7 @@ export declare function bindRoles({ groupId, groupRoleIdsRequest }: {
 /**
  * Get Group Resources
  */
-export declare function getGroupResources({ groupId, size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }: {
+export declare function getGroupResources1({ groupId, size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }: {
     groupId: string;
     size?: any;
     page?: any;
@@ -2991,9 +3221,11 @@ export declare function bindGroupMembers({ groupId, groupMemberIdsRequest }: {
     groupMemberIdsRequest: GroupMemberIdsRequest;
 }, opts?: Oazapfts.RequestOpts): Promise<unknown>;
 /**
- * List all Account Extensions
+ * List extensions that user is allowed to manage
  */
-export declare function listExtensions(opts?: Oazapfts.RequestOpts): Promise<ExtensionReadResponse[]>;
+export declare function listManageableExtensions({ actions }: {
+    actions?: string[];
+}, opts?: Oazapfts.RequestOpts): Promise<ExtensionReadResponse[]>;
 /**
  * Create Account Extension
  */
@@ -3221,6 +3453,20 @@ export declare function createPartner({ createAccountPartnerOrderRequest }: {
 export declare function validateNewPartnerData({ validateAccountPartnerDataRequest }: {
     validateAccountPartnerDataRequest: ValidateAccountPartnerDataRequest;
 }, opts?: Oazapfts.RequestOpts): Promise<unknown>;
+/**
+ * Removes privileges to group's default role.
+ */
+export declare function removePermissions({ groupId, body }: {
+    groupId: string;
+    body: RemovePrivilegeToGroupRequest[];
+}, opts?: Oazapfts.RequestOpts): Promise<never>;
+/**
+ * Add privileges to group's default role.
+ */
+export declare function addPrivilegesToGroup({ groupId, body }: {
+    groupId: string;
+    body: AddPrivilegeToGroupRequest[];
+}, opts?: Oazapfts.RequestOpts): Promise<unknown>;
 /**
  * Rotates the secret of a service credential.
  */
@@ -3326,6 +3572,38 @@ export declare function cancelSecretDelete({ secretId }: {
  * Migrate Api Key Secrets to new version
  */
 export declare function migrateApiKeySecretsToV2(opts?: Oazapfts.RequestOpts): Promise<never>;
+/**
+ * Delete a resources review
+ */
+export declare function deleteReview({ reviewId, xMemberId }: {
+    reviewId: string;
+    xMemberId: string;
+}, opts?: Oazapfts.RequestOpts): Promise<never>;
+/**
+ * Update a resources review
+ */
+export declare function updateReview({ reviewId, xMemberId, updateResourceReviewRequest }: {
+    reviewId: string;
+    xMemberId: string;
+    updateResourceReviewRequest: UpdateResourceReviewRequest;
+}, opts?: Oazapfts.RequestOpts): Promise<never>;
+/**
+ * Delete an answer to a review
+ */
+export declare function deleteReviewAnswer({ answerId, reviewId, xMemberId }: {
+    answerId: string;
+    reviewId: string;
+    xMemberId: string;
+}, opts?: Oazapfts.RequestOpts): Promise<never>;
+/**
+ * Edit an evaluation comment
+ */
+export declare function editReviewAnswer({ reviewId, answerId, xMemberId, updateReviewAnswerRequest }: {
+    reviewId: string;
+    answerId: string;
+    xMemberId: string;
+    updateReviewAnswerRequest: UpdateReviewAnswerRequest;
+}, opts?: Oazapfts.RequestOpts): Promise<never>;
 /**
  * Retrieves the preferences of a specific member.
  */
@@ -3588,21 +3866,6 @@ export declare function getRoleGroups1({ roleId, size, page, sort, direction, se
     multiFilterMode?: string;
     filterIn?: any;
 }, opts?: Oazapfts.RequestOpts): Promise<PageResponseRoleGroupResponse>;
-/**
- * Retrieves a list of resources.
- */
-export declare function getResources1({ size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }: {
-    size?: any;
-    page?: any;
-    sort?: string;
-    direction?: "ASC" | "DESC";
-    search?: string;
-    filterMode?: "MATCH" | "CONTAINS" | "IN";
-    filterBy?: string;
-    filterValue?: string;
-    multiFilterMode?: string;
-    filterIn?: any;
-}, opts?: Oazapfts.RequestOpts): Promise<PageResponseResourceResponse>;
 /**
  * Retrieves a list of members for a specified resource.
  */
@@ -3729,22 +3992,6 @@ export declare function getRoles5({ groupId, size, page, sort, direction, search
     multiFilterMode?: string;
     filterIn?: any;
 }, opts?: Oazapfts.RequestOpts): Promise<PageResponseRoleResponse>;
-/**
- * Get Group Resources
- */
-export declare function getGroupResources1({ groupId, size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }: {
-    groupId: string;
-    size?: any;
-    page?: any;
-    sort?: string;
-    direction?: "ASC" | "DESC";
-    search?: string;
-    filterMode?: "MATCH" | "CONTAINS" | "IN";
-    filterBy?: string;
-    filterValue?: string;
-    multiFilterMode?: string;
-    filterIn?: any;
-}, opts?: Oazapfts.RequestOpts): Promise<PageResponseResourceResponse>;
 /**
  * Get Group members
  */
@@ -4037,6 +4284,12 @@ export declare function getPartnersSharingAllowed({ name }: {
  * Validate Partner association limit
  */
 export declare function validatePartnerAssociationLimit(opts?: Oazapfts.RequestOpts): Promise<unknown>;
+/**
+ * Deletes a resource from the account by resource type and resource slug.
+ */
+export declare function deleteResource({ deleteResourceRequestV3 }: {
+    deleteResourceRequestV3: DeleteResourceRequestV3;
+}, opts?: Oazapfts.RequestOpts): Promise<PageDtoDeleteResourceResponseV3>;
 /**
  * Disassociate Group to Service Credential
  */
@@ -4054,7 +4307,7 @@ export declare function removeRoleFromMember({ roleId, memberId }: {
 /**
  * Deletes a resource from the account.
  */
-export declare function deleteResource({ resourceId }: {
+export declare function deleteResource1({ resourceId }: {
     resourceId: string;
 }, opts?: Oazapfts.RequestOpts): Promise<unknown>;
 /**