@a1liu/solidarity-tech-api 0.1.6 → 0.1.7

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.
@@ -1,568 +0,0 @@
1
- import type * as types from './types';
2
- import type { ConfigOptions, FetchResponse } from 'api/dist/core';
3
- import Oas from 'oas';
4
- import APICore from 'api/dist/core';
5
- declare class SDK {
6
- spec: Oas;
7
- core: APICore;
8
- constructor();
9
- /**
10
- * Optionally configure various options that the SDK allows.
11
- *
12
- * @param config Object of supported SDK options and toggles.
13
- * @param config.timeout Override the default `fetch` request timeout of 30 seconds. This number
14
- * should be represented in milliseconds.
15
- */
16
- config(config: ConfigOptions): void;
17
- /**
18
- * If the API you're using requires authentication you can supply the required credentials
19
- * through this method and the library will magically determine how they should be used
20
- * within your API request.
21
- *
22
- * With the exception of OpenID and MutualTLS, it supports all forms of authentication
23
- * supported by the OpenAPI specification.
24
- *
25
- * @example <caption>HTTP Basic auth</caption>
26
- * sdk.auth('username', 'password');
27
- *
28
- * @example <caption>Bearer tokens (HTTP or OAuth 2)</caption>
29
- * sdk.auth('myBearerToken');
30
- *
31
- * @example <caption>API Keys</caption>
32
- * sdk.auth('myApiKey');
33
- *
34
- * @see {@link https://spec.openapis.org/oas/v3.0.3#fixed-fields-22}
35
- * @see {@link https://spec.openapis.org/oas/v3.1.0#fixed-fields-22}
36
- * @param values Your auth credentials for the API; can specify up to two strings or numbers.
37
- */
38
- auth(...values: string[] | number[]): this;
39
- /**
40
- * If the API you're using offers alternate server URLs, and server variables, you can tell
41
- * the SDK which one to use with this method. To use it you can supply either one of the
42
- * server URLs that are contained within the OpenAPI definition (along with any server
43
- * variables), or you can pass it a fully qualified URL to use (that may or may not exist
44
- * within the OpenAPI definition).
45
- *
46
- * @example <caption>Server URL with server variables</caption>
47
- * sdk.server('https://{region}.api.example.com/{basePath}', {
48
- * name: 'eu',
49
- * basePath: 'v14',
50
- * });
51
- *
52
- * @example <caption>Fully qualified server URL</caption>
53
- * sdk.server('https://eu.api.example.com/v14');
54
- *
55
- * @param url Server URL
56
- * @param variables An object of variables to replace into the server URL.
57
- */
58
- server(url: string, variables?: {}): void;
59
- /**
60
- * Retrieves all activities
61
- *
62
- */
63
- getActivities(metadata?: types.GetActivitiesMetadataParam): Promise<FetchResponse<200, types.GetActivitiesResponse200>>;
64
- /**
65
- * Lists agent assignments
66
- *
67
- */
68
- getAgent_assignments(metadata?: types.GetAgentAssignmentsMetadataParam): Promise<FetchResponse<number, unknown>>;
69
- /**
70
- * Creates an agent assignment with the specified details.
71
- *
72
- * @summary Creates an agent assignment
73
- */
74
- postAgent_assignments(body: types.PostAgentAssignmentsBodyParam): Promise<FetchResponse<number, unknown>>;
75
- /**
76
- * Shows a single agent assignment
77
- *
78
- */
79
- getAgent_assignmentsId(metadata: types.GetAgentAssignmentsIdMetadataParam): Promise<FetchResponse<number, unknown>>;
80
- /**
81
- * Updates an agent assignment with the specified details.
82
- *
83
- * @summary Updates an agent assignment
84
- */
85
- putAgent_assignmentsId(body: types.PutAgentAssignmentsIdBodyParam, metadata: types.PutAgentAssignmentsIdMetadataParam): Promise<FetchResponse<number, unknown>>;
86
- /**
87
- * Deletes an agent assignment with the specified ID.
88
- *
89
- * @summary Deletes an agent assignment
90
- */
91
- deleteAgent_assignmentsId(metadata: types.DeleteAgentAssignmentsIdMetadataParam): Promise<FetchResponse<number, unknown>>;
92
- /**
93
- * Enroll user in an automation
94
- *
95
- */
96
- postAutomation_enrollments(body: types.PostAutomationEnrollmentsBodyParam): Promise<FetchResponse<number, unknown>>;
97
- /**
98
- * Retrieves all calls
99
- *
100
- */
101
- getCalls(metadata?: types.GetCallsMetadataParam): Promise<FetchResponse<200, types.GetCallsResponse200>>;
102
- /**
103
- * Lists chapter phone numbers
104
- *
105
- */
106
- getChapter_phone_numbers(metadata?: types.GetChapterPhoneNumbersMetadataParam): Promise<FetchResponse<number, unknown>>;
107
- /**
108
- * Retrieves all chapters
109
- *
110
- */
111
- getChapters(metadata?: types.GetChaptersMetadataParam): Promise<FetchResponse<200, types.GetChaptersResponse200>>;
112
- /**
113
- * Retrieves all custom user properties
114
- *
115
- */
116
- getCustom_user_properties(metadata?: types.GetCustomUserPropertiesMetadataParam): Promise<FetchResponse<200, types.GetCustomUserPropertiesResponse200>>;
117
- /**
118
- * Creates a new custom user property
119
- *
120
- * @throws FetchError<422, types.PostCustomUserPropertiesResponse422> validation failed
121
- */
122
- postCustom_user_properties(body: types.PostCustomUserPropertiesBodyParam): Promise<FetchResponse<201, types.PostCustomUserPropertiesResponse201>>;
123
- /**
124
- * Removes an option from a custom user property
125
- *
126
- * @throws FetchError<404, types.DeleteCustomUserPropertiesCustomUserPropertyIdOptionsIdResponse404> option or custom user property not found
127
- * @throws FetchError<422, types.DeleteCustomUserPropertiesCustomUserPropertyIdOptionsIdResponse422> validation failed
128
- */
129
- deleteCustom_user_propertiesCustom_user_property_idOptionsId(metadata: types.DeleteCustomUserPropertiesCustomUserPropertyIdOptionsIdMetadataParam): Promise<FetchResponse<200, types.DeleteCustomUserPropertiesCustomUserPropertyIdOptionsIdResponse200>>;
130
- /**
131
- * Creates an option for a custom user property
132
- *
133
- * @throws FetchError<404, types.PostCustomUserPropertiesIdOptionsResponse404> custom user property not found
134
- * @throws FetchError<422, types.PostCustomUserPropertiesIdOptionsResponse422> validation failed
135
- */
136
- postCustom_user_propertiesIdOptions(body: types.PostCustomUserPropertiesIdOptionsBodyParam, metadata: types.PostCustomUserPropertiesIdOptionsMetadataParam): Promise<FetchResponse<201, types.PostCustomUserPropertiesIdOptionsResponse201>>;
137
- /**
138
- * Lists donation charges
139
- *
140
- */
141
- getDonation_charges(metadata?: types.GetDonationChargesMetadataParam): Promise<FetchResponse<200, types.GetDonationChargesResponse200>>;
142
- /**
143
- * Retrieves a donation charge
144
- *
145
- */
146
- getDonation_chargesId(metadata: types.GetDonationChargesIdMetadataParam): Promise<FetchResponse<number, unknown>>;
147
- /**
148
- * Lists email blasts
149
- *
150
- */
151
- getEmail_blasts(metadata?: types.GetEmailBlastsMetadataParam): Promise<FetchResponse<number, unknown>>;
152
- /**
153
- * Shows a single email blast
154
- *
155
- */
156
- getEmail_blastsId(metadata: types.GetEmailBlastsIdMetadataParam): Promise<FetchResponse<number, unknown>>;
157
- /**
158
- * Returns a list of email senders available for the API key's scope. Use these sender IDs
159
- * when sending emails via the POST /emails endpoint.
160
- *
161
- * @summary Lists available email senders
162
- */
163
- getEmail_senders(metadata?: types.GetEmailSendersMetadataParam): Promise<FetchResponse<200, types.GetEmailSendersResponse200>>;
164
- /**
165
- * Sends a single transactional email to a user. Supports Liquid templating for
166
- * personalization (e.g., {{ first_name }}).
167
- *
168
- * @summary Sends a one-off email to a user
169
- */
170
- postEmails(metadata: types.PostEmailsMetadataParam): Promise<FetchResponse<number, unknown>>;
171
- /**
172
- * Lists event attendances
173
- *
174
- */
175
- getEvent_attendances(metadata?: types.GetEventAttendancesMetadataParam): Promise<FetchResponse<number, unknown>>;
176
- /**
177
- * Creates an event attendance with the specified details.
178
- *
179
- * @summary Creates an event attendance
180
- */
181
- postEvent_attendances(body: types.PostEventAttendancesBodyParam): Promise<FetchResponse<number, unknown>>;
182
- /**
183
- * Deletes an event attendance with the specified ID.
184
- *
185
- * @summary Deletes an event attendance
186
- */
187
- deleteEvent_attendancesId(metadata: types.DeleteEventAttendancesIdMetadataParam): Promise<FetchResponse<number, unknown>>;
188
- /**
189
- * Lists event rsvps
190
- *
191
- */
192
- getEvent_rsvps(metadata?: types.GetEventRsvpsMetadataParam): Promise<FetchResponse<number, unknown>>;
193
- /**
194
- * Creates an event rsvp with the specified details.
195
- *
196
- * @summary Creates an event rsvp
197
- */
198
- postEvent_rsvps(body: types.PostEventRsvpsBodyParam): Promise<FetchResponse<number, unknown>>;
199
- /**
200
- * Shows a single event rsvp
201
- *
202
- */
203
- getEvent_rsvpsId(metadata: types.GetEventRsvpsIdMetadataParam): Promise<FetchResponse<number, unknown>>;
204
- /**
205
- * Updates an event rsvp with the specified details.
206
- *
207
- * @summary Updates an event rsvp
208
- */
209
- putEvent_rsvpsId(body: types.PutEventRsvpsIdBodyParam, metadata: types.PutEventRsvpsIdMetadataParam): Promise<FetchResponse<number, unknown>>;
210
- /**
211
- * Deletes an event rsvp with the specified ID.
212
- *
213
- * @summary Deletes an event rsvp
214
- */
215
- deleteEvent_rsvpsId(metadata: types.DeleteEventRsvpsIdMetadataParam): Promise<FetchResponse<number, unknown>>;
216
- /**
217
- * Lists event sessions
218
- *
219
- */
220
- getEvent_sessions(metadata?: types.GetEventSessionsMetadataParam): Promise<FetchResponse<number, unknown>>;
221
- /**
222
- * Creates an event session with the specified details.
223
- *
224
- * @summary Creates an event session
225
- */
226
- postEvent_sessions(body: types.PostEventSessionsBodyParam): Promise<FetchResponse<number, unknown>>;
227
- /**
228
- * Shows a single event session
229
- *
230
- */
231
- getEvent_sessionsId(metadata: types.GetEventSessionsIdMetadataParam): Promise<FetchResponse<number, unknown>>;
232
- /**
233
- * Updates an event session with the specified details.
234
- *
235
- * @summary Updates an event session
236
- */
237
- putEvent_sessionsId(body: types.PutEventSessionsIdBodyParam, metadata: types.PutEventSessionsIdMetadataParam): Promise<FetchResponse<number, unknown>>;
238
- /**
239
- * Deletes an event session with the specified ID.
240
- *
241
- * @summary Deletes an event session
242
- */
243
- deleteEvent_sessionsId(metadata: types.DeleteEventSessionsIdMetadataParam): Promise<FetchResponse<number, unknown>>;
244
- /**
245
- * Lists events accessible within the given scope. Each event in the response includes
246
- * `primary_event_id` and `is_co_hosted_mirror`. For co-hosted events that appear across
247
- * multiple organizations, `primary_event_id` always resolves to the original event ID,
248
- * allowing you to identify that two events from different scopes represent the same real
249
- * world event. Each event session also includes `primary_session_id` for the same purpose.
250
- * Events with an event page also include `image_url` and `description` fields.
251
- *
252
- * @summary Lists events
253
- */
254
- getEvents(metadata?: types.GetEventsMetadataParam): Promise<FetchResponse<number, unknown>>;
255
- /**
256
- * Creates an event with its first event session. The event session inherits the title from
257
- * the event unless session_title is provided.
258
- *
259
- * @summary Creates an event
260
- */
261
- postEvents(body: types.PostEventsBodyParam): Promise<FetchResponse<number, unknown>>;
262
- /**
263
- * Returns a single event. The response includes `primary_event_id` (always resolves to the
264
- * original event ID, even for co-hosted mirrors) and `is_co_hosted_mirror` (true if this
265
- * event is a mirror copy from a co-host relationship). Event sessions include
266
- * `primary_session_id` for the same purpose. If the event has an event page, the response
267
- * also includes `image_url` (the event page image) and `description` (plain text content
268
- * from the event page). Both fields are null when no event page exists.
269
- *
270
- * @summary Shows a single event
271
- */
272
- getEventsId(metadata: types.GetEventsIdMetadataParam): Promise<FetchResponse<number, unknown>>;
273
- /**
274
- * Generates a field survey URL
275
- *
276
- */
277
- postField_survey_urls(body: types.PostFieldSurveyUrlsBodyParam): Promise<FetchResponse<200, types.PostFieldSurveyUrlsResponse200>>;
278
- /**
279
- * Lists organizations
280
- *
281
- */
282
- getOrganizations(metadata?: types.GetOrganizationsMetadataParam): Promise<FetchResponse<number, unknown>>;
283
- /**
284
- * Shows a single organization
285
- *
286
- */
287
- getOrganizationsId(metadata: types.GetOrganizationsIdMetadataParam): Promise<FetchResponse<number, unknown>>;
288
- /**
289
- * Lists pages
290
- *
291
- */
292
- getPages(metadata?: types.GetPagesMetadataParam): Promise<FetchResponse<number, unknown>>;
293
- /**
294
- * Shows a single page
295
- *
296
- */
297
- getPagesId(metadata: types.GetPagesIdMetadataParam): Promise<FetchResponse<number, unknown>>;
298
- /**
299
- * Lists phonebanks
300
- *
301
- */
302
- getPhonebanks(metadata?: types.GetPhonebanksMetadataParam): Promise<FetchResponse<number, unknown>>;
303
- /**
304
- * Shows a single phonebank
305
- *
306
- */
307
- getPhonebanksId(metadata: types.GetPhonebanksIdMetadataParam): Promise<FetchResponse<number, unknown>>;
308
- /**
309
- * Lists scheduled calls
310
- *
311
- */
312
- getScheduled_calls(metadata?: types.GetScheduledCallsMetadataParam): Promise<FetchResponse<number, unknown>>;
313
- /**
314
- * Shows a single scheduled call
315
- *
316
- */
317
- getScheduled_callsId(metadata: types.GetScheduledCallsIdMetadataParam): Promise<FetchResponse<number, unknown>>;
318
- /**
319
- * Lists scheduled tasks
320
- *
321
- */
322
- getScheduled_tasks(metadata?: types.GetScheduledTasksMetadataParam): Promise<FetchResponse<number, unknown>>;
323
- /**
324
- * Creates an scheduled task with the specified details.
325
- *
326
- * @summary Creates an scheduled task
327
- */
328
- postScheduled_tasks(body: types.PostScheduledTasksBodyParam): Promise<FetchResponse<number, unknown>>;
329
- /**
330
- * Shows a single scheduled task
331
- *
332
- */
333
- getScheduled_tasksId(metadata: types.GetScheduledTasksIdMetadataParam): Promise<FetchResponse<number, unknown>>;
334
- /**
335
- * Updates an scheduled task with the specified details.
336
- *
337
- * @summary Updates an scheduled task
338
- */
339
- putScheduled_tasksId(body: types.PutScheduledTasksIdBodyParam, metadata: types.PutScheduledTasksIdMetadataParam): Promise<FetchResponse<number, unknown>>;
340
- /**
341
- * Deletes an scheduled task with the specified ID.
342
- *
343
- * @summary Deletes an scheduled task
344
- */
345
- deleteScheduled_tasksId(metadata: types.DeleteScheduledTasksIdMetadataParam): Promise<FetchResponse<number, unknown>>;
346
- /**
347
- * Lists task agents
348
- *
349
- */
350
- getTask_agents(metadata?: types.GetTaskAgentsMetadataParam): Promise<FetchResponse<number, unknown>>;
351
- /**
352
- * Creates an task agent with the specified details.
353
- *
354
- * @summary Creates an task agent
355
- */
356
- postTask_agents(body: types.PostTaskAgentsBodyParam): Promise<FetchResponse<number, unknown>>;
357
- /**
358
- * Shows a single task agent
359
- *
360
- */
361
- getTask_agentsId(metadata: types.GetTaskAgentsIdMetadataParam): Promise<FetchResponse<number, unknown>>;
362
- /**
363
- * Deletes an task agent with the specified ID.
364
- *
365
- * @summary Deletes an task agent
366
- */
367
- deleteTask_agentsId(metadata: types.DeleteTaskAgentsIdMetadataParam): Promise<FetchResponse<number, unknown>>;
368
- /**
369
- * Lists task assignments
370
- *
371
- */
372
- getTask_assignments(metadata?: types.GetTaskAssignmentsMetadataParam): Promise<FetchResponse<number, unknown>>;
373
- /**
374
- * Creates a task assignment, assigning a user to participate in a phonebank or textbank
375
- * campaign.
376
- *
377
- * @summary Creates a task assignment
378
- */
379
- postTask_assignments(body: types.PostTaskAssignmentsBodyParam): Promise<FetchResponse<number, unknown>>;
380
- /**
381
- * Shows a single task assignment
382
- *
383
- */
384
- getTask_assignmentsId(metadata: types.GetTaskAssignmentsIdMetadataParam): Promise<FetchResponse<number, unknown>>;
385
- /**
386
- * Updates an task assignment with the specified details.
387
- *
388
- * @summary Updates an task assignment
389
- */
390
- putTask_assignmentsId(body: types.PutTaskAssignmentsIdBodyParam, metadata: types.PutTaskAssignmentsIdMetadataParam): Promise<FetchResponse<number, unknown>>;
391
- /**
392
- * Deletes an task assignment with the specified ID.
393
- *
394
- * @summary Deletes an task assignment
395
- */
396
- deleteTask_assignmentsId(metadata: types.DeleteTaskAssignmentsIdMetadataParam): Promise<FetchResponse<number, unknown>>;
397
- /**
398
- * Lists team members
399
- *
400
- */
401
- getTeam_members(metadata?: types.GetTeamMembersMetadataParam): Promise<FetchResponse<number, unknown>>;
402
- /**
403
- * Creates a new team member
404
- *
405
- */
406
- postTeam_members(body: types.PostTeamMembersBodyParam): Promise<FetchResponse<number, unknown>>;
407
- /**
408
- * Updates a team member
409
- *
410
- */
411
- putTeam_membersId(body: types.PutTeamMembersIdBodyParam, metadata: types.PutTeamMembersIdMetadataParam): Promise<FetchResponse<number, unknown>>;
412
- /**
413
- * Lists text blasts
414
- *
415
- */
416
- getText_blasts(metadata?: types.GetTextBlastsMetadataParam): Promise<FetchResponse<number, unknown>>;
417
- /**
418
- * Shows a single text blast
419
- *
420
- */
421
- getText_blastsId(metadata: types.GetTextBlastsIdMetadataParam): Promise<FetchResponse<number, unknown>>;
422
- /**
423
- * Lists text templates
424
- *
425
- */
426
- getText_templates(metadata?: types.GetTextTemplatesMetadataParam): Promise<FetchResponse<number, unknown>>;
427
- /**
428
- * Creates an text template with the specified details.
429
- *
430
- * @summary Creates an text template
431
- */
432
- postText_templates(body: types.PostTextTemplatesBodyParam): Promise<FetchResponse<number, unknown>>;
433
- /**
434
- * Shows a single text template
435
- *
436
- */
437
- getText_templatesId(metadata: types.GetTextTemplatesIdMetadataParam): Promise<FetchResponse<number, unknown>>;
438
- /**
439
- * Updates an text template with the specified details.
440
- *
441
- * @summary Updates an text template
442
- */
443
- putText_templatesId(body: types.PutTextTemplatesIdBodyParam, metadata: types.PutTextTemplatesIdMetadataParam): Promise<FetchResponse<number, unknown>>;
444
- /**
445
- * Deletes an text template with the specified ID.
446
- *
447
- * @summary Deletes an text template
448
- */
449
- deleteText_templatesId(metadata: types.DeleteTextTemplatesIdMetadataParam): Promise<FetchResponse<number, unknown>>;
450
- /**
451
- * Lists textbanks
452
- *
453
- */
454
- getTextbanks(metadata?: types.GetTextbanksMetadataParam): Promise<FetchResponse<number, unknown>>;
455
- /**
456
- * Shows a single textbank
457
- *
458
- */
459
- getTextbanksId(metadata: types.GetTextbanksIdMetadataParam): Promise<FetchResponse<number, unknown>>;
460
- /**
461
- * Sends a text message
462
- *
463
- */
464
- postTexts(metadata: types.PostTextsMetadataParam): Promise<FetchResponse<number, unknown>>;
465
- /**
466
- * Retrieves a list of texts
467
- *
468
- */
469
- getTexts(metadata?: types.GetTextsMetadataParam): Promise<FetchResponse<200, types.GetTextsResponse200>>;
470
- /**
471
- * Lists user actions (form submissions). Can be filtered by user_id, page_id, or both. To
472
- * get custom form responses for event RSVPs, first get the event's event_page_id from GET
473
- * /events/{id}, then query this endpoint with that page_id. Match to RSVPs by user_id.
474
- *
475
- * @summary Retrieves user actions
476
- */
477
- getUser_actions(metadata?: types.GetUserActionsMetadataParam): Promise<FetchResponse<number, unknown>>;
478
- /**
479
- * Creates a user action for a user. Note: This endpoint cannot be used for creating
480
- * actions related to donation pages or scheduled call pages.
481
- *
482
- * @summary Creates a user action
483
- */
484
- postUser_actions(body: types.PostUserActionsBodyParam): Promise<FetchResponse<number, unknown>>;
485
- /**
486
- * Lists user lists
487
- *
488
- */
489
- getUser_lists(metadata?: types.GetUserListsMetadataParam): Promise<FetchResponse<number, unknown>>;
490
- /**
491
- * Creates a User List with the specified details. The parameters field must conform to the
492
- * QueryBuilder format.
493
- *
494
- * @summary Creates a user list
495
- */
496
- postUser_lists(body: types.PostUserListsBodyParam): Promise<FetchResponse<number, unknown>>;
497
- /**
498
- * Shows a single user list
499
- *
500
- */
501
- getUser_listsId(metadata: types.GetUserListsIdMetadataParam): Promise<FetchResponse<number, unknown>>;
502
- /**
503
- * Updates a user list with the specified details.
504
- *
505
- * @summary Updates a user list
506
- */
507
- putUser_listsId(body: types.PutUserListsIdBodyParam, metadata: types.PutUserListsIdMetadataParam): Promise<FetchResponse<number, unknown>>;
508
- /**
509
- * Deletes a user list with the specified ID.
510
- *
511
- * @summary Deletes a user list
512
- */
513
- deleteUser_listsId(metadata: types.DeleteUserListsIdMetadataParam): Promise<FetchResponse<number, unknown>>;
514
- /**
515
- * Creates a user note
516
- *
517
- */
518
- postUser_notes(metadata: types.PostUserNotesMetadataParam): Promise<FetchResponse<number, unknown>>;
519
- /**
520
- * Deletes a user note with the specified ID.
521
- *
522
- * @summary Deletes a user note
523
- */
524
- deleteUser_notesId(metadata: types.DeleteUserNotesIdMetadataParam): Promise<FetchResponse<number, unknown>>;
525
- /**
526
- * Lists available relationship types
527
- *
528
- */
529
- getUser_relationships(metadata: types.GetUserRelationshipsMetadataParam): Promise<FetchResponse<200, types.GetUserRelationshipsResponse200>>;
530
- /**
531
- * Creates a user relationship
532
- *
533
- */
534
- postUser_relationships(metadata: types.PostUserRelationshipsMetadataParam): Promise<FetchResponse<number, unknown>>;
535
- /**
536
- * Deletes a user relationship
537
- *
538
- */
539
- deleteUser_relationshipsId(metadata: types.DeleteUserRelationshipsIdMetadataParam): Promise<FetchResponse<number, unknown>>;
540
- /**
541
- * Creates or updates a user
542
- *
543
- */
544
- postUsers(body: types.PostUsersBodyParam): Promise<FetchResponse<number, unknown>>;
545
- /**
546
- * Retrieves a list of users
547
- *
548
- */
549
- getUsers(metadata?: types.GetUsersMetadataParam): Promise<FetchResponse<200, types.GetUsersResponse200>>;
550
- /**
551
- * Merge duplicate users
552
- *
553
- */
554
- postUsersMerge(body: types.PostUsersMergeBodyParam): Promise<FetchResponse<200, types.PostUsersMergeResponse200>>;
555
- /**
556
- * Shows a single user
557
- *
558
- */
559
- getUsersId(metadata: types.GetUsersIdMetadataParam): Promise<FetchResponse<200, types.GetUsersIdResponse200>>;
560
- /**
561
- * Updates a user
562
- *
563
- */
564
- putUsersId(body: types.PutUsersIdBodyParam, metadata: types.PutUsersIdMetadataParam): Promise<FetchResponse<number, unknown>>;
565
- }
566
- declare const createSDK: SDK;
567
- export default createSDK;
568
- export type { DeleteAgentAssignmentsIdMetadataParam, DeleteCustomUserPropertiesCustomUserPropertyIdOptionsIdMetadataParam, DeleteCustomUserPropertiesCustomUserPropertyIdOptionsIdResponse200, DeleteCustomUserPropertiesCustomUserPropertyIdOptionsIdResponse404, DeleteCustomUserPropertiesCustomUserPropertyIdOptionsIdResponse422, DeleteEventAttendancesIdMetadataParam, DeleteEventRsvpsIdMetadataParam, DeleteEventSessionsIdMetadataParam, DeleteScheduledTasksIdMetadataParam, DeleteTaskAgentsIdMetadataParam, DeleteTaskAssignmentsIdMetadataParam, DeleteTextTemplatesIdMetadataParam, DeleteUserListsIdMetadataParam, DeleteUserNotesIdMetadataParam, DeleteUserRelationshipsIdMetadataParam, GetActivitiesMetadataParam, GetActivitiesResponse200, GetAgentAssignmentsIdMetadataParam, GetAgentAssignmentsMetadataParam, GetCallsMetadataParam, GetCallsResponse200, GetChapterPhoneNumbersMetadataParam, GetChaptersMetadataParam, GetChaptersResponse200, GetCustomUserPropertiesMetadataParam, GetCustomUserPropertiesResponse200, GetDonationChargesIdMetadataParam, GetDonationChargesMetadataParam, GetDonationChargesResponse200, GetEmailBlastsIdMetadataParam, GetEmailBlastsMetadataParam, GetEmailSendersMetadataParam, GetEmailSendersResponse200, GetEventAttendancesMetadataParam, GetEventRsvpsIdMetadataParam, GetEventRsvpsMetadataParam, GetEventSessionsIdMetadataParam, GetEventSessionsMetadataParam, GetEventsIdMetadataParam, GetEventsMetadataParam, GetOrganizationsIdMetadataParam, GetOrganizationsMetadataParam, GetPagesIdMetadataParam, GetPagesMetadataParam, GetPhonebanksIdMetadataParam, GetPhonebanksMetadataParam, GetScheduledCallsIdMetadataParam, GetScheduledCallsMetadataParam, GetScheduledTasksIdMetadataParam, GetScheduledTasksMetadataParam, GetTaskAgentsIdMetadataParam, GetTaskAgentsMetadataParam, GetTaskAssignmentsIdMetadataParam, GetTaskAssignmentsMetadataParam, GetTeamMembersMetadataParam, GetTextBlastsIdMetadataParam, GetTextBlastsMetadataParam, GetTextTemplatesIdMetadataParam, GetTextTemplatesMetadataParam, GetTextbanksIdMetadataParam, GetTextbanksMetadataParam, GetTextsMetadataParam, GetTextsResponse200, GetUserActionsMetadataParam, GetUserListsIdMetadataParam, GetUserListsMetadataParam, GetUserRelationshipsMetadataParam, GetUserRelationshipsResponse200, GetUsersIdMetadataParam, GetUsersIdResponse200, GetUsersMetadataParam, GetUsersResponse200, PostAgentAssignmentsBodyParam, PostAutomationEnrollmentsBodyParam, PostCustomUserPropertiesBodyParam, PostCustomUserPropertiesIdOptionsBodyParam, PostCustomUserPropertiesIdOptionsMetadataParam, PostCustomUserPropertiesIdOptionsResponse201, PostCustomUserPropertiesIdOptionsResponse404, PostCustomUserPropertiesIdOptionsResponse422, PostCustomUserPropertiesResponse201, PostCustomUserPropertiesResponse422, PostEmailsMetadataParam, PostEventAttendancesBodyParam, PostEventRsvpsBodyParam, PostEventSessionsBodyParam, PostEventsBodyParam, PostFieldSurveyUrlsBodyParam, PostFieldSurveyUrlsResponse200, PostScheduledTasksBodyParam, PostTaskAgentsBodyParam, PostTaskAssignmentsBodyParam, PostTeamMembersBodyParam, PostTextTemplatesBodyParam, PostTextsMetadataParam, PostUserActionsBodyParam, PostUserListsBodyParam, PostUserNotesMetadataParam, PostUserRelationshipsMetadataParam, PostUsersBodyParam, PostUsersMergeBodyParam, PostUsersMergeResponse200, PutAgentAssignmentsIdBodyParam, PutAgentAssignmentsIdMetadataParam, PutEventRsvpsIdBodyParam, PutEventRsvpsIdMetadataParam, PutEventSessionsIdBodyParam, PutEventSessionsIdMetadataParam, PutScheduledTasksIdBodyParam, PutScheduledTasksIdMetadataParam, PutTaskAssignmentsIdBodyParam, PutTaskAssignmentsIdMetadataParam, PutTeamMembersIdBodyParam, PutTeamMembersIdMetadataParam, PutTextTemplatesIdBodyParam, PutTextTemplatesIdMetadataParam, PutUserListsIdBodyParam, PutUserListsIdMetadataParam, PutUsersIdBodyParam, PutUsersIdMetadataParam } from './types';