phoebe 0.1.0.pre.alpha.1

data/lib/phoebe/models/product/lists/historical_retrieve_response.rb

@@ -0,0 +1,297 @@
+# frozen_string_literal: true
+
+module Phoebe
+  module Models
+    module Product
+      module Lists
+        class HistoricalRetrieveResponseItem < Phoebe::Internal::Type::BaseModel
+          # @!attribute all_obs_reported
+          #
+          #   @return [Boolean, nil]
+          optional :all_obs_reported, Phoebe::Internal::Type::Boolean, api_name: :allObsReported
+
+          # @!attribute checklist_id
+          #
+          #   @return [String, nil]
+          optional :checklist_id, String, api_name: :checklistId
+
+          # @!attribute creation_dt
+          #
+          #   @return [String, nil]
+          optional :creation_dt, String, api_name: :creationDt
+
+          # @!attribute duration_hrs
+          #
+          #   @return [Float, nil]
+          optional :duration_hrs, Float, api_name: :durationHrs
+
+          # @!attribute iso_obs_date
+          #
+          #   @return [String, nil]
+          optional :iso_obs_date, String, api_name: :isoObsDate
+
+          # @!attribute last_edited_dt
+          #
+          #   @return [String, nil]
+          optional :last_edited_dt, String, api_name: :lastEditedDt
+
+          # @!attribute loc
+          #
+          #   @return [Phoebe::Models::Product::Lists::HistoricalRetrieveResponseItem::Loc, nil]
+          optional :loc, -> { Phoebe::Models::Product::Lists::HistoricalRetrieveResponseItem::Loc }
+
+          # @!attribute loc_id
+          #
+          #   @return [String, nil]
+          optional :loc_id, String, api_name: :locId
+
+          # @!attribute num_observers
+          #
+          #   @return [Integer, nil]
+          optional :num_observers, Integer, api_name: :numObservers
+
+          # @!attribute num_species
+          #
+          #   @return [Integer, nil]
+          optional :num_species, Integer, api_name: :numSpecies
+
+          # @!attribute obs
+          #
+          #   @return [Array<Phoebe::Models::Product::Lists::HistoricalRetrieveResponseItem::Ob>, nil]
+          optional :obs,
+                   -> { Phoebe::Internal::Type::ArrayOf[Phoebe::Models::Product::Lists::HistoricalRetrieveResponseItem::Ob] }
+
+          # @!attribute obs_dt
+          #
+          #   @return [String, nil]
+          optional :obs_dt, String, api_name: :obsDt
+
+          # @!attribute obs_time
+          #
+          #   @return [String, nil]
+          optional :obs_time, String, api_name: :obsTime
+
+          # @!attribute obs_time_valid
+          #
+          #   @return [Boolean, nil]
+          optional :obs_time_valid, Phoebe::Internal::Type::Boolean, api_name: :obsTimeValid
+
+          # @!attribute proj_id
+          #
+          #   @return [String, nil]
+          optional :proj_id, String, api_name: :projId
+
+          # @!attribute protocol_id
+          #
+          #   @return [String, nil]
+          optional :protocol_id, String, api_name: :protocolId
+
+          # @!attribute sub_id
+          #
+          #   @return [String, nil]
+          optional :sub_id, String, api_name: :subId
+
+          # @!attribute submission_method_code
+          #
+          #   @return [String, nil]
+          optional :submission_method_code, String, api_name: :submissionMethodCode
+
+          # @!attribute subnational1_code
+          #
+          #   @return [String, nil]
+          optional :subnational1_code, String, api_name: :subnational1Code
+
+          # @!attribute user_display_name
+          #
+          #   @return [String, nil]
+          optional :user_display_name, String, api_name: :userDisplayName
+
+          # @!method initialize(all_obs_reported: nil, checklist_id: nil, creation_dt: nil, duration_hrs: nil, iso_obs_date: nil, last_edited_dt: nil, loc: nil, loc_id: nil, num_observers: nil, num_species: nil, obs: nil, obs_dt: nil, obs_time: nil, obs_time_valid: nil, proj_id: nil, protocol_id: nil, sub_id: nil, submission_method_code: nil, subnational1_code: nil, user_display_name: nil)
+          #   @param all_obs_reported [Boolean]
+          #   @param checklist_id [String]
+          #   @param creation_dt [String]
+          #   @param duration_hrs [Float]
+          #   @param iso_obs_date [String]
+          #   @param last_edited_dt [String]
+          #   @param loc [Phoebe::Models::Product::Lists::HistoricalRetrieveResponseItem::Loc]
+          #   @param loc_id [String]
+          #   @param num_observers [Integer]
+          #   @param num_species [Integer]
+          #   @param obs [Array<Phoebe::Models::Product::Lists::HistoricalRetrieveResponseItem::Ob>]
+          #   @param obs_dt [String]
+          #   @param obs_time [String]
+          #   @param obs_time_valid [Boolean]
+          #   @param proj_id [String]
+          #   @param protocol_id [String]
+          #   @param sub_id [String]
+          #   @param submission_method_code [String]
+          #   @param subnational1_code [String]
+          #   @param user_display_name [String]
+
+          # @see Phoebe::Models::Product::Lists::HistoricalRetrieveResponseItem#loc
+          class Loc < 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
+
+          class Ob < Phoebe::Internal::Type::BaseModel
+            # @!attribute obs_aux
+            #
+            #   @return [Array<Phoebe::Models::Product::Lists::HistoricalRetrieveResponseItem::Ob::ObsAux>, nil]
+            optional :obs_aux,
+                     -> { Phoebe::Internal::Type::ArrayOf[Phoebe::Models::Product::Lists::HistoricalRetrieveResponseItem::Ob::ObsAux] },
+                     api_name: :obsAux
+
+            # @!attribute obs_dt
+            #
+            #   @return [String, nil]
+            optional :obs_dt, String, api_name: :obsDt
+
+            # @!attribute obs_id
+            #
+            #   @return [String, nil]
+            optional :obs_id, String, api_name: :obsId
+
+            # @!attribute species_code
+            #
+            #   @return [String, nil]
+            optional :species_code, String, api_name: :speciesCode
+
+            # @!method initialize(obs_aux: nil, obs_dt: nil, obs_id: nil, species_code: nil)
+            #   @param obs_aux [Array<Phoebe::Models::Product::Lists::HistoricalRetrieveResponseItem::Ob::ObsAux>]
+            #   @param obs_dt [String]
+            #   @param obs_id [String]
+            #   @param species_code [String]
+
+            class ObsAux < Phoebe::Internal::Type::BaseModel
+              # @!attribute aux_code
+              #
+              #   @return [String, nil]
+              optional :aux_code, String, api_name: :auxCode
+
+              # @!attribute entry_method_code
+              #
+              #   @return [String, nil]
+              optional :entry_method_code, String, api_name: :entryMethodCode
+
+              # @!attribute field_name
+              #
+              #   @return [String, nil]
+              optional :field_name, String, api_name: :fieldName
+
+              # @!attribute obs_id
+              #
+              #   @return [String, nil]
+              optional :obs_id, String, api_name: :obsId
+
+              # @!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
+
+              # @!attribute value
+              #
+              #   @return [String, nil]
+              optional :value, String
+
+              # @!method initialize(aux_code: nil, entry_method_code: nil, field_name: nil, obs_id: nil, species_code: nil, sub_id: nil, value: nil)
+              #   @param aux_code [String]
+              #   @param entry_method_code [String]
+              #   @param field_name [String]
+              #   @param obs_id [String]
+              #   @param species_code [String]
+              #   @param sub_id [String]
+              #   @param value [String]
+            end
+          end
+        end
+
+        # @type [Phoebe::Internal::Type::Converter]
+        HistoricalRetrieveResponse =
+          Phoebe::Internal::Type::ArrayOf[-> { Phoebe::Models::Product::Lists::HistoricalRetrieveResponseItem }]
+      end
+    end
+  end
+end

data/lib/phoebe/models/product/species_list_list_params.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Phoebe
+  module Models
+    module Product
+      # @see Phoebe::Resources::Product::SpeciesList#list
+      class SpeciesListListParams < 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

data/lib/phoebe/models/product/species_list_list_response.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Phoebe
+  module Models
+    module Product
+      # @type [Phoebe::Internal::Type::Converter]
+      SpeciesListListResponse = Phoebe::Internal::Type::ArrayOf[String]
+    end
+  end
+end

data/lib/phoebe/models/product/stat_retrieve_params.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Phoebe
+  module Models
+    module Product
+      # @see Phoebe::Resources::Product::Stats#retrieve
+      class StatRetrieveParams < Phoebe::Internal::Type::BaseModel
+        extend Phoebe::Internal::Type::RequestParameters::Converter
+        include Phoebe::Internal::Type::RequestParameters
+
+        # @!attribute region_code
+        #
+        #   @return [String]
+        required :region_code, String
+
+        # @!attribute y_
+        #
+        #   @return [Integer]
+        required :y_, Integer
+
+        # @!attribute m
+        #
+        #   @return [Integer]
+        required :m, Integer
+
+        # @!method initialize(region_code:, y_:, m:, request_options: {})
+        #   @param region_code [String]
+        #   @param y_ [Integer]
+        #   @param m [Integer]
+        #   @param request_options [Phoebe::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/phoebe/models/product/stat_retrieve_response.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Phoebe
+  module Models
+    module Product
+      # @see Phoebe::Resources::Product::Stats#retrieve
+      class StatRetrieveResponse < Phoebe::Internal::Type::BaseModel
+        # @!attribute num_checklists
+        #
+        #   @return [Integer, nil]
+        optional :num_checklists, Integer, api_name: :numChecklists
+
+        # @!attribute num_contributors
+        #
+        #   @return [Integer, nil]
+        optional :num_contributors, Integer, api_name: :numContributors
+
+        # @!attribute num_species
+        #
+        #   @return [Integer, nil]
+        optional :num_species, Integer, api_name: :numSpecies
+
+        # @!method initialize(num_checklists: nil, num_contributors: nil, num_species: nil)
+        #   @param num_checklists [Integer]
+        #   @param num_contributors [Integer]
+        #   @param num_species [Integer]
+      end
+    end
+  end
+end

