Class: Courier::Send::AudienceFilter

Inherits:
Object
  • Object
show all
Defined in:
lib/trycourier/send/types/audience_filter.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(operator:, path:, value:, additional_properties: nil) ⇒ Send::AudienceFilter

Parameters:

  • operator (String) —

    Send to users only if they are member of the account

  • path (String)
  • value (String)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



15
16
17
18
19
20
21
22
23
24
 
# File 'lib/trycourier/send/types/audience_filter.rb', line 15

def initialize(operator:, path:, value:, additional_properties: nil)
  # @type [String] Send to users only if they are member of the account
  @operator = operator
  # @type [String]
  @path = path
  # @type [String]
  @value = value
  # @type [OpenStruct] Additional properties unmapped to the current class definition
  @additional_properties = additional_properties
end

Instance Attribute Details

#additional_properties ⇒ Object (readonly)

Returns the value of attribute additional_properties.



8
9
10
 
# File 'lib/trycourier/send/types/audience_filter.rb', line 8

def additional_properties
  @additional_properties
end

#operator ⇒ Object (readonly)

Returns the value of attribute operator.



8
9
10
 
# File 'lib/trycourier/send/types/audience_filter.rb', line 8

def operator
  @operator
end

#path ⇒ Object (readonly)

Returns the value of attribute path.



8
9
10
 
# File 'lib/trycourier/send/types/audience_filter.rb', line 8

def path
  @path
end

#value ⇒ Object (readonly)

Returns the value of attribute value.



8
9
10
 
# File 'lib/trycourier/send/types/audience_filter.rb', line 8

def value
  @value
end

Class Method Details

.from_json(json_object:) ⇒ Send::AudienceFilter

Deserialize a JSON object to an instance of AudienceFilter

Parameters:

  • json_object (JSON)

Returns:



30
31
32
33
34
35
36
37
 
# File 'lib/trycourier/send/types/audience_filter.rb', line 30

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  JSON.parse(json_object)
  operator = struct.operator
  path = struct.path
  value = struct.value
  new(operator: operator, path: path, value: value, additional_properties: struct)
end

.validate_raw(obj:) ⇒ Void

Leveraged for Union-type generation, validate_raw attempts to parse the given hash and check each fields type against the current object’s property definitions.

Parameters:

  • obj (Object)

Returns:

  • (Void) 


50
51
52
53
54
 
# File 'lib/trycourier/send/types/audience_filter.rb', line 50

def self.validate_raw(obj:)
  obj.operator.is_a?(String) != false || raise("Passed value for field obj.operator is not the expected type, validation failed.")
  obj.path.is_a?(String) != false || raise("Passed value for field obj.path is not the expected type, validation failed.")
  obj.value.is_a?(String) != false || raise("Passed value for field obj.value is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ JSON

Serialize an instance of AudienceFilter to a JSON object

Returns:

  • (JSON) 


42
43
44
 
# File 'lib/trycourier/send/types/audience_filter.rb', line 42

def to_json(*_args)
  { "operator": @operator, "path": @path, "value": @value }.to_json
end