Package io.moov.sdk

Class Onboarding

java.lang.Object

io.moov.sdk.Onboarding

public class Onboarding
extends java.lang.Object

Method Summary

Modifier and Type	Method	Description
CreateOnboardingInviteRequestBuilder	createInvite()	Create an invitation containing a unique link that allows the recipient to onboard their organization with Moov.
CreateOnboardingInviteResponse	createInvite(OnboardingInviteRequest request)	Create an invitation containing a unique link that allows the recipient to onboard their organization with Moov.
GetOnboardingInviteRequestBuilder	getInvite()	Retrieve details about an onboarding invite.
GetOnboardingInviteResponse	getInvite(java.lang.String code)	Retrieve details about an onboarding invite.
ListOnboardingInvitesRequestBuilder	listInvites()	List all the onboarding invites created by the caller's account.
ListOnboardingInvitesResponse	listInvitesDirect()	List all the onboarding invites created by the caller's account.
RevokeOnboardingInviteRequestBuilder	revokeInvite()	Revoke an onboarding invite, rendering the invitation link unusable.
RevokeOnboardingInviteResponse	revokeInvite(java.lang.String code)	Revoke an onboarding invite, rendering the invitation link unusable.

Methods inherited from class java.lang.Object

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

Method Detail

createInvite

public CreateOnboardingInviteRequestBuilder createInvite()

Create an invitation containing a unique link that allows the recipient to onboard their organization with Moov.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts.write` scope.

Returns:

The call builder

createInvite

public CreateOnboardingInviteResponse createInvite(OnboardingInviteRequest request)
                                            throws java.lang.Exception

Create an invitation containing a unique link that allows the recipient to onboard their organization with Moov.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts.write` scope.

Parameters:

request - The request object containing all the parameters for the API call.

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

listInvites

public ListOnboardingInvitesRequestBuilder listInvites()

List all the onboarding invites created by the caller's account.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts.read` scope.

Returns:

The call builder

listInvitesDirect

public ListOnboardingInvitesResponse listInvitesDirect()
                                                throws java.lang.Exception

List all the onboarding invites created by the caller's account.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts.read` scope.

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

getInvite

public GetOnboardingInviteRequestBuilder getInvite()

Retrieve details about an onboarding invite.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts.read` scope.

Returns:

The call builder

getInvite

public GetOnboardingInviteResponse getInvite(java.lang.String code)
                                      throws java.lang.Exception

Retrieve details about an onboarding invite.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts.read` scope.

Parameters:

code -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

revokeInvite

public RevokeOnboardingInviteRequestBuilder revokeInvite()

Revoke an onboarding invite, rendering the invitation link unusable.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts.write` scope.

Returns:

The call builder

revokeInvite

public RevokeOnboardingInviteResponse revokeInvite(java.lang.String code)
                                            throws java.lang.Exception

Revoke an onboarding invite, rendering the invitation link unusable.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts.write` scope.

Parameters:

code -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails