phoebe 0.1.0.pre.alpha.1

data/lib/phoebe/internal.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Phoebe
+  module Internal
+    extend Phoebe::Internal::Util::SorbetRuntimeSupport
+
+    OMIT =
+      Object.new.tap do
+        _1.define_singleton_method(:inspect) { "#<#{Phoebe::Internal}::OMIT>" }
+      end
+        .freeze
+
+    define_sorbet_constant!(:AnyHash) do
+      T.type_alias { T::Hash[Symbol, T.anything] }
+    end
+    define_sorbet_constant!(:FileInput) do
+      T.type_alias { T.any(Pathname, StringIO, IO, String, Phoebe::FilePart) }
+    end
+  end
+end

data/lib/phoebe/models/data/observation.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+module Phoebe
+  module Models
+    module Data
+      class Observation < Phoebe::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [Integer, nil]
+        optional :id, Integer
+
+        # @!attribute com_name
+        #
+        #   @return [String, nil]
+        optional :com_name, String, api_name: :comName
+
+        # @!attribute firstname
+        #
+        #   @return [String, nil]
+        optional :firstname, String
+
+        # @!attribute how_many
+        #
+        #   @return [Integer, nil]
+        optional :how_many, Integer, api_name: :howMany
+
+        # @!attribute lastname
+        #
+        #   @return [String, nil]
+        optional :lastname, String
+
+        # @!attribute lat
+        #
+        #   @return [Float, nil]
+        optional :lat, Float
+
+        # @!attribute lng
+        #
+        #   @return [Float, nil]
+        optional :lng, Float
+
+        # @!attribute location_private
+        #
+        #   @return [Boolean, nil]
+        optional :location_private, Phoebe::Internal::Type::Boolean, api_name: :locationPrivate
+
+        # @!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 obs_dt
+        #
+        #   @return [String, nil]
+        optional :obs_dt, String, api_name: :obsDt
+
+        # @!attribute obs_reviewed
+        #
+        #   @return [Boolean, nil]
+        optional :obs_reviewed, Phoebe::Internal::Type::Boolean, api_name: :obsReviewed
+
+        # @!attribute obs_valid
+        #
+        #   @return [Boolean, nil]
+        optional :obs_valid, Phoebe::Internal::Type::Boolean, api_name: :obsValid
+
+        # @!attribute sci_name
+        #
+        #   @return [String, nil]
+        optional :sci_name, String, api_name: :sciName
+
+        # @!attribute species_code
+        #
+        #   @return [String, nil]
+        optional :species_code, String, api_name: :speciesCode
+
+        # @!attribute sub_id
+        #
+        #   @return [String, nil]
+        optional :sub_id, String, api_name: :subId
+
+        # @!method initialize(id: nil, com_name: nil, firstname: nil, how_many: nil, lastname: nil, lat: nil, lng: nil, location_private: nil, loc_id: nil, loc_name: nil, obs_dt: nil, obs_reviewed: nil, obs_valid: nil, sci_name: nil, species_code: nil, sub_id: nil)
+        #   @param id [Integer]
+        #   @param com_name [String]
+        #   @param firstname [String]
+        #   @param how_many [Integer]
+        #   @param lastname [String]
+        #   @param lat [Float]
+        #   @param lng [Float]
+        #   @param location_private [Boolean]
+        #   @param loc_id [String]
+        #   @param loc_name [String]
+        #   @param obs_dt [String]
+        #   @param obs_reviewed [Boolean]
+        #   @param obs_valid [Boolean]
+        #   @param sci_name [String]
+        #   @param species_code [String]
+        #   @param sub_id [String]
+      end
+    end
+  end
+end

