phoebe 0.1.0.pre.alpha.1

data/lib/phoebe/models/ref/hotspot/info_retrieve_response.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module Phoebe
+  module Models
+    module Ref
+      module Hotspot
+        # @see Phoebe::Resources::Ref::Hotspot::Info#retrieve
+        class InfoRetrieveResponse < Phoebe::Internal::Type::BaseModel
+          # @!attribute country_code
+          #
+          #   @return [String, nil]
+          optional :country_code, String, api_name: :countryCode
+
+          # @!attribute country_name
+          #
+          #   @return [String, nil]
+          optional :country_name, String, api_name: :countryName
+
+          # @!attribute hierarchical_name
+          #
+          #   @return [String, nil]
+          optional :hierarchical_name, String, api_name: :hierarchicalName
+
+          # @!attribute is_hotspot
+          #
+          #   @return [Boolean, nil]
+          optional :is_hotspot, Phoebe::Internal::Type::Boolean, api_name: :isHotspot
+
+          # @!attribute lat
+          #
+          #   @return [Float, nil]
+          optional :lat, Float
+
+          # @!attribute latitude
+          #
+          #   @return [Float, nil]
+          optional :latitude, Float
+
+          # @!attribute lng
+          #
+          #   @return [Float, nil]
+          optional :lng, Float
+
+          # @!attribute loc_id
+          #
+          #   @return [String, nil]
+          optional :loc_id, String, api_name: :locId
+
+          # @!attribute loc_name
+          #
+          #   @return [String, nil]
+          optional :loc_name, String, api_name: :locName
+
+          # @!attribute longitude
+          #
+          #   @return [Float, nil]
+          optional :longitude, Float
+
+          # @!attribute name
+          #
+          #   @return [String, nil]
+          optional :name, String
+
+          # @!attribute subnational1_code
+          #
+          #   @return [String, nil]
+          optional :subnational1_code, String, api_name: :subnational1Code
+
+          # @!attribute subnational1_name
+          #
+          #   @return [String, nil]
+          optional :subnational1_name, String, api_name: :subnational1Name
+
+          # @!method initialize(country_code: nil, country_name: nil, hierarchical_name: nil, is_hotspot: nil, lat: nil, latitude: nil, lng: nil, loc_id: nil, loc_name: nil, longitude: nil, name: nil, subnational1_code: nil, subnational1_name: nil)
+          #   @param country_code [String]
+          #   @param country_name [String]
+          #   @param hierarchical_name [String]
+          #   @param is_hotspot [Boolean]
+          #   @param lat [Float]
+          #   @param latitude [Float]
+          #   @param lng [Float]
+          #   @param loc_id [String]
+          #   @param loc_name [String]
+          #   @param longitude [Float]
+          #   @param name [String]
+          #   @param subnational1_code [String]
+          #   @param subnational1_name [String]
+        end
+      end
+    end
+  end
+end

