onebusaway-sdk 0.1.0.pre.alpha.207 → 0.1.0.pre.alpha.208

data/lib/onebusaway_sdk/models/report_problem_with_stop_retrieve_params.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module OnebusawaySDK
+  module Models
+    # @see OnebusawaySDK::Resources::ReportProblemWithStop#retrieve
+    class ReportProblemWithStopRetrieveParams < OnebusawaySDK::Internal::Type::BaseModel
+      extend OnebusawaySDK::Internal::Type::RequestParameters::Converter
+      include OnebusawaySDK::Internal::Type::RequestParameters
+
+      # @!attribute code
+      #   A string code identifying the nature of the problem
+      #
+      #   @return [Symbol, OnebusawaySDK::ReportProblemWithStopRetrieveParams::Code, nil]
+      optional :code, enum: -> { OnebusawaySDK::ReportProblemWithStopRetrieveParams::Code }
+
+      # @!attribute user_comment
+      #   Additional comment text supplied by the user describing the problem
+      #
+      #   @return [String, nil]
+      optional :user_comment, String
+
+      # @!attribute user_lat
+      #   The reporting user’s current latitude
+      #
+      #   @return [Float, nil]
+      optional :user_lat, Float
+
+      # @!attribute user_location_accuracy
+      #   The reporting user’s location accuracy, in meters
+      #
+      #   @return [Float, nil]
+      optional :user_location_accuracy, Float
+
+      # @!attribute user_lon
+      #   The reporting user’s current longitude
+      #
+      #   @return [Float, nil]
+      optional :user_lon, Float
+
+      # @!method initialize(code: nil, user_comment: nil, user_lat: nil, user_location_accuracy: nil, user_lon: nil, request_options: {})
+      #   @param code [Symbol, OnebusawaySDK::ReportProblemWithStopRetrieveParams::Code] A string code identifying the nature of the problem
+      #
+      #   @param user_comment [String] Additional comment text supplied by the user describing the problem
+      #
+      #   @param user_lat [Float] The reporting user’s current latitude
+      #
+      #   @param user_location_accuracy [Float] The reporting user’s location accuracy, in meters
+      #
+      #   @param user_lon [Float] The reporting user’s current longitude
+      #
+      #   @param request_options [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}]
+
+      # A string code identifying the nature of the problem
+      module Code
+        extend OnebusawaySDK::Internal::Type::Enum
+
+        STOP_NAME_WRONG = :stop_name_wrong
+        STOP_NUMBER_WRONG = :stop_number_wrong
+        STOP_LOCATION_WRONG = :stop_location_wrong
+        ROUTE_OR_TRIP_MISSING = :route_or_trip_missing
+        OTHER = :other
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/onebusaway_sdk/models/report_problem_with_trip_retrieve_params.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+module OnebusawaySDK
+  module Models
+    # @see OnebusawaySDK::Resources::ReportProblemWithTrip#retrieve
+    class ReportProblemWithTripRetrieveParams < OnebusawaySDK::Internal::Type::BaseModel
+      extend OnebusawaySDK::Internal::Type::RequestParameters::Converter
+      include OnebusawaySDK::Internal::Type::RequestParameters
+
+      # @!attribute code
+      #   A string code identifying the nature of the problem
+      #
+      #   @return [Symbol, OnebusawaySDK::ReportProblemWithTripRetrieveParams::Code, nil]
+      optional :code, enum: -> { OnebusawaySDK::ReportProblemWithTripRetrieveParams::Code }
+
+      # @!attribute service_date
+      #   The service date of the trip
+      #
+      #   @return [Integer, nil]
+      optional :service_date, Integer
+
+      # @!attribute stop_id
+      #   A stop ID indicating where the user is experiencing the problem
+      #
+      #   @return [String, nil]
+      optional :stop_id, String
+
+      # @!attribute user_comment
+      #   Additional comment text supplied by the user describing the problem
+      #
+      #   @return [String, nil]
+      optional :user_comment, String
+
+      # @!attribute user_lat
+      #   The reporting user’s current latitude
+      #
+      #   @return [Float, nil]
+      optional :user_lat, Float
+
+      # @!attribute user_location_accuracy
+      #   The reporting user’s location accuracy, in meters
+      #
+      #   @return [Float, nil]
+      optional :user_location_accuracy, Float
+
+      # @!attribute user_lon
+      #   The reporting user’s current longitude
+      #
+      #   @return [Float, nil]
+      optional :user_lon, Float
+
+      # @!attribute user_on_vehicle
+      #   Indicator if the user is on the transit vehicle experiencing the problem
+      #
+      #   @return [Boolean, nil]
+      optional :user_on_vehicle, OnebusawaySDK::Internal::Type::Boolean
+
+      # @!attribute user_vehicle_number
+      #   The vehicle number, as reported by the user
+      #
+      #   @return [String, nil]
+      optional :user_vehicle_number, String
+
+      # @!attribute vehicle_id
+      #   The vehicle actively serving the trip
+      #
+      #   @return [String, nil]
+      optional :vehicle_id, String
+
+      # @!method initialize(code: nil, service_date: nil, stop_id: nil, user_comment: nil, user_lat: nil, user_location_accuracy: nil, user_lon: nil, user_on_vehicle: nil, user_vehicle_number: nil, vehicle_id: nil, request_options: {})
+      #   @param code [Symbol, OnebusawaySDK::ReportProblemWithTripRetrieveParams::Code] A string code identifying the nature of the problem
+      #
+      #   @param service_date [Integer] The service date of the trip
+      #
+      #   @param stop_id [String] A stop ID indicating where the user is experiencing the problem
+      #
+      #   @param user_comment [String] Additional comment text supplied by the user describing the problem
+      #
+      #   @param user_lat [Float] The reporting user’s current latitude
+      #
+      #   @param user_location_accuracy [Float] The reporting user’s location accuracy, in meters
+      #
+      #   @param user_lon [Float] The reporting user’s current longitude
+      #
+      #   @param user_on_vehicle [Boolean] Indicator if the user is on the transit vehicle experiencing the problem
+      #
+      #   @param user_vehicle_number [String] The vehicle number, as reported by the user
+      #
+      #   @param vehicle_id [String] The vehicle actively serving the trip
+      #
+      #   @param request_options [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}]
+
+      # A string code identifying the nature of the problem
+      module Code
+        extend OnebusawaySDK::Internal::Type::Enum
+
+        VEHICLE_NEVER_CAME = :vehicle_never_came
+        VEHICLE_CAME_EARLY = :vehicle_came_early
+        VEHICLE_CAME_LATE = :vehicle_came_late
+        WRONG_HEADSIGN = :wrong_headsign
+        VEHICLE_DOES_NOT_STOP_HERE = :vehicle_does_not_stop_here
+        OTHER = :other
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/{onebusaway-sdk → onebusaway_sdk}/models/response_wrapper.rb

