Profile | TagoIO SDK for JavaScript and TypeScript

Hierarchy

TagoIOModule<GenericModuleParams>
- Profile

Constructors

constructor

new Profile(params: GenericModuleParams): Profile

Inherited from TagoIOModule<GenericModuleParams>.constructor
- Defined in src/common/TagoIOModule.ts:79
Parameters
- params: GenericModuleParams
Returns Profile

Methods

addTeamMember

addTeamMember(id: string, email: string): Promise<string>

- Defined in src/modules/Account/Profile.ts:326
Add a team member to a profile in a specific account

throws
If the email is not a valid TagoIO's account.

throws
If the profile does not exists.

Parameters
- id: string
- email: string
Returns Promise<string>
Success message.

addonEdit

addonEdit(profileID: string, addonObj: Partial<AddonInfo>): Promise<string>

- Defined in src/modules/Account/Profile.ts:206
Sets the information of addons for the profile

Parameters
- profileID: string
  
  Profile identification
- addonObj: Partial<AddonInfo>
Returns Promise<string>

addonList

addonList(profileID: string): Promise<AddonInfo>

- Defined in src/modules/Account/Profile.ts:192
Gets the information of addons for the profile

Parameters
- profileID: string
  
  Profile identification
Returns Promise<AddonInfo>

auditLog

auditLog(profileID: string, filterObj?: AuditLogFilter): Promise<AuditLog>

- Defined in src/modules/Account/Profile.ts:162
Create a query for auditlog

Parameters
- profileID: string
  
  Profile identification
- Optional filterObj: AuditLogFilter
  
  auditlog filter object
Returns Promise<AuditLog>

auditLogQuery

auditLogQuery(profileID: string, queryId?: string): Promise<AuditLog>

- Defined in src/modules/Account/Profile.ts:178
Fetches the information from an auditlog query

Parameters
- profileID: string
  
  Profile identification
- Optional queryId: string
  
  auditlog queryId from auditLogCreate
Returns Promise<AuditLog>

create

create(profileObj: { name: string }, options?: { allocate_free_resources?: boolean }): Promise<{ id: string }>

- Defined in src/modules/Account/Profile.ts:76
Create a profile.

If allocate_free_resources is passed as an option, all the free resources available in allocation will be allocated to the new profile.

Parameters
- profileObj: { name: string }
  
  Profile object with data to be created
  - name: string
- Optional options: { allocate_free_resources?: boolean }
  
  Options for the created profile.
  - Optional allocate_free_resources?: boolean
Returns Promise<{ id: string }>

delete

delete(profileID: string): Promise<string>

- Defined in src/modules/Account/Profile.ts:113
Delete profile

Parameters
- profileID: string
  
  Profile identification
Returns Promise<string>

deleteTeamMember

deleteTeamMember(id: string, accountId: string): Promise<string>

- Defined in src/modules/Account/Profile.ts:358
Remove an account from a profile shared team.

throws
If the accountId is not a valid TagoIO's account.

throws
If the profile does not exists.

Parameters
- id: string
- accountId: string
Returns Promise<string>
Success message.

edit

edit(profileID: string, profileObj: Partial<ProfileInfo>): Promise<string>

- Defined in src/modules/Account/Profile.ts:99
Edits a profile

Parameters
- profileID: string
- profileObj: Partial<ProfileInfo>
  
  Profile object with data to be changed
Returns Promise<string>

info

info(profileID: string): Promise<ProfileInfo>

- Defined in src/modules/Account/Profile.ts:44
Get Profile info

Parameters
- profileID: string
  Profile identification or "current" for current profile example:
  - account.profiles.info("6126850f58ef8600184dd486");
  - account.profiles.info("current");
Returns Promise<ProfileInfo>

list

list(): Promise<ProfileListInfo[]>

- Defined in src/modules/Account/Profile.ts:28
Lists all the profiles in your account

Returns Promise<ProfileListInfo[]>

removeAddOn

removeAddOn(profileId: string, addon: BillingAddOn): Promise<string>

- Defined in src/modules/Account/Profile.ts:309
Remove an add-on from a profile at the end of the billing cycle.

throws
If profile ID is invalid.

throws
If profile doesn't have the add-on.

