frameio 2.0.3 → 3.1.0

package/dist/cjs/api/types/Forbidden.d.ts

@@ -6,12 +6,12 @@ export declare namespace Forbidden {
     namespace Errors {
         interface Item {
             detail: string;
-            source?: Item.Source;
-            title?: string;
+            source?: Item.Source | undefined;
+            title?: string | undefined;
         }
         namespace Item {
             interface Source {
-                pointer?: string;
+                pointer?: string | undefined;
             }
         }
     }

package/dist/cjs/api/types/IntegerValue.d.ts

@@ -1,4 +1,4 @@
-import * as Frameio from "../index.js";
+import type * as Frameio from "../index.js";
 export interface IntegerValue extends Frameio.FieldValueCommon {
-    value?: number;
+    value?: number | undefined;
 }

package/dist/cjs/api/types/Link.d.ts

@@ -0,0 +1,10 @@
+export interface Link {
+    /** End index of link text */
+    end_index: number;
+    /** Start index of link text */
+    start_index: number;
+    /** Link text */
+    text: string;
+    /** Link URL */
+    url: string;
+}

package/dist/cjs/api/types/Link.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/LinkParams.d.ts

@@ -0,0 +1,8 @@
+export interface LinkParams {
+    /** End index of link text */
+    end_index: number;
+    /** Start index of link text */
+    start_index: number;
+    /** Link URL */
+    url: string;
+}

package/dist/cjs/api/types/LinkParams.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/Links.d.ts

@@ -8,5 +8,5 @@ export interface Links {
      * This link is the request path with the addition of the `after` query parameter to fetch the next page of results.
      * Optional query parameters `page_size` and `include_total_count` are supported when paginating data."
      */
-    next?: string;
+    next?: string | undefined;
 }

package/dist/cjs/api/types/LongTextDefinition.d.ts

@@ -16,8 +16,7 @@ export interface LongTextDefinition {
     updated_at: string;
 }
 export declare namespace LongTextDefinition {
-    interface FieldConfiguration {
-    }
+    type FieldConfiguration = {};
     /** Field type */
     const FieldType: {
         readonly Text: "text";

package/dist/cjs/api/types/LongTextDefinitionWithIncludes.d.ts

@@ -1,4 +1,4 @@
-import * as Frameio from "../index.js";
+import type * as Frameio from "../index.js";
 export interface LongTextDefinitionWithIncludes extends Frameio.LongTextDefinition {
-    creator?: Frameio.User;
+    creator?: Frameio.User | undefined;
 }

package/dist/cjs/api/types/MediaLinkCommon.d.ts

@@ -4,7 +4,7 @@ export interface MediaLinkCommon {
      * HTTP response headers will include Content-Disposition = 'attachment;filename=<filename>'.<br/>
      * Watermarks may be applied for transcode links as per Account settings and User permissions.<br/>
      */
-    download_url?: string;
+    download_url?: string | undefined;
     /** Accepts any additional properties */
     [key: string]: any;
 }

package/dist/cjs/api/types/MediaLinksCollection.d.ts

@@ -1,10 +1,10 @@
-import * as Frameio from "../index.js";
+import type * as Frameio from "../index.js";
 export interface MediaLinksCollection {
-    efficient?: Frameio.MediaLinkCommon;
-    high_quality?: Frameio.MediaLinkCommon;
-    original?: Frameio.OriginalMediaLink;
-    scrub_sheet?: Frameio.RenditionMediaLink;
-    thumbnail?: Frameio.RenditionMediaLink;
-    thumbnail_high_quality?: Frameio.RenditionMediaLink;
-    video_h264_180?: Frameio.RenditionMediaLink;
+    efficient?: Frameio.MediaLinkCommon | undefined;
+    high_quality?: Frameio.MediaLinkCommon | undefined;
+    original?: Frameio.OriginalMediaLink | undefined;
+    scrub_sheet?: Frameio.RenditionMediaLink | undefined;
+    thumbnail?: Frameio.RenditionMediaLink | undefined;
+    thumbnail_high_quality?: Frameio.RenditionMediaLink | undefined;
+    video_h264_180?: Frameio.RenditionMediaLink | undefined;
 }

package/dist/cjs/api/types/Mention.d.ts

@@ -0,0 +1,10 @@
+export interface Mention {
+    /** End index of mention text */
+    end_index: number;
+    /** Start index of mention text */
+    start_index: number;
+    /** Mention text */
+    text: string;
+    /** Mentioned user ID */
+    user_id: string;
+}

package/dist/cjs/api/types/Mention.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/MetadataField.d.ts

@@ -1,7 +1,7 @@
-import * as Frameio from "../index.js";
-export type MetadataField = Frameio.MetadataField.Date_ | Frameio.MetadataField.LongText | Frameio.MetadataField.Number | Frameio.MetadataField.Rating | Frameio.MetadataField.Select | Frameio.MetadataField.SelectMulti | Frameio.MetadataField.Text | Frameio.MetadataField.Toggle | Frameio.MetadataField.UserMulti | Frameio.MetadataField.UserSingle | Frameio.MetadataField.Users;
+import type * as Frameio from "../index.js";
+export type MetadataField = Frameio.MetadataField.Date | Frameio.MetadataField.LongText | Frameio.MetadataField.Number | Frameio.MetadataField.Rating | Frameio.MetadataField.Select | Frameio.MetadataField.SelectMulti | Frameio.MetadataField.Text | Frameio.MetadataField.Toggle | Frameio.MetadataField.UserMulti | Frameio.MetadataField.UserSingle | Frameio.MetadataField.Users;
 export declare namespace MetadataField {
-    interface Date_ extends Frameio.DateValue {
+    interface Date extends Frameio.DateValue {
         field_type: "date";
     }
     interface LongText extends Frameio.TextValue {

package/dist/cjs/api/types/MetadataResponse.d.ts

@@ -1,4 +1,4 @@
-import * as Frameio from "../index.js";
+import type * as Frameio from "../index.js";
 export interface MetadataResponse {
     data: Frameio.MetadataWithDefinition;
 }

package/dist/cjs/api/types/MetadataWithDefinition.d.ts

@@ -1,4 +1,4 @@
-import * as Frameio from "../index.js";
+import type * as Frameio from "../index.js";
 export interface MetadataWithDefinition {
     /** File ID */
     file_id: string;

package/dist/cjs/api/types/MultiSelectValue.d.ts

@@ -1,5 +1,5 @@
-import * as Frameio from "../index.js";
+import type * as Frameio from "../index.js";
 export interface MultiSelectValue extends Frameio.FieldValueCommon {
-    field_options?: Frameio.SelectOption[];
+    field_options?: Frameio.SelectOption[] | undefined;
     value: Frameio.SelectOption[];
 }

package/dist/cjs/api/types/MultiUserValue.d.ts

@@ -1,8 +1,8 @@
-import * as Frameio from "../index.js";
+import type * as Frameio from "../index.js";
 export interface MultiUserValue extends Frameio.FieldValueCommon {
     /** Populated with custom member options only if `member_options_type` is set to 'custom'. */
-    custom_members?: Frameio.UserValue[];
-    member_options_type?: MultiUserValue.MemberOptionsType;
+    custom_members?: Frameio.UserValue[] | undefined;
+    member_options_type?: MultiUserValue.MemberOptionsType | undefined;
     value: Frameio.UserValue[];
 }
 export declare namespace MultiUserValue {

package/dist/cjs/api/types/NotFound.d.ts

@@ -6,12 +6,12 @@ export declare namespace NotFound {
     namespace Errors {
         interface Item {
             detail: string;
-            source?: Item.Source;
-            title?: string;
+            source?: Item.Source | undefined;
+            title?: string | undefined;
         }
         namespace Item {
             interface Source {
-                pointer?: string;
+                pointer?: string | undefined;
             }
         }
     }

package/dist/cjs/api/types/NumberDefinition.d.ts

@@ -16,7 +16,7 @@ export interface NumberDefinition {
 export declare namespace NumberDefinition {
     interface FieldConfiguration {
         /** Number format */
-        number_format?: FieldConfiguration.NumberFormat;
+        number_format?: FieldConfiguration.NumberFormat | undefined;
         /** Number scale. Indicates the number of decimal places of precision for the number value */
         scale: number;
     }

package/dist/cjs/api/types/NumberDefinitionParams.d.ts

@@ -6,7 +6,7 @@ export interface NumberDefinitionParams {
 export declare namespace NumberDefinitionParams {
     interface FieldConfiguration {
         /** Number format */
-        number_format?: FieldConfiguration.NumberFormat;
+        number_format?: FieldConfiguration.NumberFormat | undefined;
         /** Number scale. Indicates the number of decimal places of precision for the number value */
         scale: number;
     }

package/dist/cjs/api/types/NumberDefinitionWithIncludes.d.ts

@@ -1,4 +1,4 @@
-import * as Frameio from "../index.js";
+import type * as Frameio from "../index.js";
 export interface NumberDefinitionWithIncludes extends Frameio.NumberDefinition {
-    creator?: Frameio.User;
+    creator?: Frameio.User | undefined;
 }

package/dist/cjs/api/types/NumberValue.d.ts

@@ -1,4 +1,4 @@
-import * as Frameio from "../index.js";
+import type * as Frameio from "../index.js";
 export interface NumberValue extends Frameio.FieldValueCommon {
-    value?: number;
+    value?: number | undefined;
 }

package/dist/cjs/api/types/OriginalMediaLink.d.ts

@@ -1,8 +1,8 @@
-import * as Frameio from "../index.js";
+import type * as Frameio from "../index.js";
 export interface OriginalMediaLink extends Frameio.MediaLinkCommon {
     /**
      * URL to view the media file in a web browser in its original resolution and media type.<br/>
      * HTTP response headers will include Content-Disposition = 'inline;filename=<filename>'.<br/>
      */
-    inline_url?: string;
+    inline_url?: string | undefined;
 }

package/dist/cjs/api/types/Profile.d.ts

@@ -3,7 +3,7 @@
  */
 export interface Profile {
     /** User avatar image url */
-    avatar_url?: string;
+    avatar_url?: string | undefined;
     /** User email */
     email: string;
     /** User ID */

package/dist/cjs/api/types/ProfileResponse.d.ts

@@ -1,4 +1,4 @@
-import * as Frameio from "../index.js";
+import type * as Frameio from "../index.js";
 /**
  * User profile
  */

package/dist/cjs/api/types/Project.d.ts

@@ -9,7 +9,7 @@ export interface Project {
     /** Project Name */
     name: string;
     /** Whether the project is restricted or not */
-    restricted?: boolean;
+    restricted?: boolean | undefined;
     /** Root Folder ID */
     root_folder_id: string;
     /** Project Status */

package/dist/cjs/api/types/ProjectResponse.d.ts

@@ -1,4 +1,4 @@
-import * as Frameio from "../index.js";
+import type * as Frameio from "../index.js";
 /**
  * Frame.io project details
  */

package/dist/cjs/api/types/ProjectUserRolesResponse.d.ts

@@ -1,4 +1,4 @@
-import * as Frameio from "../index.js";
+import type * as Frameio from "../index.js";
 /**
  * Frame.io user role details
  */
@@ -7,5 +7,5 @@ export interface ProjectUserRolesResponse {
     data: Frameio.UserRole[];
     links: Frameio.Links;
     /** Total count */
-    total_count?: number;
+    total_count?: number | undefined;
 }

package/dist/cjs/api/types/ProjectWithIncludes.d.ts

@@ -1,6 +1,6 @@
-import * as Frameio from "../index.js";
+import type * as Frameio from "../index.js";
 export interface ProjectWithIncludes extends Frameio.Project {
     /** Project Description */
-    description?: string;
-    owner?: Frameio.User;
+    description?: string | undefined;
+    owner?: Frameio.User | undefined;
 }

package/dist/cjs/api/types/ProjectWithIncludesResponse.d.ts

@@ -1,4 +1,4 @@
-import * as Frameio from "../index.js";
+import type * as Frameio from "../index.js";
 /**
  * Frame.io project details
  */

package/dist/cjs/api/types/ProjectsWithIncludesResponse.d.ts

@@ -1,4 +1,4 @@
-import * as Frameio from "../index.js";
+import type * as Frameio from "../index.js";
 /**
  * Frame.io projects
  */
@@ -7,5 +7,5 @@ export interface ProjectsWithIncludesResponse {
     data: Frameio.ProjectWithIncludes[];
     links: Frameio.Links;
     /** Total count */
-    total_count?: number;
+    total_count?: number | undefined;
 }

package/dist/cjs/api/types/RatingDefinition.d.ts

@@ -16,10 +16,10 @@ export interface RatingDefinition {
 export declare namespace RatingDefinition {
     interface FieldConfiguration {
         /** Color value hex code for the `style` icon symbols. ex: #fbd400 */
-        color?: string;
+        color?: string | undefined;
         max_value: number;
         /** Field type */
-        style?: FieldConfiguration.Style;
+        style?: FieldConfiguration.Style | undefined;
     }
     namespace FieldConfiguration {
         /** Field type */

package/dist/cjs/api/types/RatingDefinitionParams.d.ts

@@ -6,10 +6,10 @@ export interface RatingDefinitionParams {
 export declare namespace RatingDefinitionParams {
     interface FieldConfiguration {
         /** Color value hex code for the `style` icon symbols. ex: #fbd400 */
-        color?: string;
+        color?: string | undefined;
         max_value: number;
         /** Field type */
-        style?: FieldConfiguration.Style;
+        style?: FieldConfiguration.Style | undefined;
     }
     namespace FieldConfiguration {
         /** Field type */

package/dist/cjs/api/types/RatingDefinitionWithIncludes.d.ts

@@ -1,4 +1,4 @@
-import * as Frameio from "../index.js";
+import type * as Frameio from "../index.js";
 export interface RatingDefinitionWithIncludes extends Frameio.RatingDefinition {
-    creator?: Frameio.User;
+    creator?: Frameio.User | undefined;
 }

package/dist/cjs/api/types/RemoveAssetResponse.d.ts

@@ -1,4 +1,4 @@
-import * as Frameio from "../index.js";
+import type * as Frameio from "../index.js";
 export interface RemoveAssetResponse {
     data: RemoveAssetResponse.Data;
 }

package/dist/cjs/api/types/RenditionMediaLink.d.ts

@@ -1,4 +1,4 @@
-import * as Frameio from "../index.js";
+import type * as Frameio from "../index.js";
 export interface RenditionMediaLink extends Frameio.MediaLinkCommon {
     /**
      * URL to transcoded media that won't include any Content-Disposition header in the response.<br/>
@@ -7,5 +7,5 @@ export interface RenditionMediaLink extends Frameio.MediaLinkCommon {
      * HEAD request to determine whether Content-Length and/or Accept-Ranges headers are present in order
      * to determine whether the content can be downloaded in parallel chunks.
      */
-    url?: string;
+    url?: string | undefined;
 }

package/dist/cjs/api/types/SelectDefinition.d.ts

@@ -16,7 +16,7 @@ export interface SelectDefinition {
 export declare namespace SelectDefinition {
     interface FieldConfiguration {
         /** Allow or disallow adding in new option(s) from the grid/list view */
-        enable_add_new?: boolean;
+        enable_add_new?: boolean | undefined;
         options: FieldConfiguration.Options.Item[];
     }
     namespace FieldConfiguration {
@@ -24,10 +24,10 @@ export declare namespace SelectDefinition {
         namespace Options {
             interface Item {
                 /** Color value hex code for the `display_name`. ex: #fbd400 */
-                color?: string;
+                color?: string | undefined;
                 /** Option display name */
                 display_name: string;
-                id?: string;
+                id?: string | undefined;
             }
         }
     }

package/dist/cjs/api/types/SelectDefinitionParams.d.ts

@@ -6,7 +6,7 @@ export interface SelectDefinitionParams {
 export declare namespace SelectDefinitionParams {
     interface FieldConfiguration {
         /** Allow or disallow adding in new option(s) from the grid/list view */
-        enable_add_new?: boolean;
+        enable_add_new?: boolean | undefined;
         options: FieldConfiguration.Options.Item[];
     }
     namespace FieldConfiguration {
@@ -14,7 +14,7 @@ export declare namespace SelectDefinitionParams {
         namespace Options {
             interface Item {
                 /** Color value hex code for the `display_name`. ex: #fbd400 */
-                color?: string;
+                color?: string | undefined;
                 /** Option display name */
                 display_name: string;
             }

package/dist/cjs/api/types/SelectDefinitionWithIncludes.d.ts

@@ -1,4 +1,4 @@
-import * as Frameio from "../index.js";
+import type * as Frameio from "../index.js";
 export interface SelectDefinitionWithIncludes extends Frameio.SelectDefinition {
-    creator?: Frameio.User;
+    creator?: Frameio.User | undefined;
 }

package/dist/cjs/api/types/SelectMultiDefinition.d.ts

@@ -18,7 +18,7 @@ export interface SelectMultiDefinition {
 export declare namespace SelectMultiDefinition {
     interface FieldConfiguration {
         /** Allow or disallow adding in new option(s) from the grid/list view */
-        enable_add_new?: boolean;
+        enable_add_new?: boolean | undefined;
         options: FieldConfiguration.Options.Item[];
     }
     namespace FieldConfiguration {
@@ -26,10 +26,10 @@ export declare namespace SelectMultiDefinition {
         namespace Options {
             interface Item {
                 /** Color value hex code for the `display_name`. ex: #fbd400 */
-                color?: string;
+                color?: string | undefined;
                 /** Option display name */
                 display_name: string;
-                id?: string;
+                id?: string | undefined;
             }
         }
     }

package/dist/cjs/api/types/SelectMultiDefinitionParams.d.ts

@@ -6,7 +6,7 @@ export interface SelectMultiDefinitionParams {
 export declare namespace SelectMultiDefinitionParams {
     interface FieldConfiguration {
         /** Allow or disallow adding in new option(s) from the grid/list view */
-        enable_add_new?: boolean;
+        enable_add_new?: boolean | undefined;
         options: FieldConfiguration.Options.Item[];
     }
     namespace FieldConfiguration {
@@ -14,7 +14,7 @@ export declare namespace SelectMultiDefinitionParams {
         namespace Options {
             interface Item {
                 /** Color value hex code for the `display_name`. ex: #fbd400 */
-                color?: string;
+                color?: string | undefined;
                 /** Option display name */
                 display_name: string;
             }

package/dist/cjs/api/types/SelectMultiDefinitionWithIncludes.d.ts

@@ -1,4 +1,4 @@
-import * as Frameio from "../index.js";
+import type * as Frameio from "../index.js";
 export interface SelectMultiDefinitionWithIncludes extends Frameio.SelectMultiDefinition {
-    creator?: Frameio.User;
+    creator?: Frameio.User | undefined;
 }

package/dist/cjs/api/types/SelectValue.d.ts

@@ -1,5 +1,5 @@
-import * as Frameio from "../index.js";
+import type * as Frameio from "../index.js";
 export interface SelectValue extends Frameio.FieldValueCommon {
-    field_options?: Frameio.SelectOption[];
+    field_options?: Frameio.SelectOption[] | undefined;
     value: Frameio.SelectOption[];
 }

package/dist/cjs/api/types/Share.d.ts

@@ -6,21 +6,21 @@ export interface Share {
     /** Creation timestamp */
     created_at: string;
     /** Share description */
-    description?: string;
+    description?: string | undefined;
     downloading_enabled: boolean;
     enabled: boolean;
     /** Expiration timestamp */
-    expiration?: string;
+    expiration?: string | undefined;
     /** Share ID */
     id: string;
     /** Last viewed timestamp */
-    last_viewed_at?: string;
+    last_viewed_at?: string | undefined;
     /** Share name */
-    name?: string;
+    name?: string | undefined;
     /** Passphrase to access share, if passphrase is required and not given it will be generated */
-    passphrase?: string;
+    passphrase?: string | undefined;
     /** Share URL */
-    short_url?: string;
+    short_url?: string | undefined;
     /** Update timestamp */
     updated_at: string;
 }

package/dist/cjs/api/types/ShareResponse.d.ts

@@ -1,4 +1,4 @@
-import * as Frameio from "../index.js";
+import type * as Frameio from "../index.js";
 export interface ShareResponse {
     data: Frameio.Share;
 }

package/dist/cjs/api/types/ShareReviewersResponse.d.ts

@@ -1,4 +1,4 @@
-import * as Frameio from "../index.js";
+import type * as Frameio from "../index.js";
 /**
  * Share reviewers
  */
@@ -7,5 +7,5 @@ export interface ShareReviewersResponse {
     data: Frameio.User[];
     links: Frameio.Links;
     /** Total count */
-    total_count?: number;
+    total_count?: number | undefined;
 }

package/dist/cjs/api/types/SharesResponse.d.ts

@@ -1,4 +1,4 @@
-import * as Frameio from "../index.js";
+import type * as Frameio from "../index.js";
 /**
  * Shares on a project
  */
@@ -7,5 +7,5 @@ export interface SharesResponse {
     data: Frameio.Share[];
     links: Frameio.Links;
     /** Total count */
-    total_count?: number;
+    total_count?: number | undefined;
 }

package/dist/cjs/api/types/SingleUserValue.d.ts

@@ -1,8 +1,8 @@
-import * as Frameio from "../index.js";
+import type * as Frameio from "../index.js";
 export interface SingleUserValue extends Frameio.FieldValueCommon {
     /** Populated with costum member options only if `member_options_type` is set to 'custom'. */
-    custom_members?: Frameio.UserValue[];
-    member_options_type?: SingleUserValue.MemberOptionsType;
+    custom_members?: Frameio.UserValue[] | undefined;
+    member_options_type?: SingleUserValue.MemberOptionsType | undefined;
     value: Frameio.UserValue[];
 }
 export declare namespace SingleUserValue {

package/dist/cjs/api/types/TextDefinition.d.ts

@@ -16,8 +16,7 @@ export interface TextDefinition {
     updated_at: string;
 }
 export declare namespace TextDefinition {
-    interface FieldConfiguration {
-    }
+    type FieldConfiguration = {};
     /** Field type */
     const FieldType: {
         readonly Text: "text";

package/dist/cjs/api/types/TextDefinitionWithIncludes.d.ts

@@ -1,4 +1,4 @@
-import * as Frameio from "../index.js";
+import type * as Frameio from "../index.js";
 export interface TextDefinitionWithIncludes extends Frameio.TextDefinition {
-    creator?: Frameio.User;
+    creator?: Frameio.User | undefined;
 }

package/dist/cjs/api/types/TextReviewAnnotation.d.ts

@@ -0,0 +1,21 @@
+import type * as Frameio from "../index.js";
+export interface TextReviewAnnotation {
+    /** An array of bounds representing a multiline selection origin at the lower-left corner. */
+    bounds: Frameio.TextReviewAnnotationBounds[];
+    /** Selected text from the document. */
+    selection_text?: string | undefined;
+    /** Suggested replacement or insertion text. */
+    suggested_text?: string | undefined;
+    /** The type of text review annotation. */
+    text_review_annotation_type: TextReviewAnnotation.TextReviewAnnotationType;
+}
+export declare namespace TextReviewAnnotation {
+    /** The type of text review annotation. */
+    const TextReviewAnnotationType: {
+        readonly Highlight: "highlight";
+        readonly Insert: "insert";
+        readonly Remove: "remove";
+        readonly Replace: "replace";
+    };
+    type TextReviewAnnotationType = (typeof TextReviewAnnotationType)[keyof typeof TextReviewAnnotationType];
+}

package/dist/cjs/api/types/TextReviewAnnotation.js

@@ -0,0 +1,14 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TextReviewAnnotation = void 0;
+var TextReviewAnnotation;
+(function (TextReviewAnnotation) {
+    /** The type of text review annotation. */
+    TextReviewAnnotation.TextReviewAnnotationType = {
+        Highlight: "highlight",
+        Insert: "insert",
+        Remove: "remove",
+        Replace: "replace",
+    };
+})(TextReviewAnnotation || (exports.TextReviewAnnotation = TextReviewAnnotation = {}));