hubspot-api-client 11.2.0 → 12.0.0

data/lib/hubspot/codegen/crm/objects/calls/models/value_with_timestamp.rb

@@ -0,0 +1,272 @@
+=begin
+#Calls
+
+#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.3.1
+
+=end
+
+require 'date'
+
+module Hubspot
+  module Crm
+    module Objects
+      module Calls
+        class ValueWithTimestamp
+          attr_accessor :value
+
+          attr_accessor :timestamp
+
+          attr_accessor :source_type
+
+          attr_accessor :source_id
+
+          attr_accessor :source_label
+
+          attr_accessor :updated_by_user_id
+
+          # Attribute mapping from ruby-style variable name to JSON key.
+          def self.attribute_map
+            {
+              :'value' => :'value',
+              :'timestamp' => :'timestamp',
+              :'source_type' => :'sourceType',
+              :'source_id' => :'sourceId',
+              :'source_label' => :'sourceLabel',
+              :'updated_by_user_id' => :'updatedByUserId'
+            }
+          end
+
+          # Attribute type mapping.
+          def self.openapi_types
+            {
+              :'value' => :'String',
+              :'timestamp' => :'DateTime',
+              :'source_type' => :'String',
+              :'source_id' => :'String',
+              :'source_label' => :'String',
+              :'updated_by_user_id' => :'Integer'
+            }
+          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::Objects::Calls::ValueWithTimestamp` 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::Objects::Calls::ValueWithTimestamp`. 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?(:'value')
+              self.value = attributes[:'value']
+            end
+
+            if attributes.key?(:'timestamp')
+              self.timestamp = attributes[:'timestamp']
+            end
+
+            if attributes.key?(:'source_type')
+              self.source_type = attributes[:'source_type']
+            end
+
+            if attributes.key?(:'source_id')
+              self.source_id = attributes[:'source_id']
+            end
+
+            if attributes.key?(:'source_label')
+              self.source_label = attributes[:'source_label']
+            end
+
+            if attributes.key?(:'updated_by_user_id')
+              self.updated_by_user_id = attributes[:'updated_by_user_id']
+            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 @value.nil?
+              invalid_properties.push('invalid value for "value", value cannot be nil.')
+            end
+
+            if @timestamp.nil?
+              invalid_properties.push('invalid value for "timestamp", timestamp cannot be nil.')
+            end
+
+            if @source_type.nil?
+              invalid_properties.push('invalid value for "source_type", source_type 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 @value.nil?
+            return false if @timestamp.nil?
+            return false if @source_type.nil?
+            true
+          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 &&
+                value == o.value &&
+                timestamp == o.timestamp &&
+                source_type == o.source_type &&
+                source_id == o.source_id &&
+                source_label == o.source_label &&
+                updated_by_user_id == o.updated_by_user_id
+          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
+            [value, timestamp, source_type, source_id, source_label, updated_by_user_id].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)
+            self.class.openapi_types.each_pair do |key, type|
+              if 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 # or else data not found in attributes(hash), not an issue as the data can be optional
+            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 :DateTime
+              DateTime.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
+              Hubspot::Crm::Objects::Calls.const_get(type).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
+end

data/lib/hubspot/codegen/crm/objects/emails/api/associations_api.rb

