Function ActivityApiFactory

ActivityApi - factory interface export

  • ActivityApiFactory(configuration?, basePath?, axios?): {
        getActivity(key?: string, type?: ActivityType, limit?: number, page?: number, userId?: string, options?: RawAxiosRequestConfig): AxiosPromise<Activity>;
        getTaskList(type?: ActivityType, limit?: number, page?: number, userId?: string, options?: RawAxiosRequestConfig): AxiosPromise<Activity>;
        updateActivity(key?: string, type?: ActivityType, status?: ActivityStatus, userId?: string, options?: RawAxiosRequestConfig): AxiosPromise<Activity>;
        updateActivityTask(activityId: string, taskId: string, activityTaskUpdateDeets?: ActivityTaskUpdateDeets, options?: RawAxiosRequestConfig): AxiosPromise<Activity>;
    }

  • Parameters

    • Optionalconfiguration: Configuration
    • OptionalbasePath: string
    • Optionalaxios: AxiosInstance

    Returns {
        getActivity(key?: string, type?: ActivityType, limit?: number, page?: number, userId?: string, options?: RawAxiosRequestConfig): AxiosPromise<Activity>;
        getTaskList(type?: ActivityType, limit?: number, page?: number, userId?: string, options?: RawAxiosRequestConfig): AxiosPromise<Activity>;
        updateActivity(key?: string, type?: ActivityType, status?: ActivityStatus, userId?: string, options?: RawAxiosRequestConfig): AxiosPromise<Activity>;
        updateActivityTask(activityId: string, taskId: string, activityTaskUpdateDeets?: ActivityTaskUpdateDeets, options?: RawAxiosRequestConfig): AxiosPromise<Activity>;
    }

    • getActivity:function
      • getActivity(key?, type?, limit?, page?, userId?, options?): AxiosPromise<Activity>

      • 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 AxiosPromise<Activity>

        Throws

    • getTaskList:function
      • getTaskList(type?, limit?, page?, userId?, options?): AxiosPromise<Activity>

      • 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 AxiosPromise<Activity>

        Throws

    • updateActivity:function
      • updateActivity(key?, type?, status?, userId?, options?): AxiosPromise<Activity>

      • 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 AxiosPromise<Activity>

        Throws

    • updateActivityTask:function
      • updateActivityTask(activityId, taskId, activityTaskUpdateDeets?, options?): AxiosPromise<Activity>

      • summary update activity task status

        Parameters

        • activityId: string
        • taskId: string
        • OptionalactivityTaskUpdateDeets: ActivityTaskUpdateDeets
        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<Activity>

        Throws

Settings

Member Visibility