@depup/openai 6.31.0-depup.0

package/src/resources/skills/skills.ts

@@ -0,0 +1,191 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as ContentAPI from './content';
+import { Content } from './content';
+import * as VersionsAPI from './versions/versions';
+import {
+  DeletedSkillVersion,
+  SkillVersion,
+  SkillVersionList,
+  SkillVersionsPage,
+  VersionCreateParams,
+  VersionDeleteParams,
+  VersionListParams,
+  VersionRetrieveParams,
+  Versions,
+} from './versions/versions';
+import { APIPromise } from '../../core/api-promise';
+import { CursorPage, type CursorPageParams, PagePromise } from '../../core/pagination';
+import { type Uploadable } from '../../core/uploads';
+import { RequestOptions } from '../../internal/request-options';
+import { maybeMultipartFormRequestOptions } from '../../internal/uploads';
+import { path } from '../../internal/utils/path';
+
+export class Skills extends APIResource {
+  content: ContentAPI.Content = new ContentAPI.Content(this._client);
+  versions: VersionsAPI.Versions = new VersionsAPI.Versions(this._client);
+
+  /**
+   * Create a new skill.
+   */
+  create(body: SkillCreateParams | null | undefined = {}, options?: RequestOptions): APIPromise<Skill> {
+    return this._client.post('/skills', maybeMultipartFormRequestOptions({ body, ...options }, this._client));
+  }
+
+  /**
+   * Get a skill by its ID.
+   */
+  retrieve(skillID: string, options?: RequestOptions): APIPromise<Skill> {
+    return this._client.get(path`/skills/${skillID}`, options);
+  }
+
+  /**
+   * Update the default version pointer for a skill.
+   */
+  update(skillID: string, body: SkillUpdateParams, options?: RequestOptions): APIPromise<Skill> {
+    return this._client.post(path`/skills/${skillID}`, { body, ...options });
+  }
+
+  /**
+   * List all skills for the current project.
+   */
+  list(
+    query: SkillListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<SkillsPage, Skill> {
+    return this._client.getAPIList('/skills', CursorPage<Skill>, { query, ...options });
+  }
+
+  /**
+   * Delete a skill by its ID.
+   */
+  delete(skillID: string, options?: RequestOptions): APIPromise<DeletedSkill> {
+    return this._client.delete(path`/skills/${skillID}`, options);
+  }
+}
+
+export type SkillsPage = CursorPage<Skill>;
+
+export interface DeletedSkill {
+  id: string;
+
+  deleted: boolean;
+
+  object: 'skill.deleted';
+}
+
+export interface Skill {
+  /**
+   * Unique identifier for the skill.
+   */
+  id: string;
+
+  /**
+   * Unix timestamp (seconds) for when the skill was created.
+   */
+  created_at: number;
+
+  /**
+   * Default version for the skill.
+   */
+  default_version: string;
+
+  /**
+   * Description of the skill.
+   */
+  description: string;
+
+  /**
+   * Latest version for the skill.
+   */
+  latest_version: string;
+
+  /**
+   * Name of the skill.
+   */
+  name: string;
+
+  /**
+   * The object type, which is `skill`.
+   */
+  object: 'skill';
+}
+
+export interface SkillList {
+  /**
+   * A list of items
+   */
+  data: Array<Skill>;
+
+  /**
+   * The ID of the first item in the list.
+   */
+  first_id: string | null;
+
+  /**
+   * Whether there are more items available.
+   */
+  has_more: boolean;
+
+  /**
+   * The ID of the last item in the list.
+   */
+  last_id: string | null;
+
+  /**
+   * The type of object returned, must be `list`.
+   */
+  object: 'list';
+}
+
+export interface SkillCreateParams {
+  /**
+   * Skill files to upload (directory upload) or a single zip file.
+   */
+  files?: Array<Uploadable> | Uploadable;
+}
+
+export interface SkillUpdateParams {
+  /**
+   * The skill version number to set as default.
+   */
+  default_version: string;
+}
+
+export interface SkillListParams extends CursorPageParams {
+  /**
+   * Sort order of results by timestamp. Use `asc` for ascending order or `desc` for
+   * descending order.
+   */
+  order?: 'asc' | 'desc';
+}
+
+Skills.Content = Content;
+Skills.Versions = Versions;
+
+export declare namespace Skills {
+  export {
+    type DeletedSkill as DeletedSkill,
+    type Skill as Skill,
+    type SkillList as SkillList,
+    type SkillsPage as SkillsPage,
+    type SkillCreateParams as SkillCreateParams,
+    type SkillUpdateParams as SkillUpdateParams,
+    type SkillListParams as SkillListParams,
+  };
+
+  export { Content as Content };
+
+  export {
+    Versions as Versions,
+    type DeletedSkillVersion as DeletedSkillVersion,
+    type SkillVersion as SkillVersion,
+    type SkillVersionList as SkillVersionList,
+    type SkillVersionsPage as SkillVersionsPage,
+    type VersionCreateParams as VersionCreateParams,
+    type VersionRetrieveParams as VersionRetrieveParams,
+    type VersionListParams as VersionListParams,
+    type VersionDeleteParams as VersionDeleteParams,
+  };
+}

package/src/resources/skills/versions/content.ts

@@ -0,0 +1,32 @@
+// 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 { buildHeaders } from '../../../internal/headers';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+export class Content extends APIResource {
+  /**
+   * Download a skill version zip bundle.
+   */
+  retrieve(version: string, params: ContentRetrieveParams, options?: RequestOptions): APIPromise<Response> {
+    const { skill_id } = params;
+    return this._client.get(path`/skills/${skill_id}/versions/${version}/content`, {
+      ...options,
+      headers: buildHeaders([{ Accept: 'application/binary' }, options?.headers]),
+      __binaryResponse: true,
+    });
+  }
+}
+
+export interface ContentRetrieveParams {
+  /**
+   * The identifier of the skill.
+   */
+  skill_id: string;
+}
+
+export declare namespace Content {
+  export { type ContentRetrieveParams as ContentRetrieveParams };
+}

