@liblab/sdk

Liblab Typescript SDK 0.1.391

The Typescript SDK for Liblab.

• API version: 0.1.391
• SDK version: 0.1.391

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

• All Methods

Build

Method	Description
createBuild
getBuilds
createSimpleBuild
createBuildArtifact
getBuildStatuses
getById
removeById
tag
untag
approveBuild
unApproveBuild

Api

Method	Description
getApiBuilds
getApiBuildTags
getApiSdks
getApiDocs
createApi
getApis
searchApis
getApiById
updateApi
getApiMembers
removeApi
getApiByOrgSlugAndApiSlug

Org

Method	Description
createOrg
getOrgs
searchOrgs
getOrgById
updateOrg
removeOrg
getApisByOrg
getOrgJobs
getDocsByOrg
getBuildByOrg
getOrgApiBuilds
getOrgArtifacts

OrgMember

Method	Description
createMember
getByOrgId
updateMember
removeMember
leaveOrg
enableAllMembers
disableAllMembers

Artifact

Method	Description
createArtifact
getArtifacts
getArtifactStatuses
getArtifactById
removeArtifact

Sdk

Method	Description
createSdk
findSdks
getSdkById
removeSdk

Doc

Method	Description
getApprovedByOrgSlugAndApiSlug
getAllApprovedByOrgSlugAndApiSlug
createDoc
findDocs
approve
unapprove
getDocById
removeDoc
updateDoc
getDownloadUrl

HubSpot

Method	Description
sendShadowForm

OrgSubscriptions

Method	Description
getActiveSubscription
cancelActiveSubscription
getActiveSubscriptionStatus
getSubscriptionPaymentMethodUpdateLink
getCheckoutLink

Subscriptions

Method	Description
getSubscriptionsOverview

PaymentProvider

Method	Description
stripeWebhook
syncStripeSubscriptions

User

Method	Description
getCurrentUser
createUser
getUsers
getUserById
updateUser
removeUser
updateEmailSubscription
getUserOrgs
getUserApis

Snippets

Method	Description
getSnippetsByBuildId

Integration

Method	Description
createIntegrationBuild
createPostmanIntegrationBuild
createPostmanServiceWorkerToken
getPostmanServiceWorkerTokens
createIntegrationCredentials
getIntegrationCredentials
updateIntegrationCredentials
deleteIntegrationCredentials

Workflows

Method	Description
uploadWorkflows

SpecValidation

Method	Description
validateSpec
getSpecValidation

Token

Method	Description
createToken
findTokensByUserId
getTokenById
removeToken

Invitation

Method	Description
createOrgInvite
redeemInvite
declineInvite
cancelInvite
getReceivedInvites
getSentInvites
searchInvites
getInviteByCode

Auth0

Method	Description
resetPasswordAuth0
passwordlessVerifyPassword
passwordlessSetupPassword

Plan

Method	Description
getEnabledPlans

Invoice

Method	Description
getOrgInvoices

HealthCheck

Method	Description
healthCheckControllerCheck

Tags

Method	Description
create
search

Ai

Method	Description
queryDocuments	Query documents

Feedback

Method	Description
sendFeedback

UserEvent

Method	Description
getUserEvents
exportUserEventsToCsv
trackUserPublishPrEvent

ThirdPartyApplications

Method	Description
thirdPartyApplicationsControllerCreate
thirdPartyApplicationsControllerGetAll
thirdPartyApplicationsControllerGetByOrgId
thirdPartyApplicationsControllerDeleteById

SpecFixer

Method	Description
fixSpec

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

Name	Type	Description
offset	number
limit	number
orgId	number
apiSlug	string

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

Name	Type	Description
id	number
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.createBuildArtifact(input, -46103316.661971584);
  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

Name	Type	Description
id	number

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

removeById

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

Required Parameters

Name	Type	Description
buildId	number
apiSlug	string
orgId	number

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(91014311.16739938, 'apiSlug', 32593084.27256733);
  console.log(result);
})();

tag

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

Required Parameters

Name	Type	Description
buildId	number
tagId	number

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(12666292.297161207, 51809262.84470019);
  console.log(result);
})();

