@teamleader/focus-api-specification 1.32.0 → 1.34.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.
Files changed (12) hide show
  1. package/dist/api.focus.teamleader.eu.dereferenced.yaml +2197 -1137
  2. package/dist/api.focus.teamleader.eu.yaml +974 -28
  3. package/dist/changelog/20251028000001.md +5 -0
  4. package/dist/changelog/20251028000002.md +5 -0
  5. package/dist/changelog/20251028173600.md +5 -0
  6. package/dist/changelog/20251029000001.md +5 -0
  7. package/dist/changelog/20251029000002.md +5 -0
  8. package/dist/changelog/20251029000003.md +5 -0
  9. package/dist/changelog/20251029000004.md +5 -0
  10. package/dist/changelog/20251029000005.md +5 -0
  11. package/dist/changelog/20251029000006.md +5 -0
  12. package/package.json +1 -1
package/dist/api.focus.teamleader.eu.yaml CHANGED
@@ -3,7 +3,7 @@ info:
3
3
  title: Teamleader API
4
4
  description: This is the documentation of the Teamleader Focus API. If you have any feedback, or are you missing functionality to support your use case? Let us know via [api@teamleader.eu](mailto:api@teamleader.eu).
5
5
  contact: {}
6
- version: 1.32.0
6
+ version: 1.34.0
7
7
  servers:
8
8
  - url: https://api.focus.teamleader.eu
9
9
  variables: {}
@@ -328,6 +328,15 @@ tags:
328
328
  - name: accounts
329
329
  description: Accounts
330
330
  x-displayName: Accounts
331
+ - name: plannable_items
332
+ description: Plannable items
333
+ x-displayName: Plannable items
334
+ - name: reservations
335
+ description: Reservations
336
+ x-displayName: Reservations
337
+ - name: user_availability
338
+ description: User availability
339
+ x-displayName: User availability
331
340
  paths:
332
341
  /departments.list:
333
342
  post:
@@ -4354,6 +4363,7 @@ paths:
4354
4363
  from: USD
4355
4364
  to: EUR
4356
4365
  rate: 1.1234
4366
+ text: Quotation text
4357
4367
  total:
4358
4368
  tax_exclusive:
4359
4369
  amount: 123.3
@@ -4439,6 +4449,7 @@ paths:
4439
4449
  from: USD
4440
4450
  to: EUR
4441
4451
  rate: 1.1234
4452
+ text: Quotation text
4442
4453
  total:
4443
4454
  tax_exclusive:
4444
4455
  amount: 123.3
@@ -15939,6 +15950,448 @@ paths:
15939
15950
  status: projects-v2
15940
15951
  will_be_automatically_switched_on: '2024-12-31'
15941
15952
  deprecated: false
