openai 0.59.0 → 0.61.0

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

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        module Projects
+          module Users
+            # @see OpenAI::Resources::Admin::Organization::Projects::Users::Roles#list
+            class RoleListParams < 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 after
+              #   Cursor for pagination. Provide the value from the previous response's `next`
+              #   field to continue listing project roles.
+              #
+              #   @return [String, nil]
+              optional :after, String
+
+              # @!attribute limit
+              #   A limit on the number of project role assignments to return.
+              #
+              #   @return [Integer, nil]
+              optional :limit, Integer
+
+              # @!attribute order
+              #   Sort order for the returned project roles.
+              #
+              #   @return [Symbol, OpenAI::Models::Admin::Organization::Projects::Users::RoleListParams::Order, nil]
+              optional :order, enum: -> { OpenAI::Admin::Organization::Projects::Users::RoleListParams::Order }
+
+              # @!method initialize(project_id:, user_id:, after: nil, limit: nil, order: nil, request_options: {})
+              #   Some parameter documentations has been truncated, see
+              #   {OpenAI::Models::Admin::Organization::Projects::Users::RoleListParams} for more
+              #   details.
+              #
+              #   @param project_id [String]
+              #
+              #   @param user_id [String]
+              #
+              #   @param after [String] Cursor for pagination. Provide the value from the previous response's `next` fie
+              #
+              #   @param limit [Integer] A limit on the number of project role assignments to return.
+              #
+              #   @param order [Symbol, OpenAI::Models::Admin::Organization::Projects::Users::RoleListParams::Order] Sort order for the returned project roles.
+              #
+              #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+
+              # Sort order for the returned project roles.
+              module Order
+                extend OpenAI::Internal::Type::Enum
+
+                ASC = :asc
+                DESC = :desc
+
+                # @!method self.values
+                #   @return [Array<Symbol>]
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        module Projects
+          module Users
+            # @see OpenAI::Resources::Admin::Organization::Projects::Users::Roles#list
+            class RoleListResponse < OpenAI::Internal::Type::BaseModel
+              # @!attribute id
+              #   Identifier for the role.
+              #
+              #   @return [String]
+              required :id, String
+
+              # @!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:, 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 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.
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        # @see OpenAI::Resources::Admin::Organization::Roles#create
+        class Role < OpenAI::Internal::Type::BaseModel
+          # @!attribute id
+          #   Identifier for the role.
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute description
+          #   Optional description of the role.
+          #
+          #   @return [String, nil]
+          required :description, String, nil?: true
+
+          # @!attribute name
+          #   Unique name for the role.
+          #
+          #   @return [String]
+          required :name, String
+
+          # @!attribute object
+          #   Always `role`.
+          #
+          #   @return [Symbol, :role]
+          required :object, const: :role
+
+          # @!attribute permissions
+          #   Permissions granted by the role.
+          #
+          #   @return [Array<String>]
+          required :permissions, OpenAI::Internal::Type::ArrayOf[String]
+
+          # @!attribute predefined_role
+          #   Whether the role is predefined and managed by OpenAI.
+          #
+          #   @return [Boolean]
+          required :predefined_role, OpenAI::Internal::Type::Boolean
+
+          # @!attribute resource_type
+          #   Resource type the role is bound to (for example `api.organization` or
+          #   `api.project`).
+          #
+          #   @return [String]
+          required :resource_type, String
+
+          # @!method initialize(id:, description:, name:, permissions:, predefined_role:, resource_type:, object: :role)
+          #   Some parameter documentations has been truncated, see
+          #   {OpenAI::Models::Admin::Organization::Role} for more details.
+          #
+          #   Details about a role that can be assigned through the public Roles API.
+          #
+          #   @param id [String] Identifier for the role.
+          #
+          #   @param description [String, nil] Optional description of the role.
+          #
+          #   @param name [String] Unique name for the role.
+          #
+          #   @param permissions [Array<String>] Permissions granted by the role.
+          #
+          #   @param predefined_role [Boolean] Whether the role is predefined and managed by OpenAI.
+          #
+          #   @param resource_type [String] Resource type the role is bound to (for example `api.organization` or `api.proje
+          #
+          #   @param object [Symbol, :role] Always `role`.
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        # @see OpenAI::Resources::Admin::Organization::Roles#create
+        class RoleCreateParams < OpenAI::Internal::Type::BaseModel
+          extend OpenAI::Internal::Type::RequestParameters::Converter
+          include OpenAI::Internal::Type::RequestParameters
+
+          # @!attribute permissions
+          #   Permissions to grant to the role.
+          #
+          #   @return [Array<String>]
+          required :permissions, OpenAI::Internal::Type::ArrayOf[String]
+
+          # @!attribute role_name
+          #   Unique name for the role.
+          #
+          #   @return [String]
+          required :role_name, String
+
+          # @!attribute description
+          #   Optional description of the role.
+          #
+          #   @return [String, nil]
+          optional :description, String, nil?: true
+
+          # @!method initialize(permissions:, role_name:, description: nil, request_options: {})
+          #   @param permissions [Array<String>] Permissions to grant to the role.
+          #
+          #   @param role_name [String] Unique name for the role.
+          #
+          #   @param description [String, nil] Optional description of the role.
+          #
+          #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        # @see OpenAI::Resources::Admin::Organization::Roles#delete
+        class RoleDeleteParams < 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/role_delete_response.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        # @see OpenAI::Resources::Admin::Organization::Roles#delete
+        class RoleDeleteResponse < OpenAI::Internal::Type::BaseModel
+          # @!attribute id
+          #   Identifier of the deleted role.
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute deleted
+          #   Whether the role was deleted.
+          #
+          #   @return [Boolean]
+          required :deleted, OpenAI::Internal::Type::Boolean
+
+          # @!attribute object
+          #   Always `role.deleted`.
+          #
+          #   @return [Symbol, :"role.deleted"]
+          required :object, const: :"role.deleted"
+
+          # @!method initialize(id:, deleted:, object: :"role.deleted")
+          #   Confirmation payload returned after deleting a role.
+          #
+          #   @param id [String] Identifier of the deleted role.
+          #
+          #   @param deleted [Boolean] Whether the role was deleted.
+          #
+          #   @param object [Symbol, :"role.deleted"] Always `role.deleted`.
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        # @see OpenAI::Resources::Admin::Organization::Roles#list
+        class RoleListParams < OpenAI::Internal::Type::BaseModel
+          extend OpenAI::Internal::Type::RequestParameters::Converter
+          include OpenAI::Internal::Type::RequestParameters
+
+          # @!attribute after
+          #   Cursor for pagination. Provide the value from the previous response's `next`
+          #   field to continue listing roles.
+          #
+          #   @return [String, nil]
+          optional :after, String
+
+          # @!attribute limit
+          #   A limit on the number of roles to return. Defaults to 1000.
+          #
+          #   @return [Integer, nil]
+          optional :limit, Integer
+
+          # @!attribute order
+          #   Sort order for the returned roles.
+          #
+          #   @return [Symbol, OpenAI::Models::Admin::Organization::RoleListParams::Order, nil]
+          optional :order, enum: -> { OpenAI::Admin::Organization::RoleListParams::Order }
+
+          # @!method initialize(after: nil, limit: nil, order: nil, request_options: {})
+          #   Some parameter documentations has been truncated, see
+          #   {OpenAI::Models::Admin::Organization::RoleListParams} for more details.
+          #
+          #   @param after [String] Cursor for pagination. Provide the value from the previous response's `next` fie
+          #
+          #   @param limit [Integer] A limit on the number of roles to return. Defaults to 1000.
+          #
+          #   @param order [Symbol, OpenAI::Models::Admin::Organization::RoleListParams::Order] Sort order for the returned roles.
+          #
+          #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+
+          # Sort order for the returned roles.
+          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/role_update_params.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        # @see OpenAI::Resources::Admin::Organization::Roles#update
+        class RoleUpdateParams < OpenAI::Internal::Type::BaseModel
+          extend OpenAI::Internal::Type::RequestParameters::Converter
+          include OpenAI::Internal::Type::RequestParameters
+
+          # @!attribute role_id
+          #
+          #   @return [String]
+          required :role_id, String
+
+          # @!attribute description
+          #   New description for the role.
+          #
+          #   @return [String, nil]
+          optional :description, String, nil?: true
+
+          # @!attribute permissions
+          #   Updated set of permissions for the role.
+          #
+          #   @return [Array<String>, nil]
+          optional :permissions, OpenAI::Internal::Type::ArrayOf[String], nil?: true
+
+          # @!attribute role_name
+          #   New name for the role.
+          #
+          #   @return [String, nil]
+          optional :role_name, String, nil?: true
+
+          # @!method initialize(role_id:, description: nil, permissions: nil, role_name: nil, request_options: {})
+          #   @param role_id [String]
+          #
+          #   @param description [String, nil] New description for the role.
+          #
+          #   @param permissions [Array<String>, nil] Updated set of permissions for the role.
+          #
+          #   @param role_name [String, nil] New name for the role.
+          #
+          #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        # @see OpenAI::Resources::Admin::Organization::Usage#audio_speeches
+        class UsageAudioSpeechesParams < OpenAI::Internal::Type::BaseModel
+          extend OpenAI::Internal::Type::RequestParameters::Converter
+          include OpenAI::Internal::Type::RequestParameters
+
+          # @!attribute start_time
+          #   Start time (Unix seconds) of the query time range, inclusive.
+          #
+          #   @return [Integer]
+          required :start_time, Integer
+
+          # @!attribute api_key_ids
+          #   Return only usage for these API keys.
+          #
+          #   @return [Array<String>, nil]
+          optional :api_key_ids, OpenAI::Internal::Type::ArrayOf[String]
+
+          # @!attribute bucket_width
+          #   Width of each time bucket in response. Currently `1m`, `1h` and `1d` are
+          #   supported, default to `1d`.
+          #
+          #   @return [Symbol, OpenAI::Models::Admin::Organization::UsageAudioSpeechesParams::BucketWidth, nil]
+          optional :bucket_width, enum: -> { OpenAI::Admin::Organization::UsageAudioSpeechesParams::BucketWidth }
+
+          # @!attribute end_time
+          #   End time (Unix seconds) of the query time range, exclusive.
+          #
+          #   @return [Integer, nil]
+          optional :end_time, Integer
+
+          # @!attribute group_by
+          #   Group the usage data by the specified fields. Support fields include
+          #   `project_id`, `user_id`, `api_key_id`, `model` or any combination of them.
+          #
+          #   @return [Array<Symbol, OpenAI::Models::Admin::Organization::UsageAudioSpeechesParams::GroupBy>, nil]
+          optional :group_by,
+                   -> { OpenAI::Internal::Type::ArrayOf[enum: OpenAI::Admin::Organization::UsageAudioSpeechesParams::GroupBy] }
+
+          # @!attribute limit
+          #   Specifies the number of buckets to return.
+          #
+          #   - `bucket_width=1d`: default: 7, max: 31
+          #   - `bucket_width=1h`: default: 24, max: 168
+          #   - `bucket_width=1m`: default: 60, max: 1440
+          #
+          #   @return [Integer, nil]
+          optional :limit, Integer
+
+          # @!attribute models
+          #   Return only usage for these models.
+          #
+          #   @return [Array<String>, nil]
+          optional :models, OpenAI::Internal::Type::ArrayOf[String]
+
+          # @!attribute page
+          #   A cursor for use in pagination. Corresponding to the `next_page` field from the
+          #   previous response.
+          #
+          #   @return [String, nil]
+          optional :page, String
+
+          # @!attribute project_ids
+          #   Return only usage for these projects.
+          #
+          #   @return [Array<String>, nil]
+          optional :project_ids, OpenAI::Internal::Type::ArrayOf[String]
+
+          # @!attribute user_ids
+          #   Return only usage for these users.
+          #
+          #   @return [Array<String>, nil]
+          optional :user_ids, OpenAI::Internal::Type::ArrayOf[String]
+
+          # @!method initialize(start_time:, api_key_ids: nil, bucket_width: nil, end_time: nil, group_by: nil, limit: nil, models: nil, page: nil, project_ids: nil, user_ids: nil, request_options: {})
+          #   Some parameter documentations has been truncated, see
+          #   {OpenAI::Models::Admin::Organization::UsageAudioSpeechesParams} for more
+          #   details.
+          #
+          #   @param start_time [Integer] Start time (Unix seconds) of the query time range, inclusive.
+          #
+          #   @param api_key_ids [Array<String>] Return only usage for these API keys.
+          #
+          #   @param bucket_width [Symbol, OpenAI::Models::Admin::Organization::UsageAudioSpeechesParams::BucketWidth] Width of each time bucket in response. Currently `1m`, `1h` and `1d` are support
+          #
+          #   @param end_time [Integer] End time (Unix seconds) of the query time range, exclusive.
+          #
+          #   @param group_by [Array<Symbol, OpenAI::Models::Admin::Organization::UsageAudioSpeechesParams::GroupBy>] Group the usage data by the specified fields. Support fields include `project_id
+          #
+          #   @param limit [Integer] Specifies the number of buckets to return.
+          #
+          #   @param models [Array<String>] Return only usage for these models.
+          #
+          #   @param page [String] A cursor for use in pagination. Corresponding to the `next_page` field from the
+          #
+          #   @param project_ids [Array<String>] Return only usage for these projects.
+          #
+          #   @param user_ids [Array<String>] Return only usage for these users.
+          #
+          #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+
+          # Width of each time bucket in response. Currently `1m`, `1h` and `1d` are
+          # supported, default to `1d`.
+          module BucketWidth
+            extend OpenAI::Internal::Type::Enum
+
+            BUCKET_WIDTH_1M = :"1m"
+            BUCKET_WIDTH_1H = :"1h"
+            BUCKET_WIDTH_1D = :"1d"
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          module GroupBy
+            extend OpenAI::Internal::Type::Enum
+
+            PROJECT_ID = :project_id
+            USER_ID = :user_id
+            API_KEY_ID = :api_key_id
+            MODEL = :model
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end