anthropic 2.3.0 → 2.4.0

data/lib/anthropic/resources/organization/analytics.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Resources
+    class Organization
+      class Analytics
+        # @return [Anthropic::Resources::Organization::Analytics::Summaries]
+        attr_reader :summaries
+
+        # @return [Anthropic::Resources::Organization::Analytics::Users]
+        attr_reader :users
+
+        # @return [Anthropic::Resources::Organization::Analytics::Apps]
+        attr_reader :apps
+
+        # @return [Anthropic::Resources::Organization::Analytics::Connectors]
+        attr_reader :connectors
+
+        # @return [Anthropic::Resources::Organization::Analytics::Plugins]
+        attr_reader :plugins
+
+        # @return [Anthropic::Resources::Organization::Analytics::Skills]
+        attr_reader :skills
+
+        # @return [Anthropic::Resources::Organization::Analytics::Artifacts]
+        attr_reader :artifacts
+
+        # @api private
+        #
+        # @param client [Anthropic::Client]
+        def initialize(client:)
+          @client = client
+          @summaries = Anthropic::Resources::Organization::Analytics::Summaries.new(client: client)
+          @users = Anthropic::Resources::Organization::Analytics::Users.new(client: client)
+          @apps = Anthropic::Resources::Organization::Analytics::Apps.new(client: client)
+          @connectors = Anthropic::Resources::Organization::Analytics::Connectors.new(client: client)
+          @plugins = Anthropic::Resources::Organization::Analytics::Plugins.new(client: client)
+          @skills = Anthropic::Resources::Organization::Analytics::Skills.new(client: client)
+          @artifacts = Anthropic::Resources::Organization::Analytics::Artifacts.new(client: client)
+        end
+      end
+    end
+  end
+end

data/lib/anthropic/resources/organization/compliance_settings.rb

@@ -32,8 +32,11 @@ module Anthropic
         # Update your organization's Compliance Settings.
         #
         # Setting `state` to `enabled` turns on the Compliance API and begins capturing
-        # organization activity events. Setting it to `disabled` turns both off. `state`
-        # reflects whether the Compliance API is enabled.
+        # organization activity events. Setting it to `disabled` turns both off. Access
+        # Transparency events are an exception: they are still captured while the
+        # Compliance API is disabled, and the Compliance API activity feed returns them
+        # once it is enabled again. `state` reflects whether the Compliance API is
+        # enabled.
         #
         # A request that sets `state` to its current value succeeds and leaves the
         # resource unchanged. A `disabled` request stays in effect until a later `enabled`

data/lib/anthropic/resources/organization/external_keys.rb

@@ -6,7 +6,10 @@ module Anthropic
       class ExternalKeys
         # Create an external key config owned by the caller's organization.
         #
-        # @overload create(provider_config:, display_name: nil, geo: nil, request_options: {})
+        # Some parameter documentations has been truncated, see
+        # {Anthropic::Models::Organization::ExternalKeyCreateParams} for more details.
+        #
+        # @overload create(provider_config:, display_name: nil, geo: nil, user_profile_id: nil, request_options: {})
         #
         # @param provider_config [Anthropic::Models::Organization::AWSExternalKeyConfig, Anthropic::Models::Organization::GCPExternalKeyConfig, Anthropic::Models::Organization::AzureExternalKeyConfigParam] KMS provider identity and auth coordinates.
         #
@@ -14,6 +17,8 @@ module Anthropic
         #
         # @param geo [Symbol, Anthropic::Models::Organization::ExternalKeyCreateParams::Geo] Data residency geo. Only `us` is supported.
         #
+        # @param user_profile_id [String, nil] ID of a user profile to bind the key to. Omit this field for a key that isn't bo
+        #
         # @param request_options [Anthropic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Anthropic::Models::Organization::ExternalKey]

