class SibApiV3Sdk::RequestContactExportCustomContactFilter
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.
Attributes
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.
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).
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.
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.
Mandatory if actionForContacts is passed, ignored otherwise. Id of the list for which the corresponding action shall be applied in the filter.
Considered only if actionForSmsCampaigns is passed, ignored otherwise. The id of sms campaign for which the corresponding action shall be applied in the filter.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# 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
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# 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
Attribute type mapping.
# 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
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# 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
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# 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
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# 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
Custom attribute writer method checking allowed values (enum). @param [Object] action_for_contacts
Object to be assigned
# File lib/sib-api-v3-sdk/models/request_contact_export_custom_contact_filter.rb, line 136 def action_for_contacts=(action_for_contacts) validator = EnumAttributeValidator.new('String', ['allContacts', 'subscribed', 'unsubscribed', 'unsubscribedPerList']) unless validator.valid?(action_for_contacts) fail ArgumentError, 'invalid value for "action_for_contacts", must be one of #{validator.allowable_values}.' end @action_for_contacts = action_for_contacts end
Custom attribute writer method checking allowed values (enum). @param [Object] action_for_email_campaigns
Object to be assigned
# File lib/sib-api-v3-sdk/models/request_contact_export_custom_contact_filter.rb, line 146 def action_for_email_campaigns=(action_for_email_campaigns) validator = EnumAttributeValidator.new('String', ['openers', 'nonOpeners', 'clickers', 'nonClickers', 'unsubscribed', 'hardBounces', 'softBounces']) unless validator.valid?(action_for_email_campaigns) fail ArgumentError, 'invalid value for "action_for_email_campaigns", must be one of #{validator.allowable_values}.' end @action_for_email_campaigns = action_for_email_campaigns end
Custom attribute writer method checking allowed values (enum). @param [Object] action_for_sms_campaigns
Object to be assigned
# File lib/sib-api-v3-sdk/models/request_contact_export_custom_contact_filter.rb, line 156 def action_for_sms_campaigns=(action_for_sms_campaigns) validator = EnumAttributeValidator.new('String', ['hardBounces', 'softBounces', 'unsubscribed']) unless validator.valid?(action_for_sms_campaigns) fail ArgumentError, 'invalid value for "action_for_sms_campaigns", must be one of #{validator.allowable_values}.' end @action_for_sms_campaigns = action_for_sms_campaigns end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# 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
@see the `==` method @param [Object] Object to be compared
# File lib/sib-api-v3-sdk/models/request_contact_export_custom_contact_filter.rb, line 179 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# 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
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# 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
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/sib-api-v3-sdk/models/request_contact_export_custom_contact_filter.rb, line 253 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# 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