Circle V2 API Docs
    Preparing search index...

    Class LightningStepApiClient

    Index

    Constructors

    • Parameters

      • rawCredentials:
            | {
                access_id: string;
                app_id: string;
                extend_workflow_id?: string;
                location_id: number;
                location_name?: string;
                secret_key: string;
            }
            | {
                bearer_token: string;
                extend_workflow_id?: string;
                location_ids: number[];
                location_name?: string;
            }
            | {
                api_id: string;
                api_secret: string;
                extend_workflow_id?: string;
                location_name?: string;
                realm_id: string;
                service_facility_id: number;
                sunwave_email: string;
            }
            | {
                base_url: string;
                client_id: string;
                extend_workflow_id?: string;
                rpa_vault_user_id: string;
                rpa_workflow_id: string;
                secret_key: string;
            }
            | {
                as_of_date?: string;
                extend_workflow_id?: string;
                location_id: "2"
                | "1";
                location_name?: string;
                seed: string;
            }
            | {
                api_key: string;
                connector: string;
                connector_label: string;
                extend_workflow_id?: string;
                org_id: string;
                program_map: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodString>>;
                sync_from: string;
            }
            | {
                bearer_token: string;
                extend_workflow_id?: string;
                location_ids: number[];
                location_name?: string;
            }
      • Optionaloptions: LightningStepApiClientOptions

      Returns LightningStepApiClient

    Methods

    • Exports a table from the LightningStep API.

      Type Parameters

      • T extends TableNames

      Parameters

      • table: T
      • options: ExportTableOptions<T>

      Returns Promise<TableExportResponse<Table<T>>>

    • Returns number[]

    • Fetches the first 1000 records of a table from the LightningStep API. Useful for previewing the data and debugging.

      Type Parameters

      • T extends TableNames

      Parameters

      • table: T

      Returns Promise<TableShowResponse<Table<T>>>