hubspot-api-client 2.0.0 → 2.1.0

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

@@ -1,12 +1,12 @@
 =begin
-#LinkedSalesObjectsPublicService
+#CRM cards
 
-#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+#Allows an app to extend the CRM UI by surfacing custom cards in the sidebar of record pages. These cards are defined up-front as part of app configuration, then populated by external data fetch requests when the record page is accessed by a user.
 
 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
 
@@ -17,8 +17,10 @@ module Hubspot
     module Extensions
       module Cards
         class CardObjectTypeBody
+          # A CRM object type where this card should be displayed.
           attr_accessor :name
 
+          # An array of properties that should be sent to this card's target URL when the data fetch request is made. Must be valid properties for the corresponding CRM object type.
           attr_accessor :properties_to_send
 
           class EnumAttributeValidator

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

@@ -1,12 +1,12 @@
 =begin
-#LinkedSalesObjectsPublicService
+#CRM cards
 
-#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+#Allows an app to extend the CRM UI by surfacing custom cards in the sidebar of record pages. These cards are defined up-front as part of app configuration, then populated by external data fetch requests when the record page is accessed by a user.
 
 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,7 +16,9 @@ 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
 
           attr_accessor :fetch

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

@@ -1,12 +1,12 @@
 =begin
-#LinkedSalesObjectsPublicService
+#CRM cards
 
-#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+#Allows an app to extend the CRM UI by surfacing custom cards in the sidebar of record pages. These cards are defined up-front as part of app configuration, then populated by external data fetch requests when the record page is accessed by a user.
 
 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,13 +16,18 @@ module Hubspot
   module Crm
     module Extensions
       module Cards
+        # Current state of Card Definition
         class CardResponse
+          # Generated unique ID for card.
           attr_accessor :id
 
+          # When this card was created.
           attr_accessor :created_at
 
+          # The last time this card was updated.
           attr_accessor :updated_at
 
+          # Displayed title of this card.
           attr_accessor :title
 
           attr_accessor :fetch

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

@@ -1,12 +1,12 @@
 =begin
-#LinkedSalesObjectsPublicService
+#CRM cards
 
-#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+#Allows an app to extend the CRM UI by surfacing custom cards in the sidebar of record pages. These cards are defined up-front as part of app configuration, then populated by external data fetch requests when the record page is accessed by a user.
 
 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,11 +16,15 @@ module Hubspot
   module Crm
     module Extensions
       module Cards
+        # Option definition for STATUS dataTypes.
         class DisplayOption
+          # JSON-friendly unique name for option.
           attr_accessor :name
 
+          # The text that will be displayed to users for this option.
           attr_accessor :label
 
+          # The type of status.
           attr_accessor :type
 
           class EnumAttributeValidator

data/lib/hubspot/codegen/crm/extensions/cards/models/error.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
 
@@ -26,6 +26,9 @@ module Hubspot
           # The error category
           attr_accessor :category
 
+          # A specific category that contains more specific detail about the error
+          attr_accessor :sub_category
+
           # further information about the error
           attr_accessor :errors
 
@@ -41,6 +44,7 @@ module Hubspot
               :'message' => :'message',
               :'correlation_id' => :'correlationId',
               :'category' => :'category',
+              :'sub_category' => :'subCategory',
               :'errors' => :'errors',
               :'context' => :'context',
               :'links' => :'links'
@@ -53,6 +57,7 @@ module Hubspot
               :'message' => :'String',
               :'correlation_id' => :'String',
               :'category' => :'String',
+              :'sub_category' => :'String',
               :'errors' => :'Array<ErrorDetail>',
               :'context' => :'Hash<String, Array<String>>',
               :'links' => :'Hash<String, String>'
@@ -92,6 +97,10 @@ module Hubspot
               self.category = attributes[:'category']
             end
 
+            if attributes.key?(:'sub_category')
+              self.sub_category = attributes[:'sub_category']
+            end
+
             if attributes.key?(:'errors')
               if (value = attributes[:'errors']).is_a?(Array)
                 self.errors = value
@@ -147,6 +156,7 @@ module Hubspot
                 message == o.message &&
                 correlation_id == o.correlation_id &&
                 category == o.category &&
