vk 0.6.5.53 → 0.99.5.53.alpha

data/lib/vk/api/photos/methods/create_comment.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+require 'vk/api/methods'
+
+module Vk
+  module API
+    class Photos < Vk::Schema::Namespace
+      module Methods
+        # Adds a new comment on the photo.
+        class CreateComment < Schema::Method
+          # @!group Properties
+
+          self.open = false
+          self.method = 'photos.createComment'
+
+          # @method initialize(arguments)
+          #   @param [Hash] arguments
+          #   @option arguments [Integer] :owner_id ID of the user or community that owns the photo.
+          #   @option arguments [Integer] :photo_id Photo ID.
+          #   @option arguments [String] :message Comment text.
+          #   @option arguments [Array] :attachments (Required if 'message' is not set.) List of objects attached to the post, in the following format:; "<owner_id>_<media_id>,<owner_id>_<media_id>"; '' — Type of media attachment:; 'photo' — photo; 'video' — video; 'audio' — audio; 'doc' — document; '<owner_id>' — Media attachment owner ID.; '<media_id>' — Media attachment ID.; ; Example:; "photo100172_166443618,photo66748_265827614"
+          #   @option arguments [Boolean] :from_group '1' — to post a comment from the community
+          #   @option arguments [Integer] :reply_to_comment 
+          #   @option arguments [Integer] :sticker_id @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json
+          #   @option arguments [String] :access_key @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json
+          #   @option arguments [String] :guid @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json
+          #   @return [Photos::Methods::CreateComment]
+
+          # @!group Arguments
+
+          # @return [Integer] ID of the user or community that owns the photo.
+          attribute :owner_id, API::Types::Coercible::Int.optional
+          # @return [Integer] Photo ID.
+          attribute :photo_id, API::Types::Coercible::Int.optional
+          # @return [String] Comment text.
+          attribute :message, API::Types::Coercible::String.optional
+          # @return [Array] (Required if 'message' is not set.) List of objects attached to the post, in the following format:; "<owner_id>_<media_id>,<owner_id>_<media_id>"; '' — Type of media attachment:; 'photo' — photo; 'video' — video; 'audio' — audio; 'doc' — document; '<owner_id>' — Media attachment owner ID.; '<media_id>' — Media attachment ID.; ; Example:; "photo100172_166443618,photo66748_265827614"
+          attribute :attachments, API::Types::Coercible::Array.optional
+          # @return [Boolean] '1' — to post a comment from the community
+          attribute :from_group, API::Types::Bool.optional
+          # @return [Integer] 
+          attribute :reply_to_comment, API::Types::Coercible::Int.optional
+          # @return [Integer] @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json
+          attribute :sticker_id, API::Types::Coercible::Int.optional
+          # @return [String] @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json
+          attribute :access_key, API::Types::Coercible::String.optional
+          # @return [String] @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json
+          attribute :guid, API::Types::Coercible::String.optional
+        end
+      end
+    end
+  end
+end

data/lib/vk/api/photos/methods/delete.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+require 'vk/api/methods'
+
+module Vk
+  module API
+    class Photos < Vk::Schema::Namespace
+      module Methods
+        # Deletes a photo.
+        class Delete < Schema::Method
+          # @!group Properties
+
+          self.open = false
+          self.method = 'photos.delete'
+
+          # @method initialize(arguments)
+          #   @param [Hash] arguments
+          #   @option arguments [Integer] :owner_id ID of the user or community that owns the photo.
+          #   @option arguments [Integer] :photo_id Photo ID.
+          #   @return [Photos::Methods::Delete]
+
+          # @!group Arguments
+
+          # @return [Integer] ID of the user or community that owns the photo.
+          attribute :owner_id, API::Types::Coercible::Int.optional
+          # @return [Integer] Photo ID.
+          attribute :photo_id, API::Types::Coercible::Int.optional
+        end
+      end
+    end
+  end
+end

