Class SeamHttpAccessCodes

constructor

• new SeamHttpAccessCodes(
      apiKeyOrOptions?: string | SeamHttpOptions,
  ): SeamHttpAccessCodes

  Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpAccessCodes

client

Readonlydefaults

ReadonlyltsVersion

StaticltsVersion

simulate

• get simulate(): SeamHttpAccessCodesSimulate

  Returns SeamHttpAccessCodesSimulate

unmanaged

• get unmanaged(): SeamHttpAccessCodesUnmanaged

  Returns SeamHttpAccessCodesUnmanaged

create

• create(
      parameters: AccessCodesCreateParameters,
      options?: AccessCodesCreateOptions,
  ): AccessCodesCreateRequest

  Parameters

  • parameters: AccessCodesCreateParameters
  • options: AccessCodesCreateOptions = {}

  Returns AccessCodesCreateRequest

createMultiple

• createMultiple(
      parameters: AccessCodesCreateMultipleParameters,
      options?: AccessCodesCreateMultipleOptions,
  ): AccessCodesCreateMultipleRequest

  Parameters

  • parameters: AccessCodesCreateMultipleParameters
  • options: AccessCodesCreateMultipleOptions = {}

  Returns AccessCodesCreateMultipleRequest

createPaginator

• createPaginator<
      const TResponse,
      const TResponseKey extends string | number | symbol,
  >(
      request: SeamHttpRequest<TResponse, TResponseKey>,
  ): SeamPaginator<TResponse, TResponseKey>

  Type Parameters

  • const TResponse
  • const TResponseKey extends string | number | symbol

  Parameters

  • request: SeamHttpRequest<TResponse, TResponseKey>

  Returns SeamPaginator<TResponse, TResponseKey>

delete

• delete(
      parameters: AccessCodesDeleteParameters,
      options?: AccessCodesDeleteOptions,
  ): AccessCodesDeleteRequest

  Parameters

  • parameters: AccessCodesDeleteParameters
  • options: AccessCodesDeleteOptions = {}

  Returns AccessCodesDeleteRequest

generateCode

• generateCode(
      parameters: AccessCodesGenerateCodeParameters,
      options?: AccessCodesGenerateCodeOptions,
  ): AccessCodesGenerateCodeRequest

  Parameters

  • parameters: AccessCodesGenerateCodeParameters
  • options: AccessCodesGenerateCodeOptions = {}

  Returns AccessCodesGenerateCodeRequest

get

• get(
      parameters?: AccessCodesGetParameters,
      options?: AccessCodesGetOptions,
  ): AccessCodesGetRequest

  Parameters

  • Optionalparameters: AccessCodesGetParameters
  • options: AccessCodesGetOptions = {}

  Returns AccessCodesGetRequest

getTimeline

• getTimeline(
      parameters: {
          access_code_id: string;
          after?: string;
          before?: string;
          event_types?: (
              | "access_code.created"
              | "access_code.changed"
              | "access_code.name_changed"
              | "access_code.code_changed"
              | "access_code.time_frame_changed"
              | "access_code.mutations_requested"
              | "access_code.scheduled_on_device"
              | "access_code.set_on_device"
              | "access_code.removed_from_device"
              | "access_code.delay_in_setting_on_device"
              | "access_code.failed_to_set_on_device"
              | "access_code.deleted"
              | "access_code.delay_in_removing_from_device"
              | "access_code.failed_to_remove_from_device"
              | "access_code.modified_external_to_seam"
              | "access_code.deleted_external_to_seam"
              | "access_code.backup_access_code_pulled"
              | "access_code.unmanaged.converted_to_managed"
              | "access_code.unmanaged.failed_to_convert_to_managed"
              | "access_code.unmanaged.created"
              | "access_code.unmanaged.removed"
              | "internal.access_code.programming_started"
              | "internal.access_code.programming_finished"
          )[];
          limit?: number;
      },
      options?: AccessCodesGetTimelineOptions,
  ): AccessCodesGetTimelineRequest

  Parameters

  • parameters: {
        access_code_id: string;
        after?: string;
        before?: string;
        event_types?: (
            | "access_code.created"
            | "access_code.changed"
            | "access_code.name_changed"
            | "access_code.code_changed"
            | "access_code.time_frame_changed"
            | "access_code.mutations_requested"
            | "access_code.scheduled_on_device"
            | "access_code.set_on_device"
            | "access_code.removed_from_device"
            | "access_code.delay_in_setting_on_device"
            | "access_code.failed_to_set_on_device"
            | "access_code.deleted"
            | "access_code.delay_in_removing_from_device"
            | "access_code.failed_to_remove_from_device"
            | "access_code.modified_external_to_seam"
            | "access_code.deleted_external_to_seam"
            | "access_code.backup_access_code_pulled"
            | "access_code.unmanaged.converted_to_managed"
            | "access_code.unmanaged.failed_to_convert_to_managed"
            | "access_code.unmanaged.created"
            | "access_code.unmanaged.removed"
            | "internal.access_code.programming_started"
            | "internal.access_code.programming_finished"
        )[];
        limit?: number;
    }

    • access_code_id: string

      ID of the access code for which to retrieve the timeline.

    • Optionalafter?: string

      Only return events that occurred after this timestamp (ISO 8601 format).

    • Optionalbefore?: string

      Only return events that occurred before this timestamp (ISO 8601 format).

    • Optionalevent_types?: (
          | "access_code.created"
          | "access_code.changed"
          | "access_code.name_changed"
          | "access_code.code_changed"
          | "access_code.time_frame_changed"
          | "access_code.mutations_requested"
          | "access_code.scheduled_on_device"
          | "access_code.set_on_device"
          | "access_code.removed_from_device"
          | "access_code.delay_in_setting_on_device"
          | "access_code.failed_to_set_on_device"
          | "access_code.deleted"
          | "access_code.delay_in_removing_from_device"
          | "access_code.failed_to_remove_from_device"
          | "access_code.modified_external_to_seam"
          | "access_code.deleted_external_to_seam"
          | "access_code.backup_access_code_pulled"
          | "access_code.unmanaged.converted_to_managed"
          | "access_code.unmanaged.failed_to_convert_to_managed"
          | "access_code.unmanaged.created"
          | "access_code.unmanaged.removed"
          | "internal.access_code.programming_started"
          | "internal.access_code.programming_finished"
      )[]

      Filter to only return specific event types.

    • Optionallimit?: number

      Maximum number of timeline events to return (default 50, max 200).

  • options: AccessCodesGetTimelineOptions = {}

  Returns AccessCodesGetTimelineRequest