+                sub_category == o.sub_category &&
                 errors == o.errors &&
                 context == o.context &&
                 links == o.links
@@ -161,7 +171,7 @@ module Hubspot
           # Calculates hash code according to all attributes.
           # @return [Integer] Hash code
           def hash
-            [message, correlation_id, category, errors, context, links].hash
+            [message, correlation_id, category, sub_category, errors, context, links].hash
           end
 
           # Builds the object from hash

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

@@ -1,12 +1,12 @@
 =begin
-#LinkedSalesObjectsPublicService
+#CRM cards
 
-#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+#Allows an app to extend the CRM UI by surfacing custom cards in the sidebar of record pages. These cards are defined up-front as part of app configuration, then populated by external data fetch requests when the record page is accessed by a user.
 
 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,6 +23,12 @@ module Hubspot
           # 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
 
@@ -31,6 +37,8 @@ module Hubspot
             {
               :'message' => :'message',
               :'_in' => :'in',
+              :'code' => :'code',
+              :'sub_category' => :'subCategory',
               :'context' => :'context'
             }
           end
@@ -40,6 +48,8 @@ module Hubspot
             {
               :'message' => :'String',
               :'_in' => :'String',
+              :'code' => :'String',
+              :'sub_category' => :'String',
               :'context' => :'Hash<String, Array<String>>'
             }
           end
@@ -73,6 +83,14 @@ module Hubspot
               self._in = attributes[:'_in']
             end
 
+            if attributes.key?(:'code')
+              self.code = attributes[:'code']
+            end
+
+            if attributes.key?(:'sub_category')
+              self.sub_category = attributes[:'sub_category']
+            end
+
             if attributes.key?(:'context')
               if (value = attributes[:'context']).is_a?(Hash)
                 self.context = value
@@ -105,6 +123,8 @@ module Hubspot
             self.class == o.class &&
                 message == o.message &&
                 _in == o._in &&
+                code == o.code &&
+                sub_category == o.sub_category &&
                 context == o.context
           end
 
@@ -117,7 +137,7 @@ module Hubspot
           # Calculates hash code according to all attributes.
           # @return [Integer] Hash code
           def hash
-            [message, _in, context].hash
+            [message, _in, code, sub_category, context].hash
           end
 
           # Builds the object from hash

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

@@ -23,22 +23,24 @@ module Hubspot
         end
         # Remove an association between two line items
         # @param line_item_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(line_item_id, associated_object_type, to_object_id, opts = {})
-          archive_association_with_http_info(line_item_id, associated_object_type, to_object_id, opts)
+        def archive_association(line_item_id, to_object_type, to_object_id, association_type, opts = {})
+          archive_association_with_http_info(line_item_id, to_object_type, to_object_id, association_type, opts)
           nil
         end
 
         # Remove an association between two line items
         # @param line_item_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(line_item_id, associated_object_type, to_object_id, opts = {})