@@ -2,7 +2,7 @@
 
 module OnebusawaySDK
   module Models
-    class ResponseWrapper < OnebusawaySDK::BaseModel
+    class ResponseWrapper < OnebusawaySDK::Internal::Type::BaseModel
       # @!attribute code
       #
       #   @return [Integer]
@@ -23,15 +23,11 @@ module OnebusawaySDK
       #   @return [Integer]
       required :version, Integer
 
-      # @!parse
-      #   # @param code [Integer]
-      #   # @param current_time [Integer]
-      #   # @param text [String]
-      #   # @param version [Integer]
-      #   #
-      #   def initialize(code:, current_time:, text:, version:, **) = super
-
-      # def initialize: (Hash | OnebusawaySDK::BaseModel) -> void
+      # @!method initialize(code:, current_time:, text:, version:)
+      #   @param code [Integer]
+      #   @param current_time [Integer]
+      #   @param text [String]
+      #   @param version [Integer]
     end
   end
 end

data/lib/onebusaway_sdk/models/route_ids_for_agency_list_params.rb

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

data/lib/onebusaway_sdk/models/route_ids_for_agency_list_response.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module OnebusawaySDK
+  module Models
+    # @see OnebusawaySDK::Resources::RouteIDsForAgency#list
+    class RouteIDsForAgencyListResponse < OnebusawaySDK::Models::ResponseWrapper
+      # @!attribute data
+      #
+      #   @return [OnebusawaySDK::Models::RouteIDsForAgencyListResponse::Data]
+      required :data, -> { OnebusawaySDK::Models::RouteIDsForAgencyListResponse::Data }
+
+      # @!method initialize(data:)
+      #   @param data [OnebusawaySDK::Models::RouteIDsForAgencyListResponse::Data]
+
+      class Data < OnebusawaySDK::Internal::Type::BaseModel
+        # @!attribute limit_exceeded
+        #
+        #   @return [Boolean]
+        required :limit_exceeded, OnebusawaySDK::Internal::Type::Boolean, api_name: :limitExceeded
+
+        # @!attribute list
+        #
+        #   @return [Array<String>]
+        required :list, OnebusawaySDK::Internal::Type::ArrayOf[String]
+
+        # @!attribute references
+        #
+        #   @return [OnebusawaySDK::References]
+        required :references, -> { OnebusawaySDK::References }
+
+        # @!method initialize(limit_exceeded:, list:, references:)
+        #   @param limit_exceeded [Boolean]
+        #   @param list [Array<String>]
+        #   @param references [OnebusawaySDK::References]
+      end
+    end
+  end
+end

