hubspot-api-client 17.2.0 → 18.0.0

data/lib/hubspot/codegen/crm/pipelines/models/pipeline_stage.rb

@@ -1,5 +1,5 @@
 =begin
-#CRM Pipelines
+#Pipelines
 
 #Pipelines represent distinct stages in a workflow, like closing a deal or servicing a support ticket. These endpoints provide access to read and modify pipelines in HubSpot. Pipelines support `deals` and `tickets` object types.  ## Pipeline ID validation  When calling endpoints that take pipelineId as a parameter, that ID must correspond to an existing, un-archived pipeline. Otherwise the request will fail with a `404 Not Found` response.
 
@@ -17,41 +17,66 @@ module Hubspot
   module Crm
     module Pipelines
       class PipelineStage
-        # A label used to organize pipeline stages in HubSpot's UI. Each pipeline stage's label must be unique within that pipeline.
-        attr_accessor :label
+        # The date the pipeline stage was created. The stages on default pipelines will have createdAt = 0.
+        attr_accessor :created_at
 
-        # The order for displaying this pipeline stage. If two pipeline stages have a matching `displayOrder`, they will be sorted alphabetically by label.
-        attr_accessor :display_order
+        # The date the pipeline was archived. `archivedAt` will only be present if the pipeline is archived.
+        attr_accessor :archived_at
+
+        # Whether the pipeline is archived.
+        attr_accessor :archived
 
         # A JSON object containing properties that are not present on all object pipelines.  For `deals` pipelines, the `probability` field is required (`{ \"probability\": 0.5 }`), and represents the likelihood a deal will close. Possible values are between 0.0 and 1.0 in increments of 0.1.  For `tickets` pipelines, the `ticketState` field is optional (`{ \"ticketState\": \"OPEN\" }`), and represents whether the ticket remains open or has been closed by a member of your Support team. Possible values are `OPEN` or `CLOSED`.
         attr_accessor :metadata
 
-        # A unique identifier generated by HubSpot that can be used to retrieve and update the pipeline stage.
-        attr_accessor :id
+        # The order for displaying this pipeline stage. If two pipeline stages have a matching `displayOrder`, they will be sorted alphabetically by label.
+        attr_accessor :display_order
 
-        # The date the pipeline stage was created. The stages on default pipelines will have createdAt = 0.
-        attr_accessor :created_at
+        attr_accessor :write_permissions
 
-        # The date the pipeline was archived. `archivedAt` will only be present if the pipeline is archived.
-        attr_accessor :archived_at
+        # A label used to organize pipeline stages in HubSpot's UI. Each pipeline stage's label must be unique within that pipeline.
+        attr_accessor :label
+
+        # A unique identifier generated by HubSpot that can be used to retrieve and update the pipeline stage.
+        attr_accessor :id
 
         # The date the pipeline stage was last updated.
         attr_accessor :updated_at
 
-        # Whether the pipeline is archived.
-        attr_accessor :archived
+        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
           {
-            :'label' => :'label',
-            :'display_order' => :'displayOrder',
-            :'metadata' => :'metadata',
-            :'id' => :'id',
             :'created_at' => :'createdAt',
             :'archived_at' => :'archivedAt',
-            :'updated_at' => :'updatedAt',
-            :'archived' => :'archived'
+            :'archived' => :'archived',
+            :'metadata' => :'metadata',
+            :'display_order' => :'displayOrder',
+            :'write_permissions' => :'writePermissions',
+            :'label' => :'label',
+            :'id' => :'id',
+            :'updated_at' => :'updatedAt'
           }
         end
 
@@ -63,14 +88,15 @@ module Hubspot
         # Attribute type mapping.
         def self.openapi_types
           {
-            :'label' => :'String',
-            :'display_order' => :'Integer',
-            :'metadata' => :'Hash<String, String>',
-            :'id' => :'String',
             :'created_at' => :'Time',
             :'archived_at' => :'Time',
-            :'updated_at' => :'Time',
-            :'archived' => :'Boolean'
+            :'archived' => :'Boolean',
+            :'metadata' => :'Hash<String, String>',
+            :'display_order' => :'Integer',
+            :'write_permissions' => :'String',
+            :'label' => :'String',
+            :'id' => :'String',
+            :'updated_at' => :'Time'
           }
         end
 
@@ -95,12 +121,16 @@ module Hubspot
             h[k.to_sym] = v
           }
 
-          if attributes.key?(:'label')
-            self.label = attributes[:'label']
+          if attributes.key?(:'created_at')
+            self.created_at = attributes[:'created_at']
           end
 
-          if attributes.key?(:'display_order')
-            self.display_order = attributes[:'display_order']
+          if attributes.key?(:'archived_at')
+            self.archived_at = attributes[:'archived_at']
+          end
+
+          if attributes.key?(:'archived')
+            self.archived = attributes[:'archived']
           end
 
           if attributes.key?(:'metadata')
@@ -109,24 +139,24 @@ module Hubspot
             end
           end
 
-          if attributes.key?(:'id')
-            self.id = attributes[:'id']
+          if attributes.key?(:'display_order')
+            self.display_order = attributes[:'display_order']
           end
 
-          if attributes.key?(:'created_at')
-            self.created_at = attributes[:'created_at']
+          if attributes.key?(:'write_permissions')
+            self.write_permissions = attributes[:'write_permissions']
           end
 
-          if attributes.key?(:'archived_at')
-            self.archived_at = attributes[:'archived_at']
+          if attributes.key?(:'label')
+            self.label = attributes[:'label']
           end
 
-          if attributes.key?(:'updated_at')
-            self.updated_at = attributes[:'updated_at']
+          if attributes.key?(:'id')
+            self.id = attributes[:'id']
           end
 
-          if attributes.key?(:'archived')
-            self.archived = attributes[:'archived']
+          if attributes.key?(:'updated_at')
+            self.updated_at = attributes[:'updated_at']
           end
         end
 
@@ -134,32 +164,32 @@ module Hubspot
         # @return Array for valid properties with the reasons
         def list_invalid_properties
           invalid_properties = Array.new
-          if @label.nil?
-            invalid_properties.push('invalid value for "label", label cannot be nil.')
+          if @created_at.nil?
+            invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
           end
 
-          if @display_order.nil?
-            invalid_properties.push('invalid value for "display_order", display_order cannot be nil.')
+          if @archived.nil?
+            invalid_properties.push('invalid value for "archived", archived cannot be nil.')
           end
 
           if @metadata.nil?
             invalid_properties.push('invalid value for "metadata", metadata cannot be nil.')
           end
 
-          if @id.nil?
-            invalid_properties.push('invalid value for "id", id cannot be nil.')
+          if @display_order.nil?
+            invalid_properties.push('invalid value for "display_order", display_order cannot be nil.')
           end
 
-          if @created_at.nil?
-            invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
+          if @label.nil?
+            invalid_properties.push('invalid value for "label", label cannot be nil.')
           end
 
-          if @updated_at.nil?
-            invalid_properties.push('invalid value for "updated_at", updated_at cannot be nil.')
+          if @id.nil?
+            invalid_properties.push('invalid value for "id", id cannot be nil.')
           end
 
-          if @archived.nil?
-            invalid_properties.push('invalid value for "archived", archived cannot be nil.')
+          if @updated_at.nil?
+            invalid_properties.push('invalid value for "updated_at", updated_at cannot be nil.')
           end
 
           invalid_properties
@@ -168,29 +198,42 @@ module Hubspot
         # 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 @label.nil?
-          return false if @display_order.nil?
+          return false if @created_at.nil?
+          return false if @archived.nil?
           return false if @metadata.nil?
+          return false if @display_order.nil?
+          write_permissions_validator = EnumAttributeValidator.new('String', ["CRM_PERMISSIONS_ENFORCEMENT", "READ_ONLY", "INTERNAL_ONLY"])
+          return false unless write_permissions_validator.valid?(@write_permissions)
+          return false if @label.nil?
           return false if @id.nil?
-          return false if @created_at.nil?
           return false if @updated_at.nil?
-          return false if @archived.nil?
           true
         end
 
+        # Custom attribute writer method checking allowed values (enum).
+        # @param [Object] write_permissions Object to be assigned
+        def write_permissions=(write_permissions)
+          validator = EnumAttributeValidator.new('String', ["CRM_PERMISSIONS_ENFORCEMENT", "READ_ONLY", "INTERNAL_ONLY"])
+          unless validator.valid?(write_permissions)
+            fail ArgumentError, "invalid value for \"write_permissions\", must be one of #{validator.allowable_values}."
+          end
+          @write_permissions = write_permissions
+        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 &&
-              label == o.label &&
-              display_order == o.display_order &&
-              metadata == o.metadata &&
-              id == o.id &&
               created_at == o.created_at &&
               archived_at == o.archived_at &&
-              updated_at == o.updated_at &&
-              archived == o.archived
+              archived == o.archived &&
+              metadata == o.metadata &&
+              display_order == o.display_order &&
+              write_permissions == o.write_permissions &&
+              label == o.label &&
+              id == o.id &&
+              updated_at == o.updated_at
         end
 
         # @see the `==` method
@@ -202,7 +245,7 @@ module Hubspot
         # Calculates hash code according to all attributes.
         # @return [Integer] Hash code
         def hash
-          [label, display_order, metadata, id, created_at, archived_at, updated_at, archived].hash
+          [created_at, archived_at, archived, metadata, display_order, write_permissions, label, id, updated_at].hash
         end
 
         # Builds the object from hash

