openai 0.63.0 → 0.65.0

data/lib/openai/models/admin/organization/groups/role_retrieve_response.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        module Groups
+          # @see OpenAI::Resources::Admin::Organization::Groups::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::Groups::RoleRetrieveResponse::AssignmentSource>, nil]
+            required :assignment_sources,
+                     -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Models::Admin::Organization::Groups::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::Groups::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

data/lib/openai/models/admin/organization/groups/user_retrieve_params.rb

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

data/lib/openai/models/admin/organization/groups/user_retrieve_response.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        module Groups
+          # @see OpenAI::Resources::Admin::Organization::Groups::Users#retrieve
+          class UserRetrieveResponse < OpenAI::Internal::Type::BaseModel
+            # @!attribute id
+            #   Identifier for the user.
+            #
+            #   @return [String]
+            required :id, String
+
+            # @!attribute email
+            #   Email address of the user, or `null` for users without an email.
+            #
+            #   @return [String, nil]
+            required :email, String, nil?: true
+
+            # @!attribute is_service_account
+            #   Whether the user is a service account.
+            #
+            #   @return [Boolean, nil]
+            required :is_service_account, OpenAI::Internal::Type::Boolean, nil?: true
+
+            # @!attribute name
+            #   Display name of the user.
+            #
+            #   @return [String]
+            required :name, String
+
+            # @!attribute picture
+            #   URL of the user's profile picture, if available.
+            #
+            #   @return [String, nil]
+            required :picture, String, nil?: true
+
+            # @!attribute user_type
+            #   The type of user.
+            #
+            #   @return [Symbol, OpenAI::Models::Admin::Organization::Groups::UserRetrieveResponse::UserType]
+            required :user_type,
+                     enum: -> { OpenAI::Models::Admin::Organization::Groups::UserRetrieveResponse::UserType }
+
+            # @!method initialize(id:, email:, is_service_account:, name:, picture:, user_type:)
+            #   Details about a user returned from an organization group membership lookup.
+            #
+            #   @param id [String] Identifier for the user.
+            #
+            #   @param email [String, nil] Email address of the user, or `null` for users without an email.
+            #
+            #   @param is_service_account [Boolean, nil] Whether the user is a service account.
+            #
+            #   @param name [String] Display name of the user.
+            #
+            #   @param picture [String, nil] URL of the user's profile picture, if available.
+            #
+            #   @param user_type [Symbol, OpenAI::Models::Admin::Organization::Groups::UserRetrieveResponse::UserType] The type of user.
+
+            # The type of user.
+            #
+            # @see OpenAI::Models::Admin::Organization::Groups::UserRetrieveResponse#user_type
+            module UserType
+              extend OpenAI::Internal::Type::Enum
+
+              USER = :user
+              TENANT_USER = :tenant_user
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -24,7 +24,8 @@ module OpenAI
           # @!attribute projects
           #   An array of projects to which membership is granted at the same time the org
           #   invite is accepted. If omitted, the user will be invited to the default project
