basecamp-sdk 0.34.0 → 0.36.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 25bd52e24df8081b95a01db3a3a77056d0a8a65e690e0873650c594c90a593fb
4
- data.tar.gz: 41dca454861e8d7be217a4bdaeae17930b09f44f508e5c6928dd169412e4bfa3
3
+ metadata.gz: 314401afda5770702cd72089245fa79d2c78a1eb408e378592172a9d5ff92386
4
+ data.tar.gz: ada4fb551b6f0959faf9a76af337faf9e4fd5af95623d173673a4f5265ae94ec
5
5
  SHA512:
6
- metadata.gz: c2cf1ae375b942bfdd03d9e8df6817bbbcf0e6929e2118817f6ddbbc6485d5bfe60705887be1f7058ca355db31bd93629c29f48ae144ca7a610664e1b5589d83
7
- data.tar.gz: fad0518aa12d9702193fc71aa538b163cbec5d0f0664d0a7b1e2f69a0933e1c43a4f5bede23e1e9e05397ad2d385e599fd55f70fd2c0fffcbc2edd4705bd200a
6
+ metadata.gz: 81fd8c83a6cb047592d3e8121caf250c21d30936f2efbec5e70e5d61ecba673afc70ae6c3a62bbfe0661b7998f7ef6384fbc8e6b3bba74c60b5eaee5718da12c
7
+ data.tar.gz: e7901c3bac9dc9d12336106e6d2894d4663d2b078d587fce2258dcd445fd1a66659a895c005c9944c52487e52d47ed2b8f188438cc8d97c36a69211f114a57be
@@ -526,6 +526,11 @@ module Basecamp
526
526
  service(:tools) { Services::ToolsService.new(self) }
527
527
  end
528
528
 
529
+ # @return [Services::DoorsService]
530
+ def doors
531
+ service(:doors) { Services::DoorsService.new(self) }
532
+ end
533
+
529
534
  # @return [Services::BookmarksService]
530
535
  def bookmarks
531
536
  service(:bookmarks) { Services::BookmarksService.new(self) }
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "$schema": "https://basecamp.com/schemas/sdk-metadata.json",
3
3
  "version": "1.0.0",
4
- "generated": "2026-10-30T06:06:06Z",
4
+ "generated": "2026-11-12T17:16:25Z",
5
5
  "operations": {
6
6
  "GetAccount": {
7
7
  "retry": {
@@ -378,6 +378,28 @@
378
378
  ]
379
379
  }
380
380
  },
381
+ "ListDoors": {
382
+ "retry": {
383
+ "maxAttempts": 3,
384
+ "baseDelayMs": 1000,
385
+ "backoff": "exponential",
386
+ "retryOn": [
387
+ 429,
388
+ 503
389
+ ]
390
+ }
391
+ },
392
+ "CreateDoor": {
393
+ "retry": {
394
+ "maxAttempts": 2,
395
+ "baseDelayMs": 1000,
396
+ "backoff": "exponential",
397
+ "retryOn": [
398
+ 429,
399
+ 503
400
+ ]
401
+ }
402
+ },
381
403
  "CreateTool": {
382
404
  "retry": {
383
405
  "maxAttempts": 2,
@@ -1070,6 +1092,45 @@
1070
1092
  "natural": true
1071
1093
  }
1072
1094
  },
