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

data/lib/hubspot/codegen/crm/products/models/simple_public_object_with_associations.rb

@@ -29,6 +29,8 @@ module Hubspot
 
         attr_accessor :id
 
+        attr_accessor :object_write_trace_id
+
         attr_accessor :properties
 
         attr_accessor :updated_at
@@ -42,6 +44,7 @@ module Hubspot
             :'archived_at' => :'archivedAt',
             :'properties_with_history' => :'propertiesWithHistory',
             :'id' => :'id',
+            :'object_write_trace_id' => :'objectWriteTraceId',
             :'properties' => :'properties',
             :'updated_at' => :'updatedAt'
           }
@@ -61,6 +64,7 @@ module Hubspot
             :'archived_at' => :'Time',
             :'properties_with_history' => :'Hash<String, Array<ValueWithTimestamp>>',
             :'id' => :'String',
+            :'object_write_trace_id' => :'String',
             :'properties' => :'Hash<String, String>',
             :'updated_at' => :'Time'
           }
@@ -115,6 +119,10 @@ module Hubspot
             self.id = attributes[:'id']
           end
 
+          if attributes.key?(:'object_write_trace_id')
+            self.object_write_trace_id = attributes[:'object_write_trace_id']
+          end
+
           if attributes.key?(:'properties')
             if (value = attributes[:'properties']).is_a?(Hash)
               self.properties = value
@@ -170,6 +178,7 @@ module Hubspot
               archived_at == o.archived_at &&
               properties_with_history == o.properties_with_history &&
               id == o.id &&
+              object_write_trace_id == o.object_write_trace_id &&
               properties == o.properties &&
               updated_at == o.updated_at
         end
@@ -183,7 +192,7 @@ module Hubspot
         # Calculates hash code according to all attributes.
         # @return [Integer] Hash code
         def hash
-          [associations, created_at, archived, archived_at, properties_with_history, id, properties, updated_at].hash
+          [associations, created_at, archived, archived_at, properties_with_history, id, object_write_trace_id, properties, updated_at].hash
         end
 
         # Builds the object from hash

data/lib/hubspot/codegen/crm/products/models/simple_public_upsert_object.rb

@@ -29,6 +29,8 @@ module Hubspot
 
         attr_accessor :id
 
+        attr_accessor :object_write_trace_id
+
         attr_accessor :properties
 
         attr_accessor :updated_at
@@ -42,6 +44,7 @@ module Hubspot
             :'new' => :'new',
             :'properties_with_history' => :'propertiesWithHistory',
             :'id' => :'id',
+            :'object_write_trace_id' => :'objectWriteTraceId',
             :'properties' => :'properties',
             :'updated_at' => :'updatedAt'
           }
@@ -61,6 +64,7 @@ module Hubspot
             :'new' => :'Boolean',
             :'properties_with_history' => :'Hash<String, Array<ValueWithTimestamp>>',
             :'id' => :'String',
+            :'object_write_trace_id' => :'String',
             :'properties' => :'Hash<String, String>',
             :'updated_at' => :'Time'
           }
@@ -113,6 +117,10 @@ module Hubspot
             self.id = attributes[:'id']
           end
 
+          if attributes.key?(:'object_write_trace_id')
+            self.object_write_trace_id = attributes[:'object_write_trace_id']
+          end
+
           if attributes.key?(:'properties')
             if (value = attributes[:'properties']).is_a?(Hash)
               self.properties = value
@@ -173,6 +181,7 @@ module Hubspot
               new == o.new &&
               properties_with_history == o.properties_with_history &&
               id == o.id &&
+              object_write_trace_id == o.object_write_trace_id &&
               properties == o.properties &&
               updated_at == o.updated_at
         end
@@ -186,7 +195,7 @@ module Hubspot
         # Calculates hash code according to all attributes.
         # @return [Integer] Hash code
         def hash
-          [created_at, archived, archived_at, new, properties_with_history, id, properties, updated_at].hash
+          [created_at, archived, archived_at, new, properties_with_history, id, object_write_trace_id, properties, updated_at].hash
         end
 
         # Builds the object from hash

data/lib/hubspot/codegen/crm/tickets/api/basic_api.rb

@@ -16,6 +16,7 @@ module Hubspot
   module Crm
     module Tickets
       class BasicApi
+        require 'hubspot/helpers/get_all_helper'
         include Hubspot::Helpers::GetAllHelper
 
         attr_accessor :api_client
