featurebase-node 0.14.3 → 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 +12 -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 +5 -5
- package/resources/feedback/feedback.d.mts.map +1 -1
- package/resources/feedback/feedback.d.ts +5 -5
- package/resources/feedback/feedback.d.ts.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/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/posts.d.mts +132 -132
- package/resources/feedback/posts/posts.d.mts.map +1 -1
- package/resources/feedback/posts/posts.d.ts +132 -132
- package/resources/feedback/posts/posts.d.ts.map +1 -1
- package/resources/feedback/posts/posts.js +107 -107
- package/resources/feedback/posts/posts.js.map +1 -1
- package/resources/feedback/posts/posts.mjs +107 -107
- 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 +249 -215
- package/resources/reports.d.mts.map +1 -1
- package/resources/reports.d.ts +249 -215
- package/resources/reports.d.ts.map +1 -1
- package/resources/reports.js +99 -99
- package/resources/reports.js.map +1 -1
- package/resources/reports.mjs +99 -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 +337 -327
- package/resources/support/conversations/conversations.d.mts.map +1 -1
- package/resources/support/conversations/conversations.d.ts +337 -327
- package/resources/support/conversations/conversations.d.ts.map +1 -1
- package/resources/support/conversations/conversations.js +293 -283
- package/resources/support/conversations/conversations.js.map +1 -1
- package/resources/support/conversations/conversations.mjs +293 -283
- 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 +6 -6
- package/src/resources/feedback/index.ts +6 -6
- package/src/resources/feedback/post-statuses.ts +33 -33
- package/src/resources/feedback/posts/index.ts +2 -2
- package/src/resources/feedback/posts/posts.ts +176 -176
- 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 +311 -262
- package/src/resources/support/conversation-tags.ts +62 -62
- package/src/resources/support/conversations/conversations.ts +429 -419
- 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
|
@@ -16,27 +16,19 @@ export declare class Contacts extends APIResource {
|
|
|
16
16
|
byUserID: ByUserIDAPI.ByUserID;
|
|
17
17
|
emailPreferences: EmailPreferencesAPI.EmailPreferences;
|
|
18
18
|
/**
|
|
19
|
-
*
|
|
20
|
-
* cursor-based pagination.
|
|
21
|
-
*
|
|
22
|
-
* ### Query Parameters
|
|
23
|
-
*
|
|
24
|
-
* - `limit` - Number of contacts to return (1-100, default 10)
|
|
25
|
-
* - `cursor` - Cursor from previous response for pagination
|
|
26
|
-
* - `contactType` - Filter by contact type: "customer" (default), "lead", or "all"
|
|
19
|
+
* Retrieves a single contact by their Featurebase ID.
|
|
27
20
|
*
|
|
28
|
-
*
|
|
21
|
+
* Returns both customers and leads.
|
|
29
22
|
*
|
|
30
|
-
*
|
|
23
|
+
* ### Path Parameters
|
|
31
24
|
*
|
|
32
|
-
* - `
|
|
33
|
-
* - `data` - Array of contact objects
|
|
34
|
-
* - `nextCursor` - Cursor for the next page, or null if no more results
|
|
25
|
+
* - `id` - The Featurebase contact ID (24-character ObjectId)
|
|
35
26
|
*
|
|
36
|
-
* ###
|
|
27
|
+
* ### Response Format
|
|
37
28
|
*
|
|
38
|
-
*
|
|
29
|
+
* Returns a single contact object with:
|
|
39
30
|
*
|
|
31
|
+
* - `object` - Always "contact"
|
|
40
32
|
* - `id` - Unique contact identifier
|
|
41
33
|
* - `userId` - External user ID from SSO (if set)
|
|
42
34
|
* - `email` - Contact email address
|
|
@@ -53,115 +45,11 @@ export declare class Contacts extends APIResource {
|
|
|
53
45
|
*
|
|
54
46
|
* ```json
|
|
55
47
|
* {
|
|
56
|
-
* "object": "list",
|
|
57
|
-
* "data": [
|
|
58
|
-
* {
|
|
59
|
-
* "object": "contact",
|
|
60
|
-
* "id": "676f0f6765bdaa7d7d760f88",
|
|
61
|
-
* "email": "john@example.com",
|
|
62
|
-
* "name": "John Doe",
|
|
63
|
-
* "type": "customer",
|
|
64
|
-
* ...
|
|
65
|
-
* }
|
|
66
|
-
* ],
|
|
67
|
-
* "nextCursor": "eyJpZCI6IjUwN2YxZjc3YmNmODZjZDc5OTQzOTAxMSJ9"
|
|
68
|
-
* }
|
|
69
|
-
* ```
|
|
70
|
-
*
|
|
71
|
-
* ### Version Availability
|
|
72
|
-
*
|
|
73
|
-
* This endpoint is only available in API version 2026-01-01.nova and newer.
|
|
74
|
-
*
|
|
75
|
-
* @example
|
|
76
|
-
* ```ts
|
|
77
|
-
* // Automatically fetches more pages as needed.
|
|
78
|
-
* for await (const contact of client.users.contacts.list()) {
|
|
79
|
-
* // ...
|
|
80
|
-
* }
|
|
81
|
-
* ```
|
|
82
|
-
*/
|
|
83
|
-
list(params?: ContactListParams | null | undefined, options?: RequestOptions): PagePromise<ContactListDataCursorPage, ContactList.Data>;
|
|
84
|
-
/**
|
|
85
|
-
* Creates a new contact or updates an existing one.
|
|
86
|
-
*
|
|
87
|
-
* If a contact with the given `email` or `userId` already exists, it will be
|
|
88
|
-
* updated. Otherwise, a new contact will be created.
|
|
89
|
-
*
|
|
90
|
-
* **At least one of `email` or `userId` must be provided for identification.**
|
|
91
|
-
*
|
|
92
|
-
* ### Request Body
|
|
93
|
-
*
|
|
94
|
-
* | Field | Type | Required | Description |
|
|
95
|
-
* | ----------------------- | ------- | ------------------- | --------------------------------------- |
|
|
96
|
-
* | `email` | string | One of email/userId | Contact email address |
|
|
97
|
-
* | `userId` | string | One of email/userId | External user ID from your system |
|
|
98
|
-
* | `name` | string | No | Contact display name |
|
|
99
|
-
* | `profilePicture` | string | No | Profile picture URL |
|
|
100
|
-
* | `companies` | array | No | Companies the contact belongs to |
|
|
101
|
-
* | `customFields` | object | No | Custom field values |
|
|
102
|
-
* | `subscribedToChangelog` | boolean | No | Whether subscribed to changelog |
|
|
103
|
-
* | `locale` | string | No | Contact locale/language |
|
|
104
|
-
* | `phone` | string | No | Contact phone number |
|
|
105
|
-
* | `roles` | array | No | Role (User Tag) names to assign |
|
|
106
|
-
* | `userHash` | string | No | HMAC hash for identity verification |
|
|
107
|
-
* | `createdAt` | string | No | When the contact was created (ISO 8601) |
|
|
108
|
-
*
|
|
109
|
-
* ### Company Object
|
|
110
|
-
*
|
|
111
|
-
* Each company in the `companies` array can have:
|
|
112
|
-
*
|
|
113
|
-
* - `id` (required) - External company ID from your system
|
|
114
|
-
* - `name` (required) - Company name
|
|
115
|
-
* - `monthlySpend` - Monthly spend/revenue
|
|
116
|
-
* - `customFields` - Custom field values
|
|
117
|
-
* - `industry` - Industry
|
|
118
|
-
* - `website` - Company website URL
|
|
119
|
-
* - `plan` - Current plan/subscription
|
|
120
|
-
* - `companySize` - Number of employees
|
|
121
|
-
* - `createdAt` - When the company was created
|
|
122
|
-
*
|
|
123
|
-
* ### Response
|
|
124
|
-
*
|
|
125
|
-
* Returns the created or updated contact object.
|
|
126
|
-
*
|
|
127
|
-
* - **201 Created** - A new contact was created
|
|
128
|
-
* - **200 OK** - An existing contact was updated
|
|
129
|
-
*
|
|
130
|
-
* ### Example Request
|
|
131
|
-
*
|
|
132
|
-
* ```json
|
|
133
|
-
* {
|
|
134
|
-
* "email": "john@example.com",
|
|
135
|
-
* "name": "John Doe",
|
|
136
|
-
* "userId": "usr_12345",
|
|
137
|
-
* "companies": [
|
|
138
|
-
* {
|
|
139
|
-
* "id": "company_123",
|
|
140
|
-
* "name": "Acme Inc",
|
|
141
|
-
* "monthlySpend": 500,
|
|
142
|
-
* "plan": "enterprise"
|
|
143
|
-
* }
|
|
144
|
-
* ],
|
|
145
|
-
* "customFields": {
|
|
146
|
-
* "plan": "pro",
|
|
147
|
-
* "signupSource": "website"
|
|
148
|
-
* },
|
|
149
|
-
* "subscribedToChangelog": true
|
|
150
|
-
* }
|
|
151
|
-
* ```
|
|
152
|
-
*
|
|
153
|
-
* ### Example Response
|
|
154
|
-
*
|
|
155
|
-
* ```json
|
|
156
|
-
* {
|
|
157
48
|
* "object": "contact",
|
|
158
49
|
* "id": "676f0f6765bdaa7d7d760f88",
|
|
159
50
|
* "email": "john@example.com",
|
|
160
51
|
* "name": "John Doe",
|
|
161
|
-
* "userId": "usr_12345",
|
|
162
52
|
* "type": "customer",
|
|
163
|
-
* "companies": [...],
|
|
164
|
-
* "customFields": {...},
|
|
165
53
|
* ...
|
|
166
54
|
* }
|
|
167
55
|
* ```
|
|
@@ -172,25 +60,34 @@ export declare class Contacts extends APIResource {
|
|
|
172
60
|
*
|
|
173
61
|
* @example
|
|
174
62
|
* ```ts
|
|
175
|
-
* const
|
|
176
|
-
*
|
|
63
|
+
* const contact = await client.users.contacts.retrieve(
|
|
64
|
+
* '507f1f77bcf86cd799439011',
|
|
65
|
+
* );
|
|
177
66
|
* ```
|
|
178
67
|
*/
|
|
179
|
-
|
|
68
|
+
retrieve(id: string, params?: ContactRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<ContactRetrieveResponse>;
|
|
180
69
|
/**
|
|
181
|
-
*
|
|
182
|
-
*
|
|
183
|
-
* Returns both customers and leads.
|
|
70
|
+
* Returns a list of contacts (customers and leads) in your organization using
|
|
71
|
+
* cursor-based pagination.
|
|
184
72
|
*
|
|
185
|
-
* ###
|
|
73
|
+
* ### Query Parameters
|
|
186
74
|
*
|
|
187
|
-
* - `
|
|
75
|
+
* - `limit` - Number of contacts to return (1-100, default 10)
|
|
76
|
+
* - `cursor` - Cursor from previous response for pagination
|
|
77
|
+
* - `contactType` - Filter by contact type: "customer" (default), "lead", or "all"
|
|
188
78
|
*
|
|
189
79
|
* ### Response Format
|
|
190
80
|
*
|
|
191
|
-
* Returns a
|
|
81
|
+
* Returns a list object with:
|
|
82
|
+
*
|
|
83
|
+
* - `object` - Always "list"
|
|
84
|
+
* - `data` - Array of contact objects
|
|
85
|
+
* - `nextCursor` - Cursor for the next page, or null if no more results
|
|
86
|
+
*
|
|
87
|
+
* ### Contact Object
|
|
88
|
+
*
|
|
89
|
+
* Each contact includes:
|
|
192
90
|
*
|
|
193
|
-
* - `object` - Always "contact"
|
|
194
91
|
* - `id` - Unique contact identifier
|
|
195
92
|
* - `userId` - External user ID from SSO (if set)
|
|
196
93
|
* - `email` - Contact email address
|
|
@@ -207,12 +104,18 @@ export declare class Contacts extends APIResource {
|
|
|
207
104
|
*
|
|
208
105
|
* ```json
|
|
209
106
|
* {
|
|
210
|
-
* "object": "
|
|
211
|
-
* "
|
|
212
|
-
*
|
|
213
|
-
*
|
|
214
|
-
*
|
|
215
|
-
*
|
|
107
|
+
* "object": "list",
|
|
108
|
+
* "data": [
|
|
109
|
+
* {
|
|
110
|
+
* "object": "contact",
|
|
111
|
+
* "id": "676f0f6765bdaa7d7d760f88",
|
|
112
|
+
* "email": "john@example.com",
|
|
113
|
+
* "name": "John Doe",
|
|
114
|
+
* "type": "customer",
|
|
115
|
+
* ...
|
|
116
|
+
* }
|
|
117
|
+
* ],
|
|
118
|
+
* "nextCursor": "eyJpZCI6IjUwN2YxZjc3YmNmODZjZDc5OTQzOTAxMSJ9"
|
|
216
119
|
* }
|
|
217
120
|
* ```
|
|
218
121
|
*
|
|
@@ -222,12 +125,13 @@ export declare class Contacts extends APIResource {
|
|
|
222
125
|
*
|
|
223
126
|
* @example
|
|
224
127
|
* ```ts
|
|
225
|
-
*
|
|
226
|
-
*
|
|
227
|
-
*
|
|
128
|
+
* // Automatically fetches more pages as needed.
|
|
129
|
+
* for await (const contact of client.users.contacts.list()) {
|
|
130
|
+
* // ...
|
|
131
|
+
* }
|
|
228
132
|
* ```
|
|
229
133
|
*/
|
|
230
|
-
|
|
134
|
+
list(params?: ContactListParams | null | undefined, options?: RequestOptions): PagePromise<ContactListDataCursorPage, ContactList.Data>;
|
|
231
135
|
/**
|
|
232
136
|
* Permanently deletes a contact by their Featurebase ID.
|
|
233
137
|
*
|
|
@@ -332,57 +236,128 @@ export declare class Contacts extends APIResource {
|
|
|
332
236
|
*/
|
|
333
237
|
block(id: string, params?: ContactBlockParams | null | undefined, options?: RequestOptions): APIPromise<ContactBlockResponse>;
|
|
334
238
|
/**
|
|
335
|
-
*
|
|
336
|
-
*
|
|
337
|
-
* ### Path Parameters
|
|
239
|
+
* Creates a new contact or updates an existing one.
|
|
338
240
|
*
|
|
339
|
-
*
|
|
241
|
+
* If a contact with the given `email` or `userId` already exists, it will be
|
|
242
|
+
* updated. Otherwise, a new contact will be created.
|
|
340
243
|
*
|
|
341
|
-
*
|
|
244
|
+
* **At least one of `email` or `userId` must be provided for identification.**
|
|
342
245
|
*
|
|
343
|
-
*
|
|
246
|
+
* ### Request Body
|
|
344
247
|
*
|
|
345
|
-
*
|
|
346
|
-
*
|
|
248
|
+
* | Field | Type | Required | Description |
|
|
249
|
+
* | ----------------------- | -------------- | ------------------- | ----------------------------------------------------------------------------- |
|
|
250
|
+
* | `email` | string or null | One of email/userId | Contact email address. Send `null` with `userId` to remove the current email. |
|
|
251
|
+
* | `userId` | string or null | One of email/userId | External user ID. Send `null` with `email` to remove it. |
|
|
252
|
+
* | `name` | string or null | No | Contact display name. `null` resets it to the system fallback. |
|
|
253
|
+
* | `profilePicture` | string or null | No | Profile picture URL. `null` removes it. |
|
|
254
|
+
* | `companies` | array | No | Replacement company list. `[]` removes all memberships. |
|
|
255
|
+
* | `customFields` | object | No | Values merge by key. A key with `null` is removed. |
|
|
256
|
+
* | `subscribedToChangelog` | boolean | No | Whether subscribed to changelog |
|
|
257
|
+
* | `locale` | string or null | No | Contact locale/language. `null` removes it. |
|
|
258
|
+
* | `phone` | string or null | No | Contact phone number. `null` removes it. |
|
|
259
|
+
* | `roles` | array | No | Replacement role list. `[]` removes all roles. |
|
|
260
|
+
* | `userHash` | string | No | HMAC hash for identity verification |
|
|
261
|
+
* | `createdAt` | string | No | When the contact was created (ISO 8601) |
|
|
262
|
+
*
|
|
263
|
+
* ### Orbit Field Update Semantics
|
|
264
|
+
*
|
|
265
|
+
* - Omit a field to keep its current value.
|
|
266
|
+
* - Send a non-null scalar value to add or replace that value.
|
|
267
|
+
* - Send `null` for `email`, `userId`, `name`, `profilePicture`, `phone`, or
|
|
268
|
+
* `locale` to clear or reset it.
|
|
269
|
+
* - A contact must keep at least one identifier. Removing `email` requires
|
|
270
|
+
* `userId`. Removing `userId` requires `email`.
|
|
271
|
+
* - Send an array to replace the stored list. Send `[]` to clear `companies` or
|
|
272
|
+
* `roles`.
|
|
273
|
+
* - `customFields` is merged by key. Omitted keys stay unchanged. A key with
|
|
274
|
+
* `null` is removed.
|
|
275
|
+
* - `createdAt` and `subscribedToChangelog` do not accept `null`. Use `false` to
|
|
276
|
+
* turn off changelog subscription.
|
|
277
|
+
* - Empty strings are not deletion values for typed contact fields.
|
|
347
278
|
*
|
|
348
|
-
* ###
|
|
279
|
+
* ### Company Object
|
|
349
280
|
*
|
|
350
|
-
*
|
|
281
|
+
* Each company in the `companies` array can have:
|
|
351
282
|
*
|
|
352
|
-
* -
|
|
353
|
-
* -
|
|
354
|
-
* -
|
|
283
|
+
* - `id` (required) - External company ID from your system
|
|
284
|
+
* - `name` (required) - Company name
|
|
285
|
+
* - `monthlySpend` - Monthly spend/revenue
|
|
286
|
+
* - `customFields` - Custom field values
|
|
287
|
+
* - `industry` - Industry
|
|
288
|
+
* - `website` - Company website URL
|
|
289
|
+
* - `plan` - Current plan/subscription
|
|
290
|
+
* - `companySize` - Number of employees
|
|
291
|
+
* - `createdAt` - When the company was created
|
|
355
292
|
*
|
|
356
293
|
* ### Response
|
|
357
294
|
*
|
|
358
|
-
* Returns
|
|
295
|
+
* Returns the created or updated contact object.
|
|
359
296
|
*
|
|
360
|
-
* -
|
|
361
|
-
* -
|
|
362
|
-
*
|
|
297
|
+
* - **201 Created** - A new contact was created
|
|
298
|
+
* - **200 OK** - An existing contact was updated
|
|
299
|
+
*
|
|
300
|
+
* ### Example Request
|
|
301
|
+
*
|
|
302
|
+
* ```json
|
|
303
|
+
* {
|
|
304
|
+
* "email": "john@example.com",
|
|
305
|
+
* "name": "John Doe",
|
|
306
|
+
* "userId": "usr_12345",
|
|
307
|
+
* "companies": [
|
|
308
|
+
* {
|
|
309
|
+
* "id": "company_123",
|
|
310
|
+
* "name": "Acme Inc",
|
|
311
|
+
* "monthlySpend": 500,
|
|
312
|
+
* "plan": "enterprise"
|
|
313
|
+
* }
|
|
314
|
+
* ],
|
|
315
|
+
* "customFields": {
|
|
316
|
+
* "plan": "pro",
|
|
317
|
+
* "signupSource": "website"
|
|
318
|
+
* },
|
|
319
|
+
* "subscribedToChangelog": true
|
|
320
|
+
* }
|
|
321
|
+
* ```
|
|
322
|
+
*
|
|
323
|
+
* ### Example: Remove an Email
|
|
324
|
+
*
|
|
325
|
+
* ```json
|
|
326
|
+
* {
|
|
327
|
+
* "userId": "usr_12345",
|
|
328
|
+
* "email": null
|
|
329
|
+
* }
|
|
330
|
+
* ```
|
|
363
331
|
*
|
|
364
332
|
* ### Example Response
|
|
365
333
|
*
|
|
366
334
|
* ```json
|
|
367
335
|
* {
|
|
368
|
-
* "id": "507f1f77bcf86cd799439011",
|
|
369
336
|
* "object": "contact",
|
|
370
|
-
* "
|
|
337
|
+
* "id": "676f0f6765bdaa7d7d760f88",
|
|
338
|
+
* "email": "john@example.com",
|
|
339
|
+
* "name": "John Doe",
|
|
340
|
+
* "userId": "usr_12345",
|
|
341
|
+
* "type": "customer",
|
|
342
|
+
* "companies": [...],
|
|
343
|
+
* "customFields": {...},
|
|
344
|
+
* ...
|
|
371
345
|
* }
|
|
372
346
|
* ```
|
|
373
347
|
*
|
|
374
348
|
* ### Version Availability
|
|
375
349
|
*
|
|
376
|
-
* This endpoint is
|
|
350
|
+
* This endpoint is available in API version 2026-01-01.nova and newer. The Orbit
|
|
351
|
+
* field update rules, including null removal and empty-array replacement, require
|
|
352
|
+
* API version 2026-08-19.orbit or newer.
|
|
377
353
|
*
|
|
378
354
|
* @example
|
|
379
355
|
* ```ts
|
|
380
|
-
* const response =
|
|
381
|
-
*
|
|
382
|
-
* );
|
|
356
|
+
* const response =
|
|
357
|
+
* await client.users.contacts.createOrUpdate();
|
|
383
358
|
* ```
|
|
384
359
|
*/
|
|
385
|
-
|
|
360
|
+
createOrUpdate(params: ContactCreateOrUpdateParams, options?: RequestOptions): APIPromise<ContactCreateOrUpdateResponse>;
|
|
386
361
|
/**
|
|
387
362
|
* Search contacts (customers and leads) with a structured filter AST, sorting, and
|
|
388
363
|
* cursor pagination.
|
|
@@ -478,6 +453,58 @@ export declare class Contacts extends APIResource {
|
|
|
478
453
|
* ```
|
|
479
454
|
*/
|
|
480
455
|
search(params: ContactSearchParams, options?: RequestOptions): APIPromise<ContactSearchResponse>;
|
|
456
|
+
/**
|
|
457
|
+
* Unblocks a contact by their Featurebase ID from the global moderation system.
|
|
458
|
+
*
|
|
459
|
+
* ### Path Parameters
|
|
460
|
+
*
|
|
461
|
+
* - `id` - The Featurebase internal ID of the contact (MongoDB ObjectId)
|
|
462
|
+
*
|
|
463
|
+
* ### Supported Contact Types
|
|
464
|
+
*
|
|
465
|
+
* This endpoint unblocks both:
|
|
466
|
+
*
|
|
467
|
+
* - **Customers** - Users with registered accounts
|
|
468
|
+
* - **Leads** - Anonymous or unregistered visitors
|
|
469
|
+
*
|
|
470
|
+
* ### Unblocking Behavior
|
|
471
|
+
*
|
|
472
|
+
* When a contact is unblocked:
|
|
473
|
+
*
|
|
474
|
+
* - The contact can resume sending messages via messenger
|
|
475
|
+
* - Previously blocked conversations remain intact
|
|
476
|
+
* - The contact regains full messenger functionality
|
|
477
|
+
*
|
|
478
|
+
* ### Response
|
|
479
|
+
*
|
|
480
|
+
* Returns an unblock confirmation object:
|
|
481
|
+
*
|
|
482
|
+
* - `id` - The ID of the unblocked contact
|
|
483
|
+
* - `object` - Always "contact"
|
|
484
|
+
* - `unblocked` - Always `true`
|
|
485
|
+
*
|
|
486
|
+
* ### Example Response
|
|
487
|
+
*
|
|
488
|
+
* ```json
|
|
489
|
+
* {
|
|
490
|
+
* "id": "507f1f77bcf86cd799439011",
|
|
491
|
+
* "object": "contact",
|
|
492
|
+
* "unblocked": true
|
|
493
|
+
* }
|
|
494
|
+
* ```
|
|
495
|
+
*
|
|
496
|
+
* ### Version Availability
|
|
497
|
+
*
|
|
498
|
+
* This endpoint is only available in API version 2026-01-01.nova and newer.
|
|
499
|
+
*
|
|
500
|
+
* @example
|
|
501
|
+
* ```ts
|
|
502
|
+
* const response = await client.users.contacts.unblock(
|
|
503
|
+
* '507f1f77bcf86cd799439011',
|
|
504
|
+
* );
|
|
505
|
+
* ```
|
|
506
|
+
*/
|
|
507
|
+
unblock(id: string, params?: ContactUnblockParams | null | undefined, options?: RequestOptions): APIPromise<ContactUnblockResponse>;
|
|
481
508
|
}
|
|
482
509
|
export type ContactListDataCursorPage = CursorPage<ContactList.Data>;
|
|
483
510
|
/**
|
|
@@ -739,6 +766,13 @@ export interface ContactUnblockResponse {
|
|
|
739
766
|
*/
|
|
740
767
|
unblocked: true;
|
|
741
768
|
}
|
|
769
|
+
export interface ContactRetrieveParams {
|
|
770
|
+
/**
|
|
771
|
+
* API version for this request. Defaults to your organization's configured API
|
|
772
|
+
* version if not specified.
|
|
773
|
+
*/
|
|
774
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
775
|
+
}
|
|
742
776
|
export interface ContactListParams extends CursorPageParams {
|
|
743
777
|
/**
|
|
744
778
|
* Query param: Filter contacts by type. Defaults to "customer".
|
|
@@ -748,45 +782,64 @@ export interface ContactListParams extends CursorPageParams {
|
|
|
748
782
|
* Header param: API version for this request. Defaults to your organization's
|
|
749
783
|
* configured API version if not specified.
|
|
750
784
|
*/
|
|
751
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
785
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
786
|
+
}
|
|
787
|
+
export interface ContactDeleteParams {
|
|
788
|
+
/**
|
|
789
|
+
* API version for this request. Defaults to your organization's configured API
|
|
790
|
+
* version if not specified.
|
|
791
|
+
*/
|
|
792
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
793
|
+
}
|
|
794
|
+
export interface ContactBlockParams {
|
|
795
|
+
/**
|
|
796
|
+
* API version for this request. Defaults to your organization's configured API
|
|
797
|
+
* version if not specified.
|
|
798
|
+
*/
|
|
799
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
752
800
|
}
|
|
753
801
|
export interface ContactCreateOrUpdateParams {
|
|
754
802
|
/**
|
|
755
|
-
* Body param:
|
|
803
|
+
* Body param: Replacement list of companies. Pass an empty array to remove all
|
|
804
|
+
* company memberships.
|
|
756
805
|
*/
|
|
757
806
|
companies?: Array<ContactCreateOrUpdateParams.Company>;
|
|
758
807
|
/**
|
|
759
|
-
* Body param: When the contact was created in your system (ISO 8601)
|
|
808
|
+
* Body param: When the contact was created in your system (ISO 8601). This field
|
|
809
|
+
* cannot be null.
|
|
760
810
|
*/
|
|
761
|
-
createdAt?: string
|
|
811
|
+
createdAt?: string;
|
|
762
812
|
/**
|
|
763
|
-
* Body param:
|
|
764
|
-
*
|
|
813
|
+
* Body param: Fields are merged by key. Omitted keys are preserved. A null value
|
|
814
|
+
* removes that custom field key.
|
|
765
815
|
*/
|
|
766
|
-
customFields?:
|
|
816
|
+
customFields?: {
|
|
817
|
+
[key: string]: string | number | boolean | Array<string | number | boolean> | null;
|
|
818
|
+
};
|
|
767
819
|
/**
|
|
768
|
-
* Body param: Contact email address.
|
|
769
|
-
*
|
|
820
|
+
* Body param: Contact email address. Omit to preserve it, or pass null with userId
|
|
821
|
+
* to remove the stored email.
|
|
770
822
|
*/
|
|
771
|
-
email?: string;
|
|
823
|
+
email?: string | null;
|
|
772
824
|
/**
|
|
773
|
-
* Body param: Contact locale/language preference
|
|
825
|
+
* Body param: Contact locale/language preference. Pass null to remove it.
|
|
774
826
|
*/
|
|
775
|
-
locale?: string;
|
|
827
|
+
locale?: string | null;
|
|
776
828
|
/**
|
|
777
|
-
* Body param: Contact display name
|
|
829
|
+
* Body param: Contact display name. Pass null to reset it to the system fallback.
|
|
778
830
|
*/
|
|
779
|
-
name?: string;
|
|
831
|
+
name?: string | null;
|
|
780
832
|
/**
|
|
781
|
-
* Body param: Contact phone number
|
|
833
|
+
* Body param: Contact phone number. Pass null to remove it.
|
|
782
834
|
*/
|
|
783
835
|
phone?: string | null;
|
|
784
836
|
/**
|
|
785
|
-
* Body param: Profile picture URL
|
|
837
|
+
* Body param: Profile picture URL. Pass null to remove the stored profile picture.
|
|
786
838
|
*/
|
|
787
839
|
profilePicture?: string | null;
|
|
788
840
|
/**
|
|
789
|
-
* Body param:
|
|
841
|
+
* Body param: Replacement list of role (User Tag) names. Pass an empty array to
|
|
842
|
+
* remove all roles.
|
|
790
843
|
*/
|
|
791
844
|
roles?: Array<string>;
|
|
792
845
|
/**
|
|
@@ -798,15 +851,15 @@ export interface ContactCreateOrUpdateParams {
|
|
|
798
851
|
*/
|
|
799
852
|
userHash?: string;
|
|
800
853
|
/**
|
|
801
|
-
* Body param: External user ID from your system.
|
|
802
|
-
*
|
|
854
|
+
* Body param: External user ID from your system. Pass null with email to remove
|
|
855
|
+
* the stored user ID.
|
|
803
856
|
*/
|
|
804
|
-
userId?: string;
|
|
857
|
+
userId?: string | null;
|
|
805
858
|
/**
|
|
806
859
|
* Header param: API version for this request. Defaults to your organization's
|
|
807
860
|
* configured API version if not specified.
|
|
808
861
|
*/
|
|
809
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
862
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
810
863
|
}
|
|
811
864
|
export declare namespace ContactCreateOrUpdateParams {
|
|
812
865
|
interface Company {
|
|
@@ -834,7 +887,9 @@ export declare namespace ContactCreateOrUpdateParams {
|
|
|
834
887
|
* Custom field values on the company. Values can be string, number, boolean, null,
|
|
835
888
|
* or array of primitives.
|
|
836
889
|
*/
|
|
837
|
-
customFields?:
|
|
890
|
+
customFields?: {
|
|
891
|
+
[key: string]: string | number | boolean | Array<string | number | boolean> | null;
|
|
892
|
+
};
|
|
838
893
|
/**
|
|
839
894
|
* Industry the company operates in
|
|
840
895
|
*/
|
|
@@ -852,54 +907,6 @@ export declare namespace ContactCreateOrUpdateParams {
|
|
|
852
907
|
*/
|
|
853
908
|
website?: string;
|
|
854
909
|
}
|
|
855
|
-
namespace Company {
|
|
856
|
-
/**
|
|
857
|
-
* Custom field values on the company. Values can be string, number, boolean, null,
|
|
858
|
-
* or array of primitives.
|
|
859
|
-
*/
|
|
860
|
-
interface CustomFields {
|
|
861
|
-
industry?: string;
|
|
862
|
-
plan?: string;
|
|
863
|
-
priority?: string;
|
|
864
|
-
}
|
|
865
|
-
}
|
|
866
|
-
/**
|
|
867
|
-
* Custom field values on the contact. Values can be string, number, boolean, null,
|
|
868
|
-
* or array of primitives.
|
|
869
|
-
*/
|
|
870
|
-
interface CustomFields {
|
|
871
|
-
accountType?: string;
|
|
872
|
-
plan?: string;
|
|
873
|
-
signupSource?: string;
|
|
874
|
-
}
|
|
875
|
-
}
|
|
876
|
-
export interface ContactRetrieveParams {
|
|
877
|
-
/**
|
|
878
|
-
* API version for this request. Defaults to your organization's configured API
|
|
879
|
-
* version if not specified.
|
|
880
|
-
*/
|
|
881
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
882
|
-
}
|
|
883
|
-
export interface ContactDeleteParams {
|
|
884
|
-
/**
|
|
885
|
-
* API version for this request. Defaults to your organization's configured API
|
|
886
|
-
* version if not specified.
|
|
887
|
-
*/
|
|
888
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
889
|
-
}
|
|
890
|
-
export interface ContactBlockParams {
|
|
891
|
-
/**
|
|
892
|
-
* API version for this request. Defaults to your organization's configured API
|
|
893
|
-
* version if not specified.
|
|
894
|
-
*/
|
|
895
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
896
|
-
}
|
|
897
|
-
export interface ContactUnblockParams {
|
|
898
|
-
/**
|
|
899
|
-
* API version for this request. Defaults to your organization's configured API
|
|
900
|
-
* version if not specified.
|
|
901
|
-
*/
|
|
902
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
903
910
|
}
|
|
904
911
|
export interface ContactSearchParams {
|
|
905
912
|
/**
|
|
@@ -928,10 +935,17 @@ export interface ContactSearchParams {
|
|
|
928
935
|
* Header param: API version for this request. Defaults to your organization's
|
|
929
936
|
* configured API version if not specified.
|
|
930
937
|
*/
|
|
931
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
938
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
939
|
+
}
|
|
940
|
+
export interface ContactUnblockParams {
|
|
941
|
+
/**
|
|
942
|
+
* API version for this request. Defaults to your organization's configured API
|
|
943
|
+
* version if not specified.
|
|
944
|
+
*/
|
|
945
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
932
946
|
}
|
|
933
947
|
export declare namespace Contacts {
|
|
934
|
-
export { type Contact as Contact, type ContactList as ContactList, type DeletedContact as DeletedContact, type ContactRetrieveResponse as ContactRetrieveResponse, type ContactBlockResponse as ContactBlockResponse, type ContactCreateOrUpdateResponse as ContactCreateOrUpdateResponse, type ContactSearchResponse as ContactSearchResponse, type ContactUnblockResponse as ContactUnblockResponse, type ContactListDataCursorPage as ContactListDataCursorPage, type
|
|
948
|
+
export { type Contact as Contact, type ContactList as ContactList, type DeletedContact as DeletedContact, type ContactRetrieveResponse as ContactRetrieveResponse, type ContactBlockResponse as ContactBlockResponse, type ContactCreateOrUpdateResponse as ContactCreateOrUpdateResponse, type ContactSearchResponse as ContactSearchResponse, type ContactUnblockResponse as ContactUnblockResponse, type ContactListDataCursorPage as ContactListDataCursorPage, type ContactRetrieveParams as ContactRetrieveParams, type ContactListParams as ContactListParams, type ContactDeleteParams as ContactDeleteParams, type ContactBlockParams as ContactBlockParams, type ContactCreateOrUpdateParams as ContactCreateOrUpdateParams, type ContactSearchParams as ContactSearchParams, type ContactUnblockParams as ContactUnblockParams, };
|
|
935
949
|
export { ByUserID as ByUserID, type ByUserIDRetrieveResponse as ByUserIDRetrieveResponse, type ByUserIDRetrieveParams as ByUserIDRetrieveParams, type ByUserIDDeleteParams as ByUserIDDeleteParams, };
|
|
936
950
|
export { EmailPreferences as EmailPreferences, type PreferenceState as PreferenceState, type PreferencesOutput as PreferencesOutput, type UpdatePreferenceBody as UpdatePreferenceBody, type EmailPreferenceRetrieveParams as EmailPreferenceRetrieveParams, type EmailPreferenceUpdateParams as EmailPreferenceUpdateParams, };
|
|
937
951
|
}
|