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

Inherits:

Schema::Method

• Object
• Dry::Struct
• Schema::Method
• Vk::API::Orders::Methods::Get

Defined in:

lib/vk/api/orders/methods/get.rb

Overview

Returns a list of orders.

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.

Instance Method Summary

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

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

#count ⇒ Integer

Returns number of returned orders.

Returns:

• (Integer) —

  number of returned orders.

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

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

#test_mode ⇒ Boolean

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.

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

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