hubspot-api-client 10.0.1 → 11.1.1

data/lib/hubspot/codegen/cms/site-search/models/search_hit_field.rb

@@ -16,10 +16,10 @@ module Hubspot
   module Cms
     module SiteSearch
       class SearchHitField
-        attr_accessor :values
-
         attr_accessor :metadata_field
 
+        attr_accessor :values
+
         attr_accessor :name
 
         attr_accessor :value
@@ -27,8 +27,8 @@ module Hubspot
         # Attribute mapping from ruby-style variable name to JSON key.
         def self.attribute_map
           {
-            :'values' => :'values',
             :'metadata_field' => :'metadataField',
+            :'values' => :'values',
             :'name' => :'name',
             :'value' => :'value'
           }
@@ -37,8 +37,8 @@ module Hubspot
         # Attribute type mapping.
         def self.openapi_types
           {
-            :'values' => :'Array<Object>',
             :'metadata_field' => :'Boolean',
+            :'values' => :'Array<Object>',
             :'name' => :'String',
             :'value' => :'Object'
           }
@@ -65,16 +65,16 @@ module Hubspot
             h[k.to_sym] = v
           }
 
+          if attributes.key?(:'metadata_field')
+            self.metadata_field = attributes[:'metadata_field']
+          end
+
           if attributes.key?(:'values')
             if (value = attributes[:'values']).is_a?(Array)
               self.values = value
             end
           end
 
-          if attributes.key?(:'metadata_field')
-            self.metadata_field = attributes[:'metadata_field']
-          end
-
           if attributes.key?(:'name')
             self.name = attributes[:'name']
           end
@@ -88,14 +88,14 @@ module Hubspot
         # @return Array for valid properties with the reasons
         def list_invalid_properties
           invalid_properties = Array.new
-          if @values.nil?
-            invalid_properties.push('invalid value for "values", values cannot be nil.')
-          end
-
           if @metadata_field.nil?
             invalid_properties.push('invalid value for "metadata_field", metadata_field cannot be nil.')
           end
 
+          if @values.nil?
+            invalid_properties.push('invalid value for "values", values cannot be nil.')
+          end
+
           if @name.nil?
             invalid_properties.push('invalid value for "name", name cannot be nil.')
           end
@@ -110,8 +110,8 @@ 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 @values.nil?
           return false if @metadata_field.nil?
+          return false if @values.nil?
           return false if @name.nil?
           return false if @value.nil?
           true
@@ -122,8 +122,8 @@ module Hubspot
         def ==(o)
           return true if self.equal?(o)
           self.class == o.class &&
-              values == o.values &&
               metadata_field == o.metadata_field &&
+              values == o.values &&
               name == o.name &&
               value == o.value
         end
@@ -137,7 +137,7 @@ module Hubspot
         # Calculates hash code according to all attributes.
         # @return [Integer] Hash code
         def hash
-          [values, metadata_field, name, value].hash
+          [metadata_field, values, name, value].hash
         end
 
         # Builds the object from hash

data/lib/hubspot/codegen/communication_preferences/api/definition_api.rb

