Class: Vk::API::Secure::Methods::GetSmsHistory

Inherits:

Schema::Method

• Object
• Dry::Struct
• Schema::Method
• Vk::API::Secure::Methods::GetSmsHistory

Defined in:

lib/vk/api/secure/methods/get_sms_history.rb

Overview

Shows a list of SMS notifications sent by the application using method.

Arguments

• #date_from ⇒ Integer

  Filter by start date.

• #date_to ⇒ Integer

  Filter by end date.

• #limit ⇒ Integer

  Number of returned posts.

• #user_id ⇒ Integer

Instance Method Summary

• #initialize(arguments) ⇒ Secure::Methods::GetSmsHistory constructor

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

#initialize(arguments) ⇒ Secure::Methods::GetSmsHistory

Parameters:

• arguments (Hash)

Options Hash (arguments):

• :user_id (Integer) —

  @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json

• :date_from (Integer) —

  filter by start date. It is set as UNIX-time.

• :date_to (Integer) —

  filter by end date. It is set as UNIX-time.

• :limit (Integer) —

  number of returned posts. By default — 1000.

# File 'lib/vk/api/secure/methods/get_sms_history.rb', line 15

Instance Method Details

#date_from ⇒ Integer

Returns filter by start date. It is set as UNIX-time.

Returns:

• (Integer) —

  filter by start date. It is set as UNIX-time.

# File 'lib/vk/api/secure/methods/get_sms_history.rb', line 28

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

#date_to ⇒ Integer

Returns filter by end date. It is set as UNIX-time.

Returns:

• (Integer) —

  filter by end date. It is set as UNIX-time.

# File 'lib/vk/api/secure/methods/get_sms_history.rb', line 30

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

#limit ⇒ Integer

Returns number of returned posts. By default — 1000.

Returns:

• (Integer) —

  number of returned posts. By default — 1000.

# File 'lib/vk/api/secure/methods/get_sms_history.rb', line 32

attribute :limit, API::Types::Coercible::Int.optional.default(1000)

#user_id ⇒ Integer

Returns @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json.

Returns:

• (Integer) —

  @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json

# File 'lib/vk/api/secure/methods/get_sms_history.rb', line 26

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