openai 0.86.0 → 0.88.0

data/lib/openai/resources/admin/organization/projects/users/roles.rb

@@ -11,11 +11,14 @@ module OpenAI
               #
               # @overload create(user_id, project_id:, role_id:, request_options: {})
               #
-              # @param user_id [String] Path param: The ID of the user that should receive the project role.
+              # @param user_id [String]
+              #   Path param: The ID of the user that should receive the project role.
               #
-              # @param project_id [String] Path param: The ID of the project to update.
+              # @param project_id [String]
+              #   Path param: The ID of the project to update.
               #
-              # @param role_id [String] Body param: Identifier of the role to assign.
+              # @param role_id [String]
+              #   Body param: Identifier of the role to assign.
               #
               # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
               #
@@ -42,11 +45,14 @@ module OpenAI
               #
               # @overload retrieve(role_id, project_id:, user_id:, request_options: {})
               #
-              # @param role_id [String] The ID of the project role to retrieve for the user.
+              # @param role_id [String]
+              #   The ID of the project role to retrieve for the user.
               #
-              # @param project_id [String] The ID of the project to inspect.
+              # @param project_id [String]
+              #   The ID of the project to inspect.
               #
-              # @param user_id [String] The ID of the user to inspect.
+              # @param user_id [String]
+              #   The ID of the user to inspect.
               #
               # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
               #
@@ -72,23 +78,25 @@ module OpenAI
                 )
               end
 
-              # Some parameter documentations has been truncated, see
-              # {OpenAI::Models::Admin::Organization::Projects::Users::RoleListParams} for more
-              # details.
-              #
               # Lists the project roles assigned to a user within a project.
               #
               # @overload list(user_id, project_id:, after: nil, limit: nil, order: nil, request_options: {})
               #
-              # @param user_id [String] Path param: The ID of the user to inspect.
+              # @param user_id [String]
+              #   Path param: The ID of the user to inspect.
               #
-              # @param project_id [String] Path param: The ID of the project to inspect.
+              # @param project_id [String]
+              #   Path param: The ID of the project to inspect.
               #
-              # @param after [String] Query param: Cursor for pagination. Provide the value from the previous response
+              # @param after [String]
+              #   Query param: Cursor for pagination. Provide the value from the previous
+              #   response's `next` field to continue listing project roles.
               #
-              # @param limit [Integer] Query param: A limit on the number of project role assignments to return.
+              # @param limit [Integer]
+              #   Query param: A limit on the number of project role assignments to return.
               #
-              # @param order [Symbol, OpenAI::Models::Admin::Organization::Projects::Users::RoleListParams::Order] Query param: Sort order for the returned project roles.
+              # @param order [Symbol, OpenAI::Models::Admin::Organization::Projects::Users::RoleListParams::Order]
+              #   Query param: Sort order for the returned project roles.
               #
               # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
               #
@@ -117,11 +125,14 @@ module OpenAI
               #
               # @overload delete(role_id, project_id:, user_id:, request_options: {})
               #
-              # @param role_id [String] The ID of the project role to remove from the user.
+              # @param role_id [String]
+              #   The ID of the project role to remove from the user.
               #
-              # @param project_id [String] The ID of the project to modify.
+              # @param project_id [String]
+              #   The ID of the project to modify.
               #
-              # @param user_id [String] The ID of the user whose project role assignment should be removed.
+              # @param user_id [String]
+              #   The ID of the user whose project role assignment should be removed.
               #
               # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
               #

data/lib/openai/resources/admin/organization/projects/users.rb

@@ -14,13 +14,17 @@ module OpenAI
             #
             # @overload create(project_id, role:, email: nil, user_id: nil, request_options: {})
             #
-            # @param project_id [String] The ID of the project.
+            # @param project_id [String]
+            #   The ID of the project.
             #
-            # @param role [String] `owner` or `member`
+            # @param role [String]
+            #   `owner` or `member`
             #
-            # @param email [String, nil] Email of the user to add.
+            # @param email [String, nil]
+            #   Email of the user to add.
             #
-            # @param user_id [String, nil] The ID of the user.
+            # @param user_id [String, nil]
+            #   The ID of the user.
             #
             # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
             #
