hubspot-api-client 10.0.1 → 17.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7e237972f3e1843e28d56c91e154cce8f756920bd9822b227a9f4818178830e
-  data.tar.gz: 39d168f6d899f60de7a7cfd679e90c446e18daeb7218c1bdaf71fd0c63738bd6
+  metadata.gz: c65b1899e69edcb77d187160ceb56978edd2117093505c1dd931448e20c39f9b
+  data.tar.gz: f9d4c851d037fd7233549dc92eb084db5c74dd03bbbeb3152a1d41590a0eb726
 SHA512:
-  metadata.gz: acf8984f3b41b74b03c977181a872224d738890f8abb4d1920b2b8c82e24ae556b3e3cd16054df865a716caf7f3ad935623183ca4a72d30ecebc7e406ebf7222
-  data.tar.gz: f47ad82c7bcbfe5ddfcf8d0e88c322219f795c86a9d3f1bd1c065fbba5b87d8745607f589ff8027997d3b1468dd24f7e523afadda59ca37b715e83b9959063e2
+  metadata.gz: 57bede9b4606c0977a9faeab6ba749909fae6a6b9adfd6445ec06889bed6a0be16375dd258597b7bf04a06a12548b8074debfcc9f5464133170bd14c6610740f
+  data.tar.gz: fd6a046cfb2a88c82c0b7ed0ec5a708f5c06c9d556e6f4675a3fb724f733ed8956ec4bfc257c7e5bd188fa387d6652895df09e75ddb858cb1c1b49d87bdac5e2

data/CHANGELOG.md