data/lib/anthropic/resources/organization/rbac_groups/members.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Resources
+    class Organization
+      class RBACGroups
+        class Members
+          # List members of an RBAC Group.
+          #
+          # The RBAC Groups API is available to Claude Enterprise organizations only.
+          #
+          # Some parameter documentations has been truncated, see
+          # {Anthropic::Models::Organization::RBACGroups::MemberListParams} for more
+          # details.
+          #
+          # @overload list(rbac_group_id, limit: nil, page: nil, request_options: {})
+          #
+          # @param rbac_group_id [String] ID of the RBAC Group.
+          #
+          # @param limit [Integer] Number of items to return per page.
+          #
+          # @param page [String, nil] Optionally set to the `next_page` token from the previous response.
+          #
+          # @param request_options [Anthropic::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [Anthropic::Internal::PageCursor<Anthropic::Models::Organization::RBACGroups::RBACGroupMember>]
+          #
+          # @see Anthropic::Models::Organization::RBACGroups::MemberListParams
+          def list(rbac_group_id, params = {})
+            parsed, options = Anthropic::Organization::RBACGroups::MemberListParams.dump_request(params)
+            query = Anthropic::Internal::Util.encode_query_params(parsed)
+            @client.request(
+              span_name: Anthropic::Internal::Tracing::SpanName::ORGANIZATION_RBAC_GROUPS_MEMBERS_LIST,
+              span_attributes: {"anthropic.organization.rbac_group.id" => rbac_group_id},
+              span_route: "/v1/organizations/rbac_groups/{rbac_group_id}/members",
+              span_query: %w[limit page],
+              method: :get,
+              path: ["v1/organizations/rbac_groups/%1$s/members", rbac_group_id],
+              query: query,
+              page: Anthropic::Internal::PageCursor,
+              model: Anthropic::Organization::RBACGroups::RBACGroupMember,
+              options: options
+            )
+          end
+
+          # Add a User to an RBAC Group. Membership of groups provisioned by an identity
+          # provider (source type `"scim"`) cannot be modified via the API while an
+          # organization in the tenant uses SCIM provisioning.
+          #
+          # The RBAC Groups API is available to Claude Enterprise organizations only.
+          #
+          # @overload add(rbac_group_id, user_id:, request_options: {})
+          #
+          # @param rbac_group_id [String] ID of the RBAC Group.
+          #
+          # @param user_id [String] ID of the User.
+          #
+          # @param request_options [Anthropic::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [Anthropic::Models::Organization::RBACGroups::RBACGroupMember]
+          #
+          # @see Anthropic::Models::Organization::RBACGroups::MemberAddParams
+          def add(rbac_group_id, params)
+            parsed, options = Anthropic::Organization::RBACGroups::MemberAddParams.dump_request(params)
+            @client.request(
+              span_name: Anthropic::Internal::Tracing::SpanName::ORGANIZATION_RBAC_GROUPS_MEMBERS_ADD,
+              span_attributes: {"anthropic.organization.rbac_group.id" => rbac_group_id},
+              span_created_id: {"anthropic.organization.rbac_group.member.id" => :user_id},
+              span_route: "/v1/organizations/rbac_groups/{rbac_group_id}/members",
+              method: :post,
+              path: ["v1/organizations/rbac_groups/%1$s/members", rbac_group_id],
+              body: parsed,
+              model: Anthropic::Organization::RBACGroups::RBACGroupMember,
+              options: options
+            )
+          end
+
+          # Remove a User from an RBAC Group. Membership of groups provisioned by an
+          # identity provider (source type `"scim"`) cannot be modified via the API while an
+          # organization in the tenant uses SCIM provisioning.
+          #
+          # The RBAC Groups API is available to Claude Enterprise organizations only.
+          #
+          # @overload remove(user_id, rbac_group_id:, request_options: {})
+          #
+          # @param user_id [String] ID of the User.
+          #
+          # @param rbac_group_id [String] ID of the RBAC Group.
+          #
+          # @param request_options [Anthropic::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [Anthropic::Models::Organization::RBACGroups::DeletedRBACGroupMember]
+          #
+          # @see Anthropic::Models::Organization::RBACGroups::MemberRemoveParams
+          def remove(user_id, params)
+            parsed, options = Anthropic::Organization::RBACGroups::MemberRemoveParams.dump_request(params)
+            rbac_group_id =
+              parsed.delete(:rbac_group_id) do
+                raise ArgumentError.new("missing required path argument #{_1}")
+              end
+            @client.request(
+              span_name: Anthropic::Internal::Tracing::SpanName::ORGANIZATION_RBAC_GROUPS_MEMBERS_REMOVE,
+              span_attributes: {
+                "anthropic.organization.rbac_group.id" => rbac_group_id,
+                "anthropic.organization.rbac_group.member.id" => user_id
+              },
+              span_route: "/v1/organizations/rbac_groups/{rbac_group_id}/members/{user_id}",
+              method: :delete,
+              path: ["v1/organizations/rbac_groups/%1$s/members/%2$s", rbac_group_id, user_id],
+              model: Anthropic::Organization::RBACGroups::DeletedRBACGroupMember,
+              options: options
+            )
+          end
+
+          # @api private
+          #
+          # @param client [Anthropic::Client]
+          def initialize(client:)
+            @client = client
+          end
+        end
+      end
+    end
+  end
+end

