onebusaway-sdk 0.1.0.pre.alpha.203

data/lib/onebusaway-sdk/models/report_problem_with_stop_retrieve_params.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+module OnebusawaySDK
+  module Models
+    class ReportProblemWithStopRetrieveParams < OnebusawaySDK::BaseModel
+      # @!parse
+      #   extend OnebusawaySDK::RequestParameters::Converter
+      include OnebusawaySDK::RequestParameters
+
+      # @!attribute [r] code
+      #   A string code identifying the nature of the problem
+      #
+      #   @return [Symbol, OnebusawaySDK::Models::ReportProblemWithStopRetrieveParams::Code, nil]
+      optional :code, enum: -> { OnebusawaySDK::Models::ReportProblemWithStopRetrieveParams::Code }
+
+      # @!parse
+      #   # @return [Symbol, OnebusawaySDK::Models::ReportProblemWithStopRetrieveParams::Code]
+      #   attr_writer :code
+
+      # @!attribute [r] user_comment
+      #   Additional comment text supplied by the user describing the problem
+      #
+      #   @return [String, nil]
+      optional :user_comment, String, api_name: :userComment
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :user_comment
+
+      # @!attribute [r] user_lat
+      #   The reporting user’s current latitude
+      #
+      #   @return [Float, nil]
+      optional :user_lat, Float, api_name: :userLat
+
+      # @!parse
+      #   # @return [Float]
+      #   attr_writer :user_lat
+
+      # @!attribute [r] user_location_accuracy
+      #   The reporting user’s location accuracy, in meters
+      #
+      #   @return [Float, nil]
+      optional :user_location_accuracy, Float, api_name: :userLocationAccuracy
+
+      # @!parse
+      #   # @return [Float]
+      #   attr_writer :user_location_accuracy
+
+      # @!attribute [r] user_lon
+      #   The reporting user’s current longitude
+      #
+      #   @return [Float, nil]
+      optional :user_lon, Float, api_name: :userLon
+
+      # @!parse
+      #   # @return [Float]
+      #   attr_writer :user_lon
+
+      # @!parse
+      #   # @param code [Symbol, OnebusawaySDK::Models::ReportProblemWithStopRetrieveParams::Code]
+      #   # @param user_comment [String]
+      #   # @param user_lat [Float]
+      #   # @param user_location_accuracy [Float]
+      #   # @param user_lon [Float]
+      #   # @param request_options [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(
+      #     code: nil,
+      #     user_comment: nil,
+      #     user_lat: nil,
+      #     user_location_accuracy: nil,
+      #     user_lon: nil,
+      #     request_options: {},
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | OnebusawaySDK::BaseModel) -> void
+
+      # @abstract
+      #
+      # A string code identifying the nature of the problem
+      #
+      # @example
+      # ```ruby
+      # case code
+      # in :stop_name_wrong
+      #   # ...
+      # in :stop_number_wrong
+      #   # ...
+      # in :stop_location_wrong
+      #   # ...
+      # in :route_or_trip_missing
+      #   # ...
+      # in :other
+      #   # ...
+      # end
+      # ```
+      class Code < OnebusawaySDK::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
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   #
+        #   def self.values; end
+      end
+    end
+  end
+end

data/lib/onebusaway-sdk/models/report_problem_with_trip_retrieve_params.rb

