frameio 0.1.0

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

@@ -0,0 +1,10 @@
+export interface MediaLinkCommon {
+    /**
+     * URL to download the media file.<br>
+     * 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;
+    /** Accepts any additional properties */
+    [key: string]: any;
+}

package/dist/cjs/api/types/MediaLinkCommon.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/MediaLinksCollection.d.ts

@@ -0,0 +1,8 @@
+import * as Frameio from "../index.js";
+export interface MediaLinksCollection {
+    efficient?: Frameio.MediaLinkCommon;
+    high_quality?: Frameio.MediaLinkCommon;
+    original?: Frameio.OriginalMediaLink;
+    thumbnail?: Frameio.RenditionMediaLink;
+    video_h264_180?: Frameio.RenditionMediaLink;
+}

package/dist/cjs/api/types/MediaLinksCollection.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

@@ -0,0 +1,37 @@
+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;
+export declare namespace MetadataField {
+    interface Date_ extends Frameio.DateValue {
+        field_type: "date";
+    }
+    interface LongText extends Frameio.TextValue {
+        field_type: "long_text";
+    }
+    interface Number extends Frameio.NumberValue {
+        field_type: "number";
+    }
+    interface Rating extends Frameio.IntegerValue {
+        field_type: "rating";
+    }
+    interface Select extends Frameio.SelectValue {
+        field_type: "select";
+    }
+    interface SelectMulti extends Frameio.MultiSelectValue {
+        field_type: "select_multi";
+    }
+    interface Text extends Frameio.TextValue {
+        field_type: "text";
+    }
+    interface Toggle extends Frameio.BooleanValue {
+        field_type: "toggle";
+    }
+    interface UserMulti extends Frameio.MultiUserValue {
+        field_type: "user_multi";
+    }
+    interface UserSingle extends Frameio.SingleUserValue {
+        field_type: "user_single";
+    }
+    interface Users extends Frameio.MultiUserValue {
+        field_type: "users";
+    }
+}

package/dist/cjs/api/types/MetadataField.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/MetadataResponse.d.ts

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

package/dist/cjs/api/types/MetadataResponse.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/MetadataWithDefinition.d.ts

@@ -0,0 +1,7 @@
+import * as Frameio from "../index.js";
+export interface MetadataWithDefinition {
+    /** File ID */
+    file_id: string;
+    /** Metadata fields values */
+    metadata: Frameio.MetadataField[];
+}

package/dist/cjs/api/types/MetadataWithDefinition.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/MultiSelectValue.d.ts

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

package/dist/cjs/api/types/MultiSelectValue.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/MultiUserValue.d.ts

@@ -0,0 +1,14 @@
+import * as Frameio from "../index.js";
+export interface MultiUserValue extends Frameio.FieldValueCommon {
+    /** Populated with costum member options only if `member_options_type` is set to 'custom'. */
+    custom_members?: Frameio.UserValue[];
+    member_options_type?: MultiUserValue.MemberOptionsType;
+    value?: Frameio.UserValue[];
+}
+export declare namespace MultiUserValue {
+    const MemberOptionsType: {
+        readonly Custom: "custom";
+        readonly AllProjectMembers: "all_project_members";
+    };
+    type MemberOptionsType = (typeof MemberOptionsType)[keyof typeof MemberOptionsType];
+}

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

@@ -0,0 +1,11 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MultiUserValue = void 0;
+var MultiUserValue;
+(function (MultiUserValue) {
+    MultiUserValue.MemberOptionsType = {
+        Custom: "custom",
+        AllProjectMembers: "all_project_members",
+    };
+})(MultiUserValue || (exports.MultiUserValue = MultiUserValue = {}));

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

@@ -0,0 +1,4 @@
+/**
+ * Response schema for generic no content response.
+ */
+export type NoContent = string;

package/dist/cjs/api/types/NoContent.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/NotFound.d.ts

