com.crowdin.client.webhooks

Class OrganizationWebhooksApi

java.lang.Object

com.crowdin.client.core.CrowdinApi

com.crowdin.client.webhooks.OrganizationWebhooksApi

public class OrganizationWebhooksApi
extends CrowdinApi

Field Summary

Fields inherited from class com.crowdin.client.core.CrowdinApi

clientConfig, graphqlUrl, httpClient, url

Constructor Summary

Constructors

Constructor and Description
OrganizationWebhooksApi(Credentials credentials)
OrganizationWebhooksApi(Credentials credentials, ClientConfig clientConfig)

Method Summary

Modifier and Type	Method and Description
ResponseObject<OrganizationWebhook>	addWebhook(AddOrganizationWebhookRequest request)
void	deleteWebhook(java.lang.Long organizationWebhookId)
ResponseObject<OrganizationWebhook>	editWebhook(java.lang.Long organizationWebhookId, java.util.List<PatchRequest> request)
ResponseObject<OrganizationWebhook>	getWebhook(java.lang.Long organizationWebhookId)
ResponseList<OrganizationWebhook>	listWebhooks(java.lang.Integer limit, java.lang.Integer offset)

Methods inherited from class com.crowdin.client.core.CrowdinApi

graphql, graphql

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OrganizationWebhooksApi

public OrganizationWebhooksApi(Credentials credentials)

OrganizationWebhooksApi

public OrganizationWebhooksApi(Credentials credentials,
                               ClientConfig clientConfig)

Method Detail

listWebhooks

public ResponseList<OrganizationWebhook> listWebhooks(java.lang.Integer limit,
                                                      java.lang.Integer offset)
                                               throws HttpException,
                                                      HttpBadRequestException

Parameters:

limit - maximum number of items to retrieve (default 25)

offset - starting offset in the collection (default 0)

Returns:

list of organization webhooks

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

addWebhook

public ResponseObject<OrganizationWebhook> addWebhook(AddOrganizationWebhookRequest request)
                                               throws HttpException,
                                                      HttpBadRequestException

Parameters:

request - request object

Returns:

newly created organization webhook

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

getWebhook

public ResponseObject<OrganizationWebhook> getWebhook(java.lang.Long organizationWebhookId)
                                               throws HttpException,
                                                      HttpBadRequestException

Parameters:

organizationWebhookId - organization webhook identifier

Returns:

organization webhook

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

deleteWebhook

public void deleteWebhook(java.lang.Long organizationWebhookId)
                   throws HttpException,
                          HttpBadRequestException

Parameters:

organizationWebhookId - organization webhook identifier

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

editWebhook

public ResponseObject<OrganizationWebhook> editWebhook(java.lang.Long organizationWebhookId,
                                                       java.util.List<PatchRequest> request)
                                                throws HttpException,
                                                       HttpBadRequestException

Parameters:

organizationWebhookId - organization webhook identifier

request - request object

Returns:

updated organization webhook

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation