Class: DeliveryFivePostClient::Resources::API::V1::Partners

Inherits:
Object
  • Object
show all
Defined in:
lib/delivery_five_post_client/resources/api/v1/partners.rb,
lib/delivery_five_post_client/resources/api/v1/partners/jwt.rb,
lib/delivery_five_post_client/resources/api/v1/partners/tasks.rb,
lib/delivery_five_post_client/resources/api/v1/partners/orders.rb,
lib/delivery_five_post_client/resources/api/v1/partners/return_.rb,
lib/delivery_five_post_client/resources/api/v1/partners/warehouse.rb,
lib/delivery_five_post_client/resources/api/v1/partners/redirection.rb,
lib/delivery_five_post_client/resources/api/v1/partners/orders/cargo.rb,
lib/delivery_five_post_client/resources/api/v1/partners/tasks/report.rb,
lib/delivery_five_post_client/resources/api/v1/partners/partner_supply.rb,
lib/delivery_five_post_client/resources/api/v1/partners/tasks/report/avds.rb,
lib/delivery_five_post_client/resources/api/v1/partners/extend_storage_days.rb

Defined Under Namespace

Classes: ExtendStorageDays, Jwt, Orders, PartnerSupply, Redirection, Return, Tasks, Warehouse

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Partners

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 Partners.

Parameters:



381
382
383
384
385
386
387
388
389
390
391
392
 
# File 'lib/delivery_five_post_client/resources/api/v1/partners.rb', line 381

def initialize(client:)
  @client = client
  @extend_storage_days =
    DeliveryFivePostClient::Resources::API::V1::Partners::ExtendStorageDays.new(client: client)
  @jwt = DeliveryFivePostClient::Resources::API::V1::Partners::Jwt.new(client: client)
  @orders = DeliveryFivePostClient::Resources::API::V1::Partners::Orders.new(client: client)
  @partner_supply = DeliveryFivePostClient::Resources::API::V1::Partners::PartnerSupply.new(client: client)
  @redirection = DeliveryFivePostClient::Resources::API::V1::Partners::Redirection.new(client: client)
  @return_ = DeliveryFivePostClient::Resources::API::V1::Partners::Return.new(client: client)
  @tasks = DeliveryFivePostClient::Resources::API::V1::Partners::Tasks.new(client: client)
  @warehouse = DeliveryFivePostClient::Resources::API::V1::Partners::Warehouse.new(client: client)
end

Instance Attribute Details

#extend_storage_days ⇒ DeliveryFivePostClient::Resources::API::V1::Partners::ExtendStorageDays (readonly)

Returns:



9
10
11
 
# File 'lib/delivery_five_post_client/resources/api/v1/partners.rb', line 9

def extend_storage_days
  @extend_storage_days
end

#jwt ⇒ DeliveryFivePostClient::Resources::API::V1::Partners::Jwt (readonly)

Returns:



12
13
14
 
# File 'lib/delivery_five_post_client/resources/api/v1/partners.rb', line 12

def jwt
  @jwt
end

#orders ⇒ DeliveryFivePostClient::Resources::API::V1::Partners::Orders (readonly)

Returns:



15
16
17
 
# File 'lib/delivery_five_post_client/resources/api/v1/partners.rb', line 15

def orders
  @orders
end

#partner_supply ⇒ DeliveryFivePostClient::Resources::API::V1::Partners::PartnerSupply (readonly)

Returns:



18
19
20
 
# File 'lib/delivery_five_post_client/resources/api/v1/partners.rb', line 18

def partner_supply
  @partner_supply
end

#redirection ⇒ DeliveryFivePostClient::Resources::API::V1::Partners::Redirection (readonly)

Returns:



21
22
23
 
# File 'lib/delivery_five_post_client/resources/api/v1/partners.rb', line 21

def redirection
  @redirection
end

#return_ ⇒ DeliveryFivePostClient::Resources::API::V1::Partners::Return (readonly)

Returns:



24
25
26
 
# File 'lib/delivery_five_post_client/resources/api/v1/partners.rb', line 24

def return_
  @return_
end

#tasks ⇒ DeliveryFivePostClient::Resources::API::V1::Partners::Tasks (readonly)

