openai 0.59.0 → 0.61.0

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

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Resources
+    class Admin
+      class Organization
+        class AdminAPIKeys
+          # Create an organization admin API key
+          #
+          # @overload create(name:, request_options: {})
+          #
+          # @param name [String]
+          # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [OpenAI::Models::Admin::Organization::AdminAPIKeyCreateResponse]
+          #
+          # @see OpenAI::Models::Admin::Organization::AdminAPIKeyCreateParams
+          def create(params)
+            parsed, options = OpenAI::Admin::Organization::AdminAPIKeyCreateParams.dump_request(params)
+            @client.request(
+              method: :post,
+              path: "organization/admin_api_keys",
+              body: parsed,
+              model: OpenAI::Models::Admin::Organization::AdminAPIKeyCreateResponse,
+              security: {admin_api_key_auth: true},
+              options: options
+            )
+          end
+
+          # Retrieve a single organization API key
+          #
+          # @overload retrieve(key_id, request_options: {})
+          #
+          # @param key_id [String] The ID of the API key.
+          #
+          # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [OpenAI::Models::Admin::Organization::AdminAPIKey]
+          #
+          # @see OpenAI::Models::Admin::Organization::AdminAPIKeyRetrieveParams
+          def retrieve(key_id, params = {})
+            @client.request(
+              method: :get,
+              path: ["organization/admin_api_keys/%1$s", key_id],
+              model: OpenAI::Admin::Organization::AdminAPIKey,
+              security: {admin_api_key_auth: true},
+              options: params[:request_options]
+            )
+          end
+
+          # List organization API keys
+          #
+          # @overload list(after: nil, limit: nil, order: nil, request_options: {})
+          #
+          # @param after [String, nil] Return keys with IDs that come after this ID in the pagination order.
+          #
+          # @param limit [Integer] Maximum number of keys to return.
+          #
+          # @param order [Symbol, OpenAI::Models::Admin::Organization::AdminAPIKeyListParams::Order] Order results by creation time, ascending or descending.
+          #
+          # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [OpenAI::Internal::CursorPage<OpenAI::Models::Admin::Organization::AdminAPIKey>]
+          #
+          # @see OpenAI::Models::Admin::Organization::AdminAPIKeyListParams
+          def list(params = {})
+            parsed, options = OpenAI::Admin::Organization::AdminAPIKeyListParams.dump_request(params)
+            query = OpenAI::Internal::Util.encode_query_params(parsed)
+            @client.request(
+              method: :get,
+              path: "organization/admin_api_keys",
+              query: query,
+              page: OpenAI::Internal::CursorPage,
+              model: OpenAI::Admin::Organization::AdminAPIKey,
+              security: {admin_api_key_auth: true},
+              options: options
+            )
+          end
+
+          # Delete an organization admin API key
+          #
+          # @overload delete(key_id, request_options: {})
+          #
+          # @param key_id [String] The ID of the API key to be deleted.
+          #
+          # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [OpenAI::Models::Admin::Organization::AdminAPIKeyDeleteResponse]
+          #
+          # @see OpenAI::Models::Admin::Organization::AdminAPIKeyDeleteParams
+          def delete(key_id, params = {})
+            @client.request(
+              method: :delete,
+              path: ["organization/admin_api_keys/%1$s", key_id],
+              model: OpenAI::Models::Admin::Organization::AdminAPIKeyDeleteResponse,
+              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/audit_logs.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Resources
+    class Admin
+      class Organization
+        # List user actions and configuration changes within this organization.
+        class AuditLogs
+          # Some parameter documentations has been truncated, see
+          # {OpenAI::Models::Admin::Organization::AuditLogListParams} for more details.
+          #
+          # List user actions and configuration changes within this organization.
+          #
+          # @overload list(actor_emails: nil, actor_ids: nil, after: nil, before: nil, effective_at: nil, event_types: nil, limit: nil, project_ids: nil, resource_ids: nil, request_options: {})
+          #
+          # @param actor_emails [Array<String>] Return only events performed by users with these emails.
+          #
+          # @param actor_ids [Array<String>] Return only events performed by these actors. Can be a user ID, a service accoun
+          #
+          # @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 effective_at [OpenAI::Models::Admin::Organization::AuditLogListParams::EffectiveAt] Return only events whose `effective_at` (Unix seconds) is in this range.
+          #
+          # @param event_types [Array<Symbol, OpenAI::Models::Admin::Organization::AuditLogListParams::EventType>] Return only events with a `type` in one of these values. For example, `project.c
+          #
+          # @param limit [Integer] A limit on the number of objects to be returned. Limit can range between 1 and 1
+          #
+          # @param project_ids [Array<String>] Return only events for these projects.
+          #
+          # @param resource_ids [Array<String>] Return only events performed on these targets. For example, a project ID updated
+          #
+          # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [OpenAI::Internal::ConversationCursorPage<OpenAI::Models::Admin::Organization::AuditLogListResponse>]
+          #
+          # @see OpenAI::Models::Admin::Organization::AuditLogListParams
+          def list(params = {})
+            parsed, options = OpenAI::Admin::Organization::AuditLogListParams.dump_request(params)
+            query = OpenAI::Internal::Util.encode_query_params(parsed)
+            @client.request(
+              method: :get,
+              path: "organization/audit_logs",
+              query: query,
+              page: OpenAI::Internal::ConversationCursorPage,
+              model: OpenAI::Models::Admin::Organization::AuditLogListResponse,
+              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

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

@@ -0,0 +1,208 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Resources
+    class Admin
+      class Organization
+        class Certificates
+          # Upload a certificate to the organization. This does **not** automatically
+          # activate the certificate.
+          #
+          # Organizations can upload up to 50 certificates.
+          #
+          # @overload create(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}, nil]
+          #
+          # @return [OpenAI::Models::Admin::Organization::Certificate]
+          #
+          # @see OpenAI::Models::Admin::Organization::CertificateCreateParams
+          def create(params)
+            parsed, options = OpenAI::Admin::Organization::CertificateCreateParams.dump_request(params)
+            @client.request(
+              method: :post,
+              path: "organization/certificates",
+              body: parsed,
+              model: OpenAI::Admin::Organization::Certificate,
+              security: {admin_api_key_auth: true},
+              options: options
+            )
+          end
+
+          # Some parameter documentations has been truncated, see
+          # {OpenAI::Models::Admin::Organization::CertificateRetrieveParams} for more
+          # details.
+          #
+          # Get a certificate that has been uploaded to the organization.
+          #
+          # You can get a certificate regardless of whether it is active or not.
+          #
+          # @overload retrieve(certificate_id, include: nil, request_options: {})
+          #
+          # @param certificate_id [String] Unique ID of the certificate to retrieve.
+          #
+          # @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}, nil]
+          #
+          # @return [OpenAI::Models::Admin::Organization::Certificate]
+          #
+          # @see OpenAI::Models::Admin::Organization::CertificateRetrieveParams
+          def retrieve(certificate_id, params = {})
+            parsed, options = OpenAI::Admin::Organization::CertificateRetrieveParams.dump_request(params)
+            query = OpenAI::Internal::Util.encode_query_params(parsed)
+            @client.request(
+              method: :get,
+              path: ["organization/certificates/%1$s", certificate_id],
+              query: query,
+              model: OpenAI::Admin::Organization::Certificate,
+              security: {admin_api_key_auth: true},
+              options: options
+            )
+          end
+
+          # Modify a certificate. Note that only the name can be modified.
+          #
+          # @overload update(certificate_id, name: nil, request_options: {})
+          #
+          # @param certificate_id [String] Unique ID of the certificate to modify.
+          #
+          # @param name [String] The updated name for the certificate
+          #
+          # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [OpenAI::Models::Admin::Organization::Certificate]
+          #
+          # @see OpenAI::Models::Admin::Organization::CertificateUpdateParams
+          def update(certificate_id, params = {})
+            parsed, options = OpenAI::Admin::Organization::CertificateUpdateParams.dump_request(params)
+            @client.request(
+              method: :post,
+              path: ["organization/certificates/%1$s", certificate_id],
+              body: parsed,
+              model: OpenAI::Admin::Organization::Certificate,
+              security: {admin_api_key_auth: true},
+              options: options
+            )
+          end
+
+          # Some parameter documentations has been truncated, see
+          # {OpenAI::Models::Admin::Organization::CertificateListParams} for more details.
+          #
+          # List uploaded certificates for this organization.
+          #
+          # @overload list(after: nil, limit: nil, order: 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 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}, nil]
+          #
+          # @return [OpenAI::Internal::ConversationCursorPage<OpenAI::Models::Admin::Organization::CertificateListResponse>]
+          #
+          # @see OpenAI::Models::Admin::Organization::CertificateListParams
+          def list(params = {})
+            parsed, options = OpenAI::Admin::Organization::CertificateListParams.dump_request(params)
+            query = OpenAI::Internal::Util.encode_query_params(parsed)
+            @client.request(
+              method: :get,
+              path: "organization/certificates",
+              query: query,
+              page: OpenAI::Internal::ConversationCursorPage,
+              model: OpenAI::Models::Admin::Organization::CertificateListResponse,
+              security: {admin_api_key_auth: true},
+              options: options
+            )
+          end
+
+          # Delete a certificate from the organization.
+          #
+          # The certificate must be inactive for the organization and all projects.
+          #
+          # @overload delete(certificate_id, request_options: {})
+          #
+          # @param certificate_id [String] Unique ID of the certificate to delete.
+          #
+          # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [OpenAI::Models::Admin::Organization::CertificateDeleteResponse]
+          #
+          # @see OpenAI::Models::Admin::Organization::CertificateDeleteParams
+          def delete(certificate_id, params = {})
+            @client.request(
+              method: :delete,
+              path: ["organization/certificates/%1$s", certificate_id],
+              model: OpenAI::Models::Admin::Organization::CertificateDeleteResponse,
+              security: {admin_api_key_auth: true},
+              options: params[:request_options]
+            )
+          end
+
+          # Activate certificates at the organization level.
+          #
+          # You can atomically and idempotently activate up to 10 certificates at a time.
+          #
+          # @overload activate(certificate_ids:, request_options: {})
+          #
+          # @param certificate_ids [Array<String>]
+          # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [OpenAI::Internal::Page<OpenAI::Models::Admin::Organization::CertificateActivateResponse>]
+          #
+          # @see OpenAI::Models::Admin::Organization::CertificateActivateParams
+          def activate(params)
+            parsed, options = OpenAI::Admin::Organization::CertificateActivateParams.dump_request(params)
+            @client.request(
+              method: :post,
+              path: "organization/certificates/activate",
+              body: parsed,
+              page: OpenAI::Internal::Page,
+              model: OpenAI::Models::Admin::Organization::CertificateActivateResponse,
+              security: {admin_api_key_auth: true},
+              options: options
+            )
+          end
+
+          # Deactivate certificates at the organization level.
+          #
+          # You can atomically and idempotently deactivate up to 10 certificates at a time.
+          #
+          # @overload deactivate(certificate_ids:, request_options: {})
+          #
+          # @param certificate_ids [Array<String>]
+          # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [OpenAI::Internal::Page<OpenAI::Models::Admin::Organization::CertificateDeactivateResponse>]
+          #
+          # @see OpenAI::Models::Admin::Organization::CertificateDeactivateParams
+          def deactivate(params)
+            parsed, options = OpenAI::Admin::Organization::CertificateDeactivateParams.dump_request(params)
+            @client.request(
+              method: :post,
+              path: "organization/certificates/deactivate",
+              body: parsed,
+              page: OpenAI::Internal::Page,
+              model: OpenAI::Models::Admin::Organization::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

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

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

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

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Resources
+    class Admin
+      class Organization
+        class Groups
+          class Users
+            # Adds a user to a group.
+            #
+            # @overload create(group_id, user_id:, request_options: {})
+            #
+            # @param group_id [String] The ID of the group to update.
+            #
+            # @param user_id [String] Identifier of the user to add to the group.
+            #
+            # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+            #
+            # @return [OpenAI::Models::Admin::Organization::Groups::UserCreateResponse]
+            #
+            # @see OpenAI::Models::Admin::Organization::Groups::UserCreateParams
+            def create(group_id, params)
+              parsed, options = OpenAI::Admin::Organization::Groups::UserCreateParams.dump_request(params)
+              @client.request(
+                method: :post,
+                path: ["organization/groups/%1$s/users", group_id],
+                body: parsed,
+                model: OpenAI::Models::Admin::Organization::Groups::UserCreateResponse,
+                security: {admin_api_key_auth: true},
+                options: options
+              )
+            end
+
+            # Some parameter documentations has been truncated, see
+            # {OpenAI::Models::Admin::Organization::Groups::UserListParams} for more details.
+            #
+            # Lists the users assigned to a group.
+            #
+            # @overload list(group_id, after: nil, limit: nil, order: nil, request_options: {})
+            #
+            # @param group_id [String] The ID of the group to inspect.
+            #
+            # @param after [String] A cursor for use in pagination. Provide the ID of the last user from the previou
+            #
+            # @param limit [Integer] A limit on the number of users to be returned. Limit can range between 0 and 100
+            #
+            # @param order [Symbol, OpenAI::Models::Admin::Organization::Groups::UserListParams::Order] Specifies the sort order of users in the list.
+            #
+            # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+            #
+            # @return [OpenAI::Internal::NextCursorPage<OpenAI::Models::Admin::Organization::Groups::OrganizationGroupUser>]
+            #
+            # @see OpenAI::Models::Admin::Organization::Groups::UserListParams
+            def list(group_id, params = {})
+              parsed, options = OpenAI::Admin::Organization::Groups::UserListParams.dump_request(params)
+              query = OpenAI::Internal::Util.encode_query_params(parsed)
+              @client.request(
+                method: :get,
+                path: ["organization/groups/%1$s/users", group_id],
+                query: query,
+                page: OpenAI::Internal::NextCursorPage,
+                model: OpenAI::Admin::Organization::Groups::OrganizationGroupUser,
+                security: {admin_api_key_auth: true},
+                options: options
+              )
+            end
+
+            # Removes a user from a group.
+            #
+            # @overload delete(user_id, group_id:, request_options: {})
+            #
+            # @param user_id [String] The ID of the user to remove from the group.
+            #
+            # @param group_id [String] The ID of the group to update.
+            #
+            # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+            #
+            # @return [OpenAI::Models::Admin::Organization::Groups::UserDeleteResponse]
+            #
+            # @see OpenAI::Models::Admin::Organization::Groups::UserDeleteParams
+            def delete(user_id, params)
+              parsed, options = OpenAI::Admin::Organization::Groups::UserDeleteParams.dump_request(params)
+              group_id =
+                parsed.delete(:group_id) do
+                  raise ArgumentError.new("missing required path argument #{_1}")
+                end
+              @client.request(
+                method: :delete,
+                path: ["organization/groups/%1$s/users/%2$s", group_id, user_id],
+                model: OpenAI::Models::Admin::Organization::Groups::UserDeleteResponse,
+                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