hubspot-api-client 17.2.0 → 18.0.0

data/lib/hubspot/codegen/crm/objects/postal_mail/api/basic_api.rb

@@ -25,30 +25,30 @@ module Hubspot
             @api_client = api_client
           end
           # Archive
-          # Move an Object identified by `{postalMail}` to the recycling bin.
-          # @param postal_mail [String] 
+          # Move an Object identified by `{postalMailId}` to the recycling bin.
+          # @param postal_mail_id [String] 
           # @param [Hash] opts the optional parameters
           # @return [nil]
-          def archive(postal_mail, opts = {})
-            archive_with_http_info(postal_mail, opts)
+          def archive(postal_mail_id, opts = {})
+            archive_with_http_info(postal_mail_id, opts)
             nil
           end
 
           # Archive
-          # Move an Object identified by `{postalMail}` to the recycling bin.
-          # @param postal_mail [String] 
+          # Move an Object identified by `{postalMailId}` to the recycling bin.
+          # @param postal_mail_id [String] 
           # @param [Hash] opts the optional parameters
           # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
-          def archive_with_http_info(postal_mail, opts = {})
+          def archive_with_http_info(postal_mail_id, opts = {})
             if @api_client.config.debugging
               @api_client.config.logger.debug 'Calling API: BasicApi.archive ...'
             end
-            # verify the required parameter 'postal_mail' is set
-            if @api_client.config.client_side_validation && postal_mail.nil?
-              fail ArgumentError, "Missing the required parameter 'postal_mail' when calling BasicApi.archive"
+            # verify the required parameter 'postal_mail_id' is set
+            if @api_client.config.client_side_validation && postal_mail_id.nil?
+              fail ArgumentError, "Missing the required parameter 'postal_mail_id' when calling BasicApi.archive"
             end
             # resource path
-            local_var_path = '/crm/v3/objects/postal_mail/{postalMail}'.sub('{' + 'postalMail' + '}', CGI.escape(postal_mail.to_s))
+            local_var_path = '/crm/v3/objects/postal_mail/{postalMailId}'.sub('{' + 'postalMailId' + '}', CGI.escape(postal_mail_id.to_s))
 
             # query parameters
             query_params = opts[:query_params] || {}
@@ -156,8 +156,8 @@ module Hubspot
           end
 
           # Read
-          # Read an Object identified by `{postalMail}`. `{postalMail}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param.  Control what is returned via the `properties` query param.
-          # @param postal_mail [String] 
+          # Read an Object identified by `{postalMailId}`. `{postalMailId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param.  Control what is returned via the `properties` query param.
+          # @param postal_mail_id [String] 
           # @param [Hash] opts the optional parameters
           # @option opts [Array<String>] :properties A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
           # @option opts [Array<String>] :properties_with_history A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.
@@ -165,14 +165,14 @@ module Hubspot
           # @option opts [Boolean] :archived Whether to return only results that have been archived. (default to false)
           # @option opts [String] :id_property The name of a property whose values are unique for this object type
           # @return [SimplePublicObjectWithAssociations]
-          def get_by_id(postal_mail, opts = {})
-            data, _status_code, _headers = get_by_id_with_http_info(postal_mail, opts)
+          def get_by_id(postal_mail_id, opts = {})
+            data, _status_code, _headers = get_by_id_with_http_info(postal_mail_id, opts)
             data
           end
 
           # Read
-          # Read an Object identified by &#x60;{postalMail}&#x60;. &#x60;{postalMail}&#x60; refers to the internal object ID by default, or optionally any unique property value as specified by the &#x60;idProperty&#x60; query param.  Control what is returned via the &#x60;properties&#x60; query param.
-          # @param postal_mail [String] 
+          # Read an Object identified by &#x60;{postalMailId}&#x60;. &#x60;{postalMailId}&#x60; refers to the internal object ID by default, or optionally any unique property value as specified by the &#x60;idProperty&#x60; query param.  Control what is returned via the &#x60;properties&#x60; query param.
+          # @param postal_mail_id [String] 
           # @param [Hash] opts the optional parameters
           # @option opts [Array<String>] :properties A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
           # @option opts [Array<String>] :properties_with_history A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.
