@a1liu/solidarity-tech-api 0.1.5 → 0.1.7

package/dist/endpoints.js

@@ -0,0 +1,369 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.listActivities = listActivities;
+exports.listAgentAssignments = listAgentAssignments;
+exports.createAgentAssignment = createAgentAssignment;
+exports.getAgentAssignment = getAgentAssignment;
+exports.updateAgentAssignment = updateAgentAssignment;
+exports.deleteAgentAssignment = deleteAgentAssignment;
+exports.listCalls = listCalls;
+exports.listChapterPhoneNumbers = listChapterPhoneNumbers;
+exports.listChapters = listChapters;
+exports.listCustomUserProperties = listCustomUserProperties;
+exports.listEmailBlasts = listEmailBlasts;
+exports.getEmailBlast = getEmailBlast;
+exports.listEventAttendances = listEventAttendances;
+exports.createEventAttendance = createEventAttendance;
+exports.listEventRsvps = listEventRsvps;
+exports.createEventRsvp = createEventRsvp;
+exports.getEventRsvp = getEventRsvp;
+exports.updateEventRsvp = updateEventRsvp;
+exports.deleteEventRsvp = deleteEventRsvp;
+exports.listEventSessions = listEventSessions;
+exports.createEventSession = createEventSession;
+exports.getEventSession = getEventSession;
+exports.updateEventSession = updateEventSession;
+exports.deleteEventSession = deleteEventSession;
+exports.listEvents = listEvents;
+exports.getEvent = getEvent;
+exports.listOrganizations = listOrganizations;
+exports.getOrganization = getOrganization;
+exports.listPages = listPages;
+exports.getPage = getPage;
+exports.listPhonebanks = listPhonebanks;
+exports.getPhonebank = getPhonebank;
+exports.listScheduledCalls = listScheduledCalls;
+exports.getScheduledCall = getScheduledCall;
+exports.listScheduledTasks = listScheduledTasks;
+exports.createScheduledTask = createScheduledTask;
+exports.getScheduledTask = getScheduledTask;
+exports.updateScheduledTask = updateScheduledTask;
+exports.deleteScheduledTask = deleteScheduledTask;
+exports.listTaskAgents = listTaskAgents;
+exports.createTaskAgent = createTaskAgent;
+exports.getTaskAgent = getTaskAgent;
+exports.deleteTaskAgent = deleteTaskAgent;
+exports.listTaskAssignments = listTaskAssignments;
+exports.createTaskAssignment = createTaskAssignment;
+exports.getTaskAssignment = getTaskAssignment;
+exports.updateTaskAssignment = updateTaskAssignment;
+exports.deleteTaskAssignment = deleteTaskAssignment;
+exports.listTeamMembers = listTeamMembers;
+exports.listTextBlasts = listTextBlasts;
+exports.getTextBlast = getTextBlast;
+exports.listTextTemplates = listTextTemplates;
+exports.createTextTemplate = createTextTemplate;
+exports.getTextTemplate = getTextTemplate;
+exports.updateTextTemplate = updateTextTemplate;
+exports.deleteTextTemplate = deleteTextTemplate;
+exports.listTextbanks = listTextbanks;
+exports.getTextbank = getTextbank;
+exports.sendText = sendText;
+exports.listTexts = listTexts;
+exports.createUserAction = createUserAction;
+exports.listUserLists = listUserLists;
+exports.getUserList = getUserList;
+exports.createUserNote = createUserNote;
+exports.createUser = createUser;
+exports.listUsers = listUsers;
+exports.updateUser = updateUser;
+const client_1 = require("./client");
+const schemas_1 = require("./schemas");
+/** GET /activities — Retrieves all activities. */
+function listActivities(config, params = {}) {
+    return (0, client_1.apiGet)(config, "/activities", { query: Object.assign({}, params), schema: schemas_1.activitiesResponse });
+}
+/** GET /agent_assignments — Lists agent assignments. */
+function listAgentAssignments(config, params = {}) {
+    return (0, client_1.apiGet)(config, "/agent_assignments", { query: Object.assign({}, params) });
+}
+/** POST /agent_assignments — Creates an agent assignment. */
+function createAgentAssignment(config, body) {
+    return (0, client_1.apiPost)(config, "/agent_assignments", { body });
+}
+/** GET /agent_assignments/{id} — Shows a single agent assignment. */
+function getAgentAssignment(config, id) {
+    return (0, client_1.apiGet)(config, `/agent_assignments/${id}`);
+}
+/** PUT /agent_assignments/{id} — Updates an agent assignment. */
+function updateAgentAssignment(config, id, body) {
+    return (0, client_1.apiPut)(config, `/agent_assignments/${id}`, { body });
+}
+/** DELETE /agent_assignments/{id} — Deletes an agent assignment. */
+function deleteAgentAssignment(config, id) {
+    return (0, client_1.apiDelete)(config, `/agent_assignments/${id}`);
+}
+/** GET /calls — Retrieves all calls. */
+function listCalls(config, params = {}) {
+    return (0, client_1.apiGet)(config, "/calls", { query: Object.assign({}, params), schema: schemas_1.callsResponse });
+}
+/** GET /chapter_phone_numbers — Lists chapter phone numbers. */
+function listChapterPhoneNumbers(config, params = {}) {
+    return (0, client_1.apiGet)(config, "/chapter_phone_numbers", { query: Object.assign({}, params) });
+}
+/* ------------------------------------------------------------------ *
+ * Chapters
+ * ------------------------------------------------------------------ */
+/** GET /chapters — Retrieves all chapters. */
+function listChapters(config, params = {}) {
+    return (0, client_1.apiGet)(config, "/chapters", { query: Object.assign({}, params), schema: schemas_1.chaptersResponse });
+}
+/* ------------------------------------------------------------------ *
+ * Custom User Properties
+ * ------------------------------------------------------------------ */
+/** GET /custom_user_properties — Retrieves all custom user properties. */
+function listCustomUserProperties(config, params = {}) {
+    return (0, client_1.apiGet)(config, "/custom_user_properties", {
+        query: Object.assign({}, params),
+        schema: schemas_1.customUserPropertiesResponse,
+    });
+}
+/* ------------------------------------------------------------------ *
+ * Email Blasts
+ * ------------------------------------------------------------------ */
+/** GET /email_blasts — Lists email blasts. */
+function listEmailBlasts(config, params = {}) {
+    return (0, client_1.apiGet)(config, "/email_blasts", { query: Object.assign({}, params) });
+}
+/** GET /email_blasts/{id} — Shows a single email blast. */
+function getEmailBlast(config, id) {
+    return (0, client_1.apiGet)(config, `/email_blasts/${id}`);
+}
+/** GET /event_attendances — Lists event attendances. */
+function listEventAttendances(config, params = {}) {
+    return (0, client_1.apiGet)(config, "/event_attendances", { query: Object.assign({}, params) });
+}
+/** POST /event_attendances — Creates an event attendance. */
+function createEventAttendance(config, body) {
+    return (0, client_1.apiPost)(config, "/event_attendances", { body });
+}
+/** GET /event_rsvps — Lists event rsvps. */
+function listEventRsvps(config, params = {}) {
+    return (0, client_1.apiGet)(config, "/event_rsvps", { query: Object.assign({}, params) });
+}
+/** POST /event_rsvps — Creates an event rsvp. */
+function createEventRsvp(config, body) {
+    return (0, client_1.apiPost)(config, "/event_rsvps", { body });
+}
+/** GET /event_rsvps/{id} — Shows a single event rsvp. */
+function getEventRsvp(config, id) {
+    return (0, client_1.apiGet)(config, `/event_rsvps/${id}`);
+}
+/** PUT /event_rsvps/{id} — Updates an event rsvp. */
+function updateEventRsvp(config, id, body) {
+    return (0, client_1.apiPut)(config, `/event_rsvps/${id}`, { body });
+}
+/** DELETE /event_rsvps/{id} — Deletes an event rsvp. */
+function deleteEventRsvp(config, id) {
+    return (0, client_1.apiDelete)(config, `/event_rsvps/${id}`);
+}
+/** GET /event_sessions — Lists event sessions. */
+function listEventSessions(config, params = {}) {
+    return (0, client_1.apiGet)(config, "/event_sessions", { query: Object.assign({}, params) });
+}
+/** POST /event_sessions — Creates an event session. */
+function createEventSession(config, body) {
+    return (0, client_1.apiPost)(config, "/event_sessions", { body });
+}
+/** GET /event_sessions/{id} — Shows a single event session. */
+function getEventSession(config, id) {
+    return (0, client_1.apiGet)(config, `/event_sessions/${id}`);
+}
+/** PUT /event_sessions/{id} — Updates an event session. */
+function updateEventSession(config, id, body) {
+    return (0, client_1.apiPut)(config, `/event_sessions/${id}`, { body });
+}
+/** DELETE /event_sessions/{id} — Deletes an event session. */
+function deleteEventSession(config, id) {
+    return (0, client_1.apiDelete)(config, `/event_sessions/${id}`);
+}
+/* ------------------------------------------------------------------ *
+ * Events
+ * ------------------------------------------------------------------ */
+/** GET /events — Lists events. */
+function listEvents(config, params = {}) {
+    return (0, client_1.apiGet)(config, "/events", { query: Object.assign({}, params) });
+}
+/** GET /events/{id} — Shows a single event. */
+function getEvent(config, id) {
+    return (0, client_1.apiGet)(config, `/events/${id}`);
+}
+/* ------------------------------------------------------------------ *
+ * Organizations
+ * ------------------------------------------------------------------ */
+/** GET /organizations — Lists organizations. */
+function listOrganizations(config, params = {}) {
+    return (0, client_1.apiGet)(config, "/organizations", { query: Object.assign({}, params) });
+}
+/** GET /organizations/{id} — Shows a single organization. */
+function getOrganization(config, id) {
+    return (0, client_1.apiGet)(config, `/organizations/${id}`);
+}
+/* ------------------------------------------------------------------ *
+ * Pages
+ * ------------------------------------------------------------------ */
+/** GET /pages — Lists pages. */
+function listPages(config, params = {}) {
+    return (0, client_1.apiGet)(config, "/pages", { query: Object.assign({}, params) });
+}
+/** GET /pages/{id} — Shows a single page. */
+function getPage(config, id) {
+    return (0, client_1.apiGet)(config, `/pages/${id}`);
+}
+/** GET /phonebanks — Lists phonebanks. */
+function listPhonebanks(config, params = {}) {
+    return (0, client_1.apiGet)(config, "/phonebanks", { query: Object.assign({}, params) });
+}
+/** GET /phonebanks/{id} — Shows a single phonebank. */
+function getPhonebank(config, id) {
+    return (0, client_1.apiGet)(config, `/phonebanks/${id}`);
+}
+/** GET /scheduled_calls — Lists scheduled calls. */
+function listScheduledCalls(config, params = {}) {
+    return (0, client_1.apiGet)(config, "/scheduled_calls", { query: Object.assign({}, params) });
+}
+/** GET /scheduled_calls/{id} — Shows a single scheduled call. */
+function getScheduledCall(config, id) {
+    return (0, client_1.apiGet)(config, `/scheduled_calls/${id}`);
+}
+/** GET /scheduled_tasks — Lists scheduled tasks. */
+function listScheduledTasks(config, params = {}) {
+    return (0, client_1.apiGet)(config, "/scheduled_tasks", { query: Object.assign({}, params) });
+}
+/** POST /scheduled_tasks — Creates a scheduled task. */
+function createScheduledTask(config, body) {
+    return (0, client_1.apiPost)(config, "/scheduled_tasks", { body });
+}
+/** GET /scheduled_tasks/{id} — Shows a single scheduled task. */
+function getScheduledTask(config, id) {
+    return (0, client_1.apiGet)(config, `/scheduled_tasks/${id}`);
+}
+/** PUT /scheduled_tasks/{id} — Updates a scheduled task. */
+function updateScheduledTask(config, id, body) {
+    return (0, client_1.apiPut)(config, `/scheduled_tasks/${id}`, { body });
+}
+/** DELETE /scheduled_tasks/{id} — Deletes a scheduled task. */
+function deleteScheduledTask(config, id) {
+    return (0, client_1.apiDelete)(config, `/scheduled_tasks/${id}`);
+}
+/** GET /task_agents — Lists task agents. */
+function listTaskAgents(config, params = {}) {
+    return (0, client_1.apiGet)(config, "/task_agents", { query: Object.assign({}, params) });
+}
+/** POST /task_agents — Creates a task agent. */
+function createTaskAgent(config, body) {
+    return (0, client_1.apiPost)(config, "/task_agents", { body });
+}
+/** GET /task_agents/{id} — Shows a single task agent. */
+function getTaskAgent(config, id) {
+    return (0, client_1.apiGet)(config, `/task_agents/${id}`);
+}
+/** DELETE /task_agents/{id} — Deletes a task agent. */
+function deleteTaskAgent(config, id) {
+    return (0, client_1.apiDelete)(config, `/task_agents/${id}`);
+}
+/** GET /task_assignments — Lists task assignments. */
+function listTaskAssignments(config, params = {}) {
+    return (0, client_1.apiGet)(config, "/task_assignments", { query: Object.assign({}, params) });
+}
+/** POST /task_assignments — Creates a task assignment. */
+function createTaskAssignment(config, body) {
+    return (0, client_1.apiPost)(config, "/task_assignments", { body });
+}
+/** GET /task_assignments/{id} — Shows a single task assignment. */
+function getTaskAssignment(config, id) {
+    return (0, client_1.apiGet)(config, `/task_assignments/${id}`);
+}
+/** PUT /task_assignments/{id} — Updates a task assignment. */
+function updateTaskAssignment(config, id, body) {
+    return (0, client_1.apiPut)(config, `/task_assignments/${id}`, { body });
+}
+/** DELETE /task_assignments/{id} — Deletes a task assignment. */
+function deleteTaskAssignment(config, id) {
+    return (0, client_1.apiDelete)(config, `/task_assignments/${id}`);
+}
+/* ------------------------------------------------------------------ *
+ * Team Members
+ * ------------------------------------------------------------------ */
+/** GET /team_members — Lists team members. */
+function listTeamMembers(config, params = {}) {
+    return (0, client_1.apiGet)(config, "/team_members", { query: Object.assign({}, params) });
+}
+/* ------------------------------------------------------------------ *
+ * Text Blasts
+ * ------------------------------------------------------------------ */
+/** GET /text_blasts — Lists text blasts. */
+function listTextBlasts(config, params = {}) {
+    return (0, client_1.apiGet)(config, "/text_blasts", { query: Object.assign({}, params) });
+}
+/** GET /text_blasts/{id} — Shows a single text blast. */
+function getTextBlast(config, id) {
+    return (0, client_1.apiGet)(config, `/text_blasts/${id}`);
+}
+/** GET /text_templates — Lists text templates. */
+function listTextTemplates(config, params = {}) {
+    return (0, client_1.apiGet)(config, "/text_templates", { query: Object.assign({}, params) });
+}
+/** POST /text_templates — Creates a text template. */
+function createTextTemplate(config, body) {
+    return (0, client_1.apiPost)(config, "/text_templates", { body });
+}
+/** GET /text_templates/{id} — Shows a single text template. */
+function getTextTemplate(config, id) {
+    return (0, client_1.apiGet)(config, `/text_templates/${id}`);
+}
+/** PUT /text_templates/{id} — Updates a text template. */
+function updateTextTemplate(config, id, body) {
+    return (0, client_1.apiPut)(config, `/text_templates/${id}`, { body });
+}
+/** DELETE /text_templates/{id} — Deletes a text template. */
+function deleteTextTemplate(config, id) {
+    return (0, client_1.apiDelete)(config, `/text_templates/${id}`);
+}
+/** GET /textbanks — Lists textbanks. */
+function listTextbanks(config, params = {}) {
+    return (0, client_1.apiGet)(config, "/textbanks", { query: Object.assign({}, params) });
+}
+/** GET /textbanks/{id} — Shows a single textbank. */
+function getTextbank(config, id) {
+    return (0, client_1.apiGet)(config, `/textbanks/${id}`);
+}
+/** POST /texts — Sends a text message. Parameters are passed as query string. */
+function sendText(config, params) {
+    return (0, client_1.apiPost)(config, "/texts", { query: Object.assign({}, params) });
+}
+/** GET /texts — Retrieves a list of texts. */
+function listTexts(config, params = {}) {
+    return (0, client_1.apiGet)(config, "/texts", { query: Object.assign({}, params), schema: schemas_1.textsResponse });
+}
+/** POST /user_actions — Creates a user action. */
+function createUserAction(config, body) {
+    return (0, client_1.apiPost)(config, "/user_actions", { body });
+}
+/* ------------------------------------------------------------------ *
+ * User Lists
+ * ------------------------------------------------------------------ */
+/** GET /user_lists — Lists user lists. */
+function listUserLists(config, params = {}) {
+    return (0, client_1.apiGet)(config, "/user_lists", { query: Object.assign({}, params) });
+}
+/** GET /user_lists/{id} — Shows a single user list. */
+function getUserList(config, id) {
+    return (0, client_1.apiGet)(config, `/user_lists/${id}`);
+}
+/** POST /user_notes — Creates a user note. Parameters are passed as query string. */
+function createUserNote(config, params) {
+    return (0, client_1.apiPost)(config, "/user_notes", { query: Object.assign({}, params) });
+}
+/** POST /users — Creates or updates a user. */
+function createUser(config, body) {
+    return (0, client_1.apiPost)(config, "/users", { body });
+}
+/** GET /users — Retrieves a list of users. */
+function listUsers(config, params = {}) {
+    return (0, client_1.apiGet)(config, "/users", { query: Object.assign({}, params), schema: schemas_1.usersResponse });
+}
+/** PUT /users/{id} — Updates a user. */
+function updateUser(config, id, body) {
+    return (0, client_1.apiPut)(config, `/users/${id}`, { body });
+}