data/lib/hubspot/codegen/crm/pipelines/models/pipeline_stage_input.rb

@@ -1,5 +1,5 @@
 =begin
-#CRM Pipelines
+#Pipelines
 
 #Pipelines represent distinct stages in a workflow, like closing a deal or servicing a support ticket. These endpoints provide access to read and modify pipelines in HubSpot. Pipelines support `deals` and `tickets` object types.  ## Pipeline ID validation  When calling endpoints that take pipelineId as a parameter, that ID must correspond to an existing, un-archived pipeline. Otherwise the request will fail with a `404 Not Found` response.
 
@@ -17,21 +17,21 @@ module Hubspot
   module Crm
     module Pipelines
       class PipelineStageInput
-        # A label used to organize pipeline stages in HubSpot's UI. Each pipeline stage's label must be unique within that pipeline.
-        attr_accessor :label
+        # A JSON object containing properties that are not present on all object pipelines.  For `deals` pipelines, the `probability` field is required (`{ \"probability\": 0.5 }`), and represents the likelihood a deal will close. Possible values are between 0.0 and 1.0 in increments of 0.1.  For `tickets` pipelines, the `ticketState` field is optional (`{ \"ticketState\": \"OPEN\" }`), and represents whether the ticket remains open or has been closed by a member of your Support team. Possible values are `OPEN` or `CLOSED`.
+        attr_accessor :metadata
 
         # The order for displaying this pipeline stage. If two pipeline stages have a matching `displayOrder`, they will be sorted alphabetically by label.
         attr_accessor :display_order
 
-        # A JSON object containing properties that are not present on all object pipelines.  For `deals` pipelines, the `probability` field is required (`{ \"probability\": 0.5 }`), and represents the likelihood a deal will close. Possible values are between 0.0 and 1.0 in increments of 0.1.  For `tickets` pipelines, the `ticketState` field is optional (`{ \"ticketState\": \"OPEN\" }`), and represents whether the ticket remains open or has been closed by a member of your Support team. Possible values are `OPEN` or `CLOSED`.
-        attr_accessor :metadata
+        # A label used to organize pipeline stages in HubSpot's UI. Each pipeline stage's label must be unique within that pipeline.
+        attr_accessor :label
 
         # Attribute mapping from ruby-style variable name to JSON key.
         def self.attribute_map
           {
-            :'label' => :'label',
+            :'metadata' => :'metadata',
             :'display_order' => :'displayOrder',
-            :'metadata' => :'metadata'
+            :'label' => :'label'
           }
         end
 
@@ -43,9 +43,9 @@ module Hubspot
         # Attribute type mapping.
         def self.openapi_types
           {
-            :'label' => :'String',
+            :'metadata' => :'Hash<String, String>',
             :'display_order' => :'Integer',
-            :'metadata' => :'Hash<String, String>'
+            :'label' => :'String'
           }
         end
 
@@ -70,18 +70,18 @@ module Hubspot
             h[k.to_sym] = v
           }
 
-          if attributes.key?(:'label')
-            self.label = attributes[:'label']
+          if attributes.key?(:'metadata')
+            if (value = attributes[:'metadata']).is_a?(Hash)
+              self.metadata = value
+            end
           end
 
           if attributes.key?(:'display_order')
             self.display_order = attributes[:'display_order']
           end
 
-          if attributes.key?(:'metadata')
-            if (value = attributes[:'metadata']).is_a?(Hash)
-              self.metadata = value
-            end
+          if attributes.key?(:'label')
+            self.label = attributes[:'label']
           end
         end
 
@@ -89,16 +89,16 @@ module Hubspot
         # @return Array for valid properties with the reasons
         def list_invalid_properties
           invalid_properties = Array.new
-          if @label.nil?
-            invalid_properties.push('invalid value for "label", label cannot be nil.')
+          if @metadata.nil?
+            invalid_properties.push('invalid value for "metadata", metadata cannot be nil.')
           end
 
           if @display_order.nil?
             invalid_properties.push('invalid value for "display_order", display_order cannot be nil.')
           end
 
-          if @metadata.nil?
-            invalid_properties.push('invalid value for "metadata", metadata cannot be nil.')
+          if @label.nil?
+            invalid_properties.push('invalid value for "label", label cannot be nil.')
           end
 
           invalid_properties
@@ -107,9 +107,9 @@ module Hubspot
         # 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 @label.nil?
-          return false if @display_order.nil?
           return false if @metadata.nil?
+          return false if @display_order.nil?
+          return false if @label.nil?
           true
         end
 
@@ -118,9 +118,9 @@ module Hubspot
         def ==(o)
           return true if self.equal?(o)
           self.class == o.class &&
-              label == o.label &&
+              metadata == o.metadata &&
               display_order == o.display_order &&
