Skip to content

Latest commit

 

History

History
179 lines (130 loc) · 12.2 KB

README.md

File metadata and controls

179 lines (130 loc) · 12.2 KB

Authentication

(subscribers.authentication)

Overview

Available Operations

chatAccessOauthCallBack

Handle providers oauth redirect

Example Usage

import { Novu } from "@novu/api";

const novu = new Novu({
  apiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await novu.subscribers.authentication.chatAccessOauthCallBack({
    subscriberId: "<id>",
    providerId: "<id>",
    hmacHash: "<value>",
    environmentId: "<id>",
    code: "<value>",
  });

  // Handle the result
  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { NovuCore } from "@novu/api/core.js";
import { subscribersAuthenticationChatAccessOauthCallBack } from "@novu/api/funcs/subscribersAuthenticationChatAccessOauthCallBack.js";

// Use `NovuCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const novu = new NovuCore({
  apiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const res = await subscribersAuthenticationChatAccessOauthCallBack(novu, {
    subscriberId: "<id>",
    providerId: "<id>",
    hmacHash: "<value>",
    environmentId: "<id>",
    code: "<value>",
  });

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

  // Handle the result
  console.log(result);
}

run();

Parameters

Parameter Type Required Description
request operations.SubscribersControllerChatOauthCallbackRequest ✔️ The request object to use for the request.
options RequestOptions ➖ Used to set various options for making HTTP requests.
options.fetchOptions RequestInit ➖ Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries RetryConfig ➖ Enables retrying HTTP requests under certain failure conditions.

Response

Promise<operations.SubscribersControllerChatOauthCallbackResponse>

Errors

Error Type Status Code Content Type
errors.ErrorDto 400, 404, 409 application/json
errors.ValidationErrorDto 422 application/json
errors.SDKError 4XX, 5XX */*

chatAccessOauth

Handle chat oauth

Example Usage

import { Novu } from "@novu/api";

const novu = new Novu({
  apiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await novu.subscribers.authentication.chatAccessOauth({
    subscriberId: "<id>",
    providerId: "<id>",
    hmacHash: "<value>",
    environmentId: "<id>",
  });

  // Handle the result
  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { NovuCore } from "@novu/api/core.js";
import { subscribersAuthenticationChatAccessOauth } from "@novu/api/funcs/subscribersAuthenticationChatAccessOauth.js";

// Use `NovuCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const novu = new NovuCore({
  apiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const res = await subscribersAuthenticationChatAccessOauth(novu, {
    subscriberId: "<id>",
    providerId: "<id>",
    hmacHash: "<value>",
    environmentId: "<id>",
  });

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

  // Handle the result
  console.log(result);
}

run();

Parameters

Parameter Type Required Description
request operations.SubscribersControllerChatAccessOauthRequest ✔️ The request object to use for the request.
options RequestOptions ➖ Used to set various options for making HTTP requests.
options.fetchOptions RequestInit ➖ Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries RetryConfig ➖ Enables retrying HTTP requests under certain failure conditions.

Response

Promise<operations.SubscribersControllerChatAccessOauthResponse>

Errors

Error Type Status Code Content Type
errors.ErrorDto 400, 404, 409 application/json
errors.ValidationErrorDto 422 application/json
errors.SDKError 4XX, 5XX */*