data/lib/anthropic/resources/organization/rbac_groups.rb

@@ -0,0 +1,165 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Resources
+    class Organization
+      class RBACGroups
+        # @return [Anthropic::Resources::Organization::RBACGroups::Members]
+        attr_reader :members
+
+        # Create an RBAC Group in the Claude Enterprise tenant. Groups created via the API
+        # have source type `"direct"`.
+        #
+        # The RBAC Groups API is available to Claude Enterprise organizations only.
+        #
+        # @overload create(name:, request_options: {})
+        #
+        # @param name [String] Name of the RBAC Group. Not uniqueness-enforced.
+        #
+        # @param request_options [Anthropic::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Anthropic::Models::Organization::RBACGroup]
+        #
+        # @see Anthropic::Models::Organization::RBACGroupCreateParams
+        def create(params)
+          parsed, options = Anthropic::Organization::RBACGroupCreateParams.dump_request(params)
+          @client.request(
+            span_name: Anthropic::Internal::Tracing::SpanName::ORGANIZATION_RBAC_GROUPS_CREATE,
+            span_created_id: "anthropic.organization.rbac_group.id",
+            span_route: "/v1/organizations/rbac_groups",
+            method: :post,
+            path: "v1/organizations/rbac_groups",
+            body: parsed,
+            model: Anthropic::Organization::RBACGroup,
+            options: options
+          )
+        end
+
+        # Retrieve an RBAC Group by ID.
+        #
+        # The RBAC Groups API is available to Claude Enterprise organizations only.
+        #
+        # @overload retrieve(rbac_group_id, request_options: {})
+        #
+        # @param rbac_group_id [String] ID of the RBAC Group.
+        #
+        # @param request_options [Anthropic::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Anthropic::Models::Organization::RBACGroup]
+        #
+        # @see Anthropic::Models::Organization::RBACGroupRetrieveParams
+        def retrieve(rbac_group_id, params = {})
+          @client.request(
+            span_name: Anthropic::Internal::Tracing::SpanName::ORGANIZATION_RBAC_GROUPS_RETRIEVE,
+            span_attributes: {"anthropic.organization.rbac_group.id" => rbac_group_id},
+            span_route: "/v1/organizations/rbac_groups/{rbac_group_id}",
+            method: :get,
+            path: ["v1/organizations/rbac_groups/%1$s", rbac_group_id],
+            model: Anthropic::Organization::RBACGroup,
+            options: params[:request_options]
+          )
+        end
+
+        # Update an RBAC Group's name. Groups provisioned by an identity provider (source
+        # type `"scim"`) cannot be modified via the API while an organization in the
+        # tenant uses SCIM provisioning.
+        #
+        # The RBAC Groups API is available to Claude Enterprise organizations only.
+        #
+        # @overload update(rbac_group_id, name: nil, request_options: {})
+        #
+        # @param rbac_group_id [String] ID of the RBAC Group.
+        #
+        # @param name [String, nil] Name of the RBAC Group. Not uniqueness-enforced.
+        #
+        # @param request_options [Anthropic::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Anthropic::Models::Organization::RBACGroup]
+        #
+        # @see Anthropic::Models::Organization::RBACGroupUpdateParams
+        def update(rbac_group_id, params = {})
+          parsed, options = Anthropic::Organization::RBACGroupUpdateParams.dump_request(params)
+          @client.request(
+            span_name: Anthropic::Internal::Tracing::SpanName::ORGANIZATION_RBAC_GROUPS_UPDATE,
+            span_attributes: {"anthropic.organization.rbac_group.id" => rbac_group_id},
+            span_route: "/v1/organizations/rbac_groups/{rbac_group_id}",
+            method: :post,
+            path: ["v1/organizations/rbac_groups/%1$s", rbac_group_id],
+            body: parsed,
+            model: Anthropic::Organization::RBACGroup,
+            options: options
+          )
+        end
+
+        # List RBAC Groups in the Claude Enterprise tenant.
+        #
+        # The RBAC Groups API is available to Claude Enterprise organizations only.
+        #
+        # Some parameter documentations has been truncated, see
+        # {Anthropic::Models::Organization::RBACGroupListParams} for more details.
+        #
+        # @overload list(limit: nil, page: nil, request_options: {})
+        #
+        # @param limit [Integer] Number of items to return per page.
+        #
+        # @param page [String, nil] Optionally set to the `next_page` token from the previous response.
+        #
+        # @param request_options [Anthropic::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Anthropic::Internal::PageCursor<Anthropic::Models::Organization::RBACGroup>]
+        #
+        # @see Anthropic::Models::Organization::RBACGroupListParams
+        def list(params = {})
+          parsed, options = Anthropic::Organization::RBACGroupListParams.dump_request(params)
+          query = Anthropic::Internal::Util.encode_query_params(parsed)
+          @client.request(
+            span_name: Anthropic::Internal::Tracing::SpanName::ORGANIZATION_RBAC_GROUPS_LIST,
+            span_route: "/v1/organizations/rbac_groups",
+            span_query: %w[limit page],
+            method: :get,
+            path: "v1/organizations/rbac_groups",
+            query: query,
+            page: Anthropic::Internal::PageCursor,
+            model: Anthropic::Organization::RBACGroup,
+            options: options
+          )
+        end
+
+        # Delete an RBAC Group. Groups provisioned by an identity provider (source type
+        # `"scim"`) cannot be deleted via the API while an organization in the tenant uses
+        # SCIM provisioning.
+        #
+        # The RBAC Groups API is available to Claude Enterprise organizations only.
+        #
+        # @overload delete(rbac_group_id, request_options: {})
+        #
+        # @param rbac_group_id [String] ID of the RBAC Group.
+        #
+        # @param request_options [Anthropic::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Anthropic::Models::Organization::DeletedRBACGroup]
+        #
+        # @see Anthropic::Models::Organization::RBACGroupDeleteParams
+        def delete(rbac_group_id, params = {})
+          @client.request(
+            span_name: Anthropic::Internal::Tracing::SpanName::ORGANIZATION_RBAC_GROUPS_DELETE,
+            span_attributes: {"anthropic.organization.rbac_group.id" => rbac_group_id},
+            span_route: "/v1/organizations/rbac_groups/{rbac_group_id}",
+            method: :delete,
+            path: ["v1/organizations/rbac_groups/%1$s", rbac_group_id],
+            model: Anthropic::Organization::DeletedRBACGroup,
+            options: params[:request_options]
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Anthropic::Client]
+        def initialize(client:)
+          @client = client
+          @members = Anthropic::Resources::Organization::RBACGroups::Members.new(client: client)
+        end
+      end
+    end
+  end
+end

