Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →

@panora/sdk-typescript

Package Overview

Dependencies

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

Package was removed

Sorry, it seems this package was removed from the registry

@panora/sdk-typescript

The Panora SDK

1.1.1
unpublished
npm

Version published: 9 months ago

Weekly downloads: 0

Maintainers: 2

Weekly downloads

Created: 9 months ago

Source

PanoraSDK Typescript SDK 1.0.0

The Typescript SDK for PanoraSDK.

API version: 1.0.0
SDK version: 1.0.0

About the API

The Panora API description

Installation

npm install @panora/sdk-typescript

Authentication

To see whether an endpoint needs a specific type of authentication check the endpoint's documentation.

Access Token

The PanoraSDK API uses access tokens as a form of authentication. You can set the access token when initializing the SDK through the constructor:

const sdk = new PanoraSDK('YOUR_ACCESS_TOKEN')

Or through the setAccessToken method:

const sdk = new PanoraSDK()
sdk.setAccessToken('YOUR_ACCESS_TOKEN')

You can also set it for each service individually:

const sdk = new PanoraSDK()
sdk.main.setAccessToken('YOUR_ACCESS_TOKEN')

Sample Usage

Here is a simple program demonstrating usage of this SDK. It can also be found in the examples/src/index.ts file in this directory.

When running the sample make sure to use npm install to install all the dependencies.

import { PanoraSDK } from '@panora/sdk-typescript';


const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.main
    .appControllerGetHello();
  console.log(result);
})();

PanoraSDK Services

A list of all services and services methods.

Main

Method	Description
appControllerGetHello

Health

Method	Description
appControllerHealth

Protected

Method	Description
appControllerGetHello2

Auth

Method	Description
signUp	Register
signIn	Log In
getUsers	Get users
getApiKeys	Retrieve API Keys
generateApiKey	Create API Key

Connections

Method	Description
handleOAuthCallback	Capture oAuth callback
getConnections	List Connections

Webhook

Method	Description
createWebhookMetadata	Add webhook metadata
getWebhooksMetadata	Retrieve webhooks metadata
updateWebhookStatus	Update webhook status

LinkedUsers

Method	Description
addLinkedUser	Add Linked User
getLinkedUsers	Retrieve Linked Users
getLinkedUser	Retrieve a Linked User

Organisations

Method	Description
getOrganisations	Retrieve Organisations
createOrganisation	Create an Organisation

Projects

Method	Description
getProjects	Retrieve projects
createProject	Create a project

FieldMapping

Method	Description
getFieldMappingsEntities	Retrieve field mapping entities
getFieldMappings	Retrieve field mappings
getFieldMappingValues	Retrieve field mappings values
defineTargetField	Define target Field
mapField	Map Custom Field
getCustomProviderProperties	Retrieve Custom Properties

Events

Method	Description
getEvents	Retrieve Events

MagicLink

Method	Description
createMagicLink	Create a Magic Link
getMagicLinks	Retrieve Magic Links
getMagicLink	Retrieve a Magic Link

Passthrough

Method	Description
passthroughRequest	Make a passthrough request

CrmContacts

Method	Description
addContact	Create CRM Contact
getContacts	List a batch of CRM Contacts
updateContact	Update a CRM Contact
getContact	Retrieve a CRM Contact
addContacts	Add a batch of CRM Contacts

CrmDeals

Method	Description
addDeal	Create a Deal
getDeals	List a batch of Deals
getDeal	Retrieve a Deal
updateDeal	Update a Deal
addDeals	Add a batch of Deals

CrmNotes

Method	Description
addNote	Create a Note
getNotes	List a batch of Notes
getNote	Retrieve a Note
addNotes	Add a batch of Notes

CrmCompanies

Method	Description
addCompany	Create a Company
getCompanies	List a batch of Companies
updateCompany	Update a Company
getCompany	Retrieve a Company
addCompanies	Add a batch of Companies

CrmEngagements

Method	Description
addEngagement	Create a Engagement
getEngagements	List a batch of Engagements
updateEngagement	Update a Engagement
getEngagement	Retrieve a Engagement
addEngagements	Add a batch of Engagements

CrmStages

Method	Description
getStages	List a batch of Stages
getStage	Retrieve a Stage

CrmTasks

Method	Description
addTask	Create a Task
getTasks	List a batch of Tasks
updateTask	Update a Task
getTask	Retrieve a Task
addTasks	Add a batch of Tasks

CrmUsers

Method	Description
getUsers	List a batch of Users
getUser	Retrieve a User

TicketingTickets

Method	Description
addTicket	Create a Ticket
getTickets	List a batch of Tickets
updateTicket	Update a Ticket
getTicket	Retrieve a Ticket
addTickets	Add a batch of Tickets

TicketingComments

Method	Description
addComment	Create a Comment
getComments	List a batch of Comments
getComment	Retrieve a Comment
addComments	Add a batch of Comments

TicketingUsers

Method	Description
getUsers	List a batch of Users
getUser	Retrieve a User

TicketingAttachments

Method	Description
addAttachment	Create a Attachment
getAttachments	List a batch of Attachments
getAttachment	Retrieve a Attachment
downloadAttachment	Download a Attachment
addAttachments	Add a batch of Attachments

TicketingContacts

Method	Description
getContacts	List a batch of Contacts
getContact	Retrieve a Contact

TicketingAccounts

