hubspot-api-client 2.0.0 → 2.1.0

data/lib/hubspot/codegen/crm/deals/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

data/lib/hubspot/codegen/crm/deals/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/extensions/cards/api/cards_api.rb

@@ -24,35 +24,35 @@ module Hubspot
           end
           # Delete a card
           # Permanently deletes a card definition with the given ID. Once deleted, data fetch requests for this card will no longer be sent to your service. This can't be undone.
+          # @param app_id [Integer] The ID of the target app.
           # @param card_id [String] The ID of the card to delete.
-          # @param app_id [Object] The ID of the target app.
           # @param [Hash] opts the optional parameters
           # @return [nil]
-          def archive(card_id, app_id, opts = {})
-            archive_with_http_info(card_id, app_id, opts)
+          def archive(app_id, card_id, opts = {})
+            archive_with_http_info(app_id, card_id, opts)
             nil
           end
 
           # Delete a card
           # Permanently deletes a card definition with the given ID. Once deleted, data fetch requests for this card will no longer be sent to your service. This can't be undone.
+          # @param app_id [Integer] The ID of the target app.
           # @param card_id [String] The ID of the card to delete.
-          # @param app_id [Object] The ID of the target app.
           # @param [Hash] opts the optional parameters
           # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
-          def archive_with_http_info(card_id, app_id, opts = {})
+          def archive_with_http_info(app_id, card_id, opts = {})
             if @api_client.config.debugging
               @api_client.config.logger.debug 'Calling API: CardsApi.archive ...'
             end
-            # verify the required parameter 'card_id' is set
-            if @api_client.config.client_side_validation && card_id.nil?
-              fail ArgumentError, "Missing the required parameter 'card_id' when calling CardsApi.archive"
-            end
             # verify the required parameter 'app_id' is set
             if @api_client.config.client_side_validation && app_id.nil?
               fail ArgumentError, "Missing the required parameter 'app_id' when calling CardsApi.archive"
             end
+            # verify the required parameter 'card_id' is set
+            if @api_client.config.client_side_validation && card_id.nil?
+              fail ArgumentError, "Missing the required parameter 'card_id' when calling CardsApi.archive"
+            end
             # resource path
-            local_var_path = '/crm/v3/extensions/cards/{appId}/{cardId}'.sub('{' + 'cardId' + '}', CGI.escape(card_id.to_s).gsub('%2F', '/')).sub('{' + 'appId' + '}', CGI.escape(app_id.to_s).gsub('%2F', '/'))
+            local_var_path = '/crm/v3/extensions/cards/{appId}/{cardId}'.sub('{' + 'appId' + '}', CGI.escape(app_id.to_s)).sub('{' + 'cardId' + '}', CGI.escape(card_id.to_s))
 
             # query parameters
             query_params = opts[:query_params] || {}
@@ -92,7 +92,7 @@ module Hubspot
 
           # Create a new card
           # Defines a new card that will become active on an account when this app is installed.
-          # @param app_id [Object] The ID of the target app.
+          # @param app_id [Integer] The ID of the target app.
           # @param [Hash] opts the optional parameters
           # @option opts [CardCreateRequest] :card_create_request The new card definition.
           # @return [CardResponse]
@@ -103,7 +103,7 @@ module Hubspot
 
           # Create a new card
           # Defines a new card that will become active on an account when this app is installed.
-          # @param app_id [Object] The ID of the target app.
+          # @param app_id [Integer] The ID of the target app.
           # @param [Hash] opts the optional parameters
           # @option opts [CardCreateRequest] :card_create_request The new card definition.
           # @return [Array<(CardResponse, Integer, Hash)>] CardResponse data, response status code and response headers
@@ -116,7 +116,7 @@ module Hubspot
               fail ArgumentError, "Missing the required parameter 'app_id' when calling CardsApi.create"
             end
             # resource path
-            local_var_path = '/crm/v3/extensions/cards/{appId}'.sub('{' + 'appId' + '}', CGI.escape(app_id.to_s).gsub('%2F', '/'))
+            local_var_path = '/crm/v3/extensions/cards/{appId}'.sub('{' + 'appId' + '}', CGI.escape(app_id.to_s))
 
             # query parameters
             query_params = opts[:query_params] || {}
@@ -158,7 +158,7 @@ module Hubspot
 
           # Get all cards
           # Returns a list of cards for a given app.
-          # @param app_id [Object] The ID of the target app.
+          # @param app_id [Integer] The ID of the target app.
           # @param [Hash] opts the optional parameters
           # @return [CardListResponse]
           def get_all(app_id, opts = {})
@@ -168,7 +168,7 @@ module Hubspot
 
           # Get all cards
           # Returns a list of cards for a given app.
