Class SeamHttpAccessCodesUnmanaged

constructor

• new SeamHttpAccessCodesUnmanaged(apiKeyOrOptions?): SeamHttpAccessCodesUnmanaged

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpAccessCodesUnmanaged

client

Readonly defaults

convertToManaged

• convertToManaged(body?): Promise<void>

• Parameters

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

    • access_code_id: string

    • Optional allow_external_modification?: boolean

    • Optional force?: boolean

    • Optional is_external_modification_allowed?: boolean

    • Optional sync?: boolean

  Returns Promise<void>

delete

• delete(body?): Promise<void>

• Parameters

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

    • access_code_id: string

    • Optional sync?: boolean

  Returns Promise<void>

get

• get(body?): Promise<{
      access_code_id: string;
      code: null | string;
      created_at: string;
      device_id: string;
      ends_at?: null | string;
      errors?: any;
      is_managed: false;
      name: null | string;
      starts_at?: null | string;
      status: "set";
      type: "time_bound" | "ongoing";
      warnings?: any;
  }>

• 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 Promise<{
      access_code_id: string;
      code: null | string;
      created_at: string;
      device_id: string;
      ends_at?: null | string;
      errors?: any;
      is_managed: false;
      name: null | string;
      starts_at?: null | string;
      status: "set";
      type: "time_bound" | "ongoing";
      warnings?: any;
  }>

list

• list(body?): Promise<{
      access_code_id: string;
      code: null | string;
      created_at: string;
      device_id: string;
      ends_at?: null | string;
      errors?: any;
      is_managed: false;
      name: null | string;
      starts_at?: null | string;
      status: "set";
      type: "time_bound" | "ongoing";
      warnings?: any;
  }[]>

• Parameters

  • Optional body: {
        device_id: string;
        user_identifier_key?: string;
    }

    • device_id: string

    • Optional user_identifier_key?: string

  Returns Promise<{
      access_code_id: string;
      code: null | string;
      created_at: string;
      device_id: string;
      ends_at?: null | string;
      errors?: any;
      is_managed: false;
      name: null | string;
      starts_at?: null | string;
      status: "set";
      type: "time_bound" | "ongoing";
      warnings?: any;
  }[]>

update

• update(body?): Promise<void>

• Parameters

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

    • access_code_id: string

    • Optional allow_external_modification?: boolean

    • Optional force?: boolean

    • Optional is_external_modification_allowed?: boolean

    • is_managed: boolean

  Returns Promise<void>

updateClientSessionToken

• updateClientSessionToken(clientSessionToken): Promise<void>

• Parameters

  • clientSessionToken: string

  Returns Promise<void>

Static fromApiKey

• fromApiKey(apiKey, options?): SeamHttpAccessCodesUnmanaged

• Parameters

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

  Returns SeamHttpAccessCodesUnmanaged

Static fromClient

• fromClient(client, options?): SeamHttpAccessCodesUnmanaged

• Parameters

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

  Returns SeamHttpAccessCodesUnmanaged

Static fromClientSessionToken

• fromClientSessionToken(clientSessionToken, options?): SeamHttpAccessCodesUnmanaged

• Parameters

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

  Returns SeamHttpAccessCodesUnmanaged

Static fromConsoleSessionToken

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

• Parameters

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

  Returns SeamHttpAccessCodesUnmanaged

Static fromPersonalAccessToken

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

• Parameters

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

  Returns SeamHttpAccessCodesUnmanaged

Static fromPublishableKey

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

• Parameters

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

  Returns Promise<SeamHttpAccessCodesUnmanaged>