Class: Twilio::REST::PageMetadata

Inherits:

Object

Object
Twilio::REST::PageMetadata

show all

Defined in:: lib/twilio-ruby/framework/rest/page_metadata.rb

Overview

Page Base Class

Direct Known Subclasses

Constant Summary collapse

META_KEYS =

[
  'end',
  'first_page_uri',
  'next_page_uri',
  'last_page_uri',
  'page',
  'page_size',
  'previous_page_uri',
  'total',
  'num_pages',
  'start',
  'uri'
].freeze

Instance Method Summary collapse

#get_key(payload) ⇒ Object
#initialize(version, response) ⇒ PageMetadata constructor
A new instance of PageMetadata.
#next_page ⇒ Object
#next_page_url ⇒ Object
#previous_page ⇒ Object
#previous_page_url ⇒ Object
#process_response(response) ⇒ Object
#to_s ⇒ Object

Constructor Details

#initialize(version, response) ⇒ `PageMetadata`

Returns a new instance of PageMetadata.

# File 'lib/twilio-ruby/framework/rest/page_metadata.rb', line 21

def initialize(version, response)
  payload = process_response(response)

  @version = version
  @payload = payload
  @solution = {}
  @records = payload
end

Instance Method Details

#get_key(payload) ⇒ `Object`

Raises:

(Twilio::REST::TwilioError)

# File 'lib/twilio-ruby/framework/rest/page_metadata.rb', line 36

def get_key(payload)
  return 'Resources' if payload['Resources']

  return payload['meta']['key'] if payload['meta'] && payload['meta']['key']

  keys = payload.keys
  key = keys - META_KEYS
  return key.first if key.size == 1

  raise Twilio::REST::TwilioError, 'Page Records can not be deserialized'
end

#next_page ⇒ `Object`

# File 'lib/twilio-ruby/framework/rest/page_metadata.rb', line 72

def next_page
  return nil unless next_page_url

  @version.domain.request('GET', next_page_url)
end

#next_page_url ⇒ `Object`

# File 'lib/twilio-ruby/framework/rest/page_metadata.rb', line 57

def next_page_url
  # rubocop:disable Layout/LineLength
  return @version.domain.absolute_url(URI.parse(@payload.body['meta']['next_page_url']).request_uri) if @payload.body['meta'] && @payload.body['meta']['next_page_url']
  # rubocop:enable Layout/LineLength
  return @version.domain.absolute_url(@payload.body['next_page_uri']) if @payload.body['next_page_uri']

  nil
end

#previous_page ⇒ `Object`

# File 'lib/twilio-ruby/framework/rest/page_metadata.rb', line 66

def previous_page
  return nil unless previous_page_url

  @version.domain.request('GET', previous_page_url)
end

#previous_page_url ⇒ `Object`

# File 'lib/twilio-ruby/framework/rest/page_metadata.rb', line 48

def previous_page_url
  # rubocop:disable Layout/LineLength
  return @version.domain.absolute_url(URI.parse(@payload['meta']['previous_page_url']).request_uri) if @payload['meta'] && @payload['meta']['previous_page_url']
  # rubocop:enable Layout/LineLength
  return @version.domain.absolute_url(@payload['previous_page_uri']) if @payload['previous_page_uri']

  nil
end

#process_response(response) ⇒ `Object`

Raises:

(Twilio::REST::RestError)

# File 'lib/twilio-ruby/framework/rest/page_metadata.rb', line 30

def process_response(response)
  return response if response.status_code == 200

  raise Twilio::REST::RestError.new('Unable to fetch page', response)
end

#to_s ⇒ `Object`



78
79
80

# File 'lib/twilio-ruby/framework/rest/page_metadata.rb', line 78

def to_s
  '#<PageMetadata>'
end

Class: Twilio::REST::PageMetadata

Overview

Direct Known Subclasses

Constant Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(version, response) ⇒ PageMetadata

Instance Method Details

#get_key(payload) ⇒ Object

#next_page ⇒ Object

#next_page_url ⇒ Object

#previous_page ⇒ Object

#previous_page_url ⇒ Object

#process_response(response) ⇒ Object

#to_s ⇒ Object

#initialize(version, response) ⇒ `PageMetadata`

#get_key(payload) ⇒ `Object`

#next_page ⇒ `Object`

#next_page_url ⇒ `Object`

#previous_page ⇒ `Object`

#previous_page_url ⇒ `Object`

#process_response(response) ⇒ `Object`

#to_s ⇒ `Object`