@bundleup/sdk 0.0.18 → 0.1.0

package/dist/index.d.ts

@@ -1,86 +1,3 @@
-declare abstract class Base$1<T> {
-    private apiKey;
-    protected abstract namespace: string;
-    private baseUrl;
-    private version;
-    constructor(apiKey: string);
-    protected buildUrl(path?: string | null, searchParams?: Record<string, string>): URL;
-    protected get headers(): Record<string, string>;
-    /**
-     * List resources with optional query parameters.
-     * @param searchParams - 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, string>>(searchParams?: 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, unknown>>(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, unknown>>(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>;
-}
-
-interface Connection {
-    id: string;
-    externalId?: string;
-    expiresAt: Date;
-    integrationId: string;
-    isValid: boolean;
-    refreshedAt?: Date;
-    createdAt: Date;
-    updatedAt: Date;
-}
-declare class Connections extends Base$1<Connection> {
-    protected namespace: string;
-}
-
-interface Integration {
-    id: string;
-    identifier: string;
-    createdAt: Date;
-    updatedAt: Date;
-}
-declare class Integrations extends Base$1<Integration> {
-    protected namespace: string;
-}
-
-interface Webhook {
-    id: string;
-    name: string;
-    url: string;
-    events: Record<string, boolean>;
-    createdAt: Date;
-    updatedAt: Date;
-    lastTriggeredAt?: Date;
-}
-declare class Webhooks extends Base$1<Webhook> {
-    protected namespace: string;
-}
-
 declare class Proxy {
     private apiKey;
     private connectionId;
@@ -98,7 +15,7 @@ declare class Proxy {
 interface Params {
     limit?: number;
     after?: string;
-    includeRaw?: boolean;
+    include_raw?: boolean;
 }
 interface Response$1<T> {
     data: T;
@@ -107,27 +24,27 @@ interface Response$1<T> {
         next: string | null;
     };
 }
-declare abstract class Base {
+declare abstract class Base$1 {
     private apiKey;
     private connectionId;
     private baseUrl;
     private version;
     protected abstract namespace: string;
     protected get headers(): Record<string, string>;
-    protected buildUrl(path?: string | null, searchParams?: Record<string, string | number | undefined>): URL;
+    protected buildUrl(path?: string | null, searchParams?: Record<string, unknown>): URL;
     constructor(apiKey: string, connectionId: string);
 }
 
-declare class Chat extends Base {
+declare class Chat extends Base$1 {
     protected namespace: string;
     /**
      * Fetch chat channels
      * @param limit - Maximum number of channels to retrieve.
      * @param after - Cursor for pagination.
-     * @param includeRaw - Whether to include raw response data.
+     * @param include_raw - Whether to include raw response data.
      * @returns A promise that resolves to the fetch response.
      */
-    channels({ limit, after, includeRaw }?: Params): Promise<Response$1<{
+    channels({ limit, after, include_raw }?: Params): Promise<Response$1<{
         id: string;
         name: string;
     }[]>>;
@@ -136,7 +53,7 @@ declare class Chat extends Base {
 interface RepoParams extends Params {
     repoName: string;
 }
-declare class Git extends Base {
+declare class Git extends Base$1 {
     protected namespace: string;
     /**
      * Fetch repositories
@@ -145,7 +62,7 @@ declare class Git extends Base {
      * @param includeRaw - Whether to include raw response data.
      * @returns A promise that resolves to the fetch response.
      */
-    repos({ limit, after, includeRaw }?: Params): Promise<Response$1<{
+    repos({ limit, after, include_raw }?: Params): Promise<Response$1<{
         id: string;
         name: string;
         full_name: string;
@@ -160,11 +77,11 @@ declare class Git extends Base {
      * @param repoName - The name of the repository.
      * @param limit - Maximum number of pull requests to retrieve.
      * @param after - Cursor for pagination.
-     * @param includeRaw - Whether to include raw response data.
+     * @param include_raw - Whether to include raw response data.
      * @returns A promise that resolves to the fetch response.
      * @throws If repoName is not provided.
      */
-    pulls({ repoName, limit, after, includeRaw }: RepoParams): Promise<Response$1<{
+    pulls(repoName: string, { limit, after, include_raw }: RepoParams): Promise<Response$1<{
         id: string;
         number: number;
         title: string;
@@ -182,11 +99,11 @@ declare class Git extends Base {
      * @param repoName - The name of the repository.
      * @param limit - Maximum number of tags to retrieve.
      * @param after - Cursor for pagination.
-     * @param includeRaw - Whether to include raw response data.
+     * @param include_raw - Whether to include raw response data.
      * @returns A promise that resolves to the fetch response.
      * @throws If repoName is not provided.
      */
-    tags({ repoName, limit, after, includeRaw }: RepoParams): Promise<Response$1<{
+    tags(repoName: string, { limit, after, include_raw }: RepoParams): Promise<Response$1<{
         name: string;
         commit_sha: string;
     }[]>>;
@@ -195,11 +112,11 @@ declare class Git extends Base {
      * @param repoName - The name of the repository.
      * @param limit - Maximum number of releases to retrieve.
      * @param after - Cursor for pagination.
-     * @param includeRaw - Whether to include raw response data.
+     * @param include_raw - Whether to include raw response data.
      * @returns A promise that resolves to the fetch response.
      * @throws If repoName is not provided.
      */
-    releases({ repoName, limit, after, includeRaw }: RepoParams): Promise<Response$1<{
+    releases(repoName: string, { limit, after, include_raw }: RepoParams): Promise<Response$1<{
         id: string;
         name: string;
         tag_name: string;
@@ -211,16 +128,16 @@ declare class Git extends Base {
     }[]>>;
 }
 
-declare class PM extends Base {
+declare class PM extends Base$1 {
     protected namespace: string;
     /**
      * Fetch issues
      * @param limit - Maximum number of issues to retrieve.
      * @param after - Cursor for pagination.
-     * @param includeRaw - Whether to include raw response data.
+     * @param include_raw - Whether to include raw response data.
      * @returns A promise that resolves to the fetch response.
      */
-    issues({ limit, after, includeRaw }?: Params): Promise<Response$1<{
+    issues({ limit, after, include_raw }?: Params): Promise<Response$1<{
         id: string;
         url: string;
         title: string;
@@ -231,6 +148,209 @@ declare class PM extends Base {
     }[]>>;
 }
 
+declare class Unify {
+    private apiKey;
+    private connectionId;
+    constructor(apiKey: string, connectionId: string);
+    /**
+     * Access the Chat API for the connection.
+     */
+    get chat(): Chat;
+    /**
+     * Access the Git API for the connection.
+     */
+    get git(): Git;
+    /**
+     * Access the PM API for the connection.
+     */
+    get pm(): PM;
+}
+
+declare abstract class Base<T> {
+    private apiKey;
+    protected abstract namespace: string;
+    private baseUrl;
+    private version;
+    constructor(apiKey: string);
+    private buildUrl;
+    private get headers();
+    /**
+     * List resources with optional query parameters.
+     * @param searchParams - 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.
+     */
+    protected list(searchParams?: Record<string, unknown>): 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.
+     */
+    protected create(body: Record<string, unknown>): 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.
+     */
+    protected 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.
+     */
+    protected update(id: string, body: Record<string, unknown>): 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.
+     */
+    protected del(id: string): Promise<void>;
+}
+
+interface Connection {
+    id: string;
+    externalId?: string;
+    expiresAt: Date;
+    integrationId: string;
+    isValid: boolean;
+    refreshedAt?: Date;
+    createdAt: Date;
+    updatedAt: Date;
+}
+interface ConnectionListParams {
+    offset: number;
+    limit: number;
+    integration_id: string;
+    integration_identifier: string;
+    external_id: string;
+}
+declare class Connections extends Base<Connection> {
+    protected namespace: string;
+    /**
+     * List all connections with optional query parameters.
+     * @param searchParams - Query parameters for filtering the list of connections.
+     *   - offset: The number of items to skip before starting to collect the result set.
+     *   - limit: The number of items to return.
+     *   - integration_id: Filter connections by integration ID.
+     *   - integration_identifier: Filter connections by integration identifier.
+     *   - external_id: Filter connections by external ID.
+     * @returns A promise that resolves to an array of connection objects.
+     * @throws If the fetch request fails or if the search parameters are invalid.
+     */
+    list(searchParams?: Partial<ConnectionListParams>): Promise<Connection[]>;
+    /**
+     * Retrieve a specific connection by ID.
+     * @param id - The ID of the connection to retrieve.
+     * @returns A promise that resolves to the connection object.
+     * @throws If the fetch request fails or if the ID is invalid.
+     */
+    retrieve(id: string): Promise<Connection>;
+    /**
+     * Delete a specific connection by ID.
+     * @param id - The ID of the connection to delete.
+     * @returns A promise that resolves when the connection is deleted.
+     * @throws If the fetch request fails or if the ID is invalid.
+     */
+    del(id: string): Promise<void>;
+}
+
+interface Integration {
+    id: string;
+    identifier: string;
+    createdAt: Date;
+    updatedAt: Date;
+}
+interface IntegrationListParams {
+    offset: number;
+    limit: number;
+    status: string;
+}
+declare class Integrations extends Base<Integration> {
+    protected namespace: string;
+    /**
+     * List all integrations with optional query parameters.
+     * @param searchParams - Query parameters for filtering the list of integrations.
+     *   - offset: The number of items to skip before starting to collect the result set.
+     *   - limit: The number of items to return.
+     *   - status: Filter integrations by status (e.g., 'active', 'inactive').
+     * @returns A promise that resolves to an array of integration objects.
+     * @throws If the fetch request fails or if the search parameters are invalid.
+     */
+    list(searchParams?: Partial<IntegrationListParams>): Promise<Integration[]>;
+    /**
+     * Retrieve a specific integration by ID.
+     * @param id - The ID of the integration to retrieve.
+     * @returns A promise that resolves to the integration object.
+     * @throws If the fetch request fails or if the ID is invalid.
+     */
+    retrieve(id: string): Promise<Integration>;
+}
+
+interface Webhook {
+    id: string;
+    name: string;
+    url: string;
+    events: Record<string, boolean>;
+    createdAt: Date;
+    updatedAt: Date;
+    lastTriggeredAt?: Date;
+}
+interface WebhookListParams {
+    offset: number;
+    limit: number;
+}
+interface WebhookBody extends Record<string, unknown> {
+    name: string;
+    url: string;
+    events: Record<string, boolean>;
+}
+declare class Webhooks extends Base<Webhook> {
+    protected namespace: string;
+    /**
+     * List all webhooks with optional query parameters.
+     * @param searchParams - Query parameters for filtering the list of webhooks.
+     *   - offset: The number of items to skip before starting to collect the result set.
+     *   - limit: The number of items to return.
+     * @returns A promise that resolves to an array of webhook objects.
+     * @throws If the fetch request fails or if the search parameters are invalid.
+     */
+    list(searchParams?: Partial<WebhookListParams>): Promise<Webhook[]>;
+    /**
+     * Retrieve a specific webhook by ID.
+     * @param id - The ID of the webhook to retrieve.
+     * @returns A promise that resolves to the webhook object.
+     * @throws If the fetch request fails or if the ID is invalid.
+     */
+    retrieve(id: string): Promise<Webhook>;
+    /**
+     * Create a new webhook with the specified data.
+     * @param data - An object containing the properties of the webhook to create.
+     * @returns A promise that resolves to the created webhook object.
+     * @throws If the fetch request fails or if the data is invalid.
+     */
+    create(data: WebhookBody): Promise<Webhook>;
+    /**
+     * Update an existing webhook with the specified data.
+     * @param id - The ID of the webhook to update.
+     * @param data - An object containing the properties of the webhook to update.
+     * @returns A promise that resolves to the updated webhook object.
+     * @throws If the fetch request fails, if the ID is invalid, or if the data is invalid.
+     */
+    update(id: string, data: WebhookBody): Promise<Webhook>;
+    /**
+     * Delete a specific webhook by ID.
+     * @param id - The ID of the webhook to delete.
+     * @returns A promise that resolves when the webhook is deleted.
+     * @throws If the fetch request fails or if the ID is invalid.
+     */
+    del(id: string): Promise<void>;
+}
+
 declare class BundleUp {
     private apiKey;
     constructor(apiKey: string);
@@ -257,11 +377,7 @@ declare class BundleUp {
      * @param connectionId - The ID of the connection.
      * @returns An object containing Unify methods.
      */
-    unify(connectionId: string): {
-        chat: Chat;
-        git: Git;
-        pm: PM;
-    };
+    unify(connectionId: string): Unify;
 }
 
 export { BundleUp };