basecamp-sdk 0.19.0 → 0.21.0

data/lib/basecamp/generated/types.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Auto-generated from OpenAPI spec. Do not edit manually.
-# Generated: 2026-09-16T11:13:05Z
+# Generated: 2026-09-30T18:52:50Z
 
 require "json"
 require "time"
@@ -594,7 +594,7 @@ module Basecamp
     # Card
     class Card
       include TypeHelpers
-      attr_accessor :app_url, :bucket, :created_at, :creator, :description_attachments, :id, :inherits_status, :parent, :status, :title, :type, :updated_at, :url, :visible_to_clients, :assignees, :bookmark_url, :boosts_count, :boosts_url, :comments_count, :comments_url, :completed, :completed_at, :completer, :completion_subscribers, :completion_url, :content, :description, :due_on, :position, :steps, :subscription_url
+      attr_accessor :app_url, :bucket, :created_at, :creator, :description_attachments, :id, :inherits_status, :parent, :status, :title, :type, :updated_at, :url, :visible_to_clients, :assignees, :bookmark_url, :boosts_count, :boosts_url, :comments_count, :comments_url, :completed, :completed_at, :completer, :completion_subscribers, :completion_url, :content, :description, :due_on, :position, :steps, :subscription_url, :subtasks_completed_count, :subtasks_count, :subtasks_url
 
       # @return [Array<Symbol>]
       def self.required_fields
@@ -631,8 +631,11 @@ module Basecamp
         @description = data["description"]
         @due_on = data["due_on"]
         @position = parse_integer(data["position"])
-        @steps = parse_array(data["steps"], "CardStep")
+        @steps = parse_array(data["steps"], "Subtask")
         @subscription_url = data["subscription_url"]
+        @subtasks_completed_count = parse_integer(data["subtasks_completed_count"])
+        @subtasks_count = parse_integer(data["subtasks_count"])
+        @subtasks_url = data["subtasks_url"]
       end
 
       def to_h
@@ -668,6 +671,9 @@ module Basecamp
           "position" => @position,
           "steps" => @steps,
           "subscription_url" => @subscription_url,
+          "subtasks_completed_count" => @subtasks_completed_count,
+          "subtasks_count" => @subtasks_count,
+          "subtasks_url" => @subtasks_url,
         }.compact
       end
 
@@ -782,75 +788,10 @@ module Basecamp
       end
     end
 
-    # CardStep
-    class CardStep
-      include TypeHelpers
-      attr_accessor :app_url, :bucket, :created_at, :creator, :id, :inherits_status, :parent, :status, :title, :type, :updated_at, :url, :visible_to_clients, :assignees, :bookmark_url, :completed, :completed_at, :completer, :completion_url, :due_on, :position
-
-      # @return [Array<Symbol>]
-      def self.required_fields
-        %i[app_url bucket created_at creator id inherits_status parent status title type updated_at url visible_to_clients].freeze
-      end
-
-      def initialize(data = {})
-        @app_url = data["app_url"]
-        @bucket = parse_type(data["bucket"], "TodoBucket")
-        @created_at = parse_datetime(data["created_at"])
-        @creator = parse_type(data["creator"], "Person")
-        @id = parse_integer(data["id"])
-        @inherits_status = parse_boolean(data["inherits_status"])
-        @parent = parse_type(data["parent"], "RecordingParent")
-        @status = data["status"]
-        @title = data["title"]
-        @type = data["type"]
-        @updated_at = parse_datetime(data["updated_at"])
-        @url = data["url"]
-        @visible_to_clients = parse_boolean(data["visible_to_clients"])
-        @assignees = parse_array(data["assignees"], "Person")
-        @bookmark_url = data["bookmark_url"]
-        @completed = parse_boolean(data["completed"])
-        @completed_at = parse_datetime(data["completed_at"])
-        @completer = parse_type(data["completer"], "Person")
-        @completion_url = data["completion_url"]
-        @due_on = data["due_on"]
-        @position = parse_integer(data["position"])
-      end
-
-      def to_h
-        {
-          "app_url" => @app_url,
-          "bucket" => @bucket,
-          "created_at" => @created_at,
-          "creator" => @creator,
-          "id" => @id,
-          "inherits_status" => @inherits_status,
-          "parent" => @parent,
-          "status" => @status,
-          "title" => @title,
-          "type" => @type,
-          "updated_at" => @updated_at,
-          "url" => @url,
-          "visible_to_clients" => @visible_to_clients,
-          "assignees" => @assignees,
-          "bookmark_url" => @bookmark_url,
-          "completed" => @completed,
-          "completed_at" => @completed_at,
-          "completer" => @completer,
-          "completion_url" => @completion_url,
-          "due_on" => @due_on,
-          "position" => @position,
-        }.compact
-      end
-
-      def to_json(*args)
-        to_h.to_json(*args)
-      end
-    end
-
     # CardTable
     class CardTable
       include TypeHelpers
