Class default

Hierarchy

default
- default

Index

Constructors

constructor

new default(__namedParameters: {
requestBuilder: default;
requestHandler: default;
}): default
Parameters
- __namedParameters: {
  requestBuilder: default;
  requestHandler: default;
  }
  - requestBuilder: default
  - requestHandler: default
Returns default
Inherited from default.constructor
- Defined in collections/abstractCollection.ts:13

Properties

`Protected` requestBuilder

requestBuilder: default

`Protected` requestHandler

requestHandler: default

Methods

`Protected` createAndSendRequest

createAndSendRequest(pathname: string, __namedParameters?: {
    body?: unknown;
    method?: Method;
    query?: {
        [key: string]: number | string | string[];
    };
}): Promise<any>
Parameters
- pathname: string
- __namedParameters: {
      body?: unknown;
      method?: Method;
      query?: {
          [key: string]: number | string | string[];
      };
  } = {}
  - Optional body?: unknown
  - Optional method?: Method
  - Optional query?: {
    [key: string]: number | string | string[];
    }
    - [key: string]: number | string | string[]
Returns Promise<any>
Inherited from default.createAndSendRequest
- Defined in collections/abstractCollection.ts:24

deletePlan

deletePlan(id: string): Promise<void>
Parameters
- id: string
Returns Promise<void>
- Defined in collections/plans.ts:66

get

get(options?: Partial<AssigneeType & PlanItemType & DateRange & UpdatedFromDateOrDateTime & Pagination>): Promise<PaginatedResultSetResponse<PlanResponse>>
Parameters
- Optional options: Partial<AssigneeType & PlanItemType & DateRange & UpdatedFromDateOrDateTime & Pagination>
Returns Promise<PaginatedResultSetResponse<PlanResponse>>
- Defined in collections/plans.ts:11

getForUser

getForUser(accountId: string, options?: Partial<DateRange & UpdatedFromDateOrDateTime>): Promise<ResultSetResponse<PlanResponse>>
Parameters
- accountId: string
- Optional options: Partial<DateRange & UpdatedFromDateOrDateTime>
Returns Promise<ResultSetResponse<PlanResponse>>
- Defined in collections/plans.ts:72

getPlan

getPlan(id: string, options?: DateRange): Promise<PlanResponse>
Parameters
- id: string
- Optional options: DateRange
Returns Promise<PlanResponse>
- Defined in collections/plans.ts:32

getPlanForDaily

getPlanForDaily(daily: string, options?: Partial<{
assigneeType: string;
} & {
planItemType: string;
} & DateRange & UpdatedFromDateOrDateTime & Pagination>): Promise<ResultSetResponse<PlanResponse>>
Retrieve plans with time broken down by days
Parameters
- daily: string
- Optional options: Partial<{
  assigneeType: string;
  } & {
  planItemType: string;
  } & DateRange & UpdatedFromDateOrDateTime & Pagination>
Returns Promise<ResultSetResponse<PlanResponse>>
- Defined in collections/plans.ts:44

post

post(plan: Plan): Promise<PlanResponse>
Parameters
- plan: Plan
Returns Promise<PlanResponse>
- Defined in collections/plans.ts:25

putPlan

putPlan(id: string, plan: Plan): Promise<PlanResponse>
Parameters
- id: string
- plan: Plan
Returns Promise<PlanResponse>
- Defined in collections/plans.ts:59

Class default

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

__namedParameters: { requestBuilder: default; requestHandler: default; }

requestBuilder: default

requestHandler: default

Returns default

Properties

Protected requestBuilder

Protected requestHandler

Methods

Protected createAndSendRequest

Parameters

pathname: string

__namedParameters: { body?: unknown; method?: Method; query?: { [key: string]: number | string | string[]; }; } = {}

Optional body?: unknown

Optional method?: Method

Optional query?: { [key: string]: number | string | string[]; }

[key: string]: number | string | string[]

Returns Promise<any>

deletePlan

Parameters

id: string

Returns Promise<void>

get

Parameters

Optional options: Partial<AssigneeType & PlanItemType & DateRange & UpdatedFromDateOrDateTime & Pagination>

Returns Promise<PaginatedResultSetResponse<PlanResponse>>

getForUser

Parameters

accountId: string

Optional options: Partial<DateRange & UpdatedFromDateOrDateTime>

Returns Promise<ResultSetResponse<PlanResponse>>

getPlan

Parameters

id: string

Optional options: DateRange

Returns Promise<PlanResponse>

getPlanForDaily

Parameters

daily: string

Optional options: Partial<{ assigneeType: string; } & { planItemType: string; } & DateRange & UpdatedFromDateOrDateTime & Pagination>

Returns Promise<ResultSetResponse<PlanResponse>>

post

Parameters

plan: Plan

Returns Promise<PlanResponse>

putPlan

Parameters

id: string

plan: Plan

Returns Promise<PlanResponse>

Settings

Member Visibility

Theme

__namedParameters: {
requestBuilder: default;
requestHandler: default;
}

`Protected` requestBuilder

`Protected` requestHandler

`Protected` createAndSendRequest

__namedParameters: {
body?: unknown;
method?: Method;
query?: {
[key: string]: number | string | string[];
};
} = {}

`Optional` body?: unknown

`Optional` method?: Method

`Optional` query?: {
[key: string]: number | string | string[];
}

`Optional` options: Partial<AssigneeType & PlanItemType & DateRange & UpdatedFromDateOrDateTime & Pagination>

`Optional` options: Partial<DateRange & UpdatedFromDateOrDateTime>

`Optional` options: DateRange

`Optional` options: Partial<{
assigneeType: string;
} & {
planItemType: string;
} & DateRange & UpdatedFromDateOrDateTime & Pagination>