basecamp-sdk 0.7.3 → 0.9.0

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

@@ -12,7 +12,7 @@ module Basecamp
       # @return [Hash] response data
       def get_my_notifications(page: nil)
         with_operation(service: "mynotifications", operation: "get_my_notifications", is_mutation: false) do
-          http_get("/my/readings.json", params: compact_params(page: page)).json
+          http_get("/my/readings.json", params: compact_query_params(page: page)).json
         end
       end
 

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

@@ -24,7 +24,7 @@ module Basecamp
       end
 
       # Update the current user's preferences
-      # @param person [String] person
+      # @param person [Hash] person
       # @return [Hash] response data
       def update_my_preferences(person:)
         with_operation(service: "people", operation: "update_my_preferences", is_mutation: true) do
@@ -85,7 +85,7 @@ module Basecamp
 
       # Enable or replace out of office for a person.
       # @param person_id [Integer] person id ID
-      # @param out_of_office [String] out of office
+      # @param out_of_office [Hash] out of office
       # @return [Hash] response data
       def enable_out_of_office(person_id:, out_of_office:)
         with_operation(service: "people", operation: "enable_out_of_office", is_mutation: true, resource_id: person_id) do

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

@@ -12,7 +12,7 @@ module Basecamp
       # @return [Enumerator<Hash>] paginated results
       def list(status: nil)
         wrap_paginated(service: "projects", operation: "list", is_mutation: false) do
-          params = compact_params(status: status)
+          params = compact_query_params(status: status)
           paginate("/projects.json", params: params)
         end
       end
@@ -41,7 +41,7 @@ module Basecamp
       # @param name [String] name
       # @param description [String, nil] description
       # @param admissions [String, nil] invite|employee|team
-      # @param schedule_attributes [String, nil] schedule attributes
+      # @param schedule_attributes [Hash, nil] schedule attributes
       # @return [Hash] response data
       def update(project_id:, name:, description: nil, admissions: nil, schedule_attributes: nil)
         with_operation(service: "projects", operation: "update", is_mutation: true, project_id: project_id) do

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

@@ -16,7 +16,7 @@ module Basecamp
       # @return [Enumerator<Hash>] paginated results
       def list(type:, bucket: nil, status: nil, sort: nil, direction: nil)
         wrap_paginated(service: "recordings", operation: "list", is_mutation: false) do
-          params = compact_params(type: type, bucket: bucket, status: status, sort: sort, direction: direction)
+          params = compact_query_params(type: type, bucket: bucket, status: status, sort: sort, direction: direction)
           paginate("/projects/recordings.json", params: params)
         end
       end

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

@@ -15,13 +15,13 @@ module Basecamp
         end
       end
 
-      # Get upcoming schedule entries within a date window
+      # Get upcoming schedule entries and assignable items within a date window.
       # @param window_starts_on [String, nil] window starts on
       # @param window_ends_on [String, nil] window ends on
       # @return [Hash] response data
       def upcoming(window_starts_on: nil, window_ends_on: nil)
         with_operation(service: "reports", operation: "upcoming", is_mutation: false) do
-          http_get("/reports/schedules/upcoming.json", params: compact_params(window_starts_on: window_starts_on, window_ends_on: window_ends_on)).json
+          http_get("/reports/schedules/upcoming.json", params: compact_query_params(window_starts_on: window_starts_on, window_ends_on: window_ends_on)).json
         end
       end
 
@@ -31,7 +31,7 @@ module Basecamp
       # @return [Hash] response data
       def assigned(person_id:, group_by: nil)
         with_operation(service: "reports", operation: "assigned", is_mutation: false, resource_id: person_id) do
-          http_get("/reports/todos/assigned/#{person_id}", params: compact_params(group_by: group_by)).json
+          http_get("/reports/todos/assigned/#{person_id}", params: compact_query_params(group_by: group_by)).json
         end
       end
 

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

