@bundleup/sdk 0.0.6 → 0.0.7

package/dist/index.d.mts

@@ -6,10 +6,41 @@ declare abstract class Base<T> {
     constructor(apiKey: string);
     private get apiUrl();
     private get headers();
+    /**
+     * List resources with optional query parameters.
+     * @param params - Query parameters for filtering the list.
+     * @returns A promise that resolves to an array of resources.
+     * @throws If params is not an object or if the fetch request fails.
+     */
     list<K extends Record<string, any>>(params?: K): Promise<T[]>;
+    /**
+     * Create a new resource.
+     * @param body - The request body containing resource details.
+     * @returns A promise that resolves to the created resource.
+     * @throws If body is not an object or if the fetch request fails.
+     */
     create<K extends Record<string, any>>(body: K): Promise<T>;
+    /**
+     * Retrieve a specific resource by ID.
+     * @param id - The ID of the resource to retrieve.
+     * @returns A promise that resolves to the retrieved resource.
+     * @throws If id is not provided or if the fetch request fails.
+     */
     retrieve(id: string): Promise<T>;
+    /**
+     * Update a specific resource by ID.
+     * @param id - The ID of the resource to update.
+     * @param body - The request body containing updated resource details.
+     * @returns A promise that resolves to the updated resource.
+     * @throws If id is not provided, if body is not an object, or if the fetch request fails.
+     */
     update<K extends Record<string, any>>(id: string, body: K): Promise<T>;
+    /**
+     * Delete a specific resource by ID.
+     * @param id - The ID of the resource to delete.
+     * @returns A promise that resolves when the resource is deleted.
+     * @throws If id is not provided or if the fetch request fails.
+     */
     del(id: string): Promise<void>;
 }
 