untag

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

Required Parameters

Name	Type	Description
buildId	number
tagId	number

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(25956629.53098175, -24045467.160855293);
  console.log(result);
})();

approveBuild

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

Required Parameters

Name	Type	Description
buildId	number

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

unApproveBuild

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

Required Parameters

Name	Type	Description
buildId	number

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

getApiBuilds

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

Required Parameters

Name	Type	Description
id	number
offset	number
limit	number

Optional Parameters

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

Name	Type	Description
sortBy	SortBy
direction	Direction
statuses	string[]
tags	number[]
createdByIds	number[]

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(-75971221.96521702, 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

Name	Type	Description
id	number

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

getApiSdks

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

Required Parameters

Name	Type	Description
id	number
offset	number
limit	number

Optional Parameters

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

Name	Type	Description
statuses	string[]
tags	number[]
createdByIds	number[]
languages	string[]
sortBy	ApiSortBy
direction	Direction

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(-30711620.481672242, 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

Name	Type	Description
id	number
offset	number
limit	number

Optional Parameters

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

Name	Type	Description
sortBy	ApiSortBy
direction	Direction
statuses	string[]
tags	number[]
createdByIds	number[]

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(56110563.79155871, 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

Name	Type	Description
orgId	number

Optional Parameters

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

Name	Type	Description
apiSlug	string

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

Name	Type	Description
offset	number
limit	number

Optional Parameters

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

Name	Type	Description
name	string
sortBy	ApiSortBy
orgId	number
direction	ApiDirection
orgIds	number[]

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

Name	Type	Description
id	number

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

updateApi

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

Required Parameters

Name	Type	Description
id	number
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 = { name: 'My api name', version: '1.0.1' };
  const result = await sdk.api.updateApi(input, -55181657.902265616);
  console.log(result);
})();

getApiMembers

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

Required Parameters

Name	Type	Description
id	number

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

removeApi

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

Required Parameters

Name	Type	Description
apiSlug	string
orgId	number

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', 68302533.71954766);
  console.log(result);
})();

getApiByOrgSlugAndApiSlug

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

Required Parameters

Name	Type	Description
orgSlug	string
apiSlug	string

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

Name	Type	Description
offset	number
limit	number

Optional Parameters

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

Name	Type	Description
direction	Direction
sortBy	OrgSortBy

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

Name	Type	Description
offset	number
limit	number

Optional Parameters

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

Name	Type	Description
website	string
domain	string
name	string

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

Name	Type	Description
id	number

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

updateOrg

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

Required Parameters

Name	Type	Description
id	number
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: '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, 35332270.78727469);
  console.log(result);
})();

removeOrg

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

Required Parameters

Name	Type	Description
id	number

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

getApisByOrg

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

Required Parameters

Name	Type	Description
id	number

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

getOrgJobs

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

Required Parameters

Name	Type	Description
id	number
offset	number
limit	number

Optional Parameters

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

Name	Type	Description
sortBy	OrgSortBy
direction	Direction
statuses	string[]
createdByIds	number[]
apiSlug	string
apiVersion	string
buildType	string[]

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(66609320.808258176, 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

Name	Type	Description
id	number

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

getBuildByOrg

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

Required Parameters

Name	Type	Description
id	number
offset	number
limit	number

Optional Parameters

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

Name	Type	Description
sortBy	OrgSortBy
direction	Direction
statuses	string[]
tags	number[]
createdByIds	number[]
apiSlug	string
apiVersion	string

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(15677659.429016978, 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

Name	Type	Description
id	number

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

getOrgArtifacts

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

Required Parameters

Name	Type	Description
id	number
offset	number
limit	number

Optional Parameters

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

Name	Type	Description
sortBy	OrgSortBy
direction	OrgDirection
artifactTypes	ArtifactTypes
statuses	OrgStatuses
createdByIds	number[]

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(-4441965.928412423, 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

Name	Type	Description
orgId	number
input	object	Request body.

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

getByOrgId

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

Required Parameters

Name	Type	Description
orgId	number
offset	number
limit	number

Optional Parameters

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

Name	Type	Description
email	string
firstName	string
lastName	string
sortBy	OrgMemberSortBy
direction	Direction

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(40735538.50825906, 42, 10, {
    email: '[e-mail]',
    firstName: 'John',
    lastName: 'Doe',
    sortBy: 'createdAt',
    direction: 'asc',
  });
  console.log(result);
})();

updateMember

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

Required Parameters

Name	Type	Description
userId	number
orgId	number
input	object	Request body.

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, -96839446.72973417, 2010515.062122926);
  console.log(result);
})();

