openai 0.63.0 → 0.65.0

data/lib/openai/models/admin/organization/projects/project_hosted_tool_permissions.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        module Projects
+          # @see OpenAI::Resources::Admin::Organization::Projects::HostedToolPermissions#retrieve
+          class ProjectHostedToolPermissions < OpenAI::Internal::Type::BaseModel
+            # @!attribute code_interpreter
+            #   Permission state for a single hosted tool on a project.
+            #
+            #   @return [OpenAI::Models::Admin::Organization::Projects::ProjectHostedToolPermissions::CodeInterpreter]
+            required :code_interpreter,
+                     -> { OpenAI::Admin::Organization::Projects::ProjectHostedToolPermissions::CodeInterpreter }
+
+            # @!attribute file_search
+            #   Permission state for a single hosted tool on a project.
+            #
+            #   @return [OpenAI::Models::Admin::Organization::Projects::ProjectHostedToolPermissions::FileSearch]
+            required :file_search,
+                     -> { OpenAI::Admin::Organization::Projects::ProjectHostedToolPermissions::FileSearch }
+
+            # @!attribute image_generation
+            #   Permission state for a single hosted tool on a project.
+            #
+            #   @return [OpenAI::Models::Admin::Organization::Projects::ProjectHostedToolPermissions::ImageGeneration]
+            required :image_generation,
+                     -> { OpenAI::Admin::Organization::Projects::ProjectHostedToolPermissions::ImageGeneration }
+
+            # @!attribute mcp
+            #   Permission state for a single hosted tool on a project.
+            #
+            #   @return [OpenAI::Models::Admin::Organization::Projects::ProjectHostedToolPermissions::Mcp]
+            required :mcp, -> { OpenAI::Admin::Organization::Projects::ProjectHostedToolPermissions::Mcp }
+
+            # @!attribute web_search
+            #   Permission state for a single hosted tool on a project.
+            #
+            #   @return [OpenAI::Models::Admin::Organization::Projects::ProjectHostedToolPermissions::WebSearch]
+            required :web_search,
+                     -> { OpenAI::Admin::Organization::Projects::ProjectHostedToolPermissions::WebSearch }
+
+            # @!method initialize(code_interpreter:, file_search:, image_generation:, mcp:, web_search:)
+            #   Represents hosted tool permissions for a project.
+            #
+            #   @param code_interpreter [OpenAI::Models::Admin::Organization::Projects::ProjectHostedToolPermissions::CodeInterpreter] Permission state for a single hosted tool on a project.
+            #
+            #   @param file_search [OpenAI::Models::Admin::Organization::Projects::ProjectHostedToolPermissions::FileSearch] Permission state for a single hosted tool on a project.
+            #
+            #   @param image_generation [OpenAI::Models::Admin::Organization::Projects::ProjectHostedToolPermissions::ImageGeneration] Permission state for a single hosted tool on a project.
+            #
+            #   @param mcp [OpenAI::Models::Admin::Organization::Projects::ProjectHostedToolPermissions::Mcp] Permission state for a single hosted tool on a project.
+            #
+            #   @param web_search [OpenAI::Models::Admin::Organization::Projects::ProjectHostedToolPermissions::WebSearch] Permission state for a single hosted tool on a project.
+
+            # @see OpenAI::Models::Admin::Organization::Projects::ProjectHostedToolPermissions#code_interpreter
+            class CodeInterpreter < OpenAI::Internal::Type::BaseModel
+              # @!attribute enabled
+              #   Whether the hosted tool is enabled for the project.
+              #
+              #   @return [Boolean]
+              required :enabled, OpenAI::Internal::Type::Boolean
+
+              # @!method initialize(enabled:)
+              #   Permission state for a single hosted tool on a project.
+              #
+              #   @param enabled [Boolean] Whether the hosted tool is enabled for the project.
+            end
+
+            # @see OpenAI::Models::Admin::Organization::Projects::ProjectHostedToolPermissions#file_search
+            class FileSearch < OpenAI::Internal::Type::BaseModel
+              # @!attribute enabled
+              #   Whether the hosted tool is enabled for the project.
+              #
+              #   @return [Boolean]
+              required :enabled, OpenAI::Internal::Type::Boolean
+
+              # @!method initialize(enabled:)
+              #   Permission state for a single hosted tool on a project.
+              #
+              #   @param enabled [Boolean] Whether the hosted tool is enabled for the project.
+            end
+
+            # @see OpenAI::Models::Admin::Organization::Projects::ProjectHostedToolPermissions#image_generation
+            class ImageGeneration < OpenAI::Internal::Type::BaseModel
+              # @!attribute enabled
+              #   Whether the hosted tool is enabled for the project.
+              #
+              #   @return [Boolean]
+              required :enabled, OpenAI::Internal::Type::Boolean
+
+              # @!method initialize(enabled:)
+              #   Permission state for a single hosted tool on a project.
+              #
+              #   @param enabled [Boolean] Whether the hosted tool is enabled for the project.
+            end
+
+            # @see OpenAI::Models::Admin::Organization::Projects::ProjectHostedToolPermissions#mcp
+            class Mcp < OpenAI::Internal::Type::BaseModel
+              # @!attribute enabled
+              #   Whether the hosted tool is enabled for the project.
+              #
+              #   @return [Boolean]
+              required :enabled, OpenAI::Internal::Type::Boolean
+
+              # @!method initialize(enabled:)
+              #   Permission state for a single hosted tool on a project.
+              #
+              #   @param enabled [Boolean] Whether the hosted tool is enabled for the project.
+            end
+
+            # @see OpenAI::Models::Admin::Organization::Projects::ProjectHostedToolPermissions#web_search
+            class WebSearch < OpenAI::Internal::Type::BaseModel
+              # @!attribute enabled
+              #   Whether the hosted tool is enabled for the project.
+              #
+              #   @return [Boolean]
+              required :enabled, OpenAI::Internal::Type::Boolean
+
+              # @!method initialize(enabled:)
+              #   Permission state for a single hosted tool on a project.
+              #
+              #   @param enabled [Boolean] Whether the hosted tool is enabled for the project.
+            end
+          end
+        end
+
+        ProjectHostedToolPermissions = Projects::ProjectHostedToolPermissions
+      end
+    end
+  end
+end

