hubspot-api-client 16.2.0 → 16.2.1

data/lib/hubspot/codegen/crm/extensions/cards/models/card_list_response.rb

@@ -17,6 +17,7 @@ module Hubspot
   module Crm
     module Extensions
       module Cards
+        # List of card definitions
         class CardListResponse
           # List of card definitions
           attr_accessor :results

data/lib/hubspot/codegen/crm/extensions/cards/models/card_patch_request.rb

@@ -17,6 +17,7 @@ module Hubspot
   module Crm
     module Extensions
       module Cards
+        # Body for a patch with optional fields
         class CardPatchRequest
           # The top-level title for this card. Displayed to users in the CRM UI.
           attr_accessor :title

data/lib/hubspot/codegen/crm/extensions/cards/models/card_response.rb

@@ -17,6 +17,7 @@ module Hubspot
   module Crm
     module Extensions
       module Cards
+        # Current state of Card Definition
         class CardResponse
           # Generated unique ID for card.
           attr_accessor :id

data/lib/hubspot/codegen/crm/extensions/cards/models/display_option.rb

@@ -17,6 +17,7 @@ module Hubspot
   module Crm
     module Extensions
       module Cards
+        # Option definition for STATUS dataTypes.
         class DisplayOption
           # JSON-friendly unique name for option.
           attr_accessor :name

data/lib/hubspot/codegen/crm/extensions/cards/models/integrator_card_payload_response.rb

@@ -17,6 +17,7 @@ module Hubspot
   module Crm
     module Extensions
       module Cards
+        # The card details payload, sent to HubSpot by an app in response to a data fetch request when a user visits a CRM record page.
         class IntegratorCardPayloadResponse
           # The total number of card properties that will be sent in this response.
           attr_accessor :total_count

data/lib/hubspot/codegen/crm/extensions/cards/models/integrator_object_result_actions_inner.rb

@@ -17,6 +17,7 @@ module Hubspot
   module Crm
     module Extensions
       module Cards
+        module IntegratorObjectResultActionsInner
           class << self
             # List of class defined in oneOf (OpenAPI v3)
             def openapi_one_of

data/lib/hubspot/codegen/crm/extensions/videoconferencing/models/external_settings.rb

@@ -17,6 +17,7 @@ module Hubspot
   module Crm
     module Extensions
       module Videoconferencing
+        # The URLs of the various actions provided by the video conferencing application. All URLs must use the `https` protocol.
         class ExternalSettings
           # The URL that HubSpot will send requests to create a new video conference.
           attr_accessor :create_meeting_url

data/lib/hubspot/codegen/files/files/models/collection_response_file.rb

@@ -16,6 +16,7 @@ require 'time'
 module Hubspot
   module Files
     module Files
+      # Collections of files
       class CollectionResponseFile
         attr_accessor :results
 

data/lib/hubspot/codegen/files/files/models/file_update_input.rb

@@ -16,6 +16,7 @@ require 'time'
 module Hubspot
   module Files
     module Files
+      # Object for updating files.
       class FileUpdateInput
         # New name for the file.
         attr_accessor :name

data/lib/hubspot/codegen/files/files/models/folder_input.rb

@@ -16,6 +16,7 @@ require 'time'
 module Hubspot
   module Files
     module Files
+      # Object for creating a folder.
       class FolderInput
         # Desired name for the folder.
         attr_accessor :name

data/lib/hubspot/codegen/files/files/models/folder_update_input.rb

@@ -16,6 +16,7 @@ require 'time'
 module Hubspot
   module Files
     module Files
+      # Object for updating folders.
       class FolderUpdateInput
         # Id of the folder to change.
         attr_accessor :id

data/lib/hubspot/codegen/files/files/models/folder_update_task_locator.rb

@@ -16,6 +16,7 @@ require 'time'
 module Hubspot
   module Files
     module Files
+      # Information on the task that has been started, and where to check it's status.
       class FolderUpdateTaskLocator
         # The ID of the task
         attr_accessor :id

