Class: StickyIoRestfulApiV2025731::RelateTheCampaignInVolumeDiscountRequest

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/sticky_io_restful_api_v2025731/models/relate_the_campaign_in_volume_discount_request.rb

Overview

RelateTheCampaignInVolumeDiscountRequest Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(is_replace:, is_all_campaigns:, campaigns:, additional_properties: nil) ⇒ RelateTheCampaignInVolumeDiscountRequest

Returns a new instance of RelateTheCampaignInVolumeDiscountRequest.



43
44
45
46
47
48
49
50
51
52
 
# File 'lib/sticky_io_restful_api_v2025731/models/relate_the_campaign_in_volume_discount_request.rb', line 43

def initialize(is_replace:, is_all_campaigns:, campaigns:,
               additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @is_replace = is_replace
  @is_all_campaigns = is_all_campaigns
  @campaigns = campaigns
  @additional_properties = additional_properties
end

Instance Attribute Details

#campaigns ⇒ Array[CampaignRelateTheCampaignInVolumeDiscountRequest]

TODO: Write general description for this method

Returns:



22
23
24
 
# File 'lib/sticky_io_restful_api_v2025731/models/relate_the_campaign_in_volume_discount_request.rb', line 22

def campaigns
  @campaigns
end

#is_all_campaigns ⇒ TrueClass | FalseClass

TODO: Write general description for this method

Returns:

  • (TrueClass | FalseClass) 


18
19
20
 
# File 'lib/sticky_io_restful_api_v2025731/models/relate_the_campaign_in_volume_discount_request.rb', line 18

def is_all_campaigns
  @is_all_campaigns
end

#is_replace ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


14
15
16
 
# File 'lib/sticky_io_restful_api_v2025731/models/relate_the_campaign_in_volume_discount_request.rb', line 14

def is_replace
  @is_replace
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/sticky_io_restful_api_v2025731/models/relate_the_campaign_in_volume_discount_request.rb', line 55

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  is_replace = hash.key?('is_replace') ? hash['is_replace'] : nil
  is_all_campaigns =
    hash.key?('is_all_campaigns') ? hash['is_all_campaigns'] : nil
  # Parameter is an array, so we need to iterate through it
  campaigns = nil
  unless hash['campaigns'].nil?
    campaigns = []
    hash['campaigns'].each do |structure|
      campaigns << (CampaignRelateTheCampaignInVolumeDiscountRequest.from_hash(structure) if structure)
    end
  end

  campaigns = nil unless hash.key?('campaigns')

  # Create a new hash for additional properties, removing known properties.
  new_hash = hash.reject { |k, _| names.value?(k) }

  additional_properties = APIHelper.get_additional_properties(
    new_hash, proc { |value| value }
  )

  # Create object from extracted values.
  RelateTheCampaignInVolumeDiscountRequest.new(is_replace: is_replace,
                                               is_all_campaigns: is_all_campaigns,
                                               campaigns: campaigns,
                                               additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



25
26
27
28
29
30
31
 
# File 'lib/sticky_io_restful_api_v2025731/models/relate_the_campaign_in_volume_discount_request.rb', line 25

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['is_replace'] = 'is_replace'
  @_hash['is_all_campaigns'] = 'is_all_campaigns'
  @_hash['campaigns'] = 'campaigns'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



39
40
41
 
# File 'lib/sticky_io_restful_api_v2025731/models/relate_the_campaign_in_volume_discount_request.rb', line 39

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



34
35
36
 
# File 'lib/sticky_io_restful_api_v2025731/models/relate_the_campaign_in_volume_discount_request.rb', line 34

def self.optionals
  []
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



95
96
97
98
99
100
 
# File 'lib/sticky_io_restful_api_v2025731/models/relate_the_campaign_in_volume_discount_request.rb', line 95

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} is_replace: #{@is_replace.inspect}, is_all_campaigns:"\
  " #{@is_all_campaigns.inspect}, campaigns: #{@campaigns.inspect}, additional_properties:"\
  " #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



88
89
90
91
92
 
# File 'lib/sticky_io_restful_api_v2025731/models/relate_the_campaign_in_volume_discount_request.rb', line 88

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} is_replace: #{@is_replace}, is_all_campaigns: #{@is_all_campaigns},"\
  " campaigns: #{@campaigns}, additional_properties: #{@additional_properties}>"
end