basecamp-sdk 0.34.0 → 0.35.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:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 60e13fb8f3a5bfb7d62df5ae6764c0c680d09696d9c6b4df93170e764ffde603
|
|
4
|
+
data.tar.gz: d119173b75c2ee189ebf96dfe3ce8ef91a16b0513763e8eeb4d7aa0537af8fe7
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 3cf418ea7d029ac7161a876abf6923fb8c0ce4a240e41388d4d2fc3a9d6dd4565e0a3b4211c9fc0cd9c7e2b868725bc7f67bbe3b1330cfb95062a7f74496f3df
|
|
7
|
+
data.tar.gz: '00919c080f692172c1670649406c6598fd19c829ff417b31afab420a44a7892f2f91eb206c614d28590a8fde71a6d3a1764ff3793e8122dce64c40b30acb5ef7'
|
data/lib/basecamp/client.rb
CHANGED
|
@@ -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-
|
|
4
|
+
"generated": "2026-11-05T15:43:14Z",
|
|
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
|
],
|
|
@@ -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-
|
|
4
|
+
# Generated: 2026-11-05T15:43:15Z
|
|
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
|
data/lib/basecamp/version.rb
CHANGED
|
@@ -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.
|
|
4
|
+
version: 0.35.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-
|
|
11
|
+
date: 2026-11-05 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
|