@vybit/api-sdk 1.0.1 → 1.1.1

package/dist/api-client.d.ts

@@ -1,18 +1,274 @@
-import { PlaceholderResponse } from './types';
+import { VybitAPIConfig, PaginationParams, SearchParams, StatusResponse, Profile, Meter, Vybit, VybitCreateParams, VybitUpdateParams, VybitTriggerParams, VybitTriggerResponse, VybitFollow, VybitFollowUpdateParams, PublicVybit, SubscriberSendParams, SubscriberSendResponse, Sound, Log, Peep, DeleteResponse } from './types';
 /**
- * VybitAPIClient - Placeholder Implementation
+ * Vybit Developer API client
  *
- * This is a placeholder class for the Vybit API SDK.
- * The full implementation will be available in a future release
- * once the main Vybit application API is finalized.
+ * Provides programmatic access to manage vybits, subscriptions, sounds,
+ * and notification logs using the Vybit Developer API.
  *
- * @deprecated This is a placeholder - do not use in production
+ * @example
+ * ```typescript
+ * // With explicit API key
+ * const client = new VybitAPIClient({
+ *   apiKey: 'your-api-key-from-developer-portal'
+ * });
+ *
+ * // Using VYBIT_API_KEY environment variable
+ * const client = new VybitAPIClient();
+ *
+ * // Get API status
+ * const status = await client.getStatus();
+ *
+ * // Create a vybit
+ * const vybit = await client.createVybit({
+ *   name: 'Server Alert',
+ *   soundKey: 'sound123abc',
+ *   triggerType: 'webhook'
+ * });
+ *
+ * // List vybits with pagination
+ * const vybits = await client.listVybits({ limit: 10, offset: 0 });
+ * ```
  */
 export declare class VybitAPIClient {
-    constructor();
+    private apiKey;
+    private baseUrl;
+    /**
+     * Creates a new Vybit Developer API client
+     * @param config - API configuration. If apiKey is not provided, falls back to VYBIT_API_KEY environment variable
+     * @throws {VybitValidationError} When API key is not provided and VYBIT_API_KEY environment variable is not set
+     */
+    constructor(config?: VybitAPIConfig);
+    private request;
+    private buildQueryParams;
+    /**
+     * Check API health status
+     * @returns API status response
+     */
+    getStatus(): Promise<StatusResponse>;
+    /**
+     * Get usage metrics and tier limits
+     * @returns Usage statistics and capacity limits
+     */
+    getMeter(): Promise<Meter>;
+    /**
+     * Get user profile information
+     * @returns User profile data
+     */
+    getProfile(): Promise<Profile>;
+    /**
+     * List vybits owned by the authenticated user
+     * @param params - Pagination and search parameters
+     * @returns Array of vybits
+     */
+    listVybits(params?: SearchParams): Promise<Vybit[]>;
+    /**
+     * Get a specific vybit by key
+     * @param key - Vybit key
+     * @returns Vybit details
+     */
+    getVybit(key: string): Promise<Vybit>;
+    /**
+     * Create a new vybit
+     * @param params - Vybit creation parameters
+     * @returns Created vybit
+     */
+    createVybit(params: VybitCreateParams): Promise<Vybit>;
+    /**
+     * Update a vybit (full update)
+     * @param key - Vybit key
+     * @param params - Vybit update parameters
+     * @returns Updated vybit
+     */
+    updateVybit(key: string, params: VybitUpdateParams): Promise<Vybit>;
+    /**
+     * Update a vybit (partial update)
+     * @param key - Vybit key
+     * @param params - Vybit update parameters
+     * @returns Updated vybit
+     */
+    patchVybit(key: string, params: VybitUpdateParams): Promise<Vybit>;
+    /**
+     * Delete a vybit
+     * @param key - Vybit key
+     * @returns Delete confirmation
+     */
+    deleteVybit(key: string): Promise<DeleteResponse>;
+    /**
+     * Trigger a vybit notification as the owner
+     * @param key - Vybit key
+     * @param params - Optional notification content to override defaults
+     * @returns Trigger response with log key
+     *
+     * @example
+     * ```typescript
+     * const result = await client.triggerVybit('vybit123abc', {
+     *   message: 'Server maintenance complete',
+     *   imageUrl: 'https://example.com/status-ok.jpg'
+     * });
+     * console.log('Notification triggered, log key:', result.plk);
+     * ```
+     */
+    triggerVybit(key: string, params?: VybitTriggerParams): Promise<VybitTriggerResponse>;
+    /**
+     * List public vybits available for subscription
+     * @param params - Pagination and search parameters
+     * @returns Array of public vybits
+     */
+    listPublicVybits(params?: SearchParams): Promise<PublicVybit[]>;
+    /**
+     * Get a public vybit by subscription key
+     * @param key - Subscription key
+     * @returns Public vybit details
+     */
+    getPublicVybit(key: string): Promise<PublicVybit>;
+    /**
+     * List vybit subscriptions (follows)
+     * @param params - Pagination and search parameters
+     * @returns Array of vybit follows
+     */
+    listVybitFollows(params?: SearchParams): Promise<VybitFollow[]>;
+    /**
+     * Get a specific vybit follow by key
+     * @param key - Vybit follow (following) key
+     * @returns Vybit follow details
+     */
+    getVybitFollow(key: string): Promise<VybitFollow>;
+    /**
+     * Subscribe to a vybit using its subscription key
+     * @param subscriptionKey - The subscription key of the vybit to subscribe to
+     * @returns Created vybit follow
+     */
+    createVybitFollow(subscriptionKey: string): Promise<any>;
+    /**
+     * Update a vybit subscription
+     * @param key - Vybit follow (following) key
+     * @param params - Update parameters
+     * @returns Updated vybit follow
+     */
+    updateVybitFollow(key: string, params: VybitFollowUpdateParams): Promise<VybitFollow>;
+    /**
+     * Unsubscribe from a vybit (delete follow)
+     * @param key - Vybit follow (following) key
+     * @returns Delete confirmation
+     */
+    deleteVybitFollow(key: string): Promise<DeleteResponse>;
+    /**
+     * Send a notification to the owner of a subscribed vybit
+     *
+     * Only available when the vybit's sendPermissions is set to 'subs_owner'.
+     * The subscription must be active (status='on') and granted access.
+     *
+     * @param followingKey - Vybit following key
+     * @param params - Notification content
+     * @returns Send response with log key
+     * @throws {VybitAPIError} 403 if vybit doesn't allow subscriber-to-owner sends
+     *
+     * @example
+     * ```typescript
+     * const result = await client.sendToOwner('following123abc', {
+     *   message: 'Server is back online',
+     *   linkUrl: 'https://example.com/dashboard'
+     * });
+     * console.log('Notification sent, log key:', result.plk);
+     * ```
+     */
+    sendToOwner(followingKey: string, params?: SubscriberSendParams): Promise<SubscriberSendResponse>;
+    /**
+     * Send a notification to all subscribers of a vybit group
+     *
+     * Only available when the vybit's sendPermissions is set to 'subs_group'.
+     * The subscription must be active (status='on') and granted access.
+     *
+     * @param followingKey - Vybit following key
+     * @param params - Notification content
+     * @returns Send response with log key
+     * @throws {VybitAPIError} 403 if vybit doesn't allow subscriber-to-group sends
+     *
+     * @example
+     * ```typescript
+     * const result = await client.sendToGroup('following123abc', {
+     *   message: 'Emergency alert: Check the group chat',
+     *   linkUrl: 'https://example.com/chat'
+     * });
+     * console.log('Notification sent to group, log key:', result.plk);
+     * ```
+     */
+    sendToGroup(followingKey: string, params?: SubscriberSendParams): Promise<SubscriberSendResponse>;
+    /**
+     * Search for sounds
+     * @param params - Pagination and search parameters
+     * @returns Array of sounds
+     */
+    searchSounds(params?: SearchParams): Promise<Sound[]>;
+    /**
+     * Get a specific sound by key
+     * @param key - Sound key
+     * @returns Sound details
+     */
+    getSound(key: string): Promise<Sound>;
+    /**
+     * Get the playback URL for a sound
+     * @param key - Sound key
+     * @returns Full URL to play/download the sound
+     */
+    getSoundPlayUrl(key: string): string;
+    /**
+     * List all notification logs for the authenticated user
+     * @param params - Pagination and search parameters
+     * @returns Array of logs
+     */
+    listLogs(params?: SearchParams): Promise<Log[]>;
+    /**
+     * Get a specific log entry by key
+     * @param logKey - Log entry key
+     * @returns Log entry details
+     */
+    getLog(logKey: string): Promise<Log>;
+    /**
+     * List logs for a specific owned vybit
+     * @param vybKey - Vybit key
+     * @param params - Pagination and search parameters
+     * @returns Array of logs for the vybit
+     */
+    listVybitLogs(vybKey: string, params?: SearchParams): Promise<Log[]>;
+    /**
+     * List logs for a specific vybit subscription
+     * @param followingKey - Vybit following key
+     * @param params - Pagination and search parameters
+     * @returns Array of logs for the subscription
+     */
+    listVybitFollowLogs(followingKey: string, params?: SearchParams): Promise<Log[]>;
+    /**
+     * List peeps (access invitations)
+     * @param params - Pagination parameters
+     * @returns Array of peeps
+     */
+    listPeeps(params?: PaginationParams): Promise<Peep[]>;
+    /**
+     * Get a specific peep by key
+     * @param key - Peep key
+     * @returns Peep details
+     */
+    getPeep(key: string): Promise<Peep>;
+    /**
+     * Create a peep invitation
+     * @param vybitKey - The vybit key to invite the user to
+     * @param email - Email address of the user to invite
+     * @returns Created peep response
+     */
+    createPeep(vybitKey: string, email: string): Promise<any>;
+    /**
+     * Remove a peep invitation
+     * @param key - Peep key
+     * @returns Delete confirmation
+     */
+    deletePeep(key: string): Promise<DeleteResponse>;
     /**
-     * Placeholder method - will be implemented in future release
+     * List peeps for a specific vybit
+     * @param vybitKey - Vybit key
+     * @param params - Pagination parameters
+     * @returns Array of peeps for the vybit
      */
-    placeholder(): Promise<PlaceholderResponse>;
+    listVybitPeeps(vybitKey: string, params?: PaginationParams): Promise<Peep[]>;
 }
 //# sourceMappingURL=api-client.d.ts.map