@@ -0,0 +1,18 @@
+export interface NotFound {
+    errors: NotFound.Errors.Item[];
+}
+export declare namespace NotFound {
+    type Errors = Errors.Item[];
+    namespace Errors {
+        interface Item {
+            detail: string;
+            source?: Item.Source;
+            title?: string;
+        }
+        namespace Item {
+            interface Source {
+                pointer?: string;
+            }
+        }
+    }
+}

package/dist/cjs/api/types/NotFound.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/NumberDefinition.d.ts

@@ -0,0 +1,36 @@
+export interface NumberDefinition {
+    /** Created Timestamp */
+    created_at: string;
+    /** Field definition creator ID */
+    creator_id: string;
+    field_configuration: NumberDefinition.FieldConfiguration;
+    /** Field definition ID */
+    id: string;
+    /** Field definition mutability. System fields cannot be updated. */
+    mutable: boolean;
+    /** FieldDefinition Name */
+    name: string;
+    /** Updated Timestamp */
+    updated_at: string;
+}
+export declare namespace NumberDefinition {
+    interface FieldConfiguration {
+        /** Number format */
+        number_format?: FieldConfiguration.NumberFormat;
+        /** Number scale. Indicates the number of decimal places of precision for the number value */
+        scale: number;
+    }
+    namespace FieldConfiguration {
+        /** Number format */
+        const NumberFormat: {
+            readonly Bitrate: "bitrate";
+            readonly Bits: "bits";
+            readonly Duration: "duration";
+            readonly Framerate: "framerate";
+            readonly Frequency: "frequency";
+            readonly Storage: "storage";
+            readonly Timecode: "timecode";
+        };
+        type NumberFormat = (typeof NumberFormat)[keyof typeof NumberFormat];
+    }
+}

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

@@ -0,0 +1,20 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NumberDefinition = void 0;
+var NumberDefinition;
+(function (NumberDefinition) {
+    let FieldConfiguration;
+    (function (FieldConfiguration) {
+        /** Number format */
+        FieldConfiguration.NumberFormat = {
+            Bitrate: "bitrate",
+            Bits: "bits",
+            Duration: "duration",
+            Framerate: "framerate",
+            Frequency: "frequency",
+            Storage: "storage",
+            Timecode: "timecode",
+        };
+    })(FieldConfiguration = NumberDefinition.FieldConfiguration || (NumberDefinition.FieldConfiguration = {}));
+})(NumberDefinition || (exports.NumberDefinition = NumberDefinition = {}));

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

@@ -0,0 +1,26 @@
+export interface NumberDefinitionParams {
+    field_configuration: NumberDefinitionParams.FieldConfiguration;
+    /** Field definition name */
+    name: string;
+}
+export declare namespace NumberDefinitionParams {
+    interface FieldConfiguration {
+        /** Number format */
+        number_format?: FieldConfiguration.NumberFormat;
+        /** Number scale. Indicates the number of decimal places of precision for the number value */
+        scale: number;
+    }
+    namespace FieldConfiguration {
+        /** Number format */
+        const NumberFormat: {
+            readonly Bitrate: "bitrate";
+            readonly Bits: "bits";
+            readonly Duration: "duration";
+            readonly Framerate: "framerate";
+            readonly Frequency: "frequency";
+            readonly Storage: "storage";
+            readonly Timecode: "timecode";
+        };
+        type NumberFormat = (typeof NumberFormat)[keyof typeof NumberFormat];
+    }
+}

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

@@ -0,0 +1,20 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NumberDefinitionParams = void 0;
+var NumberDefinitionParams;
+(function (NumberDefinitionParams) {
+    let FieldConfiguration;
+    (function (FieldConfiguration) {
+        /** Number format */
+        FieldConfiguration.NumberFormat = {
+            Bitrate: "bitrate",
+            Bits: "bits",
+            Duration: "duration",
+            Framerate: "framerate",
+            Frequency: "frequency",
+            Storage: "storage",
+            Timecode: "timecode",
+        };
+    })(FieldConfiguration = NumberDefinitionParams.FieldConfiguration || (NumberDefinitionParams.FieldConfiguration = {}));
+})(NumberDefinitionParams || (exports.NumberDefinitionParams = NumberDefinitionParams = {}));

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

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