data/lib/phoebe/models/ref/hotspot_list_params.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Phoebe
+  module Models
+    module Ref
+      # @see Phoebe::Resources::Ref::Hotspot#list
+      class HotspotListParams < Phoebe::Internal::Type::BaseModel
+        extend Phoebe::Internal::Type::RequestParameters::Converter
+        include Phoebe::Internal::Type::RequestParameters
+
+        # @!attribute back
+        #   The number of days back to fetch hotspots.
+        #
+        #   @return [Integer, nil]
+        optional :back, Integer
+
+        # @!attribute fmt
+        #   Fetch the records in CSV or JSON format.
+        #
+        #   @return [Symbol, Phoebe::Models::Ref::HotspotListParams::Fmt, nil]
+        optional :fmt, enum: -> { Phoebe::Ref::HotspotListParams::Fmt }
+
+        # @!method initialize(back: nil, fmt: nil, request_options: {})
+        #   @param back [Integer] The number of days back to fetch hotspots.
+        #
+        #   @param fmt [Symbol, Phoebe::Models::Ref::HotspotListParams::Fmt] Fetch the records in CSV or JSON format.
+        #
+        #   @param request_options [Phoebe::RequestOptions, Hash{Symbol=>Object}]
+
+        # Fetch the records in CSV or JSON format.
+        module Fmt
+          extend Phoebe::Internal::Type::Enum
+
+          CSV = :csv
+          JSON = :json
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/phoebe/models/ref/hotspot_list_response.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Phoebe
+  module Models
+    module Ref
+      class HotspotListResponseItem < Phoebe::Internal::Type::BaseModel
+        # @!attribute country_code
+        #
+        #   @return [String, nil]
+        optional :country_code, String, api_name: :countryCode
+
+        # @!attribute lat
+        #
+        #   @return [Float, nil]
+        optional :lat, Float
+
+        # @!attribute latest_obs_dt
+        #
+        #   @return [String, nil]
+        optional :latest_obs_dt, String, api_name: :latestObsDt
+
+        # @!attribute lng
+        #
+        #   @return [Float, nil]
+        optional :lng, Float
+
+        # @!attribute loc_id
+        #
+        #   @return [String, nil]
+        optional :loc_id, String, api_name: :locId
+
+        # @!attribute loc_name
+        #
+        #   @return [String, nil]
+        optional :loc_name, String, api_name: :locName
+
+        # @!attribute num_species_all_time
+        #
+        #   @return [Integer, nil]
+        optional :num_species_all_time, Integer, api_name: :numSpeciesAllTime
+
+        # @!attribute subnational1_code
+        #
+        #   @return [String, nil]
+        optional :subnational1_code, String, api_name: :subnational1Code
+
+        # @!attribute subnational2_code
+        #
+        #   @return [String, nil]
+        optional :subnational2_code, String, api_name: :subnational2Code
+
+        # @!method initialize(country_code: nil, lat: nil, latest_obs_dt: nil, lng: nil, loc_id: nil, loc_name: nil, num_species_all_time: nil, subnational1_code: nil, subnational2_code: nil)
+        #   @param country_code [String]
+        #   @param lat [Float]
+        #   @param latest_obs_dt [String]
+        #   @param lng [Float]
+        #   @param loc_id [String]
+        #   @param loc_name [String]
+        #   @param num_species_all_time [Integer]
+        #   @param subnational1_code [String]
+        #   @param subnational2_code [String]
+      end
+
+      # @type [Phoebe::Internal::Type::Converter]
+      HotspotListResponse =
+        Phoebe::Internal::Type::ArrayOf[-> { Phoebe::Models::Ref::HotspotListResponseItem }]
+    end
+  end
+end

data/lib/phoebe/models/ref/region/adjacent_list_params.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Phoebe
+  module Models
+    module Ref
+      module Region
+        # @see Phoebe::Resources::Ref::Region::Adjacent#list
+        class AdjacentListParams < Phoebe::Internal::Type::BaseModel
+          extend Phoebe::Internal::Type::RequestParameters::Converter
+          include Phoebe::Internal::Type::RequestParameters
+
+          # @!method initialize(request_options: {})
+          #   @param request_options [Phoebe::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/phoebe/models/ref/region/adjacent_list_response.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Phoebe
+  module Models
+    module Ref
+      module Region
+        class AdjacentListResponseItem < Phoebe::Internal::Type::BaseModel
+          # @!attribute code
+          #
+          #   @return [String, nil]
+          optional :code, String
+
+          # @!attribute name
+          #
+          #   @return [String, nil]
+          optional :name, String
+
+          # @!method initialize(code: nil, name: nil)
+          #   @param code [String]
+          #   @param name [String]
+        end
+
+        # @type [Phoebe::Internal::Type::Converter]
+        AdjacentListResponse =
+          Phoebe::Internal::Type::ArrayOf[-> { Phoebe::Models::Ref::Region::AdjacentListResponseItem }]
+      end
+    end
+  end
+end

