hubspot-api-client 2.0.0 → 2.1.0

data/lib/hubspot/codegen/crm/quotes/models/error_detail.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.2
+OpenAPI Generator version: 4.2.3
 
 =end
 
@@ -16,26 +16,28 @@ module Hubspot
   module Crm
     module Quotes
       class ErrorDetail
-        attr_accessor :sub_category
-
         # A human readable message describing the error along with remediation steps where appropriate
         attr_accessor :message
 
-        attr_accessor :code
-
         # The name of the field or parameter in which the error was found.
         attr_accessor :_in
 
+        # The status code associated with the error detail
+        attr_accessor :code
+
+        # A specific category that contains more specific detail about the error
+        attr_accessor :sub_category
+
         # Context about the error condition
         attr_accessor :context
 
         # Attribute mapping from ruby-style variable name to JSON key.
         def self.attribute_map
           {
-            :'sub_category' => :'subCategory',
             :'message' => :'message',
-            :'code' => :'code',
             :'_in' => :'in',
+            :'code' => :'code',
+            :'sub_category' => :'subCategory',
             :'context' => :'context'
           }
         end
@@ -43,10 +45,10 @@ module Hubspot
         # Attribute type mapping.
         def self.openapi_types
           {
-            :'sub_category' => :'String',
             :'message' => :'String',
-            :'code' => :'String',
             :'_in' => :'String',
+            :'code' => :'String',
+            :'sub_category' => :'String',
             :'context' => :'Hash<String, Array<String>>'
           }
         end
@@ -72,20 +74,20 @@ module Hubspot
             h[k.to_sym] = v
           }
 
-          if attributes.key?(:'sub_category')
-            self.sub_category = attributes[:'sub_category']
-          end
-
           if attributes.key?(:'message')
             self.message = attributes[:'message']
           end
 
+          if attributes.key?(:'_in')
+            self._in = attributes[:'_in']
+          end
+
           if attributes.key?(:'code')
             self.code = attributes[:'code']
           end
 
-          if attributes.key?(:'_in')
-            self._in = attributes[:'_in']
+          if attributes.key?(:'sub_category')
+            self.sub_category = attributes[:'sub_category']
           end
 
           if attributes.key?(:'context')
@@ -103,10 +105,6 @@ module Hubspot
             invalid_properties.push('invalid value for "message", message cannot be nil.')
           end
 
-          if @context.nil?
-            invalid_properties.push('invalid value for "context", context cannot be nil.')
-          end
-
           invalid_properties
         end
 
@@ -114,7 +112,6 @@ module Hubspot
         # @return true if the model is valid
         def valid?
           return false if @message.nil?
-          return false if @context.nil?
           true
         end
 
@@ -123,10 +120,10 @@ module Hubspot
         def ==(o)
           return true if self.equal?(o)
           self.class == o.class &&
-              sub_category == o.sub_category &&
               message == o.message &&
-              code == o.code &&
               _in == o._in &&
+              code == o.code &&
+              sub_category == o.sub_category &&
               context == o.context
         end
 
@@ -139,7 +136,7 @@ module Hubspot
         # Calculates hash code according to all attributes.
         # @return [Integer] Hash code
         def hash
-          [sub_category, message, code, _in, context].hash
+          [message, _in, code, sub_category, context].hash
         end
 
         # Builds the object from hash

data/lib/hubspot/codegen/crm/quotes/models/filter.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.2
+OpenAPI Generator version: 4.2.3
 
 =end
 
@@ -116,7 +116,7 @@ module Hubspot
         def valid?
           return false if @property_name.nil?
           return false if @operator.nil?
-          operator_validator = EnumAttributeValidator.new('String', ["EQ", "NEQ", "LT", "LTE", "GT", "GTE", "BETWEEN", "IN", "NOT_IN", "HAS_PROPERTY", "NOT_HAS_PROPERTY", "ROLLING_DATE_RANGE", "TIME_UNIT_TO_DATE", "CONTAINS_TOKEN", "NOT_CONTAINS_TOKEN"])
+          operator_validator = EnumAttributeValidator.new('String', ["EQ", "NEQ", "LT", "LTE", "GT", "GTE", "BETWEEN", "IN", "NOT_IN", "HAS_PROPERTY", "NOT_HAS_PROPERTY", "CONTAINS_TOKEN", "NOT_CONTAINS_TOKEN"])
           return false unless operator_validator.valid?(@operator)
           true
         end
