@panora/typescript-sdk v1.0.5

PanoraSDK Typescript SDK

The Typescript SDK for PanoraSDK.

Table of Contents

• About the API
• Installation
• Authentication
  • Access Token
• API Endpoint Services
• API Models
• Sample Usage
• PanoraSDK Services
• License

About the API

The Panora API description

Installation

npm i @panora/typescript-sdk 

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/typescript-sdk';


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.

• Services

  • Main

  • Auth

  • Connections

  • Webhook

  • LinkedUsers

  • Organisations

  • Projects

  • FieldMapping

  • Events

  • MagicLink

  • Passthrough

  • CrmContact

• All Methods

Main

Auth

Connections

Webhook

LinkedUsers

Organisations

Projects

FieldMapping

Events

MagicLink

Passthrough

CrmContact

All Methods

appControllerGetHello

• HTTP Method: GET
• Endpoint: /

Return Type

Returns a dict object.

Example Usage Code Snippet

import { PanoraSDK } from './src';

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

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

signUp

Register

• 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 './src';

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

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

signIn

Log In

• 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 './src';

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 './src';

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 './src';

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 './src';

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

Return Type

Returns a dict object.

Example Usage Code Snippet

import { PanoraSDK } from './src';

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

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

getConnections

Retrieve Connections

• HTTP Method: GET
• Endpoint: /connections

Return Type

Returns a dict object.

Example Usage Code Snippet

import { PanoraSDK } from './src';

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 './src';

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

(async () => {
  const input = {
    description: 'description',
    id_project: 'id_project',
    scope: 'scope',
    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 './src';

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

Return Type

Returns a dict object.

Example Usage Code Snippet

import { PanoraSDK } from './src';

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 './src';

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 './src';

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

Return Type

Returns a dict object.

Example Usage Code Snippet

import { PanoraSDK } from './src';

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

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

getOrganisations

Retrieve Organisations

• HTTP Method: GET
• Endpoint: /organisations

Return Type

Returns a dict object.

Example Usage Code Snippet

import { PanoraSDK } from './src';

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 './src';

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 './src';

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 './src';

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 './src';

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 './src';

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 './src';

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 './src';

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 './src';

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

Return Type

Returns a dict object.

Example Usage Code Snippet

import { PanoraSDK } from './src';

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 './src';

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 './src';

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 './src';

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

Return Type

Returns a dict object.

Example Usage Code Snippet

import { PanoraSDK } from './src';

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

Return Type

PassThroughResponse

Example Usage Code Snippet

import { PanoraSDK } from './src';

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

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

addContact

Create CRM Contact

• HTTP Method: POST
• Endpoint: /crm/contact

Required Parameters

Optional Parameters

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

Return Type

AddContactResponse

Example Usage Code Snippet

import { PanoraSDK } from './src';

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

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

getContacts

Retrieve a batch of CRM Contacts

• HTTP Method: GET
• Endpoint: /crm/contact

Required Parameters

Optional Parameters

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

Return Type

GetContactsResponse

Example Usage Code Snippet

import { PanoraSDK } from './src';

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

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

updateContact

Update a CRM Contact

• HTTP Method: PATCH
• Endpoint: /crm/contact

Required Parameters

Return Type

Returns a dict object.

Example Usage Code Snippet

import { PanoraSDK } from './src';

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

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

getContact

Retrieve a CRM Contact

• HTTP Method: GET
• Endpoint: /crm/contact/{id}

Required Parameters

Optional Parameters

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

Return Type

GetContactResponse

Example Usage Code Snippet

import { PanoraSDK } from './src';

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

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

addContacts

Add a batch of CRM Contacts

• HTTP Method: POST
• Endpoint: /crm/contact/batch

Required Parameters

Optional Parameters

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

Return Type

AddContactsResponse

Example Usage Code Snippet

import { PanoraSDK } from './src';

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

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

License

License: MIT. See license in LICENSE.