Documentation

TemplatesApi extends BaseApi
in package

Table of Contents

Properties

$_olcInstance  : OlcInstance

Methods

__construct()  : mixed
BaseApi constructor.
all()  : array{message: string, data: array}
Get list of all templates <code> <?php $response = $olc->templates()->all([ //'page' => 1, //'pageSize' => 10, ]); ?> </code>
allByCategory()  : array{message: string, data: array}
Fetch all templates by the given category id <code> <?php // $response = $olc->templates()->getByCategory(); ?>
categories()  : array{message: string, data: array}
Fetch all template categories <code> <?php $response = $olc->templates()->categories(); ?> </code>
create()  : array{message: string, data: array{id: int, orgId: int, title: string, templateUrl: string, backTemplateUrl: string, templateType: string, thumbnailUrl: string, backThumbnailUrl: string, isShared: bool, creator: array{id: int, fullName: string}, product: array, envelopeType: array, createdAt: string, updatedAt: string}}
Create a template to the cloud storage <code> <?php $fileUrl = $olc->templates()->create([ 'title' => 'My Template', 'productId' => 3, 'jsonFile' => 'path/to/template.json', 'thumbnailFile' => 'path/to/thumbnail.jpg', 'backThumbnailFile' => 'path/to/back-thumbnail.jpg', 'fields' => [ [ 'key' => '{{CF.FIRST_NAME}}', 'value' => 'First Name', ], ], ]); ?> </code>
delete()  : array{message: string, data: array}
Remove a template by the given template id <code> <?php $response = $olc->templates()->delete(1); ?> </code>
duplicate()  : array{message: string, data: array}
Duplicates a template by the given id <code> <?php $response = $olc->templates()->duplicate(1); ?> </code>
get()  : array{message: string, data: array}
Get template against the given id <code> <?php $response = $olc->templates()->get(1); ?> </code>
update()  : array{message: string, data: array{id: int, orgId: int, title: string, templateUrl: string, backTemplateUrl: string, templateType: string, thumbnailUrl: string, backThumbnailUrl: string, isShared: bool, creator: array{id: int, fullName: string}, product: array, envelopeType: array, createdAt: string, updatedAt: string}}
Update a template by the given ID<br> **Note:** You can pass only the fields that you want to update. The rest will be kept as it is.<br> Providing one of the `jsonFile`, `thumbnailFile` or `backThumbnailFile` field, Must provide all of them once in order to upload files.<br> <code> <?php $fileUrl = $olc->templates()->update([ 'title' => 'My Template', #'jsonFile' => 'path/to/template.json', #'thumbnailFile' => 'path/to/thumbnail.jpg', #'backThumbnailFile' => 'path/to/back-thumbnail.jpg', #'fields' => [ # [ # 'key' => '{{CF.FIRST_NAME}}', # 'value' => 'First Name', # ], #], ]); ?> </code>'
upload()  : array{message: string, data: array{templatePath: string, thumbnailPath: string, backTemplatePath: string}}
Upload a template to the cloud storage <code> <?php $fileUrl = $olc->templates()->upload([ 'jsonFile' => 'path/to/template.json', 'thumbnailFile' => 'path/to/thumbnail.jpg', 'backThumbnailFile' => 'path/to/back-thumbnail.jpg', ]); ?> </code>
uploadFile()  : string
Upload an image file to cloud storage and returns the absolute image url <code> <?php $fileUrl = $olc->templates()->uploadFile('path/to/file.jpg'); ?> </code>
viewProof()  : array{message: string, data: array}
Get view proof against the given template id <code> <?php $response = $olc->templates()->viewProof(1); ?> </code>
getInstance()  : OlcInstance
Gets the OlcInstance that this API is associated with.

Properties

Methods

__construct()

BaseApi constructor.

public __construct(OlcInstance $_olcInstance) : mixed
Parameters
$_olcInstance : OlcInstance

OlcInstance that this API is associated with

all()

Get list of all templates <code> <?php $response = $olc->templates()->all([ //'page' => 1, //'pageSize' => 10, ]); ?> </code>

public all([array{page?: int, pageSize?: int, isShared?: bool} $params = [] ]) : array{message: string, data: array}
Parameters
$params : array{page?: int, pageSize?: int, isShared?: bool} = []

Parameters to send with the request.

Tags
throws
OlcRequestError

If the request fails.

Return values
array{message: string, data: array} —

The response data.

allByCategory()

Fetch all templates by the given category id <code> <?php // $response = $olc->templates()->getByCategory(); ?>

public allByCategory([array{categoryIds?: int, page?: int, pageSize?: int} $params = [] ]) : array{message: string, data: array}
Parameters
$params : array{categoryIds?: int, page?: int, pageSize?: int} = []

Parameters to send with the request.

Tags
throws
OlcRequestError

If the request fails.

Return values
array{message: string, data: array} —

The response data.

categories()

Fetch all template categories <code> <?php $response = $olc->templates()->categories(); ?> </code>

public categories() : array{message: string, data: array}
Tags
throws
OlcRequestError

If the request fails.

Return values
array{message: string, data: array} —

The response data.

create()

Create a template to the cloud storage <code> <?php $fileUrl = $olc->templates()->create([ 'title' => 'My Template', 'productId' => 3, 'jsonFile' => 'path/to/template.json', 'thumbnailFile' => 'path/to/thumbnail.jpg', 'backThumbnailFile' => 'path/to/back-thumbnail.jpg', 'fields' => [ [ 'key' => '{{CF.FIRST_NAME}}', 'value' => 'First Name', ], ], ]); ?> </code>

public create([number, jsonFile: string, thumbnailFile: string, backThumbnailFile: string, fields: array{key: string, value: string}} $params = [] ]) : array{message: string, data: array{id: int, orgId: int, title: string, templateUrl: string, backTemplateUrl: string, templateType: string, thumbnailUrl: string, backThumbnailUrl: string, isShared: bool, creator: array{id: int, fullName: string}, product: array, envelopeType: array, createdAt: string, updatedAt: string}}
Parameters
$params : number, jsonFile: string, thumbnailFile: string, backThumbnailFile: string, fields: array{key: string, value: string}} = []

Parameters to send with the request.

Tags
throws
OlcRequestError

If the request fails.

Return values
array{message: string, data: array{id: int, orgId: int, title: string, templateUrl: string, backTemplateUrl: string, templateType: string, thumbnailUrl: string, backThumbnailUrl: string, isShared: bool, creator: array{id: int, fullName: string}, product: array, envelopeType: array, createdAt: string, updatedAt: string}} —

The result of the request

delete()

Remove a template by the given template id <code> <?php $response = $olc->templates()->delete(1); ?> </code>

public delete(int $id) : array{message: string, data: array}
Parameters
$id : int

The template ID

Tags
throws
OlcRequestError

If the request fails.

todo

Check for the correct response

Return values
array{message: string, data: array} —

The response data.

duplicate()

Duplicates a template by the given id <code> <?php $response = $olc->templates()->duplicate(1); ?> </code>

public duplicate(int $id) : array{message: string, data: array}
Parameters
$id : int

The template ID

Tags
throws
OlcRequestError

If the request fails.

todo

Check for the correct response

Return values
array{message: string, data: array} —

The response data.

get()

Get template against the given id <code> <?php $response = $olc->templates()->get(1); ?> </code>

public get(int $id) : array{message: string, data: array}
Parameters
$id : int

The template ID

Tags
throws
OlcRequestError

If the request fails.

Return values
array{message: string, data: array} —

The response data.

update()

Update a template by the given ID<br> **Note:** You can pass only the fields that you want to update. The rest will be kept as it is.<br> Providing one of the `jsonFile`, `thumbnailFile` or `backThumbnailFile` field, Must provide all of them once in order to upload files.<br> <code> <?php $fileUrl = $olc->templates()->update([ 'title' => 'My Template', #'jsonFile' => 'path/to/template.json', #'thumbnailFile' => 'path/to/thumbnail.jpg', #'backThumbnailFile' => 'path/to/back-thumbnail.jpg', #'fields' => [ # [ # 'key' => '{{CF.FIRST_NAME}}', # 'value' => 'First Name', # ], #], ]); ?> </code>'

public update(int $id, array{title: string, jsonFile: string, thumbnailFile: string, backThumbnailFile: string, fields: array{key: string, value: string}} $fields) : array{message: string, data: array{id: int, orgId: int, title: string, templateUrl: string, backTemplateUrl: string, templateType: string, thumbnailUrl: string, backThumbnailUrl: string, isShared: bool, creator: array{id: int, fullName: string}, product: array, envelopeType: array, createdAt: string, updatedAt: string}}
Parameters
$id : int

The template ID.

$fields : array{title: string, jsonFile: string, thumbnailFile: string, backThumbnailFile: string, fields: array{key: string, value: string}}

Fields to update.

Tags
throws
OlcRequestError

If the request fails.

Return values
array{message: string, data: array{id: int, orgId: int, title: string, templateUrl: string, backTemplateUrl: string, templateType: string, thumbnailUrl: string, backThumbnailUrl: string, isShared: bool, creator: array{id: int, fullName: string}, product: array, envelopeType: array, createdAt: string, updatedAt: string}} —

The result of the request

upload()

Upload a template to the cloud storage <code> <?php $fileUrl = $olc->templates()->upload([ 'jsonFile' => 'path/to/template.json', 'thumbnailFile' => 'path/to/thumbnail.jpg', 'backThumbnailFile' => 'path/to/back-thumbnail.jpg', ]); ?> </code>

public upload(array{jsonFile: string, thumbnailFile: string, backThumbnailFile: string} $params) : array{message: string, data: array{templatePath: string, thumbnailPath: string, backTemplatePath: string}}
Parameters
$params : array{jsonFile: string, thumbnailFile: string, backThumbnailFile: string}

Parameters to send with the request.

Tags
throws
OlcRequestError

If the request fails.

Return values
array{message: string, data: array{templatePath: string, thumbnailPath: string, backTemplatePath: string}} —

The result of the request

uploadFile()

Upload an image file to cloud storage and returns the absolute image url <code> <?php $fileUrl = $olc->templates()->uploadFile('path/to/file.jpg'); ?> </code>

public uploadFile(int $filePath) : string
Parameters
$filePath : int

File path to the image

Tags
throws
OlcRequestError

If the request fails.

Return values
string —

The uploaded image url

viewProof()

Get view proof against the given template id <code> <?php $response = $olc->templates()->viewProof(1); ?> </code>

public viewProof(int $id) : array{message: string, data: array}
Parameters
$id : int

The template ID

Tags
throws
OlcRequestError

If the request fails.

todo

Check for the correct response

Return values
array{message: string, data: array} —

The response data.


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results