removeMember

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

Required Parameters

Name	Type	Description
userId	number
orgId	number

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(77269301.23706374, -88171137.93286331);
  console.log(result);
})();

leaveOrg

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

Required Parameters

Name	Type	Description
orgId	number

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

enableAllMembers

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

Required Parameters

Name	Type	Description
orgId	number

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

disableAllMembers

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

Required Parameters

Name	Type	Description
orgId	number

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(-11733430.272144705);
  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

Name	Type	Description
buildId	number

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

Name	Type	Description
id	number

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

removeArtifact

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

Required Parameters

Name	Type	Description
id	number

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(7045674.783633068);
  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

Name	Type	Description
offset	number
limit	number

Optional Parameters

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

Name	Type	Description
artifactId	number
sortBy	SdkSortBy
direction	Direction
languages	string[]

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

Name	Type	Description
id	number

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

removeSdk

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

Required Parameters

Name	Type	Description
id	number

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

getApprovedByOrgSlugAndApiSlug

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

Required Parameters

Name	Type	Description
orgSlug	string

Optional Parameters

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

Name	Type	Description
apiSlug	string
apiVersion	string

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

Name	Type	Description
orgSlug	string

Optional Parameters

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

Name	Type	Description
apiSlug	string
apiVersion	string

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: 16267838.362091288,
    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

Name	Type	Description
offset	number
limit	number
artifactId	number

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

Name	Type	Description
previewSlug	string

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

Name	Type	Description
previewSlug	string

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

Name	Type	Description
id	number

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

removeDoc

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

Required Parameters

Name	Type	Description
id	number

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

updateDoc

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

Required Parameters

Name	Type	Description
id	number
input	object	Request body.

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

getDownloadUrl

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

Required Parameters

Name	Type	Description
id	number

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(40777041.93428403);
  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

Name	Type	Description
orgId	number

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

cancelActiveSubscription

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

Required Parameters

Name	Type	Description
orgId	number

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

getActiveSubscriptionStatus

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

Required Parameters

Name	Type	Description
orgId	number

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

getSubscriptionPaymentMethodUpdateLink

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

Required Parameters

Name	Type	Description
orgId	number
subscriptionId	number

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(
    79217173.75451717,
    85129466.42548779,
  );
  console.log(result);
})();

getCheckoutLink

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

Required Parameters

Name	Type	Description
orgId	number
planId	number
billingInterval	BillingInterval

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(60455745.91880211, 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

Name	Type	Description
stripeSignature	string

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: '[e-mail]',
    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

Name	Type	Description
offset	number
limit	number

Optional Parameters

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

Name	Type	Description
orgId	number
email	string
firstName	string
lastName	string
orgIds	number[]
sortBy	UserSortBy
direction	UserDirection

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(42, 10, {
    orgId: 1,
    email: '[e-mail]',
    firstName: 'John',
    lastName: 'Doe',
    orgIds: [1],
    sortBy: 'createdAt',
    direction: 'desc',
  });
  console.log(result);
})();

getUserById

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

Required Parameters

Name	Type	Description
id	number

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

updateUser

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

Required Parameters

Name	Type	Description
id	number
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: 'auth0Id',
    email: '[e-mail]',
    firstName: 'John',
    isEnabled: true,
    isLiblabAdmin: true,
    isLiblabFinanceAdmin: false,
    lastName: 'Doe',
    refreshTokenHash: 'refreshTokenHash',
    utmParams: {},
  };
  const result = await sdk.user.updateUser(input, 1666383.3258609474);
  console.log(result);
})();

removeUser

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

Required Parameters

Name	Type	Description
id	number

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.user.removeUser(-56443102.38481873);
  console.log(result);
})();

