Class SeamHttpAccessCodes

constructor

• new SeamHttpAccessCodes(apiKeyOrOptions?): SeamHttpAccessCodes

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpAccessCodes

client

unmanaged

• get unmanaged(): SeamHttpAccessCodesUnmanaged

• Returns SeamHttpAccessCodesUnmanaged

create

• create(body): Promise<{
      access_code_id: string;
      code: null | string;
      common_code_key: null | string;
      created_at: string;
      device_id: string;
      ends_at?: string;
      errors?: any;
      is_backup?: boolean;
      is_backup_access_code_available: boolean;
      is_external_modification_allowed: boolean;
      is_managed: true;
      is_scheduled_on_device?: boolean;
      is_waiting_for_code_assignment?: boolean;
      name: null | string;
      pulled_backup_access_code_id?: null | string;
      starts_at?: string;
      status: "set" | "unknown" | "setting" | "unset" | "removing";
      type: "time_bound" | "ongoing";
      warnings?: any;
  }>

• Parameters

  • 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;
        name?: string;
        prefer_native_scheduling?: boolean;
        starts_at?: string;
        sync?: boolean;
        use_backup_access_code_pool?: 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 name?: string

    • Optional prefer_native_scheduling?: boolean

    • Optional starts_at?: string

    • Optional sync?: boolean

    • Optional use_backup_access_code_pool?: boolean

  Returns Promise<{
      access_code_id: string;
      code: null | string;
      common_code_key: null | string;
      created_at: string;
      device_id: string;
      ends_at?: string;
      errors?: any;
      is_backup?: boolean;
      is_backup_access_code_available: boolean;
      is_external_modification_allowed: boolean;
      is_managed: true;
      is_scheduled_on_device?: boolean;
      is_waiting_for_code_assignment?: boolean;
      name: null | string;
      pulled_backup_access_code_id?: null | string;
      starts_at?: string;
      status: "set" | "unknown" | "setting" | "unset" | "removing";
      type: "time_bound" | "ongoing";
      warnings?: any;
  }>

createMultiple

• createMultiple(body): Promise<{
      access_code_id: string;
      code: null | string;
      common_code_key: null | string;
      created_at: string;
      device_id: string;
      ends_at?: string;
      errors?: any;
      is_backup?: boolean;
      is_backup_access_code_available: boolean;
      is_external_modification_allowed: boolean;
      is_managed: true;
      is_scheduled_on_device?: boolean;
      is_waiting_for_code_assignment?: boolean;
      name: null | string;
      pulled_backup_access_code_id?: null | string;
      starts_at?: string;
      status: "set" | "unknown" | "setting" | "unset" | "removing";
      type: "time_bound" | "ongoing";
      warnings?: any;
  }[]>

• Parameters

  • 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;
        name?: string;
        prefer_native_scheduling?: boolean;
        starts_at?: string;
        use_backup_access_code_pool?: 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 name?: string

    • Optional prefer_native_scheduling?: boolean

    • Optional starts_at?: string

    • Optional use_backup_access_code_pool?: boolean

  Returns Promise<{
      access_code_id: string;
      code: null | string;
      common_code_key: null | string;
      created_at: string;
      device_id: string;
      ends_at?: string;
      errors?: any;
      is_backup?: boolean;
      is_backup_access_code_available: boolean;
      is_external_modification_allowed: boolean;
      is_managed: true;
      is_scheduled_on_device?: boolean;
      is_waiting_for_code_assignment?: boolean;
      name: null | string;
      pulled_backup_access_code_id?: null | string;
      starts_at?: string;
      status: "set" | "unknown" | "setting" | "unset" | "removing";
      type: "time_bound" | "ongoing";
      warnings?: any;
  }[]>

delete

• delete(body): Promise<void>

• Parameters

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

    • access_code_id: string

    • Optional device_id?: string

    • Optional sync?: boolean

  Returns Promise<void>

generateCode

• generateCode(body): Promise<{
      code: string;
      device_id: string;
  }>

• Parameters

  • body: {
        device_id: string;
    }

    • device_id: string

  Returns Promise<{
      code: string;
      device_id: string;
  }>

get

