Class SeamHttpSeamCustomerV1Automations

constructor

• new SeamHttpSeamCustomerV1Automations(apiKeyOrOptions?): SeamHttpSeamCustomerV1Automations

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpSeamCustomerV1Automations

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>

delete

• delete(parameters?, options?): SeamCustomerV1AutomationsDeleteRequest

• Parameters

  • Optionalparameters: {}
  • options: SeamCustomerV1AutomationsDeleteOptions = {}

  Returns SeamCustomerV1AutomationsDeleteRequest

get

• get(parameters?, options?): SeamCustomerV1AutomationsGetRequest

• Parameters

  • Optionalparameters: {}
  • options: SeamCustomerV1AutomationsGetOptions = {}

  Returns SeamCustomerV1AutomationsGetRequest

update

• update(parameters?, options?): SeamCustomerV1AutomationsUpdateRequest

• Parameters

  • Optionalparameters: {
        access_rules?: {
            reservation_created?: {
                config: {
                    access_methods: ("code" | "card" | "mobile_key")[];
                    method_issuance_strategy: "first_available" | "first_two_available" | "all_available";
                };
                rule: "reservation_created";
            };
            reservation_deleted?: {
                config?: {};
                rule: "reservation_deleted";
            };
            reservation_time_updated?: {
                config?: {};
                rule: "reservation_time_updated";
            };
        };
    }

    • Optionalaccess_rules?: {
          reservation_created?: {
              config: {
                  access_methods: ("code" | "card" | "mobile_key")[];
                  method_issuance_strategy: "first_available" | "first_two_available" | "all_available";
              };
              rule: "reservation_created";
          };
          reservation_deleted?: {
              config?: {};
              rule: "reservation_deleted";
          };
          reservation_time_updated?: {
              config?: {};
              rule: "reservation_time_updated";
          };
      }

      Access automation rules configuration.

      • Optionalreservation_created?: {
            config: {
                access_methods: ("code" | "card" | "mobile_key")[];
                method_issuance_strategy: "first_available" | "first_two_available" | "all_available";
            };
            rule: "reservation_created";
        }

        • config: {
              access_methods: ("code" | "card" | "mobile_key")[];
              method_issuance_strategy: "first_available" | "first_two_available" | "all_available";
          }

          • access_methods: ("code" | "card" | "mobile_key")[]

          • method_issuance_strategy: "first_available" | "first_two_available" | "all_available"

        • rule: "reservation_created"

      • Optionalreservation_deleted?: {
            config?: {};
            rule: "reservation_deleted";
        }

        • Optionalconfig?: {}

        • rule: "reservation_deleted"

      • Optionalreservation_time_updated?: {
            config?: {};
            rule: "reservation_time_updated";
        }

        • Optionalconfig?: {}

        • rule: "reservation_time_updated"

  • options: SeamCustomerV1AutomationsUpdateOptions = {}

  Returns SeamCustomerV1AutomationsUpdateRequest

updateClientSessionToken

• updateClientSessionToken(clientSessionToken): Promise<void>

• Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

• fromApiKey(apiKey, options?): SeamHttpSeamCustomerV1Automations

• Parameters

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

  Returns SeamHttpSeamCustomerV1Automations

StaticfromClient

• fromClient(client, options?): SeamHttpSeamCustomerV1Automations

• Parameters

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

  Returns SeamHttpSeamCustomerV1Automations

StaticfromClientSessionToken

• fromClientSessionToken(clientSessionToken, options?): SeamHttpSeamCustomerV1Automations

• Parameters

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

  Returns SeamHttpSeamCustomerV1Automations

StaticfromConsoleSessionToken

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

• Parameters

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

  Returns SeamHttpSeamCustomerV1Automations

StaticfromPersonalAccessToken

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

• Parameters

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

  Returns SeamHttpSeamCustomerV1Automations

StaticfromPublishableKey

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

• Parameters

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

  Returns Promise<SeamHttpSeamCustomerV1Automations>