Skip to content

Latest commit

 

History

History
152 lines (110 loc) · 6.28 KB

KeysFigmaAttachmentsApi.md

File metadata and controls

152 lines (110 loc) · 6.28 KB
Raw

phrase_api.KeysFigmaAttachmentsApi

All URIs are relative to https://api.phrase.com/v2

Method HTTP request Description
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 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, x_phrase_app_otp=x_phrase_app_otp, branch=branch)

Attach the Figma attachment to a key

Attach the Figma attachment to a key

Example

from __future__ import print_function
import time
import phrase_api
from phrase_api.rest import ApiException
from pprint import pprint

configuration = phrase_api.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
configuration.api_key_prefix['Authorization'] = 'token'

# Enter a context with an instance of the API client
with phrase_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrase_api.KeysFigmaAttachmentsApi(api_client)
    project_id = 'project_id_example' # str | Project ID (required)
    figma_attachment_id = 'figma_attachment_id_example' # str | Figma attachment ID (required)
    id = 'id_example' # str | ID (required)
    x_phrase_app_otp = 'x_phrase_app_otp_example' # str | Two-Factor-Authentication token (optional)
    branch = 'my-feature-branch' # str | specify the branch to use

    try:
        # Attach the Figma attachment to a key
        api_instance.figma_attachment_attach_to_key(project_id, figma_attachment_id, id, x_phrase_app_otp=x_phrase_app_otp, branch=branch)
    except ApiException as e:
        print("Exception when calling KeysFigmaAttachmentsApi->figma_attachment_attach_to_key: %s\n" % e)

Parameters

Name Type Description Notes
project_id str Project ID
figma_attachment_id str Figma attachment ID
id str ID
x_phrase_app_otp str Two-Factor-Authentication token (optional) [optional]
branch str specify the branch to use [optional]

Return type

void (empty response body)

Authorization

Basic, Token

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
204 The resource was deleted successfully. * X-Rate-Limit-Limit -
* X-Rate-Limit-Remaining -
* X-Rate-Limit-Reset -
400 Bad request * X-Rate-Limit-Limit -
* X-Rate-Limit-Remaining -
* X-Rate-Limit-Reset -
404 Not Found * X-Rate-Limit-Limit -
* X-Rate-Limit-Remaining -
* X-Rate-Limit-Reset -
429 Rate Limiting * X-Rate-Limit-Limit -
* X-Rate-Limit-Remaining -
* X-Rate-Limit-Reset -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

figma_attachment_detach_from_key

figma_attachment_detach_from_key(project_id, figma_attachment_id, id, x_phrase_app_otp=x_phrase_app_otp, branch=branch)

Detach the Figma attachment from a key

Detach the Figma attachment from a key

Example

from __future__ import print_function
import time
import phrase_api
from phrase_api.rest import ApiException
from pprint import pprint

configuration = phrase_api.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
configuration.api_key_prefix['Authorization'] = 'token'

# Enter a context with an instance of the API client
with phrase_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrase_api.KeysFigmaAttachmentsApi(api_client)
    project_id = 'project_id_example' # str | Project ID (required)
    figma_attachment_id = 'figma_attachment_id_example' # str | Figma attachment ID (required)
    id = 'id_example' # str | ID (required)
    x_phrase_app_otp = 'x_phrase_app_otp_example' # str | Two-Factor-Authentication token (optional)
    branch = 'my-feature-branch' # str | specify the branch to use

    try:
        # Detach the Figma attachment from a key
        api_instance.figma_attachment_detach_from_key(project_id, figma_attachment_id, id, x_phrase_app_otp=x_phrase_app_otp, branch=branch)
    except ApiException as e:
        print("Exception when calling KeysFigmaAttachmentsApi->figma_attachment_detach_from_key: %s\n" % e)

Parameters

Name Type Description Notes
project_id str Project ID
figma_attachment_id str Figma attachment ID
id str ID
x_phrase_app_otp str Two-Factor-Authentication token (optional) [optional]
branch str specify the branch to use [optional]

Return type

void (empty response body)

Authorization

Basic, Token

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
204 The resource was deleted successfully. * X-Rate-Limit-Limit -
* X-Rate-Limit-Remaining -
* X-Rate-Limit-Reset -
400 Bad request * X-Rate-Limit-Limit -
* X-Rate-Limit-Remaining -
* X-Rate-Limit-Reset -
404 Not Found * X-Rate-Limit-Limit -
* X-Rate-Limit-Remaining -
* X-Rate-Limit-Reset -
429 Rate Limiting * X-Rate-Limit-Limit -
* X-Rate-Limit-Remaining -
* X-Rate-Limit-Reset -

[Back to top] [Back to API list] [Back to Model list] [Back to README]