module BacklogKit::Client::Space

Methods for the Space API

Public Instance Methods

download_space_icon() click to toggle source

Download a space logo image

@return [BacklogKit::Response] Binary image data

# File lib/backlog_kit/client/space.rb, line 23
def download_space_icon
  get('space/image')
end
get_space() click to toggle source

Get a space

@return [BacklogKit::Response] The space information

# File lib/backlog_kit/client/space.rb, line 8
def get_space
  get('space')
end
get_space_activities(params = {}) click to toggle source

Get list of space activities

@param params [Hash] Request parameters @return [BacklogKit::Response] List of recent updates in your space

# File lib/backlog_kit/client/space.rb, line 16
def get_space_activities(params = {})
  get('space/activities', params)
end
get_space_disk_usage() click to toggle source

Get a space disk usage

@return [BacklogKit::Response] The disk usage

# File lib/backlog_kit/client/space.rb, line 45
def get_space_disk_usage
  get('space/diskUsage')
end
get_space_notification() click to toggle source

Get a space notification

@return [BacklogKit::Response] The notification information

# File lib/backlog_kit/client/space.rb, line 30
def get_space_notification
  get('space/notification')
end
update_space_notification(content) click to toggle source

Update a space notification

@param content [String] Content of the notification @return [BacklogKit::Response] The notification information

# File lib/backlog_kit/client/space.rb, line 38
def update_space_notification(content)
  put('space/notification', content: content)
end
upload_attachment(file_path) click to toggle source

Upload attachment file for issue or wiki

@param file_path [String] Path of the file @return [BacklogKit::Response] The file information

# File lib/backlog_kit/client/space.rb, line 53
def upload_attachment(file_path)
  payload = { file: Faraday::UploadIO.new(file_path, 'application/octet-stream') }
  post('space/attachment', payload)
end