Skip to content

Latest commit

 

History

History
255 lines (146 loc) · 7.81 KB

FigmaAttachmentsApi.md

File metadata and controls

255 lines (146 loc) · 7.81 KB

\FigmaAttachmentsApi

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

Method HTTP request Description
FigmaAttachmentCreate Post /projects/{project_id}/figma_attachments Create a Figma attachment
FigmaAttachmentDelete Delete /projects/{project_id}/figma_attachments/{id} Delete a Figma attachment
FigmaAttachmentShow Get /projects/{project_id}/figma_attachments/{id} Get a single Figma attachment
FigmaAttachmentUpdate Patch /projects/{project_id}/figma_attachments/{id} Update a Figma attachment
FigmaAttachmentsList Get /projects/{project_id}/figma_attachments List Figma attachments

FigmaAttachmentCreate

FigmaAttachment FigmaAttachmentCreate(ctx, projectId, figmaAttachmentCreateParameters, optional)

Create a Figma attachment

Create a new Figma attachment.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
projectId string Project ID
figmaAttachmentCreateParameters FigmaAttachmentCreateParameters
optional *FigmaAttachmentCreateOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a FigmaAttachmentCreateOpts struct

Name Type Description Notes

xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) | branch | optional.String| specify the branch to use |

Return type

FigmaAttachment

Authorization

Basic, Token

HTTP request headers

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

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

FigmaAttachmentDelete

FigmaAttachmentDelete(ctx, projectId, id, optional)

Delete a Figma attachment

Delete an existing Figma attachment.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
projectId string Project ID
id string ID
optional *FigmaAttachmentDeleteOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a FigmaAttachmentDeleteOpts struct

Name Type Description Notes

xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) | branch | optional.String| specify the branch to use |

Return type

(empty response body)

Authorization

Basic, Token

HTTP request headers

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

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

FigmaAttachmentShow

FigmaAttachment FigmaAttachmentShow(ctx, projectId, id, optional)

Get a single Figma attachment

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

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
projectId string Project ID
id string ID
optional *FigmaAttachmentShowOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a FigmaAttachmentShowOpts struct

Name Type Description Notes

xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) | branch | optional.String| specify the branch to use |

Return type

FigmaAttachment

Authorization

Basic, Token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

FigmaAttachmentUpdate

FigmaAttachment FigmaAttachmentUpdate(ctx, projectId, id, figmaAttachmentUpdateParameters, optional)

Update a Figma attachment

Update an existing Figma attachment.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
projectId string Project ID
id string ID
figmaAttachmentUpdateParameters FigmaAttachmentUpdateParameters
optional *FigmaAttachmentUpdateOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a FigmaAttachmentUpdateOpts struct

Name Type Description Notes

xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) | branch | optional.String| specify the branch to use |

Return type

FigmaAttachment

Authorization

Basic, Token

HTTP request headers

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

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

FigmaAttachmentsList

[]FigmaAttachment FigmaAttachmentsList(ctx, projectId, optional)

List Figma attachments

List all Figma attachments for the given project

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
projectId string Project ID
optional *FigmaAttachmentsListOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a FigmaAttachmentsListOpts struct

Name Type Description Notes

xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) | page | optional.Int32| Page number | perPage | optional.Int32| Limit on the number of objects to be returned, between 1 and 100. 25 by default | branch | optional.String| specify the branch to use |

Return type

[]FigmaAttachment

Authorization

Basic, Token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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