openai 0.63.0 → 0.64.0

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        module Projects
+          module Users
+            # @see OpenAI::Resources::Admin::Organization::Projects::Users::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 user_id
+              #
+              #   @return [String]
+              required :user_id, String
+
+              # @!attribute role_id
+              #
+              #   @return [String]
+              required :role_id, String
+
+              # @!method initialize(project_id:, user_id:, role_id:, request_options: {})
+              #   @param project_id [String]
+              #   @param user_id [String]
+              #   @param role_id [String]
+              #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/admin/organization/projects/users/role_retrieve_response.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        module Projects
+          module Users
+            # @see OpenAI::Resources::Admin::Organization::Projects::Users::Roles#retrieve
+            class RoleRetrieveResponse < OpenAI::Internal::Type::BaseModel
+              # @!attribute id
+              #   Identifier for the role.
+              #
+              #   @return [String]
+              required :id, String
+
+              # @!attribute assignment_sources
+              #   Principals from which the role assignment is inherited, when available.
+              #
+              #   @return [Array<OpenAI::Models::Admin::Organization::Projects::Users::RoleRetrieveResponse::AssignmentSource>, nil]
+              required :assignment_sources,
+                       -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Models::Admin::Organization::Projects::Users::RoleRetrieveResponse::AssignmentSource] },
+                       nil?: true
+
+              # @!attribute created_at
+              #   When the role was created.
+              #
+              #   @return [Integer, nil]
+              required :created_at, Integer, nil?: true
+
+              # @!attribute created_by
+              #   Identifier of the actor who created the role.
+              #
+              #   @return [String, nil]
+              required :created_by, String, nil?: true
+
+              # @!attribute created_by_user_obj
+              #   User details for the actor that created the role, when available.
+              #
+              #   @return [Hash{Symbol=>Object}, nil]
+              required :created_by_user_obj,
+                       OpenAI::Internal::Type::HashOf[OpenAI::Internal::Type::Unknown],
+                       nil?: true
+
+              # @!attribute description
+              #   Description of the role.
+              #
+              #   @return [String, nil]
+              required :description, String, nil?: true
+
+              # @!attribute metadata
+              #   Arbitrary metadata stored on the role.
+              #
+              #   @return [Hash{Symbol=>Object}, nil]
+              required :metadata, OpenAI::Internal::Type::HashOf[OpenAI::Internal::Type::Unknown], nil?: true
+
+              # @!attribute name
+              #   Name of the role.
+              #
+              #   @return [String]
+              required :name, String
+
+              # @!attribute permissions
+              #   Permissions associated with the role.
+              #
+              #   @return [Array<String>]
+              required :permissions, OpenAI::Internal::Type::ArrayOf[String]
+
+              # @!attribute predefined_role
+              #   Whether the role is predefined by OpenAI.
+              #
+              #   @return [Boolean]
+              required :predefined_role, OpenAI::Internal::Type::Boolean
+
+              # @!attribute resource_type
+              #   Resource type the role applies to.
+              #
+              #   @return [String]
+              required :resource_type, String
+
+              # @!attribute updated_at
+              #   When the role was last updated.
+              #
+              #   @return [Integer, nil]
+              required :updated_at, Integer, nil?: true
+
+              # @!method initialize(id:, assignment_sources:, created_at:, created_by:, created_by_user_obj:, description:, metadata:, name:, permissions:, predefined_role:, resource_type:, updated_at:)
+              #   Detailed information about a role assignment entry returned when listing
+              #   assignments.
+              #
+              #   @param id [String] Identifier for the role.
+              #
+              #   @param assignment_sources [Array<OpenAI::Models::Admin::Organization::Projects::Users::RoleRetrieveResponse::AssignmentSource>, nil] Principals from which the role assignment is inherited, when available.
+              #
+              #   @param created_at [Integer, nil] When the role was created.
+              #
+              #   @param created_by [String, nil] Identifier of the actor who created the role.
+              #
+              #   @param created_by_user_obj [Hash{Symbol=>Object}, nil] User details for the actor that created the role, when available.
+              #
+              #   @param description [String, nil] Description of the role.
+              #
+              #   @param metadata [Hash{Symbol=>Object}, nil] Arbitrary metadata stored on the role.
+              #
+              #   @param name [String] Name of the role.
+              #
+              #   @param permissions [Array<String>] Permissions associated with the role.
+              #
+              #   @param predefined_role [Boolean] Whether the role is predefined by OpenAI.
+              #
+              #   @param resource_type [String] Resource type the role applies to.
+              #
+              #   @param updated_at [Integer, nil] When the role was last updated.
+
+              class AssignmentSource < OpenAI::Internal::Type::BaseModel
+                # @!attribute principal_id
+                #
+                #   @return [String]
+                required :principal_id, String
+
+                # @!attribute principal_type
+                #
+                #   @return [String]
+                required :principal_type, String
+
+                # @!method initialize(principal_id:, principal_type:)
+                #   @param principal_id [String]
+                #   @param principal_type [String]
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        # @see OpenAI::Resources::Admin::Organization::SpendAlerts#create
+        class SpendAlertCreateParams < OpenAI::Internal::Type::BaseModel
+          extend OpenAI::Internal::Type::RequestParameters::Converter
+          include OpenAI::Internal::Type::RequestParameters
+
+          # @!attribute currency
+          #   The currency for the threshold amount.
+          #
+          #   @return [Symbol, OpenAI::Models::Admin::Organization::SpendAlertCreateParams::Currency]
+          required :currency, enum: -> { OpenAI::Admin::Organization::SpendAlertCreateParams::Currency }
+
+          # @!attribute interval
+          #   The time interval for evaluating spend against the threshold.
+          #
+          #   @return [Symbol, OpenAI::Models::Admin::Organization::SpendAlertCreateParams::Interval]
+          required :interval, enum: -> { OpenAI::Admin::Organization::SpendAlertCreateParams::Interval }
+
+          # @!attribute notification_channel
+          #   Email notification settings for a spend alert.
+          #
+          #   @return [OpenAI::Models::Admin::Organization::SpendAlertCreateParams::NotificationChannel]
+          required :notification_channel,
+                   -> { OpenAI::Admin::Organization::SpendAlertCreateParams::NotificationChannel }
+
+          # @!attribute threshold_amount
+          #   The alert threshold amount, in cents.
+          #
+          #   @return [Integer]
+          required :threshold_amount, Integer
+
+          # @!method initialize(currency:, interval:, notification_channel:, threshold_amount:, request_options: {})
+          #   @param currency [Symbol, OpenAI::Models::Admin::Organization::SpendAlertCreateParams::Currency] The currency for the threshold amount.
+          #
+          #   @param interval [Symbol, OpenAI::Models::Admin::Organization::SpendAlertCreateParams::Interval] The time interval for evaluating spend against the threshold.
+          #
+          #   @param notification_channel [OpenAI::Models::Admin::Organization::SpendAlertCreateParams::NotificationChannel] Email notification settings for a spend alert.
+          #
+          #   @param threshold_amount [Integer] The alert threshold amount, in cents.
+          #
+          #   @param 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

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

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

