class PlaceOS::Api::Webhook::ExecParams

Defined in:

placeos-rest-api/controllers/webhook.cr

Constructors

Class Method Summary

Instance Method Summary

Instance methods inherited from class PlaceOS::Api::Webhook::WebhookParams

after_initialize(trusted : Bool) after_initialize, apply_defaults apply_defaults, assign_attributes(id : String | Missing = Missing, secret : String | Missing = Missing)
assign_attributes(params : HTTP::Params | Hash(String, String) | Tuple(String, String))
assign_attributes
, assign_attributes_from_json(json, root : String)
assign_attributes_from_json(json)
assign_attributes_from_json
, assign_attributes_from_trusted_json(json, root : String)
assign_attributes_from_trusted_json(json)
assign_attributes_from_trusted_json
, assign_attributes_from_trusted_yaml(yaml) assign_attributes_from_trusted_yaml, assign_attributes_from_yaml(yaml) assign_attributes_from_yaml, attributes attributes, attributes_tuple attributes_tuple, changed? changed?, changed_attributes changed_attributes, changed_json(io : IO) : Nil
changed_json : String
changed_json
, changed_yaml(io : IO) : Nil
changed_yaml : String
changed_yaml
, clear_changes_information clear_changes_information, id : String id, id=(value : String) id=, id? : String | Nil id?, id_change : Tuple(String | Nil, String | Nil) | Nil id_change, id_changed? : Bool id_changed?, id_default : String id_default, id_present? : Bool id_present?, id_was : String | Nil id_was, id_will_change! : Nil id_will_change!, persistent_attributes persistent_attributes, restore_attributes restore_attributes, secret : String secret, secret=(value : String) secret=, secret? : String | Nil secret?, secret_change : Tuple(String | Nil, String | Nil) | Nil secret_change, secret_changed? : Bool secret_changed?, secret_default : String secret_default, secret_present? : Bool secret_present?, secret_was : String | Nil secret_was, secret_will_change! : Nil secret_will_change!, validate_nilability validate_nilability

Constructor methods inherited from class PlaceOS::Api::Webhook::WebhookParams

from_json(string_or_io : String | IO, trusted : Bool = false) : self
from_json(string_or_io : String | IO, root : String, trusted : Bool = false) : self
from_json
, from_trusted_json(string_or_io : String | IO, root : String) : self
from_trusted_json(string_or_io : String | IO) : self
from_trusted_json
, from_trusted_yaml(string_or_io : String | IO) : self from_trusted_yaml, from_yaml(string_or_io : String | IO, trusted : Bool = false) : self from_yaml, new(ctx : YAML::ParseContext, node : YAML::Nodes::Node)
new(pull : JSON::PullParser)
new(id : String | ActiveModel::Model::None = ::ActiveModel::Model::None.new, secret : String | ActiveModel::Model::None = ::ActiveModel::Model::None.new)
new(params : HTTP::Params | Hash(String, String) | Tuple(String, String))
new

Class methods inherited from class PlaceOS::Api::Webhook::WebhookParams

attributes : Array(Symbol) attributes

Instance methods inherited from class PlaceOS::Api::Params

apply_defaults apply_defaults, assign_attributes(params : HTTP::Params | Hash(String, String) | Tuple(String, String))
assign_attributes
assign_attributes
, attributes attributes, attributes_tuple attributes_tuple, persistent_attributes persistent_attributes, validate! validate!

Constructor methods inherited from class PlaceOS::Api::Params

new(ctx : YAML::ParseContext, node : YAML::Nodes::Node)
new(pull : JSON::PullParser)
new

Class methods inherited from class PlaceOS::Api::Params

attributes : Array(Symbol) attributes

Constructor Detail

def self.from_json(string_or_io : String | IO, trusted : Bool = false) : self #

def self.from_json(string_or_io : String | IO, root : String, trusted : Bool = false) : self #

Deserializes the given JSON in string_or_io into an instance of self, assuming the JSON consists of an JSON object with key root, and whose value is the value to deserialize. Will not deserialise from fields with mass_assign: false

class User < ActiveModel::Model
  attribute name : String
  attribute google_id : UUID, mass_assign: false
end

User.from_json(%({"main": {"name": "Jason", "google_id": "f6f70bfb-c882-446d-8758-7ce47db39620"}}), root: "main") # => #<User:0x103131b20 @name="Jason">

def self.from_trusted_json(string_or_io : String | IO, root : String) : self #

def self.from_trusted_json(string_or_io : String | IO) : self #

