hubspot-api-client 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a6b58b203d4071bf15810f2b8dc74bdf5c0e76df2228b769a741310f116b01e9
+  data.tar.gz: 97f079b32bdda82fbdef60f56125a5f6fcd18586298354b95ab1b9a795a44360
+SHA512:
+  metadata.gz: 774cd20311e90aec53cf85dd06a3cdd345f35828c69d86a4fa0b8615b8a3d188482814c7fa139abb357d83bbc29e09fff97c6ae6f3937195c30271e9eb6c2f0b
+  data.tar.gz: edc7b368209f997485db8a1242ba5b626dbabd6e53428ca1beba440c8fa2d646049359b923ae8cf1fa49ee50b05d9738988c2208629ce98acfa3a7f716cde018

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 12.0.0'
+end

data/Gemfile.lock

@@ -0,0 +1,68 @@
+PATH
+  remote: .
+  specs:
+    hubspot-api-client (1.0.0)
+      faraday (>= 0.14.0)
+      json (~> 2.1, >= 2.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ZenTest (4.12.0)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    autotest (4.4.6)
+      ZenTest (>= 4.4.1)
+    autotest-fsevent (0.2.15)
+      sys-uname
+    autotest-growl (0.2.16)
+    autotest-rails-pure (4.1.2)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    faraday (1.0.0)
+      multipart-post (>= 1.2, < 3)
+    ffi (1.11.3)
+    hashdiff (1.0.0)
+    json (2.3.0)
+    multipart-post (2.1.1)
+    public_suffix (4.0.1)
+    rake (12.0.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.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-support (3.9.0)
+    safe_yaml (1.0.5)
+    sys-uname (1.1.1)
+      ffi (>= 1.0.0)
+    vcr (3.0.3)
+    webmock (1.24.6)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  autotest (~> 4.4, >= 4.4.6)
+  autotest-fsevent (~> 0.2, >= 0.2.12)
+  autotest-growl (~> 0.2, >= 0.2.16)
+  autotest-rails-pure (~> 4.1, >= 4.1.2)
+  hubspot-api-client!
+  rake (~> 12.0.0)
+  rspec (~> 3.6, >= 3.6.0)
+  vcr (~> 3.0, >= 3.0.1)
+  webmock (~> 1.24, >= 1.24.3)
+
+BUNDLED WITH
+   1.17.3

data/README.md

@@ -0,0 +1,109 @@
+# hubspot-api-client
+Ruby API v3 Client files and sample apps
+
+- API version: v3
+- Package version: 1.0.0
+- Build package: io.swagger.codegen.languages.RubyClientCodegen
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build hubspot-api-client.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./hubspot-api-client-1.0.0.gem
+```
+(for development, run `gem install --dev ./hubspot-api-client-1.0.0.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'hubspot-api-client', '~> 1.0.0'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
+
+    gem 'hubspot-api-client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+```ruby
+# Load the gem
+require 'hubspot-api-client'
+
+# Setup authorization
+Hubspot.configure do |config|
+  # Configure API key authorization: hapikey
+  config.api_key['hapikey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['hapikey'] = 'Bearer'
+
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = Hubspot::Client::Crm::Objects::Api::AssociationsApi.new
+
+object_type = 'object_type_example' # String | 
+
+object_id = 'object_id_example' # String | 
+
+associated_object_type = 'associated_object_type_example' # String | 
+
+to_object_id = 'to_object_id_example' # String | 
+
+
+begin
+  #Remove an association between two objects
+  api_instance.archive_association(object_type, object_id, associated_object_type, to_object_id)
+rescue Hubspot::Client::Crm::Objects::ApiError => e
+  puts "Exception when calling AssociationsApi->archive_association: #{e}"
+end
+
+```
+
+### Error handling
+
+#### You can set number of retry attempts and delay in seconds before retry on specific status code of response.
+
+Available params:
+  - max_retries (maximum number of retries)
+  - seconds_delay (pause in seconds between retries)
+  - retry_block (block that is executed after every retry)
+
+
+```ruby
+config = ::Hubspot::Client::Crm::Companies::Configuration.new do |config|
+  config.access_token = 'YOUR ACCESS TOKEN'
+
+  # Set handlers of statuses you want to handle
+  config.error_handler = {
+    [429, 430, 442] => { max_retries: 5, seconds_delay: 1 },
+    (500..530).to_a => { max_retries: 2, seconds_delay: 2 },
+    400 => { max_retries: 3, seconds_delay: 3 },
+  }
+end
+
+api_client = ::Hubspot::Client::Crm::Companies::ApiClient.new(config)
+basic_api = ::Hubspot::Client::Crm::Companies::Api::BasicApi.new(api_client)
+end
+
+```

data/Rakefile

@@ -0,0 +1,8 @@
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/git_push.sh

@@ -0,0 +1,55 @@
+#!/bin/sh
+#
+# Generated by: https://github.com/swagger-api/swagger-codegen.git
+#
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 swagger-petstore-perl "minor update"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="GIT_USER_ID"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="GIT_REPO_ID"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=`git remote`
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://github.com/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:${GIT_TOKEN}@github.com/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://github.com/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'
+

data/hubspot-api-client.gemspec

@@ -0,0 +1,31 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "hubspot/version"
+
+Gem::Specification.new do |s|
+  s.name        = "hubspot-api-client"
+  s.version     = Hubspot::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["HubSpot"]
+  s.email       = [""]
+  s.homepage    = "https://github.com/HubSpot/hubspot-api-ruby"
+  s.summary     = "HubSpot Ruby API Gem"
+  s.description = "HubSpot Ruby API client"
+  s.license     = "Unlicense"
+  s.required_ruby_version = ">= 1.9"
+
+  s.add_runtime_dependency 'faraday', '>= 0.14.0'
+  s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+  s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
+  s.add_development_dependency 'webmock', '~> 1.24', '>= 1.24.3'
+  s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
+  s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
+  s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
+  s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.12'
+
+  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/lib/hubspot-api-client.rb

@@ -0,0 +1,49 @@
+=begin
+#CRM Objects
+
+#CRM objects such as companies, contacts, deals, line items, products, tickets, and quotes are native objects in HubSpot’s CRM. These core building blocks support custom properties, store critical information, and play a central role in the HubSpot application.  ## Supported Object Types  This API provides access to collections of CRM objects, which return a map of property names to values. Each object type has its own set of default properties, which can be found by exploring the [CRM Object Properties API](https://developers.hubspot.com/docs/methods/crm-properties/crm-properties-overview).  |Object Type |Properties returned by default | |--|--| | `companies` | `name`, `domain` | | `contacts` | `firstname`, `lastname`, `email` | | `deals` | `dealname`, `amount`, `closedate`, `pipeline`, `dealstage` | | `products` | `name`, `description`, `price` | | `tickets` | `content`, `hs_pipeline`, `hs_pipeline_stage`, `hs_ticket_category`, `hs_ticket_priority`, `subject` |  Find a list of all properties for an object type using the [CRM Object Properties](https://developers.hubspot.com/docs/methods/crm-properties/get-properties) API. e.g. `GET https://api.hubapi.com/properties/v2/companies/properties`. Change the properties returned in the response using the `properties` array in the request body.
+
+OpenAPI spec version: v3
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.8
+
+=end
+
+require 'uri'
+require 'logger'
+
+ROOT_PATH = File.dirname(__FILE__)
+Dir["#{ROOT_PATH}/hubspot/**/*.rb"].each { |f| require f }
+
+
+module Hubspot
+  class << self
+    CLIENTS = [
+      'OAuth',
+      'Crm::Associations',
+      'Crm::Companies',
+      'Crm::Contacts',
+      'Crm::Deals',
+      'Crm::Extensions::Cards',
+      'Crm::LineItems',
+      'Crm::Objects',
+      'Crm::Owners',
+      'Crm::Pipelines',
+      'Crm::Products',
+      'Crm::Properties',
+      'Crm::Quotes',
+      'Crm::Tickets'
+    ].freeze
+
+    def configure
+      return Configuration.default unless block_given?
+      yield(Configuration.default)
+      CLIENTS.each do |client_class_name|
+        config_class = Hubspot.const_get("Client::#{client_class_name}::Configuration")
+        yield(config_class.default)
+      end
+      Configuration.default
+    end
+  end
+end

data/lib/hubspot/codegen/crm/associations/api/batch_api.rb

@@ -0,0 +1,246 @@
+=begin
+#Associations
+
+#Associations define the relationships between objects in HubSpot. These endpoints allow you to create, read, and remove associations.
+
+The version of the OpenAPI document: v3
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.2.2
+
+=end
+
+require 'cgi'
+
+module Hubspot
+  module Client
+    module Crm
+      module Associations
+        module Api
+          class BatchApi
+            attr_accessor :api_client
+
+            def initialize(api_client = ApiClient.default)
+              @api_client = api_client
+            end
+            # Archive a batch of associations
+            # Remove the associations between all pairs of objects identified in the request body.
+            # @param from_object_type [String] 
+            # @param to_object_type [String] 
+            # @param [Hash] opts the optional parameters
+            # @option opts [BatchInputPublicAssociation] :batch_input_public_association 
+            # @return [nil]
+            def archive_batch(from_object_type, to_object_type, opts = {})
+              archive_batch_with_http_info(from_object_type, to_object_type, opts)
+              nil
+            end
+
+            # Archive a batch of associations
+            # Remove the associations between all pairs of objects identified in the request body.
+            # @param from_object_type [String] 
+            # @param to_object_type [String] 
+            # @param [Hash] opts the optional parameters
+            # @option opts [BatchInputPublicAssociation] :batch_input_public_association 
+            # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+            def archive_batch_with_http_info(from_object_type, to_object_type, opts = {})
+              if @api_client.config.debugging
+                @api_client.config.logger.debug 'Calling API: BatchApi.archive_batch ...'
+              end
+              # verify the required parameter 'from_object_type' is set
+              if @api_client.config.client_side_validation && from_object_type.nil?
+                fail ArgumentError, "Missing the required parameter 'from_object_type' when calling BatchApi.archive_batch"
+              end
+              # verify the required parameter 'to_object_type' is set
+              if @api_client.config.client_side_validation && to_object_type.nil?
+                fail ArgumentError, "Missing the required parameter 'to_object_type' when calling BatchApi.archive_batch"
+              end
+              # resource path
+              local_var_path = '/{fromObjectType}/{toObjectType}/batch/archive'.sub('{' + 'fromObjectType' + '}', CGI.escape(from_object_type.to_s).gsub('%2F', '/')).sub('{' + 'toObjectType' + '}', CGI.escape(to_object_type.to_s).gsub('%2F', '/'))
+
+              # 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'
+              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[:'batch_input_public_association']) 
+
+              # 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(:POST, local_var_path, new_options)
+              if @api_client.config.debugging
+                @api_client.config.logger.debug "API called: BatchApi#archive_batch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+              end
+              return data, status_code, headers
+            end
+
+            # Create a batch of associations
+            # Associate all pairs of objects identified in the request body.
+            # @param from_object_type [String] 
+            # @param to_object_type [String] 
+            # @param [Hash] opts the optional parameters
+            # @option opts [BatchInputPublicAssociation] :batch_input_public_association 
+            # @return [BatchResponsePublicAssociation]
+            def create_batch(from_object_type, to_object_type, opts = {})
+              data, _status_code, _headers = create_batch_with_http_info(from_object_type, to_object_type, opts)
+              data
+            end
+
+            # Create a batch of associations
+            # Associate all pairs of objects identified in the request body.
+            # @param from_object_type [String] 
+            # @param to_object_type [String] 
+            # @param [Hash] opts the optional parameters
+            # @option opts [BatchInputPublicAssociation] :batch_input_public_association 
+            # @return [Array<(BatchResponsePublicAssociation, Integer, Hash)>] BatchResponsePublicAssociation data, response status code and response headers
+            def create_batch_with_http_info(from_object_type, to_object_type, opts = {})
+              if @api_client.config.debugging
+                @api_client.config.logger.debug 'Calling API: BatchApi.create_batch ...'
+              end
+              # verify the required parameter 'from_object_type' is set
+              if @api_client.config.client_side_validation && from_object_type.nil?
+                fail ArgumentError, "Missing the required parameter 'from_object_type' when calling BatchApi.create_batch"
+              end
+              # verify the required parameter 'to_object_type' is set
+              if @api_client.config.client_side_validation && to_object_type.nil?
+                fail ArgumentError, "Missing the required parameter 'to_object_type' when calling BatchApi.create_batch"
+              end
+              # resource path
+              local_var_path = '/{fromObjectType}/{toObjectType}/batch/create'.sub('{' + 'fromObjectType' + '}', CGI.escape(from_object_type.to_s).gsub('%2F', '/')).sub('{' + 'toObjectType' + '}', CGI.escape(to_object_type.to_s).gsub('%2F', '/'))
+
+              # 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[:'batch_input_public_association']) 
+
+              # return_type
+              return_type = opts[:return_type] || 'BatchResponsePublicAssociation' 
+
+              # 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: BatchApi#create_batch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+              end
+              return data, status_code, headers
+            end
+
+            # Read a batch of associations
+            # Get the IDs of all `{toObjectType}` objects associated with those specified in the request body.
+            # @param from_object_type [String] 
+            # @param to_object_type [String] 
+            # @param [Hash] opts the optional parameters
+            # @option opts [BatchInputPublicObjectId] :batch_input_public_object_id 
+            # @return [BatchResponsePublicAssociationMulti]
+            def read_batch(from_object_type, to_object_type, opts = {})
+              data, _status_code, _headers = read_batch_with_http_info(from_object_type, to_object_type, opts)
+              data
+            end
+
+            # Read a batch of associations
+            # Get the IDs of all &#x60;{toObjectType}&#x60; objects associated with those specified in the request body.
+            # @param from_object_type [String] 
+            # @param to_object_type [String] 
+            # @param [Hash] opts the optional parameters
+            # @option opts [BatchInputPublicObjectId] :batch_input_public_object_id 
+            # @return [Array<(BatchResponsePublicAssociationMulti, Integer, Hash)>] BatchResponsePublicAssociationMulti data, response status code and response headers
+            def read_batch_with_http_info(from_object_type, to_object_type, opts = {})
+              if @api_client.config.debugging
+                @api_client.config.logger.debug 'Calling API: BatchApi.read_batch ...'
+              end
+              # verify the required parameter 'from_object_type' is set
+              if @api_client.config.client_side_validation && from_object_type.nil?
+                fail ArgumentError, "Missing the required parameter 'from_object_type' when calling BatchApi.read_batch"
+              end
+              # verify the required parameter 'to_object_type' is set
+              if @api_client.config.client_side_validation && to_object_type.nil?
+                fail ArgumentError, "Missing the required parameter 'to_object_type' when calling BatchApi.read_batch"
+              end
+              # resource path
+              local_var_path = '/{fromObjectType}/{toObjectType}/batch/read'.sub('{' + 'fromObjectType' + '}', CGI.escape(from_object_type.to_s).gsub('%2F', '/')).sub('{' + 'toObjectType' + '}', CGI.escape(to_object_type.to_s).gsub('%2F', '/'))
+
+              # 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[:'batch_input_public_object_id']) 
+
+              # return_type
+              return_type = opts[:return_type] || 'BatchResponsePublicAssociationMulti' 
+
+              # 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: BatchApi#read_batch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+              end
+              return data, status_code, headers
+            end
+          end
+        end
+      end
+    end
+  end
+end