data/lib/vk/api/photos/methods/delete_album.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+require 'vk/api/methods'
+
+module Vk
+  module API
+    class Photos < Vk::Schema::Namespace
+      module Methods
+        # Deletes a photo album belonging to the current user.
+        class DeleteAlbum < Schema::Method
+          # @!group Properties
+
+          self.open = false
+          self.method = 'photos.deleteAlbum'
+
+          # @method initialize(arguments)
+          #   @param [Hash] arguments
+          #   @option arguments [Integer] :album_id Album ID.
+          #   @option arguments [Integer] :group_id ID of the community that owns the album.
+          #   @return [Photos::Methods::DeleteAlbum]
+
+          # @!group Arguments
+
+          # @return [Integer] Album ID.
+          attribute :album_id, API::Types::Coercible::Int.optional
+          # @return [Integer] ID of the community that owns the album.
+          attribute :group_id, API::Types::Coercible::Int.optional
+        end
+      end
+    end
+  end
+end

data/lib/vk/api/photos/methods/delete_comment.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+require 'vk/api/methods'
+
+module Vk
+  module API
+    class Photos < Vk::Schema::Namespace
+      module Methods
+        # Deletes a comment on the photo.
+        class DeleteComment < Schema::Method
+          # @!group Properties
+
+          self.open = false
+          self.method = 'photos.deleteComment'
+
+          # @method initialize(arguments)
+          #   @param [Hash] arguments
+          #   @option arguments [Integer] :owner_id ID of the user or community that owns the photo.
+          #   @option arguments [Integer] :comment_id Comment ID.
+          #   @return [Photos::Methods::DeleteComment]
+
+          # @!group Arguments
+
+          # @return [Integer] ID of the user or community that owns the photo.
+          attribute :owner_id, API::Types::Coercible::Int.optional
+          # @return [Integer] Comment ID.
+          attribute :comment_id, API::Types::Coercible::Int.optional
+        end
+      end
+    end
+  end
+end

data/lib/vk/api/photos/methods/edit.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+require 'vk/api/methods'
+
+module Vk
+  module API
+    class Photos < Vk::Schema::Namespace
+      module Methods
+        # Edits the caption of a photo.
+        class Edit < Schema::Method
+          # @!group Properties
+
+          self.open = false
+          self.method = 'photos.edit'
+
+          # @method initialize(arguments)
+          #   @param [Hash] arguments
+          #   @option arguments [Integer] :owner_id ID of the user or community that owns the photo.
+          #   @option arguments [Integer] :photo_id Photo ID.
+          #   @option arguments [String] :caption New caption for the photo. If this parameter is not set, it is considered to be equal to an empty string.
+          #   @option arguments [Number] :latitude @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json
+          #   @option arguments [Number] :longitude @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json
+          #   @option arguments [String] :place_str @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json
+          #   @option arguments [String] :foursquare_id @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json
+          #   @option arguments [Boolean] :delete_place @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json
+          #   @return [Photos::Methods::Edit]
+
+          # @!group Arguments
+
+          # @return [Integer] ID of the user or community that owns the photo.
+          attribute :owner_id, API::Types::Coercible::Int.optional
+          # @return [Integer] Photo ID.
+          attribute :photo_id, API::Types::Coercible::Int.optional
+          # @return [String] New caption for the photo. If this parameter is not set, it is considered to be equal to an empty string.
+          attribute :caption, API::Types::Coercible::String.optional
+          # @return [Number] @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json
+          attribute :latitude, API::Types::Coercible::Int.optional
+          # @return [Number] @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json
+          attribute :longitude, API::Types::Coercible::Int.optional
+          # @return [String] @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json
+          attribute :place_str, API::Types::Coercible::String.optional
+          # @return [String] @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json
+          attribute :foursquare_id, API::Types::Coercible::String.optional
+          # @return [Boolean] @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json
+          attribute :delete_place, API::Types::Bool.optional
+        end
+      end
+    end
+  end
+end

