@teamleader/focus-api-specification 1.97.0 → 1.99.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.
|
@@ -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.
|
|
6
|
+
version: 1.99.0
|
|
7
7
|
servers:
|
|
8
8
|
- url: https://api.focus.teamleader.eu
|
|
9
9
|
variables: {}
|
|
@@ -832,6 +832,51 @@ paths:
|
|
|
832
832
|
- type: user
|
|
833
833
|
id: bef8c53b-b6bc-0fde-944e-5c4b16e5155a
|
|
834
834
|
deprecated: false
|
|
835
|
+
/customFieldDefinitions.create:
|
|
836
|
+
post:
|
|
837
|
+
tags:
|
|
838
|
+
- custom_fields
|
|
839
|
+
summary: customFieldDefinitions.create
|
|
840
|
+
description: |
|
|
841
|
+
Create a custom field definition.
|
|
842
|
+
|
|
843
|
+
***Required scopes:*** `settings`
|
|
844
|
+
operationId: customFieldDefinitions.create
|
|
845
|
+
parameters: []
|
|
846
|
+
requestBody:
|
|
847
|
+
description: ''
|
|
848
|
+
content:
|
|
849
|
+
application/json:
|
|
850
|
+
schema:
|
|
851
|
+
allOf:
|
|
852
|
+
- $ref: '#/components/schemas/customFieldDefinitions.createrequest'
|
|
853
|
+
- example:
|
|
854
|
+
label: ''
|
|
855
|
+
type: single_line
|
|
856
|
+
context: contact
|
|
857
|
+
example:
|
|
858
|
+
label: ''
|
|
859
|
+
type: single_line
|
|
860
|
+
context: contact
|
|
861
|
+
required: true
|
|
862
|
+
responses:
|
|
863
|
+
'201':
|
|
864
|
+
description: ''
|
|
865
|
+
headers: {}
|
|
866
|
+
content:
|
|
867
|
+
application/json:
|
|
868
|
+
schema:
|
|
869
|
+
allOf:
|
|
870
|
+
- $ref: '#/components/schemas/customFieldDefinitions.createresponse'
|
|
871
|
+
- example:
|
|
872
|
+
data:
|
|
873
|
+
type: customFieldDefinition
|
|
874
|
+
id: 526960d3-8d49-4a71-9f62-7b8b74aef058
|
|
875
|
+
example:
|
|
876
|
+
data:
|
|
877
|
+
type: customFieldDefinition
|
|
878
|
+
id: 526960d3-8d49-4a71-9f62-7b8b74aef058
|
|
879
|
+
deprecated: false
|
|
835
880
|
/customFieldDefinitions.list:
|
|
836
881
|
post:
|
|
837
882
|
tags:
|
|
@@ -15484,7 +15529,13 @@ paths:
|
|
|
15484
15529
|
tags:
|
|
15485
15530
|
- files
|
|
15486
15531
|
summary: files.upload
|
|
15487
|
-
description:
|
|
15532
|
+
description: |
|
|
15533
|
+
Request the upload link for a file.
|
|
15534
|
+
|
|
15535
|
+
The following remarks apply to `temporary` files:
|
|
15536
|
+
- they exist for a maximum of 24 hours if not linked to an entity
|
|
15537
|
+
- do not show up in any file overview
|
|
15538
|
+
- are not included in external syncs
|
|
15488
15539
|
operationId: files.upload
|
|
15489
15540
|
parameters: []
|
|
15490
15541
|
requestBody:
|
|
@@ -17225,6 +17276,26 @@ components:
|
|
|
17225
17276
|
- $ref: '#/components/schemas/TypeAndId'
|
|
17226
17277
|
description: ''
|
|
17227
17278
|
description: ''
|
|
17279
|
+
CustomFieldDefinitionType:
|
|
17280
|
+
type: string
|
|
17281
|
+
enum:
|
|
17282
|
+
- single_line
|
|
17283
|
+
- multi_line
|
|
17284
|
+
- single_select
|
|
17285
|
+
- multi_select
|
|
17286
|
+
- date
|
|
17287
|
+
- money
|
|
17288
|
+
- auto_increment
|
|
17289
|
+
- integer
|
|
17290
|
+
- number
|
|
17291
|
+
- boolean
|
|
17292
|
+
- email
|
|
17293
|
+
- telephone
|
|
17294
|
+
- url
|
|
17295
|
+
- company
|
|
17296
|
+
- contact
|
|
17297
|
+
- product
|
|
17298
|
+
- user
|
|
17228
17299
|
Context:
|
|
17229
17300
|
title: Context
|
|
17230
17301
|
enum:
|
|
@@ -17238,6 +17309,59 @@ components:
|
|
|
17238
17309
|
- subscription
|
|
17239
17310
|
- ticket
|
|
17240
17311
|
type: string
|
|
17312
|
+
customFieldDefinitions.createrequest:
|
|
17313
|
+
title: customFieldDefinitions.createrequest
|
|
17314
|
+
required:
|
|
17315
|
+
- label
|
|
17316
|
+
- type
|
|
17317
|
+
- context
|
|
17318
|
+
type: object
|
|
17319
|
+
properties:
|
|
17320
|
+
label:
|
|
17321
|
+
type: string
|
|
17322
|
+
type:
|
|
17323
|
+
allOf:
|
|
17324
|
+
- $ref: '#/components/schemas/CustomFieldDefinitionType'
|
|
17325
|
+
- example: single_line
|
|
17326
|
+
context:
|
|
17327
|
+
allOf:
|
|
17328
|
+
- $ref: '#/components/schemas/Context'
|
|
17329
|
+
- example: contact
|
|
17330
|
+
configuration:
|
|
17331
|
+
type: object
|
|
17332
|
+
description: |
|
|
17333
|
+
- Use `options` when `type` is one of [`single_select`, `multi_select`]
|
|
17334
|
+
- Use `default_value` when `type` is `auto_increment`
|
|
17335
|
+
- Use `searchable` when `type` is one of [`single_line`, `company`, `integer`, `number`, `auto_increment`, `email`, `telephone`]
|
|
17336
|
+
oneOf:
|
|
17337
|
+
- type: object
|
|
17338
|
+
title: options
|
|
17339
|
+
properties:
|
|
17340
|
+
options:
|
|
17341
|
+
type: array
|
|
17342
|
+
items:
|
|
17343
|
+
type: string
|
|
17344
|
+
- type: object
|
|
17345
|
+
title: default_value
|
|
17346
|
+
properties:
|
|
17347
|
+
default_value:
|
|
17348
|
+
type: number
|
|
17349
|
+
- type: object
|
|
17350
|
+
title: searchable
|
|
17351
|
+
properties:
|
|
17352
|
+
searchable:
|
|
17353
|
+
type: boolean
|
|
17354
|
+
customFieldDefinitions.createresponse:
|
|
17355
|
+
title: customFieldDefinitions.createresponse
|
|
17356
|
+
type: object
|
|
17357
|
+
properties:
|
|
17358
|
+
data:
|
|
17359
|
+
allOf:
|
|
17360
|
+
- $ref: '#/components/schemas/TypeAndId'
|
|
17361
|
+
- properties:
|
|
17362
|
+
type:
|
|
17363
|
+
type: string
|
|
17364
|
+
example: customFieldDefinition
|
|
17241
17365
|
customFieldDefinitions.listrequest:
|
|
17242
17366
|
title: customFieldDefinitions.listrequest
|
|
17243
17367
|
type: object
|
|
@@ -17285,25 +17409,7 @@ components:
|
|
|
17285
17409
|
- $ref: '#/components/schemas/Context'
|
|
17286
17410
|
- example: contact
|
|
17287
17411
|
type:
|
|
17288
|
-
|
|
17289
|
-
enum:
|
|
17290
|
-
- single_line
|
|
17291
|
-
- multi_line
|
|
17292
|
-
- single_select
|
|
17293
|
-
- multi_select
|
|
17294
|
-
- date
|
|
17295
|
-
- money
|
|
17296
|
-
- auto_increment
|
|
17297
|
-
- integer
|
|
17298
|
-
- number
|
|
17299
|
-
- boolean
|
|
17300
|
-
- email
|
|
17301
|
-
- telephone
|
|
17302
|
-
- url
|
|
17303
|
-
- company
|
|
17304
|
-
- contact
|
|
17305
|
-
- product
|
|
17306
|
-
- user
|
|
17412
|
+
$ref: '#/components/schemas/CustomFieldDefinitionType'
|
|
17307
17413
|
label:
|
|
17308
17414
|
type: string
|
|
17309
17415
|
group:
|
|
@@ -17354,25 +17460,7 @@ components:
|
|
|
17354
17460
|
- $ref: '#/components/schemas/Context'
|
|
17355
17461
|
- example: contact
|
|
17356
17462
|
type:
|
|
17357
|
-
|
|
17358
|
-
enum:
|
|
17359
|
-
- single_line
|
|
17360
|
-
- multi_line
|
|
17361
|
-
- single_select
|
|
17362
|
-
- multi_select
|
|
17363
|
-
- date
|
|
17364
|
-
- money
|
|
17365
|
-
- auto_increment
|
|
17366
|
-
- integer
|
|
17367
|
-
- number
|
|
17368
|
-
- boolean
|
|
17369
|
-
- email
|
|
17370
|
-
- telephone
|
|
17371
|
-
- url
|
|
17372
|
-
- company
|
|
17373
|
-
- contact
|
|
17374
|
-
- product
|
|
17375
|
-
- user
|
|
17463
|
+
$ref: '#/components/schemas/CustomFieldDefinitionType'
|
|
17376
17464
|
label:
|
|
17377
17465
|
type: string
|
|
17378
17466
|
group:
|
|
@@ -30088,6 +30176,8 @@ components:
|
|
|
30088
30176
|
- type
|
|
30089
30177
|
- id
|
|
30090
30178
|
- properties:
|
|
30179
|
+
id:
|
|
30180
|
+
description: Not required if `type` is `temporary`
|
|
30091
30181
|
type:
|
|
30092
30182
|
type: string
|
|
30093
30183
|
enum:
|
|
@@ -30098,6 +30188,7 @@ components:
|
|
|
30098
30188
|
- creditNote
|
|
30099
30189
|
- nextgenProject
|
|
30100
30190
|
- ticket
|
|
30191
|
+
- temporary
|
|
30101
30192
|
example: company
|
|
30102
30193
|
folder:
|
|
30103
30194
|
type: string
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@teamleader/focus-api-specification",
|
|
3
3
|
"description": "Teamleader Focus API Specification",
|
|
4
|
-
"version": "1.
|
|
4
|
+
"version": "1.99.0",
|
|
5
5
|
"author": "Teamleader <development@teamleader.eu> (https://www.teamleader.eu)",
|
|
6
6
|
"bugs": {
|
|
7
7
|
"url": "https://github.com/teamleadercrm/focus-api-specification/issues"
|