• get(body): Promise<{
      access_code_id: string;
      code: null | string;
      common_code_key: null | string;
      created_at: string;
      device_id: string;
      ends_at?: string;
      errors?: any;
      is_backup?: boolean;
      is_backup_access_code_available: boolean;
      is_external_modification_allowed: boolean;
      is_managed: true;
      is_scheduled_on_device?: boolean;
      is_waiting_for_code_assignment?: boolean;
      name: null | string;
      pulled_backup_access_code_id?: null | string;
      starts_at?: string;
      status: "set" | "unknown" | "setting" | "unset" | "removing";
      type: "time_bound" | "ongoing";
      warnings?: any;
  }>

• Parameters

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

    • Optional access_code_id?: string

    • Optional code?: string

    • Optional device_id?: string

  Returns Promise<{
      access_code_id: string;
      code: null | string;
      common_code_key: null | string;
      created_at: string;
      device_id: string;
      ends_at?: string;
      errors?: any;
      is_backup?: boolean;
      is_backup_access_code_available: boolean;
      is_external_modification_allowed: boolean;
      is_managed: true;
      is_scheduled_on_device?: boolean;
      is_waiting_for_code_assignment?: boolean;
      name: null | string;
      pulled_backup_access_code_id?: null | string;
      starts_at?: string;
      status: "set" | "unknown" | "setting" | "unset" | "removing";
      type: "time_bound" | "ongoing";
      warnings?: any;
  }>

list

• list(body): Promise<{
      access_code_id: string;
      code: null | string;
      common_code_key: null | string;
      created_at: string;
      device_id: string;
      ends_at?: string;
      errors?: any;
      is_backup?: boolean;
      is_backup_access_code_available: boolean;
      is_external_modification_allowed: boolean;
      is_managed: true;
      is_scheduled_on_device?: boolean;
      is_waiting_for_code_assignment?: boolean;
      name: null | string;
      pulled_backup_access_code_id?: null | string;
      starts_at?: string;
      status: "set" | "unknown" | "setting" | "unset" | "removing";
      type: "time_bound" | "ongoing";
      warnings?: any;
  }[]>

• Parameters

  • 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 Promise<{
      access_code_id: string;
      code: null | string;
      common_code_key: null | string;
      created_at: string;
      device_id: string;
      ends_at?: string;
      errors?: any;
      is_backup?: boolean;
      is_backup_access_code_available: boolean;
      is_external_modification_allowed: boolean;
      is_managed: true;
      is_scheduled_on_device?: boolean;
      is_waiting_for_code_assignment?: boolean;
      name: null | string;
      pulled_backup_access_code_id?: null | string;
      starts_at?: string;
      status: "set" | "unknown" | "setting" | "unset" | "removing";
      type: "time_bound" | "ongoing";
      warnings?: any;
  }[]>

pullBackupAccessCode

• pullBackupAccessCode(body): Promise<{
      access_code_id: string;
      code: null | string;
      common_code_key: null | string;
      created_at: string;
      device_id: string;
      ends_at?: string;
      errors?: any;
      is_backup?: boolean;
      is_backup_access_code_available: boolean;
      is_external_modification_allowed: boolean;
      is_managed: true;
      is_scheduled_on_device?: boolean;
      is_waiting_for_code_assignment?: boolean;
      name: null | string;
      pulled_backup_access_code_id?: null | string;
      starts_at?: string;
      status: "set" | "unknown" | "setting" | "unset" | "removing";
      type: "time_bound" | "ongoing";
      warnings?: any;
  }>

• Parameters

  • body: {
        access_code_id: string;
    }

    • access_code_id: string

  Returns Promise<{
      access_code_id: string;
      code: null | string;
      common_code_key: null | string;
      created_at: string;
      device_id: string;
      ends_at?: string;
      errors?: any;
      is_backup?: boolean;
      is_backup_access_code_available: boolean;
      is_external_modification_allowed: boolean;
      is_managed: true;
      is_scheduled_on_device?: boolean;
      is_waiting_for_code_assignment?: boolean;
      name: null | string;
      pulled_backup_access_code_id?: null | string;
      starts_at?: string;
      status: "set" | "unknown" | "setting" | "unset" | "removing";
      type: "time_bound" | "ongoing";
      warnings?: any;
  }>

update

• update(body): Promise<void>

• Parameters

  • 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;
        name?: string;
        prefer_native_scheduling?: boolean;
        starts_at?: string;
        sync?: boolean;
        type?: "time_bound" | "ongoing";
        use_backup_access_code_pool?: 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 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

  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 fromPublishableKey

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

• Parameters

  • publishableKey: string

  • userIdentifierKey: string

  • options: SeamHttpFromPublishableKeyOptions = {}

  Returns Promise<SeamHttpAccessCodes>