data/lib/anthropic/resources/organization/rbac_roles/permissions.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Resources
+    class Organization
+      class RBACRoles
+        class Permissions
+          # List the permissions an RBAC Role grants.
+          #
+          # The RBAC Roles API is available to Claude Enterprise organizations only.
+          #
+          # Some parameter documentations has been truncated, see
+          # {Anthropic::Models::Organization::RBACRoles::PermissionListParams} for more
+          # details.
+          #
+          # @overload list(rbac_role_id, limit: nil, page: nil, request_options: {})
+          #
+          # @param rbac_role_id [String] ID of the RBAC Role.
+          #
+          # @param limit [Integer] Number of items to return per page.
+          #
+          # @param page [String, nil] Optionally set to the `next_page` token from the previous response.
+          #
+          # @param request_options [Anthropic::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [Anthropic::Internal::PageCursor<Anthropic::Models::Organization::RBACRoles::RBACRolePermission>]
+          #
+          # @see Anthropic::Models::Organization::RBACRoles::PermissionListParams
+          def list(rbac_role_id, params = {})
+            parsed, options = Anthropic::Organization::RBACRoles::PermissionListParams.dump_request(params)
+            query = Anthropic::Internal::Util.encode_query_params(parsed)
+            @client.request(
+              span_name: Anthropic::Internal::Tracing::SpanName::ORGANIZATION_RBAC_ROLES_PERMISSIONS_LIST,
+              span_attributes: {"anthropic.organization.rbac_role.id" => rbac_role_id},
+              span_route: "/v1/organizations/rbac_roles/{rbac_role_id}/permissions",
+              span_query: %w[limit page],
+              method: :get,
+              path: ["v1/organizations/rbac_roles/%1$s/permissions", rbac_role_id],
+              query: query,
+              page: Anthropic::Internal::PageCursor,
+              model: Anthropic::Organization::RBACRoles::RBACRolePermission,
+              options: options
+            )
+          end
+
+          # @api private
+          #
+          # @param client [Anthropic::Client]
+          def initialize(client:)
+            @client = client
+          end
+        end
+      end
+    end
+  end
+end

