basecamp-sdk 0.9.0 → 0.10.0

data/lib/basecamp/generated/services/message_types_service.rb

@@ -8,49 +8,54 @@ module Basecamp
     class MessageTypesService < BaseService
 
       # List message types in a project
+      # @param bucket_id [Integer] bucket id ID
       # @return [Enumerator<Hash>] paginated results
-      def list()
-        wrap_paginated(service: "messagetypes", operation: "list", is_mutation: false) do
-          paginate("/categories.json")
+      def list(bucket_id:)
+        wrap_paginated(service: "messagetypes", operation: "list", is_mutation: false, project_id: bucket_id) do
+          paginate("/buckets/#{bucket_id}/categories.json")
         end
       end
 
       # Create a new message type in a project
+      # @param bucket_id [Integer] bucket id ID
       # @param name [String] name
       # @param icon [String] icon
       # @return [Hash] response data
-      def create(name:, icon:)
-        with_operation(service: "messagetypes", operation: "create", is_mutation: true) do
-          http_post("/categories.json", body: compact_params(name: name, icon: icon)).json
+      def create(bucket_id:, name:, icon:)
+        with_operation(service: "messagetypes", operation: "create", is_mutation: true, project_id: bucket_id) do
+          http_post("/buckets/#{bucket_id}/categories.json", body: compact_params(name: name, icon: icon)).json
         end
       end
 
       # Get a single message type by id
+      # @param bucket_id [Integer] bucket id ID
       # @param type_id [Integer] type id ID
       # @return [Hash] response data
-      def get(type_id:)
-        with_operation(service: "messagetypes", operation: "get", is_mutation: false, resource_id: type_id) do
-          http_get("/categories/#{type_id}").json
+      def get(bucket_id:, type_id:)
+        with_operation(service: "messagetypes", operation: "get", is_mutation: false, project_id: bucket_id, resource_id: type_id) do
+          http_get("/buckets/#{bucket_id}/categories/#{type_id}").json
         end
       end
 
       # Update an existing message type
+      # @param bucket_id [Integer] bucket id ID
       # @param type_id [Integer] type id ID
       # @param name [String, nil] name
       # @param icon [String, nil] icon
       # @return [Hash] response data
-      def update(type_id:, name: nil, icon: nil)
-        with_operation(service: "messagetypes", operation: "update", is_mutation: true, resource_id: type_id) do
-          http_put("/categories/#{type_id}", body: compact_params(name: name, icon: icon)).json
+      def update(bucket_id:, type_id:, name: nil, icon: nil)
+        with_operation(service: "messagetypes", operation: "update", is_mutation: true, project_id: bucket_id, resource_id: type_id) do
+          http_put("/buckets/#{bucket_id}/categories/#{type_id}", body: compact_params(name: name, icon: icon)).json
         end
       end
 
       # Delete a message type
+      # @param bucket_id [Integer] bucket id ID
       # @param type_id [Integer] type id ID
       # @return [void]
-      def delete(type_id:)
-        with_operation(service: "messagetypes", operation: "delete", is_mutation: true, resource_id: type_id) do
-          http_delete("/categories/#{type_id}")
+      def delete(bucket_id:, type_id:)
+        with_operation(service: "messagetypes", operation: "delete", is_mutation: true, project_id: bucket_id, resource_id: type_id) do
+          http_delete("/buckets/#{bucket_id}/categories/#{type_id}")
           nil
         end
       end

data/lib/basecamp/generated/services/my_assignments_service.rb

@@ -16,7 +16,7 @@ module Basecamp
       end
 
       # Get the current user's completed assignments.
-      # @return [Hash] response data
+      # @return [Array<Hash>] response data
       def get_my_completed_assignments()
         with_operation(service: "myassignments", operation: "get_my_completed_assignments", is_mutation: false) do
           http_get("/my/assignments/completed.json").json
@@ -26,7 +26,7 @@ module Basecamp
       # Get the current user's assignments filtered by due date scope.
       # @param scope [String, nil] Filter by due date range: overdue, due_today, due_tomorrow,
       #   due_later_this_week, due_next_week, due_later
-      # @return [Hash] response data
+      # @return [Array<Hash>] response data
       def get_my_due_assignments(scope: nil)
         with_operation(service: "myassignments", operation: "get_my_due_assignments", is_mutation: false) do
           http_get("/my/assignments/due.json", params: compact_query_params(scope: scope)).json

data/lib/basecamp/generated/services/my_notifications_service.rb

@@ -9,10 +9,24 @@ module Basecamp
 
       # Get the current user's notification inbox (the "Hey!" menu).
       # @param page [Integer, nil] Page number for paginating through read items. Defaults to 1.
+      # @param limit_bubble_ups [Boolean, nil] Set to true to cap `bubble_ups` at 2 current bubble-ups and omit the
+      #   `scheduled_bubble_ups` key entirely. Defaults to false. Use the dedicated
+      #   bubble-ups endpoint (GetBubbleUps) to page through all current and
+      #   scheduled bubble-ups.
       # @return [Hash] response data