Serialize from a trusted JSON source


def self.from_trusted_yaml(string_or_io : String | IO) : self #

Serialize from a trusted YAML source


def self.from_yaml(string_or_io : String | IO, trusted : Bool = false) : self #

def self.new(ctx : YAML::ParseContext, node : YAML::Nodes::Node) #

[View source]
def self.new(pull : JSON::PullParser) #

[View source]
def self.new(mod : String | ActiveModel::Model::None = ::ActiveModel::Model::None.new, index : Int32 | ActiveModel::Model::None = ::ActiveModel::Model::None.new, method : String | ActiveModel::Model::None = ::ActiveModel::Model::None.new, id : String | ActiveModel::Model::None = ::ActiveModel::Model::None.new, secret : String | ActiveModel::Model::None = ::ActiveModel::Model::None.new) #

def self.new(params : HTTP::Params | Hash(String, String) | Tuple(String, String)) #

Initialize PlaceOS::Api::Webhook::ExecParams from HTTP::Params.


Class Method Detail

def self.attributes : Array(Symbol) #

Returns all attribute keys.


Instance Method Detail

def after_initialize(trusted : Bool) #

def apply_defaults #

Generate code to apply default values


def assign_attributes(mod : String | Missing = Missing, index : Int32 | Missing = Missing, method : String | Missing = Missing, id : String | Missing = Missing, secret : String | Missing = Missing) #

Assign to multiple attributes.


def assign_attributes(params : HTTP::Params | Hash(String, String) | Tuple(String, String)) #

Assign to mulitple attributes via HTTP::Params.


def assign_attributes_from_json(json, root : String) #

def assign_attributes_from_json(json) #

def assign_attributes_from_trusted_json(json, root : String) #

def assign_attributes_from_trusted_json(json) #

Assign each field from JSON if field exists in JSON and has changed in model


def assign_attributes_from_trusted_yaml(yaml) #

def assign_attributes_from_yaml(yaml) #

Uses the YAML parser as JSON is valid YAML


def attributes #

Returns a Hash of all attribute values


def attributes_tuple #

Returns a NamedTuple of all attribute values.


def changed? #

Check if any attributes have changed.


def changed_attributes #

Returns a Hash with all changed attributes.


def changed_json(io : IO) : Nil #

Serialize the set of changed attributes to JSON.


def changed_json : String #

Serialize the set of changed attributes to JSON.


def changed_yaml(io : IO) : Nil #

Serialize the set of changed attributes to YAML.


def changed_yaml : String #

Serialize the set of changed attributes to YAML.


def clear_changes_information #

Reset changes for all attributes.


def friendly #

[View source]
def id : String #

#id getter


def id=(value : String) #

#id setter


def index : Int32 #

#index getter


def index=(value : Int32) #

#index setter


def index? : Int32 | Nil #

def index_change : Tuple(Int32 | Nil, Int32 | Nil) | Nil #

Returns a Tuple of the previous and the current value of an instance variable if it has changed


def index_changed? : Bool #

def index_default : Int32 #

#index's default value


[View source]
def index_present? : Bool #

def index_was : Int32 | Nil #

def index_will_change! : Nil #

Include #index in the set of changed attributes, whether it has changed or not.


def method : String #

#method getter


def method=(value : String) #

#method setter


def method? : String | Nil #

def method_change : Tuple(String | Nil, String | Nil) | Nil #

Returns a Tuple of the previous and the current value of an instance variable if it has changed


def method_changed? : Bool #

def method_default : String #

#method's default value


[View source]
def method_present? : Bool #

def method_was : String | Nil #

def method_will_change! : Nil #

Include #method in the set of changed attributes, whether it has changed or not.


def mod : String #

#mod getter


def mod=(value : String) #

Setters #mod setter


def mod? : String | Nil #

def mod_change : Tuple(String | Nil, String | Nil) | Nil #

Returns a Tuple of the previous and the current value of an instance variable if it has changed


def mod_changed? : Bool #

def mod_default : String #

#mod's default value


[View source]
def mod_present? : Bool #

def mod_was : String | Nil #

def mod_will_change! : Nil #

Include #mod in the set of changed attributes, whether it has changed or not.


def persistent_attributes #

Returns a Hash of all attributes that can be persisted.


def restore_attributes #

Reset each attribute to their previous values and clears all changes.


def secret : String #

#secret getter


def secret=(value : String) #

#secret setter


def validate_nilability #

Validate that all non-nillable fields have values.