basecamp-sdk 0.2.1

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Basecamp
+  module Services
+    # Service for ClientCorrespondences operations
+    #
+    # @generated from OpenAPI spec
+    class ClientCorrespondencesService < BaseService
+
+      # List all client correspondences in a project
+      # @return [Enumerator<Hash>] paginated results
+      def list()
+        wrap_paginated(service: "clientcorrespondences", operation: "list", is_mutation: false) do
+          paginate("/client/correspondences.json")
+        end
+      end
+
+      # Get a single client correspondence by id
+      # @param correspondence_id [Integer] correspondence id ID
+      # @return [Hash] response data
+      def get(correspondence_id:)
+        with_operation(service: "clientcorrespondences", operation: "get", is_mutation: false, resource_id: correspondence_id) do
+          http_get("/client/correspondences/#{correspondence_id}").json
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Basecamp
+  module Services
+    # Service for ClientReplies operations
+    #
+    # @generated from OpenAPI spec
+    class ClientRepliesService < BaseService
+
+      # List all client replies for a recording (correspondence or approval)
+      # @param recording_id [Integer] recording id ID
+      # @return [Enumerator<Hash>] paginated results
+      def list(recording_id:)
+        wrap_paginated(service: "clientreplies", operation: "list", is_mutation: false, resource_id: recording_id) do
+          paginate("/client/recordings/#{recording_id}/replies.json")
+        end
+      end
+
+      # Get a single client reply by id
+      # @param recording_id [Integer] recording id ID
+      # @param reply_id [Integer] reply id ID
+      # @return [Hash] response data
+      def get(recording_id:, reply_id:)
+        with_operation(service: "clientreplies", operation: "get", is_mutation: false, resource_id: reply_id) do
+          http_get("/client/recordings/#{recording_id}/replies/#{reply_id}").json
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Basecamp
+  module Services
+    # Service for ClientVisibility operations
+    #
+    # @generated from OpenAPI spec
+    class ClientVisibilityService < BaseService
+
+      # Set client visibility for a recording
+      # @param recording_id [Integer] recording id ID
+      # @param visible_to_clients [Boolean] visible to clients
+      # @return [Hash] response data
+      def set_visibility(recording_id:, visible_to_clients:)
+        with_operation(service: "clientvisibility", operation: "set_visibility", is_mutation: true, resource_id: recording_id) do
+          http_put("/recordings/#{recording_id}/client_visibility.json", body: compact_params(visible_to_clients: visible_to_clients)).json
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Basecamp
+  module Services
+    # Service for Comments operations
+    #
+    # @generated from OpenAPI spec
+    class CommentsService < BaseService
+
+      # Get a single comment by id
+      # @param comment_id [Integer] comment id ID
+      # @return [Hash] response data
+      def get(comment_id:)
+        with_operation(service: "comments", operation: "get", is_mutation: false, resource_id: comment_id) do
+          http_get("/comments/#{comment_id}").json
+        end
+      end
+
+      # Update an existing comment
+      # @param comment_id [Integer] comment id ID
+      # @param content [String] content
+      # @return [Hash] response data
+      def update(comment_id:, content:)
+        with_operation(service: "comments", operation: "update", is_mutation: true, resource_id: comment_id) do
+          http_put("/comments/#{comment_id}", body: compact_params(content: content)).json
+        end
+      end
+
+      # List comments on a recording
+      # @param recording_id [Integer] recording id ID
+      # @return [Enumerator<Hash>] paginated results
+      def list(recording_id:)
+        wrap_paginated(service: "comments", operation: "list", is_mutation: false, resource_id: recording_id) do
+          paginate("/recordings/#{recording_id}/comments.json")
+        end
+      end
+
+      # Create a new comment on a recording
+      # @param recording_id [Integer] recording id ID
+      # @param content [String] content
+      # @return [Hash] response data
+      def create(recording_id:, content:)
+        with_operation(service: "comments", operation: "create", is_mutation: true, resource_id: recording_id) do
+          http_post("/recordings/#{recording_id}/comments.json", body: compact_params(content: content)).json
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Basecamp
+  module Services
+    # Service for Documents operations
+    #
+    # @generated from OpenAPI spec
+    class DocumentsService < BaseService
+
+      # Get a single document by id
+      # @param document_id [Integer] document id ID
+      # @return [Hash] response data
+      def get(document_id:)
+        with_operation(service: "documents", operation: "get", is_mutation: false, resource_id: document_id) do
+          http_get("/documents/#{document_id}").json
+        end
+      end
+
+      # Update an existing document
+      # @param document_id [Integer] document id ID
+      # @param title [String, nil] title
+      # @param content [String, nil] content
+      # @return [Hash] response data
+      def update(document_id:, title: nil, content: nil)
+        with_operation(service: "documents", operation: "update", is_mutation: true, resource_id: document_id) do
+          http_put("/documents/#{document_id}", body: compact_params(title: title, content: content)).json
+        end
+      end
+
+      # List documents in a vault
+      # @param vault_id [Integer] vault id ID
+      # @return [Enumerator<Hash>] paginated results
+      def list(vault_id:)
+        wrap_paginated(service: "documents", operation: "list", is_mutation: false, resource_id: vault_id) do
+          paginate("/vaults/#{vault_id}/documents.json")
+        end
+      end
+
+      # Create a new document in a vault
+      # @param vault_id [Integer] vault id ID
+      # @param title [String] title
+      # @param content [String, nil] content
+      # @param status [String, nil] active|drafted
+      # @return [Hash] response data
+      def create(vault_id:, title:, content: nil, status: nil)
+        with_operation(service: "documents", operation: "create", is_mutation: true, resource_id: vault_id) do
+          http_post("/vaults/#{vault_id}/documents.json", body: compact_params(title: title, content: content, status: status)).json
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Basecamp
+  module Services
+    # Service for Events operations
+    #
+    # @generated from OpenAPI spec
+    class EventsService < BaseService
+
+      # List all events for a recording
+      # @param recording_id [Integer] recording id ID
+      # @return [Enumerator<Hash>] paginated results
+      def list(recording_id:)
+        wrap_paginated(service: "events", operation: "list", is_mutation: false, resource_id: recording_id) do
+          paginate("/recordings/#{recording_id}/events.json")
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Basecamp
+  module Services
+    # Service for Forwards operations
+    #
+    # @generated from OpenAPI spec
+    class ForwardsService < BaseService
+
+      # Get a forward by ID
+      # @param forward_id [Integer] forward id ID
+      # @return [Hash] response data
+      def get(forward_id:)
+        with_operation(service: "forwards", operation: "get", is_mutation: false, resource_id: forward_id) do
+          http_get("/inbox_forwards/#{forward_id}").json
+        end
+      end
+
+      # List all replies to a forward
+      # @param forward_id [Integer] forward id ID
+      # @return [Enumerator<Hash>] paginated results
+      def list_replies(forward_id:)
+        wrap_paginated(service: "forwards", operation: "list_replies", is_mutation: false, resource_id: forward_id) do
+          paginate("/inbox_forwards/#{forward_id}/replies.json")
+        end
+      end
+
+      # Create a reply to a forward
+      # @param forward_id [Integer] forward id ID
+      # @param content [String] content
+      # @return [Hash] response data
+      def create_reply(forward_id:, content:)
+        with_operation(service: "forwards", operation: "create_reply", is_mutation: true, resource_id: forward_id) do
+          http_post("/inbox_forwards/#{forward_id}/replies.json", body: compact_params(content: content)).json
+        end
+      end
+
+      # Get a forward reply by ID
+      # @param forward_id [Integer] forward id ID
+      # @param reply_id [Integer] reply id ID
+      # @return [Hash] response data
+      def get_reply(forward_id:, reply_id:)
+        with_operation(service: "forwards", operation: "get_reply", is_mutation: false, resource_id: reply_id) do
+          http_get("/inbox_forwards/#{forward_id}/replies/#{reply_id}").json
+        end
+      end
+
+      # Get an inbox by ID
+      # @param inbox_id [Integer] inbox id ID
+      # @return [Hash] response data
+      def get_inbox(inbox_id:)
+        with_operation(service: "forwards", operation: "get_inbox", is_mutation: false, resource_id: inbox_id) do
+          http_get("/inboxes/#{inbox_id}").json
+        end
+      end
+
+      # List all forwards in an inbox
+      # @param inbox_id [Integer] inbox id ID
+      # @return [Enumerator<Hash>] paginated results
+      def list(inbox_id:)
+        wrap_paginated(service: "forwards", operation: "list", is_mutation: false, resource_id: inbox_id) do
+          paginate("/inboxes/#{inbox_id}/forwards.json")
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Basecamp
+  module Services
+    # Service for Lineup operations
+    #
+    # @generated from OpenAPI spec
+    class LineupService < BaseService
+
+      # Create a new lineup marker
+      # @param name [String] name
+      # @param date [String] date
+      # @return [void]
+      def create(name:, date:)
+        with_operation(service: "lineup", operation: "create", is_mutation: true) do
+          http_post("/lineup/markers.json", body: compact_params(name: name, date: date))
+          nil
+        end
+      end
+
+      # Update an existing lineup marker
+      # @param marker_id [Integer] marker id ID
+      # @param name [String, nil] name
+      # @param date [String, nil] date
+      # @return [void]
+      def update(marker_id:, name: nil, date: nil)
+        with_operation(service: "lineup", operation: "update", is_mutation: true, resource_id: marker_id) do
+          http_put("/lineup/markers/#{marker_id}", body: compact_params(name: name, date: date))
+          nil
+        end
+      end
+
+      # Delete a lineup marker
+      # @param marker_id [Integer] marker id ID
+      # @return [void]
+      def delete(marker_id:)
+        with_operation(service: "lineup", operation: "delete", is_mutation: true, resource_id: marker_id) do
+          http_delete("/lineup/markers/#{marker_id}")
+          nil
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Basecamp
+  module Services
+    # Service for MessageBoards operations
+    #
+    # @generated from OpenAPI spec
+    class MessageBoardsService < BaseService
+
+      # Get a message board
+      # @param board_id [Integer] board id ID
+      # @return [Hash] response data
+      def get(board_id:)
+        with_operation(service: "messageboards", operation: "get", is_mutation: false, resource_id: board_id) do
+          http_get("/message_boards/#{board_id}").json
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Basecamp
+  module Services
+    # Service for MessageTypes operations
+    #
+    # @generated from OpenAPI spec
+    class MessageTypesService < BaseService
+
+      # List message types in a project
+      # @return [Enumerator<Hash>] paginated results
+      def list()
+        wrap_paginated(service: "messagetypes", operation: "list", is_mutation: false) do
+          paginate("/categories.json")
+        end
+      end
+
+      # Create a new message type in a project
+      # @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
+        end
+      end
+
+      # Get a single message type by 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
+        end
+      end
+
+      # Update an existing message type
+      # @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
+        end
+      end
+
+      # Delete a message type
+      # @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}")
+          nil
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Basecamp
+  module Services
+    # Service for Messages operations
+    #
+    # @generated from OpenAPI spec
+    class MessagesService < BaseService
+
+      # List messages on a message board
+      # @param board_id [Integer] board id ID
+      # @return [Enumerator<Hash>] paginated results
+      def list(board_id:)
+        wrap_paginated(service: "messages", operation: "list", is_mutation: false, resource_id: board_id) do
+          paginate("/message_boards/#{board_id}/messages.json")
+        end
+      end
+
+      # Create a new message on a message board
+      # @param board_id [Integer] board id ID
+      # @param subject [String] subject
+      # @param content [String, nil] content
+      # @param status [String, nil] active|drafted
+      # @param category_id [Integer, nil] category id
+      # @return [Hash] response data
+      def create(board_id:, subject:, content: nil, status: nil, category_id: nil)
+        with_operation(service: "messages", operation: "create", is_mutation: true, resource_id: board_id) do
+          http_post("/message_boards/#{board_id}/messages.json", body: compact_params(subject: subject, content: content, status: status, category_id: category_id)).json
+        end
+      end
+
+      # Get a single message by id
+      # @param message_id [Integer] message id ID
+      # @return [Hash] response data
+      def get(message_id:)
+        with_operation(service: "messages", operation: "get", is_mutation: false, resource_id: message_id) do
+          http_get("/messages/#{message_id}").json
+        end
+      end
+
+      # Update an existing message
+      # @param message_id [Integer] message id ID
+      # @param subject [String, nil] subject
+      # @param content [String, nil] content
+      # @param status [String, nil] active|drafted
+      # @param category_id [Integer, nil] category id
+      # @return [Hash] response data
+      def update(message_id:, subject: nil, content: nil, status: nil, category_id: nil)
+        with_operation(service: "messages", operation: "update", is_mutation: true, resource_id: message_id) do
+          http_put("/messages/#{message_id}", body: compact_params(subject: subject, content: content, status: status, category_id: category_id)).json
+        end
+      end
+
+      # Pin a message to the top of the message board
+      # @param message_id [Integer] message id ID
+      # @return [void]
+      def pin(message_id:)
+        with_operation(service: "messages", operation: "pin", is_mutation: true, resource_id: message_id) do
+          http_post("/recordings/#{message_id}/pin.json")
+          nil
+        end
+      end
+
+      # Unpin a message from the message board
+      # @param message_id [Integer] message id ID
+      # @return [void]
+      def unpin(message_id:)
+        with_operation(service: "messages", operation: "unpin", is_mutation: true, resource_id: message_id) do
+          http_delete("/recordings/#{message_id}/pin.json")
+          nil
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Basecamp
+  module Services
+    # Service for People operations
+    #
+    # @generated from OpenAPI spec
+    class PeopleService < BaseService
+
+      # List all account users who can be pinged
+      # @return [Enumerator<Hash>] paginated results
+      def list_pingable()
+        wrap_paginated(service: "people", operation: "list_pingable", is_mutation: false) do
+          paginate("/circles/people.json")
+        end
+      end
+
+      # Get the current authenticated user's profile
+      # @return [Hash] response data
+      def my_profile()
+        with_operation(service: "people", operation: "my_profile", is_mutation: false) do
+          http_get("/my/profile.json").json
+        end
+      end
+
+      # List all people visible to the current user
+      # @return [Enumerator<Hash>] paginated results
+      def list()
+        wrap_paginated(service: "people", operation: "list", is_mutation: false) do
+          paginate("/people.json")
+        end
+      end
+
+      # Get a person by ID
+      # @param person_id [Integer] person id ID
+      # @return [Hash] response data
+      def get(person_id:)
+        with_operation(service: "people", operation: "get", is_mutation: false, resource_id: person_id) do
+          http_get("/people/#{person_id}").json
+        end
+      end
+
+      # List all active people on a project
+      # @param project_id [Integer] project id ID
+      # @return [Enumerator<Hash>] paginated results
+      def list_for_project(project_id:)
+        wrap_paginated(service: "people", operation: "list_for_project", is_mutation: false, project_id: project_id) do
+          paginate("/projects/#{project_id}/people.json")
+        end
+      end
+
+      # Update project access (grant/revoke/create people)
+      # @param project_id [Integer] project id ID
+      # @param grant [Array, nil] grant
+      # @param revoke [Array, nil] revoke
+      # @param create [Array, nil] create
+      # @return [Hash] response data
+      def update_project_access(project_id:, grant: nil, revoke: nil, create: nil)
+        with_operation(service: "people", operation: "update_project_access", is_mutation: true, project_id: project_id) do
+          http_put("/projects/#{project_id}/people/users.json", body: compact_params(grant: grant, revoke: revoke, create: create)).json
+        end
+      end
+
+      # List people who can be assigned todos
+      # @return [Hash] response data
+      def list_assignable()
+        with_operation(service: "people", operation: "list_assignable", is_mutation: false) do
+          http_get("/reports/todos/assigned.json").json
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Basecamp
+  module Services
+    # Service for Projects operations
+    #
+    # @generated from OpenAPI spec
+    class ProjectsService < BaseService
+
+      # List projects (active by default; optionally archived/trashed)
+      # @param status [String, nil] active|archived|trashed
+      # @return [Enumerator<Hash>] paginated results
+      def list(status: nil)
+        wrap_paginated(service: "projects", operation: "list", is_mutation: false) do
+          params = compact_params(status: status)
+          paginate("/projects.json", params: params)
+        end
+      end
+
+      # Create a new project
+      # @param name [String] name
+      # @param description [String, nil] description
+      # @return [Hash] response data
+      def create(name:, description: nil)
+        with_operation(service: "projects", operation: "create", is_mutation: true) do
+          http_post("/projects.json", body: compact_params(name: name, description: description)).json
+        end
+      end
+
+      # Get a single project by id
+      # @param project_id [Integer] project id ID
+      # @return [Hash] response data
+      def get(project_id:)
+        with_operation(service: "projects", operation: "get", is_mutation: false, project_id: project_id) do
+          http_get("/projects/#{project_id}").json
+        end
+      end
+
+      # Update an existing project
+      # @param project_id [Integer] project id ID
+      # @param name [String] name
+      # @param description [String, nil] description
+      # @param admissions [String, nil] invite|employee|team
+      # @param schedule_attributes [String, 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
+          http_put("/projects/#{project_id}", body: compact_params(name: name, description: description, admissions: admissions, schedule_attributes: schedule_attributes)).json
+        end
+      end
+
+      # Trash a project (returns 204 No Content)
+      # @param project_id [Integer] project id ID
+      # @return [void]
+      def trash(project_id:)
+        with_operation(service: "projects", operation: "trash", is_mutation: true, project_id: project_id) do
+          http_delete("/projects/#{project_id}")
+          nil
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Basecamp
+  module Services
+    # Service for Recordings operations
+    #
+    # @generated from OpenAPI spec
+    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 bucket [String, nil] bucket
+      # @param status [String, nil] active|archived|trashed
+      # @param sort [String, nil] created_at|updated_at
+      # @param direction [String, nil] asc|desc
+      # @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)
+          paginate("/projects/recordings.json", params: params)
+        end
+      end
+
+      # Get a single recording by id
+      # @param recording_id [Integer] recording id ID
+      # @return [Hash] response data
+      def get(recording_id:)
+        with_operation(service: "recordings", operation: "get", is_mutation: false, resource_id: recording_id) do
+          http_get("/recordings/#{recording_id}").json
+        end
+      end
+
+      # Unarchive a recording (restore to active status)
+      # @param recording_id [Integer] recording id ID
+      # @return [void]
+      def unarchive(recording_id:)
+        with_operation(service: "recordings", operation: "unarchive", is_mutation: true, resource_id: recording_id) do
+          http_put("/recordings/#{recording_id}/status/active.json")
+          nil
+        end
+      end
+
+      # Archive a recording
+      # @param recording_id [Integer] recording id ID
+      # @return [void]
+      def archive(recording_id:)
+        with_operation(service: "recordings", operation: "archive", is_mutation: true, resource_id: recording_id) do
+          http_put("/recordings/#{recording_id}/status/archived.json")
+          nil
+        end
+      end
+
+      # Trash a recording
+      # @param recording_id [Integer] recording id ID
+      # @return [void]
+      def trash(recording_id:)
+        with_operation(service: "recordings", operation: "trash", is_mutation: true, resource_id: recording_id) do
+          http_put("/recordings/#{recording_id}/status/trashed.json")
+          nil
+        end
+      end
+    end
+  end
+end