UserClient

Hierarchy

• ResourceClient
  • UserClient

Index

Properties

• apifyClient
• baseUrl
• httpClient
• id
• params
• publicBaseUrl
• resourcePath
• safeId
• url

Methods

• get
• limits
• monthlyUsage
• updateLimits

Properties

inheritedapifyClient

apifyClient: ApifyClient

Inherited from ResourceClient.apifyClient

inheritedbaseUrl

baseUrl: string

Inherited from ResourceClient.baseUrl

inheritedhttpClient

httpClient: HttpClient

Inherited from ResourceClient.httpClient

optionalinheritedid

id?: string

Inherited from ResourceClient.id

optionalinheritedparams

params?: Record<string, unknown>

Inherited from ResourceClient.params

inheritedpublicBaseUrl

publicBaseUrl: string

Inherited from ResourceClient.publicBaseUrl

inheritedresourcePath

resourcePath: string

Inherited from ResourceClient.resourcePath

optionalinheritedsafeId

safeId?: string

Inherited from ResourceClient.safeId

inheritedurl

url: string

Inherited from ResourceClient.url

Methods

get

• get(): Promise<User>

• Depending on whether ApifyClient was created with a token, the method will either return public or private user data. https://docs.apify.com/api/v2#/reference/users

  ---

  Returns Promise<User>

limits

• limits(): Promise<undefined | AccountAndUsageLimits>

• https://docs.apify.com/api/v2/#/reference/users/account-and-usage-limits

  ---

  Returns Promise<undefined | AccountAndUsageLimits>

monthlyUsage

• monthlyUsage(): Promise<undefined | MonthlyUsage>

• https://docs.apify.com/api/v2/#/reference/users/monthly-usage

  ---

  Returns Promise<undefined | MonthlyUsage>

updateLimits

• updateLimits(options): Promise<void>

• https://docs.apify.com/api/v2/#/reference/users/account-and-usage-limits

  ---

  Parameters

  • options: LimitsUpdateOptions

  Returns Promise<void>