Skip to content

Vonage Network Auth

Jump to bottom
github-actions edited this page Jul 1, 2025 · 4 revisions

Documentation

Documentation / Vonage Network Auth

Vonage Server SDK for Node.js

GitHub Workflow Status Codecov Latest Release Contributor Covenant License

Vonage

This is the Vonage Server Client SDK for Node.js used to wrap the authentication headers/signatures for use with Vonage APIs. To use it you will need a Vonage account. Sign up for free at vonage.com.

For full API documentation refer to developer.vonage.com.

Installation

With NPM

npm install @vonage/network-client

With Yarn

yarn add @vonage/network-client

Usage

To create a client, you will need to pass in a @vonage/auth object.

const { Auth } = require('@vonage/auth');
const { Client } = require('@vonage/network-client');

const vonageClient = new Client (new Auth({
        apiKey: API_KEY,
        apiSecret: API_SECRET,
        applicationId: APP_ID,
        privateKey: PRIVATE_KEY_PATH,
    }),
    options,
);

Options

options is any option from @vonage/server-client along with the following that are specific for the network APIs

  • msisdn: string - The MSISDN (phone number) you wish to authenticate to.
  • accessToken: string (optional) - A pre generated Access token for making network API calls
  • expiresIn: string (required if accessToken is passed) - Time until the access token expires

Testing

Run:

npm run test

Enumerations

Purpose

Defined in: packages/network-client/lib/enums/purpose.ts:4

Netowrk API purposes for generating the scope

Enumeration Members

Enumeration Member Value Description Defined in
FRAUD_PREVENTION_AND_DETECTION "FraudPreventionAndDetection" Purpose for Fraud Prevention and Detection packages/network-client/lib/enums/purpose.ts:8

Scope

Defined in: packages/network-client/lib/enums/scope.ts:4

Scopes for the API

Enumeration Members

Enumeration Member Value Description Defined in
CHECK_SIM_SWAP "check-sim-swap" Check for SIM Swap packages/network-client/lib/enums/scope.ts:8
NUMBER_VERIFICATION_VERIFY_READ "number-verification-verify-read" Number Verification packages/network-client/lib/enums/scope.ts:13

Classes

InvalidPurposeError

Defined in: packages/network-client/lib/errors/invalidPurposeError.ts:5

Error thrown when purpose is invalid

Extends

  • Error

Constructors

Constructor
new InvalidPurposeError(): InvalidPurposeError;

Defined in: packages/network-client/lib/errors/invalidPurposeError.ts:6

Returns

InvalidPurposeError

Overrides
Error.constructor

Properties

cause?
optional cause: unknown;

Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:24

Inherited from
Error.cause
message
message: string;

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from
Error.message
name
name: string;

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from
Error.name
stack?
optional stack: string;

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from
Error.stack
stackTraceLimit
static stackTraceLimit: number;

Defined in: node_modules/@types/node/globals.d.ts:161

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from
Error.stackTraceLimit

Methods

captureStackTrace()
static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/@types/node/globals.d.ts:145

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();
Parameters
targetObject

object

constructorOpt?

Function

Returns

void

Inherited from
Error.captureStackTrace
prepareStackTrace()
static prepareStackTrace(err, stackTraces): any;

Defined in: node_modules/@types/node/globals.d.ts:149

Parameters
err

Error

stackTraces

CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from
Error.prepareStackTrace

InvalidScopeError

Defined in: packages/network-client/lib/errors/invalidScopeError.ts:5

Error thrown when scope is invalid

Extends

  • Error

Constructors

Constructor
new InvalidScopeError(): InvalidScopeError;

Defined in: packages/network-client/lib/errors/invalidScopeError.ts:6

Returns

InvalidScopeError

Overrides
Error.constructor

Properties

cause?
optional cause: unknown;

Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:24

Inherited from
Error.cause
message
message: string;

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from
Error.message
name
name: string;

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from
Error.name
stack?
optional stack: string;

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from
Error.stack
stackTraceLimit
static stackTraceLimit: number;

Defined in: node_modules/@types/node/globals.d.ts:161

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from
Error.stackTraceLimit

Methods

captureStackTrace()
static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/@types/node/globals.d.ts:145

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();
Parameters
targetObject

object

constructorOpt?

Function

Returns

void

