hubspot-api-client 17.2.0 → 18.0.0

data/lib/hubspot/codegen/crm/timeline/models/timeline_event_response.rb

@@ -1,5 +1,5 @@
 =begin
-#Timeline events
+#CRM Timeline
 
 #This feature allows an app to create and configure custom events that can show up in the timelines of certain CRM objects like contacts, companies, tickets, or deals. You'll find multiple use cases for this API in the sections below.
 
@@ -17,55 +17,55 @@ module Hubspot
   module Crm
     module Timeline
       class TimelineEventResponse
-        # Identifier for the event. This should be unique to the app and event template. If you use the same ID for different CRM objects, the last to be processed will win and the first will not have a record. You can also use `{{uuid}}` anywhere in the ID to generate a unique string, guaranteeing uniqueness.
-        attr_accessor :id
-
         # The event template ID.
         attr_accessor :event_template_id
 
-        # The email address used for contact-specific events. This can be used to identify existing contacts, create new ones, or change the email for an existing contact (if paired with the `objectId`).
-        attr_accessor :email
+        attr_accessor :created_at
 
-        # The CRM object identifier. This is required for every event other than contacts (where utk or email can be used).
-        attr_accessor :object_id
+        # Additional event-specific data that can be interpreted by the template's markdown.
+        attr_accessor :extra_data
 
-        # Use the `utk` parameter to associate an event with a contact by `usertoken`. This is recommended if you don't know a user's email, but have an identifying user token in your cookie.
-        attr_accessor :utk
+        attr_accessor :timeline_i_frame
 
         # The event domain (often paired with utk).
         attr_accessor :domain
 
-        # The time the event occurred. If not passed in, the curren time will be assumed. This is used to determine where an event is shown on a CRM object's timeline.
-        attr_accessor :timestamp
-
         # A collection of token keys and values associated with the template tokens.
         attr_accessor :tokens
 
-        # Additional event-specific data that can be interpreted by the template's markdown.
-        attr_accessor :extra_data
+        # Identifier for the event. This should be unique to the app and event template. If you use the same ID for different CRM objects, the last to be processed will win and the first will not have a record. You can also use `{{uuid}}` anywhere in the ID to generate a unique string, guaranteeing uniqueness.
+        attr_accessor :id
 
-        attr_accessor :timeline_i_frame
+        # Use the `utk` parameter to associate an event with a contact by `usertoken`. This is recommended if you don't know a user's email, but have an identifying user token in your cookie.
+        attr_accessor :utk
+
+        # The email address used for contact-specific events. This can be used to identify existing contacts, create new ones, or change the email for an existing contact (if paired with the `objectId`).
+        attr_accessor :email
+
+        # The CRM object identifier. This is required for every event other than contacts (where utk or email can be used).
+        attr_accessor :object_id
+
+        # The time the event occurred. If not passed in, the curren time will be assumed. This is used to determine where an event is shown on a CRM object's timeline.
+        attr_accessor :timestamp
 
         # The ObjectType associated with the EventTemplate.
         attr_accessor :object_type
 
-        attr_accessor :created_at
-
         # Attribute mapping from ruby-style variable name to JSON key.
         def self.attribute_map
           {
-            :'id' => :'id',
             :'event_template_id' => :'eventTemplateId',
+            :'created_at' => :'createdAt',
+            :'extra_data' => :'extraData',
+            :'timeline_i_frame' => :'timelineIFrame',
+            :'domain' => :'domain',
+            :'tokens' => :'tokens',
+            :'id' => :'id',
+            :'utk' => :'utk',
             :'email' => :'email',
             :'object_id' => :'objectId',
-            :'utk' => :'utk',
-            :'domain' => :'domain',
             :'timestamp' => :'timestamp',
-            :'tokens' => :'tokens',
-            :'extra_data' => :'extraData',
-            :'timeline_i_frame' => :'timelineIFrame',
-            :'object_type' => :'objectType',
-            :'created_at' => :'createdAt'
+            :'object_type' => :'objectType'
           }
         end
 
