openai 0.91.0 → 0.93.0

data/sig/openai/models/admin/organization/aws_external_storage_provider.rbs

@@ -0,0 +1,49 @@
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        type aws_external_storage_provider =
+          {
+            account_id: String,
+            bucket: String,
+            external_id: String,
+            region: String,
+            role_arn: String,
+            ?type: :aws
+          }
+
+        class AwsExternalStorageProvider < OpenAI::Internal::Type::BaseModel
+          attr_accessor account_id: String
+
+          attr_accessor bucket: String
+
+          attr_accessor external_id: String
+
+          attr_accessor region: String
+
+          attr_accessor role_arn: String
+
+          attr_accessor type: :aws
+
+          def initialize: (
+            account_id: String,
+            bucket: String,
+            external_id: String,
+            region: String,
+            role_arn: String,
+            ?type: :aws
+          ) -> void
+
+          def to_hash: -> {
+            account_id: String,
+            bucket: String,
+            external_id: String,
+            region: String,
+            role_arn: String,
+            ?type: :aws
+          }
+        end
+      end
+    end
+  end
+end

data/sig/openai/models/admin/organization/azure_external_storage_provider.rbs

@@ -0,0 +1,54 @@
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        type azure_external_storage_provider =
+          {
+            account_name: String,
+            container: String,
+            region: String,
+            resource_group: String,
+            subscription_id: String,
+            tenant_id: String,
+            ?type: :azure
+          }
+
+        class AzureExternalStorageProvider < OpenAI::Internal::Type::BaseModel
+          attr_accessor account_name: String
+
+          attr_accessor container: String
+
+          attr_accessor region: String
+
+          attr_accessor resource_group: String
+
+          attr_accessor subscription_id: String
+
+          attr_accessor tenant_id: String
+
+          attr_accessor type: :azure
+
+          def initialize: (
+            account_name: String,
+            container: String,
+            region: String,
+            resource_group: String,
+            subscription_id: String,
+            tenant_id: String,
+            ?type: :azure
+          ) -> void
+
+          def to_hash: -> {
+            account_name: String,
+            container: String,
+            region: String,
+            resource_group: String,
+            subscription_id: String,
+            tenant_id: String,
+            ?type: :azure
+          }
+        end
+      end
+    end
+  end
+end

data/sig/openai/models/admin/organization/certificate.rbs

@@ -13,20 +13,53 @@ module OpenAI
           }
 
         class Certificate < OpenAI::Internal::Type::BaseModel
+          # The identifier, which can be referenced in API endpoints
           attr_accessor id: String
 
           attr_accessor certificate_details: OpenAI::Admin::Organization::Certificate::CertificateDetails
 
+          # The Unix timestamp (in seconds) of when the certificate was uploaded.
           attr_accessor created_at: Integer
 
+          # The name of the certificate.
           attr_accessor name: String?
 
+          # The object type.
+          #
+          # - If creating, updating, or getting a specific certificate, the object type is
+          #   `certificate`.
+          # - If listing, activating, or deactivating certificates for the organization, the
+          #   object type is `organization.certificate`.
+          # - If listing, activating, or deactivating certificates for a project, the object
+          #   type is `organization.project.certificate`.
           attr_accessor object: OpenAI::Models::Admin::Organization::Certificate::object
 
+          # Whether the certificate is currently active at the specified scope. Not returned
+          # when getting details for a specific certificate.
           attr_reader active: bool?
 
+          # Whether the certificate is currently active at the specified scope. Not returned
+          # when getting details for a specific certificate.
           def active=: (bool) -> bool
 