@@ -5,6 +5,346 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [Unreleased](https://github.com/HubSpot/hubspot-api-ruby/compare/v17.1.0...HEAD)
+
+
+## [17.1.0] - 2023-08-07
+
+## Removed `hapikey` from
+
+- `automation.actions.callbacksApi` Api.
+- `cms` (all Api clients).
+- `communicationPreferences` (all Api clients).
+- `conversations` (all API clients).
+- `crm` (all Api clients).
+- `events` (all Api clients).
+- `files` (all Api clients).
+- `marketing.events.settingsExternalApi` Api.
+- `marketing.transactional` Api client.
+
+## Updated
+
+- Cnange type from `object` to `string` in `cms/hubdb/models/StandardError::category`.
+- Cnange type from `StandardError[]` to `StandardError1[]` in `crm/associations/v4/models/BatchResponseSimplePublicObjectWithErrors::errors`.
+- Cnange type from `ErrorCategory` to `string` in `crm/companies/models/StandardError::category`.
+- Cnange type from `ErrorCategory` to `string` in `crm/contacts/models/StandardError::category`.
+- Cnange type from `ErrorCategory` to `string` in `crm/deals/models/StandardError::category`.
+- Cnange type from `ErrorCategory` to `string` in `crm/lineitems/models/StandardError::category`.
+- Cnange type from `ErrorCategory` to `string` in `crm/objects/calls/models/StandardError::category`.
+- Cnange type from `ErrorCategory` to `string` in `crm/objects/communications/models/StandardError::category`.
+- Cnange type from `ErrorCategory` to `string` in `crm/objects/emails/models/StandardError::category`.
+- Cnange type from `ErrorCategory` to `string` in `crm/objects/feedback_submissions/models/StandardError::category`.
+- Cnange type from `ErrorCategory` to `string` in `crm/objects/meetings/models/StandardError::category`.
+- Cnange type from `ErrorCategory` to `string` in `crm/objects/models/StandardError::category`.
+- Cnange type from `ErrorCategory` to `string` in `crm/objects/notes/models/StandardError::category`.
+- Cnange type from `ErrorCategory` to `string` in `crm/objects/postal_mail/models/StandardError::category`.
+- Cnange type from `ErrorCategory` to `string` in `crm/objects/tasks/models/StandardError::category`.
+- Cnange type from `ErrorCategory` to `string` in `crm/products/models/StandardError::category`.
+- Cnange type from `ErrorCategory` to `string` in `crm/properties/models/StandardError::category`.
+- Cnange type from `ErrorCategory` to `string` in `crm/quotes/models/StandardError::category`.
+- Cnange type from `ErrorCategory` to `string` in `crm/tickets/models/StandardError::category`.
+- Cnange type from `ErrorCategory` to `string` in `webhooks/models/StandardError::category`.
+
+## Fixed
+- `Hubspot::Helpers::Path.require_with_codegen_mapping()` 
+
+
+## [17.0.0] - 2023-06-14
+
+## Updated
+
+- Fix `Hubspot::OAuthHelper.authorize_url()` (don't add empty scopes or optional scopes to OAuth url)
+
+## [17.0.0.pre.beta.4] - 2023-05-17
+
+## Added
+
+- added custom exceptions for Signature
+- add associations types
+
+## Updated
+
+- remove deprecated `validate_signature`
+
+## [17.0.0-beta.3] - 2023-05-12
+
+## Added
+
+- `crm.associations.v4.basic_api` Api.
+- `crm.objects.communications` Api client
+
+### Updated
+
+  - `crm.associations.types_api` => `crm.associations.schema.types_api`.
+  - `crm.associations.v4.definitions_api` => `crm.associations.v4.schema.definitions_api`.
+
+## [17.0.0-beta.2] - 2023-04-28
+### Updated
+
+-Add new event types to webhooks.
+
+
+## [17.0.0-beta.1] - 2023-04-11
+### Updated
+
+- Rename `cms.hubdb.rows_batch_api.batch_clone_draft_table_rows` => `cms.hubdb.rows_batch_api.clone_draft_table_rows`.
+- Rename `cms.hubdb.rows_batch_api.batch_create_draft_table_rows` => `cms.hubdb.rows_batch_api.create_draft_table_rows`.
+- Rename `cms.hubdb.rows_batch_api.batch_purge_draft_table_rows` => `cms.hubdb.rows_batch_api.purge_draft_table_rows`.
+- Rename `cms.hubdb.rows_batch_api.batch_ReadDrafttable_rows` => `cms.hubdb.rows_batch_api.read_draft_table_rows`.
+- Rename `cms.hubdb.rows_batch_api.batch_read_table_rows` => `cms.hubdb.rows_batch_api.read_table_rows`.
+- Rename `cms.hubdb.rows_batch_api.batch_replace_draft_table_rows` => `cms.hubdb.rows_batch_api.replace_draft_table_rows`.
+- Rename `cms.hubdb.rows_batch_api.batch_update_draft_table_rows` => `cms.hubdb.rows_batch_api.update_draft_table_rows`.
+- `cms.hubdb.tables_api.get_draft_table_details_by_id` => `cms.hubdb.tables_api.get_draft_table_details_by_id(+include_foreign_ids: bool)`
+- `cms.hubdb.tables_api.get_table_details` => `cms.hubdb.tables_api.get_table_details(+include_foreign_ids: bool)`
+- `cms.hubdb.tables_api.update_draft_table` => `cms.hubdb.tables_api.update_draft_table(+include_foreign_ids: bool)`
+- Removed `crm.companies.associations_api`.
+- Removed `crm.contacts.associations_api`.
+- Removed `crm.deals.associations_api`.
+- Removed `crm.line_items.associations_api`.
+- Removed `crm.objects.calls.associations_api`.
+- Removed `crm.objects.emails.associations_api`.
+- Removed `crm.objects.feedback_submissions.associations_api`.
+- Removed `crm.objects.meetings.associations_api`.
+- Removed `crm.objects.notes.associations_api`.
+- Removed `crm.objects.postal_mail.associations_api`.
+- Removed `crm.objects.tasks.associations_api`.
+- Removed `crm.products.associations_api`.
+- Removed `crm.quotes.associations_api`.
+- Removed `crm.tickets.associations_api`.
+- `crm.companies.basic_api.create(SimplePublicObjectInput => SimplePublicObjectInputForCreate)`
+- `crm.companies.batch_api.create(BatchInputSimplePublicObjectInput => BatchInputSimplePublicObjectInputForCreate)`
+- `crm.contacts.basic_api.create(SimplePublicObjectInput => SimplePublicObjectInputForCreate)`
+- `crm.contacts.batch_api.create(BatchInputSimplePublicObjectInput => BatchInputSimplePublicObjectInputForCreate)`
+- `crm.deals.basic_api.create(SimplePublicObjectInput => SimplePublicObjectInputForCreate)`
+- `crm.deals.batch_api.create(BatchInputSimplePublicObjectInput => BatchInputSimplePublicObjectInputForCreate)`
+- `crm.line_items.basic_api.create(SimplePublicObjectInput => SimplePublicObjectInputForCreate)`
+- `crm.line_items.batch_api.create(BatchInputSimplePublicObjectInput => BatchInputSimplePublicObjectInputForCreate)`
+- `crm.objects.basic_api.create(SimplePublicObjectInput => SimplePublicObjectInputForCreate)`
+- `crm.objects.batch_api.create(BatchInputSimplePublicObjectInput => BatchInputSimplePublicObjectInputForCreate)`
+- `crm.objects.calls.basic_api.create(SimplePublicObjectInput => SimplePublicObjectInputForCreate)`
+- `crm.objects.calls.batch_api.create(BatchInputSimplePublicObjectInput => BatchInputSimplePublicObjectInputForCreate)`
+- `crm.objects.emails.basic_api.create(SimplePublicObjectInput => SimplePublicObjectInputForCreate)`
+- `crm.objects.emails.batch_api.create(BatchInputSimplePublicObjectInput => BatchInputSimplePublicObjectInputForCreate)`
+- `crm.objects.feedback_submissions.basic_api.create(SimplePublicObjectInput => SimplePublicObjectInputForCreate)`
+- `crm.objects.feedback_submissions.batch_api.create(BatchInputSimplePublicObjectInput => BatchInputSimplePublicObjectInputForCreate)`
+- `crm.objects.meetings.basic_api.create(SimplePublicObjectInput => SimplePublicObjectInputForCreate)`
+- `crm.objects.meetings.batch_api.create(BatchInputSimplePublicObjectInput => BatchInputSimplePublicObjectInputForCreate)`
+- `crm.objects.notes.basic_api.create(SimplePublicObjectInput => SimplePublicObjectInputForCreate)`
+- `crm.objects.notes.batch_api.create(BatchInputSimplePublicObjectInput => BatchInputSimplePublicObjectInputForCreate)`
+- `crm.objects.postal_mail.basic_api.create(SimplePublicObjectInput => SimplePublicObjectInputForCreate)`
+- `crm.objects.postal_mail.batch_api.create(BatchInputSimplePublicObjectInput => BatchInputSimplePublicObjectInputForCreate)`
+- `crm.objects.tasks.basic_api.create(SimplePublicObjectInput => SimplePublicObjectInputForCreate)`
+- `crm.objects.tasks.batch_api.create(BatchInputSimplePublicObjectInput => BatchInputSimplePublicObjectInputForCreate)`
+- `crm.objects.products.basic_api.create(SimplePublicObjectInput => SimplePublicObjectInputForCreate)`
+- `crm.objects.products.batch_api.create(BatchInputSimplePublicObjectInput => BatchInputSimplePublicObjectInputForCreate)`
+- `crm.objects.quotes.basic_api.create(SimplePublicObjectInput => SimplePublicObjectInputForCreate)`
+- `crm.objects.quotes.batch_api.create(BatchInputSimplePublicObjectInput => BatchInputSimplePublicObjectInputForCreate)`
+- `crm.objects.tickets.basic_api.create(SimplePublicObjectInput => SimplePublicObjectInputForCreate)`
+- `crm.objects.tickets.batch_api.create(BatchInputSimplePublicObjectInput => BatchInputSimplePublicObjectInputForCreate)`
+- `marketing.events.marketing_events_external_api.do_search` => `marketing.events.search_api.do_search`
+- Rename `oauth.access_tokens_api.get_accessToken` => `oauth.access_tokens_api.get`.
+- Rename `oauth.refresh_tokens_api.archive_refresh_token` => `oauth.refresh_tokens_api.archive`.
+- Rename `oauth.refresh_tokens_api.get_refreshToken` => `oauth.refresh_tokens_api.get`.
+- Rename `oauth.tokens_api.create_token` => `oauth.tokens_api.create`.
+
+### Added
+
+- Added param `properties` to `crm.properties.core_api.get_all`.
+- Added param `properties` to `crm.properties.core_api.get_by_name`.
+- Added `high_value` param to all Filters.
+
+## [16.4.0] - 2023-03-02
+### Added
+
+- Update models for `crm.properties` API client
+
+## [16.3.0] - 2023-02-21
+### Added
+
+- `crm.associations.v4` API client
+
+### Fixed
+
+- Fix `auth.oauth.refresh_tokens_api.archive_refresh_token` method
+
+
+## [16.2.1] - 2023-01-24
+### Fixed
+
+- Added missing modules
+
+
+## [16.2.0] - 2023-01-09
+### Added
+
+- Signature's util 'HubSpot.utils.signature'
+
+### Deprecated
+
+- webhook's util 'HubSpot.utils.webhooks'
+
+## [16.1.1] - 2022-12-23
+### Fixed
+
+- Added pipelineAuditsApi and pipelineStageAuditsApi to crm.pipelines discovery
+
+## [16.1.0] - 2022-12-22
+### Added
+
+- crm.objects.postal_mail API client
+
+## [16.0.4] - 2022-12-08
+### Changed
+
+- Added Private App access token to (
+    - cms.domains
+    - crm.imports
+    - crm.objects.emails
+    - marketing.events
+    )
+
+### Fixed
+
+- Fix all association APIs
+
+## [16.0.3] - 2022-11-23
+### Changed
+
+- auth_names => debug_auth_names
+
+## [16.0.2] - 2022-11-22
+### Fixed
+
+- added missing public_object_api classes
+
+## [16.0.1] - 2022-11-16
+### Fixed
+
+- remove passing params with snake case
+
+## [16.0.0] - 2022-11-10
+### Changed
+
+- update generated code
+- marketing.events (breaking changes)
+
+## [15.0.2] - 2022-11-04
+### Fixed
+
+- pass params with snake case
+
+## [15.0.1] - 2022-10-17
+### Fixed
+
+- codegen path mapping for requiring models
+
+## [15.0.0] - 2022-10-12
+### Changed
+
+- requiring only codegen files that is using to optimize memory usage
+
+### Removed
+
+- old client syntax support
+
+## [14.5.2] - 2022-10-05
+### Fixed
+
+- passing params with existing model
+
+## [14.5.1] - 2022-09-30
+### Changed
+
+- with_http methods were added to the discovery classes
+
+## [14.5.0] - 2022-09-30
+### Changed
+
+- handling ApiError with retries
+
+## [14.4.0] - 2022-09-27
+### Changed
+
+- handling ApiError by passing a block
+
+## [14.3.0] - 2022-08-31
+### Changed
+
+- using hash instead of model object for Hubspot::Client with body param
+
+## [14.2.0] - 2022-08-25
+### Changed
+
+- using new separate configurations for Hubspot::Client
+
+## [14.1.0] - 2022-08-23
+### Changed
+
+- using default ruby StandardError
+
+## [14.0.0] - 2022-08-11
+### Changed
+
+- required ruby version was increased to 2.7
+
+## [13.2.0] - 2022-08-09
+### Changed
+
+- models updates
+
+### Fixed
+
+- query properties param
+
+## [13.0.0] - 2022-06-29
+### Changed (Breaking changes)
+
+- crm.objects.feedback_submissions API
+
+### Fixed
+
+- crm.contacts.basic_api id_property
+
+## [12.0.0] - 2022-06-09
+### Added
+
+- cms.source_code API client
+- crm.objects.calls API client
+- crm.objects.emails API client
+- crm.objects.meetings API client
+- crm.objects.notes API client
+- crm.objects.tasks API client
+- marketing.forms API client
+- marketing.events API client
+- settings.users API client
+
+### Changed (Breaking changes)
+
+- cms.blogs.authors.author_api => cms.blogs.authors.blog_authors_api
+- cms.blogs.blog_posts.default_api => cms.blogs.blog_posts.blog_posts_api
+- cms.blogs.tags.default_api => cms.blogs.tags.blog_tags_api
+
+## [11.2.0] - 2022-05-12
+
+- added discovery classes
+
+## [11.1.1] - 2021-11-10
+
+- fixed type for the file collection response
+
+## [11.1.0] - 2021-09-10
+
+- added GDPR api modules
+- updated generated code
+
+## [11.0.0] - 2021-08-20
+
+- new generated code with updated class names
+
+## [10.1.0] - 2021-06-08
+
+- added CommunicationPreferences api module
+
 ## [10.0.0] - 2021-04-15
 
 - retry fix

data/Gemfile

@@ -4,4 +4,5 @@ gemspec
 
 group :development, :test do
   gem 'rake', '~> 12.3.3'
+  gem 'openssl'
 end

data/Gemfile.lock

@@ -1,53 +1,59 @@
 PATH
   remote: .
   specs:
-    hubspot-api-client (10.0.1)
+    hubspot-api-client (17.1.0)
       json (~> 2.1, >= 2.1.0)
-      require_all (~> 3.0.0)
       typhoeus (~> 1.4.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ZenTest (4.12.0)
-    addressable (2.7.0)
-      public_suffix (>= 2.0.2, < 5.0)
+    ZenTest (4.12.1)
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
     autotest (4.4.6)
       ZenTest (>= 4.4.1)
     autotest-growl (0.2.16)
     autotest-rails-pure (4.1.2)
-    crack (0.4.4)
-    diff-lcs (1.4.4)
-    ethon (0.13.0)
+    coderay (1.1.3)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.5.0)
+    ethon (0.16.0)
       ffi (>= 1.15.0)
-    ffi (1.15.0)
+    ffi (1.15.5)
     hashdiff (1.0.1)
-    json (2.5.1)
-    public_suffix (4.0.6)
+    json (2.6.2)
+    method_source (1.0.0)
+    openssl (3.1.0)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (5.0.0)
     rake (12.3.3)
-    rake-release (1.2.1)
+    rake-release (1.3.0)
       bundler (>= 1.11, < 3)
-    require_all (3.0.0)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.0)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
     typhoeus (1.4.0)
       ethon (>= 0.9.0)
     vcr (3.0.3)
-    webmock (1.24.6)
-      addressable (>= 2.3.6)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
       crack (>= 0.3.2)
-      hashdiff
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   ruby
@@ -57,11 +63,13 @@ DEPENDENCIES
   autotest-growl (~> 0.2, >= 0.2.16)
   autotest-rails-pure (~> 4.1, >= 4.1.2)
   hubspot-api-client!
+  openssl
+  pry (~> 0.14)
   rake (~> 12.3.3)
-  rake-release
+  rake-release (~> 1.3)
   rspec (~> 3.6, >= 3.6.0)
   vcr (~> 3.0, >= 3.0.1)
-  webmock (~> 1.24, >= 1.24.3)
+  webmock (~> 3.14)
 
 BUNDLED WITH
-   2.1.4
+   2.3.10

data/README.md

@@ -20,99 +20,148 @@ gem 'hubspot-api-client'
 ## 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'] = 'demo'
-end
+# Setup client
+client = Hubspot::Client.new(access_token: 'your_access_token')
 
 # Get contacts
-basic_api = Hubspot::Crm::Contacts::BasicApi.new
-basic_api.get_page(auth_names: 'hapikey')
-
+contacts = client.crm.contacts.basic_api.get_page
 ```
 
 ### Usage
 
+#### Hapikey support:
+
+Please, note that hapikey is no longer supported after v13.1.0. You can get more info about hapikey sunset [here](https://developers.hubspot.com/changelog/upcoming-api-key-sunset). Also, plese, visit a [migration guide](https://developers.hubspot.com/docs/api/migrate-an-api-key-integration-to-a-private-app) if you need help with a migration process.
+
 ### Get all:
-get_all method is available for all major objects (Companies, Contacts, Deals, LineItems, Products, Quotes & Tickets) and works like
+`get_all` method is available for all objects (Companies, Contacts, Deals and etc).
 
 ```ruby
-basic_api = Hubspot::Crm::Contacts::BasicApi.new
-all_contacts = basic_api.get_all(auth_names: 'oauth2')
+client = Hubspot::Client.new(access_token: 'your_oauth2_access_token')
+all_contacts = client.crm.contacts.basic_api.get_all
 ```
+
+You'll need to create a [private app](https://developers.hubspot.com/docs/api/private-apps) to get your access token or you can obtain OAuth2 access token.
+
 Please note that pagination is used under the hood to get all results.
 
+## Search:
+`do_search` method is available for all objects (Companies, Contacts, Deals and etc).
+
+Only 3 `FilterGroups` with max 3 `Filters` are supported.
+
+### Example search by date
+```ruby
+require 'hubspot-api-client'
+require 'date'
+
+api_client = Hubspot::Client.new(access_token: "YOUR_ACCESS_TOKEN")
+# timestamp in milliseconds
+timestamp = (DateTime.parse("XXXX-XX-XXTXX:XX:XX.XXXZ").to_time.to_f * 1000).to_i.to_s
+body = {
+  "filterGroups":
+    [
+      {
+        "filters":[
+          {
+            "value": timestamp,
+            "propertyName":"lastmodifieddate",
+            "operator":"EQ"
+          }
+        ]
+      }
+    ]
+}
+api_response = api_client.crm.contacts.search_api.do_search(
+  body: body
+)
+puts api_response
+```
 
 ### Crm Object Schemas client usage:
 
 #### Creation
 
 ```ruby
-config = ::Hubspot::Crm::Schemas::Configuration.new do |config|
-    config.api_key = { 'hapikey' => 'your_hapikey' }
-  end
-  api_client = ::Hubspot::Crm::Schemas::ApiClient.new(config)
-  api = ::Hubspot::Crm::Schemas::CoreApi.new(api_client)
-  labels = ::Hubspot::Crm::Schemas::ObjectTypeDefinitionLabels.new(singular: 'My object', plural: 'My objects')
-  option = ::Hubspot::Crm::Schemas::OptionInput.new(
-    label: 'Option A',
-    value: 'A',
-    description: 'Choice number one',
-    display_order: 1,
-    hidden: false
-  )
-  property = ::Hubspot::Crm::Schemas::ObjectTypePropertyCreate.new(
-      name: 'property001',
-      label: 'My object property',
-      group_name: 'my_object_information',
-      options: [option],
-      display_order: 2,
-      type: 'enumeration',
-      field_type: 'select'
-  )
-  object_schema_egg = ::Hubspot::Crm::Schemas::ObjectSchemaEgg.new(
-      labels: labels,
-      required_properties: ['property001'],
-      searchable_properties: [],
-      primary_display_property: 'property001',
-      secondary_display_properties: [],
-      properties: [property],
-      associated_objects: ['CONTACT'],
-      name: 'my_object'
-  )
-  api_response = api.create(object_schema_egg)
+client = Hubspot::Client.new(access_token: 'your_oauth2_access_token')
+
+labels = {
+  singular: 'My object',
+  plural: 'My objects'
+}
+
+option = {
+  label: 'Option A',
+  value: 'A',
+  description: 'Choice number one',
+  display_order: 1,
+  hidden: false
+}
+
+property = {
+  name: 'property001',
+  label: 'My object property',
+  group_name: 'my_object_information',
+  options: [option],
+  display_order: 2,
+  type: 'enumeration',
+  field_type: 'select'
+}
+
+body = {
+  labels: labels,
+  required_properties: ['property001'],
+  searchable_properties: [],
+  primary_display_property: 'property001',
+  secondary_display_properties: [],
+  properties: [property],
+  associated_objects: ['CONTACT'],
+  name: 'my_object'
+}
+
+api_response = client.crm.schemas.core_api.create(body: body)
 ```
 
 
 ### Error handling
 
+#### You can rescue an ApiError by passing a block to the method
+
+```ruby
+require 'hubspot-api-client'
+
+client = Hubspot::Client.new(access_token: 'your_access_token')
+
+contacts = client.crm.contacts.basic_api.get_page { |error| error.message }
+```
+
 #### 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)
+  - passing a block (block that handles errors occured)
 
 
 ```ruby
-config = ::Hubspot::Crm::Companies::Configuration.new do |config|
-  config.access_token = 'YOUR ACCESS TOKEN'
+require 'hubspot-api-client'
 
-  # 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
+# Set handlers of statuses you want to handle
+retry_config = {
+  500..530 => { max_retries: 2, seconds_delay: 2 },
+  400 => { max_retries: 3, seconds_delay: 3 }
+}
 
-api_client = ::Hubspot::Crm::Companies::ApiClient.new(config)
-basic_api = ::Hubspot::Crm::Companies::BasicApi.new(api_client)
-end
+client = Hubspot::Client.new(access_token: 'your_access_token')
 
+contacts = client.crm.contacts.basic_api.get_page(retry: retry_config) { |error| error.code }
 ```
+
+### Sample apps
+
+Please, take a look at our [Sample apps](https://github.com/HubSpot/sample-apps-list)