@@ -37,7 +37,7 @@ module Basecamp
       # @param date [String] date ID
       # @return [Hash] response data
       def get_entry_occurrence(entry_id:, date:)
-        with_operation(service: "schedules", operation: "get_entry_occurrence", is_mutation: false, resource_id: date) do
+        with_operation(service: "schedules", operation: "get_entry_occurrence", is_mutation: false, resource_id: entry_id) do
           http_get("/schedule_entries/#{entry_id}/occurrences/#{date}").json
         end
       end
@@ -67,7 +67,7 @@ module Basecamp
       # @return [Enumerator<Hash>] paginated results
       def list_entries(schedule_id:, status: nil)
         wrap_paginated(service: "schedules", operation: "list_entries", is_mutation: false, resource_id: schedule_id) do
-          params = compact_params(status: status)
+          params = compact_query_params(status: status)
           paginate("/schedules/#{schedule_id}/entries.json", params: params)
         end
       end
@@ -82,10 +82,11 @@ module Basecamp
       # @param all_day [Boolean, nil] all day
       # @param notify [Boolean, nil] notify
       # @param subscriptions [Array, nil] subscriptions
+      # @param visible_to_clients [Boolean, nil] visible to clients
       # @return [Hash] response data
-      def create_entry(schedule_id:, summary:, starts_at:, ends_at:, description: nil, participant_ids: nil, all_day: nil, notify: nil, subscriptions: nil)
+      def create_entry(schedule_id:, summary:, starts_at:, ends_at:, description: nil, participant_ids: nil, all_day: nil, notify: nil, subscriptions: nil, visible_to_clients: nil)
         with_operation(service: "schedules", operation: "create_entry", is_mutation: true, resource_id: schedule_id) do
-          http_post("/schedules/#{schedule_id}/entries.json", body: compact_params(summary: summary, starts_at: starts_at, ends_at: ends_at, description: description, participant_ids: participant_ids, all_day: all_day, notify: notify, subscriptions: subscriptions)).json
+          http_post("/schedules/#{schedule_id}/entries.json", body: compact_params(summary: summary, starts_at: starts_at, ends_at: ends_at, description: description, participant_ids: participant_ids, all_day: all_day, notify: notify, subscriptions: subscriptions, visible_to_clients: visible_to_clients)).json
         end
       end
     end

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

@@ -9,11 +9,22 @@ module Basecamp
 
       # Search for content across the account
       # @param q [String] q
-      # @param sort [String, nil] best_match|created_at
+      # @param type_names [Array, nil] Recording types to include. Use `key` values from the metadata
+      #   endpoint's `recording_search_types`. Available since Basecamp 5.
+      # @param bucket_ids [Array, nil] Project IDs to filter by. Available since Basecamp 5.
+      # @param creator_ids [Array, nil] Creator person IDs to filter by. Available since Basecamp 5.
+      # @param file_type [String, nil] Filter attachments by type. Use `key` values from the metadata
+      #   endpoint's `file_search_types`.
+      # @param exclude_chat [Boolean, nil] Set to true to exclude chat results.
+      # @param since [String, nil] last_7_days|last_30_days|last_90_days|last_12_months|forever
+      # @param sort [String, nil] best_match|recency
+      # @param type [String, nil] Deprecated: prefer type_names[].
+      # @param bucket_id [Integer, nil] Deprecated: prefer bucket_ids[].
+      # @param creator_id [Integer, nil] Deprecated: prefer creator_ids[].
       # @return [Enumerator<Hash>] paginated results
-      def search(q:, sort: nil)
+      def search(q:, type_names: nil, bucket_ids: nil, creator_ids: nil, file_type: nil, exclude_chat: nil, since: nil, sort: nil, type: nil, bucket_id: nil, creator_id: nil)
         wrap_paginated(service: "search", operation: "search", is_mutation: false) do
-          params = compact_params(q: q, sort: sort)
+          params = compact_query_params(q: q, type_names: type_names, bucket_ids: bucket_ids, creator_ids: creator_ids, file_type: file_type, exclude_chat: exclude_chat, since: since, sort: sort, type: type, bucket_id: bucket_id, creator_id: creator_id)
           paginate("/search.json", params: params)
         end
       end

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

