Sha256: cee4682362b8719c0c89fb26e29e1ffde519ce6808dd93641d7c4f691325ba44

Contents?: true

Size: 1.08 KB

Versions: 14

Compression:

Stored size: 1.08 KB

Contents

module Zype
  # Read more at https://docs.zype.com/v1.0/reference#videos
  #
  # @since 0.4.0
  class Videos < Zype::BaseModel
    # Adds zobjects to video
    #
    # @param id [String] the ID of the video
    # @param zobject_ids [Array<String>] an array of zobject IDs
    # @return [Hash] the video object
    def add_zobjects(id:, zobject_ids:)
      client.execute(method: :put, path: "/videos/#{id}/add_zobjects", params: { zobject_id: zobject_ids })
    end

    # Removes zobjects from video
    #
    # @param id [String] the ID of the video
    # @param zobject_ids [Array<String>] an array of zobject IDs
    # @return [Hash] the video object
    def remove_zobjects(id:, zobject_ids:)
      client.execute(method: :put, path: "/videos/#{id}/remove_zobjects", params: { zobject_id: zobject_ids })
    end

    # Returns the original source file for the video
    #
    # @param id [String] the ID of the video
    # @return [Hash] object containing a "url" key for the original source file
    def download(id:)
      client.execute(method: :get, path: "/videos/#{id}/download")
    end
  end
end

Version data entries

14 entries across 14 versions & 1 rubygems

Version Path
zype-0.20.0 lib/zype/models/videos.rb
zype-0.19.0 lib/zype/models/videos.rb
zype-0.18.0 lib/zype/models/videos.rb
zype-0.17.0 lib/zype/models/videos.rb
zype-0.16.1 lib/zype/models/videos.rb
zype-0.16.0 lib/zype/models/videos.rb
zype-0.15.0 lib/zype/models/videos.rb
zype-0.14.0 lib/zype/models/videos.rb
zype-0.13.0 lib/zype/models/videos.rb
zype-0.12.0 lib/zype/models/videos.rb
zype-0.11.0 lib/zype/models/videos.rb
zype-0.10.0 lib/zype/models/videos.rb
zype-0.9.0 lib/zype/models/videos.rb
zype-0.8.0 lib/zype/models/videos.rb