openai 0.63.0 → 0.64.0

data/rbi/openai/models/admin/organization/projects/spend_alert_create_params.rbi

@@ -0,0 +1,220 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        module Projects
+          class SpendAlertCreateParams < OpenAI::Internal::Type::BaseModel
+            extend OpenAI::Internal::Type::RequestParameters::Converter
+            include OpenAI::Internal::Type::RequestParameters
+
+            OrHash =
+              T.type_alias do
+                T.any(
+                  OpenAI::Admin::Organization::Projects::SpendAlertCreateParams,
+                  OpenAI::Internal::AnyHash
+                )
+              end
+
+            sig { returns(String) }
+            attr_accessor :project_id
+
+            # The currency for the threshold amount.
+            sig do
+              returns(
+                OpenAI::Admin::Organization::Projects::SpendAlertCreateParams::Currency::OrSymbol
+              )
+            end
+            attr_accessor :currency
+
+            # The time interval for evaluating spend against the threshold.
+            sig do
+              returns(
+                OpenAI::Admin::Organization::Projects::SpendAlertCreateParams::Interval::OrSymbol
+              )
+            end
+            attr_accessor :interval
+
+            # Email notification settings for a spend alert.
+            sig do
+              returns(
+                OpenAI::Admin::Organization::Projects::SpendAlertCreateParams::NotificationChannel
+              )
+            end
+            attr_reader :notification_channel
+
+            sig do
+              params(
+                notification_channel:
+                  OpenAI::Admin::Organization::Projects::SpendAlertCreateParams::NotificationChannel::OrHash
+              ).void
+            end
+            attr_writer :notification_channel
+
+            # The alert threshold amount, in cents.
+            sig { returns(Integer) }
+            attr_accessor :threshold_amount
+
+            sig do
+              params(
+                project_id: String,
+                currency:
+                  OpenAI::Admin::Organization::Projects::SpendAlertCreateParams::Currency::OrSymbol,
+                interval:
+                  OpenAI::Admin::Organization::Projects::SpendAlertCreateParams::Interval::OrSymbol,
+                notification_channel:
+                  OpenAI::Admin::Organization::Projects::SpendAlertCreateParams::NotificationChannel::OrHash,
+                threshold_amount: Integer,
+                request_options: OpenAI::RequestOptions::OrHash
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              project_id:,
+              # The currency for the threshold amount.
+              currency:,
+              # The time interval for evaluating spend against the threshold.
+              interval:,
+              # Email notification settings for a spend alert.
+              notification_channel:,
+              # The alert threshold amount, in cents.
+              threshold_amount:,
+              request_options: {}
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  project_id: String,
+                  currency:
+                    OpenAI::Admin::Organization::Projects::SpendAlertCreateParams::Currency::OrSymbol,
+                  interval:
+                    OpenAI::Admin::Organization::Projects::SpendAlertCreateParams::Interval::OrSymbol,
+                  notification_channel:
+                    OpenAI::Admin::Organization::Projects::SpendAlertCreateParams::NotificationChannel,
+                  threshold_amount: Integer,
+                  request_options: OpenAI::RequestOptions
+                }
+              )
+            end
+            def to_hash
+            end
+
+            # The currency for the threshold amount.
+            module Currency
+              extend OpenAI::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    OpenAI::Admin::Organization::Projects::SpendAlertCreateParams::Currency
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              USD =
+                T.let(
+                  :USD,
+                  OpenAI::Admin::Organization::Projects::SpendAlertCreateParams::Currency::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    OpenAI::Admin::Organization::Projects::SpendAlertCreateParams::Currency::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+
+            # The time interval for evaluating spend against the threshold.
+            module Interval
+              extend OpenAI::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    OpenAI::Admin::Organization::Projects::SpendAlertCreateParams::Interval
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              MONTH =
+                T.let(
+                  :month,
+                  OpenAI::Admin::Organization::Projects::SpendAlertCreateParams::Interval::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    OpenAI::Admin::Organization::Projects::SpendAlertCreateParams::Interval::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+
+            class NotificationChannel < OpenAI::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    OpenAI::Admin::Organization::Projects::SpendAlertCreateParams::NotificationChannel,
+                    OpenAI::Internal::AnyHash
+                  )
+                end
+
+              # Email addresses that receive the spend alert notification.
+              sig { returns(T::Array[String]) }
+              attr_accessor :recipients
+
+              # The notification channel type. Currently only `email` is supported.
+              sig { returns(Symbol) }
+              attr_accessor :type
+
+              # Optional subject prefix for alert emails.
+              sig { returns(T.nilable(String)) }
+              attr_accessor :subject_prefix
+
+              # Email notification settings for a spend alert.
+              sig do
+                params(
+                  recipients: T::Array[String],
+                  subject_prefix: T.nilable(String),
+                  type: Symbol
+                ).returns(T.attached_class)
+              end
+              def self.new(
+                # Email addresses that receive the spend alert notification.
+                recipients:,
+                # Optional subject prefix for alert emails.
+                subject_prefix: nil,
+                # The notification channel type. Currently only `email` is supported.
+                type: :email
+              )
+              end
+
+              sig do
+                override.returns(
+                  {
+                    recipients: T::Array[String],
+                    type: Symbol,
+                    subject_prefix: T.nilable(String)
+                  }
+                )
+              end
+              def to_hash
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/admin/organization/projects/spend_alert_delete_params.rbi

@@ -0,0 +1,52 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        module Projects
+          class SpendAlertDeleteParams < OpenAI::Internal::Type::BaseModel
+            extend OpenAI::Internal::Type::RequestParameters::Converter
+            include OpenAI::Internal::Type::RequestParameters
+
+            OrHash =
+              T.type_alias do
+                T.any(
+                  OpenAI::Admin::Organization::Projects::SpendAlertDeleteParams,
+                  OpenAI::Internal::AnyHash
+                )
+              end
+
+            sig { returns(String) }
+            attr_accessor :project_id
+
+            sig { returns(String) }
+            attr_accessor :alert_id
+
+            sig do
+              params(
+                project_id: String,
+                alert_id: String,
+                request_options: OpenAI::RequestOptions::OrHash
+              ).returns(T.attached_class)
+            end
+            def self.new(project_id:, alert_id:, request_options: {})
+            end
+
+            sig do
+              override.returns(
+                {
+                  project_id: String,
+                  alert_id: String,
+                  request_options: OpenAI::RequestOptions
+                }
+              )
+            end
+            def to_hash
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/admin/organization/projects/spend_alert_list_params.rbi

@@ -0,0 +1,146 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        module Projects
+          class SpendAlertListParams < OpenAI::Internal::Type::BaseModel
+            extend OpenAI::Internal::Type::RequestParameters::Converter
+            include OpenAI::Internal::Type::RequestParameters
+
+            OrHash =
+              T.type_alias do
+                T.any(
+                  OpenAI::Admin::Organization::Projects::SpendAlertListParams,
+                  OpenAI::Internal::AnyHash
+                )
+              end
+
+            sig { returns(String) }
+            attr_accessor :project_id
+
+            # Cursor for pagination. Provide the ID of the last spend alert from the previous
+            # response to fetch the next page.
+            sig { returns(T.nilable(String)) }
+            attr_reader :after
+
+            sig { params(after: String).void }
+            attr_writer :after
+
+            # Cursor for pagination. Provide the ID of the first spend alert from the previous
+            # response to fetch the previous page.
+            sig { returns(T.nilable(String)) }
+            attr_reader :before
+
+            sig { params(before: String).void }
+            attr_writer :before
+
+            # A limit on the number of spend alerts to return. Defaults to 20.
+            sig { returns(T.nilable(Integer)) }
+            attr_reader :limit
+
+            sig { params(limit: Integer).void }
+            attr_writer :limit
+
+            # Sort order for the returned spend alerts.
+            sig do
+              returns(
+                T.nilable(
+                  OpenAI::Admin::Organization::Projects::SpendAlertListParams::Order::OrSymbol
+                )
+              )
+            end
+            attr_reader :order
+
+            sig do
+              params(
+                order:
+                  OpenAI::Admin::Organization::Projects::SpendAlertListParams::Order::OrSymbol
+              ).void
+            end
+            attr_writer :order
+
+            sig do
+              params(
+                project_id: String,
+                after: String,
+                before: String,
+                limit: Integer,
+                order:
+                  OpenAI::Admin::Organization::Projects::SpendAlertListParams::Order::OrSymbol,
+                request_options: OpenAI::RequestOptions::OrHash
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              project_id:,
+              # Cursor for pagination. Provide the ID of the last spend alert from the previous
+              # response to fetch the next page.
+              after: nil,
+              # Cursor for pagination. Provide the ID of the first spend alert from the previous
+              # response to fetch the previous page.
+              before: nil,
+              # A limit on the number of spend alerts to return. Defaults to 20.
+              limit: nil,
+              # Sort order for the returned spend alerts.
+              order: nil,
+              request_options: {}
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  project_id: String,
+                  after: String,
+                  before: String,
+                  limit: Integer,
+                  order:
+                    OpenAI::Admin::Organization::Projects::SpendAlertListParams::Order::OrSymbol,
+                  request_options: OpenAI::RequestOptions
+                }
+              )
+            end
+            def to_hash
+            end
+
+            # Sort order for the returned spend alerts.
+            module Order
+              extend OpenAI::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    OpenAI::Admin::Organization::Projects::SpendAlertListParams::Order
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              ASC =
+                T.let(
+                  :asc,
+                  OpenAI::Admin::Organization::Projects::SpendAlertListParams::Order::TaggedSymbol
+                )
+              DESC =
+                T.let(
+                  :desc,
+                  OpenAI::Admin::Organization::Projects::SpendAlertListParams::Order::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    OpenAI::Admin::Organization::Projects::SpendAlertListParams::Order::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/admin/organization/projects/spend_alert_update_params.rbi

@@ -0,0 +1,226 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        module Projects
+          class SpendAlertUpdateParams < OpenAI::Internal::Type::BaseModel
+            extend OpenAI::Internal::Type::RequestParameters::Converter
+            include OpenAI::Internal::Type::RequestParameters
+
+            OrHash =
+              T.type_alias do
+                T.any(
+                  OpenAI::Admin::Organization::Projects::SpendAlertUpdateParams,
+                  OpenAI::Internal::AnyHash
+                )
+              end
+
+            sig { returns(String) }
+            attr_accessor :project_id
+
+            sig { returns(String) }
+            attr_accessor :alert_id
+
+            # The currency for the threshold amount.
+            sig do
+              returns(
+                OpenAI::Admin::Organization::Projects::SpendAlertUpdateParams::Currency::OrSymbol
+              )
+            end
+            attr_accessor :currency
+
+            # The time interval for evaluating spend against the threshold.
+            sig do
+              returns(
+                OpenAI::Admin::Organization::Projects::SpendAlertUpdateParams::Interval::OrSymbol
+              )
+            end
+            attr_accessor :interval
+
+            # Email notification settings for a spend alert.
+            sig do
+              returns(
+                OpenAI::Admin::Organization::Projects::SpendAlertUpdateParams::NotificationChannel
+              )
+            end
+            attr_reader :notification_channel
+
+            sig do
+              params(
+                notification_channel:
+                  OpenAI::Admin::Organization::Projects::SpendAlertUpdateParams::NotificationChannel::OrHash
+              ).void
+            end
+            attr_writer :notification_channel
+
+            # The alert threshold amount, in cents.
+            sig { returns(Integer) }
+            attr_accessor :threshold_amount
+
+            sig do
+              params(
+                project_id: String,
+                alert_id: String,
+                currency:
+                  OpenAI::Admin::Organization::Projects::SpendAlertUpdateParams::Currency::OrSymbol,
+                interval:
+                  OpenAI::Admin::Organization::Projects::SpendAlertUpdateParams::Interval::OrSymbol,
+                notification_channel:
+                  OpenAI::Admin::Organization::Projects::SpendAlertUpdateParams::NotificationChannel::OrHash,
+                threshold_amount: Integer,
+                request_options: OpenAI::RequestOptions::OrHash
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              project_id:,
+              alert_id:,
+              # The currency for the threshold amount.
+              currency:,
+              # The time interval for evaluating spend against the threshold.
+              interval:,
+              # Email notification settings for a spend alert.
+              notification_channel:,
+              # The alert threshold amount, in cents.
+              threshold_amount:,
+              request_options: {}
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  project_id: String,
+                  alert_id: String,
+                  currency:
+                    OpenAI::Admin::Organization::Projects::SpendAlertUpdateParams::Currency::OrSymbol,
+                  interval:
+                    OpenAI::Admin::Organization::Projects::SpendAlertUpdateParams::Interval::OrSymbol,
+                  notification_channel:
+                    OpenAI::Admin::Organization::Projects::SpendAlertUpdateParams::NotificationChannel,
+                  threshold_amount: Integer,
+                  request_options: OpenAI::RequestOptions
+                }
+              )
+            end
+            def to_hash
+            end
+
+            # The currency for the threshold amount.
+            module Currency
+              extend OpenAI::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    OpenAI::Admin::Organization::Projects::SpendAlertUpdateParams::Currency
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              USD =
+                T.let(
+                  :USD,
+                  OpenAI::Admin::Organization::Projects::SpendAlertUpdateParams::Currency::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    OpenAI::Admin::Organization::Projects::SpendAlertUpdateParams::Currency::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+
+            # The time interval for evaluating spend against the threshold.
+            module Interval
+              extend OpenAI::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    OpenAI::Admin::Organization::Projects::SpendAlertUpdateParams::Interval
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              MONTH =
+                T.let(
+                  :month,
+                  OpenAI::Admin::Organization::Projects::SpendAlertUpdateParams::Interval::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    OpenAI::Admin::Organization::Projects::SpendAlertUpdateParams::Interval::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+
+            class NotificationChannel < OpenAI::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    OpenAI::Admin::Organization::Projects::SpendAlertUpdateParams::NotificationChannel,
+                    OpenAI::Internal::AnyHash
+                  )
+                end
+
+              # Email addresses that receive the spend alert notification.
+              sig { returns(T::Array[String]) }
+              attr_accessor :recipients
+
+              # The notification channel type. Currently only `email` is supported.
+              sig { returns(Symbol) }
+              attr_accessor :type
+
+              # Optional subject prefix for alert emails.
+              sig { returns(T.nilable(String)) }
+              attr_accessor :subject_prefix
+
+              # Email notification settings for a spend alert.
+              sig do
+                params(
+                  recipients: T::Array[String],
+                  subject_prefix: T.nilable(String),
+                  type: Symbol
+                ).returns(T.attached_class)
+              end
+              def self.new(
+                # Email addresses that receive the spend alert notification.
+                recipients:,
+                # Optional subject prefix for alert emails.
+                subject_prefix: nil,
+                # The notification channel type. Currently only `email` is supported.
+                type: :email
+              )
+              end
+
+              sig do
+                override.returns(
+                  {
+                    recipients: T::Array[String],
+                    type: Symbol,
+                    subject_prefix: T.nilable(String)
+                  }
+                )
+              end
+              def to_hash
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end