com.crowdin.client.styleguide

Class StyleGuidesApi

java.lang.Object

com.crowdin.client.core.CrowdinApi

com.crowdin.client.styleguide.StyleGuidesApi

public class StyleGuidesApi
extends CrowdinApi

Field Summary

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

clientConfig, graphqlUrl, httpClient, url

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ResponseObject<StyleGuide>	addStyleGuide(AddStyleGuideRequest request)
void	deleteStyleGuide(java.lang.Long styleGuideId)
ResponseObject<StyleGuide>	editStyleGuide(java.lang.Long styleGuideId, java.util.List<PatchRequest> request)
ResponseObject<StyleGuide>	getStyleGuide(java.lang.Long styleGuideId)
ResponseList<StyleGuide>	listStyleGuides(ListStyleGuidesParams params)
ResponseList<StyleGuide>	listStyleGuides(java.lang.Long userId, java.lang.Integer limit, java.lang.Integer offset)
ResponseList<StyleGuide>	listStyleGuides(java.lang.Long userId, java.lang.Integer limit, java.lang.Integer offset, java.util.List<OrderByField> orderBy)

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

StyleGuidesApi

public StyleGuidesApi(Credentials credentials)

StyleGuidesApi

public StyleGuidesApi(Credentials credentials,
                      ClientConfig clientConfig)

Method Detail

deleteStyleGuide

public void deleteStyleGuide(java.lang.Long styleGuideId)
                      throws HttpException,
                             HttpBadRequestException

Parameters:

styleGuideId - style guide identifier

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

editStyleGuide

public ResponseObject<StyleGuide> editStyleGuide(java.lang.Long styleGuideId,
                                                 java.util.List<PatchRequest> request)
                                          throws HttpException,
                                                 HttpBadRequestException

Parameters:

styleGuideId - style guide identifier

request - request object

Returns:

updated style guide

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

getStyleGuide

public ResponseObject<StyleGuide> getStyleGuide(java.lang.Long styleGuideId)
                                         throws HttpException,
                                                HttpBadRequestException

Parameters:

styleGuideId - style guide identifier

Returns:

style guide

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

addStyleGuide

public ResponseObject<StyleGuide> addStyleGuide(AddStyleGuideRequest request)
                                         throws HttpException,
                                                HttpBadRequestException

Parameters:

request - request object

Returns:

newly created style guide

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

listStyleGuides

public ResponseList<StyleGuide> listStyleGuides(java.lang.Long userId,
                                                java.lang.Integer limit,
                                                java.lang.Integer offset)
                                         throws HttpException,
                                                HttpBadRequestException

Parameters:

userId - user identifier

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

offset - starting offset in the collection (default 0)

Returns:

list of style guides

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

listStyleGuides

public ResponseList<StyleGuide> listStyleGuides(java.lang.Long userId,
                                                java.lang.Integer limit,
                                                java.lang.Integer offset,
                                                java.util.List<OrderByField> orderBy)
                                         throws HttpException,
                                                HttpBadRequestException

Parameters:

userId - user identifier

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

offset - starting offset in the collection (default 0)

orderBy - list of OrderByField

Returns:

list of style guides

Throws:

HttpException

HttpBadRequestException

See Also:

• API Documentation
• Enterprise API Documentation

listStyleGuides

public ResponseList<StyleGuide> listStyleGuides(ListStyleGuidesParams params)
                                         throws HttpException,
                                                HttpBadRequestException

Throws:

HttpException

HttpBadRequestException