phrase 2.15.0 → 2.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a56234942a6166c1299cd75286a0ec37a654a98bfc998f806c8635b5cca69ef0
-  data.tar.gz: 3b8a5a7f7a6e782bce174f65697f6eaddbad169e912001a545ef2f3db119b632
+  metadata.gz: e256910e1eee281300838e5c2ccbe1d372e61bb6fc0ea0120cf3ad3943256ca2
+  data.tar.gz: 23488afa28edeb726cd0313ddd09724a3b6ecd4ed889194152b6beaa072d75ff
 SHA512:
-  metadata.gz: 7537a76db6d34e63d666874a35ba8963823b0935af89555a957e02242bdd8e9ab175aff193018b8082339abbda7e71a5e60d58895310129e4409664167f7a5d4
-  data.tar.gz: 44f4dcae88b39e894ed424bd2e8816a2fe8ce0cd114e138b4a9653585f9af121535f7809aa918ad590e27642fe90d3c695762706348c65f9c6cbe81a541af55e
+  metadata.gz: 1ff947242548cbb7d30d90ea410cc8b1e55521e8aa1e219fb46b3353c6eb2bb431f117ea91a22c034af26230e749859d8da62c427579bcdd2571e4f60cde95e0
+  data.tar.gz: 924205ceff36840e33741e21126e92e507793cb2aa56c15a1ced53e3bbab040be28a4680c04244d99d7a38e02069c62203c99a9c61efef85cc225eed5cb11ab6

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## [2.17.0](https://github.com/phrase/openapi/compare/ruby-v2.16.0...ruby-v2.17.0) (2023-10-13)
+
+
+### Features
+
+* **API:** Implement figma attachments endpoints ([#415](https://github.com/phrase/openapi/issues/415)) ([970e612](https://github.com/phrase/openapi/commit/970e612fda620ca882a221ef541036b8d200b675))
+
+## [2.16.0](https://github.com/phrase/openapi/compare/ruby-v2.15.0...ruby-v2.16.0) (2023-09-12)
+
+
+### Features
+
+* Optionally tag only affected keys on upload [TSI-2041] ([#412](https://github.com/phrase/openapi/issues/412)) ([e8f958e](https://github.com/phrase/openapi/commit/e8f958e91469c2542f44ab68469c933688958383))
+* **TSI-1946:** Add reviewed_at to translations ([#396](https://github.com/phrase/openapi/issues/396)) ([3e663d9](https://github.com/phrase/openapi/commit/3e663d971a99a816f0165dd6653a9a1e8a87c95e))
+
 ## [2.15.0](https://github.com/phrase/openapi/compare/ruby-v2.14.0...ruby-v2.15.0) (2023-08-28)
 
 

data/Gemfile

@@ -6,4 +6,5 @@ group :development, :test do
   gem 'rake', '~> 13.0.1'
   gem 'pry-byebug'
   gem 'rubocop', '~> 0.66.0'
+  gem 'webmock'
 end

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: 2.15.0
+- Package version: 2.17.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-2.15.0.gem
+gem install ./phrase-2.17.0.gem
 ```
 
-(for development, run `gem install --dev ./phrase-2.15.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./phrase-2.17.0.gem` to install the development dependencies)
 
 ## Getting Started
 
@@ -177,6 +177,11 @@ Class | Method | HTTP request | Description
 *Phrase::DistributionsApi* | [**distributions_list**](docs/DistributionsApi.md#distributions_list) | **GET** /accounts/{account_id}/distributions | List distributions
 *Phrase::DocumentsApi* | [**document_delete**](docs/DocumentsApi.md#document_delete) | **DELETE** /projects/{project_id}/documents/{id} | Delete document
 *Phrase::DocumentsApi* | [**documents_list**](docs/DocumentsApi.md#documents_list) | **GET** /projects/{project_id}/documents | List documents
+*Phrase::FigmaAttachmentsApi* | [**figma_attachment_create**](docs/FigmaAttachmentsApi.md#figma_attachment_create) | **POST** /projects/{project_id}/figma_attachments | Create a Figma attachment
+*Phrase::FigmaAttachmentsApi* | [**figma_attachment_delete**](docs/FigmaAttachmentsApi.md#figma_attachment_delete) | **DELETE** /projects/{project_id}/figma_attachments/{id} | Delete a Figma attachment
+*Phrase::FigmaAttachmentsApi* | [**figma_attachment_show**](docs/FigmaAttachmentsApi.md#figma_attachment_show) | **GET** /projects/{project_id}/figma_attachments/{id} | Get a single Figma attachment
+*Phrase::FigmaAttachmentsApi* | [**figma_attachment_update**](docs/FigmaAttachmentsApi.md#figma_attachment_update) | **PATCH** /projects/{project_id}/figma_attachments/{id} | Update a Figma attachment
+*Phrase::FigmaAttachmentsApi* | [**figma_attachments_list**](docs/FigmaAttachmentsApi.md#figma_attachments_list) | **GET** /projects/{project_id}/figma_attachments | List Figma attachments
 *Phrase::FormatsApi* | [**formats_list**](docs/FormatsApi.md#formats_list) | **GET** /formats | List formats
 *Phrase::GitHubSyncApi* | [**github_sync_export**](docs/GitHubSyncApi.md#github_sync_export) | **POST** /github_syncs/export | Export from Phrase Strings to GitHub
 *Phrase::GitHubSyncApi* | [**github_sync_import**](docs/GitHubSyncApi.md#github_sync_import) | **POST** /github_syncs/import | Import to Phrase Strings from GitHub
@@ -255,6 +260,8 @@ Class | Method | HTTP request | Description
 *Phrase::KeysApi* | [**keys_search**](docs/KeysApi.md#keys_search) | **POST** /projects/{project_id}/keys/search | Search keys
 *Phrase::KeysApi* | [**keys_tag**](docs/KeysApi.md#keys_tag) | **PATCH** /projects/{project_id}/keys/tag | Add tags to collection of keys
 *Phrase::KeysApi* | [**keys_untag**](docs/KeysApi.md#keys_untag) | **PATCH** /projects/{project_id}/keys/untag | Remove tags from collection of keys
+*Phrase::KeysFigmaAttachmentsApi* | [**figma_attachment_attach_to_key**](docs/KeysFigmaAttachmentsApi.md#figma_attachment_attach_to_key) | **POST** /projects/{project_id}/figma_attachments/{figma_attachment_id}/keys | Attach the Figma attachment to a key
+*Phrase::KeysFigmaAttachmentsApi* | [**figma_attachment_detach_from_key**](docs/KeysFigmaAttachmentsApi.md#figma_attachment_detach_from_key) | **DELETE** /projects/{project_id}/figma_attachments/{figma_attachment_id}/keys/{id} | Detach the Figma attachment from a key
 *Phrase::LocalesApi* | [**account_locales**](docs/LocalesApi.md#account_locales) | **GET** /accounts/{id}/locales | List locales used in account
 *Phrase::LocalesApi* | [**locale_create**](docs/LocalesApi.md#locale_create) | **POST** /projects/{project_id}/locales | Create a locale
 *Phrase::LocalesApi* | [**locale_delete**](docs/LocalesApi.md#locale_delete) | **DELETE** /projects/{project_id}/locales/{id} | Delete a locale
@@ -414,6 +421,9 @@ Class | Method | HTTP request | Description
  - [Phrase::DistributionPreview](docs/DistributionPreview.md)
  - [Phrase::DistributionUpdateParameters](docs/DistributionUpdateParameters.md)
  - [Phrase::Document](docs/Document.md)
+ - [Phrase::FigmaAttachment](docs/FigmaAttachment.md)
+ - [Phrase::FigmaAttachmentCreateParameters](docs/FigmaAttachmentCreateParameters.md)
+ - [Phrase::FigmaAttachmentUpdateParameters](docs/FigmaAttachmentUpdateParameters.md)
  - [Phrase::Format](docs/Format.md)
  - [Phrase::GithubSyncExportParameters](docs/GithubSyncExportParameters.md)
  - [Phrase::GithubSyncImportParameters](docs/GithubSyncImportParameters.md)

data/docs/FigmaAttachment.md

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

data/docs/FigmaAttachmentCreateParameters.md

@@ -0,0 +1,19 @@
+# Phrase::FigmaAttachmentCreateParameters
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional] 
+**url** | **String** | Figma file url | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::FigmaAttachmentCreateParameters.new(branch: my-feature-branch,
+                                 url: https://figma.com/file/xxxxx/sample)
+```
+
+

data/docs/FigmaAttachmentUpdateParameters.md

@@ -0,0 +1,19 @@
+# Phrase::FigmaAttachmentUpdateParameters
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional] 
+**url** | **String** | Figma file url | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::FigmaAttachmentUpdateParameters.new(branch: my-feature-branch,
+                                 url: https://figma.com/file/xxxxx/sample)
+```
+
+

data/docs/FigmaAttachmentsApi.md

@@ -0,0 +1,341 @@
+# Phrase::FigmaAttachmentsApi
+
+All URIs are relative to *https://api.phrase.com/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**figma_attachment_create**](FigmaAttachmentsApi.md#figma_attachment_create) | **POST** /projects/{project_id}/figma_attachments | Create a Figma attachment
+[**figma_attachment_delete**](FigmaAttachmentsApi.md#figma_attachment_delete) | **DELETE** /projects/{project_id}/figma_attachments/{id} | Delete a Figma attachment
+[**figma_attachment_show**](FigmaAttachmentsApi.md#figma_attachment_show) | **GET** /projects/{project_id}/figma_attachments/{id} | Get a single Figma attachment
+[**figma_attachment_update**](FigmaAttachmentsApi.md#figma_attachment_update) | **PATCH** /projects/{project_id}/figma_attachments/{id} | Update a Figma attachment
+[**figma_attachments_list**](FigmaAttachmentsApi.md#figma_attachments_list) | **GET** /projects/{project_id}/figma_attachments | List Figma attachments
+
+
+
+## figma_attachment_create
+
+> FigmaAttachment figma_attachment_create(project_id, figma_attachment_create_parameters, opts)
+
+Create a Figma attachment
+
+Create a new Figma attachment.
+
+### Example
+
+```ruby
+# load the gem
+require 'phrase'
+# setup authorization
+Phrase.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+
+  # Configure API key authorization: Token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  config.api_key_prefix['Authorization'] = 'token'
+end
+
+api_instance = Phrase::FigmaAttachmentsApi.new
+project_id = 'project_id_example' # String | Project ID
+figma_attachment_create_parameters = Phrase::FigmaAttachmentCreateParameters.new # FigmaAttachmentCreateParameters | 
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
+  branch: 'my-feature-branch' # String | specify the branch to use
+}
+
+begin
+  #Create a Figma attachment
+  result = api_instance.figma_attachment_create(project_id, figma_attachment_create_parameters, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling FigmaAttachmentsApi->figma_attachment_create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID | 
+ **figma_attachment_create_parameters** | [**FigmaAttachmentCreateParameters**](FigmaAttachmentCreateParameters.md)|  | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+ **branch** | **String**| specify the branch to use | [optional] 
+
+### Return type
+
+Response<([**FigmaAttachment**](FigmaAttachment.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## figma_attachment_delete
+
+> figma_attachment_delete(project_id, id, opts)
+
+Delete a Figma attachment
+
+Delete an existing Figma attachment.
+
+### Example
+
+```ruby
+# load the gem
+require 'phrase'
+# setup authorization
+Phrase.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+
+  # Configure API key authorization: Token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  config.api_key_prefix['Authorization'] = 'token'
+end
+
+api_instance = Phrase::FigmaAttachmentsApi.new
+project_id = 'project_id_example' # String | Project ID
+id = 'id_example' # String | ID
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
+  branch: 'my-feature-branch' # String | specify the branch to use
+}
+
+begin
+  #Delete a Figma attachment
+  api_instance.figma_attachment_delete(project_id, id, opts)
+rescue Phrase::ApiError => e
+  puts "Exception when calling FigmaAttachmentsApi->figma_attachment_delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID | 
+ **id** | **String**| ID | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+ **branch** | **String**| specify the branch to use | [optional] 
+
+### Return type
+
+Response<(nil (empty response body))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## figma_attachment_show
+
+> FigmaAttachment figma_attachment_show(project_id, id, opts)
+
+Get a single Figma attachment
+
+Get details on a single Figma attachment for a given project.
+
+### Example
+
+```ruby
+# load the gem
+require 'phrase'
+# setup authorization
+Phrase.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+
+  # Configure API key authorization: Token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  config.api_key_prefix['Authorization'] = 'token'
+end
+
+api_instance = Phrase::FigmaAttachmentsApi.new
+project_id = 'project_id_example' # String | Project ID
+id = 'id_example' # String | ID
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
+  branch: 'my-feature-branch' # String | specify the branch to use
+}
+
+begin
+  #Get a single Figma attachment
+  result = api_instance.figma_attachment_show(project_id, id, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling FigmaAttachmentsApi->figma_attachment_show: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID | 
+ **id** | **String**| ID | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+ **branch** | **String**| specify the branch to use | [optional] 
+
+### Return type
+
+Response<([**FigmaAttachment**](FigmaAttachment.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## figma_attachment_update
+
+> FigmaAttachment figma_attachment_update(project_id, id, figma_attachment_update_parameters, opts)
+
+Update a Figma attachment
+
+Update an existing Figma attachment.
+
+### Example
+
+```ruby
+# load the gem
+require 'phrase'
+# setup authorization
+Phrase.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+
+  # Configure API key authorization: Token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  config.api_key_prefix['Authorization'] = 'token'
+end
+
+api_instance = Phrase::FigmaAttachmentsApi.new
+project_id = 'project_id_example' # String | Project ID
+id = 'id_example' # String | ID
+figma_attachment_update_parameters = Phrase::FigmaAttachmentUpdateParameters.new # FigmaAttachmentUpdateParameters | 
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
+  branch: 'my-feature-branch' # String | specify the branch to use
+}
+
+begin
+  #Update a Figma attachment
+  result = api_instance.figma_attachment_update(project_id, id, figma_attachment_update_parameters, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling FigmaAttachmentsApi->figma_attachment_update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID | 
+ **id** | **String**| ID | 
+ **figma_attachment_update_parameters** | [**FigmaAttachmentUpdateParameters**](FigmaAttachmentUpdateParameters.md)|  | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+ **branch** | **String**| specify the branch to use | [optional] 
+
+### Return type
+
+Response<([**FigmaAttachment**](FigmaAttachment.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## figma_attachments_list
+
+> Array&lt;FigmaAttachment&gt; figma_attachments_list(project_id, opts)
+
+List Figma attachments
+
+List all Figma attachments for the given project
+
+### Example
+
+```ruby
+# load the gem
+require 'phrase'
+# setup authorization
+Phrase.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+
+  # Configure API key authorization: Token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  config.api_key_prefix['Authorization'] = 'token'
+end
+
+api_instance = Phrase::FigmaAttachmentsApi.new
+project_id = 'project_id_example' # String | Project ID
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
+  page: 1, # Integer | Page number
+  per_page: 25, # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
+  branch: 'my-feature-branch' # String | specify the branch to use
+}
+
+begin
+  #List Figma attachments
+  result = api_instance.figma_attachments_list(project_id, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling FigmaAttachmentsApi->figma_attachments_list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+ **page** | **Integer**| Page number | [optional] 
+ **per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional] 
+ **branch** | **String**| specify the branch to use | [optional] 
+
+### Return type
+
+Response<([**Array&lt;FigmaAttachment&gt;**](FigmaAttachment.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/KeysFigmaAttachmentsApi.md

@@ -0,0 +1,142 @@
+# Phrase::KeysFigmaAttachmentsApi
+
+All URIs are relative to *https://api.phrase.com/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**figma_attachment_attach_to_key**](KeysFigmaAttachmentsApi.md#figma_attachment_attach_to_key) | **POST** /projects/{project_id}/figma_attachments/{figma_attachment_id}/keys | Attach the Figma attachment to a key
+[**figma_attachment_detach_from_key**](KeysFigmaAttachmentsApi.md#figma_attachment_detach_from_key) | **DELETE** /projects/{project_id}/figma_attachments/{figma_attachment_id}/keys/{id} | Detach the Figma attachment from a key
+
+
+
+## figma_attachment_attach_to_key
+
+> figma_attachment_attach_to_key(project_id, figma_attachment_id, id, opts)
+
+Attach the Figma attachment to a key
+
+Attach the Figma attachment to a key
+
+### Example
+
+```ruby
+# load the gem
+require 'phrase'
+# setup authorization
+Phrase.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+
+  # Configure API key authorization: Token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  config.api_key_prefix['Authorization'] = 'token'
+end
+
+api_instance = Phrase::KeysFigmaAttachmentsApi.new
+project_id = 'project_id_example' # String | Project ID
+figma_attachment_id = 'figma_attachment_id_example' # String | Figma attachment ID
+id = 'id_example' # String | ID
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
+  branch: 'my-feature-branch' # String | specify the branch to use
+}
+
+begin
+  #Attach the Figma attachment to a key
+  api_instance.figma_attachment_attach_to_key(project_id, figma_attachment_id, id, opts)
+rescue Phrase::ApiError => e
+  puts "Exception when calling KeysFigmaAttachmentsApi->figma_attachment_attach_to_key: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID | 
+ **figma_attachment_id** | **String**| Figma attachment ID | 
+ **id** | **String**| ID | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+ **branch** | **String**| specify the branch to use | [optional] 
+
+### Return type
+
+Response<(nil (empty response body))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## figma_attachment_detach_from_key
+
+> figma_attachment_detach_from_key(project_id, figma_attachment_id, id, opts)
+
+Detach the Figma attachment from a key
+
+Detach the Figma attachment from a key
+
+### Example
+
+```ruby
+# load the gem
+require 'phrase'
+# setup authorization
+Phrase.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+
+  # Configure API key authorization: Token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  config.api_key_prefix['Authorization'] = 'token'
+end
+
+api_instance = Phrase::KeysFigmaAttachmentsApi.new
+project_id = 'project_id_example' # String | Project ID
+figma_attachment_id = 'figma_attachment_id_example' # String | Figma attachment ID
+id = 'id_example' # String | ID
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
+  branch: 'my-feature-branch' # String | specify the branch to use
+}
+
+begin
+  #Detach the Figma attachment from a key
+  api_instance.figma_attachment_detach_from_key(project_id, figma_attachment_id, id, opts)
+rescue Phrase::ApiError => e
+  puts "Exception when calling KeysFigmaAttachmentsApi->figma_attachment_detach_from_key: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID | 
+ **figma_attachment_id** | **String**| Figma attachment ID | 
+ **id** | **String**| ID | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+ **branch** | **String**| specify the branch to use | [optional] 
+
+### Return type
+
+Response<(nil (empty response body))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+