diff --git a/schema.json b/schema.json index 5d2c79c..8aaeddb 100644 --- a/schema.json +++ b/schema.json @@ -274,8 +274,10 @@ "APPLE_STRINGS", "APPLE_XLIFF", "APPLE_XCSTRINGS", + "APPLE_SDK", "PROPERTIES_ICU", "PROPERTIES_JAVA", + "ANDROID_SDK", "ANDROID_XML", "COMPOSE_XML", "FLUTTER_ARB", diff --git a/src/client/internal/schema.generated.ts b/src/client/internal/schema.generated.ts index 8524e15..2042238 100644 --- a/src/client/internal/schema.generated.ts +++ b/src/client/internal/schema.generated.ts @@ -34,6 +34,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Generate authentication url (third-party, SSO) + * @description Returns URL which can be used to authenticate user using third party SSO service + */ post: operations["getAuthenticationUrl"]; delete?: never; options?: never; @@ -405,10 +409,10 @@ export interface paths { get: operations["allByUser"]; put?: never; /** - * Crete API key + * Create API key * @description Creates new API key with provided scopes */ - post: operations["create_13"]; + post: operations["create_15"]; delete?: never; options?: never; head?: never; @@ -452,6 +456,26 @@ export interface paths { patch?: never; trace?: never; }; + "/v2/api-keys/current-permissions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get current permission info + * @description Returns current PAK or PAT permissions for current user, api-key and project + */ + get: operations["getCurrentPermissions"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v2/api-keys/{apiKeyId}": { parameters: { query?: never; @@ -461,10 +485,10 @@ export interface paths { }; get?: never; /** Update API key */ - put: operations["update_9"]; + put: operations["update_11"]; post?: never; /** Delete API key */ - delete: operations["delete_13"]; + delete: operations["delete_15"]; options?: never; head?: never; patch?: never; @@ -498,7 +522,7 @@ export interface paths { * Get one API key * @description Returns specific API key info */ - get: operations["get_21"]; + get: operations["get_24"]; put?: never; post?: never; delete?: never; @@ -507,66 +531,52 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/auth-provider/changed": { + "/v2/auth-provider": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** Get info about authentication provider which can replace the current one */ - get: operations["getChangedAuthProvider"]; + /** Get current third party authentication provider */ + get: operations["getCurrentAuthProvider"]; put?: never; post?: never; - delete?: never; + /** Initiate provider change to remove current third party authentication provider */ + delete: operations["deleteCurrentAuthProvider"]; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/auth-provider/changed/accept": { + "/v2/auth-provider/change": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - get?: never; + /** Get info about authentication provider which can replace the current one */ + get: operations["getChangedAuthProvider"]; put?: never; /** Accept change of the third party authentication provider */ post: operations["acceptChangeAuthProvider"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/v2/auth-provider/changed/reject": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get?: never; - put?: never; /** Reject change of the third party authentication provider */ - post: operations["rejectChangeAuthProvider"]; - delete?: never; + delete: operations["rejectChangeAuthProvider"]; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/auth-provider/current": { + "/v2/ee-current-subscription-usage": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** Get current third party authentication provider */ - get: operations["getCurrentAuthProvider"]; + /** Get current usage for the current EE subscription */ + get: operations["getUsage_1"]; put?: never; post?: never; delete?: never; @@ -697,7 +707,7 @@ export interface paths { put?: never; post?: never; /** Delete uploaded images */ - delete: operations["delete_12"]; + delete: operations["delete_14"]; options?: never; head?: never; patch?: never; @@ -737,6 +747,64 @@ export interface paths { patch?: never; trace?: never; }; + "/v2/notification": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** Gets notifications of the currently logged in user, newest is first. */ + get: operations["getNotifications"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/notification-settings": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get notification settings + * @description Returns notification settings of the currently logged in user + */ + get: operations["getNotificationsSettings"]; + /** + * Save notification setting + * @description Saves new value for given parameters + */ + put: operations["putNotificationSetting"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/notifications-mark-seen": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** Marks notifications of the currently logged in user with given IDs as seen. */ + put: operations["markNotificationsAsSeen"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v2/organizations": { parameters: { query?: never; @@ -748,7 +816,7 @@ export interface paths { * Get all permitted organizations * @description Returns all organizations, which is current user allowed to view */ - get: operations["getAll_10"]; + get: operations["getAll_12"]; put?: never; /** Create organization */ post: operations["create_12"]; @@ -766,15 +834,15 @@ export interface paths { cookie?: never; }; /** Get one organization */ - get: operations["get_20"]; + get: operations["get_23"]; /** Update organization data */ - put: operations["update_8"]; + put: operations["update_10"]; post?: never; /** * Delete organization * @description Deletes organization and all its data including projects */ - delete: operations["delete_11"]; + delete: operations["delete_13"]; options?: never; head?: never; patch?: never; @@ -878,15 +946,18 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/organizations/{organizationId}/invitations": { + "/v2/organizations/{organizationId}/base-languages": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** Get all invitations to organization */ - get: operations["getInvitations"]; + /** + * Get all base languages in use by projects owned by specified organization + * @description Returns all base languages in use by projects owned by specified organization + */ + get: operations["getAllBaseLanguagesInUse"]; put?: never; post?: never; delete?: never; @@ -895,38 +966,33 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/organizations/{organizationId}/machine-translation-credit-balance": { + "/v2/organizations/{organizationId}/glossaries": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** - * Get credit balance for organization - * @description Returns machine translation credit balance for organization - */ - get: operations["getOrganizationCredits"]; + /** Get all organization glossaries */ + get: operations["getAll_14"]; put?: never; - post?: never; + /** Create glossary */ + post: operations["create_13"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/organizations/{organizationId}/projects-with-stats": { + "/v2/organizations/{organizationId}/glossaries-with-stats": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** - * Get all projects with stats - * @description Returns all projects (including statistics) where current user has any permission (except none) - */ - get: operations["getAllWithStatistics_2"]; + /** Get all organization glossaries with some additional statistics */ + get: operations["getAllWithStats"]; put?: never; post?: never; delete?: never; @@ -935,39 +1001,35 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/organizations/{organizationId}/set-base-permissions": { + "/v2/organizations/{organizationId}/glossaries/{glossaryId}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - get?: never; - /** - * Set organization base permission - * @description Set default granular (scope-based) permissions for organization users, who don't have direct project permissions set. - */ - put: operations["setBasePermissions"]; + /** Get glossary */ + get: operations["get_20"]; + /** Update glossary */ + put: operations["update_8"]; post?: never; - delete?: never; + /** Delete glossary */ + delete: operations["delete_11"]; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/organizations/{organizationId}/set-base-permissions/{permissionType}": { + "/v2/organizations/{organizationId}/glossaries/{glossaryId}/assigned-projects": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - get?: never; - /** - * Set organization base permission - * @description Sets default (level-based) permission for organization - */ - put: operations["setBasePermissions_1"]; + /** Get all projects assigned to glossary */ + get: operations["getAssignedProjects"]; + put?: never; post?: never; delete?: never; options?: never; @@ -975,68 +1037,62 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/organizations/{organizationId}/slack/connect": { + "/v2/organizations/{organizationId}/glossaries/{glossaryId}/languages": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - get?: never; + /** Get all languages in use by the glossary */ + get: operations["getLanguages"]; put?: never; - /** - * Connect Slack workspace to organization - * @description This endpoint allows the owner of an organization to connect a Slack workspace to their organization. - * Checks if the Slack integration feature is enabled for the organization and proceeds with the connection. - */ - post: operations["connectWorkspace"]; + post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/organizations/{organizationId}/slack/get-connect-url": { + "/v2/organizations/{organizationId}/glossaries/{glossaryId}/terms": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** - * Get connect URL for Slack authentication - * @description Returns URL to which user should be redirected to connect Slack workspace - */ - get: operations["connectToSlack"]; + /** Get all glossary terms */ + get: operations["getAll_15"]; put?: never; - post?: never; - delete?: never; + /** Create a new glossary term */ + post: operations["create_14"]; + /** Batch delete multiple terms */ + delete: operations["deleteMultiple"]; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/organizations/{organizationId}/slack/workspaces": { + "/v2/organizations/{organizationId}/glossaries/{glossaryId}/terms/{termId}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** - * Get connected workspaces - * @description Returns a list of workspaces connected to the organization - */ - get: operations["getConnectedWorkspaces"]; - put?: never; + /** Get glossary term */ + get: operations["get_21"]; + /** Update glossary term */ + put: operations["update_9"]; post?: never; - delete?: never; + /** Delete glossary term */ + delete: operations["delete_12"]; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/organizations/{organizationId}/slack/workspaces/{workspaceId}": { + "/v2/organizations/{organizationId}/glossaries/{glossaryId}/terms/{termId}/translations": { parameters: { query?: never; header?: never; @@ -1045,26 +1101,24 @@ export interface paths { }; get?: never; put?: never; - post?: never; - /** - * Disconnect workspace - * @description Disconnects a workspace from the organization - */ - delete: operations["disconnectWorkspace"]; + /** Set a new glossary term translation for language */ + post: operations["update_12"]; + delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/organizations/{organizationId}/sso": { + "/v2/organizations/{organizationId}/glossaries/{glossaryId}/terms/{termId}/translations/{languageTag}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - get: operations["findProvider"]; - put: operations["setProvider"]; + /** Get glossary term translation for language */ + get: operations["get_22"]; + put?: never; post?: never; delete?: never; options?: never; @@ -1072,15 +1126,15 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/organizations/{organizationId}/usage": { + "/v2/organizations/{organizationId}/glossaries/{glossaryId}/termsIds": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** Get current organization usage */ - get: operations["getUsage"]; + /** Get all glossary terms ids */ + get: operations["getAllIds"]; put?: never; post?: never; delete?: never; @@ -1089,36 +1143,33 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/organizations/{organizationId}/users/{userId}": { + "/v2/organizations/{organizationId}/glossaries/{glossaryId}/termsWithTranslations": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - get?: never; + /** Get all glossary terms with translations */ + get: operations["getAllWithTranslations"]; put?: never; post?: never; - /** Remove user from organization */ - delete: operations["removeUser"]; + delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/organizations/{organizationId}/users/{userId}/set-role": { + "/v2/organizations/{organizationId}/invitations": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - get?: never; - /** - * Set user role - * @description Sets user role in organization. Owner or Member. - */ - put: operations["setUserRole"]; + /** Get all invitations to organization */ + get: operations["getInvitations"]; + put?: never; post?: never; delete?: never; options?: never; @@ -1126,15 +1177,18 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/organizations/{slug}": { + "/v2/organizations/{organizationId}/languages": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** Get organization by slug */ - get: operations["get_19"]; + /** + * Get all languages in use by projects owned by specified organization + * @description Returns all languages in use by projects owned by specified organization + */ + get: operations["getAllLanguagesInUse"]; put?: never; post?: never; delete?: never; @@ -1143,38 +1197,30 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/organizations/{slug}/projects": { + "/v2/organizations/{organizationId}/llm-providers": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** - * Get all accessible projects (by slug) - * @description Returns all organization projects the user has access to - */ - get: operations["getAllProjects"]; + get: operations["getAll_13"]; put?: never; - post?: never; + post: operations["createProvider"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/organizations/{slug}/projects-with-stats": { + "/v2/organizations/{organizationId}/llm-providers/all-available": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** - * Get all projects with stats - * @description Returns all projects (including statistics) where current user has any permission (except none) - */ - get: operations["getAllWithStatistics_1"]; + get: operations["getAvailableProviders"]; put?: never; post?: never; delete?: never; @@ -1183,82 +1229,71 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/pats": { + "/v2/organizations/{organizationId}/llm-providers/server-providers": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** Get PAKs */ - get: operations["getAll_9"]; + get: operations["getServerProviders"]; put?: never; - /** Create PAK */ - post: operations["create_11"]; + post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/pats/current": { + "/v2/organizations/{organizationId}/llm-providers/{providerId}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** - * Return current PAK - * @description Returns current Personal Access Token. If the request is not authenticated with a Personal Access Token, it will return 400 response status. - */ - get: operations["getCurrent"]; - put?: never; + get?: never; + put: operations["updateProvider"]; post?: never; - delete?: never; + delete: operations["deleteProvider"]; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/pats/{id}": { + "/v2/organizations/{organizationId}/machine-translation-credit-balance": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** Get one PAK */ - get: operations["get_18"]; /** - * Update PAK - * @description Updates Personal Access Token + * Get credit balance for organization + * @description Returns machine translation credit balance for organization */ - put: operations["update_7"]; + get: operations["getOrganizationCredits"]; + put?: never; post?: never; - /** - * Delete PAK - * @description Deletes Personal Access Token - */ - delete: operations["delete_10"]; + delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/pats/{id}/regenerate": { + "/v2/organizations/{organizationId}/projects-with-stats": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - get?: never; /** - * Regenerate PAK - * @description Regenerates Personal Access Token. It generates new token value and updates its time of expiration. + * Get all projects with stats + * @description Returns all projects (including statistics) where current user has any permission (except none) */ - put: operations["regenerate"]; + get: operations["getAllWithStatistics_2"]; + put?: never; post?: never; delete?: never; options?: never; @@ -1266,16 +1301,19 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/preferred-organization": { + "/v2/organizations/{organizationId}/set-base-permissions": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** @description Returns preferred organization. If server allows users to create organization, preferred organization is automatically created if user doesn't have access to any organization. */ - get: operations["getPreferred"]; - put?: never; + get?: never; + /** + * Set organization base permission + * @description Set default granular (scope-based) permissions for organization users, who don't have direct project permissions set. + */ + put: operations["setBasePermissions"]; post?: never; delete?: never; options?: never; @@ -1283,78 +1321,79 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/projects": { + "/v2/organizations/{organizationId}/set-base-permissions/{permissionType}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; + get?: never; /** - * Get all permitted - * @description Returns all projects where current user has any permission - */ - get: operations["getAll"]; - put?: never; - /** - * Create project - * @description Creates a new project with languages and initial settings. + * Set organization base permission + * @description Sets default (level-based) permission for organization */ - post: operations["createProject"]; + put: operations["setBasePermissions_1"]; + post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/with-stats": { + "/v2/organizations/{organizationId}/slack/connect": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; + get?: never; + put?: never; /** - * Get all with stats - * @description Returns all projects (including statistics) where current user has any permission + * Connect Slack workspace to organization + * @description This endpoint allows the owner of an organization to connect a Slack workspace to their organization. + * Checks if the Slack integration feature is enabled for the organization and proceeds with the connection. */ - get: operations["getAllWithStatistics"]; - put?: never; - post?: never; + post: operations["connectWorkspace"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}": { + "/v2/organizations/{organizationId}/slack/get-connect-url": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** Get one project */ - get: operations["get_4"]; - /** Update project settings */ - put: operations["editProject"]; + /** + * Get connect URL for Slack authentication + * @description Returns URL to which user should be redirected to connect Slack workspace + */ + get: operations["connectToSlack"]; + put?: never; post?: never; - /** Delete project */ - delete: operations["deleteProject"]; + delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/activity": { + "/v2/organizations/{organizationId}/slack/workspaces": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** Get project activity */ - get: operations["getActivity"]; + /** + * Get connected workspaces + * @description Returns a list of workspaces connected to the organization + */ + get: operations["getConnectedWorkspaces"]; put?: never; post?: never; delete?: never; @@ -1363,33 +1402,37 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/projects/{projectId}/activity/revisions/{revisionId}": { + "/v2/organizations/{organizationId}/slack/workspaces/{workspaceId}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** Get one revision data */ - get: operations["getSingleRevision"]; + get?: never; put?: never; post?: never; - delete?: never; + /** + * Disconnect workspace + * @description Disconnects a workspace from the organization + */ + delete: operations["disconnectWorkspace"]; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/activity/revisions/{revisionId}/modified-entities": { + "/v2/organizations/{organizationId}/sso": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** Get modified entities in revision */ - get: operations["getModifiedEntitiesByRevision"]; - put?: never; + /** Get SSO Tenant configuration for organization */ + get: operations["findProvider"]; + /** Set SSO Tenant configuration for organization */ + put: operations["setProvider"]; post?: never; delete?: never; options?: never; @@ -1397,17 +1440,16 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/projects/{projectId}/ai-prompt-customization": { + "/v2/organizations/{organizationId}/usage": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** Returns project level prompt customization */ - get: operations["getPromptProjectCustomization"]; - /** Sets project level prompt customization */ - put: operations["setPromptProjectCustomization"]; + /** Get current organization usage */ + get: operations["getUsage"]; + put?: never; post?: never; delete?: never; options?: never; @@ -1415,38 +1457,36 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/projects/{projectId}/all-keys": { + "/v2/organizations/{organizationId}/users/{userId}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** Get all keys in project */ - get: operations["getAllKeys"]; + get?: never; put?: never; post?: never; - delete?: never; + /** Remove user from organization */ + delete: operations["removeUser"]; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/all-keys-with-disabled-languages": { + "/v2/organizations/{organizationId}/users/{userId}/set-role": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; + get?: never; /** - * Get disabled languages for all keys in project - * @description Returns all project key with any disabled language. - * - * If key has no disabled language, it is not returned. + * Set user role + * @description Sets user role in organization. Owner or Member. */ - get: operations["getDisabledLanguages_2"]; - put?: never; + put: operations["setUserRole"]; post?: never; delete?: never; options?: never; @@ -1454,18 +1494,15 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/projects/{projectId}/api-keys": { + "/v2/organizations/{slug}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** - * Get all project API keys - * @description Returns all API keys for specified project - */ - get: operations["allByProject"]; + /** Get organization by slug */ + get: operations["get_19"]; put?: never; post?: never; delete?: never; @@ -1474,7 +1511,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/projects/{projectId}/auto-translation-settings": { + "/v2/organizations/{slug}/projects": { parameters: { query?: never; header?: never; @@ -1482,17 +1519,11 @@ export interface paths { cookie?: never; }; /** - * Get default auto-translation settings for project - * @deprecated - * @description Returns default auto translation settings for project (deprecated: use per language config with null language id) - */ - get: operations["getAutoTranslationSettings"]; - /** - * Set default auto translation settings for project - * @deprecated - * @description Sets default auto-translation settings for project (deprecated: use per language config with null language id) + * Get all accessible projects (by slug) + * @description Returns all organization projects the user has access to */ - put: operations["setAutoTranslationSettings"]; + get: operations["getAllProjects"]; + put?: never; post?: never; delete?: never; options?: never; @@ -1500,50 +1531,56 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/projects/{projectId}/avatar": { + "/v2/organizations/{slug}/projects-with-stats": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - get?: never; - /** Upload project avatar */ - put: operations["uploadAvatar_1"]; + /** + * Get all projects with stats + * @description Returns all projects (including statistics) where current user has any permission (except none) + */ + get: operations["getAllWithStatistics_1"]; + put?: never; post?: never; - /** Delete project avatar */ - delete: operations["removeAvatar_1"]; + delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/batch-jobs": { + "/v2/pats": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** List batch operations */ - get: operations["list_3"]; + /** Get PAKs */ + get: operations["getAll_11"]; put?: never; - post?: never; + /** Create PAK */ + post: operations["create_11"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/batch-jobs/{id}": { + "/v2/pats/current": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** Get batch operation */ - get: operations["get_12"]; + /** + * Return current PAK + * @description Returns current Personal Access Token. If the request is not authenticated with a Personal Access Token, it will return 400 response status. + */ + get: operations["getCurrent"]; put?: never; post?: never; delete?: never; @@ -1552,27 +1589,32 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/projects/{projectId}/batch-jobs/{id}/cancel": { + "/v2/pats/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - get?: never; + /** Get one PAK */ + get: operations["get_18"]; /** - * Stop batch operation - * @description Stops batch operation if possible. + * Update PAK + * @description Updates Personal Access Token */ - put: operations["cancel"]; + put: operations["update_7"]; post?: never; - delete?: never; + /** + * Delete PAK + * @description Deletes Personal Access Token + */ + delete: operations["delete_10"]; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/big-meta": { + "/v2/pats/{id}/regenerate": { parameters: { query?: never; header?: never; @@ -1580,145 +1622,141 @@ export interface paths { cookie?: never; }; get?: never; - put?: never; /** - * Store Big Meta - * @description Stores a bigMeta for a project + * Regenerate PAK + * @description Regenerates Personal Access Token. It generates new token value and updates its time of expiration. */ - post: operations["store_2"]; + put: operations["regenerate"]; + post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/content-delivery-configs": { + "/v2/preferred-organization": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** List existing Content Delivery Configs */ - get: operations["list_2"]; + /** @description Returns preferred organization. If server allows users to create organization, preferred organization is automatically created if user doesn't have access to any organization. */ + get: operations["getPreferred"]; put?: never; - /** Create Content Delivery Config */ - post: operations["create_6"]; + post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/content-delivery-configs/{id}": { + "/v2/projects": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** Get one Content Delivery Config */ - get: operations["get_9"]; - /** Update Content Delivery Config */ - put: operations["update_4"]; /** - * Publish to Content Delivery - * @description Immediately publishes content to the configured Content Delivery + * Get all permitted + * @description Returns all projects where current user has any permission */ - post: operations["post"]; - /** Delete Content Delivery Config */ - delete: operations["delete_7"]; + get: operations["getAll"]; + put?: never; + /** + * Create project + * @description Creates a new project with languages and initial settings. + */ + post: operations["createProject"]; + delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/content-storages": { + "/v2/projects/with-stats": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** List Content Storages */ - get: operations["list_1"]; + /** + * Get all with stats + * @description Returns all projects (including statistics) where current user has any permission + */ + get: operations["getAllWithStatistics"]; put?: never; - /** Create Content Storage */ - post: operations["create_5"]; + post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/content-storages/test": { + "/v2/projects/{projectId}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - get?: never; - put?: never; - /** Test Content Storage settings */ - post: operations["test_1"]; - delete?: never; + /** Get one project */ + get: operations["get_8"]; + /** Update project settings */ + put: operations["editProject"]; + post?: never; + /** Delete project */ + delete: operations["deleteProject"]; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/content-storages/{contentStorageId}": { + "/v2/projects/{projectId}/activity": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** Get Content Storage */ - get: operations["get_8"]; - /** Update Content Storage */ - put: operations["update_3"]; + /** Get project activity */ + get: operations["getActivity"]; + put?: never; post?: never; - /** Delete Content Storage */ - delete: operations["delete_6"]; + delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/content-storages/{id}/test": { + "/v2/projects/{projectId}/activity/revisions/{revisionId}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - get?: never; + /** Get one revision data */ + get: operations["getSingleRevision"]; put?: never; - /** - * Test existing Content Storage - * @description Tests existing Content Storage with new configuration. (Uses existing secrets, if nulls provided) - */ - post: operations["testExisting"]; + post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/current-batch-jobs": { + "/v2/projects/{projectId}/activity/revisions/{revisionId}/modified-entities": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** - * Get all running and pending batch operations - * @description Returns all running and pending batch operations. Completed batch operations are returned only if they are not older than 1 hour. If user doesn't have permission to view all batch operations, only their operations are returned. - */ - get: operations["currentJobs"]; + /** Get modified entities in revision */ + get: operations["getModifiedEntitiesByRevision"]; put?: never; post?: never; delete?: never; @@ -1727,68 +1765,50 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/projects/{projectId}/export": { + "/v2/projects/{projectId}/ai-playground-result": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** Export data */ - get: operations["exportData"]; + get?: never; put?: never; - /** - * Export data (post) - * @description Exports data (post). Useful when exceeding allowed URL size. - */ - post: operations["exportPost"]; + post: operations["getAiPlaygroundResult"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/import": { + "/v2/projects/{projectId}/ai-prompt-customization": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - get?: never; - put?: never; - /** - * Add files - * @description Prepares provided files to import. - */ - post: operations["addFiles"]; - /** - * Delete - * @description Deletes prepared import data. - */ - delete: operations["cancelImport"]; + /** Returns project level prompt customization */ + get: operations["getPromptProjectCustomization"]; + /** Sets project level prompt customization */ + put: operations["setPromptProjectCustomization"]; + post?: never; + delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/import-settings": { + "/v2/projects/{projectId}/all-keys": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** - * Get Import Settings - * @description Returns import settings for the authenticated user and the project. - */ - get: operations["get_10"]; - /** - * Set Import Settings - * @description Stores import settings for the authenticated user and the project. - */ - put: operations["store"]; + /** Get all keys in project */ + get: operations["getAllKeys"]; + put?: never; post?: never; delete?: never; options?: never; @@ -1796,7 +1816,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/projects/{projectId}/import/all-namespaces": { + "/v2/projects/{projectId}/all-keys-with-disabled-languages": { parameters: { query?: never; header?: never; @@ -1804,10 +1824,12 @@ export interface paths { cookie?: never; }; /** - * Get namespaces - * @description Returns all existing and imported namespaces + * Get disabled languages for all keys in project + * @description Returns all project key with any disabled language. + * + * If key has no disabled language, it is not returned. */ - get: operations["getAllNamespaces_2"]; + get: operations["getDisabledLanguages_2"]; put?: never; post?: never; delete?: never; @@ -1816,19 +1838,19 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/projects/{projectId}/import/apply": { + "/v2/projects/{projectId}/api-keys": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - get?: never; /** - * Apply import - * @description Imports the data prepared in previous step + * Get all project API keys + * @description Returns all API keys for specified project */ - put: operations["applyImport"]; + get: operations["allByProject"]; + put?: never; post?: never; delete?: never; options?: never; @@ -1836,19 +1858,25 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/projects/{projectId}/import/apply-streaming": { + "/v2/projects/{projectId}/auto-translation-settings": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - get?: never; /** - * Apply import (streaming) - * @description Imports the data prepared in previous step. Streams current status. + * Get default auto-translation settings for project + * @deprecated + * @description Returns default auto translation settings for project (deprecated: use per language config with null language id) */ - put: operations["applyImportStreaming"]; + get: operations["getAutoTranslationSettings"]; + /** + * Set default auto translation settings for project + * @deprecated + * @description Sets default auto-translation settings for project (deprecated: use per language config with null language id) + */ + put: operations["setAutoTranslationSettings"]; post?: never; delete?: never; options?: never; @@ -1856,39 +1884,34 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/projects/{projectId}/import/result": { + "/v2/projects/{projectId}/avatar": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** - * Get result - * @description Returns the result of preparation. - */ - get: operations["getImportResult"]; - put?: never; + get?: never; + /** Upload project avatar */ + put: operations["uploadAvatar_1"]; post?: never; - delete?: never; + /** Delete project avatar */ + delete: operations["removeAvatar_1"]; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/import/result/files/{fileId}/select-namespace": { + "/v2/projects/{projectId}/batch-jobs": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - get?: never; - /** - * Select namespace - * @description Sets namespace for file to import. - */ - put: operations["selectNamespace"]; + /** List batch operations */ + get: operations["list"]; + put?: never; post?: never; delete?: never; options?: never; @@ -1896,18 +1919,15 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/projects/{projectId}/import/result/files/{importFileId}/issues": { + "/v2/projects/{projectId}/batch-jobs/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** - * Get file issues - * @description Returns issues for uploaded file. - */ - get: operations["getImportFileIssues"]; + /** Get batch operation */ + get: operations["get_6"]; put?: never; post?: never; delete?: never; @@ -1916,7 +1936,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/projects/{projectId}/import/result/languages/{importLanguageId}/reset-existing": { + "/v2/projects/{projectId}/batch-jobs/{id}/cancel": { parameters: { query?: never; header?: never; @@ -1925,10 +1945,10 @@ export interface paths { }; get?: never; /** - * Reset existing language pairing - * @description Resets existing language paired with language to import. + * Stop batch operation + * @description Stops batch operation if possible. */ - put: operations["resetExistingLanguage"]; + put: operations["cancel"]; post?: never; delete?: never; options?: never; @@ -1936,7 +1956,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/projects/{projectId}/import/result/languages/{importLanguageId}/select-existing/{existingLanguageId}": { + "/v2/projects/{projectId}/big-meta": { parameters: { query?: never; header?: never; @@ -1944,123 +1964,114 @@ export interface paths { cookie?: never; }; get?: never; + put?: never; /** - * Pair existing language - * @description Sets existing language to pair with language to import. Data will be imported to selected existing language when applied. + * Store Big Meta + * @description Stores a bigMeta for a project */ - put: operations["selectExistingLanguage"]; - post?: never; + post: operations["store_2"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/import/result/languages/{languageId}": { + "/v2/projects/{projectId}/content-delivery-configs": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** - * Get import language - * @description Returns language prepared to import. - */ - get: operations["getImportLanguage"]; + /** List existing Content Delivery Configs */ + get: operations["list_4"]; put?: never; - post?: never; - /** - * Delete language - * @description Deletes language prepared to import. - */ - delete: operations["deleteLanguage"]; + /** Create Content Delivery Config */ + post: operations["create_10"]; + delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/import/result/languages/{languageId}/resolve-all/set-keep-existing": { + "/v2/projects/{projectId}/content-delivery-configs/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - get?: never; + /** Get one Content Delivery Config */ + get: operations["get_17"]; + /** Update Content Delivery Config */ + put: operations["update_6"]; /** - * Resolve all translation conflicts (keep existing) - * @description Resolves all translation conflicts for provided language. The old translations will be kept. + * Publish to Content Delivery + * @description Immediately publishes content to the configured Content Delivery */ - put: operations["resolveTranslationSetKeepExisting_2"]; - post?: never; - delete?: never; + post: operations["post"]; + /** Delete Content Delivery Config */ + delete: operations["delete_9"]; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/import/result/languages/{languageId}/resolve-all/set-override": { + "/v2/projects/{projectId}/content-storages": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - get?: never; - /** - * Resolve all translation conflicts (override) - * @description Resolves all translation conflicts for provided language. The old translations will be overridden. - */ - put: operations["resolveTranslationSetOverride_2"]; - post?: never; + /** List Content Storages */ + get: operations["list_3"]; + put?: never; + /** Create Content Storage */ + post: operations["create_9"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/import/result/languages/{languageId}/translations": { + "/v2/projects/{projectId}/content-storages/test": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** - * Get translations - * @description Returns translations prepared to import. - */ - get: operations["getImportTranslations"]; + get?: never; put?: never; - post?: never; + /** Test Content Storage settings */ + post: operations["test_1"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/import/result/languages/{languageId}/translations/{translationId}/resolve/set-keep-existing": { + "/v2/projects/{projectId}/content-storages/{contentStorageId}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - get?: never; - /** - * Resolve conflict (keep existing) - * @description Resolves translation conflict. The old translation will be kept. - */ - put: operations["resolveTranslationSetKeepExisting"]; + /** Get Content Storage */ + get: operations["get_16"]; + /** Update Content Storage */ + put: operations["update_5"]; post?: never; - delete?: never; + /** Delete Content Storage */ + delete: operations["delete_8"]; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/import/result/languages/{languageId}/translations/{translationId}/resolve/set-override": { + "/v2/projects/{projectId}/content-storages/{id}/test": { parameters: { query?: never; header?: never; @@ -2068,27 +2079,30 @@ export interface paths { cookie?: never; }; get?: never; + put?: never; /** - * Resolve conflict (override) - * @description Resolves translation conflict. The old translation will be overridden. + * Test existing Content Storage + * @description Tests existing Content Storage with new configuration. (Uses existing secrets, if nulls provided) */ - put: operations["resolveTranslationSetOverride"]; - post?: never; + post: operations["testExisting"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/invitations": { + "/v2/projects/{projectId}/current-batch-jobs": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** Get project invitations */ - get: operations["getProjectInvitations"]; + /** + * Get all running and pending batch operations + * @description Returns all running and pending batch operations. Completed batch operations are returned only if they are not older than 1 hour. If user doesn't have permission to view all batch operations, only their operations are returned. + */ + get: operations["currentJobs"]; put?: never; post?: never; delete?: never; @@ -2097,46 +2111,45 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/projects/{projectId}/invite": { + "/v2/projects/{projectId}/export": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - get?: never; - /** Generate user invitation link for project */ - put: operations["inviteUser"]; - post?: never; + /** Export data */ + get: operations["exportData"]; + put?: never; + /** + * Export data (post) + * @description Exports data (post). Useful when exceeding allowed URL size. + */ + post: operations["exportPost"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/keys": { + "/v2/projects/{projectId}/glossary-highlights": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** Get all keys */ - get: operations["getAll_1"]; + get?: never; put?: never; - /** Create new key */ - post: operations["create_2"]; - /** - * Delete one or multiple keys (post) - * @description Delete one or multiple keys by their IDs in request body. Useful for larger requests esxceeding allowed URL length. - */ - delete: operations["delete_4"]; + /** Returns glossary term highlights for specified text */ + post: operations["getHighlights"]; + delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/keys/create": { + "/v2/projects/{projectId}/import": { parameters: { query?: never; header?: never; @@ -2145,55 +2158,66 @@ export interface paths { }; get?: never; put?: never; - /** Create new key */ - post: operations["create_1"]; - delete?: never; + /** + * Add files + * @description Prepares provided files to import. + */ + post: operations["addFiles"]; + /** + * Delete + * @description Deletes prepared import data. + */ + delete: operations["cancelImport"]; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/keys/import": { + "/v2/projects/{projectId}/import-settings": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - get?: never; - put?: never; /** - * Import keys - * @description Imports new keys with translations. If key already exists, its translations and tags are not updated. + * Get Import Settings + * @description Returns import settings for the authenticated user and the project. */ - post: operations["importKeys_2"]; + get: operations["get_4"]; + /** + * Set Import Settings + * @description Stores import settings for the authenticated user and the project. + */ + put: operations["store"]; + post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/keys/import-resolvable": { + "/v2/projects/{projectId}/import/all-namespaces": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - get?: never; - put?: never; /** - * Import keys (resolvable) - * @description Import's new keys with translations. Translations can be updated, when specified. + * Get namespaces + * @description Returns all existing and imported namespaces */ - post: operations["importKeys"]; + get: operations["getAllNamespaces"]; + put?: never; + post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/keys/info": { + "/v2/projects/{projectId}/import/apply": { parameters: { query?: never; header?: never; @@ -2201,33 +2225,31 @@ export interface paths { cookie?: never; }; get?: never; - put?: never; /** - * Get key info - * @description Returns information about keys. (KeyData, Screenshots, Translation in specified language)If key is not found, it's not included in the response. + * Apply import + * @description Imports the data prepared in previous step */ - post: operations["getInfo"]; + put: operations["applyImport"]; + post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/keys/search": { + "/v2/projects/{projectId}/import/apply-streaming": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; + get?: never; /** - * Search for keys - * @description This endpoint helps you to find desired key by keyName, base translation or translation in specified language. - * - * Sort is ignored for this request. + * Apply import (streaming) + * @description Imports the data prepared in previous step. Streams current status. */ - get: operations["searchForKey"]; - put?: never; + put: operations["applyImportStreaming"]; post?: never; delete?: never; options?: never; @@ -2235,7 +2257,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/projects/{projectId}/keys/select": { + "/v2/projects/{projectId}/import/result": { parameters: { query?: never; header?: never; @@ -2243,10 +2265,10 @@ export interface paths { cookie?: never; }; /** - * Select keys - * @description Returns all key IDs for specified filter values. This way, you can apply the same filter as in the translation view and get the resulting key IDs for future use. + * Get result + * @description Returns the result of preparation. */ - get: operations["selectKeys_2"]; + get: operations["getImportResult"]; put?: never; post?: never; delete?: never; @@ -2255,7 +2277,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/projects/{projectId}/keys/{ids}": { + "/v2/projects/{projectId}/import/result/files/{fileId}/select-namespace": { parameters: { query?: never; header?: never; @@ -2263,26 +2285,31 @@ export interface paths { cookie?: never; }; get?: never; - put?: never; + /** + * Select namespace + * @description Sets namespace for file to import. + */ + put: operations["selectNamespace"]; post?: never; - /** Delete one or multiple keys */ - delete: operations["delete_2"]; + delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/keys/{id}": { + "/v2/projects/{projectId}/import/result/files/{importFileId}/issues": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** Get one key */ - get: operations["get_6"]; - /** Edit key name */ - put: operations["edit"]; + /** + * Get file issues + * @description Returns issues for uploaded file. + */ + get: operations["getImportFileIssues"]; + put?: never; post?: never; delete?: never; options?: never; @@ -2290,16 +2317,19 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/projects/{projectId}/keys/{id}/big-meta": { + "/v2/projects/{projectId}/import/result/languages/{importLanguageId}/reset-existing": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** Get Big Meta for key */ - get: operations["getBigMeta"]; - put?: never; + get?: never; + /** + * Reset existing language pairing + * @description Resets existing language paired with language to import. + */ + put: operations["resetExistingLanguage"]; post?: never; delete?: never; options?: never; @@ -2307,7 +2337,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/projects/{projectId}/keys/{id}/complex-update": { + "/v2/projects/{projectId}/import/result/languages/{importLanguageId}/select-existing/{existingLanguageId}": { parameters: { query?: never; header?: never; @@ -2316,10 +2346,10 @@ export interface paths { }; get?: never; /** - * Edit key and related data - * @description Edits key name, translations, tags, screenshots, and other data + * Pair existing language + * @description Sets existing language to pair with language to import. Data will be imported to selected existing language when applied. */ - put: operations["complexEdit"]; + put: operations["selectExistingLanguage"]; post?: never; delete?: never; options?: never; @@ -2327,7 +2357,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/projects/{projectId}/keys/{id}/disabled-languages": { + "/v2/projects/{projectId}/import/result/languages/{languageId}": { parameters: { query?: never; header?: never; @@ -2335,23 +2365,23 @@ export interface paths { cookie?: never; }; /** - * Get disabled languages - * @description Returns languages, in which key is disabled + * Get import language + * @description Returns language prepared to import. */ - get: operations["getDisabledLanguages"]; + get: operations["getImportLanguage"]; + put?: never; + post?: never; /** - * Set disabled languages - * @description Sets languages, in which key is disabled + * Delete language + * @description Deletes language prepared to import. */ - put: operations["setDisabledLanguages"]; - post?: never; - delete?: never; + delete: operations["deleteLanguage"]; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/keys/{keyId}/auto-translate": { + "/v2/projects/{projectId}/import/result/languages/{languageId}/resolve-all/set-keep-existing": { parameters: { query?: never; header?: never; @@ -2360,14 +2390,10 @@ export interface paths { }; get?: never; /** - * Auto translates keys - * @description Uses enabled auto-translation methods. - * You need to set at least one of useMachineTranslation or useTranslationMemory to true. - * - * This will replace the the existing translation with the result obtained from specified source! - * + * Resolve all translation conflicts (keep existing) + * @description Resolves all translation conflicts for provided language. The old translations will be kept. */ - put: operations["autoTranslate"]; + put: operations["resolveTranslationSetKeepExisting_2"]; post?: never; delete?: never; options?: never; @@ -2375,42 +2401,47 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/projects/{projectId}/keys/{keyId}/screenshots": { + "/v2/projects/{projectId}/import/result/languages/{languageId}/resolve-all/set-override": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** Get screenshots */ - get: operations["getKeyScreenshots_1"]; - put?: never; - /** Upload screenshot */ - post: operations["uploadScreenshot_1"]; + get?: never; + /** + * Resolve all translation conflicts (override) + * @description Resolves all translation conflicts for provided language. The old translations will be overridden. + */ + put: operations["resolveTranslationSetOverride_2"]; + post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/keys/{keyId}/screenshots/{ids}": { + "/v2/projects/{projectId}/import/result/languages/{languageId}/translations": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - get?: never; + /** + * Get translations + * @description Returns translations prepared to import. + */ + get: operations["getImportTranslations"]; put?: never; post?: never; - /** Delete screenshots */ - delete: operations["deleteScreenshots_1"]; + delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/keys/{keyId}/tags": { + "/v2/projects/{projectId}/import/result/languages/{languageId}/translations/{translationId}/resolve/set-keep-existing": { parameters: { query?: never; header?: never; @@ -2419,10 +2450,10 @@ export interface paths { }; get?: never; /** - * Tag key - * @description Tags a key with tag. If tag with provided name doesn't exist, it is created + * Resolve conflict (keep existing) + * @description Resolves translation conflict. The old translation will be kept. */ - put: operations["tagKey"]; + put: operations["resolveTranslationSetKeepExisting"]; post?: never; delete?: never; options?: never; @@ -2430,7 +2461,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/projects/{projectId}/keys/{keyId}/tags/{tagId}": { + "/v2/projects/{projectId}/import/result/languages/{languageId}/translations/{translationId}/resolve/set-override": { parameters: { query?: never; header?: never; @@ -2438,27 +2469,27 @@ export interface paths { cookie?: never; }; get?: never; - put?: never; - post?: never; /** - * Remove tag - * @description Removes tag with provided id from key with provided id + * Resolve conflict (override) + * @description Resolves translation conflict. The old translation will be overridden. */ - delete: operations["removeTag"]; + put: operations["resolveTranslationSetOverride"]; + post?: never; + delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/language-ai-prompt-customizations": { + "/v2/projects/{projectId}/invitations": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** Sets project level prompt customization */ - get: operations["getLanguagePromptCustomizations"]; + /** Get project invitations */ + get: operations["getProjectInvitations"]; put?: never; post?: never; delete?: never; @@ -2467,44 +2498,46 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/projects/{projectId}/languages": { + "/v2/projects/{projectId}/invite": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** Get all languages */ - get: operations["getAll_7"]; - put?: never; - /** Create language */ - post: operations["createLanguage"]; + get?: never; + /** Generate user invitation link for project */ + put: operations["inviteUser"]; + post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/languages/{languageId}": { + "/v2/projects/{projectId}/keys": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** Get one language */ - get: operations["get_16"]; - /** Update language */ - put: operations["editLanguage"]; - post?: never; - /** Delete specific language */ - delete: operations["deleteLanguage_2"]; + /** Get all keys */ + get: operations["getAll_9"]; + put?: never; + /** Create new key */ + post: operations["create_6"]; + /** + * Delete one or multiple keys (post) + * @description Delete one or multiple keys by their IDs in request body. Useful for larger requests esxceeding allowed URL length. + */ + delete: operations["delete_6"]; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/languages/{languageId}/ai-prompt-customization": { + "/v2/projects/{projectId}/keys/create": { parameters: { query?: never; header?: never; @@ -2512,16 +2545,16 @@ export interface paths { cookie?: never; }; get?: never; - /** Sets language level prompt customization */ - put: operations["setLanguagePromptCustomization"]; - post?: never; + put?: never; + /** Create new key */ + post: operations["create_5"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/leave": { + "/v2/projects/{projectId}/keys/import": { parameters: { query?: never; header?: never; @@ -2529,66 +2562,73 @@ export interface paths { cookie?: never; }; get?: never; - /** Leave project */ - put: operations["leaveProject"]; - post?: never; + put?: never; + /** + * Import keys + * @description Imports new keys with translations. If key already exists, its translations and tags are not updated. + */ + post: operations["importKeys_2"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/machine-translation-credit-balance": { + "/v2/projects/{projectId}/keys/import-resolvable": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; + get?: never; + put?: never; /** - * Get credit balance for project - * @description Returns machine translation credit balance for specified project + * Import keys (resolvable) + * @description Import's new keys with translations. Translations can be updated, when specified. */ - get: operations["getProjectCredits"]; - put?: never; - post?: never; + post: operations["importKeys"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/machine-translation-language-info": { + "/v2/projects/{projectId}/keys/info": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; + get?: never; + put?: never; /** - * Machine translation info - * @description Get enabled services and configured formality for each language + * Get key info + * @description Returns information about keys. (KeyData, Screenshots, Translation in specified language)If key is not found, it's not included in the response. */ - get: operations["getMachineTranslationLanguageInfo"]; - put?: never; - post?: never; + post: operations["getInfo"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/machine-translation-service-settings": { + "/v2/projects/{projectId}/keys/search": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** Get machine translation settings */ - get: operations["getMachineTranslationSettings"]; - /** Sets machine translation settings */ - put: operations["setMachineTranslationSettings"]; + /** + * Search for keys + * @description This endpoint helps you to find desired key by keyName, base translation or translation in specified language. + * + * Sort is ignored for this request. + */ + get: operations["searchForKey"]; + put?: never; post?: never; delete?: never; options?: never; @@ -2596,7 +2636,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/projects/{projectId}/my-batch-jobs": { + "/v2/projects/{projectId}/keys/select": { parameters: { query?: never; header?: never; @@ -2604,10 +2644,10 @@ export interface paths { cookie?: never; }; /** - * List user batch operations - * @description List all batch operations started by current user + * Select keys + * @description Returns all key IDs for specified filter values. This way, you can apply the same filter as in the translation view and get the resulting key IDs for future use. */ - get: operations["myList"]; + get: operations["selectKeys_2"]; put?: never; post?: never; delete?: never; @@ -2616,36 +2656,34 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/projects/{projectId}/namespace-by-name/{name}": { + "/v2/projects/{projectId}/keys/{ids}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** - * Get namespace by name - * @description Returns information about a namespace by its name - */ - get: operations["getByName"]; + get?: never; put?: never; post?: never; - delete?: never; + /** Delete one or multiple keys */ + delete: operations["delete_4"]; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/namespaces": { + "/v2/projects/{projectId}/keys/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** Get namespaces */ - get: operations["getAllNamespaces"]; - put?: never; + /** Get one key */ + get: operations["get_14"]; + /** Edit key name */ + put: operations["edit"]; post?: never; delete?: never; options?: never; @@ -2653,16 +2691,16 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/projects/{projectId}/namespaces/{id}": { + "/v2/projects/{projectId}/keys/{id}/big-meta": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - get?: never; - /** Update namespace */ - put: operations["update_1"]; + /** Get Big Meta for key */ + get: operations["getBigMeta"]; + put?: never; post?: never; delete?: never; options?: never; @@ -2670,17 +2708,19 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/projects/{projectId}/per-language-auto-translation-settings": { + "/v2/projects/{projectId}/keys/{id}/complex-update": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** Get per-language auto-translation settings */ - get: operations["getPerLanguageAutoTranslationSettings"]; - /** Set per-language auto-translation settings */ - put: operations["setPerLanguageAutoTranslationSettings"]; + get?: never; + /** + * Edit key and related data + * @description Edits key name, translations, tags, screenshots, and other data + */ + put: operations["complexEdit"]; post?: never; delete?: never; options?: never; @@ -2688,27 +2728,31 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/projects/{projectId}/single-step-import": { + "/v2/projects/{projectId}/keys/{id}/disabled-languages": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - get?: never; - put?: never; /** - * Single step import - * @description Unlike the /v2/projects/{projectId}/import endpoint, imports the data in single request by provided files and parameters. This is useful for automated importing via API or CLI. + * Get disabled languages + * @description Returns languages, in which key is disabled */ - post: operations["doImport"]; + get: operations["getDisabledLanguages"]; + /** + * Set disabled languages + * @description Sets languages, in which key is disabled + */ + put: operations["setDisabledLanguages"]; + post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/start-batch-job/clear-translations": { + "/v2/projects/{projectId}/keys/{keyId}/auto-translate": { parameters: { query?: never; header?: never; @@ -2716,39 +2760,41 @@ export interface paths { cookie?: never; }; get?: never; - put?: never; /** - * Clear translation values - * @description Clear translation values for provided keys in selected languages. + * Auto translates keys + * @description Uses enabled auto-translation methods. + * You need to set at least one of useMachineTranslation or useTranslationMemory to true. + * + * This will replace the the existing translation with the result obtained from specified source! + * */ - post: operations["clearTranslations"]; + put: operations["autoTranslate"]; + post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/start-batch-job/copy-translations": { + "/v2/projects/{projectId}/keys/{keyId}/screenshots": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - get?: never; + /** Get screenshots */ + get: operations["getKeyScreenshots_1"]; put?: never; - /** - * Copy translation values - * @description Copy translation values from one language to other languages. - */ - post: operations["copyTranslations"]; + /** Upload screenshot */ + post: operations["uploadScreenshot_1"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/start-batch-job/delete-keys": { + "/v2/projects/{projectId}/keys/{keyId}/screenshots/{ids}": { parameters: { query?: never; header?: never; @@ -2757,15 +2803,15 @@ export interface paths { }; get?: never; put?: never; - /** Delete keys */ - post: operations["deleteKeys"]; - delete?: never; + post?: never; + /** Delete screenshots */ + delete: operations["deleteScreenshots_1"]; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/start-batch-job/machine-translate": { + "/v2/projects/{projectId}/keys/{keyId}/tags": { parameters: { query?: never; header?: never; @@ -2773,19 +2819,19 @@ export interface paths { cookie?: never; }; get?: never; - put?: never; /** - * Machine Translation - * @description Translate provided keys to provided languages through primary MT provider. + * Tag key + * @description Tags a key with tag. If tag with provided name doesn't exist, it is created */ - post: operations["machineTranslation"]; + put: operations["tagKey"]; + post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/start-batch-job/pre-translate-by-tm": { + "/v2/projects/{projectId}/keys/{keyId}/tags/{tagId}": { parameters: { query?: never; header?: never; @@ -2794,52 +2840,53 @@ export interface paths { }; get?: never; put?: never; + post?: never; /** - * Pre-translate by TM - * @description Pre-translate provided keys to provided languages by TM. + * Remove tag + * @description Removes tag with provided id from key with provided id */ - post: operations["translate"]; - delete?: never; + delete: operations["removeTag"]; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/start-batch-job/set-keys-namespace": { + "/v2/projects/{projectId}/labels": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - get?: never; + /** Get available project labels */ + get: operations["getAll_3"]; put?: never; - /** Set keys namespace */ - post: operations["setKeysNamespace"]; + /** Create label */ + post: operations["createLabel"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/start-batch-job/set-translation-state": { + "/v2/projects/{projectId}/labels/ids": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - get?: never; + /** Get labels by ids */ + get: operations["getLabelsByIds"]; put?: never; - /** Set translation state */ - post: operations["setTranslationState_2"]; + post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/start-batch-job/tag-keys": { + "/v2/projects/{projectId}/labels/{labelId}": { parameters: { query?: never; header?: never; @@ -2847,67 +2894,71 @@ export interface paths { cookie?: never; }; get?: never; - put?: never; - /** Add tags */ - post: operations["tagKeys"]; - delete?: never; + /** Update label */ + put: operations["updateLabel"]; + post?: never; + /** Delete label */ + delete: operations["deleteLabel"]; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/start-batch-job/untag-keys": { + "/v2/projects/{projectId}/language-ai-prompt-customizations": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - get?: never; + /** Sets project level prompt customization */ + get: operations["getLanguagePromptCustomizations"]; put?: never; - /** Remove tags */ - post: operations["untagKeys"]; + post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/stats": { + "/v2/projects/{projectId}/languages": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** Get project stats */ - get: operations["getProjectStats"]; + /** Get all languages */ + get: operations["getAll_7"]; put?: never; - post?: never; + /** Create language */ + post: operations["createLanguage"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/stats/daily-activity": { + "/v2/projects/{projectId}/languages/{languageId}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** Get project daily amount of events */ - get: operations["getProjectDailyActivity"]; - put?: never; + /** Get one language */ + get: operations["get_12"]; + /** Update language */ + put: operations["editLanguage"]; post?: never; - delete?: never; + /** Delete specific language */ + delete: operations["deleteLanguage_2"]; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/suggest/machine-translations": { + "/v2/projects/{projectId}/languages/{languageId}/ai-prompt-customization": { parameters: { query?: never; header?: never; @@ -2915,19 +2966,16 @@ export interface paths { cookie?: never; }; get?: never; - put?: never; - /** - * Get machine translation suggestions - * @description Suggests machine translations from enabled services - */ - post: operations["suggestMachineTranslations"]; + /** Sets language level prompt customization */ + put: operations["setLanguagePromptCustomization"]; + post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/suggest/machine-translations-streaming": { + "/v2/projects/{projectId}/leave": { parameters: { query?: never; header?: never; @@ -2935,48 +2983,48 @@ export interface paths { cookie?: never; }; get?: never; - put?: never; - /** - * Get machine translation suggestions (streaming) - * @description Suggests machine translations from enabled services. The results are streamed to the output in ndjson format. If an error occurs when for any service provider used, the error information is returned as a part of the result item, while the response has 200 status code. - */ - post: operations["suggestMachineTranslationsStreaming"]; + /** Leave project */ + put: operations["leaveProject"]; + post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/suggest/translation-memory": { + "/v2/projects/{projectId}/machine-translation-credit-balance": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - get?: never; - put?: never; /** - * Get suggestions from translation memory - * @description Suggests machine translations from translation memory. The result is always sorted by similarity, so sorting is not supported. + * Get credit balance for project + * @description Returns machine translation credit balance for specified project */ - post: operations["suggestTranslationMemory"]; + get: operations["getProjectCredits"]; + put?: never; + post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/tag-complex": { + "/v2/projects/{projectId}/machine-translation-language-info": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - get?: never; - /** Execute complex tag operation */ - put: operations["executeComplexTagOperation"]; + /** + * Machine translation info + * @description Get enabled services and configured formality for each language + */ + get: operations["getMachineTranslationLanguageInfo"]; + put?: never; post?: never; delete?: never; options?: never; @@ -2984,16 +3032,17 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/projects/{projectId}/tags": { + "/v2/projects/{projectId}/machine-translation-service-settings": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** Get tags */ - get: operations["getAll_3"]; - put?: never; + /** Get machine translation settings */ + get: operations["getMachineTranslationSettings"]; + /** Sets machine translation settings */ + put: operations["setMachineTranslationSettings"]; post?: never; delete?: never; options?: never; @@ -3001,66 +3050,72 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/projects/{projectId}/tasks": { + "/v2/projects/{projectId}/machine-translation-service-settings/set-default-prompt/{promptId}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** Get tasks */ - get: operations["getTasks_1"]; - put?: never; - /** Create task */ - post: operations["createTask"]; + get?: never; + /** Sets machine translation default prompt for all languages */ + put: operations["setMachineTranslationSettings_1"]; + post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/tasks/calculate-scope": { + "/v2/projects/{projectId}/my-batch-jobs": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - get?: never; + /** + * List user batch operations + * @description List all batch operations started by current user + */ + get: operations["myList"]; put?: never; - /** Calculate scope */ - post: operations["calculateScope"]; + post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/tasks/create-multiple-tasks": { + "/v2/projects/{projectId}/namespace-by-name/{name}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - get?: never; + /** + * Get namespace by name + * @description Returns information about a namespace by its name + */ + get: operations["getByName"]; put?: never; - /** Create multiple tasks */ - post: operations["createTasks"]; + post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/tasks/possible-assignees": { + "/v2/projects/{projectId}/namespaces": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - get: operations["getPossibleAssignees"]; + /** Get namespaces */ + get: operations["getAllNamespaces_2"]; put?: never; post?: never; delete?: never; @@ -3069,17 +3124,16 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/projects/{projectId}/tasks/{taskNumber}": { + "/v2/projects/{projectId}/namespaces/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** Get task */ - get: operations["getTask"]; - /** Update task */ - put: operations["updateTask"]; + get?: never; + /** Update namespace */ + put: operations["update_3"]; post?: never; delete?: never; options?: never; @@ -3087,19 +3141,17 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/projects/{projectId}/tasks/{taskNumber}/blocking-tasks": { + "/v2/projects/{projectId}/per-language-auto-translation-settings": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** - * Get blocking task numbers - * @description If the tasks is blocked by other tasks, it returns numbers of these tasks. - */ - get: operations["getBlockingTasks"]; - put?: never; + /** Get per-language auto-translation settings */ + get: operations["getPerLanguageAutoTranslationSettings"]; + /** Set per-language auto-translation settings */ + put: operations["setPerLanguageAutoTranslationSettings"]; post?: never; delete?: never; options?: never; @@ -3107,33 +3159,31 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/projects/{projectId}/tasks/{taskNumber}/close": { + "/v2/projects/{projectId}/prompts": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - get?: never; - /** Close task */ - put: operations["closeTask"]; - post?: never; + get: operations["getAllPaged"]; + put?: never; + post: operations["createPrompt"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/tasks/{taskNumber}/finish": { + "/v2/projects/{projectId}/prompts/default": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - get?: never; - /** Finish task */ - put: operations["finishTask"]; + get: operations["getDefaultPrompt"]; + put?: never; post?: never; delete?: never; options?: never; @@ -3141,17 +3191,16 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/projects/{projectId}/tasks/{taskNumber}/keys": { + "/v2/projects/{projectId}/prompts/get-variables": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** Get task keys */ - get: operations["getTaskKeys"]; - /** Add or remove task keys */ - put: operations["updateTaskKeys"]; + /** Get variables */ + get: operations["variables"]; + put?: never; post?: never; delete?: never; options?: never; @@ -3159,7 +3208,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/projects/{projectId}/tasks/{taskNumber}/keys/{keyId}": { + "/v2/projects/{projectId}/prompts/run": { parameters: { query?: never; header?: never; @@ -3167,39 +3216,31 @@ export interface paths { cookie?: never; }; get?: never; - /** - * Update task key - * @description Mark key as done, which updates task progress. - */ - put: operations["updateTaskKey"]; - post?: never; + put?: never; + post: operations["run"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/tasks/{taskNumber}/per-user-report": { + "/v2/projects/{projectId}/prompts/{promptId}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** - * Get report - * @description Detailed statistics for every assignee - */ - get: operations["getPerUserReport"]; - put?: never; + get: operations["getPrompt"]; + put: operations["updatePrompt"]; post?: never; - delete?: never; + delete: operations["deletePrompt"]; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/tasks/{taskNumber}/reopen": { + "/v2/projects/{projectId}/single-step-import": { parameters: { query?: never; header?: never; @@ -3207,56 +3248,53 @@ export interface paths { cookie?: never; }; get?: never; - /** Reopen task */ - put: operations["reopenTask"]; - post?: never; + put?: never; + /** + * Single step import + * @description Unlike the /v2/projects/{projectId}/import endpoint, imports the data in single request by provided files and parameters. This is useful for automated importing via API or CLI. + */ + post: operations["doImport"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/tasks/{taskNumber}/xlsx-report": { + "/v2/projects/{projectId}/start-batch-job/ai-playground-translate": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** - * Get report in XLSX - * @description Detailed statistics about the task results - */ - get: operations["getXlsxReport"]; + get?: never; put?: never; - post?: never; + /** Translates via llm and stores result in AiPlaygroundResult */ + post: operations["aiPlaygroundTranslate"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/transfer-options": { + "/v2/projects/{projectId}/start-batch-job/assign-translation-label": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** - * Get transfer to organization options - * @description Returns organizations to which project can be transferred - */ - get: operations["getTransferOptions"]; + get?: never; put?: never; - post?: never; + /** Assign labels to translations */ + post: operations["assignTranslationLabel"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/transfer-to-organization/{organizationId}": { + "/v2/projects/{projectId}/start-batch-job/clear-translations": { parameters: { query?: never; header?: never; @@ -3264,44 +3302,39 @@ export interface paths { cookie?: never; }; get?: never; + put?: never; /** - * Transfer project - * @description Transfers project's ownership to organization + * Clear translation values + * @description Clear translation values for provided keys in selected languages. */ - put: operations["transferProjectToOrganization"]; - post?: never; + post: operations["clearTranslations"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/translations": { + "/v2/projects/{projectId}/start-batch-job/copy-translations": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** Get translations in project */ - get: operations["getTranslations"]; - /** - * Update translations for existing key - * @description Sets translations for existing key - */ - put: operations["setTranslations"]; + get?: never; + put?: never; /** - * Create key or update translations - * @description Sets translations for existing key or creates new key and sets the translations to it. + * Copy translation values + * @description Copy translation values from one language to other languages. */ - post: operations["createOrUpdateTranslations"]; + post: operations["copyTranslations"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/translations/create-comment": { + "/v2/projects/{projectId}/start-batch-job/delete-keys": { parameters: { query?: never; header?: never; @@ -3310,98 +3343,89 @@ export interface paths { }; get?: never; put?: never; - /** - * Create translation comment - * @description Creates a translation comment. Empty translation is stored, when not exists. - */ - post: operations["create_9"]; + /** Delete keys */ + post: operations["deleteKeys"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/translations/select-all": { + "/v2/projects/{projectId}/start-batch-job/machine-translate": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; + get?: never; + put?: never; /** - * Select keys - * @description Returns all key IDs for specified filter values. This way, you can apply the same filter as in the translation view and get the resulting key IDs for future use. + * Machine Translation + * @description Translate provided keys to provided languages through primary MT provider. */ - get: operations["selectKeys"]; - put?: never; - post?: never; + post: operations["machineTranslation"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/translations/{languages}": { + "/v2/projects/{projectId}/start-batch-job/pre-translate-by-tm": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; + get?: never; + put?: never; /** - * Get all translations - * @description Returns all translations for specified languages + * Pre-translate by TM + * @description Pre-translate provided keys to provided languages by TM. */ - get: operations["getAllTranslations"]; - put?: never; - post?: never; + post: operations["translate"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/translations/{translationId}/comments": { + "/v2/projects/{projectId}/start-batch-job/set-keys-namespace": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** - * Get translation comments - * @description Returns translation comments of translation - */ - get: operations["getAll_5"]; + get?: never; put?: never; - /** Create translation comment */ - post: operations["create_7"]; + /** Set keys namespace */ + post: operations["setKeysNamespace"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/translations/{translationId}/comments/{commentId}": { + "/v2/projects/{projectId}/start-batch-job/set-translation-state": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** Get one translation comment */ - get: operations["get_14"]; - /** Update translation comment */ - put: operations["update_5"]; - post?: never; - /** Delete translation comment */ - delete: operations["delete_8"]; + get?: never; + put?: never; + /** Set translation state */ + post: operations["setTranslationState_2"]; + delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/translations/{translationId}/comments/{commentId}/set-state/{state}": { + "/v2/projects/{projectId}/start-batch-job/tag-keys": { parameters: { query?: never; header?: never; @@ -3409,16 +3433,16 @@ export interface paths { cookie?: never; }; get?: never; - /** Set state of translation comment */ - put: operations["setState"]; - post?: never; + put?: never; + /** Add tags */ + post: operations["tagKeys"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/translations/{translationId}/dismiss-auto-translated-state": { + "/v2/projects/{projectId}/start-batch-job/unassign-translation-label": { parameters: { query?: never; header?: never; @@ -3426,51 +3450,42 @@ export interface paths { cookie?: never; }; get?: never; - /** - * Dismiss auto-translated - * @description Removes "auto translated" indication - */ - put: operations["dismissAutoTranslatedState"]; - post?: never; + put?: never; + /** Unassign labels from translations */ + post: operations["unassignTranslationLabel"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/translations/{translationId}/history": { + "/v2/projects/{projectId}/start-batch-job/untag-keys": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** - * Get translation history - * @description Sorting is not supported for supported. It is automatically sorted from newest to oldest. - */ - get: operations["getTranslationHistory"]; + get?: never; put?: never; - post?: never; + /** Remove tags */ + post: operations["untagKeys"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/translations/{translationId}/set-outdated-flag/{state}": { + "/v2/projects/{projectId}/stats": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - get?: never; - /** - * Set outdated value - * @description Set's "outdated" flag indicating the base translation was changed without updating current translation. - */ - put: operations["setOutdated"]; + /** Get project stats */ + get: operations["getProjectStats"]; + put?: never; post?: never; delete?: never; options?: never; @@ -3478,16 +3493,16 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/projects/{projectId}/translations/{translationId}/set-state/{state}": { + "/v2/projects/{projectId}/stats/daily-activity": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - get?: never; - /** Set translation state */ - put: operations["setTranslationState"]; + /** Get project daily amount of events */ + get: operations["getProjectDailyActivity"]; + put?: never; post?: never; delete?: never; options?: never; @@ -3495,47 +3510,47 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/projects/{projectId}/used-namespaces": { + "/v2/projects/{projectId}/suggest/machine-translations": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; + get?: never; + put?: never; /** - * Get used namespaces - * @description Returns all used project namespaces. Response contains default (null) namespace if used. + * Get machine translation suggestions + * @description Suggests machine translations from enabled services */ - get: operations["getUsedNamespaces"]; - put?: never; - post?: never; + post: operations["suggestMachineTranslations"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/users": { + "/v2/projects/{projectId}/suggest/machine-translations-streaming": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; + get?: never; + put?: never; /** - * Get users with project access - * @description Returns all project users, who have permission to access project + * Get machine translation suggestions (streaming) + * @description Suggests machine translations from enabled services. The results are streamed to the output in ndjson format. If an error occurs when for any service provider used, the error information is returned as a part of the result item, while the response has 200 status code. */ - get: operations["getAllUsers"]; - put?: never; - post?: never; + post: operations["suggestMachineTranslationsStreaming"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/users/{userId}/revoke-access": { + "/v2/projects/{projectId}/suggest/translation-memory": { parameters: { query?: never; header?: never; @@ -3543,16 +3558,19 @@ export interface paths { cookie?: never; }; get?: never; - /** Revoke project access */ - put: operations["revokePermission"]; - post?: never; + put?: never; + /** + * Get suggestions from translation memory + * @description Suggests machine translations from translation memory. The result is always sorted by similarity, so sorting is not supported. + */ + post: operations["suggestTranslationMemory"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/users/{userId}/set-by-organization": { + "/v2/projects/{projectId}/tag-complex": { parameters: { query?: never; header?: never; @@ -3560,11 +3578,8 @@ export interface paths { cookie?: never; }; get?: never; - /** - * Remove direct project permission - * @description Removes user's direct project permission, explicitly set for the project. User will have now base permissions from organization or no permission if they're not organization member. - */ - put: operations["setOrganizationBase"]; + /** Execute complex tag operation */ + put: operations["executeComplexTagOperation"]; post?: never; delete?: never; options?: never; @@ -3572,19 +3587,16 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/projects/{projectId}/users/{userId}/set-permissions": { + "/v2/projects/{projectId}/tags": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - get?: never; - /** - * Set user's project permission - * @description Set user's granular (scope-based) direct project permission - */ - put: operations["setUsersPermissions"]; + /** Get tags */ + get: operations["getAll_1"]; + put?: never; post?: never; delete?: never; options?: never; @@ -3592,124 +3604,122 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/projects/{projectId}/users/{userId}/set-permissions/{permissionType}": { + "/v2/projects/{projectId}/tasks": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - get?: never; - /** Set direct permission to user */ - put: operations["setUsersPermissions_1"]; - post?: never; + /** Get tasks */ + get: operations["getTasks_1"]; + put?: never; + /** Create task */ + post: operations["createTask"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/webhook-configs": { + "/v2/projects/{projectId}/tasks/calculate-scope": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** List webhook configurations */ - get: operations["list"]; + get?: never; put?: never; - /** Create new webhook configuration */ - post: operations["create"]; + /** Calculate scope */ + post: operations["calculateScope"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/webhook-configs/{id}": { + "/v2/projects/{projectId}/tasks/create-multiple-tasks": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** Get one webhook configuration */ - get: operations["get_5"]; - /** Update webhook configuration */ - put: operations["update"]; - post?: never; - /** Delete webhook configuration */ - delete: operations["delete_1"]; + get?: never; + put?: never; + /** Create multiple tasks */ + post: operations["createTasks"]; + delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/projects/{projectId}/webhook-configs/{id}/test": { + "/v2/projects/{projectId}/tasks/possible-assignees": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - get?: never; + get: operations["getPossibleAssignees"]; put?: never; - /** - * Test webhook configuration - * @description Sends a test request to the webhook - */ - post: operations["test"]; + post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/public/business-events/identify": { + "/v2/projects/{projectId}/tasks/{taskNumber}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - get?: never; - put?: never; - /** Identifies user */ - post: operations["identify"]; + /** Get task */ + get: operations["getTask"]; + /** Update task */ + put: operations["updateTask"]; + post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/public/business-events/report": { + "/v2/projects/{projectId}/tasks/{taskNumber}/blocking-tasks": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - get?: never; + /** + * Get blocking task numbers + * @description If the tasks is blocked by other tasks, it returns numbers of these tasks. + */ + get: operations["getBlockingTasks"]; put?: never; - /** Reports business event */ - post: operations["report"]; + post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/public/configuration-properties": { + "/v2/projects/{projectId}/tasks/{taskNumber}/cancel": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** @description Return server configuration properties documentation */ - get: operations["get_3"]; - put?: never; + get?: never; + /** Close task */ + put: operations["cancelTask"]; post?: never; delete?: never; options?: never; @@ -3717,15 +3727,19 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/public/export-info/formats": { + "/v2/projects/{projectId}/tasks/{taskNumber}/close": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - get: operations["get_2"]; - put?: never; + get?: never; + /** + * Close task + * @deprecated + */ + put: operations["closeTask"]; post?: never; delete?: never; options?: never; @@ -3733,19 +3747,16 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/public/initial-data": { + "/v2/projects/{projectId}/tasks/{taskNumber}/finish": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** - * Get initial data - * @description Returns initial data required by the UI to load - */ - get: operations["get_1"]; - put?: never; + get?: never; + /** Finish task */ + put: operations["finishTask"]; post?: never; delete?: never; options?: never; @@ -3753,19 +3764,17 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/public/machine-translation-providers": { + "/v2/projects/{projectId}/tasks/{taskNumber}/keys": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** - * Returns information about supported translation providers - * @description Get machine translation providers - */ - get: operations["getInfo_4"]; - put?: never; + /** Get task keys */ + get: operations["getTaskKeys"]; + /** Add or remove task keys */ + put: operations["updateTaskKeys"]; post?: never; delete?: never; options?: never; @@ -3773,16 +3782,19 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/public/scope-info/hierarchy": { + "/v2/projects/{projectId}/tasks/{taskNumber}/keys/{keyId}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** Returns hierarchy of scopes */ - get: operations["getHierarchy"]; - put?: never; + get?: never; + /** + * Update task key + * @description Mark key as done, which updates task progress. + */ + put: operations["updateTaskKey"]; post?: never; delete?: never; options?: never; @@ -3790,15 +3802,18 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/public/scope-info/roles": { + "/v2/projects/{projectId}/tasks/{taskNumber}/per-user-report": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** Returns user roles and their scopes */ - get: operations["getRoles"]; + /** + * Get report + * @description Detailed statistics for every assignee + */ + get: operations["getPerUserReport"]; put?: never; post?: never; delete?: never; @@ -3807,7 +3822,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/public/slack": { + "/v2/projects/{projectId}/tasks/{taskNumber}/reopen": { parameters: { query?: never; header?: never; @@ -3815,57 +3830,56 @@ export interface paths { cookie?: never; }; get?: never; - put?: never; - post: operations["slackCommand"]; + /** Reopen task */ + put: operations["reopenTask"]; + post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/public/slack/on-bot-event": { + "/v2/projects/{projectId}/tasks/{taskNumber}/xlsx-report": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - get?: never; - put?: never; /** - * On bot event - * @description This is triggered when bot event is triggered. E.g., when app is uninstalled from workspace. - * - * Heads up! The events have to be configured via Slack App configuration in Event Subscription section. + * Get report in XLSX + * @description Detailed statistics about the task results */ - post: operations["fetchBotEvent"]; + get: operations["getXlsxReport"]; + put?: never; + post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/public/slack/on-event": { + "/v2/projects/{projectId}/transfer-options": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - get?: never; - put?: never; /** - * On interactivity event - * @description This is triggered when interactivity event is triggered. E.g., when user clicks button provided in previous messages. + * Get transfer to organization options + * @description Returns organizations to which project can be transferred */ - post: operations["onInteractivityEvent"]; + get: operations["getTransferOptions"]; + put?: never; + post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/quick-start/set-finished/{finished}": { + "/v2/projects/{projectId}/transfer-to-organization/{organizationId}": { parameters: { query?: never; header?: never; @@ -3874,10 +3888,10 @@ export interface paths { }; get?: never; /** - * Set finished state - * @description Sets finished state of the quick start guide + * Transfer project + * @description Transfers project's ownership to organization */ - put: operations["setFinishedState"]; + put: operations["transferProjectToOrganization"]; post?: never; delete?: never; options?: never; @@ -3885,27 +3899,32 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/quick-start/set-open/{open}": { + "/v2/projects/{projectId}/translations": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - get?: never; + /** Get translations in project */ + get: operations["getTranslations"]; /** - * Set open state - * @description Sets open state of the quick start guide + * Update translations for existing key + * @description Sets translations for existing key */ - put: operations["setOpenState"]; - post?: never; + put: operations["setTranslations"]; + /** + * Create key or update translations + * @description Sets translations for existing key or creates new key and sets the translations to it. + */ + post: operations["createOrUpdateTranslations"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/quick-start/steps/{step}/complete": { + "/v2/projects/{projectId}/translations/create-comment": { parameters: { query?: never; header?: never; @@ -3913,19 +3932,19 @@ export interface paths { cookie?: never; }; get?: never; + put?: never; /** - * Complete guide step - * @description Marks guide step as completed + * Create translation comment + * @description Creates a translation comment. Empty translation is stored, when not exists. */ - put: operations["completeGuideStep"]; - post?: never; + post: operations["create_3"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/slack/user-login": { + "/v2/projects/{projectId}/translations/label": { parameters: { query?: never; header?: never; @@ -3933,19 +3952,16 @@ export interface paths { cookie?: never; }; get?: never; - put?: never; - /** - * User login - * @description Pairs user account with slack account. - */ - post: operations["userLogin"]; + /** Add label to translation by key and language id */ + put: operations["assignLabel_2"]; + post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/slack/user-login-info": { + "/v2/projects/{projectId}/translations/select-all": { parameters: { query?: never; header?: never; @@ -3953,14 +3969,10 @@ export interface paths { cookie?: never; }; /** - * Returns connection info - * @description Returns information about the connection between Slack account and Tolgee account which user is performing. The flow is the following. - * - * 1. User executes slash command in Slack and gets link with encrypted Slack user ID, workspace ID and the Channel ID (to send success response to) - * - * 2. User gets opens the link and the Tolgee Platform frontend and it uses this endpoint to get the data info about the future connection + * Select keys + * @description Returns all key IDs for specified filter values. This way, you can apply the same filter as in the translation view and get the resulting key IDs for future use. */ - get: operations["getInfo_3"]; + get: operations["selectKeys"]; put?: never; post?: never; delete?: never; @@ -3969,67 +3981,76 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/slug/generate-organization": { + "/v2/projects/{projectId}/translations/{languages}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - get?: never; + /** + * Get all translations + * @description Returns all translations for specified languages + */ + get: operations["getAllTranslations"]; put?: never; - /** Generate organization slug */ - post: operations["generateOrganizationSlug"]; + post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/slug/generate-project": { + "/v2/projects/{projectId}/translations/{translationId}/comments": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - get?: never; + /** + * Get translation comments + * @description Returns translation comments of translation + */ + get: operations["getAll_5"]; put?: never; - /** Generate project slug */ - post: operations["generateProjectSlug"]; + /** Create translation comment */ + post: operations["create_1"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/slug/validate-organization/{slug}": { + "/v2/projects/{projectId}/translations/{translationId}/comments/{commentId}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** Validate organization slug */ - get: operations["validateOrganizationSlug"]; - put?: never; + /** Get one translation comment */ + get: operations["get_10"]; + /** Update translation comment */ + put: operations["update_1"]; post?: never; - delete?: never; + /** Delete translation comment */ + delete: operations["delete_2"]; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/slug/validate-project/{slug}": { + "/v2/projects/{projectId}/translations/{translationId}/comments/{commentId}/set-state/{state}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** Validate project slug */ - get: operations["validateProjectSlug"]; - put?: never; + get?: never; + /** Set state of translation comment */ + put: operations["setState"]; post?: never; delete?: never; options?: never; @@ -4037,44 +4058,38 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/user": { + "/v2/projects/{projectId}/translations/{translationId}/dismiss-auto-translated-state": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; + get?: never; /** - * Get user info - * @description Returns information about currently authenticated user. - */ - get: operations["getInfo_2"]; - /** - * Update user - * @description Updates current user's profile information. - */ - put: operations["updateUser"]; - /** - * Updates current user's data. - * @deprecated + * Dismiss auto-translated + * @description Removes "auto translated" indication */ - post: operations["updateUserOld"]; - /** Delete user */ - delete: operations["delete"]; + put: operations["dismissAutoTranslatedState"]; + post?: never; + delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/user-preferences": { + "/v2/projects/{projectId}/translations/{translationId}/history": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** Get user's preferences */ - get: operations["get"]; + /** + * Get translation history + * @description Sorting is not supported for supported. It is automatically sorted from newest to oldest. + */ + get: operations["getTranslationHistory"]; put?: never; post?: never; delete?: never; @@ -4083,7 +4098,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/user-preferences/set-language/{languageTag}": { + "/v2/projects/{projectId}/translations/{translationId}/label/{labelId}": { parameters: { query?: never; header?: never; @@ -4091,8 +4106,29 @@ export interface paths { cookie?: never; }; get?: never; - /** Set user's UI language */ - put: operations["setLanguage"]; + /** Add label to translation */ + put: operations["assignLabel"]; + post?: never; + /** Remove label from translation */ + delete: operations["unassignLabel"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/projects/{projectId}/translations/{translationId}/set-outdated-flag/{state}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Set outdated value + * @description Set's "outdated" flag indicating the base translation was changed without updating current translation. + */ + put: operations["setOutdated"]; post?: never; delete?: never; options?: never; @@ -4100,7 +4136,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/user-preferences/set-preferred-organization/{organizationId}": { + "/v2/projects/{projectId}/translations/{translationId}/set-state/{state}": { parameters: { query?: never; header?: never; @@ -4108,8 +4144,8 @@ export interface paths { cookie?: never; }; get?: never; - /** Set user preferred organization */ - put: operations["setPreferredOrganization"]; + /** Set translation state */ + put: operations["setTranslationState"]; post?: never; delete?: never; options?: never; @@ -4117,15 +4153,18 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/user-tasks": { + "/v2/projects/{projectId}/used-namespaces": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** Get user tasks */ - get: operations["getTasks"]; + /** + * Get used namespaces + * @description Returns all used project namespaces. Response contains default (null) namespace if used. + */ + get: operations["getUsedNamespaces"]; put?: never; post?: never; delete?: never; @@ -4134,25 +4173,27 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/user/avatar": { + "/v2/projects/{projectId}/users": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - get?: never; - /** Upload avatar */ - put: operations["uploadAvatar"]; + /** + * Get users with project access + * @description Returns all project users, who have permission to access project + */ + get: operations["getAllUsers"]; + put?: never; post?: never; - /** Delete avatar */ - delete: operations["removeAvatar"]; + delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/user/generate-super-token": { + "/v2/projects/{projectId}/users/{userId}/revoke-access": { parameters: { query?: never; header?: never; @@ -4160,19 +4201,16 @@ export interface paths { cookie?: never; }; get?: never; - put?: never; - /** - * Get super JWT - * @description Generates new JWT token permitted to sensitive operations - */ - post: operations["getSuperToken"]; + /** Revoke project access */ + put: operations["revokePermission"]; + post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/user/mfa/recovery": { + "/v2/projects/{projectId}/users/{userId}/set-by-organization": { parameters: { query?: never; header?: never; @@ -4181,10 +4219,10 @@ export interface paths { }; get?: never; /** - * Regenerate Codes - * @description Regenerates multi-factor authentication recovery codes + * Remove direct project permission + * @description Removes user's direct project permission, explicitly set for the project. User will have now base permissions from organization or no permission if they're not organization member. */ - put: operations["regenerateRecoveryCodes"]; + put: operations["setOrganizationBase"]; post?: never; delete?: never; options?: never; @@ -4192,7 +4230,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/user/mfa/totp": { + "/v2/projects/{projectId}/users/{userId}/set-permissions": { parameters: { query?: never; header?: never; @@ -4201,22 +4239,18 @@ export interface paths { }; get?: never; /** - * Enable TOTP - * @description Enables TOTP-based two-factor authentication. Invalidates all previous sessions upon success. + * Set user's project permission + * @description Set user's granular (scope-based) direct project permission */ - put: operations["enableMfa"]; + put: operations["setUsersPermissions"]; post?: never; - /** - * Disable TOTP - * @description Disables TOTP-based two-factor authentication. Invalidates all previous sessions upon success. - */ - delete: operations["disableMfa"]; + delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/user/password": { + "/v2/projects/{projectId}/users/{userId}/set-permissions/{permissionType}": { parameters: { query?: never; header?: never; @@ -4224,11 +4258,8 @@ export interface paths { cookie?: never; }; get?: never; - /** - * Update password - * @description Updates current user's password. Invalidates all previous sessions upon success. - */ - put: operations["updateUserPassword"]; + /** Set direct permission to user */ + put: operations["setUsersPermissions_1"]; post?: never; delete?: never; options?: never; @@ -4236,7 +4267,44 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/user/send-email-verification": { + "/v2/projects/{projectId}/webhook-configs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** List webhook configurations */ + get: operations["list_2"]; + put?: never; + /** Create new webhook configuration */ + post: operations["create"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/projects/{projectId}/webhook-configs/{id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** Get one webhook configuration */ + get: operations["get_9"]; + /** Update webhook configuration */ + put: operations["update"]; + post?: never; + /** Delete webhook configuration */ + delete: operations["delete_1"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/projects/{projectId}/webhook-configs/{id}/test": { parameters: { query?: never; header?: never; @@ -4246,392 +4314,754 @@ export interface paths { get?: never; put?: never; /** - * Resend email verification - * @description Resends email verification email to currently authenticated user. + * Test webhook configuration + * @description Sends a test request to the webhook */ - post: operations["sendEmailVerification"]; + post: operations["test"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/user/single-owned-organizations": { + "/v2/public/business-events/identify": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** - * Get all single owned organizations - * @description Returns all organizations owned only by current user - */ - get: operations["getAllSingleOwnedOrganizations"]; + get?: never; put?: never; - post?: never; + /** Identifies user */ + post: operations["identify"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; -} -export type webhooks = Record; -export interface components { - schemas: { - AnnouncementDto: { - /** @enum {string} */ - type: "FEATURE_BATCH_OPERATIONS" | "FEATURE_MT_FORMALITY" | "FEATURE_CONTENT_DELIVERY_AND_WEBHOOKS" | "NEW_PRICING" | "FEATURE_AI_CUSTOMIZATION" | "FEATURE_VISUAL_EDITOR" | "FEATURE_CLI_2" | "FEATURE_TASKS"; + "/v2/public/business-events/report": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - ApiKeyModel: { - /** @description Description */ - description: string; - /** - * Format: int64 - * @description Timestamp of API key expiraion - */ - expiresAt?: number; - /** - * Format: int64 - * @description ID of the API key - */ - id: number; - /** - * Format: int64 - * @description Timestamp of API key last usage - */ - lastUsedAt?: number; - /** - * Format: int64 - * @description Api key's project ID - */ - projectId: number; - /** @description Api key's project name */ - projectName: string; - /** - * @description Api key's permission scopes - * @example [ - * "screenshots.upload", - * "screenshots.delete", - * "translations.edit", - * "screenshots.view", - * "translations.view", - * "keys.edit" - * ] - */ - scopes: string[]; - /** @description Full name of user owner */ - userFullName?: string; - /** @description Username of user owner */ - username?: string; + get?: never; + put?: never; + /** Reports business event */ + post: operations["report"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/public/configuration-properties": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - ApiKeyWithLanguagesModel: { - description: string; - /** Format: int64 */ - expiresAt?: number; - /** Format: int64 */ - id: number; - /** Format: int64 */ - lastUsedAt?: number; - /** - * @deprecated - * @description Languages for which user has translate permission. - */ - permittedLanguageIds?: number[]; - /** Format: int64 */ - projectId: number; - projectName: string; - scopes: string[]; - userFullName?: string; - username?: string; + /** @description Return server configuration properties documentation */ + get: operations["get_3"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/public/export-info/formats": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - AuthMethodsDTO: { - github: components["schemas"]["OAuthPublicConfigDTO"]; - google: components["schemas"]["OAuthPublicConfigDTO"]; - oauth2: components["schemas"]["OAuthPublicExtendsConfigDTO"]; - ssoGlobal: components["schemas"]["SsoGlobalPublicConfigDTO"]; - ssoOrganizations: components["schemas"]["SsoOrganizationsPublicConfigDTO"]; + get: operations["get_2"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/public/initial-data": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - AuthProviderDto: { - /** @enum {string} */ - accountType?: "LOCAL" | "MANAGED" | "THIRD_PARTY"; - /** @enum {string} */ - authType?: "GOOGLE" | "GITHUB" | "OAUTH2" | "SSO" | "SSO_GLOBAL"; - ssoDomain?: string; + /** + * Get initial data + * @description Returns initial data required by the UI to load + */ + get: operations["get_1"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/public/llm/prompt": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - AutoTranslationConfigModel: { - /** @description If true, import will trigger batch operation to translate the new new keys. - * It includes also the data imported via CLI, Figma, or other integrations using batch key import. */ - enableForImport: boolean; - /** Format: int64 */ - languageId?: number; - /** @description If true, new keys will be automatically translated via batch operationusing primary machine translation service.When "usingTranslationMemory" is enabled, it tries to translate it with translation memory first. */ - usingMachineTranslation: boolean; - /** @description If true, new keys will be automatically translated via batch operation using translation memory when 100% match is found */ - usingTranslationMemory: boolean; + get?: never; + put?: never; + post: operations["prompt"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/public/machine-translation-providers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - AutoTranslationSettingsDto: { - /** @description If true, import will trigger batch operation to translate the new new keys. - * It includes also the data imported via CLI, Figma, or other integrations using batch key import. */ - enableForImport: boolean; - /** Format: int64 */ - languageId?: number; - /** @description If true, new keys will be automatically translated via batch operationusing primary machine translation service.When "usingTranslationMemory" is enabled, it tries to translate it with translation memory first. */ - usingMachineTranslation: boolean; - /** @description If true, new keys will be automatically translated via batch operation using translation memory when 100% match is found */ - usingTranslationMemory: boolean; + /** + * Returns information about supported translation providers + * @description Get machine translation providers + */ + get: operations["getInfo_4"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/public/scope-info/hierarchy": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - Avatar: { - large: string; - thumbnail: string; + /** Returns hierarchy of scopes */ + get: operations["getHierarchy"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/public/scope-info/roles": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - AverageProportionalUsageItemModel: { - total: number; - unusedQuantity: number; - usedQuantity: number; - usedQuantityOverPlan: number; + /** Returns user roles and their scopes */ + get: operations["getRoles"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/public/slack": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - AzureContentStorageConfigDto: { - connectionString?: string; - containerName: string; + get?: never; + put?: never; + post: operations["slackCommand"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/public/slack/on-bot-event": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - AzureContentStorageConfigModel: { - containerName?: string; + get?: never; + put?: never; + /** + * On bot event + * @description This is triggered when bot event is triggered. E.g., when app is uninstalled from workspace. + * + * Heads up! The events have to be configured via Slack App configuration in Event Subscription section. + */ + post: operations["fetchBotEvent"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/public/slack/on-event": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - BatchJobModel: { - /** - * Format: int64 - * @description The activity revision id, that stores the activity details of the job - */ - activityRevisionId?: number; - author?: components["schemas"]["SimpleUserAccountModel"]; - /** - * Format: int64 - * @description The time when the job created - */ - createdAt: number; - /** @description If the job failed, this is the error message */ - errorMessage?: string; - /** - * Format: int64 - * @description Batch job id - */ - id: number; - /** - * Format: int32 - * @description Total items, that have been processed so far - */ - progress: number; - /** - * @description Status of the batch job - * @enum {string} - */ - status: "PENDING" | "RUNNING" | "SUCCESS" | "FAILED" | "CANCELLED" | "DEBOUNCED"; - /** - * Format: int32 - * @description Total items - */ - totalItems: number; - /** - * @description Type of the batch job - * @enum {string} - */ - type: "PRE_TRANSLATE_BT_TM" | "MACHINE_TRANSLATE" | "AUTO_TRANSLATE" | "DELETE_KEYS" | "SET_TRANSLATIONS_STATE" | "CLEAR_TRANSLATIONS" | "COPY_TRANSLATIONS" | "TAG_KEYS" | "UNTAG_KEYS" | "SET_KEYS_NAMESPACE" | "AUTOMATION" | "BILLING_TRIAL_EXPIRATION_NOTICE"; - /** - * Format: int64 - * @description The time when the job was last updated (status change) - */ - updatedAt: number; - }; - BigMetaDto: { - /** @description Keys in the document used as a context for machine translation. Keys in the same order as they appear in the document. The order is important! We are using it for graph distance calculation. */ - relatedKeysInOrder?: components["schemas"]["RelatedKeyDto"][]; - }; - BusinessEventReportRequest: { - anonymousUserId?: string; - data?: { - [key: string]: Record; - }; - eventName: string; - /** Format: int64 */ - organizationId?: number; - /** Format: int64 */ - projectId?: number; - }; - CalculateScopeRequest: { - keys: number[]; - /** Format: int64 */ - languageId: number; - /** @enum {string} */ - type: "TRANSLATE" | "REVIEW"; + get?: never; + put?: never; + /** + * On interactivity event + * @description This is triggered when interactivity event is triggered. E.g., when user clicks button provided in previous messages. + */ + post: operations["onInteractivityEvent"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/quick-start/set-finished/{finished}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - ClearTranslationsRequest: { - keyIds: number[]; - languageIds: number[]; + get?: never; + /** + * Set finished state + * @description Sets finished state of the quick start guide + */ + put: operations["setFinishedState"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/quick-start/set-open/{open}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - CollectionModelAutoTranslationConfigModel: { - _embedded?: { - configs?: components["schemas"]["AutoTranslationConfigModel"][]; - }; + get?: never; + /** + * Set open state + * @description Sets open state of the quick start guide + */ + put: operations["setOpenState"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/quick-start/steps/{step}/complete": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - CollectionModelBatchJobModel: { - _embedded?: { - batchJobs?: components["schemas"]["BatchJobModel"][]; - }; + get?: never; + /** + * Complete guide step + * @description Marks guide step as completed + */ + put: operations["completeGuideStep"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/slack/user-login": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - CollectionModelExportFormatModel: { - _embedded?: { - exportFormats?: components["schemas"]["ExportFormatModel"][]; - }; + get?: never; + put?: never; + /** + * User login + * @description Pairs user account with slack account. + */ + post: operations["userLogin"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/slack/user-login-info": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - CollectionModelImportNamespaceModel: { - _embedded?: { - namespaces?: components["schemas"]["ImportNamespaceModel"][]; - }; + /** + * Returns connection info + * @description Returns information about the connection between Slack account and Tolgee account which user is performing. The flow is the following. + * + * 1. User executes slash command in Slack and gets link with encrypted Slack user ID, workspace ID and the Channel ID (to send success response to) + * + * 2. User gets opens the link and the Tolgee Platform frontend and it uses this endpoint to get the data info about the future connection + */ + get: operations["getInfo_3"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/slug/generate-organization": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - CollectionModelKeyDisabledLanguagesModel: { - _embedded?: { - keys?: components["schemas"]["KeyDisabledLanguagesModel"][]; - }; + get?: never; + put?: never; + /** Generate organization slug */ + post: operations["generateOrganizationSlug"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/slug/generate-project": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - CollectionModelKeyModel: { - _embedded?: { - keys?: components["schemas"]["KeyModel"][]; - }; + get?: never; + put?: never; + /** Generate project slug */ + post: operations["generateProjectSlug"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/slug/validate-organization/{slug}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - CollectionModelKeyWithBaseTranslationModel: { - _embedded?: { - keys?: components["schemas"]["KeyWithBaseTranslationModel"][]; - }; + /** Validate organization slug */ + get: operations["validateOrganizationSlug"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/slug/validate-project/{slug}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - CollectionModelKeyWithDataModel: { - _embedded?: { - keys?: components["schemas"]["KeyWithDataModel"][]; - }; - }; - CollectionModelLanguageAiPromptCustomizationModel: { - _embedded?: { - promptCustomizations?: components["schemas"]["LanguageAiPromptCustomizationModel"][]; - }; + /** Validate project slug */ + get: operations["validateProjectSlug"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - CollectionModelLanguageConfigItemModel: { - _embedded?: { - languageConfigs?: components["schemas"]["LanguageConfigItemModel"][]; - }; + /** + * Get user info + * @description Returns information about currently authenticated user. + */ + get: operations["getInfo_2"]; + /** + * Update user + * @description Updates current user's profile information. + */ + put: operations["updateUser"]; + /** + * Updates current user's data. + * @deprecated + */ + post: operations["updateUserOld"]; + /** Delete user */ + delete: operations["delete"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/user-preferences": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - CollectionModelLanguageInfoModel: { - _embedded?: { - languageInfos?: components["schemas"]["LanguageInfoModel"][]; - }; + /** Get user's preferences */ + get: operations["get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/user-preferences/set-language/{languageTag}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - CollectionModelLanguageModel: { - _embedded?: { - languages?: components["schemas"]["LanguageModel"][]; - }; + get?: never; + /** Set user's UI language */ + put: operations["setLanguage"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/user-preferences/set-preferred-organization/{organizationId}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - CollectionModelOrganizationInvitationModel: { - _embedded?: { - organizationInvitations?: components["schemas"]["OrganizationInvitationModel"][]; - }; + get?: never; + /** Set user preferred organization */ + put: operations["setPreferredOrganization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/user-tasks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - CollectionModelProjectInvitationModel: { - _embedded?: { - invitations?: components["schemas"]["ProjectInvitationModel"][]; - }; + /** Get user tasks */ + get: operations["getTasks"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/user/avatar": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - CollectionModelProjectTransferOptionModel: { - _embedded?: { - transferOptions?: components["schemas"]["ProjectTransferOptionModel"][]; - }; + get?: never; + /** Upload avatar */ + put: operations["uploadAvatar"]; + post?: never; + /** Delete avatar */ + delete: operations["removeAvatar"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/user/generate-super-token": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - CollectionModelScreenshotModel: { - _embedded?: { - screenshots?: components["schemas"]["ScreenshotModel"][]; - }; + get?: never; + put?: never; + /** + * Get super JWT + * @description Generates new JWT token permitted to sensitive operations + */ + post: operations["getSuperToken"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/user/managed-by": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - CollectionModelSimpleOrganizationModel: { - _embedded?: { - organizations?: components["schemas"]["SimpleOrganizationModel"][]; - }; + /** + * Get organization which manages user + * @description Returns the organization that manages a given user or null + */ + get: operations["getManagedBy"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/user/mfa/recovery": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - CollectionModelUsedNamespaceModel: { - _embedded?: { - namespaces?: components["schemas"]["UsedNamespaceModel"][]; - }; + get?: never; + /** + * Regenerate Codes + * @description Regenerates multi-factor authentication recovery codes + */ + put: operations["regenerateRecoveryCodes"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/user/mfa/totp": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - CollectionModelWorkspaceModel: { - _embedded?: { - workspaces?: components["schemas"]["WorkspaceModel"][]; - }; + get?: never; + /** + * Enable TOTP + * @description Enables TOTP-based two-factor authentication. Invalidates all previous sessions upon success. + */ + put: operations["enableMfa"]; + post?: never; + /** + * Disable TOTP + * @description Disables TOTP-based two-factor authentication. Invalidates all previous sessions upon success. + */ + delete: operations["disableMfa"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/user/password": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - ComplexEditKeyDto: { - /** @description Custom values of the key. If not provided, custom values won't be modified */ - custom?: { - [key: string]: Record; - }; - /** @description Description of the key. It's also used as a context for Tolgee AI translator */ - description?: string; - /** @description If key is pluralized. If it will be reflected in the editor. If null, value won't be modified. */ - isPlural?: boolean; - /** @description Name of the key */ - name: string; - namespace?: string; - /** @description The argument name for the plural. If null, value won't be modified. If isPlural is false, this value will be ignored. */ - pluralArgName?: string; - /** @description Keys in the document used as a context for machine translation. Keys in the same order as they appear in the document. The order is important! We are using it for graph distance calculation. */ - relatedKeysInOrder?: components["schemas"]["RelatedKeyDto"][]; - /** @description IDs of screenshots to delete */ - screenshotIdsToDelete?: number[]; - /** @description Ids of screenshots uploaded with /v2/image-upload endpoint */ - screenshotUploadedImageIds?: number[]; - screenshotsToAdd?: components["schemas"]["KeyScreenshotDto"][]; - /** @description Translation states to update, if not provided states won't be modified */ - states?: { - [key: string]: "TRANSLATED" | "REVIEWED"; - }; - /** @description Tags of the key. If not provided tags won't be modified */ - tags?: string[]; - /** @description Translations to update */ - translations?: { - [key: string]: string; - }; - /** @description If true, it will fail with 400 (with code plural_forms_data_loss) if plural is disabled and there are plural forms, which would be lost by the action. You can get rid of this warning by setting this value to false. */ - warnOnDataLoss?: boolean; + get?: never; + /** + * Update password + * @description Updates current user's password. Invalidates all previous sessions upon success. + */ + put: operations["updateUserPassword"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/user/send-email-verification": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - ComplexTagKeysRequest: { - /** @description Include keys filtered by the provided key information */ - filterKeys?: components["schemas"]["KeyId"][]; - /** @description Exclude keys filtered by the provided key information */ - filterKeysNot?: components["schemas"]["KeyId"][]; - /** @description Include keys filtered by the provided tag information. This filter supports wildcards. For example, `draft-*` will match all tags starting with `draft-`. */ - filterTag?: string[]; - /** @description Exclude keys filtered by the provided tag information. This filter supports wildcards. For example, `draft-*` will match all tags starting with `draft-`. */ - filterTagNot?: string[]; - /** @description Specified tags will be added to filtered keys */ - tagFiltered?: string[]; - /** @description Specified tags will be added to keys not filtered by any of the specified filters. */ - tagOther?: string[]; - /** @description Specified tags will be removed from filtered keys. It supports wildcards. For example, `draft-*` will remove all tags starting with `draft-`. */ - untagFiltered?: string[]; - /** @description Specified tags will be removed from keys not filtered by any of the specified filters. It supports wildcards. For example, `draft-*` will remove all tags starting with `draft-`. */ - untagOther?: string[]; + get?: never; + put?: never; + /** + * Resend email verification + * @description Resends email verification email to currently authenticated user. + */ + post: operations["sendEmailVerification"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/user/single-owned-organizations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - ComputedPermissionModel: { + /** + * Get all single owned organizations + * @description Returns all organizations owned only by current user + */ + get: operations["getAllSingleOwnedOrganizations"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/user/sso": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get information about SSO configuration + * @description Returns information about sso configuration affecting the user. + */ + get: operations["getSso"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; +} +export type webhooks = Record; +export interface components { + schemas: { + AcceptAuthProviderChangeRequest: { + id: string; + }; + AiPlaygroundResultModel: { + contextDescription?: string; + /** Format: int64 */ + keyId: number; + /** Format: int64 */ + languageId: number; + translation?: string; + }; + AiPlaygroundResultRequest: { + keys: number[]; + languages: number[]; + }; + AnnouncementDto: { /** @enum {string} */ - origin: "ORGANIZATION_BASE" | "DIRECT" | "ORGANIZATION_OWNER" | "NONE" | "SERVER_ADMIN"; - permissionModel?: components["schemas"]["PermissionModel"]; + type: "FEATURE_BATCH_OPERATIONS" | "FEATURE_MT_FORMALITY" | "FEATURE_CONTENT_DELIVERY_AND_WEBHOOKS" | "NEW_PRICING" | "FEATURE_AI_CUSTOMIZATION" | "FEATURE_VISUAL_EDITOR" | "FEATURE_CLI_2" | "FEATURE_TASKS" | "FEATURE_LLM_PROVIDERS_AND_PLAYGROUND" | "FEATURE_GLOSSARIES_AND_PLAYGROUND" | "FEATURE_LABELS"; + }; + ApiKeyModel: { + /** @description Description */ + description: string; /** - * @deprecated - * @description Deprecated (use translateLanguageIds). - * - * List of languages current user has TRANSLATE permission to. If null, all languages edition is permitted. + * Format: int64 + * @description Timestamp of API key expiraion + */ + expiresAt?: number; + /** + * Format: int64 + * @description ID of the API key + */ + id: number; + /** + * Format: int64 + * @description Timestamp of API key last usage + */ + lastUsedAt?: number; + /** + * Format: int64 + * @description Api key's project ID + */ + projectId: number; + /** @description Api key's project name */ + projectName: string; + /** + * @description Api key's permission scopes * @example [ - * 200001, - * 200004 + * "screenshots.upload", + * "screenshots.delete", + * "translations.edit", + * "screenshots.view", + * "translations.view", + * "keys.edit" * ] */ - permittedLanguageIds?: number[]; + scopes: string[]; + /** @description Full name of user owner */ + userFullName?: string; + /** @description Username of user owner */ + username?: string; + }; + ApiKeyPermissionsModel: { + project: components["schemas"]["SimpleProjectModel"]; + /** + * Format: int64 + * @description The API key's project id or the one provided as query param + */ + projectId: number; /** * @description Granted scopes to the user. When user has type permissions, this field contains permission scopes of the type. * @example [ @@ -4639,7 +5069,7 @@ export interface components { * "TRANSLATIONS_VIEW" * ] */ - scopes: ("translations.view" | "translations.edit" | "keys.edit" | "screenshots.upload" | "screenshots.delete" | "screenshots.view" | "activity.view" | "languages.edit" | "admin" | "project.edit" | "members.view" | "members.edit" | "translation-comments.add" | "translation-comments.edit" | "translation-comments.set-state" | "translations.state-edit" | "keys.view" | "keys.delete" | "keys.create" | "batch-jobs.view" | "batch-jobs.cancel" | "translations.batch-by-tm" | "translations.batch-machine" | "content-delivery.manage" | "content-delivery.publish" | "webhooks.manage" | "tasks.view" | "tasks.edit")[]; + scopes: ("translations.view" | "translations.edit" | "keys.edit" | "screenshots.upload" | "screenshots.delete" | "screenshots.view" | "activity.view" | "languages.edit" | "admin" | "project.edit" | "members.view" | "members.edit" | "translation-comments.add" | "translation-comments.edit" | "translation-comments.set-state" | "translations.state-edit" | "keys.view" | "keys.delete" | "keys.create" | "batch-jobs.view" | "batch-jobs.cancel" | "translations.batch-by-tm" | "translations.batch-machine" | "content-delivery.manage" | "content-delivery.publish" | "webhooks.manage" | "tasks.view" | "tasks.edit" | "prompts.view" | "prompts.edit" | "translation-labels.manage" | "translation-labels.assign")[]; /** * @description List of languages user can change state to. If null, changing state of all language values is permitted. * @example [ @@ -4657,7 +5087,7 @@ export interface components { */ translateLanguageIds?: number[]; /** - * @description The user's permission type. This field is null if uses granular permissions + * @description The user's permission type. This field is null if user has assigned granular permissions or if returning API key's permissions * @enum {string} */ type?: "NONE" | "VIEW" | "TRANSLATE" | "REVIEW" | "EDIT" | "MANAGE"; @@ -4670,1323 +5100,1989 @@ export interface components { */ viewLanguageIds?: number[]; }; - ConnectToSlackDto: { - code: string; - }; - ConnectToSlackUrlModel: { - url: string; - }; - ContentDeliveryConfigModel: { - autoPublish: boolean; - /** @description This is a template that defines the structure of the resulting .zip file content. - * - * The template is a string that can contain the following placeholders: {namespace}, {languageTag}, - * {androidLanguageTag}, {snakeLanguageTag}, {extension}. - * - * For example, when exporting to JSON with the template `{namespace}/{languageTag}.{extension}`, - * the English translations of the `home` namespace will be stored in `home/en.json`. - * - * The `{snakeLanguageTag}` placeholder is the same as `{languageTag}` but in snake case. (e.g., en_US). - * - * The Android specific `{androidLanguageTag}` placeholder is the same as `{languageTag}` - * but in Android format. (e.g., en-rUS) - * */ - fileStructureTemplate?: string; - /** @description Filter key IDs to be contained in export */ - filterKeyId?: number[]; - /** @description Filter key IDs not to be contained in export */ - filterKeyIdNot?: number[]; - /** @description Filter keys with prefix */ - filterKeyPrefix?: string; - /** @description Filter translations with namespace. By default, all namespaces everything are exported. To export default namespace, use empty string. */ - filterNamespace?: string[]; - /** @description Filter translations with state. By default, all states except untranslated is exported. */ - filterState?: ("UNTRANSLATED" | "TRANSLATED" | "REVIEWED" | "DISABLED")[]; - /** @description Filter keys tagged by. - * - * This filter works the same as `filterTagIn` but in this cases it accepts single tag only. */ - filterTag?: string; - /** @description Filter keys tagged by one of provided tags */ - filterTagIn?: string[]; - /** @description Filter keys not tagged by one of provided tags */ - filterTagNotIn?: string[]; - /** - * @description Format to export to - * @enum {string} - */ - format: "JSON" | "JSON_TOLGEE" | "XLIFF" | "PO" | "APPLE_STRINGS_STRINGSDICT" | "APPLE_XLIFF" | "ANDROID_XML" | "COMPOSE_XML" | "FLUTTER_ARB" | "PROPERTIES" | "YAML_RUBY" | "YAML" | "JSON_I18NEXT" | "CSV" | "RESX_ICU" | "XLSX" | "APPLE_XCSTRINGS"; + ApiKeyWithLanguagesModel: { + description: string; + /** Format: int64 */ + expiresAt?: number; /** Format: int64 */ id: number; - /** - * @description Languages to be contained in export. - * - * If null, all languages are exported - * @example en - */ - languages?: string[]; /** Format: int64 */ - lastPublished?: number; - lastPublishedFiles: string[]; + lastUsedAt?: number; /** - * @description Message format to be used for export. - * - * e.g. PHP_PO: Hello %s, ICU: Hello {name}. - * - * This property is honored only for generic formats like JSON or YAML. - * For specific formats like `YAML_RUBY` it's ignored. - * @enum {string} + * @deprecated + * @description Languages for which user has translate permission. */ - messageFormat?: "C_SPRINTF" | "PHP_SPRINTF" | "JAVA_STRING_FORMAT" | "APPLE_SPRINTF" | "RUBY_SPRINTF" | "I18NEXT" | "ICU" | "PYTHON_PERCENT"; - name: string; - pruneBeforePublish: boolean; - publicUrl?: string; - slug: string; - storage?: components["schemas"]["ContentStorageModel"]; - /** @description Delimiter to structure file content. - * - * e.g. For key "home.header.title" would result in {"home": {"header": "title": {"Hello"}}} structure. - * - * When null, resulting file won't be structured. Works only for generic structured formats (e.g. JSON, YAML), - * specific formats like `YAML_RUBY` don't honor this parameter. */ - structureDelimiter?: string; - /** @description If true, for structured formats (like JSON) arrays are supported. - * - * e.g. Key hello[0] will be exported as {"hello": ["..."]} */ - supportArrays: boolean; + permittedLanguageIds?: number[]; + /** Format: int64 */ + projectId: number; + projectName: string; + scopes: string[]; + userFullName?: string; + username?: string; }; - ContentDeliveryConfigRequest: { - /** @description If true, data are published to the content delivery automatically after each change. */ - autoPublish: boolean; + AuthMethodsDTO: { + github: components["schemas"]["OAuthPublicConfigDTO"]; + google: components["schemas"]["OAuthPublicConfigDTO"]; + oauth2: components["schemas"]["OAuthPublicExtendsConfigDTO"]; + ssoGlobal: components["schemas"]["SsoGlobalPublicConfigDTO"]; + ssoOrganizations: components["schemas"]["SsoOrganizationsPublicConfigDTO"]; + }; + AuthProviderDto: { + /** @enum {string} */ + authType?: "GOOGLE" | "GITHUB" | "OAUTH2" | "SSO" | "SSO_GLOBAL"; + id?: string; + ssoDomain?: string; + }; + AutoTranslationConfigModel: { + /** @description If true, import will trigger batch operation to translate the new new keys. + * It includes also the data imported via CLI, Figma, or other integrations using batch key import. */ + enableForImport: boolean; + /** Format: int64 */ + languageId?: number; + /** @description If true, new keys will be automatically translated via batch operationusing primary machine translation service.When "usingTranslationMemory" is enabled, it tries to translate it with translation memory first. */ + usingMachineTranslation: boolean; + /** @description If true, new keys will be automatically translated via batch operation using translation memory when 100% match is found */ + usingTranslationMemory: boolean; + }; + AutoTranslationSettingsDto: { + /** @description If true, import will trigger batch operation to translate the new new keys. + * It includes also the data imported via CLI, Figma, or other integrations using batch key import. */ + enableForImport: boolean; + /** Format: int64 */ + languageId?: number; + /** @description If true, new keys will be automatically translated via batch operationusing primary machine translation service.When "usingTranslationMemory" is enabled, it tries to translate it with translation memory first. */ + usingMachineTranslation: boolean; + /** @description If true, new keys will be automatically translated via batch operation using translation memory when 100% match is found */ + usingTranslationMemory: boolean; + }; + /** @example Links to avatar images */ + Avatar: { + large: string; + thumbnail: string; + }; + AverageProportionalUsageItemModel: { + total: number; + unusedQuantity: number; + usedQuantity: number; + usedQuantityOverPlan: number; + }; + AzureContentStorageConfigDto: { + connectionString?: string; + containerName: string; + }; + AzureContentStorageConfigModel: { + containerName?: string; + }; + BatchJobModel: { /** * Format: int64 - * @description Id of custom storage to use for content delivery. If null, default server storage is used. Tolgee Cloud provides default Content Storage. + * @description The activity revision id, that stores the activity details of the job */ - contentStorageId?: number; - /** @description This is a template that defines the structure of the resulting .zip file content. - * - * The template is a string that can contain the following placeholders: {namespace}, {languageTag}, - * {androidLanguageTag}, {snakeLanguageTag}, {extension}. - * - * For example, when exporting to JSON with the template `{namespace}/{languageTag}.{extension}`, - * the English translations of the `home` namespace will be stored in `home/en.json`. - * - * The `{snakeLanguageTag}` placeholder is the same as `{languageTag}` but in snake case. (e.g., en_US). - * - * The Android specific `{androidLanguageTag}` placeholder is the same as `{languageTag}` - * but in Android format. (e.g., en-rUS) - * */ - fileStructureTemplate?: string; - /** @description Filter key IDs to be contained in export */ - filterKeyId?: number[]; - /** @description Filter key IDs not to be contained in export */ - filterKeyIdNot?: number[]; - /** @description Filter keys with prefix */ - filterKeyPrefix?: string; - /** @description Filter translations with namespace. By default, all namespaces everything are exported. To export default namespace, use empty string. */ - filterNamespace?: string[]; - /** @description Filter translations with state. By default, all states except untranslated is exported. */ - filterState?: ("UNTRANSLATED" | "TRANSLATED" | "REVIEWED" | "DISABLED")[]; - /** @description Filter keys tagged by. - * - * This filter works the same as `filterTagIn` but in this cases it accepts single tag only. */ - filterTag?: string; - /** @description Filter keys tagged by one of provided tags */ - filterTagIn?: string[]; - /** @description Filter keys not tagged by one of provided tags */ - filterTagNotIn?: string[]; + activityRevisionId?: number; + author?: components["schemas"]["SimpleUserAccountModel"]; /** - * @description Format to export to + * Format: int64 + * @description The time when the job created + */ + createdAt: number; + /** @description If the job failed, this is the error message */ + errorMessage?: string; + /** + * Format: int64 + * @description Batch job id + */ + id: number; + /** + * Format: int32 + * @description Total items, that have been processed so far + */ + progress: number; + /** + * @description Status of the batch job * @enum {string} */ - format: "JSON" | "JSON_TOLGEE" | "XLIFF" | "PO" | "APPLE_STRINGS_STRINGSDICT" | "APPLE_XLIFF" | "ANDROID_XML" | "COMPOSE_XML" | "FLUTTER_ARB" | "PROPERTIES" | "YAML_RUBY" | "YAML" | "JSON_I18NEXT" | "CSV" | "RESX_ICU" | "XLSX" | "APPLE_XCSTRINGS"; + status: "PENDING" | "RUNNING" | "SUCCESS" | "FAILED" | "CANCELLED" | "DEBOUNCED"; /** - * @description Languages to be contained in export. - * - * If null, all languages are exported - * @example en + * Format: int32 + * @description Total items */ - languages?: string[]; + totalItems: number; /** - * @description Message format to be used for export. - * - * e.g. PHP_PO: Hello %s, ICU: Hello {name}. - * - * This property is honored only for generic formats like JSON or YAML. - * For specific formats like `YAML_RUBY` it's ignored. + * @description Type of the batch job * @enum {string} */ - messageFormat?: "C_SPRINTF" | "PHP_SPRINTF" | "JAVA_STRING_FORMAT" | "APPLE_SPRINTF" | "RUBY_SPRINTF" | "I18NEXT" | "ICU" | "PYTHON_PERCENT"; - name: string; - /** @description Whether the data in the CDN should be pruned before publishing new data. - * - * In some cases, you might want to keep the data in the storage and only replace the files created by following publish operation. */ - pruneBeforePublish: boolean; - /** @description Tolgee uses a custom slug as a directory name for content storage and public content delivery URL. It is only applicable for custom storage. This field needs to be kept null for Tolgee Cloud content storage or global server storage on self-hosted instances. - * - * Slag has to match following regular expression: `^[a-z0-9]+(?:-[a-z0-9]+)*$`. - * - * If null is provided for update operation, slug will be assigned with generated value. */ - slug?: string; - /** @description Delimiter to structure file content. - * - * e.g. For key "home.header.title" would result in {"home": {"header": "title": {"Hello"}}} structure. - * - * When null, resulting file won't be structured. Works only for generic structured formats (e.g. JSON, YAML), - * specific formats like `YAML_RUBY` don't honor this parameter. */ - structureDelimiter?: string; - /** @description If true, for structured formats (like JSON) arrays are supported. - * - * e.g. Key hello[0] will be exported as {"hello": ["..."]} */ - supportArrays: boolean; - }; - ContentStorageModel: { - azureContentStorageConfig?: components["schemas"]["AzureContentStorageConfigModel"]; - /** Format: int64 */ - id: number; - name: string; - publicUrlPrefix?: string; - s3ContentStorageConfig?: components["schemas"]["S3ContentStorageConfigModel"]; - }; - ContentStorageRequest: { - azureContentStorageConfig?: components["schemas"]["AzureContentStorageConfigDto"]; - name: string; - publicUrlPrefix?: string; - s3ContentStorageConfig?: components["schemas"]["S3ContentStorageConfigDto"]; - }; - CopyTranslationRequest: { - keyIds: number[]; - /** Format: int64 */ - sourceLanguageId: number; - targetLanguageIds: number[]; - }; - CreateApiKeyDto: { - /** @description Description of the project API key */ - description?: string; + type: "AI_PLAYGROUND_TRANSLATE" | "PRE_TRANSLATE_BT_TM" | "MACHINE_TRANSLATE" | "AUTO_TRANSLATE" | "DELETE_KEYS" | "SET_TRANSLATIONS_STATE" | "CLEAR_TRANSLATIONS" | "COPY_TRANSLATIONS" | "TAG_KEYS" | "UNTAG_KEYS" | "SET_KEYS_NAMESPACE" | "AUTOMATION" | "BILLING_TRIAL_EXPIRATION_NOTICE" | "ASSIGN_TRANSLATION_LABEL" | "UNASSIGN_TRANSLATION_LABEL"; /** * Format: int64 - * @description Expiration date in epoch format (milliseconds). When null key never expires. - * @example 1661172869000 + * @description The time when the job was last updated (status change) */ - expiresAt?: number; - /** Format: int64 */ - projectId: number; - scopes: string[]; + updatedAt: number; }; - CreateKeyDto: { - /** - * @description Description of the key - * @example This key is used on homepage. It's a label of sign up button. - */ - description?: string; - /** @description If key is pluralized. If it will be reflected in the editor */ - isPlural: boolean; - /** @description Name of the key */ - name: string; - namespace?: string; - /** @description The argument name for the plural. If null, value will be guessed from the values provided in translations. */ - pluralArgName?: string; + BigMetaDto: { /** @description Keys in the document used as a context for machine translation. Keys in the same order as they appear in the document. The order is important! We are using it for graph distance calculation. */ relatedKeysInOrder?: components["schemas"]["RelatedKeyDto"][]; - /** @description Ids of screenshots uploaded with /v2/image-upload endpoint */ - screenshotUploadedImageIds?: number[]; - screenshots?: components["schemas"]["KeyScreenshotDto"][]; - /** @description Translation states to update, if not provided states won't be modified */ - states?: { - [key: string]: "TRANSLATED" | "REVIEWED"; - }; - tags?: string[]; - translations?: { - [key: string]: string; + }; + BusinessEventReportRequest: { + anonymousUserId?: string; + data?: { + [key: string]: Record; }; + eventName: string; + /** Format: int64 */ + organizationId?: number; + /** Format: int64 */ + projectId?: number; }; - CreateMultipleTasksRequest: { - tasks: components["schemas"]["CreateTaskRequest"][]; + CalculateScopeRequest: { + keys: number[]; + /** Format: int64 */ + languageId: number; + /** @enum {string} */ + type: "TRANSLATE" | "REVIEW"; }; - CreatePatDto: { - /** @description Description of the PAT */ - description: string; - /** - * Format: int64 - * @description Expiration date in epoch format (milliseconds). When null, token never expires. - * @example 1661172869000 - */ - expiresAt?: number; + ClearTranslationsRequest: { + keyIds: number[]; + languageIds: number[]; }; - CreateProjectRequest: { - /** @description Tag of one of created languages, to select it as base language. If not provided, first language will be selected as base. */ - baseLanguageTag?: string; - /** @description Whether to use ICU placeholder visualization in the editor and it's support. */ - icuPlaceholders: boolean; - languages: components["schemas"]["LanguageRequest"][]; - name: string; - /** - * Format: int64 - * @description Organization to create the project in - */ - organizationId: number; - /** @description Slug of your project used in url e.g. "/v2/projects/what-a-project". If not provided, it will be generated */ - slug?: string; - }; - CreateProviderRequest: { - authorizationUri: string; - clientId: string; - clientSecret: string; - domain: string; - enabled: boolean; - force: boolean; - tokenUri: string; + CollectionModelAiPlaygroundResultModel: { + _embedded?: { + results?: components["schemas"]["AiPlaygroundResultModel"][]; + }; }; - CreateTaskRequest: { - assignees: number[]; - description: string; - /** - * Format: int64 - * @description Due to date in epoch format (milliseconds). - * @example 1661172869000 - */ - dueDate?: number; - keys: number[]; - /** - * Format: int64 - * @description Id of language, this task is attached to. - * @example 1 - */ - languageId: number; - name: string; - /** @enum {string} */ - type: "TRANSLATE" | "REVIEW"; + CollectionModelAutoTranslationConfigModel: { + _embedded?: { + configs?: components["schemas"]["AutoTranslationConfigModel"][]; + }; }; - CreditBalanceModel: { - /** Format: int64 */ - bucketSize: number; - /** Format: int64 */ - creditBalance: number; - /** - * Format: int64 - * @deprecated - * @description Customers were able to buy extra credits separately in the past. - * - * This option is not available anymore and this field is kept only for backward compatibility purposes and is always 0. - */ - extraCreditBalance: number; + CollectionModelBatchJobModel: { + _embedded?: { + batchJobs?: components["schemas"]["BatchJobModel"][]; + }; }; - DeleteKeysDto: { - /** @description IDs of keys to delete */ - ids: number[]; + CollectionModelExportFormatModel: { + _embedded?: { + exportFormats?: components["schemas"]["ExportFormatModel"][]; + }; }; - DeleteKeysRequest: { - keyIds: number[]; + CollectionModelGlossaryLanguageDto: { + _embedded?: { + glossaryLanguageDtoList?: components["schemas"]["GlossaryLanguageDto"][]; + }; }; - DocItem: { - description?: string; - displayName?: string; - name: string; + CollectionModelGlossaryTermHighlightModel: { + _embedded?: { + glossaryHighlights?: components["schemas"]["GlossaryTermHighlightModel"][]; + }; }; - DomainRequest: { - domain: string; - state: string; + CollectionModelImportNamespaceModel: { + _embedded?: { + namespaces?: components["schemas"]["ImportNamespaceModel"][]; + }; }; - EditKeyDto: { - /** - * @description Description of the key - * @example This key is used on homepage. It's a label of sign up button. - */ - description?: string; - name: string; - namespace?: string; + CollectionModelKeyDisabledLanguagesModel: { + _embedded?: { + keys?: components["schemas"]["KeyDisabledLanguagesModel"][]; + }; }; - EditProjectRequest: { - /** Format: int64 */ - baseLanguageId?: number; - /** Format: int64 */ - defaultNamespaceId?: number; - description?: string; - /** @description Whether to use ICU placeholder visualization in the editor and it's support. */ - icuPlaceholders: boolean; - name: string; - slug?: string; - useNamespaces: boolean; + CollectionModelKeyModel: { + _embedded?: { + keys?: components["schemas"]["KeyModel"][]; + }; }; - EeSubscriptionModel: { - cancelAtPeriodEnd: boolean; - /** Format: int64 */ - currentPeriodEnd?: number; - /** Format: int64 */ - currentUserCount: number; - enabledFeatures: ("GRANULAR_PERMISSIONS" | "PRIORITIZED_FEATURE_REQUESTS" | "PREMIUM_SUPPORT" | "DEDICATED_SLACK_CHANNEL" | "ASSISTED_UPDATES" | "DEPLOYMENT_ASSISTANCE" | "BACKUP_CONFIGURATION" | "TEAM_TRAINING" | "ACCOUNT_MANAGER" | "STANDARD_SUPPORT" | "PROJECT_LEVEL_CONTENT_STORAGES" | "WEBHOOKS" | "MULTIPLE_CONTENT_DELIVERY_CONFIGS" | "AI_PROMPT_CUSTOMIZATION" | "SLACK_INTEGRATION" | "TASKS" | "SSO" | "ORDER_TRANSLATION")[]; - /** Format: date-time */ - lastValidCheck?: string; - licenseKey: string; - name: string; - nonCommerical: boolean; - /** @enum {string} */ - status: "ACTIVE" | "CANCELED" | "PAST_DUE" | "UNPAID" | "ERROR" | "TRIALING" | "KEY_USED_BY_ANOTHER_INSTANCE" | "UNKNOWN"; + CollectionModelKeyWithBaseTranslationModel: { + _embedded?: { + keys?: components["schemas"]["KeyWithBaseTranslationModel"][]; + }; }; - EntityDescriptionWithRelations: { - data: { - [key: string]: Record; + CollectionModelKeyWithDataModel: { + _embedded?: { + keys?: components["schemas"]["KeyWithDataModel"][]; }; - entityClass: string; - /** Format: int64 */ - entityId: number; }; - ErrorResponseBody: { - code: string; - params?: Record[]; + CollectionModelLanguageAiPromptCustomizationModel: { + _embedded?: { + promptCustomizations?: components["schemas"]["LanguageAiPromptCustomizationModel"][]; + }; }; - ErrorResponseTyped: { - /** @enum {string} */ - code: "unauthenticated" | "api_access_forbidden" | "api_key_not_found" | "invalid_api_key" | "invalid_project_api_key" | "project_api_key_expired" | "bad_credentials" | "mfa_enabled" | "invalid_otp_code" | "mfa_not_enabled" | "can_not_revoke_own_permissions" | "data_corrupted" | "invitation_code_does_not_exist_or_expired" | "language_tag_exists" | "language_name_exists" | "language_not_found" | "operation_not_permitted" | "registrations_not_allowed" | "project_not_found" | "resource_not_found" | "scope_not_found" | "key_exists" | "third_party_auth_error_message" | "third_party_auth_no_email" | "third_party_auth_non_matching_email" | "third_party_auth_no_sub" | "third_party_auth_unknown_error" | "email_already_verified" | "third_party_unauthorized" | "third_party_google_workspace_mismatch" | "third_party_switch_initiated" | "username_already_exists" | "username_or_password_invalid" | "user_already_has_permissions" | "user_already_has_role" | "user_not_found" | "file_not_image" | "file_too_big" | "invalid_timestamp" | "email_not_verified" | "missing_callback_url" | "invalid_jwt_token" | "expired_jwt_token" | "general_jwt_error" | "cannot_find_suitable_address_part" | "slug_not_unique" | "user_is_not_member_of_organization" | "organization_has_no_other_owner" | "user_has_no_project_access" | "user_is_organization_owner" | "cannot_set_your_own_permissions" | "user_is_organization_member" | "property_not_mutable" | "import_language_not_from_project" | "existing_language_not_selected" | "conflict_is_not_resolved" | "language_already_selected" | "cannot_parse_file" | "could_not_resolve_property" | "cannot_add_more_then_100_languages" | "no_languages_provided" | "language_with_base_language_tag_not_found" | "language_not_from_project" | "namespace_not_from_project" | "cannot_delete_base_language" | "key_not_from_project" | "max_screenshots_exceeded" | "translation_not_from_project" | "can_edit_only_own_comment" | "request_parse_error" | "filter_by_value_state_not_valid" | "import_has_expired" | "tag_not_from_project" | "translation_text_too_long" | "invalid_recaptcha_token" | "cannot_leave_owning_project" | "cannot_leave_project_with_organization_role" | "dont_have_direct_permissions" | "tag_too_log" | "too_many_uploaded_images" | "one_or_more_images_not_found" | "screenshot_not_of_key" | "service_not_found" | "too_many_requests" | "translation_not_found" | "out_of_credits" | "key_not_found" | "organization_not_found" | "cannot_find_base_language" | "base_language_not_found" | "no_exported_result" | "cannot_set_your_own_role" | "only_translate_review_or_view_permission_accepts_view_languages" | "oauth2_token_url_not_set" | "oauth2_user_url_not_set" | "email_already_invited_or_member" | "price_not_found" | "invoice_not_from_organization" | "invoice_not_found" | "plan_not_found" | "plan_not_available_any_more" | "no_auto_translation_method" | "cannot_translate_base_language" | "pat_not_found" | "invalid_pat" | "pat_expired" | "operation_unavailable_for_account_type" | "validation_email_is_not_valid" | "current_password_required" | "cannot_create_organization" | "wrong_current_password" | "wrong_param_type" | "expired_super_jwt_token" | "cannot_delete_your_own_account" | "cannot_sort_by_this_column" | "namespace_not_found" | "namespace_exists" | "invalid_authentication_method" | "unknown_sort_property" | "only_review_permission_accepts_state_change_languages" | "only_translate_or_review_permission_accepts_translate_languages" | "cannot_set_language_permissions_for_admin_scope" | "cannot_set_view_languages_without_translations_view_scope" | "cannot_set_translate_languages_without_translations_edit_scope" | "cannot_set_state_change_languages_without_translations_state_edit_scope" | "language_not_permitted" | "scopes_has_to_be_set" | "set_exactly_one_of_scopes_or_type" | "translation_exists" | "import_keys_error" | "provide_only_one_of_screenshots_and_screenshot_uploaded_image_ids" | "multiple_projects_not_supported" | "plan_translation_limit_exceeded" | "feature_not_enabled" | "license_key_not_found" | "cannot_set_view_languages_without_for_level_based_permissions" | "cannot_set_different_translate_and_state_change_languages_for_level_based_permissions" | "cannot_disable_your_own_account" | "subscription_not_found" | "invoice_does_not_have_usage" | "customer_not_found" | "subscription_not_active" | "organization_already_subscribed" | "organization_not_subscribed" | "license_key_used_by_another_instance" | "translation_spending_limit_exceeded" | "credit_spending_limit_exceeded" | "seats_spending_limit_exceeded" | "this_instance_is_already_licensed" | "big_meta_not_from_project" | "mt_service_not_enabled" | "project_not_selected" | "organization_not_selected" | "plan_has_subscribers" | "translation_failed" | "batch_job_not_found" | "key_exists_in_namespace" | "tag_is_blank" | "execution_failed_on_management_error" | "translation_api_rate_limit" | "cannot_finalize_activity" | "formality_not_supported_by_service" | "language_not_supported_by_service" | "rate_limited" | "pat_access_not_allowed" | "pak_access_not_allowed" | "cannot_modify_disabled_translation" | "azure_config_required" | "s3_config_required" | "content_storage_config_required" | "content_storage_test_failed" | "content_storage_config_invalid" | "invalid_connection_string" | "cannot_create_azure_storage_client" | "s3_access_key_required" | "azure_connection_string_required" | "s3_secret_key_required" | "cannot_store_file_to_content_storage" | "unexpected_error_while_publishing_to_content_storage" | "webhook_responded_with_non_200_status" | "unexpected_error_while_executing_webhook" | "content_storage_is_in_use" | "cannot_set_state_for_missing_translation" | "no_project_id_provided" | "license_key_not_provided" | "subscription_already_canceled" | "user_is_subscribed_to_paid_plan" | "cannot_create_free_plan_without_fixed_type" | "cannot_modify_plan_free_status" | "key_id_not_provided" | "free_self_hosted_seat_limit_exceeded" | "advanced_params_not_supported" | "plural_forms_not_found_for_language" | "nested_plurals_not_supported" | "message_is_not_plural" | "content_outside_plural_forms" | "invalid_plural_form" | "multiple_plurals_not_supported" | "custom_values_json_too_long" | "unsupported_po_message_format" | "plural_forms_data_loss" | "current_user_does_not_own_image" | "user_cannot_view_this_organization" | "user_is_not_owner_of_organization" | "pak_created_for_different_project" | "custom_slug_is_only_applicable_for_custom_storage" | "invalid_slug_format" | "batch_job_cancellation_timeout" | "import_failed" | "cannot_add_more_then_1000_languages" | "no_data_to_import" | "multiple_namespaces_mapped_to_single_file" | "multiple_mappings_for_same_file_language_name" | "multiple_mappings_for_null_file_language_name" | "too_many_mappings_for_file" | "missing_placeholder_in_template" | "tag_not_found" | "cannot_parse_encrypted_slack_login_data" | "slack_workspace_not_found" | "cannot_fetch_user_details_from_slack" | "slack_missing_scope" | "slack_not_connected_to_your_account" | "slack_invalid_command" | "slack_not_subscribed_yet" | "slack_connection_failed" | "tolgee_account_already_connected" | "slack_not_configured" | "slack_workspace_already_connected" | "slack_connection_error" | "email_verification_code_not_valid" | "cannot_subscribe_to_free_plan" | "plan_auto_assignment_only_for_free_plans" | "plan_auto_assignment_only_for_private_plans" | "task_not_found" | "task_not_finished" | "task_not_open" | "translation_agency_not_found" | "this_feature_is_not_implemented_in_oss" | "sso_token_exchange_failed" | "sso_user_info_retrieval_failed" | "sso_id_token_expired" | "sso_user_cannot_create_organization" | "sso_cant_verify_user" | "sso_auth_missing_domain" | "sso_domain_not_found_or_disabled" | "native_authentication_disabled" | "invitation_organization_mismatch" | "user_is_managed_by_organization" | "cannot_set_sso_provider_missing_fields" | "namespaces_cannot_be_disabled_when_namespace_exists" | "namespace_cannot_be_used_when_feature_is_disabled" | "sso_domain_not_allowed" | "sso_login_forced_for_this_account" | "date_has_to_be_in_the_future" | "custom_plan_and_plan_id_cannot_be_set_together" | "specify_plan_id_or_custom_plan" | "custom_plans_has_to_be_private" | "cannot_create_free_plan_with_prices" | "subscription_not_scheduled_for_cancellation" | "cannot_cancel_trial" | "cannot_update_without_modification" | "current_subscription_is_not_trialing"; - params?: Record[]; + CollectionModelLanguageConfigItemModel: { + _embedded?: { + languageConfigs?: components["schemas"]["LanguageConfigItemModel"][]; + }; }; - ExistenceEntityDescription: { - data: { - [key: string]: Record; + CollectionModelLanguageInfoModel: { + _embedded?: { + languageInfos?: components["schemas"]["LanguageInfoModel"][]; }; - entityClass: string; - /** Format: int64 */ - entityId: number; - exists?: boolean; - relations: { - [key: string]: components["schemas"]["EntityDescriptionWithRelations"]; + }; + CollectionModelLanguageModel: { + _embedded?: { + languages?: components["schemas"]["LanguageModel"][]; }; }; - ExportFormatModel: { - defaultFileStructureTemplate: string; - extension: string; - /** @enum {string} */ - format: "JSON" | "JSON_TOLGEE" | "XLIFF" | "PO" | "APPLE_STRINGS_STRINGSDICT" | "APPLE_XLIFF" | "ANDROID_XML" | "COMPOSE_XML" | "FLUTTER_ARB" | "PROPERTIES" | "YAML_RUBY" | "YAML" | "JSON_I18NEXT" | "CSV" | "RESX_ICU" | "XLSX" | "APPLE_XCSTRINGS"; - mediaType: string; + CollectionModelLlmProviderModel: { + _embedded?: { + providers?: components["schemas"]["LlmProviderModel"][]; + }; }; - ExportParams: { - /** @description This is a template that defines the structure of the resulting .zip file content. - * - * The template is a string that can contain the following placeholders: {namespace}, {languageTag}, - * {androidLanguageTag}, {snakeLanguageTag}, {extension}. - * - * For example, when exporting to JSON with the template `{namespace}/{languageTag}.{extension}`, - * the English translations of the `home` namespace will be stored in `home/en.json`. - * - * The `{snakeLanguageTag}` placeholder is the same as `{languageTag}` but in snake case. (e.g., en_US). - * - * The Android specific `{androidLanguageTag}` placeholder is the same as `{languageTag}` - * but in Android format. (e.g., en-rUS) - * */ - fileStructureTemplate?: string; - /** @description Filter key IDs to be contained in export */ - filterKeyId?: number[]; - /** @description Filter key IDs not to be contained in export */ - filterKeyIdNot?: number[]; - /** @description Filter keys with prefix */ - filterKeyPrefix?: string; - /** @description Filter translations with namespace. By default, all namespaces everything are exported. To export default namespace, use empty string. */ - filterNamespace?: string[]; - /** @description Filter translations with state. By default, all states except untranslated is exported. */ - filterState?: ("UNTRANSLATED" | "TRANSLATED" | "REVIEWED" | "DISABLED")[]; - /** @description Filter keys tagged by. - * - * This filter works the same as `filterTagIn` but in this cases it accepts single tag only. */ - filterTag?: string; - /** @description Filter keys tagged by one of provided tags */ - filterTagIn?: string[]; - /** @description Filter keys not tagged by one of provided tags */ - filterTagNotIn?: string[]; - /** - * @description Format to export to - * @enum {string} - */ - format: "JSON" | "JSON_TOLGEE" | "XLIFF" | "PO" | "APPLE_STRINGS_STRINGSDICT" | "APPLE_XLIFF" | "ANDROID_XML" | "COMPOSE_XML" | "FLUTTER_ARB" | "PROPERTIES" | "YAML_RUBY" | "YAML" | "JSON_I18NEXT" | "CSV" | "RESX_ICU" | "XLSX" | "APPLE_XCSTRINGS"; - /** - * @description Languages to be contained in export. - * - * If null, all languages are exported - * @example en - */ - languages?: string[]; - /** - * @description Message format to be used for export. - * - * e.g. PHP_PO: Hello %s, ICU: Hello {name}. - * - * This property is honored only for generic formats like JSON or YAML. - * For specific formats like `YAML_RUBY` it's ignored. - * @enum {string} - */ - messageFormat?: "C_SPRINTF" | "PHP_SPRINTF" | "JAVA_STRING_FORMAT" | "APPLE_SPRINTF" | "RUBY_SPRINTF" | "I18NEXT" | "ICU" | "PYTHON_PERCENT"; - /** @description Delimiter to structure file content. - * - * e.g. For key "home.header.title" would result in {"home": {"header": "title": {"Hello"}}} structure. - * - * When null, resulting file won't be structured. Works only for generic structured formats (e.g. JSON, YAML), - * specific formats like `YAML_RUBY` don't honor this parameter. */ - structureDelimiter?: string; - /** @description If true, for structured formats (like JSON) arrays are supported. - * - * e.g. Key hello[0] will be exported as {"hello": ["..."]} */ - supportArrays: boolean; - zip: boolean; + CollectionModelLlmProviderSimpleModel: { + _embedded?: { + providers?: components["schemas"]["LlmProviderSimpleModel"][]; + }; }; - GenerateSlugDto: { - name: string; - oldSlug?: string; + CollectionModelLong: { + _embedded?: { + longList?: number[]; + }; }; - GetKeysRequestDto: { - keys: components["schemas"]["KeyDefinitionDto"][]; - /** @description Tags to return language translations in */ - languageTags: string[]; + CollectionModelOrganizationInvitationModel: { + _embedded?: { + organizationInvitations?: components["schemas"]["OrganizationInvitationModel"][]; + }; }; - HierarchyItem: { - requires: components["schemas"]["HierarchyItem"][]; - /** @enum {string} */ - scope: "translations.view" | "translations.edit" | "keys.edit" | "screenshots.upload" | "screenshots.delete" | "screenshots.view" | "activity.view" | "languages.edit" | "admin" | "project.edit" | "members.view" | "members.edit" | "translation-comments.add" | "translation-comments.edit" | "translation-comments.set-state" | "translations.state-edit" | "keys.view" | "keys.delete" | "keys.create" | "batch-jobs.view" | "batch-jobs.cancel" | "translations.batch-by-tm" | "translations.batch-machine" | "content-delivery.manage" | "content-delivery.publish" | "webhooks.manage" | "tasks.view" | "tasks.edit"; + CollectionModelProjectInvitationModel: { + _embedded?: { + invitations?: components["schemas"]["ProjectInvitationModel"][]; + }; }; - IdentifyRequest: { - anonymousUserId: string; + CollectionModelProjectTransferOptionModel: { + _embedded?: { + transferOptions?: components["schemas"]["ProjectTransferOptionModel"][]; + }; }; - ImageUploadInfoDto: { - location?: string; + CollectionModelScreenshotModel: { + _embedded?: { + screenshots?: components["schemas"]["ScreenshotModel"][]; + }; }; - ImportAddFilesResultModel: { - errors: components["schemas"]["ErrorResponseBody"][]; - result?: components["schemas"]["PagedModelImportLanguageModel"]; - warnings: components["schemas"]["ErrorResponseBody"][]; + CollectionModelSimpleOrganizationModel: { + _embedded?: { + organizations?: components["schemas"]["SimpleOrganizationModel"][]; + }; }; - ImportFileIssueModel: { - /** Format: int64 */ - id: number; - params: components["schemas"]["ImportFileIssueParamModel"][]; - /** @enum {string} */ - type: "KEY_IS_NOT_STRING" | "MULTIPLE_VALUES_FOR_KEY_AND_LANGUAGE" | "VALUE_IS_NOT_STRING" | "KEY_IS_EMPTY" | "VALUE_IS_EMPTY" | "PO_MSGCTXT_NOT_SUPPORTED" | "ID_ATTRIBUTE_NOT_PROVIDED" | "TARGET_NOT_PROVIDED" | "TRANSLATION_TOO_LONG" | "KEY_IS_BLANK" | "TRANSLATION_DEFINED_IN_ANOTHER_FILE" | "INVALID_CUSTOM_VALUES" | "DESCRIPTION_TOO_LONG"; + CollectionModelSimpleProjectModel: { + _embedded?: { + projects?: components["schemas"]["SimpleProjectModel"][]; + }; }; - ImportFileIssueParamModel: { - /** @enum {string} */ - type: "KEY_NAME" | "KEY_ID" | "LANGUAGE_ID" | "KEY_INDEX" | "VALUE" | "LINE" | "FILE_NODE_ORIGINAL" | "LANGUAGE_NAME"; - value?: string; + CollectionModelUsedNamespaceModel: { + _embedded?: { + namespaces?: components["schemas"]["UsedNamespaceModel"][]; + }; }; - /** @description Definition of mapping for each file to import. */ - ImportFileMapping: { - /** @description Name of the file to import. This is the name of the file provided in `files` request part or in uploaded archive. */ - fileName: string; - /** - * @description Format of the file. If not provided, Tolgee will try to guess the format from the file name or file contents. - * - * It is recommended to provide these values to prevent any issues with format detection. - * @enum {string} - */ - format?: "CSV_ICU" | "CSV_JAVA" | "CSV_PHP" | "CSV_RUBY" | "JSON_I18NEXT" | "JSON_ICU" | "JSON_JAVA" | "JSON_PHP" | "JSON_RUBY" | "JSON_C" | "PO_PHP" | "PO_C" | "PO_JAVA" | "PO_ICU" | "PO_RUBY" | "PO_PYTHON" | "STRINGS" | "STRINGSDICT" | "APPLE_XLIFF" | "APPLE_XCSTRINGS" | "PROPERTIES_ICU" | "PROPERTIES_JAVA" | "PROPERTIES_UNKNOWN" | "ANDROID_XML" | "COMPOSE_XML" | "FLUTTER_ARB" | "YAML_RUBY" | "YAML_JAVA" | "YAML_ICU" | "YAML_PHP" | "YAML_UNKNOWN" | "XLIFF_ICU" | "XLIFF_JAVA" | "XLIFF_PHP" | "XLIFF_RUBY" | "RESX_ICU" | "XLSX_ICU" | "XLSX_JAVA" | "XLSX_PHP" | "XLSX_RUBY"; - /** @description The existing language tag in the Tolgee platform to which the imported language should be mapped. - * - * When null, Tolgee will try to guess the language from the file contents or file name. */ - languageTag?: string; - /** @description Tags of languages to be imported. When null, all languages from will be imported. - * - * This field is useful when the file contains multiple languages and you want to import only some of them. For example when importing Apple String Catalog (APPLE_XCSTRINGS), you might want only to import the base language. */ - languageTagsToImport?: string[]; - /** @description Namespace to import the file to. If not provided, the key will be imported without namespace. */ + CollectionModelWorkspaceModel: { + _embedded?: { + workspaces?: components["schemas"]["WorkspaceModel"][]; + }; + }; + ComplexEditKeyDto: { + /** @description Custom values of the key. If not provided, custom values won't be modified */ + custom?: { + [key: string]: Record; + }; + /** @description Description of the key. It's also used as a context for Tolgee AI translator */ + description?: string; + /** @description If key is pluralized. If it will be reflected in the editor. If null, value won't be modified. */ + isPlural?: boolean; + /** @description Name of the key */ + name: string; namespace?: string; + /** @description The argument name for the plural. If null, value won't be modified. If isPlural is false, this value will be ignored. */ + pluralArgName?: string; + /** @description Keys in the document used as a context for machine translation. Keys in the same order as they appear in the document. The order is important! We are using it for graph distance calculation. */ + relatedKeysInOrder?: components["schemas"]["RelatedKeyDto"][]; + /** @description IDs of screenshots to delete */ + screenshotIdsToDelete?: number[]; + /** @description Ids of screenshots uploaded with /v2/image-upload endpoint */ + screenshotUploadedImageIds?: number[]; + screenshotsToAdd?: components["schemas"]["KeyScreenshotDto"][]; + /** @description Translation states to update, if not provided states won't be modified */ + states?: { + [key: string]: "TRANSLATED" | "REVIEWED"; + }; + /** @description Tags of the key. If not provided tags won't be modified */ + tags?: string[]; + /** @description Translations to update */ + translations?: { + [key: string]: string; + }; + /** @description If true, it will fail with 400 (with code plural_forms_data_loss) if plural is disabled and there are plural forms, which would be lost by the action. You can get rid of this warning by setting this value to false. */ + warnOnDataLoss?: boolean; }; - ImportKeysDto: { - keys: components["schemas"]["ImportKeysItemDto"][]; + ComplexTagKeysRequest: { + /** @description Include keys filtered by the provided key information */ + filterKeys?: components["schemas"]["KeyId"][]; + /** @description Exclude keys filtered by the provided key information */ + filterKeysNot?: components["schemas"]["KeyId"][]; + /** @description Include keys filtered by the provided tag information. This filter supports wildcards. For example, `draft-*` will match all tags starting with `draft-`. */ + filterTag?: string[]; + /** @description Exclude keys filtered by the provided tag information. This filter supports wildcards. For example, `draft-*` will match all tags starting with `draft-`. */ + filterTagNot?: string[]; + /** @description Specified tags will be added to filtered keys */ + tagFiltered?: string[]; + /** @description Specified tags will be added to keys not filtered by any of the specified filters. */ + tagOther?: string[]; + /** @description Specified tags will be removed from filtered keys. It supports wildcards. For example, `draft-*` will remove all tags starting with `draft-`. */ + untagFiltered?: string[]; + /** @description Specified tags will be removed from keys not filtered by any of the specified filters. It supports wildcards. For example, `draft-*` will remove all tags starting with `draft-`. */ + untagOther?: string[]; }; - ImportKeysItemDto: { + ComputedPermissionModel: { + /** @enum {string} */ + origin: "ORGANIZATION_BASE" | "DIRECT" | "ORGANIZATION_OWNER" | "NONE" | "SERVER_ADMIN"; + permissionModel?: components["schemas"]["PermissionModel"]; /** - * @description Description of key - * @example This key is used on homepage. It's a label of sign up button. + * @deprecated + * @description Deprecated (use translateLanguageIds). + * + * List of languages current user has TRANSLATE permission to. If null, all languages edition is permitted. + * @example [ + * 200001, + * 200004 + * ] */ - description?: string; + permittedLanguageIds?: number[]; /** - * @description Key name to set translations for - * @example what_a_key_to_translate + * @description Granted scopes to the user. When user has type permissions, this field contains permission scopes of the type. + * @example [ + * "KEYS_EDIT", + * "TRANSLATIONS_VIEW" + * ] */ - name: string; - /** @description The namespace of the key. (When empty or null default namespace will be used) */ - namespace?: string; + scopes: ("translations.view" | "translations.edit" | "keys.edit" | "screenshots.upload" | "screenshots.delete" | "screenshots.view" | "activity.view" | "languages.edit" | "admin" | "project.edit" | "members.view" | "members.edit" | "translation-comments.add" | "translation-comments.edit" | "translation-comments.set-state" | "translations.state-edit" | "keys.view" | "keys.delete" | "keys.create" | "batch-jobs.view" | "batch-jobs.cancel" | "translations.batch-by-tm" | "translations.batch-machine" | "content-delivery.manage" | "content-delivery.publish" | "webhooks.manage" | "tasks.view" | "tasks.edit" | "prompts.view" | "prompts.edit" | "translation-labels.manage" | "translation-labels.assign")[]; /** - * @description Tags of the key + * @description List of languages user can change state to. If null, changing state of all language values is permitted. * @example [ - * "homepage", - * "user-profile" + * 200001, + * 200004 * ] */ - tags?: string[]; + stateChangeLanguageIds?: number[]; /** - * @description Object mapping language tag to translation - * @example { - * "en": "What a translated value!", - * "cs": "Jaká to přeložená hodnota!" - * } + * @description List of languages user can translate to. If null, all languages editing is permitted. + * @example [ + * 200001, + * 200004 + * ] */ - translations: { - [key: string]: string; - }; - }; - ImportKeysResolvableDto: { - keys: components["schemas"]["ImportKeysResolvableItemDto"][]; - }; - ImportKeysResolvableItemDto: { + translateLanguageIds?: number[]; /** - * @description Key name to set translations for - * @example what_a_key_to_translate + * @description The user's permission type. This field is null if uses granular permissions + * @enum {string} */ - name: string; - /** @description The namespace of the key. (When empty or null default namespace will be used) */ - namespace?: string; - screenshots?: components["schemas"]["KeyScreenshotDto"][]; - /** @description Object mapping language tag to translation */ - translations: { - [key: string]: components["schemas"]["ImportTranslationResolvableDto"]; - }; - }; - ImportLanguageModel: { - /** Format: int32 */ - conflictCount: number; - existingLanguageAbbreviation?: string; - /** Format: int64 */ - existingLanguageId?: number; - existingLanguageName?: string; - existingLanguageTag?: string; - /** Format: int64 */ - id: number; - /** Format: int64 */ - importFileId: number; - /** Format: int32 */ - importFileIssueCount: number; - importFileName: string; - name: string; - namespace?: string; - /** Format: int32 */ - resolvedCount: number; - /** Format: int32 */ - totalCount: number; - }; - ImportNamespaceModel: { + type?: "NONE" | "VIEW" | "TRANSLATE" | "REVIEW" | "EDIT" | "MANAGE"; /** - * Format: int64 - * @description The id of namespace. When null, namespace doesn't exist and will be created by import. - * @example 10000048 + * @description List of languages user can view. If null, all languages view is permitted. + * @example [ + * 200001, + * 200004 + * ] */ - id?: number; - /** @example homepage */ - name: string; - }; - ImportSettingsModel: { - /** @description If true, placeholders from other formats will be converted to ICU when possible */ - convertPlaceholdersToIcu: boolean; - /** @description If false, only updates keys, skipping the creation of new keys */ - createNewKeys: boolean; - /** @description If true, key descriptions will be overridden by the import */ - overrideKeyDescriptions: boolean; + viewLanguageIds?: number[]; }; - ImportSettingsRequest: { - /** @description If true, placeholders from other formats will be converted to ICU when possible */ - convertPlaceholdersToIcu: boolean; - /** @description If false, only updates keys, skipping the creation of new keys */ - createNewKeys: boolean; - /** @description If true, key descriptions will be overridden by the import */ - overrideKeyDescriptions: boolean; + ConnectToSlackDto: { + code: string; }; - ImportTranslationModel: { - /** Format: int64 */ - conflictId?: number; - conflictText?: string; - existingKeyIsPlural: boolean; - /** Format: int64 */ - id: number; - isPlural: boolean; - keyDescription?: string; - /** Format: int64 */ - keyId: number; - keyName: string; - override: boolean; - resolved: boolean; - text?: string; + ConnectToSlackUrlModel: { + url: string; }; - /** @description Object mapping language tag to translation */ - ImportTranslationResolvableDto: { - /** - * @description Determines, how conflict is resolved. + ContentDeliveryConfigModel: { + autoPublish: boolean; + /** @description If true, HTML tags are escaped in the exported file. (Supported in the XLIFF format only). * - * - KEEP: Translation is not changed - * - OVERRIDE: Translation is overridden - * - NEW: New translation is created - * - FORCE_OVERRIDE: Translation is updated, created or kept. + * e.g. Key hello will be exported as <b>hello</b> */ + escapeHtml?: boolean; + /** @description This is a template that defines the structure of the resulting .zip file content. * - * @example OVERRIDE + * The template is a string that can contain the following placeholders: {namespace}, {languageTag}, + * {androidLanguageTag}, {snakeLanguageTag}, {extension}. + * + * For example, when exporting to JSON with the template `{namespace}/{languageTag}.{extension}`, + * the English translations of the `home` namespace will be stored in `home/en.json`. + * + * The `{snakeLanguageTag}` placeholder is the same as `{languageTag}` but in snake case. (e.g., en_US). + * + * The Android specific `{androidLanguageTag}` placeholder is the same as `{languageTag}` + * but in Android format. (e.g., en-rUS) + * */ + fileStructureTemplate?: string; + /** @description Filter key IDs to be contained in export */ + filterKeyId?: number[]; + /** @description Filter key IDs not to be contained in export */ + filterKeyIdNot?: number[]; + /** @description Filter keys with prefix */ + filterKeyPrefix?: string; + /** @description Filter translations with namespace. By default, all namespaces everything are exported. To export default namespace, use empty string. */ + filterNamespace?: string[]; + /** @description Filter translations with state. By default, all states except untranslated is exported. */ + filterState?: ("UNTRANSLATED" | "TRANSLATED" | "REVIEWED" | "DISABLED")[]; + /** @description Filter keys tagged by. + * + * This filter works the same as `filterTagIn` but in this cases it accepts single tag only. */ + filterTag?: string; + /** @description Filter keys tagged by one of provided tags */ + filterTagIn?: string[]; + /** @description Filter keys not tagged by one of provided tags */ + filterTagNotIn?: string[]; + /** + * @description Format to export to * @enum {string} */ - resolution: "KEEP" | "OVERRIDE" | "NEW" | "FORCE_OVERRIDE"; + format: "JSON" | "JSON_TOLGEE" | "XLIFF" | "PO" | "APPLE_STRINGS_STRINGSDICT" | "APPLE_XLIFF" | "ANDROID_XML" | "COMPOSE_XML" | "FLUTTER_ARB" | "PROPERTIES" | "YAML_RUBY" | "YAML" | "JSON_I18NEXT" | "CSV" | "RESX_ICU" | "XLSX" | "APPLE_XCSTRINGS" | "ANDROID_SDK" | "APPLE_SDK"; + /** Format: int64 */ + id: number; /** - * @description Translation text - * @example Hello! I am a translation! + * @description Languages to be contained in export. + * + * If null, all languages are exported + * @example en */ - text: string; + languages?: string[]; + /** Format: int64 */ + lastPublished?: number; + lastPublishedFiles: string[]; + /** + * @description Message format to be used for export. + * + * e.g. PHP_PO: Hello %s, ICU: Hello {name}. + * + * This property is honored only for generic formats like JSON or YAML. + * For specific formats like `YAML_RUBY` it's ignored. + * @enum {string} + */ + messageFormat?: "C_SPRINTF" | "PHP_SPRINTF" | "JAVA_STRING_FORMAT" | "APPLE_SPRINTF" | "RUBY_SPRINTF" | "I18NEXT" | "ICU" | "PYTHON_PERCENT"; + name: string; + pruneBeforePublish: boolean; + publicUrl?: string; + slug: string; + storage?: components["schemas"]["ContentStorageModel"]; + /** @description Delimiter to structure file content. + * + * e.g. For key "home.header.title" would result in {"home": {"header": "title": {"Hello"}}} structure. + * + * When null, resulting file won't be structured. Works only for generic structured formats (e.g. JSON, YAML), + * specific formats like `YAML_RUBY` don't honor this parameter. */ + structureDelimiter?: string; + /** @description If true, for structured formats (like JSON) arrays are supported. + * + * e.g. Key hello[0] will be exported as {"hello": ["..."]} */ + supportArrays: boolean; }; - InitialDataModel: { - announcement?: components["schemas"]["AnnouncementDto"]; - eeSubscription?: components["schemas"]["EeSubscriptionModel"]; - languageTag?: string; - preferredOrganization?: components["schemas"]["PrivateOrganizationModel"]; - serverConfiguration: components["schemas"]["PublicConfigurationDTO"]; - userInfo?: components["schemas"]["PrivateUserAccountModel"]; + ContentDeliveryConfigRequest: { + /** @description If true, data are published to the content delivery automatically after each change. */ + autoPublish: boolean; + /** + * Format: int64 + * @description Id of custom storage to use for content delivery. If null, default server storage is used. Tolgee Cloud provides default Content Storage. + */ + contentStorageId?: number; + /** @description If true, HTML tags are escaped in the exported file. (Supported in the XLIFF format only). + * + * e.g. Key hello will be exported as <b>hello</b> */ + escapeHtml?: boolean; + /** @description This is a template that defines the structure of the resulting .zip file content. + * + * The template is a string that can contain the following placeholders: {namespace}, {languageTag}, + * {androidLanguageTag}, {snakeLanguageTag}, {extension}. + * + * For example, when exporting to JSON with the template `{namespace}/{languageTag}.{extension}`, + * the English translations of the `home` namespace will be stored in `home/en.json`. + * + * The `{snakeLanguageTag}` placeholder is the same as `{languageTag}` but in snake case. (e.g., en_US). + * + * The Android specific `{androidLanguageTag}` placeholder is the same as `{languageTag}` + * but in Android format. (e.g., en-rUS) + * */ + fileStructureTemplate?: string; + /** @description Filter key IDs to be contained in export */ + filterKeyId?: number[]; + /** @description Filter key IDs not to be contained in export */ + filterKeyIdNot?: number[]; + /** @description Filter keys with prefix */ + filterKeyPrefix?: string; + /** @description Filter translations with namespace. By default, all namespaces everything are exported. To export default namespace, use empty string. */ + filterNamespace?: string[]; + /** @description Filter translations with state. By default, all states except untranslated is exported. */ + filterState?: ("UNTRANSLATED" | "TRANSLATED" | "REVIEWED" | "DISABLED")[]; + /** @description Filter keys tagged by. + * + * This filter works the same as `filterTagIn` but in this cases it accepts single tag only. */ + filterTag?: string; + /** @description Filter keys tagged by one of provided tags */ + filterTagIn?: string[]; + /** @description Filter keys not tagged by one of provided tags */ + filterTagNotIn?: string[]; + /** + * @description Format to export to + * @enum {string} + */ + format: "JSON" | "JSON_TOLGEE" | "XLIFF" | "PO" | "APPLE_STRINGS_STRINGSDICT" | "APPLE_XLIFF" | "ANDROID_XML" | "COMPOSE_XML" | "FLUTTER_ARB" | "PROPERTIES" | "YAML_RUBY" | "YAML" | "JSON_I18NEXT" | "CSV" | "RESX_ICU" | "XLSX" | "APPLE_XCSTRINGS" | "ANDROID_SDK" | "APPLE_SDK"; + /** + * @description Languages to be contained in export. + * + * If null, all languages are exported + * @example en + */ + languages?: string[]; + /** + * @description Message format to be used for export. + * + * e.g. PHP_PO: Hello %s, ICU: Hello {name}. + * + * This property is honored only for generic formats like JSON or YAML. + * For specific formats like `YAML_RUBY` it's ignored. + * @enum {string} + */ + messageFormat?: "C_SPRINTF" | "PHP_SPRINTF" | "JAVA_STRING_FORMAT" | "APPLE_SPRINTF" | "RUBY_SPRINTF" | "I18NEXT" | "ICU" | "PYTHON_PERCENT"; + name: string; + /** @description Whether the data in the CDN should be pruned before publishing new data. + * + * In some cases, you might want to keep the data in the storage and only replace the files created by following publish operation. */ + pruneBeforePublish: boolean; + /** @description Tolgee uses a custom slug as a directory name for content storage and public content delivery URL. It is only applicable for custom storage. This field needs to be kept null for Tolgee Cloud content storage or global server storage on self-hosted instances. + * + * Slag has to match following regular expression: `^[a-z0-9]+(?:-[a-z0-9]+)*$`. + * + * If null is provided for update operation, slug will be assigned with generated value. */ + slug?: string; + /** @description Delimiter to structure file content. + * + * e.g. For key "home.header.title" would result in {"home": {"header": "title": {"Hello"}}} structure. + * + * When null, resulting file won't be structured. Works only for generic structured formats (e.g. JSON, YAML), + * specific formats like `YAML_RUBY` don't honor this parameter. */ + structureDelimiter?: string; + /** @description If true, for structured formats (like JSON) arrays are supported. + * + * e.g. Key hello[0] will be exported as {"hello": ["..."]} */ + supportArrays: boolean; }; - JwtAuthenticationResponse: { - accessToken?: string; - tokenType?: string; + ContentStorageModel: { + azureContentStorageConfig?: components["schemas"]["AzureContentStorageConfigModel"]; + /** Format: int64 */ + id: number; + name: string; + publicUrlPrefix?: string; + s3ContentStorageConfig?: components["schemas"]["S3ContentStorageConfigModel"]; }; - KeyDefinitionDto: { + ContentStorageRequest: { + azureContentStorageConfig?: components["schemas"]["AzureContentStorageConfigDto"]; name: string; - namespace?: string; + publicUrlPrefix?: string; + s3ContentStorageConfig?: components["schemas"]["S3ContentStorageConfigDto"]; }; - /** @description Disabled languages */ - KeyDisabledLanguageModel: { + CopyTranslationRequest: { + keyIds: number[]; /** Format: int64 */ - id: number; - tag: string; + sourceLanguageId: number; + targetLanguageIds: number[]; }; - KeyDisabledLanguagesModel: { - /** @description Disabled languages */ - disabledLanguages: components["schemas"]["KeyDisabledLanguageModel"][]; + CreateApiKeyDto: { + /** @description Description of the project API key */ + description?: string; /** * Format: int64 - * @description Id of key record + * @description Expiration date in epoch format (milliseconds). When null key never expires. + * @example 1661172869000 */ - id: number; + expiresAt?: number; + /** Format: int64 */ + projectId: number; + scopes: string[]; + }; + CreateGlossaryRequest: { + /** @description IDs of projects to be assigned to glossary */ + assignedProjectIds: number[]; /** - * @description Name of key - * @example this_is_super_key + * @description Language tag according to BCP 47 definition + * @example cs-CZ + */ + baseLanguageTag: string; + /** + * @description Glossary name + * @example My glossary */ name: string; + }; + CreateGlossaryTermWithTranslationRequest: { /** - * @description Namespace of key - * @example homepage + * @description A detailed explanation or definition of the glossary term + * @example It's trademark */ - namespace?: string; + description: string; + /** @description Specifies whether the term represents a shortened form of a word or phrase */ + flagAbbreviation: boolean; + /** @description When true, the term matching considers uppercase and lowercase characters as distinct */ + flagCaseSensitive: boolean; + /** @description When true, marks this term as prohibited or not recommended for use in translations */ + flagForbiddenTerm: boolean; + /** @description When true, this term will have the same translation across all target languages */ + flagNonTranslatable: boolean; + text: string; }; - /** @description Exclude keys filtered by the provided key information */ - KeyId: { + CreateKeyDto: { /** - * Format: int64 - * @description If key id is provided, name and namespace are ignored. + * @description Description of the key + * @example This key is used on homepage. It's a label of sign up button. */ - id?: number; - name?: string; + description?: string; + /** @description If key is pluralized. If it will be reflected in the editor */ + isPlural: boolean; + /** @description Name of the key */ + name: string; namespace?: string; - }; - KeyImportResolvableResultModel: { - /** @description List of keys */ - keys: components["schemas"]["KeyModel"][]; - /** @description Map uploadedImageId to screenshot */ - screenshots: { - [key: string]: components["schemas"]["ScreenshotModel"]; + /** @description The argument name for the plural. If null, value will be guessed from the values provided in translations. */ + pluralArgName?: string; + /** @description Keys in the document used as a context for machine translation. Keys in the same order as they appear in the document. The order is important! We are using it for graph distance calculation. */ + relatedKeysInOrder?: components["schemas"]["RelatedKeyDto"][]; + /** @description Ids of screenshots uploaded with /v2/image-upload endpoint */ + screenshotUploadedImageIds?: number[]; + screenshots?: components["schemas"]["KeyScreenshotDto"][]; + /** @description Translation states to update, if not provided states won't be modified */ + states?: { + [key: string]: "TRANSLATED" | "REVIEWED"; + }; + tags?: string[]; + translations?: { + [key: string]: string; }; }; - KeyInScreenshotModel: { - /** Format: int64 */ - keyId: number; - keyName: string; - keyNamespace?: string; - originalText?: string; - position?: components["schemas"]["KeyInScreenshotPosition"]; - }; - KeyInScreenshotPosition: { - /** Format: int32 */ - height: number; - /** Format: int32 */ - width: number; - /** Format: int32 */ - x: number; - /** Format: int32 */ - y: number; - }; - KeyInScreenshotPositionDto: { - /** Format: int32 */ - height: number; - /** Format: int32 */ - width: number; - /** Format: int32 */ - x: number; - /** Format: int32 */ - y: number; + CreateMultipleTasksRequest: { + tasks: components["schemas"]["CreateTaskRequest"][]; }; - KeyModel: { - /** @description Custom values of the key */ - custom?: { - [key: string]: Record; - }; + CreatePatDto: { + /** @description Description of the PAT */ + description: string; /** - * @description Description of key - * @example This key is used on homepage. It's a label of sign up button. + * Format: int64 + * @description Expiration date in epoch format (milliseconds). When null, token never expires. + * @example 1661172869000 */ - description?: string; + expiresAt?: number; + }; + CreateProjectRequest: { + /** @description Tag of one of created languages, to select it as base language. If not provided, first language will be selected as base. */ + baseLanguageTag?: string; + /** @description Whether to use ICU placeholder visualization in the editor and it's support. */ + icuPlaceholders: boolean; + languages: components["schemas"]["LanguageRequest"][]; + name: string; /** * Format: int64 - * @description Id of key record + * @description Organization to create the project in */ - id: number; + organizationId: number; + /** @description Slug of your project used in url e.g. "/v2/projects/what-a-project". If not provided, it will be generated */ + slug?: string; + }; + CreateProviderRequest: { + authorizationUri: string; + clientId: string; + clientSecret: string; + domain: string; + enabled: boolean; + force: boolean; + tokenUri: string; + }; + CreateTaskRequest: { + assignees: number[]; + description: string; /** - * @description Name of key - * @example this_is_super_key + * Format: int64 + * @description Due to date in epoch format (milliseconds). + * @example 1661172869000 */ - name: string; + dueDate?: number; + keys: number[]; /** - * @description Namespace of key - * @example homepage + * Format: int64 + * @description Id of language, this task is attached to. + * @example 1 */ - namespace?: string; + languageId: number; + name?: string; + /** @enum {string} */ + type: "TRANSLATE" | "REVIEW"; }; - KeyScreenshotDto: { - positions?: components["schemas"]["KeyInScreenshotPositionDto"][]; - text?: string; + CreateUpdateGlossaryTermResponse: { + term: components["schemas"]["SimpleGlossaryTermModel"]; + translation?: components["schemas"]["GlossaryTermTranslationModel"]; + }; + CreditBalanceModel: { + /** Format: int64 */ + bucketSize: number; + /** Format: int64 */ + creditBalance: number; /** * Format: int64 - * @description Ids of screenshot uploaded with /v2/image-upload endpoint + * @deprecated + * @description Customers were able to buy extra credits separately in the past. + * + * This option is not available anymore and this field is kept only for backward compatibility purposes and is always 0. */ - uploadedImageId: number; + extraCreditBalance: number; }; - KeySearchResultView: { - baseTranslation?: string; - description?: string; + /** @description For MT credits, the values are in full credits. Not Cents. */ + CurrentUsageItemModel: { /** Format: int64 */ - id: number; + current: number; + /** Format: int64 */ + included: number; + /** Format: int64 */ + limit: number; + }; + CurrentUsageModel: { + credits: components["schemas"]["CurrentUsageItemModel"]; + isPayAsYouGo: boolean; + keys: components["schemas"]["CurrentUsageItemModel"]; + seats: components["schemas"]["CurrentUsageItemModel"]; + strings: components["schemas"]["CurrentUsageItemModel"]; + }; + DeleteKeysDto: { + /** @description IDs of keys to delete */ + ids: number[]; + }; + DeleteKeysRequest: { + keyIds: number[]; + }; + DeleteMultipleGlossaryTermsRequest: { + termIds: number[]; + }; + DocItem: { + description?: string; + displayName?: string; + name: string; + }; + DomainRequest: { + domain: string; + state: string; + }; + EditKeyDto: { + /** + * @description Description of the key + * @example This key is used on homepage. It's a label of sign up button. + */ + description?: string; name: string; namespace?: string; - translation?: string; }; - KeySearchSearchResultModel: { - baseTranslation?: string; + EditProjectRequest: { + /** Format: int64 */ + baseLanguageId?: number; + /** Format: int64 */ + defaultNamespaceId?: number; description?: string; + /** @description Whether to use ICU placeholder visualization in the editor and it's support. */ + icuPlaceholders: boolean; + name: string; + slug?: string; + useNamespaces: boolean; + }; + EeSubscriptionModel: { + cancelAtPeriodEnd: boolean; /** Format: int64 */ - id: number; + currentPeriodEnd?: number; + /** Format: int64 */ + currentUserCount: number; + enabledFeatures: ("GRANULAR_PERMISSIONS" | "PRIORITIZED_FEATURE_REQUESTS" | "PREMIUM_SUPPORT" | "DEDICATED_SLACK_CHANNEL" | "ASSISTED_UPDATES" | "DEPLOYMENT_ASSISTANCE" | "BACKUP_CONFIGURATION" | "TEAM_TRAINING" | "ACCOUNT_MANAGER" | "STANDARD_SUPPORT" | "PROJECT_LEVEL_CONTENT_STORAGES" | "WEBHOOKS" | "MULTIPLE_CONTENT_DELIVERY_CONFIGS" | "AI_PROMPT_CUSTOMIZATION" | "SLACK_INTEGRATION" | "TASKS" | "SSO" | "ORDER_TRANSLATION" | "GLOSSARY" | "TRANSLATION_LABELS")[]; + isPayAsYouGo: boolean; + /** Format: date-time */ + lastValidCheck?: string; + licenseKey: string; name: string; - namespace?: string; - translation?: string; - view?: components["schemas"]["KeySearchResultView"]; + nonCommerical: boolean; + /** @enum {string} */ + status: "ACTIVE" | "CANCELED" | "PAST_DUE" | "UNPAID" | "ERROR" | "TRIALING" | "KEY_USED_BY_ANOTHER_INSTANCE" | "UNKNOWN"; }; - /** @description Tasks related to this key */ - KeyTaskViewModel: { - done: boolean; + EntityDescriptionWithRelations: { + data: { + [key: string]: Record; + }; + entityClass: string; /** Format: int64 */ - languageId: number; - languageTag: string; + entityId: number; + }; + ErrorResponseBody: { + code: string; + params?: Record[]; + }; + ErrorResponseTyped: { + /** @enum {string} */ + code: "unauthenticated" | "api_access_forbidden" | "api_key_not_found" | "invalid_api_key" | "invalid_project_api_key" | "project_api_key_expired" | "bad_credentials" | "mfa_enabled" | "invalid_otp_code" | "mfa_not_enabled" | "can_not_revoke_own_permissions" | "data_corrupted" | "invitation_code_does_not_exist_or_expired" | "language_tag_exists" | "language_name_exists" | "language_not_found" | "operation_not_permitted" | "registrations_not_allowed" | "project_not_found" | "resource_not_found" | "scope_not_found" | "key_exists" | "third_party_auth_error_message" | "third_party_auth_no_email" | "third_party_auth_non_matching_email" | "third_party_auth_no_sub" | "third_party_auth_unknown_error" | "email_already_verified" | "third_party_unauthorized" | "third_party_google_workspace_mismatch" | "third_party_switch_initiated" | "third_party_switch_conflict" | "username_already_exists" | "username_or_password_invalid" | "user_already_has_permissions" | "user_already_has_role" | "user_not_found" | "file_not_image" | "file_too_big" | "invalid_timestamp" | "email_not_verified" | "missing_callback_url" | "invalid_jwt_token" | "expired_jwt_token" | "general_jwt_error" | "cannot_find_suitable_address_part" | "slug_not_unique" | "user_is_not_member_of_organization" | "organization_has_no_other_owner" | "user_has_no_project_access" | "user_is_organization_owner" | "cannot_set_your_own_permissions" | "user_is_organization_member" | "property_not_mutable" | "import_language_not_from_project" | "existing_language_not_selected" | "conflict_is_not_resolved" | "language_already_selected" | "cannot_parse_file" | "could_not_resolve_property" | "cannot_add_more_then_100_languages" | "no_languages_provided" | "language_with_base_language_tag_not_found" | "language_not_from_project" | "namespace_not_from_project" | "cannot_delete_base_language" | "key_not_from_project" | "max_screenshots_exceeded" | "translation_not_from_project" | "can_edit_only_own_comment" | "request_parse_error" | "filter_by_value_state_not_valid" | "import_has_expired" | "tag_not_from_project" | "translation_text_too_long" | "invalid_recaptcha_token" | "cannot_leave_owning_project" | "cannot_leave_project_with_organization_role" | "dont_have_direct_permissions" | "tag_too_log" | "too_many_uploaded_images" | "one_or_more_images_not_found" | "screenshot_not_of_key" | "service_not_found" | "too_many_requests" | "translation_not_found" | "out_of_credits" | "key_not_found" | "organization_not_found" | "cannot_find_base_language" | "base_language_not_found" | "no_exported_result" | "cannot_set_your_own_role" | "only_translate_review_or_view_permission_accepts_view_languages" | "oauth2_token_url_not_set" | "oauth2_user_url_not_set" | "email_already_invited_or_member" | "price_not_found" | "invoice_not_from_organization" | "invoice_not_found" | "plan_not_found" | "plan_not_available_any_more" | "no_auto_translation_method" | "cannot_translate_base_language" | "pat_not_found" | "invalid_pat" | "pat_expired" | "operation_unavailable_for_account_type" | "validation_email_is_not_valid" | "current_password_required" | "cannot_create_organization" | "wrong_current_password" | "wrong_param_type" | "user_missing_password" | "expired_super_jwt_token" | "cannot_delete_your_own_account" | "cannot_sort_by_this_column" | "namespace_not_found" | "namespace_exists" | "invalid_authentication_method" | "unknown_sort_property" | "only_review_permission_accepts_state_change_languages" | "only_translate_or_review_permission_accepts_translate_languages" | "cannot_set_language_permissions_for_admin_scope" | "cannot_set_view_languages_without_translations_view_scope" | "cannot_set_translate_languages_without_translations_edit_scope" | "cannot_set_state_change_languages_without_translations_state_edit_scope" | "language_not_permitted" | "scopes_has_to_be_set" | "set_exactly_one_of_scopes_or_type" | "translation_exists" | "import_keys_error" | "provide_only_one_of_screenshots_and_screenshot_uploaded_image_ids" | "multiple_projects_not_supported" | "plan_translation_limit_exceeded" | "feature_not_enabled" | "license_key_not_found" | "cannot_set_view_languages_without_for_level_based_permissions" | "cannot_set_different_translate_and_state_change_languages_for_level_based_permissions" | "cannot_disable_your_own_account" | "subscription_not_found" | "invoice_does_not_have_usage" | "customer_not_found" | "subscription_not_active" | "organization_already_subscribed" | "organization_not_subscribed" | "license_key_used_by_another_instance" | "translation_spending_limit_exceeded" | "credit_spending_limit_exceeded" | "seats_spending_limit_exceeded" | "this_instance_is_already_licensed" | "big_meta_not_from_project" | "mt_service_not_enabled" | "project_not_selected" | "organization_not_selected" | "plan_has_subscribers" | "translation_failed" | "batch_job_not_found" | "key_exists_in_namespace" | "tag_is_blank" | "execution_failed_on_management_error" | "translation_api_rate_limit" | "cannot_finalize_activity" | "formality_not_supported_by_service" | "language_not_supported_by_service" | "rate_limited" | "pat_access_not_allowed" | "pak_access_not_allowed" | "cannot_modify_disabled_translation" | "azure_config_required" | "s3_config_required" | "content_storage_config_required" | "content_storage_test_failed" | "content_storage_config_invalid" | "invalid_connection_string" | "cannot_create_azure_storage_client" | "s3_access_key_required" | "azure_connection_string_required" | "s3_secret_key_required" | "cannot_store_file_to_content_storage" | "unexpected_error_while_publishing_to_content_storage" | "webhook_responded_with_non_200_status" | "unexpected_error_while_executing_webhook" | "content_storage_is_in_use" | "cannot_set_state_for_missing_translation" | "no_project_id_provided" | "license_key_not_provided" | "subscription_already_canceled" | "user_is_subscribed_to_paid_plan" | "cannot_create_free_plan_without_fixed_type" | "cannot_modify_plan_free_status" | "key_id_not_provided" | "free_self_hosted_seat_limit_exceeded" | "advanced_params_not_supported" | "plural_forms_not_found_for_language" | "nested_plurals_not_supported" | "message_is_not_plural" | "content_outside_plural_forms" | "invalid_plural_form" | "multiple_plurals_not_supported" | "custom_values_json_too_long" | "unsupported_po_message_format" | "plural_forms_data_loss" | "current_user_does_not_own_image" | "user_cannot_view_this_organization" | "user_is_not_owner_of_organization" | "user_is_not_owner_or_maintainer_of_organization" | "pak_created_for_different_project" | "custom_slug_is_only_applicable_for_custom_storage" | "invalid_slug_format" | "batch_job_cancellation_timeout" | "import_failed" | "cannot_add_more_then_1000_languages" | "no_data_to_import" | "multiple_namespaces_mapped_to_single_file" | "multiple_mappings_for_same_file_language_name" | "multiple_mappings_for_null_file_language_name" | "too_many_mappings_for_file" | "missing_placeholder_in_template" | "tag_not_found" | "cannot_parse_encrypted_slack_login_data" | "slack_workspace_not_found" | "cannot_fetch_user_details_from_slack" | "slack_missing_scope" | "slack_not_connected_to_your_account" | "slack_invalid_command" | "slack_not_subscribed_yet" | "slack_connection_failed" | "tolgee_account_already_connected" | "slack_not_configured" | "slack_workspace_already_connected" | "slack_connection_error" | "email_verification_code_not_valid" | "cannot_subscribe_to_free_plan" | "plan_auto_assignment_only_for_free_plans" | "plan_auto_assignment_only_for_private_plans" | "task_not_found" | "task_not_finished" | "task_not_open" | "translation_agency_not_found" | "this_feature_is_not_implemented_in_oss" | "sso_token_exchange_failed" | "sso_user_info_retrieval_failed" | "sso_id_token_expired" | "sso_user_cannot_create_organization" | "sso_cant_verify_user" | "sso_auth_missing_domain" | "sso_domain_not_found_or_disabled" | "authentication_method_disabled" | "native_authentication_disabled" | "invitation_organization_mismatch" | "user_is_managed_by_organization" | "cannot_set_sso_provider_missing_fields" | "namespaces_cannot_be_disabled_when_namespace_exists" | "namespace_cannot_be_used_when_feature_is_disabled" | "sso_domain_not_allowed" | "sso_login_forced_for_this_account" | "use_sso_for_authentication_instead" | "date_has_to_be_in_the_future" | "custom_plan_and_plan_id_cannot_be_set_together" | "specify_plan_id_or_custom_plan" | "custom_plans_has_to_be_private" | "cannot_create_free_plan_with_prices" | "subscription_not_scheduled_for_cancellation" | "cannot_cancel_trial" | "cannot_update_without_modification" | "current_subscription_is_not_trialing" | "sorting_and_paging_is_not_supported_when_using_cursor" | "strings_metric_are_not_supported" | "plan_key_limit_exceeded" | "keys_spending_limit_exceeded" | "plan_seat_limit_exceeded" | "instance_not_using_license_key" | "invalid_path" | "llm_provider_not_found" | "llm_provider_error" | "prompt_not_found" | "llm_provider_not_returned_json" | "llm_template_parsing_error" | "llm_rate_limited" | "llm_provider_timeout" | "no_llm_provider_configured" | "glossary_not_found" | "glossary_term_not_found" | "glossary_term_translation_not_found" | "glossary_non_translatable_term_cannot_be_translated" | "llm_content_filter" | "llm_provider_empty_response" | "label_not_found" | "label_not_from_project" | "label_already_exists" | "filter_by_value_label_not_valid"; + params?: Record[]; + }; + ExistenceEntityDescription: { + data: { + [key: string]: Record; + }; + entityClass: string; /** Format: int64 */ - number: number; + entityId: number; + exists?: boolean; + relations: { + [key: string]: components["schemas"]["EntityDescriptionWithRelations"]; + }; + }; + ExportFormatModel: { + defaultFileStructureTemplate: string; + extension: string; /** @enum {string} */ - type: "TRANSLATE" | "REVIEW"; - userAssigned: boolean; + format: "JSON" | "JSON_TOLGEE" | "XLIFF" | "PO" | "APPLE_STRINGS_STRINGSDICT" | "APPLE_XLIFF" | "ANDROID_XML" | "COMPOSE_XML" | "FLUTTER_ARB" | "PROPERTIES" | "YAML_RUBY" | "YAML" | "JSON_I18NEXT" | "CSV" | "RESX_ICU" | "XLSX" | "APPLE_XCSTRINGS" | "ANDROID_SDK" | "APPLE_SDK"; + mediaType: string; }; - KeyWithBaseTranslationModel: { + ExportParams: { + /** @description If true, HTML tags are escaped in the exported file. (Supported in the XLIFF format only). + * + * e.g. Key hello will be exported as <b>hello</b> */ + escapeHtml?: boolean; + /** @description This is a template that defines the structure of the resulting .zip file content. + * + * The template is a string that can contain the following placeholders: {namespace}, {languageTag}, + * {androidLanguageTag}, {snakeLanguageTag}, {extension}. + * + * For example, when exporting to JSON with the template `{namespace}/{languageTag}.{extension}`, + * the English translations of the `home` namespace will be stored in `home/en.json`. + * + * The `{snakeLanguageTag}` placeholder is the same as `{languageTag}` but in snake case. (e.g., en_US). + * + * The Android specific `{androidLanguageTag}` placeholder is the same as `{languageTag}` + * but in Android format. (e.g., en-rUS) + * */ + fileStructureTemplate?: string; + /** @description Filter key IDs to be contained in export */ + filterKeyId?: number[]; + /** @description Filter key IDs not to be contained in export */ + filterKeyIdNot?: number[]; + /** @description Filter keys with prefix */ + filterKeyPrefix?: string; + /** @description Filter translations with namespace. By default, all namespaces everything are exported. To export default namespace, use empty string. */ + filterNamespace?: string[]; + /** @description Filter translations with state. By default, all states except untranslated is exported. */ + filterState?: ("UNTRANSLATED" | "TRANSLATED" | "REVIEWED" | "DISABLED")[]; + /** @description Filter keys tagged by. + * + * This filter works the same as `filterTagIn` but in this cases it accepts single tag only. */ + filterTag?: string; + /** @description Filter keys tagged by one of provided tags */ + filterTagIn?: string[]; + /** @description Filter keys not tagged by one of provided tags */ + filterTagNotIn?: string[]; /** - * @description Base translation - * @example This is translation + * @description Format to export to + * @enum {string} */ - baseTranslation?: string; + format: "JSON" | "JSON_TOLGEE" | "XLIFF" | "PO" | "APPLE_STRINGS_STRINGSDICT" | "APPLE_XLIFF" | "ANDROID_XML" | "COMPOSE_XML" | "FLUTTER_ARB" | "PROPERTIES" | "YAML_RUBY" | "YAML" | "JSON_I18NEXT" | "CSV" | "RESX_ICU" | "XLSX" | "APPLE_XCSTRINGS" | "ANDROID_SDK" | "APPLE_SDK"; /** - * Format: int64 - * @description Id of key record + * @description Languages to be contained in export. + * + * If null, all languages are exported + * @example en */ - id: number; + languages?: string[]; /** - * @description Name of key - * @example this_is_super_key + * @description Message format to be used for export. + * + * e.g. PHP_PO: Hello %s, ICU: Hello {name}. + * + * This property is honored only for generic formats like JSON or YAML. + * For specific formats like `YAML_RUBY` it's ignored. + * @enum {string} */ + messageFormat?: "C_SPRINTF" | "PHP_SPRINTF" | "JAVA_STRING_FORMAT" | "APPLE_SPRINTF" | "RUBY_SPRINTF" | "I18NEXT" | "ICU" | "PYTHON_PERCENT"; + /** @description Delimiter to structure file content. + * + * e.g. For key "home.header.title" would result in {"home": {"header": "title": {"Hello"}}} structure. + * + * When null, resulting file won't be structured. Works only for generic structured formats (e.g. JSON, YAML), + * specific formats like `YAML_RUBY` don't honor this parameter. */ + structureDelimiter?: string; + /** @description If true, for structured formats (like JSON) arrays are supported. + * + * e.g. Key hello[0] will be exported as {"hello": ["..."]} */ + supportArrays: boolean; + zip: boolean; + }; + GenerateSlugDto: { name: string; + oldSlug?: string; + }; + GetKeysRequestDto: { + keys: components["schemas"]["KeyDefinitionDto"][]; + /** @description Tags to return language translations in */ + languageTags: string[]; + }; + GlossaryHighlightsRequest: { /** - * @description Namespace of key - * @example homepage + * @description Language tag according to BCP 47 definition + * @example cs-CZ */ - namespace?: string; + languageTag: string; + text: string; }; - KeyWithDataModel: { - /** @description Custom values of the key */ - custom: { - [key: string]: Record; - }; + GlossaryLanguageDto: { /** - * @description Description of key - * @example This key is used on homepage. It's a label of sign up button. + * @description Indicates if this is the base (main) language of the glossary + * @example true */ - description?: string; + base: boolean; /** - * Format: int64 - * @description Id of key record + * @description The language code (e.g., 'en' for English) + * @example en */ - id: number; - /** @description If key is pluralized. If it will be reflected in the editor */ - isPlural: boolean; + tag: string; + }; + GlossaryModel: { /** - * @description Name of key - * @example this_is_super_key + * @description Language tag for default translations for terms + * @example en */ + baseLanguageTag: string; + /** Format: int64 */ + id: number; name: string; + organizationOwner: components["schemas"]["SimpleOrganizationModel"]; + }; + GlossaryTermHighlightModel: { + position: components["schemas"]["PositionModel"]; + value: components["schemas"]["GlossaryTermModel"]; + }; + GlossaryTermModel: { + description: string; + /** @description Specifies whether the term represents a shortened form of a word or phrase */ + flagAbbreviation: boolean; + /** @description When true, the term matching considers uppercase and lowercase characters as distinct */ + flagCaseSensitive: boolean; + /** @description When true, marks this term as prohibited or not recommended for use in translations */ + flagForbiddenTerm: boolean; + /** @description When true, this term has the same translation across all target languages */ + flagNonTranslatable: boolean; + glossary: components["schemas"]["GlossaryModel"]; + /** Format: int64 */ + id: number; + translations: components["schemas"]["GlossaryTermTranslationModel"][]; + }; + GlossaryTermTranslationModel: { + languageTag: string; + text: string; + }; + HierarchyItem: { + requires: components["schemas"]["HierarchyItem"][]; + /** @enum {string} */ + scope: "translations.view" | "translations.edit" | "keys.edit" | "screenshots.upload" | "screenshots.delete" | "screenshots.view" | "activity.view" | "languages.edit" | "admin" | "project.edit" | "members.view" | "members.edit" | "translation-comments.add" | "translation-comments.edit" | "translation-comments.set-state" | "translations.state-edit" | "keys.view" | "keys.delete" | "keys.create" | "batch-jobs.view" | "batch-jobs.cancel" | "translations.batch-by-tm" | "translations.batch-machine" | "content-delivery.manage" | "content-delivery.publish" | "webhooks.manage" | "tasks.view" | "tasks.edit" | "prompts.view" | "prompts.edit" | "translation-labels.manage" | "translation-labels.assign"; + }; + IdentifyRequest: { + anonymousUserId: string; + }; + ImageUploadInfoDto: { + location?: string; + }; + ImportAddFilesResultModel: { + errors: components["schemas"]["ErrorResponseBody"][]; + result?: components["schemas"]["PagedModelImportLanguageModel"]; + warnings: components["schemas"]["ErrorResponseBody"][]; + }; + ImportFileIssueModel: { + /** Format: int64 */ + id: number; + params: components["schemas"]["ImportFileIssueParamModel"][]; + /** @enum {string} */ + type: "KEY_IS_NOT_STRING" | "MULTIPLE_VALUES_FOR_KEY_AND_LANGUAGE" | "VALUE_IS_NOT_STRING" | "KEY_IS_EMPTY" | "VALUE_IS_EMPTY" | "PO_MSGCTXT_NOT_SUPPORTED" | "ID_ATTRIBUTE_NOT_PROVIDED" | "TARGET_NOT_PROVIDED" | "TRANSLATION_TOO_LONG" | "KEY_IS_BLANK" | "TRANSLATION_DEFINED_IN_ANOTHER_FILE" | "INVALID_CUSTOM_VALUES" | "DESCRIPTION_TOO_LONG"; + }; + ImportFileIssueParamModel: { + /** @enum {string} */ + type: "KEY_NAME" | "KEY_ID" | "LANGUAGE_ID" | "KEY_INDEX" | "VALUE" | "LINE" | "FILE_NODE_ORIGINAL" | "LANGUAGE_NAME"; + value?: string; + }; + /** @description Definition of mapping for each file to import. */ + ImportFileMapping: { + /** @description Name of the file to import. This is the name of the file provided in `files` request part or in uploaded archive. */ + fileName: string; /** - * @description Namespace of key - * @example homepage + * @description Format of the file. If not provided, Tolgee will try to guess the format from the file name or file contents. + * + * It is recommended to provide these values to prevent any issues with format detection. + * @enum {string} */ + format?: "CSV_ICU" | "CSV_JAVA" | "CSV_PHP" | "CSV_RUBY" | "JSON_I18NEXT" | "JSON_ICU" | "JSON_JAVA" | "JSON_PHP" | "JSON_RUBY" | "JSON_C" | "PO_PHP" | "PO_C" | "PO_JAVA" | "PO_ICU" | "PO_RUBY" | "PO_PYTHON" | "STRINGS" | "STRINGSDICT" | "APPLE_XLIFF" | "APPLE_XCSTRINGS" | "PROPERTIES_ICU" | "PROPERTIES_JAVA" | "PROPERTIES_UNKNOWN" | "ANDROID_XML" | "COMPOSE_XML" | "FLUTTER_ARB" | "YAML_RUBY" | "YAML_JAVA" | "YAML_ICU" | "YAML_PHP" | "YAML_UNKNOWN" | "XLIFF_ICU" | "XLIFF_JAVA" | "XLIFF_PHP" | "XLIFF_RUBY" | "RESX_ICU" | "XLSX_ICU" | "XLSX_JAVA" | "XLSX_PHP" | "XLSX_RUBY"; + /** @description The existing language tag in the Tolgee platform to which the imported language should be mapped. + * + * When null, Tolgee will try to guess the language from the file contents or file name. */ + languageTag?: string; + /** @description Tags of languages to be imported. When null, all languages from will be imported. + * + * This field is useful when the file contains multiple languages and you want to import only some of them. For example when importing Apple String Catalog (APPLE_XCSTRINGS), you might want only to import the base language. */ + languageTagsToImport?: string[]; + /** @description Namespace to import the file to. If not provided, the key will be imported without namespace. */ namespace?: string; - /** @description The argument name for the plural */ - pluralArgName?: string; - /** @description Screenshots of the key */ - screenshots: components["schemas"]["ScreenshotModel"][]; - /** @description Tags of key */ - tags: components["schemas"]["TagModel"][]; - /** - * @description Translations object containing values updated in this request - * @example { - * "en": { - * "id": 100000003, - * "text": "This is super translation!" - * } - * } - */ - translations: { - [key: string]: components["schemas"]["TranslationModel"]; - }; }; - KeyWithTranslationsModel: { - /** @description There is a context available for this key */ - contextPresent: boolean; - /** - * @description The namespace of the key - * @example homepage - */ - keyDescription?: string; - /** - * Format: int64 - * @description Id of key record - */ - keyId: number; - /** - * @description Is this key a plural? - * @example true - */ - keyIsPlural: boolean; - /** - * @description Name of key - * @example this_is_super_key - */ - keyName: string; + ImportKeysDto: { + keys: components["schemas"]["ImportKeysItemDto"][]; + }; + ImportKeysItemDto: { /** - * @description The namespace of the key - * @example homepage + * @description Description of key + * @example This key is used on homepage. It's a label of sign up button. */ - keyNamespace?: string; + description?: string; /** - * Format: int64 - * @description The namespace id of the key - * @example 100000282 + * @description Key name to set translations for + * @example what_a_key_to_translate */ - keyNamespaceId?: number; + name: string; + /** @description The namespace of the key. (When empty or null default namespace will be used) */ + namespace?: string; /** - * @description The placeholder name for plural parameter - * @example value + * @description Tags of the key + * @example [ + * "homepage", + * "user-profile" + * ] */ - keyPluralArgName?: string; - /** @description Tags of key */ - keyTags: components["schemas"]["TagModel"][]; + tags?: string[]; /** - * Format: int64 - * @description Count of screenshots provided for the key - * @example 1 + * @description Object mapping language tag to translation + * @example { + * "en": "What a translated value!", + * "cs": "Jaká to přeložená hodnota!" + * } */ - screenshotCount: number; - /** @description Key screenshots. Not provided when API key hasn't screenshots.view scope permission. */ - screenshots?: components["schemas"]["ScreenshotModel"][]; - /** @description Tasks related to this key */ - tasks?: components["schemas"]["KeyTaskViewModel"][]; + translations: { + [key: string]: string; + }; + }; + ImportKeysResolvableDto: { + keys: components["schemas"]["ImportKeysResolvableItemDto"][]; + }; + ImportKeysResolvableItemDto: { /** - * @description Translations object - * @example - * { - * "en": { - * "id": 100000003, - * "text": "This is super translation!" - * "state": "TRANSLATED", - * "commentCount": 1 - * } - * } - * + * @description Key name to set translations for + * @example what_a_key_to_translate */ + name: string; + /** @description The namespace of the key. (When empty or null default namespace will be used) */ + namespace?: string; + screenshots?: components["schemas"]["KeyScreenshotDto"][]; + /** @description Object mapping language tag to translation */ translations: { - [key: string]: components["schemas"]["TranslationViewModel"]; + [key: string]: components["schemas"]["ImportTranslationResolvableDto"]; }; }; - KeysScopeView: { - /** Format: int64 */ - characterCount: number; + ImportLanguageModel: { + /** Format: int32 */ + conflictCount: number; + existingLanguageAbbreviation?: string; /** Format: int64 */ - keyCount: number; + existingLanguageId?: number; + existingLanguageName?: string; + existingLanguageTag?: string; /** Format: int64 */ - keyCountIncludingConflicts: number; + id: number; /** Format: int64 */ - wordCount: number; + importFileId: number; + /** Format: int32 */ + importFileIssueCount: number; + importFileName: string; + name: string; + namespace?: string; + /** Format: int32 */ + resolvedCount: number; + /** Format: int32 */ + totalCount: number; }; - KeysWithTranslationsPageModel: { - _embedded?: { - keys?: components["schemas"]["KeyWithTranslationsModel"][]; - }; + ImportNamespaceModel: { /** - * @description Cursor to get next data - * @example eyJrZXlJZCI6eyJkaXJlY3Rpb24iOiJBU0MiLCJ2YWx1ZSI6IjEwMDAwMDAxMjAifX0= + * Format: int64 + * @description The id of namespace. When null, namespace doesn't exist and will be created by import. + * @example 10000048 */ - nextCursor?: string; - page?: components["schemas"]["PageMetadata"]; - /** @description Provided languages data */ - selectedLanguages: components["schemas"]["LanguageModel"][]; + id?: number; + /** @example homepage */ + name: string; }; - LanguageAiPromptCustomizationModel: { - /** - * @description The language description used in the prompt that helps AI translator to fine tune results for specific language - * @example For arabic language, we are super formal. Always use these translations: - * Paper -> ورقة - * Office -> مكتب - * - */ - description?: string; - language: components["schemas"]["LanguageModel"]; + ImportSettingsModel: { + /** @description If true, placeholders from other formats will be converted to ICU when possible */ + convertPlaceholdersToIcu: boolean; + /** @description If false, only updates keys, skipping the creation of new keys */ + createNewKeys: boolean; + /** @description If true, key descriptions will be overridden by the import */ + overrideKeyDescriptions: boolean; }; - LanguageConfigItemModel: { - /** - * @deprecated - * @description Services to be used for suggesting (deprecated: use enabledServicesInfo) - */ - enabledServices: ("GOOGLE" | "AWS" | "DEEPL" | "AZURE" | "BAIDU" | "TOLGEE")[]; - /** @description Info about enabled services */ - enabledServicesInfo: components["schemas"]["MtServiceInfo"][]; - /** - * @deprecated - * @description Service used for automated translating (deprecated: use primaryServiceInfo) - * @enum {string} - */ - primaryService?: "GOOGLE" | "AWS" | "DEEPL" | "AZURE" | "BAIDU" | "TOLGEE"; - primaryServiceInfo?: components["schemas"]["MtServiceInfo"]; - /** - * Format: int64 - * @description When null, its a default configuration applied to not configured languages - */ - targetLanguageId?: number; - /** @description When null, its a default configuration applied to not configured languages */ - targetLanguageName?: string; - /** @description When null, its a default configuration applied to not configured languages */ - targetLanguageTag?: string; + ImportSettingsRequest: { + /** @description If true, placeholders from other formats will be converted to ICU when possible */ + convertPlaceholdersToIcu: boolean; + /** @description If false, only updates keys, skipping the creation of new keys */ + createNewKeys: boolean; + /** @description If true, key descriptions will be overridden by the import */ + overrideKeyDescriptions: boolean; }; - LanguageInfoModel: { + ImportTranslationModel: { /** Format: int64 */ - languageId?: number; - languageTag?: string; - supportedServices: components["schemas"]["MtSupportedService"][]; + conflictId?: number; + conflictText?: string; + existingKeyIsPlural: boolean; + /** Format: int64 */ + id: number; + isPlural: boolean; + keyDescription?: string; + /** Format: int64 */ + keyId: number; + keyName: string; + override: boolean; + resolved: boolean; + text?: string; }; - /** @description Maps the languages from imported files to languages existing in the Tolgee platform. - * - * Use this field only when your files contain multiple languages (e.g., XLIFF files). - * - * Otherwise, use the `languageTag` property of `fileMappings`. - * - * Example: In xliff files, there are `source-language` and `target-language` attributes defined on `file` element. Using this field you can map source and target values to languages stored in the Tolgee Platform. */ - LanguageMapping: { + /** @description Object mapping language tag to translation */ + ImportTranslationResolvableDto: { /** - * @description The language from the imported file. + * @description Determines, how conflict is resolved. * - * For xliff files, this is the `source-language` or the `target-language` attribute value of `file` element. - * @example en-US + * - KEEP: Translation is not changed + * - OVERRIDE: Translation is overridden + * - NEW: New translation is created + * - FORCE_OVERRIDE: Translation is updated, created or kept. + * + * @example OVERRIDE + * @enum {string} */ - importLanguage: string; + resolution: "KEEP" | "OVERRIDE" | "NEW" | "FORCE_OVERRIDE"; /** - * @description The tag of language existing in the Tolgee platform to which the imported language should be mapped. - * @example en-US + * @description Translation text + * @example Hello! I am a translation! */ - platformLanguageTag: string; + text: string; }; - LanguageModel: { - /** - * @description Whether is base language of project - * @example false - */ - base: boolean; + InitialDataEeSubscriptionModel: { + /** @enum {string} */ + status: "ACTIVE" | "CANCELED" | "PAST_DUE" | "UNPAID" | "ERROR" | "TRIALING" | "KEY_USED_BY_ANOTHER_INSTANCE" | "UNKNOWN"; + }; + InitialDataModel: { + announcement?: components["schemas"]["AnnouncementDto"]; + eeSubscription?: components["schemas"]["InitialDataEeSubscriptionModel"]; + languageTag?: string; + preferredOrganization?: components["schemas"]["PrivateOrganizationModel"]; + serverConfiguration: components["schemas"]["PublicConfigurationDTO"]; + ssoInfo?: components["schemas"]["PublicSsoTenantModel"]; + userInfo?: components["schemas"]["PrivateUserAccountModel"]; + }; + JsonNode: Record; + JwtAuthenticationResponse: { + accessToken?: string; + tokenType?: string; + }; + KeyDefinitionDto: { + name: string; + namespace?: string; + }; + /** @description Disabled languages */ + KeyDisabledLanguageModel: { + /** Format: int64 */ + id: number; + tag: string; + }; + KeyDisabledLanguagesModel: { + /** @description Disabled languages */ + disabledLanguages: components["schemas"]["KeyDisabledLanguageModel"][]; /** - * @description Language flag emoji as UTF-8 emoji - * @example 🇨🇿 + * Format: int64 + * @description Id of key record */ - flagEmoji?: string; - /** Format: int64 */ id: number; /** - * @description Language name in english - * @example Czech + * @description Name of key + * @example this_is_super_key */ name: string; /** - * @description Language name in this language - * @example čeština + * @description Namespace of key + * @example homepage */ - originalName?: string; + namespace?: string; + }; + /** @description Exclude keys filtered by the provided key information */ + KeyId: { /** - * @description Language tag according to BCP 47 definition - * @example cs-CZ + * Format: int64 + * @description If key id is provided, name and namespace are ignored. */ - tag: string; + id?: number; + name?: string; + namespace?: string; }; - LanguageRequest: { + KeyImportResolvableResultModel: { + /** @description List of keys */ + keys: components["schemas"]["KeyModel"][]; + /** @description Map uploadedImageId to screenshot */ + screenshots: { + [key: string]: components["schemas"]["ScreenshotModel"]; + }; + }; + KeyInScreenshotModel: { + /** Format: int64 */ + keyId: number; + keyName: string; + keyNamespace?: string; + originalText?: string; + position?: components["schemas"]["KeyInScreenshotPosition"]; + }; + KeyInScreenshotPosition: { + /** Format: int32 */ + height: number; + /** Format: int32 */ + width: number; + /** Format: int32 */ + x: number; + /** Format: int32 */ + y: number; + }; + KeyInScreenshotPositionDto: { + /** Format: int32 */ + height: number; + /** Format: int32 */ + width: number; + /** Format: int32 */ + x: number; + /** Format: int32 */ + y: number; + }; + KeyModel: { + /** @description Custom values of the key */ + custom?: { + [key: string]: Record; + }; /** - * @description Language flag emoji as UTF-8 emoji - * @example 🇨🇿 + * @description Description of key + * @example This key is used on homepage. It's a label of sign up button. */ - flagEmoji?: string; + description?: string; /** - * @description Language name in english - * @example Czech + * Format: int64 + * @description Id of key record + */ + id: number; + /** + * @description Name of key + * @example this_is_super_key */ name: string; /** - * @description Language name in this language - * @example čeština + * @description Namespace of key + * @example homepage */ - originalName: string; + namespace?: string; + }; + KeyScreenshotDto: { + positions?: components["schemas"]["KeyInScreenshotPositionDto"][]; + text?: string; /** - * @description Language tag according to BCP 47 definition - * @example cs-CZ + * Format: int64 + * @description Ids of screenshot uploaded with /v2/image-upload endpoint */ - tag: string; + uploadedImageId: number; }; - LanguageStatsModel: { - languageFlagEmoji?: string; + KeySearchResultView: { + baseTranslation?: string; + description?: string; /** Format: int64 */ - languageId?: number; - languageName?: string; - languageOriginalName?: string; - languageTag?: string; + id: number; + name: string; + namespace?: string; + translation?: string; + }; + KeySearchSearchResultModel: { + baseTranslation?: string; + description?: string; /** Format: int64 */ - reviewedKeyCount: number; - /** Format: double */ - reviewedPercentage: number; - /** Format: int64 */ - reviewedWordCount: number; - /** Format: int64 */ - translatedKeyCount: number; - /** Format: double */ - translatedPercentage: number; - /** Format: int64 */ - translatedWordCount: number; + id: number; + name: string; + namespace?: string; + translation?: string; + view?: components["schemas"]["KeySearchResultView"]; + }; + /** @description Tasks related to this key */ + KeyTaskViewModel: { + done: boolean; /** Format: int64 */ - untranslatedKeyCount: number; - /** Format: double */ - untranslatedPercentage: number; + languageId: number; + languageTag: string; /** Format: int64 */ - untranslatedWordCount: number; - }; - LoginRequest: { - otp?: string; - password: string; - username: string; + number: number; + /** @enum {string} */ + type: "TRANSLATE" | "REVIEW"; + userAssigned: boolean; }; - MachineTranslationLanguagePropsDto: { + KeyWithBaseTranslationModel: { /** - * @deprecated - * @description List of enabled services (deprecated: use enabledServicesInfo) + * @description Base translation + * @example This is translation */ - enabledServices?: ("GOOGLE" | "AWS" | "DEEPL" | "AZURE" | "BAIDU" | "TOLGEE")[]; - /** @description Info about enabled services */ - enabledServicesInfo?: components["schemas"]["MtServiceInfo"][]; + baseTranslation?: string; /** - * @deprecated - * @description This service will be used for automated translation - * @enum {string} + * Format: int64 + * @description Id of key record */ - primaryService?: "GOOGLE" | "AWS" | "DEEPL" | "AZURE" | "BAIDU" | "TOLGEE"; - primaryServiceInfo?: components["schemas"]["MtServiceInfo"]; + id: number; /** - * Format: int64 - * @description The language to apply those rules. If null, then this settings are default. + * @description Name of key + * @example this_is_super_key */ - targetLanguageId?: number; - }; - MachineTranslationProviderModel: { - /** @description BCP 47 tags of languages supported by the translation service. When null, all possible languages are supported. - * - * Please note that Tolgee tries to fall back to a higher subtag if the subtag is not supported. - * - * E.g., if `pt-BR` is not supported. Tolgee fallbacks to `pt`. */ - supportedLanguages?: string[]; - }; - MachineTranslationRequest: { - keyIds: number[]; - targetLanguageIds: number[]; + name: string; + /** + * @description Namespace of key + * @example homepage + */ + namespace?: string; }; - ModifiedEntityModel: { - description?: { + KeyWithDataModel: { + /** @description Custom values of the key */ + custom: { [key: string]: Record; }; - entityClass: string; - /** Format: int64 */ - entityId: number; - exists?: boolean; - modifications?: { - [key: string]: components["schemas"]["PropertyModification"]; - }; - relations?: { - [key: string]: components["schemas"]["ExistenceEntityDescription"]; + /** + * @description Description of key + * @example This key is used on homepage. It's a label of sign up button. + */ + description?: string; + /** + * Format: int64 + * @description Id of key record + */ + id: number; + /** @description If key is pluralized. If it will be reflected in the editor */ + isPlural: boolean; + /** + * @description Name of key + * @example this_is_super_key + */ + name: string; + /** + * @description Namespace of key + * @example homepage + */ + namespace?: string; + /** @description The argument name for the plural */ + pluralArgName?: string; + /** @description Screenshots of the key */ + screenshots: components["schemas"]["ScreenshotModel"][]; + /** @description Tags of key */ + tags: components["schemas"]["TagModel"][]; + /** + * @description Translations object containing values updated in this request + * @example { + * "en": { + * "id": 100000003, + * "text": "This is super translation!" + * } + * } + */ + translations: { + [key: string]: components["schemas"]["TranslationModel"]; }; }; - MtServiceDTO: { - defaultEnabledForProject: boolean; - enabled: boolean; - }; - /** @description Info about enabled services */ - MtServiceInfo: { - /** @enum {string} */ - formality?: "FORMAL" | "INFORMAL" | "DEFAULT"; - /** @enum {string} */ - serviceType: "GOOGLE" | "AWS" | "DEEPL" | "AZURE" | "BAIDU" | "TOLGEE"; - }; - MtServicesDTO: { - /** @enum {string} */ - defaultPrimaryService?: "GOOGLE" | "AWS" | "DEEPL" | "AZURE" | "BAIDU" | "TOLGEE"; - services: { - [key: string]: components["schemas"]["MtServiceDTO"]; + KeyWithTranslationsModel: { + /** @description There is a context available for this key */ + contextPresent: boolean; + /** + * Format: int64 + * @description The time when the key was created + */ + createdAt: number; + /** + * @description The namespace of the key + * @example homepage + */ + keyDescription?: string; + /** + * Format: int64 + * @description Id of key record + */ + keyId: number; + /** + * @description Is this key a plural? + * @example true + */ + keyIsPlural: boolean; + /** + * @description Name of key + * @example this_is_super_key + */ + keyName: string; + /** + * @description The namespace of the key + * @example homepage + */ + keyNamespace?: string; + /** + * Format: int64 + * @description The namespace id of the key + * @example 100000282 + */ + keyNamespaceId?: number; + /** + * @description The placeholder name for plural parameter + * @example value + */ + keyPluralArgName?: string; + /** @description Tags of key */ + keyTags: components["schemas"]["TagModel"][]; + /** + * Format: int64 + * @description Count of screenshots provided for the key + * @example 1 + */ + screenshotCount: number; + /** @description Key screenshots. Not provided when API key hasn't screenshots.view scope permission. */ + screenshots?: components["schemas"]["ScreenshotModel"][]; + /** @description Tasks related to this key */ + tasks?: components["schemas"]["KeyTaskViewModel"][]; + /** + * @description Translations object + * @example + * { + * "en": { + * "id": 100000003, + * "text": "This is super translation!" + * "state": "TRANSLATED", + * "commentCount": 1 + * } + * } + * + */ + translations: { + [key: string]: components["schemas"]["TranslationViewModel"]; }; }; - MtSupportedService: { - formalitySupported: boolean; - /** @enum {string} */ - serviceType: "GOOGLE" | "AWS" | "DEEPL" | "AZURE" | "BAIDU" | "TOLGEE"; + KeysScopeView: { + /** Format: int64 */ + characterCount: number; + /** Format: int64 */ + keyCount: number; + /** Format: int64 */ + keyCountIncludingConflicts: number; + /** Format: int64 */ + wordCount: number; }; - NamespaceModel: { + KeysWithTranslationsPageModel: { + _embedded?: { + keys?: components["schemas"]["KeyWithTranslationsModel"][]; + }; /** - * Format: int64 - * @description The id of namespace - * @example 10000048 + * @description Cursor to get next data + * @example eyJrZXlJZCI6eyJkaXJlY3Rpb24iOiJBU0MiLCJ2YWx1ZSI6IjEwMDAwMDAxMjAifX0= */ + nextCursor?: string; + page?: components["schemas"]["PageMetadata"]; + pagedModel?: components["schemas"]["PagedModelKeyWithTranslationsModel"]; + /** @description Provided languages data */ + selectedLanguages: components["schemas"]["LanguageModel"][]; + }; + LabelModel: { + color: string; + description?: string; + /** Format: int64 */ id: number; - /** @example homepage */ name: string; }; - OAuthPublicConfigDTO: { - clientId?: string; - enabled: boolean; - }; - OAuthPublicExtendsConfigDTO: { - authorizationUrl?: string; - clientId?: string; - enabled: boolean; - scopes?: string[]; - }; - OrganizationDto: { - /** @example This is a beautiful organization full of beautiful and clever people */ + LabelRequest: { + /** + * @description Hex color in format #RRGGBB. + * @example #FF5733 + */ + color: string; description?: string; - /** @example Beautiful organization */ name: string; - /** @example btforg */ - slug?: string; - }; - OrganizationInvitationModel: { - code: string; - /** Format: date-time */ - createdAt: string; - createdBy?: components["schemas"]["SimpleUserAccountModel"]; - /** Format: int64 */ - id: number; - invitedUserEmail?: string; - invitedUserName?: string; - /** @enum {string} */ - type: "MEMBER" | "OWNER"; }; - OrganizationInviteUserDto: { - /** @description Email to send invitation to */ - email?: string; - /** @description Name of invited user */ - name?: string; - /** @enum {string} */ - roleType: "MEMBER" | "OWNER"; + LabelTranslationsRequest: { + keyIds: number[]; + labelIds: number[]; + languageIds: number[]; }; - OrganizationModel: { - avatar?: components["schemas"]["Avatar"]; - basePermissions: components["schemas"]["PermissionModel"]; + LanguageAiPromptCustomizationModel: { /** - * @description The role of currently authorized user. + * @description The language description used in the prompt that helps AI translator to fine tune results for specific language + * @example For arabic language, we are super formal. Always use these translations: + * Paper -> ورقة + * Office -> مكتب * - * Can be null when user has direct access to one of the projects owned by the organization. - * @enum {string} */ - currentUserRole?: "MEMBER" | "OWNER"; - /** @example This is a beautiful organization full of beautiful and clever people */ description?: string; + language: components["schemas"]["LanguageModel"]; + }; + LanguageConfigItemModel: { + /** + * @deprecated + * @description Services to be used for suggesting (deprecated: use enabledServicesInfo) + */ + enabledServices: ("GOOGLE" | "AWS" | "DEEPL" | "AZURE" | "BAIDU" | "PROMPT")[]; + /** @description Info about enabled services */ + enabledServicesInfo: components["schemas"]["MtServiceInfo"][]; + /** + * @deprecated + * @description Service used for automated translating (deprecated: use primaryServiceInfo) + * @enum {string} + */ + primaryService?: "GOOGLE" | "AWS" | "DEEPL" | "AZURE" | "BAIDU" | "PROMPT"; + primaryServiceInfo?: components["schemas"]["MtServiceInfo"]; + /** + * Format: int64 + * @description When null, its a default configuration applied to not configured languages + */ + targetLanguageId?: number; + /** @description When null, its a default configuration applied to not configured languages */ + targetLanguageName?: string; + /** @description When null, its a default configuration applied to not configured languages */ + targetLanguageTag?: string; + }; + LanguageInfoModel: { + /** Format: int64 */ + languageId?: number; + languageTag?: string; + supportedServices: components["schemas"]["MtSupportedService"][]; + }; + /** @description Maps the languages from imported files to languages existing in the Tolgee platform. + * + * Use this field only when your files contain multiple languages (e.g., XLIFF files). + * + * Otherwise, use the `languageTag` property of `fileMappings`. + * + * Example: In xliff files, there are `source-language` and `target-language` attributes defined on `file` element. Using this field you can map source and target values to languages stored in the Tolgee Platform. */ + LanguageMapping: { + /** + * @description The language from the imported file. + * + * For xliff files, this is the `source-language` or the `target-language` attribute value of `file` element. + * @example en-US + */ + importLanguage: string; + /** + * @description The tag of language existing in the Tolgee platform to which the imported language should be mapped. + * @example en-US + */ + platformLanguageTag: string; + }; + LanguageModel: { + /** + * @description Whether is base language of project + * @example false + */ + base: boolean; + /** + * @description Language flag emoji as UTF-8 emoji + * @example 🇨🇿 + */ + flagEmoji?: string; /** Format: int64 */ id: number; - /** @example Beautiful organization */ + /** + * @description Language name in english + * @example Czech + */ name: string; - /** @example btforg */ - slug: string; + /** + * @description Language name in this language + * @example čeština + */ + originalName?: string; + /** + * @description Language tag according to BCP 47 definition + * @example cs-CZ + */ + tag: string; }; - PageMetadata: { + LanguageRequest: { + /** + * @description Language flag emoji as UTF-8 emoji + * @example 🇨🇿 + */ + flagEmoji?: string; + /** + * @description Language name in english + * @example Czech + */ + name: string; + /** + * @description Language name in this language + * @example čeština + */ + originalName: string; + /** + * @description Language tag according to BCP 47 definition + * @example cs-CZ + */ + tag: string; + }; + LanguageStatsModel: { + languageFlagEmoji?: string; /** Format: int64 */ - number?: number; + languageId?: number; + languageName?: string; + languageOriginalName?: string; + languageTag?: string; /** Format: int64 */ - size?: number; + reviewedKeyCount: number; + /** Format: double */ + reviewedPercentage: number; /** Format: int64 */ - totalElements?: number; + reviewedWordCount: number; /** Format: int64 */ - totalPages?: number; - }; - Pageable: { - /** Format: int32 */ - page?: number; - /** Format: int32 */ - size?: number; - sort?: string[]; + translatedKeyCount: number; + /** Format: double */ + translatedPercentage: number; + /** Format: int64 */ + translatedWordCount: number; + /** Format: date-time */ + translationsUpdatedAt?: string; + /** Format: int64 */ + untranslatedKeyCount: number; + /** Format: double */ + untranslatedPercentage: number; + /** Format: int64 */ + untranslatedWordCount: number; }; - PagedModelApiKeyModel: { - _embedded?: { - apiKeys?: components["schemas"]["ApiKeyModel"][]; - }; - page?: components["schemas"]["PageMetadata"]; + LlmMessage: { + image?: string; + text?: string; + /** @enum {string} */ + type: "TEXT" | "IMAGE"; }; - PagedModelBatchJobModel: { - _embedded?: { - batchJobs?: components["schemas"]["BatchJobModel"][]; - }; - page?: components["schemas"]["PageMetadata"]; + LlmParams: { + messages: components["schemas"]["LlmMessage"][]; + /** @enum {string} */ + priority: "LOW" | "HIGH"; + shouldOutputJson: boolean; + }; + LlmProviderModel: { + apiKey?: string; + apiUrl?: string; + deployment?: string; + format?: string; + /** Format: int64 */ + id: number; + model?: string; + name: string; + /** @enum {string} */ + priority?: "LOW" | "HIGH"; + /** @enum {string} */ + type: "OPENAI" | "OPENAI_AZURE" | "TOLGEE" | "ANTHROPIC" | "GOOGLE_AI"; + }; + LlmProviderRequest: { + apiKey?: string; + apiUrl: string; + deployment?: string; + format?: string; + keepAlive?: string; + model?: string; + name: string; + /** @enum {string} */ + priority?: "LOW" | "HIGH"; + /** @enum {string} */ + type: "OPENAI" | "OPENAI_AZURE" | "TOLGEE" | "ANTHROPIC" | "GOOGLE_AI"; }; - PagedModelContentDeliveryConfigModel: { - _embedded?: { - contentDeliveryConfigs?: components["schemas"]["ContentDeliveryConfigModel"][]; - }; - page?: components["schemas"]["PageMetadata"]; + LlmProviderSimpleModel: { + name: string; + source?: string; + /** @enum {string} */ + type: "OPENAI" | "OPENAI_AZURE" | "TOLGEE" | "ANTHROPIC" | "GOOGLE_AI"; }; - PagedModelContentStorageModel: { - _embedded?: { - contentStorages?: components["schemas"]["ContentStorageModel"][]; - }; - page?: components["schemas"]["PageMetadata"]; + LoginRequest: { + otp?: string; + password: string; + username: string; }; - PagedModelImportFileIssueModel: { - _embedded?: { - importFileIssues?: components["schemas"]["ImportFileIssueModel"][]; - }; - page?: components["schemas"]["PageMetadata"]; + MachineTranslationLanguagePropsDto: { + /** + * @deprecated + * @description List of enabled services (deprecated: use enabledServicesInfo) + */ + enabledServices?: ("GOOGLE" | "AWS" | "DEEPL" | "AZURE" | "BAIDU" | "PROMPT")[]; + /** @description Info about enabled services */ + enabledServicesInfo?: components["schemas"]["MtServiceInfo"][]; + /** + * @deprecated + * @description This service will be used for automated translation + * @enum {string} + */ + primaryService?: "GOOGLE" | "AWS" | "DEEPL" | "AZURE" | "BAIDU" | "PROMPT"; + primaryServiceInfo?: components["schemas"]["MtServiceInfo"]; + /** + * Format: int64 + * @description The language to apply those rules. If null, then this settings are default. + */ + targetLanguageId?: number; }; - PagedModelImportLanguageModel: { - _embedded?: { - languages?: components["schemas"]["ImportLanguageModel"][]; - }; - page?: components["schemas"]["PageMetadata"]; + MachineTranslationProviderModel: { + /** @description BCP 47 tags of languages supported by the translation service. When null, all possible languages are supported. + * + * Please note that Tolgee tries to fall back to a higher subtag if the subtag is not supported. + * + * E.g., if `pt-BR` is not supported. Tolgee fallbacks to `pt`. */ + supportedLanguages?: string[]; }; - PagedModelImportTranslationModel: { - _embedded?: { - translations?: components["schemas"]["ImportTranslationModel"][]; - }; - page?: components["schemas"]["PageMetadata"]; + MachineTranslationRequest: { + keyIds: number[]; + llmPrompt?: components["schemas"]["PromptDto"]; + targetLanguageIds: number[]; }; - PagedModelKeyModel: { - _embedded?: { - keys?: components["schemas"]["KeyModel"][]; + ModifiedEntityModel: { + description?: { + [key: string]: Record; }; - page?: components["schemas"]["PageMetadata"]; - }; + entityClass: string; + /** Format: int64 */ + entityId: number; + exists?: boolean; + modifications?: { + [key: string]: components["schemas"]["PropertyModification"]; + }; + relations?: { + [key: string]: components["schemas"]["ExistenceEntityDescription"]; + }; + }; + MtServiceDTO: { + defaultEnabledForProject: boolean; + enabled: boolean; + }; + /** @description Info about enabled services */ + MtServiceInfo: { + /** @enum {string} */ + formality?: "FORMAL" | "INFORMAL" | "DEFAULT"; + /** Format: int64 */ + promptId?: number; + /** @enum {string} */ + serviceType: "GOOGLE" | "AWS" | "DEEPL" | "AZURE" | "BAIDU" | "PROMPT"; + }; + MtServicesDTO: { + services: { + [key: string]: components["schemas"]["MtServiceDTO"]; + }; + }; + MtSupportedService: { + formalitySupported: boolean; + /** @enum {string} */ + serviceType: "GOOGLE" | "AWS" | "DEEPL" | "AZURE" | "BAIDU" | "PROMPT"; + }; + NamespaceModel: { + /** + * Format: int64 + * @description The id of namespace + * @example 10000048 + */ + id: number; + /** @example homepage */ + name: string; + }; + NotificationModel: { + /** Format: date-time */ + createdAt?: string; + /** Format: int64 */ + id: number; + linkedTask?: components["schemas"]["TaskModel"]; + originatingUser?: components["schemas"]["SimpleUserAccountModel"]; + project?: components["schemas"]["SimpleProjectModel"]; + /** @enum {string} */ + type: "TASK_ASSIGNED" | "TASK_FINISHED" | "TASK_CANCELED" | "MFA_ENABLED" | "MFA_DISABLED" | "PASSWORD_CHANGED"; + }; + NotificationSettingGroupModel: { + email: boolean; + inApp: boolean; + }; + NotificationSettingModel: { + accountSecurity: components["schemas"]["NotificationSettingGroupModel"]; + tasks: components["schemas"]["NotificationSettingGroupModel"]; + }; + NotificationSettingsRequest: { + /** + * @example IN_APP + * @enum {string} + */ + channel: "IN_APP" | "EMAIL"; + /** + * @description True if the setting should be enabled, false for disabled + * @example false + */ + enabled: boolean; + /** + * @example TASKS + * @enum {string} + */ + group: "ACCOUNT_SECURITY" | "TASKS"; + }; + NotificationsMarkSeenRequest: { + /** + * @description Notification IDs to be marked as seen + * @example [ + * 1, + * 2, + * 3 + * ] + */ + notificationIds: number[]; + }; + OAuthPublicConfigDTO: { + clientId?: string; + enabled: boolean; + }; + OAuthPublicExtendsConfigDTO: { + authorizationUrl?: string; + clientId?: string; + enabled: boolean; + scopes?: string[]; + }; + OrganizationDto: { + /** @example This is a beautiful organization full of beautiful and clever people */ + description?: string; + /** @example Beautiful organization */ + name: string; + /** @example btforg */ + slug?: string; + }; + OrganizationInvitationModel: { + code: string; + /** Format: date-time */ + createdAt: string; + createdBy?: components["schemas"]["SimpleUserAccountModel"]; + /** Format: int64 */ + id: number; + invitedUserEmail?: string; + invitedUserName?: string; + /** @enum {string} */ + type: "MEMBER" | "OWNER" | "MAINTAINER"; + }; + OrganizationInviteUserDto: { + /** @description Email to send invitation to */ + email?: string; + /** @description Name of invited user */ + name?: string; + /** @enum {string} */ + roleType: "MEMBER" | "OWNER" | "MAINTAINER"; + }; + OrganizationLanguageModel: { + /** + * @description Whether is base language of any project + * @example false + */ + base: boolean; + /** + * @description Language flag emoji as UTF-8 emoji + * @example 🇨🇿 + */ + flagEmoji?: string; + /** + * @description Language name in english + * @example Czech + */ + name: string; + /** + * @description Language name in this language + * @example čeština + */ + originalName?: string; + /** + * @description Language tag according to BCP 47 definition + * @example cs-CZ + */ + tag: string; + }; + OrganizationModel: { + avatar?: components["schemas"]["Avatar"]; + basePermissions: components["schemas"]["PermissionModel"]; + /** + * @description The role of currently authorized user. + * + * Can be null when user has direct access to one of the projects owned by the organization. + * @enum {string} + */ + currentUserRole?: "MEMBER" | "OWNER" | "MAINTAINER"; + /** @example This is a beautiful organization full of beautiful and clever people */ + description?: string; + /** Format: int64 */ + id: number; + /** @example Beautiful organization */ + name: string; + /** @example btforg */ + slug: string; + }; + PageMetadata: { + /** Format: int64 */ + number?: number; + /** Format: int64 */ + size?: number; + /** Format: int64 */ + totalElements?: number; + /** Format: int64 */ + totalPages?: number; + }; + Pageable: { + /** Format: int32 */ + page?: number; + /** Format: int32 */ + size?: number; + sort?: string[]; + }; + PagedModelApiKeyModel: { + _embedded?: { + apiKeys?: components["schemas"]["ApiKeyModel"][]; + }; + page?: components["schemas"]["PageMetadata"]; + }; + PagedModelBatchJobModel: { + _embedded?: { + batchJobs?: components["schemas"]["BatchJobModel"][]; + }; + page?: components["schemas"]["PageMetadata"]; + }; + PagedModelContentDeliveryConfigModel: { + _embedded?: { + contentDeliveryConfigs?: components["schemas"]["ContentDeliveryConfigModel"][]; + }; + page?: components["schemas"]["PageMetadata"]; + }; + PagedModelContentStorageModel: { + _embedded?: { + contentStorages?: components["schemas"]["ContentStorageModel"][]; + }; + page?: components["schemas"]["PageMetadata"]; + }; + PagedModelImportFileIssueModel: { + _embedded?: { + importFileIssues?: components["schemas"]["ImportFileIssueModel"][]; + }; + page?: components["schemas"]["PageMetadata"]; + }; + PagedModelImportLanguageModel: { + _embedded?: { + languages?: components["schemas"]["ImportLanguageModel"][]; + }; + page?: components["schemas"]["PageMetadata"]; + }; + PagedModelImportTranslationModel: { + _embedded?: { + translations?: components["schemas"]["ImportTranslationModel"][]; + }; + page?: components["schemas"]["PageMetadata"]; + }; + PagedModelKeyModel: { + _embedded?: { + keys?: components["schemas"]["KeyModel"][]; + }; + page?: components["schemas"]["PageMetadata"]; + }; PagedModelKeySearchSearchResultModel: { _embedded?: { keys?: components["schemas"]["KeySearchSearchResultModel"][]; }; page?: components["schemas"]["PageMetadata"]; }; + PagedModelKeyWithTranslationsModel: { + _embedded?: { + keys?: components["schemas"]["KeyWithTranslationsModel"][]; + }; + page?: components["schemas"]["PageMetadata"]; + }; + PagedModelLabelModel: { + _embedded?: { + labels?: components["schemas"]["LabelModel"][]; + }; + page?: components["schemas"]["PageMetadata"]; + }; PagedModelLanguageModel: { _embedded?: { languages?: components["schemas"]["LanguageModel"][]; @@ -6005,6 +7101,18 @@ export interface components { }; page?: components["schemas"]["PageMetadata"]; }; + PagedModelNotificationModel: { + _embedded?: { + notificationModelList?: components["schemas"]["NotificationModel"][]; + }; + page?: components["schemas"]["PageMetadata"]; + }; + PagedModelOrganizationLanguageModel: { + _embedded?: { + languages?: components["schemas"]["OrganizationLanguageModel"][]; + }; + page?: components["schemas"]["PageMetadata"]; + }; PagedModelOrganizationModel: { _embedded?: { organizations?: components["schemas"]["OrganizationModel"][]; @@ -6035,6 +7143,36 @@ export interface components { }; page?: components["schemas"]["PageMetadata"]; }; + PagedModelPromptModel: { + _embedded?: { + prompts?: components["schemas"]["PromptModel"][]; + }; + page?: components["schemas"]["PageMetadata"]; + }; + PagedModelSimpleGlossaryModel: { + _embedded?: { + glossaries?: components["schemas"]["SimpleGlossaryModel"][]; + }; + page?: components["schemas"]["PageMetadata"]; + }; + PagedModelSimpleGlossaryTermModel: { + _embedded?: { + glossaryTerms?: components["schemas"]["SimpleGlossaryTermModel"][]; + }; + page?: components["schemas"]["PageMetadata"]; + }; + PagedModelSimpleGlossaryTermWithTranslationsModel: { + _embedded?: { + glossaryTerms?: components["schemas"]["SimpleGlossaryTermWithTranslationsModel"][]; + }; + page?: components["schemas"]["PageMetadata"]; + }; + PagedModelSimpleGlossaryWithStatsModel: { + _embedded?: { + glossaries?: components["schemas"]["SimpleGlossaryWithStatsModel"][]; + }; + page?: components["schemas"]["PageMetadata"]; + }; PagedModelSimpleUserAccountModel: { _embedded?: { users?: components["schemas"]["SimpleUserAccountModel"][]; @@ -6101,6 +7239,18 @@ export interface components { }; page?: components["schemas"]["PageMetadata"]; }; + PagedModelWithNextCursorNotificationModel: { + _embedded?: { + notificationModelList?: components["schemas"]["NotificationModel"][]; + }; + /** + * @description Cursor to get next data + * @example eyJrZXlJZCI6eyJkaXJlY3Rpb24iOiJBU0MiLCJ2YWx1ZSI6IjEwMDAwMDAxMjAifX0= + */ + nextCursor?: string; + page?: components["schemas"]["PageMetadata"]; + pagedModel?: components["schemas"]["PagedModelNotificationModel"]; + }; PatModel: { /** Format: int64 */ createdAt: number; @@ -6128,10 +7278,6 @@ export interface components { updatedAt: number; user: components["schemas"]["SimpleUserAccountModel"]; }; - /** - * @description Current user's direct permission - * @example MANAGE - */ PermissionModel: { /** * @deprecated @@ -6151,7 +7297,7 @@ export interface components { * "TRANSLATIONS_VIEW" * ] */ - scopes: ("translations.view" | "translations.edit" | "keys.edit" | "screenshots.upload" | "screenshots.delete" | "screenshots.view" | "activity.view" | "languages.edit" | "admin" | "project.edit" | "members.view" | "members.edit" | "translation-comments.add" | "translation-comments.edit" | "translation-comments.set-state" | "translations.state-edit" | "keys.view" | "keys.delete" | "keys.create" | "batch-jobs.view" | "batch-jobs.cancel" | "translations.batch-by-tm" | "translations.batch-machine" | "content-delivery.manage" | "content-delivery.publish" | "webhooks.manage" | "tasks.view" | "tasks.edit")[]; + scopes: ("translations.view" | "translations.edit" | "keys.edit" | "screenshots.upload" | "screenshots.delete" | "screenshots.view" | "activity.view" | "languages.edit" | "admin" | "project.edit" | "members.view" | "members.edit" | "translation-comments.add" | "translation-comments.edit" | "translation-comments.set-state" | "translations.state-edit" | "keys.view" | "keys.delete" | "keys.create" | "batch-jobs.view" | "batch-jobs.cancel" | "translations.batch-by-tm" | "translations.batch-machine" | "content-delivery.manage" | "content-delivery.publish" | "webhooks.manage" | "tasks.view" | "tasks.edit" | "prompts.view" | "prompts.edit" | "translation-labels.manage" | "translation-labels.assign")[]; /** * @description List of languages user can change state to. If null, changing state of all language values is permitted. * @example [ @@ -6202,7 +7348,7 @@ export interface components { * "TRANSLATIONS_VIEW" * ] */ - scopes: ("translations.view" | "translations.edit" | "keys.edit" | "screenshots.upload" | "screenshots.delete" | "screenshots.view" | "activity.view" | "languages.edit" | "admin" | "project.edit" | "members.view" | "members.edit" | "translation-comments.add" | "translation-comments.edit" | "translation-comments.set-state" | "translations.state-edit" | "keys.view" | "keys.delete" | "keys.create" | "batch-jobs.view" | "batch-jobs.cancel" | "translations.batch-by-tm" | "translations.batch-machine" | "content-delivery.manage" | "content-delivery.publish" | "webhooks.manage" | "tasks.view" | "tasks.edit")[]; + scopes: ("translations.view" | "translations.edit" | "keys.edit" | "screenshots.upload" | "screenshots.delete" | "screenshots.view" | "activity.view" | "languages.edit" | "admin" | "project.edit" | "members.view" | "members.edit" | "translation-comments.add" | "translation-comments.edit" | "translation-comments.set-state" | "translations.state-edit" | "keys.view" | "keys.delete" | "keys.create" | "batch-jobs.view" | "batch-jobs.cancel" | "translations.batch-by-tm" | "translations.batch-machine" | "content-delivery.manage" | "content-delivery.publish" | "webhooks.manage" | "tasks.view" | "tasks.edit" | "prompts.view" | "prompts.edit" | "translation-labels.manage" | "translation-labels.assign")[]; /** * @description List of languages user can change state to. If null, changing state of all language values is permitted. * @example [ @@ -6234,17 +7380,18 @@ export interface components { viewLanguageIds?: number[]; }; PlanIncludedUsageModel: { + /** Format: int64 */ + keys: number; /** Format: int64 */ mtCredits: number; /** Format: int64 */ seats: number; /** Format: int64 */ - translationSlots: number; - /** Format: int64 */ translations: number; }; PlanPricesModel: { perSeat: number; + perThousandKeys: number; perThousandMtCredits?: number; perThousandTranslations?: number; subscriptionMonthly: number; @@ -6255,6 +7402,12 @@ export interface components { scriptUrl: string; url: string; }; + PositionModel: { + /** Format: int32 */ + end: number; + /** Format: int32 */ + start: number; + }; PreTranslationByTmRequest: { keyIds: number[]; targetLanguageIds: number[]; @@ -6273,11 +7426,11 @@ export interface components { * Can be null when user has direct access to one of the projects owned by the organization. * @enum {string} */ - currentUserRole?: "MEMBER" | "OWNER"; + currentUserRole?: "MEMBER" | "OWNER" | "MAINTAINER"; /** @example This is a beautiful organization full of beautiful and clever people */ description?: string; /** @example Features organization has enabled */ - enabledFeatures: ("GRANULAR_PERMISSIONS" | "PRIORITIZED_FEATURE_REQUESTS" | "PREMIUM_SUPPORT" | "DEDICATED_SLACK_CHANNEL" | "ASSISTED_UPDATES" | "DEPLOYMENT_ASSISTANCE" | "BACKUP_CONFIGURATION" | "TEAM_TRAINING" | "ACCOUNT_MANAGER" | "STANDARD_SUPPORT" | "PROJECT_LEVEL_CONTENT_STORAGES" | "WEBHOOKS" | "MULTIPLE_CONTENT_DELIVERY_CONFIGS" | "AI_PROMPT_CUSTOMIZATION" | "SLACK_INTEGRATION" | "TASKS" | "SSO" | "ORDER_TRANSLATION")[]; + enabledFeatures: ("GRANULAR_PERMISSIONS" | "PRIORITIZED_FEATURE_REQUESTS" | "PREMIUM_SUPPORT" | "DEDICATED_SLACK_CHANNEL" | "ASSISTED_UPDATES" | "DEPLOYMENT_ASSISTANCE" | "BACKUP_CONFIGURATION" | "TEAM_TRAINING" | "ACCOUNT_MANAGER" | "STANDARD_SUPPORT" | "PROJECT_LEVEL_CONTENT_STORAGES" | "WEBHOOKS" | "MULTIPLE_CONTENT_DELIVERY_CONFIGS" | "AI_PROMPT_CUSTOMIZATION" | "SLACK_INTEGRATION" | "TASKS" | "SSO" | "ORDER_TRANSLATION" | "GLOSSARY" | "TRANSLATION_LABELS")[]; /** Format: int64 */ id: number; /** @example Beautiful organization */ @@ -6292,6 +7445,7 @@ export interface components { accountType: "LOCAL" | "MANAGED" | "THIRD_PARTY"; avatar?: components["schemas"]["Avatar"]; deletable: boolean; + domain?: string; emailAwaitingVerification?: string; /** @enum {string} */ globalServerRole: "USER" | "ADMIN"; @@ -6300,6 +7454,8 @@ export interface components { mfaEnabled: boolean; name?: string; needsSuperJwtToken: boolean; + /** @enum {string} */ + thirdPartyAuthType?: "GOOGLE" | "GITHUB" | "OAUTH2" | "SSO" | "SSO_GLOBAL"; username: string; }; ProjectActivityAuthorModel: { @@ -6327,7 +7483,7 @@ export interface components { /** Format: int64 */ timestamp: number; /** @enum {string} */ - type: "UNKNOWN" | "SET_TRANSLATION_STATE" | "SET_TRANSLATIONS" | "DISMISS_AUTO_TRANSLATED_STATE" | "SET_OUTDATED_FLAG" | "TRANSLATION_COMMENT_ADD" | "TRANSLATION_COMMENT_DELETE" | "TRANSLATION_COMMENT_EDIT" | "TRANSLATION_COMMENT_SET_STATE" | "SCREENSHOT_DELETE" | "SCREENSHOT_ADD" | "KEY_TAGS_EDIT" | "KEY_NAME_EDIT" | "KEY_DELETE" | "CREATE_KEY" | "COMPLEX_EDIT" | "IMPORT" | "CREATE_LANGUAGE" | "EDIT_LANGUAGE" | "DELETE_LANGUAGE" | "HARD_DELETE_LANGUAGE" | "CREATE_PROJECT" | "EDIT_PROJECT" | "NAMESPACE_EDIT" | "BATCH_PRE_TRANSLATE_BY_TM" | "BATCH_MACHINE_TRANSLATE" | "AUTO_TRANSLATE" | "BATCH_CLEAR_TRANSLATIONS" | "BATCH_COPY_TRANSLATIONS" | "BATCH_SET_TRANSLATION_STATE" | "BATCH_TAG_KEYS" | "BATCH_UNTAG_KEYS" | "BATCH_SET_KEYS_NAMESPACE" | "AUTOMATION" | "CONTENT_DELIVERY_CONFIG_CREATE" | "CONTENT_DELIVERY_CONFIG_UPDATE" | "CONTENT_DELIVERY_CONFIG_DELETE" | "CONTENT_STORAGE_CREATE" | "CONTENT_STORAGE_UPDATE" | "CONTENT_STORAGE_DELETE" | "WEBHOOK_CONFIG_CREATE" | "WEBHOOK_CONFIG_UPDATE" | "WEBHOOK_CONFIG_DELETE" | "COMPLEX_TAG_OPERATION" | "TASKS_CREATE" | "TASK_CREATE" | "TASK_UPDATE" | "TASK_KEYS_UPDATE" | "TASK_FINISH" | "TASK_CLOSE" | "TASK_REOPEN" | "TASK_KEY_UPDATE" | "ORDER_TRANSLATION"; + type: "UNKNOWN" | "SET_TRANSLATION_STATE" | "SET_TRANSLATIONS" | "DISMISS_AUTO_TRANSLATED_STATE" | "SET_OUTDATED_FLAG" | "TRANSLATION_COMMENT_ADD" | "TRANSLATION_COMMENT_DELETE" | "TRANSLATION_COMMENT_EDIT" | "TRANSLATION_COMMENT_SET_STATE" | "SCREENSHOT_DELETE" | "SCREENSHOT_ADD" | "KEY_TAGS_EDIT" | "KEY_NAME_EDIT" | "KEY_DELETE" | "CREATE_KEY" | "COMPLEX_EDIT" | "IMPORT" | "CREATE_LANGUAGE" | "EDIT_LANGUAGE" | "DELETE_LANGUAGE" | "HARD_DELETE_LANGUAGE" | "CREATE_PROJECT" | "EDIT_PROJECT" | "NAMESPACE_EDIT" | "BATCH_PRE_TRANSLATE_BY_TM" | "BATCH_MACHINE_TRANSLATE" | "AUTO_TRANSLATE" | "BATCH_CLEAR_TRANSLATIONS" | "BATCH_COPY_TRANSLATIONS" | "BATCH_SET_TRANSLATION_STATE" | "BATCH_TAG_KEYS" | "BATCH_UNTAG_KEYS" | "BATCH_SET_KEYS_NAMESPACE" | "BATCH_ASSIGN_TRANSLATION_LABEL" | "BATCH_UNASSIGN_TRANSLATION_LABEL" | "AUTOMATION" | "CONTENT_DELIVERY_CONFIG_CREATE" | "CONTENT_DELIVERY_CONFIG_UPDATE" | "CONTENT_DELIVERY_CONFIG_DELETE" | "CONTENT_STORAGE_CREATE" | "CONTENT_STORAGE_UPDATE" | "CONTENT_STORAGE_DELETE" | "WEBHOOK_CONFIG_CREATE" | "WEBHOOK_CONFIG_UPDATE" | "WEBHOOK_CONFIG_DELETE" | "COMPLEX_TAG_OPERATION" | "TASKS_CREATE" | "TASK_CREATE" | "TASK_UPDATE" | "TASK_KEYS_UPDATE" | "TASK_FINISH" | "TASK_CLOSE" | "TASK_REOPEN" | "TASK_KEY_UPDATE" | "ORDER_TRANSLATION" | "GLOSSARY_CREATE" | "GLOSSARY_UPDATE" | "GLOSSARY_DELETE" | "GLOSSARY_TERM_CREATE" | "GLOSSARY_TERM_UPDATE" | "GLOSSARY_TERM_DELETE" | "GLOSSARY_TERM_TRANSLATION_UPDATE" | "TRANSLATION_LABELS_EDIT" | "TRANSLATION_LABEL_ASSIGN" | "TRANSLATION_LABEL_CREATE" | "TRANSLATION_LABEL_UPDATE" | "TRANSLATION_LABEL_DELETE"; }; ProjectAiPromptCustomizationModel: { /** @@ -6405,7 +7561,7 @@ export interface components { name: string; organizationOwner?: components["schemas"]["SimpleOrganizationModel"]; /** @enum {string} */ - organizationRole?: "MEMBER" | "OWNER"; + organizationRole?: "MEMBER" | "OWNER" | "MAINTAINER"; slug?: string; useNamespaces: boolean; }; @@ -6461,10 +7617,68 @@ export interface components { name: string; organizationOwner?: components["schemas"]["SimpleOrganizationModel"]; /** @enum {string} */ - organizationRole?: "MEMBER" | "OWNER"; + organizationRole?: "MEMBER" | "OWNER" | "MAINTAINER"; slug?: string; stats: components["schemas"]["ProjectStatistics"]; }; + PromptDto: { + basicPromptOptions?: ("KEY_NAME" | "KEY_DESCRIPTION" | "KEY_CONTEXT" | "PROJECT_DESCRIPTION" | "LANGUAGE_NOTES" | "TM_SUGGESTIONS" | "SCREENSHOT" | "GLOSSARY")[]; + name: string; + providerName: string; + template?: string; + }; + PromptModel: { + basicPromptOptions?: ("KEY_NAME" | "KEY_DESCRIPTION" | "KEY_CONTEXT" | "PROJECT_DESCRIPTION" | "LANGUAGE_NOTES" | "TM_SUGGESTIONS" | "SCREENSHOT" | "GLOSSARY")[]; + /** Format: int64 */ + id: number; + name: string; + /** Format: int64 */ + projectId: number; + providerName: string; + template?: string; + }; + PromptResponseDto: { + parsedJson?: components["schemas"]["JsonNode"]; + /** Format: int32 */ + price?: number; + prompt: string; + result: string; + usage?: components["schemas"]["PromptResponseUsageDto"]; + }; + PromptResponseUsageDto: { + /** Format: int64 */ + cachedTokens?: number; + /** Format: int64 */ + inputTokens?: number; + /** Format: int64 */ + outputTokens?: number; + }; + PromptResult: { + parsedJson?: components["schemas"]["JsonNode"]; + /** Format: int32 */ + price: number; + response: string; + usage?: components["schemas"]["PromptResponseUsageDto"]; + }; + PromptRunDto: { + basicPromptOptions?: ("KEY_NAME" | "KEY_DESCRIPTION" | "KEY_CONTEXT" | "PROJECT_DESCRIPTION" | "LANGUAGE_NOTES" | "TM_SUGGESTIONS" | "SCREENSHOT" | "GLOSSARY")[]; + /** Format: int64 */ + keyId: number; + provider: string; + /** Format: int64 */ + targetLanguageId: number; + template?: string; + }; + PromptVariableDto: { + description?: string; + name: string; + /** @description List of nested properties for this variable, allowing hierarchical structuring. */ + props?: components["schemas"]["PromptVariableDto"][] | null; + /** @enum {string} */ + type: "FRAGMENT" | "OBJECT" | "STRING"; + value?: string; + }; + /** @description Modified fields */ PropertyModification: { new?: Record; old?: Record; @@ -6472,11 +7686,26 @@ export interface components { PublicBillingConfigurationDTO: { enabled: boolean; }; + PublicCloudPlanModel: { + enabledFeatures: ("GRANULAR_PERMISSIONS" | "PRIORITIZED_FEATURE_REQUESTS" | "PREMIUM_SUPPORT" | "DEDICATED_SLACK_CHANNEL" | "ASSISTED_UPDATES" | "DEPLOYMENT_ASSISTANCE" | "BACKUP_CONFIGURATION" | "TEAM_TRAINING" | "ACCOUNT_MANAGER" | "STANDARD_SUPPORT" | "PROJECT_LEVEL_CONTENT_STORAGES" | "WEBHOOKS" | "MULTIPLE_CONTENT_DELIVERY_CONFIGS" | "AI_PROMPT_CUSTOMIZATION" | "SLACK_INTEGRATION" | "TASKS" | "SSO" | "ORDER_TRANSLATION" | "GLOSSARY" | "TRANSLATION_LABELS")[]; + free: boolean; + /** Format: int64 */ + id: number; + includedUsage: components["schemas"]["PlanIncludedUsageModel"]; + /** @enum {string} */ + metricType: "KEYS_SEATS" | "STRINGS"; + name: string; + nonCommercial: boolean; + public: boolean; + /** @enum {string} */ + type: "PAY_AS_YOU_GO" | "FIXED"; + }; /** @example Current active subscription info */ PublicCloudSubscriptionModel: { cancelAtPeriodEnd: boolean; /** @enum {string} */ currentBillingPeriod?: "MONTHLY" | "YEARLY"; + plan: components["schemas"]["PublicCloudPlanModel"]; /** @enum {string} */ status: "ACTIVE" | "CANCELED" | "PAST_DUE" | "UNPAID" | "ERROR" | "TRIALING" | "KEY_USED_BY_ANOTHER_INSTANCE" | "UNKNOWN"; /** Format: int64 */ @@ -6494,6 +7723,7 @@ export interface components { contentDeliveryConfigured: boolean; ga4Tag?: string; internalControllerEnabled: boolean; + llm: components["schemas"]["PublicLlmConfigurationDTO"]; machineTranslationServices: components["schemas"]["MtServicesDTO"]; /** Format: int64 */ maxTranslationTextLength: number; @@ -6509,6 +7739,8 @@ export interface components { screenshotsUrl: string; showVersion: boolean; slack: components["schemas"]["SlackDTO"]; + /** Format: int32 */ + translationsViewLanguagesLimit: number; userCanCreateOrganizations: boolean; userSourceField: boolean; version: string; @@ -6521,6 +7753,14 @@ export interface components { organizationName?: string; projectName?: string; }; + PublicLlmConfigurationDTO: { + enabled: boolean; + }; + PublicSsoTenantModel: { + domain: string; + force: boolean; + global: boolean; + }; PublicUsageModel: { /** * Format: int64 @@ -6542,6 +7782,11 @@ export interface components { * @description Date when credits were refilled. (In epoch format) */ creditBalanceRefilledAt: number; + /** + * Format: int64 + * @description How many keys are currently stored by organization + */ + currentKeys: number; /** * Format: int64 * @description Currently used credits over credits included in plan and extra credits @@ -6549,9 +7794,9 @@ export interface components { currentPayAsYouGoMtCredits: number; /** * Format: int64 - * @description How many translations slots are currently used by organization + * @description How seats are currently used by organization */ - currentTranslationSlots: number; + currentSeats: number; /** * Format: int64 * @description How many non-empty translations are currently stored by organization @@ -6565,6 +7810,11 @@ export interface components { * This option is not available anymore and this field is kept only for backward compatibility purposes and is always 0. */ extraCreditBalance: number; + /** + * Format: int64 + * @description How many keys are included in current subscription plan. How many keys can organization use without additional costs. + */ + includedKeys: number; /** * Format: int64 * @description How many credits are included in your current plan @@ -6572,27 +7822,40 @@ export interface components { includedMtCredits: number; /** * Format: int64 - * @description How many translation slots are included in current subscription plan. How many translation slots can organization use without additional costs + * @description How many seats are included in current subscription plan. How many seats can organization use without additional costs. */ - includedTranslationSlots: number; + includedSeats: number; /** * Format: int64 * @description How many translations are included in current subscription plan. How many translations can organization use without additional costs */ includedTranslations: number; + /** @description Whether the current plan is pay-as-you-go of fixed. For pay-as-you-go plans, the spending limit is the top limit. */ + isPayAsYouGo: boolean; + /** + * Format: int64 + * @description How many keys can be stored until reaching the limit. (For pay us you go, the top limit is the spending limit) + */ + keysLimit: number; /** Format: int64 */ organizationId: number; /** * Format: int64 - * @description How many translations can be stored within your organization + * @description How many seats can be stored until reaching the limit. (For pay us you go, the top limit is the spending limit) */ - translationSlotsLimit: number; + seatsLimit: number; /** * Format: int64 * @description How many translations can be stored until reaching the limit. (For pay us you go, the top limit is the spending limit) */ translationsLimit: number; + /** + * Format: int64 + * @description Currently used credits including credits used over the limit + */ + usedMtCredits: number; }; + /** @example Quick start data for current user */ QuickStartModel: { completedSteps: string[]; finished: boolean; @@ -6666,12 +7929,15 @@ export interface components { contentStorageType?: "S3" | "AZURE"; enabled?: boolean; endpoint: string; + /** @description Specifies an optional subfolder structure within s3 bucket to which content will be stored */ + path: string; secretKey?: string; signingRegion: string; }; S3ContentStorageConfigModel: { bucketName: string; endpoint: string; + path: string; signingRegion: string; }; ScreenshotInfoDto: { @@ -6710,12 +7976,13 @@ export interface components { ids: number[]; }; SelfHostedEePlanModel: { - enabledFeatures: ("GRANULAR_PERMISSIONS" | "PRIORITIZED_FEATURE_REQUESTS" | "PREMIUM_SUPPORT" | "DEDICATED_SLACK_CHANNEL" | "ASSISTED_UPDATES" | "DEPLOYMENT_ASSISTANCE" | "BACKUP_CONFIGURATION" | "TEAM_TRAINING" | "ACCOUNT_MANAGER" | "STANDARD_SUPPORT" | "PROJECT_LEVEL_CONTENT_STORAGES" | "WEBHOOKS" | "MULTIPLE_CONTENT_DELIVERY_CONFIGS" | "AI_PROMPT_CUSTOMIZATION" | "SLACK_INTEGRATION" | "TASKS" | "SSO" | "ORDER_TRANSLATION")[]; + enabledFeatures: ("GRANULAR_PERMISSIONS" | "PRIORITIZED_FEATURE_REQUESTS" | "PREMIUM_SUPPORT" | "DEDICATED_SLACK_CHANNEL" | "ASSISTED_UPDATES" | "DEPLOYMENT_ASSISTANCE" | "BACKUP_CONFIGURATION" | "TEAM_TRAINING" | "ACCOUNT_MANAGER" | "STANDARD_SUPPORT" | "PROJECT_LEVEL_CONTENT_STORAGES" | "WEBHOOKS" | "MULTIPLE_CONTENT_DELIVERY_CONFIGS" | "AI_PROMPT_CUSTOMIZATION" | "SLACK_INTEGRATION" | "TASKS" | "SSO" | "ORDER_TRANSLATION" | "GLOSSARY" | "TRANSLATION_LABELS")[]; free: boolean; hasYearlyPrice: boolean; /** Format: int64 */ id: number; includedUsage: components["schemas"]["PlanIncludedUsageModel"]; + isPayAsYouGo: boolean; name: string; nonCommercial: boolean; prices: components["schemas"]["PlanPricesModel"]; @@ -6749,7 +8016,7 @@ export interface components { }; SetOrganizationRoleDto: { /** @enum {string} */ - roleType: "MEMBER" | "OWNER"; + roleType: "MEMBER" | "OWNER" | "MAINTAINER"; }; SetProjectPromptCustomizationRequest: { /** @@ -6836,6 +8103,68 @@ export interface components { /** @description Where did the user find us? */ userSource?: string; }; + SimpleGlossaryModel: { + /** + * @description Language tag for default translations for terms + * @example en + */ + baseLanguageTag: string; + /** Format: int64 */ + id: number; + name: string; + }; + SimpleGlossaryTermModel: { + description: string; + /** @description Specifies whether the term represents a shortened form of a word or phrase */ + flagAbbreviation: boolean; + /** @description When true, the term matching considers uppercase and lowercase characters as distinct */ + flagCaseSensitive: boolean; + /** @description When true, marks this term as prohibited or not recommended for use in translations */ + flagForbiddenTerm: boolean; + /** @description When true, this term has the same translation across all target languages */ + flagNonTranslatable: boolean; + /** Format: int64 */ + id: number; + }; + SimpleGlossaryTermWithTranslationsModel: { + /** + * @description A detailed explanation or definition of the glossary term + * @example It's trademark + */ + description: string; + /** @description Specifies whether the term represents a shortened form of a word or phrase */ + flagAbbreviation: boolean; + /** @description When true, the term matching considers uppercase and lowercase characters as distinct */ + flagCaseSensitive: boolean; + /** @description When true, marks this term as prohibited or not recommended for use in translations */ + flagForbiddenTerm: boolean; + /** @description When true, this term has the same translation across all target languages */ + flagNonTranslatable: boolean; + /** Format: int64 */ + id: number; + translations: components["schemas"]["GlossaryTermTranslationModel"][]; + }; + SimpleGlossaryWithStatsModel: { + /** + * Format: int64 + * @description Total number of projects currently using this glossary + * @example 69 + */ + assignedProjectsCount: number; + /** + * @description The primary language code used for terms (e.g., 'en' for English) + * @example en + */ + baseLanguageTag: string; + /** + * @description The name of one project using this glossary (can be shown as a preview) + * @example My Project + */ + firstAssignedProjectName?: string; + /** Format: int64 */ + id: number; + name: string; + }; SimpleOrganizationModel: { avatar?: components["schemas"]["Avatar"]; basePermissions: components["schemas"]["PermissionModel"]; @@ -6858,6 +8187,7 @@ export interface components { name: string; slug?: string; }; + /** @description User who created the comment */ SimpleUserAccountModel: { avatar?: components["schemas"]["Avatar"]; deleted: boolean; @@ -6894,7 +8224,7 @@ export interface components { languageMappings?: components["schemas"]["LanguageMapping"][]; /** @description If true, key descriptions will be overridden by the import */ overrideKeyDescriptions: boolean; - /** @description If yes, keys from project that were not included in import will be deleted. */ + /** @description If yes, keys from project that were not included in import will be deleted (only within namespaces which are included in the import). */ removeOtherKeys?: boolean; /** * @description When importing files in structured formats (e.g., JSON, YAML), this field defines the delimiter which will be used in names of imported keys. @@ -6952,7 +8282,7 @@ export interface components { }; StorageTestResult: { /** @enum {string} */ - message?: "unauthenticated" | "api_access_forbidden" | "api_key_not_found" | "invalid_api_key" | "invalid_project_api_key" | "project_api_key_expired" | "bad_credentials" | "mfa_enabled" | "invalid_otp_code" | "mfa_not_enabled" | "can_not_revoke_own_permissions" | "data_corrupted" | "invitation_code_does_not_exist_or_expired" | "language_tag_exists" | "language_name_exists" | "language_not_found" | "operation_not_permitted" | "registrations_not_allowed" | "project_not_found" | "resource_not_found" | "scope_not_found" | "key_exists" | "third_party_auth_error_message" | "third_party_auth_no_email" | "third_party_auth_non_matching_email" | "third_party_auth_no_sub" | "third_party_auth_unknown_error" | "email_already_verified" | "third_party_unauthorized" | "third_party_google_workspace_mismatch" | "third_party_switch_initiated" | "username_already_exists" | "username_or_password_invalid" | "user_already_has_permissions" | "user_already_has_role" | "user_not_found" | "file_not_image" | "file_too_big" | "invalid_timestamp" | "email_not_verified" | "missing_callback_url" | "invalid_jwt_token" | "expired_jwt_token" | "general_jwt_error" | "cannot_find_suitable_address_part" | "slug_not_unique" | "user_is_not_member_of_organization" | "organization_has_no_other_owner" | "user_has_no_project_access" | "user_is_organization_owner" | "cannot_set_your_own_permissions" | "user_is_organization_member" | "property_not_mutable" | "import_language_not_from_project" | "existing_language_not_selected" | "conflict_is_not_resolved" | "language_already_selected" | "cannot_parse_file" | "could_not_resolve_property" | "cannot_add_more_then_100_languages" | "no_languages_provided" | "language_with_base_language_tag_not_found" | "language_not_from_project" | "namespace_not_from_project" | "cannot_delete_base_language" | "key_not_from_project" | "max_screenshots_exceeded" | "translation_not_from_project" | "can_edit_only_own_comment" | "request_parse_error" | "filter_by_value_state_not_valid" | "import_has_expired" | "tag_not_from_project" | "translation_text_too_long" | "invalid_recaptcha_token" | "cannot_leave_owning_project" | "cannot_leave_project_with_organization_role" | "dont_have_direct_permissions" | "tag_too_log" | "too_many_uploaded_images" | "one_or_more_images_not_found" | "screenshot_not_of_key" | "service_not_found" | "too_many_requests" | "translation_not_found" | "out_of_credits" | "key_not_found" | "organization_not_found" | "cannot_find_base_language" | "base_language_not_found" | "no_exported_result" | "cannot_set_your_own_role" | "only_translate_review_or_view_permission_accepts_view_languages" | "oauth2_token_url_not_set" | "oauth2_user_url_not_set" | "email_already_invited_or_member" | "price_not_found" | "invoice_not_from_organization" | "invoice_not_found" | "plan_not_found" | "plan_not_available_any_more" | "no_auto_translation_method" | "cannot_translate_base_language" | "pat_not_found" | "invalid_pat" | "pat_expired" | "operation_unavailable_for_account_type" | "validation_email_is_not_valid" | "current_password_required" | "cannot_create_organization" | "wrong_current_password" | "wrong_param_type" | "expired_super_jwt_token" | "cannot_delete_your_own_account" | "cannot_sort_by_this_column" | "namespace_not_found" | "namespace_exists" | "invalid_authentication_method" | "unknown_sort_property" | "only_review_permission_accepts_state_change_languages" | "only_translate_or_review_permission_accepts_translate_languages" | "cannot_set_language_permissions_for_admin_scope" | "cannot_set_view_languages_without_translations_view_scope" | "cannot_set_translate_languages_without_translations_edit_scope" | "cannot_set_state_change_languages_without_translations_state_edit_scope" | "language_not_permitted" | "scopes_has_to_be_set" | "set_exactly_one_of_scopes_or_type" | "translation_exists" | "import_keys_error" | "provide_only_one_of_screenshots_and_screenshot_uploaded_image_ids" | "multiple_projects_not_supported" | "plan_translation_limit_exceeded" | "feature_not_enabled" | "license_key_not_found" | "cannot_set_view_languages_without_for_level_based_permissions" | "cannot_set_different_translate_and_state_change_languages_for_level_based_permissions" | "cannot_disable_your_own_account" | "subscription_not_found" | "invoice_does_not_have_usage" | "customer_not_found" | "subscription_not_active" | "organization_already_subscribed" | "organization_not_subscribed" | "license_key_used_by_another_instance" | "translation_spending_limit_exceeded" | "credit_spending_limit_exceeded" | "seats_spending_limit_exceeded" | "this_instance_is_already_licensed" | "big_meta_not_from_project" | "mt_service_not_enabled" | "project_not_selected" | "organization_not_selected" | "plan_has_subscribers" | "translation_failed" | "batch_job_not_found" | "key_exists_in_namespace" | "tag_is_blank" | "execution_failed_on_management_error" | "translation_api_rate_limit" | "cannot_finalize_activity" | "formality_not_supported_by_service" | "language_not_supported_by_service" | "rate_limited" | "pat_access_not_allowed" | "pak_access_not_allowed" | "cannot_modify_disabled_translation" | "azure_config_required" | "s3_config_required" | "content_storage_config_required" | "content_storage_test_failed" | "content_storage_config_invalid" | "invalid_connection_string" | "cannot_create_azure_storage_client" | "s3_access_key_required" | "azure_connection_string_required" | "s3_secret_key_required" | "cannot_store_file_to_content_storage" | "unexpected_error_while_publishing_to_content_storage" | "webhook_responded_with_non_200_status" | "unexpected_error_while_executing_webhook" | "content_storage_is_in_use" | "cannot_set_state_for_missing_translation" | "no_project_id_provided" | "license_key_not_provided" | "subscription_already_canceled" | "user_is_subscribed_to_paid_plan" | "cannot_create_free_plan_without_fixed_type" | "cannot_modify_plan_free_status" | "key_id_not_provided" | "free_self_hosted_seat_limit_exceeded" | "advanced_params_not_supported" | "plural_forms_not_found_for_language" | "nested_plurals_not_supported" | "message_is_not_plural" | "content_outside_plural_forms" | "invalid_plural_form" | "multiple_plurals_not_supported" | "custom_values_json_too_long" | "unsupported_po_message_format" | "plural_forms_data_loss" | "current_user_does_not_own_image" | "user_cannot_view_this_organization" | "user_is_not_owner_of_organization" | "pak_created_for_different_project" | "custom_slug_is_only_applicable_for_custom_storage" | "invalid_slug_format" | "batch_job_cancellation_timeout" | "import_failed" | "cannot_add_more_then_1000_languages" | "no_data_to_import" | "multiple_namespaces_mapped_to_single_file" | "multiple_mappings_for_same_file_language_name" | "multiple_mappings_for_null_file_language_name" | "too_many_mappings_for_file" | "missing_placeholder_in_template" | "tag_not_found" | "cannot_parse_encrypted_slack_login_data" | "slack_workspace_not_found" | "cannot_fetch_user_details_from_slack" | "slack_missing_scope" | "slack_not_connected_to_your_account" | "slack_invalid_command" | "slack_not_subscribed_yet" | "slack_connection_failed" | "tolgee_account_already_connected" | "slack_not_configured" | "slack_workspace_already_connected" | "slack_connection_error" | "email_verification_code_not_valid" | "cannot_subscribe_to_free_plan" | "plan_auto_assignment_only_for_free_plans" | "plan_auto_assignment_only_for_private_plans" | "task_not_found" | "task_not_finished" | "task_not_open" | "translation_agency_not_found" | "this_feature_is_not_implemented_in_oss" | "sso_token_exchange_failed" | "sso_user_info_retrieval_failed" | "sso_id_token_expired" | "sso_user_cannot_create_organization" | "sso_cant_verify_user" | "sso_auth_missing_domain" | "sso_domain_not_found_or_disabled" | "native_authentication_disabled" | "invitation_organization_mismatch" | "user_is_managed_by_organization" | "cannot_set_sso_provider_missing_fields" | "namespaces_cannot_be_disabled_when_namespace_exists" | "namespace_cannot_be_used_when_feature_is_disabled" | "sso_domain_not_allowed" | "sso_login_forced_for_this_account" | "date_has_to_be_in_the_future" | "custom_plan_and_plan_id_cannot_be_set_together" | "specify_plan_id_or_custom_plan" | "custom_plans_has_to_be_private" | "cannot_create_free_plan_with_prices" | "subscription_not_scheduled_for_cancellation" | "cannot_cancel_trial" | "cannot_update_without_modification" | "current_subscription_is_not_trialing"; + message?: "unauthenticated" | "api_access_forbidden" | "api_key_not_found" | "invalid_api_key" | "invalid_project_api_key" | "project_api_key_expired" | "bad_credentials" | "mfa_enabled" | "invalid_otp_code" | "mfa_not_enabled" | "can_not_revoke_own_permissions" | "data_corrupted" | "invitation_code_does_not_exist_or_expired" | "language_tag_exists" | "language_name_exists" | "language_not_found" | "operation_not_permitted" | "registrations_not_allowed" | "project_not_found" | "resource_not_found" | "scope_not_found" | "key_exists" | "third_party_auth_error_message" | "third_party_auth_no_email" | "third_party_auth_non_matching_email" | "third_party_auth_no_sub" | "third_party_auth_unknown_error" | "email_already_verified" | "third_party_unauthorized" | "third_party_google_workspace_mismatch" | "third_party_switch_initiated" | "third_party_switch_conflict" | "username_already_exists" | "username_or_password_invalid" | "user_already_has_permissions" | "user_already_has_role" | "user_not_found" | "file_not_image" | "file_too_big" | "invalid_timestamp" | "email_not_verified" | "missing_callback_url" | "invalid_jwt_token" | "expired_jwt_token" | "general_jwt_error" | "cannot_find_suitable_address_part" | "slug_not_unique" | "user_is_not_member_of_organization" | "organization_has_no_other_owner" | "user_has_no_project_access" | "user_is_organization_owner" | "cannot_set_your_own_permissions" | "user_is_organization_member" | "property_not_mutable" | "import_language_not_from_project" | "existing_language_not_selected" | "conflict_is_not_resolved" | "language_already_selected" | "cannot_parse_file" | "could_not_resolve_property" | "cannot_add_more_then_100_languages" | "no_languages_provided" | "language_with_base_language_tag_not_found" | "language_not_from_project" | "namespace_not_from_project" | "cannot_delete_base_language" | "key_not_from_project" | "max_screenshots_exceeded" | "translation_not_from_project" | "can_edit_only_own_comment" | "request_parse_error" | "filter_by_value_state_not_valid" | "import_has_expired" | "tag_not_from_project" | "translation_text_too_long" | "invalid_recaptcha_token" | "cannot_leave_owning_project" | "cannot_leave_project_with_organization_role" | "dont_have_direct_permissions" | "tag_too_log" | "too_many_uploaded_images" | "one_or_more_images_not_found" | "screenshot_not_of_key" | "service_not_found" | "too_many_requests" | "translation_not_found" | "out_of_credits" | "key_not_found" | "organization_not_found" | "cannot_find_base_language" | "base_language_not_found" | "no_exported_result" | "cannot_set_your_own_role" | "only_translate_review_or_view_permission_accepts_view_languages" | "oauth2_token_url_not_set" | "oauth2_user_url_not_set" | "email_already_invited_or_member" | "price_not_found" | "invoice_not_from_organization" | "invoice_not_found" | "plan_not_found" | "plan_not_available_any_more" | "no_auto_translation_method" | "cannot_translate_base_language" | "pat_not_found" | "invalid_pat" | "pat_expired" | "operation_unavailable_for_account_type" | "validation_email_is_not_valid" | "current_password_required" | "cannot_create_organization" | "wrong_current_password" | "wrong_param_type" | "user_missing_password" | "expired_super_jwt_token" | "cannot_delete_your_own_account" | "cannot_sort_by_this_column" | "namespace_not_found" | "namespace_exists" | "invalid_authentication_method" | "unknown_sort_property" | "only_review_permission_accepts_state_change_languages" | "only_translate_or_review_permission_accepts_translate_languages" | "cannot_set_language_permissions_for_admin_scope" | "cannot_set_view_languages_without_translations_view_scope" | "cannot_set_translate_languages_without_translations_edit_scope" | "cannot_set_state_change_languages_without_translations_state_edit_scope" | "language_not_permitted" | "scopes_has_to_be_set" | "set_exactly_one_of_scopes_or_type" | "translation_exists" | "import_keys_error" | "provide_only_one_of_screenshots_and_screenshot_uploaded_image_ids" | "multiple_projects_not_supported" | "plan_translation_limit_exceeded" | "feature_not_enabled" | "license_key_not_found" | "cannot_set_view_languages_without_for_level_based_permissions" | "cannot_set_different_translate_and_state_change_languages_for_level_based_permissions" | "cannot_disable_your_own_account" | "subscription_not_found" | "invoice_does_not_have_usage" | "customer_not_found" | "subscription_not_active" | "organization_already_subscribed" | "organization_not_subscribed" | "license_key_used_by_another_instance" | "translation_spending_limit_exceeded" | "credit_spending_limit_exceeded" | "seats_spending_limit_exceeded" | "this_instance_is_already_licensed" | "big_meta_not_from_project" | "mt_service_not_enabled" | "project_not_selected" | "organization_not_selected" | "plan_has_subscribers" | "translation_failed" | "batch_job_not_found" | "key_exists_in_namespace" | "tag_is_blank" | "execution_failed_on_management_error" | "translation_api_rate_limit" | "cannot_finalize_activity" | "formality_not_supported_by_service" | "language_not_supported_by_service" | "rate_limited" | "pat_access_not_allowed" | "pak_access_not_allowed" | "cannot_modify_disabled_translation" | "azure_config_required" | "s3_config_required" | "content_storage_config_required" | "content_storage_test_failed" | "content_storage_config_invalid" | "invalid_connection_string" | "cannot_create_azure_storage_client" | "s3_access_key_required" | "azure_connection_string_required" | "s3_secret_key_required" | "cannot_store_file_to_content_storage" | "unexpected_error_while_publishing_to_content_storage" | "webhook_responded_with_non_200_status" | "unexpected_error_while_executing_webhook" | "content_storage_is_in_use" | "cannot_set_state_for_missing_translation" | "no_project_id_provided" | "license_key_not_provided" | "subscription_already_canceled" | "user_is_subscribed_to_paid_plan" | "cannot_create_free_plan_without_fixed_type" | "cannot_modify_plan_free_status" | "key_id_not_provided" | "free_self_hosted_seat_limit_exceeded" | "advanced_params_not_supported" | "plural_forms_not_found_for_language" | "nested_plurals_not_supported" | "message_is_not_plural" | "content_outside_plural_forms" | "invalid_plural_form" | "multiple_plurals_not_supported" | "custom_values_json_too_long" | "unsupported_po_message_format" | "plural_forms_data_loss" | "current_user_does_not_own_image" | "user_cannot_view_this_organization" | "user_is_not_owner_of_organization" | "user_is_not_owner_or_maintainer_of_organization" | "pak_created_for_different_project" | "custom_slug_is_only_applicable_for_custom_storage" | "invalid_slug_format" | "batch_job_cancellation_timeout" | "import_failed" | "cannot_add_more_then_1000_languages" | "no_data_to_import" | "multiple_namespaces_mapped_to_single_file" | "multiple_mappings_for_same_file_language_name" | "multiple_mappings_for_null_file_language_name" | "too_many_mappings_for_file" | "missing_placeholder_in_template" | "tag_not_found" | "cannot_parse_encrypted_slack_login_data" | "slack_workspace_not_found" | "cannot_fetch_user_details_from_slack" | "slack_missing_scope" | "slack_not_connected_to_your_account" | "slack_invalid_command" | "slack_not_subscribed_yet" | "slack_connection_failed" | "tolgee_account_already_connected" | "slack_not_configured" | "slack_workspace_already_connected" | "slack_connection_error" | "email_verification_code_not_valid" | "cannot_subscribe_to_free_plan" | "plan_auto_assignment_only_for_free_plans" | "plan_auto_assignment_only_for_private_plans" | "task_not_found" | "task_not_finished" | "task_not_open" | "translation_agency_not_found" | "this_feature_is_not_implemented_in_oss" | "sso_token_exchange_failed" | "sso_user_info_retrieval_failed" | "sso_id_token_expired" | "sso_user_cannot_create_organization" | "sso_cant_verify_user" | "sso_auth_missing_domain" | "sso_domain_not_found_or_disabled" | "authentication_method_disabled" | "native_authentication_disabled" | "invitation_organization_mismatch" | "user_is_managed_by_organization" | "cannot_set_sso_provider_missing_fields" | "namespaces_cannot_be_disabled_when_namespace_exists" | "namespace_cannot_be_used_when_feature_is_disabled" | "sso_domain_not_allowed" | "sso_login_forced_for_this_account" | "use_sso_for_authentication_instead" | "date_has_to_be_in_the_future" | "custom_plan_and_plan_id_cannot_be_set_together" | "specify_plan_id_or_custom_plan" | "custom_plans_has_to_be_private" | "cannot_create_free_plan_with_prices" | "subscription_not_scheduled_for_cancellation" | "cannot_cancel_trial" | "cannot_update_without_modification" | "current_subscription_is_not_trialing" | "sorting_and_paging_is_not_supported_when_using_cursor" | "strings_metric_are_not_supported" | "plan_key_limit_exceeded" | "keys_spending_limit_exceeded" | "plan_seat_limit_exceeded" | "instance_not_using_license_key" | "invalid_path" | "llm_provider_not_found" | "llm_provider_error" | "prompt_not_found" | "llm_provider_not_returned_json" | "llm_template_parsing_error" | "llm_rate_limited" | "llm_provider_timeout" | "no_llm_provider_configured" | "glossary_not_found" | "glossary_term_not_found" | "glossary_term_translation_not_found" | "glossary_non_translatable_term_cannot_be_translated" | "llm_content_filter" | "llm_provider_empty_response" | "label_not_found" | "label_not_from_project" | "label_already_exists" | "filter_by_value_label_not_valid"; params?: Record[]; success: boolean; }; @@ -6969,7 +8299,7 @@ export interface components { keyId?: number; plural?: boolean; /** @description List of services to use. If null, then all enabled services are used. */ - services?: ("GOOGLE" | "AWS" | "DEEPL" | "AZURE" | "BAIDU" | "TOLGEE")[]; + services?: ("GOOGLE" | "AWS" | "DEEPL" | "AZURE" | "BAIDU" | "PROMPT")[]; /** Format: int64 */ targetLanguageId: number; }; @@ -7028,7 +8358,6 @@ export interface components { keyIds: number[]; tags: string[]; }; - /** @description Tags of key */ TagModel: { /** Format: int64 */ id: number; @@ -7055,11 +8384,11 @@ export interface components { /** Format: int64 */ dueDate?: number; language: components["schemas"]["LanguageModel"]; - name: string; + name?: string; /** Format: int64 */ number: number; /** @enum {string} */ - state: "NEW" | "IN_PROGRESS" | "DONE" | "CLOSED"; + state: "NEW" | "IN_PROGRESS" | "FINISHED" | "CANCELED"; /** Format: int64 */ totalItems: number; /** @enum {string} */ @@ -7092,12 +8421,12 @@ export interface components { /** Format: int64 */ dueDate?: number; language: components["schemas"]["LanguageModel"]; - name: string; + name?: string; /** Format: int64 */ number: number; project: components["schemas"]["SimpleProjectModel"]; /** @enum {string} */ - state: "NEW" | "IN_PROGRESS" | "DONE" | "CLOSED"; + state: "NEW" | "IN_PROGRESS" | "FINISHED" | "CANCELED"; /** Format: int64 */ totalItems: number; /** @enum {string} */ @@ -7181,6 +8510,14 @@ export interface components { contextDescription?: string; output: string; }; + TranslationLabelRequest: { + /** Format: int64 */ + keyId: number; + /** Format: int64 */ + labelId: number; + /** Format: int64 */ + languageId: number; + }; TranslationMemoryItemModel: { baseText: string; keyName: string; @@ -7188,15 +8525,6 @@ export interface components { similarity: number; targetText: string; }; - /** - * @description Translations object containing values updated in this request - * @example { - * "en": { - * "id": 100000003, - * "text": "This is super translation!" - * } - * } - */ TranslationModel: { /** @description Was translated using Translation Memory or Machine translation service? */ auto: boolean; @@ -7209,7 +8537,7 @@ export interface components { * @description Which machine translation service was used to auto translate this * @enum {string} */ - mtProvider?: "GOOGLE" | "AWS" | "DEEPL" | "AZURE" | "BAIDU" | "TOLGEE"; + mtProvider?: "GOOGLE" | "AWS" | "DEEPL" | "AZURE" | "BAIDU" | "PROMPT"; /** @description Whether base language translation was changed after this translation was updated */ outdated: boolean; /** @@ -7248,11 +8576,13 @@ export interface components { * @description Id of translation record */ id: number; + /** @description Labels assigned to this translation */ + labels?: components["schemas"]["LabelModel"][]; /** * @description Which machine translation service was used to auto translate this * @enum {string} */ - mtProvider?: "GOOGLE" | "AWS" | "DEEPL" | "AZURE" | "BAIDU" | "TOLGEE"; + mtProvider?: "GOOGLE" | "AWS" | "DEEPL" | "AZURE" | "BAIDU" | "PROMPT"; /** @description Whether base language translation was changed after this translation was updated */ outdated: boolean; /** @@ -7276,6 +8606,44 @@ export interface components { keyIds: number[]; tags: string[]; }; + UpdateGlossaryRequest: { + /** @description Projects assigned to glossary; when null, assigned projects will be kept unchanged. */ + assignedProjectIds?: number[]; + /** + * @description Language tag according to BCP 47 definition + * @example cs-CZ + */ + baseLanguageTag: string; + /** + * @description Glossary name + * @example My glossary + */ + name: string; + }; + UpdateGlossaryTermTranslationRequest: { + /** + * @description Language tag according to BCP 47 definition + * @example cs-CZ + */ + languageTag: string; + /** + * @description Translation text + * @example Translated text to language of languageTag + */ + text: string; + }; + UpdateGlossaryTermWithTranslationRequest: { + description?: string; + /** @description Specifies whether the term represents a shortened form of a word or phrase */ + flagAbbreviation?: boolean; + /** @description When true, the term matching considers uppercase and lowercase characters as distinct */ + flagCaseSensitive?: boolean; + /** @description When true, marks this term as prohibited or not recommended for use in translations */ + flagForbiddenTerm?: boolean; + /** @description When true, this term will have the same translation across all target languages */ + flagNonTranslatable?: boolean; + text?: string; + }; UpdateNamespaceDto: { name: string; }; @@ -7307,7 +8675,7 @@ export interface components { * @example 1661172869000 */ dueDate?: number; - name: string; + name?: string; }; UploadedImageModel: { /** Format: date-time */ @@ -7323,6 +8691,7 @@ export interface components { /** @description Relevant for invoices only. When there are applied stripe credits, we need to reduce the total price by this amount. */ appliedStripeCredits?: number; credits?: components["schemas"]["SumUsageItemModel"]; + keys: components["schemas"]["AverageProportionalUsageItemModel"]; seats: components["schemas"]["AverageProportionalUsageItemModel"]; subscriptionPrice?: number; total: number; @@ -7350,7 +8719,7 @@ export interface components { name?: string; organizationBasePermission: components["schemas"]["PermissionModel"]; /** @enum {string} */ - organizationRole?: "MEMBER" | "OWNER"; + organizationRole?: "MEMBER" | "OWNER" | "MAINTAINER"; username: string; }; UserAccountModel: { @@ -7365,90 +8734,3072 @@ export interface components { name?: string; username: string; }; - UserAccountWithOrganizationRoleModel: { - avatar?: components["schemas"]["Avatar"]; - /** Format: int64 */ - id: number; - name: string; - /** @enum {string} */ - organizationRole?: "MEMBER" | "OWNER"; - projectsWithDirectPermission: components["schemas"]["SimpleProjectModel"][]; - username: string; + UserAccountWithOrganizationRoleModel: { + avatar?: components["schemas"]["Avatar"]; + /** Format: int64 */ + id: number; + name: string; + /** @enum {string} */ + organizationRole?: "MEMBER" | "OWNER" | "MAINTAINER"; + projectsWithDirectPermission: components["schemas"]["SimpleProjectModel"][]; + username: string; + }; + UserMfaRecoveryRequestDto: { + password: string; + }; + UserPreferencesModel: { + language?: string; + /** Format: int64 */ + preferredOrganizationId?: number; + }; + UserTotpDisableRequestDto: { + password: string; + }; + UserTotpEnableRequestDto: { + otp: string; + password: string; + totpKey: string; + }; + UserUpdatePasswordRequestDto: { + currentPassword: string; + password: string; + }; + UserUpdateRequestDto: { + /** @description Callback url for link sent in e-mail. This may be omitted, when server has set frontEndUrl in properties. */ + callbackUrl?: string; + currentPassword?: string; + email: string; + name: string; + }; + V2EditApiKeyDto: { + description?: string; + scopes: string[]; + }; + VariablesResponseDto: { + data: components["schemas"]["PromptVariableDto"][]; + }; + WebhookConfigModel: { + /** + * Format: int64 + * @description Date of the first failed webhook request. If the last webhook request is successful, this value is set to null. + */ + firstFailed?: number; + /** Format: int64 */ + id: number; + /** + * Format: int64 + * @description Date of the last webhook request. + */ + lastExecuted?: number; + url: string; + webhookSecret: string; + }; + WebhookConfigRequest: { + url: string; + }; + WebhookTestResponse: { + success: boolean; + }; + WorkspaceModel: { + /** Format: int64 */ + id: number; + slackTeamId: string; + slackTeamName: string; + }; + }; + responses: never; + parameters: never; + requestBodies: never; + headers: never; + pathItems: never; +} +export type $defs = Record; +export interface operations { + doExportJsonZip: { + parameters: { + query?: never; + header?: never; + path: { + projectId: number; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/zip": components["schemas"]["StreamingResponseBody"]; + }; + }; + /** @description Bad Request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + }; + }; + getAuthenticationUrl: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["DomainRequest"]; + }; + }; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["SsoUrlResponse"]; + }; + }; + /** @description Bad Request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + }; + }; + authenticateUser_1: { + parameters: { + query?: { + code?: string; + redirect_uri?: string; + invitationCode?: string; + domain?: string; + }; + header?: never; + path: { + serviceType: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["JwtAuthenticationResponse"]; + }; + }; + /** @description Bad Request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + }; + }; + getPublicConfiguration: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["PublicConfigurationDTO"]; + }; + }; + /** @description Bad Request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + }; + }; + authenticateUser: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["LoginRequest"]; + }; + }; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["JwtAuthenticationResponse"]; + }; + }; + /** @description Bad Request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + }; + }; + invitationInfo: { + parameters: { + query?: never; + header?: never; + path: { + code: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["PublicInvitationModel"]; + }; + }; + /** @description Bad Request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + }; + }; + resetPasswordRequest: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["ResetPasswordRequest"]; + }; + }; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Bad Request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + }; + }; + resetPasswordSet: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["ResetPassword"]; + }; + }; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Bad Request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + }; + }; + resetPasswordValidate: { + parameters: { + query?: never; + header?: never; + path: { + code: string; + email: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Bad Request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + }; + }; + signUp: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["SignUpDto"]; + }; + }; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["JwtAuthenticationResponse"]; + }; + }; + /** @description Bad Request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + }; + }; + validateEmail: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["TextNode"]; + }; + }; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": boolean; + }; + }; + /** @description Bad Request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + }; + }; + verifyEmail: { + parameters: { + query?: never; + header?: never; + path: { + userId: number; + code: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["JwtAuthenticationResponse"]; + }; + }; + /** @description Bad Request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + }; + }; + getOrganizations: { + parameters: { + query?: { + /** @description Zero-based page index (0..N) */ + page?: number; + /** @description The size of the page to be returned */ + size?: number; + /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ + sort?: string[]; + search?: string; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["PagedModelOrganizationModel"]; + }; + }; + /** @description Bad Request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + }; + }; + getUsers: { + parameters: { + query?: { + /** @description Zero-based page index (0..N) */ + page?: number; + /** @description The size of the page to be returned */ + size?: number; + /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ + sort?: string[]; + search?: string; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["PagedModelUserAccountModel"]; + }; + }; + /** @description Bad Request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + }; + }; + deleteUser: { + parameters: { + query?: never; + header?: never; + path: { + userId: number; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Bad Request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + }; + }; + disableUser: { + parameters: { + query?: never; + header?: never; + path: { + userId: number; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Bad Request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + }; + }; + enableUser: { + parameters: { + query?: never; + header?: never; + path: { + userId: number; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Bad Request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + }; + }; + generateUserToken: { + parameters: { + query?: never; + header?: never; + path: { + userId: number; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": string; + }; + }; + /** @description Bad Request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + }; + }; + setRole: { + parameters: { + query?: never; + header?: never; + path: { + userId: number; + role: "USER" | "ADMIN"; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Bad Request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + }; + }; + getLatest: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["AnnouncementDto"]; + }; + }; + /** @description Bad Request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + }; + }; + dismiss: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Bad Request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + }; + }; + allByUser: { + parameters: { + query: { + pageable: components["schemas"]["Pageable"]; + filterProjectId?: number; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["PagedModelApiKeyModel"]; + }; + }; + /** @description Bad Request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + }; + }; + create_15: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["CreateApiKeyDto"]; + }; + }; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["RevealedApiKeyModel"]; + }; + }; + /** @description Bad Request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + }; + }; + getScopes: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": string; + }; + }; + /** @description Bad Request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + }; + }; + getCurrent_1: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ApiKeyWithLanguagesModel"]; + }; + }; + /** @description Bad Request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + }; + }; + getCurrentPermissions: { + parameters: { + query?: { + /** @description Required when using with PAT */ + projectId?: number; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ApiKeyPermissionsModel"]; + }; + }; + /** @description Bad Request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + }; + }; + update_11: { + parameters: { + query?: never; + header?: never; + path: { + apiKeyId: number; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["V2EditApiKeyDto"]; + }; + }; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ApiKeyModel"]; + }; + }; + /** @description Bad Request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + }; + }; + delete_15: { + parameters: { + query?: never; + header?: never; + path: { + apiKeyId: number; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Bad Request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + }; + }; + regenerate_1: { + parameters: { + query?: never; + header?: never; + path: { + apiKeyId: number; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["RegenerateApiKeyDto"]; + }; + }; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["RevealedApiKeyModel"]; + }; + }; + /** @description Bad Request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + }; + }; + get_24: { + parameters: { + query?: never; + header?: never; + path: { + keyId: number; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ApiKeyModel"]; + }; + }; + /** @description Bad Request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + }; + }; + getCurrentAuthProvider: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["AuthProviderDto"]; + }; + }; + /** @description Bad Request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + }; + }; + deleteCurrentAuthProvider: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Bad Request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + }; + }; + getChangedAuthProvider: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["AuthProviderDto"]; + }; + }; + /** @description Bad Request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + }; + }; + acceptChangeAuthProvider: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["AcceptAuthProviderChangeRequest"]; + }; + }; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["JwtAuthenticationResponse"]; + }; + }; + /** @description Bad Request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + }; + }; + rejectChangeAuthProvider: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Bad Request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + }; + }; + getUsage_1: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["CurrentUsageModel"]; + }; + }; + /** @description Bad Request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + }; + }; + getInfo_5: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["EeSubscriptionModel"]; + }; + }; + /** @description Bad Request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + }; + }; + prepareSetLicenseKey: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["SetLicenseKeyDto"]; + }; + }; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["PrepareSetEeLicenceKeyModel"]; + }; + }; + /** @description Bad Request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + }; + }; + refreshSubscription: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["EeSubscriptionModel"]; + }; + }; + /** @description Bad Request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + }; + }; + release: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Bad Request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + }; + }; + setLicenseKey: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["SetLicenseKeyDto"]; + }; + }; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["EeSubscriptionModel"]; + }; + }; + /** @description Bad Request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + }; + }; + upload: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "multipart/form-data": { + /** Format: binary */ + image: string; + info?: components["schemas"]["ImageUploadInfoDto"]; + }; + }; + }; + responses: { + /** @description Created */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "*/*": components["schemas"]["UploadedImageModel"]; + }; + }; + /** @description Bad Request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + }; + }; + delete_14: { + parameters: { + query?: never; + header?: never; + path: { + ids: number[]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Bad Request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + }; + }; + acceptInvitation: { + parameters: { + query?: never; + header?: never; + path: { + code: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Bad Request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + }; + }; + deleteInvitation: { + parameters: { + query?: never; + header?: never; + path: { + invitationId: number; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Bad Request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + }; + }; + getNotifications: { + parameters: { + query?: { + /** @description Zero-based page index (0..N) */ + page?: number; + /** @description The size of the page to be returned */ + size?: number; + /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ + sort?: string[]; + /** @description Filter by the `seen` parameter. + * + * no value = request everything + * + * true = only seen + * + * false = only unseen */ + filterSeen?: boolean; + cursor?: string; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["PagedModelWithNextCursorNotificationModel"]; + }; + }; + /** @description Bad Request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + }; + }; + getNotificationsSettings: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - UserMfaRecoveryRequestDto: { - password: string; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["NotificationSettingModel"]; + }; + }; + /** @description Bad Request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; }; - UserPreferencesModel: { - language?: string; - /** Format: int64 */ - preferredOrganizationId?: number; + }; + putNotificationSetting: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - UserTotpDisableRequestDto: { - password: string; + requestBody: { + content: { + "application/json": components["schemas"]["NotificationSettingsRequest"]; + }; }; - UserTotpEnableRequestDto: { - otp: string; - password: string; - totpKey: string; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Bad Request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; }; - UserUpdatePasswordRequestDto: { - currentPassword: string; - password: string; + }; + markNotificationsAsSeen: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - UserUpdateRequestDto: { - /** @description Callback url for link sent in e-mail. This may be omitted, when server has set frontEndUrl in properties. */ - callbackUrl?: string; - currentPassword?: string; - email: string; - name: string; + requestBody: { + content: { + "application/json": components["schemas"]["NotificationsMarkSeenRequest"]; + }; }; - V2EditApiKeyDto: { - description?: string; - scopes: string[]; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Bad Request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; }; - WebhookConfigModel: { - /** - * Format: int64 - * @description Date of the first failed webhook request. If the last webhook request is successful, this value is set to null. - */ - firstFailed?: number; - /** Format: int64 */ - id: number; - /** - * Format: int64 - * @description Date of the last webhook request. - */ - lastExecuted?: number; - url: string; - webhookSecret: string; + }; + getAll_12: { + parameters: { + query?: { + /** @description Zero-based page index (0..N) */ + page?: number; + /** @description The size of the page to be returned */ + size?: number; + /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ + sort?: string[]; + filterCurrentUserOwner?: boolean; + search?: string; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["PagedModelOrganizationModel"]; + }; + }; + /** @description Bad Request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; }; - WebhookConfigRequest: { - url: string; + }; + create_12: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - WebhookTestResponse: { - success: boolean; + requestBody: { + content: { + "application/json": components["schemas"]["OrganizationDto"]; + }; }; - WorkspaceModel: { - /** Format: int64 */ - id: number; - slackTeamId: string; - slackTeamName: string; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["OrganizationModel"]; + }; + }; + /** @description Bad Request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; }; }; - responses: never; - parameters: never; - requestBodies: never; - headers: never; - pathItems: never; -} -export type $defs = Record; -export interface operations { - doExportJsonZip: { + get_23: { parameters: { query?: never; header?: never; path: { - projectId: number; + id: number; }; cookie?: never; }; @@ -7460,7 +11811,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/zip": components["schemas"]["StreamingResponseBody"]; + "application/json": components["schemas"]["OrganizationModel"]; }; }; /** @description Bad Request */ @@ -7501,16 +11852,18 @@ export interface operations { }; }; }; - getAuthenticationUrl: { + update_10: { parameters: { query?: never; header?: never; - path?: never; + path: { + id: number; + }; cookie?: never; }; requestBody: { content: { - "application/json": components["schemas"]["DomainRequest"]; + "application/json": components["schemas"]["OrganizationDto"]; }; }; responses: { @@ -7520,7 +11873,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["SsoUrlResponse"]; + "application/json": components["schemas"]["OrganizationModel"]; }; }; /** @description Bad Request */ @@ -7561,17 +11914,12 @@ export interface operations { }; }; }; - authenticateUser_1: { + delete_13: { parameters: { - query?: { - code?: string; - redirect_uri?: string; - invitationCode?: string; - domain?: string; - }; + query?: never; header?: never; path: { - serviceType: string; + id: number; }; cookie?: never; }; @@ -7579,11 +11927,74 @@ export interface operations { responses: { /** @description OK */ 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Bad Request */ + 400: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["JwtAuthenticationResponse"]; + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + }; + }; + uploadAvatar_2: { + parameters: { + query?: never; + header?: never; + path: { + id: number; + }; + cookie?: never; + }; + requestBody?: { + content: { + "multipart/form-data": { + /** Format: binary */ + avatar: string; + }; + }; + }; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["OrganizationModel"]; }; }; /** @description Bad Request */ @@ -7624,11 +12035,13 @@ export interface operations { }; }; }; - getPublicConfiguration: { + removeAvatar_2: { parameters: { query?: never; header?: never; - path?: never; + path: { + id: number; + }; cookie?: never; }; requestBody?: never; @@ -7639,7 +12052,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["PublicConfigurationDTO"]; + "application/json": components["schemas"]["OrganizationModel"]; }; }; /** @description Bad Request */ @@ -7680,16 +12093,18 @@ export interface operations { }; }; }; - authenticateUser: { + inviteUser_1: { parameters: { query?: never; header?: never; - path?: never; + path: { + id: number; + }; cookie?: never; }; requestBody: { content: { - "application/json": components["schemas"]["LoginRequest"]; + "application/json": components["schemas"]["OrganizationInviteUserDto"]; }; }; responses: { @@ -7699,7 +12114,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["JwtAuthenticationResponse"]; + "application/json": components["schemas"]["OrganizationInvitationModel"]; }; }; /** @description Bad Request */ @@ -7740,12 +12155,12 @@ export interface operations { }; }; }; - invitationInfo: { + leaveOrganization: { parameters: { query?: never; header?: never; path: { - code: string; + id: number; }; cookie?: never; }; @@ -7756,9 +12171,7 @@ export interface operations { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["PublicInvitationModel"]; - }; + content?: never; }; /** @description Bad Request */ 400: { @@ -7798,25 +12211,33 @@ export interface operations { }; }; }; - resetPasswordRequest: { + getAllProjects_1: { parameters: { - query?: never; + query?: { + /** @description Zero-based page index (0..N) */ + page?: number; + /** @description The size of the page to be returned */ + size?: number; + /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ + sort?: string[]; + search?: string; + }; header?: never; - path?: never; - cookie?: never; - }; - requestBody: { - content: { - "application/json": components["schemas"]["ResetPasswordRequest"]; + path: { + id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["PagedModelProjectModel"]; + }; }; /** @description Bad Request */ 400: { @@ -7856,25 +12277,33 @@ export interface operations { }; }; }; - resetPasswordSet: { + getAllUsers_1: { parameters: { - query?: never; + query?: { + /** @description Zero-based page index (0..N) */ + page?: number; + /** @description The size of the page to be returned */ + size?: number; + /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ + sort?: string[]; + search?: string; + }; header?: never; - path?: never; - cookie?: never; - }; - requestBody: { - content: { - "application/json": components["schemas"]["ResetPassword"]; + path: { + id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["PagedModelUserAccountWithOrganizationRoleModel"]; + }; }; /** @description Bad Request */ 400: { @@ -7914,13 +12343,21 @@ export interface operations { }; }; }; - resetPasswordValidate: { + getAllBaseLanguagesInUse: { parameters: { - query?: never; + query?: { + /** @description Zero-based page index (0..N) */ + page?: number; + /** @description The size of the page to be returned */ + size?: number; + /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ + sort?: string[]; + search?: string; + projectIds?: number[]; + }; header?: never; path: { - code: string; - email: string; + organizationId: number; }; cookie?: never; }; @@ -7931,7 +12368,9 @@ export interface operations { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["PagedModelOrganizationLanguageModel"]; + }; }; /** @description Bad Request */ 400: { @@ -7971,18 +12410,24 @@ export interface operations { }; }; }; - signUp: { + getAll_14: { parameters: { - query?: never; + query?: { + /** @description Zero-based page index (0..N) */ + page?: number; + /** @description The size of the page to be returned */ + size?: number; + /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ + sort?: string[]; + search?: string; + }; header?: never; - path?: never; - cookie?: never; - }; - requestBody: { - content: { - "application/json": components["schemas"]["SignUpDto"]; + path: { + organizationId: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description OK */ 200: { @@ -7990,7 +12435,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["JwtAuthenticationResponse"]; + "application/json": components["schemas"]["PagedModelSimpleGlossaryModel"]; }; }; /** @description Bad Request */ @@ -8031,16 +12476,18 @@ export interface operations { }; }; }; - validateEmail: { + create_13: { parameters: { query?: never; header?: never; - path?: never; + path: { + organizationId: number; + }; cookie?: never; }; requestBody: { content: { - "application/json": components["schemas"]["TextNode"]; + "application/json": components["schemas"]["CreateGlossaryRequest"]; }; }; responses: { @@ -8050,7 +12497,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": boolean; + "application/json": components["schemas"]["GlossaryModel"]; }; }; /** @description Bad Request */ @@ -8091,13 +12538,20 @@ export interface operations { }; }; }; - verifyEmail: { + getAllWithStats: { parameters: { - query?: never; + query?: { + /** @description Zero-based page index (0..N) */ + page?: number; + /** @description The size of the page to be returned */ + size?: number; + /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ + sort?: string[]; + search?: string; + }; header?: never; path: { - userId: number; - code: string; + organizationId: number; }; cookie?: never; }; @@ -8109,7 +12563,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["JwtAuthenticationResponse"]; + "application/json": components["schemas"]["PagedModelSimpleGlossaryWithStatsModel"]; }; }; /** @description Bad Request */ @@ -8150,19 +12604,14 @@ export interface operations { }; }; }; - getOrganizations: { + get_20: { parameters: { - query?: { - /** @description Zero-based page index (0..N) */ - page?: number; - /** @description The size of the page to be returned */ - size?: number; - /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ - sort?: string[]; - search?: string; - }; + query?: never; header?: never; - path?: never; + path: { + organizationId: number; + glossaryId: number; + }; cookie?: never; }; requestBody?: never; @@ -8173,7 +12622,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["PagedModelOrganizationModel"]; + "application/json": components["schemas"]["GlossaryModel"]; }; }; /** @description Bad Request */ @@ -8214,22 +12663,21 @@ export interface operations { }; }; }; - getUsers: { + update_8: { parameters: { - query?: { - /** @description Zero-based page index (0..N) */ - page?: number; - /** @description The size of the page to be returned */ - size?: number; - /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ - sort?: string[]; - search?: string; - }; + query?: never; header?: never; - path?: never; + path: { + organizationId: number; + glossaryId: number; + }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["UpdateGlossaryRequest"]; + }; + }; responses: { /** @description OK */ 200: { @@ -8237,7 +12685,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["PagedModelUserAccountModel"]; + "application/json": components["schemas"]["GlossaryModel"]; }; }; /** @description Bad Request */ @@ -8278,12 +12726,13 @@ export interface operations { }; }; }; - deleteUser: { + delete_11: { parameters: { query?: never; header?: never; path: { - userId: number; + organizationId: number; + glossaryId: number; }; cookie?: never; }; @@ -8334,12 +12783,13 @@ export interface operations { }; }; }; - disableUser: { + getAssignedProjects: { parameters: { query?: never; header?: never; path: { - userId: number; + organizationId: number; + glossaryId: number; }; cookie?: never; }; @@ -8350,7 +12800,9 @@ export interface operations { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["CollectionModelSimpleProjectModel"]; + }; }; /** @description Bad Request */ 400: { @@ -8390,12 +12842,13 @@ export interface operations { }; }; }; - enableUser: { + getLanguages: { parameters: { query?: never; header?: never; path: { - userId: number; + organizationId: number; + glossaryId: number; }; cookie?: never; }; @@ -8406,7 +12859,9 @@ export interface operations { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["CollectionModelGlossaryLanguageDto"]; + }; }; /** @description Bad Request */ 400: { @@ -8446,12 +12901,22 @@ export interface operations { }; }; }; - generateUserToken: { + getAll_15: { parameters: { - query?: never; + query?: { + /** @description Zero-based page index (0..N) */ + page?: number; + /** @description The size of the page to be returned */ + size?: number; + /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ + sort?: string[]; + search?: string; + languageTags?: string[]; + }; header?: never; path: { - userId: number; + organizationId: number; + glossaryId: number; }; cookie?: never; }; @@ -8463,7 +12928,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": string; + "application/json": components["schemas"]["PagedModelSimpleGlossaryTermModel"]; }; }; /** @description Bad Request */ @@ -8504,24 +12969,30 @@ export interface operations { }; }; }; - setRole: { + create_14: { parameters: { query?: never; header?: never; path: { - userId: number; - role: "USER" | "ADMIN"; + organizationId: number; + glossaryId: number; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["CreateGlossaryTermWithTranslationRequest"]; + }; + }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["CreateUpdateGlossaryTermResponse"]; + }; }; /** @description Bad Request */ 400: { @@ -8561,23 +13032,28 @@ export interface operations { }; }; }; - getLatest: { + deleteMultiple: { parameters: { query?: never; header?: never; - path?: never; + path: { + organizationId: number; + glossaryId: number; + }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["DeleteMultipleGlossaryTermsRequest"]; + }; + }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["AnnouncementDto"]; - }; + content?: never; }; /** @description Bad Request */ 400: { @@ -8617,11 +13093,15 @@ export interface operations { }; }; }; - dismiss: { + get_21: { parameters: { query?: never; header?: never; - path?: never; + path: { + organizationId: number; + glossaryId: number; + termId: number; + }; cookie?: never; }; requestBody?: never; @@ -8631,7 +13111,9 @@ export interface operations { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["GlossaryTermModel"]; + }; }; /** @description Bad Request */ 400: { @@ -8671,17 +13153,22 @@ export interface operations { }; }; }; - allByUser: { + update_9: { parameters: { - query: { - pageable: components["schemas"]["Pageable"]; - filterProjectId?: number; - }; + query?: never; header?: never; - path?: never; + path: { + organizationId: number; + glossaryId: number; + termId: number; + }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["UpdateGlossaryTermWithTranslationRequest"]; + }; + }; responses: { /** @description OK */ 200: { @@ -8689,7 +13176,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["PagedModelApiKeyModel"]; + "application/json": components["schemas"]["CreateUpdateGlossaryTermResponse"]; }; }; /** @description Bad Request */ @@ -8730,27 +13217,25 @@ export interface operations { }; }; }; - create_13: { + delete_12: { parameters: { query?: never; header?: never; - path?: never; - cookie?: never; - }; - requestBody: { - content: { - "application/json": components["schemas"]["CreateApiKeyDto"]; + path: { + organizationId: number; + glossaryId: number; + termId: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["RevealedApiKeyModel"]; - }; + content?: never; }; /** @description Bad Request */ 400: { @@ -8790,14 +13275,22 @@ export interface operations { }; }; }; - getScopes: { + update_12: { parameters: { query?: never; header?: never; - path?: never; + path: { + organizationId: number; + glossaryId: number; + termId: number; + }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["UpdateGlossaryTermTranslationRequest"]; + }; + }; responses: { /** @description OK */ 200: { @@ -8805,7 +13298,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": string; + "application/json": components["schemas"]["GlossaryTermTranslationModel"]; }; }; /** @description Bad Request */ @@ -8846,11 +13339,16 @@ export interface operations { }; }; }; - getCurrent_1: { + get_22: { parameters: { query?: never; header?: never; - path?: never; + path: { + organizationId: number; + glossaryId: number; + termId: number; + languageTag: string; + }; cookie?: never; }; requestBody?: never; @@ -8861,7 +13359,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["ApiKeyWithLanguagesModel"]; + "application/json": components["schemas"]["GlossaryTermTranslationModel"]; }; }; /** @description Bad Request */ @@ -8902,20 +13400,20 @@ export interface operations { }; }; }; - update_9: { + getAllIds: { parameters: { - query?: never; + query?: { + search?: string; + languageTags?: string[]; + }; header?: never; path: { - apiKeyId: number; + organizationId: number; + glossaryId: number; }; cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["V2EditApiKeyDto"]; - }; - }; + requestBody?: never; responses: { /** @description OK */ 200: { @@ -8923,7 +13421,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["ApiKeyModel"]; + "application/json": components["schemas"]["CollectionModelLong"]; }; }; /** @description Bad Request */ @@ -8964,12 +13462,22 @@ export interface operations { }; }; }; - delete_13: { + getAllWithTranslations: { parameters: { - query?: never; + query?: { + /** @description Zero-based page index (0..N) */ + page?: number; + /** @description The size of the page to be returned */ + size?: number; + /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ + sort?: string[]; + search?: string; + languageTags?: string[]; + }; header?: never; path: { - apiKeyId: number; + organizationId: number; + glossaryId: number; }; cookie?: never; }; @@ -8980,7 +13488,9 @@ export interface operations { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["PagedModelSimpleGlossaryTermWithTranslationsModel"]; + }; }; /** @description Bad Request */ 400: { @@ -9020,20 +13530,16 @@ export interface operations { }; }; }; - regenerate_1: { + getInvitations: { parameters: { query?: never; header?: never; path: { - apiKeyId: number; - }; - cookie?: never; - }; - requestBody: { - content: { - "application/json": components["schemas"]["RegenerateApiKeyDto"]; + organizationId: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description OK */ 200: { @@ -9041,7 +13547,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["RevealedApiKeyModel"]; + "application/json": components["schemas"]["CollectionModelOrganizationInvitationModel"]; }; }; /** @description Bad Request */ @@ -9082,12 +13588,21 @@ export interface operations { }; }; }; - get_21: { + getAllLanguagesInUse: { parameters: { - query?: never; + query?: { + /** @description Zero-based page index (0..N) */ + page?: number; + /** @description The size of the page to be returned */ + size?: number; + /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ + sort?: string[]; + search?: string; + projectIds?: number[]; + }; header?: never; path: { - keyId: number; + organizationId: number; }; cookie?: never; }; @@ -9099,7 +13614,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["ApiKeyModel"]; + "application/json": components["schemas"]["PagedModelOrganizationLanguageModel"]; }; }; /** @description Bad Request */ @@ -9140,11 +13655,13 @@ export interface operations { }; }; }; - getChangedAuthProvider: { + getAll_13: { parameters: { query?: never; header?: never; - path?: never; + path: { + organizationId: number; + }; cookie?: never; }; requestBody?: never; @@ -9155,7 +13672,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["AuthProviderDto"]; + "application/json": components["schemas"]["CollectionModelLlmProviderModel"]; }; }; /** @description Bad Request */ @@ -9196,14 +13713,20 @@ export interface operations { }; }; }; - acceptChangeAuthProvider: { + createProvider: { parameters: { query?: never; header?: never; - path?: never; + path: { + organizationId: number; + }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["LlmProviderRequest"]; + }; + }; responses: { /** @description OK */ 200: { @@ -9211,7 +13734,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["JwtAuthenticationResponse"]; + "application/json": components["schemas"]["LlmProviderModel"]; }; }; /** @description Bad Request */ @@ -9252,11 +13775,13 @@ export interface operations { }; }; }; - rejectChangeAuthProvider: { + getAvailableProviders: { parameters: { query?: never; header?: never; - path?: never; + path: { + organizationId: number; + }; cookie?: never; }; requestBody?: never; @@ -9266,7 +13791,9 @@ export interface operations { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["CollectionModelLlmProviderSimpleModel"]; + }; }; /** @description Bad Request */ 400: { @@ -9306,11 +13833,13 @@ export interface operations { }; }; }; - getCurrentAuthProvider: { + getServerProviders: { parameters: { query?: never; header?: never; - path?: never; + path: { + organizationId: number; + }; cookie?: never; }; requestBody?: never; @@ -9321,7 +13850,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["AuthProviderDto"]; + "application/json": components["schemas"]["CollectionModelLlmProviderSimpleModel"]; }; }; /** @description Bad Request */ @@ -9362,14 +13891,21 @@ export interface operations { }; }; }; - getInfo_5: { + updateProvider: { parameters: { query?: never; header?: never; - path?: never; + path: { + organizationId: number; + providerId: number; + }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["LlmProviderRequest"]; + }; + }; responses: { /** @description OK */ 200: { @@ -9377,7 +13913,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["EeSubscriptionModel"]; + "application/json": components["schemas"]["LlmProviderModel"]; }; }; /** @description Bad Request */ @@ -9418,27 +13954,24 @@ export interface operations { }; }; }; - prepareSetLicenseKey: { + deleteProvider: { parameters: { query?: never; header?: never; - path?: never; - cookie?: never; - }; - requestBody: { - content: { - "application/json": components["schemas"]["SetLicenseKeyDto"]; + path: { + organizationId: number; + providerId: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["PrepareSetEeLicenceKeyModel"]; - }; + content?: never; }; /** @description Bad Request */ 400: { @@ -9478,11 +14011,13 @@ export interface operations { }; }; }; - refreshSubscription: { + getOrganizationCredits: { parameters: { query?: never; header?: never; - path?: never; + path: { + organizationId: number; + }; cookie?: never; }; requestBody?: never; @@ -9493,7 +14028,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["EeSubscriptionModel"]; + "application/json": components["schemas"]["CreditBalanceModel"]; }; }; /** @description Bad Request */ @@ -9534,11 +14069,21 @@ export interface operations { }; }; }; - release: { + getAllWithStatistics_2: { parameters: { - query?: never; + query?: { + /** @description Zero-based page index (0..N) */ + page?: number; + /** @description The size of the page to be returned */ + size?: number; + /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ + sort?: string[]; + search?: string; + }; header?: never; - path?: never; + path: { + organizationId: number; + }; cookie?: never; }; requestBody?: never; @@ -9548,7 +14093,9 @@ export interface operations { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["PagedModelProjectWithStatsModel"]; + }; }; /** @description Bad Request */ 400: { @@ -9588,27 +14135,32 @@ export interface operations { }; }; }; - setLicenseKey: { + setBasePermissions: { parameters: { - query?: never; + query: { + /** + * @description Granted scopes to all projects for all organization users without direct project permissions set. + * @example [ + * "translations.view", + * "translations.edit" + * ] + */ + scopes: string[]; + }; header?: never; - path?: never; - cookie?: never; - }; - requestBody: { - content: { - "application/json": components["schemas"]["SetLicenseKeyDto"]; + path: { + organizationId: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["EeSubscriptionModel"]; - }; + content?: never; }; /** @description Bad Request */ 400: { @@ -9648,31 +14200,24 @@ export interface operations { }; }; }; - upload: { + setBasePermissions_1: { parameters: { query?: never; header?: never; - path?: never; - cookie?: never; - }; - requestBody?: { - content: { - "multipart/form-data": { - /** Format: binary */ - image: string; - info?: components["schemas"]["ImageUploadInfoDto"]; - }; + path: { + organizationId: number; + permissionType: "NONE" | "VIEW" | "TRANSLATE" | "REVIEW" | "EDIT" | "MANAGE"; }; + cookie?: never; }; + requestBody?: never; responses: { - /** @description Created */ - 201: { + /** @description OK */ + 200: { headers: { [name: string]: unknown; }; - content: { - "*/*": components["schemas"]["UploadedImageModel"]; - }; + content?: never; }; /** @description Bad Request */ 400: { @@ -9712,16 +14257,20 @@ export interface operations { }; }; }; - delete_12: { + connectWorkspace: { parameters: { query?: never; header?: never; path: { - ids: number[]; + organizationId: number; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["ConnectToSlackDto"]; + }; + }; responses: { /** @description OK */ 200: { @@ -9768,12 +14317,12 @@ export interface operations { }; }; }; - acceptInvitation: { + connectToSlack: { parameters: { query?: never; header?: never; path: { - code: string; + organizationId: number; }; cookie?: never; }; @@ -9784,7 +14333,9 @@ export interface operations { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["ConnectToSlackUrlModel"]; + }; }; /** @description Bad Request */ 400: { @@ -9824,12 +14375,12 @@ export interface operations { }; }; }; - deleteInvitation: { + getConnectedWorkspaces: { parameters: { query?: never; header?: never; path: { - invitationId: number; + organizationId: number; }; cookie?: never; }; @@ -9840,7 +14391,9 @@ export interface operations { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["CollectionModelWorkspaceModel"]; + }; }; /** @description Bad Request */ 400: { @@ -9880,20 +14433,14 @@ export interface operations { }; }; }; - getAll_10: { + disconnectWorkspace: { parameters: { - query?: { - /** @description Zero-based page index (0..N) */ - page?: number; - /** @description The size of the page to be returned */ - size?: number; - /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ - sort?: string[]; - filterCurrentUserOwner?: boolean; - search?: string; - }; + query?: never; header?: never; - path?: never; + path: { + workspaceId: number; + organizationId: number; + }; cookie?: never; }; requestBody?: never; @@ -9903,9 +14450,7 @@ export interface operations { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["PagedModelOrganizationModel"]; - }; + content?: never; }; /** @description Bad Request */ 400: { @@ -9945,18 +14490,16 @@ export interface operations { }; }; }; - create_12: { + findProvider: { parameters: { query?: never; header?: never; - path?: never; - cookie?: never; - }; - requestBody: { - content: { - "application/json": components["schemas"]["OrganizationDto"]; + path: { + organizationId: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description OK */ 200: { @@ -9964,7 +14507,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["OrganizationModel"]; + "application/json": components["schemas"]["SsoTenantModel"]; }; }; /** @description Bad Request */ @@ -10005,16 +14548,20 @@ export interface operations { }; }; }; - get_20: { + setProvider: { parameters: { query?: never; header?: never; path: { - id: number; + organizationId: number; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["CreateProviderRequest"]; + }; + }; responses: { /** @description OK */ 200: { @@ -10022,7 +14569,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["OrganizationModel"]; + "application/json": components["schemas"]["SsoTenantModel"]; }; }; /** @description Bad Request */ @@ -10063,20 +14610,16 @@ export interface operations { }; }; }; - update_8: { + getUsage: { parameters: { query?: never; header?: never; path: { - id: number; + organizationId: number; }; cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["OrganizationDto"]; - }; - }; + requestBody?: never; responses: { /** @description OK */ 200: { @@ -10084,7 +14627,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["OrganizationModel"]; + "application/json": components["schemas"]["PublicUsageModel"]; }; }; /** @description Bad Request */ @@ -10125,12 +14668,13 @@ export interface operations { }; }; }; - delete_11: { + removeUser: { parameters: { query?: never; header?: never; path: { - id: number; + organizationId: number; + userId: number; }; cookie?: never; }; @@ -10181,21 +14725,19 @@ export interface operations { }; }; }; - uploadAvatar_2: { + setUserRole: { parameters: { query?: never; header?: never; path: { - id: number; + organizationId: number; + userId: number; }; cookie?: never; }; - requestBody?: { + requestBody: { content: { - "multipart/form-data": { - /** Format: binary */ - avatar: string; - }; + "application/json": components["schemas"]["SetOrganizationRoleDto"]; }; }; responses: { @@ -10204,9 +14746,7 @@ export interface operations { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["OrganizationModel"]; - }; + content?: never; }; /** @description Bad Request */ 400: { @@ -10246,12 +14786,12 @@ export interface operations { }; }; }; - removeAvatar_2: { + get_19: { parameters: { query?: never; header?: never; path: { - id: number; + slug: string; }; cookie?: never; }; @@ -10304,20 +14844,24 @@ export interface operations { }; }; }; - inviteUser_1: { + getAllProjects: { parameters: { - query?: never; + query?: { + /** @description Zero-based page index (0..N) */ + page?: number; + /** @description The size of the page to be returned */ + size?: number; + /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ + sort?: string[]; + search?: string; + }; header?: never; path: { - id: number; + slug: string; }; cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["OrganizationInviteUserDto"]; - }; - }; + requestBody?: never; responses: { /** @description OK */ 200: { @@ -10325,7 +14869,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["OrganizationInvitationModel"]; + "application/json": components["schemas"]["PagedModelProjectModel"]; }; }; /** @description Bad Request */ @@ -10366,12 +14910,20 @@ export interface operations { }; }; }; - leaveOrganization: { + getAllWithStatistics_1: { parameters: { - query?: never; + query?: { + /** @description Zero-based page index (0..N) */ + page?: number; + /** @description The size of the page to be returned */ + size?: number; + /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ + sort?: string[]; + search?: string; + }; header?: never; path: { - id: number; + slug: string; }; cookie?: never; }; @@ -10382,7 +14934,9 @@ export interface operations { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["PagedModelProjectWithStatsModel"]; + }; }; /** @description Bad Request */ 400: { @@ -10422,7 +14976,7 @@ export interface operations { }; }; }; - getAllProjects_1: { + getAll_11: { parameters: { query?: { /** @description Zero-based page index (0..N) */ @@ -10431,12 +14985,9 @@ export interface operations { size?: number; /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ sort?: string[]; - search?: string; }; header?: never; - path: { - id: number; - }; + path?: never; cookie?: never; }; requestBody?: never; @@ -10447,7 +14998,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["PagedModelProjectModel"]; + "application/json": components["schemas"]["PagedModelPatModel"]; }; }; /** @description Bad Request */ @@ -10488,32 +15039,26 @@ export interface operations { }; }; }; - getAllUsers_1: { + create_11: { parameters: { - query?: { - /** @description Zero-based page index (0..N) */ - page?: number; - /** @description The size of the page to be returned */ - size?: number; - /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ - sort?: string[]; - search?: string; - }; + query?: never; header?: never; - path: { - id: number; - }; + path?: never; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["CreatePatDto"]; + }; + }; responses: { - /** @description OK */ - 200: { + /** @description Created */ + 201: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["PagedModelUserAccountWithOrganizationRoleModel"]; + "*/*": components["schemas"]["RevealedPatModel"]; }; }; /** @description Bad Request */ @@ -10554,13 +15099,11 @@ export interface operations { }; }; }; - getInvitations: { + getCurrent: { parameters: { query?: never; header?: never; - path: { - organizationId: number; - }; + path?: never; cookie?: never; }; requestBody?: never; @@ -10571,7 +15114,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["CollectionModelOrganizationInvitationModel"]; + "application/json": components["schemas"]["PatWithUserModel"]; }; }; /** @description Bad Request */ @@ -10612,12 +15155,12 @@ export interface operations { }; }; }; - getOrganizationCredits: { + get_18: { parameters: { query?: never; header?: never; path: { - organizationId: number; + id: number; }; cookie?: never; }; @@ -10629,7 +15172,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["CreditBalanceModel"]; + "application/json": components["schemas"]["PatModel"]; }; }; /** @description Bad Request */ @@ -10670,24 +15213,20 @@ export interface operations { }; }; }; - getAllWithStatistics_2: { + update_7: { parameters: { - query?: { - /** @description Zero-based page index (0..N) */ - page?: number; - /** @description The size of the page to be returned */ - size?: number; - /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ - sort?: string[]; - search?: string; - }; + query?: never; header?: never; path: { - organizationId: number; + id: number; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["UpdatePatDto"]; + }; + }; responses: { /** @description OK */ 200: { @@ -10695,7 +15234,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["PagedModelProjectWithStatsModel"]; + "application/json": components["schemas"]["PatModel"]; }; }; /** @description Bad Request */ @@ -10736,21 +15275,12 @@ export interface operations { }; }; }; - setBasePermissions: { + delete_10: { parameters: { - query: { - /** - * @description Granted scopes to all projects for all organization users without direct project permissions set. - * @example [ - * "translations.view", - * "translations.edit" - * ] - */ - scopes: string[]; - }; + query?: never; header?: never; path: { - organizationId: number; + id: number; }; cookie?: never; }; @@ -10801,24 +15331,29 @@ export interface operations { }; }; }; - setBasePermissions_1: { + regenerate: { parameters: { query?: never; header?: never; path: { - organizationId: number; - permissionType: "NONE" | "VIEW" | "TRANSLATE" | "REVIEW" | "EDIT" | "MANAGE"; + id: number; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["RegeneratePatDto"]; + }; + }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["RevealedPatModel"]; + }; }; /** @description Bad Request */ 400: { @@ -10858,27 +15393,23 @@ export interface operations { }; }; }; - connectWorkspace: { + getPreferred: { parameters: { query?: never; header?: never; - path: { - organizationId: number; - }; + path?: never; cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["ConnectToSlackDto"]; - }; - }; + requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["PrivateOrganizationModel"]; + }; }; /** @description Bad Request */ 400: { @@ -10918,13 +15449,23 @@ export interface operations { }; }; }; - connectToSlack: { + getAll: { parameters: { - query?: never; - header?: never; - path: { - organizationId: number; + query?: { + /** @description Filter projects by id */ + filterId?: number[]; + /** @description Filter projects without id */ + filterNotId?: number[]; + /** @description Zero-based page index (0..N) */ + page?: number; + /** @description The size of the page to be returned */ + size?: number; + /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ + sort?: string[]; + search?: string; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; @@ -10935,7 +15476,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["ConnectToSlackUrlModel"]; + "application/json": components["schemas"]["PagedModelProjectModel"]; }; }; /** @description Bad Request */ @@ -10976,16 +15517,18 @@ export interface operations { }; }; }; - getConnectedWorkspaces: { + createProject: { parameters: { query?: never; header?: never; - path: { - organizationId: number; - }; + path?: never; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["CreateProjectRequest"]; + }; + }; responses: { /** @description OK */ 200: { @@ -10993,7 +15536,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["CollectionModelWorkspaceModel"]; + "application/json": components["schemas"]["ProjectModel"]; }; }; /** @description Bad Request */ @@ -11034,14 +15577,19 @@ export interface operations { }; }; }; - disconnectWorkspace: { + getAllWithStatistics: { parameters: { - query?: never; - header?: never; - path: { - workspaceId: number; - organizationId: number; + query?: { + /** @description Zero-based page index (0..N) */ + page?: number; + /** @description The size of the page to be returned */ + size?: number; + /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ + sort?: string[]; + search?: string; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; @@ -11051,7 +15599,9 @@ export interface operations { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["PagedModelProjectWithStatsModel"]; + }; }; /** @description Bad Request */ 400: { @@ -11091,12 +15641,12 @@ export interface operations { }; }; }; - findProvider: { + get_8: { parameters: { query?: never; header?: never; path: { - organizationId: number; + projectId: number; }; cookie?: never; }; @@ -11108,7 +15658,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["SsoTenantModel"]; + "application/json": components["schemas"]["ProjectModel"]; }; }; /** @description Bad Request */ @@ -11149,18 +15699,18 @@ export interface operations { }; }; }; - setProvider: { + editProject: { parameters: { query?: never; header?: never; path: { - organizationId: number; + projectId: number; }; cookie?: never; }; requestBody: { content: { - "application/json": components["schemas"]["CreateProviderRequest"]; + "application/json": components["schemas"]["EditProjectRequest"]; }; }; responses: { @@ -11170,7 +15720,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["SsoTenantModel"]; + "application/json": components["schemas"]["ProjectModel"]; }; }; /** @description Bad Request */ @@ -11211,12 +15761,12 @@ export interface operations { }; }; }; - getUsage: { + deleteProject: { parameters: { query?: never; header?: never; path: { - organizationId: number; + projectId: number; }; cookie?: never; }; @@ -11227,9 +15777,7 @@ export interface operations { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["PublicUsageModel"]; - }; + content?: never; }; /** @description Bad Request */ 400: { @@ -11267,15 +15815,21 @@ export interface operations { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; - }; - }; - removeUser: { - parameters: { - query?: never; + }; + }; + getActivity: { + parameters: { + query?: { + /** @description Zero-based page index (0..N) */ + page?: number; + /** @description The size of the page to be returned */ + size?: number; + /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ + sort?: string[]; + }; header?: never; path: { - organizationId: number; - userId: number; + projectId: number; }; cookie?: never; }; @@ -11286,7 +15840,9 @@ export interface operations { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["PagedModelProjectActivityModel"]; + }; }; /** @description Bad Request */ 400: { @@ -11326,28 +15882,26 @@ export interface operations { }; }; }; - setUserRole: { + getSingleRevision: { parameters: { query?: never; header?: never; path: { - organizationId: number; - userId: number; + revisionId: number; + projectId: number; }; cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["SetOrganizationRoleDto"]; - }; - }; + requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["ProjectActivityModel"]; + }; }; /** @description Bad Request */ 400: { @@ -11387,12 +15941,22 @@ export interface operations { }; }; }; - get_19: { + getModifiedEntitiesByRevision: { parameters: { - query?: never; + query?: { + /** @description Zero-based page index (0..N) */ + page?: number; + /** @description The size of the page to be returned */ + size?: number; + /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ + sort?: string[]; + /** @description Filters results by specific entity class */ + filterEntityClass?: string[]; + }; header?: never; path: { - slug: string; + revisionId: number; + projectId: number; }; cookie?: never; }; @@ -11404,7 +15968,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["OrganizationModel"]; + "application/json": components["schemas"]["PagedModelModifiedEntityModel"]; }; }; /** @description Bad Request */ @@ -11445,24 +16009,20 @@ export interface operations { }; }; }; - getAllProjects: { + getAiPlaygroundResult: { parameters: { - query?: { - /** @description Zero-based page index (0..N) */ - page?: number; - /** @description The size of the page to be returned */ - size?: number; - /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ - sort?: string[]; - search?: string; - }; + query?: never; header?: never; path: { - slug: string; + projectId: number; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["AiPlaygroundResultRequest"]; + }; + }; responses: { /** @description OK */ 200: { @@ -11470,7 +16030,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["PagedModelProjectModel"]; + "application/json": components["schemas"]["CollectionModelAiPlaygroundResultModel"]; }; }; /** @description Bad Request */ @@ -11511,20 +16071,12 @@ export interface operations { }; }; }; - getAllWithStatistics_1: { + getPromptProjectCustomization: { parameters: { - query?: { - /** @description Zero-based page index (0..N) */ - page?: number; - /** @description The size of the page to be returned */ - size?: number; - /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ - sort?: string[]; - search?: string; - }; + query?: never; header?: never; path: { - slug: string; + projectId: number; }; cookie?: never; }; @@ -11536,7 +16088,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["PagedModelProjectWithStatsModel"]; + "application/json": components["schemas"]["ProjectAiPromptCustomizationModel"]; }; }; /** @description Bad Request */ @@ -11577,21 +16129,20 @@ export interface operations { }; }; }; - getAll_9: { + setPromptProjectCustomization: { parameters: { - query?: { - /** @description Zero-based page index (0..N) */ - page?: number; - /** @description The size of the page to be returned */ - size?: number; - /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ - sort?: string[]; - }; + query?: never; header?: never; - path?: never; + path: { + projectId: number; + }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["SetProjectPromptCustomizationRequest"]; + }; + }; responses: { /** @description OK */ 200: { @@ -11599,7 +16150,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["PagedModelPatModel"]; + "application/json": components["schemas"]["ProjectAiPromptCustomizationModel"]; }; }; /** @description Bad Request */ @@ -11640,26 +16191,24 @@ export interface operations { }; }; }; - create_11: { + getAllKeys: { parameters: { query?: never; header?: never; - path?: never; - cookie?: never; - }; - requestBody: { - content: { - "application/json": components["schemas"]["CreatePatDto"]; + path: { + projectId: number; }; + cookie?: never; }; + requestBody?: never; responses: { - /** @description Created */ - 201: { + /** @description OK */ + 200: { headers: { [name: string]: unknown; }; content: { - "*/*": components["schemas"]["RevealedPatModel"]; + "application/json": components["schemas"]["CollectionModelKeyModel"]; }; }; /** @description Bad Request */ @@ -11700,11 +16249,13 @@ export interface operations { }; }; }; - getCurrent: { + getDisabledLanguages_2: { parameters: { query?: never; header?: never; - path?: never; + path: { + projectId: number; + }; cookie?: never; }; requestBody?: never; @@ -11715,7 +16266,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["PatWithUserModel"]; + "application/json": components["schemas"]["CollectionModelKeyDisabledLanguagesModel"]; }; }; /** @description Bad Request */ @@ -11756,12 +16307,14 @@ export interface operations { }; }; }; - get_18: { + allByProject: { parameters: { - query?: never; + query: { + pageable: components["schemas"]["Pageable"]; + }; header?: never; path: { - id: number; + projectId: number; }; cookie?: never; }; @@ -11773,7 +16326,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["PatModel"]; + "application/json": components["schemas"]["PagedModelApiKeyModel"]; }; }; /** @description Bad Request */ @@ -11814,20 +16367,16 @@ export interface operations { }; }; }; - update_7: { + getAutoTranslationSettings: { parameters: { query?: never; header?: never; path: { - id: number; + projectId: number; }; cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["UpdatePatDto"]; - }; - }; + requestBody?: never; responses: { /** @description OK */ 200: { @@ -11835,7 +16384,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["PatModel"]; + "application/json": components["schemas"]["AutoTranslationConfigModel"]; }; }; /** @description Bad Request */ @@ -11876,23 +16425,29 @@ export interface operations { }; }; }; - delete_10: { + setAutoTranslationSettings: { parameters: { query?: never; header?: never; path: { - id: number; + projectId: number; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["AutoTranslationSettingsDto"]; + }; + }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["AutoTranslationConfigModel"]; + }; }; /** @description Bad Request */ 400: { @@ -11932,18 +16487,21 @@ export interface operations { }; }; }; - regenerate: { + uploadAvatar_1: { parameters: { query?: never; header?: never; path: { - id: number; + projectId: number; }; cookie?: never; }; - requestBody: { + requestBody?: { content: { - "application/json": components["schemas"]["RegeneratePatDto"]; + "multipart/form-data": { + /** Format: binary */ + avatar: string; + }; }; }; responses: { @@ -11953,7 +16511,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["RevealedPatModel"]; + "application/json": components["schemas"]["ProjectModel"]; }; }; /** @description Bad Request */ @@ -11994,11 +16552,13 @@ export interface operations { }; }; }; - getPreferred: { + removeAvatar_1: { parameters: { query?: never; header?: never; - path?: never; + path: { + projectId: number; + }; cookie?: never; }; requestBody?: never; @@ -12009,7 +16569,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["PrivateOrganizationModel"]; + "application/json": components["schemas"]["ProjectModel"]; }; }; /** @description Bad Request */ @@ -12050,23 +16610,20 @@ export interface operations { }; }; }; - getAll: { + list: { parameters: { query?: { - /** @description Filter projects by id */ - filterId?: number[]; - /** @description Filter projects without id */ - filterNotId?: number[]; /** @description Zero-based page index (0..N) */ page?: number; /** @description The size of the page to be returned */ size?: number; /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ sort?: string[]; - search?: string; }; header?: never; - path?: never; + path: { + projectId: number; + }; cookie?: never; }; requestBody?: never; @@ -12077,7 +16634,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["PagedModelProjectModel"]; + "application/json": components["schemas"]["PagedModelBatchJobModel"]; }; }; /** @description Bad Request */ @@ -12118,18 +16675,17 @@ export interface operations { }; }; }; - createProject: { + get_6: { parameters: { query?: never; header?: never; - path?: never; - cookie?: never; - }; - requestBody: { - content: { - "application/json": components["schemas"]["CreateProjectRequest"]; + path: { + id: number; + projectId: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description OK */ 200: { @@ -12137,7 +16693,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["ProjectModel"]; + "application/json": components["schemas"]["BatchJobModel"]; }; }; /** @description Bad Request */ @@ -12178,19 +16734,14 @@ export interface operations { }; }; }; - getAllWithStatistics: { + cancel: { parameters: { - query?: { - /** @description Zero-based page index (0..N) */ - page?: number; - /** @description The size of the page to be returned */ - size?: number; - /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ - sort?: string[]; - search?: string; - }; + query?: never; header?: never; - path?: never; + path: { + id: number; + projectId: number; + }; cookie?: never; }; requestBody?: never; @@ -12200,9 +16751,7 @@ export interface operations { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["PagedModelProjectWithStatsModel"]; - }; + content?: never; }; /** @description Bad Request */ 400: { @@ -12242,7 +16791,7 @@ export interface operations { }; }; }; - get_4: { + store_2: { parameters: { query?: never; header?: never; @@ -12251,16 +16800,18 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["BigMetaDto"]; + }; + }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["ProjectModel"]; - }; + content?: never; }; /** @description Bad Request */ 400: { @@ -12300,20 +16851,23 @@ export interface operations { }; }; }; - editProject: { + list_4: { parameters: { - query?: never; + query?: { + /** @description Zero-based page index (0..N) */ + page?: number; + /** @description The size of the page to be returned */ + size?: number; + /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ + sort?: string[]; + }; header?: never; path: { projectId: number; }; cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["EditProjectRequest"]; - }; - }; + requestBody?: never; responses: { /** @description OK */ 200: { @@ -12321,7 +16875,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["ProjectModel"]; + "application/json": components["schemas"]["PagedModelContentDeliveryConfigModel"]; }; }; /** @description Bad Request */ @@ -12362,7 +16916,7 @@ export interface operations { }; }; }; - deleteProject: { + create_10: { parameters: { query?: never; header?: never; @@ -12371,14 +16925,20 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["ContentDeliveryConfigRequest"]; + }; + }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["ContentDeliveryConfigModel"]; + }; }; /** @description Bad Request */ 400: { @@ -12418,18 +16978,12 @@ export interface operations { }; }; }; - getActivity: { + get_17: { parameters: { - query?: { - /** @description Zero-based page index (0..N) */ - page?: number; - /** @description The size of the page to be returned */ - size?: number; - /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ - sort?: string[]; - }; + query?: never; header?: never; path: { + id: number; projectId: number; }; cookie?: never; @@ -12442,7 +16996,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["PagedModelProjectActivityModel"]; + "application/json": components["schemas"]["ContentDeliveryConfigModel"]; }; }; /** @description Bad Request */ @@ -12483,17 +17037,21 @@ export interface operations { }; }; }; - getSingleRevision: { + update_6: { parameters: { query?: never; header?: never; path: { - revisionId: number; + id: number; projectId: number; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["ContentDeliveryConfigRequest"]; + }; + }; responses: { /** @description OK */ 200: { @@ -12501,7 +17059,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["ProjectActivityModel"]; + "application/json": components["schemas"]["ContentDeliveryConfigModel"]; }; }; /** @description Bad Request */ @@ -12542,21 +17100,12 @@ export interface operations { }; }; }; - getModifiedEntitiesByRevision: { + post: { parameters: { - query?: { - /** @description Zero-based page index (0..N) */ - page?: number; - /** @description The size of the page to be returned */ - size?: number; - /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ - sort?: string[]; - /** @description Filters results by specific entity class */ - filterEntityClass?: string[]; - }; + query?: never; header?: never; path: { - revisionId: number; + id: number; projectId: number; }; cookie?: never; @@ -12568,9 +17117,7 @@ export interface operations { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["PagedModelModifiedEntityModel"]; - }; + content?: never; }; /** @description Bad Request */ 400: { @@ -12610,11 +17157,12 @@ export interface operations { }; }; }; - getPromptProjectCustomization: { + delete_9: { parameters: { query?: never; header?: never; path: { + id: number; projectId: number; }; cookie?: never; @@ -12626,9 +17174,7 @@ export interface operations { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["ProjectAiPromptCustomizationModel"]; - }; + content?: never; }; /** @description Bad Request */ 400: { @@ -12668,20 +17214,23 @@ export interface operations { }; }; }; - setPromptProjectCustomization: { + list_3: { parameters: { - query?: never; + query?: { + /** @description Zero-based page index (0..N) */ + page?: number; + /** @description The size of the page to be returned */ + size?: number; + /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ + sort?: string[]; + }; header?: never; path: { projectId: number; }; cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["SetProjectPromptCustomizationRequest"]; - }; - }; + requestBody?: never; responses: { /** @description OK */ 200: { @@ -12689,7 +17238,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["ProjectAiPromptCustomizationModel"]; + "application/json": components["schemas"]["PagedModelContentStorageModel"]; }; }; /** @description Bad Request */ @@ -12730,7 +17279,7 @@ export interface operations { }; }; }; - getAllKeys: { + create_9: { parameters: { query?: never; header?: never; @@ -12739,7 +17288,11 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["ContentStorageRequest"]; + }; + }; responses: { /** @description OK */ 200: { @@ -12747,7 +17300,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["CollectionModelKeyModel"]; + "application/json": components["schemas"]["ContentStorageModel"]; }; }; /** @description Bad Request */ @@ -12788,7 +17341,7 @@ export interface operations { }; }; }; - getDisabledLanguages_2: { + test_1: { parameters: { query?: never; header?: never; @@ -12797,7 +17350,11 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["ContentStorageRequest"]; + }; + }; responses: { /** @description OK */ 200: { @@ -12805,7 +17362,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["CollectionModelKeyDisabledLanguagesModel"]; + "application/json": components["schemas"]["StorageTestResult"]; }; }; /** @description Bad Request */ @@ -12846,13 +17403,12 @@ export interface operations { }; }; }; - allByProject: { + get_16: { parameters: { - query: { - pageable: components["schemas"]["Pageable"]; - }; + query?: never; header?: never; path: { + contentStorageId: number; projectId: number; }; cookie?: never; @@ -12865,7 +17421,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["PagedModelApiKeyModel"]; + "application/json": components["schemas"]["ContentStorageModel"]; }; }; /** @description Bad Request */ @@ -12906,16 +17462,21 @@ export interface operations { }; }; }; - getAutoTranslationSettings: { + update_5: { parameters: { query?: never; header?: never; path: { + contentStorageId: number; projectId: number; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["ContentStorageRequest"]; + }; + }; responses: { /** @description OK */ 200: { @@ -12923,7 +17484,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["AutoTranslationConfigModel"]; + "application/json": components["schemas"]["ContentStorageModel"]; }; }; /** @description Bad Request */ @@ -12964,29 +17525,24 @@ export interface operations { }; }; }; - setAutoTranslationSettings: { + delete_8: { parameters: { query?: never; header?: never; path: { + contentStorageId: number; projectId: number; }; cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["AutoTranslationSettingsDto"]; - }; - }; + requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["AutoTranslationConfigModel"]; - }; + content?: never; }; /** @description Bad Request */ 400: { @@ -13026,21 +17582,19 @@ export interface operations { }; }; }; - uploadAvatar_1: { + testExisting: { parameters: { query?: never; header?: never; path: { + id: number; projectId: number; }; cookie?: never; }; - requestBody?: { + requestBody: { content: { - "multipart/form-data": { - /** Format: binary */ - avatar: string; - }; + "application/json": components["schemas"]["ContentStorageRequest"]; }; }; responses: { @@ -13050,7 +17604,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["ProjectModel"]; + "application/json": components["schemas"]["StorageTestResult"]; }; }; /** @description Bad Request */ @@ -13091,7 +17645,7 @@ export interface operations { }; }; }; - removeAvatar_1: { + currentJobs: { parameters: { query?: never; header?: never; @@ -13108,7 +17662,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["ProjectModel"]; + "application/json": components["schemas"]["CollectionModelBatchJobModel"]; }; }; /** @description Bad Request */ @@ -13149,15 +17703,76 @@ export interface operations { }; }; }; - list_3: { + exportData: { parameters: { query?: { - /** @description Zero-based page index (0..N) */ - page?: number; - /** @description The size of the page to be returned */ - size?: number; - /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ - sort?: string[]; + /** + * @description Languages to be contained in export. + * + * If null, all languages are exported + * @example en + */ + languages?: string[]; + /** @description Format to export to */ + format?: "JSON" | "JSON_TOLGEE" | "XLIFF" | "PO" | "APPLE_STRINGS_STRINGSDICT" | "APPLE_XLIFF" | "ANDROID_XML" | "COMPOSE_XML" | "FLUTTER_ARB" | "PROPERTIES" | "YAML_RUBY" | "YAML" | "JSON_I18NEXT" | "CSV" | "RESX_ICU" | "XLSX" | "APPLE_XCSTRINGS" | "ANDROID_SDK" | "APPLE_SDK"; + /** @description Delimiter to structure file content. + * + * e.g. For key "home.header.title" would result in {"home": {"header": "title": {"Hello"}}} structure. + * + * When null, resulting file won't be structured. Works only for generic structured formats (e.g. JSON, YAML), + * specific formats like `YAML_RUBY` don't honor this parameter. */ + structureDelimiter?: string; + /** @description Filter key IDs to be contained in export */ + filterKeyId?: number[]; + /** @description Filter key IDs not to be contained in export */ + filterKeyIdNot?: number[]; + /** @description Filter keys tagged by. + * + * This filter works the same as `filterTagIn` but in this cases it accepts single tag only. */ + filterTag?: string; + /** @description Filter keys tagged by one of provided tags */ + filterTagIn?: string[]; + /** @description Filter keys not tagged by one of provided tags */ + filterTagNotIn?: string[]; + /** @description Filter keys with prefix */ + filterKeyPrefix?: string; + /** @description Filter translations with state. By default, all states except untranslated is exported. */ + filterState?: ("UNTRANSLATED" | "TRANSLATED" | "REVIEWED" | "DISABLED")[]; + /** @description Filter translations with namespace. By default, all namespaces everything are exported. To export default namespace, use empty string. */ + filterNamespace?: string[]; + /** @description If false, it doesn't return zip of files, but it returns single file. + * + * This is possible only when single language is exported. Otherwise it returns "400 - Bad Request" response. */ + zip?: boolean; + /** @description Message format to be used for export. + * + * e.g. PHP_PO: Hello %s, ICU: Hello {name}. + * + * This property is honored only for generic formats like JSON or YAML. + * For specific formats like `YAML_RUBY` it's ignored. */ + messageFormat?: "C_SPRINTF" | "PHP_SPRINTF" | "JAVA_STRING_FORMAT" | "APPLE_SPRINTF" | "RUBY_SPRINTF" | "I18NEXT" | "ICU" | "PYTHON_PERCENT"; + /** @description This is a template that defines the structure of the resulting .zip file content. + * + * The template is a string that can contain the following placeholders: {namespace}, {languageTag}, + * {androidLanguageTag}, {snakeLanguageTag}, {extension}. + * + * For example, when exporting to JSON with the template `{namespace}/{languageTag}.{extension}`, + * the English translations of the `home` namespace will be stored in `home/en.json`. + * + * The `{snakeLanguageTag}` placeholder is the same as `{languageTag}` but in snake case. (e.g., en_US). + * + * The Android specific `{androidLanguageTag}` placeholder is the same as `{languageTag}` + * but in Android format. (e.g., en-rUS) + * */ + fileStructureTemplate?: string; + /** @description If true, for structured formats (like JSON) arrays are supported. + * + * e.g. Key hello[0] will be exported as {"hello": ["..."]} */ + supportArrays?: boolean; + /** @description If true, HTML tags are escaped in the exported file. (Supported in the XLIFF format only). + * + * e.g. Key hello will be exported as <b>hello</b> */ + escapeHtml?: boolean; }; header?: never; path: { @@ -13167,13 +17782,14 @@ export interface operations { }; requestBody?: never; responses: { - /** @description OK */ + /** @description When multiple files are exported, they are zipped and returned as a single zip file. + * When a single file is exported, it is returned directly. */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["PagedModelBatchJobModel"]; + "application/*": unknown; }; }; /** @description Bad Request */ @@ -13214,25 +17830,29 @@ export interface operations { }; }; }; - get_12: { + exportPost: { parameters: { query?: never; header?: never; path: { - id: number; projectId: number; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["ExportParams"]; + }; + }; responses: { - /** @description OK */ + /** @description When multiple files are exported, they are zipped and returned as a single zip file. + * When a single file is exported, it is returned directly. */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["BatchJobModel"]; + "application/*": unknown; }; }; /** @description Bad Request */ @@ -13273,24 +17893,29 @@ export interface operations { }; }; }; - cancel: { + getHighlights: { parameters: { query?: never; header?: never; path: { - id: number; projectId: number; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["GlossaryHighlightsRequest"]; + }; + }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["CollectionModelGlossaryTermHighlightModel"]; + }; }; /** @description Bad Request */ 400: { @@ -13330,18 +17955,26 @@ export interface operations { }; }; }; - store_2: { + addFiles: { parameters: { - query?: never; + query?: { + /** + * @description When importing files in structured formats (e.g., JSON, YAML), this field defines the delimiter which will be used in names of imported keys. + * @example . + */ + structureDelimiter?: string; + }; header?: never; path: { projectId: number; }; cookie?: never; }; - requestBody: { + requestBody?: { content: { - "application/json": components["schemas"]["BigMetaDto"]; + "multipart/form-data": { + files: string[]; + }; }; }; responses: { @@ -13350,7 +17983,9 @@ export interface operations { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["ImportAddFilesResultModel"]; + }; }; /** @description Bad Request */ 400: { @@ -13390,16 +18025,9 @@ export interface operations { }; }; }; - list_2: { + cancelImport: { parameters: { - query?: { - /** @description Zero-based page index (0..N) */ - page?: number; - /** @description The size of the page to be returned */ - size?: number; - /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ - sort?: string[]; - }; + query?: never; header?: never; path: { projectId: number; @@ -13413,9 +18041,7 @@ export interface operations { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["PagedModelContentDeliveryConfigModel"]; - }; + content?: never; }; /** @description Bad Request */ 400: { @@ -13455,7 +18081,7 @@ export interface operations { }; }; }; - create_6: { + get_4: { parameters: { query?: never; header?: never; @@ -13464,11 +18090,7 @@ export interface operations { }; cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["ContentDeliveryConfigRequest"]; - }; - }; + requestBody?: never; responses: { /** @description OK */ 200: { @@ -13476,7 +18098,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["ContentDeliveryConfigModel"]; + "application/json": components["schemas"]["ImportSettingsModel"]; }; }; /** @description Bad Request */ @@ -13517,17 +18139,20 @@ export interface operations { }; }; }; - get_9: { + store: { parameters: { query?: never; header?: never; path: { - id: number; projectId: number; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["ImportSettingsRequest"]; + }; + }; responses: { /** @description OK */ 200: { @@ -13535,7 +18160,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["ContentDeliveryConfigModel"]; + "application/json": components["schemas"]["ImportSettingsModel"]; }; }; /** @description Bad Request */ @@ -13576,21 +18201,16 @@ export interface operations { }; }; }; - update_4: { + getAllNamespaces: { parameters: { query?: never; header?: never; path: { - id: number; projectId: number; }; cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["ContentDeliveryConfigRequest"]; - }; - }; + requestBody?: never; responses: { /** @description OK */ 200: { @@ -13598,7 +18218,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["ContentDeliveryConfigModel"]; + "application/json": components["schemas"]["CollectionModelImportNamespaceModel"]; }; }; /** @description Bad Request */ @@ -13639,12 +18259,14 @@ export interface operations { }; }; }; - post: { + applyImport: { parameters: { - query?: never; + query?: { + /** @description Whether override or keep all translations with unresolved conflicts */ + forceMode?: "OVERRIDE" | "KEEP" | "NO_FORCE"; + }; header?: never; path: { - id: number; projectId: number; }; cookie?: never; @@ -13696,12 +18318,14 @@ export interface operations { }; }; }; - delete_7: { + applyImportStreaming: { parameters: { - query?: never; + query?: { + /** @description Whether override or keep all translations with unresolved conflicts */ + forceMode?: "OVERRIDE" | "KEEP" | "NO_FORCE"; + }; header?: never; path: { - id: number; projectId: number; }; cookie?: never; @@ -13713,7 +18337,9 @@ export interface operations { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/x-ndjson": components["schemas"]["StreamingResponseBody"]; + }; }; /** @description Bad Request */ 400: { @@ -13753,7 +18379,7 @@ export interface operations { }; }; }; - list_1: { + getImportResult: { parameters: { query?: { /** @description Zero-based page index (0..N) */ @@ -13777,7 +18403,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["PagedModelContentStorageModel"]; + "application/json": components["schemas"]["PagedModelImportLanguageModel"]; }; }; /** @description Bad Request */ @@ -13818,18 +18444,19 @@ export interface operations { }; }; }; - create_5: { + selectNamespace: { parameters: { query?: never; header?: never; path: { + fileId: number; projectId: number; }; cookie?: never; }; requestBody: { content: { - "application/json": components["schemas"]["ContentStorageRequest"]; + "application/json": components["schemas"]["SetFileNamespaceRequest"]; }; }; responses: { @@ -13838,9 +18465,7 @@ export interface operations { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["ContentStorageModel"]; - }; + content?: never; }; /** @description Bad Request */ 400: { @@ -13880,20 +18505,24 @@ export interface operations { }; }; }; - test_1: { + getImportFileIssues: { parameters: { - query?: never; + query?: { + /** @description Zero-based page index (0..N) */ + page?: number; + /** @description The size of the page to be returned */ + size?: number; + /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ + sort?: string[]; + }; header?: never; path: { + importFileId: number; projectId: number; }; cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["ContentStorageRequest"]; - }; - }; + requestBody?: never; responses: { /** @description OK */ 200: { @@ -13901,7 +18530,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["StorageTestResult"]; + "application/json": components["schemas"]["PagedModelImportFileIssueModel"]; }; }; /** @description Bad Request */ @@ -13942,12 +18571,12 @@ export interface operations { }; }; }; - get_8: { + resetExistingLanguage: { parameters: { query?: never; header?: never; path: { - contentStorageId: number; + importLanguageId: number; projectId: number; }; cookie?: never; @@ -13959,9 +18588,7 @@ export interface operations { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["ContentStorageModel"]; - }; + content?: never; }; /** @description Bad Request */ 400: { @@ -14001,30 +18628,25 @@ export interface operations { }; }; }; - update_3: { + selectExistingLanguage: { parameters: { query?: never; header?: never; path: { - contentStorageId: number; + importLanguageId: number; + existingLanguageId: number; projectId: number; }; cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["ContentStorageRequest"]; - }; - }; + requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["ContentStorageModel"]; - }; + content?: never; }; /** @description Bad Request */ 400: { @@ -14064,12 +18686,12 @@ export interface operations { }; }; }; - delete_6: { + getImportLanguage: { parameters: { query?: never; header?: never; path: { - contentStorageId: number; + languageId: number; projectId: number; }; cookie?: never; @@ -14081,7 +18703,9 @@ export interface operations { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["ImportLanguageModel"]; + }; }; /** @description Bad Request */ 400: { @@ -14121,30 +18745,24 @@ export interface operations { }; }; }; - testExisting: { + deleteLanguage: { parameters: { query?: never; header?: never; path: { - id: number; + languageId: number; projectId: number; }; cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["ContentStorageRequest"]; - }; - }; + requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["StorageTestResult"]; - }; + content?: never; }; /** @description Bad Request */ 400: { @@ -14184,11 +18802,12 @@ export interface operations { }; }; }; - currentJobs: { + resolveTranslationSetKeepExisting_2: { parameters: { query?: never; header?: never; path: { + languageId: number; projectId: number; }; cookie?: never; @@ -14200,9 +18819,7 @@ export interface operations { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["CollectionModelBatchJobModel"]; - }; + content?: never; }; /** @description Bad Request */ 400: { @@ -14224,108 +18841,42 @@ export interface operations { }; /** @description Forbidden */ 403: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; - }; - }; - /** @description Not Found */ - 404: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; - }; - }; - }; - }; - exportData: { - parameters: { - query?: { - /** - * @description Languages to be contained in export. - * - * If null, all languages are exported - * @example en - */ - languages?: string[]; - /** @description Format to export to */ - format?: "JSON" | "JSON_TOLGEE" | "XLIFF" | "PO" | "APPLE_STRINGS_STRINGSDICT" | "APPLE_XLIFF" | "ANDROID_XML" | "COMPOSE_XML" | "FLUTTER_ARB" | "PROPERTIES" | "YAML_RUBY" | "YAML" | "JSON_I18NEXT" | "CSV" | "RESX_ICU" | "XLSX" | "APPLE_XCSTRINGS"; - /** @description Delimiter to structure file content. - * - * e.g. For key "home.header.title" would result in {"home": {"header": "title": {"Hello"}}} structure. - * - * When null, resulting file won't be structured. Works only for generic structured formats (e.g. JSON, YAML), - * specific formats like `YAML_RUBY` don't honor this parameter. */ - structureDelimiter?: string; - /** @description Filter key IDs to be contained in export */ - filterKeyId?: number[]; - /** @description Filter key IDs not to be contained in export */ - filterKeyIdNot?: number[]; - /** @description Filter keys tagged by. - * - * This filter works the same as `filterTagIn` but in this cases it accepts single tag only. */ - filterTag?: string; - /** @description Filter keys tagged by one of provided tags */ - filterTagIn?: string[]; - /** @description Filter keys not tagged by one of provided tags */ - filterTagNotIn?: string[]; - /** @description Filter keys with prefix */ - filterKeyPrefix?: string; - /** @description Filter translations with state. By default, all states except untranslated is exported. */ - filterState?: ("UNTRANSLATED" | "TRANSLATED" | "REVIEWED" | "DISABLED")[]; - /** @description Filter translations with namespace. By default, all namespaces everything are exported. To export default namespace, use empty string. */ - filterNamespace?: string[]; - /** @description If false, it doesn't return zip of files, but it returns single file. - * - * This is possible only when single language is exported. Otherwise it returns "400 - Bad Request" response. */ - zip?: boolean; - /** @description Message format to be used for export. - * - * e.g. PHP_PO: Hello %s, ICU: Hello {name}. - * - * This property is honored only for generic formats like JSON or YAML. - * For specific formats like `YAML_RUBY` it's ignored. */ - messageFormat?: "C_SPRINTF" | "PHP_SPRINTF" | "JAVA_STRING_FORMAT" | "APPLE_SPRINTF" | "RUBY_SPRINTF" | "I18NEXT" | "ICU" | "PYTHON_PERCENT"; - /** @description This is a template that defines the structure of the resulting .zip file content. - * - * The template is a string that can contain the following placeholders: {namespace}, {languageTag}, - * {androidLanguageTag}, {snakeLanguageTag}, {extension}. - * - * For example, when exporting to JSON with the template `{namespace}/{languageTag}.{extension}`, - * the English translations of the `home` namespace will be stored in `home/en.json`. - * - * The `{snakeLanguageTag}` placeholder is the same as `{languageTag}` but in snake case. (e.g., en_US). - * - * The Android specific `{androidLanguageTag}` placeholder is the same as `{languageTag}` - * but in Android format. (e.g., en-rUS) - * */ - fileStructureTemplate?: string; - /** @description If true, for structured formats (like JSON) arrays are supported. - * - * e.g. Key hello[0] will be exported as {"hello": ["..."]} */ - supportArrays?: boolean; + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; }; + }; + }; + resolveTranslationSetOverride_2: { + parameters: { + query?: never; header?: never; path: { + languageId: number; projectId: number; }; cookie?: never; }; requestBody?: never; responses: { - /** @description When multiple files are exported, they are zipped and returned as a single zip file. - * When a single file is exported, it is returned directly. */ + /** @description OK */ 200: { headers: { [name: string]: unknown; }; - content: { - "application/*": unknown; - }; + content?: never; }; /** @description Bad Request */ 400: { @@ -14365,29 +18916,38 @@ export interface operations { }; }; }; - exportPost: { + getImportTranslations: { parameters: { - query?: never; + query?: { + /** @description Whether only translations, which are in conflict with existing translations should be returned */ + onlyConflicts?: boolean; + /** @description Whether only translations with unresolved conflictswith existing translations should be returned */ + onlyUnresolved?: boolean; + /** @description String to search in translation text or key */ + search?: string; + /** @description Zero-based page index (0..N) */ + page?: number; + /** @description The size of the page to be returned */ + size?: number; + /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ + sort?: string[]; + }; header?: never; path: { projectId: number; + languageId: number; }; cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["ExportParams"]; - }; - }; + requestBody?: never; responses: { - /** @description When multiple files are exported, they are zipped and returned as a single zip file. - * When a single file is exported, it is returned directly. */ + /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { - "application/*": unknown; + "application/json": components["schemas"]["PagedModelImportTranslationModel"]; }; }; /** @description Bad Request */ @@ -14428,37 +18988,25 @@ export interface operations { }; }; }; - addFiles: { + resolveTranslationSetKeepExisting: { parameters: { - query?: { - /** - * @description When importing files in structured formats (e.g., JSON, YAML), this field defines the delimiter which will be used in names of imported keys. - * @example . - */ - structureDelimiter?: string; - }; + query?: never; header?: never; path: { + languageId: number; + translationId: number; projectId: number; }; cookie?: never; }; - requestBody?: { - content: { - "multipart/form-data": { - files: string[]; - }; - }; - }; + requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["ImportAddFilesResultModel"]; - }; + content?: never; }; /** @description Bad Request */ 400: { @@ -14498,11 +19046,13 @@ export interface operations { }; }; }; - cancelImport: { + resolveTranslationSetOverride: { parameters: { query?: never; header?: never; path: { + languageId: number; + translationId: number; projectId: number; }; cookie?: never; @@ -14554,7 +19104,7 @@ export interface operations { }; }; }; - get_10: { + getProjectInvitations: { parameters: { query?: never; header?: never; @@ -14571,7 +19121,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["ImportSettingsModel"]; + "application/json": components["schemas"]["CollectionModelProjectInvitationModel"]; }; }; /** @description Bad Request */ @@ -14612,7 +19162,7 @@ export interface operations { }; }; }; - store: { + inviteUser: { parameters: { query?: never; header?: never; @@ -14623,7 +19173,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["ImportSettingsRequest"]; + "application/json": components["schemas"]["ProjectInviteUserDto"]; }; }; responses: { @@ -14633,7 +19183,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["ImportSettingsModel"]; + "application/json": components["schemas"]["ProjectInvitationModel"]; }; }; /** @description Bad Request */ @@ -14674,9 +19224,16 @@ export interface operations { }; }; }; - getAllNamespaces_2: { + getAll_9: { parameters: { - query?: never; + query?: { + /** @description Zero-based page index (0..N) */ + page?: number; + /** @description The size of the page to be returned */ + size?: number; + /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ + sort?: string[]; + }; header?: never; path: { projectId: number; @@ -14691,7 +19248,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["CollectionModelImportNamespaceModel"]; + "application/json": components["schemas"]["PagedModelKeyModel"]; }; }; /** @description Bad Request */ @@ -14732,26 +19289,29 @@ export interface operations { }; }; }; - applyImport: { + create_6: { parameters: { - query?: { - /** @description Whether override or keep all translations with unresolved conflicts */ - forceMode?: "OVERRIDE" | "KEEP" | "NO_FORCE"; - }; + query?: never; header?: never; path: { projectId: number; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["CreateKeyDto"]; + }; + }; responses: { - /** @description OK */ - 200: { + /** @description Created */ + 201: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "*/*": components["schemas"]["KeyWithDataModel"]; + }; }; /** @description Bad Request */ 400: { @@ -14791,28 +19351,27 @@ export interface operations { }; }; }; - applyImportStreaming: { + delete_6: { parameters: { - query?: { - /** @description Whether override or keep all translations with unresolved conflicts */ - forceMode?: "OVERRIDE" | "KEEP" | "NO_FORCE"; - }; + query?: never; header?: never; path: { projectId: number; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["DeleteKeysDto"]; + }; + }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; - content: { - "application/x-ndjson": components["schemas"]["StreamingResponseBody"]; - }; + content?: never; }; /** @description Bad Request */ 400: { @@ -14852,31 +19411,28 @@ export interface operations { }; }; }; - getImportResult: { + create_5: { parameters: { - query?: { - /** @description Zero-based page index (0..N) */ - page?: number; - /** @description The size of the page to be returned */ - size?: number; - /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ - sort?: string[]; - }; + query?: never; header?: never; path: { projectId: number; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["CreateKeyDto"]; + }; + }; responses: { - /** @description OK */ - 200: { + /** @description Created */ + 201: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["PagedModelImportLanguageModel"]; + "*/*": components["schemas"]["KeyWithDataModel"]; }; }; /** @description Bad Request */ @@ -14917,19 +19473,18 @@ export interface operations { }; }; }; - selectNamespace: { + importKeys_2: { parameters: { query?: never; header?: never; path: { - fileId: number; projectId: number; }; cookie?: never; }; requestBody: { content: { - "application/json": components["schemas"]["SetFileNamespaceRequest"]; + "application/json": components["schemas"]["ImportKeysDto"]; }; }; responses: { @@ -14978,24 +19533,20 @@ export interface operations { }; }; }; - getImportFileIssues: { + importKeys: { parameters: { - query?: { - /** @description Zero-based page index (0..N) */ - page?: number; - /** @description The size of the page to be returned */ - size?: number; - /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ - sort?: string[]; - }; + query?: never; header?: never; path: { - importFileId: number; projectId: number; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["ImportKeysResolvableDto"]; + }; + }; responses: { /** @description OK */ 200: { @@ -15003,7 +19554,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["PagedModelImportFileIssueModel"]; + "application/json": components["schemas"]["KeyImportResolvableResultModel"]; }; }; /** @description Bad Request */ @@ -15044,24 +19595,29 @@ export interface operations { }; }; }; - resetExistingLanguage: { + getInfo: { parameters: { query?: never; header?: never; path: { - importLanguageId: number; projectId: number; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["GetKeysRequestDto"]; + }; + }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["CollectionModelKeyWithDataModel"]; + }; }; /** @description Bad Request */ 400: { @@ -15101,13 +19657,22 @@ export interface operations { }; }; }; - selectExistingLanguage: { + searchForKey: { parameters: { - query?: never; + query: { + /** @description Search query */ + search: string; + /** @description Language to search in */ + languageTag?: string; + /** @description Zero-based page index (0..N) */ + page?: number; + /** @description The size of the page to be returned */ + size?: number; + /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ + sort?: string[]; + }; header?: never; path: { - importLanguageId: number; - existingLanguageId: number; projectId: number; }; cookie?: never; @@ -15119,7 +19684,9 @@ export interface operations { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["PagedModelKeySearchSearchResultModel"]; + }; }; /** @description Bad Request */ 400: { @@ -15157,14 +19724,103 @@ export interface operations { "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; }; }; - }; - }; - getImportLanguage: { - parameters: { - query?: never; + }; + }; + selectKeys_2: { + parameters: { + query?: { + /** @description Translation state in the format: languageTag,state. You can use this parameter multiple times. + * + * When used with multiple states for same language it is applied with logical OR. + * + * When used with multiple languages, it is applied with logical AND. + * */ + filterState?: string[]; + /** + * @description Languages to be contained in response. + * + * To add multiple languages, repeat this param (eg. ?languages=en&languages=de) + * @example en + */ + languages?: string[]; + /** @description String to search in key name or translation text */ + search?: string; + /** @description Selects key with provided names. Use this param multiple times to fetch more keys. */ + filterKeyName?: string[]; + /** @description Selects key with provided ID. Use this param multiple times to fetch more keys. */ + filterKeyId?: number[]; + /** @description Selects only keys for which the translation is missing in any returned language. It only filters for translations included in returned languages. */ + filterUntranslatedAny?: boolean; + /** @description Selects only keys, where translation is provided in any language */ + filterTranslatedAny?: boolean; + /** + * @description Selects only keys where the translation is missing for the specified language. The specified language must be included in the returned languages. Otherwise, this filter doesn't apply. + * @example en-US + */ + filterUntranslatedInLang?: string; + /** + * @description Selects only keys, where translation is provided in specified language + * @example en-US + */ + filterTranslatedInLang?: string; + /** + * @description Selects only keys, where translation was auto translated for specified languages. + * @example en-US + */ + filterAutoTranslatedInLang?: string[]; + /** @description Selects only keys with screenshots */ + filterHasScreenshot?: boolean; + /** @description Selects only keys without screenshots */ + filterHasNoScreenshot?: boolean; + /** @description Selects only keys with provided namespaces. + * + * To filter default namespace, set to empty string. + * */ + filterNamespace?: string[]; + /** @description Selects only keys without provided namespaces. + * + * To filter default namespace, set to empty string. + * */ + filterNoNamespace?: string[]; + /** @description Selects only keys with provided tag */ + filterTag?: string[]; + /** @description Selects only keys without provided tag */ + filterNoTag?: string[]; + /** + * @description Selects only keys, where translation in provided langs is in outdated state + * @example en-US + */ + filterOutdatedLanguage?: string[]; + /** + * @description Selects only keys, where translation in provided langs is not in outdated state + * @example en-US + */ + filterNotOutdatedLanguage?: string[]; + /** + * @description Selects only key affected by activity with specidfied revision ID + * @example 1234567 + */ + filterRevisionId?: number[]; + /** @description Select only keys which were not successfully translated by batch job with provided id */ + filterFailedKeysOfJob?: number; + /** @description Select only keys which are in specified task */ + filterTaskNumber?: number[]; + /** @description Filter task keys which are `not done` */ + filterTaskKeysNotDone?: boolean; + /** @description Filter task keys which are `done` */ + filterTaskKeysDone?: boolean; + /** @description Filter keys with unresolved comments in lang */ + filterHasUnresolvedCommentsInLang?: string[]; + /** @description Filter keys with any comments in lang */ + filterHasCommentsInLang?: string[]; + /** + * @description Filter key translations with labels + * @example labelId1,labelId2 + */ + filterLabel?: string[]; + }; header?: never; path: { - languageId: number; projectId: number; }; cookie?: never; @@ -15177,7 +19833,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["ImportLanguageModel"]; + "application/json": components["schemas"]["SelectAllResponse"]; }; }; /** @description Bad Request */ @@ -15218,12 +19874,12 @@ export interface operations { }; }; }; - deleteLanguage: { + delete_4: { parameters: { query?: never; header?: never; path: { - languageId: number; + ids: number[]; projectId: number; }; cookie?: never; @@ -15275,12 +19931,12 @@ export interface operations { }; }; }; - resolveTranslationSetKeepExisting_2: { + get_14: { parameters: { query?: never; header?: never; path: { - languageId: number; + id: number; projectId: number; }; cookie?: never; @@ -15292,7 +19948,9 @@ export interface operations { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["KeyModel"]; + }; }; /** @description Bad Request */ 400: { @@ -15332,24 +19990,30 @@ export interface operations { }; }; }; - resolveTranslationSetOverride_2: { + edit: { parameters: { query?: never; header?: never; path: { - languageId: number; + id: number; projectId: number; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["EditKeyDto"]; + }; + }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["KeyModel"]; + }; }; /** @description Bad Request */ 400: { @@ -15389,26 +20053,13 @@ export interface operations { }; }; }; - getImportTranslations: { + getBigMeta: { parameters: { - query?: { - /** @description Whether only translations, which are in conflict with existing translations should be returned */ - onlyConflicts?: boolean; - /** @description Whether only translations with unresolved conflictswith existing translations should be returned */ - onlyUnresolved?: boolean; - /** @description String to search in translation text or key */ - search?: string; - /** @description Zero-based page index (0..N) */ - page?: number; - /** @description The size of the page to be returned */ - size?: number; - /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ - sort?: string[]; - }; + query?: never; header?: never; path: { + id: number; projectId: number; - languageId: number; }; cookie?: never; }; @@ -15420,7 +20071,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["PagedModelImportTranslationModel"]; + "application/json": components["schemas"]["CollectionModelKeyWithBaseTranslationModel"]; }; }; /** @description Bad Request */ @@ -15461,25 +20112,30 @@ export interface operations { }; }; }; - resolveTranslationSetKeepExisting: { + complexEdit: { parameters: { query?: never; header?: never; path: { - languageId: number; - translationId: number; + id: number; projectId: number; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["ComplexEditKeyDto"]; + }; + }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["KeyWithDataModel"]; + }; }; /** @description Bad Request */ 400: { @@ -15519,13 +20175,12 @@ export interface operations { }; }; }; - resolveTranslationSetOverride: { + getDisabledLanguages: { parameters: { query?: never; header?: never; path: { - languageId: number; - translationId: number; + id: number; projectId: number; }; cookie?: never; @@ -15537,7 +20192,9 @@ export interface operations { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["CollectionModelLanguageModel"]; + }; }; /** @description Bad Request */ 400: { @@ -15577,16 +20234,21 @@ export interface operations { }; }; }; - getProjectInvitations: { + setDisabledLanguages: { parameters: { query?: never; header?: never; path: { + id: number; projectId: number; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["SetDisabledLanguagesRequest"]; + }; + }; responses: { /** @description OK */ 200: { @@ -15594,7 +20256,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["CollectionModelProjectInvitationModel"]; + "application/json": components["schemas"]["CollectionModelLanguageModel"]; }; }; /** @description Bad Request */ @@ -15635,29 +20297,30 @@ export interface operations { }; }; }; - inviteUser: { + autoTranslate: { parameters: { - query?: never; + query?: { + /** @description Tags of languages to auto-translate. + * When no languages provided, it translates only untranslated languages. */ + languages?: string[]; + useMachineTranslation?: boolean; + useTranslationMemory?: boolean; + }; header?: never; path: { + keyId: number; projectId: number; }; cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["ProjectInviteUserDto"]; - }; - }; + requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["ProjectInvitationModel"]; - }; + content?: never; }; /** @description Bad Request */ 400: { @@ -15697,18 +20360,12 @@ export interface operations { }; }; }; - getAll_1: { + getKeyScreenshots_1: { parameters: { - query?: { - /** @description Zero-based page index (0..N) */ - page?: number; - /** @description The size of the page to be returned */ - size?: number; - /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ - sort?: string[]; - }; + query?: never; header?: never; path: { + keyId: number; projectId: number; }; cookie?: never; @@ -15721,7 +20378,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["PagedModelKeyModel"]; + "application/json": components["schemas"]["CollectionModelScreenshotModel"]; }; }; /** @description Bad Request */ @@ -15762,18 +20419,23 @@ export interface operations { }; }; }; - create_2: { + uploadScreenshot_1: { parameters: { query?: never; header?: never; path: { + keyId: number; projectId: number; }; cookie?: never; }; - requestBody: { + requestBody?: { content: { - "application/json": components["schemas"]["CreateKeyDto"]; + "multipart/form-data": { + /** Format: binary */ + screenshot: string; + info?: components["schemas"]["ScreenshotInfoDto"]; + }; }; }; responses: { @@ -15783,7 +20445,7 @@ export interface operations { [name: string]: unknown; }; content: { - "*/*": components["schemas"]["KeyWithDataModel"]; + "*/*": components["schemas"]["ScreenshotModel"]; }; }; /** @description Bad Request */ @@ -15824,20 +20486,18 @@ export interface operations { }; }; }; - delete_4: { + deleteScreenshots_1: { parameters: { query?: never; header?: never; path: { + ids: number[]; + keyId: number; projectId: number; }; cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["DeleteKeysDto"]; - }; - }; + requestBody?: never; responses: { /** @description OK */ 200: { @@ -15884,28 +20544,29 @@ export interface operations { }; }; }; - create_1: { + tagKey: { parameters: { query?: never; header?: never; path: { + keyId: number; projectId: number; }; cookie?: never; }; requestBody: { content: { - "application/json": components["schemas"]["CreateKeyDto"]; + "application/json": components["schemas"]["TagKeyDto"]; }; }; responses: { - /** @description Created */ - 201: { + /** @description OK */ + 200: { headers: { [name: string]: unknown; }; content: { - "*/*": components["schemas"]["KeyWithDataModel"]; + "application/json": components["schemas"]["TagModel"]; }; }; /** @description Bad Request */ @@ -15946,20 +20607,18 @@ export interface operations { }; }; }; - importKeys_2: { + removeTag: { parameters: { query?: never; header?: never; path: { + keyId: number; + tagId: number; projectId: number; }; cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["ImportKeysDto"]; - }; - }; + requestBody?: never; responses: { /** @description OK */ 200: { @@ -16006,20 +20665,24 @@ export interface operations { }; }; }; - importKeys: { + getAll_3: { parameters: { - query?: never; + query?: { + search?: string; + /** @description Zero-based page index (0..N) */ + page?: number; + /** @description The size of the page to be returned */ + size?: number; + /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ + sort?: string[]; + }; header?: never; path: { projectId: number; }; cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["ImportKeysResolvableDto"]; - }; - }; + requestBody?: never; responses: { /** @description OK */ 200: { @@ -16027,7 +20690,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["KeyImportResolvableResultModel"]; + "application/json": components["schemas"]["PagedModelLabelModel"]; }; }; /** @description Bad Request */ @@ -16068,7 +20731,7 @@ export interface operations { }; }; }; - getInfo: { + createLabel: { parameters: { query?: never; header?: never; @@ -16079,7 +20742,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["GetKeysRequestDto"]; + "application/json": components["schemas"]["LabelRequest"]; }; }; responses: { @@ -16089,7 +20752,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["CollectionModelKeyWithDataModel"]; + "application/json": components["schemas"]["LabelModel"]; }; }; /** @description Bad Request */ @@ -16130,19 +20793,10 @@ export interface operations { }; }; }; - searchForKey: { - parameters: { - query: { - /** @description Search query */ - search: string; - /** @description Language to search in */ - languageTag?: string; - /** @description Zero-based page index (0..N) */ - page?: number; - /** @description The size of the page to be returned */ - size?: number; - /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ - sort?: string[]; + getLabelsByIds: { + parameters: { + query: { + id: number[]; }; header?: never; path: { @@ -16158,7 +20812,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["PagedModelKeySearchSearchResultModel"]; + "application/json": components["schemas"]["LabelModel"][]; }; }; /** @description Bad Request */ @@ -16199,85 +20853,21 @@ export interface operations { }; }; }; - selectKeys_2: { + updateLabel: { parameters: { - query?: { - /** @description Translation state in the format: languageTag,state. You can use this parameter multiple times. - * - * When used with multiple states for same language it is applied with logical OR. - * - * When used with multiple languages, it is applied with logical AND. - * */ - filterState?: string[]; - /** - * @description Languages to be contained in response. - * - * To add multiple languages, repeat this param (eg. ?languages=en&languages=de) - * @example en - */ - languages?: string[]; - /** @description String to search in key name or translation text */ - search?: string; - /** @description Selects key with provided names. Use this param multiple times to fetch more keys. */ - filterKeyName?: string[]; - /** @description Selects key with provided ID. Use this param multiple times to fetch more keys. */ - filterKeyId?: number[]; - /** @description Selects only keys for which the translation is missing in any returned language. It only filters for translations included in returned languages. */ - filterUntranslatedAny?: boolean; - /** @description Selects only keys, where translation is provided in any language */ - filterTranslatedAny?: boolean; - /** - * @description Selects only keys where the translation is missing for the specified language. The specified language must be included in the returned languages. Otherwise, this filter doesn't apply. - * @example en-US - */ - filterUntranslatedInLang?: string; - /** - * @description Selects only keys, where translation is provided in specified language - * @example en-US - */ - filterTranslatedInLang?: string; - /** @description Selects only keys with screenshots */ - filterHasScreenshot?: boolean; - /** @description Selects only keys without screenshots */ - filterHasNoScreenshot?: boolean; - /** @description Filter namespaces. - * - * To filter default namespace, set to empty string. - * */ - filterNamespace?: string[]; - /** @description Selects only keys with provided tag */ - filterTag?: string[]; - /** - * @description Selects only keys, where translation in provided langs is in outdated state - * @example en-US - */ - filterOutdatedLanguage?: string[]; - /** - * @description Selects only keys, where translation in provided langs is not in outdated state - * @example en-US - */ - filterNotOutdatedLanguage?: string[]; - /** - * @description Selects only key affected by activity with specidfied revision ID - * @example 1234567 - */ - filterRevisionId?: number[]; - /** @description Select only keys which were not successfully translated by batch job with provided id */ - filterFailedKeysOfJob?: number; - /** @description Select only keys which are in specified task */ - filterTaskNumber?: number[]; - /** @description Filter task keys which are `not done` */ - filterTaskKeysNotDone?: boolean; - /** @description Filter task keys which are `done` */ - filterTaskKeysDone?: boolean; - }; + query?: never; header?: never; path: { + labelId: number; projectId: number; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["LabelRequest"]; + }; + }; responses: { /** @description OK */ 200: { @@ -16285,7 +20875,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["SelectAllResponse"]; + "application/json": components["schemas"]["LabelModel"]; }; }; /** @description Bad Request */ @@ -16326,12 +20916,12 @@ export interface operations { }; }; }; - delete_2: { + deleteLabel: { parameters: { query?: never; header?: never; path: { - ids: number[]; + labelId: number; projectId: number; }; cookie?: never; @@ -16383,12 +20973,11 @@ export interface operations { }; }; }; - get_6: { + getLanguagePromptCustomizations: { parameters: { query?: never; header?: never; path: { - id: number; projectId: number; }; cookie?: never; @@ -16401,7 +20990,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["KeyModel"]; + "application/json": components["schemas"]["CollectionModelLanguageAiPromptCustomizationModel"]; }; }; /** @description Bad Request */ @@ -16442,21 +21031,29 @@ export interface operations { }; }; }; - edit: { + getAll_7: { parameters: { - query?: never; + query?: { + /** @description Zero-based page index (0..N) */ + page?: number; + /** @description The size of the page to be returned */ + size?: number; + /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ + sort?: string[]; + /** @description Filter languages by id */ + filterId?: number[]; + /** @description Filter languages without id */ + filterNotId?: number[]; + /** @description Filter languages by name or tag */ + search?: string; + }; header?: never; path: { - id: number; projectId: number; }; cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["EditKeyDto"]; - }; - }; + requestBody?: never; responses: { /** @description OK */ 200: { @@ -16464,7 +21061,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["KeyModel"]; + "application/json": components["schemas"]["PagedModelLanguageModel"]; }; }; /** @description Bad Request */ @@ -16505,17 +21102,20 @@ export interface operations { }; }; }; - getBigMeta: { + createLanguage: { parameters: { query?: never; header?: never; path: { - id: number; projectId: number; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["LanguageRequest"]; + }; + }; responses: { /** @description OK */ 200: { @@ -16523,7 +21123,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["CollectionModelKeyWithBaseTranslationModel"]; + "application/json": components["schemas"]["LanguageModel"]; }; }; /** @description Bad Request */ @@ -16564,21 +21164,17 @@ export interface operations { }; }; }; - complexEdit: { + get_12: { parameters: { query?: never; header?: never; path: { - id: number; + languageId: number; projectId: number; }; cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["ComplexEditKeyDto"]; - }; - }; + requestBody?: never; responses: { /** @description OK */ 200: { @@ -16586,7 +21182,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["KeyWithDataModel"]; + "application/json": components["schemas"]["LanguageModel"]; }; }; /** @description Bad Request */ @@ -16627,17 +21223,21 @@ export interface operations { }; }; }; - getDisabledLanguages: { + editLanguage: { parameters: { query?: never; header?: never; path: { - id: number; + languageId: number; projectId: number; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["LanguageRequest"]; + }; + }; responses: { /** @description OK */ 200: { @@ -16645,7 +21245,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["CollectionModelLanguageModel"]; + "application/json": components["schemas"]["LanguageModel"]; }; }; /** @description Bad Request */ @@ -16686,30 +21286,24 @@ export interface operations { }; }; }; - setDisabledLanguages: { + deleteLanguage_2: { parameters: { query?: never; header?: never; path: { - id: number; + languageId: number; projectId: number; }; cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["SetDisabledLanguagesRequest"]; - }; - }; + requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["CollectionModelLanguageModel"]; - }; + content?: never; }; /** @description Bad Request */ 400: { @@ -16749,30 +21343,30 @@ export interface operations { }; }; }; - autoTranslate: { + setLanguagePromptCustomization: { parameters: { - query?: { - /** @description Tags of languages to auto-translate. - * When no languages provided, it translates only untranslated languages. */ - languages?: string[]; - useMachineTranslation?: boolean; - useTranslationMemory?: boolean; - }; + query?: never; header?: never; path: { - keyId: number; + languageId: number; projectId: number; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["SetLanguagePromptCustomizationRequest"]; + }; + }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["LanguageAiPromptCustomizationModel"]; + }; }; /** @description Bad Request */ 400: { @@ -16812,12 +21406,11 @@ export interface operations { }; }; }; - getKeyScreenshots_1: { + leaveProject: { parameters: { query?: never; header?: never; path: { - keyId: number; projectId: number; }; cookie?: never; @@ -16829,9 +21422,7 @@ export interface operations { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["CollectionModelScreenshotModel"]; - }; + content?: never; }; /** @description Bad Request */ 400: { @@ -16871,33 +21462,24 @@ export interface operations { }; }; }; - uploadScreenshot_1: { + getProjectCredits: { parameters: { query?: never; header?: never; path: { - keyId: number; projectId: number; }; cookie?: never; }; - requestBody?: { - content: { - "multipart/form-data": { - /** Format: binary */ - screenshot: string; - info?: components["schemas"]["ScreenshotInfoDto"]; - }; - }; - }; + requestBody?: never; responses: { - /** @description Created */ - 201: { + /** @description OK */ + 200: { headers: { [name: string]: unknown; }; content: { - "*/*": components["schemas"]["ScreenshotModel"]; + "application/json": components["schemas"]["CreditBalanceModel"]; }; }; /** @description Bad Request */ @@ -16938,13 +21520,11 @@ export interface operations { }; }; }; - deleteScreenshots_1: { + getMachineTranslationLanguageInfo: { parameters: { query?: never; header?: never; path: { - ids: number[]; - keyId: number; projectId: number; }; cookie?: never; @@ -16956,7 +21536,9 @@ export interface operations { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["CollectionModelLanguageInfoModel"]; + }; }; /** @description Bad Request */ 400: { @@ -16996,21 +21578,16 @@ export interface operations { }; }; }; - tagKey: { + getMachineTranslationSettings: { parameters: { query?: never; header?: never; path: { - keyId: number; projectId: number; }; cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["TagKeyDto"]; - }; - }; + requestBody?: never; responses: { /** @description OK */ 200: { @@ -17018,7 +21595,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["TagModel"]; + "application/json": components["schemas"]["CollectionModelLanguageConfigItemModel"]; }; }; /** @description Bad Request */ @@ -17059,25 +21636,29 @@ export interface operations { }; }; }; - removeTag: { + setMachineTranslationSettings: { parameters: { query?: never; header?: never; path: { - keyId: number; - tagId: number; projectId: number; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["SetMachineTranslationSettingsDto"]; + }; + }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["CollectionModelLanguageConfigItemModel"]; + }; }; /** @description Bad Request */ 400: { @@ -17117,11 +21698,12 @@ export interface operations { }; }; }; - getLanguagePromptCustomizations: { + setMachineTranslationSettings_1: { parameters: { query?: never; header?: never; path: { + promptId: number; projectId: number; }; cookie?: never; @@ -17133,9 +21715,7 @@ export interface operations { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["CollectionModelLanguageAiPromptCustomizationModel"]; - }; + content?: never; }; /** @description Bad Request */ 400: { @@ -17175,7 +21755,7 @@ export interface operations { }; }; }; - getAll_7: { + myList: { parameters: { query?: { /** @description Zero-based page index (0..N) */ @@ -17184,10 +21764,6 @@ export interface operations { size?: number; /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ sort?: string[]; - /** @description Filter languages by id */ - filterId?: number[]; - /** @description Filter languages without id */ - filterNotId?: number[]; }; header?: never; path: { @@ -17203,7 +21779,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["PagedModelLanguageModel"]; + "application/json": components["schemas"]["PagedModelBatchJobModel"]; }; }; /** @description Bad Request */ @@ -17244,20 +21820,17 @@ export interface operations { }; }; }; - createLanguage: { + getByName: { parameters: { query?: never; header?: never; path: { + name: string; projectId: number; }; cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["LanguageRequest"]; - }; - }; + requestBody?: never; responses: { /** @description OK */ 200: { @@ -17265,7 +21838,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["LanguageModel"]; + "application/json": components["schemas"]["NamespaceModel"]; }; }; /** @description Bad Request */ @@ -17306,12 +21879,19 @@ export interface operations { }; }; }; - get_16: { + getAllNamespaces_2: { parameters: { - query?: never; + query?: { + /** @description Zero-based page index (0..N) */ + page?: number; + /** @description The size of the page to be returned */ + size?: number; + /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ + sort?: string[]; + search?: string; + }; header?: never; path: { - languageId: number; projectId: number; }; cookie?: never; @@ -17324,7 +21904,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["LanguageModel"]; + "application/json": components["schemas"]["PagedModelNamespaceModel"]; }; }; /** @description Bad Request */ @@ -17365,19 +21945,19 @@ export interface operations { }; }; }; - editLanguage: { + update_3: { parameters: { query?: never; header?: never; path: { - languageId: number; + id: number; projectId: number; }; cookie?: never; }; requestBody: { content: { - "application/json": components["schemas"]["LanguageRequest"]; + "application/json": components["schemas"]["UpdateNamespaceDto"]; }; }; responses: { @@ -17387,7 +21967,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["LanguageModel"]; + "application/json": components["schemas"]["NamespaceModel"]; }; }; /** @description Bad Request */ @@ -17428,12 +22008,11 @@ export interface operations { }; }; }; - deleteLanguage_2: { + getPerLanguageAutoTranslationSettings: { parameters: { query?: never; header?: never; path: { - languageId: number; projectId: number; }; cookie?: never; @@ -17445,7 +22024,9 @@ export interface operations { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["CollectionModelAutoTranslationConfigModel"]; + }; }; /** @description Bad Request */ 400: { @@ -17485,19 +22066,18 @@ export interface operations { }; }; }; - setLanguagePromptCustomization: { + setPerLanguageAutoTranslationSettings: { parameters: { query?: never; header?: never; path: { - languageId: number; projectId: number; }; cookie?: never; }; requestBody: { content: { - "application/json": components["schemas"]["SetLanguagePromptCustomizationRequest"]; + "application/json": components["schemas"]["AutoTranslationSettingsDto"][]; }; }; responses: { @@ -17507,7 +22087,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["LanguageAiPromptCustomizationModel"]; + "application/json": components["schemas"]["CollectionModelAutoTranslationConfigModel"]; }; }; /** @description Bad Request */ @@ -17548,9 +22128,17 @@ export interface operations { }; }; }; - leaveProject: { + getAllPaged: { parameters: { - query?: never; + query?: { + /** @description Zero-based page index (0..N) */ + page?: number; + /** @description The size of the page to be returned */ + size?: number; + /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ + sort?: string[]; + search?: string; + }; header?: never; path: { projectId: number; @@ -17564,7 +22152,9 @@ export interface operations { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["PagedModelPromptModel"]; + }; }; /** @description Bad Request */ 400: { @@ -17604,7 +22194,7 @@ export interface operations { }; }; }; - getProjectCredits: { + createPrompt: { parameters: { query?: never; header?: never; @@ -17613,7 +22203,11 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["PromptDto"]; + }; + }; responses: { /** @description OK */ 200: { @@ -17621,7 +22215,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["CreditBalanceModel"]; + "application/json": components["schemas"]["PromptModel"]; }; }; /** @description Bad Request */ @@ -17662,7 +22256,7 @@ export interface operations { }; }; }; - getMachineTranslationLanguageInfo: { + getDefaultPrompt: { parameters: { query?: never; header?: never; @@ -17679,7 +22273,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["CollectionModelLanguageInfoModel"]; + "application/json": components["schemas"]["PromptDto"]; }; }; /** @description Bad Request */ @@ -17720,9 +22314,12 @@ export interface operations { }; }; }; - getMachineTranslationSettings: { + variables: { parameters: { - query?: never; + query?: { + keyId?: number; + targetLanguageId?: number; + }; header?: never; path: { projectId: number; @@ -17737,7 +22334,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["CollectionModelLanguageConfigItemModel"]; + "application/json": components["schemas"]["VariablesResponseDto"]; }; }; /** @description Bad Request */ @@ -17778,7 +22375,7 @@ export interface operations { }; }; }; - setMachineTranslationSettings: { + run: { parameters: { query?: never; header?: never; @@ -17789,7 +22386,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["SetMachineTranslationSettingsDto"]; + "application/json": components["schemas"]["PromptRunDto"]; }; }; responses: { @@ -17799,7 +22396,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["CollectionModelLanguageConfigItemModel"]; + "application/json": components["schemas"]["PromptResponseDto"]; }; }; /** @description Bad Request */ @@ -17840,18 +22437,12 @@ export interface operations { }; }; }; - myList: { + getPrompt: { parameters: { - query?: { - /** @description Zero-based page index (0..N) */ - page?: number; - /** @description The size of the page to be returned */ - size?: number; - /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ - sort?: string[]; - }; + query?: never; header?: never; path: { + promptId: number; projectId: number; }; cookie?: never; @@ -17864,7 +22455,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["PagedModelBatchJobModel"]; + "application/json": components["schemas"]["PromptModel"]; }; }; /** @description Bad Request */ @@ -17905,17 +22496,21 @@ export interface operations { }; }; }; - getByName: { + updatePrompt: { parameters: { query?: never; header?: never; path: { - name: string; + promptId: number; projectId: number; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["PromptDto"]; + }; + }; responses: { /** @description OK */ 200: { @@ -17923,7 +22518,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["NamespaceModel"]; + "application/json": components["schemas"]["PromptModel"]; }; }; /** @description Bad Request */ @@ -17964,18 +22559,12 @@ export interface operations { }; }; }; - getAllNamespaces: { + deletePrompt: { parameters: { - query?: { - /** @description Zero-based page index (0..N) */ - page?: number; - /** @description The size of the page to be returned */ - size?: number; - /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ - sort?: string[]; - }; + query?: never; header?: never; path: { + promptId: number; projectId: number; }; cookie?: never; @@ -17987,9 +22576,7 @@ export interface operations { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["PagedModelNamespaceModel"]; - }; + content?: never; }; /** @description Bad Request */ 400: { @@ -18029,19 +22616,21 @@ export interface operations { }; }; }; - update_1: { + doImport: { parameters: { query?: never; header?: never; path: { - id: number; projectId: number; }; cookie?: never; }; - requestBody: { + requestBody?: { content: { - "application/json": components["schemas"]["UpdateNamespaceDto"]; + "multipart/form-data": { + files: string[]; + params: components["schemas"]["SingleStepImportRequest"]; + }; }; }; responses: { @@ -18050,9 +22639,7 @@ export interface operations { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["NamespaceModel"]; - }; + content?: never; }; /** @description Bad Request */ 400: { @@ -18092,7 +22679,7 @@ export interface operations { }; }; }; - getPerLanguageAutoTranslationSettings: { + aiPlaygroundTranslate: { parameters: { query?: never; header?: never; @@ -18101,7 +22688,11 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["MachineTranslationRequest"]; + }; + }; responses: { /** @description OK */ 200: { @@ -18109,7 +22700,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["CollectionModelAutoTranslationConfigModel"]; + "application/json": components["schemas"]["BatchJobModel"]; }; }; /** @description Bad Request */ @@ -18150,7 +22741,7 @@ export interface operations { }; }; }; - setPerLanguageAutoTranslationSettings: { + assignTranslationLabel: { parameters: { query?: never; header?: never; @@ -18161,7 +22752,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["AutoTranslationSettingsDto"][]; + "application/json": components["schemas"]["LabelTranslationsRequest"]; }; }; responses: { @@ -18171,7 +22762,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["CollectionModelAutoTranslationConfigModel"]; + "application/json": components["schemas"]["BatchJobModel"]; }; }; /** @description Bad Request */ @@ -18212,7 +22803,7 @@ export interface operations { }; }; }; - doImport: { + clearTranslations: { parameters: { query?: never; header?: never; @@ -18221,12 +22812,9 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { - "multipart/form-data": { - files: string[]; - params: components["schemas"]["SingleStepImportRequest"]; - }; + "application/json": components["schemas"]["ClearTranslationsRequest"]; }; }; responses: { @@ -18235,7 +22823,9 @@ export interface operations { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["BatchJobModel"]; + }; }; /** @description Bad Request */ 400: { @@ -18275,7 +22865,7 @@ export interface operations { }; }; }; - clearTranslations: { + copyTranslations: { parameters: { query?: never; header?: never; @@ -18286,7 +22876,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["ClearTranslationsRequest"]; + "application/json": components["schemas"]["CopyTranslationRequest"]; }; }; responses: { @@ -18337,7 +22927,7 @@ export interface operations { }; }; }; - copyTranslations: { + deleteKeys: { parameters: { query?: never; header?: never; @@ -18348,7 +22938,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["CopyTranslationRequest"]; + "application/json": components["schemas"]["DeleteKeysRequest"]; }; }; responses: { @@ -18399,7 +22989,7 @@ export interface operations { }; }; }; - deleteKeys: { + machineTranslation: { parameters: { query?: never; header?: never; @@ -18410,7 +23000,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["DeleteKeysRequest"]; + "application/json": components["schemas"]["MachineTranslationRequest"]; }; }; responses: { @@ -18461,7 +23051,7 @@ export interface operations { }; }; }; - machineTranslation: { + translate: { parameters: { query?: never; header?: never; @@ -18472,7 +23062,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["MachineTranslationRequest"]; + "application/json": components["schemas"]["PreTranslationByTmRequest"]; }; }; responses: { @@ -18523,7 +23113,7 @@ export interface operations { }; }; }; - translate: { + setKeysNamespace: { parameters: { query?: never; header?: never; @@ -18534,7 +23124,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["PreTranslationByTmRequest"]; + "application/json": components["schemas"]["SetKeysNamespaceRequest"]; }; }; responses: { @@ -18585,7 +23175,7 @@ export interface operations { }; }; }; - setKeysNamespace: { + setTranslationState_2: { parameters: { query?: never; header?: never; @@ -18596,7 +23186,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["SetKeysNamespaceRequest"]; + "application/json": components["schemas"]["SetTranslationsStateStateRequest"]; }; }; responses: { @@ -18647,7 +23237,7 @@ export interface operations { }; }; }; - setTranslationState_2: { + tagKeys: { parameters: { query?: never; header?: never; @@ -18658,7 +23248,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["SetTranslationsStateStateRequest"]; + "application/json": components["schemas"]["TagKeysRequest"]; }; }; responses: { @@ -18709,7 +23299,7 @@ export interface operations { }; }; }; - tagKeys: { + unassignTranslationLabel: { parameters: { query?: never; header?: never; @@ -18720,7 +23310,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["TagKeysRequest"]; + "application/json": components["schemas"]["LabelTranslationsRequest"]; }; }; responses: { @@ -19204,7 +23794,7 @@ export interface operations { }; }; }; - getAll_3: { + getAll_1: { parameters: { query?: { search?: string; @@ -19274,9 +23864,9 @@ export interface operations { parameters: { query?: { /** @description Filter tasks by state */ - filterState?: ("NEW" | "IN_PROGRESS" | "DONE" | "CLOSED")[]; + filterState?: ("NEW" | "IN_PROGRESS" | "FINISHED" | "CANCELED")[]; /** @description Filter tasks without state */ - filterNotState?: ("NEW" | "IN_PROGRESS" | "DONE" | "CLOSED")[]; + filterNotState?: ("NEW" | "IN_PROGRESS" | "FINISHED" | "CANCELED")[]; /** @description Filter tasks by assignee */ filterAssignee?: number[]; /** @description Filter tasks by type */ @@ -19295,8 +23885,6 @@ export interface operations { filterKey?: number[]; /** @description Filter tasks by agency */ filterAgency?: number[]; - /** @description Exclude "done" tasks which are older than specified timestamp */ - filterDoneMinClosedAt?: number; /** @description Exclude tasks which were closed before specified timestamp */ filterNotClosedBefore?: number; /** @description Zero-based page index (0..N) */ @@ -19515,7 +24103,83 @@ export interface operations { headers: { [name: string]: unknown; }; - content?: never; + content?: never; + }; + /** @description Bad Request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + }; + }; + getPossibleAssignees: { + parameters: { + query?: { + /** @description Filter users by id */ + filterId?: number[]; + /** @description Filter only users that have at least following scopes */ + filterMinimalScope?: string; + /** @description Filter only users that can view language */ + filterViewLanguageId?: number; + /** @description Filter only users that can edit language */ + filterEditLanguageId?: number; + /** @description Filter only users that can edit state of language */ + filterStateLanguageId?: number; + /** @description Zero-based page index (0..N) */ + page?: number; + /** @description The size of the page to be returned */ + size?: number; + /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ + sort?: string[]; + search?: string; + }; + header?: never; + path: { + projectId: number; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["PagedModelSimpleUserAccountModel"]; + }; }; /** @description Bad Request */ 400: { @@ -19555,29 +24219,12 @@ export interface operations { }; }; }; - getPossibleAssignees: { + getTask: { parameters: { - query?: { - /** @description Filter users by id */ - filterId?: number[]; - /** @description Filter only users that have at least following scopes */ - filterMinimalScope?: string; - /** @description Filter only users that can view language */ - filterViewLanguageId?: number; - /** @description Filter only users that can edit language */ - filterEditLanguageId?: number; - /** @description Filter only users that can edit state of language */ - filterStateLanguageId?: number; - /** @description Zero-based page index (0..N) */ - page?: number; - /** @description The size of the page to be returned */ - size?: number; - /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ - sort?: string[]; - search?: string; - }; + query?: never; header?: never; path: { + taskNumber: number; projectId: number; }; cookie?: never; @@ -19590,7 +24237,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["PagedModelSimpleUserAccountModel"]; + "application/json": components["schemas"]["TaskModel"]; }; }; /** @description Bad Request */ @@ -19631,7 +24278,7 @@ export interface operations { }; }; }; - getTask: { + updateTask: { parameters: { query?: never; header?: never; @@ -19641,7 +24288,11 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["UpdateTaskRequest"]; + }; + }; responses: { /** @description OK */ 200: { @@ -19690,7 +24341,7 @@ export interface operations { }; }; }; - updateTask: { + getBlockingTasks: { parameters: { query?: never; header?: never; @@ -19700,11 +24351,7 @@ export interface operations { }; cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["UpdateTaskRequest"]; - }; - }; + requestBody?: never; responses: { /** @description OK */ 200: { @@ -19712,7 +24359,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["TaskModel"]; + "application/json": number[]; }; }; /** @description Bad Request */ @@ -19753,7 +24400,7 @@ export interface operations { }; }; }; - getBlockingTasks: { + cancelTask: { parameters: { query?: never; header?: never; @@ -19771,7 +24418,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": number[]; + "application/json": components["schemas"]["TaskModel"]; }; }; /** @description Bad Request */ @@ -20447,17 +25094,29 @@ export interface operations { * @example en-US */ filterTranslatedInLang?: string; + /** + * @description Selects only keys, where translation was auto translated for specified languages. + * @example en-US + */ + filterAutoTranslatedInLang?: string[]; /** @description Selects only keys with screenshots */ filterHasScreenshot?: boolean; /** @description Selects only keys without screenshots */ filterHasNoScreenshot?: boolean; - /** @description Filter namespaces. + /** @description Selects only keys with provided namespaces. * * To filter default namespace, set to empty string. * */ filterNamespace?: string[]; + /** @description Selects only keys without provided namespaces. + * + * To filter default namespace, set to empty string. + * */ + filterNoNamespace?: string[]; /** @description Selects only keys with provided tag */ filterTag?: string[]; + /** @description Selects only keys without provided tag */ + filterNoTag?: string[]; /** * @description Selects only keys, where translation in provided langs is in outdated state * @example en-US @@ -20481,6 +25140,15 @@ export interface operations { filterTaskKeysNotDone?: boolean; /** @description Filter task keys which are `done` */ filterTaskKeysDone?: boolean; + /** @description Filter keys with unresolved comments in lang */ + filterHasUnresolvedCommentsInLang?: string[]; + /** @description Filter keys with any comments in lang */ + filterHasCommentsInLang?: string[]; + /** + * @description Filter key translations with labels + * @example labelId1,labelId2 + */ + filterLabel?: string[]; /** @description Zero-based page index (0..N) */ page?: number; /** @description The size of the page to be returned */ @@ -20667,7 +25335,7 @@ export interface operations { }; }; }; - create_9: { + create_3: { parameters: { query?: never; header?: never; @@ -20729,6 +25397,68 @@ export interface operations { }; }; }; + assignLabel_2: { + parameters: { + query?: never; + header?: never; + path: { + projectId: number; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["TranslationLabelRequest"]; + }; + }; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["LabelModel"]; + }; + }; + /** @description Bad Request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + }; + }; selectKeys: { parameters: { query?: { @@ -20766,17 +25496,29 @@ export interface operations { * @example en-US */ filterTranslatedInLang?: string; + /** + * @description Selects only keys, where translation was auto translated for specified languages. + * @example en-US + */ + filterAutoTranslatedInLang?: string[]; /** @description Selects only keys with screenshots */ filterHasScreenshot?: boolean; /** @description Selects only keys without screenshots */ filterHasNoScreenshot?: boolean; - /** @description Filter namespaces. + /** @description Selects only keys with provided namespaces. * * To filter default namespace, set to empty string. * */ filterNamespace?: string[]; + /** @description Selects only keys without provided namespaces. + * + * To filter default namespace, set to empty string. + * */ + filterNoNamespace?: string[]; /** @description Selects only keys with provided tag */ filterTag?: string[]; + /** @description Selects only keys without provided tag */ + filterNoTag?: string[]; /** * @description Selects only keys, where translation in provided langs is in outdated state * @example en-US @@ -20800,6 +25542,15 @@ export interface operations { filterTaskKeysNotDone?: boolean; /** @description Filter task keys which are `done` */ filterTaskKeysDone?: boolean; + /** @description Filter keys with unresolved comments in lang */ + filterHasUnresolvedCommentsInLang?: string[]; + /** @description Filter keys with any comments in lang */ + filterHasCommentsInLang?: string[]; + /** + * @description Filter key translations with labels + * @example labelId1,labelId2 + */ + filterLabel?: string[]; }; header?: never; path: { @@ -20943,19 +25694,142 @@ export interface operations { }; }; }; - getAll_5: { + getAll_5: { + parameters: { + query?: { + /** @description Zero-based page index (0..N) */ + page?: number; + /** @description The size of the page to be returned */ + size?: number; + /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ + sort?: string[]; + }; + header?: never; + path: { + translationId: number; + projectId: number; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["PagedModelTranslationCommentModel"]; + }; + }; + /** @description Bad Request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + }; + }; + create_1: { + parameters: { + query?: never; + header?: never; + path: { + translationId: number; + projectId: number; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["TranslationCommentDto"]; + }; + }; + responses: { + /** @description Created */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "*/*": components["schemas"]["TranslationCommentModel"]; + }; + }; + /** @description Bad Request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + }; + }; + get_10: { parameters: { - query?: { - /** @description Zero-based page index (0..N) */ - page?: number; - /** @description The size of the page to be returned */ - size?: number; - /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ - sort?: string[]; - }; + query?: never; header?: never; path: { translationId: number; + commentId: number; projectId: number; }; cookie?: never; @@ -20968,7 +25842,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["PagedModelTranslationCommentModel"]; + "application/json": components["schemas"]["TranslationCommentModel"]; }; }; /** @description Bad Request */ @@ -21009,11 +25883,12 @@ export interface operations { }; }; }; - create_7: { + update_1: { parameters: { query?: never; header?: never; path: { + commentId: number; translationId: number; projectId: number; }; @@ -21025,13 +25900,13 @@ export interface operations { }; }; responses: { - /** @description Created */ - 201: { + /** @description OK */ + 200: { headers: { [name: string]: unknown; }; content: { - "*/*": components["schemas"]["TranslationCommentModel"]; + "application/json": components["schemas"]["TranslationCommentModel"]; }; }; /** @description Bad Request */ @@ -21072,7 +25947,7 @@ export interface operations { }; }; }; - get_14: { + delete_2: { parameters: { query?: never; header?: never; @@ -21090,9 +25965,7 @@ export interface operations { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["TranslationCommentModel"]; - }; + content?: never; }; /** @description Bad Request */ 400: { @@ -21132,22 +26005,19 @@ export interface operations { }; }; }; - update_5: { + setState: { parameters: { query?: never; header?: never; path: { - commentId: number; translationId: number; + commentId: number; + state: "RESOLUTION_NOT_NEEDED" | "NEEDS_RESOLUTION" | "RESOLVED"; projectId: number; }; cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["TranslationCommentDto"]; - }; - }; + requestBody?: never; responses: { /** @description OK */ 200: { @@ -21196,13 +26066,12 @@ export interface operations { }; }; }; - delete_8: { + dismissAutoTranslatedState: { parameters: { query?: never; header?: never; path: { translationId: number; - commentId: number; projectId: number; }; cookie?: never; @@ -21214,7 +26083,9 @@ export interface operations { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["TranslationModel"]; + }; }; /** @description Bad Request */ 400: { @@ -21254,14 +26125,19 @@ export interface operations { }; }; }; - setState: { + getTranslationHistory: { parameters: { - query?: never; + query?: { + /** @description Zero-based page index (0..N) */ + page?: number; + /** @description The size of the page to be returned */ + size?: number; + /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ + sort?: string[]; + }; header?: never; path: { translationId: number; - commentId: number; - state: "RESOLUTION_NOT_NEEDED" | "NEEDS_RESOLUTION" | "RESOLVED"; projectId: number; }; cookie?: never; @@ -21274,7 +26150,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["TranslationCommentModel"]; + "application/json": components["schemas"]["PagedModelTranslationHistoryModel"]; }; }; /** @description Bad Request */ @@ -21315,12 +26191,13 @@ export interface operations { }; }; }; - dismissAutoTranslatedState: { + assignLabel: { parameters: { query?: never; header?: never; path: { translationId: number; + labelId: number; projectId: number; }; cookie?: never; @@ -21333,7 +26210,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["TranslationModel"]; + "application/json": components["schemas"]["LabelModel"]; }; }; /** @description Bad Request */ @@ -21374,19 +26251,13 @@ export interface operations { }; }; }; - getTranslationHistory: { + unassignLabel: { parameters: { - query?: { - /** @description Zero-based page index (0..N) */ - page?: number; - /** @description The size of the page to be returned */ - size?: number; - /** @description Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. */ - sort?: string[]; - }; + query?: never; header?: never; path: { translationId: number; + labelId: number; projectId: number; }; cookie?: never; @@ -21398,9 +26269,7 @@ export interface operations { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["PagedModelTranslationHistoryModel"]; - }; + content?: never; }; /** @description Bad Request */ 400: { @@ -21937,7 +26806,7 @@ export interface operations { }; }; }; - list: { + list_2: { parameters: { query?: { /** @description Zero-based page index (0..N) */ @@ -22064,7 +26933,7 @@ export interface operations { }; }; }; - get_5: { + get_9: { parameters: { query?: never; header?: never; @@ -22586,6 +27455,66 @@ export interface operations { }; }; }; + prompt: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["LlmParams"]; + }; + }; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["PromptResult"]; + }; + }; + /** @description Bad Request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + }; + }; getInfo_4: { parameters: { query?: never; @@ -22718,7 +27647,7 @@ export interface operations { }; content: { "application/json": { - [key: string]: ("translations.view" | "translations.edit" | "keys.edit" | "screenshots.upload" | "screenshots.delete" | "screenshots.view" | "activity.view" | "languages.edit" | "admin" | "project.edit" | "members.view" | "members.edit" | "translation-comments.add" | "translation-comments.edit" | "translation-comments.set-state" | "translations.state-edit" | "keys.view" | "keys.delete" | "keys.create" | "batch-jobs.view" | "batch-jobs.cancel" | "translations.batch-by-tm" | "translations.batch-machine" | "content-delivery.manage" | "content-delivery.publish" | "webhooks.manage" | "tasks.view" | "tasks.edit")[]; + [key: string]: ("translations.view" | "translations.edit" | "keys.edit" | "screenshots.upload" | "screenshots.delete" | "screenshots.view" | "activity.view" | "languages.edit" | "admin" | "project.edit" | "members.view" | "members.edit" | "translation-comments.add" | "translation-comments.edit" | "translation-comments.set-state" | "translations.state-edit" | "keys.view" | "keys.delete" | "keys.create" | "batch-jobs.view" | "batch-jobs.cancel" | "translations.batch-by-tm" | "translations.batch-machine" | "content-delivery.manage" | "content-delivery.publish" | "webhooks.manage" | "tasks.view" | "tasks.edit" | "prompts.view" | "prompts.edit" | "translation-labels.manage" | "translation-labels.assign")[]; }; }; }; @@ -23878,9 +28807,9 @@ export interface operations { parameters: { query?: { /** @description Filter tasks by state */ - filterState?: ("NEW" | "IN_PROGRESS" | "DONE" | "CLOSED")[]; + filterState?: ("NEW" | "IN_PROGRESS" | "FINISHED" | "CANCELED")[]; /** @description Filter tasks without state */ - filterNotState?: ("NEW" | "IN_PROGRESS" | "DONE" | "CLOSED")[]; + filterNotState?: ("NEW" | "IN_PROGRESS" | "FINISHED" | "CANCELED")[]; /** @description Filter tasks by assignee */ filterAssignee?: number[]; /** @description Filter tasks by type */ @@ -23899,8 +28828,6 @@ export interface operations { filterKey?: number[]; /** @description Filter tasks by agency */ filterAgency?: number[]; - /** @description Exclude "done" tasks which are older than specified timestamp */ - filterDoneMinClosedAt?: number; /** @description Exclude tasks which were closed before specified timestamp */ filterNotClosedBefore?: number; /** @description Zero-based page index (0..N) */ @@ -24143,6 +29070,69 @@ export interface operations { }; }; }; + getManagedBy: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["PrivateOrganizationModel"]; + }; + }; + /** @description No SSO configuration available for this user */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Bad Request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + }; + }; regenerateRecoveryCodes: { parameters: { query?: never; @@ -24493,4 +29483,67 @@ export interface operations { }; }; }; + getSso: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["PublicSsoTenantModel"]; + }; + }; + /** @description No SSO configuration available for this user */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Bad Request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorResponseTyped"] | components["schemas"]["ErrorResponseBody"]; + }; + }; + }; + }; } diff --git a/src/options.ts b/src/options.ts index cf72be4..d1a7182 100644 --- a/src/options.ts +++ b/src/options.ts @@ -85,8 +85,10 @@ export const FORMAT_OPT = new Option( 'APPLE_STRINGS', 'APPLE_XLIFF', 'APPLE_XCSTRINGS', + 'APPLE_SDK', 'PROPERTIES_ICU', 'PROPERTIES_JAVA', + 'ANDROID_SDK', 'ANDROID_XML', 'COMPOSE_XML', 'FLUTTER_ARB', diff --git a/src/schema.d.ts b/src/schema.d.ts index c1a0724..7dfbf8c 100644 --- a/src/schema.d.ts +++ b/src/schema.d.ts @@ -25,8 +25,10 @@ export type Format = | "APPLE_STRINGS" | "APPLE_XLIFF" | "APPLE_XCSTRINGS" + | "APPLE_SDK" | "PROPERTIES_ICU" | "PROPERTIES_JAVA" + | "ANDROID_SDK" | "ANDROID_XML" | "COMPOSE_XML" | "FLUTTER_ARB" @@ -134,7 +136,7 @@ export interface Schema { */ tagNewKeys?: string[]; /** - * Remove keys which are not present in the import. + * Remove keys which are not present in the import (within imported namespaces). */ removeOtherKeys?: boolean; }; @@ -190,7 +192,7 @@ export interface Schema { */ continueOnWarning?: boolean; /** - * Delete unused keys from the Tolgee project + * Delete unused keys from the Tolgee project (within selected namespaces if specified). */ removeUnused?: boolean; /** diff --git a/src/utils/mapExportFormat.ts b/src/utils/mapExportFormat.ts index 7a3eef4..00dec0a 100644 --- a/src/utils/mapExportFormat.ts +++ b/src/utils/mapExportFormat.ts @@ -8,8 +8,12 @@ type FormatResult = { export const mapExportFormat = (format: Schema['format']): FormatResult => { switch (format) { + case 'ANDROID_SDK': + return { format: 'ANDROID_SDK', messageFormat: 'JAVA_STRING_FORMAT' }; case 'ANDROID_XML': return { format: 'ANDROID_XML', messageFormat: 'JAVA_STRING_FORMAT' }; + case 'APPLE_SDK': + return { format: 'APPLE_SDK', messageFormat: 'APPLE_SPRINTF' }; case 'APPLE_STRINGS': return { format: 'APPLE_STRINGS_STRINGSDICT', diff --git a/src/utils/mapImportFormat.ts b/src/utils/mapImportFormat.ts index 2edf7b5..2df4fd6 100644 --- a/src/utils/mapImportFormat.ts +++ b/src/utils/mapImportFormat.ts @@ -1,3 +1,4 @@ +import { InvalidArgumentError } from 'commander'; import { components } from '../client/internal/schema.generated.js'; import { Schema } from '../schema.js'; @@ -19,6 +20,14 @@ export const mapImportFormat = ( } case 'JSON_TOLGEE': return 'JSON_ICU'; + case 'ANDROID_SDK': + throw new InvalidArgumentError( + 'Importing files in ANDROID_SDK format is not supported.' + ); + case 'APPLE_SDK': + throw new InvalidArgumentError( + 'Importing files in APPLE_SDK format is not supported.' + ); default: return format ?? 'JSON_ICU'; }