hubspot-api-client 19.0.0 → 20.0.0

data/lib/hubspot/codegen/crm/exports/api/public_exports_api.rb

@@ -0,0 +1,157 @@
+=begin
+#CRM Exports
+
+#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: 6.2.1
+
+=end
+
+require 'cgi'
+
+module Hubspot
+  module Crm
+    module Exports
+      class PublicExportsApi
+        attr_accessor :api_client
+
+        def initialize(api_client = ApiClient.default)
+          @api_client = api_client
+        end
+        # Get the status of the export including the URL to download the file
+        # Returns the status of the export with taskId, including the URL of the resulting file if the export status is COMPLETE
+        # @param task_id [Integer] 
+        # @param [Hash] opts the optional parameters
+        # @return [ActionResponseWithSingleResultURI]
+        def get_status(task_id, opts = {})
+          data, _status_code, _headers = get_status_with_http_info(task_id, opts)
+          data
+        end
+
+        # Get the status of the export including the URL to download the file
+        # Returns the status of the export with taskId, including the URL of the resulting file if the export status is COMPLETE
+        # @param task_id [Integer] 
+        # @param [Hash] opts the optional parameters
+        # @return [Array<(ActionResponseWithSingleResultURI, Integer, Hash)>] ActionResponseWithSingleResultURI data, response status code and response headers
+        def get_status_with_http_info(task_id, opts = {})
+          if @api_client.config.debugging
+            @api_client.config.logger.debug 'Calling API: PublicExportsApi.get_status ...'
+          end
+          # verify the required parameter 'task_id' is set
+          if @api_client.config.client_side_validation && task_id.nil?
+            fail ArgumentError, "Missing the required parameter 'task_id' when calling PublicExportsApi.get_status"
+          end
+          # resource path
+          local_var_path = '/crm/v3/exports/export/async/tasks/{taskId}/status'.sub('{' + 'taskId' + '}', CGI.escape(task_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[:debug_body]
+
+          # return_type
+          return_type = opts[:debug_return_type] || 'ActionResponseWithSingleResultURI'
+
+          # auth_names
+          auth_names = opts[:debug_auth_names] || ['oauth2']
+
+          new_options = opts.merge(
+            :operation => :"PublicExportsApi.get_status",
+            :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: PublicExportsApi#get_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+          end
+          return data, status_code, headers
+        end
+
+        # Start an export
+        # Begins exporting CRM data for the portal as specified in the request body
+        # @param public_export_request [PublicExportRequest] 
+        # @param [Hash] opts the optional parameters
+        # @return [TaskLocator]
+        def start(public_export_request, opts = {})
+          data, _status_code, _headers = start_with_http_info(public_export_request, opts)
+          data
+        end
+
+        # Start an export
+        # Begins exporting CRM data for the portal as specified in the request body
+        # @param public_export_request [PublicExportRequest] 
+        # @param [Hash] opts the optional parameters
+        # @return [Array<(TaskLocator, Integer, Hash)>] TaskLocator data, response status code and response headers
+        def start_with_http_info(public_export_request, opts = {})
+          if @api_client.config.debugging
+            @api_client.config.logger.debug 'Calling API: PublicExportsApi.start ...'
+          end
+          # verify the required parameter 'public_export_request' is set
+          if @api_client.config.client_side_validation && public_export_request.nil?
+            fail ArgumentError, "Missing the required parameter 'public_export_request' when calling PublicExportsApi.start"
+          end
+          # resource path
+          local_var_path = '/crm/v3/exports/export/async'
+
+          # query parameters
+          query_params = opts[:query_params] || {}
+
+          # header parameters
+          header_params = opts[:header_params] || {}
+          # HTTP header 'Accept' (if needed)
+          header_params['Accept'] = @api_client.select_header_accept(['application/json', '*/*'])
+          # HTTP header 'Content-Type'
+          content_type = @api_client.select_header_content_type(['application/json'])
+          if !content_type.nil?
+              header_params['Content-Type'] = content_type
+          end
+
+          # form parameters
+          form_params = opts[:form_params] || {}
+
+          # http body (model)
+          post_body = opts[:debug_body] || @api_client.object_to_http_body(public_export_request)
+
+          # return_type
+          return_type = opts[:debug_return_type] || 'TaskLocator'
+
+          # auth_names
+          auth_names = opts[:debug_auth_names] || ['oauth2']
+
+          new_options = opts.merge(
+            :operation => :"PublicExportsApi.start",
+            :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: PublicExportsApi#start\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+          end
+          return data, status_code, headers
+        end
+      end
+    end
+  end
+end

data/lib/hubspot/codegen/{cms/performance → crm/exports}/api_client.rb

@@ -1,7 +1,7 @@
 =begin
-#CMS Performance
+#CRM Exports
 
-#Use these endpoints to get a time series view of your website's performance.
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
 The version of the OpenAPI document: v3
 
@@ -18,8 +18,8 @@ require 'time'
 require 'typhoeus'
 
 module Hubspot
-  module Cms
-    module Performance
+  module Crm
+    module Exports
       class ApiClient
         # The Configuration object holding settings to be used in the API client.
         attr_accessor :config
@@ -294,7 +294,7 @@ module Hubspot
             end
           else
             # models (e.g. Pet) or oneOf
-            klass = Hubspot::Cms::Performance.const_get(return_type)
+            klass = Hubspot::Crm::Exports.const_get(return_type)
             klass.respond_to?(:openapi_one_of) ? klass.build(data) : klass.build_from_hash(data)
           end
         end

data/lib/hubspot/codegen/{cms/performance → crm/exports}/api_error.rb

@@ -1,7 +1,7 @@
 =begin
-#CMS Performance
+#CRM Exports
 
-#Use these endpoints to get a time series view of your website's performance.
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
 The version of the OpenAPI document: v3
 
@@ -11,8 +11,8 @@ OpenAPI Generator version: 6.2.1
 =end
 
 module Hubspot
-  module Cms
-    module Performance
+  module Crm
+    module Exports
       class ApiError < ::StandardError
         attr_reader :code, :response_headers, :response_body
 

data/lib/hubspot/codegen/{cms/performance → crm/exports}/configuration.rb

@@ -1,7 +1,7 @@
 =begin
-#CMS Performance
+#CRM Exports
 
-#Use these endpoints to get a time series view of your website's performance.
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
 The version of the OpenAPI document: v3
 
@@ -11,8 +11,8 @@ OpenAPI Generator version: 6.2.1
 =end
 
 module Hubspot
-  module Cms
-    module Performance
+  module Crm
+    module Exports
       class Configuration
         # Defines url scheme
         attr_accessor :scheme

data/lib/hubspot/codegen/crm/exports/models/action_response_with_single_result_uri.rb

@@ -0,0 +1,339 @@
+=begin
+#CRM Exports
+
+#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: 6.2.1
+
+=end
+
+require 'date'
+require 'time'
+
+module Hubspot
+  module Crm
+    module Exports
+      class ActionResponseWithSingleResultURI
+        attr_accessor :result
+
+        attr_accessor :completed_at
+
+        attr_accessor :num_errors
+
+        attr_accessor :requested_at
+
+        attr_accessor :started_at
+
+        attr_accessor :links
+
+        attr_accessor :errors
+
+        attr_accessor :status
+
+        class EnumAttributeValidator
+          attr_reader :datatype
+          attr_reader :allowable_values
+
+          def initialize(datatype, allowable_values)
+            @allowable_values = allowable_values.map do |value|
+              case datatype.to_s
+              when /Integer/i
+                value.to_i
+              when /Float/i
+                value.to_f
+              else
+                value
+              end
+            end
+          end
+
+          def valid?(value)
+            !value || allowable_values.include?(value)
+          end
+        end
+
+        # Attribute mapping from ruby-style variable name to JSON key.
+        def self.attribute_map
+          {
+            :'result' => :'result',
+            :'completed_at' => :'completedAt',
+            :'num_errors' => :'numErrors',
+            :'requested_at' => :'requestedAt',
+            :'started_at' => :'startedAt',
+            :'links' => :'links',
+            :'errors' => :'errors',
+            :'status' => :'status'
+          }
+        end
+
+        # Returns all the JSON keys this model knows about
+        def self.acceptable_attributes
+          attribute_map.values
+        end
+
+        # Attribute type mapping.
+        def self.openapi_types
+          {
+            :'result' => :'String',
+            :'completed_at' => :'Time',
+            :'num_errors' => :'Integer',
+            :'requested_at' => :'Time',
+            :'started_at' => :'Time',
+            :'links' => :'Hash<String, String>',
+            :'errors' => :'Array<StandardError>',
+            :'status' => :'String'
+          }
+        end
+
+        # List of attributes with nullable: true
+        def self.openapi_nullable
+          Set.new([
+          ])
+        end
+
+        # Initializes the object
+        # @param [Hash] attributes Model attributes in the form of hash
+        def initialize(attributes = {})
+          if (!attributes.is_a?(Hash))
+            fail ArgumentError, "The input argument (attributes) must be a hash in `Hubspot::Crm::Exports::ActionResponseWithSingleResultURI` initialize method"
+          end
+
+          # check to see if the attribute exists and convert string to symbol for hash key
+          attributes = attributes.each_with_object({}) { |(k, v), h|
+            if (!self.class.attribute_map.key?(k.to_sym))
+              fail ArgumentError, "`#{k}` is not a valid attribute in `Hubspot::Crm::Exports::ActionResponseWithSingleResultURI`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+            end
+            h[k.to_sym] = v
+          }
+
+          if attributes.key?(:'result')
+            self.result = attributes[:'result']
+          end
+
+          if attributes.key?(:'completed_at')
+            self.completed_at = attributes[:'completed_at']
+          end
+
+          if attributes.key?(:'num_errors')
+            self.num_errors = attributes[:'num_errors']
+          end
+
+          if attributes.key?(:'requested_at')
+            self.requested_at = attributes[:'requested_at']
+          end
+
+          if attributes.key?(:'started_at')
+            self.started_at = attributes[:'started_at']
+          end
+
+          if attributes.key?(:'links')
+            if (value = attributes[:'links']).is_a?(Hash)
+              self.links = value
+            end
+          end
+
+          if attributes.key?(:'errors')
+            if (value = attributes[:'errors']).is_a?(Array)
+              self.errors = value
+            end
+          end
+
+          if attributes.key?(:'status')
+            self.status = attributes[:'status']
+          end
+        end
+
+        # Show invalid properties with the reasons. Usually used together with valid?
+        # @return Array for valid properties with the reasons
+        def list_invalid_properties
+          invalid_properties = Array.new
+          if @completed_at.nil?
+            invalid_properties.push('invalid value for "completed_at", completed_at cannot be nil.')
+          end
+
+          if @started_at.nil?
+            invalid_properties.push('invalid value for "started_at", started_at cannot be nil.')
+          end
+
+          if @status.nil?
+            invalid_properties.push('invalid value for "status", status cannot be nil.')
+          end
+
+          invalid_properties
+        end
+
+        # Check to see if the all the properties in the model are valid
+        # @return true if the model is valid
+        def valid?
+          return false if @completed_at.nil?
+          return false if @started_at.nil?
+          return false if @status.nil?
+          status_validator = EnumAttributeValidator.new('String', ["PENDING", "PROCESSING", "CANCELED", "COMPLETE"])
+          return false unless status_validator.valid?(@status)
+          true
+        end
+
+        # Custom attribute writer method checking allowed values (enum).
+        # @param [Object] status Object to be assigned
+        def status=(status)
+          validator = EnumAttributeValidator.new('String', ["PENDING", "PROCESSING", "CANCELED", "COMPLETE"])
+          unless validator.valid?(status)
+            fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
+          end
+          @status = status
+        end
+
+        # Checks equality by comparing each attribute.
+        # @param [Object] Object to be compared
+        def ==(o)
+          return true if self.equal?(o)
+          self.class == o.class &&
+              result == o.result &&
+              completed_at == o.completed_at &&
+              num_errors == o.num_errors &&
+              requested_at == o.requested_at &&
+              started_at == o.started_at &&
+              links == o.links &&
+              errors == o.errors &&
+              status == o.status
+        end
+
+        # @see the `==` method
+        # @param [Object] Object to be compared
+        def eql?(o)
+          self == o
+        end
+
+        # Calculates hash code according to all attributes.
+        # @return [Integer] Hash code
+        def hash
+          [result, completed_at, num_errors, requested_at, started_at, links, errors, status].hash
+        end
+
+        # Builds the object from hash
+        # @param [Hash] attributes Model attributes in the form of hash
+        # @return [Object] Returns the model itself
+        def self.build_from_hash(attributes)
+          new.build_from_hash(attributes)
+        end
+
+        # Builds the object from hash
+        # @param [Hash] attributes Model attributes in the form of hash
+        # @return [Object] Returns the model itself
+        def build_from_hash(attributes)
+          return nil unless attributes.is_a?(Hash)
+          attributes = attributes.transform_keys(&:to_sym)
+          self.class.openapi_types.each_pair do |key, type|
+            if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+              self.send("#{key}=", nil)
+            elsif type =~ /\AArray<(.*)>/i
+              # check to ensure the input is an array given that the attribute
+              # is documented as an array but the input is not
+              if attributes[self.class.attribute_map[key]].is_a?(Array)
+                self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+              end
+            elsif !attributes[self.class.attribute_map[key]].nil?
+              self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+            end
+          end
+
+          self
+        end
+
+        # Deserializes the data based on type
+        # @param string type Data type
+        # @param string value Value to be deserialized
+        # @return [Object] Deserialized data
+        def _deserialize(type, value)
+          case type.to_sym
+          when :Time
+            Time.parse(value)
+          when :Date
+            Date.parse(value)
+          when :String
+            value.to_s
+          when :Integer
+            value.to_i
+          when :Float
+            value.to_f
+          when :Boolean
+            if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+              true
+            else
+              false
+            end
+          when :Object
+            # generic object (usually a Hash), return directly
+            value
+          when /\AArray<(?<inner_type>.+)>\z/
+            inner_type = Regexp.last_match[:inner_type]
+            value.map { |v| _deserialize(inner_type, v) }
+          when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+            k_type = Regexp.last_match[:k_type]
+            v_type = Regexp.last_match[:v_type]
+            {}.tap do |hash|
+              value.each do |k, v|
+                hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+              end
+            end
+          else # model
+            # models (e.g. Pet) or oneOf
+            klass = Hubspot::Crm::Exports.const_get(type)
+            klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+          end
+        end
+
+        # Returns the string representation of the object
+        # @return [String] String presentation of the object
+        def to_s
+          to_hash.to_s
+        end
+
+        # to_body is an alias to to_hash (backward compatibility)
+        # @return [Hash] Returns the object in the form of hash
+        def to_body
+          to_hash
+        end
+
+        # Returns the object in the form of hash
+        # @return [Hash] Returns the object in the form of hash
+        def to_hash
+          hash = {}
+          self.class.attribute_map.each_pair do |attr, param|
+            value = self.send(attr)
+            if value.nil?
+              is_nullable = self.class.openapi_nullable.include?(attr)
+              next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+            end
+
+            hash[param] = _to_hash(value)
+          end
+          hash
+        end
+
+        # Outputs non-array value in the form of hash
+        # For object, use to_hash. Otherwise, just return the value
+        # @param [Object] value Any valid value
+        # @return [Hash] Returns the value in the form of hash
+        def _to_hash(value)
+          if value.is_a?(Array)
+            value.compact.map { |v| _to_hash(v) }
+          elsif value.is_a?(Hash)
+            {}.tap do |hash|
+              value.each { |k, v| hash[k] = _to_hash(v) }
+            end
+          elsif value.respond_to? :to_hash
+            value.to_hash
+          else
+            value
+          end
+        end
+
+      end
+
+    end
+  end
+end

data/lib/hubspot/codegen/{cms/performance → crm/exports}/models/error.rb

@@ -1,7 +1,7 @@
 =begin
-#CMS Performance
+#CRM Exports
 
-#Use these endpoints to get a time series view of your website's performance.
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
 The version of the OpenAPI document: v3
 
@@ -14,8 +14,8 @@ require 'date'
 require 'time'
 
 module Hubspot
-  module Cms
-    module Performance
+  module Crm
+    module Exports
       class Error
         # A specific category that contains more specific detail about the error
         attr_accessor :sub_category
@@ -79,13 +79,13 @@ module Hubspot
         # @param [Hash] attributes Model attributes in the form of hash
         def initialize(attributes = {})
           if (!attributes.is_a?(Hash))
-            fail ArgumentError, "The input argument (attributes) must be a hash in `Hubspot::Cms::Performance::Error` initialize method"
+            fail ArgumentError, "The input argument (attributes) must be a hash in `Hubspot::Crm::Exports::Error` initialize method"
           end
 
           # check to see if the attribute exists and convert string to symbol for hash key
           attributes = attributes.each_with_object({}) { |(k, v), h|
             if (!self.class.attribute_map.key?(k.to_sym))
-              fail ArgumentError, "`#{k}` is not a valid attribute in `Hubspot::Cms::Performance::Error`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+              fail ArgumentError, "`#{k}` is not a valid attribute in `Hubspot::Crm::Exports::Error`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
             end
             h[k.to_sym] = v
           }
@@ -247,7 +247,7 @@ module Hubspot
             end
           else # model
             # models (e.g. Pet) or oneOf
-            klass = Hubspot::Cms::Performance.const_get(type)
+            klass = Hubspot::Crm::Exports.const_get(type)
             klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
           end
         end

data/lib/hubspot/codegen/{cms/performance → crm/exports}/models/error_detail.rb

@@ -1,7 +1,7 @@
 =begin
-#CMS Performance
+#CRM Exports
 
-#Use these endpoints to get a time series view of your website's performance.
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
 The version of the OpenAPI document: v3
 
@@ -14,8 +14,8 @@ require 'date'
 require 'time'
 
 module Hubspot
-  module Cms
-    module Performance
+  module Crm
+    module Exports
       class ErrorDetail
         # A specific category that contains more specific detail about the error
         attr_accessor :sub_category
@@ -69,13 +69,13 @@ module Hubspot
         # @param [Hash] attributes Model attributes in the form of hash
         def initialize(attributes = {})
           if (!attributes.is_a?(Hash))
-            fail ArgumentError, "The input argument (attributes) must be a hash in `Hubspot::Cms::Performance::ErrorDetail` initialize method"
+            fail ArgumentError, "The input argument (attributes) must be a hash in `Hubspot::Crm::Exports::ErrorDetail` initialize method"
           end
 
           # check to see if the attribute exists and convert string to symbol for hash key
           attributes = attributes.each_with_object({}) { |(k, v), h|
             if (!self.class.attribute_map.key?(k.to_sym))
-              fail ArgumentError, "`#{k}` is not a valid attribute in `Hubspot::Cms::Performance::ErrorDetail`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+              fail ArgumentError, "`#{k}` is not a valid attribute in `Hubspot::Crm::Exports::ErrorDetail`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
             end
             h[k.to_sym] = v
           }
@@ -213,7 +213,7 @@ module Hubspot
             end
           else # model
             # models (e.g. Pet) or oneOf
-            klass = Hubspot::Cms::Performance.const_get(type)
+            klass = Hubspot::Crm::Exports.const_get(type)
             klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
           end
         end