@a1liu/solidarity-tech-api 0.1.5 → 0.1.7

package/dist/client.d.ts

@@ -0,0 +1,77 @@
+import { z } from "zod";
+import type { ZodType } from "zod";
+/** Default base URL, taken from the OpenAPI `servers` entry. */
+export declare const DEFAULT_BASE_URL = "https://api.solidarity.tech/v1";
+/** Configuration shared by every endpoint call. */
+export interface ClientConfig {
+    /** Bearer token used for the `Authorization` header. */
+    apiKey: string;
+    /** Override the API base URL. Defaults to {@link DEFAULT_BASE_URL}. */
+    baseUrl?: string;
+    /**
+     * Override the `fetch` implementation. Defaults to the global `fetch`,
+     * which is available in browsers, Node 18+, Bun, Deno and other runtimes.
+     */
+    fetch?: typeof fetch;
+}
+type QueryValue = string | number | boolean | null | undefined | Array<string | number>;
+/** Query string parameters. `undefined` and `null` values are omitted. */
+export type QueryParams = Record<string, QueryValue>;
+/** Result of a successful request whose body passed validation. */
+export interface ApiSuccess<T> {
+    ok: true;
+    status: number;
+    data: T;
+}
+/** A non-2xx response, a network failure, or a body that failed validation. */
+export interface ApiFailure {
+    ok: false;
+    status: number;
+    error: ApiError;
+    /** The raw parsed body, when one was received. */
+    data: unknown;
+}
+/**
+ * Every endpoint resolves to one of these instead of throwing, mirroring how
+ * `fetch` surfaces HTTP errors as ordinary return values.
+ */
+export type ApiResult<T> = ApiSuccess<T> | ApiFailure;
+export type ApiError = 
+/** The server replied with a non-2xx status. */
+{
+    type: "http";
+    status: number;
+    message: string;
+    body: unknown;
+}
+/** `fetch` rejected (DNS, connection, abort, etc.). */
+ | {
+    type: "network";
+    message: string;
+    cause: unknown;
+}
+/** The 2xx body did not match the expected zod schema. */
+ | {
+    type: "validation";
+    message: string;
+    issues: z.core.$ZodIssue[];
+    received: unknown;
+};
+interface GetOptions<T> {
+    query?: QueryParams;
+    schema?: ZodType<T>;
+}
+interface WriteOptions<T> {
+    query?: QueryParams;
+    body?: unknown;
+    schema?: ZodType<T>;
+}
+/** Shared GET helper. Omit `schema` to receive the raw body as `unknown`. */
+export declare function apiGet<T = unknown>(config: ClientConfig, path: string, options?: GetOptions<T>): Promise<ApiResult<T>>;
+/** Shared POST helper. Omit `schema` to receive the raw body as `unknown`. */
+export declare function apiPost<T = unknown>(config: ClientConfig, path: string, options?: WriteOptions<T>): Promise<ApiResult<T>>;
+/** Shared PUT helper. Omit `schema` to receive the raw body as `unknown`. */
+export declare function apiPut<T = unknown>(config: ClientConfig, path: string, options?: WriteOptions<T>): Promise<ApiResult<T>>;
+/** Shared DELETE helper. Omit `schema` to receive the raw body as `unknown`. */
+export declare function apiDelete<T = unknown>(config: ClientConfig, path: string, options?: WriteOptions<T>): Promise<ApiResult<T>>;
+export {};

package/dist/client.js

