hubspot-api-client 19.0.0 → 20.0.0

data/lib/hubspot/codegen/{crm/contacts/api/gdpr_api.rb → events/send/api/batch_api.rb}

@@ -1,5 +1,5 @@
 =begin
-#Contacts
+#Events Send Event Completions
 
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
@@ -13,39 +13,39 @@ OpenAPI Generator version: 6.2.1
 require 'cgi'
 
 module Hubspot
-  module Crm
-    module Contacts
-      class GDPRApi
+  module Events
+    module Send
+      class BatchApi
         attr_accessor :api_client
 
         def initialize(api_client = ApiClient.default)
           @api_client = api_client
         end
-        # GDPR DELETE
-        # Permanently delete a contact and all associated content to follow GDPR. Use optional property 'idProperty' set to 'email' to identify contact by email address. If email address is not found, the email address will be added to a blocklist and prevent it from being used in the future.
-        # @param public_gdpr_delete_input [PublicGdprDeleteInput] 
+        # Send a batch of event completions
+        # Send multiple event completions at once.
+        # @param batched_behavioral_event_http_completion_request [BatchedBehavioralEventHttpCompletionRequest] 
         # @param [Hash] opts the optional parameters
         # @return [nil]
-        def purge(public_gdpr_delete_input, opts = {})
-          purge_with_http_info(public_gdpr_delete_input, opts)
+        def call_send(batched_behavioral_event_http_completion_request, opts = {})
+          call_send_with_http_info(batched_behavioral_event_http_completion_request, opts)
           nil
         end
 
-        # GDPR DELETE
-        # Permanently delete a contact and all associated content to follow GDPR. Use optional property 'idProperty' set to 'email' to identify contact by email address. If email address is not found, the email address will be added to a blocklist and prevent it from being used in the future.
-        # @param public_gdpr_delete_input [PublicGdprDeleteInput] 
+        # Send a batch of event completions
+        # Send multiple event completions at once.
+        # @param batched_behavioral_event_http_completion_request [BatchedBehavioralEventHttpCompletionRequest] 
         # @param [Hash] opts the optional parameters
         # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
-        def purge_with_http_info(public_gdpr_delete_input, opts = {})
+        def call_send_with_http_info(batched_behavioral_event_http_completion_request, opts = {})
           if @api_client.config.debugging
-            @api_client.config.logger.debug 'Calling API: GDPRApi.purge ...'
+            @api_client.config.logger.debug 'Calling API: BatchApi.call_send ...'
           end
-          # verify the required parameter 'public_gdpr_delete_input' is set
-          if @api_client.config.client_side_validation && public_gdpr_delete_input.nil?
-            fail ArgumentError, "Missing the required parameter 'public_gdpr_delete_input' when calling GDPRApi.purge"
+          # verify the required parameter 'batched_behavioral_event_http_completion_request' is set
+          if @api_client.config.client_side_validation && batched_behavioral_event_http_completion_request.nil?
+            fail ArgumentError, "Missing the required parameter 'batched_behavioral_event_http_completion_request' when calling BatchApi.call_send"
           end
           # resource path
-          local_var_path = '/crm/v3/objects/contacts/gdpr-delete'
+          local_var_path = '/events/v3/send/batch'
 
           # query parameters
           query_params = opts[:query_params] || {}
@@ -64,7 +64,7 @@ module Hubspot
           form_params = opts[:form_params] || {}
 
           # http body (model)
-          post_body = opts[:debug_body] || @api_client.object_to_http_body(public_gdpr_delete_input)
+          post_body = opts[:debug_body] || @api_client.object_to_http_body(batched_behavioral_event_http_completion_request)
 
           # return_type
           return_type = opts[:debug_return_type]
