frameio 4.2.0 → 4.2.1

package/dist/esm/api/resources/projectPermissions/types/index.d.mts

@@ -0,0 +1 @@
+export * from "./ProjectPermissionsIndexRequestSort.mjs";

package/dist/esm/api/resources/projectPermissions/types/index.mjs

@@ -0,0 +1 @@
+export * from "./ProjectPermissionsIndexRequestSort.mjs";

package/dist/esm/api/resources/projects/client/Client.d.mts

@@ -16,8 +16,8 @@ export declare class ProjectsClient {
     /**
      * Show project details. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
      *
-     * @param {Frameio.Uuid} account_id
-     * @param {Frameio.Uuid} project_id
+     * @param {Frameio.FrameOrAdobeId} account_id
+     * @param {Frameio.FrameOrAdobeId} project_id
      * @param {Frameio.ProjectsShowRequest} request
      * @param {ProjectsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -34,13 +34,13 @@ export declare class ProjectsClient {
      *         include: "owner"
      *     })
      */
-    show(account_id: Frameio.Uuid, project_id: Frameio.Uuid, request?: Frameio.ProjectsShowRequest, requestOptions?: ProjectsClient.RequestOptions): core.HttpResponsePromise<Frameio.ProjectWithIncludesResponse>;
+    show(account_id: Frameio.FrameOrAdobeId, project_id: Frameio.FrameOrAdobeId, request?: Frameio.ProjectsShowRequest, requestOptions?: ProjectsClient.RequestOptions): core.HttpResponsePromise<Frameio.ProjectWithIncludesResponse>;
     private __show;
     /**
      * Delete a project. <br/>Rate Limits: 60 calls per 1.00 minute(s) per account_user
      *
-     * @param {Frameio.Uuid} account_id
-     * @param {Frameio.Uuid} project_id
+     * @param {Frameio.FrameOrAdobeId} account_id
+     * @param {Frameio.FrameOrAdobeId} project_id
      * @param {ProjectsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Frameio.BadRequestError}
@@ -54,13 +54,13 @@ export declare class ProjectsClient {
      * @example
      *     await client.projects.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b")
      */
-    delete(account_id: Frameio.Uuid, project_id: Frameio.Uuid, requestOptions?: ProjectsClient.RequestOptions): core.HttpResponsePromise<void>;
+    delete(account_id: Frameio.FrameOrAdobeId, project_id: Frameio.FrameOrAdobeId, requestOptions?: ProjectsClient.RequestOptions): core.HttpResponsePromise<void>;
     private __delete;
     /**
      * Update project details. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
      *
-     * @param {Frameio.Uuid} account_id
-     * @param {Frameio.Uuid} project_id
+     * @param {Frameio.FrameOrAdobeId} account_id
+     * @param {Frameio.FrameOrAdobeId} project_id
      * @param {Frameio.ProjectUpdateParams} request
      * @param {ProjectsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -81,12 +81,12 @@ export declare class ProjectsClient {
      *         }
      *     })
      */
-    update(account_id: Frameio.Uuid, project_id: Frameio.Uuid, request: Frameio.ProjectUpdateParams, requestOptions?: ProjectsClient.RequestOptions): core.HttpResponsePromise<Frameio.ProjectResponse>;
+    update(account_id: Frameio.FrameOrAdobeId, project_id: Frameio.FrameOrAdobeId, request: Frameio.ProjectUpdateParams, requestOptions?: ProjectsClient.RequestOptions): core.HttpResponsePromise<Frameio.ProjectResponse>;
     private __update;
     /**
      * List projects in a given workspace. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
      *
-     * @param {Frameio.Uuid} account_id
+     * @param {Frameio.FrameOrAdobeId} account_id
      * @param {Frameio.Uuid} workspace_id
      * @param {Frameio.ProjectsIndexRequest} request
      * @param {ProjectsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -102,16 +102,17 @@ export declare class ProjectsClient {
      * @example
      *     await client.projects.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
      *         include: "owner",
+     *         sort: "name_asc",
      *         after: "<opaque_cursor>",
      *         page_size: 10,
      *         include_total_count: false
      *     })
      */
-    index(account_id: Frameio.Uuid, workspace_id: Frameio.Uuid, _request?: Frameio.ProjectsIndexRequest, requestOptions?: ProjectsClient.RequestOptions): Promise<core.Page<Frameio.ProjectWithIncludes, Frameio.ProjectsWithIncludesResponse>>;
+    index(account_id: Frameio.FrameOrAdobeId, workspace_id: Frameio.Uuid, _request?: Frameio.ProjectsIndexRequest, requestOptions?: ProjectsClient.RequestOptions): Promise<core.Page<Frameio.ProjectWithIncludes, Frameio.ProjectsWithIncludesResponse>>;
     /**
      * Create project in a given workspace. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
      *
-     * @param {Frameio.Uuid} account_id
+     * @param {Frameio.FrameOrAdobeId} account_id
      * @param {Frameio.Uuid} workspace_id
      * @param {Frameio.ProjectParams} request
      * @param {ProjectsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -132,6 +133,6 @@ export declare class ProjectsClient {
      *         }
      *     })
      */
-    create(account_id: Frameio.Uuid, workspace_id: Frameio.Uuid, request: Frameio.ProjectParams, requestOptions?: ProjectsClient.RequestOptions): core.HttpResponsePromise<Frameio.ProjectResponse>;
+    create(account_id: Frameio.FrameOrAdobeId, workspace_id: Frameio.Uuid, request: Frameio.ProjectParams, requestOptions?: ProjectsClient.RequestOptions): core.HttpResponsePromise<Frameio.ProjectResponse>;
     private __create;
 }

