Package com.flagright.api.resources.consumeruserevents

Class ConsumerUserEventsClient

java.lang.Object

com.flagright.api.resources.consumeruserevents.ConsumerUserEventsClient

public class ConsumerUserEventsClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
ConsumerUserEventsClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
UserWithRulesResult	create(ConsumerUserEventsCreateRequest request)	POST Consumer User Events
UserWithRulesResult	create(ConsumerUserEventsCreateRequest request, RequestOptions requestOptions)	POST Consumer User Events
ConsumerUserEventWithRulesResult	get(java.lang.String eventId)	GET a Consumer User Event
ConsumerUserEventWithRulesResult	get(java.lang.String eventId, RequestOptions requestOptions)	GET a Consumer User Event
RawConsumerUserEventsClient	withRawResponse()	Get responses with HTTP metadata like headers

Methods inherited from class java.lang.Object

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

Field Detail

clientOptions

protected final ClientOptions clientOptions

Constructor Detail

ConsumerUserEventsClient

public ConsumerUserEventsClient(ClientOptions clientOptions)

Method Detail

withRawResponse

public RawConsumerUserEventsClient withRawResponse()

Get responses with HTTP metadata like headers

create

public UserWithRulesResult create(ConsumerUserEventsCreateRequest request)

POST Consumer User Events

/events/consumer/user endpoint allows you to operate on the Consumer User Events entity.

User events are created after the initial POST /consumer/users call (which creates a user) and are used to:

• Update the STATE and KYC Status of the user, using the userStateDetails or kycStatusDetails field
• Update the user details, using the updatedConsumerUserAttributes field.

If you have neither of the above two use cases, you do not need to use user events.

Payload

Each user event needs three mandatory fields:

• timestamp- the timestamp of when the event was created or occured in your system
• userId - The ID of the transaction for which this event is generated.

In order to make individual events retrievable, you also need to pass in a unique eventId to the request body.

create

public UserWithRulesResult create(ConsumerUserEventsCreateRequest request,
                                  RequestOptions requestOptions)

POST Consumer User Events

/events/consumer/user endpoint allows you to operate on the Consumer User Events entity.

User events are created after the initial POST /consumer/users call (which creates a user) and are used to:

• Update the STATE and KYC Status of the user, using the userStateDetails or kycStatusDetails field
• Update the user details, using the updatedConsumerUserAttributes field.

If you have neither of the above two use cases, you do not need to use user events.

Payload

Each user event needs three mandatory fields:

• timestamp- the timestamp of when the event was created or occured in your system
• userId - The ID of the transaction for which this event is generated.

In order to make individual events retrievable, you also need to pass in a unique eventId to the request body.

get

public ConsumerUserEventWithRulesResult get(java.lang.String eventId)

GET a Consumer User Event

You can retrieve any consumer user event you created using the POST Consumer User Events call.

get

public ConsumerUserEventWithRulesResult get(java.lang.String eventId,
                                            RequestOptions requestOptions)

GET a Consumer User Event

You can retrieve any consumer user event you created using the POST Consumer User Events call.