@@ -0,0 +1,145 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_BASE_URL = void 0;
+exports.apiGet = apiGet;
+exports.apiPost = apiPost;
+exports.apiPut = apiPut;
+exports.apiDelete = apiDelete;
+const zod_1 = require("zod");
+/** Default base URL, taken from the OpenAPI `servers` entry. */
+exports.DEFAULT_BASE_URL = "https://api.solidarity.tech/v1";
+function buildUrl(baseUrl, path, query) {
+    const url = new URL(baseUrl.replace(/\/$/, "") + path);
+    if (query) {
+        for (const [key, value] of Object.entries(query)) {
+            if (value === undefined || value === null)
+                continue;
+            if (Array.isArray(value)) {
+                for (const item of value)
+                    url.searchParams.append(key, String(item));
+            }
+            else {
+                url.searchParams.append(key, String(value));
+            }
+        }
+    }
+    return url.toString();
+}
+function parseBody(res) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const text = yield res.text();
+        try {
+            return JSON.parse(text);
+        }
+        catch (_a) {
+            return text;
+        }
+    });
+}
+function request(config, method, path, options) {
+    return __awaiter(this, void 0, void 0, function* () {
+        var _a, _b;
+        const fetchImpl = (_a = config.fetch) !== null && _a !== void 0 ? _a : fetch;
+        const url = buildUrl((_b = config.baseUrl) !== null && _b !== void 0 ? _b : exports.DEFAULT_BASE_URL, path, options.query);
+        const headers = {
+            Authorization: `Bearer ${config.apiKey}`,
+            Accept: "application/json",
+        };
+        const hasBody = options.body !== undefined;
+        if (hasBody)
+            headers["Content-Type"] = "application/json";
+        let res;
+        try {
+            res = yield fetchImpl(url, {
+                method,
+                headers,
+                body: hasBody ? JSON.stringify(options.body) : undefined,
+            });
+        }
+        catch (cause) {
+            return {
+                ok: false,
+                status: 0,
+                data: undefined,
+                error: {
+                    type: "network",
+                    message: cause instanceof Error ? cause.message : "Network request failed",
+                    cause,
+                },
+            };
+        }
+        const raw = yield parseBody(res);
+        if (!res.ok) {
+            return {
+                ok: false,
+                status: res.status,
+                data: raw,
+                error: {
+                    type: "http",
+                    status: res.status,
+                    message: res.statusText || `Request failed with status ${res.status}`,
+                    body: raw,
+                },
+            };
+        }
+        const parsed = options.schema.safeParse(raw);
+        if (!parsed.success) {
+            return {
+                ok: false,
+                status: res.status,
+                data: raw,
+                error: {
+                    type: "validation",
+                    message: "Response body did not match the expected schema",
+                    issues: parsed.error.issues,
+                    received: raw,
+                },
+            };
+        }
+        return { ok: true, status: res.status, data: parsed.data };
+    });
+}
+/** Shared GET helper. Omit `schema` to receive the raw body as `unknown`. */
+function apiGet(config, path, options = {}) {
+    var _a;
+    return request(config, "GET", path, {
+        query: options.query,
+        schema: (_a = options.schema) !== null && _a !== void 0 ? _a : zod_1.z.unknown(),
+    });
+}
+/** Shared POST helper. Omit `schema` to receive the raw body as `unknown`. */
+function apiPost(config, path, options = {}) {
+    var _a;
+    return request(config, "POST", path, {
+        query: options.query,
+        body: options.body,
+        schema: (_a = options.schema) !== null && _a !== void 0 ? _a : zod_1.z.unknown(),
+    });
+}
+/** Shared PUT helper. Omit `schema` to receive the raw body as `unknown`. */
+function apiPut(config, path, options = {}) {
+    var _a;
+    return request(config, "PUT", path, {
+        query: options.query,
+        body: options.body,
+        schema: (_a = options.schema) !== null && _a !== void 0 ? _a : zod_1.z.unknown(),
+    });
+}
+/** Shared DELETE helper. Omit `schema` to receive the raw body as `unknown`. */
+function apiDelete(config, path, options = {}) {
+    var _a;
+    return request(config, "DELETE", path, {
+        query: options.query,
+        body: options.body,
+        schema: (_a = options.schema) !== null && _a !== void 0 ? _a : zod_1.z.unknown(),
+    });
+}

package/dist/endpoints.d.ts

