Type

GitHub

Wraps custom type definitions.

Types can be objects (with shapes) or unions (with variants).

Example: Object type

api.types[:address].object? # => true
api.types[:address].shape[:city] # => Param for city field

Example: Union type

api.types[:payment_method].union? # => true
api.types[:payment_method].variants # => [Param, ...]
api.types[:payment_method].discriminator # => :type

Instance Methods

#deprecated?

#deprecated?

GitHub

Whether this type is deprecated.

Returns

Boolean

---

#description

#description

GitHub

The description for this type.

Returns

String, nil

---

#discriminator

#discriminator

GitHub

The discriminator for this type.

Returns

Symbol, nil

---

#example

#example

GitHub

The example for this type.

Returns

Object, nil

---

#extends

#extends

GitHub

The extends for this type.

Returns

Array<Symbol>

---

#extends?

#extends?

GitHub

Whether this type extends other types.

Returns

Boolean

---

#object?

#object?

GitHub

Whether this type is an object.

Returns

Boolean

---

#shape

#shape

GitHub

The shape for this type.

Returns

Hash{Symbol => Param}

---

#to_h

#to_h

GitHub

Converts this type to a hash.

Returns

Hash

---

#type

#type

GitHub

The type for this type.

Returns

Symbol, nil

---

#union?

#union?

GitHub

Whether this type is a union.

Returns

Boolean

---

#variants

#variants

GitHub

The variants for this type.

Returns

Array<Param>

---