@@ -180,16 +180,16 @@ module Hubspot
           # @option opts [Boolean] :archived Whether to return only results that have been archived. (default to false)
           # @option opts [String] :id_property The name of a property whose values are unique for this object type
           # @return [Array<(SimplePublicObjectWithAssociations, Integer, Hash)>] SimplePublicObjectWithAssociations data, response status code and response headers
-          def get_by_id_with_http_info(postal_mail, opts = {})
+          def get_by_id_with_http_info(postal_mail_id, opts = {})
             if @api_client.config.debugging
               @api_client.config.logger.debug 'Calling API: BasicApi.get_by_id ...'
             end
-            # verify the required parameter 'postal_mail' is set
-            if @api_client.config.client_side_validation && postal_mail.nil?
-              fail ArgumentError, "Missing the required parameter 'postal_mail' when calling BasicApi.get_by_id"
+            # verify the required parameter 'postal_mail_id' is set
+            if @api_client.config.client_side_validation && postal_mail_id.nil?
+              fail ArgumentError, "Missing the required parameter 'postal_mail_id' when calling BasicApi.get_by_id"
             end
             # resource path
-            local_var_path = '/crm/v3/objects/postal_mail/{postalMail}'.sub('{' + 'postalMail' + '}', CGI.escape(postal_mail.to_s))
+            local_var_path = '/crm/v3/objects/postal_mail/{postalMailId}'.sub('{' + 'postalMailId' + '}', CGI.escape(postal_mail_id.to_s))
 
             # query parameters
             query_params = opts[:query_params] || {}
@@ -309,38 +309,38 @@ module Hubspot
           end
 
           # Update
-          # Perform a partial update of an Object identified by `{postalMail}`. `{postalMail}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.
-          # @param postal_mail [String] 
+          # Perform a partial update of an Object identified by `{postalMailId}`. `{postalMailId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.
+          # @param postal_mail_id [String] 
           # @param simple_public_object_input [SimplePublicObjectInput] 
           # @param [Hash] opts the optional parameters
           # @option opts [String] :id_property The name of a property whose values are unique for this object type
           # @return [SimplePublicObject]
-          def update(postal_mail, simple_public_object_input, opts = {})
-            data, _status_code, _headers = update_with_http_info(postal_mail, simple_public_object_input, opts)
+          def update(postal_mail_id, simple_public_object_input, opts = {})
+            data, _status_code, _headers = update_with_http_info(postal_mail_id, simple_public_object_input, opts)
             data
           end
 
           # Update
-          # Perform a partial update of an Object identified by &#x60;{postalMail}&#x60;. &#x60;{postalMail}&#x60; refers to the internal object ID by default, or optionally any unique property value as specified by the &#x60;idProperty&#x60; query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.
-          # @param postal_mail [String] 
+          # Perform a partial update of an Object identified by &#x60;{postalMailId}&#x60;. &#x60;{postalMailId}&#x60; refers to the internal object ID by default, or optionally any unique property value as specified by the &#x60;idProperty&#x60; query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.
+          # @param postal_mail_id [String] 
           # @param simple_public_object_input [SimplePublicObjectInput] 
           # @param [Hash] opts the optional parameters
           # @option opts [String] :id_property The name of a property whose values are unique for this object type
           # @return [Array<(SimplePublicObject, Integer, Hash)>] SimplePublicObject data, response status code and response headers
-          def update_with_http_info(postal_mail, simple_public_object_input, opts = {})
+          def update_with_http_info(postal_mail_id, simple_public_object_input, opts = {})
             if @api_client.config.debugging
               @api_client.config.logger.debug 'Calling API: BasicApi.update ...'
             end