data/lib/openai/models/admin/organization/projects/project_model_permissions.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        module Projects
+          # @see OpenAI::Resources::Admin::Organization::Projects::ModelPermissions#retrieve
+          class ProjectModelPermissions < OpenAI::Internal::Type::BaseModel
+            # @!attribute mode
+            #   Whether the project uses an allowlist or a denylist.
+            #
+            #   @return [Symbol, OpenAI::Models::Admin::Organization::Projects::ProjectModelPermissions::Mode]
+            required :mode, enum: -> { OpenAI::Admin::Organization::Projects::ProjectModelPermissions::Mode }
+
+            # @!attribute model_ids
+            #   The model IDs included in the model permissions policy.
+            #
+            #   @return [Array<String>]
+            required :model_ids, OpenAI::Internal::Type::ArrayOf[String]
+
+            # @!attribute object
+            #   The object type, which is always `project.model_permissions`.
+            #
+            #   @return [Symbol, :"project.model_permissions"]
+            required :object, const: :"project.model_permissions"
+
+            # @!method initialize(mode:, model_ids:, object: :"project.model_permissions")
+            #   Represents the model allowlist or denylist policy for a project.
+            #
+            #   @param mode [Symbol, OpenAI::Models::Admin::Organization::Projects::ProjectModelPermissions::Mode] Whether the project uses an allowlist or a denylist.
+            #
+            #   @param model_ids [Array<String>] The model IDs included in the model permissions policy.
+            #
+            #   @param object [Symbol, :"project.model_permissions"] The object type, which is always `project.model_permissions`.
+
+            # Whether the project uses an allowlist or a denylist.
+            #
+            # @see OpenAI::Models::Admin::Organization::Projects::ProjectModelPermissions#mode
+            module Mode
+              extend OpenAI::Internal::Type::Enum
+
+              ALLOW_LIST = :allow_list
+              DENY_LIST = :deny_list
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+        end
+
+        ProjectModelPermissions = Projects::ProjectModelPermissions
+      end
+    end
+  end
+end

data/lib/openai/models/admin/organization/projects/project_model_permissions_deleted.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        module Projects
+          # @see OpenAI::Resources::Admin::Organization::Projects::ModelPermissions#delete
+          class ProjectModelPermissionsDeleted < OpenAI::Internal::Type::BaseModel
+            # @!attribute deleted
+            #   Whether the project model permissions were deleted.
+            #
+            #   @return [Boolean]
+            required :deleted, OpenAI::Internal::Type::Boolean
+
+            # @!attribute object
+            #   The object type, which is always `project.model_permissions.deleted`.
+            #
+            #   @return [Symbol, :"project.model_permissions.deleted"]
+            required :object, const: :"project.model_permissions.deleted"
+
+            # @!method initialize(deleted:, object: :"project.model_permissions.deleted")
+            #   Confirmation payload returned after deleting project model permissions.
+            #
+            #   @param deleted [Boolean] Whether the project model permissions were deleted.
+            #
+            #   @param object [Symbol, :"project.model_permissions.deleted"] The object type, which is always `project.model_permissions.deleted`.
+          end
+        end
+
+        ProjectModelPermissionsDeleted = Projects::ProjectModelPermissionsDeleted
+      end
+    end
+  end
+end

