ai.thirdwatch.api

Class CustomEventApi

java.lang.Object

ai.thirdwatch.api.CustomEventApi

public class CustomEventApi
extends Object

Constructor Summary

Constructors

Constructor and Description
CustomEventApi()
CustomEventApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
EventResponse	customEvent(Custom JSON) Use order_status to track the order processing workflow of a previously submitted order.
com.squareup.okhttp.Call	customEventAsync(Custom JSON, ApiCallback<EventResponse> callback) Use order_status to track the order processing workflow of a previously submitted order.
com.squareup.okhttp.Call	customEventCall(Custom JSON, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for customEvent
ApiResponse<EventResponse>	customEventWithHttpInfo(Custom JSON) Use order_status to track the order processing workflow of a previously submitted order.
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomEventApi

public CustomEventApi()

CustomEventApi

public CustomEventApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

customEventCall

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

Build call for customEvent

Parameters:

JSON - Pass order status to thirdwatch. Only `_userID` is required field. But this should contain custom info. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

customEvent

public EventResponse customEvent(Custom JSON)
                          throws ApiException

Use order_status to track the order processing workflow of a previously submitted order. Custom events and fields capture user behavior and differences not covered by our reserved events and fields. For example, a location tracking business can create a custom event called trackLocation with custom fields that are relevant.

Parameters:

JSON - Pass order status to thirdwatch. Only `_userID` is required field. But this should contain custom info. (required)

Returns:

EventResponse

Throws:

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

customEventWithHttpInfo

public ApiResponse<EventResponse> customEventWithHttpInfo(Custom JSON)
                                                   throws ApiException

Use order_status to track the order processing workflow of a previously submitted order. Custom events and fields capture user behavior and differences not covered by our reserved events and fields. For example, a location tracking business can create a custom event called trackLocation with custom fields that are relevant.

Parameters:

JSON - Pass order status to thirdwatch. Only `_userID` is required field. But this should contain custom info. (required)

Returns:

ApiResponse<EventResponse>

Throws:

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

customEventAsync

public com.squareup.okhttp.Call customEventAsync(Custom JSON,
                                                 ApiCallback<EventResponse> callback)
                                          throws ApiException

Use order_status to track the order processing workflow of a previously submitted order. (asynchronously) Custom events and fields capture user behavior and differences not covered by our reserved events and fields. For example, a location tracking business can create a custom event called trackLocation with custom fields that are relevant.

Parameters:

JSON - Pass order status to thirdwatch. Only `_userID` is required field. But this should contain custom info. (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