Package com.flagright.api.resources.businessuserevents

Class BusinessUserEventsClient

java.lang.Object

com.flagright.api.resources.businessuserevents.BusinessUserEventsClient

public class BusinessUserEventsClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
BusinessUserEventsClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
BusinessWithRulesResult	create(BusinessUserEventsCreateRequest request)	POST Business User Events
BusinessWithRulesResult	create(BusinessUserEventsCreateRequest request, RequestOptions requestOptions)	POST Business User Events
BusinessUserEventWithRulesResult	get(java.lang.String eventId)	GET a Business User Event
BusinessUserEventWithRulesResult	get(java.lang.String eventId, RequestOptions requestOptions)	GET a Business User Event
RawBusinessUserEventsClient	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

BusinessUserEventsClient

public BusinessUserEventsClient(ClientOptions clientOptions)

Method Detail

withRawResponse

public RawBusinessUserEventsClient withRawResponse()

Get responses with HTTP metadata like headers

create

public BusinessWithRulesResult create(BusinessUserEventsCreateRequest request)

POST Business User Events

/events/business/user endpoint allows you to operate on the Business User Events entity.

User events are created after the initial POST /business/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 updatedBusinessUserAttributes 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 BusinessWithRulesResult create(BusinessUserEventsCreateRequest request,
                                      RequestOptions requestOptions)

POST Business User Events

/events/business/user endpoint allows you to operate on the Business User Events entity.

User events are created after the initial POST /business/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 updatedBusinessUserAttributes 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 BusinessUserEventWithRulesResult get(java.lang.String eventId)

GET a Business User Event

You can retrieve any business user event you created using the POST Business User Events call.

get

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

GET a Business User Event

You can retrieve any business user event you created using the POST Business User Events call.