-      attr_accessor :app_url, :bucket, :created_at, :creator, :id, :inherits_status, :status, :title, :type, :updated_at, :url, :visible_to_clients, :bookmark_url, :lists, :subscribers, :subscription_url, :wormholes
+      attr_accessor :app_url, :bucket, :created_at, :creator, :id, :inherits_status, :status, :title, :type, :updated_at, :url, :visible_to_clients, :bookmark_url, :lists, :parent, :position, :public_link_url, :subscribers, :subscription_url, :wormholes
 
       # @return [Array<Symbol>]
       def self.required_fields
@@ -872,6 +813,9 @@ module Basecamp
         @visible_to_clients = parse_boolean(data["visible_to_clients"])
         @bookmark_url = data["bookmark_url"]
         @lists = parse_array(data["lists"], "CardColumn")
+        @parent = parse_type(data["parent"], "RecordingParent")
+        @position = parse_integer(data["position"])
+        @public_link_url = data["public_link_url"]
         @subscribers = parse_array(data["subscribers"], "Person")
         @subscription_url = data["subscription_url"]
         @wormholes = parse_array(data["wormholes"], "Wormhole")
@@ -893,6 +837,9 @@ module Basecamp
           "visible_to_clients" => @visible_to_clients,
           "bookmark_url" => @bookmark_url,
           "lists" => @lists,
+          "parent" => @parent,
+          "position" => @position,
+          "public_link_url" => @public_link_url,
           "subscribers" => @subscribers,
           "subscription_url" => @subscription_url,
           "wormholes" => @wormholes,
@@ -3819,7 +3766,7 @@ module Basecamp
     # Recording
     class Recording
       include TypeHelpers
-      attr_accessor :app_url, :bucket, :created_at, :creator, :id, :inherits_status, :status, :title, :type, :updated_at, :url, :visible_to_clients, :bookmark_url, :boosts_count, :boosts_url, :bubble_up_url, :category, :comments_count, :comments_url, :content, :content_attachments, :description, :description_attachments, :from, :group_on, :parent, :position, :replies_count, :replies_url, :service, :subject, :subscription_url
+      attr_accessor :app_url, :bucket, :created_at, :creator, :id, :inherits_status, :status, :title, :type, :updated_at, :url, :visible_to_clients, :bookmark_url, :boosts_count, :boosts_url, :bubble_up_url, :category, :comments_count, :comments_url, :content, :content_attachments, :description, :description_attachments, :from, :group_on, :parent, :position, :replies_count, :replies_url, :service, :subject, :subscription_url, :subtasks_completed_count, :subtasks_count, :subtasks_url
 
       # @return [Array<Symbol>]
       def self.required_fields
@@ -3859,6 +3806,9 @@ module Basecamp
         @service = parse_type(data["service"], "DoorService")
         @subject = data["subject"]
         @subscription_url = data["subscription_url"]
+        @subtasks_completed_count = parse_integer(data["subtasks_completed_count"])
+        @subtasks_count = parse_integer(data["subtasks_count"])
+        @subtasks_url = data["subtasks_url"]
       end
 
       def to_h
@@ -3895,6 +3845,9 @@ module Basecamp
           "service" => @service,
           "subject" => @subject,
           "subscription_url" => @subscription_url,
