@beepsdev/sdk 0.0.3

package/dist/index.d.ts

@@ -0,0 +1,612 @@
+type Result<T> = {
+    data?: T;
+    error?: Error;
+};
+type BeepsClientConfig = {
+    apiKey: string;
+    baseURL?: string;
+    timeoutMs?: number;
+    retries?: {
+        attempts: number;
+        backoffMs: number;
+    };
+    fetch?: typeof fetch;
+};
+type BeepsRelayConfig = {
+    externalKey: string;
+    name: string;
+    description?: string;
+};
+type BeepsScheduleMemberConfig = {
+    userId: string;
+} | {
+    email: string;
+};
+type BeepsScheduleConfig = {
+    externalKey: string;
+    relayExternalKey: string;
+    name: string;
+    type: "daily" | "weekly";
+    startDay: "monday" | "tuesday" | "wednesday" | "thursday" | "friday" | "saturday" | "sunday";
+    startTime: string;
+    members?: BeepsScheduleMemberConfig[];
+};
+type BeepsScheduleNotifyRuleConfig = {
+    scheduleExternalKey: string;
+    notificationMethod?: "email" | "sms";
+};
+type BeepsWebhookRuleConfig = {
+    endpoint: string;
+    method?: "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
+    headers?: Record<string, string>;
+    payload?: Record<string, unknown>;
+    timeout?: number;
+};
+type BeepsAgentRuleConfig = {
+    agentType: "devin";
+    integrationId?: string;
+    integrationProvider?: "devin" | "rhythm" | "slack" | "discord";
+    endpoint?: string;
+    config?: Record<string, unknown>;
+    pollInterval?: number;
+    maxPollAttempts?: number;
+};
+type BeepsRelayRuleConfig = {
+    externalKey: string;
+    relayExternalKey: string;
+    group?: string;
+    order?: number;
+    name: string;
+    ruleType: RelayRuleType;
+    enabled?: boolean;
+    config: BeepsScheduleNotifyRuleConfig | BeepsWebhookRuleConfig | BeepsAgentRuleConfig;
+};
+type BeepsIntegrationConfig = {
+    provider: "devin" | "rhythm" | "slack" | "discord";
+    name: string;
+    apiKeyEnv: string;
+    metadata?: Record<string, unknown>;
+};
+type BeepsConfig = {
+    version: 1;
+    relays?: BeepsRelayConfig[];
+    schedules?: BeepsScheduleConfig[];
+    relayRules?: BeepsRelayRuleConfig[];
+    integrations?: BeepsIntegrationConfig[];
+};
+type CreateRelayInput = {
+    name: string;
+    description?: string;
+    externalKey?: string;
+};
+type Relay = {
+    id: string;
+    organizationId: string;
+    name: string;
+    description: string;
+    externalKey?: string | null;
+    createdAt: string;
+    updatedAt: string;
+};
+type CreateScheduleInput = {
+    name: string;
+    relayId: string;
+    type: "daily" | "weekly";
+    startDay: "monday" | "tuesday" | "wednesday" | "thursday" | "friday" | "saturday" | "sunday";
+    startTime: string;
+    externalKey?: string;
+};
+type Schedule = {
+    id: string;
+    organizationId: string;
+    relayId: string;
+    name: string;
+    type: "daily" | "weekly";
+    startDay: "monday" | "tuesday" | "wednesday" | "thursday" | "friday" | "saturday" | "sunday";
+    startTime: string;
+    externalKey?: string | null;
+    createdAt: string;
+    updatedAt: string;
+    deletedAt?: string | null;
+};
+type AddScheduleMemberInput = {
+    userId: string;
+};
+type ScheduleMember = {
+    scheduleId: string;
+    userId: string;
+    createdAt?: string;
+    effectiveAt?: string;
+    removedAt?: string | null;
+};
+type GetAssignmentsParams = {
+    type?: "assignments";
+    count?: number;
+} | {
+    type: "until";
+    date: string | Date;
+} | {
+    type: "days";
+    count: number;
+};
+type ScheduleAssignment = {
+    userId: string;
+    startDate: string;
+    endDate: string;
+    assignmentNumber: number;
+};
+type RelayRuleType = "schedule_notify" | "webhook" | "agent";
+type ScheduleNotifyConfig = {
+    scheduleId: string;
+    notificationMethod?: "email" | "sms";
+};
+type WebhookConfig = {
+    endpoint: string;
+    method?: "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
+    headers?: Record<string, string>;
+    payload?: Record<string, unknown>;
+    timeout?: number;
+};
+type AgentConfig = {
+    agentType: "devin" | "cursor";
+    integrationId?: string;
+    endpoint?: string;
+    config?: Record<string, unknown>;
+    pollInterval?: number;
+    maxPollAttempts?: number;
+    repository?: string;
+    autoCreatePr?: boolean;
+    branchName?: string;
+    autoBranch?: boolean;
+    model?: string;
+};
+type RelayRuleConfig = ScheduleNotifyConfig | WebhookConfig | AgentConfig;
+type CreateRelayRuleInput = {
+    externalKey?: string;
+    name: string;
+    ruleType: RelayRuleType;
+    group?: string;
+    order?: number;
+    config: RelayRuleConfig;
+    enabled?: boolean;
+};
+type UpdateRelayRuleInput = {
+    name?: string;
+    ruleType?: RelayRuleType;
+    group?: string;
+    order?: number;
+    config?: RelayRuleConfig;
+    enabled?: boolean;
+};
+type RelayRule = {
+    id: string;
+    organizationId: string;
+    relayId: string;
+    group: string;
+    externalKey?: string | null;
+    name: string;
+    order: number;
+    ruleType: RelayRuleType;
+    config: Record<string, unknown>;
+    enabled: boolean;
+    createdAt: string;
+    updatedAt: string;
+    deletedAt?: string | null;
+};
+type RelayLintSeverity = "error" | "warning" | "info";
+type RelayLintIssue = {
+    severity: RelayLintSeverity;
+    code: string;
+    message: string;
+    relayId?: string;
+    ruleId?: string;
+    scheduleId?: string;
+    details?: Record<string, unknown>;
+};
+type RelayLintResult = {
+    issues: RelayLintIssue[];
+};
+type RelayLintInput = {
+    simulateAt?: string;
+    coverageDays?: number;
+};
+type RelaySimulationAlertInput = {
+    title: string;
+    message?: string;
+    severity?: AlertSeverity;
+    source?: string;
+    externalId?: string;
+    metadata?: Record<string, unknown>;
+};
+type RelaySimulationInput = {
+    simulateAt: string;
+    alert?: RelaySimulationAlertInput;
+    payload?: unknown;
+    source?: string;
+};
+type RelaySimulationAlertPreview = {
+    title: string;
+    message?: string;
+    severity: AlertSeverity;
+    source: string;
+    externalId?: string;
+    metadata?: Record<string, unknown>;
+};
+type RelaySimulationContactMethod = {
+    id: string;
+    transport: string;
+    value: string;
+    verified: boolean;
+};
+type RelaySimulationOnCallUser = {
+    userId: string;
+    email: string;
+    assignmentNumber: number | null;
+    scheduleId: string;
+    isOverride: boolean;
+    overrideId?: string;
+};
+type RelaySimulationScheduleStep = {
+    ruleId: string;
+    ruleType: "schedule_notify";
+    name: string;
+    enabled: boolean;
+    scheduleId?: string;
+    notificationMethod?: "email" | "sms";
+    onCallUser?: RelaySimulationOnCallUser | null;
+    contactMethods: RelaySimulationContactMethod[];
+};
+type RelaySimulationWebhookStep = {
+    ruleId: string;
+    ruleType: "webhook";
+    name: string;
+    enabled: boolean;
+    endpoint: string;
+    method: string;
+    wouldSend: boolean;
+};
+type RelaySimulationAgentStep = {
+    ruleId: string;
+    ruleType: "agent";
+    name: string;
+    enabled: boolean;
+    agentType: string;
+    integrationId?: string;
+    endpoint?: string;
+    wouldStart: boolean;
+};
+type RelaySimulationUnknownStep = {
+    ruleId: string;
+    ruleType: string;
+    name: string;
+    enabled: boolean;
+};
+type RelaySimulationStep = RelaySimulationScheduleStep | RelaySimulationWebhookStep | RelaySimulationAgentStep | RelaySimulationUnknownStep;
+type RelaySimulationGroup = {
+    groupName: string;
+    steps: RelaySimulationStep[];
+};
+type RelaySimulationResult = {
+    relayId: string;
+    simulateAt: string;
+    alertPreview: RelaySimulationAlertPreview;
+    groups: RelaySimulationGroup[];
+    issues: RelayLintIssue[];
+};
+type ListRelayRulesParams = {
+    enabled?: boolean;
+    ruleType?: RelayRuleType;
+};
+type ReorderRelayRulesInput = {
+    rules: Array<{
+        id: string;
+        order: number;
+    }>;
+};
+type ContactMethodTransport = "email" | "sms";
+type CreateContactMethodInput = {
+    userId: string;
+    transport: ContactMethodTransport;
+    value: string;
+};
+type ContactMethod = {
+    id: string;
+    userId: string;
+    transport: string;
+    value: string;
+    verified: boolean;
+    createdAt: string;
+    updatedAt: string;
+    deletedAt?: string | null;
+};
+type ListContactMethodsParams = {
+    userId: string;
+};
+type DeleteContactMethodParams = {
+    userId: string;
+};
+type BeepsUser = {
+    userId: string;
+    email: string;
+    assignmentNumber: number | null;
+    scheduleId: string;
+    isOverride?: boolean;
+    overrideId?: string;
+};
+type CreateScheduleOverrideInput = {
+    userId: string;
+    startAt: string | Date;
+    endAt: string | Date;
+    reason?: string;
+};
+type UpdateScheduleOverrideInput = {
+    startAt?: string | Date;
+    endAt?: string | Date;
+    reason?: string;
+};
+type ListScheduleOverridesParams = {
+    startAt?: string | Date;
+    endAt?: string | Date;
+};
+type ScheduleOverride = {
+    id: string;
+    organizationId: string;
+    scheduleId: string;
+    userId: string;
+    startAt: string;
+    endAt: string;
+    reason?: string | null;
+    createdByUserId: string;
+    createdAt: string;
+    updatedAt: string;
+    canceledAt?: string | null;
+    deletedAt?: string | null;
+};
+type AlertSeverity = "critical" | "high" | "medium" | "low" | "info";
+type Alert = {
+    id: string;
+    organizationId: string;
+    webhookId: string;
+    title: string;
+    message?: string | null;
+    severity: AlertSeverity;
+    source: string;
+    externalId?: string | null;
+    metadata?: Record<string, unknown> | null;
+    assignedToUserId?: string | null;
+    acknowledgedAt?: string | null;
+    acknowledgedBy?: string | null;
+    resolvedAt?: string | null;
+    createdAt: string;
+    updatedAt: string;
+};
+type AcknowledgeAlertInput = {
+    userId?: string;
+};
+type IntegrationProvider = "devin" | "cursor" | "slack" | "discord";
+type CreateIntegrationInput = {
+    name: string;
+    provider: IntegrationProvider;
+    apiKey: string;
+    metadata?: Record<string, unknown>;
+};
+type UpdateIntegrationInput = {
+    name?: string;
+    apiKey?: string;
+    metadata?: Record<string, unknown>;
+};
+type Integration = {
+    id: string;
+    organizationId: string;
+    name: string;
+    provider: IntegrationProvider;
+    apiKey: string;
+    metadata?: Record<string, unknown> | null;
+    createdBy: string;
+    createdAt: string;
+    updatedAt: string;
+    deletedAt?: string | null;
+};
+type OrganizationMember = {
+    userId: string;
+    organizationId: string;
+    role: string;
+    email: string;
+};
+
+declare class HttpClient {
+    private cfg;
+    private _fetch;
+    constructor(config: BeepsClientConfig);
+    post<T>(path: string, body: unknown): Promise<T>;
+    get<T>(path: string): Promise<T>;
+    put<T>(path: string, body: unknown): Promise<T>;
+    patch<T>(path: string, body: unknown): Promise<T>;
+    delete<T>(path: string): Promise<T>;
+    private request;
+    private shouldRetry;
+    private jitterBackoff;
+    private sleep;
+}
+
+declare class RelayRulesResource {
+    private http;
+    constructor(http: HttpClient);
+    list(relayId: string, params?: ListRelayRulesParams): Promise<RelayRule[]>;
+    create(relayId: string, input: CreateRelayRuleInput): Promise<RelayRule>;
+    get(relayId: string, ruleId: string): Promise<RelayRule>;
+    update(relayId: string, ruleId: string, input: UpdateRelayRuleInput): Promise<RelayRule>;
+    delete(relayId: string, ruleId: string): Promise<{
+        success: boolean;
+    }>;
+    reorder(relayId: string, input: ReorderRelayRulesInput): Promise<RelayRule[]>;
+    listSafe(relayId: string, params?: ListRelayRulesParams): Promise<Result<RelayRule[]>>;
+    createSafe(relayId: string, input: CreateRelayRuleInput): Promise<Result<RelayRule>>;
+    getSafe(relayId: string, ruleId: string): Promise<Result<RelayRule>>;
+    updateSafe(relayId: string, ruleId: string, input: UpdateRelayRuleInput): Promise<Result<RelayRule>>;
+    deleteSafe(relayId: string, ruleId: string): Promise<Result<{
+        success: boolean;
+    }>>;
+    reorderSafe(relayId: string, input: ReorderRelayRulesInput): Promise<Result<RelayRule[]>>;
+}
+
+declare class RelayResource {
+    private http;
+    rules: RelayRulesResource;
+    constructor(http: HttpClient);
+    create(input: CreateRelayInput): Promise<Relay>;
+    list(): Promise<Relay[]>;
+    lint(relayId: string, input?: RelayLintInput): Promise<RelayLintResult>;
+    simulate(relayId: string, input: RelaySimulationInput): Promise<RelaySimulationResult>;
+    createSafe(input: CreateRelayInput): Promise<Result<Relay>>;
+    lintSafe(relayId: string, input?: RelayLintInput): Promise<Result<RelayLintResult>>;
+    simulateSafe(relayId: string, input: RelaySimulationInput): Promise<Result<RelaySimulationResult>>;
+}
+
+declare class ScheduleResource {
+    private http;
+    constructor(http: HttpClient);
+    create(input: CreateScheduleInput): Promise<Schedule>;
+    list(): Promise<Schedule[]>;
+    addMember(scheduleId: string, input: AddScheduleMemberInput): Promise<ScheduleMember>;
+    listMembers(scheduleId: string): Promise<ScheduleMember[]>;
+    listMembersSafe(scheduleId: string): Promise<Result<ScheduleMember[]>>;
+    removeMember(scheduleId: string, userId: string): Promise<ScheduleMember>;
+    getAssignments(scheduleId: string, params?: GetAssignmentsParams): Promise<ScheduleAssignment[]>;
+    getOnCall(scheduleId: string): Promise<BeepsUser>;
+    getOnCallSafe(scheduleId: string): Promise<Result<BeepsUser>>;
+    createOverride(scheduleId: string, input: CreateScheduleOverrideInput): Promise<ScheduleOverride>;
+    listOverrides(scheduleId: string, params?: ListScheduleOverridesParams): Promise<ScheduleOverride[]>;
+    cancelOverride(scheduleId: string, overrideId: string): Promise<ScheduleOverride>;
+    updateOverride(scheduleId: string, overrideId: string, input: UpdateScheduleOverrideInput): Promise<ScheduleOverride>;
+}
+
+declare class ContactMethodResource {
+    private http;
+    constructor(http: HttpClient);
+    list(params: ListContactMethodsParams): Promise<ContactMethod[]>;
+    create(input: CreateContactMethodInput): Promise<ContactMethod>;
+    delete(id: string, params: DeleteContactMethodParams): Promise<{
+        success: boolean;
+    }>;
+    listSafe(params: ListContactMethodsParams): Promise<Result<ContactMethod[]>>;
+    createSafe(input: CreateContactMethodInput): Promise<Result<ContactMethod>>;
+    deleteSafe(id: string, params: DeleteContactMethodParams): Promise<Result<{
+        success: boolean;
+    }>>;
+}
+
+declare class AlertResource {
+    private http;
+    constructor(http: HttpClient);
+    list(): Promise<Alert[]>;
+    listActive(): Promise<Alert[]>;
+    listResolved(): Promise<Alert[]>;
+    get(alertId: string): Promise<Alert>;
+    acknowledge(alertId: string, input?: AcknowledgeAlertInput): Promise<Alert>;
+    resolve(alertId: string): Promise<Alert>;
+    assign(alertId: string, userId: string): Promise<Alert>;
+    listSafe(): Promise<Result<Alert[]>>;
+    listActiveSafe(): Promise<Result<Alert[]>>;
+    listResolvedSafe(): Promise<Result<Alert[]>>;
+    getSafe(alertId: string): Promise<Result<Alert>>;
+    acknowledgeSafe(alertId: string, input?: AcknowledgeAlertInput): Promise<Result<Alert>>;
+    resolveSafe(alertId: string): Promise<Result<Alert>>;
+    assignSafe(alertId: string, userId: string): Promise<Result<Alert>>;
+}
+
+declare class IntegrationResource {
+    private http;
+    constructor(http: HttpClient);
+    list(): Promise<Integration[]>;
+    create(input: CreateIntegrationInput): Promise<Integration>;
+    get(integrationId: string): Promise<Integration>;
+    update(integrationId: string, input: UpdateIntegrationInput): Promise<Integration>;
+    delete(integrationId: string): Promise<{
+        success: boolean;
+    }>;
+    listSafe(): Promise<Result<Integration[]>>;
+    createSafe(input: CreateIntegrationInput): Promise<Result<Integration>>;
+    getSafe(integrationId: string): Promise<Result<Integration>>;
+    updateSafe(integrationId: string, input: UpdateIntegrationInput): Promise<Result<Integration>>;
+    deleteSafe(integrationId: string): Promise<Result<{
+        success: boolean;
+    }>>;
+}
+
+declare class MemberResource {
+    private http;
+    constructor(http: HttpClient);
+    list(): Promise<OrganizationMember[]>;
+    listSafe(): Promise<Result<OrganizationMember[]>>;
+}
+
+declare class BeepsClient {
+    relay: RelayResource;
+    schedule: ScheduleResource;
+    contactMethod: ContactMethodResource;
+    alert: AlertResource;
+    integration: IntegrationResource;
+    member: MemberResource;
+    constructor(config: BeepsClientConfig);
+}
+
+declare class BeepsError extends Error {
+    code?: string;
+    status?: number;
+    requestId?: string;
+    retryable?: boolean;
+    cause?: unknown;
+    constructor(message: string, options?: {
+        code?: string;
+        status?: number;
+        requestId?: string;
+        retryable?: boolean;
+        cause?: unknown;
+    });
+    toString(): string;
+}
+declare class AuthError extends BeepsError {
+    constructor(message?: string, opts?: ConstructorParameters<typeof BeepsError>[1]);
+}
+declare class ValidationError extends BeepsError {
+    details?: unknown;
+    constructor(message?: string, opts?: ConstructorParameters<typeof BeepsError>[1] & {
+        details?: unknown;
+    });
+}
+declare class NotFoundError extends BeepsError {
+    constructor(message?: string, opts?: ConstructorParameters<typeof BeepsError>[1]);
+}
+declare class RateLimitError extends BeepsError {
+    constructor(message?: string, opts?: ConstructorParameters<typeof BeepsError>[1]);
+}
+declare class ServerError extends BeepsError {
+    constructor(message?: string, opts?: ConstructorParameters<typeof BeepsError>[1]);
+}
+declare class NetworkError extends BeepsError {
+    constructor(message?: string, opts?: ConstructorParameters<typeof BeepsError>[1]);
+}
+declare class HttpError extends BeepsError {
+    constructor(message?: string, opts?: ConstructorParameters<typeof BeepsError>[1]);
+}
+declare function mapHttpError(status: number, message: string, requestId?: string): AuthError | ValidationError | NotFoundError | RateLimitError | ServerError | HttpError;
+
+/**
+ * Formats a Date object as an ISO 8601 timestamp with Z suffix (UTC).
+ * Example: "2024-01-29T00:00:00.000Z"
+ */
+declare function formatUTCDate(date: Date): string;
+/**
+ * Validates that a string is a valid ISO 8601 timestamp with Z suffix.
+ * Returns true if the string ends with "Z" and can be parsed as a valid date.
+ */
+declare function isIsoZ(value: string): boolean;
+/**
+ * Validates and normalizes a date parameter to an ISO 8601 string with Z suffix.
+ * Accepts either a Date object or a Z-suffixed ISO string.
+ * Throws an error if the input is invalid.
+ */
+declare function normalizeDateParam(date: Date | string): string;
+
+export { type AcknowledgeAlertInput, type AddScheduleMemberInput, type AgentConfig, type Alert, AlertResource, type AlertSeverity, AuthError, type BeepsAgentRuleConfig, BeepsClient, type BeepsClientConfig, type BeepsConfig, BeepsError, type BeepsIntegrationConfig, type BeepsRelayConfig, type BeepsRelayRuleConfig, type BeepsScheduleConfig, type BeepsScheduleMemberConfig, type BeepsScheduleNotifyRuleConfig, type BeepsUser, type BeepsWebhookRuleConfig, type ContactMethod, ContactMethodResource, type ContactMethodTransport, type CreateContactMethodInput, type CreateIntegrationInput, type CreateRelayInput, type CreateRelayRuleInput, type CreateScheduleInput, type CreateScheduleOverrideInput, type DeleteContactMethodParams, type GetAssignmentsParams, HttpError, type Integration, type IntegrationProvider, type ListContactMethodsParams, type ListRelayRulesParams, type ListScheduleOverridesParams, MemberResource, NetworkError, NotFoundError, type OrganizationMember, RateLimitError, type Relay, type RelayLintInput, type RelayLintIssue, type RelayLintResult, type RelayLintSeverity, type RelayRule, type RelayRuleConfig, type RelayRuleType, RelayRulesResource, type RelaySimulationAgentStep, type RelaySimulationAlertInput, type RelaySimulationAlertPreview, type RelaySimulationContactMethod, type RelaySimulationGroup, type RelaySimulationInput, type RelaySimulationOnCallUser, type RelaySimulationResult, type RelaySimulationScheduleStep, type RelaySimulationStep, type RelaySimulationUnknownStep, type RelaySimulationWebhookStep, type ReorderRelayRulesInput, type Result, type Schedule, type ScheduleAssignment, type ScheduleMember, type ScheduleNotifyConfig, type ScheduleOverride, ScheduleResource, ServerError, type UpdateIntegrationInput, type UpdateRelayRuleInput, type UpdateScheduleOverrideInput, ValidationError, type WebhookConfig, formatUTCDate, isIsoZ, mapHttpError, normalizeDateParam };