dist¶

Interfaces¶

SalesforceCaseCommentInput¶

Properties¶

body?¶

optional body?: string;

caseId?¶

optional caseId?: string;

comment?¶

optional comment?: string;

fields?¶

optional fields?: SalesforceProviderPayload;

isPublished?¶

optional isPublished?: boolean;

text?¶

optional text?: string;

ticketId?¶

optional ticketId?: string;

SalesforceCaseInput¶

Extended by¶

SalesforceUpdateCaseInput

Properties¶

accountId?¶

optional accountId?: string;

contactId?¶

optional contactId?: string;

description?¶

optional description?: string;

fields?¶

optional fields?: SalesforceProviderPayload;

origin?¶

optional origin?: string;

ownerId?¶

optional ownerId?: string;

priority?¶

optional priority?: string;

status?¶

optional status?: string;

subject?¶

optional subject?: string;

suppliedEmail?¶

optional suppliedEmail?: string;

suppliedName?¶

optional suppliedName?: string;

SalesforceCaseSearchInput¶

Properties¶

limit?¶

optional limit?: number;

where?¶

optional where?: string;

SalesforceInternalNoteInput¶

Properties¶

body?¶

optional body?: string;

caseId?¶

optional caseId?: string;

fields?¶

optional fields?: SalesforceProviderPayload;

note?¶

optional note?: string;

text?¶

optional text?: string;

ticketId?¶

optional ticketId?: string;

type?¶

optional type?: string;

visibility?¶

optional visibility?: string;

SalesforceProviderPayload¶

Indexable¶

[key: string]: SalesforceProviderValue

SalesforceReadCaseInput¶

Extended by¶

SalesforceUpdateCaseInput

Properties¶

id?¶

optional id?: string;

ticketId?¶

optional ticketId?: string;

SalesforceSoqlQueryInput¶

Properties¶

query?¶

optional query?: string;

soql?¶

optional soql?: string;

SalesforceTicketingClient¶

Extends¶

SalesforceTicketingOperationsClient

Properties¶

integration¶

integration: DefinedIntegration<ProviderManifestAuthorInput>;

rawClient¶

rawClient: SalesforceTicketingRawClient;

Methods¶

createCase()¶

createCase(input): Promise<unknown>;

Parameters¶

Parameter	Type
`input`	`SalesforceCaseInput`

Returns¶

Promise\<unknown>

Inherited from¶

SalesforceTicketingOperationsClient.createCase

createCaseComment()¶

createCaseComment(input): Promise<unknown>;

Parameters¶

Parameter	Type
`input`	`SalesforceCaseCommentInput`

Returns¶

Promise\<unknown>

Inherited from¶

SalesforceTicketingOperationsClient.createCaseComment

createInternalNote()¶

createInternalNote(input): Promise<unknown>;

Parameters¶

Parameter	Type
`input`	`SalesforceInternalNoteInput`

Returns¶

Promise\<unknown>

Inherited from¶

SalesforceTicketingOperationsClient.createInternalNote

getCase()¶

getCase(caseId): Promise<unknown>;

Parameters¶

Parameter	Type
`caseId`	`string`

Returns¶

Promise\<unknown>

Inherited from¶

SalesforceTicketingOperationsClient.getCase

getRawClient()¶

getRawClient(): SalesforceTicketingRawClient;

Returns¶

SalesforceTicketingRawClient

Inherited from¶

SalesforceTicketingOperationsClient.getRawClient

querySoql()¶

querySoql(soql): Promise<unknown>;

Parameters¶

Parameter	Type
`soql`	`string`

Returns¶

Promise\<unknown>

Inherited from¶

SalesforceTicketingOperationsClient.querySoql

searchCases()¶

searchCases(input?): Promise<unknown>;

Parameters¶

Parameter	Type
`input?`	`SalesforceCaseSearchInput`

Returns¶

Promise\<unknown>

Inherited from¶

SalesforceTicketingOperationsClient.searchCases

updateCase()¶

updateCase(caseId, patch): Promise<unknown>;

Parameters¶

Parameter	Type
`caseId`	`string`
`patch`	`SalesforceCaseInput`

Returns¶

Promise\<unknown>

Inherited from¶

SalesforceTicketingOperationsClient.updateCase

SalesforceTicketingClientOptions¶

Properties¶

accessToken?¶

optional accessToken?: string;

instanceUrl?¶

optional instanceUrl?: string;

rawClient?¶

optional rawClient?: SalesforceTicketingRawClient;

SalesforceTicketingOperationsClient¶

Extended by¶

SalesforceTicketingClient

Methods¶

createCase()¶

createCase(input): Promise<unknown>;

Parameters¶

Parameter	Type
`input`	`SalesforceCaseInput`

Returns¶

Promise\<unknown>

createCaseComment()¶

createCaseComment(input): Promise<unknown>;

Parameters¶

Parameter	Type
`input`	`SalesforceCaseCommentInput`

Returns¶

Promise\<unknown>

createInternalNote()¶

createInternalNote(input): Promise<unknown>;