+          "subtasks_completed_count" => @subtasks_completed_count,
+          "subtasks_count" => @subtasks_count,
+          "subtasks_url" => @subtasks_url,
         }.compact
       end
 
@@ -4462,6 +4415,71 @@ module Basecamp
       end
     end
 
+    # Subtask
+    class Subtask
+      include TypeHelpers
+      attr_accessor :app_url, :bucket, :created_at, :creator, :id, :inherits_status, :parent, :status, :title, :type, :updated_at, :url, :visible_to_clients, :assignees, :bookmark_url, :completed, :completed_at, :completer, :completion_url, :due_on, :position
+
+      # @return [Array<Symbol>]
+      def self.required_fields
+        %i[app_url bucket created_at creator id inherits_status parent status title type updated_at url visible_to_clients].freeze
+      end
+
+      def initialize(data = {})
+        @app_url = data["app_url"]
+        @bucket = parse_type(data["bucket"], "TodoBucket")
+        @created_at = parse_datetime(data["created_at"])
+        @creator = parse_type(data["creator"], "Person")
+        @id = parse_integer(data["id"])
+        @inherits_status = parse_boolean(data["inherits_status"])
+        @parent = parse_type(data["parent"], "RecordingParent")
+        @status = data["status"]
+        @title = data["title"]
+        @type = data["type"]
+        @updated_at = parse_datetime(data["updated_at"])
+        @url = data["url"]
+        @visible_to_clients = parse_boolean(data["visible_to_clients"])
+        @assignees = parse_array(data["assignees"], "Person")
+        @bookmark_url = data["bookmark_url"]
+        @completed = parse_boolean(data["completed"])
+        @completed_at = parse_datetime(data["completed_at"])
+        @completer = parse_type(data["completer"], "Person")
+        @completion_url = data["completion_url"]
+        @due_on = data["due_on"]
+        @position = parse_integer(data["position"])
+      end
+
+      def to_h
+        {
+          "app_url" => @app_url,
+          "bucket" => @bucket,
+          "created_at" => @created_at,
+          "creator" => @creator,
+          "id" => @id,
+          "inherits_status" => @inherits_status,
+          "parent" => @parent,
+          "status" => @status,
+          "title" => @title,
+          "type" => @type,
+          "updated_at" => @updated_at,
+          "url" => @url,
+          "visible_to_clients" => @visible_to_clients,
+          "assignees" => @assignees,
+          "bookmark_url" => @bookmark_url,
+          "completed" => @completed,
+          "completed_at" => @completed_at,
+          "completer" => @completer,
+          "completion_url" => @completion_url,
+          "due_on" => @due_on,
+          "position" => @position,
+        }.compact
+      end
+
+      def to_json(*args)
+        to_h.to_json(*args)
+      end
+    end
+
     # Template
     class Template
       include TypeHelpers
@@ -4503,27 +4521,27 @@ module Basecamp
       end
     end
 
-    # TemplateLibrary
-    class TemplateLibrary
+    # TemplateLibraryCardTables
+    class TemplateLibraryCardTables
       include TypeHelpers
-      attr_accessor :bucket, :todolists, :todoset
+      attr_accessor :bucket, :card_tables, :kanban_boardset
 
       # @return [Array<Symbol>]
       def self.required_fields
-        %i[bucket todolists todoset].freeze
+        %i[bucket card_tables kanban_boardset].freeze
       end
 
       def initialize(data = {})
         @bucket = parse_type(data["bucket"], "RecordingBucket")
-        @todolists = parse_array(data["todolists"], "Todolist")
-        @todoset = parse_type(data["todoset"], "RecordingParent")
+        @card_tables = parse_array(data["card_tables"], "Recording")
+        @kanban_boardset = data["kanban_boardset"]
       end
 
       def to_h
         {
           "bucket" => @bucket,
-          "todolists" => @todolists,
-          "todoset" => @todoset,
+          "card_tables" => @card_tables,
+          "kanban_boardset" => @kanban_boardset,
         }.compact
       end
 
