@labeleer/api 1.0.2 → 1.0.3

package/dist/generated/types/index.d.ts

@@ -1,34 +1,174 @@
 export type ClientOptions = {
     baseUrl: `${string}://${string}` | (string & {});
 };
+export type Booleanish = boolean;
+export type Collaborator = {
+    id: string;
+    name: string;
+    email: string;
+    /**
+     * Thumbnail URL of the user
+     */
+    thumbnail_url?: string;
+    role: Role;
+};
+export type Comment = {
+    id: string;
+    key_id: string;
+    project_id: string;
+    created_on: Timestamp;
+    edited_on?: Timestamp;
+    user: {
+        id: string;
+        name: string;
+        email: string;
+        thumbnail_url?: string;
+    };
+    content: string;
+};
+export type CreateAccessTokenRequestBody = {
+    permissions: ProjectPermissions;
+};
+export type CreateAccessTokenResponse = {
+    key: string;
+    details: ProjectApiKeyDetails;
+};
+export type CreateCommentRequestBody = {
+    projectId: string;
+    keyId: string;
+    comment: string;
+    commentId: string;
+};
+export type CreateLocaleRequestBody = {
+    projectId: string;
+    locale: Locale;
+};
+export type CreateLocaleResponse = {
+    data: Array<LanguageItem>;
+};
+export type CreateProjectRequestBody = {
+    name: string;
+    description?: string;
+    locales?: Array<Locale>;
+};
+export type CreateProjectResponse = {
+    data: Project;
+};
+export type DeleteCommentRequestQuery = {
+    commentId: string;
+    projectId: string;
+};
+export type DeleteLocaleRequestBody = {
+    projectId: string;
+    locale: Locale;
+};
+export type DeleteTranslationRequestQuery = {
+    projectId: string;
+    keyId: string;
+};
+export type DeleteTranslationsRequestBody = {
+    projectId: string;
+    keys: Array<string>;
+};
 export type ErrorResponse = {
     error: string;
     details?: string;
 };