@@ -77,18 +77,18 @@ module Hubspot
         # Attribute type mapping.
         def self.openapi_types
           {
-            :'id' => :'String',
             :'event_template_id' => :'String',
+            :'created_at' => :'Time',
+            :'extra_data' => :'Object',
+            :'timeline_i_frame' => :'TimelineEventIFrame',
+            :'domain' => :'String',
+            :'tokens' => :'Hash<String, String>',
+            :'id' => :'String',
+            :'utk' => :'String',
             :'email' => :'String',
             :'object_id' => :'String',
-            :'utk' => :'String',
-            :'domain' => :'String',
             :'timestamp' => :'Time',
-            :'tokens' => :'Hash<String, String>',
-            :'extra_data' => :'Object',
-            :'timeline_i_frame' => :'TimelineEventIFrame',
-            :'object_type' => :'String',
-            :'created_at' => :'Time'
+            :'object_type' => :'String'
           }
         end
 
@@ -113,54 +113,54 @@ module Hubspot
             h[k.to_sym] = v
           }
 
-          if attributes.key?(:'id')
-            self.id = attributes[:'id']
-          end
-
           if attributes.key?(:'event_template_id')
             self.event_template_id = attributes[:'event_template_id']
           end
 
-          if attributes.key?(:'email')
-            self.email = attributes[:'email']
+          if attributes.key?(:'created_at')
+            self.created_at = attributes[:'created_at']
           end
 
-          if attributes.key?(:'object_id')
-            self.object_id = attributes[:'object_id']
+          if attributes.key?(:'extra_data')
+            self.extra_data = attributes[:'extra_data']
           end
 
-          if attributes.key?(:'utk')
-            self.utk = attributes[:'utk']
+          if attributes.key?(:'timeline_i_frame')
+            self.timeline_i_frame = attributes[:'timeline_i_frame']
           end
 
           if attributes.key?(:'domain')
             self.domain = attributes[:'domain']
           end
 
-          if attributes.key?(:'timestamp')
-            self.timestamp = attributes[:'timestamp']
-          end
-
           if attributes.key?(:'tokens')
             if (value = attributes[:'tokens']).is_a?(Hash)
               self.tokens = value
             end
           end
 
-          if attributes.key?(:'extra_data')
-            self.extra_data = attributes[:'extra_data']
+          if attributes.key?(:'id')
+            self.id = attributes[:'id']
           end
 
-          if attributes.key?(:'timeline_i_frame')
-            self.timeline_i_frame = attributes[:'timeline_i_frame']
+          if attributes.key?(:'utk')
+            self.utk = attributes[:'utk']
           end
 
-          if attributes.key?(:'object_type')
-            self.object_type = attributes[:'object_type']
+          if attributes.key?(:'email')
+            self.email = attributes[:'email']
           end
 
-          if attributes.key?(:'created_at')
-            self.created_at = attributes[:'created_at']
+          if attributes.key?(:'object_id')
+            self.object_id = attributes[:'object_id']
+          end
+
+          if attributes.key?(:'timestamp')
+            self.timestamp = attributes[:'timestamp']
+          end
+
+          if attributes.key?(:'object_type')
+            self.object_type = attributes[:'object_type']
           end
         end
 
@@ -168,10 +168,6 @@ module Hubspot
         # @return Array for valid properties with the reasons
         def list_invalid_properties
           invalid_properties = Array.new
-          if @id.nil?
-            invalid_properties.push('invalid value for "id", id cannot be nil.')
-          end
-
           if @event_template_id.nil?
             invalid_properties.push('invalid value for "event_template_id", event_template_id cannot be nil.')
           end
@@ -180,6 +176,10 @@ module Hubspot
             invalid_properties.push('invalid value for "tokens", tokens cannot be nil.')
           end
 
+          if @id.nil?
+            invalid_properties.push('invalid value for "id", id cannot be nil.')
+          end
+
           if @object_type.nil?
             invalid_properties.push('invalid value for "object_type", object_type cannot be nil.')
           end