@@ -43,9 +47,11 @@ module OpenAI
             #
             # @overload retrieve(user_id, project_id:, request_options: {})
             #
-            # @param user_id [String] The ID of the user.
+            # @param user_id [String]
+            #   The ID of the user.
             #
-            # @param project_id [String] The ID of the project.
+            # @param project_id [String]
+            #   The ID of the project.
             #
             # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
             #
@@ -71,11 +77,14 @@ module OpenAI
             #
             # @overload update(user_id, project_id:, role: nil, request_options: {})
             #
-            # @param user_id [String] Path param: The ID of the user.
+            # @param user_id [String]
+            #   Path param: The ID of the user.
             #
-            # @param project_id [String] Path param: The ID of the project.
+            # @param project_id [String]
+            #   Path param: The ID of the project.
             #
-            # @param role [String, nil] Body param: `owner` or `member`
+            # @param role [String, nil]
+            #   Body param: `owner` or `member`
             #
             # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
             #
@@ -98,19 +107,22 @@ module OpenAI
               )
             end
 
-            # Some parameter documentations has been truncated, see
-            # {OpenAI::Models::Admin::Organization::Projects::UserListParams} for more
-            # details.
-            #
             # Returns a list of users in the project.
             #
             # @overload list(project_id, after: nil, limit: nil, request_options: {})
             #
-            # @param project_id [String] The ID of the project.
+            # @param project_id [String]
+            #   The ID of the project.
             #
-            # @param after [String] A cursor for use in pagination. `after` is an object ID that defines your place
+            # @param after [String]
+            #   A cursor for use in pagination. `after` is an object ID that defines your place
+            #   in the list. For instance, if you make a list request and receive 100 objects,
+            #   ending with obj_foo, your subsequent call can include after=obj_foo in order to
+            #   fetch the next page of the list.
             #
-            # @param limit [Integer] A limit on the number of objects to be returned. Limit can range between 1 and 1
+            # @param limit [Integer]
+            #   A limit on the number of objects to be returned. Limit can range between 1 and
+            #   100, and the default is 20.
             #
             # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
             #
@@ -138,9 +150,11 @@ module OpenAI
             #
             # @overload delete(user_id, project_id:, request_options: {})
             #
-            # @param user_id [String] The ID of the user.
+            # @param user_id [String]
+            #   The ID of the user.
             #
-            # @param project_id [String] The ID of the project.
+            # @param project_id [String]
+            #   The ID of the project.
             #
             # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
             #

data/lib/openai/resources/admin/organization/projects.rb

@@ -41,21 +41,30 @@ module OpenAI
           # @return [OpenAI::Resources::Admin::Organization::Projects::Certificates]
           attr_reader :certificates
 
-          # Some parameter documentations has been truncated, see
-          # {OpenAI::Models::Admin::Organization::ProjectCreateParams} for more details.
-          #
           # Create a new project in the organization. Projects can be created and archived,
           # but cannot be deleted.
           #
           # @overload create(name:, external_key_id: nil, geography: nil, residency: nil, request_options: {})
           #
-          # @param name [String] The friendly name of the project, this name appears in reports.
+          # @param name [String]
+          #   The friendly name of the project, this name appears in reports.
           #
-          # @param external_key_id [String, nil] External key ID to associate with the project.
+          # @param external_key_id [String, nil]
+          #   External key ID to associate with the project.
           #
-          # @param geography [String, nil] Create the project with the specified data residency region. Your organization m
+          # @param geography [String, nil]
+          #   Create the project with the specified data residency region. Your organization
+          #   must have access to Data residency functionality in order to use. See
+          #   [data residency controls](https://developers.openai.com/api/docs/guides/your-data#data-residency-controls)
+          #   to review the functionality and limitations of setting this field. Deprecated:
+          #   use `residency` instead. Do not provide both `geography` and `residency`.
           #