data/lib/vk/api/photos/methods/edit_album.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+require 'vk/api/methods'
+
+module Vk
+  module API
+    class Photos < Vk::Schema::Namespace
+      module Methods
+        # Edits information about a photo album.
+        class EditAlbum < Schema::Method
+          # @!group Properties
+
+          self.open = false
+          self.method = 'photos.editAlbum'
+
+          # @method initialize(arguments)
+          #   @param [Hash] arguments
+          #   @option arguments [Integer] :album_id ID of the photo album to be edited.
+          #   @option arguments [String] :title New album title.
+          #   @option arguments [String] :description New album description.
+          #   @option arguments [Integer] :owner_id ID of the user or community that owns the album.
+          #   @option arguments [Array] :privacy_view @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json
+          #   @option arguments [Array] :privacy_comment @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json
+          #   @option arguments [Boolean] :upload_by_admins_only @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json
+          #   @option arguments [Boolean] :comments_disabled @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json
+          #   @return [Photos::Methods::EditAlbum]
+
+          # @!group Arguments
+
+          # @return [Integer] ID of the photo album to be edited.
+          attribute :album_id, API::Types::Coercible::Int.optional
+          # @return [String] New album title.
+          attribute :title, API::Types::Coercible::String.optional
+          # @return [String] New album description.
+          attribute :description, API::Types::Coercible::String.optional
+          # @return [Integer] ID of the user or community that owns the album.
+          attribute :owner_id, API::Types::Coercible::Int.optional
+          # @return [Array] @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json
+          attribute :privacy_view, API::Types::Coercible::Array.optional
+          # @return [Array] @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json
+          attribute :privacy_comment, API::Types::Coercible::Array.optional
+          # @return [Boolean] @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json
+          attribute :upload_by_admins_only, API::Types::Bool.optional
+          # @return [Boolean] @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json
+          attribute :comments_disabled, API::Types::Bool.optional
+        end
+      end
+    end
+  end
+end

data/lib/vk/api/photos/methods/edit_comment.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+require 'vk/api/methods'
+
+module Vk
+  module API
+    class Photos < Vk::Schema::Namespace
+      module Methods
+        # Edits a comment on a photo.
+        class EditComment < Schema::Method
+          # @!group Properties
+
+          self.open = false
+          self.method = 'photos.editComment'
+
+          # @method initialize(arguments)
+          #   @param [Hash] arguments
+          #   @option arguments [Integer] :owner_id ID of the user or community that owns the photo.
+          #   @option arguments [Integer] :comment_id Comment ID.
+          #   @option arguments [String] :message New text of the comment.
+          #   @option arguments [Array] :attachments (Required if 'message' is not set.) List of objects attached to the post, in the following format:; "<owner_id>_<media_id>,<owner_id>_<media_id>"; '' — Type of media attachment:; 'photo' — photo; 'video' — video; 'audio' — audio; 'doc' — document; '<owner_id>' — Media attachment owner ID.; '<media_id>' — Media attachment ID.; ; Example:; "photo100172_166443618,photo66748_265827614"
+          #   @return [Photos::Methods::EditComment]
+
+          # @!group Arguments
+
+          # @return [Integer] ID of the user or community that owns the photo.
+          attribute :owner_id, API::Types::Coercible::Int.optional
+          # @return [Integer] Comment ID.
+          attribute :comment_id, API::Types::Coercible::Int.optional
+          # @return [String] New text of the comment.
+          attribute :message, API::Types::Coercible::String.optional
+          # @return [Array] (Required if 'message' is not set.) List of objects attached to the post, in the following format:; "<owner_id>_<media_id>,<owner_id>_<media_id>"; '' — Type of media attachment:; 'photo' — photo; 'video' — video; 'audio' — audio; 'doc' — document; '<owner_id>' — Media attachment owner ID.; '<media_id>' — Media attachment ID.; ; Example:; "photo100172_166443618,photo66748_265827614"
+          attribute :attachments, API::Types::Coercible::Array.optional
+        end
+      end
+    end
+  end
+end

