LukeParke/clerk-sdk-java

Fork 0

mirror of https://github.com/LukeHagar/clerk-sdk-java.git synced 2025-12-06 12:27:45 +00:00

Files

History

Kyle MacDonald 0d763fc89a initial commit with code

2024-06-13 13:51:50 -04:00

README.md

initial commit with code

2024-06-13 13:51:50 -04:00

README.md

Templates

(templates())

Available Operations

list - List all templates
get - Retrieve a template
upsert - Update a template for a given type and slug
revert - Revert a template
preview - Preview changes to a template
toggleDelivery - Toggle the delivery by Clerk for a template of a given type and slug

list

Returns a list of all templates. The templates are returned sorted by position.

Example Usage

package hello.world;

import com.clerk.backend_api.Clerk;
import com.clerk.backend_api.models.components.*;
import com.clerk.backend_api.models.components.Security;
import com.clerk.backend_api.models.operations.*;
import com.clerk.backend_api.utils.EventStream;
import java.math.BigDecimal;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import org.openapitools.jackson.nullable.JsonNullable;
import static java.util.Map.entry;

public class Application {

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

            GetTemplateListResponse res = sdk.templates().list()
                .templateType(TemplateType.SMS)
                .call();

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

Parameters

Parameter	Type	Required	Description
`templateType`	com.clerk.backend_api.models.operations.TemplateType	✔️	The type of templates to list (email or SMS)

Response

Optional<? extends com.clerk.backend_api.models.operations.GetTemplateListResponse>

Errors

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

get

Returns the details of a template

Example Usage

package hello.world;

import com.clerk.backend_api.Clerk;
import com.clerk.backend_api.models.components.*;
import com.clerk.backend_api.models.components.Security;
import com.clerk.backend_api.models.operations.*;
import com.clerk.backend_api.utils.EventStream;
import java.math.BigDecimal;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import org.openapitools.jackson.nullable.JsonNullable;
import static java.util.Map.entry;

public class Application {

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

            GetTemplateResponse res = sdk.templates().get()
                .templateType(PathParamTemplateType.SMS)
                .slug("<value>")
                .call();

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

Parameters

Parameter	Type	Required	Description
`templateType`	com.clerk.backend_api.models.operations.PathParamTemplateType	✔️	The type of templates to retrieve (email or SMS)
`slug`	String	✔️	The slug (i.e. machine-friendly name) of the template to retrieve

Response

Optional<? extends com.clerk.backend_api.models.operations.GetTemplateResponse>

Errors

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

upsert

Updates the existing template of the given type and slug

Example Usage

package hello.world;

import com.clerk.backend_api.Clerk;
import com.clerk.backend_api.models.components.*;
import com.clerk.backend_api.models.components.Security;
import com.clerk.backend_api.models.operations.*;
import com.clerk.backend_api.utils.EventStream;
import java.math.BigDecimal;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import org.openapitools.jackson.nullable.JsonNullable;
import static java.util.Map.entry;

public class Application {

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

            UpsertTemplateResponse res = sdk.templates().upsert()
                .templateType(UpsertTemplatePathParamTemplateType.SMS)
                .slug("<value>")
                .requestBody(UpsertTemplateRequestBody.builder()
                    .build())
                .call();

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

Parameters

Parameter	Type	Required	Description
`templateType`	com.clerk.backend_api.models.operations.UpsertTemplatePathParamTemplateType	✔️	The type of template to update
`slug`	String	✔️	The slug of the template to update
`requestBody`	Optional<? extends com.clerk.backend_api.models.operations.UpsertTemplateRequestBody>	➖	N/A

Response

Optional<? extends com.clerk.backend_api.models.operations.UpsertTemplateResponse>

Errors

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

revert

Reverts an updated template to its default state

Example Usage

package hello.world;

import com.clerk.backend_api.Clerk;
import com.clerk.backend_api.models.components.*;
import com.clerk.backend_api.models.components.Security;
import com.clerk.backend_api.models.operations.*;
import com.clerk.backend_api.utils.EventStream;
import java.math.BigDecimal;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import org.openapitools.jackson.nullable.JsonNullable;
import static java.util.Map.entry;

public class Application {

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

            RevertTemplateResponse res = sdk.templates().revert()
                .templateType(RevertTemplatePathParamTemplateType.EMAIL)
                .slug("<value>")
                .call();

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

Parameters

Parameter	Type	Required	Description
`templateType`	com.clerk.backend_api.models.operations.RevertTemplatePathParamTemplateType	✔️	The type of template to revert
`slug`	String	✔️	The slug of the template to revert

Response

Optional<? extends com.clerk.backend_api.models.operations.RevertTemplateResponse>

Errors

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

preview

Returns a preview of a template for a given template_type, slug and body

Example Usage

package hello.world;

import com.clerk.backend_api.Clerk;
import com.clerk.backend_api.models.components.*;
import com.clerk.backend_api.models.components.Security;
import com.clerk.backend_api.models.operations.*;
import com.clerk.backend_api.utils.EventStream;
import java.math.BigDecimal;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import org.openapitools.jackson.nullable.JsonNullable;
import static java.util.Map.entry;

public class Application {

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

            PreviewTemplateResponse res = sdk.templates().preview()
                .templateType("<value>")
                .slug("<value>")
                .requestBody(PreviewTemplateRequestBody.builder()
                    .build())
                .call();

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

Parameters

Parameter	Type	Required	Description
`templateType`	String	✔️	The type of template to preview
`slug`	String	✔️	The slug of the template to preview
`requestBody`	Optional<? extends com.clerk.backend_api.models.operations.PreviewTemplateRequestBody>	➖	Required parameters

Response

Optional<? extends com.clerk.backend_api.models.operations.PreviewTemplateResponse>

Errors

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

toggleDelivery

Toggles the delivery by Clerk for a template of a given type and slug. If disabled, Clerk will not deliver the resulting email or SMS. The app developer will need to listen to the email.created or sms.created webhooks in order to handle delivery themselves.

Example Usage

package hello.world;

import com.clerk.backend_api.Clerk;
import com.clerk.backend_api.models.components.*;
import com.clerk.backend_api.models.components.Security;
import com.clerk.backend_api.models.operations.*;
import com.clerk.backend_api.utils.EventStream;
import java.math.BigDecimal;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import org.openapitools.jackson.nullable.JsonNullable;
import static java.util.Map.entry;

public class Application {

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

            ToggleTemplateDeliveryResponse res = sdk.templates().toggleDelivery()
                .templateType(ToggleTemplateDeliveryPathParamTemplateType.EMAIL)
                .slug("<value>")
                .requestBody(ToggleTemplateDeliveryRequestBody.builder()
                    .build())
                .call();

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

Parameters

Parameter	Type	Required	Description
`templateType`	com.clerk.backend_api.models.operations.ToggleTemplateDeliveryPathParamTemplateType	✔️	The type of template to toggle delivery for
`slug`	String	✔️	The slug of the template for which to toggle delivery
`requestBody`	Optional<? extends com.clerk.backend_api.models.operations.ToggleTemplateDeliveryRequestBody>	➖	N/A

Response

Optional<? extends com.clerk.backend_api.models.operations.ToggleTemplateDeliveryResponse>

Errors

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

README.md Unescape Escape

Templates

Available Operations

list

Example Usage

Parameters

Response

Errors

get

Example Usage

Parameters

Response

Errors

upsert

Example Usage

Parameters

Response

Errors

revert

Example Usage

Parameters

Response

Errors

preview

Example Usage

Parameters

Response

Errors

toggleDelivery

Example Usage

Parameters

Response

Errors

README.md