hubspot-api-client 19.0.0 → 20.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 84500e6c0d93ad74edb6b523753331262d8d2c47519f4a2f36aaef78961dce6a
-  data.tar.gz: 6109e08ac99aec5aee0b6d6267785e14440e4d8c67c19c06e7034c70aacd95d6
+  metadata.gz: 9ee0f134bcb5fd133a077e86f5853808a1401a19adca17a111851952cf7d73a7
+  data.tar.gz: 62674fd3da3da53040440e3d6e0d7a28405295c648e284aeb621b5fcd4dc7d33
 SHA512:
-  metadata.gz: 8b16f78f41049a23cc8c724f8992aa31fcf11542c49409921e15a1a9c01c79f59c2f52661a6e7d905770744bc0df73486dc8021198d43f6dd30d927d5c2e754a
-  data.tar.gz: 9517fb8f81828a8575739d6b7f04a17b29146f46bdc267155d687bebbcf2d3759156aed2eff70a0d583aa64d1ff30f7bcb6b26ee5bf5f684d97e64a29291a129
+  metadata.gz: 718ff3c137d0dc5a3f6009a426d5da1b0925fb6124966ef6829e01c6114feeb2f4307e9211f8a6c97e5e0f17000605cd47da80de59ba42d93a04a8f387040c47
+  data.tar.gz: 1c58837bf3e12672c0c0f8413da6af61a737addcd18edb409331f3cfabcce824a89e8b444310ac51a7be54bbe51479918b2b098bb9dbb772b2d999a9cc3b3431

data/CHANGELOG.md

