java.lang.Object
- io.moov.sdk.Onboarding

All Implemented Interfaces:: SDKMethodInterfaces.MethodCallCreateOnboardingInvite, SDKMethodInterfaces.MethodCallGetOnboardingInvite, SDKMethodInterfaces.MethodCallListOnboardingInvites, SDKMethodInterfaces.MethodCallRevokeOnboardingInvite

public class Onboarding
extends java.lang.Object
implements SDKMethodInterfaces.MethodCallCreateOnboardingInvite, SDKMethodInterfaces.MethodCallListOnboardingInvites, SDKMethodInterfaces.MethodCallGetOnboardingInvite, SDKMethodInterfaces.MethodCallRevokeOnboardingInvite

Method Summary

All Methods Instance Methods Concrete Methods
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 onboardingInviteRequest)`	Create an invitation containing a unique link that allows the recipient to onboard their organization with Moov.
`CreateOnboardingInviteResponse`	`createInvite(java.util.Optional<java.lang.String> xMoovVersion, OnboardingInviteRequest onboardingInviteRequest)`	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.
`GetOnboardingInviteResponse`	`getInvite(java.util.Optional<java.lang.String> xMoovVersion, java.lang.String code)`	Retrieve details about an onboarding invite.
`ListOnboardingInvitesRequestBuilder`	`listInvites()`	List all the onboarding invites created by the caller's account.
`ListOnboardingInvitesResponse`	`listInvites(java.util.Optional<java.lang.String> xMoovVersion)`	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.
`RevokeOnboardingInviteResponse`	`revokeInvite(java.util.Optional<java.lang.String> xMoovVersion, 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 onboardingInviteRequest)
                                            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:
    
    onboardingInviteRequest - Request to create an onboarding invite.
    
    Returns:
    
    The response from the API call
    
    Throws:
    
    java.lang.Exception - if the API call fails
  - createInvite
```
public CreateOnboardingInviteResponse createInvite(java.util.Optional<java.lang.String> xMoovVersion,
                                                   OnboardingInviteRequest onboardingInviteRequest)
                                            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.
    
    Specified by:
    
    createInvite in interface SDKMethodInterfaces.MethodCallCreateOnboardingInvite
    
    Parameters:
    
    xMoovVersion - Specify an API version. API versioning follows the format `vYYYY.QQ.BB`, where - `YYYY` is the year - `QQ` is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10) - `BB` is the build number, starting at `.01`, for subsequent builds in the same quarter. - For example, `v2024.01.00` is the initial release of the first quarter of 2024. The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.
    
    onboardingInviteRequest - Request to create an onboarding invite.
    
    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
  - listInvites
```
public ListOnboardingInvitesResponse listInvites(java.util.Optional<java.lang.String> xMoovVersion)
                                          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.
    
    Specified by:
    
    listInvites in interface SDKMethodInterfaces.MethodCallListOnboardingInvites
    
    Parameters:
    
    xMoovVersion - Specify an API version. API versioning follows the format `vYYYY.QQ.BB`, where - `YYYY` is the year - `QQ` is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10) - `BB` is the build number, starting at `.01`, for subsequent builds in the same quarter. - For example, `v2024.01.00` is the initial release of the first quarter of 2024. The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.
    
    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
  - getInvite
```
public GetOnboardingInviteResponse getInvite(java.util.Optional<java.lang.String> xMoovVersion,
                                             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.
    
    Specified by:
    
    getInvite in interface SDKMethodInterfaces.MethodCallGetOnboardingInvite
    
    Parameters:
    
    xMoovVersion - Specify an API version. API versioning follows the format `vYYYY.QQ.BB`, where - `YYYY` is the year - `QQ` is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10) - `BB` is the build number, starting at `.01`, for subsequent builds in the same quarter. - For example, `v2024.01.00` is the initial release of the first quarter of 2024. The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.
    
    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
  - revokeInvite
```
public RevokeOnboardingInviteResponse revokeInvite(java.util.Optional<java.lang.String> xMoovVersion,
                                                   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.
    
    Specified by:
    
    revokeInvite in interface SDKMethodInterfaces.MethodCallRevokeOnboardingInvite
    
    Parameters:
    
    xMoovVersion - Specify an API version. API versioning follows the format `vYYYY.QQ.BB`, where - `YYYY` is the year - `QQ` is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10) - `BB` is the build number, starting at `.01`, for subsequent builds in the same quarter. - For example, `v2024.01.00` is the initial release of the first quarter of 2024. The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.
    
    code -
    
    Returns:
    
    The response from the API call
    
    Throws:
    
    java.lang.Exception - if the API call fails

Class Onboarding

Method Summary

Methods inherited from class java.lang.Object

Method Detail

createInvite

createInvite

createInvite

listInvites

listInvitesDirect

listInvites

getInvite

getInvite

getInvite

revokeInvite

revokeInvite

revokeInvite