hubspot-api-client 3.1.0.pre.beta → 5.0.0

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

@@ -0,0 +1,259 @@
+=begin
+#CMS Site Search
+
+#Use these endpoints for searching content on your HubSpot hosted CMS website(s).
+
+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 Cms
+    module SiteSearch
+      class SearchHitField
+        attr_accessor :metadata_field
+
+        attr_accessor :values
+
+        attr_accessor :name
+
+        attr_accessor :value
+
+        # Attribute mapping from ruby-style variable name to JSON key.
+        def self.attribute_map
+          {
+            :'metadata_field' => :'metadataField',
+            :'values' => :'values',
+            :'name' => :'name',
+            :'value' => :'value'
+          }
+        end
+
+        # Attribute type mapping.
+        def self.openapi_types
+          {
+            :'metadata_field' => :'Boolean',
+            :'values' => :'Array<Object>',
+            :'name' => :'String',
+            :'value' => :'Object'
+          }
+        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::Cms::SiteSearch::SearchHitField` 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::Cms::SiteSearch::SearchHitField`. 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?(:'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?(:'name')
+            self.name = attributes[:'name']
+          end
+
+          if attributes.key?(:'value')
+            self.value = attributes[:'value']
+          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 @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
+
+          if @value.nil?
+            invalid_properties.push('invalid value for "value", value 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 @metadata_field.nil?
+          return false if @values.nil?
+          return false if @name.nil?
+          return false if @value.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 &&
+              metadata_field == o.metadata_field &&
+              values == o.values &&
+              name == o.name &&
+              value == o.value
+        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
+          [metadata_field, values, name, value].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::Cms::SiteSearch.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

data/lib/hubspot/codegen/cms/url-redirects/api/redirects_api.rb

@@ -0,0 +1,368 @@
+=begin
+#URL redirects
+
+#URL redirect operations
+
+The version of the OpenAPI document: v3
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.2.3
+
+=end
+
+require 'cgi'
+
+module Hubspot
+  module Cms
+    module UrlRedirects
+      class RedirectsApi
+        attr_accessor :api_client
+
+        def initialize(api_client = ApiClient.default)
+          @api_client = api_client
+        end
+        # Delete a redirect
+        # Delete one existing redirect, so it is no longer mapped.
+        # @param url_redirect_id [String] The ID of the target redirect.
+        # @param [Hash] opts the optional parameters
+        # @return [nil]
+        def archive(url_redirect_id, opts = {})
+          archive_with_http_info(url_redirect_id, opts)
+          nil
+        end
+
+        # Delete a redirect
+        # Delete one existing redirect, so it is no longer mapped.
+        # @param url_redirect_id [String] The ID of the target redirect.
+        # @param [Hash] opts the optional parameters
+        # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+        def archive_with_http_info(url_redirect_id, opts = {})
+          if @api_client.config.debugging
+            @api_client.config.logger.debug 'Calling API: RedirectsApi.archive ...'
+          end
+          # verify the required parameter 'url_redirect_id' is set
+          if @api_client.config.client_side_validation && url_redirect_id.nil?
+            fail ArgumentError, "Missing the required parameter 'url_redirect_id' when calling RedirectsApi.archive"
+          end
+          # resource path
+          local_var_path = '/cms/v3/url-redirects/{urlRedirectId}'.sub('{' + 'urlRedirectId' + '}', CGI.escape(url_redirect_id.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(['*/*'])
+
+          # form parameters
+          form_params = opts[:form_params] || {}
+
+          # http body (model)
+          post_body = opts[:body] 
+
+          # return_type
+          return_type = opts[:return_type] 
+
+          # auth_names
+          auth_names = opts[:auth_names] || ['hapikey', 'oauth2']
+
+          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(:DELETE, local_var_path, new_options)
+          if @api_client.config.debugging
+            @api_client.config.logger.debug "API called: RedirectsApi#archive\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+          end
+          return data, status_code, headers
+        end
+
+        # Create a redirect
+        # Creates and configures a new URL redirect.
+        # @param [Hash] opts the optional parameters
+        # @option opts [UrlMappingCreateRequestBody] :url_mapping_create_request_body 
+        # @return [UrlMapping]
+        def create(opts = {})
+          data, _status_code, _headers = create_with_http_info(opts)
+          data
+        end
+
+        # Create a redirect
+        # Creates and configures a new URL redirect.
+        # @param [Hash] opts the optional parameters
+        # @option opts [UrlMappingCreateRequestBody] :url_mapping_create_request_body 
+        # @return [Array<(UrlMapping, Integer, Hash)>] UrlMapping data, response status code and response headers
+        def create_with_http_info(opts = {})
+          if @api_client.config.debugging
+            @api_client.config.logger.debug 'Calling API: RedirectsApi.create ...'
+          end
+          # resource path
+          local_var_path = '/cms/v3/url-redirects/'
+
+          # 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(opts[:'url_mapping_create_request_body']) 
+
+          # return_type
+          return_type = opts[:return_type] || 'UrlMapping' 
+
+          # auth_names
+          auth_names = opts[:auth_names] || ['hapikey', 'oauth2']
+
+          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: RedirectsApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+          end
+          return data, status_code, headers
+        end
+
+        # Get details for a redirect
+        # Returns the details for a single existing URL redirect by ID.
+        # @param url_redirect_id [String] The ID of the target redirect.
+        # @param [Hash] opts the optional parameters
+        # @return [UrlMapping]
+        def get_by_id(url_redirect_id, opts = {})
+          data, _status_code, _headers = get_by_id_with_http_info(url_redirect_id, opts)
+          data
+        end
+
+        # Get details for a redirect
+        # Returns the details for a single existing URL redirect by ID.
+        # @param url_redirect_id [String] The ID of the target redirect.
+        # @param [Hash] opts the optional parameters
+        # @return [Array<(UrlMapping, Integer, Hash)>] UrlMapping data, response status code and response headers
+        def get_by_id_with_http_info(url_redirect_id, opts = {})
+          if @api_client.config.debugging
+            @api_client.config.logger.debug 'Calling API: RedirectsApi.get_by_id ...'
+          end
+          # verify the required parameter 'url_redirect_id' is set
+          if @api_client.config.client_side_validation && url_redirect_id.nil?
+            fail ArgumentError, "Missing the required parameter 'url_redirect_id' when calling RedirectsApi.get_by_id"
+          end
+          # resource path
+          local_var_path = '/cms/v3/url-redirects/{urlRedirectId}'.sub('{' + 'urlRedirectId' + '}', CGI.escape(url_redirect_id.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] || 'UrlMapping' 
+
+          # auth_names
+          auth_names = opts[:auth_names] || ['hapikey', 'oauth2']
+
+          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: RedirectsApi#get_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+          end
+          return data, status_code, headers
+        end
+
+        # Get current redirects
+        # Returns all existing URL redirects. Results can be limited and filtered by creation or updated date.
+        # @param [Hash] opts the optional parameters
+        # @option opts [DateTime] :created_at Only return redirects created on exactly this date.
+        # @option opts [DateTime] :created_after Only return redirects created after this date.
+        # @option opts [DateTime] :created_before Only return redirects created before this date.
+        # @option opts [DateTime] :updated_at Only return redirects last updated on exactly this date.
+        # @option opts [DateTime] :updated_after Only return redirects last updated after this date.
+        # @option opts [DateTime] :updated_before Only return redirects last updated before this date.
+        # @option opts [Array<String>] :sort 
+        # @option opts [Array<String>] :properties 
+        # @option opts [String] :after The paging cursor token of the last successfully read resource will be returned as the &#x60;paging.next.after&#x60; JSON property of a paged response containing more results.
+        # @option opts [String] :before 
+        # @option opts [Integer] :limit Maximum number of result per page
+        # @option opts [Boolean] :archived Whether to return only results that have been archived.
+        # @return [CollectionResponseWithTotalUrlMapping]
+        def get_page(opts = {})
+          data, _status_code, _headers = get_page_with_http_info(opts)
+          data
+        end
+
+        # Get current redirects
+        # Returns all existing URL redirects. Results can be limited and filtered by creation or updated date.
+        # @param [Hash] opts the optional parameters
+        # @option opts [DateTime] :created_at Only return redirects created on exactly this date.
+        # @option opts [DateTime] :created_after Only return redirects created after this date.
+        # @option opts [DateTime] :created_before Only return redirects created before this date.
+        # @option opts [DateTime] :updated_at Only return redirects last updated on exactly this date.
+        # @option opts [DateTime] :updated_after Only return redirects last updated after this date.
+        # @option opts [DateTime] :updated_before Only return redirects last updated before this date.
+        # @option opts [Array<String>] :sort 
+        # @option opts [Array<String>] :properties 
+        # @option opts [String] :after The paging cursor token of the last successfully read resource will be returned as the &#x60;paging.next.after&#x60; JSON property of a paged response containing more results.
+        # @option opts [String] :before 
+        # @option opts [Integer] :limit Maximum number of result per page
+        # @option opts [Boolean] :archived Whether to return only results that have been archived.
+        # @return [Array<(CollectionResponseWithTotalUrlMapping, Integer, Hash)>] CollectionResponseWithTotalUrlMapping 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: RedirectsApi.get_page ...'
+          end
+          # resource path
+          local_var_path = '/cms/v3/url-redirects/'
+
+          # query parameters
+          query_params = opts[:query_params] || {}
+          query_params[:'createdAt'] = opts[:'created_at'] if !opts[:'created_at'].nil?
+          query_params[:'createdAfter'] = opts[:'created_after'] if !opts[:'created_after'].nil?
+          query_params[:'createdBefore'] = opts[:'created_before'] if !opts[:'created_before'].nil?
+          query_params[:'updatedAt'] = opts[:'updated_at'] if !opts[:'updated_at'].nil?
+          query_params[:'updatedAfter'] = opts[:'updated_after'] if !opts[:'updated_after'].nil?
+          query_params[:'updatedBefore'] = opts[:'updated_before'] if !opts[:'updated_before'].nil?
+          query_params[:'sort'] = @api_client.build_collection_param(opts[:'sort'], :multi) if !opts[:'sort'].nil?
+          query_params[:'properties'] = @api_client.build_collection_param(opts[:'properties'], :multi) if !opts[:'properties'].nil?
+          query_params[:'after'] = opts[:'after'] if !opts[:'after'].nil?
+          query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
+          query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+          query_params[:'archived'] = opts[:'archived'] if !opts[:'archived'].nil?
+
+          # 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] || 'CollectionResponseWithTotalUrlMapping' 
+
+          # auth_names
+          auth_names = opts[:auth_names] || ['hapikey', 'oauth2']
+
+          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: RedirectsApi#get_page\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+          end
+          return data, status_code, headers
+        end
+
+        # Update a redirect
+        # Updates the settings for an existing URL redirect.
+        # @param url_redirect_id [String] 
+        # @param [Hash] opts the optional parameters
+        # @option opts [UrlMapping] :url_mapping 
+        # @return [UrlMapping]
+        def update(url_redirect_id, opts = {})
+          data, _status_code, _headers = update_with_http_info(url_redirect_id, opts)
+          data
+        end
+
+        # Update a redirect
+        # Updates the settings for an existing URL redirect.
+        # @param url_redirect_id [String] 
+        # @param [Hash] opts the optional parameters
+        # @option opts [UrlMapping] :url_mapping 
+        # @return [Array<(UrlMapping, Integer, Hash)>] UrlMapping data, response status code and response headers
+        def update_with_http_info(url_redirect_id, opts = {})
+          if @api_client.config.debugging
+            @api_client.config.logger.debug 'Calling API: RedirectsApi.update ...'
+          end
+          # verify the required parameter 'url_redirect_id' is set
+          if @api_client.config.client_side_validation && url_redirect_id.nil?
+            fail ArgumentError, "Missing the required parameter 'url_redirect_id' when calling RedirectsApi.update"
+          end
+          # resource path
+          local_var_path = '/cms/v3/url-redirects/{urlRedirectId}'.sub('{' + 'urlRedirectId' + '}', CGI.escape(url_redirect_id.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', '*/*'])
+          # 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(opts[:'url_mapping']) 
+
+          # return_type
+          return_type = opts[:return_type] || 'UrlMapping' 
+
+          # auth_names
+          auth_names = opts[:auth_names] || ['hapikey', 'oauth2']
+
+          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(:PATCH, local_var_path, new_options)
+          if @api_client.config.debugging
+            @api_client.config.logger.debug "API called: RedirectsApi#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+          end
+          return data, status_code, headers
+        end
+      end
+    end
+  end
+end