data/lib/onebusaway_sdk/models/route_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module OnebusawaySDK
+  module Models
+    # @see OnebusawaySDK::Resources::Route#retrieve
+    class RouteRetrieveParams < OnebusawaySDK::Internal::Type::BaseModel
+      extend OnebusawaySDK::Internal::Type::RequestParameters::Converter
+      include OnebusawaySDK::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/onebusaway_sdk/models/route_retrieve_response.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module OnebusawaySDK
+  module Models
+    # @see OnebusawaySDK::Resources::Route#retrieve
+    class RouteRetrieveResponse < OnebusawaySDK::Models::ResponseWrapper
+      # @!attribute data
+      #
+      #   @return [OnebusawaySDK::Models::RouteRetrieveResponse::Data]
+      required :data, -> { OnebusawaySDK::Models::RouteRetrieveResponse::Data }
+
+      # @!method initialize(data:)
+      #   @param data [OnebusawaySDK::Models::RouteRetrieveResponse::Data]
+
+      class Data < OnebusawaySDK::Internal::Type::BaseModel
+        # @!attribute entry
+        #
+        #   @return [OnebusawaySDK::Models::RouteRetrieveResponse::Data::Entry]
+        required :entry, -> { OnebusawaySDK::Models::RouteRetrieveResponse::Data::Entry }
+
+        # @!attribute references
+        #
+        #   @return [OnebusawaySDK::References]
+        required :references, -> { OnebusawaySDK::References }
+
+        # @!method initialize(entry:, references:)
+        #   @param entry [OnebusawaySDK::Models::RouteRetrieveResponse::Data::Entry]
+        #   @param references [OnebusawaySDK::References]
+
+        # @see OnebusawaySDK::Models::RouteRetrieveResponse::Data#entry
+        class Entry < OnebusawaySDK::Internal::Type::BaseModel
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute agency_id
+          #
+          #   @return [String]
+          required :agency_id, String, api_name: :agencyId
+
+          # @!attribute type
+          #
+          #   @return [Integer]
+          required :type, Integer
+
+          # @!attribute color
+          #
+          #   @return [String, nil]
+          optional :color, String
+
+          # @!attribute description
+          #
+          #   @return [String, nil]
+          optional :description, String
+
+          # @!attribute long_name
+          #
+          #   @return [String, nil]
+          optional :long_name, String, api_name: :longName
+
+          # @!attribute null_safe_short_name
+          #
+          #   @return [String, nil]
+          optional :null_safe_short_name, String, api_name: :nullSafeShortName
+
+          # @!attribute short_name
+          #
+          #   @return [String, nil]
+          optional :short_name, String, api_name: :shortName
+
+          # @!attribute text_color
+          #
+          #   @return [String, nil]
+          optional :text_color, String, api_name: :textColor
+
+          # @!attribute url
+          #
+          #   @return [String, nil]
+          optional :url, String
+
+          # @!method initialize(id:, agency_id:, type:, color: nil, description: nil, long_name: nil, null_safe_short_name: nil, short_name: nil, text_color: nil, url: nil)
+          #   @param id [String]
+          #   @param agency_id [String]
+          #   @param type [Integer]
+          #   @param color [String]
+          #   @param description [String]
+          #   @param long_name [String]
+          #   @param null_safe_short_name [String]
+          #   @param short_name [String]
+          #   @param text_color [String]
+          #   @param url [String]
+        end
+      end
+    end
+  end
+end

data/lib/onebusaway_sdk/models/routes_for_agency_list_params.rb

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

