Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Pixela

Hierarchy

  • Pixela

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Pixela(username: string, token: string): Pixela

  • Parameters

    • username: string
    • token: string

    Returns Pixela

Properties

Private client

client: AxiosInstance

Private token

token: string

Private username

username: string

Methods

createChannel

createGraph

  • createGraph(params: object): Promise<Response>

  • Parameters

    • params: object
      • color: Color
      • id: string
      • Optional isSecret?: undefined | false | true
      • name: string
      • Optional publishOptionalData?: undefined | false | true
      • Optional selfSufficient?: SelfSufficient
      • Optional timezone?: undefined | string
      • type: Type
      • unit: string

    Returns Promise<Response>

createNotification

  • createNotification(__namedParameters: object): Promise<Response>

  • Parameters

    • __namedParameters: object
      • graphId: string
      • params: params

    Returns Promise<Response>

createPixel

  • createPixel(__namedParameters: object): Promise<Response>

  • Parameters

    • __namedParameters: object
      • graphId: string
      • params: params

    Returns Promise<Response>

createUser

  • createUser(params: object): Promise<Response>

  • Parameters

    Returns Promise<Response>

createWebhook

decrementPixel

  • decrementPixel(graphId: string): Promise<Response>

  • Parameters

    • graphId: string

    Returns Promise<Response>

Private delete

  • delete<T>(url: string): Promise<T>

  • Type parameters

    • T

    Parameters

    • url: string

    Returns Promise<T>

deleteChannel

  • deleteChannel(__namedParameters: object): Promise<Response>

  • Parameters

    • __namedParameters: object
      • channelId: string

    Returns Promise<Response>

deleteGraph

  • deleteGraph(graphId: string): Promise<Response>

  • Parameters

    • graphId: string

    Returns 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>

deleteUser

  • Returns Promise<Response>

deleteWebhook

  • deleteWebhook(webhookHash: string): Promise<Response>

  • Parameters

    • webhookHash: string

    Returns Promise<Response>

Private get

  • get<T>(url: string, params?: Dictionary): Promise<T>

  • Type parameters

    • T

    Parameters

    Returns Promise<T>

getChannels

  • Returns Promise<Channels>

getGraphSvg

  • getGraphSvg(__namedParameters: object): Promise<string>

  • Parameters

    • __namedParameters: object
      • graphId: string
      • params: params

    Returns Promise<string>

getGraphs

  • getGraphs(): Promise<Graphs>

  • Returns Promise<Graphs>

getNotifications

  • Parameters

    • graphId: string

    Returns Promise<Notifications>

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
      • graphId: string
      • params: params

    Returns Promise<PixelDates>

getStats

  • getStats(graphId: string): Promise<Stats>

  • Parameters

    • graphId: string

    Returns Promise<Stats>

getWebhooks

  • Returns Promise<Webhooks>

incrementPixel

  • incrementPixel(graphId: string): Promise<Response>

  • Parameters

    • graphId: string

    Returns Promise<Response>

invokeWebhook

  • invokeWebhook(webhookHash: string): Promise<Response>

  • Parameters

    • webhookHash: string

    Returns Promise<Response>

Private post

  • post<T>(url: string, params?: any): Promise<T>

  • Type parameters

    • T

    Parameters

    • url: string
    • Optional params: any

    Returns Promise<T>

Private put

  • put<T>(url: string, params?: any): Promise<T>

  • Type parameters

    • T

    Parameters

    • url: string
    • Optional params: any

    Returns Promise<T>

updateChannel

  • updateChannel(__namedParameters: object): Promise<Response>

  • Parameters

    • __namedParameters: object
      • channelId: string
      • params: params

    Returns Promise<Response>

updateGraph

  • updateGraph(__namedParameters: object): Promise<Response>

  • Parameters

    • __namedParameters: object
      • graphId: string
      • params: params

    Returns Promise<Response>

updateNotification

  • updateNotification(__namedParameters: object): Promise<Response>

  • Parameters

    • __namedParameters: object
      • graphId: string
      • notificationId: string
      • params: params

    Returns Promise<Response>

updatePixel

  • updatePixel(__namedParameters: object): Promise<Response>

  • Parameters

    • __namedParameters: object
      • date: string
      • graphId: string
      • params: params

    Returns Promise<Response>

updateUser

  • updateUser(params: object): Promise<Response>

  • Parameters

    • params: object
      • newToken: string
      • Optional thanksCode?: undefined | string

    Returns Promise<Response>

Generated using TypeDoc