Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PlansApi

Hierarchy

  • PlansApi

Index

Constructors

Properties

Methods

Constructors

constructor

  • new PlansApi(basePath?: string): PlansApi

Properties

Protected basePath

basePath: string = "https://dev.azure.com/"

defaultHeaders

defaultHeaders: any

Methods

createPlan

  • createPlan(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Plan>

  • Add a new plan for the team

    Parameters

    • params: object
      • apiVersion: string
      • body: CreatePlan
      • organization: string
      • project: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<Plan>

deletePlan

  • deletePlan(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<__type>

  • Delete the specified plan

    Parameters

    • params: object
      • apiVersion: string
      • id: string
      • organization: string
      • project: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<__type>

getPlan

  • getPlan(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Plan>

  • Get the information for the specified plan

    Parameters

    • params: object
      • apiVersion: string
      • id: string
      • organization: string
      • project: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<Plan>

getPlans

  • getPlans(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ArrayWrapper<Plan>>

  • Get the information for all the plans configured for the given team

    Parameters

    • params: object
      • apiVersion: string
      • organization: string
      • project: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<ArrayWrapper<Plan>>

updatePlan

  • updatePlan(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Plan>

  • Update the information for the specified plan

    Parameters

    • params: object
      • apiVersion: string
      • body: UpdatePlan
      • id: string
      • organization: string
      • project: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<Plan>

Generated using TypeDoc