pipedrive 29.0.0 → 29.2.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/models/add-deal-product-request-all-of.d.ts +1 -1
- package/dist/esm/versions/v1/models/add-deal-product-request-all-of1.d.ts +1 -1
- package/dist/esm/versions/v1/models/add-deal-product-request-all-of2.d.ts +1 -1
- package/dist/esm/versions/v1/models/add-or-update-role-setting-request.d.ts +1 -1
- package/dist/esm/versions/v1/models/add-product-request-all-of1.d.ts +1 -1
- package/dist/esm/versions/v1/models/add-product-request-all-of2.d.ts +1 -1
- package/dist/esm/versions/v1/models/add-webhook-request.d.ts +7 -2
- package/dist/esm/versions/v1/models/base-deal.d.ts +6 -6
- package/dist/esm/versions/v1/models/base-product.d.ts +2 -2
- package/dist/esm/versions/v1/models/base-webhook.d.ts +10 -5
- package/dist/esm/versions/v1/models/update-deal-product-request-all-of.d.ts +1 -1
- package/dist/esm/versions/v1/models/update-product-request-all-of1.d.ts +1 -1
- package/dist/esm/versions/v2/api/beta-api.d.ts +220 -16
- package/dist/esm/versions/v2/api/beta-api.js +308 -16
- package/dist/esm/versions/v2/api/deals-api.d.ts +16 -16
- package/dist/esm/versions/v2/api/deals-api.js +16 -16
- package/dist/esm/versions/v2/api/products-api.d.ts +204 -0
- package/dist/esm/versions/v2/api/products-api.js +292 -0
- package/dist/esm/versions/v2/models/add-product-image-response.d.ts +29 -0
- package/dist/esm/versions/v2/models/add-product-image-response.js +14 -0
- package/dist/esm/versions/v2/models/base-product-all-of1.d.ts +1 -1
- package/dist/esm/versions/v2/models/deal-item.d.ts +3 -3
- package/dist/esm/versions/v2/models/deal-item1.d.ts +3 -3
- package/dist/esm/versions/v2/models/delete-product-image-response-data.d.ts +23 -0
- package/dist/esm/versions/v2/models/delete-product-image-response-data.js +14 -0
- package/dist/esm/versions/v2/models/delete-product-image-response.d.ts +29 -0
- package/dist/esm/versions/v2/models/delete-product-image-response.js +14 -0
- package/dist/esm/versions/v2/models/get-deals-products-response-data-inner-all-of1.d.ts +1 -1
- package/dist/esm/versions/v2/models/get-deals-products-response-data-inner-all-of2.d.ts +1 -1
- package/dist/esm/versions/v2/models/get-deals-products-response-data-inner-all-of3.d.ts +1 -1
- package/dist/esm/versions/v2/models/get-product-image-response-data.d.ts +53 -0
- package/dist/esm/versions/v2/models/get-product-image-response-data.js +14 -0
- package/dist/esm/versions/v2/models/get-product-image-response.d.ts +29 -0
- package/dist/esm/versions/v2/models/get-product-image-response.js +14 -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-deal-product-request-all-of.d.ts +1 -1
- package/dist/esm/versions/v2/models/update-product-image-response-data.d.ts +38 -0
- package/dist/esm/versions/v2/models/update-product-image-response-data.js +14 -0
- package/dist/esm/versions/v2/models/update-product-image-response.d.ts +29 -0
- package/dist/esm/versions/v2/models/update-product-image-response.js +14 -0
- package/dist/esm/versions/v2/models/update-product-request-all-of1.d.ts +1 -1
- package/dist/versions/v1/models/add-deal-product-request-all-of.d.ts +1 -1
- package/dist/versions/v1/models/add-deal-product-request-all-of1.d.ts +1 -1
- package/dist/versions/v1/models/add-deal-product-request-all-of2.d.ts +1 -1
- package/dist/versions/v1/models/add-or-update-role-setting-request.d.ts +1 -1
- package/dist/versions/v1/models/add-product-request-all-of1.d.ts +1 -1
- package/dist/versions/v1/models/add-product-request-all-of2.d.ts +1 -1
- package/dist/versions/v1/models/add-webhook-request.d.ts +7 -2
- package/dist/versions/v1/models/base-deal.d.ts +6 -6
- package/dist/versions/v1/models/base-product.d.ts +2 -2
- package/dist/versions/v1/models/base-webhook.d.ts +10 -5
- package/dist/versions/v1/models/update-deal-product-request-all-of.d.ts +1 -1
- package/dist/versions/v1/models/update-product-request-all-of1.d.ts +1 -1
- package/dist/versions/v2/api/beta-api.d.ts +220 -16
- package/dist/versions/v2/api/beta-api.js +308 -16
- package/dist/versions/v2/api/deals-api.d.ts +16 -16
- package/dist/versions/v2/api/deals-api.js +16 -16
- package/dist/versions/v2/api/products-api.d.ts +204 -0
- package/dist/versions/v2/api/products-api.js +292 -0
- package/dist/versions/v2/models/add-product-image-response.d.ts +29 -0
- package/dist/versions/v2/models/add-product-image-response.js +15 -0
- package/dist/versions/v2/models/base-product-all-of1.d.ts +1 -1
- package/dist/versions/v2/models/deal-item.d.ts +3 -3
- package/dist/versions/v2/models/deal-item1.d.ts +3 -3
- package/dist/versions/v2/models/delete-product-image-response-data.d.ts +23 -0
- package/dist/versions/v2/models/delete-product-image-response-data.js +15 -0
- package/dist/versions/v2/models/delete-product-image-response.d.ts +29 -0
- package/dist/versions/v2/models/delete-product-image-response.js +15 -0
- package/dist/versions/v2/models/get-deals-products-response-data-inner-all-of1.d.ts +1 -1
- package/dist/versions/v2/models/get-deals-products-response-data-inner-all-of2.d.ts +1 -1
- package/dist/versions/v2/models/get-deals-products-response-data-inner-all-of3.d.ts +1 -1
- package/dist/versions/v2/models/get-product-image-response-data.d.ts +53 -0
- package/dist/versions/v2/models/get-product-image-response-data.js +15 -0
- package/dist/versions/v2/models/get-product-image-response.d.ts +29 -0
- package/dist/versions/v2/models/get-product-image-response.js +15 -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-deal-product-request-all-of.d.ts +1 -1
- package/dist/versions/v2/models/update-product-image-response-data.d.ts +38 -0
- package/dist/versions/v2/models/update-product-image-response-data.js +15 -0
- package/dist/versions/v2/models/update-product-image-response.d.ts +29 -0
- package/dist/versions/v2/models/update-product-image-response.js +15 -0
- package/dist/versions/v2/models/update-product-request-all-of1.d.ts +1 -1
- package/package.json +1 -1
@@ -16,7 +16,7 @@
|
|
16
16
|
*/
|
17
17
|
export interface AddDealProductRequestAllOf {
|
18
18
|
/**
|
19
|
-
* Only available in
|
19
|
+
* Only available in Growth and above plans How often a customer is billed for access to a service or product To set `billing_frequency` different than `one-time`, the deal must not have installments associated A deal can have up to 20 products attached with `billing_frequency` different than `one-time`
|
20
20
|
* @type {string}
|
21
21
|
*/
|
22
22
|
'billing_frequency'?: AddDealProductRequestAllOfBillingFrequencyConst;
|
@@ -16,7 +16,7 @@
|
|
16
16
|
*/
|
17
17
|
export interface AddDealProductRequestAllOf1 {
|
18
18
|
/**
|
19
|
-
* Only available in
|
19
|
+
* Only available in Growth and above plans The number of times the billing frequency repeats for a product in a deal When `billing_frequency` is set to `one-time`, this field must be `null` When `billing_frequency` is set to `weekly`, this field cannot be `null` For all the other values of `billing_frequency`, `null` represents a product billed indefinitely Must be a positive integer less or equal to 208
|
20
20
|
* @type {number}
|
21
21
|
*/
|
22
22
|
'billing_frequency_cycles'?: number | null;
|
@@ -16,7 +16,7 @@
|
|
16
16
|
*/
|
17
17
|
export interface AddDealProductRequestAllOf2 {
|
18
18
|
/**
|
19
|
-
* Only available in
|
19
|
+
* Only available in Growth and above plans The billing start date. Must be between 10 years in the past and 10 years in the future
|
20
20
|
* @type {string}
|
21
21
|
*/
|
22
22
|
'billing_start_date'?: string | null;
|
@@ -21,7 +21,7 @@ export interface AddOrUpdateRoleSettingRequest {
|
|
21
21
|
*/
|
22
22
|
'setting_key': AddOrUpdateRoleSettingRequestSettingKeyConst;
|
23
23
|
/**
|
24
|
-
* Possible values for the `default_visibility` setting depending on the subscription plan:<br> <table class=\'role-setting\'> <caption><b>
|
24
|
+
* Possible values for the `default_visibility` setting depending on the subscription plan:<br> <table class=\'role-setting\'> <caption><b>Light / Growth and Professional plans</b></caption> <tr><th><b>Value</b></th><th><b>Description</b></th></tr> <tr><td>`1`</td><td>Owner & Followers</td></tr> <tr><td>`3`</td><td>Entire company</td></tr> </table> <br> <table class=\'role-setting\'> <caption><b>Premium / Ultimate plan</b></caption> <tr><th><b>Value</b></th><th><b>Description</b></th></tr> <tr><td>`1`</td><td>Owner only</td></tr> <tr><td>`3`</td><td>Owner's visibility group</td></tr> <tr><td>`5`</td><td>Owner's visibility group and sub-groups</td></tr> <tr><td>`7`</td><td>Entire company</td></tr> </table> <br> Read more about visibility groups <a href=\'https://support.pipedrive.com/en/article/visibility-groups\'>here</a>.
|
25
25
|
* @type {number}
|
26
26
|
*/
|
27
27
|
'value': AddOrUpdateRoleSettingRequestValueConst;
|
@@ -16,7 +16,7 @@
|
|
16
16
|
*/
|
17
17
|
export interface AddProductRequestAllOf1 {
|
18
18
|
/**
|
19
|
-
* Only available in
|
19
|
+
* Only available in Growth and above plans How often a customer is billed for access to a service or product
|
20
20
|
* @type {string}
|
21
21
|
*/
|
22
22
|
'billing_frequency'?: AddProductRequestAllOf1BillingFrequencyConst;
|
@@ -16,7 +16,7 @@
|
|
16
16
|
*/
|
17
17
|
export interface AddProductRequestAllOf2 {
|
18
18
|
/**
|
19
|
-
* Only available in
|
19
|
+
* Only available in Growth and above plans The number of times the billing frequency repeats for a product in a deal When `billing_frequency` is set to `one-time`, this field must be `null` For all the other values of `billing_frequency`, `null` represents a product billed indefinitely Must be a positive integer less or equal to 208
|
20
20
|
* @type {number}
|
21
21
|
*/
|
22
22
|
'billing_frequency_cycles'?: number | null;
|
@@ -31,6 +31,11 @@ export interface AddWebhookRequest {
|
|
31
31
|
*/
|
32
32
|
'event_object': AddWebhookRequestEventObjectConst;
|
33
33
|
/**
|
34
|
+
* The webhook\'s name
|
35
|
+
* @type {string}
|
36
|
+
*/
|
37
|
+
'name': string;
|
38
|
+
/**
|
34
39
|
* The ID of the user that this webhook will be authorized with. You have the option to use a different user\'s `user_id`. If it is not set, the current user\'s `user_id` will be used. As each webhook event is checked against a user\'s permissions, the webhook will only be sent if the user has access to the specified object(s). If you want to receive notifications for all events, please use a top-level admin user’s `user_id`.
|
35
40
|
* @type {number}
|
36
41
|
*/
|
@@ -39,12 +44,12 @@ export interface AddWebhookRequest {
|
|
39
44
|
* The HTTP basic auth username of the subscription URL endpoint (if required)
|
40
45
|
* @type {string}
|
41
46
|
*/
|
42
|
-
'http_auth_user'?: string;
|
47
|
+
'http_auth_user'?: string | null;
|
43
48
|
/**
|
44
49
|
* The HTTP basic auth password of the subscription URL endpoint (if required)
|
45
50
|
* @type {string}
|
46
51
|
*/
|
47
|
-
'http_auth_password'?: string;
|
52
|
+
'http_auth_password'?: string | null;
|
48
53
|
/**
|
49
54
|
* The webhook\'s version. NB! Webhooks v2 is the default from March 17th, 2025. See <a href=\"https://developers.pipedrive.com/changelog/post/breaking-change-webhooks-v2-will-become-the-new-default-version\" target=\"_blank\" rel=\"noopener noreferrer\">this Changelog post</a> for more details.
|
50
55
|
* @type {string}
|
@@ -301,32 +301,32 @@ export interface BaseDeal {
|
|
301
301
|
*/
|
302
302
|
'channel_id'?: string | null;
|
303
303
|
/**
|
304
|
-
* Only available in
|
304
|
+
* Only available in Growth and above plans The Annual Recurring Revenue of the deal Null if there are no products attached to the deal
|
305
305
|
* @type {number}
|
306
306
|
*/
|
307
307
|
'arr'?: number | null;
|
308
308
|
/**
|
309
|
-
* Only available in
|
309
|
+
* Only available in Growth and above plans The Monthly Recurring Revenue of the deal Null if there are no products attached to the deal
|
310
310
|
* @type {number}
|
311
311
|
*/
|
312
312
|
'mrr'?: number | null;
|
313
313
|
/**
|
314
|
-
* Only available in
|
314
|
+
* Only available in Growth and above plans The Annual Contract Value of the deal Null if there are no products attached to the deal
|
315
315
|
* @type {number}
|
316
316
|
*/
|
317
317
|
'acv'?: number | null;
|
318
318
|
/**
|
319
|
-
* Only available in
|
319
|
+
* Only available in Growth and above plans The Currency for Annual Recurring Revenue of the deal If the `arr` is null, this will also be null
|
320
320
|
* @type {string}
|
321
321
|
*/
|
322
322
|
'arr_currency'?: string | null;
|
323
323
|
/**
|
324
|
-
* Only available in
|
324
|
+
* Only available in Growth and above plans The Currency for Monthly Recurring Revenue of the deal If the `mrr` is null, this will also be null
|
325
325
|
* @type {string}
|
326
326
|
*/
|
327
327
|
'mrr_currency'?: string | null;
|
328
328
|
/**
|
329
|
-
* Only available in
|
329
|
+
* Only available in Growth and above plans The Currency for Annual Contract Value of the deal If the `acv` is null, this will also be null
|
330
330
|
* @type {string}
|
331
331
|
*/
|
332
332
|
'acv_currency'?: string | null;
|
@@ -61,12 +61,12 @@ export interface BaseProduct {
|
|
61
61
|
*/
|
62
62
|
'owner_id'?: object;
|
63
63
|
/**
|
64
|
-
* Only available in
|
64
|
+
* Only available in Growth and above plans How often a customer is billed for access to a service or product
|
65
65
|
* @type {string}
|
66
66
|
*/
|
67
67
|
'billing_frequency'?: BaseProductBillingFrequencyConst;
|
68
68
|
/**
|
69
|
-
* Only available in
|
69
|
+
* Only available in Growth and above plans The number of times the billing frequency repeats for a product in a deal When `billing_frequency` is set to `one-time`, this field is always `null` When `billing_frequency` is set to `weekly`, this field cannot be `null` For all the other values of `billing_frequency`, `null` represents a product billed indefinitely Must be a positive integer less or equal to 208
|
70
70
|
* @type {number}
|
71
71
|
*/
|
72
72
|
'billing_frequency_cycles'?: number | null;
|
@@ -51,6 +51,11 @@ export interface BaseWebhook {
|
|
51
51
|
*/
|
52
52
|
'subscription_url'?: string;
|
53
53
|
/**
|
54
|
+
* The Webhook version
|
55
|
+
* @type {string}
|
56
|
+
*/
|
57
|
+
'version'?: string;
|
58
|
+
/**
|
54
59
|
*
|
55
60
|
* @type {number}
|
56
61
|
*/
|
@@ -81,11 +86,6 @@ export interface BaseWebhook {
|
|
81
86
|
*/
|
82
87
|
'http_auth_password'?: string | null;
|
83
88
|
/**
|
84
|
-
* Any additional data related to the Webhook
|
85
|
-
* @type {object}
|
86
|
-
*/
|
87
|
-
'additional_data'?: object;
|
88
|
-
/**
|
89
89
|
* The removal reason of the Webhook (if removed)
|
90
90
|
* @type {string}
|
91
91
|
*/
|
@@ -105,6 +105,11 @@ export interface BaseWebhook {
|
|
105
105
|
* @type {number}
|
106
106
|
*/
|
107
107
|
'admin_id'?: number;
|
108
|
+
/**
|
109
|
+
* The Webhook name
|
110
|
+
* @type {string}
|
111
|
+
*/
|
112
|
+
'name'?: string;
|
108
113
|
}
|
109
114
|
export declare const BaseWebhookIsActiveConst: {
|
110
115
|
readonly NUMBER_0: 0;
|
@@ -16,7 +16,7 @@
|
|
16
16
|
*/
|
17
17
|
export interface UpdateDealProductRequestAllOf {
|
18
18
|
/**
|
19
|
-
* Only available in
|
19
|
+
* Only available in Growth and above plans How often a customer is billed for access to a service or product To set `billing_frequency` different than `one-time`, the deal must not have installments associated A deal can have up to 20 products attached with `billing_frequency` different than `one-time`
|
20
20
|
* @type {string}
|
21
21
|
*/
|
22
22
|
'billing_frequency'?: UpdateDealProductRequestAllOfBillingFrequencyConst;
|
@@ -16,7 +16,7 @@
|
|
16
16
|
*/
|
17
17
|
export interface UpdateProductRequestAllOf1 {
|
18
18
|
/**
|
19
|
-
* Only available in
|
19
|
+
* Only available in Growth and above plans How often a customer is billed for access to a service or product
|
20
20
|
* @type {string}
|
21
21
|
*/
|
22
22
|
'billing_frequency'?: UpdateProductRequestAllOf1BillingFrequencyConst;
|
@@ -16,12 +16,16 @@ import { AddAInstallmentResponse } from '../models';
|
|
16
16
|
import { AddConvertDealToLeadResponse } from '../models';
|
17
17
|
import { AddConvertLeadToDealResponse } from '../models';
|
18
18
|
import { AddInstallmentRequestBody } from '../models';
|
19
|
+
import { AddProductImageResponse } from '../models';
|
19
20
|
import { ConvertLeadToDealRequest } from '../models';
|
20
21
|
import { DeleteInstallmentResponse } from '../models';
|
22
|
+
import { DeleteProductImageResponse } from '../models';
|
21
23
|
import { GetConvertResponse1 } from '../models';
|
22
24
|
import { GetInstallmentsResponse } from '../models';
|
25
|
+
import { GetProductImageResponse } from '../models';
|
23
26
|
import { UpdateInstallmentRequestBody } from '../models';
|
24
27
|
import { UpdateInstallmentResponse } from '../models';
|
28
|
+
import { UpdateProductImageResponse } from '../models';
|
25
29
|
/**
|
26
30
|
* BetaApi - axios parameter creator
|
27
31
|
* @export
|
@@ -45,7 +49,7 @@ export declare const BetaApiAxiosParamCreator: (configuration?: Configuration) =
|
|
45
49
|
*/
|
46
50
|
convertLeadToDeal: (id: string, ConvertLeadToDealRequest?: ConvertLeadToDealRequest) => Promise<RequestArgs>;
|
47
51
|
/**
|
48
|
-
* Removes an installment from a deal. Only available in
|
52
|
+
* Removes an installment from a deal. Only available in Growth and above plans.
|
49
53
|
* @summary Delete an installment from a deal
|
50
54
|
* @param {number} id The ID of the deal
|
51
55
|
* @param {number} installment_id The ID of the installment
|
@@ -53,6 +57,14 @@ export declare const BetaApiAxiosParamCreator: (configuration?: Configuration) =
|
|
53
57
|
* @throws {RequiredError}
|
54
58
|
*/
|
55
59
|
deleteInstallment: (id: number, installment_id: number) => Promise<RequestArgs>;
|
60
|
+
/**
|
61
|
+
* Deletes the image of a product.
|
62
|
+
* @summary Delete an image of a product
|
63
|
+
* @param {number} id The ID of the product
|
64
|
+
|
65
|
+
* @throws {RequiredError}
|
66
|
+
*/
|
67
|
+
deleteProductImage: (id: number) => Promise<RequestArgs>;
|
56
68
|
/**
|
57
69
|
* Returns information about the conversion. Status is always present and its value (not_started, running, completed, failed, rejected) represents the current state of the conversion. Lead ID is only present if the conversion was successfully finished. This data is only temporary and removed after a few days.
|
58
70
|
* @summary Get Deal conversion status (BETA)
|
@@ -63,7 +75,7 @@ export declare const BetaApiAxiosParamCreator: (configuration?: Configuration) =
|
|
63
75
|
*/
|
64
76
|
getDealConversionStatus: (id: number, conversion_id: string) => Promise<RequestArgs>;
|
65
77
|
/**
|
66
|
-
* Lists installments attached to a list of deals. Only available in
|
78
|
+
* Lists installments attached to a list of deals. Only available in Growth and above plans.
|
67
79
|
* @summary List installments added to a list of deals
|
68
80
|
* @param {Array<number>} deal_ids An array of integers with the IDs of the deals for which the attached installments will be returned. A maximum of 100 deal IDs can be provided.
|
69
81
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
@@ -84,7 +96,15 @@ export declare const BetaApiAxiosParamCreator: (configuration?: Configuration) =
|
|
84
96
|
*/
|
85
97
|
getLeadConversionStatus: (id: string, conversion_id: string) => Promise<RequestArgs>;
|
86
98
|
/**
|
87
|
-
*
|
99
|
+
* Retrieves the image of a product. The public URL has a limited lifetime of 7 days.
|
100
|
+
* @summary Get image of a product
|
101
|
+
* @param {number} id The ID of the product
|
102
|
+
|
103
|
+
* @throws {RequiredError}
|
104
|
+
*/
|
105
|
+
getProductImage: (id: number) => Promise<RequestArgs>;
|
106
|
+
/**
|
107
|
+
* Adds an installment to a deal. An installment can only be added if the deal includes at least one one-time product. If the deal contains at least one recurring product, adding installments is not allowed. Only available in Growth and above plans.
|
88
108
|
* @summary Add an installment to a deal
|
89
109
|
* @param {number} id The ID of the deal
|
90
110
|
* @param {AddInstallmentRequestBody} [AddInstallmentRequestBody]
|
@@ -93,7 +113,7 @@ export declare const BetaApiAxiosParamCreator: (configuration?: Configuration) =
|
|
93
113
|
*/
|
94
114
|
postInstallment: (id: number, AddInstallmentRequestBody?: AddInstallmentRequestBody) => Promise<RequestArgs>;
|
95
115
|
/**
|
96
|
-
* Edits an installment added to a deal. Only available in
|
116
|
+
* Edits an installment added to a deal. Only available in Growth and above plans.
|
97
117
|
* @summary Update an installment added to a deal
|
98
118
|
* @param {number} id The ID of the deal
|
99
119
|
* @param {number} installment_id The ID of the installment
|
@@ -102,6 +122,24 @@ export declare const BetaApiAxiosParamCreator: (configuration?: Configuration) =
|
|
102
122
|
* @throws {RequiredError}
|
103
123
|
*/
|
104
124
|
updateInstallment: (id: number, installment_id: number, UpdateInstallmentRequestBody?: UpdateInstallmentRequestBody) => Promise<RequestArgs>;
|
125
|
+
/**
|
126
|
+
* Updates the image of a product.
|
127
|
+
* @summary Update an image for a product
|
128
|
+
* @param {number} id The ID of the product
|
129
|
+
* @param {File} data One image supplied in the multipart/form-data encoding
|
130
|
+
|
131
|
+
* @throws {RequiredError}
|
132
|
+
*/
|
133
|
+
updateProductImage: (id: number, data: File) => Promise<RequestArgs>;
|
134
|
+
/**
|
135
|
+
* Uploads an image for a product.
|
136
|
+
* @summary Upload an image for a product
|
137
|
+
* @param {number} id The ID of the product
|
138
|
+
* @param {File} data One image supplied in the multipart/form-data encoding
|
139
|
+
|
140
|
+
* @throws {RequiredError}
|
141
|
+
*/
|
142
|
+
uploadProductImage: (id: number, data: File) => Promise<RequestArgs>;
|
105
143
|
};
|
106
144
|
/**
|
107
145
|
* BetaApi - functional programming interface
|
@@ -126,7 +164,7 @@ export declare const BetaApiFp: (configuration?: Configuration) => {
|
|
126
164
|
*/
|
127
165
|
convertLeadToDeal(id: string, ConvertLeadToDealRequest?: ConvertLeadToDealRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddConvertLeadToDealResponse>>;
|
128
166
|
/**
|
129
|
-
* Removes an installment from a deal. Only available in
|
167
|
+
* Removes an installment from a deal. Only available in Growth and above plans.
|
130
168
|
* @summary Delete an installment from a deal
|
131
169
|
* @param {number} id The ID of the deal
|
132
170
|
* @param {number} installment_id The ID of the installment
|
@@ -134,6 +172,14 @@ export declare const BetaApiFp: (configuration?: Configuration) => {
|
|
134
172
|
* @throws {RequiredError}
|
135
173
|
*/
|
136
174
|
deleteInstallment(id: number, installment_id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteInstallmentResponse>>;
|
175
|
+
/**
|
176
|
+
* Deletes the image of a product.
|
177
|
+
* @summary Delete an image of a product
|
178
|
+
* @param {number} id The ID of the product
|
179
|
+
|
180
|
+
* @throws {RequiredError}
|
181
|
+
*/
|
182
|
+
deleteProductImage(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteProductImageResponse>>;
|
137
183
|
/**
|
138
184
|
* Returns information about the conversion. Status is always present and its value (not_started, running, completed, failed, rejected) represents the current state of the conversion. Lead ID is only present if the conversion was successfully finished. This data is only temporary and removed after a few days.
|
139
185
|
* @summary Get Deal conversion status (BETA)
|
@@ -144,7 +190,7 @@ export declare const BetaApiFp: (configuration?: Configuration) => {
|
|
144
190
|
*/
|
145
191
|
getDealConversionStatus(id: number, conversion_id: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetConvertResponse1>>;
|
146
192
|
/**
|
147
|
-
* Lists installments attached to a list of deals. Only available in
|
193
|
+
* Lists installments attached to a list of deals. Only available in Growth and above plans.
|
148
194
|
* @summary List installments added to a list of deals
|
149
195
|
* @param {Array<number>} deal_ids An array of integers with the IDs of the deals for which the attached installments will be returned. A maximum of 100 deal IDs can be provided.
|
150
196
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
@@ -165,7 +211,15 @@ export declare const BetaApiFp: (configuration?: Configuration) => {
|
|
165
211
|
*/
|
166
212
|
getLeadConversionStatus(id: string, conversion_id: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetConvertResponse1>>;
|
167
213
|
/**
|
168
|
-
*
|
214
|
+
* Retrieves the image of a product. The public URL has a limited lifetime of 7 days.
|
215
|
+
* @summary Get image of a product
|
216
|
+
* @param {number} id The ID of the product
|
217
|
+
|
218
|
+
* @throws {RequiredError}
|
219
|
+
*/
|
220
|
+
getProductImage(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetProductImageResponse>>;
|
221
|
+
/**
|
222
|
+
* Adds an installment to a deal. An installment can only be added if the deal includes at least one one-time product. If the deal contains at least one recurring product, adding installments is not allowed. Only available in Growth and above plans.
|
169
223
|
* @summary Add an installment to a deal
|
170
224
|
* @param {number} id The ID of the deal
|
171
225
|
* @param {AddInstallmentRequestBody} [AddInstallmentRequestBody]
|
@@ -174,7 +228,7 @@ export declare const BetaApiFp: (configuration?: Configuration) => {
|
|
174
228
|
*/
|
175
229
|
postInstallment(id: number, AddInstallmentRequestBody?: AddInstallmentRequestBody): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddAInstallmentResponse>>;
|
176
230
|
/**
|
177
|
-
* Edits an installment added to a deal. Only available in
|
231
|
+
* Edits an installment added to a deal. Only available in Growth and above plans.
|
178
232
|
* @summary Update an installment added to a deal
|
179
233
|
* @param {number} id The ID of the deal
|
180
234
|
* @param {number} installment_id The ID of the installment
|
@@ -183,6 +237,24 @@ export declare const BetaApiFp: (configuration?: Configuration) => {
|
|
183
237
|
* @throws {RequiredError}
|
184
238
|
*/
|
185
239
|
updateInstallment(id: number, installment_id: number, UpdateInstallmentRequestBody?: UpdateInstallmentRequestBody): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpdateInstallmentResponse>>;
|
240
|
+
/**
|
241
|
+
* Updates the image of a product.
|
242
|
+
* @summary Update an image for a product
|
243
|
+
* @param {number} id The ID of the product
|
244
|
+
* @param {File} data One image supplied in the multipart/form-data encoding
|
245
|
+
|
246
|
+
* @throws {RequiredError}
|
247
|
+
*/
|
248
|
+
updateProductImage(id: number, data: File): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpdateProductImageResponse>>;
|
249
|
+
/**
|
250
|
+
* Uploads an image for a product.
|
251
|
+
* @summary Upload an image for a product
|
252
|
+
* @param {number} id The ID of the product
|
253
|
+
* @param {File} data One image supplied in the multipart/form-data encoding
|
254
|
+
|
255
|
+
* @throws {RequiredError}
|
256
|
+
*/
|
257
|
+
uploadProductImage(id: number, data: File): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddProductImageResponse>>;
|
186
258
|
};
|
187
259
|
/**
|
188
260
|
* BetaApi - factory interface
|
@@ -206,13 +278,21 @@ export declare const BetaApiFactory: (configuration?: Configuration, basePath?:
|
|
206
278
|
*/
|
207
279
|
convertLeadToDeal(requestParameters: BetaApiConvertLeadToDealRequest): Promise<AddConvertLeadToDealResponse>;
|
208
280
|
/**
|
209
|
-
* Removes an installment from a deal. Only available in
|
281
|
+
* Removes an installment from a deal. Only available in Growth and above plans.
|
210
282
|
* @summary Delete an installment from a deal
|
211
283
|
* @param {BetaApiDeleteInstallmentRequest} requestParameters Request parameters.
|
212
284
|
|
213
285
|
* @throws {RequiredError}
|
214
286
|
*/
|
215
287
|
deleteInstallment(requestParameters: BetaApiDeleteInstallmentRequest): Promise<DeleteInstallmentResponse>;
|
288
|
+
/**
|
289
|
+
* Deletes the image of a product.
|
290
|
+
* @summary Delete an image of a product
|
291
|
+
* @param {BetaApiDeleteProductImageRequest} requestParameters Request parameters.
|
292
|
+
|
293
|
+
* @throws {RequiredError}
|
294
|
+
*/
|
295
|
+
deleteProductImage(requestParameters: BetaApiDeleteProductImageRequest): Promise<DeleteProductImageResponse>;
|
216
296
|
/**
|
217
297
|
* Returns information about the conversion. Status is always present and its value (not_started, running, completed, failed, rejected) represents the current state of the conversion. Lead ID is only present if the conversion was successfully finished. This data is only temporary and removed after a few days.
|
218
298
|
* @summary Get Deal conversion status (BETA)
|
@@ -222,7 +302,7 @@ export declare const BetaApiFactory: (configuration?: Configuration, basePath?:
|
|
222
302
|
*/
|
223
303
|
getDealConversionStatus(requestParameters: BetaApiGetDealConversionStatusRequest): Promise<GetConvertResponse1>;
|
224
304
|
/**
|
225
|
-
* Lists installments attached to a list of deals. Only available in
|
305
|
+
* Lists installments attached to a list of deals. Only available in Growth and above plans.
|
226
306
|
* @summary List installments added to a list of deals
|
227
307
|
* @param {BetaApiGetInstallmentsRequest} requestParameters Request parameters.
|
228
308
|
|
@@ -238,7 +318,15 @@ export declare const BetaApiFactory: (configuration?: Configuration, basePath?:
|
|
238
318
|
*/
|
239
319
|
getLeadConversionStatus(requestParameters: BetaApiGetLeadConversionStatusRequest): Promise<GetConvertResponse1>;
|
240
320
|
/**
|
241
|
-
*
|
321
|
+
* Retrieves the image of a product. The public URL has a limited lifetime of 7 days.
|
322
|
+
* @summary Get image of a product
|
323
|
+
* @param {BetaApiGetProductImageRequest} requestParameters Request parameters.
|
324
|
+
|
325
|
+
* @throws {RequiredError}
|
326
|
+
*/
|
327
|
+
getProductImage(requestParameters: BetaApiGetProductImageRequest): Promise<GetProductImageResponse>;
|
328
|
+
/**
|
329
|
+
* Adds an installment to a deal. An installment can only be added if the deal includes at least one one-time product. If the deal contains at least one recurring product, adding installments is not allowed. Only available in Growth and above plans.
|
242
330
|
* @summary Add an installment to a deal
|
243
331
|
* @param {BetaApiPostInstallmentRequest} requestParameters Request parameters.
|
244
332
|
|
@@ -246,13 +334,29 @@ export declare const BetaApiFactory: (configuration?: Configuration, basePath?:
|
|
246
334
|
*/
|
247
335
|
postInstallment(requestParameters: BetaApiPostInstallmentRequest): Promise<AddAInstallmentResponse>;
|
248
336
|
/**
|
249
|
-
* Edits an installment added to a deal. Only available in
|
337
|
+
* Edits an installment added to a deal. Only available in Growth and above plans.
|
250
338
|
* @summary Update an installment added to a deal
|
251
339
|
* @param {BetaApiUpdateInstallmentRequest} requestParameters Request parameters.
|
252
340
|
|
253
341
|
* @throws {RequiredError}
|
254
342
|
*/
|
255
343
|
updateInstallment(requestParameters: BetaApiUpdateInstallmentRequest): Promise<UpdateInstallmentResponse>;
|
344
|
+
/**
|
345
|
+
* Updates the image of a product.
|
346
|
+
* @summary Update an image for a product
|
347
|
+
* @param {BetaApiUpdateProductImageRequest} requestParameters Request parameters.
|
348
|
+
|
349
|
+
* @throws {RequiredError}
|
350
|
+
*/
|
351
|
+
updateProductImage(requestParameters: BetaApiUpdateProductImageRequest): Promise<UpdateProductImageResponse>;
|
352
|
+
/**
|
353
|
+
* Uploads an image for a product.
|
354
|
+
* @summary Upload an image for a product
|
355
|
+
* @param {BetaApiUploadProductImageRequest} requestParameters Request parameters.
|
356
|
+
|
357
|
+
* @throws {RequiredError}
|
358
|
+
*/
|
359
|
+
uploadProductImage(requestParameters: BetaApiUploadProductImageRequest): Promise<AddProductImageResponse>;
|
256
360
|
};
|
257
361
|
/**
|
258
362
|
* Request parameters for convertDealToLead operation in BetaApi.
|
@@ -305,6 +409,19 @@ export interface BetaApiDeleteInstallmentRequest {
|
|
305
409
|
*/
|
306
410
|
readonly installment_id: number;
|
307
411
|
}
|
412
|
+
/**
|
413
|
+
* Request parameters for deleteProductImage operation in BetaApi.
|
414
|
+
* @export
|
415
|
+
* @interface BetaApiDeleteProductImageRequest
|
416
|
+
*/
|
417
|
+
export interface BetaApiDeleteProductImageRequest {
|
418
|
+
/**
|
419
|
+
* The ID of the product
|
420
|
+
* @type {number}
|
421
|
+
* @memberof BetaApiDeleteProductImage
|
422
|
+
*/
|
423
|
+
readonly id: number;
|
424
|
+
}
|
308
425
|
/**
|
309
426
|
* Request parameters for getDealConversionStatus operation in BetaApi.
|
310
427
|
* @export
|
@@ -380,6 +497,19 @@ export interface BetaApiGetLeadConversionStatusRequest {
|
|
380
497
|
*/
|
381
498
|
readonly conversion_id: string;
|
382
499
|
}
|
500
|
+
/**
|
501
|
+
* Request parameters for getProductImage operation in BetaApi.
|
502
|
+
* @export
|
503
|
+
* @interface BetaApiGetProductImageRequest
|
504
|
+
*/
|
505
|
+
export interface BetaApiGetProductImageRequest {
|
506
|
+
/**
|
507
|
+
* The ID of the product
|
508
|
+
* @type {number}
|
509
|
+
* @memberof BetaApiGetProductImage
|
510
|
+
*/
|
511
|
+
readonly id: number;
|
512
|
+
}
|
383
513
|
/**
|
384
514
|
* Request parameters for postInstallment operation in BetaApi.
|
385
515
|
* @export
|
@@ -424,6 +554,44 @@ export interface BetaApiUpdateInstallmentRequest {
|
|
424
554
|
*/
|
425
555
|
readonly UpdateInstallmentRequestBody?: UpdateInstallmentRequestBody;
|
426
556
|
}
|
557
|
+
/**
|
558
|
+
* Request parameters for updateProductImage operation in BetaApi.
|
559
|
+
* @export
|
560
|
+
* @interface BetaApiUpdateProductImageRequest
|
561
|
+
*/
|
562
|
+
export interface BetaApiUpdateProductImageRequest {
|
563
|
+
/**
|
564
|
+
* The ID of the product
|
565
|
+
* @type {number}
|
566
|
+
* @memberof BetaApiUpdateProductImage
|
567
|
+
*/
|
568
|
+
readonly id: number;
|
569
|
+
/**
|
570
|
+
* One image supplied in the multipart/form-data encoding
|
571
|
+
* @type {File}
|
572
|
+
* @memberof BetaApiUpdateProductImage
|
573
|
+
*/
|
574
|
+
readonly data: File;
|
575
|
+
}
|
576
|
+
/**
|
577
|
+
* Request parameters for uploadProductImage operation in BetaApi.
|
578
|
+
* @export
|
579
|
+
* @interface BetaApiUploadProductImageRequest
|
580
|
+
*/
|
581
|
+
export interface BetaApiUploadProductImageRequest {
|
582
|
+
/**
|
583
|
+
* The ID of the product
|
584
|
+
* @type {number}
|
585
|
+
* @memberof BetaApiUploadProductImage
|
586
|
+
*/
|
587
|
+
readonly id: number;
|
588
|
+
/**
|
589
|
+
* One image supplied in the multipart/form-data encoding
|
590
|
+
* @type {File}
|
591
|
+
* @memberof BetaApiUploadProductImage
|
592
|
+
*/
|
593
|
+
readonly data: File;
|
594
|
+
}
|
427
595
|
/**
|
428
596
|
* BetaApi - object-oriented interface
|
429
597
|
* @export
|
@@ -450,7 +618,7 @@ export declare class BetaApi extends BaseAPI {
|
|
450
618
|
*/
|
451
619
|
convertLeadToDeal(requestParameters: BetaApiConvertLeadToDealRequest): Promise<AddConvertLeadToDealResponse>;
|
452
620
|
/**
|
453
|
-
* Removes an installment from a deal. Only available in
|
621
|
+
* Removes an installment from a deal. Only available in Growth and above plans.
|
454
622
|
* @summary Delete an installment from a deal
|
455
623
|
* @param {BetaApiDeleteInstallmentRequest} requestParameters Request parameters.
|
456
624
|
|
@@ -458,6 +626,15 @@ export declare class BetaApi extends BaseAPI {
|
|
458
626
|
* @memberof BetaApi
|
459
627
|
*/
|
460
628
|
deleteInstallment(requestParameters: BetaApiDeleteInstallmentRequest): Promise<DeleteInstallmentResponse>;
|
629
|
+
/**
|
630
|
+
* Deletes the image of a product.
|
631
|
+
* @summary Delete an image of a product
|
632
|
+
* @param {BetaApiDeleteProductImageRequest} requestParameters Request parameters.
|
633
|
+
|
634
|
+
* @throws {RequiredError}
|
635
|
+
* @memberof BetaApi
|
636
|
+
*/
|
637
|
+
deleteProductImage(requestParameters: BetaApiDeleteProductImageRequest): Promise<DeleteProductImageResponse>;
|
461
638
|
/**
|
462
639
|
* Returns information about the conversion. Status is always present and its value (not_started, running, completed, failed, rejected) represents the current state of the conversion. Lead ID is only present if the conversion was successfully finished. This data is only temporary and removed after a few days.
|
463
640
|
* @summary Get Deal conversion status (BETA)
|
@@ -468,7 +645,7 @@ export declare class BetaApi extends BaseAPI {
|
|
468
645
|
*/
|
469
646
|
getDealConversionStatus(requestParameters: BetaApiGetDealConversionStatusRequest): Promise<GetConvertResponse1>;
|
470
647
|
/**
|
471
|
-
* Lists installments attached to a list of deals. Only available in
|
648
|
+
* Lists installments attached to a list of deals. Only available in Growth and above plans.
|
472
649
|
* @summary List installments added to a list of deals
|
473
650
|
* @param {BetaApiGetInstallmentsRequest} requestParameters Request parameters.
|
474
651
|
|
@@ -486,7 +663,16 @@ export declare class BetaApi extends BaseAPI {
|
|
486
663
|
*/
|
487
664
|
getLeadConversionStatus(requestParameters: BetaApiGetLeadConversionStatusRequest): Promise<GetConvertResponse1>;
|
488
665
|
/**
|
489
|
-
*
|
666
|
+
* Retrieves the image of a product. The public URL has a limited lifetime of 7 days.
|
667
|
+
* @summary Get image of a product
|
668
|
+
* @param {BetaApiGetProductImageRequest} requestParameters Request parameters.
|
669
|
+
|
670
|
+
* @throws {RequiredError}
|
671
|
+
* @memberof BetaApi
|
672
|
+
*/
|
673
|
+
getProductImage(requestParameters: BetaApiGetProductImageRequest): Promise<GetProductImageResponse>;
|
674
|
+
/**
|
675
|
+
* Adds an installment to a deal. An installment can only be added if the deal includes at least one one-time product. If the deal contains at least one recurring product, adding installments is not allowed. Only available in Growth and above plans.
|
490
676
|
* @summary Add an installment to a deal
|
491
677
|
* @param {BetaApiPostInstallmentRequest} requestParameters Request parameters.
|
492
678
|
|
@@ -495,7 +681,7 @@ export declare class BetaApi extends BaseAPI {
|
|
495
681
|
*/
|
496
682
|
postInstallment(requestParameters: BetaApiPostInstallmentRequest): Promise<AddAInstallmentResponse>;
|
497
683
|
/**
|
498
|
-
* Edits an installment added to a deal. Only available in
|
684
|
+
* Edits an installment added to a deal. Only available in Growth and above plans.
|
499
685
|
* @summary Update an installment added to a deal
|
500
686
|
* @param {BetaApiUpdateInstallmentRequest} requestParameters Request parameters.
|
501
687
|
|
@@ -503,4 +689,22 @@ export declare class BetaApi extends BaseAPI {
|
|
503
689
|
* @memberof BetaApi
|
504
690
|
*/
|
505
691
|
updateInstallment(requestParameters: BetaApiUpdateInstallmentRequest): Promise<UpdateInstallmentResponse>;
|
692
|
+
/**
|
693
|
+
* Updates the image of a product.
|
694
|
+
* @summary Update an image for a product
|
695
|
+
* @param {BetaApiUpdateProductImageRequest} requestParameters Request parameters.
|
696
|
+
|
697
|
+
* @throws {RequiredError}
|
698
|
+
* @memberof BetaApi
|
699
|
+
*/
|
700
|
+
updateProductImage(requestParameters: BetaApiUpdateProductImageRequest): Promise<UpdateProductImageResponse>;
|
701
|
+
/**
|
702
|
+
* Uploads an image for a product.
|
703
|
+
* @summary Upload an image for a product
|
704
|
+
* @param {BetaApiUploadProductImageRequest} requestParameters Request parameters.
|
705
|
+
|
706
|
+
* @throws {RequiredError}
|
707
|
+
* @memberof BetaApi
|
708
|
+
*/
|
709
|
+
uploadProductImage(requestParameters: BetaApiUploadProductImageRequest): Promise<AddProductImageResponse>;
|
506
710
|
}
|