Class: Vk::API::Auth::Methods::Confirm

Inherits:

Schema::Method

• Object
• Dry::Struct
• Schema::Method
• Vk::API::Auth::Methods::Confirm

Defined in:

lib/vk/api/auth/methods/confirm.rb

Overview

Completes a user's registration (begun with the method) using an authorization code.

Arguments

• #client_id ⇒ Integer
• #client_secret ⇒ String
• #code ⇒ String
• #intro ⇒ Integer
• #password ⇒ String
• #phone ⇒ String
• #test_mode ⇒ Boolean

Instance Method Summary

• #initialize(arguments) ⇒ Auth::Methods::Confirm constructor

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

#initialize(arguments) ⇒ Auth::Methods::Confirm

Parameters:

• arguments (Hash)

Options Hash (arguments):

• :client_id (Integer) —

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

• :client_secret (String) —

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

• :phone (String) —

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

• :code (String) —

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

• :password (String) —

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

• :test_mode (Boolean) —

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

• :intro (Integer) —

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

# File 'lib/vk/api/auth/methods/confirm.rb', line 15

Instance Method Details

#client_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/auth/methods/confirm.rb', line 29

attribute :client_id, API::Types::Coercible::Int

#client_secret ⇒ String

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

Returns:

• (String) —

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

# File 'lib/vk/api/auth/methods/confirm.rb', line 31

attribute :client_secret, API::Types::Coercible::String

#code ⇒ String

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

Returns:

• (String) —

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

# File 'lib/vk/api/auth/methods/confirm.rb', line 35

attribute :code, API::Types::Coercible::String

#intro ⇒ 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/auth/methods/confirm.rb', line 41

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

#password ⇒ String

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

Returns:

• (String) —

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

# File 'lib/vk/api/auth/methods/confirm.rb', line 37

attribute :password, API::Types::Coercible::String.optional.default(nil)

#phone ⇒ String

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

Returns:

• (String) —

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

# File 'lib/vk/api/auth/methods/confirm.rb', line 33

attribute :phone, API::Types::Coercible::String

#test_mode ⇒ Boolean

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

Returns:

• (Boolean) —

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

# File 'lib/vk/api/auth/methods/confirm.rb', line 39

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