Class: SibApiV3Sdk::RequestContactExportCustomContactFilter

Inherits:
Object
  • Object
show all
Defined in:
lib/sib-api-v3-sdk/models/request_contact_export_custom_contact_filter.rb

Overview

Only one of the two filter options (contactFilter or customContactFilter) can be passed in the request. Set the filter for the contacts to be exported.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RequestContactExportCustomContactFilter

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/sib-api-v3-sdk/models/request_contact_export_custom_contact_filter.rb', line 84

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'actionForContacts')
    self.action_for_contacts = attributes[:'actionForContacts']
  end

  if attributes.has_key?(:'actionForEmailCampaigns')
    self.action_for_email_campaigns = attributes[:'actionForEmailCampaigns']
  end

  if attributes.has_key?(:'actionForSmsCampaigns')
    self.action_for_sms_campaigns = attributes[:'actionForSmsCampaigns']
  end

  if attributes.has_key?(:'listId')
    self.list_id = attributes[:'listId']
  end

  if attributes.has_key?(:'emailCampaignId')
    self.email_campaign_id = attributes[:'emailCampaignId']
  end

  if attributes.has_key?(:'smsCampaignId')
    self.sms_campaign_id = attributes[:'smsCampaignId']
  end
end

Instance Attribute Details

#action_for_contacts ⇒ Object

Mandatory if neither actionForEmailCampaigns nor actionForSmsCampaigns is passed. This will export the contacts on the basis of provided action applied on contacts as per the list id. * allContacts - Fetch the list of all contacts for a particular list. * subscribed & unsubscribed - Fetch the list of subscribed / unsubscribed (blacklisted via any means) contacts for a particular list. * unsubscribedPerList - Fetch the list of contacts that are unsubscribed from a particular list only.



19
20
21
 
# File 'lib/sib-api-v3-sdk/models/request_contact_export_custom_contact_filter.rb', line 19

def action_for_contacts
  @action_for_contacts
end

#action_for_email_campaigns ⇒ Object

Mandatory if neither actionForContacts nor actionForSmsCampaigns is passed. This will export the contacts on the basis of provided action applied on email campaigns. * openers & nonOpeners - emailCampaignId is mandatory. Fetch the list of readers / non-readers for a particular email campaign. * clickers & nonClickers - emailCampaignId is mandatory. Fetch the list of clickers / non-clickers for a particular email campaign. * unsubscribed - emailCampaignId is mandatory. Fetch the list of all unsubscribed (blacklisted via any means) contacts for a particular email campaign. * hardBounces & softBounces - emailCampaignId is optional. Fetch the list of hard bounces / soft bounces for a particular / all email campaign(s).



22
23
24
 
# File 'lib/sib-api-v3-sdk/models/request_contact_export_custom_contact_filter.rb', line 22

def action_for_email_campaigns
  @action_for_email_campaigns
end

#action_for_sms_campaigns ⇒ Object

Mandatory if neither actionForContacts nor actionForEmailCampaigns is passed. This will export the contacts on the basis of provided action applied on sms campaigns. * unsubscribed - Fetch the list of all unsubscribed (blacklisted via any means) contacts for all / particular sms campaigns. * hardBounces & softBounces - Fetch the list of hard bounces / soft bounces for all / particular sms campaigns.



25
26
27
 
# File 'lib/sib-api-v3-sdk/models/request_contact_export_custom_contact_filter.rb', line 25

def action_for_sms_campaigns
  @action_for_sms_campaigns
end

#email_campaign_id ⇒ Object

Considered only if actionForEmailCampaigns is passed, ignored otherwise. Mandatory if action is one of the following - openers, nonOpeners, clickers, nonClickers, unsubscribed. The id of the email campaign for which the corresponding action shall be applied in the filter.



31
32
33
 
# File 'lib/sib-api-v3-sdk/models/request_contact_export_custom_contact_filter.rb', line 31

def email_campaign_id
  @email_campaign_id
end

#list_id ⇒ Object

Mandatory if actionForContacts is passed, ignored otherwise. Id of the list for which the corresponding action shall be applied in the filter.



28
29
30
 
# File 'lib/sib-api-v3-sdk/models/request_contact_export_custom_contact_filter.rb', line 28

