Directory - Syllable SDK

Available Operations

list - Directory Member List
create - Create Directory Member
getById - Get Directory Member By Id
update - Update Directory Member
delete - Delete Directory Member
directoryMemberBulkLoad - Bulk Load Directory Members
directoryMemberDownload - Download Directory Members

list

List the existing directory_members

Example Usage

import { SyllableSDK } from "syllable-sdk";

const syllableSDK = new SyllableSDK({
  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});

async function run() {
  const result = await syllableSDK.directory.list({});

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

run();

Standalone function

The standalone function version of this method:

import { SyllableSDKCore } from "syllable-sdk/core.js";
import { directoryList } from "syllable-sdk/funcs/directoryList.js";

// Use `SyllableSDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const syllableSDK = new SyllableSDKCore({
  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});

async function run() {
  const res = await directoryList(syllableSDK, {});

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

  const { value: result } = res;

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

run();

Parameters

Parameter	Type	Required	Description
`request`	operations.DirectoryMemberListRequest	TRUE	The request object to use for the request.
`options`	RequestOptions	FALSE	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	FALSE	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	FALSE	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<components.ListResponseDirectoryMember>

Errors

Error Type	Status Code	Content Type
errors.HTTPValidationError	422	application/json
errors.SDKError	4XX, 5XX	/

create

Create a new member in the directory

Example Usage

import { SyllableSDK } from "syllable-sdk";

const syllableSDK = new SyllableSDK({
  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});

async function run() {
  const result = await syllableSDK.directory.create({
    name: "<value>",
    type: "<value>",
  });

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

run();

Standalone function

The standalone function version of this method:

import { SyllableSDKCore } from "syllable-sdk/core.js";
import { directoryCreate } from "syllable-sdk/funcs/directoryCreate.js";

// Use `SyllableSDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const syllableSDK = new SyllableSDKCore({
  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});

async function run() {
  const res = await directoryCreate(syllableSDK, {
    name: "<value>",
    type: "<value>",
  });

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

  const { value: result } = res;

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

run();

Parameters

Parameter	Type	Required	Description
`request`	components.DirectoryMemberCreate	TRUE	The request object to use for the request.
`options`	RequestOptions	FALSE	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	FALSE	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	FALSE	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<components.DirectoryMember>

Errors

Error Type	Status Code	Content Type
errors.HTTPValidationError	422	application/json
errors.SDKError	4XX, 5XX	/

getById

Get a DirectoryMember by ID.

Example Usage

import { SyllableSDK } from "syllable-sdk";

const syllableSDK = new SyllableSDK({
  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});

async function run() {
  const result = await syllableSDK.directory.getById({
    memberId: 931598,
  });

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

run();

Standalone function

The standalone function version of this method:

import { SyllableSDKCore } from "syllable-sdk/core.js";
import { directoryGetById } from "syllable-sdk/funcs/directoryGetById.js";

// Use `SyllableSDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const syllableSDK = new SyllableSDKCore({
  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});

async function run() {
  const res = await directoryGetById(syllableSDK, {
    memberId: 931598,
  });

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

  const { value: result } = res;

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

run();

Parameters

Parameter	Type	Required	Description
`request`	operations.DirectoryMemberGetByIdRequest	TRUE	The request object to use for the request.
`options`	RequestOptions	FALSE	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	FALSE	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	FALSE	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<components.DirectoryMember>

Errors

Error Type	Status Code	Content Type
errors.HTTPValidationError	422	application/json
errors.SDKError	4XX, 5XX	/

update

Update a DirectoryMember.

Example Usage

import { SyllableSDK } from "syllable-sdk";

const syllableSDK = new SyllableSDK({
  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});

async function run() {
  const result = await syllableSDK.directory.update({
    memberId: 597129,
    directoryMember: {
      name: "<value>",
      type: "<value>",
      id: 857478,
    },
  });

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

run();

Standalone function

The standalone function version of this method:

import { SyllableSDKCore } from "syllable-sdk/core.js";
import { directoryUpdate } from "syllable-sdk/funcs/directoryUpdate.js";

// Use `SyllableSDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const syllableSDK = new SyllableSDKCore({
  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});