data/lib/vk/api/photos/methods/get.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+require 'vk/api/methods'
+
+module Vk
+  module API
+    class Photos < Vk::Schema::Namespace
+      module Methods
+        # Returns a list of a user's or community's photos.
+        class Get < Schema::Method
+          # @!group Properties
+
+          self.open = true
+          self.method = 'photos.get'
+
+          # @method initialize(arguments)
+          #   @param [Hash] arguments
+          #   @option arguments [Integer] :owner_id ID of the user or community that owns the photos. Use a negative value to designate a community ID.
+          #   @option arguments [String] :album_id Photo album ID. To return information about photos from service albums, use the following string values: 'profile, wall, saved'.
+          #   @option arguments [Array] :photo_ids Photo IDs.
+          #   @option arguments [Boolean] :rev Sort order:; '1' — reverse chronological; '0' — chronological
+          #   @option arguments [Boolean] :extended '1' — to return additional 'likes', 'comments', and 'tags' fields; '0' — (default)
+          #   @option arguments [String] :feed_type Type of feed obtained in 'feed' field of the method.
+          #   @option arguments [Integer] :feed unixtime, that can be obtained with  method in date field to get all photos uploaded by the user on a specific day, or photos the user has been tagged on. Also, 'uid' parameter of the user the event happened with shall be specified.
+          #   @option arguments [Boolean] :photo_sizes '1' — to return photo sizes in a
+          #   @option arguments [Integer] :offset @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json
+          #   @option arguments [Integer] :count @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json
+          #   @return [Photos::Methods::Get]
+
+          # @!group Arguments
+
+          # @return [Integer] ID of the user or community that owns the photos. Use a negative value to designate a community ID.
+          attribute :owner_id, API::Types::Coercible::Int.optional
+          # @return [String] Photo album ID. To return information about photos from service albums, use the following string values: 'profile, wall, saved'.
+          attribute :album_id, API::Types::Coercible::String.optional
+          # @return [Array] Photo IDs.
+          attribute :photo_ids, API::Types::Coercible::Array.optional
+          # @return [Boolean] Sort order:; '1' — reverse chronological; '0' — chronological
+          attribute :rev, API::Types::Bool.optional
+          # @return [Boolean] '1' — to return additional 'likes', 'comments', and 'tags' fields; '0' — (default)
+          attribute :extended, API::Types::Bool.optional
+          # @return [String] Type of feed obtained in 'feed' field of the method.
+          attribute :feed_type, API::Types::Coercible::String.optional
+          # @return [Integer] unixtime, that can be obtained with  method in date field to get all photos uploaded by the user on a specific day, or photos the user has been tagged on. Also, 'uid' parameter of the user the event happened with shall be specified.
+          attribute :feed, API::Types::Coercible::Int.optional
+          # @return [Boolean] '1' — to return photo sizes in a
+          attribute :photo_sizes, API::Types::Bool.optional
+          # @return [Integer] @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json
+          attribute :offset, API::Types::Coercible::Int.optional
+          # @return [Integer] @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json
+          attribute :count, API::Types::Coercible::Int.optional
+        end
+      end
+    end
+  end
+end

data/lib/vk/api/photos/methods/get_albums.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+require 'vk/api/methods'
+
+module Vk
+  module API
+    class Photos < Vk::Schema::Namespace
+      module Methods
+        # Returns a list of a user's or community's photo albums.
+        class GetAlbums < Schema::Method
+          # @!group Properties
+
+          self.open = true
+          self.method = 'photos.getAlbums'
+
+          # @method initialize(arguments)
+          #   @param [Hash] arguments
+          #   @option arguments [Integer] :owner_id ID of the user or community that owns the albums.
+          #   @option arguments [Array] :album_ids Album IDs.
+          #   @option arguments [Integer] :offset Offset needed to return a specific subset of albums.
+          #   @option arguments [Integer] :count Number of albums to return.
+          #   @option arguments [Boolean] :need_system '1' — to return system albums with negative IDs
+          #   @option arguments [Boolean] :need_covers '1' — to return an additional 'thumb_src' field; '0' — (default)
+          #   @option arguments [Boolean] :photo_sizes '1' — to return photo sizes in a
+          #   @return [Photos::Methods::GetAlbums]
+
+          # @!group Arguments
+
+          # @return [Integer] ID of the user or community that owns the albums.
+          attribute :owner_id, API::Types::Coercible::Int.optional
+          # @return [Array] Album IDs.
+          attribute :album_ids, API::Types::Coercible::Array.optional
+          # @return [Integer] Offset needed to return a specific subset of albums.
+          attribute :offset, API::Types::Coercible::Int.optional
+          # @return [Integer] Number of albums to return.
+          attribute :count, API::Types::Coercible::Int.optional
+          # @return [Boolean] '1' — to return system albums with negative IDs
+          attribute :need_system, API::Types::Bool.optional
+          # @return [Boolean] '1' — to return an additional 'thumb_src' field; '0' — (default)
+          attribute :need_covers, API::Types::Bool.optional
+          # @return [Boolean] '1' — to return photo sizes in a
+          attribute :photo_sizes, API::Types::Bool.optional
+        end
+      end
+    end
+  end
+end