Returns:



27
28
29
 
# File 'lib/delivery_five_post_client/resources/api/v1/partners.rb', line 27

def tasks
  @tasks
end

#warehouse ⇒ DeliveryFivePostClient::Resources::API::V1::Partners::Warehouse (readonly)

Returns:



30
31
32
 
# File 'lib/delivery_five_post_client/resources/api/v1/partners.rb', line 30

def warehouse
  @warehouse
end

Instance Method Details

#create_order(cargoes:, client:, cost:, receiver:, sender_order_id:, warehouse:, brand_name: nil, client_order_id: nil, request_options: {}) ⇒ DeliveryFivePostClient::Models::API::V1::OrderCreateResponse

Deprecated.

Создание одноместного заказа (УСТАРЕЛ) / Create single-cargo order (DEPRECATED)

Parameters:

Returns:

See Also:



79
80
81
82
83
84
85
86
87
88
 
# File 'lib/delivery_five_post_client/resources/api/v1/partners.rb', line 79

def create_order(params)
  parsed, options = DeliveryFivePostClient::API::V1::PartnerCreateOrderParams.dump_request(params)
  @client.request(
    method: :post,
    path: "api/v1/partners/createOrder",
    body: parsed,
    model: DeliveryFivePostClient::API::V1::OrderCreateResponse,
    options: options
  )
end

#delivery_params(city: nil, region: nil, request_options: {}) ⇒ DeliveryFivePostClient::Models::API::V1::PartnerDeliveryParamsResponse

Получение географии курьерской доставки до двери / Get courier delivery geography

Parameters:

Returns:

See Also:



104
105
106
107
108
109
110
111
112
113
 
# File 'lib/delivery_five_post_client/resources/api/v1/partners.rb', line 104

def delivery_params(params = {})
  parsed, options = DeliveryFivePostClient::API::V1::PartnerDeliveryParamsParams.dump_request(params)
  @client.request(
    method: :post,
    path: "api/v1/partners/deliveryParams",
    body: parsed,
    model: DeliveryFivePostClient::Models::API::V1::PartnerDeliveryParamsResponse,
    options: options
  )
end

#delivery_to_address(delivery_address:, dimensions:, sender_location_id:, weight:, request_options: {}) ⇒ DeliveryFivePostClient::Models::API::V1::PartnerDeliveryToAddressResponse

Расчет итоговой стоимости доставки до адреса / Calculate final delivery cost to address

Parameters:

Returns:

See Also:



133
134
135
136
137
138
139
140
141
142
 
# File 'lib/delivery_five_post_client/resources/api/v1/partners.rb', line 133

def delivery_to_address(params)
  parsed, options = DeliveryFivePostClient::API::V1::PartnerDeliveryToAddressParams.dump_request(params)
  @client.request(
    method: :post,
    path: "api/v1/partners/deliveryToAddress",
    body: parsed,
    model: DeliveryFivePostClient::Models::API::V1::PartnerDeliveryToAddressResponse,
    options: options
  )
end

#get_actual_cargo_size(cargo_id:, request_options: {}) ⇒ DeliveryFivePostClient::Models::API::V1::PartnerGetActualCargoSizeResponse

Получение актуальных ВГХ / Get actual dimensions

Parameters:

Returns:

See Also:



155
156
157
158
159
160
161
162
163
164
 
# File 'lib/delivery_five_post_client/resources/api/v1/partners.rb', line 155

def get_actual_cargo_size(params)
  parsed, options = DeliveryFivePostClient::API::V1::PartnerGetActualCargoSizeParams.dump_request(params)
  @client.request(
    method: :post,
    path: "api/v1/partners/getActualCargoSize",
    body: parsed,
    model: DeliveryFivePostClient::Models::API::V1::PartnerGetActualCargoSizeResponse,
    options: options
  )
end

#get_cargo_status(cargo_ids: nil, sender_cargo_ids: nil, request_options: {}) ⇒ DeliveryFivePostClient::Models::API::V1::PartnerGetCargoStatusResponse

Получение статуса грузомест / Get cargo status