data/lib/phoebe/models/product/top100_retrieve_params.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Phoebe
+  module Models
+    module Product
+      # @see Phoebe::Resources::Product::Top100#retrieve
+      class Top100RetrieveParams < Phoebe::Internal::Type::BaseModel
+        extend Phoebe::Internal::Type::RequestParameters::Converter
+        include Phoebe::Internal::Type::RequestParameters
+
+        # @!attribute region_code
+        #
+        #   @return [String]
+        required :region_code, String
+
+        # @!attribute y_
+        #
+        #   @return [Integer]
+        required :y_, Integer
+
+        # @!attribute m
+        #
+        #   @return [Integer]
+        required :m, Integer
+
+        # @!attribute max_results
+        #   Only fetch this number of contributors.
+        #
+        #   @return [Integer, nil]
+        optional :max_results, Integer
+
+        # @!attribute ranked_by
+        #   Order by number of complete checklists (cl) or by number of species seen (spp).
+        #
+        #   @return [Symbol, Phoebe::Models::Product::Top100RetrieveParams::RankedBy, nil]
+        optional :ranked_by, enum: -> { Phoebe::Product::Top100RetrieveParams::RankedBy }
+
+        # @!method initialize(region_code:, y_:, m:, max_results: nil, ranked_by: nil, request_options: {})
+        #   @param region_code [String]
+        #
+        #   @param y_ [Integer]
+        #
+        #   @param m [Integer]
+        #
+        #   @param max_results [Integer] Only fetch this number of contributors.
+        #
+        #   @param ranked_by [Symbol, Phoebe::Models::Product::Top100RetrieveParams::RankedBy] Order by number of complete checklists (cl) or by number of species seen (spp).
+        #
+        #   @param request_options [Phoebe::RequestOptions, Hash{Symbol=>Object}]
+
+        # Order by number of complete checklists (cl) or by number of species seen (spp).
+        module RankedBy
+          extend Phoebe::Internal::Type::Enum
+
+          SPP = :spp
+          CL = :cl
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/phoebe/models/product/top100_retrieve_response.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Phoebe
+  module Models
+    module Product
+      class Top100RetrieveResponseItem < Phoebe::Internal::Type::BaseModel
+        # @!attribute num_complete_checklists
+        #
+        #   @return [Integer, nil]
+        optional :num_complete_checklists, Integer, api_name: :numCompleteChecklists
+
+        # @!attribute num_species
+        #
+        #   @return [Integer, nil]
+        optional :num_species, Integer, api_name: :numSpecies
+
+        # @!attribute profile_handle
+        #
+        #   @return [String, nil]
+        optional :profile_handle, String, api_name: :profileHandle
+
+        # @!attribute row_num
+        #
+        #   @return [Integer, nil]
+        optional :row_num, Integer, api_name: :rowNum
+
+        # @!attribute user_display_name
+        #
+        #   @return [String, nil]
+        optional :user_display_name, String, api_name: :userDisplayName
+
+        # @!attribute user_id
+        #
+        #   @return [String, nil]
+        optional :user_id, String, api_name: :userId
+
+        # @!method initialize(num_complete_checklists: nil, num_species: nil, profile_handle: nil, row_num: nil, user_display_name: nil, user_id: nil)
+        #   @param num_complete_checklists [Integer]
+        #   @param num_species [Integer]
+        #   @param profile_handle [String]
+        #   @param row_num [Integer]
+        #   @param user_display_name [String]
+        #   @param user_id [String]
+      end
+
+      # @type [Phoebe::Internal::Type::Converter]
+      Top100RetrieveResponse =
+        Phoebe::Internal::Type::ArrayOf[-> { Phoebe::Models::Product::Top100RetrieveResponseItem }]
+    end
+  end
+end

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

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Phoebe
+  module Models
+    module Ref
+      module Hotspot
+        # @see Phoebe::Resources::Ref::Hotspot::Geo#retrieve
+        class GeoRetrieveParams < 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 hotspots.
+          #
+          #   @return [Integer, nil]
+          optional :back, Integer
+
+          # @!attribute dist
+          #   The search radius from the given position, in kilometers.
+          #
+          #   @return [Integer, nil]
+          optional :dist, Integer
+
+          # @!attribute fmt
+          #   Fetch the records in CSV or JSON format.
+          #
+          #   @return [Symbol, Phoebe::Models::Ref::Hotspot::GeoRetrieveParams::Fmt, nil]
+          optional :fmt, enum: -> { Phoebe::Ref::Hotspot::GeoRetrieveParams::Fmt }
+
+          # @!method initialize(lat:, lng:, back: nil, dist: nil, fmt: nil, request_options: {})
+          #   @param lat [Float]
+          #
+          #   @param lng [Float]
+          #
+          #   @param back [Integer] The number of days back to fetch hotspots.
+          #
+          #   @param dist [Integer] The search radius from the given position, in kilometers.
+          #
+          #   @param fmt [Symbol, Phoebe::Models::Ref::Hotspot::GeoRetrieveParams::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/hotspot/geo_retrieve_response.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Phoebe
+  module Models
+    module Ref
+      module Hotspot
+        class GeoRetrieveResponseItem < 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]
+        GeoRetrieveResponse =
+          Phoebe::Internal::Type::ArrayOf[-> { Phoebe::Models::Ref::Hotspot::GeoRetrieveResponseItem }]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Phoebe
+  module Models
+    module Ref
+      module Hotspot
+        # @see Phoebe::Resources::Ref::Hotspot::Info#retrieve
+        class InfoRetrieveParams < 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