package/dist/esm/api/resources/projects/client/Client.mjs

@@ -25,8 +25,8 @@ export class ProjectsClient {
     /**
      * Show project details. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
      *
-     * @param {Frameio.Uuid} account_id
-     * @param {Frameio.Uuid} project_id
+     * @param {Frameio.FrameOrAdobeId} account_id
+     * @param {Frameio.FrameOrAdobeId} project_id
      * @param {Frameio.ProjectsShowRequest} request
      * @param {ProjectsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -99,8 +99,8 @@ export class ProjectsClient {
     /**
      * Delete a project. <br/>Rate Limits: 60 calls per 1.00 minute(s) per account_user
      *
-     * @param {Frameio.Uuid} account_id
-     * @param {Frameio.Uuid} project_id
+     * @param {Frameio.FrameOrAdobeId} account_id
+     * @param {Frameio.FrameOrAdobeId} project_id
      * @param {ProjectsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Frameio.BadRequestError}
@@ -166,8 +166,8 @@ export class ProjectsClient {
     /**
      * Update project details. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
      *
-     * @param {Frameio.Uuid} account_id
-     * @param {Frameio.Uuid} project_id
+     * @param {Frameio.FrameOrAdobeId} account_id
+     * @param {Frameio.FrameOrAdobeId} project_id
      * @param {Frameio.ProjectUpdateParams} request
      * @param {ProjectsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -243,7 +243,7 @@ export class ProjectsClient {
     /**
      * List projects in a given workspace. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
      *
-     * @param {Frameio.Uuid} account_id
+     * @param {Frameio.FrameOrAdobeId} account_id
      * @param {Frameio.Uuid} workspace_id
      * @param {Frameio.ProjectsIndexRequest} request
      * @param {ProjectsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -259,6 +259,7 @@ export class ProjectsClient {
      * @example
      *     await client.projects.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
      *         include: "owner",
+     *         sort: "name_asc",
      *         after: "<opaque_cursor>",
      *         page_size: 10,
      *         include_total_count: false
@@ -329,7 +330,7 @@ export class ProjectsClient {
     /**
      * Create project in a given workspace. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
      *
-     * @param {Frameio.Uuid} account_id
+     * @param {Frameio.FrameOrAdobeId} account_id
      * @param {Frameio.Uuid} workspace_id
      * @param {Frameio.ProjectParams} request
      * @param {ProjectsClient.RequestOptions} requestOptions - Request-specific configuration.

package/dist/esm/api/resources/projects/client/requests/ProjectsIndexRequest.d.mts

@@ -3,6 +3,7 @@ import type * as Frameio from "../../../../index.mjs";
  * @example
  *     {
  *         include: "owner",
+ *         sort: "name_asc",
  *         after: "<opaque_cursor>",
  *         page_size: 10,
  *         include_total_count: false
@@ -10,6 +11,8 @@ import type * as Frameio from "../../../../index.mjs";
  */
 export interface ProjectsIndexRequest {
     include?: "owner";
+    /** Sort projects by query params */
+    sort?: Frameio.ProjectsIndexRequestSort;
     /**
      * Opaque Cursor query param for requests returning paginated results.
      * <br/>

package/dist/esm/api/resources/projects/index.d.mts

@@ -1 +1,2 @@
 export * from "./client/index.mjs";
+export * from "./types/index.mjs";

package/dist/esm/api/resources/projects/index.mjs

@@ -1 +1,2 @@
 export * from "./client/index.mjs";
+export * from "./types/index.mjs";

package/dist/esm/api/resources/projects/types/ProjectsIndexRequestSort.d.mts

@@ -0,0 +1,8 @@
+/** Sort query parameter for projects */
+export declare const ProjectsIndexRequestSort: {
+    readonly NameAsc: "name_asc";
+    readonly CreatedAtAsc: "created_at_asc";
+    readonly NameDesc: "name_desc";
+    readonly CreatedAtDesc: "created_at_desc";
+};
+export type ProjectsIndexRequestSort = (typeof ProjectsIndexRequestSort)[keyof typeof ProjectsIndexRequestSort];

package/dist/esm/api/resources/projects/types/ProjectsIndexRequestSort.mjs

@@ -0,0 +1,8 @@
+// This file was auto-generated by Fern from our API Definition.
+/** Sort query parameter for projects */
+export const ProjectsIndexRequestSort = {
+    NameAsc: "name_asc",
+    CreatedAtAsc: "created_at_asc",
+    NameDesc: "name_desc",
+    CreatedAtDesc: "created_at_desc",
+};

package/dist/esm/api/resources/projects/types/index.d.mts

@@ -0,0 +1 @@
+export * from "./ProjectsIndexRequestSort.mjs";

package/dist/esm/api/resources/projects/types/index.mjs

@@ -0,0 +1 @@
+export * from "./ProjectsIndexRequestSort.mjs";

package/dist/esm/api/resources/search/client/Client.d.mts

@@ -0,0 +1,48 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.mjs";
+import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.mjs";
+import * as core from "../../../../core/index.mjs";
+import * as Frameio from "../../../index.mjs";
+export declare namespace SearchClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+/**
+ * Manage Search and related operations.
+ */
+export declare class SearchClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<SearchClient.Options>;
+    constructor(options: SearchClient.Options);
+    /**
+     * Search across assets, folders, and projects within an account.
+     * Rate Limits: 100 calls per 1.00 minute(s) per account_user
+     *
+     * @param {Frameio.Uuid} account_id
+     * @param {Frameio.SearchParams} request
+     * @param {SearchClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Frameio.BadRequestError}
+     * @throws {@link Frameio.UnauthorizedError}
+     * @throws {@link Frameio.ForbiddenError}
+     * @throws {@link Frameio.NotFoundError}
+     * @throws {@link Frameio.ConflictError}
+     * @throws {@link Frameio.UnprocessableEntityError}
+     * @throws {@link Frameio.TooManyRequestsError}
+     *
+     * @example
+     *     await client.search.search("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
+     *         after: "<opaque_cursor>",
+     *         page_size: 10,
+     *         include_total_count: false,
+     *         engine: "nlp",
+     *         filters: {
+     *             files_and_version_stacks: true,
+     *             folders: false,
+     *             projects: false
+     *         },
+     *         query: "red car driving on highway"
+     *     })
+     */
+    search(account_id: Frameio.Uuid, request: Frameio.SearchParams, requestOptions?: SearchClient.RequestOptions): core.HttpResponsePromise<Frameio.SearchResponse>;
+    private __search;
+}

package/dist/esm/api/resources/search/client/Client.mjs

@@ -0,0 +1,124 @@
+// This file was auto-generated by Fern from our API Definition.
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+import { normalizeClientOptionsWithAuth } from "../../../../BaseClient.mjs";
+import { mergeHeaders, mergeOnlyDefinedHeaders } from "../../../../core/headers.mjs";
+import * as core from "../../../../core/index.mjs";
+import * as environments from "../../../../environments.mjs";
+import { handleNonStatusCodeError } from "../../../../errors/handleNonStatusCodeError.mjs";
+import * as errors from "../../../../errors/index.mjs";
+import * as Frameio from "../../../index.mjs";
+/**
+ * Manage Search and related operations.
+ */
+export class SearchClient {
+    constructor(options) {
+        this._options = normalizeClientOptionsWithAuth(options);
+    }
+    /**
+     * Search across assets, folders, and projects within an account.
+     * Rate Limits: 100 calls per 1.00 minute(s) per account_user
+     *
+     * @param {Frameio.Uuid} account_id
+     * @param {Frameio.SearchParams} request
+     * @param {SearchClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Frameio.BadRequestError}
+     * @throws {@link Frameio.UnauthorizedError}
+     * @throws {@link Frameio.ForbiddenError}
+     * @throws {@link Frameio.NotFoundError}
+     * @throws {@link Frameio.ConflictError}
+     * @throws {@link Frameio.UnprocessableEntityError}
+     * @throws {@link Frameio.TooManyRequestsError}
+     *
+     * @example
+     *     await client.search.search("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
+     *         after: "<opaque_cursor>",
+     *         page_size: 10,
+     *         include_total_count: false,
+     *         engine: "nlp",
+     *         filters: {
+     *             files_and_version_stacks: true,
+     *             folders: false,
+     *             projects: false
+     *         },
+     *         query: "red car driving on highway"
+     *     })
+     */
+    search(account_id, request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__search(account_id, request, requestOptions));
+    }
+    __search(account_id, request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
+            const { after, page_size: pageSize, include_total_count: includeTotalCount } = request, _body = __rest(request, ["after", "page_size", "include_total_count"]);
+            const _queryParams = {
+                after,
+                page_size: pageSize,
+                include_total_count: includeTotalCount,
+            };
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({ "user-agent": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.userAgent) !== null && _b !== void 0 ? _b : "frameio-ts" }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield ((_c = this._options.fetcher) !== null && _c !== void 0 ? _c : core.fetcher)({
+                url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.FrameioEnvironment.Default, `v4/accounts/${core.url.encodePathParam(account_id)}/search`),
+                method: "POST",
+                headers: _headers,
+                contentType: "application/json",
+                queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
+                requestType: "json",
+                body: _body,
+                timeoutMs: ((_h = (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.timeoutInSeconds) !== null && _h !== void 0 ? _h : 60) * 1000,
+                maxRetries: (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_l = this._options) === null || _l === void 0 ? void 0 : _l.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return { data: _response.body, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 400:
+                        throw new Frameio.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 401:
+                        throw new Frameio.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 403:
+                        throw new Frameio.ForbiddenError(_response.error.body, _response.rawResponse);
+                    case 404:
+                        throw new Frameio.NotFoundError(_response.error.body, _response.rawResponse);
+                    case 409:
+                        throw new Frameio.ConflictError(_response.error.body, _response.rawResponse);
+                    case 422:
+                        throw new Frameio.UnprocessableEntityError(_response.error.body, _response.rawResponse);
+                    case 429:
+                        throw new Frameio.TooManyRequestsError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.FrameioError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v4/accounts/{account_id}/search");
+        });
+    }
+}

package/dist/esm/api/resources/search/client/index.d.mts

@@ -0,0 +1 @@
+export * from "./requests/index.mjs";

package/dist/esm/api/resources/search/client/index.mjs

@@ -0,0 +1 @@
+export * from "./requests/index.mjs";

package/dist/esm/api/resources/search/client/requests/SearchParams.d.mts

@@ -0,0 +1,51 @@
+import type * as Frameio from "../../../../index.mjs";
+/**
+ * @example
+ *     {
+ *         after: "<opaque_cursor>",
+ *         page_size: 10,
+ *         include_total_count: false,
+ *         engine: "nlp",
+ *         filters: {
+ *             files_and_version_stacks: true,
+ *             folders: false,
+ *             projects: false
+ *         },
+ *         query: "red car driving on highway"
+ *     }
+ */
+export interface SearchParams {
+    /**
+     * 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.
+     */
+    after?: Frameio.RequestAfterOpaqueCursor | undefined;
+    page_size?: Frameio.RequestPageSize;
+    include_total_count?: Frameio.IncludeTotalCount;
+    /** Search engine to use. Available engines: lexical, nlp. */
+    engine: SearchParams.Engine;
+    /** Filters to control which types of results are returned */
+    filters?: SearchParams.Filters;
+    /** The search query text */
+    query: string;
+}
+export declare namespace SearchParams {
+    /** Search engine to use. Available engines: lexical, nlp. */
+    const Engine: {
+        readonly Lexical: "lexical";
+        readonly Nlp: "nlp";
+    };
+    type Engine = (typeof Engine)[keyof typeof Engine];
+    /**
+     * Filters to control which types of results are returned
+     */
+    interface Filters {
+        /** Include files and version stacks in search results */
+        files_and_version_stacks?: boolean | undefined;
+        /** Include folders in search results */
+        folders?: boolean | undefined;
+        /** Include projects in search results */
+        projects?: boolean | undefined;
+    }
+}

package/dist/esm/api/resources/search/client/requests/SearchParams.mjs

@@ -0,0 +1,9 @@
+// This file was auto-generated by Fern from our API Definition.
+export var SearchParams;
+(function (SearchParams) {
+    /** Search engine to use. Available engines: lexical, nlp. */
+    SearchParams.Engine = {
+        Lexical: "lexical",
+        Nlp: "nlp",
+    };
+})(SearchParams || (SearchParams = {}));

package/dist/esm/api/resources/search/client/requests/index.d.mts

@@ -0,0 +1 @@
+export { SearchParams } from "./SearchParams.mjs";

package/dist/esm/api/resources/search/client/requests/index.mjs

@@ -0,0 +1 @@
+export { SearchParams } from "./SearchParams.mjs";

package/dist/esm/api/resources/search/exports.d.mts

@@ -0,0 +1,2 @@
+export { SearchClient } from "./client/Client.mjs";
+export * from "./client/index.mjs";

package/dist/esm/api/resources/search/exports.mjs

@@ -0,0 +1,3 @@
+// This file was auto-generated by Fern from our API Definition.
+export { SearchClient } from "./client/Client.mjs";
+export * from "./client/index.mjs";

package/dist/esm/api/resources/search/index.d.mts

@@ -0,0 +1 @@
+export * from "./client/index.mjs";

package/dist/esm/api/resources/search/index.mjs

@@ -0,0 +1 @@
+export * from "./client/index.mjs";