gumnut-sdk 0.1.0

package/src/resources/faces.ts

@@ -0,0 +1,103 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { CursorPage, type CursorPageParams, PagePromise } from '../core/pagination';
+import { buildHeaders } from '../internal/headers';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class Faces extends APIResource {
+  /**
+   * Retrieves details for a specific face.
+   */
+  retrieve(faceID: string, options?: RequestOptions): APIPromise<FaceResponse> {
+    return this._client.get(path`/api/faces/${faceID}`, options);
+  }
+
+  /**
+   * Updates the details of a specific face, currently only supporting
+   * associating/disassociating with a person.
+   */
+  update(faceID: string, body: FaceUpdateParams, options?: RequestOptions): APIPromise<FaceResponse> {
+    return this._client.patch(path`/api/faces/${faceID}`, { body, ...options });
+  }
+
+  /**
+   * Retrieves a paginated list of faces, optionally filtered by asset or person,
+   * ordered by creation time, descending.
+   */
+  list(
+    query: FaceListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<FaceResponsesCursorPage, FaceResponse> {
+    return this._client.getAPIList('/api/faces', CursorPage<FaceResponse>, { query, ...options });
+  }
+
+  /**
+   * Deletes a specific face entry. This does not delete the associated asset or
+   * person.
+   */
+  delete(faceID: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/api/faces/${faceID}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Retrieves a thumbnail for a specific face.
+   */
+  downloadThumbnail(faceID: string, options?: RequestOptions): APIPromise<Response> {
+    return this._client.get(path`/api/faces/${faceID}/thumbnail`, {
+      ...options,
+      headers: buildHeaders([{ Accept: 'image/*' }, options?.headers]),
+      __binaryResponse: true,
+    });
+  }
+}
+
+export type FaceResponsesCursorPage = CursorPage<FaceResponse>;
+
+export interface FaceResponse {
+  id: string;
+
+  asset_id: string;
+
+  bounding_box: Record<string, number>;
+
+  created_at: string;
+
+  updated_at: string;
+
+  person_id?: string | null;
+
+  thumbnail_url?: string | null;
+
+  timestamp_ms?: number | null;
+}
+
+export interface FaceUpdateParams {
+  person_id?: string | null;
+}
+
+export interface FaceListParams extends CursorPageParams {
+  /**
+   * Filter by faces in a specific asset
+   */
+  asset_id?: string | null;
+
+  /**
+   * Filter by faces associated with a specific person
+   */
+  person_id?: string | null;
+}
+
+export declare namespace Faces {
+  export {
+    type FaceResponse as FaceResponse,
+    type FaceResponsesCursorPage as FaceResponsesCursorPage,
+    type FaceUpdateParams as FaceUpdateParams,
+    type FaceListParams as FaceListParams,
+  };
+}

package/src/resources/index.ts

@@ -0,0 +1,35 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { APIKeys, type APIKeyResponse, type APIKeyCreateResponse, type APIKeyListResponse } from './api-keys';
+export {
+  Albums,
+  type AlbumResponse,
+  type AlbumCreateParams,
+  type AlbumUpdateParams,
+  type AlbumListParams,
+  type AlbumResponsesCursorPage,
+} from './albums/albums';
+export {
+  Assets,
+  type AssetResponse,
+  type AssetCreateParams,
+  type AssetListParams,
+  type AssetDownloadThumbnailParams,
+  type AssetResponsesCursorPage,
+} from './assets';
+export {
+  Faces,
+  type FaceResponse,
+  type FaceUpdateParams,
+  type FaceListParams,
+  type FaceResponsesCursorPage,
+} from './faces';
+export {
+  People,
+  type PersonResponse,
+  type PersonCreateParams,
+  type PersonUpdateParams,
+  type PersonListParams,
+  type PersonResponsesCursorPage,
+} from './people';
+export { Search, type SearchResponse, type SearchSearchParams } from './search';

package/src/resources/people.ts

@@ -0,0 +1,120 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { CursorPage, type CursorPageParams, PagePromise } from '../core/pagination';
+import { buildHeaders } from '../internal/headers';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class People extends APIResource {
+  /**
+   * Creates a new person entry.
+   */
+  create(body: PersonCreateParams, options?: RequestOptions): APIPromise<PersonResponse> {
+    return this._client.post('/api/people', { body, ...options });
+  }
+
+  /**
+   * Retrieves details for a specific person.
+   */
+  retrieve(personID: string, options?: RequestOptions): APIPromise<PersonResponse> {
+    return this._client.get(path`/api/people/${personID}`, options);
+  }
+
+  /**
+   * Updates the details of a specific person.
+   */
+  update(personID: string, body: PersonUpdateParams, options?: RequestOptions): APIPromise<PersonResponse> {
+    return this._client.patch(path`/api/people/${personID}`, { body, ...options });
+  }
+
+  /**
+   * Retrieves a paginated list of people, ordered by creation time, descending.
+   */
+  list(
+    query: PersonListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<PersonResponsesCursorPage, PersonResponse> {
+    return this._client.getAPIList('/api/people', CursorPage<PersonResponse>, { query, ...options });
+  }
+
+  /**
+   * Deletes a specific person. Associated faces will have their person_id set to
+   * NULL.
+   */
+  delete(personID: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/api/people/${personID}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+export type PersonResponsesCursorPage = CursorPage<PersonResponse>;
+
+export interface PersonResponse {
+  id: string;
+
+  created_at: string;
+
+  is_favorite: boolean;
+
+  is_hidden: boolean;
+
+  updated_at: string;
+
+  birth_date?: string | null;
+
+  name?: string | null;
+
+  thumbnail_face_id?: string | null;
+
+  thumbnail_face_url?: string | null;
+}
+
+export interface PersonCreateParams {
+  birth_date?: string | null;
+
+  is_favorite?: boolean | null;
+
+  is_hidden?: boolean | null;
+
+  name?: string | null;
+
+  thumbnail_face_id?: string | null;
+}
+
+export interface PersonUpdateParams {
+  birth_date?: string | null;
+
+  is_favorite?: boolean | null;
+
+  is_hidden?: boolean | null;
+
+  name?: string | null;
+
+  thumbnail_face_id?: string | null;
+}
+
+export interface PersonListParams extends CursorPageParams {
+  /**
+   * Include only people associated with this album ID
+   */
+  album_id?: string | null;
+
+  /**
+   * Include only people associated with this asset ID
+   */
+  asset_id?: string | null;
+}
+
+export declare namespace People {
+  export {
+    type PersonResponse as PersonResponse,
+    type PersonResponsesCursorPage as PersonResponsesCursorPage,
+    type PersonCreateParams as PersonCreateParams,
+    type PersonUpdateParams as PersonUpdateParams,
+    type PersonListParams as PersonListParams,
+  };
+}

package/src/resources/search.ts

@@ -0,0 +1,53 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as AssetsAPI from './assets';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+
+export class Search extends APIResource {
+  /**
+   * Searches for assets based on a text query using semantic similarity.
+   */
+  search(query: SearchSearchParams, options?: RequestOptions): APIPromise<SearchResponse> {
+    return this._client.get('/api/search', { query, ...options });
+  }
+}
+
+export interface SearchResponse {
+  data: Array<SearchResponse.Data>;
+}
+
+export namespace SearchResponse {
+  export interface Data {
+    asset: AssetsAPI.AssetResponse;
+
+    distance: number;
+  }
+}
+
+export interface SearchSearchParams {
+  /**
+   * The text query to search for
+   */
+  query: string;
+
+  /**
+   * Number of results per page
+   */
+  limit?: number;
+
+  /**
+   * Page number
+   */
+  page?: number;
+
+  /**
+   * Similarity threshold (lower means more similar)
+   */
+  threshold?: number;
+}
+
+export declare namespace Search {
+  export { type SearchResponse as SearchResponse, type SearchSearchParams as SearchSearchParams };
+}

package/src/resources.ts

@@ -0,0 +1 @@
+export * from './resources/index';

package/src/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  // this config is included in the published src directory to prevent TS errors
+  // from appearing when users go to source, and VSCode opens the source .ts file
+  // via declaration maps
+  "include": ["index.ts"],
+  "compilerOptions": {
+    "target": "ES2015",
+    "lib": ["DOM", "DOM.Iterable", "ES2018"],
+    "moduleResolution": "node"
+  }
+}

package/src/uploads.ts

@@ -0,0 +1,2 @@
+/** @deprecated Import from ./core/uploads instead */
+export * from './core/uploads';

package/src/version.ts

@@ -0,0 +1 @@
+export const VERSION = '0.1.0'; // x-release-please-version

package/uploads.d.mts

@@ -0,0 +1,2 @@
+export * from "./core/uploads.mjs";
+//# sourceMappingURL=uploads.d.mts.map

package/uploads.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploads.d.mts","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":""}

package/uploads.d.ts

@@ -0,0 +1,2 @@
+export * from "./core/uploads.js";
+//# sourceMappingURL=uploads.d.ts.map

package/uploads.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploads.d.ts","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":""}

package/uploads.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("./internal/tslib.js");
+/** @deprecated Import from ./core/uploads instead */
+tslib_1.__exportStar(require("./core/uploads.js"), exports);
+//# sourceMappingURL=uploads.js.map

package/uploads.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploads.js","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":";;;AAAA,qDAAqD;AACrD,4DAA+B"}

package/uploads.mjs

@@ -0,0 +1,2 @@
+export * from "./core/uploads.mjs";
+//# sourceMappingURL=uploads.mjs.map

package/uploads.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploads.mjs","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":""}

package/version.d.mts

@@ -0,0 +1,2 @@
+export declare const VERSION = "0.1.0";
+//# sourceMappingURL=version.d.mts.map

package/version.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.d.mts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,UAAU,CAAC"}

package/version.d.ts

@@ -0,0 +1,2 @@
+export declare const VERSION = "0.1.0";
+//# sourceMappingURL=version.d.ts.map

package/version.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,UAAU,CAAC"}

package/version.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VERSION = void 0;
+exports.VERSION = '0.1.0'; // x-release-please-version
+//# sourceMappingURL=version.js.map

package/version.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.js","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,OAAO,CAAC,CAAC,2BAA2B"}

package/version.mjs

@@ -0,0 +1,2 @@
+export const VERSION = '0.1.0'; // x-release-please-version
+//# sourceMappingURL=version.mjs.map

package/version.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.mjs","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,2BAA2B"}