ReleaseTriggersApi

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

Method	HTTP request	Description
releaseTriggersCreate	POST /accounts/{account_id}/distributions/{distribution_id}/release_triggers	Create a release trigger
releaseTriggersDestroy	DELETE /accounts/{account_id}/distributions/{distribution_id}/release_triggers/{id}	Delete a single release trigger
releaseTriggersList	GET /accounts/{account_id}/distributions/{distribution_id}/release_triggers	List release triggers
releaseTriggersShow	GET /accounts/{account_id}/distributions/{distribution_id}/release_triggers/{id}	Get a single release trigger
releaseTriggersUpdate	PATCH /accounts/{account_id}/distributions/{distribution_id}/release_triggers/{id}	Update a release trigger

releaseTriggersCreate

ReleaseTrigger releaseTriggersCreate(accountId, distributionId, releaseCreateParameters1, xPhraseAppOTP)

Create a release trigger

Create a new recurring release. New releases will be published automatically, based on the cron schedule provided. Currently, only one release trigger can exist per distribution.

Example

// Import classes:
import com.phrase.client.ApiClient;
import com.phrase.client.ApiException;
import com.phrase.client.Configuration;
import com.phrase.client.auth.*;
import com.phrase.client.models.*;
import com.phrase.client.api.ReleaseTriggersApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.phrase.com/v2");
    
    // Configure HTTP basic authorization: Basic
    HttpBasicAuth Basic = (HttpBasicAuth) defaultClient.getAuthentication("Basic");
    Basic.setUsername("YOUR USERNAME");
    Basic.setPassword("YOUR PASSWORD");

    // Configure API key authorization: Token
    ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token");
    Token.setApiKey("YOUR API KEY");
    Token.setApiKeyPrefix("token");

    ReleaseTriggersApi apiInstance = new ReleaseTriggersApi(defaultClient);
    String accountId = "accountId_example"; // String | Account ID
    String distributionId = "distributionId_example"; // String | Distribution ID
    ReleaseCreateParameters1 releaseCreateParameters1 = new ReleaseCreateParameters1(); // ReleaseCreateParameters1 | 
    String xPhraseAppOTP = "xPhraseAppOTP_example"; // String | Two-Factor-Authentication token (optional)
    try {
      ReleaseTrigger result = apiInstance.releaseTriggersCreate(accountId, distributionId, releaseCreateParameters1, xPhraseAppOTP);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ReleaseTriggersApi#releaseTriggersCreate");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
accountId	String	Account ID
distributionId	String	Distribution ID
releaseCreateParameters1	ReleaseCreateParameters1
xPhraseAppOTP	String	Two-Factor-Authentication token (optional)	[optional]

Return type

ReleaseTrigger

Authorization

Basic, Token

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	Created	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
400	Bad request	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
404	Not Found	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
429	Rate Limiting	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -

releaseTriggersDestroy

releaseTriggersDestroy(accountId, distributionId, id, xPhraseAppOTP)

Delete a single release trigger

Delete a single release trigger.

Example

// Import classes:
import com.phrase.client.ApiClient;
import com.phrase.client.ApiException;
import com.phrase.client.Configuration;
import com.phrase.client.auth.*;
import com.phrase.client.models.*;
import com.phrase.client.api.ReleaseTriggersApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.phrase.com/v2");
    
    // Configure HTTP basic authorization: Basic
    HttpBasicAuth Basic = (HttpBasicAuth) defaultClient.getAuthentication("Basic");
    Basic.setUsername("YOUR USERNAME");
    Basic.setPassword("YOUR PASSWORD");

    // Configure API key authorization: Token
    ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token");
    Token.setApiKey("YOUR API KEY");
    Token.setApiKeyPrefix("token");

    ReleaseTriggersApi apiInstance = new ReleaseTriggersApi(defaultClient);
    String accountId = "accountId_example"; // String | Account ID
    String distributionId = "distributionId_example"; // String | Distribution ID
    String id = "id_example"; // String | ID
    String xPhraseAppOTP = "xPhraseAppOTP_example"; // String | Two-Factor-Authentication token (optional)
    try {
      apiInstance.releaseTriggersDestroy(accountId, distributionId, id, xPhraseAppOTP);
    } catch (ApiException e) {
      System.err.println("Exception when calling ReleaseTriggersApi#releaseTriggersDestroy");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
accountId	String	Account ID
distributionId	String	Distribution ID
id	String	ID
xPhraseAppOTP	String	Two-Factor-Authentication token (optional)	[optional]

Return type

null (empty response body)

Authorization

Basic, Token

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	The resource was deleted successfully.	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
400	Bad request	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
404	Not Found	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
429	Rate Limiting	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -

releaseTriggersList

List<ReleaseTrigger> releaseTriggersList(accountId, distributionId, xPhraseAppOTP)

List release triggers

List all release triggers for the given distribution.<br> Note: Currently only one release trigger can exist per distribution.

Example

// Import classes:
import com.phrase.client.ApiClient;
import com.phrase.client.ApiException;
import com.phrase.client.Configuration;
import com.phrase.client.auth.*;
import com.phrase.client.models.*;
import com.phrase.client.api.ReleaseTriggersApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.phrase.com/v2");
    
    // Configure HTTP basic authorization: Basic
    HttpBasicAuth Basic = (HttpBasicAuth) defaultClient.getAuthentication("Basic");
    Basic.setUsername("YOUR USERNAME");
    Basic.setPassword("YOUR PASSWORD");

    // Configure API key authorization: Token
    ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token");
    Token.setApiKey("YOUR API KEY");
    Token.setApiKeyPrefix("token");

    ReleaseTriggersApi apiInstance = new ReleaseTriggersApi(defaultClient);
    String accountId = "accountId_example"; // String | Account ID
    String distributionId = "distributionId_example"; // String | Distribution ID
    String xPhraseAppOTP = "xPhraseAppOTP_example"; // String | Two-Factor-Authentication token (optional)
    try {
      List<ReleaseTrigger> result = apiInstance.releaseTriggersList(accountId, distributionId, xPhraseAppOTP);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ReleaseTriggersApi#releaseTriggersList");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
accountId	String	Account ID
distributionId	String	Distribution ID
xPhraseAppOTP	String	Two-Factor-Authentication token (optional)	[optional]

Return type

List<ReleaseTrigger>

Authorization

Basic, Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
400	Bad request	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
404	Not Found	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
429	Rate Limiting	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -

releaseTriggersShow

ReleaseTrigger releaseTriggersShow(accountId, distributionId, id, xPhraseAppOTP)

Get a single release trigger

Get details of a single release trigger.

Example

// Import classes:
import com.phrase.client.ApiClient;
import com.phrase.client.ApiException;
import com.phrase.client.Configuration;
import com.phrase.client.auth.*;
import com.phrase.client.models.*;
import com.phrase.client.api.ReleaseTriggersApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.phrase.com/v2");
    
    // Configure HTTP basic authorization: Basic
    HttpBasicAuth Basic = (HttpBasicAuth) defaultClient.getAuthentication("Basic");
    Basic.setUsername("YOUR USERNAME");
    Basic.setPassword("YOUR PASSWORD");

    // Configure API key authorization: Token
    ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token");
    Token.setApiKey("YOUR API KEY");
    Token.setApiKeyPrefix("token");

    ReleaseTriggersApi apiInstance = new ReleaseTriggersApi(defaultClient);
    String accountId = "accountId_example"; // String | Account ID
    String distributionId = "distributionId_example"; // String | Distribution ID
    String id = "id_example"; // String | ID
    String xPhraseAppOTP = "xPhraseAppOTP_example"; // String | Two-Factor-Authentication token (optional)
    try {
      ReleaseTrigger result = apiInstance.releaseTriggersShow(accountId, distributionId, id, xPhraseAppOTP);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ReleaseTriggersApi#releaseTriggersShow");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
accountId	String	Account ID
distributionId	String	Distribution ID
id	String	ID
xPhraseAppOTP	String	Two-Factor-Authentication token (optional)	[optional]

Return type

ReleaseTrigger

Authorization

Basic, Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
400	Bad request	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
404	Not Found	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
429	Rate Limiting	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -

releaseTriggersUpdate

ReleaseTrigger releaseTriggersUpdate(accountId, distributionId, id, releaseUpdateParameters1, xPhraseAppOTP)

Update a release trigger

Update a recurring release.

Example

// Import classes:
import com.phrase.client.ApiClient;
import com.phrase.client.ApiException;
import com.phrase.client.Configuration;
import com.phrase.client.auth.*;
import com.phrase.client.models.*;
import com.phrase.client.api.ReleaseTriggersApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.phrase.com/v2");
    
    // Configure HTTP basic authorization: Basic
    HttpBasicAuth Basic = (HttpBasicAuth) defaultClient.getAuthentication("Basic");
    Basic.setUsername("YOUR USERNAME");
    Basic.setPassword("YOUR PASSWORD");

    // Configure API key authorization: Token
    ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token");
    Token.setApiKey("YOUR API KEY");
    Token.setApiKeyPrefix("token");

    ReleaseTriggersApi apiInstance = new ReleaseTriggersApi(defaultClient);
    String accountId = "accountId_example"; // String | Account ID
    String distributionId = "distributionId_example"; // String | Distribution ID
    String id = "id_example"; // String | ID
    ReleaseUpdateParameters1 releaseUpdateParameters1 = new ReleaseUpdateParameters1(); // ReleaseUpdateParameters1 | 
    String xPhraseAppOTP = "xPhraseAppOTP_example"; // String | Two-Factor-Authentication token (optional)
    try {
      ReleaseTrigger result = apiInstance.releaseTriggersUpdate(accountId, distributionId, id, releaseUpdateParameters1, xPhraseAppOTP);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ReleaseTriggersApi#releaseTriggersUpdate");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
accountId	String	Account ID
distributionId	String	Distribution ID
id	String	ID
releaseUpdateParameters1	ReleaseUpdateParameters1
xPhraseAppOTP	String	Two-Factor-Authentication token (optional)	[optional]

Return type

ReleaseTrigger

Authorization

Basic, Token

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
400	Bad request	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
404	Not Found	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
429	Rate Limiting	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -

Files

ReleaseTriggersApi.md

Latest commit

History

ReleaseTriggersApi.md

File metadata and controls

ReleaseTriggersApi

releaseTriggersCreate

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

releaseTriggersDestroy

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

releaseTriggersList

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

releaseTriggersShow

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

releaseTriggersUpdate

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details