@@ -0,0 +1,256 @@
+=begin
+#Emails
+
+#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.3.1
+
+=end
+
+require 'cgi'
+
+module Hubspot
+  module Crm
+    module Objects
+      module Emails
+        class AssociationsApi
+          attr_accessor :api_client
+
+          def initialize(api_client = ApiClient.default)
+            @api_client = api_client
+          end
+          # Remove an association between two emails
+          # @param email_id [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(email_id, to_object_type, to_object_id, association_type, opts = {})
+            archive_with_http_info(email_id, to_object_type, to_object_id, association_type, opts)
+            nil
+          end
+
+          # Remove an association between two emails
+          # @param email_id [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_with_http_info(email_id, to_object_type, to_object_id, association_type, opts = {})
+            if @api_client.config.debugging
+              @api_client.config.logger.debug 'Calling API: AssociationsApi.archive ...'
+            end
+            # verify the required parameter 'email_id' is set
+            if @api_client.config.client_side_validation && email_id.nil?
+              fail ArgumentError, "Missing the required parameter 'email_id' when calling AssociationsApi.archive"
+            end
+            # 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"
+            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"
+            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"
+            end
+            # resource path
+            local_var_path = '/crm/v3/objects/emails/{emailId}/associations/{toObjectType}/{toObjectId}/{associationType}'.sub('{' + 'emailId' + '}', CGI.escape(email_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] || {}
+
+            # header parameters
+            header_params = opts[:header_params] || {}
+            # HTTP header 'Accept' (if needed)
+            header_params['Accept'] = @api_client.select_header_accept(['*/*'])
+
+            # form parameters
+            form_params = opts[:form_params] || {}
+
+            # http body (model)
+            post_body = opts[:body] 
+
+            # return_type
+            return_type = opts[:return_type] 
+
+            # 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(:DELETE, local_var_path, new_options)
+            if @api_client.config.debugging
+              @api_client.config.logger.debug "API called: AssociationsApi#archive\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+            end
+            return data, status_code, headers
+          end
+
+          # Associate a email with another object
+          # @param email_id [String] 
+          # @param to_object_type [String] 
+          # @param to_object_id [String] 
+          # @param association_type [String] 
+          # @param [Hash] opts the optional parameters
+          # @return [SimplePublicObjectWithAssociations]
+          def create(email_id, to_object_type, to_object_id, association_type, opts = {})
+            data, _status_code, _headers = create_with_http_info(email_id, to_object_type, to_object_id, association_type, opts)
+            data
+          end
+
+          # Associate a email with another object
+          # @param email_id [String] 
+          # @param to_object_type [String] 
+          # @param to_object_id [String] 
+          # @param association_type [String] 
+          # @param [Hash] opts the optional parameters
+          # @return [Array<(SimplePublicObjectWithAssociations, Integer, Hash)>] SimplePublicObjectWithAssociations data, response status code and response headers
+          def create_with_http_info(email_id, to_object_type, to_object_id, association_type, opts = {})
+            if @api_client.config.debugging
+              @api_client.config.logger.debug 'Calling API: AssociationsApi.create ...'
+            end
+            # verify the required parameter 'email_id' is set
+            if @api_client.config.client_side_validation && email_id.nil?
+              fail ArgumentError, "Missing the required parameter 'email_id' when calling AssociationsApi.create"
+            end
+            # 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"
+            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"
+            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"
+            end
+            # resource path
+            local_var_path = '/crm/v3/objects/emails/{emailId}/associations/{toObjectType}/{toObjectId}/{associationType}'.sub('{' + 'emailId' + '}', CGI.escape(email_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] || {}
+
+            # 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] || 'SimplePublicObjectWithAssociations' 
+
+            # 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(:PUT, local_var_path, new_options)
+            if @api_client.config.debugging
+              @api_client.config.logger.debug "API called: AssociationsApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+            end
+            return data, status_code, headers
+          end
+
+          # List associations of a email by type
+          # @param email_id [String] 
+          # @param to_object_type [String] 
+          # @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 [Integer] :limit The maximum number of results to display per page. (default to 500)
+          # @return [CollectionResponseAssociatedIdForwardPaging]
+          def get_all(email_id, to_object_type, opts = {})
+            data, _status_code, _headers = get_all_with_http_info(email_id, to_object_type, opts)
+            data
+          end
+
+          # List associations of a email by type
+          # @param email_id [String] 
+          # @param to_object_type [String] 
+          # @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 [Integer] :limit The maximum number of results to display per page.
+          # @return [Array<(CollectionResponseAssociatedIdForwardPaging, Integer, Hash)>] CollectionResponseAssociatedIdForwardPaging data, response status code and response headers
+          def get_all_with_http_info(email_id, to_object_type, opts = {})
+            if @api_client.config.debugging
+              @api_client.config.logger.debug 'Calling API: AssociationsApi.get_all ...'
+            end
+            # verify the required parameter 'email_id' is set
+            if @api_client.config.client_side_validation && email_id.nil?
+              fail ArgumentError, "Missing the required parameter 'email_id' when calling AssociationsApi.get_all"
+            end
+            # 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_all"
+            end
+            # resource path
+            local_var_path = '/crm/v3/objects/emails/{emailId}/associations/{toObjectType}'.sub('{' + 'emailId' + '}', CGI.escape(email_id.to_s)).sub('{' + 'toObjectType' + '}', CGI.escape(to_object_type.to_s))
+
+            # query parameters
+            query_params = opts[:query_params] || {}
+            query_params[:'after'] = opts[:'after'] if !opts[:'after'].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] || 'CollectionResponseAssociatedIdForwardPaging' 
+
+            # 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: AssociationsApi#get_all\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+            end
+            return data, status_code, headers
+          end
+        end
+      end
+    end
+  end
+end