All URIs are relative to https://api.phrase.com/v2
| Method | HTTP request | Description |
|---|---|---|
| DocumentDelete | Delete /projects/{project_id}/documents/{id} | Delete document |
| DocumentsList | Get /projects/{project_id}/documents | List documents |
DocumentDelete(ctx, projectId, id, optional)
Delete document
Delete an existing document.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| projectId | string | Project ID | |
| id | string | ID | |
| optional | *DocumentDeleteOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a DocumentDeleteOpts struct
| Name | Type | Description | Notes |
|---|
xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) |
(empty response body)
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]Document DocumentsList(ctx, projectId, optional)
List documents
List all documents the current user has access to.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| projectId | string | Project ID | |
| optional | *DocumentsListOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a DocumentsListOpts 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 |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]