Method	Description
getAccounts	List a batch of Accounts
getAccount	Retrieve an Account

TicketingTags

Method	Description
getTags	List a batch of Tags
getTag	Retrieve a Tag

TicketingTeams

Method	Description
getTeams	List a batch of Teams
getTeam	Retrieve a Team

All Methods

appControllerGetHello

HTTP Method: GET
Endpoint: /

Return Type

Returns a dict object.

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.main.appControllerGetHello();
  console.log(result);
})();

appControllerHealth

HTTP Method: GET
Endpoint: /health

Return Type

Returns a dict object.

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.health.appControllerHealth();
  console.log(result);
})();

appControllerGetHello2

HTTP Method: GET
Endpoint: /protected

Return Type

Returns a dict object.

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.protected.appControllerGetHello2();
  console.log(result);
})();

HTTP Method: POST
Endpoint: /auth/register

Required Parameters

| input | object | Request body. |

Return Type

Returns a dict object.

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const input = {
    email: 'email',
    first_name: 'first_name',
    id_organisation: 'id_organisation',
    last_name: 'last_name',
    password_hash: 'password_hash',
  };
  const result = await sdk.auth.signUp(input);
  console.log(result);
})();

HTTP Method: POST
Endpoint: /auth/login

Required Parameters

| input | object | Request body. |

Return Type

Returns a dict object.

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const input = { email: 'email', id_user: 'id_user', password_hash: 'password_hash' };
  const result = await sdk.auth.signIn(input);
  console.log(result);
})();

getUsers

Get users

HTTP Method: GET
Endpoint: /auth/users

Return Type

Returns a dict object.

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.auth.getUsers();
  console.log(result);
})();

getApiKeys

Retrieve API Keys

HTTP Method: GET
Endpoint: /auth/api-keys

Return Type

Returns a dict object.

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.auth.getApiKeys();
  console.log(result);
})();

generateApiKey

Create API Key

HTTP Method: POST
Endpoint: /auth/generate-apikey

Required Parameters

| input | object | Request body. |

Return Type

Returns a dict object.

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const input = { keyName: 'keyName', projectId: 'projectId', userId: 'userId' };
  const result = await sdk.auth.generateApiKey(input);
  console.log(result);
})();

handleOAuthCallback

Capture oAuth callback

HTTP Method: GET
Endpoint: /connections/oauth/callback

Required Parameters

Name	Type	Description
state	string
code	string
location	string

Return Type

Returns a dict object.

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.connections.handleOAuthCallback('state', 'code', 'location');
  console.log(result);
})();

getConnections

List Connections

HTTP Method: GET
Endpoint: /connections

Return Type

Returns a dict object.

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.connections.getConnections();
  console.log(result);
})();

createWebhookMetadata

Add webhook metadata

HTTP Method: POST
Endpoint: /webhook

Required Parameters

| input | object | Request body. |

Return Type

Returns a dict object.

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const input = {
    description: 'description',
    id_project: 'id_project',
    scope: ['aute dolor ullamco', 'id'],
    url: 'url',
  };
  const result = await sdk.webhook.createWebhookMetadata(input);
  console.log(result);
})();

getWebhooksMetadata

Retrieve webhooks metadata

HTTP Method: GET
Endpoint: /webhook

Return Type

Returns a dict object.

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.webhook.getWebhooksMetadata();
  console.log(result);
})();

updateWebhookStatus

Update webhook status

HTTP Method: PUT
Endpoint: /webhook/{id}

Required Parameters

Name	Type	Description
id	string

Return Type

Returns a dict object.

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.webhook.updateWebhookStatus('id');
  console.log(result);
})();

addLinkedUser

Add Linked User

HTTP Method: POST
Endpoint: /linked-users/create

Required Parameters

| input | object | Request body. |

Return Type

Returns a dict object.

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const input = {
    alias: 'alias',
    id_project: 'id_project',
    linked_user_origin_id: 'linked_user_origin_id',
  };
  const result = await sdk.linkedUsers.addLinkedUser(input);
  console.log(result);
})();

getLinkedUsers

Retrieve Linked Users

HTTP Method: GET
Endpoint: /linked-users

Return Type

Returns a dict object.

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.linkedUsers.getLinkedUsers();
  console.log(result);
})();

getLinkedUser

Retrieve a Linked User

HTTP Method: GET
Endpoint: /linked-users/single

Required Parameters

Name	Type	Description
originId	string

Return Type

Returns a dict object.

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.linkedUsers.getLinkedUser('originId');
  console.log(result);
})();

getOrganisations

Retrieve Organisations

HTTP Method: GET
Endpoint: /organisations

Return Type

Returns a dict object.

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.organisations.getOrganisations();
  console.log(result);
})();

createOrganisation

Create an Organisation

HTTP Method: POST
Endpoint: /organisations/create

Required Parameters

| input | object | Request body. |

Return Type

Returns a dict object.

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const input = { name: 'name', stripe_customer_id: 'stripe_customer_id' };
  const result = await sdk.organisations.createOrganisation(input);
  console.log(result);
})();

getProjects

Retrieve projects

HTTP Method: GET
Endpoint: /projects

Return Type

Returns a dict object.

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.projects.getProjects();
  console.log(result);
})();

createProject

Create a project

HTTP Method: POST
Endpoint: /projects/create

Required Parameters

| input | object | Request body. |

