Contents

# frozen_string_literal: true
require 'vk/api/methods'

module Vk
  module API
    class Orders < Vk::Schema::Namespace
      module Methods
        # Returns information about orders by their IDs.
        class GetById < Schema::Method
          # @!group Properties

          self.open = false
          self.method = 'orders.getById'

          # @method initialize(arguments)
          #   @param [Hash] arguments
          #   @option arguments [Integer] :order_id order ID.
          #   @option arguments [Array] :order_ids order IDs (when information about several orders is requested).
          #   @option arguments [Boolean] :test_mode if this parameter is set to 1, this method returns a list of test mode orders. By default — 0.
          #   @return [Orders::Methods::GetById]

          # @!group Arguments

          # @return [Integer] order ID.
          attribute :order_id, API::Types::Coercible::Int.optional
          # @return [Array] order IDs (when information about several orders is requested).
          attribute :order_ids, API::Types::Coercible::Array.optional
          # @return [Boolean] if this parameter is set to 1, this method returns a list of test mode orders. By default — 0.
          attribute :test_mode, API::Types::Bool.optional
        end
      end
    end
  end
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
vk-0.99.5.53.alpha	lib/vk/api/orders/methods/get_by_id.rb