15953
+ /plannableItems.list:
15954
+ post:
15955
+ tags:
15956
+ - plannable_items
15957
+ summary: plannableItems.list
15958
+ description: Lists all plannable items that match the optional filters provided.
15959
+ operationId: plannableItems.list
15960
+ parameters: []
15961
+ requestBody:
15962
+ description: ''
15963
+ content:
15964
+ application/json:
15965
+ schema:
15966
+ allOf:
15967
+ - $ref: '#/components/schemas/plannableItems.listrequest'
15968
+ - example:
15969
+ filter:
15970
+ ids:
15971
+ - 018d79a1-2b99-7fbd-b323-500b01305371
15972
+ example:
15973
+ filter:
15974
+ ids:
15975
+ - 018d79a1-2b99-7fbd-b323-500b01305371
15976
+ required: true
15977
+ responses:
15978
+ '200':
15979
+ description: ''
15980
+ headers: {}
15981
+ content:
15982
+ application/json:
15983
+ schema:
15984
+ allOf:
15985
+ - $ref: '#/components/schemas/plannableItems.listresponse'
15986
+ - example:
15987
+ data:
15988
+ - id: 018d79a1-2b99-7fbd-b323-500b01305371
15989
+ source:
15990
+ type: task
15991
+ id: 948b8ca5-58aa-0844-ba34-cee255aa9694
15992
+ total_duration:
15993
+ value: 600
15994
+ currency: minutes
15995
+ planned_duration:
15996
+ value: 600
15997
+ currency: minutes
15998
+ unplanned_duration:
15999
+ value: 0
16000
+ currency: minutes
16001
+ example:
16002
+ data:
16003
+ - id: 018d79a1-2b99-7fbd-b323-500b01305371
16004
+ source:
16005
+ type: task
16006
+ id: 948b8ca5-58aa-0844-ba34-cee255aa9694
16007
+ total_duration:
16008
+ value: 600
16009
+ currency: minutes
16010
+ planned_duration:
16011
+ value: 600
16012
+ currency: minutes
16013
+ unplanned_duration:
16014
+ value: 0
16015
+ currency: minutes
16016
+ deprecated: false
16017
+ /plannableItems.info:
16018
+ post:
16019
+ tags:
16020
+ - plannable_items
16021
+ summary: plannableItems.info
16022
+ description: Returns the info for a single plannable item, either by ID or source if the ID is unknown.
16023
+ operationId: plannableItems.info
16024
+ parameters: []
16025
+ requestBody:
16026
+ description: ''
16027
+ content:
16028
+ application/json:
16029
+ schema:
16030
+ allOf:
16031
+ - $ref: '#/components/schemas/plannableItems.inforequest'
16032
+ - example:
16033
+ id: 018d79a1-2b99-7fbd-b323-500b01305371
16034
+ example:
16035
+ id: 018d79a1-2b99-7fbd-b323-500b01305371
16036
+ required: true
16037
+ responses:
16038
+ '200':
16039
+ description: ''
16040
+ headers: {}
16041
+ content:
16042
+ application/json:
16043
+ schema:
16044
+ allOf:
16045
+ - $ref: '#/components/schemas/plannableItems.inforesponse'
16046
+ - example:
16047
+ data:
16048
+ id: 018d79a1-2b99-7fbd-b323-500b01305371
16049
+ source:
16050
+ type: task
16051
+ id: 948b8ca5-58aa-0844-ba34-cee255aa9694
16052
+ total_duration:
16053
+ value: 600
16054
+ currency: minutes
16055
+ planned_duration:
16056
+ value: 600
16057
+ currency: minutes
16058
+ unplanned_duration:
16059
+ value: 0
16060
+ currency: minutes
16061
+ example:
16062
+ data:
16063
+ id: 018d79a1-2b99-7fbd-b323-500b01305371
16064
+ source:
16065
+ type: task
16066
+ id: 948b8ca5-58aa-0844-ba34-cee255aa9694
16067
+ total_duration:
16068
+ value: 600
16069
+ currency: minutes
16070
+ planned_duration:
16071
+ value: 600
16072
+ currency: minutes
16073
+ unplanned_duration:
16074
+ value: 0
16075
+ currency: minutes
16076
+ deprecated: false
16077
+ /reservations.list:
16078
+ post:
16079
+ tags:
16080
+ - reservations
16081
+ summary: reservations.list
16082
+ description: Lists all reservations that match the optional filters provided.
16083
+ operationId: reservations.list
16084
+ parameters: []
16085
+ requestBody:
16086
+ description: ''
16087
+ content:
16088
+ application/json:
16089
+ schema:
16090
+ allOf:
16091
+ - $ref: '#/components/schemas/reservations.listrequest'
16092
+ - example:
16093
+ plannable_item_ids:
16094
+ - 46156648-87c6-478d-8aa7-1dc3a00dacab
16095
+ example:
16096
+ plannable_item_ids:
16097
+ - 46156648-87c6-478d-8aa7-1dc3a00dacab
16098
+ required: true
16099
+ responses:
16100
+ '200':
16101
+ description: ''
16102
+ headers: {}
16103
+ content:
16104
+ application/json:
16105
+ schema:
16106
+ allOf:
16107
+ - $ref: '#/components/schemas/reservations.listresponse'
16108
+ - example:
16109
+ data:
16110
+ - id: 018d79a1-2b99-7fbd-b323-500b01305371
16111
+ plannable_item:
16112
+ type: plannableItem
16113
+ id: 46156648-87c6-478d-8aa7-1dc3a00dacab
16114
+ date: '2024-01-02'
16115
+ duration:
16116
+ value: 60
16117
+ currency: minutes
16118
+ assignee: null
16119
+ origin: null
16120
+ source:
16121
+ type: task
16122
+ id: 948b8ca5-58aa-0844-ba34-cee255aa9694
16123
+ example:
16124
+ data:
16125
+ - id: 018d79a1-2b99-7fbd-b323-500b01305371
16126
+ plannable_item:
16127
+ type: plannableItem
16128
+ id: 46156648-87c6-478d-8aa7-1dc3a00dacab
16129
+ date: '2024-01-02'
16130
+ duration:
16131
+ value: 60
16132
+ currency: minutes
16133
+ assignee: null
16134
+ origin: null
16135
+ source:
16136
+ type: task
16137
+ id: 948b8ca5-58aa-0844-ba34-cee255aa9694
16138
+ deprecated: false
16139
+ /reservations.create:
16140
+ post:
16141
+ tags:
16142
+ - reservations
16143
+ summary: reservations.create
16144
+ description: Create a new reservation.
16145
+ operationId: reservations.create
16146
+ parameters: []
16147
+ requestBody:
16148
+ description: ''
16149
+ content:
16150
+ application/json:
16151
+ schema:
16152
+ allOf:
16153
+ - $ref: '#/components/schemas/reservations.createrequest'
16154
+ - example:
16155
+ plannable_item_id: 46156648-87c6-478d-8aa7-1dc3a00dacab
16156
+ date: '2024-01-12'
16157
+ duration:
16158
+ value: 60
16159
+ unit: minutes
16160
+ assignee:
16161
+ type: user
16162
+ id: b38ebb9b-6e46-4bf4-a1e2-af747d6b64ae
16163
+ example:
16164
+ plannable_item_id: 46156648-87c6-478d-8aa7-1dc3a00dacab
16165
+ date: '2024-01-12'
16166
+ duration:
16167
+ value: 60
16168
+ unit: minutes
16169
+ assignee:
16170
+ type: user
16171
+ id: b38ebb9b-6e46-4bf4-a1e2-af747d6b64ae
16172
+ required: true
16173
+ responses:
16174
+ '201':
16175
+ description: ''
16176
+ headers: {}
16177
+ content:
16178
+ application/json:
16179
+ schema:
16180
+ allOf:
16181
+ - $ref: '#/components/schemas/reservations.createresponse'
16182
+ - example:
16183
+ data:
16184
+ type: reservation
16185
+ id: 019a3012-c800-7109-ae63-0ab5bcd3b484
16186
+ example:
16187
+ data:
16188
+ type: reservation
16189
+ id: 019a3012-c800-7109-ae63-0ab5bcd3b484
16190
+ deprecated: false
16191
+ /reservations.update:
16192
+ post:
16193
+ tags:
16194
+ - reservations
16195
+ summary: reservations.update
16196
+ description: Update an existing reservation.
16197
+ operationId: reservations.update
16198
+ parameters: []
16199
+ requestBody:
16200
+ description: ''
16201
+ content:
16202
+ application/json:
16203
+ schema:
16204
+ allOf:
16205
+ - $ref: '#/components/schemas/reservations.updaterequest'
16206
+ - example:
16207
+ id: 019a3012-c800-7109-ae63-0ab5bcd3b484
16208
+ date: '2024-01-01'
16209
+ duration:
16210
+ value: 120
16211
+ unit: minutes
16212
+ example:
16213
+ id: 019a3012-c800-7109-ae63-0ab5bcd3b484
16214
+ date: '2024-01-01'
16215
+ duration:
16216
+ value: 120
16217
+ unit: minutes
16218
+ required: true
16219
+ responses:
16220
+ '204':
16221
+ description: ''
16222
+ headers: {}
16223
+ content: {}
16224
+ deprecated: false
16225
+ /reservations.delete:
16226
+ post:
16227
+ tags:
16228
+ - reservations
16229
+ summary: reservations.delete
16230
+ description: Delete a reservation.
16231
+ operationId: reservations.delete
16232
+ parameters: []
16233
+ requestBody:
16234
+ description: ''
16235
+ content:
16236
+ application/json:
16237
+ schema:
16238
+ allOf:
16239
+ - $ref: '#/components/schemas/reservations.deleterequest'
16240
+ - example:
16241
+ id: 019a3012-c800-7109-ae63-0ab5bcd3b484
16242
+ example:
16243
+ id: 019a3012-c800-7109-ae63-0ab5bcd3b484
16244
+ required: true
16245
+ responses:
16246
+ '204':
16247
+ description: ''
16248
+ headers: {}
16249
+ content: {}
16250
+ deprecated: false
16251
+ /userAvailability.total:
16252
+ post:
16253
+ tags:
16254
+ - user_availability
16255
+ summary: userAvailability.total
16256
+ description: Returns the total availability for all users.
16257
+ operationId: userAvailability.total
16258
+ parameters: []
16259
+ requestBody:
16260
+ description: ''
16261
+ content:
16262
+ application/json:
16263
+ schema:
16264
+ allOf:
16265
+ - $ref: '#/components/schemas/userAvailability.totalrequest'
16266
+ - example:
16267
+ period:
16268
+ start_date: '2024-01-01'
16269
+ end_date: '2024-01-07'
16270
+ example:
16271
+ period:
16272
+ start_date: '2024-01-01'
16273
+ end_date: '2024-01-07'
16274
+ required: true
16275
+ responses:
16276
+ '200':
16277
+ description: ''
16278
+ headers: {}
16279
+ content:
16280
+ application/json:
16281
+ schema:
16282
+ allOf:
16283
+ - $ref: '#/components/schemas/userAvailability.totalresponse'
16284
+ - example:
16285
+ data:
16286
+ - user:
16287
+ type: user
16288
+ id: 1c00aeaa-0a47-0ce5-8f2b-60935c241f12
16289
+ availability:
16290
+ gross_time_available:
16291
+ value: 480
16292
+ unit: minutes
16293
+ net_time_available:
16294
+ value: 480
16295
+ unit: minutes
16296
+ planned_time:
16297
+ value: 60
16298
+ unit: minutes
16299
+ unplanned_time:
16300
+ value: 420
16301
+ unit: minutes
16302
+ example:
16303
+ data:
16304
+ - user:
16305
+ type: user
16306
+ id: 1c00aeaa-0a47-0ce5-8f2b-60935c241f12
16307
+ availability:
16308
+ gross_time_available:
16309
+ value: 480
16310
+ unit: minutes
16311
+ net_time_available:
16312
+ value: 480
16313
+ unit: minutes
16314
+ planned_time:
16315
+ value: 60
16316
+ unit: minutes
16317
+ unplanned_time:
16318
+ value: 420
16319
+ unit: minutes
16320
+ deprecated: false
16321
+ /userAvailability.daily:
16322
+ post:
16323
+ tags:
16324
+ - user_availability
16325
+ summary: userAvailability.daily
16326
+ description: Returns the daily availability for all users.
16327
+ operationId: userAvailability.daily
16328
+ parameters: []
16329
+ requestBody:
16330
+ description: ''
16331
+ content:
16332
+ application/json:
16333
+ schema:
16334
+ allOf:
16335
+ - $ref: '#/components/schemas/userAvailability.dailyrequest'
16336
+ - example:
16337
+ period:
16338
+ start_date: '2024-01-01'
16339
+ end_date: '2024-01-01'
16340
+ example:
16341
+ period:
16342
+ start_date: '2024-01-01'
16343
+ end_date: '2024-01-01'
16344
+ required: true
16345
+ responses:
16346
+ '200':
16347
+ description: ''
16348
+ headers: {}
16349
+ content:
16350
+ application/json:
16351
+ schema:
16352
+ allOf:
16353
+ - $ref: '#/components/schemas/userAvailability.dailyresponse'
16354
+ - example:
16355
+ data:
16356
+ - user:
16357
+ type: user
16358
+ id: 1c00aeaa-0a47-0ce5-8f2b-60935c241f12
16359
+ availabilities:
16360
+ - date: '2024-01-01'
16361
+ availability:
16362
+ gross_time_available:
16363
+ value: 480
16364
+ unit: minutes
16365
+ net_time_available:
16366
+ value: 480
16367
+ unit: minutes
16368
+ planned_time:
16369
+ value: 60
16370
+ unit: minutes
16371
+ unplanned_time:
16372
+ value: 420
16373
+ unit: minutes
16374
+ example:
16375
+ data:
16376
+ - user:
16377
+ type: user
16378
+ id: 1c00aeaa-0a47-0ce5-8f2b-60935c241f12
16379
+ availabilities:
16380
+ - date: '2024-01-01'
16381
+ availability:
16382
+ gross_time_available:
16383
+ value: 480
16384
+ unit: minutes
16385
+ net_time_available:
16386
+ value: 480
16387
+ unit: minutes
16388
+ planned_time:
16389
+ value: 60
16390
+ unit: minutes
16391
+ unplanned_time:
16392
+ value: 420
16393
+ unit: minutes
16394
+ deprecated: false
15942
16395
  components:
15943
16396
  securitySchemes:
15944
16397
  httpBearer:
@@ -20084,6 +20537,10 @@ components:
20084
20537
  example: USD
20085
20538
  currency_exchange_rate:
20086
20539
  $ref: '#/components/schemas/CurrencyExchangeRate'
20540
+ text:
20541
+ type: string
20542
+ description: Uses Markdown formatting
20543
+ example: Quotation text
20087
20544
  total:
20088
20545
  type: object
20089
20546
  properties:
@@ -30026,33 +30483,517 @@ components:
30026
30483
  type: string
30027
30484
  description: Date when the account will be automatically switched to `projects-v2` version (optional).
30028
30485
  example: '2024-12-31'
30029
- x-tagGroups:
30030
- - name: General
30031
- tags:
30032
- - departments
30033
- - users
30034
- - teams
30035
- - custom_fields
30036
- - work_types
30037
- - document_templates
30038
- - currencies
30039
- - notes
30040
- - email_tracking
30041
- - closing_days
30042
- - day_off_types
30043
- - days_off
30044
- - name: CRM
30045
- tags:
30046
- - contacts
30047
- - companies
30048
- - business_types
30049
- - tags
30050
- - addresses
30051
- - name: Deals
30052
- tags:
30053
- - deals
30054
- - deal_pipelines
30055
- - deal_phases
30486
+ plannableItems.listrequest:
30487
+ title: plannableItems.listrequest
30488
+ type: object
30489
+ properties:
30490
+ filter:
30491
+ type: object
30492
+ properties:
30493
+ ids:
30494
+ type: array
30495
+ items:
30496
+ type: string
30497
+ status:
30498
+ type: array
30499
+ items:
30500
+ type: string
30501
+ enum:
30502
+ - active
30503
+ - deactivated
30504
+ example: active
30505
+ term:
30506
+ type: string
30507
+ example: Set-up
30508
+ start_date:
30509
+ type: string
30510
+ example: '2023-10-02'
30511
+ end_date:
30512
+ type: string
30513
+ example: '2023-10-06'
30514
+ project_ids:
30515
+ type: array
30516
+ items:
30517
+ type: string
30518
+ assignees:
30519
+ type: array
30520
+ description: To fetch unassigned plannable items, provide `null` instead of the type/id object
30521
+ items:
30522
+ allOf:
30523
+ - $ref: '#/components/schemas/Assignee'
30524
+ - type: object
30525
+ required:
30526
+ - type
30527
+ - id
30528
+ properties:
30529
+ type:
30530
+ type: string
30531
+ enum:
30532
+ - team
30533
+ - user
30534
+ example: user
30535
+ work_type_ids:
30536
+ type: array
30537
+ items:
30538
+ type: string
30539
+ completion_statuses:
30540
+ type: array
30541
+ items:
30542
+ type: string
30543
+ enum:
30544
+ - to_do
30545
+ - done
30546
+ example: to_do
30547
+ planned_time_statuses:
30548
+ type: array
30549
+ items:
30550
+ type: string
30551
+ enum:
30552
+ - unplanned
30553
+ - partially_planned
30554
+ - fully_planned
30555
+ - overbooked
30556
+ example: unplanned
30557
+ page:
30558
+ $ref: '#/components/schemas/Page'
30559
+ sort:
30560
+ type: array
30561
+ items:
30562
+ allOf:
30563
+ - $ref: '#/components/schemas/Sort'
30564
+ - properties:
30565
+ field:
30566
+ type: string
30567
+ enum:
30568
+ - id
30569
+ - end_date
30570
+ - total_duration
30571
+ default: id
30572
+ order:
30573
+ default: asc
30574
+ DurationInMinutesFull:
30575
+ title: DurationInMinutesFull
30576
+ type: object
30577
+ properties:
30578
+ unit:
30579
+ type: string
30580
+ enum:
30581
+ - minutes
30582
+ example: minutes
30583
+ value:
30584
+ type: number
30585
+ example: 60
30586
+ plannableItems.listresponse:
30587
+ title: plannableItems.listresponse
30588
+ type: object
30589
+ properties:
30590
+ data:
30591
+ type: array
30592
+ items:
30593
+ type: object
30594
+ properties:
30595
+ id:
30596
+ type: string
30597
+ example: 018d55af-d0d7-76be-8185-ee970a7f3826
30598
+ source:
30599
+ allOf:
30600
+ - $ref: '#/components/schemas/TypeAndId'
30601
+ - properties:
30602
+ type:
30603
+ type: string
30604
+ example: task
30605
+ total_duration:
30606
+ allOf:
30607
+ - $ref: '#/components/schemas/DurationInMinutesFull'
30608
+ planned_duration:
30609
+ allOf:
30610
+ - $ref: '#/components/schemas/DurationInMinutesFull'
30611
+ unplanned_duration:
30612
+ allOf:
30613
+ - $ref: '#/components/schemas/DurationInMinutesFull'
30614
+ plannableItems.inforequest:
30615
+ title: plannableItems.inforequest
30616
+ type: object
30617
+ properties:
30618
+ id:
30619
+ type: string
30620
+ example: 018d79a1-2b99-7fbd-b323-500b01305371
30621
+ source:
30622
+ allOf:
30623
+ - $ref: '#/components/schemas/TypeAndId'
30624
+ - properties:
30625
+ type:
30626
+ type: string
30627
+ example: task
30628
+ plannableItems.inforesponse:
30629
+ title: plannableItems.inforesponse
30630
+ type: object
30631
+ properties:
30632
+ data:
30633
+ type: object
30634
+ properties:
30635
+ id:
30636
+ type: string
30637
+ example: 018d55af-d0d7-76be-8185-ee970a7f3826
30638
+ source:
30639
+ allOf:
30640
+ - $ref: '#/components/schemas/TypeAndId'
30641
+ - properties:
30642
+ type:
30643
+ type: string
30644
+ example: task
30645
+ total_duration:
30646
+ allOf:
30647
+ - $ref: '#/components/schemas/DurationInMinutesFull'
30648
+ planned_duration:
30649
+ allOf:
30650
+ - $ref: '#/components/schemas/DurationInMinutesFull'
30651
+ unplanned_duration:
30652
+ allOf:
30653
+ - $ref: '#/components/schemas/DurationInMinutesFull'
30654
+ SourceType:
30655
+ title: SourceType
30656
+ enum:
30657
+ - call
30658
+ - closingDay
30659
+ - dayOffType
30660
+ - externalEvent
30661
+ - meeting
30662
+ - task
30663
+ type: string
30664
+ reservations.listrequest:
30665
+ title: reservations.listrequest
30666
+ type: object
30667
+ properties:
30668
+ filter:
30669
+ type: object
30670
+ properties:
30671
+ plannable_item_ids:
30672
+ type: array
30673
+ items:
30674
+ type: string
30675
+ start_date:
30676
+ type: string
30677
+ example: '2024-01-11'
30678
+ end_date:
30679
+ type: string
30680
+ example: '2024-01-12'
30681
+ assignees:
30682
+ type: array
30683
+ description: To fetch unassigned reservations, provide `null` instead of the type/id object
30684
+ items:
30685
+ allOf:
30686
+ - $ref: '#/components/schemas/Assignee'
30687
+ - type: object
30688
+ required:
30689
+ - type
30690
+ - id
30691
+ properties:
30692
+ type:
30693
+ type: string
30694
+ enum:
30695
+ - team
30696
+ - user
30697
+ example: user
30698
+ sources:
30699
+ type: array
30700
+ items:
30701
+ allOf:
30702
+ - $ref: '#/components/schemas/TypeAndId'
30703
+ - properties:
30704
+ type:
30705
+ $ref: '#/components/schemas/SourceType'
30706
+ source_types:
30707
+ type: array
30708
+ items:
30709
+ $ref: '#/components/schemas/SourceType'
30710
+ page:
30711
+ $ref: '#/components/schemas/Page'
30712
+ reservations.listresponse:
30713
+ title: reservations.listresponse
30714
+ type: object
30715
+ properties:
30716
+ data:
30717
+ type: array
30718
+ items:
30719
+ type: object
30720
+ properties:
30721
+ id:
30722
+ type: string
30723
+ example: 39c64ba9-ebf1-491a-8486-a0b96ff21c07
30724
+ plannable_item:
30725
+ allOf:
30726
+ - $ref: '#/components/schemas/TypeAndId'
30727
+ - properties:
30728
+ type:
30729
+ type: string
30730
+ example: plannableItem
30731
+ date:
30732
+ type: string
30733
+ example: '2024-01-11'
30734
+ duration:
30735
+ allOf:
30736
+ - $ref: '#/components/schemas/DurationInMinutesFull'
30737
+ assignee:
30738
+ allOf:
30739
+ - $ref: '#/components/schemas/Assignee'
30740
+ - type: object
30741
+ required:
30742
+ - type
30743
+ - id
30744
+ properties:
30745
+ type:
30746
+ type: string
30747
+ enum:
30748
+ - team
30749
+ - user
30750
+ example: user
30751
+ origin:
30752
+ allOf:
30753
+ - $ref: '#/components/schemas/TypeAndId'
30754
+ - properties:
30755
+ type:
30756
+ type: string
30757
+ example: dayOff
30758
+ reservations.createrequest:
30759
+ title: reservations.createrequest
30760
+ type: object
30761
+ required:
30762
+ - plannable_item_id
30763
+ - date
30764
+ - duration
30765
+ - assignee
30766
+ properties:
30767
+ plannable_item_id:
30768
+ type: string
30769
+ example: e82cec33-24c9-4d13-96cb-d515a1660c8d
30770
+ date:
30771
+ type: string
30772
+ example: '2024-01-12'
30773
+ duration:
30774
+ allOf:
30775
+ - $ref: '#/components/schemas/DurationInMinutesFull'
30776
+ assignee:
30777
+ allOf:
30778
+ - $ref: '#/components/schemas/Assignee'
30779
+ - type: object
30780
+ required:
30781
+ - type
30782
+ - id
30783
+ properties:
30784
+ type:
30785
+ type: string
30786
+ enum:
30787
+ - team
30788
+ - user
30789
+ example: user
30790
+ reservations.createresponse:
30791
+ title: reservations.createresponse
30792
+ type: object
30793
+ properties:
30794
+ data:
30795
+ $ref: '#/components/schemas/TypeAndId'
30796
+ reservations.updaterequest:
30797
+ title: reservations.updaterequest
30798
+ type: object
30799
+ required:
30800
+ - id
30801
+ properties:
30802
+ id:
30803
+ type: string
30804
+ example: 01878019-c72c-70dc-b097-7e519c775e35
30805
+ date:
30806
+ type: string
30807
+ example: '2024-01-12'
30808
+ duration:
30809
+ allOf:
30810
+ - $ref: '#/components/schemas/DurationInMinutesFull'
30811
+ assignee:
30812
+ allOf:
30813
+ - $ref: '#/components/schemas/Assignee'
30814
+ - type: object
30815
+ required:
30816
+ - type
30817
+ - id
30818
+ properties:
30819
+ type:
30820
+ type: string
30821
+ enum:
30822
+ - team
30823
+ - user
30824
+ example: user
30825
+ reservations.deleterequest:
30826
+ title: reservations.deleterequest
30827
+ type: object
30828
+ required:
30829
+ - id
30830
+ properties:
30831
+ id:
30832
+ type: string
30833
+ example: 01878019-c72c-70dc-b097-7e519c775e35
30834
+ Period:
30835
+ title: Period
30836
+ type: object
30837
+ properties:
30838
+ start_date:
30839
+ type: string
30840
+ default: '2023-10-02'
30841
+ end_date:
30842
+ type: string
30843
+ default: '2023-10-06'
30844
+ userAvailability.totalrequest:
30845
+ title: userAvailability.totalrequest
30846
+ type: object
30847
+ required:
30848
+ - period
30849
+ properties:
30850
+ period:
30851
+ allOf:
30852
+ - $ref: '#/components/schemas/Period'
30853
+ - description: A maximum duration of 20.000 days can be passed
30854
+ filter:
30855
+ type: object
30856
+ properties:
30857
+ assignees:
30858
+ type: array
30859
+ items:
30860
+ allOf:
30861
+ - $ref: '#/components/schemas/Assignee'
30862
+ - type: object
30863
+ required:
30864
+ - type
30865
+ - id
30866
+ properties:
30867
+ type:
30868
+ type: string
30869
+ enum:
30870
+ - team
30871
+ - user
30872
+ example: user
30873
+ page:
30874
+ $ref: '#/components/schemas/Page'
30875
+ UserAvailability:
30876
+ title: UserAvailability
30877
+ type: object
30878
+ properties:
30879
+ gross_time_available:
30880
+ description: Total available time based on working hours
30881
+ allOf:
30882
+ - $ref: '#/components/schemas/DurationInMinutesFull'
30883
+ net_time_available:
30884
+ description: Gross time available minus days off
30885
+ allOf:
30886
+ - $ref: '#/components/schemas/DurationInMinutesFull'
30887
+ planned_time:
30888
+ allOf:
30889
+ - $ref: '#/components/schemas/DurationInMinutesFull'
30890
+ unplanned_time:
30891
+ allOf:
30892
+ - $ref: '#/components/schemas/DurationInMinutesFull'
30893
+ userAvailability.totalresponse:
30894
+ title: userAvailability.totalresponse
30895
+ type: object
30896
+ properties:
30897
+ data:
30898
+ type: array
30899
+ items:
30900
+ type: object
30901
+ properties:
30902
+ user:
30903
+ allOf:
30904
+ - $ref: '#/components/schemas/TypeAndId'
30905
+ - properties:
30906
+ type:
30907
+ type: string
30908
+ example: user
30909
+ availability:
30910
+ allOf:
30911
+ - $ref: '#/components/schemas/UserAvailability'
30912
+ userAvailability.dailyrequest:
30913
+ title: userAvailability.dailyrequest
30914
+ type: object
30915
+ required:
30916
+ - period
30917
+ properties:
30918
+ period:
30919
+ allOf:
30920
+ - $ref: '#/components/schemas/Period'
30921
+ - description: A maximum duration of 100 days can be passed
30922
+ filter:
30923
+ type: object
30924
+ properties:
30925
+ assignees:
30926
+ type: array
30927
+ items:
30928
+ allOf:
30929
+ - $ref: '#/components/schemas/Assignee'
30930
+ - type: object
30931
+ required:
30932
+ - type
30933
+ - id
30934
+ properties:
30935
+ type:
30936
+ type: string
30937
+ enum:
30938
+ - team
30939
+ - user
30940
+ example: user
30941
+ page:
30942
+ $ref: '#/components/schemas/Page'
30943
+ userAvailability.dailyresponse:
30944
+ title: userAvailability.dailyresponse
30945
+ type: object
30946
+ properties:
30947
+ data:
30948
+ type: array
30949
+ items:
30950
+ type: object
30951
+ properties:
30952
+ user:
30953
+ allOf:
30954
+ - $ref: '#/components/schemas/TypeAndId'
30955
+ - properties:
30956
+ type:
30957
+ type: string
30958
+ example: user
30959
+ availabilities:
30960
+ type: array
30961
+ items:
30962
+ type: object
30963
+ properties:
30964
+ date:
30965
+ type: string
30966
+ example: '2023-10-02'
30967
+ availability:
30968
+ allOf:
30969
+ - $ref: '#/components/schemas/UserAvailability'
30970
+ x-tagGroups:
30971
+ - name: General
30972
+ tags:
30973
+ - departments
30974
+ - users
30975
+ - teams
30976
+ - custom_fields
30977
+ - work_types
30978
+ - document_templates
30979
+ - currencies
30980
+ - notes
30981
+ - email_tracking
30982
+ - closing_days
30983
+ - day_off_types
30984
+ - days_off
30985
+ - name: CRM
30986
+ tags:
30987
+ - contacts
30988
+ - companies
30989
+ - business_types
30990
+ - tags
30991
+ - addresses
30992
+ - name: Deals
30993
+ tags:
30994
+ - deals
30995
+ - deal_pipelines
30996
+ - deal_phases
30056
30997
  - deal_sources
30057
30998
  - quotations
30058
30999
  - orders
@@ -30098,6 +31039,11 @@ x-tagGroups:
30098
31039
  - groups
30099
31040
  - projects_v2_tasks
30100
31041
  - materials
31042
+ - name: Planning
31043
+ tags:
31044
+ - plannable_items
31045
+ - reservations
31046
+ - user_availability
30101
31047
  - name: Tasks
30102
31048
  tags:
30103
31049
  - tasks