openai 0.60.0 → 0.61.0

data/lib/openai/resources/admin/organization/projects/rate_limits.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Resources
+    class Admin
+      class Organization
+        class Projects
+          class RateLimits
+            # Some parameter documentations has been truncated, see
+            # {OpenAI::Models::Admin::Organization::Projects::RateLimitListRateLimitsParams}
+            # for more details.
+            #
+            # Returns the rate limits per model for a project.
+            #
+            # @overload list_rate_limits(project_id, after: nil, before: nil, limit: nil, request_options: {})
+            #
+            # @param project_id [String] The ID of the project.
+            #
+            # @param after [String] A cursor for use in pagination. `after` is an object ID that defines your place
+            #
+            # @param before [String] A cursor for use in pagination. `before` is an object ID that defines your place
+            #
+            # @param limit [Integer] A limit on the number of objects to be returned. The default is 100.
+            #
+            # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+            #
+            # @return [OpenAI::Internal::ConversationCursorPage<OpenAI::Models::Admin::Organization::Projects::ProjectRateLimit>]
+            #
+            # @see OpenAI::Models::Admin::Organization::Projects::RateLimitListRateLimitsParams
+            def list_rate_limits(project_id, params = {})
+              parsed, options =
+                OpenAI::Admin::Organization::Projects::RateLimitListRateLimitsParams.dump_request(params)
+              query = OpenAI::Internal::Util.encode_query_params(parsed)
+              @client.request(
+                method: :get,
+                path: ["organization/projects/%1$s/rate_limits", project_id],
+                query: query,
+                page: OpenAI::Internal::ConversationCursorPage,
+                model: OpenAI::Admin::Organization::Projects::ProjectRateLimit,
+                security: {admin_api_key_auth: true},
+                options: options
+              )
+            end
+
+            # Some parameter documentations has been truncated, see
+            # {OpenAI::Models::Admin::Organization::Projects::RateLimitUpdateRateLimitParams}
+            # for more details.
+            #
+            # Updates a project rate limit.
+            #
+            # @overload update_rate_limit(rate_limit_id, project_id:, batch_1_day_max_input_tokens: nil, max_audio_megabytes_per_1_minute: nil, max_images_per_1_minute: nil, max_requests_per_1_day: nil, max_requests_per_1_minute: nil, max_tokens_per_1_minute: nil, request_options: {})
+            #
+            # @param rate_limit_id [String] Path param: The ID of the rate limit.
+            #
+            # @param project_id [String] Path param: The ID of the project.
+            #
+            # @param batch_1_day_max_input_tokens [Integer] Body param: The maximum batch input tokens per day. Only relevant for certain mo
+            #
+            # @param max_audio_megabytes_per_1_minute [Integer] Body param: The maximum audio megabytes per minute. Only relevant for certain mo
+            #
+            # @param max_images_per_1_minute [Integer] Body param: The maximum images per minute. Only relevant for certain models.
+            #
+            # @param max_requests_per_1_day [Integer] Body param: The maximum requests per day. Only relevant for certain models.
+            #
+            # @param max_requests_per_1_minute [Integer] Body param: The maximum requests per minute.
+            #
+            # @param max_tokens_per_1_minute [Integer] Body param: The maximum tokens per minute.
+            #
+            # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+            #
+            # @return [OpenAI::Models::Admin::Organization::Projects::ProjectRateLimit]
+            #
+            # @see OpenAI::Models::Admin::Organization::Projects::RateLimitUpdateRateLimitParams
+            def update_rate_limit(rate_limit_id, params)
+              parsed, options =
+                OpenAI::Admin::Organization::Projects::RateLimitUpdateRateLimitParams.dump_request(params)
+              project_id =
+                parsed.delete(:project_id) do
+                  raise ArgumentError.new("missing required path argument #{_1}")
+                end
+              @client.request(
+                method: :post,
+                path: ["organization/projects/%1$s/rate_limits/%2$s", project_id, rate_limit_id],
+                body: parsed,
+                model: OpenAI::Admin::Organization::Projects::ProjectRateLimit,
+                security: {admin_api_key_auth: true},
+                options: options
+              )
+            end
+
+            # @api private
+            #
+            # @param client [OpenAI::Client]
+            def initialize(client:)
+              @client = client
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openai/resources/admin/organization/projects/roles.rb

