@aloma.io/integration-sdk 3.8.53 → 3.8.55

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (20) hide show
  1. package/build/openapi-to-connector.d.mts +4 -0
  2. package/build/openapi-to-connector.mjs +131 -18
  3. package/package.json +1 -1
  4. package/src/openapi-to-connector.mts +159 -20
  5. package/examples/api-without-servers.json +0 -32
  6. package/examples/companies-resource-class.mts +0 -310
  7. package/examples/companies-resource.mts +0 -310
  8. package/examples/complete-example.sh +0 -116
  9. package/examples/create-hubspot-connector.sh +0 -33
  10. package/examples/generate-connector.sh +0 -35
  11. package/examples/generated-controller.mts +0 -81
  12. package/examples/hubspot-companies.json +0 -1889
  13. package/examples/hubspot-contacts.json +0 -1919
  14. package/examples/hubspot-controller-individual-params.mts +0 -323
  15. package/examples/hubspot-controller-with-implementation.mts +0 -315
  16. package/examples/hubspot-controller.mts +0 -192
  17. package/examples/hubspot-lists.json +0 -5525
  18. package/examples/main-controller-with-resources.mts +0 -35
  19. package/examples/stripe.json +0 -182829
  20. package/examples/utility-click.json +0 -8992
package/examples/hubspot-contacts.json DELETED
@@ -1,1919 +0,0 @@
1
- {
2
- "openapi" : "3.0.1",
3
- "info" : {
4
- "title" : "Contacts",
5
- "version" : "v3",
6
- "x-hubspot-product-tier-requirements" : {
7
- "marketing" : "FREE",
8
- "sales" : "FREE",
9
- "service" : "FREE",
10
- "cms" : "FREE"
11
- },
12
- "x-hubspot-api-use-case" : "Retrieve a contact by ID to bring that contact data into your external system.",
13
- "x-hubspot-related-documentation" : [ {
14
- "name" : "Contacts Guide",
15
- "url" : "https://developers.hubspot.com/docs/guides/api/crm/objects/contacts"
16
- } ],
17
- "x-hubspot-introduction" : "Use the contacts API to create and manage contacts."
18
- },
19
- "servers" : [ {
20
- "url" : "https://api.hubapi.com"
21
- } ],
22
- "tags" : [ {
23
- "name" : "Basic"
24
- }, {
25
- "name" : "Public_Object__SE_PT_EM_BE_R_2025"
26
- }, {
27
- "name" : "Search"
28
- }, {
29
- "name" : "Batch"
30
- }, {
31
- "name" : "Public_Object_Search_Post__SE_PT_EM_BE_R_2025"
32
- }, {
33
- "name" : "GDPR"
34
- } ],
35
- "paths" : {
36
- "/crm/v3/objects/contacts/merge" : {
37
- "post" : {
38
- "tags" : [ "Basic" ],
39
- "summary" : "Merge two contacts",
40
- "description" : "Merge two contact records. Learn more about [merging records](https://knowledge.hubspot.com/records/merge-records). ",
41
- "operationId" : "post-/crm/v3/objects/contacts/merge",
42
- "parameters" : [ ],
43
- "requestBody" : {
44
- "content" : {
45
- "application/json" : {
46
- "schema" : {
47
- "$ref" : "#/components/schemas/PublicMergeInput"
48
- }
49
- }
50
- },
51
- "required" : true
52
- },
53
- "responses" : {
54
- "200" : {
55
- "description" : "successful operation",
56
- "content" : {
57
- "application/json" : {
58
- "schema" : {
59
- "$ref" : "#/components/schemas/SimplePublicObject"
60
- }
61
- }
62
- }
63
- },
64
- "default" : {
65
- "$ref" : "#/components/responses/Error"
66
- }
67
- },
68
- "security" : [ {
69
- "oauth2_legacy" : [ ]
70
- }, {
71
- "oauth2" : [ "crm.objects.contacts.write" ]
72
- }, {
73
- "private_apps_legacy" : [ ]
74
- }, {
75
- "private_apps" : [ "crm.objects.contacts.write" ]
76
- } ]
77
- }
78
- },
79
- "/crm/v3/objects/contacts/batch/archive" : {
80
- "post" : {
81
- "tags" : [ "Batch" ],
82
- "summary" : "Archive a batch of contacts",
83
- "description" : "Archive a batch of contacts by ID. Archived contacts can be restored within 90 days of deletion. Learn more about the [data impacted by contact deletions](https://knowledge.hubspot.com/privacy-and-consent/understand-restorable-and-permanent-contact-deletions) and how to [restore archived records](https://knowledge.hubspot.com/records/restore-deleted-records).",
84
- "operationId" : "post-/crm/v3/objects/contacts/batch/archive",
85
- "parameters" : [ ],
86
- "requestBody" : {
87
- "content" : {
88
- "application/json" : {
89
- "schema" : {
90
- "$ref" : "#/components/schemas/BatchInputSimplePublicObjectId"
91
- }
92
- }
93
- },
94
- "required" : true
95
- },
96
- "responses" : {
97
- "204" : {
98
- "description" : "No content",
99
- "content" : { }
100
- },
101
- "default" : {
102
- "$ref" : "#/components/responses/Error"
103
- }
104
- },
105
- "security" : [ {
106
- "oauth2_legacy" : [ ]
107
- }, {
108
- "oauth2" : [ "crm.objects.contacts.write" ]
109
- }, {
110
- "private_apps_legacy" : [ ]
111
- }, {
112
- "private_apps" : [ "crm.objects.contacts.write" ]
113
- } ]
114
- }
115
- },
116
- "/crm/v3/objects/contacts/batch/update" : {
117
- "post" : {
118
- "tags" : [ "Batch" ],
119
- "summary" : "Update a batch of contacts",
120
- "description" : "Update a batch of contacts by ID (`contactId`) or unique property value (`idProperty`). Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.",
121
- "operationId" : "post-/crm/v3/objects/contacts/batch/update",
122
- "parameters" : [ ],
123
- "requestBody" : {
124
- "content" : {
125
- "application/json" : {
126
- "schema" : {
127
- "$ref" : "#/components/schemas/BatchInputSimplePublicObjectBatchInput"
128
- }
129
- }
130
- },
131
- "required" : true
132
- },
133
- "responses" : {
134
- "200" : {
135
- "description" : "successful operation",
136
- "content" : {
137
- "application/json" : {
138
- "schema" : {
139
- "$ref" : "#/components/schemas/BatchResponseSimplePublicObject"
140
- }
141
- }
142
- }
143
- },
144
- "default" : {
145
- "$ref" : "#/components/responses/Error"
146
- }
147
- },
148
- "security" : [ {
149
- "oauth2_legacy" : [ ]
150
- }, {
151
- "oauth2" : [ "crm.objects.contacts.write" ]
152
- }, {
153
- "private_apps_legacy" : [ ]
154
- }, {
155
- "private_apps" : [ "crm.objects.contacts.write" ]
156
- } ]
157
- }
158
- },
159
- "/crm/v3/objects/contacts" : {
160
- "get" : {
161
- "tags" : [ "Basic" ],
162
- "summary" : "Retrieve contacts",
163
- "description" : "Retrieve all contacts, using query parameters to specify the information that gets returned.",
164
- "operationId" : "get-/crm/v3/objects/contacts",
165
- "parameters" : [ {
166
- "name" : "limit",
167
- "in" : "query",
168
- "description" : "The maximum number of results to display per page.",
169
- "required" : false,
170
- "style" : "form",
171
- "explode" : true,
172
- "schema" : {
173
- "type" : "integer",
174
- "format" : "int32",
175
- "default" : 10
176
- }
177
- }, {
178
- "name" : "after",
179
- "in" : "query",
180
- "description" : "The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.",
181
- "required" : false,
182
- "style" : "form",
183
- "explode" : true,
184
- "schema" : {
185
- "type" : "string"
186
- }
187
- }, {
188
- "name" : "properties",
189
- "in" : "query",
190
- "description" : "A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.",
191
- "required" : false,
192
- "style" : "form",
193
- "explode" : true,
194
- "schema" : {
195
- "type" : "array",
196
- "items" : {
197
- "type" : "string"
198
- }
199
- }
200
- }, {
201
- "name" : "propertiesWithHistory",
202
- "in" : "query",
203
- "description" : "A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of contacts that can be read by a single request.",
204
- "required" : false,
205
- "style" : "form",
206
- "explode" : true,
207
- "schema" : {
208
- "type" : "array",
209
- "items" : {
210
- "type" : "string"
211
- }
212
- }
213
- }, {
214
- "name" : "associations",
215
- "in" : "query",
216
- "description" : "A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.",
217
- "required" : false,
218
- "style" : "form",
219
- "explode" : true,
220
- "schema" : {
221
- "type" : "array",
222
- "items" : {
223
- "type" : "string"
224
- }
225
- }
226
- }, {
227
- "name" : "archived",
228
- "in" : "query",
229
- "description" : "Whether to return only results that have been archived.",
230
- "required" : false,
231
- "style" : "form",
232
- "explode" : true,
233
- "schema" : {
234
- "type" : "boolean",
235
- "default" : false
236
- }
237
- } ],
238
- "responses" : {
239
- "200" : {
240
- "description" : "successful operation",
241
- "content" : {
242
- "application/json" : {
243
- "schema" : {
244
- "$ref" : "#/components/schemas/CollectionResponseSimplePublicObjectWithAssociations"
245
- }
246
- }
247
- }
248
- },
249
- "default" : {
250
- "$ref" : "#/components/responses/Error"
251
- }
252
- },
253
- "security" : [ {
254
- "oauth2_legacy" : [ ]
255
- }, {
256
- "oauth2" : [ "crm.objects.contacts.read" ]
257
- }, {
258
- "private_apps_legacy" : [ ]
259
- }, {
260
- "private_apps" : [ "crm.objects.contacts.read" ]
261
- } ]
262
- },
263
- "post" : {
264
- "tags" : [ "Basic" ],
265
- "summary" : "Create a contact",
266
- "description" : "Create a single contact. Include a `properties` object to define [property values](https://developers.hubspot.com/docs/guides/api/crm/properties) for the contact, along with an `associations` array to define [associations](https://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4) with other CRM records.",
267
- "operationId" : "post-/crm/v3/objects/contacts",
268
- "parameters" : [ ],
269
- "requestBody" : {
270
- "content" : {
271
- "application/json" : {
272
- "schema" : {
273
- "$ref" : "#/components/schemas/SimplePublicObjectInputForCreate"
274
- }
275
- }
276
- },
277
- "required" : true
278
- },
279
- "responses" : {
280
- "200" : {
281
- "description" : "successful operation",
282
- "content" : {
283
- "application/json" : {
284
- "schema" : {
285
- "$ref" : "#/components/schemas/CreatedResponseSimplePublicObject"
286
- }
287
- }
288
- }
289
- },
290
- "default" : {
291
- "$ref" : "#/components/responses/Error"
292
- }
293
- },
294
- "security" : [ {
295
- "oauth2_legacy" : [ ]
296
- }, {
297
- "oauth2" : [ "crm.objects.contacts.write" ]
298
- }, {
299
- "private_apps_legacy" : [ ]
300
- }, {
301
- "private_apps" : [ "crm.objects.contacts.write" ]
302
- } ]
303
- }
304
- },
305
- "/crm/v3/objects/contacts/{contactId}" : {
306
- "get" : {
307
- "tags" : [ "Basic" ],
308
- "summary" : "Retrieve a contact",
309
- "description" : "Retrieve a contact by its ID (`contactId`) or by a unique property (`idProperty`). You can specify what is returned using the `properties` query parameter.",
310
- "operationId" : "get-/crm/v3/objects/contacts/{contactId}",
311
- "parameters" : [ {
312
- "name" : "contactId",
313
- "in" : "path",
314
- "description" : "The ID of the contact to retrieve.",
315
- "required" : true,
316
- "style" : "simple",
317
- "explode" : false,
318
- "schema" : {
319
- "type" : "string"
320
- }
321
- }, {
322
- "name" : "properties",
323
- "in" : "query",
324
- "description" : "A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.",
325
- "required" : false,
326
- "style" : "form",
327
- "explode" : true,
328
- "schema" : {
329
- "type" : "array",
330
- "items" : {
331
- "type" : "string"
332
- }
333
- }
334
- }, {
335
- "name" : "propertiesWithHistory",
336
- "in" : "query",
337
- "description" : "A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.",
338
- "required" : false,
339
- "style" : "form",
340
- "explode" : true,
341
- "schema" : {
342
- "type" : "array",
343
- "items" : {
344
- "type" : "string"
345
- }
346
- }
347
- }, {
348
- "name" : "associations",
349
- "in" : "query",
350
- "description" : "A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.",
351
- "required" : false,
352
- "style" : "form",
353
- "explode" : true,
354
- "schema" : {
355
- "type" : "array",
356
- "items" : {
357
- "type" : "string"
358
- }
359
- }
360
- }, {
361
- "name" : "archived",
362
- "in" : "query",
363
- "description" : "Whether to return only results that have been archived.",
364
- "required" : false,
365
- "style" : "form",
366
- "explode" : true,
367
- "schema" : {
368
- "type" : "boolean",
369
- "default" : false
370
- }
371
- } ],
372
- "responses" : {
373
- "200" : {
374
- "description" : "successful operation",
375
- "content" : {
376
- "application/json" : {
377
- "schema" : {
378
- "$ref" : "#/components/schemas/SimplePublicObjectWithAssociations"
379
- }
380
- }
381
- }
382
- },
383
- "default" : {
384
- "$ref" : "#/components/responses/Error"
385
- }
386
- },
387
- "security" : [ {
388
- "oauth2_legacy" : [ ]
389
- }, {
390
- "oauth2" : [ "crm.objects.contacts.read" ]
391
- }, {
392
- "private_apps_legacy" : [ ]
393
- }, {
394
- "private_apps" : [ "crm.objects.contacts.read" ]
395
- } ]
396
- },
397
- "delete" : {
398
- "tags" : [ "Basic" ],
399
- "summary" : "Archive a contact",
400
- "description" : "Delete a contact by ID. Deleted contacts can be restored within 90 days of deletion. Learn more about the [data impacted by contact deletions](https://knowledge.hubspot.com/privacy-and-consent/understand-restorable-and-permanent-contact-deletions) and how to [restore archived records](https://knowledge.hubspot.com/records/restore-deleted-records).",
401
- "operationId" : "delete-/crm/v3/objects/contacts/{contactId}",
402
- "parameters" : [ {
403
- "name" : "contactId",
404
- "in" : "path",
405
- "description" : "The ID of the contact to delete.",
406
- "required" : true,
407
- "style" : "simple",
408
- "explode" : false,
409
- "schema" : {
410
- "type" : "string"
411
- }
412
- } ],
413
- "responses" : {
414
- "204" : {
415
- "description" : "No content",
416
- "content" : { }
417
- },
418
- "default" : {
419
- "$ref" : "#/components/responses/Error"
420
- }
421
- },
422
- "security" : [ {
423
- "oauth2_legacy" : [ ]
424
- }, {
425
- "oauth2" : [ "crm.objects.contacts.write" ]
426
- }, {
427
- "private_apps_legacy" : [ ]
428
- }, {
429
- "private_apps" : [ "crm.objects.contacts.write" ]
430
- } ]
431
- },
432
- "patch" : {
433
- "tags" : [ "Basic" ],
434
- "summary" : "Update a contact",
435
- "description" : "Update an existing contact, identified by ID or email/unique property value. To identify a contact by ID, include the ID in the request URL path. To identify a contact by their email or other unique property, include the email/property value in the request URL path, and add the `idProperty` query parameter (`/crm/v3/objects/contacts/jon@website.com?idProperty=email`). Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.",
436
- "operationId" : "patch-/crm/v3/objects/contacts/{contactId}",
437
- "parameters" : [ {
438
- "name" : "contactId",
439
- "in" : "path",
440
- "description" : "The ID of the contact to update.",
441
- "required" : true,
442
- "style" : "simple",
443
- "explode" : false,
444
- "schema" : {
445
- "type" : "string"
446
- }
447
- } ],
448
- "requestBody" : {
449
- "content" : {
450
- "application/json" : {
451
- "schema" : {
452
- "$ref" : "#/components/schemas/SimplePublicObjectInput"
453
- }
454
- }
455
- },
456
- "required" : true
457
- },
458
- "responses" : {
459
- "200" : {
460
- "description" : "successful operation",
461
- "content" : {
462
- "application/json" : {
463
- "schema" : {
464
- "$ref" : "#/components/schemas/SimplePublicObject"
465
- }
466
- }
467
- }
468
- },
469
- "default" : {
470
- "$ref" : "#/components/responses/Error"
471
- }
472
- },
473
- "security" : [ {
474
- "oauth2_legacy" : [ ]
475
- }, {
476
- "oauth2" : [ "crm.objects.contacts.write" ]
477
- }, {
478
- "private_apps_legacy" : [ ]
479
- }, {
480
- "private_apps" : [ "crm.objects.contacts.write" ]
481
- } ]
482
- }
483
- },
484
- "/crm/v3/objects/contacts/batch/create" : {
485
- "post" : {
486
- "tags" : [ "Batch" ],
487
- "summary" : "Create a batch of contacts",
488
- "description" : "Create a batch of contacts. The `inputs` array can contain a `properties` object to define property values for each record, along with an `associations` array to define [associations](https://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4) with other CRM records.",
489
- "operationId" : "post-/crm/v3/objects/contacts/batch/create",
490
- "parameters" : [ ],
491
- "requestBody" : {
492
- "content" : {
493
- "application/json" : {
494
- "schema" : {
495
- "$ref" : "#/components/schemas/BatchInputSimplePublicObjectBatchInputForCreate"
496
- }
497
- }
498
- },
499
- "required" : true
500
- },
501
- "responses" : {
502
- "200" : {
503
- "description" : "successful operation",
504
- "content" : {
505
- "application/json" : {
506
- "schema" : {
507
- "$ref" : "#/components/schemas/BatchResponseSimplePublicObject"
508
- }
509
- }
510
- }
511
- },
512
- "default" : {
513
- "$ref" : "#/components/responses/Error"
514
- }
515
- },
516
- "security" : [ {
517
- "oauth2_legacy" : [ ]
518
- }, {
519
- "oauth2" : [ "crm.objects.contacts.write" ]
520
- }, {
521
- "private_apps_legacy" : [ ]
522
- }, {
523
- "private_apps" : [ "crm.objects.contacts.write" ]
524
- } ]
525
- }
526
- },
527
- "/crm/v3/objects/contacts/search" : {
528
- "post" : {
529
- "tags" : [ "Search" ],
530
- "summary" : "Search for contacts",
531
- "description" : "Search for contacts by filtering on properties, searching through associations, and sorting results. Learn more about [CRM search](https://developers.hubspot.com/docs/guides/api/crm/search#make-a-search-request).",
532
- "operationId" : "post-/crm/v3/objects/contacts/search",
533
- "parameters" : [ ],
534
- "requestBody" : {
535
- "content" : {
536
- "application/json" : {
537
- "schema" : {
538
- "$ref" : "#/components/schemas/PublicObjectSearchRequest"
539
- }
540
- }
541
- },
542
- "required" : true
543
- },
544
- "responses" : {
545
- "200" : {
546
- "description" : "successful operation",
547
- "content" : {
548
- "application/json" : {
549
- "schema" : {
550
- "$ref" : "#/components/schemas/CollectionResponseWithTotalSimplePublicObject"
551
- }
552
- }
553
- }
554
- },
555
- "default" : {
556
- "$ref" : "#/components/responses/Error"
557
- }
558
- },
559
- "security" : [ {
560
- "oauth2_legacy" : [ ]
561
- }, {
562
- "oauth2" : [ "crm.objects.contacts.read" ]
563
- }, {
564
- "private_apps_legacy" : [ ]
565
- }, {
566
- "private_apps" : [ "crm.objects.contacts.read" ]
567
- } ],
568
- "x-hubspot-rate-limit-exemptions" : [ "ten-secondly" ]
569
- }
570
- },
571
- "/crm/v3/objects/contacts/gdpr-delete" : {
572
- "post" : {
573
- "tags" : [ "Basic" ],
574
- "summary" : "Permanently delete a contact (GDPR-compliant)",
575
- "description" : "Permanently delete a contact and all associated content to follow GDPR. Use optional property `idProperty` set to `email` to identify contact by email address. If email address is not found, the email address will be added to a blocklist and prevent it from being used in the future. Learn more about [permanently deleting contacts](https://knowledge.hubspot.com/privacy-and-consent/how-do-i-perform-a-gdpr-delete-in-hubspot).",
576
- "operationId" : "post-/crm/v3/objects/contacts/gdpr-delete",
577
- "parameters" : [ ],
578
- "requestBody" : {
579
- "content" : {
580
- "application/json" : {
581
- "schema" : {
582
- "$ref" : "#/components/schemas/PublicGdprDeleteInput"
583
- }
584
- }
585
- },
586
- "required" : true
587
- },
588
- "responses" : {
589
- "204" : {
590
- "description" : "No content",
591
- "content" : { }
592
- },
593
- "default" : {
594
- "$ref" : "#/components/responses/Error"
595
- }
596
- },
597
- "security" : [ {
598
- "oauth2_legacy" : [ ]
599
- }, {
600
- "oauth2" : [ "crm.objects.contacts.write" ]
601
- }, {
602
- "private_apps_legacy" : [ ]
603
- }, {
604
- "private_apps" : [ "crm.objects.contacts.write" ]
605
- } ]
606
- }
607
- },
608
- "/crm/v3/objects/contacts/batch/read" : {
609
- "post" : {
610
- "tags" : [ "Batch" ],
611
- "summary" : "Retrieve a batch of contacts",
612
- "description" : "Retrieve a batch of contacts by ID (`contactId`) or unique property value (`idProperty`). ",
613
- "operationId" : "post-/crm/v3/objects/contacts/batch/read",
614
- "parameters" : [ {
615
- "name" : "archived",
616
- "in" : "query",
617
- "description" : "Whether to return only results that have been archived.",
618
- "required" : false,
619
- "style" : "form",
620
- "explode" : true,
621
- "schema" : {
622
- "type" : "boolean",
623
- "default" : false
624
- }
625
- } ],
626
- "requestBody" : {
627
- "content" : {
628
- "application/json" : {
629
- "schema" : {
630
- "$ref" : "#/components/schemas/BatchReadInputSimplePublicObjectId"
631
- }
632
- }
633
- },
634
- "required" : true
635
- },
636
- "responses" : {
637
- "200" : {
638
- "description" : "successful operation",
639
- "content" : {
640
- "application/json" : {
641
- "schema" : {
642
- "$ref" : "#/components/schemas/BatchResponseSimplePublicObject"
643
- }
644
- }
645
- }
646
- },
647
- "default" : {
648
- "$ref" : "#/components/responses/Error"
649
- }
650
- },
651
- "security" : [ {
652
- "oauth2_legacy" : [ ]
653
- }, {
654
- "oauth2" : [ "crm.objects.contacts.read" ]
655
- }, {
656
- "private_apps_legacy" : [ ]
657
- }, {
658
- "private_apps" : [ "crm.objects.contacts.read" ]
659
- } ]
660
- }
661
- },
662
- "/crm/v3/objects/contacts/batch/upsert" : {
663
- "post" : {
664
- "tags" : [ "Batch" ],
665
- "summary" : "Create or update a batch of contacts",
666
- "description" : "Upsert a batch of contacts. The `inputs` array can contain a `properties` object to define property values for each record.",
667
- "operationId" : "post-/crm/v3/objects/contacts/batch/upsert",
668
- "parameters" : [ ],
669
- "requestBody" : {
670
- "content" : {
671
- "application/json" : {
672
- "schema" : {
673
- "$ref" : "#/components/schemas/BatchInputSimplePublicObjectBatchInputUpsert"
674
- }
675
- }
676
- },
677
- "required" : true
678
- },
679
- "responses" : {
680
- "200" : {
681
- "description" : "successful operation",
682
- "content" : {
683
- "application/json" : {
684
- "schema" : {
685
- "$ref" : "#/components/schemas/BatchResponseSimplePublicUpsertObject"
686
- }
687
- }
688
- }
689
- },
690
- "default" : {
691
- "$ref" : "#/components/responses/Error"
692
- }
693
- },
694
- "security" : [ {
695
- "oauth2_legacy" : [ ]
696
- }, {
697
- "oauth2" : [ "crm.objects.contacts.write" ]
698
- }, {
699
- "private_apps_legacy" : [ ]
700
- }, {
701
- "private_apps" : [ "crm.objects.contacts.write" ]
702
- } ]
703
- }
704
- }
705
- },
706
- "components" : {
707
- "schemas" : {
708
- "CreatedResponseSimplePublicObject" : {
709
- "required" : [ "createdResourceId", "entity" ],
710
- "type" : "object",
711
- "properties" : {
712
- "location" : {
713
- "type" : "string"
714
- },
715
- "createdResourceId" : {
716
- "type" : "string"
717
- },
718
- "entity" : {
719
- "$ref" : "#/components/schemas/SimplePublicObject"
720
- }
721
- }
722
- },
723
- "StandardError" : {
724
- "required" : [ "category", "context", "errors", "links", "message", "status" ],
725
- "type" : "object",
726
- "properties" : {
727
- "subCategory" : {
728
- "type" : "object",
729
- "properties" : { },
730
- "description" : "A more specific error category within each main category."
731
- },
732
- "context" : {
733
- "type" : "object",
734
- "additionalProperties" : {
735
- "type" : "array",
736
- "items" : {
737
- "type" : "string"
738
- }
739
- },
740
- "description" : "Additional context-specific information related to the error."
741
- },
742
- "links" : {
743
- "type" : "object",
744
- "additionalProperties" : {
745
- "type" : "string"
746
- },
747
- "description" : "URLs linking to documentation or resources associated with the error."
748
- },
749
- "id" : {
750
- "type" : "string",
751
- "description" : "A unique ID for the error instance."
752
- },
753
- "category" : {
754
- "type" : "string",
755
- "description" : "The main category of the error."
756
- },
757
- "message" : {
758
- "type" : "string",
759
- "description" : "A human-readable string describing the error and possible remediation steps."
760
- },
761
- "errors" : {
762
- "type" : "array",
763
- "description" : "The detailed error objects.",
764
- "items" : {
765
- "$ref" : "#/components/schemas/ErrorDetail"
766
- }
767
- },
768
- "status" : {
769
- "type" : "string",
770
- "description" : "The HTTP status code associated with the error."
771
- }
772
- },
773
- "description" : "Ye olde error"
774
- },
775
- "CollectionResponseAssociatedId" : {
776
- "required" : [ "results" ],
777
- "type" : "object",
778
- "properties" : {
779
- "paging" : {
780
- "$ref" : "#/components/schemas/Paging"
781
- },
782
- "results" : {
783
- "type" : "array",
784
- "items" : {
785
- "$ref" : "#/components/schemas/AssociatedId"
786
- }
787
- }
788
- }
789
- },
790
- "CollectionResponseWithTotalSimplePublicObject" : {
791
- "required" : [ "results", "total" ],
792
- "type" : "object",
793
- "properties" : {
794
- "total" : {
795
- "type" : "integer",
796
- "description" : "The number of available results",
797
- "format" : "int32"
798
- },
799
- "results" : {
800
- "type" : "array",
801
- "items" : {
802
- "$ref" : "#/components/schemas/SimplePublicObject"
803
- }
804
- },
805
- "paging" : {
806
- "$ref" : "#/components/schemas/Paging"
807
- }
808
- }
809
- },
810
- "LabelsBetweenObjectPair" : {
811
- "required" : [ "fromObjectId", "fromObjectTypeId", "labels", "toObjectId", "toObjectTypeId" ],
812
- "type" : "object",
813
- "properties" : {
814
- "fromObjectTypeId" : {
815
- "type" : "string"
816
- },
817
- "fromObjectId" : {
818
- "type" : "string"
819
- },
820
- "toObjectTypeId" : {
821
- "type" : "string"
822
- },
823
- "toObjectId" : {
824
- "type" : "string"
825
- },
826
- "labels" : {
827
- "type" : "array",
828
- "items" : {
829
- "type" : "string"
830
- }
831
- }
832
- }
833
- },
834
- "PublicAssociationsForObject" : {
835
- "required" : [ "to", "types" ],
836
- "type" : "object",
837
- "properties" : {
838
- "types" : {
839
- "type" : "array",
840
- "items" : {
841
- "$ref" : "#/components/schemas/AssociationSpec"
842
- }
843
- },
844
- "to" : {
845
- "$ref" : "#/components/schemas/PublicObjectId"
846
- }
847
- }
848
- },
849
- "BatchResponseSimplePublicObject" : {
850
- "required" : [ "completedAt", "results", "startedAt", "status" ],
851
- "type" : "object",
852
- "properties" : {
853
- "completedAt" : {
854
- "type" : "string",
855
- "description" : "The timestamp when the batch processing was completed, in ISO 8601 format.",
856
- "format" : "date-time"
857
- },
858
- "numErrors" : {
859
- "type" : "integer",
860
- "format" : "int32"
861
- },
862
- "requestedAt" : {
863
- "type" : "string",
864
- "description" : "The timestamp when the batch request was initially made, in ISO 8601 format.",
865
- "format" : "date-time"
866
- },
867
- "startedAt" : {
868
- "type" : "string",
869
- "description" : "The timestamp when the batch processing began, in ISO 8601 format.",
870
- "format" : "date-time"
871
- },
872
- "links" : {
873
- "type" : "object",
874
- "additionalProperties" : {
875
- "type" : "string"
876
- },
877
- "description" : "An object containing relevant links related to the batch request."
878
- },
879
- "results" : {
880
- "type" : "array",
881
- "items" : {
882
- "$ref" : "#/components/schemas/SimplePublicObject"
883
- }
884
- },
885
- "errors" : {
886
- "type" : "array",
887
- "items" : {
888
- "$ref" : "#/components/schemas/StandardError"
889
- }
890
- },
891
- "status" : {
892
- "type" : "string",
893
- "description" : "The status of the batch processing request: \"PENDING\", \"PROCESSING\", \"CANCELLED\", or \"COMPLETE\"",
894
- "enum" : [ "PENDING", "PROCESSING", "CANCELED", "COMPLETE" ]
895
- }
896
- },
897
- "description" : "A public object batch response object"
898
- },
899
- "FilterGroup" : {
900
- "required" : [ "filters" ],
901
- "type" : "object",
902
- "properties" : {
903
- "filters" : {
904
- "type" : "array",
905
- "items" : {
906
- "$ref" : "#/components/schemas/Filter"
907
- }
908
- }
909
- }
910
- },
911
- "MultiAssociatedObjectWithLabel" : {
912
- "required" : [ "associationTypes", "toObjectId" ],
913
- "type" : "object",
914
- "properties" : {
915
- "toObjectId" : {
916
- "type" : "string"
917
- },
918
- "associationTypes" : {
919
- "type" : "array",
920
- "items" : {
921
- "$ref" : "#/components/schemas/AssociationSpecWithLabel"
922
- }
923
- }
924
- }
925
- },
926
- "ErrorDetail" : {
927
- "required" : [ "message" ],
928
- "type" : "object",
929
- "properties" : {
930
- "subCategory" : {
931
- "type" : "string",
932
- "description" : "A specific category that contains more specific detail about the error"
933
- },
934
- "code" : {
935
- "type" : "string",
936
- "description" : "The status code associated with the error detail"
937
- },
938
- "in" : {
939
- "type" : "string",
940
- "description" : "The name of the field or parameter in which the error was found."
941
- },
942
- "context" : {
943
- "type" : "object",
944
- "additionalProperties" : {
945
- "type" : "array",
946
- "items" : {
947
- "type" : "string"
948
- }
949
- },
950
- "description" : "Context about the error condition",
951
- "example" : "{\"missingScopes\":[\"scope1\",\"scope2\"]}"
952
- },
953
- "message" : {
954
- "type" : "string",
955
- "description" : "A human readable message describing the error along with remediation steps where appropriate"
956
- }
957
- }
958
- },
959
- "SimplePublicObjectId" : {
960
- "required" : [ "id" ],
961
- "type" : "object",
962
- "properties" : {
963
- "id" : {
964
- "type" : "string",
965
- "description" : "This is generally an objectId. In specific APIs, this can also be used as the value of a unique property."
966
- }
967
- }
968
- },
969
- "AssociationSpecWithLabel" : {
970
- "required" : [ "category", "typeId" ],
971
- "type" : "object",
972
- "properties" : {
973
- "category" : {
974
- "type" : "string",
975
- "enum" : [ "HUBSPOT_DEFINED", "USER_DEFINED", "INTEGRATOR_DEFINED" ]
976
- },
977
- "typeId" : {
978
- "type" : "integer",
979
- "format" : "int32"
980
- },
981
- "label" : {
982
- "type" : "string"
983
- }
984
- }
985
- },
986
- "CreatedResponseLabelsBetweenObjectPair" : {
987
- "required" : [ "createdResourceId", "entity" ],
988
- "type" : "object",
989
- "properties" : {
990
- "location" : {
991
- "type" : "string"
992
- },
993
- "createdResourceId" : {
994
- "type" : "string"
995
- },
996
- "entity" : {
997
- "$ref" : "#/components/schemas/LabelsBetweenObjectPair"
998
- }
999
- }
1000
- },
1001
- "BatchReadInputSimplePublicObjectId" : {
1002
- "required" : [ "inputs", "properties", "propertiesWithHistory" ],
1003
- "type" : "object",
1004
- "properties" : {
1005
- "propertiesWithHistory" : {
1006
- "type" : "array",
1007
- "description" : "Key-value pairs for setting properties for the new object and their histories.",
1008
- "items" : {
1009
- "type" : "string"
1010
- }
1011
- },
1012
- "idProperty" : {
1013
- "type" : "string",
1014
- "description" : "When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID."
1015
- },
1016
- "inputs" : {
1017
- "type" : "array",
1018
- "items" : {
1019
- "$ref" : "#/components/schemas/SimplePublicObjectId"
1020
- }
1021
- },
1022
- "properties" : {
1023
- "type" : "array",
1024
- "description" : "Key-value pairs for setting properties for the new object.",
1025
- "items" : {
1026
- "type" : "string"
1027
- }
1028
- }
1029
- },
1030
- "description" : "Specifies the input for reading a batch of CRM objects, including arrays of object IDs, requested property names (with optional history), and an optional unique identifying property."
1031
- },
1032
- "BatchResponseSimplePublicUpsertObject" : {
1033
- "required" : [ "completedAt", "results", "startedAt", "status" ],
1034
- "type" : "object",
1035
- "properties" : {
1036
- "completedAt" : {
1037
- "type" : "string",
1038
- "description" : "The timestamp when the batch process was completed, in ISO 8601 format.",
1039
- "format" : "date-time"
1040
- },
1041
- "numErrors" : {
1042
- "type" : "integer",
1043
- "format" : "int32"
1044
- },
1045
- "requestedAt" : {
1046
- "type" : "string",
1047
- "description" : "The timestamp when the batch process was initiated, in ISO 8601 format.",
1048
- "format" : "date-time"
1049
- },
1050
- "startedAt" : {
1051
- "type" : "string",
1052
- "description" : "The timestamp when the batch process began execution, in ISO 8601 format.",
1053
- "format" : "date-time"
1054
- },
1055
- "links" : {
1056
- "type" : "object",
1057
- "additionalProperties" : {
1058
- "type" : "string"
1059
- },
1060
- "description" : "An object containing relevant links related to the batch request."
1061
- },
1062
- "results" : {
1063
- "type" : "array",
1064
- "items" : {
1065
- "$ref" : "#/components/schemas/SimplePublicUpsertObject"
1066
- }
1067
- },
1068
- "errors" : {
1069
- "type" : "array",
1070
- "items" : {
1071
- "$ref" : "#/components/schemas/StandardError"
1072
- }
1073
- },
1074
- "status" : {
1075
- "type" : "string",
1076
- "description" : "The status of the batch processing request. Can be: \"PENDING\", \"PROCESSING\", \"CANCELED\", or \"COMPLETE\".",
1077
- "enum" : [ "PENDING", "PROCESSING", "CANCELED", "COMPLETE" ]
1078
- }
1079
- },
1080
- "description" : "Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects."
1081
- },
1082
- "BatchInputSimplePublicObjectId" : {
1083
- "required" : [ "inputs" ],
1084
- "type" : "object",
1085
- "properties" : {
1086
- "inputs" : {
1087
- "type" : "array",
1088
- "items" : {
1089
- "$ref" : "#/components/schemas/SimplePublicObjectId"
1090
- }
1091
- }
1092
- }
1093
- },
1094
- "ValueWithTimestamp" : {
1095
- "required" : [ "sourceType", "timestamp", "value" ],
1096
- "type" : "object",
1097
- "properties" : {
1098
- "sourceId" : {
1099
- "type" : "string",
1100
- "description" : "The unique ID of the property."
1101
- },
1102
- "sourceType" : {
1103
- "type" : "string",
1104
- "description" : "The property type."
1105
- },
1106
- "sourceLabel" : {
1107
- "type" : "string",
1108
- "description" : "A human-readable label."
1109
- },
1110
- "updatedByUserId" : {
1111
- "type" : "integer",
1112
- "description" : "The ID of the user who last updated the property.",
1113
- "format" : "int32"
1114
- },
1115
- "value" : {
1116
- "type" : "string",
1117
- "description" : "The property value."
1118
- },
1119
- "timestamp" : {
1120
- "type" : "string",
1121
- "description" : "The timestamp when the property was updated, in ISO 8601 format.",
1122
- "format" : "date-time"
1123
- }
1124
- },
1125
- "description" : "Property model that includes timestamp."
1126
- },
1127
- "BatchInputSimplePublicObjectBatchInputUpsert" : {
1128
- "required" : [ "inputs" ],
1129
- "type" : "object",
1130
- "properties" : {
1131
- "inputs" : {
1132
- "type" : "array",
1133
- "items" : {
1134
- "$ref" : "#/components/schemas/SimplePublicObjectBatchInputUpsert"
1135
- }
1136
- }
1137
- }
1138
- },
1139
- "SimplePublicObject" : {
1140
- "required" : [ "createdAt", "id", "properties", "updatedAt" ],
1141
- "type" : "object",
1142
- "properties" : {
1143
- "createdAt" : {
1144
- "type" : "string",
1145
- "description" : "The timestamp when the object was created, in ISO 8601 format.",
1146
- "format" : "date-time"
1147
- },
1148
- "archived" : {
1149
- "type" : "boolean",
1150
- "description" : "Whether the object is archived."
1151
- },
1152
- "archivedAt" : {
1153
- "type" : "string",
1154
- "description" : "The timestamp when the object was archived, in ISO 8601 format.",
1155
- "format" : "date-time"
1156
- },
1157
- "propertiesWithHistory" : {
1158
- "type" : "object",
1159
- "additionalProperties" : {
1160
- "type" : "array",
1161
- "items" : {
1162
- "$ref" : "#/components/schemas/ValueWithTimestamp"
1163
- }
1164
- },
1165
- "description" : "Key-value pairs representing the properties of the object along with their history."
1166
- },
1167
- "id" : {
1168
- "type" : "string",
1169
- "description" : "The unique ID of the object.",
1170
- "example" : "512"
1171
- },
1172
- "objectWriteTraceId" : {
1173
- "type" : "string"
1174
- },
1175
- "properties" : {
1176
- "type" : "object",
1177
- "additionalProperties" : {
1178
- "type" : "string",
1179
- "nullable" : true
1180
- },
1181
- "description" : "Key-value pairs representing the properties of the object.",
1182
- "example" : "{\"email\":\"mark.s@lumon.industries\",\"lastname\":\"S.\",\"firstname\":\"Mark\"}"
1183
- },
1184
- "updatedAt" : {
1185
- "type" : "string",
1186
- "description" : "The timestamp when the object was last updated, in ISO 8601 format.",
1187
- "format" : "date-time"
1188
- }
1189
- },
1190
- "description" : "A simple public object.",
1191
- "example" : {
1192
- "archived" : false,
1193
- "createdAt" : "2019-10-30T03:30:17.883Z",
1194
- "id" : "512",
1195
- "properties" : {
1196
- "property_checkbox" : "false",
1197
- "property_date" : "1572480000000",
1198
- "property_dropdown" : "choice_b",
1199
- "property_multiple_checkboxes" : "chocolate;strawberry",
1200
- "property_number" : "17",
1201
- "property_radio" : "option_1",
1202
- "property_string" : "value"
1203
- },
1204
- "updatedAt" : "2019-12-07T16:50:06.678Z"
1205
- }
1206
- },
1207
- "PublicObjectId" : {
1208
- "required" : [ "id" ],
1209
- "type" : "object",
1210
- "properties" : {
1211
- "id" : {
1212
- "type" : "string",
1213
- "description" : "The objectId on a crmobject"
1214
- }
1215
- }
1216
- },
1217
- "Paging" : {
1218
- "type" : "object",
1219
- "properties" : {
1220
- "next" : {
1221
- "$ref" : "#/components/schemas/NextPage"
1222
- },
1223
- "prev" : {
1224
- "$ref" : "#/components/schemas/PreviousPage"
1225
- }
1226
- }
1227
- },
1228
- "CollectionResponseMultiAssociatedObjectWithLabel" : {
1229
- "required" : [ "results" ],
1230
- "type" : "object",
1231
- "properties" : {
1232
- "results" : {
1233
- "type" : "array",
1234
- "items" : {
1235
- "$ref" : "#/components/schemas/MultiAssociatedObjectWithLabel"
1236
- }
1237
- },
1238
- "paging" : {
1239
- "$ref" : "#/components/schemas/Paging"
1240
- }
1241
- }
1242
- },
1243
- "PublicDefaultAssociation" : {
1244
- "required" : [ "associationSpec", "from", "to" ],
1245
- "type" : "object",
1246
- "properties" : {
1247
- "from" : {
1248
- "$ref" : "#/components/schemas/PublicObjectId"
1249
- },
1250
- "to" : {
1251
- "$ref" : "#/components/schemas/PublicObjectId"
1252
- },
1253
- "associationSpec" : {
1254
- "$ref" : "#/components/schemas/AssociationSpec"
1255
- }
1256
- }
1257
- },
1258
- "PublicObjectSearchRequest" : {
1259
- "type" : "object",
1260
- "properties" : {
1261
- "query" : {
1262
- "type" : "string",
1263
- "description" : "The search query string, up to 3000 characters."
1264
- },
1265
- "limit" : {
1266
- "type" : "integer",
1267
- "description" : "The maximum results to return, up to 200 objects.",
1268
- "format" : "int32"
1269
- },
1270
- "after" : {
1271
- "type" : "string",
1272
- "description" : "A paging cursor token for retrieving subsequent pages."
1273
- },
1274
- "sorts" : {
1275
- "type" : "array",
1276
- "description" : "Specifies sorting order based on object properties.",
1277
- "items" : {
1278
- "type" : "string"
1279
- }
1280
- },
1281
- "properties" : {
1282
- "type" : "array",
1283
- "description" : "A list of property names to include in the response.",
1284
- "items" : {
1285
- "type" : "string"
1286
- }
1287
- },
1288
- "filterGroups" : {
1289
- "type" : "array",
1290
- "description" : "Up to 6 groups of filters defining additional query criteria.",
1291
- "items" : {
1292
- "$ref" : "#/components/schemas/FilterGroup"
1293
- }
1294
- }
1295
- },
1296
- "description" : "Describes a search request"
1297
- },
1298
- "Error" : {
1299
- "required" : [ "category", "correlationId", "message" ],
1300
- "type" : "object",
1301
- "properties" : {
1302
- "subCategory" : {
1303
- "type" : "string",
1304
- "description" : "A specific category that contains more specific detail about the error"
1305
- },
1306
- "context" : {
1307
- "type" : "object",
1308
- "additionalProperties" : {
1309
- "type" : "array",
1310
- "items" : {
1311
- "type" : "string"
1312
- }
1313
- },
1314
- "description" : "Context about the error condition",
1315
- "example" : "{\"missingScopes\":[\"scope1\",\"scope2\"],\"invalidPropertyName\":[\"propertyValue\"]}"
1316
- },
1317
- "correlationId" : {
1318
- "type" : "string",
1319
- "description" : "A unique identifier for the request. Include this value with any error reports or support tickets",
1320
- "format" : "uuid",
1321
- "example" : "aeb5f871-7f07-4993-9211-075dc63e7cbf"
1322
- },
1323
- "links" : {
1324
- "type" : "object",
1325
- "additionalProperties" : {
1326
- "type" : "string"
1327
- },
1328
- "description" : "A map of link names to associated URIs containing documentation about the error or recommended remediation steps",
1329
- "example" : "{\"knowledge-base\":\"https://www.hubspot.com/products/service/knowledge-base\"}"
1330
- },
1331
- "message" : {
1332
- "type" : "string",
1333
- "description" : "A human readable message describing the error along with remediation steps where appropriate",
1334
- "example" : "Invalid input (details will vary based on the error)"
1335
- },
1336
- "category" : {
1337
- "type" : "string",
1338
- "description" : "The error category",
1339
- "example" : "VALIDATION_ERROR"
1340
- },
1341
- "errors" : {
1342
- "type" : "array",
1343
- "description" : "further information about the error",
1344
- "items" : {
1345
- "$ref" : "#/components/schemas/ErrorDetail"
1346
- }
1347
- }
1348
- },
1349
- "example" : {
1350
- "message" : "Invalid input (details will vary based on the error)",
1351
- "correlationId" : "aeb5f871-7f07-4993-9211-075dc63e7cbf",
1352
- "category" : "VALIDATION_ERROR",
1353
- "links" : {
1354
- "knowledge-base" : "https://www.hubspot.com/products/service/knowledge-base"
1355
- }
1356
- }
1357
- },
1358
- "SimplePublicObjectBatchInputUpsert" : {
1359
- "required" : [ "id", "properties" ],
1360
- "type" : "object",
1361
- "properties" : {
1362
- "idProperty" : {
1363
- "type" : "string",
1364
- "description" : "The name of a property whose values are unique for this object"
1365
- },
1366
- "objectWriteTraceId" : {
1367
- "type" : "string",
1368
- "description" : "An identifier for tracing the creation request."
1369
- },
1370
- "id" : {
1371
- "type" : "string",
1372
- "description" : "The unique ID of the object."
1373
- },
1374
- "properties" : {
1375
- "type" : "object",
1376
- "additionalProperties" : {
1377
- "type" : "string"
1378
- },
1379
- "description" : "Key value pairs representing the properties of the object.",
1380
- "example" : "{\"lastname\":\"S.\",\"firstname\":\"Mark\"}"
1381
- }
1382
- },
1383
- "description" : "Represents an object used in batch upsert operations, containing an object’s unique identifier, its properties, and optionally the unique property name and a write trace ID."
1384
- },
1385
- "PublicGdprDeleteInput" : {
1386
- "required" : [ "objectId" ],
1387
- "type" : "object",
1388
- "properties" : {
1389
- "idProperty" : {
1390
- "type" : "string",
1391
- "description" : "The name of a property whose values are unique for this object. An alternative to identifying a contact by ID."
1392
- },
1393
- "objectId" : {
1394
- "type" : "string",
1395
- "description" : "The ID of the contact to permanently delete."
1396
- }
1397
- }
1398
- },
1399
- "SimplePublicObjectInput" : {
1400
- "required" : [ "properties" ],
1401
- "type" : "object",
1402
- "properties" : {
1403
- "properties" : {
1404
- "type" : "object",
1405
- "additionalProperties" : {
1406
- "type" : "string"
1407
- },
1408
- "description" : "Key value pairs representing the properties of the object.",
1409
- "example" : "{\"property_date\":\"1572480000000\",\"property_radio\":\"option_1\",\"property_number\":\"17\",\"property_string\":\"value\",\"property_checkbox\":\"false\",\"property_dropdown\":\"choice_b\",\"property_multiple_checkboxes\":\"chocolate;strawberry\"}"
1410
- }
1411
- },
1412
- "description" : "Represents the input required to create or update a CRM object, containing an object with property names and their corresponding values.",
1413
- "example" : {
1414
- "properties" : {
1415
- "property_checkbox" : "false",
1416
- "property_date" : "1572480000000",
1417
- "property_dropdown" : "choice_b",
1418
- "property_multiple_checkboxes" : "chocolate;strawberry",
1419
- "property_number" : "17",
1420
- "property_radio" : "option_1",
1421
- "property_string" : "value"
1422
- }
1423
- }
1424
- },
1425
- "BatchResponsePublicDefaultAssociation" : {
1426
- "required" : [ "completedAt", "results", "startedAt", "status" ],
1427
- "type" : "object",
1428
- "properties" : {
1429
- "completedAt" : {
1430
- "type" : "string",
1431
- "format" : "date-time"
1432
- },
1433
- "status" : {
1434
- "type" : "string",
1435
- "enum" : [ "PENDING", "PROCESSING", "CANCELED", "COMPLETE" ]
1436
- },
1437
- "requestedAt" : {
1438
- "type" : "string",
1439
- "format" : "date-time"
1440
- },
1441
- "startedAt" : {
1442
- "type" : "string",
1443
- "format" : "date-time"
1444
- },
1445
- "links" : {
1446
- "type" : "object",
1447
- "additionalProperties" : {
1448
- "type" : "string"
1449
- }
1450
- },
1451
- "results" : {
1452
- "type" : "array",
1453
- "items" : {
1454
- "$ref" : "#/components/schemas/PublicDefaultAssociation"
1455
- }
1456
- },
1457
- "errors" : {
1458
- "type" : "array",
1459
- "items" : {
1460
- "$ref" : "#/components/schemas/StandardError"
1461
- }
1462
- },
1463
- "numErrors" : {
1464
- "type" : "integer",
1465
- "format" : "int32"
1466
- }
1467
- }
1468
- },
1469
- "AssociationSpec" : {
1470
- "required" : [ "associationCategory", "associationTypeId" ],
1471
- "type" : "object",
1472
- "properties" : {
1473
- "associationCategory" : {
1474
- "type" : "string",
1475
- "description" : "The category of the association, such as \"HUBSPOT_DEFINED\".",
1476
- "enum" : [ "HUBSPOT_DEFINED", "USER_DEFINED", "INTEGRATOR_DEFINED" ]
1477
- },
1478
- "associationTypeId" : {
1479
- "type" : "integer",
1480
- "description" : "The ID representing the specific type of association.",
1481
- "format" : "int32"
1482
- }
1483
- },
1484
- "description" : "Defines the type, direction, and details of the relationship between two CRM objects."
1485
- },
1486
- "PublicMergeInput" : {
1487
- "required" : [ "objectIdToMerge", "primaryObjectId" ],
1488
- "type" : "object",
1489
- "properties" : {
1490
- "objectIdToMerge" : {
1491
- "type" : "string",
1492
- "description" : "The object ID of the record that the merge will not set as the current value after the merge."
1493
- },
1494
- "primaryObjectId" : {
1495
- "type" : "string",
1496
- "description" : "The object ID of the record that the merge will generally set as the current value after the merge."
1497
- }
1498
- }
1499
- },
1500
- "CollectionResponseSimplePublicObjectWithAssociations" : {
1501
- "required" : [ "results" ],
1502
- "type" : "object",
1503
- "properties" : {
1504
- "results" : {
1505
- "type" : "array",
1506
- "items" : {
1507
- "$ref" : "#/components/schemas/SimplePublicObjectWithAssociations"
1508
- }
1509
- },
1510
- "paging" : {
1511
- "$ref" : "#/components/schemas/Paging"
1512
- }
1513
- }
1514
- },
1515
- "SimplePublicObjectWithAssociations" : {
1516
- "required" : [ "createdAt", "id", "properties", "updatedAt" ],
1517
- "type" : "object",
1518
- "properties" : {
1519
- "associations" : {
1520
- "type" : "object",
1521
- "additionalProperties" : {
1522
- "$ref" : "#/components/schemas/CollectionResponseAssociatedId"
1523
- },
1524
- "description" : "A list defining relationships with other objects.",
1525
- "example" : "{\"companies\":{\"results\":[{\"id\":\"29846388244\",\"type\":\"contact_to_company\"},{\"id\":\"29846388244\",\"type\":\"contact_to_company_unlabeled\"}]}}"
1526
- },
1527
- "createdAt" : {
1528
- "type" : "string",
1529
- "description" : "The timestamp when the object was created, in ISO 8601 format.",
1530
- "format" : "date-time"
1531
- },
1532
- "archived" : {
1533
- "type" : "boolean",
1534
- "description" : "Whether the object is archived."
1535
- },
1536
- "archivedAt" : {
1537
- "type" : "string",
1538
- "description" : "The timestamp when the object was archived, in ISO 8601 format.",
1539
- "format" : "date-time"
1540
- },
1541
- "propertiesWithHistory" : {
1542
- "type" : "object",
1543
- "additionalProperties" : {
1544
- "type" : "array",
1545
- "items" : {
1546
- "$ref" : "#/components/schemas/ValueWithTimestamp"
1547
- }
1548
- },
1549
- "description" : "Key-value pairs representing the properties of the object along with their history.",
1550
- "example" : "{\"lastname\":[{\"value\":\"Scout\",\"sourceId\":\"userId:2931299\",\"timestamp\":\"2025-02-11T16:28:13.591Z\",\"sourceType\":\"CRM_UI\",\"updatedByUserId\":2931299},{\"value\":\"S.\",\"sourceId\":\"userId:2931299\",\"timestamp\":\"2025-02-11T15:45:00.400Z\",\"sourceType\":\"CRM_UI\",\"updatedByUserId\":2931299}]}"
1551
- },
1552
- "id" : {
1553
- "type" : "string",
1554
- "description" : "The unique ID of the object."
1555
- },
1556
- "objectWriteTraceId" : {
1557
- "type" : "string"
1558
- },
1559
- "properties" : {
1560
- "type" : "object",
1561
- "additionalProperties" : {
1562
- "type" : "string",
1563
- "nullable" : true
1564
- },
1565
- "description" : "Key value pairs representing the properties of the object.",
1566
- "example" : "{\"email\":\"mark.s@lumon.industries\",\"lastname\":\"S.\",\"firstname\":\"Mark\",\"createdate\":\"2025-02-11T15:45:00.400Z\",\"hs_object_id\":\"98630638716\",\"lastmodifieddate\":\"2025-02-11T15:52:10.273Z\"}"
1567
- },
1568
- "updatedAt" : {
1569
- "type" : "string",
1570
- "description" : "The timestamp when the object was last updated, in ISO 8601 format.",
1571
- "format" : "date-time"
1572
- }
1573
- },
1574
- "description" : "Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type."
1575
- },
1576
- "Filter" : {
1577
- "required" : [ "operator", "propertyName" ],
1578
- "type" : "object",
1579
- "properties" : {
1580
- "highValue" : {
1581
- "type" : "string",
1582
- "description" : "The upper boundary value when using ranged-based filters."
1583
- },
1584
- "propertyName" : {
1585
- "type" : "string",
1586
- "description" : "The name of the property to apply the filter to."
1587
- },
1588
- "values" : {
1589
- "type" : "array",
1590
- "description" : "The values to match against the property.",
1591
- "items" : {
1592
- "type" : "string"
1593
- }
1594
- },
1595
- "value" : {
1596
- "type" : "string",
1597
- "description" : "The value to match against the property."
1598
- },
1599
- "operator" : {
1600
- "type" : "string",
1601
- "description" : "null",
1602
- "enum" : [ "EQ", "NEQ", "LT", "LTE", "GT", "GTE", "BETWEEN", "IN", "NOT_IN", "HAS_PROPERTY", "NOT_HAS_PROPERTY", "CONTAINS_TOKEN", "NOT_CONTAINS_TOKEN" ]
1603
- }
1604
- },
1605
- "description" : "Defines a single condition for searching CRM objects, specifying the property to filter on, the operator to use (such as equals, greater than, or contains), and the value(s) to compare against. "
1606
- },
1607
- "BatchInputSimplePublicObjectBatchInput" : {
1608
- "required" : [ "inputs" ],
1609
- "type" : "object",
1610
- "properties" : {
1611
- "inputs" : {
1612
- "type" : "array",
1613
- "items" : {
1614
- "$ref" : "#/components/schemas/SimplePublicObjectBatchInput"
1615
- }
1616
- }
1617
- }
1618
- },
1619
- "PreviousPage" : {
1620
- "required" : [ "before" ],
1621
- "type" : "object",
1622
- "properties" : {
1623
- "before" : {
1624
- "type" : "string",
1625
- "description" : "A paging cursor token for retrieving previous pages."
1626
- },
1627
- "link" : {
1628
- "type" : "string",
1629
- "description" : "A URL that can be used to retrieve the previous pages' results."
1630
- }
1631
- },
1632
- "description" : "specifies the paging information needed to retrieve the previous set of results in a paginated API response"
1633
- },
1634
- "SimplePublicUpsertObject" : {
1635
- "required" : [ "createdAt", "id", "new", "properties", "updatedAt" ],
1636
- "type" : "object",
1637
- "properties" : {
1638
- "createdAt" : {
1639
- "type" : "string",
1640
- "description" : "The timestamp when the object was created, in ISO 8601 format.",
1641
- "format" : "date-time"
1642
- },
1643
- "archived" : {
1644
- "type" : "boolean",
1645
- "description" : "Whether the object is archived."
1646
- },
1647
- "archivedAt" : {
1648
- "type" : "string",
1649
- "description" : "The timestamp when the object was archived, in ISO 8601 format.",
1650
- "format" : "date-time"
1651
- },
1652
- "new" : {
1653
- "type" : "boolean",
1654
- "description" : "Whether the property is new."
1655
- },
1656
- "propertiesWithHistory" : {
1657
- "type" : "object",
1658
- "additionalProperties" : {
1659
- "type" : "array",
1660
- "items" : {
1661
- "$ref" : "#/components/schemas/ValueWithTimestamp"
1662
- }
1663
- },
1664
- "description" : "Key-value pairs representing the properties of the object along with their history."
1665
- },
1666
- "id" : {
1667
- "type" : "string",
1668
- "description" : "The unique ID of the object."
1669
- },
1670
- "objectWriteTraceId" : {
1671
- "type" : "string",
1672
- "description" : "An identifier for tracing the creation request."
1673
- },
1674
- "properties" : {
1675
- "type" : "object",
1676
- "additionalProperties" : {
1677
- "type" : "string"
1678
- },
1679
- "description" : "Key value pairs representing the properties of the object."
1680
- },
1681
- "updatedAt" : {
1682
- "type" : "string",
1683
- "description" : "The timestamp when the object was last updated, in ISO 8601 format.",
1684
- "format" : "date-time"
1685
- }
1686
- },
1687
- "description" : "Represents a CRM object that has either been created or updated (upserted)"
1688
- },
1689
- "SimplePublicObjectBatchInput" : {
1690
- "required" : [ "id", "properties" ],
1691
- "type" : "object",
1692
- "properties" : {
1693
- "idProperty" : {
1694
- "type" : "string",
1695
- "description" : "The name of a unique property, when identifying records by property. ",
1696
- "example" : "my_unique_property_name"
1697
- },
1698
- "objectWriteTraceId" : {
1699
- "type" : "string",
1700
- "description" : "A unique identifier for tracing the request."
1701
- },
1702
- "id" : {
1703
- "type" : "string",
1704
- "description" : "The ID of the contact to update. This can be the object ID, or the unique property value of the `idProperty` property."
1705
- },
1706
- "properties" : {
1707
- "type" : "object",
1708
- "additionalProperties" : {
1709
- "type" : "string"
1710
- },
1711
- "description" : "Key-value pairs representing the properties of the object.",
1712
- "example" : "{\"email\":\"mark.s@lumon.industries\",\"lastname\":\"S.\",\"firstname\":\"Mark\",\"createdate\":\"2025-02-11T15:45:00.400Z\",\"hs_object_id\":\"98630638716\",\"lastmodifieddate\":\"2025-02-11T15:52:10.273Z\"}"
1713
- }
1714
- },
1715
- "description" : "Contains an array of CRM object records to be processed in a batch operation, each defined by their ID and properties."
1716
- },
1717
- "SimplePublicObjectBatchInputForCreate" : {
1718
- "required" : [ "properties" ],
1719
- "type" : "object",
1720
- "properties" : {
1721
- "associations" : {
1722
- "type" : "array",
1723
- "items" : {
1724
- "$ref" : "#/components/schemas/PublicAssociationsForObject"
1725
- }
1726
- },
1727
- "objectWriteTraceId" : {
1728
- "type" : "string",
1729
- "description" : "User provided trace ID which serves as both a request identifier for tracking purposes and a flag to enable partial update behavior.\n\nEach objectWriteTraceId in a batch must be unique, or must be omitted from all requests in a batch."
1730
- },
1731
- "properties" : {
1732
- "type" : "object",
1733
- "additionalProperties" : {
1734
- "type" : "string"
1735
- },
1736
- "description" : "The map of properties that should be created",
1737
- "example" : "{ \"firstname\": \"John\", \"lastname\": \"Doe\", \"email\": \"john.doe@example.com\", \"company\": \"HubSpot\", \"phone\": \"+1-555-123-4567\" }"
1738
- }
1739
- }
1740
- },
1741
- "AssociatedId" : {
1742
- "required" : [ "id", "type" ],
1743
- "type" : "object",
1744
- "properties" : {
1745
- "id" : {
1746
- "type" : "string",
1747
- "description" : "The ID for the association type."
1748
- },
1749
- "type" : {
1750
- "type" : "string",
1751
- "description" : "The type of association.",
1752
- "example" : "deal_to_contact"
1753
- }
1754
- },
1755
- "description" : "Contains the id and type of an association"
1756
- },
1757
- "NextPage" : {
1758
- "required" : [ "after" ],
1759
- "type" : "object",
1760
- "properties" : {
1761
- "link" : {
1762
- "type" : "string",
1763
- "description" : "A URL that can be used to retrieve the next page results.",
1764
- "example" : "?after=NTI1Cg%3D%3D"
1765
- },
1766
- "after" : {
1767
- "type" : "string",
1768
- "description" : "A paging cursor token for retrieving subsequent pages.",
1769
- "example" : "NTI1Cg%3D%3D"
1770
- }
1771
- },
1772
- "description" : "Specifies the paging information needed to retrieve the next set of results in a paginated API response",
1773
- "example" : {
1774
- "after" : "NTI1Cg%3D%3D",
1775
- "link" : "?after=NTI1Cg%3D%3D"
1776
- }
1777
- },
1778
- "SimplePublicObjectInputForCreate" : {
1779
- "required" : [ "properties" ],
1780
- "type" : "object",
1781
- "properties" : {
1782
- "associations" : {
1783
- "type" : "array",
1784
- "items" : {
1785
- "$ref" : "#/components/schemas/PublicAssociationsForObject"
1786
- }
1787
- },
1788
- "properties" : {
1789
- "type" : "object",
1790
- "additionalProperties" : {
1791
- "type" : "string"
1792
- },
1793
- "description" : "Key-value pairs for setting properties for the new object.",
1794
- "example" : "{\"email\":\"mark.s@lumon.industries\",\"lastname\":\"S.\",\"firstname\":\"Mark\"}"
1795
- }
1796
- },
1797
- "description" : "Is the input object used to create a new CRM object, containing the properties to be set and optional associations to link the new record with other CRM objects."
1798
- },
1799
- "BatchInputSimplePublicObjectBatchInputForCreate" : {
1800
- "required" : [ "inputs" ],
1801
- "type" : "object",
1802
- "properties" : {
1803
- "inputs" : {
1804
- "type" : "array",
1805
- "items" : {
1806
- "$ref" : "#/components/schemas/SimplePublicObjectBatchInputForCreate"
1807
- }
1808
- }
1809
- }
1810
- }
1811
- },
1812
- "responses" : {
1813
- "Error" : {
1814
- "description" : "An error occurred.",
1815
- "content" : {
1816
- "*/*" : {
1817
- "schema" : {
1818
- "$ref" : "#/components/schemas/Error"
1819
- }
1820
- }
1821
- }
1822
- }
1823
- },
1824
- "securitySchemes" : {
1825
- "oauth2" : {
1826
- "type" : "oauth2",
1827
- "flows" : {
1828
- "authorizationCode" : {
1829
- "authorizationUrl" : "https://app.hubspot.com/oauth/authorize",
1830
- "tokenUrl" : "https://api.hubapi.com/oauth/v1/token",
1831
- "scopes" : {
1832
- "oauth" : "User and Account Information",
1833
- "crm.objects.deals.read" : "View deal records",
1834
- "crm.objects.subscriptions.read" : "Read Commerce Subscriptions",
1835
- "crm.objects.services.read" : "Read services",
1836
- "crm.objects.orders.read" : "Read Orders",
1837
- "crm.objects.listings.write" : "Write listings",
1838
- "crm.objects.custom.read" : "View custom object records",
1839
- "crm.objects.companies.write" : "View company records",
1840
- "crm.objects.custom.sensitive.write.v2" : "Change custom object records (sensitive)",
1841
- "crm.objects.custom.highly_sensitive.write.v2" : "Change custom object records (highly-sensitive)",
1842
- "crm.objects.companies.read" : "Create or update company records",
1843
- "crm.objects.appointments.sensitive.read.v2" : "Read appointments (sensitive)",
1844
- "crm.objects.contacts.highly_sensitive.read.v2" : "View contact records (highly-sensitive)",
1845
- "crm.objects.companies.sensitive.read.v2" : "View sensitive properties on company records",
1846
- "media_bridge.read" : "Read media and media events",
1847
- "crm.objects.deals.highly_sensitive.read.v2" : "View deal records (highly-sensitive)",
1848
- "crm.objects.contacts.highly_sensitive.write.v2" : "Change contact records (highly-sensitive)",
1849
- "crm.objects.companies.highly_sensitive.read.v2" : "View company records (highly-sensitive)",
1850
- "crm.objects.commercepayments.write" : "Write commerce payments",
1851
- "crm.objects.invoices.write" : "Write invoices",
1852
- "crm.objects.contacts.sensitive.write.v2" : "Create or update sensitive properties on contact records",
1853
- "crm.objects.users.write" : "Write User CRM objects",
1854
- "crm.objects.custom.sensitive.read.v2" : "View custom object records (sensitive)",
1855
- "crm.objects.users.read" : "Read User CRM objects",
1856
- "crm.objects.partner-services.read" : "View Partner Service CRM objects",
1857
- "crm.objects.orders.write" : "Write orders",
1858
- "crm.objects.partner-services.write" : "Modify Partner Service CRM objects",
1859
- "crm.objects.appointments.write" : "Write appointments",
1860
- "crm.objects.carts.write" : "Write cart",
1861
- "crm.objects.commercepayments.read" : "Read the COMMERCE_PAYMENT object.",
1862
- "crm.objects.products.write" : "Write to my Product Library",
1863
- "crm.objects.services.write" : "Write services",
1864
- "crm.objects.subscriptions.write" : "Write to Commerce Subscriptions",
1865
- "crm.objects.deals.sensitive.write.v2" : "Create or update sensitive properties on deal records",
1866
- "crm.objects.contacts.read" : "View contact records",
1867
- "crm.objects.appointments.sensitive.write.v2" : "Write appointments (sensitive)",
1868
- "crm.objects.invoices.read" : "Read invoices objects",
1869
- "tickets.sensitive.v2" : "Tickets (sensitive)",
1870
- "crm.objects.custom.write" : "Change custom object records",
1871
- "crm.objects.deals.write" : "Create or update deal records",
1872
- "crm.objects.appointments.read" : "Read appointments",
1873
- "crm.objects.companies.sensitive.write.v2" : "Create or update sensitive properties on company records",
1874
- "crm.objects.deals.highly_sensitive.write.v2" : "Change deal records (highly-sensitive)",
1875
- "crm.objects.custom.highly_sensitive.read.v2" : "View custom object records (highly-sensitive)",
1876
- "crm.objects.companies.highly_sensitive.write.v2" : "Change company records (highly-sensitive)",
1877
- "crm.objects.goals.write" : "Write goals",
1878
- "crm.objects.line_items.write" : "Line Items",
1879
- "crm.objects.contacts.write" : "Create or update contact records",
1880
- "crm.objects.goals.read" : "Read goals",
1881
- "crm.objects.partner-clients.write" : "Modify Partner Client CRM objects",
1882
- "crm.objects.line_items.read" : "Line Items",
1883
- "crm.objects.deals.sensitive.read.v2" : "View sensitive properties on deal records",
1884
- "tickets.highly_sensitive.v2" : "Tickets (highly-sensitive)",
1885
- "crm.objects.quotes.write" : "Quotes",
1886
- "crm.objects.leads.read" : "Read lead objects",
1887
- "crm.objects.leads.write" : "Modify lead objects",
1888
- "crm.objects.carts.read" : "Read carts",
1889
- "crm.objects.quotes.read" : "Quotes",
1890
- "crm.objects.courses.write" : "Write courses",
1891
- "crm.objects.partner-clients.read" : "View Partner Client CRM objects",
1892
- "crm.objects.courses.read" : "Read courses",
1893
- "crm.objects.listings.read" : "Read listings",
1894
- "crm.objects.contacts.sensitive.read.v2" : "View sensitive properties on contact records",
1895
- "crm.objects.products.read" : "Read from my Product Library"
1896
- }
1897
- }
1898
- }
1899
- },
1900
- "private_apps_legacy" : {
1901
- "type" : "apiKey",
1902
- "name" : "private-app-legacy",
1903
- "in" : "header"
1904
- },
1905
- "private_apps" : {
1906
- "type" : "apiKey",
1907
- "name" : "private-app",
1908
- "in" : "header"
1909
- }
1910
- }
1911
- },
1912
- "x-hubspot-available-client-libraries" : [ "Node", "Python", "Ruby", "PHP" ],
1913
- "x-hubspot-product-tier-requirements" : {
1914
- "marketing" : "FREE",
1915
- "sales" : "FREE",
1916
- "service" : "FREE",
1917
- "cms" : "FREE"
1918
- }
1919
- }