Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.smokeball.com/llms.txt

Use this file to discover all available pages before exploring further.

@smokeballdev/smokeball-client-sdk

ā€‹
Interface: Api

Entry point for correspondence to Smokeball.

ā€‹
Methods

ā€‹
document()

document(request): void
Opens a Word document with the specified body content

ā€‹
Parameters

request
DocumentRequest the create request.

ā€‹
Returns

void

ā€‹
Example

const request: DocumentRequest = {
 // Specify the fields here.
};
// Opens pre-populated Word document.
sdk.correspondence.document(request);

ā€‹
email()

email(request): void
Opens pre-populated email window.

ā€‹
Parameters

request
EmailRequest the create request.

ā€‹
Returns

void

ā€‹
Example

const request: EmailRequest = {
 // Specify the fields here.
};
// Opens pre-populated email window.
sdk.correspondence.email(request);

ā€‹
form()

form(request): void
Opens pre-populated form/caption window (US only).

ā€‹
Parameters

request
FormRequest the create request.

ā€‹
Returns

void

ā€‹
Throws

NotImplementedException in AU/UK region

ā€‹
Example

const request: FormRequest = {
 // Specify the fields here.
};
// Opens form/caption selection window.
sdk.correspondence.form(request);

ā€‹
letter()

letter(request): void
Opens pre-populated letter window.

ā€‹
Parameters

request
LetterRequest the create request.

ā€‹
Returns

void

ā€‹
Example

const request: LetterRequest = {
 // Specify the fields here.
};
// Opens pre-populated email window.
sdk.correspondence.letter(request);