@@ -4564,7 +4582,7 @@ module Basecamp
     # TemplateLibraryCopy
     class TemplateLibraryCopy
       include TypeHelpers
-      attr_accessor :destination_parent_id, :id, :source_recording_id, :status, :url, :destination_todolist
+      attr_accessor :destination_parent_id, :id, :source_recording_id, :status, :url, :destination_card_table, :destination_todolist
 
       # @return [Array<Symbol>]
       def self.required_fields
@@ -4577,6 +4595,7 @@ module Basecamp
         @source_recording_id = parse_integer(data["source_recording_id"])
         @status = data["status"]
         @url = data["url"]
+        @destination_card_table = parse_type(data["destination_card_table"], "CardTable")
         @destination_todolist = parse_type(data["destination_todolist"], "Todolist")
       end
 
@@ -4587,6 +4606,71 @@ module Basecamp
           "source_recording_id" => @source_recording_id,
           "status" => @status,
           "url" => @url,
+          "destination_card_table" => @destination_card_table,
+          "destination_todolist" => @destination_todolist,
+        }.compact
+      end
+
+      def to_json(*args)
+        to_h.to_json(*args)
+      end
+    end
+
+    # TemplateLibraryTodolists
+    class TemplateLibraryTodolists
+      include TypeHelpers
+      attr_accessor :bucket, :todolists, :todoset
+
+      # @return [Array<Symbol>]
+      def self.required_fields
+        %i[bucket todolists todoset].freeze
+      end
+
+      def initialize(data = {})
+        @bucket = parse_type(data["bucket"], "RecordingBucket")
+        @todolists = parse_array(data["todolists"], "Todolist")
+        @todoset = parse_type(data["todoset"], "RecordingParent")
+      end
+
+      def to_h
+        {
+          "bucket" => @bucket,
+          "todolists" => @todolists,
+          "todoset" => @todoset,
+        }.compact
+      end
+
+      def to_json(*args)
+        to_h.to_json(*args)
+      end
+    end
+
+    # Templatification
+    class Templatification
+      include TypeHelpers
+      attr_accessor :id, :source_recording_id, :status, :url, :destination_card_table, :destination_todolist
+
+      # @return [Array<Symbol>]
+      def self.required_fields
+        %i[id source_recording_id status url].freeze
+      end
+
+      def initialize(data = {})
+        @id = parse_integer(data["id"])
+        @source_recording_id = parse_integer(data["source_recording_id"])
+        @status = data["status"]
+        @url = data["url"]
+        @destination_card_table = parse_type(data["destination_card_table"], "CardTable")
+        @destination_todolist = parse_type(data["destination_todolist"], "Todolist")
+      end
+
+      def to_h
+        {
+          "id" => @id,
+          "source_recording_id" => @source_recording_id,
+          "status" => @status,
+          "url" => @url,
+          "destination_card_table" => @destination_card_table,
           "destination_todolist" => @destination_todolist,
         }.compact
       end
@@ -4827,7 +4911,7 @@ module Basecamp
     # Todo
     class Todo
       include TypeHelpers
-      attr_accessor :app_url, :bucket, :content, :created_at, :creator, :description_attachments, :id, :inherits_status, :parent, :status, :title, :type, :updated_at, :url, :visible_to_clients, :assignees, :bookmark_url, :boosts_count, :boosts_url, :comments_count, :comments_url, :completed, :completion_subscribers, :completion_url, :description, :due_on, :position, :starts_on, :steps, :subscription_url
+      attr_accessor :app_url, :bucket, :content, :created_at, :creator, :description_attachments, :id, :inherits_status, :parent, :status, :title, :type, :updated_at, :url, :visible_to_clients, :assignees, :bookmark_url, :boosts_count, :boosts_url, :comments_count, :comments_url, :completed, :completion_subscribers, :completion_url, :description, :due_on, :position, :starts_on, :steps, :subscription_url, :subtasks_completed_count, :subtasks_count, :subtasks_url
 
       # @return [Array<Symbol>]
       def self.required_fields
@@ -4863,8 +4947,11 @@ module Basecamp
         @due_on = data["due_on"]
         @position = parse_integer(data["position"])
         @starts_on = data["starts_on"]