Return Type

Returns a dict object.

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const input = { id_organization: 'id_organization', name: 'name' };
  const result = await sdk.projects.createProject(input);
  console.log(result);
})();

getFieldMappingsEntities

Retrieve field mapping entities

HTTP Method: GET
Endpoint: /field-mapping/entities

Return Type

Returns a dict object.

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.fieldMapping.getFieldMappingsEntities();
  console.log(result);
})();

getFieldMappings

Retrieve field mappings

HTTP Method: GET
Endpoint: /field-mapping/attribute

Return Type

Returns a dict object.

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.fieldMapping.getFieldMappings();
  console.log(result);
})();

getFieldMappingValues

Retrieve field mappings values

HTTP Method: GET
Endpoint: /field-mapping/value

Return Type

Returns a dict object.

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.fieldMapping.getFieldMappingValues();
  console.log(result);
})();

defineTargetField

Define target Field

HTTP Method: POST
Endpoint: /field-mapping/define

Required Parameters

| input | object | Request body. |

Return Type

Returns a dict object.

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const input = {
    data_type: 'data_type',
    description: 'description',
    name: 'name',
    object_type_owner: 'object_type_owner',
  };
  const result = await sdk.fieldMapping.defineTargetField(input);
  console.log(result);
})();

mapField

Map Custom Field

HTTP Method: POST
Endpoint: /field-mapping/map

Required Parameters

| input | object | Request body. |

Return Type

Returns a dict object.

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const input = {
    attributeId: 'attributeId',
    linked_user_id: 'linked_user_id',
    source_custom_field_id: 'source_custom_field_id',
    source_provider: 'source_provider',
  };
  const result = await sdk.fieldMapping.mapField(input);
  console.log(result);
})();

getCustomProviderProperties

Retrieve Custom Properties

HTTP Method: GET
Endpoint: /field-mapping/properties

Required Parameters

Name	Type	Description
linkedUserId	string
providerId	string

Return Type

Returns a dict object.

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.fieldMapping.getCustomProviderProperties('linkedUserId', 'providerId');
  console.log(result);
})();

getEvents

Retrieve Events

HTTP Method: GET
Endpoint: /events

Return Type

Returns a dict object.

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.events.getEvents();
  console.log(result);
})();

createMagicLink

Create a Magic Link

HTTP Method: POST
Endpoint: /magic-link/create

Required Parameters

| input | object | Request body. |

Return Type

Returns a dict object.

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const input = {
    alias: 'alias',
    email: 'email',
    id_project: 'id_project',
    linked_user_origin_id: 'linked_user_origin_id',
  };
  const result = await sdk.magicLink.createMagicLink(input);
  console.log(result);
})();

getMagicLinks

Retrieve Magic Links

HTTP Method: GET
Endpoint: /magic-link

Return Type

Returns a dict object.

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.magicLink.getMagicLinks();
  console.log(result);
})();

getMagicLink

Retrieve a Magic Link

HTTP Method: GET
Endpoint: /magic-link/single

Required Parameters

Name	Type	Description
id	string

Return Type

Returns a dict object.

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.magicLink.getMagicLink('id');
  console.log(result);
})();

passthroughRequest

Make a passthrough request

HTTP Method: POST
Endpoint: /passthrough

Required Parameters

Name	Type	Description
integrationId	string
linkedUserId	string
input	object	Request body.

Return Type

PassThroughResponse

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const input = { data: {}, headers_: {}, method: 'DELETE', path: 'path' };
  const result = await sdk.passthrough.passthroughRequest(input, 'integrationId', 'linkedUserId');
  console.log(result);
})();

addContact

Create CRM Contact

HTTP Method: POST
Endpoint: /crm/contacts

Required Parameters

Name	Type	Description
connectionToken	string	The connection token
input	object	Request body.

Optional Parameters

Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}

Name	Type	Description
remoteData	boolean	Set to true to include data from the original CRM software.

Return Type

AddContactResponse UnifiedContactOutput

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const input = {
    addresses: [],
    email_addresses: [],
    field_mappings: {},
    first_name: 'first_name',
    last_name: 'last_name',
    phone_numbers: [],
    user_id: 'user_id',
  };
  const result = await sdk.crmContacts.addContact(input, 'connection_token', { remoteData: true });
  console.log(result);
})();

getContacts

List a batch of CRM Contacts

HTTP Method: GET
Endpoint: /crm/contacts

Required Parameters

Name	Type	Description
connectionToken	string	The connection token

Optional Parameters

Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}

Name	Type	Description
remoteData	boolean	Set to true to include data from the original CRM software.

Return Type

GetContactsResponse

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.crmContacts.getContacts('connection_token', { remoteData: true });
  console.log(result);
})();

updateContact

Update a CRM Contact

HTTP Method: PATCH
Endpoint: /crm/contacts

Required Parameters

Name	Type	Description
id	string

Return Type

UnifiedContactOutput

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.crmContacts.updateContact('id');
  console.log(result);
})();

getContact

Retrieve a CRM Contact

HTTP Method: GET
Endpoint: /crm/contacts/{id}

Required Parameters

Name	Type	Description
id	string	id of the `contact` you want to retrive.

Optional Parameters

Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}

Name	Type	Description
remoteData	boolean	Set to true to include data from the original CRM software.

Return Type

GetContactResponse

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.crmContacts.getContact('id', { remoteData: true });
  console.log(result);
})();