data/lib/openai/models/admin/organization/projects/project_spend_alert.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        module Projects
+          # @see OpenAI::Resources::Admin::Organization::Projects::SpendAlerts#create
+          class ProjectSpendAlert < OpenAI::Internal::Type::BaseModel
+            # @!attribute id
+            #   The identifier, which can be referenced in API endpoints.
+            #
+            #   @return [String]
+            required :id, String
+
+            # @!attribute currency
+            #   The currency for the threshold amount.
+            #
+            #   @return [Symbol, OpenAI::Models::Admin::Organization::Projects::ProjectSpendAlert::Currency]
+            required :currency, enum: -> { OpenAI::Admin::Organization::Projects::ProjectSpendAlert::Currency }
+
+            # @!attribute interval
+            #   The time interval for evaluating spend against the threshold.
+            #
+            #   @return [Symbol, OpenAI::Models::Admin::Organization::Projects::ProjectSpendAlert::Interval]
+            required :interval, enum: -> { OpenAI::Admin::Organization::Projects::ProjectSpendAlert::Interval }
+
+            # @!attribute notification_channel
+            #   Email notification settings for a spend alert.
+            #
+            #   @return [OpenAI::Models::Admin::Organization::Projects::ProjectSpendAlert::NotificationChannel]
+            required :notification_channel,
+                     -> { OpenAI::Admin::Organization::Projects::ProjectSpendAlert::NotificationChannel }
+
+            # @!attribute object
+            #   The object type, which is always `project.spend_alert`.
+            #
+            #   @return [Symbol, :"project.spend_alert"]
+            required :object, const: :"project.spend_alert"
+
+            # @!attribute threshold_amount
+            #   The alert threshold amount, in cents.
+            #
+            #   @return [Integer]
+            required :threshold_amount, Integer
+
+            # @!method initialize(id:, currency:, interval:, notification_channel:, threshold_amount:, object: :"project.spend_alert")
+            #   Represents a spend alert configured at the project level.
+            #
+            #   @param id [String] The identifier, which can be referenced in API endpoints.
+            #
+            #   @param currency [Symbol, OpenAI::Models::Admin::Organization::Projects::ProjectSpendAlert::Currency] The currency for the threshold amount.
+            #
+            #   @param interval [Symbol, OpenAI::Models::Admin::Organization::Projects::ProjectSpendAlert::Interval] The time interval for evaluating spend against the threshold.
+            #
+            #   @param notification_channel [OpenAI::Models::Admin::Organization::Projects::ProjectSpendAlert::NotificationChannel] Email notification settings for a spend alert.
+            #
+            #   @param threshold_amount [Integer] The alert threshold amount, in cents.
+            #
+            #   @param object [Symbol, :"project.spend_alert"] The object type, which is always `project.spend_alert`.
+
+            # The currency for the threshold amount.
+            #
+            # @see OpenAI::Models::Admin::Organization::Projects::ProjectSpendAlert#currency
+            module Currency
+              extend OpenAI::Internal::Type::Enum
+
+              USD = :USD
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+
+            # The time interval for evaluating spend against the threshold.
+            #
+            # @see OpenAI::Models::Admin::Organization::Projects::ProjectSpendAlert#interval
+            module Interval
+              extend OpenAI::Internal::Type::Enum
+
+              MONTH = :month
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+
+            # @see OpenAI::Models::Admin::Organization::Projects::ProjectSpendAlert#notification_channel
+            class NotificationChannel < OpenAI::Internal::Type::BaseModel
+              # @!attribute recipients
+              #   Email addresses that receive the spend alert notification.
+              #
+              #   @return [Array<String>]
+              required :recipients, OpenAI::Internal::Type::ArrayOf[String]
+
+              # @!attribute type
+              #   The notification channel type. Currently only `email` is supported.
+              #
+              #   @return [Symbol, :email]
+              required :type, const: :email
+
+              # @!attribute subject_prefix
+              #   Optional subject prefix for alert emails.
+              #
+              #   @return [String, nil]
+              optional :subject_prefix, String, nil?: true
+
+              # @!method initialize(recipients:, subject_prefix: nil, type: :email)
+              #   Email notification settings for a spend alert.
+              #
+              #   @param recipients [Array<String>] Email addresses that receive the spend alert notification.
+              #
+              #   @param subject_prefix [String, nil] Optional subject prefix for alert emails.
+              #
+              #   @param type [Symbol, :email] The notification channel type. Currently only `email` is supported.
+            end
+          end
+        end
+
+        ProjectSpendAlert = Projects::ProjectSpendAlert
+      end
+    end
+  end
+end

