dev.vality.swag.analytics.api.SearchApi

@Generated(value="io.swagger.codegen.languages.JavaClientCodegen",
           date="2022-03-18T10:45:05.280Z")
@Component("dev.vality.swag.analytics.api.SearchApi")
public class SearchApi
extends Object

Constructor Summary

Constructors

Constructor Description

SearchApi()

SearchApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
`ApiClient`	`getApiClient()`
`InlineResponse2008`	`searchChargebacks(String xRequestID, String partyID, OffsetDateTime fromTime, OffsetDateTime toTime, Integer limit, String xRequestDeadline, String shopID, List<String> shopIDs, String paymentInstitutionRealm, Integer offset, String invoiceID, String paymentID, String chargebackID, List<String> chargebackStatuses, List<String> chargebackStages, List<String> chargebackCategories, String continuationToken)`	Поиск чарджбэков
`InlineResponse2009`	`searchInvoices(String xRequestID, String partyID, OffsetDateTime fromTime, OffsetDateTime toTime, Integer limit, String xRequestDeadline, String shopID, List<String> shopIDs, String paymentInstitutionRealm, List<String> invoiceIDs, String invoiceStatus, String invoiceID, String externalID, Long invoiceAmountFrom, Long invoiceAmountTo, List<String> excludedShops, String continuationToken)`	Поиск инвойсов
`InlineResponse20010`	searchPayments(String xRequestID, String partyID, OffsetDateTime fromTime, OffsetDateTime toTime, Integer limit, String xRequestDeadline, String shopID, List<String> shopIDs, String paymentInstitutionRealm, List<String> invoiceIDs, String paymentStatus, String paymentFlow, String paymentMethod, String paymentTerminalProvider, String invoiceID, String paymentID, String externalID, String payerEmail, String payerIP, String payerFingerprint, String customerID, String first6, String last4, String rrn, String approvalCode, String bankCardTokenProvider, String bankCardPaymentSystem, Long paymentAmountFrom, Long paymentAmountTo, List<String> excludedShops, String continuationToken)	Поиск платежей
`InlineResponse20011`	`searchPayouts(String xRequestID, String partyID, OffsetDateTime fromTime, OffsetDateTime toTime, Integer limit, String xRequestDeadline, String shopID, List<String> shopIDs, String paymentInstitutionRealm, Integer offset, String payoutID, String payoutToolType, List<String> excludedShops, String continuationToken)`	Поиск выплат
`InlineResponse20012`	`searchRefunds(String xRequestID, String partyID, OffsetDateTime fromTime, OffsetDateTime toTime, Integer limit, String xRequestDeadline, String shopID, List<String> shopIDs, String paymentInstitutionRealm, Integer offset, List<String> invoiceIDs, String invoiceID, String paymentID, String refundID, String externalID, String refundStatus, List<String> excludedShops, String continuationToken)`	Поиск возвратов
`void`	`setApiClient(ApiClient apiClient)`

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- SearchApi
  
  public SearchApi()
- SearchApi
  
  @Autowired public SearchApi(ApiClient apiClient)
Method Details
- getApiClient
  
  public ApiClient getApiClient()
- setApiClient
  
  public void setApiClient(ApiClient apiClient)
- searchChargebacks
  
  public InlineResponse2008 searchChargebacks(String xRequestID, String partyID, OffsetDateTime fromTime, OffsetDateTime toTime, Integer limit, String xRequestDeadline, String shopID, List<String> shopIDs, String paymentInstitutionRealm, Integer offset, String invoiceID, String paymentID, String chargebackID, List<String> chargebackStatuses, List<String> chargebackStages, List<String> chargebackCategories, String continuationToken) throws org.springframework.web.client.RestClientException
  
  Поиск чарджбэков
  200 - Найденные чарджбэки
  400 - Неверные данные
  401 - Ошибка авторизации
  404 - Заданный ресурс не найден
  
  Parameters:
  
  xRequestID - Уникальный идентификатор запроса к системе
  
  partyID - Уникальный идентификатор участника в рамках платформы
  
  fromTime - Начало временного отрезка
  
  toTime - Конец временного отрезка
  
  limit - Лимит выборки
  
  xRequestDeadline - Максимальное время обработки запроса
  
  shopID - Идентификатор магазина
  
  shopIDs - Идентификаторы магазинов
  
  paymentInstitutionRealm - Тип магазина, тестовый или «боевой»
  
  offset - Смещение выборки
  
  invoiceID - Идентификатор инвойса
  
  paymentID - Идентификатор платежа
  
  chargebackID - Идентификатор чарджбэка
  
  chargebackStatuses - Статусы чарджбэков
  
  chargebackStages - Этапы чарджбэков
  
  chargebackCategories - Категории чарджбэков
  
  continuationToken - Токен, сигнализирующий о том, что в ответе передана только часть данных. Для получения следующей части нужно повторно обратиться к сервису, указав тот же набор условий и полученый токен. Если токена нет, получена последняя часть данных.
  
  Returns:
  
  InlineResponse2008
  
  Throws:
  
  org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
