featurebase-node 0.14.2 → 0.15.0
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.
- package/CHANGELOG.md +16 -0
- package/client.d.mts +5 -5
- package/client.d.mts.map +1 -1
- package/client.d.ts +5 -5
- package/client.d.ts.map +1 -1
- package/package.json +1 -1
- package/resources/audit-logs.d.mts +3 -3
- package/resources/audit-logs.d.mts.map +1 -1
- package/resources/audit-logs.d.ts +3 -3
- package/resources/audit-logs.d.ts.map +1 -1
- package/resources/changelogs/changelogs.d.mts +116 -116
- package/resources/changelogs/changelogs.d.mts.map +1 -1
- package/resources/changelogs/changelogs.d.ts +116 -116
- package/resources/changelogs/changelogs.d.ts.map +1 -1
- package/resources/changelogs/changelogs.js +74 -74
- package/resources/changelogs/changelogs.js.map +1 -1
- package/resources/changelogs/changelogs.mjs +74 -74
- package/resources/changelogs/changelogs.mjs.map +1 -1
- package/resources/changelogs/index.d.mts +1 -1
- package/resources/changelogs/index.d.mts.map +1 -1
- package/resources/changelogs/index.d.ts +1 -1
- package/resources/changelogs/index.d.ts.map +1 -1
- package/resources/changelogs/subscribers.d.mts +3 -3
- package/resources/changelogs/subscribers.d.mts.map +1 -1
- package/resources/changelogs/subscribers.d.ts +3 -3
- package/resources/changelogs/subscribers.d.ts.map +1 -1
- package/resources/conversation-attributes.d.mts +17 -17
- package/resources/conversation-attributes.d.mts.map +1 -1
- package/resources/conversation-attributes.d.ts +17 -17
- package/resources/conversation-attributes.d.ts.map +1 -1
- package/resources/conversation-attributes.js +19 -19
- package/resources/conversation-attributes.js.map +1 -1
- package/resources/conversation-attributes.mjs +19 -19
- package/resources/conversation-attributes.mjs.map +1 -1
- package/resources/feedback/boards.d.mts +19 -19
- package/resources/feedback/boards.d.mts.map +1 -1
- package/resources/feedback/boards.d.ts +19 -19
- package/resources/feedback/boards.d.ts.map +1 -1
- package/resources/feedback/boards.js +20 -20
- package/resources/feedback/boards.js.map +1 -1
- package/resources/feedback/boards.mjs +20 -20
- package/resources/feedback/boards.mjs.map +1 -1
- package/resources/feedback/comments.d.mts +113 -113
- package/resources/feedback/comments.d.mts.map +1 -1
- package/resources/feedback/comments.d.ts +113 -113
- package/resources/feedback/comments.d.ts.map +1 -1
- package/resources/feedback/comments.js +93 -93
- package/resources/feedback/comments.js.map +1 -1
- package/resources/feedback/comments.mjs +93 -93
- package/resources/feedback/comments.mjs.map +1 -1
- package/resources/feedback/custom-fields.d.mts +36 -36
- package/resources/feedback/custom-fields.d.mts.map +1 -1
- package/resources/feedback/custom-fields.d.ts +36 -36
- package/resources/feedback/custom-fields.d.ts.map +1 -1
- package/resources/feedback/custom-fields.js +36 -36
- package/resources/feedback/custom-fields.js.map +1 -1
- package/resources/feedback/custom-fields.mjs +36 -36
- package/resources/feedback/custom-fields.mjs.map +1 -1
- package/resources/feedback/feedback.d.mts +6 -6
- package/resources/feedback/feedback.d.mts.map +1 -1
- package/resources/feedback/feedback.d.ts +6 -6
- package/resources/feedback/feedback.d.ts.map +1 -1
- package/resources/feedback/feedback.js.map +1 -1
- package/resources/feedback/feedback.mjs.map +1 -1
- package/resources/feedback/index.d.mts +5 -5
- package/resources/feedback/index.d.mts.map +1 -1
- package/resources/feedback/index.d.ts +5 -5
- package/resources/feedback/index.d.ts.map +1 -1
- package/resources/feedback/index.js.map +1 -1
- package/resources/feedback/index.mjs.map +1 -1
- package/resources/feedback/post-statuses.d.mts +20 -20
- package/resources/feedback/post-statuses.d.mts.map +1 -1
- package/resources/feedback/post-statuses.d.ts +20 -20
- package/resources/feedback/post-statuses.d.ts.map +1 -1
- package/resources/feedback/post-statuses.js +23 -23
- package/resources/feedback/post-statuses.js.map +1 -1
- package/resources/feedback/post-statuses.mjs +23 -23
- package/resources/feedback/post-statuses.mjs.map +1 -1
- package/resources/feedback/posts/index.d.mts +1 -1
- package/resources/feedback/posts/index.d.mts.map +1 -1
- package/resources/feedback/posts/index.d.ts +1 -1
- package/resources/feedback/posts/index.d.ts.map +1 -1
- package/resources/feedback/posts/index.js.map +1 -1
- package/resources/feedback/posts/index.mjs.map +1 -1
- package/resources/feedback/posts/posts.d.mts +169 -102
- package/resources/feedback/posts/posts.d.mts.map +1 -1
- package/resources/feedback/posts/posts.d.ts +169 -102
- package/resources/feedback/posts/posts.d.ts.map +1 -1
- package/resources/feedback/posts/posts.js +144 -75
- package/resources/feedback/posts/posts.js.map +1 -1
- package/resources/feedback/posts/posts.mjs +144 -75
- package/resources/feedback/posts/posts.mjs.map +1 -1
- package/resources/feedback/posts/voters.d.mts +3 -3
- package/resources/feedback/posts/voters.d.mts.map +1 -1
- package/resources/feedback/posts/voters.d.ts +3 -3
- package/resources/feedback/posts/voters.d.ts.map +1 -1
- package/resources/help-center/articles.d.mts +213 -97
- package/resources/help-center/articles.d.mts.map +1 -1
- package/resources/help-center/articles.d.ts +213 -97
- package/resources/help-center/articles.d.ts.map +1 -1
- package/resources/help-center/articles.js +73 -73
- package/resources/help-center/articles.js.map +1 -1
- package/resources/help-center/articles.mjs +73 -73
- package/resources/help-center/articles.mjs.map +1 -1
- package/resources/help-center/collections.d.mts +158 -71
- package/resources/help-center/collections.d.mts.map +1 -1
- package/resources/help-center/collections.d.ts +158 -71
- package/resources/help-center/collections.d.ts.map +1 -1
- package/resources/help-center/collections.js +65 -65
- package/resources/help-center/collections.js.map +1 -1
- package/resources/help-center/collections.mjs +65 -65
- package/resources/help-center/collections.mjs.map +1 -1
- package/resources/help-center/help-center.d.mts +4 -4
- package/resources/help-center/help-center.d.mts.map +1 -1
- package/resources/help-center/help-center.d.ts +4 -4
- package/resources/help-center/help-center.d.ts.map +1 -1
- package/resources/help-center/help-centers.d.mts +77 -48
- package/resources/help-center/help-centers.d.mts.map +1 -1
- package/resources/help-center/help-centers.d.ts +77 -48
- package/resources/help-center/help-centers.d.ts.map +1 -1
- package/resources/help-center/help-centers.js +43 -43
- package/resources/help-center/help-centers.js.map +1 -1
- package/resources/help-center/help-centers.mjs +43 -43
- package/resources/help-center/help-centers.mjs.map +1 -1
- package/resources/help-center/index.d.mts +4 -4
- package/resources/help-center/index.d.mts.map +1 -1
- package/resources/help-center/index.d.ts +4 -4
- package/resources/help-center/index.d.ts.map +1 -1
- package/resources/help-center/redirect-rules.d.mts +124 -124
- package/resources/help-center/redirect-rules.d.mts.map +1 -1
- package/resources/help-center/redirect-rules.d.ts +124 -124
- package/resources/help-center/redirect-rules.d.ts.map +1 -1
- package/resources/help-center/redirect-rules.js +112 -112
- package/resources/help-center/redirect-rules.js.map +1 -1
- package/resources/help-center/redirect-rules.mjs +112 -112
- package/resources/help-center/redirect-rules.mjs.map +1 -1
- package/resources/index.d.mts +5 -5
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +5 -5
- package/resources/index.d.ts.map +1 -1
- package/resources/organization/admins.d.mts +26 -26
- package/resources/organization/admins.d.mts.map +1 -1
- package/resources/organization/admins.d.ts +26 -26
- package/resources/organization/admins.d.ts.map +1 -1
- package/resources/organization/admins.js +25 -25
- package/resources/organization/admins.js.map +1 -1
- package/resources/organization/admins.mjs +25 -25
- package/resources/organization/admins.mjs.map +1 -1
- package/resources/organization/brands.d.mts +52 -52
- package/resources/organization/brands.d.mts.map +1 -1
- package/resources/organization/brands.d.ts +52 -52
- package/resources/organization/brands.d.ts.map +1 -1
- package/resources/organization/brands.js +54 -54
- package/resources/organization/brands.js.map +1 -1
- package/resources/organization/brands.mjs +54 -54
- package/resources/organization/brands.mjs.map +1 -1
- package/resources/organization/index.d.mts +3 -3
- package/resources/organization/index.d.mts.map +1 -1
- package/resources/organization/index.d.ts +3 -3
- package/resources/organization/index.d.ts.map +1 -1
- package/resources/organization/organization.d.mts +3 -3
- package/resources/organization/organization.d.mts.map +1 -1
- package/resources/organization/organization.d.ts +3 -3
- package/resources/organization/organization.d.ts.map +1 -1
- package/resources/organization/teams.d.mts +47 -47
- package/resources/organization/teams.d.mts.map +1 -1
- package/resources/organization/teams.d.ts +47 -47
- package/resources/organization/teams.d.ts.map +1 -1
- package/resources/organization/teams.js +44 -44
- package/resources/organization/teams.js.map +1 -1
- package/resources/organization/teams.mjs +44 -44
- package/resources/organization/teams.mjs.map +1 -1
- package/resources/reports.d.mts +347 -180
- package/resources/reports.d.mts.map +1 -1
- package/resources/reports.d.ts +347 -180
- package/resources/reports.d.ts.map +1 -1
- package/resources/reports.js +124 -99
- package/resources/reports.js.map +1 -1
- package/resources/reports.mjs +124 -99
- package/resources/reports.mjs.map +1 -1
- package/resources/support/conversation-tags.d.mts +43 -43
- package/resources/support/conversation-tags.d.mts.map +1 -1
- package/resources/support/conversation-tags.d.ts +43 -43
- package/resources/support/conversation-tags.d.ts.map +1 -1
- package/resources/support/conversation-tags.js +32 -32
- package/resources/support/conversation-tags.js.map +1 -1
- package/resources/support/conversation-tags.mjs +32 -32
- package/resources/support/conversation-tags.mjs.map +1 -1
- package/resources/support/conversations/conversations.d.mts +402 -351
- package/resources/support/conversations/conversations.d.mts.map +1 -1
- package/resources/support/conversations/conversations.d.ts +402 -351
- package/resources/support/conversations/conversations.d.ts.map +1 -1
- package/resources/support/conversations/conversations.js +340 -295
- package/resources/support/conversations/conversations.js.map +1 -1
- package/resources/support/conversations/conversations.mjs +340 -295
- package/resources/support/conversations/conversations.mjs.map +1 -1
- package/resources/support/conversations/index.d.mts +1 -1
- package/resources/support/conversations/index.d.mts.map +1 -1
- package/resources/support/conversations/index.d.ts +1 -1
- package/resources/support/conversations/index.d.ts.map +1 -1
- package/resources/support/conversations/participants.d.mts +2 -2
- package/resources/support/conversations/participants.d.mts.map +1 -1
- package/resources/support/conversations/participants.d.ts +2 -2
- package/resources/support/conversations/participants.d.ts.map +1 -1
- package/resources/support/index.d.mts +3 -3
- package/resources/support/index.d.mts.map +1 -1
- package/resources/support/index.d.ts +3 -3
- package/resources/support/index.d.ts.map +1 -1
- package/resources/support/support.d.mts +3 -3
- package/resources/support/support.d.mts.map +1 -1
- package/resources/support/support.d.ts +3 -3
- package/resources/support/support.d.ts.map +1 -1
- package/resources/support/tickets/categories.d.mts +20 -20
- package/resources/support/tickets/categories.d.mts.map +1 -1
- package/resources/support/tickets/categories.d.ts +20 -20
- package/resources/support/tickets/categories.d.ts.map +1 -1
- package/resources/support/tickets/categories.js +25 -25
- package/resources/support/tickets/categories.js.map +1 -1
- package/resources/support/tickets/categories.mjs +25 -25
- package/resources/support/tickets/categories.mjs.map +1 -1
- package/resources/support/tickets/custom-fields.d.mts +22 -22
- package/resources/support/tickets/custom-fields.d.mts.map +1 -1
- package/resources/support/tickets/custom-fields.d.ts +22 -22
- package/resources/support/tickets/custom-fields.d.ts.map +1 -1
- package/resources/support/tickets/custom-fields.js +19 -19
- package/resources/support/tickets/custom-fields.js.map +1 -1
- package/resources/support/tickets/custom-fields.mjs +19 -19
- package/resources/support/tickets/custom-fields.mjs.map +1 -1
- package/resources/support/tickets/index.d.mts +4 -4
- package/resources/support/tickets/index.d.mts.map +1 -1
- package/resources/support/tickets/index.d.ts +4 -4
- package/resources/support/tickets/index.d.ts.map +1 -1
- package/resources/support/tickets/statuses.d.mts +19 -19
- package/resources/support/tickets/statuses.d.mts.map +1 -1
- package/resources/support/tickets/statuses.d.ts +19 -19
- package/resources/support/tickets/statuses.d.ts.map +1 -1
- package/resources/support/tickets/statuses.js +21 -21
- package/resources/support/tickets/statuses.js.map +1 -1
- package/resources/support/tickets/statuses.mjs +21 -21
- package/resources/support/tickets/statuses.mjs.map +1 -1
- package/resources/support/tickets/tickets.d.mts +75 -75
- package/resources/support/tickets/tickets.d.mts.map +1 -1
- package/resources/support/tickets/tickets.d.ts +75 -75
- package/resources/support/tickets/tickets.d.ts.map +1 -1
- package/resources/support/tickets/tickets.js +44 -44
- package/resources/support/tickets/tickets.js.map +1 -1
- package/resources/support/tickets/tickets.mjs +44 -44
- package/resources/support/tickets/tickets.mjs.map +1 -1
- package/resources/surveys.d.mts +43 -43
- package/resources/surveys.d.mts.map +1 -1
- package/resources/surveys.d.ts +43 -43
- package/resources/surveys.d.ts.map +1 -1
- package/resources/surveys.js +44 -44
- package/resources/surveys.js.map +1 -1
- package/resources/surveys.mjs +44 -44
- package/resources/surveys.mjs.map +1 -1
- package/resources/users/companies/companies.d.mts +121 -130
- package/resources/users/companies/companies.d.mts.map +1 -1
- package/resources/users/companies/companies.d.ts +121 -130
- package/resources/users/companies/companies.d.ts.map +1 -1
- package/resources/users/companies/companies.js +125 -125
- package/resources/users/companies/companies.js.map +1 -1
- package/resources/users/companies/companies.mjs +125 -125
- package/resources/users/companies/companies.mjs.map +1 -1
- package/resources/users/companies/contacts.d.mts +3 -3
- package/resources/users/companies/contacts.d.mts.map +1 -1
- package/resources/users/companies/contacts.d.ts +3 -3
- package/resources/users/companies/contacts.d.ts.map +1 -1
- package/resources/users/companies/index.d.mts +1 -1
- package/resources/users/companies/index.d.mts.map +1 -1
- package/resources/users/companies/index.d.ts +1 -1
- package/resources/users/companies/index.d.ts.map +1 -1
- package/resources/users/contacts/by-user-id/by-user-id.d.mts +2 -2
- package/resources/users/contacts/by-user-id/by-user-id.d.mts.map +1 -1
- package/resources/users/contacts/by-user-id/by-user-id.d.ts +2 -2
- package/resources/users/contacts/by-user-id/by-user-id.d.ts.map +1 -1
- package/resources/users/contacts/by-user-id/email-preferences.d.mts +2 -2
- package/resources/users/contacts/by-user-id/email-preferences.d.mts.map +1 -1
- package/resources/users/contacts/by-user-id/email-preferences.d.ts +2 -2
- package/resources/users/contacts/by-user-id/email-preferences.d.ts.map +1 -1
- package/resources/users/contacts/contacts.d.mts +249 -235
- package/resources/users/contacts/contacts.d.mts.map +1 -1
- package/resources/users/contacts/contacts.d.ts +249 -235
- package/resources/users/contacts/contacts.d.ts.map +1 -1
- package/resources/users/contacts/contacts.js +211 -184
- package/resources/users/contacts/contacts.js.map +1 -1
- package/resources/users/contacts/contacts.mjs +211 -184
- package/resources/users/contacts/contacts.mjs.map +1 -1
- package/resources/users/contacts/email-preferences.d.mts +2 -2
- package/resources/users/contacts/email-preferences.d.mts.map +1 -1
- package/resources/users/contacts/email-preferences.d.ts +2 -2
- package/resources/users/contacts/email-preferences.d.ts.map +1 -1
- package/resources/users/contacts/index.d.mts +1 -1
- package/resources/users/contacts/index.d.mts.map +1 -1
- package/resources/users/contacts/index.d.ts +1 -1
- package/resources/users/contacts/index.d.ts.map +1 -1
- package/resources/users/index.d.mts +2 -2
- package/resources/users/index.d.mts.map +1 -1
- package/resources/users/index.d.ts +2 -2
- package/resources/users/index.d.ts.map +1 -1
- package/resources/users/users.d.mts +2 -2
- package/resources/users/users.d.mts.map +1 -1
- package/resources/users/users.d.ts +2 -2
- package/resources/users/users.d.ts.map +1 -1
- package/resources/webhooks.d.mts +83 -83
- package/resources/webhooks.d.mts.map +1 -1
- package/resources/webhooks.d.ts +83 -83
- package/resources/webhooks.d.ts.map +1 -1
- package/resources/webhooks.js +77 -77
- package/resources/webhooks.js.map +1 -1
- package/resources/webhooks.mjs +77 -77
- package/resources/webhooks.mjs.map +1 -1
- package/src/client.ts +6 -6
- package/src/resources/audit-logs.ts +7 -1
- package/src/resources/changelogs/changelogs.ts +320 -175
- package/src/resources/changelogs/index.ts +1 -1
- package/src/resources/changelogs/subscribers.ts +31 -2
- package/src/resources/conversation-attributes.ts +34 -34
- package/src/resources/feedback/boards.ts +30 -30
- package/src/resources/feedback/comments.ts +137 -137
- package/src/resources/feedback/custom-fields.ts +46 -46
- package/src/resources/feedback/feedback.ts +9 -5
- package/src/resources/feedback/index.ts +7 -5
- package/src/resources/feedback/post-statuses.ts +33 -33
- package/src/resources/feedback/posts/index.ts +3 -1
- package/src/resources/feedback/posts/posts.ts +232 -128
- package/src/resources/feedback/posts/voters.ts +3 -3
- package/src/resources/help-center/articles.ts +631 -109
- package/src/resources/help-center/collections.ts +349 -88
- package/src/resources/help-center/help-center.ts +5 -5
- package/src/resources/help-center/help-centers.ts +202 -57
- package/src/resources/help-center/index.ts +5 -5
- package/src/resources/help-center/redirect-rules.ts +294 -178
- package/src/resources/index.ts +6 -6
- package/src/resources/organization/admins.ts +36 -36
- package/src/resources/organization/brands.ts +68 -68
- package/src/resources/organization/index.ts +3 -3
- package/src/resources/organization/organization.ts +3 -3
- package/src/resources/organization/teams.ts +54 -54
- package/src/resources/reports.ts +454 -232
- package/src/resources/support/conversation-tags.ts +62 -62
- package/src/resources/support/conversations/conversations.ts +489 -438
- package/src/resources/support/conversations/index.ts +4 -4
- package/src/resources/support/conversations/participants.ts +2 -2
- package/src/resources/support/index.ts +7 -7
- package/src/resources/support/support.ts +7 -7
- package/src/resources/support/tickets/categories.ts +35 -35
- package/src/resources/support/tickets/custom-fields.ts +29 -29
- package/src/resources/support/tickets/index.ts +4 -4
- package/src/resources/support/tickets/statuses.ts +31 -31
- package/src/resources/support/tickets/tickets.ts +101 -101
- package/src/resources/surveys.ts +60 -60
- package/src/resources/users/companies/companies.ts +158 -172
- package/src/resources/users/companies/contacts.ts +3 -3
- package/src/resources/users/companies/index.ts +2 -2
- package/src/resources/users/contacts/by-user-id/by-user-id.ts +2 -2
- package/src/resources/users/contacts/by-user-id/email-preferences.ts +2 -2
- package/src/resources/users/contacts/contacts.ts +284 -280
- package/src/resources/users/contacts/email-preferences.ts +2 -2
- package/src/resources/users/contacts/index.ts +3 -3
- package/src/resources/users/index.ts +5 -5
- package/src/resources/users/users.ts +5 -5
- package/src/resources/webhooks.ts +106 -100
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -36,27 +36,19 @@ export class Contacts extends APIResource {
|
|
|
36
36
|
);
|
|
37
37
|
|
|
38
38
|
/**
|
|
39
|
-
*
|
|
40
|
-
* cursor-based pagination.
|
|
41
|
-
*
|
|
42
|
-
* ### Query Parameters
|
|
43
|
-
*
|
|
44
|
-
* - `limit` - Number of contacts to return (1-100, default 10)
|
|
45
|
-
* - `cursor` - Cursor from previous response for pagination
|
|
46
|
-
* - `contactType` - Filter by contact type: "customer" (default), "lead", or "all"
|
|
39
|
+
* Retrieves a single contact by their Featurebase ID.
|
|
47
40
|
*
|
|
48
|
-
*
|
|
41
|
+
* Returns both customers and leads.
|
|
49
42
|
*
|
|
50
|
-
*
|
|
43
|
+
* ### Path Parameters
|
|
51
44
|
*
|
|
52
|
-
* - `
|
|
53
|
-
* - `data` - Array of contact objects
|
|
54
|
-
* - `nextCursor` - Cursor for the next page, or null if no more results
|
|
45
|
+
* - `id` - The Featurebase contact ID (24-character ObjectId)
|
|
55
46
|
*
|
|
56
|
-
* ###
|
|
47
|
+
* ### Response Format
|
|
57
48
|
*
|
|
58
|
-
*
|
|
49
|
+
* Returns a single contact object with:
|
|
59
50
|
*
|
|
51
|
+
* - `object` - Always "contact"
|
|
60
52
|
* - `id` - Unique contact identifier
|
|
61
53
|
* - `userId` - External user ID from SSO (if set)
|
|
62
54
|
* - `email` - Contact email address
|
|
@@ -73,133 +65,11 @@ export class Contacts extends APIResource {
|
|
|
73
65
|
*
|
|
74
66
|
* ```json
|
|
75
67
|
* {
|
|
76
|
-
* "object": "list",
|
|
77
|
-
* "data": [
|
|
78
|
-
* {
|
|
79
|
-
* "object": "contact",
|
|
80
|
-
* "id": "676f0f6765bdaa7d7d760f88",
|
|
81
|
-
* "email": "john@example.com",
|
|
82
|
-
* "name": "John Doe",
|
|
83
|
-
* "type": "customer",
|
|
84
|
-
* ...
|
|
85
|
-
* }
|
|
86
|
-
* ],
|
|
87
|
-
* "nextCursor": "eyJpZCI6IjUwN2YxZjc3YmNmODZjZDc5OTQzOTAxMSJ9"
|
|
88
|
-
* }
|
|
89
|
-
* ```
|
|
90
|
-
*
|
|
91
|
-
* ### Version Availability
|
|
92
|
-
*
|
|
93
|
-
* This endpoint is only available in API version 2026-01-01.nova and newer.
|
|
94
|
-
*
|
|
95
|
-
* @example
|
|
96
|
-
* ```ts
|
|
97
|
-
* // Automatically fetches more pages as needed.
|
|
98
|
-
* for await (const contact of client.users.contacts.list()) {
|
|
99
|
-
* // ...
|
|
100
|
-
* }
|
|
101
|
-
* ```
|
|
102
|
-
*/
|
|
103
|
-
list(
|
|
104
|
-
params: ContactListParams | null | undefined = {},
|
|
105
|
-
options?: RequestOptions,
|
|
106
|
-
): PagePromise<ContactListDataCursorPage, ContactList.Data> {
|
|
107
|
-
const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
|
|
108
|
-
return this._client.getAPIList('/v2/contacts', CursorPage<ContactList.Data>, {
|
|
109
|
-
query,
|
|
110
|
-
...options,
|
|
111
|
-
headers: buildHeaders([
|
|
112
|
-
{
|
|
113
|
-
...(featurebaseVersion?.toString() != null ?
|
|
114
|
-
{ 'Featurebase-Version': featurebaseVersion?.toString() }
|
|
115
|
-
: undefined),
|
|
116
|
-
},
|
|
117
|
-
options?.headers,
|
|
118
|
-
]),
|
|
119
|
-
});
|
|
120
|
-
}
|
|
121
|
-
|
|
122
|
-
/**
|
|
123
|
-
* Creates a new contact or updates an existing one.
|
|
124
|
-
*
|
|
125
|
-
* If a contact with the given `email` or `userId` already exists, it will be
|
|
126
|
-
* updated. Otherwise, a new contact will be created.
|
|
127
|
-
*
|
|
128
|
-
* **At least one of `email` or `userId` must be provided for identification.**
|
|
129
|
-
*
|
|
130
|
-
* ### Request Body
|
|
131
|
-
*
|
|
132
|
-
* | Field | Type | Required | Description |
|
|
133
|
-
* | ----------------------- | ------- | ------------------- | --------------------------------------- |
|
|
134
|
-
* | `email` | string | One of email/userId | Contact email address |
|
|
135
|
-
* | `userId` | string | One of email/userId | External user ID from your system |
|
|
136
|
-
* | `name` | string | No | Contact display name |
|
|
137
|
-
* | `profilePicture` | string | No | Profile picture URL |
|
|
138
|
-
* | `companies` | array | No | Companies the contact belongs to |
|
|
139
|
-
* | `customFields` | object | No | Custom field values |
|
|
140
|
-
* | `subscribedToChangelog` | boolean | No | Whether subscribed to changelog |
|
|
141
|
-
* | `locale` | string | No | Contact locale/language |
|
|
142
|
-
* | `phone` | string | No | Contact phone number |
|
|
143
|
-
* | `roles` | array | No | Role (User Tag) names to assign |
|
|
144
|
-
* | `userHash` | string | No | HMAC hash for identity verification |
|
|
145
|
-
* | `createdAt` | string | No | When the contact was created (ISO 8601) |
|
|
146
|
-
*
|
|
147
|
-
* ### Company Object
|
|
148
|
-
*
|
|
149
|
-
* Each company in the `companies` array can have:
|
|
150
|
-
*
|
|
151
|
-
* - `id` (required) - External company ID from your system
|
|
152
|
-
* - `name` (required) - Company name
|
|
153
|
-
* - `monthlySpend` - Monthly spend/revenue
|
|
154
|
-
* - `customFields` - Custom field values
|
|
155
|
-
* - `industry` - Industry
|
|
156
|
-
* - `website` - Company website URL
|
|
157
|
-
* - `plan` - Current plan/subscription
|
|
158
|
-
* - `companySize` - Number of employees
|
|
159
|
-
* - `createdAt` - When the company was created
|
|
160
|
-
*
|
|
161
|
-
* ### Response
|
|
162
|
-
*
|
|
163
|
-
* Returns the created or updated contact object.
|
|
164
|
-
*
|
|
165
|
-
* - **201 Created** - A new contact was created
|
|
166
|
-
* - **200 OK** - An existing contact was updated
|
|
167
|
-
*
|
|
168
|
-
* ### Example Request
|
|
169
|
-
*
|
|
170
|
-
* ```json
|
|
171
|
-
* {
|
|
172
|
-
* "email": "john@example.com",
|
|
173
|
-
* "name": "John Doe",
|
|
174
|
-
* "userId": "usr_12345",
|
|
175
|
-
* "companies": [
|
|
176
|
-
* {
|
|
177
|
-
* "id": "company_123",
|
|
178
|
-
* "name": "Acme Inc",
|
|
179
|
-
* "monthlySpend": 500,
|
|
180
|
-
* "plan": "enterprise"
|
|
181
|
-
* }
|
|
182
|
-
* ],
|
|
183
|
-
* "customFields": {
|
|
184
|
-
* "plan": "pro",
|
|
185
|
-
* "signupSource": "website"
|
|
186
|
-
* },
|
|
187
|
-
* "subscribedToChangelog": true
|
|
188
|
-
* }
|
|
189
|
-
* ```
|
|
190
|
-
*
|
|
191
|
-
* ### Example Response
|
|
192
|
-
*
|
|
193
|
-
* ```json
|
|
194
|
-
* {
|
|
195
68
|
* "object": "contact",
|
|
196
69
|
* "id": "676f0f6765bdaa7d7d760f88",
|
|
197
70
|
* "email": "john@example.com",
|
|
198
71
|
* "name": "John Doe",
|
|
199
|
-
* "userId": "usr_12345",
|
|
200
72
|
* "type": "customer",
|
|
201
|
-
* "companies": [...],
|
|
202
|
-
* "customFields": {...},
|
|
203
73
|
* ...
|
|
204
74
|
* }
|
|
205
75
|
* ```
|
|
@@ -210,17 +80,18 @@ export class Contacts extends APIResource {
|
|
|
210
80
|
*
|
|
211
81
|
* @example
|
|
212
82
|
* ```ts
|
|
213
|
-
* const
|
|
214
|
-
*
|
|
83
|
+
* const contact = await client.users.contacts.retrieve(
|
|
84
|
+
* '507f1f77bcf86cd799439011',
|
|
85
|
+
* );
|
|
215
86
|
* ```
|
|
216
87
|
*/
|
|
217
|
-
|
|
218
|
-
|
|
88
|
+
retrieve(
|
|
89
|
+
id: string,
|
|
90
|
+
params: ContactRetrieveParams | null | undefined = {},
|
|
219
91
|
options?: RequestOptions,
|
|
220
|
-
): APIPromise<
|
|
221
|
-
const { 'Featurebase-Version': featurebaseVersion
|
|
222
|
-
return this._client.
|
|
223
|
-
body,
|
|
92
|
+
): APIPromise<ContactRetrieveResponse> {
|
|
93
|
+
const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
|
|
94
|
+
return this._client.get(path`/v2/contacts/${id}`, {
|
|
224
95
|
...options,
|
|
225
96
|
headers: buildHeaders([
|
|
226
97
|
{
|
|
@@ -234,19 +105,27 @@ export class Contacts extends APIResource {
|
|
|
234
105
|
}
|
|
235
106
|
|
|
236
107
|
/**
|
|
237
|
-
*
|
|
238
|
-
*
|
|
239
|
-
* Returns both customers and leads.
|
|
108
|
+
* Returns a list of contacts (customers and leads) in your organization using
|
|
109
|
+
* cursor-based pagination.
|
|
240
110
|
*
|
|
241
|
-
* ###
|
|
111
|
+
* ### Query Parameters
|
|
242
112
|
*
|
|
243
|
-
* - `
|
|
113
|
+
* - `limit` - Number of contacts to return (1-100, default 10)
|
|
114
|
+
* - `cursor` - Cursor from previous response for pagination
|
|
115
|
+
* - `contactType` - Filter by contact type: "customer" (default), "lead", or "all"
|
|
244
116
|
*
|
|
245
117
|
* ### Response Format
|
|
246
118
|
*
|
|
247
|
-
* Returns a
|
|
119
|
+
* Returns a list object with:
|
|
120
|
+
*
|
|
121
|
+
* - `object` - Always "list"
|
|
122
|
+
* - `data` - Array of contact objects
|
|
123
|
+
* - `nextCursor` - Cursor for the next page, or null if no more results
|
|
124
|
+
*
|
|
125
|
+
* ### Contact Object
|
|
126
|
+
*
|
|
127
|
+
* Each contact includes:
|
|
248
128
|
*
|
|
249
|
-
* - `object` - Always "contact"
|
|
250
129
|
* - `id` - Unique contact identifier
|
|
251
130
|
* - `userId` - External user ID from SSO (if set)
|
|
252
131
|
* - `email` - Contact email address
|
|
@@ -263,12 +142,18 @@ export class Contacts extends APIResource {
|
|
|
263
142
|
*
|
|
264
143
|
* ```json
|
|
265
144
|
* {
|
|
266
|
-
* "object": "
|
|
267
|
-
* "
|
|
268
|
-
*
|
|
269
|
-
*
|
|
270
|
-
*
|
|
271
|
-
*
|
|
145
|
+
* "object": "list",
|
|
146
|
+
* "data": [
|
|
147
|
+
* {
|
|
148
|
+
* "object": "contact",
|
|
149
|
+
* "id": "676f0f6765bdaa7d7d760f88",
|
|
150
|
+
* "email": "john@example.com",
|
|
151
|
+
* "name": "John Doe",
|
|
152
|
+
* "type": "customer",
|
|
153
|
+
* ...
|
|
154
|
+
* }
|
|
155
|
+
* ],
|
|
156
|
+
* "nextCursor": "eyJpZCI6IjUwN2YxZjc3YmNmODZjZDc5OTQzOTAxMSJ9"
|
|
272
157
|
* }
|
|
273
158
|
* ```
|
|
274
159
|
*
|
|
@@ -278,18 +163,19 @@ export class Contacts extends APIResource {
|
|
|
278
163
|
*
|
|
279
164
|
* @example
|
|
280
165
|
* ```ts
|
|
281
|
-
*
|
|
282
|
-
*
|
|
283
|
-
*
|
|
166
|
+
* // Automatically fetches more pages as needed.
|
|
167
|
+
* for await (const contact of client.users.contacts.list()) {
|
|
168
|
+
* // ...
|
|
169
|
+
* }
|
|
284
170
|
* ```
|
|
285
171
|
*/
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
params: ContactRetrieveParams | null | undefined = {},
|
|
172
|
+
list(
|
|
173
|
+
params: ContactListParams | null | undefined = {},
|
|
289
174
|
options?: RequestOptions,
|
|
290
|
-
):
|
|
291
|
-
const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
|
|
292
|
-
return this._client.
|
|
175
|
+
): PagePromise<ContactListDataCursorPage, ContactList.Data> {
|
|
176
|
+
const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
|
|
177
|
+
return this._client.getAPIList('/v2/contacts', CursorPage<ContactList.Data>, {
|
|
178
|
+
query,
|
|
293
179
|
...options,
|
|
294
180
|
headers: buildHeaders([
|
|
295
181
|
{
|
|
@@ -442,63 +328,134 @@ export class Contacts extends APIResource {
|
|
|
442
328
|
}
|
|
443
329
|
|
|
444
330
|
/**
|
|
445
|
-
*
|
|
446
|
-
*
|
|
447
|
-
* ### Path Parameters
|
|
331
|
+
* Creates a new contact or updates an existing one.
|
|
448
332
|
*
|
|
449
|
-
*
|
|
333
|
+
* If a contact with the given `email` or `userId` already exists, it will be
|
|
334
|
+
* updated. Otherwise, a new contact will be created.
|
|
450
335
|
*
|
|
451
|
-
*
|
|
336
|
+
* **At least one of `email` or `userId` must be provided for identification.**
|
|
452
337
|
*
|
|
453
|
-
*
|
|
338
|
+
* ### Request Body
|
|
454
339
|
*
|
|
455
|
-
*
|
|
456
|
-
*
|
|
340
|
+
* | Field | Type | Required | Description |
|
|
341
|
+
* | ----------------------- | -------------- | ------------------- | ----------------------------------------------------------------------------- |
|
|
342
|
+
* | `email` | string or null | One of email/userId | Contact email address. Send `null` with `userId` to remove the current email. |
|
|
343
|
+
* | `userId` | string or null | One of email/userId | External user ID. Send `null` with `email` to remove it. |
|
|
344
|
+
* | `name` | string or null | No | Contact display name. `null` resets it to the system fallback. |
|
|
345
|
+
* | `profilePicture` | string or null | No | Profile picture URL. `null` removes it. |
|
|
346
|
+
* | `companies` | array | No | Replacement company list. `[]` removes all memberships. |
|
|
347
|
+
* | `customFields` | object | No | Values merge by key. A key with `null` is removed. |
|
|
348
|
+
* | `subscribedToChangelog` | boolean | No | Whether subscribed to changelog |
|
|
349
|
+
* | `locale` | string or null | No | Contact locale/language. `null` removes it. |
|
|
350
|
+
* | `phone` | string or null | No | Contact phone number. `null` removes it. |
|
|
351
|
+
* | `roles` | array | No | Replacement role list. `[]` removes all roles. |
|
|
352
|
+
* | `userHash` | string | No | HMAC hash for identity verification |
|
|
353
|
+
* | `createdAt` | string | No | When the contact was created (ISO 8601) |
|
|
354
|
+
*
|
|
355
|
+
* ### Orbit Field Update Semantics
|
|
356
|
+
*
|
|
357
|
+
* - Omit a field to keep its current value.
|
|
358
|
+
* - Send a non-null scalar value to add or replace that value.
|
|
359
|
+
* - Send `null` for `email`, `userId`, `name`, `profilePicture`, `phone`, or
|
|
360
|
+
* `locale` to clear or reset it.
|
|
361
|
+
* - A contact must keep at least one identifier. Removing `email` requires
|
|
362
|
+
* `userId`. Removing `userId` requires `email`.
|
|
363
|
+
* - Send an array to replace the stored list. Send `[]` to clear `companies` or
|
|
364
|
+
* `roles`.
|
|
365
|
+
* - `customFields` is merged by key. Omitted keys stay unchanged. A key with
|
|
366
|
+
* `null` is removed.
|
|
367
|
+
* - `createdAt` and `subscribedToChangelog` do not accept `null`. Use `false` to
|
|
368
|
+
* turn off changelog subscription.
|
|
369
|
+
* - Empty strings are not deletion values for typed contact fields.
|
|
457
370
|
*
|
|
458
|
-
* ###
|
|
371
|
+
* ### Company Object
|
|
459
372
|
*
|
|
460
|
-
*
|
|
373
|
+
* Each company in the `companies` array can have:
|
|
461
374
|
*
|
|
462
|
-
* -
|
|
463
|
-
* -
|
|
464
|
-
* -
|
|
375
|
+
* - `id` (required) - External company ID from your system
|
|
376
|
+
* - `name` (required) - Company name
|
|
377
|
+
* - `monthlySpend` - Monthly spend/revenue
|
|
378
|
+
* - `customFields` - Custom field values
|
|
379
|
+
* - `industry` - Industry
|
|
380
|
+
* - `website` - Company website URL
|
|
381
|
+
* - `plan` - Current plan/subscription
|
|
382
|
+
* - `companySize` - Number of employees
|
|
383
|
+
* - `createdAt` - When the company was created
|
|
465
384
|
*
|
|
466
385
|
* ### Response
|
|
467
386
|
*
|
|
468
|
-
* Returns
|
|
387
|
+
* Returns the created or updated contact object.
|
|
469
388
|
*
|
|
470
|
-
* -
|
|
471
|
-
* -
|
|
472
|
-
*
|
|
389
|
+
* - **201 Created** - A new contact was created
|
|
390
|
+
* - **200 OK** - An existing contact was updated
|
|
391
|
+
*
|
|
392
|
+
* ### Example Request
|
|
393
|
+
*
|
|
394
|
+
* ```json
|
|
395
|
+
* {
|
|
396
|
+
* "email": "john@example.com",
|
|
397
|
+
* "name": "John Doe",
|
|
398
|
+
* "userId": "usr_12345",
|
|
399
|
+
* "companies": [
|
|
400
|
+
* {
|
|
401
|
+
* "id": "company_123",
|
|
402
|
+
* "name": "Acme Inc",
|
|
403
|
+
* "monthlySpend": 500,
|
|
404
|
+
* "plan": "enterprise"
|
|
405
|
+
* }
|
|
406
|
+
* ],
|
|
407
|
+
* "customFields": {
|
|
408
|
+
* "plan": "pro",
|
|
409
|
+
* "signupSource": "website"
|
|
410
|
+
* },
|
|
411
|
+
* "subscribedToChangelog": true
|
|
412
|
+
* }
|
|
413
|
+
* ```
|
|
414
|
+
*
|
|
415
|
+
* ### Example: Remove an Email
|
|
416
|
+
*
|
|
417
|
+
* ```json
|
|
418
|
+
* {
|
|
419
|
+
* "userId": "usr_12345",
|
|
420
|
+
* "email": null
|
|
421
|
+
* }
|
|
422
|
+
* ```
|
|
473
423
|
*
|
|
474
424
|
* ### Example Response
|
|
475
425
|
*
|
|
476
426
|
* ```json
|
|
477
427
|
* {
|
|
478
|
-
* "id": "507f1f77bcf86cd799439011",
|
|
479
428
|
* "object": "contact",
|
|
480
|
-
* "
|
|
429
|
+
* "id": "676f0f6765bdaa7d7d760f88",
|
|
430
|
+
* "email": "john@example.com",
|
|
431
|
+
* "name": "John Doe",
|
|
432
|
+
* "userId": "usr_12345",
|
|
433
|
+
* "type": "customer",
|
|
434
|
+
* "companies": [...],
|
|
435
|
+
* "customFields": {...},
|
|
436
|
+
* ...
|
|
481
437
|
* }
|
|
482
438
|
* ```
|
|
483
439
|
*
|
|
484
440
|
* ### Version Availability
|
|
485
441
|
*
|
|
486
|
-
* This endpoint is
|
|
442
|
+
* This endpoint is available in API version 2026-01-01.nova and newer. The Orbit
|
|
443
|
+
* field update rules, including null removal and empty-array replacement, require
|
|
444
|
+
* API version 2026-08-19.orbit or newer.
|
|
487
445
|
*
|
|
488
446
|
* @example
|
|
489
447
|
* ```ts
|
|
490
|
-
* const response =
|
|
491
|
-
*
|
|
492
|
-
* );
|
|
448
|
+
* const response =
|
|
449
|
+
* await client.users.contacts.createOrUpdate();
|
|
493
450
|
* ```
|
|
494
451
|
*/
|
|
495
|
-
|
|
496
|
-
|
|
497
|
-
params: ContactUnblockParams | null | undefined = {},
|
|
452
|
+
createOrUpdate(
|
|
453
|
+
params: ContactCreateOrUpdateParams,
|
|
498
454
|
options?: RequestOptions,
|
|
499
|
-
): APIPromise<
|
|
500
|
-
const { 'Featurebase-Version': featurebaseVersion } = params
|
|
501
|
-
return this._client.post(
|
|
455
|
+
): APIPromise<ContactCreateOrUpdateResponse> {
|
|
456
|
+
const { 'Featurebase-Version': featurebaseVersion, ...body } = params;
|
|
457
|
+
return this._client.post('/v2/contacts', {
|
|
458
|
+
body,
|
|
502
459
|
...options,
|
|
503
460
|
headers: buildHeaders([
|
|
504
461
|
{
|
|
@@ -620,6 +577,76 @@ export class Contacts extends APIResource {
|
|
|
620
577
|
]),
|
|
621
578
|
});
|
|
622
579
|
}
|
|
580
|
+
|
|
581
|
+
/**
|
|
582
|
+
* Unblocks a contact by their Featurebase ID from the global moderation system.
|
|
583
|
+
*
|
|
584
|
+
* ### Path Parameters
|
|
585
|
+
*
|
|
586
|
+
* - `id` - The Featurebase internal ID of the contact (MongoDB ObjectId)
|
|
587
|
+
*
|
|
588
|
+
* ### Supported Contact Types
|
|
589
|
+
*
|
|
590
|
+
* This endpoint unblocks both:
|
|
591
|
+
*
|
|
592
|
+
* - **Customers** - Users with registered accounts
|
|
593
|
+
* - **Leads** - Anonymous or unregistered visitors
|
|
594
|
+
*
|
|
595
|
+
* ### Unblocking Behavior
|
|
596
|
+
*
|
|
597
|
+
* When a contact is unblocked:
|
|
598
|
+
*
|
|
599
|
+
* - The contact can resume sending messages via messenger
|
|
600
|
+
* - Previously blocked conversations remain intact
|
|
601
|
+
* - The contact regains full messenger functionality
|
|
602
|
+
*
|
|
603
|
+
* ### Response
|
|
604
|
+
*
|
|
605
|
+
* Returns an unblock confirmation object:
|
|
606
|
+
*
|
|
607
|
+
* - `id` - The ID of the unblocked contact
|
|
608
|
+
* - `object` - Always "contact"
|
|
609
|
+
* - `unblocked` - Always `true`
|
|
610
|
+
*
|
|
611
|
+
* ### Example Response
|
|
612
|
+
*
|
|
613
|
+
* ```json
|
|
614
|
+
* {
|
|
615
|
+
* "id": "507f1f77bcf86cd799439011",
|
|
616
|
+
* "object": "contact",
|
|
617
|
+
* "unblocked": true
|
|
618
|
+
* }
|
|
619
|
+
* ```
|
|
620
|
+
*
|
|
621
|
+
* ### Version Availability
|
|
622
|
+
*
|
|
623
|
+
* This endpoint is only available in API version 2026-01-01.nova and newer.
|
|
624
|
+
*
|
|
625
|
+
* @example
|
|
626
|
+
* ```ts
|
|
627
|
+
* const response = await client.users.contacts.unblock(
|
|
628
|
+
* '507f1f77bcf86cd799439011',
|
|
629
|
+
* );
|
|
630
|
+
* ```
|
|
631
|
+
*/
|
|
632
|
+
unblock(
|
|
633
|
+
id: string,
|
|
634
|
+
params: ContactUnblockParams | null | undefined = {},
|
|
635
|
+
options?: RequestOptions,
|
|
636
|
+
): APIPromise<ContactUnblockResponse> {
|
|
637
|
+
const { 'Featurebase-Version': featurebaseVersion } = params ?? {};
|
|
638
|
+
return this._client.post(path`/v2/contacts/${id}/unblock`, {
|
|
639
|
+
...options,
|
|
640
|
+
headers: buildHeaders([
|
|
641
|
+
{
|
|
642
|
+
...(featurebaseVersion?.toString() != null ?
|
|
643
|
+
{ 'Featurebase-Version': featurebaseVersion?.toString() }
|
|
644
|
+
: undefined),
|
|
645
|
+
},
|
|
646
|
+
options?.headers,
|
|
647
|
+
]),
|
|
648
|
+
});
|
|
649
|
+
}
|
|
623
650
|
}
|
|
624
651
|
|
|
625
652
|
export type ContactListDataCursorPage = CursorPage<ContactList.Data>;
|
|
@@ -937,6 +964,14 @@ export interface ContactUnblockResponse {
|
|
|
937
964
|
unblocked: true;
|
|
938
965
|
}
|
|
939
966
|
|
|
967
|
+
export interface ContactRetrieveParams {
|
|
968
|
+
/**
|
|
969
|
+
* API version for this request. Defaults to your organization's configured API
|
|
970
|
+
* version if not specified.
|
|
971
|
+
*/
|
|
972
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
973
|
+
}
|
|
974
|
+
|
|
940
975
|
export interface ContactListParams extends CursorPageParams {
|
|
941
976
|
/**
|
|
942
977
|
* Query param: Filter contacts by type. Defaults to "customer".
|
|
@@ -947,54 +982,73 @@ export interface ContactListParams extends CursorPageParams {
|
|
|
947
982
|
* Header param: API version for this request. Defaults to your organization's
|
|
948
983
|
* configured API version if not specified.
|
|
949
984
|
*/
|
|
950
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
985
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
986
|
+
}
|
|
987
|
+
|
|
988
|
+
export interface ContactDeleteParams {
|
|
989
|
+
/**
|
|
990
|
+
* API version for this request. Defaults to your organization's configured API
|
|
991
|
+
* version if not specified.
|
|
992
|
+
*/
|
|
993
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
994
|
+
}
|
|
995
|
+
|
|
996
|
+
export interface ContactBlockParams {
|
|
997
|
+
/**
|
|
998
|
+
* API version for this request. Defaults to your organization's configured API
|
|
999
|
+
* version if not specified.
|
|
1000
|
+
*/
|
|
1001
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
951
1002
|
}
|
|
952
1003
|
|
|
953
1004
|
export interface ContactCreateOrUpdateParams {
|
|
954
1005
|
/**
|
|
955
|
-
* Body param:
|
|
1006
|
+
* Body param: Replacement list of companies. Pass an empty array to remove all
|
|
1007
|
+
* company memberships.
|
|
956
1008
|
*/
|
|
957
1009
|
companies?: Array<ContactCreateOrUpdateParams.Company>;
|
|
958
1010
|
|
|
959
1011
|
/**
|
|
960
|
-
* Body param: When the contact was created in your system (ISO 8601)
|
|
1012
|
+
* Body param: When the contact was created in your system (ISO 8601). This field
|
|
1013
|
+
* cannot be null.
|
|
961
1014
|
*/
|
|
962
|
-
createdAt?: string
|
|
1015
|
+
createdAt?: string;
|
|
963
1016
|
|
|
964
1017
|
/**
|
|
965
|
-
* Body param:
|
|
966
|
-
*
|
|
1018
|
+
* Body param: Fields are merged by key. Omitted keys are preserved. A null value
|
|
1019
|
+
* removes that custom field key.
|
|
967
1020
|
*/
|
|
968
|
-
customFields?:
|
|
1021
|
+
customFields?: { [key: string]: string | number | boolean | Array<string | number | boolean> | null };
|
|
969
1022
|
|
|
970
1023
|
/**
|
|
971
|
-
* Body param: Contact email address.
|
|
972
|
-
*
|
|
1024
|
+
* Body param: Contact email address. Omit to preserve it, or pass null with userId
|
|
1025
|
+
* to remove the stored email.
|
|
973
1026
|
*/
|
|
974
|
-
email?: string;
|
|
1027
|
+
email?: string | null;
|
|
975
1028
|
|
|
976
1029
|
/**
|
|
977
|
-
* Body param: Contact locale/language preference
|
|
1030
|
+
* Body param: Contact locale/language preference. Pass null to remove it.
|
|
978
1031
|
*/
|
|
979
|
-
locale?: string;
|
|
1032
|
+
locale?: string | null;
|
|
980
1033
|
|
|
981
1034
|
/**
|
|
982
|
-
* Body param: Contact display name
|
|
1035
|
+
* Body param: Contact display name. Pass null to reset it to the system fallback.
|
|
983
1036
|
*/
|
|
984
|
-
name?: string;
|
|
1037
|
+
name?: string | null;
|
|
985
1038
|
|
|
986
1039
|
/**
|
|
987
|
-
* Body param: Contact phone number
|
|
1040
|
+
* Body param: Contact phone number. Pass null to remove it.
|
|
988
1041
|
*/
|
|
989
1042
|
phone?: string | null;
|
|
990
1043
|
|
|
991
1044
|
/**
|
|
992
|
-
* Body param: Profile picture URL
|
|
1045
|
+
* Body param: Profile picture URL. Pass null to remove the stored profile picture.
|
|
993
1046
|
*/
|
|
994
1047
|
profilePicture?: string | null;
|
|
995
1048
|
|
|
996
1049
|
/**
|
|
997
|
-
* Body param:
|
|
1050
|
+
* Body param: Replacement list of role (User Tag) names. Pass an empty array to
|
|
1051
|
+
* remove all roles.
|
|
998
1052
|
*/
|
|
999
1053
|
roles?: Array<string>;
|
|
1000
1054
|
|
|
@@ -1009,16 +1063,16 @@ export interface ContactCreateOrUpdateParams {
|
|
|
1009
1063
|
userHash?: string;
|
|
1010
1064
|
|
|
1011
1065
|
/**
|
|
1012
|
-
* Body param: External user ID from your system.
|
|
1013
|
-
*
|
|
1066
|
+
* Body param: External user ID from your system. Pass null with email to remove
|
|
1067
|
+
* the stored user ID.
|
|
1014
1068
|
*/
|
|
1015
|
-
userId?: string;
|
|
1069
|
+
userId?: string | null;
|
|
1016
1070
|
|
|
1017
1071
|
/**
|
|
1018
1072
|
* Header param: API version for this request. Defaults to your organization's
|
|
1019
1073
|
* configured API version if not specified.
|
|
1020
1074
|
*/
|
|
1021
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
1075
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
1022
1076
|
}
|
|
1023
1077
|
|
|
1024
1078
|
export namespace ContactCreateOrUpdateParams {
|
|
@@ -1052,7 +1106,7 @@ export namespace ContactCreateOrUpdateParams {
|
|
|
1052
1106
|
* Custom field values on the company. Values can be string, number, boolean, null,
|
|
1053
1107
|
* or array of primitives.
|
|
1054
1108
|
*/
|
|
1055
|
-
customFields?:
|
|
1109
|
+
customFields?: { [key: string]: string | number | boolean | Array<string | number | boolean> | null };
|
|
1056
1110
|
|
|
1057
1111
|
/**
|
|
1058
1112
|
* Industry the company operates in
|
|
@@ -1074,64 +1128,6 @@ export namespace ContactCreateOrUpdateParams {
|
|
|
1074
1128
|
*/
|
|
1075
1129
|
website?: string;
|
|
1076
1130
|
}
|
|
1077
|
-
|
|
1078
|
-
export namespace Company {
|
|
1079
|
-
/**
|
|
1080
|
-
* Custom field values on the company. Values can be string, number, boolean, null,
|
|
1081
|
-
* or array of primitives.
|
|
1082
|
-
*/
|
|
1083
|
-
export interface CustomFields {
|
|
1084
|
-
industry?: string;
|
|
1085
|
-
|
|
1086
|
-
plan?: string;
|
|
1087
|
-
|
|
1088
|
-
priority?: string;
|
|
1089
|
-
}
|
|
1090
|
-
}
|
|
1091
|
-
|
|
1092
|
-
/**
|
|
1093
|
-
* Custom field values on the contact. Values can be string, number, boolean, null,
|
|
1094
|
-
* or array of primitives.
|
|
1095
|
-
*/
|
|
1096
|
-
export interface CustomFields {
|
|
1097
|
-
accountType?: string;
|
|
1098
|
-
|
|
1099
|
-
plan?: string;
|
|
1100
|
-
|
|
1101
|
-
signupSource?: string;
|
|
1102
|
-
}
|
|
1103
|
-
}
|
|
1104
|
-
|
|
1105
|
-
export interface ContactRetrieveParams {
|
|
1106
|
-
/**
|
|
1107
|
-
* API version for this request. Defaults to your organization's configured API
|
|
1108
|
-
* version if not specified.
|
|
1109
|
-
*/
|
|
1110
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
1111
|
-
}
|
|
1112
|
-
|
|
1113
|
-
export interface ContactDeleteParams {
|
|
1114
|
-
/**
|
|
1115
|
-
* API version for this request. Defaults to your organization's configured API
|
|
1116
|
-
* version if not specified.
|
|
1117
|
-
*/
|
|
1118
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
1119
|
-
}
|
|
1120
|
-
|
|
1121
|
-
export interface ContactBlockParams {
|
|
1122
|
-
/**
|
|
1123
|
-
* API version for this request. Defaults to your organization's configured API
|
|
1124
|
-
* version if not specified.
|
|
1125
|
-
*/
|
|
1126
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
1127
|
-
}
|
|
1128
|
-
|
|
1129
|
-
export interface ContactUnblockParams {
|
|
1130
|
-
/**
|
|
1131
|
-
* API version for this request. Defaults to your organization's configured API
|
|
1132
|
-
* version if not specified.
|
|
1133
|
-
*/
|
|
1134
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
1135
1131
|
}
|
|
1136
1132
|
|
|
1137
1133
|
export interface ContactSearchParams {
|
|
@@ -1181,7 +1177,15 @@ export interface ContactSearchParams {
|
|
|
1181
1177
|
* Header param: API version for this request. Defaults to your organization's
|
|
1182
1178
|
* configured API version if not specified.
|
|
1183
1179
|
*/
|
|
1184
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
1180
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
1181
|
+
}
|
|
1182
|
+
|
|
1183
|
+
export interface ContactUnblockParams {
|
|
1184
|
+
/**
|
|
1185
|
+
* API version for this request. Defaults to your organization's configured API
|
|
1186
|
+
* version if not specified.
|
|
1187
|
+
*/
|
|
1188
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
1185
1189
|
}
|
|
1186
1190
|
|
|
1187
1191
|
Contacts.ByUserID = ByUserID;
|
|
@@ -1198,13 +1202,13 @@ export declare namespace Contacts {
|
|
|
1198
1202
|
type ContactSearchResponse as ContactSearchResponse,
|
|
1199
1203
|
type ContactUnblockResponse as ContactUnblockResponse,
|
|
1200
1204
|
type ContactListDataCursorPage as ContactListDataCursorPage,
|
|
1201
|
-
type ContactListParams as ContactListParams,
|
|
1202
|
-
type ContactCreateOrUpdateParams as ContactCreateOrUpdateParams,
|
|
1203
1205
|
type ContactRetrieveParams as ContactRetrieveParams,
|
|
1206
|
+
type ContactListParams as ContactListParams,
|
|
1204
1207
|
type ContactDeleteParams as ContactDeleteParams,
|
|
1205
1208
|
type ContactBlockParams as ContactBlockParams,
|
|
1206
|
-
type
|
|
1209
|
+
type ContactCreateOrUpdateParams as ContactCreateOrUpdateParams,
|
|
1207
1210
|
type ContactSearchParams as ContactSearchParams,
|
|
1211
|
+
type ContactUnblockParams as ContactUnblockParams,
|
|
1208
1212
|
};
|
|
1209
1213
|
|
|
1210
1214
|
export {
|