@@ -25,7 +26,7 @@ module Hubspot
         end
         # Archive
         # Move an Object identified by `{ticketId}` to the recycling bin.
-        # @param ticket_id [String] 
+        # @param ticket_id [String] The ID of the ticket to delete.
         # @param [Hash] opts the optional parameters
         # @return [nil]
         def archive(ticket_id, opts = {})
@@ -35,7 +36,7 @@ module Hubspot
 
         # Archive
         # Move an Object identified by `{ticketId}` to the recycling bin.
-        # @param ticket_id [String] 
+        # @param ticket_id [String] The ID of the ticket to delete.
         # @param [Hash] opts the optional parameters
         # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
         def archive_with_http_info(ticket_id, opts = {})
@@ -156,7 +157,7 @@ module Hubspot
 
         # Read
         # Read an Object identified by `{ticketId}`. `{ticketId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param.  Control what is returned via the `properties` query param.
-        # @param ticket_id [String] 
+        # @param ticket_id [String] The ID of the ticket.
         # @param [Hash] opts the optional parameters
         # @option opts [Array<String>] :properties A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
         # @option opts [Array<String>] :properties_with_history A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.
@@ -171,7 +172,7 @@ module Hubspot
 
         # Read
         # Read an Object identified by &#x60;{ticketId}&#x60;. &#x60;{ticketId}&#x60; refers to the internal object ID by default, or optionally any unique property value as specified by the &#x60;idProperty&#x60; query param.  Control what is returned via the &#x60;properties&#x60; query param.
-        # @param ticket_id [String] 
+        # @param ticket_id [String] The ID of the ticket.
         # @param [Hash] opts the optional parameters
         # @option opts [Array<String>] :properties A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
         # @option opts [Array<String>] :properties_with_history A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.
@@ -307,6 +308,74 @@ module Hubspot
           return data, status_code, headers
         end
 