data/lib/vk/api/photos/methods/get_albums_count.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+require 'vk/api/methods'
+
+module Vk
+  module API
+    class Photos < Vk::Schema::Namespace
+      module Methods
+        # Returns the number of photo albums belonging to a user or community.
+        class GetAlbumsCount < Schema::Method
+          # @!group Properties
+
+          self.open = false
+          self.method = 'photos.getAlbumsCount'
+
+          # @method initialize(arguments)
+          #   @param [Hash] arguments
+          #   @option arguments [Integer] :user_id User ID.
+          #   @option arguments [Integer] :group_id Community ID.
+          #   @return [Photos::Methods::GetAlbumsCount]
+
+          # @!group Arguments
+
+          # @return [Integer] User ID.
+          attribute :user_id, API::Types::Coercible::Int.optional
+          # @return [Integer] Community ID.
+          attribute :group_id, API::Types::Coercible::Int.optional
+        end
+      end
+    end
+  end
+end

data/lib/vk/api/photos/methods/get_all.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+require 'vk/api/methods'
+
+module Vk
+  module API
+    class Photos < Vk::Schema::Namespace
+      module Methods
+        # Returns a list of photos belonging to a user or community, in reverse chronological order.
+        class GetAll < Schema::Method
+          # @!group Properties
+
+          self.open = false
+          self.method = 'photos.getAll'
+
+          # @method initialize(arguments)
+          #   @param [Hash] arguments
+          #   @option arguments [Integer] :owner_id ID of a user or community that owns the photos.; Use a negative value to designate a community ID.
+          #   @option arguments [Boolean] :extended '1' — to return detailed information about photos
+          #   @option arguments [Integer] :offset Offset needed to return a specific subset of photos. By default, '0'.
+          #   @option arguments [Integer] :count Number of photos to return.
+          #   @option arguments [Boolean] :photo_sizes '1' – to return image sizes in .
+          #   @option arguments [Boolean] :no_service_albums '1' – to return photos only from standard albums; '0' – to return all photos including those in service albums, e.g., 'My wall photos' (default)
+          #   @option arguments [Boolean] :need_hidden '1' – to show information about photos being hidden from the block above the wall.
+          #   @option arguments [Boolean] :skip_hidden '1' – not to return photos being hidden from the block above the wall. Works only with owner_id>0, no_service_albums is ignored.
+          #   @return [Photos::Methods::GetAll]
+
+          # @!group Arguments
+
+          # @return [Integer] ID of a user or community that owns the photos.; Use a negative value to designate a community ID.
+          attribute :owner_id, API::Types::Coercible::Int.optional
+          # @return [Boolean] '1' — to return detailed information about photos
+          attribute :extended, API::Types::Bool.optional
+          # @return [Integer] Offset needed to return a specific subset of photos. By default, '0'.
+          attribute :offset, API::Types::Coercible::Int.optional
+          # @return [Integer] Number of photos to return.
+          attribute :count, API::Types::Coercible::Int.optional
+          # @return [Boolean] '1' – to return image sizes in .
+          attribute :photo_sizes, API::Types::Bool.optional
+          # @return [Boolean] '1' – to return photos only from standard albums; '0' – to return all photos including those in service albums, e.g., 'My wall photos' (default)
+          attribute :no_service_albums, API::Types::Bool.optional
+          # @return [Boolean] '1' – to show information about photos being hidden from the block above the wall.
+          attribute :need_hidden, API::Types::Bool.optional
+          # @return [Boolean] '1' – not to return photos being hidden from the block above the wall. Works only with owner_id>0, no_service_albums is ignored.
+          attribute :skip_hidden, API::Types::Bool.optional
+        end
+      end
+    end
+  end
+end