Class: Vk::API::Orders::Methods::ChangeState

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

Overview

Changes order status.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :order_id (Integer)

    order ID.

  • :action (String)

    action to be done with the order. ; ; Available actions:; *cancel — to cancel unconfirmed order.; *charge — to confirm unconfirmed order. Applies only if processing of notification failed.; *refund — to cancel confirmed order.;

  • :app_order_id (Integer)

    internal ID of the order in the application.

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

Instance Method Details

#actionString

Returns action to be done with the order. ; ; Available actions:; *cancel — to cancel unconfirmed order.; *charge — to confirm unconfirmed order. Applies only if processing of notification failed.; *refund — to cancel confirmed order.;.

Returns:

  • (String)

    action to be done with the order. ; ; Available actions:; *cancel — to cancel unconfirmed order.; *charge — to confirm unconfirmed order. Applies only if processing of notification failed.; *refund — to cancel confirmed order.;


28
# File 'lib/vk/api/orders/methods/change_state.rb', line 28

attribute :action, API::Types::Coercible::String

#app_order_idInteger

Returns internal ID of the order in the application.

Returns:

  • (Integer)

    internal ID of the order in the application.


30
# File 'lib/vk/api/orders/methods/change_state.rb', line 30

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

#order_idInteger

Returns order ID.

Returns:

  • (Integer)

    order ID.


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

attribute :order_id, API::Types::Coercible::Int

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


32
# File 'lib/vk/api/orders/methods/change_state.rb', line 32

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