All URIs are relative to https://api.phrase.com/v2
| Method | HTTP request | Description |
|---|---|---|
| ScreenshotCreate | Post /projects/{project_id}/screenshots | Create a screenshot |
| ScreenshotDelete | Delete /projects/{project_id}/screenshots/{id} | Delete a screenshot |
| ScreenshotShow | Get /projects/{project_id}/screenshots/{id} | Get a single screenshot |
| ScreenshotUpdate | Patch /projects/{project_id}/screenshots/{id} | Update a screenshot |
| ScreenshotsList | Get /projects/{project_id}/screenshots | List screenshots |
Screenshot ScreenshotCreate(ctx, projectId, optional)
Create a screenshot
Create a new screenshot.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| projectId | string | Project ID | |
| optional | *ScreenshotCreateOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a ScreenshotCreateOpts struct
| Name | Type | Description | Notes |
|---|
xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) | branch | optional.String| specify the branch to use | name | optional.String| Name of the screenshot | description | optional.String| Description of the screenshot | filename | *optional.Interface of os.File***optional.os.File| Screenshot file |
- Content-Type: multipart/form-data
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ScreenshotDelete(ctx, projectId, id, optional)
Delete a screenshot
Delete an existing screenshot.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| projectId | string | Project ID | |
| id | string | ID | |
| optional | *ScreenshotDeleteOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a ScreenshotDeleteOpts struct
| Name | Type | Description | Notes |
|---|
xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) | branch | optional.String| specify the branch to use |
(empty response body)
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Screenshot ScreenshotShow(ctx, projectId, id, optional)
Get a single screenshot
Get details on a single screenshot for a given project.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| projectId | string | Project ID | |
| id | string | ID | |
| optional | *ScreenshotShowOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a ScreenshotShowOpts struct
| Name | Type | Description | Notes |
|---|
xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) | branch | optional.String| specify the branch to use |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Screenshot ScreenshotUpdate(ctx, projectId, id, screenshotUpdateParameters, optional)
Update a screenshot
Update an existing screenshot.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| projectId | string | Project ID | |
| id | string | ID | |
| screenshotUpdateParameters | ScreenshotUpdateParameters | ||
| optional | *ScreenshotUpdateOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a ScreenshotUpdateOpts struct
| Name | Type | Description | Notes |
|---|
xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]Screenshot ScreenshotsList(ctx, projectId, optional)
List screenshots
List all screenshots for the given project.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| projectId | string | Project ID | |
| optional | *ScreenshotsListOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a ScreenshotsListOpts 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 | keyId | optional.String| filter by key |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]