-              metadata == o.metadata
+              label == o.label
         end
 
         # @see the `==` method
@@ -132,7 +132,7 @@ module Hubspot
         # Calculates hash code according to all attributes.
         # @return [Integer] Hash code
         def hash
-          [label, display_order, metadata].hash
+          [metadata, display_order, label].hash
         end
 
         # Builds the object from hash

data/lib/hubspot/codegen/crm/pipelines/models/pipeline_stage_patch_input.rb

@@ -1,5 +1,5 @@
 =begin
-#CRM Pipelines
+#Pipelines
 
 #Pipelines represent distinct stages in a workflow, like closing a deal or servicing a support ticket. These endpoints provide access to read and modify pipelines in HubSpot. Pipelines support `deals` and `tickets` object types.  ## Pipeline ID validation  When calling endpoints that take pipelineId as a parameter, that ID must correspond to an existing, un-archived pipeline. Otherwise the request will fail with a `404 Not Found` response.
 
@@ -17,25 +17,25 @@ module Hubspot
   module Crm
     module Pipelines
       class PipelineStagePatchInput
-        # A label used to organize pipeline stages in HubSpot's UI. Each pipeline stage's label must be unique within that pipeline.
-        attr_accessor :label
-
         # Whether the pipeline is archived.
         attr_accessor :archived
 
+        # A JSON object containing properties that are not present on all object pipelines.  For `deals` pipelines, the `probability` field is required (`{ \"probability\": 0.5 }`), and represents the likelihood a deal will close. Possible values are between 0.0 and 1.0 in increments of 0.1.  For `tickets` pipelines, the `ticketState` field is optional (`{ \"ticketState\": \"OPEN\" }`), and represents whether the ticket remains open or has been closed by a member of your Support team. Possible values are `OPEN` or `CLOSED`.
+        attr_accessor :metadata
+
         # The order for displaying this pipeline stage. If two pipeline stages have a matching `displayOrder`, they will be sorted alphabetically by label.
         attr_accessor :display_order
 
-        # A JSON object containing properties that are not present on all object pipelines.  For `deals` pipelines, the `probability` field is required (`{ \"probability\": 0.5 }`), and represents the likelihood a deal will close. Possible values are between 0.0 and 1.0 in increments of 0.1.  For `tickets` pipelines, the `ticketState` field is optional (`{ \"ticketState\": \"OPEN\" }`), and represents whether the ticket remains open or has been closed by a member of your Support team. Possible values are `OPEN` or `CLOSED`.
-        attr_accessor :metadata
+        # A label used to organize pipeline stages in HubSpot's UI. Each pipeline stage's label must be unique within that pipeline.
+        attr_accessor :label
 
         # Attribute mapping from ruby-style variable name to JSON key.
         def self.attribute_map
           {
-            :'label' => :'label',
             :'archived' => :'archived',
+            :'metadata' => :'metadata',
             :'display_order' => :'displayOrder',
-            :'metadata' => :'metadata'
+            :'label' => :'label'
           }
         end
 
@@ -47,10 +47,10 @@ module Hubspot
         # Attribute type mapping.
         def self.openapi_types
           {
-            :'label' => :'String',
             :'archived' => :'Boolean',
+            :'metadata' => :'Hash<String, String>',
             :'display_order' => :'Integer',
-            :'metadata' => :'Hash<String, String>'
+            :'label' => :'String'
           }
         end
 
@@ -75,23 +75,23 @@ module Hubspot
             h[k.to_sym] = v
           }
 
-          if attributes.key?(:'label')
-            self.label = attributes[:'label']
-          end
-
           if attributes.key?(:'archived')
             self.archived = attributes[:'archived']
           end
 
-          if attributes.key?(:'display_order')
-            self.display_order = attributes[:'display_order']
-          end
-
           if attributes.key?(:'metadata')
             if (value = attributes[:'metadata']).is_a?(Hash)
               self.metadata = value
             end
           end
+
+          if attributes.key?(:'display_order')
+            self.display_order = attributes[:'display_order']
+          end
+
+          if attributes.key?(:'label')
+            self.label = attributes[:'label']
+          end
         end
 
         # Show invalid properties with the reasons. Usually used together with valid?
@@ -117,10 +117,10 @@ module Hubspot
         def ==(o)
           return true if self.equal?(o)
           self.class == o.class &&
-              label == o.label &&
               archived == o.archived &&
+              metadata == o.metadata &&
               display_order == o.display_order &&
-              metadata == o.metadata
+              label == o.label
         end
 
         # @see the `==` method
@@ -132,7 +132,7 @@ module Hubspot
         # Calculates hash code according to all attributes.
         # @return [Integer] Hash code
         def hash
-          [label, archived, display_order, metadata].hash
+          [archived, metadata, display_order, label].hash
         end
 
         # Builds the object from hash