Class: Vk::API::Orders::Methods::GetById

Inherits:
Schema::Method show all
Defined in:
lib/vk/api/orders/methods/get_by_id.rb

Overview

Returns information about orders by their IDs.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

#initialize(arguments) ⇒ Orders::Methods::GetById

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :order_id (Integer)

    order ID.

  • :order_ids (Array)

    order IDs (when information about several orders is requested).

  • :test_mode (Boolean)

    if this parameter is set to 1, this method returns a list of test mode orders. By default — 0.


# File 'lib/vk/api/orders/methods/get_by_id.rb', line 15

Instance Method Details

#order_idInteger

Returns order ID.

Returns:

  • (Integer)

    order ID.


25
# File 'lib/vk/api/orders/methods/get_by_id.rb', line 25

attribute :order_id, API::Types::Coercible::Int.optional.default(nil)

#order_idsArray

Returns order IDs (when information about several orders is requested).

Returns:

  • (Array)

    order IDs (when information about several orders is requested).


27
# File 'lib/vk/api/orders/methods/get_by_id.rb', line 27

attribute :order_ids, API::Types::Coercible::Array.member(API::Types::Coercible::Int).optional.default(nil)

#test_modeBoolean

Returns if this parameter is set to 1, this method returns a list of test mode orders. By default — 0.

Returns:

  • (Boolean)

    if this parameter is set to 1, this method returns a list of test mode orders. By default — 0.


29
# File 'lib/vk/api/orders/methods/get_by_id.rb', line 29

attribute :test_mode, API::Types::Form::Bool.optional.default(nil)