constant_contact_client 1.2.0 → 1.5.0

data/lib/constant_contact_client/models/create_event201_response.rb

@@ -0,0 +1,708 @@
+=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
+  class CreateEvent201Response
+    # Provides the event description.
+    attr_accessor :description
+
+    # The title for the event. The title does not have to be unique for an account.
+    attr_accessor :title
+
+    # The name of the event, has to be unique for the account.
+    attr_accessor :name
+
+    # The ID that uniquely identifies the event.
+    attr_accessor :event_id
+
+    # The system assigned ID that uniquely identifies the event and is identical to the `event_id`.
+    attr_accessor :campaign_id
+
+    # The date the event starts.
+    attr_accessor :event_start
+
+    # The date the event ends.
+    attr_accessor :event_end
+
+    # Identifies the event type.
+    attr_accessor :event_type
+
+    # The encrypted SOId.
+    attr_accessor :eso
+
+    attr_accessor :contact
+
+    # The time the event was created, in ISO format. Read-only.
+    attr_accessor :create_time
+
+    # The time the event was published, in ISO format.
+    attr_accessor :active_time
+
+    # The time the event was cancelled, in ISO format. Read-only.
+    attr_accessor :cancelled_time
+
+    # The time the event was deleted, in ISO format. Read-only.
+    attr_accessor :deleted_time
+
+    # The date and time the event was last modified.
+    attr_accessor :last_update_time
+
+    attr_accessor :address
+
+    # The accepted currency for payments. Required for events collecting payments ['AUD','BRL','CAD','CHF','CZK','DKK','EUR','GBP','HKD','HUF','ILS','JPY','MXN','MYR','NOK','NZD','PHP','PLN','RUB','SEK','SGD','THB','TRY','TWD','USD']
+    attr_accessor :currency_type
+
+    attr_accessor :default_track
+
+    # Display or hide event contact information on the registration form and registration confirmation message.
+    attr_accessor :display_contact_flag
+
+    # Display or hide the event end time on the registration form and registration confirmation message.
+    attr_accessor :display_end_time_flag
+
+    # Display the event on the Event Calendar.
+    attr_accessor :display_on_calendar_flag
+
+    # Display the time zone on the registration form and registration confirmation message.
+    attr_accessor :display_time_zone_flag
+
+    # The event calendar URL.
+    attr_accessor :event_calendar_url
+
+    attr_accessor :event_metadata
+
+    # The short code to use for the event.
+    attr_accessor :event_code
+
+    # List of event promotions.
+    attr_accessor :event_promotions
+
+    attr_accessor :event_settings
+
+    # The event widget URL.
+    attr_accessor :event_widget_url
+
+    # List of failed campaign activities.
+    attr_accessor :failed_campaign_activities
+
+    # Specifies if the event is physical and/or virtual, or to be determined.
+    attr_accessor :location_type
+
+    # If `true`, sends an email to the event owner when a registration is made.
+    attr_accessor :notify_owner_on_reg
+
+    attr_accessor :online_meeting
+
+    # The event registration URL.
+    attr_accessor :registration_url
+
+    # Specifies the event's current status.
+    attr_accessor :status
+
+    # The time zone where the event takes place.
+    attr_accessor :time_zone
+
+    # The abbreviation to use to indicate the time zone where the event takes place.
+    attr_accessor :time_zone_abbreviation
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'description' => :'description',
+        :'title' => :'title',
+        :'name' => :'name',
+        :'event_id' => :'event_id',
+        :'campaign_id' => :'campaign_id',
+        :'event_start' => :'event_start',
+        :'event_end' => :'event_end',
+        :'event_type' => :'event_type',
+        :'eso' => :'eso',
+        :'contact' => :'contact',
+        :'create_time' => :'create_time',
+        :'active_time' => :'active_time',
+        :'cancelled_time' => :'cancelled_time',
+        :'deleted_time' => :'deleted_time',
+        :'last_update_time' => :'last_update_time',
+        :'address' => :'address',
+        :'currency_type' => :'currency_type',
+        :'default_track' => :'default_track',
+        :'display_contact_flag' => :'display_contact_flag',
+        :'display_end_time_flag' => :'display_end_time_flag',
+        :'display_on_calendar_flag' => :'display_on_calendar_flag',
+        :'display_time_zone_flag' => :'display_time_zone_flag',
+        :'event_calendar_url' => :'event_calendar_url',
+        :'event_metadata' => :'event_metadata',
+        :'event_code' => :'event_code',
+        :'event_promotions' => :'event_promotions',
+        :'event_settings' => :'event_settings',
+        :'event_widget_url' => :'event_widget_url',
+        :'failed_campaign_activities' => :'failed_campaign_activities',
+        :'location_type' => :'location_type',
+        :'notify_owner_on_reg' => :'notify_owner_on_reg',
+        :'online_meeting' => :'online_meeting',
+        :'registration_url' => :'registration_url',
+        :'status' => :'status',
+        :'time_zone' => :'time_zone',
+        :'time_zone_abbreviation' => :'time_zone_abbreviation'
+      }
+    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
+      {
+        :'description' => :'String',
+        :'title' => :'String',
+        :'name' => :'String',
+        :'event_id' => :'String',
+        :'campaign_id' => :'String',
+        :'event_start' => :'String',
+        :'event_end' => :'String',
+        :'event_type' => :'String',
+        :'eso' => :'String',
+        :'contact' => :'ContactDto1',
+        :'create_time' => :'String',
+        :'active_time' => :'String',
+        :'cancelled_time' => :'String',
+        :'deleted_time' => :'String',
+        :'last_update_time' => :'String',
+        :'address' => :'AddressDto1',
+        :'currency_type' => :'String',
+        :'default_track' => :'TrackDto1',
+        :'display_contact_flag' => :'Boolean',
+        :'display_end_time_flag' => :'Boolean',
+        :'display_on_calendar_flag' => :'Boolean',
+        :'display_time_zone_flag' => :'Boolean',
+        :'event_calendar_url' => :'String',
+        :'event_metadata' => :'EventMetaDataDto1',
+        :'event_code' => :'String',
+        :'event_promotions' => :'Array<CreateEvent201ResponseEventPromotionsInner>',
+        :'event_settings' => :'CreateEvent201ResponseEventSettings',
+        :'event_widget_url' => :'String',
+        :'failed_campaign_activities' => :'Array<String>',
+        :'location_type' => :'String',
+        :'notify_owner_on_reg' => :'Boolean',
+        :'online_meeting' => :'OnlineMeetingDto1',
+        :'registration_url' => :'String',
+        :'status' => :'String',
+        :'time_zone' => :'String',
+        :'time_zone_abbreviation' => :'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::CreateEvent201Response` 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::CreateEvent201Response`. 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?(:'description')
+        self.description = attributes[:'description']
+      else
+        self.description = nil
+      end
+
+      if attributes.key?(:'title')
+        self.title = attributes[:'title']
+      else
+        self.title = nil
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'event_id')
+        self.event_id = attributes[:'event_id']
+      end
+
+      if attributes.key?(:'campaign_id')
+        self.campaign_id = attributes[:'campaign_id']
+      else
+        self.campaign_id = nil
+      end
+
+      if attributes.key?(:'event_start')
+        self.event_start = attributes[:'event_start']
+      else
+        self.event_start = nil
+      end
+
+      if attributes.key?(:'event_end')
+        self.event_end = attributes[:'event_end']
+      else
+        self.event_end = nil
+      end
+
+      if attributes.key?(:'event_type')
+        self.event_type = attributes[:'event_type']
+      else
+        self.event_type = nil
+      end
+
+      if attributes.key?(:'eso')
+        self.eso = attributes[:'eso']
+      end
+
+      if attributes.key?(:'contact')
+        self.contact = attributes[:'contact']
+      end
+
+      if attributes.key?(:'create_time')
+        self.create_time = attributes[:'create_time']
+      end
+
+      if attributes.key?(:'active_time')
+        self.active_time = attributes[:'active_time']
+      end
+
+      if attributes.key?(:'cancelled_time')
+        self.cancelled_time = attributes[:'cancelled_time']
+      end
+
+      if attributes.key?(:'deleted_time')
+        self.deleted_time = attributes[:'deleted_time']
+      end
+
+      if attributes.key?(:'last_update_time')
+        self.last_update_time = attributes[:'last_update_time']
+      end
+
+      if attributes.key?(:'address')
+        self.address = attributes[:'address']
+      end
+
+      if attributes.key?(:'currency_type')
+        self.currency_type = attributes[:'currency_type']
+      end
+
+      if attributes.key?(:'default_track')
+        self.default_track = attributes[:'default_track']
+      else
+        self.default_track = nil
+      end
+
+      if attributes.key?(:'display_contact_flag')
+        self.display_contact_flag = attributes[:'display_contact_flag']
+      end
+
+      if attributes.key?(:'display_end_time_flag')
+        self.display_end_time_flag = attributes[:'display_end_time_flag']
+      end
+
+      if attributes.key?(:'display_on_calendar_flag')
+        self.display_on_calendar_flag = attributes[:'display_on_calendar_flag']
+      end
+
+      if attributes.key?(:'display_time_zone_flag')
+        self.display_time_zone_flag = attributes[:'display_time_zone_flag']
+      end
+
+      if attributes.key?(:'event_calendar_url')
+        self.event_calendar_url = attributes[:'event_calendar_url']
+      end
+
+      if attributes.key?(:'event_metadata')
+        self.event_metadata = attributes[:'event_metadata']
+      end
+
+      if attributes.key?(:'event_code')
+        self.event_code = attributes[:'event_code']
+      end
+
+      if attributes.key?(:'event_promotions')
+        if (value = attributes[:'event_promotions']).is_a?(Array)
+          self.event_promotions = value
+        end
+      end
+
+      if attributes.key?(:'event_settings')
+        self.event_settings = attributes[:'event_settings']
+      end
+
+      if attributes.key?(:'event_widget_url')
+        self.event_widget_url = attributes[:'event_widget_url']
+      end
+
+      if attributes.key?(:'failed_campaign_activities')
+        if (value = attributes[:'failed_campaign_activities']).is_a?(Array)
+          self.failed_campaign_activities = value
+        end
+      end
+
+      if attributes.key?(:'location_type')
+        self.location_type = attributes[:'location_type']
+      else
+        self.location_type = nil
+      end
+
+      if attributes.key?(:'notify_owner_on_reg')
+        self.notify_owner_on_reg = attributes[:'notify_owner_on_reg']
+      end
+
+      if attributes.key?(:'online_meeting')
+        self.online_meeting = attributes[:'online_meeting']
+      end
+
+      if attributes.key?(:'registration_url')
+        self.registration_url = attributes[:'registration_url']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.key?(:'time_zone')
+        self.time_zone = attributes[:'time_zone']
+      else
+        self.time_zone = nil
+      end
+
+      if attributes.key?(:'time_zone_abbreviation')
+        self.time_zone_abbreviation = attributes[:'time_zone_abbreviation']
+      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 @description.nil?
+        invalid_properties.push('invalid value for "description", description cannot be nil.')
+      end
+
+      if @description.to_s.length > 600
+        invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 600.')
+      end
+
+      if @description.to_s.length < 0
+        invalid_properties.push('invalid value for "description", the character length must be great than or equal to 0.')
+      end
+
+      if @title.nil?
+        invalid_properties.push('invalid value for "title", title cannot be nil.')
+      end
+
+      if @title.to_s.length > 100
+        invalid_properties.push('invalid value for "title", the character length must be smaller than or equal to 100.')
+      end
+
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @name.to_s.length > 100
+        invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 100.')
+      end
+
+      if @name.to_s.length < 1
+        invalid_properties.push('invalid value for "name", the character length must be great than or equal to 1.')
+      end
+
+      if @campaign_id.nil?
+        invalid_properties.push('invalid value for "campaign_id", campaign_id cannot be nil.')
+      end
+
+      if @event_start.nil?
+        invalid_properties.push('invalid value for "event_start", event_start cannot be nil.')
+      end
+
+      if @event_end.nil?
+        invalid_properties.push('invalid value for "event_end", event_end cannot be nil.')
+      end
+
+      if @event_type.nil?
+        invalid_properties.push('invalid value for "event_type", event_type cannot be nil.')
+      end
+
+      if @default_track.nil?
+        invalid_properties.push('invalid value for "default_track", default_track cannot be nil.')
+      end
+
+      if @location_type.nil?
+        invalid_properties.push('invalid value for "location_type", location_type cannot be nil.')
+      end
+
+      if @time_zone.nil?
+        invalid_properties.push('invalid value for "time_zone", time_zone 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 @description.nil?
+      return false if @description.to_s.length > 600
+      return false if @description.to_s.length < 0
+      return false if @title.nil?
+      return false if @title.to_s.length > 100
+      return false if @name.nil?
+      return false if @name.to_s.length > 100
+      return false if @name.to_s.length < 1
+      return false if @campaign_id.nil?
+      return false if @event_start.nil?
+      return false if @event_end.nil?
+      return false if @event_type.nil?
+      return false if @default_track.nil?
+      return false if @location_type.nil?
+      return false if @time_zone.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] description Value to be assigned
+    def description=(description)
+      if description.nil?
+        fail ArgumentError, 'description cannot be nil'
+      end
+
+      if description.to_s.length > 600
+        fail ArgumentError, 'invalid value for "description", the character length must be smaller than or equal to 600.'
+      end
+
+      if description.to_s.length < 0
+        fail ArgumentError, 'invalid value for "description", the character length must be great than or equal to 0.'
+      end
+
+      @description = description
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] title Value to be assigned
+    def title=(title)
+      if title.nil?
+        fail ArgumentError, 'title cannot be nil'
+      end
+
+      if title.to_s.length > 100
+        fail ArgumentError, 'invalid value for "title", the character length must be smaller than or equal to 100.'
+      end
+
+      @title = title
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if name.nil?
+        fail ArgumentError, 'name cannot be nil'
+      end
+
+      if name.to_s.length > 100
+        fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 100.'
+      end
+
+      if name.to_s.length < 1
+        fail ArgumentError, 'invalid value for "name", the character length must be great than or equal to 1.'
+      end
+
+      @name = name
+    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 &&
+          description == o.description &&
+          title == o.title &&
+          name == o.name &&
+          event_id == o.event_id &&
+          campaign_id == o.campaign_id &&
+          event_start == o.event_start &&
+          event_end == o.event_end &&
+          event_type == o.event_type &&
+          eso == o.eso &&
+          contact == o.contact &&
+          create_time == o.create_time &&
+          active_time == o.active_time &&
+          cancelled_time == o.cancelled_time &&
+          deleted_time == o.deleted_time &&
+          last_update_time == o.last_update_time &&
+          address == o.address &&
+          currency_type == o.currency_type &&
+          default_track == o.default_track &&
+          display_contact_flag == o.display_contact_flag &&
+          display_end_time_flag == o.display_end_time_flag &&
+          display_on_calendar_flag == o.display_on_calendar_flag &&
+          display_time_zone_flag == o.display_time_zone_flag &&
+          event_calendar_url == o.event_calendar_url &&
+          event_metadata == o.event_metadata &&
+          event_code == o.event_code &&
+          event_promotions == o.event_promotions &&
+          event_settings == o.event_settings &&
+          event_widget_url == o.event_widget_url &&
+          failed_campaign_activities == o.failed_campaign_activities &&
+          location_type == o.location_type &&
+          notify_owner_on_reg == o.notify_owner_on_reg &&
+          online_meeting == o.online_meeting &&
+          registration_url == o.registration_url &&
+          status == o.status &&
+          time_zone == o.time_zone &&
+          time_zone_abbreviation == o.time_zone_abbreviation
+    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
+      [description, title, name, event_id, campaign_id, event_start, event_end, event_type, eso, contact, create_time, active_time, cancelled_time, deleted_time, last_update_time, address, currency_type, default_track, display_contact_flag, display_end_time_flag, display_on_calendar_flag, display_time_zone_flag, event_calendar_url, event_metadata, event_code, event_promotions, event_settings, event_widget_url, failed_campaign_activities, location_type, notify_owner_on_reg, online_meeting, registration_url, status, time_zone, time_zone_abbreviation].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