@liblab/sdk v0.1.418

Liblab Typescript SDK 0.1.418

The Typescript SDK for Liblab.

• API version: 0.1.418
• SDK version: 0.1.418

Table of Contents

• Installation
• Authentication
  • Access Token
• API Endpoint Services
• API Models
• Sample Usage
• Environments
• Liblab Services
• License

Installation

npm install sdk

Authentication

To see whether an endpoint needs a specific type of authentication check the endpoint's documentation.

Access Token

The Liblab 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 Liblab('YOUR_ACCESS_TOKEN')

Or through the setAccessToken method:

const sdk = new Liblab()
sdk.setAccessToken('YOUR_ACCESS_TOKEN')

You can also set it for each service individually:

const sdk = new Liblab()
sdk.build.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 { Liblab } from '@liblab/sdk';


const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  try {
    const result = await sdk.build
      .getBuildStatuses();
    console.log(result);
  } catch (err) {
    const error = err as Error;
    console.error(error.message);
  }
})();

Environments

Here is the list of all available environments:

DEFAULT = 'https://api-dev.liblab.com',
PRODUCTION = 'https://api.liblab.com',
STAGING = 'https://api-staging.liblab.com',
DEVELOPMENT = 'https://api-dev.liblab.com'

How to set the environment:

const sdk = new Liblab();
sdk.setEnvironment(Environment.DEFAULT);

Liblab Services

A list of all services and services methods.

• Services

  • Build

  • Api

  • Org

  • OrgMember

  • Artifact

  • Sdk

  • Doc

  • HubSpot

  • OrgSubscriptions

  • Subscriptions

  • PaymentProvider

  • User

  • Snippets

  • Integration

  • Workflows

  • SpecValidation

  • Token

  • Invitation

  • Auth0

  • Plan

  • Invoice

  • HealthCheck

  • Tags

  • Ai

  • Feedback

  • UserEvent

  • ThirdPartyApplications

  • SpecFixer

  • McpServer

• All Methods

Build

Api

Org

OrgMember

Artifact

Sdk

Doc

HubSpot

OrgSubscriptions

Subscriptions

PaymentProvider

User

Snippets

Integration

Workflows

SpecValidation

Token

Invitation

Auth0

Plan

Invoice

HealthCheck

Tags

Ai

Feedback

UserEvent

ThirdPartyApplications

SpecFixer

McpServer

All Methods

createBuild

• HTTP Method: POST
• Endpoint: /builds

Required Parameters

| input | object | Request body. |

Return Type

BuildResponse

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const input = {};
  const result = await sdk.build.createBuild(input);
  console.log(result);
})();

getBuilds

• HTTP Method: GET
• Endpoint: /builds

Required Parameters

Return Type

PaginatedBuildResponse

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const result = await sdk.build.getBuilds(42, 10, 1, 'my-api');
  console.log(result);
})();

createSimpleBuild

• HTTP Method: POST
• Endpoint: /builds/simple

Required Parameters

| input | object | Request body. |

Return Type

BuildResponse

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const input = {
    apiId: 1,
    authentication: {},
    baseUrl: 'https://api-dev.liblab.com',
    docs: ['enhancedApiSpec', 'snippets', 'api'],
    languages: ['typescript'],
    liblabVersion: '2',
    sdkName: 'liblab',
    sdkVersion: '1.0.0',
  };
  const result = await sdk.build.createSimpleBuild(input);
  console.log(result);
})();

createBuildArtifact

• HTTP Method: POST
• Endpoint: /builds/{id}/artifact

Required Parameters

Return Type

BuildResponse

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const input = {};
  const result = await sdk.build.createBuildArtifact(input, 4753978.817569092);
  console.log(result);
})();

getBuildStatuses

• HTTP Method: GET
• Endpoint: /builds/statuses

Return Type

GetBuildStatusesResponse

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const result = await sdk.build.getBuildStatuses();
  console.log(result);
})();

getById

• HTTP Method: GET
• Endpoint: /builds/{id}

Required Parameters

Return Type

GetBuildByIdResponse

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const result = await sdk.build.getById(85924660.71519893);
  console.log(result);
})();

removeById

• HTTP Method: DELETE
• Endpoint: /builds/{buildId}/{apiSlug}/{orgId}