@@ -5,7 +5,108 @@ 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/v19..0...HEAD)
+## [Unreleased](https://github.com/HubSpot/hubspot-api-ruby/compare/v20.0.0...HEAD)
+
+## [20.0.0] - 2025-05-08
+
+## Files
+
+- Changed incomining parameters list in `files.files_api.do_search()`.
+- Renamed method `archive_gdpr()` to `delete()` in `files.files_api`.
+- Renamed method `update_properties()` to `update_properties_recursively()` in `files.folders_api`.
+- Added new method `update_properties()` to `files.folders_api`.
+- Changed incomining parameters list in `files.folders_api.do_search()`.
+- Added properties `source_group` and `file_md5` to `File`.
+- Added property `clear_expires` to `FileUpdateInput`.
+- Changed property type from `:'expires_at' => :'Integer'` to `:'expires_at' => :'Time'` in `FileUpdateInput`.
+- Added property `expires_at` to `ImportFromUrlInput`.
+- Removed property `id` from `FolderUpdateInput`.
+
+## CRM Objects
+
+- Renamed `BatchInputSimplePublicObjectInputForCreate` to `BatchInputSimplePublicObjectBatchInputForCreate` for `crm.contacts`, `crm.companies`, `crm.deals`, `crm.products`, `crm.objects.goals`, `crm.tickets`.
+- Added parameter `object_write_trace_id` to models: `simple_public_object`, `simple_public_object_with_associations`, `simple_public_upsert_object` for  `crm.contacts`, `crm.companies`, `crm.deals`, `crm.products`, `crm.objects.goals`, `crm.tickets`, `crm.objects.feedback_submissions`.
+- Removed parameter `object_write_trace_id` from models: `simple_public_object_input`, `simple_public_object_input_for_create` for  `crm.contacts`, `crm.companies`, `crm.deals`, `crm.products`, `crm.objects.goals`, `crm.tickets`, `crm.objects.feedback_submissions`.
+- Added method `merge()` to `crm.tickets.basic_api`.
+
+## Other changes
+
+- Changed from `Hubspot::OAuth` to `Hubspot::Oauth`.
+- Removed `crm.tickets.merge_api` Api.
+- Removed `crm.companies.merge_api` Api.
+- Removed `crm.contacts.merge_api` Api.
+- Removed `crm.deals.merge_api` Api.
+- Removed `crm.contacts.gdpr_api` Api.
+- Removed `CMS Performance` Client.
+
+## [20.0.0-beta.1] - 2025-04-09
+
+## CRM Objects
+
+- Added methods `archive()`, `create()` and `update()` to `crm.objects.goals.basic_api`.
+- Added methods `archive()`, `create()`, `update()` and `upsert` to `crm.objects.goals.batch_api`.
+- Removed methods `archive()`, `create()` and `update()` from `crm.objects.feedback_submissions.basic_api`.
+- Removed methods `archive()`, `create()` and `update()` from `crm.objects.feedback_submissions.batch_api`.
+- Added parameters `uses_remote` and `uses_calling_window` to `crm.extensions.calling.models.settings_patch_request`, `crm.extensions.calling.models.settings_request` and `crm.extensions.calling.models.settings_response`.
+- Added parameter `object_write_trace_id` to models: `simple_public_object`, `simple_public_object_with_associations`, `simple_public_upsert_object` for `crm.objects`, `crm.objects.taxes`, `crm.objects.tasks`, `crm.objects.postal_mail`, `crm.objects.notes`, `crm.objects.meetings`, `crm.objects.leads`, `crm.objects.emails`, `crm.objects.communications`, `crm.objects.calls`, `crm.quotes`, `crm.line_items`.
+- Removed parameter `object_write_trace_id` from models: `simple_public_object_input`, `simple_public_object_input_for_create` for `crm.objects`, `crm.objects.taxes`, `crm.objects.tasks`, `crm.objects.postal_mail`, `crm.objects.notes`, `crm.objects.meetings`, `crm.objects.leads`, `crm.objects.emails`, `crm.objects.communications`, `crm.objects.calls`, `crm.quotes`, `crm.line_items`.
+
+## CRM Imports and Owners
+
+- Added parameter `contains_encrypted_properties` to `crm.imports.models.import_row_core`.
+- Added parameter `mapped_object_type_ids` to `crm.imports.models.public_import_response`.
+- Added parameter `user_id_including_inactive` and `type` to `crm.owners.models.public_owner`.
+
+## Marketing Events
+
+- Added parameter `object_id` to `marketing.events.models.marketing_event_default_response`, `marketing.events.models.marketing_event_default_response` and `marketing.events.models.marketing_event_public_read_response`.
+- Added methods `archive_by_object_id()`, `get_all()`, `get_by_object_id()` and `update_by_object_id()` to `marketing.events.basic_api`.
+- Renamed from `marketing.events.participant_state_api` to `marketing.events.retrieve_participant_state_api`.
+- Renamed from `CollectionResponseMarketingEventExternalUniqueIdentifierNoPaging` to `CollectionResponseSearchPublicResponseWrapperNoPaging`.
+- Moved and renamed methods from `basic_api.batch_archive()` and `basic_api.batch_upsert()` to `batch_api.archive()` and `batch_api.upsert()`.
+- Moved methods from `basic_api.compelte()` and `basic_api.cancel()` to `change_property_api.compelte()` and `change_property_api.cancel()`.
+- Moved method from `basic_api.do_search()` to `identifiers_api.do_search()`.
+
+## Webhooks
+
+- Added parameter `object_type_id` to `webhooks.models.subscription_create_request` and `webhooks.models.subscription_response`.
+- Removed parameter `period` from `webhooks.models.throttling_settings`.
+
+## Added new Client APIs
+
+- `api_request` - Use not wrapped endpoint(s).
+- `crm.associations.v4.report_api` Api.
+- `crm.associations.v4.schema.definition_configurations_api` Api.
+- `crm.extensions.calling.channel_connection_settings_api` Api.
+- `marketing.events.add_event_attendees_api` Api.
+- `marketing.events.batch_api` Api.
+- `marketing.events.change_property_api` Api.
+- `marketing.events.identifiers_api` Api.
+- `cms.blogs.blog_posts.basic_api` Api.
+- `cms.blogs.blog_posts.batch_api` Api.
+- `cms.blogs.blog_posts.multi_language_api` Api.
+- `events.send.basic_api` Api.
+- `events.send.batch_api` Api.
+
+## Removed Client APIs
+
+- `cms.blogs.blog_posts.blog_posts_api` Api.
+- `marketing.events.attendance_subscriber_state_changes_api` Api.
+- `crm.objects.feedback_submissions.gdpr_api` Api.
+- `crm.objects.feedback_submissions.public_object_api` Api.
+- `events.send.custom_event_data` Api.
+
+## Added new Clients
+
+- `Marketing Emails` client.
+- `Invoices` client.
+- `Exports` client.
+- `Deal Splits` client.
+
+## Fixed
+
+- Singature.
+- Module names `cms.hubdb` and `crm.lists`.
 
 ## [19.0.0] - 2024-10-16
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    hubspot-api-client (19.0.0)
+    hubspot-api-client (20.0.0)
       json (~> 2.1, >= 2.1.0)
       typhoeus (~> 1.4.0)
 