Inherited from
Error.captureStackTrace
prepareStackTrace()
static prepareStackTrace(err, stackTraces): any;

Defined in: node_modules/@types/node/globals.d.ts:149

Parameters
err

Error

stackTraces

CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from
Error.prepareStackTrace

MissingPurposeError

Defined in: packages/network-client/lib/errors/missingPurposeError.ts:5

Error thrown when purpose is invalid

Extends

  • Error

Constructors

Constructor
new MissingPurposeError(): MissingPurposeError;

Defined in: packages/network-client/lib/errors/missingPurposeError.ts:6

Returns

MissingPurposeError

Overrides
Error.constructor

Properties

cause?
optional cause: unknown;

Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:24

Inherited from
Error.cause
message
message: string;

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from
Error.message
name
name: string;

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from
Error.name
stack?
optional stack: string;

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from
Error.stack
stackTraceLimit
static stackTraceLimit: number;

Defined in: node_modules/@types/node/globals.d.ts:161

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from
Error.stackTraceLimit

Methods

captureStackTrace()
static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/@types/node/globals.d.ts:145

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();
Parameters
targetObject

object

constructorOpt?

Function

Returns

void

Inherited from
Error.captureStackTrace
prepareStackTrace()
static prepareStackTrace(err, stackTraces): any;

Defined in: node_modules/@types/node/globals.d.ts:149

Parameters
err

Error

stackTraces

CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from
Error.prepareStackTrace

MissingScopeError

Defined in: packages/network-client/lib/errors/missingScopeError.ts:5

Error thrown when no scope is set for a request.

Extends

  • Error

Constructors

Constructor
new MissingScopeError(): MissingScopeError;

Defined in: packages/network-client/lib/errors/missingScopeError.ts:6

Returns

MissingScopeError

Overrides
Error.constructor

Properties

cause?
optional cause: unknown;

Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:24

Inherited from
Error.cause
message
message: string;

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from
Error.message
name
name: string;

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from
Error.name
stack?
optional stack: string;

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from
Error.stack
stackTraceLimit
static stackTraceLimit: number;

Defined in: node_modules/@types/node/globals.d.ts:161

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from
Error.stackTraceLimit

Methods

captureStackTrace()
static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/@types/node/globals.d.ts:145

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();
Parameters
targetObject

object

constructorOpt?

Function

Returns

void

Inherited from
Error.captureStackTrace
prepareStackTrace()
static prepareStackTrace(err, stackTraces): any;

Defined in: node_modules/@types/node/globals.d.ts:149

Parameters
err

Error

stackTraces

CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from
Error.prepareStackTrace

NetworkClient

Defined in: packages/network-client/lib/networkClient.ts:26

Extends

Extended by

Constructors

Constructor
new NetworkClient(auth, config?): NetworkClient;

Defined in: packages/network-client/lib/networkClient.ts:62

Parameters
auth

NetworkAuthParameters

config?

NetworkConfigParameters

Returns

NetworkClient

Overrides

Client.constructor

Properties

_msisdn
protected _msisdn: string;

Defined in: packages/network-client/lib/networkClient.ts:45

The msisdn that will be used for API calls

_purpose?
protected optional _purpose: FRAUD_PREVENTION_AND_DETECTION;

Defined in: packages/network-client/lib/networkClient.ts:50

The purpose for the scope

_scope?
protected optional _scope: Scope;

Defined in: packages/network-client/lib/networkClient.ts:55

The scope for the token

accessToken?
protected optional accessToken: string;

Defined in: packages/network-client/lib/networkClient.ts:35

The current token

auth
protected auth: AuthInterface;

Defined in: packages/server-client/dist/lib/client.d.ts:24

The authentication instance responsible for generating authentication headers and query parameters.

Inherited from

Client.auth

authType?
protected optional authType: AuthenticationType;

Defined in: packages/server-client/dist/lib/client.d.ts:20

The type of authentication used for the client's requests.

Inherited from

Client.authType

config
protected config: NetworkConfigParameters;

Defined in: packages/network-client/lib/networkClient.ts:60

Configuration settings for the client, including default hosts for various services and other request settings.

Overrides

Client.config

expires
protected expires: number = 0;

Defined in: packages/network-client/lib/networkClient.ts:40

Timestamp until the token expires

