Skip to content

Latest commit

 

History

History
414 lines (310 loc) · 20.7 KB

README.md

File metadata and controls

414 lines (310 loc) · 20.7 KB
Raw

Templates

(templates())

Overview

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.errors.SDKError;
import com.clerk.backend_api.models.operations.GetTemplateListResponse;
import com.clerk.backend_api.models.operations.TemplateType;
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();

            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 (SDKError e) {
            // handle exception
            throw e;
        } catch (Exception e) {
            // handle exception
            throw e;
        }

    }
}

Parameters

Parameter Type Required Description
templateType TemplateType ✔️ The type of templates to list (email or SMS)

Response

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.errors.SDKError;
import com.clerk.backend_api.models.operations.GetTemplateResponse;
import com.clerk.backend_api.models.operations.PathParamTemplateType;
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();

            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 (SDKError e) {
            // handle exception
            throw e;
        } catch (Exception e) {
            // handle exception
            throw e;
        }

    }
}

Parameters

Parameter Type Required Description
templateType 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

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.errors.SDKError;
import com.clerk.backend_api.models.operations.UpsertTemplatePathParamTemplateType;
import com.clerk.backend_api.models.operations.UpsertTemplateRequestBody;
import com.clerk.backend_api.models.operations.UpsertTemplateResponse;
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();

            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 (SDKError e) {
            // handle exception
            throw e;
        } catch (Exception e) {
            // handle exception
            throw e;
        }

    }
}

Parameters

Parameter Type Required Description
templateType UpsertTemplatePathParamTemplateType ✔️ The type of template to update
slug String ✔️ The slug of the template to update
requestBody Optional ➖ N/A

Response

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.errors.SDKError;
import com.clerk.backend_api.models.operations.RevertTemplatePathParamTemplateType;
import com.clerk.backend_api.models.operations.RevertTemplateResponse;
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();

            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 (SDKError e) {
            // handle exception
            throw e;
        } catch (Exception e) {
            // handle exception
            throw e;
        }

    }
}

Parameters

Parameter Type Required Description
templateType RevertTemplatePathParamTemplateType ✔️ The type of template to revert
slug String ✔️ The slug of the template to revert

Response

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.errors.SDKError;
import com.clerk.backend_api.models.operations.PreviewTemplateRequestBody;
import com.clerk.backend_api.models.operations.PreviewTemplateResponse;
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();

            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 (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 ➖ Required parameters

Response

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.errors.SDKError;
import com.clerk.backend_api.models.operations.ToggleTemplateDeliveryPathParamTemplateType;
import com.clerk.backend_api.models.operations.ToggleTemplateDeliveryRequestBody;
import com.clerk.backend_api.models.operations.ToggleTemplateDeliveryResponse;
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();

            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 (SDKError e) {
            // handle exception
            throw e;
        } catch (Exception e) {
            // handle exception
            throw e;
        }

    }
}

Parameters

Parameter Type Required Description
templateType ToggleTemplateDeliveryPathParamTemplateType ✔️ The type of template to toggle delivery for
slug String ✔️ The slug of the template for which to toggle delivery
requestBody Optional ➖ N/A

Response

ToggleTemplateDeliveryResponse

Errors

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