basecamp-sdk 0.10.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06b1a1a19b501f386b63739724bb50b0f1d778660d2765f04d2c6a0d2214ef14
-  data.tar.gz: 3c2b5c8409d5a334eabb01b668e430510ad79b93cefc5ead3c5475f4b8f5d661
+  metadata.gz: 99e64617bcf9bcf031f03ea1ae0311f37f46c5da4ac4fba9caeca9a768e44a22
+  data.tar.gz: 83dd4b5a6d15ffc7909121dc742e2ccbaf9d1159d2b743a8482bb5a1cd17241f
 SHA512:
-  metadata.gz: 0d9134c7b9996490c035fccc0c949acd1c05faff5c52b40aa5f30ab913456c10701a8742b74df33aea35539d197dd8c4932df3a1305d73db3efe2ac3de7bfa34
-  data.tar.gz: 3a4c47cb7196bd642f1c0863d25ff02fcf8ec607e102a6ce16cafe54aa5a74ef6290561c1897e365ff848e77911bdf8d7b3d31d85395adc4ba0b0753ba21d641
+  metadata.gz: 1e5ce39f93f07dad1c1b79b2da9ac39db5ac70e8871eba73af86a92eb986d56f5b4002af55c40eb16a8f4bed14d2407ead7c1be3b5c817664dcf5033397db7eb
+  data.tar.gz: 5263d6241a9de95303c8a546efe7f412db59def57207a0e0f8c22c45ab06d0b40b4d2c05e7b4d7ab05e02d7cb451246a5ccb5c4992afb52127541b464dbeeb3e

data/README.md