updateEmailSubscription

• HTTP Method: PATCH
• Endpoint: /users/emails/subscriptions

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 = { isSubscribedToEmails: true };
  const result = await sdk.user.updateEmailSubscription(input);
  console.log(result);
})();

getUserOrgs

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

Required Parameters

Name	Type	Description
offset	number
limit	number

Return Type

PaginatedOrgResponse

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.getUserOrgs(42, 10);
  console.log(result);
})();

getUserApis

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

Return Type

GetUserApisResponse

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

getSnippetsByBuildId

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

Required Parameters

Name	Type	Description
id	number

Return Type

SnippetsResponse

Example Usage Code Snippet

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

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

(async () => {
  const result = await sdk.snippets.getSnippetsByBuildId(14210084.80927743);
  console.log(result);
})();

createIntegrationBuild

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

Required Parameters

| input | object | Request body. |

Return Type

IntegrationBuildResponseDto

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.integration.createIntegrationBuild(input);
  console.log(result);
})();

createPostmanIntegrationBuild

• HTTP Method: POST
• Endpoint: /integrations/postman/builds

Required Parameters

| input | object | Request body. |

Return Type

IntegrationBuildResponseDto

Example Usage Code Snippet

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

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

(async () => {
  const input = {
    config: {},
    email: '[e-mail]',
    languages: ['typescript'],
    postmanCollectionId: '12345678-1234-1234-1234-123456789012',
    sdkName: 'sdkName',
  };
  const result = await sdk.integration.createPostmanIntegrationBuild(input);
  console.log(result);
})();

createPostmanServiceWorkerToken

• HTTP Method: POST
• Endpoint: /integrations/postman/tokens

Required Parameters

| input | object | Request body. |

Return Type

CreateTokenResponse

Example Usage Code Snippet

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

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

(async () => {
  const input = {
    expiresAt: '2025-01-01T01:01:01.0Z',
    name: 'My token',
    scope: ['API', 'DOC', 'SDK', 'BUILD', 'ARTIFACT', 'ORG'],
  };
  const result = await sdk.integration.createPostmanServiceWorkerToken(input);
  console.log(result);
})();

getPostmanServiceWorkerTokens

• HTTP Method: GET
• Endpoint: /integrations/postman/tokens

Optional Parameters

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

Name	Type	Description
sort	Sort	Sort order for token expiration date

Return Type

GetPostmanServiceWorkerTokensResponse

Example Usage Code Snippet

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

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

(async () => {
  const result = await sdk.integration.getPostmanServiceWorkerTokens({ sort: 'desc' });
  console.log(result);
})();

createIntegrationCredentials

• HTTP Method: POST
• Endpoint: /integrations/credentials

Required Parameters

| input | object | Request body. |

Return Type

IntegrationCredentialsResponseDto

Example Usage Code Snippet

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

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

(async () => {
  const input = {
    clientId: 'client-id-12345',
    clientSecret: 'client-secret-abcde',
    integrationSource: 'POSTMAN',
  };
  const result = await sdk.integration.createIntegrationCredentials(input);
  console.log(result);
})();

getIntegrationCredentials

• HTTP Method: GET
• Endpoint: /integrations/credentials/{source}

Required Parameters

Name	Type	Description
source	string

Return Type

IntegrationCredentialsResponseDto

Example Usage Code Snippet

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

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

(async () => {
  const result = await sdk.integration.getIntegrationCredentials('source');
  console.log(result);
})();

updateIntegrationCredentials

• HTTP Method: PATCH
• Endpoint: /integrations/credentials/{source}

Required Parameters

Name	Type	Description
source	string
input	object	Request body.

Return Type

IntegrationCredentialsResponseDto

Example Usage Code Snippet

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

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

(async () => {
  const input = {
    clientId: 'updated-client-id',
    clientSecret: 'updated-client-secret',
    integrationSource: 'POSTMAN',
  };
  const result = await sdk.integration.updateIntegrationCredentials(input, 'source');
  console.log(result);
})();

deleteIntegrationCredentials

• HTTP Method: DELETE
• Endpoint: /integrations/credentials/{source}