@@ -190,9 +190,9 @@ module Hubspot
         # 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 @id.nil?
           return false if @event_template_id.nil?
           return false if @tokens.nil?
+          return false if @id.nil?
           return false if @object_type.nil?
           true
         end
@@ -202,18 +202,18 @@ module Hubspot
         def ==(o)
           return true if self.equal?(o)
           self.class == o.class &&
-              id == o.id &&
               event_template_id == o.event_template_id &&
+              created_at == o.created_at &&
+              extra_data == o.extra_data &&
+              timeline_i_frame == o.timeline_i_frame &&
+              domain == o.domain &&
+              tokens == o.tokens &&
+              id == o.id &&
+              utk == o.utk &&
               email == o.email &&
               object_id == o.object_id &&
-              utk == o.utk &&
-              domain == o.domain &&
               timestamp == o.timestamp &&
-              tokens == o.tokens &&
-              extra_data == o.extra_data &&
-              timeline_i_frame == o.timeline_i_frame &&
-              object_type == o.object_type &&
-              created_at == o.created_at
+              object_type == o.object_type
         end
 
         # @see the `==` method
@@ -225,7 +225,7 @@ module Hubspot
         # Calculates hash code according to all attributes.
         # @return [Integer] Hash code
         def hash
-          [id, event_template_id, email, object_id, utk, domain, timestamp, tokens, extra_data, timeline_i_frame, object_type, created_at].hash
+          [event_template_id, created_at, extra_data, timeline_i_frame, domain, tokens, id, utk, email, object_id, timestamp, object_type].hash
         end
 
         # Builds the object from hash

data/lib/hubspot/codegen/crm/timeline/models/timeline_event_template.rb

@@ -1,5 +1,5 @@
 =begin
-#Timeline events
+#CRM Timeline
 
 #This feature allows an app to create and configure custom events that can show up in the timelines of certain CRM objects like contacts, companies, tickets, or deals. You'll find multiple use cases for this API in the sections below.
 
@@ -17,40 +17,40 @@ module Hubspot
   module Crm
     module Timeline
       class TimelineEventTemplate
-        # The template name.
-        attr_accessor :name
-
-        # This uses Markdown syntax with Handlebars and event-specific data to render HTML on a timeline as a header.
-        attr_accessor :header_template
+        # The date and time that the Event Template was created, as an ISO 8601 timestamp. Will be null if the template was created before Feb 18th, 2020.
+        attr_accessor :created_at
 
         # This uses Markdown syntax with Handlebars and event-specific data to render HTML on a timeline when you expand the details.
         attr_accessor :detail_template
 
+        # The template name.
+        attr_accessor :name
+
         # A collection of tokens that can be used as custom properties on the event and to create fully fledged CRM objects.
         attr_accessor :tokens
 
         # The template ID.
         attr_accessor :id
 
+        # This uses Markdown syntax with Handlebars and event-specific data to render HTML on a timeline as a header.
+        attr_accessor :header_template
+
         # The type of CRM object this template is for. [Contacts, companies, tickets, and deals] are supported.
         attr_accessor :object_type
 
-        # The date and time that the Event Template was created, as an ISO 8601 timestamp. Will be null if the template was created before Feb 18th, 2020.
-        attr_accessor :created_at
-
         # The date and time that the Event Template was last updated, as an ISO 8601 timestamp. Will be null if the template was created before Feb 18th, 2020.
         attr_accessor :updated_at
 
         # Attribute mapping from ruby-style variable name to JSON key.
         def self.attribute_map
           {
-            :'name' => :'name',
-            :'header_template' => :'headerTemplate',
+            :'created_at' => :'createdAt',
             :'detail_template' => :'detailTemplate',
+            :'name' => :'name',
             :'tokens' => :'tokens',
             :'id' => :'id',
+            :'header_template' => :'headerTemplate',
             :'object_type' => :'objectType',
-            :'created_at' => :'createdAt',
             :'updated_at' => :'updatedAt'
           }
         end
