hubspot-api-client 1.0.1 → 2.0.0

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

@@ -0,0 +1,303 @@
+=begin
+#CRM cards
+
+#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.3
+
+=end
+
+require 'date'
+
+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
+
+          # URL to a page the integrator has built that displays all details for this card. This URL will be displayed to users under a `See more [x]` link if there are more than five items in your response, where `[x]` is the value of `itemLabel`.
+          attr_accessor :all_items_link_url
+
+          # The label to be used for the `allItemsLinkUrl` link (e.g. 'See more tickets'). If not provided, this falls back to the card's title.
+          attr_accessor :card_label
+
+          attr_accessor :top_level_actions
+
+          # A list of up to five valid card sub categories.
+          attr_accessor :sections
+
+          attr_accessor :response_version
+
+          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
+            {
+              :'total_count' => :'totalCount',
+              :'all_items_link_url' => :'allItemsLinkUrl',
+              :'card_label' => :'cardLabel',
+              :'top_level_actions' => :'topLevelActions',
+              :'sections' => :'sections',
+              :'response_version' => :'responseVersion'
+            }
+          end
+
+          # Attribute type mapping.
+          def self.openapi_types
+            {
+              :'total_count' => :'Integer',
+              :'all_items_link_url' => :'String',
+              :'card_label' => :'String',
+              :'top_level_actions' => :'TopLevelActions',
+              :'sections' => :'Array<IntegratorObjectResult>',
+              :'response_version' => :'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::Extensions::Cards::IntegratorCardPayloadResponse` 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::Cards::IntegratorCardPayloadResponse`. 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?(:'total_count')
+              self.total_count = attributes[:'total_count']
+            end
+
+            if attributes.key?(:'all_items_link_url')
+              self.all_items_link_url = attributes[:'all_items_link_url']
+            end
+
+            if attributes.key?(:'card_label')
+              self.card_label = attributes[:'card_label']
+            end
+
+            if attributes.key?(:'top_level_actions')
+              self.top_level_actions = attributes[:'top_level_actions']
+            end
+
+            if attributes.key?(:'sections')
+              if (value = attributes[:'sections']).is_a?(Array)
+                self.sections = value
+              end
+            end
+
+            if attributes.key?(:'response_version')
+              self.response_version = attributes[:'response_version']
+            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 @total_count.nil?
+              invalid_properties.push('invalid value for "total_count", total_count 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 @total_count.nil?
+            response_version_validator = EnumAttributeValidator.new('String', ["v1", "v3"])
+            return false unless response_version_validator.valid?(@response_version)
+            true
+          end
+
+          # Custom attribute writer method checking allowed values (enum).
+          # @param [Object] response_version Object to be assigned
+          def response_version=(response_version)
+            validator = EnumAttributeValidator.new('String', ["v1", "v3"])
+            unless validator.valid?(response_version)
+              fail ArgumentError, "invalid value for \"response_version\", must be one of #{validator.allowable_values}."
+            end
+            @response_version = response_version
+          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 &&
+                total_count == o.total_count &&
+                all_items_link_url == o.all_items_link_url &&
+                card_label == o.card_label &&
+                top_level_actions == o.top_level_actions &&
+                sections == o.sections &&
+                response_version == o.response_version
+          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
+            [total_count, all_items_link_url, card_label, top_level_actions, sections, response_version].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::Extensions::Cards.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/extensions/cards/models/integrator_object_result.rb

@@ -0,0 +1,272 @@
+=begin
+#CRM cards
+
+#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.3
+
+=end
+
+require 'date'
+
+module Hubspot
+  module Crm
+    module Extensions
+      module Cards
+        class IntegratorObjectResult
+          attr_accessor :id
+
+          attr_accessor :title
+
+          attr_accessor :link_url
+
+          attr_accessor :tokens
+
+          attr_accessor :actions
+
+          # Attribute mapping from ruby-style variable name to JSON key.
+          def self.attribute_map
+            {
+              :'id' => :'id',
+              :'title' => :'title',
+              :'link_url' => :'linkUrl',
+              :'tokens' => :'tokens',
+              :'actions' => :'actions'
+            }
+          end
+
+          # Attribute type mapping.
+          def self.openapi_types
+            {
+              :'id' => :'String',
+              :'title' => :'String',
+              :'link_url' => :'String',
+              :'tokens' => :'Array<ObjectToken>',
+              :'actions' => :'Array<AnyOfActionHookActionBodyIFrameActionBody>'
+            }
+          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::Cards::IntegratorObjectResult` 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::Cards::IntegratorObjectResult`. 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?(:'id')
+              self.id = attributes[:'id']
+            end
+
+            if attributes.key?(:'title')
+              self.title = attributes[:'title']
+            end
+
+            if attributes.key?(:'link_url')
+              self.link_url = attributes[:'link_url']
+            end
+
+            if attributes.key?(:'tokens')
+              if (value = attributes[:'tokens']).is_a?(Array)
+                self.tokens = value
+              end
+            end
+
+            if attributes.key?(:'actions')
+              if (value = attributes[:'actions']).is_a?(Array)
+                self.actions = value
+              end
+            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 @id.nil?
+              invalid_properties.push('invalid value for "id", id cannot be nil.')
+            end
+
+            if @title.nil?
+              invalid_properties.push('invalid value for "title", title cannot be nil.')
+            end
+
+            if @tokens.nil?
+              invalid_properties.push('invalid value for "tokens", tokens cannot be nil.')
+            end
+
+            if @actions.nil?
+              invalid_properties.push('invalid value for "actions", actions 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 @id.nil?
+            return false if @title.nil?
+            return false if @tokens.nil?
+            return false if @actions.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 &&
+                id == o.id &&
+                title == o.title &&
+                link_url == o.link_url &&
+                tokens == o.tokens &&
+                actions == o.actions
+          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
+            [id, title, link_url, tokens, actions].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::Extensions::Cards.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