Class SeamHttpSeamCustomerV1ConnectorsIcal

constructor

• new SeamHttpSeamCustomerV1ConnectorsIcal(
      apiKeyOrOptions?: string | SeamHttpOptions,
  ): SeamHttpSeamCustomerV1ConnectorsIcal

  Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpSeamCustomerV1ConnectorsIcal

client

Readonlydefaults

ReadonlyltsVersion

StaticltsVersion

createPaginator

• createPaginator<
      const TResponse,
      const TResponseKey extends string | number | symbol,
  >(
      request: SeamHttpRequest<TResponse, TResponseKey>,
  ): SeamPaginator<TResponse, TResponseKey>

  Type Parameters

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

  Parameters

  • request: SeamHttpRequest<TResponse, TResponseKey>

  Returns SeamPaginator<TResponse, TResponseKey>

updateClientSessionToken

• updateClientSessionToken(clientSessionToken: string): Promise<void>

  Parameters

  • clientSessionToken: string

  Returns Promise<void>

validateConfig

• validateConfig(
      parameters?: {
          ical_config: {
              fields: {
                  ends_at: { pattern?: string; source: string; type?: "date" };
                  guest_email?: { pattern?: string; source: string; type?: "date" };
                  guest_name?: { pattern?: string; source: string; type?: "date" };
                  guest_phone?: { pattern?: string; source: string; type?: "date" };
                  reservation_key?: { pattern?: string; source: string; type?: "date" };
                  starts_at: { pattern?: string; source: string; type?: "date" };
              };
              filter?: { pattern: string; source: string };
          };
          ical_url: string;
      },
      options?: SeamCustomerV1ConnectorsIcalValidateConfigOptions,
  ): SeamCustomerV1ConnectorsIcalValidateConfigRequest

  Parameters

  • Optionalparameters: {
        ical_config: {
            fields: {
                ends_at: { pattern?: string; source: string; type?: "date" };
                guest_email?: { pattern?: string; source: string; type?: "date" };
                guest_name?: { pattern?: string; source: string; type?: "date" };
                guest_phone?: { pattern?: string; source: string; type?: "date" };
                reservation_key?: { pattern?: string; source: string; type?: "date" };
                starts_at: { pattern?: string; source: string; type?: "date" };
            };
            filter?: { pattern: string; source: string };
        };
        ical_url: string;
    }

    • ical_config: {
          fields: {
              ends_at: { pattern?: string; source: string; type?: "date" };
              guest_email?: { pattern?: string; source: string; type?: "date" };
              guest_name?: { pattern?: string; source: string; type?: "date" };
              guest_phone?: { pattern?: string; source: string; type?: "date" };
              reservation_key?: { pattern?: string; source: string; type?: "date" };
              starts_at: { pattern?: string; source: string; type?: "date" };
          };
          filter?: { pattern: string; source: string };
      }

      Config to validate

      • fields: {
            ends_at: { pattern?: string; source: string; type?: "date" };
            guest_email?: { pattern?: string; source: string; type?: "date" };
            guest_name?: { pattern?: string; source: string; type?: "date" };
            guest_phone?: { pattern?: string; source: string; type?: "date" };
            reservation_key?: { pattern?: string; source: string; type?: "date" };
            starts_at: { pattern?: string; source: string; type?: "date" };
        }

        • ends_at: { pattern?: string; source: string; type?: "date" }

          How to extract check-out date

          • Optionalpattern?: string

            Regex with capture group to extract value from the property

          • source: string

            iCal property name to read from: UID, SUMMARY, DESCRIPTION, DTSTART, DTEND, etc.

          • Optionaltype?: "date"

            Special type handling — 'date' parses iCal date formats

        • Optionalguest_email?: { pattern?: string; source: string; type?: "date" }

          How to extract guest email

          • Optionalpattern?: string

            Regex with capture group to extract value from the property

          • source: string

            iCal property name to read from: UID, SUMMARY, DESCRIPTION, DTSTART, DTEND, etc.

          • Optionaltype?: "date"

            Special type handling — 'date' parses iCal date formats

        • Optionalguest_name?: { pattern?: string; source: string; type?: "date" }

          How to extract guest name

          • Optionalpattern?: string

            Regex with capture group to extract value from the property

          • source: string

            iCal property name to read from: UID, SUMMARY, DESCRIPTION, DTSTART, DTEND, etc.

          • Optionaltype?: "date"

            Special type handling — 'date' parses iCal date formats

        • Optionalguest_phone?: { pattern?: string; source: string; type?: "date" }

          How to extract guest phone

          • Optionalpattern?: string

            Regex with capture group to extract value from the property

          • source: string

            iCal property name to read from: UID, SUMMARY, DESCRIPTION, DTSTART, DTEND, etc.

          • Optionaltype?: "date"

            Special type handling — 'date' parses iCal date formats

        • Optionalreservation_key?: { pattern?: string; source: string; type?: "date" }

          How to extract the reservation key (falls back to UID)

          • Optionalpattern?: string

            Regex with capture group to extract value from the property

          • source: string

            iCal property name to read from: UID, SUMMARY, DESCRIPTION, DTSTART, DTEND, etc.

          • Optionaltype?: "date"

            Special type handling — 'date' parses iCal date formats

        • starts_at: { pattern?: string; source: string; type?: "date" }

          How to extract check-in date

          • Optionalpattern?: string

            Regex with capture group to extract value from the property

          • source: string

            iCal property name to read from: UID, SUMMARY, DESCRIPTION, DTSTART, DTEND, etc.

          • Optionaltype?: "date"

            Special type handling — 'date' parses iCal date formats

      • Optionalfilter?: { pattern: string; source: string }

        Optional filter to skip non-matching events

        • pattern: string

          Regex pattern — events not matching are skipped

        • source: string

          iCal property name to match against

    • ical_url: string

      iCal feed URL to validate against

  • options: SeamCustomerV1ConnectorsIcalValidateConfigOptions = {}

  Returns SeamCustomerV1ConnectorsIcalValidateConfigRequest