-          #   for compatibility with legacy behavior.
+          #   for compatibility with legacy behavior. If empty list is passed, the user will
+          #   not be invited to any projects, including the default one.
           #
           #   @return [Array<OpenAI::Models::Admin::Organization::InviteCreateParams::Project>, nil]
           optional :projects,

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        # @see OpenAI::Resources::Admin::Organization::DataRetention#retrieve
+        class OrganizationDataRetention < OpenAI::Internal::Type::BaseModel
+          # @!attribute object
+          #   The object type, which is always `organization.data_retention`.
+          #
+          #   @return [Symbol, :"organization.data_retention"]
+          required :object, const: :"organization.data_retention"
+
+          # @!attribute type
+          #   The configured organization data retention type.
+          #
+          #   @return [Symbol, OpenAI::Models::Admin::Organization::OrganizationDataRetention::Type]
+          required :type, enum: -> { OpenAI::Admin::Organization::OrganizationDataRetention::Type }
+
+          # @!method initialize(type:, object: :"organization.data_retention")
+          #   Represents the organization's data retention control setting.
+          #
+          #   @param type [Symbol, OpenAI::Models::Admin::Organization::OrganizationDataRetention::Type] The configured organization data retention type.
+          #
+          #   @param object [Symbol, :"organization.data_retention"] The object type, which is always `organization.data_retention`.
+
+          # The configured organization data retention type.
+          #
+          # @see OpenAI::Models::Admin::Organization::OrganizationDataRetention#type
+          module Type
+            extend OpenAI::Internal::Type::Enum
+
+            ZERO_DATA_RETENTION = :zero_data_retention
+            MODIFIED_ABUSE_MONITORING = :modified_abuse_monitoring
+            ENHANCED_ZERO_DATA_RETENTION = :enhanced_zero_data_retention
+            ENHANCED_MODIFIED_ABUSE_MONITORING = :enhanced_modified_abuse_monitoring
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+
+      OrganizationDataRetention = Organization::OrganizationDataRetention
+    end
+  end
+end

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

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        # @see OpenAI::Resources::Admin::Organization::SpendAlerts#create
+        class OrganizationSpendAlert < 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::OrganizationSpendAlert::Currency]
+          required :currency, enum: -> { OpenAI::Admin::Organization::OrganizationSpendAlert::Currency }
+
+          # @!attribute interval
+          #   The time interval for evaluating spend against the threshold.
+          #
+          #   @return [Symbol, OpenAI::Models::Admin::Organization::OrganizationSpendAlert::Interval]
+          required :interval, enum: -> { OpenAI::Admin::Organization::OrganizationSpendAlert::Interval }
+
+          # @!attribute notification_channel
+          #   Email notification settings for a spend alert.
+          #
+          #   @return [OpenAI::Models::Admin::Organization::OrganizationSpendAlert::NotificationChannel]
+          required :notification_channel,
+                   -> { OpenAI::Admin::Organization::OrganizationSpendAlert::NotificationChannel }
+
+          # @!attribute object
+          #   The object type, which is always `organization.spend_alert`.
+          #
+          #   @return [Symbol, :"organization.spend_alert"]
+          required :object, const: :"organization.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: :"organization.spend_alert")
+          #   Represents a spend alert configured at the organization level.
+          #
+          #   @param id [String] The identifier, which can be referenced in API endpoints.
+          #
+          #   @param currency [Symbol, OpenAI::Models::Admin::Organization::OrganizationSpendAlert::Currency] The currency for the threshold amount.
+          #
+          #   @param interval [Symbol, OpenAI::Models::Admin::Organization::OrganizationSpendAlert::Interval] The time interval for evaluating spend against the threshold.
+          #
+          #   @param notification_channel [OpenAI::Models::Admin::Organization::OrganizationSpendAlert::NotificationChannel] Email notification settings for a spend alert.
+          #
+          #   @param threshold_amount [Integer] The alert threshold amount, in cents.
+          #
+          #   @param object [Symbol, :"organization.spend_alert"] The object type, which is always `organization.spend_alert`.
+
+          # The currency for the threshold amount.
+          #
+          # @see OpenAI::Models::Admin::Organization::OrganizationSpendAlert#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::OrganizationSpendAlert#interval
+          module Interval
+            extend OpenAI::Internal::Type::Enum
+
+            MONTH = :month
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # @see OpenAI::Models::Admin::Organization::OrganizationSpendAlert#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
+
+      OrganizationSpendAlert = Organization::OrganizationSpendAlert
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        # @see OpenAI::Resources::Admin::Organization::SpendAlerts#delete
+        class OrganizationSpendAlertDeleted < 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 `organization.spend_alert.deleted`.
+          #
+          #   @return [Symbol, :"organization.spend_alert.deleted"]
+          required :object, const: :"organization.spend_alert.deleted"
+
+          # @!method initialize(id:, deleted:, object: :"organization.spend_alert.deleted")
+          #   Confirmation payload returned after deleting an organization spend alert.
+          #
+          #   @param id [String] The deleted spend alert ID.
+          #
+          #   @param deleted [Boolean] Whether the spend alert was deleted.
+          #
+          #   @param object [Symbol, :"organization.spend_alert.deleted"] Always `organization.spend_alert.deleted`.
+        end
+      end
+
+      OrganizationSpendAlertDeleted = Organization::OrganizationSpendAlertDeleted
+    end
+  end
+end

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

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

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        module Projects
+          # @see OpenAI::Resources::Admin::Organization::Projects::DataRetention#update
+          class DataRetentionUpdateParams < 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 retention_type
+            #   The desired project data retention type.
+            #
+            #   @return [Symbol, OpenAI::Models::Admin::Organization::Projects::DataRetentionUpdateParams::RetentionType]
+            required :retention_type,
+                     enum: -> { OpenAI::Admin::Organization::Projects::DataRetentionUpdateParams::RetentionType }
+
+            # @!method initialize(project_id:, retention_type:, request_options: {})
+            #   @param project_id [String]
+            #
+            #   @param retention_type [Symbol, OpenAI::Models::Admin::Organization::Projects::DataRetentionUpdateParams::RetentionType] The desired project data retention type.
+            #
+            #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+
+            # The desired project data retention type.
+            module RetentionType
+              extend OpenAI::Internal::Type::Enum
+
+              ORGANIZATION_DEFAULT = :organization_default
+              NONE = :none
+              ZERO_DATA_RETENTION = :zero_data_retention
+              MODIFIED_ABUSE_MONITORING = :modified_abuse_monitoring
+              ENHANCED_ZERO_DATA_RETENTION = :enhanced_zero_data_retention
+              ENHANCED_MODIFIED_ABUSE_MONITORING = :enhanced_modified_abuse_monitoring
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        module Projects
+          # @see OpenAI::Resources::Admin::Organization::Projects::Groups#retrieve
+          class GroupRetrieveParams < 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 group_id
+            #
+            #   @return [String]
+            required :group_id, String
+
+            # @!attribute group_type
+            #   The type of group to retrieve.
+            #
+            #   @return [Symbol, OpenAI::Models::Admin::Organization::Projects::GroupRetrieveParams::GroupType, nil]
+            optional :group_type, enum: -> { OpenAI::Admin::Organization::Projects::GroupRetrieveParams::GroupType }
+
+            # @!method initialize(project_id:, group_id:, group_type: nil, request_options: {})
+            #   @param project_id [String]
+            #
+            #   @param group_id [String]
+            #
+            #   @param group_type [Symbol, OpenAI::Models::Admin::Organization::Projects::GroupRetrieveParams::GroupType] The type of group to retrieve.
+            #
+            #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+
+            # The type of group to retrieve.
+            module GroupType
+              extend OpenAI::Internal::Type::Enum
+
+              GROUP = :group
+              TENANT_GROUP = :tenant_group
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/admin/organization/projects/groups/role_list_response.rb

@@ -14,6 +14,14 @@ module OpenAI
               #   @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::Groups::RoleListResponse::AssignmentSource>, nil]
+              required :assignment_sources,
+                       -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Models::Admin::Organization::Projects::Groups::RoleListResponse::AssignmentSource] },
+                       nil?: true
+
               # @!attribute created_at
               #   When the role was created.
               #
@@ -76,12 +84,14 @@ module OpenAI
               #   @return [Integer, nil]
               required :updated_at, Integer, nil?: true
 
-              # @!method initialize(id:, created_at:, created_by:, created_by_user_obj:, description:, metadata:, name:, permissions:, predefined_role:, resource_type:, updated_at:)
+              # @!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::Groups::RoleListResponse::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.
@@ -101,6 +111,22 @@ module 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