hubspot-api-client 18.0.0 → 20.0.0.pre.beta.1

data/lib/hubspot/codegen/crm/extensions/calling/models/channel_connection_settings_response.rb

@@ -0,0 +1,276 @@
+=begin
+#CRM Calling Extensions
+
+#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 Extensions
+      module Calling
+        class ChannelConnectionSettingsResponse
+          # The timestamp this setting was created
+          attr_accessor :created_at
+
+          # If true, this app will be considered to support channel connection
+          attr_accessor :is_ready
+
+          # The URL to fetch phone numbers available for channel connection
+          attr_accessor :url
+
+          # The timestamp this setting was last updated
+          attr_accessor :updated_at
+
+          # Attribute mapping from ruby-style variable name to JSON key.
+          def self.attribute_map
+            {
+              :'created_at' => :'createdAt',
+              :'is_ready' => :'isReady',
+              :'url' => :'url',
+              :'updated_at' => :'updatedAt'
+            }
+          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
+            {
+              :'created_at' => :'Time',
+              :'is_ready' => :'Boolean',
+              :'url' => :'String',
+              :'updated_at' => :'Time'
+            }
+          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::Extensions::Calling::ChannelConnectionSettingsResponse` 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::Extensions::Calling::ChannelConnectionSettingsResponse`. 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?(:'created_at')
+              self.created_at = attributes[:'created_at']
+            end
+
+            if attributes.key?(:'is_ready')
+              self.is_ready = attributes[:'is_ready']
+            end
+
+            if attributes.key?(:'url')
+              self.url = attributes[:'url']
+            end
+
+            if attributes.key?(:'updated_at')
+              self.updated_at = attributes[:'updated_at']
+            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 @created_at.nil?
+              invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
+            end
+
+            if @is_ready.nil?
+              invalid_properties.push('invalid value for "is_ready", is_ready cannot be nil.')
+            end
+
+            if @url.nil?
+              invalid_properties.push('invalid value for "url", url cannot be nil.')
+            end
+
+            if @updated_at.nil?
+              invalid_properties.push('invalid value for "updated_at", updated_at 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 @created_at.nil?
+            return false if @is_ready.nil?
+            return false if @url.nil?
+            return false if @updated_at.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 &&
+                created_at == o.created_at &&
+                is_ready == o.is_ready &&
+                url == o.url &&
+                updated_at == o.updated_at
+          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
+            [created_at, is_ready, url, updated_at].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::Extensions::Calling.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
+end

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

@@ -1,7 +1,7 @@
 =begin
-#Calling Extensions
+#CRM Calling Extensions
 
-#Provides a way for apps to add custom calling options to a contact record. This works in conjunction with the [Calling SDK](#), which is used to build your phone/calling UI. The endpoints here allow your service to appear as an option to HubSpot users when they access the *Call* action on a contact record. Once accessed, your custom phone/calling UI will be displayed in an iframe at the specified URL with the specified dimensions on that record.
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
 The version of the OpenAPI document: v3
 

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

@@ -1,7 +1,7 @@
 =begin
-#Calling Extensions
+#CRM Calling Extensions
 
-#Provides a way for apps to add custom calling options to a contact record. This works in conjunction with the [Calling SDK](#), which is used to build your phone/calling UI. The endpoints here allow your service to appear as an option to HubSpot users when they access the *Call* action on a contact record. Once accessed, your custom phone/calling UI will be displayed in an iframe at the specified URL with the specified dimensions on that record.
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
 The version of the OpenAPI document: v3
 

data/lib/hubspot/codegen/crm/extensions/calling/models/mark_recording_as_ready_request.rb

@@ -0,0 +1,230 @@
+=begin
+#CRM Calling Extensions
+
+#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 Extensions
+      module Calling
+        class MarkRecordingAsReadyRequest
+          attr_accessor :engagement_id
+
+          # Attribute mapping from ruby-style variable name to JSON key.
+          def self.attribute_map
+            {
+              :'engagement_id' => :'engagementId'
+            }
+          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
+            {
+              :'engagement_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::Extensions::Calling::MarkRecordingAsReadyRequest` 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::Extensions::Calling::MarkRecordingAsReadyRequest`. 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?(:'engagement_id')
+              self.engagement_id = attributes[:'engagement_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 @engagement_id.nil?
+              invalid_properties.push('invalid value for "engagement_id", engagement_id 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 @engagement_id.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 &&
+                engagement_id == o.engagement_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
+            [engagement_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)
+            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::Extensions::Calling.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
+end

data/lib/hubspot/codegen/crm/extensions/calling/models/recording_settings_patch_request.rb

@@ -1,7 +1,7 @@
 =begin
-#Calling Extensions
+#CRM Calling Extensions
 
-#Provides a way for apps to add custom calling options to a contact record. This works in conjunction with the [Calling SDK](#), which is used to build your phone/calling UI. The endpoints here allow your service to appear as an option to HubSpot users when they access the *Call* action on a contact record. Once accessed, your custom phone/calling UI will be displayed in an iframe at the specified URL with the specified dimensions on that record.
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
 The version of the OpenAPI document: v3
 

data/lib/hubspot/codegen/crm/extensions/calling/models/recording_settings_request.rb

@@ -1,7 +1,7 @@
 =begin
-#Calling Extensions
+#CRM Calling Extensions
 
-#Provides a way for apps to add custom calling options to a contact record. This works in conjunction with the [Calling SDK](#), which is used to build your phone/calling UI. The endpoints here allow your service to appear as an option to HubSpot users when they access the *Call* action on a contact record. Once accessed, your custom phone/calling UI will be displayed in an iframe at the specified URL with the specified dimensions on that record.
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
 The version of the OpenAPI document: v3
 

data/lib/hubspot/codegen/crm/extensions/calling/models/recording_settings_response.rb

@@ -1,7 +1,7 @@
 =begin
-#Calling Extensions
+#CRM Calling Extensions
 
-#Provides a way for apps to add custom calling options to a contact record. This works in conjunction with the [Calling SDK](#), which is used to build your phone/calling UI. The endpoints here allow your service to appear as an option to HubSpot users when they access the *Call* action on a contact record. Once accessed, your custom phone/calling UI will be displayed in an iframe at the specified URL with the specified dimensions on that record.
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
 The version of the OpenAPI document: v3
 
@@ -18,6 +18,7 @@ module Hubspot
     module Extensions
       module Calling
         class RecordingSettingsResponse
+          # 
           attr_accessor :url_to_retrieve_authed_recording
 
           # Attribute mapping from ruby-style variable name to JSON key.

data/lib/hubspot/codegen/crm/extensions/calling/models/settings_patch_request.rb

@@ -1,7 +1,7 @@
 =begin
-#Calling Extensions
+#CRM Calling Extensions
 
-#Provides a way for apps to add custom calling options to a contact record. This works in conjunction with the [Calling SDK](#), which is used to build your phone/calling UI. The endpoints here allow your service to appear as an option to HubSpot users when they access the *Call* action on a contact record. Once accessed, your custom phone/calling UI will be displayed in an iframe at the specified URL with the specified dimensions on that record.
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
 The version of the OpenAPI document: v3
 
@@ -17,12 +17,14 @@ module Hubspot
   module Crm
     module Extensions
       module Calling
-        # Settings update request
         class SettingsPatchRequest
-          # When true, you are indicating that your service is compatible with engagement v2 service and can be used with custom objects.
+          # When true, users will be able to click to dial from custom objects.
           attr_accessor :supports_custom_objects
 
-          # When true, your service will appear as an option under the *Call* action in contact records of connected accounts.
+          # When false, this indicates that your calling app does not use the anchored calling remote within the HubSpot app. 
+          attr_accessor :uses_remote
+
+          # When true, this indicates that your calling app is ready for production. Users will be able to select your calling app as their provider and can then click to dial within HubSpot.
           attr_accessor :is_ready
 
           # The name of your calling service to display to users.
@@ -31,6 +33,12 @@ module Hubspot
           # The target width of the iframe that will contain your phone/calling UI.
           attr_accessor :width
 
+          # When false, this indicates that your calling app does not require the use of the separate calling window to hold the call connection. 
+          attr_accessor :uses_calling_window
+
+          # When true, this indicates that your calling app supports inbound calling within HubSpot.
+          attr_accessor :supports_inbound_calling
+
           # The URL to your phone/calling UI, built with the [Calling SDK](#).
           attr_accessor :url
 
@@ -41,9 +49,12 @@ module Hubspot
           def self.attribute_map
             {
               :'supports_custom_objects' => :'supportsCustomObjects',
+              :'uses_remote' => :'usesRemote',
               :'is_ready' => :'isReady',
               :'name' => :'name',
               :'width' => :'width',
+              :'uses_calling_window' => :'usesCallingWindow',
+              :'supports_inbound_calling' => :'supportsInboundCalling',
               :'url' => :'url',
               :'height' => :'height'
             }
@@ -58,9 +69,12 @@ module Hubspot
           def self.openapi_types
             {
               :'supports_custom_objects' => :'Boolean',
+              :'uses_remote' => :'Boolean',
               :'is_ready' => :'Boolean',
               :'name' => :'String',
               :'width' => :'Integer',
+              :'uses_calling_window' => :'Boolean',
+              :'supports_inbound_calling' => :'Boolean',
               :'url' => :'String',
               :'height' => :'Integer'
             }
@@ -91,6 +105,10 @@ module Hubspot
               self.supports_custom_objects = attributes[:'supports_custom_objects']
             end
 
+            if attributes.key?(:'uses_remote')
+              self.uses_remote = attributes[:'uses_remote']
+            end
+
             if attributes.key?(:'is_ready')
               self.is_ready = attributes[:'is_ready']
             end
@@ -103,6 +121,14 @@ module Hubspot
               self.width = attributes[:'width']
             end
 
+            if attributes.key?(:'uses_calling_window')
+              self.uses_calling_window = attributes[:'uses_calling_window']
+            end
+
+            if attributes.key?(:'supports_inbound_calling')
+              self.supports_inbound_calling = attributes[:'supports_inbound_calling']
+            end
+
             if attributes.key?(:'url')
               self.url = attributes[:'url']
             end
@@ -131,9 +157,12 @@ module Hubspot
             return true if self.equal?(o)
             self.class == o.class &&
                 supports_custom_objects == o.supports_custom_objects &&
+                uses_remote == o.uses_remote &&
                 is_ready == o.is_ready &&
                 name == o.name &&
                 width == o.width &&
+                uses_calling_window == o.uses_calling_window &&
+                supports_inbound_calling == o.supports_inbound_calling &&
                 url == o.url &&
                 height == o.height
           end
@@ -147,7 +176,7 @@ module Hubspot
           # Calculates hash code according to all attributes.
           # @return [Integer] Hash code
           def hash
-            [supports_custom_objects, is_ready, name, width, url, height].hash
+            [supports_custom_objects, uses_remote, is_ready, name, width, uses_calling_window, supports_inbound_calling, url, height].hash
           end
 
           # Builds the object from hash