Required Parameters

Name	Type	Description
source	string

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.integration.deleteIntegrationCredentials('source');
  console.log(result);
})();

uploadWorkflows

• HTTP Method: POST
• Endpoint: /workflows

Required Parameters

| input | object | Request body. |

Return Type

CreateWorkflowsResponse

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.workflows.uploadWorkflows(input);
  console.log(result);
})();

validateSpec

• HTTP Method: POST
• Endpoint: /spec-validations

Required Parameters

| input | object | Request body. |

Return Type

SpecValidationResponse

Example Usage Code Snippet

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

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

(async () => {
  const input = { apiId: 1 };
  const result = await sdk.specValidation.validateSpec(input);
  console.log(result);
})();

getSpecValidation

• HTTP Method: GET
• Endpoint: /spec-validations/{id}

Required Parameters

Name	Type	Description
id	number

Return Type

SpecValidationResponse

Example Usage Code Snippet

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

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

(async () => {
  const result = await sdk.specValidation.getSpecValidation(12037738.121362016);
  console.log(result);
})();

createToken

• HTTP Method: POST
• Endpoint: /auth/tokens

Required Parameters

| input | object | Request body. |

Return Type

CreateTokenResponse

Example Usage Code Snippet

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

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

(async () => {
  const input = {
    expiresAt: '2025-01-01T01:01:01.0Z',
    name: 'My token',
    scope: ['API', 'DOC', 'SDK', 'BUILD', 'ARTIFACT', 'ORG'],
  };
  const result = await sdk.token.createToken(input);
  console.log(result);
})();

findTokensByUserId

• HTTP Method: GET
• Endpoint: /auth/tokens

Required Parameters

Name	Type	Description
userId	number

Return Type

FindTokensByUserIdResponse

Example Usage Code Snippet

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

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

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

getTokenById

• HTTP Method: GET
• Endpoint: /auth/tokens/{id}

Required Parameters

Name	Type	Description
id	number

Return Type

GetTokenResponse

Example Usage Code Snippet

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

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

(async () => {
  const result = await sdk.token.getTokenById(85979705.8491683);
  console.log(result);
})();

removeToken

• HTTP Method: DELETE
• Endpoint: /auth/tokens/{id}

Required Parameters

Name	Type	Description
id	number

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.token.removeToken(25463735.086368278);
  console.log(result);
})();

createOrgInvite

• HTTP Method: POST
• Endpoint: /invitations/org/{orgId}/invite

Required Parameters

Name	Type	Description
orgId	number
input	object	Request body.

Return Type

InvitationResponse

Example Usage Code Snippet

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

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

(async () => {
  const input = { email: '[e-mail]' };
  const result = await sdk.invitation.createOrgInvite(input, 28851006.40992579);
  console.log(result);
})();

redeemInvite

• HTTP Method: PATCH
• Endpoint: /invitations/{inviteCode}/redeem

Required Parameters

Name	Type	Description
inviteCode	string

Return Type

InvitationResponse

Example Usage Code Snippet

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

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

(async () => {
  const result = await sdk.invitation.redeemInvite('inviteCode');
  console.log(result);
})();

declineInvite

• HTTP Method: PATCH
• Endpoint: /invitations/{inviteCode}/decline

Required Parameters

Name	Type	Description
inviteCode	string

Return Type

InvitationResponse

Example Usage Code Snippet

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

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

(async () => {
  const result = await sdk.invitation.declineInvite('inviteCode');
  console.log(result);
})();

cancelInvite

• HTTP Method: DELETE
• Endpoint: /invitations/{inviteId}/cancel

Required Parameters

Name	Type	Description
inviteId	number

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.invitation.cancelInvite(83630131.13338545);
  console.log(result);
})();

getReceivedInvites

• HTTP Method: GET
• Endpoint: /invitations/received

Required Parameters

Name	Type	Description
offset	number
limit	number

Return Type

PaginatedOrgInvitesResponse

Example Usage Code Snippet

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

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

(async () => {
  const result = await sdk.invitation.getReceivedInvites(42, 10);
  console.log(result);
})();

getSentInvites