data/lib/hubspot/codegen/files/files/models/hubspot_file.rb

@@ -16,6 +16,7 @@ require 'time'
 module Hubspot
   module Files
     module Files
+      # File
       class HubspotFile
         # File ID.
         attr_accessor :id

data/lib/hubspot/codegen/files/files/models/import_from_url_task_locator.rb

@@ -16,6 +16,7 @@ require 'time'
 module Hubspot
   module Files
     module Files
+      # Information on the task that has been started, and where to check it's status.
       class ImportFromUrlTaskLocator
         # The ID of the task
         attr_accessor :id

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

@@ -441,66 +441,6 @@ module Hubspot
           return data, status_code, headers
         end
 
-        # @param q [String] 
-        # @param [Hash] opts the optional parameters
-        # @return [CollectionResponseMarketingEventExternalUniqueIdentifierNoPaging]
-        def do_search(q, opts = {})
-          data, _status_code, _headers = do_search_with_http_info(q, opts)
-          data
-        end
-
-        # @param q [String] 
-        # @param [Hash] opts the optional parameters
-        # @return [Array<(CollectionResponseMarketingEventExternalUniqueIdentifierNoPaging, Integer, Hash)>] CollectionResponseMarketingEventExternalUniqueIdentifierNoPaging data, response status code and response headers
-        def do_search_with_http_info(q, opts = {})
-          if @api_client.config.debugging
-            @api_client.config.logger.debug 'Calling API: MarketingEventsExternalApi.do_search ...'
-          end
-          # verify the required parameter 'q' is set
-          if @api_client.config.client_side_validation && q.nil?
-            fail ArgumentError, "Missing the required parameter 'q' when calling MarketingEventsExternalApi.do_search"
-          end
-          # resource path
-          local_var_path = '/marketing/v3/marketing-events/events/search'
-
-          # query parameters
-          query_params = opts[:query_params] || {}
-          query_params[:'q'] = q
-
-          # header parameters
-          header_params = opts[:header_params] || {}
-          # HTTP header 'Accept' (if needed)
-          header_params['Accept'] = @api_client.select_header_accept(['application/json', '*/*'])
-
-          # form parameters
-          form_params = opts[:form_params] || {}
-
-          # http body (model)
-          post_body = opts[:debug_body]
-
-          # return_type
-          return_type = opts[:debug_return_type] || 'CollectionResponseMarketingEventExternalUniqueIdentifierNoPaging'
-
-          # auth_names
-          auth_names = opts[:debug_auth_names] || ['oauth2']
-
-          new_options = opts.merge(
-            :operation => :"MarketingEventsExternalApi.do_search",
-            :header_params => header_params,
-            :query_params => query_params,
-            :form_params => form_params,
-            :body => post_body,
-            :auth_names => auth_names,
-            :return_type => return_type
-          )
-
-          data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
-          if @api_client.config.debugging
-            @api_client.config.logger.debug "API called: MarketingEventsExternalApi#do_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-          end
-          return data, status_code, headers
-        end
-
         # @param batch_input_marketing_event_create_request_params [BatchInputMarketingEventCreateRequestParams] 
         # @param [Hash] opts the optional parameters
         # @return [BatchResponseMarketingEventPublicDefaultResponse]

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

