Skip to content

README.md

Latest commit

 

History

History
65 lines (42 loc) · 3.23 KB

README.md

File metadata and controls

65 lines (42 loc) · 3.23 KB

Templates

Warning

This SDK is DEPRECATED

Overview

Available Operations

  • preview - Preview changes to a template ⚠️ Deprecated

preview

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

⚠️ DEPRECATED: This will be removed in a future release, please migrate away from it as soon as possible.

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Clerk\Backend;

$sdk = Backend\ClerkBackend::builder()
    ->setSecurity(
        '<YOUR_BEARER_TOKEN_HERE>'
    )
    ->build();



$response = $sdk->templates->preview(
    templateType: '<value>',
    slug: '<value>',
    requestBody: $requestBody

);

if ($response->object !== null) {
    // handle response
}

Parameters

Parameter Type Required Description
templateType string ✔️ The type of template to preview
slug string ✔️ The slug of the template to preview
requestBody ?Operations\PreviewTemplateRequestBody ➖ Required parameters

Response

?Operations\PreviewTemplateResponse

Errors

Error Type Status Code Content Type
Errors\ClerkErrors 400, 401, 404, 422 application/json
Errors\SDKException 4XX, 5XX */*