list

• list(
      parameters?: AccessCodesListParameters,
      options?: AccessCodesListOptions,
  ): AccessCodesListRequest

  Parameters

  • Optionalparameters: AccessCodesListParameters
  • options: AccessCodesListOptions = {}

  Returns AccessCodesListRequest

pullBackupAccessCode

• pullBackupAccessCode(
      parameters: AccessCodesPullBackupAccessCodeParameters,
      options?: AccessCodesPullBackupAccessCodeOptions,
  ): AccessCodesPullBackupAccessCodeRequest

  Parameters

  • parameters: AccessCodesPullBackupAccessCodeParameters
  • options: AccessCodesPullBackupAccessCodeOptions = {}

  Returns AccessCodesPullBackupAccessCodeRequest

reportDeviceConstraints

• reportDeviceConstraints(
      parameters: AccessCodesReportDeviceConstraintsParameters,
      options?: AccessCodesReportDeviceConstraintsOptions,
  ): AccessCodesReportDeviceConstraintsRequest

  Parameters

  • parameters: AccessCodesReportDeviceConstraintsParameters
  • options: AccessCodesReportDeviceConstraintsOptions = {}

  Returns AccessCodesReportDeviceConstraintsRequest

update

• update(
      parameters: AccessCodesUpdateParameters,
      options?: AccessCodesUpdateOptions,
  ): AccessCodesUpdateRequest

  Parameters

  • parameters: AccessCodesUpdateParameters
  • options: AccessCodesUpdateOptions = {}

  Returns AccessCodesUpdateRequest

updateClientSessionToken

• updateClientSessionToken(clientSessionToken: string): Promise<void>

  Parameters

  • clientSessionToken: string

  Returns Promise<void>

updateMultiple

• updateMultiple(
      parameters: AccessCodesUpdateMultipleParameters,
      options?: AccessCodesUpdateMultipleOptions,
  ): AccessCodesUpdateMultipleRequest

  Parameters

  • parameters: AccessCodesUpdateMultipleParameters
  • options: AccessCodesUpdateMultipleOptions = {}

  Returns AccessCodesUpdateMultipleRequest

StaticfromApiKey

• fromApiKey(
      apiKey: string,
      options?: Omit<SeamHttpOptionsWithApiKey, "apiKey">,
  ): SeamHttpAccessCodes

  Parameters

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

  Returns SeamHttpAccessCodes

StaticfromClient

• fromClient(
      client: AxiosInstance,
      options?: Omit<SeamHttpOptionsWithClient, "client">,
  ): SeamHttpAccessCodes

  Parameters

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

  Returns SeamHttpAccessCodes

StaticfromClientSessionToken

• fromClientSessionToken(
      clientSessionToken: string,
      options?: Omit<SeamHttpOptionsWithClientSessionToken, "clientSessionToken">,
  ): SeamHttpAccessCodes

  Parameters

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

  Returns SeamHttpAccessCodes

StaticfromConsoleSessionToken

• fromConsoleSessionToken(
      consoleSessionToken: string,
      workspaceId: string,
      options?: Omit<
          SeamHttpOptionsWithConsoleSessionToken,
          "consoleSessionToken"
          | "workspaceId",
      >,
  ): SeamHttpAccessCodes

  Parameters

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

  Returns SeamHttpAccessCodes

StaticfromPersonalAccessToken

• fromPersonalAccessToken(
      personalAccessToken: string,
      workspaceId: string,
      options?: Omit<
          SeamHttpOptionsWithPersonalAccessToken,
          "personalAccessToken"
          | "workspaceId",
      >,
  ): SeamHttpAccessCodes

  Parameters

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

  Returns SeamHttpAccessCodes

StaticfromPublishableKey

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

  Parameters

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

  Returns Promise<SeamHttpAccessCodes>