phoebe 0.1.0.pre.alpha.1

data/sig/phoebe/models/product/lists/historical_retrieve_response.rbs

@@ -0,0 +1,374 @@
+module Phoebe
+  module Models
+    module Product
+      module Lists
+        type historical_retrieve_response_item =
+          {
+            all_obs_reported: bool,
+            checklist_id: String,
+            creation_dt: String,
+            duration_hrs: Float,
+            iso_obs_date: String,
+            last_edited_dt: String,
+            loc: Phoebe::Models::Product::Lists::HistoricalRetrieveResponseItem::Loc,
+            loc_id: String,
+            num_observers: Integer,
+            num_species: Integer,
+            obs: ::Array[Phoebe::Models::Product::Lists::HistoricalRetrieveResponseItem::Ob],
+            obs_dt: String,
+            obs_time: String,
+            obs_time_valid: bool,
+            proj_id: String,
+            protocol_id: String,
+            sub_id: String,
+            submission_method_code: String,
+            :subnational1_code => String,
+            user_display_name: String
+          }
+
+        class HistoricalRetrieveResponseItem < Phoebe::Internal::Type::BaseModel
+          attr_reader all_obs_reported: bool?
+
+          def all_obs_reported=: (bool) -> bool
+
+          attr_reader checklist_id: String?
+
+          def checklist_id=: (String) -> String
+
+          attr_reader creation_dt: String?
+
+          def creation_dt=: (String) -> String
+
+          attr_reader duration_hrs: Float?
+
+          def duration_hrs=: (Float) -> Float
+
+          attr_reader iso_obs_date: String?
+
+          def iso_obs_date=: (String) -> String
+
+          attr_reader last_edited_dt: String?
+
+          def last_edited_dt=: (String) -> String
+
+          attr_reader loc: Phoebe::Models::Product::Lists::HistoricalRetrieveResponseItem::Loc?
+
+          def loc=: (
+            Phoebe::Models::Product::Lists::HistoricalRetrieveResponseItem::Loc
+          ) -> Phoebe::Models::Product::Lists::HistoricalRetrieveResponseItem::Loc
+
+          attr_reader loc_id: String?
+
+          def loc_id=: (String) -> String
+
+          attr_reader num_observers: Integer?
+
+          def num_observers=: (Integer) -> Integer
+
+          attr_reader num_species: Integer?
+
+          def num_species=: (Integer) -> Integer
+
+          attr_reader obs: ::Array[Phoebe::Models::Product::Lists::HistoricalRetrieveResponseItem::Ob]?
+
+          def obs=: (
+            ::Array[Phoebe::Models::Product::Lists::HistoricalRetrieveResponseItem::Ob]
+          ) -> ::Array[Phoebe::Models::Product::Lists::HistoricalRetrieveResponseItem::Ob]
+
+          attr_reader obs_dt: String?
+
+          def obs_dt=: (String) -> String
+
+          attr_reader obs_time: String?
+
+          def obs_time=: (String) -> String
+
+          attr_reader obs_time_valid: bool?
+
+          def obs_time_valid=: (bool) -> bool
+
+          attr_reader proj_id: String?
+
+          def proj_id=: (String) -> String
+
+          attr_reader protocol_id: String?
+
+          def protocol_id=: (String) -> String
+
+          attr_reader sub_id: String?
+
+          def sub_id=: (String) -> String
+
+          attr_reader submission_method_code: String?
+
+          def submission_method_code=: (String) -> String
+
+          attr_reader subnational1_code: String?
+
+          def subnational1_code=: (String) -> String
+
+          attr_reader user_display_name: String?
+
+          def user_display_name=: (String) -> String
+
+          def initialize: (
+            ?all_obs_reported: bool,
+            ?checklist_id: String,
+            ?creation_dt: String,
+            ?duration_hrs: Float,
+            ?iso_obs_date: String,
+            ?last_edited_dt: String,
+            ?loc: Phoebe::Models::Product::Lists::HistoricalRetrieveResponseItem::Loc,
+            ?loc_id: String,
+            ?num_observers: Integer,
+            ?num_species: Integer,
+            ?obs: ::Array[Phoebe::Models::Product::Lists::HistoricalRetrieveResponseItem::Ob],
+            ?obs_dt: String,
+            ?obs_time: String,
+            ?obs_time_valid: bool,
+            ?proj_id: String,
+            ?protocol_id: String,
+            ?sub_id: String,
+            ?submission_method_code: String,
+            ?subnational1_code: String,
+            ?user_display_name: String
+          ) -> void
+
+          def to_hash: -> {
+            all_obs_reported: bool,
+            checklist_id: String,
+            creation_dt: String,
+            duration_hrs: Float,
+            iso_obs_date: String,
+            last_edited_dt: String,
+            loc: Phoebe::Models::Product::Lists::HistoricalRetrieveResponseItem::Loc,
+            loc_id: String,
+            num_observers: Integer,
+            num_species: Integer,
+            obs: ::Array[Phoebe::Models::Product::Lists::HistoricalRetrieveResponseItem::Ob],
+            obs_dt: String,
+            obs_time: String,
+            obs_time_valid: bool,
+            proj_id: String,
+            protocol_id: String,
+            sub_id: String,
+            submission_method_code: String,
+            :subnational1_code => String,
+            user_display_name: String
+          }
+
+          type loc =
+            {
+              country_code: String,
+              country_name: String,
+              hierarchical_name: String,
+              is_hotspot: bool,
+              lat: Float,
+              latitude: Float,
+              lng: Float,
+              loc_id: String,
+              loc_name: String,
+              longitude: Float,
+              name: String,
+              :subnational1_code => String,
+              :subnational1_name => String
+            }
+
+          class Loc < Phoebe::Internal::Type::BaseModel
+            attr_reader country_code: String?
+
+            def country_code=: (String) -> String
+
+            attr_reader country_name: String?
+
+            def country_name=: (String) -> String
+
+            attr_reader hierarchical_name: String?
+
+            def hierarchical_name=: (String) -> String
+
+            attr_reader is_hotspot: bool?
+
+            def is_hotspot=: (bool) -> bool
+
+            attr_reader lat: Float?
+
+            def lat=: (Float) -> Float
+
+            attr_reader latitude: Float?
+
+            def latitude=: (Float) -> Float
+
+            attr_reader lng: Float?
+
+            def lng=: (Float) -> Float
+
+            attr_reader loc_id: String?
+
+            def loc_id=: (String) -> String
+
+            attr_reader loc_name: String?
+
+            def loc_name=: (String) -> String
+
+            attr_reader longitude: Float?
+
+            def longitude=: (Float) -> Float
+
+            attr_reader name: String?
+
+            def name=: (String) -> String
+
+            attr_reader subnational1_code: String?
+
+            def subnational1_code=: (String) -> String
+
+            attr_reader subnational1_name: String?
+
+            def subnational1_name=: (String) -> String
+
+            def initialize: (
+              ?country_code: String,
+              ?country_name: String,
+              ?hierarchical_name: String,
+              ?is_hotspot: bool,
+              ?lat: Float,
+              ?latitude: Float,
+              ?lng: Float,
+              ?loc_id: String,
+              ?loc_name: String,
+              ?longitude: Float,
+              ?name: String,
+              ?subnational1_code: String,
+              ?subnational1_name: String
+            ) -> void
+
+            def to_hash: -> {
+              country_code: String,
+              country_name: String,
+              hierarchical_name: String,
+              is_hotspot: bool,
+              lat: Float,
+              latitude: Float,
+              lng: Float,
+              loc_id: String,
+              loc_name: String,
+              longitude: Float,
+              name: String,
+              :subnational1_code => String,
+              :subnational1_name => String
+            }
+          end
+
+          type ob =
+            {
+              obs_aux: ::Array[Phoebe::Models::Product::Lists::HistoricalRetrieveResponseItem::Ob::ObsAux],
+              obs_dt: String,
+              obs_id: String,
+              species_code: String
+            }
+
+          class Ob < Phoebe::Internal::Type::BaseModel
+            attr_reader obs_aux: ::Array[Phoebe::Models::Product::Lists::HistoricalRetrieveResponseItem::Ob::ObsAux]?
+
+            def obs_aux=: (
+              ::Array[Phoebe::Models::Product::Lists::HistoricalRetrieveResponseItem::Ob::ObsAux]
+            ) -> ::Array[Phoebe::Models::Product::Lists::HistoricalRetrieveResponseItem::Ob::ObsAux]
+
+            attr_reader obs_dt: String?
+
+            def obs_dt=: (String) -> String
+
+            attr_reader obs_id: String?
+
+            def obs_id=: (String) -> String
+
+            attr_reader species_code: String?
+
+            def species_code=: (String) -> String
+
+            def initialize: (
+              ?obs_aux: ::Array[Phoebe::Models::Product::Lists::HistoricalRetrieveResponseItem::Ob::ObsAux],
+              ?obs_dt: String,
+              ?obs_id: String,
+              ?species_code: String
+            ) -> void
+
+            def to_hash: -> {
+              obs_aux: ::Array[Phoebe::Models::Product::Lists::HistoricalRetrieveResponseItem::Ob::ObsAux],
+              obs_dt: String,
+              obs_id: String,
+              species_code: String
+            }
+
+            type obs_aux =
+              {
+                aux_code: String,
+                entry_method_code: String,
+                field_name: String,
+                obs_id: String,
+                species_code: String,
+                sub_id: String,
+                value: String
+              }
+
+            class ObsAux < Phoebe::Internal::Type::BaseModel
+              attr_reader aux_code: String?
+
+              def aux_code=: (String) -> String
+
+              attr_reader entry_method_code: String?
+
+              def entry_method_code=: (String) -> String
+
+              attr_reader field_name: String?
+
+              def field_name=: (String) -> String
+
+              attr_reader obs_id: String?
+
+              def obs_id=: (String) -> String
+
+              attr_reader species_code: String?
+
+              def species_code=: (String) -> String
+
+              attr_reader sub_id: String?
+
+              def sub_id=: (String) -> String
+
+              attr_reader value: String?
+
+              def value=: (String) -> String
+
+              def initialize: (
+                ?aux_code: String,
+                ?entry_method_code: String,
+                ?field_name: String,
+                ?obs_id: String,
+                ?species_code: String,
+                ?sub_id: String,
+                ?value: String
+              ) -> void
+
+              def to_hash: -> {
+                aux_code: String,
+                entry_method_code: String,
+                field_name: String,
+                obs_id: String,
+                species_code: String,
+                sub_id: String,
+                value: String
+              }
+            end
+          end
+        end
+
+        type historical_retrieve_response =
+          ::Array[Phoebe::Models::Product::Lists::HistoricalRetrieveResponseItem]
+
+        HistoricalRetrieveResponse: Phoebe::Internal::Type::Converter
+      end
+    end
+  end
+end

