@zapier/zapier-sdk-cli 0.64.0 → 0.65.0

package/dist/extensions-GB0w0RUO.d.ts

@@ -0,0 +1,533 @@
+import * as _zapier_zapier_sdk from '@zapier/zapier-sdk';
+import { AppItem, Manifest, PluginSurface, ZapierSdk, Plugin, PluginProvides } from '@zapier/zapier-sdk';
+import * as zod from 'zod';
+import { z } from 'zod';
+import * as zod_v4_core from 'zod/v4/core';
+
+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: _zapier_zapier_sdk.MethodPlugin<"buildManifest", BuildManifestOptions, Promise<BuildManifestResult>, readonly []> & _zapier_zapier_sdk.LeafSummary<"", "buildManifest", readonly [_zapier_zapier_sdk.MethodPlugin<"listApps", ({
+    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;
+}>, readonly []> & _zapier_zapier_sdk.PluginSummary<"listApps", never>, _zapier_zapier_sdk.PropertyPlugin<"manifest", _zapier_zapier_sdk.ManifestProvider> & _zapier_zapier_sdk.PluginSummary<"zapier/manifest", never>]>;
+type BuildManifestPluginProvides = PluginSurface<typeof buildManifestPlugin>;
+
+declare const feedbackPlugin: _zapier_zapier_sdk.MethodPlugin<"feedback", {
+    feedback: string;
+}, Promise<string>, readonly []> & _zapier_zapier_sdk.LeafSummary<"", "feedback", readonly [_zapier_zapier_sdk.PropertyPlugin<"sdkOptions", {
+    credentials?: string | {
+        clientId: string;
+        clientSecret: string;
+        type?: "client_credentials" | undefined;
+        baseUrl?: string | undefined;
+        scope?: string | undefined;
+    } | {
+        clientId: string;
+        type?: "pkce" | undefined;
+        baseUrl?: string | undefined;
+        scope?: string | undefined;
+    } | zod_v4_core.$InferOuterFunctionType<zod_v4_core.$ZodTuple<readonly [], zod_v4_core.$ZodFunctionOut>, zod.ZodUnion<readonly [zod.ZodUnion<readonly [zod.ZodString, zod.ZodUnion<readonly [zod.ZodObject<{
+        type: zod.ZodOptional<zod.ZodEnum<{
+            client_credentials: "client_credentials";
+        }>>;
+        clientId: zod.ZodString;
+        clientSecret: zod.ZodString;
+        baseUrl: zod.ZodOptional<zod.ZodString>;
+        scope: zod.ZodOptional<zod.ZodString>;
+    }, zod_v4_core.$strip>, zod.ZodObject<{
+        type: zod.ZodOptional<zod.ZodEnum<{
+            pkce: "pkce";
+        }>>;
+        clientId: zod.ZodString;
+        baseUrl: zod.ZodOptional<zod.ZodString>;
+        scope: zod.ZodOptional<zod.ZodString>;
+    }, zod_v4_core.$strip>]>]>, zod.ZodPromise<zod.ZodUnion<readonly [zod.ZodString, zod.ZodUnion<readonly [zod.ZodObject<{
+        type: zod.ZodOptional<zod.ZodEnum<{
+            client_credentials: "client_credentials";
+        }>>;
+        clientId: zod.ZodString;
+        clientSecret: zod.ZodString;
+        baseUrl: zod.ZodOptional<zod.ZodString>;
+        scope: zod.ZodOptional<zod.ZodString>;
+    }, zod_v4_core.$strip>, zod.ZodObject<{
+        type: zod.ZodOptional<zod.ZodEnum<{
+            pkce: "pkce";
+        }>>;
+        clientId: zod.ZodString;
+        baseUrl: zod.ZodOptional<zod.ZodString>;
+        scope: zod.ZodOptional<zod.ZodString>;
+    }, zod_v4_core.$strip>]>]>>]>> | undefined;
+    debug?: boolean | undefined;
+    baseUrl?: string | undefined;
+    trackingBaseUrl?: string | undefined;
+    maxNetworkRetries?: number | undefined;
+    maxNetworkRetryDelayMs?: number | undefined;
+    maxConcurrentRequests?: number | undefined;
+    approvalTimeoutMs?: number | undefined;
+    maxApprovalRetries?: number | undefined;
+    approvalMode?: "disabled" | "poll" | "throw" | undefined;
+    openAutoModeApprovalsInBrowser?: boolean | undefined;
+    manifestPath?: string | undefined;
+    manifest?: _zapier_zapier_sdk.Manifest | undefined;
+    onEvent?: _zapier_zapier_sdk.EventCallback | undefined;
+    fetch?: typeof fetch | undefined;
+    eventEmission?: _zapier_zapier_sdk.EventEmissionConfig | undefined;
+    callerPackage?: {
+        name: string;
+        version: string;
+    } | undefined;
+    cache?: _zapier_zapier_sdk.ZapierCache | undefined;
+    canIncludeSharedConnections?: boolean | undefined;
+    canIncludeSharedTables?: boolean | undefined;
+    canDeleteTables?: boolean | undefined;
+    token?: string | undefined;
+} | undefined> & _zapier_zapier_sdk.PluginSummary<never, never>]>;
+type FeedbackPluginProvides = PluginSurface<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: _zapier_zapier_sdk.MethodPlugin<"generateAppTypes", GenerateAppTypesOptions, Promise<GenerateAppTypesResult>, readonly []> & _zapier_zapier_sdk.LeafSummary<"", "generateAppTypes", readonly [_zapier_zapier_sdk.MethodPlugin<"listApps", ({
+    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;
+}>, readonly []> & _zapier_zapier_sdk.PluginSummary<"listApps", never>, _zapier_zapier_sdk.MethodPlugin<"listConnections", ({
+    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;
+}>, readonly []> & _zapier_zapier_sdk.PluginSummary<"listConnections", never>, _zapier_zapier_sdk.MethodPlugin<"listActions", ({
+    app: string;
+    actionType?: "read" | "read_bulk" | "write" | "search" | "search_or_write" | "search_and_write" | "filter" | "run" | undefined;
+    pageSize?: number | undefined;
+    maxItems?: number | undefined;
+    cursor?: string | undefined;
+} | {
+    appKey: string;
+    actionType?: "read" | "read_bulk" | "write" | "search" | "search_or_write" | "search_and_write" | "filter" | "run" | undefined;
+    pageSize?: number | undefined;
+    maxItems?: number | undefined;
+    cursor?: string | undefined;
+}) & {
+    cursor?: string;
+    pageSize?: number;
+} & {
+    maxItems?: number;
+}, _zapier_zapier_sdk.PaginatedSdkResult<{
+    description: string;
+    key: string;
+    app_key: string;
+    action_type: "read" | "read_bulk" | "write" | "search" | "search_or_write" | "search_and_write" | "filter" | "run";
+    title: string;
+    type: "action";
+    is_hidden?: boolean | undefined;
+    id?: string | undefined;
+    is_important?: boolean | undefined;
+    app_version?: string | undefined;
+}>, readonly []> & _zapier_zapier_sdk.PluginSummary<"listActions", never>, _zapier_zapier_sdk.MethodPlugin<"listActionInputFields", ({
+    app: string;
+    actionType: "read" | "read_bulk" | "write" | "search" | "search_or_write" | "search_and_write" | "filter" | "run";
+    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: "read" | "read_bulk" | "write" | "search" | "search_or_write" | "search_and_write" | "filter" | "run";
+    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;
+}, _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>, readonly []> & _zapier_zapier_sdk.PluginSummary<"listActionInputFields", never>]>;
+type GenerateAppTypesPluginProvides = PluginSurface<typeof generateAppTypesPlugin>;
+
+type SignupPluginProvides = PluginSurface<typeof signupPlugin>;
+declare const signupPlugin: _zapier_zapier_sdk.MethodPlugin<"signup", {
+    timeout?: string | undefined;
+    useApprovals?: boolean | undefined;
+    nonInteractive?: boolean | undefined;
+    skipPrompts?: boolean | undefined;
+    headless?: boolean | undefined;
+    callbackUrl?: string | undefined;
+}, Promise<void>, readonly []> & _zapier_zapier_sdk.LeafSummary<"", "signup", readonly [_zapier_zapier_sdk.PropertyPlugin<"api", _zapier_zapier_sdk.ApiClient> & _zapier_zapier_sdk.PluginSummary<"zapier/api", never>, _zapier_zapier_sdk.PropertyPlugin<"resolveCredentials", _zapier_zapier_sdk.ResolveCredentialsFn> & _zapier_zapier_sdk.PluginSummary<"zapier/resolveCredentials", never>, _zapier_zapier_sdk.PropertyPlugin<"eventEmission", {
+    transport: _zapier_zapier_sdk.EventTransport;
+    config: _zapier_zapier_sdk.EventEmissionConfig;
+    emit<T extends unknown>(subject: string, event: T): void;
+    createBaseEvent(): Promise<_zapier_zapier_sdk.BaseEvent>;
+    flush(): Promise<void>;
+    close(exitCode?: number): Promise<void>;
+}> & _zapier_zapier_sdk.PluginSummary<"zapier/eventEmission", never>, _zapier_zapier_sdk.PropertyPlugin<"sdkOptions", {
+    credentials?: string | {
+        clientId: string;
+        clientSecret: string;
+        type?: "client_credentials" | undefined;
+        baseUrl?: string | undefined;
+        scope?: string | undefined;
+    } | {
+        clientId: string;
+        type?: "pkce" | undefined;
+        baseUrl?: string | undefined;
+        scope?: string | undefined;
+    } | zod_v4_core.$InferOuterFunctionType<zod_v4_core.$ZodTuple<readonly [], zod_v4_core.$ZodFunctionOut>, zod.ZodUnion<readonly [zod.ZodUnion<readonly [zod.ZodString, zod.ZodUnion<readonly [zod.ZodObject<{
+        type: zod.ZodOptional<zod.ZodEnum<{
+            client_credentials: "client_credentials";
+        }>>;
+        clientId: zod.ZodString;
+        clientSecret: zod.ZodString;
+        baseUrl: zod.ZodOptional<zod.ZodString>;
+        scope: zod.ZodOptional<zod.ZodString>;
+    }, zod_v4_core.$strip>, zod.ZodObject<{
+        type: zod.ZodOptional<zod.ZodEnum<{
+            pkce: "pkce";
+        }>>;
+        clientId: zod.ZodString;
+        baseUrl: zod.ZodOptional<zod.ZodString>;
+        scope: zod.ZodOptional<zod.ZodString>;
+    }, zod_v4_core.$strip>]>]>, zod.ZodPromise<zod.ZodUnion<readonly [zod.ZodString, zod.ZodUnion<readonly [zod.ZodObject<{
+        type: zod.ZodOptional<zod.ZodEnum<{
+            client_credentials: "client_credentials";
+        }>>;
+        clientId: zod.ZodString;
+        clientSecret: zod.ZodString;
+        baseUrl: zod.ZodOptional<zod.ZodString>;
+        scope: zod.ZodOptional<zod.ZodString>;
+    }, zod_v4_core.$strip>, zod.ZodObject<{
+        type: zod.ZodOptional<zod.ZodEnum<{
+            pkce: "pkce";
+        }>>;
+        clientId: zod.ZodString;
+        baseUrl: zod.ZodOptional<zod.ZodString>;
+        scope: zod.ZodOptional<zod.ZodString>;
+    }, zod_v4_core.$strip>]>]>>]>> | undefined;
+    debug?: boolean | undefined;
+    baseUrl?: string | undefined;
+    trackingBaseUrl?: string | undefined;
+    maxNetworkRetries?: number | undefined;
+    maxNetworkRetryDelayMs?: number | undefined;
+    maxConcurrentRequests?: number | undefined;
+    approvalTimeoutMs?: number | undefined;
+    maxApprovalRetries?: number | undefined;
+    approvalMode?: "disabled" | "poll" | "throw" | undefined;
+    openAutoModeApprovalsInBrowser?: boolean | undefined;
+    manifestPath?: string | undefined;
+    manifest?: _zapier_zapier_sdk.Manifest | undefined;
+    onEvent?: _zapier_zapier_sdk.EventCallback | undefined;
+    fetch?: typeof fetch | undefined;
+    eventEmission?: _zapier_zapier_sdk.EventEmissionConfig | undefined;
+    callerPackage?: {
+        name: string;
+        version: string;
+    } | undefined;
+    cache?: _zapier_zapier_sdk.ZapierCache | undefined;
+    canIncludeSharedConnections?: boolean | undefined;
+    canIncludeSharedTables?: boolean | undefined;
+    canDeleteTables?: boolean | undefined;
+    token?: string | undefined;
+} | undefined> & _zapier_zapier_sdk.PluginSummary<never, never>]>;
+
+type ZapierSdkCli = ZapierSdk & BuildManifestPluginProvides & FeedbackPluginProvides & GenerateAppTypesPluginProvides & SignupPluginProvides;
+
+/** A new-model plugin descriptor (from `defineMethod` / `definePlugin` /
+ * `defineResolver` etc.), identified by its `pluginType` discriminant. */
+interface ModelPlugin {
+    readonly pluginType: string;
+}
+/** An extension is either a legacy function plugin or a new-model plugin
+ * descriptor; `addPlugin` accepts both. */
+type Extension = Plugin<unknown, PluginProvides> | ModelPlugin;
+
+export type { Extension as E, ZapierSdkCli as Z };