+        # Merge two tickets
+        # Merge two tickets, combining them into one ticket record.
+        # @param public_merge_input [PublicMergeInput] 
+        # @param [Hash] opts the optional parameters
+        # @return [SimplePublicObject]
+        def merge(public_merge_input, opts = {})
+          data, _status_code, _headers = merge_with_http_info(public_merge_input, opts)
+          data
+        end
+
+        # Merge two tickets
+        # Merge two tickets, combining them into one ticket record.
+        # @param public_merge_input [PublicMergeInput] 
+        # @param [Hash] opts the optional parameters
+        # @return [Array<(SimplePublicObject, Integer, Hash)>] SimplePublicObject data, response status code and response headers
+        def merge_with_http_info(public_merge_input, opts = {})
+          if @api_client.config.debugging
+            @api_client.config.logger.debug 'Calling API: BasicApi.merge ...'
+          end
+          # verify the required parameter 'public_merge_input' is set
+          if @api_client.config.client_side_validation && public_merge_input.nil?
+            fail ArgumentError, "Missing the required parameter 'public_merge_input' when calling BasicApi.merge"
+          end
+          # resource path
+          local_var_path = '/crm/v3/objects/tickets/merge'
+
+          # query parameters
+          query_params = opts[:query_params] || {}
+
+          # header parameters
+          header_params = opts[:header_params] || {}
+          # HTTP header 'Accept' (if needed)
+          header_params['Accept'] = @api_client.select_header_accept(['application/json', '*/*'])
+          # HTTP header 'Content-Type'
+          content_type = @api_client.select_header_content_type(['application/json'])
+          if !content_type.nil?
+              header_params['Content-Type'] = content_type
+          end
+
+          # form parameters
+          form_params = opts[:form_params] || {}
+
+          # http body (model)
+          post_body = opts[:debug_body] || @api_client.object_to_http_body(public_merge_input)
+
+          # return_type
+          return_type = opts[:debug_return_type] || 'SimplePublicObject'
+
+          # auth_names
+          auth_names = opts[:debug_auth_names] || ['oauth2']
+
+          new_options = opts.merge(
+            :operation => :"BasicApi.merge",
+            :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(:POST, local_var_path, new_options)
+          if @api_client.config.debugging
+            @api_client.config.logger.debug "API called: BasicApi#merge\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+          end
+          return data, status_code, headers
+        end
+
         # Update
         # Perform a partial update of an Object identified by `{ticketId}`or optionally a unique property value as specified by the `idProperty` query param. `{ticketId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.
         # @param ticket_id [String] 

data/lib/hubspot/codegen/crm/tickets/api/batch_api.rb

@@ -22,6 +22,7 @@ module Hubspot
           @api_client = api_client
         end
         # Archive a batch of tickets by ID
+        # Delete a batch of tickets by ID. Deleted tickets can be restored within 90 days of deletion. Learn more about [restoring records](https://knowledge.hubspot.com/records/restore-deleted-records).
         # @param batch_input_simple_public_object_id [BatchInputSimplePublicObjectId] 
         # @param [Hash] opts the optional parameters
         # @return [nil]
@@ -31,6 +32,7 @@ module Hubspot
         end
 
         # Archive a batch of tickets by ID
+        # Delete a batch of tickets by ID. Deleted tickets can be restored within 90 days of deletion. Learn more about [restoring records](https://knowledge.hubspot.com/records/restore-deleted-records).
         # @param batch_input_simple_public_object_id [BatchInputSimplePublicObjectId] 
         # @param [Hash] opts the optional parameters
         # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -88,25 +90,27 @@ module Hubspot
         end
 
         # Create a batch of tickets
-        # @param batch_input_simple_public_object_input_for_create [BatchInputSimplePublicObjectInputForCreate] 
+        # Create a batch of tickets. The `inputs` array can contain a `properties` object to define property values for the ticket, along with an `associations` array to define [associations](https://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4) with other CRM records.
+        # @param batch_input_simple_public_object_batch_input_for_create [BatchInputSimplePublicObjectBatchInputForCreate] 
         # @param [Hash] opts the optional parameters
         # @return [BatchResponseSimplePublicObject]
-        def create(batch_input_simple_public_object_input_for_create, opts = {})
-          data, _status_code, _headers = create_with_http_info(batch_input_simple_public_object_input_for_create, opts)
+        def create(batch_input_simple_public_object_batch_input_for_create, opts = {})
+          data, _status_code, _headers = create_with_http_info(batch_input_simple_public_object_batch_input_for_create, opts)
           data
         end
 
         # Create a batch of tickets
-        # @param batch_input_simple_public_object_input_for_create [BatchInputSimplePublicObjectInputForCreate] 
+        # Create a batch of tickets. The &#x60;inputs&#x60; array can contain a &#x60;properties&#x60; object to define property values for the ticket, along with an &#x60;associations&#x60; array to define [associations](https://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4) with other CRM records.
+        # @param batch_input_simple_public_object_batch_input_for_create [BatchInputSimplePublicObjectBatchInputForCreate] 
         # @param [Hash] opts the optional parameters
         # @return [Array<(BatchResponseSimplePublicObject, Integer, Hash)>] BatchResponseSimplePublicObject data, response status code and response headers
-        def create_with_http_info(batch_input_simple_public_object_input_for_create, opts = {})
+        def create_with_http_info(batch_input_simple_public_object_batch_input_for_create, opts = {})
           if @api_client.config.debugging
             @api_client.config.logger.debug 'Calling API: BatchApi.create ...'
           end
-          # verify the required parameter 'batch_input_simple_public_object_input_for_create' is set
-          if @api_client.config.client_side_validation && batch_input_simple_public_object_input_for_create.nil?
-            fail ArgumentError, "Missing the required parameter 'batch_input_simple_public_object_input_for_create' when calling BatchApi.create"
+          # verify the required parameter 'batch_input_simple_public_object_batch_input_for_create' is set
+          if @api_client.config.client_side_validation && batch_input_simple_public_object_batch_input_for_create.nil?
+            fail ArgumentError, "Missing the required parameter 'batch_input_simple_public_object_batch_input_for_create' when calling BatchApi.create"
           end
           # resource path
           local_var_path = '/crm/v3/objects/tickets/batch/create'
@@ -128,7 +132,7 @@ module Hubspot
           form_params = opts[:form_params] || {}
 
           # http body (model)
-          post_body = opts[:debug_body] || @api_client.object_to_http_body(batch_input_simple_public_object_input_for_create)
+          post_body = opts[:debug_body] || @api_client.object_to_http_body(batch_input_simple_public_object_batch_input_for_create)
 
           # return_type
           return_type = opts[:debug_return_type] || 'BatchResponseSimplePublicObject'
@@ -154,6 +158,7 @@ module Hubspot
         end
 
         # Read a batch of tickets by internal ID, or unique property values
+        # Retrieve a batch of tickets by ID (`ticketId`) or unique property value (`idProperty`). 
         # @param batch_read_input_simple_public_object_id [BatchReadInputSimplePublicObjectId] 
         # @param [Hash] opts the optional parameters
         # @option opts [Boolean] :archived Whether to return only results that have been archived. (default to false)
@@ -164,6 +169,7 @@ module Hubspot
         end
 
         # Read a batch of tickets by internal ID, or unique property values
+        # Retrieve a batch of tickets by ID (&#x60;ticketId&#x60;) or unique property value (&#x60;idProperty&#x60;). 
         # @param batch_read_input_simple_public_object_id [BatchReadInputSimplePublicObjectId] 
         # @param [Hash] opts the optional parameters
         # @option opts [Boolean] :archived Whether to return only results that have been archived. (default to false)
@@ -223,6 +229,7 @@ module Hubspot
         end
 
         # Update a batch of tickets by internal ID, or unique property values
+        # Update a batch of tickets by ID (`ticketId`) or unique property value (`idProperty`). Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.
         # @param batch_input_simple_public_object_batch_input [BatchInputSimplePublicObjectBatchInput] 
         # @param [Hash] opts the optional parameters
         # @return [BatchResponseSimplePublicObject]
@@ -232,6 +239,7 @@ module Hubspot
         end
 
         # Update a batch of tickets by internal ID, or unique property values
+        # Update a batch of tickets by ID (&#x60;ticketId&#x60;) or unique property value (&#x60;idProperty&#x60;). Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.
         # @param batch_input_simple_public_object_batch_input [BatchInputSimplePublicObjectBatchInput] 
         # @param [Hash] opts the optional parameters
         # @return [Array<(BatchResponseSimplePublicObject, Integer, Hash)>] BatchResponseSimplePublicObject data, response status code and response headers

data/lib/hubspot/codegen/crm/tickets/api/search_api.rb

@@ -21,6 +21,8 @@ module Hubspot
         def initialize(api_client = ApiClient.default)
           @api_client = api_client
         end
+        # Search for tickets
+        # Search for tickets by filtering on properties, searching through associations, and sorting results. Learn more about [CRM search](https://developers.hubspot.com/docs/guides/api/crm/search#make-a-search-request).
         # @param public_object_search_request [PublicObjectSearchRequest] 
         # @param [Hash] opts the optional parameters
         # @return [CollectionResponseWithTotalSimplePublicObjectForwardPaging]
@@ -29,6 +31,8 @@ module Hubspot
           data
         end
 
+        # Search for tickets
+        # Search for tickets by filtering on properties, searching through associations, and sorting results. Learn more about [CRM search](https://developers.hubspot.com/docs/guides/api/crm/search#make-a-search-request).
         # @param public_object_search_request [PublicObjectSearchRequest] 
         # @param [Hash] opts the optional parameters
         # @return [Array<(CollectionResponseWithTotalSimplePublicObjectForwardPaging, Integer, Hash)>] CollectionResponseWithTotalSimplePublicObjectForwardPaging data, response status code and response headers

data/lib/hubspot/codegen/crm/tickets/models/association_spec.rb

@@ -98,14 +98,24 @@ module Hubspot
         # @return Array for valid properties with the reasons
         def list_invalid_properties
           invalid_properties = Array.new
+          if @association_category.nil?
+            invalid_properties.push('invalid value for "association_category", association_category cannot be nil.')
+          end
+
+          if @association_type_id.nil?
+            invalid_properties.push('invalid value for "association_type_id", association_type_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 @association_category.nil?
           association_category_validator = EnumAttributeValidator.new('String', ["HUBSPOT_DEFINED", "USER_DEFINED", "INTEGRATOR_DEFINED"])
           return false unless association_category_validator.valid?(@association_category)
+          return false if @association_type_id.nil?
           true
         end
 

data/lib/hubspot/codegen/crm/tickets/models/{batch_input_simple_public_object_input_for_create.rb → batch_input_simple_public_object_batch_input_for_create.rb}

@@ -16,7 +16,7 @@ require 'time'
 module Hubspot
   module Crm
     module Tickets
-      class BatchInputSimplePublicObjectInputForCreate
+      class BatchInputSimplePublicObjectBatchInputForCreate
         attr_accessor :inputs
 
         # Attribute mapping from ruby-style variable name to JSON key.
@@ -34,7 +34,7 @@ module Hubspot
         # Attribute type mapping.
         def self.openapi_types
           {
-            :'inputs' => :'Array<SimplePublicObjectInputForCreate>'
+            :'inputs' => :'Array<SimplePublicObjectBatchInputForCreate>'
           }
         end
 
@@ -48,13 +48,13 @@ module Hubspot
         # @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::Crm::Tickets::BatchInputSimplePublicObjectInputForCreate` initialize method"
+            fail ArgumentError, "The input argument (attributes) must be a hash in `Hubspot::Crm::Tickets::BatchInputSimplePublicObjectBatchInputForCreate` 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::Crm::Tickets::BatchInputSimplePublicObjectInputForCreate`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+              fail ArgumentError, "`#{k}` is not a valid attribute in `Hubspot::Crm::Tickets::BatchInputSimplePublicObjectBatchInputForCreate`. 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
           }

data/lib/hubspot/codegen/crm/tickets/models/batch_read_input_simple_public_object_id.rb

@@ -19,6 +19,7 @@ module Hubspot
       class BatchReadInputSimplePublicObjectId
         attr_accessor :properties_with_history
 
+        # When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.
         attr_accessor :id_property
 
         attr_accessor :inputs

data/lib/hubspot/codegen/crm/tickets/models/public_associations_for_object.rb

@@ -78,12 +78,22 @@ module Hubspot
         # @return Array for valid properties with the reasons
         def list_invalid_properties
           invalid_properties = Array.new
+          if @types.nil?
+            invalid_properties.push('invalid value for "types", types cannot be nil.')
+          end
+
+          if @to.nil?
+            invalid_properties.push('invalid value for "to", to 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 @types.nil?
+          return false if @to.nil?
           true
         end
 

data/lib/hubspot/codegen/crm/tickets/models/public_object_id.rb

@@ -68,12 +68,17 @@ 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
+
           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 @id.nil?
           true
         end
 

data/lib/hubspot/codegen/crm/tickets/models/simple_public_object.rb

@@ -27,6 +27,8 @@ module Hubspot
 
         attr_accessor :id
 
+        attr_accessor :object_write_trace_id
+
         attr_accessor :properties
 
         attr_accessor :updated_at
@@ -39,6 +41,7 @@ module Hubspot
             :'archived_at' => :'archivedAt',
             :'properties_with_history' => :'propertiesWithHistory',
             :'id' => :'id',
+            :'object_write_trace_id' => :'objectWriteTraceId',
             :'properties' => :'properties',
             :'updated_at' => :'updatedAt'
           }
@@ -57,6 +60,7 @@ module Hubspot
             :'archived_at' => :'Time',
             :'properties_with_history' => :'Hash<String, Array<ValueWithTimestamp>>',
             :'id' => :'String',
+            :'object_write_trace_id' => :'String',
             :'properties' => :'Hash<String, String>',
             :'updated_at' => :'Time'
           }