Parameters¶

Parameter	Type
`input`	`SalesforceInternalNoteInput`

Returns¶

Promise\<unknown>

getCase()¶

getCase(caseId): Promise<unknown>;

Parameters¶

Parameter	Type
`caseId`	`string`

Returns¶

Promise\<unknown>

getRawClient()¶

getRawClient(): SalesforceTicketingRawClient;

Returns¶

SalesforceTicketingRawClient

querySoql()¶

querySoql(soql): Promise<unknown>;

Parameters¶

Parameter	Type
`soql`	`string`

Returns¶

Promise\<unknown>

searchCases()¶

searchCases(input?): Promise<unknown>;

Parameters¶

Parameter	Type
`input?`	`SalesforceCaseSearchInput`

Returns¶

Promise\<unknown>

updateCase()¶

updateCase(caseId, patch): Promise<unknown>;

Parameters¶

Parameter	Type
`caseId`	`string`
`patch`	`SalesforceCaseInput`

Returns¶

Promise\<unknown>

SalesforceTicketingRawClient¶

Methods¶

query()¶

query(soql): PromiseLike<unknown>;

Parameters¶

Parameter	Type
`soql`	`string`

Returns¶

PromiseLike\<unknown>

sobject()¶

sobject(name): {
  create: Promise<unknown>;
  retrieve: Promise<unknown>;
  update: Promise<unknown>;
};

Parameters¶

Parameter	Type
`name`	`string`

Returns¶

{
  create: Promise<unknown>;
  retrieve: Promise<unknown>;
  update: Promise<unknown>;
}

Name	Type
`create()`	(`input`) => `Promise`\<`unknown`>
`retrieve()`	(`id`) => `Promise`\<`unknown`>
`update()`	(`input`) => `Promise`\<`unknown`>

SalesforceUpdateCaseInput¶

Extends¶

SalesforceCaseInput.SalesforceReadCaseInput

Properties¶

accountId?¶

optional accountId?: string;

Inherited from¶

SalesforceCaseInput.accountId

contactId?¶

optional contactId?: string;

Inherited from¶

SalesforceCaseInput.contactId

description?¶

optional description?: string;

Inherited from¶

SalesforceCaseInput.description

fields?¶

optional fields?: SalesforceProviderPayload;

Inherited from¶

SalesforceCaseInput.fields

id?¶

optional id?: string;

Inherited from¶

SalesforceReadCaseInput.id

origin?¶

optional origin?: string;

Inherited from¶

SalesforceCaseInput.origin

ownerId?¶

optional ownerId?: string;

Inherited from¶

SalesforceCaseInput.ownerId

patch?¶

optional patch?: SalesforceCaseInput;

priority?¶

optional priority?: string;

Inherited from¶

SalesforceCaseInput.priority

status?¶

optional status?: string;

Inherited from¶

SalesforceCaseInput.status

subject?¶

optional subject?: string;

Inherited from¶

SalesforceCaseInput.subject

suppliedEmail?¶

optional suppliedEmail?: string;

Inherited from¶

SalesforceCaseInput.suppliedEmail

suppliedName?¶

optional suppliedName?: string;

Inherited from¶

SalesforceCaseInput.suppliedName

ticketId?¶

optional ticketId?: string;

Inherited from¶

SalesforceReadCaseInput.ticketId

Type Aliases¶

SalesforceProviderPrimitive¶

type SalesforceProviderPrimitive = string | number | boolean | null;

SalesforceProviderValue¶

type SalesforceProviderValue =
  | SalesforceProviderPrimitive
  | SalesforceProviderPayload
  | readonly SalesforceProviderValue[];

SalesforceTicketingOperationAlias¶

type SalesforceTicketingOperationAlias = string;

SalesforceTicketingSdkClient¶

type SalesforceTicketingSdkClient = InstanceType<typeof jsforce.Connection>;

Variables¶

salesforceTicketingProviderOperations¶

const salesforceTicketingProviderOperations: ProviderOperationDeclarationInput[];

Functions¶

createSalesforceTicketingClient()¶

function createSalesforceTicketingClient(options?): SalesforceTicketingClient;

Parameters¶

Parameter	Type
`options?`	`SalesforceTicketingClientOptions`

Returns¶

SalesforceTicketingClient

createSalesforceTicketingOperationHandlers()¶

function createSalesforceTicketingOperationHandlers(clientOrRawClient): IntegrationOperationHandlers;

Parameters¶

Parameter	Type
`clientOrRawClient`	\| `SalesforceTicketingOperationsClient` \| `SalesforceTicketingRawClient`

Returns¶

IntegrationOperationHandlers

createSalesforceTicketingOperationsClient()¶

function createSalesforceTicketingOperationsClient(rawClient): Omit<SalesforceTicketingClient, "integration">;

Parameters¶

Parameter	Type
`rawClient`	`SalesforceTicketingRawClient`

Returns¶

Omit\<SalesforceTicketingClient, "integration">

References¶

salesforceTicketingProviderManifest¶

Re-exports salesforceTicketingProviderManifest