1095
+ "GetDoor": {
1096
+ "retry": {
1097
+ "maxAttempts": 3,
1098
+ "baseDelayMs": 1000,
1099
+ "backoff": "exponential",
1100
+ "retryOn": [
1101
+ 429,
1102
+ 503
1103
+ ]
1104
+ }
1105
+ },
1106
+ "UpdateDoor": {
1107
+ "retry": {
1108
+ "maxAttempts": 3,
1109
+ "baseDelayMs": 1000,
1110
+ "backoff": "exponential",
1111
+ "retryOn": [
1112
+ 429,
1113
+ 503
1114
+ ]
1115
+ },
1116
+ "idempotent": {
1117
+ "natural": true
1118
+ }
1119
+ },
1120
+ "DeleteDoor": {
1121
+ "retry": {
1122
+ "maxAttempts": 3,
1123
+ "baseDelayMs": 1000,
1124
+ "backoff": "exponential",
1125
+ "retryOn": [
1126
+ 429,
1127
+ 503
1128
+ ]
1129
+ },
1130
+ "idempotent": {
1131
+ "natural": true
1132
+ }
1133
+ },
1073
1134
  "GetTool": {
1074
1135
  "retry": {
1075
1136
  "maxAttempts": 3,
@@ -3919,6 +3980,9 @@
3919
3980
  "CreateDocument": [
3920
3981
  "creator"
3921
3982
  ],
3983
+ "CreateDoor": [
3984
+ "creator"
3985
+ ],
3922
3986
  "CreateEventBoost": [
3923
3987
  "booster"
3924
3988
  ],
@@ -4115,6 +4179,9 @@
4115
4179
  "GetDocument": [
4116
4180
  "creator"
4117
4181
  ],
4182
+ "GetDoor": [
4183
+ "creator"
4184
+ ],
4118
4185
  "GetEverythingCheckins": [
4119
4186
  "[].creator"
4120
4187
  ],
@@ -4478,6 +4545,9 @@
4478
4545
  "ListDocuments": [
4479
4546
  "[].creator"
4480
4547
  ],
4548
+ "ListDoors": [
4549
+ "[].creator"
4550
+ ],
4481
4551
  "ListEventBoosts": [
4482
4552
  "[].booster"
4483
4553
  ],
@@ -4640,6 +4710,9 @@
4640
4710
  "UpdateComment": [
4641
4711
  "creator"
4642
4712
  ],
4713
+ "UpdateDoor": [
4714
+ "creator"
4715
+ ],
4643
4716
  "UpdateGaugeNeedle": [
4644
4717
  "creator"
4645
4718
  ],
@@ -22,10 +22,13 @@ module Basecamp
22
22
  # @param content [String, nil] content
23
23
  # @param due_on [String, nil] due on (YYYY-MM-DD)
24
24
  # @param assignee_ids [Array, nil] assignee ids
25
+ # @param notify [Boolean, nil] Notify people newly assigned through assignee_ids in this same request.
26
+ # Off unless true, and has no effect without assignee_ids: people already
27
+ # assigned are not notified again.
25
28
  # @return [Hash] response data
26
- def update_verbatim(card_id:, title: nil, content: nil, due_on: nil, assignee_ids: nil)
29
+ def update_verbatim(card_id:, title: nil, content: nil, due_on: nil, assignee_ids: nil, notify: nil)
27
30
  with_operation(service: "cards", operation: "update_verbatim", is_mutation: true, resource_id: card_id) do
28
- http_put("/card_tables/cards/#{card_id}", body: compact_params(title: title, content: content, due_on: due_on, assignee_ids: assignee_ids)).json(operation: "UpdateCard")
31
+ http_put("/card_tables/cards/#{card_id}", body: compact_params(title: title, content: content, due_on: due_on, assignee_ids: assignee_ids, notify: notify)).json(operation: "UpdateCard")
29
32
  end
30
33
  end
31
34
 
@@ -59,11 +62,13 @@ module Basecamp
59
62
  # @param title [String] title
60
63
  # @param content [String, nil] content
61
64
  # @param due_on [String, nil] due on (YYYY-MM-DD)
62
- # @param notify [Boolean, nil] notify
65
+ # @param assignee_ids [Array, nil] People to assign to the new card. BC3 keeps only the ids it finds among
66
+ # the card table's reachable people and silently drops the rest.
67
+ # @param notify [Boolean, nil] Notify the people assigned through assignee_ids. Off unless true.
63
68
  # @return [Hash] response data
64
- def create(column_id:, title:, content: nil, due_on: nil, notify: nil)
69
+ def create(column_id:, title:, content: nil, due_on: nil, assignee_ids: nil, notify: nil)
65
70
  with_operation(service: "cards", operation: "create", is_mutation: true, resource_id: column_id) do
66
- http_post("/card_tables/lists/#{column_id}/cards.json", body: compact_params(title: title, content: content, due_on: due_on, notify: notify)).json(operation: "CreateCard")
71
+ http_post("/card_tables/lists/#{column_id}/cards.json", body: compact_params(title: title, content: content, due_on: due_on, assignee_ids: assignee_ids, notify: notify)).json(operation: "CreateCard")
67
72
  end
68
73
  end
69
74
  end
@@ -0,0 +1,64 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Basecamp
4
+ module Services
5
+ # Service for Doors operations
6
+ #
7
+ # @generated from OpenAPI spec
8
+ class DoorsService < BaseService
9
+
10
+ # List the active external links in a project
11
+ # @param bucket_id [Integer] bucket id ID
12
+ # @return [Array<Hash>] response data
13
+ def list(bucket_id:)
14
+ with_operation(service: "doors", operation: "list", is_mutation: false, project_id: bucket_id) do
15
+ http_get("/buckets/#{bucket_id}/dock/doors.json", operation: "ListDoors").json(operation: "ListDoors")
16
+ end
17
+ end
18
+
19
+ # Create an external link in a project
20
+ # @param bucket_id [Integer] bucket id ID
21
+ # @param door [Hash] door
22
+ # @param visible_to_clients [Boolean, nil] Whether the project's clients can see the external link. Omitted means
23
+ # false: the link is private to the team. A client caller always creates a
24
+ # client-visible link regardless of what is sent.
25
+ # @return [Hash] response data
26
+ def create(bucket_id:, door:, visible_to_clients: nil)
27
+ with_operation(service: "doors", operation: "create", is_mutation: true, project_id: bucket_id) do
28
+ http_post("/buckets/#{bucket_id}/dock/doors.json", body: compact_params(door: door, visible_to_clients: visible_to_clients)).json(operation: "CreateDoor")
29
+ end
30
+ end
31
+
32
+ # Get an external link by id
33
+ # @param door_id [Integer] door id ID
34
+ # @return [Hash] response data
35
+ def get(door_id:)
36
+ with_operation(service: "doors", operation: "get", is_mutation: false, resource_id: door_id) do
37
+ http_get("/dock/doors/#{door_id}", operation: "GetDoor").json(operation: "GetDoor")
38
+ end
39
+ end
40
+
41
+ # Update an external link
42
+ # @param door_id [Integer] door id ID
43
+ # @param door [Hash, nil] door
44
+ # @param visible_to_clients [Boolean, nil] Whether the project's clients can see the external link. Omitted keeps
45
+ # the current visibility.
46
+ # @return [Hash] response data
47
+ def update(door_id:, door: nil, visible_to_clients: nil)
48
+ with_operation(service: "doors", operation: "update", is_mutation: true, resource_id: door_id) do
49
+ http_put("/dock/doors/#{door_id}", body: compact_params(door: door, visible_to_clients: visible_to_clients)).json(operation: "UpdateDoor")
50
+ end
51
+ end
52
+
53
+ # Delete an external link (returns 204 No Content)
54
+ # @param door_id [Integer] door id ID
55
+ # @return [void]
56
+ def delete(door_id:)
57
+ with_operation(service: "doors", operation: "delete", is_mutation: true, resource_id: door_id) do
58
+ http_delete("/dock/doors/#{door_id}")
59
+ nil
60
+ end
61
+ end
62
+ end
63
+ end
64
+ end
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  # Auto-generated from OpenAPI spec. Do not edit manually.
4
- # Generated: 2026-10-30T06:06:06Z
4
+ # Generated: 2026-11-12T17:16:25Z
5
5
 
6
6
  require "json"
7
7
  require "time"
@@ -1427,6 +1427,37 @@ module Basecamp
1427
1427
  end
1428
1428
  end
1429
1429
 
1430
+ # CreateDoorPayload
1431
+ class CreateDoorPayload
1432
+ include TypeHelpers
1433
+ attr_accessor :service, :url, :description, :title
1434
+
1435
+ # @return [Array<Symbol>]
1436
+ def self.required_fields
1437
+ %i[service url].freeze
1438
+ end
1439
+
1440
+ def initialize(data = {})
1441
+ @service = data["service"]
1442
+ @url = data["url"]
1443
+ @description = data["description"]
1444
+ @title = data["title"]
1445
+ end
1446
+
1447
+ def to_h
1448
+ {
1449
+ "service" => @service,
1450
+ "url" => @url,
1451
+ "description" => @description,
1452
+ "title" => @title,
1453
+ }.compact
1454
+ end
1455
+
1456
+ def to_json(*args)
1457
+ to_h.to_json(*args)
1458
+ end
1459
+ end
1460
+
1430
1461
  # CreatePersonRequest
1431
1462
  class CreatePersonRequest
1432
1463
  include TypeHelpers
@@ -1562,6 +1593,63 @@ module Basecamp
1562
1593
  end
1563
1594
  end
1564
1595
 
1596
+ # Door
1597
+ class Door
1598
+ include TypeHelpers
1599
+ attr_accessor :app_url, :bucket, :created_at, :creator, :id, :inherits_status, :service, :status, :title, :type, :updated_at, :url, :visible_to_clients, :bookmark_url, :description, :position, :subscription_url
1600
+
1601
+ # @return [Array<Symbol>]
1602
+ def self.required_fields
1603
+ %i[app_url bucket created_at creator id inherits_status service status title type updated_at url visible_to_clients].freeze
1604
+ end
1605
+
1606
+ def initialize(data = {})
1607
+ @app_url = data["app_url"]
1608
+ @bucket = parse_type(data["bucket"], "RecordingBucket")
1609
+ @created_at = parse_datetime(data["created_at"])
1610
+ @creator = parse_type(data["creator"], "Person")
1611
+ @id = parse_integer(data["id"])
1612
+ @inherits_status = parse_boolean(data["inherits_status"])
1613
+ @service = parse_type(data["service"], "DoorService")
1614
+ @status = data["status"]
1615
+ @title = data["title"]
1616
+ @type = data["type"]
1617
+ @updated_at = parse_datetime(data["updated_at"])
1618
+ @url = data["url"]
1619
+ @visible_to_clients = parse_boolean(data["visible_to_clients"])
1620
+ @bookmark_url = data["bookmark_url"]
1621
+ @description = data["description"]
1622
+ @position = parse_integer(data["position"])
1623
+ @subscription_url = data["subscription_url"]
1624
+ end
1625
+
1626
+ def to_h
1627
+ {
1628
+ "app_url" => @app_url,
1629
+ "bucket" => @bucket,
1630
+ "created_at" => @created_at,
1631
+ "creator" => @creator,
1632
+ "id" => @id,
1633
+ "inherits_status" => @inherits_status,
1634
+ "service" => @service,
1635
+ "status" => @status,
1636
+ "title" => @title,
1637
+ "type" => @type,
1638
+ "updated_at" => @updated_at,
1639
+ "url" => @url,
1640
+ "visible_to_clients" => @visible_to_clients,
1641
+ "bookmark_url" => @bookmark_url,
1642
+ "description" => @description,
1643
+ "position" => @position,
1644
+ "subscription_url" => @subscription_url,
1645
+ }.compact
1646
+ end
1647
+
1648
+ def to_json(*args)
1649
+ to_h.to_json(*args)
1650
+ end
1651
+ end
1652
+
1565
1653
  # DoorService
1566
1654
  class DoorService
1567
1655
  include TypeHelpers
@@ -5935,6 +6023,32 @@ module Basecamp
5935
6023
  end
5936
6024
  end
5937
6025
 
6026
+ # UpdateDoorPayload
6027
+ class UpdateDoorPayload
6028
+ include TypeHelpers
6029
+ attr_accessor :description, :service, :title, :url
6030
+
6031
+ def initialize(data = {})
6032
+ @description = data["description"]
6033
+ @service = data["service"]
6034
+ @title = data["title"]
6035
+ @url = data["url"]
6036
+ end
6037
+
6038
+ def to_h
6039
+ {
6040
+ "description" => @description,
6041
+ "service" => @service,
6042
+ "title" => @title,
6043
+ "url" => @url,
6044
+ }.compact
6045
+ end
6046
+
6047
+ def to_json(*args)
6048
+ to_h.to_json(*args)
6049
+ end
6050
+ end
6051
+
5938
6052
  # Upload
5939
6053
  class Upload
5940
6054
  include TypeHelpers
@@ -36,7 +36,9 @@ module Basecamp
36
36
  # * a date — the due date is set
37
37
  #
38
38
  # Every other argument is plain send-when-set: +nil+ leaves the field off
39
- # the body, and BC3 leaves the stored value untouched.
39
+ # the body, and BC3 leaves the stored value untouched. The exception is
40
+ # +notify+, a send directive rather than card state, which goes on the
41
+ # wire only when true (as on the todo writes).
40
42
  #
41
43
  # This is the same single PUT as {#update_verbatim}, which stays as the
42
44
  # unnormalised path; +update+ differs only in mapping an empty +due_on+ to
@@ -47,8 +49,11 @@ module Basecamp
47
49
  # @param content [String, nil] new content (nil = keep current, "" clears)
48
50
  # @param due_on [String, nil] new due date (nil = keep current, "" clears)
49
51
  # @param assignee_ids [Array, nil] new assignees (nil = keep current, [] clears)
52
+ # @param notify [Boolean, nil] notify the people this request newly assigns
53
+ # through +assignee_ids+; sent only when true, and without effect unless
54
+ # +assignee_ids+ is sent too
50
55
  # @return [Hash] the updated card
51
- def update(card_id:, title: nil, content: nil, due_on: nil, assignee_ids: nil)
56
+ def update(card_id:, title: nil, content: nil, due_on: nil, assignee_ids: nil, notify: nil)
52
57
  resolved_due_on =
53
58
  if due_on.nil?
54
59
  # Unaddressed. +compact_params+ drops the nil, so no key is sent and
@@ -67,7 +72,8 @@ module Basecamp
67
72
  title: title,
68
73
  content: content,
69
74
  due_on: resolved_due_on,
70
- assignee_ids: assignee_ids
75
+ assignee_ids: assignee_ids,
76
+ notify: notify ? true : nil
71
77
  )
72
78
  end
73
79
  end
@@ -645,17 +645,18 @@ module Basecamp
645
645
  # member was kept where the reference reads 0 and drops it.
646
646
  creator_member = read_member(summary["creator"], "name", "creator", kind: :person)
647
647
  creator_member.nil? ? summary.delete("creator") : summary["creator"] = creator_member
648
- # Absent or empty is genuinely nothing to report — the reference's
649
- # +omitempty+ leaves an empty slice out of its summary too, so the key
650
- # goes. Anything else that is not an array of objects is a decode
651
- # failure there and fails the read here.
648
+ # Absent (or null) is nothing to report, so the key goes. A list the
649
+ # server sent stays, empty or not: the reference's +omitzero+ keeps a
650
+ # server-sent [] as [], so a to-do with no assignees reads
651
+ # "assignees" => [] in every SDK. Anything else that is not an array of
652
+ # objects is a decode failure there and fails the read here.
652
653
  #
653
654
  # This comment used to say a malformed "assignees" was read as absent
654
655
  # "for the same reason a malformed bucket is". That reason stopped being
655
656
  # true when the bucket started raising, and the sentence survived the
656
657
  # change it contradicted — which is the whole hazard of writing an
657
658
  # invariant down next to the code instead of into a test.
658
- if assignees.nil? || (assignees.is_a?(Array) && assignees.empty?)
659
+ if assignees.nil?
659
660
  summary.delete("assignees")
660
661
  else
661
662
  summary["assignees"] = read_assignees(assignees)
@@ -1,6 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Basecamp
4
- VERSION = "0.34.0"
5
- API_VERSION = "2026-10-30"
4
+ VERSION = "0.36.0"
5
+ API_VERSION = "2026-11-05"
6
6
  end
@@ -122,7 +122,8 @@ class ServiceGenerator
122
122
  'GoogleDocuments' => %w[GetGoogleDocument CreateGoogleDocument UpdateGoogleDocument]
123
123
  },