• HTTP Method: GET
• Endpoint: /invitations/sent

Required Parameters

Name	Type	Description
offset	number
limit	number

Return Type

PaginatedOrgInvitesResponse

Example Usage Code Snippet

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

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

(async () => {
  const result = await sdk.invitation.getSentInvites(42, 10);
  console.log(result);
})();

searchInvites

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

Required Parameters

Name	Type	Description
offset	number
limit	number

Optional Parameters

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

Name	Type	Description
orgName	string	Name of the organization
status	Status	Status of the invitation
sortBy	InvitationSortBy	Field to sort by
direction	InvitationDirection	Direction to sort by

Return Type

PaginatedOrgInvitesResponse

Example Usage Code Snippet

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

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

(async () => {
  const result = await sdk.invitation.searchInvites(42, 10, {
    orgName: 'liblab',
    status: 'PENDING',
    sortBy: 'createdAt',
    direction: 'desc',
  });
  console.log(result);
})();

getInviteByCode

• HTTP Method: GET
• Endpoint: /invitations/{inviteCode}

Required Parameters

Name	Type	Description
inviteCode	string

Return Type

InvitationResponse

Example Usage Code Snippet

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

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

(async () => {
  const result = await sdk.invitation.getInviteByCode('inviteCode');
  console.log(result);
})();

resetPasswordAuth0

• HTTP Method: POST
• Endpoint: /auth0/reset-password

Return Type

Auth0ResetPasswordResponse

Example Usage Code Snippet

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

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

(async () => {
  const result = await sdk.auth0.resetPasswordAuth0();
  console.log(result);
})();

passwordlessVerifyPassword

• HTTP Method: POST
• Endpoint: /auth0/passwordless/verify-password

Return Type

VerifyPasswordResponseDto

Example Usage Code Snippet

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

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

(async () => {
  const result = await sdk.auth0.passwordlessVerifyPassword();
  console.log(result);
})();

passwordlessSetupPassword

• HTTP Method: POST
• Endpoint: /auth0/passwordless/setup-password

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 = { password: 'P@ssw0rd123' };
  const result = await sdk.auth0.passwordlessSetupPassword(input);
  console.log(result);
})();

getEnabledPlans

• HTTP Method: GET
• Endpoint: /plans/enabled

Return Type

GetEnabledPlansResponse

Example Usage Code Snippet

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

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

(async () => {
  const result = await sdk.plan.getEnabledPlans();
  console.log(result);
})();

getOrgInvoices

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

Required Parameters

Name	Type	Description
orgId	number

Return Type

OrgInvoicesResponse

Example Usage Code Snippet

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

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

(async () => {
  const result = await sdk.invoice.getOrgInvoices(-98041551.05681595);
  console.log(result);
})();

healthCheckControllerCheck

• HTTP Method: GET
• Endpoint: /health-check

Return Type

HealthCheckResponse

Example Usage Code Snippet

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

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

(async () => {
  const result = await sdk.healthCheck.healthCheckControllerCheck();
  console.log(result);
})();

create

• HTTP Method: POST
• Endpoint: /tags

Required Parameters

| input | object | Request body. |

Return Type

TagResponse

Example Usage Code Snippet

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

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

(async () => {
  const input = { name: 'tag' };
  const result = await sdk.tags.create(input);
  console.log(result);
})();

search

• HTTP Method: GET
• Endpoint: /tags

Required Parameters

Name	Type	Description
offset	number
limit	number
searchQuery	string

Return Type

SearchResponse

Example Usage Code Snippet

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

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

(async () => {
  const result = await sdk.tags.search(42, 10, 'abc');
  console.log(result);
})();

queryDocuments

Query documents

• HTTP Method: GET
• Endpoint: /ai/chat

Required Parameters

Name	Type	Description
orgId	number
apiSlug	string
apiVersion	string
sdkLanguage	string
q	string

Return Type

ChatResponseDto

Example Usage Code Snippet

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

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

(async () => {
  const result = await sdk.ai.queryDocuments(
    -70800476.06351614,
    'apiSlug',
    'apiVersion',
    'sdkLanguage',
    'q',
  );
  console.log(result);
})();

