openai 0.59.0 → 0.61.0

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

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        # @see OpenAI::Resources::Admin::Organization::Certificates#create
+        class Certificate < OpenAI::Internal::Type::BaseModel
+          # @!attribute id
+          #   The identifier, which can be referenced in API endpoints
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute certificate_details
+          #
+          #   @return [OpenAI::Models::Admin::Organization::Certificate::CertificateDetails]
+          required :certificate_details, -> { OpenAI::Admin::Organization::Certificate::CertificateDetails }
+
+          # @!attribute created_at
+          #   The Unix timestamp (in seconds) of when the certificate was uploaded.
+          #
+          #   @return [Integer]
+          required :created_at, Integer
+
+          # @!attribute name
+          #   The name of the certificate.
+          #
+          #   @return [String, nil]
+          required :name, String, nil?: true
+
+          # @!attribute 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`.
+          #
+          #   @return [Symbol, OpenAI::Models::Admin::Organization::Certificate::Object]
+          required :object, enum: -> { OpenAI::Admin::Organization::Certificate::Object }
+
+          # @!attribute active
+          #   Whether the certificate is currently active at the specified scope. Not returned
+          #   when getting details for a specific certificate.
+          #
+          #   @return [Boolean, nil]
+          optional :active, OpenAI::Internal::Type::Boolean
+
+          # @!method initialize(id:, certificate_details:, created_at:, name:, object:, active: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {OpenAI::Models::Admin::Organization::Certificate} for more details.
+          #
+          #   Represents an individual `certificate` uploaded to the organization.
+          #
+          #   @param id [String] The identifier, which can be referenced in API endpoints
+          #
+          #   @param certificate_details [OpenAI::Models::Admin::Organization::Certificate::CertificateDetails]
+          #
+          #   @param created_at [Integer] The Unix timestamp (in seconds) of when the certificate was uploaded.
+          #
+          #   @param name [String, nil] The name of the certificate.
+          #
+          #   @param object [Symbol, OpenAI::Models::Admin::Organization::Certificate::Object] The object type.
+          #
+          #   @param active [Boolean] Whether the certificate is currently active at the specified scope. Not returned
+
+          # @see OpenAI::Models::Admin::Organization::Certificate#certificate_details
+          class CertificateDetails < OpenAI::Internal::Type::BaseModel
+            # @!attribute content
+            #   The content of the certificate in PEM format.
+            #
+            #   @return [String, nil]
+            optional :content, String
+
+            # @!attribute expires_at
+            #   The Unix timestamp (in seconds) of when the certificate expires.
+            #
+            #   @return [Integer, nil]
+            optional :expires_at, Integer
+
+            # @!attribute valid_at
+            #   The Unix timestamp (in seconds) of when the certificate becomes valid.
+            #
+            #   @return [Integer, nil]
+            optional :valid_at, Integer
+
+            # @!method initialize(content: nil, expires_at: nil, valid_at: nil)
+            #   @param content [String] The content of the certificate in PEM format.
+            #
+            #   @param expires_at [Integer] The Unix timestamp (in seconds) of when the certificate expires.
+            #
+            #   @param valid_at [Integer] The Unix timestamp (in seconds) of when the certificate becomes valid.
+          end
+
+          # 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`.
+          #
+          # @see OpenAI::Models::Admin::Organization::Certificate#object
+          module Object
+            extend OpenAI::Internal::Type::Enum
+
+            CERTIFICATE = :certificate
+            ORGANIZATION_CERTIFICATE = :"organization.certificate"
+            ORGANIZATION_PROJECT_CERTIFICATE = :"organization.project.certificate"
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        # @see OpenAI::Resources::Admin::Organization::Certificates#activate
+        class CertificateActivateResponse < OpenAI::Internal::Type::BaseModel
+          # @!attribute id
+          #   The identifier, which can be referenced in API endpoints
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute active
+          #   Whether the certificate is currently active at the organization level.
+          #
+          #   @return [Boolean]
+          required :active, OpenAI::Internal::Type::Boolean
+
+          # @!attribute certificate_details
+          #
+          #   @return [OpenAI::Models::Admin::Organization::CertificateActivateResponse::CertificateDetails]
+          required :certificate_details,
+                   -> { OpenAI::Models::Admin::Organization::CertificateActivateResponse::CertificateDetails }
+
+          # @!attribute created_at
+          #   The Unix timestamp (in seconds) of when the certificate was uploaded.
+          #
+          #   @return [Integer]
+          required :created_at, Integer
+
+          # @!attribute name
+          #   The name of the certificate.
+          #
+          #   @return [String, nil]
+          required :name, String, nil?: true
+
+          # @!attribute object
+          #   The object type, which is always `organization.certificate`.
+          #
+          #   @return [Symbol, :"organization.certificate"]
+          required :object, const: :"organization.certificate"
+
+          # @!method initialize(id:, active:, certificate_details:, created_at:, name:, object: :"organization.certificate")
+          #   Represents an individual certificate configured at the organization level.
+          #
+          #   @param id [String] The identifier, which can be referenced in API endpoints
+          #
+          #   @param active [Boolean] Whether the certificate is currently active at the organization level.
+          #
+          #   @param certificate_details [OpenAI::Models::Admin::Organization::CertificateActivateResponse::CertificateDetails]
+          #
+          #   @param created_at [Integer] The Unix timestamp (in seconds) of when the certificate was uploaded.
+          #
+          #   @param name [String, nil] The name of the certificate.
+          #
+          #   @param object [Symbol, :"organization.certificate"] The object type, which is always `organization.certificate`.
+
+          # @see OpenAI::Models::Admin::Organization::CertificateActivateResponse#certificate_details
+          class CertificateDetails < OpenAI::Internal::Type::BaseModel
+            # @!attribute expires_at
+            #   The Unix timestamp (in seconds) of when the certificate expires.
+            #
+            #   @return [Integer, nil]
+            optional :expires_at, Integer
+
+            # @!attribute valid_at
+            #   The Unix timestamp (in seconds) of when the certificate becomes valid.
+            #
+            #   @return [Integer, nil]
+            optional :valid_at, Integer
+
+            # @!method initialize(expires_at: nil, valid_at: nil)
+            #   @param expires_at [Integer] The Unix timestamp (in seconds) of when the certificate expires.
+            #
+            #   @param valid_at [Integer] The Unix timestamp (in seconds) of when the certificate becomes valid.
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        # @see OpenAI::Resources::Admin::Organization::Certificates#create
+        class CertificateCreateParams < OpenAI::Internal::Type::BaseModel
+          extend OpenAI::Internal::Type::RequestParameters::Converter
+          include OpenAI::Internal::Type::RequestParameters
+
+          # @!attribute certificate
+          #   The certificate content in PEM format
+          #
+          #   @return [String]
+          required :certificate, String
+
+          # @!attribute name
+          #   An optional name for the certificate
+          #
+          #   @return [String, nil]
+          optional :name, String
+
+          # @!method initialize(certificate:, name: nil, request_options: {})
+          #   @param certificate [String] The certificate content in PEM format
+          #
+          #   @param name [String] An optional name for the certificate
+          #
+          #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        # @see OpenAI::Resources::Admin::Organization::Certificates#deactivate
+        class CertificateDeactivateResponse < OpenAI::Internal::Type::BaseModel
+          # @!attribute id
+          #   The identifier, which can be referenced in API endpoints
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute active
+          #   Whether the certificate is currently active at the organization level.
+          #
+          #   @return [Boolean]
+          required :active, OpenAI::Internal::Type::Boolean
+
+          # @!attribute certificate_details
+          #
+          #   @return [OpenAI::Models::Admin::Organization::CertificateDeactivateResponse::CertificateDetails]
+          required :certificate_details,
+                   -> { OpenAI::Models::Admin::Organization::CertificateDeactivateResponse::CertificateDetails }
+
+          # @!attribute created_at
+          #   The Unix timestamp (in seconds) of when the certificate was uploaded.
+          #
+          #   @return [Integer]
+          required :created_at, Integer
+
+          # @!attribute name
+          #   The name of the certificate.
+          #
+          #   @return [String, nil]
+          required :name, String, nil?: true
+
+          # @!attribute object
+          #   The object type, which is always `organization.certificate`.
+          #
+          #   @return [Symbol, :"organization.certificate"]
+          required :object, const: :"organization.certificate"
+
+          # @!method initialize(id:, active:, certificate_details:, created_at:, name:, object: :"organization.certificate")
+          #   Represents an individual certificate configured at the organization level.
+          #
+          #   @param id [String] The identifier, which can be referenced in API endpoints
+          #
+          #   @param active [Boolean] Whether the certificate is currently active at the organization level.
+          #
+          #   @param certificate_details [OpenAI::Models::Admin::Organization::CertificateDeactivateResponse::CertificateDetails]
+          #
+          #   @param created_at [Integer] The Unix timestamp (in seconds) of when the certificate was uploaded.
+          #
+          #   @param name [String, nil] The name of the certificate.
+          #
+          #   @param object [Symbol, :"organization.certificate"] The object type, which is always `organization.certificate`.
+
+          # @see OpenAI::Models::Admin::Organization::CertificateDeactivateResponse#certificate_details
+          class CertificateDetails < OpenAI::Internal::Type::BaseModel
+            # @!attribute expires_at
+            #   The Unix timestamp (in seconds) of when the certificate expires.
+            #
+            #   @return [Integer, nil]
+            optional :expires_at, Integer
+
+            # @!attribute valid_at
+            #   The Unix timestamp (in seconds) of when the certificate becomes valid.
+            #
+            #   @return [Integer, nil]
+            optional :valid_at, Integer
+
+            # @!method initialize(expires_at: nil, valid_at: nil)
+            #   @param expires_at [Integer] The Unix timestamp (in seconds) of when the certificate expires.
+            #
+            #   @param valid_at [Integer] The Unix timestamp (in seconds) of when the certificate becomes valid.
+          end
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        # @see OpenAI::Resources::Admin::Organization::Certificates#delete
+        class CertificateDeleteResponse < OpenAI::Internal::Type::BaseModel
+          # @!attribute id
+          #   The ID of the certificate that was deleted.
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute object
+          #   The object type, must be `certificate.deleted`.
+          #
+          #   @return [Symbol, :"certificate.deleted"]
+          required :object, const: :"certificate.deleted"
+
+          # @!method initialize(id:, object: :"certificate.deleted")
+          #   @param id [String] The ID of the certificate that was deleted.
+          #
+          #   @param object [Symbol, :"certificate.deleted"] The object type, must be `certificate.deleted`.
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        # @see OpenAI::Resources::Admin::Organization::Certificates#list
+        class CertificateListParams < OpenAI::Internal::Type::BaseModel
+          extend OpenAI::Internal::Type::RequestParameters::Converter
+          include OpenAI::Internal::Type::RequestParameters
+
+          # @!attribute 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.
+          #
+          #   @return [String, nil]
+          optional :after, String
+
+          # @!attribute limit
+          #   A limit on the number of objects to be returned. Limit can range between 1 and
+          #   100, and the default is 20.
+          #
+          #   @return [Integer, nil]
+          optional :limit, Integer
+
+          # @!attribute order
+          #   Sort order by the `created_at` timestamp of the objects. `asc` for ascending
+          #   order and `desc` for descending order.
+          #
+          #   @return [Symbol, OpenAI::Models::Admin::Organization::CertificateListParams::Order, nil]
+          optional :order, enum: -> { OpenAI::Admin::Organization::CertificateListParams::Order }
+
+          # @!method initialize(after: nil, limit: nil, order: nil, request_options: {})
+          #   Some parameter documentations has been truncated, see
+          #   {OpenAI::Models::Admin::Organization::CertificateListParams} for more details.
+          #
+          #   @param after [String] A cursor for use in pagination. `after` is an object ID that defines your place
+          #
+          #   @param limit [Integer] A limit on the number of objects to be returned. Limit can range between 1 and 1
+          #
+          #   @param order [Symbol, OpenAI::Models::Admin::Organization::CertificateListParams::Order] Sort order by the `created_at` timestamp of the objects. `asc` for ascending ord
+          #
+          #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+
+          # Sort order by the `created_at` timestamp of the objects. `asc` for ascending
+          # order and `desc` for descending order.
+          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/certificate_list_response.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        # @see OpenAI::Resources::Admin::Organization::Certificates#list
+        class CertificateListResponse < OpenAI::Internal::Type::BaseModel
+          # @!attribute id
+          #   The identifier, which can be referenced in API endpoints
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute active
+          #   Whether the certificate is currently active at the organization level.
+          #
+          #   @return [Boolean]
+          required :active, OpenAI::Internal::Type::Boolean
+
+          # @!attribute certificate_details
+          #
+          #   @return [OpenAI::Models::Admin::Organization::CertificateListResponse::CertificateDetails]
+          required :certificate_details,
+                   -> { OpenAI::Models::Admin::Organization::CertificateListResponse::CertificateDetails }
+
+          # @!attribute created_at
+          #   The Unix timestamp (in seconds) of when the certificate was uploaded.
+          #
+          #   @return [Integer]
+          required :created_at, Integer
+
+          # @!attribute name
+          #   The name of the certificate.
+          #
+          #   @return [String, nil]
+          required :name, String, nil?: true
+
+          # @!attribute object
+          #   The object type, which is always `organization.certificate`.
+          #
+          #   @return [Symbol, :"organization.certificate"]
+          required :object, const: :"organization.certificate"
+
+          # @!method initialize(id:, active:, certificate_details:, created_at:, name:, object: :"organization.certificate")
+          #   Represents an individual certificate configured at the organization level.
+          #
+          #   @param id [String] The identifier, which can be referenced in API endpoints
+          #
+          #   @param active [Boolean] Whether the certificate is currently active at the organization level.
+          #
+          #   @param certificate_details [OpenAI::Models::Admin::Organization::CertificateListResponse::CertificateDetails]
+          #
+          #   @param created_at [Integer] The Unix timestamp (in seconds) of when the certificate was uploaded.
+          #
+          #   @param name [String, nil] The name of the certificate.
+          #
+          #   @param object [Symbol, :"organization.certificate"] The object type, which is always `organization.certificate`.
+
+          # @see OpenAI::Models::Admin::Organization::CertificateListResponse#certificate_details
+          class CertificateDetails < OpenAI::Internal::Type::BaseModel
+            # @!attribute expires_at
+            #   The Unix timestamp (in seconds) of when the certificate expires.
+            #
+            #   @return [Integer, nil]
+            optional :expires_at, Integer
+
+            # @!attribute valid_at
+            #   The Unix timestamp (in seconds) of when the certificate becomes valid.
+            #
+            #   @return [Integer, nil]
+            optional :valid_at, Integer
+
+            # @!method initialize(expires_at: nil, valid_at: nil)
+            #   @param expires_at [Integer] The Unix timestamp (in seconds) of when the certificate expires.
+            #
+            #   @param valid_at [Integer] The Unix timestamp (in seconds) of when the certificate becomes valid.
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        # @see OpenAI::Resources::Admin::Organization::Certificates#retrieve
+        class CertificateRetrieveParams < OpenAI::Internal::Type::BaseModel
+          extend OpenAI::Internal::Type::RequestParameters::Converter
+          include OpenAI::Internal::Type::RequestParameters
+
+          # @!attribute certificate_id
+          #
+          #   @return [String]
+          required :certificate_id, String
+
+          # @!attribute 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.
+          #
+          #   @return [Array<Symbol, OpenAI::Models::Admin::Organization::CertificateRetrieveParams::Include>, nil]
+          optional :include,
+                   -> { OpenAI::Internal::Type::ArrayOf[enum: OpenAI::Admin::Organization::CertificateRetrieveParams::Include] }
+
+          # @!method initialize(certificate_id:, include: nil, request_options: {})
+          #   Some parameter documentations has been truncated, see
+          #   {OpenAI::Models::Admin::Organization::CertificateRetrieveParams} for more
+          #   details.
+          #
+          #   @param certificate_id [String]
+          #
+          #   @param include [Array<Symbol, OpenAI::Models::Admin::Organization::CertificateRetrieveParams::Include>] A list of additional fields to include in the response. Currently the only suppo
+          #
+          #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+
+          module Include
+            extend OpenAI::Internal::Type::Enum
+
+            CONTENT = :content
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        # @see OpenAI::Resources::Admin::Organization::Certificates#update
+        class CertificateUpdateParams < OpenAI::Internal::Type::BaseModel
+          extend OpenAI::Internal::Type::RequestParameters::Converter
+          include OpenAI::Internal::Type::RequestParameters
+
+          # @!attribute certificate_id
+          #
+          #   @return [String]
+          required :certificate_id, String
+
+          # @!attribute name
+          #   The updated name for the certificate
+          #
+          #   @return [String, nil]
+          optional :name, String
+
+          # @!method initialize(certificate_id:, name: nil, request_options: {})
+          #   @param certificate_id [String]
+          #
+          #   @param name [String] The updated name for the certificate
+          #
+          #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end