124
124
  'Dock' => {
125
- 'Tools' => %w[GetTool UpdateTool DeleteTool CreateTool EnableTool DisableTool RepositionTool]
125
+ 'Tools' => %w[GetTool UpdateTool DeleteTool CreateTool EnableTool DisableTool RepositionTool],
126
+ 'Doors' => %w[ListDoors GetDoor CreateDoor UpdateDoor DeleteDoor]
126
127
  },
127
128
  'Recordings' => {
128
129
  'Events' => %w[ListEvents]
@@ -371,7 +372,7 @@ class ServiceGenerator
371
372
  clientcorrespondences clientreply clientreplies forwardreply
372
373
  forwardreplies campfireline campfirelines todolistgroup todolistgroups
373
374
  todolistorgroup uploadversions hillchart hillcharts subtask subtasks ping pings
374
- wormhole wormholes embed embeds
375
+ wormhole wormholes embed embeds door doors
375
376
  ].freeze
376
377
 
377
378
  def initialize(openapi_path)
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: basecamp-sdk
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.34.0
4
+ version: 0.36.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Basecamp
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2026-10-30 00:00:00.000000000 Z
11
+ date: 2026-11-12 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: faraday
@@ -201,6 +201,7 @@ files:
201
201
  - lib/basecamp/generated/services/cloud_files_service.rb
202
202
  - lib/basecamp/generated/services/comments_service.rb
203
203
  - lib/basecamp/generated/services/documents_service.rb
204
+ - lib/basecamp/generated/services/doors_service.rb
204
205
  - lib/basecamp/generated/services/drafts_service.rb
205
206
  - lib/basecamp/generated/services/embeds_service.rb
206
207
  - lib/basecamp/generated/services/event_feed_service.rb