addContacts

Add a batch of CRM Contacts

HTTP Method: POST
Endpoint: /crm/contacts/batch

Required Parameters

Name	Type	Description
connectionToken	string	The connection token
input	object	Request body.

Optional Parameters

Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}

Name	Type	Description
remoteData	boolean	Set to true to include data from the original CRM software.

Return Type

AddContactsResponse CrmContactsAddContactsResponse

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const input = [{}, {}];
  const result = await sdk.crmContacts.addContacts(input, 'connection_token', { remoteData: true });
  console.log(result);
})();

addDeal

Create a Deal

HTTP Method: POST
Endpoint: /crm/deals

Required Parameters

Name	Type	Description
connectionToken	string	The connection token
input	object	Request body.

Optional Parameters

Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}

Name	Type	Description
remoteData	boolean	Set to true to include data from the original Crm software.

Return Type

AddDealResponse UnifiedDealOutput

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const input = { field_mappings: {} };
  const result = await sdk.crmDeals.addDeal(input, 'connection_token', { remoteData: true });
  console.log(result);
})();

getDeals

List a batch of Deals

HTTP Method: GET
Endpoint: /crm/deals

Required Parameters

Name	Type	Description
connectionToken	string	The connection token

Optional Parameters

Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}

Name	Type	Description
remoteData	boolean	Set to true to include data from the original Crm software.

Return Type

GetDealsResponse

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.crmDeals.getDeals('connection_token', { remoteData: true });
  console.log(result);
})();

getDeal

Retrieve a Deal

HTTP Method: GET
Endpoint: /crm/deals/{id}

Required Parameters

Name	Type	Description
id	string	id of the deal you want to retrieve.

Optional Parameters

Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}

Name	Type	Description
remoteData	boolean	Set to true to include data from the original Crm software.

Return Type

GetDealResponse

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.crmDeals.getDeal('id', { remoteData: true });
  console.log(result);
})();

updateDeal

Update a Deal

HTTP Method: PATCH
Endpoint: /crm/deals/{id}

Required Parameters

Name	Type	Description
id	string

Return Type

UpdateDealResponse

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.crmDeals.updateDeal('id');
  console.log(result);
})();

addDeals

Add a batch of Deals

HTTP Method: POST
Endpoint: /crm/deals/batch

Required Parameters

Name	Type	Description
connectionToken	string	The connection token
input	object	Request body.

Optional Parameters

Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}

Name	Type	Description
remoteData	boolean	Set to true to include data from the original Crm software.

Return Type

AddDealsResponse CrmDealsAddDealsResponse

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const input = [{}, {}];
  const result = await sdk.crmDeals.addDeals(input, 'connection_token', { remoteData: true });
  console.log(result);
})();

addNote

Create a Note

HTTP Method: POST
Endpoint: /crm/notes

Required Parameters

Name	Type	Description
connectionToken	string	The connection token
input	object	Request body.

Optional Parameters

Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}

Name	Type	Description
remoteData	boolean	Set to true to include data from the original Crm software.

Return Type

AddNoteResponse UnifiedNoteOutput

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const input = { field_mappings: {} };
  const result = await sdk.crmNotes.addNote(input, 'connection_token', { remoteData: true });
  console.log(result);
})();

getNotes

List a batch of Notes

HTTP Method: GET
Endpoint: /crm/notes

Required Parameters

Name	Type	Description
connectionToken	string	The connection token

Optional Parameters

Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}

Name	Type	Description
remoteData	boolean	Set to true to include data from the original Crm software.

Return Type

GetNotesResponse

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.crmNotes.getNotes('connection_token', { remoteData: true });
  console.log(result);
})();

getNote

Retrieve a Note

HTTP Method: GET
Endpoint: /crm/notes/{id}

Required Parameters

Name	Type	Description
id	string	id of the note you want to retrieve.

Optional Parameters

Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}

Name	Type	Description
remoteData	boolean	Set to true to include data from the original Crm software.

Return Type

GetNoteResponse

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.crmNotes.getNote('id', { remoteData: true });
  console.log(result);
})();

addNotes

Add a batch of Notes

HTTP Method: POST
Endpoint: /crm/notes/batch

Required Parameters

Name	Type	Description
connectionToken	string	The connection token
input	object	Request body.

Optional Parameters

Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}

Name	Type	Description
remoteData	boolean	Set to true to include data from the original Crm software.

Return Type

AddNotesResponse CrmNotesAddNotesResponse

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const input = [{}, {}];
  const result = await sdk.crmNotes.addNotes(input, 'connection_token', { remoteData: true });
  console.log(result);
})();

addCompany

Create a Company

HTTP Method: POST
Endpoint: /crm/companies

Required Parameters

Name	Type	Description
connectionToken	string	The connection token
input	object	Request body.

Optional Parameters

Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}

Name	Type	Description
remoteData	boolean	Set to true to include data from the original Crm software.

Return Type

AddCompanyResponse UnifiedCompanyOutput

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const input = { field_mappings: {} };
  const result = await sdk.crmCompanies.addCompany(input, 'connection_token', { remoteData: true });
  console.log(result);
})();

getCompanies

List a batch of Companies

HTTP Method: GET
Endpoint: /crm/companies

Required Parameters

Name	Type	Description
connectionToken	string	The connection token

Optional Parameters

Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}

