phrase 4.5.0 → 4.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04bf3ebdd9d603c87adf2947d530e382f37097aee543be5b2cb4dccd7db69534
-  data.tar.gz: 2dc353e4330710c12f66deab8bd9faf89561c5d3412ba5dd2fdd4d110691906d
+  metadata.gz: 47e153737c6cf0b7338cc8a2cc7593587af87e186f64523e04d9cb610bf6dd4b
+  data.tar.gz: 26707ecb1cf18465c05a7d755549c84b3b0186d80f6e6ba92518cbdf6b01d3c0
 SHA512:
-  metadata.gz: 72b9f71936dc753d69b3dd654bbd780f81dee8d51dcf726c50b9759b08fc8bc6d41fb70b0c7a5931e94506cc304baa456cf405d39af80d4e29dccfb519637149
-  data.tar.gz: 6355285399a4b1257e7961bb3b3efdb4a5b184314855b89039ad3d49b855ff53a5b3dfe69d2011a9d8ec9d4dee1b59ac1e60191a98085eddb8376a7670445101
+  metadata.gz: e73894d2b783cbdfe8d3bc7dd5147c093d0d4fe8eb6d272c8adcac4403fe199be804172857e5ad79b3456e73d2c54af7e25b92e09a697bc9645fb0fe700b2152
+  data.tar.gz: d7bee789a42ceefbaba8b89acb0bc3ca06761b7b7f1ce92eb503e4b3b1f9f9a6cd475afa1c42620f40d5fc3548fab18d5d139d08508d5599bcfcacc196411106

data/CHANGELOG.md

@@ -1,5 +1,28 @@
 # Changelog
 
