Class SeamHttpAccessCodes
Constructors
constructor
- new SeamHttpAccessCodes(apiKeyOrOptions?): SeamHttpAccessCodes
Properties
client
client: AxiosInstance
Readonlydefaults
Accessors
Methods
create
- create(body?): SeamHttpRequest<SetNonNullable<Required<{
access_code: {
access_code_id: string;
code: null | string;
common_code_key: null | string;
created_at: string;
device_id: string;
ends_at?: null | string;
errors: ({
error_code: string;
is_access_code_error: true;
message: string;
} | {
error_code: string;
is_device_error: true;
message: string;
} | {
error_code: string;
is_connected_account_error: true;
message: string;
})[];
is_backup?: boolean;
is_backup_access_code_available: boolean;
is_external_modification_allowed: boolean;
is_managed: true;
is_offline_access_code: boolean;
is_one_time_use: boolean;
is_scheduled_on_device?: boolean;
is_waiting_for_code_assignment?: boolean;
name: null | string;
pulled_backup_access_code_id?: null | string;
starts_at?: null | string;
status:
| "set"
| "unknown"
| "setting"
| "unset"
| "removing";
type: "time_bound" | "ongoing";
warnings: {
message: string;
warning_code: string;
}[];
};
action_attempt:
| {
action_attempt_id: string;
action_type: "LOCK_DOOR";
error: null;
result: null;
status: "pending";
}
| {
action_attempt_id: string;
action_type: "LOCK_DOOR";
error: null;
result: {};
status: "success";
}
| {
action_attempt_id: string;
action_type: "LOCK_DOOR";
error: {
message: string;
type: string;
};
result: null;
status: "error";
}
| {
action_attempt_id: string;
action_type: "UNLOCK_DOOR";
error: null;
result: null;
status: "pending";
}
| {
action_attempt_id: string;
action_type: "UNLOCK_DOOR";
error: null;
result: {};
status: "success";
}
| {
action_attempt_id: string;
action_type: "UNLOCK_DOOR";
error: {
message: string;
type: string;
};
result: null;
status: "error";
}
| {
action_attempt_id: string;
action_type: "SCAN_CREDENTIAL";
error: null;
result: null;
status: "pending";
}
| {
action_attempt_id: string;
action_type: "SCAN_CREDENTIAL";
error: null;
result: {
acs_credential_on_encoder: null | {
card_number: null | string;
created_at: null | string;
ends_at: null | string;
is_issued: null | boolean;
starts_at: null | string;
visionline_metadata?: {
cancelled: ...;
card_format: ...;
card_holder?: ...;
card_id: ...;
common_acs_entrance_ids?: ...;
discarded: ...;
expired: ...;
guest_acs_entrance_ids?: ...;
number_of_issued_cards: ...;
overridden?: ...;
overwritten: ...;
pending_auto_update: ...;
};
};
acs_credential_on_seam: null | {
access_method: "code" | "card" | "mobile_key";
acs_credential_id: string;
acs_credential_pool_id?: string;
acs_system_id: string;
acs_user_id?: string;
card_number?: null | string;
code?: null | string;
created_at: string;
display_name: string;
ends_at?: string;
errors: {
error_code: ...;
message: ...;
}[];
external_type?:
| "pti_card"
| "brivo_credential"
| "hid_credential"
| "visionline_card"
| "salto_ks_credential";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean;
is_managed: true;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: null | string;
latest_desired_state_synced_with_provider_at?: string;
parent_acs_credential_id?: string;
starts_at?: string;
visionline_metadata?: {
auto_join?: ...;
card_function_type: ...;
card_id?: ...;
common_acs_entrance_ids?: ...;
credential_id?: ...;
guest_acs_entrance_ids?: ...;
is_valid?: ...;
joiner_acs_credential_ids?: ...;
};
warnings: (
| (...)
| (...)
| (...)
| (...))[];
workspace_id: string;
} | {
access_method: "code" | "card" | "mobile_key";
acs_credential_id: string;
acs_credential_pool_id?: string;
acs_system_id: string;
acs_user_id?: string;
card_number?: null | string;
code?: null | string;
created_at: string;
display_name: string;
ends_at?: string;
errors: {
error_code: ...;
message: ...;
}[];
external_type?:
| "pti_card"
| "brivo_credential"
| "hid_credential"
| "visionline_card"
| "salto_ks_credential";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean;
is_managed: false;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: null | string;
latest_desired_state_synced_with_provider_at?: string;
parent_acs_credential_id?: string;
starts_at?: string;
visionline_metadata?: {
auto_join?: ...;
card_function_type: ...;
card_id?: ...;
common_acs_entrance_ids?: ...;
credential_id?: ...;
guest_acs_entrance_ids?: ...;
is_valid?: ...;
joiner_acs_credential_ids?: ...;
};
warnings: (
| (...)
| (...)
| (...)
| (...))[];
workspace_id: string;
};
warnings: {
warning_code: "acs_credential_on_encoder_out_of_sync" | "acs_credential_on_seam_not_found";
warning_message: string;
}[];
};
status: "success";
}
| {
action_attempt_id: string;
action_type: "SCAN_CREDENTIAL";
error: {
message: string;
type: "uncategorized_error";
} | {
message: string;
type: "action_attempt_expired";
} | {
message: string;
type: "no_card_on_encoder";
};
result: null;
status: "error";
}
| {
action_attempt_id: string;
action_type: "ENCODE_CREDENTIAL";
error: null;
result: null;
status: "pending";
}
| {
action_attempt_id: string;
action_type: "ENCODE_CREDENTIAL";
error: null;
result: {
access_method: "code" | "card" | "mobile_key";
acs_credential_id: string;
acs_credential_pool_id?: string;
acs_system_id: string;
acs_user_id?: string;
card_number?: null | string;
code?: null | string;
created_at: string;
display_name: string;
ends_at?: string;
errors: {
error_code: string;
message: string;
}[];
external_type?:
| "pti_card"
| "brivo_credential"
| "hid_credential"
| "visionline_card"
| "salto_ks_credential";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean;
is_managed: true;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: null | string;
latest_desired_state_synced_with_provider_at?: string;
parent_acs_credential_id?: string;
starts_at?: string;
visionline_metadata?: {
auto_join?: (...) | (...) | (...);
card_function_type: (...) | (...);
card_id?: (...) | (...);
common_acs_entrance_ids?: (...) | (...);
credential_id?: (...) | (...);
guest_acs_entrance_ids?: (...) | (...);
is_valid?: (...) | (...) | (...);
joiner_acs_credential_ids?: (...) | (...);
};
warnings: (
| {
created_at: ...;
message: ...;
warning_code: ...;
}
| {
created_at: ...;
message: ...;
warning_code: ...;
}
| {
created_at: ...;
message: ...;
warning_code: ...;
}
| {
created_at: ...;
message: ...;
warning_code: ...;
})[];
workspace_id: string;
} | {
access_method: "code" | "card" | "mobile_key";
acs_credential_id: string;
acs_credential_pool_id?: string;
acs_system_id: string;
acs_user_id?: string;
card_number?: null | string;
code?: null | string;
created_at: string;
display_name: string;
ends_at?: string;
errors: {
error_code: string;
message: string;
}[];
external_type?:
| "pti_card"
| "brivo_credential"
| "hid_credential"
| "visionline_card"
| "salto_ks_credential";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean;
is_managed: false;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: null | string;
latest_desired_state_synced_with_provider_at?: string;
parent_acs_credential_id?: string;
starts_at?: string;
visionline_metadata?: {
auto_join?: (...) | (...) | (...);
card_function_type: (...) | (...);
card_id?: (...) | (...);
common_acs_entrance_ids?: (...) | (...);
credential_id?: (...) | (...);
guest_acs_entrance_ids?: (...) | (...);
is_valid?: (...) | (...) | (...);
joiner_acs_credential_ids?: (...) | (...);
};
warnings: (
| {
created_at: ...;
message: ...;
warning_code: ...;
}
| {
created_at: ...;
message: ...;
warning_code: ...;
}
| {
created_at: ...;
message: ...;
warning_code: ...;
}
| {
created_at: ...;
message: ...;
warning_code: ...;
})[];
workspace_id: string;
};
status: "success";
}
| {
action_attempt_id: string;
action_type: "ENCODE_CREDENTIAL";
error:
| {
message: string;
type: "uncategorized_error";
}
| {
message: string;
type: "action_attempt_expired";
}
| {
message: string;
type: "no_card_on_encoder";
}
| {
message: string;
type: "incompatible_card_format";
};
result: null;
status: "error";
}
| {
action_attempt_id: string;
action_type: "RESET_SANDBOX_WORKSPACE";
error: null;
result: null;
status: "pending";
}
| {
action_attempt_id: string;
action_type: "RESET_SANDBOX_WORKSPACE";
error: null;
result: {};
status: "success";
}
| {
action_attempt_id: string;
action_type: "RESET_SANDBOX_WORKSPACE";
error: {
message: string;
type: string;
};
result: null;
status: "error";
}
| {
action_attempt_id: string;
action_type: "SET_FAN_MODE";
error: null;
result: null;
status: "pending";
}
| {
action_attempt_id: string;
action_type: "SET_FAN_MODE";
error: null;
result: {};
status: "success";
}
| {
action_attempt_id: string;
action_type: "SET_FAN_MODE";
error: {
message: string;
type: string;
};
result: null;
status: "error";
}
| {
action_attempt_id: string;
action_type: "SET_HVAC_MODE";
error: null;
result: null;
status: "pending";
}
| {
action_attempt_id: string;
action_type: "SET_HVAC_MODE";
error: null;
result: {};
status: "success";
}
| {
action_attempt_id: string;
action_type: "SET_HVAC_MODE";
error: {
message: string;
type: string;
};
result: null;
status: "error";
}
| {
action_attempt_id: string;
action_type: "ACTIVATE_CLIMATE_PRESET";
error: null;
result: null;
status: "pending";
}
| {
action_attempt_id: string;
action_type: "ACTIVATE_CLIMATE_PRESET";
error: null;
result: {};
status: "success";
}
| {
action_attempt_id: string;
action_type: "ACTIVATE_CLIMATE_PRESET";
error: {
message: string;
type: string;
};
result: null;
status: "error";
}
| {
action_attempt_id: string;
action_type: "SYNC_ACCESS_CODES";
error: null;
result: null;
status: "pending";
}
| {
action_attempt_id: string;
action_type: "SYNC_ACCESS_CODES";
error: null;
result: {};
status: "success";
}
| {
action_attempt_id: string;
action_type: "SYNC_ACCESS_CODES";
error: {
message: string;
type: string;
};
result: null;
status: "error";
}
| {
action_attempt_id: string;
action_type: "CREATE_ACCESS_CODE";
error: null;
result: null;
status: "pending";
}
| {
action_attempt_id: string;
action_type: "CREATE_ACCESS_CODE";
error: null;
result: {
access_code?: any;
};
status: "success";
}
| {
action_attempt_id: string;
action_type: "CREATE_ACCESS_CODE";
error: {
message: string;
type: string;
};
result: null;
status: "error";
}
| {
action_attempt_id: string;
action_type: "DELETE_ACCESS_CODE";
error: null;
result: null;
status: "pending";
}
| {
action_attempt_id: string;
action_type: "DELETE_ACCESS_CODE";
error: null;
result: {};
status: "success";
}
| {
action_attempt_id: string;
action_type: "DELETE_ACCESS_CODE";
error: {
message: string;
type: string;
};
result: null;
status: "error";
}
| {
action_attempt_id: string;
action_type: "UPDATE_ACCESS_CODE";
error: null;
result: null;
status: "pending";
}
| {
action_attempt_id: string;
action_type: "UPDATE_ACCESS_CODE";
error: null;
result: {
access_code?: any;
};
status: "success";
}
| {
action_attempt_id: string;
action_type: "UPDATE_ACCESS_CODE";
error: {
message: string;
type: string;
};
result: null;
status: "error";
}
| {
action_attempt_id: string;
action_type: "CREATE_NOISE_THRESHOLD";
error: null;
result: null;
status: "pending";
}
| {
action_attempt_id: string;
action_type: "CREATE_NOISE_THRESHOLD";
error: null;
result: {
noise_threshold?: any;
};
status: "success";
}
| {
action_attempt_id: string;
action_type: "CREATE_NOISE_THRESHOLD";
error: {
message: string;
type: string;
};
result: null;
status: "error";
}
| {
action_attempt_id: string;
action_type: "DELETE_NOISE_THRESHOLD";
error: null;
result: null;
status: "pending";
}
| {
action_attempt_id: string;
action_type: "DELETE_NOISE_THRESHOLD";
error: null;
result: {};
status: "success";
}
| {
action_attempt_id: string;
action_type: "DELETE_NOISE_THRESHOLD";
error: {
message: string;
type: string;
};
result: null;
status: "error";
}
| {
action_attempt_id: string;
action_type: "UPDATE_NOISE_THRESHOLD";
error: null;
result: null;
status: "pending";
}
| {
action_attempt_id: string;
action_type: "UPDATE_NOISE_THRESHOLD";
error: null;
result: {
noise_threshold?: any;
};
status: "success";
}
| {
action_attempt_id: string;
action_type: "UPDATE_NOISE_THRESHOLD";
error: {
message: string;
type: string;
};
result: null;
status: "error";
};
}>, "access_code" | "action_attempt">, "access_code"> Parameters
Optionalbody: {
allow_external_modification?: boolean;
attempt_for_offline_device?: boolean;
code?: string;
common_code_key?: string;
device_id: string;
ends_at?: string;
is_external_modification_allowed?: boolean;
is_offline_access_code?: boolean;
is_one_time_use?: boolean;
max_time_rounding?:
| "1hour"
| "1day"
| "1h"
| "1d";
name?: string;
prefer_native_scheduling?: boolean;
preferred_code_length?: number;
starts_at?: string;
sync?: boolean;
use_backup_access_code_pool?: boolean;
use_offline_access_code?: boolean;
}Optionalallow_external_modification?: boolean
Optionalattempt_for_offline_device?: boolean
Optionalcode?: string
Optionalcommon_code_key?: string
device_id: string
Optionalends_at?: string
Optionalis_external_modification_allowed?: boolean
Optionalis_offline_access_code?: boolean
Optionalis_one_time_use?: boolean
Optionalmax_time_rounding?:
| "1hour"
| "1day"
| "1h"
| "1d"
Optionalname?: string
Optionalprefer_native_scheduling?: boolean
Optionalpreferred_code_length?: number
Optionalstarts_at?: string
Optionalsync?: boolean
Optionaluse_backup_access_code_pool?: boolean
Optionaluse_offline_access_code?: boolean
Returns SeamHttpRequest<SetNonNullable<Required<{
access_code: {
access_code_id: string;
code: null | string;
common_code_key: null | string;
created_at: string;
device_id: string;
ends_at?: null | string;
errors: ({
error_code: string;
is_access_code_error: true;
message: string;
} | {
error_code: string;
is_device_error: true;
message: string;
} | {
error_code: string;
is_connected_account_error: true;
message: string;
})[];
is_backup?: boolean;
is_backup_access_code_available: boolean;
is_external_modification_allowed: boolean;
is_managed: true;
is_offline_access_code: boolean;
is_one_time_use: boolean;
is_scheduled_on_device?: boolean;
is_waiting_for_code_assignment?: boolean;
name: null | string;
pulled_backup_access_code_id?: null | string;
starts_at?: null | string;
status:
| "set"
| "unknown"
| "setting"
| "unset"
| "removing";
type: "time_bound" | "ongoing";
warnings: {
message: string;
warning_code: string;
}[];
};
action_attempt:
| {
action_attempt_id: string;
action_type: "LOCK_DOOR";
error: null;
result: null;
status: "pending";
}
| {
action_attempt_id: string;
action_type: "LOCK_DOOR";
error: null;
result: {};
status: "success";
}
| {
action_attempt_id: string;
action_type: "LOCK_DOOR";
error: {
message: string;
type: string;
};
result: null;
status: "error";
}
| {
action_attempt_id: string;
action_type: "UNLOCK_DOOR";
error: null;
result: null;
status: "pending";
}
| {
action_attempt_id: string;
action_type: "UNLOCK_DOOR";
error: null;
result: {};
status: "success";
}
| {
action_attempt_id: string;
action_type: "UNLOCK_DOOR";
error: {
message: string;
type: string;
};
result: null;
status: "error";
}
| {
action_attempt_id: string;
action_type: "SCAN_CREDENTIAL";
error: null;
result: null;
status: "pending";
}
| {
action_attempt_id: string;
action_type: "SCAN_CREDENTIAL";
error: null;
result: {
acs_credential_on_encoder: null | {
card_number: null | string;
created_at: null | string;
ends_at: null | string;
is_issued: null | boolean;
starts_at: null | string;
visionline_metadata?: {
cancelled: ...;
card_format: ...;
card_holder?: ...;
card_id: ...;
common_acs_entrance_ids?: ...;
discarded: ...;
expired: ...;
guest_acs_entrance_ids?: ...;
number_of_issued_cards: ...;
overridden?: ...;
overwritten: ...;
pending_auto_update: ...;
};
};
acs_credential_on_seam: null | {
access_method: "code" | "card" | "mobile_key";
acs_credential_id: string;
acs_credential_pool_id?: string;
acs_system_id: string;
acs_user_id?: string;
card_number?: null | string;
code?: null | string;
created_at: string;
display_name: string;
ends_at?: string;
errors: {
error_code: ...;
message: ...;
}[];
external_type?:
| "pti_card"
| "brivo_credential"
| "hid_credential"
| "visionline_card"
| "salto_ks_credential";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean;
is_managed: true;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: null | string;
latest_desired_state_synced_with_provider_at?: string;
parent_acs_credential_id?: string;
starts_at?: string;
visionline_metadata?: {
auto_join?: ...;
card_function_type: ...;
card_id?: ...;
common_acs_entrance_ids?: ...;
credential_id?: ...;
guest_acs_entrance_ids?: ...;
is_valid?: ...;
joiner_acs_credential_ids?: ...;
};
warnings: (
| (...)
| (...)
| (...)
| (...))[];
workspace_id: string;
} | {
access_method: "code" | "card" | "mobile_key";
acs_credential_id: string;
acs_credential_pool_id?: string;
acs_system_id: string;
acs_user_id?: string;
card_number?: null | string;
code?: null | string;
created_at: string;
display_name: string;
ends_at?: string;
errors: {
error_code: ...;
message: ...;
}[];
external_type?:
| "pti_card"
| "brivo_credential"
| "hid_credential"
| "visionline_card"
| "salto_ks_credential";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean;
is_managed: false;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: null | string;
latest_desired_state_synced_with_provider_at?: string;
parent_acs_credential_id?: string;
starts_at?: string;
visionline_metadata?: {
auto_join?: ...;
card_function_type: ...;
card_id?: ...;
common_acs_entrance_ids?: ...;
credential_id?: ...;
guest_acs_entrance_ids?: ...;
is_valid?: ...;
joiner_acs_credential_ids?: ...;
};
warnings: (
| (...)
| (...)
| (...)
| (...))[];
workspace_id: string;
};
warnings: {
warning_code: "acs_credential_on_encoder_out_of_sync" | "acs_credential_on_seam_not_found";
warning_message: string;
}[];
};
status: "success";
}
| {
action_attempt_id: string;
action_type: "SCAN_CREDENTIAL";
error: {
message: string;
type: "uncategorized_error";
} | {
message: string;
type: "action_attempt_expired";
} | {
message: string;
type: "no_card_on_encoder";
};
result: null;
status: "error";
}
| {
action_attempt_id: string;
action_type: "ENCODE_CREDENTIAL";
error: null;
result: null;
status: "pending";
}
| {
action_attempt_id: string;
action_type: "ENCODE_CREDENTIAL";
error: null;
result: {
access_method: "code" | "card" | "mobile_key";
acs_credential_id: string;
acs_credential_pool_id?: string;
acs_system_id: string;
acs_user_id?: string;
card_number?: null | string;
code?: null | string;
created_at: string;
display_name: string;
ends_at?: string;
errors: {
error_code: string;
message: string;
}[];
external_type?:
| "pti_card"
| "brivo_credential"
| "hid_credential"
| "visionline_card"
| "salto_ks_credential";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean;
is_managed: true;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: null | string;
latest_desired_state_synced_with_provider_at?: string;
parent_acs_credential_id?: string;
starts_at?: string;
visionline_metadata?: {
auto_join?: (...) | (...) | (...);
card_function_type: (...) | (...);
card_id?: (...) | (...);
common_acs_entrance_ids?: (...) | (...);
credential_id?: (...) | (...);
guest_acs_entrance_ids?: (...) | (...);
is_valid?: (...) | (...) | (...);
joiner_acs_credential_ids?: (...) | (...);
};
warnings: (
| {
created_at: ...;
message: ...;
warning_code: ...;
}
| {
created_at: ...;
message: ...;
warning_code: ...;
}
| {
created_at: ...;
message: ...;
warning_code: ...;
}
| {
created_at: ...;
message: ...;
warning_code: ...;
})[];
workspace_id: string;
} | {
access_method: "code" | "card" | "mobile_key";
acs_credential_id: string;
acs_credential_pool_id?: string;
acs_system_id: string;
acs_user_id?: string;
card_number?: null | string;
code?: null | string;
created_at: string;
display_name: string;
ends_at?: string;
errors: {
error_code: string;
message: string;
}[];
external_type?:
| "pti_card"
| "brivo_credential"
| "hid_credential"
| "visionline_card"
| "salto_ks_credential";
external_type_display_name?: string;
is_issued?: boolean;
is_latest_desired_state_synced_with_provider?: boolean;
is_managed: false;
is_multi_phone_sync_credential?: boolean;
is_one_time_use?: boolean;
issued_at?: null | string;
latest_desired_state_synced_with_provider_at?: string;
parent_acs_credential_id?: string;
starts_at?: string;
visionline_metadata?: {
auto_join?: (...) | (...) | (...);
card_function_type: (...) | (...);
card_id?: (...) | (...);
common_acs_entrance_ids?: (...) | (...);
credential_id?: (...) | (...);
guest_acs_entrance_ids?: (...) | (...);
is_valid?: (...) | (...) | (...);
joiner_acs_credential_ids?: (...) | (...);
};
warnings: (
| {
created_at: ...;
message: ...;
warning_code: ...;
}
| {
created_at: ...;
message: ...;
warning_code: ...;
}
| {
created_at: ...;
message: ...;
warning_code: ...;
}
| {
created_at: ...;
message: ...;
warning_code: ...;
})[];
workspace_id: string;
};
status: "success";
}
| {
action_attempt_id: string;
action_type: "ENCODE_CREDENTIAL";
error:
| {
message: string;
type: "uncategorized_error";
}
| {
message: string;
type: "action_attempt_expired";
}
| {
message: string;
type: "no_card_on_encoder";
}
| {
message: string;
type: "incompatible_card_format";
};
result: null;
status: "error";
}
| {
action_attempt_id: string;
action_type: "RESET_SANDBOX_WORKSPACE";
error: null;
result: null;
status: "pending";
}
| {
action_attempt_id: string;
action_type: "RESET_SANDBOX_WORKSPACE";
error: null;
result: {};
status: "success";
}
| {
action_attempt_id: string;
action_type: "RESET_SANDBOX_WORKSPACE";
error: {
message: string;
type: string;
};
result: null;
status: "error";
}
| {
action_attempt_id: string;
action_type: "SET_FAN_MODE";
error: null;
result: null;
status: "pending";
}
| {
action_attempt_id: string;
action_type: "SET_FAN_MODE";
error: null;
result: {};
status: "success";
}
| {
action_attempt_id: string;
action_type: "SET_FAN_MODE";
error: {
message: string;
type: string;
};
result: null;
status: "error";
}
| {
action_attempt_id: string;
action_type: "SET_HVAC_MODE";
error: null;
result: null;
status: "pending";
}
| {
action_attempt_id: string;
action_type: "SET_HVAC_MODE";
error: null;
result: {};
status: "success";
}
| {
action_attempt_id: string;
action_type: "SET_HVAC_MODE";
error: {
message: string;
type: string;
};
result: null;
status: "error";
}
| {
action_attempt_id: string;
action_type: "ACTIVATE_CLIMATE_PRESET";
error: null;
result: null;
status: "pending";
}
| {
action_attempt_id: string;
action_type: "ACTIVATE_CLIMATE_PRESET";
error: null;
result: {};
status: "success";
}
| {
action_attempt_id: string;
action_type: "ACTIVATE_CLIMATE_PRESET";
error: {
message: string;
type: string;
};
result: null;
status: "error";
}
| {
action_attempt_id: string;
action_type: "SYNC_ACCESS_CODES";
error: null;
result: null;
status: "pending";
}
| {
action_attempt_id: string;
action_type: "SYNC_ACCESS_CODES";
error: null;
result: {};
status: "success";
}
| {
action_attempt_id: string;
action_type: "SYNC_ACCESS_CODES";
error: {
message: string;
type: string;
};
result: null;
status: "error";
}
| {
action_attempt_id: string;
action_type: "CREATE_ACCESS_CODE";
error: null;
result: null;
status: "pending";
}
| {
action_attempt_id: string;
action_type: "CREATE_ACCESS_CODE";
error: null;
result: {
access_code?: any;
};
status: "success";
}
| {
action_attempt_id: string;
action_type: "CREATE_ACCESS_CODE";
error: {
message: string;
type: string;
};
result: null;
status: "error";
}
| {
action_attempt_id: string;
action_type: "DELETE_ACCESS_CODE";
error: null;
result: null;
status: "pending";
}
| {
action_attempt_id: string;
action_type: "DELETE_ACCESS_CODE";
error: null;
result: {};
status: "success";
}
| {
action_attempt_id: string;
action_type: "DELETE_ACCESS_CODE";
error: {
message: string;
type: string;
};
result: null;
status: "error";
}
| {
action_attempt_id: string;
action_type: "UPDATE_ACCESS_CODE";
error: null;
result: null;
status: "pending";
}
| {
action_attempt_id: string;
action_type: "UPDATE_ACCESS_CODE";
error: null;
result: {
access_code?: any;
};
status: "success";
}
| {
action_attempt_id: string;
action_type: "UPDATE_ACCESS_CODE";
error: {
message: string;
type: string;
};
result: null;
status: "error";
}
| {
action_attempt_id: string;
action_type: "CREATE_NOISE_THRESHOLD";
error: null;
result: null;
status: "pending";
}
| {
action_attempt_id: string;
action_type: "CREATE_NOISE_THRESHOLD";
error: null;
result: {
noise_threshold?: any;
};
status: "success";
}
| {
action_attempt_id: string;
action_type: "CREATE_NOISE_THRESHOLD";
error: {
message: string;
type: string;
};
result: null;
status: "error";
}
| {
action_attempt_id: string;
action_type: "DELETE_NOISE_THRESHOLD";
error: null;
result: null;
status: "pending";
}
| {
action_attempt_id: string;
action_type: "DELETE_NOISE_THRESHOLD";
error: null;
result: {};
status: "success";
}
| {
action_attempt_id: string;
action_type: "DELETE_NOISE_THRESHOLD";
error: {
message: string;
type: string;
};
result: null;
status: "error";
}
| {
action_attempt_id: string;
action_type: "UPDATE_NOISE_THRESHOLD";
error: null;
result: null;
status: "pending";
}
| {
action_attempt_id: string;
action_type: "UPDATE_NOISE_THRESHOLD";
error: null;
result: {
noise_threshold?: any;
};
status: "success";
}
| {
action_attempt_id: string;
action_type: "UPDATE_NOISE_THRESHOLD";
error: {
message: string;
type: string;
};
result: null;
status: "error";
};
}>, "access_code" | "action_attempt">, "access_code">
createMultiple
- createMultiple(body?): SeamHttpRequest<SetNonNullable<Required<{
access_codes: {
access_code_id: string;
code: null | string;
common_code_key: null | string;
created_at: string;
device_id: string;
ends_at?: null | string;
errors: ({
error_code: string;
is_access_code_error: true;
message: string;
} | {
error_code: string;
is_device_error: true;
message: string;
} | {
error_code: string;
is_connected_account_error: true;
message: string;
})[];
is_backup?: boolean;
is_backup_access_code_available: boolean;
is_external_modification_allowed: boolean;
is_managed: true;
is_offline_access_code: boolean;
is_one_time_use: boolean;
is_scheduled_on_device?: boolean;
is_waiting_for_code_assignment?: boolean;
name: null | string;
pulled_backup_access_code_id?: null | string;
starts_at?: null | string;
status:
| "set"
| "unknown"
| "setting"
| "unset"
| "removing";
type: "time_bound" | "ongoing";
warnings: {
message: string;
warning_code: string;
}[];
}[];
}>, "access_codes">, "access_codes"> Parameters
Optionalbody: {
allow_external_modification?: boolean;
attempt_for_offline_device?: boolean;
behavior_when_code_cannot_be_shared?: "throw" | "create_random_code";
code?: string;
device_ids: string[];
ends_at?: string;
is_external_modification_allowed?: boolean;
is_offline_access_code?: boolean;
is_one_time_use?: boolean;
max_time_rounding?:
| "1hour"
| "1day"
| "1h"
| "1d";
name?: string;
prefer_native_scheduling?: boolean;
preferred_code_length?: number;
starts_at?: string;
use_backup_access_code_pool?: boolean;
use_offline_access_code?: boolean;
}Optionalallow_external_modification?: boolean
Optionalattempt_for_offline_device?: boolean
Optionalbehavior_when_code_cannot_be_shared?: "throw" | "create_random_code"
Optionalcode?: string
device_ids: string[]
Optionalends_at?: string
Optionalis_external_modification_allowed?: boolean
Optionalis_offline_access_code?: boolean
Optionalis_one_time_use?: boolean
Optionalmax_time_rounding?:
| "1hour"
| "1day"
| "1h"
| "1d"
Optionalname?: string
Optionalprefer_native_scheduling?: boolean
Optionalpreferred_code_length?: number
Optionalstarts_at?: string
Optionaluse_backup_access_code_pool?: boolean
Optionaluse_offline_access_code?: boolean
Returns SeamHttpRequest<SetNonNullable<Required<{
access_codes: {
access_code_id: string;
code: null | string;
common_code_key: null | string;
created_at: string;
device_id: string;
ends_at?: null | string;
errors: ({
error_code: string;
is_access_code_error: true;
message: string;
} | {
error_code: string;
is_device_error: true;
message: string;
} | {
error_code: string;
is_connected_account_error: true;
message: string;
})[];
is_backup?: boolean;
is_backup_access_code_available: boolean;
is_external_modification_allowed: boolean;
is_managed: true;
is_offline_access_code: boolean;
is_one_time_use: boolean;
is_scheduled_on_device?: boolean;
is_waiting_for_code_assignment?: boolean;
name: null | string;
pulled_backup_access_code_id?: null | string;
starts_at?: null | string;
status:
| "set"
| "unknown"
| "setting"
| "unset"
| "removing";
type: "time_bound" | "ongoing";
warnings: {
message: string;
warning_code: string;
}[];
}[];
}>, "access_codes">, "access_codes">
delete
- delete(body?): SeamHttpRequest<void, undefined>
Parameters
Optionalbody: {
access_code_id: string;
device_id?: string;
sync?: boolean;
}access_code_id: string
Optionaldevice_id?: string
Optionalsync?: boolean
generateCode
- generateCode(body?): SeamHttpRequest<SetNonNullable<Required<{
generated_code: {
code: string;
device_id: string;
};
}>, "generated_code">, "generated_code"> Parameters
Optionalbody: {
device_id: string;
}
Returns SeamHttpRequest<SetNonNullable<Required<{
generated_code: {
code: string;
device_id: string;
};
}>, "generated_code">, "generated_code">
get
- get(body?): SeamHttpRequest<SetNonNullable<Required<{
access_code: {
access_code_id: string;
code: null | string;
common_code_key: null | string;
created_at: string;
device_id: string;
ends_at?: null | string;
errors: ({
error_code: string;
is_access_code_error: true;
message: string;
} | {
error_code: string;
is_device_error: true;
message: string;
} | {
error_code: string;
is_connected_account_error: true;
message: string;
})[];
is_backup?: boolean;
is_backup_access_code_available: boolean;
is_external_modification_allowed: boolean;
is_managed: true;
is_offline_access_code: boolean;
is_one_time_use: boolean;
is_scheduled_on_device?: boolean;
is_waiting_for_code_assignment?: boolean;
name: null | string;
pulled_backup_access_code_id?: null | string;
starts_at?: null | string;
status:
| "set"
| "unknown"
| "setting"
| "unset"
| "removing";
type: "time_bound" | "ongoing";
warnings: {
message: string;
warning_code: string;
}[];
};
}>, "access_code">, "access_code"> Parameters
Optionalbody: {
access_code_id?: string;
code?: string;
device_id?: string;
}Optionalaccess_code_id?: string
Optionalcode?: string
Optionaldevice_id?: string
Returns SeamHttpRequest<SetNonNullable<Required<{
access_code: {
access_code_id: string;
code: null | string;
common_code_key: null | string;
created_at: string;
device_id: string;
ends_at?: null | string;
errors: ({
error_code: string;
is_access_code_error: true;
message: string;
} | {
error_code: string;
is_device_error: true;
message: string;
} | {
error_code: string;
is_connected_account_error: true;
message: string;
})[];
is_backup?: boolean;
is_backup_access_code_available: boolean;
is_external_modification_allowed: boolean;
is_managed: true;
is_offline_access_code: boolean;
is_one_time_use: boolean;
is_scheduled_on_device?: boolean;
is_waiting_for_code_assignment?: boolean;
name: null | string;
pulled_backup_access_code_id?: null | string;
starts_at?: null | string;
status:
| "set"
| "unknown"
| "setting"
| "unset"
| "removing";
type: "time_bound" | "ongoing";
warnings: {
message: string;
warning_code: string;
}[];
};
}>, "access_code">, "access_code">
list
- list(body?): SeamHttpRequest<SetNonNullable<Required<{
access_codes: {
access_code_id: string;
code: null | string;
common_code_key: null | string;
created_at: string;
device_id: string;
ends_at?: null | string;
errors: ({
error_code: string;
is_access_code_error: true;
message: string;
} | {
error_code: string;
is_device_error: true;
message: string;
} | {
error_code: string;
is_connected_account_error: true;
message: string;
})[];
is_backup?: boolean;
is_backup_access_code_available: boolean;
is_external_modification_allowed: boolean;
is_managed: true;
is_offline_access_code: boolean;
is_one_time_use: boolean;
is_scheduled_on_device?: boolean;
is_waiting_for_code_assignment?: boolean;
name: null | string;
pulled_backup_access_code_id?: null | string;
starts_at?: null | string;
status:
| "set"
| "unknown"
| "setting"
| "unset"
| "removing";
type: "time_bound" | "ongoing";
warnings: {
message: string;
warning_code: string;
}[];
}[];
}>, "access_codes">, "access_codes"> Parameters
Optionalbody: {
access_code_ids?: string[];
device_id?: string;
user_identifier_key?: string;
}Optionalaccess_code_ids?: string[]
Optionaldevice_id?: string
Optionaluser_identifier_key?: string
Returns SeamHttpRequest<SetNonNullable<Required<{
access_codes: {
access_code_id: string;
code: null | string;
common_code_key: null | string;
created_at: string;
device_id: string;
ends_at?: null | string;
errors: ({
error_code: string;
is_access_code_error: true;
message: string;
} | {
error_code: string;
is_device_error: true;
message: string;
} | {
error_code: string;
is_connected_account_error: true;
message: string;
})[];
is_backup?: boolean;
is_backup_access_code_available: boolean;
is_external_modification_allowed: boolean;
is_managed: true;
is_offline_access_code: boolean;
is_one_time_use: boolean;
is_scheduled_on_device?: boolean;
is_waiting_for_code_assignment?: boolean;
name: null | string;
pulled_backup_access_code_id?: null | string;
starts_at?: null | string;
status:
| "set"
| "unknown"
| "setting"
| "unset"
| "removing";
type: "time_bound" | "ongoing";
warnings: {
message: string;
warning_code: string;
}[];
}[];
}>, "access_codes">, "access_codes">
pullBackupAccessCode
- pullBackupAccessCode(body?): SeamHttpRequest<SetNonNullable<Required<{
access_code: {
access_code_id: string;
code: null | string;
common_code_key: null | string;
created_at: string;
device_id: string;
ends_at?: null | string;
errors: ({
error_code: string;
is_access_code_error: true;
message: string;
} | {
error_code: string;
is_device_error: true;
message: string;
} | {
error_code: string;
is_connected_account_error: true;
message: string;
})[];
is_backup?: boolean;
is_backup_access_code_available: boolean;
is_external_modification_allowed: boolean;
is_managed: true;
is_offline_access_code: boolean;
is_one_time_use: boolean;
is_scheduled_on_device?: boolean;
is_waiting_for_code_assignment?: boolean;
name: null | string;
pulled_backup_access_code_id?: null | string;
starts_at?: null | string;
status:
| "set"
| "unknown"
| "setting"
| "unset"
| "removing";
type: "time_bound" | "ongoing";
warnings: {
message: string;
warning_code: string;
}[];
};
backup_access_code: {
access_code_id: string;
code: null | string;
common_code_key: null | string;
created_at: string;
device_id: string;
ends_at?: null | string;
errors: ({
error_code: string;
is_access_code_error: true;
message: string;
} | {
error_code: string;
is_device_error: true;
message: string;
} | {
error_code: string;
is_connected_account_error: true;
message: string;
})[];
is_backup?: boolean;
is_backup_access_code_available: boolean;
is_external_modification_allowed: boolean;
is_managed: true;
is_offline_access_code: boolean;
is_one_time_use: boolean;
is_scheduled_on_device?: boolean;
is_waiting_for_code_assignment?: boolean;
name: null | string;
pulled_backup_access_code_id?: null | string;
starts_at?: null | string;
status:
| "set"
| "unknown"
| "setting"
| "unset"
| "removing";
type: "time_bound" | "ongoing";
warnings: {
message: string;
warning_code: string;
}[];
};
}>, "access_code" | "backup_access_code">, "access_code"> Parameters
Optionalbody: {
access_code_id: string;
}
Returns SeamHttpRequest<SetNonNullable<Required<{
access_code: {
access_code_id: string;
code: null | string;
common_code_key: null | string;
created_at: string;
device_id: string;
ends_at?: null | string;
errors: ({
error_code: string;
is_access_code_error: true;
message: string;
} | {
error_code: string;
is_device_error: true;
message: string;
} | {
error_code: string;
is_connected_account_error: true;
message: string;
})[];
is_backup?: boolean;
is_backup_access_code_available: boolean;
is_external_modification_allowed: boolean;
is_managed: true;
is_offline_access_code: boolean;
is_one_time_use: boolean;
is_scheduled_on_device?: boolean;
is_waiting_for_code_assignment?: boolean;
name: null | string;
pulled_backup_access_code_id?: null | string;
starts_at?: null | string;
status:
| "set"
| "unknown"
| "setting"
| "unset"
| "removing";
type: "time_bound" | "ongoing";
warnings: {
message: string;
warning_code: string;
}[];
};
backup_access_code: {
access_code_id: string;
code: null | string;
common_code_key: null | string;
created_at: string;
device_id: string;
ends_at?: null | string;
errors: ({
error_code: string;
is_access_code_error: true;
message: string;
} | {
error_code: string;
is_device_error: true;
message: string;
} | {
error_code: string;
is_connected_account_error: true;
message: string;
})[];
is_backup?: boolean;
is_backup_access_code_available: boolean;
is_external_modification_allowed: boolean;
is_managed: true;
is_offline_access_code: boolean;
is_one_time_use: boolean;
is_scheduled_on_device?: boolean;
is_waiting_for_code_assignment?: boolean;
name: null | string;
pulled_backup_access_code_id?: null | string;
starts_at?: null | string;
status:
| "set"
| "unknown"
| "setting"
| "unset"
| "removing";
type: "time_bound" | "ongoing";
warnings: {
message: string;
warning_code: string;
}[];
};
}>, "access_code" | "backup_access_code">, "access_code">
update
- update(body?): SeamHttpRequest<void, undefined>
Parameters
Optionalbody: {
access_code_id: string;
allow_external_modification?: boolean;
attempt_for_offline_device?: boolean;
code?: string;
device_id?: string;
ends_at?: string;
is_external_modification_allowed?: boolean;
is_managed?: boolean;
is_offline_access_code?: boolean;
is_one_time_use?: boolean;
max_time_rounding?:
| "1hour"
| "1day"
| "1h"
| "1d";
name?: string;
prefer_native_scheduling?: boolean;
preferred_code_length?: number;
starts_at?: string;
sync?: boolean;
type?: "time_bound" | "ongoing";
use_backup_access_code_pool?: boolean;
use_offline_access_code?: boolean;
}access_code_id: string
Optionalallow_external_modification?: boolean
Optionalattempt_for_offline_device?: boolean
Optionalcode?: string
Optionaldevice_id?: string
Optionalends_at?: string
Optionalis_external_modification_allowed?: boolean
Optionalis_managed?: boolean
Optionalis_offline_access_code?: boolean
Optionalis_one_time_use?: boolean
Optionalmax_time_rounding?:
| "1hour"
| "1day"
| "1h"
| "1d"
Optionalname?: string
Optionalprefer_native_scheduling?: boolean
Optionalpreferred_code_length?: number
Optionalstarts_at?: string
Optionalsync?: boolean
Optionaltype?: "time_bound" | "ongoing"
Optionaluse_backup_access_code_pool?: boolean
Optionaluse_offline_access_code?: boolean
updateClientSessionToken
- updateClientSessionToken(clientSessionToken): Promise<void>
Parameters
- clientSessionToken: string
Returns Promise<void>
updateMultiple
- updateMultiple(body?): SeamHttpRequest<void, undefined>
Parameters
Optionalbody: {
common_code_key: string;
ends_at?: string;
name?: string;
starts_at?: string;
}common_code_key: string
Optionalends_at?: string
Optionalname?: string
Optionalstarts_at?: string
StaticfromApiKey
- fromApiKey(apiKey, options?): SeamHttpAccessCodes
StaticfromClient
- fromClient(client, options?): SeamHttpAccessCodes
StaticfromClientSessionToken
- fromClientSessionToken(clientSessionToken, options?): SeamHttpAccessCodes
StaticfromConsoleSessionToken
- fromConsoleSessionToken(consoleSessionToken, workspaceId, options?): SeamHttpAccessCodes
StaticfromPersonalAccessToken
- fromPersonalAccessToken(personalAccessToken, workspaceId, options?): SeamHttpAccessCodes
StaticfromPublishableKey
- fromPublishableKey(publishableKey, userIdentifierKey, options?): Promise<SeamHttpAccessCodes>