Deploying from phrase/strings-openapi@95b6c2a2

Phrase · Phrase · commit 4df26f83f6c4 · 2025-07-23T13:27:05.000Z
diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES
@@ -20,6 +20,7 @@ src/apis/GlossaryTermTranslationsApi.ts
 src/apis/GlossaryTermsApi.ts
 src/apis/ICUApi.ts
 src/apis/InvitationsApi.ts
+src/apis/JobAnnotationsApi.ts
 src/apis/JobCommentsApi.ts
 src/apis/JobLocalesApi.ts
 src/apis/JobTemplateLocalesApi.ts
@@ -115,6 +116,9 @@ src/models/InvitationCreateParameters.ts
 src/models/InvitationUpdateParameters.ts
 src/models/InvitationUpdateSettingsParameters.ts
 src/models/Job.ts
+src/models/JobAnnotation.ts
+src/models/JobAnnotationShort.ts
+src/models/JobAnnotationUpdateParameters.ts
 src/models/JobComment.ts
 src/models/JobCommentCreateParameters.ts
 src/models/JobCommentUpdateParameters.ts
diff --git a/README.md b/README.md
@@ -274,6 +274,12 @@ Class | Method | HTTP request | Description
 *InvitationsApi* | **invitationUpdate** | **PATCH** /accounts/{account_id}/invitations/{id} | Update an invitation
 *InvitationsApi* | **invitationUpdateSettings** | **PATCH** /projects/{project_id}/invitations/{id} | Update a member\&#39;s invitation access
 *InvitationsApi* | **invitationsList** | **GET** /accounts/{account_id}/invitations | List invitations
+*JobAnnotationsApi* | **jobAnnotationDelete** | **DELETE** /projects/{project_id}/jobs/{job_id}/annotations/{id} | Delete a job annotation
+*JobAnnotationsApi* | **jobAnnotationUpdate** | **PATCH** /projects/{project_id}/jobs/{job_id}/annotations/{id} | Create/Update a job annotation
+*JobAnnotationsApi* | **jobAnnotationsList** | **GET** /projects/{project_id}/jobs/{job_id}/annotations | List job annotations
+*JobAnnotationsApi* | **jobLocaleAnnotationDelete** | **DELETE** /projects/{project_id}/jobs/{job_id}/locales/{job_locale_id}/annotations/{id} | Delete a job locale annotation
+*JobAnnotationsApi* | **jobLocaleAnnotationUpdate** | **PATCH** /projects/{project_id}/jobs/{job_id}/locales/{job_locale_id}/annotations/{id} | Create/Update a job locale annotation
+*JobAnnotationsApi* | **jobLocaleAnnotationsList** | **GET** /projects/{project_id}/jobs/{job_id}/locales/{job_locale_id}/annotations | List job locale annotations
 *JobCommentsApi* | **jobCommentCreate** | **POST** /projects/{project_id}/jobs/{job_id}/comments | Create a job comment
 *JobCommentsApi* | **jobCommentDelete** | **DELETE** /projects/{project_id}/jobs/{job_id}/comments/{id} | Delete a job comment
 *JobCommentsApi* | **jobCommentShow** | **GET** /projects/{project_id}/jobs/{job_id}/comments/{id} | Get a single job comment