Name	Type	Description
remoteData	boolean	Set to true to include data from the original Crm software.

Return Type

GetCompaniesResponse

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.crmCompanies.getCompanies('connection_token', { remoteData: true });
  console.log(result);
})();

updateCompany

Update a Company

HTTP Method: PATCH
Endpoint: /crm/companies

Required Parameters

Name	Type	Description
id	string

Return Type

UpdateCompanyResponse

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.crmCompanies.updateCompany('id');
  console.log(result);
})();

getCompany

Retrieve a Company

HTTP Method: GET
Endpoint: /crm/companies/{id}

Required Parameters

Name	Type	Description
id	string	id of the company you want to retrieve.

Optional Parameters

Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}

Name	Type	Description
remoteData	boolean	Set to true to include data from the original Crm software.

Return Type

GetCompanyResponse

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.crmCompanies.getCompany('id', { remoteData: true });
  console.log(result);
})();

addCompanies

Add a batch of Companies

HTTP Method: POST
Endpoint: /crm/companies/batch

Required Parameters

Name	Type	Description
connectionToken	string	The connection token
input	object	Request body.

Optional Parameters

Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}

Name	Type	Description
remoteData	boolean	Set to true to include data from the original Crm software.

Return Type

AddCompaniesResponse CrmCompaniesAddCompaniesResponse

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const input = [{}, {}];
  const result = await sdk.crmCompanies.addCompanies(input, 'connection_token', {
    remoteData: true,
  });
  console.log(result);
})();

addEngagement

Create a Engagement

HTTP Method: POST
Endpoint: /crm/engagements

Required Parameters

Name	Type	Description
connectionToken	string	The connection token
input	object	Request body.

Optional Parameters

Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}

Name	Type	Description
remoteData	boolean	Set to true to include data from the original Crm software.

Return Type

AddEngagementResponse UnifiedEngagementOutput

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const input = { field_mappings: {} };
  const result = await sdk.crmEngagements.addEngagement(input, 'connection_token', {
    remoteData: true,
  });
  console.log(result);
})();

getEngagements

List a batch of Engagements

HTTP Method: GET
Endpoint: /crm/engagements

Required Parameters

Name	Type	Description
connectionToken	string	The connection token

Optional Parameters

Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}

Name	Type	Description
remoteData	boolean	Set to true to include data from the original Crm software.

Return Type

GetEngagementsResponse

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.crmEngagements.getEngagements('connection_token', { remoteData: true });
  console.log(result);
})();

updateEngagement

Update a Engagement

HTTP Method: PATCH
Endpoint: /crm/engagements

Required Parameters

Name	Type	Description
id	string

Return Type

UpdateEngagementResponse

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.crmEngagements.updateEngagement('id');
  console.log(result);
})();

getEngagement

Retrieve a Engagement

HTTP Method: GET
Endpoint: /crm/engagements/{id}

Required Parameters

Name	Type	Description
id	string	id of the engagement you want to retrieve.

Optional Parameters

Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}

Name	Type	Description
remoteData	boolean	Set to true to include data from the original Crm software.

Return Type

GetEngagementResponse

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.crmEngagements.getEngagement('id', { remoteData: true });
  console.log(result);
})();

addEngagements

Add a batch of Engagements

HTTP Method: POST
Endpoint: /crm/engagements/batch

Required Parameters

Name	Type	Description
connectionToken	string	The connection token
input	object	Request body.

Optional Parameters

Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}

Name	Type	Description
remoteData	boolean	Set to true to include data from the original Crm software.

Return Type

AddEngagementsResponse CrmEngagementsAddEngagementsResponse

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const input = [{}, {}];
  const result = await sdk.crmEngagements.addEngagements(input, 'connection_token', {
    remoteData: true,
  });
  console.log(result);
})();

getStages

List a batch of Stages

HTTP Method: GET
Endpoint: /crm/stages

Required Parameters

Name	Type	Description
connectionToken	string	The connection token

Optional Parameters

Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}

Name	Type	Description
remoteData	boolean	Set to true to include data from the original Crm software.

Return Type

GetStagesResponse

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.crmStages.getStages('connection_token', { remoteData: true });
  console.log(result);
})();

getStage

Retrieve a Stage

HTTP Method: GET
Endpoint: /crm/stages/{id}

Required Parameters

Name	Type	Description
id	string	id of the stage you want to retrieve.

Optional Parameters

Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}

Name	Type	Description
remoteData	boolean	Set to true to include data from the original Crm software.

Return Type

GetStageResponse

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.crmStages.getStage('id', { remoteData: true });
  console.log(result);
})();

addTask

Create a Task

HTTP Method: POST
Endpoint: /crm/tasks

Required Parameters

Name	Type	Description
connectionToken	string	The connection token
input	object	Request body.

Optional Parameters

Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}

Name	Type	Description
remoteData	boolean	Set to true to include data from the original Crm software.

Return Type

AddTaskResponse UnifiedTaskOutput

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const input = { field_mappings: {} };
  const result = await sdk.crmTasks.addTask(input, 'connection_token', { remoteData: true });
  console.log(result);
})();

getTasks

List a batch of Tasks

HTTP Method: GET
Endpoint: /crm/tasks

Required Parameters

Name	Type	Description
connectionToken	string	The connection token

Optional Parameters

Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}

Name	Type	Description
remoteData	boolean	Set to true to include data from the original Crm software.