data/lib/phoebe/models/data/observations/geo/recent/notable_list_params.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module Phoebe
+  module Models
+    module Data
+      module Observations
+        module Geo
+          module Recent
+            # @see Phoebe::Resources::Data::Observations::Geo::Recent::Notable#list
+            class NotableListParams < Phoebe::Internal::Type::BaseModel
+              extend Phoebe::Internal::Type::RequestParameters::Converter
+              include Phoebe::Internal::Type::RequestParameters
+
+              # @!attribute lat
+              #
+              #   @return [Float]
+              required :lat, Float
+
+              # @!attribute lng
+              #
+              #   @return [Float]
+              required :lng, Float
+
+              # @!attribute back
+              #   The number of days back to fetch observations.
+              #
+              #   @return [Integer, nil]
+              optional :back, Integer
+
+              # @!attribute detail
+              #   Include a subset (simple), or all (full), of the fields available.
+              #
+              #   @return [Symbol, Phoebe::Models::Data::Observations::Geo::Recent::NotableListParams::Detail, nil]
+              optional :detail, enum: -> { Phoebe::Data::Observations::Geo::Recent::NotableListParams::Detail }
+
+              # @!attribute dist
+              #   The search radius from the given position, in kilometers.
+              #
+              #   @return [Integer, nil]
+              optional :dist, Integer
+
+              # @!attribute hotspot
+              #   Only fetch observations from hotspots
+              #
+              #   @return [Boolean, nil]
+              optional :hotspot, Phoebe::Internal::Type::Boolean
+
+              # @!attribute max_results
+              #   Only fetch this number of observations
+              #
+              #   @return [Integer, nil]
+              optional :max_results, Integer
+
+              # @!attribute spp_locale
+              #   Use this language for species common names
+              #
+              #   @return [String, nil]
+              optional :spp_locale, String
+
+              # @!method initialize(lat:, lng:, back: nil, detail: nil, dist: nil, hotspot: nil, max_results: nil, spp_locale: nil, request_options: {})
+              #   @param lat [Float]
+              #
+              #   @param lng [Float]
+              #
+              #   @param back [Integer] The number of days back to fetch observations.
+              #
+              #   @param detail [Symbol, Phoebe::Models::Data::Observations::Geo::Recent::NotableListParams::Detail] Include a subset (simple), or all (full), of the fields available.
+              #
+              #   @param dist [Integer] The search radius from the given position, in kilometers.
+              #
+              #   @param hotspot [Boolean] Only fetch observations from hotspots
+              #
+              #   @param max_results [Integer] Only fetch this number of observations
+              #
+              #   @param spp_locale [String] Use this language for species common names
+              #
+              #   @param request_options [Phoebe::RequestOptions, Hash{Symbol=>Object}]
+
+              # Include a subset (simple), or all (full), of the fields available.
+              module Detail
+                extend Phoebe::Internal::Type::Enum
+
+                SIMPLE = :simple
+                FULL = :full
+
+                # @!method self.values
+                #   @return [Array<Symbol>]
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/phoebe/models/data/observations/geo/recent/notable_list_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Phoebe
+  module Models
+    module Data
+      module Observations
+        module Geo
+          module Recent
+            # @type [Phoebe::Internal::Type::Converter]
+            NotableListResponse = Phoebe::Internal::Type::ArrayOf[-> { Phoebe::Data::Observation }]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/phoebe/models/data/observations/geo/recent/specie_list_params.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module Phoebe
+  module Models
+    module Data
+      module Observations
+        module Geo
+          module Recent
+            # @see Phoebe::Resources::Data::Observations::Geo::Recent::Species#list
+            class SpecieListParams < Phoebe::Internal::Type::BaseModel
+              extend Phoebe::Internal::Type::RequestParameters::Converter
+              include Phoebe::Internal::Type::RequestParameters
+
+              # @!attribute lat
+              #
+              #   @return [Float]
+              required :lat, Float
+
+              # @!attribute lng
+              #
+              #   @return [Float]
+              required :lng, Float
+
+              # @!attribute back
+              #   The number of days back to fetch observations.
+              #
+              #   @return [Integer, nil]
+              optional :back, Integer
+
+              # @!attribute dist
+              #   The search radius from the given position, in kilometers.
+              #
+              #   @return [Integer, nil]
+              optional :dist, Integer
+
+              # @!attribute hotspot
+              #   Only fetch observations from hotspots
+              #
+              #   @return [Boolean, nil]
+              optional :hotspot, Phoebe::Internal::Type::Boolean
+
+              # @!attribute include_provisional
+              #   Include observations which have not yet been reviewed.
+              #
+              #   @return [Boolean, nil]
+              optional :include_provisional, Phoebe::Internal::Type::Boolean
+
+              # @!attribute max_results
+              #   Only fetch this number of observations
+              #
+              #   @return [Integer, nil]
+              optional :max_results, Integer
+
+              # @!attribute spp_locale
+              #   Use this language for species common names
+              #
+              #   @return [String, nil]
+              optional :spp_locale, String
+
+              # @!method initialize(lat:, lng:, back: nil, dist: nil, hotspot: nil, include_provisional: nil, max_results: nil, spp_locale: nil, request_options: {})
+              #   @param lat [Float]
+              #
+              #   @param lng [Float]
+              #
+              #   @param back [Integer] The number of days back to fetch observations.
+              #
+              #   @param dist [Integer] The search radius from the given position, in kilometers.
+              #
+              #   @param hotspot [Boolean] Only fetch observations from hotspots
+              #
+              #   @param include_provisional [Boolean] Include observations which have not yet been reviewed.
+              #
+              #   @param max_results [Integer] Only fetch this number of observations
+              #
+              #   @param spp_locale [String] Use this language for species common names
+              #
+              #   @param request_options [Phoebe::RequestOptions, Hash{Symbol=>Object}]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/phoebe/models/data/observations/geo/recent/specie_list_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Phoebe
+  module Models
+    module Data
+      module Observations
+        module Geo
+          module Recent
+            # @type [Phoebe::Internal::Type::Converter]
+            SpecieListResponse = Phoebe::Internal::Type::ArrayOf[-> { Phoebe::Data::Observation }]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/phoebe/models/data/observations/geo/recent_list_params.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+module Phoebe
+  module Models
+    module Data
+      module Observations
+        module Geo
+          # @see Phoebe::Resources::Data::Observations::Geo::Recent#list
+          class RecentListParams < Phoebe::Internal::Type::BaseModel
+            extend Phoebe::Internal::Type::RequestParameters::Converter
+            include Phoebe::Internal::Type::RequestParameters
+
+            # @!attribute lat
+            #
+            #   @return [Float]
+            required :lat, Float
+
+            # @!attribute lng
+            #
+            #   @return [Float]
+            required :lng, Float
+
+            # @!attribute back
+            #   The number of days back to fetch observations.
+            #
+            #   @return [Integer, nil]
+            optional :back, Integer
+
+            # @!attribute cat
+            #   Only fetch observations from these taxonomic categories
+            #
+            #   @return [Symbol, Phoebe::Models::Data::Observations::Geo::RecentListParams::Cat, nil]
+            optional :cat, enum: -> { Phoebe::Data::Observations::Geo::RecentListParams::Cat }
+
+            # @!attribute dist
+            #   The search radius from the given position, in kilometers.
+            #
+            #   @return [Integer, nil]
+            optional :dist, Integer
+
+            # @!attribute hotspot
+            #   Only fetch observations from hotspots
+            #
+            #   @return [Boolean, nil]
+            optional :hotspot, Phoebe::Internal::Type::Boolean
+
+            # @!attribute include_provisional
+            #   Include observations which have not yet been reviewed.
+            #
+            #   @return [Boolean, nil]
+            optional :include_provisional, Phoebe::Internal::Type::Boolean
+
+            # @!attribute max_results
+            #   Only fetch this number of observations
+            #
+            #   @return [Integer, nil]
+            optional :max_results, Integer
+
+            # @!attribute sort
+            #   Sort observations by taxonomy or by date, most recent first.
+            #
+            #   @return [Symbol, Phoebe::Models::Data::Observations::Geo::RecentListParams::Sort, nil]
+            optional :sort, enum: -> { Phoebe::Data::Observations::Geo::RecentListParams::Sort }
+
+            # @!attribute spp_locale
+            #   Use this language for species common names
+            #
+            #   @return [String, nil]
+            optional :spp_locale, String
+
+            # @!method initialize(lat:, lng:, back: nil, cat: nil, dist: nil, hotspot: nil, include_provisional: nil, max_results: nil, sort: nil, spp_locale: nil, request_options: {})
+            #   @param lat [Float]
+            #
+            #   @param lng [Float]
+            #
+            #   @param back [Integer] The number of days back to fetch observations.
+            #
+            #   @param cat [Symbol, Phoebe::Models::Data::Observations::Geo::RecentListParams::Cat] Only fetch observations from these taxonomic categories
+            #
+            #   @param dist [Integer] The search radius from the given position, in kilometers.
+            #
+            #   @param hotspot [Boolean] Only fetch observations from hotspots
+            #
+            #   @param include_provisional [Boolean] Include observations which have not yet been reviewed.
+            #
+            #   @param max_results [Integer] Only fetch this number of observations
+            #
+            #   @param sort [Symbol, Phoebe::Models::Data::Observations::Geo::RecentListParams::Sort] Sort observations by taxonomy or by date, most recent first.
+            #
+            #   @param spp_locale [String] Use this language for species common names
+            #
+            #   @param request_options [Phoebe::RequestOptions, Hash{Symbol=>Object}]
+
+            # Only fetch observations from these taxonomic categories
+            module Cat
+              extend Phoebe::Internal::Type::Enum
+
+              SPECIES = :species
+              SLASH = :slash
+              ISSF = :issf
+              SPUH = :spuh
+              HYBRID = :hybrid
+              DOMESTIC = :domestic
+              FORM = :form
+              INTERGRADE = :intergrade
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+
+            # Sort observations by taxonomy or by date, most recent first.
+            module Sort
+              extend Phoebe::Internal::Type::Enum
+
+              DATE = :date
+              SPECIES = :species
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/phoebe/models/data/observations/geo/recent_list_response.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Phoebe
+  module Models
+    module Data
+      module Observations
+        module Geo
+          # @type [Phoebe::Internal::Type::Converter]
+          RecentListResponse = Phoebe::Internal::Type::ArrayOf[-> { Phoebe::Data::Observation }]
+        end
+      end
+    end
+  end
+end

