Class Firesquad

Hierarchy

Firesquad

Constructors

constructor

new Firesquad(apiUrl: string, apiId: string, apiKey: string): Firesquad

- Defined in index.ts:1494
Creates a Firesquad SDK Instance.

Parameters
- apiUrl: string
  
  Root URL assigned to your account.
- apiId: string
  
  ID of the integration.
- apiKey: string
  
  API Secret to authenticate.
Returns Firesquad

Properties

Private apiId

apiId: string

Private apiKey

apiKey: string

Private apiUrl

apiUrl: string

Private token

token: string

Methods

Authenticate

Authenticate(data: VisitorInput, visitorId: string): Promise<Visitor>

- Defined in index.ts:2257
Authenticates an user via webhook auth.

Only available For Widget Authention APIs.*

Parameters
- data: VisitorInput
- visitorId: string
Returns Promise<Visitor>

CloseConversation

CloseConversation(id: string): Promise<Conversation>

- Defined in index.ts:2284
Mark this conversation as closed.

Requires "conversation:close-conversation" permission.*

Parameters
- id: string
Returns Promise<Conversation>

Conversation

Conversation(id: string): Promise<Conversation>

- Defined in index.ts:1614
Retrieves a conversation.

Requires "conversation:query" permission.*

Parameters
- id: string
Returns Promise<Conversation>

CreateConversation

CreateConversation(data: ConversationItemInput, inboxId: string, visitorId: string): Promise<Conversation>

- Defined in index.ts:2755
Creates a new conversation.

Requires "conversation:create-conversation" permission.*

Parameters
- data: ConversationItemInput
- inboxId: string
- visitorId: string
Returns Promise<Conversation>

CreateStatusPageEventHistoryItem

CreateStatusPageEventHistoryItem(data: StatusPageEventHistoryItemInput, eventId: string): Promise<StatusPageEventHistoryItem>

- Defined in index.ts:3226
Creates a new history item for an event.

Requires "status-page:write" permission.*

Parameters
- data: StatusPageEventHistoryItemInput
- eventId: string
Returns Promise<StatusPageEventHistoryItem>

CreateStatusPageIncident

CreateStatusPageIncident(data: StatusPageIncidentCreationInput): Promise<StatusPageEvent>

- Defined in index.ts:3252
Creates a new incident event.

Requires "status-page:write" permission.*

Parameters
- data: StatusPageIncidentCreationInput
Returns Promise<StatusPageEvent>

DeleteStatusPageEventHistoryItem

DeleteStatusPageEventHistoryItem(id: string): Promise<GenericResponse>

- Defined in index.ts:3310
Deletes an existing history item for an event.

Requires "status-page:write" permission.*

Parameters
- id: string
Returns Promise<GenericResponse>

MoveConversation

MoveConversation(id: string, inboxId: string): Promise<Conversation>

- Defined in index.ts:3325
Move conversation to another inbox.

Requires "conversation:move-conversation" permission.*

Parameters
- id: string
- inboxId: string
Returns Promise<Conversation>

PostConversationItem

PostConversationItem(data: ConversationItemInput, id: string): Promise<ConversationItem>

- Defined in index.ts:3796
Post a message into the conversation.

Requires "conversation:post-conversation-item" permission.*

Parameters
- data: ConversationItemInput
- id: string
Returns Promise<ConversationItem>

RemoveStatusPageEvent

RemoveStatusPageEvent(id: string): Promise<GenericResponse>

- Defined in index.ts:4235
Deletes an existing event.

Requires "status-page:write" permission.*

Parameters
- id: string
Returns Promise<GenericResponse>

UpdateAttributes

UpdateAttributes(attributes: VisitorAttributeCategoryInput[], visitorId: string): Promise<Visitor>

- Defined in index.ts:4250
Updates user attributes (showed on the dashboard UI) of an existing visitor.

Requires "visitor:update-attributes" permission.*

Parameters
- attributes: VisitorAttributeCategoryInput[]
- visitorId: string
Returns Promise<Visitor>

UpdateConversationItem

UpdateConversationItem(data: ConversationItemUpdate, id: string): Promise<ConversationItem>

- Defined in index.ts:4277
Updates the card and buttons of an already existing conversation message.

Requires "conversation:update-conversation-item" permission.*

Parameters
- data: ConversationItemUpdate
- id: string
Returns Promise<ConversationItem>

UpdateStatusPageEvent

UpdateStatusPageEvent(data: StatusPageEventUpdateInput, id: string): Promise<StatusPageEvent>

- Defined in index.ts:4716
Updates an existing event.

Requires "status-page:write" permission.*

Parameters
- data: StatusPageEventUpdateInput
- id: string
Returns Promise<StatusPageEvent>

UpdateStatusPageEventHistoryItem

UpdateStatusPageEventHistoryItem(data: StatusPageEventHistoryItemUpdateInput, id: string): Promise<StatusPageEventHistoryItem>

- Defined in index.ts:4774
Updates an existing history item for an event.

Requires "status-page:write" permission.*

Parameters
- data: StatusPageEventHistoryItemUpdateInput
- id: string
Returns Promise<StatusPageEventHistoryItem>

Visitor

Visitor(id: string): Promise<Visitor>

- Defined in index.ts:2085
Retrieves a visitor by ID.

Requires "visitor:query" permission.*

Parameters
- id: string
Returns Promise<Visitor>

doRequest

doRequest<key, res>(request: Request<key>): Promise<res[key]>

- Defined in index.ts:1586
This is a generic method to run requests to our GraphQL API. If the default methods does not match your needs, you can use this method to run your own requests.

Type parameters
- key: string | number | symbol
- res = Record<key, unknown>
Parameters
- request: Request<key>
  
  Request to send to the API.
Returns Promise<res[key]>
- Response from the API.

Private getToken

getToken(): Promise<string>

- Defined in index.ts:1562
Returns a local token if not expired.

Returns Promise<string>
- String token

Private refreshToken

refreshToken(): Promise<string>

- Defined in index.ts:1522
Retrieves a fresh token from the API.

Returns Promise<string>
- A new token

signPayload

signPayload(secret: string, payload: string): string

- Defined in index.ts:1514
This signs an authentication payload, used to validate your authentication with our API without transmitting your token, exchanging it to a short-timed JWT. If you're receiving websocket, use this to validate your x-signature-sha-256 header against your secret.

Parameters
- secret: string
  
  payload to sign.
- payload: string
  
  payload to sign.
Returns string
SHA-256 signature of the payload.

statusPageComponents

statusPageComponents(): Promise<StatusPageComponent[]>

- Defined in index.ts:2110
Components of this statuspage.

Returns Promise<StatusPageComponent[]>

statusPageEvent

statusPageEvent(id: string): Promise<StatusPageEvent>

- Defined in index.ts:2135
Returns a single event.

Requires "status-page:query" permission.*

Parameters
- id: string
Returns Promise<StatusPageEvent>

statusPageEvents

statusPageEvents(affectedComponents: string[], after: string, impact: StatusPageEventImpact[], maintenance: boolean, ongoing: boolean): Promise<StatusPageEvent[]>

- Defined in index.ts:2193
Return a list of events.

Requires "status-page:query" permission.*

Parameters
- affectedComponents: string[]
- after: string
- impact: StatusPageEventImpact[]
- maintenance: boolean
- ongoing: boolean
Returns Promise<StatusPageEvent[]>

Generated using TypeDoc