Class: Vk::API::Market::Methods::Add

Inherits:

Schema::Method

• Object
• Dry::Struct
• Schema::Method
• Vk::API::Market::Methods::Add

Defined in:

lib/vk/api/market/methods/add.rb

Overview

Ads a new item to the market.

Arguments

• #category_id ⇒ Integer

  Item category ID.

• #deleted ⇒ Boolean

  Item status ('1' — deleted, '0' — not deleted).

• #description ⇒ String

  Item description.

• #main_photo_id ⇒ Integer

  Cover photo ID.

• #name ⇒ String

  Item name.

• #owner_id ⇒ Integer

  ID of an item owner community.

• #photo_ids ⇒ Array

  IDs of additional photos.

• #price ⇒ Number

  Item price.

Instance Method Summary

• #initialize(arguments) ⇒ Market::Methods::Add constructor

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

#initialize(arguments) ⇒ Market::Methods::Add

Parameters:

• arguments (Hash)

Options Hash (arguments):

• :owner_id (Integer) —

  ID of an item owner community.

• :name (String) —

  Item name.

• :description (String) —

  Item description.

• :category_id (Integer) —

  Item category ID.

• :price (Number) —

  Item price.

• :deleted (Boolean) —

  Item status ('1' — deleted, '0' — not deleted).

• :main_photo_id (Integer) —

  Cover photo ID.

• :photo_ids (Array) —

  IDs of additional photos.

# File 'lib/vk/api/market/methods/add.rb', line 15

Instance Method Details

#category_id ⇒ Integer

Returns Item category ID.

Returns:

• (Integer) —

  Item category ID.

# File 'lib/vk/api/market/methods/add.rb', line 36

attribute :category_id, API::Types::Coercible::Int

#deleted ⇒ Boolean

Returns Item status ('1' — deleted, '0' — not deleted).

Returns:

• (Boolean) —

  Item status ('1' — deleted, '0' — not deleted).

# File 'lib/vk/api/market/methods/add.rb', line 40

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

#description ⇒ String

Returns Item description.

Returns:

• (String) —

  Item description.

# File 'lib/vk/api/market/methods/add.rb', line 34

attribute :description, API::Types::Coercible::String

#main_photo_id ⇒ Integer

Returns Cover photo ID.

Returns:

• (Integer) —

  Cover photo ID.

# File 'lib/vk/api/market/methods/add.rb', line 42

attribute :main_photo_id, API::Types::Coercible::Int

#name ⇒ String

Returns Item name.

Returns:

• (String) —

  Item name.

# File 'lib/vk/api/market/methods/add.rb', line 32

attribute :name, API::Types::Coercible::String

#owner_id ⇒ Integer

Returns ID of an item owner community.

Returns:

• (Integer) —

  ID of an item owner community.

# File 'lib/vk/api/market/methods/add.rb', line 30

attribute :owner_id, API::Types::Coercible::Int

#photo_ids ⇒ Array

Returns IDs of additional photos.

Returns:

• (Array) —

  IDs of additional photos.

# File 'lib/vk/api/market/methods/add.rb', line 44

attribute :photo_ids, API::Types::Coercible::Array.member(API::Types::Coercible::Int).constrained(max_size: 4).optional.default(nil)

#price ⇒ Number

Returns Item price.

Returns:

• (Number) —

  Item price.

# File 'lib/vk/api/market/methods/add.rb', line 38

attribute :price, API::Types::Coercible::Int