package/dist/api-client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"api-client.d.ts","sourceRoot":"","sources":["../src/api-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAE9C;;;;;;;;GAQG;AACH,qBAAa,cAAc;;IAQzB;;OAEG;IACG,WAAW,IAAI,OAAO,CAAC,mBAAmB,CAAC;CAKlD"}
+{"version":3,"file":"api-client.d.ts","sourceRoot":"","sources":["../src/api-client.ts"],"names":[],"mappings":"AAMA,OAAO,EACL,cAAc,EACd,gBAAgB,EAChB,YAAY,EACZ,cAAc,EACd,OAAO,EACP,KAAK,EACL,KAAK,EACL,iBAAiB,EACjB,iBAAiB,EACjB,kBAAkB,EAClB,oBAAoB,EACpB,WAAW,EACX,uBAAuB,EACvB,WAAW,EACX,oBAAoB,EACpB,sBAAsB,EACtB,KAAK,EACL,GAAG,EACH,IAAI,EACJ,cAAc,EACf,MAAM,SAAS,CAAC;AAEjB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,qBAAa,cAAc;IACzB,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,OAAO,CAAS;IAExB;;;;OAIG;gBACS,MAAM,GAAE,cAAmB;YAczB,OAAO;IAoDrB,OAAO,CAAC,gBAAgB;IAcxB;;;OAGG;IACG,SAAS,IAAI,OAAO,CAAC,cAAc,CAAC;IAI1C;;;OAGG;IACG,QAAQ,IAAI,OAAO,CAAC,KAAK,CAAC;IAMhC;;;OAGG;IACG,UAAU,IAAI,OAAO,CAAC,OAAO,CAAC;IAMpC;;;;OAIG;IACG,UAAU,CAAC,MAAM,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;IAKzD;;;;OAIG;IACG,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;IAI3C;;;;OAIG;IACG,WAAW,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,KAAK,CAAC;IAO5D;;;;;OAKG;IACG,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,KAAK,CAAC;IAOzE;;;;;OAKG;IACG,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,KAAK,CAAC;IAOxE;;;;OAIG;IACG,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IAMvD;;;;;;;;;;;;;;OAcG;IACG,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAS3F;;;;OAIG;IACG,gBAAgB,CAAC,MAAM,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;IAKrE;;;;OAIG;IACG,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAMvD;;;;OAIG;IACG,gBAAgB,CAAC,MAAM,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;IAKrE;;;;OAIG;IACG,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAIvD;;;;OAIG;IACG,iBAAiB,CAAC,eAAe,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAM9D;;;;;OAKG;IACG,iBAAiB,CACrB,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,uBAAuB,GAC9B,OAAO,CAAC,WAAW,CAAC;IAOvB;;;;OAIG;IACG,iBAAiB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IAM7D;;;;;;;;;;;;;;;;;;;OAmBG;IACG,WAAW,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAOvG;;;;;;;;;;;;;;;;;;;OAmBG;IACG,WAAW,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,sBAAsB,CAAC;IASvG;;;;OAIG;IACG,YAAY,CAAC,MAAM,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;IAK3D;;;;OAIG;IACG,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;IAI3C;;;;OAIG;IACH,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM;IAMpC;;;;OAIG;IACG,QAAQ,CAAC,MAAM,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IAKrD;;;;OAIG;IACG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAI1C;;;;;OAKG;IACG,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IAK1E;;;;;OAKG;IACG,mBAAmB,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IAOtF;;;;OAIG;IACG,SAAS,CAAC,MAAM,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;IAK3D;;;;OAIG;IACG,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIzC;;;;;OAKG;IACG,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAO/D;;;;OAIG;IACG,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IAMtD;;;;;OAKG;IACG,cAAc,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;CAInF"}