Required Parameters

Return Type

Returns a dict object.

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const result = await sdk.build.removeById(-57310310.25835431, 'apiSlug', 1357540.0123945475);
  console.log(result);
})();

tag

• HTTP Method: POST
• Endpoint: /builds/{buildId}/tag/{tagId}

Required Parameters

Return Type

Returns a dict object.

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const result = await sdk.build.tag(-33377936.261711657, 24798018.790846094);
  console.log(result);
})();

untag

• HTTP Method: POST
• Endpoint: /builds/{buildId}/untag/{tagId}

Required Parameters

Return Type

Returns a dict object.

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const result = await sdk.build.untag(-56078077.59539596, -16709904.642753586);
  console.log(result);
})();

approveBuild

• HTTP Method: PATCH
• Endpoint: /builds/{buildId}/approve

Required Parameters

Return Type

Returns a dict object.

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const result = await sdk.build.approveBuild(42881009.381103694);
  console.log(result);
})();

unApproveBuild

• HTTP Method: PATCH
• Endpoint: /builds/{buildId}/unapprove

Required Parameters

Return Type

Returns a dict object.

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const result = await sdk.build.unApproveBuild(99826196.1824511);
  console.log(result);
})();

getApiBuilds

• HTTP Method: GET
• Endpoint: /apis/{id}/builds

Required Parameters

Optional Parameters

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

Return Type

PaginatedBuildResponse

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const result = await sdk.api.getApiBuilds(-74306859.65547363, 42, 10, {
    sortBy: 'status',
    direction: 'asc',
    statuses: ['FAILURE'],
    tags: [1],
    createdByIds: [1],
  });
  console.log(result);
})();

getApiBuildTags

• HTTP Method: GET
• Endpoint: /apis/{id}/builds/tags

Required Parameters

Return Type

GetApiBuildTagsResponse

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const result = await sdk.api.getApiBuildTags(-10376151.13175106);
  console.log(result);
})();

getApiSdks

• HTTP Method: GET
• Endpoint: /apis/{id}/sdks

Required Parameters

Optional Parameters

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

Return Type

PaginatedSdkResponse

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const result = await sdk.api.getApiSdks(-95376817.1609851, 42, 10, {
    statuses: ['FAIL'],
    tags: [1],
    createdByIds: [1],
    languages: ['JAVA'],
    sortBy: 'createdAt',
    direction: 'asc',
  });
  console.log(result);
})();

getApiDocs

• HTTP Method: GET
• Endpoint: /apis/{id}/docs

Required Parameters

Optional Parameters

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

Return Type

PaginatedDocResponse

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const result = await sdk.api.getApiDocs(53352491.84560838, 42, 10, {
    sortBy: 'createdAt',
    direction: 'asc',
    statuses: ['FAIL'],
    tags: [1],
    createdByIds: [1],
  });
  console.log(result);
})();

createApi

• HTTP Method: POST
• Endpoint: /apis

Required Parameters

| input | object | Request body. |

Return Type

ApiResponse

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const input = {};
  const result = await sdk.api.createApi(input);
  console.log(result);
})();

getApis

• HTTP Method: GET
• Endpoint: /apis

Required Parameters

Optional Parameters

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

Return Type

GetApisResponse

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const result = await sdk.api.getApis(1, { apiSlug: 'my-api' });
  console.log(result);
})();

searchApis

• HTTP Method: GET
• Endpoint: /apis/search

Required Parameters

Optional Parameters

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

Return Type

ApisSearchPaginatedResponse

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const result = await sdk.api.searchApis(42, 10, {
    name: 'alpaca',
    sortBy: 'createdAt',
    orgId: 1,
    direction: 'asc',
    orgIds: [1],
  });
  console.log(result);
})();

getApiById

• HTTP Method: GET
• Endpoint: /apis/{id}

Required Parameters

Return Type

ApiResponse

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const result = await sdk.api.getApiById(-1636058.4384950846);
  console.log(result);
})();

updateApi

• HTTP Method: PATCH
• Endpoint: /apis/{id}

Required Parameters

Return Type

ApiResponse

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const input = { name: 'My api name', version: '1.0.1' };
  const result = await sdk.api.updateApi(input, -35426037.07420762);
  console.log(result);
})();

