@epilot/sdk 2.1.1 → 2.1.2
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/definitions/partner-directory-runtime.json +1 -1
- package/definitions/partner-directory.json +795 -229
- package/dist/apis/access-token.cjs +6 -6
- package/dist/apis/access-token.js +1 -1
- package/dist/apis/address-suggestions.cjs +6 -6
- package/dist/apis/address-suggestions.js +1 -1
- package/dist/apis/address.cjs +6 -6
- package/dist/apis/address.js +1 -1
- package/dist/apis/ai-agents.cjs +6 -6
- package/dist/apis/ai-agents.js +1 -1
- package/dist/apis/app.cjs +6 -6
- package/dist/apis/app.js +1 -1
- package/dist/apis/audit-logs.cjs +6 -6
- package/dist/apis/audit-logs.js +1 -1
- package/dist/apis/automation.cjs +6 -6
- package/dist/apis/automation.js +1 -1
- package/dist/apis/billing.cjs +6 -6
- package/dist/apis/billing.js +1 -1
- package/dist/apis/blueprint-manifest.cjs +6 -6
- package/dist/apis/blueprint-manifest.js +1 -1
- package/dist/apis/consent.cjs +6 -6
- package/dist/apis/consent.js +1 -1
- package/dist/apis/customer-portal.cjs +6 -6
- package/dist/apis/customer-portal.js +1 -1
- package/dist/apis/dashboard.cjs +6 -6
- package/dist/apis/dashboard.js +1 -1
- package/dist/apis/data-management.cjs +6 -6
- package/dist/apis/data-management.js +1 -1
- package/dist/apis/deduplication.cjs +6 -6
- package/dist/apis/deduplication.js +1 -1
- package/dist/apis/design.cjs +6 -6
- package/dist/apis/design.js +1 -1
- package/dist/apis/document.cjs +6 -6
- package/dist/apis/document.js +1 -1
- package/dist/apis/email-settings.cjs +6 -6
- package/dist/apis/email-settings.js +1 -1
- package/dist/apis/email-template.cjs +6 -6
- package/dist/apis/email-template.js +1 -1
- package/dist/apis/entity-mapping.cjs +6 -6
- package/dist/apis/entity-mapping.js +1 -1
- package/dist/apis/entity.cjs +6 -6
- package/dist/apis/entity.js +1 -1
- package/dist/apis/environments.cjs +6 -6
- package/dist/apis/environments.js +1 -1
- package/dist/apis/erp-integration.cjs +6 -6
- package/dist/apis/erp-integration.js +1 -1
- package/dist/apis/event-catalog.cjs +6 -6
- package/dist/apis/event-catalog.js +1 -1
- package/dist/apis/file.cjs +6 -6
- package/dist/apis/file.js +1 -1
- package/dist/apis/iban.cjs +6 -6
- package/dist/apis/iban.js +1 -1
- package/dist/apis/journey.cjs +6 -6
- package/dist/apis/journey.js +1 -1
- package/dist/apis/kanban.cjs +6 -6
- package/dist/apis/kanban.js +1 -1
- package/dist/apis/message.cjs +6 -6
- package/dist/apis/message.js +1 -1
- package/dist/apis/metering.cjs +6 -6
- package/dist/apis/metering.js +1 -1
- package/dist/apis/notes.cjs +6 -6
- package/dist/apis/notes.js +1 -1
- package/dist/apis/notification.cjs +6 -6
- package/dist/apis/notification.js +1 -1
- package/dist/apis/organization.cjs +6 -6
- package/dist/apis/organization.js +1 -1
- package/dist/apis/partner-directory.cjs +8 -8
- package/dist/apis/partner-directory.d.cts +2 -2
- package/dist/apis/partner-directory.d.ts +2 -2
- package/dist/apis/partner-directory.js +2 -2
- package/dist/apis/permissions.cjs +6 -6
- package/dist/apis/permissions.js +1 -1
- package/dist/apis/pricing-tier.cjs +6 -6
- package/dist/apis/pricing-tier.js +1 -1
- package/dist/apis/pricing.cjs +6 -6
- package/dist/apis/pricing.js +1 -1
- package/dist/apis/purpose.cjs +6 -6
- package/dist/apis/purpose.js +1 -1
- package/dist/apis/sandbox.cjs +6 -6
- package/dist/apis/sandbox.js +1 -1
- package/dist/apis/submission.cjs +6 -6
- package/dist/apis/submission.js +1 -1
- package/dist/apis/targeting.cjs +6 -6
- package/dist/apis/targeting.js +1 -1
- package/dist/apis/template-variables.cjs +6 -6
- package/dist/apis/template-variables.js +1 -1
- package/dist/apis/user.cjs +6 -6
- package/dist/apis/user.js +1 -1
- package/dist/apis/validation-rules.cjs +6 -6
- package/dist/apis/validation-rules.js +1 -1
- package/dist/apis/webhooks.cjs +6 -6
- package/dist/apis/webhooks.js +1 -1
- package/dist/apis/workflow-definition.cjs +6 -6
- package/dist/apis/workflow-definition.js +1 -1
- package/dist/apis/workflow.cjs +6 -6
- package/dist/apis/workflow.js +1 -1
- package/dist/bin/cli.js +1 -1
- package/dist/{chunk-F5JVW2D5.cjs → chunk-BFUNXZRX.cjs} +1 -1
- package/dist/{chunk-AUH6NP6Y.js → chunk-I2XRA5AM.js} +1 -1
- package/dist/{chunk-NBYH536J.js → chunk-QTU4H6NQ.js} +2 -2
- package/dist/{chunk-WSZWUQDD.cjs → chunk-T7LQKRUK.cjs} +2 -2
- package/dist/index.cjs +10 -10
- package/dist/index.d.cts +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +2 -2
- package/dist/{js-yaml-UPZKYVRY.js → js-yaml-DLCVPJ7G.js} +17 -15
- package/dist/partner-directory-THI7JEXK.js +7 -0
- package/dist/partner-directory-ZQIBKD5Q.cjs +7 -0
- package/dist/{partner-directory-runtime-RSONSDNJ.cjs → partner-directory-runtime-AUHVA5Q3.cjs} +2 -2
- package/dist/{partner-directory-runtime-QURDOO4Z.js → partner-directory-runtime-GNVT7U7R.js} +1 -1
- package/dist/partner-directory.d-BCIjHoGs.d.cts +2337 -0
- package/dist/partner-directory.d-BCIjHoGs.d.ts +2337 -0
- package/docs/partner-directory.md +295 -127
- package/package.json +1 -1
- package/dist/partner-directory-2XMPQWWX.js +0 -7
- package/dist/partner-directory-WHNTKQ5E.cjs +0 -7
- package/dist/partner-directory.d-CRNkDF8q.d.cts +0 -1510
- package/dist/partner-directory.d-CRNkDF8q.d.ts +0 -1510
|
@@ -0,0 +1,2337 @@
|
|
|
1
|
+
import { OpenAPIClient, Parameters, AxiosRequestConfig, OperationResponse, UnknownParamsObject } from 'openapi-client-axios';
|
|
2
|
+
|
|
3
|
+
/* Auto-copied from partner-directory-client */
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
declare namespace Components {
|
|
7
|
+
namespace Schemas {
|
|
8
|
+
/**
|
|
9
|
+
* Payload for activating a partner account using an invitation token
|
|
10
|
+
*/
|
|
11
|
+
export interface ActivatePartnerPayload {
|
|
12
|
+
/**
|
|
13
|
+
* The official name of the partner's company
|
|
14
|
+
* example:
|
|
15
|
+
* Acme Solar GmbH
|
|
16
|
+
*/
|
|
17
|
+
company_name?: string;
|
|
18
|
+
/**
|
|
19
|
+
* Email address of the user completing the partner registration
|
|
20
|
+
* example:
|
|
21
|
+
* admin@acme-solar.de
|
|
22
|
+
*/
|
|
23
|
+
signed_up_email: string; // email
|
|
24
|
+
/**
|
|
25
|
+
* The organization ID of the partner's existing epilot organization (if they already have one)
|
|
26
|
+
* example:
|
|
27
|
+
* 456
|
|
28
|
+
*/
|
|
29
|
+
organization_id: string;
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* Structured postal address
|
|
33
|
+
*/
|
|
34
|
+
export interface Address {
|
|
35
|
+
/**
|
|
36
|
+
* Street name without house number
|
|
37
|
+
* example:
|
|
38
|
+
* Auweg
|
|
39
|
+
*/
|
|
40
|
+
street?: string;
|
|
41
|
+
/**
|
|
42
|
+
* House or building number
|
|
43
|
+
* example:
|
|
44
|
+
* 10
|
|
45
|
+
*/
|
|
46
|
+
street_number?: string;
|
|
47
|
+
/**
|
|
48
|
+
* City or locality name
|
|
49
|
+
* example:
|
|
50
|
+
* Regensburg
|
|
51
|
+
*/
|
|
52
|
+
city?: string;
|
|
53
|
+
/**
|
|
54
|
+
* Postal or ZIP code
|
|
55
|
+
* example:
|
|
56
|
+
* 93055
|
|
57
|
+
*/
|
|
58
|
+
postal_code?: string;
|
|
59
|
+
/**
|
|
60
|
+
* Country code (ISO 3166-1 alpha-2)
|
|
61
|
+
* example:
|
|
62
|
+
* DE
|
|
63
|
+
*/
|
|
64
|
+
country?: string;
|
|
65
|
+
}
|
|
66
|
+
/**
|
|
67
|
+
* Combined address and geographic coordinates for a location
|
|
68
|
+
*/
|
|
69
|
+
export interface AddressGeolocation {
|
|
70
|
+
address: /* Structured postal address */ Address;
|
|
71
|
+
/**
|
|
72
|
+
* Latitude coordinate (WGS84)
|
|
73
|
+
* example:
|
|
74
|
+
* 49.013
|
|
75
|
+
*/
|
|
76
|
+
lat: number;
|
|
77
|
+
/**
|
|
78
|
+
* Longitude coordinate (WGS84)
|
|
79
|
+
* example:
|
|
80
|
+
* 12.101
|
|
81
|
+
*/
|
|
82
|
+
lng: number;
|
|
83
|
+
/**
|
|
84
|
+
* Normalized full address as returned by the geocoding service
|
|
85
|
+
* example:
|
|
86
|
+
* Auweg 1, 93055 Regensburg, Germany
|
|
87
|
+
*/
|
|
88
|
+
addressLabel?: string;
|
|
89
|
+
/**
|
|
90
|
+
* Confidence score for the geocoding result (0-1).
|
|
91
|
+
* Values closer to 1 indicate higher confidence that the coordinates match the input address.
|
|
92
|
+
*
|
|
93
|
+
* example:
|
|
94
|
+
* 0.95
|
|
95
|
+
*/
|
|
96
|
+
relevance?: number;
|
|
97
|
+
}
|
|
98
|
+
/**
|
|
99
|
+
* Request payload for assigning or unassigning roles to/from a user
|
|
100
|
+
*/
|
|
101
|
+
export interface AssignRolesPayload {
|
|
102
|
+
/**
|
|
103
|
+
* Array of role IDs to assign or unassign
|
|
104
|
+
* example:
|
|
105
|
+
* [
|
|
106
|
+
* "123:partner_admin",
|
|
107
|
+
* "123:partner_viewer"
|
|
108
|
+
* ]
|
|
109
|
+
*/
|
|
110
|
+
roleIds: string[];
|
|
111
|
+
}
|
|
112
|
+
/**
|
|
113
|
+
* A user, organization, or group that can be assigned to tasks, workflows, or entities.
|
|
114
|
+
* The `type` field discriminates between different assignable types.
|
|
115
|
+
*
|
|
116
|
+
*/
|
|
117
|
+
export type Assignable = /**
|
|
118
|
+
* A user, organization, or group that can be assigned to tasks, workflows, or entities.
|
|
119
|
+
* The `type` field discriminates between different assignable types.
|
|
120
|
+
*
|
|
121
|
+
*/
|
|
122
|
+
/* A user within the caller's organization that can be assigned to tasks or entities */ AssignableUser | /* A user from a partner organization that can be assigned to shared tasks or entities */ AssignablePartnerUser | /**
|
|
123
|
+
* A partner organization that can be assigned to tasks or entities at the organization level.
|
|
124
|
+
* Useful when you want to assign work to a partner company rather than a specific individual.
|
|
125
|
+
*
|
|
126
|
+
*/
|
|
127
|
+
AssignableOrganization | /**
|
|
128
|
+
* An End Customer Portal (ECP) user that can be assigned to tasks or entities.
|
|
129
|
+
* These are external users who access the system through the customer portal.
|
|
130
|
+
*
|
|
131
|
+
*/
|
|
132
|
+
AssignableEcpPlaceholder | /* A user group that can be assigned to tasks or entities. All members of the group will be notified/assigned. */ AssignableGroup;
|
|
133
|
+
/**
|
|
134
|
+
* An End Customer Portal (ECP) user that can be assigned to tasks or entities.
|
|
135
|
+
* These are external users who access the system through the customer portal.
|
|
136
|
+
*
|
|
137
|
+
*/
|
|
138
|
+
export interface AssignableEcpPlaceholder {
|
|
139
|
+
/**
|
|
140
|
+
* Discriminator field indicating the type of assignable
|
|
141
|
+
* example:
|
|
142
|
+
* ecp
|
|
143
|
+
*/
|
|
144
|
+
type: "ecp";
|
|
145
|
+
/**
|
|
146
|
+
* Name of the portal user
|
|
147
|
+
* example:
|
|
148
|
+
* Max Mustermann
|
|
149
|
+
*/
|
|
150
|
+
display_name: string;
|
|
151
|
+
/**
|
|
152
|
+
* Profile image URLs for the assignable
|
|
153
|
+
*/
|
|
154
|
+
image_uri?: {
|
|
155
|
+
/**
|
|
156
|
+
* Full-resolution profile image URL
|
|
157
|
+
* example:
|
|
158
|
+
* https://epilot-staging-user-content.s3.eu-central-1.amazonaws.com/728/8043d909-71fc-4838-a363-1b15dc1d585c/epilot.png
|
|
159
|
+
*/
|
|
160
|
+
original: string; // uri
|
|
161
|
+
/**
|
|
162
|
+
* 32x32 pixel thumbnail image URL for compact displays
|
|
163
|
+
* example:
|
|
164
|
+
* https://file.sls.epilot.io/v1/files/public/preview?w=32&h=32&key=/728/8043d909-71fc-4838-a363-1b15dc1d585c/epilot.png
|
|
165
|
+
*/
|
|
166
|
+
thumbnail_32?: string; // uri
|
|
167
|
+
};
|
|
168
|
+
/**
|
|
169
|
+
* Organization ID the assignable belongs to
|
|
170
|
+
* example:
|
|
171
|
+
* 123
|
|
172
|
+
*/
|
|
173
|
+
org_id: string;
|
|
174
|
+
/**
|
|
175
|
+
* Timestamp when the assignable was created
|
|
176
|
+
* example:
|
|
177
|
+
* 2022-02-08T04:44:32.246Z
|
|
178
|
+
*/
|
|
179
|
+
created_at?: string; // date-time
|
|
180
|
+
/**
|
|
181
|
+
* Timestamp when the assignable was activated (for users, when they accepted their invitation)
|
|
182
|
+
* example:
|
|
183
|
+
* 2022-02-08T04:44:32.246Z
|
|
184
|
+
*/
|
|
185
|
+
activated_at?: string; // date-time
|
|
186
|
+
/**
|
|
187
|
+
* Current status of the assignable
|
|
188
|
+
*/
|
|
189
|
+
status?: "Active" | "Pending" | "Deactivated" | "Deleted";
|
|
190
|
+
/**
|
|
191
|
+
* Unique identifier of the portal user
|
|
192
|
+
* example:
|
|
193
|
+
* ecp-456
|
|
194
|
+
*/
|
|
195
|
+
user_id: string;
|
|
196
|
+
/**
|
|
197
|
+
* Email address of the portal user
|
|
198
|
+
* example:
|
|
199
|
+
* max.mustermann@customer.de
|
|
200
|
+
*/
|
|
201
|
+
email?: string; // email
|
|
202
|
+
}
|
|
203
|
+
/**
|
|
204
|
+
* A user group that can be assigned to tasks or entities. All members of the group will be notified/assigned.
|
|
205
|
+
*/
|
|
206
|
+
export interface AssignableGroup {
|
|
207
|
+
/**
|
|
208
|
+
* Discriminator field indicating the type of assignable
|
|
209
|
+
* example:
|
|
210
|
+
* group
|
|
211
|
+
*/
|
|
212
|
+
type: "group";
|
|
213
|
+
/**
|
|
214
|
+
* Human-readable name for display in UI (user name, organization name, or group name)
|
|
215
|
+
* example:
|
|
216
|
+
* John Smith
|
|
217
|
+
*/
|
|
218
|
+
display_name: string;
|
|
219
|
+
/**
|
|
220
|
+
* Profile image URLs for the assignable
|
|
221
|
+
*/
|
|
222
|
+
image_uri?: {
|
|
223
|
+
/**
|
|
224
|
+
* Full-resolution profile image URL
|
|
225
|
+
* example:
|
|
226
|
+
* https://epilot-staging-user-content.s3.eu-central-1.amazonaws.com/728/8043d909-71fc-4838-a363-1b15dc1d585c/epilot.png
|
|
227
|
+
*/
|
|
228
|
+
original: string; // uri
|
|
229
|
+
/**
|
|
230
|
+
* 32x32 pixel thumbnail image URL for compact displays
|
|
231
|
+
* example:
|
|
232
|
+
* https://file.sls.epilot.io/v1/files/public/preview?w=32&h=32&key=/728/8043d909-71fc-4838-a363-1b15dc1d585c/epilot.png
|
|
233
|
+
*/
|
|
234
|
+
thumbnail_32?: string; // uri
|
|
235
|
+
};
|
|
236
|
+
/**
|
|
237
|
+
* Organization ID the assignable belongs to
|
|
238
|
+
* example:
|
|
239
|
+
* 123
|
|
240
|
+
*/
|
|
241
|
+
org_id: string;
|
|
242
|
+
/**
|
|
243
|
+
* Timestamp when the assignable was created
|
|
244
|
+
* example:
|
|
245
|
+
* 2022-02-08T04:44:32.246Z
|
|
246
|
+
*/
|
|
247
|
+
created_at?: string; // date-time
|
|
248
|
+
/**
|
|
249
|
+
* Timestamp when the assignable was activated (for users, when they accepted their invitation)
|
|
250
|
+
* example:
|
|
251
|
+
* 2022-02-08T04:44:32.246Z
|
|
252
|
+
*/
|
|
253
|
+
activated_at?: string; // date-time
|
|
254
|
+
/**
|
|
255
|
+
* Current status of the assignable
|
|
256
|
+
*/
|
|
257
|
+
status?: "Active" | "Pending" | "Deactivated" | "Deleted";
|
|
258
|
+
/**
|
|
259
|
+
* Unique identifier of the user group
|
|
260
|
+
* example:
|
|
261
|
+
* group-456
|
|
262
|
+
*/
|
|
263
|
+
group_id?: string;
|
|
264
|
+
}
|
|
265
|
+
/**
|
|
266
|
+
* A partner organization that can be assigned to tasks or entities at the organization level.
|
|
267
|
+
* Useful when you want to assign work to a partner company rather than a specific individual.
|
|
268
|
+
*
|
|
269
|
+
*/
|
|
270
|
+
export interface AssignableOrganization {
|
|
271
|
+
/**
|
|
272
|
+
* Discriminator field indicating the type of assignable
|
|
273
|
+
* example:
|
|
274
|
+
* partner_organization
|
|
275
|
+
*/
|
|
276
|
+
type: "partner_organization";
|
|
277
|
+
/**
|
|
278
|
+
* Name of the partner organization
|
|
279
|
+
* example:
|
|
280
|
+
* Acme Solar GmbH
|
|
281
|
+
*/
|
|
282
|
+
display_name: string;
|
|
283
|
+
/**
|
|
284
|
+
* Profile image URLs for the assignable
|
|
285
|
+
*/
|
|
286
|
+
image_uri?: {
|
|
287
|
+
/**
|
|
288
|
+
* Full-resolution profile image URL
|
|
289
|
+
* example:
|
|
290
|
+
* https://epilot-staging-user-content.s3.eu-central-1.amazonaws.com/728/8043d909-71fc-4838-a363-1b15dc1d585c/epilot.png
|
|
291
|
+
*/
|
|
292
|
+
original: string; // uri
|
|
293
|
+
/**
|
|
294
|
+
* 32x32 pixel thumbnail image URL for compact displays
|
|
295
|
+
* example:
|
|
296
|
+
* https://file.sls.epilot.io/v1/files/public/preview?w=32&h=32&key=/728/8043d909-71fc-4838-a363-1b15dc1d585c/epilot.png
|
|
297
|
+
*/
|
|
298
|
+
thumbnail_32?: string; // uri
|
|
299
|
+
};
|
|
300
|
+
/**
|
|
301
|
+
* Organization ID the assignable belongs to
|
|
302
|
+
* example:
|
|
303
|
+
* 123
|
|
304
|
+
*/
|
|
305
|
+
org_id: string;
|
|
306
|
+
/**
|
|
307
|
+
* Timestamp when the assignable was created
|
|
308
|
+
* example:
|
|
309
|
+
* 2022-02-08T04:44:32.246Z
|
|
310
|
+
*/
|
|
311
|
+
created_at?: string; // date-time
|
|
312
|
+
/**
|
|
313
|
+
* Timestamp when the assignable was activated (for users, when they accepted their invitation)
|
|
314
|
+
* example:
|
|
315
|
+
* 2022-02-08T04:44:32.246Z
|
|
316
|
+
*/
|
|
317
|
+
activated_at?: string; // date-time
|
|
318
|
+
/**
|
|
319
|
+
* Current status of the assignable
|
|
320
|
+
*/
|
|
321
|
+
status?: "Active" | "Pending" | "Deactivated" | "Deleted";
|
|
322
|
+
/**
|
|
323
|
+
* ID of the partner relationship
|
|
324
|
+
* example:
|
|
325
|
+
* e45a6dc2-3795-43a3-ae0f-6b6760f310fc
|
|
326
|
+
*/
|
|
327
|
+
partner_id: string;
|
|
328
|
+
/**
|
|
329
|
+
* Primary contact email for the partner organization
|
|
330
|
+
* example:
|
|
331
|
+
* contact@acme-solar.de
|
|
332
|
+
*/
|
|
333
|
+
email?: string; // email
|
|
334
|
+
/**
|
|
335
|
+
* Physical locations of the partner organization with addresses and coordinates
|
|
336
|
+
*/
|
|
337
|
+
geolocations?: /* Combined address and geographic coordinates for a location */ AddressGeolocation[];
|
|
338
|
+
/**
|
|
339
|
+
* Primary contact phone number for the partner organization
|
|
340
|
+
* example:
|
|
341
|
+
* +49 941 123456
|
|
342
|
+
*/
|
|
343
|
+
phone?: string;
|
|
344
|
+
/**
|
|
345
|
+
* Geographic service radius in kilometers - the area within which the partner operates
|
|
346
|
+
* example:
|
|
347
|
+
* 50
|
|
348
|
+
*/
|
|
349
|
+
activity_radius?: number;
|
|
350
|
+
}
|
|
351
|
+
/**
|
|
352
|
+
* A user from a partner organization that can be assigned to shared tasks or entities
|
|
353
|
+
*/
|
|
354
|
+
export interface AssignablePartnerUser {
|
|
355
|
+
/**
|
|
356
|
+
* Discriminator field indicating the type of assignable
|
|
357
|
+
* example:
|
|
358
|
+
* partner_user
|
|
359
|
+
*/
|
|
360
|
+
type: "partner_user";
|
|
361
|
+
/**
|
|
362
|
+
* Full name of the partner user
|
|
363
|
+
* example:
|
|
364
|
+
* Jane Doe (Partner)
|
|
365
|
+
*/
|
|
366
|
+
display_name: string;
|
|
367
|
+
/**
|
|
368
|
+
* Profile image URLs for the assignable
|
|
369
|
+
*/
|
|
370
|
+
image_uri?: {
|
|
371
|
+
/**
|
|
372
|
+
* Full-resolution profile image URL
|
|
373
|
+
* example:
|
|
374
|
+
* https://epilot-staging-user-content.s3.eu-central-1.amazonaws.com/728/8043d909-71fc-4838-a363-1b15dc1d585c/epilot.png
|
|
375
|
+
*/
|
|
376
|
+
original: string; // uri
|
|
377
|
+
/**
|
|
378
|
+
* 32x32 pixel thumbnail image URL for compact displays
|
|
379
|
+
* example:
|
|
380
|
+
* https://file.sls.epilot.io/v1/files/public/preview?w=32&h=32&key=/728/8043d909-71fc-4838-a363-1b15dc1d585c/epilot.png
|
|
381
|
+
*/
|
|
382
|
+
thumbnail_32?: string; // uri
|
|
383
|
+
};
|
|
384
|
+
/**
|
|
385
|
+
* Organization ID the assignable belongs to
|
|
386
|
+
* example:
|
|
387
|
+
* 123
|
|
388
|
+
*/
|
|
389
|
+
org_id: string;
|
|
390
|
+
/**
|
|
391
|
+
* Timestamp when the assignable was created
|
|
392
|
+
* example:
|
|
393
|
+
* 2022-02-08T04:44:32.246Z
|
|
394
|
+
*/
|
|
395
|
+
created_at?: string; // date-time
|
|
396
|
+
/**
|
|
397
|
+
* Timestamp when the assignable was activated (for users, when they accepted their invitation)
|
|
398
|
+
* example:
|
|
399
|
+
* 2022-02-08T04:44:32.246Z
|
|
400
|
+
*/
|
|
401
|
+
activated_at?: string; // date-time
|
|
402
|
+
/**
|
|
403
|
+
* Current status of the assignable
|
|
404
|
+
*/
|
|
405
|
+
status?: "Active" | "Pending" | "Deactivated" | "Deleted";
|
|
406
|
+
/**
|
|
407
|
+
* ID of the partner relationship through which this user is accessible
|
|
408
|
+
* example:
|
|
409
|
+
* e45a6dc2-3795-43a3-ae0f-6b6760f310fc
|
|
410
|
+
*/
|
|
411
|
+
partner_id?: string;
|
|
412
|
+
/**
|
|
413
|
+
* Unique identifier of the partner user
|
|
414
|
+
* example:
|
|
415
|
+
* 789
|
|
416
|
+
*/
|
|
417
|
+
user_id?: string;
|
|
418
|
+
/**
|
|
419
|
+
* Email address of the partner user
|
|
420
|
+
* example:
|
|
421
|
+
* jane.doe@partner.com
|
|
422
|
+
*/
|
|
423
|
+
email?: string; // email
|
|
424
|
+
}
|
|
425
|
+
/**
|
|
426
|
+
* A user within the caller's organization that can be assigned to tasks or entities
|
|
427
|
+
*/
|
|
428
|
+
export interface AssignableUser {
|
|
429
|
+
/**
|
|
430
|
+
* Discriminator field indicating the type of assignable
|
|
431
|
+
* example:
|
|
432
|
+
* user
|
|
433
|
+
*/
|
|
434
|
+
type: "user";
|
|
435
|
+
/**
|
|
436
|
+
* Full name of the user
|
|
437
|
+
* example:
|
|
438
|
+
* John Smith
|
|
439
|
+
*/
|
|
440
|
+
display_name: string;
|
|
441
|
+
/**
|
|
442
|
+
* Profile image URLs for the assignable
|
|
443
|
+
*/
|
|
444
|
+
image_uri?: {
|
|
445
|
+
/**
|
|
446
|
+
* Full-resolution profile image URL
|
|
447
|
+
* example:
|
|
448
|
+
* https://epilot-staging-user-content.s3.eu-central-1.amazonaws.com/728/8043d909-71fc-4838-a363-1b15dc1d585c/epilot.png
|
|
449
|
+
*/
|
|
450
|
+
original: string; // uri
|
|
451
|
+
/**
|
|
452
|
+
* 32x32 pixel thumbnail image URL for compact displays
|
|
453
|
+
* example:
|
|
454
|
+
* https://file.sls.epilot.io/v1/files/public/preview?w=32&h=32&key=/728/8043d909-71fc-4838-a363-1b15dc1d585c/epilot.png
|
|
455
|
+
*/
|
|
456
|
+
thumbnail_32?: string; // uri
|
|
457
|
+
};
|
|
458
|
+
/**
|
|
459
|
+
* Organization ID the assignable belongs to
|
|
460
|
+
* example:
|
|
461
|
+
* 123
|
|
462
|
+
*/
|
|
463
|
+
org_id: string;
|
|
464
|
+
/**
|
|
465
|
+
* Timestamp when the assignable was created
|
|
466
|
+
* example:
|
|
467
|
+
* 2022-02-08T04:44:32.246Z
|
|
468
|
+
*/
|
|
469
|
+
created_at?: string; // date-time
|
|
470
|
+
/**
|
|
471
|
+
* Timestamp when the assignable was activated (for users, when they accepted their invitation)
|
|
472
|
+
* example:
|
|
473
|
+
* 2022-02-08T04:44:32.246Z
|
|
474
|
+
*/
|
|
475
|
+
activated_at?: string; // date-time
|
|
476
|
+
/**
|
|
477
|
+
* Current status of the assignable
|
|
478
|
+
*/
|
|
479
|
+
status?: "Active" | "Pending" | "Deactivated" | "Deleted";
|
|
480
|
+
/**
|
|
481
|
+
* Unique identifier of the user
|
|
482
|
+
* example:
|
|
483
|
+
* 456
|
|
484
|
+
*/
|
|
485
|
+
user_id?: string;
|
|
486
|
+
/**
|
|
487
|
+
* Email address of the user
|
|
488
|
+
* example:
|
|
489
|
+
* john.smith@example.com
|
|
490
|
+
*/
|
|
491
|
+
email?: string; // email
|
|
492
|
+
}
|
|
493
|
+
/**
|
|
494
|
+
* Common properties shared by all assignable types
|
|
495
|
+
*/
|
|
496
|
+
export interface BaseAssignable {
|
|
497
|
+
/**
|
|
498
|
+
* Discriminator field indicating the type of assignable
|
|
499
|
+
* example:
|
|
500
|
+
* user
|
|
501
|
+
*/
|
|
502
|
+
type: string;
|
|
503
|
+
/**
|
|
504
|
+
* Human-readable name for display in UI (user name, organization name, or group name)
|
|
505
|
+
* example:
|
|
506
|
+
* John Smith
|
|
507
|
+
*/
|
|
508
|
+
display_name: string;
|
|
509
|
+
/**
|
|
510
|
+
* Profile image URLs for the assignable
|
|
511
|
+
*/
|
|
512
|
+
image_uri?: {
|
|
513
|
+
/**
|
|
514
|
+
* Full-resolution profile image URL
|
|
515
|
+
* example:
|
|
516
|
+
* https://epilot-staging-user-content.s3.eu-central-1.amazonaws.com/728/8043d909-71fc-4838-a363-1b15dc1d585c/epilot.png
|
|
517
|
+
*/
|
|
518
|
+
original: string; // uri
|
|
519
|
+
/**
|
|
520
|
+
* 32x32 pixel thumbnail image URL for compact displays
|
|
521
|
+
* example:
|
|
522
|
+
* https://file.sls.epilot.io/v1/files/public/preview?w=32&h=32&key=/728/8043d909-71fc-4838-a363-1b15dc1d585c/epilot.png
|
|
523
|
+
*/
|
|
524
|
+
thumbnail_32?: string; // uri
|
|
525
|
+
};
|
|
526
|
+
/**
|
|
527
|
+
* Organization ID the assignable belongs to
|
|
528
|
+
* example:
|
|
529
|
+
* 123
|
|
530
|
+
*/
|
|
531
|
+
org_id: string;
|
|
532
|
+
/**
|
|
533
|
+
* Timestamp when the assignable was created
|
|
534
|
+
* example:
|
|
535
|
+
* 2022-02-08T04:44:32.246Z
|
|
536
|
+
*/
|
|
537
|
+
created_at?: string; // date-time
|
|
538
|
+
/**
|
|
539
|
+
* Timestamp when the assignable was activated (for users, when they accepted their invitation)
|
|
540
|
+
* example:
|
|
541
|
+
* 2022-02-08T04:44:32.246Z
|
|
542
|
+
*/
|
|
543
|
+
activated_at?: string; // date-time
|
|
544
|
+
/**
|
|
545
|
+
* Current status of the assignable
|
|
546
|
+
*/
|
|
547
|
+
status?: "Active" | "Pending" | "Deactivated" | "Deleted";
|
|
548
|
+
}
|
|
549
|
+
/**
|
|
550
|
+
* Base schema for creating or updating a role
|
|
551
|
+
*/
|
|
552
|
+
export interface BaseRoleForCreate {
|
|
553
|
+
id?: /**
|
|
554
|
+
* Unique identifier for a role, combining organization ID and role slug.
|
|
555
|
+
* Format: <organization_id>:<slug>
|
|
556
|
+
*
|
|
557
|
+
* example:
|
|
558
|
+
* 123:owner
|
|
559
|
+
*/
|
|
560
|
+
RoleId;
|
|
561
|
+
/**
|
|
562
|
+
* Human-readable display name for the role
|
|
563
|
+
* example:
|
|
564
|
+
* Owner
|
|
565
|
+
*/
|
|
566
|
+
name: string;
|
|
567
|
+
/**
|
|
568
|
+
* URL-friendly identifier for the role (lowercase, no spaces)
|
|
569
|
+
* example:
|
|
570
|
+
* owner
|
|
571
|
+
*/
|
|
572
|
+
slug: string; // ^[a-z][a-z0-9_]*$
|
|
573
|
+
/**
|
|
574
|
+
* List of permission grants that define what users with this role can do
|
|
575
|
+
*/
|
|
576
|
+
grants: /**
|
|
577
|
+
* A permission grant that allows or denies a specific action on a resource.
|
|
578
|
+
*
|
|
579
|
+
* Grants are the building blocks of roles and define what users can do within the system.
|
|
580
|
+
*
|
|
581
|
+
*/
|
|
582
|
+
Grant[];
|
|
583
|
+
}
|
|
584
|
+
/**
|
|
585
|
+
* Request payload for creating a new role in a partner organization
|
|
586
|
+
*/
|
|
587
|
+
export interface CreatePartnerRolePayload {
|
|
588
|
+
/**
|
|
589
|
+
* Human-readable display name for the role
|
|
590
|
+
* example:
|
|
591
|
+
* Partner Administrator
|
|
592
|
+
*/
|
|
593
|
+
name: string;
|
|
594
|
+
/**
|
|
595
|
+
* URL-friendly identifier for the role (lowercase, underscores allowed)
|
|
596
|
+
* example:
|
|
597
|
+
* partner_admin
|
|
598
|
+
*/
|
|
599
|
+
slug: string; // ^[a-z][a-z0-9_]*$
|
|
600
|
+
/**
|
|
601
|
+
* Permission grants that define what users with this role can do.
|
|
602
|
+
* Each grant specifies an action and resource pattern.
|
|
603
|
+
*
|
|
604
|
+
*/
|
|
605
|
+
grants: /* A grant with optional dependent grants that are automatically included when this grant is assigned */ GrantWithDependencies[];
|
|
606
|
+
}
|
|
607
|
+
/**
|
|
608
|
+
* Request payload for creating a new user in a partner organization
|
|
609
|
+
*/
|
|
610
|
+
export interface CreatePartnerUserPayload {
|
|
611
|
+
/**
|
|
612
|
+
* Email address for the new user. An invitation will be sent to this address.
|
|
613
|
+
* example:
|
|
614
|
+
* newuser@partner.com
|
|
615
|
+
*/
|
|
616
|
+
email: string; // email
|
|
617
|
+
/**
|
|
618
|
+
* Preferred language for the user. Determines the language of the invitation email and default UI language.
|
|
619
|
+
* example:
|
|
620
|
+
* de
|
|
621
|
+
*/
|
|
622
|
+
language?: "en" | "de";
|
|
623
|
+
/**
|
|
624
|
+
* Role IDs to automatically assign to the user upon creation.
|
|
625
|
+
* If not provided, the user will have no roles until manually assigned.
|
|
626
|
+
*
|
|
627
|
+
* example:
|
|
628
|
+
* [
|
|
629
|
+
* "123:partner_viewer"
|
|
630
|
+
* ]
|
|
631
|
+
*/
|
|
632
|
+
roles?: string[];
|
|
633
|
+
}
|
|
634
|
+
/**
|
|
635
|
+
* A condition that checks if an attribute equals one of the specified values.
|
|
636
|
+
* The grant only applies when the condition is satisfied.
|
|
637
|
+
*
|
|
638
|
+
*/
|
|
639
|
+
export interface EqualsCondition {
|
|
640
|
+
/**
|
|
641
|
+
* The attribute path to check (dot notation for nested attributes).
|
|
642
|
+
* Example: workflows.primary.task_name checks the task name in the primary workflow.
|
|
643
|
+
*
|
|
644
|
+
* example:
|
|
645
|
+
* workflows.primary.task_name
|
|
646
|
+
*/
|
|
647
|
+
attribute: string;
|
|
648
|
+
/**
|
|
649
|
+
* The comparison operation to perform
|
|
650
|
+
*/
|
|
651
|
+
operation: "equals";
|
|
652
|
+
/**
|
|
653
|
+
* List of values to match against - the condition is true if the attribute equals any of these values
|
|
654
|
+
*/
|
|
655
|
+
values: string[];
|
|
656
|
+
}
|
|
657
|
+
/**
|
|
658
|
+
* Geographic coordinates with optional metadata
|
|
659
|
+
*/
|
|
660
|
+
export interface Geolocation {
|
|
661
|
+
/**
|
|
662
|
+
* Latitude coordinate (WGS84)
|
|
663
|
+
* example:
|
|
664
|
+
* 49.013
|
|
665
|
+
*/
|
|
666
|
+
lat: number;
|
|
667
|
+
/**
|
|
668
|
+
* Longitude coordinate (WGS84)
|
|
669
|
+
* example:
|
|
670
|
+
* 12.101
|
|
671
|
+
*/
|
|
672
|
+
lng: number;
|
|
673
|
+
/**
|
|
674
|
+
* Normalized full address as returned by the geocoding service
|
|
675
|
+
* example:
|
|
676
|
+
* Auweg 1, 93055 Regensburg, Germany
|
|
677
|
+
*/
|
|
678
|
+
addressLabel?: string;
|
|
679
|
+
/**
|
|
680
|
+
* Confidence score for the geocoding result (0-1).
|
|
681
|
+
* Values closer to 1 indicate higher confidence that the coordinates match the input address.
|
|
682
|
+
*
|
|
683
|
+
* example:
|
|
684
|
+
* 0.95
|
|
685
|
+
*/
|
|
686
|
+
relevance?: number;
|
|
687
|
+
}
|
|
688
|
+
/**
|
|
689
|
+
* A permission grant that allows or denies a specific action on a resource.
|
|
690
|
+
*
|
|
691
|
+
* Grants are the building blocks of roles and define what users can do within the system.
|
|
692
|
+
*
|
|
693
|
+
*/
|
|
694
|
+
export interface Grant {
|
|
695
|
+
/**
|
|
696
|
+
* The action being granted or denied.
|
|
697
|
+
* Common actions include: entity-read, entity-create, entity-update, entity-delete
|
|
698
|
+
*
|
|
699
|
+
* example:
|
|
700
|
+
* entity-read
|
|
701
|
+
*/
|
|
702
|
+
action: string;
|
|
703
|
+
/**
|
|
704
|
+
* The resource pattern this grant applies to.
|
|
705
|
+
* Format: entity:<org_id>:<schema>:<entity_id>
|
|
706
|
+
* Use wildcards (*) to match multiple resources.
|
|
707
|
+
*
|
|
708
|
+
* example:
|
|
709
|
+
* entity:123:contact:*
|
|
710
|
+
*/
|
|
711
|
+
resource?: string;
|
|
712
|
+
/**
|
|
713
|
+
* Whether this grant allows or denies the action
|
|
714
|
+
*/
|
|
715
|
+
effect?: "allow" | "deny";
|
|
716
|
+
/**
|
|
717
|
+
* Additional conditions that must be met for this grant to apply
|
|
718
|
+
*/
|
|
719
|
+
conditions?: /**
|
|
720
|
+
* An additional condition that must be met for a grant to apply.
|
|
721
|
+
* Conditions allow fine-grained control over when permissions are active.
|
|
722
|
+
*
|
|
723
|
+
*/
|
|
724
|
+
GrantCondition[];
|
|
725
|
+
}
|
|
726
|
+
/**
|
|
727
|
+
* An additional condition that must be met for a grant to apply.
|
|
728
|
+
* Conditions allow fine-grained control over when permissions are active.
|
|
729
|
+
*
|
|
730
|
+
*/
|
|
731
|
+
export type GrantCondition = /**
|
|
732
|
+
* An additional condition that must be met for a grant to apply.
|
|
733
|
+
* Conditions allow fine-grained control over when permissions are active.
|
|
734
|
+
*
|
|
735
|
+
*/
|
|
736
|
+
/**
|
|
737
|
+
* A condition that checks if an attribute equals one of the specified values.
|
|
738
|
+
* The grant only applies when the condition is satisfied.
|
|
739
|
+
*
|
|
740
|
+
*/
|
|
741
|
+
EqualsCondition;
|
|
742
|
+
/**
|
|
743
|
+
* A grant with optional dependent grants that are automatically included when this grant is assigned
|
|
744
|
+
*/
|
|
745
|
+
export interface GrantWithDependencies {
|
|
746
|
+
/**
|
|
747
|
+
* The action being granted or denied.
|
|
748
|
+
* Common actions include: entity-read, entity-create, entity-update, entity-delete
|
|
749
|
+
*
|
|
750
|
+
* example:
|
|
751
|
+
* entity-read
|
|
752
|
+
*/
|
|
753
|
+
action: string;
|
|
754
|
+
/**
|
|
755
|
+
* The resource pattern this grant applies to.
|
|
756
|
+
* Format: entity:<org_id>:<schema>:<entity_id>
|
|
757
|
+
* Use wildcards (*) to match multiple resources.
|
|
758
|
+
*
|
|
759
|
+
* example:
|
|
760
|
+
* entity:123:contact:*
|
|
761
|
+
*/
|
|
762
|
+
resource?: string;
|
|
763
|
+
/**
|
|
764
|
+
* Whether this grant allows or denies the action
|
|
765
|
+
*/
|
|
766
|
+
effect?: "allow" | "deny";
|
|
767
|
+
/**
|
|
768
|
+
* Additional conditions that must be met for this grant to apply
|
|
769
|
+
*/
|
|
770
|
+
conditions?: /**
|
|
771
|
+
* An additional condition that must be met for a grant to apply.
|
|
772
|
+
* Conditions allow fine-grained control over when permissions are active.
|
|
773
|
+
*
|
|
774
|
+
*/
|
|
775
|
+
GrantCondition[];
|
|
776
|
+
/**
|
|
777
|
+
* Additional grants that are automatically included when this grant is assigned.
|
|
778
|
+
* Dependencies are expanded and stored with the role to ensure users have all
|
|
779
|
+
* necessary permissions for the primary action.
|
|
780
|
+
*
|
|
781
|
+
*/
|
|
782
|
+
dependencies?: /**
|
|
783
|
+
* A permission grant that allows or denies a specific action on a resource.
|
|
784
|
+
*
|
|
785
|
+
* Grants are the building blocks of roles and define what users can do within the system.
|
|
786
|
+
*
|
|
787
|
+
*/
|
|
788
|
+
Grant[];
|
|
789
|
+
}
|
|
790
|
+
/**
|
|
791
|
+
* A secure token used for partner invitation and activation. Sent via email to the invited partner.
|
|
792
|
+
* example:
|
|
793
|
+
* eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXJ0bmVySWQiOiIxMjM0NSJ9.abcdef
|
|
794
|
+
*/
|
|
795
|
+
export type InviteToken = string;
|
|
796
|
+
/**
|
|
797
|
+
* Unique identifier for an organization in the epilot platform
|
|
798
|
+
* example:
|
|
799
|
+
* 123
|
|
800
|
+
*/
|
|
801
|
+
export type OrganizationId = string;
|
|
802
|
+
/**
|
|
803
|
+
* Represents a partner organization in the partner directory.
|
|
804
|
+
*
|
|
805
|
+
* Partners go through a lifecycle from invitation to active collaboration:
|
|
806
|
+
* - **Pending**: Initial state when partner record is created
|
|
807
|
+
* - **Invited**: Invitation email has been sent to the partner
|
|
808
|
+
* - **Request**: Partner has requested to join (self-registration)
|
|
809
|
+
* - **Rejected**: Partnership request was declined
|
|
810
|
+
* - **Deleted**: Partner relationship has been terminated
|
|
811
|
+
*
|
|
812
|
+
*/
|
|
813
|
+
export interface Partner {
|
|
814
|
+
id?: /**
|
|
815
|
+
* Unique identifier for a partner record (UUID format)
|
|
816
|
+
* example:
|
|
817
|
+
* e45a6dc2-3795-43a3-ae0f-6b6760f310fc
|
|
818
|
+
*/
|
|
819
|
+
PartnerId;
|
|
820
|
+
/**
|
|
821
|
+
* The organization ID of the parent organization that invited this partner
|
|
822
|
+
* example:
|
|
823
|
+
* 123
|
|
824
|
+
*/
|
|
825
|
+
organization_id?: string;
|
|
826
|
+
/**
|
|
827
|
+
* Timestamp when the partner record was created
|
|
828
|
+
* example:
|
|
829
|
+
* 2022-02-08T04:44:32.246Z
|
|
830
|
+
*/
|
|
831
|
+
created_at?: string; // date-time
|
|
832
|
+
/**
|
|
833
|
+
* Optional description of the partner or partnership
|
|
834
|
+
* example:
|
|
835
|
+
* Regional solar installation partner for Bavaria
|
|
836
|
+
*/
|
|
837
|
+
description?: string;
|
|
838
|
+
/**
|
|
839
|
+
* The legal or trading name of the partner organization
|
|
840
|
+
* example:
|
|
841
|
+
* Acme Solar GmbH
|
|
842
|
+
*/
|
|
843
|
+
company_name?: string;
|
|
844
|
+
/**
|
|
845
|
+
* Secure token for partner activation (only present for invited partners)
|
|
846
|
+
* example:
|
|
847
|
+
* eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
|
|
848
|
+
*/
|
|
849
|
+
invitation_token?: string;
|
|
850
|
+
/**
|
|
851
|
+
* Deprecated: Use 'email' instead. Email address used for the invitation.
|
|
852
|
+
*/
|
|
853
|
+
invitation_email?: string; // email
|
|
854
|
+
/**
|
|
855
|
+
* Primary email address of the partner, used for invitation delivery
|
|
856
|
+
* example:
|
|
857
|
+
* contact@acme-solar.de
|
|
858
|
+
*/
|
|
859
|
+
email?: string; // email
|
|
860
|
+
/**
|
|
861
|
+
* Alternative email address where invitations should be sent (e.g., owner or admin email)
|
|
862
|
+
* example:
|
|
863
|
+
* owner@acme-solar.de
|
|
864
|
+
*/
|
|
865
|
+
owner_email?: string; // email
|
|
866
|
+
/**
|
|
867
|
+
* Email address used by the partner when completing registration
|
|
868
|
+
* example:
|
|
869
|
+
* admin@acme-solar.de
|
|
870
|
+
*/
|
|
871
|
+
signed_up_email?: string; // email
|
|
872
|
+
/**
|
|
873
|
+
* Organization ID of the partner organization (populated after activation)
|
|
874
|
+
* example:
|
|
875
|
+
* 456789
|
|
876
|
+
*/
|
|
877
|
+
partner_org_id?: string;
|
|
878
|
+
/**
|
|
879
|
+
* Current status of the partner in the invitation/collaboration lifecycle
|
|
880
|
+
*/
|
|
881
|
+
status?: "Pending" | "Request" | "Deleted" | "Invited" | "Rejected";
|
|
882
|
+
}
|
|
883
|
+
/**
|
|
884
|
+
* Unique identifier for a partner record (UUID format)
|
|
885
|
+
* example:
|
|
886
|
+
* e45a6dc2-3795-43a3-ae0f-6b6760f310fc
|
|
887
|
+
*/
|
|
888
|
+
export type PartnerId = string;
|
|
889
|
+
/**
|
|
890
|
+
* Configuration options for sending a partner invitation
|
|
891
|
+
*/
|
|
892
|
+
export interface PartnerInvitationPayload {
|
|
893
|
+
/**
|
|
894
|
+
* Language for the partner invitation email. Determines the email template language.
|
|
895
|
+
* example:
|
|
896
|
+
* de
|
|
897
|
+
*/
|
|
898
|
+
language?: "en" | "de";
|
|
899
|
+
}
|
|
900
|
+
/**
|
|
901
|
+
* A role definition for users in a partner organization
|
|
902
|
+
*/
|
|
903
|
+
export interface PartnerRole {
|
|
904
|
+
/**
|
|
905
|
+
* Unique identifier for the role (format: org_id:slug)
|
|
906
|
+
* example:
|
|
907
|
+
* 123:partner_admin
|
|
908
|
+
*/
|
|
909
|
+
id: string;
|
|
910
|
+
/**
|
|
911
|
+
* URL-friendly identifier for the role
|
|
912
|
+
* example:
|
|
913
|
+
* partner_admin
|
|
914
|
+
*/
|
|
915
|
+
slug: string;
|
|
916
|
+
/**
|
|
917
|
+
* Human-readable display name for the role
|
|
918
|
+
* example:
|
|
919
|
+
* Partner Administrator
|
|
920
|
+
*/
|
|
921
|
+
name: string;
|
|
922
|
+
/**
|
|
923
|
+
* Type of role. Partner roles are typically 'share_role' indicating
|
|
924
|
+
* they are designed for cross-organization sharing scenarios.
|
|
925
|
+
*
|
|
926
|
+
* example:
|
|
927
|
+
* share_role
|
|
928
|
+
*/
|
|
929
|
+
type?: string;
|
|
930
|
+
/**
|
|
931
|
+
* List of permission grants that define what users with this role can do
|
|
932
|
+
*/
|
|
933
|
+
grants: /**
|
|
934
|
+
* A permission grant that allows or denies a specific action on a resource.
|
|
935
|
+
*
|
|
936
|
+
* Grants are the building blocks of roles and define what users can do within the system.
|
|
937
|
+
*
|
|
938
|
+
*/
|
|
939
|
+
Grant[];
|
|
940
|
+
}
|
|
941
|
+
/**
|
|
942
|
+
* A user within a partner organization, including their assigned roles
|
|
943
|
+
*/
|
|
944
|
+
export interface PartnerUser {
|
|
945
|
+
/**
|
|
946
|
+
* Unique identifier for the user
|
|
947
|
+
* example:
|
|
948
|
+
* 456
|
|
949
|
+
*/
|
|
950
|
+
id: string;
|
|
951
|
+
/**
|
|
952
|
+
* Full name of the user
|
|
953
|
+
* example:
|
|
954
|
+
* John Doe
|
|
955
|
+
*/
|
|
956
|
+
name?: string;
|
|
957
|
+
/**
|
|
958
|
+
* Email address of the user
|
|
959
|
+
* example:
|
|
960
|
+
* user@partner.com
|
|
961
|
+
*/
|
|
962
|
+
email: string; // email
|
|
963
|
+
/**
|
|
964
|
+
* Current status of the user account:
|
|
965
|
+
* - Active: User has completed registration and can access the system
|
|
966
|
+
* - Pending: User has been invited but not yet completed registration
|
|
967
|
+
* - Deactivated: User account has been disabled
|
|
968
|
+
*
|
|
969
|
+
* example:
|
|
970
|
+
* Active
|
|
971
|
+
*/
|
|
972
|
+
status: string;
|
|
973
|
+
/**
|
|
974
|
+
* Profile image URLs for the user
|
|
975
|
+
*/
|
|
976
|
+
image?: {
|
|
977
|
+
/**
|
|
978
|
+
* Full-resolution profile image URL
|
|
979
|
+
*/
|
|
980
|
+
original?: string; // uri
|
|
981
|
+
/**
|
|
982
|
+
* 32x32 pixel thumbnail image URL
|
|
983
|
+
*/
|
|
984
|
+
thumbnail_32?: string; // uri
|
|
985
|
+
};
|
|
986
|
+
/**
|
|
987
|
+
* List of roles assigned to the user within the partner organization
|
|
988
|
+
*/
|
|
989
|
+
roles: {
|
|
990
|
+
/**
|
|
991
|
+
* Unique identifier for the role
|
|
992
|
+
* example:
|
|
993
|
+
* 123:partner_admin
|
|
994
|
+
*/
|
|
995
|
+
id: string;
|
|
996
|
+
/**
|
|
997
|
+
* URL-friendly role identifier
|
|
998
|
+
* example:
|
|
999
|
+
* partner_admin
|
|
1000
|
+
*/
|
|
1001
|
+
slug: string;
|
|
1002
|
+
/**
|
|
1003
|
+
* Human-readable role name
|
|
1004
|
+
* example:
|
|
1005
|
+
* Partner Administrator
|
|
1006
|
+
*/
|
|
1007
|
+
name: string;
|
|
1008
|
+
}[];
|
|
1009
|
+
}
|
|
1010
|
+
/**
|
|
1011
|
+
* Unique identifier for a role, combining organization ID and role slug.
|
|
1012
|
+
* Format: <organization_id>:<slug>
|
|
1013
|
+
*
|
|
1014
|
+
* example:
|
|
1015
|
+
* 123:owner
|
|
1016
|
+
*/
|
|
1017
|
+
export type RoleId = string;
|
|
1018
|
+
/**
|
|
1019
|
+
* Request payload for geocoding an address to coordinates
|
|
1020
|
+
*/
|
|
1021
|
+
export interface SearchGeolocation {
|
|
1022
|
+
/**
|
|
1023
|
+
* Full address string to convert to geographic coordinates.
|
|
1024
|
+
* For best results, include street, city, postal code, and country.
|
|
1025
|
+
*
|
|
1026
|
+
* example:
|
|
1027
|
+
* Auweg 1, 93055 Regensburg, DE
|
|
1028
|
+
*/
|
|
1029
|
+
address: string;
|
|
1030
|
+
}
|
|
1031
|
+
/**
|
|
1032
|
+
* Request payload for updating an existing role in a partner organization
|
|
1033
|
+
*/
|
|
1034
|
+
export interface UpdatePartnerRolePayload {
|
|
1035
|
+
/**
|
|
1036
|
+
* List of permission grants that define what users with this role can do
|
|
1037
|
+
*/
|
|
1038
|
+
grants: /**
|
|
1039
|
+
* A permission grant that allows or denies a specific action on a resource.
|
|
1040
|
+
*
|
|
1041
|
+
* Grants are the building blocks of roles and define what users can do within the system.
|
|
1042
|
+
*
|
|
1043
|
+
*/
|
|
1044
|
+
Grant[];
|
|
1045
|
+
id?: /**
|
|
1046
|
+
* Unique identifier for a role, combining organization ID and role slug.
|
|
1047
|
+
* Format: <organization_id>:<slug>
|
|
1048
|
+
*
|
|
1049
|
+
* example:
|
|
1050
|
+
* 123:owner
|
|
1051
|
+
*/
|
|
1052
|
+
RoleId;
|
|
1053
|
+
/**
|
|
1054
|
+
* Human-readable display name for the role
|
|
1055
|
+
* example:
|
|
1056
|
+
* Owner
|
|
1057
|
+
*/
|
|
1058
|
+
name: string;
|
|
1059
|
+
/**
|
|
1060
|
+
* URL-friendly identifier for the role (lowercase, no spaces)
|
|
1061
|
+
* example:
|
|
1062
|
+
* owner
|
|
1063
|
+
*/
|
|
1064
|
+
slug: string; // ^[a-z][a-z0-9_]*$
|
|
1065
|
+
}
|
|
1066
|
+
/**
|
|
1067
|
+
* A user account in the epilot platform
|
|
1068
|
+
*/
|
|
1069
|
+
export interface User {
|
|
1070
|
+
/**
|
|
1071
|
+
* Unique identifier for the user
|
|
1072
|
+
* example:
|
|
1073
|
+
* 456
|
|
1074
|
+
*/
|
|
1075
|
+
id?: string;
|
|
1076
|
+
/**
|
|
1077
|
+
* Email address of the user
|
|
1078
|
+
* example:
|
|
1079
|
+
* user@example.com
|
|
1080
|
+
*/
|
|
1081
|
+
email?: string; // email
|
|
1082
|
+
/**
|
|
1083
|
+
* Full name of the user for display purposes
|
|
1084
|
+
* example:
|
|
1085
|
+
* John Doe
|
|
1086
|
+
*/
|
|
1087
|
+
display_name?: string;
|
|
1088
|
+
/**
|
|
1089
|
+
* Current status of the user account:
|
|
1090
|
+
* - Active: User has completed registration and can access the system
|
|
1091
|
+
* - Pending: User has been invited but not yet completed registration
|
|
1092
|
+
* - Deactivated: User account has been disabled
|
|
1093
|
+
*
|
|
1094
|
+
* example:
|
|
1095
|
+
* Active
|
|
1096
|
+
*/
|
|
1097
|
+
status?: "Active" | "Pending" | "Deactivated";
|
|
1098
|
+
}
|
|
1099
|
+
}
|
|
1100
|
+
}
|
|
1101
|
+
declare namespace Paths {
|
|
1102
|
+
namespace ActivatePartner {
|
|
1103
|
+
namespace Parameters {
|
|
1104
|
+
export type Token = /**
|
|
1105
|
+
* A secure token used for partner invitation and activation. Sent via email to the invited partner.
|
|
1106
|
+
* example:
|
|
1107
|
+
* eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXJ0bmVySWQiOiIxMjM0NSJ9.abcdef
|
|
1108
|
+
*/
|
|
1109
|
+
Components.Schemas.InviteToken;
|
|
1110
|
+
}
|
|
1111
|
+
export interface QueryParameters {
|
|
1112
|
+
token: Parameters.Token;
|
|
1113
|
+
}
|
|
1114
|
+
export type RequestBody = /* Payload for activating a partner account using an invitation token */ Components.Schemas.ActivatePartnerPayload;
|
|
1115
|
+
namespace Responses {
|
|
1116
|
+
export interface $200 {
|
|
1117
|
+
}
|
|
1118
|
+
export interface $400 {
|
|
1119
|
+
}
|
|
1120
|
+
export interface $404 {
|
|
1121
|
+
}
|
|
1122
|
+
export interface $409 {
|
|
1123
|
+
}
|
|
1124
|
+
}
|
|
1125
|
+
}
|
|
1126
|
+
namespace ApprovePartner {
|
|
1127
|
+
namespace Parameters {
|
|
1128
|
+
export type Id = /**
|
|
1129
|
+
* Unique identifier for a partner record (UUID format)
|
|
1130
|
+
* example:
|
|
1131
|
+
* e45a6dc2-3795-43a3-ae0f-6b6760f310fc
|
|
1132
|
+
*/
|
|
1133
|
+
Components.Schemas.PartnerId;
|
|
1134
|
+
}
|
|
1135
|
+
export interface PathParameters {
|
|
1136
|
+
id: Parameters.Id;
|
|
1137
|
+
}
|
|
1138
|
+
namespace Responses {
|
|
1139
|
+
export type $201 = /**
|
|
1140
|
+
* Represents a partner organization in the partner directory.
|
|
1141
|
+
*
|
|
1142
|
+
* Partners go through a lifecycle from invitation to active collaboration:
|
|
1143
|
+
* - **Pending**: Initial state when partner record is created
|
|
1144
|
+
* - **Invited**: Invitation email has been sent to the partner
|
|
1145
|
+
* - **Request**: Partner has requested to join (self-registration)
|
|
1146
|
+
* - **Rejected**: Partnership request was declined
|
|
1147
|
+
* - **Deleted**: Partner relationship has been terminated
|
|
1148
|
+
*
|
|
1149
|
+
*/
|
|
1150
|
+
Components.Schemas.Partner;
|
|
1151
|
+
export interface $400 {
|
|
1152
|
+
}
|
|
1153
|
+
export interface $404 {
|
|
1154
|
+
}
|
|
1155
|
+
}
|
|
1156
|
+
}
|
|
1157
|
+
namespace AssignPartnerUserRoles {
|
|
1158
|
+
namespace Parameters {
|
|
1159
|
+
export type OrgId = /**
|
|
1160
|
+
* Unique identifier for an organization in the epilot platform
|
|
1161
|
+
* example:
|
|
1162
|
+
* 123
|
|
1163
|
+
*/
|
|
1164
|
+
Components.Schemas.OrganizationId;
|
|
1165
|
+
export type UserId = string;
|
|
1166
|
+
}
|
|
1167
|
+
export interface PathParameters {
|
|
1168
|
+
orgId: Parameters.OrgId;
|
|
1169
|
+
userId: Parameters.UserId;
|
|
1170
|
+
}
|
|
1171
|
+
export type RequestBody = /* Request payload for assigning or unassigning roles to/from a user */ Components.Schemas.AssignRolesPayload;
|
|
1172
|
+
namespace Responses {
|
|
1173
|
+
export interface $200 {
|
|
1174
|
+
/**
|
|
1175
|
+
* Results for each role assignment attempt
|
|
1176
|
+
*/
|
|
1177
|
+
results?: {
|
|
1178
|
+
/**
|
|
1179
|
+
* The role ID that was processed
|
|
1180
|
+
*/
|
|
1181
|
+
roleId?: string;
|
|
1182
|
+
/**
|
|
1183
|
+
* Whether the assignment was successful
|
|
1184
|
+
*/
|
|
1185
|
+
success?: boolean;
|
|
1186
|
+
/**
|
|
1187
|
+
* Additional data on success
|
|
1188
|
+
*/
|
|
1189
|
+
data?: {
|
|
1190
|
+
[key: string]: any;
|
|
1191
|
+
};
|
|
1192
|
+
/**
|
|
1193
|
+
* Error details on failure
|
|
1194
|
+
*/
|
|
1195
|
+
error?: {
|
|
1196
|
+
[key: string]: any;
|
|
1197
|
+
};
|
|
1198
|
+
}[];
|
|
1199
|
+
}
|
|
1200
|
+
export interface $400 {
|
|
1201
|
+
}
|
|
1202
|
+
export interface $403 {
|
|
1203
|
+
}
|
|
1204
|
+
export interface $404 {
|
|
1205
|
+
}
|
|
1206
|
+
export interface $500 {
|
|
1207
|
+
}
|
|
1208
|
+
}
|
|
1209
|
+
}
|
|
1210
|
+
namespace BatchGetAssignable {
|
|
1211
|
+
export type RequestBody = [
|
|
1212
|
+
{
|
|
1213
|
+
/**
|
|
1214
|
+
* User ID of the assignable to retrieve
|
|
1215
|
+
* example:
|
|
1216
|
+
* 456
|
|
1217
|
+
*/
|
|
1218
|
+
user_id?: string;
|
|
1219
|
+
/**
|
|
1220
|
+
* Organization ID of the assignable. If not provided, defaults to the caller's organization.
|
|
1221
|
+
* example:
|
|
1222
|
+
* 123
|
|
1223
|
+
*/
|
|
1224
|
+
org_id?: string;
|
|
1225
|
+
/**
|
|
1226
|
+
* Group ID of the assignable to retrieve (mutually exclusive with user_id)
|
|
1227
|
+
* example:
|
|
1228
|
+
* group-789
|
|
1229
|
+
*/
|
|
1230
|
+
group_id?: string;
|
|
1231
|
+
},
|
|
1232
|
+
...{
|
|
1233
|
+
/**
|
|
1234
|
+
* User ID of the assignable to retrieve
|
|
1235
|
+
* example:
|
|
1236
|
+
* 456
|
|
1237
|
+
*/
|
|
1238
|
+
user_id?: string;
|
|
1239
|
+
/**
|
|
1240
|
+
* Organization ID of the assignable. If not provided, defaults to the caller's organization.
|
|
1241
|
+
* example:
|
|
1242
|
+
* 123
|
|
1243
|
+
*/
|
|
1244
|
+
org_id?: string;
|
|
1245
|
+
/**
|
|
1246
|
+
* Group ID of the assignable to retrieve (mutually exclusive with user_id)
|
|
1247
|
+
* example:
|
|
1248
|
+
* group-789
|
|
1249
|
+
*/
|
|
1250
|
+
group_id?: string;
|
|
1251
|
+
}[]
|
|
1252
|
+
];
|
|
1253
|
+
namespace Responses {
|
|
1254
|
+
export interface $200 {
|
|
1255
|
+
/**
|
|
1256
|
+
* Total number of assignables found
|
|
1257
|
+
* example:
|
|
1258
|
+
* 3
|
|
1259
|
+
*/
|
|
1260
|
+
hits?: number;
|
|
1261
|
+
results?: /**
|
|
1262
|
+
* A user, organization, or group that can be assigned to tasks, workflows, or entities.
|
|
1263
|
+
* The `type` field discriminates between different assignable types.
|
|
1264
|
+
*
|
|
1265
|
+
*/
|
|
1266
|
+
Components.Schemas.Assignable[];
|
|
1267
|
+
}
|
|
1268
|
+
export interface $400 {
|
|
1269
|
+
}
|
|
1270
|
+
}
|
|
1271
|
+
}
|
|
1272
|
+
namespace CreatePartnerRole {
|
|
1273
|
+
namespace Parameters {
|
|
1274
|
+
export type OrgId = /**
|
|
1275
|
+
* Unique identifier for an organization in the epilot platform
|
|
1276
|
+
* example:
|
|
1277
|
+
* 123
|
|
1278
|
+
*/
|
|
1279
|
+
Components.Schemas.OrganizationId;
|
|
1280
|
+
}
|
|
1281
|
+
export interface PathParameters {
|
|
1282
|
+
orgId: Parameters.OrgId;
|
|
1283
|
+
}
|
|
1284
|
+
export type RequestBody = /* Request payload for creating a new role in a partner organization */ Components.Schemas.CreatePartnerRolePayload;
|
|
1285
|
+
namespace Responses {
|
|
1286
|
+
export type $201 = /* A role definition for users in a partner organization */ Components.Schemas.PartnerRole;
|
|
1287
|
+
export interface $400 {
|
|
1288
|
+
}
|
|
1289
|
+
export interface $403 {
|
|
1290
|
+
}
|
|
1291
|
+
export interface $404 {
|
|
1292
|
+
}
|
|
1293
|
+
export interface $500 {
|
|
1294
|
+
}
|
|
1295
|
+
}
|
|
1296
|
+
}
|
|
1297
|
+
namespace CreatePartnerUser {
|
|
1298
|
+
namespace Parameters {
|
|
1299
|
+
export type OrgId = /**
|
|
1300
|
+
* Unique identifier for an organization in the epilot platform
|
|
1301
|
+
* example:
|
|
1302
|
+
* 123
|
|
1303
|
+
*/
|
|
1304
|
+
Components.Schemas.OrganizationId;
|
|
1305
|
+
}
|
|
1306
|
+
export interface PathParameters {
|
|
1307
|
+
orgId: Parameters.OrgId;
|
|
1308
|
+
}
|
|
1309
|
+
export type RequestBody = /* Request payload for creating a new user in a partner organization */ Components.Schemas.CreatePartnerUserPayload;
|
|
1310
|
+
namespace Responses {
|
|
1311
|
+
export type $201 = /* A user account in the epilot platform */ Components.Schemas.User;
|
|
1312
|
+
export interface $400 {
|
|
1313
|
+
}
|
|
1314
|
+
export interface $403 {
|
|
1315
|
+
}
|
|
1316
|
+
export interface $404 {
|
|
1317
|
+
}
|
|
1318
|
+
export interface $500 {
|
|
1319
|
+
}
|
|
1320
|
+
}
|
|
1321
|
+
}
|
|
1322
|
+
namespace DeletePartnerRole {
|
|
1323
|
+
namespace Parameters {
|
|
1324
|
+
export type OrgId = /**
|
|
1325
|
+
* Unique identifier for an organization in the epilot platform
|
|
1326
|
+
* example:
|
|
1327
|
+
* 123
|
|
1328
|
+
*/
|
|
1329
|
+
Components.Schemas.OrganizationId;
|
|
1330
|
+
export type RoleId = string;
|
|
1331
|
+
}
|
|
1332
|
+
export interface PathParameters {
|
|
1333
|
+
orgId: Parameters.OrgId;
|
|
1334
|
+
roleId: Parameters.RoleId;
|
|
1335
|
+
}
|
|
1336
|
+
namespace Responses {
|
|
1337
|
+
export type $200 = /* A role definition for users in a partner organization */ Components.Schemas.PartnerRole;
|
|
1338
|
+
export interface $400 {
|
|
1339
|
+
}
|
|
1340
|
+
export interface $403 {
|
|
1341
|
+
}
|
|
1342
|
+
export interface $404 {
|
|
1343
|
+
}
|
|
1344
|
+
export interface $409 {
|
|
1345
|
+
}
|
|
1346
|
+
export interface $500 {
|
|
1347
|
+
}
|
|
1348
|
+
}
|
|
1349
|
+
}
|
|
1350
|
+
namespace DeletePartnerUser {
|
|
1351
|
+
namespace Parameters {
|
|
1352
|
+
export type OrgId = /**
|
|
1353
|
+
* Unique identifier for an organization in the epilot platform
|
|
1354
|
+
* example:
|
|
1355
|
+
* 123
|
|
1356
|
+
*/
|
|
1357
|
+
Components.Schemas.OrganizationId;
|
|
1358
|
+
export type UserId = string;
|
|
1359
|
+
}
|
|
1360
|
+
export interface PathParameters {
|
|
1361
|
+
orgId: Parameters.OrgId;
|
|
1362
|
+
userId: Parameters.UserId;
|
|
1363
|
+
}
|
|
1364
|
+
namespace Responses {
|
|
1365
|
+
export interface $200 {
|
|
1366
|
+
}
|
|
1367
|
+
export interface $400 {
|
|
1368
|
+
}
|
|
1369
|
+
export interface $403 {
|
|
1370
|
+
}
|
|
1371
|
+
export interface $404 {
|
|
1372
|
+
}
|
|
1373
|
+
export interface $500 {
|
|
1374
|
+
}
|
|
1375
|
+
}
|
|
1376
|
+
}
|
|
1377
|
+
namespace GetPartnerByToken {
|
|
1378
|
+
namespace Parameters {
|
|
1379
|
+
export type Token = /**
|
|
1380
|
+
* A secure token used for partner invitation and activation. Sent via email to the invited partner.
|
|
1381
|
+
* example:
|
|
1382
|
+
* eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXJ0bmVySWQiOiIxMjM0NSJ9.abcdef
|
|
1383
|
+
*/
|
|
1384
|
+
Components.Schemas.InviteToken;
|
|
1385
|
+
}
|
|
1386
|
+
export interface QueryParameters {
|
|
1387
|
+
token: Parameters.Token;
|
|
1388
|
+
}
|
|
1389
|
+
namespace Responses {
|
|
1390
|
+
export type $200 = /**
|
|
1391
|
+
* Represents a partner organization in the partner directory.
|
|
1392
|
+
*
|
|
1393
|
+
* Partners go through a lifecycle from invitation to active collaboration:
|
|
1394
|
+
* - **Pending**: Initial state when partner record is created
|
|
1395
|
+
* - **Invited**: Invitation email has been sent to the partner
|
|
1396
|
+
* - **Request**: Partner has requested to join (self-registration)
|
|
1397
|
+
* - **Rejected**: Partnership request was declined
|
|
1398
|
+
* - **Deleted**: Partner relationship has been terminated
|
|
1399
|
+
*
|
|
1400
|
+
*/
|
|
1401
|
+
Components.Schemas.Partner;
|
|
1402
|
+
export interface $400 {
|
|
1403
|
+
}
|
|
1404
|
+
export interface $404 {
|
|
1405
|
+
}
|
|
1406
|
+
}
|
|
1407
|
+
}
|
|
1408
|
+
namespace GetPartnerRoles {
|
|
1409
|
+
namespace Parameters {
|
|
1410
|
+
export type OrgId = /**
|
|
1411
|
+
* Unique identifier for an organization in the epilot platform
|
|
1412
|
+
* example:
|
|
1413
|
+
* 123
|
|
1414
|
+
*/
|
|
1415
|
+
Components.Schemas.OrganizationId;
|
|
1416
|
+
}
|
|
1417
|
+
export interface PathParameters {
|
|
1418
|
+
orgId: Parameters.OrgId;
|
|
1419
|
+
}
|
|
1420
|
+
namespace Responses {
|
|
1421
|
+
export interface $200 {
|
|
1422
|
+
results?: /* A role definition for users in a partner organization */ Components.Schemas.PartnerRole[];
|
|
1423
|
+
}
|
|
1424
|
+
export interface $400 {
|
|
1425
|
+
}
|
|
1426
|
+
export interface $403 {
|
|
1427
|
+
}
|
|
1428
|
+
export interface $404 {
|
|
1429
|
+
}
|
|
1430
|
+
export interface $500 {
|
|
1431
|
+
}
|
|
1432
|
+
}
|
|
1433
|
+
}
|
|
1434
|
+
namespace GetPartnerUsers {
|
|
1435
|
+
namespace Parameters {
|
|
1436
|
+
export type OrgId = /**
|
|
1437
|
+
* Unique identifier for an organization in the epilot platform
|
|
1438
|
+
* example:
|
|
1439
|
+
* 123
|
|
1440
|
+
*/
|
|
1441
|
+
Components.Schemas.OrganizationId;
|
|
1442
|
+
}
|
|
1443
|
+
export interface PathParameters {
|
|
1444
|
+
orgId: Parameters.OrgId;
|
|
1445
|
+
}
|
|
1446
|
+
namespace Responses {
|
|
1447
|
+
export interface $200 {
|
|
1448
|
+
results?: /* A user within a partner organization, including their assigned roles */ Components.Schemas.PartnerUser[];
|
|
1449
|
+
}
|
|
1450
|
+
export interface $400 {
|
|
1451
|
+
}
|
|
1452
|
+
export interface $403 {
|
|
1453
|
+
}
|
|
1454
|
+
export interface $404 {
|
|
1455
|
+
}
|
|
1456
|
+
export interface $500 {
|
|
1457
|
+
}
|
|
1458
|
+
}
|
|
1459
|
+
}
|
|
1460
|
+
namespace InvitePartnerV2 {
|
|
1461
|
+
namespace Parameters {
|
|
1462
|
+
export type Id = /**
|
|
1463
|
+
* Unique identifier for a partner record (UUID format)
|
|
1464
|
+
* example:
|
|
1465
|
+
* e45a6dc2-3795-43a3-ae0f-6b6760f310fc
|
|
1466
|
+
*/
|
|
1467
|
+
Components.Schemas.PartnerId;
|
|
1468
|
+
}
|
|
1469
|
+
export interface PathParameters {
|
|
1470
|
+
id: Parameters.Id;
|
|
1471
|
+
}
|
|
1472
|
+
export type RequestBody = /* Configuration options for sending a partner invitation */ Components.Schemas.PartnerInvitationPayload;
|
|
1473
|
+
namespace Responses {
|
|
1474
|
+
export type $200 = /**
|
|
1475
|
+
* Represents a partner organization in the partner directory.
|
|
1476
|
+
*
|
|
1477
|
+
* Partners go through a lifecycle from invitation to active collaboration:
|
|
1478
|
+
* - **Pending**: Initial state when partner record is created
|
|
1479
|
+
* - **Invited**: Invitation email has been sent to the partner
|
|
1480
|
+
* - **Request**: Partner has requested to join (self-registration)
|
|
1481
|
+
* - **Rejected**: Partnership request was declined
|
|
1482
|
+
* - **Deleted**: Partner relationship has been terminated
|
|
1483
|
+
*
|
|
1484
|
+
*/
|
|
1485
|
+
Components.Schemas.Partner;
|
|
1486
|
+
export interface $400 {
|
|
1487
|
+
}
|
|
1488
|
+
export interface $404 {
|
|
1489
|
+
}
|
|
1490
|
+
}
|
|
1491
|
+
}
|
|
1492
|
+
namespace RejectPartner {
|
|
1493
|
+
namespace Parameters {
|
|
1494
|
+
export type Id = /**
|
|
1495
|
+
* Unique identifier for a partner record (UUID format)
|
|
1496
|
+
* example:
|
|
1497
|
+
* e45a6dc2-3795-43a3-ae0f-6b6760f310fc
|
|
1498
|
+
*/
|
|
1499
|
+
Components.Schemas.PartnerId;
|
|
1500
|
+
}
|
|
1501
|
+
export interface PathParameters {
|
|
1502
|
+
id: Parameters.Id;
|
|
1503
|
+
}
|
|
1504
|
+
namespace Responses {
|
|
1505
|
+
export type $200 = /**
|
|
1506
|
+
* Represents a partner organization in the partner directory.
|
|
1507
|
+
*
|
|
1508
|
+
* Partners go through a lifecycle from invitation to active collaboration:
|
|
1509
|
+
* - **Pending**: Initial state when partner record is created
|
|
1510
|
+
* - **Invited**: Invitation email has been sent to the partner
|
|
1511
|
+
* - **Request**: Partner has requested to join (self-registration)
|
|
1512
|
+
* - **Rejected**: Partnership request was declined
|
|
1513
|
+
* - **Deleted**: Partner relationship has been terminated
|
|
1514
|
+
*
|
|
1515
|
+
*/
|
|
1516
|
+
Components.Schemas.Partner;
|
|
1517
|
+
export interface $400 {
|
|
1518
|
+
}
|
|
1519
|
+
export interface $404 {
|
|
1520
|
+
}
|
|
1521
|
+
}
|
|
1522
|
+
}
|
|
1523
|
+
namespace SearchAssignable {
|
|
1524
|
+
export interface RequestBody {
|
|
1525
|
+
/**
|
|
1526
|
+
* Search query string to filter results by name or email
|
|
1527
|
+
* example:
|
|
1528
|
+
* john
|
|
1529
|
+
*/
|
|
1530
|
+
q: string;
|
|
1531
|
+
/**
|
|
1532
|
+
* Starting offset for pagination (zero-based index)
|
|
1533
|
+
* example:
|
|
1534
|
+
* 0
|
|
1535
|
+
*/
|
|
1536
|
+
from?: number;
|
|
1537
|
+
/**
|
|
1538
|
+
* Maximum number of results to return per page
|
|
1539
|
+
* example:
|
|
1540
|
+
* 25
|
|
1541
|
+
*/
|
|
1542
|
+
size?: number;
|
|
1543
|
+
/**
|
|
1544
|
+
* Filter results to specific organization IDs. If not provided, searches all accessible organizations including partners.
|
|
1545
|
+
* example:
|
|
1546
|
+
* [
|
|
1547
|
+
* "123",
|
|
1548
|
+
* "456"
|
|
1549
|
+
* ]
|
|
1550
|
+
*/
|
|
1551
|
+
org_ids?: /**
|
|
1552
|
+
* Unique identifier for an organization in the epilot platform
|
|
1553
|
+
* example:
|
|
1554
|
+
* 123
|
|
1555
|
+
*/
|
|
1556
|
+
Components.Schemas.OrganizationId[];
|
|
1557
|
+
/**
|
|
1558
|
+
* Entity ID to scope portal user search. Required when `types` includes `ecp`.
|
|
1559
|
+
* When provided, only portal users related to the specified entity are returned
|
|
1560
|
+
* instead of placeholder users.
|
|
1561
|
+
*
|
|
1562
|
+
* example:
|
|
1563
|
+
* f7c22299-ca72-4bca-8538-0a88eeefc947
|
|
1564
|
+
*/
|
|
1565
|
+
portalUsersEntityIdScope?: string;
|
|
1566
|
+
/**
|
|
1567
|
+
* Filter results to specific types of assignables.
|
|
1568
|
+
* If not provided, defaults to all types except `parent_organization_user`.
|
|
1569
|
+
*
|
|
1570
|
+
*/
|
|
1571
|
+
types?: ("user" | "partner_user" | "partner_organization" | "ecp" | "group" | "parent_organization_user")[];
|
|
1572
|
+
}
|
|
1573
|
+
namespace Responses {
|
|
1574
|
+
export interface $200 {
|
|
1575
|
+
/**
|
|
1576
|
+
* Total number of matching results (may exceed returned results for pagination)
|
|
1577
|
+
* example:
|
|
1578
|
+
* 42
|
|
1579
|
+
*/
|
|
1580
|
+
hits?: number;
|
|
1581
|
+
results?: /**
|
|
1582
|
+
* A user, organization, or group that can be assigned to tasks, workflows, or entities.
|
|
1583
|
+
* The `type` field discriminates between different assignable types.
|
|
1584
|
+
*
|
|
1585
|
+
*/
|
|
1586
|
+
Components.Schemas.Assignable[];
|
|
1587
|
+
}
|
|
1588
|
+
export interface $400 {
|
|
1589
|
+
}
|
|
1590
|
+
}
|
|
1591
|
+
}
|
|
1592
|
+
namespace SearchGeolocationForText {
|
|
1593
|
+
export type RequestBody = /* Request payload for geocoding an address to coordinates */ Components.Schemas.SearchGeolocation;
|
|
1594
|
+
namespace Responses {
|
|
1595
|
+
export type $200 = /* Geographic coordinates with optional metadata */ Components.Schemas.Geolocation;
|
|
1596
|
+
export interface $400 {
|
|
1597
|
+
}
|
|
1598
|
+
export interface $404 {
|
|
1599
|
+
}
|
|
1600
|
+
}
|
|
1601
|
+
}
|
|
1602
|
+
namespace UnassignPartnerUserRoles {
|
|
1603
|
+
namespace Parameters {
|
|
1604
|
+
export type OrgId = /**
|
|
1605
|
+
* Unique identifier for an organization in the epilot platform
|
|
1606
|
+
* example:
|
|
1607
|
+
* 123
|
|
1608
|
+
*/
|
|
1609
|
+
Components.Schemas.OrganizationId;
|
|
1610
|
+
export type UserId = string;
|
|
1611
|
+
}
|
|
1612
|
+
export interface PathParameters {
|
|
1613
|
+
orgId: Parameters.OrgId;
|
|
1614
|
+
userId: Parameters.UserId;
|
|
1615
|
+
}
|
|
1616
|
+
export type RequestBody = /* Request payload for assigning or unassigning roles to/from a user */ Components.Schemas.AssignRolesPayload;
|
|
1617
|
+
namespace Responses {
|
|
1618
|
+
export interface $200 {
|
|
1619
|
+
/**
|
|
1620
|
+
* Results for each role removal attempt
|
|
1621
|
+
*/
|
|
1622
|
+
results?: {
|
|
1623
|
+
/**
|
|
1624
|
+
* The role ID that was processed
|
|
1625
|
+
*/
|
|
1626
|
+
roleId?: string;
|
|
1627
|
+
/**
|
|
1628
|
+
* Whether the removal was successful
|
|
1629
|
+
*/
|
|
1630
|
+
success?: boolean;
|
|
1631
|
+
/**
|
|
1632
|
+
* Additional data on success
|
|
1633
|
+
*/
|
|
1634
|
+
data?: {
|
|
1635
|
+
[key: string]: any;
|
|
1636
|
+
};
|
|
1637
|
+
/**
|
|
1638
|
+
* Error details on failure
|
|
1639
|
+
*/
|
|
1640
|
+
error?: {
|
|
1641
|
+
[key: string]: any;
|
|
1642
|
+
};
|
|
1643
|
+
}[];
|
|
1644
|
+
}
|
|
1645
|
+
export interface $400 {
|
|
1646
|
+
}
|
|
1647
|
+
export interface $403 {
|
|
1648
|
+
}
|
|
1649
|
+
export interface $404 {
|
|
1650
|
+
}
|
|
1651
|
+
export interface $500 {
|
|
1652
|
+
}
|
|
1653
|
+
}
|
|
1654
|
+
}
|
|
1655
|
+
namespace UpdatePartnerRole {
|
|
1656
|
+
namespace Parameters {
|
|
1657
|
+
export type OrgId = /**
|
|
1658
|
+
* Unique identifier for an organization in the epilot platform
|
|
1659
|
+
* example:
|
|
1660
|
+
* 123
|
|
1661
|
+
*/
|
|
1662
|
+
Components.Schemas.OrganizationId;
|
|
1663
|
+
export type RoleId = string;
|
|
1664
|
+
}
|
|
1665
|
+
export interface PathParameters {
|
|
1666
|
+
orgId: Parameters.OrgId;
|
|
1667
|
+
roleId: Parameters.RoleId;
|
|
1668
|
+
}
|
|
1669
|
+
export type RequestBody = /* Request payload for updating an existing role in a partner organization */ Components.Schemas.UpdatePartnerRolePayload;
|
|
1670
|
+
namespace Responses {
|
|
1671
|
+
export type $200 = /* A role definition for users in a partner organization */ Components.Schemas.PartnerRole;
|
|
1672
|
+
export interface $400 {
|
|
1673
|
+
}
|
|
1674
|
+
export interface $403 {
|
|
1675
|
+
}
|
|
1676
|
+
export interface $404 {
|
|
1677
|
+
}
|
|
1678
|
+
export interface $500 {
|
|
1679
|
+
}
|
|
1680
|
+
}
|
|
1681
|
+
}
|
|
1682
|
+
}
|
|
1683
|
+
|
|
1684
|
+
|
|
1685
|
+
interface OperationMethods {
|
|
1686
|
+
/**
|
|
1687
|
+
* approvePartner - approvePartner
|
|
1688
|
+
*
|
|
1689
|
+
* Approves a pending partner request, allowing the partner to begin collaboration.
|
|
1690
|
+
*
|
|
1691
|
+
* When a partner requests to join your organization's partner network, this endpoint
|
|
1692
|
+
* is used to approve the request and activate the partnership.
|
|
1693
|
+
*
|
|
1694
|
+
*/
|
|
1695
|
+
'approvePartner'(
|
|
1696
|
+
parameters?: Parameters<Paths.ApprovePartner.PathParameters> | null,
|
|
1697
|
+
data?: any,
|
|
1698
|
+
config?: AxiosRequestConfig
|
|
1699
|
+
): OperationResponse<Paths.ApprovePartner.Responses.$201>
|
|
1700
|
+
/**
|
|
1701
|
+
* rejectPartner - rejectPartner
|
|
1702
|
+
*
|
|
1703
|
+
* Rejects a pending partner request, declining the partnership.
|
|
1704
|
+
*
|
|
1705
|
+
* When a partner requests to join your organization's partner network, this endpoint
|
|
1706
|
+
* is used to reject the request if the partnership is not desired.
|
|
1707
|
+
*
|
|
1708
|
+
*/
|
|
1709
|
+
'rejectPartner'(
|
|
1710
|
+
parameters?: Parameters<Paths.RejectPartner.PathParameters> | null,
|
|
1711
|
+
data?: any,
|
|
1712
|
+
config?: AxiosRequestConfig
|
|
1713
|
+
): OperationResponse<Paths.RejectPartner.Responses.$200>
|
|
1714
|
+
/**
|
|
1715
|
+
* searchAssignable - searchAssignable
|
|
1716
|
+
*
|
|
1717
|
+
* Search for users and organizations that can be assigned to tasks, workflows, or entities.
|
|
1718
|
+
*
|
|
1719
|
+
* This endpoint searches across your organization and all connected partner organizations
|
|
1720
|
+
* to find assignable resources. Use this when you need to assign someone to a task,
|
|
1721
|
+
* workflow step, or entity and want to include partners in the search.
|
|
1722
|
+
*
|
|
1723
|
+
* **Results can include:**
|
|
1724
|
+
* - `user`: Users in your organization
|
|
1725
|
+
* - `partner_user`: Users in partner organizations
|
|
1726
|
+
* - `partner_organization`: Partner organizations themselves (for organization-level assignments)
|
|
1727
|
+
* - `ecp`: End Customer Portal users
|
|
1728
|
+
* - `group`: User groups
|
|
1729
|
+
* - `parent_organization_user`: Users from parent organization (for sub-organizations)
|
|
1730
|
+
*
|
|
1731
|
+
* **Pagination:** Use `from` and `size` parameters for paginated results.
|
|
1732
|
+
*
|
|
1733
|
+
*/
|
|
1734
|
+
'searchAssignable'(
|
|
1735
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1736
|
+
data?: Paths.SearchAssignable.RequestBody,
|
|
1737
|
+
config?: AxiosRequestConfig
|
|
1738
|
+
): OperationResponse<Paths.SearchAssignable.Responses.$200>
|
|
1739
|
+
/**
|
|
1740
|
+
* batchGetAssignable - batchGetAssignable
|
|
1741
|
+
*
|
|
1742
|
+
* Retrieve multiple assignable users or groups by their IDs in a single request.
|
|
1743
|
+
*
|
|
1744
|
+
* Use this endpoint when you have a list of user or group IDs and need to fetch
|
|
1745
|
+
* their full assignable information. This is more efficient than making multiple
|
|
1746
|
+
* individual requests.
|
|
1747
|
+
*
|
|
1748
|
+
* Each item in the request array should specify either a `user_id` or `group_id`.
|
|
1749
|
+
*
|
|
1750
|
+
*/
|
|
1751
|
+
'batchGetAssignable'(
|
|
1752
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1753
|
+
data?: Paths.BatchGetAssignable.RequestBody,
|
|
1754
|
+
config?: AxiosRequestConfig
|
|
1755
|
+
): OperationResponse<Paths.BatchGetAssignable.Responses.$200>
|
|
1756
|
+
/**
|
|
1757
|
+
* getPartnerByToken - getPartnerByToken
|
|
1758
|
+
*
|
|
1759
|
+
* Retrieves partner information using an invitation token.
|
|
1760
|
+
*
|
|
1761
|
+
* This is a **public endpoint** that does not require authentication.
|
|
1762
|
+
* It is used during the partner onboarding flow to display partner information
|
|
1763
|
+
* before the invited organization completes their registration.
|
|
1764
|
+
*
|
|
1765
|
+
* The token is sent to the partner via email when they are invited.
|
|
1766
|
+
*
|
|
1767
|
+
*/
|
|
1768
|
+
'getPartnerByToken'(
|
|
1769
|
+
parameters?: Parameters<Paths.GetPartnerByToken.QueryParameters> | null,
|
|
1770
|
+
data?: any,
|
|
1771
|
+
config?: AxiosRequestConfig
|
|
1772
|
+
): OperationResponse<Paths.GetPartnerByToken.Responses.$200>
|
|
1773
|
+
/**
|
|
1774
|
+
* activatePartner - activatePartner
|
|
1775
|
+
*
|
|
1776
|
+
* Activates a partner account using an invitation token.
|
|
1777
|
+
*
|
|
1778
|
+
* This is a **public endpoint** that does not require authentication.
|
|
1779
|
+
* It is called when an invited partner completes their registration to establish
|
|
1780
|
+
* the partnership between the two organizations.
|
|
1781
|
+
*
|
|
1782
|
+
* **Activation Flow:**
|
|
1783
|
+
* 1. Partner receives invitation email with token
|
|
1784
|
+
* 2. Partner clicks link and views invitation details (via `getPartnerByToken`)
|
|
1785
|
+
* 3. Partner completes registration form
|
|
1786
|
+
* 4. This endpoint is called to activate the partnership
|
|
1787
|
+
*
|
|
1788
|
+
* After activation, the partner organization can begin collaborating with
|
|
1789
|
+
* the inviting organization through shared entities and assignments.
|
|
1790
|
+
*
|
|
1791
|
+
*/
|
|
1792
|
+
'activatePartner'(
|
|
1793
|
+
parameters?: Parameters<Paths.ActivatePartner.QueryParameters> | null,
|
|
1794
|
+
data?: Paths.ActivatePartner.RequestBody,
|
|
1795
|
+
config?: AxiosRequestConfig
|
|
1796
|
+
): OperationResponse<Paths.ActivatePartner.Responses.$200>
|
|
1797
|
+
/**
|
|
1798
|
+
* searchGeolocationForText - searchGeolocationForText
|
|
1799
|
+
*
|
|
1800
|
+
* Converts an address string to geographic coordinates (latitude and longitude).
|
|
1801
|
+
*
|
|
1802
|
+
* This endpoint is used to geocode partner addresses for location-based features such as:
|
|
1803
|
+
* - Partner search by proximity
|
|
1804
|
+
* - Displaying partners on a map
|
|
1805
|
+
* - Calculating activity radius coverage
|
|
1806
|
+
*
|
|
1807
|
+
* The address should be provided as a complete, well-formatted string for best results.
|
|
1808
|
+
*
|
|
1809
|
+
*/
|
|
1810
|
+
'searchGeolocationForText'(
|
|
1811
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1812
|
+
data?: Paths.SearchGeolocationForText.RequestBody,
|
|
1813
|
+
config?: AxiosRequestConfig
|
|
1814
|
+
): OperationResponse<Paths.SearchGeolocationForText.Responses.$200>
|
|
1815
|
+
/**
|
|
1816
|
+
* invitePartnerV2 - invitePartnerV2
|
|
1817
|
+
*
|
|
1818
|
+
* Sends an invitation email to a partner organization to begin collaboration.
|
|
1819
|
+
*
|
|
1820
|
+
* This endpoint generates an invitation token and sends an email to the partner
|
|
1821
|
+
* with a link to complete their registration. The partner can then accept the
|
|
1822
|
+
* invitation to establish a B2B partnership.
|
|
1823
|
+
*
|
|
1824
|
+
* **Invitation Flow:**
|
|
1825
|
+
* 1. Create a partner record (via entity API)
|
|
1826
|
+
* 2. Call this endpoint to send the invitation email
|
|
1827
|
+
* 3. Partner receives email with unique invitation link
|
|
1828
|
+
* 4. Partner activates their account via the public activation endpoint
|
|
1829
|
+
*
|
|
1830
|
+
* The invitation email language can be customized via the request body.
|
|
1831
|
+
*
|
|
1832
|
+
*/
|
|
1833
|
+
'invitePartnerV2'(
|
|
1834
|
+
parameters?: Parameters<Paths.InvitePartnerV2.PathParameters> | null,
|
|
1835
|
+
data?: Paths.InvitePartnerV2.RequestBody,
|
|
1836
|
+
config?: AxiosRequestConfig
|
|
1837
|
+
): OperationResponse<Paths.InvitePartnerV2.Responses.$200>
|
|
1838
|
+
/**
|
|
1839
|
+
* getPartnerUsers - getPartnerUsers
|
|
1840
|
+
*
|
|
1841
|
+
* Retrieves all users belonging to a partner organization along with their assigned roles.
|
|
1842
|
+
*
|
|
1843
|
+
* This endpoint allows parent organizations to view and manage the users within
|
|
1844
|
+
* their partner organizations. The response includes user details and their
|
|
1845
|
+
* role assignments within the partner organization.
|
|
1846
|
+
*
|
|
1847
|
+
*/
|
|
1848
|
+
'getPartnerUsers'(
|
|
1849
|
+
parameters?: Parameters<Paths.GetPartnerUsers.PathParameters> | null,
|
|
1850
|
+
data?: any,
|
|
1851
|
+
config?: AxiosRequestConfig
|
|
1852
|
+
): OperationResponse<Paths.GetPartnerUsers.Responses.$200>
|
|
1853
|
+
/**
|
|
1854
|
+
* createPartnerUser - createPartnerUser
|
|
1855
|
+
*
|
|
1856
|
+
* Creates a new user in a partner organization.
|
|
1857
|
+
*
|
|
1858
|
+
* This endpoint allows parent organizations to create users directly within
|
|
1859
|
+
* their partner organizations. The new user will receive an invitation email
|
|
1860
|
+
* to set up their account.
|
|
1861
|
+
*
|
|
1862
|
+
* Optionally, roles can be assigned to the user at creation time.
|
|
1863
|
+
*
|
|
1864
|
+
*/
|
|
1865
|
+
'createPartnerUser'(
|
|
1866
|
+
parameters?: Parameters<Paths.CreatePartnerUser.PathParameters> | null,
|
|
1867
|
+
data?: Paths.CreatePartnerUser.RequestBody,
|
|
1868
|
+
config?: AxiosRequestConfig
|
|
1869
|
+
): OperationResponse<Paths.CreatePartnerUser.Responses.$201>
|
|
1870
|
+
/**
|
|
1871
|
+
* deletePartnerUser - deletePartnerUser
|
|
1872
|
+
*
|
|
1873
|
+
* Removes a user from a partner organization.
|
|
1874
|
+
*
|
|
1875
|
+
* This endpoint allows parent organizations to delete users from their partner
|
|
1876
|
+
* organizations. The user will lose access to the partner organization immediately.
|
|
1877
|
+
*
|
|
1878
|
+
* **Note:** This action is permanent and cannot be undone.
|
|
1879
|
+
*
|
|
1880
|
+
*/
|
|
1881
|
+
'deletePartnerUser'(
|
|
1882
|
+
parameters?: Parameters<Paths.DeletePartnerUser.PathParameters> | null,
|
|
1883
|
+
data?: any,
|
|
1884
|
+
config?: AxiosRequestConfig
|
|
1885
|
+
): OperationResponse<Paths.DeletePartnerUser.Responses.$200>
|
|
1886
|
+
/**
|
|
1887
|
+
* getPartnerRoles - getPartnerRoles
|
|
1888
|
+
*
|
|
1889
|
+
* Retrieves all roles defined for a partner organization.
|
|
1890
|
+
*
|
|
1891
|
+
* Roles define the permissions that users in the partner organization have.
|
|
1892
|
+
* Parent organizations can use this endpoint to view available roles before
|
|
1893
|
+
* assigning them to partner users.
|
|
1894
|
+
*
|
|
1895
|
+
*/
|
|
1896
|
+
'getPartnerRoles'(
|
|
1897
|
+
parameters?: Parameters<Paths.GetPartnerRoles.PathParameters> | null,
|
|
1898
|
+
data?: any,
|
|
1899
|
+
config?: AxiosRequestConfig
|
|
1900
|
+
): OperationResponse<Paths.GetPartnerRoles.Responses.$200>
|
|
1901
|
+
/**
|
|
1902
|
+
* createPartnerRole - createPartnerRole
|
|
1903
|
+
*
|
|
1904
|
+
* Creates a new role for a partner organization.
|
|
1905
|
+
*
|
|
1906
|
+
* Roles define permissions for partner users. The parent organization can create
|
|
1907
|
+
* custom roles with specific permission grants to control what partner users
|
|
1908
|
+
* can access and modify.
|
|
1909
|
+
*
|
|
1910
|
+
* **Permission Grants:**
|
|
1911
|
+
* Each role contains a list of grants that define allowed (or denied) actions
|
|
1912
|
+
* on specific resources. See the Grant schema for details on defining permissions.
|
|
1913
|
+
*
|
|
1914
|
+
*/
|
|
1915
|
+
'createPartnerRole'(
|
|
1916
|
+
parameters?: Parameters<Paths.CreatePartnerRole.PathParameters> | null,
|
|
1917
|
+
data?: Paths.CreatePartnerRole.RequestBody,
|
|
1918
|
+
config?: AxiosRequestConfig
|
|
1919
|
+
): OperationResponse<Paths.CreatePartnerRole.Responses.$201>
|
|
1920
|
+
/**
|
|
1921
|
+
* updatePartnerRole - updatePartnerRole
|
|
1922
|
+
*
|
|
1923
|
+
* Updates an existing role in a partner organization.
|
|
1924
|
+
*
|
|
1925
|
+
* Use this endpoint to modify the permissions (grants) or metadata of an existing
|
|
1926
|
+
* role. All users with this role will immediately have the updated permissions.
|
|
1927
|
+
*
|
|
1928
|
+
* **Note:** Changing role permissions affects all users currently assigned to the role.
|
|
1929
|
+
*
|
|
1930
|
+
*/
|
|
1931
|
+
'updatePartnerRole'(
|
|
1932
|
+
parameters?: Parameters<Paths.UpdatePartnerRole.PathParameters> | null,
|
|
1933
|
+
data?: Paths.UpdatePartnerRole.RequestBody,
|
|
1934
|
+
config?: AxiosRequestConfig
|
|
1935
|
+
): OperationResponse<Paths.UpdatePartnerRole.Responses.$200>
|
|
1936
|
+
/**
|
|
1937
|
+
* deletePartnerRole - deletePartnerRole
|
|
1938
|
+
*
|
|
1939
|
+
* Delete a role from a partner organization
|
|
1940
|
+
*/
|
|
1941
|
+
'deletePartnerRole'(
|
|
1942
|
+
parameters?: Parameters<Paths.DeletePartnerRole.PathParameters> | null,
|
|
1943
|
+
data?: any,
|
|
1944
|
+
config?: AxiosRequestConfig
|
|
1945
|
+
): OperationResponse<Paths.DeletePartnerRole.Responses.$200>
|
|
1946
|
+
/**
|
|
1947
|
+
* assignPartnerUserRoles - assignPartnerUserRoles
|
|
1948
|
+
*
|
|
1949
|
+
* Assigns one or more roles to a user in a partner organization.
|
|
1950
|
+
*
|
|
1951
|
+
* Roles define the permissions that the user has within the partner organization.
|
|
1952
|
+
* Multiple roles can be assigned in a single request. The response indicates
|
|
1953
|
+
* the success or failure of each role assignment.
|
|
1954
|
+
*
|
|
1955
|
+
*/
|
|
1956
|
+
'assignPartnerUserRoles'(
|
|
1957
|
+
parameters?: Parameters<Paths.AssignPartnerUserRoles.PathParameters> | null,
|
|
1958
|
+
data?: Paths.AssignPartnerUserRoles.RequestBody,
|
|
1959
|
+
config?: AxiosRequestConfig
|
|
1960
|
+
): OperationResponse<Paths.AssignPartnerUserRoles.Responses.$200>
|
|
1961
|
+
/**
|
|
1962
|
+
* unassignPartnerUserRoles - unassignPartnerUserRoles
|
|
1963
|
+
*
|
|
1964
|
+
* Removes one or more roles from a user in a partner organization.
|
|
1965
|
+
*
|
|
1966
|
+
* This endpoint removes the specified roles from the user, reducing their permissions
|
|
1967
|
+
* within the partner organization. The response indicates the success or failure
|
|
1968
|
+
* of each role removal.
|
|
1969
|
+
*
|
|
1970
|
+
* **Note:** Removing all roles from a user may result in the user having no access
|
|
1971
|
+
* to the partner organization.
|
|
1972
|
+
*
|
|
1973
|
+
*/
|
|
1974
|
+
'unassignPartnerUserRoles'(
|
|
1975
|
+
parameters?: Parameters<Paths.UnassignPartnerUserRoles.PathParameters> | null,
|
|
1976
|
+
data?: Paths.UnassignPartnerUserRoles.RequestBody,
|
|
1977
|
+
config?: AxiosRequestConfig
|
|
1978
|
+
): OperationResponse<Paths.UnassignPartnerUserRoles.Responses.$200>
|
|
1979
|
+
}
|
|
1980
|
+
|
|
1981
|
+
interface PathsDictionary {
|
|
1982
|
+
['/v1/partners/{id}/approve']: {
|
|
1983
|
+
/**
|
|
1984
|
+
* approvePartner - approvePartner
|
|
1985
|
+
*
|
|
1986
|
+
* Approves a pending partner request, allowing the partner to begin collaboration.
|
|
1987
|
+
*
|
|
1988
|
+
* When a partner requests to join your organization's partner network, this endpoint
|
|
1989
|
+
* is used to approve the request and activate the partnership.
|
|
1990
|
+
*
|
|
1991
|
+
*/
|
|
1992
|
+
'post'(
|
|
1993
|
+
parameters?: Parameters<Paths.ApprovePartner.PathParameters> | null,
|
|
1994
|
+
data?: any,
|
|
1995
|
+
config?: AxiosRequestConfig
|
|
1996
|
+
): OperationResponse<Paths.ApprovePartner.Responses.$201>
|
|
1997
|
+
}
|
|
1998
|
+
['/v1/partners/{id}/reject']: {
|
|
1999
|
+
/**
|
|
2000
|
+
* rejectPartner - rejectPartner
|
|
2001
|
+
*
|
|
2002
|
+
* Rejects a pending partner request, declining the partnership.
|
|
2003
|
+
*
|
|
2004
|
+
* When a partner requests to join your organization's partner network, this endpoint
|
|
2005
|
+
* is used to reject the request if the partnership is not desired.
|
|
2006
|
+
*
|
|
2007
|
+
*/
|
|
2008
|
+
'post'(
|
|
2009
|
+
parameters?: Parameters<Paths.RejectPartner.PathParameters> | null,
|
|
2010
|
+
data?: any,
|
|
2011
|
+
config?: AxiosRequestConfig
|
|
2012
|
+
): OperationResponse<Paths.RejectPartner.Responses.$200>
|
|
2013
|
+
}
|
|
2014
|
+
['/v1/partners/assignables:search']: {
|
|
2015
|
+
/**
|
|
2016
|
+
* searchAssignable - searchAssignable
|
|
2017
|
+
*
|
|
2018
|
+
* Search for users and organizations that can be assigned to tasks, workflows, or entities.
|
|
2019
|
+
*
|
|
2020
|
+
* This endpoint searches across your organization and all connected partner organizations
|
|
2021
|
+
* to find assignable resources. Use this when you need to assign someone to a task,
|
|
2022
|
+
* workflow step, or entity and want to include partners in the search.
|
|
2023
|
+
*
|
|
2024
|
+
* **Results can include:**
|
|
2025
|
+
* - `user`: Users in your organization
|
|
2026
|
+
* - `partner_user`: Users in partner organizations
|
|
2027
|
+
* - `partner_organization`: Partner organizations themselves (for organization-level assignments)
|
|
2028
|
+
* - `ecp`: End Customer Portal users
|
|
2029
|
+
* - `group`: User groups
|
|
2030
|
+
* - `parent_organization_user`: Users from parent organization (for sub-organizations)
|
|
2031
|
+
*
|
|
2032
|
+
* **Pagination:** Use `from` and `size` parameters for paginated results.
|
|
2033
|
+
*
|
|
2034
|
+
*/
|
|
2035
|
+
'post'(
|
|
2036
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
2037
|
+
data?: Paths.SearchAssignable.RequestBody,
|
|
2038
|
+
config?: AxiosRequestConfig
|
|
2039
|
+
): OperationResponse<Paths.SearchAssignable.Responses.$200>
|
|
2040
|
+
}
|
|
2041
|
+
['/v1/partners/assignables:batchGet']: {
|
|
2042
|
+
/**
|
|
2043
|
+
* batchGetAssignable - batchGetAssignable
|
|
2044
|
+
*
|
|
2045
|
+
* Retrieve multiple assignable users or groups by their IDs in a single request.
|
|
2046
|
+
*
|
|
2047
|
+
* Use this endpoint when you have a list of user or group IDs and need to fetch
|
|
2048
|
+
* their full assignable information. This is more efficient than making multiple
|
|
2049
|
+
* individual requests.
|
|
2050
|
+
*
|
|
2051
|
+
* Each item in the request array should specify either a `user_id` or `group_id`.
|
|
2052
|
+
*
|
|
2053
|
+
*/
|
|
2054
|
+
'post'(
|
|
2055
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
2056
|
+
data?: Paths.BatchGetAssignable.RequestBody,
|
|
2057
|
+
config?: AxiosRequestConfig
|
|
2058
|
+
): OperationResponse<Paths.BatchGetAssignable.Responses.$200>
|
|
2059
|
+
}
|
|
2060
|
+
['/v1/partner-directory/public/getPartnerByToken']: {
|
|
2061
|
+
/**
|
|
2062
|
+
* getPartnerByToken - getPartnerByToken
|
|
2063
|
+
*
|
|
2064
|
+
* Retrieves partner information using an invitation token.
|
|
2065
|
+
*
|
|
2066
|
+
* This is a **public endpoint** that does not require authentication.
|
|
2067
|
+
* It is used during the partner onboarding flow to display partner information
|
|
2068
|
+
* before the invited organization completes their registration.
|
|
2069
|
+
*
|
|
2070
|
+
* The token is sent to the partner via email when they are invited.
|
|
2071
|
+
*
|
|
2072
|
+
*/
|
|
2073
|
+
'get'(
|
|
2074
|
+
parameters?: Parameters<Paths.GetPartnerByToken.QueryParameters> | null,
|
|
2075
|
+
data?: any,
|
|
2076
|
+
config?: AxiosRequestConfig
|
|
2077
|
+
): OperationResponse<Paths.GetPartnerByToken.Responses.$200>
|
|
2078
|
+
}
|
|
2079
|
+
['/v1/partner-directory/public/activate']: {
|
|
2080
|
+
/**
|
|
2081
|
+
* activatePartner - activatePartner
|
|
2082
|
+
*
|
|
2083
|
+
* Activates a partner account using an invitation token.
|
|
2084
|
+
*
|
|
2085
|
+
* This is a **public endpoint** that does not require authentication.
|
|
2086
|
+
* It is called when an invited partner completes their registration to establish
|
|
2087
|
+
* the partnership between the two organizations.
|
|
2088
|
+
*
|
|
2089
|
+
* **Activation Flow:**
|
|
2090
|
+
* 1. Partner receives invitation email with token
|
|
2091
|
+
* 2. Partner clicks link and views invitation details (via `getPartnerByToken`)
|
|
2092
|
+
* 3. Partner completes registration form
|
|
2093
|
+
* 4. This endpoint is called to activate the partnership
|
|
2094
|
+
*
|
|
2095
|
+
* After activation, the partner organization can begin collaborating with
|
|
2096
|
+
* the inviting organization through shared entities and assignments.
|
|
2097
|
+
*
|
|
2098
|
+
*/
|
|
2099
|
+
'post'(
|
|
2100
|
+
parameters?: Parameters<Paths.ActivatePartner.QueryParameters> | null,
|
|
2101
|
+
data?: Paths.ActivatePartner.RequestBody,
|
|
2102
|
+
config?: AxiosRequestConfig
|
|
2103
|
+
): OperationResponse<Paths.ActivatePartner.Responses.$200>
|
|
2104
|
+
}
|
|
2105
|
+
['/v1/geolocation/text:search']: {
|
|
2106
|
+
/**
|
|
2107
|
+
* searchGeolocationForText - searchGeolocationForText
|
|
2108
|
+
*
|
|
2109
|
+
* Converts an address string to geographic coordinates (latitude and longitude).
|
|
2110
|
+
*
|
|
2111
|
+
* This endpoint is used to geocode partner addresses for location-based features such as:
|
|
2112
|
+
* - Partner search by proximity
|
|
2113
|
+
* - Displaying partners on a map
|
|
2114
|
+
* - Calculating activity radius coverage
|
|
2115
|
+
*
|
|
2116
|
+
* The address should be provided as a complete, well-formatted string for best results.
|
|
2117
|
+
*
|
|
2118
|
+
*/
|
|
2119
|
+
'post'(
|
|
2120
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
2121
|
+
data?: Paths.SearchGeolocationForText.RequestBody,
|
|
2122
|
+
config?: AxiosRequestConfig
|
|
2123
|
+
): OperationResponse<Paths.SearchGeolocationForText.Responses.$200>
|
|
2124
|
+
}
|
|
2125
|
+
['/v2/partners/{id}/invite']: {
|
|
2126
|
+
/**
|
|
2127
|
+
* invitePartnerV2 - invitePartnerV2
|
|
2128
|
+
*
|
|
2129
|
+
* Sends an invitation email to a partner organization to begin collaboration.
|
|
2130
|
+
*
|
|
2131
|
+
* This endpoint generates an invitation token and sends an email to the partner
|
|
2132
|
+
* with a link to complete their registration. The partner can then accept the
|
|
2133
|
+
* invitation to establish a B2B partnership.
|
|
2134
|
+
*
|
|
2135
|
+
* **Invitation Flow:**
|
|
2136
|
+
* 1. Create a partner record (via entity API)
|
|
2137
|
+
* 2. Call this endpoint to send the invitation email
|
|
2138
|
+
* 3. Partner receives email with unique invitation link
|
|
2139
|
+
* 4. Partner activates their account via the public activation endpoint
|
|
2140
|
+
*
|
|
2141
|
+
* The invitation email language can be customized via the request body.
|
|
2142
|
+
*
|
|
2143
|
+
*/
|
|
2144
|
+
'post'(
|
|
2145
|
+
parameters?: Parameters<Paths.InvitePartnerV2.PathParameters> | null,
|
|
2146
|
+
data?: Paths.InvitePartnerV2.RequestBody,
|
|
2147
|
+
config?: AxiosRequestConfig
|
|
2148
|
+
): OperationResponse<Paths.InvitePartnerV2.Responses.$200>
|
|
2149
|
+
}
|
|
2150
|
+
['/v2/partners/{orgId}/users']: {
|
|
2151
|
+
/**
|
|
2152
|
+
* getPartnerUsers - getPartnerUsers
|
|
2153
|
+
*
|
|
2154
|
+
* Retrieves all users belonging to a partner organization along with their assigned roles.
|
|
2155
|
+
*
|
|
2156
|
+
* This endpoint allows parent organizations to view and manage the users within
|
|
2157
|
+
* their partner organizations. The response includes user details and their
|
|
2158
|
+
* role assignments within the partner organization.
|
|
2159
|
+
*
|
|
2160
|
+
*/
|
|
2161
|
+
'get'(
|
|
2162
|
+
parameters?: Parameters<Paths.GetPartnerUsers.PathParameters> | null,
|
|
2163
|
+
data?: any,
|
|
2164
|
+
config?: AxiosRequestConfig
|
|
2165
|
+
): OperationResponse<Paths.GetPartnerUsers.Responses.$200>
|
|
2166
|
+
/**
|
|
2167
|
+
* createPartnerUser - createPartnerUser
|
|
2168
|
+
*
|
|
2169
|
+
* Creates a new user in a partner organization.
|
|
2170
|
+
*
|
|
2171
|
+
* This endpoint allows parent organizations to create users directly within
|
|
2172
|
+
* their partner organizations. The new user will receive an invitation email
|
|
2173
|
+
* to set up their account.
|
|
2174
|
+
*
|
|
2175
|
+
* Optionally, roles can be assigned to the user at creation time.
|
|
2176
|
+
*
|
|
2177
|
+
*/
|
|
2178
|
+
'post'(
|
|
2179
|
+
parameters?: Parameters<Paths.CreatePartnerUser.PathParameters> | null,
|
|
2180
|
+
data?: Paths.CreatePartnerUser.RequestBody,
|
|
2181
|
+
config?: AxiosRequestConfig
|
|
2182
|
+
): OperationResponse<Paths.CreatePartnerUser.Responses.$201>
|
|
2183
|
+
}
|
|
2184
|
+
['/v2/partners/{orgId}/users/{userId}']: {
|
|
2185
|
+
/**
|
|
2186
|
+
* deletePartnerUser - deletePartnerUser
|
|
2187
|
+
*
|
|
2188
|
+
* Removes a user from a partner organization.
|
|
2189
|
+
*
|
|
2190
|
+
* This endpoint allows parent organizations to delete users from their partner
|
|
2191
|
+
* organizations. The user will lose access to the partner organization immediately.
|
|
2192
|
+
*
|
|
2193
|
+
* **Note:** This action is permanent and cannot be undone.
|
|
2194
|
+
*
|
|
2195
|
+
*/
|
|
2196
|
+
'delete'(
|
|
2197
|
+
parameters?: Parameters<Paths.DeletePartnerUser.PathParameters> | null,
|
|
2198
|
+
data?: any,
|
|
2199
|
+
config?: AxiosRequestConfig
|
|
2200
|
+
): OperationResponse<Paths.DeletePartnerUser.Responses.$200>
|
|
2201
|
+
}
|
|
2202
|
+
['/v2/partners/{orgId}/roles']: {
|
|
2203
|
+
/**
|
|
2204
|
+
* getPartnerRoles - getPartnerRoles
|
|
2205
|
+
*
|
|
2206
|
+
* Retrieves all roles defined for a partner organization.
|
|
2207
|
+
*
|
|
2208
|
+
* Roles define the permissions that users in the partner organization have.
|
|
2209
|
+
* Parent organizations can use this endpoint to view available roles before
|
|
2210
|
+
* assigning them to partner users.
|
|
2211
|
+
*
|
|
2212
|
+
*/
|
|
2213
|
+
'get'(
|
|
2214
|
+
parameters?: Parameters<Paths.GetPartnerRoles.PathParameters> | null,
|
|
2215
|
+
data?: any,
|
|
2216
|
+
config?: AxiosRequestConfig
|
|
2217
|
+
): OperationResponse<Paths.GetPartnerRoles.Responses.$200>
|
|
2218
|
+
/**
|
|
2219
|
+
* createPartnerRole - createPartnerRole
|
|
2220
|
+
*
|
|
2221
|
+
* Creates a new role for a partner organization.
|
|
2222
|
+
*
|
|
2223
|
+
* Roles define permissions for partner users. The parent organization can create
|
|
2224
|
+
* custom roles with specific permission grants to control what partner users
|
|
2225
|
+
* can access and modify.
|
|
2226
|
+
*
|
|
2227
|
+
* **Permission Grants:**
|
|
2228
|
+
* Each role contains a list of grants that define allowed (or denied) actions
|
|
2229
|
+
* on specific resources. See the Grant schema for details on defining permissions.
|
|
2230
|
+
*
|
|
2231
|
+
*/
|
|
2232
|
+
'post'(
|
|
2233
|
+
parameters?: Parameters<Paths.CreatePartnerRole.PathParameters> | null,
|
|
2234
|
+
data?: Paths.CreatePartnerRole.RequestBody,
|
|
2235
|
+
config?: AxiosRequestConfig
|
|
2236
|
+
): OperationResponse<Paths.CreatePartnerRole.Responses.$201>
|
|
2237
|
+
}
|
|
2238
|
+
['/v2/partners/{orgId}/roles/{roleId}']: {
|
|
2239
|
+
/**
|
|
2240
|
+
* updatePartnerRole - updatePartnerRole
|
|
2241
|
+
*
|
|
2242
|
+
* Updates an existing role in a partner organization.
|
|
2243
|
+
*
|
|
2244
|
+
* Use this endpoint to modify the permissions (grants) or metadata of an existing
|
|
2245
|
+
* role. All users with this role will immediately have the updated permissions.
|
|
2246
|
+
*
|
|
2247
|
+
* **Note:** Changing role permissions affects all users currently assigned to the role.
|
|
2248
|
+
*
|
|
2249
|
+
*/
|
|
2250
|
+
'put'(
|
|
2251
|
+
parameters?: Parameters<Paths.UpdatePartnerRole.PathParameters> | null,
|
|
2252
|
+
data?: Paths.UpdatePartnerRole.RequestBody,
|
|
2253
|
+
config?: AxiosRequestConfig
|
|
2254
|
+
): OperationResponse<Paths.UpdatePartnerRole.Responses.$200>
|
|
2255
|
+
/**
|
|
2256
|
+
* deletePartnerRole - deletePartnerRole
|
|
2257
|
+
*
|
|
2258
|
+
* Delete a role from a partner organization
|
|
2259
|
+
*/
|
|
2260
|
+
'delete'(
|
|
2261
|
+
parameters?: Parameters<Paths.DeletePartnerRole.PathParameters> | null,
|
|
2262
|
+
data?: any,
|
|
2263
|
+
config?: AxiosRequestConfig
|
|
2264
|
+
): OperationResponse<Paths.DeletePartnerRole.Responses.$200>
|
|
2265
|
+
}
|
|
2266
|
+
['/v2/partners/{orgId}/users/{userId}/roles']: {
|
|
2267
|
+
/**
|
|
2268
|
+
* assignPartnerUserRoles - assignPartnerUserRoles
|
|
2269
|
+
*
|
|
2270
|
+
* Assigns one or more roles to a user in a partner organization.
|
|
2271
|
+
*
|
|
2272
|
+
* Roles define the permissions that the user has within the partner organization.
|
|
2273
|
+
* Multiple roles can be assigned in a single request. The response indicates
|
|
2274
|
+
* the success or failure of each role assignment.
|
|
2275
|
+
*
|
|
2276
|
+
*/
|
|
2277
|
+
'post'(
|
|
2278
|
+
parameters?: Parameters<Paths.AssignPartnerUserRoles.PathParameters> | null,
|
|
2279
|
+
data?: Paths.AssignPartnerUserRoles.RequestBody,
|
|
2280
|
+
config?: AxiosRequestConfig
|
|
2281
|
+
): OperationResponse<Paths.AssignPartnerUserRoles.Responses.$200>
|
|
2282
|
+
/**
|
|
2283
|
+
* unassignPartnerUserRoles - unassignPartnerUserRoles
|
|
2284
|
+
*
|
|
2285
|
+
* Removes one or more roles from a user in a partner organization.
|
|
2286
|
+
*
|
|
2287
|
+
* This endpoint removes the specified roles from the user, reducing their permissions
|
|
2288
|
+
* within the partner organization. The response indicates the success or failure
|
|
2289
|
+
* of each role removal.
|
|
2290
|
+
*
|
|
2291
|
+
* **Note:** Removing all roles from a user may result in the user having no access
|
|
2292
|
+
* to the partner organization.
|
|
2293
|
+
*
|
|
2294
|
+
*/
|
|
2295
|
+
'delete'(
|
|
2296
|
+
parameters?: Parameters<Paths.UnassignPartnerUserRoles.PathParameters> | null,
|
|
2297
|
+
data?: Paths.UnassignPartnerUserRoles.RequestBody,
|
|
2298
|
+
config?: AxiosRequestConfig
|
|
2299
|
+
): OperationResponse<Paths.UnassignPartnerUserRoles.Responses.$200>
|
|
2300
|
+
}
|
|
2301
|
+
}
|
|
2302
|
+
|
|
2303
|
+
type Client = OpenAPIClient<OperationMethods, PathsDictionary>
|
|
2304
|
+
|
|
2305
|
+
|
|
2306
|
+
type ActivatePartnerPayload = Components.Schemas.ActivatePartnerPayload;
|
|
2307
|
+
type Address = Components.Schemas.Address;
|
|
2308
|
+
type AddressGeolocation = Components.Schemas.AddressGeolocation;
|
|
2309
|
+
type AssignRolesPayload = Components.Schemas.AssignRolesPayload;
|
|
2310
|
+
type Assignable = Components.Schemas.Assignable;
|
|
2311
|
+
type AssignableEcpPlaceholder = Components.Schemas.AssignableEcpPlaceholder;
|
|
2312
|
+
type AssignableGroup = Components.Schemas.AssignableGroup;
|
|
2313
|
+
type AssignableOrganization = Components.Schemas.AssignableOrganization;
|
|
2314
|
+
type AssignablePartnerUser = Components.Schemas.AssignablePartnerUser;
|
|
2315
|
+
type AssignableUser = Components.Schemas.AssignableUser;
|
|
2316
|
+
type BaseAssignable = Components.Schemas.BaseAssignable;
|
|
2317
|
+
type BaseRoleForCreate = Components.Schemas.BaseRoleForCreate;
|
|
2318
|
+
type CreatePartnerRolePayload = Components.Schemas.CreatePartnerRolePayload;
|
|
2319
|
+
type CreatePartnerUserPayload = Components.Schemas.CreatePartnerUserPayload;
|
|
2320
|
+
type EqualsCondition = Components.Schemas.EqualsCondition;
|
|
2321
|
+
type Geolocation = Components.Schemas.Geolocation;
|
|
2322
|
+
type Grant = Components.Schemas.Grant;
|
|
2323
|
+
type GrantCondition = Components.Schemas.GrantCondition;
|
|
2324
|
+
type GrantWithDependencies = Components.Schemas.GrantWithDependencies;
|
|
2325
|
+
type InviteToken = Components.Schemas.InviteToken;
|
|
2326
|
+
type OrganizationId = Components.Schemas.OrganizationId;
|
|
2327
|
+
type Partner = Components.Schemas.Partner;
|
|
2328
|
+
type PartnerId = Components.Schemas.PartnerId;
|
|
2329
|
+
type PartnerInvitationPayload = Components.Schemas.PartnerInvitationPayload;
|
|
2330
|
+
type PartnerRole = Components.Schemas.PartnerRole;
|
|
2331
|
+
type PartnerUser = Components.Schemas.PartnerUser;
|
|
2332
|
+
type RoleId = Components.Schemas.RoleId;
|
|
2333
|
+
type SearchGeolocation = Components.Schemas.SearchGeolocation;
|
|
2334
|
+
type UpdatePartnerRolePayload = Components.Schemas.UpdatePartnerRolePayload;
|
|
2335
|
+
type User = Components.Schemas.User;
|
|
2336
|
+
|
|
2337
|
+
export { type ActivatePartnerPayload as A, type BaseAssignable as B, type Client as C, type EqualsCondition as E, type Geolocation as G, type InviteToken as I, type OperationMethods as O, Paths as P, type RoleId as R, type SearchGeolocation as S, type UpdatePartnerRolePayload as U, Components as a, type PathsDictionary as b, type Address as c, type AddressGeolocation as d, type AssignRolesPayload as e, type Assignable as f, type AssignableEcpPlaceholder as g, type AssignableGroup as h, type AssignableOrganization as i, type AssignablePartnerUser as j, type AssignableUser as k, type BaseRoleForCreate as l, type CreatePartnerRolePayload as m, type CreatePartnerUserPayload as n, type Grant as o, type GrantCondition as p, type GrantWithDependencies as q, type OrganizationId as r, type Partner as s, type PartnerId as t, type PartnerInvitationPayload as u, type PartnerRole as v, type PartnerUser as w, type User as x };
|