@stack-spot/portal-network 0.99.5 → 0.101.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [0.101.0](https://github.com/stack-spot/portal-commons/compare/portal-network@v0.100.0...portal-network@v0.101.0) (2025-03-24)
+
+
+### Features
+
+* add queries vpn ([2e575b3](https://github.com/stack-spot/portal-commons/commit/2e575b32c592ed19f4f09d3d5bdc90a98250125b))
+
+## [0.100.0](https://github.com/stack-spot/portal-commons/compare/portal-network@v0.99.5...portal-network@v0.100.0) (2025-03-21)
+
+
+### Features
+
+* add account endpoints trial ([#827](https://github.com/stack-spot/portal-commons/issues/827)) ([2527e76](https://github.com/stack-spot/portal-commons/commit/2527e76e256a6f53ddb8512b9a2cb7af19b6e4b1))
+
 ## [0.99.5](https://github.com/stack-spot/portal-commons/compare/portal-network@v0.99.4...portal-network@v0.99.5) (2025-03-21)
 
 

package/dist/api/account.d.ts

@@ -575,7 +575,7 @@ export type CreateSecretRequest = {
     /** Secret name */
     name: string;
     /** Secret description */
-    description: string;
+    description?: string;
     /** Secret type */
     "type": "API_KEY" | "OAUTH" | "CERTIFICATE" | "KEY_VALUE" | "BEARER_TOKEN";
     /** Secret scope */
@@ -891,6 +891,62 @@ export type InviteMembersResponse = {
     /** Members with error */
     errors: string[];
 };
+export type PersonalLeadRequest = {
+    /** Lead name */
+    name: string;
+    /** Lead email */
+    email: string;
+    /** Lead phone number */
+    phone: string;
+    /** Preferred contact method */
+    contactPreference: "EMAIL" | "PHONE";
+    /** Contact reason */
+    reason: string;
+};
+export type LeadResponse = {
+    /** Unique identifier of the lead. */
+    id: string;
+    /** Type of the lead, indicating whether it is a personal or enterprise lead. */
+    "type": "PERSONAL" | "ENTERPRISE";
+    /** Full name of the lead. */
+    name: string;
+    /** Email address of the lead. */
+    email: string;
+    /** Phone number of the lead, including country code if applicable. */
+    phone: string;
+    /** Reason for the lead's contact or inquiry. */
+    reason: string;
+    /** Name of the company associated with the lead, if applicable. */
+    companyName?: string | null;
+    /** Industry of the company associated with the lead, if applicable. */
+    companyIndustry?: string | null;
+    /** Size of the team in the company associated with the lead, if applicable. */
+    teamSize?: string | null;
+    /** Preferred contact method. */
+    contactPreference?: ("EMAIL" | "PHONE") | null;
+    /** Timestamp when the lead was created. */
+    createdAt: string;
+    /** Timestamp when the lead was last updated, if applicable. */
+    updatedAt?: string | null;
+    /** Timestamp when the lead was deleted, if applicable. */
+    deletedAt?: string | null;
+};
+export type EnterpriseLeadRequest = {
+    /** Lead name */
+    name: string;
+    /** Lead email */
+    email: string;
+    /** Lead phone number */
+    phone: string;
+    /** Company name */
+    companyName: string;
+    /** Company industry */
+    companyIndustry: string;
+    /** Team size */
+    teamSize: string;
+    /** Contact reason */
+    reason: string;
+};
 export type CreateUserInvitationRequest = {
     /** User email */
     email: string;
@@ -1172,6 +1228,28 @@ export type CreateAccountOrderRequest = {
     /** Email list of the sales representatives responsible for this request. */
     salesRepresentatives: string[];
 };
+export type AccountTrialCreateRequest = {
+    /** The slug to use in URL as unique identifying part representing the account (https://developer.mozilla.org/en-US/docs/Glossary/Slug). Example: zup */
+    slug: string;
+    /** The full name of the person who is creating a trial account */
+    fullName: string;
+    /** The company name where the trial user is related */
+    companyName?: string;
+    /** The company amount of people where the trial user is related */
+    companySize?: string;
+    /** The position occupied in the company by the trial user */
+    companyPositionType?: "DEVELOPER" | "PROJECT_MANAGER" | "DESIGNER" | "DATA_ANALYST" | "PRODUCT_OWNER" | "SOFTWARE_ENGINEER" | "DEVOPS_SPECIALIST" | "QUALITY_ANALYST" | "SCRUM_MASTER" | "BUSINESS_AREA" | "INFORMATION_SECURITY" | "OTHER";
+    /** The custom position occupied in the company by the trial user */
+    otherPosition?: string;
+    /** The channel used for the trial user to reach Stackspot */
+    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;
+};
+export type AccountCollaboratorRequest = {
+    /** The API id of account requester */
+    accountApiId: string;
+};
 export type PageResponseAccountSsoGroupMappingResponse = {
     /** Current page content */
     items?: AccountSsoGroupMappingResponse[];
@@ -1266,16 +1344,6 @@ export type AccountSsoParserResponse = {
     /** SSO callback url */
     callbackUrl?: string;
 };
-export type AccountFreemiumCreateRequest = {
-    /** The account's name. Example: Zup IT Innovation */
-    name: string;
-    /** The slug to use in URL as unique identifying part representing the account (https://developer.mozilla.org/en-US/docs/Glossary/Slug). Example: zup */
-    slug: string;
-};
-export type AccountCollaboratorRequest = {
-    /** The API id of account requester */
-    accountApiId: string;
-};
 export type CreateAccountPartnerOrderRequest = {
     /** The account's name. Example: Zup IT Innovation */
     name: string;
@@ -1311,6 +1379,43 @@ export type UpdateServiceCredentialScopesRequest = {
     /** Service credential statements */
     scopes: string[];
 };
+export type ServiceCredentialRateLimitResponse = {
+    /** Service Credential ID */
+    serviceCredentialId?: string;
+    apiId?: string;
+    /** When was created */
+    createdAt?: string;
+    /** Who created */
+    createdBy?: string;
+    /** Who updated */
+    updatedBy?: string;
+    /** When was updated */
+    updatedAt?: string;
+    /** Limit of executions per minute */
+    scMaxPerMin: number;
+    /** Limit of executions per day */
+    scMaxPerDay: number;
+};
+export type PageResponseServiceCredentialRateLimitResponse = {
+    /** Current page content */
+    items?: ServiceCredentialRateLimitResponse[];
+    /** Total elements found */
+    totalElements: number;
+    /** Current page number */
+    page: number;
+    /** Length of current page items */
+    size: number;
+    /** Total pages found */
+    totalPages: number;
+};
+export type ServiceCredentialRateLimitRequest = {
+    /** Limit of executions per minute */
+    scMaxPerMin?: number;
+    /** Limit of executions per day */
+    scMaxPerDay?: number;
+    /** List of service credentials IDs */
+    serviceCredentialIds: string[];
+};
 export type DeleteMemberPermissionsRequest = {
     /** Permission Action */
     actionName: string;
@@ -1431,6 +1536,22 @@ export type AddNewEmailDomainRequest = {
     /** Email domains list that account users will use to login into StackSpot. Example: zup.com.br */
     domains: string[];
 };
+export type AccountTrialUpdateRequest = {
+    /** The full name of the person who is creating a trial account */
+    fullName?: string;
+    /** The company name where the trial user is related */
+    companyName?: string;
+    /** The company amount of people where the trial user is related */
+    companySize?: string;
+    /** The position occupied in the company by the trial user */
+    companyPositionType?: "DEVELOPER" | "PROJECT_MANAGER" | "DESIGNER" | "DATA_ANALYST" | "PRODUCT_OWNER" | "SOFTWARE_ENGINEER" | "DEVOPS_SPECIALIST" | "QUALITY_ANALYST" | "SCRUM_MASTER" | "BUSINESS_AREA" | "INFORMATION_SECURITY" | "OTHER";
+    /** The custom position occupied in the company by the trial user */
+    otherPosition?: string;
+    /** The channel used for the trial user to reach Stackspot */
+    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;
+};
 export type AccountSsoAttributesConfigResponse = {
     /** Id from SSO */
     id: string;
@@ -1814,6 +1935,42 @@ export type AccountSlugResponse = {
     /** Account slug */
     slug: string;
 };
+export type PersonalAccountDetailsResponse = {
+    /** Unique identifier of the personal account. */
+    id: number;
+    /** Unique identifier of the associated account. */
+    accountId: string;
+    /** Full name of the account owner. */
+    fullName: string;
+    /** Name of the company associated with the account. */
+    companyName?: string | null;
+    /** Size of the company associated with the account. */
+    companySize?: string | null;
+    /** Position of the account owner in the company. */
+    companyPosition?: ("DEVELOPER" | "PROJECT_MANAGER" | "DESIGNER" | "DATA_ANALYST" | "PRODUCT_OWNER" | "SOFTWARE_ENGINEER" | "DEVOPS_SPECIALIST" | "QUALITY_ANALYST" | "SCRUM_MASTER" | "BUSINESS_AREA" | "INFORMATION_SECURITY" | "OTHER") | null;
+    /** 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;
+    /** Custom description of how the account owner was reached, if not listed. */
+    customReachedBy?: string | null;
+    /** Date and time until the account is valid. */
+    validUntil: string;
+};
+export type PersonalAccountExpirationDataResponse = {
+    /** Account id */
+    accountId: string;
+    /** Account name */
+    name: string;
+    /** Account remaining trial days */
+    remainingTrialDays: number;
+    /** Date that trial Account will be blocked */
+    validUntil: string;
+};
+export type AccountDataAvailableResponse = {
+    /** Account data (name and slug) is available to be registered */
+    available: boolean;
+};
 export type AccountSsoResponse = {
     /** SSO configuration name */
     name: string;
@@ -1847,10 +2004,6 @@ export type PageResponseAccountSsoResponse = {
     /** Total pages found */
     totalPages: number;
 };
-export type AccountDataAvailableResponse = {
-    /** Account data (name and slug) is available to be registered */
-    available: boolean;
-};
 export type AccountPartnerResponse = {
     /** Account id */
     accountApiId: string;
@@ -2102,7 +2255,7 @@ export declare function createServiceCredential({ serviceCredentialCreateRequest
     serviceCredentialCreateRequestV2: ServiceCredentialCreateRequestV2;
 }, opts?: Oazapfts.RequestOpts): Promise<ServiceCredentialCreateResponseV2>;
 /**
- * Retrieves a list of service credentials with their associated owner information if available.
+ * Get Service Credentials
  */
 export declare function getServiceCredentials1({ name, status, page, size }: {
     name?: string;
@@ -2111,13 +2264,13 @@ export declare function getServiceCredentials1({ name, status, page, size }: {
     size?: string;
 }, opts?: Oazapfts.RequestOpts): Promise<ServiceCredentialResponse[]>;
 /**
- * Creates a new service credential for an account.
+ * Create Service Credential
  */
 export declare function createServiceCredential1({ serviceCredentialCreateRequest }: {
     serviceCredentialCreateRequest: ServiceCredentialCreateRequest;
 }, opts?: Oazapfts.RequestOpts): Promise<ServiceCredentialCreateResponse>;
 /**
- * Notifies the user about the expiration of the service credential via email.
+ * Notify about Service Credential expiration
  */
 export declare function notifyServiceCredentialExpiration({ serviceCredentialExpirationRequest }: {
     serviceCredentialExpirationRequest: ServiceCredentialExpirationNotifyRequest;
@@ -2323,13 +2476,13 @@ export declare function bindToGroups({ memberId, memberIdsCommonRequest }: {
     memberIdsCommonRequest: MemberIdsCommonRequest;
 }, opts?: Oazapfts.RequestOpts): Promise<unknown>;
 /**
- * Lists all favorite resources associated with a specific member.
+ * Get account member favorite resources
  */
 export declare function listAccountMemberFavorites({ memberId }: {
     memberId: string;
 }, opts?: Oazapfts.RequestOpts): Promise<FavoriteResourcesResponse[]>;
 /**
- * Adds a favorite resource to a member.
+ * Add account member favorite resource
  */
 export declare function addAccountMemberFavorite({ memberId, createFavoriteResourceRequest }: {
     memberId: string;
@@ -2347,6 +2500,18 @@ export declare function resetPassword({ memberEmailRequest }: {
 export declare function inviteMembers({ body }: {
     body: InviteNewMemberRequest[];
 }, opts?: Oazapfts.RequestOpts): Promise<InviteMembersResponse>;
+/**
+ * Create a personal lead contact
+ */
+export declare function personalContact({ personalLeadRequest }: {
+    personalLeadRequest: PersonalLeadRequest;
+}, opts?: Oazapfts.RequestOpts): Promise<LeadResponse>;
+/**
+ * Create an enterprise lead contact
+ */
+export declare function enterpriseContact({ enterpriseLeadRequest }: {
+    enterpriseLeadRequest: EnterpriseLeadRequest;
+}, opts?: Oazapfts.RequestOpts): Promise<LeadResponse>;
 /**
  * Lists user invitations for account
  */
@@ -2583,6 +2748,22 @@ export declare function getAccounts1({ size, page, sort, direction, search, filt
 export declare function create1({ createAccountOrderRequest }: {
     createAccountOrderRequest: CreateAccountOrderRequest;
 }, opts?: Oazapfts.RequestOpts): Promise<unknown>;
+/**
+ * Creates a Trial account.
+ */
+export declare function createTrialAccount({ accountTrialCreateRequest }: {
+    accountTrialCreateRequest: AccountTrialCreateRequest;
+}, opts?: Oazapfts.RequestOpts): Promise<unknown>;
+/**
+ * Sets trial account to be removed after expiration.
+ */
+export declare function removeTrialAccount(opts?: Oazapfts.RequestOpts): Promise<unknown>;
+/**
+ * Adds a collaborator to an account with a specified role.
+ */
+export declare function addCollaborator({ accountCollaboratorRequest }: {
+    accountCollaboratorRequest: AccountCollaboratorRequest;
+}, opts?: Oazapfts.RequestOpts): Promise<unknown>;
 /**
  * Retrieves a list of SSO group mappings.
  */
@@ -2624,18 +2805,6 @@ export declare function ssoParseConfigurationFile({ protocol, body }: {
         file: Blob;
     };
 }, opts?: Oazapfts.RequestOpts): Promise<AccountSsoParserResponse>;
-/**
- * Creates a freemium account.
- */
-export declare function createAccountFreemium({ accountFreemiumCreateRequest }: {
-    accountFreemiumCreateRequest: AccountFreemiumCreateRequest;
-}, opts?: Oazapfts.RequestOpts): Promise<unknown>;
-/**
- * Adds a collaborator to an account with a specified role.
- */
-export declare function addCollaborator({ accountCollaboratorRequest }: {
-    accountCollaboratorRequest: AccountCollaboratorRequest;
-}, opts?: Oazapfts.RequestOpts): Promise<unknown>;
 /**
  * Create an Account Order for Partner
  */
@@ -2668,6 +2837,27 @@ export declare function updateServiceCredentialScopes({ id, updateServiceCredent
 export declare function revokeServiceCredential({ id }: {
     id: string;
 }, opts?: Oazapfts.RequestOpts): Promise<unknown>;
+/**
+ * Rotates the secret of a service credential.
+ */
+export declare function getAllServiceCredentialRateLimit({ 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<PageResponseServiceCredentialRateLimitResponse>;
+/**
+ * Rotates the secret of a service credential.
+ */
+export declare function updateServiceCredentialRateLimit({ serviceCredentialRateLimitRequest }: {
+    serviceCredentialRateLimitRequest: ServiceCredentialRateLimitRequest;
+}, opts?: Oazapfts.RequestOpts): Promise<unknown>;
 /**
  * Delete a member permissions
  */
@@ -2704,7 +2894,7 @@ export declare function associateGroupToServiceCredential({ id, serviceCredentia
     serviceCredentialAssociateGroupRequest: ServiceCredentialAssociateGroupRequest;
 }, opts?: Oazapfts.RequestOpts): Promise<unknown>;
 /**
- * Revokes a service credential.
+ * Revoke Service Credential
  */
 export declare function revokeServiceCredential1({ id }: {
     id: string;
@@ -2866,6 +3056,13 @@ export declare function addNewEmailDomain({ accountId, addNewEmailDomainRequest
     accountId: string;
     addNewEmailDomainRequest: AddNewEmailDomainRequest;
 }, opts?: Oazapfts.RequestOpts): Promise<unknown>;
+/**
+ * Update personal account details
+ */
+export declare function updatePersonalAccountDetails({ accountId, accountTrialUpdateRequest }: {
+    accountId: string;
+    accountTrialUpdateRequest: AccountTrialUpdateRequest;
+}, opts?: Oazapfts.RequestOpts): Promise<unknown>;
 /**
  * Retrieves the SSO attributes configuration for a given SSO ID.
  */
@@ -2921,6 +3118,12 @@ export declare function updatePartnerAccountAdminData({ id, accountPartnerAdminD
 export declare function getServiceCredentialGroups({ id }: {
     id: string;
 }, opts?: Oazapfts.RequestOpts): Promise<PageResponseGroupReadResponse>;
+/**
+ * Rotates the secret of a service credential.
+ */
+export declare function getServiceCredentialByIdRateLimit({ clientId }: {
+    clientId: string;
+}, opts?: Oazapfts.RequestOpts): Promise<ServiceCredentialRateLimitResponse>;
 /**
  * Get Roles
  */
@@ -3196,7 +3399,7 @@ export declare function getAccountMembers1({ id, size, page, sort, direction, se
     filterIn?: any;
 }, opts?: Oazapfts.RequestOpts): Promise<AccountMemberResponse[]>;
 /**
- * Retrieves the service credential details for a given client ID.
+ * Get Service Credential by ID (Client ID)
  */
 export declare function getServiceCredential({ id }: {
     id: string;
@@ -3208,7 +3411,7 @@ export declare function getServiceCredentialPermissions({ id }: {
     id: string;
 }, opts?: Oazapfts.RequestOpts): Promise<FullResourceResponse[]>;
 /**
- * Retrieves a list of service credential groups associated with a specific client ID.
+ * List service credential groups
  */
 export declare function getServiceCredentialGroups1({ id }: {
     id: string;
@@ -3306,12 +3509,12 @@ export declare function getResources2({ memberId }: {
     memberId: string;
 }, opts?: Oazapfts.RequestOpts): Promise<ResourceDto[]>;
 /**
- * Lists the IDs of a member's favorite resources of a specified type.
+ * Get member favorite resources by type
  */
 export declare function listMemberFavoritesByResource({ memberId, resourceType }: {
     memberId: string;
     resourceType: string;
-}, opts?: Oazapfts.RequestOpts): Promise<string[]>;
+}, opts?: Oazapfts.RequestOpts): Promise<any>;
 /**
  * Retrieves a list of account members and collaborators associated with the current user's account.
  */
@@ -3371,6 +3574,21 @@ export declare function getAccountDataByEmail({ email }: {
 export declare function getAccountSlug({ accountId }: {
     accountId: string;
 }, opts?: Oazapfts.RequestOpts): Promise<AccountSlugResponse>;
+/**
+ * Finds and returns personal account details.
+ */
+export declare function getPersonalAccountDetails(opts?: Oazapfts.RequestOpts): Promise<PersonalAccountDetailsResponse>;
+/**
+ * Finds and returns personal account expiration data associated with the provided token.
+ */
+export declare function getPersonalAccountExpirationData(opts?: Oazapfts.RequestOpts): Promise<PersonalAccountExpirationDataResponse>;
+/**
+ * Determines whether account data is available for registration based on the provided name and slug.
+ */
+export declare function accountDataIsAvailable({ name, slug }: {
+    name: string;
+    slug: string;
+}, opts?: Oazapfts.RequestOpts): Promise<AccountDataAvailableResponse>;
 /**
  * Retrieves a list of SSO for the current account.
  */
@@ -3386,13 +3604,6 @@ export declare function getAllAccountSso({ size, page, sort, direction, search,
     multiFilterMode?: string;
     filterIn?: any;
 }, opts?: Oazapfts.RequestOpts): Promise<PageResponseAccountSsoResponse>;
-/**
- * Determines whether account data is available for registration based on the provided name and slug.
- */
-export declare function accountDataIsAvailable({ name, slug }: {
-    name: string;
-    slug: string;
-}, opts?: Oazapfts.RequestOpts): Promise<AccountDataAvailableResponse>;
 /**
  * Get Partners who are sharing content.
  */
@@ -3410,7 +3621,7 @@ export declare function getPartnersSharingAllowed({ name }: {
  */
 export declare function validatePartnerAssociationLimit(opts?: Oazapfts.RequestOpts): Promise<unknown>;
 /**
- * Disassociates a group from a service credential.
+ * Disassociate Group to Service Credential
  */
 export declare function disassociateGroupToServiceCredential({ id, groupId }: {
     id: string;
@@ -3436,7 +3647,7 @@ export declare function deleteProfileImage({ memberId }: {
     memberId: string;
 }, opts?: Oazapfts.RequestOpts): Promise<unknown>;
 /**
- * Removes a specified resource from a member favorites.
+ * Remove resource from member favorites
  */
 export declare function deleteMemberFavorite({ memberId, resourceType, resourceId }: {
     memberId: string;