@a1liu/solidarity-tech-api 0.1.6 → 0.1.7

package/dist/.api/apis/solidarity-tech/schemas.js

@@ -1,184 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.GetTextTemplatesId = exports.GetTextTemplates = exports.GetTextBlastsId = exports.GetTextBlasts = exports.GetTeamMembers = exports.GetTaskAssignmentsId = exports.GetTaskAssignments = exports.GetTaskAgentsId = exports.GetTaskAgents = exports.GetScheduledTasksId = exports.GetScheduledTasks = exports.GetScheduledCallsId = exports.GetScheduledCalls = exports.GetPhonebanksId = exports.GetPhonebanks = exports.GetPagesId = exports.GetPages = exports.GetOrganizationsId = exports.GetOrganizations = exports.GetEventsId = exports.GetEvents = exports.GetEventSessionsId = exports.GetEventSessions = exports.GetEventRsvpsId = exports.GetEventRsvps = exports.GetEventAttendances = exports.GetEmailSenders = exports.GetEmailBlastsId = exports.GetEmailBlasts = exports.GetDonationChargesId = exports.GetDonationCharges = exports.GetCustomUserProperties = exports.GetChapters = exports.GetChapterPhoneNumbers = exports.GetCalls = exports.GetAgentAssignmentsId = exports.GetAgentAssignments = exports.GetActivities = exports.DeleteUserRelationshipsId = exports.DeleteUserNotesId = exports.DeleteUserListsId = exports.DeleteTextTemplatesId = exports.DeleteTaskAssignmentsId = exports.DeleteTaskAgentsId = exports.DeleteScheduledTasksId = exports.DeleteEventSessionsId = exports.DeleteEventRsvpsId = exports.DeleteEventAttendancesId = exports.DeleteCustomUserPropertiesCustomUserPropertyIdOptionsId = exports.DeleteAgentAssignmentsId = void 0;
-exports.PutUsersId = exports.PutUserListsId = exports.PutTextTemplatesId = exports.PutTeamMembersId = exports.PutTaskAssignmentsId = exports.PutScheduledTasksId = exports.PutEventSessionsId = exports.PutEventRsvpsId = exports.PutAgentAssignmentsId = exports.PostUsersMerge = exports.PostUsers = exports.PostUserRelationships = exports.PostUserNotes = exports.PostUserLists = exports.PostUserActions = exports.PostTexts = exports.PostTextTemplates = exports.PostTeamMembers = exports.PostTaskAssignments = exports.PostTaskAgents = exports.PostScheduledTasks = exports.PostFieldSurveyUrls = exports.PostEvents = exports.PostEventSessions = exports.PostEventRsvps = exports.PostEventAttendances = exports.PostEmails = exports.PostCustomUserPropertiesIdOptions = exports.PostCustomUserProperties = exports.PostAutomationEnrollments = exports.PostAgentAssignments = exports.GetUsersId = exports.GetUsers = exports.GetUserRelationships = exports.GetUserListsId = exports.GetUserLists = exports.GetUserActions = exports.GetTexts = exports.GetTextbanksId = exports.GetTextbanks = void 0;
-const DeleteAgentAssignmentsId = { "metadata": { "allOf": [{ "type": "object", "properties": { "id": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#", "description": "Identifier of the agent assignment to delete" } }, "required": ["id"] }] } };
-exports.DeleteAgentAssignmentsId = DeleteAgentAssignmentsId;
-const DeleteCustomUserPropertiesCustomUserPropertyIdOptionsId = { "metadata": { "allOf": [{ "type": "object", "properties": { "custom_user_property_id": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#", "description": "Custom user property ID" }, "id": { "type": "string", "$schema": "http://json-schema.org/draft-04/schema#", "description": "Value of the option to remove" } }, "required": ["custom_user_property_id", "id"] }] }, "response": { "200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "key": { "type": "string" }, "field_type": { "type": "string" }, "options": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "object", "additionalProperties": { "type": "string" } }, "value": { "type": "string" } } } }, "scope_id": { "type": "integer" }, "scope_type": { "type": "string", "enum": ["Organization", "Chapter"], "description": "`Organization` `Chapter`" } } } }, "$schema": "http://json-schema.org/draft-04/schema#" }, "404": { "type": "object", "properties": { "error": { "type": "string" } }, "$schema": "http://json-schema.org/draft-04/schema#" }, "422": { "type": "object", "properties": { "error": { "type": "string" } }, "$schema": "http://json-schema.org/draft-04/schema#" } } };
-exports.DeleteCustomUserPropertiesCustomUserPropertyIdOptionsId = DeleteCustomUserPropertiesCustomUserPropertyIdOptionsId;
-const DeleteEventAttendancesId = { "metadata": { "allOf": [{ "type": "object", "properties": { "id": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#", "description": "Identifier of the event attendance to delete" } }, "required": ["id"] }] } };
-exports.DeleteEventAttendancesId = DeleteEventAttendancesId;
-const DeleteEventRsvpsId = { "metadata": { "allOf": [{ "type": "object", "properties": { "id": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#", "description": "Identifier of the event rsvp to delete" } }, "required": ["id"] }] } };
-exports.DeleteEventRsvpsId = DeleteEventRsvpsId;
-const DeleteEventSessionsId = { "metadata": { "allOf": [{ "type": "object", "properties": { "id": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#", "description": "Identifier of the event session to delete" } }, "required": ["id"] }] } };
-exports.DeleteEventSessionsId = DeleteEventSessionsId;
-const DeleteScheduledTasksId = { "metadata": { "allOf": [{ "type": "object", "properties": { "id": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#", "description": "Identifier of the scheduled task to delete" } }, "required": ["id"] }] } };
-exports.DeleteScheduledTasksId = DeleteScheduledTasksId;
-const DeleteTaskAgentsId = { "metadata": { "allOf": [{ "type": "object", "properties": { "id": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#", "description": "Identifier of the task agent to delete" } }, "required": ["id"] }] } };
-exports.DeleteTaskAgentsId = DeleteTaskAgentsId;
-const DeleteTaskAssignmentsId = { "metadata": { "allOf": [{ "type": "object", "properties": { "id": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#", "description": "Identifier of the task assignment to delete" } }, "required": ["id"] }] } };
-exports.DeleteTaskAssignmentsId = DeleteTaskAssignmentsId;
-const DeleteTextTemplatesId = { "metadata": { "allOf": [{ "type": "object", "properties": { "id": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#", "description": "Identifier of the text template to delete" } }, "required": ["id"] }] } };
-exports.DeleteTextTemplatesId = DeleteTextTemplatesId;
-const DeleteUserListsId = { "metadata": { "allOf": [{ "type": "object", "properties": { "id": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#", "description": "Identifier of the user list to delete" } }, "required": ["id"] }] } };
-exports.DeleteUserListsId = DeleteUserListsId;
-const DeleteUserNotesId = { "metadata": { "allOf": [{ "type": "object", "properties": { "id": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#", "description": "Identifier of the user note to delete" } }, "required": ["id"] }, { "type": "object", "properties": { "user_id": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#" }, "agent_id": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#" } }, "required": ["user_id"] }] } };
-exports.DeleteUserNotesId = DeleteUserNotesId;
-const DeleteUserRelationshipsId = { "metadata": { "allOf": [{ "type": "object", "properties": { "id": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#" } }, "required": ["id"] }, { "type": "object", "properties": { "user_id": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#" } }, "required": ["user_id"] }] } };
-exports.DeleteUserRelationshipsId = DeleteUserRelationshipsId;
-const GetActivities = { "metadata": { "allOf": [{ "type": "object", "properties": { "_limit": { "type": "integer", "default": 20, "$schema": "http://json-schema.org/draft-04/schema#", "description": "Limits the number of items returned. Default is 20, maximum is 100." }, "_offset": { "type": "integer", "default": 0, "$schema": "http://json-schema.org/draft-04/schema#", "description": "Number of items to skip before starting to return the results." }, "_since": { "type": "integer", "default": 0, "$schema": "http://json-schema.org/draft-04/schema#", "description": "UTC timestamp in seconds since the Unix epoch to filter activities created after this time." }, "user_id": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#", "description": "User ID to filter activities for a specific user." } }, "required": [] }] }, "response": { "200": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "user_id": { "type": "integer" }, "name": { "type": "string" }, "actionable_id": { "type": "integer" }, "actionable_type": { "type": "string" }, "action": { "type": "object", "properties": { "id": { "type": "integer" }, "user_id": { "type": "integer" }, "agent_user_id": { "type": "integer" }, "field_type": { "type": "string" }, "old_value": { "type": "string" }, "new_value": { "type": "string" }, "data_import_id": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } } }, "meta": { "type": "object", "properties": { "total_count": { "type": "integer" }, "limit": { "type": "integer" }, "offset": { "type": "integer" } } } }, "$schema": "http://json-schema.org/draft-04/schema#" } } };
-exports.GetActivities = GetActivities;
-const GetAgentAssignments = { "metadata": { "allOf": [{ "type": "object", "properties": { "_limit": { "type": "integer", "default": 20, "$schema": "http://json-schema.org/draft-04/schema#", "description": "Limits the number of items returned. Default is 20, maximum is 100." }, "_offset": { "type": "integer", "default": 0, "$schema": "http://json-schema.org/draft-04/schema#", "description": "Number of items to skip before starting to return the results." }, "_since": { "type": "integer", "default": 0, "$schema": "http://json-schema.org/draft-04/schema#", "description": "UTC timestamp in seconds since the Unix epoch to filter calls created after this time." }, "user_id": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#", "description": "User ID to filter agent assignments related to a specific user." }, "agent_user_id": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#", "description": "Agent User ID to filter agent user assignments related to a specific agent user." } }, "required": [] }] } };
-exports.GetAgentAssignments = GetAgentAssignments;
-const GetAgentAssignmentsId = { "metadata": { "allOf": [{ "type": "object", "properties": { "id": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#", "description": "ID of the agent assignment to retrieve" } }, "required": ["id"] }] } };
-exports.GetAgentAssignmentsId = GetAgentAssignmentsId;
-const GetCalls = { "metadata": { "allOf": [{ "type": "object", "properties": { "user_id": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#", "description": "User ID to filter calls related to a specific user." }, "_limit": { "type": "integer", "default": 20, "$schema": "http://json-schema.org/draft-04/schema#", "description": "Limits the number of items returned. Default is 20, maximum is 100." }, "_offset": { "type": "integer", "default": 0, "$schema": "http://json-schema.org/draft-04/schema#", "description": "Number of items to skip before starting to return the results." }, "_since": { "type": "integer", "default": 0, "$schema": "http://json-schema.org/draft-04/schema#", "description": "UTC timestamp in seconds since the Unix epoch to filter calls created after this time." } }, "required": [] }] }, "response": { "200": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "user_id": { "type": "integer" }, "chapter_id": { "type": "integer" }, "direction": { "type": "string" }, "from_number": { "type": "string" }, "to_number": { "type": "string" }, "phonebank_id": { "type": "integer", "description": "The ID of the phone bank (MobilizeEventTask) this call was made as part of, or null if the call was not part of a phone bank." }, "agent_user_id": { "type": "integer" }, "notes": { "type": "string" }, "duration": { "type": "integer" }, "picked_up": { "type": "boolean" }, "left_voicemail": { "type": "boolean" }, "twilio_call_sid": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "ended_at": { "type": "string", "format": "date-time" }, "transcription": { "type": "object", "description": "AI generated transcription analysis, present when the call has been transcribed.", "properties": { "summary": { "type": "string" }, "rating": { "type": "integer" }, "sentiment": { "type": "string" }, "engagement_analysis": { "type": "string" }, "engagement_analysis_justification": { "type": "string" } } } } } }, "meta": { "type": "object", "properties": { "total_count": { "type": "integer" }, "limit": { "type": "integer" }, "offset": { "type": "integer" } } } }, "$schema": "http://json-schema.org/draft-04/schema#" } } };
-exports.GetCalls = GetCalls;
-const GetChapterPhoneNumbers = { "metadata": { "allOf": [{ "type": "object", "properties": { "_limit": { "type": "integer", "default": 20, "$schema": "http://json-schema.org/draft-04/schema#", "description": "Limits the number of items returned. Default is 20, maximum is 100." }, "_offset": { "type": "integer", "default": 0, "$schema": "http://json-schema.org/draft-04/schema#", "description": "Number of items to skip before starting to return the results." }, "_since": { "type": "integer", "default": 0, "$schema": "http://json-schema.org/draft-04/schema#", "description": "UTC timestamp in seconds since the Unix epoch to filter calls created after this time." }, "chapter_id": { "type": "integer", "default": 0, "$schema": "http://json-schema.org/draft-04/schema#", "description": "Filters chapter phone numbers by chapter_id within the accessible scope." } }, "required": [] }] } };
-exports.GetChapterPhoneNumbers = GetChapterPhoneNumbers;
-const GetChapters = { "metadata": { "allOf": [{ "type": "object", "properties": { "_limit": { "type": "integer", "default": 20, "$schema": "http://json-schema.org/draft-04/schema#", "description": "Limits the number of items returned. Default is 20, maximum is 100." }, "_offset": { "type": "integer", "default": 0, "$schema": "http://json-schema.org/draft-04/schema#", "description": "Number of items to skip before starting to return the results." }, "_since": { "type": "integer", "default": 0, "$schema": "http://json-schema.org/draft-04/schema#", "description": "UTC timestamp in seconds since the Unix epoch to filter chapters created after this time." } }, "required": [] }] }, "response": { "200": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "logo_url": { "type": "string" }, "organization_id": { "type": "integer" }, "chapter_phone_number": { "type": "string" }, "calendar_feed_url": { "type": "string" } } } }, "meta": { "type": "object", "properties": { "total_count": { "type": "integer" }, "limit": { "type": "integer" }, "offset": { "type": "integer" } } } }, "$schema": "http://json-schema.org/draft-04/schema#" } } };
-exports.GetChapters = GetChapters;
-const GetCustomUserProperties = { "metadata": { "allOf": [{ "type": "object", "properties": { "_limit": { "type": "integer", "default": 20, "$schema": "http://json-schema.org/draft-04/schema#", "description": "Limits the number of items returned. Default is 20, maximum is 100." }, "_offset": { "type": "integer", "default": 0, "$schema": "http://json-schema.org/draft-04/schema#", "description": "Number of items to skip before starting to return the results." }, "_since": { "type": "integer", "default": 0, "$schema": "http://json-schema.org/draft-04/schema#", "description": "UTC timestamp in seconds since the Unix epoch to filter custom user properties created after this time." }, "scope_id": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#", "description": "ID of the scope to filter custom user properties by." }, "scope_type": { "type": "string", "enum": ["Organization", "Chapter"], "$schema": "http://json-schema.org/draft-04/schema#", "description": "Type of the scope to filter custom user properties by." } }, "required": [] }] }, "response": { "200": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "key": { "type": "string" }, "field_type": { "type": "string" }, "options": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "object", "additionalProperties": { "type": "string" } }, "value": { "type": "string" } } } }, "scope_id": { "type": "integer" }, "scope_type": { "type": "string", "description": "Type of the scope\n\n`Organization` `Chapter`", "enum": ["Organization", "Chapter"] } } } }, "meta": { "type": "object", "properties": { "total_count": { "type": "integer" }, "limit": { "type": "integer" }, "offset": { "type": "integer" } } } }, "$schema": "http://json-schema.org/draft-04/schema#" } } };
-exports.GetCustomUserProperties = GetCustomUserProperties;
-const GetDonationCharges = { "metadata": { "allOf": [{ "type": "object", "properties": { "_limit": { "type": "integer", "default": 20, "$schema": "http://json-schema.org/draft-04/schema#", "description": "Limits the number of items returned. Default is 20, maximum is 100." }, "_offset": { "type": "integer", "default": 0, "$schema": "http://json-schema.org/draft-04/schema#", "description": "Number of items to skip before starting to return the results." }, "_since": { "type": "integer", "default": 0, "$schema": "http://json-schema.org/draft-04/schema#", "description": "UTC timestamp in seconds since the Unix epoch to filter donation charges created after this time." } }, "required": [] }] }, "response": { "200": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "examples": [1] }, "amount": { "type": "integer", "description": "Amount in cents", "examples": [5000] }, "created_at": { "type": "string", "format": "datetime", "examples": ["2023-01-01T12:00:00Z"] }, "updated_at": { "type": "string", "format": "datetime", "examples": ["2023-01-01T12:00:00Z"] }, "success": { "type": "boolean", "examples": [true] }, "refunded": { "type": "boolean", "examples": [false] }, "receipt_number": { "type": "string", "examples": ["ABC1-DEF2"] }, "hash_id": { "type": "string", "examples": ["abc123def456"] }, "processing_fee_cents": { "type": "integer", "examples": [150] }, "external_donation_id": { "type": "string" }, "external_donation_date": { "type": "string", "format": "datetime" }, "is_external": { "type": "boolean", "examples": [false] }, "amount_in_dollars": { "type": "string", "examples": ["$50.00"] }, "currency": { "type": "string", "examples": ["USD"] }, "currency_symbol": { "type": "string", "examples": ["$"] }, "receipt_url": { "type": "string", "examples": ["https://example.com/receipt/ABC1-DEF2/abc123def456"] }, "brand": { "type": "string", "examples": ["visa"] }, "last4": { "type": "string", "examples": ["4242"] }, "json": { "type": "object", "description": "Full JSON representation of the donation charge", "additionalProperties": true }, "user": { "type": "object", "properties": { "id": { "type": "integer", "examples": [1] }, "email": { "type": "string", "examples": ["user@example.com"] }, "first_name": { "type": "string", "examples": ["John"] }, "last_name": { "type": "string", "examples": ["Doe"] }, "phone_number": { "type": "string", "examples": ["15551234567"] }, "created_at": { "type": "string", "format": "datetime", "examples": ["2023-01-01T12:00:00Z"] }, "address1": { "type": "string", "examples": ["123 Main St"] }, "address2": { "type": "string", "examples": ["Apt 4B"] }, "city": { "type": "string", "examples": ["New York"] }, "state": { "type": "string", "examples": ["NY"] }, "zip_code": { "type": "string", "examples": ["10001"] }, "country_name": { "type": "string", "examples": ["United States"] } } }, "action_page": { "type": "object", "properties": { "id": { "type": "integer", "examples": [1] }, "title": { "type": "string", "examples": ["Donation Page"] }, "url_slug": { "type": "string", "examples": ["donate-now"] } } }, "chapter": { "type": "object", "properties": { "id": { "type": "integer", "examples": [1] }, "name": { "type": "string", "examples": ["Local Chapter"] } } } } } }, "meta": { "type": "object", "properties": { "total_count": { "type": "integer", "examples": [100] }, "limit": { "type": "integer", "examples": [20] }, "offset": { "type": "integer", "examples": [0] } } } }, "$schema": "http://json-schema.org/draft-04/schema#" } } };
-exports.GetDonationCharges = GetDonationCharges;
-const GetDonationChargesId = { "metadata": { "allOf": [{ "type": "object", "properties": { "id": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#", "description": "ID of the donation charge to retrieve" } }, "required": ["id"] }] } };
-exports.GetDonationChargesId = GetDonationChargesId;
-const GetEmailBlasts = { "metadata": { "allOf": [{ "type": "object", "properties": { "_limit": { "type": "integer", "default": 20, "$schema": "http://json-schema.org/draft-04/schema#", "description": "Limits the number of items returned. Default is 20, maximum is 100." }, "_offset": { "type": "integer", "default": 0, "$schema": "http://json-schema.org/draft-04/schema#", "description": "Number of items to skip before starting to return the results." }, "_since": { "type": "integer", "default": 0, "$schema": "http://json-schema.org/draft-04/schema#", "description": "UTC timestamp in seconds since the Unix epoch to filter calls created after this time." } }, "required": [] }] } };
-exports.GetEmailBlasts = GetEmailBlasts;
-const GetEmailBlastsId = { "metadata": { "allOf": [{ "type": "object", "properties": { "id": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#", "description": "ID of the email blast to retrieve" } }, "required": ["id"] }] } };
-exports.GetEmailBlastsId = GetEmailBlastsId;
-const GetEmailSenders = { "metadata": { "allOf": [{ "type": "object", "properties": { "_limit": { "type": "integer", "default": 20, "$schema": "http://json-schema.org/draft-04/schema#", "description": "Limits the number of items returned. Default is 20, maximum is 100." }, "_offset": { "type": "integer", "default": 0, "$schema": "http://json-schema.org/draft-04/schema#", "description": "Number of items to skip before starting to return the results." } }, "required": [] }] }, "response": { "200": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "email": { "type": "string" }, "from": { "type": "string" }, "default_for_scope": { "type": "boolean" }, "scope_type": { "type": "string" }, "scope_id": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" } } } }, "meta": { "type": "object", "properties": { "total_count": { "type": "integer" }, "limit": { "type": "integer" }, "offset": { "type": "integer" } } } }, "$schema": "http://json-schema.org/draft-04/schema#" } } };
-exports.GetEmailSenders = GetEmailSenders;
-const GetEventAttendances = { "metadata": { "allOf": [{ "type": "object", "properties": { "_limit": { "type": "integer", "default": 20, "$schema": "http://json-schema.org/draft-04/schema#", "description": "Limits the number of items returned. Default is 20, maximum is 100." }, "_offset": { "type": "integer", "default": 0, "$schema": "http://json-schema.org/draft-04/schema#", "description": "Number of items to skip before starting to return the results." }, "_since": { "type": "integer", "default": 0, "$schema": "http://json-schema.org/draft-04/schema#", "description": "UTC timestamp in seconds since the Unix epoch to filter calls created after this time." }, "event_id": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#", "description": "Filters attendances by event_id within the accessible scope." }, "session_id": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#", "description": "Filters attendances by session_id (calendar item id) within the accessible scope." } }, "required": [] }] } };
-exports.GetEventAttendances = GetEventAttendances;
-const GetEventRsvps = { "metadata": { "allOf": [{ "type": "object", "properties": { "_limit": { "type": "integer", "default": 20, "$schema": "http://json-schema.org/draft-04/schema#", "description": "Limits the number of items returned. Default is 20, maximum is 100." }, "_offset": { "type": "integer", "default": 0, "$schema": "http://json-schema.org/draft-04/schema#", "description": "Number of items to skip before starting to return the results." }, "_since": { "type": "integer", "default": 0, "$schema": "http://json-schema.org/draft-04/schema#", "description": "UTC timestamp in seconds since the Unix epoch to filter calls created after this time." }, "event_id": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#", "description": "Filters rsvps by event_id within the accessible scope." }, "session_id": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#", "description": "Filters rsvps by session_id (calendar item id) within the accessible scope." }, "full_user_payload": { "type": "boolean", "default": false, "$schema": "http://json-schema.org/draft-04/schema#", "description": "When true, includes complete user data in the response instead of just basic details." } }, "required": [] }] } };
-exports.GetEventRsvps = GetEventRsvps;
-const GetEventRsvpsId = { "metadata": { "allOf": [{ "type": "object", "properties": { "id": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#", "description": "ID of the event rsvp to retrieve" } }, "required": ["id"] }, { "type": "object", "properties": { "full_user_payload": { "type": "boolean", "default": false, "$schema": "http://json-schema.org/draft-04/schema#", "description": "When true, includes complete user data in the response instead of just basic details." } }, "required": [] }] } };
-exports.GetEventRsvpsId = GetEventRsvpsId;
-const GetEventSessions = { "metadata": { "allOf": [{ "type": "object", "properties": { "_limit": { "type": "integer", "default": 20, "$schema": "http://json-schema.org/draft-04/schema#", "description": "Limits the number of items returned. Default is 20, maximum is 100." }, "_offset": { "type": "integer", "default": 0, "$schema": "http://json-schema.org/draft-04/schema#", "description": "Number of items to skip before starting to return the results." }, "_since": { "type": "integer", "default": 0, "$schema": "http://json-schema.org/draft-04/schema#", "description": "UTC timestamp in seconds since the Unix epoch to filter calls created after this time." }, "event_id": { "type": "integer", "default": 0, "$schema": "http://json-schema.org/draft-04/schema#", "description": "Filters sessions by event_id within the accessible scope." } }, "required": [] }] } };
-exports.GetEventSessions = GetEventSessions;
-const GetEventSessionsId = { "metadata": { "allOf": [{ "type": "object", "properties": { "id": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#", "description": "ID of the event session to retrieve" } }, "required": ["id"] }] } };
-exports.GetEventSessionsId = GetEventSessionsId;
-const GetEvents = { "metadata": { "allOf": [{ "type": "object", "properties": { "_limit": { "type": "integer", "default": 20, "$schema": "http://json-schema.org/draft-04/schema#", "description": "Limits the number of items returned. Default is 20, maximum is 100." }, "_offset": { "type": "integer", "default": 0, "$schema": "http://json-schema.org/draft-04/schema#", "description": "Number of items to skip before starting to return the results." }, "_since": { "type": "integer", "default": 0, "$schema": "http://json-schema.org/draft-04/schema#", "description": "UTC timestamp in seconds since the Unix epoch to filter calls created after this time." }, "scope_id": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#", "description": "ID of the scope to filter events by." }, "scope_type": { "type": "string", "enum": ["Organization", "Chapter"], "$schema": "http://json-schema.org/draft-04/schema#", "description": "Type of the scope to filter events by." } }, "required": [] }] } };
-exports.GetEvents = GetEvents;
-const GetEventsId = { "metadata": { "allOf": [{ "type": "object", "properties": { "id": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#", "description": "ID of the event to retrieve" } }, "required": ["id"] }] } };
-exports.GetEventsId = GetEventsId;
-const GetOrganizations = { "metadata": { "allOf": [{ "type": "object", "properties": { "_limit": { "type": "integer", "default": 20, "$schema": "http://json-schema.org/draft-04/schema#", "description": "Limits the number of items returned. Default is 20, maximum is 100." }, "_offset": { "type": "integer", "default": 0, "$schema": "http://json-schema.org/draft-04/schema#", "description": "Number of items to skip before starting to return the results." }, "_since": { "type": "integer", "default": 0, "$schema": "http://json-schema.org/draft-04/schema#", "description": "UTC timestamp in seconds since the Unix epoch to filter calls created after this time." } }, "required": [] }] } };
-exports.GetOrganizations = GetOrganizations;
-const GetOrganizationsId = { "metadata": { "allOf": [{ "type": "object", "properties": { "id": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#", "description": "ID of the organization to retrieve" } }, "required": ["id"] }] } };
-exports.GetOrganizationsId = GetOrganizationsId;
-const GetPages = { "metadata": { "allOf": [{ "type": "object", "properties": { "_limit": { "type": "integer", "default": 20, "$schema": "http://json-schema.org/draft-04/schema#", "description": "Limits the number of items returned. Default is 20, maximum is 100." }, "_offset": { "type": "integer", "default": 0, "$schema": "http://json-schema.org/draft-04/schema#", "description": "Number of items to skip before starting to return the results." }, "_since": { "type": "integer", "default": 0, "$schema": "http://json-schema.org/draft-04/schema#", "description": "UTC timestamp in seconds since the Unix epoch to filter calls created after this time." } }, "required": [] }] } };
-exports.GetPages = GetPages;
-const GetPagesId = { "metadata": { "allOf": [{ "type": "object", "properties": { "id": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#", "description": "ID of the page to retrieve" } }, "required": ["id"] }] } };
-exports.GetPagesId = GetPagesId;
-const GetPhonebanks = { "metadata": { "allOf": [{ "type": "object", "properties": { "_limit": { "type": "integer", "default": 20, "$schema": "http://json-schema.org/draft-04/schema#", "description": "Limits the number of items returned. Default is 20, maximum is 100." }, "_offset": { "type": "integer", "default": 0, "$schema": "http://json-schema.org/draft-04/schema#", "description": "Number of items to skip before starting to return the results." }, "_since": { "type": "integer", "default": 0, "$schema": "http://json-schema.org/draft-04/schema#", "description": "UTC timestamp in seconds since the Unix epoch to filter calls created after this time." }, "event_id": { "type": "integer", "default": 0, "$schema": "http://json-schema.org/draft-04/schema#", "description": "Filters phonebanks by event_id within the accessible scope." } }, "required": [] }] } };
-exports.GetPhonebanks = GetPhonebanks;
-const GetPhonebanksId = { "metadata": { "allOf": [{ "type": "object", "properties": { "id": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#", "description": "ID of the phonebank to retrieve" } }, "required": ["id"] }] } };
-exports.GetPhonebanksId = GetPhonebanksId;
-const GetScheduledCalls = { "metadata": { "allOf": [{ "type": "object", "properties": { "_limit": { "type": "integer", "default": 20, "$schema": "http://json-schema.org/draft-04/schema#", "description": "Limits the number of items returned. Default is 20, maximum is 100." }, "_offset": { "type": "integer", "default": 0, "$schema": "http://json-schema.org/draft-04/schema#", "description": "Number of items to skip before starting to return the results." }, "_since": { "type": "integer", "default": 0, "$schema": "http://json-schema.org/draft-04/schema#", "description": "UTC timestamp in seconds since the Unix epoch to filter calls created after this time." }, "user_id": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#", "description": "User ID to filter scheduled calls related to a specific user." }, "agent_user_id": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#", "description": "Agent User ID to filter agent user assignments related to a specific agent user." } }, "required": [] }] } };
-exports.GetScheduledCalls = GetScheduledCalls;
-const GetScheduledCallsId = { "metadata": { "allOf": [{ "type": "object", "properties": { "id": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#", "description": "ID of the scheduled call to retrieve" } }, "required": ["id"] }] } };
-exports.GetScheduledCallsId = GetScheduledCallsId;
-const GetScheduledTasks = { "metadata": { "allOf": [{ "type": "object", "properties": { "_limit": { "type": "integer", "default": 20, "$schema": "http://json-schema.org/draft-04/schema#", "description": "Limits the number of items returned. Default is 20, maximum is 100." }, "_offset": { "type": "integer", "default": 0, "$schema": "http://json-schema.org/draft-04/schema#", "description": "Number of items to skip before starting to return the results." }, "_since": { "type": "integer", "default": 0, "$schema": "http://json-schema.org/draft-04/schema#", "description": "UTC timestamp in seconds since the Unix epoch to filter calls created after this time." }, "user_id": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#", "description": "User ID to filter scheduled tasks related to a specific user." }, "agent_user_id": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#", "description": "Agent User ID to filter agent user assignments related to a specific agent user." } }, "required": [] }] } };
-exports.GetScheduledTasks = GetScheduledTasks;
-const GetScheduledTasksId = { "metadata": { "allOf": [{ "type": "object", "properties": { "id": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#", "description": "ID of the scheduled task to retrieve" } }, "required": ["id"] }] } };
-exports.GetScheduledTasksId = GetScheduledTasksId;
-const GetTaskAgents = { "metadata": { "allOf": [{ "type": "object", "properties": { "_limit": { "type": "integer", "default": 20, "$schema": "http://json-schema.org/draft-04/schema#", "description": "Limits the number of items returned. Default is 20, maximum is 100." }, "_offset": { "type": "integer", "default": 0, "$schema": "http://json-schema.org/draft-04/schema#", "description": "Number of items to skip before starting to return the results." }, "_since": { "type": "integer", "default": 0, "$schema": "http://json-schema.org/draft-04/schema#", "description": "UTC timestamp in seconds since the Unix epoch to filter calls created after this time." }, "task_id": { "type": "integer", "default": 0, "$schema": "http://json-schema.org/draft-04/schema#", "description": "Filters task agents by task within the accessible scope." } }, "required": [] }] } };
-exports.GetTaskAgents = GetTaskAgents;
-const GetTaskAgentsId = { "metadata": { "allOf": [{ "type": "object", "properties": { "id": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#", "description": "ID of the task agent to retrieve" } }, "required": ["id"] }] } };
-exports.GetTaskAgentsId = GetTaskAgentsId;
-const GetTaskAssignments = { "metadata": { "allOf": [{ "type": "object", "properties": { "_limit": { "type": "integer", "default": 20, "$schema": "http://json-schema.org/draft-04/schema#", "description": "Limits the number of items returned. Default is 20, maximum is 100." }, "_offset": { "type": "integer", "default": 0, "$schema": "http://json-schema.org/draft-04/schema#", "description": "Number of items to skip before starting to return the results." }, "_since": { "type": "integer", "default": 0, "$schema": "http://json-schema.org/draft-04/schema#", "description": "UTC timestamp in seconds since the Unix epoch to filter calls created after this time." }, "task_id": { "type": "integer", "default": 0, "$schema": "http://json-schema.org/draft-04/schema#", "description": "Filters task assignments by phonebank or textbank task within the accessible scope." }, "agent_user_id": { "type": "integer", "default": 0, "$schema": "http://json-schema.org/draft-04/schema#", "description": "Filters task assignments by agent user within the accessible scope." } }, "required": [] }] } };
-exports.GetTaskAssignments = GetTaskAssignments;
-const GetTaskAssignmentsId = { "metadata": { "allOf": [{ "type": "object", "properties": { "id": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#", "description": "ID of the task assignment to retrieve" } }, "required": ["id"] }] } };
-exports.GetTaskAssignmentsId = GetTaskAssignmentsId;
-const GetTeamMembers = { "metadata": { "allOf": [{ "type": "object", "properties": { "_limit": { "type": "integer", "default": 20, "$schema": "http://json-schema.org/draft-04/schema#", "description": "Limits the number of items returned. Default is 20, maximum is 100." }, "_offset": { "type": "integer", "default": 0, "$schema": "http://json-schema.org/draft-04/schema#", "description": "Number of items to skip before starting to return the results." }, "_since": { "type": "integer", "default": 0, "$schema": "http://json-schema.org/draft-04/schema#", "description": "UTC timestamp in seconds since the Unix epoch to filter calls created after this time." } }, "required": [] }] } };
-exports.GetTeamMembers = GetTeamMembers;
-const GetTextBlasts = { "metadata": { "allOf": [{ "type": "object", "properties": { "_limit": { "type": "integer", "default": 20, "$schema": "http://json-schema.org/draft-04/schema#", "description": "Limits the number of items returned. Default is 20, maximum is 100." }, "_offset": { "type": "integer", "default": 0, "$schema": "http://json-schema.org/draft-04/schema#", "description": "Number of items to skip before starting to return the results." }, "_since": { "type": "integer", "default": 0, "$schema": "http://json-schema.org/draft-04/schema#", "description": "UTC timestamp in seconds since the Unix epoch to filter calls created after this time." } }, "required": [] }] } };
-exports.GetTextBlasts = GetTextBlasts;
-const GetTextBlastsId = { "metadata": { "allOf": [{ "type": "object", "properties": { "id": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#", "description": "ID of the text blast to retrieve" } }, "required": ["id"] }] } };
-exports.GetTextBlastsId = GetTextBlastsId;
-const GetTextTemplates = { "metadata": { "allOf": [{ "type": "object", "properties": { "_limit": { "type": "integer", "default": 20, "$schema": "http://json-schema.org/draft-04/schema#", "description": "Limits the number of items returned. Default is 20, maximum is 100." }, "_offset": { "type": "integer", "default": 0, "$schema": "http://json-schema.org/draft-04/schema#", "description": "Number of items to skip before starting to return the results." }, "_since": { "type": "integer", "default": 0, "$schema": "http://json-schema.org/draft-04/schema#", "description": "UTC timestamp in seconds since the Unix epoch to filter calls created after this time." }, "event_id": { "type": "integer", "default": 0, "$schema": "http://json-schema.org/draft-04/schema#", "description": "Filters rsvps by event_id within the accessible scope." } }, "required": [] }] } };
-exports.GetTextTemplates = GetTextTemplates;
-const GetTextTemplatesId = { "metadata": { "allOf": [{ "type": "object", "properties": { "id": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#", "description": "ID of the text template to retrieve" } }, "required": ["id"] }] } };
-exports.GetTextTemplatesId = GetTextTemplatesId;
-const GetTextbanks = { "metadata": { "allOf": [{ "type": "object", "properties": { "_limit": { "type": "integer", "default": 20, "$schema": "http://json-schema.org/draft-04/schema#", "description": "Limits the number of items returned. Default is 20, maximum is 100." }, "_offset": { "type": "integer", "default": 0, "$schema": "http://json-schema.org/draft-04/schema#", "description": "Number of items to skip before starting to return the results." }, "_since": { "type": "integer", "default": 0, "$schema": "http://json-schema.org/draft-04/schema#", "description": "UTC timestamp in seconds since the Unix epoch to filter calls created after this time." }, "event_id": { "type": "integer", "default": 0, "$schema": "http://json-schema.org/draft-04/schema#", "description": "Filters textbanks by event_id within the accessible scope." } }, "required": [] }] } };
-exports.GetTextbanks = GetTextbanks;
-const GetTextbanksId = { "metadata": { "allOf": [{ "type": "object", "properties": { "id": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#", "description": "ID of the textbank to retrieve" } }, "required": ["id"] }] } };
-exports.GetTextbanksId = GetTextbanksId;
-const GetTexts = { "metadata": { "allOf": [{ "type": "object", "properties": { "user_id": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#" }, "_limit": { "type": "integer", "default": 20, "$schema": "http://json-schema.org/draft-04/schema#" }, "_offset": { "type": "integer", "default": 0, "$schema": "http://json-schema.org/draft-04/schema#" }, "_since": { "type": "string", "$schema": "http://json-schema.org/draft-04/schema#" } }, "required": [] }] }, "response": { "200": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "user_id": { "type": "integer" }, "direction": { "type": "string" }, "body": { "type": "string" }, "media_urls": { "type": "array", "items": { "type": "string" } }, "segment_size": { "type": "integer" }, "chapter_phone_number_id": { "type": "integer" }, "twilio_error_code": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" } } } }, "meta": { "type": "object", "properties": { "total_count": { "type": "integer" }, "limit": { "type": "integer" }, "offset": { "type": "integer" } } } }, "$schema": "http://json-schema.org/draft-04/schema#" } } };
-exports.GetTexts = GetTexts;
-const GetUserActions = { "metadata": { "allOf": [{ "type": "object", "properties": { "user_id": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#", "description": "Filter by user ID" }, "page_id": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#", "description": "Filter by page ID" }, "_limit": { "type": "integer", "default": 20, "$schema": "http://json-schema.org/draft-04/schema#", "description": "Number of results to return (default: 20, max: 100)" }, "_offset": { "type": "integer", "default": 0, "$schema": "http://json-schema.org/draft-04/schema#", "description": "Number of results to skip (default: 0)" }, "_since": { "type": "integer", "default": 0, "$schema": "http://json-schema.org/draft-04/schema#", "description": "UTC timestamp in seconds since the Unix epoch to filter results created after this time (default: 0)" } }, "required": [] }] } };
-exports.GetUserActions = GetUserActions;
-const GetUserLists = { "metadata": { "allOf": [{ "type": "object", "properties": { "_limit": { "type": "integer", "default": 20, "$schema": "http://json-schema.org/draft-04/schema#", "description": "Limits the number of items returned. Default is 20, maximum is 100." }, "_offset": { "type": "integer", "default": 0, "$schema": "http://json-schema.org/draft-04/schema#", "description": "Number of items to skip before starting to return the results." }, "_since": { "type": "integer", "default": 0, "$schema": "http://json-schema.org/draft-04/schema#", "description": "UTC timestamp in seconds since the Unix epoch to filter calls created after this time." } }, "required": [] }] } };
-exports.GetUserLists = GetUserLists;
-const GetUserListsId = { "metadata": { "allOf": [{ "type": "object", "properties": { "id": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#", "description": "ID of the user list to retrieve" } }, "required": ["id"] }] } };
-exports.GetUserListsId = GetUserListsId;
-const GetUserRelationships = { "metadata": { "allOf": [{ "type": "object", "properties": { "user_id": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#" } }, "required": ["user_id"] }] }, "response": { "200": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "text": { "type": "string" } } }, "$schema": "http://json-schema.org/draft-04/schema#" } } };
-exports.GetUserRelationships = GetUserRelationships;
-const GetUsers = { "metadata": { "allOf": [{ "type": "object", "properties": { "_limit": { "type": "integer", "default": 20, "$schema": "http://json-schema.org/draft-04/schema#", "description": "Maximum number of users to return" }, "_offset": { "type": "integer", "default": 0, "$schema": "http://json-schema.org/draft-04/schema#", "description": "Number of users to skip before starting to return" }, "_since": { "type": "integer", "default": 0, "$schema": "http://json-schema.org/draft-04/schema#", "description": "UTC timestamp in seconds since the Unix epoch (e.g., 1622559600) to filter users updated after this time" }, "user_list_ids": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#", "description": "Comma-separated list of user list IDs to apply" }, "phone_number": { "type": "string", "$schema": "http://json-schema.org/draft-04/schema#", "description": "Filter by phone number (any format accepted, will be normalized)" }, "email": { "type": "string", "$schema": "http://json-schema.org/draft-04/schema#", "description": "Filter by email address (case-insensitive)" } }, "required": [] }] }, "response": { "200": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "hash_id": { "type": "string" }, "phone_number": { "type": "string" }, "email": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "alternate_name": { "type": "string", "description": "Alternate name (nickname, community name, or alternate romanization). Searchable." }, "preferred_language": { "type": "string" }, "second_language": { "type": "string" }, "chapter_id": { "type": "integer" }, "chapter_ids": { "type": "array", "items": { "type": "integer" }, "description": "Array of all chapter IDs this user belongs to (primary + secondary)" }, "branch_id": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "custom_user_properties": { "type": "object", "additionalProperties": { "oneOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }] }, "description": "Custom property values. String for single-value fields, array of strings for Multiple Checkboxes fields." }, "address": { "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zip_code": { "type": "string" }, "country": { "type": "string" } } }, "sms_permission": { "type": "boolean" }, "call_permission": { "type": "boolean" }, "email_permission": { "type": "boolean" }, "other_emails": { "type": "array", "items": { "type": "string" }, "description": "Additional email addresses stored on the user profile, excluding the primary email." }, "other_phone_numbers": { "type": "array", "items": { "type": "string" }, "description": "Additional phone numbers stored on the user profile, excluding the primary phone number." } } } }, "meta": { "type": "object", "properties": { "total_count": { "type": "integer" }, "limit": { "type": "integer" }, "offset": { "type": "integer" } } } }, "$schema": "http://json-schema.org/draft-04/schema#" } } };
-exports.GetUsers = GetUsers;
-const GetUsersId = { "metadata": { "allOf": [{ "type": "object", "properties": { "id": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#", "description": "ID of the user to retrieve" } }, "required": ["id"] }] }, "response": { "200": { "type": "object", "properties": { "id": { "type": "integer" }, "hash_id": { "type": "string" }, "phone_number": { "type": "string" }, "email": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "alternate_name": { "type": "string", "description": "Alternate name (nickname, community name, or alternate romanization). Searchable." }, "preferred_language": { "type": "string" }, "second_language": { "type": "string" }, "chapter_id": { "type": "integer" }, "chapter_ids": { "type": "array", "items": { "type": "integer" }, "description": "Array of all chapter IDs this user belongs to (primary + secondary)" }, "branch_id": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "custom_user_properties": { "type": "object", "additionalProperties": { "oneOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }] }, "description": "Custom property values. String for single-value fields, array of strings for Multiple Checkboxes fields." }, "address": { "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zip_code": { "type": "string" }, "country": { "type": "string" } } }, "sms_permission": { "type": "boolean" }, "call_permission": { "type": "boolean" }, "email_permission": { "type": "boolean" }, "other_emails": { "type": "array", "items": { "type": "string" }, "description": "Additional email addresses stored on the user profile, excluding the primary email." }, "other_phone_numbers": { "type": "array", "items": { "type": "string" }, "description": "Additional phone numbers stored on the user profile, excluding the primary phone number." } }, "$schema": "http://json-schema.org/draft-04/schema#" } } };
-exports.GetUsersId = GetUsersId;
-const PostAgentAssignments = { "body": { "type": "object", "properties": { "user_id": { "type": "integer", "format": "int64", "description": "Identifier for the user", "minimum": -9223372036854776000, "maximum": 9223372036854776000 }, "agent_user_id": { "type": "integer", "format": "int64", "description": "Identifier for the agent user", "minimum": -9223372036854776000, "maximum": 9223372036854776000 }, "is_active": { "type": "boolean", "description": "Indicates if the assignment is currently active" } }, "required": ["user_id", "agent_user_id"], "$schema": "http://json-schema.org/draft-04/schema#" } };
-exports.PostAgentAssignments = PostAgentAssignments;
-const PostAutomationEnrollments = { "body": { "type": "object", "properties": { "automation_id": { "type": "integer", "description": "ID of the automation to enroll user in" }, "user_id": { "type": "integer", "description": "ID of the user to enroll" } }, "required": ["automation_id", "user_id"], "$schema": "http://json-schema.org/draft-04/schema#" } };
-exports.PostAutomationEnrollments = PostAutomationEnrollments;
-const PostCustomUserProperties = { "body": { "type": "object", "properties": { "label": { "type": "string", "description": "Display label for the property" }, "description": { "type": "string", "description": "Optional description of the property" }, "field_type": { "type": "string", "enum": ["input", "textarea", "number", "date", "checkbox", "select", "radios", "checkboxes"], "description": "Type of field for data entry" }, "options": { "type": "array", "description": "Options for select, radios, checkbox, or checkboxes field types", "items": { "type": "object", "properties": { "label": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Multi-language labels for the option" }, "value": { "type": "string", "description": "Internal value for the option" } } } }, "scope_type": { "type": "string", "enum": ["Organization", "Chapter"], "description": "Type of scope for the property" }, "scope_id": { "type": "integer", "description": "ID of the scope for the property" } }, "required": ["label", "field_type"], "$schema": "http://json-schema.org/draft-04/schema#" }, "response": { "201": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "key": { "type": "string" }, "field_type": { "type": "string" }, "options": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "object", "additionalProperties": { "type": "string" } }, "value": { "type": "string" } } } }, "scope_id": { "type": "integer" }, "scope_type": { "type": "string", "enum": ["Organization", "Chapter"], "description": "`Organization` `Chapter`" }, "created_at": { "type": "string" } } } }, "$schema": "http://json-schema.org/draft-04/schema#" }, "422": { "type": "object", "properties": { "error": { "type": "string" }, "details": { "type": "array", "items": { "type": "string" } } }, "$schema": "http://json-schema.org/draft-04/schema#" } } };
-exports.PostCustomUserProperties = PostCustomUserProperties;
-const PostCustomUserPropertiesIdOptions = { "body": { "type": "object", "properties": { "label": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Multi-language labels for the option" }, "value": { "type": "string", "description": "Internal value for the option (will be auto-generated if not provided)" } }, "required": ["label"], "$schema": "http://json-schema.org/draft-04/schema#" }, "metadata": { "allOf": [{ "type": "object", "properties": { "id": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#", "description": "Custom user property ID" } }, "required": ["id"] }] }, "response": { "201": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "key": { "type": "string" }, "field_type": { "type": "string" }, "options": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "object", "additionalProperties": { "type": "string" } }, "value": { "type": "string" } } } }, "scope_id": { "type": "integer" }, "scope_type": { "type": "string", "enum": ["Organization", "Chapter"], "description": "`Organization` `Chapter`" } } } }, "$schema": "http://json-schema.org/draft-04/schema#" }, "404": { "type": "object", "properties": { "error": { "type": "string" } }, "$schema": "http://json-schema.org/draft-04/schema#" }, "422": { "type": "object", "properties": { "error": { "type": "string" } }, "$schema": "http://json-schema.org/draft-04/schema#" } } };
-exports.PostCustomUserPropertiesIdOptions = PostCustomUserPropertiesIdOptions;
-const PostEmails = { "metadata": { "allOf": [{ "type": "object", "properties": { "user_id": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#", "description": "ID of the user to send email to" }, "subject": { "type": "string", "$schema": "http://json-schema.org/draft-04/schema#", "description": "Email subject line (supports Liquid templating)" }, "body_html": { "type": "string", "$schema": "http://json-schema.org/draft-04/schema#", "description": "HTML content of the email (supports Liquid templating)" }, "body_plain": { "type": "string", "$schema": "http://json-schema.org/draft-04/schema#", "description": "Plain text fallback content" }, "email_sender_id": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#", "description": "ID of configured email sender (uses org default if omitted)" }, "reply_to": { "type": "string", "$schema": "http://json-schema.org/draft-04/schema#", "description": "Reply-to email address" }, "attachment_urls": { "type": "array", "items": { "type": "string" }, "$schema": "http://json-schema.org/draft-04/schema#", "description": "Array of URLs to files to attach (max 5)" }, "track_opens": { "type": "boolean", "$schema": "http://json-schema.org/draft-04/schema#", "description": "Enable open tracking (default: true)" }, "track_clicks": { "type": "boolean", "$schema": "http://json-schema.org/draft-04/schema#", "description": "Enable click tracking (default: true)" } }, "required": ["user_id", "subject", "body_html"] }] } };
-exports.PostEmails = PostEmails;
-const PostEventAttendances = { "body": { "type": "object", "properties": { "event_id": { "type": "integer", "format": "int64", "description": "Identifier for the Mobilize event", "minimum": -9223372036854776000, "maximum": 9223372036854776000 }, "event_session_id": { "type": "integer", "format": "int64", "description": "Identifier for the specific event session", "minimum": -9223372036854776000, "maximum": 9223372036854776000 }, "user_id": { "type": "integer", "format": "int64", "description": "Identifier for the user attending to the event", "minimum": -9223372036854776000, "maximum": 9223372036854776000 }, "attended": { "type": "boolean", "description": "Indicates if the user attended the event" } }, "required": ["event_id", "event_session_id", "user_id", "attended"], "$schema": "http://json-schema.org/draft-04/schema#" } };
-exports.PostEventAttendances = PostEventAttendances;
-const PostEventRsvps = { "body": { "type": "object", "properties": { "event_id": { "type": "integer", "format": "int64", "description": "Identifier for the Mobilize event", "minimum": -9223372036854776000, "maximum": 9223372036854776000 }, "event_session_id": { "type": "integer", "format": "int64", "description": "Identifier for the specific event session", "minimum": -9223372036854776000, "maximum": 9223372036854776000 }, "user_id": { "type": "integer", "format": "int64", "description": "Identifier for the user RSVPing to the event", "minimum": -9223372036854776000, "maximum": 9223372036854776000 }, "is_attending": { "type": "string", "description": "Indicates if the user is attending the event", "enum": ["yes", "no", "maybe"] }, "is_confirmed": { "type": "boolean", "description": "Indicates if the RSVP is confirmed" }, "agent_user_id": { "type": "integer", "format": "int64", "description": "Identifier for the agent user, if applicable", "minimum": -9223372036854776000, "maximum": 9223372036854776000 }, "source": { "type": "string", "description": "Source of the RSVP" }, "source_system": { "type": "string", "description": "System from which the RSVP originated" }, "skip_email_confirmation": { "type": "boolean", "description": "When true, skips sending the initial email confirmation to the user", "default": false } }, "required": ["event_id", "event_session_id", "is_attending", "agent_user_id"], "$schema": "http://json-schema.org/draft-04/schema#" } };
-exports.PostEventRsvps = PostEventRsvps;
-const PostEventSessions = { "body": { "type": "object", "properties": { "event_id": { "type": "integer", "format": "int64", "description": "Identifier for the Mobilize event", "minimum": -9223372036854776000, "maximum": 9223372036854776000 }, "start_time": { "type": "integer", "format": "int64", "description": "UTC timestamp in seconds since the Unix epoch", "minimum": -9223372036854776000, "maximum": 9223372036854776000 }, "end_time": { "type": "integer", "format": "int64", "description": "UTC timestamp in seconds since the Unix epoch", "minimum": -9223372036854776000, "maximum": 9223372036854776000 }, "event_type": { "type": "string", "description": "Type of session", "enum": ["virtual", "in_person"] }, "title": { "type": "string", "description": "Title of the event session" }, "location_name": { "type": "string", "description": "Name of the location" }, "location_data": { "type": "object", "description": "Structured location details. `components` and `coordinates` may be sent either as native JSON (array/object) or as JSON-encoded strings; both are stored and returned as JSON strings. Neighborhood is the `components` entry whose `types` include \"neighborhood\"; NYC borough is the entry whose `types` include \"sublocality_level_1\".", "properties": { "components": { "type": "string", "description": "JSON-encoded array of Google-style address component objects ({ long_name, short_name, types: [] }). May also be sent as a native JSON array." }, "coordinates": { "type": "string", "description": "JSON-encoded object of the form {\"lat\":<num>,\"lng\":<num>}. May also be sent as a native JSON object." }, "address_city": { "type": "string" }, "full_address": { "type": "string" }, "address_state": { "type": "string" }, "address_line_1": { "type": "string" }, "address_country": { "type": "string" }, "address_postal_code": { "type": "string" } } }, "location_address": { "type": "string", "description": "Physical address of the event location" }, "show_rsvp_bar": { "type": "boolean", "description": "Flag to show RSVP buttons bar" }, "show_title_in_form": { "type": "boolean", "description": "Flag to show title in the form" }, "note": { "type": "string", "description": "Additional notes for the event session" }, "max_capacity": { "type": "integer", "description": "Maximum capacity for the event session" }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Array of tags for the event session" } }, "required": ["event_id", "start_time", "end_time", "title"], "$schema": "http://json-schema.org/draft-04/schema#" } };
-exports.PostEventSessions = PostEventSessions;
-const PostEvents = { "body": { "type": "object", "properties": { "title": { "type": "string", "description": "Event title (max 65 characters)" }, "event_type": { "type": "string", "description": "Type of event", "enum": ["virtual", "in_person", "hybrid"] }, "start_time": { "type": "integer", "format": "int64", "description": "Start time as UNIX timestamp", "minimum": -9223372036854776000, "maximum": 9223372036854776000 }, "end_time": { "type": "integer", "format": "int64", "description": "End time as UNIX timestamp", "minimum": -9223372036854776000, "maximum": 9223372036854776000 }, "location_address": { "type": "string", "description": "For virtual: meeting URL. For in_person and hybrid: street address for the in-person session" }, "virtual_url": { "type": "string", "description": "Meeting URL for the virtual session when event_type is hybrid" }, "location_name": { "type": "string", "description": "Display name for location (e.g., \"City Hall\")" }, "scope_id": { "type": "integer", "format": "int64", "description": "ID of the scope (Organization or Chapter)", "minimum": -9223372036854776000, "maximum": 9223372036854776000 }, "scope_type": { "type": "string", "description": "Type of scope", "enum": ["Organization", "Chapter"] }, "session_title": { "type": "string", "description": "Title for the first event session (defaults to event title)" }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Event tags" }, "max_capacity": { "type": "integer", "description": "Maximum capacity for the event session (0 = unlimited)" }, "latitude": { "type": "number", "format": "float", "description": "Latitude for in_person events (optional, will geocode if not provided)", "minimum": -3.402823669209385e+38, "maximum": 3.402823669209385e+38 }, "longitude": { "type": "number", "format": "float", "description": "Longitude for in_person events (optional, will geocode if not provided)", "minimum": -3.402823669209385e+38, "maximum": 3.402823669209385e+38 }, "skip_duplicate_check": { "type": "boolean", "description": "When true, bypasses duplicate event detection (default: false)", "default": false } }, "required": ["title", "event_type", "start_time", "end_time", "scope_id", "scope_type"], "$schema": "http://json-schema.org/draft-04/schema#" } };
-exports.PostEvents = PostEvents;
-const PostFieldSurveyUrls = { "body": { "type": "object", "properties": { "user_id": { "type": "integer", "description": "The ID of the user to generate URL for", "examples": [123] }, "agent_user_id": { "type": "integer", "description": "The ID of the agent user", "examples": [456] }, "page_id": { "type": "integer", "description": "The ID of the action page (field survey)", "examples": [789] } }, "required": ["user_id", "agent_user_id", "page_id"], "$schema": "http://json-schema.org/draft-04/schema#" }, "response": { "200": { "type": "object", "properties": { "url": { "type": "string", "description": "Complete URL with access token. Token expires in 24 hours.", "examples": ["https://example.com/field-survey/volunteer-survey?access_token=abc123&user_id=456"] }, "expires_at": { "type": "string", "format": "date-time", "description": "ISO 8601 timestamp when the access token expires", "examples": ["2025-11-14T10:30:00Z"] } }, "$schema": "http://json-schema.org/draft-04/schema#" } } };
-exports.PostFieldSurveyUrls = PostFieldSurveyUrls;
-const PostScheduledTasks = { "body": { "type": "object", "properties": { "due_at": { "type": "string", "format": "date-time", "description": "The date and time when the task is due. Accepts either an ISO 8601 formatted date-time string or a UNIX timestamp as a string or integer." }, "remind_at": { "type": "string", "format": "date-time", "description": "The date and time when a reminder for the task should be sent. Accepts either an ISO 8601 formatted date-time string or a UNIX timestamp as a string or integer." }, "agent_user_id": { "type": "integer", "format": "int64", "description": "Identifier for the agent user assigned to the task", "minimum": -9223372036854776000, "maximum": 9223372036854776000 }, "user_id": { "type": "integer", "format": "int64", "description": "Identifier for the user who created the task", "minimum": -9223372036854776000, "maximum": 9223372036854776000 }, "notes": { "type": "string", "description": "Additional notes or details about the task" }, "marked_as_completed": { "type": "boolean", "description": "Indicates if the task has been marked as completed" } }, "required": ["due_at", "user_id"], "$schema": "http://json-schema.org/draft-04/schema#" } };
-exports.PostScheduledTasks = PostScheduledTasks;
-const PostTaskAgents = { "body": { "type": "object", "properties": { "user_id": { "type": "integer", "format": "int64", "description": "Identifier for the task agent", "minimum": -9223372036854776000, "maximum": 9223372036854776000 }, "task_id": { "type": "integer", "format": "int64", "description": "Identifier for the task", "minimum": -9223372036854776000, "maximum": 9223372036854776000 } }, "required": ["user_id", "task_id"], "$schema": "http://json-schema.org/draft-04/schema#" } };
-exports.PostTaskAgents = PostTaskAgents;
-const PostTaskAssignments = { "body": { "type": "object", "properties": { "user_id": { "type": "integer", "format": "int64", "description": "Identifier for the task assignment user", "minimum": -9223372036854776000, "maximum": 9223372036854776000 }, "task_id": { "type": "integer", "format": "int64", "description": "Identifier for the phonebank or textbank task", "minimum": -9223372036854776000, "maximum": 9223372036854776000 }, "agent_user_id": { "type": "integer", "format": "int64", "description": "Identifier for the agent user who will conduct outreach (volunteer or staff member)", "minimum": -9223372036854776000, "maximum": 9223372036854776000 } }, "required": ["user_id", "task_id"], "$schema": "http://json-schema.org/draft-04/schema#" } };
-exports.PostTaskAssignments = PostTaskAssignments;
-const PostTeamMembers = { "body": { "type": "object", "properties": { "member_id": { "type": "string", "description": "Hash ID of existing user (optional if phone_number or email provided)" }, "phone_number": { "type": "string", "description": "Phone number of the person (primary key for user lookup/creation)" }, "email": { "type": "string", "description": "Email of the person (secondary key for user lookup/creation)" }, "full_name": { "type": "string", "description": "Full name for new user creation" }, "first_name": { "type": "string", "description": "First name for new user creation" }, "last_name": { "type": "string", "description": "Last name for new user creation" }, "role_id": { "type": "integer", "description": "ID of the role to assign" }, "scope_type": { "type": "string", "enum": ["Chapter", "Organization"], "description": "Type of scope" }, "scope_id": { "type": "integer", "description": "ID of the scope (Chapter or Organization)" }, "invite_via": { "type": "string", "enum": ["sms", "email"], "description": "How to send the invitation" }, "task_id": { "type": "integer", "description": "Optional task ID to assign the member to" } }, "required": ["role_id", "scope_type", "scope_id", "invite_via"], "$schema": "http://json-schema.org/draft-04/schema#" } };
-exports.PostTeamMembers = PostTeamMembers;
-const PostTextTemplates = { "body": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the entity" }, "scope_id": { "type": "integer", "format": "int64", "description": "Identifier for the scope", "minimum": -9223372036854776000, "maximum": 9223372036854776000 }, "scope_type": { "type": "string", "description": "Type of the scope", "enum": ["Organization", "Chapter"] }, "template": { "type": "object", "description": "Template content in various languages, where keys are 2-character language codes (e.g., \"en\" for English, \"fr\" for French).", "additionalProperties": { "type": "string", "description": "The message in the specified language." } }, "event_id": { "type": "integer", "format": "int64", "description": "Identifier for the associated event, if applicable", "minimum": -9223372036854776000, "maximum": 9223372036854776000 } }, "required": ["iname", "scope_id", "scope_type"], "$schema": "http://json-schema.org/draft-04/schema#" } };
-exports.PostTextTemplates = PostTextTemplates;
-const PostTexts = { "metadata": { "allOf": [{ "type": "object", "properties": { "user_id": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#" }, "body": { "type": "string", "$schema": "http://json-schema.org/draft-04/schema#" }, "media_urls": { "type": "array", "items": { "type": "string" }, "$schema": "http://json-schema.org/draft-04/schema#" }, "attach_contact_card": { "type": "boolean", "$schema": "http://json-schema.org/draft-04/schema#" }, "shorten_urls": { "type": "boolean", "$schema": "http://json-schema.org/draft-04/schema#" } }, "required": ["user_id", "body"] }] } };
-exports.PostTexts = PostTexts;
-const PostUserActions = { "body": { "type": "object", "required": ["page_id"], "oneOf": [{ "required": ["user_id"], "properties": { "page_id": { "type": "integer", "format": "int64", "description": "Identifier for the Page, required for new user actions", "minimum": -9223372036854776000, "maximum": 9223372036854776000 }, "user_id": { "type": "integer", "format": "int64", "description": "Identifier for the User", "minimum": -9223372036854776000, "maximum": 9223372036854776000 }, "created_at": { "type": "integer", "format": "int64", "description": "UTC timestamp in seconds since the Unix epoch for the creation time of the user action", "minimum": -9223372036854776000, "maximum": 9223372036854776000 }, "data": { "type": "object", "properties": { "phone_number": { "type": "string", "description": "User's phone number" }, "email": { "type": "string", "format": "email", "description": "User's email address" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "preferred_language": { "type": "string" }, "second_language": { "type": "string" }, "chapter_id": { "type": "integer" }, "address": { "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zip_code": { "type": "string" }, "country": { "type": "string" } } }, "assessment": { "type": "string", "description": "Assessment status key to set on the user (maps to classification)" }, "sms_permission": { "type": "boolean" }, "call_permission": { "type": "boolean" }, "email_permission": { "type": "boolean" }, "custom_user_properties": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "type": "object" }, { "required": ["data"], "properties": { "data": { "type": "object", "oneOf": [{ "required": ["phone_number"], "properties": { "phone_number": { "type": "string", "description": "User's phone number" }, "email": { "type": "string", "format": "email", "description": "User's email address" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "preferred_language": { "type": "string" }, "second_language": { "type": "string" }, "chapter_id": { "type": "integer" }, "address": { "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zip_code": { "type": "string" }, "country": { "type": "string" } } }, "assessment": { "type": "string", "description": "Assessment status key to set on the user (maps to classification)" }, "sms_permission": { "type": "boolean" }, "call_permission": { "type": "boolean" }, "email_permission": { "type": "boolean" }, "custom_user_properties": { "type": "object", "additionalProperties": { "type": "string" } } }, "type": "object" }, { "required": ["email"], "properties": { "phone_number": { "type": "string", "description": "User's phone number" }, "email": { "type": "string", "format": "email", "description": "User's email address" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "preferred_language": { "type": "string" }, "second_language": { "type": "string" }, "chapter_id": { "type": "integer" }, "address": { "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zip_code": { "type": "string" }, "country": { "type": "string" } } }, "assessment": { "type": "string", "description": "Assessment status key to set on the user (maps to classification)" }, "sms_permission": { "type": "boolean" }, "call_permission": { "type": "boolean" }, "email_permission": { "type": "boolean" }, "custom_user_properties": { "type": "object", "additionalProperties": { "type": "string" } } }, "type": "object" }] }, "page_id": { "type": "integer", "format": "int64", "description": "Identifier for the Page, required for new user actions", "minimum": -9223372036854776000, "maximum": 9223372036854776000 }, "user_id": { "type": "integer", "format": "int64", "description": "Identifier for the User", "minimum": -9223372036854776000, "maximum": 9223372036854776000 }, "created_at": { "type": "integer", "format": "int64", "description": "UTC timestamp in seconds since the Unix epoch for the creation time of the user action", "minimum": -9223372036854776000, "maximum": 9223372036854776000 } }, "type": "object" }], "$schema": "http://json-schema.org/draft-04/schema#" } };
-exports.PostUserActions = PostUserActions;
-const PostUserLists = { "body": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the user list" }, "scope_id": { "type": "integer", "format": "int64", "description": "Identifier for the scope", "minimum": -9223372036854776000, "maximum": 9223372036854776000 }, "scope_type": { "type": "string", "description": "Type of the scope", "enum": ["Organization", "Chapter"] }, "event_id": { "type": "integer", "format": "int64", "description": "Identifier for the associated event, if applicable", "minimum": -9223372036854776000, "maximum": 9223372036854776000 }, "user_id": { "type": "integer", "format": "int64", "description": "Identifier for the associated user", "minimum": -9223372036854776000, "maximum": 9223372036854776000 }, "parameters": { "type": "object", "description": "Parameters for filtering users in QueryBuilder format", "properties": { "condition": { "type": "string", "enum": ["AND", "OR"], "description": "Top-level condition for the rules", "examples": ["AND"] }, "valid": { "type": "boolean", "description": "Indicates if the rule set is valid", "examples": [true] }, "rules": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Field identifier", "examples": ["time.account_created"] }, "type": { "type": "string", "description": "Data type of the field", "examples": ["date"] }, "operator": { "type": "string", "description": "Comparison operator", "examples": ["between"] }, "value": { "oneOf": [{ "type": "string", "examples": ["2023-10-23"] }, { "type": "number", "examples": ["2024-07-25"] }, { "type": "boolean" }, { "type": "array", "items": { "oneOf": [{ "type": "string" }, { "type": "number" }, { "type": "boolean" }] } }], "description": "Value or values to compare against", "examples": [["2023-10-23", "2024-07-25"]] } } } } } } }, "required": ["name", "scope_id", "scope_type", "parameters"], "$schema": "http://json-schema.org/draft-04/schema#" } };
-exports.PostUserLists = PostUserLists;
-const PostUserNotes = { "metadata": { "allOf": [{ "type": "object", "properties": { "user_id": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#" }, "agent_id": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#" }, "content": { "type": "string", "$schema": "http://json-schema.org/draft-04/schema#" }, "created_at": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#" }, "restricted": { "type": "boolean", "$schema": "http://json-schema.org/draft-04/schema#", "description": "When true, the note is only visible to team members with the View Restricted Properties permission." }, "interaction_method": { "type": "string", "enum": ["in_person", "call", "text", "email"], "$schema": "http://json-schema.org/draft-04/schema#", "description": "Optional interaction type that produced the note. One of: in_person, call, text, email." } }, "required": ["user_id", "content"] }] } };
-exports.PostUserNotes = PostUserNotes;
-const PostUserRelationships = { "metadata": { "allOf": [{ "type": "object", "properties": { "user_id": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#" }, "related_user_id": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#" }, "relationship_type": { "type": "string", "$schema": "http://json-schema.org/draft-04/schema#" } }, "required": ["user_id", "related_user_id", "relationship_type"] }] } };
-exports.PostUserRelationships = PostUserRelationships;
-const PostUsers = { "body": { "type": "object", "oneOf": [{ "type": "object", "required": ["phone_number"], "properties": { "phone_number": { "type": "string", "format": "phone" }, "email": { "type": "string", "format": "email" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "preferred_language": { "type": "string" }, "second_language": { "type": "string" }, "chapter_id": { "type": "integer", "description": "Primary chapter ID. Required for new users unless chapter_ids is provided." }, "chapter_ids": { "type": "array", "description": "Array of chapter IDs for multi-chapter membership. First element becomes primary if chapter_id not provided. Requires multi-chapter feature for more than one chapter.", "items": { "type": "integer" } }, "referred_by_user_id": { "type": "integer" }, "custom_user_properties": { "type": "object", "description": "Custom property values keyed by internal_name. Use a string for single-value fields (text, number, radio, dropdown, single checkbox). Use an array of strings for Multiple Checkboxes fields (e.g. [\"Option A\", \"Option B\"]). Comma-separated strings are also accepted for Multiple Checkboxes (e.g. \"Option A, Option B\"). For Multiple Checkboxes, see append_custom_user_properties to control whether values are merged with or replace existing values.", "additionalProperties": { "oneOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }] } }, "append_custom_user_properties": { "type": "boolean", "description": "Controls how Multiple Checkboxes custom properties are written. Defaults to true (union new values with existing values, the long-standing API behavior). Set to false to overwrite existing values, mirroring bulk update REPLACE mode. Has no effect on non-array field types." }, "add_tags": { "type": "array", "items": { "type": "string" } }, "remove_tags": { "type": "array", "items": { "type": "string" } }, "donation_charge": { "type": "object", "description": "Optional external donation charge to create", "required": ["amount", "external_donation_id", "external_donation_source"], "properties": { "amount": { "type": "number", "description": "Donation amount in dollars" }, "processing_fee": { "type": "number", "description": "Processing fee in dollars" }, "external_donation_id": { "type": "string", "description": "External platform donation ID" }, "external_donation_source": { "type": "string", "description": "Source platform (e.g. WePay, ActBlue, etc.)" }, "external_donation_date": { "type": "string", "format": "date-time", "description": "Date of the donation" } } }, "address": { "type": "object", "description": "Optional address to create. We will attempt to geocode the address if latitude and longitude are not provided.", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zip_code": { "type": "string" }, "country": { "type": "string" }, "latitude": { "type": "number", "format": "float", "minimum": -3.402823669209385e+38, "maximum": 3.402823669209385e+38 }, "longitude": { "type": "number", "format": "float", "minimum": -3.402823669209385e+38, "maximum": 3.402823669209385e+38 } } }, "assessment": { "type": "string", "description": "Assessment status key to set on the user (maps to classification)" }, "sms_permission": { "type": "boolean" }, "call_permission": { "type": "boolean" }, "email_permission": { "type": "boolean" }, "timezone": { "type": "string", "description": "IANA timezone identifier (e.g., \"America/New_York\", \"Europe/London\")" }, "require_contact_info": { "type": "boolean", "description": "Whether to require phone_number or email for user creation. Defaults to true." }, "phone_number_textable_validation": { "type": "boolean", "description": "Whether to validate that phone number is textable. Defaults to true." }, "lookup_key": { "type": "string", "description": "Custom property key (internal_name) to use for user lookup/deduplication. Value is read from custom_user_properties[lookup_key]. Allows matching existing users by external IDs stored in custom properties." } } }, { "type": "object", "required": ["email"], "properties": { "phone_number": { "type": "string", "format": "phone" }, "email": { "type": "string", "format": "email" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "preferred_language": { "type": "string" }, "second_language": { "type": "string" }, "chapter_id": { "type": "integer", "description": "Primary chapter ID. Required for new users unless chapter_ids is provided." }, "chapter_ids": { "type": "array", "description": "Array of chapter IDs for multi-chapter membership. First element becomes primary if chapter_id not provided. Requires multi-chapter feature for more than one chapter.", "items": { "type": "integer" } }, "referred_by_user_id": { "type": "integer" }, "custom_user_properties": { "type": "object", "description": "Custom property values keyed by internal_name. Use a string for single-value fields (text, number, radio, dropdown, single checkbox). Use an array of strings for Multiple Checkboxes fields (e.g. [\"Option A\", \"Option B\"]). Comma-separated strings are also accepted for Multiple Checkboxes (e.g. \"Option A, Option B\"). For Multiple Checkboxes, see append_custom_user_properties to control whether values are merged with or replace existing values.", "additionalProperties": { "oneOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }] } }, "append_custom_user_properties": { "type": "boolean", "description": "Controls how Multiple Checkboxes custom properties are written. Defaults to true (union new values with existing values, the long-standing API behavior). Set to false to overwrite existing values, mirroring bulk update REPLACE mode. Has no effect on non-array field types." }, "add_tags": { "type": "array", "items": { "type": "string" } }, "remove_tags": { "type": "array", "items": { "type": "string" } }, "donation_charge": { "type": "object", "description": "Optional external donation charge to create", "required": ["amount", "external_donation_id", "external_donation_source"], "properties": { "amount": { "type": "number", "description": "Donation amount in dollars" }, "processing_fee": { "type": "number", "description": "Processing fee in dollars" }, "external_donation_id": { "type": "string", "description": "External platform donation ID" }, "external_donation_source": { "type": "string", "description": "Source platform (e.g. WePay, ActBlue, etc.)" }, "external_donation_date": { "type": "string", "format": "date-time", "description": "Date of the donation" } } }, "address": { "type": "object", "description": "Optional address to create. We will attempt to geocode the address if latitude and longitude are not provided.", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zip_code": { "type": "string" }, "country": { "type": "string" }, "latitude": { "type": "number", "format": "float", "minimum": -3.402823669209385e+38, "maximum": 3.402823669209385e+38 }, "longitude": { "type": "number", "format": "float", "minimum": -3.402823669209385e+38, "maximum": 3.402823669209385e+38 } } }, "assessment": { "type": "string", "description": "Assessment status key to set on the user (maps to classification)" }, "sms_permission": { "type": "boolean" }, "call_permission": { "type": "boolean" }, "email_permission": { "type": "boolean" }, "timezone": { "type": "string", "description": "IANA timezone identifier (e.g., \"America/New_York\", \"Europe/London\")" }, "require_contact_info": { "type": "boolean", "description": "Whether to require phone_number or email for user creation. Defaults to true." }, "phone_number_textable_validation": { "type": "boolean", "description": "Whether to validate that phone number is textable. Defaults to true." }, "lookup_key": { "type": "string", "description": "Custom property key (internal_name) to use for user lookup/deduplication. Value is read from custom_user_properties[lookup_key]. Allows matching existing users by external IDs stored in custom properties." } } }], "$schema": "http://json-schema.org/draft-04/schema#" } };
-exports.PostUsers = PostUsers;
-const PostUsersMerge = { "body": { "type": "object", "properties": { "primary_user_id": { "type": "integer", "description": "ID of the user to keep (the survivor). All data from duplicates will be merged into this user.", "examples": [100] }, "user_ids": { "type": "array", "items": { "type": "integer", "examples": [101] }, "description": "IDs of the duplicate users to merge into the primary user. These users will be deactivated after merge. Also accepts a comma-separated string." } }, "required": ["primary_user_id", "user_ids"], "$schema": "http://json-schema.org/draft-04/schema#" }, "response": { "200": { "type": "object", "properties": { "message": { "type": "string" }, "primary_user_id": { "type": "integer", "description": "ID of the surviving user" }, "merged_user_ids": { "type": "array", "items": { "type": "integer" }, "description": "IDs that were successfully merged" }, "merged_count": { "type": "integer", "description": "Number of users merged" }, "not_found_user_ids": { "type": "array", "items": { "type": "integer" }, "description": "IDs that were not found (only present if some IDs were missing)" } }, "$schema": "http://json-schema.org/draft-04/schema#" } } };
-exports.PostUsersMerge = PostUsersMerge;
-const PutAgentAssignmentsId = { "body": { "type": "object", "properties": { "user_id": { "type": "integer", "format": "int64", "description": "Identifier for the user", "minimum": -9223372036854776000, "maximum": 9223372036854776000 }, "agent_user_id": { "type": "integer", "format": "int64", "description": "Identifier for the agent user", "minimum": -9223372036854776000, "maximum": 9223372036854776000 }, "is_active": { "type": "boolean", "description": "Indicates if the assignment is currently active" } }, "$schema": "http://json-schema.org/draft-04/schema#" }, "metadata": { "allOf": [{ "type": "object", "properties": { "id": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#", "description": "Identifier of the agent assignment to update" } }, "required": ["id"] }] } };
-exports.PutAgentAssignmentsId = PutAgentAssignmentsId;
-const PutEventRsvpsId = { "body": { "type": "object", "properties": { "is_attending": { "type": "string", "description": "Indicates if the user is attending the event", "enum": ["yes", "no", "maybe"] }, "is_confirmed": { "type": "boolean", "description": "Indicates if the RSVP is confirmed" }, "agent_user_id": { "type": "integer", "format": "int64", "description": "Identifier for the agent user, if applicable", "minimum": -9223372036854776000, "maximum": 9223372036854776000 }, "source": { "type": "string", "description": "Source of the RSVP" }, "source_system": { "type": "string", "description": "System from which the RSVP originated" } }, "$schema": "http://json-schema.org/draft-04/schema#" }, "metadata": { "allOf": [{ "type": "object", "properties": { "id": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#", "description": "Identifier of the event rsvp to update" } }, "required": ["id"] }] } };
-exports.PutEventRsvpsId = PutEventRsvpsId;
-const PutEventSessionsId = { "body": { "type": "object", "properties": { "start_time": { "type": "integer", "format": "int64", "description": "UTC timestamp in seconds since the Unix epoch", "minimum": -9223372036854776000, "maximum": 9223372036854776000 }, "end_time": { "type": "integer", "format": "int64", "description": "UTC timestamp in seconds since the Unix epoch", "minimum": -9223372036854776000, "maximum": 9223372036854776000 }, "title": { "type": "string", "description": "Title of the event session" }, "location_name": { "type": "string", "description": "Name of the location" }, "location_address": { "type": "string", "description": "Physical address of the event location" }, "location_data": { "type": "object", "description": "See create. `components`/`coordinates` accept native JSON or JSON strings and are stored/returned as JSON strings. Omit to leave the existing location_data unchanged.", "additionalProperties": true }, "show_rsvp_bar": { "type": "boolean", "description": "Flag to show RSVP buttons bar" }, "show_title_in_form": { "type": "boolean", "description": "Flag to show title in the form" }, "note": { "type": "string", "description": "Additional notes for the event session" }, "max_capacity": { "type": "integer", "description": "Maximum capacity for the event session" }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Array of tags for the event session" } }, "$schema": "http://json-schema.org/draft-04/schema#" }, "metadata": { "allOf": [{ "type": "object", "properties": { "id": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#", "description": "Identifier of the event session to update" } }, "required": ["id"] }] } };
-exports.PutEventSessionsId = PutEventSessionsId;
-const PutScheduledTasksId = { "body": { "type": "object", "properties": { "due_at": { "type": "string", "format": "date-time", "description": "The date and time when the task is due. Accepts either an ISO 8601 formatted date-time string or a UNIX timestamp as a string or integer." }, "remind_at": { "type": "string", "format": "date-time", "description": "The date and time when a reminder for the task should be sent. Accepts either an ISO 8601 formatted date-time string or a UNIX timestamp as a string or integer." }, "agent_user_id": { "type": "integer", "format": "int64", "description": "Identifier for the agent user assigned to the task", "minimum": -9223372036854776000, "maximum": 9223372036854776000 }, "user_id": { "type": "integer", "format": "int64", "description": "Identifier for the user who created the task", "minimum": -9223372036854776000, "maximum": 9223372036854776000 }, "notes": { "type": "string", "description": "Additional notes or details about the task" }, "marked_as_completed": { "type": "boolean", "description": "Indicates if the task has been marked as completed" } }, "$schema": "http://json-schema.org/draft-04/schema#" }, "metadata": { "allOf": [{ "type": "object", "properties": { "id": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#", "description": "Identifier of the scheduled task to update" } }, "required": ["id"] }] } };
-exports.PutScheduledTasksId = PutScheduledTasksId;
-const PutTaskAssignmentsId = { "body": { "type": "object", "properties": { "agent_user_id": { "type": "integer", "format": "int64", "description": "Identifier for the agent user, if applicable", "minimum": -9223372036854776000, "maximum": 9223372036854776000 } }, "$schema": "http://json-schema.org/draft-04/schema#" }, "metadata": { "allOf": [{ "type": "object", "properties": { "id": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#", "description": "Identifier of the task assignment to update" } }, "required": ["id"] }] } };
-exports.PutTaskAssignmentsId = PutTaskAssignmentsId;
-const PutTeamMembersId = { "body": { "type": "object", "properties": { "role_id": { "type": "integer", "description": "ID of the role to assign" }, "scope_type": { "type": "string", "enum": ["Chapter", "Organization"], "description": "Type of scope" }, "scope_id": { "type": "integer", "description": "ID of the scope (Chapter or Organization)" } }, "required": ["role_id", "scope_type", "scope_id"], "$schema": "http://json-schema.org/draft-04/schema#" }, "metadata": { "allOf": [{ "type": "object", "properties": { "id": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#", "description": "Team member ID (UserRoleScope ID)" } }, "required": ["id"] }] } };
-exports.PutTeamMembersId = PutTeamMembersId;
-const PutTextTemplatesId = { "body": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the entity" }, "scope_id": { "type": "integer", "format": "int64", "description": "Identifier for the scope", "minimum": -9223372036854776000, "maximum": 9223372036854776000 }, "scope_type": { "type": "string", "description": "Type of the scope" }, "template": { "type": "object", "description": "Template content in various languages, where keys are 2-character language codes (e.g., \"en\" for English, \"fr\" for French).", "additionalProperties": { "type": "string", "description": "The message in the specified language." } }, "event_id": { "type": "integer", "format": "int64", "description": "Identifier for the associated event, if applicable", "minimum": -9223372036854776000, "maximum": 9223372036854776000 } }, "$schema": "http://json-schema.org/draft-04/schema#" }, "metadata": { "allOf": [{ "type": "object", "properties": { "id": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#", "description": "Identifier of the text template to update" } }, "required": ["id"] }] } };
-exports.PutTextTemplatesId = PutTextTemplatesId;
-const PutUserListsId = { "body": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the user list" }, "scope_id": { "type": "integer", "format": "int64", "description": "Identifier for the scope", "minimum": -9223372036854776000, "maximum": 9223372036854776000 }, "scope_type": { "type": "string", "description": "Type of the scope", "enum": ["Organization", "Chapter"] }, "parameters": { "type": "object", "description": "Parameters for filtering users in QueryBuilder format", "properties": { "condition": { "type": "string", "enum": ["AND", "OR"], "description": "Top-level condition for the rules" }, "valid": { "type": "boolean", "description": "Indicates if the rule set is valid" }, "rules": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Field identifier" }, "type": { "type": "string", "description": "Data type of the field" }, "operator": { "type": "string", "description": "Comparison operator" }, "value": { "oneOf": [{ "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "array", "items": { "oneOf": [{ "type": "string" }, { "type": "number" }, { "type": "boolean" }] } }], "description": "Value or values to compare against" } } } } } }, "event_id": { "type": "integer", "format": "int64", "description": "Identifier for the associated event, if applicable", "minimum": -9223372036854776000, "maximum": 9223372036854776000 } }, "$schema": "http://json-schema.org/draft-04/schema#" }, "metadata": { "allOf": [{ "type": "object", "properties": { "id": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#", "description": "Identifier of the user list to update" } }, "required": ["id"] }] } };
-exports.PutUserListsId = PutUserListsId;
-const PutUsersId = { "body": { "type": "object", "properties": { "phone_number": { "type": "string", "format": "phone" }, "email": { "type": "string", "format": "email" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "preferred_language": { "type": "string" }, "chapter_id": { "type": "integer", "description": "Primary chapter ID (backwards compatible)" }, "chapter_ids": { "type": "array", "items": { "type": "integer" }, "description": "Full array of chapter IDs (replaces all). Requires multi-chapter feature." }, "add_chapter_ids": { "type": "array", "items": { "type": "integer" }, "description": "Array of chapter IDs to add. Requires multi-chapter feature." }, "remove_chapter_ids": { "type": "array", "items": { "type": "integer" }, "description": "Array of chapter IDs to remove. Requires multi-chapter feature." }, "set_exclusive_chapter": { "type": "boolean", "description": "When true with chapter_id, sets that chapter as the only chapter (removes all other chapter memberships)." }, "second_language": { "type": "string" }, "referred_by_user_id": { "type": "integer" }, "custom_user_properties": { "type": "object", "additionalProperties": { "oneOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }] }, "description": "Custom property values keyed by internal_name. Use a string for single-value fields. Use an array of strings for Multiple Checkboxes fields. Comma-separated strings are also accepted for Multiple Checkboxes. For Multiple Checkboxes, see append_custom_user_properties to control whether values are merged with or replace existing values." }, "append_custom_user_properties": { "type": "boolean", "description": "Controls how Multiple Checkboxes custom properties are written. Defaults to true (union new values with existing values, the long-standing API behavior). Set to false to overwrite existing values, mirroring bulk update REPLACE mode. Has no effect on non-array field types." }, "address": { "type": "object", "description": "Optional address to update. We will attempt to geocode the address if latitude and longitude are not provided.", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zip_code": { "type": "string" }, "country": { "type": "string" }, "latitude": { "type": "number", "format": "float", "minimum": -3.402823669209385e+38, "maximum": 3.402823669209385e+38 }, "longitude": { "type": "number", "format": "float", "minimum": -3.402823669209385e+38, "maximum": 3.402823669209385e+38 } } }, "assessment": { "type": "string", "description": "Assessment status key to set on the user (maps to classification)" }, "sms_permission": { "type": "boolean" }, "call_permission": { "type": "boolean" }, "email_permission": { "type": "boolean" }, "timezone": { "type": "string", "description": "IANA timezone identifier (e.g., \"America/New_York\", \"Europe/London\")" }, "donation_charge": { "type": "object", "description": "Optional external donation charge to create", "properties": { "amount": { "type": "number", "description": "Donation amount in dollars" }, "processing_fee": { "type": "number", "description": "Processing fee in dollars" }, "external_donation_id": { "type": "string", "description": "External platform donation ID" }, "external_donation_source": { "type": "string", "description": "Source platform (e.g. WePay, ActBlue, etc.)" }, "external_donation_date": { "type": "string", "format": "date-time", "description": "Date of the donation" } }, "required": ["amount", "external_donation_id", "external_donation_source"] } }, "$schema": "http://json-schema.org/draft-04/schema#" }, "metadata": { "allOf": [{ "type": "object", "properties": { "id": { "type": "integer", "$schema": "http://json-schema.org/draft-04/schema#", "description": "ID of the user to update" } }, "required": ["id"] }] } };
-exports.PutUsersId = PutUsersId;