openai 0.63.0 → 0.65.0

data/rbi/openai/models/admin/organization/projects/users/role_retrieve_response.rbi

@@ -0,0 +1,188 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        module Projects
+          module Users
+            class RoleRetrieveResponse < OpenAI::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    OpenAI::Models::Admin::Organization::Projects::Users::RoleRetrieveResponse,
+                    OpenAI::Internal::AnyHash
+                  )
+                end
+
+              # Identifier for the role.
+              sig { returns(String) }
+              attr_accessor :id
+
+              # Principals from which the role assignment is inherited, when available.
+              sig do
+                returns(
+                  T.nilable(
+                    T::Array[
+                      OpenAI::Models::Admin::Organization::Projects::Users::RoleRetrieveResponse::AssignmentSource
+                    ]
+                  )
+                )
+              end
+              attr_accessor :assignment_sources
+
+              # When the role was created.
+              sig { returns(T.nilable(Integer)) }
+              attr_accessor :created_at
+
+              # Identifier of the actor who created the role.
+              sig { returns(T.nilable(String)) }
+              attr_accessor :created_by
+
+              # User details for the actor that created the role, when available.
+              sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+              attr_accessor :created_by_user_obj
+
+              # Description of the role.
+              sig { returns(T.nilable(String)) }
+              attr_accessor :description
+
+              # Arbitrary metadata stored on the role.
+              sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+              attr_accessor :metadata
+
+              # Name of the role.
+              sig { returns(String) }
+              attr_accessor :name
+
+              # Permissions associated with the role.
+              sig { returns(T::Array[String]) }
+              attr_accessor :permissions
+
+              # Whether the role is predefined by OpenAI.
+              sig { returns(T::Boolean) }
+              attr_accessor :predefined_role
+
+              # Resource type the role applies to.
+              sig { returns(String) }
+              attr_accessor :resource_type
+
+              # When the role was last updated.
+              sig { returns(T.nilable(Integer)) }
+              attr_accessor :updated_at
+
+              # Detailed information about a role assignment entry returned when listing
+              # assignments.
+              sig do
+                params(
+                  id: String,
+                  assignment_sources:
+                    T.nilable(
+                      T::Array[
+                        OpenAI::Models::Admin::Organization::Projects::Users::RoleRetrieveResponse::AssignmentSource::OrHash
+                      ]
+                    ),
+                  created_at: T.nilable(Integer),
+                  created_by: T.nilable(String),
+                  created_by_user_obj: T.nilable(T::Hash[Symbol, T.anything]),
+                  description: T.nilable(String),
+                  metadata: T.nilable(T::Hash[Symbol, T.anything]),
+                  name: String,
+                  permissions: T::Array[String],
+                  predefined_role: T::Boolean,
+                  resource_type: String,
+                  updated_at: T.nilable(Integer)
+                ).returns(T.attached_class)
+              end
+              def self.new(
+                # Identifier for the role.
+                id:,
+                # Principals from which the role assignment is inherited, when available.
+                assignment_sources:,
+                # When the role was created.
+                created_at:,
+                # Identifier of the actor who created the role.
+                created_by:,
+                # User details for the actor that created the role, when available.
+                created_by_user_obj:,
+                # Description of the role.
+                description:,
+                # Arbitrary metadata stored on the role.
+                metadata:,
+                # Name of the role.
+                name:,
+                # Permissions associated with the role.
+                permissions:,
+                # Whether the role is predefined by OpenAI.
+                predefined_role:,
+                # Resource type the role applies to.
+                resource_type:,
+                # When the role was last updated.
+                updated_at:
+              )
+              end
+
+              sig do
+                override.returns(
+                  {
+                    id: String,
+                    assignment_sources:
+                      T.nilable(
+                        T::Array[
+                          OpenAI::Models::Admin::Organization::Projects::Users::RoleRetrieveResponse::AssignmentSource
+                        ]
+                      ),
+                    created_at: T.nilable(Integer),
+                    created_by: T.nilable(String),
+                    created_by_user_obj: T.nilable(T::Hash[Symbol, T.anything]),
+                    description: T.nilable(String),
+                    metadata: T.nilable(T::Hash[Symbol, T.anything]),
+                    name: String,
+                    permissions: T::Array[String],
+                    predefined_role: T::Boolean,
+                    resource_type: String,
+                    updated_at: T.nilable(Integer)
+                  }
+                )
+              end
+              def to_hash
+              end
+
+              class AssignmentSource < OpenAI::Internal::Type::BaseModel
+                OrHash =
+                  T.type_alias do
+                    T.any(
+                      OpenAI::Models::Admin::Organization::Projects::Users::RoleRetrieveResponse::AssignmentSource,
+                      OpenAI::Internal::AnyHash
+                    )
+                  end
+
+                sig { returns(String) }
+                attr_accessor :principal_id
+
+                sig { returns(String) }
+                attr_accessor :principal_type
+
+                sig do
+                  params(principal_id: String, principal_type: String).returns(
+                    T.attached_class
+                  )
+                end
+                def self.new(principal_id:, principal_type:)
+                end
+
+                sig do
+                  override.returns(
+                    { principal_id: String, principal_type: String }
+                  )
+                end
+                def to_hash
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        class RoleRetrieveParams < 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::RoleRetrieveParams,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :role_id
+
+          sig do
+            params(
+              role_id: String,
+              request_options: OpenAI::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(role_id:, request_options: {})
+          end
+
+          sig do
+            override.returns(
+              { role_id: String, request_options: OpenAI::RequestOptions }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,212 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        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::SpendAlertCreateParams,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # The currency for the threshold amount.
+          sig do
+            returns(
+              OpenAI::Admin::Organization::SpendAlertCreateParams::Currency::OrSymbol
+            )
+          end
+          attr_accessor :currency
+
+          # The time interval for evaluating spend against the threshold.
+          sig do
+            returns(
+              OpenAI::Admin::Organization::SpendAlertCreateParams::Interval::OrSymbol
+            )
+          end
+          attr_accessor :interval
+
+          # Email notification settings for a spend alert.
+          sig do
+            returns(
+              OpenAI::Admin::Organization::SpendAlertCreateParams::NotificationChannel
+            )
+          end
+          attr_reader :notification_channel
+
+          sig do
+            params(
+              notification_channel:
+                OpenAI::Admin::Organization::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(
+              currency:
+                OpenAI::Admin::Organization::SpendAlertCreateParams::Currency::OrSymbol,
+              interval:
+                OpenAI::Admin::Organization::SpendAlertCreateParams::Interval::OrSymbol,
+              notification_channel:
+                OpenAI::Admin::Organization::SpendAlertCreateParams::NotificationChannel::OrHash,
+              threshold_amount: Integer,
+              request_options: OpenAI::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # 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(
+              {
+                currency:
+                  OpenAI::Admin::Organization::SpendAlertCreateParams::Currency::OrSymbol,
+                interval:
+                  OpenAI::Admin::Organization::SpendAlertCreateParams::Interval::OrSymbol,
+                notification_channel:
+                  OpenAI::Admin::Organization::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::SpendAlertCreateParams::Currency
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            USD =
+              T.let(
+                :USD,
+                OpenAI::Admin::Organization::SpendAlertCreateParams::Currency::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  OpenAI::Admin::Organization::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::SpendAlertCreateParams::Interval
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            MONTH =
+              T.let(
+                :month,
+                OpenAI::Admin::Organization::SpendAlertCreateParams::Interval::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  OpenAI::Admin::Organization::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::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

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

@@ -0,0 +1,42 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        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::SpendAlertDeleteParams,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :alert_id
+
+          sig do
+            params(
+              alert_id: String,
+              request_options: OpenAI::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(alert_id:, request_options: {})
+          end
+
+          sig do
+            override.returns(
+              { alert_id: String, request_options: OpenAI::RequestOptions }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,138 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        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::SpendAlertListParams,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # 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::SpendAlertListParams::Order::OrSymbol
+              )
+            )
+          end
+          attr_reader :order
+
+          sig do
+            params(
+              order:
+                OpenAI::Admin::Organization::SpendAlertListParams::Order::OrSymbol
+            ).void
+          end
+          attr_writer :order
+
+          sig do
+            params(
+              after: String,
+              before: String,
+              limit: Integer,
+              order:
+                OpenAI::Admin::Organization::SpendAlertListParams::Order::OrSymbol,
+              request_options: OpenAI::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # 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(
+              {
+                after: String,
+                before: String,
+                limit: Integer,
+                order:
+                  OpenAI::Admin::Organization::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::SpendAlertListParams::Order
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            ASC =
+              T.let(
+                :asc,
+                OpenAI::Admin::Organization::SpendAlertListParams::Order::TaggedSymbol
+              )
+            DESC =
+              T.let(
+                :desc,
+                OpenAI::Admin::Organization::SpendAlertListParams::Order::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  OpenAI::Admin::Organization::SpendAlertListParams::Order::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+      end
+    end
+  end
+end