basecamp-client 1.0.8 → 1.0.10
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.
- package/dist/index.d.mts +1922 -713
- package/dist/index.d.ts +1922 -713
- package/dist/index.js +525 -376
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +525 -376
- package/dist/index.mjs.map +1 -1
- package/openapi.json +1380 -205
- package/package.json +1 -1
package/openapi.json
CHANGED
|
@@ -22228,7 +22228,8 @@
|
|
|
22228
22228
|
},
|
|
22229
22229
|
"position": {
|
|
22230
22230
|
"type": "integer",
|
|
22231
|
-
"minimum": 0
|
|
22231
|
+
"minimum": 0,
|
|
22232
|
+
"exclusiveMinimum": 0
|
|
22232
22233
|
}
|
|
22233
22234
|
},
|
|
22234
22235
|
"required": [
|
|
@@ -35228,12 +35229,12 @@
|
|
|
35228
35229
|
"x-client-method": "questions.get"
|
|
35229
35230
|
}
|
|
35230
35231
|
},
|
|
35231
|
-
"/buckets/{bucketId}/
|
|
35232
|
+
"/buckets/{bucketId}/questions/{questionId}/answers": {
|
|
35232
35233
|
"get": {
|
|
35233
|
-
"description": "Returns a paginated list of
|
|
35234
|
-
"summary": "List
|
|
35234
|
+
"description": "Returns a paginated list of answers for a specific check-in question.",
|
|
35235
|
+
"summary": "List question answers",
|
|
35235
35236
|
"tags": [
|
|
35236
|
-
"
|
|
35237
|
+
"Question Answers"
|
|
35237
35238
|
],
|
|
35238
35239
|
"parameters": [
|
|
35239
35240
|
{
|
|
@@ -35247,7 +35248,7 @@
|
|
|
35247
35248
|
}
|
|
35248
35249
|
},
|
|
35249
35250
|
{
|
|
35250
|
-
"name": "
|
|
35251
|
+
"name": "questionId",
|
|
35251
35252
|
"in": "path",
|
|
35252
35253
|
"required": true,
|
|
35253
35254
|
"schema": {
|
|
@@ -35341,7 +35342,7 @@
|
|
|
35341
35342
|
"type": {
|
|
35342
35343
|
"type": "string",
|
|
35343
35344
|
"enum": [
|
|
35344
|
-
"
|
|
35345
|
+
"Question::Answer"
|
|
35345
35346
|
]
|
|
35346
35347
|
},
|
|
35347
35348
|
"url": {
|
|
@@ -35530,6 +35531,9 @@
|
|
|
35530
35531
|
"content": {
|
|
35531
35532
|
"type": "string",
|
|
35532
35533
|
"minLength": 0
|
|
35534
|
+
},
|
|
35535
|
+
"group_on": {
|
|
35536
|
+
"type": "string"
|
|
35533
35537
|
}
|
|
35534
35538
|
},
|
|
35535
35539
|
"required": [
|
|
@@ -35545,7 +35549,8 @@
|
|
|
35545
35549
|
"app_url",
|
|
35546
35550
|
"bucket",
|
|
35547
35551
|
"creator",
|
|
35548
|
-
"content"
|
|
35552
|
+
"content",
|
|
35553
|
+
"group_on"
|
|
35549
35554
|
]
|
|
35550
35555
|
}
|
|
35551
35556
|
}
|
|
@@ -35553,23 +35558,23 @@
|
|
|
35553
35558
|
}
|
|
35554
35559
|
}
|
|
35555
35560
|
},
|
|
35556
|
-
"operationId": "
|
|
35561
|
+
"operationId": "questionAnswers.list",
|
|
35557
35562
|
"externalDocs": {
|
|
35558
35563
|
"description": "Official Basecamp API Documentation",
|
|
35559
|
-
"url": "https://github.com/basecamp/bc3-api/docs/basecamp-api-specs/sections/
|
|
35564
|
+
"url": "https://github.com/basecamp/bc3-api/docs/basecamp-api-specs/sections/question_answers.md#get-question-answers"
|
|
35560
35565
|
},
|
|
35561
35566
|
"security": [
|
|
35562
35567
|
{
|
|
35563
35568
|
"BearerAuth": []
|
|
35564
35569
|
}
|
|
35565
35570
|
],
|
|
35566
|
-
"x-client-method": "
|
|
35571
|
+
"x-client-method": "questionAnswers.list"
|
|
35567
35572
|
},
|
|
35568
35573
|
"post": {
|
|
35569
|
-
"description": "
|
|
35570
|
-
"summary": "Create a
|
|
35574
|
+
"description": "Create a new answer for a check-in question.",
|
|
35575
|
+
"summary": "Create a question answer",
|
|
35571
35576
|
"tags": [
|
|
35572
|
-
"
|
|
35577
|
+
"Question Answers"
|
|
35573
35578
|
],
|
|
35574
35579
|
"parameters": [
|
|
35575
35580
|
{
|
|
@@ -35583,7 +35588,7 @@
|
|
|
35583
35588
|
}
|
|
35584
35589
|
},
|
|
35585
35590
|
{
|
|
35586
|
-
"name": "
|
|
35591
|
+
"name": "questionId",
|
|
35587
35592
|
"in": "path",
|
|
35588
35593
|
"required": true,
|
|
35589
35594
|
"schema": {
|
|
@@ -35627,32 +35632,17 @@
|
|
|
35627
35632
|
"schema": {
|
|
35628
35633
|
"type": "object",
|
|
35629
35634
|
"properties": {
|
|
35630
|
-
"title": {
|
|
35631
|
-
"type": "string",
|
|
35632
|
-
"minLength": 1
|
|
35633
|
-
},
|
|
35634
35635
|
"content": {
|
|
35635
35636
|
"type": "string",
|
|
35636
|
-
"minLength":
|
|
35637
|
+
"minLength": 1
|
|
35637
35638
|
},
|
|
35638
|
-
"
|
|
35639
|
-
"
|
|
35640
|
-
{
|
|
35641
|
-
"type": "string",
|
|
35642
|
-
"enum": [
|
|
35643
|
-
"active",
|
|
35644
|
-
"draft"
|
|
35645
|
-
]
|
|
35646
|
-
},
|
|
35647
|
-
{
|
|
35648
|
-
"type": "string"
|
|
35649
|
-
}
|
|
35650
|
-
]
|
|
35639
|
+
"group_on": {
|
|
35640
|
+
"type": "string"
|
|
35651
35641
|
}
|
|
35652
35642
|
},
|
|
35653
35643
|
"required": [
|
|
35654
|
-
"
|
|
35655
|
-
"
|
|
35644
|
+
"content",
|
|
35645
|
+
"group_on"
|
|
35656
35646
|
]
|
|
35657
35647
|
}
|
|
35658
35648
|
}
|
|
@@ -35704,7 +35694,7 @@
|
|
|
35704
35694
|
"type": {
|
|
35705
35695
|
"type": "string",
|
|
35706
35696
|
"enum": [
|
|
35707
|
-
"
|
|
35697
|
+
"Question::Answer"
|
|
35708
35698
|
]
|
|
35709
35699
|
},
|
|
35710
35700
|
"url": {
|
|
@@ -35893,6 +35883,9 @@
|
|
|
35893
35883
|
"content": {
|
|
35894
35884
|
"type": "string",
|
|
35895
35885
|
"minLength": 0
|
|
35886
|
+
},
|
|
35887
|
+
"group_on": {
|
|
35888
|
+
"type": "string"
|
|
35896
35889
|
}
|
|
35897
35890
|
},
|
|
35898
35891
|
"required": [
|
|
@@ -35908,32 +35901,33 @@
|
|
|
35908
35901
|
"app_url",
|
|
35909
35902
|
"bucket",
|
|
35910
35903
|
"creator",
|
|
35911
|
-
"content"
|
|
35904
|
+
"content",
|
|
35905
|
+
"group_on"
|
|
35912
35906
|
]
|
|
35913
35907
|
}
|
|
35914
35908
|
}
|
|
35915
35909
|
}
|
|
35916
35910
|
}
|
|
35917
35911
|
},
|
|
35918
|
-
"operationId": "
|
|
35912
|
+
"operationId": "questionAnswers.create",
|
|
35919
35913
|
"externalDocs": {
|
|
35920
35914
|
"description": "Official Basecamp API Documentation",
|
|
35921
|
-
"url": "https://github.com/basecamp/bc3-api/docs/basecamp-api-specs/sections/
|
|
35915
|
+
"url": "https://github.com/basecamp/bc3-api/docs/basecamp-api-specs/sections/question_answers.md#get-question-answers"
|
|
35922
35916
|
},
|
|
35923
35917
|
"security": [
|
|
35924
35918
|
{
|
|
35925
35919
|
"BearerAuth": []
|
|
35926
35920
|
}
|
|
35927
35921
|
],
|
|
35928
|
-
"x-client-method": "
|
|
35922
|
+
"x-client-method": "questionAnswers.create"
|
|
35929
35923
|
}
|
|
35930
35924
|
},
|
|
35931
|
-
"/buckets/{bucketId}/
|
|
35925
|
+
"/buckets/{bucketId}/question_answers/{answerId}": {
|
|
35932
35926
|
"get": {
|
|
35933
|
-
"description": "
|
|
35934
|
-
"summary": "Get a
|
|
35927
|
+
"description": "Returns a single question answer by its ID.",
|
|
35928
|
+
"summary": "Get a question answer",
|
|
35935
35929
|
"tags": [
|
|
35936
|
-
"
|
|
35930
|
+
"Question Answers"
|
|
35937
35931
|
],
|
|
35938
35932
|
"parameters": [
|
|
35939
35933
|
{
|
|
@@ -35947,7 +35941,7 @@
|
|
|
35947
35941
|
}
|
|
35948
35942
|
},
|
|
35949
35943
|
{
|
|
35950
|
-
"name": "
|
|
35944
|
+
"name": "answerId",
|
|
35951
35945
|
"in": "path",
|
|
35952
35946
|
"required": true,
|
|
35953
35947
|
"schema": {
|
|
@@ -36030,7 +36024,7 @@
|
|
|
36030
36024
|
"type": {
|
|
36031
36025
|
"type": "string",
|
|
36032
36026
|
"enum": [
|
|
36033
|
-
"
|
|
36027
|
+
"Question::Answer"
|
|
36034
36028
|
]
|
|
36035
36029
|
},
|
|
36036
36030
|
"url": {
|
|
@@ -36219,6 +36213,9 @@
|
|
|
36219
36213
|
"content": {
|
|
36220
36214
|
"type": "string",
|
|
36221
36215
|
"minLength": 0
|
|
36216
|
+
},
|
|
36217
|
+
"group_on": {
|
|
36218
|
+
"type": "string"
|
|
36222
36219
|
}
|
|
36223
36220
|
},
|
|
36224
36221
|
"required": [
|
|
@@ -36234,28 +36231,31 @@
|
|
|
36234
36231
|
"app_url",
|
|
36235
36232
|
"bucket",
|
|
36236
36233
|
"creator",
|
|
36237
|
-
"content"
|
|
36234
|
+
"content",
|
|
36235
|
+
"group_on"
|
|
36238
36236
|
]
|
|
36239
36237
|
}
|
|
36240
36238
|
}
|
|
36241
36239
|
}
|
|
36242
36240
|
}
|
|
36243
36241
|
},
|
|
36244
|
-
"operationId": "
|
|
36242
|
+
"operationId": "questionAnswers.get",
|
|
36245
36243
|
"externalDocs": {
|
|
36246
36244
|
"description": "Official Basecamp API Documentation",
|
|
36247
|
-
"url": "https://github.com/basecamp/bc3-api/docs/basecamp-api-specs/sections/
|
|
36245
|
+
"url": "https://github.com/basecamp/bc3-api/docs/basecamp-api-specs/sections/question_answers.md#get-a-question-answer"
|
|
36248
36246
|
},
|
|
36249
36247
|
"security": [
|
|
36250
36248
|
{
|
|
36251
36249
|
"BearerAuth": []
|
|
36252
36250
|
}
|
|
36253
36251
|
],
|
|
36254
|
-
"x-client-method": "
|
|
36255
|
-
}
|
|
36256
|
-
|
|
36257
|
-
|
|
36258
|
-
|
|
36252
|
+
"x-client-method": "questionAnswers.get"
|
|
36253
|
+
}
|
|
36254
|
+
},
|
|
36255
|
+
"/buckets/{bucketId}/vaults/{vaultId}/documents": {
|
|
36256
|
+
"get": {
|
|
36257
|
+
"description": "Returns a paginated list of active documents in a vault. Pagination data is available via the Link and X-Total-Count headers.",
|
|
36258
|
+
"summary": "List documents",
|
|
36259
36259
|
"tags": [
|
|
36260
36260
|
"Documents"
|
|
36261
36261
|
],
|
|
@@ -36271,7 +36271,7 @@
|
|
|
36271
36271
|
}
|
|
36272
36272
|
},
|
|
36273
36273
|
{
|
|
36274
|
-
"name": "
|
|
36274
|
+
"name": "vaultId",
|
|
36275
36275
|
"in": "path",
|
|
36276
36276
|
"required": true,
|
|
36277
36277
|
"schema": {
|
|
@@ -36306,166 +36306,1190 @@
|
|
|
36306
36306
|
"application/json"
|
|
36307
36307
|
]
|
|
36308
36308
|
}
|
|
36309
|
-
}
|
|
36310
|
-
|
|
36311
|
-
|
|
36312
|
-
|
|
36313
|
-
|
|
36314
|
-
|
|
36315
|
-
"
|
|
36316
|
-
|
|
36317
|
-
"properties": {
|
|
36318
|
-
"title": {
|
|
36319
|
-
"type": "string",
|
|
36320
|
-
"minLength": 1
|
|
36321
|
-
},
|
|
36322
|
-
"content": {
|
|
36323
|
-
"type": "string",
|
|
36324
|
-
"minLength": 0
|
|
36325
|
-
}
|
|
36326
|
-
}
|
|
36327
|
-
}
|
|
36309
|
+
},
|
|
36310
|
+
{
|
|
36311
|
+
"name": "page",
|
|
36312
|
+
"in": "query",
|
|
36313
|
+
"schema": {
|
|
36314
|
+
"type": "integer",
|
|
36315
|
+
"minimum": 0,
|
|
36316
|
+
"exclusiveMinimum": 0
|
|
36328
36317
|
}
|
|
36329
36318
|
}
|
|
36330
|
-
|
|
36319
|
+
],
|
|
36331
36320
|
"responses": {
|
|
36332
36321
|
"200": {
|
|
36333
36322
|
"description": "200",
|
|
36334
36323
|
"content": {
|
|
36335
36324
|
"application/json": {
|
|
36336
36325
|
"schema": {
|
|
36337
|
-
"type": "
|
|
36338
|
-
"
|
|
36339
|
-
"
|
|
36340
|
-
|
|
36341
|
-
"
|
|
36342
|
-
|
|
36343
|
-
|
|
36344
|
-
"oneOf": [
|
|
36345
|
-
{
|
|
36346
|
-
"type": "string",
|
|
36347
|
-
"enum": [
|
|
36348
|
-
"active",
|
|
36349
|
-
"trashed"
|
|
36350
|
-
]
|
|
36351
|
-
},
|
|
36352
|
-
{
|
|
36353
|
-
"type": "string"
|
|
36354
|
-
}
|
|
36355
|
-
]
|
|
36356
|
-
},
|
|
36357
|
-
"visible_to_clients": {
|
|
36358
|
-
"type": "boolean"
|
|
36359
|
-
},
|
|
36360
|
-
"created_at": {
|
|
36361
|
-
"type": "string",
|
|
36362
|
-
"format": "date-time"
|
|
36363
|
-
},
|
|
36364
|
-
"updated_at": {
|
|
36365
|
-
"type": "string",
|
|
36366
|
-
"format": "date-time"
|
|
36367
|
-
},
|
|
36368
|
-
"title": {
|
|
36369
|
-
"type": "string"
|
|
36370
|
-
},
|
|
36371
|
-
"inherits_status": {
|
|
36372
|
-
"type": "boolean"
|
|
36373
|
-
},
|
|
36374
|
-
"type": {
|
|
36375
|
-
"type": "string",
|
|
36376
|
-
"enum": [
|
|
36377
|
-
"Document"
|
|
36378
|
-
]
|
|
36379
|
-
},
|
|
36380
|
-
"url": {
|
|
36381
|
-
"type": "string",
|
|
36382
|
-
"format": "uri"
|
|
36383
|
-
},
|
|
36384
|
-
"app_url": {
|
|
36385
|
-
"type": "string",
|
|
36386
|
-
"format": "uri"
|
|
36387
|
-
},
|
|
36388
|
-
"bookmark_url": {
|
|
36389
|
-
"type": "string",
|
|
36390
|
-
"format": "uri"
|
|
36391
|
-
},
|
|
36392
|
-
"subscription_url": {
|
|
36393
|
-
"type": "string",
|
|
36394
|
-
"format": "uri"
|
|
36395
|
-
},
|
|
36396
|
-
"comments_count": {
|
|
36397
|
-
"type": "integer",
|
|
36398
|
-
"minimum": 0
|
|
36399
|
-
},
|
|
36400
|
-
"comments_url": {
|
|
36401
|
-
"type": "string",
|
|
36402
|
-
"format": "uri"
|
|
36403
|
-
},
|
|
36404
|
-
"position": {
|
|
36405
|
-
"type": "integer",
|
|
36406
|
-
"minimum": 0
|
|
36407
|
-
},
|
|
36408
|
-
"parent": {
|
|
36409
|
-
"type": "object",
|
|
36410
|
-
"properties": {
|
|
36411
|
-
"id": {
|
|
36412
|
-
"type": "integer",
|
|
36413
|
-
"minimum": 0
|
|
36414
|
-
},
|
|
36415
|
-
"title": {
|
|
36416
|
-
"type": "string"
|
|
36417
|
-
},
|
|
36418
|
-
"type": {
|
|
36419
|
-
"type": "string"
|
|
36420
|
-
},
|
|
36421
|
-
"url": {
|
|
36422
|
-
"type": "string",
|
|
36423
|
-
"format": "uri"
|
|
36424
|
-
},
|
|
36425
|
-
"app_url": {
|
|
36426
|
-
"type": "string",
|
|
36427
|
-
"format": "uri"
|
|
36428
|
-
}
|
|
36326
|
+
"type": "array",
|
|
36327
|
+
"items": {
|
|
36328
|
+
"type": "object",
|
|
36329
|
+
"properties": {
|
|
36330
|
+
"id": {
|
|
36331
|
+
"type": "integer",
|
|
36332
|
+
"minimum": 0
|
|
36429
36333
|
},
|
|
36430
|
-
"
|
|
36431
|
-
"
|
|
36432
|
-
|
|
36433
|
-
|
|
36434
|
-
|
|
36435
|
-
|
|
36436
|
-
|
|
36437
|
-
|
|
36438
|
-
|
|
36439
|
-
|
|
36440
|
-
|
|
36441
|
-
|
|
36442
|
-
|
|
36443
|
-
"minimum": 0
|
|
36444
|
-
},
|
|
36445
|
-
"name": {
|
|
36446
|
-
"type": "string"
|
|
36447
|
-
},
|
|
36448
|
-
"type": {
|
|
36449
|
-
"type": "string"
|
|
36450
|
-
}
|
|
36334
|
+
"status": {
|
|
36335
|
+
"oneOf": [
|
|
36336
|
+
{
|
|
36337
|
+
"type": "string",
|
|
36338
|
+
"enum": [
|
|
36339
|
+
"active",
|
|
36340
|
+
"trashed"
|
|
36341
|
+
]
|
|
36342
|
+
},
|
|
36343
|
+
{
|
|
36344
|
+
"type": "string"
|
|
36345
|
+
}
|
|
36346
|
+
]
|
|
36451
36347
|
},
|
|
36452
|
-
"
|
|
36453
|
-
"
|
|
36454
|
-
|
|
36455
|
-
|
|
36456
|
-
|
|
36457
|
-
|
|
36458
|
-
|
|
36459
|
-
"
|
|
36460
|
-
|
|
36461
|
-
"
|
|
36462
|
-
|
|
36463
|
-
|
|
36464
|
-
|
|
36465
|
-
|
|
36466
|
-
|
|
36467
|
-
|
|
36468
|
-
|
|
36348
|
+
"visible_to_clients": {
|
|
36349
|
+
"type": "boolean"
|
|
36350
|
+
},
|
|
36351
|
+
"created_at": {
|
|
36352
|
+
"type": "string",
|
|
36353
|
+
"format": "date-time"
|
|
36354
|
+
},
|
|
36355
|
+
"updated_at": {
|
|
36356
|
+
"type": "string",
|
|
36357
|
+
"format": "date-time"
|
|
36358
|
+
},
|
|
36359
|
+
"title": {
|
|
36360
|
+
"type": "string"
|
|
36361
|
+
},
|
|
36362
|
+
"inherits_status": {
|
|
36363
|
+
"type": "boolean"
|
|
36364
|
+
},
|
|
36365
|
+
"type": {
|
|
36366
|
+
"type": "string",
|
|
36367
|
+
"enum": [
|
|
36368
|
+
"Document"
|
|
36369
|
+
]
|
|
36370
|
+
},
|
|
36371
|
+
"url": {
|
|
36372
|
+
"type": "string",
|
|
36373
|
+
"format": "uri"
|
|
36374
|
+
},
|
|
36375
|
+
"app_url": {
|
|
36376
|
+
"type": "string",
|
|
36377
|
+
"format": "uri"
|
|
36378
|
+
},
|
|
36379
|
+
"bookmark_url": {
|
|
36380
|
+
"type": "string",
|
|
36381
|
+
"format": "uri"
|
|
36382
|
+
},
|
|
36383
|
+
"subscription_url": {
|
|
36384
|
+
"type": "string",
|
|
36385
|
+
"format": "uri"
|
|
36386
|
+
},
|
|
36387
|
+
"comments_count": {
|
|
36388
|
+
"type": "integer",
|
|
36389
|
+
"minimum": 0
|
|
36390
|
+
},
|
|
36391
|
+
"comments_url": {
|
|
36392
|
+
"type": "string",
|
|
36393
|
+
"format": "uri"
|
|
36394
|
+
},
|
|
36395
|
+
"position": {
|
|
36396
|
+
"type": "integer",
|
|
36397
|
+
"minimum": 0
|
|
36398
|
+
},
|
|
36399
|
+
"parent": {
|
|
36400
|
+
"type": "object",
|
|
36401
|
+
"properties": {
|
|
36402
|
+
"id": {
|
|
36403
|
+
"type": "integer",
|
|
36404
|
+
"minimum": 0
|
|
36405
|
+
},
|
|
36406
|
+
"title": {
|
|
36407
|
+
"type": "string"
|
|
36408
|
+
},
|
|
36409
|
+
"type": {
|
|
36410
|
+
"type": "string"
|
|
36411
|
+
},
|
|
36412
|
+
"url": {
|
|
36413
|
+
"type": "string",
|
|
36414
|
+
"format": "uri"
|
|
36415
|
+
},
|
|
36416
|
+
"app_url": {
|
|
36417
|
+
"type": "string",
|
|
36418
|
+
"format": "uri"
|
|
36419
|
+
}
|
|
36420
|
+
},
|
|
36421
|
+
"required": [
|
|
36422
|
+
"id",
|
|
36423
|
+
"title",
|
|
36424
|
+
"type",
|
|
36425
|
+
"url",
|
|
36426
|
+
"app_url"
|
|
36427
|
+
]
|
|
36428
|
+
},
|
|
36429
|
+
"bucket": {
|
|
36430
|
+
"type": "object",
|
|
36431
|
+
"properties": {
|
|
36432
|
+
"id": {
|
|
36433
|
+
"type": "integer",
|
|
36434
|
+
"minimum": 0
|
|
36435
|
+
},
|
|
36436
|
+
"name": {
|
|
36437
|
+
"type": "string"
|
|
36438
|
+
},
|
|
36439
|
+
"type": {
|
|
36440
|
+
"type": "string"
|
|
36441
|
+
}
|
|
36442
|
+
},
|
|
36443
|
+
"required": [
|
|
36444
|
+
"id",
|
|
36445
|
+
"name",
|
|
36446
|
+
"type"
|
|
36447
|
+
]
|
|
36448
|
+
},
|
|
36449
|
+
"creator": {
|
|
36450
|
+
"type": "object",
|
|
36451
|
+
"properties": {
|
|
36452
|
+
"id": {
|
|
36453
|
+
"type": "integer",
|
|
36454
|
+
"minimum": 0
|
|
36455
|
+
},
|
|
36456
|
+
"attachable_sgid": {
|
|
36457
|
+
"type": "string",
|
|
36458
|
+
"minLength": 1
|
|
36459
|
+
},
|
|
36460
|
+
"name": {
|
|
36461
|
+
"type": "string"
|
|
36462
|
+
},
|
|
36463
|
+
"email_address": {
|
|
36464
|
+
"type": "string",
|
|
36465
|
+
"format": "email",
|
|
36466
|
+
"nullable": true
|
|
36467
|
+
},
|
|
36468
|
+
"personable_type": {
|
|
36469
|
+
"type": "string"
|
|
36470
|
+
},
|
|
36471
|
+
"title": {
|
|
36472
|
+
"type": "string",
|
|
36473
|
+
"nullable": true
|
|
36474
|
+
},
|
|
36475
|
+
"bio": {
|
|
36476
|
+
"type": "string",
|
|
36477
|
+
"nullable": true
|
|
36478
|
+
},
|
|
36479
|
+
"location": {
|
|
36480
|
+
"type": "string",
|
|
36481
|
+
"nullable": true
|
|
36482
|
+
},
|
|
36483
|
+
"created_at": {
|
|
36484
|
+
"type": "string",
|
|
36485
|
+
"format": "date-time"
|
|
36486
|
+
},
|
|
36487
|
+
"updated_at": {
|
|
36488
|
+
"type": "string",
|
|
36489
|
+
"format": "date-time"
|
|
36490
|
+
},
|
|
36491
|
+
"admin": {
|
|
36492
|
+
"type": "boolean"
|
|
36493
|
+
},
|
|
36494
|
+
"owner": {
|
|
36495
|
+
"type": "boolean"
|
|
36496
|
+
},
|
|
36497
|
+
"client": {
|
|
36498
|
+
"type": "boolean"
|
|
36499
|
+
},
|
|
36500
|
+
"employee": {
|
|
36501
|
+
"type": "boolean"
|
|
36502
|
+
},
|
|
36503
|
+
"time_zone": {
|
|
36504
|
+
"type": "string"
|
|
36505
|
+
},
|
|
36506
|
+
"avatar_url": {
|
|
36507
|
+
"type": "string",
|
|
36508
|
+
"format": "uri"
|
|
36509
|
+
},
|
|
36510
|
+
"company": {
|
|
36511
|
+
"type": "object",
|
|
36512
|
+
"properties": {
|
|
36513
|
+
"id": {
|
|
36514
|
+
"type": "integer",
|
|
36515
|
+
"minimum": 0
|
|
36516
|
+
},
|
|
36517
|
+
"name": {
|
|
36518
|
+
"type": "string"
|
|
36519
|
+
}
|
|
36520
|
+
},
|
|
36521
|
+
"required": [
|
|
36522
|
+
"id",
|
|
36523
|
+
"name"
|
|
36524
|
+
]
|
|
36525
|
+
},
|
|
36526
|
+
"can_manage_projects": {
|
|
36527
|
+
"type": "boolean"
|
|
36528
|
+
},
|
|
36529
|
+
"can_manage_people": {
|
|
36530
|
+
"type": "boolean"
|
|
36531
|
+
}
|
|
36532
|
+
},
|
|
36533
|
+
"required": [
|
|
36534
|
+
"id",
|
|
36535
|
+
"attachable_sgid",
|
|
36536
|
+
"name",
|
|
36537
|
+
"email_address",
|
|
36538
|
+
"personable_type",
|
|
36539
|
+
"title",
|
|
36540
|
+
"bio",
|
|
36541
|
+
"location",
|
|
36542
|
+
"created_at",
|
|
36543
|
+
"updated_at",
|
|
36544
|
+
"admin",
|
|
36545
|
+
"owner",
|
|
36546
|
+
"client",
|
|
36547
|
+
"employee",
|
|
36548
|
+
"time_zone",
|
|
36549
|
+
"avatar_url",
|
|
36550
|
+
"can_manage_projects",
|
|
36551
|
+
"can_manage_people"
|
|
36552
|
+
]
|
|
36553
|
+
},
|
|
36554
|
+
"content": {
|
|
36555
|
+
"type": "string",
|
|
36556
|
+
"minLength": 0
|
|
36557
|
+
}
|
|
36558
|
+
},
|
|
36559
|
+
"required": [
|
|
36560
|
+
"id",
|
|
36561
|
+
"status",
|
|
36562
|
+
"visible_to_clients",
|
|
36563
|
+
"created_at",
|
|
36564
|
+
"updated_at",
|
|
36565
|
+
"title",
|
|
36566
|
+
"inherits_status",
|
|
36567
|
+
"type",
|
|
36568
|
+
"url",
|
|
36569
|
+
"app_url",
|
|
36570
|
+
"bucket",
|
|
36571
|
+
"creator",
|
|
36572
|
+
"content"
|
|
36573
|
+
]
|
|
36574
|
+
}
|
|
36575
|
+
}
|
|
36576
|
+
}
|
|
36577
|
+
}
|
|
36578
|
+
}
|
|
36579
|
+
},
|
|
36580
|
+
"operationId": "documents.list",
|
|
36581
|
+
"externalDocs": {
|
|
36582
|
+
"description": "Official Basecamp API Documentation",
|
|
36583
|
+
"url": "https://github.com/basecamp/bc3-api/docs/basecamp-api-specs/sections/documents.md#get-documents"
|
|
36584
|
+
},
|
|
36585
|
+
"security": [
|
|
36586
|
+
{
|
|
36587
|
+
"BearerAuth": []
|
|
36588
|
+
}
|
|
36589
|
+
],
|
|
36590
|
+
"x-client-method": "documents.list"
|
|
36591
|
+
},
|
|
36592
|
+
"post": {
|
|
36593
|
+
"description": "Publish a document in a vault. Setting status to \"active\" makes the document visible immediately.",
|
|
36594
|
+
"summary": "Create a document",
|
|
36595
|
+
"tags": [
|
|
36596
|
+
"Documents"
|
|
36597
|
+
],
|
|
36598
|
+
"parameters": [
|
|
36599
|
+
{
|
|
36600
|
+
"name": "bucketId",
|
|
36601
|
+
"in": "path",
|
|
36602
|
+
"required": true,
|
|
36603
|
+
"schema": {
|
|
36604
|
+
"type": "integer",
|
|
36605
|
+
"minimum": 0,
|
|
36606
|
+
"nullable": true
|
|
36607
|
+
}
|
|
36608
|
+
},
|
|
36609
|
+
{
|
|
36610
|
+
"name": "vaultId",
|
|
36611
|
+
"in": "path",
|
|
36612
|
+
"required": true,
|
|
36613
|
+
"schema": {
|
|
36614
|
+
"type": "integer",
|
|
36615
|
+
"minimum": 0,
|
|
36616
|
+
"nullable": true
|
|
36617
|
+
}
|
|
36618
|
+
},
|
|
36619
|
+
{
|
|
36620
|
+
"name": "Authorization",
|
|
36621
|
+
"in": "header",
|
|
36622
|
+
"required": true,
|
|
36623
|
+
"schema": {
|
|
36624
|
+
"type": "string",
|
|
36625
|
+
"minLength": 1
|
|
36626
|
+
}
|
|
36627
|
+
},
|
|
36628
|
+
{
|
|
36629
|
+
"name": "User-Agent",
|
|
36630
|
+
"in": "header",
|
|
36631
|
+
"schema": {
|
|
36632
|
+
"type": "string",
|
|
36633
|
+
"minLength": 1
|
|
36634
|
+
}
|
|
36635
|
+
},
|
|
36636
|
+
{
|
|
36637
|
+
"name": "Accept",
|
|
36638
|
+
"in": "header",
|
|
36639
|
+
"schema": {
|
|
36640
|
+
"type": "string",
|
|
36641
|
+
"enum": [
|
|
36642
|
+
"application/json"
|
|
36643
|
+
]
|
|
36644
|
+
}
|
|
36645
|
+
}
|
|
36646
|
+
],
|
|
36647
|
+
"requestBody": {
|
|
36648
|
+
"description": "Body",
|
|
36649
|
+
"content": {
|
|
36650
|
+
"application/json": {
|
|
36651
|
+
"schema": {
|
|
36652
|
+
"type": "object",
|
|
36653
|
+
"properties": {
|
|
36654
|
+
"title": {
|
|
36655
|
+
"type": "string",
|
|
36656
|
+
"minLength": 1
|
|
36657
|
+
},
|
|
36658
|
+
"content": {
|
|
36659
|
+
"type": "string",
|
|
36660
|
+
"minLength": 0
|
|
36661
|
+
},
|
|
36662
|
+
"status": {
|
|
36663
|
+
"oneOf": [
|
|
36664
|
+
{
|
|
36665
|
+
"type": "string",
|
|
36666
|
+
"enum": [
|
|
36667
|
+
"active",
|
|
36668
|
+
"draft"
|
|
36669
|
+
]
|
|
36670
|
+
},
|
|
36671
|
+
{
|
|
36672
|
+
"type": "string"
|
|
36673
|
+
}
|
|
36674
|
+
]
|
|
36675
|
+
}
|
|
36676
|
+
},
|
|
36677
|
+
"required": [
|
|
36678
|
+
"title",
|
|
36679
|
+
"content"
|
|
36680
|
+
]
|
|
36681
|
+
}
|
|
36682
|
+
}
|
|
36683
|
+
}
|
|
36684
|
+
},
|
|
36685
|
+
"responses": {
|
|
36686
|
+
"201": {
|
|
36687
|
+
"description": "201",
|
|
36688
|
+
"content": {
|
|
36689
|
+
"application/json": {
|
|
36690
|
+
"schema": {
|
|
36691
|
+
"type": "object",
|
|
36692
|
+
"properties": {
|
|
36693
|
+
"id": {
|
|
36694
|
+
"type": "integer",
|
|
36695
|
+
"minimum": 0
|
|
36696
|
+
},
|
|
36697
|
+
"status": {
|
|
36698
|
+
"oneOf": [
|
|
36699
|
+
{
|
|
36700
|
+
"type": "string",
|
|
36701
|
+
"enum": [
|
|
36702
|
+
"active",
|
|
36703
|
+
"trashed"
|
|
36704
|
+
]
|
|
36705
|
+
},
|
|
36706
|
+
{
|
|
36707
|
+
"type": "string"
|
|
36708
|
+
}
|
|
36709
|
+
]
|
|
36710
|
+
},
|
|
36711
|
+
"visible_to_clients": {
|
|
36712
|
+
"type": "boolean"
|
|
36713
|
+
},
|
|
36714
|
+
"created_at": {
|
|
36715
|
+
"type": "string",
|
|
36716
|
+
"format": "date-time"
|
|
36717
|
+
},
|
|
36718
|
+
"updated_at": {
|
|
36719
|
+
"type": "string",
|
|
36720
|
+
"format": "date-time"
|
|
36721
|
+
},
|
|
36722
|
+
"title": {
|
|
36723
|
+
"type": "string"
|
|
36724
|
+
},
|
|
36725
|
+
"inherits_status": {
|
|
36726
|
+
"type": "boolean"
|
|
36727
|
+
},
|
|
36728
|
+
"type": {
|
|
36729
|
+
"type": "string",
|
|
36730
|
+
"enum": [
|
|
36731
|
+
"Document"
|
|
36732
|
+
]
|
|
36733
|
+
},
|
|
36734
|
+
"url": {
|
|
36735
|
+
"type": "string",
|
|
36736
|
+
"format": "uri"
|
|
36737
|
+
},
|
|
36738
|
+
"app_url": {
|
|
36739
|
+
"type": "string",
|
|
36740
|
+
"format": "uri"
|
|
36741
|
+
},
|
|
36742
|
+
"bookmark_url": {
|
|
36743
|
+
"type": "string",
|
|
36744
|
+
"format": "uri"
|
|
36745
|
+
},
|
|
36746
|
+
"subscription_url": {
|
|
36747
|
+
"type": "string",
|
|
36748
|
+
"format": "uri"
|
|
36749
|
+
},
|
|
36750
|
+
"comments_count": {
|
|
36751
|
+
"type": "integer",
|
|
36752
|
+
"minimum": 0
|
|
36753
|
+
},
|
|
36754
|
+
"comments_url": {
|
|
36755
|
+
"type": "string",
|
|
36756
|
+
"format": "uri"
|
|
36757
|
+
},
|
|
36758
|
+
"position": {
|
|
36759
|
+
"type": "integer",
|
|
36760
|
+
"minimum": 0
|
|
36761
|
+
},
|
|
36762
|
+
"parent": {
|
|
36763
|
+
"type": "object",
|
|
36764
|
+
"properties": {
|
|
36765
|
+
"id": {
|
|
36766
|
+
"type": "integer",
|
|
36767
|
+
"minimum": 0
|
|
36768
|
+
},
|
|
36769
|
+
"title": {
|
|
36770
|
+
"type": "string"
|
|
36771
|
+
},
|
|
36772
|
+
"type": {
|
|
36773
|
+
"type": "string"
|
|
36774
|
+
},
|
|
36775
|
+
"url": {
|
|
36776
|
+
"type": "string",
|
|
36777
|
+
"format": "uri"
|
|
36778
|
+
},
|
|
36779
|
+
"app_url": {
|
|
36780
|
+
"type": "string",
|
|
36781
|
+
"format": "uri"
|
|
36782
|
+
}
|
|
36783
|
+
},
|
|
36784
|
+
"required": [
|
|
36785
|
+
"id",
|
|
36786
|
+
"title",
|
|
36787
|
+
"type",
|
|
36788
|
+
"url",
|
|
36789
|
+
"app_url"
|
|
36790
|
+
]
|
|
36791
|
+
},
|
|
36792
|
+
"bucket": {
|
|
36793
|
+
"type": "object",
|
|
36794
|
+
"properties": {
|
|
36795
|
+
"id": {
|
|
36796
|
+
"type": "integer",
|
|
36797
|
+
"minimum": 0
|
|
36798
|
+
},
|
|
36799
|
+
"name": {
|
|
36800
|
+
"type": "string"
|
|
36801
|
+
},
|
|
36802
|
+
"type": {
|
|
36803
|
+
"type": "string"
|
|
36804
|
+
}
|
|
36805
|
+
},
|
|
36806
|
+
"required": [
|
|
36807
|
+
"id",
|
|
36808
|
+
"name",
|
|
36809
|
+
"type"
|
|
36810
|
+
]
|
|
36811
|
+
},
|
|
36812
|
+
"creator": {
|
|
36813
|
+
"type": "object",
|
|
36814
|
+
"properties": {
|
|
36815
|
+
"id": {
|
|
36816
|
+
"type": "integer",
|
|
36817
|
+
"minimum": 0
|
|
36818
|
+
},
|
|
36819
|
+
"attachable_sgid": {
|
|
36820
|
+
"type": "string",
|
|
36821
|
+
"minLength": 1
|
|
36822
|
+
},
|
|
36823
|
+
"name": {
|
|
36824
|
+
"type": "string"
|
|
36825
|
+
},
|
|
36826
|
+
"email_address": {
|
|
36827
|
+
"type": "string",
|
|
36828
|
+
"format": "email",
|
|
36829
|
+
"nullable": true
|
|
36830
|
+
},
|
|
36831
|
+
"personable_type": {
|
|
36832
|
+
"type": "string"
|
|
36833
|
+
},
|
|
36834
|
+
"title": {
|
|
36835
|
+
"type": "string",
|
|
36836
|
+
"nullable": true
|
|
36837
|
+
},
|
|
36838
|
+
"bio": {
|
|
36839
|
+
"type": "string",
|
|
36840
|
+
"nullable": true
|
|
36841
|
+
},
|
|
36842
|
+
"location": {
|
|
36843
|
+
"type": "string",
|
|
36844
|
+
"nullable": true
|
|
36845
|
+
},
|
|
36846
|
+
"created_at": {
|
|
36847
|
+
"type": "string",
|
|
36848
|
+
"format": "date-time"
|
|
36849
|
+
},
|
|
36850
|
+
"updated_at": {
|
|
36851
|
+
"type": "string",
|
|
36852
|
+
"format": "date-time"
|
|
36853
|
+
},
|
|
36854
|
+
"admin": {
|
|
36855
|
+
"type": "boolean"
|
|
36856
|
+
},
|
|
36857
|
+
"owner": {
|
|
36858
|
+
"type": "boolean"
|
|
36859
|
+
},
|
|
36860
|
+
"client": {
|
|
36861
|
+
"type": "boolean"
|
|
36862
|
+
},
|
|
36863
|
+
"employee": {
|
|
36864
|
+
"type": "boolean"
|
|
36865
|
+
},
|
|
36866
|
+
"time_zone": {
|
|
36867
|
+
"type": "string"
|
|
36868
|
+
},
|
|
36869
|
+
"avatar_url": {
|
|
36870
|
+
"type": "string",
|
|
36871
|
+
"format": "uri"
|
|
36872
|
+
},
|
|
36873
|
+
"company": {
|
|
36874
|
+
"type": "object",
|
|
36875
|
+
"properties": {
|
|
36876
|
+
"id": {
|
|
36877
|
+
"type": "integer",
|
|
36878
|
+
"minimum": 0
|
|
36879
|
+
},
|
|
36880
|
+
"name": {
|
|
36881
|
+
"type": "string"
|
|
36882
|
+
}
|
|
36883
|
+
},
|
|
36884
|
+
"required": [
|
|
36885
|
+
"id",
|
|
36886
|
+
"name"
|
|
36887
|
+
]
|
|
36888
|
+
},
|
|
36889
|
+
"can_manage_projects": {
|
|
36890
|
+
"type": "boolean"
|
|
36891
|
+
},
|
|
36892
|
+
"can_manage_people": {
|
|
36893
|
+
"type": "boolean"
|
|
36894
|
+
}
|
|
36895
|
+
},
|
|
36896
|
+
"required": [
|
|
36897
|
+
"id",
|
|
36898
|
+
"attachable_sgid",
|
|
36899
|
+
"name",
|
|
36900
|
+
"email_address",
|
|
36901
|
+
"personable_type",
|
|
36902
|
+
"title",
|
|
36903
|
+
"bio",
|
|
36904
|
+
"location",
|
|
36905
|
+
"created_at",
|
|
36906
|
+
"updated_at",
|
|
36907
|
+
"admin",
|
|
36908
|
+
"owner",
|
|
36909
|
+
"client",
|
|
36910
|
+
"employee",
|
|
36911
|
+
"time_zone",
|
|
36912
|
+
"avatar_url",
|
|
36913
|
+
"can_manage_projects",
|
|
36914
|
+
"can_manage_people"
|
|
36915
|
+
]
|
|
36916
|
+
},
|
|
36917
|
+
"content": {
|
|
36918
|
+
"type": "string",
|
|
36919
|
+
"minLength": 0
|
|
36920
|
+
}
|
|
36921
|
+
},
|
|
36922
|
+
"required": [
|
|
36923
|
+
"id",
|
|
36924
|
+
"status",
|
|
36925
|
+
"visible_to_clients",
|
|
36926
|
+
"created_at",
|
|
36927
|
+
"updated_at",
|
|
36928
|
+
"title",
|
|
36929
|
+
"inherits_status",
|
|
36930
|
+
"type",
|
|
36931
|
+
"url",
|
|
36932
|
+
"app_url",
|
|
36933
|
+
"bucket",
|
|
36934
|
+
"creator",
|
|
36935
|
+
"content"
|
|
36936
|
+
]
|
|
36937
|
+
}
|
|
36938
|
+
}
|
|
36939
|
+
}
|
|
36940
|
+
}
|
|
36941
|
+
},
|
|
36942
|
+
"operationId": "documents.create",
|
|
36943
|
+
"externalDocs": {
|
|
36944
|
+
"description": "Official Basecamp API Documentation",
|
|
36945
|
+
"url": "https://github.com/basecamp/bc3-api/docs/basecamp-api-specs/sections/documents.md#create-a-document"
|
|
36946
|
+
},
|
|
36947
|
+
"security": [
|
|
36948
|
+
{
|
|
36949
|
+
"BearerAuth": []
|
|
36950
|
+
}
|
|
36951
|
+
],
|
|
36952
|
+
"x-client-method": "documents.create"
|
|
36953
|
+
}
|
|
36954
|
+
},
|
|
36955
|
+
"/buckets/{bucketId}/documents/{documentId}": {
|
|
36956
|
+
"get": {
|
|
36957
|
+
"description": "Fetch the full representation of a single document.",
|
|
36958
|
+
"summary": "Get a document",
|
|
36959
|
+
"tags": [
|
|
36960
|
+
"Documents"
|
|
36961
|
+
],
|
|
36962
|
+
"parameters": [
|
|
36963
|
+
{
|
|
36964
|
+
"name": "bucketId",
|
|
36965
|
+
"in": "path",
|
|
36966
|
+
"required": true,
|
|
36967
|
+
"schema": {
|
|
36968
|
+
"type": "integer",
|
|
36969
|
+
"minimum": 0,
|
|
36970
|
+
"nullable": true
|
|
36971
|
+
}
|
|
36972
|
+
},
|
|
36973
|
+
{
|
|
36974
|
+
"name": "documentId",
|
|
36975
|
+
"in": "path",
|
|
36976
|
+
"required": true,
|
|
36977
|
+
"schema": {
|
|
36978
|
+
"type": "integer",
|
|
36979
|
+
"minimum": 0,
|
|
36980
|
+
"nullable": true
|
|
36981
|
+
}
|
|
36982
|
+
},
|
|
36983
|
+
{
|
|
36984
|
+
"name": "Authorization",
|
|
36985
|
+
"in": "header",
|
|
36986
|
+
"required": true,
|
|
36987
|
+
"schema": {
|
|
36988
|
+
"type": "string",
|
|
36989
|
+
"minLength": 1
|
|
36990
|
+
}
|
|
36991
|
+
},
|
|
36992
|
+
{
|
|
36993
|
+
"name": "User-Agent",
|
|
36994
|
+
"in": "header",
|
|
36995
|
+
"schema": {
|
|
36996
|
+
"type": "string",
|
|
36997
|
+
"minLength": 1
|
|
36998
|
+
}
|
|
36999
|
+
},
|
|
37000
|
+
{
|
|
37001
|
+
"name": "Accept",
|
|
37002
|
+
"in": "header",
|
|
37003
|
+
"schema": {
|
|
37004
|
+
"type": "string",
|
|
37005
|
+
"enum": [
|
|
37006
|
+
"application/json"
|
|
37007
|
+
]
|
|
37008
|
+
}
|
|
37009
|
+
}
|
|
37010
|
+
],
|
|
37011
|
+
"responses": {
|
|
37012
|
+
"200": {
|
|
37013
|
+
"description": "200",
|
|
37014
|
+
"content": {
|
|
37015
|
+
"application/json": {
|
|
37016
|
+
"schema": {
|
|
37017
|
+
"type": "object",
|
|
37018
|
+
"properties": {
|
|
37019
|
+
"id": {
|
|
37020
|
+
"type": "integer",
|
|
37021
|
+
"minimum": 0
|
|
37022
|
+
},
|
|
37023
|
+
"status": {
|
|
37024
|
+
"oneOf": [
|
|
37025
|
+
{
|
|
37026
|
+
"type": "string",
|
|
37027
|
+
"enum": [
|
|
37028
|
+
"active",
|
|
37029
|
+
"trashed"
|
|
37030
|
+
]
|
|
37031
|
+
},
|
|
37032
|
+
{
|
|
37033
|
+
"type": "string"
|
|
37034
|
+
}
|
|
37035
|
+
]
|
|
37036
|
+
},
|
|
37037
|
+
"visible_to_clients": {
|
|
37038
|
+
"type": "boolean"
|
|
37039
|
+
},
|
|
37040
|
+
"created_at": {
|
|
37041
|
+
"type": "string",
|
|
37042
|
+
"format": "date-time"
|
|
37043
|
+
},
|
|
37044
|
+
"updated_at": {
|
|
37045
|
+
"type": "string",
|
|
37046
|
+
"format": "date-time"
|
|
37047
|
+
},
|
|
37048
|
+
"title": {
|
|
37049
|
+
"type": "string"
|
|
37050
|
+
},
|
|
37051
|
+
"inherits_status": {
|
|
37052
|
+
"type": "boolean"
|
|
37053
|
+
},
|
|
37054
|
+
"type": {
|
|
37055
|
+
"type": "string",
|
|
37056
|
+
"enum": [
|
|
37057
|
+
"Document"
|
|
37058
|
+
]
|
|
37059
|
+
},
|
|
37060
|
+
"url": {
|
|
37061
|
+
"type": "string",
|
|
37062
|
+
"format": "uri"
|
|
37063
|
+
},
|
|
37064
|
+
"app_url": {
|
|
37065
|
+
"type": "string",
|
|
37066
|
+
"format": "uri"
|
|
37067
|
+
},
|
|
37068
|
+
"bookmark_url": {
|
|
37069
|
+
"type": "string",
|
|
37070
|
+
"format": "uri"
|
|
37071
|
+
},
|
|
37072
|
+
"subscription_url": {
|
|
37073
|
+
"type": "string",
|
|
37074
|
+
"format": "uri"
|
|
37075
|
+
},
|
|
37076
|
+
"comments_count": {
|
|
37077
|
+
"type": "integer",
|
|
37078
|
+
"minimum": 0
|
|
37079
|
+
},
|
|
37080
|
+
"comments_url": {
|
|
37081
|
+
"type": "string",
|
|
37082
|
+
"format": "uri"
|
|
37083
|
+
},
|
|
37084
|
+
"position": {
|
|
37085
|
+
"type": "integer",
|
|
37086
|
+
"minimum": 0
|
|
37087
|
+
},
|
|
37088
|
+
"parent": {
|
|
37089
|
+
"type": "object",
|
|
37090
|
+
"properties": {
|
|
37091
|
+
"id": {
|
|
37092
|
+
"type": "integer",
|
|
37093
|
+
"minimum": 0
|
|
37094
|
+
},
|
|
37095
|
+
"title": {
|
|
37096
|
+
"type": "string"
|
|
37097
|
+
},
|
|
37098
|
+
"type": {
|
|
37099
|
+
"type": "string"
|
|
37100
|
+
},
|
|
37101
|
+
"url": {
|
|
37102
|
+
"type": "string",
|
|
37103
|
+
"format": "uri"
|
|
37104
|
+
},
|
|
37105
|
+
"app_url": {
|
|
37106
|
+
"type": "string",
|
|
37107
|
+
"format": "uri"
|
|
37108
|
+
}
|
|
37109
|
+
},
|
|
37110
|
+
"required": [
|
|
37111
|
+
"id",
|
|
37112
|
+
"title",
|
|
37113
|
+
"type",
|
|
37114
|
+
"url",
|
|
37115
|
+
"app_url"
|
|
37116
|
+
]
|
|
37117
|
+
},
|
|
37118
|
+
"bucket": {
|
|
37119
|
+
"type": "object",
|
|
37120
|
+
"properties": {
|
|
37121
|
+
"id": {
|
|
37122
|
+
"type": "integer",
|
|
37123
|
+
"minimum": 0
|
|
37124
|
+
},
|
|
37125
|
+
"name": {
|
|
37126
|
+
"type": "string"
|
|
37127
|
+
},
|
|
37128
|
+
"type": {
|
|
37129
|
+
"type": "string"
|
|
37130
|
+
}
|
|
37131
|
+
},
|
|
37132
|
+
"required": [
|
|
37133
|
+
"id",
|
|
37134
|
+
"name",
|
|
37135
|
+
"type"
|
|
37136
|
+
]
|
|
37137
|
+
},
|
|
37138
|
+
"creator": {
|
|
37139
|
+
"type": "object",
|
|
37140
|
+
"properties": {
|
|
37141
|
+
"id": {
|
|
37142
|
+
"type": "integer",
|
|
37143
|
+
"minimum": 0
|
|
37144
|
+
},
|
|
37145
|
+
"attachable_sgid": {
|
|
37146
|
+
"type": "string",
|
|
37147
|
+
"minLength": 1
|
|
37148
|
+
},
|
|
37149
|
+
"name": {
|
|
37150
|
+
"type": "string"
|
|
37151
|
+
},
|
|
37152
|
+
"email_address": {
|
|
37153
|
+
"type": "string",
|
|
37154
|
+
"format": "email",
|
|
37155
|
+
"nullable": true
|
|
37156
|
+
},
|
|
37157
|
+
"personable_type": {
|
|
37158
|
+
"type": "string"
|
|
37159
|
+
},
|
|
37160
|
+
"title": {
|
|
37161
|
+
"type": "string",
|
|
37162
|
+
"nullable": true
|
|
37163
|
+
},
|
|
37164
|
+
"bio": {
|
|
37165
|
+
"type": "string",
|
|
37166
|
+
"nullable": true
|
|
37167
|
+
},
|
|
37168
|
+
"location": {
|
|
37169
|
+
"type": "string",
|
|
37170
|
+
"nullable": true
|
|
37171
|
+
},
|
|
37172
|
+
"created_at": {
|
|
37173
|
+
"type": "string",
|
|
37174
|
+
"format": "date-time"
|
|
37175
|
+
},
|
|
37176
|
+
"updated_at": {
|
|
37177
|
+
"type": "string",
|
|
37178
|
+
"format": "date-time"
|
|
37179
|
+
},
|
|
37180
|
+
"admin": {
|
|
37181
|
+
"type": "boolean"
|
|
37182
|
+
},
|
|
37183
|
+
"owner": {
|
|
37184
|
+
"type": "boolean"
|
|
37185
|
+
},
|
|
37186
|
+
"client": {
|
|
37187
|
+
"type": "boolean"
|
|
37188
|
+
},
|
|
37189
|
+
"employee": {
|
|
37190
|
+
"type": "boolean"
|
|
37191
|
+
},
|
|
37192
|
+
"time_zone": {
|
|
37193
|
+
"type": "string"
|
|
37194
|
+
},
|
|
37195
|
+
"avatar_url": {
|
|
37196
|
+
"type": "string",
|
|
37197
|
+
"format": "uri"
|
|
37198
|
+
},
|
|
37199
|
+
"company": {
|
|
37200
|
+
"type": "object",
|
|
37201
|
+
"properties": {
|
|
37202
|
+
"id": {
|
|
37203
|
+
"type": "integer",
|
|
37204
|
+
"minimum": 0
|
|
37205
|
+
},
|
|
37206
|
+
"name": {
|
|
37207
|
+
"type": "string"
|
|
37208
|
+
}
|
|
37209
|
+
},
|
|
37210
|
+
"required": [
|
|
37211
|
+
"id",
|
|
37212
|
+
"name"
|
|
37213
|
+
]
|
|
37214
|
+
},
|
|
37215
|
+
"can_manage_projects": {
|
|
37216
|
+
"type": "boolean"
|
|
37217
|
+
},
|
|
37218
|
+
"can_manage_people": {
|
|
37219
|
+
"type": "boolean"
|
|
37220
|
+
}
|
|
37221
|
+
},
|
|
37222
|
+
"required": [
|
|
37223
|
+
"id",
|
|
37224
|
+
"attachable_sgid",
|
|
37225
|
+
"name",
|
|
37226
|
+
"email_address",
|
|
37227
|
+
"personable_type",
|
|
37228
|
+
"title",
|
|
37229
|
+
"bio",
|
|
37230
|
+
"location",
|
|
37231
|
+
"created_at",
|
|
37232
|
+
"updated_at",
|
|
37233
|
+
"admin",
|
|
37234
|
+
"owner",
|
|
37235
|
+
"client",
|
|
37236
|
+
"employee",
|
|
37237
|
+
"time_zone",
|
|
37238
|
+
"avatar_url",
|
|
37239
|
+
"can_manage_projects",
|
|
37240
|
+
"can_manage_people"
|
|
37241
|
+
]
|
|
37242
|
+
},
|
|
37243
|
+
"content": {
|
|
37244
|
+
"type": "string",
|
|
37245
|
+
"minLength": 0
|
|
37246
|
+
}
|
|
37247
|
+
},
|
|
37248
|
+
"required": [
|
|
37249
|
+
"id",
|
|
37250
|
+
"status",
|
|
37251
|
+
"visible_to_clients",
|
|
37252
|
+
"created_at",
|
|
37253
|
+
"updated_at",
|
|
37254
|
+
"title",
|
|
37255
|
+
"inherits_status",
|
|
37256
|
+
"type",
|
|
37257
|
+
"url",
|
|
37258
|
+
"app_url",
|
|
37259
|
+
"bucket",
|
|
37260
|
+
"creator",
|
|
37261
|
+
"content"
|
|
37262
|
+
]
|
|
37263
|
+
}
|
|
37264
|
+
}
|
|
37265
|
+
}
|
|
37266
|
+
}
|
|
37267
|
+
},
|
|
37268
|
+
"operationId": "documents.get",
|
|
37269
|
+
"externalDocs": {
|
|
37270
|
+
"description": "Official Basecamp API Documentation",
|
|
37271
|
+
"url": "https://github.com/basecamp/bc3-api/docs/basecamp-api-specs/sections/documents.md#get-a-document"
|
|
37272
|
+
},
|
|
37273
|
+
"security": [
|
|
37274
|
+
{
|
|
37275
|
+
"BearerAuth": []
|
|
37276
|
+
}
|
|
37277
|
+
],
|
|
37278
|
+
"x-client-method": "documents.get"
|
|
37279
|
+
},
|
|
37280
|
+
"put": {
|
|
37281
|
+
"description": "Update the title or content of an existing document.",
|
|
37282
|
+
"summary": "Update a document",
|
|
37283
|
+
"tags": [
|
|
37284
|
+
"Documents"
|
|
37285
|
+
],
|
|
37286
|
+
"parameters": [
|
|
37287
|
+
{
|
|
37288
|
+
"name": "bucketId",
|
|
37289
|
+
"in": "path",
|
|
37290
|
+
"required": true,
|
|
37291
|
+
"schema": {
|
|
37292
|
+
"type": "integer",
|
|
37293
|
+
"minimum": 0,
|
|
37294
|
+
"nullable": true
|
|
37295
|
+
}
|
|
37296
|
+
},
|
|
37297
|
+
{
|
|
37298
|
+
"name": "documentId",
|
|
37299
|
+
"in": "path",
|
|
37300
|
+
"required": true,
|
|
37301
|
+
"schema": {
|
|
37302
|
+
"type": "integer",
|
|
37303
|
+
"minimum": 0,
|
|
37304
|
+
"nullable": true
|
|
37305
|
+
}
|
|
37306
|
+
},
|
|
37307
|
+
{
|
|
37308
|
+
"name": "Authorization",
|
|
37309
|
+
"in": "header",
|
|
37310
|
+
"required": true,
|
|
37311
|
+
"schema": {
|
|
37312
|
+
"type": "string",
|
|
37313
|
+
"minLength": 1
|
|
37314
|
+
}
|
|
37315
|
+
},
|
|
37316
|
+
{
|
|
37317
|
+
"name": "User-Agent",
|
|
37318
|
+
"in": "header",
|
|
37319
|
+
"schema": {
|
|
37320
|
+
"type": "string",
|
|
37321
|
+
"minLength": 1
|
|
37322
|
+
}
|
|
37323
|
+
},
|
|
37324
|
+
{
|
|
37325
|
+
"name": "Accept",
|
|
37326
|
+
"in": "header",
|
|
37327
|
+
"schema": {
|
|
37328
|
+
"type": "string",
|
|
37329
|
+
"enum": [
|
|
37330
|
+
"application/json"
|
|
37331
|
+
]
|
|
37332
|
+
}
|
|
37333
|
+
}
|
|
37334
|
+
],
|
|
37335
|
+
"requestBody": {
|
|
37336
|
+
"description": "Body",
|
|
37337
|
+
"content": {
|
|
37338
|
+
"application/json": {
|
|
37339
|
+
"schema": {
|
|
37340
|
+
"type": "object",
|
|
37341
|
+
"properties": {
|
|
37342
|
+
"title": {
|
|
37343
|
+
"type": "string",
|
|
37344
|
+
"minLength": 1
|
|
37345
|
+
},
|
|
37346
|
+
"content": {
|
|
37347
|
+
"type": "string",
|
|
37348
|
+
"minLength": 0
|
|
37349
|
+
}
|
|
37350
|
+
}
|
|
37351
|
+
}
|
|
37352
|
+
}
|
|
37353
|
+
}
|
|
37354
|
+
},
|
|
37355
|
+
"responses": {
|
|
37356
|
+
"200": {
|
|
37357
|
+
"description": "200",
|
|
37358
|
+
"content": {
|
|
37359
|
+
"application/json": {
|
|
37360
|
+
"schema": {
|
|
37361
|
+
"type": "object",
|
|
37362
|
+
"properties": {
|
|
37363
|
+
"id": {
|
|
37364
|
+
"type": "integer",
|
|
37365
|
+
"minimum": 0
|
|
37366
|
+
},
|
|
37367
|
+
"status": {
|
|
37368
|
+
"oneOf": [
|
|
37369
|
+
{
|
|
37370
|
+
"type": "string",
|
|
37371
|
+
"enum": [
|
|
37372
|
+
"active",
|
|
37373
|
+
"trashed"
|
|
37374
|
+
]
|
|
37375
|
+
},
|
|
37376
|
+
{
|
|
37377
|
+
"type": "string"
|
|
37378
|
+
}
|
|
37379
|
+
]
|
|
37380
|
+
},
|
|
37381
|
+
"visible_to_clients": {
|
|
37382
|
+
"type": "boolean"
|
|
37383
|
+
},
|
|
37384
|
+
"created_at": {
|
|
37385
|
+
"type": "string",
|
|
37386
|
+
"format": "date-time"
|
|
37387
|
+
},
|
|
37388
|
+
"updated_at": {
|
|
37389
|
+
"type": "string",
|
|
37390
|
+
"format": "date-time"
|
|
37391
|
+
},
|
|
37392
|
+
"title": {
|
|
37393
|
+
"type": "string"
|
|
37394
|
+
},
|
|
37395
|
+
"inherits_status": {
|
|
37396
|
+
"type": "boolean"
|
|
37397
|
+
},
|
|
37398
|
+
"type": {
|
|
37399
|
+
"type": "string",
|
|
37400
|
+
"enum": [
|
|
37401
|
+
"Document"
|
|
37402
|
+
]
|
|
37403
|
+
},
|
|
37404
|
+
"url": {
|
|
37405
|
+
"type": "string",
|
|
37406
|
+
"format": "uri"
|
|
37407
|
+
},
|
|
37408
|
+
"app_url": {
|
|
37409
|
+
"type": "string",
|
|
37410
|
+
"format": "uri"
|
|
37411
|
+
},
|
|
37412
|
+
"bookmark_url": {
|
|
37413
|
+
"type": "string",
|
|
37414
|
+
"format": "uri"
|
|
37415
|
+
},
|
|
37416
|
+
"subscription_url": {
|
|
37417
|
+
"type": "string",
|
|
37418
|
+
"format": "uri"
|
|
37419
|
+
},
|
|
37420
|
+
"comments_count": {
|
|
37421
|
+
"type": "integer",
|
|
37422
|
+
"minimum": 0
|
|
37423
|
+
},
|
|
37424
|
+
"comments_url": {
|
|
37425
|
+
"type": "string",
|
|
37426
|
+
"format": "uri"
|
|
37427
|
+
},
|
|
37428
|
+
"position": {
|
|
37429
|
+
"type": "integer",
|
|
37430
|
+
"minimum": 0
|
|
37431
|
+
},
|
|
37432
|
+
"parent": {
|
|
37433
|
+
"type": "object",
|
|
37434
|
+
"properties": {
|
|
37435
|
+
"id": {
|
|
37436
|
+
"type": "integer",
|
|
37437
|
+
"minimum": 0
|
|
37438
|
+
},
|
|
37439
|
+
"title": {
|
|
37440
|
+
"type": "string"
|
|
37441
|
+
},
|
|
37442
|
+
"type": {
|
|
37443
|
+
"type": "string"
|
|
37444
|
+
},
|
|
37445
|
+
"url": {
|
|
37446
|
+
"type": "string",
|
|
37447
|
+
"format": "uri"
|
|
37448
|
+
},
|
|
37449
|
+
"app_url": {
|
|
37450
|
+
"type": "string",
|
|
37451
|
+
"format": "uri"
|
|
37452
|
+
}
|
|
37453
|
+
},
|
|
37454
|
+
"required": [
|
|
37455
|
+
"id",
|
|
37456
|
+
"title",
|
|
37457
|
+
"type",
|
|
37458
|
+
"url",
|
|
37459
|
+
"app_url"
|
|
37460
|
+
]
|
|
37461
|
+
},
|
|
37462
|
+
"bucket": {
|
|
37463
|
+
"type": "object",
|
|
37464
|
+
"properties": {
|
|
37465
|
+
"id": {
|
|
37466
|
+
"type": "integer",
|
|
37467
|
+
"minimum": 0
|
|
37468
|
+
},
|
|
37469
|
+
"name": {
|
|
37470
|
+
"type": "string"
|
|
37471
|
+
},
|
|
37472
|
+
"type": {
|
|
37473
|
+
"type": "string"
|
|
37474
|
+
}
|
|
37475
|
+
},
|
|
37476
|
+
"required": [
|
|
37477
|
+
"id",
|
|
37478
|
+
"name",
|
|
37479
|
+
"type"
|
|
37480
|
+
]
|
|
37481
|
+
},
|
|
37482
|
+
"creator": {
|
|
37483
|
+
"type": "object",
|
|
37484
|
+
"properties": {
|
|
37485
|
+
"id": {
|
|
37486
|
+
"type": "integer",
|
|
37487
|
+
"minimum": 0
|
|
37488
|
+
},
|
|
37489
|
+
"attachable_sgid": {
|
|
37490
|
+
"type": "string",
|
|
37491
|
+
"minLength": 1
|
|
37492
|
+
},
|
|
36469
37493
|
"name": {
|
|
36470
37494
|
"type": "string"
|
|
36471
37495
|
},
|
|
@@ -39673,6 +40697,89 @@
|
|
|
39673
40697
|
"x-client-method": "uploads.update"
|
|
39674
40698
|
}
|
|
39675
40699
|
},
|
|
40700
|
+
"/buckets/{bucketId}/uploads/{uploadId}/download/{filename}": {
|
|
40701
|
+
"get": {
|
|
40702
|
+
"description": "Download the raw file content of an upload.",
|
|
40703
|
+
"summary": "Download an upload",
|
|
40704
|
+
"tags": [
|
|
40705
|
+
"Uploads"
|
|
40706
|
+
],
|
|
40707
|
+
"parameters": [
|
|
40708
|
+
{
|
|
40709
|
+
"name": "bucketId",
|
|
40710
|
+
"in": "path",
|
|
40711
|
+
"required": true,
|
|
40712
|
+
"schema": {
|
|
40713
|
+
"type": "integer",
|
|
40714
|
+
"minimum": 0,
|
|
40715
|
+
"nullable": true
|
|
40716
|
+
}
|
|
40717
|
+
},
|
|
40718
|
+
{
|
|
40719
|
+
"name": "uploadId",
|
|
40720
|
+
"in": "path",
|
|
40721
|
+
"required": true,
|
|
40722
|
+
"schema": {
|
|
40723
|
+
"type": "integer",
|
|
40724
|
+
"minimum": 0,
|
|
40725
|
+
"nullable": true
|
|
40726
|
+
}
|
|
40727
|
+
},
|
|
40728
|
+
{
|
|
40729
|
+
"name": "filename",
|
|
40730
|
+
"in": "path",
|
|
40731
|
+
"required": true,
|
|
40732
|
+
"schema": {
|
|
40733
|
+
"type": "string",
|
|
40734
|
+
"minLength": 1
|
|
40735
|
+
}
|
|
40736
|
+
},
|
|
40737
|
+
{
|
|
40738
|
+
"name": "Authorization",
|
|
40739
|
+
"in": "header",
|
|
40740
|
+
"required": true,
|
|
40741
|
+
"schema": {
|
|
40742
|
+
"type": "string",
|
|
40743
|
+
"minLength": 1
|
|
40744
|
+
}
|
|
40745
|
+
},
|
|
40746
|
+
{
|
|
40747
|
+
"name": "User-Agent",
|
|
40748
|
+
"in": "header",
|
|
40749
|
+
"schema": {
|
|
40750
|
+
"type": "string",
|
|
40751
|
+
"minLength": 1
|
|
40752
|
+
}
|
|
40753
|
+
},
|
|
40754
|
+
{
|
|
40755
|
+
"name": "Accept",
|
|
40756
|
+
"in": "header",
|
|
40757
|
+
"schema": {
|
|
40758
|
+
"type": "string",
|
|
40759
|
+
"enum": [
|
|
40760
|
+
"application/json"
|
|
40761
|
+
]
|
|
40762
|
+
}
|
|
40763
|
+
}
|
|
40764
|
+
],
|
|
40765
|
+
"responses": {
|
|
40766
|
+
"200": {
|
|
40767
|
+
"description": "200"
|
|
40768
|
+
}
|
|
40769
|
+
},
|
|
40770
|
+
"operationId": "uploads.download",
|
|
40771
|
+
"externalDocs": {
|
|
40772
|
+
"description": "Official Basecamp API Documentation",
|
|
40773
|
+
"url": "https://github.com/basecamp/bc3-api/docs/basecamp-api-specs/sections/uploads.md"
|
|
40774
|
+
},
|
|
40775
|
+
"security": [
|
|
40776
|
+
{
|
|
40777
|
+
"BearerAuth": []
|
|
40778
|
+
}
|
|
40779
|
+
],
|
|
40780
|
+
"x-client-method": "uploads.download"
|
|
40781
|
+
}
|
|
40782
|
+
},
|
|
39676
40783
|
"/buckets/{bucketId}/recordings/{uploadId}/status/trashed": {
|
|
39677
40784
|
"put": {
|
|
39678
40785
|
"description": "Move an upload recording to the trash. Trashed items can be restored via the UI.",
|
|
@@ -39825,6 +40932,74 @@
|
|
|
39825
40932
|
],
|
|
39826
40933
|
"x-client-method": "attachments.create"
|
|
39827
40934
|
}
|
|
40935
|
+
},
|
|
40936
|
+
"/blobs/{blobId}/download/{filename}": {
|
|
40937
|
+
"get": {
|
|
40938
|
+
"description": "Download the raw file content of a blob. Blobs represent files embedded in documents and messages via bc-attachment tags.",
|
|
40939
|
+
"summary": "Download a blob",
|
|
40940
|
+
"tags": [
|
|
40941
|
+
"Blobs"
|
|
40942
|
+
],
|
|
40943
|
+
"parameters": [
|
|
40944
|
+
{
|
|
40945
|
+
"name": "blobId",
|
|
40946
|
+
"in": "path",
|
|
40947
|
+
"required": true,
|
|
40948
|
+
"schema": {
|
|
40949
|
+
"type": "string",
|
|
40950
|
+
"minLength": 1
|
|
40951
|
+
}
|
|
40952
|
+
},
|
|
40953
|
+
{
|
|
40954
|
+
"name": "filename",
|
|
40955
|
+
"in": "path",
|
|
40956
|
+
"required": true,
|
|
40957
|
+
"schema": {
|
|
40958
|
+
"type": "string",
|
|
40959
|
+
"minLength": 1
|
|
40960
|
+
}
|
|
40961
|
+
},
|
|
40962
|
+
{
|
|
40963
|
+
"name": "Authorization",
|
|
40964
|
+
"in": "header",
|
|
40965
|
+
"required": true,
|
|
40966
|
+
"schema": {
|
|
40967
|
+
"type": "string",
|
|
40968
|
+
"minLength": 1
|
|
40969
|
+
}
|
|
40970
|
+
},
|
|
40971
|
+
{
|
|
40972
|
+
"name": "User-Agent",
|
|
40973
|
+
"in": "header",
|
|
40974
|
+
"schema": {
|
|
40975
|
+
"type": "string",
|
|
40976
|
+
"minLength": 1
|
|
40977
|
+
}
|
|
40978
|
+
},
|
|
40979
|
+
{
|
|
40980
|
+
"name": "Accept",
|
|
40981
|
+
"in": "header",
|
|
40982
|
+
"schema": {
|
|
40983
|
+
"type": "string",
|
|
40984
|
+
"enum": [
|
|
40985
|
+
"application/json"
|
|
40986
|
+
]
|
|
40987
|
+
}
|
|
40988
|
+
}
|
|
40989
|
+
],
|
|
40990
|
+
"responses": {
|
|
40991
|
+
"200": {
|
|
40992
|
+
"description": "200"
|
|
40993
|
+
}
|
|
40994
|
+
},
|
|
40995
|
+
"operationId": "blobs.download",
|
|
40996
|
+
"security": [
|
|
40997
|
+
{
|
|
40998
|
+
"BearerAuth": []
|
|
40999
|
+
}
|
|
41000
|
+
],
|
|
41001
|
+
"x-client-method": "blobs.download"
|
|
41002
|
+
}
|
|
39828
41003
|
}
|
|
39829
41004
|
},
|
|
39830
41005
|
"info": {
|