Class TimespanAPI

Hierarchy

APIBase
- TimespanAPI

Index

Constructors

Properties

apiClient options

Methods

checkApiKey createTimespan deleteTimespan retrieveTimespan retrieveTimespans setApiAuthorization setApiUrl updateTimespan

Constructors

constructor

new TimespanAPI(apiClient: APIClient, options: ClientOptions): TimespanAPI
Parameters
- apiClient: APIClient
- options: ClientOptions
Returns TimespanAPI
Overrides APIBase.constructor
- Defined in api/TimespanAPI.ts:9

Properties

`Protected` `Readonly`apiClient

apiClient: APIClient

`Protected` `Readonly`options

options: ClientOptions

Methods

`Protected`checkApiKey

checkApiKey(apiName?: string): void
Parameters
- OptionalapiName: string
Returns void
Inherited from APIBase.checkApiKey
- Defined in api/APIBase.ts:41

createTimespan

createTimespan(timestampData: NewTimespan): Promise<Timespan>
Creates a new time entry
Parameters
- timestampData: NewTimespan
  The time entry data
Returns Promise<Timespan>
- Defined in api/TimespanAPI.ts:17

deleteTimespan

deleteTimespan(id: string): Promise<void>
Deletes one time entry
Parameters
- id: string
  The time entry id
Returns Promise<void>
- Defined in api/TimespanAPI.ts:28

retrieveTimespan

retrieveTimespan(id: string): Promise<Timespan>
Retrieve a single time entry
Parameters
- id: string
  The time entry id
Returns Promise<Timespan>
- Defined in api/TimespanAPI.ts:38

retrieveTimespans

retrieveTimespans(options?: PaginationOptions): Promise<Paginated<Timespan[]>>
Query a list of time entries
Parameters
- Optionaloptions: PaginationOptions
Returns Promise<Paginated<Timespan[]>>
- Defined in api/TimespanAPI.ts:48

setApiAuthorization

setApiAuthorization(authorization: Authorization): void
Set a new API key.
Parameters
- authorization: Authorization
  The API authorization data
Returns void
Inherited from APIBase.setApiAuthorization
- Defined in api/APIBase.ts:20

setApiUrl

setApiUrl(newURL: string): void
Set a new API URL.
Parameters
- newURL: string
  The new API url
Returns void
Inherited from APIBase.setApiUrl
- Defined in api/APIBase.ts:37

updateTimespan

updateTimespan(
id: string,
newTimespanData: Partial<NewTimespan>,
): Promise<Timespan>
Creates a new time entry
Parameters
- id: string
  The time entry id
- newTimespanData: Partial<NewTimespan>
  The time entry data
Returns Promise<Timespan>
- Defined in api/TimespanAPI.ts:60