@@ -0,0 +1,90 @@
+=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: 6.2.1
+
+=end
+
+require 'cgi'
+
+module Hubspot
+  module Marketing
+    module Events
+      class SearchApi
+        attr_accessor :api_client
+
+        def initialize(api_client = ApiClient.default)
+          @api_client = api_client
+        end
+        # Search for marketing events
+        # Search for marketing events that have an event id that starts with the query string
+        # @param q [String] The id of the marketing event in the external event application
+        # @param [Hash] opts the optional parameters
+        # @return [CollectionResponseMarketingEventExternalUniqueIdentifierNoPaging]
+        def do_search(q, opts = {})
+          data, _status_code, _headers = do_search_with_http_info(q, opts)
+          data
+        end
+
+        # Search for marketing events
+        # Search for marketing events that have an event id that starts with the query string
+        # @param q [String] The id of the marketing event in the external event application
+        # @param [Hash] opts the optional parameters
+        # @return [Array<(CollectionResponseMarketingEventExternalUniqueIdentifierNoPaging, Integer, Hash)>] CollectionResponseMarketingEventExternalUniqueIdentifierNoPaging data, response status code and response headers
+        def do_search_with_http_info(q, opts = {})
+          if @api_client.config.debugging
+            @api_client.config.logger.debug 'Calling API: SearchApi.do_search ...'
+          end
+          # verify the required parameter 'q' is set
+          if @api_client.config.client_side_validation && q.nil?
+            fail ArgumentError, "Missing the required parameter 'q' when calling SearchApi.do_search"
+          end
+          # resource path
+          local_var_path = '/marketing/v3/marketing-events/events/search'
+
+          # query parameters
+          query_params = opts[:query_params] || {}
+          query_params[:'q'] = q
+
+          # header parameters
+          header_params = opts[:header_params] || {}
+          # HTTP header 'Accept' (if needed)
+          header_params['Accept'] = @api_client.select_header_accept(['application/json', '*/*'])
+
+          # form parameters
+          form_params = opts[:form_params] || {}
+
+          # http body (model)
+          post_body = opts[:debug_body]
+
+          # return_type
+          return_type = opts[:debug_return_type] || 'CollectionResponseMarketingEventExternalUniqueIdentifierNoPaging'
+
+          # auth_names
+          auth_names = opts[:debug_auth_names] || ['oauth2']
+
+          new_options = opts.merge(
+            :operation => :"SearchApi.do_search",
+            :header_params => header_params,
+            :query_params => query_params,
+            :form_params => form_params,
+            :body => post_body,
+            :auth_names => auth_names,
+            :return_type => return_type
+          )
+
+          data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+          if @api_client.config.debugging
+            @api_client.config.logger.debug "API called: SearchApi#do_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+          end
+          return data, status_code, headers
+        end
+      end
+    end
+  end
+end

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

@@ -16,6 +16,7 @@ require 'time'
 module Hubspot
   module Marketing
     module Events
+      # List of marketing event details to create or update
       class BatchInputMarketingEventEmailSubscriber
         # List of marketing event details to create or update
         attr_accessor :inputs

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

@@ -16,6 +16,7 @@ require 'time'
 module Hubspot
   module Marketing
     module Events
+      # List of HubSpot contacts to subscribe to the marketing event
       class BatchInputMarketingEventSubscriber
         # List of HubSpot contacts to subscribe to the marketing event
         attr_accessor :inputs

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

@@ -44,6 +44,8 @@ module Hubspot
 
         attr_accessor :persistence_timestamp
 
+        attr_accessor :use_timestamp_as_persistence_timestamp
+
         class EnumAttributeValidator
           attr_reader :datatype
           attr_reader :allowable_values
@@ -81,7 +83,8 @@ module Hubspot
             :'source_metadata' => :'sourceMetadata',
             :'request_id' => :'requestId',
             :'updated_by_user_id' => :'updatedByUserId',
-            :'persistence_timestamp' => :'persistenceTimestamp'
+            :'persistence_timestamp' => :'persistenceTimestamp',
+            :'use_timestamp_as_persistence_timestamp' => :'useTimestampAsPersistenceTimestamp'
           }
         end
 
@@ -105,7 +108,8 @@ module Hubspot
             :'source_metadata' => :'String',
             :'request_id' => :'String',
             :'updated_by_user_id' => :'Integer',
-            :'persistence_timestamp' => :'Integer'
+            :'persistence_timestamp' => :'Integer',
+            :'use_timestamp_as_persistence_timestamp' => :'Boolean'
           }
         end
 
@@ -183,6 +187,10 @@ module Hubspot
           if attributes.key?(:'persistence_timestamp')
             self.persistence_timestamp = attributes[:'persistence_timestamp']
           end