Parameters:

  • cargo_ids (Array<String>) —

    Массив UUID грузомест / Array of cargo UUIDs

  • sender_cargo_ids (Array<String>) —

    Массив ID грузомест партнера / Array of partner cargo IDs

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

Returns:

See Also:



179
180
181
182
183
184
185
186
187
188
 
# File 'lib/delivery_five_post_client/resources/api/v1/partners.rb', line 179

def get_cargo_status(params = {})
  parsed, options = DeliveryFivePostClient::API::V1::PartnerGetCargoStatusParams.dump_request(params)
  @client.request(
    method: :post,
    path: "api/v1/partners/getCargoStatus",
    body: parsed,
    model: DeliveryFivePostClient::Models::API::V1::PartnerGetCargoStatusResponse,
    options: options
  )
end

#get_order_history_mass(order_ids: nil, sender_order_ids: nil, request_options: {}) ⇒ DeliveryFivePostClient::Models::API::V1::PartnerGetOrderHistoryMassResponse

Получение истории статусов заказа / Get order status history

Parameters:

  • order_ids (Array<String>) —

    Массив UUID заказов / Array of order UUIDs

  • sender_order_ids (Array<String>) —

    Массив ID заказов партнера / Array of partner order IDs

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

Returns:

See Also:



203
204
205
206
207
208
209
210
211
212
 
# File 'lib/delivery_five_post_client/resources/api/v1/partners.rb', line 203

def get_order_history_mass(params = {})
  parsed, options = DeliveryFivePostClient::API::V1::PartnerGetOrderHistoryMassParams.dump_request(params)
  @client.request(
    method: :post,
    path: "api/v1/partners/getOrderHistoryMass",
    body: parsed,
    model: DeliveryFivePostClient::Models::API::V1::PartnerGetOrderHistoryMassResponse,
    options: options
  )
end

#get_order_status(order_ids: nil, sender_order_ids: nil, request_options: {}) ⇒ DeliveryFivePostClient::Models::API::V1::PartnerGetOrderStatusResponse

Получение актуального статуса заказов / Get current order status

Parameters:

  • order_ids (Array<String>) —

    Массив UUID заказов / Array of order UUIDs

  • sender_order_ids (Array<String>) —

    Массив ID заказов партнера / Array of partner order IDs

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

Returns:

See Also:



227
228
229
230
231
232
233
234
235
236
 
# File 'lib/delivery_five_post_client/resources/api/v1/partners.rb', line 227

def get_order_status(params = {})
  parsed, options = DeliveryFivePostClient::API::V1::PartnerGetOrderStatusParams.dump_request(params)
  @client.request(
    method: :post,
    path: "api/v1/partners/getOrderStatus",
    body: parsed,
    model: DeliveryFivePostClient::Models::API::V1::PartnerGetOrderStatusResponse,
    options: options
  )
end

#get_receipts(order_ids:, request_options: {}) ⇒ DeliveryFivePostClient::Models::API::V1::PartnerGetReceiptsResponse

Получение чеков / Get receipts

Parameters:

Returns:

See Also:



249
250
251
252
253
254
255
256
257
258
 
# File 'lib/delivery_five_post_client/resources/api/v1/partners.rb', line 249

def get_receipts(params)
  parsed, options = DeliveryFivePostClient::API::V1::PartnerGetReceiptsParams.dump_request(params)
  @client.request(
    method: :post,
    path: "api/v1/partners/getReceipts",
    body: parsed,
    model: DeliveryFivePostClient::Models::API::V1::PartnerGetReceiptsResponse,
    options: options
  )
end

#get_receiver_locations(order_ids:, request_options: {}) ⇒ DeliveryFivePostClient::Models::API::V1::PartnerGetReceiverLocationsResponse

Информация о переадресации / Redirection information

Parameters:

Returns:

See Also:



271
272
273
274
275
276
277
278
279
280
 
# File 'lib/delivery_five_post_client/resources/api/v1/partners.rb', line 271

def get_receiver_locations(params)
  parsed, options = DeliveryFivePostClient::API::V1::PartnerGetReceiverLocationsParams.dump_request(params)
  @client.request(
    method: :post,
    path: "api/v1/partners/getReceiverLocations",
    body: parsed,
    model: DeliveryFivePostClient::Models::API::V1::PartnerGetReceiverLocationsResponse,
    options: options
  )
