Function AnalyticsApiAxiosParamCreator

AnalyticsApi - axios parameter creator export

  • AnalyticsApiAxiosParamCreator(configuration?): {
        apiAnalyticsGet: ((minAmount?: number, maxAmount?: number, fromDate?: string, toDate?: string, statuses?: string[], paymentTypes?: string[], id?: string, shortId?: string, toHandle?: string, toEmail?: string, toPhone?: string, toName?: string, toPersonaId?: string, toUserId?: string, toUserAccountId?: string, toId?: string, toCreated?: string, toShortId?: string, toObjectName?: string, limit?: number, page?: number, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

  • Parameters

    Returns {
        apiAnalyticsGet: ((minAmount?: number, maxAmount?: number, fromDate?: string, toDate?: string, statuses?: string[], paymentTypes?: string[], id?: string, shortId?: string, toHandle?: string, toEmail?: string, toPhone?: string, toName?: string, toPersonaId?: string, toUserId?: string, toUserAccountId?: string, toId?: string, toCreated?: string, toShortId?: string, toObjectName?: string, limit?: number, page?: number, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

    • apiAnalyticsGet: ((minAmount?: number, maxAmount?: number, fromDate?: string, toDate?: string, statuses?: string[], paymentTypes?: string[], id?: string, shortId?: string, toHandle?: string, toEmail?: string, toPhone?: string, toName?: string, toPersonaId?: string, toUserId?: string, toUserAccountId?: string, toId?: string, toCreated?: string, toShortId?: string, toObjectName?: string, limit?: number, page?: number, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      summary Retrieve a list of Payments summed by date

      Throws

        • (minAmount?, maxAmount?, fromDate?, toDate?, statuses?, paymentTypes?, id?, shortId?, toHandle?, toEmail?, toPhone?, toName?, toPersonaId?, toUserId?, toUserAccountId?, toId?, toCreated?, toShortId?, toObjectName?, limit?, page?, userId?, options?): Promise<RequestArgs>

        • Parameters

          • OptionalminAmount: number

            The minimum amount for filtering

          • OptionalmaxAmount: number

            The maximum amount for filtering

          • OptionalfromDate: string

            The starting date for filtering

          • OptionaltoDate: string

            The end date for filtering

          • Optionalstatuses: string[]

            A list of statuses for filtering

          • OptionalpaymentTypes: string[]

            A list of payment types for filtering

          • Optionalid: string
          • OptionalshortId: string
          • OptionaltoHandle: string

            The Mozaic handle for a contact

          • OptionaltoEmail: string

            The email address of the contact

          • OptionaltoPhone: string

            The fully qualified phone number of the contact

          • OptionaltoName: string

            Loosely, the name of the contact. May be changed during registration

          • OptionaltoPersonaId: string

            Specifies the persona associated with this contact record

          • OptionaltoUserId: string

            Specifies the user associated with this contact record

          • OptionaltoUserAccountId: string

            Specifies the user account id associated with this contact record

          • OptionaltoId: string
          • OptionaltoCreated: string
          • OptionaltoShortId: string
          • OptionaltoObjectName: string

            The name of this object

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

Settings

Member Visibility