package/dist/cjs/api/types/NumberDefinitionWithIncludes.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/NumberValue.d.ts

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

package/dist/cjs/api/types/NumberValue.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/OriginalMediaLink.d.ts

@@ -0,0 +1,8 @@
+import * 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;
+}

package/dist/cjs/api/types/OriginalMediaLink.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/Profile.d.ts

@@ -0,0 +1,13 @@
+/**
+ * User details
+ */
+export interface Profile {
+    /** User avatar image url */
+    avatar_url?: string;
+    /** User email */
+    email: string;
+    /** User ID */
+    id: string;
+    /** User name */
+    name: string;
+}

package/dist/cjs/api/types/Profile.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/ProfileResponse.d.ts

@@ -0,0 +1,7 @@
+import * as Frameio from "../index.js";
+/**
+ * User profile
+ */
+export interface ProfileResponse {
+    data: Frameio.Profile;
+}

package/dist/cjs/api/types/ProfileResponse.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/Project.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Frame.io Project
+ */
+export interface Project {
+    /** Created Timestamp */
+    created_at: string;
+    /** Project ID */
+    id: string;
+    /** Project Name */
+    name: string;
+    /** Root Folder ID */
+    root_folder_id: string;
+    /** Storage Usage */
+    storage: number;
+    /** Updated Timestamp */
+    updated_at: string;
+    /** URL to view the project in the Frame.io web application */
+    view_url: string;
+    /** Workspace ID */
+    workspace_id: string;
+}

package/dist/cjs/api/types/Project.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/ProjectInclude.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Include query parameter for projects
+ */
+export type ProjectInclude = "owner";

package/dist/cjs/api/types/ProjectInclude.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/ProjectParams.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Project parameters for create operations
+ */
+export interface ProjectParams {
+    data: ProjectParams.Data;
+}
+export declare namespace ProjectParams {
+    interface Data {
+        /** Project Name */
+        name: string;
+    }
+}

package/dist/cjs/api/types/ProjectParams.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/ProjectResponse.d.ts

@@ -0,0 +1,7 @@
+import * as Frameio from "../index.js";
+/**
+ * Frame.io project details
+ */
+export interface ProjectResponse {
+    data: Frameio.Project;
+}

package/dist/cjs/api/types/ProjectResponse.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/ProjectWithIncludes.d.ts

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

package/dist/cjs/api/types/ProjectWithIncludes.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/ProjectWithIncludesResponse.d.ts

@@ -0,0 +1,7 @@
+import * as Frameio from "../index.js";
+/**
+ * Frame.io project details
+ */
+export interface ProjectWithIncludesResponse {
+    data: Frameio.ProjectWithIncludes;
+}

package/dist/cjs/api/types/ProjectWithIncludesResponse.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/ProjectsWithIncludesResponse.d.ts

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

package/dist/cjs/api/types/ProjectsWithIncludesResponse.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/RatingDefinition.d.ts

@@ -0,0 +1,33 @@
+export interface RatingDefinition {
+    /** Created Timestamp */
+    created_at: string;
+    /** Field definition creator ID */
+    creator_id: string;
+    field_configuration: RatingDefinition.FieldConfiguration;
+    /** Field definition ID */
+    id: string;
+    /** Field definition mutability. System fields cannot be updated. */
+    mutable: boolean;
+    /** FieldDefinition Name */
+    name: string;
+    /** Updated Timestamp */
+    updated_at: string;
+}
+export declare namespace RatingDefinition {
+    interface FieldConfiguration {
+        /** Color value hex code for the `style` icon symbols. ex: #fbd400 */
+        color?: string;
+        max_value: number;
+        /** Field type */
+        style?: FieldConfiguration.Style;
+    }
+    namespace FieldConfiguration {
+        /** Field type */
+        const Style: {
+            readonly Star: "star";
+            readonly Heart: "heart";
+            readonly ThumbsUp: "thumbs_up";
+        };
+        type Style = (typeof Style)[keyof typeof Style];
+    }
+}

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