@@ -12,7 +12,7 @@ module Basecamp
       # @return [Enumerator<Hash>] paginated results
       def list(status: nil)
         wrap_paginated(service: "templates", operation: "list", is_mutation: false) do
-          params = compact_params(status: status)
+          params = compact_query_params(status: status)
           paginate("/templates.json", params: params)
         end
       end
@@ -59,12 +59,11 @@ module Basecamp
 
       # Create a project from a template (asynchronous)
       # @param template_id [Integer] template id ID
-      # @param name [String] name
-      # @param description [String, nil] description
+      # @param project [Hash] project
       # @return [Hash] response data
-      def create_project(template_id:, name:, description: nil)
+      def create_project(template_id:, project:)
         with_operation(service: "templates", operation: "create_project", is_mutation: true, resource_id: template_id) do
-          http_post("/templates/#{template_id}/project_constructions.json", body: compact_params(name: name, description: description)).json
+          http_post("/templates/#{template_id}/project_constructions.json", body: compact_params(project: project)).json
         end
       end
 

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

@@ -15,7 +15,7 @@ module Basecamp
       # @return [Enumerator<Hash>] paginated results
       def for_project(project_id:, from: nil, to: nil, person_id: nil)
         wrap_paginated(service: "timesheets", operation: "for_project", is_mutation: false, project_id: project_id) do
-          params = compact_params(from: from, to: to, person_id: person_id)
+          params = compact_query_params(from: from, to: to, person_id: person_id)
           paginate("/projects/#{project_id}/timesheet.json", params: params)
         end
       end
@@ -28,7 +28,7 @@ module Basecamp
       # @return [Enumerator<Hash>] paginated results
       def for_recording(recording_id:, from: nil, to: nil, person_id: nil)
         wrap_paginated(service: "timesheets", operation: "for_recording", is_mutation: false, resource_id: recording_id) do
-          params = compact_params(from: from, to: to, person_id: person_id)
+          params = compact_query_params(from: from, to: to, person_id: person_id)
           paginate("/recordings/#{recording_id}/timesheet.json", params: params)
         end
       end
@@ -53,7 +53,7 @@ module Basecamp
       # @return [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_params(from: from, to: to, person_id: person_id)).json
+          http_get("/reports/timesheet.json", params: compact_query_params(from: from, to: to, person_id: person_id)).json
         end
       end
 

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

@@ -27,13 +27,24 @@ module Basecamp
         end
       end
 
+      # Reposition a to-do list within its to-do set.
+      # @param todolist_id [Integer] todolist id ID
+      # @param position [Integer] position
+      # @return [void]
+      def reposition(todolist_id:, position:)
+        with_operation(service: "todolists", operation: "reposition", is_mutation: true, resource_id: todolist_id) do
+          http_put("/todosets/todolists/#{todolist_id}/position.json", body: compact_params(position: position))
+          nil
+        end
+      end
+
       # List todolists in a todoset
       # @param todoset_id [Integer] todoset id ID
       # @param status [String, nil] active|archived|trashed
       # @return [Enumerator<Hash>] paginated results
       def list(todoset_id:, status: nil)
         wrap_paginated(service: "todolists", operation: "list", is_mutation: false, resource_id: todoset_id) do
-          params = compact_params(status: status)
+          params = compact_query_params(status: status)
           paginate("/todosets/#{todoset_id}/todolists.json", params: params)
         end
       end
@@ -42,10 +53,11 @@ module Basecamp
       # @param todoset_id [Integer] todoset id ID
       # @param name [String] name
       # @param description [String, nil] description
+      # @param visible_to_clients [Boolean, nil] visible to clients
       # @return [Hash] response data
-      def create(todoset_id:, name:, description: nil)
+      def create(todoset_id:, name:, description: nil, visible_to_clients: nil)
         with_operation(service: "todolists", operation: "create", is_mutation: true, resource_id: todoset_id) do
