pipedrive 33.7.1 → 33.8.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.
- package/dist/esm/versions/v1/api/legacy-teams-api.d.ts +32 -32
- package/dist/esm/versions/v1/api/legacy-teams-api.js +32 -32
- package/dist/esm/versions/v2/api/persons-api.d.ts +8 -8
- package/dist/esm/versions/v2/api/persons-api.js +8 -8
- package/dist/esm/versions/v2/models/add-activity-request.d.ts +1 -6
- package/dist/esm/versions/v2/models/add-person-request.d.ts +5 -5
- package/dist/esm/versions/v2/models/update-person-request.d.ts +4 -4
- package/dist/versions/v1/api/legacy-teams-api.d.ts +32 -32
- package/dist/versions/v1/api/legacy-teams-api.js +32 -32
- package/dist/versions/v2/api/persons-api.d.ts +8 -8
- package/dist/versions/v2/api/persons-api.js +8 -8
- package/dist/versions/v2/models/add-activity-request.d.ts +1 -6
- package/dist/versions/v2/models/add-person-request.d.ts +5 -5
- package/dist/versions/v2/models/update-person-request.d.ts +4 -4
- package/package.json +1 -1
|
@@ -33,7 +33,7 @@ import { BASE_PATH, BaseAPI } from '../base';
|
|
|
33
33
|
export const PersonsApiAxiosParamCreator = function (configuration) {
|
|
34
34
|
return {
|
|
35
35
|
/**
|
|
36
|
-
* Adds a new person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don
|
|
36
|
+
* Adds a new person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don\'t exist by default in Pipedrive and are only created when you set up your contact sync — attempting to set any of them without contact sync enabled returns a 403.
|
|
37
37
|
* @summary Add a new person
|
|
38
38
|
* @param {AddPersonRequest} [AddPersonRequest]
|
|
39
39
|
|
|
@@ -493,7 +493,7 @@ export const PersonsApiAxiosParamCreator = function (configuration) {
|
|
|
493
493
|
};
|
|
494
494
|
}),
|
|
495
495
|
/**
|
|
496
|
-
* Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don
|
|
496
|
+
* Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don\'t exist by default in Pipedrive and are only created when you set up your contact sync — attempting to set any of them without contact sync enabled returns a 403.
|
|
497
497
|
* @summary Update a person
|
|
498
498
|
* @param {number} id The ID of the person
|
|
499
499
|
* @param {UpdatePersonRequest} [UpdatePersonRequest]
|
|
@@ -539,7 +539,7 @@ export const PersonsApiFp = function (configuration) {
|
|
|
539
539
|
const localVarAxiosParamCreator = PersonsApiAxiosParamCreator(configuration);
|
|
540
540
|
return {
|
|
541
541
|
/**
|
|
542
|
-
* Adds a new person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don
|
|
542
|
+
* Adds a new person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don\'t exist by default in Pipedrive and are only created when you set up your contact sync — attempting to set any of them without contact sync enabled returns a 403.
|
|
543
543
|
* @summary Add a new person
|
|
544
544
|
* @param {AddPersonRequest} [AddPersonRequest]
|
|
545
545
|
|
|
@@ -699,7 +699,7 @@ export const PersonsApiFp = function (configuration) {
|
|
|
699
699
|
});
|
|
700
700
|
},
|
|
701
701
|
/**
|
|
702
|
-
* Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don
|
|
702
|
+
* Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don\'t exist by default in Pipedrive and are only created when you set up your contact sync — attempting to set any of them without contact sync enabled returns a 403.
|
|
703
703
|
* @summary Update a person
|
|
704
704
|
* @param {number} id The ID of the person
|
|
705
705
|
* @param {UpdatePersonRequest} [UpdatePersonRequest]
|
|
@@ -722,7 +722,7 @@ export const PersonsApiFactory = function (configuration, basePath, axios) {
|
|
|
722
722
|
const localVarFp = PersonsApiFp(configuration);
|
|
723
723
|
return {
|
|
724
724
|
/**
|
|
725
|
-
* Adds a new person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don
|
|
725
|
+
* Adds a new person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don\'t exist by default in Pipedrive and are only created when you set up your contact sync — attempting to set any of them without contact sync enabled returns a 403.
|
|
726
726
|
* @summary Add a new person
|
|
727
727
|
* @param {PersonsApiAddPersonRequest} requestParameters Request parameters.
|
|
728
728
|
|
|
@@ -822,7 +822,7 @@ export const PersonsApiFactory = function (configuration, basePath, axios) {
|
|
|
822
822
|
return localVarFp.searchPersons(requestParameters.term, requestParameters.fields, requestParameters.exact_match, requestParameters.organization_id, requestParameters.include_fields, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
|
|
823
823
|
},
|
|
824
824
|
/**
|
|
825
|
-
* Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don
|
|
825
|
+
* Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don\'t exist by default in Pipedrive and are only created when you set up your contact sync — attempting to set any of them without contact sync enabled returns a 403.
|
|
826
826
|
* @summary Update a person
|
|
827
827
|
* @param {PersonsApiUpdatePersonRequest} requestParameters Request parameters.
|
|
828
828
|
|
|
@@ -841,7 +841,7 @@ export const PersonsApiFactory = function (configuration, basePath, axios) {
|
|
|
841
841
|
*/
|
|
842
842
|
export class PersonsApi extends BaseAPI {
|
|
843
843
|
/**
|
|
844
|
-
* Adds a new person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don
|
|
844
|
+
* Adds a new person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don\'t exist by default in Pipedrive and are only created when you set up your contact sync — attempting to set any of them without contact sync enabled returns a 403.
|
|
845
845
|
* @summary Add a new person
|
|
846
846
|
* @param {PersonsApiAddPersonRequest} requestParameters Request parameters.
|
|
847
847
|
|
|
@@ -951,7 +951,7 @@ export class PersonsApi extends BaseAPI {
|
|
|
951
951
|
return PersonsApiFp(this.configuration).searchPersons(requestParameters.term, requestParameters.fields, requestParameters.exact_match, requestParameters.organization_id, requestParameters.include_fields, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
|
|
952
952
|
}
|
|
953
953
|
/**
|
|
954
|
-
* Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don
|
|
954
|
+
* Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don\'t exist by default in Pipedrive and are only created when you set up your contact sync — attempting to set any of them without contact sync enabled returns a 403.
|
|
955
955
|
* @summary Update a person
|
|
956
956
|
* @param {PersonsApiUpdatePersonRequest} requestParameters Request parameters.
|
|
957
957
|
|
|
@@ -44,11 +44,6 @@ export interface AddActivityRequest {
|
|
|
44
44
|
*/
|
|
45
45
|
'lead_id'?: string;
|
|
46
46
|
/**
|
|
47
|
-
* The ID of the person linked to the activity
|
|
48
|
-
* @type {number}
|
|
49
|
-
*/
|
|
50
|
-
'person_id'?: number;
|
|
51
|
-
/**
|
|
52
47
|
* The ID of the organization linked to the activity
|
|
53
48
|
* @type {number}
|
|
54
49
|
*/
|
|
@@ -89,7 +84,7 @@ export interface AddActivityRequest {
|
|
|
89
84
|
*/
|
|
90
85
|
'location'?: AddActivityRequestLocation;
|
|
91
86
|
/**
|
|
92
|
-
* The participants of the activity
|
|
87
|
+
* The participants of the activity. Use this to set the activity\'s person — a primary participant (`primary: true`) sets `person_id` on the activity.
|
|
93
88
|
* @type {Array<AddActivityRequestParticipantsInner>}
|
|
94
89
|
*/
|
|
95
90
|
'participants'?: Array<AddActivityRequestParticipantsInner>;
|
|
@@ -23,7 +23,7 @@ export interface AddPersonRequest {
|
|
|
23
23
|
* The name of the person
|
|
24
24
|
* @type {string}
|
|
25
25
|
*/
|
|
26
|
-
'name'
|
|
26
|
+
'name': string;
|
|
27
27
|
/**
|
|
28
28
|
* The ID of the user who owns the person
|
|
29
29
|
* @type {number}
|
|
@@ -65,22 +65,22 @@ export interface AddPersonRequest {
|
|
|
65
65
|
*/
|
|
66
66
|
'postal_address'?: PersonItemAddress;
|
|
67
67
|
/**
|
|
68
|
-
* Contact sync notes of the person, maximum 10 000 characters
|
|
68
|
+
* Contact sync notes of the person, maximum 10 000 characters. Only accepted when contact sync is enabled for the company; otherwise the request returns 403.
|
|
69
69
|
* @type {string}
|
|
70
70
|
*/
|
|
71
71
|
'notes'?: string;
|
|
72
72
|
/**
|
|
73
|
-
* The instant messaging accounts of the person
|
|
73
|
+
* The instant messaging accounts of the person. Only accepted when contact sync is enabled for the company; otherwise the request returns 403.
|
|
74
74
|
* @type {Array<PersonItemIm>}
|
|
75
75
|
*/
|
|
76
76
|
'im'?: Array<PersonItemIm>;
|
|
77
77
|
/**
|
|
78
|
-
* The birthday of the person
|
|
78
|
+
* The birthday of the person. Only accepted when contact sync is enabled for the company; otherwise the request returns 403.
|
|
79
79
|
* @type {string}
|
|
80
80
|
*/
|
|
81
81
|
'birthday'?: string;
|
|
82
82
|
/**
|
|
83
|
-
* The job title of the person
|
|
83
|
+
* The job title of the person. Only accepted when contact sync is enabled for the company; otherwise the request returns 403.
|
|
84
84
|
* @type {string}
|
|
85
85
|
*/
|
|
86
86
|
'job_title'?: string;
|
|
@@ -60,22 +60,22 @@ export interface UpdatePersonRequest {
|
|
|
60
60
|
*/
|
|
61
61
|
'postal_address'?: PersonItemAddress;
|
|
62
62
|
/**
|
|
63
|
-
* Contact sync notes of the person, maximum 10 000 characters
|
|
63
|
+
* Contact sync notes of the person, maximum 10 000 characters. Only accepted when contact sync is enabled for the company; otherwise the request returns 403.
|
|
64
64
|
* @type {string}
|
|
65
65
|
*/
|
|
66
66
|
'notes'?: string;
|
|
67
67
|
/**
|
|
68
|
-
* The instant messaging accounts of the person
|
|
68
|
+
* The instant messaging accounts of the person. Only accepted when contact sync is enabled for the company; otherwise the request returns 403.
|
|
69
69
|
* @type {Array<PersonItemIm>}
|
|
70
70
|
*/
|
|
71
71
|
'im'?: Array<PersonItemIm>;
|
|
72
72
|
/**
|
|
73
|
-
* The birthday of the person
|
|
73
|
+
* The birthday of the person. Only accepted when contact sync is enabled for the company; otherwise the request returns 403.
|
|
74
74
|
* @type {string}
|
|
75
75
|
*/
|
|
76
76
|
'birthday'?: string;
|
|
77
77
|
/**
|
|
78
|
-
* The job title of the person
|
|
78
|
+
* The job title of the person. Only accepted when contact sync is enabled for the company; otherwise the request returns 403.
|
|
79
79
|
* @type {string}
|
|
80
80
|
*/
|
|
81
81
|
'job_title'?: string;
|
|
@@ -28,7 +28,7 @@ export declare const LegacyTeamsApiAxiosParamCreator: (configuration?: Configura
|
|
|
28
28
|
* Adds a new team to the company and returns the created object.
|
|
29
29
|
* @summary Add a new team
|
|
30
30
|
* @param {AddTeamRequest1} [AddTeamRequest1]
|
|
31
|
-
|
|
31
|
+
|
|
32
32
|
* @throws {RequiredError}
|
|
33
33
|
*/
|
|
34
34
|
addTeam: (AddTeamRequest1?: AddTeamRequest1) => Promise<RequestArgs>;
|
|
@@ -37,7 +37,7 @@ export declare const LegacyTeamsApiAxiosParamCreator: (configuration?: Configura
|
|
|
37
37
|
* @summary Add users to a team
|
|
38
38
|
* @param {number} id The ID of the team
|
|
39
39
|
* @param {AddTeamUserRequest} [AddTeamUserRequest]
|
|
40
|
-
|
|
40
|
+
|
|
41
41
|
* @throws {RequiredError}
|
|
42
42
|
*/
|
|
43
43
|
addTeamUser: (id: number, AddTeamUserRequest?: AddTeamUserRequest) => Promise<RequestArgs>;
|
|
@@ -46,7 +46,7 @@ export declare const LegacyTeamsApiAxiosParamCreator: (configuration?: Configura
|
|
|
46
46
|
* @summary Delete users from a team
|
|
47
47
|
* @param {number} id The ID of the team
|
|
48
48
|
* @param {DeleteTeamUserRequest} [DeleteTeamUserRequest]
|
|
49
|
-
|
|
49
|
+
|
|
50
50
|
* @throws {RequiredError}
|
|
51
51
|
*/
|
|
52
52
|
deleteTeamUser: (id: number, DeleteTeamUserRequest?: DeleteTeamUserRequest) => Promise<RequestArgs>;
|
|
@@ -55,7 +55,7 @@ export declare const LegacyTeamsApiAxiosParamCreator: (configuration?: Configura
|
|
|
55
55
|
* @summary Get a single team
|
|
56
56
|
* @param {number} id The ID of the team
|
|
57
57
|
* @param {0 | 1} [skip_users] When enabled, the teams will not include IDs of member users
|
|
58
|
-
|
|
58
|
+
|
|
59
59
|
* @throws {RequiredError}
|
|
60
60
|
*/
|
|
61
61
|
getTeam: (id: number, skip_users?: 0 | 1) => Promise<RequestArgs>;
|
|
@@ -63,7 +63,7 @@ export declare const LegacyTeamsApiAxiosParamCreator: (configuration?: Configura
|
|
|
63
63
|
* Returns a list of all user IDs within a team.
|
|
64
64
|
* @summary Get all users in a team
|
|
65
65
|
* @param {number} id The ID of the team
|
|
66
|
-
|
|
66
|
+
|
|
67
67
|
* @throws {RequiredError}
|
|
68
68
|
*/
|
|
69
69
|
getTeamUsers: (id: number) => Promise<RequestArgs>;
|
|
@@ -72,7 +72,7 @@ export declare const LegacyTeamsApiAxiosParamCreator: (configuration?: Configura
|
|
|
72
72
|
* @summary Get all teams
|
|
73
73
|
* @param {'id' | 'name' | 'manager_id' | 'active_flag'} [order_by] The field name to sort returned teams by
|
|
74
74
|
* @param {0 | 1} [skip_users] When enabled, the teams will not include IDs of member users
|
|
75
|
-
|
|
75
|
+
|
|
76
76
|
* @throws {RequiredError}
|
|
77
77
|
*/
|
|
78
78
|
getTeams: (order_by?: 'id' | 'name' | 'manager_id' | 'active_flag', skip_users?: 0 | 1) => Promise<RequestArgs>;
|
|
@@ -82,7 +82,7 @@ export declare const LegacyTeamsApiAxiosParamCreator: (configuration?: Configura
|
|
|
82
82
|
* @param {number} id The ID of the user
|
|
83
83
|
* @param {'id' | 'name' | 'manager_id' | 'active_flag'} [order_by] The field name to sort returned teams by
|
|
84
84
|
* @param {0 | 1} [skip_users] When enabled, the teams will not include IDs of member users
|
|
85
|
-
|
|
85
|
+
|
|
86
86
|
* @throws {RequiredError}
|
|
87
87
|
*/
|
|
88
88
|
getUserTeams: (id: number, order_by?: 'id' | 'name' | 'manager_id' | 'active_flag', skip_users?: 0 | 1) => Promise<RequestArgs>;
|
|
@@ -91,7 +91,7 @@ export declare const LegacyTeamsApiAxiosParamCreator: (configuration?: Configura
|
|
|
91
91
|
* @summary Update a team
|
|
92
92
|
* @param {number} id The ID of the team
|
|
93
93
|
* @param {UpdateTeamRequest} [UpdateTeamRequest]
|
|
94
|
-
|
|
94
|
+
|
|
95
95
|
* @throws {RequiredError}
|
|
96
96
|
*/
|
|
97
97
|
updateTeam: (id: number, UpdateTeamRequest?: UpdateTeamRequest) => Promise<RequestArgs>;
|
|
@@ -105,7 +105,7 @@ export declare const LegacyTeamsApiFp: (configuration?: Configuration) => {
|
|
|
105
105
|
* Adds a new team to the company and returns the created object.
|
|
106
106
|
* @summary Add a new team
|
|
107
107
|
* @param {AddTeamRequest1} [AddTeamRequest1]
|
|
108
|
-
|
|
108
|
+
|
|
109
109
|
* @throws {RequiredError}
|
|
110
110
|
*/
|
|
111
111
|
addTeam(AddTeamRequest1?: AddTeamRequest1): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetTeamResponse>>;
|
|
@@ -114,7 +114,7 @@ export declare const LegacyTeamsApiFp: (configuration?: Configuration) => {
|
|
|
114
114
|
* @summary Add users to a team
|
|
115
115
|
* @param {number} id The ID of the team
|
|
116
116
|
* @param {AddTeamUserRequest} [AddTeamUserRequest]
|
|
117
|
-
|
|
117
|
+
|
|
118
118
|
* @throws {RequiredError}
|
|
119
119
|
*/
|
|
120
120
|
addTeamUser(id: number, AddTeamUserRequest?: AddTeamUserRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UserIds>>;
|
|
@@ -123,7 +123,7 @@ export declare const LegacyTeamsApiFp: (configuration?: Configuration) => {
|
|
|
123
123
|
* @summary Delete users from a team
|
|
124
124
|
* @param {number} id The ID of the team
|
|
125
125
|
* @param {DeleteTeamUserRequest} [DeleteTeamUserRequest]
|
|
126
|
-
|
|
126
|
+
|
|
127
127
|
* @throws {RequiredError}
|
|
128
128
|
*/
|
|
129
129
|
deleteTeamUser(id: number, DeleteTeamUserRequest?: DeleteTeamUserRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UserIds>>;
|
|
@@ -132,7 +132,7 @@ export declare const LegacyTeamsApiFp: (configuration?: Configuration) => {
|
|
|
132
132
|
* @summary Get a single team
|
|
133
133
|
* @param {number} id The ID of the team
|
|
134
134
|
* @param {0 | 1} [skip_users] When enabled, the teams will not include IDs of member users
|
|
135
|
-
|
|
135
|
+
|
|
136
136
|
* @throws {RequiredError}
|
|
137
137
|
*/
|
|
138
138
|
getTeam(id: number, skip_users?: 0 | 1): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetTeamResponse>>;
|
|
@@ -140,7 +140,7 @@ export declare const LegacyTeamsApiFp: (configuration?: Configuration) => {
|
|
|
140
140
|
* Returns a list of all user IDs within a team.
|
|
141
141
|
* @summary Get all users in a team
|
|
142
142
|
* @param {number} id The ID of the team
|
|
143
|
-
|
|
143
|
+
|
|
144
144
|
* @throws {RequiredError}
|
|
145
145
|
*/
|
|
146
146
|
getTeamUsers(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UserIds>>;
|
|
@@ -149,7 +149,7 @@ export declare const LegacyTeamsApiFp: (configuration?: Configuration) => {
|
|
|
149
149
|
* @summary Get all teams
|
|
150
150
|
* @param {'id' | 'name' | 'manager_id' | 'active_flag'} [order_by] The field name to sort returned teams by
|
|
151
151
|
* @param {0 | 1} [skip_users] When enabled, the teams will not include IDs of member users
|
|
152
|
-
|
|
152
|
+
|
|
153
153
|
* @throws {RequiredError}
|
|
154
154
|
*/
|
|
155
155
|
getTeams(order_by?: 'id' | 'name' | 'manager_id' | 'active_flag', skip_users?: 0 | 1): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetTeamsResponse>>;
|
|
@@ -159,7 +159,7 @@ export declare const LegacyTeamsApiFp: (configuration?: Configuration) => {
|
|
|
159
159
|
* @param {number} id The ID of the user
|
|
160
160
|
* @param {'id' | 'name' | 'manager_id' | 'active_flag'} [order_by] The field name to sort returned teams by
|
|
161
161
|
* @param {0 | 1} [skip_users] When enabled, the teams will not include IDs of member users
|
|
162
|
-
|
|
162
|
+
|
|
163
163
|
* @throws {RequiredError}
|
|
164
164
|
*/
|
|
165
165
|
getUserTeams(id: number, order_by?: 'id' | 'name' | 'manager_id' | 'active_flag', skip_users?: 0 | 1): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetTeamsResponse>>;
|
|
@@ -168,7 +168,7 @@ export declare const LegacyTeamsApiFp: (configuration?: Configuration) => {
|
|
|
168
168
|
* @summary Update a team
|
|
169
169
|
* @param {number} id The ID of the team
|
|
170
170
|
* @param {UpdateTeamRequest} [UpdateTeamRequest]
|
|
171
|
-
|
|
171
|
+
|
|
172
172
|
* @throws {RequiredError}
|
|
173
173
|
*/
|
|
174
174
|
updateTeam(id: number, UpdateTeamRequest?: UpdateTeamRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetTeamResponse>>;
|
|
@@ -182,7 +182,7 @@ export declare const LegacyTeamsApiFactory: (configuration?: Configuration, base
|
|
|
182
182
|
* Adds a new team to the company and returns the created object.
|
|
183
183
|
* @summary Add a new team
|
|
184
184
|
* @param {LegacyTeamsApiAddTeamRequest} requestParameters Request parameters.
|
|
185
|
-
|
|
185
|
+
|
|
186
186
|
* @throws {RequiredError}
|
|
187
187
|
*/
|
|
188
188
|
addTeam(requestParameters?: LegacyTeamsApiAddTeamRequest): Promise<GetTeamResponse>;
|
|
@@ -190,7 +190,7 @@ export declare const LegacyTeamsApiFactory: (configuration?: Configuration, base
|
|
|
190
190
|
* Adds users to an existing team.
|
|
191
191
|
* @summary Add users to a team
|
|
192
192
|
* @param {LegacyTeamsApiAddTeamUserRequest} requestParameters Request parameters.
|
|
193
|
-
|
|
193
|
+
|
|
194
194
|
* @throws {RequiredError}
|
|
195
195
|
*/
|
|
196
196
|
addTeamUser(requestParameters: LegacyTeamsApiAddTeamUserRequest): Promise<UserIds>;
|
|
@@ -198,7 +198,7 @@ export declare const LegacyTeamsApiFactory: (configuration?: Configuration, base
|
|
|
198
198
|
* Deletes users from an existing team.
|
|
199
199
|
* @summary Delete users from a team
|
|
200
200
|
* @param {LegacyTeamsApiDeleteTeamUserRequest} requestParameters Request parameters.
|
|
201
|
-
|
|
201
|
+
|
|
202
202
|
* @throws {RequiredError}
|
|
203
203
|
*/
|
|
204
204
|
deleteTeamUser(requestParameters: LegacyTeamsApiDeleteTeamUserRequest): Promise<UserIds>;
|
|
@@ -206,7 +206,7 @@ export declare const LegacyTeamsApiFactory: (configuration?: Configuration, base
|
|
|
206
206
|
* Returns data about a specific team.
|
|
207
207
|
* @summary Get a single team
|
|
208
208
|
* @param {LegacyTeamsApiGetTeamRequest} requestParameters Request parameters.
|
|
209
|
-
|
|
209
|
+
|
|
210
210
|
* @throws {RequiredError}
|
|
211
211
|
*/
|
|
212
212
|
getTeam(requestParameters: LegacyTeamsApiGetTeamRequest): Promise<GetTeamResponse>;
|
|
@@ -214,7 +214,7 @@ export declare const LegacyTeamsApiFactory: (configuration?: Configuration, base
|
|
|
214
214
|
* Returns a list of all user IDs within a team.
|
|
215
215
|
* @summary Get all users in a team
|
|
216
216
|
* @param {LegacyTeamsApiGetTeamUsersRequest} requestParameters Request parameters.
|
|
217
|
-
|
|
217
|
+
|
|
218
218
|
* @throws {RequiredError}
|
|
219
219
|
*/
|
|
220
220
|
getTeamUsers(requestParameters: LegacyTeamsApiGetTeamUsersRequest): Promise<UserIds>;
|
|
@@ -222,7 +222,7 @@ export declare const LegacyTeamsApiFactory: (configuration?: Configuration, base
|
|
|
222
222
|
* Returns data about teams within the company.
|
|
223
223
|
* @summary Get all teams
|
|
224
224
|
* @param {LegacyTeamsApiGetTeamsRequest} requestParameters Request parameters.
|
|
225
|
-
|
|
225
|
+
|
|
226
226
|
* @throws {RequiredError}
|
|
227
227
|
*/
|
|
228
228
|
getTeams(requestParameters?: LegacyTeamsApiGetTeamsRequest): Promise<GetTeamsResponse>;
|
|
@@ -230,7 +230,7 @@ export declare const LegacyTeamsApiFactory: (configuration?: Configuration, base
|
|
|
230
230
|
* Returns data about all teams which have the specified user as a member.
|
|
231
231
|
* @summary Get all teams of a user
|
|
232
232
|
* @param {LegacyTeamsApiGetUserTeamsRequest} requestParameters Request parameters.
|
|
233
|
-
|
|
233
|
+
|
|
234
234
|
* @throws {RequiredError}
|
|
235
235
|
*/
|
|
236
236
|
getUserTeams(requestParameters: LegacyTeamsApiGetUserTeamsRequest): Promise<GetTeamsResponse>;
|
|
@@ -238,7 +238,7 @@ export declare const LegacyTeamsApiFactory: (configuration?: Configuration, base
|
|
|
238
238
|
* Updates an existing team and returns the updated object.
|
|
239
239
|
* @summary Update a team
|
|
240
240
|
* @param {LegacyTeamsApiUpdateTeamRequest} requestParameters Request parameters.
|
|
241
|
-
|
|
241
|
+
|
|
242
242
|
* @throws {RequiredError}
|
|
243
243
|
*/
|
|
244
244
|
updateTeam(requestParameters: LegacyTeamsApiUpdateTeamRequest): Promise<GetTeamResponse>;
|
|
@@ -400,7 +400,7 @@ export declare class LegacyTeamsApi extends BaseAPI {
|
|
|
400
400
|
* Adds a new team to the company and returns the created object.
|
|
401
401
|
* @summary Add a new team
|
|
402
402
|
* @param {LegacyTeamsApiAddTeamRequest} requestParameters Request parameters.
|
|
403
|
-
|
|
403
|
+
|
|
404
404
|
* @throws {RequiredError}
|
|
405
405
|
* @memberof LegacyTeamsApi
|
|
406
406
|
*/
|
|
@@ -409,7 +409,7 @@ export declare class LegacyTeamsApi extends BaseAPI {
|
|
|
409
409
|
* Adds users to an existing team.
|
|
410
410
|
* @summary Add users to a team
|
|
411
411
|
* @param {LegacyTeamsApiAddTeamUserRequest} requestParameters Request parameters.
|
|
412
|
-
|
|
412
|
+
|
|
413
413
|
* @throws {RequiredError}
|
|
414
414
|
* @memberof LegacyTeamsApi
|
|
415
415
|
*/
|
|
@@ -418,7 +418,7 @@ export declare class LegacyTeamsApi extends BaseAPI {
|
|
|
418
418
|
* Deletes users from an existing team.
|
|
419
419
|
* @summary Delete users from a team
|
|
420
420
|
* @param {LegacyTeamsApiDeleteTeamUserRequest} requestParameters Request parameters.
|
|
421
|
-
|
|
421
|
+
|
|
422
422
|
* @throws {RequiredError}
|
|
423
423
|
* @memberof LegacyTeamsApi
|
|
424
424
|
*/
|
|
@@ -427,7 +427,7 @@ export declare class LegacyTeamsApi extends BaseAPI {
|
|
|
427
427
|
* Returns data about a specific team.
|
|
428
428
|
* @summary Get a single team
|
|
429
429
|
* @param {LegacyTeamsApiGetTeamRequest} requestParameters Request parameters.
|
|
430
|
-
|
|
430
|
+
|
|
431
431
|
* @throws {RequiredError}
|
|
432
432
|
* @memberof LegacyTeamsApi
|
|
433
433
|
*/
|
|
@@ -436,7 +436,7 @@ export declare class LegacyTeamsApi extends BaseAPI {
|
|
|
436
436
|
* Returns a list of all user IDs within a team.
|
|
437
437
|
* @summary Get all users in a team
|
|
438
438
|
* @param {LegacyTeamsApiGetTeamUsersRequest} requestParameters Request parameters.
|
|
439
|
-
|
|
439
|
+
|
|
440
440
|
* @throws {RequiredError}
|
|
441
441
|
* @memberof LegacyTeamsApi
|
|
442
442
|
*/
|
|
@@ -445,7 +445,7 @@ export declare class LegacyTeamsApi extends BaseAPI {
|
|
|
445
445
|
* Returns data about teams within the company.
|
|
446
446
|
* @summary Get all teams
|
|
447
447
|
* @param {LegacyTeamsApiGetTeamsRequest} requestParameters Request parameters.
|
|
448
|
-
|
|
448
|
+
|
|
449
449
|
* @throws {RequiredError}
|
|
450
450
|
* @memberof LegacyTeamsApi
|
|
451
451
|
*/
|
|
@@ -454,7 +454,7 @@ export declare class LegacyTeamsApi extends BaseAPI {
|
|
|
454
454
|
* Returns data about all teams which have the specified user as a member.
|
|
455
455
|
* @summary Get all teams of a user
|
|
456
456
|
* @param {LegacyTeamsApiGetUserTeamsRequest} requestParameters Request parameters.
|
|
457
|
-
|
|
457
|
+
|
|
458
458
|
* @throws {RequiredError}
|
|
459
459
|
* @memberof LegacyTeamsApi
|
|
460
460
|
*/
|
|
@@ -463,7 +463,7 @@ export declare class LegacyTeamsApi extends BaseAPI {
|
|
|
463
463
|
* Updates an existing team and returns the updated object.
|
|
464
464
|
* @summary Update a team
|
|
465
465
|
* @param {LegacyTeamsApiUpdateTeamRequest} requestParameters Request parameters.
|
|
466
|
-
|
|
466
|
+
|
|
467
467
|
* @throws {RequiredError}
|
|
468
468
|
* @memberof LegacyTeamsApi
|
|
469
469
|
*/
|