Class: Vk::API::Leads::Methods::GetUsers

Inherits:
Schema::Method show all
Defined in:
lib/vk/api/leads/methods/get_users.rb

Overview

Returns a list of last user actions for the offer.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

#initialize(arguments) ⇒ Leads::Methods::GetUsers

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :offer_id (Integer)

    Offer ID.

  • :secret (String)

    Secret key obtained in the lead testing interface.

  • :offset (Integer)

    Offset needed to return a specific subset of results.

  • :count (Integer)

    Number of results to return.

  • :status (Integer)

    Action type. Possible values:; *'0' — start;; *'1' — finish;; *'2' — blocking users;; *'3' — start in a test mode;; *'4' — finish in a test mode.;

  • :reverse (Boolean)

    Sort order. Possible values:; *'1' — chronological;; *'0' — reverse chronological.


# File 'lib/vk/api/leads/methods/get_users.rb', line 15

Instance Method Details

#countInteger

Returns Number of results to return.

Returns:

  • (Integer)

    Number of results to return.


34
# File 'lib/vk/api/leads/methods/get_users.rb', line 34

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

#offer_idInteger

Returns Offer ID.

Returns:

  • (Integer)

    Offer ID.


28
# File 'lib/vk/api/leads/methods/get_users.rb', line 28

attribute :offer_id, API::Types::Coercible::Int

#offsetInteger

Returns Offset needed to return a specific subset of results.

Returns:

  • (Integer)

    Offset needed to return a specific subset of results.


32
# File 'lib/vk/api/leads/methods/get_users.rb', line 32

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

#reverseBoolean

Returns Sort order. Possible values:; *'1' — chronological;; *'0' — reverse chronological.

Returns:

  • (Boolean)

    Sort order. Possible values:; *'1' — chronological;; *'0' — reverse chronological.


38
# File 'lib/vk/api/leads/methods/get_users.rb', line 38

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

#secretString

Returns Secret key obtained in the lead testing interface.

Returns:

  • (String)

    Secret key obtained in the lead testing interface.


30
# File 'lib/vk/api/leads/methods/get_users.rb', line 30

attribute :secret, API::Types::Coercible::String

#statusInteger

Returns Action type. Possible values:; *'0' — start;; *'1' — finish;; *'2' — blocking users;; *'3' — start in a test mode;; *'4' — finish in a test mode.;.

Returns:

  • (Integer)

    Action type. Possible values:; *'0' — start;; *'1' — finish;; *'2' — blocking users;; *'3' — start in a test mode;; *'4' — finish in a test mode.;


36
# File 'lib/vk/api/leads/methods/get_users.rb', line 36

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