Merge pull request #1548 from openai/release-please--branches--master--changes--next--components--openai

release: 5.5.0

Author: kwhinnery-openai

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "5.4.0"
+  ".": "5.5.0"
 }

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 111
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-9e41d2d5471d2c28bff0d616f4476f5b0e6c541ef4cb51bdaaef5fdf5e13c8b2.yml
 openapi_spec_hash: 86f765e18d00e32cf2ce9db7ab84d946
-config_hash: fd2af1d5eff0995bb7dc02ac9a34851d
+config_hash: dc5515e257676a27cb1ace1784aa92b3

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 5.5.0 (2025-06-16)
+
+Full Changelog: [v5.4.0...v5.5.0](https://github.com/openai/openai-node/compare/v5.4.0...v5.5.0)
+
+### Features
+
+* **api:** manual updates ([ab6b57c](https://github.com/openai/openai-node/commit/ab6b57c241dc7c57e411fae572842da801e9828b))
+
 ## 5.4.0 (2025-06-16)
 
 Full Changelog: [v5.3.0...v5.4.0](https://github.com/openai/openai-node/compare/v5.3.0...v5.4.0)

api.md

@@ -259,7 +259,7 @@ Types:
 Methods:
 
 - <code title="post /fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions">client.fineTuning.checkpoints.permissions.<a href="./src/resources/fine-tuning/checkpoints/permissions.ts">create</a>(fineTunedModelCheckpoint, { ...params }) -> PermissionCreateResponsesPage</code>
-- <code title="get /fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions">client.fineTuning.checkpoints.permissions.<a href="./src/resources/fine-tuning/checkpoints/permissions.ts">retrieve</a>(fineTunedModelCheckpoint, { ...params }) -> PermissionRetrieveResponse</code>
+- <code title="get /fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions">client.fineTuning.checkpoints.permissions.<a href="./src/resources/fine-tuning/checkpoints/permissions.ts">retrieve</a>(fineTunedModelCheckpoint, { ...params }) -> PermissionRetrieveResponsesPage</code>
 - <code title="delete /fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions/{permission_id}">client.fineTuning.checkpoints.permissions.<a href="./src/resources/fine-tuning/checkpoints/permissions.ts">delete</a>(permissionID, { ...params }) -> PermissionDeleteResponse</code>
 
 ## Alpha

jsr.json

@@ -1,6 +1,6 @@
 {
   "name": "@openai/openai",
-  "version": "5.4.0",
+  "version": "5.5.0",
   "exports": {
     ".": "./index.ts",
     "./helpers/zod": "./helpers/zod.ts",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "openai",
-  "version": "5.4.0",
+  "version": "5.5.0",
   "description": "The official TypeScript library for the OpenAI API",
   "author": "OpenAI <[email protected]>",
   "types": "dist/index.d.ts",

src/resources/fine-tuning/checkpoints/checkpoints.ts

@@ -10,6 +10,7 @@ import {
   PermissionDeleteResponse,
   PermissionRetrieveParams,
   PermissionRetrieveResponse,
+  PermissionRetrieveResponsesPage,
   Permissions,
 } from './permissions';
 
@@ -26,6 +27,7 @@ export declare namespace Checkpoints {
     type PermissionRetrieveResponse as PermissionRetrieveResponse,
     type PermissionDeleteResponse as PermissionDeleteResponse,
     type PermissionCreateResponsesPage as PermissionCreateResponsesPage,
+    type PermissionRetrieveResponsesPage as PermissionRetrieveResponsesPage,
     type PermissionCreateParams as PermissionCreateParams,
     type PermissionRetrieveParams as PermissionRetrieveParams,
     type PermissionDeleteParams as PermissionDeleteParams,

src/resources/fine-tuning/checkpoints/index.ts

@@ -10,4 +10,5 @@ export {
   type PermissionRetrieveParams,
   type PermissionDeleteParams,
   type PermissionCreateResponsesPage,
+  type PermissionRetrieveResponsesPage,
 } from './permissions';

src/resources/fine-tuning/checkpoints/permissions.ts

@@ -2,7 +2,7 @@
 
 import { APIResource } from '../../../core/resource';
 import { APIPromise } from '../../../core/api-promise';
-import { Page, PagePromise } from '../../../core/pagination';
+import { CursorPage, type CursorPageParams, Page, PagePromise } from '../../../core/pagination';
 import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
 
@@ -44,21 +44,24 @@ export class Permissions extends APIResource {
    *
    * @example
    * ```ts
-   * const permission =
-   *   await client.fineTuning.checkpoints.permissions.retrieve(
-   *     'ft-AF1WoRqd3aJAHsqc9NY7iL8F',
-   *   );
+   * // Automatically fetches more pages as needed.
+   * for await (const permissionRetrieveResponse of client.fineTuning.checkpoints.permissions.retrieve(
+   *   'ft-AF1WoRqd3aJAHsqc9NY7iL8F',
+   * )) {
+   *   // ...
+   * }
    * ```
    */
   retrieve(
     fineTunedModelCheckpoint: string,
     query: PermissionRetrieveParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<PermissionRetrieveResponse> {
-    return this._client.get(path`/fine_tuning/checkpoints/${fineTunedModelCheckpoint}/permissions`, {
-      query,
-      ...options,
-    });
+  ): PagePromise<PermissionRetrieveResponsesPage, PermissionRetrieveResponse> {
+    return this._client.getAPIList(
+      path`/fine_tuning/checkpoints/${fineTunedModelCheckpoint}/permissions`,
+      CursorPage<PermissionRetrieveResponse>,
+      { query, ...options },
+    );
   }
 
   /**
@@ -95,6 +98,8 @@ export class Permissions extends APIResource {
 // Note: no pagination actually occurs yet, this is for forwards-compatibility.
 export type PermissionCreateResponsesPage = Page<PermissionCreateResponse>;
 
+export type PermissionRetrieveResponsesPage = CursorPage<PermissionRetrieveResponse>;
+
 /**
  * The `checkpoint.permission` object represents a permission for a fine-tuned
  * model checkpoint.
@@ -121,44 +126,30 @@ export interface PermissionCreateResponse {
   project_id: string;
 }
 
+/**
+ * The `checkpoint.permission` object represents a permission for a fine-tuned
+ * model checkpoint.
+ */
 export interface PermissionRetrieveResponse {
-  data: Array<PermissionRetrieveResponse.Data>;
-
-  has_more: boolean;
-
-  object: 'list';
-
-  first_id?: string | null;
-
-  last_id?: string | null;
-}
-
-export namespace PermissionRetrieveResponse {
   /**
-   * The `checkpoint.permission` object represents a permission for a fine-tuned
-   * model checkpoint.
+   * The permission identifier, which can be referenced in the API endpoints.
    */
-  export interface Data {
-    /**
-     * The permission identifier, which can be referenced in the API endpoints.
-     */
-    id: string;
+  id: string;
 
-    /**
-     * The Unix timestamp (in seconds) for when the permission was created.
-     */
-    created_at: number;
+  /**
+   * The Unix timestamp (in seconds) for when the permission was created.
+   */
+  created_at: number;
 
-    /**
-     * The object type, which is always "checkpoint.permission".
-     */
-    object: 'checkpoint.permission';
+  /**
+   * The object type, which is always "checkpoint.permission".
+   */
+  object: 'checkpoint.permission';
 
-    /**
-     * The project identifier that the permission is for.
-     */
-    project_id: string;
-  }
+  /**
+   * The project identifier that the permission is for.
+   */
+  project_id: string;
 }
 
 export interface PermissionDeleteResponse {
@@ -185,17 +176,7 @@ export interface PermissionCreateParams {
   project_ids: Array<string>;
 }
 
-export interface PermissionRetrieveParams {
-  /**
-   * Identifier for the last permission ID from the previous pagination request.
-   */
-  after?: string;
-
-  /**
-   * Number of permissions to retrieve.
-   */
-  limit?: number;
-
+export interface PermissionRetrieveParams extends CursorPageParams {
   /**
    * The order in which to retrieve permissions.
    */
@@ -220,6 +201,7 @@ export declare namespace Permissions {
     type PermissionRetrieveResponse as PermissionRetrieveResponse,
     type PermissionDeleteResponse as PermissionDeleteResponse,
     type PermissionCreateResponsesPage as PermissionCreateResponsesPage,
+    type PermissionRetrieveResponsesPage as PermissionRetrieveResponsesPage,
     type PermissionCreateParams as PermissionCreateParams,
     type PermissionRetrieveParams as PermissionRetrieveParams,
     type PermissionDeleteParams as PermissionDeleteParams,

src/version.ts

@@ -1 +1 @@
-export const VERSION = '5.4.0'; // x-release-please-version
+export const VERSION = '5.5.0'; // x-release-please-version