hubspot-api-client 16.2.0 → 16.2.1

data/lib/hubspot/codegen/crm/associations/models/public_association_definition.rb

@@ -0,0 +1,242 @@
+=begin
+#Associations
+
+#Associations define the relationships between objects in HubSpot. These endpoints allow you to create, read, and remove associations.
+
+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 Associations
+      class PublicAssociationDefinition
+        attr_accessor :id
+
+        attr_accessor :name
+
+        # Attribute mapping from ruby-style variable name to JSON key.
+        def self.attribute_map
+          {
+            :'id' => :'id',
+            :'name' => :'name'
+          }
+        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
+          {
+            :'id' => :'String',
+            :'name' => :'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::Associations::PublicAssociationDefinition` 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::Associations::PublicAssociationDefinition`. 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?(:'name')
+            self.name = attributes[:'name']
+          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 @name.nil?
+            invalid_properties.push('invalid value for "name", name 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 @name.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 &&
+              name == o.name
+        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, name].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::Associations.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/crm/associations/models/public_association_multi.rb

@@ -22,11 +22,14 @@ module Hubspot
         # The IDs of objects that are associated with the object identified by the ID in 'from'.
         attr_accessor :to
 
+        attr_accessor :paging
+
         # Attribute mapping from ruby-style variable name to JSON key.
         def self.attribute_map
           {
             :'from' => :'from',
-            :'to' => :'to'
+            :'to' => :'to',
+            :'paging' => :'paging'
           }
         end
 
@@ -39,7 +42,8 @@ module Hubspot
         def self.openapi_types
           {
             :'from' => :'PublicObjectId',
-            :'to' => :'Array<AssociatedId>'
+            :'to' => :'Array<AssociatedId>',
+            :'paging' => :'Paging'
           }
         end
 
@@ -73,6 +77,10 @@ module Hubspot
               self.to = value
             end
           end
+
+          if attributes.key?(:'paging')
+            self.paging = attributes[:'paging']
+          end
         end
 
         # Show invalid properties with the reasons. Usually used together with valid?
@@ -104,7 +112,8 @@ module Hubspot
           return true if self.equal?(o)
           self.class == o.class &&
               from == o.from &&
-              to == o.to
+              to == o.to &&
+              paging == o.paging
         end
 
         # @see the `==` method
@@ -116,7 +125,7 @@ module Hubspot
         # Calculates hash code according to all attributes.
         # @return [Integer] Hash code
         def hash
-          [from, to].hash
+          [from, to, paging].hash
         end
 
         # Builds the object from hash

data/lib/hubspot/codegen/crm/extensions/accounting/models/accounting_app_settings.rb

@@ -17,6 +17,7 @@ module Hubspot
   module Crm
     module Extensions
       module Accounting
+        # The URL Settings, which defines the URL endpoints that HubSpot will send requests to an external accounting application for certain actions.
         class AccountingAppSettings
           # The ID of the accounting app. This is the identifier of the application created in your HubSpot developer portal.
           attr_accessor :app_id

data/lib/hubspot/codegen/crm/extensions/accounting/models/accounting_app_urls.rb

@@ -17,6 +17,7 @@ module Hubspot
   module Crm
     module Extensions
       module Accounting
+        # The URL endpoints that HubSpot will send requests to an external accounting system for certain actions.
         class AccountingAppUrls
           # A URL that specifies the endpoint where invoices can be retrieved.
           attr_accessor :get_invoice_url

data/lib/hubspot/codegen/crm/extensions/accounting/models/accounting_extension_customer.rb

@@ -17,6 +17,7 @@ module Hubspot
   module Crm
     module Extensions
       module Accounting
+        # Representation of a customer in the external accounting system.
         class AccountingExtensionCustomer
           # The customer's email address
           attr_accessor :email_address

data/lib/hubspot/codegen/crm/extensions/accounting/models/accounting_extension_invoice.rb

@@ -17,6 +17,7 @@ module Hubspot
   module Crm
     module Extensions
       module Accounting
+        # Representation of an invoice in the external accounting system.
         class AccountingExtensionInvoice
           # The total amount due.
           attr_accessor :amount_due

data/lib/hubspot/codegen/crm/extensions/accounting/models/accounting_extension_term.rb

@@ -17,6 +17,7 @@ module Hubspot
   module Crm
     module Extensions
       module Accounting
+        # Representation of payment terms that are defined in the external accounting system. One of 'dueDays' or 'dueDate' is required.
         class AccountingExtensionTerm
           # The due date for payment of the invoice, in ISO-8601 date format (yyyy-MM-dd)
           attr_accessor :due_date

data/lib/hubspot/codegen/crm/extensions/accounting/models/accounting_features.rb

@@ -17,6 +17,7 @@ module Hubspot
   module Crm
     module Extensions
       module Accounting
+        # Outlines the features that are supported by the external accounting system.
         class AccountingFeatures
           attr_accessor :create_invoice
 

data/lib/hubspot/codegen/crm/extensions/accounting/models/address.rb

@@ -17,6 +17,7 @@ module Hubspot
   module Crm
     module Extensions
       module Accounting
+        # Represents an address of a customer
         class Address
           # The country of the address.
           attr_accessor :country

data/lib/hubspot/codegen/crm/extensions/accounting/models/create_invoice_feature.rb

@@ -17,6 +17,7 @@ module Hubspot
   module Crm
     module Extensions
       module Accounting
+        # Indicates what elements of creating invoices in HubSpot is supported for the integration.
         class CreateInvoiceFeature
           # Indicates if creating invoices in HubSpot is supported for the integration.
           attr_accessor :enabled

data/lib/hubspot/codegen/crm/extensions/accounting/models/create_invoice_sub_features.rb

@@ -17,6 +17,7 @@ module Hubspot
   module Crm
     module Extensions
       module Accounting
+        # Lists the individual aspects of creating invoices that are enabled for the integration, as part of the create invoice flow in HubSpot.
         class CreateInvoiceSubFeatures
           # Indicates if a new customer can be created in the external accounting system.
           attr_accessor :create_customer

data/lib/hubspot/codegen/crm/extensions/accounting/models/create_user_account_request_external.rb

@@ -17,6 +17,7 @@ module Hubspot
   module Crm
     module Extensions
       module Accounting
+        # Information about the account in your external account system.
         class CreateUserAccountRequestExternal
           # The id of the account in your system.
           attr_accessor :account_id

data/lib/hubspot/codegen/crm/extensions/accounting/models/customer_search_response_external.rb

@@ -17,6 +17,7 @@ module Hubspot
   module Crm
     module Extensions
       module Accounting
+        # A response to a search for customers.
         class CustomerSearchResponseExternal
           # Designates if the response is a success ('OK') or failure ('ERR').
           attr_accessor :result

data/lib/hubspot/codegen/crm/extensions/accounting/models/exchange_rate_response.rb

@@ -17,6 +17,7 @@ module Hubspot
   module Crm
     module Extensions
       module Accounting
+        # A response to the request for an exchange rate value. It represents the exchange rate from the source currency to the target currency.
         class ExchangeRateResponse
           # Designates if the response is a success ('OK') or failure ('ERR').
           attr_accessor :result

data/lib/hubspot/codegen/crm/extensions/accounting/models/import_invoice_feature.rb

@@ -17,6 +17,7 @@ module Hubspot
   module Crm
     module Extensions
       module Accounting
+        # Indicates if importing invoices from the external account system into HubSpot is supported for the integration.
         class ImportInvoiceFeature
           # Indicates if importing invoices from the external account system into HubSpot.
           attr_accessor :enabled

data/lib/hubspot/codegen/crm/extensions/accounting/models/invoice_pdf_response.rb

@@ -17,6 +17,7 @@ module Hubspot
   module Crm
     module Extensions
       module Accounting
+        # A response that contains the PDF of an invoice
         class InvoicePdfResponse
           # Designates if the response is a success ('OK') or failure ('ERR').
           attr_accessor :result

data/lib/hubspot/codegen/crm/extensions/accounting/models/invoice_read_response.rb

@@ -17,6 +17,7 @@ module Hubspot
   module Crm
     module Extensions
       module Accounting
+        # The invoice data stored in HubSpot
         class InvoiceReadResponse
           # The invoice number. Note that this is _not_ the ID of the invoice, but the number that the billed customer will see.
           attr_accessor :external_invoice_number

data/lib/hubspot/codegen/crm/extensions/accounting/models/invoice_search_response.rb

@@ -17,6 +17,7 @@ module Hubspot
   module Crm
     module Extensions
       module Accounting
+        # A response to a search for invoices.
         class InvoiceSearchResponse
           # Designates if the response is a success ('OK') or failure ('ERR').
           attr_accessor :result

data/lib/hubspot/codegen/crm/extensions/accounting/models/invoice_update_request.rb

@@ -17,6 +17,7 @@ module Hubspot
   module Crm
     module Extensions
       module Accounting
+        # The invoice data to update in HubSpot
         class InvoiceUpdateRequest
           attr_accessor :external_invoice_number
 

data/lib/hubspot/codegen/crm/extensions/accounting/models/invoices_response_external.rb

@@ -17,6 +17,7 @@ module Hubspot
   module Crm
     module Extensions
       module Accounting
+        # A response to a request for invoices.
         class InvoicesResponseExternal
           # Designates if the response is a success ('OK') or failure ('ERR').
           attr_accessor :result

data/lib/hubspot/codegen/crm/extensions/accounting/models/product.rb

@@ -17,6 +17,7 @@ module Hubspot
   module Crm
     module Extensions
       module Accounting
+        # Representation of a product in the external accounting system.
         class Product
           attr_accessor :unit_price
 

data/lib/hubspot/codegen/crm/extensions/accounting/models/product_search_response.rb

@@ -17,6 +17,7 @@ module Hubspot
   module Crm
     module Extensions
       module Accounting
+        # A response to a search for products.
         class ProductSearchResponse
           # Designates if the response is a success ('OK') or failure ('ERR').
           attr_accessor :result

data/lib/hubspot/codegen/crm/extensions/accounting/models/result_id_accounting_response.rb

@@ -17,6 +17,7 @@ module Hubspot
   module Crm
     module Extensions
       module Accounting
+        # A response to the creation of an entity (eg. invoice, customer).
         class ResultIdAccountingResponse
           # Designates if the response is a success ('OK') or failure ('ERR').
           attr_accessor :result

data/lib/hubspot/codegen/crm/extensions/accounting/models/sync_contacts_request.rb

@@ -17,6 +17,7 @@ module Hubspot
   module Crm
     module Extensions
       module Accounting
+        # A request to import external accounting contact properties in HubSpot
         class SyncContactsRequest
           # The ID of the account in the external accounting system. This is the value that will be passed as `accountId` for all outbound calls for the user from HubSpot to the external accounting system.
           attr_accessor :account_id

data/lib/hubspot/codegen/crm/extensions/accounting/models/sync_products_request.rb

@@ -17,6 +17,7 @@ module Hubspot
   module Crm
     module Extensions
       module Accounting
+        # A request to import external accounting product properties in HubSpot
         class SyncProductsRequest
           # The ID of the account in the external accounting system. This is the value that will be passed as `accountId` for all outbound calls for the user from HubSpot to the external accounting system.
           attr_accessor :account_id

data/lib/hubspot/codegen/crm/extensions/accounting/models/tax.rb

@@ -17,6 +17,7 @@ module Hubspot
   module Crm
     module Extensions
       module Accounting
+        # Representation of a tax defined in the external accounting system.
         class Tax
           # The code/ID of the tax in the external accounting system.
           attr_accessor :code

data/lib/hubspot/codegen/crm/extensions/accounting/models/tax_search_response.rb

@@ -17,6 +17,7 @@ module Hubspot
   module Crm
     module Extensions
       module Accounting
+        # A response to a search for taxes.
         class TaxSearchResponse
           # Designates if the response is a success ('OK') or failure ('ERR').
           attr_accessor :result

data/lib/hubspot/codegen/crm/extensions/accounting/models/tax_type.rb

@@ -17,6 +17,7 @@ module Hubspot
   module Crm
     module Extensions
       module Accounting
+        # Represents a tax in the external accounting system.
         class TaxType
           # The code/ID of the tax in the external accounting system.
           attr_accessor :code

data/lib/hubspot/codegen/crm/extensions/accounting/models/terms_response.rb

@@ -17,6 +17,7 @@ module Hubspot
   module Crm
     module Extensions
       module Accounting
+        # A response to a search for payment terms.
         class TermsResponse
           # Designates if the response is a success ('OK') or failure ('ERR').
           attr_accessor :result

data/lib/hubspot/codegen/crm/extensions/accounting/models/unit_price.rb

@@ -17,6 +17,7 @@ module Hubspot
   module Crm
     module Extensions
       module Accounting
+        # Represents a unit price
         class UnitPrice
           # The actual unit price amount.
           attr_accessor :amount

data/lib/hubspot/codegen/crm/extensions/accounting/models/updated_contact.rb

@@ -17,6 +17,7 @@ module Hubspot
   module Crm
     module Extensions
       module Accounting
+        # A request to import external accounting contact properties in HubSpot
         class UpdatedContact
           # The operation to be performed.
           attr_accessor :sync_action

data/lib/hubspot/codegen/crm/extensions/accounting/models/updated_product.rb

@@ -17,6 +17,7 @@ module Hubspot
   module Crm
     module Extensions
       module Accounting
+        # A request to import external accounting product properties in HubSpot
         class UpdatedProduct
           # The operation to be performed.
           attr_accessor :sync_action

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

@@ -17,6 +17,7 @@ module Hubspot
   module Crm
     module Extensions
       module Calling
+        # Settings update request
         class SettingsPatchRequest
           # The name of your calling service to display to users.
           attr_accessor :name

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

@@ -17,6 +17,7 @@ module Hubspot
   module Crm
     module Extensions
       module Calling
+        # Settings create request
         class SettingsRequest
           # The name of your calling service to display to users.
           attr_accessor :name

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

@@ -17,6 +17,7 @@ module Hubspot
   module Crm
     module Extensions
       module Calling
+        # Current settings state
         class SettingsResponse
           # The name of your calling service to display to users.
           attr_accessor :name

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

@@ -17,6 +17,7 @@ module Hubspot
   module Crm
     module Extensions
       module Cards
+        # Configuration for custom user actions on cards.
         class CardActions
           # A list of URL prefixes that will be accepted for card action URLs. If your data fetch response includes an action URL that doesn't begin with one of these values, it will result in an error and the card will not be displayed.
           attr_accessor :base_urls

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

@@ -17,6 +17,7 @@ module Hubspot
   module Crm
     module Extensions
       module Cards
+        # State of card definition to be created
         class CardCreateRequest
           # The top-level title for this card. Displayed to users in the CRM UI.
           attr_accessor :title

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

@@ -17,6 +17,7 @@ module Hubspot
   module Crm
     module Extensions
       module Cards
+        # Configuration for displayed info on a card
         class CardDisplayBody
           # Card display properties. These will will be rendered as \"label : value\" pairs in the card UI. See the [example card](#) in the overview docs for more details.
           attr_accessor :properties

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

@@ -17,6 +17,7 @@ module Hubspot
   module Crm
     module Extensions
       module Cards
+        # Definition for a card display property.
         class CardDisplayProperty
           # An internal identifier for this property. This value must be unique TODO.
           attr_accessor :name

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

@@ -17,6 +17,7 @@ module Hubspot
   module Crm
     module Extensions
       module Cards
+        # Configuration for this card's data fetch request.
         class CardFetchBody
           # URL to a service endpoints that will respond with card details. HubSpot will call this endpoint each time a user visits a CRM record page where this card should be displayed.
           attr_accessor :target_url

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

@@ -17,6 +17,7 @@ module Hubspot
   module Crm
     module Extensions
       module Cards
+        # Variant of CardFetchBody with fields as optional for patches
         class CardFetchBodyPatch
           # URL to a service endpoint that will respond with details for this card. HubSpot will call this endpoint each time a user visits a CRM record page where this card should be displayed.
           attr_accessor :target_url