github
/
nocodb
mirror of https://github.com/nocodb/nocodb
1
0
Fork 0
Code Issues Releases Wiki Activity
Browse Source

refactor(sdk): regenerate Api.ts

pull/5269/head
Wing-Kam Wong 2 years ago
parent
6fe2395136
commit
552d4ad3f1
1 changed files with 189 additions and 59 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 206
      packages/nocodb-sdk/src/lib/Api.ts

206
packages/nocodb-sdk/src/lib/Api.ts
Unescape View File

@ -4099,7 +4099,11 @@ export class Api<
* @name MetaDiffSync * @name MetaDiffSync
* @summary Sync Meta * @summary Sync Meta
* @request POST:/api/v1/db/meta/projects/{projectId}/meta-diff * @request POST:/api/v1/db/meta/projects/{projectId}/meta-diff
* @response `200` `any` OK * @response `200` `{
\** @example The meta has been synchronized successfully *\
msg?: string,
}` OK
* @response `400` `{ * @response `400` `{
\** @example BadRequest [Error]: <ERROR MESSAGE> *\ \** @example BadRequest [Error]: <ERROR MESSAGE> *\
msg?: string, msg?: string,
@ -4108,7 +4112,10 @@ export class Api<
*/ */
metaDiffSync: (projectId: IdType, params: RequestParams = {}) => metaDiffSync: (projectId: IdType, params: RequestParams = {}) =>
this.request< this.request<
any, {
/** @example The meta has been synchronized successfully */
msg?: string;
},
{ {
/** @example BadRequest [Error]: <ERROR MESSAGE> */ /** @example BadRequest [Error]: <ERROR MESSAGE> */
msg?: string; msg?: string;
@ -4127,7 +4134,26 @@ export class Api<
* @name MetaDiffGet * @name MetaDiffGet
* @summary Meta Diff * @summary Meta Diff
* @request GET:/api/v1/db/meta/projects/{projectId}/meta-diff * @request GET:/api/v1/db/meta/projects/{projectId}/meta-diff
* @response `200` `any` OK * @response `200` `({
\**
* Table Name
* @example Table 1
*\
table_name?: string,
\**
* Base ID
* @example ds_rrplkgy0pq1f3c
*\
base_id?: string,
\**
* Change Type
* @example table
*\
type?: string,
\** Detected Changes *\
detectedChanges?: (object)[],
})[]` OK
* @response `400` `{ * @response `400` `{
\** @example BadRequest [Error]: <ERROR MESSAGE> *\ \** @example BadRequest [Error]: <ERROR MESSAGE> *\
msg?: string, msg?: string,
@ -4136,7 +4162,25 @@ export class Api<
*/ */
metaDiffGet: (projectId: IdType, params: RequestParams = {}) => metaDiffGet: (projectId: IdType, params: RequestParams = {}) =>
this.request< this.request<
any, {
/**
* Table Name
* @example Table 1
*/
table_name?: string;
/**
* Base ID
* @example ds_rrplkgy0pq1f3c
*/
base_id?: string;
/**
* Change Type
* @example table
*/
type?: string;
/** Detected Changes */
detectedChanges?: object[];
}[],
{ {
/** @example BadRequest [Error]: <ERROR MESSAGE> */ /** @example BadRequest [Error]: <ERROR MESSAGE> */
msg?: string; msg?: string;
@ -4259,7 +4303,7 @@ export class Api<
* @name Delete * @name Delete
* @summary Delete Base * @summary Delete Base
* @request DELETE:/api/v1/db/meta/projects/{projectId}/bases/{baseId} * @request DELETE:/api/v1/db/meta/projects/{projectId}/bases/{baseId}
* @response `200` `void` OK * @response `200` `boolean` OK
* @response `400` `{ * @response `400` `{
\** @example BadRequest [Error]: <ERROR MESSAGE> *\ \** @example BadRequest [Error]: <ERROR MESSAGE> *\
msg?: string, msg?: string,
@ -4268,7 +4312,7 @@ export class Api<
*/ */
delete: (projectId: IdType, baseId: string, params: RequestParams = {}) => delete: (projectId: IdType, baseId: string, params: RequestParams = {}) =>
this.request< this.request<
void, boolean,
{ {
/** @example BadRequest [Error]: <ERROR MESSAGE> */ /** @example BadRequest [Error]: <ERROR MESSAGE> */
msg?: string; msg?: string;
@ -4276,6 +4320,7 @@ export class Api<
>({ >({
path: `/api/v1/db/meta/projects/${projectId}/bases/${baseId}`, path: `/api/v1/db/meta/projects/${projectId}/bases/${baseId}`,
method: 'DELETE', method: 'DELETE',
format: 'json',
...params, ...params,
}), }),
@ -4286,7 +4331,7 @@ export class Api<
* @name Update * @name Update
* @summary Update Base * @summary Update Base
* @request PATCH:/api/v1/db/meta/projects/{projectId}/bases/{baseId} * @request PATCH:/api/v1/db/meta/projects/{projectId}/bases/{baseId}
* @response `200` `void` OK * @response `200` `object` OK
* @response `400` `{ * @response `400` `{
\** @example BadRequest [Error]: <ERROR MESSAGE> *\ \** @example BadRequest [Error]: <ERROR MESSAGE> *\
msg?: string, msg?: string,
@ -4296,11 +4341,11 @@ export class Api<
update: ( update: (
projectId: IdType, projectId: IdType,
baseId: string, baseId: string,
data: any, data: object,
params: RequestParams = {} params: RequestParams = {}
) => ) =>
this.request< this.request<
void, object,
{ {
/** @example BadRequest [Error]: <ERROR MESSAGE> */ /** @example BadRequest [Error]: <ERROR MESSAGE> */
msg?: string; msg?: string;
@ -4310,6 +4355,7 @@ export class Api<
method: 'PATCH', method: 'PATCH',
body: data, body: data,
type: ContentType.Json, type: ContentType.Json,
format: 'json',
...params, ...params,
}), }),
@ -4457,7 +4503,11 @@ export class Api<
* @name MetaDiffSync * @name MetaDiffSync
* @summary Synchronise Base Meta * @summary Synchronise Base Meta
* @request POST:/api/v1/db/meta/projects/{projectId}/meta-diff/{baseId} * @request POST:/api/v1/db/meta/projects/{projectId}/meta-diff/{baseId}
* @response `200` `any` OK * @response `200` `{
\** @example The base meta has been synchronized successfully *\
msg?: string,
}` OK
* @response `400` `{ * @response `400` `{
\** @example BadRequest [Error]: <ERROR MESSAGE> *\ \** @example BadRequest [Error]: <ERROR MESSAGE> *\
msg?: string, msg?: string,
@ -4470,7 +4520,10 @@ export class Api<
params: RequestParams = {} params: RequestParams = {}
) => ) =>
this.request< this.request<
any, {
/** @example The base meta has been synchronized successfully */
msg?: string;
},
{ {
/** @example BadRequest [Error]: <ERROR MESSAGE> */ /** @example BadRequest [Error]: <ERROR MESSAGE> */
msg?: string; msg?: string;
@ -4489,7 +4542,26 @@ export class Api<
* @name MetaDiffGet * @name MetaDiffGet
* @summary Base Meta Diff * @summary Base Meta Diff
* @request GET:/api/v1/db/meta/projects/{projectId}/meta-diff/{baseId} * @request GET:/api/v1/db/meta/projects/{projectId}/meta-diff/{baseId}
* @response `200` `any` OK * @response `200` `({
\**
* Table Name
* @example Table 1
*\
table_name?: string,
\**
* Base ID
* @example ds_rrplkgy0pq1f3c
*\
base_id?: string,
\**
* Change Type
* @example table
*\
type?: string,
\** Detected Changes *\
detectedChanges?: (object)[],
})[]` OK
* @response `400` `{ * @response `400` `{
\** @example BadRequest [Error]: <ERROR MESSAGE> *\ \** @example BadRequest [Error]: <ERROR MESSAGE> *\
msg?: string, msg?: string,
@ -4502,7 +4574,25 @@ export class Api<
params: RequestParams = {} params: RequestParams = {}
) => ) =>
this.request< this.request<
any, {
/**
* Table Name
* @example Table 1
*/
table_name?: string;
/**
* Base ID
* @example ds_rrplkgy0pq1f3c
*/
base_id?: string;
/**
* Change Type
* @example table
*/
type?: string;
/** Detected Changes */
detectedChanges?: object[];
}[],
{ {
/** @example BadRequest [Error]: <ERROR MESSAGE> */ /** @example BadRequest [Error]: <ERROR MESSAGE> */
msg?: string; msg?: string;
@ -4621,7 +4711,11 @@ export class Api<
* @name Update * @name Update
* @summary Update Table * @summary Update Table
* @request PATCH:/api/v1/db/meta/tables/{tableId} * @request PATCH:/api/v1/db/meta/tables/{tableId}
* @response `200` `any` OK * @response `200` `{
\** @example The table has been updated successfully *\
msg?: string,
}` OK
* @response `400` `{ * @response `400` `{
\** @example BadRequest [Error]: <ERROR MESSAGE> *\ \** @example BadRequest [Error]: <ERROR MESSAGE> *\
msg?: string, msg?: string,
@ -4652,7 +4746,10 @@ export class Api<
params: RequestParams = {} params: RequestParams = {}
) => ) =>
this.request< this.request<
any, {
/** @example The table has been updated successfully */
msg?: string;
},
{ {
/** @example BadRequest [Error]: <ERROR MESSAGE> */ /** @example BadRequest [Error]: <ERROR MESSAGE> */
msg?: string; msg?: string;
@ -4673,7 +4770,7 @@ export class Api<
* @name Delete * @name Delete
* @summary Delete Table * @summary Delete Table
* @request DELETE:/api/v1/db/meta/tables/{tableId} * @request DELETE:/api/v1/db/meta/tables/{tableId}
* @response `200` `void` OK * @response `200` `boolean` OK
* @response `400` `{ * @response `400` `{
\** @example BadRequest [Error]: <ERROR MESSAGE> *\ \** @example BadRequest [Error]: <ERROR MESSAGE> *\
msg?: string, msg?: string,
@ -4682,7 +4779,7 @@ export class Api<
*/ */
delete: (tableId: IdType, params: RequestParams = {}) => delete: (tableId: IdType, params: RequestParams = {}) =>
this.request< this.request<
void, boolean,
{ {
/** @example BadRequest [Error]: <ERROR MESSAGE> */ /** @example BadRequest [Error]: <ERROR MESSAGE> */
msg?: string; msg?: string;
@ -4690,6 +4787,7 @@ export class Api<
>({ >({
path: `/api/v1/db/meta/tables/${tableId}`, path: `/api/v1/db/meta/tables/${tableId}`,
method: 'DELETE', method: 'DELETE',
format: 'json',
...params, ...params,
}), }),
@ -4700,7 +4798,7 @@ export class Api<
* @name Reorder * @name Reorder
* @summary Reorder Table * @summary Reorder Table
* @request POST:/api/v1/db/meta/tables/{tableId}/reorder * @request POST:/api/v1/db/meta/tables/{tableId}/reorder
* @response `200` `void` OK * @response `200` `boolean` OK
* @response `400` `{ * @response `400` `{
\** @example BadRequest [Error]: <ERROR MESSAGE> *\ \** @example BadRequest [Error]: <ERROR MESSAGE> *\
msg?: string, msg?: string,
@ -4715,7 +4813,7 @@ export class Api<
params: RequestParams = {} params: RequestParams = {}
) => ) =>
this.request< this.request<
void, boolean,
{ {
/** @example BadRequest [Error]: <ERROR MESSAGE> */ /** @example BadRequest [Error]: <ERROR MESSAGE> */
msg?: string; msg?: string;
@ -4725,6 +4823,7 @@ export class Api<
method: 'POST', method: 'POST',
body: data, body: data,
type: ContentType.Json, type: ContentType.Json,
format: 'json',
...params, ...params,
}), }),
}; };
@ -6343,7 +6442,7 @@ export class Api<
* @name GroupedDataList * @name GroupedDataList
* @summary Table Group by Column * @summary Table Group by Column
* @request GET:/api/v1/db/data/{orgs}/{projectName}/{tableName}/group/{columnId} * @request GET:/api/v1/db/data/{orgs}/{projectName}/{tableName}/group/{columnId}
* @response `200` `any` OK * @response `200` `object` OK
* @response `400` `{ * @response `400` `{
\** @example BadRequest [Error]: <ERROR MESSAGE> *\ \** @example BadRequest [Error]: <ERROR MESSAGE> *\
msg?: string, msg?: string,
@ -6365,7 +6464,7 @@ export class Api<
params: RequestParams = {} params: RequestParams = {}
) => ) =>
this.request< this.request<
any, object,
{ {
/** @example BadRequest [Error]: <ERROR MESSAGE> */ /** @example BadRequest [Error]: <ERROR MESSAGE> */
msg?: string; msg?: string;
@ -6648,7 +6747,7 @@ export class Api<
orgs: string, orgs: string,
projectName: string, projectName: string,
tableName: string, tableName: string,
data: any, data: object,
query?: { query?: {
where?: string; where?: string;
}, },
@ -6677,7 +6776,7 @@ export class Api<
* @name BulkDeleteAll * @name BulkDeleteAll
* @summary Bulk Delete Table Rows with Conditions * @summary Bulk Delete Table Rows with Conditions
* @request DELETE:/api/v1/db/data/bulk/{orgs}/{projectName}/{tableName}/all * @request DELETE:/api/v1/db/data/bulk/{orgs}/{projectName}/{tableName}/all
* @response `200` `any` OK * @response `200` `(object)[]` OK
* @response `400` `{ * @response `400` `{
\** @example BadRequest [Error]: <ERROR MESSAGE> *\ \** @example BadRequest [Error]: <ERROR MESSAGE> *\
msg?: string, msg?: string,
@ -6688,14 +6787,14 @@ export class Api<
orgs: string, orgs: string,
projectName: string, projectName: string,
tableName: string, tableName: string,
data: any, data: object,
query?: { query?: {
where?: string; where?: string;
}, },
params: RequestParams = {} params: RequestParams = {}
) => ) =>
this.request< this.request<
any, object[],
{ {
/** @example BadRequest [Error]: <ERROR MESSAGE> */ /** @example BadRequest [Error]: <ERROR MESSAGE> */
msg?: string; msg?: string;
@ -6937,7 +7036,7 @@ export class Api<
* @name GroupedDataList * @name GroupedDataList
* @summary Table Group by Column * @summary Table Group by Column
* @request GET:/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/group/{columnId} * @request GET:/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/group/{columnId}
* @response `200` `any` OK * @response `200` `object` OK
* @response `400` `{ * @response `400` `{
\** @example BadRequest [Error]: <ERROR MESSAGE> *\ \** @example BadRequest [Error]: <ERROR MESSAGE> *\
msg?: string, msg?: string,
@ -6960,7 +7059,7 @@ export class Api<
params: RequestParams = {} params: RequestParams = {}
) => ) =>
this.request< this.request<
any, object,
{ {
/** @example BadRequest [Error]: <ERROR MESSAGE> */ /** @example BadRequest [Error]: <ERROR MESSAGE> */
msg?: string; msg?: string;
@ -7147,7 +7246,10 @@ export class Api<
* @name Count * @name Count
* @summary Count Table View Rows * @summary Count Table View Rows
* @request GET:/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/count * @request GET:/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/count
* @response `200` `any` OK * @response `200` `{
count?: number,
}` OK
*/ */
count: ( count: (
orgs: string, orgs: string,
@ -7161,7 +7263,12 @@ export class Api<
}, },
params: RequestParams = {} params: RequestParams = {}
) => ) =>
this.request<any, any>({ this.request<
{
count?: number;
},
any
>({
path: `/api/v1/db/data/${orgs}/${projectName}/${tableName}/views/${viewName}/count`, path: `/api/v1/db/data/${orgs}/${projectName}/${tableName}/views/${viewName}/count`,
method: 'GET', method: 'GET',
query: query, query: query,
@ -7176,7 +7283,12 @@ export class Api<
* @name Read * @name Read
* @summary Get Table View Row * @summary Get Table View Row
* @request GET:/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/{rowId} * @request GET:/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/{rowId}
* @response `201` `any` Created * @response `200` `object` OK
* @response `400` `{
\** @example BadRequest [Error]: <ERROR MESSAGE> *\
msg?: string,
}`
*/ */
read: ( read: (
orgs: string, orgs: string,
@ -7186,7 +7298,13 @@ export class Api<
rowId: any, rowId: any,
params: RequestParams = {} params: RequestParams = {}
) => ) =>
this.request<any, any>({ this.request<
object,
{
/** @example BadRequest [Error]: <ERROR MESSAGE> */
msg?: string;
}
>({
path: `/api/v1/db/data/${orgs}/${projectName}/${tableName}/views/${viewName}/${rowId}`, path: `/api/v1/db/data/${orgs}/${projectName}/${tableName}/views/${viewName}/${rowId}`,
method: 'GET', method: 'GET',
format: 'json', format: 'json',
@ -7200,7 +7318,12 @@ export class Api<
* @name Update * @name Update
* @summary Update Table View Row * @summary Update Table View Row
* @request PATCH:/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/{rowId} * @request PATCH:/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/{rowId}
* @response `200` `any` OK * @response `200` `object` OK
* @response `400` `{
\** @example BadRequest [Error]: <ERROR MESSAGE> *\
msg?: string,
}`
*/ */
update: ( update: (
orgs: string, orgs: string,
@ -7208,10 +7331,16 @@ export class Api<
tableName: string, tableName: string,
viewName: string, viewName: string,
rowId: any, rowId: any,
data: any, data: object,
params: RequestParams = {} params: RequestParams = {}
) => ) =>
this.request<any, any>({ this.request<
object,
{
/** @example BadRequest [Error]: <ERROR MESSAGE> */
msg?: string;
}
>({
path: `/api/v1/db/data/${orgs}/${projectName}/${tableName}/views/${viewName}/${rowId}`, path: `/api/v1/db/data/${orgs}/${projectName}/${tableName}/views/${viewName}/${rowId}`,
method: 'PATCH', method: 'PATCH',
body: data, body: data,
@ -7227,7 +7356,7 @@ export class Api<
* @name Delete * @name Delete
* @summary Delete Table View Row * @summary Delete Table View Row
* @request DELETE:/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/{rowId} * @request DELETE:/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/{rowId}
* @response `200` `void` OK * @response `200` `number` OK
* @response `400` `{ * @response `400` `{
\** @example BadRequest [Error]: <ERROR MESSAGE> *\ \** @example BadRequest [Error]: <ERROR MESSAGE> *\
msg?: string, msg?: string,
@ -7243,7 +7372,7 @@ export class Api<
params: RequestParams = {} params: RequestParams = {}
) => ) =>
this.request< this.request<
void, number,
{ {
/** @example BadRequest [Error]: <ERROR MESSAGE> */ /** @example BadRequest [Error]: <ERROR MESSAGE> */
msg?: string; msg?: string;
@ -7251,6 +7380,7 @@ export class Api<
>({ >({
path: `/api/v1/db/data/${orgs}/${projectName}/${tableName}/views/${viewName}/${rowId}`, path: `/api/v1/db/data/${orgs}/${projectName}/${tableName}/views/${viewName}/${rowId}`,
method: 'DELETE', method: 'DELETE',
format: 'json',
...params, ...params,
}), }),
@ -7261,7 +7391,7 @@ export class Api<
* @name Exist * @name Exist
* @summary Does Table View Row Exist * @summary Does Table View Row Exist
* @request GET:/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/{rowId}/exist * @request GET:/api/v1/db/data/{orgs}/{projectName}/{tableName}/views/{viewName}/{rowId}/exist
* @response `201` `any` Created * @response `201` `number` Created
* @response `400` `{ * @response `400` `{
\** @example BadRequest [Error]: <ERROR MESSAGE> *\ \** @example BadRequest [Error]: <ERROR MESSAGE> *\
msg?: string, msg?: string,
@ -7277,7 +7407,7 @@ export class Api<
params: RequestParams = {} params: RequestParams = {}
) => ) =>
this.request< this.request<
any, number,
{ {
/** @example BadRequest [Error]: <ERROR MESSAGE> */ /** @example BadRequest [Error]: <ERROR MESSAGE> */
msg?: string; msg?: string;

Write Preview
Loading…
Cancel
Save