-          # @param residency [Symbol, OpenAI::Models::Admin::Organization::ProjectResidency, nil] Create the project with the specified residency configuration. Your organization
+          # @param residency [Symbol, OpenAI::Models::Admin::Organization::ProjectResidency, nil]
+          #   Create the project with the specified residency configuration. Your organization
+          #   must have access to the requested residency configuration in order to use it.
+          #   See
+          #   [data residency controls](https://developers.openai.com/api/docs/guides/your-data#data-residency-controls)
+          #   to review the functionality and limitations of setting this field.
           #
           # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
           #
@@ -78,7 +87,8 @@ module OpenAI
           #
           # @overload retrieve(project_id, request_options: {})
           #
-          # @param project_id [String] The ID of the project.
+          # @param project_id [String]
+          #   The ID of the project.
           #
           # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
           #
@@ -95,20 +105,22 @@ module OpenAI
             )
           end
 
-          # Some parameter documentations has been truncated, see
-          # {OpenAI::Models::Admin::Organization::ProjectUpdateParams} for more details.
-          #
           # Modifies a project in the organization.
           #
           # @overload update(project_id, external_key_id: nil, geography: nil, name: nil, request_options: {})
           #
-          # @param project_id [String] The ID of the project.
+          # @param project_id [String]
+          #   The ID of the project.
           #
-          # @param external_key_id [String, nil] External key ID to associate with the project.
+          # @param external_key_id [String, nil]
+          #   External key ID to associate with the project.
           #
-          # @param geography [String, nil] Geography for the project.
+          # @param geography [String, nil]
+          #   Geography for the project. Deprecated: use `residency` when creating a project
+          #   to configure data residency. This field is retained for backward compatibility.
           #
-          # @param name [String, nil] The updated name of the project, this name appears in reports.
+          # @param name [String, nil]
+          #   The updated name of the project, this name appears in reports.
           #
           # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
           #
@@ -127,18 +139,23 @@ module OpenAI
             )
           end
 
-          # Some parameter documentations has been truncated, see
-          # {OpenAI::Models::Admin::Organization::ProjectListParams} for more details.
-          #
           # Returns a list of projects.
           #
           # @overload list(after: nil, include_archived: nil, limit: nil, request_options: {})
           #
-          # @param after [String] A cursor for use in pagination. `after` is an object ID that defines your place
+          # @param after [String]
+          #   A cursor for use in pagination. `after` is an object ID that defines your place
+          #   in the list. For instance, if you make a list request and receive 100 objects,
+          #   ending with obj_foo, your subsequent call can include after=obj_foo in order to
+          #   fetch the next page of the list.
           #
-          # @param include_archived [Boolean] If `true` returns all projects including those that have been `archived`. Archiv
+          # @param include_archived [Boolean]
+          #   If `true` returns all projects including those that have been `archived`.
+          #   Archived projects are not included by default.
           #
-          # @param limit [Integer] A limit on the number of objects to be returned. Limit can range between 1 and 1
+          # @param limit [Integer]
+          #   A limit on the number of objects to be returned. Limit can range between 1 and
+          #   100, and the default is 20.
           #
           # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
           #
@@ -164,7 +181,8 @@ module OpenAI
           #
           # @overload archive(project_id, request_options: {})
           #
-          # @param project_id [String] The ID of the project.
+          # @param project_id [String]
+          #   The ID of the project.
           #
           # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
           #

data/lib/openai/resources/admin/organization/roles.rb

@@ -9,11 +9,14 @@ module OpenAI
           #
           # @overload create(permissions:, role_name:, description: nil, request_options: {})
           #
-          # @param permissions [Array<String>] Permissions to grant to the role.
+          # @param permissions [Array<String>]
+          #   Permissions to grant to the role.
           #
-          # @param role_name [String] Unique name for the role.
+          # @param role_name [String]
+          #   Unique name for the role.
           #
-          # @param description [String, nil] Optional description of the role.
+          # @param description [String, nil]
+          #   Optional description of the role.
           #
           # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
           #
@@ -36,7 +39,8 @@ module OpenAI
           #
           # @overload retrieve(role_id, request_options: {})
           #
-          # @param role_id [String] The ID of the role to retrieve.
+          # @param role_id [String]
+          #   The ID of the role to retrieve.
           #
           # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
           #
@@ -57,13 +61,17 @@ module OpenAI
           #
           # @overload update(role_id, description: nil, permissions: nil, role_name: nil, request_options: {})
           #