@@ -0,0 +1,180 @@
+# frozen_string_literal: true
+
+module OnebusawaySDK
+  module Models
+    class ReportProblemWithTripRetrieveParams < OnebusawaySDK::BaseModel
+      # @!parse
+      #   extend OnebusawaySDK::RequestParameters::Converter
+      include OnebusawaySDK::RequestParameters
+
+      # @!attribute [r] code
+      #   A string code identifying the nature of the problem
+      #
+      #   @return [Symbol, OnebusawaySDK::Models::ReportProblemWithTripRetrieveParams::Code, nil]
+      optional :code, enum: -> { OnebusawaySDK::Models::ReportProblemWithTripRetrieveParams::Code }
+
+      # @!parse
+      #   # @return [Symbol, OnebusawaySDK::Models::ReportProblemWithTripRetrieveParams::Code]
+      #   attr_writer :code
+
+      # @!attribute [r] service_date
+      #   The service date of the trip
+      #
+      #   @return [Integer, nil]
+      optional :service_date, Integer, api_name: :serviceDate
+
+      # @!parse
+      #   # @return [Integer]
+      #   attr_writer :service_date
+
+      # @!attribute [r] stop_id
+      #   A stop ID indicating where the user is experiencing the problem
+      #
+      #   @return [String, nil]
+      optional :stop_id, String, api_name: :stopID
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :stop_id
+
+      # @!attribute [r] user_comment
+      #   Additional comment text supplied by the user describing the problem
+      #
+      #   @return [String, nil]
+      optional :user_comment, String, api_name: :userComment
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :user_comment
+
+      # @!attribute [r] user_lat
+      #   The reporting user’s current latitude
+      #
+      #   @return [Float, nil]
+      optional :user_lat, Float, api_name: :userLat
+
+      # @!parse
+      #   # @return [Float]
+      #   attr_writer :user_lat
+
+      # @!attribute [r] user_location_accuracy
+      #   The reporting user’s location accuracy, in meters
+      #
+      #   @return [Float, nil]
+      optional :user_location_accuracy, Float, api_name: :userLocationAccuracy
+
+      # @!parse
+      #   # @return [Float]
+      #   attr_writer :user_location_accuracy
+
+      # @!attribute [r] user_lon
+      #   The reporting user’s current longitude
+      #
+      #   @return [Float, nil]
+      optional :user_lon, Float, api_name: :userLon
+
+      # @!parse
+      #   # @return [Float]
+      #   attr_writer :user_lon
+
+      # @!attribute [r] user_on_vehicle
+      #   Indicator if the user is on the transit vehicle experiencing the problem
+      #
+      #   @return [Boolean, nil]
+      optional :user_on_vehicle, OnebusawaySDK::BooleanModel, api_name: :userOnVehicle
+
+      # @!parse
+      #   # @return [Boolean]
+      #   attr_writer :user_on_vehicle
+
+      # @!attribute [r] user_vehicle_number
+      #   The vehicle number, as reported by the user
+      #
+      #   @return [String, nil]
+      optional :user_vehicle_number, String, api_name: :userVehicleNumber
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :user_vehicle_number
+
+      # @!attribute [r] vehicle_id
+      #   The vehicle actively serving the trip
+      #
+      #   @return [String, nil]
+      optional :vehicle_id, String, api_name: :vehicleID
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :vehicle_id
+
+      # @!parse
+      #   # @param code [Symbol, OnebusawaySDK::Models::ReportProblemWithTripRetrieveParams::Code]
+      #   # @param service_date [Integer]
+      #   # @param stop_id [String]
+      #   # @param user_comment [String]
+      #   # @param user_lat [Float]
+      #   # @param user_location_accuracy [Float]
+      #   # @param user_lon [Float]
+      #   # @param user_on_vehicle [Boolean]
+      #   # @param user_vehicle_number [String]
+      #   # @param vehicle_id [String]
+      #   # @param request_options [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def 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: {},
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | OnebusawaySDK::BaseModel) -> void
+
+      # @abstract
+      #
+      # A string code identifying the nature of the problem
+      #
+      # @example
+      # ```ruby
+      # case code
+      # in :vehicle_never_came
+      #   # ...
+      # in :vehicle_came_early
+      #   # ...
+      # in :vehicle_came_late
+      #   # ...
+      # in :wrong_headsign
+      #   # ...
+      # in :vehicle_does_not_stop_here
+      #   # ...
+      # in ...
+      #   #...
+      # end
+      # ```
+      class Code < OnebusawaySDK::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
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   #
+        #   def self.values; end
+      end
+    end
+  end
+end

data/lib/onebusaway-sdk/models/response_wrapper.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module OnebusawaySDK
+  module Models
+    class ResponseWrapper < OnebusawaySDK::BaseModel
+      # @!attribute code
+      #
+      #   @return [Integer]
+      required :code, Integer
+
+      # @!attribute current_time
+      #
+      #   @return [Integer]
+      required :current_time, Integer, api_name: :currentTime
+
+      # @!attribute text
+      #
+      #   @return [String]
+      required :text, String
+
+      # @!attribute version
+      #
+      #   @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
+    end
+  end
+end

data/lib/onebusaway-sdk/models/route_ids_for_agency_list_params.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module OnebusawaySDK
+  module Models
+    class RouteIDsForAgencyListParams < OnebusawaySDK::BaseModel
+      # @!parse
+      #   extend OnebusawaySDK::RequestParameters::Converter
+      include OnebusawaySDK::RequestParameters
+
+      # @!parse
+      #   # @param request_options [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(request_options: {}, **) = super
+
+      # def initialize: (Hash | OnebusawaySDK::BaseModel) -> void
+    end
+  end
+end

data/lib/onebusaway-sdk/models/route_ids_for_agency_list_response.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module OnebusawaySDK
+  module Models
+    class RouteIDsForAgencyListResponse < OnebusawaySDK::Models::ResponseWrapper
+      # @!attribute data
+      #
+      #   @return [OnebusawaySDK::Models::RouteIDsForAgencyListResponse::Data]
+      required :data, -> { OnebusawaySDK::Models::RouteIDsForAgencyListResponse::Data }
+
+      # @!parse
+      #   # @param data [OnebusawaySDK::Models::RouteIDsForAgencyListResponse::Data]
+      #   #
+      #   def initialize(data:, **) = super
+
+      # def initialize: (Hash | OnebusawaySDK::BaseModel) -> void
+
+      class Data < OnebusawaySDK::BaseModel
+        # @!attribute limit_exceeded
+        #
+        #   @return [Boolean]
+        required :limit_exceeded, OnebusawaySDK::BooleanModel, api_name: :limitExceeded
+
+        # @!attribute list
+        #
+        #   @return [Array<String>]
+        required :list, OnebusawaySDK::ArrayOf[String]
+
+        # @!attribute references
+        #
+        #   @return [OnebusawaySDK::Models::References]
+        required :references, -> { OnebusawaySDK::Models::References }
+
+        # @!parse
+        #   # @param limit_exceeded [Boolean]
+        #   # @param list [Array<String>]
+        #   # @param references [OnebusawaySDK::Models::References]
+        #   #
+        #   def initialize(limit_exceeded:, list:, references:, **) = super
+
+        # def initialize: (Hash | OnebusawaySDK::BaseModel) -> void
+      end
+    end
+  end
+end

