@gnosticdev/highlevel-sdk
Version:
SDK for the HighLevel API
342 lines (340 loc) • 10.1 kB
text/typescript
type paths = {
'/links/': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Links
* @description Get Links
*/
get: operations['get-links'];
put?: never;
/**
* Create Link
* @description Create Link
*/
post: operations['create-link'];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/links/{linkId}': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/**
* Update Link
* @description Update Link
*/
put: operations['update-link'];
post?: never;
/**
* Delete Link
* @description Delete Link
*/
delete: operations['delete-link'];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
};
type webhooks = Record<string, never>;
type components = {
schemas: {
BadRequestDTO: {
/** @example Bad Request */
message?: string;
/** @example 400 */
statusCode?: number;
};
DeleteLinksSuccessfulResponseDto: {
/** @example true */
succeded?: boolean;
};
GetLinksSuccessfulResponseDto: {
links?: components['schemas']['LinkSchema'][];
};
GetLinkSuccessfulResponseDto: {
link?: components['schemas']['LinkSchema'];
};
LinkSchema: {
/** @example {{trigger_link.n4AriwEnFrGh3tu08W0U}} */
fieldKey?: string;
/** @example n4AriwEnFrGh3tu08W0U */
id?: string;
/** @example ve9EPM428h8vShlRW1KT */
locationId?: string;
/** @example first tag */
name?: string;
/** @example https://www.google.com/ */
redirectTo?: string;
};
LinksDto: {
/** @example ve9EPM428h8vShlRW1KT */
locationId: string;
/** @example first tag */
name: string;
/** @example https://www.google.com/ */
redirectTo: string;
};
LinkUpdateDto: {
/** @example first tag */
name: string;
/** @example https://www.google.com/ */
redirectTo: string;
};
UnauthorizedDTO: {
/** @example Unauthorized */
error?: string;
/** @example Invalid token: access token is invalid */
message?: string;
/** @example 401 */
statusCode?: number;
};
UnprocessableDTO: {
/** @example Unprocessable Entity */
error?: string;
/** @example [
* "Unprocessable Entity"
* ] */
message?: string[];
/** @example 422 */
statusCode?: number;
};
};
responses: never;
parameters: never;
requestBodies: never;
headers: never;
pathItems: never;
};
type $defs = Record<string, never>;
interface operations {
'get-links': {
parameters: {
query: {
/** @example ve9EPM428h8vShlRW1KT */
locationId: string;
};
header: {
/** @description Access Token */
Authorization: string;
/** @description API Version */
Version: '2021-07-28';
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful response */
200: {
headers: {
[name: string]: unknown;
};
content: {
'application/json': components['schemas']['GetLinksSuccessfulResponseDto'];
};
};
/** @description Bad Request */
400: {
headers: {
[name: string]: unknown;
};
content: {
'application/json': components['schemas']['BadRequestDTO'];
};
};
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown;
};
content: {
'application/json': components['schemas']['UnauthorizedDTO'];
};
};
};
};
'create-link': {
parameters: {
query?: never;
header: {
/** @description Access Token */
Authorization: string;
/** @description API Version */
Version: '2021-07-28';
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
'application/json': components['schemas']['LinksDto'];
};
};
responses: {
/** @description Successful response */
201: {
headers: {
[name: string]: unknown;
};
content: {
'application/json': components['schemas']['GetLinkSuccessfulResponseDto'];
};
};
/** @description Bad Request */
400: {
headers: {
[name: string]: unknown;
};
content: {
'application/json': components['schemas']['BadRequestDTO'];
};
};
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown;
};
content: {
'application/json': components['schemas']['UnauthorizedDTO'];
};
};
/** @description Unprocessable Entity */
422: {
headers: {
[name: string]: unknown;
};
content: {
'application/json': components['schemas']['UnprocessableDTO'];
};
};
};
};
'update-link': {
parameters: {
query?: never;
header: {
/** @description Access Token */
Authorization: string;
/** @description API Version */
Version: '2021-07-28';
};
path: {
/** @description Link Id */
linkId: string;
};
cookie?: never;
};
requestBody: {
content: {
'application/json': components['schemas']['LinkUpdateDto'];
};
};
responses: {
/** @description Successful response */
201: {
headers: {
[name: string]: unknown;
};
content: {
'application/json': components['schemas']['GetLinkSuccessfulResponseDto'];
};
};
/** @description Bad Request */
400: {
headers: {
[name: string]: unknown;
};
content: {
'application/json': components['schemas']['BadRequestDTO'];
};
};
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown;
};
content: {
'application/json': components['schemas']['UnauthorizedDTO'];
};
};
/** @description Unprocessable Entity */
422: {
headers: {
[name: string]: unknown;
};
content: {
'application/json': components['schemas']['UnprocessableDTO'];
};
};
};
};
'delete-link': {
parameters: {
query?: never;
header: {
/** @description Access Token */
Authorization: string;
/** @description API Version */
Version: '2021-07-28';
};
path: {
/** @description Link Id */
linkId: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful response */
201: {
headers: {
[name: string]: unknown;
};
content: {
'application/json': components['schemas']['DeleteLinksSuccessfulResponseDto'];
};
};
/** @description Bad Request */
400: {
headers: {
[name: string]: unknown;
};
content: {
'application/json': components['schemas']['BadRequestDTO'];
};
};
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown;
};
content: {
'application/json': components['schemas']['UnauthorizedDTO'];
};
};
/** @description Unprocessable Entity */
422: {
headers: {
[name: string]: unknown;
};
content: {
'application/json': components['schemas']['UnprocessableDTO'];
};
};
};
};
}
export type { $defs, components, operations, paths, webhooks };