All URIs are relative to https://api.phrase.com/v2
| Method | HTTP request | Description |
|---|---|---|
| ReleaseCreate | Post /accounts/{account_id}/distributions/{distribution_id}/releases | Create a release |
| ReleaseDelete | Delete /accounts/{account_id}/distributions/{distribution_id}/releases/{id} | Delete a release |
| ReleasePublish | Post /accounts/{account_id}/distributions/{distribution_id}/releases/{id}/publish | Publish a release |
| ReleaseShow | Get /accounts/{account_id}/distributions/{distribution_id}/releases/{id} | Get a single release |
| ReleaseUpdate | Patch /accounts/{account_id}/distributions/{distribution_id}/releases/{id} | Update a release |
| ReleasesList | Get /accounts/{account_id}/distributions/{distribution_id}/releases | List releases |
Release ReleaseCreate(ctx, accountId, distributionId, releaseCreateParameters, optional)
Create a release
Create a new release.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| accountId | string | Account ID | |
| distributionId | string | Distribution ID | |
| releaseCreateParameters | ReleaseCreateParameters | ||
| optional | *ReleaseCreateOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a ReleaseCreateOpts 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]
ReleaseDelete(ctx, accountId, distributionId, id, optional)
Delete a release
Delete an existing release.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| accountId | string | Account ID | |
| distributionId | string | Distribution ID | |
| id | string | ID | |
| optional | *ReleaseDeleteOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a ReleaseDeleteOpts 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]
Release ReleasePublish(ctx, accountId, distributionId, id, optional)
Publish a release
Publish a release for production.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| accountId | string | Account ID | |
| distributionId | string | Distribution ID | |
| id | string | ID | |
| optional | *ReleasePublishOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a ReleasePublishOpts 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]
Release ReleaseShow(ctx, accountId, distributionId, id, optional)
Get a single release
Get details on a single release.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| accountId | string | Account ID | |
| distributionId | string | Distribution ID | |
| id | string | ID | |
| optional | *ReleaseShowOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a ReleaseShowOpts 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]
Release ReleaseUpdate(ctx, accountId, distributionId, id, releaseUpdateParameters, optional)
Update a release
Update an existing release.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| accountId | string | Account ID | |
| distributionId | string | Distribution ID | |
| id | string | ID | |
| releaseUpdateParameters | ReleaseUpdateParameters | ||
| optional | *ReleaseUpdateOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a ReleaseUpdateOpts 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]
[]ReleasePreview ReleasesList(ctx, accountId, distributionId, optional)
List releases
List all releases for the given distribution.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| accountId | string | Account ID | |
| distributionId | string | Distribution ID | |
| optional | *ReleasesListOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a ReleasesListOpts 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]