@zapier/zapier-sdk-cli 0.44.1 → 0.45.0

package/dist/sdk-B3nKAZdN.d.mts

@@ -0,0 +1,516 @@
+import * as _zapier_zapier_sdk from '@zapier/zapier-sdk';
+import { AppItem, Manifest, ZapierSdk } from '@zapier/zapier-sdk';
+import { z } from 'zod';
+
+declare const BuildManifestSchema: z.ZodObject<{
+    apps: z.ZodArray<z.ZodString>;
+    skipWrite: z.ZodOptional<z.ZodBoolean>;
+    configPath: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+type BuildManifestOptions = z.infer<typeof BuildManifestSchema> & {
+    onProgress?: (event: ManifestBuildProgressEvent) => void;
+};
+type ManifestBuildProgressEvent = {
+    type: "apps_lookup_start";
+    count: number;
+} | {
+    type: "app_found";
+    app: AppItem;
+} | {
+    type: "apps_lookup_complete";
+    count: number;
+} | {
+    type: "app_processing_start";
+    app: string;
+    slug?: string;
+} | {
+    type: "manifest_entry_built";
+    app: string;
+    manifestKey: string;
+    version: string;
+} | {
+    type: "manifest_updated";
+    app: string;
+    manifestKey: string;
+    version: string;
+} | {
+    type: "app_processing_complete";
+    app: string;
+} | {
+    type: "app_processing_error";
+    app: string;
+    error: string;
+};
+interface BuildManifestResult {
+    manifest?: Manifest;
+}
+
+declare const buildManifestPlugin: (sdk: {
+    listApps: (options?: ({
+        search?: string | undefined;
+        apps?: string[] | undefined;
+        appKeys?: string[] | undefined;
+        pageSize?: number | undefined;
+        maxItems?: number | undefined;
+        cursor?: string | undefined;
+    } & {
+        cursor?: string;
+        pageSize?: number;
+        maxItems?: number;
+    }) | undefined) => _zapier_zapier_sdk.PaginatedSdkResult<{
+        slug: string;
+        title: string;
+        key: string;
+        implementation_id: string;
+        description?: string | undefined;
+        is_hidden?: boolean | undefined;
+        auth_type?: string | undefined;
+        actions?: {
+            read?: number | undefined;
+            read_bulk?: number | undefined;
+            write?: number | undefined;
+            search?: number | undefined;
+            search_or_write?: number | undefined;
+            search_and_write?: number | undefined;
+            filter?: number | undefined;
+        } | undefined;
+        is_deprecated?: boolean | undefined;
+        is_beta?: boolean | undefined;
+        is_premium?: boolean | undefined;
+        age_in_days?: number | undefined;
+        banner?: string | undefined;
+        categories?: {
+            id: number;
+            name: string;
+            slug: string;
+        }[] | undefined;
+        images?: {
+            url_16x16?: string | undefined;
+            url_32x32?: string | undefined;
+            url_64x64?: string | undefined;
+            url_128x128?: string | undefined;
+        } | undefined;
+        popularity?: number | undefined;
+        has_filters?: boolean | undefined;
+        has_reads?: boolean | undefined;
+        has_searches?: boolean | undefined;
+        has_searches_or_writes?: boolean | undefined;
+        has_upfront_fields?: boolean | undefined;
+        has_writes?: boolean | undefined;
+        is_built_in?: boolean | undefined;
+        is_featured?: boolean | undefined;
+        is_invite?: boolean | undefined;
+        is_public?: boolean | undefined;
+        is_upcoming?: boolean | undefined;
+        visibility?: string | undefined;
+        primary_color?: string | undefined;
+        secondary_color?: string | undefined;
+        classification?: string | undefined;
+        api_docs_url?: string | undefined;
+        image?: string | undefined;
+        version?: string | undefined;
+    }>;
+} & {
+    context: {
+        meta: {
+            listApps: _zapier_zapier_sdk.PluginMeta;
+        };
+    };
+} & {
+    context: {
+        getResolvedManifest: () => Promise<Manifest | null>;
+        getVersionedImplementationId: (appKey: string) => Promise<string | null>;
+        resolveAppKeys: ({ appKeys }: {
+            appKeys: string[];
+        }) => Promise<_zapier_zapier_sdk.ResolvedAppLocator[]>;
+        updateManifestEntry: (options: _zapier_zapier_sdk.UpdateManifestEntryOptions) => Promise<_zapier_zapier_sdk.UpdateManifestEntryResult>;
+        addActionEntry: (options: _zapier_zapier_sdk.AddActionEntryOptions) => Promise<_zapier_zapier_sdk.AddActionEntryResult>;
+        findActionEntry: ({ name, manifest, }: {
+            name: string;
+            manifest: Manifest;
+        }) => _zapier_zapier_sdk.ActionEntry | null;
+        listActionEntries: ({ configPath, }?: {
+            configPath?: string;
+        }) => Promise<Array<[string, _zapier_zapier_sdk.ActionEntry]>>;
+        deleteActionEntry: ({ name, configPath, skipWrite, }: {
+            name: string;
+            configPath?: string;
+            skipWrite?: boolean;
+        }) => Promise<Manifest>;
+        hasActionEntry: ({ name, manifest, }: {
+            name: string;
+            manifest: Manifest;
+        }) => boolean;
+        findManifestEntry: typeof _zapier_zapier_sdk.findManifestEntry;
+        readManifestFromFile: typeof _zapier_zapier_sdk.readManifestFromFile;
+        getManifestConnections: () => Promise<Record<string, {
+            connectionId: string | number;
+        }> | null>;
+    };
+} & {
+    context: _zapier_zapier_sdk.EventEmissionContext;
+} & {
+    context: {
+        meta: Record<string, _zapier_zapier_sdk.PluginMeta>;
+    };
+}) => {
+    buildManifest: (options?: BuildManifestOptions | undefined) => Promise<BuildManifestResult>;
+} & {
+    context: {
+        meta: {
+            buildManifest: _zapier_zapier_sdk.PluginMeta;
+        };
+    };
+};
+type BuildManifestPluginProvides = ReturnType<typeof buildManifestPlugin>;
+
+declare const feedbackPlugin: (sdk: {
+    context: {
+        options?: {
+            debug?: boolean;
+        };
+    };
+} & {
+    context: _zapier_zapier_sdk.EventEmissionContext;
+} & {
+    context: {
+        meta: Record<string, _zapier_zapier_sdk.PluginMeta>;
+    };
+}) => {
+    feedback: (options?: {
+        feedback: string;
+    } | undefined) => Promise<string>;
+} & {
+    context: {
+        meta: {
+            feedback: _zapier_zapier_sdk.PluginMeta;
+        };
+    };
+};
+type FeedbackPluginProvides = ReturnType<typeof feedbackPlugin>;
+
+declare const GenerateAppTypesSchema: z.ZodObject<{
+    apps: z.ZodArray<z.ZodString>;
+    connections: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    skipWrite: z.ZodOptional<z.ZodBoolean>;
+    typesOutputDirectory: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+type GenerateAppTypesOptions = z.infer<typeof GenerateAppTypesSchema> & {
+    onProgress?: (event: AppTypesProgressEvent) => void;
+};
+type AppTypesProgressEvent = {
+    type: "apps_lookup_start";
+    count: number;
+} | {
+    type: "app_found";
+    app: AppItem;
+} | {
+    type: "apps_lookup_complete";
+    count: number;
+} | {
+    type: "connections_lookup_start";
+    count: number;
+} | {
+    type: "connections_lookup_complete";
+    count: number;
+} | {
+    type: "app_processing_start";
+    app: string;
+    slug?: string;
+} | {
+    type: "connection_matched";
+    app: string;
+    connectionId: string;
+    connectionTitle: string;
+} | {
+    type: "connection_not_matched";
+    app: string;
+} | {
+    type: "type_generated";
+    manifestKey: string;
+    sizeBytes: number;
+} | {
+    type: "file_written";
+    manifestKey: string;
+    filePath: string;
+} | {
+    type: "app_processing_complete";
+    app: string;
+} | {
+    type: "app_processing_error";
+    app: string;
+    error: string;
+};
+interface GenerateAppTypesResult {
+    typeDefinitions: Record<string, string>;
+    writtenFiles?: Record<string, string>;
+}
+
+declare const generateAppTypesPlugin: (sdk: {
+    listApps: (options?: ({
+        search?: string | undefined;
+        apps?: string[] | undefined;
+        appKeys?: string[] | undefined;
+        pageSize?: number | undefined;
+        maxItems?: number | undefined;
+        cursor?: string | undefined;
+    } & {
+        cursor?: string;
+        pageSize?: number;
+        maxItems?: number;
+    }) | undefined) => _zapier_zapier_sdk.PaginatedSdkResult<{
+        slug: string;
+        title: string;
+        key: string;
+        implementation_id: string;
+        description?: string | undefined;
+        is_hidden?: boolean | undefined;
+        auth_type?: string | undefined;
+        actions?: {
+            read?: number | undefined;
+            read_bulk?: number | undefined;
+            write?: number | undefined;
+            search?: number | undefined;
+            search_or_write?: number | undefined;
+            search_and_write?: number | undefined;
+            filter?: number | undefined;
+        } | undefined;
+        is_deprecated?: boolean | undefined;
+        is_beta?: boolean | undefined;
+        is_premium?: boolean | undefined;
+        age_in_days?: number | undefined;
+        banner?: string | undefined;
+        categories?: {
+            id: number;
+            name: string;
+            slug: string;
+        }[] | undefined;
+        images?: {
+            url_16x16?: string | undefined;
+            url_32x32?: string | undefined;
+            url_64x64?: string | undefined;
+            url_128x128?: string | undefined;
+        } | undefined;
+        popularity?: number | undefined;
+        has_filters?: boolean | undefined;
+        has_reads?: boolean | undefined;
+        has_searches?: boolean | undefined;
+        has_searches_or_writes?: boolean | undefined;
+        has_upfront_fields?: boolean | undefined;
+        has_writes?: boolean | undefined;
+        is_built_in?: boolean | undefined;
+        is_featured?: boolean | undefined;
+        is_invite?: boolean | undefined;
+        is_public?: boolean | undefined;
+        is_upcoming?: boolean | undefined;
+        visibility?: string | undefined;
+        primary_color?: string | undefined;
+        secondary_color?: string | undefined;
+        classification?: string | undefined;
+        api_docs_url?: string | undefined;
+        image?: string | undefined;
+        version?: string | undefined;
+    }>;
+} & {
+    context: {
+        meta: {
+            listApps: _zapier_zapier_sdk.PluginMeta;
+        };
+    };
+} & {
+    listActions: (options?: (({
+        app: string;
+        actionType?: "filter" | "read" | "read_bulk" | "run" | "search" | "search_and_write" | "search_or_write" | "write" | undefined;
+        pageSize?: number | undefined;
+        maxItems?: number | undefined;
+        cursor?: string | undefined;
+    } | {
+        appKey: string;
+        actionType?: "filter" | "read" | "read_bulk" | "run" | "search" | "search_and_write" | "search_or_write" | "write" | undefined;
+        pageSize?: number | undefined;
+        maxItems?: number | undefined;
+        cursor?: string | undefined;
+    }) & {
+        cursor?: string;
+        pageSize?: number;
+        maxItems?: number;
+    }) | undefined) => _zapier_zapier_sdk.PaginatedSdkResult<{
+        description: string;
+        key: string;
+        app_key: string;
+        action_type: "filter" | "read" | "read_bulk" | "run" | "search" | "search_and_write" | "search_or_write" | "write";
+        title: string;
+        type: "action";
+        id?: string | undefined;
+        is_important?: boolean | undefined;
+        is_hidden?: boolean | undefined;
+        app_version?: string | undefined;
+    }>;
+} & {
+    context: {
+        meta: {
+            listActions: _zapier_zapier_sdk.PluginMeta;
+        };
+    };
+} & {
+    listActionInputFields: (options?: (({
+        app: string;
+        actionType: "filter" | "read" | "read_bulk" | "run" | "search" | "search_and_write" | "search_or_write" | "write";
+        action: string;
+        connection?: string | number | undefined;
+        connectionId?: string | number | null | undefined;
+        authenticationId?: string | number | null | undefined;
+        inputs?: Record<string, unknown> | undefined;
+        pageSize?: number | undefined;
+        maxItems?: number | undefined;
+        cursor?: string | undefined;
+    } | {
+        appKey: string;
+        actionType: "filter" | "read" | "read_bulk" | "run" | "search" | "search_and_write" | "search_or_write" | "write";
+        actionKey: string;
+        connection?: string | number | undefined;
+        connectionId?: string | number | null | undefined;
+        authenticationId?: string | number | null | undefined;
+        inputs?: Record<string, unknown> | undefined;
+        pageSize?: number | undefined;
+        maxItems?: number | undefined;
+        cursor?: string | undefined;
+    }) & {
+        cursor?: string;
+        pageSize?: number;
+        maxItems?: number;
+    }) | undefined) => _zapier_zapier_sdk.PaginatedSdkResult<{
+        key: string;
+        type: "input_field";
+        default_value: string;
+        depends_on: string[];
+        description: string;
+        invalidates_input_fields: boolean;
+        is_required: boolean;
+        placeholder: string;
+        title: string;
+        value_type: string;
+        format?: string | undefined;
+        items?: {
+            type: string;
+        } | undefined;
+    } | {
+        key: string;
+        type: "info_field";
+        description: string;
+        title?: string | undefined;
+    } | _zapier_zapier_sdk.FieldsetItem>;
+} & {
+    context: {
+        meta: {
+            listActionInputFields: _zapier_zapier_sdk.PluginMeta;
+        };
+    };
+} & {
+    listConnections: (options?: ({
+        title?: string | undefined;
+        search?: string | undefined;
+        owner?: string | undefined;
+        app?: string | undefined;
+        appKey?: string | undefined;
+        connections?: string[] | undefined;
+        connectionIds?: string[] | undefined;
+        authenticationIds?: string[] | undefined;
+        account?: string | undefined;
+        accountId?: string | undefined;
+        includeShared?: boolean | undefined;
+        isExpired?: boolean | undefined;
+        expired?: boolean | undefined;
+        pageSize?: number | undefined;
+        maxItems?: number | undefined;
+        cursor?: string | undefined;
+    } & {
+        cursor?: string;
+        pageSize?: number;
+        maxItems?: number;
+    }) | undefined) => _zapier_zapier_sdk.PaginatedSdkResult<{
+        date: string;
+        is_invite_only: boolean;
+        is_private: boolean;
+        shared_with_all: boolean;
+        id: string;
+        account_id: string;
+        title?: string | null | undefined;
+        lastchanged?: string | undefined;
+        destination_selected_api?: string | null | undefined;
+        is_stale?: string | undefined;
+        is_shared?: string | undefined;
+        marked_stale_at?: string | null | undefined;
+        label?: string | null | undefined;
+        identifier?: string | null | undefined;
+        url?: string | undefined;
+        groups?: Record<string, unknown>[] | undefined;
+        members?: string | undefined;
+        permissions?: Record<string, boolean> | undefined;
+        public_id?: string | undefined;
+        account_public_id?: string | undefined;
+        customuser_public_id?: string | undefined;
+        implementation_id?: string | undefined;
+        profile_id?: string | undefined;
+        is_expired?: string | undefined;
+        expired_at?: string | null | undefined;
+        app_key?: string | undefined;
+        app_version?: string | undefined;
+    }>;
+} & {
+    context: {
+        meta: {
+            listConnections: _zapier_zapier_sdk.PluginMeta;
+        };
+    };
+} & {
+    context: {
+        getResolvedManifest: () => Promise<_zapier_zapier_sdk.Manifest | null>;
+        getVersionedImplementationId: (appKey: string) => Promise<string | null>;
+        resolveAppKeys: ({ appKeys }: {
+            appKeys: string[];
+        }) => Promise<_zapier_zapier_sdk.ResolvedAppLocator[]>;
+        updateManifestEntry: (options: _zapier_zapier_sdk.UpdateManifestEntryOptions) => Promise<_zapier_zapier_sdk.UpdateManifestEntryResult>;
+        addActionEntry: (options: _zapier_zapier_sdk.AddActionEntryOptions) => Promise<_zapier_zapier_sdk.AddActionEntryResult>;
+        findActionEntry: ({ name, manifest, }: {
+            name: string;
+            manifest: _zapier_zapier_sdk.Manifest;
+        }) => _zapier_zapier_sdk.ActionEntry | null;
+        listActionEntries: ({ configPath, }?: {
+            configPath?: string;
+        }) => Promise<Array<[string, _zapier_zapier_sdk.ActionEntry]>>;
+        deleteActionEntry: ({ name, configPath, skipWrite, }: {
+            name: string;
+            configPath?: string;
+            skipWrite?: boolean;
+        }) => Promise<_zapier_zapier_sdk.Manifest>;
+        hasActionEntry: ({ name, manifest, }: {
+            name: string;
+            manifest: _zapier_zapier_sdk.Manifest;
+        }) => boolean;
+        findManifestEntry: typeof _zapier_zapier_sdk.findManifestEntry;
+        readManifestFromFile: typeof _zapier_zapier_sdk.readManifestFromFile;
+        getManifestConnections: () => Promise<Record<string, {
+            connectionId: string | number;
+        }> | null>;
+    };
+} & {
+    context: _zapier_zapier_sdk.EventEmissionContext;
+} & {
+    context: {
+        meta: Record<string, _zapier_zapier_sdk.PluginMeta>;
+    };
+}) => {
+    generateAppTypes: (options?: GenerateAppTypesOptions | undefined) => Promise<GenerateAppTypesResult>;
+} & {
+    context: {
+        meta: {
+            generateAppTypes: _zapier_zapier_sdk.PluginMeta;
+        };
+    };
+};
+type GenerateAppTypesPluginProvides = ReturnType<typeof generateAppTypesPlugin>;
+
+type ZapierSdkCli = ZapierSdk & BuildManifestPluginProvides & FeedbackPluginProvides & GenerateAppTypesPluginProvides;
+
+export type { ZapierSdkCli as Z };