data/lib/onebusaway-sdk/models/route_retrieve_params.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module OnebusawaySDK
+  module Models
+    class RouteRetrieveParams < OnebusawaySDK::BaseModel
+      # @!parse
+      #   extend OnebusawaySDK::RequestParameters::Converter
+      include OnebusawaySDK::RequestParameters
+
+      # @!parse
+      #   # @param request_options [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(request_options: {}, **) = super
+
+      # def initialize: (Hash | OnebusawaySDK::BaseModel) -> void
+    end
+  end
+end

data/lib/onebusaway-sdk/models/route_retrieve_response.rb

@@ -0,0 +1,149 @@
+# frozen_string_literal: true
+
+module OnebusawaySDK
+  module Models
+    class RouteRetrieveResponse < OnebusawaySDK::Models::ResponseWrapper
+      # @!attribute data
+      #
+      #   @return [OnebusawaySDK::Models::RouteRetrieveResponse::Data]
+      required :data, -> { OnebusawaySDK::Models::RouteRetrieveResponse::Data }
+
+      # @!parse
+      #   # @param data [OnebusawaySDK::Models::RouteRetrieveResponse::Data]
+      #   #
+      #   def initialize(data:, **) = super
+
+      # def initialize: (Hash | OnebusawaySDK::BaseModel) -> void
+
+      class Data < OnebusawaySDK::BaseModel
+        # @!attribute entry
+        #
+        #   @return [OnebusawaySDK::Models::RouteRetrieveResponse::Data::Entry]
+        required :entry, -> { OnebusawaySDK::Models::RouteRetrieveResponse::Data::Entry }
+
+        # @!attribute references
+        #
+        #   @return [OnebusawaySDK::Models::References]
+        required :references, -> { OnebusawaySDK::Models::References }
+
+        # @!parse
+        #   # @param entry [OnebusawaySDK::Models::RouteRetrieveResponse::Data::Entry]
+        #   # @param references [OnebusawaySDK::Models::References]
+        #   #
+        #   def initialize(entry:, references:, **) = super
+
+        # def initialize: (Hash | OnebusawaySDK::BaseModel) -> void
+
+        class Entry < OnebusawaySDK::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 [r] color
+          #
+          #   @return [String, nil]
+          optional :color, String
+
+          # @!parse
+          #   # @return [String]
+          #   attr_writer :color
+
+          # @!attribute [r] description
+          #
+          #   @return [String, nil]
+          optional :description, String
+
+          # @!parse
+          #   # @return [String]
+          #   attr_writer :description
+
+          # @!attribute [r] long_name
+          #
+          #   @return [String, nil]
+          optional :long_name, String, api_name: :longName
+
+          # @!parse
+          #   # @return [String]
+          #   attr_writer :long_name
+
+          # @!attribute [r] null_safe_short_name
+          #
+          #   @return [String, nil]
+          optional :null_safe_short_name, String, api_name: :nullSafeShortName
+
+          # @!parse
+          #   # @return [String]
+          #   attr_writer :null_safe_short_name
+
+          # @!attribute [r] short_name
+          #
+          #   @return [String, nil]
+          optional :short_name, String, api_name: :shortName
+
+          # @!parse
+          #   # @return [String]
+          #   attr_writer :short_name
+
+          # @!attribute [r] text_color
+          #
+          #   @return [String, nil]
+          optional :text_color, String, api_name: :textColor
+
+          # @!parse
+          #   # @return [String]
+          #   attr_writer :text_color
+
+          # @!attribute [r] url
+          #
+          #   @return [String, nil]
+          optional :url, String
+
+          # @!parse
+          #   # @return [String]
+          #   attr_writer :url
+
+          # @!parse
+          #   # @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]
+          #   #
+          #   def 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,
+          #     **
+          #   )
+          #     super
+          #   end
+
+          # def initialize: (Hash | OnebusawaySDK::BaseModel) -> void
+        end
+      end
+    end
+  end
+end

data/lib/onebusaway-sdk/models/routes_for_agency_list_params.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module OnebusawaySDK
+  module Models
+    class RoutesForAgencyListParams < OnebusawaySDK::BaseModel
+      # @!parse
+      #   extend OnebusawaySDK::RequestParameters::Converter
+      include OnebusawaySDK::RequestParameters
+
+      # @!parse
+      #   # @param request_options [OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(request_options: {}, **) = super
+
+      # def initialize: (Hash | OnebusawaySDK::BaseModel) -> void
+    end
+  end
+end