StaticfromApiKey

• fromApiKey(
      apiKey: string,
      options?: Omit<SeamHttpOptionsWithApiKey, "apiKey">,
  ): SeamHttpSeamCustomerV1ConnectorsIcal

  Parameters

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

  Returns SeamHttpSeamCustomerV1ConnectorsIcal

StaticfromClient

• fromClient(
      client: AxiosInstance,
      options?: Omit<SeamHttpOptionsWithClient, "client">,
  ): SeamHttpSeamCustomerV1ConnectorsIcal

  Parameters

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

  Returns SeamHttpSeamCustomerV1ConnectorsIcal

StaticfromClientSessionToken

• fromClientSessionToken(
      clientSessionToken: string,
      options?: Omit<SeamHttpOptionsWithClientSessionToken, "clientSessionToken">,
  ): SeamHttpSeamCustomerV1ConnectorsIcal

  Parameters

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

  Returns SeamHttpSeamCustomerV1ConnectorsIcal

StaticfromConsoleSessionToken

• fromConsoleSessionToken(
      consoleSessionToken: string,
      workspaceId: string,
      options?: Omit<
          SeamHttpOptionsWithConsoleSessionToken,
          "consoleSessionToken"
          | "workspaceId",
      >,
  ): SeamHttpSeamCustomerV1ConnectorsIcal

  Parameters

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

  Returns SeamHttpSeamCustomerV1ConnectorsIcal

StaticfromPersonalAccessToken

• fromPersonalAccessToken(
      personalAccessToken: string,
      workspaceId: string,
      options?: Omit<
          SeamHttpOptionsWithPersonalAccessToken,
          "personalAccessToken"
          | "workspaceId",
      >,
  ): SeamHttpSeamCustomerV1ConnectorsIcal

  Parameters

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

  Returns SeamHttpSeamCustomerV1ConnectorsIcal

StaticfromPublishableKey

• fromPublishableKey(
      publishableKey: string,
      userIdentifierKey: string,
      options?: SeamHttpFromPublishableKeyOptions,
  ): Promise<SeamHttpSeamCustomerV1ConnectorsIcal>

  Parameters

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

  Returns Promise<SeamHttpSeamCustomerV1ConnectorsIcal>