@@ -42,7 +42,6 @@ project = account.projects.get(project_id: 12345)
 
 # Create a todo
 todo = account.todos.create(
-  project_id: 12345,
   todolist_id: 67890,
   content: "Review PR",
   due_on: "2024-12-31"
@@ -57,7 +56,7 @@ todo = account.todos.create(
 config = Basecamp::Config.new(
   base_url: "https://3.basecampapi.com",  # Default
   timeout: 30,                             # Request timeout in seconds
-  max_retries: 3,                          # Max retry attempts for GET requests
+  max_retries: 3,                          # Total request attempts for GET requests (including the initial request)
   base_delay: 1.0,                         # Base delay for exponential backoff
   max_pages: 10_000                         # Max pages for pagination
 )
@@ -72,7 +71,7 @@ client = Basecamp::Client.new(config: config, token_provider: token_provider)
 |--------|---------|-------------|
 | `base_url` | `https://3.basecampapi.com` | Basecamp API base URL |
 | `timeout` | `30` | HTTP request timeout (seconds) |
-| `max_retries` | `3` | Maximum retry attempts for GET requests |
+| `max_retries` | `3` | Total request attempts for GET requests (including the initial request) |
 | `base_delay` | `1.0` | Base delay for exponential backoff (seconds) |
 | `max_jitter` | `0.1` | Maximum random jitter added to delays |
 | `max_pages` | `10_000` | Maximum pages to fetch during pagination |
@@ -133,6 +132,99 @@ if token.expired?
 end
 ```
 
+### Device Authorization Grant (RFC 8628)
+
+For input-constrained clients (CLIs, TVs) that can't host a redirect URI, the
+device flow trades a redirect for a user-entered code. Basecamp pre-registers the
+public `basecamp-cli` client (`token_endpoint_auth_method: none`, no secret); an
+omitted scope defaults to `read` — prefer pinning it explicitly with
+`scope: "read"`. Pass bare origins everywhere (no trailing slash): binding is
+code-point exact — a trailing-slash `expected_issuer` raises a **hard**
+`expected_issuer_unavailable`, while a trailing-slash resource origin breaks
+the hop-1 binding and silently soft-falls back to Launchpad.
+
+```ruby
+# The device grant runs against an ALREADY-SELECTED config whose issuer advertises
+# a device_authorization_endpoint. Resolve one with resource-first discovery —
+# NOT discover_launchpad: Launchpad advertises no device endpoint, so the
+# capability guard would reject it.
+result = Basecamp::Oauth.discover_from_resource("https://3.basecampapi.com")
+raise "device login is not available for this resource" unless result.selected?
+config = result.config
+
+# One call runs the whole grant against the SELECTED config: it guards
+# capability, requests a device/user code, shows it via the display hook, then
+# polls the token endpoint until the user approves.
+token = Basecamp::Oauth.perform_device_login(
+  config: config,
+  client_id: "basecamp-cli",
+  display: ->(auth) do
+    puts "Visit #{auth.verification_uri} and enter code: #{auth.user_code}"
+    puts "Or open: #{auth.verification_uri_complete}" if auth.verification_uri_complete
+  end
+)
+
+client = Basecamp.client(access_token: token.access_token)
+
+# BC5 device logins as basecamp-cli mint MULTI-ACCOUNT refresh tokens: the
+# token carries an RFC 8707 resource indicator (token.resource,
+# "urn:bc:account:<id>"), and refreshing without echoing it is rejected
+# (400 invalid_request). Persist token.resource alongside the tokens and
+# echo it on refresh:
+# A device-token response MAY omit refresh_token — guard it: without one,
+# refreshing is impossible and the user must re-run the device login.
+if token.expired? && token.refresh_token
+  fresh = Basecamp::Oauth.refresh_token(
+    token_endpoint: config.token_endpoint,
+    refresh_token: token.refresh_token,
+    client_id: "basecamp-cli",   # public client — no secret
+    resource: token.resource
+  )
+  # A refresh response MAY omit resource (the binding is unchanged) — persist
+  # `fresh.resource || token.resource` so the next refresh still echoes it.
+end
+```
+
+The capability guard requires BOTH `config.device_authorization_endpoint` AND the
+exact grant-type URN `urn:ietf:params:oauth:grant-type:device_code` in
+`config.grant_types_supported` — servers advertise the full URN, so checking for
+a bare `device_code` entry would wrongly conclude the flow is unavailable;
+otherwise it raises
+`Basecamp::Oauth::DeviceFlowError` with `reason: :unavailable` before any request
+is issued. The two lower-level steps are also exposed directly:
+
+```ruby
+auth = Basecamp::Oauth.request_device_authorization(
+  device_authorization_endpoint: config.device_authorization_endpoint,
+  client_id: "basecamp-cli"
+)
+
+token = Basecamp::Oauth.poll_device_token(
+  token_endpoint: config.token_endpoint,
+  client_id: "basecamp-cli",
+  device_code: auth.device_code,
+  interval: auth.interval,
+  expires_in: auth.expires_in
+)
+```
+
+The polling loop waits at least `interval` seconds between polls against a
+**monotonic** deadline, sustains a `slow_down` bump (+5s for every later poll),
+and backs off exponentially on connection timeouts. A terminal outcome raises
+`DeviceFlowError` carrying a `reason` whose parent `type` is derived from it:
+
+| `reason` | `type` | Meaning |
+|---|---|---|
+| `:access_denied` | `auth` | The user declined the request |
+| `:expired` | `auth` | The code expired before approval |
+| `:transport` | `network` (retryable) | A network failure ended the flow |
+| `:unavailable` | `validation` | The config can't do device flow |
+| `:cancelled` | `usage` | The caller cancelled the flow |
+
+`poll_device_token` and `perform_device_login` accept injectable `clock`,
+`sleeper`, and `cancelled` callables — pass a `cancelled` probe (e.g. one that
+checks a signal set by SIGINT) to abort a pending login cleanly.
+
 ### Resource-First Discovery (RFC 9728 + RFC 8414)
 
 BC5's Authorization Server (AS) metadata lives only at the canonical issuer (the
@@ -179,7 +271,7 @@ aborts before an oversized body is buffered.
 
 ## Services
 
-The SDK provides 45 account-scoped services. The table below covers the common ones; see `lib/basecamp/generated/services/` for the authoritative, complete set:
+The SDK provides 46 account-scoped services. The table below covers the common ones; see `lib/basecamp/generated/services/` for the authoritative, complete set:
 
 | Service | Description |
 |---------|-------------|
@@ -260,13 +352,15 @@ result = account.download_url(url)
 
 ## Retry Behavior
 
-GET requests automatically retry on transient failures with exponential backoff:
-
-- **Retryable errors**: 429 (rate limit), 502, 503, 504 (gateway errors)
-- **Backoff**: Exponential with jitter (1s, 2s, 4s...)
-- **Rate limits**: Respects `Retry-After` header
+Only plain GET requests retry — automatically, with exponential backoff. Mutation operations (POST, PUT, DELETE) do **not** retry to prevent data duplication, and the raw upload and download paths skip the retry loop entirely (the upload path is strictly one request; the download hop keeps only the one-shot 401 replay below).
 
-Mutation operations (POST, PUT, DELETE) do **not** retry to prevent data duplication.
+- **Which errors**: Retry keys off the error's `retryable?` classification, not a declared status list — 429 (rate limit), 500, 502, 503, 504, and any other 5xx all retry, as does `NetworkError` (connection failures, including DNS and connect-phase timeouts). Read timeouts are the exception: Faraday surfaces them as a status-less `ApiError` with `retryable? == false`, so a GET that times out mid-response fails on the first attempt. 400, 401, 403, 404, and 422 never retry.
+- **`max_retries`**: Total request attempts for GET requests, including the initial request — the default `3` means one initial attempt plus two retries. **`max_retries: 0` sends zero requests** and raises `Basecamp::ApiError` (`"Request failed after 0 attempts"`).
+- **Backoff**: Exponential with jitter — `base_delay * 2^(attempt - 1) + rand * max_jitter` — uncapped, bounded in practice by the attempt budget.
+- **Rate limits**: A 429's `Retry-After` header overrides the calculated backoff. Only 429 carries it: 5xx and network errors always use the exponential backoff.
+- **401 responses**: With a refresh-capable token provider, the SDK refreshes the token and replays the request **once** — for all methods, including mutations — outside the `max_retries` budget. A second 401 is surfaced. The raw upload path has no 401 replay.
+- **Per-operation metadata**: The retry policy operations declare (`retry_on` statuses, per-operation `max`) is inert in Ruby — every API GET issued through the client, including the Launchpad authorization fetch, rides the same classification-based loop bounded by `config.max_retries` alone. (The download flow's redirect hop and OAuth discovery use their own single-attempt transports.)
+- **`retryable?`**: Unlike SDKs where the error classification is only a hint for your own code, in Ruby an error's `retryable?` (and `retry_after`) is exactly what the transport acts on for GET requests.
 
 ## Error Handling
 
@@ -335,6 +429,8 @@ client = Basecamp::Client.new(
 | `BASECAMP_TOKEN` | OAuth access token |
 | `BASECAMP_ACCOUNT_ID` | Account ID |
 | `BASECAMP_BASE_URL` | API base URL (default: `https://3.basecampapi.com`) |
+| `BASECAMP_TIMEOUT` | Request timeout in seconds (default: `30`) |
+| `BASECAMP_MAX_RETRIES` | Total request attempts for GET requests, including the initial request (default: `3`) |
 
 ## Development
 

data/lib/basecamp/client.rb

@@ -152,8 +152,8 @@ module Basecamp
     # @param path [String] URL path (without account prefix)
     # @param params [Hash] query parameters
     # @return [Response]
-    def get(path, params: {})
-      @parent.http.get(account_path(path), params: params)
+    def get(path, params: {}, operation: nil)
+      @parent.http.get(account_path(path), params: params, operation: operation)
     end
 
     # Performs a POST request scoped to this account.
@@ -204,8 +204,8 @@ module Basecamp
     # @param params [Hash] query parameters
     # @yield [Hash] each item from the response
     # @return [Enumerator] if no block given
-    def paginate(path, params: {}, &)
-      @parent.http.paginate(account_path(path), params: params, &)
+    def paginate(path, params: {}, operation: nil, &)
+      @parent.http.paginate(account_path(path), params: params, operation: operation, &)
     end
 
     # Fetches all pages of a paginated resource, extracting items from a key.
@@ -215,8 +215,8 @@ module Basecamp
     # @param params [Hash] query parameters
     # @yield [Hash] each item from the response
     # @return [Enumerator] if no block given
-    def paginate_key(path, key:, params: {}, &)
-      @parent.http.paginate_key(account_path(path), key: key, params: params, &)
+    def paginate_key(path, key:, params: {}, operation: nil, &)
+      @parent.http.paginate_key(account_path(path), key: key, params: params, operation: operation, &)
     end
 
     # Fetches a wrapped paginated resource, returning wrapper fields + lazy paginated items.
@@ -224,8 +224,8 @@ module Basecamp
     # @param key [String] the key containing the array of paginated items
     # @param params [Hash] query parameters
     # @return [Hash] wrapper fields merged with key => Enumerator of all items
-    def paginate_wrapped(path, key:, params: {})
-      @parent.http.paginate_wrapped(account_path(path), key: key, params: params)
+    def paginate_wrapped(path, key:, params: {}, operation: nil)
+      @parent.http.paginate_wrapped(account_path(path), key: key, params: params, operation: operation)
     end
 
     # Downloads file content from any API-routable download URL.
@@ -481,6 +481,26 @@ module Basecamp
       service(:tools) { Services::ToolsService.new(self) }
     end
 
+    # @return [Services::BookmarksService]
+    def bookmarks
+      service(:bookmarks) { Services::BookmarksService.new(self) }
+    end
+
+    # @return [Services::DraftsService]
+    def drafts
+      service(:drafts) { Services::DraftsService.new(self) }
+    end
+
+    # @return [Services::CalendarsService]
+    def calendars
+      service(:calendars) { Services::CalendarsService.new(self) }
+    end
+
+    # @return [Services::MyNotesService]
+    def my_notes
+      service(:my_notes) { Services::MyNotesService.new(self) }
+    end
+
     # @return [Services::SubscriptionsService]
     def subscriptions
       service(:subscriptions) { Services::SubscriptionsService.new(self) }

data/lib/basecamp/config.rb

@@ -24,7 +24,8 @@ module Basecamp
     # @return [Integer] request timeout in seconds
     attr_accessor :timeout
 
-    # @return [Integer] maximum retry attempts for GET requests
+    # @return [Integer] total request attempts for GET requests, including the
+    #   initial request (0 sends no requests at all and raises)
     attr_accessor :max_retries
 
     # @return [Float] initial backoff delay in seconds
@@ -48,7 +49,7 @@ module Basecamp
     #
     # @param base_url [String] API base URL
     # @param timeout [Integer] request timeout in seconds
-    # @param max_retries [Integer] maximum retry attempts
+    # @param max_retries [Integer] total request attempts for GET requests, including the initial request
     # @param base_delay [Float] initial backoff delay
     # @param max_jitter [Float] maximum jitter
     # @param max_pages [Integer] maximum pages to fetch
@@ -78,7 +79,7 @@ module Basecamp
     # Environment variables:
     # - BASECAMP_BASE_URL: API base URL
     # - BASECAMP_TIMEOUT: Request timeout in seconds
-    # - BASECAMP_MAX_RETRIES: Maximum retry attempts
+    # - BASECAMP_MAX_RETRIES: Total request attempts for GET requests, including the initial request
     #
     # @return [Config]
     def self.from_env

data/lib/basecamp/generated/metadata.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://basecamp.com/schemas/sdk-metadata.json",
   "version": "1.0.0",
-  "generated": "2026-07-28T21:34:14Z",
+  "generated": "2026-07-31T15:59:31Z",
   "operations": {
     "GetAccount": {
       "retry": {
@@ -67,22 +67,6 @@
         ]
       }
     },
-    "GetEverythingBoosts": {
-      "retry": {
-        "maxAttempts": 3,
-        "baseDelayMs": 1000,
-        "backoff": "exponential",
-        "retryOn": [
-          429,
-          503
-        ]
-      },
-      "pagination": {
-        "style": "link",
-        "totalCountHeader": "X-Total-Count",
-        "maxPageSize": 50
-      }
-    },
     "GetBoost": {
       "retry": {
         "maxAttempts": 3,
@@ -131,6 +115,9 @@
           429,
           503
         ]
+      },
+      "idempotent": {
+        "natural": true
       }
     },
     "DisableCardColumnOnHold": {
@@ -263,6 +250,17 @@
         ]
       }
     },
