Class: DeliveryFivePostClient::Resources::API::V1::Partners::Orders::Cargo

Inherits:
Object
  • Object
show all
Defined in:
lib/delivery_five_post_client/resources/api/v1/partners/orders/cargo.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Cargo

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

Parameters:



129
130
131
 
# File 'lib/delivery_five_post_client/resources/api/v1/partners/orders/cargo.rb', line 129

def initialize(client:)
  @client = client
end

Instance Method Details

#create(order_id, height:, length:, price:, product_values:, sender_cargo_id:, weight:, width:, barcode: nil, vat: nil, vendor: nil, request_options: {}) ⇒ DeliveryFivePostClient::Models::API::V1::Partners::Orders::CargoCreatedInfo

Добавление грузоместа / Add cargo

Parameters:

Returns:

See Also:



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

def create(order_id, params)
  parsed, options =
    DeliveryFivePostClient::API::V1::Partners::Orders::CargoCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["api/v1/partners/orders/%1$s/cargo", order_id],
    body: parsed,
    model: DeliveryFivePostClient::API::V1::Partners::Orders::CargoCreatedInfo,
    options: options
  )
end

#delete(cargo_id, order_id:, request_options: {}) ⇒ nil

Удаление грузоместа / Delete cargo

Parameters:

  • cargo_id (String) —

    UUID в формате v4 / UUID in v4 format

  • order_id (String) —

    UUID в формате v4 / UUID in v4 format

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

Returns:

  • (nil)

See Also:



111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/delivery_five_post_client/resources/api/v1/partners/orders/cargo.rb', line 111

def delete(cargo_id, params)
  parsed, options =
    DeliveryFivePostClient::API::V1::Partners::Orders::CargoDeleteParams.dump_request(params)
  order_id =
    parsed.delete(:order_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :delete,
    path: ["api/v1/partners/orders/%1$s/cargo/%2$s", order_id, cargo_id],
    model: NilClass,
    options: options
  )
end

#update(cargo_id, order_id:, height: nil, length: nil, price: nil, product_values: nil, vat: nil, vendor: nil, weight: nil, width: nil, request_options: {}) ⇒ nil

Обновление грузоместа / Update cargo

Parameters:

Returns:

  • (nil)

See Also:



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/delivery_five_post_client/resources/api/v1/partners/orders/cargo.rb', line 82

def update(cargo_id, params)
  parsed, options =
    DeliveryFivePostClient::API::V1::Partners::Orders::CargoUpdateParams.dump_request(params)
  order_id =
    parsed.delete(:order_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :put,
    path: ["api/v1/partners/orders/%1$s/cargo/%2$s", order_id, cargo_id],
    body: parsed,
    model: NilClass,
    options: options
  )
end