gettingToken
protected gettingToken: boolean = false;

Defined in: packages/network-client/lib/networkClient.ts:30

Flags if we are currently getting a token

transformers
static transformers: object;

Defined in: packages/server-client/dist/lib/client.d.ts:11

Static property containing utility transformers.

camelCaseObjectKeys
camelCaseObjectKeys: PartialTransformFunction;
kebabCaseObjectKeys
kebabCaseObjectKeys: PartialTransformFunction;
omit()
omit: (keys, obj) => TransformedObject;
Parameters
keys

string[]

obj

ObjectToTransform

Returns

TransformedObject

snakeCaseObjectKeys
snakeCaseObjectKeys: PartialTransformFunction;
Inherited from

Client.transformers

Accessors

msisdn
Get Signature
get msisdn(): string;

Defined in: packages/network-client/lib/networkClient.ts:81

Get the msisdn

Throws

If the msisdn is not set

Returns

string

The msisdn

purpose
Get Signature
get purpose(): FRAUD_PREVENTION_AND_DETECTION;

Defined in: packages/network-client/lib/networkClient.ts:96

Get the purpose

Throws

If the purpose is not set

Throws

If the purpose is not valid

Returns

FRAUD_PREVENTION_AND_DETECTION

The purpose

Set Signature
set purpose(value): void;

Defined in: packages/network-client/lib/networkClient.ts:112

Set the purpose

Parameters
value

FRAUD_PREVENTION_AND_DETECTION

The purpose

Returns

void

scope
Get Signature
get scope(): Scope;

Defined in: packages/network-client/lib/networkClient.ts:123

Get the scope

Throws

If the scope is not set

Throws

If the scope is not valid

Returns

Scope

The scope

Set Signature
set scope(value): void;

Defined in: packages/network-client/lib/networkClient.ts:142

Set the scope

Throws

If the scope is not valid

Throws

If the scope is not set

Parameters
value

Scope

The scope

Returns

void

Methods

addAuthenticationToRequest()
addAuthenticationToRequest(request): Promise<VetchOptions>;

Defined in: packages/network-client/lib/networkClient.ts:154

Add authentication to the auth

This will make the calls to get a network token if required.

Parameters
request

VetchOptions

The request to add authentication to

Returns

Promise<VetchOptions>

The request with authentication added

Overrides

Client.addAuthenticationToRequest

addBasicAuthToRequest()
protected addBasicAuthToRequest(request): Promise<VetchOptions>;

Defined in: packages/server-client/dist/lib/client.d.ts:71

Adds basic authentication headers to the request.

Parameters
request

VetchOptions

The request options to which authentication needs to be added.

Returns

Promise<VetchOptions>

  • The request options with the added authentication.
Inherited from

Client.addBasicAuthToRequest

addJWTToRequest()
protected addJWTToRequest(request): Promise<VetchOptions>;

Defined in: packages/server-client/dist/lib/client.d.ts:64

Adds a JWT to the request.

Parameters
request

VetchOptions

The request options to which authentication needs to be added.

Returns

Promise<VetchOptions>

  • The request options with the added authentication.
Inherited from

Client.addJWTToRequest

addQueryKeySecretToRequest()
protected addQueryKeySecretToRequest(request): Promise<VetchOptions>;

Defined in: packages/server-client/dist/lib/client.d.ts:57

Adds API key and secret to the request.

Parameters
request

VetchOptions

The request options to which authentication needs to be added.

Returns

Promise<VetchOptions>

  • The request options with the added authentication.
Inherited from

Client.addQueryKeySecretToRequest

addQueryKeySecretToRequestBody()
protected addQueryKeySecretToRequestBody(request): Promise<VetchOptions>;

Defined in: packages/server-client/dist/lib/client.d.ts:50

Adds API key and secret to the request body.

Parameters
request

VetchOptions

The request options to which authentication needs to be added.

Returns

Promise<VetchOptions>

  • The request options with the added authentication.
Inherited from

Client.addQueryKeySecretToRequestBody

buildOIDCURL()
buildOIDCURL(state): string;

Defined in: packages/network-client/lib/networkClient.ts:191

Build the URL for the OIDC flow

Parameters
state

string = ''

The state to use

Returns

string

The URL for the OIDC flow

