Skip to content

gi-nx


gi-nx / GiFileForDocs

ts
type GiFileForDocs = 
  | {
  access_level: "admin" | "edit" | "view" | "none";
  created_at: string;
  description: string;
  file_type: "giraffe_pack_metric" | "giraffe_pack_imperial";
  giraffe_pack_category: string | number;
  giraffe_pack_contents: (
     | number
     | "sections"
     | "usages"
     | "layers"
     | "flows"
     | "blocks"
     | "analytics"
     | "report_builder"
     | "apps"
    | "scenarios")[];
  id: number;
  name: string;
  org: number;
  org_name: string;
  public: boolean;
  searchable_description: string;
  tags: string[];
  thumbnail_url?: string;
  updated_at: string;
  url: string;
}
  | {
  access_level: "admin" | "edit" | "view" | "none";
  created_at: string;
  description: string;
  file_type: "image" | "three_d_model";
  id: number;
  meta?: object;
  name: string;
  org: number;
  org_name: string;
  public: boolean;
  searchable_description: string;
  tags: string[];
  thumbnail_url?: string;
  updated_at: string;
  url: string;
};

Type Declaration

ts
{
  access_level: "admin" | "edit" | "view" | "none";
  created_at: string;
  description: string;
  file_type: "giraffe_pack_metric" | "giraffe_pack_imperial";
  giraffe_pack_category: string | number;
  giraffe_pack_contents: (
     | number
     | "sections"
     | "usages"
     | "layers"
     | "flows"
     | "blocks"
     | "analytics"
     | "report_builder"
     | "apps"
    | "scenarios")[];
  id: number;
  name: string;
  org: number;
  org_name: string;
  public: boolean;
  searchable_description: string;
  tags: string[];
  thumbnail_url?: string;
  updated_at: string;
  url: string;
}
NameTypeDescription
access_level"admin" | "edit" | "view" | "none"-
created_atstring-
descriptionstring-
file_type"giraffe_pack_metric" | "giraffe_pack_imperial"-
giraffe_pack_categorystring | number-
giraffe_pack_contents( | number | "sections" | "usages" | "layers" | "flows" | "blocks" | "analytics" | "report_builder" | "apps" | "scenarios")[]-
idnumber-
namestring-
orgnumber-
org_namestring-
publicboolean-
searchable_descriptionstring-
tagsstring[]-
thumbnail_url?string-
updated_atstring-
urlstringThis could be a private URL (if it contains api/storage-proxy/) . Private URLS will need to be passed to getTempUrl before it can be fetched by the app. Apps need to be whitelisted before they can access the temporary public URLs returned by getTempUrl. Contact us for details.
ts
{
  access_level: "admin" | "edit" | "view" | "none";
  created_at: string;
  description: string;
  file_type: "image" | "three_d_model";
  id: number;
  meta?: object;
  name: string;
  org: number;
  org_name: string;
  public: boolean;
  searchable_description: string;
  tags: string[];
  thumbnail_url?: string;
  updated_at: string;
  url: string;
}
NameTypeDescription
access_level"admin" | "edit" | "view" | "none"-
created_atstring-
descriptionstring-
file_type"image" | "three_d_model"-
idnumber-
meta?object-
namestring-
orgnumber-
org_namestring-
publicboolean-
searchable_descriptionstring-
tagsstring[]-
thumbnail_url?string-
updated_atstring-
urlstringThis could be a private URL (if it contains api/storage-proxy/) . Private URLS will need to be passed to getTempUrl before it can be fetched by the app. Apps need to be whitelisted before they can access the temporary public URLs returned by getTempUrl. Contact us for details.