data/lib/onebusaway_sdk/models/routes_for_agency_list_response.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+module OnebusawaySDK
+  module Models
+    # @see OnebusawaySDK::Resources::RoutesForAgency#list
+    class RoutesForAgencyListResponse < OnebusawaySDK::Models::ResponseWrapper
+      # @!attribute data
+      #
+      #   @return [OnebusawaySDK::Models::RoutesForAgencyListResponse::Data]
+      required :data, -> { OnebusawaySDK::Models::RoutesForAgencyListResponse::Data }
+
+      # @!method initialize(data:)
+      #   @param data [OnebusawaySDK::Models::RoutesForAgencyListResponse::Data]
+
+      class Data < OnebusawaySDK::Internal::Type::BaseModel
+        # @!attribute limit_exceeded
+        #
+        #   @return [Boolean]
+        required :limit_exceeded, OnebusawaySDK::Internal::Type::Boolean, api_name: :limitExceeded
+
+        # @!attribute list
+        #
+        #   @return [Array<OnebusawaySDK::Models::RoutesForAgencyListResponse::Data::List>]
+        required :list,
+                 -> { OnebusawaySDK::Internal::Type::ArrayOf[OnebusawaySDK::Models::RoutesForAgencyListResponse::Data::List] }
+
+        # @!attribute references
+        #
+        #   @return [OnebusawaySDK::References]
+        required :references, -> { OnebusawaySDK::References }
+
+        # @!method initialize(limit_exceeded:, list:, references:)
+        #   @param limit_exceeded [Boolean]
+        #   @param list [Array<OnebusawaySDK::Models::RoutesForAgencyListResponse::Data::List>]
+        #   @param references [OnebusawaySDK::References]
+
+        class List < OnebusawaySDK::Internal::Type::BaseModel
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute agency_id
+          #
+          #   @return [String]
+          required :agency_id, String, api_name: :agencyId
+
+          # @!attribute type
+          #
+          #   @return [Integer]
+          required :type, Integer
+
+          # @!attribute color
+          #
+          #   @return [String, nil]
+          optional :color, String
+
+          # @!attribute description
+          #
+          #   @return [String, nil]
+          optional :description, String
+
+          # @!attribute long_name
+          #
+          #   @return [String, nil]
+          optional :long_name, String, api_name: :longName
+
+          # @!attribute null_safe_short_name
+          #
+          #   @return [String, nil]
+          optional :null_safe_short_name, String, api_name: :nullSafeShortName
+
+          # @!attribute short_name
+          #
+          #   @return [String, nil]
+          optional :short_name, String, api_name: :shortName
+
+          # @!attribute text_color
+          #
+          #   @return [String, nil]
+          optional :text_color, String, api_name: :textColor
+
+          # @!attribute url
+          #
+          #   @return [String, nil]
+          optional :url, String
+
+          # @!method initialize(id:, agency_id:, type:, color: nil, description: nil, long_name: nil, null_safe_short_name: nil, short_name: nil, text_color: nil, url: nil)
+          #   @param id [String]
+          #   @param agency_id [String]
+          #   @param type [Integer]
+          #   @param color [String]
+          #   @param description [String]
+          #   @param long_name [String]
+          #   @param null_safe_short_name [String]
+          #   @param short_name [String]
+          #   @param text_color [String]
+          #   @param url [String]
+        end
+      end
+    end
+  end
+end