getApiMembers

• HTTP Method: GET
• Endpoint: /apis/{id}/members

Required Parameters

Return Type

GetApiMembersResponse

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const result = await sdk.api.getApiMembers(-20298758.74481885);
  console.log(result);
})();

removeApi

• HTTP Method: DELETE
• Endpoint: /apis/delete/{apiSlug}/{orgId}

Required Parameters

Return Type

Returns a dict object.

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const result = await sdk.api.removeApi('apiSlug', -80347104.60165368);
  console.log(result);
})();

getApiByOrgSlugAndApiSlug

• HTTP Method: GET
• Endpoint: /apis/{orgSlug}/{apiSlug}

Required Parameters

Return Type

GetApiByOrgSlugAndApiSlugResponse

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const result = await sdk.api.getApiByOrgSlugAndApiSlug('orgSlug', 'apiSlug');
  console.log(result);
})();

createOrg

• HTTP Method: POST
• Endpoint: /orgs

Required Parameters

| input | object | Request body. |

Return Type

OrgResponse

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const input = {
    description: 'Example Org Description',
    domain: 'business.com',
    logoUrl: 'https://liblab.com/images/logo.png',
    name: 'Example Org',
    website: 'https://example.com',
  };
  const result = await sdk.org.createOrg(input);
  console.log(result);
})();

getOrgs

• HTTP Method: GET
• Endpoint: /orgs

Required Parameters

Optional Parameters

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

Return Type

AdminPaginatedOrgResponse

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const result = await sdk.org.getOrgs(42, 10, { direction: 'asc', sortBy: 'status' });
  console.log(result);
})();

searchOrgs

• HTTP Method: GET
• Endpoint: /orgs/search

Required Parameters

Optional Parameters

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

Return Type

AdminPaginatedOrgResponse

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const result = await sdk.org.searchOrgs(42, 10, {
    website: 'https://liblab.com',
    domain: 'liblab.com',
    name: 'liblab',
  });
  console.log(result);
})();

getOrgById

• HTTP Method: GET
• Endpoint: /orgs/{id}

Required Parameters

Return Type

GetOrgByIdResponse

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const result = await sdk.org.getOrgById(-8302902.540178582);
  console.log(result);
})();

updateOrg

• HTTP Method: PATCH
• Endpoint: /orgs/{id}

Required Parameters

Return Type

OrgResponse

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const input = {
    description: 'Example Org Description',
    domain: 'example.com',
    isAllowedForBeta: true,
    logoUrl: 'https://liblab.com/images/logo.png',
    name: 'Example Org',
    remainingCredits: 19,
    website: 'https://example.com',
  };
  const result = await sdk.org.updateOrg(input, -22499004.887146696);
  console.log(result);
})();

removeOrg

• HTTP Method: DELETE
• Endpoint: /orgs/{id}

Required Parameters

Return Type

Returns a dict object.

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const result = await sdk.org.removeOrg(39925014.38744345);
  console.log(result);
})();

getApisByOrg

• HTTP Method: GET
• Endpoint: /orgs/{id}/apis

Required Parameters

Return Type

GetApisByOrgResponse

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const result = await sdk.org.getApisByOrg(-63922262.37631235);
  console.log(result);
})();

getOrgJobs

• HTTP Method: GET
• Endpoint: /orgs/{id}/jobs

Required Parameters

Optional Parameters

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

Return Type

PaginatedOrgJobsResponseWithTotalCount

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const result = await sdk.org.getOrgJobs(24870896.608148873, 42, 10, {
    sortBy: 'status',
    direction: 'asc',
    statuses: ['FAILURE'],
    createdByIds: [1],
    apiSlug: 'my-api',
    apiVersion: '1.0.0',
    buildType: ['SDK', 'DOC'],
  });
  console.log(result);
})();

getDocsByOrg

• HTTP Method: GET
• Endpoint: /orgs/{id}/docs

Required Parameters

Return Type

GetDocsByOrgResponse

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const result = await sdk.org.getDocsByOrg(-45019651.23638914);
  console.log(result);
})();

getBuildByOrg

• HTTP Method: GET
• Endpoint: /orgs/{id}/builds

Required Parameters

Optional Parameters

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

Return Type

