sibApi

Class AttributesApi

java.lang.Object

sibApi.AttributesApi

public class AttributesApi
extends Object

Constructor Summary

Constructors

Constructor and Description
AttributesApi()
AttributesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
void	createAttribute(String attributeCategory, String attributeName, CreateAttribute createAttribute) Create contact attribute
com.squareup.okhttp.Call	createAttributeAsync(String attributeCategory, String attributeName, CreateAttribute createAttribute, ApiCallback<Void> callback) Create contact attribute (asynchronously)
com.squareup.okhttp.Call	createAttributeCall(String attributeCategory, String attributeName, CreateAttribute createAttribute, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for createAttribute
ApiResponse<Void>	createAttributeWithHttpInfo(String attributeCategory, String attributeName, CreateAttribute createAttribute) Create contact attribute
void	deleteAttribute(String attributeCategory, String attributeName) Delete an attribute
com.squareup.okhttp.Call	deleteAttributeAsync(String attributeCategory, String attributeName, ApiCallback<Void> callback) Delete an attribute (asynchronously)
com.squareup.okhttp.Call	deleteAttributeCall(String attributeCategory, String attributeName, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for deleteAttribute
ApiResponse<Void>	deleteAttributeWithHttpInfo(String attributeCategory, String attributeName) Delete an attribute
ApiClient	getApiClient()
GetAttributes	getAttributes() List all attributes
com.squareup.okhttp.Call	getAttributesAsync(ApiCallback<GetAttributes> callback) List all attributes (asynchronously)
com.squareup.okhttp.Call	getAttributesCall(ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getAttributes
ApiResponse<GetAttributes>	getAttributesWithHttpInfo() List all attributes
void	setApiClient(ApiClient apiClient)
void	updateAttribute(String attributeCategory, String attributeName, UpdateAttribute updateAttribute) Update contact attribute
com.squareup.okhttp.Call	updateAttributeAsync(String attributeCategory, String attributeName, UpdateAttribute updateAttribute, ApiCallback<Void> callback) Update contact attribute (asynchronously)
com.squareup.okhttp.Call	updateAttributeCall(String attributeCategory, String attributeName, UpdateAttribute updateAttribute, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for updateAttribute
ApiResponse<Void>	updateAttributeWithHttpInfo(String attributeCategory, String attributeName, UpdateAttribute updateAttribute) Update contact attribute

Methods inherited from class java.lang.Object

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

Constructor Detail

AttributesApi

public AttributesApi()

AttributesApi

public AttributesApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createAttributeCall

public com.squareup.okhttp.Call createAttributeCall(String attributeCategory,
                                                    String attributeName,
                                                    CreateAttribute createAttribute,
                                                    ProgressResponseBody.ProgressListener progressListener,
                                                    ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                             throws ApiException

Build call for createAttribute

Parameters:

attributeCategory - Category of the attribute (required)

attributeName - Name of the attribute (required)

createAttribute - Values to create an attribute (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

createAttribute

public void createAttribute(String attributeCategory,
                            String attributeName,
                            CreateAttribute createAttribute)
                     throws ApiException

Create contact attribute

Parameters:

attributeCategory - Category of the attribute (required)

attributeName - Name of the attribute (required)

createAttribute - Values to create an attribute (required)

Throws:

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

createAttributeWithHttpInfo

public ApiResponse<Void> createAttributeWithHttpInfo(String attributeCategory,
                                                     String attributeName,
                                                     CreateAttribute createAttribute)
                                              throws ApiException

Create contact attribute

Parameters:

attributeCategory - Category of the attribute (required)

attributeName - Name of the attribute (required)

createAttribute - Values to create an attribute (required)

Returns:

ApiResponse<Void>

Throws:

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

createAttributeAsync

public com.squareup.okhttp.Call createAttributeAsync(String attributeCategory,
                                                     String attributeName,
                                                     CreateAttribute createAttribute,
                                                     ApiCallback<Void> callback)
                                              throws ApiException

Create contact attribute (asynchronously)

Parameters:

attributeCategory - Category of the attribute (required)

attributeName - Name of the attribute (required)

createAttribute - Values to create an attribute (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

deleteAttributeCall

public com.squareup.okhttp.Call deleteAttributeCall(String attributeCategory,
                                                    String attributeName,
                                                    ProgressResponseBody.ProgressListener progressListener,
                                                    ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                             throws ApiException

Build call for deleteAttribute

Parameters:

attributeCategory - Category of the attribute (required)

attributeName - Name of the existing attribute (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

deleteAttribute

public void deleteAttribute(String attributeCategory,
                            String attributeName)
                     throws ApiException

Delete an attribute

Parameters:

attributeCategory - Category of the attribute (required)

attributeName - Name of the existing attribute (required)

Throws:

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

deleteAttributeWithHttpInfo

public ApiResponse<Void> deleteAttributeWithHttpInfo(String attributeCategory,
                                                     String attributeName)
                                              throws ApiException

Delete an attribute

Parameters:

attributeCategory - Category of the attribute (required)

attributeName - Name of the existing attribute (required)

Returns:

ApiResponse<Void>

Throws:

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

deleteAttributeAsync

public com.squareup.okhttp.Call deleteAttributeAsync(String attributeCategory,
                                                     String attributeName,
                                                     ApiCallback<Void> callback)
                                              throws ApiException

Delete an attribute (asynchronously)

Parameters:

attributeCategory - Category of the attribute (required)

attributeName - Name of the existing attribute (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

getAttributesCall

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

Build call for getAttributes

Parameters:

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getAttributes

public GetAttributes getAttributes()
                            throws ApiException

List all attributes

Returns:

GetAttributes

Throws:

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

getAttributesWithHttpInfo

public ApiResponse<GetAttributes> getAttributesWithHttpInfo()
                                                     throws ApiException

List all attributes

Returns:

ApiResponse<GetAttributes>

Throws:

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

getAttributesAsync

public com.squareup.okhttp.Call getAttributesAsync(ApiCallback<GetAttributes> callback)
                                            throws ApiException

List all attributes (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

updateAttributeCall

public com.squareup.okhttp.Call updateAttributeCall(String attributeCategory,
                                                    String attributeName,
                                                    UpdateAttribute updateAttribute,
                                                    ProgressResponseBody.ProgressListener progressListener,
                                                    ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                             throws ApiException

Build call for updateAttribute

Parameters:

attributeCategory - Category of the attribute (required)

attributeName - Name of the existing attribute (required)

updateAttribute - Values to update an attribute (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

updateAttribute

public void updateAttribute(String attributeCategory,
                            String attributeName,
                            UpdateAttribute updateAttribute)
                     throws ApiException

Update contact attribute

Parameters:

attributeCategory - Category of the attribute (required)

attributeName - Name of the existing attribute (required)

updateAttribute - Values to update an attribute (required)

Throws:

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

updateAttributeWithHttpInfo

public ApiResponse<Void> updateAttributeWithHttpInfo(String attributeCategory,
                                                     String attributeName,
                                                     UpdateAttribute updateAttribute)
                                              throws ApiException

Update contact attribute

Parameters:

attributeCategory - Category of the attribute (required)

attributeName - Name of the existing attribute (required)

updateAttribute - Values to update an attribute (required)

Returns:

ApiResponse<Void>

Throws:

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

updateAttributeAsync

public com.squareup.okhttp.Call updateAttributeAsync(String attributeCategory,
                                                     String attributeName,
                                                     UpdateAttribute updateAttribute,
                                                     ApiCallback<Void> callback)
                                              throws ApiException

Update contact attribute (asynchronously)

Parameters:

attributeCategory - Category of the attribute (required)

attributeName - Name of the existing attribute (required)

updateAttribute - Values to update an attribute (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