hubspot-api-client 11.2.0 → 12.0.0

data/lib/hubspot/codegen/marketing/events/models/marketing_event_public_read_response.rb

@@ -0,0 +1,420 @@
+=begin
+#Marketing Events Extension
+
+#These APIs allow you to interact with HubSpot's Marketing Events Extension. It allows you to: * Create, Read or update Marketing Event information in HubSpot * Specify whether a HubSpot contact has registered, attended or cancelled a registration to a Marketing Event. * Specify a URL that can be called to get the details of a Marketing Event. 
+
+The version of the OpenAPI document: v3
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'date'
+
+module Hubspot
+  module Marketing
+    module Events
+      class MarketingEventPublicReadResponse
+        # The name of the marketing event.
+        attr_accessor :event_name
+
+        # The type of the marketing event.
+        attr_accessor :event_type
+
+        # The start date and time of the marketing event.
+        attr_accessor :start_date_time
+
+        # The end date and time of the marketing event.
+        attr_accessor :end_date_time
+
+        # The name of the organizer of the marketing event.
+        attr_accessor :event_organizer
+
+        # The description of the marketing event.
+        attr_accessor :event_description
+
+        # A URL in the external event application where the marketing event can be managed.
+        attr_accessor :event_url
+
+        # Indicates if the marketing event has been cancelled.
+        attr_accessor :event_cancelled
+
+        # A list of PropertyValues. These can be whatever kind of property names and values you want. However, they must already exist on the HubSpot account's definition of the MarketingEvent Object. If they don't they will be filtered out and not set. In order to do this you'll need to create a new PropertyGroup on the HubSpot account's MarketingEvent object for your specific app and create the Custom Property you want to track on that HubSpot account. Do not create any new default properties on the MarketingEvent object as that will apply to all HubSpot accounts. 
+        attr_accessor :custom_properties
+
+        # The id of the marketing event in the external event application.
+        attr_accessor :external_event_id
+
+        # The number of HubSpot contacts that registered for this marketing event.
+        attr_accessor :registrants
+
+        # The number of HubSpot contacts that attended this marketing event.
+        attr_accessor :attendees
+
+        # The number of HubSpot contacts that registered for this marketing event, but later cancelled their registration.
+        attr_accessor :cancellations
+
+        # The number of HubSpot contacts that registered for this marketing event, but did not attend. This field only had a value when the event is over.
+        attr_accessor :no_shows
+
+        attr_accessor :created_at
+
+        attr_accessor :updated_at
+
+        attr_accessor :id
+
+        # Attribute mapping from ruby-style variable name to JSON key.
+        def self.attribute_map
+          {
+            :'event_name' => :'eventName',
+            :'event_type' => :'eventType',
+            :'start_date_time' => :'startDateTime',
+            :'end_date_time' => :'endDateTime',
+            :'event_organizer' => :'eventOrganizer',
+            :'event_description' => :'eventDescription',
+            :'event_url' => :'eventUrl',
+            :'event_cancelled' => :'eventCancelled',
+            :'custom_properties' => :'customProperties',
+            :'external_event_id' => :'externalEventId',
+            :'registrants' => :'registrants',
+            :'attendees' => :'attendees',
+            :'cancellations' => :'cancellations',
+            :'no_shows' => :'noShows',
+            :'created_at' => :'createdAt',
+            :'updated_at' => :'updatedAt',
+            :'id' => :'id'
+          }
+        end
+
+        # Attribute type mapping.
+        def self.openapi_types
+          {
+            :'event_name' => :'String',
+            :'event_type' => :'String',
+            :'start_date_time' => :'DateTime',
+            :'end_date_time' => :'DateTime',
+            :'event_organizer' => :'String',
+            :'event_description' => :'String',
+            :'event_url' => :'String',
+            :'event_cancelled' => :'Boolean',
+            :'custom_properties' => :'Array<PropertyValue>',
+            :'external_event_id' => :'String',
+            :'registrants' => :'Integer',
+            :'attendees' => :'Integer',
+            :'cancellations' => :'Integer',
+            :'no_shows' => :'Integer',
+            :'created_at' => :'DateTime',
+            :'updated_at' => :'DateTime',
+            :'id' => :'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 `Hubspot::Marketing::Events::MarketingEventPublicReadResponse` 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 `Hubspot::Marketing::Events::MarketingEventPublicReadResponse`. 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?(:'event_name')
+            self.event_name = attributes[:'event_name']
+          end
+
+          if attributes.key?(:'event_type')
+            self.event_type = attributes[:'event_type']
+          end
+
+          if attributes.key?(:'start_date_time')
+            self.start_date_time = attributes[:'start_date_time']
+          end
+
+          if attributes.key?(:'end_date_time')
+            self.end_date_time = attributes[:'end_date_time']
+          end
+
+          if attributes.key?(:'event_organizer')
+            self.event_organizer = attributes[:'event_organizer']
+          end
+
+          if attributes.key?(:'event_description')
+            self.event_description = attributes[:'event_description']
+          end
+
+          if attributes.key?(:'event_url')
+            self.event_url = attributes[:'event_url']
+          end
+
+          if attributes.key?(:'event_cancelled')
+            self.event_cancelled = attributes[:'event_cancelled']
+          end
+
+          if attributes.key?(:'custom_properties')
+            if (value = attributes[:'custom_properties']).is_a?(Array)
+              self.custom_properties = value
+            end
+          end
+
+          if attributes.key?(:'external_event_id')
+            self.external_event_id = attributes[:'external_event_id']
+          end
+
+          if attributes.key?(:'registrants')
+            self.registrants = attributes[:'registrants']
+          end
+
+          if attributes.key?(:'attendees')
+            self.attendees = attributes[:'attendees']
+          end
+
+          if attributes.key?(:'cancellations')
+            self.cancellations = attributes[:'cancellations']
+          end
+
+          if attributes.key?(:'no_shows')
+            self.no_shows = attributes[:'no_shows']
+          end
+
+          if attributes.key?(:'created_at')
+            self.created_at = attributes[:'created_at']
+          end
+
+          if attributes.key?(:'updated_at')
+            self.updated_at = attributes[:'updated_at']
+          end
+
+          if attributes.key?(:'id')
+            self.id = attributes[:'id']
+          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
+          invalid_properties = Array.new
+          if @event_name.nil?
+            invalid_properties.push('invalid value for "event_name", event_name cannot be nil.')
+          end
+
+          if @event_organizer.nil?
+            invalid_properties.push('invalid value for "event_organizer", event_organizer cannot be nil.')
+          end
+
+          if @external_event_id.nil?
+            invalid_properties.push('invalid value for "external_event_id", external_event_id cannot be nil.')
+          end
+
+          if @registrants.nil?
+            invalid_properties.push('invalid value for "registrants", registrants cannot be nil.')
+          end
+
+          if @attendees.nil?
+            invalid_properties.push('invalid value for "attendees", attendees cannot be nil.')
+          end
+
+          if @cancellations.nil?
+            invalid_properties.push('invalid value for "cancellations", cancellations cannot be nil.')
+          end
+
+          if @no_shows.nil?
+            invalid_properties.push('invalid value for "no_shows", no_shows cannot be nil.')
+          end
+
+          if @created_at.nil?
+            invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
+          end
+
+          if @updated_at.nil?
+            invalid_properties.push('invalid value for "updated_at", updated_at cannot be nil.')
+          end
+
+          if @id.nil?
+            invalid_properties.push('invalid value for "id", 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?
+          return false if @event_name.nil?
+          return false if @event_organizer.nil?
+          return false if @external_event_id.nil?
+          return false if @registrants.nil?
+          return false if @attendees.nil?
+          return false if @cancellations.nil?
+          return false if @no_shows.nil?
+          return false if @created_at.nil?
+          return false if @updated_at.nil?
+          return false if @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 &&
+              event_name == o.event_name &&
+              event_type == o.event_type &&
+              start_date_time == o.start_date_time &&
+              end_date_time == o.end_date_time &&
+              event_organizer == o.event_organizer &&
+              event_description == o.event_description &&
+              event_url == o.event_url &&
+              event_cancelled == o.event_cancelled &&
+              custom_properties == o.custom_properties &&
+              external_event_id == o.external_event_id &&
+              registrants == o.registrants &&
+              attendees == o.attendees &&
+              cancellations == o.cancellations &&
+              no_shows == o.no_shows &&
+              created_at == o.created_at &&
+              updated_at == o.updated_at &&
+              id == o.id
+        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
+          [event_name, event_type, start_date_time, end_date_time, event_organizer, event_description, event_url, event_cancelled, custom_properties, external_event_id, registrants, attendees, cancellations, no_shows, created_at, updated_at, id].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)
+          new.build_from_hash(attributes)
+        end
+
+        # Builds the object from hash
+        # @param [Hash] attributes Model attributes in the form of hash
+        # @return [Object] Returns the model itself
+        def build_from_hash(attributes)
+          return nil unless attributes.is_a?(Hash)
+          self.class.openapi_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
+
+        # Deserializes the data based on type
+        # @param string type Data type
+        # @param string value Value to be deserialized
+        # @return [Object] Deserialized data
+        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
+            Hubspot::Marketing::Events.const_get(type).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
+  end
+end

data/lib/hubspot/codegen/marketing/events/models/marketing_event_subscriber.rb

@@ -0,0 +1,225 @@
+=begin
+#Marketing Events Extension
+
+#These APIs allow you to interact with HubSpot's Marketing Events Extension. It allows you to: * Create, Read or update Marketing Event information in HubSpot * Specify whether a HubSpot contact has registered, attended or cancelled a registration to a Marketing Event. * Specify a URL that can be called to get the details of a Marketing Event. 
+
+The version of the OpenAPI document: v3
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'date'
+
+module Hubspot
+  module Marketing
+    module Events
+      class MarketingEventSubscriber
+        # The date and time at which the contact subscribed to the event.
+        attr_accessor :interaction_date_time
+
+        attr_accessor :vid
+
+        # Attribute mapping from ruby-style variable name to JSON key.
+        def self.attribute_map
+          {
+            :'interaction_date_time' => :'interactionDateTime',
+            :'vid' => :'vid'
+          }
+        end
+
+        # Attribute type mapping.
+        def self.openapi_types
+          {
+            :'interaction_date_time' => :'Integer',
+            :'vid' => :'Integer'
+          }
+        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 `Hubspot::Marketing::Events::MarketingEventSubscriber` 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 `Hubspot::Marketing::Events::MarketingEventSubscriber`. 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?(:'interaction_date_time')
+            self.interaction_date_time = attributes[:'interaction_date_time']
+          end
+
+          if attributes.key?(:'vid')
+            self.vid = attributes[:'vid']
+          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
+          invalid_properties = Array.new
+          if @interaction_date_time.nil?
+            invalid_properties.push('invalid value for "interaction_date_time", interaction_date_time 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?
+          return false if @interaction_date_time.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 &&
+              interaction_date_time == o.interaction_date_time &&
+              vid == o.vid
+        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
+          [interaction_date_time, vid].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)
+          new.build_from_hash(attributes)
+        end
+
+        # Builds the object from hash
+        # @param [Hash] attributes Model attributes in the form of hash
+        # @return [Object] Returns the model itself
+        def build_from_hash(attributes)
+          return nil unless attributes.is_a?(Hash)
+          self.class.openapi_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
+
+        # Deserializes the data based on type
+        # @param string type Data type
+        # @param string value Value to be deserialized
+        # @return [Object] Deserialized data
+        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
+            Hubspot::Marketing::Events.const_get(type).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
+  end
+end