anthropic 2.3.0 → 2.4.0

data/rbi/anthropic/models/organization/analytics/summary_list_params.rbi

@@ -0,0 +1,116 @@
+# typed: strong
+
+module Anthropic
+  module Models
+    module Organization
+      module Analytics
+        class SummaryListParams < Anthropic::Internal::Type::BaseModel
+          extend Anthropic::Internal::Type::RequestParameters::Converter
+          include Anthropic::Internal::Type::RequestParameters
+
+          OrHash =
+            T.type_alias do
+              T.any(
+                Anthropic::Organization::Analytics::SummaryListParams,
+                Anthropic::Internal::AnyHash
+              )
+            end
+
+          # UTC date in YYYY-MM-DD format. Start of the date range (inclusive). Data is
+          # typically available with a 1-day lag (varies by query; the error for a
+          # too-recent date names the latest available day) and may be revised by a few
+          # percent over the following days. No earlier than 2026-01-01.
+          sig { returns(Date) }
+          attr_accessor :starting_date
+
+          # UTC date in YYYY-MM-DD format. End of the date range (exclusive). Data is
+          # typically available with a 1-day lag, so this can be at most today — which is
+          # also the default when omitted, making the last entry cover the most recent
+          # available day. Data may be revised by a few percent over the following days. The
+          # range may span at most 366 days.
+          sig { returns(T.nilable(Date)) }
+          attr_accessor :ending_date
+
+          # Filters as `dimension:value`. Only `rbac_group_id` is supported (e.g.
+          # `filter[]=rbac_group_id:{id}`); repeat the param to OR across groups. Scopes the
+          # whole day series to members of the matching group(s), re-aggregated from
+          # member-level activity — org-wide seat/invite fields and the adoption rates
+          # derived from them are null on scoped rows. `rbac_group_id` accepts the tagged id
+          # (`rbac_group_...`, as emitted in responses and by the spend-limits API) or a
+          # bare group UUID, and matches users who held the group at any point during each
+          # UTC day (time-of-usage attribution). At most 100 entries.
+          sig { returns(T.nilable(T::Array[String])) }
+          attr_accessor :filter
+
+          # Number of results per page (1-1000, default 100). The day series (at most 366
+          # entries) is currently returned in full in a single page, so `limit` does not yet
+          # shorten it.
+          sig { returns(T.nilable(Integer)) }
+          attr_accessor :limit
+
+          # Opaque cursor from a previous response's `next_page` field. `next_page` is
+          # currently always null, so there is never a cursor to send.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :page
+
+          sig do
+            params(
+              starting_date: Date,
+              ending_date: T.nilable(Date),
+              filter: T.nilable(T::Array[String]),
+              limit: T.nilable(Integer),
+              page: T.nilable(String),
+              request_options: Anthropic::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # UTC date in YYYY-MM-DD format. Start of the date range (inclusive). Data is
+            # typically available with a 1-day lag (varies by query; the error for a
+            # too-recent date names the latest available day) and may be revised by a few
+            # percent over the following days. No earlier than 2026-01-01.
+            starting_date:,
+            # UTC date in YYYY-MM-DD format. End of the date range (exclusive). Data is
+            # typically available with a 1-day lag, so this can be at most today — which is
+            # also the default when omitted, making the last entry cover the most recent
+            # available day. Data may be revised by a few percent over the following days. The
+            # range may span at most 366 days.
+            ending_date: nil,
+            # Filters as `dimension:value`. Only `rbac_group_id` is supported (e.g.
+            # `filter[]=rbac_group_id:{id}`); repeat the param to OR across groups. Scopes the
+            # whole day series to members of the matching group(s), re-aggregated from
+            # member-level activity — org-wide seat/invite fields and the adoption rates
+            # derived from them are null on scoped rows. `rbac_group_id` accepts the tagged id
+            # (`rbac_group_...`, as emitted in responses and by the spend-limits API) or a
+            # bare group UUID, and matches users who held the group at any point during each
+            # UTC day (time-of-usage attribution). At most 100 entries.
+            filter: nil,
+            # Number of results per page (1-1000, default 100). The day series (at most 366
+            # entries) is currently returned in full in a single page, so `limit` does not yet
+            # shorten it.
+            limit: nil,
+            # Opaque cursor from a previous response's `next_page` field. `next_page` is
+            # currently always null, so there is never a cursor to send.
+            page: nil,
+            request_options: {}
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                starting_date: Date,
+                ending_date: T.nilable(Date),
+                filter: T.nilable(T::Array[String]),
+                limit: T.nilable(Integer),
+                page: T.nilable(String),
+                request_options: Anthropic::RequestOptions
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/anthropic/models/organization/analytics/user_list_params.rbi

@@ -0,0 +1,226 @@
+# typed: strong
+
+module Anthropic
+  module Models
+    module Organization
+      module Analytics
+        class UserListParams < Anthropic::Internal::Type::BaseModel
+          extend Anthropic::Internal::Type::RequestParameters::Converter
+          include Anthropic::Internal::Type::RequestParameters
+
+          OrHash =
+            T.type_alias do
+              T.any(
+                Anthropic::Organization::Analytics::UserListParams,
+                Anthropic::Internal::AnyHash
+              )
+            end
+
+          # UTC date in YYYY-MM-DD format. The day to get user activity for. Data is
+          # typically available with a 1-day lag (varies by query; the error for a
+          # too-recent date names the latest available day) and may be revised by a few
+          # percent over the following days. No earlier than 2026-01-01.
+          sig { returns(T.nilable(Date)) }
+          attr_accessor :date
+
+          # UTC date in YYYY-MM-DD format. End of the date range (exclusive); only valid
+          # with `starting_date`. Data is typically available with a 1-day lag (varies by
+          # query; the error for a too-recent date names the latest available day), so this
+          # can be at most today — which is also the default when omitted, resolved once
+          # when the first page is served and reused for the rest of the pagination
+          # sequence. At most 366 days after `starting_date`.
+          sig { returns(T.nilable(Date)) }
+          attr_accessor :ending_date
+
+          # Filters as `dimension:value`, e.g. `filter[]=rbac_group_id:{id}`. Repeat the
+          # param for OR within a dimension and across dimensions for AND. Supported
+          # dimensions on this endpoint: `project_id`, `rbac_group_id`, `user_id`. Value
+          # forms: `project_id` takes a tagged project id (`claude_proj_...`);
+          # `rbac_group_id` takes the tagged id (`rbac_group_...`, as emitted in responses
+          # and by the spend-limits API) or a bare group UUID, and matches users who held
+          # the group at any point during each covered UTC day (time-of-usage attribution);
+          # `user_id` takes a tagged user id (`user_...`), as emitted in responses. An
+          # unsupported dimension returns 400. At most 100 entries. A `project_id` filter
+          # limits each member's row to their claude.ai chat activity in that project and
+          # cannot be combined with `group_by[]` or an `rbac_group_id` filter. On these
+          # rows, every count in `chat_cowork_unified_metrics.sessions` is 0, because
+          # sessions are not measured per project. On any day a member sent a chat message
+          # in Chat and Cowork unified, all of that member's project activity for the day is
+          # counted in `chat_cowork_unified_metrics.chat` instead of `chat_metrics`.
+          sig { returns(T.nilable(T::Array[String])) }
+          attr_accessor :filter
+
+          # Dimensions to break results out by (e.g. `group_by[]=rbac_group_id`). Supported
+          # on this endpoint: `rbac_group_id`. Rows are already per-member, so the one
+          # supported grouping aggregates them per RBAC group instead. Grouped rows carry
+          # the requested dimension values as additional fields and paginate like ungrouped
+          # responses via `next_page`; an unsupported dimension returns 400. `rbac_group_id`
+          # attributes a user to every group they held at any point during each covered UTC
+          # day, so grouped rows are not an exclusive partition and can sum above org-level
+          # totals. At most 100 entries.
+          sig do
+            returns(
+              T.nilable(
+                T::Array[
+                  Anthropic::Organization::AnalyticsUserGroupBy::OrSymbol
+                ]
+              )
+            )
+          end
+          attr_accessor :group_by
+
+          # Number of results per page (1-1000, default 100).
+          sig { returns(T.nilable(Integer)) }
+          attr_accessor :limit
+
+          # Sort direction: `asc` or `desc`. Defaults to `asc` for the endpoint's sort
+          # column and to `desc` when `order_by` names a metric (a top-N ranking). Applies
+          # to `order_by`, or to the endpoint's default sort field when `order_by` is
+          # omitted.
+          sig do
+            returns(
+              T.nilable(Anthropic::Organization::AnalyticsOrder::OrSymbol)
+            )
+          end
+          attr_accessor :order
+
+          # Sort field. Restricted to the endpoint's sort column plus its rankable metrics
+          # (metrics default to descending; a few metrics rank in date-range mode only, per
+          # the endpoint's documented orderable set).
+          sig { returns(T.nilable(String)) }
+          attr_accessor :order_by
+
+          # Opaque cursor from a previous response's `next_page` field.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :page
+
+          # UTC date in YYYY-MM-DD format. Start of a date range (inclusive). Enables rollup
+          # mode: one row per entity aggregated over the whole range — addable counters are
+          # summed across days, and a distinct count is never summed where summing could
+          # double-count (a field's range value is recomputed exactly over the window,
+          # approximate via HLL with typical error under 2%, null, or — for the
+          # creation-event counts, whose per-day values cannot overlap — a per-day sum that
+          # is itself exact; each field's own description says which). Use either `date` or
+          # `starting_date`, not both. Data is typically available with a 1-day lag (varies
+          # by query; the error for a too-recent date names the latest available day) and
+          # may be revised by a few percent over the following days. No earlier than
+          # 2026-01-01.
+          sig { returns(T.nilable(Date)) }
+          attr_accessor :starting_date
+
+          sig do
+            params(
+              date: T.nilable(Date),
+              ending_date: T.nilable(Date),
+              filter: T.nilable(T::Array[String]),
+              group_by:
+                T.nilable(
+                  T::Array[
+                    Anthropic::Organization::AnalyticsUserGroupBy::OrSymbol
+                  ]
+                ),
+              limit: T.nilable(Integer),
+              order:
+                T.nilable(Anthropic::Organization::AnalyticsOrder::OrSymbol),
+              order_by: T.nilable(String),
+              page: T.nilable(String),
+              starting_date: T.nilable(Date),
+              request_options: Anthropic::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # UTC date in YYYY-MM-DD format. The day to get user activity for. Data is
+            # typically available with a 1-day lag (varies by query; the error for a
+            # too-recent date names the latest available day) and may be revised by a few
+            # percent over the following days. No earlier than 2026-01-01.
+            date: nil,
+            # UTC date in YYYY-MM-DD format. End of the date range (exclusive); only valid
+            # with `starting_date`. Data is typically available with a 1-day lag (varies by
+            # query; the error for a too-recent date names the latest available day), so this
+            # can be at most today — which is also the default when omitted, resolved once
+            # when the first page is served and reused for the rest of the pagination
+            # sequence. At most 366 days after `starting_date`.
+            ending_date: nil,
+            # Filters as `dimension:value`, e.g. `filter[]=rbac_group_id:{id}`. Repeat the
+            # param for OR within a dimension and across dimensions for AND. Supported
+            # dimensions on this endpoint: `project_id`, `rbac_group_id`, `user_id`. Value
+            # forms: `project_id` takes a tagged project id (`claude_proj_...`);
+            # `rbac_group_id` takes the tagged id (`rbac_group_...`, as emitted in responses
+            # and by the spend-limits API) or a bare group UUID, and matches users who held
+            # the group at any point during each covered UTC day (time-of-usage attribution);
+            # `user_id` takes a tagged user id (`user_...`), as emitted in responses. An
+            # unsupported dimension returns 400. At most 100 entries. A `project_id` filter
+            # limits each member's row to their claude.ai chat activity in that project and
+            # cannot be combined with `group_by[]` or an `rbac_group_id` filter. On these
+            # rows, every count in `chat_cowork_unified_metrics.sessions` is 0, because
+            # sessions are not measured per project. On any day a member sent a chat message
+            # in Chat and Cowork unified, all of that member's project activity for the day is
+            # counted in `chat_cowork_unified_metrics.chat` instead of `chat_metrics`.
+            filter: nil,
+            # Dimensions to break results out by (e.g. `group_by[]=rbac_group_id`). Supported
+            # on this endpoint: `rbac_group_id`. Rows are already per-member, so the one
+            # supported grouping aggregates them per RBAC group instead. Grouped rows carry
+            # the requested dimension values as additional fields and paginate like ungrouped
+            # responses via `next_page`; an unsupported dimension returns 400. `rbac_group_id`
+            # attributes a user to every group they held at any point during each covered UTC
+            # day, so grouped rows are not an exclusive partition and can sum above org-level
+            # totals. At most 100 entries.
+            group_by: nil,
+            # Number of results per page (1-1000, default 100).
+            limit: nil,
+            # Sort direction: `asc` or `desc`. Defaults to `asc` for the endpoint's sort
+            # column and to `desc` when `order_by` names a metric (a top-N ranking). Applies
+            # to `order_by`, or to the endpoint's default sort field when `order_by` is
+            # omitted.
+            order: nil,
+            # Sort field. Restricted to the endpoint's sort column plus its rankable metrics
+            # (metrics default to descending; a few metrics rank in date-range mode only, per
+            # the endpoint's documented orderable set).
+            order_by: nil,
+            # Opaque cursor from a previous response's `next_page` field.
+            page: nil,
+            # UTC date in YYYY-MM-DD format. Start of a date range (inclusive). Enables rollup
+            # mode: one row per entity aggregated over the whole range — addable counters are
+            # summed across days, and a distinct count is never summed where summing could
+            # double-count (a field's range value is recomputed exactly over the window,
+            # approximate via HLL with typical error under 2%, null, or — for the
+            # creation-event counts, whose per-day values cannot overlap — a per-day sum that
+            # is itself exact; each field's own description says which). Use either `date` or
+            # `starting_date`, not both. Data is typically available with a 1-day lag (varies
+            # by query; the error for a too-recent date names the latest available day) and
+            # may be revised by a few percent over the following days. No earlier than
+            # 2026-01-01.
+            starting_date: nil,
+            request_options: {}
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                date: T.nilable(Date),
+                ending_date: T.nilable(Date),
+                filter: T.nilable(T::Array[String]),
+                group_by:
+                  T.nilable(
+                    T::Array[
+                      Anthropic::Organization::AnalyticsUserGroupBy::OrSymbol
+                    ]
+                  ),
+                limit: T.nilable(Integer),
+                order:
+                  T.nilable(Anthropic::Organization::AnalyticsOrder::OrSymbol),
+                order_by: T.nilable(String),
+                page: T.nilable(String),
+                starting_date: T.nilable(Date),
+                request_options: Anthropic::RequestOptions
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/anthropic/models/organization/analytics_artifact_activity.rbi

@@ -0,0 +1,156 @@
+# typed: strong
+
+module Anthropic
+  module Models
+    module Organization
+      class AnalyticsArtifactActivity < Anthropic::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Anthropic::Organization::AnalyticsArtifactActivity,
+              Anthropic::Internal::AnyHash
+            )
+          end
+
+        # Canonical artifact MIME type (e.g. `text/markdown`, `application/vnd.ant.react`,
+        # `image/svg+xml`), or `other`. Claude Code and Cowork artifacts report as
+        # `text/html`.
+        sig { returns(String) }
+        attr_accessor :artifact_type
+
+        # Number of artifacts created in this bucket on the requested day
+        sig { returns(Integer) }
+        attr_accessor :artifacts_created_count
+
+        # Number of distinct users who created artifacts in this bucket on the requested
+        # day
+        sig { returns(Integer) }
+        attr_accessor :distinct_user_count
+
+        # Whether the artifacts in this bucket have ever been shared (a Claude Code /
+        # Cowork artifact is shared once anyone beyond its creator may open it: named
+        # members, the whole organization, or anyone with the link).
+        sig { returns(T::Boolean) }
+        attr_accessor :is_shared
+
+        # Number of those artifacts that have been published (for Claude Code / Cowork
+        # artifacts: open to anyone with the link); never exceeds
+        # `artifacts_created_count`
+        sig { returns(Integer) }
+        attr_accessor :published_artifacts_created_count
+
+        # Product that produced this row's activity: one of `chat`, `claude_code`,
+        # `cowork`, `office_agent`, or `chat_cowork_unified` (Chat and Cowork unified).
+        # These are the canonical Cost & Usage product names; an `office_agent` row's
+        # per-surface breakdown is in its `office_metrics`. On `/plugins` only `cowork`,
+        # `claude_code` and `chat_cowork_unified` occur (the only surfaces with plugin
+        # attribution); on `/artifacts` only `chat`, `claude_code`, `cowork` and
+        # `chat_cowork_unified` occur (the surfaces that create artifacts);
+        # `/apps/chat/projects` does not support the product dimension (a `product` entry
+        # in `group_by[]` or `filter[]` there is rejected). Present only when the request
+        # grouped by `product`.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :product
+
+        # Tagged RBAC group identifier (`rbac_group_...`), matching the spend-limits API
+        # spelling. Present only when the request grouped by `rbac_group_id`.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :rbac_group_id
+
+        # Resolved RBAC group display name, alongside `rbac_group_id` when name resolution
+        # is available. Null if the group has been deleted or its name could not be
+        # resolved; `rbac_group_id` remains the stable key.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :rbac_group_name
+
+        # Tagged user identifier (e.g. `user_...`). Present only when the request grouped
+        # by `user_id`.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :user_id
+
+        # Artifact-creation activity for one (`artifact_type`, `is_shared`) bucket on a
+        # given day.
+        #
+        # Artifacts form a small finite cube — the canonical MIME type (8 values incl.
+        # `other`) crossed with shared-vs-private — so the response is the full set of
+        # non-empty buckets, not a ranked/paginated list. Claude Code and Cowork artifacts
+        # report under `text/html` and are counted from 2026-08-17 onward; earlier days
+        # contain claude.ai chat artifacts only. With `group_by[]=product` / `user_id` /
+        # `rbac_group_id` each row is further split by the flat group keys and counts are
+        # scoped to that cut.
+        sig do
+          params(
+            artifact_type: String,
+            artifacts_created_count: Integer,
+            distinct_user_count: Integer,
+            is_shared: T::Boolean,
+            published_artifacts_created_count: Integer,
+            product: T.nilable(String),
+            rbac_group_id: T.nilable(String),
+            rbac_group_name: T.nilable(String),
+            user_id: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Canonical artifact MIME type (e.g. `text/markdown`, `application/vnd.ant.react`,
+          # `image/svg+xml`), or `other`. Claude Code and Cowork artifacts report as
+          # `text/html`.
+          artifact_type:,
+          # Number of artifacts created in this bucket on the requested day
+          artifacts_created_count:,
+          # Number of distinct users who created artifacts in this bucket on the requested
+          # day
+          distinct_user_count:,
+          # Whether the artifacts in this bucket have ever been shared (a Claude Code /
+          # Cowork artifact is shared once anyone beyond its creator may open it: named
+          # members, the whole organization, or anyone with the link).
+          is_shared:,
+          # Number of those artifacts that have been published (for Claude Code / Cowork
+          # artifacts: open to anyone with the link); never exceeds
+          # `artifacts_created_count`
+          published_artifacts_created_count:,
+          # Product that produced this row's activity: one of `chat`, `claude_code`,
+          # `cowork`, `office_agent`, or `chat_cowork_unified` (Chat and Cowork unified).
+          # These are the canonical Cost & Usage product names; an `office_agent` row's
+          # per-surface breakdown is in its `office_metrics`. On `/plugins` only `cowork`,
+          # `claude_code` and `chat_cowork_unified` occur (the only surfaces with plugin
+          # attribution); on `/artifacts` only `chat`, `claude_code`, `cowork` and
+          # `chat_cowork_unified` occur (the surfaces that create artifacts);
+          # `/apps/chat/projects` does not support the product dimension (a `product` entry
+          # in `group_by[]` or `filter[]` there is rejected). Present only when the request
+          # grouped by `product`.
+          product: nil,
+          # Tagged RBAC group identifier (`rbac_group_...`), matching the spend-limits API
+          # spelling. Present only when the request grouped by `rbac_group_id`.
+          rbac_group_id: nil,
+          # Resolved RBAC group display name, alongside `rbac_group_id` when name resolution
+          # is available. Null if the group has been deleted or its name could not be
+          # resolved; `rbac_group_id` remains the stable key.
+          rbac_group_name: nil,
+          # Tagged user identifier (e.g. `user_...`). Present only when the request grouped
+          # by `user_id`.
+          user_id: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              artifact_type: String,
+              artifacts_created_count: Integer,
+              distinct_user_count: Integer,
+              is_shared: T::Boolean,
+              published_artifacts_created_count: Integer,
+              product: T.nilable(String),
+              rbac_group_id: T.nilable(String),
+              rbac_group_name: T.nilable(String),
+              user_id: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/anthropic/models/organization/analytics_artifact_group_by.rbi

@@ -0,0 +1,44 @@
+# typed: strong
+
+module Anthropic
+  module Models
+    module Organization
+      # A dimension to group artifact activity by.
+      module AnalyticsArtifactGroupBy
+        extend Anthropic::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Anthropic::Organization::AnalyticsArtifactGroupBy)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        PRODUCT =
+          T.let(
+            :product,
+            Anthropic::Organization::AnalyticsArtifactGroupBy::TaggedSymbol
+          )
+        RBAC_GROUP_ID =
+          T.let(
+            :rbac_group_id,
+            Anthropic::Organization::AnalyticsArtifactGroupBy::TaggedSymbol
+          )
+        USER_ID =
+          T.let(
+            :user_id,
+            Anthropic::Organization::AnalyticsArtifactGroupBy::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Anthropic::Organization::AnalyticsArtifactGroupBy::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end