+
+          if attributes.key?(:'use_timestamp_as_persistence_timestamp')
+            self.use_timestamp_as_persistence_timestamp = attributes[:'use_timestamp_as_persistence_timestamp']
+          end
         end
 
         # Show invalid properties with the reasons. Usually used together with valid?
@@ -282,7 +290,8 @@ module Hubspot
               source_metadata == o.source_metadata &&
               request_id == o.request_id &&
               updated_by_user_id == o.updated_by_user_id &&
-              persistence_timestamp == o.persistence_timestamp
+              persistence_timestamp == o.persistence_timestamp &&
+              use_timestamp_as_persistence_timestamp == o.use_timestamp_as_persistence_timestamp
         end
 
         # @see the `==` method
@@ -294,7 +303,7 @@ module Hubspot
         # Calculates hash code according to all attributes.
         # @return [Integer] Hash code
         def hash
-          [name, value, timestamp, source_id, source_label, source, selected_by_user, selected_by_user_timestamp, source_vid, source_metadata, request_id, updated_by_user_id, persistence_timestamp].hash
+          [name, value, timestamp, source_id, source_label, source, selected_by_user, selected_by_user_timestamp, source_vid, source_metadata, request_id, updated_by_user_id, persistence_timestamp, use_timestamp_as_persistence_timestamp].hash
         end
 
         # Builds the object from hash

data/lib/hubspot/codegen/marketing/forms/models/collection_response_form_definition_base_forward_paging_results_inner.rb

@@ -16,6 +16,7 @@ require 'time'
 module Hubspot
   module Marketing
     module Forms
+      module CollectionResponseFormDefinitionBaseForwardPagingResultsInner
         class << self
           # List of class defined in oneOf (OpenAPI v3)
           def openapi_one_of

data/lib/hubspot/codegen/marketing/forms/models/datepicker_field.rb

@@ -16,6 +16,7 @@ require 'time'
 module Hubspot
   module Marketing
     module Forms
+      # A form field used to select a date
       class DatepickerField
         # Determines how the field will be displayed and validated.
         attr_accessor :field_type

data/lib/hubspot/codegen/marketing/forms/models/dependent_field.rb

@@ -16,6 +16,7 @@ require 'time'
 module Hubspot
   module Marketing
     module Forms
+      # A form field that will be displayed based on what the customer entered in another field.
       class DependentField
         attr_accessor :dependent_condition
 

data/lib/hubspot/codegen/marketing/forms/models/dependent_field_dependent_field.rb

@@ -16,6 +16,7 @@ require 'time'
 module Hubspot
   module Marketing
     module Forms
+      module DependentFieldDependentField
         class << self
           # List of class defined in oneOf (OpenAPI v3)
           def openapi_one_of

data/lib/hubspot/codegen/marketing/forms/models/dependent_field_filter.rb

@@ -16,6 +16,7 @@ require 'time'
 module Hubspot
   module Marketing
     module Forms
+      # A condition based on customer input
       class DependentFieldFilter
         attr_accessor :operator
 

data/lib/hubspot/codegen/marketing/forms/models/dropdown_field.rb

@@ -16,6 +16,7 @@ require 'time'
 module Hubspot
   module Marketing
     module Forms
+      # A field consisting of a drop down with multiple choices.
       class DropdownField
         # Determines how the field will be displayed and validated.
         attr_accessor :field_type

data/lib/hubspot/codegen/marketing/forms/models/email_field.rb

@@ -16,6 +16,7 @@ require 'time'
 module Hubspot
   module Marketing
     module Forms
+      # A form field used for collecting an email address.
       class EmailField
         # Determines how the field will be displayed and validated.
         attr_accessor :field_type

data/lib/hubspot/codegen/marketing/forms/models/email_field_validation.rb

@@ -16,6 +16,7 @@ require 'time'
 module Hubspot
   module Marketing
     module Forms