PaginatedOrgBuildsWithJobsResponseWithTotalCount

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const result = await sdk.org.getBuildByOrg(-10520633.02970168, 42, 10, {
    sortBy: 'status',
    direction: 'asc',
    statuses: ['FAILURE'],
    tags: [1],
    createdByIds: [1],
    apiSlug: 'my-api',
    apiVersion: '1.0.0',
  });
  console.log(result);
})();

getOrgApiBuilds

• HTTP Method: GET
• Endpoint: /orgs/{id}/api-builds

Required Parameters

Return Type

GetOrgApiBuildsResponse

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const result = await sdk.org.getOrgApiBuilds(-26286210.62686123);
  console.log(result);
})();

getOrgArtifacts

• HTTP Method: GET
• Endpoint: /orgs/{id}/artifacts

Required Parameters

Optional Parameters

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

Return Type

PaginatedOrgArtifactsResponse

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const result = await sdk.org.getOrgArtifacts(68445276.7768136, 42, 10, {
    sortBy: 'status',
    direction: 'asc',
    artifactTypes: ['SDK'],
    statuses: ['IN_PROGRESS'],
    createdByIds: [1],
  });
  console.log(result);
})();

createMember

• HTTP Method: POST
• Endpoint: /orgs/{orgId}/members

Required Parameters

Return Type

OrgMemberResponse

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const input = { role: 'MEMBER', userId: 1 };
  const result = await sdk.orgMember.createMember(input, -89596096.02510458);
  console.log(result);
})();

getByOrgId

• HTTP Method: GET
• Endpoint: /orgs/{orgId}/members

Required Parameters

Optional Parameters

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

Return Type

PaginatedOrgMemberResponse

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const result = await sdk.orgMember.getByOrgId(5088950.625721946, 42, 10, {
    email: 'john@liblab.com',
    firstName: 'John',
    lastName: 'Doe',
    sortBy: 'createdAt',
    direction: 'asc',
  });
  console.log(result);
})();

updateMember

• HTTP Method: PATCH
• Endpoint: /orgs/{orgId}/members/{userId}

Required Parameters

Return Type

OrgMemberResponse

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const input = { orgId: 1, role: 'MEMBER' };
  const result = await sdk.orgMember.updateMember(input, -66671542.53919483, -51305398.64576833);
  console.log(result);
})();

removeMember

• HTTP Method: DELETE
• Endpoint: /orgs/{orgId}/members/{userId}

Required Parameters

Return Type

Returns a dict object.

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const result = await sdk.orgMember.removeMember(54864116.27097607, 62395554.00692743);
  console.log(result);
})();

leaveOrg

• HTTP Method: DELETE
• Endpoint: /orgs/{orgId}/leave

Required Parameters

Return Type

Returns a dict object.

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const result = await sdk.orgMember.leaveOrg(-31971660.352570996);
  console.log(result);
})();

enableAllMembers

• HTTP Method: PATCH
• Endpoint: /orgs/{orgId}/enable

Required Parameters

Return Type

UpdateManyOrgMembersResponse

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const result = await sdk.orgMember.enableAllMembers(-90630088.44956145);
  console.log(result);
})();

disableAllMembers

• HTTP Method: PATCH
• Endpoint: /orgs/{orgId}/disable

Required Parameters

Return Type

UpdateManyOrgMembersResponse

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const result = await sdk.orgMember.disableAllMembers(-86739175.38664648);
  console.log(result);
})();

createArtifact

• HTTP Method: POST
• Endpoint: /artifacts

Required Parameters

| input | object | Request body. |

Return Type

ArtifactResponse

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const input = {
    artifactType: 'DOC',
    bucketKey: 'bucketKey',
    bucketName: 'bucketName',
    buildId: 1,
    status: 'SUCCESS',
  };
  const result = await sdk.artifact.createArtifact(input);
  console.log(result);
})();

getArtifacts

• HTTP Method: GET
• Endpoint: /artifacts

Required Parameters

Return Type

GetArtifactsResponse

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const result = await sdk.artifact.getArtifacts(1);
  console.log(result);
})();

getArtifactStatuses

• HTTP Method: GET
• Endpoint: /artifacts/statuses

Return Type

GetArtifactStatusesResponse

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const result = await sdk.artifact.getArtifactStatuses();
  console.log(result);
})();