- searchInvoices
  
  public InlineResponse2009 searchInvoices(String xRequestID, String partyID, OffsetDateTime fromTime, OffsetDateTime toTime, Integer limit, String xRequestDeadline, String shopID, List<String> shopIDs, String paymentInstitutionRealm, List<String> invoiceIDs, String invoiceStatus, String invoiceID, String externalID, Long invoiceAmountFrom, Long invoiceAmountTo, List<String> excludedShops, String continuationToken) throws org.springframework.web.client.RestClientException
  
  Поиск инвойсов
  200 - Найденные инвойсы
  400 - Неверные данные
  401 - Ошибка авторизации
  404 - Заданный ресурс не найден
  
  Parameters:
  
  xRequestID - Уникальный идентификатор запроса к системе
  
  partyID - Уникальный идентификатор участника в рамках платформы
  
  fromTime - Начало временного отрезка
  
  toTime - Конец временного отрезка
  
  limit - Лимит выборки
  
  xRequestDeadline - Максимальное время обработки запроса
  
  shopID - Идентификатор магазина
  
  shopIDs - Идентификаторы магазинов
  
  paymentInstitutionRealm - Тип магазина, тестовый или «боевой»
  
  invoiceIDs - Список инвойсов
  
  invoiceStatus - Статус инвойса для поиска
  
  invoiceID - Идентификатор инвойса
  
  externalID - Внешний идентификатор
  
  invoiceAmountFrom - Минимальная сумма инвойса
  
  invoiceAmountTo - Максимальная сумма инвойса
  
  excludedShops - Идентификаторы магазинов, исключаемых из поиска
  
  continuationToken - Токен, сигнализирующий о том, что в ответе передана только часть данных. Для получения следующей части нужно повторно обратиться к сервису, указав тот же набор условий и полученый токен. Если токена нет, получена последняя часть данных.
  
  Returns:
  
  InlineResponse2009
  
  Throws:
  
  org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
- searchPayments
  
  public InlineResponse20010 searchPayments(String xRequestID, String partyID, OffsetDateTime fromTime, OffsetDateTime toTime, Integer limit, String xRequestDeadline, String shopID, List<String> shopIDs, String paymentInstitutionRealm, List<String> invoiceIDs, String paymentStatus, String paymentFlow, String paymentMethod, String paymentTerminalProvider, String invoiceID, String paymentID, String externalID, String payerEmail, String payerIP, String payerFingerprint, String customerID, String first6, String last4, String rrn, String approvalCode, String bankCardTokenProvider, String bankCardPaymentSystem, Long paymentAmountFrom, Long paymentAmountTo, List<String> excludedShops, String continuationToken) throws org.springframework.web.client.RestClientException
  
  Поиск платежей
  200 - Найденные платежи
  400 - Неверные данные
  401 - Ошибка авторизации
  404 - Заданный ресурс не найден
  
  Parameters:
  
  xRequestID - Уникальный идентификатор запроса к системе
  
  partyID - Уникальный идентификатор участника в рамках платформы
  
  fromTime - Начало временного отрезка
  
  toTime - Конец временного отрезка
  
  limit - Лимит выборки
  
  xRequestDeadline - Максимальное время обработки запроса
  
  shopID - Идентификатор магазина
  
  shopIDs - Идентификаторы магазинов
  
  paymentInstitutionRealm - Тип магазина, тестовый или «боевой»
  
  invoiceIDs - Список инвойсов
  
  paymentStatus - Статус платежа для поиска
  
  paymentFlow - Flow платежа
  
  paymentMethod - Метод оплаты
  
  paymentTerminalProvider - Провайдер платежного терминала
  
  invoiceID - Идентификатор инвойса
  
  paymentID - Идентификатор платежа
  
  externalID - Внешний идентификатор
  
  payerEmail - Email, указанный при оплате
  
  payerIP - IP-адрес плательщика
  
  payerFingerprint - Уникальный отпечаток user agent'а плательщика
  
  customerID - Идентификатор плательщика
  
  first6 - Первые 6 цифр номера карты
  
  last4 - Последние 4 цифры номера карты
  
  rrn - Retrieval Reference Number
  
  approvalCode - Authorization Approval Code
  
  bankCardTokenProvider - Провайдер платежных токенов
  
  bankCardPaymentSystem - Платежная система
  
  paymentAmountFrom - Минимальная сумма платежа
  
  paymentAmountTo - Максимальная сумма платежа
  
  excludedShops - Идентификаторы магазинов, исключаемых из поиска
  
  continuationToken - Токен, сигнализирующий о том, что в ответе передана только часть данных. Для получения следующей части нужно повторно обратиться к сервису, указав тот же набор условий и полученый токен. Если токена нет, получена последняя часть данных.
  
  Returns:
  
  InlineResponse20010
  
  Throws:
  
  org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