+          # @param id
+          #   The identifier, which can be referenced in API endpoints
+          # @param created_at
+          #   The Unix timestamp (in seconds) of when the certificate was uploaded.
+          # @param name
+          #   The name of the certificate.
+          # @param object
+          #   The object type.
+          #
+          #   - If creating, updating, or getting a specific certificate, the object type is
+          #     `certificate`.
+          #   - If listing, activating, or deactivating certificates for the organization, the
+          #     object type is `organization.certificate`.
+          #   - If listing, activating, or deactivating certificates for a project, the object
+          #     type is `organization.project.certificate`.
+          # @param active
+          #   Whether the certificate is currently active at the specified scope. Not returned
+          #   when getting details for a specific certificate.
           def initialize: (
             id: String,
             certificate_details: OpenAI::Admin::Organization::Certificate::CertificateDetails,
@@ -49,18 +82,30 @@ module OpenAI
             { ?content: String, ?expires_at: Integer, ?valid_at: Integer }
 
           class CertificateDetails < OpenAI::Internal::Type::BaseModel
+            # The content of the certificate in PEM format.
             attr_reader content: String?
 
+            # The content of the certificate in PEM format.
             def content=: (String) -> String
 
+            # The Unix timestamp (in seconds) of when the certificate expires.
             attr_reader expires_at: Integer?
 
+            # The Unix timestamp (in seconds) of when the certificate expires.
             def expires_at=: (Integer) -> Integer
 
+            # The Unix timestamp (in seconds) of when the certificate becomes valid.
             attr_reader valid_at: Integer?
 
+            # The Unix timestamp (in seconds) of when the certificate becomes valid.
             def valid_at=: (Integer) -> Integer
 
+            # @param content
+            #   The content of the certificate in PEM format.
+            # @param expires_at
+            #   The Unix timestamp (in seconds) of when the certificate expires.
+            # @param valid_at
+            #   The Unix timestamp (in seconds) of when the certificate becomes valid.
             def initialize: (
               ?content: String,
               ?expires_at: Integer,

data/sig/openai/models/admin/organization/certificate_activate_response.rbs

@@ -13,18 +13,33 @@ module OpenAI
           }
 
         class CertificateActivateResponse < OpenAI::Internal::Type::BaseModel
+          # The identifier, which can be referenced in API endpoints
           attr_accessor id: String
 
+          # Whether the certificate is currently active at the organization level.
           attr_accessor active: bool
 
           attr_accessor certificate_details: OpenAI::Models::Admin::Organization::CertificateActivateResponse::CertificateDetails
 
+          # The Unix timestamp (in seconds) of when the certificate was uploaded.
           attr_accessor created_at: Integer
 
+          # The name of the certificate.
           attr_accessor name: String?
 
+          # The object type, which is always `organization.certificate`.
           attr_accessor object: :"organization.certificate"
 
+          # @param id
+          #   The identifier, which can be referenced in API endpoints
+          # @param active
+          #   Whether the certificate is currently active at the organization level.
+          # @param created_at
+          #   The Unix timestamp (in seconds) of when the certificate was uploaded.
+          # @param name
+          #   The name of the certificate.
+          # @param object
+          #   The object type, which is always `organization.certificate`.
           def initialize: (
             id: String,
             active: bool,
@@ -47,14 +62,22 @@ module OpenAI
             { ?expires_at: Integer, ?valid_at: Integer }
 
           class CertificateDetails < OpenAI::Internal::Type::BaseModel
+            # The Unix timestamp (in seconds) of when the certificate expires.
             attr_reader expires_at: Integer?
 
+            # The Unix timestamp (in seconds) of when the certificate expires.
             def expires_at=: (Integer) -> Integer
 
+            # The Unix timestamp (in seconds) of when the certificate becomes valid.
             attr_reader valid_at: Integer?
 
+            # The Unix timestamp (in seconds) of when the certificate becomes valid.
             def valid_at=: (Integer) -> Integer
 
+            # @param expires_at
+            #   The Unix timestamp (in seconds) of when the certificate expires.
+            # @param valid_at
+            #   The Unix timestamp (in seconds) of when the certificate becomes valid.
             def initialize: (?expires_at: Integer, ?valid_at: Integer) -> void
 
             def to_hash: -> { ?expires_at: Integer, ?valid_at: Integer }

data/sig/openai/models/admin/organization/certificate_create_params.rbs

@@ -13,12 +13,19 @@ module OpenAI
           extend OpenAI::Internal::Type::RequestParameters::Converter
           include OpenAI::Internal::Type::RequestParameters
 
+          # The certificate content in PEM format
           attr_accessor certificate: String
 
+          # An optional name for the certificate
           attr_reader name: String?
 
+          # An optional name for the certificate
           def name=: (String) -> String
 
+          # @param certificate
+          #   The certificate content in PEM format
+          # @param name
+          #   An optional name for the certificate
           def initialize: (
             certificate: String,
             ?name: String,

data/sig/openai/models/admin/organization/certificate_deactivate_response.rbs

@@ -13,18 +13,33 @@ module OpenAI
           }
 
         class CertificateDeactivateResponse < OpenAI::Internal::Type::BaseModel
+          # The identifier, which can be referenced in API endpoints
           attr_accessor id: String
 
+          # Whether the certificate is currently active at the organization level.
           attr_accessor active: bool
 
           attr_accessor certificate_details: OpenAI::Models::Admin::Organization::CertificateDeactivateResponse::CertificateDetails
 
+          # The Unix timestamp (in seconds) of when the certificate was uploaded.
           attr_accessor created_at: Integer
 
+          # The name of the certificate.
           attr_accessor name: String?
 
+          # The object type, which is always `organization.certificate`.
           attr_accessor object: :"organization.certificate"
 
+          # @param id
+          #   The identifier, which can be referenced in API endpoints
+          # @param active
+          #   Whether the certificate is currently active at the organization level.
+          # @param created_at
+          #   The Unix timestamp (in seconds) of when the certificate was uploaded.
+          # @param name
+          #   The name of the certificate.
+          # @param object
+          #   The object type, which is always `organization.certificate`.
           def initialize: (
             id: String,
             active: bool,
@@ -47,14 +62,22 @@ module OpenAI
             { ?expires_at: Integer, ?valid_at: Integer }
 
           class CertificateDetails < OpenAI::Internal::Type::BaseModel
+            # The Unix timestamp (in seconds) of when the certificate expires.
             attr_reader expires_at: Integer?
 
+            # The Unix timestamp (in seconds) of when the certificate expires.
             def expires_at=: (Integer) -> Integer
 
+            # The Unix timestamp (in seconds) of when the certificate becomes valid.
             attr_reader valid_at: Integer?
 
+            # The Unix timestamp (in seconds) of when the certificate becomes valid.
             def valid_at=: (Integer) -> Integer
 
+            # @param expires_at
+            #   The Unix timestamp (in seconds) of when the certificate expires.
+            # @param valid_at
+            #   The Unix timestamp (in seconds) of when the certificate becomes valid.
             def initialize: (?expires_at: Integer, ?valid_at: Integer) -> void
 
             def to_hash: -> { ?expires_at: Integer, ?valid_at: Integer }

data/sig/openai/models/admin/organization/certificate_delete_response.rbs

@@ -6,10 +6,16 @@ module OpenAI
           { id: String, ?object: :"certificate.deleted" }
 
         class CertificateDeleteResponse < OpenAI::Internal::Type::BaseModel
+          # The ID of the certificate that was deleted.
           attr_accessor id: String
 
+          # The object type, must be `certificate.deleted`.
           attr_accessor object: :"certificate.deleted"
 
+          # @param id
+          #   The ID of the certificate that was deleted.
+          # @param object
+          #   The object type, must be `certificate.deleted`.
           def initialize: (id: String, ?object: :"certificate.deleted") -> void
 
           def to_hash: -> { id: String, ?object: :"certificate.deleted" }

data/sig/openai/models/admin/organization/certificate_list_params.rbs

@@ -14,20 +14,47 @@ module OpenAI
           extend OpenAI::Internal::Type::RequestParameters::Converter
           include OpenAI::Internal::Type::RequestParameters
 
+          # A cursor for use in pagination. `after` is an object ID that defines your place
+          # in the list. For instance, if you make a list request and receive 100 objects,
+          # ending with obj_foo, your subsequent call can include after=obj_foo in order to
+          # fetch the next page of the list.
           attr_reader after: String?
 
+          # A cursor for use in pagination. `after` is an object ID that defines your place
+          # in the list. For instance, if you make a list request and receive 100 objects,
+          # ending with obj_foo, your subsequent call can include after=obj_foo in order to
+          # fetch the next page of the list.
           def after=: (String) -> String
 
+          # A limit on the number of objects to be returned. Limit can range between 1 and
+          # 100, and the default is 20.
           attr_reader limit: Integer?
 
+          # A limit on the number of objects to be returned. Limit can range between 1 and
+          # 100, and the default is 20.
           def limit=: (Integer) -> Integer
 
+          # Sort order by the `created_at` timestamp of the objects. `asc` for ascending
+          # order and `desc` for descending order.
           attr_reader order: OpenAI::Models::Admin::Organization::CertificateListParams::order?
 
+          # Sort order by the `created_at` timestamp of the objects. `asc` for ascending
+          # order and `desc` for descending order.
           def order=: (
             OpenAI::Models::Admin::Organization::CertificateListParams::order
           ) -> OpenAI::Models::Admin::Organization::CertificateListParams::order
 
+          # @param after
+          #   A cursor for use in pagination. `after` is an object ID that defines your place
+          #   in the list. For instance, if you make a list request and receive 100 objects,
+          #   ending with obj_foo, your subsequent call can include after=obj_foo in order to
+          #   fetch the next page of the list.
+          # @param limit
+          #   A limit on the number of objects to be returned. Limit can range between 1 and
+          #   100, and the default is 20.
+          # @param order
+          #   Sort order by the `created_at` timestamp of the objects. `asc` for ascending
+          #   order and `desc` for descending order.
           def initialize: (
             ?after: String,
             ?limit: Integer,

data/sig/openai/models/admin/organization/certificate_list_response.rbs

@@ -13,18 +13,33 @@ module OpenAI
           }
 
         class CertificateListResponse < OpenAI::Internal::Type::BaseModel
+          # The identifier, which can be referenced in API endpoints
           attr_accessor id: String
 
+          # Whether the certificate is currently active at the organization level.
           attr_accessor active: bool
 
           attr_accessor certificate_details: OpenAI::Models::Admin::Organization::CertificateListResponse::CertificateDetails
 
+          # The Unix timestamp (in seconds) of when the certificate was uploaded.
           attr_accessor created_at: Integer
 
+          # The name of the certificate.
           attr_accessor name: String?
 
+          # The object type, which is always `organization.certificate`.
           attr_accessor object: :"organization.certificate"
 
+          # @param id
+          #   The identifier, which can be referenced in API endpoints
+          # @param active
+          #   Whether the certificate is currently active at the organization level.
+          # @param created_at
+          #   The Unix timestamp (in seconds) of when the certificate was uploaded.
+          # @param name
+          #   The name of the certificate.
+          # @param object
+          #   The object type, which is always `organization.certificate`.
           def initialize: (
             id: String,
             active: bool,
@@ -47,14 +62,22 @@ module OpenAI
             { ?expires_at: Integer, ?valid_at: Integer }
 
           class CertificateDetails < OpenAI::Internal::Type::BaseModel
+            # The Unix timestamp (in seconds) of when the certificate expires.
             attr_reader expires_at: Integer?
 
+            # The Unix timestamp (in seconds) of when the certificate expires.
             def expires_at=: (Integer) -> Integer
 
+            # The Unix timestamp (in seconds) of when the certificate becomes valid.
             attr_reader valid_at: Integer?
 
+            # The Unix timestamp (in seconds) of when the certificate becomes valid.
             def valid_at=: (Integer) -> Integer
 
+            # @param expires_at
+            #   The Unix timestamp (in seconds) of when the certificate expires.
+            # @param valid_at
+            #   The Unix timestamp (in seconds) of when the certificate becomes valid.
             def initialize: (?expires_at: Integer, ?valid_at: Integer) -> void
 
             def to_hash: -> { ?expires_at: Integer, ?valid_at: Integer }

data/sig/openai/models/admin/organization/certificate_retrieve_params.rbs

@@ -15,12 +15,19 @@ module OpenAI
 
           attr_accessor certificate_id: String
 
+          # A list of additional fields to include in the response. Currently the only
+          # supported value is `content` to fetch the PEM content of the certificate.
           attr_reader include: ::Array[OpenAI::Models::Admin::Organization::CertificateRetrieveParams::include_]?
 
+          # A list of additional fields to include in the response. Currently the only
+          # supported value is `content` to fetch the PEM content of the certificate.
           def include=: (
             ::Array[OpenAI::Models::Admin::Organization::CertificateRetrieveParams::include_]
           ) -> ::Array[OpenAI::Models::Admin::Organization::CertificateRetrieveParams::include_]
 
+          # @param include
+          #   A list of additional fields to include in the response. Currently the only
+          #   supported value is `content` to fetch the PEM content of the certificate.
           def initialize: (
             certificate_id: String,
             ?include: ::Array[OpenAI::Models::Admin::Organization::CertificateRetrieveParams::include_],

data/sig/openai/models/admin/organization/certificate_update_params.rbs

@@ -15,10 +15,14 @@ module OpenAI
 
           attr_accessor certificate_id: String
 
+          # The updated name for the certificate
           attr_reader name: String?
 
+          # The updated name for the certificate
           def name=: (String) -> String
 
+          # @param name
+          #   The updated name for the certificate
           def initialize: (
             certificate_id: String,
             ?name: String,

data/sig/openai/models/admin/organization/data_retention_update_params.rbs

@@ -12,8 +12,11 @@ module OpenAI
           extend OpenAI::Internal::Type::RequestParameters::Converter
           include OpenAI::Internal::Type::RequestParameters
 
+          # The desired organization data retention type.
           attr_accessor retention_type: OpenAI::Models::Admin::Organization::DataRetentionUpdateParams::retention_type
 
+          # @param retention_type
+          #   The desired organization data retention type.
           def initialize: (
             retention_type: OpenAI::Models::Admin::Organization::DataRetentionUpdateParams::retention_type,
             ?request_options: OpenAI::request_opts

data/sig/openai/models/admin/organization/external_storage_configuration.rbs

@@ -0,0 +1,76 @@
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        type external_storage_configuration =
+          {
+            id: String,
+            created_at: Integer,
+            geography: String,
+            ?object: :"organization.external_storage",
+            project_id: String,
+            provider: OpenAI::Models::Admin::Organization::ExternalStorageConfiguration::provider,
+            status: OpenAI::Models::Admin::Organization::ExternalStorageConfiguration::status
+          }
+
+        class ExternalStorageConfiguration < OpenAI::Internal::Type::BaseModel
+          attr_accessor id: String
+
+          attr_accessor created_at: Integer
+
+          attr_accessor geography: String
+
+          attr_accessor object: :"organization.external_storage"
+
+          attr_accessor project_id: String
+
+          attr_accessor provider: OpenAI::Models::Admin::Organization::ExternalStorageConfiguration::provider
+
+          attr_accessor status: OpenAI::Models::Admin::Organization::ExternalStorageConfiguration::status
+
+          def initialize: (
+            id: String,
+            created_at: Integer,
+            geography: String,
+            project_id: String,
+            provider: OpenAI::Models::Admin::Organization::ExternalStorageConfiguration::provider,
+            status: OpenAI::Models::Admin::Organization::ExternalStorageConfiguration::status,
+            ?object: :"organization.external_storage"
+          ) -> void
+
+          def to_hash: -> {
+            id: String,
+            created_at: Integer,
+            geography: String,
+            ?object: :"organization.external_storage",
+            project_id: String,
+            provider: OpenAI::Models::Admin::Organization::ExternalStorageConfiguration::provider,
+            status: OpenAI::Models::Admin::Organization::ExternalStorageConfiguration::status
+          }
+
+          type provider =
+            OpenAI::Admin::Organization::AwsExternalStorageProvider
+            | OpenAI::Admin::Organization::AzureExternalStorageProvider
+
+          module Provider
+            extend OpenAI::Internal::Type::Union
+
+            def self?.variants: -> ::Array[OpenAI::Models::Admin::Organization::ExternalStorageConfiguration::provider]
+          end
+
+          type status = :pending | :validated | :unhealthy
+
+          module Status
+            extend OpenAI::Internal::Type::Enum
+
+            PENDING: :pending
+            VALIDATED: :validated
+            UNHEALTHY: :unhealthy
+
+            def self?.values: -> ::Array[OpenAI::Models::Admin::Organization::ExternalStorageConfiguration::status]
+          end
+        end
+      end
+    end
+  end
+end

data/sig/openai/models/admin/organization/external_storage_create_params.rbs

@@ -0,0 +1,105 @@
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        type external_storage_create_params =
+          {
+            project_id: String,
+            provider: OpenAI::Models::Admin::Organization::ExternalStorageCreateParams::provider,
+            ?request_options: OpenAI::request_opts
+          }
+
+        class ExternalStorageCreateParams < OpenAI::Internal::Type::BaseModel
+          extend OpenAI::Internal::Type::RequestParameters::Converter
+          include OpenAI::Internal::Type::RequestParameters
+
+          attr_accessor project_id: String
+
+          attr_accessor provider: OpenAI::Models::Admin::Organization::ExternalStorageCreateParams::provider
+
+          def initialize: (
+            project_id: String,
+            provider: OpenAI::Models::Admin::Organization::ExternalStorageCreateParams::provider,
+            ?request_options: OpenAI::request_opts
+          ) -> void
+
+          def to_hash: -> {
+            project_id: String,
+            provider: OpenAI::Models::Admin::Organization::ExternalStorageCreateParams::provider,
+            ?request_options: OpenAI::RequestOptions
+          }
+
+          type provider =
+            OpenAI::Admin::Organization::ExternalStorageCreateParams::Provider::Aws
+            | OpenAI::Admin::Organization::ExternalStorageCreateParams::Provider::Azure
+
+          module Provider
+            extend OpenAI::Internal::Type::Union
+
+            type aws = { bucket: String, role_arn: String, ?type: :aws }
+
+            class Aws < OpenAI::Internal::Type::BaseModel
+              attr_accessor bucket: String
+
+              attr_accessor role_arn: String
+
+              attr_accessor type: :aws
+
+              def initialize: (
+                bucket: String,
+                role_arn: String,
+                ?type: :aws
+              ) -> void
+
+              def to_hash: -> { bucket: String, role_arn: String, ?type: :aws }
+            end
+
+            type azure =
+              {
+                account_name: String,
+                container: String,
+                resource_group: String,
+                subscription_id: String,
+                tenant_id: String,
+                ?type: :azure
+              }
+
+            class Azure < OpenAI::Internal::Type::BaseModel
+              attr_accessor account_name: String
+
+              attr_accessor container: String
+
+              attr_accessor resource_group: String
+
+              attr_accessor subscription_id: String
+
+              attr_accessor tenant_id: String
+
+              attr_accessor type: :azure
+
+              def initialize: (
+                account_name: String,
+                container: String,
+                resource_group: String,
+                subscription_id: String,
+                tenant_id: String,
+                ?type: :azure
+              ) -> void
+
+              def to_hash: -> {
+                account_name: String,
+                container: String,
+                resource_group: String,
+                subscription_id: String,
+                tenant_id: String,
+                ?type: :azure
+              }
+            end
+
+            def self?.variants: -> ::Array[OpenAI::Models::Admin::Organization::ExternalStorageCreateParams::provider]
+          end
+        end
+      end
+    end
+  end
+end