diff --git a/src/apis/JobAnnotationsApi.ts b/src/apis/JobAnnotationsApi.ts
diff --git a/src/apis/JobLocalesApi.ts b/src/apis/JobLocalesApi.ts
@@ -72,6 +72,7 @@ export interface JobLocaleShowRequest {
     id: string;
     xPhraseAppOTP?: string;
     branch?: string;
+    includeAnnotations?: boolean;
 }
 
 export interface JobLocaleUpdateRequest {
@@ -96,6 +97,7 @@ export interface JobLocalesListRequest {
     page?: number;
     perPage?: number;
     branch?: string;
+    includeAnnotations?: boolean;
 }
 
 /**
@@ -355,6 +357,10 @@ export class JobLocalesApi extends runtime.BaseAPI {
             queryParameters['branch'] = requestParameters.branch;
         }
 
+        if (requestParameters.includeAnnotations !== undefined) {
+            queryParameters['include_annotations'] = requestParameters.includeAnnotations;
+        }
+
         const headerParameters: runtime.HTTPHeaders = {};
 
         if (requestParameters.xPhraseAppOTP !== undefined && requestParameters.xPhraseAppOTP !== null) {
@@ -526,6 +532,10 @@ export class JobLocalesApi extends runtime.BaseAPI {
             queryParameters['branch'] = requestParameters.branch;
         }
 
+        if (requestParameters.includeAnnotations !== undefined) {
+            queryParameters['include_annotations'] = requestParameters.includeAnnotations;
+        }
+
         const headerParameters: runtime.HTTPHeaders = {};
 
         if (requestParameters.xPhraseAppOTP !== undefined && requestParameters.xPhraseAppOTP !== null) {
diff --git a/src/apis/JobsApi.ts b/src/apis/JobsApi.ts
@@ -96,6 +96,7 @@ export interface JobShowRequest {
     id: string;
     xPhraseAppOTP?: string;
     branch?: string;
+    includeAnnotations?: boolean;
 }
 
 export interface JobStartRequest {
@@ -534,6 +535,10 @@ export class JobsApi extends runtime.BaseAPI {
             queryParameters['branch'] = requestParameters.branch;
         }
 
+        if (requestParameters.includeAnnotations !== undefined) {
+            queryParameters['include_annotations'] = requestParameters.includeAnnotations;
+        }
+
         const headerParameters: runtime.HTTPHeaders = {};
 
         if (requestParameters.xPhraseAppOTP !== undefined && requestParameters.xPhraseAppOTP !== null) {
diff --git a/src/apis/index.ts b/src/apis/index.ts
@@ -15,6 +15,7 @@ export * from './GlossaryTermTranslationsApi';
 export * from './GlossaryTermsApi';
 export * from './ICUApi';
 export * from './InvitationsApi';
+export * from './JobAnnotationsApi';
 export * from './JobCommentsApi';
 export * from './JobLocalesApi';
 export * from './JobTemplateLocalesApi';
diff --git a/src/models/JobAnnotation.ts b/src/models/JobAnnotation.ts
@@ -0,0 +1,80 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Phrase Strings API Reference
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@phrase.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists, mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface JobAnnotation
+ */
+export interface JobAnnotation {
+    /**
+     * 
+     * @type {string}
+     * @memberof JobAnnotation
+     */
+    name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof JobAnnotation
+     */
+    value: string;
+    /**
+     * 
+     * @type {Date}
+     * @memberof JobAnnotation
+     */
+    createdAt?: Date;
+    /**
+     * 
+     * @type {Date}
+     * @memberof JobAnnotation
+     */
+    updatedAt?: Date;
+}
+
+export function JobAnnotationFromJSON(json: any): JobAnnotation {
+    return JobAnnotationFromJSONTyped(json, false);
+}
+
+export function JobAnnotationFromJSONTyped(json: any, ignoreDiscriminator: boolean): JobAnnotation {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'value': json['value'],
+        'createdAt': !exists(json, 'created_at') ? undefined : (new Date(json['created_at'])),
+        'updatedAt': !exists(json, 'updated_at') ? undefined : (new Date(json['updated_at'])),
+    };
+}
+
+export function JobAnnotationToJSON(value?: JobAnnotation | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'name': value.name,
+        'value': value.value,
+        'created_at': value.createdAt === undefined ? undefined : (value.createdAt.toISOString()),
+        'updated_at': value.updatedAt === undefined ? undefined : (value.updatedAt.toISOString()),
+    };
+}
+
+
diff --git a/src/models/JobAnnotationShort.ts b/src/models/JobAnnotationShort.ts
@@ -0,0 +1,64 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Phrase Strings API Reference
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@phrase.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists, mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface JobAnnotationShort
+ */
+export interface JobAnnotationShort {
+    /**
+     * 
+     * @type {string}
+     * @memberof JobAnnotationShort
+     */
+    name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof JobAnnotationShort
+     */
+    value: string;
+}
+
+export function JobAnnotationShortFromJSON(json: any): JobAnnotationShort {
+    return JobAnnotationShortFromJSONTyped(json, false);
+}
+
+export function JobAnnotationShortFromJSONTyped(json: any, ignoreDiscriminator: boolean): JobAnnotationShort {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'value': json['value'],
+    };
+}
+
+export function JobAnnotationShortToJSON(value?: JobAnnotationShort | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'name': value.name,
+        'value': value.value,
+    };
+}
+
+
diff --git a/src/models/JobAnnotationUpdateParameters.ts b/src/models/JobAnnotationUpdateParameters.ts
@@ -0,0 +1,64 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Phrase Strings API Reference
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@phrase.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists, mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface JobAnnotationUpdateParameters
+ */
+export interface JobAnnotationUpdateParameters {
+    /**
+     * Annotation value
+     * @type {string}
+     * @memberof JobAnnotationUpdateParameters
+     */
+    value?: string;
+    /**
+     * Branch name of the job
+     * @type {string}
+     * @memberof JobAnnotationUpdateParameters
+     */
+    branch?: string;
+}
+
+export function JobAnnotationUpdateParametersFromJSON(json: any): JobAnnotationUpdateParameters {
+    return JobAnnotationUpdateParametersFromJSONTyped(json, false);
+}
+
+export function JobAnnotationUpdateParametersFromJSONTyped(json: any, ignoreDiscriminator: boolean): JobAnnotationUpdateParameters {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'value': !exists(json, 'value') ? undefined : json['value'],
+        'branch': !exists(json, 'branch') ? undefined : json['branch'],
+    };
+}
+
+export function JobAnnotationUpdateParametersToJSON(value?: JobAnnotationUpdateParameters | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'value': value.value,
+        'branch': value.branch,
+    };
+}
+
+
diff --git a/src/models/JobDetails.ts b/src/models/JobDetails.ts
@@ -17,6 +17,10 @@ import {
     BranchNameFromJSON,
     BranchNameFromJSONTyped,
     BranchNameToJSON,
+    JobAnnotationShort,
+    JobAnnotationShortFromJSON,
+    JobAnnotationShortFromJSONTyped,
+    JobAnnotationShortToJSON,
     KeyPreview,
     KeyPreviewFromJSON,
     KeyPreviewFromJSONTyped,
@@ -137,6 +141,12 @@ export interface JobDetails {
      * @memberof JobDetails
      */
     keys?: Array<KeyPreview>;
+    /**
+     * 
+     * @type {Array<JobAnnotationShort>}
+     * @memberof JobDetails
+     */
+    annotations?: Array<JobAnnotationShort>;
 }
 
 export function JobDetailsFromJSON(json: any): JobDetails {
@@ -165,6 +175,7 @@ export function JobDetailsFromJSONTyped(json: any, ignoreDiscriminator: boolean)
         'sourceLocale': !exists(json, 'source_locale') ? undefined : LocalePreviewFromJSON(json['source_locale']),
         'locales': !exists(json, 'locales') ? undefined : ((json['locales'] as Array<any>).map(LocalePreviewFromJSON)),
         'keys': !exists(json, 'keys') ? undefined : ((json['keys'] as Array<any>).map(KeyPreviewFromJSON)),
+        'annotations': !exists(json, 'annotations') ? undefined : ((json['annotations'] as Array<any>).map(JobAnnotationShortFromJSON)),
     };
 }
 