@@ -124,7 +124,7 @@ module Hubspot
         # Custom attribute writer method checking allowed values (enum).
         # @param [Object] operator Object to be assigned
         def operator=(operator)
-          validator = EnumAttributeValidator.new('String', ["EQ", "NEQ", "LT", "LTE", "GT", "GTE", "BETWEEN", "IN", "NOT_IN", "HAS_PROPERTY", "NOT_HAS_PROPERTY", "ROLLING_DATE_RANGE", "TIME_UNIT_TO_DATE", "CONTAINS_TOKEN", "NOT_CONTAINS_TOKEN"])
+          validator = EnumAttributeValidator.new('String', ["EQ", "NEQ", "LT", "LTE", "GT", "GTE", "BETWEEN", "IN", "NOT_IN", "HAS_PROPERTY", "NOT_HAS_PROPERTY", "CONTAINS_TOKEN", "NOT_CONTAINS_TOKEN"])
           unless validator.valid?(operator)
             fail ArgumentError, "invalid value for \"operator\", must be one of #{validator.allowable_values}."
           end
@@ -269,4 +269,4 @@ module Hubspot
       end
     end
   end
-end
+end

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

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.2
+OpenAPI Generator version: 4.2.3
 
 =end
 
@@ -50,7 +50,7 @@ module Hubspot
             :'properties' => :'Hash<String, String>',
             :'created_at' => :'DateTime',
             :'updated_at' => :'DateTime',
-            :'associations' => :'Hash<String, CollectionResponseSimplePublicObjectId>',
+            :'associations' => :'Hash<String, CollectionResponseAssociatedId>',
             :'archived' => :'Boolean',
             :'archived_at' => :'DateTime'
           }
@@ -130,14 +130,6 @@ module Hubspot
             invalid_properties.push('invalid value for "updated_at", updated_at cannot be nil.')
           end
 
-          if @associations.nil?
-            invalid_properties.push('invalid value for "associations", associations cannot be nil.')
-          end
-
-          if @archived.nil?
-            invalid_properties.push('invalid value for "archived", archived cannot be nil.')
-          end
-
           invalid_properties
         end
 
@@ -148,8 +140,6 @@ module Hubspot
           return false if @properties.nil?
           return false if @created_at.nil?
           return false if @updated_at.nil?
-          return false if @associations.nil?
-          return false if @archived.nil?
           true
         end
 

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

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.2
+OpenAPI Generator version: 4.2.3
 
 =end
 
@@ -23,22 +23,24 @@ module Hubspot
         end
         # Remove an association between two tickets
         # @param ticket_id [String] 
-        # @param associated_object_type [String] 
+        # @param to_object_type [String] 
         # @param to_object_id [String] 
+        # @param association_type [String] 
         # @param [Hash] opts the optional parameters
         # @return [nil]
-        def archive_association(ticket_id, associated_object_type, to_object_id, opts = {})
-          archive_association_with_http_info(ticket_id, associated_object_type, to_object_id, opts)
+        def archive_association(ticket_id, to_object_type, to_object_id, association_type, opts = {})
+          archive_association_with_http_info(ticket_id, to_object_type, to_object_id, association_type, opts)
           nil
         end
 
         # Remove an association between two tickets
         # @param ticket_id [String] 
-        # @param associated_object_type [String] 
+        # @param to_object_type [String] 
         # @param to_object_id [String] 
+        # @param association_type [String] 
         # @param [Hash] opts the optional parameters
         # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
-        def archive_association_with_http_info(ticket_id, associated_object_type, to_object_id, opts = {})
+        def archive_association_with_http_info(ticket_id, to_object_type, to_object_id, association_type, opts = {})
           if @api_client.config.debugging
             @api_client.config.logger.debug 'Calling API: AssociationsApi.archive_association ...'
           end
@@ -46,16 +48,20 @@ module Hubspot
           if @api_client.config.client_side_validation && ticket_id.nil?
             fail ArgumentError, "Missing the required parameter 'ticket_id' when calling AssociationsApi.archive_association"
           end