data/lib/onebusaway_sdk/models/routes_for_location_list_params.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module OnebusawaySDK
+  module Models
+    # @see OnebusawaySDK::Resources::RoutesForLocation#list
+    class RoutesForLocationListParams < OnebusawaySDK::Internal::Type::BaseModel
+      extend OnebusawaySDK::Internal::Type::RequestParameters::Converter
+      include OnebusawaySDK::Internal::Type::RequestParameters
+
+      # @!attribute lat
+      #
+      #   @return [Float]
+      required :lat, Float
+
+      # @!attribute lon
+      #
+      #   @return [Float]
+      required :lon, Float
+
+      # @!attribute lat_span
+      #
+      #   @return [Float, nil]
+      optional :lat_span, Float
+
+      # @!attribute lon_span
+      #
+      #   @return [Float, nil]
+      optional :lon_span, Float
+
+      # @!attribute query
+      #
+      #   @return [String, nil]
+      optional :query, String
+
+      # @!attribute radius
+      #
+      #   @return [Float, nil]
+      optional :radius, Float
+
+      # @!method initialize(lat:, lon:, lat_span: nil, lon_span: nil, query: nil, radius: nil, request_options: {})
+      #   @param lat [Float]
+      #   @param lon [Float]
+      #   @param lat_span [Float]
+      #   @param lon_span [Float]
+      #   @param query [String]
+      #   @param radius [Float]
+      #   @param request_options [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/onebusaway_sdk/models/routes_for_location_list_response.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+module OnebusawaySDK
+  module Models
+    # @see OnebusawaySDK::Resources::RoutesForLocation#list
+    class RoutesForLocationListResponse < OnebusawaySDK::Models::ResponseWrapper
+      # @!attribute data
+      #
+      #   @return [OnebusawaySDK::Models::RoutesForLocationListResponse::Data]
+      required :data, -> { OnebusawaySDK::Models::RoutesForLocationListResponse::Data }
+
+      # @!method initialize(data:)
+      #   @param data [OnebusawaySDK::Models::RoutesForLocationListResponse::Data]
+
+      class Data < OnebusawaySDK::Internal::Type::BaseModel
+        # @!attribute limit_exceeded
+        #
+        #   @return [Boolean]
+        required :limit_exceeded, OnebusawaySDK::Internal::Type::Boolean, api_name: :limitExceeded
+
+        # @!attribute list
+        #
+        #   @return [Array<OnebusawaySDK::Models::RoutesForLocationListResponse::Data::List>]
+        required :list,
+                 -> { OnebusawaySDK::Internal::Type::ArrayOf[OnebusawaySDK::Models::RoutesForLocationListResponse::Data::List] }
+
+        # @!attribute out_of_range
+        #
+        #   @return [Boolean]
+        required :out_of_range, OnebusawaySDK::Internal::Type::Boolean, api_name: :outOfRange
+
+        # @!attribute references
+        #
+        #   @return [OnebusawaySDK::References]
+        required :references, -> { OnebusawaySDK::References }
+
+        # @!method initialize(limit_exceeded:, list:, out_of_range:, references:)
+        #   @param limit_exceeded [Boolean]
+        #   @param list [Array<OnebusawaySDK::Models::RoutesForLocationListResponse::Data::List>]
+        #   @param out_of_range [Boolean]
+        #   @param references [OnebusawaySDK::References]
+
+        class List < OnebusawaySDK::Internal::Type::BaseModel
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute agency_id
+          #
+          #   @return [String]
+          required :agency_id, String, api_name: :agencyId
+
+          # @!attribute type
+          #
+          #   @return [Integer]
+          required :type, Integer
+
+          # @!attribute color
+          #
+          #   @return [String, nil]
+          optional :color, String
+
+          # @!attribute description
+          #
+          #   @return [String, nil]
+          optional :description, String
+
+          # @!attribute long_name
+          #
+          #   @return [String, nil]
+          optional :long_name, String, api_name: :longName
+
+          # @!attribute null_safe_short_name
+          #
+          #   @return [String, nil]
+          optional :null_safe_short_name, String, api_name: :nullSafeShortName
+
+          # @!attribute short_name
+          #
+          #   @return [String, nil]
+          optional :short_name, String, api_name: :shortName
+
+          # @!attribute text_color
+          #
+          #   @return [String, nil]
+          optional :text_color, String, api_name: :textColor
+
+          # @!attribute url
+          #
+          #   @return [String, nil]
+          optional :url, String
+
+          # @!method initialize(id:, agency_id:, type:, color: nil, description: nil, long_name: nil, null_safe_short_name: nil, short_name: nil, text_color: nil, url: nil)
+          #   @param id [String]
+          #   @param agency_id [String]
+          #   @param type [Integer]
+          #   @param color [String]
+          #   @param description [String]
+          #   @param long_name [String]
+          #   @param null_safe_short_name [String]
+          #   @param short_name [String]
+          #   @param text_color [String]
+          #   @param url [String]
+        end
+      end
+    end
+  end
+end

data/lib/onebusaway_sdk/models/schedule_for_route_retrieve_params.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module OnebusawaySDK
+  module Models
+    # @see OnebusawaySDK::Resources::ScheduleForRoute#retrieve
+    class ScheduleForRouteRetrieveParams < OnebusawaySDK::Internal::Type::BaseModel
+      extend OnebusawaySDK::Internal::Type::RequestParameters::Converter
+      include OnebusawaySDK::Internal::Type::RequestParameters
+
+      # @!attribute date
+      #   The date for which you want to request a schedule in the format YYYY-MM-DD
+      #   (optional, defaults to current date)
+      #
+      #   @return [Date, nil]
+      optional :date, Date
+
+      # @!method initialize(date: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {OnebusawaySDK::Models::ScheduleForRouteRetrieveParams} for more details.
+      #
+      #   @param date [Date] The date for which you want to request a schedule in the format YYYY-MM-DD (opti
+      #
+      #   @param request_options [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end