@@ -193,6 +204,7 @@ export function JobDetailsToJSON(value?: JobDetails | null): any {
         'source_locale': LocalePreviewToJSON(value.sourceLocale),
         'locales': value.locales === undefined ? undefined : ((value.locales as Array<any>).map(LocalePreviewToJSON)),
         'keys': value.keys === undefined ? undefined : ((value.keys as Array<any>).map(KeyPreviewToJSON)),
+        'annotations': value.annotations === undefined ? undefined : ((value.annotations as Array<any>).map(JobAnnotationShortToJSON)),
     };
 }
 
diff --git a/src/models/JobLocale.ts b/src/models/JobLocale.ts
@@ -13,6 +13,10 @@
 
 import { exists, mapValues } from '../runtime';
 import {
+    JobAnnotationShort,
+    JobAnnotationShortFromJSON,
+    JobAnnotationShortFromJSONTyped,
+    JobAnnotationShortToJSON,
     JobPreview,
     JobPreviewFromJSON,
     JobPreviewFromJSONTyped,
@@ -85,6 +89,12 @@ export interface JobLocale {
      * @memberof JobLocale
      */
     reviewCompletedAt?: Date;
+    /**
+     * 
+     * @type {Array<JobAnnotationShort>}
+     * @memberof JobLocale
+     */
+    annotations?: Array<JobAnnotationShort>;
 }
 
 export function JobLocaleFromJSON(json: any): JobLocale {
@@ -105,6 +115,7 @@ export function JobLocaleFromJSONTyped(json: any, ignoreDiscriminator: boolean):
         'completed': !exists(json, 'completed') ? undefined : json['completed'],
         'translationCompletedAt': !exists(json, 'translation_completed_at') ? undefined : (new Date(json['translation_completed_at'])),
         'reviewCompletedAt': !exists(json, 'review_completed_at') ? undefined : (new Date(json['review_completed_at'])),
+        'annotations': !exists(json, 'annotations') ? undefined : ((json['annotations'] as Array<any>).map(JobAnnotationShortFromJSON)),
     };
 }
 
@@ -125,6 +136,7 @@ export function JobLocaleToJSON(value?: JobLocale | null): any {
         'completed': value.completed,
         'translation_completed_at': value.translationCompletedAt === undefined ? undefined : (value.translationCompletedAt.toISOString()),
         'review_completed_at': value.reviewCompletedAt === undefined ? undefined : (value.reviewCompletedAt.toISOString()),
+        'annotations': value.annotations === undefined ? undefined : ((value.annotations as Array<any>).map(JobAnnotationShortToJSON)),
     };
 }
 
diff --git a/src/models/index.ts b/src/models/index.ts
@@ -54,6 +54,9 @@ export * from './InvitationCreateParameters';
 export * from './InvitationUpdateParameters';
 export * from './InvitationUpdateSettingsParameters';
 export * from './Job';
+export * from './JobAnnotation';
+export * from './JobAnnotationShort';
+export * from './JobAnnotationUpdateParameters';
 export * from './JobComment';
 export * from './JobCommentCreateParameters';
 export * from './JobCommentUpdateParameters';
