openai 0.71.0 → 0.72.0

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

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Resources
+    class Admin
+      class Organization
+        class SpendLimit
+          # Get the organization's hard spend limit.
+          #
+          # @overload retrieve(request_options: {})
+          #
+          # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [OpenAI::Models::Admin::Organization::OrganizationSpendLimit]
+          #
+          # @see OpenAI::Models::Admin::Organization::SpendLimitRetrieveParams
+          def retrieve(params = {})
+            @client.request(
+              method: :get,
+              path: "organization/spend_limit",
+              model: OpenAI::Admin::Organization::OrganizationSpendLimit,
+              security: {admin_api_key_auth: true},
+              options: params[:request_options]
+            )
+          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 interval [Symbol, OpenAI::Models::Admin::Organization::SpendLimitUpdateParams::Interval] The time interval for evaluating spend against the threshold. Currently, only `m
+          #
+          # @param threshold_amount [Integer] The hard spend limit amount, in cents.
+          #
+          # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [OpenAI::Models::Admin::Organization::OrganizationSpendLimit]
+          #
+          # @see OpenAI::Models::Admin::Organization::SpendLimitUpdateParams
+          def update(params)
+            parsed, options = OpenAI::Admin::Organization::SpendLimitUpdateParams.dump_request(params)
+            @client.request(
+              method: :post,
+              path: "organization/spend_limit",
+              body: parsed,
+              model: OpenAI::Admin::Organization::OrganizationSpendLimit,
+              security: {admin_api_key_auth: true},
+              options: options
+            )
+          end
+
+          # Delete the organization's hard spend limit.
+          #
+          # @overload delete(request_options: {})
+          #
+          # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [OpenAI::Models::Admin::Organization::OrganizationSpendLimitDeleted]
+          #
+          # @see OpenAI::Models::Admin::Organization::SpendLimitDeleteParams
+          def delete(params = {})
+            @client.request(
+              method: :delete,
+              path: "organization/spend_limit",
+              model: OpenAI::Admin::Organization::OrganizationSpendLimitDeleted,
+              security: {admin_api_key_auth: true},
+              options: params[:request_options]
+            )
+          end
+
+          # @api private
+          #
+          # @param client [OpenAI::Client]
+          def initialize(client:)
+            @client = client
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -29,6 +29,9 @@ module OpenAI
         # @return [OpenAI::Resources::Admin::Organization::DataRetention]
         attr_reader :data_retention
 
+        # @return [OpenAI::Resources::Admin::Organization::SpendLimit]
+        attr_reader :spend_limit
+
         # @return [OpenAI::Resources::Admin::Organization::SpendAlerts]
         attr_reader :spend_alerts
 
@@ -51,6 +54,7 @@ module OpenAI
           @groups = OpenAI::Resources::Admin::Organization::Groups.new(client: client)
           @roles = OpenAI::Resources::Admin::Organization::Roles.new(client: client)
           @data_retention = OpenAI::Resources::Admin::Organization::DataRetention.new(client: client)
+          @spend_limit = OpenAI::Resources::Admin::Organization::SpendLimit.new(client: client)
           @spend_alerts = OpenAI::Resources::Admin::Organization::SpendAlerts.new(client: client)
           @certificates = OpenAI::Resources::Admin::Organization::Certificates.new(client: client)
           @projects = OpenAI::Resources::Admin::Organization::Projects.new(client: client)

data/lib/openai/resources/beta/responses.rb

@@ -59,7 +59,7 @@ module OpenAI
         #
         # @param prompt [OpenAI::Models::Beta::BetaResponsePrompt, nil] Body param: Reference to a prompt template and its variables.
         #
-        # @param prompt_cache_key [String] Body param: Used by OpenAI to cache responses for similar requests to optimize y
+        # @param prompt_cache_key [String, nil] Body param: Used by OpenAI to cache responses for similar requests to optimize y
         #
         # @param prompt_cache_options [OpenAI::Models::Beta::ResponseCreateParams::PromptCacheOptions] Body param: Options for prompt caching. Supported for `gpt-5.6` and later models
         #
@@ -67,7 +67,7 @@ module OpenAI
         #
         # @param reasoning [OpenAI::Models::Beta::ResponseCreateParams::Reasoning, nil] Body param: **gpt-5 and o-series models only**
         #
-        # @param safety_identifier [String] Body param: A stable identifier used to help detect users of your application th
+        # @param safety_identifier [String, nil] Body param: A stable identifier used to help detect users of your application th
         #
         # @param service_tier [Symbol, OpenAI::Models::Beta::ResponseCreateParams::ServiceTier, nil] Body param: Specifies the processing type used for serving the request.
         #
@@ -165,7 +165,7 @@ module OpenAI
         #
         # @param prompt [OpenAI::Models::Beta::BetaResponsePrompt, nil] Body param: Reference to a prompt template and its variables.
         #
-        # @param prompt_cache_key [String] Body param: Used by OpenAI to cache responses for similar requests to optimize y
+        # @param prompt_cache_key [String, nil] Body param: Used by OpenAI to cache responses for similar requests to optimize y
         #
         # @param prompt_cache_options [OpenAI::Models::Beta::ResponseCreateParams::PromptCacheOptions] Body param: Options for prompt caching. Supported for `gpt-5.6` and later models
         #
@@ -173,7 +173,7 @@ module OpenAI
         #
         # @param reasoning [OpenAI::Models::Beta::ResponseCreateParams::Reasoning, nil] Body param: **gpt-5 and o-series models only**
         #
-        # @param safety_identifier [String] Body param: A stable identifier used to help detect users of your application th
+        # @param safety_identifier [String, nil] Body param: A stable identifier used to help detect users of your application th
         #
         # @param service_tier [Symbol, OpenAI::Models::Beta::ResponseCreateParams::ServiceTier, nil] Body param: Specifies the processing type used for serving the request.
         #

data/lib/openai/resources/chat/completions.rb

@@ -73,7 +73,7 @@ module OpenAI
         #
         # @param presence_penalty [Float, nil] Number between -2.0 and 2.0. Positive values penalize new tokens based on
         #
-        # @param prompt_cache_key [String] Used by OpenAI to cache responses for similar requests to optimize your cache hi
+        # @param prompt_cache_key [String, nil] Used by OpenAI to cache responses for similar requests to optimize your cache hi
         #
         # @param prompt_cache_options [OpenAI::Models::Chat::CompletionCreateParams::PromptCacheOptions] Options for prompt caching. Supported for `gpt-5.6` and later models. By default
         #
@@ -83,7 +83,7 @@ module OpenAI
         #
         # @param response_format [OpenAI::Models::ResponseFormatText, OpenAI::Models::ResponseFormatJSONSchema, OpenAI::Models::ResponseFormatJSONObject] An object specifying the format that the model must output.
         #
-        # @param safety_identifier [String] A stable identifier used to help detect users of your application that may be vi
+        # @param safety_identifier [String, nil] A stable identifier used to help detect users of your application that may be vi
         #
         # @param seed [Integer, nil] This feature is in Beta.
         #
@@ -329,7 +329,7 @@ module OpenAI
         #
         # @param presence_penalty [Float, nil] Number between -2.0 and 2.0. Positive values penalize new tokens based on
         #
-        # @param prompt_cache_key [String] Used by OpenAI to cache responses for similar requests to optimize your cache hi
+        # @param prompt_cache_key [String, nil] Used by OpenAI to cache responses for similar requests to optimize your cache hi
         #
         # @param prompt_cache_options [OpenAI::Models::Chat::CompletionCreateParams::PromptCacheOptions] Options for prompt caching. Supported for `gpt-5.6` and later models. By default
         #
@@ -339,7 +339,7 @@ module OpenAI
         #
         # @param response_format [OpenAI::Models::ResponseFormatText, OpenAI::Models::ResponseFormatJSONSchema, OpenAI::Models::ResponseFormatJSONObject] An object specifying the format that the model must output.
         #
-        # @param safety_identifier [String] A stable identifier used to help detect users of your application that may be vi
+        # @param safety_identifier [String, nil] A stable identifier used to help detect users of your application that may be vi
         #
         # @param seed [Integer, nil] This feature is in Beta.
         #

data/lib/openai/resources/responses.rb

@@ -56,7 +56,7 @@ module OpenAI
       #
       # @param prompt [OpenAI::Models::Responses::ResponsePrompt, nil] Reference to a prompt template and its variables.
       #
-      # @param prompt_cache_key [String] Used by OpenAI to cache responses for similar requests to optimize your cache hi
+      # @param prompt_cache_key [String, nil] Used by OpenAI to cache responses for similar requests to optimize your cache hi
       #
       # @param prompt_cache_options [OpenAI::Models::Responses::ResponseCreateParams::PromptCacheOptions] Options for prompt caching. Supported for `gpt-5.6` and later models. By default
       #
@@ -64,7 +64,7 @@ module OpenAI
       #
       # @param reasoning [OpenAI::Models::Reasoning, nil] **gpt-5 and o-series models only**
       #
-      # @param safety_identifier [String] A stable identifier used to help detect users of your application that may be vi
+      # @param safety_identifier [String, nil] A stable identifier used to help detect users of your application that may be vi
       #
       # @param service_tier [Symbol, OpenAI::Models::Responses::ResponseCreateParams::ServiceTier, nil] Specifies the processing type used for serving the request.
       #
@@ -287,7 +287,7 @@ module OpenAI
       #
       # @param prompt [OpenAI::Models::Responses::ResponsePrompt, nil] Reference to a prompt template and its variables.
       #
-      # @param prompt_cache_key [String] Used by OpenAI to cache responses for similar requests to optimize your cache hi
+      # @param prompt_cache_key [String, nil] Used by OpenAI to cache responses for similar requests to optimize your cache hi
       #
       # @param prompt_cache_options [OpenAI::Models::Responses::ResponseCreateParams::PromptCacheOptions] Options for prompt caching. Supported for `gpt-5.6` and later models. By default
       #
@@ -295,7 +295,7 @@ module OpenAI
       #
       # @param reasoning [OpenAI::Models::Reasoning, nil] **gpt-5 and o-series models only**
       #
-      # @param safety_identifier [String] A stable identifier used to help detect users of your application that may be vi
+      # @param safety_identifier [String, nil] A stable identifier used to help detect users of your application that may be vi
       #
       # @param service_tier [Symbol, OpenAI::Models::Responses::ResponseCreateParams::ServiceTier, nil] Specifies the processing type used for serving the request.
       #

data/lib/openai/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OpenAI
-  VERSION = "0.71.0"
+  VERSION = "0.72.0"
 end

data/lib/openai.rb

@@ -147,6 +147,8 @@ require_relative "openai/models/admin/organization/invite_retrieve_params"
 require_relative "openai/models/admin/organization/organization_data_retention"
 require_relative "openai/models/admin/organization/organization_spend_alert"
 require_relative "openai/models/admin/organization/organization_spend_alert_deleted"
+require_relative "openai/models/admin/organization/organization_spend_limit"
+require_relative "openai/models/admin/organization/organization_spend_limit_deleted"
 require_relative "openai/models/admin/organization/organization_user"
 require_relative "openai/models/admin/organization/project"
 require_relative "openai/models/admin/organization/project_archive_params"
@@ -193,6 +195,8 @@ require_relative "openai/models/admin/organization/projects/project_rate_limit"
 require_relative "openai/models/admin/organization/projects/project_service_account"
 require_relative "openai/models/admin/organization/projects/project_spend_alert"
 require_relative "openai/models/admin/organization/projects/project_spend_alert_deleted"
+require_relative "openai/models/admin/organization/projects/project_spend_limit"
+require_relative "openai/models/admin/organization/projects/project_spend_limit_deleted"
 require_relative "openai/models/admin/organization/projects/project_user"
 require_relative "openai/models/admin/organization/projects/rate_limit_list_rate_limits_params"
 require_relative "openai/models/admin/organization/projects/rate_limit_update_rate_limit_params"
@@ -216,6 +220,9 @@ require_relative "openai/models/admin/organization/projects/spend_alert_delete_p
 require_relative "openai/models/admin/organization/projects/spend_alert_list_params"
 require_relative "openai/models/admin/organization/projects/spend_alert_retrieve_params"
 require_relative "openai/models/admin/organization/projects/spend_alert_update_params"
+require_relative "openai/models/admin/organization/projects/spend_limit_delete_params"
+require_relative "openai/models/admin/organization/projects/spend_limit_retrieve_params"
+require_relative "openai/models/admin/organization/projects/spend_limit_update_params"
 require_relative "openai/models/admin/organization/projects/user_create_params"
 require_relative "openai/models/admin/organization/projects/user_delete_params"
 require_relative "openai/models/admin/organization/projects/user_delete_response"
@@ -243,6 +250,9 @@ require_relative "openai/models/admin/organization/spend_alert_delete_params"
 require_relative "openai/models/admin/organization/spend_alert_list_params"
 require_relative "openai/models/admin/organization/spend_alert_retrieve_params"
 require_relative "openai/models/admin/organization/spend_alert_update_params"
+require_relative "openai/models/admin/organization/spend_limit_delete_params"
+require_relative "openai/models/admin/organization/spend_limit_retrieve_params"
+require_relative "openai/models/admin/organization/spend_limit_update_params"
 require_relative "openai/models/admin/organization/usage_audio_speeches_params"
 require_relative "openai/models/admin/organization/usage_audio_speeches_response"
 require_relative "openai/models/admin/organization/usage_audio_transcriptions_params"
@@ -1169,10 +1179,12 @@ require_relative "openai/resources/admin/organization/projects/roles"
 require_relative "openai/resources/admin/organization/projects/service_accounts"
 require_relative "openai/resources/admin/organization/projects/service_accounts/api_keys"
 require_relative "openai/resources/admin/organization/projects/spend_alerts"
+require_relative "openai/resources/admin/organization/projects/spend_limit"
 require_relative "openai/resources/admin/organization/projects/users"
 require_relative "openai/resources/admin/organization/projects/users/roles"
 require_relative "openai/resources/admin/organization/roles"
 require_relative "openai/resources/admin/organization/spend_alerts"
+require_relative "openai/resources/admin/organization/spend_limit"
 require_relative "openai/resources/admin/organization/usage"
 require_relative "openai/resources/admin/organization/users"
 require_relative "openai/resources/admin/organization/users/roles"

data/rbi/openai/models/admin/organization/organization_spend_limit.rbi

@@ -0,0 +1,278 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Admin
+      OrganizationSpendLimit = Organization::OrganizationSpendLimit
+
+      module Organization
+        class OrganizationSpendLimit < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Admin::Organization::OrganizationSpendLimit,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # The currency for the threshold amount. Currently, only `USD` is supported.
+          sig do
+            returns(
+              OpenAI::Admin::Organization::OrganizationSpendLimit::Currency::Variants
+            )
+          end
+          attr_accessor :currency
+
+          # The current enforcement state of the hard spend limit.
+          sig do
+            returns(
+              OpenAI::Admin::Organization::OrganizationSpendLimit::Enforcement
+            )
+          end
+          attr_reader :enforcement
+
+          sig do
+            params(
+              enforcement:
+                OpenAI::Admin::Organization::OrganizationSpendLimit::Enforcement::OrHash
+            ).void
+          end
+          attr_writer :enforcement
+
+          # The time interval for evaluating spend against the threshold. Currently, only
+          # `month` is supported.
+          sig do
+            returns(
+              OpenAI::Admin::Organization::OrganizationSpendLimit::Interval::Variants
+            )
+          end
+          attr_accessor :interval
+
+          # The object type, which is always `organization.spend_limit`.
+          sig { returns(Symbol) }
+          attr_accessor :object
+
+          # The hard spend limit amount, in cents.
+          sig { returns(Integer) }
+          attr_accessor :threshold_amount
+
+          # Represents a hard spend limit configured at the organization level.
+          sig do
+            params(
+              currency:
+                T.any(
+                  String,
+                  OpenAI::Admin::Organization::OrganizationSpendLimit::Currency::OrSymbol
+                ),
+              enforcement:
+                OpenAI::Admin::Organization::OrganizationSpendLimit::Enforcement::OrHash,
+              interval:
+                T.any(
+                  String,
+                  OpenAI::Admin::Organization::OrganizationSpendLimit::Interval::OrSymbol
+                ),
+              threshold_amount: Integer,
+              object: Symbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The currency for the threshold amount. Currently, only `USD` is supported.
+            currency:,
+            # The current enforcement state of the hard spend limit.
+            enforcement:,
+            # The time interval for evaluating spend against the threshold. Currently, only
+            # `month` is supported.
+            interval:,
+            # The hard spend limit amount, in cents.
+            threshold_amount:,
+            # The object type, which is always `organization.spend_limit`.
+            object: :"organization.spend_limit"
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                currency:
+                  OpenAI::Admin::Organization::OrganizationSpendLimit::Currency::Variants,
+                enforcement:
+                  OpenAI::Admin::Organization::OrganizationSpendLimit::Enforcement,
+                interval:
+                  OpenAI::Admin::Organization::OrganizationSpendLimit::Interval::Variants,
+                object: Symbol,
+                threshold_amount: Integer
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # The currency for the threshold amount. Currently, only `USD` is supported.
+          module Currency
+            extend OpenAI::Internal::Type::Union
+
+            Variants =
+              T.type_alias do
+                T.any(
+                  String,
+                  OpenAI::Admin::Organization::OrganizationSpendLimit::Currency::TaggedSymbol
+                )
+              end
+
+            sig do
+              override.returns(
+                T::Array[
+                  OpenAI::Admin::Organization::OrganizationSpendLimit::Currency::Variants
+                ]
+              )
+            end
+            def self.variants
+            end
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  OpenAI::Admin::Organization::OrganizationSpendLimit::Currency
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            USD =
+              T.let(
+                :USD,
+                OpenAI::Admin::Organization::OrganizationSpendLimit::Currency::TaggedSymbol
+              )
+          end
+
+          class Enforcement < OpenAI::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  OpenAI::Admin::Organization::OrganizationSpendLimit::Enforcement,
+                  OpenAI::Internal::AnyHash
+                )
+              end
+
+            # Whether the hard spend limit is currently enforcing.
+            sig do
+              returns(
+                OpenAI::Admin::Organization::OrganizationSpendLimit::Enforcement::Status::Variants
+              )
+            end
+            attr_accessor :status
+
+            # The current enforcement state of the hard spend limit.
+            sig do
+              params(
+                status:
+                  T.any(
+                    String,
+                    OpenAI::Admin::Organization::OrganizationSpendLimit::Enforcement::Status::OrSymbol
+                  )
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # Whether the hard spend limit is currently enforcing.
+              status:
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  status:
+                    OpenAI::Admin::Organization::OrganizationSpendLimit::Enforcement::Status::Variants
+                }
+              )
+            end
+            def to_hash
+            end
+
+            # Whether the hard spend limit is currently enforcing.
+            module Status
+              extend OpenAI::Internal::Type::Union
+
+              Variants =
+                T.type_alias do
+                  T.any(
+                    String,
+                    OpenAI::Admin::Organization::OrganizationSpendLimit::Enforcement::Status::TaggedSymbol
+                  )
+                end
+
+              sig do
+                override.returns(
+                  T::Array[
+                    OpenAI::Admin::Organization::OrganizationSpendLimit::Enforcement::Status::Variants
+                  ]
+                )
+              end
+              def self.variants
+              end
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    OpenAI::Admin::Organization::OrganizationSpendLimit::Enforcement::Status
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              INACTIVE =
+                T.let(
+                  :inactive,
+                  OpenAI::Admin::Organization::OrganizationSpendLimit::Enforcement::Status::TaggedSymbol
+                )
+              ENFORCING =
+                T.let(
+                  :enforcing,
+                  OpenAI::Admin::Organization::OrganizationSpendLimit::Enforcement::Status::TaggedSymbol
+                )
+            end
+          end
+
+          # The time interval for evaluating spend against the threshold. Currently, only
+          # `month` is supported.
+          module Interval
+            extend OpenAI::Internal::Type::Union
+
+            Variants =
+              T.type_alias do
+                T.any(
+                  String,
+                  OpenAI::Admin::Organization::OrganizationSpendLimit::Interval::TaggedSymbol
+                )
+              end
+
+            sig do
+              override.returns(
+                T::Array[
+                  OpenAI::Admin::Organization::OrganizationSpendLimit::Interval::Variants
+                ]
+              )
+            end
+            def self.variants
+            end
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  OpenAI::Admin::Organization::OrganizationSpendLimit::Interval
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            MONTH =
+              T.let(
+                :month,
+                OpenAI::Admin::Organization::OrganizationSpendLimit::Interval::TaggedSymbol
+              )
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/admin/organization/organization_spend_limit_deleted.rbi

@@ -0,0 +1,48 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Admin
+      OrganizationSpendLimitDeleted =
+        Organization::OrganizationSpendLimitDeleted
+
+      module Organization
+        class OrganizationSpendLimitDeleted < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Admin::Organization::OrganizationSpendLimitDeleted,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # Whether the hard spend limit was deleted.
+          sig { returns(T::Boolean) }
+          attr_accessor :deleted
+
+          # The object type, which is always `organization.spend_limit.deleted`.
+          sig { returns(Symbol) }
+          attr_accessor :object
+
+          # Confirmation payload returned after deleting an organization hard spend limit.
+          sig do
+            params(deleted: T::Boolean, object: Symbol).returns(
+              T.attached_class
+            )
+          end
+          def self.new(
+            # Whether the hard spend limit was deleted.
+            deleted:,
+            # The object type, which is always `organization.spend_limit.deleted`.
+            object: :"organization.spend_limit.deleted"
+          )
+          end
+
+          sig { override.returns({ deleted: T::Boolean, object: Symbol }) }
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end