Class SeamHttpSeamCustomerV1AutomationRuns

constructor

• new SeamHttpSeamCustomerV1AutomationRuns(apiKeyOrOptions?): SeamHttpSeamCustomerV1AutomationRuns

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpSeamCustomerV1AutomationRuns

client

Readonlydefaults

ReadonlyltsVersion

StaticltsVersion

createPaginator

• createPaginator<const TResponse, const TResponseKey>(request): SeamPaginator<TResponse, TResponseKey>

• Type Parameters

  • const TResponse
  • const TResponseKey extends string | number | symbol

  Parameters

  • request: SeamHttpRequest<TResponse, TResponseKey>

  Returns SeamPaginator<TResponse, TResponseKey>

list

• list(parameters?, options?): SeamCustomerV1AutomationRunsListRequest

• Parameters

  • Optionalparameters: {
        automation_id?: string;
        created_before?: Date;
        limit?: number;
        page_cursor?: null | string;
        partner_resource_id?: string;
        rule?: "reservation_created" | "reservation_time_updated" | "reservation_deleted";
        success?: boolean;
    }

    • Optionalautomation_id?: string

      ID of the automation for which you want to retrieve all automation runs.

    • Optionalcreated_before?: Date

      Timestamp by which to limit returned automation runs. Returns runs created before this timestamp.

    • Optionallimit?: number

      Maximum number of records to return per page.

    • Optionalpage_cursor?: null | string

      Identifies the specific page of results to return, obtained from the previous page's next_page_cursor.

    • Optionalpartner_resource_id?: string

      ID of the partner resource for which you want to retrieve all automation runs.

    • Optionalrule?: "reservation_created" | "reservation_time_updated" | "reservation_deleted"

      Filter automation runs by the specific rule that was executed.

    • Optionalsuccess?: boolean

      Filter automation runs by success status.
  • options: SeamCustomerV1AutomationRunsListOptions = {}

  Returns SeamCustomerV1AutomationRunsListRequest

updateClientSessionToken

• updateClientSessionToken(clientSessionToken): Promise<void>

• Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

• fromApiKey(apiKey, options?): SeamHttpSeamCustomerV1AutomationRuns

• Parameters

  • apiKey: string
  • options: Omit<SeamHttpOptionsWithApiKey, "apiKey"> = {}

  Returns SeamHttpSeamCustomerV1AutomationRuns

StaticfromClient

• fromClient(client, options?): SeamHttpSeamCustomerV1AutomationRuns

• Parameters

  • client: AxiosInstance
  • options: Omit<SeamHttpOptionsWithClient, "client"> = {}

  Returns SeamHttpSeamCustomerV1AutomationRuns

StaticfromClientSessionToken

• fromClientSessionToken(clientSessionToken, options?): SeamHttpSeamCustomerV1AutomationRuns

• Parameters

  • clientSessionToken: string
  • options: Omit<SeamHttpOptionsWithClientSessionToken, "clientSessionToken"> = {}

  Returns SeamHttpSeamCustomerV1AutomationRuns

StaticfromConsoleSessionToken

• fromConsoleSessionToken(consoleSessionToken, workspaceId, options?): SeamHttpSeamCustomerV1AutomationRuns

• Parameters

  • consoleSessionToken: string
  • workspaceId: string
  • options: Omit<SeamHttpOptionsWithConsoleSessionToken, "consoleSessionToken" | "workspaceId"> = {}

  Returns SeamHttpSeamCustomerV1AutomationRuns

StaticfromPersonalAccessToken

• fromPersonalAccessToken(personalAccessToken, workspaceId, options?): SeamHttpSeamCustomerV1AutomationRuns

• Parameters

  • personalAccessToken: string
  • workspaceId: string
  • options: Omit<SeamHttpOptionsWithPersonalAccessToken, "workspaceId" | "personalAccessToken"> = {}

  Returns SeamHttpSeamCustomerV1AutomationRuns

StaticfromPublishableKey

• fromPublishableKey(publishableKey, userIdentifierKey, options?): Promise<SeamHttpSeamCustomerV1AutomationRuns>

• Parameters

  • publishableKey: string
  • userIdentifierKey: string
  • options: SeamHttpFromPublishableKeyOptions = {}

  Returns Promise<SeamHttpSeamCustomerV1AutomationRuns>