constant_contact_client 1.2.0 → 1.5.0

data/lib/constant_contact_client/models/profile_post_profile_dto.rb

@@ -0,0 +1,323 @@
+=begin
+#Constant Contact API v3
+
+#Swagger build version 3.0.161
+
+The version of the OpenAPI document: 1.0.220
+Contact: webservices@constantcontact.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 7.2.0
+
+=end
+
+require 'date'
+require 'time'
+
+module ConstantContactClient
+  # Describes a post to a single social profile, including the target profile and its current status on that network.
+  class ProfilePostProfileDto
+    # The human-readable username of the account that owns this profile.
+    attr_accessor :account_username
+
+    # The campaign activity ID for this post on the specified profile. Generated by the server on creation. When updating a post, existing profile entries should include their original <code>campaign_activity_id</code>.
+    attr_accessor :campaign_activity_id
+
+    # The status of the post activity for this profile.
+    attr_accessor :campaign_activity_status
+
+    # The activity's timestamp. For <code>SCHEDULED</code> activities, this is typically the same as the scheduled publish time; otherwise, it is the last-modified timestamp.
+    attr_accessor :campaign_activity_status_date
+
+    # A human-readable message describing the current status of the post activity. Can be a generic Constant Contact message or a specific message reported by the social network.
+    attr_accessor :campaign_activity_status_message
+
+    # The URL of the profile's image. This image may become stale and is only refreshed when retrieving profiles with <code>include=accessible</code>.
+    attr_accessor :image_url
+
+    # The social network this profile belongs to.
+    attr_accessor :network
+
+    # The social network's reference for this post. Only set when the status is <code>DONE</code>.
+    attr_accessor :network_post_id
+
+    # The permalink URL to the published post on the social network. Only set when the status is <code>DONE</code>.
+    attr_accessor :post_url
+
+    # The unique identifier for the profile to post to. Use the <code>profile_id</code> from <code>GET /social/profiles</code>.
+    attr_accessor :profile_id
+
+    # The display name of the profile.
+    attr_accessor :profile_name
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'account_username' => :'account_username',
+        :'campaign_activity_id' => :'campaign_activity_id',
+        :'campaign_activity_status' => :'campaign_activity_status',
+        :'campaign_activity_status_date' => :'campaign_activity_status_date',
+        :'campaign_activity_status_message' => :'campaign_activity_status_message',
+        :'image_url' => :'image_url',
+        :'network' => :'network',
+        :'network_post_id' => :'network_post_id',
+        :'post_url' => :'post_url',
+        :'profile_id' => :'profile_id',
+        :'profile_name' => :'profile_name'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'account_username' => :'String',
+        :'campaign_activity_id' => :'String',
+        :'campaign_activity_status' => :'String',
+        :'campaign_activity_status_date' => :'Time',
+        :'campaign_activity_status_message' => :'String',
+        :'image_url' => :'String',
+        :'network' => :'String',
+        :'network_post_id' => :'String',
+        :'post_url' => :'String',
+        :'profile_id' => :'String',
+        :'profile_name' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `ConstantContactClient::ProfilePostProfileDto` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `ConstantContactClient::ProfilePostProfileDto`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'account_username')
+        self.account_username = attributes[:'account_username']
+      end
+
+      if attributes.key?(:'campaign_activity_id')
+        self.campaign_activity_id = attributes[:'campaign_activity_id']
+      end
+
+      if attributes.key?(:'campaign_activity_status')
+        self.campaign_activity_status = attributes[:'campaign_activity_status']
+      end
+
+      if attributes.key?(:'campaign_activity_status_date')
+        self.campaign_activity_status_date = attributes[:'campaign_activity_status_date']
+      end
+
+      if attributes.key?(:'campaign_activity_status_message')
+        self.campaign_activity_status_message = attributes[:'campaign_activity_status_message']
+      end
+
+      if attributes.key?(:'image_url')
+        self.image_url = attributes[:'image_url']
+      end
+
+      if attributes.key?(:'network')
+        self.network = attributes[:'network']
+      end
+
+      if attributes.key?(:'network_post_id')
+        self.network_post_id = attributes[:'network_post_id']
+      end
+
+      if attributes.key?(:'post_url')
+        self.post_url = attributes[:'post_url']
+      end
+
+      if attributes.key?(:'profile_id')
+        self.profile_id = attributes[:'profile_id']
+      else
+        self.profile_id = nil
+      end
+
+      if attributes.key?(:'profile_name')
+        self.profile_name = attributes[:'profile_name']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @profile_id.nil?
+        invalid_properties.push('invalid value for "profile_id", profile_id cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @profile_id.nil?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          account_username == o.account_username &&
+          campaign_activity_id == o.campaign_activity_id &&
+          campaign_activity_status == o.campaign_activity_status &&
+          campaign_activity_status_date == o.campaign_activity_status_date &&
+          campaign_activity_status_message == o.campaign_activity_status_message &&
+          image_url == o.image_url &&
+          network == o.network &&
+          network_post_id == o.network_post_id &&
+          post_url == o.post_url &&
+          profile_id == o.profile_id &&
+          profile_name == o.profile_name
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [account_username, campaign_activity_id, campaign_activity_status, campaign_activity_status_date, campaign_activity_status_message, image_url, network, network_post_id, post_url, profile_id, profile_name].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif 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[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.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
+        # models (e.g. Pet) or oneOf
+        klass = ConstantContactClient.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    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
+    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
+
+  end
+
+end