-        @steps = parse_array(data["steps"], "CardStep")
+        @steps = parse_array(data["steps"], "Subtask")
         @subscription_url = data["subscription_url"]
+        @subtasks_completed_count = parse_integer(data["subtasks_completed_count"])
+        @subtasks_count = parse_integer(data["subtasks_count"])
+        @subtasks_url = data["subtasks_url"]
       end
 
       def to_h
@@ -4899,6 +4986,9 @@ module Basecamp
           "starts_on" => @starts_on,
           "steps" => @steps,
           "subscription_url" => @subscription_url,
+          "subtasks_completed_count" => @subtasks_completed_count,
+          "subtasks_count" => @subtasks_count,
+          "subtasks_url" => @subtasks_url,
         }.compact
       end
 
@@ -5875,5 +5965,9 @@ module Basecamp
         to_h.to_json(*args)
       end
     end
+
+    # CardStep
+    # @deprecated renamed to Subtask, the same Kanban::Step record.
+    CardStep = Subtask
   end
 end

data/lib/basecamp/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Basecamp
-  VERSION = "0.19.0"
-  API_VERSION = "2026-09-02"
+  VERSION = "0.21.0"
+  API_VERSION = "2026-09-15"
 end

data/scripts/generate-metadata.rb

@@ -13,7 +13,46 @@ require 'time'
 
 # Extract metadata from OpenAPI spec
 class MetadataExtractor
-  METHODS = %w[get post put patch delete].freeze
+  # A Path Item Object is read by EXCLUSION: its non-operation fields are a
+  # closed, spec-defined set, its extensions are `x-` prefixed, and every other
+  # field is an operation. A verb list here dropped an operation's metadata in
+  # silence for any method outside the five it knew (#925). Nothing in this
+  # file is verb-specific — metadata is keyed by operationId — so the walk is
+  # total and no verb bound belongs here.
+  NON_OPERATION_FIELDS = %w[summary description servers parameters].freeze
+
+  # Membership is decided above, by exclusion. The shared declaration every
+  # generator reads (spec/generated-verbs.json) is ORDERED, and that order is
+  # reused here to keep metadata.json byte-stable. Order is not membership: a
+  # verb absent from the declaration sorts deterministically to the end by name
+  # and is still extracted, because nothing in this file is verb-specific.
+  # The self-test points this at a crafted declaration to prove the bound is
+  # sourced from the shared file rather than a private literal; production runs
+  # never set it.
+  GENERATED_VERBS_FILE = ENV.fetch(
+    'BASECAMP_GENERATED_VERBS', File.expand_path('../../spec/generated-verbs.json', __dir__)
+  )
+
+  METHOD_ORDER = begin
+    verbs = JSON.parse(File.read(GENERATED_VERBS_FILE, encoding: 'UTF-8'))['verbs']
+    # An HTTP method is a TOKEN, so the rule is a positive character class rather
+    # than a blankness predicate: `[a-z]+`, identical in all six loaders. Two
+    # review rounds chased "blank" across languages — Kotlin and Rust rejected a
+    # space while the others accepted it, then Ruby's ASCII `strip` accepted a
+    # non-breaking space the Unicode-aware ones rejected — and the next
+    # disagreement was guaranteed, because every language defines whitespace
+    # differently (Java's Character.isWhitespace excludes U+00A0; Rust's
+    # char::is_whitespace includes it; Ruby's String#strip is ASCII-only). A
+    # closed positive rule has no such seam: "", " ", "\u00a0", "GET" and 1 are
+    # all rejected the same way everywhere.
+    unless verbs.is_a?(Array) && !verbs.empty? && verbs.all? { |v| v.is_a?(String) && v.match?(/\A[a-z]+\z/) }
+      abort "Error: #{GENERATED_VERBS_FILE} must declare a non-empty `verbs` array of lowercase " \
+            'ASCII method names (/\A[a-z]+\z/).'
+    end
+    verbs.freeze
+  rescue Errno::ENOENT, JSON::ParserError => e
+    abort "Error: cannot read the generated-verb declaration #{GENERATED_VERBS_FILE}: #{e.message}"
+  end
 
   def initialize(openapi_path)
     # Read as UTF-8 regardless of process locale (LC_ALL=C would otherwise read
