Class Profile

Hierarchy

Index

Constructors

constructor

Properties

addons

addons: object

id

limits

limits: { analysis: number; data_records: number; email: number; input: number; output: number; sms: number }

Type declaration

  • analysis: number
  • data_records: number
  • email: number
  • input: number
  • output: number
  • sms: number

name

name: string

Methods

addonEdit

addonList

auditLog

create

  • create(profileObj: { name: string }): Promise<{ id: GenericID }>

delete

  • delete(profileID: GenericID): Promise<string>

edit

info

list

serviceEdit

  • serviceEdit(profileID: GenericID, serviceObj: object): Promise<string>
  • Sets the information of services for the profile. Services are the main resources in your profile, for example data input, data output, etc...

    Parameters

    • profileID: GenericID

      Profile identification

    • serviceObj: object

    Returns Promise<string>

tokenCreate

tokenDelete

tokenList

transferTokenToAnotherProfile

  • transferTokenToAnotherProfile(targetProfileID: GenericID): Promise<string>
  • Transforms the current token to another profile. The current profile will no longer have the current token, as the current token will be acquired by the profile informed. After this call is done, other requests using this token will work solely for the new profile, and no longer for the current profile.

    Parameters

    • targetProfileID: GenericID

      Profile identification

    Returns Promise<string>

usageStatisticList

  • usageStatisticList(profileID: GenericID, dateObj?: { date?: string; timezone?: string }): Promise<UsageStatistic[]>
  • List all the usage statistics of your profile

    Parameters

    • profileID: GenericID

      Profile identification

    • Optional dateObj: { date?: string; timezone?: string }

      Object with date and their timezone

      • Optional date?: string
      • Optional timezone?: string

    Returns Promise<UsageStatistic[]>