@iblai/iblai-api 4.288.1-core → 4.289.0-core
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/index.cjs.js +10618 -12607
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.esm.js +10619 -12593
- package/dist/index.esm.js.map +1 -1
- package/dist/index.umd.js +10618 -12607
- package/dist/index.umd.js.map +1 -1
- package/dist/types/index.d.ts +0 -15
- package/dist/types/services/BillingService.d.ts +215 -4
- package/package.json +1 -1
- package/sdk_schema.yml +10797 -14096
- package/src/core/OpenAPI.ts +1 -1
- package/src/index.ts +0 -15
- package/src/services/BillingService.ts +468 -6
- package/dist/types/services/AccessCheckService.d.ts +0 -17
- package/dist/types/services/AccountService.d.ts +0 -36
- package/dist/types/services/ActivitiesService.d.ts +0 -126
- package/dist/types/services/AutoRechargeService.d.ts +0 -14
- package/dist/types/services/CreditsService.d.ts +0 -12
- package/dist/types/services/DealsService.d.ts +0 -192
- package/dist/types/services/ItemsService.d.ts +0 -13
- package/dist/types/services/LeadSourcesService.d.ts +0 -95
- package/dist/types/services/OrganizationsService.d.ts +0 -109
- package/dist/types/services/PersonsService.d.ts +0 -168
- package/dist/types/services/PipelinesService.d.ts +0 -183
- package/dist/types/services/PlatformsService.d.ts +0 -332
- package/dist/types/services/PricesService.d.ts +0 -15
- package/dist/types/services/TagsService.d.ts +0 -96
- package/dist/types/services/TransactionsService.d.ts +0 -35
- package/src/services/AccessCheckService.ts +0 -39
- package/src/services/AccountService.ts +0 -70
- package/src/services/ActivitiesService.ts +0 -255
- package/src/services/AutoRechargeService.ts +0 -29
- package/src/services/CreditsService.ts +0 -23
- package/src/services/DealsService.ts +0 -406
- package/src/services/ItemsService.ts +0 -29
- package/src/services/LeadSourcesService.ts +0 -198
- package/src/services/OrganizationsService.ts +0 -249
- package/src/services/PersonsService.ts +0 -367
- package/src/services/PipelinesService.ts +0 -406
- package/src/services/PlatformsService.ts +0 -716
- package/src/services/PricesService.ts +0 -34
- package/src/services/TagsService.ts +0 -201
- package/src/services/TransactionsService.ts +0 -57
|
@@ -1,126 +0,0 @@
|
|
|
1
|
-
import type { Activity } from '../models/Activity';
|
|
2
|
-
import type { PaginatedActivityList } from '../models/PaginatedActivityList';
|
|
3
|
-
import type { PatchedActivity } from '../models/PatchedActivity';
|
|
4
|
-
import type { CancelablePromise } from '../core/CancelablePromise';
|
|
5
|
-
export declare class ActivitiesService {
|
|
6
|
-
/**
|
|
7
|
-
* List activities
|
|
8
|
-
* Returns a paginated list of Activities in your Platform. Supports filtering by `type`, `is_done`, `owner`, `deal`, `person`, schedule-from ranges, and `metadata__has_key`.
|
|
9
|
-
*
|
|
10
|
-
* **Required permission:** `Ibl.CRM/Activities/list`.
|
|
11
|
-
* @returns PaginatedActivityList
|
|
12
|
-
* @throws ApiError
|
|
13
|
-
*/
|
|
14
|
-
static activitiesList({ deal, isDone, metadataHasKey, owner, page, pageSize, person, scheduleFromGte, scheduleFromLte, type, }: {
|
|
15
|
-
deal?: number;
|
|
16
|
-
isDone?: boolean;
|
|
17
|
-
metadataHasKey?: string;
|
|
18
|
-
owner?: number;
|
|
19
|
-
/**
|
|
20
|
-
* A page number within the paginated result set.
|
|
21
|
-
*/
|
|
22
|
-
page?: number;
|
|
23
|
-
/**
|
|
24
|
-
* Number of results to return per page.
|
|
25
|
-
*/
|
|
26
|
-
pageSize?: number;
|
|
27
|
-
person?: string;
|
|
28
|
-
scheduleFromGte?: string;
|
|
29
|
-
scheduleFromLte?: string;
|
|
30
|
-
/**
|
|
31
|
-
* Interaction kind.
|
|
32
|
-
*
|
|
33
|
-
* * `call` - Call
|
|
34
|
-
* * `meeting` - Meeting
|
|
35
|
-
* * `email` - Email
|
|
36
|
-
* * `note` - Note
|
|
37
|
-
* * `task` - Task
|
|
38
|
-
* * `lunch` - Lunch
|
|
39
|
-
* * `deadline` - Deadline
|
|
40
|
-
*/
|
|
41
|
-
type?: 'call' | 'deadline' | 'email' | 'lunch' | 'meeting' | 'note' | 'task';
|
|
42
|
-
}): CancelablePromise<PaginatedActivityList>;
|
|
43
|
-
/**
|
|
44
|
-
* Create an activity
|
|
45
|
-
* Creates an Activity. Either `deal` or `person` must be supplied; both must belong to your Platform.
|
|
46
|
-
*
|
|
47
|
-
* **Required permission:** `Ibl.CRM/Activities/action`.
|
|
48
|
-
* @returns Activity
|
|
49
|
-
* @throws ApiError
|
|
50
|
-
*/
|
|
51
|
-
static activitiesCreate({ requestBody, }: {
|
|
52
|
-
requestBody: Activity;
|
|
53
|
-
}): CancelablePromise<Activity>;
|
|
54
|
-
/**
|
|
55
|
-
* Retrieve an activity
|
|
56
|
-
* Returns a single Activity by id.
|
|
57
|
-
*
|
|
58
|
-
* **Required permission:** `Ibl.CRM/Activities/read`.
|
|
59
|
-
* @returns Activity
|
|
60
|
-
* @throws ApiError
|
|
61
|
-
*/
|
|
62
|
-
static activitiesRetrieve({ id, }: {
|
|
63
|
-
/**
|
|
64
|
-
* A unique integer value identifying this activity.
|
|
65
|
-
*/
|
|
66
|
-
id: number;
|
|
67
|
-
}): CancelablePromise<Activity>;
|
|
68
|
-
/**
|
|
69
|
-
* Replace an activity
|
|
70
|
-
* Replaces all editable fields on the Activity.
|
|
71
|
-
*
|
|
72
|
-
* **Required permission:** `Ibl.CRM/Activities/write`.
|
|
73
|
-
* @returns Activity
|
|
74
|
-
* @throws ApiError
|
|
75
|
-
*/
|
|
76
|
-
static activitiesUpdate({ id, requestBody, }: {
|
|
77
|
-
/**
|
|
78
|
-
* A unique integer value identifying this activity.
|
|
79
|
-
*/
|
|
80
|
-
id: number;
|
|
81
|
-
requestBody: Activity;
|
|
82
|
-
}): CancelablePromise<Activity>;
|
|
83
|
-
/**
|
|
84
|
-
* Update an activity
|
|
85
|
-
* Updates only the supplied fields on the Activity.
|
|
86
|
-
*
|
|
87
|
-
* **Required permission:** `Ibl.CRM/Activities/write`.
|
|
88
|
-
* @returns Activity
|
|
89
|
-
* @throws ApiError
|
|
90
|
-
*/
|
|
91
|
-
static activitiesPartialUpdate({ id, requestBody, }: {
|
|
92
|
-
/**
|
|
93
|
-
* A unique integer value identifying this activity.
|
|
94
|
-
*/
|
|
95
|
-
id: number;
|
|
96
|
-
requestBody?: PatchedActivity;
|
|
97
|
-
}): CancelablePromise<Activity>;
|
|
98
|
-
/**
|
|
99
|
-
* Delete an activity
|
|
100
|
-
* Deletes the Activity.
|
|
101
|
-
*
|
|
102
|
-
* **Required permission:** `Ibl.CRM/Activities/delete`.
|
|
103
|
-
* @returns void
|
|
104
|
-
* @throws ApiError
|
|
105
|
-
*/
|
|
106
|
-
static activitiesDestroy({ id, }: {
|
|
107
|
-
/**
|
|
108
|
-
* A unique integer value identifying this activity.
|
|
109
|
-
*/
|
|
110
|
-
id: number;
|
|
111
|
-
}): CancelablePromise<void>;
|
|
112
|
-
/**
|
|
113
|
-
* Mark an activity as done
|
|
114
|
-
* Flips `is_done=True` and stamps `done_at` if it isn't already set. Idempotent — calling on an already-done Activity preserves the original `done_at`.
|
|
115
|
-
*
|
|
116
|
-
* **Required permission:** `Ibl.CRM/Activities/write`.
|
|
117
|
-
* @returns Activity
|
|
118
|
-
* @throws ApiError
|
|
119
|
-
*/
|
|
120
|
-
static activitiesDoneCreate({ id, }: {
|
|
121
|
-
/**
|
|
122
|
-
* A unique integer value identifying this activity.
|
|
123
|
-
*/
|
|
124
|
-
id: number;
|
|
125
|
-
}): CancelablePromise<Activity>;
|
|
126
|
-
}
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
import type { AutoRechargeTriggerRequest } from '../models/AutoRechargeTriggerRequest';
|
|
2
|
-
import type { AutoRechargeTriggerResponse } from '../models/AutoRechargeTriggerResponse';
|
|
3
|
-
import type { CancelablePromise } from '../core/CancelablePromise';
|
|
4
|
-
export declare class AutoRechargeService {
|
|
5
|
-
/**
|
|
6
|
-
* Trigger auto-recharge or manual top-up
|
|
7
|
-
* With amount_usd: manual top-up (charge that amount, add credits; no threshold/limit/cooldown). Without amount_usd: run auto-recharge once if enabled and balance below threshold. Returns 400 if skipped or failed (e.g. no payment method, cooldown). Pass platform_key in request body.
|
|
8
|
-
* @returns AutoRechargeTriggerResponse
|
|
9
|
-
* @throws ApiError
|
|
10
|
-
*/
|
|
11
|
-
static autoRechargeTriggerCreate({ requestBody, }: {
|
|
12
|
-
requestBody?: AutoRechargeTriggerRequest;
|
|
13
|
-
}): CancelablePromise<AutoRechargeTriggerResponse>;
|
|
14
|
-
}
|
|
@@ -1,12 +0,0 @@
|
|
|
1
|
-
import type { CancelablePromise } from '../core/CancelablePromise';
|
|
2
|
-
export declare class CreditsService {
|
|
3
|
-
/**
|
|
4
|
-
* Sample endpoint protected by @consume_credits (opt-in).
|
|
5
|
-
*
|
|
6
|
-
* Balance is checked before the view runs. If insufficient, 402 with
|
|
7
|
-
* pricing_table is returned; otherwise the view runs and 1 credit is consumed.
|
|
8
|
-
* @returns any No response body
|
|
9
|
-
* @throws ApiError
|
|
10
|
-
*/
|
|
11
|
-
static creditsSampleActionCreate(): CancelablePromise<any>;
|
|
12
|
-
}
|
|
@@ -1,192 +0,0 @@
|
|
|
1
|
-
import type { _TagAttachRequest } from '../models/_TagAttachRequest';
|
|
2
|
-
import type { Deal } from '../models/Deal';
|
|
3
|
-
import type { DealLostRequest } from '../models/DealLostRequest';
|
|
4
|
-
import type { DealMoveStageRequest } from '../models/DealMoveStageRequest';
|
|
5
|
-
import type { DealWonRequest } from '../models/DealWonRequest';
|
|
6
|
-
import type { PaginatedDealList } from '../models/PaginatedDealList';
|
|
7
|
-
import type { PatchedDeal } from '../models/PatchedDeal';
|
|
8
|
-
import type { CancelablePromise } from '../core/CancelablePromise';
|
|
9
|
-
export declare class DealsService {
|
|
10
|
-
/**
|
|
11
|
-
* List deals
|
|
12
|
-
* Returns a paginated list of Deals in your Platform. Supports filtering by `status`, `pipeline`, `stage`, `owner`, `source`, `person`, `organization`, expected-close-date and created-at ranges, and `metadata__has_key`.
|
|
13
|
-
*
|
|
14
|
-
* **Required permission:** `Ibl.CRM/Deals/list`.
|
|
15
|
-
* @returns PaginatedDealList
|
|
16
|
-
* @throws ApiError
|
|
17
|
-
*/
|
|
18
|
-
static dealsList({ createdAtGte, createdAtLte, expectedCloseDateGte, expectedCloseDateLte, metadataHasKey, organization, owner, page, pageSize, person, pipeline, source, stage, status, tags, }: {
|
|
19
|
-
createdAtGte?: string;
|
|
20
|
-
createdAtLte?: string;
|
|
21
|
-
expectedCloseDateGte?: string;
|
|
22
|
-
expectedCloseDateLte?: string;
|
|
23
|
-
metadataHasKey?: string;
|
|
24
|
-
organization?: string;
|
|
25
|
-
owner?: number;
|
|
26
|
-
/**
|
|
27
|
-
* A page number within the paginated result set.
|
|
28
|
-
*/
|
|
29
|
-
page?: number;
|
|
30
|
-
/**
|
|
31
|
-
* Number of results to return per page.
|
|
32
|
-
*/
|
|
33
|
-
pageSize?: number;
|
|
34
|
-
person?: string;
|
|
35
|
-
pipeline?: number;
|
|
36
|
-
source?: number;
|
|
37
|
-
stage?: number;
|
|
38
|
-
/**
|
|
39
|
-
* Service-managed (read-only in serializer). Derived from the destination stage's is_won/is_lost.
|
|
40
|
-
*
|
|
41
|
-
* * `open` - Open
|
|
42
|
-
* * `won` - Won
|
|
43
|
-
* * `lost` - Lost
|
|
44
|
-
*/
|
|
45
|
-
status?: 'lost' | 'open' | 'won';
|
|
46
|
-
tags?: string;
|
|
47
|
-
}): CancelablePromise<PaginatedDealList>;
|
|
48
|
-
/**
|
|
49
|
-
* Create a deal
|
|
50
|
-
* Creates a new Deal. All FK targets (`person`, `organization`, `pipeline`, `stage`, `source`) must belong to your Platform; `stage` must belong to `pipeline`. `status` and `closed_at` are service-managed — passing them returns `400`.
|
|
51
|
-
*
|
|
52
|
-
* **Required permission:** `Ibl.CRM/Deals/action`.
|
|
53
|
-
* @returns Deal
|
|
54
|
-
* @throws ApiError
|
|
55
|
-
*/
|
|
56
|
-
static dealsCreate({ requestBody, }: {
|
|
57
|
-
requestBody: Deal;
|
|
58
|
-
}): CancelablePromise<Deal>;
|
|
59
|
-
/**
|
|
60
|
-
* Retrieve a deal
|
|
61
|
-
* Returns a single Deal by id.
|
|
62
|
-
*
|
|
63
|
-
* **Required permission:** `Ibl.CRM/Deals/read`.
|
|
64
|
-
* @returns Deal
|
|
65
|
-
* @throws ApiError
|
|
66
|
-
*/
|
|
67
|
-
static dealsRetrieve({ id, }: {
|
|
68
|
-
/**
|
|
69
|
-
* A unique integer value identifying this deal.
|
|
70
|
-
*/
|
|
71
|
-
id: number;
|
|
72
|
-
}): CancelablePromise<Deal>;
|
|
73
|
-
/**
|
|
74
|
-
* Replace a deal
|
|
75
|
-
* Replaces all editable fields on the Deal.
|
|
76
|
-
*
|
|
77
|
-
* **Required permission:** `Ibl.CRM/Deals/write`.
|
|
78
|
-
* @returns Deal
|
|
79
|
-
* @throws ApiError
|
|
80
|
-
*/
|
|
81
|
-
static dealsUpdate({ id, requestBody, }: {
|
|
82
|
-
/**
|
|
83
|
-
* A unique integer value identifying this deal.
|
|
84
|
-
*/
|
|
85
|
-
id: number;
|
|
86
|
-
requestBody: Deal;
|
|
87
|
-
}): CancelablePromise<Deal>;
|
|
88
|
-
/**
|
|
89
|
-
* Update a deal
|
|
90
|
-
* Updates only the supplied fields on the Deal. Direct writes to `status` or `closed_at` are rejected with `400` — use `POST /deals/{id}/move-stage/`, `won/`, or `lost/`.
|
|
91
|
-
*
|
|
92
|
-
* **Required permission:** `Ibl.CRM/Deals/write`.
|
|
93
|
-
* @returns Deal
|
|
94
|
-
* @throws ApiError
|
|
95
|
-
*/
|
|
96
|
-
static dealsPartialUpdate({ id, requestBody, }: {
|
|
97
|
-
/**
|
|
98
|
-
* A unique integer value identifying this deal.
|
|
99
|
-
*/
|
|
100
|
-
id: number;
|
|
101
|
-
requestBody?: PatchedDeal;
|
|
102
|
-
}): CancelablePromise<Deal>;
|
|
103
|
-
/**
|
|
104
|
-
* Delete a deal
|
|
105
|
-
* Deletes the Deal.
|
|
106
|
-
*
|
|
107
|
-
* **Required permission:** `Ibl.CRM/Deals/delete`.
|
|
108
|
-
* @returns void
|
|
109
|
-
* @throws ApiError
|
|
110
|
-
*/
|
|
111
|
-
static dealsDestroy({ id, }: {
|
|
112
|
-
/**
|
|
113
|
-
* A unique integer value identifying this deal.
|
|
114
|
-
*/
|
|
115
|
-
id: number;
|
|
116
|
-
}): CancelablePromise<void>;
|
|
117
|
-
/**
|
|
118
|
-
* Mark a deal as lost
|
|
119
|
-
* Moves the Deal into a closed-lost stage and persists `lost_reason`. If `stage_code` is omitted, the first `is_lost=True` stage in the Deal's pipeline (by sort order) is used.
|
|
120
|
-
*
|
|
121
|
-
* **Required permission:** `Ibl.CRM/Deals/write`.
|
|
122
|
-
* @returns Deal
|
|
123
|
-
* @throws ApiError
|
|
124
|
-
*/
|
|
125
|
-
static dealsLostCreate({ id, requestBody, }: {
|
|
126
|
-
/**
|
|
127
|
-
* A unique integer value identifying this deal.
|
|
128
|
-
*/
|
|
129
|
-
id: number;
|
|
130
|
-
requestBody: DealLostRequest;
|
|
131
|
-
}): CancelablePromise<Deal>;
|
|
132
|
-
/**
|
|
133
|
-
* Move a deal to a different stage
|
|
134
|
-
* Moves the Deal to the stage identified by `stage_id` or `stage_code`. The target stage must belong to this Deal's pipeline. Records an audit Activity and emits `deal_stage_changed`. `Deal.status` is recomputed from the new stage's `is_won` / `is_lost` flags.
|
|
135
|
-
*
|
|
136
|
-
* **Required permission:** `Ibl.CRM/Deals/write`.
|
|
137
|
-
* @returns Deal
|
|
138
|
-
* @throws ApiError
|
|
139
|
-
*/
|
|
140
|
-
static dealsMoveStageCreate({ id, requestBody, }: {
|
|
141
|
-
/**
|
|
142
|
-
* A unique integer value identifying this deal.
|
|
143
|
-
*/
|
|
144
|
-
id: number;
|
|
145
|
-
requestBody?: DealMoveStageRequest;
|
|
146
|
-
}): CancelablePromise<Deal>;
|
|
147
|
-
/**
|
|
148
|
-
* Attach a tag to this record
|
|
149
|
-
* Attaches an existing Tag to this record. Both the Tag and the record must belong to your Platform. Returns `409 Conflict` with the existing `assignment_id` if the tag is already attached.
|
|
150
|
-
*
|
|
151
|
-
* **Required permission:** `Ibl.CRM/Tags/write`.
|
|
152
|
-
* @returns any No response body
|
|
153
|
-
* @throws ApiError
|
|
154
|
-
*/
|
|
155
|
-
static dealsTagsCreate({ id, requestBody, }: {
|
|
156
|
-
/**
|
|
157
|
-
* A unique integer value identifying this deal.
|
|
158
|
-
*/
|
|
159
|
-
id: number;
|
|
160
|
-
requestBody: _TagAttachRequest;
|
|
161
|
-
}): CancelablePromise<any>;
|
|
162
|
-
/**
|
|
163
|
-
* Detach a tag from this record
|
|
164
|
-
* Removes the Tag with id `tag_id` from this record. Returns `404` if the tag was not attached.
|
|
165
|
-
*
|
|
166
|
-
* **Required permission:** `Ibl.CRM/Tags/write`.
|
|
167
|
-
* @returns void
|
|
168
|
-
* @throws ApiError
|
|
169
|
-
*/
|
|
170
|
-
static dealsTagsDestroy({ id, tagId, }: {
|
|
171
|
-
/**
|
|
172
|
-
* A unique integer value identifying this deal.
|
|
173
|
-
*/
|
|
174
|
-
id: number;
|
|
175
|
-
tagId: string;
|
|
176
|
-
}): CancelablePromise<void>;
|
|
177
|
-
/**
|
|
178
|
-
* Mark a deal as won
|
|
179
|
-
* Moves the Deal into a closed-won stage and sets `status='won'`. If `stage_code` is omitted, the first `is_won=True` stage in the Deal's pipeline (by sort order) is used.
|
|
180
|
-
*
|
|
181
|
-
* **Required permission:** `Ibl.CRM/Deals/write`.
|
|
182
|
-
* @returns Deal
|
|
183
|
-
* @throws ApiError
|
|
184
|
-
*/
|
|
185
|
-
static dealsWonCreate({ id, requestBody, }: {
|
|
186
|
-
/**
|
|
187
|
-
* A unique integer value identifying this deal.
|
|
188
|
-
*/
|
|
189
|
-
id: number;
|
|
190
|
-
requestBody?: DealWonRequest;
|
|
191
|
-
}): CancelablePromise<Deal>;
|
|
192
|
-
}
|
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
import type { PublicItemPricing } from '../models/PublicItemPricing';
|
|
2
|
-
import type { CancelablePromise } from '../core/CancelablePromise';
|
|
3
|
-
export declare class ItemsService {
|
|
4
|
-
/**
|
|
5
|
-
* Get public pricing by paywall config unique_id
|
|
6
|
-
* Looks up the paywall config by its unique_id and delegates to the standard public pricing endpoint.
|
|
7
|
-
* @returns PublicItemPricing
|
|
8
|
-
* @throws ApiError
|
|
9
|
-
*/
|
|
10
|
-
static itemsPublicPricingRetrieve({ configUniqueId, }: {
|
|
11
|
-
configUniqueId: string;
|
|
12
|
-
}): CancelablePromise<PublicItemPricing>;
|
|
13
|
-
}
|
|
@@ -1,95 +0,0 @@
|
|
|
1
|
-
import type { LeadSource } from '../models/LeadSource';
|
|
2
|
-
import type { PaginatedLeadSourceList } from '../models/PaginatedLeadSourceList';
|
|
3
|
-
import type { PatchedLeadSource } from '../models/PatchedLeadSource';
|
|
4
|
-
import type { CancelablePromise } from '../core/CancelablePromise';
|
|
5
|
-
export declare class LeadSourcesService {
|
|
6
|
-
/**
|
|
7
|
-
* List lead sources
|
|
8
|
-
* Returns a paginated list of LeadSources in your Platform.
|
|
9
|
-
*
|
|
10
|
-
* **Required permission:** `Ibl.CRM/Pipelines/list`.
|
|
11
|
-
* @returns PaginatedLeadSourceList
|
|
12
|
-
* @throws ApiError
|
|
13
|
-
*/
|
|
14
|
-
static leadSourcesList({ code, name, page, pageSize, }: {
|
|
15
|
-
code?: string;
|
|
16
|
-
name?: string;
|
|
17
|
-
/**
|
|
18
|
-
* A page number within the paginated result set.
|
|
19
|
-
*/
|
|
20
|
-
page?: number;
|
|
21
|
-
/**
|
|
22
|
-
* Number of results to return per page.
|
|
23
|
-
*/
|
|
24
|
-
pageSize?: number;
|
|
25
|
-
}): CancelablePromise<PaginatedLeadSourceList>;
|
|
26
|
-
/**
|
|
27
|
-
* Create a lead source
|
|
28
|
-
* Creates a new LeadSource in your Platform. `code` must be unique.
|
|
29
|
-
*
|
|
30
|
-
* **Required permission:** `Ibl.CRM/Pipelines/action`.
|
|
31
|
-
* @returns LeadSource
|
|
32
|
-
* @throws ApiError
|
|
33
|
-
*/
|
|
34
|
-
static leadSourcesCreate({ requestBody, }: {
|
|
35
|
-
requestBody: LeadSource;
|
|
36
|
-
}): CancelablePromise<LeadSource>;
|
|
37
|
-
/**
|
|
38
|
-
* Retrieve a lead source
|
|
39
|
-
* Returns a single LeadSource by id.
|
|
40
|
-
*
|
|
41
|
-
* **Required permission:** `Ibl.CRM/Pipelines/read`.
|
|
42
|
-
* @returns LeadSource
|
|
43
|
-
* @throws ApiError
|
|
44
|
-
*/
|
|
45
|
-
static leadSourcesRetrieve({ id, }: {
|
|
46
|
-
/**
|
|
47
|
-
* A unique integer value identifying this lead source.
|
|
48
|
-
*/
|
|
49
|
-
id: number;
|
|
50
|
-
}): CancelablePromise<LeadSource>;
|
|
51
|
-
/**
|
|
52
|
-
* Replace a lead source
|
|
53
|
-
* Replaces all editable fields on the LeadSource.
|
|
54
|
-
*
|
|
55
|
-
* **Required permission:** `Ibl.CRM/Pipelines/write`.
|
|
56
|
-
* @returns LeadSource
|
|
57
|
-
* @throws ApiError
|
|
58
|
-
*/
|
|
59
|
-
static leadSourcesUpdate({ id, requestBody, }: {
|
|
60
|
-
/**
|
|
61
|
-
* A unique integer value identifying this lead source.
|
|
62
|
-
*/
|
|
63
|
-
id: number;
|
|
64
|
-
requestBody: LeadSource;
|
|
65
|
-
}): CancelablePromise<LeadSource>;
|
|
66
|
-
/**
|
|
67
|
-
* Update a lead source
|
|
68
|
-
* Updates only the supplied fields on the LeadSource.
|
|
69
|
-
*
|
|
70
|
-
* **Required permission:** `Ibl.CRM/Pipelines/write`.
|
|
71
|
-
* @returns LeadSource
|
|
72
|
-
* @throws ApiError
|
|
73
|
-
*/
|
|
74
|
-
static leadSourcesPartialUpdate({ id, requestBody, }: {
|
|
75
|
-
/**
|
|
76
|
-
* A unique integer value identifying this lead source.
|
|
77
|
-
*/
|
|
78
|
-
id: number;
|
|
79
|
-
requestBody?: PatchedLeadSource;
|
|
80
|
-
}): CancelablePromise<LeadSource>;
|
|
81
|
-
/**
|
|
82
|
-
* Delete a lead source
|
|
83
|
-
* Deletes the LeadSource. Any Deals referencing it have their `source` cleared.
|
|
84
|
-
*
|
|
85
|
-
* **Required permission:** `Ibl.CRM/Pipelines/delete`.
|
|
86
|
-
* @returns void
|
|
87
|
-
* @throws ApiError
|
|
88
|
-
*/
|
|
89
|
-
static leadSourcesDestroy({ id, }: {
|
|
90
|
-
/**
|
|
91
|
-
* A unique integer value identifying this lead source.
|
|
92
|
-
*/
|
|
93
|
-
id: number;
|
|
94
|
-
}): CancelablePromise<void>;
|
|
95
|
-
}
|
|
@@ -1,109 +0,0 @@
|
|
|
1
|
-
import type { _TagAttachRequest } from '../models/_TagAttachRequest';
|
|
2
|
-
import type { Organization } from '../models/Organization';
|
|
3
|
-
import type { PaginatedOrganizationList } from '../models/PaginatedOrganizationList';
|
|
4
|
-
import type { PatchedOrganization } from '../models/PatchedOrganization';
|
|
5
|
-
import type { CancelablePromise } from '../core/CancelablePromise';
|
|
6
|
-
export declare class OrganizationsService {
|
|
7
|
-
/**
|
|
8
|
-
* List organizations
|
|
9
|
-
* Returns a paginated list of organizations in your Platform. Supports filtering by `owner` and by `name` (case-insensitive substring match).
|
|
10
|
-
*
|
|
11
|
-
* **Required permission:** `Ibl.CRM/Organizations/list`.
|
|
12
|
-
* @returns PaginatedOrganizationList
|
|
13
|
-
* @throws ApiError
|
|
14
|
-
*/
|
|
15
|
-
static organizationsList({ name, owner, page, pageSize, tags, }: {
|
|
16
|
-
name?: string;
|
|
17
|
-
owner?: number;
|
|
18
|
-
/**
|
|
19
|
-
* A page number within the paginated result set.
|
|
20
|
-
*/
|
|
21
|
-
page?: number;
|
|
22
|
-
/**
|
|
23
|
-
* Number of results to return per page.
|
|
24
|
-
*/
|
|
25
|
-
pageSize?: number;
|
|
26
|
-
tags?: string;
|
|
27
|
-
}): CancelablePromise<PaginatedOrganizationList>;
|
|
28
|
-
/**
|
|
29
|
-
* Create an organization
|
|
30
|
-
* Creates a new organization in your Platform. The Platform is inferred from your credentials. `name` must be unique within your Platform.
|
|
31
|
-
*
|
|
32
|
-
* **Required permission:** `Ibl.CRM/Organizations/action`.
|
|
33
|
-
* @returns Organization
|
|
34
|
-
* @throws ApiError
|
|
35
|
-
*/
|
|
36
|
-
static organizationsCreate({ requestBody, }: {
|
|
37
|
-
requestBody: Organization;
|
|
38
|
-
}): CancelablePromise<Organization>;
|
|
39
|
-
/**
|
|
40
|
-
* Retrieve an organization
|
|
41
|
-
* Returns a single organization by id.
|
|
42
|
-
*
|
|
43
|
-
* **Required permission:** `Ibl.CRM/Organizations/read`.
|
|
44
|
-
* @returns Organization
|
|
45
|
-
* @throws ApiError
|
|
46
|
-
*/
|
|
47
|
-
static organizationsRetrieve({ id, }: {
|
|
48
|
-
id: string;
|
|
49
|
-
}): CancelablePromise<Organization>;
|
|
50
|
-
/**
|
|
51
|
-
* Replace an organization
|
|
52
|
-
* Replaces all editable fields on the organization.
|
|
53
|
-
*
|
|
54
|
-
* **Required permission:** `Ibl.CRM/Organizations/write`.
|
|
55
|
-
* @returns Organization
|
|
56
|
-
* @throws ApiError
|
|
57
|
-
*/
|
|
58
|
-
static organizationsUpdate({ id, requestBody, }: {
|
|
59
|
-
id: string;
|
|
60
|
-
requestBody: Organization;
|
|
61
|
-
}): CancelablePromise<Organization>;
|
|
62
|
-
/**
|
|
63
|
-
* Update an organization
|
|
64
|
-
* Updates only the supplied fields on the organization.
|
|
65
|
-
*
|
|
66
|
-
* **Required permission:** `Ibl.CRM/Organizations/write`.
|
|
67
|
-
* @returns Organization
|
|
68
|
-
* @throws ApiError
|
|
69
|
-
*/
|
|
70
|
-
static organizationsPartialUpdate({ id, requestBody, }: {
|
|
71
|
-
id: string;
|
|
72
|
-
requestBody?: PatchedOrganization;
|
|
73
|
-
}): CancelablePromise<Organization>;
|
|
74
|
-
/**
|
|
75
|
-
* Delete an organization
|
|
76
|
-
* Deletes the organization. Any persons linked to it are kept; their organization reference is cleared.
|
|
77
|
-
*
|
|
78
|
-
* **Required permission:** `Ibl.CRM/Organizations/delete`.
|
|
79
|
-
* @returns void
|
|
80
|
-
* @throws ApiError
|
|
81
|
-
*/
|
|
82
|
-
static organizationsDestroy({ id, }: {
|
|
83
|
-
id: string;
|
|
84
|
-
}): CancelablePromise<void>;
|
|
85
|
-
/**
|
|
86
|
-
* Attach a tag to this record
|
|
87
|
-
* Attaches an existing Tag to this record. Both the Tag and the record must belong to your Platform. Returns `409 Conflict` with the existing `assignment_id` if the tag is already attached.
|
|
88
|
-
*
|
|
89
|
-
* **Required permission:** `Ibl.CRM/Tags/write`.
|
|
90
|
-
* @returns any No response body
|
|
91
|
-
* @throws ApiError
|
|
92
|
-
*/
|
|
93
|
-
static organizationsTagsCreate({ id, requestBody, }: {
|
|
94
|
-
id: string;
|
|
95
|
-
requestBody: _TagAttachRequest;
|
|
96
|
-
}): CancelablePromise<any>;
|
|
97
|
-
/**
|
|
98
|
-
* Detach a tag from this record
|
|
99
|
-
* Removes the Tag with id `tag_id` from this record. Returns `404` if the tag was not attached.
|
|
100
|
-
*
|
|
101
|
-
* **Required permission:** `Ibl.CRM/Tags/write`.
|
|
102
|
-
* @returns void
|
|
103
|
-
* @throws ApiError
|
|
104
|
-
*/
|
|
105
|
-
static organizationsTagsDestroy({ id, tagId, }: {
|
|
106
|
-
id: string;
|
|
107
|
-
tagId: string;
|
|
108
|
-
}): CancelablePromise<void>;
|
|
109
|
-
}
|