-
Notifications
You must be signed in to change notification settings - Fork 89
Expand file tree
/
Copy pathproduct-fields-api.ts
More file actions
631 lines (541 loc) · 27.7 KB
/
product-fields-api.ts
File metadata and controls
631 lines (541 loc) · 27.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
/* tslint:disable */
/* eslint-disable */
/**
* Pipedrive API v1
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
*
* The version of the OpenAPI document: 1.0.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import type { Configuration } from '../configuration';
import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
import globalAxios from 'axios';
// Some imports not used depending on template conditions
// @ts-ignore
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
// @ts-ignore
import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
// @ts-ignore
import { DeleteProductFieldResponse } from '../models';
// @ts-ignore
import { DeleteProductFieldsResponse } from '../models';
// @ts-ignore
import { FailResponse } from '../models';
// @ts-ignore
import { GetProductFieldResponse } from '../models';
// @ts-ignore
import { GetProductFieldsResponse } from '../models';
// @ts-ignore
import { ProductFieldAllOf } from '../models';
// @ts-ignore
import { UpdateProductFieldResponse } from '../models';
/**
* ProductFieldsApi - axios parameter creator
* @export
*/
export const ProductFieldsApiAxiosParamCreator = function (configuration?: Configuration) {
return {
/**
* Adds a new product field. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-new-custom-field\" target=\"_blank\" rel=\"noopener noreferrer\">adding a new custom field</a>.
* @summary Add a new product field
* @param {ProductFieldAllOf} [ProductFieldAllOf]
* @throws {RequiredError}
*/
addProductField: async (ProductFieldAllOf?: ProductFieldAllOf, ): Promise<RequestArgs> => {
const localVarPath = `/productFields`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'POST', ...baseOptions };
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
// authentication api_key required
await setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration)
// authentication oauth2 required
// oauth required
await setOAuthToObject(localVarHeaderParameter, "oauth2", ["product-fields:full", "products:full"], configuration)
localVarHeaderParameter['Content-Type'] = 'application/json';
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, };
localVarRequestOptions.data = serializeDataIfNeeded(ProductFieldAllOf, localVarRequestOptions, configuration)
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* Marks a product field as deleted. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/deleting-a-custom-field\" target=\"_blank\" rel=\"noopener noreferrer\">deleting a custom field</a>.
* @summary Delete a product field
* @param {number} id The ID of the product field
* @throws {RequiredError}
*/
deleteProductField: async (id: number, ): Promise<RequestArgs> => {
// verify required parameter 'id' is not null or undefined
assertParamExists('deleteProductField', 'id', id)
const localVarPath = `/productFields/{id}`
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'DELETE', ...baseOptions };
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
// authentication api_key required
await setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration)
// authentication oauth2 required
// oauth required
await setOAuthToObject(localVarHeaderParameter, "oauth2", ["product-fields:full", "products:full"], configuration)
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, };
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* Marks multiple fields as deleted.
* @summary Delete multiple product fields in bulk
* @param {string} ids The comma-separated field IDs to delete
* @throws {RequiredError}
*/
deleteProductFields: async (ids: string, ): Promise<RequestArgs> => {
// verify required parameter 'ids' is not null or undefined
assertParamExists('deleteProductFields', 'ids', ids)
const localVarPath = `/productFields`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'DELETE', ...baseOptions };
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
// authentication api_key required
await setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration)
// authentication oauth2 required
// oauth required
await setOAuthToObject(localVarHeaderParameter, "oauth2", ["product-fields:full", "products:full"], configuration)
if (ids !== undefined) {
localVarQueryParameter['ids'] = ids;
}
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, };
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* Returns data about a specific product field.
* @summary Get one product field
* @param {number} id The ID of the product field
* @throws {RequiredError}
*/
getProductField: async (id: number, ): Promise<RequestArgs> => {
// verify required parameter 'id' is not null or undefined
assertParamExists('getProductField', 'id', id)
const localVarPath = `/productFields/{id}`
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'GET', ...baseOptions };
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
// authentication api_key required
await setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration)
// authentication oauth2 required
// oauth required
await setOAuthToObject(localVarHeaderParameter, "oauth2", ["products:read", "product-fields:full", "products:full"], configuration)
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, };
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* Returns data about all product fields.
* @summary Get all product fields
* @param {number} [start] Pagination start
* @param {number} [limit] Items shown per page
* @throws {RequiredError}
*/
getProductFields: async (start?: number, limit?: number, ): Promise<RequestArgs> => {
const localVarPath = `/productFields`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'GET', ...baseOptions };
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
// authentication api_key required
await setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration)
// authentication oauth2 required
// oauth required
await setOAuthToObject(localVarHeaderParameter, "oauth2", ["products:read", "product-fields:full", "products:full"], configuration)
if (start !== undefined) {
localVarQueryParameter['start'] = start;
}
if (limit !== undefined) {
localVarQueryParameter['limit'] = limit;
}
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, };
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* Updates a product field. For more information, see the tutorial for <a href=\" https://pipedrive.readme.io/docs/updating-custom-field-value \" target=\"_blank\" rel=\"noopener noreferrer\">updating custom fields\' values</a>.
* @summary Update a product field
* @param {number} id The ID of the product field
* @param {UpdateProductFieldResponse} [UpdateProductFieldResponse]
* @throws {RequiredError}
*/
updateProductField: async (id: number, UpdateProductFieldResponse?: UpdateProductFieldResponse, ): Promise<RequestArgs> => {
// verify required parameter 'id' is not null or undefined
assertParamExists('updateProductField', 'id', id)
const localVarPath = `/productFields/{id}`
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'PUT', ...baseOptions };
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
// authentication api_key required
await setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration)
// authentication oauth2 required
// oauth required
await setOAuthToObject(localVarHeaderParameter, "oauth2", ["product-fields:full", "products:full"], configuration)
localVarHeaderParameter['Content-Type'] = 'application/json';
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, };
localVarRequestOptions.data = serializeDataIfNeeded(UpdateProductFieldResponse, localVarRequestOptions, configuration)
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
}
};
/**
* ProductFieldsApi - functional programming interface
* @export
*/
export const ProductFieldsApiFp = function(configuration?: Configuration) {
const localVarAxiosParamCreator = ProductFieldsApiAxiosParamCreator(configuration)
return {
/**
* Adds a new product field. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-new-custom-field\" target=\"_blank\" rel=\"noopener noreferrer\">adding a new custom field</a>.
* @summary Add a new product field
* @param {ProductFieldAllOf} [ProductFieldAllOf]
* @throws {RequiredError}
*/
async addProductField(ProductFieldAllOf?: ProductFieldAllOf, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetProductFieldResponse>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.addProductField(ProductFieldAllOf, );
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
},
/**
* Marks a product field as deleted. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/deleting-a-custom-field\" target=\"_blank\" rel=\"noopener noreferrer\">deleting a custom field</a>.
* @summary Delete a product field
* @param {number} id The ID of the product field
* @throws {RequiredError}
*/
async deleteProductField(id: number, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteProductFieldResponse>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteProductField(id, );
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
},
/**
* Marks multiple fields as deleted.
* @summary Delete multiple product fields in bulk
* @param {string} ids The comma-separated field IDs to delete
* @throws {RequiredError}
*/
async deleteProductFields(ids: string, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteProductFieldsResponse>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteProductFields(ids, );
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
},
/**
* Returns data about a specific product field.
* @summary Get one product field
* @param {number} id The ID of the product field
* @throws {RequiredError}
*/
async getProductField(id: number, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetProductFieldResponse>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.getProductField(id, );
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
},
/**
* Returns data about all product fields.
* @summary Get all product fields
* @param {number} [start] Pagination start
* @param {number} [limit] Items shown per page
* @throws {RequiredError}
*/
async getProductFields(start?: number, limit?: number, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetProductFieldsResponse>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.getProductFields(start, limit, );
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
},
/**
* Updates a product field. For more information, see the tutorial for <a href=\" https://pipedrive.readme.io/docs/updating-custom-field-value \" target=\"_blank\" rel=\"noopener noreferrer\">updating custom fields\' values</a>.
* @summary Update a product field
* @param {number} id The ID of the product field
* @param {UpdateProductFieldResponse} [UpdateProductFieldResponse]
* @throws {RequiredError}
*/
async updateProductField(id: number, UpdateProductFieldResponse?: UpdateProductFieldResponse, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetProductFieldResponse>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.updateProductField(id, UpdateProductFieldResponse, );
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
},
}
};
/**
* ProductFieldsApi - factory interface
* @export
*/
export const ProductFieldsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
const localVarFp = ProductFieldsApiFp(configuration)
return {
/**
* Adds a new product field. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-new-custom-field\" target=\"_blank\" rel=\"noopener noreferrer\">adding a new custom field</a>.
* @summary Add a new product field
* @param {ProductFieldsApiAddProductFieldRequest} requestParameters Request parameters.
* @throws {RequiredError}
*/
addProductField(requestParameters: ProductFieldsApiAddProductFieldRequest = {}, ): Promise<GetProductFieldResponse> {
return localVarFp.addProductField(requestParameters.ProductFieldAllOf, ).then((request) => request(axios, basePath));
},
/**
* Marks a product field as deleted. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/deleting-a-custom-field\" target=\"_blank\" rel=\"noopener noreferrer\">deleting a custom field</a>.
* @summary Delete a product field
* @param {ProductFieldsApiDeleteProductFieldRequest} requestParameters Request parameters.
* @throws {RequiredError}
*/
deleteProductField(requestParameters: ProductFieldsApiDeleteProductFieldRequest, ): Promise<DeleteProductFieldResponse> {
return localVarFp.deleteProductField(requestParameters.id, ).then((request) => request(axios, basePath));
},
/**
* Marks multiple fields as deleted.
* @summary Delete multiple product fields in bulk
* @param {ProductFieldsApiDeleteProductFieldsRequest} requestParameters Request parameters.
* @throws {RequiredError}
*/
deleteProductFields(requestParameters: ProductFieldsApiDeleteProductFieldsRequest, ): Promise<DeleteProductFieldsResponse> {
return localVarFp.deleteProductFields(requestParameters.ids, ).then((request) => request(axios, basePath));
},
/**
* Returns data about a specific product field.
* @summary Get one product field
* @param {ProductFieldsApiGetProductFieldRequest} requestParameters Request parameters.
* @throws {RequiredError}
*/
getProductField(requestParameters: ProductFieldsApiGetProductFieldRequest, ): Promise<GetProductFieldResponse> {
return localVarFp.getProductField(requestParameters.id, ).then((request) => request(axios, basePath));
},
/**
* Returns data about all product fields.
* @summary Get all product fields
* @param {ProductFieldsApiGetProductFieldsRequest} requestParameters Request parameters.
* @throws {RequiredError}
*/
getProductFields(requestParameters: ProductFieldsApiGetProductFieldsRequest = {}, ): Promise<GetProductFieldsResponse> {
return localVarFp.getProductFields(requestParameters.start, requestParameters.limit, ).then((request) => request(axios, basePath));
},
/**
* Updates a product field. For more information, see the tutorial for <a href=\" https://pipedrive.readme.io/docs/updating-custom-field-value \" target=\"_blank\" rel=\"noopener noreferrer\">updating custom fields\' values</a>.
* @summary Update a product field
* @param {ProductFieldsApiUpdateProductFieldRequest} requestParameters Request parameters.
* @throws {RequiredError}
*/
updateProductField(requestParameters: ProductFieldsApiUpdateProductFieldRequest, ): Promise<GetProductFieldResponse> {
return localVarFp.updateProductField(requestParameters.id, requestParameters.UpdateProductFieldResponse, ).then((request) => request(axios, basePath));
},
};
};
/**
* Request parameters for addProductField operation in ProductFieldsApi.
* @export
* @interface ProductFieldsApiAddProductFieldRequest
*/
export interface ProductFieldsApiAddProductFieldRequest {
/**
*
* @type {ProductFieldAllOf}
* @memberof ProductFieldsApiAddProductField
*/
readonly ProductFieldAllOf?: ProductFieldAllOf
}
/**
* Request parameters for deleteProductField operation in ProductFieldsApi.
* @export
* @interface ProductFieldsApiDeleteProductFieldRequest
*/
export interface ProductFieldsApiDeleteProductFieldRequest {
/**
* The ID of the product field
* @type {number}
* @memberof ProductFieldsApiDeleteProductField
*/
readonly id: number
}
/**
* Request parameters for deleteProductFields operation in ProductFieldsApi.
* @export
* @interface ProductFieldsApiDeleteProductFieldsRequest
*/
export interface ProductFieldsApiDeleteProductFieldsRequest {
/**
* The comma-separated field IDs to delete
* @type {string}
* @memberof ProductFieldsApiDeleteProductFields
*/
readonly ids: string
}
/**
* Request parameters for getProductField operation in ProductFieldsApi.
* @export
* @interface ProductFieldsApiGetProductFieldRequest
*/
export interface ProductFieldsApiGetProductFieldRequest {
/**
* The ID of the product field
* @type {number}
* @memberof ProductFieldsApiGetProductField
*/
readonly id: number
}
/**
* Request parameters for getProductFields operation in ProductFieldsApi.
* @export
* @interface ProductFieldsApiGetProductFieldsRequest
*/
export interface ProductFieldsApiGetProductFieldsRequest {
/**
* Pagination start
* @type {number}
* @memberof ProductFieldsApiGetProductFields
*/
readonly start?: number
/**
* Items shown per page
* @type {number}
* @memberof ProductFieldsApiGetProductFields
*/
readonly limit?: number
}
/**
* Request parameters for updateProductField operation in ProductFieldsApi.
* @export
* @interface ProductFieldsApiUpdateProductFieldRequest
*/
export interface ProductFieldsApiUpdateProductFieldRequest {
/**
* The ID of the product field
* @type {number}
* @memberof ProductFieldsApiUpdateProductField
*/
readonly id: number
/**
*
* @type {UpdateProductFieldResponse}
* @memberof ProductFieldsApiUpdateProductField
*/
readonly UpdateProductFieldResponse?: UpdateProductFieldResponse
}
/**
* ProductFieldsApi - object-oriented interface
* @export
* @class ProductFieldsApi
* @extends {BaseAPI}
*/
export class ProductFieldsApi extends BaseAPI {
/**
* Adds a new product field. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-new-custom-field\" target=\"_blank\" rel=\"noopener noreferrer\">adding a new custom field</a>.
* @summary Add a new product field
* @param {ProductFieldsApiAddProductFieldRequest} requestParameters Request parameters.
* @throws {RequiredError}
* @memberof ProductFieldsApi
*/
public addProductField(requestParameters: ProductFieldsApiAddProductFieldRequest = {}, ) {
return ProductFieldsApiFp(this.configuration).addProductField(requestParameters.ProductFieldAllOf, ).then((request) => request(this.axios, this.basePath));
}
/**
* Marks a product field as deleted. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/deleting-a-custom-field\" target=\"_blank\" rel=\"noopener noreferrer\">deleting a custom field</a>.
* @summary Delete a product field
* @param {ProductFieldsApiDeleteProductFieldRequest} requestParameters Request parameters.
* @throws {RequiredError}
* @memberof ProductFieldsApi
*/
public deleteProductField(requestParameters: ProductFieldsApiDeleteProductFieldRequest, ) {
return ProductFieldsApiFp(this.configuration).deleteProductField(requestParameters.id, ).then((request) => request(this.axios, this.basePath));
}
/**
* Marks multiple fields as deleted.
* @summary Delete multiple product fields in bulk
* @param {ProductFieldsApiDeleteProductFieldsRequest} requestParameters Request parameters.
* @throws {RequiredError}
* @memberof ProductFieldsApi
*/
public deleteProductFields(requestParameters: ProductFieldsApiDeleteProductFieldsRequest, ) {
return ProductFieldsApiFp(this.configuration).deleteProductFields(requestParameters.ids, ).then((request) => request(this.axios, this.basePath));
}
/**
* Returns data about a specific product field.
* @summary Get one product field
* @param {ProductFieldsApiGetProductFieldRequest} requestParameters Request parameters.
* @throws {RequiredError}
* @memberof ProductFieldsApi
*/
public getProductField(requestParameters: ProductFieldsApiGetProductFieldRequest, ) {
return ProductFieldsApiFp(this.configuration).getProductField(requestParameters.id, ).then((request) => request(this.axios, this.basePath));
}
/**
* Returns data about all product fields.
* @summary Get all product fields
* @param {ProductFieldsApiGetProductFieldsRequest} requestParameters Request parameters.
* @throws {RequiredError}
* @memberof ProductFieldsApi
*/
public getProductFields(requestParameters: ProductFieldsApiGetProductFieldsRequest = {}, ) {
return ProductFieldsApiFp(this.configuration).getProductFields(requestParameters.start, requestParameters.limit, ).then((request) => request(this.axios, this.basePath));
}
/**
* Updates a product field. For more information, see the tutorial for <a href=\" https://pipedrive.readme.io/docs/updating-custom-field-value \" target=\"_blank\" rel=\"noopener noreferrer\">updating custom fields\' values</a>.
* @summary Update a product field
* @param {ProductFieldsApiUpdateProductFieldRequest} requestParameters Request parameters.
* @throws {RequiredError}
* @memberof ProductFieldsApi
*/
public updateProductField(requestParameters: ProductFieldsApiUpdateProductFieldRequest, ) {
return ProductFieldsApiFp(this.configuration).updateProductField(requestParameters.id, requestParameters.UpdateProductFieldResponse, ).then((request) => request(this.axios, this.basePath));
}
}