Parameters
- profileId: string
- addon: BillingAddOn
Returns Promise<string>
Success message.

serviceEdit

serviceEdit(profileID: string, serviceObj: object): Promise<string>

- Defined in src/modules/Account/Profile.ts:222
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: string
  
  Profile identification
- serviceObj: object
Returns Promise<string>

summary

summary(profileID: string): Promise<ProfileSummary>

- Defined in src/modules/Account/Profile.ts:58
Gets profile summary

Parameters
- profileID: string
Returns Promise<ProfileSummary>

teamList

teamList(id: string): Promise<ProfileTeam[]>

- Defined in src/modules/Account/Profile.ts:341
Fetch the list of accounts that a profile is shared with.

Parameters
- id: string
Returns Promise<ProfileTeam[]>

tokenCreate

tokenCreate(profileID: string, tokenParams: TokenData): Promise<TokenCreateResponse>

- Defined in src/modules/Account/Profile.ts:276
Generates and retrieves a new token

Parameters
- profileID: string
  
  Profile ID
- tokenParams: TokenData
  
  Token params for new token
Returns Promise<TokenCreateResponse>

tokenDelete

tokenDelete(token: string): Promise<string>

- Defined in src/modules/Account/Profile.ts:292
Deletes a token

Parameters
- token: string
  
  Token
Returns Promise<string>

tokenList

tokenList(profileID: string, queryObj?: ListTokenQuery): Promise<Partial<TokenDataList>[]>

- Defined in src/modules/Account/Profile.ts:253
Retrieves a list of all tokens

Parameters
- profileID: string
  
  Profile ID
- Optional queryObj: ListTokenQuery
  
  Search query params
Returns Promise<Partial<TokenDataList>[]>

transferTokenToAnotherProfile

transferTokenToAnotherProfile(targetProfileID: string): Promise<string>

- Defined in src/modules/Account/Profile.ts:239
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: string
  
  Profile identification
Returns Promise<string>

usageStatisticList

usageStatisticList(profileID: string, dateObj?: StatisticsDate): Promise<UsageStatistic[]>

- Defined in src/modules/Account/Profile.ts:143
List all the usage statistics of a profile.

Usage statistics are cumulative: if a service was not used in a time period, the statistics for that time period will not be in the object.
example
```
[
  { "time": "2022-01-01T00:00:00.000Z", "input": 5 },
  { "time": "2022-01-02T00:00:00.000Z", "input": 5, "output": 10 },
  { "time": "2022-01-03T00:00:00.000Z", "input": 10, "output": 15 },
]
```
Parameters
- profileID: string
  
  Profile identification
- Optional dateObj: StatisticsDate
  
  Object with date and their timezone
Returns Promise<UsageStatistic[]>
Array of cumulative usage statistics.

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

params: GenericModuleParams

Returns Profile

Methods

addTeamMember

Parameters

id: string

email: string

Returns Promise<string>

addonEdit

Parameters

profileID: string

addonObj: Partial<AddonInfo>

Returns Promise<string>

addonList

Parameters

profileID: string

Returns Promise<AddonInfo>

auditLog

Parameters

profileID: string

Optional filterObj: AuditLogFilter

Returns Promise<AuditLog>

auditLogQuery

Parameters

profileID: string

Optional queryId: string

Returns Promise<AuditLog>

create

Parameters

profileObj: { name: string }

name: string

Optional options: { allocate_free_resources?: boolean }

Optional allocate_free_resources?: boolean

Returns Promise<{ id: string }>

delete

Parameters

profileID: string

Returns Promise<string>

deleteTeamMember

Parameters

id: string

accountId: string

Returns Promise<string>

edit

Parameters

profileID: string

profileObj: Partial<ProfileInfo>

Returns Promise<string>

info

Parameters

profileID: string

Returns Promise<ProfileInfo>

list

Returns Promise<ProfileListInfo[]>

removeAddOn

Parameters

profileId: string

addon: BillingAddOn

Returns Promise<string>

serviceEdit

Parameters

profileID: string

serviceObj: object

Returns Promise<string>

summary

Parameters

profileID: string

Returns Promise<ProfileSummary>

teamList

Parameters

id: string

Returns Promise<ProfileTeam[]>

tokenCreate