@@ -24,13 +63,9 @@ class MetadataExtractor
   def extract
     operations = {}
 
-    (@openapi['paths'] || {}).each_value do |path_item|
-      METHODS.each do |method|
-        operation = path_item[method]
-        next unless operation
-
+    (@openapi['paths'] || {}).each do |path, path_item|
+      each_operation(path, path_item) do |_method, operation|
         operation_id = operation['operationId']
-        next unless operation_id
 
         metadata = extract_operation_metadata(operation)
         operations[operation_id] = metadata if metadata.any?
@@ -61,11 +96,8 @@ class MetadataExtractor
   # in "[]" names an array of people. "$" is the body itself.
   def person_id_sites
     sites = {}
-    (@openapi['paths'] || {}).each_value do |path_item|
-      METHODS.each do |method|
-        operation = path_item[method]
-        next unless operation && operation['operationId']
-
+    (@openapi['paths'] || {}).each do |path, path_item|
+      each_operation(path, path_item) do |_method, operation|
         paths = (operation['responses'] || {}).flat_map do |code, response|
           next [] unless code.to_s.start_with?('2')
 
@@ -117,6 +149,57 @@ class MetadataExtractor
     raise "person id site under additionalProperties at #{nested.first} has no runtime path syntax" if nested.any?
   end
 
+  # Yields [verb, operation] for every operation in a path item. A field that is
+  # neither a known non-operation field nor a readable operation object stops
+  # the run by name rather than being stepped over.
+  def each_operation(path, path_item)
+    unless path_item.is_a?(Hash)
+      abort "Error: openapi.json path #{path} is a #{path_item.class}, not a path item object."
+    end
+
+    if path_item.key?('$ref')
+      abort "Error: openapi.json path #{path} is a $ref to #{path_item['$ref'].inspect}. " \
+            'This extractor cannot resolve a path-item reference, and skipping it would leave ' \
+            'every operation behind it without runtime metadata.'
+    end
+
+    # OpenAPI 3.2's `additionalOperations` is a MAP of method to Operation, not an
+    # operation. Read as one it carries no operationId, so it would drop every
+    # operation inside it without saying so. Refuse by name until the walk learns
+    # the map shape.
+    if path_item.key?('additionalOperations')
+      abort "Error: openapi.json path #{path} declares `additionalOperations`, which OpenAPI 3.2 " \
+            'defines as a map of method to Operation. This walk reads a path-item field as a ' \
+            'single operation, so it would drop every operation inside it. Teach the walk the map ' \
+            'shape, or take the field out of the spec.'
+    end
+
+    fields = path_item.keys.reject { |f| NON_OPERATION_FIELDS.include?(f) || f.start_with?('x-') }
+    fields.sort_by! { |f| [ METHOD_ORDER.index(f) || METHOD_ORDER.length, f ] }
+
+    fields.each do |field|
+      operation = path_item[field]
+
+      unless operation.is_a?(Hash)
+        abort "Error: openapi.json path #{path} field #{field.inspect} is a #{operation.class}, " \
+              'which is neither a known non-operation field nor an operation object. If a later ' \
+              'OpenAPI version added it, add it to NON_OPERATION_FIELDS with a reason.'
+      end
+
+      # An operation has to be IDENTIFIABLE. OpenAPI lets operationId be omitted,
+      # and every walker here used to step over one that was — a silent drop of a
+      # real operation, which is #925 wearing a different field.
+      op_id = operation['operationId']
+      unless op_id.is_a?(String) && !op_id.empty?
+        abort "Error: openapi.json declares #{field.upcase} #{path} with no operationId. " \
+              'Everything downstream is keyed by it, and skipping the operation would drop it ' \
+              'from the SDK in silence.'
+      end
+
+      yield field, operation
+    end
+  end
+
   private
 
   def extract_operation_metadata(operation)