phrase_api.FigmaAttachmentsApi

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

Method	HTTP request	Description
figma_attachment_create	POST /projects/{project_id}/figma_attachments	Create a Figma attachment
figma_attachment_delete	DELETE /projects/{project_id}/figma_attachments/{id}	Delete a Figma attachment
figma_attachment_show	GET /projects/{project_id}/figma_attachments/{id}	Get a single Figma attachment
figma_attachment_update	PATCH /projects/{project_id}/figma_attachments/{id}	Update a Figma attachment
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, x_phrase_app_otp=x_phrase_app_otp, branch=branch)

Create a Figma attachment

Create a new Figma attachment.

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.FigmaAttachmentsApi(api_client)
    project_id = 'project_id_example' # str | Project ID (required)
    figma_attachment_create_parameters = phrase_api.FigmaAttachmentCreateParameters() # FigmaAttachmentCreateParameters |  (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:
        # Create a Figma attachment
        api_response = api_instance.figma_attachment_create(project_id, figma_attachment_create_parameters, x_phrase_app_otp=x_phrase_app_otp, branch=branch)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling FigmaAttachmentsApi->figma_attachment_create: %s\n" % e)

Parameters

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

Return type

FigmaAttachment

Authorization

Basic, Token

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Created	* 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_delete

figma_attachment_delete(project_id, id, x_phrase_app_otp=x_phrase_app_otp, branch=branch)

Delete a Figma attachment

Delete an existing Figma attachment.

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.FigmaAttachmentsApi(api_client)
    project_id = 'project_id_example' # str | Project 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:
        # Delete a Figma attachment
        api_instance.figma_attachment_delete(project_id, id, x_phrase_app_otp=x_phrase_app_otp, branch=branch)
    except ApiException as e:
        print("Exception when calling FigmaAttachmentsApi->figma_attachment_delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_id	str	Project 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_show

FigmaAttachment figma_attachment_show(project_id, id, x_phrase_app_otp=x_phrase_app_otp, branch=branch)

Get a single Figma attachment

Get details on a single Figma attachment for a given project.

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.FigmaAttachmentsApi(api_client)
    project_id = 'project_id_example' # str | Project 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:
        # Get a single Figma attachment
        api_response = api_instance.figma_attachment_show(project_id, id, x_phrase_app_otp=x_phrase_app_otp, branch=branch)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling FigmaAttachmentsApi->figma_attachment_show: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_id	str	Project 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

FigmaAttachment

Authorization

Basic, Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	* 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_update

FigmaAttachment figma_attachment_update(project_id, id, figma_attachment_update_parameters, x_phrase_app_otp=x_phrase_app_otp, branch=branch)

Update a Figma attachment

Update an existing Figma attachment.

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.FigmaAttachmentsApi(api_client)
    project_id = 'project_id_example' # str | Project ID (required)
    id = 'id_example' # str | ID (required)
    figma_attachment_update_parameters = phrase_api.FigmaAttachmentUpdateParameters() # FigmaAttachmentUpdateParameters |  (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:
        # Update a Figma attachment
        api_response = api_instance.figma_attachment_update(project_id, id, figma_attachment_update_parameters, x_phrase_app_otp=x_phrase_app_otp, branch=branch)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling FigmaAttachmentsApi->figma_attachment_update: %s\n" % e)

Parameters

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

Return type

FigmaAttachment

Authorization

Basic, Token

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	* 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_attachments_list

List[FigmaAttachment] figma_attachments_list(project_id, x_phrase_app_otp=x_phrase_app_otp, page=page, per_page=per_page, branch=branch)

List Figma attachments

List all Figma attachments for the given project

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.FigmaAttachmentsApi(api_client)
    project_id = 'project_id_example' # str | Project ID (required)
    x_phrase_app_otp = 'x_phrase_app_otp_example' # str | Two-Factor-Authentication token (optional)
    page = 1 # int | Page number
    per_page = 25 # int | Limit on the number of objects to be returned, between 1 and 100. 25 by default
    branch = 'my-feature-branch' # str | specify the branch to use

    try:
        # List Figma attachments
        api_response = api_instance.figma_attachments_list(project_id, x_phrase_app_otp=x_phrase_app_otp, page=page, per_page=per_page, branch=branch)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling FigmaAttachmentsApi->figma_attachments_list: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_id	str	Project ID
x_phrase_app_otp	str	Two-Factor-Authentication token (optional)	[optional]
page	int	Page number	[optional]
per_page	int	Limit on the number of objects to be returned, between 1 and 100. 25 by default	[optional]
branch	str	specify the branch to use	[optional]

Return type

List[FigmaAttachment]

Authorization

Basic, Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset - * Link - * Pagination -
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]

Files

FigmaAttachmentsApi.md

Latest commit

History

FigmaAttachmentsApi.md

File metadata and controls

phrase_api.FigmaAttachmentsApi

figma_attachment_create

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

figma_attachment_delete

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

figma_attachment_show

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

figma_attachment_update

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

figma_attachments_list

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details