Circle V2 API Docs
    Preparing search index...

    Class LightningStepApiClient

    Index

    Constructors

    constructor

    Methods

    exportTable getIntegrationLocationIds showTable

    Constructors

    • Parameters

      • rawCredentials:
            | {
                access_id: string;
                app_id: string;
                location_id: number;
                location_name?: string;
                secret_key: string;
            }
            | { bearer_token: string; location_ids: number[]; location_name?: string }
            | {
                api_id: string;
                api_secret: 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;
                location_id: "1"
                | "2";
                location_name?: string;
                seed: string;
            }
        • {
              access_id: string;
              app_id: string;
              location_id: number;
              location_name?: string;
              secret_key: string;
          }
        • { bearer_token: string; location_ids: number[]; location_name?: string }
        • {
              api_id: string;
              api_secret: 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;
          }
          • base_url: string
          • client_id: string
          • Optionalextend_workflow_id?: string

            Optional custom Extend workflow id for this facility's uploads; blank = unset (normalized by getExtendWorkflowId).

          • rpa_vault_user_id: string

            RPA vault user id — passed as the workflow's USER input (the portal login identity).

          • rpa_workflow_id: string

            RPA workflow id the bot runs; the workflow branches on the sync_type input.

          • secret_key: string
        • {
              as_of_date?: string;
              location_id: "1" | "2";
              location_name?: string;
              seed: 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>>>

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods