Class: DeliveryFivePostClient::Resources::API::V1::Partners::Tasks::Report::Avds

Inherits:
Object
  • Object
show all
Defined in:
lib/delivery_five_post_client/resources/api/v1/partners/tasks/report/avds.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Avds

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Avds.

Parameters:



88
89
90
 
# File 'lib/delivery_five_post_client/resources/api/v1/partners/tasks/report/avds.rb', line 88

def initialize(client:)
  @client = client
end

Instance Method Details

#create(date_from:, date_to:, request_options: {}) ⇒ DeliveryFivePostClient::Models::API::V1::Partners::Tasks::Report::AvdCreateResponse

Создание задачи на формирование отчета о переводе денежных средств партнеру / Create task for AVDS report generation

Parameters:

  • date_from (Date) —

    Дата начала периода / Start date

  • date_to (Date) —

    Дата окончания периода / End date

  • request_options (DeliveryFivePostClient::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/delivery_five_post_client/resources/api/v1/partners/tasks/report/avds.rb', line 25

def create(params)
  parsed, options =
    DeliveryFivePostClient::API::V1::Partners::Tasks::Report::AvdCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "api/v1/partners/tasks/report/avds",
    body: parsed,
    model: DeliveryFivePostClient::Models::API::V1::Partners::Tasks::Report::AvdCreateResponse,
    options: options
  )
end

#result(task_id:, request_options: {}) ⇒ StringIO

Получение сформированного отчета (Excel файл). Срок хранения: 30 дней / Get generated report (Excel file). Storage period: 30 days

Parameters:

Returns:

  • (StringIO)

See Also:



49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/delivery_five_post_client/resources/api/v1/partners/tasks/report/avds.rb', line 49

def result(params)
  parsed, options =
    DeliveryFivePostClient::API::V1::Partners::Tasks::Report::AvdResultParams.dump_request(params)
  @client.request(
    method: :post,
    path: "api/v1/partners/tasks/report/avds/result",
    headers: {"accept" => "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"},
    body: parsed,
    model: StringIO,
    options: options
  )
end

#status(task_id:, request_options: {}) ⇒ DeliveryFivePostClient::Models::API::V1::Partners::Tasks::Report::AvdStatusResponse

Получение статуса задачи формирования отчета / Get report task status

Parameters:

Returns:

See Also:



73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/delivery_five_post_client/resources/api/v1/partners/tasks/report/avds.rb', line 73

def status(params)
  parsed, options =
    DeliveryFivePostClient::API::V1::Partners::Tasks::Report::AvdStatusParams.dump_request(params)
  @client.request(
    method: :post,
    path: "api/v1/partners/tasks/report/avds/status",
    body: parsed,
    model: DeliveryFivePostClient::Models::API::V1::Partners::Tasks::Report::AvdStatusResponse,
    options: options
  )
end