hubspot-api-client 18.0.0 → 20.0.0.pre.beta.1

data/lib/hubspot/codegen/marketing/events/api/subscriber_state_changes_api.rb

@@ -1,7 +1,7 @@
 =begin
 #Marketing Events
 
-#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. 
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
 The version of the OpenAPI document: v3
 
@@ -21,46 +21,46 @@ module Hubspot
         def initialize(api_client = ApiClient.default)
           @api_client = api_client
         end
-        # Record
-        # Record a subscription state between multiple HubSpot contacts and a marketing event, using contact email addresses. Note that the contact must already exist in HubSpot; a contact will not be created.
-        # @param external_event_id [String] The id of the marketing event
-        # @param subscriber_state [String] The new subscriber state for the HubSpot contacts and the specified marketing event
-        # @param external_account_id [String] The account id associated with the marketing event
-        # @param batch_input_marketing_event_email_subscriber [BatchInputMarketingEventEmailSubscriber] The details of the contacts to subscribe to the event
+        # Record a subscriber state by contact email
+        # Record a subscriber state between multiple HubSpot contacts and a marketing event, using contact email addresses. Note that the contact must already exist in HubSpot; a contact will not be created. The contactProperties field is used only when creating a new contact. These properties will not update existing contacts. 
+        # @param external_event_id [String] The id of the marketing event in the external event application
+        # @param subscriber_state [String] The new subscriber state for the HubSpot contacts and the specified marketing event. For example: 'register', 'attend' or 'cancel'.
+        # @param external_account_id [String] The accountId that is associated with this marketing event in the external event application
+        # @param batch_input_marketing_event_email_subscriber [BatchInputMarketingEventEmailSubscriber] 
         # @param [Hash] opts the optional parameters
         # @return [Error]
-        def do_email_upsert_by_id(external_event_id, subscriber_state, external_account_id, batch_input_marketing_event_email_subscriber, opts = {})
-          data, _status_code, _headers = do_email_upsert_by_id_with_http_info(external_event_id, subscriber_state, external_account_id, batch_input_marketing_event_email_subscriber, opts)
+        def upsert_by_contact_email(external_event_id, subscriber_state, external_account_id, batch_input_marketing_event_email_subscriber, opts = {})
+          data, _status_code, _headers = upsert_by_contact_email_with_http_info(external_event_id, subscriber_state, external_account_id, batch_input_marketing_event_email_subscriber, opts)
           data
         end
 
-        # Record
-        # Record a subscription state between multiple HubSpot contacts and a marketing event, using contact email addresses. Note that the contact must already exist in HubSpot; a contact will not be created.
-        # @param external_event_id [String] The id of the marketing event
-        # @param subscriber_state [String] The new subscriber state for the HubSpot contacts and the specified marketing event
-        # @param external_account_id [String] The account id associated with the marketing event
-        # @param batch_input_marketing_event_email_subscriber [BatchInputMarketingEventEmailSubscriber] The details of the contacts to subscribe to the event
+        # Record a subscriber state by contact email
+        # Record a subscriber state between multiple HubSpot contacts and a marketing event, using contact email addresses. Note that the contact must already exist in HubSpot; a contact will not be created. The contactProperties field is used only when creating a new contact. These properties will not update existing contacts. 
+        # @param external_event_id [String] The id of the marketing event in the external event application
+        # @param subscriber_state [String] The new subscriber state for the HubSpot contacts and the specified marketing event. For example: 'register', 'attend' or 'cancel'.
+        # @param external_account_id [String] The accountId that is associated with this marketing event in the external event application
+        # @param batch_input_marketing_event_email_subscriber [BatchInputMarketingEventEmailSubscriber] 
         # @param [Hash] opts the optional parameters
         # @return [Array<(Error, Integer, Hash)>] Error data, response status code and response headers
