Class StoriesService

headers

get

• get(id): Promise<Story>

• Parameters

  • id: string | number

  Returns Promise<Story>

getMany

• getMany(ids): Promise<Story[]>

• Parameters

  • ids: string[] | number[]

  Returns Promise<Story[]>

list

• list(): Promise<Story[]>

• Returns Promise<Story[]>

search

• search(query, next?): Promise<SearchResponse<Story, StoryInterface>>

• Search for resources using the Shortcut Syntax

  Parameters

  • query: string

    The search query to use
  • Optional next: string

    The next page token to use for pagination

  Returns Promise<SearchResponse<Story, StoryInterface>>

  Example

  const client = new Client()
  const epics = client.epic.search('My epic')
  const stories = client.story.search('team:platform')
  const objectives = client.objective.search({team_id: 123})
  const iterations = client.iteration.search('team:platform')
  Copy

  Throws

  Error if the HTTP status code is 400 or greater