Constructors
constructor
- new Pixela(username: string, token: string): Pixela
-
Parameters
-
username: string
-
token: string
Properties
Private client
client: AxiosInstance
Private token
token: string
Private username
username: string
Methods
createGraph
- createGraph(params: object): Promise<Response>
-
Parameters
-
params: object
-
-
id: string
-
Optional isSecret?: undefined | false | true
-
name: string
-
Optional publishOptionalData?: undefined | false | true
-
-
Optional timezone?: undefined | string
-
-
unit: string
Returns Promise<Response>
createNotification
- createNotification(__namedParameters: object): Promise<Response>
-
Parameters
-
__namedParameters: object
Returns Promise<Response>
createPixel
- createPixel(__namedParameters: object): Promise<Response>
-
Parameters
-
__namedParameters: object
Returns Promise<Response>
createUser
- createUser(params: object): Promise<Response>
-
Parameters
-
params: object
-
-
-
Optional thanksCode?: undefined | string
Returns Promise<Response>
decrementPixel
- decrementPixel(graphId: string): Promise<Response>
Private delete
- delete<T>(url: string): Promise<T>
-
Type parameters
Parameters
Returns Promise<T>
deleteChannel
- deleteChannel(__namedParameters: object): Promise<Response>
-
Parameters
-
__namedParameters: object
Returns Promise<Response>
deleteGraph
- deleteGraph(graphId: string): Promise<Response>
deleteNotification
- deleteNotification(__namedParameters: object): Promise<Response>
-
Parameters
-
__namedParameters: object
-
graphId: string
-
notificationId: string
Returns Promise<Response>
deletePixel
- deletePixel(__namedParameters: object): Promise<Response>
-
Parameters
-
__namedParameters: object
-
date: string
-
graphId: string
Returns Promise<Response>
deleteWebhook
- deleteWebhook(webhookHash: string): Promise<Response>
Private get
- get<T>(url: string, params?: Dictionary): Promise<T>
-
Type parameters
Parameters
Returns Promise<T>
getGraphSvg
- getGraphSvg(__namedParameters: object): Promise<string>
-
Parameters
-
__namedParameters: object
Returns Promise<string>
getPixel
- getPixel(__namedParameters: object): Promise<Pixel>
-
Parameters
-
__namedParameters: object
-
date: string
-
graphId: string
Returns Promise<Pixel>
getPixelDates
- getPixelDates(__namedParameters: object): Promise<PixelDates>
-
Parameters
-
__namedParameters: object
getStats
- getStats(graphId: string): Promise<Stats>
-
Parameters
Returns Promise<Stats>
incrementPixel
- incrementPixel(graphId: string): Promise<Response>
invokeWebhook
- invokeWebhook(webhookHash: string): Promise<Response>
Private post
- post<T>(url: string, params?: any): Promise<T>
-
Type parameters
Parameters
-
url: string
-
Optional params: any
Returns Promise<T>
Private put
- put<T>(url: string, params?: any): Promise<T>
-
Type parameters
Parameters
-
url: string
-
Optional params: any
Returns Promise<T>
updateChannel
- updateChannel(__namedParameters: object): Promise<Response>
-
Parameters
-
__namedParameters: object
Returns Promise<Response>
updateGraph
- updateGraph(__namedParameters: object): Promise<Response>
-
Parameters
-
__namedParameters: object
Returns Promise<Response>
updateNotification
- updateNotification(__namedParameters: object): Promise<Response>
-
Parameters
-
__namedParameters: object
-
graphId: string
-
notificationId: string
-
Returns Promise<Response>
updatePixel
- updatePixel(__namedParameters: object): Promise<Response>
-
Parameters
-
__namedParameters: object
-
date: string
-
graphId: string
-
Returns Promise<Response>
updateUser
- updateUser(params: object): Promise<Response>
-
Parameters
-
params: object
-
newToken: string
-
Optional thanksCode?: undefined | string
Returns Promise<Response>