-          # @param role_id [String] The ID of the role to update.
+          # @param role_id [String]
+          #   The ID of the role to update.
           #
-          # @param description [String, nil] New description for the role.
+          # @param description [String, nil]
+          #   New description for the role.
           #
-          # @param permissions [Array<String>, nil] Updated set of permissions for the role.
+          # @param permissions [Array<String>, nil]
+          #   Updated set of permissions for the role.
           #
-          # @param role_name [String, nil] New name for the role.
+          # @param role_name [String, nil]
+          #   New name for the role.
           #
           # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
           #
@@ -82,18 +90,19 @@ module OpenAI
             )
           end
 
-          # Some parameter documentations has been truncated, see
-          # {OpenAI::Models::Admin::Organization::RoleListParams} for more details.
-          #
           # Lists the roles configured for the organization.
           #
           # @overload list(after: nil, limit: nil, order: nil, request_options: {})
           #
-          # @param after [String] Cursor for pagination. Provide the value from the previous response's `next` fie
+          # @param after [String]
+          #   Cursor for pagination. Provide the value from the previous response's `next`
+          #   field to continue listing roles.
           #
-          # @param limit [Integer] A limit on the number of roles to return. Defaults to 1000.
+          # @param limit [Integer]
+          #   A limit on the number of roles to return. Defaults to 1000.
           #
-          # @param order [Symbol, OpenAI::Models::Admin::Organization::RoleListParams::Order] Sort order for the returned roles.
+          # @param order [Symbol, OpenAI::Models::Admin::Organization::RoleListParams::Order]
+          #   Sort order for the returned roles.
           #
           # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
           #
@@ -118,7 +127,8 @@ module OpenAI
           #
           # @overload delete(role_id, request_options: {})
           #
-          # @param role_id [String] The ID of the role to delete.
+          # @param role_id [String]
+          #   The ID of the role to delete.
           #
           # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
           #

data/lib/openai/resources/admin/organization/spend_alerts.rb

@@ -9,13 +9,17 @@ module OpenAI
           #
           # @overload create(currency:, interval:, notification_channel:, threshold_amount:, request_options: {})
           #
-          # @param currency [Symbol, OpenAI::Models::Admin::Organization::SpendAlertCreateParams::Currency] The currency for the threshold amount.
+          # @param currency [Symbol, OpenAI::Models::Admin::Organization::SpendAlertCreateParams::Currency]
+          #   The currency for the threshold amount.
           #
-          # @param interval [Symbol, OpenAI::Models::Admin::Organization::SpendAlertCreateParams::Interval] The time interval for evaluating spend against the threshold.
+          # @param interval [Symbol, OpenAI::Models::Admin::Organization::SpendAlertCreateParams::Interval]
+          #   The time interval for evaluating spend against the threshold.
           #
-          # @param notification_channel [OpenAI::Models::Admin::Organization::SpendAlertCreateParams::NotificationChannel] Email notification settings for a spend alert.
+          # @param notification_channel [OpenAI::Models::Admin::Organization::SpendAlertCreateParams::NotificationChannel]
+          #   Email notification settings for a spend alert.
           #
-          # @param threshold_amount [Integer] The alert threshold amount, in cents.
+          # @param threshold_amount [Integer]
+          #   The alert threshold amount, in cents.
           #
           # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
           #
@@ -38,7 +42,8 @@ module OpenAI
           #
           # @overload retrieve(alert_id, request_options: {})
           #
-          # @param alert_id [String] The ID of the spend alert to retrieve.
+          # @param alert_id [String]
+          #   The ID of the spend alert to retrieve.
           #
           # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
           #
@@ -59,15 +64,20 @@ module OpenAI
           #
           # @overload update(alert_id, currency:, interval:, notification_channel:, threshold_amount:, request_options: {})
           #
-          # @param alert_id [String] The ID of the spend alert to update.
+          # @param alert_id [String]
+          #   The ID of the spend alert to update.
           #
