Class ActivityApi

ActivityApi - object-oriented interface export ActivityApi

Hierarchy (view full)

BaseAPI
- ActivityApi

Index

Constructors

Properties

axios basePath configuration

Methods

getActivity getTaskList updateActivity updateActivityTask

Constructors

constructor

new ActivityApi(configuration?, basePath?, axios?): ActivityApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns ActivityApi
Inherited from BaseAPI.constructor
- Defined in src/api/base.ts:53

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

getActivity

getActivity(key?, type?, limit?, page?, userId?, options?): Promise<AxiosResponse<Activity, any>>
summary Retrieves the Activity with the specified key and activity type
Parameters
- Optionalkey: string
  The id of the object this activity is associated with
- Optionaltype: ActivityType
  The type of activity being requested contactCreated invited onboarded readyForPayouts firstPayout firstPayment
- Optionallimit: number
  A limit of the number of objects to be returned for the next page, between 1 and 100. The default is 25
- Optionalpage: number
  1-based page index for paginated results
- OptionaluserId: string
  The user id to operate on their behalf (tenants only)
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<Activity, any>>
Throws
memberof ActivityApi
- Defined in src/api/api.ts:11441

getTaskList

getTaskList(type?, limit?, page?, userId?, options?): Promise<AxiosResponse<Activity, any>>
summary Retrieves the Task Activity with the specified key and activity type
Parameters
- Optionaltype: ActivityType
  The type of activity being requested contactCreated invited onboarded readyForPayouts firstPayout firstPayment
- Optionallimit: number
  A limit of the number of objects to be returned for the next page, between 1 and 100. The default is 25
- Optionalpage: number
  1-based page index for paginated results
- OptionaluserId: string
  The user id to operate on their behalf (tenants only)
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<Activity, any>>
Throws
memberof ActivityApi
- Defined in src/api/api.ts:11456

updateActivity

updateActivity(key?, type?, status?, userId?, options?): Promise<AxiosResponse<Activity, any>>
summary Create or update an Activity
Parameters
- Optionalkey: string
  The id of the object this activity is associated with
- Optionaltype: ActivityType
  Specifies the type of the activity contactCreated invited onboarded readyForPayouts firstPayout firstPayment
- Optionalstatus: ActivityStatus
  Specifies the status of the activity unknown started pending completed needsAttention failed notStarted
- OptionaluserId: string
  The user id to operate on their behalf (tenants only)
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<Activity, any>>
Throws
memberof ActivityApi
- Defined in src/api/api.ts:11471

updateActivityTask

updateActivityTask(activityId, taskId, activityTaskUpdateDeets?, options?): Promise<AxiosResponse<Activity, any>>
summary update activity task status
Parameters
- activityId: string
- taskId: string
- OptionalactivityTaskUpdateDeets: ActivityTaskUpdateDeets
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<Activity, any>>
Throws
memberof ActivityApi
- Defined in src/api/api.ts:11485