@liblab/sdk

Liblab Typescript SDK 1.0.0

The Typescript SDK for Liblab.

• API version: 1.0
• SDK version: 1.0.0

Table of Contents

• Installation
• Authentication
• API Endpoint Services
• API Models
• Sample Usage
• Environments
• Liblab Services

Installation

npm install liblab  

Authentication

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

Bearer Authentication with Refresh Tokens

The Liblab API uses bearer tokens for authentication, but these bearer tokens have a short expiration time. Refresh tokens have longer duration, and they have the ability to obtain new bearer tokens. The bearer and refresh token can be set when initializing the SDK like this:

sdk = new Liblab('YOUR_REFRESH_TOKEN', 'YOUR_BEARER_TOKEN')

Or at a later stage:

sdk = new Liblab()
sdk.setBearerToken('YOUR_BEARER_TOKEN');
sdk.setRefreshToken('YOUR_REFRESH_TOKEN');

After the refresh token has been set, the SDK will automatically refresh the bearer token when needed.

Sample Usage

Here is a simple program demonstrating usage of this SDK. It is also available in the sample.js file in this directory.

import { Liblab } from './src';


const sdk = new Liblab();

(async () => {
  const result = await sdk.Org
    .getByCurrentUser();
  console.log(result);
})();
 

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

  • Auth

  • User

  • Token

  • HealthCheck

  • Event

  • Invitation

• All Methods

Build

Method	Description
buildSdk
buildDoc
getBuilds
getById

Api

Method	Description
create
getApis
getById
update
remove
getApiMembers
getApiSdks
getApiDocs
getApiBuilds
getApiByOrgSlugAndApiSlug

Org

Method	Description
create
getByCurrentUser
getById
update
remove
getApis
getPayments
getArtifacts
getDocs

OrgMember

Method	Description
createMember
getByOrgId
updateMember
removeMember
enableAllMembers
disableAllMembers

Artifact

Method	Description
create
getArtifacts
getById
remove

Sdk

Method	Description
create
findSdks
getById
remove

Doc

Method	Description
getApprovedByOrgSlugAndApiSlug
getAllApprovedByOrgSlugAndApiSlug
create
findDocs
approve
getById
remove
update

Auth

Method	Description
signup
login
logout
refreshToken
resetPassword
oneTimeLogin
changePassword
verifyEmail
resendVerifictionEmail

User

Method	Description
getCurrentUser
create
getUserApis
getById
update
remove

Token

Method	Description
create
findByUserId
getById
remove

HealthCheck

Method	Description
HealthCheckController_check

Event

Method	Description
track

Invitation

Method	Description
createInvite
acceptInvite
declineInvite
inviteCode
getInvitesByUser

All Methods

buildSdk

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

Required Parameters

Name	Type	Description
input	object	Request body.

Optional Parameters

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

Name	Type	Description

Return Type

BuildResponse

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

(async () => {
  const result = await sdk.Build.buildSdk();
  console.log(result);
})();

buildDoc

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

Required Parameters

Name	Type	Description
input	object	Request body.

Optional Parameters

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

Name	Type	Description

Return Type

BuildResponse

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

(async () => {
  const result = await sdk.Build.buildDoc();
  console.log(result);
})();

getBuilds

• HTTP Method: GET
• Endpoint: /builds

Required Parameters

Name	Type	Description
apiId	number

Optional Parameters

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

Name	Type	Description

Return Type

BuildGetBuilds200Response

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

(async () => {
  const result = await sdk.Build.getBuilds(59634700.91996676);
  console.log(result);
})();

getById

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

Required Parameters

Name	Type	Description
id	number

Optional Parameters

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

Name	Type	Description

Return Type

BuildResponse

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

(async () => {
  const result = await sdk.Build.getById(-20126496.688035727);
  console.log(result);
})();

create

• HTTP Method: POST
• Endpoint: /apis

Required Parameters

Name	Type	Description
input	object	Request body.

Optional Parameters

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

Name	Type	Description

Return Type

ApiResponse

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

