Class: Latitude::API::Resources::Region

Inherits:
APIResource show all
Extended by:
Operations::List, Operations::Retrieve
Defined in:
lib/latitude/api/resources/region.rb

Defined Under Namespace

Classes: Country

Constant Summary

Constants inherited from APIResource

APIResource::READ_ONLY_ATTRIBUTES

Instance Attribute Summary collapse

Attributes inherited from APIResource

#id, #meta, #path_params, #raw_data

Method Summary

Methods included from Operations::List

all, list

Methods included from Operations::Retrieve

retrieve

Methods inherited from APIResource

#==, #[], #[]=, #as_json, #attributes, #changed?, class_url, config_source, construct_from, #delete, execute_request, extract_path_params, #hash, id_prefix, #initialize, #inspect, instance_url, #method_missing, path_param_keys, #refresh, resource_path, resource_type, #resource_url, #respond_to_missing?, #save, #to_h, #unsaved_attributes, with_config, #write_attribute

Methods included from Attributes::ClassMethods

#attribute, #attribute_specs

Methods included from Attributes::InstanceMethods

#attribute_spec, #read_attribute, #wrap_attribute

Constructor Details

This class inherits a constructor from Latitude::API::APIResource

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Latitude::API::APIResource

Instance Attribute Details

#country ⇒ Country

Returns:



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/latitude/api/resources/region.rb', line 16

class Region < APIResource
    # @!attribute [r] name
    #   @return [String]
    # @!attribute [r] slug
    #   @return [String]
  class Country < APIObject
    attribute :name, :string, read_only: true
    attribute :slug, :string, read_only: true
  end

  attribute :name, :string
  attribute :slug, :string
  attribute :facility, :string
  attribute :country, Country
  attribute :type, :string

  resource_type "regions"
  resource_path "/regions"
  id_prefix     "reg_"

  extend Operations::List
  extend Operations::Retrieve
end

#facility ⇒ String

Returns:

  • (String) 


16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/latitude/api/resources/region.rb', line 16

class Region < APIResource
    # @!attribute [r] name
    #   @return [String]
    # @!attribute [r] slug
    #   @return [String]
  class Country < APIObject
    attribute :name, :string, read_only: true
    attribute :slug, :string, read_only: true
  end

  attribute :name, :string
  attribute :slug, :string
  attribute :facility, :string
  attribute :country, Country
  attribute :type, :string

  resource_type "regions"
  resource_path "/regions"
  id_prefix     "reg_"

  extend Operations::List
  extend Operations::Retrieve
end

#name ⇒ String

Returns:

  • (String) 


16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/latitude/api/resources/region.rb', line 16

class Region < APIResource
    # @!attribute [r] name
    #   @return [String]
    # @!attribute [r] slug
    #   @return [String]
  class Country < APIObject
    attribute :name, :string, read_only: true
    attribute :slug, :string, read_only: true
  end

  attribute :name, :string
  attribute :slug, :string
  attribute :facility, :string
  attribute :country, Country
  attribute :type, :string

  resource_type "regions"
  resource_path "/regions"
  id_prefix     "reg_"

  extend Operations::List
  extend Operations::Retrieve
end

#slug ⇒ String

Returns:

  • (String) 


16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/latitude/api/resources/region.rb', line 16

class Region < APIResource
    # @!attribute [r] name
    #   @return [String]
    # @!attribute [r] slug
    #   @return [String]
  class Country < APIObject
    attribute :name, :string, read_only: true
    attribute :slug, :string, read_only: true
  end

  attribute :name, :string
  attribute :slug, :string
  attribute :facility, :string
  attribute :country, Country
  attribute :type, :string

  resource_type "regions"
  resource_path "/regions"
  id_prefix     "reg_"

  extend Operations::List
  extend Operations::Retrieve
end

#type ⇒ String

Returns:

  • (String) 


16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/latitude/api/resources/region.rb', line 16

class Region < APIResource
    # @!attribute [r] name
    #   @return [String]
    # @!attribute [r] slug
    #   @return [String]
  class Country < APIObject
    attribute :name, :string, read_only: true
    attribute :slug, :string, read_only: true
  end

  attribute :name, :string
  attribute :slug, :string
  attribute :facility, :string
  attribute :country, Country
  attribute :type, :string

  resource_type "regions"
  resource_path "/regions"
  id_prefix     "reg_"

  extend Operations::List
  extend Operations::Retrieve
end