Class: Jamf::AppStoreCountryCodes
- Inherits:
-
SingletonResource
- Object
- JSONObject
- Resource
- SingletonResource
- Jamf::AppStoreCountryCodes
- Extended by:
- Immutable
- Defined in:
- lib/jamf/api/resources/singleton_resources/app_store_country_codes.rb
Overview
The API endpoint for country codes.
Probably more useful is the Jamf.app_store_country_codes method which parses this into a hash of Code => Name
Constant Summary collapse
- RSRC_VERSION =
Constants
'v1'.freeze
- RSRC_PATH =
'app-store-country-codes'.freeze
- OBJECT_MODEL =
{ # @!attribute checkInFrequency # @return [integer] countryCodes: { class: Jamf::Country, multi: true, read_only: true } }.freeze
Instance Attribute Summary collapse
Class Method Summary collapse
-
.code_for_name(name, refresh = false, cnx: Jamf.cnx) ⇒ Object
Class level wrapper for #code_for_name.
-
.codes(refresh = false, cnx: Jamf.cnx) ⇒ Object
Class level wrapper for #codes.
-
.codes_by_name(refresh = false, cnx: Jamf.cnx) ⇒ Object
Class level wrapper for #codes_by_name.
- .mutable? ⇒ Boolean extended from Immutable
-
.name_for_code(code, refresh = false, cnx: Jamf.cnx) ⇒ Object
Class level wrapper for #name_for_code.
-
.names(refresh = false, cnx: Jamf.cnx) ⇒ Object
Class level wrapper for #names.
-
.names_by_code(refresh = false, cnx: Jamf.cnx) ⇒ Object
Class level wrapper for #names_by_code.
Instance Method Summary collapse
-
#code_for_name(name) ⇒ String
return a country code from its name, case-insensitive.
-
#codes ⇒ Array<String>
The available country codes.
-
#codes_by_name ⇒ Hash
Name => code.
-
#name_for_code(code) ⇒ String
return a country name from its code, case-insensitive.
-
#names ⇒ Array<String>
The available country names.
-
#names_by_code ⇒ Hash
Code => name.
Constructor Details
This class inherits a constructor from Jamf::JSONObject
Instance Attribute Details
#checkInFrequency ⇒ integer
|
# File 'lib/jamf/api/resources/singleton_resources/app_store_country_codes.rb', line 46
|
Class Method Details
.code_for_name(name, refresh = false, cnx: Jamf.cnx) ⇒ Object
Class level wrapper for #code_for_name
82 83 84 |
# File 'lib/jamf/api/resources/singleton_resources/app_store_country_codes.rb', line 82 def self.code_for_name(name, refresh = false, cnx: Jamf.cnx) fetch(refresh, cnx: cnx).code_for_name name end |
.codes(refresh = false, cnx: Jamf.cnx) ⇒ Object
Class level wrapper for #codes
67 68 69 |
# File 'lib/jamf/api/resources/singleton_resources/app_store_country_codes.rb', line 67 def self.codes(refresh = false, cnx: Jamf.cnx) fetch(refresh, cnx: cnx).codes end |
.codes_by_name(refresh = false, cnx: Jamf.cnx) ⇒ Object
Class level wrapper for #codes_by_name
72 73 74 |
# File 'lib/jamf/api/resources/singleton_resources/app_store_country_codes.rb', line 72 def self.codes_by_name(refresh = false, cnx: Jamf.cnx) fetch(refresh, cnx: cnx).codes_by_name end |
.mutable? ⇒ Boolean Originally defined in module Immutable
.name_for_code(code, refresh = false, cnx: Jamf.cnx) ⇒ Object
Class level wrapper for #name_for_code
87 88 89 |
# File 'lib/jamf/api/resources/singleton_resources/app_store_country_codes.rb', line 87 def self.name_for_code(code, refresh = false, cnx: Jamf.cnx) fetch(refresh, cnx: cnx).name_for_code code end |
Instance Method Details
#code_for_name(name) ⇒ String
return a country code from its name, case-insensitive
117 118 119 120 |
# File 'lib/jamf/api/resources/singleton_resources/app_store_country_codes.rb', line 117 def code_for_name(name) name = names.select { |n| n.casecmp? name }.first codes_by_name[name] end |
#codes ⇒ Array<String>
Returns the available country codes.
100 101 102 |
# File 'lib/jamf/api/resources/singleton_resources/app_store_country_codes.rb', line 100 def codes @codes ||= countryCodes.map{ |country| country.code } end |
#codes_by_name ⇒ Hash
Returns name => code.
105 106 107 |
# File 'lib/jamf/api/resources/singleton_resources/app_store_country_codes.rb', line 105 def codes_by_name @codes_by_name ||= countryCodes.map{ |country| [country.name, country.code] }.to_h end |
#name_for_code(code) ⇒ String
return a country name from its code, case-insensitive
125 126 127 |
# File 'lib/jamf/api/resources/singleton_resources/app_store_country_codes.rb', line 125 def name_for_code(code) names_by_code[code.upcase] end |
#names ⇒ Array<String>
Returns the available country names.
95 96 97 |
# File 'lib/jamf/api/resources/singleton_resources/app_store_country_codes.rb', line 95 def names @names ||= countryCodes.map{ |country| country.name } end |
#names_by_code ⇒ Hash
Returns code => name.
110 111 112 |
# File 'lib/jamf/api/resources/singleton_resources/app_store_country_codes.rb', line 110 def names_by_code @names_by_code ||= countryCodes.map{ |country| [country.code, country.name] }.to_h end |