(async () => {
  const result = await sdk.Api.create();
  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

Return Type

ApiGetApis200Response

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

(async () => {
  const result = await sdk.Api.getApis(-62746750.77052838);
  console.log(result);
})();

getById

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

Required Parameters

Name	Type	Description
id	number

Optional Parameters

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

Name	Type	Description

Return Type

ApiResponse

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

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

update

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

Required Parameters

Name	Type	Description
id	number
input	object	Request body.

Optional Parameters

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

Name	Type	Description

Return Type

ApiResponse

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

(async () => {
  const result = await sdk.Api.update(-41764453.685370564);
  console.log(result);
})();

remove

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

Required Parameters

Name	Type	Description
id	number

Optional Parameters

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

Name	Type	Description

Return Type

Returns a dict object.

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

(async () => {
  const result = await sdk.Api.remove(48124821.0190011);
  console.log(result);
})();

getApiMembers

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

Required Parameters

Name	Type	Description
id	number

Optional Parameters

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

Name	Type	Description

Return Type

ApiGetApiMembers200Response

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

(async () => {
  const result = await sdk.Api.getApiMembers(63941601.55143252);
  console.log(result);
})();

getApiSdks

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

Required Parameters

Name	Type	Description
id	number

Optional Parameters

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

Name	Type	Description

Return Type

ApiGetApiSdks200Response

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

(async () => {
  const result = await sdk.Api.getApiSdks(-23525260.608993202);
  console.log(result);
})();

getApiDocs

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

Required Parameters

Name	Type	Description
id	number

Optional Parameters

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

Name	Type	Description

Return Type

ApiGetApiDocs200Response

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

(async () => {
  const result = await sdk.Api.getApiDocs(-87067088.4182359);
  console.log(result);
})();

getApiBuilds

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

Required Parameters

Name	Type	Description
id	number

Optional Parameters

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

Name	Type	Description

Return Type

ApiGetApiBuilds200Response

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

(async () => {
  const result = await sdk.Api.getApiBuilds(98791159.60693374);
  console.log(result);
})();

getApiByOrgSlugAndApiSlug

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

Required Parameters

Name	Type	Description
orgSlug	string
apiSlug	string

Optional Parameters

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

Name	Type	Description

Return Type

ApiGetApiByOrgSlugAndApiSlug200Response

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

(async () => {
  const result = await sdk.Api.getApiByOrgSlugAndApiSlug(
    'consectetur ea mollit aute',
    'deserunt cupidatat voluptate Duis',
  );
  console.log(result);
})();

create

• HTTP Method: POST
• Endpoint: /orgs

Required Parameters

Name	Type	Description
input	object	Request body.

Optional Parameters

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

Name	Type	Description

Return Type

OrgResponse

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

(async () => {
  const result = await sdk.Org.create();
  console.log(result);
})();

getByCurrentUser

• HTTP Method: GET
• Endpoint: /orgs

Required Parameters

Name	Type	Description

Optional Parameters

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

Name	Type	Description

Return Type

OrgGetByCurrentUser200Response

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

(async () => {
  const result = await sdk.Org.getByCurrentUser();
  console.log(result);
})();

getById

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

Required Parameters

Name	Type	Description
id	number

Optional Parameters

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

Name	Type	Description

Return Type

OrgResponse

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

(async () => {
  const result = await sdk.Org.getById(-15150623.487047985);
  console.log(result);
})();

update

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

Required Parameters

Name	Type	Description
id	number
input	object	Request body.

Optional Parameters

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

Name	Type	Description

Return Type

OrgResponse

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

(async () => {
  const result = await sdk.Org.update(7635786.838635504);
  console.log(result);
})();

remove

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

Required Parameters

Name	Type	Description
id	number

Optional Parameters

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

Name	Type	Description

Return Type

Returns a dict object.

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

(async () => {
  const result = await sdk.Org.remove(-84241558.47510129);
  console.log(result);
})();

getApis

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

Required Parameters

Name	Type	Description
id	number

Optional Parameters

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

Name	Type	Description

Return Type

OrgGetApis200Response

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

(async () => {
  const result = await sdk.Org.getApis(-4583551.752192423);
  console.log(result);
})();

getPayments

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

Required Parameters

Name	Type	Description
id	number

Optional Parameters

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

Name	Type	Description

Return Type

OrgGetPayments200Response

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

(async () => {
  const result = await sdk.Org.getPayments(98010434.53537384);
  console.log(result);
})();

getArtifacts

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

Required Parameters

Name	Type	Description
id	number

Optional Parameters

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

Name	Type	Description

Return Type

OrgGetArtifacts200Response

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

(async () => {
  const result = await sdk.Org.getArtifacts(-84379730.68496332);
  console.log(result);
})();

getDocs

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

Required Parameters

Name	Type	Description
id	number

Optional Parameters

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

Name	Type	Description

Return Type

OrgGetDocs200Response

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

(async () => {
  const result = await sdk.Org.getDocs(15514099.348234385);
  console.log(result);
})();

createMember

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

Required Parameters

Name	Type	Description
orgId	number
input	object	Request body.

Optional Parameters

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

Name	Type	Description

Return Type

OrgMemberResponse

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

(async () => {
  const result = await sdk.OrgMember.createMember(6044688.852225065);
  console.log(result);
})();

getByOrgId

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

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

Return Type

OrgmemberGetByOrgId200Response

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

(async () => {
  const result = await sdk.OrgMember.getByOrgId(40775351.606452435);
  console.log(result);
})();

updateMember

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

Required Parameters

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

Optional Parameters

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

Name	Type	Description

Return Type

OrgMemberResponse

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

(async () => {
  const result = await sdk.OrgMember.updateMember(87983244.94409439, 2684615.95311819);
  console.log(result);
})();

removeMember

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

Required Parameters

Name	Type	Description
memberId	number
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

Return Type

Returns a dict object.

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

(async () => {
  const result = await sdk.OrgMember.removeMember(2045034.0059317052, 21751370.481368154);
  console.log(result);
})();

enableAllMembers

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

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

Return Type

UpdateManyOrgMembersResponse

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

(async () => {
  const result = await sdk.OrgMember.enableAllMembers(27565138.973987937);
  console.log(result);
})();

disableAllMembers

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

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

Return Type

UpdateManyOrgMembersResponse

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

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

create

• HTTP Method: POST
• Endpoint: /artifacts

Required Parameters

Name	Type	Description
input	object	Request body.

Optional Parameters

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

Name	Type	Description

Return Type

ArtifactResponse

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

(async () => {
  const result = await sdk.Artifact.create();
  console.log(result);
})();

getArtifacts

• HTTP Method: GET
• Endpoint: /artifacts

Required Parameters

Name	Type	Description
buildId	number

Optional Parameters

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

Name	Type	Description

Return Type

ArtifactGetArtifacts200Response

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

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

getById

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

Required Parameters

Name	Type	Description
id	number

Optional Parameters

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

Name	Type	Description

Return Type

ApiResponse

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

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

remove

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

Required Parameters

Name	Type	Description
id	number

Optional Parameters

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

Name	Type	Description

Return Type

Returns a dict object.

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

(async () => {
  const result = await sdk.Artifact.remove(1459738.4965782166);
  console.log(result);
})();

create

• HTTP Method: POST
• Endpoint: /sdks

Required Parameters

Name	Type	Description
input	object	Request body.

Optional Parameters

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

Name	Type	Description

Return Type

SdkResponse

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

(async () => {
  const result = await sdk.Sdk.create();
  console.log(result);
})();

findSdks

• HTTP Method: GET
• Endpoint: /sdks

Required Parameters

Name	Type	Description
offset	number
limit	number
artifactId	number

Optional Parameters

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

Name	Type	Description

Return Type

SdkFindSdks200Response

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

(async () => {
  const result = await sdk.Sdk.findSdks(
    -60473534.49488693,
    -28240420.612496614,
    -96729935.94518644,
  );
  console.log(result);
})();

getById

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

Required Parameters

Name	Type	Description
id	number

Optional Parameters

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

Name	Type	Description

Return Type

SdkResponse

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

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

remove

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

Required Parameters

Name	Type	Description
id	number

Optional Parameters

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

Name	Type	Description

Return Type

Returns a dict object.

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

(async () => {
  const result = await sdk.Sdk.remove(36040263.85478282);
  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 './src';

const sdk = new Liblab();

(async () => {
  const result = await sdk.Doc.getApprovedByOrgSlugAndApiSlug('laboris', {
    apiSlug: 'ut',
    apiVersion: 'eu sint nisi',
  });
  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

DocGetAllApprovedByOrgSlugAndApiSlug200Response

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

(async () => {
  const result = await sdk.Doc.getAllApprovedByOrgSlugAndApiSlug('dolore', {
    apiSlug: 'ea non incididunt aute officia',
    apiVersion: 'ullamco irure',
  });
  console.log(result);
})();

create

• HTTP Method: POST
• Endpoint: /docs

Required Parameters

Name	Type	Description
input	object	Request body.

Optional Parameters

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

Name	Type	Description

Return Type

DocCreatedResponse

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

(async () => {
  const result = await sdk.Doc.create();
  console.log(result);
})();

findDocs

• HTTP Method: GET
• Endpoint: /docs

Required Parameters

Name	Type	Description
offset	number
limit	number
artifactId	number

Optional Parameters

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

Name	Type	Description

Return Type

DocFindDocs200Response

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

(async () => {
  const result = await sdk.Doc.findDocs(-73010289.7992203, -96057035.2332199, -83237452.5303173);
  console.log(result);
})();

approve

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

Required Parameters

Name	Type	Description
previewSlug	string

Optional Parameters

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

Name	Type	Description

Return Type

DocResponse

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

(async () => {
  const result = await sdk.Doc.approve('in Ut');
  console.log(result);
})();

getById

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

Required Parameters

Name	Type	Description
id	number

Optional Parameters

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

Name	Type	Description

Return Type

DocResponse

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

(async () => {
  const result = await sdk.Doc.getById(-47505014.54999743);
  console.log(result);
})();

remove

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

Required Parameters

Name	Type	Description
id	number

Optional Parameters

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

Name	Type	Description

Return Type

DocResponse

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

(async () => {
  const result = await sdk.Doc.remove(-65882340.530661665);
  console.log(result);
})();

update

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

Required Parameters

Name	Type	Description
id	number
input	object	Request body.

Optional Parameters

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

Name	Type	Description

Return Type

DocResponse

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

(async () => {
  const result = await sdk.Doc.update(-59724388.452076524);
  console.log(result);
})();

signup

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

Required Parameters

Name	Type	Description
input	object	Request body.

Optional Parameters

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

Name	Type	Description

Return Type

UserResponse

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

(async () => {
  const result = await sdk.Auth.signup();
  console.log(result);
})();

login

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

Required Parameters

Name	Type	Description
input	object	Request body.

Optional Parameters

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

Name	Type	Description

Return Type

AuthTokenResponse

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

(async () => {
  const result = await sdk.Auth.login();
  console.log(result);
})();

logout

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

Required Parameters

Name	Type	Description

Optional Parameters

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

Name	Type	Description

Return Type

Returns a dict object.

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

(async () => {
  const result = await sdk.Auth.logout();
  console.log(result);
})();

refreshToken

• HTTP Method: POST
• Endpoint: /auth/refresh-jwt

Required Parameters

Name	Type	Description
input	object	Request body.

Optional Parameters

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

Name	Type	Description

Return Type

AuthTokenResponse

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

(async () => {
  const result = await sdk.Auth.refreshToken();
  console.log(result);
})();

resetPassword

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

Required Parameters

Name	Type	Description
input	object	Request body.

Optional Parameters

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

Name	Type	Description

Return Type

Returns a dict object.

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

(async () => {
  const result = await sdk.Auth.resetPassword();
  console.log(result);
})();

oneTimeLogin

• HTTP Method: POST
• Endpoint: /auth/one-time-login

Required Parameters

Name	Type	Description
input	object	Request body.

Optional Parameters

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

Name	Type	Description

Return Type

AuthTokenResponse

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

(async () => {
  const result = await sdk.Auth.oneTimeLogin();
  console.log(result);
})();

changePassword

• HTTP Method: POST
• Endpoint: /auth/change-password

Required Parameters

Name	Type	Description
input	object	Request body.

Optional Parameters

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

Name	Type	Description

Return Type

AuthTokenResponse

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

(async () => {
  const result = await sdk.Auth.changePassword();
  console.log(result);
})();

verifyEmail

• HTTP Method: POST
• Endpoint: /auth/verify-email

Required Parameters

Name	Type	Description
input	object	Request body.

Optional Parameters

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

Name	Type	Description

Return Type

Returns a dict object.

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

(async () => {
  const result = await sdk.Auth.verifyEmail();
  console.log(result);
})();

resendVerifictionEmail

• HTTP Method: POST
• Endpoint: /auth/resend-verify-email

Required Parameters

Name	Type	Description
input	object	Request body.

Optional Parameters

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

Name	Type	Description

Return Type

Returns a dict object.

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

(async () => {
  const result = await sdk.Auth.resendVerifictionEmail();
  console.log(result);
})();

getCurrentUser

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

Required Parameters

Name	Type	Description

Optional Parameters

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

Name	Type	Description

Return Type

UserResponse

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

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

create

• HTTP Method: POST
• Endpoint: /users

Required Parameters

Name	Type	Description
input	object	Request body.

Optional Parameters

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

Name	Type	Description

Return Type

UserResponse

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

(async () => {
  const result = await sdk.User.create();
  console.log(result);
})();

getUserApis

• HTTP Method: GET
• Endpoint: /users

Required Parameters

Name	Type	Description

Optional Parameters

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

Name	Type	Description

Return Type

UserGetUserApis200Response

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

(async () => {
  const result = await sdk.User.getUserApis();
  console.log(result);
})();

getById

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

Required Parameters

Name	Type	Description
id	number

Optional Parameters

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

Name	Type	Description

Return Type

UserResponse

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

(async () => {
  const result = await sdk.User.getById(-58436627.95764453);
  console.log(result);
})();

update

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

Required Parameters

Name	Type	Description
id	number
input	object	Request body.

Optional Parameters

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

Name	Type	Description

Return Type

UserResponse

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

(async () => {
  const result = await sdk.User.update(80987905.82253394);
  console.log(result);
})();

remove

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

Required Parameters

Name	Type	Description
id	number

Optional Parameters

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

Name	Type	Description

Return Type

Returns a dict object.

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

(async () => {
  const result = await sdk.User.remove(-96664790.1696299);
  console.log(result);
})();

create

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

Required Parameters

Name	Type	Description
input	object	Request body.

Optional Parameters

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

Name	Type	Description

Return Type

CreateTokenResponse

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

(async () => {
  const result = await sdk.Token.create();
  console.log(result);
})();

findByUserId

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

Required Parameters

Name	Type	Description
userId	number

Optional Parameters

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

Name	Type	Description

Return Type

GetTokenResponse

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

(async () => {
  const result = await sdk.Token.findByUserId(8722124.320271224);
  console.log(result);
})();

getById

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

Required Parameters

Name	Type	Description
id	number

Optional Parameters

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

Name	Type	Description

Return Type

GetTokenResponse

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

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

remove

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

Required Parameters

Name	Type	Description
id	number

Optional Parameters

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

Name	Type	Description

Return Type

Returns a dict object.

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

(async () => {
  const result = await sdk.Token.remove(-8710355.174106881);
  console.log(result);
})();

HealthCheckController_check

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

Required Parameters

Name	Type	Description

Optional Parameters

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

Name	Type	Description

Return Type

HealthCheckResponse

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

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

track

• HTTP Method: POST
• Endpoint: /events

Required Parameters

Name	Type	Description
input	object	Request body.

Optional Parameters

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

Name	Type	Description

Return Type

Returns a dict object.

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

(async () => {
  const result = await sdk.Event.track();
  console.log(result);
})();

createInvite

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

Required Parameters

Name	Type	Description
orgId	number
input	object	Request body.

Optional Parameters

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

Name	Type	Description

Return Type

InvitationResponse InvitationResponse

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

(async () => {
  const result = await sdk.Invitation.createInvite(-64698228.28666039);
  console.log(result);
})();

acceptInvite

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

Required Parameters

Name	Type	Description
inviteCode	string

Optional Parameters

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

Name	Type	Description

Return Type

Returns a dict object.

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

(async () => {
  const result = await sdk.Invitation.acceptInvite('ullamco in aliquip occaecat');
  console.log(result);
})();

declineInvite

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

Required Parameters

Name	Type	Description
inviteCode	string

Optional Parameters

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

Name	Type	Description

Return Type

Returns a dict object.

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

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

inviteCode

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

Required Parameters

Name	Type	Description
inviteCode	string

Optional Parameters

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

Name	Type	Description

Return Type

InvitationResponse

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

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

getInvitesByUser

• HTTP Method: GET
• Endpoint: /invitations

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

Return Type

InvitationGetInvitesByUser200Response

Example Usage Code Snippet

import { Liblab } from './src';

const sdk = new Liblab();

(async () => {
  const result = await sdk.Invitation.getInvitesByUser(-83779445.8852048, 61874668.19490507);
  console.log(result);
})();