marturion-suitetalk-01 / Exports / NetsuiteRest

Class: NetsuiteRest

Netsuite Rest Client

description Helps facilitate communications with Netsuite Suitetalk Web Services

const netsuiteRestOptions: INetsuiteRestOptions = {
 // Populate with Authentication Keys
}

// Setup Netsuite Rest Client
const NetsuiteClient: NetsuiteRest = new NetsuiteRest(netsuiteRestOptions)

// Setup request options
const netsuiteRequestOptions: INetsuiteRequestOptions = {
   path: 'query/v1/suiteql',
   method: "POST",
   body: JSON.stringify(requestBody),
}

 // Perform the request
 NetsuiteClient.Request(netsuiteRequestOptions);

Table of contents

Constructors

• constructor

Properties

• algorithm
• baseUrl
• consumerKey
• consumerSecret
• realm
• token
• tokenSecret

Methods

• Request

Constructors

constructor

• new NetsuiteRest(options)

Netsuite Rest Contructor

argument INetsuiteRestOptions

Parameters

| Name | Type | | :------ | :------ | | options | INetsuiteRestOptions |

Defined in

NetsuiteRest.ts:82

Properties

algorithm

• Private algorithm: string = "HMAC-SHA256"

Algorithm to be used for Hashing Functionality

Defined in

NetsuiteRest.ts:35

baseUrl

• Private baseUrl: string

Netsuite URL to override realm, If passing a baseURL the realm is still needed for authentication

Defined in

NetsuiteRest.ts:76

consumerKey

• Private consumerKey: string

Netsuite integration record consumer key

see Integration Record Oracle Docs

Defined in

NetsuiteRest.ts:41

consumerSecret

• Private consumerSecret: string

Netsuite integration record consumer secret key

see Integration Record Oracle Docs

Defined in

NetsuiteRest.ts:47

realm

• Private realm: string

Netsuite account id

// if production
XXXXXX - a number of 6 digits or more
// if Sandbox
XXXXXX_SB or XXXXXX_SB1

Defined in

NetsuiteRest.ts:70

token

• Private token: string

Netsuite user access token for token based authentication

see https://docs.oracle.com/en/cloud/saas/netsuite/ns-online-help/section_4254975694.html

Defined in

NetsuiteRest.ts:53

tokenSecret

• Private tokenSecret: string

Netsuite user access secret for token based authentication

• @see https://docs.oracle.com/en/cloud/saas/netsuite/ns-online-help/section_4254975694.html

Defined in

NetsuiteRest.ts:59

Methods

Request

▸ Request(options): Promise<AxiosResponse<any, any>>

Perform a Request to Netsuite Rest Web Services Also supports using suiteQL for requests

example

// Setup Netsuite Client
const NetsuiteClient: NetsuiteRest = new NetsuiteRest(netsuiteRestOptions);

// Setup request options
const netsuiteRequestOptions: INetsuiteRequestOptions = {
   path: 'query/v1/suiteql',
   method: "POST",
   body: JSON.stringify(requestBody),
}

// Peform Request
NetsuiteClient.Request(netsuiteRequestOptions);

Parameters

| Name | Type | Description | | :------ | :------ | :------ | | options | INetsuiteRequestOptions | INetsuiteRequestOptions |

Returns

Promise<AxiosResponse<any, any>>

Defined in

NetsuiteRest.ts:114