bereach 0.1.2 → 0.2.1

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/README.md CHANGED
@@ -5,6 +5,11 @@ Developer-friendly & type-safe Typescript SDK specifically catered to leverage *
5
5
  [![Built by Speakeasy](https://img.shields.io/badge/Built_by-SPEAKEASY-374151?style=for-the-badge&labelColor=f3f4f6)](https://www.speakeasy.com/?utm_source=bereach&utm_campaign=typescript)
6
6
  [![License: MIT](https://img.shields.io/badge/LICENSE_//_MIT-3b5bdb?style=for-the-badge&labelColor=eff6ff)](https://opensource.org/licenses/MIT)
7
7
 
8
+
9
+ <br /><br />
10
+ > [!IMPORTANT]
11
+ > This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your [workspace](https://app.speakeasy.com/org/bereach/bereach). Delete this section before > publishing to a package manager.
12
+
8
13
  <!-- Start Summary [summary] -->
9
14
  ## Summary
10
15
 
@@ -69,7 +74,7 @@ yarn add bereach
69
74
  <!-- Start Requirements [requirements] -->
70
75
  ## Requirements
71
76
 
72
- For supported JavaScript runtimes, please consult [RUNTIMES.md](https://github.com/berea-ch/bereach-sdk-ts/blob/main/RUNTIMES.md).
77
+ For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
73
78
  <!-- End Requirements [requirements] -->
74
79
 
75
80
  <!-- Start SDK Example Usage [usage] -->
@@ -139,57 +144,57 @@ run();
139
144
  <details open>
140
145
  <summary>Available methods</summary>
141
146
 
142
- ### [Campaigns](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/campaigns/README.md)
147
+ ### [Campaigns](docs/sdks/campaigns/README.md)
143
148
 
144
- * [~~filter~~](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/campaigns/README.md#filter) - Check if campaign actions are completed :warning: **Deprecated**
145
- * [getStatus](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/campaigns/README.md#getstatus) - Query per-profile action status within a campaign
146
- * [syncActions](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/campaigns/README.md#syncactions) - Mark actions as completed without performing them
147
- * [getStats](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/campaigns/README.md#getstats) - Get aggregate campaign statistics
149
+ * [~~filter~~](docs/sdks/campaigns/README.md#filter) - Check if campaign actions are completed :warning: **Deprecated**
150
+ * [getStatus](docs/sdks/campaigns/README.md#getstatus) - Query per-profile action status within a campaign
151
+ * [syncActions](docs/sdks/campaigns/README.md#syncactions) - Mark actions as completed without performing them
152
+ * [getStats](docs/sdks/campaigns/README.md#getstats) - Get aggregate campaign statistics
148
153
 
149
- ### [LinkedinActions](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/linkedinactions/README.md)
154
+ ### [LinkedinActions](docs/sdks/linkedinactions/README.md)
150
155
 
151
- * [connectProfile](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/linkedinactions/README.md#connectprofile) - Send LinkedIn connection request
152
- * [listInvitations](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/linkedinactions/README.md#listinvitations) - List received LinkedIn connection invitations
153
- * [acceptInvitation](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/linkedinactions/README.md#acceptinvitation) - Accept a LinkedIn connection invitation
154
- * [sendMessage](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/linkedinactions/README.md#sendmessage) - Send LinkedIn message
155
- * [replyToComment](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/linkedinactions/README.md#replytocomment) - Reply to a LinkedIn comment
156
- * [likeComment](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/linkedinactions/README.md#likecomment) - Like a LinkedIn comment
157
- * [publishPost](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/linkedinactions/README.md#publishpost) - Publish or schedule a LinkedIn post
156
+ * [connectProfile](docs/sdks/linkedinactions/README.md#connectprofile) - Send LinkedIn connection request
157
+ * [listInvitations](docs/sdks/linkedinactions/README.md#listinvitations) - List received LinkedIn connection invitations
158
+ * [acceptInvitation](docs/sdks/linkedinactions/README.md#acceptinvitation) - Accept a LinkedIn connection invitation
159
+ * [sendMessage](docs/sdks/linkedinactions/README.md#sendmessage) - Send LinkedIn message
160
+ * [replyToComment](docs/sdks/linkedinactions/README.md#replytocomment) - Reply to a LinkedIn comment
161
+ * [likeComment](docs/sdks/linkedinactions/README.md#likecomment) - Like a LinkedIn comment
162
+ * [publishPost](docs/sdks/linkedinactions/README.md#publishpost) - Publish or schedule a LinkedIn post
158
163
 
159
- ### [LinkedinChat](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/linkedinchat/README.md)
164
+ ### [LinkedinChat](docs/sdks/linkedinchat/README.md)
160
165
 
161
- * [listConversations](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/linkedinchat/README.md#listconversations) - List LinkedIn inbox conversations
162
- * [searchConversations](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/linkedinchat/README.md#searchconversations) - Search LinkedIn conversations
163
- * [findConversation](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/linkedinchat/README.md#findconversation) - Find a conversation with a specific person
164
- * [getMessages](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/linkedinchat/README.md#getmessages) - Read messages from a conversation
166
+ * [listConversations](docs/sdks/linkedinchat/README.md#listconversations) - List LinkedIn inbox conversations
167
+ * [searchConversations](docs/sdks/linkedinchat/README.md#searchconversations) - Search LinkedIn conversations
168
+ * [findConversation](docs/sdks/linkedinchat/README.md#findconversation) - Find a conversation with a specific person
169
+ * [getMessages](docs/sdks/linkedinchat/README.md#getmessages) - Read messages from a conversation
165
170
 
166
- ### [LinkedinScrapers](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/linkedinscrapers/README.md)
171
+ ### [LinkedinScrapers](docs/sdks/linkedinscrapers/README.md)
167
172
 
168
- * [collectLikes](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/linkedinscrapers/README.md#collectlikes) - Scrape LinkedIn post likes
169
- * [collectComments](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/linkedinscrapers/README.md#collectcomments) - Scrape LinkedIn post comments
170
- * [collectCommentReplies](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/linkedinscrapers/README.md#collectcommentreplies) - Scrape replies to a LinkedIn comment
171
- * [collectPosts](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/linkedinscrapers/README.md#collectposts) - Scrape LinkedIn profile posts
172
- * [visitProfile](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/linkedinscrapers/README.md#visitprofile) - Visit LinkedIn profile and extract contact data
173
- * [visitCompany](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/linkedinscrapers/README.md#visitcompany) - Visit LinkedIn company page and extract profile data
173
+ * [collectLikes](docs/sdks/linkedinscrapers/README.md#collectlikes) - Scrape LinkedIn post likes
174
+ * [collectComments](docs/sdks/linkedinscrapers/README.md#collectcomments) - Scrape LinkedIn post comments
175
+ * [collectCommentReplies](docs/sdks/linkedinscrapers/README.md#collectcommentreplies) - Scrape replies to a LinkedIn comment
176
+ * [collectPosts](docs/sdks/linkedinscrapers/README.md#collectposts) - Scrape LinkedIn profile posts
177
+ * [visitProfile](docs/sdks/linkedinscrapers/README.md#visitprofile) - Visit LinkedIn profile and extract contact data
178
+ * [visitCompany](docs/sdks/linkedinscrapers/README.md#visitcompany) - Visit LinkedIn company page and extract profile data
174
179
 
175
- ### [LinkedinSearch](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/linkedinsearch/README.md)
180
+ ### [LinkedinSearch](docs/sdks/linkedinsearch/README.md)
176
181
 
177
- * [unifiedSearch](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/linkedinsearch/README.md#unifiedsearch) - Unified LinkedIn Search — posts, people, companies, jobs
178
- * [searchPosts](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/linkedinsearch/README.md#searchposts) - Search LinkedIn Posts
179
- * [searchPeople](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/linkedinsearch/README.md#searchpeople) - Search LinkedIn People
180
- * [searchCompanies](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/linkedinsearch/README.md#searchcompanies) - Search LinkedIn Companies
181
- * [searchJobs](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/linkedinsearch/README.md#searchjobs) - Search LinkedIn Jobs
182
- * [searchByUrl](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/linkedinsearch/README.md#searchbyurl) - Search LinkedIn by URL
183
- * [resolveParameters](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/linkedinsearch/README.md#resolveparameters) - Resolve text to LinkedIn search parameter IDs (typeahead)
182
+ * [unifiedSearch](docs/sdks/linkedinsearch/README.md#unifiedsearch) - Unified LinkedIn Search — posts, people, companies, jobs
183
+ * [searchPosts](docs/sdks/linkedinsearch/README.md#searchposts) - Search LinkedIn Posts
184
+ * [searchPeople](docs/sdks/linkedinsearch/README.md#searchpeople) - Search LinkedIn People
185
+ * [searchCompanies](docs/sdks/linkedinsearch/README.md#searchcompanies) - Search LinkedIn Companies
186
+ * [searchJobs](docs/sdks/linkedinsearch/README.md#searchjobs) - Search LinkedIn Jobs
187
+ * [searchByUrl](docs/sdks/linkedinsearch/README.md#searchbyurl) - Search LinkedIn by URL
188
+ * [resolveParameters](docs/sdks/linkedinsearch/README.md#resolveparameters) - Resolve text to LinkedIn search parameter IDs (typeahead)
184
189
 
185
- ### [Profile](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/profile/README.md)
190
+ ### [Profile](docs/sdks/profile/README.md)
186
191
 
187
- * [getLinkedInProfile](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/profile/README.md#getlinkedinprofile) - Get authenticated user's LinkedIn profile
188
- * [refresh](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/profile/README.md#refresh) - Refresh authenticated user's LinkedIn profile
189
- * [getPosts](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/profile/README.md#getposts) - Get authenticated user's LinkedIn posts
190
- * [getFollowers](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/profile/README.md#getfollowers) - Get authenticated user's LinkedIn followers
191
- * [getLimits](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/profile/README.md#getlimits) - Get current LinkedIn rate limit status
192
- * [getCredits](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/profile/README.md#getcredits) - Get current BeReach credit balance
192
+ * [getLinkedInProfile](docs/sdks/profile/README.md#getlinkedinprofile) - Get authenticated user's LinkedIn profile
193
+ * [refresh](docs/sdks/profile/README.md#refresh) - Refresh authenticated user's LinkedIn profile
194
+ * [getPosts](docs/sdks/profile/README.md#getposts) - Get authenticated user's LinkedIn posts
195
+ * [getFollowers](docs/sdks/profile/README.md#getfollowers) - Get authenticated user's LinkedIn followers
196
+ * [getLimits](docs/sdks/profile/README.md#getlimits) - Get current LinkedIn rate limit status
197
+ * [getCredits](docs/sdks/profile/README.md#getcredits) - Get current BeReach credit balance
193
198
 
194
199
  </details>
195
200
  <!-- End Available Resources and Operations [operations] -->
@@ -203,46 +208,46 @@ runtimes or other environments where application bundle size is a primary
203
208
  concern. When using a bundler to build your application, all unused
204
209
  functionality will be either excluded from the final bundle or tree-shaken away.
205
210
 
206
- To read more about standalone functions, check [FUNCTIONS.md](https://github.com/berea-ch/bereach-sdk-ts/blob/main/FUNCTIONS.md).
211
+ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
207
212
 
208
213
  <details>
209
214
 
210
215
  <summary>Available standalone functions</summary>
211
216
 
212
- - [`campaignsGetStats`](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/campaigns/README.md#getstats) - Get aggregate campaign statistics
213
- - [`campaignsGetStatus`](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/campaigns/README.md#getstatus) - Query per-profile action status within a campaign
214
- - [`campaignsSyncActions`](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/campaigns/README.md#syncactions) - Mark actions as completed without performing them
215
- - [`linkedinActionsAcceptInvitation`](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/linkedinactions/README.md#acceptinvitation) - Accept a LinkedIn connection invitation
216
- - [`linkedinActionsConnectProfile`](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/linkedinactions/README.md#connectprofile) - Send LinkedIn connection request
217
- - [`linkedinActionsLikeComment`](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/linkedinactions/README.md#likecomment) - Like a LinkedIn comment
218
- - [`linkedinActionsListInvitations`](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/linkedinactions/README.md#listinvitations) - List received LinkedIn connection invitations
219
- - [`linkedinActionsPublishPost`](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/linkedinactions/README.md#publishpost) - Publish or schedule a LinkedIn post
220
- - [`linkedinActionsReplyToComment`](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/linkedinactions/README.md#replytocomment) - Reply to a LinkedIn comment
221
- - [`linkedinActionsSendMessage`](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/linkedinactions/README.md#sendmessage) - Send LinkedIn message
222
- - [`linkedinChatFindConversation`](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/linkedinchat/README.md#findconversation) - Find a conversation with a specific person
223
- - [`linkedinChatGetMessages`](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/linkedinchat/README.md#getmessages) - Read messages from a conversation
224
- - [`linkedinChatListConversations`](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/linkedinchat/README.md#listconversations) - List LinkedIn inbox conversations
225
- - [`linkedinChatSearchConversations`](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/linkedinchat/README.md#searchconversations) - Search LinkedIn conversations
226
- - [`linkedinScrapersCollectCommentReplies`](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/linkedinscrapers/README.md#collectcommentreplies) - Scrape replies to a LinkedIn comment
227
- - [`linkedinScrapersCollectComments`](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/linkedinscrapers/README.md#collectcomments) - Scrape LinkedIn post comments
228
- - [`linkedinScrapersCollectLikes`](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/linkedinscrapers/README.md#collectlikes) - Scrape LinkedIn post likes
229
- - [`linkedinScrapersCollectPosts`](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/linkedinscrapers/README.md#collectposts) - Scrape LinkedIn profile posts
230
- - [`linkedinScrapersVisitCompany`](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/linkedinscrapers/README.md#visitcompany) - Visit LinkedIn company page and extract profile data
231
- - [`linkedinScrapersVisitProfile`](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/linkedinscrapers/README.md#visitprofile) - Visit LinkedIn profile and extract contact data
232
- - [`linkedinSearchResolveParameters`](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/linkedinsearch/README.md#resolveparameters) - Resolve text to LinkedIn search parameter IDs (typeahead)
233
- - [`linkedinSearchSearchByUrl`](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/linkedinsearch/README.md#searchbyurl) - Search LinkedIn by URL
234
- - [`linkedinSearchSearchCompanies`](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/linkedinsearch/README.md#searchcompanies) - Search LinkedIn Companies
235
- - [`linkedinSearchSearchJobs`](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/linkedinsearch/README.md#searchjobs) - Search LinkedIn Jobs
236
- - [`linkedinSearchSearchPeople`](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/linkedinsearch/README.md#searchpeople) - Search LinkedIn People
237
- - [`linkedinSearchSearchPosts`](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/linkedinsearch/README.md#searchposts) - Search LinkedIn Posts
238
- - [`linkedinSearchUnifiedSearch`](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/linkedinsearch/README.md#unifiedsearch) - Unified LinkedIn Search — posts, people, companies, jobs
239
- - [`profileGetCredits`](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/profile/README.md#getcredits) - Get current BeReach credit balance
240
- - [`profileGetFollowers`](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/profile/README.md#getfollowers) - Get authenticated user's LinkedIn followers
241
- - [`profileGetLimits`](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/profile/README.md#getlimits) - Get current LinkedIn rate limit status
242
- - [`profileGetLinkedInProfile`](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/profile/README.md#getlinkedinprofile) - Get authenticated user's LinkedIn profile
243
- - [`profileGetPosts`](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/profile/README.md#getposts) - Get authenticated user's LinkedIn posts
244
- - [`profileRefresh`](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/profile/README.md#refresh) - Refresh authenticated user's LinkedIn profile
245
- - ~~[`campaignsFilter`](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/campaigns/README.md#filter)~~ - Check if campaign actions are completed :warning: **Deprecated**
217
+ - [`campaignsGetStats`](docs/sdks/campaigns/README.md#getstats) - Get aggregate campaign statistics
218
+ - [`campaignsGetStatus`](docs/sdks/campaigns/README.md#getstatus) - Query per-profile action status within a campaign
219
+ - [`campaignsSyncActions`](docs/sdks/campaigns/README.md#syncactions) - Mark actions as completed without performing them
220
+ - [`linkedinActionsAcceptInvitation`](docs/sdks/linkedinactions/README.md#acceptinvitation) - Accept a LinkedIn connection invitation
221
+ - [`linkedinActionsConnectProfile`](docs/sdks/linkedinactions/README.md#connectprofile) - Send LinkedIn connection request
222
+ - [`linkedinActionsLikeComment`](docs/sdks/linkedinactions/README.md#likecomment) - Like a LinkedIn comment
223
+ - [`linkedinActionsListInvitations`](docs/sdks/linkedinactions/README.md#listinvitations) - List received LinkedIn connection invitations
224
+ - [`linkedinActionsPublishPost`](docs/sdks/linkedinactions/README.md#publishpost) - Publish or schedule a LinkedIn post
225
+ - [`linkedinActionsReplyToComment`](docs/sdks/linkedinactions/README.md#replytocomment) - Reply to a LinkedIn comment
226
+ - [`linkedinActionsSendMessage`](docs/sdks/linkedinactions/README.md#sendmessage) - Send LinkedIn message
227
+ - [`linkedinChatFindConversation`](docs/sdks/linkedinchat/README.md#findconversation) - Find a conversation with a specific person
228
+ - [`linkedinChatGetMessages`](docs/sdks/linkedinchat/README.md#getmessages) - Read messages from a conversation
229
+ - [`linkedinChatListConversations`](docs/sdks/linkedinchat/README.md#listconversations) - List LinkedIn inbox conversations
230
+ - [`linkedinChatSearchConversations`](docs/sdks/linkedinchat/README.md#searchconversations) - Search LinkedIn conversations
231
+ - [`linkedinScrapersCollectCommentReplies`](docs/sdks/linkedinscrapers/README.md#collectcommentreplies) - Scrape replies to a LinkedIn comment
232
+ - [`linkedinScrapersCollectComments`](docs/sdks/linkedinscrapers/README.md#collectcomments) - Scrape LinkedIn post comments
233
+ - [`linkedinScrapersCollectLikes`](docs/sdks/linkedinscrapers/README.md#collectlikes) - Scrape LinkedIn post likes
234
+ - [`linkedinScrapersCollectPosts`](docs/sdks/linkedinscrapers/README.md#collectposts) - Scrape LinkedIn profile posts
235
+ - [`linkedinScrapersVisitCompany`](docs/sdks/linkedinscrapers/README.md#visitcompany) - Visit LinkedIn company page and extract profile data
236
+ - [`linkedinScrapersVisitProfile`](docs/sdks/linkedinscrapers/README.md#visitprofile) - Visit LinkedIn profile and extract contact data
237
+ - [`linkedinSearchResolveParameters`](docs/sdks/linkedinsearch/README.md#resolveparameters) - Resolve text to LinkedIn search parameter IDs (typeahead)
238
+ - [`linkedinSearchSearchByUrl`](docs/sdks/linkedinsearch/README.md#searchbyurl) - Search LinkedIn by URL
239
+ - [`linkedinSearchSearchCompanies`](docs/sdks/linkedinsearch/README.md#searchcompanies) - Search LinkedIn Companies
240
+ - [`linkedinSearchSearchJobs`](docs/sdks/linkedinsearch/README.md#searchjobs) - Search LinkedIn Jobs
241
+ - [`linkedinSearchSearchPeople`](docs/sdks/linkedinsearch/README.md#searchpeople) - Search LinkedIn People
242
+ - [`linkedinSearchSearchPosts`](docs/sdks/linkedinsearch/README.md#searchposts) - Search LinkedIn Posts
243
+ - [`linkedinSearchUnifiedSearch`](docs/sdks/linkedinsearch/README.md#unifiedsearch) - Unified LinkedIn Search — posts, people, companies, jobs
244
+ - [`profileGetCredits`](docs/sdks/profile/README.md#getcredits) - Get current BeReach credit balance
245
+ - [`profileGetFollowers`](docs/sdks/profile/README.md#getfollowers) - Get authenticated user's LinkedIn followers
246
+ - [`profileGetLimits`](docs/sdks/profile/README.md#getlimits) - Get current LinkedIn rate limit status
247
+ - [`profileGetLinkedInProfile`](docs/sdks/profile/README.md#getlinkedinprofile) - Get authenticated user's LinkedIn profile
248
+ - [`profileGetPosts`](docs/sdks/profile/README.md#getposts) - Get authenticated user's LinkedIn posts
249
+ - [`profileRefresh`](docs/sdks/profile/README.md#refresh) - Refresh authenticated user's LinkedIn profile
250
+ - ~~[`campaignsFilter`](docs/sdks/campaigns/README.md#filter)~~ - Check if campaign actions are completed :warning: **Deprecated**
246
251
 
247
252
  </details>
248
253
  <!-- End Standalone functions [standalone-funcs] -->
@@ -321,7 +326,7 @@ run();
321
326
  <!-- Start Error Handling [errors] -->
322
327
  ## Error Handling
323
328
 
324
- [`BereachError`](https://github.com/berea-ch/bereach-sdk-ts/blob/main/src/models/errors/bereach-error.ts) is the base class for all HTTP error responses. It has the following properties:
329
+ [`BereachError`](./src/models/errors/bereach-error.ts) is the base class for all HTTP error responses. It has the following properties:
325
330
 
326
331
  | Property | Type | Description |
327
332
  | ------------------- | ---------- | --------------------------------------------------------------------------------------- |
@@ -373,31 +378,31 @@ run();
373
378
 
374
379
  ### Error Classes
375
380
  **Primary errors:**
376
- * [`BereachError`](https://github.com/berea-ch/bereach-sdk-ts/blob/main/src/models/errors/bereach-error.ts): The base class for HTTP error responses.
377
- * [`BadRequestError`](https://github.com/berea-ch/bereach-sdk-ts/blob/main/src/models/errors/bad-request-error.ts): The server cannot or will not process the request due to something that is perceived to be a client error. Status code `400`.
378
- * [`UnauthorizedError`](https://github.com/berea-ch/bereach-sdk-ts/blob/main/src/models/errors/unauthorized-error.ts): Although HTTP specifies "unauthorized", this response means "unauthenticated". Authenticate to continue. Status code `401`.
379
- * [`ForbiddenError`](https://github.com/berea-ch/bereach-sdk-ts/blob/main/src/models/errors/forbidden-error.ts): The client does not have access rights to the content. Status code `403`.
380
- * [`NotFoundError`](https://github.com/berea-ch/bereach-sdk-ts/blob/main/src/models/errors/not-found-error.ts): The server cannot find the requested resource. Status code `404`.
381
- * [`ConflictError`](https://github.com/berea-ch/bereach-sdk-ts/blob/main/src/models/errors/conflict-error.ts): The request conflicts with the current state of the server. Status code `409`.
382
- * [`GoneError`](https://github.com/berea-ch/bereach-sdk-ts/blob/main/src/models/errors/gone-error.ts): The requested content has been permanently deleted from the server. Status code `410`.
383
- * [`UnprocessableEntityError`](https://github.com/berea-ch/bereach-sdk-ts/blob/main/src/models/errors/unprocessable-entity-error.ts): The request was well-formed but was unable to be followed due to semantic errors. Status code `422`.
384
- * [`TooManyRequestsError`](https://github.com/berea-ch/bereach-sdk-ts/blob/main/src/models/errors/too-many-requests-error.ts): Rate limit exceeded. Read error.retryAfter for the wait time in seconds. Status code `429`.
385
- * [`InternalServerError`](https://github.com/berea-ch/bereach-sdk-ts/blob/main/src/models/errors/internal-server-error.ts): The server encountered a situation it does not know how to handle. Status code `500`.
381
+ * [`BereachError`](./src/models/errors/bereach-error.ts): The base class for HTTP error responses.
382
+ * [`BadRequestError`](./src/models/errors/bad-request-error.ts): The server cannot or will not process the request due to something that is perceived to be a client error. Status code `400`.
383
+ * [`UnauthorizedError`](./src/models/errors/unauthorized-error.ts): Although HTTP specifies "unauthorized", this response means "unauthenticated". Authenticate to continue. Status code `401`.
384
+ * [`ForbiddenError`](./src/models/errors/forbidden-error.ts): The client does not have access rights to the content. Status code `403`.
385
+ * [`NotFoundError`](./src/models/errors/not-found-error.ts): The server cannot find the requested resource. Status code `404`.
386
+ * [`ConflictError`](./src/models/errors/conflict-error.ts): The request conflicts with the current state of the server. Status code `409`.
387
+ * [`GoneError`](./src/models/errors/gone-error.ts): The requested content has been permanently deleted from the server. Status code `410`.
388
+ * [`UnprocessableEntityError`](./src/models/errors/unprocessable-entity-error.ts): The request was well-formed but was unable to be followed due to semantic errors. Status code `422`.
389
+ * [`TooManyRequestsError`](./src/models/errors/too-many-requests-error.ts): Rate limit exceeded. Read error.retryAfter for the wait time in seconds. Status code `429`.
390
+ * [`InternalServerError`](./src/models/errors/internal-server-error.ts): The server encountered a situation it does not know how to handle. Status code `500`.
386
391
 
387
392
  <details><summary>Less common errors (6)</summary>
388
393
 
389
394
  <br />
390
395
 
391
396
  **Network errors:**
392
- * [`ConnectionError`](https://github.com/berea-ch/bereach-sdk-ts/blob/main/src/models/errors/http-client-errors.ts): HTTP client was unable to make a request to a server.
393
- * [`RequestTimeoutError`](https://github.com/berea-ch/bereach-sdk-ts/blob/main/src/models/errors/http-client-errors.ts): HTTP request timed out due to an AbortSignal signal.
394
- * [`RequestAbortedError`](https://github.com/berea-ch/bereach-sdk-ts/blob/main/src/models/errors/http-client-errors.ts): HTTP request was aborted by the client.
395
- * [`InvalidRequestError`](https://github.com/berea-ch/bereach-sdk-ts/blob/main/src/models/errors/http-client-errors.ts): Any input used to create a request is invalid.
396
- * [`UnexpectedClientError`](https://github.com/berea-ch/bereach-sdk-ts/blob/main/src/models/errors/http-client-errors.ts): Unrecognised or unexpected error.
397
+ * [`ConnectionError`](./src/models/errors/http-client-errors.ts): HTTP client was unable to make a request to a server.
398
+ * [`RequestTimeoutError`](./src/models/errors/http-client-errors.ts): HTTP request timed out due to an AbortSignal signal.
399
+ * [`RequestAbortedError`](./src/models/errors/http-client-errors.ts): HTTP request was aborted by the client.
400
+ * [`InvalidRequestError`](./src/models/errors/http-client-errors.ts): Any input used to create a request is invalid.
401
+ * [`UnexpectedClientError`](./src/models/errors/http-client-errors.ts): Unrecognised or unexpected error.
397
402
 
398
403
 
399
- **Inherit from [`BereachError`](https://github.com/berea-ch/bereach-sdk-ts/blob/main/src/models/errors/bereach-error.ts)**:
400
- * [`ResponseValidationError`](https://github.com/berea-ch/bereach-sdk-ts/blob/main/src/models/errors/response-validation-error.ts): Type mismatch between the data returned from the server and the structure expected by the SDK. See `error.rawValue` for the raw value and `error.pretty()` for a nicely formatted multi-line string.
404
+ **Inherit from [`BereachError`](./src/models/errors/bereach-error.ts)**:
405
+ * [`ResponseValidationError`](./src/models/errors/response-validation-error.ts): Type mismatch between the data returned from the server and the structure expected by the SDK. See `error.rawValue` for the raw value and `error.pretty()` for a nicely formatted multi-line string.
401
406
 
402
407
  </details>
403
408
  <!-- End Error Handling [errors] -->
@@ -30,9 +30,9 @@ export type SDKOptions = {
30
30
  export declare function serverURLFromOptions(options: SDKOptions): URL | null;
31
31
  export declare const SDK_METADATA: {
32
32
  readonly language: "typescript";
33
- readonly openapiDocVersion: "0.0.8";
34
- readonly sdkVersion: "0.1.2";
35
- readonly genVersion: "2.846.4";
36
- readonly userAgent: "speakeasy-sdk/typescript 0.1.2 2.846.4 0.0.8 bereach";
33
+ readonly openapiDocVersion: "0.1.0";
34
+ readonly sdkVersion: "0.2.1";
35
+ readonly genVersion: "2.849.8";
36
+ readonly userAgent: "speakeasy-sdk/typescript 0.2.1 2.849.8 0.1.0 bereach";
37
37
  };
38
38
  //# sourceMappingURL=config.d.ts.map
package/esm/lib/config.js CHANGED
@@ -26,9 +26,9 @@ export function serverURLFromOptions(options) {
26
26
  }
27
27
  export const SDK_METADATA = {
28
28
  language: "typescript",
29
- openapiDocVersion: "0.0.8",
30
- sdkVersion: "0.1.2",
31
- genVersion: "2.846.4",
32
- userAgent: "speakeasy-sdk/typescript 0.1.2 2.846.4 0.0.8 bereach",
29
+ openapiDocVersion: "0.1.0",
30
+ sdkVersion: "0.2.1",
31
+ genVersion: "2.849.8",
32
+ userAgent: "speakeasy-sdk/typescript 0.2.1 2.849.8 0.1.0 bereach",
33
33
  };
34
34
  //# sourceMappingURL=config.js.map
@@ -301,15 +301,15 @@ export type GetMyLinkedInProfileResponse = {
301
301
  /**
302
302
  * Total LinkedIn connections
303
303
  */
304
- connectionsCount?: number | null | undefined;
304
+ connectionsCount: number | null;
305
305
  /**
306
306
  * Profile location
307
307
  */
308
- location?: GetMyLinkedInProfileLocation | null | undefined;
308
+ location: GetMyLinkedInProfileLocation | null;
309
309
  /**
310
310
  * LinkedIn verification status
311
311
  */
312
- isVerified?: boolean | undefined;
312
+ isVerified: boolean | null;
313
313
  /**
314
314
  * Last 5 posts (populated when posts have been fetched via /me/linkedin/posts)
315
315
  */
@@ -425,15 +425,15 @@ export type RefreshMyLinkedInProfileResponse = {
425
425
  /**
426
426
  * Total LinkedIn connections
427
427
  */
428
- connectionsCount?: number | null | undefined;
428
+ connectionsCount: number | null;
429
429
  /**
430
430
  * Profile location
431
431
  */
432
- location?: RefreshMyLinkedInProfileLocation | null | undefined;
432
+ location: RefreshMyLinkedInProfileLocation | null;
433
433
  /**
434
434
  * LinkedIn verification status
435
435
  */
436
- isVerified?: boolean | undefined;
436
+ isVerified: boolean | null;
437
437
  /**
438
438
  * Last 5 posts (populated when posts have been fetched via /me/linkedin/posts)
439
439
  */
@@ -858,12 +858,12 @@ export type ListInboxConversationsParticipant = {
858
858
  profileUrn: string;
859
859
  firstName: string;
860
860
  lastName: string;
861
- profileUrl: string;
861
+ profileUrl: string | null;
862
862
  headline: string | null;
863
863
  profilePicture: string | null;
864
864
  };
865
865
  export type ListInboxConversationsLastMessage = {
866
- text: string;
866
+ text: string | null;
867
867
  deliveredAt: number;
868
868
  senderProfileUrn: string;
869
869
  };
@@ -911,12 +911,12 @@ export type SearchLinkedInConversationsParticipant = {
911
911
  profileUrn: string;
912
912
  firstName: string;
913
913
  lastName: string;
914
- profileUrl: string;
914
+ profileUrl: string | null;
915
915
  headline: string | null;
916
916
  profilePicture: string | null;
917
917
  };
918
918
  export type SearchLinkedInConversationsLastMessage = {
919
- text: string;
919
+ text: string | null;
920
920
  deliveredAt: number;
921
921
  senderProfileUrn: string;
922
922
  };
@@ -960,34 +960,16 @@ export type FindLinkedInConversationRequest = {
960
960
  */
961
961
  includeMessages?: boolean | undefined;
962
962
  };
963
- export type FindLinkedInConversationParticipant = {
964
- profileUrn: string;
965
- firstName: string;
966
- lastName: string;
967
- profileUrl: string;
968
- headline: string | null;
969
- profilePicture: string | null;
970
- };
971
- export type FindLinkedInConversationLastMessage = {
972
- text: string;
973
- deliveredAt: number;
974
- senderProfileUrn: string;
975
- };
963
+ /**
964
+ * Lightweight conversation reference (O(1) lookup returns URN only, not full details).
965
+ */
976
966
  export type FindLinkedInConversationConversation = {
977
967
  conversationUrn: string;
978
- conversationUrl: string;
979
- lastActivityAt: number;
980
- createdAt: number;
981
- read: boolean;
982
- unreadCount: number;
983
- groupChat: boolean;
984
- participants: Array<FindLinkedInConversationParticipant>;
985
- lastMessage: FindLinkedInConversationLastMessage | null;
986
968
  };
987
969
  export type FindLinkedInConversationSender = {
988
970
  firstName: string;
989
971
  lastName: string;
990
- profileUrl: string;
972
+ profileUrl: string | null;
991
973
  headline: string | null;
992
974
  profilePicture: string | null;
993
975
  };
@@ -1013,7 +995,7 @@ export type FindLinkedInConversationAttachment = {
1013
995
  };
1014
996
  export type FindLinkedInConversationMessage = {
1015
997
  messageUrn: string;
1016
- text: string;
998
+ text: string | null;
1017
999
  deliveredAt: number;
1018
1000
  senderProfileUrn: string;
1019
1001
  sender: FindLinkedInConversationSender;
@@ -1025,6 +1007,9 @@ export type FindLinkedInConversationMessage = {
1025
1007
  export type FindLinkedInConversationResponse = {
1026
1008
  success: boolean;
1027
1009
  found: boolean;
1010
+ /**
1011
+ * Lightweight conversation reference (O(1) lookup returns URN only, not full details).
1012
+ */
1028
1013
  conversation: FindLinkedInConversationConversation | null;
1029
1014
  messages: Array<FindLinkedInConversationMessage> | null;
1030
1015
  /**
@@ -1049,7 +1034,7 @@ export type GetConversationMessagesRequest = {
1049
1034
  export type GetConversationMessagesSender = {
1050
1035
  firstName: string;
1051
1036
  lastName: string;
1052
- profileUrl: string;
1037
+ profileUrl: string | null;
1053
1038
  headline: string | null;
1054
1039
  profilePicture: string | null;
1055
1040
  };
@@ -1075,7 +1060,7 @@ export type GetConversationMessagesAttachment = {
1075
1060
  };
1076
1061
  export type GetConversationMessagesMessage = {
1077
1062
  messageUrn: string;
1078
- text: string;
1063
+ text: string | null;
1079
1064
  deliveredAt: number;
1080
1065
  senderProfileUrn: string;
1081
1066
  sender: GetConversationMessagesSender;
@@ -1498,12 +1483,6 @@ export type FindLinkedInConversationRequest$Outbound = {
1498
1483
  export declare const FindLinkedInConversationRequest$outboundSchema: z.ZodMiniType<FindLinkedInConversationRequest$Outbound, FindLinkedInConversationRequest>;
1499
1484
  export declare function findLinkedInConversationRequestToJSON(findLinkedInConversationRequest: FindLinkedInConversationRequest): string;
1500
1485
  /** @internal */
1501
- export declare const FindLinkedInConversationParticipant$inboundSchema: z.ZodMiniType<FindLinkedInConversationParticipant, unknown>;
1502
- export declare function findLinkedInConversationParticipantFromJSON(jsonString: string): SafeParseResult<FindLinkedInConversationParticipant, SDKValidationError>;
1503
- /** @internal */
1504
- export declare const FindLinkedInConversationLastMessage$inboundSchema: z.ZodMiniType<FindLinkedInConversationLastMessage, unknown>;
1505
- export declare function findLinkedInConversationLastMessageFromJSON(jsonString: string): SafeParseResult<FindLinkedInConversationLastMessage, SDKValidationError>;
1506
- /** @internal */
1507
1486
  export declare const FindLinkedInConversationConversation$inboundSchema: z.ZodMiniType<FindLinkedInConversationConversation, unknown>;
1508
1487
  export declare function findLinkedInConversationConversationFromJSON(jsonString: string): SafeParseResult<FindLinkedInConversationConversation, SDKValidationError>;
1509
1488
  /** @internal */