+
+
Click `Save` button to create the new column.
@@ -86,6 +87,11 @@ You will be able to edit column name & associated datatype using pop-up modal.
+Prior to v0.104.3, Advanced menu by default displayed developer specific database configuration options. To avoid unintended tweaks from user, these are now hidden under an easter egg menu. To enable, double click on `show all`/`hide all` button in column edit modal.
+
+
+
+
### Column Delete
To delete a column, click the down arrow, select `Delete` from the menu.
diff --git a/packages/nocodb-sdk/src/lib/Api.ts b/packages/nocodb-sdk/src/lib/Api.ts
index a2358937bb..33a759b62c 100644
--- a/packages/nocodb-sdk/src/lib/Api.ts
+++ b/packages/nocodb-sdk/src/lib/Api.ts
@@ -9,921 +9,2293 @@
* ---------------------------------------------------------------
*/
-export interface UserType {
- /** Unique identifier for the given user. */
- id: string;
- firstname: string;
- lastname: string;
- /** @format email */
- email: string;
- roles?: string;
+/**
+ * Model for API Token
+ */
+export interface ApiTokenType {
+ /** Unique API Token ID */
+ id?: IdType;
+ /** Foreign Key to User */
+ fk_user_id?: IdType;
/**
- * @format date
- * @example 1997-10-31
+ * API Token Description
+ * @example This API Token is for ABC application
*/
- date_of_birth?: string;
- /** Set to true if the user's email has been verified. */
- email_verified: boolean;
+ description?: string;
/**
- * The date that the user was created.
- * @format date
+ * API Token
+ * @example DYh540o8hbWpUGdarekECKLdN5OhlgCUWutVJYX2
*/
- createDate?: string;
+ token?: string;
}
-export interface PageReqQueryParamsType {
- offset?: number;
- limit?: number;
- query?: string;
+/**
+ * Model for API Token Request
+ */
+export interface ApiTokenReqType {
+ /**
+ * Description of the API token
+ * @example This API Token is for ABC application
+ */
+ description?: string;
}
-export interface UserListType {
- users: {
- list: UserType;
- pageInfo: PaginatedType;
- };
+/**
+ * Model for Attachment
+ */
+export interface AttachmentType {
+ /** Data for uploading */
+ data?: any;
+ /** The mimetype of the attachment */
+ mimetype?: string;
+ /** File Path */
+ path?: string;
+ /** Attachment Size */
+ size?: number;
+ /** The title of the attachment. Used in UI. */
+ title?: string;
+ /** Attachment URL */
+ url?: string;
}
-export interface ProjectReqType {
- title: string;
- description?: string;
- color?: string;
- bases?: BaseReqType[];
+/**
+ * Model for Attachment Request
+ */
+export interface AttachmentReqType {
+ /** The mimetype of the attachment */
+ mimetype?: string;
+ /** The file path of the attachment */
+ path?: string;
+ /** The size of the attachment */
+ size?: number;
+ /** The title of the attachment used in UI */
+ title?: string;
+ /** Attachment URL to be uploaded via upload-by-url */
+ url?: string;
}
-export interface ProjectType {
- id?: string;
- title?: string;
+/**
+ * Model for Audit
+ */
+export interface AuditType {
+ /** Unique ID */
+ id?: IdType;
+ /**
+ * The user name performing the action
+ * @example w@nocodb.com
+ */
+ user?: string;
+ /**
+ * IP address from the user
+ * @example ::ffff:127.0.0.1
+ */
+ ip?: string;
+ /**
+ * Base ID in where action is performed
+ * @example ds_3l9qx8xqksenrl
+ */
+ base_id?: string;
+ /**
+ * Project ID in where action is performed
+ * @example p_9sx43moxhqtjm3
+ */
+ project_id?: string;
+ /**
+ * Model ID in where action is performed
+ * @example md_ehn5izr99m7d45
+ */
+ fk_model_id?: string;
+ /**
+ * Row ID
+ * @example rec0Adp9PMG9o7uJy
+ */
+ row_id?: string;
+ /**
+ * Operation Type
+ * @example AUTHENTICATION
+ */
+ op_type?:
+ | 'COMMENT'
+ | 'DATA'
+ | 'PROJECT'
+ | 'VIRTUAL_RELATION'
+ | 'RELATION'
+ | 'TABLE_VIEW'
+ | 'TABLE'
+ | 'VIEW'
+ | 'META'
+ | 'WEBHOOKS'
+ | 'AUTHENTICATION'
+ | 'TABLE_COLUMN'
+ | 'ORG_USER';
+ /**
+ * Operation Sub Type
+ * @example UPDATE
+ */
+ op_sub_type?:
+ | 'UPDATE'
+ | 'INSERT'
+ | 'BULK_INSERT'
+ | 'BULK_UPDATE'
+ | 'BULK_DELETE'
+ | 'LINK_RECORD'
+ | 'UNLINK_RECORD'
+ | 'DELETE'
+ | 'CREATED'
+ | 'DELETED'
+ | 'RENAMED'
+ | 'IMPORT_FROM_ZIP'
+ | 'EXPORT_TO_FS'
+ | 'EXPORT_TO_ZIP'
+ | 'UPDATED'
+ | 'SIGNIN'
+ | 'SIGNUP'
+ | 'PASSWORD_RESET'
+ | 'PASSWORD_FORGOT'
+ | 'PASSWORD_CHANGE'
+ | 'EMAIL_VERIFICATION'
+ | 'ROLES_MANAGEMENT'
+ | 'INVITE'
+ | 'RESEND_INVITE';
+ /** Audit Status */
status?: string;
+ /**
+ * Description of the action
+ * @example Table nc_snms___Table_1 : field Date got changed from 2023-03-12 to
+ */
description?: string;
- meta?: MetaType;
- color?: string;
- deleted?: BoolType;
- order?: number;
- bases?: BaseType[];
- is_meta?: BoolType;
- prefix?: string;
- created_at?: any;
- updated_at?: any;
- slug?: string;
+ /**
+ * Detail
+ * @example Date : 2023-03-12
+ */
+ details?: string;
}
-export interface ProjectListType {
- list?: ProjectType[];
- pageInfo?: PaginatedType;
+/**
+ * Model for Audit Row Update Request
+ */
+export interface AuditRowUpdateReqType {
+ /**
+ * Column Name
+ * @example baz
+ */
+ column_name?: string;
+ /**
+ * Foreign Key to Model
+ * @example md_ehn5izr99m7d45
+ */
+ fk_model_id?: string;
+ /**
+ * Row ID
+ * @example rec0Adp9PMG9o7uJy
+ */
+ row_id?: string;
+ /** The previous value before the action */
+ prev_value?: any;
+ /** The current value after the action */
+ value?: any;
}
+/**
+ * Model for Base
+ */
export interface BaseType {
- id?: string;
- project_id?: string;
- alias?: string;
- type?: string;
- is_meta?: BoolType;
+ /** Base Name - Default BASE will be null by default */
+ alias?: StringOrNullType;
+ /** Base Configuration */
config?: any;
- created_at?: any;
- updated_at?: any;
- inflection_column?: string;
- inflection_table?: string;
- order?: number;
+ /** Is this base enabled */
enabled?: BoolType;
-}
-
-export interface BaseReqType {
+ /** Unique Base ID */
id?: string;
- project_id?: string;
- alias?: string;
- type?: string;
- is_meta?: boolean;
- config?: any;
+ /**
+ * Inflection for columns
+ * @example camelize
+ */
inflection_column?: string;
+ /**
+ * Inflection for tables
+ * @example camelize
+ */
inflection_table?: string;
+ /** Is the data source connected externally */
+ is_meta?: BoolType;
+ /**
+ * The order of the list of bases
+ * @example 1
+ */
+ order?: number;
+ /** The project ID that this base belongs to */
+ project_id?: string;
+ /**
+ * DB Type
+ * @example mysql2
+ */
+ type?:
+ | 'mssql'
+ | 'mysql'
+ | 'mysql2'
+ | 'oracledb'
+ | 'pg'
+ | 'snowflake'
+ | 'sqlite3';
}
+/**
+ * Model for Base List
+ */
export interface BaseListType {
bases: {
list: BaseType[];
+ /** Model for Paginated */
pageInfo: PaginatedType;
};
}
-export interface TableType {
- id?: string;
- project_id?: string;
- base_id?: string;
- table_name: string;
- title: string;
- type?: string;
- enabled?: BoolType;
- parent_id?: string;
- show_as?: string;
- tags?: string;
- pinned?: BoolType;
- deleted?: BoolType;
- order?: number;
- columns?: ColumnType[];
- columnsById?: object;
- slug?: string;
- mm?: BoolType;
- meta?: MetaType;
+/**
+ * Model for Base Request
+ */
+export interface BaseReqType {
+ /**
+ * Base Name - Default BASE will be null by default
+ * @example My Base
+ */
+ alias?: string;
+ /** Base Configuration */
+ config?: any;
+ /**
+ * Inflection for columns
+ * @example camelize
+ */
+ inflection_column?: string;
+ /**
+ * Inflection for tables
+ * @example camelize
+ */
+ inflection_table?: string;
+ /** Is the data source connected externally */
+ is_meta?: boolean;
+ /** DB Type */
+ type?:
+ | 'mssql'
+ | 'mysql'
+ | 'mysql2'
+ | 'oracledb'
+ | 'pg'
+ | 'snowflake'
+ | 'sqlite3';
}
-export interface ViewType {
- id?: string;
- title: string;
+/**
+ * Model for Bool
+ */
+export type BoolType = number | boolean | null;
+
+/**
+ * Model for Column
+ */
+export interface ColumnType {
+ /** Is Auto-Increment? */
+ ai?: BoolType;
+ /** Auto Update Timestamp */
+ au?: BoolType;
+ /**
+ * Base ID that this column belongs to
+ * @example ds_krsappzu9f8vmo
+ */
+ base_id?: string;
+ /** Column Comment */
+ cc?: string;
+ /** Column Default */
+ cdf?: StringOrNullType;
+ /** Character Maximum Length */
+ clen?: number | null | string;
+ /** Column Options */
+ colOptions?:
+ | FormulaType
+ | LinkToAnotherRecordType
+ | LookupType
+ | RollupType
+ | SelectOptionsType
+ | object
+ | (FormulaType &
+ LinkToAnotherRecordType &
+ LookupType &
+ RollupType &
+ SelectOptionsType &
+ object);
+ /**
+ * Column Name
+ * @example title
+ */
+ column_name?: string;
+ /** Column Ordinal Position */
+ cop?: string;
+ /** Character Set Name */
+ csn?: StringOrNullType;
+ /**
+ * Column Type
+ * @example varchar(45)
+ */
+ ct?: string;
+ /** Is Deleted? */
deleted?: BoolType;
- order?: number;
+ /**
+ * Data Type in DB
+ * @example varchar
+ */
+ dt?: string;
+ /**
+ * Data Type X
+ * @example specificType
+ */
+ dtx?: string;
+ /** Data Type X Precision */
+ dtxp?: null | number | string;
+ /** Data Type X Scale */
+ dtxs?: null | number | string;
+ /**
+ * Model ID that this column belongs to
+ * @example md_yvwvbt2i78rgcm
+ */
fk_model_id?: string;
- slug?: string;
- uuid?: string;
+ /** Unique ID */
+ id?: IdType;
+ /** Meta Info */
meta?: MetaType;
- show_system_fields?: BoolType;
- lock_type?: 'collaborative' | 'locked' | 'personal';
- type?: number;
- view?:
- | FormType
- | GridType
- | GalleryType
- | KanbanType
- | MapType
- | (FormType & GridType & GalleryType & KanbanType & MapType);
-}
-
-export interface TableInfoType {
- id?: string;
- fk_project_id?: string;
- fk_base_id?: string;
- title: string;
- table_name: string;
- type?: string;
- enabled?: string;
- parent_id?: string;
- show_as?: string;
- tags?: string;
- pinned?: BoolType;
- deleted?: BoolType;
- order?: number;
- column?: ColumnType[];
- filters?: FilterType[];
- sort?: SortType[];
-}
-
-export interface TableReqType {
- id?: string;
- fk_project_id?: string;
- fk_base_id?: string;
- table_name: string;
- title: string;
- type?: string;
- enabled?: string;
- parent_id?: string;
- show_as?: string;
- tags?: string;
- pinned?: BoolType;
- deleted?: BoolType;
+ /** Numeric Precision */
+ np?: number | null | string;
+ /** Numeric Scale */
+ ns?: number | null | string;
+ /** The order of the list of columns */
order?: number;
- mm?: BoolType;
- columns: NormalColumnRequestType[];
- meta?: MetaType;
-}
-
-export interface TableListType {
- list?: TableType[];
- pageInfo?: PaginatedType;
-}
-
-export interface FilterType {
- id?: string;
- fk_model_id?: string;
- fk_column_id?: string;
- logical_op?: string;
- comparison_op?: string;
- value?: any;
- is_group?: boolean | number | null;
- children?: FilterType[];
- project_id?: string;
- base_id?: string;
- fk_parent_id?: string;
- fk_view_id?: StringOrNullType;
- fk_hook_id?: StringOrNullType;
-}
+ /** Is Primary Key? */
+ pk?: BoolType;
+ /** Is Primary Value? */
+ pv?: BoolType;
+ /** Is Required? */
+ rqd?: BoolType;
+ /** Is System Column? */
+ system?: BoolType;
+ /**
+ * Column Title
+ * @example Title
+ */
+ title?: string;
+ /**
+ * The data type in UI
+ * @example SingleLineText
+ */
+ uidt?:
+ | 'Attachment'
+ | 'AutoNumber'
+ | 'Barcode'
+ | 'Button'
+ | 'Checkbox'
+ | 'Collaborator'
+ | 'Count'
+ | 'CreateTime'
+ | 'Currency'
+ | 'Date'
+ | 'DateTime'
+ | 'Decimal'
+ | 'Duration'
+ | 'Email'
+ | 'Formula'
+ | 'ForeignKey'
+ | 'GeoData'
+ | 'Geometry'
+ | 'ID'
+ | 'JSON'
+ | 'LastModifiedTime'
+ | 'LongText'
+ | 'LinkToAnotherRecord'
+ | 'Lookup'
+ | 'MultiSelect'
+ | 'Number'
+ | 'Percent'
+ | 'PhoneNumber'
+ | 'Rating'
+ | 'Rollup'
+ | 'SingleLineText'
+ | 'SingleSelect'
+ | 'SpecificDBType'
+ | 'Time'
+ | 'URL'
+ | 'Year'
+ | 'QrCode';
+ /** Is Unsigned? */
+ un?: BoolType;
+ /** Is unique? */
+ unique?: BoolType;
+ /** Is Visible? */
+ visible?: BoolType;
+}
-export interface FilterReqType {
- id?: string;
- fk_model_id?: string;
- fk_column_id?: string;
- logical_op?: string;
- comparison_op?: string;
- value?: any;
- is_group?: boolean | number | null;
- children?: FilterType[];
- project_id?: string;
+/**
+ * Model for Column List
+ */
+export interface ColumnListType {
+ columns: {
+ list: ColumnType[];
+ };
+}
+
+/**
+ * Model for Column Request
+ */
+export type ColumnReqType = (
+ | FormulaColumnReqType
+ | LinkToAnotherColumnReqType
+ | LookupColumnReqType
+ | NormalColumnRequestType
+ | RollupColumnReqType
+ | (FormulaColumnReqType &
+ LinkToAnotherColumnReqType &
+ LookupColumnReqType &
+ NormalColumnRequestType &
+ RollupColumnReqType)
+) & {
+ column_name?: string;
+ /** Column order in a specific view */
+ column_order?: {
+ order?: number;
+ view_id?: string;
+ };
+ title: string;
+};
+
+/**
+ * Model for Comment Request
+ */
+export interface CommentReqType {
+ /**
+ * Description for the target row
+ * @example This is the comment for the row
+ */
+ description?: string;
+ /**
+ * Foreign Key to Model
+ * @example md_ehn5izr99m7d45
+ */
+ fk_model_id: string;
+ /**
+ * Row ID
+ * @example 3
+ */
+ row_id: string;
+}
+
+/**
+ * Model for Filter
+ */
+export interface FilterType {
+ /** Unqiue Base ID */
base_id?: string;
- fk_parent_id?: string;
- fk_view_id?: StringOrNullType;
+ /** Children filters. Available when the filter is grouped. */
+ children?: FilterType[];
+ /** Comparison Operator */
+ comparison_op?:
+ | 'allof'
+ | 'anyof'
+ | 'blank'
+ | 'btw'
+ | 'checked'
+ | 'empty'
+ | 'eq'
+ | 'ge'
+ | 'gt'
+ | 'gte'
+ | 'in'
+ | 'is'
+ | 'isWithin'
+ | 'isnot'
+ | 'le'
+ | 'like'
+ | 'lt'
+ | 'lte'
+ | 'nallof'
+ | 'nanyof'
+ | 'nbtw'
+ | 'neq'
+ | 'nlike'
+ | 'not'
+ | 'notblank'
+ | 'notchecked'
+ | 'notempty'
+ | 'notnull'
+ | 'null';
+ /** Comparison Sub-Operator */
+ comparison_sub_op?:
+ | 'daysAgo'
+ | 'daysFromNow'
+ | 'exactDate'
+ | 'nextMonth'
+ | 'nextNumberOfDays'
+ | 'nextWeek'
+ | 'nextYear'
+ | 'oneMonthAgo'
+ | 'oneMonthFromNow'
+ | 'oneWeekAgo'
+ | 'oneWeekFromNow'
+ | 'pastMonth'
+ | 'pastNumberOfDays'
+ | 'pastWeek'
+ | 'pastYear'
+ | 'today'
+ | 'tomorrow'
+ | 'yesterday'
+ | null
+ | (
+ | 'daysAgo'
+ | 'daysFromNow'
+ | 'exactDate'
+ | 'nextMonth'
+ | 'nextNumberOfDays'
+ | 'nextWeek'
+ | 'nextYear'
+ | 'oneMonthAgo'
+ | 'oneMonthFromNow'
+ | 'oneWeekAgo'
+ | 'oneWeekFromNow'
+ | 'pastMonth'
+ | 'pastNumberOfDays'
+ | 'pastWeek'
+ | 'pastYear'
+ | 'today'
+ | 'tomorrow'
+ | ('yesterday' & null)
+ );
+ /** Foreign Key to Column */
+ fk_column_id?: IdType;
+ /** Foreign Key to Hook */
fk_hook_id?: StringOrNullType;
+ /** Foreign Key to Model */
+ fk_model_id?: IdType;
+ /** Foreign Key to parent group. */
+ fk_parent_id?: StringOrNullType;
+ /** Foreign Key to View */
+ fk_view_id?: StringOrNullType;
+ /** Unique ID */
+ id?: IdType;
+ /** Is this filter grouped? */
+ is_group?: boolean | number | null;
+ /** Logical Operator */
+ logical_op?: 'and' | 'not' | 'or';
+ /** Unique Project ID */
+ project_id?: string;
+ /** The filter value. Can be NULL for some operators. */
+ value?: any;
}
+/**
+ * Model for Filter List
+ */
export interface FilterListType {
filters: {
list: FilterType[];
};
}
-export interface SortType {
- id?: string;
+/**
+ * Model for Filter Request
+ */
+export interface FilterReqType {
+ /** Comparison Operator */
+ comparison_op?:
+ | 'allof'
+ | 'anyof'
+ | 'blank'
+ | 'btw'
+ | 'checked'
+ | 'empty'
+ | 'eq'
+ | 'ge'
+ | 'gt'
+ | 'gte'
+ | 'in'
+ | 'is'
+ | 'isWithin'
+ | 'isnot'
+ | 'le'
+ | 'like'
+ | 'lt'
+ | 'lte'
+ | 'nallof'
+ | 'nanyof'
+ | 'nbtw'
+ | 'neq'
+ | 'nlike'
+ | 'not'
+ | 'notblank'
+ | 'notchecked'
+ | 'notempty'
+ | 'notnull'
+ | 'null';
+ /** Comparison Sub-Operator */
+ comparison_sub_op?:
+ | 'daysAgo'
+ | 'daysFromNow'
+ | 'exactDate'
+ | 'nextMonth'
+ | 'nextNumberOfDays'
+ | 'nextWeek'
+ | 'nextYear'
+ | 'oneMonthAgo'
+ | 'oneMonthFromNow'
+ | 'oneWeekAgo'
+ | 'oneWeekFromNow'
+ | 'pastMonth'
+ | 'pastNumberOfDays'
+ | 'pastWeek'
+ | 'pastYear'
+ | 'today'
+ | 'tomorrow'
+ | 'yesterday'
+ | null
+ | (
+ | 'daysAgo'
+ | 'daysFromNow'
+ | 'exactDate'
+ | 'nextMonth'
+ | 'nextNumberOfDays'
+ | 'nextWeek'
+ | 'nextYear'
+ | 'oneMonthAgo'
+ | 'oneMonthFromNow'
+ | 'oneWeekAgo'
+ | 'oneWeekFromNow'
+ | 'pastMonth'
+ | 'pastNumberOfDays'
+ | 'pastWeek'
+ | 'pastYear'
+ | 'today'
+ | 'tomorrow'
+ | ('yesterday' & null)
+ );
+ /** Foreign Key to Column */
+ fk_column_id?: IdType;
+ /** Belong to which filter ID */
+ fk_parent_id?: IdType;
+ /** Is this filter grouped? */
+ is_group?: BoolType;
+ /** Logical Operator */
+ logical_op?: 'and' | 'not' | 'or';
+ /** The filter value. Can be NULL for some operators. */
+ value?: any;
+}
+
+/**
+ * Model for Form
+ */
+export interface FormType {
+ /** Unique ID */
+ id?: IdType;
+ /** Banner Image URL. Not in use currently. */
+ banner_image_url?: StringOrNullType;
+ /** Form Columns */
+ columns?: FormColumnType[];
+ /** Email to sned after form is submitted */
+ email?: StringOrNullType;
+ /**
+ * Foreign Key to Model
+ * @example md_rsu68aqjsbyqtl
+ */
fk_model_id?: string;
- fk_column_id?: string;
- direction?: string;
- order?: number;
- project_id?: string;
+ /**
+ * Base ID
+ * @example md_rsu68aqjsbyqtl
+ */
base_id?: string;
+ /**
+ * The heading of the form
+ * @example My Form
+ */
+ heading?: string;
+ /**
+ * Lock Type of this view
+ * @example collaborative
+ */
+ lock_type?: 'collaborative' | 'locked' | 'personal';
+ /** Logo URL. Not in use currently. */
+ logo_url?: StringOrNullType;
+ /** Meta Info for this view */
+ meta?: MetaType;
+ /** The numbers of seconds to redirect after form submission */
+ redirect_after_secs?: StringOrNullType;
+ /** URL to redirect after submission */
+ redirect_url?: StringOrNullType;
+ /** Show `Blank Form` after 5 seconds */
+ show_blank_form?: BoolType;
+ /**
+ * The subheading of the form
+ * @example My Form Subheading
+ */
+ subheading?: string;
+ /** Show `Submit Another Form` button */
+ submit_another_form?: BoolType;
+ /** Custom message after the form is successfully submitted */
+ success_msg?: StringOrNullType;
+ /**
+ * Form View Title
+ * @example Form View 1
+ */
+ title?: string;
}
-export interface SortReqType {
- fk_column_id?: string;
- direction?: string;
+/**
+ * Model for Form Request
+ */
+export interface FormReqType {
+ /** Banner Image URL. Not in use currently. */
+ banner_image_url?: StringOrNullType;
+ /** Email to sned after form is submitted */
+ email?: StringOrNullType;
+ /**
+ * The heading of the form
+ * @example My Form
+ */
+ heading?: string;
+ /**
+ * Lock Type of this view
+ * @example collaborative
+ */
+ lock_type?: 'collaborative' | 'locked' | 'personal';
+ /** Logo URL. Not in use currently. */
+ logo_url?: StringOrNullType;
+ /** Meta Info for this view */
+ meta?: MetaType;
+ /** The numbers of seconds to redirect after form submission */
+ redirect_after_secs?: StringOrNullType;
+ /** URL to redirect after submission */
+ redirect_url?: StringOrNullType;
+ /** Show `Blank Form` after 5 seconds */
+ show_blank_form?: BoolType;
+ /**
+ * The subheading of the form
+ * @example My Form Subheading
+ */
+ subheading?: string;
+ /** Show `Submit Another Form` button */
+ submit_another_form?: BoolType;
+ /** Custom message after the form is successfully submitted */
+ success_msg?: StringOrNullType;
+ /**
+ * The title of the form
+ * @example My Form
+ */
+ title?: string;
}
-export interface SortListType {
- sorts: {
- list: SharedViewType[];
- };
+/**
+ * Model for Form Column
+ */
+export interface FormColumnType {
+ /** Unique ID */
+ id?: IdType;
+ /** Form Column Description (Not in use) */
+ description?: StringOrNullType;
+ /** Foreign Key to Column */
+ fk_column_id?: IdType;
+ /** Foreign Key to View */
+ fk_view_id?: IdType;
+ /** Form Column Help Text */
+ help?: StringOrNullType;
+ /** Form Column Label */
+ label?: StringOrNullType;
+ /** Meta Info */
+ meta?: MetaType;
+ /**
+ * The order among all the columns in the form
+ * @example 1
+ */
+ order?: number;
+ /** Is this form column required in submission? */
+ required?: BoolType;
+ /** Is this column shown in Form? */
+ show?: BoolType;
+ /** Form Column UUID (Not in use) */
+ uuid?: StringOrNullType;
}
-export interface ColumnType {
- id?: string;
- base_id?: string;
- fk_model_id?: string;
+/**
+ * Model for Form Column Request
+ */
+export interface FormColumnReqType {
+ /** Form Column Description (Not in use) */
+ description?: StringOrNullType;
+ /** Form Column Help Text */
+ help?: StringOrNullType;
+ /** Form Column Label */
+ label?: StringOrNullType;
+ /** Meta Info */
+ meta?: MetaType;
+ /** The order among all the columns in the form */
+ order?: number;
+ /** Is this form column required in submission? */
+ required?: BoolType;
+ /** Is this column shown in Form? */
+ show?: BoolType;
+}
+
+/**
+ * Model for Formula
+ */
+export interface FormulaType {
+ /** Unique ID */
+ id?: IdType;
+ /** Foreign Key to Column */
+ fk_column_id?: IdType;
+ /**
+ * Formula with column ID replaced
+ * @example CONCAT("FOO", {{cl_c5knoi4xs4sfpt}})
+ */
+ formula?: string;
+ /**
+ * Original Formula inputted in UI
+ * @example CONCAT("FOO", {Title})
+ */
+ formula_raw?: string;
+ /** Error Message */
+ error?: string;
+}
+
+/**
+ * Model for Formula Column Request
+ */
+export interface FormulaColumnReqType {
+ /** Formula with column ID replaced */
+ formula?: string;
+ /** Original Formula inputted in UI */
+ formula_raw?: string;
+ /** Formula Title */
title?: string;
- uidt?: string;
- dt?: string;
- np?: string | number | null;
- ns?: string | number | null;
- clen?: string | number | null;
- cop?: string;
- pk?: BoolType;
- pv?: BoolType;
- rqd?: BoolType;
- column_name?: string;
- un?: BoolType;
- ct?: string;
- ai?: BoolType;
- unique?: BoolType;
- cdf?: string;
- cc?: string;
- csn?: string;
- dtx?: string;
- dtxp?: string | number | null;
- dtxs?: string | number | null;
- au?: BoolType;
+ /** UI Data Type */
+ uidt?: 'Formula';
+}
+
+/**
+ * Model for Gallery
+ */
+export interface GalleryType {
+ alias?: string;
+ columns?: GalleryColumnType[];
+ cover_image?: string;
+ cover_image_idx?: number;
+ /** Model for Bool */
deleted?: BoolType;
- visible?: BoolType;
+ /** Foreign Key to Cover Image Column */
+ fk_cover_image_col_id?: string;
+ /** Foreign Key to Model */
+ fk_model_id?: string;
+ /** Foreign Key to View */
+ fk_view_id?: string;
+ lock_type?: 'collaborative' | 'locked' | 'personal';
+ /** Model for Bool */
+ next_enabled?: BoolType;
+ /** Order of Gallery */
order?: number;
- system?: BoolType;
+ /** Model for Bool */
+ prev_enabled?: BoolType;
+ restrict_number?: string;
+ restrict_size?: string;
+ restrict_types?: string;
+ title?: string;
+}
+
+/**
+ * Model for Gallery Column
+ */
+export interface GalleryColumnType {
+ fk_col_id?: string;
+ fk_gallery_id?: string;
+ help?: string;
+ /** Unique ID */
+ id?: IdType;
+ label?: string;
+}
+
+/**
+ * Model for Gallery Request
+ */
+export interface GalleryReqType {
+ cover_image?: string;
+ /** @min 0 */
+ cover_image_idx?: number;
+ /** The id of the column that contains the cover image */
+ fk_cover_image_col_id?: string;
+ /** The lock type of gallery */
+ lock_type?: 'collaborative' | 'locked' | 'personal';
+ /** Model for Bool */
+ next_enabled?: BoolType;
+ /** Model for Bool */
+ prev_enabled?: BoolType;
+ restrict_number?: string;
+ restrict_size?: string;
+ restrict_types?: string;
+ /**
+ * The title of the gallery
+ * @example My Gallery
+ */
+ title: string;
+}
+
+/**
+ * Model for Geo Location
+ */
+export interface GeoLocationType {
+ /**
+ * The latitude of the location
+ * @format double
+ * @example 18.52139
+ */
+ latitude?: number;
+ /**
+ * The longitude of the location
+ * @format double
+ * @example 179.87295
+ */
+ longitude?: number;
+}
+
+/**
+ * Model for Grid
+ */
+export interface GridType {
+ /** Unique ID */
+ id?: IdType;
+ /** Project ID */
+ project_id?: IdType;
+ /** Base ID */
+ base_id?: IdType;
+ /** Foreign Key to View */
+ fk_view_id?: IdType;
+ /**
+ * Row Height
+ * @example 1
+ */
+ row_height?: number;
+ /** Meta info for Grid Model */
meta?: MetaType;
- colOptions?:
- | LinkToAnotherRecordType
- | FormulaType
- | RollupType
- | LookupType
- | SelectOptionsType
- | object
- | (LinkToAnotherRecordType &
- FormulaType &
- RollupType &
- LookupType &
- SelectOptionsType &
- object);
+ /** Grid View Columns */
+ columns?: GridColumnType[];
}
-export interface ColumnListType {
- columns: {
- list: ColumnType[];
- };
+/**
+ * Model for Grid Column
+ */
+export interface GridColumnType {
+ /** Unique ID */
+ id?: IdType;
+ /** Foreign Key to View */
+ fk_view_id?: IdType;
+ /** Foreign Key to Column */
+ fk_column_id?: IdType;
+ /** Project ID */
+ project_id?: IdType;
+ /** Base ID */
+ base_id?: IdType;
+ /** Model for Bool */
+ show?: BoolType;
+ /**
+ * Grid Column Order
+ * @example 1
+ */
+ order?: number;
+ /**
+ * Column Width
+ * @example 200px
+ */
+ width?: string;
+ /** Column Help Text */
+ help?: StringOrNullType;
}
-export interface LinkToAnotherRecordType {
- id?: string;
- type?: string;
- virtual?: BoolType;
- fk_column_id?: string;
- fk_child_column_id?: string;
- fk_parent_column_id?: string;
- fk_mm_model_id?: string;
- fk_related_model_id?: string;
- fk_mm_child_column_id?: string;
- fk_mm_parent_column_id?: string;
- ur?: string;
- dr?: string;
- fk_index_name?: string;
- deleted?: string;
- order?: string;
+/**
+ * Model for Grid Column Request
+ */
+export interface GridColumnReqType {
+ /** Foreign Key to Column */
+ fk_column_id?: IdType;
+ help?: string;
+ /**
+ * The label of the column
+ * @example My Column
+ */
+ label?: string;
+ /**
+ * The width of the column
+ * @pattern ^[0-9]+(px|%)$
+ * @example 200px
+ */
+ width?: string;
+}
+
+/**
+ * Model for Grid Request
+ */
+export interface GridReqType {
+ /** The lock type of the grid */
+ lock_type?: 'collaborative' | 'locked' | 'personal';
+ /**
+ * The order of the grid
+ * @example 1
+ */
+ order?: number;
+ /**
+ * The height of the grid rows
+ * @min 1
+ * @example 1
+ */
+ row_height?: number;
+ /**
+ * The title of the grid
+ * @example My Grid
+ */
+ title: string;
+}
+
+/**
+ * Model for Hook
+ */
+export interface HookType {
+ /** Is the hook active? */
+ active?: BoolType;
+ /** Is the hook aysnc? */
+ async?: BoolType;
+ /**
+ * Hook Description
+ * @example This is my hook description
+ */
+ description?: string;
+ /**
+ * Environment for the hook
+ * @example all
+ */
+ env?: string;
+ /**
+ * Event Type for the operation
+ * @example after
+ */
+ event?: 'after' | 'before';
+ /**
+ * Foreign Key to Model
+ * @example md_rsu68aqjsbyqtl
+ */
+ fk_model_id?: string;
+ /** Unique ID */
+ id?: IdType;
+ /** Hook Notification including info such as type, payload, method, body, and etc */
+ notification?: object | string;
+ /**
+ * Hook Operation
+ * @example insert
+ */
+ operation?: 'delete' | 'insert' | 'update';
+ /**
+ * Retry Count
+ * @example 10
+ */
+ retries?: number;
+ /**
+ * Retry Interval
+ * @example 60000
+ */
+ retry_interval?: number;
+ /**
+ * Timeout
+ * @example 60000
+ */
+ timeout?: number;
+ /**
+ * Hook Title
+ * @example My Webhook
+ */
+ title?: string;
+ /** Hook Type */
+ type?: string;
}
-export interface LookupType {
- id?: string;
- type?: string;
- virtual?: BoolType;
- fk_column_id?: string;
- fk_relation_column_id?: string;
- fk_lookup_column_id?: string;
- deleted?: string;
- order?: string;
+/**
+ * Model for Hook
+ */
+export interface HookReqType {
+ /** Is the hook active? */
+ active?: BoolType;
+ /** Is the hook aysnc? */
+ async?: BoolType;
+ /** Hook Description */
+ description?: StringOrNullType;
+ /**
+ * Environment for the hook
+ * @example all
+ */
+ env?: string;
+ /**
+ * Event Type for the operation
+ * @example after
+ */
+ event: 'after' | 'before';
+ /**
+ * Foreign Key to Model
+ * @example md_rsu68aqjsbyqtl
+ */
+ fk_model_id?: string;
+ /** Unique ID */
+ id?: IdType;
+ /** Hook Notification including info such as type, payload, method, body, and etc */
+ notification: object | string;
+ /**
+ * Hook Operation
+ * @example insert
+ */
+ operation: 'delete' | 'insert' | 'update';
+ /**
+ * Retry Count
+ * @example 10
+ */
+ retries?: number;
+ /**
+ * Retry Interval
+ * @example 60000
+ */
+ retry_interval?: number;
+ /**
+ * Timeout
+ * @example 60000
+ */
+ timeout?: number;
+ /**
+ * Hook Title
+ * @example My Webhook
+ */
+ title: string;
+ /** Hook Type */
+ type?: string | null;
}
-export interface RollupType {
- id?: string;
- type?: string;
- virtual?: BoolType;
- fk_column_id?: string;
- fk_relation_column_id?: string;
- fk_rollup_column_id?: string;
- rollup_function?: string;
- deleted?: string;
- order?: string;
+/**
+ * Model for Hook List
+ */
+export interface HookListType {
+ list?: HookType[];
+ /** Model for Paginated */
+ pageInfo?: PaginatedType;
}
-export interface FormulaType {
- id?: string;
+/**
+ * Model for Hook Log
+ */
+export interface HookLogType {
+ base_id?: string;
+ conditions?: string;
+ error?: string;
+ error_code?: string;
+ error_message?: string;
+ event?: string;
+ execution_time?: string;
+ /** Model for StringOrNull */
+ fk_hook_id?: StringOrNullType;
+ /** Unique ID */
+ id?: IdType;
+ notifications?: string;
+ operation?: string;
+ payload?: any;
+ project_id?: string;
+ response?: string;
+ /** Model for Bool */
+ test_call?: BoolType;
+ triggered_by?: string;
type?: string;
- virtual?: BoolType;
- fk_column_id?: string;
- formula?: string;
- formula_raw?: string;
- deleted?: string;
- order?: string;
}
-export interface SelectOptionsType {
- options: SelectOptionType[];
+/**
+ * Model for Hook Test Request
+ */
+export interface HookTestReqType {
+ /** Model for Hook */
+ hook: HookReqType;
+ /** Payload to be sent */
+ payload: any;
}
-export interface SelectOptionType {
- id?: string;
- fk_column_id?: string;
- title?: string;
- color?: string;
- order?: number;
-}
+/**
+ * Model for ID
+ */
+export type IdType = string;
-export interface GridType {
- id?: string;
+/**
+ * Model for Kanban
+ */
+export interface KanbanType {
+ /** Unique ID */
+ id?: IdType;
+ /** Grouping Field Column ID */
+ fk_grp_col_id?: StringOrNullType;
+ /** View ID */
+ fk_view_id?: IdType;
+ /** Cover Image Column ID */
+ fk_cover_image_col_id?: IdType;
+ /** Kanban Columns */
+ columns?: KanbanColumnType[];
+ /** Meta Info for Kanban */
+ meta?: MetaType;
+ /**
+ * Kanban Title
+ * @example My Kanban
+ */
title?: string;
- alias?: string;
- deleted?: BoolType;
- order?: number;
- lock_type?: 'collaborative' | 'locked' | 'personal';
- row_height?: number;
-}
-
-export interface GridReqType {
- title: string;
- order?: number;
- lock_type?: 'collaborative' | 'locked' | 'personal';
- row_height?: number;
}
-export interface GalleryType {
- fk_view_id?: string;
+/**
+ * Model for Kanban Column
+ */
+export interface KanbanColumnType {
+ /** Unique ID */
+ id?: IdType;
+ /** Foreign Key to Column */
+ fk_column_id?: IdType;
+ /** Foreign Key to View */
+ fk_view_id?: IdType;
+ /**
+ * Baes ID
+ *
+ */
+ base_id?: IdType;
+ /** Project ID */
+ project_id?: IdType;
+ /** Project ID */
title?: string;
- alias?: string;
- deleted?: BoolType;
+ /** Is this column shown? */
+ show?: BoolType;
+ /**
+ * Column Order
+ * @example 1
+ */
order?: number;
- next_enabled?: BoolType;
- prev_enabled?: BoolType;
- cover_image_idx?: number;
- cover_image?: string;
- restrict_types?: string;
- restrict_size?: string;
- restrict_number?: string;
- columns?: GalleryColumnType[];
- fk_model_id?: string;
- fk_cover_image_col_id?: string;
- lock_type?: 'collaborative' | 'locked' | 'personal';
}
-export interface GalleryReqType {
+/**
+ * Model for Kanban Request
+ */
+export interface KanbanReqType {
+ /** Grouping Column ID */
+ fk_grp_col_id?: StringOrNullType;
+ /**
+ * The title of the kanban
+ * @example My Kanban
+ */
title: string;
- next_enabled?: BoolType;
- prev_enabled?: BoolType;
- cover_image_idx?: number;
- cover_image?: string;
- restrict_types?: string;
- restrict_size?: string;
- restrict_number?: string;
- fk_cover_image_col_id?: string;
- lock_type?: 'collaborative' | 'locked' | 'personal';
}
-export interface GalleryColumnType {
- id?: string;
- label?: string;
- help?: string;
- fk_col_id?: string;
- fk_gallery_id?: string;
+/**
+ * Model for Kanban Update Request
+ */
+export interface KanbanUpdateReqType {
+ /** Model for StringOrNull */
+ fk_grp_col_id?: StringOrNullType;
}
-export interface GridColumnReqType {
- label?: string;
- help?: string;
- fk_column_id?: string;
- fk_gallery_id?: string;
- width?: string;
+/**
+ * Model for Kanban Request
+ */
+export interface LicenseReqType {
+ /**
+ * The license key
+ * @example 1234567890
+ */
+ key?: string;
}
-export interface GridColumnType {
- id?: string;
- label?: string;
- help?: string;
- fk_column_id?: string;
- fk_gallery_id?: string;
- width?: string;
+/**
+ * Model for LinkToAnotherColumn Request
+ */
+export interface LinkToAnotherColumnReqType {
+ /** Foreign Key to chhild column */
+ childId: IdType;
+ /** Foreign Key to parent column */
+ parentId: IdType;
+ /** The title of the virtual column */
+ title: string;
+ /** The type of the relationship */
+ type: 'bt' | 'hm' | 'mm';
+ /** Abstract type of the relationship */
+ uidt: 'LinkToAnotherRecord';
+ /** Is this relationship virtual? */
+ virtual?: BoolType;
}
-export interface KanbanColumnType {
- id?: string;
- label?: string;
- help?: string;
- fk_column_id?: string;
- fk_kanban_id?: string;
+/**
+ * Model for LinkToAnotherRecord
+ */
+export interface LinkToAnotherRecordType {
+ deleted?: string;
+ dr?: string;
+ fk_child_column_id?: string;
+ /** Foreign Key to Column */
+ fk_column_id?: IdType;
+ fk_index_name?: string;
+ fk_mm_child_column_id?: string;
+ fk_mm_model_id?: string;
+ fk_mm_parent_column_id?: string;
+ fk_parent_column_id?: string;
+ fk_related_model_id?: string;
+ /** Unique ID */
+ id?: IdType;
+ order?: string;
+ type?: string;
+ ur?: string;
+ /** Model for Bool */
+ virtual?: BoolType;
}
-export interface KanbanType {
- id?: string;
- title?: string;
- alias?: string;
- columns?: KanbanColumnType[];
- fk_model_id?: string;
- fk_grp_col_id?: StringOrNullType;
- fk_cover_image_col_id?: string;
- meta?: MetaType;
+/**
+ * Model for Lookup
+ */
+export interface LookupType {
+ /** Unique ID */
+ id?: IdType;
+ /** Foreign Key to Column */
+ fk_column_id?: IdType;
+ /** Foreign Key to Lookup Column */
+ fk_lookup_column_id?: IdType;
+ /** Foreign Key to Relation Column */
+ fk_relation_column_id?: IdType;
+ /**
+ * The order among the list
+ * @example 1
+ */
+ order?: number;
}
-export interface GeoLocationType {
- /** @format double */
- latitude?: number;
- /** @format double */
- longitude?: number;
+/**
+ * Model for Lookup Column Request
+ */
+export interface LookupColumnReqType {
+ /** Foreign Key to Lookup Column */
+ fk_lookup_column_id?: IdType;
+ /** Foreign Key to Relation Column */
+ fk_relation_column_id?: IdType;
+ /**
+ * Lookup Title
+ * @example My Lookup
+ */
+ title?: string;
+ /** UI DataType */
+ uidt?: 'Lookup';
}
+/**
+ * Model for Map
+ */
export interface MapType {
- id?: string;
- title?: string;
- alias?: string;
- initial_geo_position?: GeoLocationType;
- fk_model_id?: string;
+ /**
+ * The ID of the base that this view belongs to
+ * @example ds_g4ccx6e77h1dmi
+ */
+ base_id?: string;
+ /** Columns in this view */
+ columns?: MapColumnType[];
+ /**
+ * Foreign Key to GeoData Column
+ * @example cl_8iw2o4ejzvdyna
+ */
+ fk_geo_data_col_id?: string;
+ /**
+ * Unique ID for Map
+ * @example vw_qjt7klod1p9kyv
+ */
fk_view_id?: string;
- fk_geo_data_col_id?: StringOrNullType;
- columns?: MapColumnType[];
+ /** Meta data for this view */
meta?: MetaType;
+ /** The order of the map list */
+ order?: number;
+ /**
+ * The ID of the project that this view belongs to
+ * @example p_xm3thidrblw4n7
+ */
+ project_id?: string;
+ /** To show this Map or not */
+ show?: boolean;
+ /**
+ * Title of Map View
+ * @example My Map
+ */
+ title?: string;
}
+/**
+ * Model for Map Column
+ */
export interface MapColumnType {
+ /**
+ * The ID of the base that this map column belongs to
+ * @example ds_g4ccx6e77h1dmi
+ */
+ base_id?: string;
+ /**
+ * Foreign Key to Column
+ * @example cl_8iw2o4ejzvdyna
+ */
+ fk_column_id?: string;
+ /**
+ * Foreign Key to View
+ * @example vw_qjt7klod1p9kyv
+ */
+ fk_view_id?: string;
+ /**
+ * Unique ID of Map Column
+ * @example nc_46xcacqn4rc9xf
+ */
id?: string;
- label?: string;
- help?: string;
- fk_col_id?: string;
- fk_gallery_id?: string;
-}
-
-export interface LicenseReqType {
- key?: string;
-}
-
-export interface KanbanReqType {
- title: string;
- fk_grp_col_id?: StringOrNullType;
+ /**
+ * the order in the list of map columns
+ * @example 1
+ */
+ order?: number;
+ /**
+ * The ID of the project that this map column belongs to
+ * @example p_xm3thidrblw4n7
+ */
+ project_id?: string;
+ /**
+ * Whether to show this column or not
+ * @example 1
+ */
+ show?: number;
}
-export interface KanbanUpdateReqType {
- fk_grp_col_id?: StringOrNullType;
-}
+/**
+ * Model for Meta
+ */
+export type MetaType = null | object | string;
-export interface FormType {
- id?: string;
- title?: string;
- heading?: string;
- subheading?: string;
- success_msg?: string;
- redirect_url?: StringOrNullType;
- redirect_after_secs?: StringOrNullType;
- email?: StringOrNullType;
- banner_image_url?: StringOrNullType;
- logo_url?: StringOrNullType;
- submit_another_form?: BoolType;
- show_blank_form?: BoolType;
- columns?: FormColumnType[];
+/**
+ * Model for ModelRoleVisibility
+ */
+export interface ModelRoleVisibilityType {
+ base_id?: string;
+ /** Model for Bool */
+ disabled?: BoolType;
fk_model_id?: string;
- lock_type?: 'collaborative' | 'locked' | 'personal';
- meta?: MetaType;
+ fk_view_id?: string;
+ /** Unique ID */
+ id?: IdType;
+ project_id?: string;
+ role?: string;
}
-export interface FormReqType {
+/**
+ * Model for Normal Column Request
+ */
+export interface NormalColumnRequestType {
+ /** Is this column auto-incremented? */
+ ai?: BoolType;
+ /** Is this column auto-updated datetime field? */
+ au?: BoolType;
+ /** Column Comment */
+ cc?: StringOrNullType;
+ /** Column Default Value */
+ cdf?: StringOrNullType;
+ /** Column Name */
+ column_name: string;
+ /** Model for StringOrNull */
+ csn?: StringOrNullType;
+ /** Data Type */
+ dt?: string;
+ /** Data Type Extra */
+ dtx?: StringOrNullType;
+ /** Data Type Extra Precision */
+ dtxp?: StringOrNullType | number;
+ /** Data Type Extra Scale */
+ dtxs?: StringOrNullType | number;
+ /** Numeric Precision */
+ np?: StringOrNullType | number;
+ /** Numeric Scale */
+ ns?: StringOrNullType | number;
+ /** Is this column a primary key? */
+ pk?: BoolType;
+ /** Is this column a primary value? */
+ pv?: BoolType;
+ /** Is this column required? */
+ rqd?: BoolType;
+ /** Column Title */
title?: string;
- heading?: string;
- subheading?: string;
- success_msg?: string;
- redirect_url?: StringOrNullType;
- redirect_after_secs?: StringOrNullType;
- email?: StringOrNullType;
- banner_image_url?: StringOrNullType;
- logo_url?: StringOrNullType;
- submit_another_form?: BoolType;
- show_blank_form?: BoolType;
- lock_type?: 'collaborative' | 'locked' | 'personal';
- meta?: MetaType;
-}
-
-export type FormCreateReqType = FormReqType;
-
-export interface FormColumnType {
- fk_column_id?: string;
- id?: string;
- fk_view_id?: string;
- uuid?: any;
- label?: string;
- help?: any;
- required?: BoolType;
- show?: BoolType;
- order?: number;
- created_at?: string;
- updated_at?: string;
- description?: string;
- meta?: MetaType;
+ /** UI Data Type */
+ uidt?:
+ | 'Attachment'
+ | 'AutoNumber'
+ | 'Barcode'
+ | 'Button'
+ | 'Checkbox'
+ | 'Collaborator'
+ | 'Count'
+ | 'CreateTime'
+ | 'Currency'
+ | 'Date'
+ | 'DateTime'
+ | 'Decimal'
+ | 'Duration'
+ | 'Email'
+ | 'Formula'
+ | 'ForeignKey'
+ | 'GeoData'
+ | 'Geometry'
+ | 'ID'
+ | 'JSON'
+ | 'LastModifiedTime'
+ | 'LongText'
+ | 'LinkToAnotherRecord'
+ | 'Lookup'
+ | 'MultiSelect'
+ | 'Number'
+ | 'Percent'
+ | 'PhoneNumber'
+ | 'Rating'
+ | 'Rollup'
+ | 'SingleLineText'
+ | 'SingleSelect'
+ | 'SpecificDBType'
+ | 'Time'
+ | 'URL'
+ | 'Year'
+ | 'QrCode';
+ /** Is this column unique? */
+ un?: BoolType;
+ /** Is this column unique? */
+ unique?: BoolType;
}
-export interface FormColumnReqType {
- uuid?: any;
- label?: string;
- help?: any;
- required?: BoolType;
- show?: BoolType;
- order?: number;
- description?: string;
- meta?: MetaType;
+/**
+ * Model for Organisation User Update Request
+ */
+export interface OrgUserReqType {
+ /** @format email */
+ email?: string;
+ /** Roles for the project user */
+ roles?: 'org-level-creator' | 'org-level-viewer';
}
+/**
+ * Model for Paginated
+ */
export interface PaginatedType {
- pageSize?: number;
- totalRows?: number;
- sort?: string | SortType[];
+ /** Is the current page the first page */
isFirstPage?: boolean;
+ /** Is the current page the last page */
isLastPage?: boolean;
+ /**
+ * The current page
+ * @example 1
+ */
page?: number;
+ /**
+ * The number of pages
+ * @example 10
+ */
+ pageSize?: number;
+ /**
+ * The number of rows in the given result
+ * @example 1
+ */
+ totalRows?: number;
}
-export interface HookListType {
- list?: object[];
- pageInfo?: PaginatedType;
-}
+/**
+ * Model for Password
+ * @example password123456789
+ */
+export type PasswordType = string;
-export interface SharedViewType {
- id?: string;
- fk_view_id?: string;
- password?: string;
- deleted?: string;
+/**
+ * Model for Password Change Request
+ */
+export interface PasswordChangeReqType {
+ currentPassword: string;
+ newPassword: string;
}
-export interface SharedViewListType {
- list?: SharedViewType[];
- pageInfo?: PaginatedType;
+/**
+ * Model for Password Forgot Request
+ */
+export interface PasswordForgotReqType {
+ /**
+ * Email address of the user
+ * @format email
+ */
+ email: string;
}
-export interface ViewListType {
- list?: ViewType[];
- pageInfo?: PaginatedType;
+/**
+ * Model for Password Reset Request
+ */
+export interface PasswordResetReqType {
+ /**
+ * New password
+ * @example newpassword
+ */
+ password: string;
}
-export interface AttachmentType {
- url?: string;
- title?: string;
- mimetype?: string;
- size?: string;
+/**
+ * Model for Plugin
+ */
+export interface PluginType {
+ /** Is plguin active? */
+ active?: BoolType;
+ /**
+ * Plugin Category
+ * @example Storage
+ */
+ category?: string;
+ /** Plugin Creator (Not in use) */
+ creator?: string;
+ /** Plugin Creator website (Not in use) */
+ creator_website?: string;
+ /**
+ * Plugin Description
+ * @example Amazon Simple Storage Service (Amazon S3) is an object storage service that offers industry-leading scalability, data availability, security, and performance.
+ */
+ description?: string;
+ /** Documentation of plugin (Not in use) */
+ docs?: string;
+ /** Plugin Icon (Not in use) */
icon?: string;
- path?: string;
- data?: any;
+ /** Unique ID */
+ id?: IdType;
+ /** Plugin Input */
+ input?: StringOrNullType | number;
+ /**
+ * Plugin Input Schema
+ *
+ */
+ input_schema?: string;
+ /**
+ * Plugin logo
+ * @example plugins/s3.png
+ */
+ logo?: string;
+ /** Plugin Price (Not in use) */
+ price?: string;
+ /** Plugin Rating (Not in use) */
+ rating?: number;
+ /**
+ * Plugin Status
+ * @example install
+ */
+ status?: string;
+ /** Not in use */
+ status_details?: string;
+ /**
+ * Plugin tags
+ * @example Storage
+ */
+ tags?: string;
+ /** Plugin Title */
+ title?: string;
+ /**
+ * Plugin Version
+ * @example 0.0.1
+ */
+ version?: string;
+}
+
+/**
+ * Model for Plugin Request
+ */
+export interface PluginReqType {
+ /** Is Plugin Active? */
+ active?: BoolType;
+ /** Plugin Input */
+ input?: string;
+}
+
+/**
+ * Model for Plugin Test Request
+ */
+export interface PluginTestReqType {
+ /** Plugin Title */
+ title: string;
+ /** Plugin Input as JSON string */
+ input: string;
}
-export interface WebhookType {
+/**
+ * Model for Project
+ */
+export interface ProjectType {
+ /** List of base models */
+ bases?: BaseType[];
+ /**
+ * Primary Theme Color
+ * @example #24716E
+ */
+ color?: string;
+ /** Is the project deleted */
+ deleted?: BoolType;
+ /**
+ * Project Description
+ * @example This is my project description
+ */
+ description?: string;
+ /**
+ * Unique Project ID
+ * @example p_124hhlkbeasewh
+ */
id?: string;
+ /** Model for Bool */
+ is_meta?: BoolType;
+ /** Meta Info such as theme colors */
+ meta?: MetaType;
+ /** The order in project list */
+ order?: number;
+ /**
+ * Project prefix. Used in XCDB only.
+ * @example nc_vm5q__
+ */
+ prefix?: string;
+ status?: string;
+ /**
+ * Project Title
+ * @example my-project
+ */
title?: string;
- type?: string;
}
-export interface AuditType {
- id?: string;
- user?: string;
- ip?: string;
- base_id?: string;
- project_id?: string;
- fk_model_id?: string;
- row_id?: string;
- op_type?: string;
- op_sub_type?: string;
- status?: string;
- description?: string;
- details?: string;
+/**
+ * Model for Project List
+ */
+export interface ProjectListType {
+ /** List of Project Models */
+ list?: ProjectType[];
+ /** Pagination Info */
+ pageInfo?: PaginatedType;
}
-export interface HookType {
- id?: string;
- fk_model_id?: string;
- title?: string;
+/**
+ * Model for Project Request
+ */
+export interface ProjectReqType {
+ /** Array of Bases */
+ bases?: BaseReqType[];
+ /**
+ * Primary Theme Color
+ * @example #24716E
+ */
+ color?: string;
+ /**
+ * Project Description
+ * @example This is my project description
+ */
description?: string;
- env?: string;
- type?: string;
- event?: 'after' | 'before';
- operation?: 'insert' | 'delete' | 'update';
- async?: BoolType;
- notification?: string;
- retries?: number;
- retry_interval?: number;
- timeout?: number;
- active?: BoolType;
-}
-
-export interface HookReqType {
- id?: string;
- fk_model_id?: string;
+ /**
+ * Project Title
+ * @example My Project
+ */
title: string;
- description?: StringOrNullType;
- env?: string;
- event: 'after' | 'before';
- operation: 'insert' | 'delete' | 'update';
- async?: string | number | null;
- notification: object;
- retries?: number;
- retry_interval?: number;
- timeout?: number;
- active?: BoolType;
}
-export interface HookTestReqType {
- payload: any;
- hook: HookReqType;
+/**
+ * Model for Project User Request
+ */
+export interface ProjectUserReqType {
+ /**
+ * Project User Email
+ * @format email
+ */
+ email: string;
+ /** Project User Role */
+ roles: 'commenter' | 'editor' | 'guest' | 'owner' | 'viewer' | 'creator';
}
-export interface SignUpReqType {
- email: string;
- password: string;
+/**
+ * Model for Rollup
+ */
+export interface RollupType {
+ /** Unique ID */
+ id?: IdType;
+ /** Foreign Key to Column */
+ fk_column_id?: IdType;
+ /** Foreign to Relation Column */
+ fk_relation_column_id?: IdType;
+ /** Foreign to Rollup Column */
+ fk_rollup_column_id?: IdType;
+ /**
+ * Rollup Function
+ * @example count
+ */
+ rollup_function?:
+ | 'count'
+ | 'min'
+ | 'max'
+ | 'avg'
+ | 'countDistinct'
+ | 'sumDistinct'
+ | 'avgDistinct';
}
-export interface SignInReqType {
- email: string;
- password: string;
+/**
+ * Model for Rollup Column Request
+ */
+export interface RollupColumnReqType {
+ /** Foreign Key to Relation Column */
+ fk_relation_column_id?: IdType;
+ /** Foreign Key to Rollup Column */
+ fk_rollup_column_id?: IdType;
+ /** Rollup Column Title */
+ title?: string;
+ /** Rollup Function */
+ rollup_function?:
+ | 'avg'
+ | 'avgDistinct'
+ | 'count'
+ | 'countDistinct'
+ | 'max'
+ | 'min'
+ | 'sum'
+ | 'sumDistinct';
+ /** UI DataType */
+ uidt?: 'Rollup';
}
-export interface PasswordForgotReqType {
- email: string;
+/**
+ * Model for SelectOption
+ */
+export interface SelectOptionType {
+ /** Unique ID */
+ id?: IdType;
+ /**
+ * Option Title
+ *
+ * @example Option A
+ */
+ title?: string;
+ /** Foreign Key to Column */
+ fk_column_id?: IdType;
+ /**
+ * Option Color
+ * @example #cfdffe
+ */
+ color?: string;
+ /**
+ * The order among the options
+ * @example 1
+ */
+ order?: number;
}
-export interface PasswordResetReqType {
- password: string;
+/**
+ * Model for SelectOptions
+ */
+export interface SelectOptionsType {
+ /** Array of select options */
+ options: SelectOptionType[];
}
-export interface PasswordChangeReqType {
- currentPassword: string;
- newPassword: string;
+/**
+ * Model for Shared Base Request
+ */
+export interface SharedBaseReqType {
+ /**
+ * Password to protect the base
+ * @example password123
+ */
+ password?: string;
+ /**
+ * The role given the target user
+ * @example editor
+ */
+ roles?: 'commenter' | 'editor' | 'viewer';
}
-export interface ApiTokenReqType {
- description?: StringOrNullType;
+/**
+ * Model for Shared View
+ */
+export type SharedViewType = ViewType;
+
+/**
+ * Model for Shared View List
+ */
+export interface SharedViewListType {
+ list?: SharedViewType[];
+ /** Model for Paginated */
+ pageInfo?: PaginatedType;
}
-export interface PluginType {
- id?: string;
- title?: string;
- description?: string;
- active?: BoolType;
- rating?: number;
- version?: string;
- docs?: string;
- status?: string;
- status_details?: string;
- logo?: string;
- icon?: string;
- tags?: string;
- category?: string;
- input_schema?: string;
- input?: number | StringOrNullType;
- creator?: string;
- creator_website?: string;
- price?: string;
+/**
+ * Model for Shared View Request
+ */
+export interface SharedViewReqType {
+ /** Meta data passing to Shared View such as if download is allowed or not. */
+ meta?: MetaType;
+ /** Password to restrict access */
+ password?: StringOrNullType;
}
-export interface ModelRoleVisibilityType {
- id?: string;
- project_id?: string;
- base_id?: string;
- fk_model_id?: string;
- fk_view_id?: string;
- role?: string;
- disabled?: BoolType;
+/**
+ * Model for Signin Request
+ */
+export interface SignInReqType {
+ /**
+ * Email address of the user
+ * @format email
+ */
+ email: string;
+ /** Password of the user */
+ password: string;
}
-export interface ApiTokenType {
- id?: string;
- token?: string;
- description?: string;
- fk_user_id?: string;
- created_at?: any;
- updated_at?: any;
+/**
+ * Model for Signup Request
+ */
+export interface SignUpReqType {
+ /**
+ * Email address of the user
+ * @format email
+ * @example user@example.com
+ */
+ email: string;
+ /**
+ * Password of the user
+ * @example password123456789
+ */
+ password: string;
+ /** Model for StringOrNull */
+ firstname?: StringOrNullType;
+ /** Model for StringOrNull */
+ lastname?: StringOrNullType;
+ /** Sign Up Token. Used for invitation. */
+ token?: StringOrNullType;
+ /** Ignore Subscription */
+ ignore_subscribe?: BoolType;
}
-export interface HookLogType {
- id?: string;
+/**
+ * Model for Sort
+ */
+export interface SortType {
+ /** Unique ID */
+ id?: IdType;
+ /** Model for ID */
+ fk_column_id?: IdType;
+ /** Model for ID */
+ fk_model_id?: IdType;
+ /**
+ * Base ID
+ * @example ds_3l9qx8xqksenrl
+ */
base_id?: string;
+ /**
+ * Sort direction
+ * @example desc
+ */
+ direction?: 'asc' | 'desc';
+ /** @example 1 */
+ order?: number;
+ /**
+ * Project ID
+ * @example p_9sx43moxhqtjm3
+ */
project_id?: string;
- fk_hook_id?: StringOrNullType;
- type?: string;
- event?: string;
- operation?: string;
- test_call?: BoolType;
- payload?: any;
- conditions?: string;
- notifications?: string;
- error_code?: string;
- error_message?: string;
- error?: string;
- execution_time?: string;
- response?: string;
- triggered_by?: string;
- created_at?: string;
- updated_at?: string;
}
-export interface NormalColumnRequestType {
- uidt?:
- | 'ID'
- | 'SingleLineText'
- | 'LongText'
- | 'Attachment'
- | 'Checkbox'
- | 'MultiSelect'
- | 'SingleSelect'
- | 'Collaborator'
- | 'Date'
- | 'Year'
- | 'GeoData'
- | 'Time'
- | 'PhoneNumber'
- | 'Email'
- | 'URL'
- | 'Number'
- | 'Decimal'
- | 'Currency'
- | 'Percent'
- | 'Duration'
- | 'Rating'
- | 'Count'
- | 'DateTime'
- | 'CreateTime'
- | 'LastModifiedTime'
- | 'AutoNumber'
- | 'Geometry'
- | 'JSON'
- | 'SpecificDBType'
- | 'Barcode'
- | 'Button';
- id?: string;
- base_id?: string;
- fk_model_id?: string;
- title?: string;
- dt?: string;
- np?: number | StringOrNullType;
- ns?: number | StringOrNullType;
- pk?: BoolType;
- pv?: BoolType;
- rqd?: BoolType;
- column_name?: string;
- un?: BoolType;
- ct?: string;
- ai?: BoolType;
- unique?: BoolType;
- cdf?: StringOrNullType;
- cc?: string;
- csn?: string;
- dtx?: string;
- dtxp?: number | StringOrNullType;
- dtxs?: number | StringOrNullType;
- au?: BoolType;
+/**
+ * Model for Sort List
+ */
+export interface SortListType {
+ sorts: {
+ list: SortType[];
+ };
}
-export interface LinkToAnotherColumnReqType {
- uidt: 'LinkToAnotherRecord';
- title: string;
- virtual?: BoolType;
- parentId: string;
- childId: string;
- type: 'hm' | 'bt' | 'mm';
+/**
+ * Model for Sort Request
+ */
+export interface SortReqType {
+ /** Foreign Key to Column */
+ fk_column_id?: IdType;
+ /** Sort direction */
+ direction?: 'asc' | 'desc';
}
-export interface RollupColumnReqType {
- uidt?: 'Rollup';
- title?: string;
- fk_relation_column_id?: string;
- fk_rollup_column_id?: string;
- rollup_function?: string;
+/**
+ * Model for StringOrNull
+ */
+export type StringOrNullType = string | null;
+
+/**
+ * Model for Table
+ */
+export interface TableType {
+ /** Unique Base ID */
+ base_id?: string;
+ /** The columns included in this table */
+ columns?: ColumnType[];
+ /** Column Models grouped by IDs */
+ columnsById?: object;
+ /** Model for Bool */
+ deleted?: BoolType;
+ /** Is this table enabled? */
+ enabled?: BoolType;
+ /** Unique Table ID */
+ id?: string;
+ /** Meta Data */
+ meta?: MetaType;
+ /** Is this table used for M2M */
+ mm?: BoolType;
+ /** The order of the list of tables */
+ order?: number;
+ /** Currently not in use */
+ pinned?: BoolType;
+ /** Unique Project ID */
+ project_id?: string;
+ /** Table Name. Prefix will be added for XCDB projects. */
+ table_name: string;
+ /** Currently not in use */
+ tags?: StringOrNullType;
+ /** Table Title */
+ title: string;
+ /** Table Type */
+ type?: string;
}
-export interface LookupColumnReqType {
- uidt?: 'Lookup';
- title?: string;
- fk_relation_column_id?: string;
- fk_lookup_column_id?: string;
+/**
+ * Model for Table List
+ */
+export interface TableListType {
+ list?: TableType[];
+ /** Model for Paginated */
+ pageInfo?: PaginatedType;
}
-export interface FormulaColumnReqType {
- uidt?: string;
- formula_raw?: string;
- formula?: string;
+/**
+ * Model for Table Request
+ */
+export interface TableReqType {
+ /** The column models in this table */
+ columns: NormalColumnRequestType[];
+ /** the meta data for this table */
+ meta?: MetaType;
+ /**
+ * The order of table list
+ * @example 1
+ */
+ order?: number;
+ /**
+ * Table name
+ * @example my_table
+ */
+ table_name: string;
+ /**
+ * Table title
+ * @example My Table
+ */
title?: string;
}
-export type ColumnReqType = (
- | LinkToAnotherColumnReqType
- | RollupColumnReqType
- | FormulaColumnReqType
- | LookupColumnReqType
- | NormalColumnRequestType
- | (LinkToAnotherColumnReqType &
- RollupColumnReqType &
- FormulaColumnReqType &
- LookupColumnReqType &
- NormalColumnRequestType)
-) & {
- column_name?: string;
- title?: string;
- column_order?: {
- view_id?: string;
- order?: number;
- };
-};
+/**
+ * Model for User
+ */
+export interface UserType {
+ /**
+ * The email of the user
+ * @format email
+ * @example user@example.com
+ */
+ email: string;
+ /** Set to true if the user's email has been verified. */
+ email_verified: boolean;
+ /**
+ * The first name of the user
+ * @example Alice
+ */
+ firstname: string;
+ /**
+ * Unique identifier for the given user.
+ * @example us_8kugj628ebjngs
+ */
+ id: string;
+ /**
+ * The last name of the user
+ * @example Smith
+ */
+ lastname: string;
+ /**
+ * The roles of the user
+ * @example org-level-viewer
+ */
+ roles?: string;
+}
+/**
+ * Model for User Info
+ */
export interface UserInfoType {
- id?: string;
+ /**
+ * User Email
+ * @format email
+ */
email?: string;
- email_verified?: string;
+ /** Set to true if the user's email has been verified. */
+ email_verified?: boolean;
+ /** The firstname of the user */
firstname?: string;
+ /** User ID */
+ id?: string;
+ /** The lastname of the user */
lastname?: string;
+ /** The roles of the user */
roles?: any;
}
-export type VisibilityRuleReqType = {
- disabled?: {
- commenter?: BoolType;
- creator?: BoolType;
- editor?: BoolType;
- guest?: BoolType;
- owner?: BoolType;
- viewer?: BoolType;
+/**
+ * Model for User List
+ */
+export interface UserListType {
+ /** users includes `list` and `pageInfo` */
+ users: {
+ /** List of User objects */
+ list: UserType;
+ /** Pagination info */
+ pageInfo: PaginatedType;
};
-}[];
-
-export type BoolType = boolean | number | null;
-
-export type StringOrNullType = string | null;
-
-export type MetaType = object | string | null;
-
-export interface CommentReqType {
- row_id: string;
- fk_model_id: string;
- description?: string;
}
-export interface AuditRowUpdateReqType {
- fk_model_id?: string;
- column_name?: string;
- row_id?: string;
- value?: any;
- prev_value?: any;
+/**
+ * Model for View
+ */
+export interface ViewType {
+ /** Unique Base ID */
+ base_id?: IdType;
+ /** Unique Model ID */
+ fk_model_id: IdType;
+ /** Unique ID for View */
+ id?: IdType;
+ /** Lock Type of the view */
+ lock_type?: 'collaborative' | 'locked' | 'personal';
+ /** Meta data for this view */
+ meta?: MetaType;
+ /** The rder of the list of views */
+ order?: number;
+ /** Password for protecting the view */
+ password?: string;
+ /** Unique Project ID */
+ project_id?: IdType;
+ /** If this view is shown? */
+ show: BoolType;
+ /** Should show system fields in this view? */
+ show_system_fields?: BoolType;
+ /** View Title */
+ title: string;
+ /** View Type */
+ type: number;
+ /** UUID of the view */
+ uuid?: StringOrNullType;
+ /** Associated View Model */
+ view?:
+ | FormType
+ | GalleryType
+ | GridType
+ | KanbanType
+ | MapType
+ | (FormType & GalleryType & GridType & KanbanType & MapType);
}
-export interface OrgUserReqType {
- email?: string;
- roles?: string;
+/**
+ * Model for View List
+ */
+export interface ViewListType {
+ list?: ViewType[];
+ /** Model for Paginated */
+ pageInfo?: PaginatedType;
}
-export interface ProjectUserReqType {
- email?: string;
- roles?: string;
+/**
+ * Model for View Request
+ */
+export interface ViewReqType {
+ /**
+ * View Title
+ * @example Grid View 1
+ */
+ title?: string;
+ /**
+ * View UUID. Used in Shared View.
+ * @example e2457bbf-e29c-4fec-866e-fe3b01dba57f
+ */
+ uuid?: string;
+ /**
+ * View Password. Used in Shared View.
+ * @example password123
+ */
+ password?: string;
+ /**
+ * Lock type of View.
+ * @example collaborative
+ */
+ lock_type?: 'collaborative' | 'locked' | 'personal';
+ /** Meta info used in View. */
+ meta?: MetaType;
+ /**
+ * The order of the list of views.
+ * @min 0
+ * @example 1
+ */
+ order?: number;
+ /** Should this view show system fields? */
+ show_system_fields?: BoolType;
}
-export interface SharedBaseReqType {
- uuid?: StringOrNullType;
- roles?: StringOrNullType;
+/**
+ * Model for View Column Update Request
+ */
+export interface ViewColumnUpdateReqType {
+ /** View Title */
+ show?: BoolType;
+ /**
+ * The order of the list of views.
+ * @min 0
+ * @example 1
+ */
+ order?: number;
}
-export interface PluginTestReqType {
- title?: string;
- input?: any;
+/**
+ * Model for View Column Request
+ */
+export interface ViewColumnReqType {
+ /** Foreign Key to Column */
+ fk_column_id?: IdType;
+ /** View Title */
+ show?: BoolType;
+ /**
+ * The order of the list of views.
+ * @min 0
+ * @example 1
+ */
+ order?: number;
}
-export interface PluginReqType {
- active?: BoolType;
- input?: any;
-}
+/**
+ * Model for Visibility Rule Request
+ */
+export type VisibilityRuleReqType = {
+ id?: string | null;
+ disabled?: {
+ /** Model for Bool */
+ commenter?: BoolType;
+ /** Model for Bool */
+ creator?: BoolType;
+ /** Model for Bool */
+ editor?: BoolType;
+ /** Model for Bool */
+ guest?: BoolType;
+ /** Model for Bool */
+ owner?: BoolType;
+ /** Model for Bool */
+ viewer?: BoolType;
+ };
+}[];
import axios, { AxiosInstance, AxiosRequestConfig, ResponseType } from 'axios';
@@ -1087,6 +2459,8 @@ export class HttpClient