Class SeamHttpAccessCodes

constructor

• new SeamHttpAccessCodes(apiKeyOrOptions?): SeamHttpAccessCodes

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpAccessCodes

client

Readonly defaults

simulate

• get simulate(): SeamHttpAccessCodesSimulate

• Returns SeamHttpAccessCodesSimulate

unmanaged

• get unmanaged(): SeamHttpAccessCodesUnmanaged

• Returns SeamHttpAccessCodesUnmanaged

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?: any;
          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?: any;
      };
      action_attempt: {
          action_attempt_id: string;
          action_type: string;
          error: null;
          result?: any;
          status: "success";
      } | {
          action_attempt_id: string;
          action_type: string;
          error: null;
          result: null;
          status: "pending";
      } | {
          action_attempt_id: string;
          action_type: string;
          error: {
              message: string;
              type: string;
          };
          result: null;
          status: "error";
      };
  }>, "access_code" | "action_attempt">, "access_code">

• Parameters

  • Optional body: {
        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;
        starts_at?: string;
        sync?: boolean;
        use_backup_access_code_pool?: boolean;
        use_offline_access_code?: boolean;
    }

    • Optional allow_external_modification?: boolean

    • Optional attempt_for_offline_device?: boolean

    • Optional code?: string

    • Optional common_code_key?: string

    • device_id: string

    • Optional ends_at?: string

    • Optional is_external_modification_allowed?: boolean

    • Optional is_offline_access_code?: boolean

    • Optional is_one_time_use?: boolean

    • Optional max_time_rounding?: "1hour" | "1day" | "1h" | "1d"

    • Optional name?: string

    • Optional prefer_native_scheduling?: boolean

    • Optional starts_at?: string

    • Optional sync?: boolean

    • Optional use_backup_access_code_pool?: boolean

    • Optional use_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?: any;
          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?: any;
      };
      action_attempt: {
          action_attempt_id: string;
          action_type: string;
          error: null;
          result?: any;
          status: "success";
      } | {
          action_attempt_id: string;
          action_type: string;
          error: null;
          result: null;
          status: "pending";
      } | {
          action_attempt_id: string;
          action_type: string;
          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?: any;
          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?: any;
      }[];
  }>, "access_codes">, "access_codes">

• Parameters

  • Optional body: {
        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;
    }

    • Optional allow_external_modification?: boolean

    • Optional attempt_for_offline_device?: boolean

    • Optional behavior_when_code_cannot_be_shared?: "throw" | "create_random_code"

    • Optional code?: string

    • device_ids: string[]

    • Optional ends_at?: string

    • Optional is_external_modification_allowed?: boolean

    • Optional is_offline_access_code?: boolean

    • Optional is_one_time_use?: boolean

    • Optional max_time_rounding?: "1hour" | "1day" | "1h" | "1d"

    • Optional name?: string

    • Optional prefer_native_scheduling?: boolean

    • Optional preferred_code_length?: number

    • Optional starts_at?: string

    • Optional use_backup_access_code_pool?: boolean

    • Optional use_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?: any;
          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?: any;
      }[];
  }>, "access_codes">, "access_codes">

delete

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

• Parameters

  • Optional body: {
        access_code_id: string;
        device_id?: string;
        sync?: boolean;
    }

    • access_code_id: string

    • Optional device_id?: string

    • Optional sync?: boolean

  Returns SeamHttpRequest<void, undefined>

generateCode

• generateCode(body?): SeamHttpRequest<SetNonNullable<Required<{
      generated_code: {
          code: string;
          device_id: string;
      };
  }>, "generated_code">, "generated_code">

• Parameters

  • Optional body: {
        device_id: string;
    }

    • 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?: any;
          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?: any;
      };
  }>, "access_code">, "access_code">

• Parameters

  • Optional body: {
        access_code_id?: string;
        code?: string;
        device_id?: string;
    }

    • Optional access_code_id?: string

    • Optional code?: string

    • Optional device_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?: any;
          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?: any;
      };
  }>, "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?: any;
          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?: any;
      }[];
  }>, "access_codes">, "access_codes">

• Parameters

  • Optional body: {
        access_code_ids?: string[];
        device_id?: string;
        user_identifier_key?: string;
    }

    • Optional access_code_ids?: string[]

    • Optional device_id?: string

    • Optional user_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?: any;
          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?: any;
      }[];
  }>, "access_codes">, "access_codes">

pullBackupAccessCode

• pullBackupAccessCode(body?): SeamHttpRequest<SetNonNullable<Required<{
      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?: any;
          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?: any;
      };
  }>, "backup_access_code">, "backup_access_code">

• Parameters

  • Optional body: {
        access_code_id: string;
    }

    • access_code_id: string

  Returns SeamHttpRequest<SetNonNullable<Required<{
      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?: any;
          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?: any;
      };
  }>, "backup_access_code">, "backup_access_code">

update

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

• Parameters

  • Optional body: {
        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;
        starts_at?: string;
        sync?: boolean;
        type?: "time_bound" | "ongoing";
        use_backup_access_code_pool?: boolean;
        use_offline_access_code?: boolean;
    }

    • access_code_id: string

    • Optional allow_external_modification?: boolean

    • Optional attempt_for_offline_device?: boolean

    • Optional code?: string

    • Optional device_id?: string

    • Optional ends_at?: string

    • Optional is_external_modification_allowed?: boolean

    • Optional is_managed?: boolean

    • Optional is_offline_access_code?: boolean

    • Optional is_one_time_use?: boolean

    • Optional max_time_rounding?: "1hour" | "1day" | "1h" | "1d"

    • Optional name?: string

    • Optional prefer_native_scheduling?: boolean

    • Optional starts_at?: string

    • Optional sync?: boolean

    • Optional type?: "time_bound" | "ongoing"

    • Optional use_backup_access_code_pool?: boolean

    • Optional use_offline_access_code?: boolean

  Returns SeamHttpRequest<void, undefined>

updateClientSessionToken

• updateClientSessionToken(clientSessionToken): Promise<void>

• Parameters

  • clientSessionToken: string

  Returns Promise<void>

Static fromApiKey

• fromApiKey(apiKey, options?): SeamHttpAccessCodes

• Parameters

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

  Returns SeamHttpAccessCodes

Static fromClient

• fromClient(client, options?): SeamHttpAccessCodes

• Parameters

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

  Returns SeamHttpAccessCodes

Static fromClientSessionToken

• fromClientSessionToken(clientSessionToken, options?): SeamHttpAccessCodes

• Parameters

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

  Returns SeamHttpAccessCodes

Static fromConsoleSessionToken

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

• Parameters

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

  Returns SeamHttpAccessCodes

Static fromPersonalAccessToken

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

• Parameters

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

  Returns SeamHttpAccessCodes

Static fromPublishableKey

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

• Parameters

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

  Returns Promise<SeamHttpAccessCodes>