Class: Merge::Crm::ItemSchema

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_ruby_client/crm/types/item_schema.rb

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(item_type: OMIT, item_format: OMIT, item_choices: OMIT, additional_properties: nil) ⇒ Merge::Crm::ItemSchema

Parameters:

  • item_type (Merge::Crm::ItemTypeEnum) (defaults to: OMIT)
  • item_format (Merge::Crm::ItemFormatEnum) (defaults to: OMIT)
  • item_choices (Array<String>) (defaults to: OMIT)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/merge_ruby_client/crm/types/item_schema.rb', line 30

def initialize(item_type: OMIT, item_format: OMIT, item_choices: OMIT, additional_properties: nil)
  @item_type = item_type if item_type != OMIT
  @item_format = item_format if item_format != OMIT
  @item_choices = item_choices if item_choices != OMIT
  @additional_properties = additional_properties
  @_field_set = {
    "item_type": item_type,
    "item_format": item_format,
    "item_choices": item_choices
  }.reject do |_k, v|
    v == OMIT
  end
end

Instance Attribute Details

#additional_properties ⇒ OpenStruct (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

  • (OpenStruct) —

    Additional properties unmapped to the current class definition



18
19
20
 
# File 'lib/merge_ruby_client/crm/types/item_schema.rb', line 18

def additional_properties
  @additional_properties
end

#item_choices ⇒ Array<String> (readonly)

Returns:

  • (Array<String>) 


16
17
18
 
# File 'lib/merge_ruby_client/crm/types/item_schema.rb', line 16

def item_choices
  @item_choices
end

#item_format ⇒ Merge::Crm::ItemFormatEnum (readonly)

Returns:



14
15
16
 
# File 'lib/merge_ruby_client/crm/types/item_schema.rb', line 14

def item_format
  @item_format
end

#item_type ⇒ Merge::Crm::ItemTypeEnum (readonly)

Returns:



12
13
14
 
# File 'lib/merge_ruby_client/crm/types/item_schema.rb', line 12

def item_type
  @item_type
end

Class Method Details

.from_json(json_object:) ⇒ Merge::Crm::ItemSchema

Deserialize a JSON object to an instance of ItemSchema

Parameters:

  • json_object (String)

Returns:



48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/merge_ruby_client/crm/types/item_schema.rb', line 48

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  item_type = parsed_json["item_type"]
  item_format = parsed_json["item_format"]
  item_choices = parsed_json["item_choices"]
  new(
    item_type: item_type,
    item_format: item_format,
    item_choices: item_choices,
    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) 


75
76
77
78
79
 
# File 'lib/merge_ruby_client/crm/types/item_schema.rb', line 75

def self.validate_raw(obj:)
  obj.item_type&.is_a?(Merge::Crm::ItemTypeEnum) != false || raise("Passed value for field obj.item_type is not the expected type, validation failed.")
  obj.item_format&.is_a?(Merge::Crm::ItemFormatEnum) != false || raise("Passed value for field obj.item_format is not the expected type, validation failed.")
  obj.item_choices&.is_a?(Array) != false || raise("Passed value for field obj.item_choices is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of ItemSchema to a JSON object

Returns:

  • (String) 


65
66
67
 
# File 'lib/merge_ruby_client/crm/types/item_schema.rb', line 65

def to_json(*_args)
  @_field_set&.to_json
end