data/lib/phoebe/models/ref/region/info_retrieve_params.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Phoebe
+  module Models
+    module Ref
+      module Region
+        # @see Phoebe::Resources::Ref::Region::Info#retrieve
+        class InfoRetrieveParams < Phoebe::Internal::Type::BaseModel
+          extend Phoebe::Internal::Type::RequestParameters::Converter
+          include Phoebe::Internal::Type::RequestParameters
+
+          # @!attribute delim
+          #   The characters used to separate elements in the name.
+          #
+          #   @return [String, nil]
+          optional :delim, String
+
+          # @!attribute region_name_format
+          #   Control how the name is displayed.
+          #
+          #   @return [Symbol, Phoebe::Models::Ref::Region::InfoRetrieveParams::RegionNameFormat, nil]
+          optional :region_name_format, enum: -> { Phoebe::Ref::Region::InfoRetrieveParams::RegionNameFormat }
+
+          # @!method initialize(delim: nil, region_name_format: nil, request_options: {})
+          #   @param delim [String] The characters used to separate elements in the name.
+          #
+          #   @param region_name_format [Symbol, Phoebe::Models::Ref::Region::InfoRetrieveParams::RegionNameFormat] Control how the name is displayed.
+          #
+          #   @param request_options [Phoebe::RequestOptions, Hash{Symbol=>Object}]
+
+          # Control how the name is displayed.
+          module RegionNameFormat
+            extend Phoebe::Internal::Type::Enum
+
+            DETAILED = :detailed
+            DETAILEDNOQUAL = :detailednoqual
+            FULL = :full
+            NAMEQUAL = :namequal
+            NAMEONLY = :nameonly
+            REVDETAILED = :revdetailed
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/phoebe/models/ref/region/info_retrieve_response.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Phoebe
+  module Models
+    module Ref
+      module Region
+        # @see Phoebe::Resources::Ref::Region::Info#retrieve
+        class InfoRetrieveResponse < Phoebe::Internal::Type::BaseModel
+          # @!attribute bounds
+          #
+          #   @return [Phoebe::Models::Ref::Region::InfoRetrieveResponse::Bounds, nil]
+          optional :bounds, -> { Phoebe::Models::Ref::Region::InfoRetrieveResponse::Bounds }
+
+          # @!attribute result
+          #
+          #   @return [String, nil]
+          optional :result, String
+
+          # @!method initialize(bounds: nil, result: nil)
+          #   @param bounds [Phoebe::Models::Ref::Region::InfoRetrieveResponse::Bounds]
+          #   @param result [String]
+
+          # @see Phoebe::Models::Ref::Region::InfoRetrieveResponse#bounds
+          class Bounds < Phoebe::Internal::Type::BaseModel
+            # @!attribute max_x
+            #
+            #   @return [Float, nil]
+            optional :max_x, Float, api_name: :maxX
+
+            # @!attribute max_y
+            #
+            #   @return [Float, nil]
+            optional :max_y, Float, api_name: :maxY
+
+            # @!attribute min_x
+            #
+            #   @return [Float, nil]
+            optional :min_x, Float, api_name: :minX
+
+            # @!attribute min_y
+            #
+            #   @return [Float, nil]
+            optional :min_y, Float, api_name: :minY
+
+            # @!method initialize(max_x: nil, max_y: nil, min_x: nil, min_y: nil)
+            #   @param max_x [Float]
+            #   @param max_y [Float]
+            #   @param min_x [Float]
+            #   @param min_y [Float]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/phoebe/models/ref/region/list_list_params.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Phoebe
+  module Models
+    module Ref
+      module Region
+        # @see Phoebe::Resources::Ref::Region::List#list
+        class ListListParams < Phoebe::Internal::Type::BaseModel
+          extend Phoebe::Internal::Type::RequestParameters::Converter
+          include Phoebe::Internal::Type::RequestParameters
+
+          # @!attribute region_type
+          #
+          #   @return [String]
+          required :region_type, String
+
+          # @!attribute fmt
+          #   Fetch the records in CSV or JSON format.
+          #
+          #   @return [Symbol, Phoebe::Models::Ref::Region::ListListParams::Fmt, nil]
+          optional :fmt, enum: -> { Phoebe::Ref::Region::ListListParams::Fmt }
+
+          # @!method initialize(region_type:, fmt: nil, request_options: {})
+          #   @param region_type [String]
+          #
+          #   @param fmt [Symbol, Phoebe::Models::Ref::Region::ListListParams::Fmt] Fetch the records in CSV or JSON format.
+          #
+          #   @param request_options [Phoebe::RequestOptions, Hash{Symbol=>Object}]
+
+          # Fetch the records in CSV or JSON format.
+          module Fmt
+            extend Phoebe::Internal::Type::Enum
+
+            CSV = :csv
+            JSON = :json
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/phoebe/models/ref/region/list_list_response.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Phoebe
+  module Models
+    module Ref
+      module Region
+        class ListListResponseItem < Phoebe::Internal::Type::BaseModel
+          # @!attribute code
+          #
+          #   @return [String, nil]
+          optional :code, String
+
+          # @!attribute name
+          #
+          #   @return [String, nil]
+          optional :name, String
+
+          # @!method initialize(code: nil, name: nil)
+          #   @param code [String]
+          #   @param name [String]
+        end
+
+        # @type [Phoebe::Internal::Type::Converter]
+        ListListResponse =
+          Phoebe::Internal::Type::ArrayOf[-> { Phoebe::Models::Ref::Region::ListListResponseItem }]
+      end
+    end
+  end
+end

