Liblab Typescript SDK 0.0.35
The Typescript SDK for Liblab.
- API version: 0.0.35
- SDK version: 0.0.35
Table of Contents
Installation
npm install sdk
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 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();
(async () => {
const result = await sdk.Build
.getBuildStatuses();
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.
Build
Api
Org
OrgMember
Artifact
Sdk
Doc
User
Auth
Token
OrgPlan
Stripe
HealthCheck
Event
Invitation
Tags
All Methods
createBuild
- HTTP Method: POST
- Endpoint: /builds
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'}
Return Type
BuildResponse
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(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 | |
apiId | number | |
Optional Parameters
Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}
Return Type
PaginatedBuildResponse
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const result = await sdk.Build.getBuilds(
-53181705.09912794,
35921744.510472566,
-52308781.90031505,
);
console.log(result);
})();
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'}
Return Type
BuildResponse
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const input = {};
const result = await sdk.Build.buildSdk(input);
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'}
Return Type
BuildResponse
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const input = {
apiId: 1,
openApiUrl:
'https://dev-order-bucket.s3.amazonaws.com/specs/doc-specs/alpaca-broker+api_api_1.0.0.json',
};
const result = await sdk.Build.buildDoc(input);
console.log(result);
})();
getBuildStatuses
- HTTP Method: GET
- Endpoint: /builds/statuses
Required Parameters
Optional Parameters
Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}
Return Type
BuildGetBuildStatuses200Response
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const result = await sdk.Build.getBuildStatuses();
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'}
Return Type
BuildResponse
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const result = await sdk.Build.getById(-64653927.29156742);
console.log(result);
})();
tag
- HTTP Method: POST
- Endpoint: /builds/{buildId}/tag/{tagId}
Required Parameters
Name | Type | Description |
---|
buildId | number | |
tagId | number | |
Optional Parameters
Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}
Return Type
BuildResponse
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const result = await sdk.Build.tag(-53430600.86649642, 52566643.61110929);
console.log(result);
})();
untag
- HTTP Method: POST
- Endpoint: /builds/{buildId}/untag/{tagId}
Required Parameters
Name | Type | Description |
---|
buildId | number | |
tagId | number | |
Optional Parameters
Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}
Return Type
BuildResponse
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const result = await sdk.Build.untag(56779842.12496731, 12142098.362589598);
console.log(result);
})();
approveBuild
- HTTP Method: PATCH
- Endpoint: /builds/{buildId}/approve
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'}
Return Type
Returns a dict object.
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const result = await sdk.Build.approveBuild(63202586.00216836);
console.log(result);
})();
unApproveBuild
- HTTP Method: PATCH
- Endpoint: /builds/{buildId}/unapprove
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'}
Return Type
Returns a dict object.
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const result = await sdk.Build.unApproveBuild(52484407.672717154);
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 | string | |
direction | string | |
statuses | string[] | |
tags | number[] | |
createdByIds | number[] | |
Return Type
PaginatedBuildResponse
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const result = await sdk.Api.getApiBuilds(
-37912550.876729555,
6026388.320690975,
-788314.0629452616,
{
sortBy: 'startTime',
direction: 'asc',
statuses: ['IN_PROGRESS', 'IN_PROGRESS'],
tags: [-51112356.33091886, -24547969.728759483],
createdByIds: [-30336271.337455273, 5086503.256639391],
},
);
console.log(result);
})();
getApiBuildTags
- HTTP Method: GET
- Endpoint: /apis/{id}/builds/tags
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'}
Return Type
ApiGetApiBuildTags200Response
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const result = await sdk.Api.getApiBuildTags(19527012.79338482);
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 | string | |
direction | string | |
Return Type
PaginatedSdkResponse
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const result = await sdk.Api.getApiSdks(
-28950613.31315136,
-46323024.599649765,
35836403.40783888,
{
statuses: ['FAIL', 'SUCCESS'],
tags: [84791590.49384898, 96308546.98655796],
createdByIds: [-40574431.14897921, -76160528.59127893],
languages: ['JAVA', 'PYTHON'],
sortBy: 'version',
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 | string | |
direction | string | |
statuses | string[] | |
tags | number[] | |
createdByIds | number[] | |
Return Type
PaginatedDocResponse
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const result = await sdk.Api.getApiDocs(85597825.315112, 68974073.44477937, 46462859.085737854, {
sortBy: 'createdAt',
direction: 'asc',
statuses: ['FAIL', 'SUCCESS'],
tags: [41001592.00902328, -31594684.04485257],
createdByIds: [4537259.079409227, 92466397.74141282],
});
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'}
Return Type
ApiResponse
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const input = {};
const result = await sdk.Api.create(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'}
Return Type
ApiGetApis200Response
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const result = await sdk.Api.getApis(-62541666.96170667);
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 | |
Return Type
PaginatedApiResponse
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const result = await sdk.Api.searchApis(-72468662.7668686, 34151951.174772546, {
name: 'labore',
});
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'}
Return Type
ApiResponse
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const result = await sdk.Api.getById(-34847358.93516877);
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'}
Return Type
ApiResponse
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const input = { name: 'My api name', version: '1.0.1' };
const result = await sdk.Api.update(input, -76698024.1658342);
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'}
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(78841516.73732802);
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'}
Return Type
ApiGetApiMembers200Response
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const result = await sdk.Api.getApiMembers(81044152.24140409);
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'}
Return Type
ApiGetApiByOrgSlugAndApiSlug200Response
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const result = await sdk.Api.getApiByOrgSlugAndApiSlug('velit anim ut', 'proident ut dolore');
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'}
Return Type
OrgResponse
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const input = {
description: 'Example Org Description',
domain: 'business.com',
name: 'Example Org',
website: 'https://example.com',
};
const result = await sdk.Org.create(input);
console.log(result);
})();
getByCurrentUser
- 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'}
Return Type
PaginatedOrgResponse
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const result = await sdk.Org.getByCurrentUser(879999.0221028477, -4041514.780885786);
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
PaginatedOrgResponse
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const result = await sdk.Org.searchOrgs(38881728.47306332, -44746466.23173899, {
website: 'ipsum',
domain: 'velit consectetur Lorem in',
name: 'fugiat labore eu',
});
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'}
Return Type
OrgResponse
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const result = await sdk.Org.getById(34957844.31702575);
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'}
Return Type
OrgResponse
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const input = {
description: 'Example Org Description',
domain: 'example.com',
isAllowedForBeta: true,
name: 'Example Org',
website: 'https://example.com',
};
const result = await sdk.Org.update(input, -30312019.91277732);
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'}
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(19819563.52097103);
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'}
Return Type
OrgGetApis200Response
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const result = await sdk.Org.getApis(27250370.62051116);
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'}
Return Type
OrgGetPayments200Response
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const result = await sdk.Org.getPayments(-57214449.57999564);
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'}
Return Type
OrgGetArtifacts200Response
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const result = await sdk.Org.getArtifacts(-36276941.96108951);
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'}
Return Type
OrgGetDocs200Response
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const result = await sdk.Org.getDocs(-68273274.61825137);
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'}
Return Type
OrgMemberResponse
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const input = { role: 'MEMBER', userId: 1 };
const result = await sdk.OrgMember.createMember(input, -40984411.27829866);
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'}
Return Type
PaginatedOrgMemberResponse
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const result = await sdk.OrgMember.getByOrgId(
-57697217.24462755,
-85293935.57287608,
-15966789.480003208,
);
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'}
Return Type
OrgMemberResponse
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const input = { role: 'MEMBER' };
const result = await sdk.OrgMember.updateMember(input, -1026836.1578079909, 53593586.546841264);
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'}
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(-42014338.07068389, 58660013.015025616);
console.log(result);
})();
leaveOrg
- HTTP Method: DELETE
- Endpoint: /orgs/{orgId}/leave
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'}
Return Type
Returns a dict object.
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const result = await sdk.OrgMember.leaveOrg(52805763.737045586);
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'}
Return Type
UpdateManyOrgMembersResponse
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const result = await sdk.OrgMember.enableAllMembers(60424203.22377771);
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'}
Return Type
UpdateManyOrgMembersResponse
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const result = await sdk.OrgMember.disableAllMembers(-77983997.4891353);
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'}
Return Type
ArtifactResponse
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const input = {
artifactType: 'DOC',
bucketKey: 'ex',
bucketName: 'dolor minim',
buildId: 1,
status: {},
};
const result = await sdk.Artifact.create(input);
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'}
Return Type
ArtifactGetArtifacts200Response
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const result = await sdk.Artifact.getArtifacts(-17667920.13258627);
console.log(result);
})();
getArtifactStatuses
- HTTP Method: GET
- Endpoint: /artifacts/statuses
Required Parameters
Optional Parameters
Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}
Return Type
ArtifactGetArtifactStatuses200Response
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const result = await sdk.Artifact.getArtifactStatuses();
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'}
Return Type
ApiResponse
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const result = await sdk.Artifact.getById(-59301433.70893655);
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'}
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(-4182254.9788214266);
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'}
Return Type
SdkResponse
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const input = {
artifactId: 1,
fileLocation: 'https://my-file.location',
language: 'JAVA',
version: '1.0.0',
};
const result = await sdk.Sdk.create(input);
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 |
---|
sortBy | string | |
direction | string | |
Return Type
PaginatedSdkResponse
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const result = await sdk.Sdk.findSdks(39139365.83725861, -48458181.94808431, -76236202.05176166, {
sortBy: 'createdAt',
direction: 'asc',
});
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'}
Return Type
SdkResponse
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const result = await sdk.Sdk.getById(60961458.94151923);
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'}
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(11991869.669515818);
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('magna commodo sunt', {
apiSlug: 'ad voluptate',
apiVersion: 'ex',
});
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('in veniam dolore', {
apiSlug: 'ea consectetur Lorem aute eu',
apiVersion: 'quis Ut ipsum exercitation eiusmod',
});
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'}
Return Type
DocCreatedResponse
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const input = {
apiId: -76260018.98447137,
artifactId: 1,
fileLocation: 'https://example.com',
previewSlug: 'ullamco qui ut consequat',
version: '1.0.0',
};
const result = await sdk.Doc.create(input);
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'}
Return Type
PaginatedDocResponse
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const result = await sdk.Doc.findDocs(70000431.86518595, -89319690.46279252, 83510452.4008258);
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'}
Return Type
DocResponse
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const result = await sdk.Doc.approve('id Ut irure esse est');
console.log(result);
})();
unapprove
- HTTP Method: POST
- Endpoint: /docs/{previewSlug}/unapprove
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'}
Return Type
DocResponse
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const result = await sdk.Doc.unapprove('ad eu eiusmod labore');
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'}
Return Type
DocResponse
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const result = await sdk.Doc.getById(-1496301.6527559161);
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'}
Return Type
DocResponse
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const result = await sdk.Doc.remove(-50785137.64931558);
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'}
Return Type
DocResponse
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const input = { fileLocation: 'https://example.com', version: '1.0.0' };
const result = await sdk.Doc.update(input, -52865270.89138353);
console.log(result);
})();
getDownloadUrl
- HTTP Method: GET
- Endpoint: /docs/{id}/getDownloadUrl
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'}
Return Type
DocDownloadResponse
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const result = await sdk.Doc.getDownloadUrl(18787040.80863844);
console.log(result);
})();
getCurrentUser
- HTTP Method: GET
- Endpoint: /users/current-user
Required Parameters
Optional Parameters
Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}
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'}
Return Type
UserResponse
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const input = {
email: 'someone@example.com',
firstName: 'John',
lastName: 'Doe',
password: 'Password123!',
};
const result = await sdk.User.create(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 | |
Return Type
PaginatedUserResponse
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const result = await sdk.User.getUsers(72499715.7070446, -61535118.32391185, {
orgId: -13597738.425361961,
email: 'pariatur adipisicing commodo ex',
firstName: 'nisi nulla dolor dolor ea',
lastName: 'sit deserunt',
});
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'}
Return Type
UserResponse
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const result = await sdk.User.getById(90040422.96991202);
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'}
Return Type
UserResponse
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const input = {
email: 'someone@example.com',
firstName: 'John',
isEnabled: true,
isLiblabAdmin: true,
lastName: 'Doe',
refreshTokenHash: 'refreshTokenHash',
};
const result = await sdk.User.update(input, -76327908.18199009);
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'}
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(-83052328.37103361);
console.log(result);
})();
updateEmailSubscription
- HTTP Method: PATCH
- Endpoint: /users/emails/subscriptions
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'}
Return Type
Returns a dict object.
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(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 | |
Optional Parameters
Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}
Return Type
PaginatedOrgResponse
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const result = await sdk.User.getUserOrgs(71886321.15649948, -54913999.13753541);
console.log(result);
})();
getUserApis
- HTTP Method: GET
- Endpoint: /users/apis
Required Parameters
Optional Parameters
Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}
Return Type
UserGetUserApis200Response
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const result = await sdk.User.getUserApis();
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'}
Return Type
UserResponse
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const input = { email: 'someone@example.com', password: 'Password123!' };
const result = await sdk.Auth.signup(input);
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'}
Return Type
AuthTokenResponse
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const input = { email: 'someone@example.com', password: 'Password123!' };
const result = await sdk.Auth.login(input);
console.log(result);
})();
logout
- HTTP Method: POST
- Endpoint: /auth/logout
Required Parameters
Optional Parameters
Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}
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'}
Return Type
AuthTokenResponse
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const input = { refreshToken: 'refreshToken' };
const result = await sdk.Auth.refreshToken(input);
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'}
Return Type
Returns a dict object.
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const input = { email: 'someone@example.com' };
const result = await sdk.Auth.resetPassword(input);
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'}
Return Type
AuthTokenResponse
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const input = { code: 'code', email: 'someone@example.com' };
const result = await sdk.Auth.oneTimeLogin(input);
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'}
Return Type
AuthTokenResponse
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const input = { password: 'Password123!' };
const result = await sdk.Auth.changePassword(input);
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'}
Return Type
Returns a dict object.
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const input = { code: 'code', email: 'someone@example.com' };
const result = await sdk.Auth.verifyEmail(input);
console.log(result);
})();
resendVerificationEmail
- 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'}
Return Type
Returns a dict object.
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const input = { email: 'someone@example.com' };
const result = await sdk.Auth.resendVerificationEmail(input);
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'}
Return Type
CreateTokenResponse
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const input = {
expiresAt: '2023-07-24T18:29:02.0Z',
name: 'My token',
scope: ['API', 'DOC', 'SDK', 'BUILD', 'ARTIFACT', 'ORG'],
};
const result = await sdk.Token.create(input);
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'}
Return Type
GetTokenResponse
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const result = await sdk.Token.findByUserId(1184544.3580203801);
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'}
Return Type
GetTokenResponse
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const result = await sdk.Token.getById(-60231077.041212);
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'}
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(44931551.71246511);
console.log(result);
})();
getOrgPlanHistory
- HTTP Method: GET
- Endpoint: /orgs/{orgId}/plans
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'}
Return Type
OrgPlanGetOrgPlanHistory200Response
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const result = await sdk.OrgPlan.getOrgPlanHistory(-5161692.015632331);
console.log(result);
})();
updateOrgPlan
- HTTP Method: PUT
- Endpoint: /orgs/{orgId}/plans
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'}
Return Type
OrgPlanResponse
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const input = { plan: 'COMMUNITY' };
const result = await sdk.OrgPlan.updateOrgPlan(input, -26609239.253058046);
console.log(result);
})();
getStripePaymentPortalUrl
- HTTP Method: GET
- Endpoint: /orgs/{orgId}/payment-portal
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'}
Return Type
OrgPaymentPortalResponse
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const input = { returnUrl: 'https://app.liblab.com/' };
const result = await sdk.OrgPlan.getStripePaymentPortalUrl(input, -76665825.27671587);
console.log(result);
})();
stripeWebhook
- HTTP Method: POST
- Endpoint: /stripe/webhook
Required Parameters
Name | Type | Description |
---|
stripeSignature | string | |
Optional Parameters
Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}
Return Type
Returns a dict object.
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const result = await sdk.Stripe.stripeWebhook('qui dolore cupidatat dolor in');
console.log(result);
})();
healthCheckControllerCheck
- HTTP Method: GET
- Endpoint: /health-check
Required Parameters
Optional Parameters
Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}
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'}
Return Type
Returns a dict object.
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const input = { metadata: { foo: 'bar' }, name: 'my-event', userToken: 'amet id sit' };
const result = await sdk.Event.track(input);
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'}
Return Type
InvitationResponse
InvitationResponse
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const input = { email: 'someone@example.com', name: 'John Doe', role: 'MEMBER' };
const result = await sdk.Invitation.createInvite(input, 43420692.26395351);
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'}
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('non labore dolore eiusmod consectetur');
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'}
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('et');
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'}
Return Type
InvitationResponse
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const result = await sdk.Invitation.inviteCode('commodo');
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'}
Return Type
InvitationGetInvitesByUser200Response
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const result = await sdk.Invitation.getInvitesByUser(16852695.21092163, -43145802.703673564);
console.log(result);
})();
create
- HTTP Method: POST
- Endpoint: /tags
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'}
Return Type
TagResponse
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(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 | |
Optional Parameters
Optional parameters are passed as part of the last parameter to the method. Ex. {optionalParam1 : 'value1', optionalParam2: 'value2'}
Return Type
TagsSearch200Response
Example Usage Code Snippet
import { Liblab } from './src';
const sdk = new Liblab();
(async () => {
const result = await sdk.Tags.search(
-54840543.43759475,
-59085314.96862901,
'ut adipisicing id Lorem in',
);
console.log(result);
})();