bereach 0.1.1 → 0.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/README.md +99 -108
  2. package/esm/lib/config.d.ts +3 -3
  3. package/esm/lib/config.js +3 -3
  4. package/jsr.json +1 -1
  5. package/package.json +5 -1
  6. package/src/lib/config.ts +3 -3
package/README.md CHANGED
@@ -5,11 +5,6 @@ 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
-
13
8
  <!-- Start Summary [summary] -->
14
9
  ## Summary
15
10
 
@@ -40,45 +35,41 @@ BeReach API: BeReach | Unofficial Linkedin API
40
35
  <!-- Start SDK Installation [installation] -->
41
36
  ## SDK Installation
42
37
 
43
- > [!TIP]
44
- > To finish publishing your SDK to npm and others you must [run your first generation action](https://www.speakeasy.com/docs/github-setup#step-by-step-guide).
45
-
46
-
47
38
  The SDK can be installed with either [npm](https://www.npmjs.com/), [pnpm](https://pnpm.io/), [bun](https://bun.sh/) or [yarn](https://classic.yarnpkg.com/en/) package managers.
48
39
 
49
40
  ### NPM
50
41
 
51
42
  ```bash
52
- npm add <UNSET>
43
+ npm add bereach
53
44
  ```
54
45
 
55
46
  ### PNPM
56
47
 
57
48
  ```bash
58
- pnpm add <UNSET>
49
+ pnpm add bereach
59
50
  ```
60
51
 
61
52
  ### Bun
62
53
 
63
54
  ```bash
64
- bun add <UNSET>
55
+ bun add bereach
65
56
  ```
66
57
 
67
58
  ### Yarn
68
59
 
69
60
  ```bash
70
- yarn add <UNSET>
61
+ yarn add bereach
71
62
  ```
72
63
 
73
64
  > [!NOTE]
74
65
  > This package is published as an ES Module (ESM) only. For applications using
75
- > CommonJS, use `await import()` to import and use this package.
66
+ > CommonJS, use `await import("bereach")` to import and use this package.
76
67
  <!-- End SDK Installation [installation] -->
77
68
 
78
69
  <!-- Start Requirements [requirements] -->
79
70
  ## Requirements
80
71
 
81
- For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
72
+ For supported JavaScript runtimes, please consult [RUNTIMES.md](https://github.com/berea-ch/bereach-sdk-ts/blob/main/RUNTIMES.md).
82
73
  <!-- End Requirements [requirements] -->
83
74
 
84
75
  <!-- Start SDK Example Usage [usage] -->
@@ -148,57 +139,57 @@ run();
148
139
  <details open>
149
140
  <summary>Available methods</summary>
150
141
 
151
- ### [Campaigns](docs/sdks/campaigns/README.md)
142
+ ### [Campaigns](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/campaigns/README.md)
152
143
 
153
- * [~~filter~~](docs/sdks/campaigns/README.md#filter) - Check if campaign actions are completed :warning: **Deprecated**
154
- * [getStatus](docs/sdks/campaigns/README.md#getstatus) - Query per-profile action status within a campaign
155
- * [syncActions](docs/sdks/campaigns/README.md#syncactions) - Mark actions as completed without performing them
156
- * [getStats](docs/sdks/campaigns/README.md#getstats) - Get aggregate campaign statistics
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
157
148
 
158
- ### [LinkedinActions](docs/sdks/linkedinactions/README.md)
149
+ ### [LinkedinActions](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/linkedinactions/README.md)
159
150
 
160
- * [connectProfile](docs/sdks/linkedinactions/README.md#connectprofile) - Send LinkedIn connection request
161
- * [listInvitations](docs/sdks/linkedinactions/README.md#listinvitations) - List received LinkedIn connection invitations
162
- * [acceptInvitation](docs/sdks/linkedinactions/README.md#acceptinvitation) - Accept a LinkedIn connection invitation
163
- * [sendMessage](docs/sdks/linkedinactions/README.md#sendmessage) - Send LinkedIn message
164
- * [replyToComment](docs/sdks/linkedinactions/README.md#replytocomment) - Reply to a LinkedIn comment
165
- * [likeComment](docs/sdks/linkedinactions/README.md#likecomment) - Like a LinkedIn comment
166
- * [publishPost](docs/sdks/linkedinactions/README.md#publishpost) - Publish or schedule a LinkedIn post
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
167
158
 
168
- ### [LinkedinChat](docs/sdks/linkedinchat/README.md)
159
+ ### [LinkedinChat](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/linkedinchat/README.md)
169
160
 
170
- * [listConversations](docs/sdks/linkedinchat/README.md#listconversations) - List LinkedIn inbox conversations
171
- * [searchConversations](docs/sdks/linkedinchat/README.md#searchconversations) - Search LinkedIn conversations
172
- * [findConversation](docs/sdks/linkedinchat/README.md#findconversation) - Find a conversation with a specific person
173
- * [getMessages](docs/sdks/linkedinchat/README.md#getmessages) - Read messages from a conversation
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
174
165
 
175
- ### [LinkedinScrapers](docs/sdks/linkedinscrapers/README.md)
166
+ ### [LinkedinScrapers](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/linkedinscrapers/README.md)
176
167
 
177
- * [collectLikes](docs/sdks/linkedinscrapers/README.md#collectlikes) - Scrape LinkedIn post likes
178
- * [collectComments](docs/sdks/linkedinscrapers/README.md#collectcomments) - Scrape LinkedIn post comments
179
- * [collectCommentReplies](docs/sdks/linkedinscrapers/README.md#collectcommentreplies) - Scrape replies to a LinkedIn comment
180
- * [collectPosts](docs/sdks/linkedinscrapers/README.md#collectposts) - Scrape LinkedIn profile posts
181
- * [visitProfile](docs/sdks/linkedinscrapers/README.md#visitprofile) - Visit LinkedIn profile and extract contact data
182
- * [visitCompany](docs/sdks/linkedinscrapers/README.md#visitcompany) - Visit LinkedIn company page and extract profile data
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
183
174
 
184
- ### [LinkedinSearch](docs/sdks/linkedinsearch/README.md)
175
+ ### [LinkedinSearch](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/linkedinsearch/README.md)
185
176
 
186
- * [unifiedSearch](docs/sdks/linkedinsearch/README.md#unifiedsearch) - Unified LinkedIn Search — posts, people, companies, jobs
187
- * [searchPosts](docs/sdks/linkedinsearch/README.md#searchposts) - Search LinkedIn Posts
188
- * [searchPeople](docs/sdks/linkedinsearch/README.md#searchpeople) - Search LinkedIn People
189
- * [searchCompanies](docs/sdks/linkedinsearch/README.md#searchcompanies) - Search LinkedIn Companies
190
- * [searchJobs](docs/sdks/linkedinsearch/README.md#searchjobs) - Search LinkedIn Jobs
191
- * [searchByUrl](docs/sdks/linkedinsearch/README.md#searchbyurl) - Search LinkedIn by URL
192
- * [resolveParameters](docs/sdks/linkedinsearch/README.md#resolveparameters) - Resolve text to LinkedIn search parameter IDs (typeahead)
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)
193
184
 
194
- ### [Profile](docs/sdks/profile/README.md)
185
+ ### [Profile](https://github.com/berea-ch/bereach-sdk-ts/blob/main/docs/sdks/profile/README.md)
195
186
 
196
- * [getLinkedInProfile](docs/sdks/profile/README.md#getlinkedinprofile) - Get authenticated user's LinkedIn profile
197
- * [refresh](docs/sdks/profile/README.md#refresh) - Refresh authenticated user's LinkedIn profile
198
- * [getPosts](docs/sdks/profile/README.md#getposts) - Get authenticated user's LinkedIn posts
199
- * [getFollowers](docs/sdks/profile/README.md#getfollowers) - Get authenticated user's LinkedIn followers
200
- * [getLimits](docs/sdks/profile/README.md#getlimits) - Get current LinkedIn rate limit status
201
- * [getCredits](docs/sdks/profile/README.md#getcredits) - Get current BeReach credit balance
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
202
193
 
203
194
  </details>
204
195
  <!-- End Available Resources and Operations [operations] -->
@@ -212,46 +203,46 @@ runtimes or other environments where application bundle size is a primary
212
203
  concern. When using a bundler to build your application, all unused
213
204
  functionality will be either excluded from the final bundle or tree-shaken away.
214
205
 
215
- To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
206
+ To read more about standalone functions, check [FUNCTIONS.md](https://github.com/berea-ch/bereach-sdk-ts/blob/main/FUNCTIONS.md).
216
207
 
217
208
  <details>
218
209
 
219
210
  <summary>Available standalone functions</summary>
220
211
 
221
- - [`campaignsGetStats`](docs/sdks/campaigns/README.md#getstats) - Get aggregate campaign statistics
222
- - [`campaignsGetStatus`](docs/sdks/campaigns/README.md#getstatus) - Query per-profile action status within a campaign
223
- - [`campaignsSyncActions`](docs/sdks/campaigns/README.md#syncactions) - Mark actions as completed without performing them
224
- - [`linkedinActionsAcceptInvitation`](docs/sdks/linkedinactions/README.md#acceptinvitation) - Accept a LinkedIn connection invitation
225
- - [`linkedinActionsConnectProfile`](docs/sdks/linkedinactions/README.md#connectprofile) - Send LinkedIn connection request
226
- - [`linkedinActionsLikeComment`](docs/sdks/linkedinactions/README.md#likecomment) - Like a LinkedIn comment
227
- - [`linkedinActionsListInvitations`](docs/sdks/linkedinactions/README.md#listinvitations) - List received LinkedIn connection invitations
228
- - [`linkedinActionsPublishPost`](docs/sdks/linkedinactions/README.md#publishpost) - Publish or schedule a LinkedIn post
229
- - [`linkedinActionsReplyToComment`](docs/sdks/linkedinactions/README.md#replytocomment) - Reply to a LinkedIn comment
230
- - [`linkedinActionsSendMessage`](docs/sdks/linkedinactions/README.md#sendmessage) - Send LinkedIn message
231
- - [`linkedinChatFindConversation`](docs/sdks/linkedinchat/README.md#findconversation) - Find a conversation with a specific person
232
- - [`linkedinChatGetMessages`](docs/sdks/linkedinchat/README.md#getmessages) - Read messages from a conversation
233
- - [`linkedinChatListConversations`](docs/sdks/linkedinchat/README.md#listconversations) - List LinkedIn inbox conversations
234
- - [`linkedinChatSearchConversations`](docs/sdks/linkedinchat/README.md#searchconversations) - Search LinkedIn conversations
235
- - [`linkedinScrapersCollectCommentReplies`](docs/sdks/linkedinscrapers/README.md#collectcommentreplies) - Scrape replies to a LinkedIn comment
236
- - [`linkedinScrapersCollectComments`](docs/sdks/linkedinscrapers/README.md#collectcomments) - Scrape LinkedIn post comments
237
- - [`linkedinScrapersCollectLikes`](docs/sdks/linkedinscrapers/README.md#collectlikes) - Scrape LinkedIn post likes
238
- - [`linkedinScrapersCollectPosts`](docs/sdks/linkedinscrapers/README.md#collectposts) - Scrape LinkedIn profile posts
239
- - [`linkedinScrapersVisitCompany`](docs/sdks/linkedinscrapers/README.md#visitcompany) - Visit LinkedIn company page and extract profile data
240
- - [`linkedinScrapersVisitProfile`](docs/sdks/linkedinscrapers/README.md#visitprofile) - Visit LinkedIn profile and extract contact data
241
- - [`linkedinSearchResolveParameters`](docs/sdks/linkedinsearch/README.md#resolveparameters) - Resolve text to LinkedIn search parameter IDs (typeahead)
242
- - [`linkedinSearchSearchByUrl`](docs/sdks/linkedinsearch/README.md#searchbyurl) - Search LinkedIn by URL
243
- - [`linkedinSearchSearchCompanies`](docs/sdks/linkedinsearch/README.md#searchcompanies) - Search LinkedIn Companies
244
- - [`linkedinSearchSearchJobs`](docs/sdks/linkedinsearch/README.md#searchjobs) - Search LinkedIn Jobs
245
- - [`linkedinSearchSearchPeople`](docs/sdks/linkedinsearch/README.md#searchpeople) - Search LinkedIn People
246
- - [`linkedinSearchSearchPosts`](docs/sdks/linkedinsearch/README.md#searchposts) - Search LinkedIn Posts
247
- - [`linkedinSearchUnifiedSearch`](docs/sdks/linkedinsearch/README.md#unifiedsearch) - Unified LinkedIn Search — posts, people, companies, jobs
248
- - [`profileGetCredits`](docs/sdks/profile/README.md#getcredits) - Get current BeReach credit balance
249
- - [`profileGetFollowers`](docs/sdks/profile/README.md#getfollowers) - Get authenticated user's LinkedIn followers
250
- - [`profileGetLimits`](docs/sdks/profile/README.md#getlimits) - Get current LinkedIn rate limit status
251
- - [`profileGetLinkedInProfile`](docs/sdks/profile/README.md#getlinkedinprofile) - Get authenticated user's LinkedIn profile
252
- - [`profileGetPosts`](docs/sdks/profile/README.md#getposts) - Get authenticated user's LinkedIn posts
253
- - [`profileRefresh`](docs/sdks/profile/README.md#refresh) - Refresh authenticated user's LinkedIn profile
254
- - ~~[`campaignsFilter`](docs/sdks/campaigns/README.md#filter)~~ - Check if campaign actions are completed :warning: **Deprecated**
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**
255
246
 
256
247
  </details>
257
248
  <!-- End Standalone functions [standalone-funcs] -->
@@ -330,7 +321,7 @@ run();
330
321
  <!-- Start Error Handling [errors] -->
331
322
  ## Error Handling
332
323
 
333
- [`BereachError`](./src/models/errors/bereach-error.ts) is the base class for all HTTP error responses. It has the following properties:
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:
334
325
 
335
326
  | Property | Type | Description |
336
327
  | ------------------- | ---------- | --------------------------------------------------------------------------------------- |
@@ -382,31 +373,31 @@ run();
382
373
 
383
374
  ### Error Classes
384
375
  **Primary errors:**
385
- * [`BereachError`](./src/models/errors/bereach-error.ts): The base class for HTTP error responses.
386
- * [`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`.
387
- * [`UnauthorizedError`](./src/models/errors/unauthorized-error.ts): Although HTTP specifies "unauthorized", this response means "unauthenticated". Authenticate to continue. Status code `401`.
388
- * [`ForbiddenError`](./src/models/errors/forbidden-error.ts): The client does not have access rights to the content. Status code `403`.
389
- * [`NotFoundError`](./src/models/errors/not-found-error.ts): The server cannot find the requested resource. Status code `404`.
390
- * [`ConflictError`](./src/models/errors/conflict-error.ts): The request conflicts with the current state of the server. Status code `409`.
391
- * [`GoneError`](./src/models/errors/gone-error.ts): The requested content has been permanently deleted from the server. Status code `410`.
392
- * [`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`.
393
- * [`TooManyRequestsError`](./src/models/errors/too-many-requests-error.ts): Rate limit exceeded. Read error.retryAfter for the wait time in seconds. Status code `429`.
394
- * [`InternalServerError`](./src/models/errors/internal-server-error.ts): The server encountered a situation it does not know how to handle. Status code `500`.
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`.
395
386
 
396
387
  <details><summary>Less common errors (6)</summary>
397
388
 
398
389
  <br />
399
390
 
400
391
  **Network errors:**
401
- * [`ConnectionError`](./src/models/errors/http-client-errors.ts): HTTP client was unable to make a request to a server.
402
- * [`RequestTimeoutError`](./src/models/errors/http-client-errors.ts): HTTP request timed out due to an AbortSignal signal.
403
- * [`RequestAbortedError`](./src/models/errors/http-client-errors.ts): HTTP request was aborted by the client.
404
- * [`InvalidRequestError`](./src/models/errors/http-client-errors.ts): Any input used to create a request is invalid.
405
- * [`UnexpectedClientError`](./src/models/errors/http-client-errors.ts): Unrecognised or unexpected error.
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.
406
397
 
407
398
 
408
- **Inherit from [`BereachError`](./src/models/errors/bereach-error.ts)**:
409
- * [`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.
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.
410
401
 
411
402
  </details>
412
403
  <!-- End Error Handling [errors] -->
package/esm/lib/config.d.ts CHANGED
@@ -31,8 +31,8 @@ export declare function serverURLFromOptions(options: SDKOptions): URL | null;
31
31
  export declare const SDK_METADATA: {
32
32
  readonly language: "typescript";
33
33
  readonly openapiDocVersion: "0.0.8";
34
- readonly sdkVersion: "0.1.1";
35
- readonly genVersion: "2.846.1";
36
- readonly userAgent: "speakeasy-sdk/typescript 0.1.1 2.846.1 0.0.8 bereach";
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";
37
37
  };
38
38
  //# sourceMappingURL=config.d.ts.map
package/esm/lib/config.js CHANGED
@@ -27,8 +27,8 @@ export function serverURLFromOptions(options) {
27
27
  export const SDK_METADATA = {
28
28
  language: "typescript",
29
29
  openapiDocVersion: "0.0.8",
30
- sdkVersion: "0.1.1",
31
- genVersion: "2.846.1",
32
- userAgent: "speakeasy-sdk/typescript 0.1.1 2.846.1 0.0.8 bereach",
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",
33
33
  };
34
34
  //# sourceMappingURL=config.js.map
package/jsr.json CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  {
4
4
  "name": "bereach",
5
- "version": "0.1.1",
5
+ "version": "0.1.2",
6
6
  "exports": {
7
7
  ".": "./src/index.ts",
8
8
  "./models/errors": "./src/models/errors/index.ts",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "bereach",
3
- "version": "0.1.1",
3
+ "version": "0.1.2",
4
4
  "author": "Speakeasy",
5
5
  "type": "module",
6
6
  "main": "./esm/index.js",
@@ -43,6 +43,10 @@
43
43
  }
44
44
  },
45
45
  "sideEffects": false,
46
+ "repository": {
47
+ "type": "git",
48
+ "url": "https://github.com/berea-ch/bereach-sdk-ts.git"
49
+ },
46
50
  "scripts": {
47
51
  "lint": "oxlint --max-warnings=0 --deny-warnings 'src/**/*.{ts,tsx}'",
48
52
  "build": "tsgo",
package/src/lib/config.ts CHANGED
@@ -61,7 +61,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
61
61
  export const SDK_METADATA = {
62
62
  language: "typescript",
63
63
  openapiDocVersion: "0.0.8",
64
- sdkVersion: "0.1.1",
65
- genVersion: "2.846.1",
66
- userAgent: "speakeasy-sdk/typescript 0.1.1 2.846.1 0.0.8 bereach",
64
+ sdkVersion: "0.1.2",
65
+ genVersion: "2.846.4",
66
+ userAgent: "speakeasy-sdk/typescript 0.1.2 2.846.4 0.0.8 bereach",
67
67
  } as const;