class BaremetricsAPI::Endpoint::Annotations

Constants

PATH

Public Class Methods

new(client) click to toggle source
# File lib/baremetrics_api/endpoint/annotations.rb, line 6
def initialize(client)
  @client = client
end

Public Instance Methods

create_annotation(annotation_params:) click to toggle source
# File lib/baremetrics_api/endpoint/annotations.rb, line 18
def create_annotation(annotation_params:)
  JSON.parse(create_annotation_request(annotation_params).body).with_indifferent_access
end
delete_annotation(id:) click to toggle source
# File lib/baremetrics_api/endpoint/annotations.rb, line 22
def delete_annotation(id:)
  JSON.parse(delete_annotation_request(id).body).with_indifferent_access
end
list_annotations(page: nil) click to toggle source
# File lib/baremetrics_api/endpoint/annotations.rb, line 10
def list_annotations(page: nil)
  JSON.parse(list_annotations_request(page).body).with_indifferent_access
end
show_annotation(id:) click to toggle source
# File lib/baremetrics_api/endpoint/annotations.rb, line 14
def show_annotation(id:)
  JSON.parse(show_annotation_request(id).body).with_indifferent_access
end

Private Instance Methods

create_annotation_request(annotation_params) click to toggle source
# File lib/baremetrics_api/endpoint/annotations.rb, line 47
def create_annotation_request(annotation_params)
  @client.connection.post do |req|
    req.url PATH
    req.body = annotation_params
  end
end
delete_annotation_request(id) click to toggle source
# File lib/baremetrics_api/endpoint/annotations.rb, line 54
def delete_annotation_request(id)
  @client.connection.delete "#{PATH}/#{id}"
end
list_annotations_request(page) click to toggle source
# File lib/baremetrics_api/endpoint/annotations.rb, line 28
def list_annotations_request(page)
  query_params = {
    per_page: @client.configuration.response_limit
  }

  query_params[:page] = page unless page.nil?

  @client.connection.get do |req|
    req.url PATH
    req.params = query_params
  end
end
show_annotation_request(id) click to toggle source
# File lib/baremetrics_api/endpoint/annotations.rb, line 41
def show_annotation_request(id)
  @client.connection.get do |req|
    req.url "#{PATH}/#{id}"
  end
end