@@ -63,13 +63,13 @@ module Hubspot
         # Attribute type mapping.
         def self.openapi_types
           {
-            :'name' => :'String',
-            :'header_template' => :'String',
+            :'created_at' => :'Time',
             :'detail_template' => :'String',
+            :'name' => :'String',
             :'tokens' => :'Array<TimelineEventTemplateToken>',
             :'id' => :'String',
+            :'header_template' => :'String',
             :'object_type' => :'String',
-            :'created_at' => :'Time',
             :'updated_at' => :'Time'
           }
         end
@@ -95,18 +95,18 @@ module Hubspot
             h[k.to_sym] = v
           }
 
-          if attributes.key?(:'name')
-            self.name = attributes[:'name']
-          end
-
-          if attributes.key?(:'header_template')
-            self.header_template = attributes[:'header_template']
+          if attributes.key?(:'created_at')
+            self.created_at = attributes[:'created_at']
           end
 
           if attributes.key?(:'detail_template')
             self.detail_template = attributes[:'detail_template']
           end
 
+          if attributes.key?(:'name')
+            self.name = attributes[:'name']
+          end
+
           if attributes.key?(:'tokens')
             if (value = attributes[:'tokens']).is_a?(Array)
               self.tokens = value
@@ -117,12 +117,12 @@ module Hubspot
             self.id = attributes[:'id']
           end
 
-          if attributes.key?(:'object_type')
-            self.object_type = attributes[:'object_type']
+          if attributes.key?(:'header_template')
+            self.header_template = attributes[:'header_template']
           end
 
-          if attributes.key?(:'created_at')
-            self.created_at = attributes[:'created_at']
+          if attributes.key?(:'object_type')
+            self.object_type = attributes[:'object_type']
           end
 
           if attributes.key?(:'updated_at')
@@ -168,13 +168,13 @@ module Hubspot
         def ==(o)
           return true if self.equal?(o)
           self.class == o.class &&
-              name == o.name &&
-              header_template == o.header_template &&
+              created_at == o.created_at &&
               detail_template == o.detail_template &&
+              name == o.name &&
               tokens == o.tokens &&
               id == o.id &&
+              header_template == o.header_template &&
               object_type == o.object_type &&
-              created_at == o.created_at &&
               updated_at == o.updated_at
         end
 
@@ -187,7 +187,7 @@ module Hubspot
         # Calculates hash code according to all attributes.
         # @return [Integer] Hash code
         def hash
-          [name, header_template, detail_template, tokens, id, object_type, created_at, updated_at].hash
+          [created_at, detail_template, name, tokens, id, header_template, object_type, updated_at].hash
         end
 
         # Builds the object from hash

data/lib/hubspot/codegen/crm/timeline/models/timeline_event_template_create_request.rb

@@ -1,5 +1,5 @@
 =begin
-#Timeline events
+#CRM Timeline
 
 #This feature allows an app to create and configure custom events that can show up in the timelines of certain CRM objects like contacts, companies, tickets, or deals. You'll find multiple use cases for this API in the sections below.
 
@@ -17,28 +17,28 @@ module Hubspot
   module Crm
     module Timeline
       class TimelineEventTemplateCreateRequest
-        # The template name.
-        attr_accessor :name
-
-        # This uses Markdown syntax with Handlebars and event-specific data to render HTML on a timeline as a header.
-        attr_accessor :header_template
-
         # This uses Markdown syntax with Handlebars and event-specific data to render HTML on a timeline when you expand the details.
         attr_accessor :detail_template
 
+        # The template name.
+        attr_accessor :name
+
         # A collection of tokens that can be used as custom properties on the event and to create fully fledged CRM objects.
         attr_accessor :tokens
 
+        # This uses Markdown syntax with Handlebars and event-specific data to render HTML on a timeline as a header.
+        attr_accessor :header_template
+
         # The type of CRM object this template is for. [Contacts, companies, tickets, and deals] are supported.
         attr_accessor :object_type
 
         # Attribute mapping from ruby-style variable name to JSON key.
         def self.attribute_map
           {
-            :'name' => :'name',
-            :'header_template' => :'headerTemplate',
             :'detail_template' => :'detailTemplate',
+            :'name' => :'name',
             :'tokens' => :'tokens',
+            :'header_template' => :'headerTemplate',
             :'object_type' => :'objectType'
           }
         end