data/lib/phoebe/models/ref/taxonomy/ebird_retrieve_params.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Phoebe
+  module Models
+    module Ref
+      module Taxonomy
+        # @see Phoebe::Resources::Ref::Taxonomy::Ebird#retrieve
+        class EbirdRetrieveParams < Phoebe::Internal::Type::BaseModel
+          extend Phoebe::Internal::Type::RequestParameters::Converter
+          include Phoebe::Internal::Type::RequestParameters
+
+          # @!attribute cat
+          #   Only fetch records from these taxonomic categories.
+          #
+          #   @return [String, nil]
+          optional :cat, String
+
+          # @!attribute fmt
+          #   Fetch the records in CSV or JSON format.
+          #
+          #   @return [Symbol, Phoebe::Models::Ref::Taxonomy::EbirdRetrieveParams::Fmt, nil]
+          optional :fmt, enum: -> { Phoebe::Ref::Taxonomy::EbirdRetrieveParams::Fmt }
+
+          # @!attribute locale
+          #   Use this language for common names.
+          #
+          #   @return [String, nil]
+          optional :locale, String
+
+          # @!attribute species
+          #   Only fetch records for these species.
+          #
+          #   @return [String, nil]
+          optional :species, String
+
+          # @!attribute version
+          #   Fetch a specific version of the taxonomy.
+          #
+          #   @return [String, nil]
+          optional :version, String
+
+          # @!method initialize(cat: nil, fmt: nil, locale: nil, species: nil, version: nil, request_options: {})
+          #   @param cat [String] Only fetch records from these taxonomic categories.
+          #
+          #   @param fmt [Symbol, Phoebe::Models::Ref::Taxonomy::EbirdRetrieveParams::Fmt] Fetch the records in CSV or JSON format.
+          #
+          #   @param locale [String] Use this language for common names.
+          #
+          #   @param species [String] Only fetch records for these species.
+          #
+          #   @param version [String] Fetch a specific version of the taxonomy.
+          #
+          #   @param request_options [Phoebe::RequestOptions, Hash{Symbol=>Object}]
+
+          # Fetch the records in CSV or JSON format.
+          module Fmt
+            extend Phoebe::Internal::Type::Enum
+
+            CSV = :csv
+            JSON = :json
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/phoebe/models/ref/taxonomy/ebird_retrieve_response.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module Phoebe
+  module Models
+    module Ref
+      module Taxonomy
+        class EbirdRetrieveResponseItem < Phoebe::Internal::Type::BaseModel
+          # @!attribute banding_codes
+          #
+          #   @return [Array<String>, nil]
+          optional :banding_codes, Phoebe::Internal::Type::ArrayOf[String], api_name: :bandingCodes
+
+          # @!attribute category
+          #
+          #   @return [String, nil]
+          optional :category, String
+
+          # @!attribute com_name
+          #
+          #   @return [String, nil]
+          optional :com_name, String, api_name: :comName
+
+          # @!attribute com_name_codes
+          #
+          #   @return [Array<String>, nil]
+          optional :com_name_codes, Phoebe::Internal::Type::ArrayOf[String], api_name: :comNameCodes
+
+          # @!attribute family_code
+          #
+          #   @return [String, nil]
+          optional :family_code, String, api_name: :familyCode
+
+          # @!attribute family_com_name
+          #
+          #   @return [String, nil]
+          optional :family_com_name, String, api_name: :familyComName
+
+          # @!attribute family_sci_name
+          #
+          #   @return [String, nil]
+          optional :family_sci_name, String, api_name: :familySciName
+
+          # @!attribute order
+          #
+          #   @return [String, nil]
+          optional :order, String
+
+          # @!attribute sci_name
+          #
+          #   @return [String, nil]
+          optional :sci_name, String, api_name: :sciName
+
+          # @!attribute sci_name_codes
+          #
+          #   @return [Array<String>, nil]
+          optional :sci_name_codes, Phoebe::Internal::Type::ArrayOf[String], api_name: :sciNameCodes
+
+          # @!attribute species_code
+          #
+          #   @return [String, nil]
+          optional :species_code, String, api_name: :speciesCode
+
+          # @!attribute taxon_order
+          #
+          #   @return [Integer, nil]
+          optional :taxon_order, Integer, api_name: :taxonOrder
+
+          # @!method initialize(banding_codes: nil, category: nil, com_name: nil, com_name_codes: nil, family_code: nil, family_com_name: nil, family_sci_name: nil, order: nil, sci_name: nil, sci_name_codes: nil, species_code: nil, taxon_order: nil)
+          #   @param banding_codes [Array<String>]
+          #   @param category [String]
+          #   @param com_name [String]
+          #   @param com_name_codes [Array<String>]
+          #   @param family_code [String]
+          #   @param family_com_name [String]
+          #   @param family_sci_name [String]
+          #   @param order [String]
+          #   @param sci_name [String]
+          #   @param sci_name_codes [Array<String>]
+          #   @param species_code [String]
+          #   @param taxon_order [Integer]
+        end
+
+        # @type [Phoebe::Internal::Type::Converter]
+        EbirdRetrieveResponse =
+          Phoebe::Internal::Type::ArrayOf[-> { Phoebe::Models::Ref::Taxonomy::EbirdRetrieveResponseItem }]
+      end
+    end
+  end
+end

