@line-harness/sdk 0.1.0

package/dist/index.d.cts

@@ -0,0 +1,448 @@
+interface HttpClientConfig {
+    baseUrl: string;
+    apiKey: string;
+    timeout: number;
+}
+declare class HttpClient {
+    private readonly baseUrl;
+    private readonly apiKey;
+    private readonly timeout;
+    constructor(config: HttpClientConfig);
+    get<T = unknown>(path: string): Promise<T>;
+    post<T = unknown>(path: string, body?: unknown): Promise<T>;
+    put<T = unknown>(path: string, body?: unknown): Promise<T>;
+    delete<T = unknown>(path: string): Promise<T>;
+    private request;
+}
+
+interface LineHarnessConfig {
+    apiUrl: string;
+    apiKey: string;
+    timeout?: number;
+    lineAccountId?: string;
+}
+interface ApiResponse<T> {
+    success: boolean;
+    data: T;
+    error?: string;
+}
+interface PaginatedData<T> {
+    items: T[];
+    total: number;
+    page: number;
+    limit: number;
+    hasNextPage: boolean;
+}
+type ScenarioTriggerType = 'friend_add' | 'tag_added' | 'manual';
+type MessageType = 'text' | 'image' | 'flex';
+type BroadcastStatus = 'draft' | 'scheduled' | 'sending' | 'sent';
+interface Friend {
+    id: string;
+    lineUserId: string;
+    displayName: string | null;
+    pictureUrl: string | null;
+    statusMessage: string | null;
+    isFollowing: boolean;
+    metadata: Record<string, unknown>;
+    tags: Tag[];
+    createdAt: string;
+    updatedAt: string;
+}
+interface FriendListParams {
+    limit?: number;
+    offset?: number;
+    tagId?: string;
+    accountId?: string;
+}
+interface Tag {
+    id: string;
+    name: string;
+    color: string;
+    createdAt: string;
+}
+interface CreateTagInput {
+    name: string;
+    color?: string;
+}
+interface Scenario {
+    id: string;
+    name: string;
+    description: string | null;
+    triggerType: ScenarioTriggerType;
+    triggerTagId: string | null;
+    isActive: boolean;
+    createdAt: string;
+    updatedAt: string;
+}
+interface ScenarioListItem extends Scenario {
+    stepCount: number;
+}
+interface ScenarioWithSteps extends Scenario {
+    steps: ScenarioStep[];
+}
+interface ScenarioStep {
+    id: string;
+    scenarioId: string;
+    stepOrder: number;
+    delayMinutes: number;
+    messageType: MessageType;
+    messageContent: string;
+    conditionType: string | null;
+    conditionValue: string | null;
+    nextStepOnFalse: number | null;
+    createdAt: string;
+}
+interface CreateScenarioInput {
+    name: string;
+    description?: string;
+    triggerType: ScenarioTriggerType;
+    triggerTagId?: string;
+    isActive?: boolean;
+}
+interface CreateStepInput {
+    stepOrder: number;
+    delayMinutes: number;
+    messageType: MessageType;
+    messageContent: string;
+    conditionType?: string | null;
+    conditionValue?: string | null;
+    nextStepOnFalse?: number | null;
+}
+interface UpdateScenarioInput {
+    name?: string;
+    description?: string | null;
+    triggerType?: ScenarioTriggerType;
+    triggerTagId?: string | null;
+    isActive?: boolean;
+}
+interface UpdateStepInput {
+    stepOrder?: number;
+    delayMinutes?: number;
+    messageType?: MessageType;
+    messageContent?: string;
+    conditionType?: string | null;
+    conditionValue?: string | null;
+    nextStepOnFalse?: number | null;
+}
+interface FriendScenarioEnrollment {
+    id: string;
+    friendId: string;
+    scenarioId: string;
+    currentStepOrder: number;
+    status: 'active' | 'paused' | 'completed';
+    startedAt: string;
+    nextDeliveryAt: string | null;
+    updatedAt: string;
+}
+interface Broadcast {
+    id: string;
+    title: string;
+    messageType: MessageType;
+    messageContent: string;
+    targetType: 'all' | 'tag';
+    targetTagId: string | null;
+    status: BroadcastStatus;
+    scheduledAt: string | null;
+    sentAt: string | null;
+    totalCount: number;
+    successCount: number;
+    createdAt: string;
+}
+interface CreateBroadcastInput {
+    title: string;
+    messageType: MessageType;
+    messageContent: string;
+    targetType: 'all' | 'tag';
+    targetTagId?: string;
+    scheduledAt?: string;
+}
+interface UpdateBroadcastInput {
+    title?: string;
+    messageType?: MessageType;
+    messageContent?: string;
+    targetType?: 'all' | 'tag';
+    targetTagId?: string | null;
+    scheduledAt?: string | null;
+}
+interface RichMenuBounds {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+}
+type RichMenuAction = {
+    type: 'postback';
+    data: string;
+    displayText?: string;
+    label?: string;
+} | {
+    type: 'message';
+    text: string;
+    label?: string;
+} | {
+    type: 'uri';
+    uri: string;
+    label?: string;
+} | {
+    type: 'datetimepicker';
+    data: string;
+    mode: 'date' | 'time' | 'datetime';
+    label?: string;
+} | {
+    type: 'richmenuswitch';
+    richMenuAliasId: string;
+    data: string;
+    label?: string;
+};
+interface RichMenuArea {
+    bounds: RichMenuBounds;
+    action: RichMenuAction;
+}
+interface RichMenu {
+    richMenuId: string;
+    size: {
+        width: number;
+        height: number;
+    };
+    selected: boolean;
+    name: string;
+    chatBarText: string;
+    areas: RichMenuArea[];
+}
+interface CreateRichMenuInput {
+    size: {
+        width: number;
+        height: number;
+    };
+    selected: boolean;
+    name: string;
+    chatBarText: string;
+    areas: RichMenuArea[];
+}
+interface SegmentRule {
+    type: 'tag_exists' | 'tag_not_exists' | 'metadata_equals' | 'metadata_not_equals' | 'ref_code' | 'is_following';
+    value: string | boolean | {
+        key: string;
+        value: string;
+    };
+}
+interface SegmentCondition {
+    operator: 'AND' | 'OR';
+    rules: SegmentRule[];
+}
+interface TrackedLink {
+    id: string;
+    name: string;
+    originalUrl: string;
+    trackingUrl: string;
+    tagId: string | null;
+    scenarioId: string | null;
+    isActive: boolean;
+    clickCount: number;
+    createdAt: string;
+    updatedAt: string;
+}
+interface LinkClick {
+    id: string;
+    friendId: string | null;
+    friendDisplayName: string | null;
+    clickedAt: string;
+}
+interface TrackedLinkWithClicks extends TrackedLink {
+    clicks: LinkClick[];
+}
+interface CreateTrackedLinkInput {
+    name: string;
+    originalUrl: string;
+    tagId?: string | null;
+    scenarioId?: string | null;
+}
+interface FormField {
+    name: string;
+    label: string;
+    type: 'text' | 'email' | 'tel' | 'number' | 'textarea' | 'select' | 'radio' | 'checkbox' | 'date';
+    required?: boolean;
+    options?: string[];
+    placeholder?: string;
+}
+interface Form {
+    id: string;
+    name: string;
+    description: string | null;
+    fields: FormField[];
+    onSubmitTagId: string | null;
+    onSubmitScenarioId: string | null;
+    saveToMetadata: boolean;
+    isActive: boolean;
+    submitCount: number;
+    createdAt: string;
+    updatedAt: string;
+}
+interface CreateFormInput {
+    name: string;
+    description?: string;
+    fields: FormField[];
+    onSubmitTagId?: string | null;
+    onSubmitScenarioId?: string | null;
+    saveToMetadata?: boolean;
+}
+interface UpdateFormInput {
+    name?: string;
+    description?: string | null;
+    fields?: FormField[];
+    onSubmitTagId?: string | null;
+    onSubmitScenarioId?: string | null;
+    saveToMetadata?: boolean;
+    isActive?: boolean;
+}
+interface FormSubmission {
+    id: string;
+    formId: string;
+    friendId: string | null;
+    data: Record<string, unknown>;
+    createdAt: string;
+}
+interface StepDefinition {
+    delay: string;
+    type: MessageType;
+    content: string;
+}
+
+declare class FriendsResource {
+    private readonly http;
+    private readonly defaultAccountId?;
+    constructor(http: HttpClient, defaultAccountId?: string | undefined);
+    list(params?: FriendListParams): Promise<PaginatedData<Friend>>;
+    get(id: string): Promise<Friend>;
+    count(params?: {
+        accountId?: string;
+    }): Promise<number>;
+    addTag(friendId: string, tagId: string): Promise<void>;
+    removeTag(friendId: string, tagId: string): Promise<void>;
+    sendMessage(friendId: string, content: string, messageType?: MessageType): Promise<{
+        messageId: string;
+    }>;
+    setMetadata(friendId: string, fields: Record<string, unknown>): Promise<Friend>;
+    setRichMenu(friendId: string, richMenuId: string): Promise<void>;
+    removeRichMenu(friendId: string): Promise<void>;
+}
+
+declare class TagsResource {
+    private readonly http;
+    constructor(http: HttpClient);
+    list(): Promise<Tag[]>;
+    create(input: CreateTagInput): Promise<Tag>;
+    delete(id: string): Promise<void>;
+}
+
+declare class ScenariosResource {
+    private readonly http;
+    private readonly defaultAccountId?;
+    constructor(http: HttpClient, defaultAccountId?: string | undefined);
+    list(params?: {
+        accountId?: string;
+    }): Promise<ScenarioListItem[]>;
+    get(id: string): Promise<ScenarioWithSteps>;
+    create(input: CreateScenarioInput & {
+        lineAccountId?: string;
+    }): Promise<Scenario>;
+    update(id: string, input: UpdateScenarioInput): Promise<Scenario>;
+    delete(id: string): Promise<void>;
+    addStep(scenarioId: string, input: CreateStepInput): Promise<ScenarioStep>;
+    updateStep(scenarioId: string, stepId: string, input: UpdateStepInput): Promise<ScenarioStep>;
+    deleteStep(scenarioId: string, stepId: string): Promise<void>;
+    enroll(scenarioId: string, friendId: string): Promise<FriendScenarioEnrollment>;
+}
+
+declare class BroadcastsResource {
+    private readonly http;
+    private readonly defaultAccountId?;
+    constructor(http: HttpClient, defaultAccountId?: string | undefined);
+    list(params?: {
+        accountId?: string;
+    }): Promise<Broadcast[]>;
+    get(id: string): Promise<Broadcast>;
+    create(input: CreateBroadcastInput & {
+        lineAccountId?: string;
+    }): Promise<Broadcast>;
+    update(id: string, input: UpdateBroadcastInput): Promise<Broadcast>;
+    delete(id: string): Promise<void>;
+    send(id: string): Promise<Broadcast>;
+    sendToSegment(id: string, conditions: SegmentCondition): Promise<Broadcast>;
+}
+
+declare class RichMenusResource {
+    private readonly http;
+    constructor(http: HttpClient);
+    list(): Promise<RichMenu[]>;
+    create(menu: CreateRichMenuInput): Promise<{
+        richMenuId: string;
+    }>;
+    delete(richMenuId: string): Promise<void>;
+    setDefault(richMenuId: string): Promise<void>;
+}
+
+declare class TrackedLinksResource {
+    private readonly http;
+    constructor(http: HttpClient);
+    list(): Promise<TrackedLink[]>;
+    create(input: CreateTrackedLinkInput): Promise<TrackedLink>;
+    get(id: string): Promise<TrackedLinkWithClicks>;
+    delete(id: string): Promise<void>;
+}
+
+declare class FormsResource {
+    private readonly http;
+    constructor(http: HttpClient);
+    list(): Promise<Form[]>;
+    get(id: string): Promise<Form>;
+    create(input: CreateFormInput): Promise<Form>;
+    update(id: string, input: UpdateFormInput): Promise<Form>;
+    delete(id: string): Promise<void>;
+    getSubmissions(formId: string): Promise<FormSubmission[]>;
+}
+
+declare class LineHarness {
+    readonly friends: FriendsResource;
+    readonly tags: TagsResource;
+    readonly scenarios: ScenariosResource;
+    readonly broadcasts: BroadcastsResource;
+    readonly richMenus: RichMenusResource;
+    readonly trackedLinks: TrackedLinksResource;
+    readonly forms: FormsResource;
+    private readonly apiUrl;
+    private readonly defaultAccountId;
+    private readonly workflows;
+    readonly createStepScenario: (name: string, triggerType: ScenarioTriggerType, steps: StepDefinition[]) => Promise<ScenarioWithSteps>;
+    readonly broadcastText: (text: string) => Promise<Broadcast>;
+    readonly broadcastToTag: (tagId: string, messageType: MessageType, content: string) => Promise<Broadcast>;
+    readonly broadcastToSegment: (messageType: MessageType, content: string, conditions: SegmentCondition) => Promise<Broadcast>;
+    readonly sendTextToFriend: (friendId: string, text: string) => Promise<{
+        messageId: string;
+    }>;
+    readonly sendFlexToFriend: (friendId: string, flexJson: string) => Promise<{
+        messageId: string;
+    }>;
+    constructor(config: LineHarnessConfig);
+    /**
+     * Generate friend-add URL with OAuth (bot_prompt=aggressive)
+     * This URL does friend-add + UUID in one step.
+     *
+     * @param ref - Attribution code (e.g., 'lp-a', 'instagram', 'seminar-0322')
+     * @param redirect - URL to redirect after completion
+     */
+    getAuthUrl(options?: {
+        ref?: string;
+        redirect?: string;
+    }): string;
+}
+
+declare class LineHarnessError extends Error {
+    readonly status: number;
+    readonly endpoint: string;
+    constructor(message: string, status: number, endpoint: string);
+}
+
+declare function parseDelay(input: string): number;
+
+export { type ApiResponse, type Broadcast, type BroadcastStatus, BroadcastsResource, type CreateBroadcastInput, type CreateFormInput, type CreateRichMenuInput, type CreateScenarioInput, type CreateStepInput, type CreateTagInput, type CreateTrackedLinkInput, type Form, type FormField, type FormSubmission, FormsResource, type Friend, type FriendListParams, type FriendScenarioEnrollment, FriendsResource, LineHarness, type LineHarnessConfig, LineHarnessError, type LinkClick, type MessageType, type PaginatedData, type RichMenu, type RichMenuAction, type RichMenuArea, type RichMenuBounds, RichMenusResource, type Scenario, type ScenarioListItem, type ScenarioStep, type ScenarioTriggerType, type ScenarioWithSteps, ScenariosResource, type SegmentCondition, type SegmentRule, type StepDefinition, type Tag, TagsResource, type TrackedLink, type TrackedLinkWithClicks, TrackedLinksResource, type UpdateBroadcastInput, type UpdateFormInput, type UpdateScenarioInput, type UpdateStepInput, parseDelay };