@a1liu/solidarity-tech-api 0.1.6 → 0.1.7

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

@@ -1,759 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const oas_1 = __importDefault(require("oas"));
-const core_1 = __importDefault(require("api/dist/core"));
-const openapi_json_1 = __importDefault(require("./openapi.json"));
-class SDK {
-    constructor() {
-        this.spec = oas_1.default.init(openapi_json_1.default);
-        this.core = new core_1.default(this.spec, 'solidarity-tech/v1 (api/6.1.3)');
-    }
-    /**
-     * Optionally configure various options that the SDK allows.
-     *
-     * @param config Object of supported SDK options and toggles.
-     * @param config.timeout Override the default `fetch` request timeout of 30 seconds. This number
-     * should be represented in milliseconds.
-     */
-    config(config) {
-        this.core.setConfig(config);
-    }
-    /**
-     * If the API you're using requires authentication you can supply the required credentials
-     * through this method and the library will magically determine how they should be used
-     * within your API request.
-     *
-     * With the exception of OpenID and MutualTLS, it supports all forms of authentication
-     * supported by the OpenAPI specification.
-     *
-     * @example <caption>HTTP Basic auth</caption>
-     * sdk.auth('username', 'password');
-     *
-     * @example <caption>Bearer tokens (HTTP or OAuth 2)</caption>
-     * sdk.auth('myBearerToken');
-     *
-     * @example <caption>API Keys</caption>
-     * sdk.auth('myApiKey');
-     *
-     * @see {@link https://spec.openapis.org/oas/v3.0.3#fixed-fields-22}
-     * @see {@link https://spec.openapis.org/oas/v3.1.0#fixed-fields-22}
-     * @param values Your auth credentials for the API; can specify up to two strings or numbers.
-     */
-    auth(...values) {
-        this.core.setAuth(...values);
-        return this;
-    }
-    /**
-     * If the API you're using offers alternate server URLs, and server variables, you can tell
-     * the SDK which one to use with this method. To use it you can supply either one of the
-     * server URLs that are contained within the OpenAPI definition (along with any server
-     * variables), or you can pass it a fully qualified URL to use (that may or may not exist
-     * within the OpenAPI definition).
-     *
-     * @example <caption>Server URL with server variables</caption>
-     * sdk.server('https://{region}.api.example.com/{basePath}', {
-     *   name: 'eu',
-     *   basePath: 'v14',
-     * });
-     *
-     * @example <caption>Fully qualified server URL</caption>
-     * sdk.server('https://eu.api.example.com/v14');
-     *
-     * @param url Server URL
-     * @param variables An object of variables to replace into the server URL.
-     */
-    server(url, variables = {}) {
-        this.core.setServer(url, variables);
-    }
-    /**
-     * Retrieves all activities
-     *
-     */
-    getActivities(metadata) {
-        return this.core.fetch('/activities', 'get', metadata);
-    }
-    /**
-     * Lists agent assignments
-     *
-     */
-    getAgent_assignments(metadata) {
-        return this.core.fetch('/agent_assignments', 'get', metadata);
-    }
-    /**
-     * Creates an agent assignment with the specified details.
-     *
-     * @summary Creates an agent assignment
-     */
-    postAgent_assignments(body) {
-        return this.core.fetch('/agent_assignments', 'post', body);
-    }
-    /**
-     * Shows a single agent assignment
-     *
-     */
-    getAgent_assignmentsId(metadata) {
-        return this.core.fetch('/agent_assignments/{id}', 'get', metadata);
-    }
-    /**
-     * Updates an agent assignment with the specified details.
-     *
-     * @summary Updates an agent assignment
-     */
-    putAgent_assignmentsId(body, metadata) {
-        return this.core.fetch('/agent_assignments/{id}', 'put', body, metadata);
-    }
-    /**
-     * Deletes an agent assignment with the specified ID.
-     *
-     * @summary Deletes an agent assignment
-     */
-    deleteAgent_assignmentsId(metadata) {
-        return this.core.fetch('/agent_assignments/{id}', 'delete', metadata);
-    }
-    /**
-     * Enroll user in an automation
-     *
-     */
-    postAutomation_enrollments(body) {
-        return this.core.fetch('/automation_enrollments', 'post', body);
-    }
-    /**
-     * Retrieves all calls
-     *
-     */
-    getCalls(metadata) {
-        return this.core.fetch('/calls', 'get', metadata);
-    }
-    /**
-     * Lists chapter phone numbers
-     *
-     */
-    getChapter_phone_numbers(metadata) {
-        return this.core.fetch('/chapter_phone_numbers', 'get', metadata);
-    }
-    /**
-     * Retrieves all chapters
-     *
-     */
-    getChapters(metadata) {
-        return this.core.fetch('/chapters', 'get', metadata);
-    }
-    /**
-     * Retrieves all custom user properties
-     *
-     */
-    getCustom_user_properties(metadata) {
-        return this.core.fetch('/custom_user_properties', 'get', metadata);
-    }
-    /**
-     * Creates a new custom user property
-     *
-     * @throws FetchError<422, types.PostCustomUserPropertiesResponse422> validation failed
-     */
-    postCustom_user_properties(body) {
-        return this.core.fetch('/custom_user_properties', 'post', body);
-    }
-    /**
-     * Removes an option from a custom user property
-     *
-     * @throws FetchError<404, types.DeleteCustomUserPropertiesCustomUserPropertyIdOptionsIdResponse404> option or custom user property not found
-     * @throws FetchError<422, types.DeleteCustomUserPropertiesCustomUserPropertyIdOptionsIdResponse422> validation failed
-     */
-    deleteCustom_user_propertiesCustom_user_property_idOptionsId(metadata) {
-        return this.core.fetch('/custom_user_properties/{custom_user_property_id}/options/{id}', 'delete', metadata);
-    }
-    /**
-     * Creates an option for a custom user property
-     *
-     * @throws FetchError<404, types.PostCustomUserPropertiesIdOptionsResponse404> custom user property not found
-     * @throws FetchError<422, types.PostCustomUserPropertiesIdOptionsResponse422> validation failed
-     */
-    postCustom_user_propertiesIdOptions(body, metadata) {
-        return this.core.fetch('/custom_user_properties/{id}/options', 'post', body, metadata);
-    }
-    /**
-     * Lists donation charges
-     *
-     */
-    getDonation_charges(metadata) {
-        return this.core.fetch('/donation_charges', 'get', metadata);
-    }
-    /**
-     * Retrieves a donation charge
-     *
-     */
-    getDonation_chargesId(metadata) {
-        return this.core.fetch('/donation_charges/{id}', 'get', metadata);
-    }
-    /**
-     * Lists email blasts
-     *
-     */
-    getEmail_blasts(metadata) {
-        return this.core.fetch('/email_blasts', 'get', metadata);
-    }
-    /**
-     * Shows a single email blast
-     *
-     */
-    getEmail_blastsId(metadata) {
-        return this.core.fetch('/email_blasts/{id}', 'get', metadata);
-    }
-    /**
-     * Returns a list of email senders available for the API key's scope. Use these sender IDs
-     * when sending emails via the POST /emails endpoint.
-     *
-     * @summary Lists available email senders
-     */
-    getEmail_senders(metadata) {
-        return this.core.fetch('/email_senders', 'get', metadata);
-    }
-    /**
-     * Sends a single transactional email to a user. Supports Liquid templating for
-     * personalization (e.g., {{ first_name }}).
-     *
-     * @summary Sends a one-off email to a user
-     */
-    postEmails(metadata) {
-        return this.core.fetch('/emails', 'post', metadata);
-    }
-    /**
-     * Lists event attendances
-     *
-     */
-    getEvent_attendances(metadata) {
-        return this.core.fetch('/event_attendances', 'get', metadata);
-    }
-    /**
-     * Creates an event attendance with the specified details.
-     *
-     * @summary Creates an event attendance
-     */
-    postEvent_attendances(body) {
-        return this.core.fetch('/event_attendances', 'post', body);
-    }
-    /**
-     * Deletes an event attendance with the specified ID.
-     *
-     * @summary Deletes an event attendance
-     */
-    deleteEvent_attendancesId(metadata) {
-        return this.core.fetch('/event_attendances/{id}', 'delete', metadata);
-    }
-    /**
-     * Lists event rsvps
-     *
-     */
-    getEvent_rsvps(metadata) {
-        return this.core.fetch('/event_rsvps', 'get', metadata);
-    }
-    /**
-     * Creates an event rsvp with the specified details.
-     *
-     * @summary Creates an event rsvp
-     */
-    postEvent_rsvps(body) {
-        return this.core.fetch('/event_rsvps', 'post', body);
-    }
-    /**
-     * Shows a single event rsvp
-     *
-     */
-    getEvent_rsvpsId(metadata) {
-        return this.core.fetch('/event_rsvps/{id}', 'get', metadata);
-    }
-    /**
-     * Updates an event rsvp with the specified details.
-     *
-     * @summary Updates an event rsvp
-     */
-    putEvent_rsvpsId(body, metadata) {
-        return this.core.fetch('/event_rsvps/{id}', 'put', body, metadata);
-    }
-    /**
-     * Deletes an event rsvp with the specified ID.
-     *
-     * @summary Deletes an event rsvp
-     */
-    deleteEvent_rsvpsId(metadata) {
-        return this.core.fetch('/event_rsvps/{id}', 'delete', metadata);
-    }
-    /**
-     * Lists event sessions
-     *
-     */
-    getEvent_sessions(metadata) {
-        return this.core.fetch('/event_sessions', 'get', metadata);
-    }
-    /**
-     * Creates an event session with the specified details.
-     *
-     * @summary Creates an event session
-     */
-    postEvent_sessions(body) {
-        return this.core.fetch('/event_sessions', 'post', body);
-    }
-    /**
-     * Shows a single event session
-     *
-     */
-    getEvent_sessionsId(metadata) {
-        return this.core.fetch('/event_sessions/{id}', 'get', metadata);
-    }
-    /**
-     * Updates an event session with the specified details.
-     *
-     * @summary Updates an event session
-     */
-    putEvent_sessionsId(body, metadata) {
-        return this.core.fetch('/event_sessions/{id}', 'put', body, metadata);
-    }
-    /**
-     * Deletes an event session with the specified ID.
-     *
-     * @summary Deletes an event session
-     */
-    deleteEvent_sessionsId(metadata) {
-        return this.core.fetch('/event_sessions/{id}', 'delete', metadata);
-    }
-    /**
-     * Lists events accessible within the given scope. Each event in the response includes
-     * `primary_event_id` and `is_co_hosted_mirror`. For co-hosted events that appear across
-     * multiple organizations, `primary_event_id` always resolves to the original event ID,
-     * allowing you to identify that two events from different scopes represent the same real
-     * world event. Each event session also includes `primary_session_id` for the same purpose.
-     * Events with an event page also include `image_url` and `description` fields.
-     *
-     * @summary Lists events
-     */
-    getEvents(metadata) {
-        return this.core.fetch('/events', 'get', metadata);
-    }
-    /**
-     * Creates an event with its first event session. The event session inherits the title from
-     * the event unless session_title is provided.
-     *
-     * @summary Creates an event
-     */
-    postEvents(body) {
-        return this.core.fetch('/events', 'post', body);
-    }
-    /**
-     * Returns a single event. The response includes `primary_event_id` (always resolves to the
-     * original event ID, even for co-hosted mirrors) and `is_co_hosted_mirror` (true if this
-     * event is a mirror copy from a co-host relationship). Event sessions include
-     * `primary_session_id` for the same purpose. If the event has an event page, the response
-     * also includes `image_url` (the event page image) and `description` (plain text content
-     * from the event page). Both fields are null when no event page exists.
-     *
-     * @summary Shows a single event
-     */
-    getEventsId(metadata) {
-        return this.core.fetch('/events/{id}', 'get', metadata);
-    }
-    /**
-     * Generates a field survey URL
-     *
-     */
-    postField_survey_urls(body) {
-        return this.core.fetch('/field_survey_urls', 'post', body);
-    }
-    /**
-     * Lists organizations
-     *
-     */
-    getOrganizations(metadata) {
-        return this.core.fetch('/organizations', 'get', metadata);
-    }
-    /**
-     * Shows a single organization
-     *
-     */
-    getOrganizationsId(metadata) {
-        return this.core.fetch('/organizations/{id}', 'get', metadata);
-    }
-    /**
-     * Lists pages
-     *
-     */
-    getPages(metadata) {
-        return this.core.fetch('/pages', 'get', metadata);
-    }
-    /**
-     * Shows a single page
-     *
-     */
-    getPagesId(metadata) {
-        return this.core.fetch('/pages/{id}', 'get', metadata);
-    }
-    /**
-     * Lists phonebanks
-     *
-     */
-    getPhonebanks(metadata) {
-        return this.core.fetch('/phonebanks', 'get', metadata);
-    }
-    /**
-     * Shows a single phonebank
-     *
-     */
-    getPhonebanksId(metadata) {
-        return this.core.fetch('/phonebanks/{id}', 'get', metadata);
-    }
-    /**
-     * Lists scheduled calls
-     *
-     */
-    getScheduled_calls(metadata) {
-        return this.core.fetch('/scheduled_calls', 'get', metadata);
-    }
-    /**
-     * Shows a single scheduled call
-     *
-     */
-    getScheduled_callsId(metadata) {
-        return this.core.fetch('/scheduled_calls/{id}', 'get', metadata);
-    }
-    /**
-     * Lists scheduled tasks
-     *
-     */
-    getScheduled_tasks(metadata) {
-        return this.core.fetch('/scheduled_tasks', 'get', metadata);
-    }
-    /**
-     * Creates an scheduled task with the specified details.
-     *
-     * @summary Creates an scheduled task
-     */
-    postScheduled_tasks(body) {
-        return this.core.fetch('/scheduled_tasks', 'post', body);
-    }
-    /**
-     * Shows a single scheduled task
-     *
-     */
-    getScheduled_tasksId(metadata) {
-        return this.core.fetch('/scheduled_tasks/{id}', 'get', metadata);
-    }
-    /**
-     * Updates an scheduled task with the specified details.
-     *
-     * @summary Updates an scheduled task
-     */
-    putScheduled_tasksId(body, metadata) {
-        return this.core.fetch('/scheduled_tasks/{id}', 'put', body, metadata);
-    }
-    /**
-     * Deletes an scheduled task with the specified ID.
-     *
-     * @summary Deletes an scheduled task
-     */
-    deleteScheduled_tasksId(metadata) {
-        return this.core.fetch('/scheduled_tasks/{id}', 'delete', metadata);
-    }
-    /**
-     * Lists task agents
-     *
-     */
-    getTask_agents(metadata) {
-        return this.core.fetch('/task_agents', 'get', metadata);
-    }
-    /**
-     * Creates an task agent with the specified details.
-     *
-     * @summary Creates an task agent
-     */
-    postTask_agents(body) {
-        return this.core.fetch('/task_agents', 'post', body);
-    }
-    /**
-     * Shows a single task agent
-     *
-     */
-    getTask_agentsId(metadata) {
-        return this.core.fetch('/task_agents/{id}', 'get', metadata);
-    }
-    /**
-     * Deletes an task agent with the specified ID.
-     *
-     * @summary Deletes an task agent
-     */
-    deleteTask_agentsId(metadata) {
-        return this.core.fetch('/task_agents/{id}', 'delete', metadata);
-    }
-    /**
-     * Lists task assignments
-     *
-     */
-    getTask_assignments(metadata) {
-        return this.core.fetch('/task_assignments', 'get', metadata);
-    }
-    /**
-     * Creates a task assignment, assigning a user to participate in a phonebank or textbank
-     * campaign.
-     *
-     * @summary Creates a task assignment
-     */
-    postTask_assignments(body) {
-        return this.core.fetch('/task_assignments', 'post', body);
-    }
-    /**
-     * Shows a single task assignment
-     *
-     */
-    getTask_assignmentsId(metadata) {
-        return this.core.fetch('/task_assignments/{id}', 'get', metadata);
-    }
-    /**
-     * Updates an task assignment with the specified details.
-     *
-     * @summary Updates an task assignment
-     */
-    putTask_assignmentsId(body, metadata) {
-        return this.core.fetch('/task_assignments/{id}', 'put', body, metadata);
-    }
-    /**
-     * Deletes an task assignment with the specified ID.
-     *
-     * @summary Deletes an task assignment
-     */
-    deleteTask_assignmentsId(metadata) {
-        return this.core.fetch('/task_assignments/{id}', 'delete', metadata);
-    }
-    /**
-     * Lists team members
-     *
-     */
-    getTeam_members(metadata) {
-        return this.core.fetch('/team_members', 'get', metadata);
-    }
-    /**
-     * Creates a new team member
-     *
-     */
-    postTeam_members(body) {
-        return this.core.fetch('/team_members', 'post', body);
-    }
-    /**
-     * Updates a team member
-     *
-     */
-    putTeam_membersId(body, metadata) {
-        return this.core.fetch('/team_members/{id}', 'put', body, metadata);
-    }
-    /**
-     * Lists text blasts
-     *
-     */
-    getText_blasts(metadata) {
-        return this.core.fetch('/text_blasts', 'get', metadata);
-    }
-    /**
-     * Shows a single text blast
-     *
-     */
-    getText_blastsId(metadata) {
-        return this.core.fetch('/text_blasts/{id}', 'get', metadata);
-    }
-    /**
-     * Lists text templates
-     *
-     */
-    getText_templates(metadata) {
-        return this.core.fetch('/text_templates', 'get', metadata);
-    }
-    /**
-     * Creates an text template with the specified details.
-     *
-     * @summary Creates an text template
-     */
-    postText_templates(body) {
-        return this.core.fetch('/text_templates', 'post', body);
-    }
-    /**
-     * Shows a single text template
-     *
-     */
-    getText_templatesId(metadata) {
-        return this.core.fetch('/text_templates/{id}', 'get', metadata);
-    }
-    /**
-     * Updates an text template with the specified details.
-     *
-     * @summary Updates an text template
-     */
-    putText_templatesId(body, metadata) {
-        return this.core.fetch('/text_templates/{id}', 'put', body, metadata);
-    }
-    /**
-     * Deletes an text template with the specified ID.
-     *
-     * @summary Deletes an text template
-     */
-    deleteText_templatesId(metadata) {
-        return this.core.fetch('/text_templates/{id}', 'delete', metadata);
-    }
-    /**
-     * Lists textbanks
-     *
-     */
-    getTextbanks(metadata) {
-        return this.core.fetch('/textbanks', 'get', metadata);
-    }
-    /**
-     * Shows a single textbank
-     *
-     */
-    getTextbanksId(metadata) {
-        return this.core.fetch('/textbanks/{id}', 'get', metadata);
-    }
-    /**
-     * Sends a text message
-     *
-     */
-    postTexts(metadata) {
-        return this.core.fetch('/texts', 'post', metadata);
-    }
-    /**
-     * Retrieves a list of texts
-     *
-     */
-    getTexts(metadata) {
-        return this.core.fetch('/texts', 'get', metadata);
-    }
-    /**
-     * Lists user actions (form submissions). Can be filtered by user_id, page_id, or both. To
-     * get custom form responses for event RSVPs, first get the event's event_page_id from GET
-     * /events/{id}, then query this endpoint with that page_id. Match to RSVPs by user_id.
-     *
-     * @summary Retrieves user actions
-     */
-    getUser_actions(metadata) {
-        return this.core.fetch('/user_actions', 'get', metadata);
-    }
-    /**
-     * Creates a user action for a user. Note: This endpoint cannot be used for creating
-     * actions related to donation pages or scheduled call pages.
-     *
-     * @summary Creates a user action
-     */
-    postUser_actions(body) {
-        return this.core.fetch('/user_actions', 'post', body);
-    }
-    /**
-     * Lists user lists
-     *
-     */
-    getUser_lists(metadata) {
-        return this.core.fetch('/user_lists', 'get', metadata);
-    }
-    /**
-     * Creates a User List with the specified details. The parameters field must conform to the
-     * QueryBuilder format.
-     *
-     * @summary Creates a user list
-     */
-    postUser_lists(body) {
-        return this.core.fetch('/user_lists', 'post', body);
-    }
-    /**
-     * Shows a single user list
-     *
-     */
-    getUser_listsId(metadata) {
-        return this.core.fetch('/user_lists/{id}', 'get', metadata);
-    }
-    /**
-     * Updates a user list with the specified details.
-     *
-     * @summary Updates a user list
-     */
-    putUser_listsId(body, metadata) {
-        return this.core.fetch('/user_lists/{id}', 'put', body, metadata);
-    }
-    /**
-     * Deletes a user list with the specified ID.
-     *
-     * @summary Deletes a user list
-     */
-    deleteUser_listsId(metadata) {
-        return this.core.fetch('/user_lists/{id}', 'delete', metadata);
-    }
-    /**
-     * Creates a user note
-     *
-     */
-    postUser_notes(metadata) {
-        return this.core.fetch('/user_notes', 'post', metadata);
-    }
-    /**
-     * Deletes a user note with the specified ID.
-     *
-     * @summary Deletes a user note
-     */
-    deleteUser_notesId(metadata) {
-        return this.core.fetch('/user_notes/{id}', 'delete', metadata);
-    }
-    /**
-     * Lists available relationship types
-     *
-     */
-    getUser_relationships(metadata) {
-        return this.core.fetch('/user_relationships', 'get', metadata);
-    }
-    /**
-     * Creates a user relationship
-     *
-     */
-    postUser_relationships(metadata) {
-        return this.core.fetch('/user_relationships', 'post', metadata);
-    }
-    /**
-     * Deletes a user relationship
-     *
-     */
-    deleteUser_relationshipsId(metadata) {
-        return this.core.fetch('/user_relationships/{id}', 'delete', metadata);
-    }
-    /**
-     * Creates or updates a user
-     *
-     */
-    postUsers(body) {
-        return this.core.fetch('/users', 'post', body);
-    }
-    /**
-     * Retrieves a list of users
-     *
-     */
-    getUsers(metadata) {
-        return this.core.fetch('/users', 'get', metadata);
-    }
-    /**
-     * Merge duplicate users
-     *
-     */
-    postUsersMerge(body) {
-        return this.core.fetch('/users/merge', 'post', body);
-    }
-    /**
-     * Shows a single user
-     *
-     */
-    getUsersId(metadata) {
-        return this.core.fetch('/users/{id}', 'get', metadata);
-    }
-    /**
-     * Updates a user
-     *
-     */
-    putUsersId(body, metadata) {
-        return this.core.fetch('/users/{id}', 'put', body, metadata);
-    }
-}
-const createSDK = (() => { return new SDK(); })();
-exports.default = createSDK;