data/lib/openai/models/admin/organization/spend_alert_list_params.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        # @see OpenAI::Resources::Admin::Organization::SpendAlerts#list
+        class SpendAlertListParams < OpenAI::Internal::Type::BaseModel
+          extend OpenAI::Internal::Type::RequestParameters::Converter
+          include OpenAI::Internal::Type::RequestParameters
+
+          # @!attribute after
+          #   Cursor for pagination. Provide the ID of the last spend alert from the previous
+          #   response to fetch the next page.
+          #
+          #   @return [String, nil]
+          optional :after, String
+
+          # @!attribute before
+          #   Cursor for pagination. Provide the ID of the first spend alert from the previous
+          #   response to fetch the previous page.
+          #
+          #   @return [String, nil]
+          optional :before, String
+
+          # @!attribute limit
+          #   A limit on the number of spend alerts to return. Defaults to 20.
+          #
+          #   @return [Integer, nil]
+          optional :limit, Integer
+
+          # @!attribute order
+          #   Sort order for the returned spend alerts.
+          #
+          #   @return [Symbol, OpenAI::Models::Admin::Organization::SpendAlertListParams::Order, nil]
+          optional :order, enum: -> { OpenAI::Admin::Organization::SpendAlertListParams::Order }
+
+          # @!method initialize(after: nil, before: nil, limit: nil, order: nil, request_options: {})
+          #   Some parameter documentations has been truncated, see
+          #   {OpenAI::Models::Admin::Organization::SpendAlertListParams} for more details.
+          #
+          #   @param after [String] Cursor for pagination. Provide the ID of the last spend alert from the previous
+          #
+          #   @param before [String] Cursor for pagination. Provide the ID of the first spend alert from the previous
+          #
+          #   @param limit [Integer] A limit on the number of spend alerts to return. Defaults to 20.
+          #
+          #   @param order [Symbol, OpenAI::Models::Admin::Organization::SpendAlertListParams::Order] Sort order for the returned spend alerts.
+          #
+          #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+
+          # Sort order for the returned spend alerts.
+          module Order
+            extend OpenAI::Internal::Type::Enum
+
+            ASC = :asc
+            DESC = :desc
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/admin/organization/spend_alert_update_params.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        # @see OpenAI::Resources::Admin::Organization::SpendAlerts#update
+        class SpendAlertUpdateParams < OpenAI::Internal::Type::BaseModel
+          extend OpenAI::Internal::Type::RequestParameters::Converter
+          include OpenAI::Internal::Type::RequestParameters
+
+          # @!attribute alert_id
+          #
+          #   @return [String]
+          required :alert_id, String
+
+          # @!attribute currency
+          #   The currency for the threshold amount.
+          #
+          #   @return [Symbol, OpenAI::Models::Admin::Organization::SpendAlertUpdateParams::Currency]
+          required :currency, enum: -> { OpenAI::Admin::Organization::SpendAlertUpdateParams::Currency }
+
+          # @!attribute interval
+          #   The time interval for evaluating spend against the threshold.
+          #
+          #   @return [Symbol, OpenAI::Models::Admin::Organization::SpendAlertUpdateParams::Interval]
+          required :interval, enum: -> { OpenAI::Admin::Organization::SpendAlertUpdateParams::Interval }
+
+          # @!attribute notification_channel
+          #   Email notification settings for a spend alert.
+          #
+          #   @return [OpenAI::Models::Admin::Organization::SpendAlertUpdateParams::NotificationChannel]
+          required :notification_channel,
+                   -> { OpenAI::Admin::Organization::SpendAlertUpdateParams::NotificationChannel }
+
+          # @!attribute threshold_amount
+          #   The alert threshold amount, in cents.
+          #
+          #   @return [Integer]
+          required :threshold_amount, Integer
+
+          # @!method initialize(alert_id:, currency:, interval:, notification_channel:, threshold_amount:, request_options: {})
+          #   @param alert_id [String]
+          #
+          #   @param currency [Symbol, OpenAI::Models::Admin::Organization::SpendAlertUpdateParams::Currency] The currency for the threshold amount.
+          #
+          #   @param interval [Symbol, OpenAI::Models::Admin::Organization::SpendAlertUpdateParams::Interval] The time interval for evaluating spend against the threshold.
+          #
+          #   @param notification_channel [OpenAI::Models::Admin::Organization::SpendAlertUpdateParams::NotificationChannel] Email notification settings for a spend alert.
+          #
+          #   @param threshold_amount [Integer] The alert threshold amount, in cents.
+          #
+          #   @param 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