alytics-proto.1.42-668efde.source-code.analytics.thrift Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of analytics-proto Show documentation
Generates jar artifact containing compiled thrift classes based on generated thrift IDL files
There is a newer version: 1.43-2d1fdc2
include "base.thrift"

namespace java dev.vality.damsel.analytics
namespace erlang analytics

/**
 * В каком разбиении сервис отдаёт данные.
 **/
enum SplitUnit {
    MINUTE
    HOUR
    DAY
    WEEK
    MONTH
    YEAR
}

/**
 * Статусы платежей.
 **/
enum PaymentStatus {
    PENDING
    PROCESSED
    CAPTURED
    CANCELLED
    REFUNDED
    FAILED
}

/**
 * Параметры фильтрации мерчанта
 **/
struct MerchantFilter {
    1: required string party_id
    2: optional list shop_ids
    3: optional list exclude_shop_ids
}

/**
 * Параметры фильтрации по времени
 **/
struct TimeFilter {
    1: required base.Timestamp from_time
    2: required base.Timestamp to_time
}

/**
 * Запрос с разбивкой по периодам
 **/
struct FilterRequest {
    1: required MerchantFilter merchant_filter
    2: required TimeFilter time_filter
}

/**
 * Запрос с разбивкой по периодам сгруппированый по отрезкам
 **/
struct SplitFilterRequest {
    1: required FilterRequest filter_request
    // Желаемый уровень разбиения, может быть изменен при неадекватности запроса
    2: required SplitUnit split_unit
}

/**
 * Распределение в процентах для чего-либо
 **/
struct NamingDistribution {
    1: required string name
    2: required base.Percent percents
}

/**
 * Ошибка с вложенными подоошибками
 **/
struct SubError {
    1: required string code
    2: optional SubError sub_error
}

/**
 * Распределение в процентах для ошибок
 **/
struct ErrorDistribution {
    1: required SubError error
    2: required base.Percent percents
}

/**
 * Список оборотов с группировкой по  валютам
 **/
struct AmountResponse {
    1: required list groups_amount
}

struct ShopAmountResponse {
    1: required list groups_amount
}

/**
 * Результат запроса распределения ошибок
 **/
struct ErrorDistributionsResponse {
    1: required list error_distributions
}

/**
 * Результат запроса распределения ошибок с подошибками
 **/
struct SubErrorDistributionsResponse {
    1: required list error_distributions
}

/**
 * Сгруппированное по валюте значение оборота
 **/
struct CurrencyGroupedAmount {
    1: required base.Amount amount
    2: required base.CurrencySymbolicCode currency
}

/**
 * Сгруппированное по магазину значение оборота
 **/
struct ShopGroupedAmount {
    1: required base.Amount amount
    2: required string shop_id
    3: required base.CurrencySymbolicCode currency
}

/**
 * Результат запроса колличества сгруппированных по валютам
 **/
struct CountResponse {
    1: required list groups_count
}

/**
 * Сгруппированное по валюте колличество
 **/
struct CurrecyGroupCount {
    1: required base.Count count
    2: required base.CurrencySymbolicCode currency
}

/**
 * Результат запроса распределения платежных средств
 **/
struct PaymentToolDistributionResponse {
    1: required list payment_tools_distributions
}

/**
 * Результат запроса оборотов разделенного на временные участки и сгруппированного по валюте
 **/
struct SplitAmountResponse {
    1: required list grouped_currency_amounts
    // Фактический уровень разбиения, может быть равен желаемому или заменен на более подходящий
    2: required SplitUnit result_split_unit
}

/**
 * Результат оборотов сгруппированных по валюте
 **/
struct GroupedCurrencyOffsetAmount {
    1: required base.CurrencySymbolicCode currency
    2: required list offset_amounts
}

/**
 * Оборот со смещением в временном интервале
 **/
struct OffsetAmount {
    1: required base.Amount amount
    2: required base.Count offset
}

/**
 * Результат запроса колличества платежей разделенного на временные участки и сгруппированного по валюте и статусам
 **/
struct SplitCountResponse {
    1: required list payment_tools_destrobutions
    // Фактический уровень разбиения, может быть равен желаемому или заменен на более подходящий
    2: required SplitUnit result_split_unit
}

/**
 * Колличества платежей сгруппированые по валюте
 **/
struct GroupedCurrencyOffsetCount {
    1: required base.CurrencySymbolicCode currency
    2: required list offset_amounts
}

/**
 * Колличества платежей сгруппированые по статусам
 **/
struct GroupedStatusOffsetCount {
    1: required PaymentStatus status
    2: required list offsetCounts
}

/**
 * Колличество платежей со смещением в временном интервале
 **/
struct OffsetCount {
    1: required base.Count count
    2: required base.Count offset
}

/**
 * Сервис для работы с аналитикой
 **/
service AnalyticsService {

    /**
     * Получение распределения использования платежных инструментов для ЛК.
     **/
    PaymentToolDistributionResponse GetPaymentsToolDistribution(1: FilterRequest request)

    /**
     * Получение списка оборотов с группировкой по валютам для ЛК.
     **/
    AmountResponse GetPaymentsAmount(1: FilterRequest request)

    /**
     * Получение списка зачислений с группировкой по валютам для ЛК.
     **/
    AmountResponse GetCreditingsAmount(1: FilterRequest request)

    /**
     * Получение среднего размера платежа с группировкой по валютам для ЛК.
     **/
    AmountResponse GetAveragePayment(1: FilterRequest request)

    /**
     * Получение колличества платежей с группировкой по валютам для ЛК.
     **/
    CountResponse GetPaymentsCount(1: FilterRequest request)

    /**
     * Получение распределения ошибок по причине ошибки для ЛК.
     **/
    ErrorDistributionsResponse GetPaymentsErrorDistribution(1: FilterRequest request)

    /**
     * Получение распределения ошибок c подошибками для ЛК.
     **/
    SubErrorDistributionsResponse GetPaymentsSubErrorDistribution(1: FilterRequest request)

    /**
     * Получение списка оборотов с группировкой по валютам и разделенные по временным интервалам для ЛК.
     **/
    SplitAmountResponse GetPaymentsSplitAmount(1: SplitFilterRequest request)

    /**
     * Получение колличества платежей с группировкой по валютам и статусам, разделенные по временным интервалам для ЛК.
     **/
    SplitCountResponse GetPaymentsSplitCount(1: SplitFilterRequest request)

    /**
     * Получение списка возвратов с группировкой по валютам для ЛК.
     **/
    AmountResponse GetRefundsAmount(1: FilterRequest request)

    /**
     * Получение балансов с группировкой по валютам для ЛК.
     **/
    AmountResponse GetCurrentBalances(1: MerchantFilter merchant_filter)

    /**
    * Получение текущего баланса с группировкой по магазинам
    **/
    ShopAmountResponse GetCurrentShopBalances(1: MerchantFilter merchant_filter)

}