-            # verify the required parameter 'postal_mail' is set
-            if @api_client.config.client_side_validation && postal_mail.nil?
-              fail ArgumentError, "Missing the required parameter 'postal_mail' when calling BasicApi.update"
+            # verify the required parameter 'postal_mail_id' is set
+            if @api_client.config.client_side_validation && postal_mail_id.nil?
+              fail ArgumentError, "Missing the required parameter 'postal_mail_id' when calling BasicApi.update"
             end
             # verify the required parameter 'simple_public_object_input' is set
             if @api_client.config.client_side_validation && simple_public_object_input.nil?
               fail ArgumentError, "Missing the required parameter 'simple_public_object_input' when calling BasicApi.update"
             end
             # resource path
-            local_var_path = '/crm/v3/objects/postal_mail/{postalMail}'.sub('{' + 'postalMail' + '}', CGI.escape(postal_mail.to_s))
+            local_var_path = '/crm/v3/objects/postal_mail/{postalMailId}'.sub('{' + 'postalMailId' + '}', CGI.escape(postal_mail_id.to_s))
 
             # query parameters
             query_params = opts[:query_params] || {}

data/lib/hubspot/codegen/crm/objects/postal_mail/api/gdpr_api.rb

@@ -0,0 +1,96 @@
+=begin
+#Postal Mail
+
+#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 'cgi'
+
+module Hubspot
+  module Crm
+    module Objects
+      module PostalMail
+        class GDPRApi
+          attr_accessor :api_client
+
+          def initialize(api_client = ApiClient.default)
+            @api_client = api_client
+          end
+          # GDPR DELETE
+          # Permanently delete a contact and all associated content to follow GDPR. Use optional property 'idProperty' set to 'email' to identify contact by email address. If email address is not found, the email address will be added to a blocklist and prevent it from being used in the future.
+          # @param public_gdpr_delete_input [PublicGdprDeleteInput] 
+          # @param [Hash] opts the optional parameters
+          # @return [nil]
+          def purge(public_gdpr_delete_input, opts = {})
+            purge_with_http_info(public_gdpr_delete_input, opts)
+            nil
+          end
+
+          # GDPR DELETE
+          # Permanently delete a contact and all associated content to follow GDPR. Use optional property 'idProperty' set to 'email' to identify contact by email address. If email address is not found, the email address will be added to a blocklist and prevent it from being used in the future.
+          # @param public_gdpr_delete_input [PublicGdprDeleteInput] 
+          # @param [Hash] opts the optional parameters
+          # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+          def purge_with_http_info(public_gdpr_delete_input, opts = {})
+            if @api_client.config.debugging
+              @api_client.config.logger.debug 'Calling API: GDPRApi.purge ...'
+            end
+            # verify the required parameter 'public_gdpr_delete_input' is set
+            if @api_client.config.client_side_validation && public_gdpr_delete_input.nil?
+              fail ArgumentError, "Missing the required parameter 'public_gdpr_delete_input' when calling GDPRApi.purge"
+            end
+            # resource path
+            local_var_path = '/crm/v3/objects/postal_mail/gdpr-delete'
+
+            # query parameters
+            query_params = opts[:query_params] || {}
+
+            # header parameters
+            header_params = opts[:header_params] || {}
+            # HTTP header 'Accept' (if needed)
+            header_params['Accept'] = @api_client.select_header_accept(['*/*'])
+            # HTTP header 'Content-Type'
+            content_type = @api_client.select_header_content_type(['application/json'])
+            if !content_type.nil?
+                header_params['Content-Type'] = content_type
+            end
+
+            # form parameters
+            form_params = opts[:form_params] || {}
+
+            # http body (model)
+            post_body = opts[:debug_body] || @api_client.object_to_http_body(public_gdpr_delete_input)
+
+            # return_type
+            return_type = opts[:debug_return_type]
+
+            # auth_names
+            auth_names = opts[:debug_auth_names] || ['oauth2']
+
+            new_options = opts.merge(
+              :operation => :"GDPRApi.purge",
+              :header_params => header_params,
+              :query_params => query_params,
+              :form_params => form_params,
+              :body => post_body,
+              :auth_names => auth_names,
+              :return_type => return_type
+            )
+
+            data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+            if @api_client.config.debugging
+              @api_client.config.logger.debug "API called: GDPRApi#purge\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+            end
+            return data, status_code, headers
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hubspot/codegen/crm/objects/postal_mail/models/batch_read_input_simple_public_object_id.rb

