Class: Vk::API::Orders::Methods::Get

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

Overview

Returns a list of orders.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :count (Integer)

    number of returned orders.

  • :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.rb', line 15

Instance Method Details

#countInteger

Returns number of returned orders.

Returns:

  • (Integer)

    number of returned orders.


24
# File 'lib/vk/api/orders/methods/get.rb', line 24

attribute :count, API::Types::Coercible::Int.optional.default(100)

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


26
# File 'lib/vk/api/orders/methods/get.rb', line 26

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