@@ -0,0 +1,16 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RatingDefinition = void 0;
+var RatingDefinition;
+(function (RatingDefinition) {
+    let FieldConfiguration;
+    (function (FieldConfiguration) {
+        /** Field type */
+        FieldConfiguration.Style = {
+            Star: "star",
+            Heart: "heart",
+            ThumbsUp: "thumbs_up",
+        };
+    })(FieldConfiguration = RatingDefinition.FieldConfiguration || (RatingDefinition.FieldConfiguration = {}));
+})(RatingDefinition || (exports.RatingDefinition = RatingDefinition = {}));

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

@@ -0,0 +1,23 @@
+export interface RatingDefinitionParams {
+    field_configuration: RatingDefinitionParams.FieldConfiguration;
+    /** Field definition name */
+    name: string;
+}
+export declare namespace RatingDefinitionParams {
+    interface FieldConfiguration {
+        /** Color value hex code for the `style` icon symbols. ex: #fbd400 */
+        color?: string;
+        max_value: number;
+        /** Field type */
+        style?: FieldConfiguration.Style;
+    }
+    namespace FieldConfiguration {
+        /** Field type */
+        const Style: {
+            readonly Star: "star";
+            readonly Heart: "heart";
+            readonly ThumbsUp: "thumbs_up";
+        };
+        type Style = (typeof Style)[keyof typeof Style];
+    }
+}

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

@@ -0,0 +1,16 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RatingDefinitionParams = void 0;
+var RatingDefinitionParams;
+(function (RatingDefinitionParams) {
+    let FieldConfiguration;
+    (function (FieldConfiguration) {
+        /** Field type */
+        FieldConfiguration.Style = {
+            Star: "star",
+            Heart: "heart",
+            ThumbsUp: "thumbs_up",
+        };
+    })(FieldConfiguration = RatingDefinitionParams.FieldConfiguration || (RatingDefinitionParams.FieldConfiguration = {}));
+})(RatingDefinitionParams || (exports.RatingDefinitionParams = RatingDefinitionParams = {}));

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

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

package/dist/cjs/api/types/RatingDefinitionWithIncludes.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/RemoveAssetResponse.d.ts

@@ -0,0 +1,10 @@
+import * as Frameio from "../index.js";
+export interface RemoveAssetResponse {
+    data: RemoveAssetResponse.Data;
+}
+export declare namespace RemoveAssetResponse {
+    interface Data extends Frameio.Share {
+        /** ID for asset added */
+        asset_removed: string;
+    }
+}

package/dist/cjs/api/types/RemoveAssetResponse.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/RenditionMediaLink.d.ts

@@ -0,0 +1,11 @@
+import * 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>
+     * Watermarks may be applied as per Account settings and User permissions.<br>
+     * Media content may be streamed (e.g. when watermarks are required). Clients may issue a
+     * 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;
+}

package/dist/cjs/api/types/RenditionMediaLink.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/RequestAfterOpaqueCursor.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Opaque Cursor query param for requests returning paginated results.
+ * <br/>
+ * NOTE: this value is auto-generated and included as part of links from a previous response. It is not intended to be human readable.
+ */
+export type RequestAfterOpaqueCursor = string | undefined;

package/dist/cjs/api/types/RequestAfterOpaqueCursor.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/RequestPageSize.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Page size query param for requests
+ */
+export type RequestPageSize = number;

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

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