def list_id
  @list_id
end

#sms_campaign_id ⇒ Object

Considered only if actionForSmsCampaigns is passed, ignored otherwise. The id of sms campaign for which the corresponding action shall be applied in the filter.



34
35
36
 
# File 'lib/sib-api-v3-sdk/models/request_contact_export_custom_contact_filter.rb', line 34

def sms_campaign_id
  @sms_campaign_id
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



59
60
61
62
63
64
65
66
67
68
 
# File 'lib/sib-api-v3-sdk/models/request_contact_export_custom_contact_filter.rb', line 59

def self.attribute_map
  {
    :'action_for_contacts' => :'actionForContacts',
    :'action_for_email_campaigns' => :'actionForEmailCampaigns',
    :'action_for_sms_campaigns' => :'actionForSmsCampaigns',
    :'list_id' => :'listId',
    :'email_campaign_id' => :'emailCampaignId',
    :'sms_campaign_id' => :'smsCampaignId'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



71
72
73
74
75
76
77
78
79
80
 
# File 'lib/sib-api-v3-sdk/models/request_contact_export_custom_contact_filter.rb', line 71

def self.swagger_types
  {
    :'action_for_contacts' => :'String',
    :'action_for_email_campaigns' => :'String',
    :'action_for_sms_campaigns' => :'String',
    :'list_id' => :'Integer',
    :'email_campaign_id' => :'Integer',
    :'sms_campaign_id' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



166
167
168
169
170
171
172
173
174
175
 
# File 'lib/sib-api-v3-sdk/models/request_contact_export_custom_contact_filter.rb', line 166

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      action_for_contacts == o.action_for_contacts &&
      action_for_email_campaigns == o.action_for_email_campaigns &&
      action_for_sms_campaigns == o.action_for_sms_campaigns &&
      list_id == o.list_id &&
      email_campaign_id == o.email_campaign_id &&
      sms_campaign_id == o.sms_campaign_id
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/sib-api-v3-sdk/models/request_contact_export_custom_contact_filter.rb', line 213

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = SibApiV3Sdk.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/sib-api-v3-sdk/models/request_contact_export_custom_contact_filter.rb', line 279

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/sib-api-v3-sdk/models/request_contact_export_custom_contact_filter.rb', line 192

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


179
180
181
 
# File 'lib/sib-api-v3-sdk/models/request_contact_export_custom_contact_filter.rb', line 179

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



185
186
187
 
# File 'lib/sib-api-v3-sdk/models/request_contact_export_custom_contact_filter.rb', line 185

def hash
  [action_for_contacts, action_for_email_campaigns, action_for_sms_campaigns, list_id, email_campaign_id, sms_campaign_id].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



117
118
119
120
 
# File 'lib/sib-api-v3-sdk/models/request_contact_export_custom_contact_filter.rb', line 117

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



259
260
261
 
# File 'lib/sib-api-v3-sdk/models/request_contact_export_custom_contact_filter.rb', line 259

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



265
266
267
268
269
270
271
272
273
 
# File 'lib/sib-api-v3-sdk/models/request_contact_export_custom_contact_filter.rb', line 265

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



253
254
255
 
# File 'lib/sib-api-v3-sdk/models/request_contact_export_custom_contact_filter.rb', line 253

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



124
125
126
127
128
129
130
131
132
 
# File 'lib/sib-api-v3-sdk/models/request_contact_export_custom_contact_filter.rb', line 124

def valid?
  action_for_contacts_validator = EnumAttributeValidator.new('String', ['allContacts', 'subscribed', 'unsubscribed', 'unsubscribedPerList'])
  return false unless action_for_contacts_validator.valid?(@action_for_contacts)
  action_for_email_campaigns_validator = EnumAttributeValidator.new('String', ['openers', 'nonOpeners', 'clickers', 'nonClickers', 'unsubscribed', 'hardBounces', 'softBounces'])
  return false unless action_for_email_campaigns_validator.valid?(@action_for_email_campaigns)
  action_for_sms_campaigns_validator = EnumAttributeValidator.new('String', ['hardBounces', 'softBounces', 'unsubscribed'])
  return false unless action_for_sms_campaigns_validator.valid?(@action_for_sms_campaigns)
  true
end