Incorrect handling of Multi-status errors

[pouellet]

The SDK does not expose Multi-status errors when parsing the response for batch operations, making it impossible to detect errors in batch operations. As can be seen (for example) in the generated code for the Hubspot::Crm::Objects::Calls::BatchApi.upsert_with_http_info method, the return type is hardcoded to BatchResponseSimplePublicUpsertObject.

hubspot-api-ruby/lib/hubspot/codegen/crm/objects/calls/api/batch_api.rb

Line 346 in 389fed0

return_type = opts[:debug_return_type] || 'BatchResponseSimplePublicUpsertObject'

Instead of being hardcoded, the response type should be one of BatchResponseSimplePublicUpsertObject or BatchResponseSimplePublicUpsertObjectWithErrors, depending on if all the operations in the batch succeeded or not.

Example

Here's an example of a batch request that fails with a validation error with client debugging enabled:

ETHON: performed EASY effective_url=https://api.hubapi.com/crm/v3/objects/<object_id>/batch/upsert response_code=207 return_code=ok total_time=0.456076
HTTP response body ~BEGIN~
{
  "status":"COMPLETE",
  "results":[],
  "numErrors":1,
  "errors":[
    {
      "status":"error",
      "category":"VALIDATION_ERROR",
      "message":"Property values were not valid: [{\"isValid\":false,\"message\":\"Enter a number no more than 10\",\"error\":\"MAX_NUMBER\",\"name\":\"gross_total\"}]",
      "context":{"objectWriteTraceId":["143","146","145"]}
    }
  ],
  "startedAt":"2025-04-12T02:54:48.893Z",
  "completedAt":"2025-04-12T02:54:49.030Z"
}
~END~

And the incorrect object being returned:

0> response.class
=> Hubspot::Crm::Objects::BatchResponseSimplePublicUpsertObject

0> response.to_json
=> {"completedAt":"2025-04-12T02:54:49.030Z","startedAt":"2025-04-12T02:54:48.893Z","results":[],"status":"COMPLETE"}

[katamotokosuke]

I'm experiencing the same issue with the batch/create endpoint for custom objects. The SDK doesn't expose error details when some items in a batch fail validation.

Example

object_type = "aaa"
request_body = {:inputs=>
  [{"properties"=>{"name"=>"aaa", "bool"=>"false", "tiny_text_10"=>"looooooooooooooooong text"},
    "objectWriteTraceId"=>"c3911c87"},
   {"properties"=>{"name"=>"bbb", "bool"=>"true", "tiny_text_10"=>"valid text"},
    "objectWriteTraceId"=>"e632d594"}]} 
# The first item has text that exceeds the field limit for tiny_text_10

response = cli.crm.objects.batch_api.api.create(object_type, request_body)
response.to_hash

# Returns:
{:status=>"COMPLETE",
 :results=>
  [{:id=>"32180164770",
    :properties=>
     {"bool"=>"true",
      "hs_createdate"=>"2025-08-08T00:15:39.778Z",
      "hs_lastmodifieddate"=>"2025-08-08T00:15:39.778Z",
      "hs_object_id"=>"32180164770",
      "hs_object_source"=>"INTEGRATION",
      "hs_object_source_id"=>"751131",
      "hs_object_source_label"=>"INTEGRATION",
      "name"=>"bbb",
      "tiny_text_10"=>"valid text"},
    :createdAt=>2025-08-08 00:15:39.778 UTC,
    :updatedAt=>2025-08-08 00:15:39.778 UTC,
    :archived=>false}],
 :startedAt=>2025-08-08 00:15:39.683 UTC,
 :completedAt=>2025-08-08 00:15:40.287 UTC}

Issue

As shown above, only the second item ("bbb") was successfully created, while the first item ("aaa") failed due to validation error. However:

1. The response doesn't include numErrors or errors fields that should be present according to HubSpot's Multi-status errors documentation
2. The HTTP status should be 207 (Multi-Status) as per the batch/create API documentation
3. The SDK returns BatchResponseSimplePublicObject instead of BatchResponseSimplePublicObjectWithErrors

This makes it impossible to detect which items failed and why they failed in batch operations, forcing us to compare input and output to identify failures without knowing the actual error reasons.