+      # Describes how an email address should be validated.
       class EmailFieldValidation
         # A list of email domains to block.
         attr_accessor :blocked_email_domains

data/lib/hubspot/codegen/marketing/forms/models/field_group.rb

@@ -16,6 +16,7 @@ require 'time'
 module Hubspot
   module Marketing
     module Forms
+      # A collection of up to three form fields usually displayed in a row.
       class FieldGroup
         attr_accessor :group_type
 

data/lib/hubspot/codegen/marketing/forms/models/file_field.rb

@@ -16,6 +16,7 @@ require 'time'
 module Hubspot
   module Marketing
     module Forms
+      # A form field used for uploading one or more files.
       class FileField
         # Determines how the field will be displayed and validated.
         attr_accessor :field_type

data/lib/hubspot/codegen/marketing/forms/models/form_definition_base.rb

@@ -16,6 +16,7 @@ require 'time'
 module Hubspot
   module Marketing
     module Forms
+      module FormDefinitionBase
         class << self
           # List of class defined in oneOf (OpenAPI v3)
           def openapi_one_of

data/lib/hubspot/codegen/marketing/forms/models/form_definition_create_request_base.rb

@@ -16,6 +16,7 @@ require 'time'
 module Hubspot
   module Marketing
     module Forms
+      module FormDefinitionCreateRequestBase
         class << self
           # List of class defined in oneOf (OpenAPI v3)
           def openapi_one_of

data/lib/hubspot/codegen/marketing/forms/models/form_display_options.rb

@@ -16,6 +16,7 @@ require 'time'
 module Hubspot
   module Marketing
     module Forms
+      # Options for styling the form.
       class FormDisplayOptions
         # Whether the form will render as raw HTML as opposed to inside an iFrame.
         attr_accessor :render_raw_html

data/lib/hubspot/codegen/marketing/forms/models/form_post_submit_action.rb

@@ -16,6 +16,7 @@ require 'time'
 module Hubspot
   module Marketing
     module Forms
+      # What should happen after the customer submits the form.
       class FormPostSubmitAction
         # The action to take after submit. The default action is displaying a thank you message.
         attr_accessor :type

data/lib/hubspot/codegen/marketing/forms/models/form_style.rb

@@ -16,6 +16,7 @@ require 'time'
 module Hubspot
   module Marketing
     module Forms
+      # Styling options for the form
       class FormStyle
         attr_accessor :font_family
 

data/lib/hubspot/codegen/marketing/forms/models/hub_spot_form_definition_patch_request_legal_consent_options.rb

@@ -16,6 +16,7 @@ require 'time'
 module Hubspot
   module Marketing
     module Forms
+      module HubSpotFormDefinitionPatchRequestLegalConsentOptions
         class << self
           # List of class defined in oneOf (OpenAPI v3)
           def openapi_one_of

data/lib/hubspot/codegen/marketing/forms/models/mobile_phone_field.rb

@@ -16,6 +16,7 @@ require 'time'
 module Hubspot
   module Marketing
     module Forms
+      # A form field used for collecting a mobile phone number.
       class MobilePhoneField
         # Determines how the field will be displayed and validated.
         attr_accessor :field_type

data/lib/hubspot/codegen/marketing/forms/models/multi_line_text_field.rb

@@ -16,6 +16,7 @@ require 'time'
 module Hubspot
   module Marketing
     module Forms
+      # A form field consisting of a multiple-line text box.
       class MultiLineTextField
         # Determines how the field will be displayed and validated.
         attr_accessor :field_type

data/lib/hubspot/codegen/marketing/forms/models/multiple_checkboxes_field.rb

@@ -16,6 +16,7 @@ require 'time'
 module Hubspot
   module Marketing
     module Forms
+      # A form field consisting of a set of checkboxes allowing multiple choices to be selected at one time.
       class MultipleCheckboxesField
         # Determines how the field will be displayed and validated.
         attr_accessor :field_type

data/lib/hubspot/codegen/marketing/forms/models/number_field.rb