-        def do_email_upsert_by_id_with_http_info(external_event_id, subscriber_state, external_account_id, batch_input_marketing_event_email_subscriber, opts = {})
+        def upsert_by_contact_email_with_http_info(external_event_id, subscriber_state, external_account_id, batch_input_marketing_event_email_subscriber, opts = {})
           if @api_client.config.debugging
-            @api_client.config.logger.debug 'Calling API: SubscriberStateChangesApi.do_email_upsert_by_id ...'
+            @api_client.config.logger.debug 'Calling API: SubscriberStateChangesApi.upsert_by_contact_email ...'
           end
           # verify the required parameter 'external_event_id' is set
           if @api_client.config.client_side_validation && external_event_id.nil?
-            fail ArgumentError, "Missing the required parameter 'external_event_id' when calling SubscriberStateChangesApi.do_email_upsert_by_id"
+            fail ArgumentError, "Missing the required parameter 'external_event_id' when calling SubscriberStateChangesApi.upsert_by_contact_email"
           end
           # verify the required parameter 'subscriber_state' is set
           if @api_client.config.client_side_validation && subscriber_state.nil?
-            fail ArgumentError, "Missing the required parameter 'subscriber_state' when calling SubscriberStateChangesApi.do_email_upsert_by_id"
+            fail ArgumentError, "Missing the required parameter 'subscriber_state' when calling SubscriberStateChangesApi.upsert_by_contact_email"
           end
           # verify the required parameter 'external_account_id' is set
           if @api_client.config.client_side_validation && external_account_id.nil?
-            fail ArgumentError, "Missing the required parameter 'external_account_id' when calling SubscriberStateChangesApi.do_email_upsert_by_id"
+            fail ArgumentError, "Missing the required parameter 'external_account_id' when calling SubscriberStateChangesApi.upsert_by_contact_email"
           end
           # verify the required parameter 'batch_input_marketing_event_email_subscriber' is set
           if @api_client.config.client_side_validation && batch_input_marketing_event_email_subscriber.nil?
-            fail ArgumentError, "Missing the required parameter 'batch_input_marketing_event_email_subscriber' when calling SubscriberStateChangesApi.do_email_upsert_by_id"
+            fail ArgumentError, "Missing the required parameter 'batch_input_marketing_event_email_subscriber' when calling SubscriberStateChangesApi.upsert_by_contact_email"
           end
           # resource path
           local_var_path = '/marketing/v3/marketing-events/events/{externalEventId}/{subscriberState}/email-upsert'.sub('{' + 'externalEventId' + '}', CGI.escape(external_event_id.to_s)).sub('{' + 'subscriberState' + '}', CGI.escape(subscriber_state.to_s))
