hubspot-api-client 3.3.0 → 4.0.0

data/lib/hubspot/codegen/cms/url-redirects/models/url_mapping_create_request_body.rb

@@ -0,0 +1,306 @@
+=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 'date'
+
+module Hubspot
+  module Cms
+    module UrlRedirects
+      class UrlMappingCreateRequestBody
+        attr_accessor :route_prefix
+
+        attr_accessor :destination
+
+        attr_accessor :redirect_style
+
+        attr_accessor :precedence
+
+        attr_accessor :is_only_after_not_found
+
+        attr_accessor :is_match_full_url
+
+        attr_accessor :is_match_query_string
+
+        attr_accessor :is_pattern
+
+        attr_accessor :is_trailing_slash_optional
+
+        attr_accessor :is_protocol_agnostic
+
+        # Attribute mapping from ruby-style variable name to JSON key.
+        def self.attribute_map
+          {
+            :'route_prefix' => :'routePrefix',
+            :'destination' => :'destination',
+            :'redirect_style' => :'redirectStyle',
+            :'precedence' => :'precedence',
+            :'is_only_after_not_found' => :'isOnlyAfterNotFound',
+            :'is_match_full_url' => :'isMatchFullUrl',
+            :'is_match_query_string' => :'isMatchQueryString',
+            :'is_pattern' => :'isPattern',
+            :'is_trailing_slash_optional' => :'isTrailingSlashOptional',
+            :'is_protocol_agnostic' => :'isProtocolAgnostic'
+          }
+        end
+
+        # Attribute type mapping.
+        def self.openapi_types
+          {
+            :'route_prefix' => :'String',
+            :'destination' => :'String',
+            :'redirect_style' => :'Integer',
+            :'precedence' => :'Integer',
+            :'is_only_after_not_found' => :'Boolean',
+            :'is_match_full_url' => :'Boolean',
+            :'is_match_query_string' => :'Boolean',
+            :'is_pattern' => :'Boolean',
+            :'is_trailing_slash_optional' => :'Boolean',
+            :'is_protocol_agnostic' => :'Boolean'
+          }
+        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::UrlRedirects::UrlMappingCreateRequestBody` 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::UrlRedirects::UrlMappingCreateRequestBody`. 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?(:'route_prefix')
+            self.route_prefix = attributes[:'route_prefix']
+          end
+
+          if attributes.key?(:'destination')
+            self.destination = attributes[:'destination']
+          end
+
+          if attributes.key?(:'redirect_style')
+            self.redirect_style = attributes[:'redirect_style']
+          end
+
+          if attributes.key?(:'precedence')
+            self.precedence = attributes[:'precedence']
+          end
+
+          if attributes.key?(:'is_only_after_not_found')
+            self.is_only_after_not_found = attributes[:'is_only_after_not_found']
+          end
+
+          if attributes.key?(:'is_match_full_url')
+            self.is_match_full_url = attributes[:'is_match_full_url']
+          end
+
+          if attributes.key?(:'is_match_query_string')
+            self.is_match_query_string = attributes[:'is_match_query_string']
+          end
+
+          if attributes.key?(:'is_pattern')
+            self.is_pattern = attributes[:'is_pattern']
+          end
+
+          if attributes.key?(:'is_trailing_slash_optional')
+            self.is_trailing_slash_optional = attributes[:'is_trailing_slash_optional']
+          end
+
+          if attributes.key?(:'is_protocol_agnostic')
+            self.is_protocol_agnostic = attributes[:'is_protocol_agnostic']
+          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 @route_prefix.nil?
+            invalid_properties.push('invalid value for "route_prefix", route_prefix cannot be nil.')
+          end
+
+          if @destination.nil?
+            invalid_properties.push('invalid value for "destination", destination cannot be nil.')
+          end
+
+          if @redirect_style.nil?
+            invalid_properties.push('invalid value for "redirect_style", redirect_style 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 @route_prefix.nil?
+          return false if @destination.nil?
+          return false if @redirect_style.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 &&
+              route_prefix == o.route_prefix &&
+              destination == o.destination &&
+              redirect_style == o.redirect_style &&
+              precedence == o.precedence &&
+              is_only_after_not_found == o.is_only_after_not_found &&
+              is_match_full_url == o.is_match_full_url &&
+              is_match_query_string == o.is_match_query_string &&
+              is_pattern == o.is_pattern &&
+              is_trailing_slash_optional == o.is_trailing_slash_optional &&
+              is_protocol_agnostic == o.is_protocol_agnostic
+        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
+          [route_prefix, destination, redirect_style, precedence, is_only_after_not_found, is_match_full_url, is_match_query_string, is_pattern, is_trailing_slash_optional, is_protocol_agnostic].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::UrlRedirects.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/version.rb

@@ -1,3 +1,3 @@
  module Hubspot
-  VERSION = '3.3.0'
+  VERSION = '4.0.0'
  end

data/sample-apps/search-result-paging-app/.env.template

@@ -0,0 +1,4 @@
+HUBSPOT_CLIENT_ID=
+HUBSPOT_CLIENT_SECRET=
+SEARCH_QUERY=mail
+SEARCH_BATCH_SIZE=100

data/sample-apps/search-result-paging-app/.gitignore

@@ -0,0 +1,35 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+/db/*.sqlite3-journal
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+
+# Ignore uploaded files in development
+/storage/*
+!/storage/.keep
+
+/node_modules
+/yarn-error.log
+
+/public/assets
+.byebug_history
+
+# Ignore master key for decrypting credentials and more.
+/config/master.key
+
+.rubocop.yml
+.env
+.env.test

data/sample-apps/search-result-paging-app/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/sample-apps/search-result-paging-app/.ruby-version

@@ -0,0 +1 @@
+ruby-2.6.3

data/sample-apps/search-result-paging-app/Dockerfile

@@ -0,0 +1,22 @@
+FROM ruby:2.6.3
+RUN apt-get update -qq && apt-get install -y nodejs postgresql-client
+RUN mkdir /hubspot-api-client
+
+COPY ./lib /hubspot-api-client/lib
+COPY ./sample-apps /hubspot-api-client/sample-apps
+COPY ./spec /hubspot-api-client/spec
+COPY ./Gemfile /hubspot-api-client/Gemfile
+COPY ./Gemfile.lock /hubspot-api-client/Gemfile.lock
+COPY ./hubspot-api-client.gemspec /hubspot-api-client/hubspot-api-client.gemspec
+
+WORKDIR /hubspot-api-client/sample-apps/search-result-paging-app
+RUN bundle install
+
+# Add a script to be executed every time the container starts.
+COPY ./sample-apps/search-result-paging-app/docker-entrypoint.sh /usr/bin/
+RUN chmod +x /usr/bin/docker-entrypoint.sh
+ENTRYPOINT ["docker-entrypoint.sh"]
+EXPOSE 3000
+
+# Start the main process.
+CMD ["rails", "server", "-b", "0.0.0.0"]

data/sample-apps/search-result-paging-app/Gemfile

@@ -0,0 +1,35 @@
+source 'https://rubygems.org'
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+ruby '2.6.3'
+
+gem 'rails', '~> 5.2.3'
+gem 'sqlite3'
+gem 'puma', '~> 4.3'
+gem 'sass-rails', '~> 5.0'
+gem 'uglifier', '>= 1.3.0'
+gem 'jbuilder', '~> 2.5'
+gem 'jquery-rails'
+gem 'jquery-ui-rails'
+gem 'clipboard-rails'
+
+gem 'hubspot-api-client', path: '../../'
+
+group :development, :test do
+  gem 'dotenv-rails', require: 'dotenv/rails-now'
+  gem 'byebug', platforms: [:mri, :mingw, :x64_mingw]
+  gem 'rspec-rails', '~> 3.5'
+  gem 'capybara'
+  gem 'capybara-mechanize', '~> 1.11'
+  gem 'selenium-webdriver', '3.4.3'
+  gem 'geckodriver-helper'
+  gem 'pry'
+  gem 'pry-byebug'
+end
+
+group :development do
+  gem 'web-console', '>= 3.3.0'
+  gem 'listen', '>= 3.0.5', '< 3.2'
+end
+
+gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]

data/sample-apps/search-result-paging-app/Gemfile.lock

@@ -0,0 +1,279 @@
+PATH
+  remote: ../..
+  specs:
+    hubspot-api-client (3.3.0)
+      faraday (>= 0.14.0)
+      json (~> 2.1, >= 2.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.2.3)
+      actionpack (= 5.2.3)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailer (5.2.3)
+      actionpack (= 5.2.3)
+      actionview (= 5.2.3)
+      activejob (= 5.2.3)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.2.3)
+      actionview (= 5.2.3)
+      activesupport (= 5.2.3)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.3)
+      activesupport (= 5.2.3)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.2.3)
+      activesupport (= 5.2.3)
+      globalid (>= 0.3.6)
+    activemodel (5.2.3)
+      activesupport (= 5.2.3)
+    activerecord (5.2.3)
+      activemodel (= 5.2.3)
+      activesupport (= 5.2.3)
+      arel (>= 9.0)
+    activestorage (5.2.3)
+      actionpack (= 5.2.3)
+      activerecord (= 5.2.3)
+      marcel (~> 0.3.1)
+    activesupport (5.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    archive-zip (0.12.0)
+      io-like (~> 0.3.0)
+    arel (9.0.0)
+    bindex (0.8.1)
+    builder (3.2.3)
+    byebug (11.0.1)
+    capybara (3.29.0)
+      addressable
+      mini_mime (>= 0.1.3)
+      nokogiri (~> 1.8)
+      rack (>= 1.6.0)
+      rack-test (>= 0.6.3)
+      regexp_parser (~> 1.5)
+      xpath (~> 3.2)
+    capybara-mechanize (1.11.0)
+      capybara (>= 2.4.4, < 4)
+      mechanize (~> 2.7.0)
+    childprocess (0.9.0)
+      ffi (~> 1.0, >= 1.0.11)
+    clipboard-rails (1.7.1)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.5)
+    connection_pool (2.2.2)
+    crass (1.0.5)
+    diff-lcs (1.3)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    dotenv (2.7.5)
+    dotenv-rails (2.7.5)
+      dotenv (= 2.7.5)
+      railties (>= 3.2, < 6.1)
+    erubi (1.9.0)
+    execjs (2.7.0)
+    faraday (1.0.1)
+      multipart-post (>= 1.2, < 3)
+    ffi (1.11.1)
+    geckodriver-helper (0.24.0)
+      archive-zip (~> 0.7)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    i18n (1.7.0)
+      concurrent-ruby (~> 1.0)
+    io-like (0.3.0)
+    jbuilder (2.9.1)
+      activesupport (>= 4.2.0)
+    jquery-rails (4.4.0)
+      rails-dom-testing (>= 1, < 3)
+      railties (>= 4.2.0)
+      thor (>= 0.14, < 2.0)
+    jquery-ui-rails (6.0.1)
+      railties (>= 3.2.16)
+    json (2.3.0)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    loofah (2.3.1)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    mechanize (2.7.6)
+      domain_name (~> 0.5, >= 0.5.1)
+      http-cookie (~> 1.0)
+      mime-types (>= 1.17.2)
+      net-http-digest_auth (~> 1.1, >= 1.1.1)
+      net-http-persistent (>= 2.5.2)
+      nokogiri (~> 1.6)
+      ntlm-http (~> 0.1, >= 0.1.1)
+      webrobots (>= 0.0.9, < 0.2)
+    method_source (0.9.2)
+    mime-types (3.3)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2019.1009)
+    mimemagic (0.3.3)
+    mini_mime (1.0.2)
+    mini_portile2 (2.4.0)
+    minitest (5.13.0)
+    multipart-post (2.1.1)
+    net-http-digest_auth (1.4.1)
+    net-http-persistent (3.1.0)
+      connection_pool (~> 2.2)
+    nio4r (2.5.2)
+    nokogiri (1.10.5)
+      mini_portile2 (~> 2.4.0)
+    ntlm-http (0.1.1)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.7.0)
+      byebug (~> 11.0)
+      pry (~> 0.10)
+    public_suffix (4.0.1)
+    puma (4.3.1)
+      nio4r (~> 2.0)
+    rack (2.2.2)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (5.2.3)
+      actioncable (= 5.2.3)
+      actionmailer (= 5.2.3)
+      actionpack (= 5.2.3)
+      actionview (= 5.2.3)
+      activejob (= 5.2.3)
+      activemodel (= 5.2.3)
+      activerecord (= 5.2.3)
+      activestorage (= 5.2.3)
+      activesupport (= 5.2.3)
+      bundler (>= 1.3.0)
+      railties (= 5.2.3)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (5.2.3)
+      actionpack (= 5.2.3)
+      activesupport (= 5.2.3)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.19.0, < 2.0)
+    rake (13.0.0)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.10.0)
+      ffi (~> 1.0)
+    regexp_parser (1.6.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-rails (3.9.0)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    ruby_dep (1.5.0)
+    rubyzip (1.3.0)
+    sass (3.7.4)
+      sass-listen (~> 4.0.0)
+    sass-listen (4.0.0)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+    sass-rails (5.1.0)
+      railties (>= 5.2.0)
+      sass (~> 3.1)
+      sprockets (>= 2.8, < 4.0)
+      sprockets-rails (>= 2.0, < 4.0)
+      tilt (>= 1.1, < 3)
+    selenium-webdriver (3.4.3)
+      childprocess (~> 0.5)
+      rubyzip (~> 1.0)
+    sprockets (3.7.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.4.1)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tilt (2.0.10)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    uglifier (4.2.0)
+      execjs (>= 0.3.0, < 3)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.6)
+    web-console (3.7.0)
+      actionview (>= 5.0)
+      activemodel (>= 5.0)
+      bindex (>= 0.4.0)
+      railties (>= 5.0)
+    webrobots (0.1.2)
+    websocket-driver (0.7.1)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.4)
+    xpath (3.2.0)
+      nokogiri (~> 1.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug
+  capybara
+  capybara-mechanize (~> 1.11)
+  clipboard-rails
+  dotenv-rails
+  geckodriver-helper
+  hubspot-api-client!
+  jbuilder (~> 2.5)
+  jquery-rails
+  jquery-ui-rails
+  listen (>= 3.0.5, < 3.2)
+  pry
+  pry-byebug
+  puma (~> 4.3)
+  rails (~> 5.2.3)
+  rspec-rails (~> 3.5)
+  sass-rails (~> 5.0)
+  selenium-webdriver (= 3.4.3)
+  sqlite3
+  tzinfo-data
+  uglifier (>= 1.3.0)
+  web-console (>= 3.3.0)
+
+RUBY VERSION
+   ruby 2.6.3p62
+
+BUNDLED WITH
+   1.17.3