+        def archive_association_with_http_info(line_item_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 && line_item_id.nil?
             fail ArgumentError, "Missing the required parameter 'line_item_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/line_items/{lineItemId}/associations/{associatedObjectType}/{toObjectId}'.sub('{' + 'lineItemId' + '}', CGI.escape(line_item_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/line_items/{lineItemId}/associations/{toObjectType}/{toObjectId}/{associationType}'.sub('{' + 'lineItemId' + '}', CGI.escape(line_item_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 line items
         # @param line_item_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(line_item_id, associated_object_type, to_object_id, opts = {})
-          data, _status_code, _headers = create_association_with_http_info(line_item_id, associated_object_type, to_object_id, opts)
+        def create_association(line_item_id, to_object_type, to_object_id, association_type, opts = {})
+          data, _status_code, _headers = create_association_with_http_info(line_item_id, to_object_type, to_object_id, association_type, opts)
           data
         end
 
         # Associate two line items
         # @param line_item_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(line_item_id, associated_object_type, to_object_id, opts = {})
+        def create_association_with_http_info(line_item_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 && line_item_id.nil?
             fail ArgumentError, "Missing the required parameter 'line_item_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/line_items/{lineItemId}/associations/{associatedObjectType}/{toObjectId}'.sub('{' + 'lineItemId' + '}', CGI.escape(line_item_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/line_items/{lineItemId}/associations/{toObjectType}/{toObjectId}/{associationType}'.sub('{' + 'lineItemId' + '}', CGI.escape(line_item_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 line item by type
         # @param line_item_id [String] 
-        # @param associated_object_type [String] 
+        # @param to_object_type [String] 
         # @param [Hash] opts the optional parameters
-        # @return [CollectionResponseSimplePublicObjectId]
-        def get_associations(line_item_id, associated_object_type, opts = {})
-          data, _status_code, _headers = get_associations_with_http_info(line_item_id, associated_object_type, opts)
+        # @return [CollectionResponseAssociatedId]
+        def get_associations(line_item_id, to_object_type, opts = {})
+          data, _status_code, _headers = get_associations_with_http_info(line_item_id, to_object_type, opts)
           data
         end
 
         # List associations of a line item by type
         # @param line_item_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(line_item_id, associated_object_type, opts = {})
+        # @return [Array<(CollectionResponseAssociatedId, Integer, Hash)>] CollectionResponseAssociatedId data, response status code and response headers
+        def get_associations_with_http_info(line_item_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 && line_item_id.nil?
             fail ArgumentError, "Missing the required parameter 'line_item_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/line_items/{lineItemId}/associations/{associatedObjectType}'.sub('{' + 'lineItemId' + '}', CGI.escape(line_item_id.to_s).gsub('%2F', '/')).sub('{' + 'associatedObjectType' + '}', CGI.escape(associated_object_type.to_s).gsub('%2F', '/'))
+          local_var_path = '/crm/v3/objects/line_items/{lineItemId}/associations/{toObjectType}'.sub('{' + 'lineItemId' + '}', CGI.escape(line_item_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/line_items/api/basic_api.rb

@@ -47,7 +47,7 @@ module Hubspot
             fail ArgumentError, "Missing the required parameter 'line_item_id' when calling BasicApi.archive"
           end
           # resource path
-          local_var_path = '/crm/v3/objects/line_items/{lineItemId}'.sub('{' + 'lineItemId' + '}', CGI.escape(line_item_id.to_s).gsub('%2F', '/'))
+          local_var_path = '/crm/v3/objects/line_items/{lineItemId}'.sub('{' + 'lineItemId' + '}', CGI.escape(line_item_id.to_s))
 
           # query parameters
           query_params = opts[:query_params] || {}
@@ -146,12 +146,13 @@ module Hubspot
         end
 
         # Read
-        # Read an Object identified by `{lineItemId}`. Control what is returned via the `properties` query param.
+        # Read an Object identified by `{lineItemId}`. `{lineItemId}` 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 line_item_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(line_item_id, opts = {})
           data, _status_code, _headers = get_by_id_with_http_info(line_item_id, opts)
@@ -159,12 +160,13 @@ module Hubspot
         end
 
         # Read
-        # Read an Object identified by &#x60;{lineItemId}&#x60;. Control what is returned via the &#x60;properties&#x60; query param.
+        # Read an Object identified by &#x60;{lineItemId}&#x60;. &#x60;{lineItemId}&#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 line_item_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(line_item_id, opts = {})
           if @api_client.config.debugging
@@ -175,13 +177,14 @@ module Hubspot
             fail ArgumentError, "Missing the required parameter 'line_item_id' when calling BasicApi.get_by_id"
           end
           # resource path
-          local_var_path = '/crm/v3/objects/line_items/{lineItemId}'.sub('{' + 'lineItemId' + '}', CGI.escape(line_item_id.to_s).gsub('%2F', '/'))
+          local_var_path = '/crm/v3/objects/line_items/{lineItemId}'.sub('{' + 'lineItemId' + '}', CGI.escape(line_item_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 'line_item_id' when calling BasicApi.update"
           end
           # resource path
-          local_var_path = '/crm/v3/objects/line_items/{lineItemId}'.sub('{' + 'lineItemId' + '}', CGI.escape(line_item_id.to_s).gsub('%2F', '/'))
+          local_var_path = '/crm/v3/objects/line_items/{lineItemId}'.sub('{' + 'lineItemId' + '}', CGI.escape(line_item_id.to_s))
 
           # query parameters
           query_params = opts[:query_params] || {}