-          # verify the required parameter 'associated_object_type' is set
-          if @api_client.config.client_side_validation && associated_object_type.nil?
-            fail ArgumentError, "Missing the required parameter 'associated_object_type' when calling AssociationsApi.archive_association"
+          # verify the required parameter 'to_object_type' is set
+          if @api_client.config.client_side_validation && to_object_type.nil?
+            fail ArgumentError, "Missing the required parameter 'to_object_type' when calling AssociationsApi.archive_association"
           end
           # verify the required parameter 'to_object_id' is set
           if @api_client.config.client_side_validation && to_object_id.nil?
             fail ArgumentError, "Missing the required parameter 'to_object_id' when calling AssociationsApi.archive_association"
           end
+          # verify the required parameter 'association_type' is set
+          if @api_client.config.client_side_validation && association_type.nil?
+            fail ArgumentError, "Missing the required parameter 'association_type' when calling AssociationsApi.archive_association"
+          end
           # resource path
-          local_var_path = '/crm/v3/objects/tickets/{ticketId}/associations/{associatedObjectType}/{toObjectId}'.sub('{' + 'ticketId' + '}', CGI.escape(ticket_id.to_s).gsub('%2F', '/')).sub('{' + 'associatedObjectType' + '}', CGI.escape(associated_object_type.to_s).gsub('%2F', '/')).sub('{' + 'toObjectId' + '}', CGI.escape(to_object_id.to_s).gsub('%2F', '/'))
+          local_var_path = '/crm/v3/objects/tickets/{ticketId}/associations/{toObjectType}/{toObjectId}/{associationType}'.sub('{' + 'ticketId' + '}', CGI.escape(ticket_id.to_s)).sub('{' + 'toObjectType' + '}', CGI.escape(to_object_type.to_s)).sub('{' + 'toObjectId' + '}', CGI.escape(to_object_id.to_s)).sub('{' + 'associationType' + '}', CGI.escape(association_type.to_s))
 
           # query parameters
           query_params = opts[:query_params] || {}
@@ -95,22 +101,24 @@ module Hubspot
 
         # Associate two tickets
         # @param ticket_id [String] 
-        # @param associated_object_type [String] 
+        # @param to_object_type [String] 
         # @param to_object_id [String] 
+        # @param association_type [String] 
         # @param [Hash] opts the optional parameters
         # @return [SimplePublicObject]
-        def create_association(ticket_id, associated_object_type, to_object_id, opts = {})
-          data, _status_code, _headers = create_association_with_http_info(ticket_id, associated_object_type, to_object_id, opts)
+        def create_association(ticket_id, to_object_type, to_object_id, association_type, opts = {})
+          data, _status_code, _headers = create_association_with_http_info(ticket_id, to_object_type, to_object_id, association_type, opts)
           data
         end
 
         # Associate two tickets
         # @param ticket_id [String] 
-        # @param associated_object_type [String] 
+        # @param to_object_type [String] 
         # @param to_object_id [String] 
+        # @param association_type [String] 
         # @param [Hash] opts the optional parameters
         # @return [Array<(SimplePublicObject, Integer, Hash)>] SimplePublicObject data, response status code and response headers
-        def create_association_with_http_info(ticket_id, associated_object_type, to_object_id, opts = {})
+        def create_association_with_http_info(ticket_id, to_object_type, to_object_id, association_type, opts = {})
           if @api_client.config.debugging
             @api_client.config.logger.debug 'Calling API: AssociationsApi.create_association ...'
           end
@@ -118,16 +126,20 @@ module Hubspot
           if @api_client.config.client_side_validation && ticket_id.nil?
             fail ArgumentError, "Missing the required parameter 'ticket_id' when calling AssociationsApi.create_association"
           end
-          # verify the required parameter 'associated_object_type' is set
-          if @api_client.config.client_side_validation && associated_object_type.nil?
-            fail ArgumentError, "Missing the required parameter 'associated_object_type' when calling AssociationsApi.create_association"
+          # verify the required parameter 'to_object_type' is set
+          if @api_client.config.client_side_validation && to_object_type.nil?
+            fail ArgumentError, "Missing the required parameter 'to_object_type' when calling AssociationsApi.create_association"
           end
           # verify the required parameter 'to_object_id' is set
           if @api_client.config.client_side_validation && to_object_id.nil?
             fail ArgumentError, "Missing the required parameter 'to_object_id' when calling AssociationsApi.create_association"
           end
+          # verify the required parameter 'association_type' is set
+          if @api_client.config.client_side_validation && association_type.nil?
+            fail ArgumentError, "Missing the required parameter 'association_type' when calling AssociationsApi.create_association"
+          end
           # resource path
-          local_var_path = '/crm/v3/objects/tickets/{ticketId}/associations/{associatedObjectType}/{toObjectId}'.sub('{' + 'ticketId' + '}', CGI.escape(ticket_id.to_s).gsub('%2F', '/')).sub('{' + 'associatedObjectType' + '}', CGI.escape(associated_object_type.to_s).gsub('%2F', '/')).sub('{' + 'toObjectId' + '}', CGI.escape(to_object_id.to_s).gsub('%2F', '/'))
+          local_var_path = '/crm/v3/objects/tickets/{ticketId}/associations/{toObjectType}/{toObjectId}/{associationType}'.sub('{' + 'ticketId' + '}', CGI.escape(ticket_id.to_s)).sub('{' + 'toObjectType' + '}', CGI.escape(to_object_type.to_s)).sub('{' + 'toObjectId' + '}', CGI.escape(to_object_id.to_s)).sub('{' + 'associationType' + '}', CGI.escape(association_type.to_s))
 
           # query parameters
           query_params = opts[:query_params] || {}
@@ -167,20 +179,20 @@ module Hubspot
 
         # List associations of a ticket by type
         # @param ticket_id [String] 
-        # @param associated_object_type [String] 
+        # @param to_object_type [String] 
         # @param [Hash] opts the optional parameters
-        # @return [CollectionResponseSimplePublicObjectId]
-        def get_associations(ticket_id, associated_object_type, opts = {})
-          data, _status_code, _headers = get_associations_with_http_info(ticket_id, associated_object_type, opts)
+        # @return [CollectionResponseAssociatedId]
+        def get_associations(ticket_id, to_object_type, opts = {})
+          data, _status_code, _headers = get_associations_with_http_info(ticket_id, to_object_type, opts)
           data
         end
 
         # List associations of a ticket by type
         # @param ticket_id [String] 
-        # @param associated_object_type [String] 
+        # @param to_object_type [String] 
         # @param [Hash] opts the optional parameters
-        # @return [Array<(CollectionResponseSimplePublicObjectId, Integer, Hash)>] CollectionResponseSimplePublicObjectId data, response status code and response headers
-        def get_associations_with_http_info(ticket_id, associated_object_type, opts = {})
+        # @return [Array<(CollectionResponseAssociatedId, Integer, Hash)>] CollectionResponseAssociatedId data, response status code and response headers
+        def get_associations_with_http_info(ticket_id, to_object_type, opts = {})
           if @api_client.config.debugging
             @api_client.config.logger.debug 'Calling API: AssociationsApi.get_associations ...'
           end
@@ -188,12 +200,12 @@ module Hubspot
           if @api_client.config.client_side_validation && ticket_id.nil?
             fail ArgumentError, "Missing the required parameter 'ticket_id' when calling AssociationsApi.get_associations"
           end
-          # verify the required parameter 'associated_object_type' is set
-          if @api_client.config.client_side_validation && associated_object_type.nil?
-            fail ArgumentError, "Missing the required parameter 'associated_object_type' when calling AssociationsApi.get_associations"
+          # verify the required parameter 'to_object_type' is set
+          if @api_client.config.client_side_validation && to_object_type.nil?
+            fail ArgumentError, "Missing the required parameter 'to_object_type' when calling AssociationsApi.get_associations"
           end
           # resource path
-          local_var_path = '/crm/v3/objects/tickets/{ticketId}/associations/{associatedObjectType}'.sub('{' + 'ticketId' + '}', CGI.escape(ticket_id.to_s).gsub('%2F', '/')).sub('{' + 'associatedObjectType' + '}', CGI.escape(associated_object_type.to_s).gsub('%2F', '/'))
+          local_var_path = '/crm/v3/objects/tickets/{ticketId}/associations/{toObjectType}'.sub('{' + 'ticketId' + '}', CGI.escape(ticket_id.to_s)).sub('{' + 'toObjectType' + '}', CGI.escape(to_object_type.to_s))
 
           # query parameters
           query_params = opts[:query_params] || {}
@@ -210,7 +222,7 @@ module Hubspot
           post_body = opts[:body] 
 
           # return_type
-          return_type = opts[:return_type] || 'CollectionResponseSimplePublicObjectId' 
+          return_type = opts[:return_type] || 'CollectionResponseAssociatedId' 
 
           # auth_names
           auth_names = opts[:auth_names] || ['hapikey', 'oauth2']

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

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.2
+OpenAPI Generator version: 4.2.3
 
 =end
 