@@ -18,21 +18,21 @@ module Hubspot
     module Objects
       module PostalMail
         class BatchReadInputSimplePublicObjectId
-          attr_accessor :properties
-
           attr_accessor :properties_with_history
 
           attr_accessor :id_property
 
           attr_accessor :inputs
 
+          attr_accessor :properties
+
           # Attribute mapping from ruby-style variable name to JSON key.
           def self.attribute_map
             {
-              :'properties' => :'properties',
               :'properties_with_history' => :'propertiesWithHistory',
               :'id_property' => :'idProperty',
-              :'inputs' => :'inputs'
+              :'inputs' => :'inputs',
+              :'properties' => :'properties'
             }
           end
 
@@ -44,10 +44,10 @@ module Hubspot
           # Attribute type mapping.
           def self.openapi_types
             {
-              :'properties' => :'Array<String>',
               :'properties_with_history' => :'Array<String>',
               :'id_property' => :'String',
-              :'inputs' => :'Array<SimplePublicObjectId>'
+              :'inputs' => :'Array<SimplePublicObjectId>',
+              :'properties' => :'Array<String>'
             }
           end
 
@@ -72,12 +72,6 @@ module Hubspot
               h[k.to_sym] = v
             }
 
-            if attributes.key?(:'properties')
-              if (value = attributes[:'properties']).is_a?(Array)
-                self.properties = value
-              end
-            end
-
             if attributes.key?(:'properties_with_history')
               if (value = attributes[:'properties_with_history']).is_a?(Array)
                 self.properties_with_history = value
@@ -93,16 +87,18 @@ module Hubspot
                 self.inputs = value
               end
             end
+
+            if attributes.key?(:'properties')
+              if (value = attributes[:'properties']).is_a?(Array)
+                self.properties = 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 @properties.nil?
-              invalid_properties.push('invalid value for "properties", properties cannot be nil.')
-            end
-
             if @properties_with_history.nil?
               invalid_properties.push('invalid value for "properties_with_history", properties_with_history cannot be nil.')
             end
@@ -111,15 +107,19 @@ module Hubspot
               invalid_properties.push('invalid value for "inputs", inputs cannot be nil.')
             end
 
+            if @properties.nil?
+              invalid_properties.push('invalid value for "properties", properties 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 @properties.nil?
             return false if @properties_with_history.nil?
             return false if @inputs.nil?
+            return false if @properties.nil?
             true
           end
 
@@ -128,10 +128,10 @@ module Hubspot
           def ==(o)
             return true if self.equal?(o)
             self.class == o.class &&
-                properties == o.properties &&
                 properties_with_history == o.properties_with_history &&
                 id_property == o.id_property &&
-                inputs == o.inputs
+                inputs == o.inputs &&
+                properties == o.properties
           end
 
           # @see the `==` method
@@ -143,7 +143,7 @@ module Hubspot
           # Calculates hash code according to all attributes.
           # @return [Integer] Hash code
           def hash
-            [properties, properties_with_history, id_property, inputs].hash
+            [properties_with_history, id_property, inputs, properties].hash
           end
 
           # Builds the object from hash

data/lib/hubspot/codegen/crm/objects/postal_mail/models/batch_response_simple_public_object.rb

@@ -18,18 +18,18 @@ module Hubspot
     module Objects
       module PostalMail
         class BatchResponseSimplePublicObject
-          attr_accessor :status
-
-          attr_accessor :results
+          attr_accessor :completed_at
 
           attr_accessor :requested_at
 
           attr_accessor :started_at
 
-          attr_accessor :completed_at
-
           attr_accessor :links
 
+          attr_accessor :results
+
+          attr_accessor :status
+
           class EnumAttributeValidator
             attr_reader :datatype
             attr_reader :allowable_values
@@ -55,12 +55,12 @@ module Hubspot
           # Attribute mapping from ruby-style variable name to JSON key.
           def self.attribute_map
             {
-              :'status' => :'status',
-              :'results' => :'results',
+              :'completed_at' => :'completedAt',
               :'requested_at' => :'requestedAt',
               :'started_at' => :'startedAt',
-              :'completed_at' => :'completedAt',
-              :'links' => :'links'
+              :'links' => :'links',
+              :'results' => :'results',
+              :'status' => :'status'
             }
           end
 
@@ -72,12 +72,12 @@ module Hubspot
           # Attribute type mapping.
           def self.openapi_types
             {
-              :'status' => :'String',
-              :'results' => :'Array<SimplePublicObject>',
+              :'completed_at' => :'Time',
               :'requested_at' => :'Time',
               :'started_at' => :'Time',
-              :'completed_at' => :'Time',
-              :'links' => :'Hash<String, String>'
+              :'links' => :'Hash<String, String>',
+              :'results' => :'Array<SimplePublicObject>',
+              :'status' => :'String'
             }
           end
 
@@ -102,14 +102,8 @@ module Hubspot
               h[k.to_sym] = v
             }
 