@@ -73,7 +73,7 @@ module Hubspot
           auth_names = opts[:debug_auth_names] || ['oauth2']
 
           new_options = opts.merge(
-            :operation => :"GDPRApi.purge",
+            :operation => :"BatchApi.call_send",
             :header_params => header_params,
             :query_params => query_params,
             :form_params => form_params,
@@ -84,7 +84,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: GDPRApi#purge\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+            @api_client.config.logger.debug "API called: BatchApi#call_send\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
           end
           return data, status_code, headers
         end

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

@@ -1,7 +1,7 @@
 =begin
 #Events Send Event Completions
 
-#HTTP API for triggering instances of custom behavioral events
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
 The version of the OpenAPI document: v3
 

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

@@ -1,7 +1,7 @@
 =begin
 #Events Send Event Completions
 
-#HTTP API for triggering instances of custom behavioral events
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
 The version of the OpenAPI document: v3
 

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

@@ -1,7 +1,7 @@
 =begin
 #Events Send Event Completions
 
-#HTTP API for triggering instances of custom behavioral events
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
 The version of the OpenAPI document: v3
 

data/lib/hubspot/codegen/events/send/models/batched_behavioral_event_http_completion_request.rb

@@ -0,0 +1,230 @@
+=begin
+#Events Send Event Completions
+
+#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 Events
+    module Send
+      class BatchedBehavioralEventHttpCompletionRequest
+        attr_accessor :inputs
+
+        # Attribute mapping from ruby-style variable name to JSON key.
+        def self.attribute_map
+          {
+            :'inputs' => :'inputs'
+          }
+        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
+          {
+            :'inputs' => :'Array<BehavioralEventHttpCompletionRequest>'
+          }
+        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::Events::Send::BatchedBehavioralEventHttpCompletionRequest` 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::Events::Send::BatchedBehavioralEventHttpCompletionRequest`. 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?(:'inputs')
+            if (value = attributes[:'inputs']).is_a?(Array)
+              self.inputs = value
+            end
+          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 @inputs.nil?
+            invalid_properties.push('invalid value for "inputs", inputs 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 @inputs.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 &&
+              inputs == o.inputs
+        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
+          [inputs].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::Events::Send.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

data/lib/hubspot/codegen/events/send/models/behavioral_event_http_completion_request.rb

@@ -1,7 +1,7 @@
 =begin
 #Events Send Event Completions
 
-#HTTP API for triggering instances of custom behavioral events
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
 The version of the OpenAPI document: v3
 
@@ -17,24 +17,25 @@ module Hubspot
   module Events
     module Send
       class BehavioralEventHttpCompletionRequest
-        # The time when this event occurred (if any). If this isn't set, the current time will be used
+        # The time when this event occurred. If this isn't set, the current time will be used.
         attr_accessor :occurred_at
 
-        # Internal name of the event-type to trigger
+        # The internal name of the event (`pe<portalID>_eventName`). Can be retrieved through the [event definitions API](https://developers.hubspot.com/docs/reference/api/analytics-and-events/custom-events/custom-event-definitions#get-%2Fevents%2Fv3%2Fevent-definitions) or in [HubSpot's UI](https://knowledge.hubspot.com/reports/create-custom-behavioral-events-with-the-code-wizard#find-internal-name). 
         attr_accessor :event_name
 
-        # User token
+        # The visitor's usertoken. Used for associating the event data with a CRM record.
         attr_accessor :utk
 
+        # Include a universally unique identifier to assign a unique ID to the event completion. Can be useful for matching data between HubSpot and other external systems.
         attr_accessor :uuid
 
-        # Email of visitor
+        # The visitor's email address. Used for associating the event data with a CRM record.
         attr_accessor :email
 
-        # Map of properties for the event in the format property internal name - property value
+        # The event properties to update. Takes the format of key-value pairs (property internal name and property value). Learn more about [HubSpot's default event properties](https://developers.hubspot.com/docs/guides/api/analytics-and-events/custom-events/custom-event-definitions#hubspot-s-default-event-properties).
         attr_accessor :properties
 
-        # The object id that this event occurred on. Could be a contact id or a visitor id.
+        # The ID of the object that completed the event (e.g., contact ID or visitor ID).
         attr_accessor :object_id
 
         # Attribute mapping from ruby-style variable name to JSON key.

data/lib/hubspot/codegen/events/send/models/error.rb

@@ -1,7 +1,7 @@
 =begin
 #Events Send Event Completions
 
-#HTTP API for triggering instances of custom behavioral events
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
 The version of the OpenAPI document: v3
 

data/lib/hubspot/codegen/events/send/models/error_detail.rb

@@ -1,7 +1,7 @@
 =begin
 #Events Send Event Completions
 
-#HTTP API for triggering instances of custom behavioral events
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
 The version of the OpenAPI document: v3