-      def get_my_notifications(page: nil)
+      def get_my_notifications(page: nil, limit_bubble_ups: nil)
         with_operation(service: "mynotifications", operation: "get_my_notifications", is_mutation: false) do
-          http_get("/my/readings.json", params: compact_query_params(page: page)).json
+          http_get("/my/readings.json", params: compact_query_params(page: page, limit_bubble_ups: limit_bubble_ups)).json
+        end
+      end
+
+      # Get the current user's current and scheduled bubble-ups (paginated, 50 per page).
+      # @param page [Integer, nil] Page number. Defaults to 1.
+      # @return [Enumerator<Hash>] paginated results
+      def get_bubble_ups(page: nil)
+        wrap_paginated(service: "mynotifications", operation: "get_bubble_ups", is_mutation: false) do
+          params = compact_query_params(page: page)
+          paginate("/my/readings/bubble_ups.json", params: params)
         end
       end
 

data/lib/basecamp/generated/services/people_service.rb

@@ -125,7 +125,7 @@ module Basecamp
       end
 
       # List people who can be assigned todos
-      # @return [Hash] response data
+      # @return [Array<Hash>] response data
       def list_assignable()
         with_operation(service: "people", operation: "list_assignable", is_mutation: false) do
           http_get("/reports/todos/assigned.json").json

data/lib/basecamp/generated/services/recordings_service.rb

@@ -8,7 +8,7 @@ module Basecamp
     class RecordingsService < BaseService
 
       # List recordings of a given type across projects
-      # @param type [String] Comment|Document|Kanban::Card|Kanban::Step|Message|Question::Answer|Schedule::Entry|Todo|Todolist|Upload|Vault
+      # @param type [String] Comment|Document|Door|Kanban::Card|Kanban::Step|Message|Question::Answer|Schedule::Entry|Todo|Todolist|Upload|Vault
       # @param bucket [String, nil] bucket
       # @param status [String, nil] active|archived|trashed
       # @param sort [String, nil] created_at|updated_at

data/lib/basecamp/generated/services/schedules_service.rb

@@ -22,7 +22,15 @@ module Basecamp
       # @param starts_at [String, nil] starts at (RFC3339 (e.g., 2024-12-15T09:00:00Z))
       # @param ends_at [String, nil] ends at (RFC3339 (e.g., 2024-12-15T09:00:00Z))
       # @param description [String, nil] description
-      # @param participant_ids [Array, nil] participant ids
+      # @param participant_ids [Array, nil] Replaces the entry's participants.
+      #   
+      #   Omitting this member preserves the current participants; sending an empty
+      #   array clears them. That guarantee is BC3-side and recent: until
+      #   basecamp/bc3#12425, `Schedules::EntriesController#update` called
+      #   `replace_participants` unconditionally, so any update omitting the key —
+      #   including the shape in BC3's own "Update a schedule entry" doc example —
+      #   silently removed every participant and notified each one. The controller
+      #   now guards on the request actually addressing participants.
       # @param all_day [Boolean, nil] all day
       # @param notify [Boolean, nil] notify
       # @return [Hash] response data

data/lib/basecamp/generated/services/timesheets_service.rb

@@ -50,7 +50,7 @@ module Basecamp
       # @param from [String, nil] from
       # @param to [String, nil] to
       # @param person_id [Integer, nil] person id
-      # @return [Hash] response data
+      # @return [Array<Hash>] response data
       def report(from: nil, to: nil, person_id: nil)
         with_operation(service: "timesheets", operation: "report", is_mutation: false) do
           http_get("/reports/timesheet.json", params: compact_query_params(from: from, to: to, person_id: person_id)).json

data/lib/basecamp/generated/services/tools_service.rb

@@ -11,10 +11,11 @@ module Basecamp
       # @param bucket_id [Integer] bucket id ID
       # @param tool_type [String] Tool type to add to the project dock. Values: Chat::Transcript|Inbox|Kanban::Board|Message::Board|Questionnaire|Schedule|Todoset|Vault.
       # @param title [String, nil] Title for the new tool. When omitted, Basecamp assigns the next available default title for the tool type.
+      # @param visible_to_clients [Boolean, nil] Create the tool already visible to clients. Honored only for tool types that manage their own client visibility (Chat::Transcript, Kanban::Board), which otherwise start hidden; every other tool type ignores it and inherits the project default.
       # @return [Hash] response data
-      def create(bucket_id:, tool_type:, title: nil)
+      def create(bucket_id:, tool_type:, title: nil, visible_to_clients: nil)
         with_operation(service: "tools", operation: "create", is_mutation: true, project_id: bucket_id) do
-          http_post("/buckets/#{bucket_id}/dock/tools.json", body: compact_params(tool_type: tool_type, title: title)).json
+          http_post("/buckets/#{bucket_id}/dock/tools.json", body: compact_params(tool_type: tool_type, title: title, visible_to_clients: visible_to_clients)).json
         end
       end