@@ -0,0 +1,147 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Resources
+    class Admin
+      class Organization
+        class Projects
+          class Roles
+            # Creates a custom role for a project.
+            #
+            # @overload create(project_id, permissions:, role_name:, description: nil, request_options: {})
+            #
+            # @param project_id [String] The ID of the project to update.
+            #
+            # @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}, nil]
+            #
+            # @return [OpenAI::Models::Admin::Organization::Role]
+            #
+            # @see OpenAI::Models::Admin::Organization::Projects::RoleCreateParams
+            def create(project_id, params)
+              parsed, options = OpenAI::Admin::Organization::Projects::RoleCreateParams.dump_request(params)
+              @client.request(
+                method: :post,
+                path: ["projects/%1$s/roles", project_id],
+                body: parsed,
+                model: OpenAI::Admin::Organization::Role,
+                security: {admin_api_key_auth: true},
+                options: options
+              )
+            end
+
+            # Updates an existing project role.
+            #
+            # @overload update(role_id, project_id:, description: nil, permissions: nil, role_name: nil, request_options: {})
+            #
+            # @param role_id [String] Path param: The ID of the role to update.
+            #
+            # @param project_id [String] Path param: The ID of the project to update.
+            #
+            # @param description [String, nil] Body param: New description for the role.
+            #
+            # @param permissions [Array<String>, nil] Body param: Updated set of permissions for the role.
+            #
+            # @param role_name [String, nil] Body param: New name for the role.
+            #
+            # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+            #
+            # @return [OpenAI::Models::Admin::Organization::Role]
+            #
+            # @see OpenAI::Models::Admin::Organization::Projects::RoleUpdateParams
+            def update(role_id, params)
+              parsed, options = OpenAI::Admin::Organization::Projects::RoleUpdateParams.dump_request(params)
+              project_id =
+                parsed.delete(:project_id) do
+                  raise ArgumentError.new("missing required path argument #{_1}")
+                end
+              @client.request(
+                method: :post,
+                path: ["projects/%1$s/roles/%2$s", project_id, role_id],
+                body: parsed,
+                model: OpenAI::Admin::Organization::Role,
+                security: {admin_api_key_auth: true},
+                options: options
+              )
+            end
+
+            # Some parameter documentations has been truncated, see
+            # {OpenAI::Models::Admin::Organization::Projects::RoleListParams} for more
+            # details.
+            #
+            # Lists the roles configured for a project.
+            #
+            # @overload list(project_id, after: nil, limit: nil, order: nil, request_options: {})
+            #
+            # @param project_id [String] The ID of the project to inspect.
+            #
+            # @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::Projects::RoleListParams::Order] Sort order for the returned roles.
+            #
+            # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+            #
+            # @return [OpenAI::Internal::NextCursorPage<OpenAI::Models::Admin::Organization::Role>]
+            #
+            # @see OpenAI::Models::Admin::Organization::Projects::RoleListParams
+            def list(project_id, params = {})
+              parsed, options = OpenAI::Admin::Organization::Projects::RoleListParams.dump_request(params)
+              query = OpenAI::Internal::Util.encode_query_params(parsed)
+              @client.request(
+                method: :get,
+                path: ["projects/%1$s/roles", project_id],
+                query: query,
+                page: OpenAI::Internal::NextCursorPage,
+                model: OpenAI::Admin::Organization::Role,
+                security: {admin_api_key_auth: true},
+                options: options
+              )
+            end
+
+            # Deletes a custom role from a project.
+            #
+            # @overload delete(role_id, project_id:, request_options: {})
+            #
+            # @param role_id [String] The ID of the role to delete.
+            #
+            # @param project_id [String] The ID of the project to update.
+            #
+            # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+            #
+            # @return [OpenAI::Models::Admin::Organization::Projects::RoleDeleteResponse]
+            #
+            # @see OpenAI::Models::Admin::Organization::Projects::RoleDeleteParams
+            def delete(role_id, params)
+              parsed, options = OpenAI::Admin::Organization::Projects::RoleDeleteParams.dump_request(params)
+              project_id =
+                parsed.delete(:project_id) do
+                  raise ArgumentError.new("missing required path argument #{_1}")
+                end
+              @client.request(
+                method: :delete,
+                path: ["projects/%1$s/roles/%2$s", project_id, role_id],
+                model: OpenAI::Models::Admin::Organization::Projects::RoleDeleteResponse,
+                security: {admin_api_key_auth: true},
+                options: options
+              )
+            end
+
+            # @api private
+            #
+            # @param client [OpenAI::Client]
+            def initialize(client:)
+              @client = client
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openai/resources/admin/organization/projects/service_accounts.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Resources
+    class Admin
+      class Organization
+        class Projects
+          class ServiceAccounts
+            # Creates a new service account in the project. This also returns an unredacted
+            # API key for the service account.
+            #
+            # @overload create(project_id, name:, request_options: {})
+            #
+            # @param project_id [String] The ID of the project.
+            #
+            # @param name [String] The name of the service account being created.
+            #
+            # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+            #
+            # @return [OpenAI::Models::Admin::Organization::Projects::ServiceAccountCreateResponse]
+            #
+            # @see OpenAI::Models::Admin::Organization::Projects::ServiceAccountCreateParams
+            def create(project_id, params)
+              parsed, options = OpenAI::Admin::Organization::Projects::ServiceAccountCreateParams.dump_request(params)
+              @client.request(
+                method: :post,
+                path: ["organization/projects/%1$s/service_accounts", project_id],
+                body: parsed,
+                model: OpenAI::Models::Admin::Organization::Projects::ServiceAccountCreateResponse,
+                security: {admin_api_key_auth: true},
+                options: options
+              )
+            end
+
+            # Retrieves a service account in the project.
+            #
+            # @overload retrieve(service_account_id, project_id:, request_options: {})
+            #
+            # @param service_account_id [String] The ID of the service account.
+            #
+            # @param project_id [String] The ID of the project.
+            #
+            # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+            #
+            # @return [OpenAI::Models::Admin::Organization::Projects::ProjectServiceAccount]
+            #
+            # @see OpenAI::Models::Admin::Organization::Projects::ServiceAccountRetrieveParams
+            def retrieve(service_account_id, params)
+              parsed, options =
+                OpenAI::Admin::Organization::Projects::ServiceAccountRetrieveParams.dump_request(params)
+              project_id =
+                parsed.delete(:project_id) do
+                  raise ArgumentError.new("missing required path argument #{_1}")
+                end
+              @client.request(
+                method: :get,
+                path: ["organization/projects/%1$s/service_accounts/%2$s", project_id, service_account_id],
+                model: OpenAI::Admin::Organization::Projects::ProjectServiceAccount,
+                security: {admin_api_key_auth: true},
+                options: options
+              )
+            end
+
+            # Some parameter documentations has been truncated, see
+            # {OpenAI::Models::Admin::Organization::Projects::ServiceAccountListParams} for
+            # more details.
+            #
+            # Returns a list of service accounts in the project.
+            #
+            # @overload list(project_id, after: nil, limit: nil, request_options: {})
+            #
+            # @param project_id [String] The ID of the project.
+            #
+            # @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 request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+            #
+            # @return [OpenAI::Internal::ConversationCursorPage<OpenAI::Models::Admin::Organization::Projects::ProjectServiceAccount>]
+            #
+            # @see OpenAI::Models::Admin::Organization::Projects::ServiceAccountListParams
+            def list(project_id, params = {})
+              parsed, options = OpenAI::Admin::Organization::Projects::ServiceAccountListParams.dump_request(params)
+              query = OpenAI::Internal::Util.encode_query_params(parsed)
+              @client.request(
+                method: :get,
+                path: ["organization/projects/%1$s/service_accounts", project_id],
+                query: query,
+                page: OpenAI::Internal::ConversationCursorPage,
+                model: OpenAI::Admin::Organization::Projects::ProjectServiceAccount,
+                security: {admin_api_key_auth: true},
+                options: options
+              )
+            end
+
+            # Deletes a service account from the project.
+            #
+            # Returns confirmation of service account deletion, or an error if the project is
+            # archived (archived projects have no service accounts).
+            #
+            # @overload delete(service_account_id, project_id:, request_options: {})
+            #
+            # @param service_account_id [String] The ID of the service account.
+            #
+            # @param project_id [String] The ID of the project.
+            #
+            # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+            #
+            # @return [OpenAI::Models::Admin::Organization::Projects::ServiceAccountDeleteResponse]
+            #
+            # @see OpenAI::Models::Admin::Organization::Projects::ServiceAccountDeleteParams
+            def delete(service_account_id, params)
+              parsed, options = OpenAI::Admin::Organization::Projects::ServiceAccountDeleteParams.dump_request(params)
+              project_id =
+                parsed.delete(:project_id) do
+                  raise ArgumentError.new("missing required path argument #{_1}")
+                end
+              @client.request(
+                method: :delete,
+                path: ["organization/projects/%1$s/service_accounts/%2$s", project_id, service_account_id],
+                model: OpenAI::Models::Admin::Organization::Projects::ServiceAccountDeleteResponse,
+                security: {admin_api_key_auth: true},
+                options: options
+              )
+            end
+
+            # @api private
+            #
+            # @param client [OpenAI::Client]
+            def initialize(client:)
+              @client = client
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openai/resources/admin/organization/projects/users/roles.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Resources
+    class Admin
+      class Organization
+        class Projects
+          class Users
+            class Roles
+              # Assigns a project role to a user within a project.
+              #
+              # @overload create(user_id, project_id:, role_id:, request_options: {})
+              #
+              # @param user_id [String] Path param: The ID of the user that should receive the project role.
+              #
+              # @param project_id [String] Path param: The ID of the project to update.
+              #
+              # @param role_id [String] Body param: Identifier of the role to assign.
+              #
+              # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+              #
+              # @return [OpenAI::Models::Admin::Organization::Projects::Users::RoleCreateResponse]
+              #
+              # @see OpenAI::Models::Admin::Organization::Projects::Users::RoleCreateParams
+              def create(user_id, params)
+                parsed, options = OpenAI::Admin::Organization::Projects::Users::RoleCreateParams.dump_request(params)
+                project_id =
+                  parsed.delete(:project_id) do
+                    raise ArgumentError.new("missing required path argument #{_1}")
+                  end
+                @client.request(
+                  method: :post,
+                  path: ["projects/%1$s/users/%2$s/roles", project_id, user_id],
+                  body: parsed,
+                  model: OpenAI::Models::Admin::Organization::Projects::Users::RoleCreateResponse,
+                  security: {admin_api_key_auth: true},
+                  options: options
+                )
+              end
+
+              # Some parameter documentations has been truncated, see
+              # {OpenAI::Models::Admin::Organization::Projects::Users::RoleListParams} for more
+              # details.
+              #
+              # Lists the project roles assigned to a user within a project.
+              #
+              # @overload list(user_id, project_id:, after: nil, limit: nil, order: nil, request_options: {})
+              #
+              # @param user_id [String] Path param: The ID of the user to inspect.
+              #
+              # @param project_id [String] Path param: The ID of the project to inspect.
+              #
+              # @param after [String] Query param: Cursor for pagination. Provide the value from the previous response
+              #
+              # @param limit [Integer] Query param: A limit on the number of project role assignments to return.
+              #
+              # @param order [Symbol, OpenAI::Models::Admin::Organization::Projects::Users::RoleListParams::Order] Query param: Sort order for the returned project roles.
+              #
+              # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+              #
+              # @return [OpenAI::Internal::NextCursorPage<OpenAI::Models::Admin::Organization::Projects::Users::RoleListResponse>]
+              #
+              # @see OpenAI::Models::Admin::Organization::Projects::Users::RoleListParams
+              def list(user_id, params)
+                parsed, options = OpenAI::Admin::Organization::Projects::Users::RoleListParams.dump_request(params)
+                query = OpenAI::Internal::Util.encode_query_params(parsed)
+                project_id =
+                  parsed.delete(:project_id) do
+                    raise ArgumentError.new("missing required path argument #{_1}")
+                  end
+                @client.request(
+                  method: :get,
+                  path: ["projects/%1$s/users/%2$s/roles", project_id, user_id],
+                  query: query,
+                  page: OpenAI::Internal::NextCursorPage,
+                  model: OpenAI::Models::Admin::Organization::Projects::Users::RoleListResponse,
+                  security: {admin_api_key_auth: true},
+                  options: options
+                )
+              end
+
+              # Unassigns a project role from a user within a project.
+              #
+              # @overload delete(role_id, project_id:, user_id:, request_options: {})
+              #
+              # @param role_id [String] The ID of the project role to remove from the user.
+              #
+              # @param project_id [String] The ID of the project to modify.
+              #
+              # @param user_id [String] The ID of the user whose project role assignment should be removed.
+              #
+              # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+              #
+              # @return [OpenAI::Models::Admin::Organization::Projects::Users::RoleDeleteResponse]
+              #
+              # @see OpenAI::Models::Admin::Organization::Projects::Users::RoleDeleteParams
+              def delete(role_id, params)
+                parsed, options = OpenAI::Admin::Organization::Projects::Users::RoleDeleteParams.dump_request(params)
+                project_id =
+                  parsed.delete(:project_id) do
+                    raise ArgumentError.new("missing required path argument #{_1}")
+                  end
+                user_id =
+                  parsed.delete(:user_id) do
+                    raise ArgumentError.new("missing required path argument #{_1}")
+                  end
+                @client.request(
+                  method: :delete,
+                  path: ["projects/%1$s/users/%2$s/roles/%3$s", project_id, user_id, role_id],
+                  model: OpenAI::Models::Admin::Organization::Projects::Users::RoleDeleteResponse,
+                  security: {admin_api_key_auth: true},
+                  options: options
+                )
+              end
+
+              # @api private
+              #
+              # @param client [OpenAI::Client]
+              def initialize(client:)
+                @client = client
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end