async function run() {
  const res = await directoryUpdate(syllableSDK, {
    memberId: 597129,
    directoryMember: {
      name: "<value>",
      type: "<value>",
      id: 857478,
    },
  });

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

  const { value: result } = res;

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

run();

Parameters

Parameter	Type	Required	Description
`request`	operations.DirectoryMemberUpdateRequest	TRUE	The request object to use for the request.
`options`	RequestOptions	FALSE	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	FALSE	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	FALSE	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<components.DirectoryMember>

Errors

Error Type	Status Code	Content Type
errors.HTTPValidationError	422	application/json
errors.SDKError	4XX, 5XX	/

delete

Delete a DirectoryMember.

Example Usage

import { SyllableSDK } from "syllable-sdk";

const syllableSDK = new SyllableSDK({
  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});

async function run() {
  const result = await syllableSDK.directory.delete({
    memberId: 545907,
  });

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

run();

Standalone function

The standalone function version of this method:

import { SyllableSDKCore } from "syllable-sdk/core.js";
import { directoryDelete } from "syllable-sdk/funcs/directoryDelete.js";

// Use `SyllableSDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const syllableSDK = new SyllableSDKCore({
  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});

async function run() {
  const res = await directoryDelete(syllableSDK, {
    memberId: 545907,
  });

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

  const { value: result } = res;

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

run();

Parameters

Parameter	Type	Required	Description
`request`	operations.DirectoryMemberDeleteRequest	TRUE	The request object to use for the request.
`options`	RequestOptions	FALSE	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	FALSE	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	FALSE	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<Any>

Errors

Error Type	Status Code	Content Type
errors.HTTPValidationError	422	application/json
errors.SDKError	4XX, 5XX	/

directoryMemberBulkLoad

Update Directory Members in chunks of 100.

Example Usage

import { openAsBlob } from "node:fs";
import { SyllableSDK } from "syllable-sdk";

const syllableSDK = new SyllableSDK({
  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});

async function run() {
  const result = await syllableSDK.directory.directoryMemberBulkLoad({
    file: await openAsBlob("example.file"),
  });

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

run();

Standalone function

The standalone function version of this method:

import { openAsBlob } from "node:fs";
import { SyllableSDKCore } from "syllable-sdk/core.js";
import { directoryDirectoryMemberBulkLoad } from "syllable-sdk/funcs/directoryDirectoryMemberBulkLoad.js";

// Use `SyllableSDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const syllableSDK = new SyllableSDKCore({
  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});

async function run() {
  const res = await directoryDirectoryMemberBulkLoad(syllableSDK, {
    file: await openAsBlob("example.file"),
  });

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

  const { value: result } = res;

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

run();

Parameters

Parameter	Type	Required	Description
`request`	components.BodyDirectoryMemberBulkLoad	TRUE	The request object to use for the request.
`options`	RequestOptions	FALSE	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	FALSE	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	FALSE	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<Any>

Errors

Error Type	Status Code	Content Type
errors.HTTPValidationError	422	application/json
errors.SDKError	4XX, 5XX	/

directoryMemberDownload

Download the entire directory as a JSON file.

Example Usage

import { SyllableSDK } from "syllable-sdk";

const syllableSDK = new SyllableSDK({
  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});

async function run() {
  const result = await syllableSDK.directory.directoryMemberDownload();

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

run();

Standalone function

The standalone function version of this method:

import { SyllableSDKCore } from "syllable-sdk/core.js";
import { directoryDirectoryMemberDownload } from "syllable-sdk/funcs/directoryDirectoryMemberDownload.js";

// Use `SyllableSDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const syllableSDK = new SyllableSDKCore({
  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});

async function run() {
  const res = await directoryDirectoryMemberDownload(syllableSDK);

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

  const { value: result } = res;

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

run();

Parameters

Parameter	Type	Required	Description
`options`	RequestOptions	FALSE	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	FALSE	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	FALSE	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<Any>

Errors

Error Type	Status Code	Content Type
errors.SDKError	4XX, 5XX	/

SDK Reference

Configuration & Settings

Insights & Analytics

Models

​Available Operations

​list

​Example Usage

​Standalone function

​Parameters

​Response

​Errors

​create

​Example Usage

​Standalone function

​Parameters

​Response

​Errors

​getById

​Example Usage

​Standalone function

​Parameters

​Response

​Errors

​update

​Example Usage

​Standalone function

​Parameters

​Response

​Errors

​delete

​Example Usage

​Standalone function

​Parameters

​Response

​Errors

​directoryMemberBulkLoad

​Example Usage

​Standalone function

​Parameters

​Response

​Errors

​directoryMemberDownload

​Example Usage

​Standalone function

​Parameters

​Response

​Errors

Available Operations

list

Example Usage

Standalone function

Parameters

Response

Errors

create

Example Usage

Standalone function

Parameters

Response

Errors

getById

Example Usage

Standalone function

Parameters

Response

Errors

update

Example Usage

Standalone function

Parameters

Response

Errors

delete

Example Usage

Standalone function

Parameters

Response

Errors

directoryMemberBulkLoad

Example Usage

Standalone function

Parameters

Response

Errors

directoryMemberDownload

Example Usage

Standalone function

Parameters

Response

Errors