data/lib/phoebe/models/ref/taxonomy/form_list_params.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Phoebe
+  module Models
+    module Ref
+      module Taxonomy
+        # @see Phoebe::Resources::Ref::Taxonomy::Forms#list
+        class FormListParams < Phoebe::Internal::Type::BaseModel
+          extend Phoebe::Internal::Type::RequestParameters::Converter
+          include Phoebe::Internal::Type::RequestParameters
+
+          # @!method initialize(request_options: {})
+          #   @param request_options [Phoebe::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/phoebe/models/ref/taxonomy/form_list_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Phoebe
+  module Models
+    module Ref
+      module Taxonomy
+        # @type [Phoebe::Internal::Type::Converter]
+        FormListResponse = Phoebe::Internal::Type::ArrayOf[String]
+      end
+    end
+  end
+end

data/lib/phoebe/models/ref/taxonomy/locale_list_params.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Phoebe
+  module Models
+    module Ref
+      module Taxonomy
+        # @see Phoebe::Resources::Ref::Taxonomy::Locales#list
+        class LocaleListParams < Phoebe::Internal::Type::BaseModel
+          extend Phoebe::Internal::Type::RequestParameters::Converter
+          include Phoebe::Internal::Type::RequestParameters
+
+          # @!attribute accept_language
+          #
+          #   @return [String, nil]
+          optional :accept_language, String
+
+          # @!method initialize(accept_language: nil, request_options: {})
+          #   @param accept_language [String]
+          #   @param request_options [Phoebe::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/phoebe/models/ref/taxonomy/locale_list_response.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Phoebe
+  module Models
+    module Ref
+      module Taxonomy
+        class LocaleListResponseItem < Phoebe::Internal::Type::BaseModel
+          # @!attribute code
+          #
+          #   @return [String, nil]
+          optional :code, String
+
+          # @!attribute last_updated
+          #
+          #   @return [String, nil]
+          optional :last_updated, String, api_name: :lastUpdated
+
+          # @!attribute name
+          #
+          #   @return [String, nil]
+          optional :name, String
+
+          # @!method initialize(code: nil, last_updated: nil, name: nil)
+          #   @param code [String]
+          #   @param last_updated [String]
+          #   @param name [String]
+        end
+
+        # @type [Phoebe::Internal::Type::Converter]
+        LocaleListResponse =
+          Phoebe::Internal::Type::ArrayOf[-> { Phoebe::Models::Ref::Taxonomy::LocaleListResponseItem }]
+      end
+    end
+  end
+end