@@ -51,10 +51,10 @@ module Hubspot
         # Attribute type mapping.
         def self.openapi_types
           {
-            :'name' => :'String',
-            :'header_template' => :'String',
             :'detail_template' => :'String',
+            :'name' => :'String',
             :'tokens' => :'Array<TimelineEventTemplateToken>',
+            :'header_template' => :'String',
             :'object_type' => :'String'
           }
         end
@@ -80,24 +80,24 @@ module Hubspot
             h[k.to_sym] = v
           }
 
-          if attributes.key?(:'name')
-            self.name = attributes[:'name']
-          end
-
-          if attributes.key?(:'header_template')
-            self.header_template = attributes[:'header_template']
-          end
-
           if attributes.key?(:'detail_template')
             self.detail_template = attributes[:'detail_template']
           end
 
+          if attributes.key?(:'name')
+            self.name = attributes[:'name']
+          end
+
           if attributes.key?(:'tokens')
             if (value = attributes[:'tokens']).is_a?(Array)
               self.tokens = value
             end
           end
 
+          if attributes.key?(:'header_template')
+            self.header_template = attributes[:'header_template']
+          end
+
           if attributes.key?(:'object_type')
             self.object_type = attributes[:'object_type']
           end
@@ -136,10 +136,10 @@ module Hubspot
         def ==(o)
           return true if self.equal?(o)
           self.class == o.class &&
-              name == o.name &&
-              header_template == o.header_template &&
               detail_template == o.detail_template &&
+              name == o.name &&
               tokens == o.tokens &&
+              header_template == o.header_template &&
               object_type == o.object_type
         end
 
@@ -152,7 +152,7 @@ module Hubspot
         # Calculates hash code according to all attributes.
         # @return [Integer] Hash code
         def hash
-          [name, header_template, detail_template, tokens, object_type].hash
+          [detail_template, name, tokens, header_template, object_type].hash
         end
 
         # Builds the object from hash

data/lib/hubspot/codegen/crm/timeline/models/timeline_event_template_token.rb

@@ -1,5 +1,5 @@
 =begin
-#Timeline events
+#CRM Timeline
 
 #This feature allows an app to create and configure custom events that can show up in the timelines of certain CRM objects like contacts, companies, tickets, or deals. You'll find multiple use cases for this API in the sections below.
 
@@ -17,11 +17,8 @@ module Hubspot
   module Crm
     module Timeline
       class TimelineEventTemplateToken
-        # Used for list segmentation and reporting.
-        attr_accessor :label
-
-        # The name of the CRM object property. This will populate the CRM object property associated with the event. With enough of these, you can fully build CRM objects via the Timeline API.
-        attr_accessor :object_property_name
+        # The date and time that the Event Template Token was created, as an ISO 8601 timestamp. Will be null if the template was created before Feb 18th, 2020.
+        attr_accessor :created_at
 
         # If type is `enumeration`, we should have a list of options to choose from.
         attr_accessor :options
@@ -29,12 +26,15 @@ module Hubspot
         # The name of the token referenced in the templates. This must be unique for the specific template. It may only contain alphanumeric characters, periods, dashes, or underscores (. - _).
         attr_accessor :name
 
+        # Used for list segmentation and reporting.
+        attr_accessor :label
+
+        # The name of the CRM object property. This will populate the CRM object property associated with the event. With enough of these, you can fully build CRM objects via the Timeline API.
+        attr_accessor :object_property_name
+
         # The data type of the token. You can currently choose from [string, number, date, enumeration].
         attr_accessor :type
 
-        # The date and time that the Event Template Token was created, as an ISO 8601 timestamp. Will be null if the template was created before Feb 18th, 2020.
-        attr_accessor :created_at
-
         # The date and time that the Event Template Token was last updated, as an ISO 8601 timestamp. Will be null if the template was created before Feb 18th, 2020.
         attr_accessor :updated_at
 