end

#get_security_code(order_ids:, request_options: {}) ⇒ DeliveryFivePostClient::Models::API::V1::PartnerGetSecurityCodeResponse

Получение кода выдачи / Get security code

Parameters:

Returns:

See Also:



293
294
295
296
297
298
299
300
301
302
 
# File 'lib/delivery_five_post_client/resources/api/v1/partners.rb', line 293

def get_security_code(params)
  parsed, options = DeliveryFivePostClient::API::V1::PartnerGetSecurityCodeParams.dump_request(params)
  @client.request(
    method: :post,
    path: "api/v1/partners/getSecurityCode",
    body: parsed,
    model: DeliveryFivePostClient::Models::API::V1::PartnerGetSecurityCodeResponse,
    options: options
  )
end

#order_labels(order_ids:, format_: nil, unified: nil, request_options: {}) ⇒ DeliveryFivePostClient::Models::API::V1::PartnerOrderLabelsResponse

Получение этикеток / Get labels

Parameters:

Returns:

See Also:



319
320
321
322
323
324
325
326
327
328
 
# File 'lib/delivery_five_post_client/resources/api/v1/partners.rb', line 319

def order_labels(params)
  parsed, options = DeliveryFivePostClient::API::V1::PartnerOrderLabelsParams.dump_request(params)
  @client.request(
    method: :post,
    path: "api/v1/partners/orderLabels",
    body: parsed,
    model: DeliveryFivePostClient::Models::API::V1::PartnerOrderLabelsResponse,
    options: options
  )
end

#pickup_points(active: nil, city: nil, mdm_code: nil, ready: nil, region: nil, request_options: {}) ⇒ DeliveryFivePostClient::Models::API::V1::PartnerPickupPointsResponse

Получение списка точек выдачи / Get pickup points list

Parameters:

  • active (Boolean) —

    Фильтр по активности / Filter by active status

  • city (String) —

    Фильтр по городу / Filter by city

  • mdm_code (String) —

    Поиск по MDM коду / Search by MDM code

  • ready (Boolean) —

    Фильтр по готовности / Filter by ready status

  • region (String) —

    Фильтр по региону / Filter by region

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

Returns:

See Also:



349
350
351
352
353
354
355
356
357
358
 
# File 'lib/delivery_five_post_client/resources/api/v1/partners.rb', line 349

def pickup_points(params = {})
  parsed, options = DeliveryFivePostClient::API::V1::PartnerPickupPointsParams.dump_request(params)
  @client.request(
    method: :post,
    path: "api/v1/partners/pickupPoints",
    body: parsed,
    model: DeliveryFivePostClient::Models::API::V1::PartnerPickupPointsResponse,
    options: options
  )
end

#retrieve(order_id, request_options: {}) ⇒ DeliveryFivePostClient::Models::API::V1::PartnerRetrieveResponse

Срок хранения заказа / Order storage expiration

Parameters:

Returns:

See Also:



43
44
45
46
47
48
49
50
 
# File 'lib/delivery_five_post_client/resources/api/v1/partners.rb', line 43

def retrieve(order_id, params = {})
  @client.request(
    method: :get,
    path: ["api/v1/partners/getExpirationDate/%1$s", order_id],
    model: DeliveryFivePostClient::Models::API::V1::PartnerRetrieveResponse,
    options: params[:request_options]
  )
end

#retrieve_warehouse_all(request_options: {}) ⇒ DeliveryFivePostClient::Models::API::V1::PartnerRetrieveWarehouseAllResponse

Получение списка всех складов / Get list of all warehouses

Parameters:

Returns:

See Also:



369
370
371
372
373
374
375
376
 
# File 'lib/delivery_five_post_client/resources/api/v1/partners.rb', line 369

def retrieve_warehouse_all(params = {})
  @client.request(
    method: :get,
    path: "api/v1/partners/warehouseAll",
    model: DeliveryFivePostClient::Models::API::V1::PartnerRetrieveWarehouseAllResponse,
    options: params[:request_options]
  )
end