- searchPayouts
  
  public InlineResponse20011 searchPayouts(String xRequestID, String partyID, OffsetDateTime fromTime, OffsetDateTime toTime, Integer limit, String xRequestDeadline, String shopID, List<String> shopIDs, String paymentInstitutionRealm, Integer offset, String payoutID, String payoutToolType, List<String> excludedShops, String continuationToken) throws org.springframework.web.client.RestClientException
  
  Поиск выплат
  200 - Найденные выплаты
  400 - Неверные данные
  401 - Ошибка авторизации
  404 - Заданный ресурс не найден
  
  Parameters:
  
  xRequestID - Уникальный идентификатор запроса к системе
  
  partyID - Уникальный идентификатор участника в рамках платформы
  
  fromTime - Начало временного отрезка
  
  toTime - Конец временного отрезка
  
  limit - Лимит выборки
  
  xRequestDeadline - Максимальное время обработки запроса
  
  shopID - Идентификатор магазина
  
  shopIDs - Идентификаторы магазинов
  
  paymentInstitutionRealm - Тип магазина, тестовый или «боевой»
  
  offset - Смещение выборки
  
  payoutID - Идентификатор выплаты
  
  payoutToolType - Тип выплаты для поиска * PayoutAccount - выплата на банковский счёт * Wallet - выплата на кошелёк * PaymentInstitutionAccount - выплата на счёт платежной организации
  
  excludedShops - Идентификаторы магазинов, исключаемых из поиска
  
  continuationToken - Токен, сигнализирующий о том, что в ответе передана только часть данных. Для получения следующей части нужно повторно обратиться к сервису, указав тот же набор условий и полученый токен. Если токена нет, получена последняя часть данных.
  
  Returns:
  
  InlineResponse20011
  
  Throws:
  
  org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API
- searchRefunds
  
  public InlineResponse20012 searchRefunds(String xRequestID, String partyID, OffsetDateTime fromTime, OffsetDateTime toTime, Integer limit, String xRequestDeadline, String shopID, List<String> shopIDs, String paymentInstitutionRealm, Integer offset, List<String> invoiceIDs, String invoiceID, String paymentID, String refundID, String externalID, String refundStatus, List<String> excludedShops, String continuationToken) throws org.springframework.web.client.RestClientException
  
  Поиск возвратов
  200 - Найденные возвраты
  400 - Неверные данные
  401 - Ошибка авторизации
  404 - Заданный ресурс не найден
  
  Parameters:
  
  xRequestID - Уникальный идентификатор запроса к системе
  
  partyID - Уникальный идентификатор участника в рамках платформы
  
  fromTime - Начало временного отрезка
  
  toTime - Конец временного отрезка
  
  limit - Лимит выборки
  
  xRequestDeadline - Максимальное время обработки запроса
  
  shopID - Идентификатор магазина
  
  shopIDs - Идентификаторы магазинов
  
  paymentInstitutionRealm - Тип магазина, тестовый или «боевой»
  
  offset - Смещение выборки
  
  invoiceIDs - Список инвойсов
  
  invoiceID - Идентификатор инвойса
  
  paymentID - Идентификатор платежа
  
  refundID - Идентификатор возврата
  
  externalID - Внешний идентификатор
  
  refundStatus - Статус возврата
  
  excludedShops - Идентификаторы магазинов, исключаемых из поиска
  
  continuationToken - Токен, сигнализирующий о том, что в ответе передана только часть данных. Для получения следующей части нужно повторно обратиться к сервису, указав тот же набор условий и полученый токен. Если токена нет, получена последняя часть данных.
  
  Returns:
  
  InlineResponse20012
  
  Throws:
  
  org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

Constructors
Constructor	Description
`SearchApi()`
`SearchApi(ApiClient apiClient)`

Class SearchApi

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Details

SearchApi

SearchApi

Method Details

getApiClient

setApiClient

searchChargebacks

searchInvoices

searchPayments

searchPayouts

searchRefunds