Documentation ¶
Index ¶
- Constants
- type BasicWorkspaceInfo
- type Branch
- type Category
- type Commit
- type CreateCategory
- type CreateCategoryParams
- type CreateCommentComment
- type CreateEntityTemplate
- type CreateEpic
- type CreateEpicComment
- type CreateGroup
- type CreateIteration
- type CreateLabelParams
- type CreateLinkedFile
- type CreateMilestone
- type CreateOrDeleteStoryReaction
- func (m *CreateOrDeleteStoryReaction) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *CreateOrDeleteStoryReaction) MarshalBinary() ([]byte, error)
- func (m *CreateOrDeleteStoryReaction) UnmarshalBinary(b []byte) error
- func (m *CreateOrDeleteStoryReaction) Validate(formats strfmt.Registry) error
- type CreateProject
- type CreateStories
- type CreateStoryComment
- type CreateStoryCommentParams
- func (m *CreateStoryCommentParams) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *CreateStoryCommentParams) MarshalBinary() ([]byte, error)
- func (m *CreateStoryCommentParams) UnmarshalBinary(b []byte) error
- func (m *CreateStoryCommentParams) Validate(formats strfmt.Registry) error
- type CreateStoryContents
- type CreateStoryLink
- type CreateStoryLinkParams
- type CreateStoryParams
- type CreateTask
- type CreateTaskParams
- type DeleteStories
- type EntityTemplate
- type EntityTemplateTask
- type Epic
- type EpicSearchResults
- type EpicSlim
- type EpicState
- type EpicStats
- type EpicWorkflow
- type GetEpicStories
- type GetExternalLinkStoriesParams
- func (m *GetExternalLinkStoriesParams) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *GetExternalLinkStoriesParams) MarshalBinary() ([]byte, error)
- func (m *GetExternalLinkStoriesParams) UnmarshalBinary(b []byte) error
- func (m *GetExternalLinkStoriesParams) Validate(formats strfmt.Registry) error
- type GetIterationStories
- type GetLabelStories
- type GetMember
- type GetProjectStories
- type Group
- type History
- type HistoryActionBranchCreate
- func (m *HistoryActionBranchCreate) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *HistoryActionBranchCreate) MarshalBinary() ([]byte, error)
- func (m *HistoryActionBranchCreate) UnmarshalBinary(b []byte) error
- func (m *HistoryActionBranchCreate) Validate(formats strfmt.Registry) error
- type HistoryActionBranchMerge
- func (m *HistoryActionBranchMerge) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *HistoryActionBranchMerge) MarshalBinary() ([]byte, error)
- func (m *HistoryActionBranchMerge) UnmarshalBinary(b []byte) error
- func (m *HistoryActionBranchMerge) Validate(formats strfmt.Registry) error
- type HistoryActionBranchPush
- func (m *HistoryActionBranchPush) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *HistoryActionBranchPush) MarshalBinary() ([]byte, error)
- func (m *HistoryActionBranchPush) UnmarshalBinary(b []byte) error
- func (m *HistoryActionBranchPush) Validate(formats strfmt.Registry) error
- type HistoryActionLabelCreate
- func (m *HistoryActionLabelCreate) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *HistoryActionLabelCreate) MarshalBinary() ([]byte, error)
- func (m *HistoryActionLabelCreate) UnmarshalBinary(b []byte) error
- func (m *HistoryActionLabelCreate) Validate(formats strfmt.Registry) error
- type HistoryActionLabelDelete
- func (m *HistoryActionLabelDelete) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *HistoryActionLabelDelete) MarshalBinary() ([]byte, error)
- func (m *HistoryActionLabelDelete) UnmarshalBinary(b []byte) error
- func (m *HistoryActionLabelDelete) Validate(formats strfmt.Registry) error
- type HistoryActionLabelUpdate
- func (m *HistoryActionLabelUpdate) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *HistoryActionLabelUpdate) MarshalBinary() ([]byte, error)
- func (m *HistoryActionLabelUpdate) UnmarshalBinary(b []byte) error
- func (m *HistoryActionLabelUpdate) Validate(formats strfmt.Registry) error
- type HistoryActionProjectUpdate
- func (m *HistoryActionProjectUpdate) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *HistoryActionProjectUpdate) MarshalBinary() ([]byte, error)
- func (m *HistoryActionProjectUpdate) UnmarshalBinary(b []byte) error
- func (m *HistoryActionProjectUpdate) Validate(formats strfmt.Registry) error
- type HistoryActionPullRequest
- func (m *HistoryActionPullRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *HistoryActionPullRequest) MarshalBinary() ([]byte, error)
- func (m *HistoryActionPullRequest) UnmarshalBinary(b []byte) error
- func (m *HistoryActionPullRequest) Validate(formats strfmt.Registry) error
- type HistoryActionStoryCommentCreate
- func (m *HistoryActionStoryCommentCreate) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *HistoryActionStoryCommentCreate) MarshalBinary() ([]byte, error)
- func (m *HistoryActionStoryCommentCreate) UnmarshalBinary(b []byte) error
- func (m *HistoryActionStoryCommentCreate) Validate(formats strfmt.Registry) error
- type HistoryActionStoryCreate
- func (m *HistoryActionStoryCreate) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *HistoryActionStoryCreate) MarshalBinary() ([]byte, error)
- func (m *HistoryActionStoryCreate) UnmarshalBinary(b []byte) error
- func (m *HistoryActionStoryCreate) Validate(formats strfmt.Registry) error
- type HistoryActionStoryDelete
- func (m *HistoryActionStoryDelete) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *HistoryActionStoryDelete) MarshalBinary() ([]byte, error)
- func (m *HistoryActionStoryDelete) UnmarshalBinary(b []byte) error
- func (m *HistoryActionStoryDelete) Validate(formats strfmt.Registry) error
- type HistoryActionStoryLinkCreate
- func (m *HistoryActionStoryLinkCreate) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *HistoryActionStoryLinkCreate) MarshalBinary() ([]byte, error)
- func (m *HistoryActionStoryLinkCreate) UnmarshalBinary(b []byte) error
- func (m *HistoryActionStoryLinkCreate) Validate(formats strfmt.Registry) error
- type HistoryActionStoryLinkDelete
- func (m *HistoryActionStoryLinkDelete) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *HistoryActionStoryLinkDelete) MarshalBinary() ([]byte, error)
- func (m *HistoryActionStoryLinkDelete) UnmarshalBinary(b []byte) error
- func (m *HistoryActionStoryLinkDelete) Validate(formats strfmt.Registry) error
- type HistoryActionStoryLinkUpdate
- func (m *HistoryActionStoryLinkUpdate) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *HistoryActionStoryLinkUpdate) MarshalBinary() ([]byte, error)
- func (m *HistoryActionStoryLinkUpdate) UnmarshalBinary(b []byte) error
- func (m *HistoryActionStoryLinkUpdate) Validate(formats strfmt.Registry) error
- type HistoryActionStoryUpdate
- func (m *HistoryActionStoryUpdate) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *HistoryActionStoryUpdate) MarshalBinary() ([]byte, error)
- func (m *HistoryActionStoryUpdate) UnmarshalBinary(b []byte) error
- func (m *HistoryActionStoryUpdate) Validate(formats strfmt.Registry) error
- type HistoryActionTaskCreate
- func (m *HistoryActionTaskCreate) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *HistoryActionTaskCreate) MarshalBinary() ([]byte, error)
- func (m *HistoryActionTaskCreate) UnmarshalBinary(b []byte) error
- func (m *HistoryActionTaskCreate) Validate(formats strfmt.Registry) error
- type HistoryActionTaskDelete
- func (m *HistoryActionTaskDelete) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *HistoryActionTaskDelete) MarshalBinary() ([]byte, error)
- func (m *HistoryActionTaskDelete) UnmarshalBinary(b []byte) error
- func (m *HistoryActionTaskDelete) Validate(formats strfmt.Registry) error
- type HistoryActionTaskUpdate
- func (m *HistoryActionTaskUpdate) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *HistoryActionTaskUpdate) MarshalBinary() ([]byte, error)
- func (m *HistoryActionTaskUpdate) UnmarshalBinary(b []byte) error
- func (m *HistoryActionTaskUpdate) Validate(formats strfmt.Registry) error
- type HistoryChangesStory
- type HistoryChangesStoryLink
- func (m *HistoryChangesStoryLink) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *HistoryChangesStoryLink) MarshalBinary() ([]byte, error)
- func (m *HistoryChangesStoryLink) UnmarshalBinary(b []byte) error
- func (m *HistoryChangesStoryLink) Validate(formats strfmt.Registry) error
- type HistoryChangesTask
- type HistoryReferenceBranch
- func (m *HistoryReferenceBranch) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *HistoryReferenceBranch) MarshalBinary() ([]byte, error)
- func (m *HistoryReferenceBranch) UnmarshalBinary(b []byte) error
- func (m *HistoryReferenceBranch) Validate(formats strfmt.Registry) error
- type HistoryReferenceCommit
- func (m *HistoryReferenceCommit) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *HistoryReferenceCommit) MarshalBinary() ([]byte, error)
- func (m *HistoryReferenceCommit) UnmarshalBinary(b []byte) error
- func (m *HistoryReferenceCommit) Validate(formats strfmt.Registry) error
- type HistoryReferenceEpic
- type HistoryReferenceGeneral
- func (m *HistoryReferenceGeneral) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *HistoryReferenceGeneral) MarshalBinary() ([]byte, error)
- func (m *HistoryReferenceGeneral) UnmarshalBinary(b []byte) error
- func (m *HistoryReferenceGeneral) Validate(formats strfmt.Registry) error
- type HistoryReferenceGroup
- type HistoryReferenceIteration
- func (m *HistoryReferenceIteration) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *HistoryReferenceIteration) MarshalBinary() ([]byte, error)
- func (m *HistoryReferenceIteration) UnmarshalBinary(b []byte) error
- func (m *HistoryReferenceIteration) Validate(formats strfmt.Registry) error
- type HistoryReferenceLabel
- type HistoryReferenceProject
- func (m *HistoryReferenceProject) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *HistoryReferenceProject) MarshalBinary() ([]byte, error)
- func (m *HistoryReferenceProject) UnmarshalBinary(b []byte) error
- func (m *HistoryReferenceProject) Validate(formats strfmt.Registry) error
- type HistoryReferenceStory
- type HistoryReferenceStoryTask
- func (m *HistoryReferenceStoryTask) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *HistoryReferenceStoryTask) MarshalBinary() ([]byte, error)
- func (m *HistoryReferenceStoryTask) UnmarshalBinary(b []byte) error
- func (m *HistoryReferenceStoryTask) Validate(formats strfmt.Registry) error
- type HistoryReferenceWorkflowState
- func (m *HistoryReferenceWorkflowState) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *HistoryReferenceWorkflowState) MarshalBinary() ([]byte, error)
- func (m *HistoryReferenceWorkflowState) UnmarshalBinary(b []byte) error
- func (m *HistoryReferenceWorkflowState) Validate(formats strfmt.Registry) error
- type Icon
- type Identity
- type Iteration
- type IterationSlim
- type IterationStats
- type Label
- type LabelSlim
- type LabelStats
- type LinkedFile
- type ListEpics
- type ListGroupStories
- type ListLabels
- type ListMembers
- type MaxSearchResultsExceededError
- func (m *MaxSearchResultsExceededError) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *MaxSearchResultsExceededError) MarshalBinary() ([]byte, error)
- func (m *MaxSearchResultsExceededError) UnmarshalBinary(b []byte) error
- func (m *MaxSearchResultsExceededError) Validate(formats strfmt.Registry) error
- type Member
- type MemberInfo
- type Milestone
- type MilestoneStats
- type Profile
- type Project
- type ProjectStats
- type PullRequest
- type PullRequestLabel
- type Repository
- type Search
- type SearchResults
- type SearchStories
- type Story
- type StoryComment
- type StoryContents
- type StoryContentsTask
- type StoryHistoryChangeAddsRemovesInt
- func (m *StoryHistoryChangeAddsRemovesInt) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *StoryHistoryChangeAddsRemovesInt) MarshalBinary() ([]byte, error)
- func (m *StoryHistoryChangeAddsRemovesInt) UnmarshalBinary(b []byte) error
- func (m *StoryHistoryChangeAddsRemovesInt) Validate(formats strfmt.Registry) error
- type StoryHistoryChangeAddsRemovesUUID
- func (m *StoryHistoryChangeAddsRemovesUUID) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *StoryHistoryChangeAddsRemovesUUID) MarshalBinary() ([]byte, error)
- func (m *StoryHistoryChangeAddsRemovesUUID) UnmarshalBinary(b []byte) error
- func (m *StoryHistoryChangeAddsRemovesUUID) Validate(formats strfmt.Registry) error
- type StoryHistoryChangeOldNewBool
- func (m *StoryHistoryChangeOldNewBool) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *StoryHistoryChangeOldNewBool) MarshalBinary() ([]byte, error)
- func (m *StoryHistoryChangeOldNewBool) UnmarshalBinary(b []byte) error
- func (m *StoryHistoryChangeOldNewBool) Validate(formats strfmt.Registry) error
- type StoryHistoryChangeOldNewInt
- func (m *StoryHistoryChangeOldNewInt) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *StoryHistoryChangeOldNewInt) MarshalBinary() ([]byte, error)
- func (m *StoryHistoryChangeOldNewInt) UnmarshalBinary(b []byte) error
- func (m *StoryHistoryChangeOldNewInt) Validate(formats strfmt.Registry) error
- type StoryHistoryChangeOldNewStr
- func (m *StoryHistoryChangeOldNewStr) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *StoryHistoryChangeOldNewStr) MarshalBinary() ([]byte, error)
- func (m *StoryHistoryChangeOldNewStr) UnmarshalBinary(b []byte) error
- func (m *StoryHistoryChangeOldNewStr) Validate(formats strfmt.Registry) error
- type StoryHistoryChangeOldNewUUID
- func (m *StoryHistoryChangeOldNewUUID) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *StoryHistoryChangeOldNewUUID) MarshalBinary() ([]byte, error)
- func (m *StoryHistoryChangeOldNewUUID) UnmarshalBinary(b []byte) error
- func (m *StoryHistoryChangeOldNewUUID) Validate(formats strfmt.Registry) error
- type StoryLink
- type StoryReaction
- type StorySearchResults
- type StorySlim
- type StoryStats
- type Task
- type ThreadedComment
- type TypedStoryLink
- type UnusableEntitlementError
- func (m *UnusableEntitlementError) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *UnusableEntitlementError) MarshalBinary() ([]byte, error)
- func (m *UnusableEntitlementError) UnmarshalBinary(b []byte) error
- func (m *UnusableEntitlementError) Validate(formats strfmt.Registry) error
- type UpdateCategory
- type UpdateComment
- type UpdateEntityTemplate
- type UpdateEpic
- type UpdateFile
- type UpdateGroup
- type UpdateIteration
- type UpdateLabel
- type UpdateLinkedFile
- type UpdateMilestone
- type UpdateProject
- type UpdateStories
- type UpdateStory
- type UpdateStoryComment
- type UpdateStoryContents
- type UpdateStoryLink
- type UpdateTask
- type UploadedFile
- type Workflow
- type WorkflowState
Constants ¶
const ( // CreateEpicStateInProgress captures enum value "in progress" CreateEpicStateInProgress string = "in progress" // CreateEpicStateToDo captures enum value "to do" CreateEpicStateToDo string = "to do" // CreateEpicStateDone captures enum value "done" CreateEpicStateDone string = "done" )
const ( // CreateGroupColorKeyBlue captures enum value "blue" CreateGroupColorKeyBlue string = "blue" // CreateGroupColorKeyPurple captures enum value "purple" CreateGroupColorKeyPurple string = "purple" // CreateGroupColorKeyMidnightDashBlue captures enum value "midnight-blue" CreateGroupColorKeyMidnightDashBlue string = "midnight-blue" // CreateGroupColorKeyOrange captures enum value "orange" CreateGroupColorKeyOrange string = "orange" // CreateGroupColorKeyYellowDashGreen captures enum value "yellow-green" CreateGroupColorKeyYellowDashGreen string = "yellow-green" // CreateGroupColorKeyBrass captures enum value "brass" CreateGroupColorKeyBrass string = "brass" // CreateGroupColorKeyGray captures enum value "gray" CreateGroupColorKeyGray string = "gray" // CreateGroupColorKeyFuchsia captures enum value "fuchsia" CreateGroupColorKeyFuchsia string = "fuchsia" // CreateGroupColorKeyYellow captures enum value "yellow" CreateGroupColorKeyYellow string = "yellow" // CreateGroupColorKeyPink captures enum value "pink" CreateGroupColorKeyPink string = "pink" // CreateGroupColorKeySkyDashBlue captures enum value "sky-blue" CreateGroupColorKeySkyDashBlue string = "sky-blue" // CreateGroupColorKeyGreen captures enum value "green" CreateGroupColorKeyGreen string = "green" // CreateGroupColorKeyRed captures enum value "red" CreateGroupColorKeyRed string = "red" // CreateGroupColorKeyBlack captures enum value "black" CreateGroupColorKeyBlack string = "black" // CreateGroupColorKeySlate captures enum value "slate" CreateGroupColorKeySlate string = "slate" // CreateGroupColorKeyTurquoise captures enum value "turquoise" CreateGroupColorKeyTurquoise string = "turquoise" )
const ( // CreateLinkedFileTypeGoogle captures enum value "google" CreateLinkedFileTypeGoogle string = "google" // CreateLinkedFileTypeURL captures enum value "url" CreateLinkedFileTypeURL string = "url" // CreateLinkedFileTypeDropbox captures enum value "dropbox" CreateLinkedFileTypeDropbox string = "dropbox" // CreateLinkedFileTypeBox captures enum value "box" CreateLinkedFileTypeBox string = "box" // CreateLinkedFileTypeOnedrive captures enum value "onedrive" CreateLinkedFileTypeOnedrive string = "onedrive" )
const ( // CreateMilestoneStateInProgress captures enum value "in progress" CreateMilestoneStateInProgress string = "in progress" // CreateMilestoneStateToDo captures enum value "to do" CreateMilestoneStateToDo string = "to do" // CreateMilestoneStateDone captures enum value "done" CreateMilestoneStateDone string = "done" )
const ( // CreateStoryLinkVerbBlocks captures enum value "blocks" CreateStoryLinkVerbBlocks string = "blocks" // CreateStoryLinkVerbDuplicates captures enum value "duplicates" CreateStoryLinkVerbDuplicates string = "duplicates" // CreateStoryLinkVerbRelatesTo captures enum value "relates to" CreateStoryLinkVerbRelatesTo string = "relates to" )
const ( // CreateStoryLinkParamsVerbBlocks captures enum value "blocks" CreateStoryLinkParamsVerbBlocks string = "blocks" // CreateStoryLinkParamsVerbDuplicates captures enum value "duplicates" CreateStoryLinkParamsVerbDuplicates string = "duplicates" // CreateStoryLinkParamsVerbRelatesTo captures enum value "relates to" CreateStoryLinkParamsVerbRelatesTo string = "relates to" )
const ( // CreateStoryParamsStoryTypeFeature captures enum value "feature" CreateStoryParamsStoryTypeFeature string = "feature" // CreateStoryParamsStoryTypeChore captures enum value "chore" CreateStoryParamsStoryTypeChore string = "chore" // CreateStoryParamsStoryTypeBug captures enum value "bug" CreateStoryParamsStoryTypeBug string = "bug" )
const ( // GroupColorKeyBlue captures enum value "blue" GroupColorKeyBlue string = "blue" // GroupColorKeyPurple captures enum value "purple" GroupColorKeyPurple string = "purple" // GroupColorKeyMidnightDashBlue captures enum value "midnight-blue" GroupColorKeyMidnightDashBlue string = "midnight-blue" // GroupColorKeyOrange captures enum value "orange" GroupColorKeyOrange string = "orange" // GroupColorKeyYellowDashGreen captures enum value "yellow-green" GroupColorKeyYellowDashGreen string = "yellow-green" // GroupColorKeyBrass captures enum value "brass" GroupColorKeyBrass string = "brass" // GroupColorKeyGray captures enum value "gray" GroupColorKeyGray string = "gray" // GroupColorKeyFuchsia captures enum value "fuchsia" GroupColorKeyFuchsia string = "fuchsia" // GroupColorKeyYellow captures enum value "yellow" GroupColorKeyYellow string = "yellow" // GroupColorKeyPink captures enum value "pink" GroupColorKeyPink string = "pink" // GroupColorKeySkyDashBlue captures enum value "sky-blue" GroupColorKeySkyDashBlue string = "sky-blue" // GroupColorKeyGreen captures enum value "green" GroupColorKeyGreen string = "green" // GroupColorKeyRed captures enum value "red" GroupColorKeyRed string = "red" // GroupColorKeyBlack captures enum value "black" GroupColorKeyBlack string = "black" // GroupColorKeySlate captures enum value "slate" GroupColorKeySlate string = "slate" // GroupColorKeyTurquoise captures enum value "turquoise" GroupColorKeyTurquoise string = "turquoise" )
const ( // HistoryActionPullRequestActionOpen captures enum value "open" HistoryActionPullRequestActionOpen string = "open" // HistoryActionPullRequestActionUpdate captures enum value "update" HistoryActionPullRequestActionUpdate string = "update" // HistoryActionPullRequestActionReopen captures enum value "reopen" HistoryActionPullRequestActionReopen string = "reopen" // HistoryActionPullRequestActionClose captures enum value "close" HistoryActionPullRequestActionClose string = "close" // HistoryActionPullRequestActionSync captures enum value "sync" HistoryActionPullRequestActionSync string = "sync" // HistoryActionPullRequestActionComment captures enum value "comment" HistoryActionPullRequestActionComment string = "comment" )
const ( // HistoryActionStoryCreateStoryTypeFeature captures enum value "feature" HistoryActionStoryCreateStoryTypeFeature string = "feature" // HistoryActionStoryCreateStoryTypeChore captures enum value "chore" HistoryActionStoryCreateStoryTypeChore string = "chore" // HistoryActionStoryCreateStoryTypeBug captures enum value "bug" HistoryActionStoryCreateStoryTypeBug string = "bug" )
const ( // HistoryActionStoryDeleteStoryTypeFeature captures enum value "feature" HistoryActionStoryDeleteStoryTypeFeature string = "feature" // HistoryActionStoryDeleteStoryTypeChore captures enum value "chore" HistoryActionStoryDeleteStoryTypeChore string = "chore" // HistoryActionStoryDeleteStoryTypeBug captures enum value "bug" HistoryActionStoryDeleteStoryTypeBug string = "bug" )
const ( // HistoryActionStoryLinkCreateVerbBlocks captures enum value "blocks" HistoryActionStoryLinkCreateVerbBlocks string = "blocks" // HistoryActionStoryLinkCreateVerbDuplicates captures enum value "duplicates" HistoryActionStoryLinkCreateVerbDuplicates string = "duplicates" // HistoryActionStoryLinkCreateVerbRelatesTo captures enum value "relates to" HistoryActionStoryLinkCreateVerbRelatesTo string = "relates to" )
const ( // HistoryActionStoryLinkDeleteVerbBlocks captures enum value "blocks" HistoryActionStoryLinkDeleteVerbBlocks string = "blocks" // HistoryActionStoryLinkDeleteVerbDuplicates captures enum value "duplicates" HistoryActionStoryLinkDeleteVerbDuplicates string = "duplicates" // HistoryActionStoryLinkDeleteVerbRelatesTo captures enum value "relates to" HistoryActionStoryLinkDeleteVerbRelatesTo string = "relates to" )
const ( // HistoryActionStoryLinkUpdateVerbBlocks captures enum value "blocks" HistoryActionStoryLinkUpdateVerbBlocks string = "blocks" // HistoryActionStoryLinkUpdateVerbDuplicates captures enum value "duplicates" HistoryActionStoryLinkUpdateVerbDuplicates string = "duplicates" // HistoryActionStoryLinkUpdateVerbRelatesTo captures enum value "relates to" HistoryActionStoryLinkUpdateVerbRelatesTo string = "relates to" )
const ( // HistoryActionStoryUpdateStoryTypeFeature captures enum value "feature" HistoryActionStoryUpdateStoryTypeFeature string = "feature" // HistoryActionStoryUpdateStoryTypeChore captures enum value "chore" HistoryActionStoryUpdateStoryTypeChore string = "chore" // HistoryActionStoryUpdateStoryTypeBug captures enum value "bug" HistoryActionStoryUpdateStoryTypeBug string = "bug" )
const ( // HistoryReferenceStoryStoryTypeFeature captures enum value "feature" HistoryReferenceStoryStoryTypeFeature string = "feature" // HistoryReferenceStoryStoryTypeChore captures enum value "chore" HistoryReferenceStoryStoryTypeChore string = "chore" // HistoryReferenceStoryStoryTypeBug captures enum value "bug" HistoryReferenceStoryStoryTypeBug string = "bug" )
const ( // HistoryReferenceWorkflowStateTypeStarted captures enum value "started" HistoryReferenceWorkflowStateTypeStarted string = "started" // HistoryReferenceWorkflowStateTypeUnstarted captures enum value "unstarted" HistoryReferenceWorkflowStateTypeUnstarted string = "unstarted" // HistoryReferenceWorkflowStateTypeDone captures enum value "done" HistoryReferenceWorkflowStateTypeDone string = "done" )
const ( // MemberStatePartial captures enum value "partial" MemberStatePartial string = "partial" // MemberStateFull captures enum value "full" MemberStateFull string = "full" // MemberStateDisabled captures enum value "disabled" MemberStateDisabled string = "disabled" // MemberStateImported captures enum value "imported" MemberStateImported string = "imported" )
const ( // SearchStoriesStoryTypeFeature captures enum value "feature" SearchStoriesStoryTypeFeature string = "feature" // SearchStoriesStoryTypeChore captures enum value "chore" SearchStoriesStoryTypeChore string = "chore" // SearchStoriesStoryTypeBug captures enum value "bug" SearchStoriesStoryTypeBug string = "bug" )
const ( // UpdateEpicStateInProgress captures enum value "in progress" UpdateEpicStateInProgress string = "in progress" // UpdateEpicStateToDo captures enum value "to do" UpdateEpicStateToDo string = "to do" // UpdateEpicStateDone captures enum value "done" UpdateEpicStateDone string = "done" )
const ( // UpdateGroupColorKeyBlue captures enum value "blue" UpdateGroupColorKeyBlue string = "blue" // UpdateGroupColorKeyPurple captures enum value "purple" UpdateGroupColorKeyPurple string = "purple" // UpdateGroupColorKeyMidnightDashBlue captures enum value "midnight-blue" UpdateGroupColorKeyMidnightDashBlue string = "midnight-blue" // UpdateGroupColorKeyOrange captures enum value "orange" UpdateGroupColorKeyOrange string = "orange" // UpdateGroupColorKeyYellowDashGreen captures enum value "yellow-green" UpdateGroupColorKeyYellowDashGreen string = "yellow-green" // UpdateGroupColorKeyBrass captures enum value "brass" UpdateGroupColorKeyBrass string = "brass" // UpdateGroupColorKeyGray captures enum value "gray" UpdateGroupColorKeyGray string = "gray" // UpdateGroupColorKeyFuchsia captures enum value "fuchsia" UpdateGroupColorKeyFuchsia string = "fuchsia" // UpdateGroupColorKeyYellow captures enum value "yellow" UpdateGroupColorKeyYellow string = "yellow" // UpdateGroupColorKeyPink captures enum value "pink" UpdateGroupColorKeyPink string = "pink" // UpdateGroupColorKeySkyDashBlue captures enum value "sky-blue" UpdateGroupColorKeySkyDashBlue string = "sky-blue" // UpdateGroupColorKeyGreen captures enum value "green" UpdateGroupColorKeyGreen string = "green" // UpdateGroupColorKeyRed captures enum value "red" UpdateGroupColorKeyRed string = "red" // UpdateGroupColorKeyBlack captures enum value "black" UpdateGroupColorKeyBlack string = "black" // UpdateGroupColorKeySlate captures enum value "slate" UpdateGroupColorKeySlate string = "slate" // UpdateGroupColorKeyTurquoise captures enum value "turquoise" UpdateGroupColorKeyTurquoise string = "turquoise" )
const ( // UpdateLinkedFileTypeGoogle captures enum value "google" UpdateLinkedFileTypeGoogle string = "google" // UpdateLinkedFileTypeURL captures enum value "url" UpdateLinkedFileTypeURL string = "url" // UpdateLinkedFileTypeDropbox captures enum value "dropbox" UpdateLinkedFileTypeDropbox string = "dropbox" // UpdateLinkedFileTypeBox captures enum value "box" UpdateLinkedFileTypeBox string = "box" // UpdateLinkedFileTypeOnedrive captures enum value "onedrive" UpdateLinkedFileTypeOnedrive string = "onedrive" )
const ( // UpdateMilestoneStateInProgress captures enum value "in progress" UpdateMilestoneStateInProgress string = "in progress" // UpdateMilestoneStateToDo captures enum value "to do" UpdateMilestoneStateToDo string = "to do" // UpdateMilestoneStateDone captures enum value "done" UpdateMilestoneStateDone string = "done" )
const ( // UpdateStoriesMoveToLast captures enum value "last" UpdateStoriesMoveToLast string = "last" // UpdateStoriesMoveToFirst captures enum value "first" UpdateStoriesMoveToFirst string = "first" )
const ( // UpdateStoriesStoryTypeFeature captures enum value "feature" UpdateStoriesStoryTypeFeature string = "feature" // UpdateStoriesStoryTypeChore captures enum value "chore" UpdateStoriesStoryTypeChore string = "chore" // UpdateStoriesStoryTypeBug captures enum value "bug" UpdateStoriesStoryTypeBug string = "bug" )
const ( // UpdateStoryMoveToLast captures enum value "last" UpdateStoryMoveToLast string = "last" // UpdateStoryMoveToFirst captures enum value "first" UpdateStoryMoveToFirst string = "first" )
const ( // UpdateStoryStoryTypeFeature captures enum value "feature" UpdateStoryStoryTypeFeature string = "feature" // UpdateStoryStoryTypeChore captures enum value "chore" UpdateStoryStoryTypeChore string = "chore" // UpdateStoryStoryTypeBug captures enum value "bug" UpdateStoryStoryTypeBug string = "bug" )
const ( // UpdateStoryLinkVerbBlocks captures enum value "blocks" UpdateStoryLinkVerbBlocks string = "blocks" // UpdateStoryLinkVerbDuplicates captures enum value "duplicates" UpdateStoryLinkVerbDuplicates string = "duplicates" // UpdateStoryLinkVerbRelatesTo captures enum value "relates to" UpdateStoryLinkVerbRelatesTo string = "relates to" )
const ( // CreateCategoryTypeMilestone captures enum value "milestone" CreateCategoryTypeMilestone string = "milestone" )
const ( // HistoryActionBranchCreateActionCreate captures enum value "create" HistoryActionBranchCreateActionCreate string = "create" )
const ( // HistoryActionBranchMergeActionMerge captures enum value "merge" HistoryActionBranchMergeActionMerge string = "merge" )
const ( // HistoryActionBranchPushActionPush captures enum value "push" HistoryActionBranchPushActionPush string = "push" )
const ( // HistoryActionLabelCreateActionCreate captures enum value "create" HistoryActionLabelCreateActionCreate string = "create" )
const ( // HistoryActionLabelDeleteActionDelete captures enum value "delete" HistoryActionLabelDeleteActionDelete string = "delete" )
const ( // HistoryActionLabelUpdateActionUpdate captures enum value "update" HistoryActionLabelUpdateActionUpdate string = "update" )
const ( // HistoryActionProjectUpdateActionUpdate captures enum value "update" HistoryActionProjectUpdateActionUpdate string = "update" )
const ( // HistoryActionStoryCommentCreateActionCreate captures enum value "create" HistoryActionStoryCommentCreateActionCreate string = "create" )
const ( // HistoryActionStoryCreateActionCreate captures enum value "create" HistoryActionStoryCreateActionCreate string = "create" )
const ( // HistoryActionStoryDeleteActionDelete captures enum value "delete" HistoryActionStoryDeleteActionDelete string = "delete" )
const ( // HistoryActionStoryLinkCreateActionCreate captures enum value "create" HistoryActionStoryLinkCreateActionCreate string = "create" )
const ( // HistoryActionStoryLinkDeleteActionDelete captures enum value "delete" HistoryActionStoryLinkDeleteActionDelete string = "delete" )
const ( // HistoryActionStoryLinkUpdateActionUpdate captures enum value "update" HistoryActionStoryLinkUpdateActionUpdate string = "update" )
const ( // HistoryActionStoryUpdateActionUpdate captures enum value "update" HistoryActionStoryUpdateActionUpdate string = "update" )
const ( // HistoryActionTaskCreateActionCreate captures enum value "create" HistoryActionTaskCreateActionCreate string = "create" )
const ( // HistoryActionTaskDeleteActionDelete captures enum value "delete" HistoryActionTaskDeleteActionDelete string = "delete" )
const ( // HistoryActionTaskUpdateActionUpdate captures enum value "update" HistoryActionTaskUpdateActionUpdate string = "update" )
const ( // HistoryVersionV1 captures enum value "v1" HistoryVersionV1 string = "v1" )
const ( // MaxSearchResultsExceededErrorErrorMaximumDashResultsDashExceeded captures enum value "maximum-results-exceeded" MaxSearchResultsExceededErrorErrorMaximumDashResultsDashExceeded string = "maximum-results-exceeded" )
const ( // SearchIncludeCursors captures enum value "cursors" SearchIncludeCursors string = "cursors" )
const ( // UnusableEntitlementErrorReasonTagEntitlementDashViolation captures enum value "entitlement-violation" UnusableEntitlementErrorReasonTagEntitlementDashViolation string = "entitlement-violation" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BasicWorkspaceInfo ¶
type BasicWorkspaceInfo struct { // estimate scale // Required: true EstimateScale []int64 `json:"estimate_scale"` // url slug // Required: true URLSlug *string `json:"url_slug"` }
BasicWorkspaceInfo basic workspace info
swagger:model BasicWorkspaceInfo
func (*BasicWorkspaceInfo) ContextValidate ¶
ContextValidate validates this basic workspace info based on context it is used
func (*BasicWorkspaceInfo) MarshalBinary ¶
func (m *BasicWorkspaceInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*BasicWorkspaceInfo) UnmarshalBinary ¶
func (m *BasicWorkspaceInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Branch ¶
type Branch struct { // The time/date the Branch was created. // Required: true // Format: date-time CreatedAt *strfmt.DateTime `json:"created_at"` // A true/false boolean indicating if the Branch has been deleted. // Required: true Deleted *bool `json:"deleted"` // A string description of this resource. // Required: true EntityType *string `json:"entity_type"` // The unique ID of the Branch. // Required: true ID *int64 `json:"id"` // The IDs of the Branches the Branch has been merged into. // Required: true MergedBranchIds []int64 `json:"merged_branch_ids"` // The name of the Branch. // Required: true Name *string `json:"name"` // A true/false boolean indicating if the Branch is persistent; e.g. master. // Required: true Persistent *bool `json:"persistent"` // An array of PullRequests attached to the Branch (there is usually only one). // Required: true PullRequests []*PullRequest `json:"pull_requests"` // The ID of the Repository that contains the Branch. // Required: true RepositoryID *int64 `json:"repository_id"` // The time/date the Branch was updated. // Required: true // Format: date-time UpdatedAt *strfmt.DateTime `json:"updated_at"` // The URL of the Branch. // Required: true URL *string `json:"url"` }
Branch Branch refers to a VCS branch. Branches are feature branches associated with Shortcut Stories.
swagger:model Branch
func (*Branch) ContextValidate ¶
ContextValidate validate this branch based on the context it is used
func (*Branch) MarshalBinary ¶
MarshalBinary interface implementation
func (*Branch) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Category ¶
type Category struct { // A true/false boolean indicating if the Category has been archived. // Required: true Archived *bool `json:"archived"` // The hex color to be displayed with the Category (for example, "#ff0000"). // Required: true // Min Length: 1 // Pattern: ^#[a-fA-F0-9]{6}$ Color *string `json:"color"` // The time/date that the Category was created. // Required: true // Format: date-time CreatedAt *strfmt.DateTime `json:"created_at"` // A string description of this resource. // Required: true EntityType *string `json:"entity_type"` // This field can be set to another unique ID. In the case that the Category has been imported from another tool, the ID in the other tool can be indicated here. // Required: true ExternalID *string `json:"external_id"` // The unique ID of the Category. // Required: true ID *int64 `json:"id"` // The name of the Category. // Required: true Name *string `json:"name"` // The type of entity this Category is associated with; currently Milestone is the only type of Category. // Required: true Type *string `json:"type"` // The time/date that the Category was updated. // Required: true // Format: date-time UpdatedAt *strfmt.DateTime `json:"updated_at"` }
Category A Category can be used to associate Milestones.
swagger:model Category
func (*Category) ContextValidate ¶
ContextValidate validates this category based on context it is used
func (*Category) MarshalBinary ¶
MarshalBinary interface implementation
func (*Category) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Commit ¶
type Commit struct { // The email address of the VCS user that authored the Commit. // Required: true AuthorEmail *string `json:"author_email"` // The ID of the Member that authored the Commit, if known. // Required: true // Format: uuid AuthorID *strfmt.UUID `json:"author_id"` // author identity // Required: true AuthorIdentity *Identity `json:"author_identity"` // The time/date the Commit was created. // Required: true // Format: date-time CreatedAt *strfmt.DateTime `json:"created_at"` // A string description of this resource. // Required: true EntityType *string `json:"entity_type"` // The Commit hash. // Required: true Hash *string `json:"hash"` // The unique ID of the Commit. // Required: true ID *int64 `json:"id"` // The IDs of the Branches the Commit has been merged into. // Required: true MergedBranchIds []int64 `json:"merged_branch_ids"` // The Commit message. // Required: true Message *string `json:"message"` // The ID of the Repository that contains the Commit. // Required: true RepositoryID *int64 `json:"repository_id"` // The time/date the Commit was pushed. // Required: true // Format: date-time Timestamp *strfmt.DateTime `json:"timestamp"` // The time/date the Commit was updated. // Required: true // Format: date-time UpdatedAt *strfmt.DateTime `json:"updated_at"` // The URL of the Commit. // Required: true URL *string `json:"url"` }
Commit Commit refers to a VCS commit and all associated details.
swagger:model Commit
func (*Commit) ContextValidate ¶
ContextValidate validate this commit based on the context it is used
func (*Commit) MarshalBinary ¶
MarshalBinary interface implementation
func (*Commit) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type CreateCategory ¶
type CreateCategory struct { // The hex color to be displayed with the Category (for example, "#ff0000"). // Min Length: 1 // Pattern: ^#[a-fA-F0-9]{6}$ Color string `json:"color,omitempty"` // This field can be set to another unique ID. In the case that the Category has been imported from another tool, the ID in the other tool can be indicated here. // Min Length: 1 ExternalID string `json:"external_id,omitempty"` // The name of the new Category. // Required: true // Min Length: 1 Name *string `json:"name"` // The type of entity this Category is associated with; currently Milestone is the only type of Category. // Required: true // Enum: [milestone] Type *string `json:"type"` }
CreateCategory create category
swagger:model CreateCategory
func (*CreateCategory) ContextValidate ¶
ContextValidate validates this create category based on context it is used
func (*CreateCategory) MarshalBinary ¶
func (m *CreateCategory) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CreateCategory) UnmarshalBinary ¶
func (m *CreateCategory) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CreateCategoryParams ¶
type CreateCategoryParams struct { // The hex color to be displayed with the Category (for example, "#ff0000"). // Min Length: 1 // Pattern: ^#[a-fA-F0-9]{6}$ Color string `json:"color,omitempty"` // This field can be set to another unique ID. In the case that the Category has been imported from another tool, the ID in the other tool can be indicated here. // Min Length: 1 ExternalID string `json:"external_id,omitempty"` // The name of the new Category. // Required: true // Min Length: 1 Name *string `json:"name"` }
CreateCategoryParams Request parameters for creating a Category with a Milestone.
swagger:model CreateCategoryParams
func (*CreateCategoryParams) ContextValidate ¶
ContextValidate validates this create category params based on context it is used
func (*CreateCategoryParams) MarshalBinary ¶
func (m *CreateCategoryParams) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CreateCategoryParams) UnmarshalBinary ¶
func (m *CreateCategoryParams) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CreateCommentComment ¶
type CreateCommentComment struct { // The Member ID of the Comment's author. Defaults to the user identified by the API token. // Format: uuid AuthorID strfmt.UUID `json:"author_id,omitempty"` // Defaults to the time/date the comment is created, but can be set to reflect another date. // Format: date-time CreatedAt strfmt.DateTime `json:"created_at,omitempty"` // This field can be set to another unique ID. In the case that the comment has been imported from another tool, the ID in the other tool can be indicated here. ExternalID string `json:"external_id,omitempty"` // The comment text. // Required: true // Max Length: 100000 // Min Length: 1 Text *string `json:"text"` // Defaults to the time/date the comment is last updated, but can be set to reflect another date. // Format: date-time UpdatedAt strfmt.DateTime `json:"updated_at,omitempty"` }
CreateCommentComment create comment comment
swagger:model CreateCommentComment
func (*CreateCommentComment) ContextValidate ¶
ContextValidate validates this create comment comment based on context it is used
func (*CreateCommentComment) MarshalBinary ¶
func (m *CreateCommentComment) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CreateCommentComment) UnmarshalBinary ¶
func (m *CreateCommentComment) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CreateEntityTemplate ¶
type CreateEntityTemplate struct { // The id of the user creating this template. // Format: uuid AuthorID strfmt.UUID `json:"author_id,omitempty"` // The name of the new entity template // Required: true // Min Length: 1 Name *string `json:"name"` // story contents // Required: true StoryContents *CreateStoryContents `json:"story_contents"` }
CreateEntityTemplate Request paramaters for creating an entirely new entity template.
swagger:model CreateEntityTemplate
func (*CreateEntityTemplate) ContextValidate ¶
ContextValidate validate this create entity template based on the context it is used
func (*CreateEntityTemplate) MarshalBinary ¶
func (m *CreateEntityTemplate) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CreateEntityTemplate) UnmarshalBinary ¶
func (m *CreateEntityTemplate) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CreateEpic ¶
type CreateEpic struct { // A manual override for the time/date the Epic was completed. // Format: date-time CompletedAtOverride strfmt.DateTime `json:"completed_at_override,omitempty"` // Defaults to the time/date it is created but can be set to reflect another date. // Format: date-time CreatedAt strfmt.DateTime `json:"created_at,omitempty"` // The Epic's deadline. // Format: date-time Deadline *strfmt.DateTime `json:"deadline,omitempty"` // The Epic's description. // Max Length: 100000 Description string `json:"description,omitempty"` // The ID of the Epic State. EpicStateID int64 `json:"epic_state_id,omitempty"` // This field can be set to another unique ID. In the case that the Epic has been imported from another tool, the ID in the other tool can be indicated here. ExternalID string `json:"external_id,omitempty"` // An array of UUIDs for any Members you want to add as Followers on this new Epic. FollowerIds []strfmt.UUID `json:"follower_ids"` // The ID of the group to associate with the epic. // Format: uuid GroupID *strfmt.UUID `json:"group_id,omitempty"` // An array of Labels attached to the Epic. Labels []*CreateLabelParams `json:"labels"` // The ID of the Milestone this Epic is related to. MilestoneID *int64 `json:"milestone_id,omitempty"` // The Epic's name. // Required: true // Max Length: 256 // Min Length: 1 Name *string `json:"name"` // An array of UUIDs for any members you want to add as Owners on this new Epic. OwnerIds []strfmt.UUID `json:"owner_ids"` // The Epic's planned start date. // Format: date-time PlannedStartDate *strfmt.DateTime `json:"planned_start_date,omitempty"` // The ID of the member that requested the epic. // Format: uuid RequestedByID strfmt.UUID `json:"requested_by_id,omitempty"` // A manual override for the time/date the Epic was started. // Format: date-time StartedAtOverride strfmt.DateTime `json:"started_at_override,omitempty"` // `Deprecated` The Epic's state (to do, in progress, or done); will be ignored when `epic_state_id` is set. // Enum: [in progress to do done] State string `json:"state,omitempty"` // Defaults to the time/date it is created but can be set to reflect another date. // Format: date-time UpdatedAt strfmt.DateTime `json:"updated_at,omitempty"` }
CreateEpic create epic
swagger:model CreateEpic
func (*CreateEpic) ContextValidate ¶
ContextValidate validate this create epic based on the context it is used
func (*CreateEpic) MarshalBinary ¶
func (m *CreateEpic) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CreateEpic) UnmarshalBinary ¶
func (m *CreateEpic) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CreateEpicComment ¶
type CreateEpicComment struct { // The Member ID of the Comment's author. Defaults to the user identified by the API token. // Format: uuid AuthorID strfmt.UUID `json:"author_id,omitempty"` // Defaults to the time/date the comment is created, but can be set to reflect another date. // Format: date-time CreatedAt strfmt.DateTime `json:"created_at,omitempty"` // This field can be set to another unique ID. In the case that the comment has been imported from another tool, the ID in the other tool can be indicated here. ExternalID string `json:"external_id,omitempty"` // The comment text. // Required: true // Max Length: 100000 // Min Length: 1 Text *string `json:"text"` // Defaults to the time/date the comment is last updated, but can be set to reflect another date. // Format: date-time UpdatedAt strfmt.DateTime `json:"updated_at,omitempty"` }
CreateEpicComment create epic comment
swagger:model CreateEpicComment
func (*CreateEpicComment) ContextValidate ¶
ContextValidate validates this create epic comment based on context it is used
func (*CreateEpicComment) MarshalBinary ¶
func (m *CreateEpicComment) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CreateEpicComment) UnmarshalBinary ¶
func (m *CreateEpicComment) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CreateGroup ¶
type CreateGroup struct { // The color you wish to use for the Group in the system. // Min Length: 1 // Pattern: ^#[a-fA-F0-9]{6}$ Color string `json:"color,omitempty"` // The color key you wish to use for the Group in the system. // Enum: [blue purple midnight-blue orange yellow-green brass gray fuchsia yellow pink sky-blue green red black slate turquoise] ColorKey string `json:"color_key,omitempty"` // The description of the Group. Description string `json:"description,omitempty"` // The Icon id for the avatar of this Group. // Format: uuid DisplayIconID strfmt.UUID `json:"display_icon_id,omitempty"` // The Member ids to add to this Group. // Unique: true MemberIds []strfmt.UUID `json:"member_ids"` // The mention name of this Group. // Required: true // Min Length: 1 MentionName *string `json:"mention_name"` // The name of this Group. // Required: true // Min Length: 1 Name *string `json:"name"` // The Workflow ids to add to the Group. WorkflowIds []int64 `json:"workflow_ids"` }
CreateGroup create group
swagger:model CreateGroup
func (*CreateGroup) ContextValidate ¶
ContextValidate validates this create group based on context it is used
func (*CreateGroup) MarshalBinary ¶
func (m *CreateGroup) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CreateGroup) UnmarshalBinary ¶
func (m *CreateGroup) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CreateIteration ¶
type CreateIteration struct { // The description of the Iteration. // Max Length: 100000 Description string `json:"description,omitempty"` // The date this Iteration ends, e.g. 2019-07-01. // Required: true // Min Length: 1 EndDate *string `json:"end_date"` // An array of UUIDs for any Members you want to add as Followers. FollowerIds []strfmt.UUID `json:"follower_ids"` // An array of UUIDs for any Groups you want to add as Followers. Currently, only one Group association is presented in our web UI. GroupIds []strfmt.UUID `json:"group_ids"` // An array of Labels attached to the Iteration. Labels []*CreateLabelParams `json:"labels"` // The name of this Iteration. // Required: true // Min Length: 1 Name *string `json:"name"` // The date this Iteration begins, e.g. 2019-07-01. // Required: true // Min Length: 1 StartDate *string `json:"start_date"` }
CreateIteration create iteration
swagger:model CreateIteration
func (*CreateIteration) ContextValidate ¶
ContextValidate validate this create iteration based on the context it is used
func (*CreateIteration) MarshalBinary ¶
func (m *CreateIteration) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CreateIteration) UnmarshalBinary ¶
func (m *CreateIteration) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CreateLabelParams ¶
type CreateLabelParams struct { // The hex color to be displayed with the Label (for example, "#ff0000"). // Min Length: 1 // Pattern: ^#[a-fA-F0-9]{6}$ Color string `json:"color,omitempty"` // The description of the new Label. Description string `json:"description,omitempty"` // This field can be set to another unique ID. In the case that the Label has been imported from another tool, the ID in the other tool can be indicated here. // Min Length: 1 ExternalID string `json:"external_id,omitempty"` // The name of the new Label. // Required: true // Max Length: 128 // Min Length: 1 Name *string `json:"name"` }
CreateLabelParams Request parameters for creating a Label on a Shortcut Story.
swagger:model CreateLabelParams
func (*CreateLabelParams) ContextValidate ¶
ContextValidate validates this create label params based on context it is used
func (*CreateLabelParams) MarshalBinary ¶
func (m *CreateLabelParams) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CreateLabelParams) UnmarshalBinary ¶
func (m *CreateLabelParams) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CreateLinkedFile ¶
type CreateLinkedFile struct { // The content type of the image (e.g. txt/plain). ContentType string `json:"content_type,omitempty"` // The description of the file. Description string `json:"description,omitempty"` // The name of the file. // Required: true // Min Length: 1 Name *string `json:"name"` // The filesize, if the integration provided it. Size int64 `json:"size,omitempty"` // The ID of the linked story. StoryID int64 `json:"story_id,omitempty"` // The URL of the thumbnail, if the integration provided it. // Max Length: 2048 // Pattern: ^https?://.+$ ThumbnailURL string `json:"thumbnail_url,omitempty"` // The integration type of the file (e.g. google, dropbox, box). // Required: true // Enum: [google url dropbox box onedrive] Type *string `json:"type"` // The UUID of the member that uploaded the file. // Format: uuid UploaderID strfmt.UUID `json:"uploader_id,omitempty"` // The URL of linked file. // Required: true // Max Length: 2048 // Pattern: ^https?://.+$ URL *string `json:"url"` }
CreateLinkedFile create linked file
swagger:model CreateLinkedFile
func (*CreateLinkedFile) ContextValidate ¶
ContextValidate validates this create linked file based on context it is used
func (*CreateLinkedFile) MarshalBinary ¶
func (m *CreateLinkedFile) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CreateLinkedFile) UnmarshalBinary ¶
func (m *CreateLinkedFile) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CreateMilestone ¶
type CreateMilestone struct { // An array of IDs of Categories attached to the Milestone. Categories []*CreateCategoryParams `json:"categories"` // A manual override for the time/date the Milestone was completed. // Format: date-time CompletedAtOverride strfmt.DateTime `json:"completed_at_override,omitempty"` // The Milestone's description. // Max Length: 100000 Description string `json:"description,omitempty"` // The name of the Milestone. // Required: true // Max Length: 256 // Min Length: 1 Name *string `json:"name"` // A manual override for the time/date the Milestone was started. // Format: date-time StartedAtOverride strfmt.DateTime `json:"started_at_override,omitempty"` // The workflow state that the Milestone is in. // Enum: [in progress to do done] State string `json:"state,omitempty"` }
CreateMilestone create milestone
swagger:model CreateMilestone
func (*CreateMilestone) ContextValidate ¶
ContextValidate validate this create milestone based on the context it is used
func (*CreateMilestone) MarshalBinary ¶
func (m *CreateMilestone) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CreateMilestone) UnmarshalBinary ¶
func (m *CreateMilestone) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CreateOrDeleteStoryReaction ¶
type CreateOrDeleteStoryReaction struct { // The emoji short-code to add / remove. E.g. `:thumbsup::skin-tone-4:`. // Required: true Emoji *string `json:"emoji"` }
CreateOrDeleteStoryReaction create or delete story reaction
swagger:model CreateOrDeleteStoryReaction
func (*CreateOrDeleteStoryReaction) ContextValidate ¶
func (m *CreateOrDeleteStoryReaction) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this create or delete story reaction based on context it is used
func (*CreateOrDeleteStoryReaction) MarshalBinary ¶
func (m *CreateOrDeleteStoryReaction) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CreateOrDeleteStoryReaction) UnmarshalBinary ¶
func (m *CreateOrDeleteStoryReaction) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CreateProject ¶
type CreateProject struct { // The Project abbreviation used in Story summaries. Should be kept to 3 characters at most. Abbreviation string `json:"abbreviation,omitempty"` // The color you wish to use for the Project in the system. // Min Length: 1 // Pattern: ^#[a-fA-F0-9]{6}$ Color string `json:"color,omitempty"` // Defaults to the time/date it is created but can be set to reflect another date. // Format: date-time CreatedAt strfmt.DateTime `json:"created_at,omitempty"` // The Project description. // Max Length: 100000 Description string `json:"description,omitempty"` // This field can be set to another unique ID. In the case that the Project has been imported from another tool, the ID in the other tool can be indicated here. ExternalID string `json:"external_id,omitempty"` // An array of UUIDs for any members you want to add as Owners on this new Epic. FollowerIds []strfmt.UUID `json:"follower_ids"` // The number of weeks per iteration in this Project. IterationLength int64 `json:"iteration_length,omitempty"` // The name of the Project. // Required: true // Max Length: 128 // Min Length: 1 Name *string `json:"name"` // The date at which the Project was started. // Format: date-time StartTime strfmt.DateTime `json:"start_time,omitempty"` // The ID of the team the project belongs to. // Required: true TeamID *int64 `json:"team_id"` // Defaults to the time/date it is created but can be set to reflect another date. // Format: date-time UpdatedAt strfmt.DateTime `json:"updated_at,omitempty"` }
CreateProject create project
swagger:model CreateProject
func (*CreateProject) ContextValidate ¶
ContextValidate validates this create project based on context it is used
func (*CreateProject) MarshalBinary ¶
func (m *CreateProject) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CreateProject) UnmarshalBinary ¶
func (m *CreateProject) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CreateStories ¶
type CreateStories struct { // An array of stories to be created. // Required: true Stories []*CreateStoryParams `json:"stories"` }
CreateStories create stories
swagger:model CreateStories
func (*CreateStories) ContextValidate ¶
ContextValidate validate this create stories based on the context it is used
func (*CreateStories) MarshalBinary ¶
func (m *CreateStories) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CreateStories) UnmarshalBinary ¶
func (m *CreateStories) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CreateStoryComment ¶
type CreateStoryComment struct { // The Member ID of the Comment's author. Defaults to the user identified by the API token. // Format: uuid AuthorID strfmt.UUID `json:"author_id,omitempty"` // Defaults to the time/date the comment is created, but can be set to reflect another date. // Format: date-time CreatedAt strfmt.DateTime `json:"created_at,omitempty"` // This field can be set to another unique ID. In the case that the comment has been imported from another tool, the ID in the other tool can be indicated here. ExternalID string `json:"external_id,omitempty"` // The ID of the Comment that this comment is threaded under. ParentID *int64 `json:"parent_id,omitempty"` // The comment text. // Required: true // Max Length: 100000 Text *string `json:"text"` // Defaults to the time/date the comment is last updated, but can be set to reflect another date. // Format: date-time UpdatedAt strfmt.DateTime `json:"updated_at,omitempty"` }
CreateStoryComment create story comment
swagger:model CreateStoryComment
func (*CreateStoryComment) ContextValidate ¶
ContextValidate validates this create story comment based on context it is used
func (*CreateStoryComment) MarshalBinary ¶
func (m *CreateStoryComment) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CreateStoryComment) UnmarshalBinary ¶
func (m *CreateStoryComment) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CreateStoryCommentParams ¶
type CreateStoryCommentParams struct { // The Member ID of the Comment's author. Defaults to the user identified by the API token. // Format: uuid AuthorID strfmt.UUID `json:"author_id,omitempty"` // Defaults to the time/date the comment is created, but can be set to reflect another date. // Format: date-time CreatedAt strfmt.DateTime `json:"created_at,omitempty"` // This field can be set to another unique ID. In the case that the comment has been imported from another tool, the ID in the other tool can be indicated here. ExternalID string `json:"external_id,omitempty"` // The ID of the Comment that this comment is threaded under. ParentID *int64 `json:"parent_id,omitempty"` // The comment text. // Required: true // Max Length: 100000 Text *string `json:"text"` // Defaults to the time/date the comment is last updated, but can be set to reflect another date. // Format: date-time UpdatedAt strfmt.DateTime `json:"updated_at,omitempty"` }
CreateStoryCommentParams Request parameters for creating a Comment on a Shortcut Story.
swagger:model CreateStoryCommentParams
func (*CreateStoryCommentParams) ContextValidate ¶
func (m *CreateStoryCommentParams) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this create story comment params based on context it is used
func (*CreateStoryCommentParams) MarshalBinary ¶
func (m *CreateStoryCommentParams) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CreateStoryCommentParams) UnmarshalBinary ¶
func (m *CreateStoryCommentParams) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CreateStoryContents ¶
type CreateStoryContents struct { // The due date of the story. // Format: date-time Deadline *strfmt.DateTime `json:"deadline,omitempty"` // The description of the story. Description string `json:"description,omitempty"` // A string description of this resource. EntityType string `json:"entity_type,omitempty"` // The ID of the epic the to be populated. EpicID *int64 `json:"epic_id,omitempty"` // The numeric point estimate to be populated. Estimate *int64 `json:"estimate,omitempty"` // An array of external links to be populated. ExternalLinks []string `json:"external_links"` // An array of the attached file IDs to be populated. // Unique: true FileIds []int64 `json:"file_ids"` // An array of files attached to the story. Files []*UploadedFile `json:"files"` // An array of UUIDs for any Members listed as Followers. FollowerIds []strfmt.UUID `json:"follower_ids"` // The ID of the group to be populated. // Format: uuid GroupID *strfmt.UUID `json:"group_id,omitempty"` // The ID of the iteration the to be populated. IterationID *int64 `json:"iteration_id,omitempty"` // An array of label ids attached to the story. LabelIds []int64 `json:"label_ids"` // An array of labels to be populated by the template. Labels []*CreateLabelParams `json:"labels"` // An array of the linked file IDs to be populated. // Unique: true LinkedFileIds []int64 `json:"linked_file_ids"` // An array of linked files attached to the story. LinkedFiles []*LinkedFile `json:"linked_files"` // The name of the story. Name string `json:"name,omitempty"` // An array of UUIDs of the owners of this story. OwnerIds []strfmt.UUID `json:"owner_ids"` // The ID of the project the story belongs to. ProjectID int64 `json:"project_id,omitempty"` // The type of story (feature, bug, chore). StoryType string `json:"story_type,omitempty"` // An array of tasks to be populated by the template. Tasks []*EntityTemplateTask `json:"tasks"` // The ID of the workflow. WorkflowID *int64 `json:"workflow_id,omitempty"` // The ID of the workflow state the story is currently in. WorkflowStateID int64 `json:"workflow_state_id,omitempty"` }
CreateStoryContents A map of story attributes this template populates.
swagger:model CreateStoryContents
func (*CreateStoryContents) ContextValidate ¶
ContextValidate validate this create story contents based on the context it is used
func (*CreateStoryContents) MarshalBinary ¶
func (m *CreateStoryContents) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CreateStoryContents) UnmarshalBinary ¶
func (m *CreateStoryContents) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CreateStoryLink ¶
type CreateStoryLink struct { // The ID of the object Story. // Required: true ObjectID *int64 `json:"object_id"` // The ID of the subject Story. // Required: true SubjectID *int64 `json:"subject_id"` // The type of link. // Required: true // Enum: [blocks duplicates relates to] Verb *string `json:"verb"` }
CreateStoryLink create story link
swagger:model CreateStoryLink
func (*CreateStoryLink) ContextValidate ¶
ContextValidate validates this create story link based on context it is used
func (*CreateStoryLink) MarshalBinary ¶
func (m *CreateStoryLink) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CreateStoryLink) UnmarshalBinary ¶
func (m *CreateStoryLink) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CreateStoryLinkParams ¶
type CreateStoryLinkParams struct { // The unique ID of the Story defined as object. ObjectID int64 `json:"object_id,omitempty"` // The unique ID of the Story defined as subject. SubjectID int64 `json:"subject_id,omitempty"` // How the subject Story acts on the object Story. This can be "blocks", "duplicates", or "relates to". // Required: true // Enum: [blocks duplicates relates to] Verb *string `json:"verb"` }
CreateStoryLinkParams Request parameters for creating a Story Link within a Story.
swagger:model CreateStoryLinkParams
func (*CreateStoryLinkParams) ContextValidate ¶
ContextValidate validates this create story link params based on context it is used
func (*CreateStoryLinkParams) MarshalBinary ¶
func (m *CreateStoryLinkParams) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CreateStoryLinkParams) UnmarshalBinary ¶
func (m *CreateStoryLinkParams) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CreateStoryParams ¶
type CreateStoryParams struct { // Controls the story's archived state. Archived bool `json:"archived,omitempty"` // An array of comments to add to the story. Comments []*CreateStoryCommentParams `json:"comments"` // A manual override for the time/date the Story was completed. // Format: date-time CompletedAtOverride strfmt.DateTime `json:"completed_at_override,omitempty"` // The time/date the Story was created. // Format: date-time CreatedAt strfmt.DateTime `json:"created_at,omitempty"` // The due date of the story. // Format: date-time Deadline *strfmt.DateTime `json:"deadline,omitempty"` // The description of the story. // Max Length: 100000 Description string `json:"description,omitempty"` // The ID of the epic the story belongs to. EpicID *int64 `json:"epic_id,omitempty"` // The numeric point estimate of the story. Can also be null, which means unestimated. Estimate *int64 `json:"estimate,omitempty"` // This field can be set to another unique ID. In the case that the Story has been imported from another tool, the ID in the other tool can be indicated here. ExternalID string `json:"external_id,omitempty"` // An array of External Links associated with this story. ExternalLinks []string `json:"external_links"` // An array of IDs of files attached to the story. // Unique: true FileIds []int64 `json:"file_ids"` // An array of UUIDs of the followers of this story. // Unique: true FollowerIds []strfmt.UUID `json:"follower_ids"` // The id of the group to associate with this story. // Format: uuid GroupID *strfmt.UUID `json:"group_id,omitempty"` // The ID of the iteration the story belongs to. IterationID *int64 `json:"iteration_id,omitempty"` // An array of labels attached to the story. Labels []*CreateLabelParams `json:"labels"` // An array of IDs of linked files attached to the story. // Unique: true LinkedFileIds []int64 `json:"linked_file_ids"` // The name of the story. // Required: true // Max Length: 512 // Min Length: 1 Name *string `json:"name"` // An array of UUIDs of the owners of this story. // Unique: true OwnerIds []strfmt.UUID `json:"owner_ids"` // The ID of the project the story belongs to. ProjectID *int64 `json:"project_id,omitempty"` // The ID of the member that requested the story. // Format: uuid RequestedByID strfmt.UUID `json:"requested_by_id,omitempty"` // A manual override for the time/date the Story was started. // Format: date-time StartedAtOverride strfmt.DateTime `json:"started_at_override,omitempty"` // An array of story links attached to the story. StoryLinks []*CreateStoryLinkParams `json:"story_links"` // The id of the story template used to create this story, if applicable. // Format: uuid StoryTemplateID *strfmt.UUID `json:"story_template_id,omitempty"` // The type of story (feature, bug, chore). // Enum: [feature chore bug] StoryType string `json:"story_type,omitempty"` // An array of tasks connected to the story. Tasks []*CreateTaskParams `json:"tasks"` // The time/date the Story was updated. // Format: date-time UpdatedAt strfmt.DateTime `json:"updated_at,omitempty"` // The ID of the workflow state the story will be in. WorkflowStateID int64 `json:"workflow_state_id,omitempty"` }
CreateStoryParams Request parameters for creating a story.
swagger:model CreateStoryParams
func (*CreateStoryParams) ContextValidate ¶
ContextValidate validate this create story params based on the context it is used
func (*CreateStoryParams) MarshalBinary ¶
func (m *CreateStoryParams) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CreateStoryParams) UnmarshalBinary ¶
func (m *CreateStoryParams) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CreateTask ¶
type CreateTask struct { // True/false boolean indicating whether the Task is completed. Defaults to false. Complete bool `json:"complete,omitempty"` // Defaults to the time/date the Task is created but can be set to reflect another creation time/date. // Format: date-time CreatedAt strfmt.DateTime `json:"created_at,omitempty"` // The Task description. // Required: true Description *string `json:"description"` // This field can be set to another unique ID. In the case that the Task has been imported from another tool, the ID in the other tool can be indicated here. ExternalID string `json:"external_id,omitempty"` // An array of UUIDs for any members you want to add as Owners on this new Task. OwnerIds []strfmt.UUID `json:"owner_ids"` // Defaults to the time/date the Task is created in Shortcut but can be set to reflect another time/date. // Format: date-time UpdatedAt strfmt.DateTime `json:"updated_at,omitempty"` }
CreateTask create task
swagger:model CreateTask
func (*CreateTask) ContextValidate ¶
ContextValidate validates this create task based on context it is used
func (*CreateTask) MarshalBinary ¶
func (m *CreateTask) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CreateTask) UnmarshalBinary ¶
func (m *CreateTask) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CreateTaskParams ¶
type CreateTaskParams struct { // True/false boolean indicating whether the Task is completed. Defaults to false. Complete bool `json:"complete,omitempty"` // Defaults to the time/date the Task is created but can be set to reflect another creation time/date. // Format: date-time CreatedAt strfmt.DateTime `json:"created_at,omitempty"` // The Task description. // Required: true Description *string `json:"description"` // This field can be set to another unique ID. In the case that the Task has been imported from another tool, the ID in the other tool can be indicated here. ExternalID string `json:"external_id,omitempty"` // An array of UUIDs for any members you want to add as Owners on this new Task. OwnerIds []strfmt.UUID `json:"owner_ids"` // Defaults to the time/date the Task is created in Shortcut but can be set to reflect another time/date. // Format: date-time UpdatedAt strfmt.DateTime `json:"updated_at,omitempty"` }
CreateTaskParams Request parameters for creating a Task on a Story.
swagger:model CreateTaskParams
func (*CreateTaskParams) ContextValidate ¶
ContextValidate validates this create task params based on context it is used
func (*CreateTaskParams) MarshalBinary ¶
func (m *CreateTaskParams) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CreateTaskParams) UnmarshalBinary ¶
func (m *CreateTaskParams) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeleteStories ¶
type DeleteStories struct { // An array of IDs of Stories to delete. // Required: true // Unique: true StoryIds []int64 `json:"story_ids"` }
DeleteStories delete stories
swagger:model DeleteStories
func (*DeleteStories) ContextValidate ¶
ContextValidate validates this delete stories based on context it is used
func (*DeleteStories) MarshalBinary ¶
func (m *DeleteStories) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeleteStories) UnmarshalBinary ¶
func (m *DeleteStories) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type EntityTemplate ¶
type EntityTemplate struct { // The unique ID of the member who created the template. // Required: true // Format: uuid AuthorID *strfmt.UUID `json:"author_id"` // The time/date when the entity template was created. // Required: true // Format: date-time CreatedAt *strfmt.DateTime `json:"created_at"` // A string description of this resource. // Required: true EntityType *string `json:"entity_type"` // The unique identifier for the entity template. // Required: true // Format: uuid ID *strfmt.UUID `json:"id"` // The last time that someone created an entity using this template. // Required: true // Format: date-time LastUsedAt *strfmt.DateTime `json:"last_used_at"` // The template's name. // Required: true Name *string `json:"name"` // story contents // Required: true StoryContents *StoryContents `json:"story_contents"` // The time/date when the entity template was last updated. // Required: true // Format: date-time UpdatedAt *strfmt.DateTime `json:"updated_at"` }
EntityTemplate An entity template can be used to prefill various fields when creating new stories.
swagger:model EntityTemplate
func (*EntityTemplate) ContextValidate ¶
ContextValidate validate this entity template based on the context it is used
func (*EntityTemplate) MarshalBinary ¶
func (m *EntityTemplate) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*EntityTemplate) UnmarshalBinary ¶
func (m *EntityTemplate) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type EntityTemplateTask ¶
type EntityTemplateTask struct { // True/false boolean indicating whether the Task is completed. Defaults to false. Complete bool `json:"complete,omitempty"` // The Task description. // Required: true Description *string `json:"description"` // This field can be set to another unique ID. In the case that the Task has been imported from another tool, the ID in the other tool can be indicated here. ExternalID string `json:"external_id,omitempty"` // An array of UUIDs for any members you want to add as Owners on this new Task. OwnerIds []strfmt.UUID `json:"owner_ids"` }
EntityTemplateTask Request parameters for specifying how to pre-populate a task through a template.
swagger:model EntityTemplateTask
func (*EntityTemplateTask) ContextValidate ¶
ContextValidate validates this entity template task based on context it is used
func (*EntityTemplateTask) MarshalBinary ¶
func (m *EntityTemplateTask) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*EntityTemplateTask) UnmarshalBinary ¶
func (m *EntityTemplateTask) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Epic ¶
type Epic struct { // The Shortcut application url for the Epic. // Required: true AppURL *string `json:"app_url"` // True/false boolean that indicates whether the Epic is archived or not. // Required: true Archived *bool `json:"archived"` // A nested array of threaded comments. // Required: true Comments []*ThreadedComment `json:"comments"` // A true/false boolean indicating if the Epic has been completed. // Required: true Completed *bool `json:"completed"` // The time/date the Epic was completed. // Required: true // Format: date-time CompletedAt *strfmt.DateTime `json:"completed_at"` // A manual override for the time/date the Epic was completed. // Required: true // Format: date-time CompletedAtOverride *strfmt.DateTime `json:"completed_at_override"` // The time/date the Epic was created. // Required: true // Format: date-time CreatedAt *strfmt.DateTime `json:"created_at"` // The Epic's deadline. // Required: true // Format: date-time Deadline *strfmt.DateTime `json:"deadline"` // The Epic's description. // Required: true Description *string `json:"description"` // A string description of this resource. // Required: true EntityType *string `json:"entity_type"` // The ID of the Epic State. // Required: true EpicStateID *int64 `json:"epic_state_id"` // This field can be set to another unique ID. In the case that the Epic has been imported from another tool, the ID in the other tool can be indicated here. // Required: true ExternalID *string `json:"external_id"` // An array of UUIDs for any Members you want to add as Followers on this Epic. // Required: true FollowerIds []strfmt.UUID `json:"follower_ids"` // group id // Required: true // Format: uuid GroupID *strfmt.UUID `json:"group_id"` // An array of Group IDs that have been mentioned in the Epic description. // Required: true GroupMentionIds []strfmt.UUID `json:"group_mention_ids"` // The unique ID of the Epic. // Required: true ID *int64 `json:"id"` // An array of Label ids attached to the Epic. // Required: true LabelIds []int64 `json:"label_ids"` // An array of Labels attached to the Epic. // Required: true Labels []*LabelSlim `json:"labels"` // An array of Member IDs that have been mentioned in the Epic description. // Required: true MemberMentionIds []strfmt.UUID `json:"member_mention_ids"` // Deprecated: use member_mention_ids. // Required: true MentionIds []strfmt.UUID `json:"mention_ids"` // The ID of the Milestone this Epic is related to. // Required: true MilestoneID *int64 `json:"milestone_id"` // The name of the Epic. // Required: true Name *string `json:"name"` // An array of UUIDs for any members you want to add as Owners on this new Epic. // Required: true OwnerIds []strfmt.UUID `json:"owner_ids"` // The Epic's planned start date. // Required: true // Format: date-time PlannedStartDate *strfmt.DateTime `json:"planned_start_date"` // The Epic's relative position in the Epic workflow state. // Required: true Position *int64 `json:"position"` // The ID of the associated productboard feature. // Required: true // Format: uuid ProductboardID *strfmt.UUID `json:"productboard_id"` // The name of the associated productboard feature. // Required: true ProductboardName *string `json:"productboard_name"` // The ID of the associated productboard integration. // Required: true // Format: uuid ProductboardPluginID *strfmt.UUID `json:"productboard_plugin_id"` // The URL of the associated productboard feature. // Required: true ProductboardURL *string `json:"productboard_url"` // The IDs of Projects related to this Epic. // Required: true ProjectIds []int64 `json:"project_ids"` // The ID of the Member that requested the epic. // Required: true // Format: uuid RequestedByID *strfmt.UUID `json:"requested_by_id"` // A true/false boolean indicating if the Epic has been started. // Required: true Started *bool `json:"started"` // The time/date the Epic was started. // Required: true // Format: date-time StartedAt *strfmt.DateTime `json:"started_at"` // A manual override for the time/date the Epic was started. // Required: true // Format: date-time StartedAtOverride *strfmt.DateTime `json:"started_at_override"` // `Deprecated` The workflow state that the Epic is in. // Required: true State *string `json:"state"` // stats // Required: true Stats *EpicStats `json:"stats"` // The number of stories in this epic which are not associated with a project. // Required: true StoriesWithoutProjects *int64 `json:"stories_without_projects"` // The time/date the Epic was updated. // Required: true // Format: date-time UpdatedAt *strfmt.DateTime `json:"updated_at"` }
Epic An Epic is a collection of stories that together might make up a release, a milestone, or some other large initiative that your organization is working on.
swagger:model Epic
func (*Epic) ContextValidate ¶
ContextValidate validate this epic based on the context it is used
func (*Epic) MarshalBinary ¶
MarshalBinary interface implementation
func (*Epic) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type EpicSearchResults ¶
type EpicSearchResults struct { // cursors Cursors []string `json:"cursors"` // A list of search results. // Required: true Data []*Epic `json:"data"` // The URL path and query string for the next page of search results. // Required: true Next *string `json:"next"` // The total number of matches for the search query. The first 1000 matches can be paged through via the API. // Required: true Total *int64 `json:"total"` }
EpicSearchResults The results of the Epic search query.
swagger:model EpicSearchResults
func (*EpicSearchResults) ContextValidate ¶
ContextValidate validate this epic search results based on the context it is used
func (*EpicSearchResults) MarshalBinary ¶
func (m *EpicSearchResults) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*EpicSearchResults) UnmarshalBinary ¶
func (m *EpicSearchResults) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type EpicSlim ¶
type EpicSlim struct { // The Shortcut application url for the Epic. // Required: true AppURL *string `json:"app_url"` // True/false boolean that indicates whether the Epic is archived or not. // Required: true Archived *bool `json:"archived"` // A true/false boolean indicating if the Epic has been completed. // Required: true Completed *bool `json:"completed"` // The time/date the Epic was completed. // Required: true // Format: date-time CompletedAt *strfmt.DateTime `json:"completed_at"` // A manual override for the time/date the Epic was completed. // Required: true // Format: date-time CompletedAtOverride *strfmt.DateTime `json:"completed_at_override"` // The time/date the Epic was created. // Required: true // Format: date-time CreatedAt *strfmt.DateTime `json:"created_at"` // The Epic's deadline. // Required: true // Format: date-time Deadline *strfmt.DateTime `json:"deadline"` // The Epic's description. Description string `json:"description,omitempty"` // A string description of this resource. // Required: true EntityType *string `json:"entity_type"` // The ID of the Epic State. // Required: true EpicStateID *int64 `json:"epic_state_id"` // This field can be set to another unique ID. In the case that the Epic has been imported from another tool, the ID in the other tool can be indicated here. // Required: true ExternalID *string `json:"external_id"` // An array of UUIDs for any Members you want to add as Followers on this Epic. // Required: true FollowerIds []strfmt.UUID `json:"follower_ids"` // group id // Required: true // Format: uuid GroupID *strfmt.UUID `json:"group_id"` // An array of Group IDs that have been mentioned in the Epic description. // Required: true GroupMentionIds []strfmt.UUID `json:"group_mention_ids"` // The unique ID of the Epic. // Required: true ID *int64 `json:"id"` // An array of Label ids attached to the Epic. // Required: true LabelIds []int64 `json:"label_ids"` // An array of Labels attached to the Epic. // Required: true Labels []*LabelSlim `json:"labels"` // An array of Member IDs that have been mentioned in the Epic description. // Required: true MemberMentionIds []strfmt.UUID `json:"member_mention_ids"` // Deprecated: use member_mention_ids. // Required: true MentionIds []strfmt.UUID `json:"mention_ids"` // The ID of the Milestone this Epic is related to. // Required: true MilestoneID *int64 `json:"milestone_id"` // The name of the Epic. // Required: true Name *string `json:"name"` // An array of UUIDs for any members you want to add as Owners on this new Epic. // Required: true OwnerIds []strfmt.UUID `json:"owner_ids"` // The Epic's planned start date. // Required: true // Format: date-time PlannedStartDate *strfmt.DateTime `json:"planned_start_date"` // The Epic's relative position in the Epic workflow state. // Required: true Position *int64 `json:"position"` // The ID of the associated productboard feature. // Required: true // Format: uuid ProductboardID *strfmt.UUID `json:"productboard_id"` // The name of the associated productboard feature. // Required: true ProductboardName *string `json:"productboard_name"` // The ID of the associated productboard integration. // Required: true // Format: uuid ProductboardPluginID *strfmt.UUID `json:"productboard_plugin_id"` // The URL of the associated productboard feature. // Required: true ProductboardURL *string `json:"productboard_url"` // The IDs of Projects related to this Epic. // Required: true ProjectIds []int64 `json:"project_ids"` // The ID of the Member that requested the epic. // Required: true // Format: uuid RequestedByID *strfmt.UUID `json:"requested_by_id"` // A true/false boolean indicating if the Epic has been started. // Required: true Started *bool `json:"started"` // The time/date the Epic was started. // Required: true // Format: date-time StartedAt *strfmt.DateTime `json:"started_at"` // A manual override for the time/date the Epic was started. // Required: true // Format: date-time StartedAtOverride *strfmt.DateTime `json:"started_at_override"` // `Deprecated` The workflow state that the Epic is in. // Required: true State *string `json:"state"` // stats // Required: true Stats *EpicStats `json:"stats"` // The number of stories in this epic which are not associated with a project. // Required: true StoriesWithoutProjects *int64 `json:"stories_without_projects"` // The time/date the Epic was updated. // Required: true // Format: date-time UpdatedAt *strfmt.DateTime `json:"updated_at"` }
EpicSlim EpicSlim represents the same resource as an Epic but is more light-weight, including all Epic fields except the comments array. The description string can be optionally included. Use the [Get Epic](#Get-Epic) endpoint to fetch the unabridged payload for an Epic.
swagger:model EpicSlim
func (*EpicSlim) ContextValidate ¶
ContextValidate validate this epic slim based on the context it is used
func (*EpicSlim) MarshalBinary ¶
MarshalBinary interface implementation
func (*EpicSlim) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type EpicState ¶
type EpicState struct { // The hex color for this Epic State. // Min Length: 1 // Pattern: ^#[a-fA-F0-9]{6}$ Color string `json:"color,omitempty"` // The time/date the Epic State was created. // Required: true // Format: date-time CreatedAt *strfmt.DateTime `json:"created_at"` // The description of what sort of Epics belong in that Epic State. // Required: true Description *string `json:"description"` // A string description of this resource. // Required: true EntityType *string `json:"entity_type"` // The unique ID of the Epic State. // Required: true ID *int64 `json:"id"` // The Epic State's name. // Required: true Name *string `json:"name"` // The position that the Epic State is in, starting with 0 at the left. // Required: true Position *int64 `json:"position"` // The type of Epic State (Unstarted, Started, or Done) // Required: true Type *string `json:"type"` // When the Epic State was last updated. // Required: true // Format: date-time UpdatedAt *strfmt.DateTime `json:"updated_at"` }
EpicState Epic State is any of the at least 3 columns. Epic States correspond to one of 3 types: Unstarted, Started, or Done.
swagger:model EpicState
func (*EpicState) ContextValidate ¶
ContextValidate validates this epic state based on context it is used
func (*EpicState) MarshalBinary ¶
MarshalBinary interface implementation
func (*EpicState) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type EpicStats ¶
type EpicStats struct { // The average cycle time (in seconds) of completed stories in this Epic. AverageCycleTime int64 `json:"average_cycle_time,omitempty"` // The average lead time (in seconds) of completed stories in this Epic. AverageLeadTime int64 `json:"average_lead_time,omitempty"` // The date of the last update of a Story in this Epic. // Required: true // Format: date-time LastStoryUpdate *strfmt.DateTime `json:"last_story_update"` // The total number of points in this Epic. // Required: true NumPoints *int64 `json:"num_points"` // The total number of completed points in this Epic. // Required: true NumPointsDone *int64 `json:"num_points_done"` // The total number of started points in this Epic. // Required: true NumPointsStarted *int64 `json:"num_points_started"` // The total number of unstarted points in this Epic. // Required: true NumPointsUnstarted *int64 `json:"num_points_unstarted"` // The total number of documents associated with this Epic. // Required: true NumRelatedDocuments *int64 `json:"num_related_documents"` // The total number of done Stories in this Epic. // Required: true NumStoriesDone *int64 `json:"num_stories_done"` // The total number of started Stories in this Epic. // Required: true NumStoriesStarted *int64 `json:"num_stories_started"` // The total number of Stories in this Epic. // Required: true NumStoriesTotal *int64 `json:"num_stories_total"` // The total number of Stories with no point estimate. // Required: true NumStoriesUnestimated *int64 `json:"num_stories_unestimated"` // The total number of unstarted Stories in this Epic. // Required: true NumStoriesUnstarted *int64 `json:"num_stories_unstarted"` }
EpicStats A group of calculated values for this Epic.
swagger:model EpicStats
func (*EpicStats) ContextValidate ¶
ContextValidate validates this epic stats based on context it is used
func (*EpicStats) MarshalBinary ¶
MarshalBinary interface implementation
func (*EpicStats) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type EpicWorkflow ¶
type EpicWorkflow struct { // The date the Epic Workflow was created. // Required: true // Format: date-time CreatedAt *strfmt.DateTime `json:"created_at"` // The unique ID of the default Epic State that new Epics are assigned by default. // Required: true DefaultEpicStateID *int64 `json:"default_epic_state_id"` // A string description of this resource. // Required: true EntityType *string `json:"entity_type"` // A map of the Epic States in this Epic Workflow. // Required: true EpicStates []*EpicState `json:"epic_states"` // The unique ID of the Epic Workflow. // Required: true ID *int64 `json:"id"` // The date the Epic Workflow was updated. // Required: true // Format: date-time UpdatedAt *strfmt.DateTime `json:"updated_at"` }
EpicWorkflow Epic Workflow is the array of defined Epic States. Epic Workflow can be queried using the API but must be updated in the Shortcut UI.
swagger:model EpicWorkflow
func (*EpicWorkflow) ContextValidate ¶
ContextValidate validate this epic workflow based on the context it is used
func (*EpicWorkflow) MarshalBinary ¶
func (m *EpicWorkflow) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*EpicWorkflow) UnmarshalBinary ¶
func (m *EpicWorkflow) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type GetEpicStories ¶
type GetEpicStories struct { // A true/false boolean indicating whether to return Stories with their descriptions. IncludesDescription bool `json:"includes_description,omitempty"` }
GetEpicStories get epic stories
swagger:model GetEpicStories
func (*GetEpicStories) ContextValidate ¶
ContextValidate validates this get epic stories based on context it is used
func (*GetEpicStories) MarshalBinary ¶
func (m *GetEpicStories) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*GetEpicStories) UnmarshalBinary ¶
func (m *GetEpicStories) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type GetExternalLinkStoriesParams ¶
type GetExternalLinkStoriesParams struct { // The external link associated with one or more stories. // Required: true // Max Length: 2048 // Pattern: ^https?://.+$ ExternalLink *string `json:"external_link"` }
GetExternalLinkStoriesParams get external link stories params
swagger:model GetExternalLinkStoriesParams
func (*GetExternalLinkStoriesParams) ContextValidate ¶
func (m *GetExternalLinkStoriesParams) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this get external link stories params based on context it is used
func (*GetExternalLinkStoriesParams) MarshalBinary ¶
func (m *GetExternalLinkStoriesParams) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*GetExternalLinkStoriesParams) UnmarshalBinary ¶
func (m *GetExternalLinkStoriesParams) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type GetIterationStories ¶
type GetIterationStories struct { // A true/false boolean indicating whether to return Stories with their descriptions. IncludesDescription bool `json:"includes_description,omitempty"` }
GetIterationStories get iteration stories
swagger:model GetIterationStories
func (*GetIterationStories) ContextValidate ¶
ContextValidate validates this get iteration stories based on context it is used
func (*GetIterationStories) MarshalBinary ¶
func (m *GetIterationStories) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*GetIterationStories) UnmarshalBinary ¶
func (m *GetIterationStories) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type GetLabelStories ¶
type GetLabelStories struct { // A true/false boolean indicating whether to return Stories with their descriptions. IncludesDescription bool `json:"includes_description,omitempty"` }
GetLabelStories get label stories
swagger:model GetLabelStories
func (*GetLabelStories) ContextValidate ¶
ContextValidate validates this get label stories based on context it is used
func (*GetLabelStories) MarshalBinary ¶
func (m *GetLabelStories) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*GetLabelStories) UnmarshalBinary ¶
func (m *GetLabelStories) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type GetMember ¶
type GetMember struct { // The unique ID of the Organization to limit the lookup to. // Format: uuid OrgPublicID strfmt.UUID `json:"org-public-id,omitempty"` }
GetMember get member
swagger:model GetMember
func (*GetMember) ContextValidate ¶
ContextValidate validates this get member based on context it is used
func (*GetMember) MarshalBinary ¶
MarshalBinary interface implementation
func (*GetMember) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type GetProjectStories ¶
type GetProjectStories struct { // A true/false boolean indicating whether to return Stories with their descriptions. IncludesDescription bool `json:"includes_description,omitempty"` }
GetProjectStories get project stories
swagger:model GetProjectStories
func (*GetProjectStories) ContextValidate ¶
ContextValidate validates this get project stories based on context it is used
func (*GetProjectStories) MarshalBinary ¶
func (m *GetProjectStories) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*GetProjectStories) UnmarshalBinary ¶
func (m *GetProjectStories) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Group ¶
type Group struct { // The Shortcut application url for the Group. // Required: true AppURL *string `json:"app_url"` // Whether or not the Group is archived. // Required: true Archived *bool `json:"archived"` // The hex color to be displayed with the Group (for example, "#ff0000"). // Required: true // Min Length: 1 // Pattern: ^#[a-fA-F0-9]{6}$ Color *string `json:"color"` // The color key to be displayed with the Group. // Required: true // Enum: [blue purple midnight-blue orange yellow-green brass gray fuchsia yellow pink sky-blue green red black slate turquoise] ColorKey *string `json:"color_key"` // The description of the Group. // Required: true Description *string `json:"description"` // display icon // Required: true DisplayIcon *Icon `json:"display_icon"` // A string description of this resource. // Required: true EntityType *string `json:"entity_type"` // The id of the Group. // Required: true // Format: uuid ID *strfmt.UUID `json:"id"` // The Member IDs contain within the Group. // Required: true MemberIds []strfmt.UUID `json:"member_ids"` // The mention name of the Group. // Required: true // Min Length: 1 // Pattern: ^[a-z0-9\-\_\.]+$ MentionName *string `json:"mention_name"` // The name of the Group. // Required: true Name *string `json:"name"` // The number of epics assigned to the group which are in the started workflow state. // Required: true NumEpicsStarted *int64 `json:"num_epics_started"` // The total number of stories assigned ot the group. // Required: true NumStories *int64 `json:"num_stories"` // The number of stories assigned to the group which are in a started workflow state. // Required: true NumStoriesStarted *int64 `json:"num_stories_started"` // The Workflow IDs which have stories assigned to the group. // Required: true StoryWorkflowIds []int64 `json:"story_workflow_ids"` // The Workflow IDs contained within the Group. // Required: true WorkflowIds []int64 `json:"workflow_ids"` }
Group A Group.
swagger:model Group
func (*Group) ContextValidate ¶
ContextValidate validate this group based on the context it is used
func (*Group) MarshalBinary ¶
MarshalBinary interface implementation
func (*Group) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type History ¶
type History struct { // An array of actions that were performed for the change. // Required: true Actions []interface{} `json:"actions"` // The date when the change occurred. // Required: true ChangedAt *string `json:"changed_at"` // The ID of the webhook that handled the change. ExternalID string `json:"external_id,omitempty"` // The ID representing the change for the story. // Required: true // Format: uuid ID *strfmt.UUID `json:"id"` // The ID of the member who performed the change. // Format: uuid MemberID strfmt.UUID `json:"member_id,omitempty"` // The ID of the primary entity that has changed, if applicable. PrimaryID int64 `json:"primary_id,omitempty"` // An array of objects affected by the change. Reference objects provide basic information for the entities reference in the history actions. Some have specific fields, but they always contain an id, entity_type, and a name. References []interface{} `json:"references"` // The version of the change format. // Required: true // Enum: [v1] Version *string `json:"version"` // The ID of the webhook that handled the change. WebhookID *string `json:"webhook_id,omitempty"` }
History A history item is a group of actions that represent a transactional change to a Story.
swagger:model History
func (*History) ContextValidate ¶
ContextValidate validates this history based on context it is used
func (*History) MarshalBinary ¶
MarshalBinary interface implementation
func (*History) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type HistoryActionBranchCreate ¶
type HistoryActionBranchCreate struct { // The action of the entity referenced. // Required: true // Enum: [create] Action *string `json:"action"` // The type of entity referenced. // Required: true EntityType *string `json:"entity_type"` // The ID of the entity referenced. // Required: true ID *int64 `json:"id"` // The name of the VCS Branch that was pushed // Required: true Name *string `json:"name"` // The URL from the provider of the VCS Branch that was pushed // Required: true URL *string `json:"url"` }
HistoryActionBranchCreate An action representing a VCS Branch being created.
swagger:model HistoryActionBranchCreate
func (*HistoryActionBranchCreate) ContextValidate ¶
func (m *HistoryActionBranchCreate) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this history action branch create based on context it is used
func (*HistoryActionBranchCreate) MarshalBinary ¶
func (m *HistoryActionBranchCreate) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*HistoryActionBranchCreate) UnmarshalBinary ¶
func (m *HistoryActionBranchCreate) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type HistoryActionBranchMerge ¶
type HistoryActionBranchMerge struct { // The action of the entity referenced. // Required: true // Enum: [merge] Action *string `json:"action"` // The type of entity referenced. // Required: true EntityType *string `json:"entity_type"` // The ID of the entity referenced. // Required: true ID *int64 `json:"id"` // The name of the VCS Branch that was pushed // Required: true Name *string `json:"name"` // The URL from the provider of the VCS Branch that was pushed // Required: true URL *string `json:"url"` }
HistoryActionBranchMerge An action representing a VCS Branch being merged.
swagger:model HistoryActionBranchMerge
func (*HistoryActionBranchMerge) ContextValidate ¶
func (m *HistoryActionBranchMerge) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this history action branch merge based on context it is used
func (*HistoryActionBranchMerge) MarshalBinary ¶
func (m *HistoryActionBranchMerge) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*HistoryActionBranchMerge) UnmarshalBinary ¶
func (m *HistoryActionBranchMerge) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type HistoryActionBranchPush ¶
type HistoryActionBranchPush struct { // The action of the entity referenced. // Required: true // Enum: [push] Action *string `json:"action"` // The type of entity referenced. // Required: true EntityType *string `json:"entity_type"` // The ID of the entity referenced. // Required: true ID *int64 `json:"id"` // The name of the VCS Branch that was pushed // Required: true Name *string `json:"name"` // The URL from the provider of the VCS Branch that was pushed // Required: true URL *string `json:"url"` }
HistoryActionBranchPush An action representing a VCS Branch being pushed.
swagger:model HistoryActionBranchPush
func (*HistoryActionBranchPush) ContextValidate ¶
func (m *HistoryActionBranchPush) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this history action branch push based on context it is used
func (*HistoryActionBranchPush) MarshalBinary ¶
func (m *HistoryActionBranchPush) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*HistoryActionBranchPush) UnmarshalBinary ¶
func (m *HistoryActionBranchPush) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type HistoryActionLabelCreate ¶
type HistoryActionLabelCreate struct { // The action of the entity referenced. // Required: true // Enum: [create] Action *string `json:"action"` // The application URL of the Label. // Required: true // Max Length: 2048 // Pattern: ^https?://.+$ AppURL *string `json:"app_url"` // The type of entity referenced. // Required: true EntityType *string `json:"entity_type"` // The ID of the entity referenced. // Required: true ID *int64 `json:"id"` // The name of the Label. // Required: true Name *string `json:"name"` }
HistoryActionLabelCreate An action representing a Label being created.
swagger:model HistoryActionLabelCreate
func (*HistoryActionLabelCreate) ContextValidate ¶
func (m *HistoryActionLabelCreate) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this history action label create based on context it is used
func (*HistoryActionLabelCreate) MarshalBinary ¶
func (m *HistoryActionLabelCreate) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*HistoryActionLabelCreate) UnmarshalBinary ¶
func (m *HistoryActionLabelCreate) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type HistoryActionLabelDelete ¶
type HistoryActionLabelDelete struct { // The action of the entity referenced. // Required: true // Enum: [delete] Action *string `json:"action"` // The type of entity referenced. // Required: true EntityType *string `json:"entity_type"` // The ID of the entity referenced. // Required: true ID *int64 `json:"id"` // The name of the Label. // Required: true Name *string `json:"name"` }
HistoryActionLabelDelete An action representing a Label being deleted.
swagger:model HistoryActionLabelDelete
func (*HistoryActionLabelDelete) ContextValidate ¶
func (m *HistoryActionLabelDelete) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this history action label delete based on context it is used
func (*HistoryActionLabelDelete) MarshalBinary ¶
func (m *HistoryActionLabelDelete) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*HistoryActionLabelDelete) UnmarshalBinary ¶
func (m *HistoryActionLabelDelete) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type HistoryActionLabelUpdate ¶
type HistoryActionLabelUpdate struct { // The action of the entity referenced. // Required: true // Enum: [update] Action *string `json:"action"` // The type of entity referenced. // Required: true EntityType *string `json:"entity_type"` // The ID of the entity referenced. // Required: true ID *int64 `json:"id"` }
HistoryActionLabelUpdate An action representing a Label being updated.
swagger:model HistoryActionLabelUpdate
func (*HistoryActionLabelUpdate) ContextValidate ¶
func (m *HistoryActionLabelUpdate) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this history action label update based on context it is used
func (*HistoryActionLabelUpdate) MarshalBinary ¶
func (m *HistoryActionLabelUpdate) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*HistoryActionLabelUpdate) UnmarshalBinary ¶
func (m *HistoryActionLabelUpdate) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type HistoryActionProjectUpdate ¶
type HistoryActionProjectUpdate struct { // The action of the entity referenced. // Required: true // Enum: [update] Action *string `json:"action"` // The application URL of the Project. // Required: true // Max Length: 2048 // Pattern: ^https?://.+$ AppURL *string `json:"app_url"` // The type of entity referenced. // Required: true EntityType *string `json:"entity_type"` // The ID of the entity referenced. // Required: true ID *int64 `json:"id"` // The name of the Project. // Required: true Name *string `json:"name"` }
HistoryActionProjectUpdate An action representing a Project being updated.
swagger:model HistoryActionProjectUpdate
func (*HistoryActionProjectUpdate) ContextValidate ¶
func (m *HistoryActionProjectUpdate) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this history action project update based on context it is used
func (*HistoryActionProjectUpdate) MarshalBinary ¶
func (m *HistoryActionProjectUpdate) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*HistoryActionProjectUpdate) UnmarshalBinary ¶
func (m *HistoryActionProjectUpdate) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type HistoryActionPullRequest ¶
type HistoryActionPullRequest struct { // The action of the entity referenced. // Required: true // Enum: [open update reopen close sync comment] Action *string `json:"action"` // The type of entity referenced. // Required: true EntityType *string `json:"entity_type"` // The ID of the entity referenced. // Required: true ID *int64 `json:"id"` // The VCS Repository-specific ID for the Pull Request. // Required: true Number *int64 `json:"number"` // The title of the Pull Request. // Required: true Title *string `json:"title"` // The URL from the provider of the VCS Pull Request. // Required: true // Max Length: 2048 // Pattern: ^https?://.+$ URL *string `json:"url"` }
HistoryActionPullRequest An action representing various operations for a Pull Request.
swagger:model HistoryActionPullRequest
func (*HistoryActionPullRequest) ContextValidate ¶
func (m *HistoryActionPullRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this history action pull request based on context it is used
func (*HistoryActionPullRequest) MarshalBinary ¶
func (m *HistoryActionPullRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*HistoryActionPullRequest) UnmarshalBinary ¶
func (m *HistoryActionPullRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type HistoryActionStoryCommentCreate ¶
type HistoryActionStoryCommentCreate struct { // The action of the entity referenced. // Required: true // Enum: [create] Action *string `json:"action"` // The application URL of the Story Comment. // Required: true // Max Length: 2048 // Pattern: ^https?://.+$ AppURL *string `json:"app_url"` // The Member ID of who created the Story Comment. // Required: true // Format: uuid AuthorID *strfmt.UUID `json:"author_id"` // The type of entity referenced. // Required: true EntityType *string `json:"entity_type"` // The ID of the entity referenced. // Required: true ID *int64 `json:"id"` // The text of the Story Comment. // Required: true Text *string `json:"text"` }
HistoryActionStoryCommentCreate An action representing a Story Comment being created.
swagger:model HistoryActionStoryCommentCreate
func (*HistoryActionStoryCommentCreate) ContextValidate ¶
func (m *HistoryActionStoryCommentCreate) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this history action story comment create based on context it is used
func (*HistoryActionStoryCommentCreate) MarshalBinary ¶
func (m *HistoryActionStoryCommentCreate) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*HistoryActionStoryCommentCreate) UnmarshalBinary ¶
func (m *HistoryActionStoryCommentCreate) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type HistoryActionStoryCreate ¶
type HistoryActionStoryCreate struct { // The action of the entity referenced. // Required: true // Enum: [create] Action *string `json:"action"` // The application URL of the Story. // Required: true // Max Length: 2048 // Pattern: ^https?://.+$ AppURL *string `json:"app_url"` // Whether or not the Story is blocked by another Story. Blocked bool `json:"blocked,omitempty"` // Whether or not the Story is blocking another Story. Blocker bool `json:"blocker,omitempty"` // Whether or not the Story is completed. Completed bool `json:"completed,omitempty"` // The timestamp representing the Story's deadline. Deadline string `json:"deadline,omitempty"` // The description of the Story. Description string `json:"description,omitempty"` // The type of entity referenced. // Required: true EntityType *string `json:"entity_type"` // The Epic ID for this Story. EpicID int64 `json:"epic_id,omitempty"` // The estimate (or point value) for the Story. Estimate int64 `json:"estimate,omitempty"` // An array of Member IDs for the followers of the Story. FollowerIds []strfmt.UUID `json:"follower_ids"` // The ID of the entity referenced. // Required: true ID *int64 `json:"id"` // The Iteration ID the Story is in. IterationID *int64 `json:"iteration_id,omitempty"` // An array of Labels IDs attached to the Story. LabelIds []int64 `json:"label_ids"` // The name of the Story. // Required: true Name *string `json:"name"` // An array of Story IDs that are the object of a Story Link relationship. ObjectStoryLinkIds []int64 `json:"object_story_link_ids"` // An array of Member IDs that are the owners of the Story. OwnerIds []strfmt.UUID `json:"owner_ids"` // The Project ID of the Story is in. ProjectID int64 `json:"project_id,omitempty"` // The ID of the Member that requested the Story. // Format: uuid RequestedByID strfmt.UUID `json:"requested_by_id,omitempty"` // Whether or not the Story has been started. Started bool `json:"started,omitempty"` // The type of Story; either feature, bug, or chore. // Required: true // Enum: [feature chore bug] StoryType *string `json:"story_type"` // An array of Story IDs that are the subject of a Story Link relationship. SubjectStoryLinkIds []int64 `json:"subject_story_link_ids"` // An array of Task IDs on this Story. TaskIds []int64 `json:"task_ids"` // An array of Workflow State IDs attached to the Story. WorkflowStateID int64 `json:"workflow_state_id,omitempty"` }
HistoryActionStoryCreate An action representing a Story being created.
swagger:model HistoryActionStoryCreate
func (*HistoryActionStoryCreate) ContextValidate ¶
func (m *HistoryActionStoryCreate) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this history action story create based on context it is used
func (*HistoryActionStoryCreate) MarshalBinary ¶
func (m *HistoryActionStoryCreate) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*HistoryActionStoryCreate) UnmarshalBinary ¶
func (m *HistoryActionStoryCreate) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type HistoryActionStoryDelete ¶
type HistoryActionStoryDelete struct { // The action of the entity referenced. // Required: true // Enum: [delete] Action *string `json:"action"` // The type of entity referenced. // Required: true EntityType *string `json:"entity_type"` // The ID of the entity referenced. // Required: true ID *int64 `json:"id"` // The name of the Story. // Required: true Name *string `json:"name"` // The type of Story; either feature, bug, or chore. // Required: true // Enum: [feature chore bug] StoryType *string `json:"story_type"` }
HistoryActionStoryDelete An action representing a Story being deleted.
swagger:model HistoryActionStoryDelete
func (*HistoryActionStoryDelete) ContextValidate ¶
func (m *HistoryActionStoryDelete) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this history action story delete based on context it is used
func (*HistoryActionStoryDelete) MarshalBinary ¶
func (m *HistoryActionStoryDelete) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*HistoryActionStoryDelete) UnmarshalBinary ¶
func (m *HistoryActionStoryDelete) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type HistoryActionStoryLinkCreate ¶
type HistoryActionStoryLinkCreate struct { // The action of the entity referenced. // Required: true // Enum: [create] Action *string `json:"action"` // The type of entity referenced. // Required: true EntityType *string `json:"entity_type"` // The ID of the entity referenced. // Required: true ID *int64 `json:"id"` // The Story ID of the object Story. // Required: true ObjectID *int64 `json:"object_id"` // The Story ID of the subject Story. // Required: true SubjectID *int64 `json:"subject_id"` // The verb describing the link's relationship. // Required: true // Enum: [blocks duplicates relates to] Verb *string `json:"verb"` }
HistoryActionStoryLinkCreate An action representing a Story Link being created.
swagger:model HistoryActionStoryLinkCreate
func (*HistoryActionStoryLinkCreate) ContextValidate ¶
func (m *HistoryActionStoryLinkCreate) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this history action story link create based on context it is used
func (*HistoryActionStoryLinkCreate) MarshalBinary ¶
func (m *HistoryActionStoryLinkCreate) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*HistoryActionStoryLinkCreate) UnmarshalBinary ¶
func (m *HistoryActionStoryLinkCreate) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type HistoryActionStoryLinkDelete ¶
type HistoryActionStoryLinkDelete struct { // The action of the entity referenced. // Required: true // Enum: [delete] Action *string `json:"action"` // The type of entity referenced. // Required: true EntityType *string `json:"entity_type"` // The ID of the entity referenced. // Required: true ID *int64 `json:"id"` // The Story ID of the object Story. // Required: true ObjectID *int64 `json:"object_id"` // The Story ID of the subject Story. // Required: true SubjectID *int64 `json:"subject_id"` // The verb describing the link's relationship. // Required: true // Enum: [blocks duplicates relates to] Verb *string `json:"verb"` }
HistoryActionStoryLinkDelete An action representing a Story Link being deleted.
swagger:model HistoryActionStoryLinkDelete
func (*HistoryActionStoryLinkDelete) ContextValidate ¶
func (m *HistoryActionStoryLinkDelete) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this history action story link delete based on context it is used
func (*HistoryActionStoryLinkDelete) MarshalBinary ¶
func (m *HistoryActionStoryLinkDelete) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*HistoryActionStoryLinkDelete) UnmarshalBinary ¶
func (m *HistoryActionStoryLinkDelete) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type HistoryActionStoryLinkUpdate ¶
type HistoryActionStoryLinkUpdate struct { // The action of the entity referenced. // Required: true // Enum: [update] Action *string `json:"action"` // changes // Required: true Changes *HistoryChangesStoryLink `json:"changes"` // The type of entity referenced. // Required: true EntityType *string `json:"entity_type"` // The ID of the entity referenced. // Required: true ID *int64 `json:"id"` // The Story ID of the object Story. // Required: true ObjectID *int64 `json:"object_id"` // The Story ID of the subject Story. // Required: true SubjectID *int64 `json:"subject_id"` // The verb describing the link's relationship. // Required: true // Enum: [blocks duplicates relates to] Verb *string `json:"verb"` }
HistoryActionStoryLinkUpdate An action representing a Story Link being updated.
swagger:model HistoryActionStoryLinkUpdate
func (*HistoryActionStoryLinkUpdate) ContextValidate ¶
func (m *HistoryActionStoryLinkUpdate) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this history action story link update based on the context it is used
func (*HistoryActionStoryLinkUpdate) MarshalBinary ¶
func (m *HistoryActionStoryLinkUpdate) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*HistoryActionStoryLinkUpdate) UnmarshalBinary ¶
func (m *HistoryActionStoryLinkUpdate) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type HistoryActionStoryUpdate ¶
type HistoryActionStoryUpdate struct { // The action of the entity referenced. // Required: true // Enum: [update] Action *string `json:"action"` // The application URL of the Story. // Required: true // Max Length: 2048 // Pattern: ^https?://.+$ AppURL *string `json:"app_url"` // changes Changes *HistoryChangesStory `json:"changes,omitempty"` // The type of entity referenced. // Required: true EntityType *string `json:"entity_type"` // The ID of the entity referenced. // Required: true ID *int64 `json:"id"` // The name of the Story. // Required: true Name *string `json:"name"` // The type of Story; either feature, bug, or chore. // Required: true // Enum: [feature chore bug] StoryType *string `json:"story_type"` }
HistoryActionStoryUpdate An action representing a Story being updated.
swagger:model HistoryActionStoryUpdate
func (*HistoryActionStoryUpdate) ContextValidate ¶
func (m *HistoryActionStoryUpdate) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this history action story update based on the context it is used
func (*HistoryActionStoryUpdate) MarshalBinary ¶
func (m *HistoryActionStoryUpdate) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*HistoryActionStoryUpdate) UnmarshalBinary ¶
func (m *HistoryActionStoryUpdate) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type HistoryActionTaskCreate ¶
type HistoryActionTaskCreate struct { // The action of the entity referenced. // Required: true // Enum: [create] Action *string `json:"action"` // Whether or not the Task is complete. // Required: true Complete *bool `json:"complete"` // A timestamp that represent's the Task's deadline. Deadline string `json:"deadline,omitempty"` // The description of the Task. // Required: true Description *string `json:"description"` // The type of entity referenced. // Required: true EntityType *string `json:"entity_type"` // An array of Groups IDs that represent which have been mentioned in the Task. GroupMentionIds []strfmt.UUID `json:"group_mention_ids"` // The ID of the entity referenced. // Required: true ID *int64 `json:"id"` // An array of Member IDs that represent who has been mentioned in the Task. MentionIds []strfmt.UUID `json:"mention_ids"` // An array of Member IDs that represent the Task's owners. OwnerIds []strfmt.UUID `json:"owner_ids"` }
HistoryActionTaskCreate An action representing a Task being created.
swagger:model HistoryActionTaskCreate
func (*HistoryActionTaskCreate) ContextValidate ¶
func (m *HistoryActionTaskCreate) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this history action task create based on context it is used
func (*HistoryActionTaskCreate) MarshalBinary ¶
func (m *HistoryActionTaskCreate) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*HistoryActionTaskCreate) UnmarshalBinary ¶
func (m *HistoryActionTaskCreate) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type HistoryActionTaskDelete ¶
type HistoryActionTaskDelete struct { // The action of the entity referenced. // Required: true // Enum: [delete] Action *string `json:"action"` // The description of the Task being deleted. // Required: true Description *string `json:"description"` // The type of entity referenced. // Required: true EntityType *string `json:"entity_type"` // The ID of the entity referenced. // Required: true ID *int64 `json:"id"` }
HistoryActionTaskDelete An action representing a Task being deleted.
swagger:model HistoryActionTaskDelete
func (*HistoryActionTaskDelete) ContextValidate ¶
func (m *HistoryActionTaskDelete) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this history action task delete based on context it is used
func (*HistoryActionTaskDelete) MarshalBinary ¶
func (m *HistoryActionTaskDelete) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*HistoryActionTaskDelete) UnmarshalBinary ¶
func (m *HistoryActionTaskDelete) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type HistoryActionTaskUpdate ¶
type HistoryActionTaskUpdate struct { // The action of the entity referenced. // Required: true // Enum: [update] Action *string `json:"action"` // changes // Required: true Changes *HistoryChangesTask `json:"changes"` // Whether or not the Task is complete. Complete bool `json:"complete,omitempty"` // The description of the Task. // Required: true Description *string `json:"description"` // The type of entity referenced. // Required: true EntityType *string `json:"entity_type"` // The ID of the entity referenced. // Required: true ID *int64 `json:"id"` // The Story ID that contains the Task. // Required: true StoryID *int64 `json:"story_id"` }
HistoryActionTaskUpdate An action representing a Task being updated.
swagger:model HistoryActionTaskUpdate
func (*HistoryActionTaskUpdate) ContextValidate ¶
func (m *HistoryActionTaskUpdate) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this history action task update based on the context it is used
func (*HistoryActionTaskUpdate) MarshalBinary ¶
func (m *HistoryActionTaskUpdate) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*HistoryActionTaskUpdate) UnmarshalBinary ¶
func (m *HistoryActionTaskUpdate) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type HistoryChangesStory ¶
type HistoryChangesStory struct { // archived Archived *StoryHistoryChangeOldNewBool `json:"archived,omitempty"` // blocked Blocked *StoryHistoryChangeOldNewBool `json:"blocked,omitempty"` // blocker Blocker *StoryHistoryChangeOldNewBool `json:"blocker,omitempty"` // branch ids BranchIds *StoryHistoryChangeAddsRemovesInt `json:"branch_ids,omitempty"` // commit ids CommitIds *StoryHistoryChangeAddsRemovesInt `json:"commit_ids,omitempty"` // completed Completed *StoryHistoryChangeOldNewBool `json:"completed,omitempty"` // deadline Deadline *StoryHistoryChangeOldNewStr `json:"deadline,omitempty"` // description Description *StoryHistoryChangeOldNewStr `json:"description,omitempty"` // epic id EpicID *StoryHistoryChangeOldNewInt `json:"epic_id,omitempty"` // estimate Estimate *StoryHistoryChangeOldNewInt `json:"estimate,omitempty"` // follower ids FollowerIds *StoryHistoryChangeAddsRemovesUUID `json:"follower_ids,omitempty"` // iteration id IterationID *StoryHistoryChangeOldNewInt `json:"iteration_id,omitempty"` // label ids LabelIds *StoryHistoryChangeAddsRemovesInt `json:"label_ids,omitempty"` // mention ids MentionIds *StoryHistoryChangeAddsRemovesUUID `json:"mention_ids,omitempty"` // name Name *StoryHistoryChangeOldNewStr `json:"name,omitempty"` // object story link ids ObjectStoryLinkIds *StoryHistoryChangeAddsRemovesInt `json:"object_story_link_ids,omitempty"` // owner ids OwnerIds *StoryHistoryChangeAddsRemovesUUID `json:"owner_ids,omitempty"` // project id ProjectID *StoryHistoryChangeOldNewInt `json:"project_id,omitempty"` // requested by id RequestedByID *StoryHistoryChangeOldNewUUID `json:"requested_by_id,omitempty"` // started Started *StoryHistoryChangeOldNewBool `json:"started,omitempty"` // story type StoryType *StoryHistoryChangeOldNewStr `json:"story_type,omitempty"` // subject story link ids SubjectStoryLinkIds *StoryHistoryChangeAddsRemovesInt `json:"subject_story_link_ids,omitempty"` // task ids TaskIds *StoryHistoryChangeAddsRemovesInt `json:"task_ids,omitempty"` // workflow state id WorkflowStateID *StoryHistoryChangeOldNewInt `json:"workflow_state_id,omitempty"` }
HistoryChangesStory The changes that have occurred as a result of the action.
swagger:model HistoryChangesStory
func (*HistoryChangesStory) ContextValidate ¶
ContextValidate validate this history changes story based on the context it is used
func (*HistoryChangesStory) MarshalBinary ¶
func (m *HistoryChangesStory) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*HistoryChangesStory) UnmarshalBinary ¶
func (m *HistoryChangesStory) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type HistoryChangesStoryLink ¶
type HistoryChangesStoryLink struct { // object id ObjectID *StoryHistoryChangeOldNewInt `json:"object_id,omitempty"` // subject id SubjectID *StoryHistoryChangeOldNewInt `json:"subject_id,omitempty"` // verb Verb *StoryHistoryChangeOldNewStr `json:"verb,omitempty"` }
HistoryChangesStoryLink The changes that have occurred as a result of the action.
swagger:model HistoryChangesStoryLink
func (*HistoryChangesStoryLink) ContextValidate ¶
func (m *HistoryChangesStoryLink) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this history changes story link based on the context it is used
func (*HistoryChangesStoryLink) MarshalBinary ¶
func (m *HistoryChangesStoryLink) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*HistoryChangesStoryLink) UnmarshalBinary ¶
func (m *HistoryChangesStoryLink) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type HistoryChangesTask ¶
type HistoryChangesTask struct { // complete Complete *StoryHistoryChangeOldNewBool `json:"complete,omitempty"` // description Description *StoryHistoryChangeOldNewStr `json:"description,omitempty"` // mention ids MentionIds *StoryHistoryChangeAddsRemovesUUID `json:"mention_ids,omitempty"` // owner ids OwnerIds *StoryHistoryChangeAddsRemovesUUID `json:"owner_ids,omitempty"` }
HistoryChangesTask The changes that have occurred as a result of the action.
swagger:model HistoryChangesTask
func (*HistoryChangesTask) ContextValidate ¶
ContextValidate validate this history changes task based on the context it is used
func (*HistoryChangesTask) MarshalBinary ¶
func (m *HistoryChangesTask) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*HistoryChangesTask) UnmarshalBinary ¶
func (m *HistoryChangesTask) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type HistoryReferenceBranch ¶
type HistoryReferenceBranch struct { // The type of entity referenced. // Required: true EntityType *string `json:"entity_type"` // The ID of the entity referenced. // Required: true ID *int64 `json:"id"` // The name of the entity referenced. // Required: true Name *string `json:"name"` // The external URL for the Branch. // Required: true // Max Length: 2048 // Pattern: ^https?://.+$ URL *string `json:"url"` }
HistoryReferenceBranch A reference to a VCS Branch.
swagger:model HistoryReferenceBranch
func (*HistoryReferenceBranch) ContextValidate ¶
func (m *HistoryReferenceBranch) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this history reference branch based on context it is used
func (*HistoryReferenceBranch) MarshalBinary ¶
func (m *HistoryReferenceBranch) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*HistoryReferenceBranch) UnmarshalBinary ¶
func (m *HistoryReferenceBranch) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type HistoryReferenceCommit ¶
type HistoryReferenceCommit struct { // The type of entity referenced. // Required: true EntityType *string `json:"entity_type"` // The ID of the entity referenced. // Required: true ID *int64 `json:"id"` // The message from the Commit. // Required: true Message *string `json:"message"` // The external URL for the Branch. // Required: true // Max Length: 2048 // Pattern: ^https?://.+$ URL *string `json:"url"` }
HistoryReferenceCommit A reference to a VCS Commit.
swagger:model HistoryReferenceCommit
func (*HistoryReferenceCommit) ContextValidate ¶
func (m *HistoryReferenceCommit) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this history reference commit based on context it is used
func (*HistoryReferenceCommit) MarshalBinary ¶
func (m *HistoryReferenceCommit) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*HistoryReferenceCommit) UnmarshalBinary ¶
func (m *HistoryReferenceCommit) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type HistoryReferenceEpic ¶
type HistoryReferenceEpic struct { // The application URL of the Epic. // Required: true // Max Length: 2048 // Pattern: ^https?://.+$ AppURL *string `json:"app_url"` // The type of entity referenced. // Required: true EntityType *string `json:"entity_type"` // The ID of the entity referenced. // Required: true ID *int64 `json:"id"` // The name of the entity referenced. // Required: true Name *string `json:"name"` }
HistoryReferenceEpic A reference to an Epic.
swagger:model HistoryReferenceEpic
func (*HistoryReferenceEpic) ContextValidate ¶
ContextValidate validates this history reference epic based on context it is used
func (*HistoryReferenceEpic) MarshalBinary ¶
func (m *HistoryReferenceEpic) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*HistoryReferenceEpic) UnmarshalBinary ¶
func (m *HistoryReferenceEpic) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type HistoryReferenceGeneral ¶
type HistoryReferenceGeneral struct { // The type of entity referenced. // Required: true EntityType *string `json:"entity_type"` // The ID of the entity referenced. // Required: true ID *int64 `json:"id"` // The name of the entity referenced. // Required: true Name *string `json:"name"` }
HistoryReferenceGeneral A default reference for entity types that don't have extra fields.
swagger:model HistoryReferenceGeneral
func (*HistoryReferenceGeneral) ContextValidate ¶
func (m *HistoryReferenceGeneral) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this history reference general based on context it is used
func (*HistoryReferenceGeneral) MarshalBinary ¶
func (m *HistoryReferenceGeneral) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*HistoryReferenceGeneral) UnmarshalBinary ¶
func (m *HistoryReferenceGeneral) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type HistoryReferenceGroup ¶
type HistoryReferenceGroup struct { // The type of entity referenced. // Required: true EntityType *string `json:"entity_type"` // The ID of the entity referenced. // Required: true // Format: uuid ID *strfmt.UUID `json:"id"` // The name of the entity referenced. // Required: true Name *string `json:"name"` }
HistoryReferenceGroup A reference to a Group.
swagger:model HistoryReferenceGroup
func (*HistoryReferenceGroup) ContextValidate ¶
ContextValidate validates this history reference group based on context it is used
func (*HistoryReferenceGroup) MarshalBinary ¶
func (m *HistoryReferenceGroup) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*HistoryReferenceGroup) UnmarshalBinary ¶
func (m *HistoryReferenceGroup) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type HistoryReferenceIteration ¶
type HistoryReferenceIteration struct { // The application URL of the Iteration. // Required: true // Max Length: 2048 // Pattern: ^https?://.+$ AppURL *string `json:"app_url"` // The type of entity referenced. // Required: true EntityType *string `json:"entity_type"` // The ID of the entity referenced. // Required: true ID *int64 `json:"id"` // The name of the entity referenced. // Required: true Name *string `json:"name"` }
HistoryReferenceIteration A reference to an Iteration.
swagger:model HistoryReferenceIteration
func (*HistoryReferenceIteration) ContextValidate ¶
func (m *HistoryReferenceIteration) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this history reference iteration based on context it is used
func (*HistoryReferenceIteration) MarshalBinary ¶
func (m *HistoryReferenceIteration) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*HistoryReferenceIteration) UnmarshalBinary ¶
func (m *HistoryReferenceIteration) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type HistoryReferenceLabel ¶
type HistoryReferenceLabel struct { // The application URL of the Label. // Required: true // Max Length: 2048 // Pattern: ^https?://.+$ AppURL *string `json:"app_url"` // The type of entity referenced. // Required: true EntityType *string `json:"entity_type"` // The ID of the entity referenced. // Required: true ID *int64 `json:"id"` // The name of the entity referenced. // Required: true Name *string `json:"name"` }
HistoryReferenceLabel A reference to an Label.
swagger:model HistoryReferenceLabel
func (*HistoryReferenceLabel) ContextValidate ¶
ContextValidate validates this history reference label based on context it is used
func (*HistoryReferenceLabel) MarshalBinary ¶
func (m *HistoryReferenceLabel) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*HistoryReferenceLabel) UnmarshalBinary ¶
func (m *HistoryReferenceLabel) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type HistoryReferenceProject ¶
type HistoryReferenceProject struct { // The application URL of the Project. // Required: true // Max Length: 2048 // Pattern: ^https?://.+$ AppURL *string `json:"app_url"` // The type of entity referenced. // Required: true EntityType *string `json:"entity_type"` // The ID of the entity referenced. // Required: true ID *int64 `json:"id"` // The name of the entity referenced. // Required: true Name *string `json:"name"` }
HistoryReferenceProject A reference to an Project.
swagger:model HistoryReferenceProject
func (*HistoryReferenceProject) ContextValidate ¶
func (m *HistoryReferenceProject) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this history reference project based on context it is used
func (*HistoryReferenceProject) MarshalBinary ¶
func (m *HistoryReferenceProject) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*HistoryReferenceProject) UnmarshalBinary ¶
func (m *HistoryReferenceProject) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type HistoryReferenceStory ¶
type HistoryReferenceStory struct { // The application URL of the Story. // Required: true // Max Length: 2048 // Pattern: ^https?://.+$ AppURL *string `json:"app_url"` // The type of entity referenced. // Required: true EntityType *string `json:"entity_type"` // The ID of the entity referenced. // Required: true ID *int64 `json:"id"` // The name of the entity referenced. // Required: true Name *string `json:"name"` // If the referenced entity is a Story, either "bug", "chore", or "feature". // Required: true // Enum: [feature chore bug] StoryType *string `json:"story_type"` }
HistoryReferenceStory A reference to a Story.
swagger:model HistoryReferenceStory
func (*HistoryReferenceStory) ContextValidate ¶
ContextValidate validates this history reference story based on context it is used
func (*HistoryReferenceStory) MarshalBinary ¶
func (m *HistoryReferenceStory) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*HistoryReferenceStory) UnmarshalBinary ¶
func (m *HistoryReferenceStory) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type HistoryReferenceStoryTask ¶
type HistoryReferenceStoryTask struct { // The description of the Story Task. // Required: true Description *string `json:"description"` // The type of entity referenced. // Required: true EntityType *string `json:"entity_type"` // The ID of the entity referenced. // Required: true ID *int64 `json:"id"` }
HistoryReferenceStoryTask A reference to a Story Task.
swagger:model HistoryReferenceStoryTask
func (*HistoryReferenceStoryTask) ContextValidate ¶
func (m *HistoryReferenceStoryTask) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this history reference story task based on context it is used
func (*HistoryReferenceStoryTask) MarshalBinary ¶
func (m *HistoryReferenceStoryTask) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*HistoryReferenceStoryTask) UnmarshalBinary ¶
func (m *HistoryReferenceStoryTask) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type HistoryReferenceWorkflowState ¶
type HistoryReferenceWorkflowState struct { // The type of entity referenced. // Required: true EntityType *string `json:"entity_type"` // The ID of the entity referenced. // Required: true ID *int64 `json:"id"` // The name of the entity referenced. // Required: true Name *string `json:"name"` // Either "unstarted", "started", or "done". // Required: true // Enum: [started unstarted done] Type *string `json:"type"` }
HistoryReferenceWorkflowState A references to a Story Workflow State.
swagger:model HistoryReferenceWorkflowState
func (*HistoryReferenceWorkflowState) ContextValidate ¶
func (m *HistoryReferenceWorkflowState) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this history reference workflow state based on context it is used
func (*HistoryReferenceWorkflowState) MarshalBinary ¶
func (m *HistoryReferenceWorkflowState) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*HistoryReferenceWorkflowState) UnmarshalBinary ¶
func (m *HistoryReferenceWorkflowState) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Icon ¶
type Icon struct { // The time/date that the Icon was created. // Required: true // Format: date-time CreatedAt *strfmt.DateTime `json:"created_at"` // A string description of this resource. // Required: true EntityType *string `json:"entity_type"` // The unique ID of the Icon. // Required: true // Format: uuid ID *strfmt.UUID `json:"id"` // The time/date that the Icon was updated. // Required: true // Format: date-time UpdatedAt *strfmt.DateTime `json:"updated_at"` // The URL of the Icon. // Required: true URL *string `json:"url"` }
Icon Icons are used to attach images to Organizations, Members, and Loading screens in the Shortcut web application.
swagger:model Icon
func (*Icon) ContextValidate ¶
ContextValidate validates this icon based on context it is used
func (*Icon) MarshalBinary ¶
MarshalBinary interface implementation
func (*Icon) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Identity ¶
type Identity struct { // A string description of this resource. // Required: true EntityType *string `json:"entity_type"` // This is your login in VCS. // Required: true Name *string `json:"name"` // The type of Identity; currently only type is github. // Required: true Type *string `json:"type"` }
Identity The Identity of the VCS user that authored the Commit.
swagger:model Identity
func (*Identity) ContextValidate ¶
ContextValidate validates this identity based on context it is used
func (*Identity) MarshalBinary ¶
MarshalBinary interface implementation
func (*Identity) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Iteration ¶
type Iteration struct { // The Shortcut application url for the Iteration. // Required: true AppURL *string `json:"app_url"` // The instant when this iteration was created. // Required: true // Format: date-time CreatedAt *strfmt.DateTime `json:"created_at"` // The description of the iteration. // Required: true Description *string `json:"description"` // The date this iteration begins. // Required: true // Format: date-time EndDate *strfmt.DateTime `json:"end_date"` // A string description of this resource // Required: true EntityType *string `json:"entity_type"` // An array of UUIDs for any Members listed as Followers. // Required: true FollowerIds []strfmt.UUID `json:"follower_ids"` // An array of UUIDs for any Groups you want to add as Followers. Currently, only one Group association is presented in our web UI. // Required: true GroupIds []strfmt.UUID `json:"group_ids"` // An array of Group IDs that have been mentioned in the Story description. // Required: true GroupMentionIds []strfmt.UUID `json:"group_mention_ids"` // The ID of the iteration. // Required: true ID *int64 `json:"id"` // An array of label ids attached to the iteration. // Required: true LabelIds []int64 `json:"label_ids"` // An array of labels attached to the iteration. // Required: true Labels []*Label `json:"labels"` // An array of Member IDs that have been mentioned in the Story description. // Required: true MemberMentionIds []strfmt.UUID `json:"member_mention_ids"` // Deprecated: use member_mention_ids. // Required: true MentionIds []strfmt.UUID `json:"mention_ids"` // The name of the iteration. // Required: true Name *string `json:"name"` // The date this iteration begins. // Required: true // Format: date-time StartDate *strfmt.DateTime `json:"start_date"` // stats // Required: true Stats *IterationStats `json:"stats"` // The status of the iteration. Values are either "unstarted", "started", or "done". // Required: true Status *string `json:"status"` // The instant when this iteration was last updated. // Required: true // Format: date-time UpdatedAt *strfmt.DateTime `json:"updated_at"` }
Iteration An Iteration is a defined, time-boxed period of development for a collection of Stories. See https://help.shortcut.com/hc/en-us/articles/360028953452-Iterations-Overview for more information.
swagger:model Iteration
func (*Iteration) ContextValidate ¶
ContextValidate validate this iteration based on the context it is used
func (*Iteration) MarshalBinary ¶
MarshalBinary interface implementation
func (*Iteration) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type IterationSlim ¶
type IterationSlim struct { // The Shortcut application url for the Iteration. // Required: true AppURL *string `json:"app_url"` // The instant when this iteration was created. // Required: true // Format: date-time CreatedAt *strfmt.DateTime `json:"created_at"` // The date this iteration begins. // Required: true // Format: date-time EndDate *strfmt.DateTime `json:"end_date"` // A string description of this resource // Required: true EntityType *string `json:"entity_type"` // An array of UUIDs for any Members listed as Followers. // Required: true FollowerIds []strfmt.UUID `json:"follower_ids"` // An array of UUIDs for any Groups you want to add as Followers. Currently, only one Group association is presented in our web UI. // Required: true GroupIds []strfmt.UUID `json:"group_ids"` // An array of Group IDs that have been mentioned in the Story description. // Required: true GroupMentionIds []strfmt.UUID `json:"group_mention_ids"` // The ID of the iteration. // Required: true ID *int64 `json:"id"` // An array of label ids attached to the iteration. // Required: true LabelIds []int64 `json:"label_ids"` // An array of labels attached to the iteration. // Required: true Labels []*Label `json:"labels"` // An array of Member IDs that have been mentioned in the Story description. // Required: true MemberMentionIds []strfmt.UUID `json:"member_mention_ids"` // Deprecated: use member_mention_ids. // Required: true MentionIds []strfmt.UUID `json:"mention_ids"` // The name of the iteration. // Required: true Name *string `json:"name"` // The date this iteration begins. // Required: true // Format: date-time StartDate *strfmt.DateTime `json:"start_date"` // stats // Required: true Stats *IterationStats `json:"stats"` // The status of the iteration. Values are either "unstarted", "started", or "done". // Required: true Status *string `json:"status"` // The instant when this iteration was last updated. // Required: true // Format: date-time UpdatedAt *strfmt.DateTime `json:"updated_at"` }
IterationSlim IterationSlim represents the same resource as an Iteration, but is more light-weight. Use the [Get Iteration](#Get-Iteration) endpoint to fetch the unabridged payload for an Iteration.
swagger:model IterationSlim
func (*IterationSlim) ContextValidate ¶
ContextValidate validate this iteration slim based on the context it is used
func (*IterationSlim) MarshalBinary ¶
func (m *IterationSlim) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*IterationSlim) UnmarshalBinary ¶
func (m *IterationSlim) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type IterationStats ¶
type IterationStats struct { // The average cycle time (in seconds) of completed stories in this Iteration. AverageCycleTime int64 `json:"average_cycle_time,omitempty"` // The average lead time (in seconds) of completed stories in this Iteration. AverageLeadTime int64 `json:"average_lead_time,omitempty"` // The total number of points in this Iteration. // Required: true NumPoints *int64 `json:"num_points"` // The total number of completed points in this Iteration. // Required: true NumPointsDone *int64 `json:"num_points_done"` // The total number of started points in this Iteration. // Required: true NumPointsStarted *int64 `json:"num_points_started"` // The total number of unstarted points in this Iteration. // Required: true NumPointsUnstarted *int64 `json:"num_points_unstarted"` // The total number of documents related to an Iteration // Required: true NumRelatedDocuments *int64 `json:"num_related_documents"` // The total number of done Stories in this Iteration. // Required: true NumStoriesDone *int64 `json:"num_stories_done"` // The total number of started Stories in this Iteration. // Required: true NumStoriesStarted *int64 `json:"num_stories_started"` // The total number of Stories with no point estimate. // Required: true NumStoriesUnestimated *int64 `json:"num_stories_unestimated"` // The total number of unstarted Stories in this Iteration. // Required: true NumStoriesUnstarted *int64 `json:"num_stories_unstarted"` }
IterationStats A group of calculated values for this Iteration.
swagger:model IterationStats
func (*IterationStats) ContextValidate ¶
ContextValidate validates this iteration stats based on context it is used
func (*IterationStats) MarshalBinary ¶
func (m *IterationStats) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*IterationStats) UnmarshalBinary ¶
func (m *IterationStats) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Label ¶
type Label struct { // The Shortcut application url for the Label. // Required: true AppURL *string `json:"app_url"` // A true/false boolean indicating if the Label has been archived. // Required: true Archived *bool `json:"archived"` // The hex color to be displayed with the Label (for example, "#ff0000"). // Required: true // Min Length: 1 // Pattern: ^#[a-fA-F0-9]{6}$ Color *string `json:"color"` // The time/date that the Label was created. // Required: true // Format: date-time CreatedAt *strfmt.DateTime `json:"created_at"` // The description of the Label. // Required: true Description *string `json:"description"` // A string description of this resource. // Required: true EntityType *string `json:"entity_type"` // This field can be set to another unique ID. In the case that the Label has been imported from another tool, the ID in the other tool can be indicated here. // Required: true ExternalID *string `json:"external_id"` // The unique ID of the Label. // Required: true ID *int64 `json:"id"` // The name of the Label. // Required: true Name *string `json:"name"` // stats Stats *LabelStats `json:"stats,omitempty"` // The time/date that the Label was updated. // Required: true // Format: date-time UpdatedAt *strfmt.DateTime `json:"updated_at"` }
Label A Label can be used to associate and filter Stories and Epics, and also create new Workspaces.
swagger:model Label
func (*Label) ContextValidate ¶
ContextValidate validate this label based on the context it is used
func (*Label) MarshalBinary ¶
MarshalBinary interface implementation
func (*Label) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type LabelSlim ¶
type LabelSlim struct { // The Shortcut application url for the Label. // Required: true AppURL *string `json:"app_url"` // A true/false boolean indicating if the Label has been archived. // Required: true Archived *bool `json:"archived"` // The hex color to be displayed with the Label (for example, "#ff0000"). // Required: true // Min Length: 1 // Pattern: ^#[a-fA-F0-9]{6}$ Color *string `json:"color"` // The time/date that the Label was created. // Required: true // Format: date-time CreatedAt *strfmt.DateTime `json:"created_at"` // The description of the Label. // Required: true Description *string `json:"description"` // A string description of this resource. // Required: true EntityType *string `json:"entity_type"` // This field can be set to another unique ID. In the case that the Label has been imported from another tool, the ID in the other tool can be indicated here. // Required: true ExternalID *string `json:"external_id"` // The unique ID of the Label. // Required: true ID *int64 `json:"id"` // The name of the Label. // Required: true Name *string `json:"name"` // The time/date that the Label was updated. // Required: true // Format: date-time UpdatedAt *strfmt.DateTime `json:"updated_at"` }
LabelSlim A Label can be used to associate and filter Stories and Epics, and also create new Workspaces. A slim Label does not include aggregate stats. Fetch the Label using the labels endpoint to retrieve them.
swagger:model LabelSlim
func (*LabelSlim) ContextValidate ¶
ContextValidate validates this label slim based on context it is used
func (*LabelSlim) MarshalBinary ¶
MarshalBinary interface implementation
func (*LabelSlim) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type LabelStats ¶
type LabelStats struct { // The total number of Epics with this Label. // Required: true NumEpics *int64 `json:"num_epics"` // The number of completed Epics assoicated with this Label. // Required: true NumEpicsCompleted *int64 `json:"num_epics_completed"` // The number of in progress epics assoicated with this label. // Required: true NumEpicsInProgress *int64 `json:"num_epics_in_progress"` // The total number of Epics assoicated with this Label. // Required: true NumEpicsTotal *int64 `json:"num_epics_total"` // The number of unstarted epics assoicated with this label. // Required: true NumEpicsUnstarted *int64 `json:"num_epics_unstarted"` // The total number of completed points with this Label. // Required: true NumPointsCompleted *int64 `json:"num_points_completed"` // The total number of in-progress points with this Label. // Required: true NumPointsInProgress *int64 `json:"num_points_in_progress"` // The total number of points with this Label. // Required: true NumPointsTotal *int64 `json:"num_points_total"` // The total number of unstarted points with this Label. // Required: true NumPointsUnstarted *int64 `json:"num_points_unstarted"` // The total number of Documents associated this Label. // Required: true NumRelatedDocuments *int64 `json:"num_related_documents"` // The total number of completed Stories with this Label. // Required: true NumStoriesCompleted *int64 `json:"num_stories_completed"` // The total number of in-progress Stories with this Label. // Required: true NumStoriesInProgress *int64 `json:"num_stories_in_progress"` // The total number of Stories with this Label. // Required: true NumStoriesTotal *int64 `json:"num_stories_total"` // The total number of Stories with no point estimate with this Label. // Required: true NumStoriesUnestimated *int64 `json:"num_stories_unestimated"` // The total number of stories unstarted Stories with this Label. // Required: true NumStoriesUnstarted *int64 `json:"num_stories_unstarted"` }
LabelStats A group of calculated values for this Label. This is not included if the slim? flag is set to true for the List Labels endpoint.
swagger:model LabelStats
func (*LabelStats) ContextValidate ¶
ContextValidate validates this label stats based on context it is used
func (*LabelStats) MarshalBinary ¶
func (m *LabelStats) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*LabelStats) UnmarshalBinary ¶
func (m *LabelStats) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type LinkedFile ¶
type LinkedFile struct { // The content type of the image (e.g. txt/plain). // Required: true ContentType *string `json:"content_type"` // The time/date the LinkedFile was created. // Required: true // Format: date-time CreatedAt *strfmt.DateTime `json:"created_at"` // The description of the file. // Required: true Description *string `json:"description"` // A string description of this resource. // Required: true EntityType *string `json:"entity_type"` // The groups that are mentioned in the description of the file. // Required: true GroupMentionIds []strfmt.UUID `json:"group_mention_ids"` // The unique identifier for the file. // Required: true ID *int64 `json:"id"` // The members that are mentioned in the description of the file. // Required: true MemberMentionIds []strfmt.UUID `json:"member_mention_ids"` // Deprecated: use member_mention_ids. // Required: true MentionIds []strfmt.UUID `json:"mention_ids"` // The name of the linked file. // Required: true Name *string `json:"name"` // The filesize, if the integration provided it. // Required: true Size *int64 `json:"size"` // The IDs of the stories this file is attached to. // Required: true StoryIds []int64 `json:"story_ids"` // The URL of the file thumbnail, if the integration provided it. // Required: true ThumbnailURL *string `json:"thumbnail_url"` // The integration type (e.g. google, dropbox, box). // Required: true Type *string `json:"type"` // The time/date the LinkedFile was updated. // Required: true // Format: date-time UpdatedAt *strfmt.DateTime `json:"updated_at"` // The UUID of the member that uploaded the file. // Required: true // Format: uuid UploaderID *strfmt.UUID `json:"uploader_id"` // The URL of the file. // Required: true URL *string `json:"url"` }
LinkedFile Linked files are stored on a third-party website and linked to one or more Stories. Shortcut currently supports linking files from Google Drive, Dropbox, Box, and by URL.
swagger:model LinkedFile
func (*LinkedFile) ContextValidate ¶
ContextValidate validates this linked file based on context it is used
func (*LinkedFile) MarshalBinary ¶
func (m *LinkedFile) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*LinkedFile) UnmarshalBinary ¶
func (m *LinkedFile) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ListEpics ¶
type ListEpics struct { // A true/false boolean indicating whether to return Epics with their descriptions. IncludesDescription bool `json:"includes_description,omitempty"` }
ListEpics list epics
swagger:model ListEpics
func (*ListEpics) ContextValidate ¶
ContextValidate validates this list epics based on context it is used
func (*ListEpics) MarshalBinary ¶
MarshalBinary interface implementation
func (*ListEpics) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type ListGroupStories ¶
type ListGroupStories struct { // The maximum number of results to return. (Defaults to 1000, max 1000) Limit int64 `json:"limit,omitempty"` // The offset at which to begin returning results. (Defaults to 0) Offset int64 `json:"offset,omitempty"` }
ListGroupStories list group stories
swagger:model ListGroupStories
func (*ListGroupStories) ContextValidate ¶
ContextValidate validates this list group stories based on context it is used
func (*ListGroupStories) MarshalBinary ¶
func (m *ListGroupStories) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ListGroupStories) UnmarshalBinary ¶
func (m *ListGroupStories) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ListLabels ¶
type ListLabels struct { // A true/false boolean indicating if the slim versions of the Label should be returned. Slim bool `json:"slim,omitempty"` }
ListLabels list labels
swagger:model ListLabels
func (*ListLabels) ContextValidate ¶
ContextValidate validates this list labels based on context it is used
func (*ListLabels) MarshalBinary ¶
func (m *ListLabels) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ListLabels) UnmarshalBinary ¶
func (m *ListLabels) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ListMembers ¶
type ListMembers struct { // The unique ID of the Organization to limit the list to. // Format: uuid OrgPublicID strfmt.UUID `json:"org-public-id,omitempty"` }
ListMembers list members
swagger:model ListMembers
func (*ListMembers) ContextValidate ¶
ContextValidate validates this list members based on context it is used
func (*ListMembers) MarshalBinary ¶
func (m *ListMembers) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ListMembers) UnmarshalBinary ¶
func (m *ListMembers) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type MaxSearchResultsExceededError ¶
type MaxSearchResultsExceededError struct { // The name for this type of error, `maximum-results-exceeded` // Required: true // Enum: [maximum-results-exceeded] Error *string `json:"error"` // The maximum number of search results supported, `1000` // Required: true // Enum: [1000] MaximumResults *int64 `json:"maximum-results"` // An explanatory message: "A maximum of 1000 search results are supported." // Required: true Message *string `json:"message"` }
MaxSearchResultsExceededError Error returned when total maximum supported results have been reached.
swagger:model MaxSearchResultsExceededError
func (*MaxSearchResultsExceededError) ContextValidate ¶
func (m *MaxSearchResultsExceededError) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this max search results exceeded error based on context it is used
func (*MaxSearchResultsExceededError) MarshalBinary ¶
func (m *MaxSearchResultsExceededError) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*MaxSearchResultsExceededError) UnmarshalBinary ¶
func (m *MaxSearchResultsExceededError) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Member ¶
type Member struct { // The time/date the Member was created. // Required: true // Format: date-time CreatedAt *strfmt.DateTime `json:"created_at"` // Whether this member was created as a placeholder entity. // Required: true CreatedWithoutInvite *bool `json:"created_without_invite"` // True/false boolean indicating whether the Member has been disabled within this Organization. // Required: true Disabled *bool `json:"disabled"` // A string description of this resource. // Required: true EntityType *string `json:"entity_type"` // The Member's group ids // Required: true GroupIds []strfmt.UUID `json:"group_ids"` // The Member's ID in Shortcut. // Required: true // Format: uuid ID *strfmt.UUID `json:"id"` // profile // Required: true Profile *Profile `json:"profile"` // The id of the member that replaces this one when merged. // Format: uuid ReplacedBy strfmt.UUID `json:"replaced_by,omitempty"` // The Member's role in the Shortcut organization. // Required: true Role *string `json:"role"` // The user state, one of partial, full, disabled, or imported. A partial // user is disabled, has no means to log in, and is not an import user. A full // user is enabled and has a means to log in. A disabled user is disabled and has // a means to log in. An import user is disabled, has no means to log in, and is // marked as an import user. // Required: true // Enum: [partial full disabled imported] State *string `json:"state"` // The time/date the Member was last updated. // Required: true // Format: date-time UpdatedAt *strfmt.DateTime `json:"updated_at"` }
Member Details about individual Shortcut user within the Shortcut organization that has issued the token.
swagger:model Member
func (*Member) ContextValidate ¶
ContextValidate validate this member based on the context it is used
func (*Member) MarshalBinary ¶
MarshalBinary interface implementation
func (*Member) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type MemberInfo ¶
type MemberInfo struct { // id // Required: true // Format: uuid ID *strfmt.UUID `json:"id"` // mention name // Required: true MentionName *string `json:"mention_name"` // name // Required: true Name *string `json:"name"` // workspace2 // Required: true Workspace2 *BasicWorkspaceInfo `json:"workspace2"` }
MemberInfo member info
swagger:model MemberInfo
func (*MemberInfo) ContextValidate ¶
ContextValidate validate this member info based on the context it is used
func (*MemberInfo) MarshalBinary ¶
func (m *MemberInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*MemberInfo) UnmarshalBinary ¶
func (m *MemberInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Milestone ¶
type Milestone struct { // The Shortcut application url for the Milestone. // Required: true AppURL *string `json:"app_url"` // An array of Categories attached to the Milestone. // Required: true Categories []*Category `json:"categories"` // A true/false boolean indicating if the Milestone has been completed. // Required: true Completed *bool `json:"completed"` // The time/date the Milestone was completed. // Required: true // Format: date-time CompletedAt *strfmt.DateTime `json:"completed_at"` // A manual override for the time/date the Milestone was completed. // Required: true // Format: date-time CompletedAtOverride *strfmt.DateTime `json:"completed_at_override"` // The time/date the Milestone was created. // Required: true // Format: date-time CreatedAt *strfmt.DateTime `json:"created_at"` // The Milestone's description. // Required: true Description *string `json:"description"` // A string description of this resource. // Required: true EntityType *string `json:"entity_type"` // The unique ID of the Milestone. // Required: true ID *int64 `json:"id"` // The name of the Milestone. // Required: true Name *string `json:"name"` // A number representing the position of the Milestone in relation to every other Milestone within the Organization. // Required: true Position *int64 `json:"position"` // A true/false boolean indicating if the Milestone has been started. // Required: true Started *bool `json:"started"` // The time/date the Milestone was started. // Required: true // Format: date-time StartedAt *strfmt.DateTime `json:"started_at"` // A manual override for the time/date the Milestone was started. // Required: true // Format: date-time StartedAtOverride *strfmt.DateTime `json:"started_at_override"` // The workflow state that the Milestone is in. // Required: true State *string `json:"state"` // stats Stats *MilestoneStats `json:"stats,omitempty"` // The time/date the Milestone was updated. // Required: true // Format: date-time UpdatedAt *strfmt.DateTime `json:"updated_at"` }
Milestone A Milestone is a collection of Epics that represent a release or some other large initiative that your organization is working on.
swagger:model Milestone
func (*Milestone) ContextValidate ¶
ContextValidate validate this milestone based on the context it is used
func (*Milestone) MarshalBinary ¶
MarshalBinary interface implementation
func (*Milestone) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type MilestoneStats ¶
type MilestoneStats struct { // The average cycle time (in seconds) of completed stories in this Milestone. AverageCycleTime int64 `json:"average_cycle_time,omitempty"` // The average lead time (in seconds) of completed stories in this Milestone. AverageLeadTime int64 `json:"average_lead_time,omitempty"` // The number of related documents tp this Milestone. // Required: true NumRelatedDocuments *int64 `json:"num_related_documents"` }
MilestoneStats A group of calculated values for this Milestone.
swagger:model MilestoneStats
func (*MilestoneStats) ContextValidate ¶
ContextValidate validates this milestone stats based on context it is used
func (*MilestoneStats) MarshalBinary ¶
func (m *MilestoneStats) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*MilestoneStats) UnmarshalBinary ¶
func (m *MilestoneStats) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Profile ¶
type Profile struct { // A true/false boolean indicating whether the Member has been deactivated within Shortcut. // Required: true Deactivated *bool `json:"deactivated"` // display icon // Required: true DisplayIcon *Icon `json:"display_icon"` // The primary email address of the Member with the Organization. // Required: true EmailAddress *string `json:"email_address"` // A string description of this resource. // Required: true EntityType *string `json:"entity_type"` // This is the gravatar hash associated with email_address. // Required: true GravatarHash *string `json:"gravatar_hash"` // The unique identifier of the profile. // Required: true // Format: uuid ID *strfmt.UUID `json:"id"` // The Member's username within the Organization. // Required: true MentionName *string `json:"mention_name"` // The Member's name within the Organization. // Required: true Name *string `json:"name"` // If Two Factor Authentication is activated for this User. TwoFactorAuthActivated bool `json:"two_factor_auth_activated,omitempty"` }
Profile A group of Member profile details.
swagger:model Profile
func (*Profile) ContextValidate ¶
ContextValidate validate this profile based on the context it is used
func (*Profile) MarshalBinary ¶
MarshalBinary interface implementation
func (*Profile) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Project ¶
type Project struct { // The Project abbreviation used in Story summaries. Should be kept to 3 characters at most. // Required: true Abbreviation *string `json:"abbreviation"` // The Shortcut application url for the Project. // Required: true AppURL *string `json:"app_url"` // True/false boolean indicating whether the Project is in an Archived state. // Required: true Archived *bool `json:"archived"` // The color associated with the Project in the Shortcut member interface. // Required: true // Min Length: 1 // Pattern: ^#[a-fA-F0-9]{6}$ Color *string `json:"color"` // The time/date that the Project was created. // Required: true // Format: date-time CreatedAt *strfmt.DateTime `json:"created_at"` // The number of days before the thermometer appears in the Story summary. // Required: true DaysToThermometer *int64 `json:"days_to_thermometer"` // The description of the Project. // Required: true Description *string `json:"description"` // A string description of this resource. // Required: true EntityType *string `json:"entity_type"` // This field can be set to another unique ID. In the case that the Project has been imported from another tool, the ID in the other tool can be indicated here. // Required: true ExternalID *string `json:"external_id"` // An array of UUIDs for any Members listed as Followers. // Required: true FollowerIds []strfmt.UUID `json:"follower_ids"` // The unique ID of the Project. // Required: true ID *int64 `json:"id"` // The number of weeks per iteration in this Project. // Required: true IterationLength *int64 `json:"iteration_length"` // The name of the Project // Required: true Name *string `json:"name"` // Configuration to enable or disable thermometers in the Story summary. // Required: true ShowThermometer *bool `json:"show_thermometer"` // The date at which the Project was started. // Required: true // Format: date-time StartTime *strfmt.DateTime `json:"start_time"` // stats // Required: true Stats *ProjectStats `json:"stats"` // The ID of the team the project belongs to. // Required: true TeamID *int64 `json:"team_id"` // The time/date that the Project was last updated. // Required: true // Format: date-time UpdatedAt *strfmt.DateTime `json:"updated_at"` // The ID of the workflow the project belongs to. // Required: true WorkflowID *int64 `json:"workflow_id"` }
Project Projects typically map to teams (such as Frontend, Backend, Mobile, Devops, etc) but can represent any open-ended product, component, or initiative.
swagger:model Project
func (*Project) ContextValidate ¶
ContextValidate validate this project based on the context it is used
func (*Project) MarshalBinary ¶
MarshalBinary interface implementation
func (*Project) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type ProjectStats ¶
type ProjectStats struct { // The total number of points in this Project. // Required: true NumPoints *int64 `json:"num_points"` // The total number of documents related to this Project // Required: true NumRelatedDocuments *int64 `json:"num_related_documents"` // The total number of stories in this Project. // Required: true NumStories *int64 `json:"num_stories"` }
ProjectStats A group of calculated values for this Project.
swagger:model ProjectStats
func (*ProjectStats) ContextValidate ¶
ContextValidate validates this project stats based on context it is used
func (*ProjectStats) MarshalBinary ¶
func (m *ProjectStats) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ProjectStats) UnmarshalBinary ¶
func (m *ProjectStats) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PullRequest ¶
type PullRequest struct { // The ID of the branch for the particular pull request. // Required: true BranchID *int64 `json:"branch_id"` // The name of the branch for the particular pull request. // Required: true BranchName *string `json:"branch_name"` // The status of the Continuous Integration workflow for the pull request. BuildStatus string `json:"build_status,omitempty"` // True/False boolean indicating whether the VCS pull request has been closed. // Required: true Closed *bool `json:"closed"` // The time/date the pull request was created. // Required: true // Format: date-time CreatedAt *strfmt.DateTime `json:"created_at"` // True/False boolean indicating whether the VCS pull request is in the draft state. // Required: true Draft *bool `json:"draft"` // A string description of this resource. // Required: true EntityType *string `json:"entity_type"` // The unique ID associated with the pull request in Shortcut. // Required: true ID *int64 `json:"id"` // True/False boolean indicating whether the VCS pull request has been merged. // Required: true Merged *bool `json:"merged"` // Number of lines added in the pull request, according to VCS. // Required: true NumAdded *int64 `json:"num_added"` // The number of commits on the pull request. // Required: true NumCommits *int64 `json:"num_commits"` // Number of lines modified in the pull request, according to VCS. // Required: true NumModified *int64 `json:"num_modified"` // Number of lines removed in the pull request, according to VCS. // Required: true NumRemoved *int64 `json:"num_removed"` // The pull request's unique number ID in VCS. // Required: true Number *int64 `json:"number"` // The ID of the repository for the particular pull request. // Required: true RepositoryID *int64 `json:"repository_id"` // The status of the review for the pull request. ReviewStatus string `json:"review_status,omitempty"` // The ID of the target branch for the particular pull request. // Required: true TargetBranchID *int64 `json:"target_branch_id"` // The name of the target branch for the particular pull request. // Required: true TargetBranchName *string `json:"target_branch_name"` // The title of the pull request. // Required: true Title *string `json:"title"` // The time/date the pull request was created. // Required: true // Format: date-time UpdatedAt *strfmt.DateTime `json:"updated_at"` // The URL for the pull request. // Required: true URL *string `json:"url"` // An array of PullRequestLabels attached to the PullRequest. VcsLabels []*PullRequestLabel `json:"vcs_labels"` }
PullRequest Corresponds to a VCS Pull Request attached to a Shortcut story.
swagger:model PullRequest
func (*PullRequest) ContextValidate ¶
ContextValidate validate this pull request based on the context it is used
func (*PullRequest) MarshalBinary ¶
func (m *PullRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PullRequest) UnmarshalBinary ¶
func (m *PullRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PullRequestLabel ¶
type PullRequestLabel struct { // The color of the VCS label. // Required: true // Min Length: 1 // Pattern: ^#[a-fA-F0-9]{6}$ Color *string `json:"color"` // The description of the VCS label. Description *string `json:"description,omitempty"` // A string description of this resource. // Required: true EntityType *string `json:"entity_type"` // The unique ID of the VCS Label. // Required: true ID *int64 `json:"id"` // The name of the VCS label. // Required: true Name *string `json:"name"` }
PullRequestLabel Corresponds to a VCS Label associated with a Pull Request.
swagger:model PullRequestLabel
func (*PullRequestLabel) ContextValidate ¶
ContextValidate validates this pull request label based on context it is used
func (*PullRequestLabel) MarshalBinary ¶
func (m *PullRequestLabel) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PullRequestLabel) UnmarshalBinary ¶
func (m *PullRequestLabel) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Repository ¶
type Repository struct { // The time/date the Repository was created. // Required: true // Format: date-time CreatedAt *strfmt.DateTime `json:"created_at"` // A string description of this resource. // Required: true EntityType *string `json:"entity_type"` // The VCS unique identifier for the Repository. // Required: true ExternalID *string `json:"external_id"` // The full name of the VCS repository. // Required: true FullName *string `json:"full_name"` // The ID associated to the VCS repository in Shortcut. // Required: true ID *int64 `json:"id"` // The shorthand name of the VCS repository. // Required: true Name *string `json:"name"` // The type of Repository. Currently this can only be "github". // Required: true Type *string `json:"type"` // The time/date the Repository was updated. // Required: true // Format: date-time UpdatedAt *strfmt.DateTime `json:"updated_at"` // The URL of the Repository. // Required: true URL *string `json:"url"` }
Repository Repository refers to a VCS repository.
swagger:model Repository
func (*Repository) ContextValidate ¶
ContextValidate validates this repository based on context it is used
func (*Repository) MarshalBinary ¶
func (m *Repository) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*Repository) UnmarshalBinary ¶
func (m *Repository) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Search ¶
type Search struct { // include // Enum: [cursors] Include string `json:"include,omitempty"` // The next page token. Next string `json:"next,omitempty"` // The number of search results to include in a page. Minimum of 1 and maximum of 25. PageSize int64 `json:"page_size,omitempty"` // See our help center article on [search operators](https://help.shortcut.com/hc/en-us/articles/360000046646-Search-Operators) // Required: true // Min Length: 1 Query *string `json:"query"` }
Search search
swagger:model Search
func (*Search) ContextValidate ¶
ContextValidate validates this search based on context it is used
func (*Search) MarshalBinary ¶
MarshalBinary interface implementation
func (*Search) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type SearchResults ¶
type SearchResults struct { // epics // Required: true Epics *EpicSearchResults `json:"epics"` // stories // Required: true Stories *StorySearchResults `json:"stories"` }
SearchResults The results of the multi-entity search query.
swagger:model SearchResults
func (*SearchResults) ContextValidate ¶
ContextValidate validate this search results based on the context it is used
func (*SearchResults) MarshalBinary ¶
func (m *SearchResults) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SearchResults) UnmarshalBinary ¶
func (m *SearchResults) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SearchStories ¶
type SearchStories struct { // A true/false boolean indicating whether the Story is in archived state. Archived bool `json:"archived,omitempty"` // Stories should have been completed before this date. // Format: date-time CompletedAtEnd strfmt.DateTime `json:"completed_at_end,omitempty"` // Stories should have been competed after this date. // Format: date-time CompletedAtStart strfmt.DateTime `json:"completed_at_start,omitempty"` // Stories should have been created before this date. // Format: date-time CreatedAtEnd strfmt.DateTime `json:"created_at_end,omitempty"` // Stories should have been created after this date. // Format: date-time CreatedAtStart strfmt.DateTime `json:"created_at_start,omitempty"` // Stories should have a deadline before this date. // Format: date-time DeadlineEnd strfmt.DateTime `json:"deadline_end,omitempty"` // Stories should have a deadline after this date. // Format: date-time DeadlineStart strfmt.DateTime `json:"deadline_start,omitempty"` // The Epic IDs that may be associated with the Stories. EpicID *int64 `json:"epic_id,omitempty"` // The Epic IDs that may be associated with the Stories. // Unique: true EpicIds []int64 `json:"epic_ids"` // The number of estimate points associate with the Stories. Estimate int64 `json:"estimate,omitempty"` // An ID or URL that references an external resource. Useful during imports. ExternalID string `json:"external_id,omitempty"` // The Group ID that is associated with the Stories // Format: uuid GroupID *strfmt.UUID `json:"group_id,omitempty"` // The Group IDs that are associated with the Stories // Unique: true GroupIds []strfmt.UUID `json:"group_ids"` // Whether to include the story description in the response. IncludesDescription bool `json:"includes_description,omitempty"` // The Iteration ID that may be associated with the Stories. IterationID *int64 `json:"iteration_id,omitempty"` // The Iteration IDs that may be associated with the Stories. // Unique: true IterationIds []int64 `json:"iteration_ids"` // The Label IDs that may be associated with the Stories. // Unique: true LabelIds []int64 `json:"label_ids"` // The name of any associated Labels. // Min Length: 1 LabelName string `json:"label_name,omitempty"` // An array of UUIDs for any Users who may be Owners of the Stories. // Format: uuid OwnerID *strfmt.UUID `json:"owner_id,omitempty"` // An array of UUIDs for any Users who may be Owners of the Stories. // Unique: true OwnerIds []strfmt.UUID `json:"owner_ids"` // The IDs for the Projects the Stories may be assigned to. ProjectID int64 `json:"project_id,omitempty"` // The IDs for the Projects the Stories may be assigned to. // Unique: true ProjectIds []int64 `json:"project_ids"` // The UUID of any Users who may have requested the Stories. // Format: uuid RequestedByID strfmt.UUID `json:"requested_by_id,omitempty"` // The type of Stories that you want returned. // Enum: [feature chore bug] StoryType string `json:"story_type,omitempty"` // Stories should have been updated before this date. // Format: date-time UpdatedAtEnd strfmt.DateTime `json:"updated_at_end,omitempty"` // Stories should have been updated after this date. // Format: date-time UpdatedAtStart strfmt.DateTime `json:"updated_at_start,omitempty"` // The unique IDs of the specific Workflow States that the Stories should be in. WorkflowStateID int64 `json:"workflow_state_id,omitempty"` // The type of Workflow State the Stories may be in. WorkflowStateTypes []string `json:"workflow_state_types"` }
SearchStories search stories
swagger:model SearchStories
func (*SearchStories) ContextValidate ¶
ContextValidate validates this search stories based on context it is used
func (*SearchStories) MarshalBinary ¶
func (m *SearchStories) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SearchStories) UnmarshalBinary ¶
func (m *SearchStories) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Story ¶
type Story struct { // The Shortcut application url for the Story. // Required: true AppURL *string `json:"app_url"` // True if the story has been archived or not. // Required: true Archived *bool `json:"archived"` // A true/false boolean indicating if the Story is currently blocked. // Required: true Blocked *bool `json:"blocked"` // A true/false boolean indicating if the Story is currently a blocker of another story. // Required: true Blocker *bool `json:"blocker"` // An array of Git branches attached to the story. // Required: true Branches []*Branch `json:"branches"` // An array of comments attached to the story. // Required: true Comments []*StoryComment `json:"comments"` // An array of commits attached to the story. // Required: true Commits []*Commit `json:"commits"` // A true/false boolean indicating if the Story has been completed. // Required: true Completed *bool `json:"completed"` // The time/date the Story was completed. // Required: true // Format: date-time CompletedAt *strfmt.DateTime `json:"completed_at"` // A manual override for the time/date the Story was completed. // Required: true // Format: date-time CompletedAtOverride *strfmt.DateTime `json:"completed_at_override"` // The time/date the Story was created. // Required: true // Format: date-time CreatedAt *strfmt.DateTime `json:"created_at"` // The cycle time (in seconds) of this story when complete. CycleTime int64 `json:"cycle_time,omitempty"` // The due date of the story. // Required: true // Format: date-time Deadline *strfmt.DateTime `json:"deadline"` // The description of the story. // Required: true Description *string `json:"description"` // A string description of this resource. // Required: true EntityType *string `json:"entity_type"` // The ID of the epic the story belongs to. // Required: true EpicID *int64 `json:"epic_id"` // The numeric point estimate of the story. Can also be null, which means unestimated. // Required: true Estimate *int64 `json:"estimate"` // This field can be set to another unique ID. In the case that the Story has been imported from another tool, the ID in the other tool can be indicated here. // Required: true ExternalID *string `json:"external_id"` // An array of external links (strings) associated with a Story // Required: true ExternalLinks []string `json:"external_links"` // An array of files attached to the story. // Required: true Files []*UploadedFile `json:"files"` // An array of UUIDs for any Members listed as Followers. // Required: true FollowerIds []strfmt.UUID `json:"follower_ids"` // The ID of the group associated with the story. // Required: true // Format: uuid GroupID *strfmt.UUID `json:"group_id"` // An array of Group IDs that have been mentioned in the Story description. // Required: true GroupMentionIds []strfmt.UUID `json:"group_mention_ids"` // The unique ID of the Story. // Required: true ID *int64 `json:"id"` // The ID of the iteration the story belongs to. // Required: true IterationID *int64 `json:"iteration_id"` // An array of label ids attached to the story. // Required: true LabelIds []int64 `json:"label_ids"` // An array of labels attached to the story. // Required: true Labels []*LabelSlim `json:"labels"` // The lead time (in seconds) of this story when complete. LeadTime int64 `json:"lead_time,omitempty"` // An array of linked files attached to the story. // Required: true LinkedFiles []*LinkedFile `json:"linked_files"` // An array of Member IDs that have been mentioned in the Story description. // Required: true MemberMentionIds []strfmt.UUID `json:"member_mention_ids"` // Deprecated: use member_mention_ids. // Required: true MentionIds []strfmt.UUID `json:"mention_ids"` // The time/date the Story was last changed workflow-state. // Required: true // Format: date-time MovedAt *strfmt.DateTime `json:"moved_at"` // The name of the story. // Required: true Name *string `json:"name"` // An array of UUIDs of the owners of this story. // Required: true OwnerIds []strfmt.UUID `json:"owner_ids"` // A number representing the position of the story in relation to every other story in the current project. // Required: true Position *int64 `json:"position"` // The IDs of the iteration the story belongs to. // Required: true PreviousIterationIds []int64 `json:"previous_iteration_ids"` // The ID of the project the story belongs to. // Required: true ProjectID *int64 `json:"project_id"` // An array of Pull/Merge Requests attached to the story. // Required: true PullRequests []*PullRequest `json:"pull_requests"` // The ID of the Member that requested the story. // Required: true // Format: uuid RequestedByID *strfmt.UUID `json:"requested_by_id"` // A true/false boolean indicating if the Story has been started. // Required: true Started *bool `json:"started"` // The time/date the Story was started. // Required: true // Format: date-time StartedAt *strfmt.DateTime `json:"started_at"` // A manual override for the time/date the Story was started. // Required: true // Format: date-time StartedAtOverride *strfmt.DateTime `json:"started_at_override"` // stats // Required: true Stats *StoryStats `json:"stats"` // An array of story links attached to the Story. // Required: true StoryLinks []*TypedStoryLink `json:"story_links"` // The ID of the story template used to create this story, or null if not created using a template. // Required: true // Format: uuid StoryTemplateID *strfmt.UUID `json:"story_template_id"` // The type of story (feature, bug, chore). // Required: true StoryType *string `json:"story_type"` // An array of tasks connected to the story. // Required: true Tasks []*Task `json:"tasks"` // The time/date the Story was updated. // Required: true // Format: date-time UpdatedAt *strfmt.DateTime `json:"updated_at"` // The ID of the workflow the story belongs to. // Required: true WorkflowID *int64 `json:"workflow_id"` // The ID of the workflow state the story is currently in. // Required: true WorkflowStateID *int64 `json:"workflow_state_id"` }
Story Stories are the standard unit of work in Shortcut and represent individual features, bugs, and chores.
swagger:model Story
func (*Story) ContextValidate ¶
ContextValidate validate this story based on the context it is used
func (*Story) MarshalBinary ¶
MarshalBinary interface implementation
func (*Story) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type StoryComment ¶
type StoryComment struct { // The Shortcut application url for the Comment. // Required: true AppURL *string `json:"app_url"` // The unique ID of the Member who is the Comment's author. // Required: true // Format: uuid AuthorID *strfmt.UUID `json:"author_id"` // The time/date when the Comment was created. // Required: true // Format: date-time CreatedAt *strfmt.DateTime `json:"created_at"` // A string description of this resource. // Required: true EntityType *string `json:"entity_type"` // This field can be set to another unique ID. In the case that the Comment has been imported from another tool, the ID in the other tool can be indicated here. // Required: true ExternalID *string `json:"external_id"` // The unique IDs of the Group who are mentioned in the Comment. // Required: true GroupMentionIds []strfmt.UUID `json:"group_mention_ids"` // The unique ID of the Comment. // Required: true ID *int64 `json:"id"` // The unique IDs of the Member who are mentioned in the Comment. // Required: true MemberMentionIds []strfmt.UUID `json:"member_mention_ids"` // Deprecated: use member_mention_ids. // Required: true MentionIds []strfmt.UUID `json:"mention_ids"` // The ID of the parent Comment this Comment is threaded under. ParentID *int64 `json:"parent_id,omitempty"` // The Comments numerical position in the list from oldest to newest. // Required: true Position *int64 `json:"position"` // A set of Reactions to this Comment. // Required: true Reactions []*StoryReaction `json:"reactions"` // The ID of the Story on which the Comment appears. // Required: true StoryID *int64 `json:"story_id"` // The text of the Comment. // Required: true Text *string `json:"text"` // The time/date when the Comment was updated. // Required: true // Format: date-time UpdatedAt *strfmt.DateTime `json:"updated_at"` }
StoryComment A Comment is any note added within the Comment field of a Story.
swagger:model StoryComment
func (*StoryComment) ContextValidate ¶
ContextValidate validate this story comment based on the context it is used
func (*StoryComment) MarshalBinary ¶
func (m *StoryComment) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*StoryComment) UnmarshalBinary ¶
func (m *StoryComment) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type StoryContents ¶
type StoryContents struct { // The due date of the story. // Format: date-time Deadline strfmt.DateTime `json:"deadline,omitempty"` // The description of the story. Description string `json:"description,omitempty"` // A string description of this resource. EntityType string `json:"entity_type,omitempty"` // The ID of the epic the story belongs to. EpicID int64 `json:"epic_id,omitempty"` // The numeric point estimate of the story. Can also be null, which means unestimated. Estimate int64 `json:"estimate,omitempty"` // An array of external links connected to the story. ExternalLinks []string `json:"external_links"` // An array of files attached to the story. Files []*UploadedFile `json:"files"` // An array of UUIDs for any Members listed as Followers. FollowerIds []strfmt.UUID `json:"follower_ids"` // The ID of the group to which the story is assigned. // Format: uuid GroupID strfmt.UUID `json:"group_id,omitempty"` // The ID of the iteration the story belongs to. IterationID int64 `json:"iteration_id,omitempty"` // An array of label ids attached to the story. LabelIds []int64 `json:"label_ids"` // An array of labels attached to the story. Labels []*LabelSlim `json:"labels"` // An array of linked files attached to the story. LinkedFiles []*LinkedFile `json:"linked_files"` // The name of the story. Name string `json:"name,omitempty"` // An array of UUIDs of the owners of this story. OwnerIds []strfmt.UUID `json:"owner_ids"` // The ID of the project the story belongs to. ProjectID int64 `json:"project_id,omitempty"` // The type of story (feature, bug, chore). StoryType string `json:"story_type,omitempty"` // An array of tasks connected to the story. Tasks []*StoryContentsTask `json:"tasks"` // The ID of the workflow state the story is currently in. WorkflowStateID int64 `json:"workflow_state_id,omitempty"` }
StoryContents A container entity for the attributes this template should populate.
swagger:model StoryContents
func (*StoryContents) ContextValidate ¶
ContextValidate validate this story contents based on the context it is used
func (*StoryContents) MarshalBinary ¶
func (m *StoryContents) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*StoryContents) UnmarshalBinary ¶
func (m *StoryContents) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type StoryContentsTask ¶
type StoryContentsTask struct { // True/false boolean indicating whether the Task has been completed. Complete bool `json:"complete,omitempty"` // Full text of the Task. // Required: true Description *string `json:"description"` // This field can be set to another unique ID. In the case that the Task has been imported from another tool, the ID in the other tool can be indicated here. ExternalID *string `json:"external_id,omitempty"` // An array of UUIDs of the Owners of this Task. OwnerIds []strfmt.UUID `json:"owner_ids"` // The number corresponding to the Task's position within a list of Tasks on a Story. Position int64 `json:"position,omitempty"` }
StoryContentsTask story contents task
swagger:model StoryContentsTask
func (*StoryContentsTask) ContextValidate ¶
ContextValidate validates this story contents task based on context it is used
func (*StoryContentsTask) MarshalBinary ¶
func (m *StoryContentsTask) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*StoryContentsTask) UnmarshalBinary ¶
func (m *StoryContentsTask) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type StoryHistoryChangeAddsRemovesInt ¶
type StoryHistoryChangeAddsRemovesInt struct { // The values that have been added. Adds []int64 `json:"adds"` // The values that have been removed Removes []int64 `json:"removes"` }
StoryHistoryChangeAddsRemovesInt Task IDs that have been added or removed from the Story.
swagger:model StoryHistoryChangeAddsRemovesInt
func (*StoryHistoryChangeAddsRemovesInt) ContextValidate ¶
func (m *StoryHistoryChangeAddsRemovesInt) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this story history change adds removes int based on context it is used
func (*StoryHistoryChangeAddsRemovesInt) MarshalBinary ¶
func (m *StoryHistoryChangeAddsRemovesInt) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*StoryHistoryChangeAddsRemovesInt) UnmarshalBinary ¶
func (m *StoryHistoryChangeAddsRemovesInt) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type StoryHistoryChangeAddsRemovesUUID ¶
type StoryHistoryChangeAddsRemovesUUID struct { // The values that have been added. Adds []strfmt.UUID `json:"adds"` // The values that have been removed Removes []strfmt.UUID `json:"removes"` }
StoryHistoryChangeAddsRemovesUUID Member IDs that have been added or removed as a owner of the Story.
swagger:model StoryHistoryChangeAddsRemovesUuid
func (*StoryHistoryChangeAddsRemovesUUID) ContextValidate ¶
func (m *StoryHistoryChangeAddsRemovesUUID) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this story history change adds removes Uuid based on context it is used
func (*StoryHistoryChangeAddsRemovesUUID) MarshalBinary ¶
func (m *StoryHistoryChangeAddsRemovesUUID) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*StoryHistoryChangeAddsRemovesUUID) UnmarshalBinary ¶
func (m *StoryHistoryChangeAddsRemovesUUID) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type StoryHistoryChangeOldNewBool ¶
type StoryHistoryChangeOldNewBool struct { // The new value. New bool `json:"new,omitempty"` // The old value. Old bool `json:"old,omitempty"` }
StoryHistoryChangeOldNewBool True if the Story has archived, otherwise false.
swagger:model StoryHistoryChangeOldNewBool
func (*StoryHistoryChangeOldNewBool) ContextValidate ¶
func (m *StoryHistoryChangeOldNewBool) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this story history change old new bool based on context it is used
func (*StoryHistoryChangeOldNewBool) MarshalBinary ¶
func (m *StoryHistoryChangeOldNewBool) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*StoryHistoryChangeOldNewBool) UnmarshalBinary ¶
func (m *StoryHistoryChangeOldNewBool) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type StoryHistoryChangeOldNewInt ¶
type StoryHistoryChangeOldNewInt struct { // The new value. New int64 `json:"new,omitempty"` // The old value. Old int64 `json:"old,omitempty"` }
StoryHistoryChangeOldNewInt The estimate value for the Story
swagger:model StoryHistoryChangeOldNewInt
func (*StoryHistoryChangeOldNewInt) ContextValidate ¶
func (m *StoryHistoryChangeOldNewInt) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this story history change old new int based on context it is used
func (*StoryHistoryChangeOldNewInt) MarshalBinary ¶
func (m *StoryHistoryChangeOldNewInt) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*StoryHistoryChangeOldNewInt) UnmarshalBinary ¶
func (m *StoryHistoryChangeOldNewInt) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type StoryHistoryChangeOldNewStr ¶
type StoryHistoryChangeOldNewStr struct { // The new value. New string `json:"new,omitempty"` // The old value. Old string `json:"old,omitempty"` }
StoryHistoryChangeOldNewStr A timestamp that represents the Story's deadline.
swagger:model StoryHistoryChangeOldNewStr
func (*StoryHistoryChangeOldNewStr) ContextValidate ¶
func (m *StoryHistoryChangeOldNewStr) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this story history change old new str based on context it is used
func (*StoryHistoryChangeOldNewStr) MarshalBinary ¶
func (m *StoryHistoryChangeOldNewStr) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*StoryHistoryChangeOldNewStr) UnmarshalBinary ¶
func (m *StoryHistoryChangeOldNewStr) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type StoryHistoryChangeOldNewUUID ¶
type StoryHistoryChangeOldNewUUID struct { // The new value. // Format: uuid New strfmt.UUID `json:"new,omitempty"` // The old value. // Format: uuid Old strfmt.UUID `json:"old,omitempty"` }
StoryHistoryChangeOldNewUUID The Member ID of the preson who requested the Story.
swagger:model StoryHistoryChangeOldNewUuid
func (*StoryHistoryChangeOldNewUUID) ContextValidate ¶
func (m *StoryHistoryChangeOldNewUUID) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this story history change old new Uuid based on context it is used
func (*StoryHistoryChangeOldNewUUID) MarshalBinary ¶
func (m *StoryHistoryChangeOldNewUUID) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*StoryHistoryChangeOldNewUUID) UnmarshalBinary ¶
func (m *StoryHistoryChangeOldNewUUID) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type StoryLink ¶
type StoryLink struct { // The time/date when the Story Link was created. // Required: true // Format: date-time CreatedAt *strfmt.DateTime `json:"created_at"` // A string description of this resource. // Required: true EntityType *string `json:"entity_type"` // The unique identifier of the Story Link. // Required: true ID *int64 `json:"id"` // The ID of the object Story. // Required: true ObjectID *int64 `json:"object_id"` // The ID of the subject Story. // Required: true SubjectID *int64 `json:"subject_id"` // The workflow state of the "subject" story. // Required: true SubjectWorkflowStateID *int64 `json:"subject_workflow_state_id"` // The time/date when the Story Link was last updated. // Required: true // Format: date-time UpdatedAt *strfmt.DateTime `json:"updated_at"` // How the subject Story acts on the object Story. This can be "blocks", "duplicates", or "relates to". // Required: true Verb *string `json:"verb"` }
StoryLink Story links allow you create semantic relationships between two stories. Relationship types are relates to, blocks / blocked by, and duplicates / is duplicated by. The format is `subject -> link -> object`, or for example "story 5 blocks story 6".
swagger:model StoryLink
func (*StoryLink) ContextValidate ¶
ContextValidate validates this story link based on context it is used
func (*StoryLink) MarshalBinary ¶
MarshalBinary interface implementation
func (*StoryLink) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type StoryReaction ¶
type StoryReaction struct { // Emoji text of the reaction. // Required: true Emoji *string `json:"emoji"` // Permissions who have reacted with this. // Required: true PermissionIds []strfmt.UUID `json:"permission_ids"` }
StoryReaction Emoji reaction on a comment.
swagger:model StoryReaction
func (*StoryReaction) ContextValidate ¶
ContextValidate validates this story reaction based on context it is used
func (*StoryReaction) MarshalBinary ¶
func (m *StoryReaction) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*StoryReaction) UnmarshalBinary ¶
func (m *StoryReaction) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type StorySearchResults ¶
type StorySearchResults struct { // cursors Cursors []string `json:"cursors"` // A list of search results. // Required: true Data []*Story `json:"data"` // The URL path and query string for the next page of search results. // Required: true Next *string `json:"next"` // The total number of matches for the search query. The first 1000 matches can be paged through via the API. // Required: true Total *int64 `json:"total"` }
StorySearchResults The results of the Story search query.
swagger:model StorySearchResults
func (*StorySearchResults) ContextValidate ¶
ContextValidate validate this story search results based on the context it is used
func (*StorySearchResults) MarshalBinary ¶
func (m *StorySearchResults) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*StorySearchResults) UnmarshalBinary ¶
func (m *StorySearchResults) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type StorySlim ¶
type StorySlim struct { // The Shortcut application url for the Story. // Required: true AppURL *string `json:"app_url"` // True if the story has been archived or not. // Required: true Archived *bool `json:"archived"` // A true/false boolean indicating if the Story is currently blocked. // Required: true Blocked *bool `json:"blocked"` // A true/false boolean indicating if the Story is currently a blocker of another story. // Required: true Blocker *bool `json:"blocker"` // An array of IDs of Comments attached to the story. // Required: true CommentIds []int64 `json:"comment_ids"` // A true/false boolean indicating if the Story has been completed. // Required: true Completed *bool `json:"completed"` // The time/date the Story was completed. // Required: true // Format: date-time CompletedAt *strfmt.DateTime `json:"completed_at"` // A manual override for the time/date the Story was completed. // Required: true // Format: date-time CompletedAtOverride *strfmt.DateTime `json:"completed_at_override"` // The time/date the Story was created. // Required: true // Format: date-time CreatedAt *strfmt.DateTime `json:"created_at"` // The cycle time (in seconds) of this story when complete. CycleTime int64 `json:"cycle_time,omitempty"` // The due date of the story. // Required: true // Format: date-time Deadline *strfmt.DateTime `json:"deadline"` // The description of the Story. Description string `json:"description,omitempty"` // A string description of this resource. // Required: true EntityType *string `json:"entity_type"` // The ID of the epic the story belongs to. // Required: true EpicID *int64 `json:"epic_id"` // The numeric point estimate of the story. Can also be null, which means unestimated. // Required: true Estimate *int64 `json:"estimate"` // This field can be set to another unique ID. In the case that the Story has been imported from another tool, the ID in the other tool can be indicated here. // Required: true ExternalID *string `json:"external_id"` // An array of external links (strings) associated with a Story // Required: true ExternalLinks []string `json:"external_links"` // An array of IDs of Files attached to the story. // Required: true FileIds []int64 `json:"file_ids"` // An array of UUIDs for any Members listed as Followers. // Required: true FollowerIds []strfmt.UUID `json:"follower_ids"` // The ID of the group associated with the story. // Required: true // Format: uuid GroupID *strfmt.UUID `json:"group_id"` // An array of Group IDs that have been mentioned in the Story description. // Required: true GroupMentionIds []strfmt.UUID `json:"group_mention_ids"` // The unique ID of the Story. // Required: true ID *int64 `json:"id"` // The ID of the iteration the story belongs to. // Required: true IterationID *int64 `json:"iteration_id"` // An array of label ids attached to the story. // Required: true LabelIds []int64 `json:"label_ids"` // An array of labels attached to the story. // Required: true Labels []*LabelSlim `json:"labels"` // The lead time (in seconds) of this story when complete. LeadTime int64 `json:"lead_time,omitempty"` // An array of IDs of LinkedFiles attached to the story. // Required: true LinkedFileIds []int64 `json:"linked_file_ids"` // An array of Member IDs that have been mentioned in the Story description. // Required: true MemberMentionIds []strfmt.UUID `json:"member_mention_ids"` // Deprecated: use member_mention_ids. // Required: true MentionIds []strfmt.UUID `json:"mention_ids"` // The time/date the Story was last changed workflow-state. // Required: true // Format: date-time MovedAt *strfmt.DateTime `json:"moved_at"` // The name of the story. // Required: true Name *string `json:"name"` // The number of tasks on the story which are complete. // Required: true NumTasksCompleted *int64 `json:"num_tasks_completed"` // An array of UUIDs of the owners of this story. // Required: true OwnerIds []strfmt.UUID `json:"owner_ids"` // A number representing the position of the story in relation to every other story in the current project. // Required: true Position *int64 `json:"position"` // The IDs of the iteration the story belongs to. // Required: true PreviousIterationIds []int64 `json:"previous_iteration_ids"` // The ID of the project the story belongs to. // Required: true ProjectID *int64 `json:"project_id"` // The ID of the Member that requested the story. // Required: true // Format: uuid RequestedByID *strfmt.UUID `json:"requested_by_id"` // A true/false boolean indicating if the Story has been started. // Required: true Started *bool `json:"started"` // The time/date the Story was started. // Required: true // Format: date-time StartedAt *strfmt.DateTime `json:"started_at"` // A manual override for the time/date the Story was started. // Required: true // Format: date-time StartedAtOverride *strfmt.DateTime `json:"started_at_override"` // stats // Required: true Stats *StoryStats `json:"stats"` // An array of story links attached to the Story. // Required: true StoryLinks []*TypedStoryLink `json:"story_links"` // The ID of the story template used to create this story, or null if not created using a template. // Required: true // Format: uuid StoryTemplateID *strfmt.UUID `json:"story_template_id"` // The type of story (feature, bug, chore). // Required: true StoryType *string `json:"story_type"` // An array of IDs of Tasks attached to the story. // Required: true TaskIds []int64 `json:"task_ids"` // The time/date the Story was updated. // Required: true // Format: date-time UpdatedAt *strfmt.DateTime `json:"updated_at"` // The ID of the workflow the story belongs to. // Required: true WorkflowID *int64 `json:"workflow_id"` // The ID of the workflow state the story is currently in. // Required: true WorkflowStateID *int64 `json:"workflow_state_id"` }
StorySlim StorySlim represents the same resource as a Story, but is more light-weight. For certain fields it provides ids rather than full resources (e.g., `comment_ids` and `file_ids`) and it also excludes certain aggregate values (e.g., `cycle_time`). The `description` field can be optionally included. Use the [Get Story](#Get-Story) endpoint to fetch the unabridged payload for a Story.
swagger:model StorySlim
func (*StorySlim) ContextValidate ¶
ContextValidate validate this story slim based on the context it is used
func (*StorySlim) MarshalBinary ¶
MarshalBinary interface implementation
func (*StorySlim) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type StoryStats ¶
type StoryStats struct { // The number of documents related to this Story. // Required: true NumRelatedDocuments *int64 `json:"num_related_documents"` }
StoryStats The stats object for Stories
swagger:model StoryStats
func (*StoryStats) ContextValidate ¶
ContextValidate validates this story stats based on context it is used
func (*StoryStats) MarshalBinary ¶
func (m *StoryStats) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*StoryStats) UnmarshalBinary ¶
func (m *StoryStats) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Task ¶
type Task struct { // True/false boolean indicating whether the Task has been completed. // Required: true Complete *bool `json:"complete"` // The time/date the Task was completed. // Required: true // Format: date-time CompletedAt *strfmt.DateTime `json:"completed_at"` // The time/date the Task was created. // Required: true // Format: date-time CreatedAt *strfmt.DateTime `json:"created_at"` // Full text of the Task. // Required: true Description *string `json:"description"` // A string description of this resource. // Required: true EntityType *string `json:"entity_type"` // This field can be set to another unique ID. In the case that the Task has been imported from another tool, the ID in the other tool can be indicated here. // Required: true ExternalID *string `json:"external_id"` // An array of UUIDs of Groups mentioned in this Task. // Required: true GroupMentionIds []strfmt.UUID `json:"group_mention_ids"` // The unique ID of the Task. // Required: true ID *int64 `json:"id"` // An array of UUIDs of Members mentioned in this Task. // Required: true MemberMentionIds []strfmt.UUID `json:"member_mention_ids"` // Deprecated: use member_mention_ids. // Required: true MentionIds []strfmt.UUID `json:"mention_ids"` // An array of UUIDs of the Owners of this Task. // Required: true OwnerIds []strfmt.UUID `json:"owner_ids"` // The number corresponding to the Task's position within a list of Tasks on a Story. // Required: true Position *int64 `json:"position"` // The unique identifier of the parent Story. // Required: true StoryID *int64 `json:"story_id"` // The time/date the Task was updated. // Required: true // Format: date-time UpdatedAt *strfmt.DateTime `json:"updated_at"` }
Task task
swagger:model Task
func (*Task) ContextValidate ¶
ContextValidate validates this task based on context it is used
func (*Task) MarshalBinary ¶
MarshalBinary interface implementation
func (*Task) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type ThreadedComment ¶
type ThreadedComment struct { // The Shortcut application url for the Comment. // Required: true AppURL *string `json:"app_url"` // The unique ID of the Member that authored the Comment. // Required: true // Format: uuid AuthorID *strfmt.UUID `json:"author_id"` // A nested array of threaded comments. // Required: true Comments []*ThreadedComment `json:"comments"` // The time/date the Comment was created. // Required: true // Format: date-time CreatedAt *strfmt.DateTime `json:"created_at"` // True/false boolean indicating whether the Comment is deleted. // Required: true Deleted *bool `json:"deleted"` // A string description of this resource. // Required: true EntityType *string `json:"entity_type"` // This field can be set to another unique ID. In the case that the Comment has been imported from another tool, the ID in the other tool can be indicated here. // Required: true ExternalID *string `json:"external_id"` // An array of Group IDs that have been mentioned in this Comment. // Required: true GroupMentionIds []strfmt.UUID `json:"group_mention_ids"` // The unique ID of the Comment. // Required: true ID *int64 `json:"id"` // An array of Member IDs that have been mentioned in this Comment. // Required: true MemberMentionIds []strfmt.UUID `json:"member_mention_ids"` // Deprecated: use member_mention_ids. // Required: true MentionIds []strfmt.UUID `json:"mention_ids"` // The text of the Comment. // Required: true Text *string `json:"text"` // The time/date the Comment was updated. // Required: true // Format: date-time UpdatedAt *strfmt.DateTime `json:"updated_at"` }
ThreadedComment Comments associated with Epic Discussions.
swagger:model ThreadedComment
func (*ThreadedComment) ContextValidate ¶
ContextValidate validate this threaded comment based on the context it is used
func (*ThreadedComment) MarshalBinary ¶
func (m *ThreadedComment) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ThreadedComment) UnmarshalBinary ¶
func (m *ThreadedComment) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TypedStoryLink ¶
type TypedStoryLink struct { // The time/date when the Story Link was created. // Required: true // Format: date-time CreatedAt *strfmt.DateTime `json:"created_at"` // A string description of this resource. // Required: true EntityType *string `json:"entity_type"` // The unique identifier of the Story Link. // Required: true ID *int64 `json:"id"` // The ID of the object Story. // Required: true ObjectID *int64 `json:"object_id"` // The ID of the subject Story. // Required: true SubjectID *int64 `json:"subject_id"` // The workflow state of the "subject" story. // Required: true SubjectWorkflowStateID *int64 `json:"subject_workflow_state_id"` // This indicates whether the Story is the subject or object in the Story Link. // Required: true Type *string `json:"type"` // The time/date when the Story Link was last updated. // Required: true // Format: date-time UpdatedAt *strfmt.DateTime `json:"updated_at"` // How the subject Story acts on the object Story. This can be "blocks", "duplicates", or "relates to". // Required: true Verb *string `json:"verb"` }
TypedStoryLink The type of Story Link. The string can be subject or object.
swagger:model TypedStoryLink
func (*TypedStoryLink) ContextValidate ¶
ContextValidate validates this typed story link based on context it is used
func (*TypedStoryLink) MarshalBinary ¶
func (m *TypedStoryLink) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TypedStoryLink) UnmarshalBinary ¶
func (m *TypedStoryLink) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type UnusableEntitlementError ¶
type UnusableEntitlementError struct { // Short tag describing the unusable entitlement action taken by the user. // Required: true // Max Length: 63 // Min Length: 1 EntitlementTag *string `json:"entitlement_tag"` // Message displayed to the user on why their action failed. // Required: true // Max Length: 256 // Min Length: 1 Message *string `json:"message"` // The tag for violating an entitlement action. // Required: true // Enum: [entitlement-violation] ReasonTag *string `json:"reason_tag"` }
UnusableEntitlementError unusable entitlement error
swagger:model UnusableEntitlementError
func (*UnusableEntitlementError) ContextValidate ¶
func (m *UnusableEntitlementError) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this unusable entitlement error based on context it is used
func (*UnusableEntitlementError) MarshalBinary ¶
func (m *UnusableEntitlementError) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*UnusableEntitlementError) UnmarshalBinary ¶
func (m *UnusableEntitlementError) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type UpdateCategory ¶
type UpdateCategory struct { // A true/false boolean indicating if the Category has been archived. Archived bool `json:"archived,omitempty"` // The hex color to be displayed with the Category (for example, "#ff0000"). // Min Length: 1 // Pattern: ^#[a-fA-F0-9]{6}$ Color *string `json:"color,omitempty"` // The new name of the Category. // Min Length: 1 Name string `json:"name,omitempty"` }
UpdateCategory update category
swagger:model UpdateCategory
func (*UpdateCategory) ContextValidate ¶
ContextValidate validates this update category based on context it is used
func (*UpdateCategory) MarshalBinary ¶
func (m *UpdateCategory) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*UpdateCategory) UnmarshalBinary ¶
func (m *UpdateCategory) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type UpdateComment ¶
type UpdateComment struct { // The updated comment text. // Required: true Text *string `json:"text"` }
UpdateComment update comment
swagger:model UpdateComment
func (*UpdateComment) ContextValidate ¶
ContextValidate validates this update comment based on context it is used
func (*UpdateComment) MarshalBinary ¶
func (m *UpdateComment) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*UpdateComment) UnmarshalBinary ¶
func (m *UpdateComment) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type UpdateEntityTemplate ¶
type UpdateEntityTemplate struct { // The updated template name. // Min Length: 1 Name string `json:"name,omitempty"` // story contents StoryContents *UpdateStoryContents `json:"story_contents,omitempty"` }
UpdateEntityTemplate Request parameters for changing either a template's name or any of
the attributes it is designed to pre-populate.
swagger:model UpdateEntityTemplate
func (*UpdateEntityTemplate) ContextValidate ¶
ContextValidate validate this update entity template based on the context it is used
func (*UpdateEntityTemplate) MarshalBinary ¶
func (m *UpdateEntityTemplate) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*UpdateEntityTemplate) UnmarshalBinary ¶
func (m *UpdateEntityTemplate) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type UpdateEpic ¶
type UpdateEpic struct { // The ID of the Epic we want to move this Epic after. AfterID int64 `json:"after_id,omitempty"` // A true/false boolean indicating whether the Epic is in archived state. Archived bool `json:"archived,omitempty"` // The ID of the Epic we want to move this Epic before. BeforeID int64 `json:"before_id,omitempty"` // A manual override for the time/date the Epic was completed. // Format: date-time CompletedAtOverride *strfmt.DateTime `json:"completed_at_override,omitempty"` // The Epic's deadline. // Format: date-time Deadline *strfmt.DateTime `json:"deadline,omitempty"` // The Epic's description. // Max Length: 100000 Description string `json:"description,omitempty"` // The ID of the Epic State. EpicStateID int64 `json:"epic_state_id,omitempty"` // An array of UUIDs for any Members you want to add as Followers on this Epic. FollowerIds []strfmt.UUID `json:"follower_ids"` // The ID of the group to associate with the epic. // Format: uuid GroupID *strfmt.UUID `json:"group_id,omitempty"` // An array of Labels attached to the Epic. Labels []*CreateLabelParams `json:"labels"` // The ID of the Milestone this Epic is related to. MilestoneID *int64 `json:"milestone_id,omitempty"` // The Epic's name. // Max Length: 256 // Min Length: 1 Name string `json:"name,omitempty"` // An array of UUIDs for any members you want to add as Owners on this Epic. OwnerIds []strfmt.UUID `json:"owner_ids"` // The Epic's planned start date. // Format: date-time PlannedStartDate *strfmt.DateTime `json:"planned_start_date,omitempty"` // The ID of the member that requested the epic. // Format: uuid RequestedByID strfmt.UUID `json:"requested_by_id,omitempty"` // A manual override for the time/date the Epic was started. // Format: date-time StartedAtOverride *strfmt.DateTime `json:"started_at_override,omitempty"` // `Deprecated` The Epic's state (to do, in progress, or done); will be ignored when `epic_state_id` is set. // Enum: [in progress to do done] State string `json:"state,omitempty"` }
UpdateEpic update epic
swagger:model UpdateEpic
func (*UpdateEpic) ContextValidate ¶
ContextValidate validate this update epic based on the context it is used
func (*UpdateEpic) MarshalBinary ¶
func (m *UpdateEpic) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*UpdateEpic) UnmarshalBinary ¶
func (m *UpdateEpic) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type UpdateFile ¶
type UpdateFile struct { // The time/date that the file was uploaded. // Format: date-time CreatedAt strfmt.DateTime `json:"created_at,omitempty"` // The description of the file. Description string `json:"description,omitempty"` // An additional ID that you may wish to assign to the file. ExternalID string `json:"external_id,omitempty"` // The name of the file. // Max Length: 1024 // Min Length: 1 Name string `json:"name,omitempty"` // The time/date that the file was last updated. // Format: date-time UpdatedAt strfmt.DateTime `json:"updated_at,omitempty"` // The unique ID assigned to the Member who uploaded the file to Shortcut. // Format: uuid UploaderID strfmt.UUID `json:"uploader_id,omitempty"` }
UpdateFile update file
swagger:model UpdateFile
func (*UpdateFile) ContextValidate ¶
ContextValidate validates this update file based on context it is used
func (*UpdateFile) MarshalBinary ¶
func (m *UpdateFile) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*UpdateFile) UnmarshalBinary ¶
func (m *UpdateFile) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type UpdateGroup ¶
type UpdateGroup struct { // Whether or not this Group is archived. Archived *bool `json:"archived,omitempty"` // The color you wish to use for the Group in the system. // Min Length: 1 // Pattern: ^#[a-fA-F0-9]{6}$ Color *string `json:"color,omitempty"` // The color key you wish to use for the Group in the system. // Enum: [blue purple midnight-blue orange yellow-green brass gray fuchsia yellow pink sky-blue green red black slate turquoise] ColorKey string `json:"color_key,omitempty"` // The description of this Group. Description string `json:"description,omitempty"` // The Icon id for the avatar of this Group. // Format: uuid DisplayIconID *strfmt.UUID `json:"display_icon_id,omitempty"` // The Member ids to add to this Group. // Unique: true MemberIds []strfmt.UUID `json:"member_ids"` // The mention name of this Group. // Min Length: 1 MentionName string `json:"mention_name,omitempty"` // The name of this Group. // Min Length: 1 Name string `json:"name,omitempty"` // The Workflow ids to add to the Group. WorkflowIds []int64 `json:"workflow_ids"` }
UpdateGroup update group
swagger:model UpdateGroup
func (*UpdateGroup) ContextValidate ¶
ContextValidate validates this update group based on context it is used
func (*UpdateGroup) MarshalBinary ¶
func (m *UpdateGroup) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*UpdateGroup) UnmarshalBinary ¶
func (m *UpdateGroup) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type UpdateIteration ¶
type UpdateIteration struct { // The description of the Iteration. // Max Length: 100000 Description string `json:"description,omitempty"` // The date this Iteration ends, e.g. 2019-07-05. // Min Length: 1 EndDate string `json:"end_date,omitempty"` // An array of UUIDs for any Members you want to add as Followers. FollowerIds []strfmt.UUID `json:"follower_ids"` // An array of UUIDs for any Groups you want to add as Followers. Currently, only one Group association is presented in our web UI. GroupIds []strfmt.UUID `json:"group_ids"` // An array of Labels attached to the Iteration. Labels []*CreateLabelParams `json:"labels"` // The name of this Iteration // Min Length: 1 Name string `json:"name,omitempty"` // The date this Iteration begins, e.g. 2019-07-01 // Min Length: 1 StartDate string `json:"start_date,omitempty"` }
UpdateIteration update iteration
swagger:model UpdateIteration
func (*UpdateIteration) ContextValidate ¶
ContextValidate validate this update iteration based on the context it is used
func (*UpdateIteration) MarshalBinary ¶
func (m *UpdateIteration) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*UpdateIteration) UnmarshalBinary ¶
func (m *UpdateIteration) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type UpdateLabel ¶
type UpdateLabel struct { // A true/false boolean indicating if the Label has been archived. Archived bool `json:"archived,omitempty"` // The hex color to be displayed with the Label (for example, "#ff0000"). // Min Length: 1 // Pattern: ^#[a-fA-F0-9]{6}$ Color *string `json:"color,omitempty"` // The new description of the label. Description string `json:"description,omitempty"` // The new name of the label. // Max Length: 128 // Min Length: 1 Name string `json:"name,omitempty"` }
UpdateLabel update label
swagger:model UpdateLabel
func (*UpdateLabel) ContextValidate ¶
ContextValidate validates this update label based on context it is used
func (*UpdateLabel) MarshalBinary ¶
func (m *UpdateLabel) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*UpdateLabel) UnmarshalBinary ¶
func (m *UpdateLabel) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type UpdateLinkedFile ¶
type UpdateLinkedFile struct { // The description of the file. Description string `json:"description,omitempty"` // The name of the file. // Min Length: 1 Name string `json:"name,omitempty"` // The filesize, if the integration provided it. Size int64 `json:"size,omitempty"` // The ID of the linked story. StoryID int64 `json:"story_id,omitempty"` // The URL of the thumbnail, if the integration provided it. // Max Length: 2048 // Pattern: ^https?://.+$ ThumbnailURL string `json:"thumbnail_url,omitempty"` // The integration type of the file (e.g. google, dropbox, box). // Enum: [google url dropbox box onedrive] Type string `json:"type,omitempty"` // The UUID of the member that uploaded the file. // Format: uuid UploaderID strfmt.UUID `json:"uploader_id,omitempty"` // The URL of linked file. // Max Length: 2048 // Pattern: ^https?://.+$ URL string `json:"url,omitempty"` }
UpdateLinkedFile update linked file
swagger:model UpdateLinkedFile
func (*UpdateLinkedFile) ContextValidate ¶
ContextValidate validates this update linked file based on context it is used
func (*UpdateLinkedFile) MarshalBinary ¶
func (m *UpdateLinkedFile) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*UpdateLinkedFile) UnmarshalBinary ¶
func (m *UpdateLinkedFile) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type UpdateMilestone ¶
type UpdateMilestone struct { // The ID of the Milestone we want to move this Milestone after. AfterID int64 `json:"after_id,omitempty"` // The ID of the Milestone we want to move this Milestone before. BeforeID int64 `json:"before_id,omitempty"` // An array of IDs of Categories attached to the Milestone. Categories []*CreateCategoryParams `json:"categories"` // A manual override for the time/date the Milestone was completed. // Format: date-time CompletedAtOverride *strfmt.DateTime `json:"completed_at_override,omitempty"` // The Milestone's description. // Max Length: 100000 Description string `json:"description,omitempty"` // The name of the Milestone. // Max Length: 256 // Min Length: 1 Name string `json:"name,omitempty"` // A manual override for the time/date the Milestone was started. // Format: date-time StartedAtOverride *strfmt.DateTime `json:"started_at_override,omitempty"` // The workflow state that the Milestone is in. // Enum: [in progress to do done] State string `json:"state,omitempty"` }
UpdateMilestone update milestone
swagger:model UpdateMilestone
func (*UpdateMilestone) ContextValidate ¶
ContextValidate validate this update milestone based on the context it is used
func (*UpdateMilestone) MarshalBinary ¶
func (m *UpdateMilestone) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*UpdateMilestone) UnmarshalBinary ¶
func (m *UpdateMilestone) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type UpdateProject ¶
type UpdateProject struct { // The Project abbreviation used in Story summaries. Should be kept to 3 characters at most. Abbreviation string `json:"abbreviation,omitempty"` // A true/false boolean indicating whether the Story is in archived state. Archived bool `json:"archived,omitempty"` // The color that represents the Project in the UI. // Min Length: 1 // Pattern: ^#[a-fA-F0-9]{6}$ Color string `json:"color,omitempty"` // The number of days before the thermometer appears in the Story summary. DaysToThermometer int64 `json:"days_to_thermometer,omitempty"` // The Project's description. // Max Length: 100000 Description string `json:"description,omitempty"` // An array of UUIDs for any Members you want to add as Followers. FollowerIds []strfmt.UUID `json:"follower_ids"` // The Project's name. // Max Length: 128 // Min Length: 1 Name string `json:"name,omitempty"` // Configuration to enable or disable thermometers in the Story summary. ShowThermometer bool `json:"show_thermometer,omitempty"` // The ID of the team the project belongs to. TeamID int64 `json:"team_id,omitempty"` }
UpdateProject update project
swagger:model UpdateProject
func (*UpdateProject) ContextValidate ¶
ContextValidate validates this update project based on context it is used
func (*UpdateProject) MarshalBinary ¶
func (m *UpdateProject) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*UpdateProject) UnmarshalBinary ¶
func (m *UpdateProject) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type UpdateStories ¶
type UpdateStories struct { // The ID of the story that the stories are to be moved below. AfterID int64 `json:"after_id,omitempty"` // If the Stories should be archived or not. Archived bool `json:"archived,omitempty"` // The ID of the story that the stories are to be moved before. BeforeID int64 `json:"before_id,omitempty"` // The due date of the story. // Format: date-time Deadline *strfmt.DateTime `json:"deadline,omitempty"` // The ID of the epic the story belongs to. EpicID *int64 `json:"epic_id,omitempty"` // The numeric point estimate of the story. Can also be null, which means unestimated. Estimate *int64 `json:"estimate,omitempty"` // An array of External Links associated with this story. ExternalLinks []string `json:"external_links"` // The UUIDs of the new followers to be added. // Unique: true FollowerIdsAdd []strfmt.UUID `json:"follower_ids_add"` // The UUIDs of the followers to be removed. // Unique: true FollowerIdsRemove []strfmt.UUID `json:"follower_ids_remove"` // The Id of the Group the Stories should belong to. // Format: uuid GroupID *strfmt.UUID `json:"group_id,omitempty"` // The ID of the iteration the story belongs to. IterationID *int64 `json:"iteration_id,omitempty"` // An array of labels to be added. LabelsAdd []*CreateLabelParams `json:"labels_add"` // An array of labels to be removed. LabelsRemove []*CreateLabelParams `json:"labels_remove"` // One of "first" or "last". This can be used to move the given story to the first or last position in the workflow state. // Enum: [last first] MoveTo string `json:"move_to,omitempty"` // The UUIDs of the new owners to be added. // Unique: true OwnerIdsAdd []strfmt.UUID `json:"owner_ids_add"` // The UUIDs of the owners to be removed. // Unique: true OwnerIdsRemove []strfmt.UUID `json:"owner_ids_remove"` // The ID of the Project the Stories should belong to. ProjectID *int64 `json:"project_id,omitempty"` // The ID of the member that requested the story. // Format: uuid RequestedByID strfmt.UUID `json:"requested_by_id,omitempty"` // The Ids of the Stories you wish to update. // Required: true // Unique: true StoryIds []int64 `json:"story_ids"` // The type of story (feature, bug, chore). // Enum: [feature chore bug] StoryType string `json:"story_type,omitempty"` // The ID of the workflow state to put the stories in. WorkflowStateID int64 `json:"workflow_state_id,omitempty"` }
UpdateStories update stories
swagger:model UpdateStories
func (*UpdateStories) ContextValidate ¶
ContextValidate validate this update stories based on the context it is used
func (*UpdateStories) MarshalBinary ¶
func (m *UpdateStories) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*UpdateStories) UnmarshalBinary ¶
func (m *UpdateStories) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type UpdateStory ¶
type UpdateStory struct { // The ID of the story we want to move this story after. AfterID int64 `json:"after_id,omitempty"` // True if the story is archived, otherwise false. Archived bool `json:"archived,omitempty"` // The ID of the story we want to move this story before. BeforeID int64 `json:"before_id,omitempty"` // An array of IDs of Branches attached to the story. // Unique: true BranchIds []int64 `json:"branch_ids"` // An array of IDs of Commits attached to the story. // Unique: true CommitIds []int64 `json:"commit_ids"` // A manual override for the time/date the Story was completed. // Format: date-time CompletedAtOverride *strfmt.DateTime `json:"completed_at_override,omitempty"` // The due date of the story. // Format: date-time Deadline *strfmt.DateTime `json:"deadline,omitempty"` // The description of the story. // Max Length: 100000 Description string `json:"description,omitempty"` // The ID of the epic the story belongs to. EpicID *int64 `json:"epic_id,omitempty"` // The numeric point estimate of the story. Can also be null, which means unestimated. Estimate *int64 `json:"estimate,omitempty"` // An array of External Links associated with this story. ExternalLinks []string `json:"external_links"` // An array of IDs of files attached to the story. // Unique: true FileIds []int64 `json:"file_ids"` // An array of UUIDs of the followers of this story. // Unique: true FollowerIds []strfmt.UUID `json:"follower_ids"` // The ID of the group to associate with this story // Format: uuid GroupID *strfmt.UUID `json:"group_id,omitempty"` // The ID of the iteration the story belongs to. IterationID *int64 `json:"iteration_id,omitempty"` // An array of labels attached to the story. Labels []*CreateLabelParams `json:"labels"` // An array of IDs of linked files attached to the story. // Unique: true LinkedFileIds []int64 `json:"linked_file_ids"` // One of "first" or "last". This can be used to move the given story to the first or last position in the workflow state. // Enum: [last first] MoveTo string `json:"move_to,omitempty"` // The title of the story. // Max Length: 512 // Min Length: 1 Name string `json:"name,omitempty"` // An array of UUIDs of the owners of this story. // Unique: true OwnerIds []strfmt.UUID `json:"owner_ids"` // The ID of the project the story belongs to. ProjectID *int64 `json:"project_id,omitempty"` // An array of IDs of Pull/Merge Requests attached to the story. // Unique: true PullRequestIds []int64 `json:"pull_request_ids"` // The ID of the member that requested the story. // Format: uuid RequestedByID strfmt.UUID `json:"requested_by_id,omitempty"` // A manual override for the time/date the Story was started. // Format: date-time StartedAtOverride *strfmt.DateTime `json:"started_at_override,omitempty"` // The type of story (feature, bug, chore). // Enum: [feature chore bug] StoryType string `json:"story_type,omitempty"` // The ID of the workflow state to put the story in. WorkflowStateID int64 `json:"workflow_state_id,omitempty"` }
UpdateStory update story
swagger:model UpdateStory
func (*UpdateStory) ContextValidate ¶
ContextValidate validate this update story based on the context it is used
func (*UpdateStory) MarshalBinary ¶
func (m *UpdateStory) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*UpdateStory) UnmarshalBinary ¶
func (m *UpdateStory) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type UpdateStoryComment ¶
type UpdateStoryComment struct { // The updated comment text. // Required: true // Max Length: 100000 Text *string `json:"text"` }
UpdateStoryComment update story comment
swagger:model UpdateStoryComment
func (*UpdateStoryComment) ContextValidate ¶
ContextValidate validates this update story comment based on context it is used
func (*UpdateStoryComment) MarshalBinary ¶
func (m *UpdateStoryComment) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*UpdateStoryComment) UnmarshalBinary ¶
func (m *UpdateStoryComment) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type UpdateStoryContents ¶
type UpdateStoryContents struct { // The due date of the story. // Format: date-time Deadline *strfmt.DateTime `json:"deadline,omitempty"` // The description of the story. Description string `json:"description,omitempty"` // A string description of this resource. EntityType string `json:"entity_type,omitempty"` // The ID of the epic the to be populated. EpicID *int64 `json:"epic_id,omitempty"` // The numeric point estimate to be populated. Estimate *int64 `json:"estimate,omitempty"` // An array of external links to be populated. ExternalLinks []string `json:"external_links"` // An array of the attached file IDs to be populated. // Unique: true FileIds []int64 `json:"file_ids"` // An array of files attached to the story. Files []*UploadedFile `json:"files"` // An array of UUIDs for any Members listed as Followers. FollowerIds []strfmt.UUID `json:"follower_ids"` // The ID of the group to be populated. // Format: uuid GroupID *strfmt.UUID `json:"group_id,omitempty"` // The ID of the iteration the to be populated. IterationID *int64 `json:"iteration_id,omitempty"` // An array of label ids attached to the story. LabelIds []int64 `json:"label_ids"` // An array of labels to be populated by the template. Labels []*CreateLabelParams `json:"labels"` // An array of the linked file IDs to be populated. // Unique: true LinkedFileIds []int64 `json:"linked_file_ids"` // An array of linked files attached to the story. LinkedFiles []*LinkedFile `json:"linked_files"` // The name of the story. Name string `json:"name,omitempty"` // An array of UUIDs of the owners of this story. OwnerIds []strfmt.UUID `json:"owner_ids"` // The ID of the project the story belongs to. ProjectID *int64 `json:"project_id,omitempty"` // The type of story (feature, bug, chore). StoryType string `json:"story_type,omitempty"` // An array of tasks to be populated by the template. Tasks []*EntityTemplateTask `json:"tasks"` // The ID of the workflow state the story is currently in. WorkflowStateID int64 `json:"workflow_state_id,omitempty"` }
UpdateStoryContents Updated attributes for the template to populate.
swagger:model UpdateStoryContents
func (*UpdateStoryContents) ContextValidate ¶
ContextValidate validate this update story contents based on the context it is used
func (*UpdateStoryContents) MarshalBinary ¶
func (m *UpdateStoryContents) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*UpdateStoryContents) UnmarshalBinary ¶
func (m *UpdateStoryContents) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type UpdateStoryLink ¶
type UpdateStoryLink struct { // The ID of the object Story. ObjectID int64 `json:"object_id,omitempty"` // The ID of the subject Story. SubjectID int64 `json:"subject_id,omitempty"` // The type of link. // Enum: [blocks duplicates relates to] Verb string `json:"verb,omitempty"` }
UpdateStoryLink update story link
swagger:model UpdateStoryLink
func (*UpdateStoryLink) ContextValidate ¶
ContextValidate validates this update story link based on context it is used
func (*UpdateStoryLink) MarshalBinary ¶
func (m *UpdateStoryLink) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*UpdateStoryLink) UnmarshalBinary ¶
func (m *UpdateStoryLink) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type UpdateTask ¶
type UpdateTask struct { // Move task after this task ID. AfterID int64 `json:"after_id,omitempty"` // Move task before this task ID. BeforeID int64 `json:"before_id,omitempty"` // A true/false boolean indicating whether the task is complete. Complete bool `json:"complete,omitempty"` // The Task's description. Description string `json:"description,omitempty"` // An array of UUIDs of the owners of this story. OwnerIds []strfmt.UUID `json:"owner_ids"` }
UpdateTask update task
swagger:model UpdateTask
func (*UpdateTask) ContextValidate ¶
ContextValidate validates this update task based on context it is used
func (*UpdateTask) MarshalBinary ¶
func (m *UpdateTask) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*UpdateTask) UnmarshalBinary ¶
func (m *UpdateTask) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type UploadedFile ¶
type UploadedFile struct { // Free form string corresponding to a text or image file. // Required: true ContentType *string `json:"content_type"` // The time/date that the file was created. // Required: true // Format: date-time CreatedAt *strfmt.DateTime `json:"created_at"` // The description of the file. // Required: true Description *string `json:"description"` // A string description of this resource. // Required: true EntityType *string `json:"entity_type"` // This field can be set to another unique ID. In the case that the File has been imported from another tool, the ID in the other tool can be indicated here. // Required: true ExternalID *string `json:"external_id"` // The name assigned to the file in Shortcut upon upload. // Required: true Filename *string `json:"filename"` // The unique IDs of the Groups who are mentioned in the file description. // Required: true GroupMentionIds []strfmt.UUID `json:"group_mention_ids"` // The unique ID for the file. // Required: true ID *int64 `json:"id"` // The unique IDs of the Members who are mentioned in the file description. // Required: true MemberMentionIds []strfmt.UUID `json:"member_mention_ids"` // Deprecated: use member_mention_ids. // Required: true MentionIds []strfmt.UUID `json:"mention_ids"` // The optional User-specified name of the file. // Required: true Name *string `json:"name"` // The size of the file. // Required: true Size *int64 `json:"size"` // The unique IDs of the Stories associated with this file. // Required: true StoryIds []int64 `json:"story_ids"` // The url where the thumbnail of the file can be found in Shortcut. // Required: true ThumbnailURL *string `json:"thumbnail_url"` // The time/date that the file was updated. // Required: true // Format: date-time UpdatedAt *strfmt.DateTime `json:"updated_at"` // The unique ID of the Member who uploaded the file. // Required: true // Format: uuid UploaderID *strfmt.UUID `json:"uploader_id"` // The URL for the file. // Required: true URL *string `json:"url"` }
UploadedFile An UploadedFile is any document uploaded to your Shortcut Workspace. Files attached from a third-party service are different: see the Linked Files endpoint.
swagger:model UploadedFile
func (*UploadedFile) ContextValidate ¶
ContextValidate validates this uploaded file based on context it is used
func (*UploadedFile) MarshalBinary ¶
func (m *UploadedFile) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*UploadedFile) UnmarshalBinary ¶
func (m *UploadedFile) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Workflow ¶
type Workflow struct { // Indicates if an owner is automatically assigned when an unowned story is started. // Required: true AutoAssignOwner *bool `json:"auto_assign_owner"` // The date the Workflow was created. // Required: true // Format: date-time CreatedAt *strfmt.DateTime `json:"created_at"` // The unique ID of the default state that new Stories are entered into. // Required: true DefaultStateID *int64 `json:"default_state_id"` // A description of the workflow. // Required: true Description *string `json:"description"` // A string description of this resource. // Required: true EntityType *string `json:"entity_type"` // The unique ID of the Workflow. // Required: true ID *int64 `json:"id"` // The name of the workflow. // Required: true Name *string `json:"name"` // An array of IDs of projects within the Workflow. // Required: true ProjectIds []float64 `json:"project_ids"` // A map of the states in this Workflow. // Required: true States []*WorkflowState `json:"states"` // The ID of the team the workflow belongs to. // Required: true TeamID *int64 `json:"team_id"` // The date the Workflow was updated. // Required: true // Format: date-time UpdatedAt *strfmt.DateTime `json:"updated_at"` }
Workflow Workflow is the array of defined Workflow States. Workflow can be queried using the API but must be updated in the Shortcut UI.
swagger:model Workflow
func (*Workflow) ContextValidate ¶
ContextValidate validate this workflow based on the context it is used
func (*Workflow) MarshalBinary ¶
MarshalBinary interface implementation
func (*Workflow) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type WorkflowState ¶
type WorkflowState struct { // The hex color for this Workflow State. // Min Length: 1 // Pattern: ^#[a-fA-F0-9]{6}$ Color string `json:"color,omitempty"` // The time/date the Workflow State was created. // Required: true // Format: date-time CreatedAt *strfmt.DateTime `json:"created_at"` // The description of what sort of Stories belong in that Workflow state. // Required: true Description *string `json:"description"` // A string description of this resource. // Required: true EntityType *string `json:"entity_type"` // The unique ID of the Workflow State. // Required: true ID *int64 `json:"id"` // The Workflow State's name. // Required: true Name *string `json:"name"` // The number of Stories currently in that Workflow State. // Required: true NumStories *int64 `json:"num_stories"` // The number of Story Templates associated with that Workflow State. // Required: true NumStoryTemplates *int64 `json:"num_story_templates"` // The position that the Workflow State is in, starting with 0 at the left. // Required: true Position *int64 `json:"position"` // The type of Workflow State (Unstarted, Started, or Finished) // Required: true Type *string `json:"type"` // When the Workflow State was last updated. // Required: true // Format: date-time UpdatedAt *strfmt.DateTime `json:"updated_at"` // The verb that triggers a move to that Workflow State when making VCS commits. // Required: true Verb *string `json:"verb"` }
WorkflowState Workflow State is any of the at least 3 columns. Workflow States correspond to one of 3 types: Unstarted, Started, or Done.
swagger:model WorkflowState
func (*WorkflowState) ContextValidate ¶
ContextValidate validates this workflow state based on context it is used
func (*WorkflowState) MarshalBinary ¶
func (m *WorkflowState) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*WorkflowState) UnmarshalBinary ¶
func (m *WorkflowState) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
Source Files ¶
- basic_workspace_info.go
- branch.go
- category.go
- commit.go
- create_category.go
- create_category_params.go
- create_comment_comment.go
- create_entity_template.go
- create_epic.go
- create_epic_comment.go
- create_group.go
- create_iteration.go
- create_label_params.go
- create_linked_file.go
- create_milestone.go
- create_or_delete_story_reaction.go
- create_project.go
- create_stories.go
- create_story_comment.go
- create_story_comment_params.go
- create_story_contents.go
- create_story_link.go
- create_story_link_params.go
- create_story_params.go
- create_task.go
- create_task_params.go
- delete_stories.go
- entity_template.go
- entity_template_task.go
- epic.go
- epic_search_results.go
- epic_slim.go
- epic_state.go
- epic_stats.go
- epic_workflow.go
- get_epic_stories.go
- get_external_link_stories_params.go
- get_iteration_stories.go
- get_label_stories.go
- get_member.go
- get_project_stories.go
- group.go
- history.go
- history_action_branch_create.go
- history_action_branch_merge.go
- history_action_branch_push.go
- history_action_label_create.go
- history_action_label_delete.go
- history_action_label_update.go
- history_action_project_update.go
- history_action_pull_request.go
- history_action_story_comment_create.go
- history_action_story_create.go
- history_action_story_delete.go
- history_action_story_link_create.go
- history_action_story_link_delete.go
- history_action_story_link_update.go
- history_action_story_update.go
- history_action_task_create.go
- history_action_task_delete.go
- history_action_task_update.go
- history_changes_story.go
- history_changes_story_link.go
- history_changes_task.go
- history_reference_branch.go
- history_reference_commit.go
- history_reference_epic.go
- history_reference_general.go
- history_reference_group.go
- history_reference_iteration.go
- history_reference_label.go
- history_reference_project.go
- history_reference_story.go
- history_reference_story_task.go
- history_reference_workflow_state.go
- icon.go
- identity.go
- iteration.go
- iteration_slim.go
- iteration_stats.go
- label.go
- label_slim.go
- label_stats.go
- linked_file.go
- list_epics.go
- list_group_stories.go
- list_labels.go
- list_members.go
- max_search_results_exceeded_error.go
- member.go
- member_info.go
- milestone.go
- milestone_stats.go
- profile.go
- project.go
- project_stats.go
- pull_request.go
- pull_request_label.go
- repository.go
- search.go
- search_results.go
- search_stories.go
- story.go
- story_comment.go
- story_contents.go
- story_contents_task.go
- story_history_change_adds_removes_int.go
- story_history_change_adds_removes_uuid.go
- story_history_change_old_new_bool.go
- story_history_change_old_new_int.go
- story_history_change_old_new_str.go
- story_history_change_old_new_uuid.go
- story_link.go
- story_reaction.go
- story_search_results.go
- story_slim.go
- story_stats.go
- task.go
- threaded_comment.go
- typed_story_link.go
- unusable_entitlement_error.go
- update_category.go
- update_comment.go
- update_entity_template.go
- update_epic.go
- update_file.go
- update_group.go
- update_iteration.go
- update_label.go
- update_linked_file.go
- update_milestone.go
- update_project.go
- update_stories.go
- update_story.go
- update_story_comment.go
- update_story_contents.go
- update_story_link.go
- update_task.go
- uploaded_file.go
- workflow.go
- workflow_state.go