package/dist/index.d.ts

@@ -1,5 +1,21 @@
-import { default as createSDK } from "./.api/apis/solidarity-tech/index";
-export * from "./.api/apis/solidarity-tech/index";
-export { createSDK };
-export { createSDK as sdk };
-export default createSDK;
+import type { ClientConfig } from "./client";
+import * as endpoints from "./endpoints";
+export * from "./client";
+export * from "./schemas";
+export * from "./endpoints";
+type Bound<F> = F extends (config: ClientConfig, ...args: infer A) => infer R ? (...args: A) => R : never;
+/** All endpoint functions with their leading `ClientConfig` argument bound. */
+export type SolidarityClient = {
+    [K in keyof typeof endpoints]: Bound<(typeof endpoints)[K]>;
+};
+/**
+ * Binds a {@link ClientConfig} to every endpoint so they can be called without
+ * passing the config each time:
+ *
+ * ```ts
+ * const client = createClient({ apiKey: "..." });
+ * const res = await client.listUsers({ _limit: 50 });
+ * ```
+ */
+export declare function createClient(config: ClientConfig): SolidarityClient;
+export default createClient;

package/dist/index.js

@@ -10,16 +10,41 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
 }));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.sdk = exports.createSDK = void 0;
-const index_1 = __importDefault(require("./.api/apis/solidarity-tech/index"));
-Object.defineProperty(exports, "createSDK", { enumerable: true, get: function () { return index_1.default; } });
-Object.defineProperty(exports, "sdk", { enumerable: true, get: function () { return index_1.default; } });
-__exportStar(require("./.api/apis/solidarity-tech/index"), exports);
-exports.default = index_1.default;
+exports.createClient = createClient;
+const endpoints = __importStar(require("./endpoints"));
+__exportStar(require("./client"), exports);
+__exportStar(require("./schemas"), exports);
+__exportStar(require("./endpoints"), exports);
+/**
+ * Binds a {@link ClientConfig} to every endpoint so they can be called without
+ * passing the config each time:
+ *
+ * ```ts
+ * const client = createClient({ apiKey: "..." });
+ * const res = await client.listUsers({ _limit: 50 });
+ * ```
+ */
+function createClient(config) {
+    const bound = {};
+    for (const [name, fn] of Object.entries(endpoints)) {
+        bound[name] = (...args) => fn(config, ...args);
+    }
+    return bound;
+}
+exports.default = createClient;