README.md

EmailAddresses

(emailAddresses())

Overview

Available Operations

• create - Create an email address
• get - Retrieve an email address
• delete - Delete an email address
• update - Update an email address

create

Create a new email address

Example Usage

package hello.world;

import com.clerk.backend_api.Clerk;
import com.clerk.backend_api.models.errors.SDKError;
import com.clerk.backend_api.models.operations.CreateEmailAddressRequestBody;
import com.clerk.backend_api.models.operations.CreateEmailAddressResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {
        try {
            Clerk sdk = Clerk.builder()
                .bearerAuth("<YOUR_BEARER_TOKEN_HERE>")
                .build();

            CreateEmailAddressRequestBody req = CreateEmailAddressRequestBody.builder()
                .build();

            CreateEmailAddressResponse res = sdk.emailAddresses().create()
                .request(req)
                .call();

            if (res.emailAddress().isPresent()) {
                // handle response
            }
        } catch (com.clerk.backend_api.models.errors.ClerkErrors e) {
            // handle exception
            throw e;
        } catch (SDKError e) {
            // handle exception
            throw e;
        } catch (Exception e) {
            // handle exception
            throw e;
        }

    }
}

Parameters

Parameter	Type	Required	Description
request	CreateEmailAddressRequestBody	✔️	The request object to use for the request.

Response

CreateEmailAddressResponse

Errors

Error Object	Status Code	Content Type
models/errors/ClerkErrors	400,401,403,404,422	application/json
models/errors/SDKError	4xx-5xx	*/*

get

Returns the details of an email address.

Example Usage

package hello.world;

import com.clerk.backend_api.Clerk;
import com.clerk.backend_api.models.errors.SDKError;
import com.clerk.backend_api.models.operations.GetEmailAddressResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {
        try {
            Clerk sdk = Clerk.builder()
                .bearerAuth("<YOUR_BEARER_TOKEN_HERE>")
                .build();

            GetEmailAddressResponse res = sdk.emailAddresses().get()
                .emailAddressId("<value>")
                .call();

            if (res.emailAddress().isPresent()) {
                // handle response
            }
        } catch (com.clerk.backend_api.models.errors.ClerkErrors e) {
            // handle exception
            throw e;
        } catch (SDKError e) {
            // handle exception
            throw e;
        } catch (Exception e) {
            // handle exception
            throw e;
        }

    }
}

Parameters

Parameter	Type	Required	Description
emailAddressId	String	✔️	The ID of the email address to retrieve

Response

GetEmailAddressResponse

Errors

Error Object	Status Code	Content Type
models/errors/ClerkErrors	400,401,403,404	application/json
models/errors/SDKError	4xx-5xx	*/*

delete

Delete the email address with the given ID

Example Usage

package hello.world;

import com.clerk.backend_api.Clerk;
import com.clerk.backend_api.models.errors.SDKError;
import com.clerk.backend_api.models.operations.DeleteEmailAddressResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {
        try {
            Clerk sdk = Clerk.builder()
                .bearerAuth("<YOUR_BEARER_TOKEN_HERE>")
                .build();

            DeleteEmailAddressResponse res = sdk.emailAddresses().delete()
                .emailAddressId("<value>")
                .call();

            if (res.deletedObject().isPresent()) {
                // handle response
            }
        } catch (com.clerk.backend_api.models.errors.ClerkErrors e) {
            // handle exception
            throw e;
        } catch (SDKError e) {
            // handle exception
            throw e;
        } catch (Exception e) {
            // handle exception
            throw e;
        }

    }
}

Parameters

Parameter	Type	Required	Description
emailAddressId	String	✔️	The ID of the email address to delete

Response

DeleteEmailAddressResponse

Errors

Error Object	Status Code	Content Type
models/errors/ClerkErrors	400,401,403,404	application/json
models/errors/SDKError	4xx-5xx	*/*

update

Updates an email address.

Example Usage

package hello.world;

import com.clerk.backend_api.Clerk;
import com.clerk.backend_api.models.errors.SDKError;
import com.clerk.backend_api.models.operations.UpdateEmailAddressRequestBody;
import com.clerk.backend_api.models.operations.UpdateEmailAddressResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {
        try {
            Clerk sdk = Clerk.builder()
                .bearerAuth("<YOUR_BEARER_TOKEN_HERE>")
                .build();

            UpdateEmailAddressResponse res = sdk.emailAddresses().update()
                .emailAddressId("<value>")
                .requestBody(UpdateEmailAddressRequestBody.builder()
                    .build())
                .call();

            if (res.emailAddress().isPresent()) {
                // handle response
            }
        } catch (com.clerk.backend_api.models.errors.ClerkErrors e) {
            // handle exception
            throw e;
        } catch (SDKError e) {
            // handle exception
            throw e;
        } catch (Exception e) {
            // handle exception
            throw e;
        }

    }
}

Parameters

Parameter	Type	Required	Description
emailAddressId	String	✔️	The ID of the email address to update
requestBody	Optional	➖	N/A

Response

UpdateEmailAddressResponse

Errors

Error Object	Status Code	Content Type
models/errors/ClerkErrors	400,401,403,404	application/json
models/errors/SDKError	4xx-5xx	*/*