@@ -16,6 +16,7 @@ require 'time'
 module Hubspot
   module Marketing
     module Forms
+      # A form field used for collecting a numeric value.
       class NumberField
         # Determines how the field will be displayed and validated.
         attr_accessor :field_type

data/lib/hubspot/codegen/marketing/forms/models/number_field_validation.rb

@@ -16,6 +16,7 @@ require 'time'
 module Hubspot
   module Marketing
     module Forms
+      # Describes how a numeric value should be validated.
       class NumberFieldValidation
         attr_accessor :min_allowed_digits
 

data/lib/hubspot/codegen/marketing/forms/models/phone_field.rb

@@ -16,6 +16,7 @@ require 'time'
 module Hubspot
   module Marketing
     module Forms
+      # A form field used for collecting a phone number.
       class PhoneField
         # Determines how the field will be displayed and validated.
         attr_accessor :field_type

data/lib/hubspot/codegen/marketing/forms/models/phone_field_validation.rb

@@ -16,6 +16,7 @@ require 'time'
 module Hubspot
   module Marketing
     module Forms
+      # Describes how a phone number should be validated.
       class PhoneFieldValidation
         attr_accessor :min_allowed_digits
 

data/lib/hubspot/codegen/marketing/forms/models/radio_field.rb

@@ -16,6 +16,7 @@ require 'time'
 module Hubspot
   module Marketing
     module Forms
+      # A form field consisting of a set of radio options, out of which one can be selected at a time.
       class RadioField
         # Determines how the field will be displayed and validated.
         attr_accessor :field_type

data/lib/hubspot/codegen/marketing/forms/models/single_checkbox_field.rb

@@ -16,6 +16,7 @@ require 'time'
 module Hubspot
   module Marketing
     module Forms
+      # A form field consisting of a single checkbox.
       class SingleCheckboxField
         # Determines how the field will be displayed and validated.
         attr_accessor :field_type

data/lib/hubspot/codegen/marketing/forms/models/single_line_text_field.rb

@@ -16,6 +16,7 @@ require 'time'
 module Hubspot
   module Marketing
     module Forms
+      # A form field consisting of a single-line text box.
       class SingleLineTextField
         # Determines how the field will be displayed and validated.
         attr_accessor :field_type

data/lib/hubspot/codegen/marketing/transactional/models/email_send_status_view.rb

@@ -16,6 +16,7 @@ require 'time'
 module Hubspot
   module Marketing
     module Transactional
+      # Describes the status of an email send request.
       class EmailSendStatusView
         # Identifier used to query the status of the send.
         attr_accessor :status_id

data/lib/hubspot/codegen/marketing/transactional/models/event_id_view.rb

@@ -16,6 +16,7 @@ require 'time'
 module Hubspot
   module Marketing
     module Transactional
+      # The ID of a send event.
       class EventIdView
         # Time of event creation.
         attr_accessor :created

data/lib/hubspot/codegen/marketing/transactional/models/public_single_send_email.rb

@@ -16,6 +16,7 @@ require 'time'
 module Hubspot
   module Marketing
     module Transactional
+      # A JSON object containing anything you want to override.
       class PublicSingleSendEmail
         # The From header for the email.
         attr_accessor :from

data/lib/hubspot/codegen/marketing/transactional/models/public_single_send_request_egg.rb

@@ -16,6 +16,7 @@ require 'time'
 module Hubspot
   module Marketing
     module Transactional
+      # A request to send a single transactional email asynchronously.
       class PublicSingleSendRequestEgg
         # The content ID for the transactional email, which can be found in email tool UI.
         attr_accessor :email_id

data/lib/hubspot/codegen/marketing/transactional/models/smtp_api_token_request_egg.rb

@@ -16,6 +16,7 @@ require 'time'
 module Hubspot
   module Marketing
     module Transactional
+      # A request object to create a SMTP API token
       class SmtpApiTokenRequestEgg
         # Indicates whether a contact should be created for email recipients.
         attr_accessor :create_contact