Class SeamHttpAccessCodesUnmanaged

constructor

• new SeamHttpAccessCodesUnmanaged(apiKeyOrOptions?): SeamHttpAccessCodesUnmanaged

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpAccessCodesUnmanaged

client

Readonlydefaults

convertToManaged

• convertToManaged(body?): SeamHttpRequest<void, undefined>

• Parameters

  • Optionalbody: {
        access_code_id: string;
        allow_external_modification?: boolean;
        force?: boolean;
        is_external_modification_allowed?: boolean;
        sync?: boolean;
    }

    • access_code_id: string

    • Optionalallow_external_modification?: boolean

    • Optionalforce?: boolean

    • Optionalis_external_modification_allowed?: boolean

    • Optionalsync?: boolean

  Returns SeamHttpRequest<void, undefined>

delete

• delete(body?): SeamHttpRequest<void, undefined>

• Parameters

  • Optionalbody: {
        access_code_id: string;
        sync?: boolean;
    }

    • access_code_id: string

    • Optionalsync?: boolean

  Returns SeamHttpRequest<void, undefined>

get

• get(body?): SeamHttpRequest<SetNonNullable<Required<{
      access_code: {
          access_code_id: string;
          code: 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: "device_offline";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "device_removed";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "account_disconnected";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "hub_disconnected";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "device_disconnected";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "empty_backup_access_code_pool";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "august_lock_not_authorized";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "august_lock_missing_bridge";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "salto_site_user_limit_reached";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "ttlock_lock_not_paired_to_gateway";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "missing_device_credentials";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "auxiliary_heat_running";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "subscription_required";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: string;
                  is_connected_account_error: true;
                  message: string;
              })[];
          is_managed: false;
          name: null | string;
          starts_at?: null | string;
          status: "set";
          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;
          created_at: string;
          device_id: string;
          ends_at?: null | string;
          errors: (
              | {
                  error_code: string;
                  is_access_code_error: true;
                  message: string;
              }
              | {
                  error_code: "device_offline";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "device_removed";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "account_disconnected";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "hub_disconnected";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "device_disconnected";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "empty_backup_access_code_pool";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "august_lock_not_authorized";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "august_lock_missing_bridge";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "salto_site_user_limit_reached";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "ttlock_lock_not_paired_to_gateway";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "missing_device_credentials";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "auxiliary_heat_running";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "subscription_required";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: string;
                  is_connected_account_error: true;
                  message: string;
              })[];
          is_managed: false;
          name: null | string;
          starts_at?: null | string;
          status: "set";
          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;
          created_at: string;
          device_id: string;
          ends_at?: null | string;
          errors: (
              | {
                  error_code: string;
                  is_access_code_error: true;
                  message: string;
              }
              | {
                  error_code: "device_offline";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "device_removed";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "account_disconnected";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "hub_disconnected";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "device_disconnected";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "empty_backup_access_code_pool";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "august_lock_not_authorized";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "august_lock_missing_bridge";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "salto_site_user_limit_reached";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "ttlock_lock_not_paired_to_gateway";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "missing_device_credentials";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "auxiliary_heat_running";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "subscription_required";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: string;
                  is_connected_account_error: true;
                  message: string;
              })[];
          is_managed: false;
          name: null | string;
          starts_at?: null | string;
          status: "set";
          type: "time_bound" | "ongoing";
          warnings: {
              message: string;
              warning_code: string;
          }[];
      }[];
  }>, "access_codes">, "access_codes">

• Parameters

  • Optionalbody: {
        device_id: string;
        user_identifier_key?: string;
    }

    • device_id: string

    • Optionaluser_identifier_key?: string

  Returns SeamHttpRequest<SetNonNullable<Required<{
      access_codes: {
          access_code_id: string;
          code: 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: "device_offline";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "device_removed";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "account_disconnected";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "hub_disconnected";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "device_disconnected";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "empty_backup_access_code_pool";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "august_lock_not_authorized";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "august_lock_missing_bridge";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "salto_site_user_limit_reached";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "ttlock_lock_not_paired_to_gateway";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "missing_device_credentials";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "auxiliary_heat_running";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: "subscription_required";
                  is_device_error: true;
                  message: string;
              }
              | {
                  error_code: string;
                  is_connected_account_error: true;
                  message: string;
              })[];
          is_managed: false;
          name: null | string;
          starts_at?: null | string;
          status: "set";
          type: "time_bound" | "ongoing";
          warnings: {
              message: string;
              warning_code: string;
          }[];
      }[];
  }>, "access_codes">, "access_codes">

update

• update(body?): SeamHttpRequest<void, undefined>

• Parameters

  • Optionalbody: {
        access_code_id: string;
        allow_external_modification?: boolean;
        force?: boolean;
        is_external_modification_allowed?: boolean;
        is_managed: boolean;
    }

    • access_code_id: string

    • Optionalallow_external_modification?: boolean

    • Optionalforce?: boolean

    • Optionalis_external_modification_allowed?: boolean

    • is_managed: boolean

  Returns SeamHttpRequest<void, undefined>

updateClientSessionToken

• updateClientSessionToken(clientSessionToken): Promise<void>

• Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

• fromApiKey(apiKey, options?): SeamHttpAccessCodesUnmanaged

• Parameters

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

  Returns SeamHttpAccessCodesUnmanaged

StaticfromClient

• fromClient(client, options?): SeamHttpAccessCodesUnmanaged

• Parameters

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

  Returns SeamHttpAccessCodesUnmanaged

StaticfromClientSessionToken

• fromClientSessionToken(clientSessionToken, options?): SeamHttpAccessCodesUnmanaged

• Parameters

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

  Returns SeamHttpAccessCodesUnmanaged

StaticfromConsoleSessionToken

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

• Parameters

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

  Returns SeamHttpAccessCodesUnmanaged

StaticfromPersonalAccessToken

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

• Parameters

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

  Returns SeamHttpAccessCodesUnmanaged

StaticfromPublishableKey

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

• Parameters

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

  Returns Promise<SeamHttpAccessCodesUnmanaged>