exchangeCodeForToken()
exchangeCodeForToken(code): Promise<NetworkTokenResponse>;

Defined in: packages/network-client/lib/networkClient.ts:224

Exchange the code for a network token

Parameters
code

string

The code to exchange

Returns

Promise<NetworkTokenResponse>

The network token token

getCIBAAccessToken()
protected getCIBAAccessToken(cibaRequestId): Promise<NetworkTokenResponse>;

Defined in: packages/network-client/lib/networkClient.ts:306

Get a network token

Parameters
cibaRequestId

string

The CIBA request id

Returns

Promise<NetworkTokenResponse>

The network token data

getCIBARequestId()
protected getCIBARequestId(): Promise<string>;

Defined in: packages/network-client/lib/networkClient.ts:355

Get an CIBA request id

Returns

Promise<string>

The CIBA request id

getCIBAToken()
protected getCIBAToken(): Promise<void>;

Defined in: packages/network-client/lib/networkClient.ts:283

Get the access token for the CIBA flow

This is a two step process. First we need to get an CIBA request id, then we can use that to get a network token.

Returns

Promise<void>

getConfig()
getConfig(): ConfigParams;

Defined in: packages/server-client/dist/lib/client.d.ts:36

Returns

ConfigParams

Inherited from

Client.getConfig

parseResponse()
protected parseResponse<T>(request, response): Promise<VetchResponse<T>>;

Defined in: packages/server-client/dist/lib/client.d.ts:168

Parses the response based on its content type.

Type Parameters
T

T

The expected type of the parsed response data.

Parameters
request

VetchOptions

The request options.

response

Response

The raw response from the request.

Returns

Promise<VetchResponse<T>>

  • The parsed response.
Inherited from

Client.parseResponse

prepareBody()
protected prepareBody(request): undefined | string;

Defined in: packages/server-client/dist/lib/client.d.ts:158

Prepares the body for the request based on the content type.

Parameters
request

VetchOptions

The request options.

Returns

undefined | string

  • The prepared request body as a string or undefined.
Inherited from

Client.prepareBody

prepareRequest()
protected prepareRequest(request): Promise<VetchOptions>;

Defined in: packages/server-client/dist/lib/client.d.ts:151

Prepares the request with necessary headers, authentication, and query parameters.

Parameters
request

VetchOptions

The initial request options.

Returns

Promise<VetchOptions>

  • The modified request options.
Inherited from

Client.prepareRequest

sendDeleteRequest()
sendDeleteRequest<T>(url): Promise<VetchResponse<T>>;

Defined in: packages/server-client/dist/lib/client.d.ts:78

Sends a DELETE request to the specified URL.

Type Parameters
T

T

Parameters
url

string

The URL endpoint for the DELETE request.

Returns

Promise<VetchResponse<T>>

  • The response from the DELETE request.
Inherited from

Client.sendDeleteRequest

sendFormSubmitRequest()
sendFormSubmitRequest<T>(url, payload?): Promise<VetchResponse<T>>;

Defined in: packages/server-client/dist/lib/client.d.ts:86

Sends a POST request with form data to the specified URL.

Type Parameters
T

T

Parameters
url

string

The URL endpoint for the POST request.

payload?

Record<string, undefined | string>

Optional payload containing form data to send with the POST request.

Returns

Promise<VetchResponse<T>>

  • The response from the POST request.
Inherited from

Client.sendFormSubmitRequest

sendGetRequest()
sendGetRequest<T>(url, queryParams?): Promise<VetchResponse<T>>;

Defined in: packages/server-client/dist/lib/client.d.ts:94

Sends a GET request to the specified URL with optional query parameters.

Type Parameters
T

T

Parameters
url

string

The URL endpoint for the GET request.

queryParams?

Optional query parameters to append to the URL. These should be compatible with Node's URLSearchParams.

Returns

Promise<VetchResponse<T>>

  • The response from the GET request.
Inherited from

Client.sendGetRequest

sendPatchRequest()
sendPatchRequest<T>(url, payload?): Promise<VetchResponse<T>>;

Defined in: packages/server-client/dist/lib/client.d.ts:104

Sends a PATCH request to the specified URL with an optional payload.

Type Parameters
T

T

Parameters
url

string

The URL endpoint for the PATCH request.

payload?

