Interface GetGuideCommandOutputProtected

The output of GetGuideCommand.

Hierarchy

Properties

createdAt definition fragmentPath? id ignoredWarnings? lockStatus? lockedBy? managedBy? name networkSettings? privateNotes? publishedAt? shareEnabled shareId? sourceGuide? target unpublishedChanges updatedAt visibility? x12Envelope?

Properties

createdAt

createdAt: undefined | Date

definition

definition: undefined | DocumentType

Optional fragmentPath

fragmentPath?: string

id

id: undefined | string

Optional ignoredWarnings

ignoredWarnings?: IgnoredWarning[]

Optional lockStatus

lockStatus?: string

When locked - updating, deleting, and publishing of the guide is not allowed.

Optional lockedBy

lockedBy?: string

Optional managedBy

managedBy?: string

name

name: undefined | string

Optional networkSettings

networkSettings?: GuideNetworkSettings

Optional privateNotes

privateNotes?: string

Private notes are only present on the DRFT_ guide

Optional publishedAt

publishedAt?: Date

shareEnabled

shareEnabled: undefined | boolean

Optional shareId

shareId?: string

Optional sourceGuide

sourceGuide?: string

target

target: undefined | GuideTarget

unpublishedChanges

unpublishedChanges: undefined | boolean

updatedAt

updatedAt: undefined | Date

Optional visibility

visibility?: string

Optional x12Envelope

x12Envelope?: string

Settings

Member Visibility

Theme