@@ -47,7 +47,7 @@ module Hubspot
             fail ArgumentError, "Missing the required parameter 'ticket_id' when calling BasicApi.archive"
           end
           # resource path
-          local_var_path = '/crm/v3/objects/tickets/{ticketId}'.sub('{' + 'ticketId' + '}', CGI.escape(ticket_id.to_s).gsub('%2F', '/'))
+          local_var_path = '/crm/v3/objects/tickets/{ticketId}'.sub('{' + 'ticketId' + '}', CGI.escape(ticket_id.to_s))
 
           # query parameters
           query_params = opts[:query_params] || {}
@@ -146,12 +146,13 @@ module Hubspot
         end
 
         # Read
-        # Read an Object identified by `{ticketId}`. Control what is returned via the `properties` query param.
+        # 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 [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>] :associations A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
         # @option opts [Boolean] :archived Whether to return only results that have been archived. (default to false)
+        # @option opts [String] :id_property The name of a property whose values are unique for this object type
         # @return [SimplePublicObject]
         def get_by_id(ticket_id, opts = {})
           data, _status_code, _headers = get_by_id_with_http_info(ticket_id, opts)
@@ -159,12 +160,13 @@ module Hubspot
         end
 
         # Read
-        # Read an Object identified by &#x60;{ticketId}&#x60;. Control what is returned via the &#x60;properties&#x60; query param.
+        # 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 [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>] :associations A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
         # @option opts [Boolean] :archived Whether to return only results that have been archived.
+        # @option opts [String] :id_property The name of a property whose values are unique for this object type
         # @return [Array<(SimplePublicObject, Integer, Hash)>] SimplePublicObject data, response status code and response headers
         def get_by_id_with_http_info(ticket_id, opts = {})
           if @api_client.config.debugging
@@ -175,13 +177,14 @@ module Hubspot
             fail ArgumentError, "Missing the required parameter 'ticket_id' when calling BasicApi.get_by_id"
           end
           # resource path
-          local_var_path = '/crm/v3/objects/tickets/{ticketId}'.sub('{' + 'ticketId' + '}', CGI.escape(ticket_id.to_s).gsub('%2F', '/'))
+          local_var_path = '/crm/v3/objects/tickets/{ticketId}'.sub('{' + 'ticketId' + '}', CGI.escape(ticket_id.to_s))
 
           # query parameters
           query_params = opts[:query_params] || {}
           query_params[:'properties'] = @api_client.build_collection_param(opts[:'properties'], :multi) if !opts[:'properties'].nil?
           query_params[:'associations'] = @api_client.build_collection_param(opts[:'associations'], :multi) if !opts[:'associations'].nil?
           query_params[:'archived'] = opts[:'archived'] if !opts[:'archived'].nil?
+          query_params[:'idProperty'] = opts[:'id_property'] if !opts[:'id_property'].nil?
 
           # header parameters
           header_params = opts[:header_params] || {}
@@ -313,7 +316,7 @@ module Hubspot
             fail ArgumentError, "Missing the required parameter 'ticket_id' when calling BasicApi.update"
           end
           # resource path
-          local_var_path = '/crm/v3/objects/tickets/{ticketId}'.sub('{' + 'ticketId' + '}', CGI.escape(ticket_id.to_s).gsub('%2F', '/'))
+          local_var_path = '/crm/v3/objects/tickets/{ticketId}'.sub('{' + 'ticketId' + '}', CGI.escape(ticket_id.to_s))
 
           # query parameters
           query_params = opts[:query_params] || {}

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

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.2
+OpenAPI Generator version: 4.2.3
 
 =end
 
@@ -141,7 +141,7 @@ module Hubspot
           return data, status_code, headers
         end
 
-        # Read a batch of tickets by ID
+        # Read a batch of tickets by internal ID, or unique property values
         # Read a list of tickets given a collection of IDs. Use the `properties` request body property to control which properties are returned.
         # @param [Hash] opts the optional parameters
         # @option opts [Boolean] :archived Whether to return only results that have been archived. (default to false)
@@ -152,7 +152,7 @@ module Hubspot
           data
         end
 
-        # Read a batch of tickets by ID
+        # Read a batch of tickets by internal ID, or unique property values
         # Read a list of tickets given a collection of IDs. Use the `properties` request body property to control which properties are returned.
         # @param [Hash] opts the optional parameters
         # @option opts [Boolean] :archived Whether to return only results that have been archived.