hubspot-api-client 2.3.2 → 3.3.0

data/lib/hubspot/codegen/crm/extensions/cards/api_error.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
 
@@ -60,4 +60,4 @@ module Hubspot
       end
     end
   end
-end
+end

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

@@ -257,4 +257,4 @@ module Hubspot
       end
     end
   end
-end
+end

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

@@ -242,4 +242,4 @@ module Hubspot
       end
     end
   end
-end
+end

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

@@ -324,4 +324,4 @@ module Hubspot
       end
     end
   end
-end
+end

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

@@ -16,7 +16,6 @@ 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
@@ -218,4 +217,4 @@ module Hubspot
       end
     end
   end
-end
+end

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

@@ -16,7 +16,6 @@ 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
@@ -258,4 +257,4 @@ module Hubspot
       end
     end
   end
-end
+end

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

@@ -16,7 +16,6 @@ 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
@@ -218,4 +217,4 @@ module Hubspot
       end
     end
   end
-end
+end

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

@@ -16,7 +16,6 @@ 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
@@ -297,4 +296,4 @@ module Hubspot
       end
     end
   end
-end
+end

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

@@ -16,7 +16,6 @@ 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
@@ -233,4 +232,4 @@ module Hubspot
       end
     end
   end
-end
+end

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

@@ -16,7 +16,6 @@ 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

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

@@ -16,7 +16,6 @@ module Hubspot
   module Crm
     module Extensions
       module Cards
-        # List of card definitions
         class CardListResponse
           # List of card definitions
           attr_accessor :results
@@ -218,4 +217,4 @@ module Hubspot
       end
     end
   end
-end
+end

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

@@ -266,4 +266,4 @@ module Hubspot
       end
     end
   end
-end
+end

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

@@ -16,7 +16,6 @@ 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
@@ -238,4 +237,4 @@ module Hubspot
       end
     end
   end
-end
+end

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

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

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

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

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

@@ -291,4 +291,4 @@ module Hubspot
       end
     end
   end
-end
+end

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

@@ -257,4 +257,4 @@ module Hubspot
       end
     end
   end
-end
+end

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

@@ -317,4 +317,4 @@ module Hubspot
       end
     end
   end
-end
+end

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

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

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

@@ -45,7 +45,7 @@ module Hubspot
               :'title' => :'String',
               :'link_url' => :'String',
               :'tokens' => :'Array<ObjectToken>',
-              :'actions' => :'Array<AnyOfActionHookActionBodyIFrameActionBody>'
+              :'actions' => :'Array<OneOfActionHookActionBodyIFrameActionBody>'
             }
           end
 
@@ -269,4 +269,4 @@ module Hubspot
       end
     end
   end
-end
+end

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

@@ -275,4 +275,4 @@ module Hubspot
       end
     end
   end
-end
+end

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

@@ -37,7 +37,7 @@ module Hubspot
             {
               :'settings' => :'IFrameActionBody',
               :'primary' => :'OneOfActionHookActionBodyIFrameActionBody',
-              :'secondary' => :'Array<AnyOfActionHookActionBodyIFrameActionBody>'
+              :'secondary' => :'Array<OneOfActionHookActionBodyIFrameActionBody>'
             }
           end
 
@@ -234,4 +234,4 @@ module Hubspot
       end
     end
   end
-end
+end

data/lib/hubspot/codegen/crm/imports/api/core_api.rb

