@liblab/sdk v0.1.164

Liblab Typescript SDK 0.1.164

The Typescript SDK for Liblab.

• API version: 0.1.164
• SDK version: 0.1.164

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

  • Subscription

  • PaymentProvider

  • User

  • Snippets

  • Token

  • Invitation

  • Auth0

  • Plan

  • Invoice

  • Spec

  • HealthCheck

  • Tags

  • Ai

  • Feedback

  • UserEvent

• All Methods

Build

Api

Org

OrgMember

Artifact

Sdk

Doc

HubSpot

Subscription

PaymentProvider

User

Snippets

Token

Invitation

Auth0

Plan

Invoice

Spec

HealthCheck

Tags

Ai

Feedback

UserEvent

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(
    -52863462.924145386,
    -8018355.237383604,
    6183107.269605964,
    'apiSlug',
  );
  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(49815269.12318176);
  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(57785128.23107013, 'apiSlug', -66203752.39651564);
  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(83897543.8697618, 61265827.55609974);
  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(-38417567.698575675, -14726378.245189637);
  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(-53314421.30668784);
  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(87693802.15969965);
  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(
    69821860.14108804,
    -98326273.70310871,
    -67756685.69077724,
    {
      sortBy: 'startTime',
      direction: 'asc',
      statuses: ['IN_PROGRESS', 'SUCCESS'],
      tags: [61200750.71106207, -21009571.03353554],
      createdByIds: [-67425529.60890844, -13557497.112228528],
    },
  );
  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(-87597291.82664976);
  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(
    -44253250.38671874,
    -31061766.992734358,
    -84281533.54168415,
    {
      statuses: ['IN_PROGRESS', 'IN_PROGRESS'],
      tags: [-91085656.1084449, -1108481.2273906618],
      createdByIds: [86073744.96788594, -90295434.94853729],
      languages: ['PYTHON', '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(
    82868332.44604951,
    -51884773.63235693,
    -45933343.144203216,
    {
      sortBy: 'createdAt',
      direction: 'asc',
      statuses: ['FAIL', 'IN_PROGRESS'],
      tags: [41527071.66297281, -12120851.921760246],
      createdByIds: [94081281.87313244, -57563716.343770646],
    },
  );
  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(10284477.760221615, { apiSlug: 'apiSlug' });
  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(-71397766.47973499, -53255550.54016885, {
    name: 'name',
    sortBy: 'createdAt',
    orgId: 23262804.36192088,
    direction: 'desc',
    orgIds: [42807345.84256658, -82653219.62655014],
  });
  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(-20859461.491737545);
  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, -58390200.82156012);
  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(8475784.91190371);
  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', 96262842.85218075);
  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(33492537.885055155, -11598549.87367718, {
    direction: 'asc',
    sortBy: 'createdAt',
  });
  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(64606389.34497553, -1083734.466355607, {
    website: 'website',
    domain: 'domain',
    name: 'name',
  });
  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(75566001.16182917);
  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, 76707417.87152693);
  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(40737048.54679993);
  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(56009520.75140494);
  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(
    -33069249.406111464,
    37035208.70661524,
    -6696916.755440503,
    {
      sortBy: 'startTime',
      direction: 'asc',
      statuses: ['FAILURE', 'SUCCESS'],
      createdByIds: [55166384.58048439, -6115538.133790374],
      apiSlug: 'apiSlug',
      apiVersion: 'apiVersion',
      buildType: ['SNIPPETS', 'SDK'],
    },
  );
  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(-48183852.873241715);
  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(
    27338128.7482581,
    -93599512.37127766,
    -56025653.57892912,
    {
      sortBy: 'startTime',
      direction: 'asc',
      statuses: ['IN_PROGRESS', 'SUCCESS'],
      tags: [12826804.010849059, -85351337.19266534],
      createdByIds: [-25685250.437820926, -10692742.10487014],
      apiSlug: 'apiSlug',
      apiVersion: 'apiVersion',
    },
  );
  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(20726960.13224098);
  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(
    -90921380.80980998,
    -13166737.72057037,
    -9242997.601805791,
    {
      sortBy: 'startTime',
      direction: 'desc',
      artifactTypes: ['DOC', 'SDK'],
      statuses: [{ imports: [] }, { imports: [] }],
      createdByIds: [-95408333.66248384, 26307903.40419078],
    },
  );
  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, -16385691.434204474);
  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(
    78059894.55917269,
    -88958232.44085377,
    -47681286.38673235,
    {
      email: 'email',
      firstName: 'firstName',
      lastName: 'lastName',
      sortBy: 'role',
      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, -62282803.82880826, -59580779.745431475);
  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(-24914493.793131292, 86427825.40995243);
  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(-68056830.17017321);
  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(70498898.29904589);
  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(-48089368.5786707);
  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(98452577.58124095);
  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(68305672.3085787);
  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(4278808.800179139);
  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(-4058071.1465366036, -3869043.566834092, {
    artifactId: 70422276.01256844,
    sortBy: 'language',
    direction: 'asc',
    languages: ['GO', '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(-26730809.394670546);
  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(26456680.99273379);
  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: 83732725.51629487,
    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(-10335.081092759967, -42661391.37347782, -6363592.02352415);
  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(-90062008.76921144);
  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(88027084.3453745);
  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, -61441841.43124725);
  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(-90525941.75223225);
  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.subscription.getActiveSubscription(14610253.111368403);
  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.subscription.cancelActiveSubscription(-36174802.5630793);
  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.subscription.getActiveSubscriptionStatus(54679020.788782746);
  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.subscription.getSubscriptionPaymentMethodUpdateLink(
    -57417340.94658062,
    62284189.16196734,
  );
  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.subscription.getCheckoutLink(
    34103639.66808654,
    93875446.5632737,
    'year',
  );
  console.log(result);
})();

createOpenSourceSubscription

• HTTP Method: POST
• Endpoint: /orgs/{orgId}/subscriptions/open-source

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 input = { openSourceProjectUrl: 'https://github.com/liblaber/api' };
  const result = await sdk.subscription.createOpenSourceSubscription(input, -657506.9204562753);
  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 Parameters

Optional Parameters

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

Return Type

UsersResponse

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.getUsers(76917510.05405271, -30267309.706219897, {
    orgId: 89422741.76572362,
    email: 'email',
    firstName: 'firstName',
    lastName: 'lastName',
    orgIds: [-15938503.902351141, 59726943.02839044],
    sortBy: 'createdAt',
    direction: 'desc',
  });
  console.log(result);
})();

getUserById

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

Required Parameters

Return Type

UserResponse

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.getUserById(58146303.92401278);
  console.log(result);
})();

updateUser

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

Required Parameters

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 = {
    email: 'someone@example.com',
    firstName: 'John',
    isEnabled: true,
    isLiblabAdmin: true,
    lastName: 'Doe',
    refreshTokenHash: 'refreshTokenHash',
  };
  const result = await sdk.user.updateUser(input, -16027967.956765458);
  console.log(result);
})();

removeUser

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

Required Parameters

Return Type

Return