@@ -0,0 +1,80 @@
+=begin
+#Subscriptions
+
+#Subscriptions allow contacts to control what forms of communications they receive. Contacts can decide whether they want to receive communication pertaining to a specific topic, brand, or an entire HubSpot account.
+
+The version of the OpenAPI document: v3
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'cgi'
+
+module Hubspot
+  module CommunicationPreferences
+    class DefinitionApi
+      attr_accessor :api_client
+
+      def initialize(api_client = ApiClient.default)
+        @api_client = api_client
+      end
+      # Get subscription definitions
+      # Get a list of all subscription definitions for the portal
+      # @param [Hash] opts the optional parameters
+      # @return [SubscriptionDefinitionsResponse]
+      def get_page(opts = {})
+        data, _status_code, _headers = get_page_with_http_info(opts)
+        data
+      end
+
+      # Get subscription definitions
+      # Get a list of all subscription definitions for the portal
+      # @param [Hash] opts the optional parameters
+      # @return [Array<(SubscriptionDefinitionsResponse, Integer, Hash)>] SubscriptionDefinitionsResponse data, response status code and response headers
+      def get_page_with_http_info(opts = {})
+        if @api_client.config.debugging
+          @api_client.config.logger.debug 'Calling API: DefinitionApi.get_page ...'
+        end
+        # resource path
+        local_var_path = '/communication-preferences/v3/definitions'
+
+        # 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(['application/json', '*/*'])
+
+        # form parameters
+        form_params = opts[:form_params] || {}
+
+        # http body (model)
+        post_body = opts[:body] 
+
+        # return_type
+        return_type = opts[:return_type] || 'SubscriptionDefinitionsResponse' 
+
+        # auth_names
+        auth_names = opts[:auth_names] || ['hapikey']
+
+        new_options = opts.merge(
+          :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(:GET, local_var_path, new_options)
+        if @api_client.config.debugging
+          @api_client.config.logger.debug "API called: DefinitionApi#get_page\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        end
+        return data, status_code, headers
+      end
+    end
+  end
+end

data/lib/hubspot/codegen/communication_preferences/api/status_api.rb

@@ -0,0 +1,214 @@
+=begin
+#Subscriptions
+
+#Subscriptions allow contacts to control what forms of communications they receive. Contacts can decide whether they want to receive communication pertaining to a specific topic, brand, or an entire HubSpot account.
+
+The version of the OpenAPI document: v3
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'cgi'
+
+module Hubspot
+  module CommunicationPreferences
+    class StatusApi
+      attr_accessor :api_client
+
+      def initialize(api_client = ApiClient.default)
+        @api_client = api_client
+      end
+      # Get subscription statuses for a contact
+      # Returns a list of subscriptions and their status for a given contact.
+      # @param email_address [String] 
+      # @param [Hash] opts the optional parameters
+      # @return [PublicSubscriptionStatusesResponse]
+      def get_email_status(email_address, opts = {})
+        data, _status_code, _headers = get_email_status_with_http_info(email_address, opts)
+        data
+      end
+
+      # Get subscription statuses for a contact
+      # Returns a list of subscriptions and their status for a given contact.
+      # @param email_address [String] 
+      # @param [Hash] opts the optional parameters
+      # @return [Array<(PublicSubscriptionStatusesResponse, Integer, Hash)>] PublicSubscriptionStatusesResponse data, response status code and response headers
+      def get_email_status_with_http_info(email_address, opts = {})
+        if @api_client.config.debugging
+          @api_client.config.logger.debug 'Calling API: StatusApi.get_email_status ...'
+        end
+        # verify the required parameter 'email_address' is set
+        if @api_client.config.client_side_validation && email_address.nil?
+          fail ArgumentError, "Missing the required parameter 'email_address' when calling StatusApi.get_email_status"
+        end
+        # resource path
+        local_var_path = '/communication-preferences/v3/status/email/{emailAddress}'.sub('{' + 'emailAddress' + '}', CGI.escape(email_address.to_s))
+
+        # 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(['application/json', '*/*'])
+
+        # form parameters
+        form_params = opts[:form_params] || {}
+
+        # http body (model)
+        post_body = opts[:body] 
+
+        # return_type
+        return_type = opts[:return_type] || 'PublicSubscriptionStatusesResponse' 
+
+        # auth_names
+        auth_names = opts[:auth_names] || ['hapikey']
+
+        new_options = opts.merge(
+          :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(:GET, local_var_path, new_options)
+        if @api_client.config.debugging
+          @api_client.config.logger.debug "API called: StatusApi#get_email_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        end
+        return data, status_code, headers
+      end
+
+      # Subscribe a contact
+      # Subscribes a contact to the given subscription type. This API is not valid to use for subscribing a contact at a brand or portal level and will return an error.
+      # @param public_update_subscription_status_request [PublicUpdateSubscriptionStatusRequest] 
+      # @param [Hash] opts the optional parameters
+      # @return [PublicSubscriptionStatus]
+      def subscribe(public_update_subscription_status_request, opts = {})
+        data, _status_code, _headers = subscribe_with_http_info(public_update_subscription_status_request, opts)
+        data
+      end
+
+      # Subscribe a contact
+      # Subscribes a contact to the given subscription type. This API is not valid to use for subscribing a contact at a brand or portal level and will return an error.
+      # @param public_update_subscription_status_request [PublicUpdateSubscriptionStatusRequest] 
+      # @param [Hash] opts the optional parameters
+      # @return [Array<(PublicSubscriptionStatus, Integer, Hash)>] PublicSubscriptionStatus data, response status code and response headers
+      def subscribe_with_http_info(public_update_subscription_status_request, opts = {})
+        if @api_client.config.debugging
+          @api_client.config.logger.debug 'Calling API: StatusApi.subscribe ...'
+        end
+        # verify the required parameter 'public_update_subscription_status_request' is set
+        if @api_client.config.client_side_validation && public_update_subscription_status_request.nil?
+          fail ArgumentError, "Missing the required parameter 'public_update_subscription_status_request' when calling StatusApi.subscribe"
+        end
+        # resource path
+        local_var_path = '/communication-preferences/v3/subscribe'
+
+        # 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(['application/json', '*/*'])
+        # HTTP header 'Content-Type'
+        header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+        # form parameters
+        form_params = opts[:form_params] || {}
+
+        # http body (model)
+        post_body = opts[:body] || @api_client.object_to_http_body(public_update_subscription_status_request) 
+
+        # return_type
+        return_type = opts[:return_type] || 'PublicSubscriptionStatus' 
+
+        # auth_names
+        auth_names = opts[:auth_names] || ['hapikey']
+
+        new_options = opts.merge(
+          :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: StatusApi#subscribe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        end
+        return data, status_code, headers
+      end
+
+      # Unsubscribe a contact
+      # Unsubscribes a contact from the given subscription type. This API is not valid to use for unsubscribing a contact at a brand or portal level and will return an error.
+      # @param public_update_subscription_status_request [PublicUpdateSubscriptionStatusRequest] 
+      # @param [Hash] opts the optional parameters
+      # @return [PublicSubscriptionStatus]
+      def unsubscribe(public_update_subscription_status_request, opts = {})
+        data, _status_code, _headers = unsubscribe_with_http_info(public_update_subscription_status_request, opts)
+        data
+      end
+
+      # Unsubscribe a contact
+      # Unsubscribes a contact from the given subscription type. This API is not valid to use for unsubscribing a contact at a brand or portal level and will return an error.
+      # @param public_update_subscription_status_request [PublicUpdateSubscriptionStatusRequest] 
+      # @param [Hash] opts the optional parameters
+      # @return [Array<(PublicSubscriptionStatus, Integer, Hash)>] PublicSubscriptionStatus data, response status code and response headers
+      def unsubscribe_with_http_info(public_update_subscription_status_request, opts = {})
+        if @api_client.config.debugging
+          @api_client.config.logger.debug 'Calling API: StatusApi.unsubscribe ...'
+        end
+        # verify the required parameter 'public_update_subscription_status_request' is set
+        if @api_client.config.client_side_validation && public_update_subscription_status_request.nil?
+          fail ArgumentError, "Missing the required parameter 'public_update_subscription_status_request' when calling StatusApi.unsubscribe"
+        end
+        # resource path
+        local_var_path = '/communication-preferences/v3/unsubscribe'
+
+        # 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(['application/json', '*/*'])
+        # HTTP header 'Content-Type'
+        header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+        # form parameters
+        form_params = opts[:form_params] || {}
+
+        # http body (model)
+        post_body = opts[:body] || @api_client.object_to_http_body(public_update_subscription_status_request) 
+
+        # return_type
+        return_type = opts[:return_type] || 'PublicSubscriptionStatus' 
+
+        # auth_names
+        auth_names = opts[:auth_names] || ['hapikey']
+
+        new_options = opts.merge(
+          :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: StatusApi#unsubscribe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        end
+        return data, status_code, headers
+      end
+    end
+  end
+end