@@ -92,7 +92,7 @@ module Hubspot
           auth_names = opts[:debug_auth_names] || ['oauth2']
 
           new_options = opts.merge(
-            :operation => :"SubscriberStateChangesApi.do_email_upsert_by_id",
+            :operation => :"SubscriberStateChangesApi.upsert_by_contact_email",
             :header_params => header_params,
             :query_params => query_params,
             :form_params => form_params,
@@ -103,51 +103,51 @@ module Hubspot
 
           data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
           if @api_client.config.debugging
-            @api_client.config.logger.debug "API called: SubscriberStateChangesApi#do_email_upsert_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+            @api_client.config.logger.debug "API called: SubscriberStateChangesApi#upsert_by_contact_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
           end
           return data, status_code, headers
         end
 
-        # Record
-        # Record a subscription state between multiple HubSpot contacts and a marketing event, using HubSpot contact ids. Note that the contact must already exist in HubSpot; a contact will not be create.
-        # @param external_event_id [String] The id of the marketing event
-        # @param subscriber_state [String] The new subscriber state for the HubSpot contacts and the specified marketing event
-        # @param external_account_id [String] The account id associated with the marketing event
-        # @param batch_input_marketing_event_subscriber [BatchInputMarketingEventSubscriber] The details of the contacts to subscribe to the event
+        # Record a subscriber state by contact ID
+        # Record a subscriber state between multiple HubSpot contacts and a marketing event, using HubSpot contact IDs. Note that the contact must already exist in HubSpot; a contact will not be created.
+        # @param external_event_id [String] The id of the marketing event in the external event application
+        # @param subscriber_state [String] The new subscriber state for the HubSpot contacts and the specified marketing event. For example: &#39;register&#39;, &#39;attend&#39; or &#39;cancel&#39;.
+        # @param external_account_id [String] The accountId that is associated with this marketing event in the external event application
+        # @param batch_input_marketing_event_subscriber [BatchInputMarketingEventSubscriber] 
         # @param [Hash] opts the optional parameters
         # @return [Error]
-        def do_upsert_by_id(external_event_id, subscriber_state, external_account_id, batch_input_marketing_event_subscriber, opts = {})
-          data, _status_code, _headers = do_upsert_by_id_with_http_info(external_event_id, subscriber_state, external_account_id, batch_input_marketing_event_subscriber, opts)
+        def upsert_by_contact_id(external_event_id, subscriber_state, external_account_id, batch_input_marketing_event_subscriber, opts = {})
+          data, _status_code, _headers = upsert_by_contact_id_with_http_info(external_event_id, subscriber_state, external_account_id, batch_input_marketing_event_subscriber, opts)
           data
         end
 
-        # Record
-        # Record a subscription state between multiple HubSpot contacts and a marketing event, using HubSpot contact ids. Note that the contact must already exist in HubSpot; a contact will not be create.
-        # @param external_event_id [String] The id of the marketing event
-        # @param subscriber_state [String] The new subscriber state for the HubSpot contacts and the specified marketing event
-        # @param external_account_id [String] The account id associated with the marketing event
-        # @param batch_input_marketing_event_subscriber [BatchInputMarketingEventSubscriber] The details of the contacts to subscribe to the event
+        # Record a subscriber state by contact ID
+        # Record a subscriber state between multiple HubSpot contacts and a marketing event, using HubSpot contact IDs. Note that the contact must already exist in HubSpot; a contact will not be created.
+        # @param external_event_id [String] The id of the marketing event in the external event application
+        # @param subscriber_state [String] The new subscriber state for the HubSpot contacts and the specified marketing event. For example: &#39;register&#39;, &#39;attend&#39; or &#39;cancel&#39;.
+        # @param external_account_id [String] The accountId that is associated with this marketing event in the external event application
+        # @param batch_input_marketing_event_subscriber [BatchInputMarketingEventSubscriber] 
         # @param [Hash] opts the optional parameters
         # @return [Array<(Error, Integer, Hash)>] Error data, response status code and response headers
-        def do_upsert_by_id_with_http_info(external_event_id, subscriber_state, external_account_id, batch_input_marketing_event_subscriber, opts = {})
+        def upsert_by_contact_id_with_http_info(external_event_id, subscriber_state, external_account_id, batch_input_marketing_event_subscriber, opts = {})
           if @api_client.config.debugging
-            @api_client.config.logger.debug 'Calling API: SubscriberStateChangesApi.do_upsert_by_id ...'
+            @api_client.config.logger.debug 'Calling API: SubscriberStateChangesApi.upsert_by_contact_id ...'
           end
           # verify the required parameter 'external_event_id' is set
           if @api_client.config.client_side_validation && external_event_id.nil?
-            fail ArgumentError, "Missing the required parameter 'external_event_id' when calling SubscriberStateChangesApi.do_upsert_by_id"
+            fail ArgumentError, "Missing the required parameter 'external_event_id' when calling SubscriberStateChangesApi.upsert_by_contact_id"
           end
           # verify the required parameter 'subscriber_state' is set
           if @api_client.config.client_side_validation && subscriber_state.nil?
-            fail ArgumentError, "Missing the required parameter 'subscriber_state' when calling SubscriberStateChangesApi.do_upsert_by_id"
+            fail ArgumentError, "Missing the required parameter 'subscriber_state' when calling SubscriberStateChangesApi.upsert_by_contact_id"
           end
           # verify the required parameter 'external_account_id' is set
           if @api_client.config.client_side_validation && external_account_id.nil?
-            fail ArgumentError, "Missing the required parameter 'external_account_id' when calling SubscriberStateChangesApi.do_upsert_by_id"
+            fail ArgumentError, "Missing the required parameter 'external_account_id' when calling SubscriberStateChangesApi.upsert_by_contact_id"
           end
           # verify the required parameter 'batch_input_marketing_event_subscriber' is set
           if @api_client.config.client_side_validation && batch_input_marketing_event_subscriber.nil?
-            fail ArgumentError, "Missing the required parameter 'batch_input_marketing_event_subscriber' when calling SubscriberStateChangesApi.do_upsert_by_id"
+            fail ArgumentError, "Missing the required parameter 'batch_input_marketing_event_subscriber' when calling SubscriberStateChangesApi.upsert_by_contact_id"
           end
           # resource path
           local_var_path = '/marketing/v3/marketing-events/events/{externalEventId}/{subscriberState}/upsert'.sub('{' + 'externalEventId' + '}', CGI.escape(external_event_id.to_s)).sub('{' + 'subscriberState' + '}', CGI.escape(subscriber_state.to_s))
@@ -179,7 +179,7 @@ module Hubspot
           auth_names = opts[:debug_auth_names] || ['oauth2']
 
           new_options = opts.merge(
-            :operation => :"SubscriberStateChangesApi.do_upsert_by_id",
+            :operation => :"SubscriberStateChangesApi.upsert_by_contact_id",
             :header_params => header_params,
             :query_params => query_params,
             :form_params => form_params,
@@ -190,7 +190,7 @@ module Hubspot
 
           data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
           if @api_client.config.debugging
-            @api_client.config.logger.debug "API called: SubscriberStateChangesApi#do_upsert_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+            @api_client.config.logger.debug "API called: SubscriberStateChangesApi#upsert_by_contact_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
           end
           return data, status_code, headers
         end

data/lib/hubspot/codegen/marketing/events/api_client.rb

@@ -1,7 +1,7 @@
 =begin
 #Marketing Events
 
-#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. 
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
 The version of the OpenAPI document: v3
 

data/lib/hubspot/codegen/marketing/events/api_error.rb

@@ -1,7 +1,7 @@
 =begin
 #Marketing Events
 
-#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. 
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
 The version of the OpenAPI document: v3
 

data/lib/hubspot/codegen/marketing/events/configuration.rb

@@ -1,7 +1,7 @@
 =begin
 #Marketing Events
 
-#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. 
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
 The version of the OpenAPI document: v3
 

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

@@ -0,0 +1,242 @@
+=begin
+#Marketing Events
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: v3
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.2.1
+
+=end
+
+require 'date'
+require 'time'
+
+module Hubspot
+  module Marketing
+    module Events
+      class AppInfo
+        attr_accessor :name
+
+        attr_accessor :id
+
+        # Attribute mapping from ruby-style variable name to JSON key.
+        def self.attribute_map
+          {
+            :'name' => :'name',
+            :'id' => :'id'
+          }
+        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
+          {
+            :'name' => :'String',
+            :'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::AppInfo` 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::AppInfo`. 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?(:'name')
+            self.name = attributes[:'name']
+          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 @name.nil?
+            invalid_properties.push('invalid value for "name", name 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 @name.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 &&
+              name == o.name &&
+              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
+          [name, 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)
+          attributes = attributes.transform_keys(&:to_sym)
+          self.class.openapi_types.each_pair do |key, type|
+            if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+              self.send("#{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[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
+          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 :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 = Hubspot::Marketing::Events.const_get(type)
+            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
+  end
+end