-export type SuccessResponse = {
-    success: boolean;
+export type ExtendedTranslationItem = {
+    key: string;
+    key_id: string;
+    translations: {
+        [key in Locale]?: string;
+    };
+    plurals: {
+        [key in Locale]?: {
+            [key in Plurality]?: string;
+        };
+    };
+    comment_count: number;
+    description?: string | null;
+    tags: TranslationTags;
+    created_at: Timestamp;
+    updated_at?: Timestamp;
+    created_by?: {
+        id: string;
+        name: string;
+        email: string;
+        thumbnail?: string;
+    };
 };
-export declare const enum PermissionCategory {
-    TRANSLATIONS = "translations",
-    LANGUAGES = "languages",
-    COLLABORATORS = "collaborators",
-    PROJECT = "project"
-}
-export declare const enum PermissionRole {
-    VIEWER = "viewer",
-    EDITOR = "editor"
-}
-export type ProjectPermissions = {
-    [key in PermissionCategory]?: PermissionRole;
+export type GenerateTranslationsRequestQuery = {
+    project_id: string;
+    key: string;
+    from_locale: Locale;
+    to_locale: Locale;
+};
+export type GetCommentsRequestQuery = {
+    projectId: string;
+    keyId: string;
+};
+export type GetCommentsResponse = {
+    data: Array<Comment>;
+};
+export type GetInvitationsResponse = {
+    data: Array<Invitation>;
+};
+export type GetLocaleResponse = {
+    data: Array<LanguageItem>;
+};
+export type GetLocalesRequestQuery = {
+    projectId: string;
+};
+export type GetProjectsResponse = {
+    data: Array<Project>;
+};
+export type GetTranslationDataResponse = {
+    data: ExtendedTranslationItem;
+};
+export type GetTranslationRequestQuery = {
+    projectId: string;
+    keyId: string;
+};
+export type GetTranslationsResponse = {
+    data: Array<TranslationItem>;
+    pagination: Pagination;
+};
+export type GetTranslationTagsRequestQuery = {
+    projectId: string;
+    keyId: string;
+};
+export type GetTranslationTagsResponse = {
+    data: TranslationTags;
+};
+export type GetUserPermissionsResponse = {
+    data: ProjectPermissions;
+};
+export type Invitation = {
+    id: string;
+    role: Role;
+    invited_on: Timestamp;
+    project: InvitationProject;
+    invited_by: InvitedBy;
+};
+export type InvitationProject = {
+    id: string;
+    name: string;
+    description?: string;
+};
+export type InvitedBy = {
+    user_id: string;
+    name: string;
+    thumbnail_url?: string;
+    email: string;
+};
+export type InviteUserRequestBody = {
+    email: string;
+};
+export type LanguageItem = {
+    id: string;
+    locale: Locale;
+    is_reference: boolean;
 };
-export declare const enum Role {
-    OWNER = "owner",
-    COLLABORATOR = "collaborator"
-}
-export declare const enum ProjectFeature {
-    AUTO_TRANSLATE = "auto-translate",
-    SUGGESTIONS = "suggestions"
-}
 export declare const enum Locale {
     AF_ZA = "af_ZA",
     AM_ET = "am_ET",
@@ -177,7 +317,34 @@ export declare const enum Locale {
     YI_DE = "yi_DE",
     TR_TR = "tr_TR"
 }
-export type Timestamp = string;
+export type Pagination = {
+    /**
+     * Page offset
+     */
+    offset: number;
+    /**
+     * Amount of entries contained within this page
+     */
+    count: number;
+    /**
+     * Total amount of items in all pages
+     */
+    total_count: number;
+    /**
+     * Whether this is the last page in pagination
+     */
+    has_next: boolean;
+};
+export declare const enum PermissionCategory {
+    TRANSLATIONS = "translations",
+    LANGUAGES = "languages",
+    COLLABORATORS = "collaborators",
+    PROJECT = "project"
+}
+export declare const enum PermissionRole {
+    VIEWER = "viewer",
+    EDITOR = "editor"
+}
 export declare const enum Plurality {
     ZERO = "zero",
     ONE = "one",
@@ -186,24 +353,6 @@ export declare const enum Plurality {
     MANY = "many",
     OTHER = "other"
 }
-export type Pagination = {
-    offset: number;
-    count: number;
-    totalCount: number;
-};
-export type User = {
-    id: string;
-    name: string;
-    email: string;
-    thumbnail_url?: string;
-};
-export type Collaborator = {
-    id: string;
-    name: string;
-    email: string;
-    thumbnail_url?: string;
-    role: Role;
-};
 export type Project = {
     id: string;
     description?: string;
@@ -215,28 +364,36 @@ export type Project = {
     created_by: Collaborator;
     users: Array<Collaborator>;
 };
-export type InvitationProject = {
+export type ProjectApiKeyDetails = {
     id: string;
-    name: string;
-    description?: string;
+    name?: string;
+    start: string;
+    enabled: boolean;
+    permissions: ProjectPermissions;
+    created_on: Timestamp;
+    last_request?: Timestamp;
+    request_count: number;
+    expires_on?: Timestamp;
 };
-export type InvitedBy = {
-    user_id: string;
-    name: string;
-    thumbnail_url?: string;
-    email: string;
+export declare const enum ProjectFeature {
+    AUTO_TRANSLATE = "auto-translate",
+    SUGGESTIONS = "suggestions"
+}
+export type ProjectPermissions = {
+    [key in PermissionCategory]?: PermissionRole;
 };
-export type Invitation = {
-    id: string;
-    role: Role;
-    invited_on: Timestamp;
-    project: InvitationProject;
-    invited_by: InvitedBy;
+export declare const enum Role {
+    OWNER = "owner",
+    COLLABORATOR = "collaborator"
+}
+export type SuccessResponse = {
+    success: boolean;
 };
-export type TranslationTags = Array<string>;
-export type TranslationItem = {
+export type Timestamp = string;
+export type TranslationExportItem = {
     key: string;
-    key_id: string;
+    tags: TranslationTags;
+    description?: string;
     translations: {
         [key in Locale]?: string;
     };
@@ -245,11 +402,8 @@ export type TranslationItem = {
             [key in Plurality]?: string;
         };
     };
-    comment_count: number;
-    description?: string;
-    tags: TranslationTags;
 };
-export type ExtendedTranslationItem = {
+export type TranslationItem = {
     key: string;
     key_id: string;
     translations: {
@@ -261,114 +415,8 @@ export type ExtendedTranslationItem = {
         };
     };
     comment_count: number;
-    description?: string;
+    description?: string | null;
     tags: TranslationTags;
-    created_at: Timestamp;
-    updated_at?: Timestamp;
-    created_by?: {
-        id: string;
-        name: string;
-        email: string;
-        thumbnail?: string;
-    };
-};
-export type TranslationExportItem = {
-    key: string;
-    tags: TranslationTags;
-    description?: string;
-    translations: {
-        [key in Locale]?: string;
-    };
-    plurals: {
-        [key in Locale]?: {
-            [key in Plurality]?: string;
-        };
-    };
-};
-export type LanguageItem = {
-    id: string;
-    locale: Locale;
-    is_reference: boolean;
-};
-export type Comment = {
-    id: string;
-    key_id: string;
-    project_id: string;
-    created_on: Timestamp;
-    edited_on?: Timestamp;
-    user: {
-        id: string;
-        name: string;
-        email: string;
-        thumbnail_url?: string;
-    };
-    content: string;
-};
-export type ProjectApiKeyDetails = {
-    id: string;
-    name?: string;
-    start: string;
-    enabled: boolean;
-    permissions: ProjectPermissions;
-    created_on: Timestamp;
-    last_request?: Timestamp;
-    request_count: number;
-    expires_on?: Timestamp;
-};
-export type Booleanish = boolean;
-export type GetInvitationsResponse = {
-    data: Array<Invitation>;
-};
-export type CreateAccessTokenResponse = {
-    key: string;
-    details: ProjectApiKeyDetails;
-};
-export type UpdateAccessTokenResponse = {
-    details: ProjectApiKeyDetails;
-};
-export type UpdateProjectResponse = {
-    name: string;
-    description?: string;
-};
-export type GetUserPermissionsResponse = {
-    data: ProjectPermissions;
-};
-export type UpdateUserPermissionsRequestBody = {
-    permissions: {
-        translations?: 'viewer' | 'editor';
-        languages?: 'viewer' | 'editor';
-        collaborators?: 'viewer' | 'editor';
-        project?: 'viewer' | 'editor';
-    };
-};
-export type CreateProjectRequest = {
-    name: string;
-    description?: string;
-    locales?: Array<Locale>;
-};
-export type CreateProjectResponse = {
-    data: Project;
-};
-export type GetProjectsResponse = {
-    data: Array<Project>;
-};
-export type GetTranslationDataResponse = {
-    data: ExtendedTranslationItem;
-};
-export type GetTranslationTagsRequest = {
-    projectId: string;
-    keyId: string;
-};
-export type GetTranslationTagsResponse = {
-    data: TranslationTags;
-};
-export type UpdateTranslationTagsRequestBody = {
-    projectId: string;
-    keyId: string;
-    tags: Array<string>;
-};
-export type UpdateTranslationTagsResponse = {
-    data: TranslationTags;
 };
 export type TranslationsExportRequestQuery = {
     projectId: string;
@@ -378,23 +426,29 @@ export type TranslationsExportRequestQuery = {
     include_untranslated?: Booleanish;
     include_description?: Booleanish;
 };
-export type GetLocaleResponse = {
-    data: Array<LanguageItem>;
+export type TranslationTags = Array<string>;
+export type UpdateAccessTokenPermissionsRequestBody = {
+    permissions: ProjectPermissions;
 };
-export type CreateLocaleRequestBody = {
-    projectId: string;
-    locale: Locale;
+export type UpdateAccessTokenPermissionsResponse = {
+    details: ProjectApiKeyDetails;
 };
-export type CreateLocaleResponse = {
-    data: Array<LanguageItem>;
+export type UpdateInvitationStatusRequestBody = {
+    invitationId: string;
+    status: 'accepted' | 'declined';
+};
+export type UpdateProjectResponse = {
+    name: string;
+    description?: string;
 };
 export type UpdateReferenceLocaleRequestBody = {
     projectId: string;
     locale: Locale;
 };
-export type GetTranslationsResponse = {
-    data: Array<TranslationItem>;
-    pagination: Pagination;
+export type UpdateTranslationRequestBody = {
+    projectId: string;
+    keyId: string;
+    newKeyName: string;
 };
 export type UpdateTranslationsRequestBody = {
     projectId: string;
@@ -413,9 +467,25 @@ export type UpdateTranslationsRequestBody = {
         };
     };
 };
-export type DeleteTranslationsRequestBody = {
+export type UpdateTranslationTagsRequestBody = {
     projectId: string;
-    keys: Array<string>;
+    keyId: string;
+    tags: Array<string>;
+};
+export type UpdateTranslationTagsResponse = {
+    data: TranslationTags;
+};
+export type UpdateUserPermissionsRequestBody = {
+    permissions: ProjectPermissions;
+};
+export type User = {
+    id: string;
+    name: string;
+    email: string;
+    /**
+     * Thumbnail URL of the user
+     */
+    thumbnail_url?: string;
 };
 export type GetInvitationsData = {
     body?: never;
@@ -442,10 +512,7 @@ export type GetInvitationsResponses = {
 };
 export type GetInvitationsResponse2 = GetInvitationsResponses[keyof GetInvitationsResponses];
 export type RespondToInvitationData = {
-    body: {
-        invitationId: string;
-        status: 'accepted' | 'declined';
-    };
+    body: UpdateInvitationStatusRequestBody;
     path?: never;
     query?: never;
     url: '/api/invitations';
@@ -511,14 +578,7 @@ export type RevokeAccessTokenResponses = {
 };
 export type RevokeAccessTokenResponse = RevokeAccessTokenResponses[keyof RevokeAccessTokenResponses];
 export type UpdateAccessTokenData = {
-    body: {
-        permissions: {
-            translations?: 'viewer' | 'editor';
-            languages?: 'viewer' | 'editor';
-            collaborators?: 'viewer' | 'editor';
-            project?: 'viewer' | 'editor';
-        };
-    };
+    body: UpdateAccessTokenPermissionsRequestBody;
     path: {
         projectId: string;
     };
@@ -552,18 +612,11 @@ export type UpdateAccessTokenResponses = {
     /**
      * Ok
      */
-    200: UpdateAccessTokenResponse;
+    200: UpdateAccessTokenPermissionsResponse;
 };
-export type UpdateAccessTokenResponse2 = UpdateAccessTokenResponses[keyof UpdateAccessTokenResponses];
+export type UpdateAccessTokenResponse = UpdateAccessTokenResponses[keyof UpdateAccessTokenResponses];
 export type CreateAccessTokenData = {
-    body: {
-        permissions: {
-            translations?: 'viewer' | 'editor';
-            languages?: 'viewer' | 'editor';
-            collaborators?: 'viewer' | 'editor';
-            project?: 'viewer' | 'editor';
-        };
-    };
+    body: CreateAccessTokenRequestBody;
     path: {
         projectId: string;
     };
@@ -597,9 +650,7 @@ export type CreateAccessTokenResponses = {
 };
 export type CreateAccessTokenResponse2 = CreateAccessTokenResponses[keyof CreateAccessTokenResponses];
 export type InviteUserToProjectData = {
-    body: {
-        email: string;
-    };
+    body: InviteUserRequestBody;
     path: {
         projectId: string;
     };
@@ -627,9 +678,9 @@ export type InviteUserToProjectErrors = {
 export type InviteUserToProjectError = InviteUserToProjectErrors[keyof InviteUserToProjectErrors];
 export type InviteUserToProjectResponses = {
     /**
-     * Resource Created
+     * Ok
      */
-    201: SuccessResponse;
+    200: SuccessResponse;
 };
 export type InviteUserToProjectResponse = InviteUserToProjectResponses[keyof InviteUserToProjectResponses];
 export type DeleteProjectData = {
@@ -834,7 +885,7 @@ export type GetProjectsResponses = {
 };
 export type GetProjectsResponse2 = GetProjectsResponses[keyof GetProjectsResponses];
 export type CreateProjectData = {
-    body: CreateProjectRequest;
+    body: CreateProjectRequestBody;
     path?: never;
     query?: never;
     url: '/api/project';
@@ -981,11 +1032,7 @@ export type GetTranslationResponses = {
 };
 export type GetTranslationResponse = GetTranslationResponses[keyof GetTranslationResponses];
 export type RenameTranslationKeyData = {
-    body: {
-        projectId: string;
-        keyId: string;
-        newKeyName: string;
-    };
+    body: UpdateTranslationRequestBody;
     path?: never;
     query?: never;
     url: '/api/translation';
@@ -1195,13 +1242,13 @@ export type GetLocalesResponses = {
     200: GetLocaleResponse;
 };
 export type GetLocalesResponse = GetLocalesResponses[keyof GetLocalesResponses];
-export type AddLocaleData = {
-    body: CreateLocaleRequestBody;
+export type UpdateReferenceLocaleData = {
+    body: UpdateReferenceLocaleRequestBody;
     path?: never;
     query?: never;
     url: '/api/translations/locales';
 };
-export type AddLocaleErrors = {
+export type UpdateReferenceLocaleErrors = {
     /**
      * Bad Request
      */
@@ -1219,21 +1266,21 @@ export type AddLocaleErrors = {
      */
     500: ErrorResponse;
 };
-export type AddLocaleError = AddLocaleErrors[keyof AddLocaleErrors];
-export type AddLocaleResponses = {
+export type UpdateReferenceLocaleError = UpdateReferenceLocaleErrors[keyof UpdateReferenceLocaleErrors];
+export type UpdateReferenceLocaleResponses = {
     /**
-     * Resource Created
+     * Ok
      */
-    201: CreateLocaleResponse;
+    200: SuccessResponse;
 };
-export type AddLocaleResponse = AddLocaleResponses[keyof AddLocaleResponses];
-export type UpdateReferenceLocaleData = {
-    body: UpdateReferenceLocaleRequestBody;
+export type UpdateReferenceLocaleResponse = UpdateReferenceLocaleResponses[keyof UpdateReferenceLocaleResponses];
+export type AddLocaleData = {
+    body: CreateLocaleRequestBody;
     path?: never;
     query?: never;
     url: '/api/translations/locales';
 };
-export type UpdateReferenceLocaleErrors = {
+export type AddLocaleErrors = {
     /**
      * Bad Request
      */
@@ -1251,14 +1298,14 @@ export type UpdateReferenceLocaleErrors = {
      */
     500: ErrorResponse;
 };
-export type UpdateReferenceLocaleError = UpdateReferenceLocaleErrors[keyof UpdateReferenceLocaleErrors];
-export type UpdateReferenceLocaleResponses = {
+export type AddLocaleError = AddLocaleErrors[keyof AddLocaleErrors];
+export type AddLocaleResponses = {
     /**
-     * Ok
+     * Resource Created
      */
-    200: SuccessResponse;
+    201: CreateLocaleResponse;
 };
-export type UpdateReferenceLocaleResponse = UpdateReferenceLocaleResponses[keyof UpdateReferenceLocaleResponses];
+export type AddLocaleResponse = AddLocaleResponses[keyof AddLocaleResponses];
 export type DeleteTranslationsData = {
     body: DeleteTranslationsRequestBody;
     path?: never;