pipedrive 25.0.0 → 27.0.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/activities-api.d.ts +40 -40
- package/dist/esm/versions/v1/api/activities-api.js +47 -47
- package/dist/esm/versions/v1/api/activity-fields-api.js +1 -1
- package/dist/esm/versions/v1/api/activity-types-api.js +5 -5
- package/dist/esm/versions/v1/api/billing-api.js +1 -1
- package/dist/esm/versions/v1/api/call-logs-api.js +5 -5
- package/dist/esm/versions/v1/api/channels-api.js +4 -4
- package/dist/esm/versions/v1/api/currencies-api.js +1 -1
- package/dist/esm/versions/v1/api/deal-fields-api.js +6 -6
- package/dist/esm/versions/v1/api/deals-api.d.ts +410 -88
- package/dist/esm/versions/v1/api/deals-api.js +447 -118
- package/dist/esm/versions/v1/api/files-api.js +8 -8
- package/dist/esm/versions/v1/api/filters-api.js +7 -7
- package/dist/esm/versions/v1/api/goals-api.js +5 -5
- package/dist/esm/versions/v1/api/item-search-api.d.ts +8 -8
- package/dist/esm/versions/v1/api/item-search-api.js +10 -10
- package/dist/esm/versions/v1/api/lead-labels-api.js +4 -4
- package/dist/esm/versions/v1/api/lead-sources-api.js +1 -1
- package/dist/esm/versions/v1/api/leads-api.d.ts +100 -14
- package/dist/esm/versions/v1/api/leads-api.js +114 -21
- package/dist/esm/versions/v1/api/legacy-teams-api.js +8 -8
- package/dist/esm/versions/v1/api/mailbox-api.js +6 -6
- package/dist/esm/versions/v1/api/meetings-api.js +2 -2
- package/dist/esm/versions/v1/api/note-fields-api.js +1 -1
- package/dist/esm/versions/v1/api/notes-api.d.ts +18 -2
- package/dist/esm/versions/v1/api/notes-api.js +25 -15
- package/dist/esm/versions/v1/api/organization-fields-api.js +6 -6
- package/dist/esm/versions/v1/api/organization-relationships-api.js +5 -5
- package/dist/esm/versions/v1/api/organizations-api.d.ts +68 -68
- package/dist/esm/versions/v1/api/organizations-api.js +88 -88
- package/dist/esm/versions/v1/api/permission-sets-api.js +3 -3
- package/dist/esm/versions/v1/api/person-fields-api.js +6 -6
- package/dist/esm/versions/v1/api/persons-api.d.ts +56 -56
- package/dist/esm/versions/v1/api/persons-api.js +78 -78
- package/dist/esm/versions/v1/api/pipelines-api.d.ts +28 -28
- package/dist/esm/versions/v1/api/pipelines-api.js +36 -36
- package/dist/esm/versions/v1/api/product-fields-api.js +6 -6
- package/dist/esm/versions/v1/api/products-api.d.ts +24 -24
- package/dist/esm/versions/v1/api/products-api.js +36 -36
- package/dist/esm/versions/v1/api/project-templates-api.js +4 -4
- package/dist/esm/versions/v1/api/projects-api.js +14 -14
- package/dist/esm/versions/v1/api/recents-api.js +1 -1
- package/dist/esm/versions/v1/api/roles-api.js +12 -12
- package/dist/esm/versions/v1/api/stages-api.d.ts +36 -36
- package/dist/esm/versions/v1/api/stages-api.js +43 -43
- package/dist/esm/versions/v1/api/subscriptions-api.js +9 -9
- package/dist/esm/versions/v1/api/tasks-api.js +5 -5
- package/dist/esm/versions/v1/api/user-connections-api.js +1 -1
- package/dist/esm/versions/v1/api/user-settings-api.js +1 -1
- package/dist/esm/versions/v1/api/users-api.js +10 -10
- package/dist/esm/versions/v1/api/webhooks-api.js +3 -3
- package/dist/esm/versions/v1/base.d.ts +2 -3
- package/dist/esm/versions/v1/configuration.d.ts +2 -2
- package/dist/esm/versions/v1/models/add-note-request-all-of.d.ts +9 -4
- package/dist/esm/versions/v1/models/add-note-request-all-of1.d.ts +10 -0
- package/dist/esm/versions/v1/models/add-note-request-all-of1.js +4 -0
- package/dist/esm/versions/v1/models/get-deal-search-response-all-of-data-items-inner-item.d.ts +5 -0
- package/dist/esm/versions/v1/models/index.d.ts +1 -0
- package/dist/esm/versions/v1/models/index.js +1 -0
- package/dist/esm/versions/v1/models/note-project.d.ts +23 -0
- package/dist/esm/versions/v1/models/note-project.js +14 -0
- package/dist/esm/versions/v1/models/note-request-all-of1.d.ts +5 -0
- package/dist/esm/versions/v1/models/note.d.ts +16 -0
- package/dist/esm/versions/v2/api/activities-api.d.ts +15 -7
- package/dist/esm/versions/v2/api/activities-api.js +17 -12
- package/dist/esm/versions/v2/api/beta-api.d.ts +212 -0
- package/dist/esm/versions/v2/api/beta-api.js +290 -4
- package/dist/esm/versions/v2/api/deals-api.d.ts +272 -4
- package/dist/esm/versions/v2/api/deals-api.js +311 -27
- package/dist/esm/versions/v2/api/item-search-api.js +2 -2
- package/dist/esm/versions/v2/api/leads-api.d.ts +111 -0
- package/dist/esm/versions/v2/api/leads-api.js +147 -2
- package/dist/esm/versions/v2/api/organizations-api.js +10 -10
- package/dist/esm/versions/v2/api/persons-api.d.ts +8 -8
- package/dist/esm/versions/v2/api/persons-api.js +18 -18
- package/dist/esm/versions/v2/api/pipelines-api.js +5 -5
- package/dist/esm/versions/v2/api/products-api.js +15 -15
- package/dist/esm/versions/v2/api/stages-api.js +5 -5
- package/dist/esm/versions/v2/api/users-api.js +1 -1
- package/dist/esm/versions/v2/base.d.ts +2 -3
- package/dist/esm/versions/v2/configuration.d.ts +2 -2
- package/dist/esm/versions/v2/models/activity-item.d.ts +5 -0
- package/dist/esm/versions/v2/models/activity-item1.d.ts +5 -0
- package/dist/esm/versions/v2/models/add-convert-deal-to-lead-response-data.d.ts +23 -0
- package/dist/esm/versions/v2/models/add-convert-deal-to-lead-response-data.js +14 -0
- package/dist/esm/versions/v2/models/add-convert-deal-to-lead-response.d.ts +34 -0
- package/dist/esm/versions/v2/models/add-convert-deal-to-lead-response.js +14 -0
- package/dist/esm/versions/v2/models/add-convert-lead-to-deal-response.d.ts +34 -0
- package/dist/esm/versions/v2/models/add-convert-lead-to-deal-response.js +14 -0
- package/dist/esm/versions/v2/models/add-person-request.d.ts +12 -0
- package/dist/esm/versions/v2/models/add-person-request.js +6 -1
- package/dist/esm/versions/v2/models/convert-lead-to-deal-request.d.ts +28 -0
- package/dist/esm/versions/v2/models/convert-lead-to-deal-request.js +14 -0
- package/dist/esm/versions/v2/models/deal-item.d.ts +5 -0
- package/dist/esm/versions/v2/models/deal-item1.d.ts +5 -0
- package/dist/esm/versions/v2/models/get-convert-response.d.ts +43 -0
- package/dist/esm/versions/v2/models/get-convert-response.js +14 -0
- package/dist/esm/versions/v2/models/get-convert-response1-data.d.ts +46 -0
- package/dist/esm/versions/v2/models/get-convert-response1-data.js +20 -0
- package/dist/esm/versions/v2/models/get-convert-response1.d.ts +34 -0
- package/dist/esm/versions/v2/models/get-convert-response1.js +14 -0
- package/dist/esm/versions/v2/models/get-deal-search-response-all-of-data-items-inner-item.d.ts +5 -0
- package/dist/esm/versions/v2/models/index.d.ts +7 -0
- package/dist/esm/versions/v2/models/index.js +7 -0
- package/dist/esm/versions/v2/models/update-person-request.d.ts +12 -0
- package/dist/esm/versions/v2/models/update-person-request.js +6 -1
- package/dist/versions/v1/api/activities-api.d.ts +40 -40
- package/dist/versions/v1/api/activities-api.js +47 -47
- package/dist/versions/v1/api/activity-fields-api.js +1 -1
- package/dist/versions/v1/api/activity-types-api.js +5 -5
- package/dist/versions/v1/api/billing-api.js +1 -1
- package/dist/versions/v1/api/call-logs-api.js +5 -5
- package/dist/versions/v1/api/channels-api.js +4 -4
- package/dist/versions/v1/api/currencies-api.js +1 -1
- package/dist/versions/v1/api/deal-fields-api.js +6 -6
- package/dist/versions/v1/api/deals-api.d.ts +410 -88
- package/dist/versions/v1/api/deals-api.js +447 -118
- package/dist/versions/v1/api/files-api.js +8 -8
- package/dist/versions/v1/api/filters-api.js +7 -7
- package/dist/versions/v1/api/goals-api.js +5 -5
- package/dist/versions/v1/api/item-search-api.d.ts +8 -8
- package/dist/versions/v1/api/item-search-api.js +10 -10
- package/dist/versions/v1/api/lead-labels-api.js +4 -4
- package/dist/versions/v1/api/lead-sources-api.js +1 -1
- package/dist/versions/v1/api/leads-api.d.ts +100 -14
- package/dist/versions/v1/api/leads-api.js +114 -21
- package/dist/versions/v1/api/legacy-teams-api.js +8 -8
- package/dist/versions/v1/api/mailbox-api.js +6 -6
- package/dist/versions/v1/api/meetings-api.js +2 -2
- package/dist/versions/v1/api/note-fields-api.js +1 -1
- package/dist/versions/v1/api/notes-api.d.ts +18 -2
- package/dist/versions/v1/api/notes-api.js +25 -15
- package/dist/versions/v1/api/organization-fields-api.js +6 -6
- package/dist/versions/v1/api/organization-relationships-api.js +5 -5
- package/dist/versions/v1/api/organizations-api.d.ts +68 -68
- package/dist/versions/v1/api/organizations-api.js +88 -88
- package/dist/versions/v1/api/permission-sets-api.js +3 -3
- package/dist/versions/v1/api/person-fields-api.js +6 -6
- package/dist/versions/v1/api/persons-api.d.ts +56 -56
- package/dist/versions/v1/api/persons-api.js +78 -78
- package/dist/versions/v1/api/pipelines-api.d.ts +28 -28
- package/dist/versions/v1/api/pipelines-api.js +36 -36
- package/dist/versions/v1/api/product-fields-api.js +6 -6
- package/dist/versions/v1/api/products-api.d.ts +24 -24
- package/dist/versions/v1/api/products-api.js +36 -36
- package/dist/versions/v1/api/project-templates-api.js +4 -4
- package/dist/versions/v1/api/projects-api.js +14 -14
- package/dist/versions/v1/api/recents-api.js +1 -1
- package/dist/versions/v1/api/roles-api.js +12 -12
- package/dist/versions/v1/api/stages-api.d.ts +36 -36
- package/dist/versions/v1/api/stages-api.js +43 -43
- package/dist/versions/v1/api/subscriptions-api.js +9 -9
- package/dist/versions/v1/api/tasks-api.js +5 -5
- package/dist/versions/v1/api/user-connections-api.js +1 -1
- package/dist/versions/v1/api/user-settings-api.js +1 -1
- package/dist/versions/v1/api/users-api.js +10 -10
- package/dist/versions/v1/api/webhooks-api.js +3 -3
- package/dist/versions/v1/base.d.ts +2 -3
- package/dist/versions/v1/configuration.d.ts +2 -2
- package/dist/versions/v1/models/add-note-request-all-of.d.ts +9 -4
- package/dist/versions/v1/models/add-note-request-all-of1.d.ts +10 -0
- package/dist/versions/v1/models/add-note-request-all-of1.js +5 -1
- package/dist/versions/v1/models/get-deal-search-response-all-of-data-items-inner-item.d.ts +5 -0
- package/dist/versions/v1/models/index.d.ts +1 -0
- package/dist/versions/v1/models/index.js +1 -0
- package/dist/versions/v1/models/note-project.d.ts +23 -0
- package/dist/versions/v1/models/note-project.js +15 -0
- package/dist/versions/v1/models/note-request-all-of1.d.ts +5 -0
- package/dist/versions/v1/models/note.d.ts +16 -0
- package/dist/versions/v2/api/activities-api.d.ts +15 -7
- package/dist/versions/v2/api/activities-api.js +17 -12
- package/dist/versions/v2/api/beta-api.d.ts +212 -0
- package/dist/versions/v2/api/beta-api.js +290 -4
- package/dist/versions/v2/api/deals-api.d.ts +272 -4
- package/dist/versions/v2/api/deals-api.js +311 -27
- package/dist/versions/v2/api/item-search-api.js +2 -2
- package/dist/versions/v2/api/leads-api.d.ts +111 -0
- package/dist/versions/v2/api/leads-api.js +146 -1
- package/dist/versions/v2/api/organizations-api.js +10 -10
- package/dist/versions/v2/api/persons-api.d.ts +8 -8
- package/dist/versions/v2/api/persons-api.js +18 -18
- package/dist/versions/v2/api/pipelines-api.js +5 -5
- package/dist/versions/v2/api/products-api.js +15 -15
- package/dist/versions/v2/api/stages-api.js +5 -5
- package/dist/versions/v2/api/users-api.js +1 -1
- package/dist/versions/v2/base.d.ts +2 -3
- package/dist/versions/v2/configuration.d.ts +2 -2
- package/dist/versions/v2/models/activity-item.d.ts +5 -0
- package/dist/versions/v2/models/activity-item1.d.ts +5 -0
- package/dist/versions/v2/models/add-convert-deal-to-lead-response-data.d.ts +23 -0
- package/dist/versions/v2/models/add-convert-deal-to-lead-response-data.js +15 -0
- package/dist/versions/v2/models/add-convert-deal-to-lead-response.d.ts +34 -0
- package/dist/versions/v2/models/add-convert-deal-to-lead-response.js +15 -0
- package/dist/versions/v2/models/add-convert-lead-to-deal-response.d.ts +34 -0
- package/dist/versions/v2/models/add-convert-lead-to-deal-response.js +15 -0
- package/dist/versions/v2/models/add-person-request.d.ts +12 -0
- package/dist/versions/v2/models/add-person-request.js +7 -0
- package/dist/versions/v2/models/convert-lead-to-deal-request.d.ts +28 -0
- package/dist/versions/v2/models/convert-lead-to-deal-request.js +15 -0
- package/dist/versions/v2/models/deal-item.d.ts +5 -0
- package/dist/versions/v2/models/deal-item1.d.ts +5 -0
- package/dist/versions/v2/models/get-convert-response.d.ts +43 -0
- package/dist/versions/v2/models/get-convert-response.js +15 -0
- package/dist/versions/v2/models/get-convert-response1-data.d.ts +46 -0
- package/dist/versions/v2/models/get-convert-response1-data.js +23 -0
- package/dist/versions/v2/models/get-convert-response1.d.ts +34 -0
- package/dist/versions/v2/models/get-convert-response1.js +15 -0
- package/dist/versions/v2/models/get-deal-search-response-all-of-data-items-inner-item.d.ts +5 -0
- package/dist/versions/v2/models/index.d.ts +7 -0
- package/dist/versions/v2/models/index.js +7 -0
- package/dist/versions/v2/models/update-person-request.d.ts +12 -0
- package/dist/versions/v2/models/update-person-request.js +7 -0
- package/package.json +1 -1
@@ -57,7 +57,7 @@ const LeadsApiAxiosParamCreator = function (configuration) {
|
|
57
57
|
const localVarHeaderParameter = {};
|
58
58
|
const localVarQueryParameter = {};
|
59
59
|
// authentication api_key required
|
60
|
-
yield (0, common_1.setApiKeyToObject)(
|
60
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-token", configuration);
|
61
61
|
// authentication oauth2 required
|
62
62
|
// oauth required
|
63
63
|
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["leads:full"], configuration);
|
@@ -93,7 +93,7 @@ const LeadsApiAxiosParamCreator = function (configuration) {
|
|
93
93
|
const localVarHeaderParameter = {};
|
94
94
|
const localVarQueryParameter = {};
|
95
95
|
// authentication api_key required
|
96
|
-
yield (0, common_1.setApiKeyToObject)(
|
96
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-token", configuration);
|
97
97
|
// authentication oauth2 required
|
98
98
|
// oauth required
|
99
99
|
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["leads:full"], configuration);
|
@@ -105,6 +105,64 @@ const LeadsApiAxiosParamCreator = function (configuration) {
|
|
105
105
|
options: localVarRequestOptions,
|
106
106
|
};
|
107
107
|
}),
|
108
|
+
/**
|
109
|
+
* Returns multiple archived leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using `limit` and `start` query parameters. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields\' structure from deals.
|
110
|
+
* @summary Get all archived leads
|
111
|
+
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned.
|
112
|
+
* @param {number} [start] For pagination, the position that represents the first result for the page
|
113
|
+
* @param {number} [owner_id] If supplied, only leads matching the given user will be returned. However, `filter_id` takes precedence over `owner_id` when supplied.
|
114
|
+
* @param {number} [person_id] If supplied, only leads matching the given person will be returned. However, `filter_id` takes precedence over `person_id` when supplied.
|
115
|
+
* @param {number} [organization_id] If supplied, only leads matching the given organization will be returned. However, `filter_id` takes precedence over `organization_id` when supplied.
|
116
|
+
* @param {number} [filter_id] The ID of the filter to use
|
117
|
+
* @param {'id' | 'title' | 'owner_id' | 'creator_id' | 'was_seen' | 'expected_close_date' | 'next_activity_id' | 'add_time' | 'update_time'} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys).
|
118
|
+
|
119
|
+
* @throws {RequiredError}
|
120
|
+
*/
|
121
|
+
getArchivedLeads: (limit, start, owner_id, person_id, organization_id, filter_id, sort) => __awaiter(this, void 0, void 0, function* () {
|
122
|
+
const localVarPath = `/leads/archived`;
|
123
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
124
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
125
|
+
let baseOptions;
|
126
|
+
if (configuration) {
|
127
|
+
baseOptions = configuration.baseOptions;
|
128
|
+
}
|
129
|
+
const localVarRequestOptions = Object.assign({ method: 'GET' }, baseOptions);
|
130
|
+
const localVarHeaderParameter = {};
|
131
|
+
const localVarQueryParameter = {};
|
132
|
+
// authentication api_key required
|
133
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-token", configuration);
|
134
|
+
// authentication oauth2 required
|
135
|
+
// oauth required
|
136
|
+
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["leads:read", "leads:full"], configuration);
|
137
|
+
if (limit !== undefined) {
|
138
|
+
localVarQueryParameter['limit'] = limit;
|
139
|
+
}
|
140
|
+
if (start !== undefined) {
|
141
|
+
localVarQueryParameter['start'] = start;
|
142
|
+
}
|
143
|
+
if (owner_id !== undefined) {
|
144
|
+
localVarQueryParameter['owner_id'] = owner_id;
|
145
|
+
}
|
146
|
+
if (person_id !== undefined) {
|
147
|
+
localVarQueryParameter['person_id'] = person_id;
|
148
|
+
}
|
149
|
+
if (organization_id !== undefined) {
|
150
|
+
localVarQueryParameter['organization_id'] = organization_id;
|
151
|
+
}
|
152
|
+
if (filter_id !== undefined) {
|
153
|
+
localVarQueryParameter['filter_id'] = filter_id;
|
154
|
+
}
|
155
|
+
if (sort !== undefined) {
|
156
|
+
localVarQueryParameter['sort'] = sort;
|
157
|
+
}
|
158
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
159
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
160
|
+
localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
|
161
|
+
return {
|
162
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
163
|
+
options: localVarRequestOptions,
|
164
|
+
};
|
165
|
+
}),
|
108
166
|
/**
|
109
167
|
* Returns details of a specific lead. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields’ structure from deals.
|
110
168
|
* @summary Get one lead
|
@@ -127,7 +185,7 @@ const LeadsApiAxiosParamCreator = function (configuration) {
|
|
127
185
|
const localVarHeaderParameter = {};
|
128
186
|
const localVarQueryParameter = {};
|
129
187
|
// authentication api_key required
|
130
|
-
yield (0, common_1.setApiKeyToObject)(
|
188
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-token", configuration);
|
131
189
|
// authentication oauth2 required
|
132
190
|
// oauth required
|
133
191
|
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["leads:read", "leads:full"], configuration);
|
@@ -161,7 +219,7 @@ const LeadsApiAxiosParamCreator = function (configuration) {
|
|
161
219
|
const localVarHeaderParameter = {};
|
162
220
|
const localVarQueryParameter = {};
|
163
221
|
// authentication api_key required
|
164
|
-
yield (0, common_1.setApiKeyToObject)(
|
222
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-token", configuration);
|
165
223
|
// authentication oauth2 required
|
166
224
|
// oauth required
|
167
225
|
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["leads:read", "leads:full"], configuration);
|
@@ -174,11 +232,10 @@ const LeadsApiAxiosParamCreator = function (configuration) {
|
|
174
232
|
};
|
175
233
|
}),
|
176
234
|
/**
|
177
|
-
* Returns multiple leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using `limit` and `start` query parameters. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields\' structure from deals.
|
235
|
+
* Returns multiple not archived leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using `limit` and `start` query parameters. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields\' structure from deals.
|
178
236
|
* @summary Get all leads
|
179
237
|
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned.
|
180
238
|
* @param {number} [start] For pagination, the position that represents the first result for the page
|
181
|
-
* @param {'archived' | 'not_archived' | 'all'} [archived_status] Filtering based on the archived status of a lead. If not provided, `All` is used.
|
182
239
|
* @param {number} [owner_id] If supplied, only leads matching the given user will be returned. However, `filter_id` takes precedence over `owner_id` when supplied.
|
183
240
|
* @param {number} [person_id] If supplied, only leads matching the given person will be returned. However, `filter_id` takes precedence over `person_id` when supplied.
|
184
241
|
* @param {number} [organization_id] If supplied, only leads matching the given organization will be returned. However, `filter_id` takes precedence over `organization_id` when supplied.
|
@@ -187,7 +244,7 @@ const LeadsApiAxiosParamCreator = function (configuration) {
|
|
187
244
|
|
188
245
|
* @throws {RequiredError}
|
189
246
|
*/
|
190
|
-
getLeads: (limit, start,
|
247
|
+
getLeads: (limit, start, owner_id, person_id, organization_id, filter_id, sort) => __awaiter(this, void 0, void 0, function* () {
|
191
248
|
const localVarPath = `/leads`;
|
192
249
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
193
250
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
@@ -199,7 +256,7 @@ const LeadsApiAxiosParamCreator = function (configuration) {
|
|
199
256
|
const localVarHeaderParameter = {};
|
200
257
|
const localVarQueryParameter = {};
|
201
258
|
// authentication api_key required
|
202
|
-
yield (0, common_1.setApiKeyToObject)(
|
259
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-token", configuration);
|
203
260
|
// authentication oauth2 required
|
204
261
|
// oauth required
|
205
262
|
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["leads:read", "leads:full"], configuration);
|
@@ -209,9 +266,6 @@ const LeadsApiAxiosParamCreator = function (configuration) {
|
|
209
266
|
if (start !== undefined) {
|
210
267
|
localVarQueryParameter['start'] = start;
|
211
268
|
}
|
212
|
-
if (archived_status !== undefined) {
|
213
|
-
localVarQueryParameter['archived_status'] = archived_status;
|
214
|
-
}
|
215
269
|
if (owner_id !== undefined) {
|
216
270
|
localVarQueryParameter['owner_id'] = owner_id;
|
217
271
|
}
|
@@ -263,7 +317,7 @@ const LeadsApiAxiosParamCreator = function (configuration) {
|
|
263
317
|
const localVarHeaderParameter = {};
|
264
318
|
const localVarQueryParameter = {};
|
265
319
|
// authentication api_key required
|
266
|
-
yield (0, common_1.setApiKeyToObject)(
|
320
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-token", configuration);
|
267
321
|
// authentication oauth2 required
|
268
322
|
// oauth required
|
269
323
|
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["leads:read", "leads:full", "search:read"], configuration);
|
@@ -322,7 +376,7 @@ const LeadsApiAxiosParamCreator = function (configuration) {
|
|
322
376
|
const localVarHeaderParameter = {};
|
323
377
|
const localVarQueryParameter = {};
|
324
378
|
// authentication api_key required
|
325
|
-
yield (0, common_1.setApiKeyToObject)(
|
379
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-token", configuration);
|
326
380
|
// authentication oauth2 required
|
327
381
|
// oauth required
|
328
382
|
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["leads:full"], configuration);
|
@@ -372,6 +426,25 @@ const LeadsApiFp = function (configuration) {
|
|
372
426
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
373
427
|
});
|
374
428
|
},
|
429
|
+
/**
|
430
|
+
* Returns multiple archived leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using `limit` and `start` query parameters. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields\' structure from deals.
|
431
|
+
* @summary Get all archived leads
|
432
|
+
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned.
|
433
|
+
* @param {number} [start] For pagination, the position that represents the first result for the page
|
434
|
+
* @param {number} [owner_id] If supplied, only leads matching the given user will be returned. However, `filter_id` takes precedence over `owner_id` when supplied.
|
435
|
+
* @param {number} [person_id] If supplied, only leads matching the given person will be returned. However, `filter_id` takes precedence over `person_id` when supplied.
|
436
|
+
* @param {number} [organization_id] If supplied, only leads matching the given organization will be returned. However, `filter_id` takes precedence over `organization_id` when supplied.
|
437
|
+
* @param {number} [filter_id] The ID of the filter to use
|
438
|
+
* @param {'id' | 'title' | 'owner_id' | 'creator_id' | 'was_seen' | 'expected_close_date' | 'next_activity_id' | 'add_time' | 'update_time'} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys).
|
439
|
+
|
440
|
+
* @throws {RequiredError}
|
441
|
+
*/
|
442
|
+
getArchivedLeads(limit, start, owner_id, person_id, organization_id, filter_id, sort) {
|
443
|
+
return __awaiter(this, void 0, void 0, function* () {
|
444
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getArchivedLeads(limit, start, owner_id, person_id, organization_id, filter_id, sort);
|
445
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
446
|
+
});
|
447
|
+
},
|
375
448
|
/**
|
376
449
|
* Returns details of a specific lead. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields’ structure from deals.
|
377
450
|
* @summary Get one lead
|
@@ -399,11 +472,10 @@ const LeadsApiFp = function (configuration) {
|
|
399
472
|
});
|
400
473
|
},
|
401
474
|
/**
|
402
|
-
* Returns multiple leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using `limit` and `start` query parameters. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields\' structure from deals.
|
475
|
+
* Returns multiple not archived leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using `limit` and `start` query parameters. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields\' structure from deals.
|
403
476
|
* @summary Get all leads
|
404
477
|
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned.
|
405
478
|
* @param {number} [start] For pagination, the position that represents the first result for the page
|
406
|
-
* @param {'archived' | 'not_archived' | 'all'} [archived_status] Filtering based on the archived status of a lead. If not provided, `All` is used.
|
407
479
|
* @param {number} [owner_id] If supplied, only leads matching the given user will be returned. However, `filter_id` takes precedence over `owner_id` when supplied.
|
408
480
|
* @param {number} [person_id] If supplied, only leads matching the given person will be returned. However, `filter_id` takes precedence over `person_id` when supplied.
|
409
481
|
* @param {number} [organization_id] If supplied, only leads matching the given organization will be returned. However, `filter_id` takes precedence over `organization_id` when supplied.
|
@@ -412,9 +484,9 @@ const LeadsApiFp = function (configuration) {
|
|
412
484
|
|
413
485
|
* @throws {RequiredError}
|
414
486
|
*/
|
415
|
-
getLeads(limit, start,
|
487
|
+
getLeads(limit, start, owner_id, person_id, organization_id, filter_id, sort) {
|
416
488
|
return __awaiter(this, void 0, void 0, function* () {
|
417
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getLeads(limit, start,
|
489
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getLeads(limit, start, owner_id, person_id, organization_id, filter_id, sort);
|
418
490
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
419
491
|
});
|
420
492
|
},
|
@@ -482,6 +554,16 @@ const LeadsApiFactory = function (configuration, basePath, axios) {
|
|
482
554
|
deleteLead(requestParameters) {
|
483
555
|
return localVarFp.deleteLead(requestParameters.id).then((request) => request(axios, basePath));
|
484
556
|
},
|
557
|
+
/**
|
558
|
+
* Returns multiple archived leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using `limit` and `start` query parameters. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields\' structure from deals.
|
559
|
+
* @summary Get all archived leads
|
560
|
+
* @param {LeadsApiGetArchivedLeadsRequest} requestParameters Request parameters.
|
561
|
+
|
562
|
+
* @throws {RequiredError}
|
563
|
+
*/
|
564
|
+
getArchivedLeads(requestParameters = {}) {
|
565
|
+
return localVarFp.getArchivedLeads(requestParameters.limit, requestParameters.start, requestParameters.owner_id, requestParameters.person_id, requestParameters.organization_id, requestParameters.filter_id, requestParameters.sort).then((request) => request(axios, basePath));
|
566
|
+
},
|
485
567
|
/**
|
486
568
|
* Returns details of a specific lead. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields’ structure from deals.
|
487
569
|
* @summary Get one lead
|
@@ -503,14 +585,14 @@ const LeadsApiFactory = function (configuration, basePath, axios) {
|
|
503
585
|
return localVarFp.getLeadUsers(requestParameters.id).then((request) => request(axios, basePath));
|
504
586
|
},
|
505
587
|
/**
|
506
|
-
* Returns multiple leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using `limit` and `start` query parameters. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields\' structure from deals.
|
588
|
+
* Returns multiple not archived leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using `limit` and `start` query parameters. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields\' structure from deals.
|
507
589
|
* @summary Get all leads
|
508
590
|
* @param {LeadsApiGetLeadsRequest} requestParameters Request parameters.
|
509
591
|
|
510
592
|
* @throws {RequiredError}
|
511
593
|
*/
|
512
594
|
getLeads(requestParameters = {}) {
|
513
|
-
return localVarFp.getLeads(requestParameters.limit, requestParameters.start, requestParameters.
|
595
|
+
return localVarFp.getLeads(requestParameters.limit, requestParameters.start, requestParameters.owner_id, requestParameters.person_id, requestParameters.organization_id, requestParameters.filter_id, requestParameters.sort).then((request) => request(axios, basePath));
|
514
596
|
},
|
515
597
|
/**
|
516
598
|
* Searches all leads by title, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found leads can be filtered by the person ID and the organization ID.
|
@@ -564,6 +646,17 @@ class LeadsApi extends base_1.BaseAPI {
|
|
564
646
|
deleteLead(requestParameters) {
|
565
647
|
return (0, exports.LeadsApiFp)(this.configuration).deleteLead(requestParameters.id).then((request) => request(this.axios, this.basePath));
|
566
648
|
}
|
649
|
+
/**
|
650
|
+
* Returns multiple archived leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using `limit` and `start` query parameters. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields\' structure from deals.
|
651
|
+
* @summary Get all archived leads
|
652
|
+
* @param {LeadsApiGetArchivedLeadsRequest} requestParameters Request parameters.
|
653
|
+
|
654
|
+
* @throws {RequiredError}
|
655
|
+
* @memberof LeadsApi
|
656
|
+
*/
|
657
|
+
getArchivedLeads(requestParameters = {}) {
|
658
|
+
return (0, exports.LeadsApiFp)(this.configuration).getArchivedLeads(requestParameters.limit, requestParameters.start, requestParameters.owner_id, requestParameters.person_id, requestParameters.organization_id, requestParameters.filter_id, requestParameters.sort).then((request) => request(this.axios, this.basePath));
|
659
|
+
}
|
567
660
|
/**
|
568
661
|
* Returns details of a specific lead. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields’ structure from deals.
|
569
662
|
* @summary Get one lead
|
@@ -587,7 +680,7 @@ class LeadsApi extends base_1.BaseAPI {
|
|
587
680
|
return (0, exports.LeadsApiFp)(this.configuration).getLeadUsers(requestParameters.id).then((request) => request(this.axios, this.basePath));
|
588
681
|
}
|
589
682
|
/**
|
590
|
-
* Returns multiple leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using `limit` and `start` query parameters. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields\' structure from deals.
|
683
|
+
* Returns multiple not archived leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using `limit` and `start` query parameters. If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields\' structure from deals.
|
591
684
|
* @summary Get all leads
|
592
685
|
* @param {LeadsApiGetLeadsRequest} requestParameters Request parameters.
|
593
686
|
|
@@ -595,7 +688,7 @@ class LeadsApi extends base_1.BaseAPI {
|
|
595
688
|
* @memberof LeadsApi
|
596
689
|
*/
|
597
690
|
getLeads(requestParameters = {}) {
|
598
|
-
return (0, exports.LeadsApiFp)(this.configuration).getLeads(requestParameters.limit, requestParameters.start, requestParameters.
|
691
|
+
return (0, exports.LeadsApiFp)(this.configuration).getLeads(requestParameters.limit, requestParameters.start, requestParameters.owner_id, requestParameters.person_id, requestParameters.organization_id, requestParameters.filter_id, requestParameters.sort).then((request) => request(this.axios, this.basePath));
|
599
692
|
}
|
600
693
|
/**
|
601
694
|
* Searches all leads by title, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found leads can be filtered by the person ID and the organization ID.
|
@@ -57,7 +57,7 @@ const LegacyTeamsApiAxiosParamCreator = function (configuration) {
|
|
57
57
|
const localVarHeaderParameter = {};
|
58
58
|
const localVarQueryParameter = {};
|
59
59
|
// authentication api_key required
|
60
|
-
yield (0, common_1.setApiKeyToObject)(
|
60
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-token", configuration);
|
61
61
|
// authentication oauth2 required
|
62
62
|
// oauth required
|
63
63
|
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["admin"], configuration);
|
@@ -94,7 +94,7 @@ const LegacyTeamsApiAxiosParamCreator = function (configuration) {
|
|
94
94
|
const localVarHeaderParameter = {};
|
95
95
|
const localVarQueryParameter = {};
|
96
96
|
// authentication api_key required
|
97
|
-
yield (0, common_1.setApiKeyToObject)(
|
97
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-token", configuration);
|
98
98
|
// authentication oauth2 required
|
99
99
|
// oauth required
|
100
100
|
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["admin"], configuration);
|
@@ -131,7 +131,7 @@ const LegacyTeamsApiAxiosParamCreator = function (configuration) {
|
|
131
131
|
const localVarHeaderParameter = {};
|
132
132
|
const localVarQueryParameter = {};
|
133
133
|
// authentication api_key required
|
134
|
-
yield (0, common_1.setApiKeyToObject)(
|
134
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-token", configuration);
|
135
135
|
// authentication oauth2 required
|
136
136
|
// oauth required
|
137
137
|
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["admin"], configuration);
|
@@ -168,7 +168,7 @@ const LegacyTeamsApiAxiosParamCreator = function (configuration) {
|
|
168
168
|
const localVarHeaderParameter = {};
|
169
169
|
const localVarQueryParameter = {};
|
170
170
|
// authentication api_key required
|
171
|
-
yield (0, common_1.setApiKeyToObject)(
|
171
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-token", configuration);
|
172
172
|
// authentication oauth2 required
|
173
173
|
// oauth required
|
174
174
|
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["users:read"], configuration);
|
@@ -205,7 +205,7 @@ const LegacyTeamsApiAxiosParamCreator = function (configuration) {
|
|
205
205
|
const localVarHeaderParameter = {};
|
206
206
|
const localVarQueryParameter = {};
|
207
207
|
// authentication api_key required
|
208
|
-
yield (0, common_1.setApiKeyToObject)(
|
208
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-token", configuration);
|
209
209
|
// authentication oauth2 required
|
210
210
|
// oauth required
|
211
211
|
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["users:read"], configuration);
|
@@ -237,7 +237,7 @@ const LegacyTeamsApiAxiosParamCreator = function (configuration) {
|
|
237
237
|
const localVarHeaderParameter = {};
|
238
238
|
const localVarQueryParameter = {};
|
239
239
|
// authentication api_key required
|
240
|
-
yield (0, common_1.setApiKeyToObject)(
|
240
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-token", configuration);
|
241
241
|
// authentication oauth2 required
|
242
242
|
// oauth required
|
243
243
|
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["users:read"], configuration);
|
@@ -279,7 +279,7 @@ const LegacyTeamsApiAxiosParamCreator = function (configuration) {
|
|
279
279
|
const localVarHeaderParameter = {};
|
280
280
|
const localVarQueryParameter = {};
|
281
281
|
// authentication api_key required
|
282
|
-
yield (0, common_1.setApiKeyToObject)(
|
282
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-token", configuration);
|
283
283
|
// authentication oauth2 required
|
284
284
|
// oauth required
|
285
285
|
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["users:read"], configuration);
|
@@ -320,7 +320,7 @@ const LegacyTeamsApiAxiosParamCreator = function (configuration) {
|
|
320
320
|
const localVarHeaderParameter = {};
|
321
321
|
const localVarQueryParameter = {};
|
322
322
|
// authentication api_key required
|
323
|
-
yield (0, common_1.setApiKeyToObject)(
|
323
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-token", configuration);
|
324
324
|
// authentication oauth2 required
|
325
325
|
// oauth required
|
326
326
|
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["admin"], configuration);
|
@@ -60,7 +60,7 @@ const MailboxApiAxiosParamCreator = function (configuration) {
|
|
60
60
|
const localVarHeaderParameter = {};
|
61
61
|
const localVarQueryParameter = {};
|
62
62
|
// authentication api_key required
|
63
|
-
yield (0, common_1.setApiKeyToObject)(
|
63
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-token", configuration);
|
64
64
|
// authentication oauth2 required
|
65
65
|
// oauth required
|
66
66
|
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["mail:full"], configuration);
|
@@ -95,7 +95,7 @@ const MailboxApiAxiosParamCreator = function (configuration) {
|
|
95
95
|
const localVarHeaderParameter = {};
|
96
96
|
const localVarQueryParameter = {};
|
97
97
|
// authentication api_key required
|
98
|
-
yield (0, common_1.setApiKeyToObject)(
|
98
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-token", configuration);
|
99
99
|
// authentication oauth2 required
|
100
100
|
// oauth required
|
101
101
|
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["mail:read", "mail:full"], configuration);
|
@@ -132,7 +132,7 @@ const MailboxApiAxiosParamCreator = function (configuration) {
|
|
132
132
|
const localVarHeaderParameter = {};
|
133
133
|
const localVarQueryParameter = {};
|
134
134
|
// authentication api_key required
|
135
|
-
yield (0, common_1.setApiKeyToObject)(
|
135
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-token", configuration);
|
136
136
|
// authentication oauth2 required
|
137
137
|
// oauth required
|
138
138
|
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["mail:read", "mail:full"], configuration);
|
@@ -166,7 +166,7 @@ const MailboxApiAxiosParamCreator = function (configuration) {
|
|
166
166
|
const localVarHeaderParameter = {};
|
167
167
|
const localVarQueryParameter = {};
|
168
168
|
// authentication api_key required
|
169
|
-
yield (0, common_1.setApiKeyToObject)(
|
169
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-token", configuration);
|
170
170
|
// authentication oauth2 required
|
171
171
|
// oauth required
|
172
172
|
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["mail:read", "mail:full"], configuration);
|
@@ -201,7 +201,7 @@ const MailboxApiAxiosParamCreator = function (configuration) {
|
|
201
201
|
const localVarHeaderParameter = {};
|
202
202
|
const localVarQueryParameter = {};
|
203
203
|
// authentication api_key required
|
204
|
-
yield (0, common_1.setApiKeyToObject)(
|
204
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-token", configuration);
|
205
205
|
// authentication oauth2 required
|
206
206
|
// oauth required
|
207
207
|
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["mail:read", "mail:full"], configuration);
|
@@ -250,7 +250,7 @@ const MailboxApiAxiosParamCreator = function (configuration) {
|
|
250
250
|
const localVarQueryParameter = {};
|
251
251
|
const localVarFormParams = new URLSearchParams();
|
252
252
|
// authentication api_key required
|
253
|
-
yield (0, common_1.setApiKeyToObject)(
|
253
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-token", configuration);
|
254
254
|
// authentication oauth2 required
|
255
255
|
// oauth required
|
256
256
|
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["mail:full"], configuration);
|
@@ -60,7 +60,7 @@ const MeetingsApiAxiosParamCreator = function (configuration) {
|
|
60
60
|
const localVarHeaderParameter = {};
|
61
61
|
const localVarQueryParameter = {};
|
62
62
|
// authentication api_key required
|
63
|
-
yield (0, common_1.setApiKeyToObject)(
|
63
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-token", configuration);
|
64
64
|
// authentication oauth2 required
|
65
65
|
// oauth required
|
66
66
|
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["video-calls"], configuration);
|
@@ -91,7 +91,7 @@ const MeetingsApiAxiosParamCreator = function (configuration) {
|
|
91
91
|
const localVarHeaderParameter = {};
|
92
92
|
const localVarQueryParameter = {};
|
93
93
|
// authentication api_key required
|
94
|
-
yield (0, common_1.setApiKeyToObject)(
|
94
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-token", configuration);
|
95
95
|
// authentication oauth2 required
|
96
96
|
// oauth required
|
97
97
|
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["video-calls"], configuration);
|
@@ -56,7 +56,7 @@ const NoteFieldsApiAxiosParamCreator = function (configuration) {
|
|
56
56
|
const localVarHeaderParameter = {};
|
57
57
|
const localVarQueryParameter = {};
|
58
58
|
// authentication api_key required
|
59
|
-
yield (0, common_1.setApiKeyToObject)(
|
59
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-token", configuration);
|
60
60
|
// authentication oauth2 required
|
61
61
|
// oauth required
|
62
62
|
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["deals:read", "deals:full", "contacts:read", "contacts:full"], configuration);
|
@@ -95,6 +95,7 @@ export declare const NotesApiAxiosParamCreator: (configuration?: Configuration)
|
|
95
95
|
* @param {number} [deal_id] The ID of the deal which notes to fetch. If omitted, notes about all deals will be returned.
|
96
96
|
* @param {number} [person_id] The ID of the person whose notes to fetch. If omitted, notes about all persons will be returned.
|
97
97
|
* @param {number} [org_id] The ID of the organization which notes to fetch. If omitted, notes about all organizations will be returned.
|
98
|
+
* @param {number} [project_id] The ID of the project which notes to fetch. If omitted, notes about all projects will be returned.
|
98
99
|
* @param {number} [start] Pagination start
|
99
100
|
* @param {number} [limit] Items shown per page
|
100
101
|
* @param {string} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: `id`, `user_id`, `deal_id`, `person_id`, `org_id`, `content`, `add_time`, `update_time`.
|
@@ -104,10 +105,11 @@ export declare const NotesApiAxiosParamCreator: (configuration?: Configuration)
|
|
104
105
|
* @param {0 | 1} [pinned_to_deal_flag] If set, the results are filtered by note to deal pinning state
|
105
106
|
* @param {0 | 1} [pinned_to_organization_flag] If set, the results are filtered by note to organization pinning state
|
106
107
|
* @param {0 | 1} [pinned_to_person_flag] If set, the results are filtered by note to person pinning state
|
108
|
+
* @param {0 | 1} [pinned_to_project_flag] If set, the results are filtered by note to project pinning state
|
107
109
|
|
108
110
|
* @throws {RequiredError}
|
109
111
|
*/
|
110
|
-
getNotes: (user_id?: number, lead_id?: string, deal_id?: number, person_id?: number, org_id?: number, start?: number, limit?: number, sort?: string, start_date?: string, end_date?: string, pinned_to_lead_flag?: 0 | 1, pinned_to_deal_flag?: 0 | 1, pinned_to_organization_flag?: 0 | 1, pinned_to_person_flag?: 0 | 1) => Promise<RequestArgs>;
|
112
|
+
getNotes: (user_id?: number, lead_id?: string, deal_id?: number, person_id?: number, org_id?: number, project_id?: number, start?: number, limit?: number, sort?: string, start_date?: string, end_date?: string, pinned_to_lead_flag?: 0 | 1, pinned_to_deal_flag?: 0 | 1, pinned_to_organization_flag?: 0 | 1, pinned_to_person_flag?: 0 | 1, pinned_to_project_flag?: 0 | 1) => Promise<RequestArgs>;
|
111
113
|
/**
|
112
114
|
* Updates a comment related to a note.
|
113
115
|
* @summary Update a comment related to a note
|
@@ -202,6 +204,7 @@ export declare const NotesApiFp: (configuration?: Configuration) => {
|
|
202
204
|
* @param {number} [deal_id] The ID of the deal which notes to fetch. If omitted, notes about all deals will be returned.
|
203
205
|
* @param {number} [person_id] The ID of the person whose notes to fetch. If omitted, notes about all persons will be returned.
|
204
206
|
* @param {number} [org_id] The ID of the organization which notes to fetch. If omitted, notes about all organizations will be returned.
|
207
|
+
* @param {number} [project_id] The ID of the project which notes to fetch. If omitted, notes about all projects will be returned.
|
205
208
|
* @param {number} [start] Pagination start
|
206
209
|
* @param {number} [limit] Items shown per page
|
207
210
|
* @param {string} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: `id`, `user_id`, `deal_id`, `person_id`, `org_id`, `content`, `add_time`, `update_time`.
|
@@ -211,10 +214,11 @@ export declare const NotesApiFp: (configuration?: Configuration) => {
|
|
211
214
|
* @param {0 | 1} [pinned_to_deal_flag] If set, the results are filtered by note to deal pinning state
|
212
215
|
* @param {0 | 1} [pinned_to_organization_flag] If set, the results are filtered by note to organization pinning state
|
213
216
|
* @param {0 | 1} [pinned_to_person_flag] If set, the results are filtered by note to person pinning state
|
217
|
+
* @param {0 | 1} [pinned_to_project_flag] If set, the results are filtered by note to project pinning state
|
214
218
|
|
215
219
|
* @throws {RequiredError}
|
216
220
|
*/
|
217
|
-
getNotes(user_id?: number, lead_id?: string, deal_id?: number, person_id?: number, org_id?: number, start?: number, limit?: number, sort?: string, start_date?: string, end_date?: string, pinned_to_lead_flag?: 0 | 1, pinned_to_deal_flag?: 0 | 1, pinned_to_organization_flag?: 0 | 1, pinned_to_person_flag?: 0 | 1): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetNotesResponse>>;
|
221
|
+
getNotes(user_id?: number, lead_id?: string, deal_id?: number, person_id?: number, org_id?: number, project_id?: number, start?: number, limit?: number, sort?: string, start_date?: string, end_date?: string, pinned_to_lead_flag?: 0 | 1, pinned_to_deal_flag?: 0 | 1, pinned_to_organization_flag?: 0 | 1, pinned_to_person_flag?: 0 | 1, pinned_to_project_flag?: 0 | 1): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetNotesResponse>>;
|
218
222
|
/**
|
219
223
|
* Updates a comment related to a note.
|
220
224
|
* @summary Update a comment related to a note
|
@@ -478,6 +482,12 @@ export interface NotesApiGetNotesRequest {
|
|
478
482
|
* @memberof NotesApiGetNotes
|
479
483
|
*/
|
480
484
|
readonly org_id?: number;
|
485
|
+
/**
|
486
|
+
* The ID of the project which notes to fetch. If omitted, notes about all projects will be returned.
|
487
|
+
* @type {number}
|
488
|
+
* @memberof NotesApiGetNotes
|
489
|
+
*/
|
490
|
+
readonly project_id?: number;
|
481
491
|
/**
|
482
492
|
* Pagination start
|
483
493
|
* @type {number}
|
@@ -532,6 +542,12 @@ export interface NotesApiGetNotesRequest {
|
|
532
542
|
* @memberof NotesApiGetNotes
|
533
543
|
*/
|
534
544
|
readonly pinned_to_person_flag?: 0 | 1;
|
545
|
+
/**
|
546
|
+
* If set, the results are filtered by note to project pinning state
|
547
|
+
* @type {0 | 1}
|
548
|
+
* @memberof NotesApiGetNotes
|
549
|
+
*/
|
550
|
+
readonly pinned_to_project_flag?: 0 | 1;
|
535
551
|
}
|
536
552
|
/**
|
537
553
|
* Request parameters for updateCommentForNote operation in NotesApi.
|