Class: OnebusawaySDK::Resources::Shape

Inherits:

Object

• Object
• OnebusawaySDK::Resources::Shape

Defined in:

lib/onebusaway_sdk/resources/shape.rb

Instance Method Summary

• #initialize(client:) ⇒ Shape constructor private

  A new instance of Shape.

• #retrieve(shape_id, request_options: {}) ⇒ OnebusawaySDK::Models::ShapeRetrieveResponse

  Retrieve a shape (the path traveled by a transit vehicle) by ID.

Constructor Details

#initialize(client:) ⇒ Shape

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Shape.

Parameters:

• client (OnebusawaySDK::Client)

# File 'lib/onebusaway_sdk/resources/shape.rb', line 29

def initialize(client:)
  @client = client
end

Instance Method Details

#retrieve(shape_id, request_options: {}) ⇒ OnebusawaySDK::Models::ShapeRetrieveResponse

Retrieve a shape (the path traveled by a transit vehicle) by ID.

Parameters:

• shape_id (String) —

  The shape ID, encoded directly in the URL

• request_options (OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (OnebusawaySDK::Models::ShapeRetrieveResponse)

See Also:

• Models::ShapeRetrieveParams

# File 'lib/onebusaway_sdk/resources/shape.rb', line 17

def retrieve(shape_id, params = {})
  @client.request(
    method: :get,
    path: ["api/where/shape/%1$s.json", shape_id],
    model: OnebusawaySDK::Models::ShapeRetrieveResponse,
    options: params[:request_options]
  )
end