sendFeedback

• HTTP Method: POST
• Endpoint: /feedback

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 = { message: 'message', title: 'title' };
  const result = await sdk.feedback.sendFeedback(input);
  console.log(result);
})();

getUserEvents

• HTTP Method: GET
• Endpoint: /user-events

Required Parameters

Name	Type	Description
offset	number
limit	number

Optional Parameters

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

Name	Type	Description
email	string
orgId	number
sortBy	UserEventSortBy
direction	UserEventDirection
orgIds	number[]
eventIds	number[]

Return Type

PaginatedUserEventsResponse

Example Usage Code Snippet

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

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

(async () => {
  const result = await sdk.userEvent.getUserEvents(42, 10, {
    email: '[e-mail]',
    orgId: 1,
    sortBy: 'timestamp',
    direction: 'desc',
    orgIds: [-8772960.200730667, -68514336.99985981],
    eventIds: [3316714.8393860906, 89320319.93203297],
  });
  console.log(result);
})();

exportUserEventsToCsv

• HTTP Method: GET
• Endpoint: /user-events/export-to-csv

Optional Parameters

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

Name	Type	Description
email	string
orgId	number
filename	string
orgIds	number[]
eventIds	number[]

Return Type

ExportUserEventsToCsvResponse

Example Usage Code Snippet

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

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

(async () => {
  const result = await sdk.userEvent.exportUserEventsToCsv({
    email: '[e-mail]',
    orgId: 1,
    filename: 'user-events.csv',
    orgIds: [50176445.567276806, -43528149.67026952],
    eventIds: [86650805.86063781, -41117901.69944029],
  });
  console.log(result);
})();

trackUserPublishPrEvent

• HTTP Method: POST
• Endpoint: /user-events/track-user-publish-pr-event

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 = { language: 'typescript', sdk: 'My SDK', success: true };
  const result = await sdk.userEvent.trackUserPublishPrEvent(input);
  console.log(result);
})();

thirdPartyApplicationsControllerCreate

• HTTP Method: POST
• Endpoint: /third-party-applications

Required Parameters

| input | object | Request body. |

Return Type

ThirdPartyApplicationResponse

Example Usage Code Snippet

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

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

(async () => {
  const input = {
    callbackUrls: ['http://localhost:3000/api/auth/callback'],
    logoUrl: 'https://liblab.com/img/logo.svg',
    name: 'third-party application',
    orgId: 1,
  };
  const result = await sdk.thirdPartyApplications.thirdPartyApplicationsControllerCreate(input);
  console.log(result);
})();

thirdPartyApplicationsControllerGetAll

• HTTP Method: GET
• Endpoint: /third-party-applications

Return Type

ThirdPartyApplicationsControllerGetAllResponse

Example Usage Code Snippet

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

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

(async () => {
  const result = await sdk.thirdPartyApplications.thirdPartyApplicationsControllerGetAll();
  console.log(result);
})();

thirdPartyApplicationsControllerGetByOrgId

• HTTP Method: GET
• Endpoint: /third-party-applications/{id}

Required Parameters

Name	Type	Description
id	number

Return Type

ThirdPartyApplicationsControllerGetByOrgIdResponse

Example Usage Code Snippet

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

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

(async () => {
  const result = await sdk.thirdPartyApplications.thirdPartyApplicationsControllerGetByOrgId(
    54493388.710433066,
  );
  console.log(result);
})();

thirdPartyApplicationsControllerDeleteById

• HTTP Method: DELETE
• Endpoint: /third-party-applications/{id}

Required Parameters

Name	Type	Description
id	number

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.thirdPartyApplications.thirdPartyApplicationsControllerDeleteById(
    51354235.66561195,
  );
  console.log(result);
})();

fixSpec

• HTTP Method: POST
• Endpoint: /spec-fixer/{id}/fix

Required Parameters

Name	Type	Description
id	number

Return Type

SpecFixerResponseDto

Example Usage Code Snippet

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

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

(async () => {
  const result = await sdk.specFixer.fixSpec(-83297203.37840825);
  console.log(result);
})();

License

License: MIT. See license in LICENSE.