data/lib/phoebe/models/data/observations/nearest/geo_specie_list_params.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module Phoebe
+  module Models
+    module Data
+      module Observations
+        module Nearest
+          # @see Phoebe::Resources::Data::Observations::Nearest::GeoSpecies#list
+          class GeoSpecieListParams < Phoebe::Internal::Type::BaseModel
+            extend Phoebe::Internal::Type::RequestParameters::Converter
+            include Phoebe::Internal::Type::RequestParameters
+
+            # @!attribute lat
+            #
+            #   @return [Float]
+            required :lat, Float
+
+            # @!attribute lng
+            #
+            #   @return [Float]
+            required :lng, Float
+
+            # @!attribute back
+            #   The number of days back to fetch observations.
+            #
+            #   @return [Integer, nil]
+            optional :back, Integer
+
+            # @!attribute dist
+            #   Only fetch observations within this distance of the provided lat/lng
+            #
+            #   @return [Integer, nil]
+            optional :dist, Integer
+
+            # @!attribute hotspot
+            #   Only fetch observations from hotspots
+            #
+            #   @return [Boolean, nil]
+            optional :hotspot, Phoebe::Internal::Type::Boolean
+
+            # @!attribute include_provisional
+            #   Include observations which have not yet been reviewed.
+            #
+            #   @return [Boolean, nil]
+            optional :include_provisional, Phoebe::Internal::Type::Boolean
+
+            # @!attribute max_results
+            #   Only fetch up to this number of observations
+            #
+            #   @return [Integer, nil]
+            optional :max_results, Integer
+
+            # @!attribute spp_locale
+            #   Use this language for species common names
+            #
+            #   @return [String, nil]
+            optional :spp_locale, String
+
+            # @!method initialize(lat:, lng:, back: nil, dist: nil, hotspot: nil, include_provisional: nil, max_results: nil, spp_locale: nil, request_options: {})
+            #   @param lat [Float]
+            #
+            #   @param lng [Float]
+            #
+            #   @param back [Integer] The number of days back to fetch observations.
+            #
+            #   @param dist [Integer] Only fetch observations within this distance of the provided lat/lng
+            #
+            #   @param hotspot [Boolean] Only fetch observations from hotspots
+            #
+            #   @param include_provisional [Boolean] Include observations which have not yet been reviewed.
+            #
+            #   @param max_results [Integer] Only fetch up to this number of observations
+            #
+            #   @param spp_locale [String] Use this language for species common names
+            #
+            #   @param request_options [Phoebe::RequestOptions, Hash{Symbol=>Object}]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/phoebe/models/data/observations/nearest/geo_specie_list_response.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Phoebe
+  module Models
+    module Data
+      module Observations
+        module Nearest
+          # @type [Phoebe::Internal::Type::Converter]
+          GeoSpecieListResponse = Phoebe::Internal::Type::ArrayOf[-> { Phoebe::Data::Observation }]
+        end
+      end
+    end
+  end
+end