-            if attributes.key?(:'status')
-              self.status = attributes[:'status']
-            end
-
-            if attributes.key?(:'results')
-              if (value = attributes[:'results']).is_a?(Array)
-                self.results = value
-              end
+            if attributes.key?(:'completed_at')
+              self.completed_at = attributes[:'completed_at']
             end
 
             if attributes.key?(:'requested_at')
@@ -120,35 +114,41 @@ module Hubspot
               self.started_at = attributes[:'started_at']
             end
 
-            if attributes.key?(:'completed_at')
-              self.completed_at = attributes[:'completed_at']
-            end
-
             if attributes.key?(:'links')
               if (value = attributes[:'links']).is_a?(Hash)
                 self.links = value
               end
             end
+
+            if attributes.key?(:'results')
+              if (value = attributes[:'results']).is_a?(Array)
+                self.results = value
+              end
+            end
+
+            if attributes.key?(:'status')
+              self.status = attributes[:'status']
+            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 @status.nil?
-              invalid_properties.push('invalid value for "status", status cannot be nil.')
-            end
-
-            if @results.nil?
-              invalid_properties.push('invalid value for "results", results cannot be nil.')
+            if @completed_at.nil?
+              invalid_properties.push('invalid value for "completed_at", completed_at cannot be nil.')
             end
 
             if @started_at.nil?
               invalid_properties.push('invalid value for "started_at", started_at cannot be nil.')
             end
 
-            if @completed_at.nil?
-              invalid_properties.push('invalid value for "completed_at", completed_at cannot be nil.')
+            if @results.nil?
+              invalid_properties.push('invalid value for "results", results cannot be nil.')
+            end
+
+            if @status.nil?
+              invalid_properties.push('invalid value for "status", status cannot be nil.')
             end
 
             invalid_properties
@@ -157,12 +157,12 @@ 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 @completed_at.nil?
+            return false if @started_at.nil?
+            return false if @results.nil?
             return false if @status.nil?
             status_validator = EnumAttributeValidator.new('String', ["PENDING", "PROCESSING", "CANCELED", "COMPLETE"])
             return false unless status_validator.valid?(@status)
-            return false if @results.nil?
-            return false if @started_at.nil?
-            return false if @completed_at.nil?
             true
           end
 
@@ -181,12 +181,12 @@ module Hubspot
           def ==(o)
             return true if self.equal?(o)
             self.class == o.class &&
-                status == o.status &&
-                results == o.results &&
+                completed_at == o.completed_at &&
                 requested_at == o.requested_at &&
                 started_at == o.started_at &&
-                completed_at == o.completed_at &&
-                links == o.links
+                links == o.links &&
+                results == o.results &&
+                status == o.status
           end
 
           # @see the `==` method
@@ -198,7 +198,7 @@ module Hubspot
           # Calculates hash code according to all attributes.
           # @return [Integer] Hash code
           def hash
-            [status, results, requested_at, started_at, completed_at, links].hash
+            [completed_at, requested_at, started_at, links, results, status].hash
           end
 
           # Builds the object from hash