Return Type

GetTasksResponse

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.crmTasks.getTasks('connection_token', { remoteData: true });
  console.log(result);
})();

updateTask

Update a Task

HTTP Method: PATCH
Endpoint: /crm/tasks

Required Parameters

Name	Type	Description
id	string

Return Type

UpdateTaskResponse

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.crmTasks.updateTask('id');
  console.log(result);
})();

getTask

Retrieve a Task

HTTP Method: GET
Endpoint: /crm/tasks/{id}

Required Parameters

Name	Type	Description
id	string	id of the task you want to retrieve.

Optional Parameters

Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}

Name	Type	Description
remoteData	boolean	Set to true to include data from the original Crm software.

Return Type

GetTaskResponse

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.crmTasks.getTask('id', { remoteData: true });
  console.log(result);
})();

addTasks

Add a batch of Tasks

HTTP Method: POST
Endpoint: /crm/tasks/batch

Required Parameters

Name	Type	Description
connectionToken	string	The connection token
input	object	Request body.

Optional Parameters

Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}

Name	Type	Description
remoteData	boolean	Set to true to include data from the original Crm software.

Return Type

AddTasksResponse CrmTasksAddTasksResponse

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const input = [{}, {}];
  const result = await sdk.crmTasks.addTasks(input, 'connection_token', { remoteData: true });
  console.log(result);
})();

getUsers

List a batch of Users

HTTP Method: GET
Endpoint: /crm/users

Required Parameters

Name	Type	Description
connectionToken	string	The connection token

Optional Parameters

Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}

Name	Type	Description
remoteData	boolean	Set to true to include data from the original Crm software.

Return Type

GetUsersResponse

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.crmUsers.getUsers('connection_token', { remoteData: true });
  console.log(result);
})();

getUser

Retrieve a User

HTTP Method: GET
Endpoint: /crm/users/{id}

Required Parameters

Name	Type	Description
id	string	id of the user you want to retrieve.

Optional Parameters

Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}

Name	Type	Description
remoteData	boolean	Set to true to include data from the original Crm software.

Return Type

GetUserResponse

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.crmUsers.getUser('id', { remoteData: true });
  console.log(result);
})();

addTicket

Create a Ticket

HTTP Method: POST
Endpoint: /ticketing/tickets

Required Parameters

Name	Type	Description
connectionToken	string	The connection token
input	object	Request body.

Optional Parameters

Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}

Name	Type	Description
remoteData	boolean	Set to true to include data from the original Ticketing software.

Return Type

AddTicketResponse UnifiedTicketOutput

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const input = {
    account_id: 'account_id',
    assigned_to: ['dolore mollit', 'dolor ut'],
    comment: ['sunt ea deserunt labore', 'sint'],
    completed_at: '1944-01-11T20:56:01.0Z',
    contact_id: 'contact_id',
    description: ['ea minim aute elit eu', 'laborum dolor reprehenderit'],
    due_date: '1943-11-18T12:02:47.0Z',
    field_mappings: {},
    name: 'name',
    parent_ticket: 'parent_ticket',
    priority: 'priority',
    status: 'status',
    tags: ['in', 'eu aute ullamco est nulla'],
    type_: 'type',
  };
  const result = await sdk.ticketingTickets.addTicket(input, 'connection_token', {
    remoteData: true,
  });
  console.log(result);
})();

getTickets

List a batch of Tickets

HTTP Method: GET
Endpoint: /ticketing/tickets

Required Parameters

Name	Type	Description
connectionToken	string	The connection token

Optional Parameters

Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}

Name	Type	Description
remoteData	boolean	Set to true to include data from the original Ticketing software.

Return Type

GetTicketsResponse

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.ticketingTickets.getTickets('connection_token', { remoteData: true });
  console.log(result);
})();

updateTicket

Update a Ticket

HTTP Method: PATCH
Endpoint: /ticketing/tickets

Required Parameters

Name	Type	Description
id	string

Return Type

UnifiedTicketOutput

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.ticketingTickets.updateTicket('id');
  console.log(result);
})();

getTicket

Retrieve a Ticket

HTTP Method: GET
Endpoint: /ticketing/tickets/{id}

Required Parameters

Name	Type	Description
id	string	id of the `ticket` you want to retrive.

Optional Parameters

Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}

Name	Type	Description
remoteData	boolean	Set to true to include data from the original Ticketing software.

Return Type

GetTicketResponse

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.ticketingTickets.getTicket('id', { remoteData: true });
  console.log(result);
})();

addTickets

Add a batch of Tickets

HTTP Method: POST
Endpoint: /ticketing/tickets/batch

Required Parameters

Name	Type	Description
connectionToken	string	The connection token
input	object	Request body.

Optional Parameters

Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}

Name	Type	Description
remoteData	boolean	Set to true to include data from the original Ticketing software.

Return Type

AddTicketsResponse TicketingTicketsAddTicketsResponse

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const input = [{}, {}];
  const result = await sdk.ticketingTickets.addTickets(input, 'connection_token', {
    remoteData: true,
  });
  console.log(result);
})();

addComment

Create a Comment

HTTP Method: POST
Endpoint: /ticketing/comments

Required Parameters

Name	Type	Description
connectionToken	string	The connection token
input	object	Request body.

Optional Parameters

Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}

Name	Type	Description
remoteData	boolean	Set to true to include data from the original Ticketing software.

Return Type

