Function ActivityApiAxiosParamCreator

ActivityApi - axios parameter creator export

  • ActivityApiAxiosParamCreator(configuration?): {
        getActivity: ((key?: string, type?: ActivityType, limit?: number, page?: number, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getTaskList: ((type?: ActivityType, limit?: number, page?: number, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        updateActivity: ((key?: string, type?: ActivityType, status?: ActivityStatus, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        updateActivityTask: ((activityId: string, taskId: string, activityTaskUpdateDeets?: ActivityTaskUpdateDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

  • Parameters

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

    • getActivity: ((key?: string, type?: ActivityType, limit?: number, page?: number, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      summary Retrieves the Activity with the specified key and activity type

      Throws

        • (key?, type?, limit?, page?, userId?, options?): Promise<RequestArgs>

        • 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<RequestArgs>

    • getTaskList: ((type?: ActivityType, limit?: number, page?: number, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      summary Retrieves the Task Activity with the specified key and activity type

      Throws

        • (type?, limit?, page?, userId?, options?): Promise<RequestArgs>

        • 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<RequestArgs>

    • updateActivity: ((key?: string, type?: ActivityType, status?: ActivityStatus, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      summary Create or update an Activity

      Throws

        • (key?, type?, status?, userId?, options?): Promise<RequestArgs>

        • 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<RequestArgs>

    • updateActivityTask: ((activityId: string, taskId: string, activityTaskUpdateDeets?: ActivityTaskUpdateDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      summary update activity task status

      Throws

        • (activityId, taskId, activityTaskUpdateDeets?, options?): Promise<RequestArgs>

        • Parameters

          • activityId: string
          • taskId: string
          • OptionalactivityTaskUpdateDeets: ActivityTaskUpdateDeets
          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

Settings

Member Visibility