data/sig/phoebe/models/product/species_list_list_params.rbs

@@ -0,0 +1,17 @@
+module Phoebe
+  module Models
+    module Product
+      type species_list_list_params =
+        {  } & Phoebe::Internal::Type::request_parameters
+
+      class SpeciesListListParams < Phoebe::Internal::Type::BaseModel
+        extend Phoebe::Internal::Type::RequestParameters::Converter
+        include Phoebe::Internal::Type::RequestParameters
+
+        def initialize: (?request_options: Phoebe::request_opts) -> void
+
+        def to_hash: -> { request_options: Phoebe::RequestOptions }
+      end
+    end
+  end
+end

data/sig/phoebe/models/product/species_list_list_response.rbs

@@ -0,0 +1,9 @@
+module Phoebe
+  module Models
+    module Product
+      type species_list_list_response = ::Array[String]
+
+      SpeciesListListResponse: Phoebe::Internal::Type::Converter
+    end
+  end
+end

data/sig/phoebe/models/product/stat_retrieve_params.rbs

@@ -0,0 +1,34 @@
+module Phoebe
+  module Models
+    module Product
+      type stat_retrieve_params =
+        { region_code: String, y_: Integer, m: Integer }
+        & Phoebe::Internal::Type::request_parameters
+
+      class StatRetrieveParams < Phoebe::Internal::Type::BaseModel
+        extend Phoebe::Internal::Type::RequestParameters::Converter
+        include Phoebe::Internal::Type::RequestParameters
+
+        attr_accessor region_code: String
+
+        attr_accessor y_: Integer
+
+        attr_accessor m: Integer
+
+        def initialize: (
+          region_code: String,
+          y_: Integer,
+          m: Integer,
+          ?request_options: Phoebe::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          region_code: String,
+          y_: Integer,
+          m: Integer,
+          request_options: Phoebe::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/phoebe/models/product/stat_retrieve_response.rbs

@@ -0,0 +1,38 @@
+module Phoebe
+  module Models
+    module Product
+      type stat_retrieve_response =
+        {
+          num_checklists: Integer,
+          num_contributors: Integer,
+          num_species: Integer
+        }
+
+      class StatRetrieveResponse < Phoebe::Internal::Type::BaseModel
+        attr_reader num_checklists: Integer?
+
+        def num_checklists=: (Integer) -> Integer
+
+        attr_reader num_contributors: Integer?
+
+        def num_contributors=: (Integer) -> Integer
+
+        attr_reader num_species: Integer?
+
+        def num_species=: (Integer) -> Integer
+
+        def initialize: (
+          ?num_checklists: Integer,
+          ?num_contributors: Integer,
+          ?num_species: Integer
+        ) -> void
+
+        def to_hash: -> {
+          num_checklists: Integer,
+          num_contributors: Integer,
+          num_species: Integer
+        }
+      end
+    end
+  end
+end

data/sig/phoebe/models/product/top100_retrieve_params.rbs

@@ -0,0 +1,65 @@
+module Phoebe
+  module Models
+    module Product
+      type top100_retrieve_params =
+        {
+          region_code: String,
+          y_: Integer,
+          m: Integer,
+          max_results: Integer,
+          ranked_by: Phoebe::Models::Product::Top100RetrieveParams::ranked_by
+        }
+        & Phoebe::Internal::Type::request_parameters
+
+      class Top100RetrieveParams < Phoebe::Internal::Type::BaseModel
+        extend Phoebe::Internal::Type::RequestParameters::Converter
+        include Phoebe::Internal::Type::RequestParameters
+
+        attr_accessor region_code: String
+
+        attr_accessor y_: Integer
+
+        attr_accessor m: Integer
+
+        attr_reader max_results: Integer?
+
+        def max_results=: (Integer) -> Integer
+
+        attr_reader ranked_by: Phoebe::Models::Product::Top100RetrieveParams::ranked_by?
+
+        def ranked_by=: (
+          Phoebe::Models::Product::Top100RetrieveParams::ranked_by
+        ) -> Phoebe::Models::Product::Top100RetrieveParams::ranked_by
+
+        def initialize: (
+          region_code: String,
+          y_: Integer,
+          m: Integer,
+          ?max_results: Integer,
+          ?ranked_by: Phoebe::Models::Product::Top100RetrieveParams::ranked_by,
+          ?request_options: Phoebe::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          region_code: String,
+          y_: Integer,
+          m: Integer,
+          max_results: Integer,
+          ranked_by: Phoebe::Models::Product::Top100RetrieveParams::ranked_by,
+          request_options: Phoebe::RequestOptions
+        }
+
+        type ranked_by = :spp | :cl
+
+        module RankedBy
+          extend Phoebe::Internal::Type::Enum
+
+          SPP: :spp
+          CL: :cl
+
+          def self?.values: -> ::Array[Phoebe::Models::Product::Top100RetrieveParams::ranked_by]
+        end
+      end
+    end
+  end
+end

data/sig/phoebe/models/product/top100_retrieve_response.rbs

@@ -0,0 +1,64 @@
+module Phoebe
+  module Models
+    module Product
+      type top100_retrieve_response_item =
+        {
+          num_complete_checklists: Integer,
+          num_species: Integer,
+          profile_handle: String,
+          row_num: Integer,
+          user_display_name: String,
+          user_id: String
+        }
+
+      class Top100RetrieveResponseItem < Phoebe::Internal::Type::BaseModel
+        attr_reader num_complete_checklists: Integer?
+
+        def num_complete_checklists=: (Integer) -> Integer
+
+        attr_reader num_species: Integer?
+
+        def num_species=: (Integer) -> Integer
+
+        attr_reader profile_handle: String?
+
+        def profile_handle=: (String) -> String
+
+        attr_reader row_num: Integer?
+
+        def row_num=: (Integer) -> Integer
+
+        attr_reader user_display_name: String?
+
+        def user_display_name=: (String) -> String
+
+        attr_reader user_id: String?
+
+        def user_id=: (String) -> String
+
+        def initialize: (
+          ?num_complete_checklists: Integer,
+          ?num_species: Integer,
+          ?profile_handle: String,
+          ?row_num: Integer,
+          ?user_display_name: String,
+          ?user_id: String
+        ) -> void
+
+        def to_hash: -> {
+          num_complete_checklists: Integer,
+          num_species: Integer,
+          profile_handle: String,
+          row_num: Integer,
+          user_display_name: String,
+          user_id: String
+        }
+      end
+
+      type top100_retrieve_response =
+        ::Array[Phoebe::Models::Product::Top100RetrieveResponseItem]
+
+      Top100RetrieveResponse: Phoebe::Internal::Type::Converter
+    end
+  end
+end

data/sig/phoebe/models/ref/hotspot/geo_retrieve_params.rbs

@@ -0,0 +1,69 @@
+module Phoebe
+  module Models
+    module Ref
+      module Hotspot
+        type geo_retrieve_params =
+          {
+            lat: Float,
+            lng: Float,
+            back: Integer,
+            dist: Integer,
+            fmt: Phoebe::Models::Ref::Hotspot::GeoRetrieveParams::fmt
+          }
+          & Phoebe::Internal::Type::request_parameters
+
+        class GeoRetrieveParams < Phoebe::Internal::Type::BaseModel
+          extend Phoebe::Internal::Type::RequestParameters::Converter
+          include Phoebe::Internal::Type::RequestParameters
+
+          attr_accessor lat: Float
+
+          attr_accessor lng: Float
+
+          attr_reader back: Integer?
+
+          def back=: (Integer) -> Integer
+
+          attr_reader dist: Integer?
+
+          def dist=: (Integer) -> Integer
+
+          attr_reader fmt: Phoebe::Models::Ref::Hotspot::GeoRetrieveParams::fmt?
+
+          def fmt=: (
+            Phoebe::Models::Ref::Hotspot::GeoRetrieveParams::fmt
+          ) -> Phoebe::Models::Ref::Hotspot::GeoRetrieveParams::fmt
+
+          def initialize: (
+            lat: Float,
+            lng: Float,
+            ?back: Integer,
+            ?dist: Integer,
+            ?fmt: Phoebe::Models::Ref::Hotspot::GeoRetrieveParams::fmt,
+            ?request_options: Phoebe::request_opts
+          ) -> void
+
+          def to_hash: -> {
+            lat: Float,
+            lng: Float,
+            back: Integer,
+            dist: Integer,
+            fmt: Phoebe::Models::Ref::Hotspot::GeoRetrieveParams::fmt,
+            request_options: Phoebe::RequestOptions
+          }
+
+          type fmt = :csv | :json
+
+          module Fmt
+            extend Phoebe::Internal::Type::Enum
+
+            CSV: :csv
+            JSON: :json
+
+            def self?.values: -> ::Array[Phoebe::Models::Ref::Hotspot::GeoRetrieveParams::fmt]
+          end
+        end
+      end
+    end
+  end
+end