AddCommentResponse UnifiedCommentOutput

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const input = {
    attachments: ['Duis qui aliquip Ut in', 'ullamco'],
    body: 'body',
    contact_id: 'contact_id',
    creator_type: 'creator_type',
    html_body: 'html_body',
    is_private: true,
    ticket_id: 'ticket_id',
    user_id: 'user_id',
  };
  const result = await sdk.ticketingComments.addComment(input, 'connection_token', {
    remoteData: true,
  });
  console.log(result);
})();

getComments

List a batch of Comments

HTTP Method: GET
Endpoint: /ticketing/comments

Required Parameters

Name	Type	Description
connectionToken	string	The connection token

Optional Parameters

Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}

Name	Type	Description
remoteData	boolean	Set to true to include data from the original Ticketing software.

Return Type

GetCommentsResponse

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.ticketingComments.getComments('connection_token', { remoteData: true });
  console.log(result);
})();

getComment

Retrieve a Comment

HTTP Method: GET
Endpoint: /ticketing/comments/{id}

Required Parameters

Name	Type	Description
id	string	id of the `comment` you want to retrive.

Optional Parameters

Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}

Name	Type	Description
remoteData	boolean	Set to true to include data from the original Ticketing software.

Return Type

GetCommentResponse

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.ticketingComments.getComment('id', { remoteData: true });
  console.log(result);
})();

addComments

Add a batch of Comments

HTTP Method: POST
Endpoint: /ticketing/comments/batch

Required Parameters

Name	Type	Description
connectionToken	string	The connection token
input	object	Request body.

Optional Parameters

Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}

Name	Type	Description
remoteData	boolean	Set to true to include data from the original Ticketing software.

Return Type

AddCommentsResponse TicketingCommentsAddCommentsResponse

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const input = [{}, {}];
  const result = await sdk.ticketingComments.addComments(input, 'connection_token', {
    remoteData: true,
  });
  console.log(result);
})();

getUsers

List a batch of Users

HTTP Method: GET
Endpoint: /ticketing/users

Required Parameters

Name	Type	Description
connectionToken	string	The connection token

Optional Parameters

Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}

Name	Type	Description
remoteData	boolean	Set to true to include data from the original Ticketing software.

Return Type

GetUsersResponse

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.ticketingUsers.getUsers('connection_token', { remoteData: true });
  console.log(result);
})();

getUser

Retrieve a User

HTTP Method: GET
Endpoint: /ticketing/users/{id}

Required Parameters

Name	Type	Description
id	string	id of the user you want to retrieve.

Optional Parameters

Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}

Name	Type	Description
remoteData	boolean	Set to true to include data from the original Ticketing software.

Return Type

GetUserResponse

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.ticketingUsers.getUser('id', { remoteData: true });
  console.log(result);
})();

addAttachment

Create a Attachment

HTTP Method: POST
Endpoint: /ticketing/attachments

Required Parameters

Name	Type	Description
connectionToken	string	The connection token
input	object	Request body.

Optional Parameters

Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}

Name	Type	Description
remoteData	boolean	Set to true to include data from the original Ticketing software.

Return Type

AddAttachmentResponse UnifiedAttachmentOutput

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const input = {
    field_mappings: {},
    file_name: 'file_name',
    file_url: 'file_url',
    uploader: 'uploader',
  };
  const result = await sdk.ticketingAttachments.addAttachment(input, 'connection_token', {
    remoteData: true,
  });
  console.log(result);
})();

getAttachments

List a batch of Attachments

HTTP Method: GET
Endpoint: /ticketing/attachments

Required Parameters

Name	Type	Description
connectionToken	string	The connection token

Optional Parameters

Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}

Name	Type	Description
remoteData	boolean	Set to true to include data from the original Ticketing software.

Return Type

GetAttachmentsResponse

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.ticketingAttachments.getAttachments('connection_token', {
    remoteData: true,
  });
  console.log(result);
})();

getAttachment

Retrieve a Attachment

HTTP Method: GET
Endpoint: /ticketing/attachments/{id}

Required Parameters

Name	Type	Description
id	string	id of the attachment you want to retrive.

Optional Parameters

Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}

Name	Type	Description
remoteData	boolean	Set to true to include data from the original Ticketing software.

Return Type

GetAttachmentResponse

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.ticketingAttachments.getAttachment('id', { remoteData: true });
  console.log(result);
})();

downloadAttachment

Download a Attachment

HTTP Method: GET
Endpoint: /ticketing/attachments/{id}/download

Required Parameters

Name	Type	Description
id	string	id of the attachment you want to retrive.

Optional Parameters

Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}

Name	Type	Description
remoteData	boolean	Set to true to include data from the original Ticketing software.

Return Type

DownloadAttachmentResponse

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.ticketingAttachments.downloadAttachment('id', { remoteData: true });
  console.log(result);
})();

addAttachments

Add a batch of Attachments

HTTP Method: POST
Endpoint: /ticketing/attachments/batch

Required Parameters

Name	Type	Description
connectionToken	string	The connection token
input	object	Request body.

Optional Parameters

Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}

Name	Type	Description
remoteData	boolean	Set to true to include data from the original Ticketing software.

Return Type

AddAttachmentsResponse TicketingAttachmentsAddAttachmentsResponse

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const input = [{}, {}];
  const result = await sdk.ticketingAttachments.addAttachments(input, 'connection_token', {
    remoteData: true,
  });
  console.log(result);
})();

