org.finra.herd.sdk.api

Class TagTypeApi

java.lang.Object

org.finra.herd.sdk.api.TagTypeApi

@Generated(value="class io.swagger.codegen.languages.JavaClientCodegen",
           date="2017-02-24T15:10:39.441-05:00")
public class TagTypeApi
extends Object

Constructor Summary

Constructors

Constructor and Description
TagTypeApi()
TagTypeApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)
TagType	tagTypeCreateTagType(TagTypeCreateRequest tagTypeCreateRequest) createTagType Creates a new tag type.
TagType	tagTypeDeleteTagType(String tagTypeCode) deleteTagType Deletes an existing tag type by tag type code.
TagType	tagTypeGetTagType(String tagTypeCode) getTagType Gets an existing tag type by tag type code.
TagTypeKeys	tagTypeGetTagTypes() getTagTypes Gets a list of tag type keys for all tag types defined in the system.
TagTypeSearchResponse	tagTypeSearchTagTypes(TagTypeSearchRequest tagTypeSearchRequest, String fields) searchTagTypes Retrieves all tag types existing in the system.
TagType	tagTypeUpdateTagType(String tagTypeCode, TagTypeUpdateRequest tagTypeUpdateRequest) updateTagType Updates an existing tag type.

Methods inherited from class java.lang.Object

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

Constructor Detail

TagTypeApi

public TagTypeApi()

TagTypeApi

public TagTypeApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

tagTypeGetTagTypes

public TagTypeKeys tagTypeGetTagTypes()
                               throws ApiException

getTagTypes Gets a list of tag type keys for all tag types defined in the system.

Returns:

TagTypeKeys

Throws:

ApiException

tagTypeCreateTagType

public TagType tagTypeCreateTagType(TagTypeCreateRequest tagTypeCreateRequest)
                             throws ApiException

createTagType Creates a new tag type.

Parameters:

tagTypeCreateRequest - the information needed to create the tag type

Returns:

TagType

Throws:

ApiException

tagTypeSearchTagTypes

public TagTypeSearchResponse tagTypeSearchTagTypes(TagTypeSearchRequest tagTypeSearchRequest,
                                                   String fields)
                                            throws ApiException

searchTagTypes Retrieves all tag types existing in the system. For each tag type entity, the endpoint returns tag type key by default along with any other top-level elements as specified by the \"fields\" query string parameter. The list of tag types returned by the endpoint is sorted alphabetically by tag type's order value ascending.

Parameters:

tagTypeSearchRequest - the tag type search request. The request does not take any search keys or filters

fields - the field options for the tag type search response. The valid field options are: displayName, tagTypeOrder

Returns:

TagTypeSearchResponse

Throws:

ApiException

tagTypeGetTagType

public TagType tagTypeGetTagType(String tagTypeCode)
                          throws ApiException

getTagType Gets an existing tag type by tag type code.

Parameters:

tagTypeCode - the tag type code

Returns:

TagType

Throws:

ApiException

tagTypeUpdateTagType

public TagType tagTypeUpdateTagType(String tagTypeCode,
                                    TagTypeUpdateRequest tagTypeUpdateRequest)
                             throws ApiException

updateTagType Updates an existing tag type.

Parameters:

tagTypeCode - the tag type code

tagTypeUpdateRequest - the information needed to update the tag type

Returns:

TagType

Throws:

ApiException

tagTypeDeleteTagType

public TagType tagTypeDeleteTagType(String tagTypeCode)
                             throws ApiException

deleteTagType Deletes an existing tag type by tag type code.

Parameters:

tagTypeCode - the tag type code

Returns:

TagType

Throws:

ApiException