@@ -0,0 +1,377 @@
+import type { ApiResult, ClientConfig } from "./client";
+import type { ActivitiesResponse, CallsResponse, ChaptersResponse, CustomUserPropertiesResponse, TextsResponse, UsersResponse } from "./schemas";
+/** Pagination/`_since` parameters common to every list endpoint. */
+export interface ListParams {
+    _limit?: number;
+    _offset?: number;
+    _since?: number;
+}
+export type ScopeType = "Organization" | "Chapter";
+export interface Address {
+    address1?: string | null;
+    address2?: string | null;
+    city?: string | null;
+    state?: string | null;
+    zip_code?: string | null;
+    country?: string | null;
+}
+export interface EventLocationData {
+    components?: string | null;
+    coordinates?: string | null;
+    address_city?: string | null;
+    full_address?: string | null;
+    address_state?: string | null;
+    address_line_1?: string | null;
+    address_country?: string | null;
+    address_postal_code?: string | null;
+}
+export interface ListActivitiesParams extends ListParams {
+    user_id?: number;
+}
+/** GET /activities — Retrieves all activities. */
+export declare function listActivities(config: ClientConfig, params?: ListActivitiesParams): Promise<ApiResult<ActivitiesResponse>>;
+export interface ListAgentAssignmentsParams extends ListParams {
+    user_id?: number;
+    agent_user_id?: number;
+}
+export interface AgentAssignmentCreate {
+    user_id: number;
+    agent_user_id: number | null;
+    is_active?: boolean | null;
+}
+export interface AgentAssignmentUpdate {
+    user_id?: number;
+    agent_user_id?: number | null;
+    is_active?: boolean | null;
+}
+/** GET /agent_assignments — Lists agent assignments. */
+export declare function listAgentAssignments(config: ClientConfig, params?: ListAgentAssignmentsParams): Promise<ApiResult<unknown>>;
+/** POST /agent_assignments — Creates an agent assignment. */
+export declare function createAgentAssignment(config: ClientConfig, body: AgentAssignmentCreate): Promise<ApiResult<unknown>>;
+/** GET /agent_assignments/{id} — Shows a single agent assignment. */
+export declare function getAgentAssignment(config: ClientConfig, id: number): Promise<ApiResult<unknown>>;
+/** PUT /agent_assignments/{id} — Updates an agent assignment. */
+export declare function updateAgentAssignment(config: ClientConfig, id: number, body: AgentAssignmentUpdate): Promise<ApiResult<unknown>>;
+/** DELETE /agent_assignments/{id} — Deletes an agent assignment. */
+export declare function deleteAgentAssignment(config: ClientConfig, id: number): Promise<ApiResult<unknown>>;
+export interface ListCallsParams extends ListParams {
+    user_id?: number;
+}
+/** GET /calls — Retrieves all calls. */
+export declare function listCalls(config: ClientConfig, params?: ListCallsParams): Promise<ApiResult<CallsResponse>>;
+export interface ListChapterPhoneNumbersParams extends ListParams {
+    chapter_id?: number;
+}
+/** GET /chapter_phone_numbers — Lists chapter phone numbers. */
+export declare function listChapterPhoneNumbers(config: ClientConfig, params?: ListChapterPhoneNumbersParams): Promise<ApiResult<unknown>>;
+/** GET /chapters — Retrieves all chapters. */
+export declare function listChapters(config: ClientConfig, params?: ListParams): Promise<ApiResult<ChaptersResponse>>;
+/** GET /custom_user_properties — Retrieves all custom user properties. */
+export declare function listCustomUserProperties(config: ClientConfig, params?: ListParams): Promise<ApiResult<CustomUserPropertiesResponse>>;
+/** GET /email_blasts — Lists email blasts. */
+export declare function listEmailBlasts(config: ClientConfig, params?: ListParams): Promise<ApiResult<unknown>>;
+/** GET /email_blasts/{id} — Shows a single email blast. */
+export declare function getEmailBlast(config: ClientConfig, id: number): Promise<ApiResult<unknown>>;
+export interface ListEventAttendancesParams extends ListParams {
+    event_id?: number;
+}
+export interface EventAttendanceCreate {
+    event_id: number;
+    event_session_id: number;
+    user_id: number;
+    attended: boolean;
+}
+/** GET /event_attendances — Lists event attendances. */
+export declare function listEventAttendances(config: ClientConfig, params?: ListEventAttendancesParams): Promise<ApiResult<unknown>>;
+/** POST /event_attendances — Creates an event attendance. */
+export declare function createEventAttendance(config: ClientConfig, body: EventAttendanceCreate): Promise<ApiResult<unknown>>;
+export interface ListEventRsvpsParams extends ListParams {
+    event_id?: number;
+}
+export interface EventRsvpCreate {
+    event_id: number;
+    event_session_id: number;
+    user_id?: number;
+    is_attending: "yes" | "no" | "maybe";
+    is_confirmed?: boolean;
+    agent_user_id: number | null;
+    source?: string | null;
+    source_system?: string | null;
+}
+export interface EventRsvpUpdate {
+    is_attending?: "yes" | "no" | "maybe";
+    is_confirmed?: boolean;
+    agent_user_id?: number | null;
+    source?: string | null;
+    source_system?: string | null;
+}
+/** GET /event_rsvps — Lists event rsvps. */
+export declare function listEventRsvps(config: ClientConfig, params?: ListEventRsvpsParams): Promise<ApiResult<unknown>>;
+/** POST /event_rsvps — Creates an event rsvp. */
+export declare function createEventRsvp(config: ClientConfig, body: EventRsvpCreate): Promise<ApiResult<unknown>>;
+/** GET /event_rsvps/{id} — Shows a single event rsvp. */
+export declare function getEventRsvp(config: ClientConfig, id: number): Promise<ApiResult<unknown>>;
+/** PUT /event_rsvps/{id} — Updates an event rsvp. */
+export declare function updateEventRsvp(config: ClientConfig, id: number, body: EventRsvpUpdate): Promise<ApiResult<unknown>>;
+/** DELETE /event_rsvps/{id} — Deletes an event rsvp. */
+export declare function deleteEventRsvp(config: ClientConfig, id: number): Promise<ApiResult<unknown>>;
+export interface ListEventSessionsParams extends ListParams {
+    event_id?: number;
+}
+export interface EventSessionCreate {
+    event_id: number;
+    start_time: number | null;
+    end_time: number | null;
+    title?: string | null;
+    location_name?: string | null;
+    location_data?: EventLocationData;
+    location_address?: string | null;
+    show_rsvp_bar?: boolean | null;
+    show_title_in_form?: boolean | null;
+}
+export interface EventSessionUpdate {
+    start_time?: number | null;
+    end_time?: number | null;
+    title?: string | null;
+    location_name?: string | null;
+    location_address?: string | null;
+    show_rsvp_bar?: boolean | null;
+    show_title_in_form?: boolean | null;
+}
+/** GET /event_sessions — Lists event sessions. */
+export declare function listEventSessions(config: ClientConfig, params?: ListEventSessionsParams): Promise<ApiResult<unknown>>;
+/** POST /event_sessions — Creates an event session. */
+export declare function createEventSession(config: ClientConfig, body: EventSessionCreate): Promise<ApiResult<unknown>>;
+/** GET /event_sessions/{id} — Shows a single event session. */
+export declare function getEventSession(config: ClientConfig, id: number): Promise<ApiResult<unknown>>;
+/** PUT /event_sessions/{id} — Updates an event session. */
+export declare function updateEventSession(config: ClientConfig, id: number, body: EventSessionUpdate): Promise<ApiResult<unknown>>;
+/** DELETE /event_sessions/{id} — Deletes an event session. */
+export declare function deleteEventSession(config: ClientConfig, id: number): Promise<ApiResult<unknown>>;
+/** GET /events — Lists events. */
+export declare function listEvents(config: ClientConfig, params?: ListParams): Promise<ApiResult<unknown>>;
+/** GET /events/{id} — Shows a single event. */
+export declare function getEvent(config: ClientConfig, id: number): Promise<ApiResult<unknown>>;
+/** GET /organizations — Lists organizations. */
+export declare function listOrganizations(config: ClientConfig, params?: ListParams): Promise<ApiResult<unknown>>;
+/** GET /organizations/{id} — Shows a single organization. */
+export declare function getOrganization(config: ClientConfig, id: number): Promise<ApiResult<unknown>>;
+/** GET /pages — Lists pages. */
+export declare function listPages(config: ClientConfig, params?: ListParams): Promise<ApiResult<unknown>>;
+/** GET /pages/{id} — Shows a single page. */
+export declare function getPage(config: ClientConfig, id: number): Promise<ApiResult<unknown>>;
+export interface ListPhonebanksParams extends ListParams {
+    event_id?: number;
+}
+/** GET /phonebanks — Lists phonebanks. */
+export declare function listPhonebanks(config: ClientConfig, params?: ListPhonebanksParams): Promise<ApiResult<unknown>>;
+/** GET /phonebanks/{id} — Shows a single phonebank. */
+export declare function getPhonebank(config: ClientConfig, id: number): Promise<ApiResult<unknown>>;
+export interface ListScheduledCallsParams extends ListParams {
+    user_id?: number;
+    agent_user_id?: number;
+}
+/** GET /scheduled_calls — Lists scheduled calls. */
+export declare function listScheduledCalls(config: ClientConfig, params?: ListScheduledCallsParams): Promise<ApiResult<unknown>>;
+/** GET /scheduled_calls/{id} — Shows a single scheduled call. */
+export declare function getScheduledCall(config: ClientConfig, id: number): Promise<ApiResult<unknown>>;
+export interface ListScheduledTasksParams extends ListParams {
+    user_id?: number;
+    agent_user_id?: number;
+}
+export interface ScheduledTaskCreate {
+    due_at: string;
+    remind_at?: string | null;
+    agent_user_id?: number | null;
+    user_id: number;
+    notes?: string | null;
+    marked_as_completed?: boolean | null;
+}
+export interface ScheduledTaskUpdate {
+    due_at?: string;
+    remind_at?: string | null;
+    agent_user_id?: number | null;
+    user_id?: number;
+    notes?: string | null;
+    marked_as_completed?: boolean | null;
+}
+/** GET /scheduled_tasks — Lists scheduled tasks. */
+export declare function listScheduledTasks(config: ClientConfig, params?: ListScheduledTasksParams): Promise<ApiResult<unknown>>;
+/** POST /scheduled_tasks — Creates a scheduled task. */
+export declare function createScheduledTask(config: ClientConfig, body: ScheduledTaskCreate): Promise<ApiResult<unknown>>;
+/** GET /scheduled_tasks/{id} — Shows a single scheduled task. */
+export declare function getScheduledTask(config: ClientConfig, id: number): Promise<ApiResult<unknown>>;
+/** PUT /scheduled_tasks/{id} — Updates a scheduled task. */
+export declare function updateScheduledTask(config: ClientConfig, id: number, body: ScheduledTaskUpdate): Promise<ApiResult<unknown>>;
+/** DELETE /scheduled_tasks/{id} — Deletes a scheduled task. */
+export declare function deleteScheduledTask(config: ClientConfig, id: number): Promise<ApiResult<unknown>>;
+export interface ListTaskAgentsParams extends ListParams {
+    task_id?: number;
+}
+export interface TaskAgentCreate {
+    user_id: number;
+    task_id: number;
+}
+/** GET /task_agents — Lists task agents. */
+export declare function listTaskAgents(config: ClientConfig, params?: ListTaskAgentsParams): Promise<ApiResult<unknown>>;
+/** POST /task_agents — Creates a task agent. */
+export declare function createTaskAgent(config: ClientConfig, body: TaskAgentCreate): Promise<ApiResult<unknown>>;
+/** GET /task_agents/{id} — Shows a single task agent. */
+export declare function getTaskAgent(config: ClientConfig, id: number): Promise<ApiResult<unknown>>;
+/** DELETE /task_agents/{id} — Deletes a task agent. */
+export declare function deleteTaskAgent(config: ClientConfig, id: number): Promise<ApiResult<unknown>>;
+export interface ListTaskAssignmentsParams extends ListParams {
+    task_id?: number;
+    agent_user_id?: number;
+}
+export interface TaskAssignmentCreate {
+    user_id: number;
+    task_id: number;
+    agent_user_id?: number | null;
+}
+export interface TaskAssignmentUpdate {
+    agent_user_id?: number | null;
+}
+/** GET /task_assignments — Lists task assignments. */
+export declare function listTaskAssignments(config: ClientConfig, params?: ListTaskAssignmentsParams): Promise<ApiResult<unknown>>;
+/** POST /task_assignments — Creates a task assignment. */
+export declare function createTaskAssignment(config: ClientConfig, body: TaskAssignmentCreate): Promise<ApiResult<unknown>>;
+/** GET /task_assignments/{id} — Shows a single task assignment. */
+export declare function getTaskAssignment(config: ClientConfig, id: number): Promise<ApiResult<unknown>>;
+/** PUT /task_assignments/{id} — Updates a task assignment. */
+export declare function updateTaskAssignment(config: ClientConfig, id: number, body: TaskAssignmentUpdate): Promise<ApiResult<unknown>>;
+/** DELETE /task_assignments/{id} — Deletes a task assignment. */
+export declare function deleteTaskAssignment(config: ClientConfig, id: number): Promise<ApiResult<unknown>>;
+/** GET /team_members — Lists team members. */
+export declare function listTeamMembers(config: ClientConfig, params?: ListParams): Promise<ApiResult<unknown>>;
+/** GET /text_blasts — Lists text blasts. */
+export declare function listTextBlasts(config: ClientConfig, params?: ListParams): Promise<ApiResult<unknown>>;
+/** GET /text_blasts/{id} — Shows a single text blast. */
+export declare function getTextBlast(config: ClientConfig, id: number): Promise<ApiResult<unknown>>;
+export interface ListTextTemplatesParams extends ListParams {
+    event_id?: number;
+}
+export interface TextTemplateCreate {
+    name: string;
+    scope_id: number;
+    scope_type: ScopeType;
+    /** Localized template bodies keyed by 2-character language code. */
+    template?: Record<string, string>;
+    event_id?: number | null;
+}
+export interface TextTemplateUpdate {
+    name?: string;
+    scope_id?: number;
+    scope_type?: string;
+    template?: Record<string, string>;
+    event_id?: number | null;
+}
+/** GET /text_templates — Lists text templates. */
+export declare function listTextTemplates(config: ClientConfig, params?: ListTextTemplatesParams): Promise<ApiResult<unknown>>;
+/** POST /text_templates — Creates a text template. */
+export declare function createTextTemplate(config: ClientConfig, body: TextTemplateCreate): Promise<ApiResult<unknown>>;
+/** GET /text_templates/{id} — Shows a single text template. */
+export declare function getTextTemplate(config: ClientConfig, id: number): Promise<ApiResult<unknown>>;
+/** PUT /text_templates/{id} — Updates a text template. */
+export declare function updateTextTemplate(config: ClientConfig, id: number, body: TextTemplateUpdate): Promise<ApiResult<unknown>>;
+/** DELETE /text_templates/{id} — Deletes a text template. */
+export declare function deleteTextTemplate(config: ClientConfig, id: number): Promise<ApiResult<unknown>>;
+export interface ListTextbanksParams extends ListParams {
+    event_id?: number;
+}
+/** GET /textbanks — Lists textbanks. */
+export declare function listTextbanks(config: ClientConfig, params?: ListTextbanksParams): Promise<ApiResult<unknown>>;
+/** GET /textbanks/{id} — Shows a single textbank. */
+export declare function getTextbank(config: ClientConfig, id: number): Promise<ApiResult<unknown>>;
+export interface SendTextParams {
+    user_id: number;
+    body: string;
+    media_urls?: string[];
+    attach_contact_card?: boolean;
+    shorten_urls?: boolean;
+}
+export interface ListTextsParams {
+    user_id?: number;
+    _limit?: number;
+    _offset?: number;
+    _since?: string;
+}
+/** POST /texts — Sends a text message. Parameters are passed as query string. */
+export declare function sendText(config: ClientConfig, params: SendTextParams): Promise<ApiResult<unknown>>;
+/** GET /texts — Retrieves a list of texts. */
+export declare function listTexts(config: ClientConfig, params?: ListTextsParams): Promise<ApiResult<TextsResponse>>;
+export interface UserActionData {
+    phone_number?: string | null;
+    email?: string | null;
+    first_name?: string | null;
+    last_name?: string | null;
+    preferred_language?: string | null;
+    second_language?: string | null;
+    chapter_id?: number | null;
+    address?: Address | null;
+    sms_permission?: boolean | null;
+    call_permission?: boolean | null;
+    email_permission?: boolean | null;
+    custom_user_properties?: Record<string, string> | null;
+}
+/**
+ * Body for POST /user_actions. `page_id` is required; supply either an existing
+ * `user_id` or a `data` object that identifies the user by phone number/email.
+ */
+export interface UserActionCreate {
+    page_id: number;
+    user_id?: number | null;
+    created_at?: number | null;
+    data?: UserActionData;
+}
+/** POST /user_actions — Creates a user action. */
+export declare function createUserAction(config: ClientConfig, body: UserActionCreate): Promise<ApiResult<unknown>>;
+/** GET /user_lists — Lists user lists. */
+export declare function listUserLists(config: ClientConfig, params?: ListParams): Promise<ApiResult<unknown>>;
+/** GET /user_lists/{id} — Shows a single user list. */
+export declare function getUserList(config: ClientConfig, id: number): Promise<ApiResult<unknown>>;
+export interface CreateUserNoteParams {
+    user_id: number;
+    content: string;
+    created_at?: number;
+}
+/** POST /user_notes — Creates a user note. Parameters are passed as query string. */
+export declare function createUserNote(config: ClientConfig, params: CreateUserNoteParams): Promise<ApiResult<unknown>>;
+/**
+ * Body for POST /users. The API requires at least one of `phone_number` or
+ * `email` to identify the user.
+ */
+export interface UserCreate {
+    phone_number?: string | null;
+    email?: string | null;
+    first_name?: string | null;
+    last_name?: string | null;
+    preferred_language?: string;
+    second_language?: string | null;
+    chapter_id?: number | null;
+    custom_user_properties?: Record<string, string> | null;
+    address?: Address | null;
+    sms_permission?: boolean | null;
+    call_permission?: boolean | null;
+    email_permission?: boolean | null;
+}
+export interface UserUpdate {
+    phone_number?: string | null;
+    email?: string | null;
+    first_name?: string | null;
+    last_name?: string | null;
+    preferred_language?: string | null;
+    second_language?: string | null;
+    chapter_id?: number | null;
+    custom_user_properties?: Record<string, string> | null;
+    address?: Address | null;
+    sms_permission?: boolean | null;
+    call_permission?: boolean | null;
+    email_permission?: boolean | null;
+}
+/** POST /users — Creates or updates a user. */
+export declare function createUser(config: ClientConfig, body: UserCreate): Promise<ApiResult<unknown>>;
+/** GET /users — Retrieves a list of users. */
+export declare function listUsers(config: ClientConfig, params?: ListParams): Promise<ApiResult<UsersResponse>>;
+/** PUT /users/{id} — Updates a user. */
+export declare function updateUser(config: ClientConfig, id: number, body: UserUpdate): Promise<ApiResult<unknown>>;