-          # @param currency [Symbol, OpenAI::Models::Admin::Organization::SpendAlertUpdateParams::Currency] The currency for the threshold amount.
+          # @param currency [Symbol, OpenAI::Models::Admin::Organization::SpendAlertUpdateParams::Currency]
+          #   The currency for the threshold amount.
           #
-          # @param interval [Symbol, OpenAI::Models::Admin::Organization::SpendAlertUpdateParams::Interval] The time interval for evaluating spend against the threshold.
+          # @param interval [Symbol, OpenAI::Models::Admin::Organization::SpendAlertUpdateParams::Interval]
+          #   The time interval for evaluating spend against the threshold.
           #
-          # @param notification_channel [OpenAI::Models::Admin::Organization::SpendAlertUpdateParams::NotificationChannel] Email notification settings for a spend alert.
+          # @param notification_channel [OpenAI::Models::Admin::Organization::SpendAlertUpdateParams::NotificationChannel]
+          #   Email notification settings for a spend alert.
           #
-          # @param threshold_amount [Integer] The alert threshold amount, in cents.
+          # @param threshold_amount [Integer]
+          #   The alert threshold amount, in cents.
           #
           # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
           #
@@ -86,20 +96,23 @@ module OpenAI
             )
           end
 
-          # Some parameter documentations has been truncated, see
-          # {OpenAI::Models::Admin::Organization::SpendAlertListParams} for more details.
-          #
           # Lists organization spend alerts.
           #
           # @overload list(after: nil, before: nil, limit: nil, order: nil, request_options: {})
           #
-          # @param after [String] Cursor for pagination. Provide the ID of the last spend alert from the previous
+          # @param after [String]
+          #   Cursor for pagination. Provide the ID of the last spend alert from the previous
+          #   response to fetch the next page.
           #
-          # @param before [String] Cursor for pagination. Provide the ID of the first spend alert from the previous
+          # @param before [String]
+          #   Cursor for pagination. Provide the ID of the first spend alert from the previous
+          #   response to fetch the previous page.
           #
-          # @param limit [Integer] A limit on the number of spend alerts to return. Defaults to 20.
+          # @param limit [Integer]
+          #   A limit on the number of spend alerts to return. Defaults to 20.
           #
-          # @param order [Symbol, OpenAI::Models::Admin::Organization::SpendAlertListParams::Order] Sort order for the returned spend alerts.
+          # @param order [Symbol, OpenAI::Models::Admin::Organization::SpendAlertListParams::Order]
+          #   Sort order for the returned spend alerts.
           #
           # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
           #
@@ -124,7 +137,8 @@ module OpenAI
           #
           # @overload delete(alert_id, request_options: {})
           #
-          # @param alert_id [String] The ID of the spend alert to delete.
+          # @param alert_id [String]
+          #   The ID of the spend alert to delete.
           #
           # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
           #

data/lib/openai/resources/admin/organization/spend_limit.rb

@@ -24,18 +24,19 @@ module OpenAI
             )
           end
 
-          # Some parameter documentations has been truncated, see
-          # {OpenAI::Models::Admin::Organization::SpendLimitUpdateParams} for more details.
-          #
           # Create or replace the organization's hard spend limit.
           #
           # @overload update(currency:, interval:, threshold_amount:, request_options: {})
           #
-          # @param currency [Symbol, OpenAI::Models::Admin::Organization::SpendLimitUpdateParams::Currency] The currency for the threshold amount. Currently, only `USD` is supported.
+          # @param currency [Symbol, OpenAI::Models::Admin::Organization::SpendLimitUpdateParams::Currency]
+          #   The currency for the threshold amount. Currently, only `USD` is supported.
           #
-          # @param interval [Symbol, OpenAI::Models::Admin::Organization::SpendLimitUpdateParams::Interval] The time interval for evaluating spend against the threshold. Currently, only `m
+          # @param interval [Symbol, OpenAI::Models::Admin::Organization::SpendLimitUpdateParams::Interval]
+          #   The time interval for evaluating spend against the threshold. Currently, only
+          #   `month` is supported.
           #
-          # @param threshold_amount [Integer] The hard spend limit amount, in cents.
+          # @param threshold_amount [Integer]
+          #   The hard spend limit amount, in cents.
           #
           # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
           #