@@ -105,6 +109,10 @@ module Hubspot
             self.id = attributes[:'id']
           end
 
+          if attributes.key?(:'object_write_trace_id')
+            self.object_write_trace_id = attributes[:'object_write_trace_id']
+          end
+
           if attributes.key?(:'properties')
             if (value = attributes[:'properties']).is_a?(Hash)
               self.properties = value
@@ -159,6 +167,7 @@ module Hubspot
               archived_at == o.archived_at &&
               properties_with_history == o.properties_with_history &&
               id == o.id &&
+              object_write_trace_id == o.object_write_trace_id &&
               properties == o.properties &&
               updated_at == o.updated_at
         end
@@ -172,7 +181,7 @@ module Hubspot
         # Calculates hash code according to all attributes.
         # @return [Integer] Hash code
         def hash
-          [created_at, archived, archived_at, properties_with_history, id, properties, updated_at].hash
+          [created_at, archived, archived_at, properties_with_history, id, object_write_trace_id, properties, updated_at].hash
         end
 
         # Builds the object from hash

data/lib/hubspot/codegen/crm/tickets/models/simple_public_object_batch_input.rb

@@ -17,10 +17,12 @@ module Hubspot
   module Crm
     module Tickets
       class SimplePublicObjectBatchInput
+        # The name of a property whose values are unique for this object
         attr_accessor :id_property
 
         attr_accessor :object_write_trace_id
 
+        # The id to be updated. This can be the object id, or the unique property value of the idProperty property
         attr_accessor :id
 
         attr_accessor :properties