data/lib/openai/models/admin/organization/projects/project_spend_alert_deleted.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        module Projects
+          # @see OpenAI::Resources::Admin::Organization::Projects::SpendAlerts#delete
+          class ProjectSpendAlertDeleted < OpenAI::Internal::Type::BaseModel
+            # @!attribute id
+            #   The deleted spend alert ID.
+            #
+            #   @return [String]
+            required :id, String
+
+            # @!attribute deleted
+            #   Whether the spend alert was deleted.
+            #
+            #   @return [Boolean]
+            required :deleted, OpenAI::Internal::Type::Boolean
+
+            # @!attribute object
+            #   Always `project.spend_alert.deleted`.
+            #
+            #   @return [Symbol, :"project.spend_alert.deleted"]
+            required :object, const: :"project.spend_alert.deleted"
+
+            # @!method initialize(id:, deleted:, object: :"project.spend_alert.deleted")
+            #   Confirmation payload returned after deleting a project spend alert.
+            #
+            #   @param id [String] The deleted spend alert ID.
+            #
+            #   @param deleted [Boolean] Whether the spend alert was deleted.
+            #
+            #   @param object [Symbol, :"project.spend_alert.deleted"] Always `project.spend_alert.deleted`.
+          end
+        end
+
+        ProjectSpendAlertDeleted = Projects::ProjectSpendAlertDeleted
+      end
+    end
+  end
+end

