Shape

GitHub

Base class for wrapper shapes.

Subclass to define response type structure for record or collection wrappers. The block is evaluated via instance_exec, providing access to type DSL methods and helpers like root_key and #metadata_type_names.

Example: Custom shape class

class MyShape < Wrapper::Shape
  def apply
    reference(:invoice)
    object?(:meta)
    metadata_type_names.each { |type_name| merge(type_name) }
  end
end

Example: Inline shape block

shape do
  reference(root_key.singular.to_sym)
  object?(:meta)
  metadata_type_names.each { |type_name| merge(type_name) }
end

Instance Methods

#array

#array(name, **options, &block)

GitHub

See also

• API::Object#array

---

#array?

#array?(name, **options, &block)

GitHub

See also

• API::Object#array?

---

#binary

#binary(name, **options)

GitHub

See also

• API::Object#binary

---

#binary?

#binary?(name, **options)

GitHub

See also

• API::Object#binary?

---

#boolean

#boolean(name, **options)

GitHub

See also

• API::Object#boolean

---

#boolean?

#boolean?(name, **options)

GitHub

See also

• API::Object#boolean?

---

#data_type

#data_type

GitHub

The data type for this shape.

Returns

Symbol, nil

---

#date

#date(name, **options)

GitHub

See also

• API::Object#date

---

#date?

#date?(name, **options)

GitHub

See also

• API::Object#date?

---

#datetime

#datetime(name, **options)

GitHub

See also

• API::Object#datetime

---

#datetime?

#datetime?(name, **options)

GitHub

See also

• API::Object#datetime?

---

#decimal

#decimal(name, **options)

GitHub

See also

• API::Object#decimal

---

#decimal?

#decimal?(name, **options)

GitHub

See also

• API::Object#decimal?

---

#extends

#extends(type)

GitHub

See also

• API::Object#extends

---

#integer

#integer(name, **options)

GitHub

See also

• API::Object#integer

---

#integer?

#integer?(name, **options)

GitHub

See also

• API::Object#integer?

---

#literal

#literal(name, value:, **options)

GitHub

See also

• API::Object#literal

---

#merge

#merge(other)

GitHub

See also

• API::Object#merge

---

#metadata_type_names

#metadata_type_names

GitHub

The metadata type names for this shape.

Auto-generated type names from capability Adapter::Capability::Operation::Base.metadata_shape definitions. Use with #merge to include capability metadata fields in the shape.

Returns

Array<Symbol>

---

#number

#number(name, **options)

GitHub

See also

• API::Object#number

---

#number?

#number?(name, **options)

GitHub

See also

• API::Object#number?

---

#object

#object(name, **options, &block)

GitHub

See also

• API::Object#object

---

#object?

#object?(name, **options, &block)

GitHub

See also

• API::Object#object?

---

#reference

#reference(name, **options)

GitHub

See also

• API::Object#reference

---

#reference?

#reference?(name, **options)

GitHub

See also

• API::Object#reference?

---

#string

#string(name, **options)

GitHub

See also

• API::Object#string

---

#string?

#string?(name, **options)

GitHub

See also

• API::Object#string?

---

#time

#time(name, **options)

GitHub

See also

• API::Object#time

---

#time?

#time?(name, **options)

GitHub

See also

• API::Object#time?

---

#union

#union(name, **options, &block)

GitHub

See also

• API::Object#union

---

#union?

#union?(name, **options, &block)

GitHub

See also

• API::Object#union?

---

#uuid

#uuid(name, **options)

GitHub

See also

• API::Object#uuid

---

#uuid?

#uuid?(name, **options)

GitHub

See also

• API::Object#uuid?

---