@teamleader/focus-api-specification 1.15.0 → 1.16.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.16.0
|
|
7
7
|
servers:
|
|
8
8
|
- url: https://api.focus.teamleader.eu
|
|
9
9
|
variables: {}
|
|
@@ -233,6 +233,12 @@ tags:
|
|
|
233
233
|
|
|
234
234
|
***Required scopes:*** `projects`
|
|
235
235
|
x-displayName: Projects
|
|
236
|
+
- name: external_parties
|
|
237
|
+
description: |
|
|
238
|
+
> An external party is a contact or company that is added to a project with an optional function and/or sub function.
|
|
239
|
+
|
|
240
|
+
***Required scopes:*** `projects`
|
|
241
|
+
x-displayName: External parties
|
|
236
242
|
- name: project_lines
|
|
237
243
|
description: |
|
|
238
244
|
> A project line can be a group, a task, or a material.
|
|
@@ -9197,6 +9203,13 @@ paths:
|
|
|
9197
9203
|
legacy_project:
|
|
9198
9204
|
type: project
|
|
9199
9205
|
id: 624ca743-8998-4f8c-add1-c427bb022166
|
|
9206
|
+
external_parties:
|
|
9207
|
+
id: f7fcf4eb-583c-4e6b-88be-2a9e83afdb81
|
|
9208
|
+
customer:
|
|
9209
|
+
type: contact
|
|
9210
|
+
id: 66abace2-62af-0836-a927-fe3f44b9b47b
|
|
9211
|
+
function: Sales representative
|
|
9212
|
+
sub_function: Teamleader Focus FR
|
|
9200
9213
|
example:
|
|
9201
9214
|
data:
|
|
9202
9215
|
id: 49b403be-a32e-0901-9b1c-25214f9027c6
|
|
@@ -9291,6 +9304,13 @@ paths:
|
|
|
9291
9304
|
legacy_project:
|
|
9292
9305
|
type: project
|
|
9293
9306
|
id: 624ca743-8998-4f8c-add1-c427bb022166
|
|
9307
|
+
external_parties:
|
|
9308
|
+
- id: f7fcf4eb-583c-4e6b-88be-2a9e83afdb81
|
|
9309
|
+
customer:
|
|
9310
|
+
type: contact
|
|
9311
|
+
id: 66abace2-62af-0836-a927-fe3f44b9b47b
|
|
9312
|
+
function: Sales representative
|
|
9313
|
+
sub_function: Teamleader Focus FR
|
|
9294
9314
|
deprecated: false
|
|
9295
9315
|
/projects-v2/projects.create:
|
|
9296
9316
|
post:
|
|
@@ -9926,6 +9946,104 @@ paths:
|
|
|
9926
9946
|
headers: {}
|
|
9927
9947
|
content: {}
|
|
9928
9948
|
deprecated: false
|
|
9949
|
+
/projects-v2/externalParties.addToProject:
|
|
9950
|
+
post:
|
|
9951
|
+
tags:
|
|
9952
|
+
- external_parties
|
|
9953
|
+
summary: externalParties.addToProject
|
|
9954
|
+
description: Add an external party to a project.
|
|
9955
|
+
operationId: NextgenProjectsExternalParties.addToProject
|
|
9956
|
+
parameters: []
|
|
9957
|
+
requestBody:
|
|
9958
|
+
description: ''
|
|
9959
|
+
content:
|
|
9960
|
+
application/json:
|
|
9961
|
+
schema:
|
|
9962
|
+
allOf:
|
|
9963
|
+
- $ref: '#/components/schemas/projects-v2_externalParties.addToProjectrequest'
|
|
9964
|
+
- example:
|
|
9965
|
+
project_id: 48ef99b9-4a20-4071-888d-0927f45c03d5
|
|
9966
|
+
customer:
|
|
9967
|
+
type: contact
|
|
9968
|
+
id: adfec6b9-a8d7-403d-bde3-093ad50d74c2
|
|
9969
|
+
function: Sales representative
|
|
9970
|
+
sub_function: Teamleader Focus Sales FR
|
|
9971
|
+
example:
|
|
9972
|
+
project_id: 48ef99b9-4a20-4071-888d-0927f45c03d5
|
|
9973
|
+
customer:
|
|
9974
|
+
type: contact
|
|
9975
|
+
id: adfec6b9-a8d7-403d-bde3-093ad50d74c2
|
|
9976
|
+
function: Sales representative
|
|
9977
|
+
sub_function: Teamleader Focus Sales FR
|
|
9978
|
+
required: true
|
|
9979
|
+
responses:
|
|
9980
|
+
'204':
|
|
9981
|
+
description: ''
|
|
9982
|
+
headers: {}
|
|
9983
|
+
content: {}
|
|
9984
|
+
deprecated: false
|
|
9985
|
+
/projects-v2/externalParties.update:
|
|
9986
|
+
post:
|
|
9987
|
+
tags:
|
|
9988
|
+
- external_parties
|
|
9989
|
+
summary: externalParties.update
|
|
9990
|
+
description: Update an external party.
|
|
9991
|
+
operationId: NextgenProjectsExternalParties.update
|
|
9992
|
+
parameters: []
|
|
9993
|
+
requestBody:
|
|
9994
|
+
description: ''
|
|
9995
|
+
content:
|
|
9996
|
+
application/json:
|
|
9997
|
+
schema:
|
|
9998
|
+
allOf:
|
|
9999
|
+
- $ref: '#/components/schemas/projects-v2_externalParties.updaterequest'
|
|
10000
|
+
- example:
|
|
10001
|
+
id: 48ef99b9-4a20-4071-888d-0927f45c03d5
|
|
10002
|
+
customer:
|
|
10003
|
+
type: contact
|
|
10004
|
+
id: adfec6b9-a8d7-403d-bde3-093ad50d74c2
|
|
10005
|
+
function: Sales representative
|
|
10006
|
+
sub_function: null
|
|
10007
|
+
example:
|
|
10008
|
+
id: 48ef99b9-4a20-4071-888d-0927f45c03d5
|
|
10009
|
+
customer:
|
|
10010
|
+
type: contact
|
|
10011
|
+
id: adfec6b9-a8d7-403d-bde3-093ad50d74c2
|
|
10012
|
+
function: Sales representative
|
|
10013
|
+
sub_function: null
|
|
10014
|
+
required: true
|
|
10015
|
+
responses:
|
|
10016
|
+
'204':
|
|
10017
|
+
description: ''
|
|
10018
|
+
headers: {}
|
|
10019
|
+
content: {}
|
|
10020
|
+
deprecated: false
|
|
10021
|
+
/projects-v2/externalParties.delete:
|
|
10022
|
+
post:
|
|
10023
|
+
tags:
|
|
10024
|
+
- external_parties
|
|
10025
|
+
summary: externalParties.delete
|
|
10026
|
+
description: Delete an external party.
|
|
10027
|
+
operationId: NextgenProjectsExternalParties.delete
|
|
10028
|
+
parameters: []
|
|
10029
|
+
requestBody:
|
|
10030
|
+
description: ''
|
|
10031
|
+
content:
|
|
10032
|
+
application/json:
|
|
10033
|
+
schema:
|
|
10034
|
+
allOf:
|
|
10035
|
+
- $ref: '#/components/schemas/projects-v2_externalParties.deleterequest'
|
|
10036
|
+
- example:
|
|
10037
|
+
id: 48ef99b9-4a20-4071-888d-0927f45c03d5
|
|
10038
|
+
example:
|
|
10039
|
+
id: 48ef99b9-4a20-4071-888d-0927f45c03d5
|
|
10040
|
+
required: true
|
|
10041
|
+
responses:
|
|
10042
|
+
'204':
|
|
10043
|
+
description: ''
|
|
10044
|
+
headers: {}
|
|
10045
|
+
content: {}
|
|
10046
|
+
deprecated: false
|
|
9929
10047
|
/projects-v2/projectLines.list:
|
|
9930
10048
|
post:
|
|
9931
10049
|
tags:
|
|
@@ -23506,6 +23624,22 @@ components:
|
|
|
23506
23624
|
type:
|
|
23507
23625
|
type: string
|
|
23508
23626
|
example: project
|
|
23627
|
+
external_parties:
|
|
23628
|
+
type: array
|
|
23629
|
+
items:
|
|
23630
|
+
type: object
|
|
23631
|
+
properties:
|
|
23632
|
+
id:
|
|
23633
|
+
type: string
|
|
23634
|
+
example: e80e3e0f-4008-47cc-aa94-3d71a42052bf
|
|
23635
|
+
customer:
|
|
23636
|
+
$ref: '#/components/schemas/Customer'
|
|
23637
|
+
function:
|
|
23638
|
+
type: string
|
|
23639
|
+
example: Sales representative
|
|
23640
|
+
sub_function:
|
|
23641
|
+
type: string
|
|
23642
|
+
example: Teamleader Focus FR
|
|
23509
23643
|
projects-v2.createrequest:
|
|
23510
23644
|
title: projects-v2.createrequest
|
|
23511
23645
|
required:
|
|
@@ -23954,6 +24088,52 @@ components:
|
|
|
23954
24088
|
quotation_id:
|
|
23955
24089
|
type: string
|
|
23956
24090
|
example: 8385b072-587f-4ebf-a32b-5f48baea1b1c
|
|
24091
|
+
projects-v2_externalParties.addToProjectrequest:
|
|
24092
|
+
title: projects-v2_externalParties.addToProjectrequest
|
|
24093
|
+
required:
|
|
24094
|
+
- project_id
|
|
24095
|
+
- customer
|
|
24096
|
+
type: object
|
|
24097
|
+
properties:
|
|
24098
|
+
project_id:
|
|
24099
|
+
type: string
|
|
24100
|
+
example: 7257b535-d40f-4699-b3bd-63679379b579
|
|
24101
|
+
customer:
|
|
24102
|
+
$ref: '#/components/schemas/Customer'
|
|
24103
|
+
function:
|
|
24104
|
+
type: string
|
|
24105
|
+
example: Project Manager
|
|
24106
|
+
sub_function:
|
|
24107
|
+
type: string
|
|
24108
|
+
example: Project Coordinator
|
|
24109
|
+
projects-v2_externalParties.updaterequest:
|
|
24110
|
+
title: projects-v2_externalParties.updaterequest
|
|
24111
|
+
required:
|
|
24112
|
+
- id
|
|
24113
|
+
type: object
|
|
24114
|
+
properties:
|
|
24115
|
+
id:
|
|
24116
|
+
type: string
|
|
24117
|
+
example: 6126596f-6193-445a-935a-60c10df9f632
|
|
24118
|
+
customer:
|
|
24119
|
+
$ref: '#/components/schemas/Customer'
|
|
24120
|
+
function:
|
|
24121
|
+
type: string
|
|
24122
|
+
example: Project Manager
|
|
24123
|
+
nullable: true
|
|
24124
|
+
sub_function:
|
|
24125
|
+
type: string
|
|
24126
|
+
example: Project Coordinator
|
|
24127
|
+
nullable: true
|
|
24128
|
+
projects-v2_externalParties.deleterequest:
|
|
24129
|
+
title: projects-v2_externalParties.deleterequest
|
|
24130
|
+
required:
|
|
24131
|
+
- id
|
|
24132
|
+
type: object
|
|
24133
|
+
properties:
|
|
24134
|
+
id:
|
|
24135
|
+
type: string
|
|
24136
|
+
example: 6126596f-6193-445a-935a-60c10df9f632
|
|
23957
24137
|
projects-v2_projectLines.listrequest:
|
|
23958
24138
|
title: projects-v2_projectLines.listrequest
|
|
23959
24139
|
required:
|
|
@@ -28115,6 +28295,7 @@ x-tagGroups:
|
|
|
28115
28295
|
- name: New Projects
|
|
28116
28296
|
tags:
|
|
28117
28297
|
- projects
|
|
28298
|
+
- external_parties
|
|
28118
28299
|
- project_lines
|
|
28119
28300
|
- groups
|
|
28120
28301
|
- projects_v2_tasks
|
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.16.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"
|