@@ -63,12 +63,12 @@ module Hubspot
         # Attribute mapping from ruby-style variable name to JSON key.
         def self.attribute_map
           {
-            :'label' => :'label',
-            :'object_property_name' => :'objectPropertyName',
+            :'created_at' => :'createdAt',
             :'options' => :'options',
             :'name' => :'name',
+            :'label' => :'label',
+            :'object_property_name' => :'objectPropertyName',
             :'type' => :'type',
-            :'created_at' => :'createdAt',
             :'updated_at' => :'updatedAt'
           }
         end
@@ -81,12 +81,12 @@ module Hubspot
         # Attribute type mapping.
         def self.openapi_types
           {
-            :'label' => :'String',
-            :'object_property_name' => :'String',
+            :'created_at' => :'Time',
             :'options' => :'Array<TimelineEventTemplateTokenOption>',
             :'name' => :'String',
+            :'label' => :'String',
+            :'object_property_name' => :'String',
             :'type' => :'String',
-            :'created_at' => :'Time',
             :'updated_at' => :'Time'
           }
         end
@@ -112,12 +112,8 @@ module Hubspot
             h[k.to_sym] = v
           }
 
-          if attributes.key?(:'label')
-            self.label = attributes[:'label']
-          end
-
-          if attributes.key?(:'object_property_name')
-            self.object_property_name = attributes[:'object_property_name']
+          if attributes.key?(:'created_at')
+            self.created_at = attributes[:'created_at']
           end
 
           if attributes.key?(:'options')
@@ -130,12 +126,16 @@ module Hubspot
             self.name = attributes[:'name']
           end
 
-          if attributes.key?(:'type')
-            self.type = attributes[:'type']
+          if attributes.key?(:'label')
+            self.label = attributes[:'label']
           end
 
-          if attributes.key?(:'created_at')
-            self.created_at = attributes[:'created_at']
+          if attributes.key?(:'object_property_name')
+            self.object_property_name = attributes[:'object_property_name']
+          end
+
+          if attributes.key?(:'type')
+            self.type = attributes[:'type']
           end
 
           if attributes.key?(:'updated_at')
@@ -147,18 +147,14 @@ module Hubspot
         # @return Array for valid properties with the reasons
         def list_invalid_properties
           invalid_properties = Array.new
-          if @label.nil?
-            invalid_properties.push('invalid value for "label", label cannot be nil.')
-          end
-
-          if @options.nil?
-            invalid_properties.push('invalid value for "options", options cannot be nil.')
-          end
-
           if @name.nil?
             invalid_properties.push('invalid value for "name", name cannot be nil.')
           end
 
+          if @label.nil?
+            invalid_properties.push('invalid value for "label", label cannot be nil.')
+          end
+
           if @type.nil?
             invalid_properties.push('invalid value for "type", type cannot be nil.')
           end
@@ -169,9 +165,8 @@ module Hubspot
         # 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 @label.nil?
-          return false if @options.nil?
           return false if @name.nil?
+          return false if @label.nil?
           return false if @type.nil?
           type_validator = EnumAttributeValidator.new('String', ["date", "enumeration", "number", "string"])
           return false unless type_validator.valid?(@type)
@@ -193,12 +188,12 @@ module Hubspot
         def ==(o)
           return true if self.equal?(o)
           self.class == o.class &&
-              label == o.label &&
-              object_property_name == o.object_property_name &&
+              created_at == o.created_at &&
               options == o.options &&
               name == o.name &&
+              label == o.label &&
+              object_property_name == o.object_property_name &&
               type == o.type &&
-              created_at == o.created_at &&
               updated_at == o.updated_at
         end
 
@@ -211,7 +206,7 @@ module Hubspot
         # Calculates hash code according to all attributes.
         # @return [Integer] Hash code
         def hash
-          [label, object_property_name, options, name, type, created_at, updated_at].hash
+          [created_at, options, name, label, object_property_name, type, updated_at].hash
         end
 
         # Builds the object from hash