+    "CreateTodosetTodo": {
+      "retry": {
+        "maxAttempts": 3,
+        "baseDelayMs": 1000,
+        "backoff": "exponential",
+        "retryOn": [
+          429,
+          503
+        ]
+      }
+    },
     "ListWebhooks": {
       "retry": {
         "maxAttempts": 3,
@@ -290,6 +288,31 @@
         ]
       }
     },
+    "GetCalendar": {
+      "retry": {
+        "maxAttempts": 3,
+        "baseDelayMs": 1000,
+        "backoff": "exponential",
+        "retryOn": [
+          429,
+          503
+        ]
+      }
+    },
+    "UpdateCalendar": {
+      "retry": {
+        "maxAttempts": 3,
+        "baseDelayMs": 1000,
+        "backoff": "exponential",
+        "retryOn": [
+          429,
+          503
+        ]
+      },
+      "idempotent": {
+        "natural": true
+      }
+    },
     "GetCard": {
       "retry": {
         "maxAttempts": 3,
@@ -1304,6 +1327,63 @@
         ]
       }
     },
+    "ListMyBookmarks": {
+      "retry": {
+        "maxAttempts": 3,
+        "baseDelayMs": 1000,
+        "backoff": "exponential",
+        "retryOn": [
+          429,
+          503
+        ]
+      },
+      "pagination": {
+        "style": "link",
+        "totalCountHeader": "X-Total-Count",
+        "maxPageSize": 50
+      }
+    },
+    "ListMyDrafts": {
+      "retry": {
+        "maxAttempts": 3,
+        "baseDelayMs": 1000,
+        "backoff": "exponential",
+        "retryOn": [
+          429,
+          503
+        ]
+      },
+      "pagination": {
+        "style": "link",
+        "totalCountHeader": "X-Total-Count",
+        "maxPageSize": 50
+      }
+    },
+    "GetMyNote": {
+      "retry": {
+        "maxAttempts": 3,
+        "baseDelayMs": 1000,
+        "backoff": "exponential",
+        "retryOn": [
+          429,
+          503
+        ]
+      }
+    },
+    "UpdateMyNote": {
+      "retry": {
+        "maxAttempts": 3,
+        "baseDelayMs": 1000,
+        "backoff": "exponential",
+        "retryOn": [
+          429,
+          503
+        ]
+      },
+      "idempotent": {
+        "natural": true
+      }
+    },
     "GetMyPreferences": {
       "retry": {
         "maxAttempts": 3,
@@ -1329,6 +1409,45 @@
         "natural": true
       }
     },
