phoebe 0.1.0.pre.alpha.1

data/lib/phoebe/models/data/observations/recent/historic_list_params.rb

@@ -0,0 +1,144 @@
+# frozen_string_literal: true
+
+module Phoebe
+  module Models
+    module Data
+      module Observations
+        module Recent
+          # @see Phoebe::Resources::Data::Observations::Recent::Historic#list
+          class HistoricListParams < 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 cat
+            #   Only fetch observations from these taxonomic categories
+            #
+            #   @return [Symbol, Phoebe::Models::Data::Observations::Recent::HistoricListParams::Cat, nil]
+            optional :cat, enum: -> { Phoebe::Data::Observations::Recent::HistoricListParams::Cat }
+
+            # @!attribute detail
+            #   Include a subset (simple), or all (full), of the fields available.
+            #
+            #   @return [Symbol, Phoebe::Models::Data::Observations::Recent::HistoricListParams::Detail, nil]
+            optional :detail, enum: -> { Phoebe::Data::Observations::Recent::HistoricListParams::Detail }
+
+            # @!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 r
+            #   Fetch observations from up to 50 locations
+            #
+            #   @return [Array<String>, nil]
+            optional :r, Phoebe::Internal::Type::ArrayOf[String]
+
+            # @!attribute rank
+            #   Include latest observation of the day, or the first added
+            #
+            #   @return [Symbol, Phoebe::Models::Data::Observations::Recent::HistoricListParams::Rank, nil]
+            optional :rank, enum: -> { Phoebe::Data::Observations::Recent::HistoricListParams::Rank }
+
+            # @!attribute spp_locale
+            #   Use this language for species common names
+            #
+            #   @return [String, nil]
+            optional :spp_locale, String
+
+            # @!method initialize(region_code:, y_:, m:, cat: nil, detail: nil, hotspot: nil, include_provisional: nil, max_results: nil, r: nil, rank: nil, spp_locale: nil, request_options: {})
+            #   @param region_code [String]
+            #
+            #   @param y_ [Integer]
+            #
+            #   @param m [Integer]
+            #
+            #   @param cat [Symbol, Phoebe::Models::Data::Observations::Recent::HistoricListParams::Cat] Only fetch observations from these taxonomic categories
+            #
+            #   @param detail [Symbol, Phoebe::Models::Data::Observations::Recent::HistoricListParams::Detail] Include a subset (simple), or all (full), of the fields available.
+            #
+            #   @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 r [Array<String>] Fetch observations from up to 50 locations
+            #
+            #   @param rank [Symbol, Phoebe::Models::Data::Observations::Recent::HistoricListParams::Rank] Include latest observation of the day, or the first added
+            #
+            #   @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
+
+            # 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
+
+            # Include latest observation of the day, or the first added
+            module Rank
+              extend Phoebe::Internal::Type::Enum
+
+              MREC = :mrec
+              CREATE = :create
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/phoebe/models/data/observations/recent/historic_list_response.rb

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

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

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Phoebe
+  module Models
+    module Data
+      module Observations
+        module Recent
+          # @see Phoebe::Resources::Data::Observations::Recent::Notable#list
+          class NotableListParams < Phoebe::Internal::Type::BaseModel
+            extend Phoebe::Internal::Type::RequestParameters::Converter
+            include Phoebe::Internal::Type::RequestParameters
+
+            # @!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::Recent::NotableListParams::Detail, nil]
+            optional :detail, enum: -> { Phoebe::Data::Observations::Recent::NotableListParams::Detail }
+
+            # @!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 r
+            #   Fetch observations from up to 10 locations
+            #
+            #   @return [Array<String>, nil]
+            optional :r, Phoebe::Internal::Type::ArrayOf[String]
+
+            # @!attribute spp_locale
+            #   Use this language for species common names
+            #
+            #   @return [String, nil]
+            optional :spp_locale, String
+
+            # @!method initialize(back: nil, detail: nil, hotspot: nil, max_results: nil, r: nil, spp_locale: nil, request_options: {})
+            #   @param back [Integer] The number of days back to fetch observations.
+            #
+            #   @param detail [Symbol, Phoebe::Models::Data::Observations::Recent::NotableListParams::Detail] Include a subset (simple), or all (full), of the fields available.
+            #
+            #   @param hotspot [Boolean] Only fetch observations from hotspots
+            #
+            #   @param max_results [Integer] Only fetch this number of observations
+            #
+            #   @param r [Array<String>] Fetch observations from up to 10 locations
+            #
+            #   @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

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

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

data/lib/phoebe/models/data/observations/recent/specie_retrieve_params.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Phoebe
+  module Models
+    module Data
+      module Observations
+        module Recent
+          # @see Phoebe::Resources::Data::Observations::Recent::Species#retrieve
+          class SpecieRetrieveParams < 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 back
+            #   The number of days back to fetch observations.
+            #
+            #   @return [Integer, nil]
+            optional :back, 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 r
+            #   Fetch observations from up to 10 locations
+            #
+            #   @return [Array<String>, nil]
+            optional :r, Phoebe::Internal::Type::ArrayOf[String]
+
+            # @!attribute spp_locale
+            #   Use this language for species common names
+            #
+            #   @return [String, nil]
+            optional :spp_locale, String
+
+            # @!method initialize(region_code:, back: nil, hotspot: nil, include_provisional: nil, max_results: nil, r: nil, spp_locale: nil, request_options: {})
+            #   @param region_code [String]
+            #
+            #   @param back [Integer] The number of days back to fetch observations.
+            #
+            #   @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 r [Array<String>] Fetch observations from up to 10 locations
+            #
+            #   @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/recent/specie_retrieve_response.rb

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

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

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module Phoebe
+  module Models
+    module Data
+      module Observations
+        # @see Phoebe::Resources::Data::Observations::Recent#list
+        class RecentListParams < Phoebe::Internal::Type::BaseModel
+          extend Phoebe::Internal::Type::RequestParameters::Converter
+          include Phoebe::Internal::Type::RequestParameters
+
+          # @!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::RecentListParams::Cat, nil]
+          optional :cat, enum: -> { Phoebe::Data::Observations::RecentListParams::Cat }
+
+          # @!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 r
+          #   Fetch observations from up to 10 locations
+          #
+          #   @return [Array<String>, nil]
+          optional :r, Phoebe::Internal::Type::ArrayOf[String]
+
+          # @!attribute spp_locale
+          #   Use this language for species common names
+          #
+          #   @return [String, nil]
+          optional :spp_locale, String
+
+          # @!method initialize(back: nil, cat: nil, hotspot: nil, include_provisional: nil, max_results: nil, r: nil, spp_locale: nil, request_options: {})
+          #   @param back [Integer] The number of days back to fetch observations.
+          #
+          #   @param cat [Symbol, Phoebe::Models::Data::Observations::RecentListParams::Cat] Only fetch observations from these taxonomic categories
+          #
+          #   @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 r [Array<String>] Fetch observations from up to 10 locations
+          #
+          #   @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
+        end
+      end
+    end
+  end
+end

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

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

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

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