Class SeamHttpSeamCustomerV1Automations

constructor

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

  Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpSeamCustomerV1Automations

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>

delete

• delete(
      parameters?: {},
      options?: SeamCustomerV1AutomationsDeleteOptions,
  ): SeamCustomerV1AutomationsDeleteRequest

  Parameters

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

  Returns SeamCustomerV1AutomationsDeleteRequest

get

• get(
      parameters?: { customer_key?: string },
      options?: SeamCustomerV1AutomationsGetOptions,
  ): SeamCustomerV1AutomationsGetRequest

  Parameters

  • Optionalparameters: { customer_key?: string }

    • Optionalcustomer_key?: string

      Key of the customer to get automation config for.

  • options: SeamCustomerV1AutomationsGetOptions = {}

  Returns SeamCustomerV1AutomationsGetRequest

update

• update(
      parameters?: {
          access_rules?: {
              reservation_created?: {
                  config: {
                      access_methods: ("code" | "card" | "mobile_key")[];
                      card_count_on_reservation_create?: number;
                      code_count_on_reservation_create?: number;
                      instant_key_max_use_count?: number;
                      method_issuance_strategy:
                          | "first_available"
                          | "first_two_available"
                          | "all_available";
                  };
                  rule: "reservation_created";
              };
              reservation_deleted?: { config?: {}; rule: "reservation_deleted" };
              reservation_spaces_updated?: {
                  config?: {};
                  rule: "reservation_spaces_updated";
              };
              reservation_time_updated?: {
                  config?: {};
                  rule: "reservation_time_updated";
              };
              space_name_updated?: { config?: {}; rule: "space_name_updated" };
              staff_member_created?: { config: {}; rule: "staff_member_created" };
              staff_member_name_updated?: {
                  config?: {};
                  rule: "staff_member_name_updated";
              };
              user_identity_name_updated?: {
                  config?: {};
                  rule: "user_identity_name_updated";
              };
          };
          climate_rules?: {
              rules?: {
                  reservation_created?: {
                      automated_occupied_preset?: {
                          cooling_set_point_celsius?: (...)
                          | (...);
                          cooling_set_point_fahrenheit?: (...) | (...);
                          fan_mode: (...) | (...) | (...);
                          heating_set_point_celsius?: (...) | (...);
                          heating_set_point_fahrenheit?: (...) | (...);
                          is_override_allowed: boolean;
                          max_override_period_minutes: number;
                          mode: (...) | (...) | (...);
                      };
                      automated_unoccupied_preset?: {
                          cooling_set_point_celsius?: (...)
                          | (...);
                          cooling_set_point_fahrenheit?: (...) | (...);
                          fan_mode: (...) | (...) | (...);
                          heating_set_point_celsius?: (...) | (...);
                          heating_set_point_fahrenheit?: (...) | (...);
                          is_override_allowed: boolean;
                          max_override_period_minutes: number;
                          mode: (...) | (...) | (...);
                      };
                      occupied_preset_key?: string;
                      precondition_minutes_before_reservation?: number;
                      unoccupied_preset_key?: string;
                  };
                  reservation_deleted?: {};
                  reservation_time_updated?: {};
              };
          };
          customer_key?: string;
      },
      options?: SeamCustomerV1AutomationsUpdateOptions,
  ): SeamCustomerV1AutomationsUpdateRequest

  Parameters

  • Optionalparameters: {
        access_rules?: {
            reservation_created?: {
                config: {
                    access_methods: ("code" | "card" | "mobile_key")[];
                    card_count_on_reservation_create?: number;
                    code_count_on_reservation_create?: number;
                    instant_key_max_use_count?: number;
                    method_issuance_strategy:
                        | "first_available"
                        | "first_two_available"
                        | "all_available";
                };
                rule: "reservation_created";
            };
            reservation_deleted?: { config?: {}; rule: "reservation_deleted" };
            reservation_spaces_updated?: {
                config?: {};
                rule: "reservation_spaces_updated";
            };
            reservation_time_updated?: {
                config?: {};
                rule: "reservation_time_updated";
            };
            space_name_updated?: { config?: {}; rule: "space_name_updated" };
            staff_member_created?: { config: {}; rule: "staff_member_created" };
            staff_member_name_updated?: {
                config?: {};
                rule: "staff_member_name_updated";
            };
            user_identity_name_updated?: {
                config?: {};
                rule: "user_identity_name_updated";
            };
        };
        climate_rules?: {
            rules?: {
                reservation_created?: {
                    automated_occupied_preset?: {
                        cooling_set_point_celsius?: (...)
                        | (...);
                        cooling_set_point_fahrenheit?: (...) | (...);
                        fan_mode: (...) | (...) | (...);
                        heating_set_point_celsius?: (...) | (...);
                        heating_set_point_fahrenheit?: (...) | (...);
                        is_override_allowed: boolean;
                        max_override_period_minutes: number;
                        mode: (...) | (...) | (...);
                    };
                    automated_unoccupied_preset?: {
                        cooling_set_point_celsius?: (...)
                        | (...);
                        cooling_set_point_fahrenheit?: (...) | (...);
                        fan_mode: (...) | (...) | (...);
                        heating_set_point_celsius?: (...) | (...);
                        heating_set_point_fahrenheit?: (...) | (...);
                        is_override_allowed: boolean;
                        max_override_period_minutes: number;
                        mode: (...) | (...) | (...);
                    };
                    occupied_preset_key?: string;
                    precondition_minutes_before_reservation?: number;
                    unoccupied_preset_key?: string;
                };
                reservation_deleted?: {};
                reservation_time_updated?: {};
            };
        };
        customer_key?: string;
    }

    • Optionalaccess_rules?: {
          reservation_created?: {
              config: {
                  access_methods: ("code" | "card" | "mobile_key")[];
                  card_count_on_reservation_create?: number;
                  code_count_on_reservation_create?: number;
                  instant_key_max_use_count?: number;
                  method_issuance_strategy:
                      | "first_available"
                      | "first_two_available"
                      | "all_available";
              };
              rule: "reservation_created";
          };
          reservation_deleted?: { config?: {}; rule: "reservation_deleted" };
          reservation_spaces_updated?: {
              config?: {};
              rule: "reservation_spaces_updated";
          };
          reservation_time_updated?: {
              config?: {};
              rule: "reservation_time_updated";
          };
          space_name_updated?: { config?: {}; rule: "space_name_updated" };
          staff_member_created?: { config: {}; rule: "staff_member_created" };
          staff_member_name_updated?: {
              config?: {};
              rule: "staff_member_name_updated";
          };
          user_identity_name_updated?: {
              config?: {};
              rule: "user_identity_name_updated";
          };
      }

      Access automation rules configuration.

    • Optionalclimate_rules?: {
          rules?: {
              reservation_created?: {
                  automated_occupied_preset?: {
                      cooling_set_point_celsius?: (...) | (...);
                      cooling_set_point_fahrenheit?: (...) | (...);
                      fan_mode: (...) | (...) | (...);
                      heating_set_point_celsius?: (...) | (...);
                      heating_set_point_fahrenheit?: (...) | (...);
                      is_override_allowed: boolean;
                      max_override_period_minutes: number;
                      mode: (...) | (...) | (...);
                  };
                  automated_unoccupied_preset?: {
                      cooling_set_point_celsius?: (...)
                      | (...);
                      cooling_set_point_fahrenheit?: (...) | (...);
                      fan_mode: (...) | (...) | (...);
                      heating_set_point_celsius?: (...) | (...);
                      heating_set_point_fahrenheit?: (...) | (...);
                      is_override_allowed: boolean;
                      max_override_period_minutes: number;
                      mode: (...) | (...) | (...);
                  };
                  occupied_preset_key?: string;
                  precondition_minutes_before_reservation?: number;
                  unoccupied_preset_key?: string;
              };
              reservation_deleted?: {};
              reservation_time_updated?: {};
          };
      }

      Climate automation rules configuration.

    • Optionalcustomer_key?: string

      Key of the customer to update automation config for.

  • options: SeamCustomerV1AutomationsUpdateOptions = {}

  Returns SeamCustomerV1AutomationsUpdateRequest

updateClientSessionToken

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

  Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

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

  Parameters

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

  Returns SeamHttpSeamCustomerV1Automations

StaticfromClient

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

  Parameters

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

  Returns SeamHttpSeamCustomerV1Automations

StaticfromClientSessionToken

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

  Parameters

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

  Returns SeamHttpSeamCustomerV1Automations

StaticfromConsoleSessionToken

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

  Parameters

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

  Returns SeamHttpSeamCustomerV1Automations

StaticfromPersonalAccessToken

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

  Parameters

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

  Returns SeamHttpSeamCustomerV1Automations

StaticfromPublishableKey

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

  Parameters

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

  Returns Promise<SeamHttpSeamCustomerV1Automations>