Resource

GitHub

Wraps resource definitions.

Example

resource = api.resources[:invoices]

resource.identifier # => "invoices"
resource.path # => "invoices"
resource.parent_identifiers # => []
resource.resources # => {} or nested resources

resource.actions.each_value do |action|
  action.request # => Action::Request
  action.response # => Action::Response
end

Instance Methods

#actions

#actions

GitHub

The actions for this resource.

Returns

Hash{Symbol => Introspection::Action}

See also

• Introspection::Action

---

#identifier

#identifier

GitHub

The identifier for this resource.

Returns

String

---

#parent_identifiers

#parent_identifiers

GitHub

The parent identifiers for this resource.

Returns

Array<String>

---

#path

#path

GitHub

The path for this resource.

Returns

String

---

#resources

#resources

GitHub

The nested resources for this resource.

Returns

Hash{Symbol => Resource}

---

#to_h

#to_h

GitHub

Converts this resource to a hash.

Returns

Hash

---