getArtifactById

• HTTP Method: GET
• Endpoint: /artifacts/{id}

Required Parameters

Return Type

ArtifactResponse

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const result = await sdk.artifact.getArtifactById(-37405372.79036275);
  console.log(result);
})();

removeArtifact

• HTTP Method: DELETE
• Endpoint: /artifacts/{id}

Required Parameters

Return Type

Returns a dict object.

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const result = await sdk.artifact.removeArtifact(-63027275.57936252);
  console.log(result);
})();

createSdk

• HTTP Method: POST
• Endpoint: /sdks

Required Parameters

| input | object | Request body. |

Return Type

SdkResponse

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const input = {
    artifactId: 1,
    fileLocation: 'https://my-file.location',
    language: 'JAVA',
    version: '1.0.0',
  };
  const result = await sdk.sdk.createSdk(input);
  console.log(result);
})();

findSdks

• HTTP Method: GET
• Endpoint: /sdks

Required Parameters

Optional Parameters

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

Return Type

PaginatedSdkResponse

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const result = await sdk.sdk.findSdks(42, 10, {
    artifactId: 1,
    sortBy: 'version',
    direction: 'asc',
    languages: ['TYPESCRIPT'],
  });
  console.log(result);
})();

getSdkById

• HTTP Method: GET
• Endpoint: /sdks/{id}

Required Parameters

Return Type

SdkResponse

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const result = await sdk.sdk.getSdkById(-96509278.26448834);
  console.log(result);
})();

removeSdk

• HTTP Method: DELETE
• Endpoint: /sdks/{id}

Required Parameters

Return Type

Returns a dict object.

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const result = await sdk.sdk.removeSdk(76365442.07183263);
  console.log(result);
})();

getApprovedByOrgSlugAndApiSlug

• HTTP Method: GET
• Endpoint: /docs/approved

Required Parameters

Optional Parameters

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

Return Type

DocResponse

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const result = await sdk.doc.getApprovedByOrgSlugAndApiSlug('orgSlug', {
    apiSlug: 'apiSlug',
    apiVersion: 'apiVersion',
  });
  console.log(result);
})();

getAllApprovedByOrgSlugAndApiSlug

• HTTP Method: GET
• Endpoint: /docs/approved/all

Required Parameters

Optional Parameters

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

Return Type

GetAllApprovedByOrgSlugAndApiSlugResponse

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const result = await sdk.doc.getAllApprovedByOrgSlugAndApiSlug('orgSlug', {
    apiSlug: 'apiSlug',
    apiVersion: 'apiVersion',
  });
  console.log(result);
})();

createDoc

• HTTP Method: POST
• Endpoint: /docs

Required Parameters

| input | object | Request body. |

Return Type

DocCreatedResponse

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const input = {
    apiId: -65325002.96215722,
    artifactId: 1,
    fileLocation: 'https://example.com',
    previewSlug: 'previewSlug',
    version: '1.0.0',
  };
  const result = await sdk.doc.createDoc(input);
  console.log(result);
})();

findDocs

• HTTP Method: GET
• Endpoint: /docs

Required Parameters

Return Type

PaginatedDocResponse

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const result = await sdk.doc.findDocs(42, 10, 1);
  console.log(result);
})();

approve

• HTTP Method: POST
• Endpoint: /docs/{previewSlug}/approve

Required Parameters

Return Type

DocResponse

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const result = await sdk.doc.approve('previewSlug');
  console.log(result);
})();

unapprove

• HTTP Method: POST
• Endpoint: /docs/{previewSlug}/unapprove

Required Parameters

Return Type

DocResponse

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const result = await sdk.doc.unapprove('previewSlug');
  console.log(result);
})();

getDocById

• HTTP Method: GET
• Endpoint: /docs/{id}

Required Parameters

Return Type

DocResponse

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const result = await sdk.doc.getDocById(-95554666.9262227);
  console.log(result);
})();

removeDoc

• HTTP Method: DELETE
• Endpoint: /docs/{id}

Required Parameters

Return Type

Returns a dict object.

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const result = await sdk.doc.removeDoc(38610583.231470704);
  console.log(result);
})();

updateDoc

• HTTP Method: PUT
• Endpoint: /docs/{id}