-          http_post("/todosets/#{todoset_id}/todolists.json", body: compact_params(name: name, description: description)).json
+          http_post("/todosets/#{todoset_id}/todolists.json", body: compact_params(name: name, description: description, visible_to_clients: visible_to_clients)).json
         end
       end
     end

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

@@ -14,7 +14,7 @@ module Basecamp
       # @return [Enumerator<Hash>] paginated results
       def list(todolist_id:, status: nil, completed: nil)
         wrap_paginated(service: "todos", operation: "list", is_mutation: false, resource_id: todolist_id) do
-          params = compact_params(status: status, completed: completed)
+          params = compact_query_params(status: status, completed: completed)
           paginate("/todolists/#{todolist_id}/todos.json", params: params)
         end
       end
@@ -44,9 +44,9 @@ module Basecamp
         end
       end
 
-      # Update an existing todo
+      # Replace a todo with a new complete representation.
       # @param todo_id [Integer] todo id ID
-      # @param content [String, nil] content
+      # @param content [String] content
       # @param description [String, nil] description
       # @param assignee_ids [Array, nil] assignee ids
       # @param completion_subscriber_ids [Array, nil] completion subscriber ids
@@ -54,8 +54,8 @@ module Basecamp
       # @param due_on [String, nil] due on (YYYY-MM-DD)
       # @param starts_on [String, nil] starts on (YYYY-MM-DD)
       # @return [Hash] response data
-      def update(todo_id:, content: nil, description: nil, assignee_ids: nil, completion_subscriber_ids: nil, notify: nil, due_on: nil, starts_on: nil)
-        with_operation(service: "todos", operation: "update", is_mutation: true, resource_id: todo_id) do
+      def replace(todo_id:, content:, description: nil, assignee_ids: nil, completion_subscriber_ids: nil, notify: nil, due_on: nil, starts_on: nil)
+        with_operation(service: "todos", operation: "replace", is_mutation: true, resource_id: todo_id) do
           http_put("/todos/#{todo_id}", body: compact_params(content: content, description: description, assignee_ids: assignee_ids, completion_subscriber_ids: completion_subscriber_ids, notify: notify, due_on: due_on, starts_on: starts_on)).json
         end
       end

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

@@ -7,13 +7,14 @@ module Basecamp
     # @generated from OpenAPI spec
     class ToolsService < BaseService
 
-      # Clone an existing tool to create a new one
-      # @param source_recording_id [Integer] source recording id
-      # @param title [String, nil] title
+      # Create a tool in a project dock
+      # @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.
       # @return [Hash] response data
