openai 0.59.0 → 0.61.0

data/lib/openai/resources/admin/organization/groups.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Resources
+    class Admin
+      class Organization
+        class Groups
+          # @return [OpenAI::Resources::Admin::Organization::Groups::Users]
+          attr_reader :users
+
+          # @return [OpenAI::Resources::Admin::Organization::Groups::Roles]
+          attr_reader :roles
+
+          # Creates a new group in the organization.
+          #
+          # @overload create(name:, request_options: {})
+          #
+          # @param name [String] Human readable name for the group.
+          #
+          # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [OpenAI::Models::Admin::Organization::Group]
+          #
+          # @see OpenAI::Models::Admin::Organization::GroupCreateParams
+          def create(params)
+            parsed, options = OpenAI::Admin::Organization::GroupCreateParams.dump_request(params)
+            @client.request(
+              method: :post,
+              path: "organization/groups",
+              body: parsed,
+              model: OpenAI::Admin::Organization::Group,
+              security: {admin_api_key_auth: true},
+              options: options
+            )
+          end
+
+          # Updates a group's information.
+          #
+          # @overload update(group_id, name:, request_options: {})
+          #
+          # @param group_id [String] The ID of the group to update.
+          #
+          # @param name [String] New display name for the group.
+          #
+          # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [OpenAI::Models::Admin::Organization::GroupUpdateResponse]
+          #
+          # @see OpenAI::Models::Admin::Organization::GroupUpdateParams
+          def update(group_id, params)
+            parsed, options = OpenAI::Admin::Organization::GroupUpdateParams.dump_request(params)
+            @client.request(
+              method: :post,
+              path: ["organization/groups/%1$s", group_id],
+              body: parsed,
+              model: OpenAI::Models::Admin::Organization::GroupUpdateResponse,
+              security: {admin_api_key_auth: true},
+              options: options
+            )
+          end
+
+          # Some parameter documentations has been truncated, see
+          # {OpenAI::Models::Admin::Organization::GroupListParams} for more details.
+          #
+          # Lists all groups in the organization.
+          #
+          # @overload list(after: nil, limit: nil, order: nil, request_options: {})
+          #
+          # @param after [String] A cursor for use in pagination. `after` is a group ID that defines your place in
+          #
+          # @param limit [Integer] A limit on the number of groups to be returned. Limit can range between 0 and 10
+          #
+          # @param order [Symbol, OpenAI::Models::Admin::Organization::GroupListParams::Order] Specifies the sort order of the returned groups.
+          #
+          # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [OpenAI::Internal::NextCursorPage<OpenAI::Models::Admin::Organization::Group>]
+          #
+          # @see OpenAI::Models::Admin::Organization::GroupListParams
+          def list(params = {})
+            parsed, options = OpenAI::Admin::Organization::GroupListParams.dump_request(params)
+            query = OpenAI::Internal::Util.encode_query_params(parsed)
+            @client.request(
+              method: :get,
+              path: "organization/groups",
+              query: query,
+              page: OpenAI::Internal::NextCursorPage,
+              model: OpenAI::Admin::Organization::Group,
+              security: {admin_api_key_auth: true},
+              options: options
+            )
+          end
+
+          # Deletes a group from the organization.
+          #
+          # @overload delete(group_id, request_options: {})
+          #
+          # @param group_id [String] The ID of the group to delete.
+          #
+          # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [OpenAI::Models::Admin::Organization::GroupDeleteResponse]
+          #
+          # @see OpenAI::Models::Admin::Organization::GroupDeleteParams
+          def delete(group_id, params = {})
+            @client.request(
+              method: :delete,
+              path: ["organization/groups/%1$s", group_id],
+              model: OpenAI::Models::Admin::Organization::GroupDeleteResponse,
+              security: {admin_api_key_auth: true},
+              options: params[:request_options]
+            )
+          end
+
+          # @api private
+          #
+          # @param client [OpenAI::Client]
+          def initialize(client:)
+            @client = client
+            @users = OpenAI::Resources::Admin::Organization::Groups::Users.new(client: client)
+            @roles = OpenAI::Resources::Admin::Organization::Groups::Roles.new(client: client)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openai/resources/admin/organization/invites.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Resources
+    class Admin
+      class Organization
+        class Invites
+          # Some parameter documentations has been truncated, see
+          # {OpenAI::Models::Admin::Organization::InviteCreateParams} for more details.
+          #
+          # Create an invite for a user to the organization. The invite must be accepted by
+          # the user before they have access to the organization.
+          #
+          # @overload create(email:, role:, projects: nil, request_options: {})
+          #
+          # @param email [String] Send an email to this address
+          #
+          # @param role [Symbol, OpenAI::Models::Admin::Organization::InviteCreateParams::Role] `owner` or `reader`
+          #
+          # @param projects [Array<OpenAI::Models::Admin::Organization::InviteCreateParams::Project>] An array of projects to which membership is granted at the same time the org inv
+          #
+          # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [OpenAI::Models::Admin::Organization::Invite]
+          #
+          # @see OpenAI::Models::Admin::Organization::InviteCreateParams
+          def create(params)
+            parsed, options = OpenAI::Admin::Organization::InviteCreateParams.dump_request(params)
+            @client.request(
+              method: :post,
+              path: "organization/invites",
+              body: parsed,
+              model: OpenAI::Admin::Organization::Invite,
+              security: {admin_api_key_auth: true},
+              options: options
+            )
+          end
+
+          # Retrieves an invite.
+          #
+          # @overload retrieve(invite_id, request_options: {})
+          #
+          # @param invite_id [String] The ID of the invite to retrieve.
+          #
+          # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [OpenAI::Models::Admin::Organization::Invite]
+          #
+          # @see OpenAI::Models::Admin::Organization::InviteRetrieveParams
+          def retrieve(invite_id, params = {})
+            @client.request(
+              method: :get,
+              path: ["organization/invites/%1$s", invite_id],
+              model: OpenAI::Admin::Organization::Invite,
+              security: {admin_api_key_auth: true},
+              options: params[:request_options]
+            )
+          end
+
+          # Some parameter documentations has been truncated, see
+          # {OpenAI::Models::Admin::Organization::InviteListParams} for more details.
+          #
+          # Returns a list of invites in the organization.
+          #
+          # @overload list(after: nil, limit: nil, request_options: {})
+          #
+          # @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::Invite>]
+          #
+          # @see OpenAI::Models::Admin::Organization::InviteListParams
+          def list(params = {})
+            parsed, options = OpenAI::Admin::Organization::InviteListParams.dump_request(params)
+            query = OpenAI::Internal::Util.encode_query_params(parsed)
+            @client.request(
+              method: :get,
+              path: "organization/invites",
+              query: query,
+              page: OpenAI::Internal::ConversationCursorPage,
+              model: OpenAI::Admin::Organization::Invite,
+              security: {admin_api_key_auth: true},
+              options: options
+            )
+          end
+
+          # Delete an invite. If the invite has already been accepted, it cannot be deleted.
+          #
+          # @overload delete(invite_id, request_options: {})
+          #
+          # @param invite_id [String] The ID of the invite to delete.
+          #
+          # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [OpenAI::Models::Admin::Organization::InviteDeleteResponse]
+          #
+          # @see OpenAI::Models::Admin::Organization::InviteDeleteParams
+          def delete(invite_id, params = {})
+            @client.request(
+              method: :delete,
+              path: ["organization/invites/%1$s", invite_id],
+              model: OpenAI::Models::Admin::Organization::InviteDeleteResponse,
+              security: {admin_api_key_auth: true},
+              options: params[:request_options]
+            )
+          end
+
+          # @api private
+          #
+          # @param client [OpenAI::Client]
+          def initialize(client:)
+            @client = client
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Resources
+    class Admin
+      class Organization
+        class Projects
+          class APIKeys
+            # Retrieves an API key in the project.
+            #
+            # @overload retrieve(api_key_id, project_id:, request_options: {})
+            #
+            # @param api_key_id [String] The ID of the API key.
+            #
+            # @param project_id [String] The ID of the project.
+            #
+            # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+            #
+            # @return [OpenAI::Models::Admin::Organization::Projects::ProjectAPIKey]
+            #
+            # @see OpenAI::Models::Admin::Organization::Projects::APIKeyRetrieveParams
+            def retrieve(api_key_id, params)
+              parsed, options = OpenAI::Admin::Organization::Projects::APIKeyRetrieveParams.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/api_keys/%2$s", project_id, api_key_id],
+                model: OpenAI::Admin::Organization::Projects::ProjectAPIKey,
+                security: {admin_api_key_auth: true},
+                options: options
+              )
+            end
+
+            # Some parameter documentations has been truncated, see
+            # {OpenAI::Models::Admin::Organization::Projects::APIKeyListParams} for more
+            # details.
+            #
+            # Returns a list of API keys 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::ProjectAPIKey>]
+            #
+            # @see OpenAI::Models::Admin::Organization::Projects::APIKeyListParams
+            def list(project_id, params = {})
+              parsed, options = OpenAI::Admin::Organization::Projects::APIKeyListParams.dump_request(params)
+              query = OpenAI::Internal::Util.encode_query_params(parsed)
+              @client.request(
+                method: :get,
+                path: ["organization/projects/%1$s/api_keys", project_id],
+                query: query,
+                page: OpenAI::Internal::ConversationCursorPage,
+                model: OpenAI::Admin::Organization::Projects::ProjectAPIKey,
+                security: {admin_api_key_auth: true},
+                options: options
+              )
+            end
+
+            # Deletes an API key from the project.
+            #
+            # Returns confirmation of the key deletion, or an error if the key belonged to a
+            # service account.
+            #
+            # @overload delete(api_key_id, project_id:, request_options: {})
+            #
+            # @param api_key_id [String] The ID of the API key.
+            #
+            # @param project_id [String] The ID of the project.
+            #
+            # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+            #
+            # @return [OpenAI::Models::Admin::Organization::Projects::APIKeyDeleteResponse]
+            #
+            # @see OpenAI::Models::Admin::Organization::Projects::APIKeyDeleteParams
+            def delete(api_key_id, params)
+              parsed, options = OpenAI::Admin::Organization::Projects::APIKeyDeleteParams.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/api_keys/%2$s", project_id, api_key_id],
+                model: OpenAI::Models::Admin::Organization::Projects::APIKeyDeleteResponse,
+                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/certificates.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Resources
+    class Admin
+      class Organization
+        class Projects
+          class Certificates
+            # Some parameter documentations has been truncated, see
+            # {OpenAI::Models::Admin::Organization::Projects::CertificateListParams} for more
+            # details.
+            #
+            # List certificates for this project.
+            #
+            # @overload list(project_id, after: nil, limit: nil, order: 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 order [Symbol, OpenAI::Models::Admin::Organization::Projects::CertificateListParams::Order] Sort order by the `created_at` timestamp of the objects. `asc` for ascending ord
+            #
+            # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+            #
+            # @return [OpenAI::Internal::ConversationCursorPage<OpenAI::Models::Admin::Organization::Projects::CertificateListResponse>]
+            #
+            # @see OpenAI::Models::Admin::Organization::Projects::CertificateListParams
+            def list(project_id, params = {})
+              parsed, options = OpenAI::Admin::Organization::Projects::CertificateListParams.dump_request(params)
+              query = OpenAI::Internal::Util.encode_query_params(parsed)
+              @client.request(
+                method: :get,
+                path: ["organization/projects/%1$s/certificates", project_id],
+                query: query,
+                page: OpenAI::Internal::ConversationCursorPage,
+                model: OpenAI::Models::Admin::Organization::Projects::CertificateListResponse,
+                security: {admin_api_key_auth: true},
+                options: options
+              )
+            end
+
+            # Activate certificates at the project level.
+            #
+            # You can atomically and idempotently activate up to 10 certificates at a time.
+            #
+            # @overload activate(project_id, certificate_ids:, request_options: {})
+            #
+            # @param project_id [String] The ID of the project.
+            #
+            # @param certificate_ids [Array<String>]
+            #
+            # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+            #
+            # @return [OpenAI::Internal::Page<OpenAI::Models::Admin::Organization::Projects::CertificateActivateResponse>]
+            #
+            # @see OpenAI::Models::Admin::Organization::Projects::CertificateActivateParams
+            def activate(project_id, params)
+              parsed, options = OpenAI::Admin::Organization::Projects::CertificateActivateParams.dump_request(params)
+              @client.request(
+                method: :post,
+                path: ["organization/projects/%1$s/certificates/activate", project_id],
+                body: parsed,
+                page: OpenAI::Internal::Page,
+                model: OpenAI::Models::Admin::Organization::Projects::CertificateActivateResponse,
+                security: {admin_api_key_auth: true},
+                options: options
+              )
+            end
+
+            # Deactivate certificates at the project level. You can atomically and
+            # idempotently deactivate up to 10 certificates at a time.
+            #
+            # @overload deactivate(project_id, certificate_ids:, request_options: {})
+            #
+            # @param project_id [String] The ID of the project.
+            #
+            # @param certificate_ids [Array<String>]
+            #
+            # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+            #
+            # @return [OpenAI::Internal::Page<OpenAI::Models::Admin::Organization::Projects::CertificateDeactivateResponse>]
+            #
+            # @see OpenAI::Models::Admin::Organization::Projects::CertificateDeactivateParams
+            def deactivate(project_id, params)
+              parsed, options = OpenAI::Admin::Organization::Projects::CertificateDeactivateParams.dump_request(params)
+              @client.request(
+                method: :post,
+                path: ["organization/projects/%1$s/certificates/deactivate", project_id],
+                body: parsed,
+                page: OpenAI::Internal::Page,
+                model: OpenAI::Models::Admin::Organization::Projects::CertificateDeactivateResponse,
+                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/groups/roles.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Resources
+    class Admin
+      class Organization
+        class Projects
+          class Groups
+            class Roles
+              # Assigns a project role to a group within a project.
+              #
+              # @overload create(group_id, project_id:, role_id:, request_options: {})
+              #
+              # @param group_id [String] Path param: The ID of the group 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::Groups::RoleCreateResponse]
+              #
+              # @see OpenAI::Models::Admin::Organization::Projects::Groups::RoleCreateParams
+              def create(group_id, params)
+                parsed, options = OpenAI::Admin::Organization::Projects::Groups::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/groups/%2$s/roles", project_id, group_id],
+                  body: parsed,
+                  model: OpenAI::Models::Admin::Organization::Projects::Groups::RoleCreateResponse,
+                  security: {admin_api_key_auth: true},
+                  options: options
+                )
+              end
+
+              # Some parameter documentations has been truncated, see
+              # {OpenAI::Models::Admin::Organization::Projects::Groups::RoleListParams} for more
+              # details.
+              #
+              # Lists the project roles assigned to a group within a project.
+              #
+              # @overload list(group_id, project_id:, after: nil, limit: nil, order: nil, request_options: {})
+              #
+              # @param group_id [String] Path param: The ID of the group 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::Groups::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::Groups::RoleListResponse>]
+              #
+              # @see OpenAI::Models::Admin::Organization::Projects::Groups::RoleListParams
+              def list(group_id, params)
+                parsed, options = OpenAI::Admin::Organization::Projects::Groups::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/groups/%2$s/roles", project_id, group_id],
+                  query: query,
+                  page: OpenAI::Internal::NextCursorPage,
+                  model: OpenAI::Models::Admin::Organization::Projects::Groups::RoleListResponse,
+                  security: {admin_api_key_auth: true},
+                  options: options
+                )
+              end
+
+              # Unassigns a project role from a group within a project.
+              #
+              # @overload delete(role_id, project_id:, group_id:, request_options: {})
+              #
+              # @param role_id [String] The ID of the project role to remove from the group.
+              #
+              # @param project_id [String] The ID of the project to modify.
+              #
+              # @param group_id [String] The ID of the group whose project role assignment should be removed.
+              #
+              # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+              #
+              # @return [OpenAI::Models::Admin::Organization::Projects::Groups::RoleDeleteResponse]
+              #
+              # @see OpenAI::Models::Admin::Organization::Projects::Groups::RoleDeleteParams
+              def delete(role_id, params)
+                parsed, options = OpenAI::Admin::Organization::Projects::Groups::RoleDeleteParams.dump_request(params)
+                project_id =
+                  parsed.delete(:project_id) do
+                    raise ArgumentError.new("missing required path argument #{_1}")
+                  end
+                group_id =
+                  parsed.delete(:group_id) do
+                    raise ArgumentError.new("missing required path argument #{_1}")
+                  end
+                @client.request(
+                  method: :delete,
+                  path: ["projects/%1$s/groups/%2$s/roles/%3$s", project_id, group_id, role_id],
+                  model: OpenAI::Models::Admin::Organization::Projects::Groups::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