io.swagger.client.api

Class TemplatesApi

java.lang.Object

io.swagger.client.api.TemplatesApi

public class TemplatesApi
extends Object

Constructor Summary

Constructors

Constructor and Description
TemplatesApi()
TemplatesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)
void	templatesNameDelete(String name) Delete template with the specified ID
com.squareup.okhttp.Call	templatesNameDeleteAsync(String name, ApiCallback<Void> callback) Delete template with the specified ID (asynchronously)
com.squareup.okhttp.Call	templatesNameDeleteCall(String name, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for templatesNameDelete
ApiResponse<Void>	templatesNameDeleteWithHttpInfo(String name) Delete template with the specified ID
Template	templatesNameGet(String name) Load template with content
com.squareup.okhttp.Call	templatesNameGetAsync(String name, ApiCallback<Template> callback) Load template with content (asynchronously)
com.squareup.okhttp.Call	templatesNameGetCall(String name, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for templatesNameGet
ApiResponse<Template>	templatesNameGetWithHttpInfo(String name) Load template with content
Template	templatesNamePut(String name, Template body, Boolean removeScreenshot) Update existing template, overwriting existing data.
com.squareup.okhttp.Call	templatesNamePutAsync(String name, Template body, Boolean removeScreenshot, ApiCallback<Template> callback) Update existing template, overwriting existing data.
com.squareup.okhttp.Call	templatesNamePutCall(String name, Template body, Boolean removeScreenshot, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for templatesNamePut
ApiResponse<Template>	templatesNamePutWithHttpInfo(String name, Template body, Boolean removeScreenshot) Update existing template, overwriting existing data.
Template	templatesPost(Template body) Create new Template.
com.squareup.okhttp.Call	templatesPostAsync(Template body, ApiCallback<Template> callback) Create new Template.
com.squareup.okhttp.Call	templatesPostCall(Template body, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for templatesPost
ApiResponse<Template>	templatesPostWithHttpInfo(Template body) Create new Template.
TemplateTagList	templatesTagsGet() Retrieve a list of your Tags
com.squareup.okhttp.Call	templatesTagsGetAsync(ApiCallback<TemplateTagList> callback) Retrieve a list of your Tags (asynchronously)
com.squareup.okhttp.Call	templatesTagsGetCall(ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for templatesTagsGet
ApiResponse<TemplateTagList>	templatesTagsGetWithHttpInfo() Retrieve a list of your Tags
void	templatesTagsNameDelete(String name) Delete a tag, removing it from all Templates
com.squareup.okhttp.Call	templatesTagsNameDeleteAsync(String name, ApiCallback<Void> callback) Delete a tag, removing it from all Templates (asynchronously)
com.squareup.okhttp.Call	templatesTagsNameDeleteCall(String name, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for templatesTagsNameDelete
ApiResponse<Void>	templatesTagsNameDeleteWithHttpInfo(String name) Delete a tag, removing it from all Templates
TemplateTag	templatesTagsPost(String tagName) Create a new Tag to be used in your Templates
com.squareup.okhttp.Call	templatesTagsPostAsync(String tagName, ApiCallback<TemplateTag> callback) Create a new Tag to be used in your Templates (asynchronously)
com.squareup.okhttp.Call	templatesTagsPostCall(String tagName, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for templatesTagsPost
ApiResponse<TemplateTag>	templatesTagsPostWithHttpInfo(String tagName) Create a new Tag to be used in your Templates
List<Template>	templatesTypeListGet(String type, List<String> tags, Integer limit, Integer offset) Load a list of templates of a specified type
com.squareup.okhttp.Call	templatesTypeListGetAsync(String type, List<String> tags, Integer limit, Integer offset, ApiCallback<List<Template>> callback) Load a list of templates of a specified type (asynchronously)
com.squareup.okhttp.Call	templatesTypeListGetCall(String type, List<String> tags, Integer limit, Integer offset, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for templatesTypeListGet
ApiResponse<List<Template>>	templatesTypeListGetWithHttpInfo(String type, List<String> tags, Integer limit, Integer offset) Load a list of templates of a specified type

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplatesApi

public TemplatesApi()

TemplatesApi

public TemplatesApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

templatesNameDeleteCall

public com.squareup.okhttp.Call templatesNameDeleteCall(String name,
                                                        ProgressResponseBody.ProgressListener progressListener,
                                                        ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                 throws ApiException

Build call for templatesNameDelete

Parameters:

name - Name of template. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

templatesNameDelete

public void templatesNameDelete(String name)
                         throws ApiException

Delete template with the specified ID

Parameters:

name - Name of template. (required)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

templatesNameDeleteWithHttpInfo

public ApiResponse<Void> templatesNameDeleteWithHttpInfo(String name)
                                                  throws ApiException

Delete template with the specified ID

Parameters:

name - Name of template. (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

templatesNameDeleteAsync

public com.squareup.okhttp.Call templatesNameDeleteAsync(String name,
                                                         ApiCallback<Void> callback)
                                                  throws ApiException

Delete template with the specified ID (asynchronously)

Parameters:

name - Name of template. (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

templatesNameGetCall

public com.squareup.okhttp.Call templatesNameGetCall(String name,
                                                     ProgressResponseBody.ProgressListener progressListener,
                                                     ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                              throws ApiException

Build call for templatesNameGet

Parameters:

name - Name of template. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

templatesNameGet

public Template templatesNameGet(String name)
                          throws ApiException

Load template with content

Parameters:

name - Name of template. (required)

Returns:

Template

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

templatesNameGetWithHttpInfo

public ApiResponse<Template> templatesNameGetWithHttpInfo(String name)
                                                   throws ApiException

Load template with content

Parameters:

name - Name of template. (required)

Returns:

ApiResponse<Template>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

templatesNameGetAsync

public com.squareup.okhttp.Call templatesNameGetAsync(String name,
                                                      ApiCallback<Template> callback)
                                               throws ApiException

Load template with content (asynchronously)

Parameters:

name - Name of template. (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

templatesNamePutCall

public com.squareup.okhttp.Call templatesNamePutCall(String name,
                                                     Template body,
                                                     Boolean removeScreenshot,
                                                     ProgressResponseBody.ProgressListener progressListener,
                                                     ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                              throws ApiException

Build call for templatesNamePut

Parameters:

name - Name of template. (required)

body - (required)

removeScreenshot - (optional, default to True)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

templatesNamePut

public Template templatesNamePut(String name,
                                 Template body,
                                 Boolean removeScreenshot)
                          throws ApiException

Update existing template, overwriting existing data.

Parameters:

name - Name of template. (required)

body - (required)

removeScreenshot - (optional, default to True)

Returns:

Template

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

templatesNamePutWithHttpInfo

public ApiResponse<Template> templatesNamePutWithHttpInfo(String name,
                                                          Template body,
                                                          Boolean removeScreenshot)
                                                   throws ApiException

Update existing template, overwriting existing data.

Parameters:

name - Name of template. (required)

body - (required)

removeScreenshot - (optional, default to True)

Returns:

ApiResponse<Template>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

templatesNamePutAsync

public com.squareup.okhttp.Call templatesNamePutAsync(String name,
                                                      Template body,
                                                      Boolean removeScreenshot,
                                                      ApiCallback<Template> callback)
                                               throws ApiException

Update existing template, overwriting existing data. (asynchronously)

Parameters:

name - Name of template. (required)

body - (required)

removeScreenshot - (optional, default to True)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

templatesPostCall

public com.squareup.okhttp.Call templatesPostCall(Template body,
                                                  ProgressResponseBody.ProgressListener progressListener,
                                                  ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                           throws ApiException

Build call for templatesPost

Parameters:

body - (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

templatesPost

public Template templatesPost(Template body)
                       throws ApiException

Create new Template. Needs to be sent using POST method

Parameters:

body - (required)

Returns:

Template

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

templatesPostWithHttpInfo

public ApiResponse<Template> templatesPostWithHttpInfo(Template body)
                                                throws ApiException

Create new Template. Needs to be sent using POST method

Parameters:

body - (required)

Returns:

ApiResponse<Template>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

templatesPostAsync

public com.squareup.okhttp.Call templatesPostAsync(Template body,
                                                   ApiCallback<Template> callback)
                                            throws ApiException

Create new Template. Needs to be sent using POST method (asynchronously)

Parameters:

body - (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

templatesTagsGetCall

public com.squareup.okhttp.Call templatesTagsGetCall(ProgressResponseBody.ProgressListener progressListener,
                                                     ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                              throws ApiException

Build call for templatesTagsGet

Parameters:

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

templatesTagsGet

public TemplateTagList templatesTagsGet()
                                 throws ApiException

Retrieve a list of your Tags

Returns:

TemplateTagList

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

templatesTagsGetWithHttpInfo

public ApiResponse<TemplateTagList> templatesTagsGetWithHttpInfo()
                                                          throws ApiException

Retrieve a list of your Tags

Returns:

ApiResponse<TemplateTagList>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

templatesTagsGetAsync

public com.squareup.okhttp.Call templatesTagsGetAsync(ApiCallback<TemplateTagList> callback)
                                               throws ApiException

Retrieve a list of your Tags (asynchronously)

Parameters:

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

templatesTagsNameDeleteCall

public com.squareup.okhttp.Call templatesTagsNameDeleteCall(String name,
                                                            ProgressResponseBody.ProgressListener progressListener,
                                                            ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                     throws ApiException

Build call for templatesTagsNameDelete

Parameters:

name - (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

templatesTagsNameDelete

public void templatesTagsNameDelete(String name)
                             throws ApiException

Delete a tag, removing it from all Templates

Parameters:

name - (required)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

templatesTagsNameDeleteWithHttpInfo

public ApiResponse<Void> templatesTagsNameDeleteWithHttpInfo(String name)
                                                      throws ApiException

Delete a tag, removing it from all Templates

Parameters:

name - (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

templatesTagsNameDeleteAsync

public com.squareup.okhttp.Call templatesTagsNameDeleteAsync(String name,
                                                             ApiCallback<Void> callback)
                                                      throws ApiException

Delete a tag, removing it from all Templates (asynchronously)

Parameters:

name - (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

templatesTagsPostCall

public com.squareup.okhttp.Call templatesTagsPostCall(String tagName,
                                                      ProgressResponseBody.ProgressListener progressListener,
                                                      ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                               throws ApiException

Build call for templatesTagsPost

Parameters:

tagName - (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

templatesTagsPost

public TemplateTag templatesTagsPost(String tagName)
                              throws ApiException

Create a new Tag to be used in your Templates

Parameters:

tagName - (required)

Returns:

TemplateTag

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

templatesTagsPostWithHttpInfo

public ApiResponse<TemplateTag> templatesTagsPostWithHttpInfo(String tagName)
                                                       throws ApiException

Create a new Tag to be used in your Templates

Parameters:

tagName - (required)

Returns:

ApiResponse<TemplateTag>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

templatesTagsPostAsync

public com.squareup.okhttp.Call templatesTagsPostAsync(String tagName,
                                                       ApiCallback<TemplateTag> callback)
                                                throws ApiException

Create a new Tag to be used in your Templates (asynchronously)

Parameters:

tagName - (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

templatesTypeListGetCall

public com.squareup.okhttp.Call templatesTypeListGetCall(String type,
                                                         List<String> tags,
                                                         Integer limit,
                                                         Integer offset,
                                                         ProgressResponseBody.ProgressListener progressListener,
                                                         ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                  throws ApiException

Build call for templatesTypeListGet

Parameters:

type - (required)

tags - (optional)

limit - Maximum of loaded items. (optional, default to 500)

offset - How many items should be loaded ahead. (optional, default to 0)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

templatesTypeListGet

public List<Template> templatesTypeListGet(String type,
                                           List<String> tags,
                                           Integer limit,
                                           Integer offset)
                                    throws ApiException

Load a list of templates of a specified type

Parameters:

type - (required)

tags - (optional)

limit - Maximum of loaded items. (optional, default to 500)

offset - How many items should be loaded ahead. (optional, default to 0)

Returns:

List<Template>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

templatesTypeListGetWithHttpInfo

public ApiResponse<List<Template>> templatesTypeListGetWithHttpInfo(String type,
                                                                    List<String> tags,
                                                                    Integer limit,
                                                                    Integer offset)
                                                             throws ApiException

Load a list of templates of a specified type

Parameters:

type - (required)

tags - (optional)

limit - Maximum of loaded items. (optional, default to 500)

offset - How many items should be loaded ahead. (optional, default to 0)

Returns:

ApiResponse<List<Template>>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

templatesTypeListGetAsync

public com.squareup.okhttp.Call templatesTypeListGetAsync(String type,
                                                          List<String> tags,
                                                          Integer limit,
                                                          Integer offset,
                                                          ApiCallback<List<Template>> callback)
                                                   throws ApiException

Load a list of templates of a specified type (asynchronously)

Parameters:

type - (required)

tags - (optional)

limit - Maximum of loaded items. (optional, default to 500)

offset - How many items should be loaded ahead. (optional, default to 0)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object