-      def clone(source_recording_id:, title: nil)
-        with_operation(service: "tools", operation: "clone", is_mutation: true) do
-          http_post("/dock/tools.json", body: compact_params(source_recording_id: source_recording_id, title: title)).json
+      def create(bucket_id:, tool_type:, title: 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
         end
       end
 

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

@@ -51,10 +51,28 @@ module Basecamp
       # @param description [String, nil] description
       # @param base_name [String, nil] base name
       # @param subscriptions [Array, nil] subscriptions
+      # @param visible_to_clients [Boolean, nil] visible to clients
       # @return [Hash] response data
-      def create(vault_id:, attachable_sgid:, description: nil, base_name: nil, subscriptions: nil)
+      def create(vault_id:, attachable_sgid:, description: nil, base_name: nil, subscriptions: nil, visible_to_clients: nil)
         with_operation(service: "uploads", operation: "create", is_mutation: true, resource_id: vault_id) do
-          http_post("/vaults/#{vault_id}/uploads.json", body: compact_params(attachable_sgid: attachable_sgid, description: description, base_name: base_name, subscriptions: subscriptions)).json
+          http_post("/vaults/#{vault_id}/uploads.json", body: compact_params(attachable_sgid: attachable_sgid, description: description, base_name: base_name, subscriptions: subscriptions, visible_to_clients: visible_to_clients)).json
+        end
+      end
+
+      # Download an upload's file content in one call.
+      # Fetches upload metadata, then delegates to the AccountClient download
+      # primitive so the auth'd-hop + 302-follow flow lives in one place.
+      # @param upload_id [Integer] upload id ID
+      # @return [Basecamp::DownloadResult]
+      def download(upload_id:)
+        with_operation(service: "uploads", operation: "download", is_mutation: false, resource_id: upload_id) do
+          upload = get(upload_id: upload_id)
+          url = upload["download_url"]
+          raise UsageError.new("upload #{upload_id} has no download_url") if url.nil? || url.empty?
+
+          result = @client.download_url(url)
+          filename = upload["filename"]
+          filename.to_s.empty? ? result : result.with(filename: filename)
         end
       end
     end

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

@@ -11,7 +11,7 @@ module Basecamp
       # @param bucket_id [Integer] bucket id ID
       # @return [Enumerator<Hash>] paginated results
       def list(bucket_id:)
-        wrap_paginated(service: "webhooks", operation: "list", is_mutation: false, resource_id: bucket_id) do
+        wrap_paginated(service: "webhooks", operation: "list", is_mutation: false, project_id: bucket_id) do
           paginate("/buckets/#{bucket_id}/webhooks.json")
         end
       end
@@ -23,7 +23,7 @@ module Basecamp
       # @param active [Boolean, nil] active
       # @return [Hash] response data
       def create(bucket_id:, payload_url:, types:, active: nil)
-        with_operation(service: "webhooks", operation: "create", is_mutation: true, resource_id: bucket_id) do
+        with_operation(service: "webhooks", operation: "create", is_mutation: true, project_id: bucket_id) do
           http_post("/buckets/#{bucket_id}/webhooks.json", body: compact_params(payload_url: payload_url, types: types, active: active)).json
         end
       end

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Basecamp
+  module Services
+    # Service for Wormholes operations
+    #
+    # @generated from OpenAPI spec
+    class WormholesService < BaseService
+
+      # Update a wormhole's destination column
+      # @param bucket_id [Integer] bucket id ID
+      # @param wormhole_id [Integer] wormhole id ID
+      # @param destination_recording_id [Integer] Id of the new destination column (on another accessible card table).
+      # @return [Hash] response data
+      def update(bucket_id:, wormhole_id:, destination_recording_id:)
+        with_operation(service: "wormholes", operation: "update", is_mutation: true, project_id: bucket_id, resource_id: wormhole_id) do
+          http_put("/buckets/#{bucket_id}/card_tables/wormholes/#{wormhole_id}", body: compact_params(destination_recording_id: destination_recording_id)).json
+        end
+      end
+
+      # Delete a wormhole
+      # @param bucket_id [Integer] bucket id ID
+      # @param wormhole_id [Integer] wormhole id ID
+      # @return [void]
+      def delete(bucket_id:, wormhole_id:)
+        with_operation(service: "wormholes", operation: "delete", is_mutation: true, project_id: bucket_id, resource_id: wormhole_id) do
+          http_delete("/buckets/#{bucket_id}/card_tables/wormholes/#{wormhole_id}")
+          nil
+        end
+      end
+
+      # Create a wormhole linking this card table to a column on another card table.
+      # @param bucket_id [Integer] bucket id ID
+      # @param card_table_id [Integer] card table id ID
+      # @param destination_recording_id [Integer] Id of the destination column (on another accessible card table) to link to.
+      # @return [Hash] response data
+      def create(bucket_id:, card_table_id:, destination_recording_id:)
+        with_operation(service: "wormholes", operation: "create", is_mutation: true, project_id: bucket_id, resource_id: card_table_id) do
+          http_post("/buckets/#{bucket_id}/card_tables/#{card_table_id}/wormholes.json", body: compact_params(destination_recording_id: destination_recording_id)).json
+        end
+      end
+    end
+  end
+end