data/lib/anthropic/resources/organization/rbac_roles.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Resources
+    class Organization
+      class RBACRoles
+        # @return [Anthropic::Resources::Organization::RBACRoles::Permissions]
+        attr_reader :permissions
+
+        # Retrieve an RBAC Role by ID.
+        #
+        # The RBAC Roles API is available to Claude Enterprise organizations only.
+        #
+        # @overload retrieve(rbac_role_id, request_options: {})
+        #
+        # @param rbac_role_id [String] ID of the RBAC Role.
+        #
+        # @param request_options [Anthropic::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Anthropic::Models::Organization::RBACRole]
+        #
+        # @see Anthropic::Models::Organization::RBACRoleRetrieveParams
+        def retrieve(rbac_role_id, params = {})
+          @client.request(
+            span_name: Anthropic::Internal::Tracing::SpanName::ORGANIZATION_RBAC_ROLES_RETRIEVE,
+            span_attributes: {"anthropic.organization.rbac_role.id" => rbac_role_id},
+            span_route: "/v1/organizations/rbac_roles/{rbac_role_id}",
+            method: :get,
+            path: ["v1/organizations/rbac_roles/%1$s", rbac_role_id],
+            model: Anthropic::Organization::RBACRole,
+            options: params[:request_options]
+          )
+        end
+
+        # List RBAC Roles in the organization.
+        #
+        # The RBAC Roles API is available to Claude Enterprise organizations only.
+        #
+        # Some parameter documentations has been truncated, see
+        # {Anthropic::Models::Organization::RBACRoleListParams} for more details.
+        #
+        # @overload list(limit: nil, page: nil, request_options: {})
+        #
+        # @param limit [Integer] Number of items to return per page.
+        #
+        # @param page [String, nil] Optionally set to the `next_page` token from the previous response.
+        #
+        # @param request_options [Anthropic::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Anthropic::Internal::PageCursor<Anthropic::Models::Organization::RBACRole>]
+        #
+        # @see Anthropic::Models::Organization::RBACRoleListParams
+        def list(params = {})
+          parsed, options = Anthropic::Organization::RBACRoleListParams.dump_request(params)
+          query = Anthropic::Internal::Util.encode_query_params(parsed)
+          @client.request(
+            span_name: Anthropic::Internal::Tracing::SpanName::ORGANIZATION_RBAC_ROLES_LIST,
+            span_route: "/v1/organizations/rbac_roles",
+            span_query: %w[limit page],
+            method: :get,
+            path: "v1/organizations/rbac_roles",
+            query: query,
+            page: Anthropic::Internal::PageCursor,
+            model: Anthropic::Organization::RBACRole,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Anthropic::Client]
+        def initialize(client:)
+          @client = client
+          @permissions = Anthropic::Resources::Organization::RBACRoles::Permissions.new(client: client)
+        end
+      end
+    end
+  end
+end