package/src/resources/skills/versions/index.ts

@@ -0,0 +1,14 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Content, type ContentRetrieveParams } from './content';
+export {
+  Versions,
+  type DeletedSkillVersion,
+  type SkillVersion,
+  type SkillVersionList,
+  type VersionCreateParams,
+  type VersionRetrieveParams,
+  type VersionListParams,
+  type VersionDeleteParams,
+  type SkillVersionsPage,
+} from './versions';

package/src/resources/skills/versions/versions.ts

@@ -0,0 +1,196 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as ContentAPI from './content';
+import { Content, ContentRetrieveParams } from './content';
+import { APIPromise } from '../../../core/api-promise';
+import { CursorPage, type CursorPageParams, PagePromise } from '../../../core/pagination';
+import { type Uploadable } from '../../../core/uploads';
+import { RequestOptions } from '../../../internal/request-options';
+import { maybeMultipartFormRequestOptions } from '../../../internal/uploads';
+import { path } from '../../../internal/utils/path';
+
+export class Versions extends APIResource {
+  content: ContentAPI.Content = new ContentAPI.Content(this._client);
+
+  /**
+   * Create a new immutable skill version.
+   */
+  create(
+    skillID: string,
+    body: VersionCreateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<SkillVersion> {
+    return this._client.post(
+      path`/skills/${skillID}/versions`,
+      maybeMultipartFormRequestOptions({ body, ...options }, this._client),
+    );
+  }
+
+  /**
+   * Get a specific skill version.
+   */
+  retrieve(
+    version: string,
+    params: VersionRetrieveParams,
+    options?: RequestOptions,
+  ): APIPromise<SkillVersion> {
+    const { skill_id } = params;
+    return this._client.get(path`/skills/${skill_id}/versions/${version}`, options);
+  }
+
+  /**
+   * List skill versions for a skill.
+   */
+  list(
+    skillID: string,
+    query: VersionListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<SkillVersionsPage, SkillVersion> {
+    return this._client.getAPIList(path`/skills/${skillID}/versions`, CursorPage<SkillVersion>, {
+      query,
+      ...options,
+    });
+  }
+
+  /**
+   * Delete a skill version.
+   */
+  delete(
+    version: string,
+    params: VersionDeleteParams,
+    options?: RequestOptions,
+  ): APIPromise<DeletedSkillVersion> {
+    const { skill_id } = params;
+    return this._client.delete(path`/skills/${skill_id}/versions/${version}`, options);
+  }
+}
+
+export type SkillVersionsPage = CursorPage<SkillVersion>;
+
+export interface DeletedSkillVersion {
+  id: string;
+
+  deleted: boolean;
+
+  object: 'skill.version.deleted';
+
+  /**
+   * The deleted skill version.
+   */
+  version: string;
+}
+
+export interface SkillVersion {
+  /**
+   * Unique identifier for the skill version.
+   */
+  id: string;
+
+  /**
+   * Unix timestamp (seconds) for when the version was created.
+   */
+  created_at: number;
+
+  /**
+   * Description of the skill version.
+   */
+  description: string;
+
+  /**
+   * Name of the skill version.
+   */
+  name: string;
+
+  /**
+   * The object type, which is `skill.version`.
+   */
+  object: 'skill.version';
+
+  /**
+   * Identifier of the skill for this version.
+   */
+  skill_id: string;
+
+  /**
+   * Version number for this skill.
+   */
+  version: string;
+}
+
+export interface SkillVersionList {
+  /**
+   * A list of items
+   */
+  data: Array<SkillVersion>;
+
+  /**
+   * The ID of the first item in the list.
+   */
+  first_id: string | null;
+
+  /**
+   * Whether there are more items available.
+   */
+  has_more: boolean;
+
+  /**
+   * The ID of the last item in the list.
+   */
+  last_id: string | null;
+
+  /**
+   * The type of object returned, must be `list`.
+   */
+  object: 'list';
+}
+
+export interface VersionCreateParams {
+  /**
+   * Whether to set this version as the default.
+   */
+  default?: boolean;
+
+  /**
+   * Skill files to upload (directory upload) or a single zip file.
+   */
+  files?: Array<Uploadable> | Uploadable;
+}
+
+export interface VersionRetrieveParams {
+  /**
+   * The identifier of the skill.
+   */
+  skill_id: string;
+}
+
+export interface VersionListParams extends CursorPageParams {
+  /**
+   * Sort order of results by version number.
+   */
+  order?: 'asc' | 'desc';
+}
+
+export interface VersionDeleteParams {
+  /**
+   * The identifier of the skill.
+   */
+  skill_id: string;
+}
+
+Versions.Content = Content;
+
+export declare namespace Versions {
+  export {
+    type DeletedSkillVersion as DeletedSkillVersion,
+    type SkillVersion as SkillVersion,
+    type SkillVersionList as SkillVersionList,
+    type SkillVersionsPage as SkillVersionsPage,
+    type VersionCreateParams as VersionCreateParams,
+    type VersionRetrieveParams as VersionRetrieveParams,
+    type VersionListParams as VersionListParams,
+    type VersionDeleteParams as VersionDeleteParams,
+  };
+
+  export { Content as Content, type ContentRetrieveParams as ContentRetrieveParams };
+}

package/src/resources/skills/versions.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './versions/index';

package/src/resources/skills.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './skills/index';

package/src/resources/uploads/index.ts

@@ -0,0 +1,4 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Parts, type UploadPart, type PartCreateParams } from './parts';
+export { Uploads, type Upload, type UploadCreateParams, type UploadCompleteParams } from './uploads';

package/src/resources/uploads/parts.ts

@@ -0,0 +1,69 @@
+// 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 { type Uploadable } from '../../core/uploads';
+import { RequestOptions } from '../../internal/request-options';
+import { multipartFormRequestOptions } from '../../internal/uploads';
+import { path } from '../../internal/utils/path';
+
+/**
+ * Use Uploads to upload large files in multiple parts.
+ */
+export class Parts extends APIResource {
+  /**
+   * Adds a
+   * [Part](https://platform.openai.com/docs/api-reference/uploads/part-object) to an
+   * [Upload](https://platform.openai.com/docs/api-reference/uploads/object) object.
+   * A Part represents a chunk of bytes from the file you are trying to upload.
+   *
+   * Each Part can be at most 64 MB, and you can add Parts until you hit the Upload
+   * maximum of 8 GB.
+   *
+   * It is possible to add multiple Parts in parallel. You can decide the intended
+   * order of the Parts when you
+   * [complete the Upload](https://platform.openai.com/docs/api-reference/uploads/complete).
+   */
+  create(uploadID: string, body: PartCreateParams, options?: RequestOptions): APIPromise<UploadPart> {
+    return this._client.post(
+      path`/uploads/${uploadID}/parts`,
+      multipartFormRequestOptions({ body, ...options }, this._client),
+    );
+  }
+}
+
+/**
+ * The upload Part represents a chunk of bytes we can add to an Upload object.
+ */
+export interface UploadPart {
+  /**
+   * The upload Part unique identifier, which can be referenced in API endpoints.
+   */
+  id: string;
+
+  /**
+   * The Unix timestamp (in seconds) for when the Part was created.
+   */
+  created_at: number;
+
+  /**
+   * The object type, which is always `upload.part`.
+   */
+  object: 'upload.part';
+
+  /**
+   * The ID of the Upload object that this Part was added to.
+   */
+  upload_id: string;
+}
+
+export interface PartCreateParams {
+  /**
+   * The chunk of bytes for this Part.
+   */
+  data: Uploadable;
+}
+
+export declare namespace Parts {
+  export { type UploadPart as UploadPart, type PartCreateParams as PartCreateParams };
+}