getContacts

List a batch of Contacts

HTTP Method: GET
Endpoint: /ticketing/contacts

Required Parameters

Name	Type	Description
connectionToken	string	The connection token

Optional Parameters

Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}

Name	Type	Description
remoteData	boolean	Set to true to include data from the original Ticketing software.

Return Type

GetContactsResponse

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.ticketingContacts.getContacts('connection_token', { remoteData: true });
  console.log(result);
})();

getContact

Retrieve a Contact

HTTP Method: GET
Endpoint: /ticketing/contacts/{id}

Required Parameters

Name	Type	Description
id	string	id of the contact you want to retrieve.

Optional Parameters

Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}

Name	Type	Description
remoteData	boolean	Set to true to include data from the original Ticketing software.

Return Type

GetContactResponse

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.ticketingContacts.getContact('id', { remoteData: true });
  console.log(result);
})();

getAccounts

List a batch of Accounts

HTTP Method: GET
Endpoint: /ticketing/accounts

Required Parameters

Name	Type	Description
connectionToken	string	The connection token

Optional Parameters

Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}

Name	Type	Description
remoteData	boolean	Set to true to include data from the original Ticketing software.

Return Type

GetAccountsResponse

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.ticketingAccounts.getAccounts('connection_token', { remoteData: true });
  console.log(result);
})();

getAccount

Retrieve an Account

HTTP Method: GET
Endpoint: /ticketing/accounts/{id}

Required Parameters

Name	Type	Description
id	string	id of the account you want to retrieve.

Optional Parameters

Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}

Name	Type	Description
remoteData	boolean	Set to true to include data from the original Ticketing software.

Return Type

GetAccountResponse

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.ticketingAccounts.getAccount('id', { remoteData: true });
  console.log(result);
})();

getTags

List a batch of Tags

HTTP Method: GET
Endpoint: /ticketing/tags

Required Parameters

Name	Type	Description
connectionToken	string	The connection token

Optional Parameters

Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}

Name	Type	Description
remoteData	boolean	Set to true to include data from the original Ticketing software.

Return Type

GetTagsResponse

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.ticketingTags.getTags('connection_token', { remoteData: true });
  console.log(result);
})();

getTag

Retrieve a Tag

HTTP Method: GET
Endpoint: /ticketing/tags/{id}

Required Parameters

Name	Type	Description
id	string	id of the tag you want to retrieve.

Optional Parameters

Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}

Name	Type	Description
remoteData	boolean	Set to true to include data from the original Ticketing software.

Return Type

GetTagResponse

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.ticketingTags.getTag('id', { remoteData: true });
  console.log(result);
})();

getTeams

List a batch of Teams

HTTP Method: GET
Endpoint: /ticketing/teams

Required Parameters

Name	Type	Description
connectionToken	string	The connection token

Optional Parameters

Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}

Name	Type	Description
remoteData	boolean	Set to true to include data from the original Ticketing software.

Return Type

GetTeamsResponse

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.ticketingTeams.getTeams('connection_token', { remoteData: true });
  console.log(result);
})();

getTeam

Retrieve a Team

HTTP Method: GET
Endpoint: /ticketing/teams/{id}

Required Parameters

Name	Type	Description
id	string	id of the team you want to retrieve.

Optional Parameters

Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}

Name	Type	Description
remoteData	boolean	Set to true to include data from the original Ticketing software.

Return Type

GetTeamResponse

Example Usage Code Snippet

import { PanoraSDK } from 'panorasdk';

const sdk = new PanoraSDK({ accessToken: process.env.PANORASDK_ACCESS_TOKEN });

(async () => {
  const result = await sdk.ticketingTeams.getTeam('id', { remoteData: true });
  console.log(result);
})();

License

License: MIT. See license in LICENSE.

FAQs

What is @panora/sdk-typescript?

Is @panora/sdk-typescript popular?

Is @panora/sdk-typescript well maintained?

Package last updated on 08 Feb 2024

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

@panora/sdk-typescript

PanoraSDK Typescript SDK 1.0.0

Table of Contents

About the API

Installation

Authentication

Access Token

Sample Usage

PanoraSDK Services

Main

Health

Protected

Auth

Connections

Webhook

LinkedUsers

Organisations

Projects

FieldMapping

Events

MagicLink

Passthrough

CrmContacts

CrmDeals

CrmNotes

CrmCompanies

CrmEngagements

CrmStages

CrmTasks

CrmUsers

TicketingTickets

TicketingComments

TicketingUsers

TicketingAttachments

TicketingContacts

TicketingAccounts

TicketingTags

TicketingTeams

All Methods

appControllerGetHello

appControllerHealth

appControllerGetHello2

signUp

signIn

getUsers

getApiKeys

generateApiKey

handleOAuthCallback

getConnections

createWebhookMetadata

getWebhooksMetadata

updateWebhookStatus

addLinkedUser

getLinkedUsers

getLinkedUser

getOrganisations

createOrganisation

getProjects

createProject

getFieldMappingsEntities

getFieldMappings

getFieldMappingValues

defineTargetField

mapField

getCustomProviderProperties

getEvents

createMagicLink

getMagicLinks

getMagicLink

passthroughRequest

addContact

getContacts

updateContact

getContact

addContacts

addDeal

getDeals

getDeal

updateDeal

addDeals