+## [4.8.0](https://github.com/phrase/openapi/compare/ruby-v4.7.0...ruby-v4.8.0) (2025-07-23)
+
+
+### Features
+
+* **API:** Job and job locale annotations #SCD-145 ([#867](https://github.com/phrase/openapi/issues/867)) ([95b6c2a](https://github.com/phrase/openapi/commit/95b6c2a2ab798d01f9bc0d53a22dbf817a5eb0ee))
+
+## [4.7.0](https://github.com/phrase/openapi/compare/ruby-v4.6.0...ruby-v4.7.0) (2025-07-18)
+
+
+### Features
+
+* **API:** add updated_since param for downloads ([#858](https://github.com/phrase/openapi/issues/858)) ([db4196b](https://github.com/phrase/openapi/commit/db4196bfb1a45f628577bebb99aad7da1179c241))
+* **API:** Add use_ordinal_rules attribute to request body for create/update Keys endpoints ([#868](https://github.com/phrase/openapi/issues/868)) ([29410b5](https://github.com/phrase/openapi/commit/29410b5d4edee9645f449d2d7de53fb953c1f0c2))
+* **API:** Add use_ordinal_rules boolean [STRINGS-2273] ([#846](https://github.com/phrase/openapi/issues/846)) ([450ce0c](https://github.com/phrase/openapi/commit/450ce0cce6bb2064758c44b130b39dd5539c2681))
+
+## [4.6.0](https://github.com/phrase/openapi/compare/ruby-v4.5.0...ruby-v4.6.0) (2025-05-23)
+
+
+### Features
+
+* **API:** Add omit_statistics param to tags#show ([#834](https://github.com/phrase/openapi/issues/834)) ([2058b18](https://github.com/phrase/openapi/commit/2058b18297133075885ac99770aee2e171811cd6))
+
 ## [4.5.0](https://github.com/phrase/openapi/compare/ruby-v4.4.0...ruby-v4.5.0) (2025-05-16)
 
 

data/README.md

@@ -7,7 +7,7 @@ Phrase Strings is a translation management platform for software projects. You c
 ## This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 2.0.0
-- Package version: 4.5.0
+- Package version: 4.8.0
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 For more information, please visit [https://developers.phrase.com/api/](https://developers.phrase.com/api/)
 
@@ -56,10 +56,10 @@ gem build phrase.gemspec
 Then install the gem locally:
 
 ```shell
-gem install ./phrase-4.5.0.gem
+gem install ./phrase-4.8.0.gem
 ```
 
-(for development, run `gem install --dev ./phrase-4.5.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./phrase-4.8.0.gem` to install the development dependencies)
 
 ## Getting Started
 
@@ -206,6 +206,12 @@ Class | Method | HTTP request | Description
 *Phrase::InvitationsApi* | [**invitation_update**](docs/InvitationsApi.md#invitation_update) | **PATCH** /accounts/{account_id}/invitations/{id} | Update an invitation
 *Phrase::InvitationsApi* | [**invitation_update_settings**](docs/InvitationsApi.md#invitation_update_settings) | **PATCH** /projects/{project_id}/invitations/{id} | Update a member's invitation access
 *Phrase::InvitationsApi* | [**invitations_list**](docs/InvitationsApi.md#invitations_list) | **GET** /accounts/{account_id}/invitations | List invitations
+*Phrase::JobAnnotationsApi* | [**job_annotation_delete**](docs/JobAnnotationsApi.md#job_annotation_delete) | **DELETE** /projects/{project_id}/jobs/{job_id}/annotations/{id} | Delete a job annotation
+*Phrase::JobAnnotationsApi* | [**job_annotation_update**](docs/JobAnnotationsApi.md#job_annotation_update) | **PATCH** /projects/{project_id}/jobs/{job_id}/annotations/{id} | Create/Update a job annotation
+*Phrase::JobAnnotationsApi* | [**job_annotations_list**](docs/JobAnnotationsApi.md#job_annotations_list) | **GET** /projects/{project_id}/jobs/{job_id}/annotations | List job annotations
+*Phrase::JobAnnotationsApi* | [**job_locale_annotation_delete**](docs/JobAnnotationsApi.md#job_locale_annotation_delete) | **DELETE** /projects/{project_id}/jobs/{job_id}/locales/{job_locale_id}/annotations/{id} | Delete a job locale annotation
+*Phrase::JobAnnotationsApi* | [**job_locale_annotation_update**](docs/JobAnnotationsApi.md#job_locale_annotation_update) | **PATCH** /projects/{project_id}/jobs/{job_id}/locales/{job_locale_id}/annotations/{id} | Create/Update a job locale annotation
+*Phrase::JobAnnotationsApi* | [**job_locale_annotations_list**](docs/JobAnnotationsApi.md#job_locale_annotations_list) | **GET** /projects/{project_id}/jobs/{job_id}/locales/{job_locale_id}/annotations | List job locale annotations
 *Phrase::JobCommentsApi* | [**job_comment_create**](docs/JobCommentsApi.md#job_comment_create) | **POST** /projects/{project_id}/jobs/{job_id}/comments | Create a job comment
 *Phrase::JobCommentsApi* | [**job_comment_delete**](docs/JobCommentsApi.md#job_comment_delete) | **DELETE** /projects/{project_id}/jobs/{job_id}/comments/{id} | Delete a job comment
 *Phrase::JobCommentsApi* | [**job_comment_show**](docs/JobCommentsApi.md#job_comment_show) | **GET** /projects/{project_id}/jobs/{job_id}/comments/{id} | Get a single job comment
@@ -460,6 +466,9 @@ Class | Method | HTTP request | Description
  - [Phrase::InvitationUpdateParameters](docs/InvitationUpdateParameters.md)
  - [Phrase::InvitationUpdateSettingsParameters](docs/InvitationUpdateSettingsParameters.md)
  - [Phrase::Job](docs/Job.md)
+ - [Phrase::JobAnnotation](docs/JobAnnotation.md)
+ - [Phrase::JobAnnotationShort](docs/JobAnnotationShort.md)
+ - [Phrase::JobAnnotationUpdateParameters](docs/JobAnnotationUpdateParameters.md)
  - [Phrase::JobComment](docs/JobComment.md)
  - [Phrase::JobCommentCreateParameters](docs/JobCommentCreateParameters.md)
  - [Phrase::JobCommentUpdateParameters](docs/JobCommentUpdateParameters.md)

data/docs/BranchesApi.md

@@ -20,7 +20,7 @@ Method | HTTP request | Description
 
 Compare branches
 
-Compare branch with main branch. <br><br><i>Note: Comparing a branch may take several minutes depending on the project size.</i>
+Compare branch with main branch.   *Note: Comparing a branch may take several minutes depending on the project size.* 
 
 ### Example
 
@@ -82,7 +82,7 @@ Response<(nil (empty response body))>
 
 Create a branch
 
-Create a new branch. <br><br><i>Note: Creating a new branch may take several minutes depending on the project size.</i>
+Create a new branch.  *Note: Creating a new branch may take several minutes depending on the project size.* 
 
 ### Example
 
@@ -207,7 +207,7 @@ Response<(nil (empty response body))>
 
 Merge a branch
 
-Merge an existing branch. <br><br><i>Note: Merging a branch may take several minutes depending on diff size.</i>
+Merge an existing branch.   *Note: Merging a branch may take several minutes depending on diff size.* 
 
 ### Example
 

data/docs/DistributionCreateParameters.md

@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 **project_id** | **String** | Project id the distribution should be assigned to. | 
 **platforms** | **Array<String>** | List of platforms the distribution should support. Valid values are: * `android` * `ios` * `flutter` * `i18next` * `rails` | [optional] 
 **locale_ids** | **Array<String>** | List of locale ids that will be part of distribution releases | [optional] 
-**format_options** | **Hash<String, String>** | Additional formatting and render options. Only <code>enclose_in_cdata</code> is available for platform <code>android</code>. | [optional] 
+**format_options** | **Hash<String, String>** | Additional formatting and render options. Only `enclose_in_cdata` is available for platform `android`.  | [optional] 
 **fallback_locales_enabled** | **Boolean** | Use fallback locale if there is no translation in the current locale. | [optional] 
 **fallback_to_non_regional_locale** | **Boolean** | Indicates whether to fallback to non regional locale when locale can not be found | [optional] 
 **fallback_to_default_locale** | **Boolean** | Indicates whether to fallback to projects default locale when locale can not be found | [optional] 

data/docs/DistributionUpdateParameters.md

@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 **project_id** | **String** | Project id the distribution should be assigned to. | [optional] 
 **platforms** | **Array<String>** | List of platforms the distribution should support. | [optional] 
 **locale_ids** | **Array<String>** | List of locale ids that will be part of distribution releases | [optional] 
-**format_options** | **Hash<String, String>** | Additional formatting and render options. Only <code>enclose_in_cdata</code> is available for platform <code>android</code>. | [optional] 
+**format_options** | **Hash<String, String>** | Additional formatting and render options. Only `enclose_in_cdata` is available for platform `android`.  | [optional] 
 **fallback_locales_enabled** | **Boolean** | Use fallback locale if there is no translation in the current locale. | [optional] 
 **fallback_to_non_regional_locale** | **Boolean** | Indicates whether to fallback to non regional locale when locale can not be found | [optional] 
 **fallback_to_default_locale** | **Boolean** | Indicates whether to fallback to projects default locale when locale can not be found | [optional] 

data/docs/InvitationCreateParameters.md

@@ -4,14 +4,14 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**email** | **String** | The email of the invited user. The <code>email</code> can not be updated once created. Create a new invitation for each unique email. | 
+**email** | **String** | The email of the invited user. The `email` can not be updated once created. Create a new invitation for each unique email. | 
 **role** | **String** | Invitiation role, can be any of Manager, Developer, Translator. | 
 **project_ids** | **String** | List of project ids the invited user has access to. | [optional] 
 **locale_ids** | **String** | List of locale ids the invited user has access to. | [optional] 
 **space_ids** | **Array<String>** | List of spaces the user is assigned to. | [optional] 
 **team_ids** | **Array<String>** | List of teams the user is assigned to. | [optional] 
 **default_locale_codes** | **Array<String>** | List of default locales for the user. | [optional] 
-**permissions** | **Hash<String, String>** | Additional permissions depending on invitation role. Available permissions are <code>create_upload</code> and <code>review_translations</code> | [optional] 
+**permissions** | **Hash<String, String>** | Additional permissions depending on invitation role. Available permissions are `create_upload` and `review_translations` | [optional] 
 
 ## Code Sample
 

data/docs/InvitationsApi.md

@@ -20,7 +20,7 @@ Method | HTTP request | Description
 
 Create a new invitation
 
-Invite a person to an account. Developers and translators need <code>project_ids</code> and <code>locale_ids</code> assigned to access them. Access token scope must include <code>team.manage</code>.
+Invite a person to an account. Developers and translators need `project_ids` and `locale_ids` assigned to access them. Access token scope must include `team.manage`.
 
 ### Example
 
@@ -83,7 +83,7 @@ Response<([**Invitation**](Invitation.md))>
 
 Delete an invitation
 
-Delete an existing invitation (must not be accepted yet). Access token scope must include <code>team.manage</code>.
+Delete an existing invitation (must not be accepted yet). Access token scope must include `team.manage`.
 
 ### Example
 
@@ -145,7 +145,7 @@ Response<(nil (empty response body))>
 
 Resend an invitation
 
-Resend the invitation email (must not be accepted yet). Access token scope must include <code>team.manage</code>.
+Resend the invitation email (must not be accepted yet). Access token scope must include `team.manage`.
 
 ### Example
 
@@ -208,7 +208,7 @@ Response<([**Invitation**](Invitation.md))>
 
 Get a single invitation
 
-Get details on a single invitation. Access token scope must include <code>team.manage</code>.
+Get details on a single invitation. Access token scope must include `team.manage`.
 
 ### Example
 
@@ -271,7 +271,7 @@ Response<([**Invitation**](Invitation.md))>
 
 Update an invitation
 
-Update an existing invitation (must not be accepted yet). The <code>email</code> cannot be updated. Developers and translators need <code>project_ids</code> and <code>locale_ids</code> assigned to access them. Access token scope must include <code>team.manage</code>.
+Update an existing invitation (must not be accepted yet). The `email` cannot be updated. Developers and translators need `project_ids` and `locale_ids` assigned to access them. Access token scope must include `team.manage`.
 
 ### Example
 
@@ -336,7 +336,7 @@ Response<([**Invitation**](Invitation.md))>
 
 Update a member's invitation access
 
-Update member's settings in the invitations. Access token scope must include <code>team.manage</code>.
+Update member's settings in the invitations. Access token scope must include `team.manage`.
 
 ### Example
 
@@ -401,7 +401,7 @@ Response<([**Invitation**](Invitation.md))>
 
 List invitations
 
-List invitations for an account. It will also list the accessible resources like projects and locales the invited user has access to. In case nothing is shown the default access from the role is used. Access token scope must include <code>team.manage</code>.
+List invitations for an account. It will also list the accessible resources like projects and locales the invited user has access to. In case nothing is shown the default access from the role is used. Access token scope must include `team.manage`.
 
 ### Example
 

data/docs/JobAnnotation.md

@@ -0,0 +1,23 @@
+# Phrase::JobAnnotation
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | 
+**value** | **String** |  | 
+**created_at** | **Time** |  | [optional] 
+**updated_at** | **Time** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::JobAnnotation.new(name: null,
+                                 value: null,
+                                 created_at: null,
+                                 updated_at: null)
+```
+
+

data/docs/JobAnnotationShort.md

@@ -0,0 +1,19 @@
+# Phrase::JobAnnotationShort
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | 
+**value** | **String** |  | 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::JobAnnotationShort.new(name: null,
+                                 value: null)
+```
+
+

data/docs/JobAnnotationUpdateParameters.md

@@ -0,0 +1,19 @@
+# Phrase::JobAnnotationUpdateParameters
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **String** | Annotation value | [optional] 
+**branch** | **String** | Branch name of the job | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::JobAnnotationUpdateParameters.new(value: Some value...,
+                                 branch: my-feature-branch)
+```
+
+