Class: V1::PrinterResource

Inherits:
JSONAPI::Resource
  • Object
show all
Defined in:
app/resources/v1/printer_resource.rb

Overview

TODO:

This documentation does not yet include a detailed description of what this resource represents.

TODO:

This documentation does not yet include detailed descriptions for relationships, attributes and filters.

TODO:

This documentation does not yet include any example usage of the API via cURL or similar.

Note:

Access this resource via the /v1/printer_types endpoint.

Provides a JSON:API representation of Printer and exposes valid library type options for use by the UI.

For more information about JSON:API see the JSON:API Specifications or look at the JSONAPI::Resources package for the service implementation of the JSON:API standard.

Instance Attribute Summary collapse

Instance Attribute Details

#active? ⇒ Boolean

Returns the active status of the printer.

Returns:

  • (Boolean) —

    the active status of the printer



31
 
# File 'app/resources/v1/printer_resource.rb', line 31

attributes :name, :labware_type, :active?, :created_at, :updated_at, :deactivated_at

#created_at ⇒ String

Returns the timestamp when the printer was created.

Returns:

  • (String) —

    the timestamp when the printer was created



31
 
# File 'app/resources/v1/printer_resource.rb', line 31

attributes :name, :labware_type, :active?, :created_at, :updated_at, :deactivated_at

#deactivated_at ⇒ DateTime?

Returns the timestamp when printer was deactivated, or nil if it is active.

Returns:

  • (DateTime, nil) —

    the timestamp when printer was deactivated, or nil if it is active



31
 
# File 'app/resources/v1/printer_resource.rb', line 31

attributes :name, :labware_type, :active?, :created_at, :updated_at, :deactivated_at

#labware_type ⇒ String

Returns the type of labware the printer handles.

Returns:

  • (String) —

    the type of labware the printer handles



31
 
# File 'app/resources/v1/printer_resource.rb', line 31

attributes :name, :labware_type, :active?, :created_at, :updated_at, :deactivated_at

#name ⇒ String

Returns the name of the printer.

Returns:

  • (String) —

    the name of the printer



31
 
# File 'app/resources/v1/printer_resource.rb', line 31

attributes :name, :labware_type, :active?, :created_at, :updated_at, :deactivated_at

#updated_at ⇒ String

Returns the timestamp when the printer was last updated.

Returns:

  • (String) —

    the timestamp when the printer was last updated



31
 
# File 'app/resources/v1/printer_resource.rb', line 31

attributes :name, :labware_type, :active?, :created_at, :updated_at, :deactivated_at