@@ -28,10 +59,10 @@ declare class Connections extends Base<Connection> {
 }
 
 interface Integration {
-    id: true;
-    identifier: true;
-    createdAt: true;
-    updatedAt: true;
+    id: string;
+    identifier: string;
+    createdAt: Date;
+    updatedAt: Date;
 }
 declare class Integrations extends Base<Integration> {
     protected path: string;
@@ -71,6 +102,14 @@ type ChatMessageRequest = {
 declare class Chat {
     private req;
     constructor(apiKey: string, connectionId: string);
+    /**
+     * Send a chat message to a specific channel.
+     * @param params - The parameters for sending a chat message.
+     * @param params.channelId - The ID of the channel to send the message to.
+     * @param params.content - The content of the chat message.
+     * @returns The response from the API.
+     * @throws If channelId or content is missing.
+     */
     message({ channelId, content }: ChatMessageRequest): Promise<Response>;
 }
 

package/dist/index.d.ts

@@ -6,10 +6,41 @@ declare abstract class Base<T> {
     constructor(apiKey: string);
     private get apiUrl();
     private get headers();
+    /**
+     * List resources with optional query parameters.
+     * @param params - Query parameters for filtering the list.
+     * @returns A promise that resolves to an array of resources.
+     * @throws If params is not an object or if the fetch request fails.
+     */
     list<K extends Record<string, any>>(params?: K): Promise<T[]>;
+    /**
+     * Create a new resource.
+     * @param body - The request body containing resource details.
+     * @returns A promise that resolves to the created resource.
+     * @throws If body is not an object or if the fetch request fails.
+     */
     create<K extends Record<string, any>>(body: K): Promise<T>;
+    /**
+     * Retrieve a specific resource by ID.
+     * @param id - The ID of the resource to retrieve.
+     * @returns A promise that resolves to the retrieved resource.
+     * @throws If id is not provided or if the fetch request fails.
+     */
     retrieve(id: string): Promise<T>;
+    /**
+     * Update a specific resource by ID.
+     * @param id - The ID of the resource to update.
+     * @param body - The request body containing updated resource details.
+     * @returns A promise that resolves to the updated resource.
+     * @throws If id is not provided, if body is not an object, or if the fetch request fails.
+     */
     update<K extends Record<string, any>>(id: string, body: K): Promise<T>;
+    /**
+     * Delete a specific resource by ID.
+     * @param id - The ID of the resource to delete.
+     * @returns A promise that resolves when the resource is deleted.
+     * @throws If id is not provided or if the fetch request fails.
+     */
     del(id: string): Promise<void>;
 }
 
@@ -28,10 +59,10 @@ declare class Connections extends Base<Connection> {
 }
 
 interface Integration {
-    id: true;
-    identifier: true;
-    createdAt: true;
-    updatedAt: true;
+    id: string;
+    identifier: string;
+    createdAt: Date;
+    updatedAt: Date;
 }
 declare class Integrations extends Base<Integration> {
     protected path: string;
@@ -71,6 +102,14 @@ type ChatMessageRequest = {
 declare class Chat {
     private req;
     constructor(apiKey: string, connectionId: string);
+    /**
+     * Send a chat message to a specific channel.
+     * @param params - The parameters for sending a chat message.
+     * @param params.channelId - The ID of the channel to send the message to.
+     * @param params.content - The content of the chat message.
+     * @returns The response from the API.
+     * @throws If channelId or content is missing.
+     */
     message({ channelId, content }: ChatMessageRequest): Promise<Response>;
 }
 

package/dist/index.js

@@ -45,6 +45,12 @@ var Base = class {
       Authorization: `Bearer ${this.apiKey}`
     };
   }
+  /**
+   * List resources with optional query parameters.
+   * @param params - Query parameters for filtering the list.
+   * @returns A promise that resolves to an array of resources.
+   * @throws If params is not an object or if the fetch request fails.
+   */
   async list(params = {}) {
     if (!isObject(params)) {
       throw new Error("List parameters must be an object.");
@@ -62,6 +68,12 @@ var Base = class {
     const data = await response.json();
     return data;
   }
+  /**
+   * Create a new resource.
+   * @param body - The request body containing resource details.
+   * @returns A promise that resolves to the created resource.
+   * @throws If body is not an object or if the fetch request fails.
+   */
   async create(body) {
     if (!isObject(body)) {
       throw new Error("Request body must be an object.");
@@ -77,6 +89,12 @@ var Base = class {
     const data = await response.json();
     return data;
   }
+  /**
+   * Retrieve a specific resource by ID.
+   * @param id - The ID of the resource to retrieve.
+   * @returns A promise that resolves to the retrieved resource.
+   * @throws If id is not provided or if the fetch request fails.
+   */
   async retrieve(id) {
     if (!id) {
       throw new Error("ID is required to retrieve a resource.");
@@ -93,6 +111,13 @@ var Base = class {
     const data = await response.json();
     return data;
   }
+  /**
+   * Update a specific resource by ID.
+   * @param id - The ID of the resource to update.
+   * @param body - The request body containing updated resource details.
+   * @returns A promise that resolves to the updated resource.
+   * @throws If id is not provided, if body is not an object, or if the fetch request fails.
+   */
   async update(id, body) {
     if (!id) {
       throw new Error("ID is required to update a resource.");
@@ -113,6 +138,12 @@ var Base = class {
     const data = await response.json();
     return data;
   }
+  /**
+   * Delete a specific resource by ID.
+   * @param id - The ID of the resource to delete.
+   * @returns A promise that resolves when the resource is deleted.
+   * @throws If id is not provided or if the fetch request fails.
+   */
   async del(id) {
     if (!id) {
       throw new Error("ID is required to delete a resource.");
@@ -268,6 +299,14 @@ var Chat = class {
   constructor(apiKey, connectionId) {
     this.req = new Request(apiKey, connectionId);
   }
+  /**
+   * Send a chat message to a specific channel.
+   * @param params - The parameters for sending a chat message.
+   * @param params.channelId - The ID of the channel to send the message to.
+   * @param params.content - The content of the chat message.
+   * @returns The response from the API.
+   * @throws If channelId or content is missing.
+   */
   message({ channelId, content }) {
     if (!channelId) {
       throw new Error("Channel ID is required to send a chat message.");

package/dist/index.mjs

@@ -19,6 +19,12 @@ var Base = class {
       Authorization: `Bearer ${this.apiKey}`
     };
   }
+  /**
+   * List resources with optional query parameters.
+   * @param params - Query parameters for filtering the list.
+   * @returns A promise that resolves to an array of resources.
+   * @throws If params is not an object or if the fetch request fails.
+   */
   async list(params = {}) {
     if (!isObject(params)) {
       throw new Error("List parameters must be an object.");
@@ -36,6 +42,12 @@ var Base = class {
     const data = await response.json();
     return data;
   }
+  /**
+   * Create a new resource.
+   * @param body - The request body containing resource details.
+   * @returns A promise that resolves to the created resource.
+   * @throws If body is not an object or if the fetch request fails.
+   */
   async create(body) {
     if (!isObject(body)) {
       throw new Error("Request body must be an object.");
@@ -51,6 +63,12 @@ var Base = class {
     const data = await response.json();
     return data;
   }
+  /**
+   * Retrieve a specific resource by ID.
+   * @param id - The ID of the resource to retrieve.
+   * @returns A promise that resolves to the retrieved resource.
+   * @throws If id is not provided or if the fetch request fails.
+   */
   async retrieve(id) {
     if (!id) {
       throw new Error("ID is required to retrieve a resource.");
@@ -67,6 +85,13 @@ var Base = class {
     const data = await response.json();
     return data;
   }
+  /**
+   * Update a specific resource by ID.
+   * @param id - The ID of the resource to update.
+   * @param body - The request body containing updated resource details.
+   * @returns A promise that resolves to the updated resource.
+   * @throws If id is not provided, if body is not an object, or if the fetch request fails.
+   */
   async update(id, body) {
     if (!id) {
       throw new Error("ID is required to update a resource.");
@@ -87,6 +112,12 @@ var Base = class {
     const data = await response.json();
     return data;
   }
+  /**
+   * Delete a specific resource by ID.
+   * @param id - The ID of the resource to delete.
+   * @returns A promise that resolves when the resource is deleted.
+   * @throws If id is not provided or if the fetch request fails.
+   */
   async del(id) {
     if (!id) {
       throw new Error("ID is required to delete a resource.");
@@ -242,6 +273,14 @@ var Chat = class {
   constructor(apiKey, connectionId) {
     this.req = new Request(apiKey, connectionId);
   }
+  /**
+   * Send a chat message to a specific channel.
+   * @param params - The parameters for sending a chat message.
+   * @param params.channelId - The ID of the channel to send the message to.
+   * @param params.content - The content of the chat message.
+   * @returns The response from the API.
+   * @throws If channelId or content is missing.
+   */
   message({ channelId, content }) {
     if (!channelId) {
       throw new Error("Channel ID is required to send a chat message.");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bundleup/sdk",
-  "version": "0.0.6",
+  "version": "0.0.7",
   "description": "SDK package for BundleUp",
   "exports": {
     ".": {