-          # @param app_id [Object] The ID of the target app.
+          # @param app_id [Integer] The ID of the target app.
           # @param [Hash] opts the optional parameters
           # @return [Array<(CardListResponse, Integer, Hash)>] CardListResponse data, response status code and response headers
           def get_all_with_http_info(app_id, opts = {})
@@ -180,7 +180,7 @@ module Hubspot
               fail ArgumentError, "Missing the required parameter 'app_id' when calling CardsApi.get_all"
             end
             # resource path
-            local_var_path = '/crm/v3/extensions/cards/{appId}'.sub('{' + 'appId' + '}', CGI.escape(app_id.to_s).gsub('%2F', '/'))
+            local_var_path = '/crm/v3/extensions/cards/{appId}'.sub('{' + 'appId' + '}', CGI.escape(app_id.to_s))
 
             # query parameters
             query_params = opts[:query_params] || {}
@@ -220,35 +220,35 @@ module Hubspot
 
           # Get a card.
           # Returns the definition for a card with the given ID.
+          # @param app_id [Integer] The ID of the target app.
           # @param card_id [String] The ID of the target card.
-          # @param app_id [Object] The ID of the target app.
           # @param [Hash] opts the optional parameters
           # @return [CardResponse]
-          def get_by_id(card_id, app_id, opts = {})
-            data, _status_code, _headers = get_by_id_with_http_info(card_id, app_id, opts)
+          def get_by_id(app_id, card_id, opts = {})
+            data, _status_code, _headers = get_by_id_with_http_info(app_id, card_id, opts)
             data
           end
 
           # Get a card.
           # Returns the definition for a card with the given ID.
+          # @param app_id [Integer] The ID of the target app.
           # @param card_id [String] The ID of the target card.
-          # @param app_id [Object] The ID of the target app.
           # @param [Hash] opts the optional parameters
           # @return [Array<(CardResponse, Integer, Hash)>] CardResponse data, response status code and response headers
-          def get_by_id_with_http_info(card_id, app_id, opts = {})
+          def get_by_id_with_http_info(app_id, card_id, opts = {})
             if @api_client.config.debugging
               @api_client.config.logger.debug 'Calling API: CardsApi.get_by_id ...'
             end
-            # verify the required parameter 'card_id' is set
-            if @api_client.config.client_side_validation && card_id.nil?
-              fail ArgumentError, "Missing the required parameter 'card_id' when calling CardsApi.get_by_id"
-            end
             # verify the required parameter 'app_id' is set
             if @api_client.config.client_side_validation && app_id.nil?
               fail ArgumentError, "Missing the required parameter 'app_id' when calling CardsApi.get_by_id"
             end
+            # verify the required parameter 'card_id' is set
+            if @api_client.config.client_side_validation && card_id.nil?
+              fail ArgumentError, "Missing the required parameter 'card_id' when calling CardsApi.get_by_id"
+            end
             # resource path
-            local_var_path = '/crm/v3/extensions/cards/{appId}/{cardId}'.sub('{' + 'cardId' + '}', CGI.escape(card_id.to_s).gsub('%2F', '/')).sub('{' + 'appId' + '}', CGI.escape(app_id.to_s).gsub('%2F', '/'))
+            local_var_path = '/crm/v3/extensions/cards/{appId}/{cardId}'.sub('{' + 'appId' + '}', CGI.escape(app_id.to_s)).sub('{' + 'cardId' + '}', CGI.escape(card_id.to_s))
 
             # query parameters
             query_params = opts[:query_params] || {}
@@ -288,37 +288,37 @@ module Hubspot
 
           # Update a card
           # Update a card definition with new details.
+          # @param app_id [Integer] The ID of the target app.
           # @param card_id [String] The ID of the card to update.
-          # @param app_id [Object] The ID of the target app.
           # @param [Hash] opts the optional parameters
           # @option opts [CardPatchRequest] :card_patch_request Card definition fields to be updated.
           # @return [CardResponse]
-          def update(card_id, app_id, opts = {})
-            data, _status_code, _headers = update_with_http_info(card_id, app_id, opts)
+          def update(app_id, card_id, opts = {})
+            data, _status_code, _headers = update_with_http_info(app_id, card_id, opts)
             data
           end
 
           # Update a card
           # Update a card definition with new details.
+          # @param app_id [Integer] The ID of the target app.
           # @param card_id [String] The ID of the card to update.
-          # @param app_id [Object] The ID of the target app.
           # @param [Hash] opts the optional parameters
           # @option opts [CardPatchRequest] :card_patch_request Card definition fields to be updated.
           # @return [Array<(CardResponse, Integer, Hash)>] CardResponse data, response status code and response headers
-          def update_with_http_info(card_id, app_id, opts = {})
+          def update_with_http_info(app_id, card_id, opts = {})
             if @api_client.config.debugging
               @api_client.config.logger.debug 'Calling API: CardsApi.update ...'
             end