@@ -0,0 +1,279 @@
+=begin
+#CRM Imports
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: v3
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.2.3
+
+=end
+
+require 'cgi'
+
+module Hubspot
+  module Crm
+    module Imports
+      class CoreApi
+        attr_accessor :api_client
+
+        def initialize(api_client = ApiClient.default)
+          @api_client = api_client
+        end
+        # Cancel an active import
+        # This allows a developer to cancel an active import.
+        # @param import_id [Integer] 
+        # @param [Hash] opts the optional parameters
+        # @return [ActionResponse]
+        def cancel(import_id, opts = {})
+          data, _status_code, _headers = cancel_with_http_info(import_id, opts)
+          data
+        end
+
+        # Cancel an active import
+        # This allows a developer to cancel an active import.
+        # @param import_id [Integer] 
+        # @param [Hash] opts the optional parameters
+        # @return [Array<(ActionResponse, Integer, Hash)>] ActionResponse data, response status code and response headers
+        def cancel_with_http_info(import_id, opts = {})
+          if @api_client.config.debugging
+            @api_client.config.logger.debug 'Calling API: CoreApi.cancel ...'
+          end
+          # verify the required parameter 'import_id' is set
+          if @api_client.config.client_side_validation && import_id.nil?
+            fail ArgumentError, "Missing the required parameter 'import_id' when calling CoreApi.cancel"
+          end
+          # resource path
+          local_var_path = '/crm/v3/imports/{importId}/cancel'.sub('{' + 'importId' + '}', CGI.escape(import_id.to_s))
+
+          # 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', '*/*'])
+
+          # form parameters
+          form_params = opts[:form_params] || {}
+
+          # http body (model)
+          post_body = opts[:body] 
+
+          # return_type
+          return_type = opts[:return_type] || 'ActionResponse' 
+
+          # auth_names
+          auth_names = opts[:auth_names] || ['hapikey', 'oauth2']
+
+          new_options = opts.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: CoreApi#cancel\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+          end
+          return data, status_code, headers
+        end
+
+        # Start a new import
+        # Begins importing data from the specified file resources. This uploads the corresponding file and uses the import request object to convert rows in the files to objects.
+        # @param [Hash] opts the optional parameters
+        # @option opts [String] :import_request JSON formatted metadata about the import. This includes a name for the import and the column mappings for each file. See [this page]() for more on the required format.
+        # @option opts [File] :files A list of files containing the data to import
+        # @return [PublicImportResponse]
+        def create(opts = {})
+          data, _status_code, _headers = create_with_http_info(opts)
+          data
+        end
+
+        # Start a new import
+        # Begins importing data from the specified file resources. This uploads the corresponding file and uses the import request object to convert rows in the files to objects.
+        # @param [Hash] opts the optional parameters
+        # @option opts [String] :import_request JSON formatted metadata about the import. This includes a name for the import and the column mappings for each file. See [this page]() for more on the required format.
+        # @option opts [File] :files A list of files containing the data to import
+        # @return [Array<(PublicImportResponse, Integer, Hash)>] PublicImportResponse data, response status code and response headers
+        def create_with_http_info(opts = {})
+          if @api_client.config.debugging
+            @api_client.config.logger.debug 'Calling API: CoreApi.create ...'
+          end
+          # resource path
+          local_var_path = '/crm/v3/imports/'
+
+          # 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'
+          header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
+
+          # form parameters
+          form_params = opts[:form_params] || {}
+          form_params['importRequest'] = opts[:'import_request'] if !opts[:'import_request'].nil?
+          form_params['files'] = opts[:'files'] if !opts[:'files'].nil?
+
+          # http body (model)
+          post_body = opts[:body] 
+
+          # return_type
+          return_type = opts[:return_type] || 'PublicImportResponse' 
+
+          # auth_names
+          auth_names = opts[:auth_names] || ['hapikey', 'oauth2']
+
+          new_options = opts.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: CoreApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+          end
+          return data, status_code, headers
+        end
+
+        # Get the information on any import
+        # A complete summary of an import record, including any updates.
+        # @param import_id [Integer] 
+        # @param [Hash] opts the optional parameters
+        # @return [PublicImportResponse]
+        def get_by_id(import_id, opts = {})
+          data, _status_code, _headers = get_by_id_with_http_info(import_id, opts)
+          data
+        end
+
+        # Get the information on any import
+        # A complete summary of an import record, including any updates.
+        # @param import_id [Integer] 
+        # @param [Hash] opts the optional parameters
+        # @return [Array<(PublicImportResponse, Integer, Hash)>] PublicImportResponse data, response status code and response headers
+        def get_by_id_with_http_info(import_id, opts = {})
+          if @api_client.config.debugging
+            @api_client.config.logger.debug 'Calling API: CoreApi.get_by_id ...'
+          end
+          # verify the required parameter 'import_id' is set
+          if @api_client.config.client_side_validation && import_id.nil?
+            fail ArgumentError, "Missing the required parameter 'import_id' when calling CoreApi.get_by_id"
+          end
+          # resource path
+          local_var_path = '/crm/v3/imports/{importId}'.sub('{' + 'importId' + '}', CGI.escape(import_id.to_s))
+
+          # 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', '*/*'])
+
+          # form parameters
+          form_params = opts[:form_params] || {}
+
+          # http body (model)
+          post_body = opts[:body] 
+
+          # return_type
+          return_type = opts[:return_type] || 'PublicImportResponse' 
+
+          # auth_names
+          auth_names = opts[:auth_names] || ['hapikey', 'oauth2']
+
+          new_options = opts.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(:GET, local_var_path, new_options)
+          if @api_client.config.debugging
+            @api_client.config.logger.debug "API called: CoreApi#get_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+          end
+          return data, status_code, headers
+        end
+
+        # Get active imports
+        # Returns a paged list of active imports for this account.
+        # @param [Hash] opts the optional parameters
+        # @option opts [String] :after The paging cursor token of the last successfully read resource will be returned as the &#x60;paging.next.after&#x60; JSON property of a paged response containing more results.
+        # @option opts [String] :before 
+        # @option opts [Integer] :limit The maximum number of results to display per page.
+        # @return [CollectionResponsePublicImportResponse]
+        def get_page(opts = {})
+          data, _status_code, _headers = get_page_with_http_info(opts)
+          data
+        end
+
+        # Get active imports
+        # Returns a paged list of active imports for this account.
+        # @param [Hash] opts the optional parameters
+        # @option opts [String] :after The paging cursor token of the last successfully read resource will be returned as the &#x60;paging.next.after&#x60; JSON property of a paged response containing more results.
+        # @option opts [String] :before 
+        # @option opts [Integer] :limit The maximum number of results to display per page.
+        # @return [Array<(CollectionResponsePublicImportResponse, Integer, Hash)>] CollectionResponsePublicImportResponse data, response status code and response headers
+        def get_page_with_http_info(opts = {})
+          if @api_client.config.debugging
+            @api_client.config.logger.debug 'Calling API: CoreApi.get_page ...'
+          end
+          # resource path
+          local_var_path = '/crm/v3/imports/'
+
+          # query parameters
+          query_params = opts[:query_params] || {}
+          query_params[:'after'] = opts[:'after'] if !opts[:'after'].nil?
+          query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
+          query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+
+          # header parameters
+          header_params = opts[:header_params] || {}
+          # HTTP header 'Accept' (if needed)
+          header_params['Accept'] = @api_client.select_header_accept(['application/json', '*/*'])
+
+          # form parameters
+          form_params = opts[:form_params] || {}
+
+          # http body (model)
+          post_body = opts[:body] 
+
+          # return_type
+          return_type = opts[:return_type] || 'CollectionResponsePublicImportResponse' 
+
+          # auth_names
+          auth_names = opts[:auth_names] || ['hapikey', 'oauth2']
+
+          new_options = opts.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(:GET, local_var_path, new_options)
+          if @api_client.config.debugging
+            @api_client.config.logger.debug "API called: CoreApi#get_page\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+          end
+          return data, status_code, headers
+        end
+      end
+    end
+  end
+end