+    "PrioritizeAssignment": {
+      "retry": {
+        "maxAttempts": 3,
+        "baseDelayMs": 1000,
+        "backoff": "exponential",
+        "retryOn": [
+          429,
+          503
+        ]
+      },
+      "idempotent": {
+        "natural": true
+      }
+    },
+    "DeprioritizeAssignment": {
+      "retry": {
+        "maxAttempts": 3,
+        "baseDelayMs": 1000,
+        "backoff": "exponential",
+        "retryOn": [
+          429,
+          503
+        ]
+      },
+      "idempotent": {
+        "natural": true
+      }
+    },
+    "ReorderUpNext": {
+      "retry": {
+        "maxAttempts": 3,
+        "baseDelayMs": 1000,
+        "backoff": "exponential",
+        "retryOn": [
+          429,
+          503
+        ]
+      }
+    },
     "GetMyProfile": {
       "retry": {
         "maxAttempts": 3,
@@ -1881,6 +2000,45 @@
         ]
       }
     },
+    "GetBookmark": {
+      "retry": {
+        "maxAttempts": 3,
+        "baseDelayMs": 1000,
+        "backoff": "exponential",
+        "retryOn": [
+          429,
+          503
+        ]
+      }
+    },
+    "CreateBookmark": {
+      "retry": {
+        "maxAttempts": 3,
+        "baseDelayMs": 1000,
+        "backoff": "exponential",
+        "retryOn": [
+          429,
+          503
+        ]
+      },
+      "idempotent": {
+        "natural": true
+      }
+    },
+    "DeleteBookmark": {
+      "retry": {
+        "maxAttempts": 3,
+        "baseDelayMs": 1000,
+        "backoff": "exponential",
+        "retryOn": [
+          429,
+          503
+        ]
+      },
+      "idempotent": {
+        "natural": true
+      }
+    },
     "ListRecordingBoosts": {
       "retry": {
         "maxAttempts": 3,
@@ -2054,6 +2212,9 @@
           429,
           503
         ]
+      },
+      "idempotent": {
+        "natural": true
       }
     },
     "UpdateSubscription": {

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

@@ -11,7 +11,7 @@ module Basecamp
       # @return [Hash] response data
       def get_account()
         with_operation(service: "account", operation: "get_account", is_mutation: false) do
-          http_get("/account.json").json
+          http_get("/account.json", operation: "GetAccount").json
         end
       end
 

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

@@ -11,7 +11,7 @@ module Basecamp
       # @return [Array<Hash>] response data
       def list_lineup_markers()
         with_operation(service: "automation", operation: "list_lineup_markers", is_mutation: false) do
-          http_get("/lineup/markers.json").json
+          http_get("/lineup/markers.json", operation: "ListLineupMarkers").json
         end
       end
     end

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

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Basecamp
+  module Services
+    # Service for Bookmarks operations
+    #
+    # @generated from OpenAPI spec
+    class BookmarksService < BaseService
+
+      # List the current user's bookmarks, most recently bookmarked first (paginated).
+      # @param page [Integer, nil] Page number for paginating through results. Defaults to 1.
+      # @return [Enumerator<Hash>] paginated results
+      def list_my_bookmarks(page: nil)
+        wrap_paginated(service: "bookmarks", operation: "list_my_bookmarks", is_mutation: false) do
+          params = compact_query_params(page: page)
+          paginate("/my/bookmarks.json", params: params, operation: "ListMyBookmarks")
+        end
+      end
+
+      # Report whether the current user has bookmarked the recording.
+      # @param recording_id [Integer] recording id ID
+      # @return [Hash] response data
+      def get_bookmark(recording_id:)
+        with_operation(service: "bookmarks", operation: "get_bookmark", is_mutation: false, resource_id: recording_id) do
+          http_get("/recordings/#{recording_id}/bookmark.json", operation: "GetBookmark").json
+        end
+      end
+
+      # Bookmark a recording for the current user.
+      # @param recording_id [Integer] recording id ID
+      # @return [Hash] response data
+      def create_bookmark(recording_id:)
+        with_operation(service: "bookmarks", operation: "create_bookmark", is_mutation: true, resource_id: recording_id) do
+          http_post("/recordings/#{recording_id}/bookmark.json").json
+        end
+      end
+
+      # Remove the current user's bookmark from a recording (returns 204 No Content).
+      # @param recording_id [Integer] recording id ID
+      # @return [void]
+      def delete_bookmark(recording_id:)
+        with_operation(service: "bookmarks", operation: "delete_bookmark", is_mutation: true, resource_id: recording_id) do
+          http_delete("/recordings/#{recording_id}/bookmark.json")
+          nil
+        end
+      end
+    end
+  end
+end

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

@@ -12,7 +12,7 @@ module Basecamp
       # @return [Hash] response data
       def get_boost(boost_id:)
         with_operation(service: "boosts", operation: "get_boost", is_mutation: false, resource_id: boost_id) do
-          http_get("/boosts/#{boost_id}").json
+          http_get("/boosts/#{boost_id}", operation: "GetBoost").json
         end
       end
 
@@ -31,7 +31,7 @@ module Basecamp
       # @return [Enumerator<Hash>] paginated results
       def list_recording_boosts(recording_id:)
         wrap_paginated(service: "boosts", operation: "list_recording_boosts", is_mutation: false, resource_id: recording_id) do
-          paginate("/recordings/#{recording_id}/boosts.json")
+          paginate("/recordings/#{recording_id}/boosts.json", operation: "ListRecordingBoosts")
         end
       end
 
@@ -51,7 +51,7 @@ module Basecamp
       # @return [Enumerator<Hash>] paginated results
       def list_event_boosts(recording_id:, event_id:)
         wrap_paginated(service: "boosts", operation: "list_event_boosts", is_mutation: false, resource_id: event_id) do
-          paginate("/recordings/#{recording_id}/events/#{event_id}/boosts.json")
+          paginate("/recordings/#{recording_id}/events/#{event_id}/boosts.json", operation: "ListEventBoosts")
         end
       end
 

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Basecamp
+  module Services
+    # Service for Calendars operations
+    #
+    # @generated from OpenAPI spec
+    class CalendarsService < BaseService
+
+      # Get a calendar by its bucket id. A Calendar is a top-level BC5 bucketable
+      # @param calendar_id [Integer] calendar id ID
+      # @return [Hash] response data
+      def get_calendar(calendar_id:)
+        with_operation(service: "calendars", operation: "get_calendar", is_mutation: false, resource_id: calendar_id) do
+          http_get("/calendars/#{calendar_id}", operation: "GetCalendar").json
+        end
+      end
+
+      # Update a calendar's display color. An unknown color returns 422 with a JSON
+      # @param calendar_id [Integer] calendar id ID
+      # @param calendar [Hash] calendar
+      # @return [Hash] response data
+      def update_calendar(calendar_id:, calendar:)
+        with_operation(service: "calendars", operation: "update_calendar", is_mutation: true, resource_id: calendar_id) do
+          http_put("/calendars/#{calendar_id}", body: compact_params(calendar: calendar)).json
+        end
+      end
+    end
+  end
+end