data/lib/anthropic/resources/organization/spend_limits/effective.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Resources
+    class Organization
+      class SpendLimits
+        class Effective
+          # List each member's effective spend limit and period-to-date spend.
+          #
+          # Returns one row per (member, period) the member resolves a spend limit for, with
+          # the `source` scope the spend limit was inherited from. Paginates by member, so a
+          # member's periods never split across pages. Supported for Claude Enterprise
+          # organizations only, not for Claude Console organizations.
+          #
+          # Some parameter documentations has been truncated, see
+          # {Anthropic::Models::Organization::SpendLimits::EffectiveListParams} for more
+          # details.
+          #
+          # @overload list(limit: nil, page: nil, period: nil, user_ids: nil, request_options: {})
+          #
+          # @param limit [Integer] Maximum number of members per page. A member's period rows never split across pa
+          #
+          # @param page [String, nil] Opaque cursor from a previous response's `next_page` field.
+          #
+          # @param period [Array<Symbol, Anthropic::Models::Organization::SpendLimitPeriod>, nil] Restrict the report to these limit periods. Omit to return one row per period ea
+          #
+          # @param user_ids [Array<String>, nil] Restrict the report to these members, by tagged user ID (`user_...`). At most 10
+          #
+          # @param request_options [Anthropic::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [Anthropic::Internal::PageCursor<Anthropic::Models::Organization::SpendSummary>]
+          #
+          # @see Anthropic::Models::Organization::SpendLimits::EffectiveListParams
+          def list(params = {})
+            parsed, options = Anthropic::Organization::SpendLimits::EffectiveListParams.dump_request(params)
+            query = Anthropic::Internal::Util.encode_query_params(parsed)
+            @client.request(
+              span_name: Anthropic::Internal::Tracing::SpanName::ORGANIZATION_SPEND_LIMITS_EFFECTIVE_LIST,
+              span_route: "/v1/organizations/spend_limits/effective",
+              span_query: %w[limit page period user_ids],
+              method: :get,
+              path: "v1/organizations/spend_limits/effective",
+              query: query,
+              page: Anthropic::Internal::PageCursor,
+              model: Anthropic::Organization::SpendSummary,
+              options: options
+            )
+          end
+
+          # @api private
+          #
+          # @param client [Anthropic::Client]
+          def initialize(client:)
+            @client = client
+          end
+        end
+      end
+    end
+  end
+end