@@ -23,7 +23,7 @@ GEM
       ffi (>= 1.15.0)
     ffi (1.15.5)
     hashdiff (1.0.1)
-    json (2.6.2)
+    json (2.9.0)
     method_source (1.0.0)
     openssl (3.1.0)
     pry (0.14.1)

data/README.md

@@ -1,4 +1,5 @@
 # hubspot-api-client
+
 Ruby API v3 Client files and sample apps
 
 - API version: v3
@@ -34,11 +35,12 @@ contacts = client.crm.contacts.basic_api.get_page
 
 ### Usage
 
-#### Hapikey support:
+#### 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
+
 `get_all` method is available for all objects (Companies, Contacts, Deals and etc).
 
 ```ruby
@@ -50,12 +52,86 @@ You'll need to create a [private app](https://developers.hubspot.com/docs/api/pr
 
 Please note that pagination is used under the hood to get all results.
 
-## Search:
+## Search
+
 `do_search` method is available for all objects (Companies, Contacts, Deals and etc).
 
 Only 3 `FilterGroups` with max 3 `Filters` are supported.
 
+## Not wrapped endpoint(s)
+
+It is possible to access the hubspot request method directly,
+it could be handy if client doesn't have implementation for some endpoint yet.
+Exposed request method benefits by having all configured client params.
+
+```ruby
+client.api_request({
+    "method": "PUT",
+    "path": "/some/api/not/wrapped/yet",
+    "body": {"key": "value"}
+})
+```
+
+## api_request options
+
+```ruby
+- "method": string, # Http method (e.g.: GET, POST, etc). Default value GET
+  "path": string, # URL path (e.g.: '/crm/v3/objects/contacts'). Optional
+  "headers": array, # Http headers. Optional.
+  "body": mixed, # Request body (if defaultJson set body will be transforted to json string).Optional.
+  "auth_type": (access_token, hapikey, developer_api_key), # Auth type. if it isn't set it will use access_token or hapikey. Default value is non empty auth_type.
+  "auth_value": string, # The corresponding value for the auth_type.
+  "base_url": string, # Base URL. Default value 'https://api.hubapi.com'.
+  "qs": array, # Query parameters. Optional.
+  "default_json": bool, # Default Json. if it is set to true it add to headers [ 'Content-Type' => 'application/json', 'Accept' => 'application/json, */*;q=0.8',]
+```
+
+### {Example} for `GET` request
+
+```ruby
+require 'hubspot-api-client'
+
+client = Hubspot::Client.new(access_token: 'your_access_token')
+
+options = {
+  method: "GET",
+  path: "/crm/v3/objects/contacts",
+  qs: {
+    limit: 1,
+    properties: ["email", "last_activity_date"]
+  }
+}
+
+contacts = client.api_request(options)
+
+p JSON.parse(contacts.body)
+```
+
+### {Example} for `POST` request
+
+```ruby
+require 'hubspot-api-client'
+
+client = Hubspot::Client.new(access_token: 'your_access_token')
+
+options = {
+  method: "POST",
+  path: "/crm/v3/objects/contacts",
+  body: {
+    "properties": {
+      "email": "some_email@some.com",
+      "lastname": "some_last_name"
+    }
+  }
+}
+
+contacts = client.api_request(options)
+
+p JSON.parse(contacts.body)
+```
+
 ### Example search by date
+
 ```ruby
 require 'hubspot-api-client'
 require 'date'
@@ -83,7 +159,7 @@ api_response = api_client.crm.contacts.search_api.do_search(
 puts api_response
 ```
 
-### Crm Object Schemas client usage:
+### Crm Object Schemas client usage
 
 #### Creation
 
@@ -127,7 +203,6 @@ body = {
 api_response = client.crm.schemas.core_api.create(body: body)
 ```
 
-
 ### Error handling
 
 #### You can rescue an ApiError by passing a block to the method
@@ -143,10 +218,10 @@ 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)
-  - passing a block (block that handles errors occured)
 
+- max_retries (maximum number of retries)
+- seconds_delay (pause in seconds between retries)
+- passing a block (block that handles errors occured)
 
 ```ruby
 require 'hubspot-api-client'

data/lib/hubspot/client.rb

@@ -25,6 +25,13 @@ module Hubspot
       ].freeze
     end
 
+    def api_request(options)
+      require_relative 'helpers/requests/http_request_builder'
+
+      request = Hubspot::Helpers::Request.new(@params, options)
+      request.send
+    end
+
     def base_module
       'Hubspot::Discovery'
     end