All URIs are relative to https://api.phrase.com/v2
| Method | HTTP request | Description |
|---|---|---|
| DistributionCreate | Post /accounts/{account_id}/distributions | Create a distribution |
| DistributionDelete | Delete /accounts/{account_id}/distributions/{id} | Delete a distribution |
| DistributionShow | Get /accounts/{account_id}/distributions/{id} | Get a single distribution |
| DistributionUpdate | Patch /accounts/{account_id}/distributions/{id} | Update a distribution |
| DistributionsList | Get /accounts/{account_id}/distributions | List distributions |
Distribution DistributionCreate(ctx, accountId, distributionCreateParameters, optional)
Create a distribution
Create a new distribution.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| accountId | string | Account ID | |
| distributionCreateParameters | DistributionCreateParameters | ||
| optional | *DistributionCreateOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a DistributionCreateOpts 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]
DistributionDelete(ctx, accountId, id, optional)
Delete a distribution
Delete an existing distribution.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| accountId | string | Account ID | |
| id | string | ID | |
| optional | *DistributionDeleteOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a DistributionDeleteOpts 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]
Distribution DistributionShow(ctx, accountId, id, optional)
Get a single distribution
Get details on a single distribution.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| accountId | string | Account ID | |
| id | string | ID | |
| optional | *DistributionShowOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a DistributionShowOpts struct
| Name | Type | Description | Notes |
|---|
xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Distribution DistributionUpdate(ctx, accountId, id, distributionUpdateParameters, optional)
Update a distribution
Update an existing distribution.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| accountId | string | Account ID | |
| id | string | ID | |
| distributionUpdateParameters | DistributionUpdateParameters | ||
| optional | *DistributionUpdateOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a DistributionUpdateOpts 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]
[]DistributionPreview DistributionsList(ctx, accountId, optional)
List distributions
List all distributions for the given account.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| accountId | string | Account ID | |
| optional | *DistributionsListOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a DistributionsListOpts 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]