Optional payload to be sent as the body of the PATCH request.

Returns

Promise<VetchResponse<T>>

  • The response from the PATCH request.
Inherited from

Client.sendPatchRequest

sendPostRequest()
sendPostRequest<T>(url, payload?): Promise<VetchResponse<T>>;

Defined in: packages/server-client/dist/lib/client.d.ts:114

Sends a POST request to the specified URL with an optional payload.

Type Parameters
T

T

Parameters
url

string

The URL endpoint for the POST request.

payload?

Optional payload to be sent as the body of the POST request.

Returns

Promise<VetchResponse<T>>

  • The response from the POST request.
Inherited from

Client.sendPostRequest

sendPutRequest()
sendPutRequest<T>(url, payload?): Promise<VetchResponse<T>>;

Defined in: packages/server-client/dist/lib/client.d.ts:124

Sends a PUT request to the specified URL with an optional payload.

Type Parameters
T

T

Parameters
url

string

The URL endpoint for the PUT request.

payload?

Optional payload to be sent as the body of the PUT request.

Returns

Promise<VetchResponse<T>>

  • The response from the PUT request.
Inherited from

Client.sendPutRequest

sendRequest()
sendRequest<T>(request): Promise<VetchResponse<T>>;

Defined in: packages/server-client/dist/lib/client.d.ts:144

Sends a request adding necessary headers, handling authentication, and parsing the response.

Type Parameters
T

T

Parameters
request

VetchOptions

The options defining the request, including URL, method, headers, and data.

Returns

Promise<VetchResponse<T>>

  • The parsed response from the request.
Inherited from

Client.sendRequest

sendRequestWithData()
sendRequestWithData<T>(
   method, 
   url, 
payload?): Promise<VetchResponse<T>>;

Defined in: packages/server-client/dist/lib/client.d.ts:135

Sends a request with JSON-encoded data to the specified URL using the provided HTTP method.

Type Parameters
T

T

Parameters
method

The HTTP method to be used for the request (only POST, PATCH, or PUT are acceptable).

POST | PUT | PATCH

url

string

The URL endpoint for the request.

payload?

Optional payload to be sent as the body of the request, JSON-encoded.

Returns

Promise<VetchResponse<T>>

  • The response from the request.
Inherited from

Client.sendRequestWithData

Type Aliases

CIBAResponse

type CIBAResponse = object;

Defined in: packages/network-client/lib/types/responses/odicResponse.ts:1

Properties

auth_req_id
auth_req_id: string;

Defined in: packages/network-client/lib/types/responses/odicResponse.ts:5

CIBA ODIC token

expires_in
expires_in: number;

Defined in: packages/network-client/lib/types/responses/odicResponse.ts:10

Seconds until the token expires

interval?
optional interval: string;

Defined in: packages/network-client/lib/types/responses/odicResponse.ts:15

This is the minimum polling interval in seconds

NetworkAuthParameters

type NetworkAuthParameters = AuthParams & object;

Defined in: packages/network-client/lib/types/parameters/networkAuthParameters.ts:3

Type declaration

accessToken?
optional accessToken: string;

The access token to use for API calls

expiresIn?
optional expiresIn: number;

The expiration time of the access token (in seconds)

msisdn
msisdn: string;

The msisdn that will be used for API calls

NetworkConfigParameters

type NetworkConfigParameters = ConfigParams & object;

Defined in: packages/network-client/lib/types/parameters/networkConfigParameters.ts:3

Type declaration

networkApiHost?
optional networkApiHost: string;

URL for making calls to get a network token

odicHost?
optional odicHost: string;

URL for making calls to get a network token

redirectUri?
optional redirectUri: string;

The URL to redirect to for the OAuth flow

NetworkTokenResponse

type NetworkTokenResponse = object;

Defined in: packages/network-client/lib/types/responses/networkTokenResponse.ts:1

Properties

access_token
access_token: string;

Defined in: packages/network-client/lib/types/responses/networkTokenResponse.ts:5

The token

expires_in
expires_in: number;

Defined in: packages/network-client/lib/types/responses/networkTokenResponse.ts:15

The time in seconds from now that the token expires

token_type
token_type: "Bearer";

Defined in: packages/network-client/lib/types/responses/networkTokenResponse.ts:10

The type of token

Clone this wiki locally