data/lib/openai/models/admin/organization/projects/role_retrieve_params.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        module Projects
+          # @see OpenAI::Resources::Admin::Organization::Projects::Roles#retrieve
+          class RoleRetrieveParams < OpenAI::Internal::Type::BaseModel
+            extend OpenAI::Internal::Type::RequestParameters::Converter
+            include OpenAI::Internal::Type::RequestParameters
+
+            # @!attribute project_id
+            #
+            #   @return [String]
+            required :project_id, String
+
+            # @!attribute role_id
+            #
+            #   @return [String]
+            required :role_id, String
+
+            # @!method initialize(project_id:, role_id:, request_options: {})
+            #   @param project_id [String]
+            #   @param role_id [String]
+            #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/admin/organization/projects/service_account_update_params.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        module Projects
+          # @see OpenAI::Resources::Admin::Organization::Projects::ServiceAccounts#update
+          class ServiceAccountUpdateParams < OpenAI::Internal::Type::BaseModel
+            extend OpenAI::Internal::Type::RequestParameters::Converter
+            include OpenAI::Internal::Type::RequestParameters
+
+            # @!attribute project_id
+            #
+            #   @return [String]
+            required :project_id, String
+
+            # @!attribute service_account_id
+            #
+            #   @return [String]
+            required :service_account_id, String
+
+            # @!attribute name
+            #   The updated service account name.
+            #
+            #   @return [String, nil]
+            optional :name, String
+
+            # @!attribute role
+            #   The updated service account role.
+            #
+            #   @return [Symbol, OpenAI::Models::Admin::Organization::Projects::ServiceAccountUpdateParams::Role, nil]
+            optional :role, enum: -> { OpenAI::Admin::Organization::Projects::ServiceAccountUpdateParams::Role }
+
+            # @!method initialize(project_id:, service_account_id:, name: nil, role: nil, request_options: {})
+            #   @param project_id [String]
+            #
+            #   @param service_account_id [String]
+            #
+            #   @param name [String] The updated service account name.
+            #
+            #   @param role [Symbol, OpenAI::Models::Admin::Organization::Projects::ServiceAccountUpdateParams::Role] The updated service account role.
+            #
+            #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+
+            # The updated service account role.
+            module Role
+              extend OpenAI::Internal::Type::Enum
+
+              MEMBER = :member
+              OWNER = :owner
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/admin/organization/projects/spend_alert_create_params.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        module Projects
+          # @see OpenAI::Resources::Admin::Organization::Projects::SpendAlerts#create
+          class SpendAlertCreateParams < OpenAI::Internal::Type::BaseModel
+            extend OpenAI::Internal::Type::RequestParameters::Converter
+            include OpenAI::Internal::Type::RequestParameters
+
+            # @!attribute project_id
+            #
+            #   @return [String]
+            required :project_id, String
+
+            # @!attribute currency
+            #   The currency for the threshold amount.
+            #
+            #   @return [Symbol, OpenAI::Models::Admin::Organization::Projects::SpendAlertCreateParams::Currency]
+            required :currency, enum: -> { OpenAI::Admin::Organization::Projects::SpendAlertCreateParams::Currency }
+
+            # @!attribute interval
+            #   The time interval for evaluating spend against the threshold.
+            #
+            #   @return [Symbol, OpenAI::Models::Admin::Organization::Projects::SpendAlertCreateParams::Interval]
+            required :interval, enum: -> { OpenAI::Admin::Organization::Projects::SpendAlertCreateParams::Interval }
+
+            # @!attribute notification_channel
+            #   Email notification settings for a spend alert.
+            #
+            #   @return [OpenAI::Models::Admin::Organization::Projects::SpendAlertCreateParams::NotificationChannel]
+            required :notification_channel,
+                     -> { OpenAI::Admin::Organization::Projects::SpendAlertCreateParams::NotificationChannel }
+
+            # @!attribute threshold_amount
+            #   The alert threshold amount, in cents.
+            #
+            #   @return [Integer]
+            required :threshold_amount, Integer
+
+            # @!method initialize(project_id:, currency:, interval:, notification_channel:, threshold_amount:, request_options: {})
+            #   @param project_id [String]
+            #
+            #   @param currency [Symbol, OpenAI::Models::Admin::Organization::Projects::SpendAlertCreateParams::Currency] The currency for the threshold amount.
+            #
+            #   @param interval [Symbol, OpenAI::Models::Admin::Organization::Projects::SpendAlertCreateParams::Interval] The time interval for evaluating spend against the threshold.
+            #
+            #   @param notification_channel [OpenAI::Models::Admin::Organization::Projects::SpendAlertCreateParams::NotificationChannel] Email notification settings for a spend alert.
+            #
+            #   @param threshold_amount [Integer] The alert threshold amount, in cents.
+            #
+            #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+
+            # The currency for the threshold amount.
+            module Currency
+              extend OpenAI::Internal::Type::Enum
+
+              USD = :USD
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+
+            # The time interval for evaluating spend against the threshold.
+            module Interval
+              extend OpenAI::Internal::Type::Enum
+
+              MONTH = :month
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+
+            class NotificationChannel < OpenAI::Internal::Type::BaseModel
+              # @!attribute recipients
+              #   Email addresses that receive the spend alert notification.
+              #
+              #   @return [Array<String>]
+              required :recipients, OpenAI::Internal::Type::ArrayOf[String]
+
+              # @!attribute type
+              #   The notification channel type. Currently only `email` is supported.
+              #
+              #   @return [Symbol, :email]
+              required :type, const: :email
+
+              # @!attribute subject_prefix
+              #   Optional subject prefix for alert emails.
+              #
+              #   @return [String, nil]
+              optional :subject_prefix, String, nil?: true
+
+              # @!method initialize(recipients:, subject_prefix: nil, type: :email)
+              #   Email notification settings for a spend alert.
+              #
+              #   @param recipients [Array<String>] Email addresses that receive the spend alert notification.
+              #
+              #   @param subject_prefix [String, nil] Optional subject prefix for alert emails.
+              #
+              #   @param type [Symbol, :email] The notification channel type. Currently only `email` is supported.
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/admin/organization/projects/spend_alert_delete_params.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        module Projects
+          # @see OpenAI::Resources::Admin::Organization::Projects::SpendAlerts#delete
+          class SpendAlertDeleteParams < OpenAI::Internal::Type::BaseModel
+            extend OpenAI::Internal::Type::RequestParameters::Converter
+            include OpenAI::Internal::Type::RequestParameters
+
+            # @!attribute project_id
+            #
+            #   @return [String]
+            required :project_id, String
+
+            # @!attribute alert_id
+            #
+            #   @return [String]
+            required :alert_id, String
+
+            # @!method initialize(project_id:, alert_id:, request_options: {})
+            #   @param project_id [String]
+            #   @param alert_id [String]
+            #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+          end
+        end
+      end
+    end
+  end
+end