-            # verify the required parameter 'card_id' is set
-            if @api_client.config.client_side_validation && card_id.nil?
-              fail ArgumentError, "Missing the required parameter 'card_id' when calling CardsApi.update"
-            end
             # verify the required parameter 'app_id' is set
             if @api_client.config.client_side_validation && app_id.nil?
               fail ArgumentError, "Missing the required parameter 'app_id' when calling CardsApi.update"
             end
+            # verify the required parameter 'card_id' is set
+            if @api_client.config.client_side_validation && card_id.nil?
+              fail ArgumentError, "Missing the required parameter 'card_id' when calling CardsApi.update"
+            end
             # resource path
-            local_var_path = '/crm/v3/extensions/cards/{appId}/{cardId}'.sub('{' + 'cardId' + '}', CGI.escape(card_id.to_s).gsub('%2F', '/')).sub('{' + 'appId' + '}', CGI.escape(app_id.to_s).gsub('%2F', '/'))
+            local_var_path = '/crm/v3/extensions/cards/{appId}/{cardId}'.sub('{' + 'appId' + '}', CGI.escape(app_id.to_s)).sub('{' + 'cardId' + '}', CGI.escape(card_id.to_s))
 
             # query parameters
             query_params = opts[:query_params] || {}

data/lib/hubspot/codegen/crm/extensions/cards/api_client.rb

@@ -64,6 +64,7 @@ module Hubspot
                 conn.request :url_encoded
               end
               conn.adapter(Faraday.default_adapter)
+              conn.options[:params_encoder] = Faraday::FlatParamsEncoder
 
               # Errors handler settings
               if !config.error_handler.empty?

data/lib/hubspot/codegen/crm/extensions/cards/models/card_actions.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
+        # Configuration for custom user actions on cards.
         class CardActions
+          # A list of URL prefixes that will be accepted for card action URLs. If your data fetch response includes an action URL that doesn't begin with one of these values, it will result in an error and the card will not be displayed.
           attr_accessor :base_urls
 
           # Attribute mapping from ruby-style variable name to JSON key.

data/lib/hubspot/codegen/crm/extensions/cards/models/card_create_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
+        # State of card definition to be created
         class CardCreateRequest
+          # 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_display_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
 
@@ -16,7 +16,9 @@ module Hubspot
   module Crm
     module Extensions
       module Cards
+        # Configuration for displayed info on a card
         class CardDisplayBody
+          # Card display properties. These will will be rendered as \"label : value\" pairs in the card UI. See the [example card](#) in the overview docs for more details.
           attr_accessor :properties
 
           # Attribute mapping from ruby-style variable name to JSON key.

data/lib/hubspot/codegen/crm/extensions/cards/models/card_display_property.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
+        # Definition for a card display property.
         class CardDisplayProperty
+          # An internal identifier for this property. This value must be unique TODO.
           attr_accessor :name
 
+          # The label for this property as you'd like it displayed to users.
           attr_accessor :label
 
+          # Type of data represented by this property.
           attr_accessor :data_type
 
+          # An array of available options that can be displayed. Only used in when `dataType` is `STATUS`.
           attr_accessor :options
 
           class EnumAttributeValidator

data/lib/hubspot/codegen/crm/extensions/cards/models/card_fetch_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
 
@@ -16,9 +16,12 @@ module Hubspot
   module Crm
     module Extensions
       module Cards
+        # Configuration for this card's data fetch request.
         class CardFetchBody
+          # URL to a service endpoints that will respond with card details. HubSpot will call this endpoint each time a user visits a CRM record page where this card should be displayed.
           attr_accessor :target_url
 
+          # An array of CRM object types where this card should be displayed. HubSpot will call your data fetch URL whenever a user visits a record page of the types defined here.
           attr_accessor :object_types
 
           # Attribute mapping from ruby-style variable name to JSON key.

data/lib/hubspot/codegen/crm/extensions/cards/models/card_fetch_body_patch.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,9 +16,12 @@ module Hubspot
   module Crm
     module Extensions
       module Cards
+        # Variant of CardFetchBody with fields as optional for patches
         class CardFetchBodyPatch
+          # URL to a service endpoint that will respond with details for this card. HubSpot will call this endpoint each time a user visits a CRM record page where this card should be displayed.
           attr_accessor :target_url
 
+          # An array of CRM object types where this card should be displayed. HubSpot will call your target URL whenever a user visits a record page of the types defined here.
           attr_accessor :object_types
 
           # Attribute mapping from ruby-style variable name to JSON key.
@@ -225,4 +228,4 @@ module Hubspot
       end
     end
   end
-end
+end

data/lib/hubspot/codegen/crm/extensions/cards/models/card_list_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,7 +16,9 @@ module Hubspot
   module Crm
     module Extensions
       module Cards
+        # List of card definitions
         class CardListResponse
+          # List of card definitions
           attr_accessor :results
 
           # Attribute mapping from ruby-style variable name to JSON key.