Required Parameters

Return Type

DocResponse

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const input = { fileLocation: 'https://example.com', version: '1.0.0' };
  const result = await sdk.doc.updateDoc(input, 44538902.7978985);
  console.log(result);
})();

getDownloadUrl

• HTTP Method: GET
• Endpoint: /docs/{id}/getDownloadUrl

Required Parameters

Return Type

DocDownloadResponse

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const result = await sdk.doc.getDownloadUrl(3234304.1423680037);
  console.log(result);
})();

sendShadowForm

• HTTP Method: POST
• Endpoint: /hubspot/shadow-form

Required Parameters

| input | object | Request body. |

Return Type

Returns a dict object.

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const input = { fields: [{ name: 'test-name', value: 'test-field' }] };
  const result = await sdk.hubSpot.sendShadowForm(input);
  console.log(result);
})();

getActiveSubscription

• HTTP Method: GET
• Endpoint: /orgs/{orgId}/subscriptions/active

Required Parameters

Return Type

SubscriptionResponse

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const result = await sdk.orgSubscriptions.getActiveSubscription(72925064.71865776);
  console.log(result);
})();

cancelActiveSubscription

• HTTP Method: POST
• Endpoint: /orgs/{orgId}/subscriptions/active/cancel

Required Parameters

Return Type

SubscriptionResponse

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const result = await sdk.orgSubscriptions.cancelActiveSubscription(-54527464.200656794);
  console.log(result);
})();

getActiveSubscriptionStatus

• HTTP Method: GET
• Endpoint: /orgs/{orgId}/subscriptions/active/state

Required Parameters

Return Type

GetActiveSubscriptionStatusResponse

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const result = await sdk.orgSubscriptions.getActiveSubscriptionStatus(-72619252.98952132);
  console.log(result);
})();

getSubscriptionPaymentMethodUpdateLink

• HTTP Method: GET
• Endpoint: /orgs/{orgId}/subscriptions/{subscriptionId}/payment-methods/update-link

Required Parameters

Return Type

CheckoutLinkResponse

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const result = await sdk.orgSubscriptions.getSubscriptionPaymentMethodUpdateLink(
    6552209.0864376575,
    -36908531.59113945,
  );
  console.log(result);
})();

getCheckoutLink

• HTTP Method: GET
• Endpoint: /orgs/{orgId}/subscriptions/checkout/link

Required Parameters

Return Type

CheckoutLinkResponse

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const result = await sdk.orgSubscriptions.getCheckoutLink(-19598013.322416946, 1, 'year');
  console.log(result);
})();

getSubscriptionsOverview

• HTTP Method: GET
• Endpoint: /subscriptions

Return Type

SubscriptionsOverviewResponse

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const result = await sdk.subscriptions.getSubscriptionsOverview();
  console.log(result);
})();

stripeWebhook

• HTTP Method: POST
• Endpoint: /payment-provider/stripe/webhook

Required Parameters

Return Type

Returns a dict object.

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const result = await sdk.paymentProvider.stripeWebhook('stripe-signature');
  console.log(result);
})();

syncStripeSubscriptions

• HTTP Method: POST
• Endpoint: /payment-provider/stripe/subscriptions/sync

Return Type

Returns a dict object.

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const result = await sdk.paymentProvider.syncStripeSubscriptions();
  console.log(result);
})();

getCurrentUser

• HTTP Method: GET
• Endpoint: /users/current-user

Return Type

CurrentUserResponse

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const result = await sdk.user.getCurrentUser();
  console.log(result);
})();

createUser

• HTTP Method: POST
• Endpoint: /users

Required Parameters

| input | object | Request body. |

Return Type

UserResponse

Example Usage Code Snippet

import { Liblab } from '@liblab/sdk';

const sdk = new Liblab({ accessToken: process.env.LIBLAB_ACCESS_TOKEN });

(async () => {
  const input = {
    auth0Id: 'auth0|123',
    email: 'someone@example.com',
    firstName: 'John',
    lastName: 'Doe',
    password: 'Password123!',
    signupMethod: 'DEFAULT',
  };
  const result = await sdk.user.createUser(input);
  console.log(result);
})();

getUsers

• HTTP Method: GET
• Endpoint: /users

**Required Paramet