diff --git a/docs/README.md b/docs/README.md index 5ef2f9f7..f4c90586 100644 --- a/docs/README.md +++ b/docs/README.md @@ -3,7 +3,6 @@ > [Globals](globals.md) # NodeJS LinkedIn API - ![Build](https://github.com/eilonmore/linkedin-private-api/workflows/Build/badge.svg?branch=master) NodeJS Wrapper API for LinkedIn API, written in TypeScript. @@ -16,10 +15,8 @@ npm install linkedin-private-api ``` ## Example usage - Check out [the post](https://codeburst.io/how-i-nailed-a-job-with-this-nodejs-linkedin-bot-6fcada2afbe1) I've written that describes a great example of how to use this library. Also, see a list of examples [here](https://github.com/eilonmore/linkedin-private-api/tree/master/examples). - ```typescript import { Client } from 'linkedin-private-api'; @@ -30,7 +27,7 @@ const password = process.env.PASSWORD as string; // Login const client = new Client(); await client.login.userPass({ username, password }); - + // Search for React development jobs in Israel const jobsScroller = await client.search.searchJobs({ keywords: 'React', @@ -48,32 +45,28 @@ const password = process.env.PASSWORD as string; // Search for profiles and send an invitation const peopleScroller = await client.search.searchPeople({ - keywords: 'Bill Gates', + keywords: 'Bill Gates' }); const [{ profile: billGates }] = await peopleScroller.scrollNext(); - + await client.invitation.sendInvitation({ profileId: billGates.profileId, trackingId: billGates.trackingId, }); - + // Search in my connections const ownConnectionsScroller = await client.search.searchOwnConnections({ keywords: 'Bill Gates', limit: 1 }); const connections = await ownConnectionsScroller.scrollNext(); // Get conversation - const [billConversation] = await client.conversation - .getConversations({ - recipients: billGates.profileId, - }) - .scrollNext(); - - const conversationMessages = await client.message - .getMessages({ - conversationId: billConversation.conversationId, - }) - .scrollNext(); - + const [billConversation] = await client.conversation.getConversations({ + recipients: billGates.profileId + }).scrollNext(); + + const conversationMessages = await client.message.getMessages({ + conversationId: billConversation.conversationId + }).scrollNext() + // Send a message const sentMessage = await client.message.sendMessage({ profileId: billGates.profileId, @@ -83,76 +76,71 @@ const password = process.env.PASSWORD as string; ``` ## API - ### Repositories Classes that expose methods for communicating with linkedin API. -Each repository describes a LinkedIn entity that we can operate on it. Example: `InvitationRepository`. +Each repository describes a LinkedIn entity that we can operate on it. Example: ``InvitationRepository``. -The methods are divided into 3 types: +The methods are divided into 3 types: +* Single entity getters - example: ``conversation.getConversation({ conversationId: CONVERSATION_ID })`` +Single entity getters return a [LinkedIn Entity](#entities). -- Single entity getters - example: `conversation.getConversation({ conversationId: CONVERSATION_ID })` - Single entity getters return a [LinkedIn Entity](#entities). +* Multiple entities getters - for example ``invitation.getSentInvitations({ skip: 10, limit: 5 })`` +Multiple entities getters return a [Scroller](#scrollers). -- Multiple entities getters - for example `invitation.getSentInvitations({ skip: 10, limit: 5 })` - Multiple entities getters return a [Scroller](#scrollers). +* Mutations - for example ``invitation.sendInvitation({ ... })`` +Mutations return a [Response entity](#entities) -- Mutations - for example `invitation.sendInvitation({ ... })` - Mutations return a [Response entity](#entities) +|Name|Example Usage|Docs Reference| +|-|-|-| +|`login`|`client.login.userPass(...)`|[Login Docs](https://github.com/eilonmore/linkedin-private-api/blob/master/docs/classes/_src_core_login_.login.md)| +|`search`|`client.search.searchPeople()`|[Search Docs](https://github.com/eilonmore/linkedin-private-api/blob/master/docs/classes/_src_repositories_search_repository_.searchrepository.md)| +|`profile`|`client.profile.getOwnProfile()`|[Profile Docs](https://github.com/eilonmore/linkedin-private-api/blob/master/docs/classes/_src_repositories_profile_repository_.profilerepository.md)| +|`invitation`|`client.invitation.getReceivedInvitations()`|[Invitation Docs](https://github.com/eilonmore/linkedin-private-api/blob/master/docs/classes/_src_repositories_invitation_repository_.invitationrepository.md)| +|`conversation`|`client.conversation.getConversation(...)`|[Conversation Docs](https://github.com/eilonmore/linkedin-private-api/blob/master/docs/classes/_src_repositories_conversation_repository_.conversationrepository.md)| +|`message`|`client.message.getMessages(...)`|[Message Docs](https://github.com/eilonmore/linkedin-private-api/blob/master/docs/classes/_src_repositories_message_repository_.messagerepository.md)| -| Name | Example Usage | Docs Reference | -| -------------- | -------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `login` | `client.login.userPass(...)` | [Login Docs](https://github.com/eilonmore/linkedin-private-api/blob/master/docs/classes/_src_core_login_.login.md) | -| `search` | `client.search.searchPeople()` | [Search Docs](https://github.com/eilonmore/linkedin-private-api/blob/master/docs/classes/_src_repositories_search_repository_.searchrepository.md) | -| `profile` | `client.profile.getOwnProfile()` | [Profile Docs](https://github.com/eilonmore/linkedin-private-api/blob/master/docs/classes/_src_repositories_profile_repository_.profilerepository.md) | -| `invitation` | `client.invitation.getReceivedInvitations()` | [Invitation Docs](https://github.com/eilonmore/linkedin-private-api/blob/master/docs/classes/_src_repositories_invitation_repository_.invitationrepository.md) | -| `conversation` | `client.conversation.getConversation(...)` | [Conversation Docs](https://github.com/eilonmore/linkedin-private-api/blob/master/docs/classes/_src_repositories_conversation_repository_.conversationrepository.md) | -| `message` | `client.message.getMessages(...)` | [Message Docs](https://github.com/eilonmore/linkedin-private-api/blob/master/docs/classes/_src_repositories_message_repository_.messagerepository.md) | - -### Entities - -Interfaces that describe LinkedIn objects. For example - `Conversation` object. +### Entities +Interfaces that describe LinkedIn objects. For example - ``Conversation`` object. Most of those entities contain the properties returned from the LinkedIn response and in addition to these properties, the API adds some extra properties to make the usage a bit easier. The full list of entities can be found [here](https://github.com/eilonmore/linkedin-private-api/blob/master/docs/modules/_src_entities_index_.md#attributetext), this is the list of the most important ones: -| Entities | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [Profile](https://github.com/eilonmore/linkedin-private-api/blob/master/docs/interfaces/_src_entities_profile_entity_.profile.md) | -| [MiniProfile](https://github.com/eilonmore/linkedin-private-api/blob/master/docs/interfaces/_src_entities_mini_profile_entity_.miniprofile.md) | -| [MiniCompany](https://github.com/eilonmore/linkedin-private-api/blob/conversation-id/docs/interfaces/_src_entities_mini_company_entity_.minicompany.md) | -| [Invitation](https://github.com/eilonmore/linkedin-private-api/blob/master/docs/interfaces/_src_entities_invitation_entity_.invitation.md) | -| [Conversation](https://github.com/eilonmore/linkedin-private-api/blob/master/docs/interfaces/_src_entities_conversation_entity_.conversation.md) | -| [Message](https://github.com/eilonmore/linkedin-private-api/blob/master/docs/interfaces/_src_entities_message_event_entity_.messageevent.md) | -| [CompanySearchHit](https://github.com/eilonmore/linkedin-private-api/blob/master/docs/interfaces/_src_entities_company_search_hit_entity_.companysearchhit.md) | -| [PeopleSearchHit](https://github.com/eilonmore/linkedin-private-api/blob/master/docs/interfaces/_src_entities_people_search_hit_entity_.peoplesearchhit.md) | -| [MessageCreateResponse](https://github.com/eilonmore/linkedin-private-api/blob/master/docs/interfaces/_src_entities_message_create_response_entity_.messageeventcreateresponse.md) | +|Entities| +|-| +|[Profile](https://github.com/eilonmore/linkedin-private-api/blob/master/docs/interfaces/_src_entities_profile_entity_.profile.md)| +|[MiniProfile](https://github.com/eilonmore/linkedin-private-api/blob/master/docs/interfaces/_src_entities_mini_profile_entity_.miniprofile.md)| +|[MiniCompany](https://github.com/eilonmore/linkedin-private-api/blob/conversation-id/docs/interfaces/_src_entities_mini_company_entity_.minicompany.md)| +|[Invitation](https://github.com/eilonmore/linkedin-private-api/blob/master/docs/interfaces/_src_entities_invitation_entity_.invitation.md)| +|[Conversation](https://github.com/eilonmore/linkedin-private-api/blob/master/docs/interfaces/_src_entities_conversation_entity_.conversation.md)| +|[Message](https://github.com/eilonmore/linkedin-private-api/blob/master/docs/interfaces/_src_entities_message_event_entity_.messageevent.md)| +|[CompanySearchHit](https://github.com/eilonmore/linkedin-private-api/blob/master/docs/interfaces/_src_entities_company_search_hit_entity_.companysearchhit.md)| +|[PeopleSearchHit](https://github.com/eilonmore/linkedin-private-api/blob/master/docs/interfaces/_src_entities_people_search_hit_entity_.peoplesearchhit.md)| +|[JobSearchHit](https://github.com/eilonmore/linkedin-private-api/blob/master/docs/modules/_src_entities_job_search_hit_entity_.md)| +|[MessageCreateResponse](https://github.com/eilonmore/linkedin-private-api/blob/master/docs/interfaces/_src_entities_message_create_response_entity_.messageeventcreateresponse.md)| ### Scrollers +Wrapper classes that enable a convenient work with paginated responses. For example - ``PeopleScroller``. +Most of LinkedIn requests return paginated responses, (just like in the UI), scrollers just provide a structured way to navigate between pages. -Wrapper classes that enable a convenient work with paginated responses. For example - `PeopleScroller`. -Most of LinkedIn requests return paginated responses, (just like in the UI), scrollers just provide a structured way to navigate between pages. - -There are two types of scrollers: - -- **Index scroller** - Accepts 2 properties: - `skip (number)` - Starting index (How many entities to skip). - `limit (number)` - How many entities to fetch on each iteration. +There are two types of scrollers: +* **Index scroller** - Accepts 2 properties: +``skip (number)`` - Starting index (How many entities to skip). +``limit (number)`` - How many entities to fetch on each iteration. -- **Time scrollers** - Accepts one property: - `createdBefore (Date)` - Defines the point of time to start fetching entities. +* **Time scrollers** - Accepts one property: +``createdBefore (Date)`` - Defines the point of time to start fetching entities. Example: - ```typescript // index scroller -let companiesScroller = client.search.searchCompanies(); +let companiesScroller = client.search.searchCompanies(); let companies = await companiesScroller.scrollNext(); // returns first page with 10 results companies = await companiesScroller.scrollNext(); // next page companies = await companiesScroller.scrollBack(); // previous page // overriding skip and limit -companiesScroller = client.search.searchCompanies({ skip: 100, limit: 1 }); +companiesScroller = client.search.searchCompanies({ skip: 100, limit: 1 }); companies = await companiesScroller.scrollNext(); // returns first page with 1 results companies = await companiesScroller.scrollNext(); // next page companies = await companiesScroller.scrollBack(); // previous page @@ -161,28 +149,25 @@ companies = await companiesScroller.scrollBack(); // previous page const twoDaysAgo = moment().subtract(2, 'days').toDate(); let messagesScroller = client.message.getMessages({ conversationId: CONVERSATION_ID, - createdBefore: twoDaysAgo, + createdBefore: twoDaysAgo }); messages = await companiesScroller.scrollNext(); ``` ## What's coming next? - **A lot!** This is a new project, and as such, there's a lot that need to be done. Some new features that I expect to develop soon: +* Media support - fetch, like, comment and create a new post. +* Invitation improvements - be able to do some more actions like "remove connection". +* Improve login API +* Add services so automate common workflows -- Media support - fetch, like, comment and create a new post. -- Invitation improvements - be able to do some more actions like "remove connection". -- Improve login API -- Add services so automate common workflows - -Want a specific feature? Please open a feature request :) +Want a specific feature? Please open a feature request :) Also, i'll be more than happy to welcome new contributors to this project. ## Legal - This code is in no way affiliated with, authorized, maintained, sponsored or endorsed by Linkedin or any of its affiliates or subsidiaries. This is an independent and unofficial API. Use at your own risk. Note that using this API might cause your account being banned. diff --git a/docs/classes/_src_core_client_.client.md b/docs/classes/_src_core_client_.client.md index 445d3877..c305cb69 100644 --- a/docs/classes/_src_core_client_.client.md +++ b/docs/classes/_src_core_client_.client.md @@ -6,72 +6,92 @@ ## Hierarchy -- **Client** +* **Client** ## Index +### Constructors + +* [constructor](_src_core_client_.client.md#constructor) + ### Properties -- [conversation](_src_core_client_.client.md#conversation) -- [invitation](_src_core_client_.client.md#invitation) -- [login](_src_core_client_.client.md#login) -- [message](_src_core_client_.client.md#message) -- [profile](_src_core_client_.client.md#profile) -- [request](_src_core_client_.client.md#request) -- [search](_src_core_client_.client.md#search) +* [conversation](_src_core_client_.client.md#conversation) +* [invitation](_src_core_client_.client.md#invitation) +* [login](_src_core_client_.client.md#login) +* [message](_src_core_client_.client.md#message) +* [profile](_src_core_client_.client.md#profile) +* [request](_src_core_client_.client.md#request) +* [search](_src_core_client_.client.md#search) + +## Constructors + +### constructor + +\+ **new Client**(`__namedParameters?`: { proxy: undefined \| AxiosProxyConfig }): [Client](_src_core_client_.client.md) + +*Defined in [src/core/client.ts:18](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/core/client.ts#L18)* + +#### Parameters: + +Name | Type | Default value | +------ | ------ | ------ | +`__namedParameters` | { proxy: undefined \| AxiosProxyConfig } | {} | + +**Returns:** [Client](_src_core_client_.client.md) ## Properties ### conversation -• **conversation**: [ConversationRepository](_src_repositories_conversation_repository_.conversationrepository.md) = new ConversationRepository({ client: this }) +• **conversation**: [ConversationRepository](_src_repositories_conversation_repository_.conversationrepository.md) = new ConversationRepository({ client: this }) -_Defined in [src/core/client.ts:22](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/core/client.ts#L22)_ +*Defined in [src/core/client.ts:32](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/core/client.ts#L32)* ---- +___ ### invitation -• **invitation**: [InvitationRepository](_src_repositories_invitation_repository_.invitationrepository.md) = new InvitationRepository({ client: this }) +• **invitation**: [InvitationRepository](_src_repositories_invitation_repository_.invitationrepository.md) = new InvitationRepository({ client: this }) -_Defined in [src/core/client.ts:18](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/core/client.ts#L18)_ +*Defined in [src/core/client.ts:28](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/core/client.ts#L28)* ---- +___ ### login -• **login**: [Login](_src_core_login_.login.md) = new Login({ client: this }) +• **login**: [Login](_src_core_login_.login.md) = new Login({ client: this }) -_Defined in [src/core/client.ts:14](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/core/client.ts#L14)_ +*Defined in [src/core/client.ts:24](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/core/client.ts#L24)* ---- +___ ### message -• **message**: [MessageRepository](_src_repositories_message_repository_.messagerepository.md) = new MessageRepository({ client: this }) +• **message**: [MessageRepository](_src_repositories_message_repository_.messagerepository.md) = new MessageRepository({ client: this }) -_Defined in [src/core/client.ts:24](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/core/client.ts#L24)_ +*Defined in [src/core/client.ts:34](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/core/client.ts#L34)* ---- +___ ### profile -• **profile**: [ProfileRepository](_src_repositories_profile_repository_.profilerepository.md) = new ProfileRepository({ client: this }) +• **profile**: [ProfileRepository](_src_repositories_profile_repository_.profilerepository.md) = new ProfileRepository({ client: this }) -_Defined in [src/core/client.ts:20](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/core/client.ts#L20)_ +*Defined in [src/core/client.ts:30](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/core/client.ts#L30)* ---- +___ ### request -• **request**: [LinkedInRequest](_src_core_linkedin_request_.linkedinrequest.md) = new LinkedInRequest() +• **request**: [LinkedInRequest](_src_core_linkedin_request_.linkedinrequest.md) -_Defined in [src/core/client.ts:12](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/core/client.ts#L12)_ +*Defined in [src/core/client.ts:18](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/core/client.ts#L18)* ---- +___ ### search -• **search**: [SearchRepository](_src_repositories_search_repository_.searchrepository.md) = new SearchRepository({ client: this }) +• **search**: [SearchRepository](_src_repositories_search_repository_.searchrepository.md) = new SearchRepository({ client: this }) -_Defined in [src/core/client.ts:16](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/core/client.ts#L16)_ +*Defined in [src/core/client.ts:26](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/core/client.ts#L26)* diff --git a/docs/classes/_src_core_linkedin_request_.linkedinrequest.md b/docs/classes/_src_core_linkedin_request_.linkedinrequest.md index 4f69a85a..7820ceb9 100644 --- a/docs/classes/_src_core_linkedin_request_.linkedinrequest.md +++ b/docs/classes/_src_core_linkedin_request_.linkedinrequest.md @@ -6,7 +6,7 @@ ## Hierarchy -- [Request](_src_core_request_.request.md) +* [Request](_src_core_request_.request.md) ↳ **LinkedInRequest** @@ -14,33 +14,39 @@ ### Constructors -- [constructor](_src_core_linkedin_request_.linkedinrequest.md#constructor) +* [constructor](_src_core_linkedin_request_.linkedinrequest.md#constructor) ### Properties -- [auth](_src_core_linkedin_request_.linkedinrequest.md#auth) -- [conversation](_src_core_linkedin_request_.linkedinrequest.md#conversation) -- [invitation](_src_core_linkedin_request_.linkedinrequest.md#invitation) -- [message](_src_core_linkedin_request_.linkedinrequest.md#message) -- [profile](_src_core_linkedin_request_.linkedinrequest.md#profile) -- [request](_src_core_linkedin_request_.linkedinrequest.md#request) -- [search](_src_core_linkedin_request_.linkedinrequest.md#search) +* [auth](_src_core_linkedin_request_.linkedinrequest.md#auth) +* [conversation](_src_core_linkedin_request_.linkedinrequest.md#conversation) +* [invitation](_src_core_linkedin_request_.linkedinrequest.md#invitation) +* [message](_src_core_linkedin_request_.linkedinrequest.md#message) +* [profile](_src_core_linkedin_request_.linkedinrequest.md#profile) +* [request](_src_core_linkedin_request_.linkedinrequest.md#request) +* [search](_src_core_linkedin_request_.linkedinrequest.md#search) ### Methods -- [get](_src_core_linkedin_request_.linkedinrequest.md#get) -- [post](_src_core_linkedin_request_.linkedinrequest.md#post) -- [setHeaders](_src_core_linkedin_request_.linkedinrequest.md#setheaders) +* [get](_src_core_linkedin_request_.linkedinrequest.md#get) +* [post](_src_core_linkedin_request_.linkedinrequest.md#post) +* [setHeaders](_src_core_linkedin_request_.linkedinrequest.md#setheaders) ## Constructors ### constructor -\+ **new LinkedInRequest**(): [LinkedInRequest](_src_core_linkedin_request_.linkedinrequest.md) +\+ **new LinkedInRequest**(`__namedParameters?`: { proxy: undefined \| AxiosProxyConfig }): [LinkedInRequest](_src_core_linkedin_request_.linkedinrequest.md) -_Inherited from [Request](_src_core_request_.request.md).[constructor](_src_core_request_.request.md#constructor)_ +*Inherited from [Request](_src_core_request_.request.md).[constructor](_src_core_request_.request.md#constructor)* -_Defined in [src/core/request.ts:13](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/core/request.ts#L13)_ +*Defined in [src/core/request.ts:17](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/core/request.ts#L17)* + +#### Parameters: + +Name | Type | Default value | +------ | ------ | ------ | +`__namedParameters` | { proxy: undefined \| AxiosProxyConfig } | {} | **Returns:** [LinkedInRequest](_src_core_linkedin_request_.linkedinrequest.md) @@ -48,59 +54,59 @@ _Defined in [src/core/request.ts:13](https://github.com/eilonmore/linkedin-priva ### auth -• **auth**: AuthRequest = new AuthRequest({ request: this }) +• **auth**: AuthRequest = new AuthRequest({ request: this }) -_Defined in [src/core/linkedin-request.ts:20](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/core/linkedin-request.ts#L20)_ +*Defined in [src/core/linkedin-request.ts:20](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/core/linkedin-request.ts#L20)* ---- +___ ### conversation -• **conversation**: ConversationRequest = new ConversationRequest({ request: this }) +• **conversation**: ConversationRequest = new ConversationRequest({ request: this }) -_Defined in [src/core/linkedin-request.ts:10](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/core/linkedin-request.ts#L10)_ +*Defined in [src/core/linkedin-request.ts:10](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/core/linkedin-request.ts#L10)* ---- +___ ### invitation -• **invitation**: InvitationRequest = new InvitationRequest({ request: this }) +• **invitation**: InvitationRequest = new InvitationRequest({ request: this }) -_Defined in [src/core/linkedin-request.ts:12](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/core/linkedin-request.ts#L12)_ +*Defined in [src/core/linkedin-request.ts:12](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/core/linkedin-request.ts#L12)* ---- +___ ### message -• **message**: MessageRequest = new MessageRequest({ request: this }) +• **message**: MessageRequest = new MessageRequest({ request: this }) -_Defined in [src/core/linkedin-request.ts:14](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/core/linkedin-request.ts#L14)_ +*Defined in [src/core/linkedin-request.ts:14](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/core/linkedin-request.ts#L14)* ---- +___ ### profile -• **profile**: ProfileRequest = new ProfileRequest({ request: this }) +• **profile**: ProfileRequest = new ProfileRequest({ request: this }) -_Defined in [src/core/linkedin-request.ts:16](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/core/linkedin-request.ts#L16)_ +*Defined in [src/core/linkedin-request.ts:16](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/core/linkedin-request.ts#L16)* ---- +___ ### request -• **request**: AxiosInstance +• **request**: AxiosInstance -_Inherited from [Request](_src_core_request_.request.md).[request](_src_core_request_.request.md#request)_ +*Inherited from [Request](_src_core_request_.request.md).[request](_src_core_request_.request.md#request)* -_Defined in [src/core/request.ts:13](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/core/request.ts#L13)_ +*Defined in [src/core/request.ts:17](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/core/request.ts#L17)* ---- +___ ### search -• **search**: SearchRequest = new SearchRequest({ request: this }) +• **search**: SearchRequest = new SearchRequest({ request: this }) -_Defined in [src/core/linkedin-request.ts:18](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/core/linkedin-request.ts#L18)_ +*Defined in [src/core/linkedin-request.ts:18](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/core/linkedin-request.ts#L18)* ## Methods @@ -108,108 +114,108 @@ _Defined in [src/core/linkedin-request.ts:18](https://github.com/eilonmore/linke ▸ **get**(`url`: string, `reqConfig?`: ConfigNonFullResponse): Promise -_Inherited from [Request](_src_core_request_.request.md).[get](_src_core_request_.request.md#get)_ +*Inherited from [Request](_src_core_request_.request.md).[get](_src_core_request_.request.md#get)* -_Defined in [src/core/request.ts:26](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/core/request.ts#L26)_ +*Defined in [src/core/request.ts:31](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/core/request.ts#L31)* #### Type parameters: -| Name | -| ---- | -| `T` | +Name | +------ | +`T` | #### Parameters: -| Name | Type | -| ------------ | --------------------- | -| `url` | string | -| `reqConfig?` | ConfigNonFullResponse | +Name | Type | +------ | ------ | +`url` | string | +`reqConfig?` | ConfigNonFullResponse | **Returns:** Promise ▸ **get**(`url`: string, `reqConfig?`: ConfigFullResponse): Promise\> -_Inherited from [Request](_src_core_request_.request.md).[get](_src_core_request_.request.md#get)_ +*Inherited from [Request](_src_core_request_.request.md).[get](_src_core_request_.request.md#get)* -_Defined in [src/core/request.ts:27](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/core/request.ts#L27)_ +*Defined in [src/core/request.ts:32](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/core/request.ts#L32)* #### Type parameters: -| Name | -| ---- | -| `T` | +Name | +------ | +`T` | #### Parameters: -| Name | Type | -| ------------ | ------------------ | -| `url` | string | -| `reqConfig?` | ConfigFullResponse | +Name | Type | +------ | ------ | +`url` | string | +`reqConfig?` | ConfigFullResponse | **Returns:** Promise\> ---- +___ ### post ▸ **post**(`url`: string, `data`: string \| Record, `reqConfig?`: ConfigNonFullResponse): Promise -_Inherited from [Request](_src_core_request_.request.md).[post](_src_core_request_.request.md#post)_ +*Inherited from [Request](_src_core_request_.request.md).[post](_src_core_request_.request.md#post)* -_Defined in [src/core/request.ts:34](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/core/request.ts#L34)_ +*Defined in [src/core/request.ts:39](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/core/request.ts#L39)* #### Type parameters: -| Name | -| ---- | -| `T` | +Name | +------ | +`T` | #### Parameters: -| Name | Type | -| ------------ | ---------------------------------- | -| `url` | string | -| `data` | string \| Record | -| `reqConfig?` | ConfigNonFullResponse | +Name | Type | +------ | ------ | +`url` | string | +`data` | string \| Record | +`reqConfig?` | ConfigNonFullResponse | **Returns:** Promise ▸ **post**(`url`: string, `data`: string \| Record, `reqConfig?`: ConfigFullResponse): Promise\> -_Inherited from [Request](_src_core_request_.request.md).[post](_src_core_request_.request.md#post)_ +*Inherited from [Request](_src_core_request_.request.md).[post](_src_core_request_.request.md#post)* -_Defined in [src/core/request.ts:35](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/core/request.ts#L35)_ +*Defined in [src/core/request.ts:40](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/core/request.ts#L40)* #### Type parameters: -| Name | -| ---- | -| `T` | +Name | +------ | +`T` | #### Parameters: -| Name | Type | -| ------------ | ---------------------------------- | -| `url` | string | -| `data` | string \| Record | -| `reqConfig?` | ConfigFullResponse | +Name | Type | +------ | ------ | +`url` | string | +`data` | string \| Record | +`reqConfig?` | ConfigFullResponse | **Returns:** Promise\> ---- +___ ### setHeaders ▸ **setHeaders**(`headers`: Record): void -_Inherited from [Request](_src_core_request_.request.md).[setHeaders](_src_core_request_.request.md#setheaders)_ +*Inherited from [Request](_src_core_request_.request.md).[setHeaders](_src_core_request_.request.md#setheaders)* -_Defined in [src/core/request.ts:22](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/core/request.ts#L22)_ +*Defined in [src/core/request.ts:27](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/core/request.ts#L27)* #### Parameters: -| Name | Type | -| --------- | ----------------------- | -| `headers` | Record | +Name | Type | +------ | ------ | +`headers` | Record | **Returns:** void diff --git a/docs/classes/_src_core_login_.login.md b/docs/classes/_src_core_login_.login.md index a74e40eb..c1459334 100644 --- a/docs/classes/_src_core_login_.login.md +++ b/docs/classes/_src_core_login_.login.md @@ -6,32 +6,32 @@ ## Hierarchy -- **Login** +* **Login** ## Index ### Constructors -- [constructor](_src_core_login_.login.md#constructor) +* [constructor](_src_core_login_.login.md#constructor) ### Methods -- [userCookie](_src_core_login_.login.md#usercookie) -- [userPass](_src_core_login_.login.md#userpass) +* [userCookie](_src_core_login_.login.md#usercookie) +* [userPass](_src_core_login_.login.md#userpass) ## Constructors ### constructor -\+ **new Login**(`__namedParameters`: { client: [Client](_src_core_client_.client.md) }): [Login](_src_core_login_.login.md) +\+ **new Login**(`__namedParameters`: { client: [Client](_src_core_client_.client.md) }): [Login](_src_core_login_.login.md) -_Defined in [src/core/login.ts:22](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/core/login.ts#L22)_ +*Defined in [src/core/login.ts:22](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/core/login.ts#L22)* #### Parameters: -| Name | Type | -| ------------------- | ------------------------------------------------- | -| `__namedParameters` | { client: [Client](_src_core_client_.client.md) } | +Name | Type | +------ | ------ | +`__namedParameters` | { client: [Client](_src_core_client_.client.md) } | **Returns:** [Login](_src_core_login_.login.md) @@ -39,30 +39,30 @@ _Defined in [src/core/login.ts:22](https://github.com/eilonmore/linkedin-private ### userCookie -▸ **userCookie**(`__namedParameters`: { cookies: { JSESSIONID: string ; li*at?: undefined \| string } ; useCache: boolean = true; username: undefined \| string }): Promise<[Client](\_src_core_client*.client.md)\> +▸ **userCookie**(`__namedParameters`: { cookies: { JSESSIONID: string ; li_at?: undefined \| string } ; useCache: boolean = true; username: undefined \| string }): Promise<[Client](_src_core_client_.client.md)\> -_Defined in [src/core/login.ts:112](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/core/login.ts#L112)_ +*Defined in [src/core/login.ts:112](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/core/login.ts#L112)* #### Parameters: -| Name | Type | -| ------------------- | --------------------------------------------------------------------------------------------------------------------------- | -| `__namedParameters` | { cookies: { JSESSIONID: string ; li_at?: undefined \| string } ; useCache: boolean = true; username: undefined \| string } | +Name | Type | +------ | ------ | +`__namedParameters` | { cookies: { JSESSIONID: string ; li_at?: undefined \| string } ; useCache: boolean = true; username: undefined \| string } | **Returns:** Promise<[Client](_src_core_client_.client.md)\> ---- +___ ### userPass -▸ **userPass**(`__namedParameters`: { password: undefined \| string ; useCache: boolean = true; username: string }): Promise<[Client](_src_core_client_.client.md)\> +▸ **userPass**(`__namedParameters`: { password: undefined \| string ; useCache: boolean = true; username: string }): Promise<[Client](_src_core_client_.client.md)\> -_Defined in [src/core/login.ts:79](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/core/login.ts#L79)_ +*Defined in [src/core/login.ts:79](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/core/login.ts#L79)* #### Parameters: -| Name | Type | -| ------------------- | ------------------------------------------------------------------------------ | -| `__namedParameters` | { password: undefined \| string ; useCache: boolean = true; username: string } | +Name | Type | +------ | ------ | +`__namedParameters` | { password: undefined \| string ; useCache: boolean = true; username: string } | **Returns:** Promise<[Client](_src_core_client_.client.md)\> diff --git a/docs/classes/_src_core_request_.request.md b/docs/classes/_src_core_request_.request.md index 59267c8e..cc92211d 100644 --- a/docs/classes/_src_core_request_.request.md +++ b/docs/classes/_src_core_request_.request.md @@ -6,7 +6,7 @@ ## Hierarchy -- **Request** +* **Request** ↳ [LinkedInRequest](_src_core_linkedin_request_.linkedinrequest.md) @@ -14,25 +14,31 @@ ### Constructors -- [constructor](_src_core_request_.request.md#constructor) +* [constructor](_src_core_request_.request.md#constructor) ### Properties -- [request](_src_core_request_.request.md#request) +* [request](_src_core_request_.request.md#request) ### Methods -- [get](_src_core_request_.request.md#get) -- [post](_src_core_request_.request.md#post) -- [setHeaders](_src_core_request_.request.md#setheaders) +* [get](_src_core_request_.request.md#get) +* [post](_src_core_request_.request.md#post) +* [setHeaders](_src_core_request_.request.md#setheaders) ## Constructors ### constructor -\+ **new Request**(): [Request](_src_core_request_.request.md) +\+ **new Request**(`__namedParameters?`: { proxy: undefined \| AxiosProxyConfig }): [Request](_src_core_request_.request.md) -_Defined in [src/core/request.ts:13](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/core/request.ts#L13)_ +*Defined in [src/core/request.ts:17](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/core/request.ts#L17)* + +#### Parameters: + +Name | Type | Default value | +------ | ------ | ------ | +`__namedParameters` | { proxy: undefined \| AxiosProxyConfig } | {} | **Returns:** [Request](_src_core_request_.request.md) @@ -40,9 +46,9 @@ _Defined in [src/core/request.ts:13](https://github.com/eilonmore/linkedin-priva ### request -• **request**: AxiosInstance +• **request**: AxiosInstance -_Defined in [src/core/request.ts:13](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/core/request.ts#L13)_ +*Defined in [src/core/request.ts:17](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/core/request.ts#L17)* ## Methods @@ -50,98 +56,98 @@ _Defined in [src/core/request.ts:13](https://github.com/eilonmore/linkedin-priva ▸ **get**(`url`: string, `reqConfig?`: ConfigNonFullResponse): Promise -_Defined in [src/core/request.ts:26](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/core/request.ts#L26)_ +*Defined in [src/core/request.ts:31](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/core/request.ts#L31)* #### Type parameters: -| Name | -| ---- | -| `T` | +Name | +------ | +`T` | #### Parameters: -| Name | Type | -| ------------ | --------------------- | -| `url` | string | -| `reqConfig?` | ConfigNonFullResponse | +Name | Type | +------ | ------ | +`url` | string | +`reqConfig?` | ConfigNonFullResponse | **Returns:** Promise ▸ **get**(`url`: string, `reqConfig?`: ConfigFullResponse): Promise\> -_Defined in [src/core/request.ts:27](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/core/request.ts#L27)_ +*Defined in [src/core/request.ts:32](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/core/request.ts#L32)* #### Type parameters: -| Name | -| ---- | -| `T` | +Name | +------ | +`T` | #### Parameters: -| Name | Type | -| ------------ | ------------------ | -| `url` | string | -| `reqConfig?` | ConfigFullResponse | +Name | Type | +------ | ------ | +`url` | string | +`reqConfig?` | ConfigFullResponse | **Returns:** Promise\> ---- +___ ### post ▸ **post**(`url`: string, `data`: string \| Record, `reqConfig?`: ConfigNonFullResponse): Promise -_Defined in [src/core/request.ts:34](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/core/request.ts#L34)_ +*Defined in [src/core/request.ts:39](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/core/request.ts#L39)* #### Type parameters: -| Name | -| ---- | -| `T` | +Name | +------ | +`T` | #### Parameters: -| Name | Type | -| ------------ | ---------------------------------- | -| `url` | string | -| `data` | string \| Record | -| `reqConfig?` | ConfigNonFullResponse | +Name | Type | +------ | ------ | +`url` | string | +`data` | string \| Record | +`reqConfig?` | ConfigNonFullResponse | **Returns:** Promise ▸ **post**(`url`: string, `data`: string \| Record, `reqConfig?`: ConfigFullResponse): Promise\> -_Defined in [src/core/request.ts:35](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/core/request.ts#L35)_ +*Defined in [src/core/request.ts:40](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/core/request.ts#L40)* #### Type parameters: -| Name | -| ---- | -| `T` | +Name | +------ | +`T` | #### Parameters: -| Name | Type | -| ------------ | ---------------------------------- | -| `url` | string | -| `data` | string \| Record | -| `reqConfig?` | ConfigFullResponse | +Name | Type | +------ | ------ | +`url` | string | +`data` | string \| Record | +`reqConfig?` | ConfigFullResponse | **Returns:** Promise\> ---- +___ ### setHeaders ▸ **setHeaders**(`headers`: Record): void -_Defined in [src/core/request.ts:22](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/core/request.ts#L22)_ +*Defined in [src/core/request.ts:27](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/core/request.ts#L27)* #### Parameters: -| Name | Type | -| --------- | ----------------------- | -| `headers` | Record | +Name | Type | +------ | ------ | +`headers` | Record | **Returns:** void diff --git a/docs/classes/_src_repositories_conversation_repository_.conversationrepository.md b/docs/classes/_src_repositories_conversation_repository_.conversationrepository.md index 3b367c8a..1a8ea474 100644 --- a/docs/classes/_src_repositories_conversation_repository_.conversationrepository.md +++ b/docs/classes/_src_repositories_conversation_repository_.conversationrepository.md @@ -6,32 +6,33 @@ ## Hierarchy -- **ConversationRepository** +* **ConversationRepository** ## Index ### Constructors -- [constructor](_src_repositories_conversation_repository_.conversationrepository.md#constructor) +* [constructor](_src_repositories_conversation_repository_.conversationrepository.md#constructor) ### Methods -- [getConversation](_src_repositories_conversation_repository_.conversationrepository.md#getconversation) -- [getConversations](_src_repositories_conversation_repository_.conversationrepository.md#getconversations) +* [getConversation](_src_repositories_conversation_repository_.conversationrepository.md#getconversation) +* [getConversations](_src_repositories_conversation_repository_.conversationrepository.md#getconversations) +* [markConversationAsRead](_src_repositories_conversation_repository_.conversationrepository.md#markconversationasread) ## Constructors ### constructor -\+ **new ConversationRepository**(`__namedParameters`: { client: [Client](_src_core_client_.client.md) }): [ConversationRepository](_src_repositories_conversation_repository_.conversationrepository.md) +\+ **new ConversationRepository**(`__namedParameters`: { client: [Client](_src_core_client_.client.md) }): [ConversationRepository](_src_repositories_conversation_repository_.conversationrepository.md) -_Defined in [src/repositories/conversation.repository.ts:36](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/repositories/conversation.repository.ts#L36)_ +*Defined in [src/repositories/conversation.repository.ts:35](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/repositories/conversation.repository.ts#L35)* #### Parameters: -| Name | Type | -| ------------------- | ------------------------------------------------- | -| `__namedParameters` | { client: [Client](_src_core_client_.client.md) } | +Name | Type | +------ | ------ | +`__namedParameters` | { client: [Client](_src_core_client_.client.md) } | **Returns:** [ConversationRepository](_src_repositories_conversation_repository_.conversationrepository.md) @@ -39,30 +40,46 @@ _Defined in [src/repositories/conversation.repository.ts:36](https://github.com/ ### getConversation -▸ **getConversation**(`__namedParameters`: { conversationId: string }): Promise<[Conversation](../interfaces/_src_entities_conversation_entity_.conversation.md)\> +▸ **getConversation**(`__namedParameters`: { conversationId: string }): Promise<[Conversation](../interfaces/_src_entities_conversation_entity_.conversation.md)\> -_Defined in [src/repositories/conversation.repository.ts:42](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/repositories/conversation.repository.ts#L42)_ +*Defined in [src/repositories/conversation.repository.ts:46](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/repositories/conversation.repository.ts#L46)* #### Parameters: -| Name | Type | -| ------------------- | -------------------------- | -| `__namedParameters` | { conversationId: string } | +Name | Type | +------ | ------ | +`__namedParameters` | { conversationId: string } | **Returns:** Promise<[Conversation](../interfaces/_src_entities_conversation_entity_.conversation.md)\> ---- +___ ### getConversations -▸ **getConversations**(`__namedParameters?`: { createdBefore: undefined \| Date ; recipients: undefined \| string \| string[] }): [ConversationScroller](_src_scrollers_conversation_scroller_.conversationscroller.md) +▸ **getConversations**(`__namedParameters?`: { createdBefore: undefined \| Date ; recipients: undefined \| string \| string[] }): [ConversationScroller](_src_scrollers_conversation_scroller_.conversationscroller.md) -_Defined in [src/repositories/conversation.repository.ts:53](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/repositories/conversation.repository.ts#L53)_ +*Defined in [src/repositories/conversation.repository.ts:57](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/repositories/conversation.repository.ts#L57)* #### Parameters: -| Name | Type | Default value | -| ------------------- | ---------------------------------------------------------------------------------- | ------------- | -| `__namedParameters` | { createdBefore: undefined \| Date ; recipients: undefined \| string \| string[] } | {} | +Name | Type | Default value | +------ | ------ | ------ | +`__namedParameters` | { createdBefore: undefined \| Date ; recipients: undefined \| string \| string[] } | {} | **Returns:** [ConversationScroller](_src_scrollers_conversation_scroller_.conversationscroller.md) + +___ + +### markConversationAsRead + +▸ **markConversationAsRead**(`__namedParameters`: { conversationId: string }): Promise<[Conversation](../interfaces/_src_entities_conversation_entity_.conversation.md)\> + +*Defined in [src/repositories/conversation.repository.ts:41](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/repositories/conversation.repository.ts#L41)* + +#### Parameters: + +Name | Type | +------ | ------ | +`__namedParameters` | { conversationId: string } | + +**Returns:** Promise<[Conversation](../interfaces/_src_entities_conversation_entity_.conversation.md)\> diff --git a/docs/classes/_src_repositories_invitation_repository_.invitationrepository.md b/docs/classes/_src_repositories_invitation_repository_.invitationrepository.md index 045c46d5..660e459b 100644 --- a/docs/classes/_src_repositories_invitation_repository_.invitationrepository.md +++ b/docs/classes/_src_repositories_invitation_repository_.invitationrepository.md @@ -6,33 +6,33 @@ ## Hierarchy -- **InvitationRepository** +* **InvitationRepository** ## Index ### Constructors -- [constructor](_src_repositories_invitation_repository_.invitationrepository.md#constructor) +* [constructor](_src_repositories_invitation_repository_.invitationrepository.md#constructor) ### Methods -- [getReceivedInvitations](_src_repositories_invitation_repository_.invitationrepository.md#getreceivedinvitations) -- [getSentInvitations](_src_repositories_invitation_repository_.invitationrepository.md#getsentinvitations) -- [sendInvitation](_src_repositories_invitation_repository_.invitationrepository.md#sendinvitation) +* [getReceivedInvitations](_src_repositories_invitation_repository_.invitationrepository.md#getreceivedinvitations) +* [getSentInvitations](_src_repositories_invitation_repository_.invitationrepository.md#getsentinvitations) +* [sendInvitation](_src_repositories_invitation_repository_.invitationrepository.md#sendinvitation) ## Constructors ### constructor -\+ **new InvitationRepository**(`__namedParameters`: { client: [Client](_src_core_client_.client.md) }): [InvitationRepository](_src_repositories_invitation_repository_.invitationrepository.md) +\+ **new InvitationRepository**(`__namedParameters`: { client: [Client](_src_core_client_.client.md) }): [InvitationRepository](_src_repositories_invitation_repository_.invitationrepository.md) -_Defined in [src/repositories/invitation.repository.ts:37](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/repositories/invitation.repository.ts#L37)_ +*Defined in [src/repositories/invitation.repository.ts:37](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/repositories/invitation.repository.ts#L37)* #### Parameters: -| Name | Type | -| ------------------- | ------------------------------------------------- | -| `__namedParameters` | { client: [Client](_src_core_client_.client.md) } | +Name | Type | +------ | ------ | +`__namedParameters` | { client: [Client](_src_core_client_.client.md) } | **Returns:** [InvitationRepository](_src_repositories_invitation_repository_.invitationrepository.md) @@ -42,44 +42,44 @@ _Defined in [src/repositories/invitation.repository.ts:37](https://github.com/ei ▸ **getReceivedInvitations**(`__namedParameters?`: { limit: number = 100; skip: number = 0 }): [InvitationScroller](_src_scrollers_invitation_scroller_.invitationscroller.md) -_Defined in [src/repositories/invitation.repository.ts:51](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/repositories/invitation.repository.ts#L51)_ +*Defined in [src/repositories/invitation.repository.ts:51](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/repositories/invitation.repository.ts#L51)* #### Parameters: -| Name | Type | Default value | -| ------------------- | ----------------------------------------- | ------------- | -| `__namedParameters` | { limit: number = 100; skip: number = 0 } | {} | +Name | Type | Default value | +------ | ------ | ------ | +`__namedParameters` | { limit: number = 100; skip: number = 0 } | {} | **Returns:** [InvitationScroller](_src_scrollers_invitation_scroller_.invitationscroller.md) ---- +___ ### getSentInvitations ▸ **getSentInvitations**(`__namedParameters?`: { limit: number = 100; skip: number = 0 }): [InvitationScroller](_src_scrollers_invitation_scroller_.invitationscroller.md) -_Defined in [src/repositories/invitation.repository.ts:43](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/repositories/invitation.repository.ts#L43)_ +*Defined in [src/repositories/invitation.repository.ts:43](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/repositories/invitation.repository.ts#L43)* #### Parameters: -| Name | Type | Default value | -| ------------------- | ----------------------------------------- | ------------- | -| `__namedParameters` | { limit: number = 100; skip: number = 0 } | {} | +Name | Type | Default value | +------ | ------ | ------ | +`__namedParameters` | { limit: number = 100; skip: number = 0 } | {} | **Returns:** [InvitationScroller](_src_scrollers_invitation_scroller_.invitationscroller.md) ---- +___ ### sendInvitation -▸ **sendInvitation**(`__namedParameters`: { message: undefined \| string ; profileId: string ; trackingId: string }): Promise<[Invitation](../interfaces/_src_entities_invitation_entity_.invitation.md)\> +▸ **sendInvitation**(`__namedParameters`: { message: undefined \| string ; profileId: string ; trackingId: string }): Promise<[Invitation](../interfaces/_src_entities_invitation_entity_.invitation.md)\> -_Defined in [src/repositories/invitation.repository.ts:59](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/repositories/invitation.repository.ts#L59)_ +*Defined in [src/repositories/invitation.repository.ts:59](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/repositories/invitation.repository.ts#L59)* #### Parameters: -| Name | Type | -| ------------------- | ------------------------------------------------------------------------- | -| `__namedParameters` | { message: undefined \| string ; profileId: string ; trackingId: string } | +Name | Type | +------ | ------ | +`__namedParameters` | { message: undefined \| string ; profileId: string ; trackingId: string } | **Returns:** Promise<[Invitation](../interfaces/_src_entities_invitation_entity_.invitation.md)\> diff --git a/docs/classes/_src_repositories_message_repository_.messagerepository.md b/docs/classes/_src_repositories_message_repository_.messagerepository.md index 4e4e3315..2a2f362a 100644 --- a/docs/classes/_src_repositories_message_repository_.messagerepository.md +++ b/docs/classes/_src_repositories_message_repository_.messagerepository.md @@ -6,32 +6,32 @@ ## Hierarchy -- **MessageRepository** +* **MessageRepository** ## Index ### Constructors -- [constructor](_src_repositories_message_repository_.messagerepository.md#constructor) +* [constructor](_src_repositories_message_repository_.messagerepository.md#constructor) ### Methods -- [getMessages](_src_repositories_message_repository_.messagerepository.md#getmessages) -- [sendMessage](_src_repositories_message_repository_.messagerepository.md#sendmessage) +* [getMessages](_src_repositories_message_repository_.messagerepository.md#getmessages) +* [sendMessage](_src_repositories_message_repository_.messagerepository.md#sendmessage) ## Constructors ### constructor -\+ **new MessageRepository**(`__namedParameters`: { client: [Client](_src_core_client_.client.md) }): [MessageRepository](_src_repositories_message_repository_.messagerepository.md) +\+ **new MessageRepository**(`__namedParameters`: { client: [Client](_src_core_client_.client.md) }): [MessageRepository](_src_repositories_message_repository_.messagerepository.md) -_Defined in [src/repositories/message.repository.ts:18](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/repositories/message.repository.ts#L18)_ +*Defined in [src/repositories/message.repository.ts:18](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/repositories/message.repository.ts#L18)* #### Parameters: -| Name | Type | -| ------------------- | ------------------------------------------------- | -| `__namedParameters` | { client: [Client](_src_core_client_.client.md) } | +Name | Type | +------ | ------ | +`__namedParameters` | { client: [Client](_src_core_client_.client.md) } | **Returns:** [MessageRepository](_src_repositories_message_repository_.messagerepository.md) @@ -39,30 +39,30 @@ _Defined in [src/repositories/message.repository.ts:18](https://github.com/eilon ### getMessages -▸ **getMessages**(`__namedParameters`: { conversationId: string ; createdBefore: undefined \| Date }): [MessageScroller](_src_scrollers_message_scroller_.messagescroller.md) +▸ **getMessages**(`__namedParameters`: { conversationId: string ; createdBefore: undefined \| Date }): [MessageScroller](_src_scrollers_message_scroller_.messagescroller.md) -_Defined in [src/repositories/message.repository.ts:24](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/repositories/message.repository.ts#L24)_ +*Defined in [src/repositories/message.repository.ts:24](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/repositories/message.repository.ts#L24)* #### Parameters: -| Name | Type | -| ------------------- | ------------------------------------------------------------- | -| `__namedParameters` | { conversationId: string ; createdBefore: undefined \| Date } | +Name | Type | +------ | ------ | +`__namedParameters` | { conversationId: string ; createdBefore: undefined \| Date } | **Returns:** [MessageScroller](_src_scrollers_message_scroller_.messagescroller.md) ---- +___ ### sendMessage -▸ **sendMessage**(`__namedParameters`: { profileId: string ; text: string }): Promise<[MessageEventCreateResponse](../interfaces/_src_entities_message_create_response_entity_.messageeventcreateresponse.md)\> +▸ **sendMessage**(`__namedParameters`: { profileId: string ; text: string }): Promise<[MessageEventCreateResponse](../interfaces/_src_entities_message_create_response_entity_.messageeventcreateresponse.md)\> -_Defined in [src/repositories/message.repository.ts:28](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/repositories/message.repository.ts#L28)_ +*Defined in [src/repositories/message.repository.ts:28](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/repositories/message.repository.ts#L28)* #### Parameters: -| Name | Type | -| ------------------- | ------------------------------------ | -| `__namedParameters` | { profileId: string ; text: string } | +Name | Type | +------ | ------ | +`__namedParameters` | { profileId: string ; text: string } | **Returns:** Promise<[MessageEventCreateResponse](../interfaces/_src_entities_message_create_response_entity_.messageeventcreateresponse.md)\> diff --git a/docs/classes/_src_repositories_profile_repository_.profilerepository.md b/docs/classes/_src_repositories_profile_repository_.profilerepository.md index e8fdf12b..1a073aae 100644 --- a/docs/classes/_src_repositories_profile_repository_.profilerepository.md +++ b/docs/classes/_src_repositories_profile_repository_.profilerepository.md @@ -6,32 +6,32 @@ ## Hierarchy -- **ProfileRepository** +* **ProfileRepository** ## Index ### Constructors -- [constructor](_src_repositories_profile_repository_.profilerepository.md#constructor) +* [constructor](_src_repositories_profile_repository_.profilerepository.md#constructor) ### Methods -- [getOwnProfile](_src_repositories_profile_repository_.profilerepository.md#getownprofile) -- [getProfile](_src_repositories_profile_repository_.profilerepository.md#getprofile) +* [getOwnProfile](_src_repositories_profile_repository_.profilerepository.md#getownprofile) +* [getProfile](_src_repositories_profile_repository_.profilerepository.md#getprofile) ## Constructors ### constructor -\+ **new ProfileRepository**(`__namedParameters`: { client: [Client](_src_core_client_.client.md) }): [ProfileRepository](_src_repositories_profile_repository_.profilerepository.md) +\+ **new ProfileRepository**(`__namedParameters`: { client: [Client](_src_core_client_.client.md) }): [ProfileRepository](_src_repositories_profile_repository_.profilerepository.md) -_Defined in [src/repositories/profile.repository.ts:31](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/repositories/profile.repository.ts#L31)_ +*Defined in [src/repositories/profile.repository.ts:31](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/repositories/profile.repository.ts#L31)* #### Parameters: -| Name | Type | -| ------------------- | ------------------------------------------------- | -| `__namedParameters` | { client: [Client](_src_core_client_.client.md) } | +Name | Type | +------ | ------ | +`__namedParameters` | { client: [Client](_src_core_client_.client.md) } | **Returns:** [ProfileRepository](_src_repositories_profile_repository_.profilerepository.md) @@ -41,22 +41,22 @@ _Defined in [src/repositories/profile.repository.ts:31](https://github.com/eilon ▸ **getOwnProfile**(): Promise<[Profile](../interfaces/_src_entities_profile_entity_.profile.md) \| null\> -_Defined in [src/repositories/profile.repository.ts:53](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/repositories/profile.repository.ts#L53)_ +*Defined in [src/repositories/profile.repository.ts:53](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/repositories/profile.repository.ts#L53)* **Returns:** Promise<[Profile](../interfaces/_src_entities_profile_entity_.profile.md) \| null\> ---- +___ ### getProfile -▸ **getProfile**(`__namedParameters`: { publicIdentifier: string }): Promise<[Profile](../interfaces/_src_entities_profile_entity_.profile.md)\> +▸ **getProfile**(`__namedParameters`: { publicIdentifier: string }): Promise<[Profile](../interfaces/_src_entities_profile_entity_.profile.md)\> -_Defined in [src/repositories/profile.repository.ts:37](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/repositories/profile.repository.ts#L37)_ +*Defined in [src/repositories/profile.repository.ts:37](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/repositories/profile.repository.ts#L37)* #### Parameters: -| Name | Type | -| ------------------- | ---------------------------- | -| `__namedParameters` | { publicIdentifier: string } | +Name | Type | +------ | ------ | +`__namedParameters` | { publicIdentifier: string } | **Returns:** Promise<[Profile](../interfaces/_src_entities_profile_entity_.profile.md)\> diff --git a/docs/classes/_src_repositories_search_repository_.searchrepository.md b/docs/classes/_src_repositories_search_repository_.searchrepository.md index ed55b017..5f2d83aa 100644 --- a/docs/classes/_src_repositories_search_repository_.searchrepository.md +++ b/docs/classes/_src_repositories_search_repository_.searchrepository.md @@ -6,39 +6,39 @@ ## Hierarchy -- **SearchRepository** +* **SearchRepository** ## Index ### Constructors -- [constructor](_src_repositories_search_repository_.searchrepository.md#constructor) +* [constructor](_src_repositories_search_repository_.searchrepository.md#constructor) ### Properties -- [client](_src_repositories_search_repository_.searchrepository.md#client) +* [client](_src_repositories_search_repository_.searchrepository.md#client) ### Methods -- [searchCompanies](_src_repositories_search_repository_.searchrepository.md#searchcompanies) -- [searchConnectionsOf](_src_repositories_search_repository_.searchrepository.md#searchconnectionsof) -- [searchJobs](_src_repositories_search_repository_.searchrepository.md#searchjobs) -- [searchOwnConnections](_src_repositories_search_repository_.searchrepository.md#searchownconnections) -- [searchPeople](_src_repositories_search_repository_.searchrepository.md#searchpeople) +* [searchCompanies](_src_repositories_search_repository_.searchrepository.md#searchcompanies) +* [searchConnectionsOf](_src_repositories_search_repository_.searchrepository.md#searchconnectionsof) +* [searchJobs](_src_repositories_search_repository_.searchrepository.md#searchjobs) +* [searchOwnConnections](_src_repositories_search_repository_.searchrepository.md#searchownconnections) +* [searchPeople](_src_repositories_search_repository_.searchrepository.md#searchpeople) ## Constructors ### constructor -\+ **new SearchRepository**(`__namedParameters`: { client: [Client](_src_core_client_.client.md) }): [SearchRepository](_src_repositories_search_repository_.searchrepository.md) +\+ **new SearchRepository**(`__namedParameters`: { client: [Client](_src_core_client_.client.md) }): [SearchRepository](_src_repositories_search_repository_.searchrepository.md) -_Defined in [src/repositories/search.repository.ts:24](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/repositories/search.repository.ts#L24)_ +*Defined in [src/repositories/search.repository.ts:24](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/repositories/search.repository.ts#L24)* #### Parameters: -| Name | Type | -| ------------------- | ------------------------------------------------- | -| `__namedParameters` | { client: [Client](_src_core_client_.client.md) } | +Name | Type | +------ | ------ | +`__namedParameters` | { client: [Client](_src_core_client_.client.md) } | **Returns:** [SearchRepository](_src_repositories_search_repository_.searchrepository.md) @@ -46,9 +46,9 @@ _Defined in [src/repositories/search.repository.ts:24](https://github.com/eilonm ### client -• **client**: [Client](_src_core_client_.client.md) +• **client**: [Client](_src_core_client_.client.md) -_Defined in [src/repositories/search.repository.ts:24](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/repositories/search.repository.ts#L24)_ +*Defined in [src/repositories/search.repository.ts:24](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/repositories/search.repository.ts#L24)* ## Methods @@ -56,76 +56,76 @@ _Defined in [src/repositories/search.repository.ts:24](https://github.com/eilonm ▸ **searchCompanies**(`__namedParameters?`: { keywords: undefined \| string ; limit: number = 10; skip: number = 0 }): [CompanySearchScroller](_src_scrollers_company_search_scroller_.companysearchscroller.md) -_Defined in [src/repositories/search.repository.ts:50](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/repositories/search.repository.ts#L50)_ +*Defined in [src/repositories/search.repository.ts:50](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/repositories/search.repository.ts#L50)* #### Parameters: -| Name | Type | Default value | -| ------------------- | ------------------------------------------------------------------------ | ------------- | -| `__namedParameters` | { keywords: undefined \| string ; limit: number = 10; skip: number = 0 } | {} | +Name | Type | Default value | +------ | ------ | ------ | +`__namedParameters` | { keywords: undefined \| string ; limit: number = 10; skip: number = 0 } | {} | **Returns:** [CompanySearchScroller](_src_scrollers_company_search_scroller_.companysearchscroller.md) ---- +___ ### searchConnectionsOf ▸ **searchConnectionsOf**(`__namedParameters`: { filters: Omit ; keywords: undefined \| string ; limit: number = 10; profileId: string ; skip: number = 0 }): [PeopleSearchScroller](_src_scrollers_people_search_scroller_.peoplesearchscroller.md) -_Defined in [src/repositories/search.repository.ts:87](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/repositories/search.repository.ts#L87)_ +*Defined in [src/repositories/search.repository.ts:87](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/repositories/search.repository.ts#L87)* #### Parameters: -| Name | Type | -| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `__namedParameters` | { filters: Omit ; keywords: undefined \| string ; limit: number = 10; profileId: string ; skip: number = 0 } | +Name | Type | +------ | ------ | +`__namedParameters` | { filters: Omit ; keywords: undefined \| string ; limit: number = 10; profileId: string ; skip: number = 0 } | **Returns:** [PeopleSearchScroller](_src_scrollers_people_search_scroller_.peoplesearchscroller.md) ---- +___ ### searchJobs ▸ **searchJobs**(`__namedParameters?`: { filters: JobSearchFilters ; keywords: undefined \| string ; limit: number = 10; skip: number = 0 }): [JobSearchScroller](_src_scrollers_job_search_scroller_.jobsearchscroller.md) -_Defined in [src/repositories/search.repository.ts:109](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/repositories/search.repository.ts#L109)_ +*Defined in [src/repositories/search.repository.ts:109](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/repositories/search.repository.ts#L109)* #### Parameters: -| Name | Type | Default value | -| ------------------- | ---------------------------------------------------------------------------------------------------- | ------------- | -| `__namedParameters` | { filters: JobSearchFilters ; keywords: undefined \| string ; limit: number = 10; skip: number = 0 } | {} | +Name | Type | Default value | +------ | ------ | ------ | +`__namedParameters` | { filters: JobSearchFilters ; keywords: undefined \| string ; limit: number = 10; skip: number = 0 } | {} | **Returns:** [JobSearchScroller](_src_scrollers_job_search_scroller_.jobsearchscroller.md) ---- +___ ### searchOwnConnections ▸ **searchOwnConnections**(`__namedParameters?`: { filters: Omit ; keywords: undefined \| string ; limit: number = 10; skip: number = 0 }): [PeopleSearchScroller](_src_scrollers_people_search_scroller_.peoplesearchscroller.md) -_Defined in [src/repositories/search.repository.ts:67](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/repositories/search.repository.ts#L67)_ +*Defined in [src/repositories/search.repository.ts:67](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/repositories/search.repository.ts#L67)* #### Parameters: -| Name | Type | Default value | -| ------------------- | --------------------------------------------------------------------------------------------------------------------------- | ------------- | -| `__namedParameters` | { filters: Omit ; keywords: undefined \| string ; limit: number = 10; skip: number = 0 } | {} | +Name | Type | Default value | +------ | ------ | ------ | +`__namedParameters` | { filters: Omit ; keywords: undefined \| string ; limit: number = 10; skip: number = 0 } | {} | **Returns:** [PeopleSearchScroller](_src_scrollers_people_search_scroller_.peoplesearchscroller.md) ---- +___ ### searchPeople ▸ **searchPeople**(`__namedParameters?`: { filters: PeopleSearchFilters ; keywords: undefined \| string ; limit: number = 10; skip: number = 0 }): [PeopleSearchScroller](_src_scrollers_people_search_scroller_.peoplesearchscroller.md) -_Defined in [src/repositories/search.repository.ts:30](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/repositories/search.repository.ts#L30)_ +*Defined in [src/repositories/search.repository.ts:30](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/repositories/search.repository.ts#L30)* #### Parameters: -| Name | Type | Default value | -| ------------------- | ------------------------------------------------------------------------------------------------------- | ------------- | -| `__namedParameters` | { filters: PeopleSearchFilters ; keywords: undefined \| string ; limit: number = 10; skip: number = 0 } | {} | +Name | Type | Default value | +------ | ------ | ------ | +`__namedParameters` | { filters: PeopleSearchFilters ; keywords: undefined \| string ; limit: number = 10; skip: number = 0 } | {} | **Returns:** [PeopleSearchScroller](_src_scrollers_people_search_scroller_.peoplesearchscroller.md) diff --git a/docs/classes/_src_scrollers_company_search_scroller_.companysearchscroller.md b/docs/classes/_src_scrollers_company_search_scroller_.companysearchscroller.md index b881b31d..a511bc29 100644 --- a/docs/classes/_src_scrollers_company_search_scroller_.companysearchscroller.md +++ b/docs/classes/_src_scrollers_company_search_scroller_.companysearchscroller.md @@ -6,7 +6,7 @@ ## Hierarchy -- [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md)<[CompanySearchHit](../interfaces/_src_entities_company_search_hit_entity_.companysearchhit.md)\> +* [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md)<[CompanySearchHit](../interfaces/_src_entities_company_search_hit_entity_.companysearchhit.md)\> ↳ **CompanySearchScroller** @@ -14,21 +14,21 @@ ### Constructors -- [constructor](_src_scrollers_company_search_scroller_.companysearchscroller.md#constructor) +* [constructor](_src_scrollers_company_search_scroller_.companysearchscroller.md#constructor) ### Properties -- [hitEndOfResults](_src_scrollers_company_search_scroller_.companysearchscroller.md#hitendofresults) -- [limit](_src_scrollers_company_search_scroller_.companysearchscroller.md#limit) -- [scrollNextCounter](_src_scrollers_company_search_scroller_.companysearchscroller.md#scrollnextcounter) -- [skip](_src_scrollers_company_search_scroller_.companysearchscroller.md#skip) +* [hitEndOfResults](_src_scrollers_company_search_scroller_.companysearchscroller.md#hitendofresults) +* [limit](_src_scrollers_company_search_scroller_.companysearchscroller.md#limit) +* [scrollNextCounter](_src_scrollers_company_search_scroller_.companysearchscroller.md#scrollnextcounter) +* [skip](_src_scrollers_company_search_scroller_.companysearchscroller.md#skip) ### Methods -- [fetch](_src_scrollers_company_search_scroller_.companysearchscroller.md#fetch) -- [restart](_src_scrollers_company_search_scroller_.companysearchscroller.md#restart) -- [scrollBack](_src_scrollers_company_search_scroller_.companysearchscroller.md#scrollback) -- [scrollNext](_src_scrollers_company_search_scroller_.companysearchscroller.md#scrollnext) +* [fetch](_src_scrollers_company_search_scroller_.companysearchscroller.md#fetch) +* [restart](_src_scrollers_company_search_scroller_.companysearchscroller.md#restart) +* [scrollBack](_src_scrollers_company_search_scroller_.companysearchscroller.md#scrollback) +* [scrollNext](_src_scrollers_company_search_scroller_.companysearchscroller.md#scrollnext) ## Constructors @@ -36,15 +36,15 @@ \+ **new CompanySearchScroller**(`__namedParameters`: { fetchCompanies: FetchCompanies ; keywords: undefined \| string ; limit: number = 10; skip: number = 0 }): [CompanySearchScroller](_src_scrollers_company_search_scroller_.companysearchscroller.md) -_Overrides [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[constructor](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#constructor)_ +*Overrides [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[constructor](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#constructor)* -_Defined in [src/scrollers/company-search.scroller.ts:17](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/scrollers/company-search.scroller.ts#L17)_ +*Defined in [src/scrollers/company-search.scroller.ts:17](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/scrollers/company-search.scroller.ts#L17)* #### Parameters: -| Name | Type | -| ------------------- | --------------------------------------------------------------------------------------------------------- | -| `__namedParameters` | { fetchCompanies: FetchCompanies ; keywords: undefined \| string ; limit: number = 10; skip: number = 0 } | +Name | Type | +------ | ------ | +`__namedParameters` | { fetchCompanies: FetchCompanies ; keywords: undefined \| string ; limit: number = 10; skip: number = 0 } | **Returns:** [CompanySearchScroller](_src_scrollers_company_search_scroller_.companysearchscroller.md) @@ -52,41 +52,41 @@ _Defined in [src/scrollers/company-search.scroller.ts:17](https://github.com/eil ### hitEndOfResults -• **hitEndOfResults**: boolean = false +• **hitEndOfResults**: boolean = false -_Inherited from [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[hitEndOfResults](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#hitendofresults)_ +*Inherited from [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[hitEndOfResults](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#hitendofresults)* -_Defined in [src/scrollers/skip-limit-scroller.ts:10](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/scrollers/skip-limit-scroller.ts#L10)_ +*Defined in [src/scrollers/skip-limit-scroller.ts:10](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/scrollers/skip-limit-scroller.ts#L10)* ---- +___ ### limit -• **limit**: number +• **limit**: number -_Inherited from [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[limit](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#limit)_ +*Inherited from [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[limit](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#limit)* -_Defined in [src/scrollers/skip-limit-scroller.ts:4](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/scrollers/skip-limit-scroller.ts#L4)_ +*Defined in [src/scrollers/skip-limit-scroller.ts:4](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/scrollers/skip-limit-scroller.ts#L4)* ---- +___ ### scrollNextCounter -• **scrollNextCounter**: number = 0 +• **scrollNextCounter**: number = 0 -_Inherited from [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[scrollNextCounter](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#scrollnextcounter)_ +*Inherited from [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[scrollNextCounter](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#scrollnextcounter)* -_Defined in [src/scrollers/skip-limit-scroller.ts:8](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/scrollers/skip-limit-scroller.ts#L8)_ +*Defined in [src/scrollers/skip-limit-scroller.ts:8](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/scrollers/skip-limit-scroller.ts#L8)* ---- +___ ### skip -• **skip**: number +• **skip**: number -_Inherited from [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[skip](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#skip)_ +*Inherited from [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[skip](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#skip)* -_Defined in [src/scrollers/skip-limit-scroller.ts:6](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/scrollers/skip-limit-scroller.ts#L6)_ +*Defined in [src/scrollers/skip-limit-scroller.ts:6](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/scrollers/skip-limit-scroller.ts#L6)* ## Methods @@ -94,44 +94,44 @@ _Defined in [src/scrollers/skip-limit-scroller.ts:6](https://github.com/eilonmor ▸ **fetch**(): Promise<[CompanySearchHit](../interfaces/_src_entities_company_search_hit_entity_.companysearchhit.md)[]\> -_Overrides [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[fetch](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#fetch)_ +*Overrides [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[fetch](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#fetch)* -_Defined in [src/scrollers/company-search.scroller.ts:36](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/scrollers/company-search.scroller.ts#L36)_ +*Defined in [src/scrollers/company-search.scroller.ts:36](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/scrollers/company-search.scroller.ts#L36)* **Returns:** Promise<[CompanySearchHit](../interfaces/_src_entities_company_search_hit_entity_.companysearchhit.md)[]\> ---- +___ ### restart ▸ **restart**(): void -_Inherited from [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[restart](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#restart)_ +*Inherited from [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[restart](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#restart)* -_Defined in [src/scrollers/skip-limit-scroller.ts:55](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/scrollers/skip-limit-scroller.ts#L55)_ +*Defined in [src/scrollers/skip-limit-scroller.ts:55](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/scrollers/skip-limit-scroller.ts#L55)* **Returns:** void ---- +___ ### scrollBack ▸ **scrollBack**(): Promise<[CompanySearchHit](../interfaces/_src_entities_company_search_hit_entity_.companysearchhit.md)[]\> -_Inherited from [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[scrollBack](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#scrollback)_ +*Inherited from [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[scrollBack](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#scrollback)* -_Defined in [src/scrollers/skip-limit-scroller.ts:36](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/scrollers/skip-limit-scroller.ts#L36)_ +*Defined in [src/scrollers/skip-limit-scroller.ts:36](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/scrollers/skip-limit-scroller.ts#L36)* **Returns:** Promise<[CompanySearchHit](../interfaces/_src_entities_company_search_hit_entity_.companysearchhit.md)[]\> ---- +___ ### scrollNext ▸ **scrollNext**(): Promise<[CompanySearchHit](../interfaces/_src_entities_company_search_hit_entity_.companysearchhit.md)[]\> -_Inherited from [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[scrollNext](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#scrollnext)_ +*Inherited from [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[scrollNext](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#scrollnext)* -_Defined in [src/scrollers/skip-limit-scroller.ts:19](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/scrollers/skip-limit-scroller.ts#L19)_ +*Defined in [src/scrollers/skip-limit-scroller.ts:19](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/scrollers/skip-limit-scroller.ts#L19)* **Returns:** Promise<[CompanySearchHit](../interfaces/_src_entities_company_search_hit_entity_.companysearchhit.md)[]\> diff --git a/docs/classes/_src_scrollers_conversation_scroller_.conversationscroller.md b/docs/classes/_src_scrollers_conversation_scroller_.conversationscroller.md index ab1d5949..4e53ad5d 100644 --- a/docs/classes/_src_scrollers_conversation_scroller_.conversationscroller.md +++ b/docs/classes/_src_scrollers_conversation_scroller_.conversationscroller.md @@ -6,7 +6,7 @@ ## Hierarchy -- [CreatedBeforeScroller](_src_scrollers_created_before_scroller_.createdbeforescroller.md)<[Conversation](../interfaces/_src_entities_conversation_entity_.conversation.md)\> +* [CreatedBeforeScroller](_src_scrollers_created_before_scroller_.createdbeforescroller.md)<[Conversation](../interfaces/_src_entities_conversation_entity_.conversation.md)\> ↳ **ConversationScroller** @@ -14,36 +14,36 @@ ### Constructors -- [constructor](_src_scrollers_conversation_scroller_.conversationscroller.md#constructor) +* [constructor](_src_scrollers_conversation_scroller_.conversationscroller.md#constructor) ### Properties -- [createdBefore](_src_scrollers_conversation_scroller_.conversationscroller.md#createdbefore) -- [fieldName](_src_scrollers_conversation_scroller_.conversationscroller.md#fieldname) -- [recipients](_src_scrollers_conversation_scroller_.conversationscroller.md#recipients) +* [createdBefore](_src_scrollers_conversation_scroller_.conversationscroller.md#createdbefore) +* [fieldName](_src_scrollers_conversation_scroller_.conversationscroller.md#fieldname) +* [recipients](_src_scrollers_conversation_scroller_.conversationscroller.md#recipients) ### Methods -- [fetch](_src_scrollers_conversation_scroller_.conversationscroller.md#fetch) -- [restart](_src_scrollers_conversation_scroller_.conversationscroller.md#restart) -- [scrollBack](_src_scrollers_conversation_scroller_.conversationscroller.md#scrollback) -- [scrollNext](_src_scrollers_conversation_scroller_.conversationscroller.md#scrollnext) +* [fetch](_src_scrollers_conversation_scroller_.conversationscroller.md#fetch) +* [restart](_src_scrollers_conversation_scroller_.conversationscroller.md#restart) +* [scrollBack](_src_scrollers_conversation_scroller_.conversationscroller.md#scrollback) +* [scrollNext](_src_scrollers_conversation_scroller_.conversationscroller.md#scrollnext) ## Constructors ### constructor -\+ **new ConversationScroller**(`__namedParameters`: { createdBefore: undefined \| Date ; fetchConversations: FetchConversations ; recipients: undefined \| string \| string[] }): [ConversationScroller](_src_scrollers_conversation_scroller_.conversationscroller.md) +\+ **new ConversationScroller**(`__namedParameters`: { createdBefore: undefined \| Date ; fetchConversations: FetchConversations ; recipients: undefined \| string \| string[] }): [ConversationScroller](_src_scrollers_conversation_scroller_.conversationscroller.md) -_Overrides [CreatedBeforeScroller](_src_scrollers_created_before_scroller_.createdbeforescroller.md).[constructor](_src_scrollers_created_before_scroller_.createdbeforescroller.md#constructor)_ +*Overrides [CreatedBeforeScroller](_src_scrollers_created_before_scroller_.createdbeforescroller.md).[constructor](_src_scrollers_created_before_scroller_.createdbeforescroller.md#constructor)* -_Defined in [src/scrollers/conversation.scroller.ts:19](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/scrollers/conversation.scroller.ts#L19)_ +*Defined in [src/scrollers/conversation.scroller.ts:19](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/scrollers/conversation.scroller.ts#L19)* #### Parameters: -| Name | Type | -| ------------------- | --------------------------------------------------------------------------------------------------------------------------- | -| `__namedParameters` | { createdBefore: undefined \| Date ; fetchConversations: FetchConversations ; recipients: undefined \| string \| string[] } | +Name | Type | +------ | ------ | +`__namedParameters` | { createdBefore: undefined \| Date ; fetchConversations: FetchConversations ; recipients: undefined \| string \| string[] } | **Returns:** [ConversationScroller](_src_scrollers_conversation_scroller_.conversationscroller.md) @@ -53,27 +53,27 @@ _Defined in [src/scrollers/conversation.scroller.ts:19](https://github.com/eilon • `Optional` **createdBefore**: undefined \| number -_Inherited from [CreatedBeforeScroller](_src_scrollers_created_before_scroller_.createdbeforescroller.md).[createdBefore](_src_scrollers_created_before_scroller_.createdbeforescroller.md#createdbefore)_ +*Inherited from [CreatedBeforeScroller](_src_scrollers_created_before_scroller_.createdbeforescroller.md).[createdBefore](_src_scrollers_created_before_scroller_.createdbeforescroller.md#createdbefore)* -_Defined in [src/scrollers/created-before-scroller.ts:4](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/scrollers/created-before-scroller.ts#L4)_ +*Defined in [src/scrollers/created-before-scroller.ts:4](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/scrollers/created-before-scroller.ts#L4)* ---- +___ ### fieldName -• **fieldName**: \"lastActivityAt\" = "lastActivityAt" +• **fieldName**: \"lastActivityAt\" = "lastActivityAt" -_Overrides [CreatedBeforeScroller](_src_scrollers_created_before_scroller_.createdbeforescroller.md).[fieldName](_src_scrollers_created_before_scroller_.createdbeforescroller.md#fieldname)_ +*Overrides [CreatedBeforeScroller](_src_scrollers_created_before_scroller_.createdbeforescroller.md).[fieldName](_src_scrollers_created_before_scroller_.createdbeforescroller.md#fieldname)* -_Defined in [src/scrollers/conversation.scroller.ts:17](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/scrollers/conversation.scroller.ts#L17)_ +*Defined in [src/scrollers/conversation.scroller.ts:17](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/scrollers/conversation.scroller.ts#L17)* ---- +___ ### recipients • `Optional` **recipients**: [ProfileId](../modules/_src_entities_mini_profile_entity_.md#profileid) \| [ProfileId](../modules/_src_entities_mini_profile_entity_.md#profileid)[] -_Defined in [src/scrollers/conversation.scroller.ts:19](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/scrollers/conversation.scroller.ts#L19)_ +*Defined in [src/scrollers/conversation.scroller.ts:19](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/scrollers/conversation.scroller.ts#L19)* ## Methods @@ -81,44 +81,44 @@ _Defined in [src/scrollers/conversation.scroller.ts:19](https://github.com/eilon ▸ **fetch**(): Promise<[Conversation](../interfaces/_src_entities_conversation_entity_.conversation.md)[]\> -_Overrides [CreatedBeforeScroller](_src_scrollers_created_before_scroller_.createdbeforescroller.md).[fetch](_src_scrollers_created_before_scroller_.createdbeforescroller.md#fetch)_ +*Overrides [CreatedBeforeScroller](_src_scrollers_created_before_scroller_.createdbeforescroller.md).[fetch](_src_scrollers_created_before_scroller_.createdbeforescroller.md#fetch)* -_Defined in [src/scrollers/conversation.scroller.ts:37](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/scrollers/conversation.scroller.ts#L37)_ +*Defined in [src/scrollers/conversation.scroller.ts:37](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/scrollers/conversation.scroller.ts#L37)* **Returns:** Promise<[Conversation](../interfaces/_src_entities_conversation_entity_.conversation.md)[]\> ---- +___ ### restart ▸ **restart**(): void -_Inherited from [CreatedBeforeScroller](_src_scrollers_created_before_scroller_.createdbeforescroller.md).[restart](_src_scrollers_created_before_scroller_.createdbeforescroller.md#restart)_ +*Inherited from [CreatedBeforeScroller](_src_scrollers_created_before_scroller_.createdbeforescroller.md).[restart](_src_scrollers_created_before_scroller_.createdbeforescroller.md#restart)* -_Defined in [src/scrollers/created-before-scroller.ts:43](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/scrollers/created-before-scroller.ts#L43)_ +*Defined in [src/scrollers/created-before-scroller.ts:43](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/scrollers/created-before-scroller.ts#L43)* **Returns:** void ---- +___ ### scrollBack ▸ **scrollBack**(): Promise<[Conversation](../interfaces/_src_entities_conversation_entity_.conversation.md)[]\> -_Inherited from [CreatedBeforeScroller](_src_scrollers_created_before_scroller_.createdbeforescroller.md).[scrollBack](_src_scrollers_created_before_scroller_.createdbeforescroller.md#scrollback)_ +*Inherited from [CreatedBeforeScroller](_src_scrollers_created_before_scroller_.createdbeforescroller.md).[scrollBack](_src_scrollers_created_before_scroller_.createdbeforescroller.md#scrollback)* -_Defined in [src/scrollers/created-before-scroller.ts:33](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/scrollers/created-before-scroller.ts#L33)_ +*Defined in [src/scrollers/created-before-scroller.ts:33](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/scrollers/created-before-scroller.ts#L33)* **Returns:** Promise<[Conversation](../interfaces/_src_entities_conversation_entity_.conversation.md)[]\> ---- +___ ### scrollNext ▸ **scrollNext**(): Promise<[Conversation](../interfaces/_src_entities_conversation_entity_.conversation.md)[]\> -_Inherited from [CreatedBeforeScroller](_src_scrollers_created_before_scroller_.createdbeforescroller.md).[scrollNext](_src_scrollers_created_before_scroller_.createdbeforescroller.md#scrollnext)_ +*Inherited from [CreatedBeforeScroller](_src_scrollers_created_before_scroller_.createdbeforescroller.md).[scrollNext](_src_scrollers_created_before_scroller_.createdbeforescroller.md#scrollnext)* -_Defined in [src/scrollers/created-before-scroller.ts:18](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/scrollers/created-before-scroller.ts#L18)_ +*Defined in [src/scrollers/created-before-scroller.ts:18](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/scrollers/created-before-scroller.ts#L18)* **Returns:** Promise<[Conversation](../interfaces/_src_entities_conversation_entity_.conversation.md)[]\> diff --git a/docs/classes/_src_scrollers_created_before_scroller_.createdbeforescroller.md b/docs/classes/_src_scrollers_created_before_scroller_.createdbeforescroller.md index 496b8c22..a78cecfa 100644 --- a/docs/classes/_src_scrollers_created_before_scroller_.createdbeforescroller.md +++ b/docs/classes/_src_scrollers_created_before_scroller_.createdbeforescroller.md @@ -6,13 +6,13 @@ ## Type parameters -| Name | -| ---- | -| `T` | +Name | +------ | +`T` | ## Hierarchy -- **CreatedBeforeScroller** +* **CreatedBeforeScroller** ↳ [ConversationScroller](_src_scrollers_conversation_scroller_.conversationscroller.md) @@ -22,33 +22,33 @@ ### Constructors -- [constructor](_src_scrollers_created_before_scroller_.createdbeforescroller.md#constructor) +* [constructor](_src_scrollers_created_before_scroller_.createdbeforescroller.md#constructor) ### Properties -- [createdBefore](_src_scrollers_created_before_scroller_.createdbeforescroller.md#createdbefore) -- [fieldName](_src_scrollers_created_before_scroller_.createdbeforescroller.md#fieldname) +* [createdBefore](_src_scrollers_created_before_scroller_.createdbeforescroller.md#createdbefore) +* [fieldName](_src_scrollers_created_before_scroller_.createdbeforescroller.md#fieldname) ### Methods -- [fetch](_src_scrollers_created_before_scroller_.createdbeforescroller.md#fetch) -- [restart](_src_scrollers_created_before_scroller_.createdbeforescroller.md#restart) -- [scrollBack](_src_scrollers_created_before_scroller_.createdbeforescroller.md#scrollback) -- [scrollNext](_src_scrollers_created_before_scroller_.createdbeforescroller.md#scrollnext) +* [fetch](_src_scrollers_created_before_scroller_.createdbeforescroller.md#fetch) +* [restart](_src_scrollers_created_before_scroller_.createdbeforescroller.md#restart) +* [scrollBack](_src_scrollers_created_before_scroller_.createdbeforescroller.md#scrollback) +* [scrollNext](_src_scrollers_created_before_scroller_.createdbeforescroller.md#scrollnext) ## Constructors ### constructor -\+ **new CreatedBeforeScroller**(`__namedParameters`: { createdBefore: undefined \| Date }): [CreatedBeforeScroller](_src_scrollers_created_before_scroller_.createdbeforescroller.md) +\+ **new CreatedBeforeScroller**(`__namedParameters`: { createdBefore: undefined \| Date }): [CreatedBeforeScroller](_src_scrollers_created_before_scroller_.createdbeforescroller.md) -_Defined in [src/scrollers/created-before-scroller.ts:10](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/scrollers/created-before-scroller.ts#L10)_ +*Defined in [src/scrollers/created-before-scroller.ts:10](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/scrollers/created-before-scroller.ts#L10)* #### Parameters: -| Name | Type | -| ------------------- | ------------------------------------ | -| `__namedParameters` | { createdBefore: undefined \| Date } | +Name | Type | +------ | ------ | +`__namedParameters` | { createdBefore: undefined \| Date } | **Returns:** [CreatedBeforeScroller](_src_scrollers_created_before_scroller_.createdbeforescroller.md) @@ -58,15 +58,15 @@ _Defined in [src/scrollers/created-before-scroller.ts:10](https://github.com/eil • `Optional` **createdBefore**: undefined \| number -_Defined in [src/scrollers/created-before-scroller.ts:4](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/scrollers/created-before-scroller.ts#L4)_ +*Defined in [src/scrollers/created-before-scroller.ts:4](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/scrollers/created-before-scroller.ts#L4)* ---- +___ ### fieldName • `Abstract` **fieldName**: keyof T -_Defined in [src/scrollers/created-before-scroller.ts:10](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/scrollers/created-before-scroller.ts#L10)_ +*Defined in [src/scrollers/created-before-scroller.ts:10](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/scrollers/created-before-scroller.ts#L10)* ## Methods @@ -74,36 +74,36 @@ _Defined in [src/scrollers/created-before-scroller.ts:10](https://github.com/eil ▸ `Abstract`**fetch**(): Promise -_Defined in [src/scrollers/created-before-scroller.ts:16](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/scrollers/created-before-scroller.ts#L16)_ +*Defined in [src/scrollers/created-before-scroller.ts:16](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/scrollers/created-before-scroller.ts#L16)* **Returns:** Promise ---- +___ ### restart ▸ **restart**(): void -_Defined in [src/scrollers/created-before-scroller.ts:43](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/scrollers/created-before-scroller.ts#L43)_ +*Defined in [src/scrollers/created-before-scroller.ts:43](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/scrollers/created-before-scroller.ts#L43)* **Returns:** void ---- +___ ### scrollBack ▸ **scrollBack**(): Promise -_Defined in [src/scrollers/created-before-scroller.ts:33](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/scrollers/created-before-scroller.ts#L33)_ +*Defined in [src/scrollers/created-before-scroller.ts:33](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/scrollers/created-before-scroller.ts#L33)* **Returns:** Promise ---- +___ ### scrollNext ▸ **scrollNext**(): Promise -_Defined in [src/scrollers/created-before-scroller.ts:18](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/scrollers/created-before-scroller.ts#L18)_ +*Defined in [src/scrollers/created-before-scroller.ts:18](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/scrollers/created-before-scroller.ts#L18)* **Returns:** Promise diff --git a/docs/classes/_src_scrollers_invitation_scroller_.invitationscroller.md b/docs/classes/_src_scrollers_invitation_scroller_.invitationscroller.md index 09c2e4f5..a5776699 100644 --- a/docs/classes/_src_scrollers_invitation_scroller_.invitationscroller.md +++ b/docs/classes/_src_scrollers_invitation_scroller_.invitationscroller.md @@ -6,7 +6,7 @@ ## Hierarchy -- [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md)<[Invitation](../interfaces/_src_entities_invitation_entity_.invitation.md)\> +* [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md)<[Invitation](../interfaces/_src_entities_invitation_entity_.invitation.md)\> ↳ **InvitationScroller** @@ -14,21 +14,21 @@ ### Constructors -- [constructor](_src_scrollers_invitation_scroller_.invitationscroller.md#constructor) +* [constructor](_src_scrollers_invitation_scroller_.invitationscroller.md#constructor) ### Properties -- [hitEndOfResults](_src_scrollers_invitation_scroller_.invitationscroller.md#hitendofresults) -- [limit](_src_scrollers_invitation_scroller_.invitationscroller.md#limit) -- [scrollNextCounter](_src_scrollers_invitation_scroller_.invitationscroller.md#scrollnextcounter) -- [skip](_src_scrollers_invitation_scroller_.invitationscroller.md#skip) +* [hitEndOfResults](_src_scrollers_invitation_scroller_.invitationscroller.md#hitendofresults) +* [limit](_src_scrollers_invitation_scroller_.invitationscroller.md#limit) +* [scrollNextCounter](_src_scrollers_invitation_scroller_.invitationscroller.md#scrollnextcounter) +* [skip](_src_scrollers_invitation_scroller_.invitationscroller.md#skip) ### Methods -- [fetch](_src_scrollers_invitation_scroller_.invitationscroller.md#fetch) -- [restart](_src_scrollers_invitation_scroller_.invitationscroller.md#restart) -- [scrollBack](_src_scrollers_invitation_scroller_.invitationscroller.md#scrollback) -- [scrollNext](_src_scrollers_invitation_scroller_.invitationscroller.md#scrollnext) +* [fetch](_src_scrollers_invitation_scroller_.invitationscroller.md#fetch) +* [restart](_src_scrollers_invitation_scroller_.invitationscroller.md#restart) +* [scrollBack](_src_scrollers_invitation_scroller_.invitationscroller.md#scrollback) +* [scrollNext](_src_scrollers_invitation_scroller_.invitationscroller.md#scrollnext) ## Constructors @@ -36,15 +36,15 @@ \+ **new InvitationScroller**(`__namedParameters`: { fetchInvitations: FetchInvitations ; limit: number = 100; skip: number = 0 }): [InvitationScroller](_src_scrollers_invitation_scroller_.invitationscroller.md) -_Overrides [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[constructor](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#constructor)_ +*Overrides [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[constructor](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#constructor)* -_Defined in [src/scrollers/invitation.scroller.ts:7](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/scrollers/invitation.scroller.ts#L7)_ +*Defined in [src/scrollers/invitation.scroller.ts:7](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/scrollers/invitation.scroller.ts#L7)* #### Parameters: -| Name | Type | -| ------------------- | ------------------------------------------------------------------------------ | -| `__namedParameters` | { fetchInvitations: FetchInvitations ; limit: number = 100; skip: number = 0 } | +Name | Type | +------ | ------ | +`__namedParameters` | { fetchInvitations: FetchInvitations ; limit: number = 100; skip: number = 0 } | **Returns:** [InvitationScroller](_src_scrollers_invitation_scroller_.invitationscroller.md) @@ -52,41 +52,41 @@ _Defined in [src/scrollers/invitation.scroller.ts:7](https://github.com/eilonmor ### hitEndOfResults -• **hitEndOfResults**: boolean = false +• **hitEndOfResults**: boolean = false -_Inherited from [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[hitEndOfResults](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#hitendofresults)_ +*Inherited from [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[hitEndOfResults](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#hitendofresults)* -_Defined in [src/scrollers/skip-limit-scroller.ts:10](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/scrollers/skip-limit-scroller.ts#L10)_ +*Defined in [src/scrollers/skip-limit-scroller.ts:10](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/scrollers/skip-limit-scroller.ts#L10)* ---- +___ ### limit -• **limit**: number +• **limit**: number -_Inherited from [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[limit](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#limit)_ +*Inherited from [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[limit](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#limit)* -_Defined in [src/scrollers/skip-limit-scroller.ts:4](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/scrollers/skip-limit-scroller.ts#L4)_ +*Defined in [src/scrollers/skip-limit-scroller.ts:4](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/scrollers/skip-limit-scroller.ts#L4)* ---- +___ ### scrollNextCounter -• **scrollNextCounter**: number = 0 +• **scrollNextCounter**: number = 0 -_Inherited from [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[scrollNextCounter](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#scrollnextcounter)_ +*Inherited from [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[scrollNextCounter](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#scrollnextcounter)* -_Defined in [src/scrollers/skip-limit-scroller.ts:8](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/scrollers/skip-limit-scroller.ts#L8)_ +*Defined in [src/scrollers/skip-limit-scroller.ts:8](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/scrollers/skip-limit-scroller.ts#L8)* ---- +___ ### skip -• **skip**: number +• **skip**: number -_Inherited from [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[skip](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#skip)_ +*Inherited from [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[skip](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#skip)* -_Defined in [src/scrollers/skip-limit-scroller.ts:6](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/scrollers/skip-limit-scroller.ts#L6)_ +*Defined in [src/scrollers/skip-limit-scroller.ts:6](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/scrollers/skip-limit-scroller.ts#L6)* ## Methods @@ -94,44 +94,44 @@ _Defined in [src/scrollers/skip-limit-scroller.ts:6](https://github.com/eilonmor ▸ **fetch**(): Promise<[Invitation](../interfaces/_src_entities_invitation_entity_.invitation.md)[]\> -_Overrides [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[fetch](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#fetch)_ +*Overrides [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[fetch](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#fetch)* -_Defined in [src/scrollers/invitation.scroller.ts:15](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/scrollers/invitation.scroller.ts#L15)_ +*Defined in [src/scrollers/invitation.scroller.ts:15](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/scrollers/invitation.scroller.ts#L15)* **Returns:** Promise<[Invitation](../interfaces/_src_entities_invitation_entity_.invitation.md)[]\> ---- +___ ### restart ▸ **restart**(): void -_Inherited from [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[restart](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#restart)_ +*Inherited from [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[restart](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#restart)* -_Defined in [src/scrollers/skip-limit-scroller.ts:55](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/scrollers/skip-limit-scroller.ts#L55)_ +*Defined in [src/scrollers/skip-limit-scroller.ts:55](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/scrollers/skip-limit-scroller.ts#L55)* **Returns:** void ---- +___ ### scrollBack ▸ **scrollBack**(): Promise<[Invitation](../interfaces/_src_entities_invitation_entity_.invitation.md)[]\> -_Inherited from [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[scrollBack](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#scrollback)_ +*Inherited from [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[scrollBack](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#scrollback)* -_Defined in [src/scrollers/skip-limit-scroller.ts:36](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/scrollers/skip-limit-scroller.ts#L36)_ +*Defined in [src/scrollers/skip-limit-scroller.ts:36](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/scrollers/skip-limit-scroller.ts#L36)* **Returns:** Promise<[Invitation](../interfaces/_src_entities_invitation_entity_.invitation.md)[]\> ---- +___ ### scrollNext ▸ **scrollNext**(): Promise<[Invitation](../interfaces/_src_entities_invitation_entity_.invitation.md)[]\> -_Inherited from [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[scrollNext](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#scrollnext)_ +*Inherited from [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[scrollNext](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#scrollnext)* -_Defined in [src/scrollers/skip-limit-scroller.ts:19](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/scrollers/skip-limit-scroller.ts#L19)_ +*Defined in [src/scrollers/skip-limit-scroller.ts:19](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/scrollers/skip-limit-scroller.ts#L19)* **Returns:** Promise<[Invitation](../interfaces/_src_entities_invitation_entity_.invitation.md)[]\> diff --git a/docs/classes/_src_scrollers_job_search_scroller_.jobsearchscroller.md b/docs/classes/_src_scrollers_job_search_scroller_.jobsearchscroller.md index 0960f5a9..10ac049e 100644 --- a/docs/classes/_src_scrollers_job_search_scroller_.jobsearchscroller.md +++ b/docs/classes/_src_scrollers_job_search_scroller_.jobsearchscroller.md @@ -6,7 +6,7 @@ ## Hierarchy -- [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md)<[JobSearchHit](../modules/_src_entities_job_search_hit_entity_.md#jobsearchhit)\> +* [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md)<[JobSearchHit](../modules/_src_entities_job_search_hit_entity_.md#jobsearchhit)\> ↳ **JobSearchScroller** @@ -14,21 +14,21 @@ ### Constructors -- [constructor](_src_scrollers_job_search_scroller_.jobsearchscroller.md#constructor) +* [constructor](_src_scrollers_job_search_scroller_.jobsearchscroller.md#constructor) ### Properties -- [hitEndOfResults](_src_scrollers_job_search_scroller_.jobsearchscroller.md#hitendofresults) -- [limit](_src_scrollers_job_search_scroller_.jobsearchscroller.md#limit) -- [scrollNextCounter](_src_scrollers_job_search_scroller_.jobsearchscroller.md#scrollnextcounter) -- [skip](_src_scrollers_job_search_scroller_.jobsearchscroller.md#skip) +* [hitEndOfResults](_src_scrollers_job_search_scroller_.jobsearchscroller.md#hitendofresults) +* [limit](_src_scrollers_job_search_scroller_.jobsearchscroller.md#limit) +* [scrollNextCounter](_src_scrollers_job_search_scroller_.jobsearchscroller.md#scrollnextcounter) +* [skip](_src_scrollers_job_search_scroller_.jobsearchscroller.md#skip) ### Methods -- [fetch](_src_scrollers_job_search_scroller_.jobsearchscroller.md#fetch) -- [restart](_src_scrollers_job_search_scroller_.jobsearchscroller.md#restart) -- [scrollBack](_src_scrollers_job_search_scroller_.jobsearchscroller.md#scrollback) -- [scrollNext](_src_scrollers_job_search_scroller_.jobsearchscroller.md#scrollnext) +* [fetch](_src_scrollers_job_search_scroller_.jobsearchscroller.md#fetch) +* [restart](_src_scrollers_job_search_scroller_.jobsearchscroller.md#restart) +* [scrollBack](_src_scrollers_job_search_scroller_.jobsearchscroller.md#scrollback) +* [scrollNext](_src_scrollers_job_search_scroller_.jobsearchscroller.md#scrollnext) ## Constructors @@ -36,15 +36,15 @@ \+ **new JobSearchScroller**(`__namedParameters`: { fetchJobs: FetchJobs ; filters: undefined \| JobSearchFilters ; keywords: undefined \| string ; limit: number = 10; skip: number = 0 }): [JobSearchScroller](_src_scrollers_job_search_scroller_.jobsearchscroller.md) -_Overrides [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[constructor](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#constructor)_ +*Overrides [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[constructor](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#constructor)* -_Defined in [src/scrollers/job-search.scroller.ts:22](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/scrollers/job-search.scroller.ts#L22)_ +*Defined in [src/scrollers/job-search.scroller.ts:22](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/scrollers/job-search.scroller.ts#L22)* #### Parameters: -| Name | Type | -| ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `__namedParameters` | { fetchJobs: FetchJobs ; filters: undefined \| JobSearchFilters ; keywords: undefined \| string ; limit: number = 10; skip: number = 0 } | +Name | Type | +------ | ------ | +`__namedParameters` | { fetchJobs: FetchJobs ; filters: undefined \| JobSearchFilters ; keywords: undefined \| string ; limit: number = 10; skip: number = 0 } | **Returns:** [JobSearchScroller](_src_scrollers_job_search_scroller_.jobsearchscroller.md) @@ -52,41 +52,41 @@ _Defined in [src/scrollers/job-search.scroller.ts:22](https://github.com/eilonmo ### hitEndOfResults -• **hitEndOfResults**: boolean = false +• **hitEndOfResults**: boolean = false -_Inherited from [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[hitEndOfResults](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#hitendofresults)_ +*Inherited from [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[hitEndOfResults](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#hitendofresults)* -_Defined in [src/scrollers/skip-limit-scroller.ts:10](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/scrollers/skip-limit-scroller.ts#L10)_ +*Defined in [src/scrollers/skip-limit-scroller.ts:10](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/scrollers/skip-limit-scroller.ts#L10)* ---- +___ ### limit -• **limit**: number +• **limit**: number -_Inherited from [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[limit](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#limit)_ +*Inherited from [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[limit](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#limit)* -_Defined in [src/scrollers/skip-limit-scroller.ts:4](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/scrollers/skip-limit-scroller.ts#L4)_ +*Defined in [src/scrollers/skip-limit-scroller.ts:4](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/scrollers/skip-limit-scroller.ts#L4)* ---- +___ ### scrollNextCounter -• **scrollNextCounter**: number = 0 +• **scrollNextCounter**: number = 0 -_Inherited from [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[scrollNextCounter](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#scrollnextcounter)_ +*Inherited from [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[scrollNextCounter](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#scrollnextcounter)* -_Defined in [src/scrollers/skip-limit-scroller.ts:8](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/scrollers/skip-limit-scroller.ts#L8)_ +*Defined in [src/scrollers/skip-limit-scroller.ts:8](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/scrollers/skip-limit-scroller.ts#L8)* ---- +___ ### skip -• **skip**: number +• **skip**: number -_Inherited from [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[skip](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#skip)_ +*Inherited from [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[skip](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#skip)* -_Defined in [src/scrollers/skip-limit-scroller.ts:6](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/scrollers/skip-limit-scroller.ts#L6)_ +*Defined in [src/scrollers/skip-limit-scroller.ts:6](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/scrollers/skip-limit-scroller.ts#L6)* ## Methods @@ -94,44 +94,44 @@ _Defined in [src/scrollers/skip-limit-scroller.ts:6](https://github.com/eilonmor ▸ **fetch**(): Promise<[JobSearchHit](../modules/_src_entities_job_search_hit_entity_.md#jobsearchhit)[]\> -_Overrides [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[fetch](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#fetch)_ +*Overrides [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[fetch](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#fetch)* -_Defined in [src/scrollers/job-search.scroller.ts:44](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/scrollers/job-search.scroller.ts#L44)_ +*Defined in [src/scrollers/job-search.scroller.ts:44](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/scrollers/job-search.scroller.ts#L44)* **Returns:** Promise<[JobSearchHit](../modules/_src_entities_job_search_hit_entity_.md#jobsearchhit)[]\> ---- +___ ### restart ▸ **restart**(): void -_Inherited from [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[restart](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#restart)_ +*Inherited from [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[restart](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#restart)* -_Defined in [src/scrollers/skip-limit-scroller.ts:55](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/scrollers/skip-limit-scroller.ts#L55)_ +*Defined in [src/scrollers/skip-limit-scroller.ts:55](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/scrollers/skip-limit-scroller.ts#L55)* **Returns:** void ---- +___ ### scrollBack ▸ **scrollBack**(): Promise<[JobSearchHit](../modules/_src_entities_job_search_hit_entity_.md#jobsearchhit)[]\> -_Inherited from [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[scrollBack](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#scrollback)_ +*Inherited from [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[scrollBack](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#scrollback)* -_Defined in [src/scrollers/skip-limit-scroller.ts:36](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/scrollers/skip-limit-scroller.ts#L36)_ +*Defined in [src/scrollers/skip-limit-scroller.ts:36](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/scrollers/skip-limit-scroller.ts#L36)* **Returns:** Promise<[JobSearchHit](../modules/_src_entities_job_search_hit_entity_.md#jobsearchhit)[]\> ---- +___ ### scrollNext ▸ **scrollNext**(): Promise<[JobSearchHit](../modules/_src_entities_job_search_hit_entity_.md#jobsearchhit)[]\> -_Inherited from [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[scrollNext](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#scrollnext)_ +*Inherited from [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[scrollNext](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#scrollnext)* -_Defined in [src/scrollers/skip-limit-scroller.ts:19](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/scrollers/skip-limit-scroller.ts#L19)_ +*Defined in [src/scrollers/skip-limit-scroller.ts:19](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/scrollers/skip-limit-scroller.ts#L19)* **Returns:** Promise<[JobSearchHit](../modules/_src_entities_job_search_hit_entity_.md#jobsearchhit)[]\> diff --git a/docs/classes/_src_scrollers_message_scroller_.messagescroller.md b/docs/classes/_src_scrollers_message_scroller_.messagescroller.md index d8681787..3a3941e9 100644 --- a/docs/classes/_src_scrollers_message_scroller_.messagescroller.md +++ b/docs/classes/_src_scrollers_message_scroller_.messagescroller.md @@ -6,7 +6,7 @@ ## Hierarchy -- [CreatedBeforeScroller](_src_scrollers_created_before_scroller_.createdbeforescroller.md)<[MessageEvent](../interfaces/_src_entities_message_event_entity_.messageevent.md)\> +* [CreatedBeforeScroller](_src_scrollers_created_before_scroller_.createdbeforescroller.md)<[MessageEvent](../interfaces/_src_entities_message_event_entity_.messageevent.md)\> ↳ **MessageScroller** @@ -14,35 +14,35 @@ ### Constructors -- [constructor](_src_scrollers_message_scroller_.messagescroller.md#constructor) +* [constructor](_src_scrollers_message_scroller_.messagescroller.md#constructor) ### Properties -- [createdBefore](_src_scrollers_message_scroller_.messagescroller.md#createdbefore) -- [fieldName](_src_scrollers_message_scroller_.messagescroller.md#fieldname) +* [createdBefore](_src_scrollers_message_scroller_.messagescroller.md#createdbefore) +* [fieldName](_src_scrollers_message_scroller_.messagescroller.md#fieldname) ### Methods -- [fetch](_src_scrollers_message_scroller_.messagescroller.md#fetch) -- [restart](_src_scrollers_message_scroller_.messagescroller.md#restart) -- [scrollBack](_src_scrollers_message_scroller_.messagescroller.md#scrollback) -- [scrollNext](_src_scrollers_message_scroller_.messagescroller.md#scrollnext) +* [fetch](_src_scrollers_message_scroller_.messagescroller.md#fetch) +* [restart](_src_scrollers_message_scroller_.messagescroller.md#restart) +* [scrollBack](_src_scrollers_message_scroller_.messagescroller.md#scrollback) +* [scrollNext](_src_scrollers_message_scroller_.messagescroller.md#scrollnext) ## Constructors ### constructor -\+ **new MessageScroller**(`__namedParameters`: { conversationId: string ; createdBefore: undefined \| Date ; fetchMessages: FetchMessages }): [MessageScroller](_src_scrollers_message_scroller_.messagescroller.md) +\+ **new MessageScroller**(`__namedParameters`: { conversationId: string ; createdBefore: undefined \| Date ; fetchMessages: FetchMessages }): [MessageScroller](_src_scrollers_message_scroller_.messagescroller.md) -_Overrides [CreatedBeforeScroller](_src_scrollers_created_before_scroller_.createdbeforescroller.md).[constructor](_src_scrollers_created_before_scroller_.createdbeforescroller.md#constructor)_ +*Overrides [CreatedBeforeScroller](_src_scrollers_created_before_scroller_.createdbeforescroller.md).[constructor](_src_scrollers_created_before_scroller_.createdbeforescroller.md#constructor)* -_Defined in [src/scrollers/message.scroller.ts:20](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/scrollers/message.scroller.ts#L20)_ +*Defined in [src/scrollers/message.scroller.ts:20](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/scrollers/message.scroller.ts#L20)* #### Parameters: -| Name | Type | -| ------------------- | -------------------------------------------------------------------------------------------- | -| `__namedParameters` | { conversationId: string ; createdBefore: undefined \| Date ; fetchMessages: FetchMessages } | +Name | Type | +------ | ------ | +`__namedParameters` | { conversationId: string ; createdBefore: undefined \| Date ; fetchMessages: FetchMessages } | **Returns:** [MessageScroller](_src_scrollers_message_scroller_.messagescroller.md) @@ -52,19 +52,19 @@ _Defined in [src/scrollers/message.scroller.ts:20](https://github.com/eilonmore/ • `Optional` **createdBefore**: undefined \| number -_Inherited from [CreatedBeforeScroller](_src_scrollers_created_before_scroller_.createdbeforescroller.md).[createdBefore](_src_scrollers_created_before_scroller_.createdbeforescroller.md#createdbefore)_ +*Inherited from [CreatedBeforeScroller](_src_scrollers_created_before_scroller_.createdbeforescroller.md).[createdBefore](_src_scrollers_created_before_scroller_.createdbeforescroller.md#createdbefore)* -_Defined in [src/scrollers/created-before-scroller.ts:4](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/scrollers/created-before-scroller.ts#L4)_ +*Defined in [src/scrollers/created-before-scroller.ts:4](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/scrollers/created-before-scroller.ts#L4)* ---- +___ ### fieldName -• **fieldName**: \"createdAt\" = "createdAt" +• **fieldName**: \"createdAt\" = "createdAt" -_Overrides [CreatedBeforeScroller](_src_scrollers_created_before_scroller_.createdbeforescroller.md).[fieldName](_src_scrollers_created_before_scroller_.createdbeforescroller.md#fieldname)_ +*Overrides [CreatedBeforeScroller](_src_scrollers_created_before_scroller_.createdbeforescroller.md).[fieldName](_src_scrollers_created_before_scroller_.createdbeforescroller.md#fieldname)* -_Defined in [src/scrollers/message.scroller.ts:20](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/scrollers/message.scroller.ts#L20)_ +*Defined in [src/scrollers/message.scroller.ts:20](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/scrollers/message.scroller.ts#L20)* ## Methods @@ -72,44 +72,44 @@ _Defined in [src/scrollers/message.scroller.ts:20](https://github.com/eilonmore/ ▸ **fetch**(): Promise<[MessageEvent](../interfaces/_src_entities_message_event_entity_.messageevent.md)[]\> -_Overrides [CreatedBeforeScroller](_src_scrollers_created_before_scroller_.createdbeforescroller.md).[fetch](_src_scrollers_created_before_scroller_.createdbeforescroller.md#fetch)_ +*Overrides [CreatedBeforeScroller](_src_scrollers_created_before_scroller_.createdbeforescroller.md).[fetch](_src_scrollers_created_before_scroller_.createdbeforescroller.md#fetch)* -_Defined in [src/scrollers/message.scroller.ts:37](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/scrollers/message.scroller.ts#L37)_ +*Defined in [src/scrollers/message.scroller.ts:37](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/scrollers/message.scroller.ts#L37)* **Returns:** Promise<[MessageEvent](../interfaces/_src_entities_message_event_entity_.messageevent.md)[]\> ---- +___ ### restart ▸ **restart**(): void -_Inherited from [CreatedBeforeScroller](_src_scrollers_created_before_scroller_.createdbeforescroller.md).[restart](_src_scrollers_created_before_scroller_.createdbeforescroller.md#restart)_ +*Inherited from [CreatedBeforeScroller](_src_scrollers_created_before_scroller_.createdbeforescroller.md).[restart](_src_scrollers_created_before_scroller_.createdbeforescroller.md#restart)* -_Defined in [src/scrollers/created-before-scroller.ts:43](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/scrollers/created-before-scroller.ts#L43)_ +*Defined in [src/scrollers/created-before-scroller.ts:43](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/scrollers/created-before-scroller.ts#L43)* **Returns:** void ---- +___ ### scrollBack ▸ **scrollBack**(): Promise<[MessageEvent](../interfaces/_src_entities_message_event_entity_.messageevent.md)[]\> -_Inherited from [CreatedBeforeScroller](_src_scrollers_created_before_scroller_.createdbeforescroller.md).[scrollBack](_src_scrollers_created_before_scroller_.createdbeforescroller.md#scrollback)_ +*Inherited from [CreatedBeforeScroller](_src_scrollers_created_before_scroller_.createdbeforescroller.md).[scrollBack](_src_scrollers_created_before_scroller_.createdbeforescroller.md#scrollback)* -_Defined in [src/scrollers/created-before-scroller.ts:33](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/scrollers/created-before-scroller.ts#L33)_ +*Defined in [src/scrollers/created-before-scroller.ts:33](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/scrollers/created-before-scroller.ts#L33)* **Returns:** Promise<[MessageEvent](../interfaces/_src_entities_message_event_entity_.messageevent.md)[]\> ---- +___ ### scrollNext ▸ **scrollNext**(): Promise<[MessageEvent](../interfaces/_src_entities_message_event_entity_.messageevent.md)[]\> -_Inherited from [CreatedBeforeScroller](_src_scrollers_created_before_scroller_.createdbeforescroller.md).[scrollNext](_src_scrollers_created_before_scroller_.createdbeforescroller.md#scrollnext)_ +*Inherited from [CreatedBeforeScroller](_src_scrollers_created_before_scroller_.createdbeforescroller.md).[scrollNext](_src_scrollers_created_before_scroller_.createdbeforescroller.md#scrollnext)* -_Defined in [src/scrollers/created-before-scroller.ts:18](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/scrollers/created-before-scroller.ts#L18)_ +*Defined in [src/scrollers/created-before-scroller.ts:18](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/scrollers/created-before-scroller.ts#L18)* **Returns:** Promise<[MessageEvent](../interfaces/_src_entities_message_event_entity_.messageevent.md)[]\> diff --git a/docs/classes/_src_scrollers_people_search_scroller_.peoplesearchscroller.md b/docs/classes/_src_scrollers_people_search_scroller_.peoplesearchscroller.md index 5ecec0ca..d9b5bea1 100644 --- a/docs/classes/_src_scrollers_people_search_scroller_.peoplesearchscroller.md +++ b/docs/classes/_src_scrollers_people_search_scroller_.peoplesearchscroller.md @@ -6,7 +6,7 @@ ## Hierarchy -- [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md)<[PeopleSearchHit](../interfaces/_src_entities_people_search_hit_entity_.peoplesearchhit.md)\> +* [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md)<[PeopleSearchHit](../interfaces/_src_entities_people_search_hit_entity_.peoplesearchhit.md)\> ↳ **PeopleSearchScroller** @@ -14,21 +14,21 @@ ### Constructors -- [constructor](_src_scrollers_people_search_scroller_.peoplesearchscroller.md#constructor) +* [constructor](_src_scrollers_people_search_scroller_.peoplesearchscroller.md#constructor) ### Properties -- [hitEndOfResults](_src_scrollers_people_search_scroller_.peoplesearchscroller.md#hitendofresults) -- [limit](_src_scrollers_people_search_scroller_.peoplesearchscroller.md#limit) -- [scrollNextCounter](_src_scrollers_people_search_scroller_.peoplesearchscroller.md#scrollnextcounter) -- [skip](_src_scrollers_people_search_scroller_.peoplesearchscroller.md#skip) +* [hitEndOfResults](_src_scrollers_people_search_scroller_.peoplesearchscroller.md#hitendofresults) +* [limit](_src_scrollers_people_search_scroller_.peoplesearchscroller.md#limit) +* [scrollNextCounter](_src_scrollers_people_search_scroller_.peoplesearchscroller.md#scrollnextcounter) +* [skip](_src_scrollers_people_search_scroller_.peoplesearchscroller.md#skip) ### Methods -- [fetch](_src_scrollers_people_search_scroller_.peoplesearchscroller.md#fetch) -- [restart](_src_scrollers_people_search_scroller_.peoplesearchscroller.md#restart) -- [scrollBack](_src_scrollers_people_search_scroller_.peoplesearchscroller.md#scrollback) -- [scrollNext](_src_scrollers_people_search_scroller_.peoplesearchscroller.md#scrollnext) +* [fetch](_src_scrollers_people_search_scroller_.peoplesearchscroller.md#fetch) +* [restart](_src_scrollers_people_search_scroller_.peoplesearchscroller.md#restart) +* [scrollBack](_src_scrollers_people_search_scroller_.peoplesearchscroller.md#scrollback) +* [scrollNext](_src_scrollers_people_search_scroller_.peoplesearchscroller.md#scrollnext) ## Constructors @@ -36,15 +36,15 @@ \+ **new PeopleSearchScroller**(`__namedParameters`: { fetchPeople: FetchPeople ; filters: undefined \| PeopleSearchFilters ; keywords: undefined \| string ; limit: number = 10; skip: number = 0 }): [PeopleSearchScroller](_src_scrollers_people_search_scroller_.peoplesearchscroller.md) -_Overrides [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[constructor](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#constructor)_ +*Overrides [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[constructor](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#constructor)* -_Defined in [src/scrollers/people-search.scroller.ts:22](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/scrollers/people-search.scroller.ts#L22)_ +*Defined in [src/scrollers/people-search.scroller.ts:22](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/scrollers/people-search.scroller.ts#L22)* #### Parameters: -| Name | Type | -| ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | -| `__namedParameters` | { fetchPeople: FetchPeople ; filters: undefined \| PeopleSearchFilters ; keywords: undefined \| string ; limit: number = 10; skip: number = 0 } | +Name | Type | +------ | ------ | +`__namedParameters` | { fetchPeople: FetchPeople ; filters: undefined \| PeopleSearchFilters ; keywords: undefined \| string ; limit: number = 10; skip: number = 0 } | **Returns:** [PeopleSearchScroller](_src_scrollers_people_search_scroller_.peoplesearchscroller.md) @@ -52,41 +52,41 @@ _Defined in [src/scrollers/people-search.scroller.ts:22](https://github.com/eilo ### hitEndOfResults -• **hitEndOfResults**: boolean = false +• **hitEndOfResults**: boolean = false -_Inherited from [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[hitEndOfResults](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#hitendofresults)_ +*Inherited from [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[hitEndOfResults](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#hitendofresults)* -_Defined in [src/scrollers/skip-limit-scroller.ts:10](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/scrollers/skip-limit-scroller.ts#L10)_ +*Defined in [src/scrollers/skip-limit-scroller.ts:10](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/scrollers/skip-limit-scroller.ts#L10)* ---- +___ ### limit -• **limit**: number +• **limit**: number -_Inherited from [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[limit](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#limit)_ +*Inherited from [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[limit](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#limit)* -_Defined in [src/scrollers/skip-limit-scroller.ts:4](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/scrollers/skip-limit-scroller.ts#L4)_ +*Defined in [src/scrollers/skip-limit-scroller.ts:4](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/scrollers/skip-limit-scroller.ts#L4)* ---- +___ ### scrollNextCounter -• **scrollNextCounter**: number = 0 +• **scrollNextCounter**: number = 0 -_Inherited from [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[scrollNextCounter](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#scrollnextcounter)_ +*Inherited from [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[scrollNextCounter](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#scrollnextcounter)* -_Defined in [src/scrollers/skip-limit-scroller.ts:8](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/scrollers/skip-limit-scroller.ts#L8)_ +*Defined in [src/scrollers/skip-limit-scroller.ts:8](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/scrollers/skip-limit-scroller.ts#L8)* ---- +___ ### skip -• **skip**: number +• **skip**: number -_Inherited from [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[skip](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#skip)_ +*Inherited from [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[skip](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#skip)* -_Defined in [src/scrollers/skip-limit-scroller.ts:6](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/scrollers/skip-limit-scroller.ts#L6)_ +*Defined in [src/scrollers/skip-limit-scroller.ts:6](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/scrollers/skip-limit-scroller.ts#L6)* ## Methods @@ -94,44 +94,44 @@ _Defined in [src/scrollers/skip-limit-scroller.ts:6](https://github.com/eilonmor ▸ **fetch**(): Promise<[PeopleSearchHit](../interfaces/_src_entities_people_search_hit_entity_.peoplesearchhit.md)[]\> -_Overrides [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[fetch](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#fetch)_ +*Overrides [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[fetch](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#fetch)* -_Defined in [src/scrollers/people-search.scroller.ts:44](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/scrollers/people-search.scroller.ts#L44)_ +*Defined in [src/scrollers/people-search.scroller.ts:44](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/scrollers/people-search.scroller.ts#L44)* **Returns:** Promise<[PeopleSearchHit](../interfaces/_src_entities_people_search_hit_entity_.peoplesearchhit.md)[]\> ---- +___ ### restart ▸ **restart**(): void -_Inherited from [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[restart](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#restart)_ +*Inherited from [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[restart](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#restart)* -_Defined in [src/scrollers/skip-limit-scroller.ts:55](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/scrollers/skip-limit-scroller.ts#L55)_ +*Defined in [src/scrollers/skip-limit-scroller.ts:55](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/scrollers/skip-limit-scroller.ts#L55)* **Returns:** void ---- +___ ### scrollBack ▸ **scrollBack**(): Promise<[PeopleSearchHit](../interfaces/_src_entities_people_search_hit_entity_.peoplesearchhit.md)[]\> -_Inherited from [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[scrollBack](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#scrollback)_ +*Inherited from [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[scrollBack](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#scrollback)* -_Defined in [src/scrollers/skip-limit-scroller.ts:36](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/scrollers/skip-limit-scroller.ts#L36)_ +*Defined in [src/scrollers/skip-limit-scroller.ts:36](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/scrollers/skip-limit-scroller.ts#L36)* **Returns:** Promise<[PeopleSearchHit](../interfaces/_src_entities_people_search_hit_entity_.peoplesearchhit.md)[]\> ---- +___ ### scrollNext ▸ **scrollNext**(): Promise<[PeopleSearchHit](../interfaces/_src_entities_people_search_hit_entity_.peoplesearchhit.md)[]\> -_Inherited from [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[scrollNext](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#scrollnext)_ +*Inherited from [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md).[scrollNext](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#scrollnext)* -_Defined in [src/scrollers/skip-limit-scroller.ts:19](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/scrollers/skip-limit-scroller.ts#L19)_ +*Defined in [src/scrollers/skip-limit-scroller.ts:19](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/scrollers/skip-limit-scroller.ts#L19)* **Returns:** Promise<[PeopleSearchHit](../interfaces/_src_entities_people_search_hit_entity_.peoplesearchhit.md)[]\> diff --git a/docs/classes/_src_scrollers_skip_limit_scroller_.skiplimitscroller.md b/docs/classes/_src_scrollers_skip_limit_scroller_.skiplimitscroller.md index 1090cbce..c5a176ec 100644 --- a/docs/classes/_src_scrollers_skip_limit_scroller_.skiplimitscroller.md +++ b/docs/classes/_src_scrollers_skip_limit_scroller_.skiplimitscroller.md @@ -6,13 +6,13 @@ ## Type parameters -| Name | -| ---- | -| `T` | +Name | +------ | +`T` | ## Hierarchy -- **SkipLimitScroller** +* **SkipLimitScroller** ↳ [InvitationScroller](_src_scrollers_invitation_scroller_.invitationscroller.md) @@ -26,35 +26,35 @@ ### Constructors -- [constructor](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#constructor) +* [constructor](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#constructor) ### Properties -- [hitEndOfResults](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#hitendofresults) -- [limit](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#limit) -- [scrollNextCounter](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#scrollnextcounter) -- [skip](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#skip) +* [hitEndOfResults](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#hitendofresults) +* [limit](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#limit) +* [scrollNextCounter](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#scrollnextcounter) +* [skip](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#skip) ### Methods -- [fetch](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#fetch) -- [restart](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#restart) -- [scrollBack](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#scrollback) -- [scrollNext](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#scrollnext) +* [fetch](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#fetch) +* [restart](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#restart) +* [scrollBack](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#scrollback) +* [scrollNext](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md#scrollnext) ## Constructors ### constructor -\+ **new SkipLimitScroller**(`__namedParameters`: { limit: number ; skip: number }): [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md) +\+ **new SkipLimitScroller**(`__namedParameters`: { limit: number ; skip: number }): [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md) -_Defined in [src/scrollers/skip-limit-scroller.ts:10](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/scrollers/skip-limit-scroller.ts#L10)_ +*Defined in [src/scrollers/skip-limit-scroller.ts:10](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/scrollers/skip-limit-scroller.ts#L10)* #### Parameters: -| Name | Type | -| ------------------- | -------------------------------- | -| `__namedParameters` | { limit: number ; skip: number } | +Name | Type | +------ | ------ | +`__namedParameters` | { limit: number ; skip: number } | **Returns:** [SkipLimitScroller](_src_scrollers_skip_limit_scroller_.skiplimitscroller.md) @@ -62,33 +62,33 @@ _Defined in [src/scrollers/skip-limit-scroller.ts:10](https://github.com/eilonmo ### hitEndOfResults -• **hitEndOfResults**: boolean = false +• **hitEndOfResults**: boolean = false -_Defined in [src/scrollers/skip-limit-scroller.ts:10](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/scrollers/skip-limit-scroller.ts#L10)_ +*Defined in [src/scrollers/skip-limit-scroller.ts:10](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/scrollers/skip-limit-scroller.ts#L10)* ---- +___ ### limit -• **limit**: number +• **limit**: number -_Defined in [src/scrollers/skip-limit-scroller.ts:4](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/scrollers/skip-limit-scroller.ts#L4)_ +*Defined in [src/scrollers/skip-limit-scroller.ts:4](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/scrollers/skip-limit-scroller.ts#L4)* ---- +___ ### scrollNextCounter -• **scrollNextCounter**: number = 0 +• **scrollNextCounter**: number = 0 -_Defined in [src/scrollers/skip-limit-scroller.ts:8](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/scrollers/skip-limit-scroller.ts#L8)_ +*Defined in [src/scrollers/skip-limit-scroller.ts:8](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/scrollers/skip-limit-scroller.ts#L8)* ---- +___ ### skip -• **skip**: number +• **skip**: number -_Defined in [src/scrollers/skip-limit-scroller.ts:6](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/scrollers/skip-limit-scroller.ts#L6)_ +*Defined in [src/scrollers/skip-limit-scroller.ts:6](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/scrollers/skip-limit-scroller.ts#L6)* ## Methods @@ -96,36 +96,36 @@ _Defined in [src/scrollers/skip-limit-scroller.ts:6](https://github.com/eilonmor ▸ `Abstract`**fetch**(): Promise -_Defined in [src/scrollers/skip-limit-scroller.ts:17](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/scrollers/skip-limit-scroller.ts#L17)_ +*Defined in [src/scrollers/skip-limit-scroller.ts:17](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/scrollers/skip-limit-scroller.ts#L17)* **Returns:** Promise ---- +___ ### restart ▸ **restart**(): void -_Defined in [src/scrollers/skip-limit-scroller.ts:55](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/scrollers/skip-limit-scroller.ts#L55)_ +*Defined in [src/scrollers/skip-limit-scroller.ts:55](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/scrollers/skip-limit-scroller.ts#L55)* **Returns:** void ---- +___ ### scrollBack ▸ **scrollBack**(): Promise -_Defined in [src/scrollers/skip-limit-scroller.ts:36](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/scrollers/skip-limit-scroller.ts#L36)_ +*Defined in [src/scrollers/skip-limit-scroller.ts:36](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/scrollers/skip-limit-scroller.ts#L36)* **Returns:** Promise ---- +___ ### scrollNext ▸ **scrollNext**(): Promise -_Defined in [src/scrollers/skip-limit-scroller.ts:19](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/scrollers/skip-limit-scroller.ts#L19)_ +*Defined in [src/scrollers/skip-limit-scroller.ts:19](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/scrollers/skip-limit-scroller.ts#L19)* **Returns:** Promise diff --git a/docs/enums/_src_entities_linkedin_conversation_entity_.featuredtype.md b/docs/enums/_src_entities_linkedin_conversation_entity_.featuredtype.md index fcc80e47..4e3b8f80 100644 --- a/docs/enums/_src_entities_linkedin_conversation_entity_.featuredtype.md +++ b/docs/enums/_src_entities_linkedin_conversation_entity_.featuredtype.md @@ -8,21 +8,21 @@ ### Enumeration members -- [CREATE_NEW_GROUP_CHAT](_src_entities_linkedin_conversation_entity_.featuredtype.md#create_new_group_chat) -- [REACTIONS](_src_entities_linkedin_conversation_entity_.featuredtype.md#reactions) +* [CREATE\_NEW\_GROUP\_CHAT](_src_entities_linkedin_conversation_entity_.featuredtype.md#create_new_group_chat) +* [REACTIONS](_src_entities_linkedin_conversation_entity_.featuredtype.md#reactions) ## Enumeration members -### CREATE_NEW_GROUP_CHAT +### CREATE\_NEW\_GROUP\_CHAT -• **CREATE_NEW_GROUP_CHAT**: +• **CREATE\_NEW\_GROUP\_CHAT**: -_Defined in [src/entities/linkedin-conversation.entity.ts:5](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-conversation.entity.ts#L5)_ +*Defined in [src/entities/linkedin-conversation.entity.ts:5](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-conversation.entity.ts#L5)* ---- +___ ### REACTIONS -• **REACTIONS**: +• **REACTIONS**: -_Defined in [src/entities/linkedin-conversation.entity.ts:4](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-conversation.entity.ts#L4)_ +*Defined in [src/entities/linkedin-conversation.entity.ts:4](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-conversation.entity.ts#L4)* diff --git a/docs/globals.md b/docs/globals.md index a79bdd6e..df326d7a 100644 --- a/docs/globals.md +++ b/docs/globals.md @@ -8,59 +8,59 @@ ### Modules -- ["src/core/client"](modules/_src_core_client_.md) -- ["src/core/index"](modules/_src_core_index_.md) -- ["src/core/linkedin-request"](modules/_src_core_linkedin_request_.md) -- ["src/core/login"](modules/_src_core_login_.md) -- ["src/core/request"](modules/_src_core_request_.md) -- ["src/entities/company-search-hit.entity"](modules/_src_entities_company_search_hit_entity_.md) -- ["src/entities/conversation.entity"](modules/_src_entities_conversation_entity_.md) -- ["src/entities/index"](modules/_src_entities_index_.md) -- ["src/entities/invitation.entity"](modules/_src_entities_invitation_entity_.md) -- ["src/entities/job-search-hit.entity"](modules/_src_entities_job_search_hit_entity_.md) -- ["src/entities/linkedin-attribute-text.entity"](modules/_src_entities_linkedin_attribute_text_entity_.md) -- ["src/entities/linkedin-base-company"](modules/_src_entities_linkedin_base_company_.md) -- ["src/entities/linkedin-collection-response.entity"](modules/_src_entities_linkedin_collection_response_entity_.md) -- ["src/entities/linkedin-company.entity"](modules/_src_entities_linkedin_company_entity_.md) -- ["src/entities/linkedin-conversation.entity"](modules/_src_entities_linkedin_conversation_entity_.md) -- ["src/entities/linkedin-event-create-response"](modules/_src_entities_linkedin_event_create_response_.md) -- ["src/entities/linkedin-event.entity"](modules/_src_entities_linkedin_event_entity_.md) -- ["src/entities/linkedin-image-attribute.entity"](modules/_src_entities_linkedin_image_attribute_entity_.md) -- ["src/entities/linkedin-image-view-model.entity"](modules/_src_entities_linkedin_image_view_model_entity_.md) -- ["src/entities/linkedin-invitation.entity"](modules/_src_entities_linkedin_invitation_entity_.md) -- ["src/entities/linkedin-job-posting"](modules/_src_entities_linkedin_job_posting_.md) -- ["src/entities/linkedin-job-search-hit-entity"](modules/_src_entities_linkedin_job_search_hit_entity_.md) -- ["src/entities/linkedin-message-event.entity"](modules/_src_entities_linkedin_message_event_entity_.md) -- ["src/entities/linkedin-message.entity"](modules/_src_entities_linkedin_message_entity_.md) -- ["src/entities/linkedin-mini-company.entity"](modules/_src_entities_linkedin_mini_company_entity_.md) -- ["src/entities/linkedin-mini-profile.entity"](modules/_src_entities_linkedin_mini_profile_entity_.md) -- ["src/entities/linkedin-profile.entity"](modules/_src_entities_linkedin_profile_entity_.md) -- ["src/entities/linkedin-quick-replay-recommendation.entity"](modules/_src_entities_linkedin_quick_replay_recommendation_entity_.md) -- ["src/entities/linkedin-search-cluster.entity"](modules/_src_entities_linkedin_search_cluster_entity_.md) -- ["src/entities/linkedin-search-hit-entity"](modules/_src_entities_linkedin_search_hit_entity_.md) -- ["src/entities/linkedin-search-hit-v2.entity"](modules/_src_entities_linkedin_search_hit_v2_entity_.md) -- ["src/entities/linkedin-text-view-model.entity"](modules/_src_entities_linkedin_text_view_model_entity_.md) -- ["src/entities/linkedin-vector-artifact.entity"](modules/_src_entities_linkedin_vector_artifact_entity_.md) -- ["src/entities/linkedin-vector-image.entity"](modules/_src_entities_linkedin_vector_image_entity_.md) -- ["src/entities/message-create-response.entity"](modules/_src_entities_message_create_response_entity_.md) -- ["src/entities/message-event.entity"](modules/_src_entities_message_event_entity_.md) -- ["src/entities/mini-company.entity"](modules/_src_entities_mini_company_entity_.md) -- ["src/entities/mini-profile.entity"](modules/_src_entities_mini_profile_entity_.md) -- ["src/entities/people-search-hit.entity"](modules/_src_entities_people_search_hit_entity_.md) -- ["src/entities/profile.entity"](modules/_src_entities_profile_entity_.md) -- ["src/index"](modules/_src_index_.md) -- ["src/repositories/conversation.repository"](modules/_src_repositories_conversation_repository_.md) -- ["src/repositories/index"](modules/_src_repositories_index_.md) -- ["src/repositories/invitation.repository"](modules/_src_repositories_invitation_repository_.md) -- ["src/repositories/message.repository"](modules/_src_repositories_message_repository_.md) -- ["src/repositories/profile.repository"](modules/_src_repositories_profile_repository_.md) -- ["src/repositories/search.repository"](modules/_src_repositories_search_repository_.md) -- ["src/scrollers/company-search.scroller"](modules/_src_scrollers_company_search_scroller_.md) -- ["src/scrollers/conversation.scroller"](modules/_src_scrollers_conversation_scroller_.md) -- ["src/scrollers/created-before-scroller"](modules/_src_scrollers_created_before_scroller_.md) -- ["src/scrollers/index"](modules/_src_scrollers_index_.md) -- ["src/scrollers/invitation.scroller"](modules/_src_scrollers_invitation_scroller_.md) -- ["src/scrollers/job-search.scroller"](modules/_src_scrollers_job_search_scroller_.md) -- ["src/scrollers/message.scroller"](modules/_src_scrollers_message_scroller_.md) -- ["src/scrollers/people-search.scroller"](modules/_src_scrollers_people_search_scroller_.md) -- ["src/scrollers/skip-limit-scroller"](modules/_src_scrollers_skip_limit_scroller_.md) +* ["src/core/client"](modules/_src_core_client_.md) +* ["src/core/index"](modules/_src_core_index_.md) +* ["src/core/linkedin-request"](modules/_src_core_linkedin_request_.md) +* ["src/core/login"](modules/_src_core_login_.md) +* ["src/core/request"](modules/_src_core_request_.md) +* ["src/entities/company-search-hit.entity"](modules/_src_entities_company_search_hit_entity_.md) +* ["src/entities/conversation.entity"](modules/_src_entities_conversation_entity_.md) +* ["src/entities/index"](modules/_src_entities_index_.md) +* ["src/entities/invitation.entity"](modules/_src_entities_invitation_entity_.md) +* ["src/entities/job-search-hit.entity"](modules/_src_entities_job_search_hit_entity_.md) +* ["src/entities/linkedin-attribute-text.entity"](modules/_src_entities_linkedin_attribute_text_entity_.md) +* ["src/entities/linkedin-base-company"](modules/_src_entities_linkedin_base_company_.md) +* ["src/entities/linkedin-collection-response.entity"](modules/_src_entities_linkedin_collection_response_entity_.md) +* ["src/entities/linkedin-company.entity"](modules/_src_entities_linkedin_company_entity_.md) +* ["src/entities/linkedin-conversation.entity"](modules/_src_entities_linkedin_conversation_entity_.md) +* ["src/entities/linkedin-event-create-response"](modules/_src_entities_linkedin_event_create_response_.md) +* ["src/entities/linkedin-event.entity"](modules/_src_entities_linkedin_event_entity_.md) +* ["src/entities/linkedin-image-attribute.entity"](modules/_src_entities_linkedin_image_attribute_entity_.md) +* ["src/entities/linkedin-image-view-model.entity"](modules/_src_entities_linkedin_image_view_model_entity_.md) +* ["src/entities/linkedin-invitation.entity"](modules/_src_entities_linkedin_invitation_entity_.md) +* ["src/entities/linkedin-job-posting"](modules/_src_entities_linkedin_job_posting_.md) +* ["src/entities/linkedin-job-search-hit-entity"](modules/_src_entities_linkedin_job_search_hit_entity_.md) +* ["src/entities/linkedin-message-event.entity"](modules/_src_entities_linkedin_message_event_entity_.md) +* ["src/entities/linkedin-message.entity"](modules/_src_entities_linkedin_message_entity_.md) +* ["src/entities/linkedin-mini-company.entity"](modules/_src_entities_linkedin_mini_company_entity_.md) +* ["src/entities/linkedin-mini-profile.entity"](modules/_src_entities_linkedin_mini_profile_entity_.md) +* ["src/entities/linkedin-profile.entity"](modules/_src_entities_linkedin_profile_entity_.md) +* ["src/entities/linkedin-quick-replay-recommendation.entity"](modules/_src_entities_linkedin_quick_replay_recommendation_entity_.md) +* ["src/entities/linkedin-search-cluster.entity"](modules/_src_entities_linkedin_search_cluster_entity_.md) +* ["src/entities/linkedin-search-hit-entity"](modules/_src_entities_linkedin_search_hit_entity_.md) +* ["src/entities/linkedin-search-hit-v2.entity"](modules/_src_entities_linkedin_search_hit_v2_entity_.md) +* ["src/entities/linkedin-text-view-model.entity"](modules/_src_entities_linkedin_text_view_model_entity_.md) +* ["src/entities/linkedin-vector-artifact.entity"](modules/_src_entities_linkedin_vector_artifact_entity_.md) +* ["src/entities/linkedin-vector-image.entity"](modules/_src_entities_linkedin_vector_image_entity_.md) +* ["src/entities/message-create-response.entity"](modules/_src_entities_message_create_response_entity_.md) +* ["src/entities/message-event.entity"](modules/_src_entities_message_event_entity_.md) +* ["src/entities/mini-company.entity"](modules/_src_entities_mini_company_entity_.md) +* ["src/entities/mini-profile.entity"](modules/_src_entities_mini_profile_entity_.md) +* ["src/entities/people-search-hit.entity"](modules/_src_entities_people_search_hit_entity_.md) +* ["src/entities/profile.entity"](modules/_src_entities_profile_entity_.md) +* ["src/index"](modules/_src_index_.md) +* ["src/repositories/conversation.repository"](modules/_src_repositories_conversation_repository_.md) +* ["src/repositories/index"](modules/_src_repositories_index_.md) +* ["src/repositories/invitation.repository"](modules/_src_repositories_invitation_repository_.md) +* ["src/repositories/message.repository"](modules/_src_repositories_message_repository_.md) +* ["src/repositories/profile.repository"](modules/_src_repositories_profile_repository_.md) +* ["src/repositories/search.repository"](modules/_src_repositories_search_repository_.md) +* ["src/scrollers/company-search.scroller"](modules/_src_scrollers_company_search_scroller_.md) +* ["src/scrollers/conversation.scroller"](modules/_src_scrollers_conversation_scroller_.md) +* ["src/scrollers/created-before-scroller"](modules/_src_scrollers_created_before_scroller_.md) +* ["src/scrollers/index"](modules/_src_scrollers_index_.md) +* ["src/scrollers/invitation.scroller"](modules/_src_scrollers_invitation_scroller_.md) +* ["src/scrollers/job-search.scroller"](modules/_src_scrollers_job_search_scroller_.md) +* ["src/scrollers/message.scroller"](modules/_src_scrollers_message_scroller_.md) +* ["src/scrollers/people-search.scroller"](modules/_src_scrollers_people_search_scroller_.md) +* ["src/scrollers/skip-limit-scroller"](modules/_src_scrollers_skip_limit_scroller_.md) diff --git a/docs/interfaces/_src_entities_company_search_hit_entity_.companysearchhit.md b/docs/interfaces/_src_entities_company_search_hit_entity_.companysearchhit.md index 48525275..699c7374 100644 --- a/docs/interfaces/_src_entities_company_search_hit_entity_.companysearchhit.md +++ b/docs/interfaces/_src_entities_company_search_hit_entity_.companysearchhit.md @@ -6,7 +6,7 @@ ## Hierarchy -- [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md) +* [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md) ↳ **CompanySearchHit** @@ -14,206 +14,206 @@ ### Properties -- [$type](_src_entities_company_search_hit_entity_.companysearchhit.md#$type) -- [\*badges](_src_entities_company_search_hit_entity_.companysearchhit.md#*badges) -- [company](_src_entities_company_search_hit_entity_.companysearchhit.md#company) -- [headless](_src_entities_company_search_hit_entity_.companysearchhit.md#headless) -- [headline](_src_entities_company_search_hit_entity_.companysearchhit.md#headline) -- [image](_src_entities_company_search_hit_entity_.companysearchhit.md#image) -- [memberDistance](_src_entities_company_search_hit_entity_.companysearchhit.md#memberdistance) -- [nameMatch](_src_entities_company_search_hit_entity_.companysearchhit.md#namematch) -- [navigationUrl](_src_entities_company_search_hit_entity_.companysearchhit.md#navigationurl) -- [publicIdentifier](_src_entities_company_search_hit_entity_.companysearchhit.md#publicidentifier) -- [secondaryTitle](_src_entities_company_search_hit_entity_.companysearchhit.md#secondarytitle) -- [socialProofText](_src_entities_company_search_hit_entity_.companysearchhit.md#socialprooftext) -- [subline](_src_entities_company_search_hit_entity_.companysearchhit.md#subline) -- [targetUrn](_src_entities_company_search_hit_entity_.companysearchhit.md#targeturn) -- [title](_src_entities_company_search_hit_entity_.companysearchhit.md#title) -- [trackingId](_src_entities_company_search_hit_entity_.companysearchhit.md#trackingid) -- [trackingUrn](_src_entities_company_search_hit_entity_.companysearchhit.md#trackingurn) -- [type](_src_entities_company_search_hit_entity_.companysearchhit.md#type) +* [$type](_src_entities_company_search_hit_entity_.companysearchhit.md#$type) +* [*badges](_src_entities_company_search_hit_entity_.companysearchhit.md#*badges) +* [company](_src_entities_company_search_hit_entity_.companysearchhit.md#company) +* [headless](_src_entities_company_search_hit_entity_.companysearchhit.md#headless) +* [headline](_src_entities_company_search_hit_entity_.companysearchhit.md#headline) +* [image](_src_entities_company_search_hit_entity_.companysearchhit.md#image) +* [memberDistance](_src_entities_company_search_hit_entity_.companysearchhit.md#memberdistance) +* [nameMatch](_src_entities_company_search_hit_entity_.companysearchhit.md#namematch) +* [navigationUrl](_src_entities_company_search_hit_entity_.companysearchhit.md#navigationurl) +* [publicIdentifier](_src_entities_company_search_hit_entity_.companysearchhit.md#publicidentifier) +* [secondaryTitle](_src_entities_company_search_hit_entity_.companysearchhit.md#secondarytitle) +* [socialProofText](_src_entities_company_search_hit_entity_.companysearchhit.md#socialprooftext) +* [subline](_src_entities_company_search_hit_entity_.companysearchhit.md#subline) +* [targetUrn](_src_entities_company_search_hit_entity_.companysearchhit.md#targeturn) +* [title](_src_entities_company_search_hit_entity_.companysearchhit.md#title) +* [trackingId](_src_entities_company_search_hit_entity_.companysearchhit.md#trackingid) +* [trackingUrn](_src_entities_company_search_hit_entity_.companysearchhit.md#trackingurn) +* [type](_src_entities_company_search_hit_entity_.companysearchhit.md#type) ## Properties ### $type -• **$type**: \"com.linkedin.voyager.search.SearchHitV2\" +• **$type**: \"com.linkedin.voyager.search.SearchHitV2\" -_Inherited from [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md).[$type](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#$type)_ +*Inherited from [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md).[$type](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#$type)* -_Defined in [src/entities/linkedin-search-hit-v2.entity.ts:5](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-search-hit-v2.entity.ts#L5)_ +*Defined in [src/entities/linkedin-search-hit-v2.entity.ts:5](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-search-hit-v2.entity.ts#L5)* ---- +___ -### \*badges +### *badges -• **\*badges**: string +• ***badges**: string -*Inherited from [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md).[*badges](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#_badges)_ +*Inherited from [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md).[*badges](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#*badges)* -_Defined in [src/entities/linkedin-search-hit-v2.entity.ts:6](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-search-hit-v2.entity.ts#L6)_ +*Defined in [src/entities/linkedin-search-hit-v2.entity.ts:6](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-search-hit-v2.entity.ts#L6)* ---- +___ ### company -• **company**: [MiniCompany](_src_entities_mini_company_entity_.minicompany.md) +• **company**: [MiniCompany](_src_entities_mini_company_entity_.minicompany.md) -_Defined in [src/entities/company-search-hit.entity.ts:5](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/company-search-hit.entity.ts#L5)_ +*Defined in [src/entities/company-search-hit.entity.ts:5](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/company-search-hit.entity.ts#L5)* ---- +___ ### headless -• **headless**: string +• **headless**: string -_Inherited from [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md).[headless](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#headless)_ +*Inherited from [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md).[headless](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#headless)* -_Defined in [src/entities/linkedin-search-hit-v2.entity.ts:7](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-search-hit-v2.entity.ts#L7)_ +*Defined in [src/entities/linkedin-search-hit-v2.entity.ts:7](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-search-hit-v2.entity.ts#L7)* ---- +___ ### headline -• **headline**: [LinkedInTextViewModel](_src_entities_linkedin_text_view_model_entity_.linkedintextviewmodel.md) +• **headline**: [LinkedInTextViewModel](_src_entities_linkedin_text_view_model_entity_.linkedintextviewmodel.md) -_Inherited from [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md).[headline](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#headline)_ +*Inherited from [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md).[headline](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#headline)* -_Defined in [src/entities/linkedin-search-hit-v2.entity.ts:8](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-search-hit-v2.entity.ts#L8)_ +*Defined in [src/entities/linkedin-search-hit-v2.entity.ts:8](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-search-hit-v2.entity.ts#L8)* ---- +___ ### image -• **image**: [LinkedInImageViewModel](_src_entities_linkedin_image_view_model_entity_.linkedinimageviewmodel.md) +• **image**: [LinkedInImageViewModel](_src_entities_linkedin_image_view_model_entity_.linkedinimageviewmodel.md) -_Inherited from [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md).[image](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#image)_ +*Inherited from [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md).[image](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#image)* -_Defined in [src/entities/linkedin-search-hit-v2.entity.ts:9](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-search-hit-v2.entity.ts#L9)_ +*Defined in [src/entities/linkedin-search-hit-v2.entity.ts:9](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-search-hit-v2.entity.ts#L9)* ---- +___ ### memberDistance -• **memberDistance**: { $type: \"com.linkedin.voyager.common.MemberDistance\" ; value: string } +• **memberDistance**: { $type: \"com.linkedin.voyager.common.MemberDistance\" ; value: string } -_Inherited from [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md).[memberDistance](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#memberdistance)_ +*Inherited from [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md).[memberDistance](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#memberdistance)* -_Defined in [src/entities/linkedin-search-hit-v2.entity.ts:10](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-search-hit-v2.entity.ts#L10)_ +*Defined in [src/entities/linkedin-search-hit-v2.entity.ts:10](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-search-hit-v2.entity.ts#L10)* #### Type declaration: -| Name | Type | -| ------- | ---------------------------------------------- | -| `$type` | \"com.linkedin.voyager.common.MemberDistance\" | -| `value` | string | +Name | Type | +------ | ------ | +`$type` | \"com.linkedin.voyager.common.MemberDistance\" | +`value` | string | ---- +___ ### nameMatch -• **nameMatch**: boolean +• **nameMatch**: boolean -_Inherited from [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md).[nameMatch](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#namematch)_ +*Inherited from [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md).[nameMatch](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#namematch)* -_Defined in [src/entities/linkedin-search-hit-v2.entity.ts:14](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-search-hit-v2.entity.ts#L14)_ +*Defined in [src/entities/linkedin-search-hit-v2.entity.ts:14](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-search-hit-v2.entity.ts#L14)* ---- +___ ### navigationUrl -• **navigationUrl**: string +• **navigationUrl**: string -_Inherited from [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md).[navigationUrl](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#navigationurl)_ +*Inherited from [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md).[navigationUrl](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#navigationurl)* -_Defined in [src/entities/linkedin-search-hit-v2.entity.ts:15](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-search-hit-v2.entity.ts#L15)_ +*Defined in [src/entities/linkedin-search-hit-v2.entity.ts:15](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-search-hit-v2.entity.ts#L15)* ---- +___ ### publicIdentifier -• **publicIdentifier**: string +• **publicIdentifier**: string -_Inherited from [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md).[publicIdentifier](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#publicidentifier)_ +*Inherited from [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md).[publicIdentifier](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#publicidentifier)* -_Defined in [src/entities/linkedin-search-hit-v2.entity.ts:16](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-search-hit-v2.entity.ts#L16)_ +*Defined in [src/entities/linkedin-search-hit-v2.entity.ts:16](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-search-hit-v2.entity.ts#L16)* ---- +___ ### secondaryTitle -• **secondaryTitle**: [LinkedInTextViewModel](_src_entities_linkedin_text_view_model_entity_.linkedintextviewmodel.md) +• **secondaryTitle**: [LinkedInTextViewModel](_src_entities_linkedin_text_view_model_entity_.linkedintextviewmodel.md) -_Inherited from [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md).[secondaryTitle](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#secondarytitle)_ +*Inherited from [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md).[secondaryTitle](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#secondarytitle)* -_Defined in [src/entities/linkedin-search-hit-v2.entity.ts:17](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-search-hit-v2.entity.ts#L17)_ +*Defined in [src/entities/linkedin-search-hit-v2.entity.ts:17](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-search-hit-v2.entity.ts#L17)* ---- +___ ### socialProofText -• **socialProofText**: string +• **socialProofText**: string -_Inherited from [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md).[socialProofText](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#socialprooftext)_ +*Inherited from [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md).[socialProofText](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#socialprooftext)* -_Defined in [src/entities/linkedin-search-hit-v2.entity.ts:18](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-search-hit-v2.entity.ts#L18)_ +*Defined in [src/entities/linkedin-search-hit-v2.entity.ts:18](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-search-hit-v2.entity.ts#L18)* ---- +___ ### subline -• **subline**: [LinkedInTextViewModel](_src_entities_linkedin_text_view_model_entity_.linkedintextviewmodel.md) +• **subline**: [LinkedInTextViewModel](_src_entities_linkedin_text_view_model_entity_.linkedintextviewmodel.md) -_Inherited from [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md).[subline](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#subline)_ +*Inherited from [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md).[subline](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#subline)* -_Defined in [src/entities/linkedin-search-hit-v2.entity.ts:19](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-search-hit-v2.entity.ts#L19)_ +*Defined in [src/entities/linkedin-search-hit-v2.entity.ts:19](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-search-hit-v2.entity.ts#L19)* ---- +___ ### targetUrn -• **targetUrn**: string +• **targetUrn**: string -_Inherited from [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md).[targetUrn](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#targeturn)_ +*Inherited from [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md).[targetUrn](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#targeturn)* -_Defined in [src/entities/linkedin-search-hit-v2.entity.ts:20](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-search-hit-v2.entity.ts#L20)_ +*Defined in [src/entities/linkedin-search-hit-v2.entity.ts:20](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-search-hit-v2.entity.ts#L20)* ---- +___ ### title -• **title**: [LinkedInTextViewModel](_src_entities_linkedin_text_view_model_entity_.linkedintextviewmodel.md) +• **title**: [LinkedInTextViewModel](_src_entities_linkedin_text_view_model_entity_.linkedintextviewmodel.md) -_Inherited from [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md).[title](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#title)_ +*Inherited from [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md).[title](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#title)* -_Defined in [src/entities/linkedin-search-hit-v2.entity.ts:21](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-search-hit-v2.entity.ts#L21)_ +*Defined in [src/entities/linkedin-search-hit-v2.entity.ts:21](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-search-hit-v2.entity.ts#L21)* ---- +___ ### trackingId -• **trackingId**: string +• **trackingId**: string -_Inherited from [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md).[trackingId](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#trackingid)_ +*Inherited from [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md).[trackingId](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#trackingid)* -_Defined in [src/entities/linkedin-search-hit-v2.entity.ts:22](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-search-hit-v2.entity.ts#L22)_ +*Defined in [src/entities/linkedin-search-hit-v2.entity.ts:22](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-search-hit-v2.entity.ts#L22)* ---- +___ ### trackingUrn -• **trackingUrn**: string +• **trackingUrn**: string -_Inherited from [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md).[trackingUrn](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#trackingurn)_ +*Inherited from [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md).[trackingUrn](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#trackingurn)* -_Defined in [src/entities/linkedin-search-hit-v2.entity.ts:23](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-search-hit-v2.entity.ts#L23)_ +*Defined in [src/entities/linkedin-search-hit-v2.entity.ts:23](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-search-hit-v2.entity.ts#L23)* ---- +___ ### type -• **type**: string +• **type**: string -_Inherited from [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md).[type](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#type)_ +*Inherited from [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md).[type](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#type)* -_Defined in [src/entities/linkedin-search-hit-v2.entity.ts:24](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-search-hit-v2.entity.ts#L24)_ +*Defined in [src/entities/linkedin-search-hit-v2.entity.ts:24](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-search-hit-v2.entity.ts#L24)* diff --git a/docs/interfaces/_src_entities_conversation_entity_.conversation.md b/docs/interfaces/_src_entities_conversation_entity_.conversation.md index d81cb8bd..7c27c83c 100644 --- a/docs/interfaces/_src_entities_conversation_entity_.conversation.md +++ b/docs/interfaces/_src_entities_conversation_entity_.conversation.md @@ -6,7 +6,7 @@ ## Hierarchy -- [LinkedinConversation](_src_entities_linkedin_conversation_entity_.linkedinconversation.md) +* [LinkedinConversation](_src_entities_linkedin_conversation_entity_.linkedinconversation.md) ↳ **Conversation** @@ -14,230 +14,230 @@ ### Properties -- [$type](_src_entities_conversation_entity_.conversation.md#$type) -- [\*events](_src_entities_conversation_entity_.conversation.md#*events) -- [\*participants](_src_entities_conversation_entity_.conversation.md#*participants) -- [\*type](_src_entities_conversation_entity_.conversation.md#*type) -- [archived](_src_entities_conversation_entity_.conversation.md#archived) -- [backendUrn](_src_entities_conversation_entity_.conversation.md#backendurn) -- [blocked](_src_entities_conversation_entity_.conversation.md#blocked) -- [conversationId](_src_entities_conversation_entity_.conversation.md#conversationid) -- [entityUrn](_src_entities_conversation_entity_.conversation.md#entityurn) -- [featureTypes](_src_entities_conversation_entity_.conversation.md#featuretypes) -- [firstMessageUrn](_src_entities_conversation_entity_.conversation.md#firstmessageurn) -- [lastActivityAt](_src_entities_conversation_entity_.conversation.md#lastactivityat) -- [muted](_src_entities_conversation_entity_.conversation.md#muted) -- [notificationStatus](_src_entities_conversation_entity_.conversation.md#notificationstatus) -- [participants](_src_entities_conversation_entity_.conversation.md#participants) -- [read](_src_entities_conversation_entity_.conversation.md#read) -- [receipts](_src_entities_conversation_entity_.conversation.md#receipts) -- [totalEventCount](_src_entities_conversation_entity_.conversation.md#totaleventcount) -- [unreadCount](_src_entities_conversation_entity_.conversation.md#unreadcount) -- [viewerCurrentParticipant](_src_entities_conversation_entity_.conversation.md#viewercurrentparticipant) -- [withNonConnection](_src_entities_conversation_entity_.conversation.md#withnonconnection) +* [$type](_src_entities_conversation_entity_.conversation.md#$type) +* [*events](_src_entities_conversation_entity_.conversation.md#*events) +* [*participants](_src_entities_conversation_entity_.conversation.md#*participants) +* [*type](_src_entities_conversation_entity_.conversation.md#*type) +* [archived](_src_entities_conversation_entity_.conversation.md#archived) +* [backendUrn](_src_entities_conversation_entity_.conversation.md#backendurn) +* [blocked](_src_entities_conversation_entity_.conversation.md#blocked) +* [conversationId](_src_entities_conversation_entity_.conversation.md#conversationid) +* [entityUrn](_src_entities_conversation_entity_.conversation.md#entityurn) +* [featureTypes](_src_entities_conversation_entity_.conversation.md#featuretypes) +* [firstMessageUrn](_src_entities_conversation_entity_.conversation.md#firstmessageurn) +* [lastActivityAt](_src_entities_conversation_entity_.conversation.md#lastactivityat) +* [muted](_src_entities_conversation_entity_.conversation.md#muted) +* [notificationStatus](_src_entities_conversation_entity_.conversation.md#notificationstatus) +* [participants](_src_entities_conversation_entity_.conversation.md#participants) +* [read](_src_entities_conversation_entity_.conversation.md#read) +* [receipts](_src_entities_conversation_entity_.conversation.md#receipts) +* [totalEventCount](_src_entities_conversation_entity_.conversation.md#totaleventcount) +* [unreadCount](_src_entities_conversation_entity_.conversation.md#unreadcount) +* [viewerCurrentParticipant](_src_entities_conversation_entity_.conversation.md#viewercurrentparticipant) +* [withNonConnection](_src_entities_conversation_entity_.conversation.md#withnonconnection) ## Properties ### $type -• **$type**: _typeof_ [CONVERSATION_TYPE](../modules/_src_entities_linkedin_conversation_entity_.md#conversation_type) +• **$type**: *typeof* [CONVERSATION\_TYPE](../modules/_src_entities_linkedin_conversation_entity_.md#conversation_type) -_Inherited from [LinkedinConversation](_src_entities_linkedin_conversation_entity_.linkedinconversation.md).[$type](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#$type)_ +*Inherited from [LinkedinConversation](_src_entities_linkedin_conversation_entity_.linkedinconversation.md).[$type](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#$type)* -_Defined in [src/entities/linkedin-conversation.entity.ts:26](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-conversation.entity.ts#L26)_ +*Defined in [src/entities/linkedin-conversation.entity.ts:26](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-conversation.entity.ts#L26)* ---- +___ -### \*events +### *events -• **\*events**: string[] +• ***events**: string[] -*Inherited from [LinkedinConversation](_src_entities_linkedin_conversation_entity_.linkedinconversation.md).[*events](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#_events)_ +*Inherited from [LinkedinConversation](_src_entities_linkedin_conversation_entity_.linkedinconversation.md).[*events](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#*events)* -_Defined in [src/entities/linkedin-conversation.entity.ts:27](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-conversation.entity.ts#L27)_ +*Defined in [src/entities/linkedin-conversation.entity.ts:27](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-conversation.entity.ts#L27)* ---- +___ -### \*participants +### *participants -• **\*participants**: string[] +• ***participants**: string[] -*Inherited from [LinkedinConversation](_src_entities_linkedin_conversation_entity_.linkedinconversation.md).[*participants](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#_participants)_ +*Inherited from [LinkedinConversation](_src_entities_linkedin_conversation_entity_.linkedinconversation.md).[*participants](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#*participants)* -_Defined in [src/entities/linkedin-conversation.entity.ts:28](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-conversation.entity.ts#L28)_ +*Defined in [src/entities/linkedin-conversation.entity.ts:28](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-conversation.entity.ts#L28)* ---- +___ -### \*type +### *type -• **\*type**: string[] +• ***type**: string[] -*Inherited from [LinkedinConversation](_src_entities_linkedin_conversation_entity_.linkedinconversation.md).[*type](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#_type)_ +*Inherited from [LinkedinConversation](_src_entities_linkedin_conversation_entity_.linkedinconversation.md).[*type](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#*type)* -_Defined in [src/entities/linkedin-conversation.entity.ts:29](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-conversation.entity.ts#L29)_ +*Defined in [src/entities/linkedin-conversation.entity.ts:29](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-conversation.entity.ts#L29)* ---- +___ ### archived -• **archived**: boolean +• **archived**: boolean -_Inherited from [LinkedinConversation](_src_entities_linkedin_conversation_entity_.linkedinconversation.md).[archived](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#archived)_ +*Inherited from [LinkedinConversation](_src_entities_linkedin_conversation_entity_.linkedinconversation.md).[archived](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#archived)* -_Defined in [src/entities/linkedin-conversation.entity.ts:30](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-conversation.entity.ts#L30)_ +*Defined in [src/entities/linkedin-conversation.entity.ts:30](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-conversation.entity.ts#L30)* ---- +___ ### backendUrn -• **backendUrn**: string +• **backendUrn**: string -_Inherited from [LinkedinConversation](_src_entities_linkedin_conversation_entity_.linkedinconversation.md).[backendUrn](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#backendurn)_ +*Inherited from [LinkedinConversation](_src_entities_linkedin_conversation_entity_.linkedinconversation.md).[backendUrn](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#backendurn)* -_Defined in [src/entities/linkedin-conversation.entity.ts:31](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-conversation.entity.ts#L31)_ +*Defined in [src/entities/linkedin-conversation.entity.ts:31](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-conversation.entity.ts#L31)* ---- +___ ### blocked -• **blocked**: boolean +• **blocked**: boolean -_Inherited from [LinkedinConversation](_src_entities_linkedin_conversation_entity_.linkedinconversation.md).[blocked](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#blocked)_ +*Inherited from [LinkedinConversation](_src_entities_linkedin_conversation_entity_.linkedinconversation.md).[blocked](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#blocked)* -_Defined in [src/entities/linkedin-conversation.entity.ts:32](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-conversation.entity.ts#L32)_ +*Defined in [src/entities/linkedin-conversation.entity.ts:32](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-conversation.entity.ts#L32)* ---- +___ ### conversationId -• **conversationId**: [ConversationId](../modules/_src_entities_conversation_entity_.md#conversationid) +• **conversationId**: [ConversationId](../modules/_src_entities_conversation_entity_.md#conversationid) -_Defined in [src/entities/conversation.entity.ts:7](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/conversation.entity.ts#L7)_ +*Defined in [src/entities/conversation.entity.ts:7](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/conversation.entity.ts#L7)* ---- +___ ### entityUrn -• **entityUrn**: [ConversationUrn](../modules/_src_entities_linkedin_conversation_entity_.md#conversationurn) +• **entityUrn**: [ConversationUrn](../modules/_src_entities_linkedin_conversation_entity_.md#conversationurn) -_Inherited from [LinkedinConversation](_src_entities_linkedin_conversation_entity_.linkedinconversation.md).[entityUrn](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#entityurn)_ +*Inherited from [LinkedinConversation](_src_entities_linkedin_conversation_entity_.linkedinconversation.md).[entityUrn](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#entityurn)* -_Defined in [src/entities/linkedin-conversation.entity.ts:33](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-conversation.entity.ts#L33)_ +*Defined in [src/entities/linkedin-conversation.entity.ts:33](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-conversation.entity.ts#L33)* ---- +___ ### featureTypes -• **featureTypes**: [FeaturedType](../enums/_src_entities_linkedin_conversation_entity_.featuredtype.md)[] +• **featureTypes**: [FeaturedType](../enums/_src_entities_linkedin_conversation_entity_.featuredtype.md)[] -_Inherited from [LinkedinConversation](_src_entities_linkedin_conversation_entity_.linkedinconversation.md).[featureTypes](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#featuretypes)_ +*Inherited from [LinkedinConversation](_src_entities_linkedin_conversation_entity_.linkedinconversation.md).[featureTypes](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#featuretypes)* -_Defined in [src/entities/linkedin-conversation.entity.ts:34](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-conversation.entity.ts#L34)_ +*Defined in [src/entities/linkedin-conversation.entity.ts:34](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-conversation.entity.ts#L34)* ---- +___ ### firstMessageUrn -• **firstMessageUrn**: string +• **firstMessageUrn**: string -_Inherited from [LinkedinConversation](_src_entities_linkedin_conversation_entity_.linkedinconversation.md).[firstMessageUrn](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#firstmessageurn)_ +*Inherited from [LinkedinConversation](_src_entities_linkedin_conversation_entity_.linkedinconversation.md).[firstMessageUrn](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#firstmessageurn)* -_Defined in [src/entities/linkedin-conversation.entity.ts:35](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-conversation.entity.ts#L35)_ +*Defined in [src/entities/linkedin-conversation.entity.ts:35](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-conversation.entity.ts#L35)* ---- +___ ### lastActivityAt -• **lastActivityAt**: number +• **lastActivityAt**: number -_Inherited from [LinkedinConversation](_src_entities_linkedin_conversation_entity_.linkedinconversation.md).[lastActivityAt](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#lastactivityat)_ +*Inherited from [LinkedinConversation](_src_entities_linkedin_conversation_entity_.linkedinconversation.md).[lastActivityAt](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#lastactivityat)* -_Defined in [src/entities/linkedin-conversation.entity.ts:36](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-conversation.entity.ts#L36)_ +*Defined in [src/entities/linkedin-conversation.entity.ts:36](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-conversation.entity.ts#L36)* ---- +___ ### muted -• **muted**: boolean +• **muted**: boolean -_Inherited from [LinkedinConversation](_src_entities_linkedin_conversation_entity_.linkedinconversation.md).[muted](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#muted)_ +*Inherited from [LinkedinConversation](_src_entities_linkedin_conversation_entity_.linkedinconversation.md).[muted](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#muted)* -_Defined in [src/entities/linkedin-conversation.entity.ts:37](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-conversation.entity.ts#L37)_ +*Defined in [src/entities/linkedin-conversation.entity.ts:37](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-conversation.entity.ts#L37)* ---- +___ ### notificationStatus -• **notificationStatus**: string +• **notificationStatus**: string -_Inherited from [LinkedinConversation](_src_entities_linkedin_conversation_entity_.linkedinconversation.md).[notificationStatus](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#notificationstatus)_ +*Inherited from [LinkedinConversation](_src_entities_linkedin_conversation_entity_.linkedinconversation.md).[notificationStatus](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#notificationstatus)* -_Defined in [src/entities/linkedin-conversation.entity.ts:38](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-conversation.entity.ts#L38)_ +*Defined in [src/entities/linkedin-conversation.entity.ts:38](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-conversation.entity.ts#L38)* ---- +___ ### participants -• **participants**: [MiniProfile](_src_entities_mini_profile_entity_.miniprofile.md)[] +• **participants**: [MiniProfile](_src_entities_mini_profile_entity_.miniprofile.md)[] -_Defined in [src/entities/conversation.entity.ts:8](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/conversation.entity.ts#L8)_ +*Defined in [src/entities/conversation.entity.ts:8](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/conversation.entity.ts#L8)* ---- +___ ### read -• **read**: boolean +• **read**: boolean -_Inherited from [LinkedinConversation](_src_entities_linkedin_conversation_entity_.linkedinconversation.md).[read](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#read)_ +*Inherited from [LinkedinConversation](_src_entities_linkedin_conversation_entity_.linkedinconversation.md).[read](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#read)* -_Defined in [src/entities/linkedin-conversation.entity.ts:39](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-conversation.entity.ts#L39)_ +*Defined in [src/entities/linkedin-conversation.entity.ts:39](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-conversation.entity.ts#L39)* ---- +___ ### receipts -• **receipts**: [LinkedInParticipantReceipts](_src_entities_linkedin_conversation_entity_.linkedinparticipantreceipts.md)[] +• **receipts**: [LinkedInParticipantReceipts](_src_entities_linkedin_conversation_entity_.linkedinparticipantreceipts.md)[] -_Inherited from [LinkedinConversation](_src_entities_linkedin_conversation_entity_.linkedinconversation.md).[receipts](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#receipts)_ +*Inherited from [LinkedinConversation](_src_entities_linkedin_conversation_entity_.linkedinconversation.md).[receipts](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#receipts)* -_Defined in [src/entities/linkedin-conversation.entity.ts:40](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-conversation.entity.ts#L40)_ +*Defined in [src/entities/linkedin-conversation.entity.ts:40](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-conversation.entity.ts#L40)* ---- +___ ### totalEventCount -• **totalEventCount**: number +• **totalEventCount**: number -_Inherited from [LinkedinConversation](_src_entities_linkedin_conversation_entity_.linkedinconversation.md).[totalEventCount](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#totaleventcount)_ +*Inherited from [LinkedinConversation](_src_entities_linkedin_conversation_entity_.linkedinconversation.md).[totalEventCount](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#totaleventcount)* -_Defined in [src/entities/linkedin-conversation.entity.ts:41](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-conversation.entity.ts#L41)_ +*Defined in [src/entities/linkedin-conversation.entity.ts:41](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-conversation.entity.ts#L41)* ---- +___ ### unreadCount -• **unreadCount**: number +• **unreadCount**: number -_Inherited from [LinkedinConversation](_src_entities_linkedin_conversation_entity_.linkedinconversation.md).[unreadCount](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#unreadcount)_ +*Inherited from [LinkedinConversation](_src_entities_linkedin_conversation_entity_.linkedinconversation.md).[unreadCount](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#unreadcount)* -_Defined in [src/entities/linkedin-conversation.entity.ts:42](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-conversation.entity.ts#L42)_ +*Defined in [src/entities/linkedin-conversation.entity.ts:42](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-conversation.entity.ts#L42)* ---- +___ ### viewerCurrentParticipant -• **viewerCurrentParticipant**: boolean +• **viewerCurrentParticipant**: boolean -_Inherited from [LinkedinConversation](_src_entities_linkedin_conversation_entity_.linkedinconversation.md).[viewerCurrentParticipant](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#viewercurrentparticipant)_ +*Inherited from [LinkedinConversation](_src_entities_linkedin_conversation_entity_.linkedinconversation.md).[viewerCurrentParticipant](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#viewercurrentparticipant)* -_Defined in [src/entities/linkedin-conversation.entity.ts:43](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-conversation.entity.ts#L43)_ +*Defined in [src/entities/linkedin-conversation.entity.ts:43](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-conversation.entity.ts#L43)* ---- +___ ### withNonConnection -• **withNonConnection**: boolean +• **withNonConnection**: boolean -_Inherited from [LinkedinConversation](_src_entities_linkedin_conversation_entity_.linkedinconversation.md).[withNonConnection](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#withnonconnection)_ +*Inherited from [LinkedinConversation](_src_entities_linkedin_conversation_entity_.linkedinconversation.md).[withNonConnection](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#withnonconnection)* -_Defined in [src/entities/linkedin-conversation.entity.ts:44](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-conversation.entity.ts#L44)_ +*Defined in [src/entities/linkedin-conversation.entity.ts:44](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-conversation.entity.ts#L44)* diff --git a/docs/interfaces/_src_entities_invitation_entity_.invitation.md b/docs/interfaces/_src_entities_invitation_entity_.invitation.md index c6cdf15f..803cb1cf 100644 --- a/docs/interfaces/_src_entities_invitation_entity_.invitation.md +++ b/docs/interfaces/_src_entities_invitation_entity_.invitation.md @@ -6,7 +6,7 @@ ## Hierarchy -- [LinkedInInvitation](_src_entities_linkedin_invitation_entity_.linkedininvitation.md) +* [LinkedInInvitation](_src_entities_linkedin_invitation_entity_.linkedininvitation.md) ↳ **Invitation** @@ -14,144 +14,144 @@ ### Properties -- [$type](_src_entities_invitation_entity_.invitation.md#$type) -- [\*fromMember](_src_entities_invitation_entity_.invitation.md#*frommember) -- [\*toMember](_src_entities_invitation_entity_.invitation.md#*tomember) -- [customMessage](_src_entities_invitation_entity_.invitation.md#custommessage) -- [entityUrn](_src_entities_invitation_entity_.invitation.md#entityurn) -- [invitationType](_src_entities_invitation_entity_.invitation.md#invitationtype) -- [invitee](_src_entities_invitation_entity_.invitation.md#invitee) -- [mailboxItemId](_src_entities_invitation_entity_.invitation.md#mailboxitemid) -- [profile](_src_entities_invitation_entity_.invitation.md#profile) -- [sentTime](_src_entities_invitation_entity_.invitation.md#senttime) -- [sharedSecret](_src_entities_invitation_entity_.invitation.md#sharedsecret) -- [toMemberId](_src_entities_invitation_entity_.invitation.md#tomemberid) -- [unseen](_src_entities_invitation_entity_.invitation.md#unseen) +* [$type](_src_entities_invitation_entity_.invitation.md#$type) +* [*fromMember](_src_entities_invitation_entity_.invitation.md#*frommember) +* [*toMember](_src_entities_invitation_entity_.invitation.md#*tomember) +* [customMessage](_src_entities_invitation_entity_.invitation.md#custommessage) +* [entityUrn](_src_entities_invitation_entity_.invitation.md#entityurn) +* [invitationType](_src_entities_invitation_entity_.invitation.md#invitationtype) +* [invitee](_src_entities_invitation_entity_.invitation.md#invitee) +* [mailboxItemId](_src_entities_invitation_entity_.invitation.md#mailboxitemid) +* [profile](_src_entities_invitation_entity_.invitation.md#profile) +* [sentTime](_src_entities_invitation_entity_.invitation.md#senttime) +* [sharedSecret](_src_entities_invitation_entity_.invitation.md#sharedsecret) +* [toMemberId](_src_entities_invitation_entity_.invitation.md#tomemberid) +* [unseen](_src_entities_invitation_entity_.invitation.md#unseen) ## Properties ### $type -• **$type**: _typeof_ [INVITATION_TYPE](../modules/_src_entities_linkedin_invitation_entity_.md#invitation_type) +• **$type**: *typeof* [INVITATION\_TYPE](../modules/_src_entities_linkedin_invitation_entity_.md#invitation_type) -_Inherited from [LinkedInInvitation](_src_entities_linkedin_invitation_entity_.linkedininvitation.md).[$type](_src_entities_linkedin_invitation_entity_.linkedininvitation.md#$type)_ +*Inherited from [LinkedInInvitation](_src_entities_linkedin_invitation_entity_.linkedininvitation.md).[$type](_src_entities_linkedin_invitation_entity_.linkedininvitation.md#$type)* -_Defined in [src/entities/linkedin-invitation.entity.ts:16](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-invitation.entity.ts#L16)_ +*Defined in [src/entities/linkedin-invitation.entity.ts:16](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-invitation.entity.ts#L16)* ---- +___ -### \*fromMember +### *fromMember -• **\*fromMember**: [MiniProfileUrn](../modules/_src_entities_linkedin_mini_profile_entity_.md#miniprofileurn) +• ***fromMember**: [MiniProfileUrn](../modules/_src_entities_linkedin_mini_profile_entity_.md#miniprofileurn) -*Inherited from [LinkedInInvitation](_src_entities_linkedin_invitation_entity_.linkedininvitation.md).[*fromMember](_src_entities_linkedin_invitation_entity_.linkedininvitation.md#_frommember)_ +*Inherited from [LinkedInInvitation](_src_entities_linkedin_invitation_entity_.linkedininvitation.md).[*fromMember](_src_entities_linkedin_invitation_entity_.linkedininvitation.md#*frommember)* -_Defined in [src/entities/linkedin-invitation.entity.ts:17](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-invitation.entity.ts#L17)_ +*Defined in [src/entities/linkedin-invitation.entity.ts:17](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-invitation.entity.ts#L17)* ---- +___ -### \*toMember +### *toMember -• **\*toMember**: [MiniProfileUrn](../modules/_src_entities_linkedin_mini_profile_entity_.md#miniprofileurn) +• ***toMember**: [MiniProfileUrn](../modules/_src_entities_linkedin_mini_profile_entity_.md#miniprofileurn) -*Inherited from [LinkedInInvitation](_src_entities_linkedin_invitation_entity_.linkedininvitation.md).[*toMember](_src_entities_linkedin_invitation_entity_.linkedininvitation.md#_tomember)_ +*Inherited from [LinkedInInvitation](_src_entities_linkedin_invitation_entity_.linkedininvitation.md).[*toMember](_src_entities_linkedin_invitation_entity_.linkedininvitation.md#*tomember)* -_Defined in [src/entities/linkedin-invitation.entity.ts:18](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-invitation.entity.ts#L18)_ +*Defined in [src/entities/linkedin-invitation.entity.ts:18](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-invitation.entity.ts#L18)* ---- +___ ### customMessage -• **customMessage**: boolean +• **customMessage**: boolean -_Inherited from [LinkedInInvitation](_src_entities_linkedin_invitation_entity_.linkedininvitation.md).[customMessage](_src_entities_linkedin_invitation_entity_.linkedininvitation.md#custommessage)_ +*Inherited from [LinkedInInvitation](_src_entities_linkedin_invitation_entity_.linkedininvitation.md).[customMessage](_src_entities_linkedin_invitation_entity_.linkedininvitation.md#custommessage)* -_Defined in [src/entities/linkedin-invitation.entity.ts:19](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-invitation.entity.ts#L19)_ +*Defined in [src/entities/linkedin-invitation.entity.ts:19](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-invitation.entity.ts#L19)* ---- +___ ### entityUrn -• **entityUrn**: string +• **entityUrn**: string -_Inherited from [LinkedInInvitation](_src_entities_linkedin_invitation_entity_.linkedininvitation.md).[entityUrn](_src_entities_linkedin_invitation_entity_.linkedininvitation.md#entityurn)_ +*Inherited from [LinkedInInvitation](_src_entities_linkedin_invitation_entity_.linkedininvitation.md).[entityUrn](_src_entities_linkedin_invitation_entity_.linkedininvitation.md#entityurn)* -_Defined in [src/entities/linkedin-invitation.entity.ts:20](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-invitation.entity.ts#L20)_ +*Defined in [src/entities/linkedin-invitation.entity.ts:20](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-invitation.entity.ts#L20)* ---- +___ ### invitationType -• **invitationType**: InvitationType +• **invitationType**: InvitationType -_Inherited from [LinkedInInvitation](_src_entities_linkedin_invitation_entity_.linkedininvitation.md).[invitationType](_src_entities_linkedin_invitation_entity_.linkedininvitation.md#invitationtype)_ +*Inherited from [LinkedInInvitation](_src_entities_linkedin_invitation_entity_.linkedininvitation.md).[invitationType](_src_entities_linkedin_invitation_entity_.linkedininvitation.md#invitationtype)* -_Defined in [src/entities/linkedin-invitation.entity.ts:21](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-invitation.entity.ts#L21)_ +*Defined in [src/entities/linkedin-invitation.entity.ts:21](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-invitation.entity.ts#L21)* ---- +___ ### invitee -• **invitee**: LinkedInProfileInvitee +• **invitee**: LinkedInProfileInvitee -_Inherited from [LinkedInInvitation](_src_entities_linkedin_invitation_entity_.linkedininvitation.md).[invitee](_src_entities_linkedin_invitation_entity_.linkedininvitation.md#invitee)_ +*Inherited from [LinkedInInvitation](_src_entities_linkedin_invitation_entity_.linkedininvitation.md).[invitee](_src_entities_linkedin_invitation_entity_.linkedininvitation.md#invitee)* -_Defined in [src/entities/linkedin-invitation.entity.ts:22](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-invitation.entity.ts#L22)_ +*Defined in [src/entities/linkedin-invitation.entity.ts:22](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-invitation.entity.ts#L22)* ---- +___ ### mailboxItemId -• **mailboxItemId**: string +• **mailboxItemId**: string -_Inherited from [LinkedInInvitation](_src_entities_linkedin_invitation_entity_.linkedininvitation.md).[mailboxItemId](_src_entities_linkedin_invitation_entity_.linkedininvitation.md#mailboxitemid)_ +*Inherited from [LinkedInInvitation](_src_entities_linkedin_invitation_entity_.linkedininvitation.md).[mailboxItemId](_src_entities_linkedin_invitation_entity_.linkedininvitation.md#mailboxitemid)* -_Defined in [src/entities/linkedin-invitation.entity.ts:23](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-invitation.entity.ts#L23)_ +*Defined in [src/entities/linkedin-invitation.entity.ts:23](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-invitation.entity.ts#L23)* ---- +___ ### profile -• **profile**: [MiniProfile](_src_entities_mini_profile_entity_.miniprofile.md) +• **profile**: [MiniProfile](_src_entities_mini_profile_entity_.miniprofile.md) -_Defined in [src/entities/invitation.entity.ts:5](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/invitation.entity.ts#L5)_ +*Defined in [src/entities/invitation.entity.ts:5](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/invitation.entity.ts#L5)* ---- +___ ### sentTime -• **sentTime**: number +• **sentTime**: number -_Inherited from [LinkedInInvitation](_src_entities_linkedin_invitation_entity_.linkedininvitation.md).[sentTime](_src_entities_linkedin_invitation_entity_.linkedininvitation.md#senttime)_ +*Inherited from [LinkedInInvitation](_src_entities_linkedin_invitation_entity_.linkedininvitation.md).[sentTime](_src_entities_linkedin_invitation_entity_.linkedininvitation.md#senttime)* -_Defined in [src/entities/linkedin-invitation.entity.ts:24](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-invitation.entity.ts#L24)_ +*Defined in [src/entities/linkedin-invitation.entity.ts:24](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-invitation.entity.ts#L24)* ---- +___ ### sharedSecret -• **sharedSecret**: string +• **sharedSecret**: string -_Inherited from [LinkedInInvitation](_src_entities_linkedin_invitation_entity_.linkedininvitation.md).[sharedSecret](_src_entities_linkedin_invitation_entity_.linkedininvitation.md#sharedsecret)_ +*Inherited from [LinkedInInvitation](_src_entities_linkedin_invitation_entity_.linkedininvitation.md).[sharedSecret](_src_entities_linkedin_invitation_entity_.linkedininvitation.md#sharedsecret)* -_Defined in [src/entities/linkedin-invitation.entity.ts:25](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-invitation.entity.ts#L25)_ +*Defined in [src/entities/linkedin-invitation.entity.ts:25](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-invitation.entity.ts#L25)* ---- +___ ### toMemberId -• **toMemberId**: string +• **toMemberId**: string -_Inherited from [LinkedInInvitation](_src_entities_linkedin_invitation_entity_.linkedininvitation.md).[toMemberId](_src_entities_linkedin_invitation_entity_.linkedininvitation.md#tomemberid)_ +*Inherited from [LinkedInInvitation](_src_entities_linkedin_invitation_entity_.linkedininvitation.md).[toMemberId](_src_entities_linkedin_invitation_entity_.linkedininvitation.md#tomemberid)* -_Defined in [src/entities/linkedin-invitation.entity.ts:26](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-invitation.entity.ts#L26)_ +*Defined in [src/entities/linkedin-invitation.entity.ts:26](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-invitation.entity.ts#L26)* ---- +___ ### unseen • `Optional` **unseen**: undefined \| false \| true -_Inherited from [LinkedInInvitation](_src_entities_linkedin_invitation_entity_.linkedininvitation.md).[unseen](_src_entities_linkedin_invitation_entity_.linkedininvitation.md#unseen)_ +*Inherited from [LinkedInInvitation](_src_entities_linkedin_invitation_entity_.linkedininvitation.md).[unseen](_src_entities_linkedin_invitation_entity_.linkedininvitation.md#unseen)* -_Defined in [src/entities/linkedin-invitation.entity.ts:27](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-invitation.entity.ts#L27)_ +*Defined in [src/entities/linkedin-invitation.entity.ts:27](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-invitation.entity.ts#L27)* diff --git a/docs/interfaces/_src_entities_job_search_hit_entity_.populatedjobhitinfo.md b/docs/interfaces/_src_entities_job_search_hit_entity_.populatedjobhitinfo.md index cbf8f7f9..1f90ad86 100644 --- a/docs/interfaces/_src_entities_job_search_hit_entity_.populatedjobhitinfo.md +++ b/docs/interfaces/_src_entities_job_search_hit_entity_.populatedjobhitinfo.md @@ -6,7 +6,7 @@ ## Hierarchy -- {} +* {} ↳ **PopulatedJobHitInfo** @@ -14,12 +14,12 @@ ### Properties -- [jobPosting](_src_entities_job_search_hit_entity_.populatedjobhitinfo.md#jobposting) +* [jobPosting](_src_entities_job_search_hit_entity_.populatedjobhitinfo.md#jobposting) ## Properties ### jobPosting -• **jobPosting**: [PopulatedJobPosting](_src_entities_job_search_hit_entity_.populatedjobposting.md) +• **jobPosting**: [PopulatedJobPosting](_src_entities_job_search_hit_entity_.populatedjobposting.md) -_Defined in [src/entities/job-search-hit.entity.ts:15](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/job-search-hit.entity.ts#L15)_ +*Defined in [src/entities/job-search-hit.entity.ts:15](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/job-search-hit.entity.ts#L15)* diff --git a/docs/interfaces/_src_entities_job_search_hit_entity_.populatedjobposting.md b/docs/interfaces/_src_entities_job_search_hit_entity_.populatedjobposting.md index fc1eef42..8e35d2ee 100644 --- a/docs/interfaces/_src_entities_job_search_hit_entity_.populatedjobposting.md +++ b/docs/interfaces/_src_entities_job_search_hit_entity_.populatedjobposting.md @@ -6,7 +6,7 @@ ## Hierarchy -- {} +* {} ↳ **PopulatedJobPosting** @@ -14,12 +14,12 @@ ### Properties -- [companyDetails](_src_entities_job_search_hit_entity_.populatedjobposting.md#companydetails) +* [companyDetails](_src_entities_job_search_hit_entity_.populatedjobposting.md#companydetails) ## Properties ### companyDetails -• **companyDetails**: [PopulatedJobPostingCompany](_src_entities_job_search_hit_entity_.populatedjobpostingcompany.md) +• **companyDetails**: [PopulatedJobPostingCompany](_src_entities_job_search_hit_entity_.populatedjobpostingcompany.md) -_Defined in [src/entities/job-search-hit.entity.ts:11](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/job-search-hit.entity.ts#L11)_ +*Defined in [src/entities/job-search-hit.entity.ts:11](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/job-search-hit.entity.ts#L11)* diff --git a/docs/interfaces/_src_entities_job_search_hit_entity_.populatedjobpostingcompany.md b/docs/interfaces/_src_entities_job_search_hit_entity_.populatedjobpostingcompany.md index 7dfcad36..53510da9 100644 --- a/docs/interfaces/_src_entities_job_search_hit_entity_.populatedjobpostingcompany.md +++ b/docs/interfaces/_src_entities_job_search_hit_entity_.populatedjobpostingcompany.md @@ -6,7 +6,7 @@ ## Hierarchy -- {} +* {} ↳ **PopulatedJobPostingCompany** @@ -14,12 +14,12 @@ ### Properties -- [company](_src_entities_job_search_hit_entity_.populatedjobpostingcompany.md#company) +* [company](_src_entities_job_search_hit_entity_.populatedjobpostingcompany.md#company) ## Properties ### company -• **company**: [LinkedInBaseCompany](_src_entities_linkedin_base_company_.linkedinbasecompany.md) +• **company**: [LinkedInBaseCompany](_src_entities_linkedin_base_company_.linkedinbasecompany.md) -_Defined in [src/entities/job-search-hit.entity.ts:7](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/job-search-hit.entity.ts#L7)_ +*Defined in [src/entities/job-search-hit.entity.ts:7](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/job-search-hit.entity.ts#L7)* diff --git a/docs/interfaces/_src_entities_linkedin_attribute_text_entity_.attributetext.md b/docs/interfaces/_src_entities_linkedin_attribute_text_entity_.attributetext.md index a68044c9..1393f946 100644 --- a/docs/interfaces/_src_entities_linkedin_attribute_text_entity_.attributetext.md +++ b/docs/interfaces/_src_entities_linkedin_attribute_text_entity_.attributetext.md @@ -6,27 +6,27 @@ ## Hierarchy -- **AttributeText** +* **AttributeText** ## Index ### Properties -- [$type](_src_entities_linkedin_attribute_text_entity_.attributetext.md#$type) -- [text](_src_entities_linkedin_attribute_text_entity_.attributetext.md#text) +* [$type](_src_entities_linkedin_attribute_text_entity_.attributetext.md#$type) +* [text](_src_entities_linkedin_attribute_text_entity_.attributetext.md#text) ## Properties ### $type -• **$type**: \"com.linkedin.pemberly.text.AttributedText\" +• **$type**: \"com.linkedin.pemberly.text.AttributedText\" -_Defined in [src/entities/linkedin-attribute-text.entity.ts:2](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-attribute-text.entity.ts#L2)_ +*Defined in [src/entities/linkedin-attribute-text.entity.ts:2](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-attribute-text.entity.ts#L2)* ---- +___ ### text -• **text**: string +• **text**: string -_Defined in [src/entities/linkedin-attribute-text.entity.ts:3](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-attribute-text.entity.ts#L3)_ +*Defined in [src/entities/linkedin-attribute-text.entity.ts:3](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-attribute-text.entity.ts#L3)* diff --git a/docs/interfaces/_src_entities_linkedin_base_company_.linkedinbasecompany.md b/docs/interfaces/_src_entities_linkedin_base_company_.linkedinbasecompany.md index 3a22430e..9075d92c 100644 --- a/docs/interfaces/_src_entities_linkedin_base_company_.linkedinbasecompany.md +++ b/docs/interfaces/_src_entities_linkedin_base_company_.linkedinbasecompany.md @@ -6,71 +6,71 @@ ## Hierarchy -- **LinkedInBaseCompany** +* **LinkedInBaseCompany** ## Index ### Properties -- [$anti_abuse_annotations](_src_entities_linkedin_base_company_.linkedinbasecompany.md#$anti_abuse_annotations) -- [$recipeTypes](_src_entities_linkedin_base_company_.linkedinbasecompany.md#$recipetypes) -- [$type](_src_entities_linkedin_base_company_.linkedinbasecompany.md#$type) -- [entityUrn](_src_entities_linkedin_base_company_.linkedinbasecompany.md#entityurn) -- [logo](_src_entities_linkedin_base_company_.linkedinbasecompany.md#logo) -- [name](_src_entities_linkedin_base_company_.linkedinbasecompany.md#name) +* [$anti\_abuse\_annotations](_src_entities_linkedin_base_company_.linkedinbasecompany.md#$anti_abuse_annotations) +* [$recipeTypes](_src_entities_linkedin_base_company_.linkedinbasecompany.md#$recipetypes) +* [$type](_src_entities_linkedin_base_company_.linkedinbasecompany.md#$type) +* [entityUrn](_src_entities_linkedin_base_company_.linkedinbasecompany.md#entityurn) +* [logo](_src_entities_linkedin_base_company_.linkedinbasecompany.md#logo) +* [name](_src_entities_linkedin_base_company_.linkedinbasecompany.md#name) ## Properties -### $anti_abuse_annotations +### $anti\_abuse\_annotations -• **$anti_abuse_annotations**: { attributeId: number ; entityId: number }[] +• **$anti\_abuse\_annotations**: { attributeId: number ; entityId: number }[] -_Defined in [src/entities/linkedin-base-company.ts:7](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-base-company.ts#L7)_ +*Defined in [src/entities/linkedin-base-company.ts:7](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-base-company.ts#L7)* ---- +___ ### $recipeTypes -• **$recipeTypes**: string[] +• **$recipeTypes**: string[] -_Defined in [src/entities/linkedin-base-company.ts:11](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-base-company.ts#L11)_ +*Defined in [src/entities/linkedin-base-company.ts:11](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-base-company.ts#L11)* ---- +___ ### $type -• **$type**: _typeof_ [BASE_COMPANY_TYPE](../modules/_src_entities_linkedin_base_company_.md#base_company_type) +• **$type**: *typeof* [BASE\_COMPANY\_TYPE](../modules/_src_entities_linkedin_base_company_.md#base_company_type) -_Defined in [src/entities/linkedin-base-company.ts:6](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-base-company.ts#L6)_ +*Defined in [src/entities/linkedin-base-company.ts:6](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-base-company.ts#L6)* ---- +___ ### entityUrn -• **entityUrn**: string +• **entityUrn**: string -_Defined in [src/entities/linkedin-base-company.ts:12](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-base-company.ts#L12)_ +*Defined in [src/entities/linkedin-base-company.ts:12](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-base-company.ts#L12)* ---- +___ ### logo -• **logo**: { $type: \"com.linkedin.voyager.organization.CompanyLogoImage\" ; image: [LinkedInVectorImage](_src_entities_linkedin_vector_image_entity_.linkedinvectorimage.md) ; type: \"SQUARE_LOGO\" } +• **logo**: { $type: \"com.linkedin.voyager.organization.CompanyLogoImage\" ; image: [LinkedInVectorImage](_src_entities_linkedin_vector_image_entity_.linkedinvectorimage.md) ; type: \"SQUARE\_LOGO\" } -_Defined in [src/entities/linkedin-base-company.ts:13](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-base-company.ts#L13)_ +*Defined in [src/entities/linkedin-base-company.ts:13](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-base-company.ts#L13)* #### Type declaration: -| Name | Type | -| ------- | ----------------------------------------------------------------------------------------- | -| `$type` | \"com.linkedin.voyager.organization.CompanyLogoImage\" | -| `image` | [LinkedInVectorImage](_src_entities_linkedin_vector_image_entity_.linkedinvectorimage.md) | -| `type` | \"SQUARE_LOGO\" | +Name | Type | +------ | ------ | +`$type` | \"com.linkedin.voyager.organization.CompanyLogoImage\" | +`image` | [LinkedInVectorImage](_src_entities_linkedin_vector_image_entity_.linkedinvectorimage.md) | +`type` | \"SQUARE\_LOGO\" | ---- +___ ### name -• **name**: string +• **name**: string -_Defined in [src/entities/linkedin-base-company.ts:18](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-base-company.ts#L18)_ +*Defined in [src/entities/linkedin-base-company.ts:18](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-base-company.ts#L18)* diff --git a/docs/interfaces/_src_entities_linkedin_collection_response_entity_.linkedincollectionresponse.md b/docs/interfaces/_src_entities_linkedin_collection_response_entity_.linkedincollectionresponse.md index b77cab5c..9b19f475 100644 --- a/docs/interfaces/_src_entities_linkedin_collection_response_entity_.linkedincollectionresponse.md +++ b/docs/interfaces/_src_entities_linkedin_collection_response_entity_.linkedincollectionresponse.md @@ -6,45 +6,45 @@ ## Type parameters -| Name | Default | -| ---- | --------- | -| `T` | - | -| `I` | - | -| `M` | undefined | +Name | Default | +------ | ------ | +`T` | - | +`I` | - | +`M` | undefined | ## Hierarchy -- **LinkedInCollectionResponse** +* **LinkedInCollectionResponse** ## Index ### Properties -- [data](_src_entities_linkedin_collection_response_entity_.linkedincollectionresponse.md#data) -- [included](_src_entities_linkedin_collection_response_entity_.linkedincollectionresponse.md#included) +* [data](_src_entities_linkedin_collection_response_entity_.linkedincollectionresponse.md#data) +* [included](_src_entities_linkedin_collection_response_entity_.linkedincollectionresponse.md#included) ## Properties ### data -• **data**: { $type: \"com.linkedin.restli.common.CollectionResponse\" ; elements: T[] ; entityUrn: string ; metadata?: M ; paging: Paging } +• **data**: { $type: \"com.linkedin.restli.common.CollectionResponse\" ; elements: T[] ; entityUrn: string ; metadata?: M ; paging: Paging } -_Defined in [src/entities/linkedin-collection-response.entity.ts:8](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-collection-response.entity.ts#L8)_ +*Defined in [src/entities/linkedin-collection-response.entity.ts:8](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-collection-response.entity.ts#L8)* #### Type declaration: -| Name | Type | -| ----------- | ------------------------------------------------- | -| `$type` | \"com.linkedin.restli.common.CollectionResponse\" | -| `elements` | T[] | -| `entityUrn` | string | -| `metadata?` | M | -| `paging` | Paging | +Name | Type | +------ | ------ | +`$type` | \"com.linkedin.restli.common.CollectionResponse\" | +`elements` | T[] | +`entityUrn` | string | +`metadata?` | M | +`paging` | Paging | ---- +___ ### included -• **included**: I[] +• **included**: I[] -_Defined in [src/entities/linkedin-collection-response.entity.ts:15](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-collection-response.entity.ts#L15)_ +*Defined in [src/entities/linkedin-collection-response.entity.ts:15](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-collection-response.entity.ts#L15)* diff --git a/docs/interfaces/_src_entities_linkedin_company_entity_.linkedincompany.md b/docs/interfaces/_src_entities_linkedin_company_entity_.linkedincompany.md index 06873ec0..d7ac7c79 100644 --- a/docs/interfaces/_src_entities_linkedin_company_entity_.linkedincompany.md +++ b/docs/interfaces/_src_entities_linkedin_company_entity_.linkedincompany.md @@ -6,105 +6,105 @@ ## Hierarchy -- **LinkedInCompany** +* **LinkedInCompany** ## Index ### Properties -- [$anti_abuse_annotations](_src_entities_linkedin_company_entity_.linkedincompany.md#$anti_abuse_annotations) -- [$recipeTypes](_src_entities_linkedin_company_entity_.linkedincompany.md#$recipetypes) -- [$type](_src_entities_linkedin_company_entity_.linkedincompany.md#$type) -- [entityUrn](_src_entities_linkedin_company_entity_.linkedincompany.md#entityurn) -- [industry](_src_entities_linkedin_company_entity_.linkedincompany.md#industry) -- [industryUrns](_src_entities_linkedin_company_entity_.linkedincompany.md#industryurns) -- [logo](_src_entities_linkedin_company_entity_.linkedincompany.md#logo) -- [name](_src_entities_linkedin_company_entity_.linkedincompany.md#name) -- [universalName](_src_entities_linkedin_company_entity_.linkedincompany.md#universalname) -- [url](_src_entities_linkedin_company_entity_.linkedincompany.md#url) +* [$anti\_abuse\_annotations](_src_entities_linkedin_company_entity_.linkedincompany.md#$anti_abuse_annotations) +* [$recipeTypes](_src_entities_linkedin_company_entity_.linkedincompany.md#$recipetypes) +* [$type](_src_entities_linkedin_company_entity_.linkedincompany.md#$type) +* [entityUrn](_src_entities_linkedin_company_entity_.linkedincompany.md#entityurn) +* [industry](_src_entities_linkedin_company_entity_.linkedincompany.md#industry) +* [industryUrns](_src_entities_linkedin_company_entity_.linkedincompany.md#industryurns) +* [logo](_src_entities_linkedin_company_entity_.linkedincompany.md#logo) +* [name](_src_entities_linkedin_company_entity_.linkedincompany.md#name) +* [universalName](_src_entities_linkedin_company_entity_.linkedincompany.md#universalname) +* [url](_src_entities_linkedin_company_entity_.linkedincompany.md#url) ## Properties -### $anti_abuse_annotations +### $anti\_abuse\_annotations -• **$anti_abuse_annotations**: { attributeId: number ; entityId: number }[] +• **$anti\_abuse\_annotations**: { attributeId: number ; entityId: number }[] -_Defined in [src/entities/linkedin-company.entity.ts:7](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-company.entity.ts#L7)_ +*Defined in [src/entities/linkedin-company.entity.ts:7](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-company.entity.ts#L7)* ---- +___ ### $recipeTypes -• **$recipeTypes**: string[] +• **$recipeTypes**: string[] -_Defined in [src/entities/linkedin-company.entity.ts:11](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-company.entity.ts#L11)_ +*Defined in [src/entities/linkedin-company.entity.ts:11](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-company.entity.ts#L11)* ---- +___ ### $type -• **$type**: _typeof_ [COMPANY_TYPE](../modules/_src_entities_linkedin_company_entity_.md#company_type) +• **$type**: *typeof* [COMPANY\_TYPE](../modules/_src_entities_linkedin_company_entity_.md#company_type) -_Defined in [src/entities/linkedin-company.entity.ts:6](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-company.entity.ts#L6)_ +*Defined in [src/entities/linkedin-company.entity.ts:6](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-company.entity.ts#L6)* ---- +___ ### entityUrn -• **entityUrn**: string +• **entityUrn**: string -_Defined in [src/entities/linkedin-company.entity.ts:12](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-company.entity.ts#L12)_ +*Defined in [src/entities/linkedin-company.entity.ts:12](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-company.entity.ts#L12)* ---- +___ ### industry -• **industry**: Record +• **industry**: Record -_Defined in [src/entities/linkedin-company.entity.ts:13](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-company.entity.ts#L13)_ +*Defined in [src/entities/linkedin-company.entity.ts:13](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-company.entity.ts#L13)* ---- +___ ### industryUrns -• **industryUrns**: string[] +• **industryUrns**: string[] -_Defined in [src/entities/linkedin-company.entity.ts:14](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-company.entity.ts#L14)_ +*Defined in [src/entities/linkedin-company.entity.ts:14](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-company.entity.ts#L14)* ---- +___ ### logo -• **logo**: { vetorImage: [LinkedInVectorImage](_src_entities_linkedin_vector_image_entity_.linkedinvectorimage.md) } +• **logo**: { vetorImage: [LinkedInVectorImage](_src_entities_linkedin_vector_image_entity_.linkedinvectorimage.md) } -_Defined in [src/entities/linkedin-company.entity.ts:15](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-company.entity.ts#L15)_ +*Defined in [src/entities/linkedin-company.entity.ts:15](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-company.entity.ts#L15)* #### Type declaration: -| Name | Type | -| ------------ | ----------------------------------------------------------------------------------------- | -| `vetorImage` | [LinkedInVectorImage](_src_entities_linkedin_vector_image_entity_.linkedinvectorimage.md) | +Name | Type | +------ | ------ | +`vetorImage` | [LinkedInVectorImage](_src_entities_linkedin_vector_image_entity_.linkedinvectorimage.md) | ---- +___ ### name -• **name**: string +• **name**: string -_Defined in [src/entities/linkedin-company.entity.ts:18](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-company.entity.ts#L18)_ +*Defined in [src/entities/linkedin-company.entity.ts:18](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-company.entity.ts#L18)* ---- +___ ### universalName -• **universalName**: string +• **universalName**: string -_Defined in [src/entities/linkedin-company.entity.ts:19](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-company.entity.ts#L19)_ +*Defined in [src/entities/linkedin-company.entity.ts:19](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-company.entity.ts#L19)* ---- +___ ### url -• **url**: string +• **url**: string -_Defined in [src/entities/linkedin-company.entity.ts:20](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-company.entity.ts#L20)_ +*Defined in [src/entities/linkedin-company.entity.ts:20](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-company.entity.ts#L20)* diff --git a/docs/interfaces/_src_entities_linkedin_conversation_entity_.linkedinconversation.md b/docs/interfaces/_src_entities_linkedin_conversation_entity_.linkedinconversation.md index 4d775133..b9a30770 100644 --- a/docs/interfaces/_src_entities_linkedin_conversation_entity_.linkedinconversation.md +++ b/docs/interfaces/_src_entities_linkedin_conversation_entity_.linkedinconversation.md @@ -6,7 +6,7 @@ ## Hierarchy -- **LinkedinConversation** +* **LinkedinConversation** ↳ [Conversation](_src_entities_conversation_entity_.conversation.md) @@ -14,174 +14,174 @@ ### Properties -- [$type](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#$type) -- [\*events](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#*events) -- [\*participants](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#*participants) -- [\*type](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#*type) -- [archived](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#archived) -- [backendUrn](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#backendurn) -- [blocked](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#blocked) -- [entityUrn](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#entityurn) -- [featureTypes](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#featuretypes) -- [firstMessageUrn](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#firstmessageurn) -- [lastActivityAt](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#lastactivityat) -- [muted](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#muted) -- [notificationStatus](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#notificationstatus) -- [read](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#read) -- [receipts](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#receipts) -- [totalEventCount](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#totaleventcount) -- [unreadCount](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#unreadcount) -- [viewerCurrentParticipant](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#viewercurrentparticipant) -- [withNonConnection](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#withnonconnection) +* [$type](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#$type) +* [*events](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#*events) +* [*participants](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#*participants) +* [*type](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#*type) +* [archived](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#archived) +* [backendUrn](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#backendurn) +* [blocked](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#blocked) +* [entityUrn](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#entityurn) +* [featureTypes](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#featuretypes) +* [firstMessageUrn](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#firstmessageurn) +* [lastActivityAt](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#lastactivityat) +* [muted](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#muted) +* [notificationStatus](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#notificationstatus) +* [read](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#read) +* [receipts](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#receipts) +* [totalEventCount](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#totaleventcount) +* [unreadCount](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#unreadcount) +* [viewerCurrentParticipant](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#viewercurrentparticipant) +* [withNonConnection](_src_entities_linkedin_conversation_entity_.linkedinconversation.md#withnonconnection) ## Properties ### $type -• **$type**: _typeof_ [CONVERSATION_TYPE](../modules/_src_entities_linkedin_conversation_entity_.md#conversation_type) +• **$type**: *typeof* [CONVERSATION\_TYPE](../modules/_src_entities_linkedin_conversation_entity_.md#conversation_type) -_Defined in [src/entities/linkedin-conversation.entity.ts:26](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-conversation.entity.ts#L26)_ +*Defined in [src/entities/linkedin-conversation.entity.ts:26](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-conversation.entity.ts#L26)* ---- +___ -### \*events +### *events -• **\*events**: string[] +• ***events**: string[] -_Defined in [src/entities/linkedin-conversation.entity.ts:27](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-conversation.entity.ts#L27)_ +*Defined in [src/entities/linkedin-conversation.entity.ts:27](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-conversation.entity.ts#L27)* ---- +___ -### \*participants +### *participants -• **\*participants**: string[] +• ***participants**: string[] -_Defined in [src/entities/linkedin-conversation.entity.ts:28](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-conversation.entity.ts#L28)_ +*Defined in [src/entities/linkedin-conversation.entity.ts:28](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-conversation.entity.ts#L28)* ---- +___ -### \*type +### *type -• **\*type**: string[] +• ***type**: string[] -_Defined in [src/entities/linkedin-conversation.entity.ts:29](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-conversation.entity.ts#L29)_ +*Defined in [src/entities/linkedin-conversation.entity.ts:29](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-conversation.entity.ts#L29)* ---- +___ ### archived -• **archived**: boolean +• **archived**: boolean -_Defined in [src/entities/linkedin-conversation.entity.ts:30](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-conversation.entity.ts#L30)_ +*Defined in [src/entities/linkedin-conversation.entity.ts:30](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-conversation.entity.ts#L30)* ---- +___ ### backendUrn -• **backendUrn**: string +• **backendUrn**: string -_Defined in [src/entities/linkedin-conversation.entity.ts:31](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-conversation.entity.ts#L31)_ +*Defined in [src/entities/linkedin-conversation.entity.ts:31](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-conversation.entity.ts#L31)* ---- +___ ### blocked -• **blocked**: boolean +• **blocked**: boolean -_Defined in [src/entities/linkedin-conversation.entity.ts:32](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-conversation.entity.ts#L32)_ +*Defined in [src/entities/linkedin-conversation.entity.ts:32](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-conversation.entity.ts#L32)* ---- +___ ### entityUrn -• **entityUrn**: [ConversationUrn](../modules/_src_entities_linkedin_conversation_entity_.md#conversationurn) +• **entityUrn**: [ConversationUrn](../modules/_src_entities_linkedin_conversation_entity_.md#conversationurn) -_Defined in [src/entities/linkedin-conversation.entity.ts:33](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-conversation.entity.ts#L33)_ +*Defined in [src/entities/linkedin-conversation.entity.ts:33](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-conversation.entity.ts#L33)* ---- +___ ### featureTypes -• **featureTypes**: [FeaturedType](../enums/_src_entities_linkedin_conversation_entity_.featuredtype.md)[] +• **featureTypes**: [FeaturedType](../enums/_src_entities_linkedin_conversation_entity_.featuredtype.md)[] -_Defined in [src/entities/linkedin-conversation.entity.ts:34](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-conversation.entity.ts#L34)_ +*Defined in [src/entities/linkedin-conversation.entity.ts:34](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-conversation.entity.ts#L34)* ---- +___ ### firstMessageUrn -• **firstMessageUrn**: string +• **firstMessageUrn**: string -_Defined in [src/entities/linkedin-conversation.entity.ts:35](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-conversation.entity.ts#L35)_ +*Defined in [src/entities/linkedin-conversation.entity.ts:35](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-conversation.entity.ts#L35)* ---- +___ ### lastActivityAt -• **lastActivityAt**: number +• **lastActivityAt**: number -_Defined in [src/entities/linkedin-conversation.entity.ts:36](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-conversation.entity.ts#L36)_ +*Defined in [src/entities/linkedin-conversation.entity.ts:36](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-conversation.entity.ts#L36)* ---- +___ ### muted -• **muted**: boolean +• **muted**: boolean -_Defined in [src/entities/linkedin-conversation.entity.ts:37](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-conversation.entity.ts#L37)_ +*Defined in [src/entities/linkedin-conversation.entity.ts:37](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-conversation.entity.ts#L37)* ---- +___ ### notificationStatus -• **notificationStatus**: string +• **notificationStatus**: string -_Defined in [src/entities/linkedin-conversation.entity.ts:38](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-conversation.entity.ts#L38)_ +*Defined in [src/entities/linkedin-conversation.entity.ts:38](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-conversation.entity.ts#L38)* ---- +___ ### read -• **read**: boolean +• **read**: boolean -_Defined in [src/entities/linkedin-conversation.entity.ts:39](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-conversation.entity.ts#L39)_ +*Defined in [src/entities/linkedin-conversation.entity.ts:39](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-conversation.entity.ts#L39)* ---- +___ ### receipts -• **receipts**: [LinkedInParticipantReceipts](_src_entities_linkedin_conversation_entity_.linkedinparticipantreceipts.md)[] +• **receipts**: [LinkedInParticipantReceipts](_src_entities_linkedin_conversation_entity_.linkedinparticipantreceipts.md)[] -_Defined in [src/entities/linkedin-conversation.entity.ts:40](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-conversation.entity.ts#L40)_ +*Defined in [src/entities/linkedin-conversation.entity.ts:40](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-conversation.entity.ts#L40)* ---- +___ ### totalEventCount -• **totalEventCount**: number +• **totalEventCount**: number -_Defined in [src/entities/linkedin-conversation.entity.ts:41](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-conversation.entity.ts#L41)_ +*Defined in [src/entities/linkedin-conversation.entity.ts:41](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-conversation.entity.ts#L41)* ---- +___ ### unreadCount -• **unreadCount**: number +• **unreadCount**: number -_Defined in [src/entities/linkedin-conversation.entity.ts:42](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-conversation.entity.ts#L42)_ +*Defined in [src/entities/linkedin-conversation.entity.ts:42](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-conversation.entity.ts#L42)* ---- +___ ### viewerCurrentParticipant -• **viewerCurrentParticipant**: boolean +• **viewerCurrentParticipant**: boolean -_Defined in [src/entities/linkedin-conversation.entity.ts:43](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-conversation.entity.ts#L43)_ +*Defined in [src/entities/linkedin-conversation.entity.ts:43](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-conversation.entity.ts#L43)* ---- +___ ### withNonConnection -• **withNonConnection**: boolean +• **withNonConnection**: boolean -_Defined in [src/entities/linkedin-conversation.entity.ts:44](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-conversation.entity.ts#L44)_ +*Defined in [src/entities/linkedin-conversation.entity.ts:44](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-conversation.entity.ts#L44)* diff --git a/docs/interfaces/_src_entities_linkedin_conversation_entity_.linkedinparticipantreceipts.md b/docs/interfaces/_src_entities_linkedin_conversation_entity_.linkedinparticipantreceipts.md index de5f7cfc..9b7db17f 100644 --- a/docs/interfaces/_src_entities_linkedin_conversation_entity_.linkedinparticipantreceipts.md +++ b/docs/interfaces/_src_entities_linkedin_conversation_entity_.linkedinparticipantreceipts.md @@ -6,45 +6,45 @@ ## Hierarchy -- **LinkedInParticipantReceipts** +* **LinkedInParticipantReceipts** ## Index ### Properties -- [$type](_src_entities_linkedin_conversation_entity_.linkedinparticipantreceipts.md#$type) -- [fromEntity](_src_entities_linkedin_conversation_entity_.linkedinparticipantreceipts.md#fromentity) -- [fromParticipant](_src_entities_linkedin_conversation_entity_.linkedinparticipantreceipts.md#fromparticipant) -- [seenReceipt](_src_entities_linkedin_conversation_entity_.linkedinparticipantreceipts.md#seenreceipt) +* [$type](_src_entities_linkedin_conversation_entity_.linkedinparticipantreceipts.md#$type) +* [fromEntity](_src_entities_linkedin_conversation_entity_.linkedinparticipantreceipts.md#fromentity) +* [fromParticipant](_src_entities_linkedin_conversation_entity_.linkedinparticipantreceipts.md#fromparticipant) +* [seenReceipt](_src_entities_linkedin_conversation_entity_.linkedinparticipantreceipts.md#seenreceipt) ## Properties ### $type -• **$type**: \"com.linkedin.voyager.messaging.ParticipantReceipts\" +• **$type**: \"com.linkedin.voyager.messaging.ParticipantReceipts\" -_Defined in [src/entities/linkedin-conversation.entity.ts:15](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-conversation.entity.ts#L15)_ +*Defined in [src/entities/linkedin-conversation.entity.ts:15](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-conversation.entity.ts#L15)* ---- +___ ### fromEntity -• **fromEntity**: [MiniProfileUrn](../modules/_src_entities_linkedin_mini_profile_entity_.md#miniprofileurn) +• **fromEntity**: [MiniProfileUrn](../modules/_src_entities_linkedin_mini_profile_entity_.md#miniprofileurn) -_Defined in [src/entities/linkedin-conversation.entity.ts:16](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-conversation.entity.ts#L16)_ +*Defined in [src/entities/linkedin-conversation.entity.ts:16](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-conversation.entity.ts#L16)* ---- +___ ### fromParticipant -• **fromParticipant**: string +• **fromParticipant**: string -_Defined in [src/entities/linkedin-conversation.entity.ts:17](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-conversation.entity.ts#L17)_ +*Defined in [src/entities/linkedin-conversation.entity.ts:17](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-conversation.entity.ts#L17)* ---- +___ ### seenReceipt -• **seenReceipt**: LinkedInSeenReceipt +• **seenReceipt**: LinkedInSeenReceipt -_Defined in [src/entities/linkedin-conversation.entity.ts:18](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-conversation.entity.ts#L18)_ +*Defined in [src/entities/linkedin-conversation.entity.ts:18](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-conversation.entity.ts#L18)* diff --git a/docs/interfaces/_src_entities_linkedin_event_create_response_.linkedeventcreateresponse.md b/docs/interfaces/_src_entities_linkedin_event_create_response_.linkedeventcreateresponse.md index da297da4..0cd5fac6 100644 --- a/docs/interfaces/_src_entities_linkedin_event_create_response_.linkedeventcreateresponse.md +++ b/docs/interfaces/_src_entities_linkedin_event_create_response_.linkedeventcreateresponse.md @@ -6,7 +6,7 @@ ## Hierarchy -- **LinkedEventCreateResponse** +* **LinkedEventCreateResponse** ↳ [MessageEventCreateResponse](_src_entities_message_create_response_entity_.messageeventcreateresponse.md) @@ -14,57 +14,57 @@ ### Properties -- [$type](_src_entities_linkedin_event_create_response_.linkedeventcreateresponse.md#$type) -- [backendConversationUrn](_src_entities_linkedin_event_create_response_.linkedeventcreateresponse.md#backendconversationurn) -- [backendEventUrn](_src_entities_linkedin_event_create_response_.linkedeventcreateresponse.md#backendeventurn) -- [conversationUrn](_src_entities_linkedin_event_create_response_.linkedeventcreateresponse.md#conversationurn) -- [createdAt](_src_entities_linkedin_event_create_response_.linkedeventcreateresponse.md#createdat) -- [eventUrn](_src_entities_linkedin_event_create_response_.linkedeventcreateresponse.md#eventurn) +* [$type](_src_entities_linkedin_event_create_response_.linkedeventcreateresponse.md#$type) +* [backendConversationUrn](_src_entities_linkedin_event_create_response_.linkedeventcreateresponse.md#backendconversationurn) +* [backendEventUrn](_src_entities_linkedin_event_create_response_.linkedeventcreateresponse.md#backendeventurn) +* [conversationUrn](_src_entities_linkedin_event_create_response_.linkedeventcreateresponse.md#conversationurn) +* [createdAt](_src_entities_linkedin_event_create_response_.linkedeventcreateresponse.md#createdat) +* [eventUrn](_src_entities_linkedin_event_create_response_.linkedeventcreateresponse.md#eventurn) ## Properties ### $type -• **$type**: \"com.linkedin.voyager.messaging.create.EventCreateResponse\" +• **$type**: \"com.linkedin.voyager.messaging.create.EventCreateResponse\" -_Defined in [src/entities/linkedin-event-create-response.ts:2](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-event-create-response.ts#L2)_ +*Defined in [src/entities/linkedin-event-create-response.ts:2](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-event-create-response.ts#L2)* ---- +___ ### backendConversationUrn -• **backendConversationUrn**: string +• **backendConversationUrn**: string -_Defined in [src/entities/linkedin-event-create-response.ts:3](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-event-create-response.ts#L3)_ +*Defined in [src/entities/linkedin-event-create-response.ts:3](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-event-create-response.ts#L3)* ---- +___ ### backendEventUrn -• **backendEventUrn**: string +• **backendEventUrn**: string -_Defined in [src/entities/linkedin-event-create-response.ts:4](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-event-create-response.ts#L4)_ +*Defined in [src/entities/linkedin-event-create-response.ts:4](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-event-create-response.ts#L4)* ---- +___ ### conversationUrn -• **conversationUrn**: string +• **conversationUrn**: string -_Defined in [src/entities/linkedin-event-create-response.ts:5](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-event-create-response.ts#L5)_ +*Defined in [src/entities/linkedin-event-create-response.ts:5](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-event-create-response.ts#L5)* ---- +___ ### createdAt -• **createdAt**: number +• **createdAt**: number -_Defined in [src/entities/linkedin-event-create-response.ts:6](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-event-create-response.ts#L6)_ +*Defined in [src/entities/linkedin-event-create-response.ts:6](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-event-create-response.ts#L6)* ---- +___ ### eventUrn -• **eventUrn**: string +• **eventUrn**: string -_Defined in [src/entities/linkedin-event-create-response.ts:7](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-event-create-response.ts#L7)_ +*Defined in [src/entities/linkedin-event-create-response.ts:7](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-event-create-response.ts#L7)* diff --git a/docs/interfaces/_src_entities_linkedin_event_entity_.linkedinevent.md b/docs/interfaces/_src_entities_linkedin_event_entity_.linkedinevent.md index d7b38571..96708b6d 100644 --- a/docs/interfaces/_src_entities_linkedin_event_entity_.linkedinevent.md +++ b/docs/interfaces/_src_entities_linkedin_event_entity_.linkedinevent.md @@ -6,7 +6,7 @@ ## Hierarchy -- **LinkedInEvent** +* **LinkedInEvent** ↳ [LinkedInMessageEvent](_src_entities_linkedin_message_event_entity_.linkedinmessageevent.md) @@ -14,93 +14,93 @@ ### Properties -- [$type](_src_entities_linkedin_event_entity_.linkedinevent.md#$type) -- [\*from](_src_entities_linkedin_event_entity_.linkedinevent.md#*from) -- [backendUrn](_src_entities_linkedin_event_entity_.linkedinevent.md#backendurn) -- [createdAt](_src_entities_linkedin_event_entity_.linkedinevent.md#createdat) -- [dashEntityUrn](_src_entities_linkedin_event_entity_.linkedinevent.md#dashentityurn) -- [entityUrn](_src_entities_linkedin_event_entity_.linkedinevent.md#entityurn) -- [eventContent](_src_entities_linkedin_event_entity_.linkedinevent.md#eventcontent) -- [originToken](_src_entities_linkedin_event_entity_.linkedinevent.md#origintoken) -- [previousEventInConversation](_src_entities_linkedin_event_entity_.linkedinevent.md#previouseventinconversation) -- [subtype](_src_entities_linkedin_event_entity_.linkedinevent.md#subtype) +* [$type](_src_entities_linkedin_event_entity_.linkedinevent.md#$type) +* [*from](_src_entities_linkedin_event_entity_.linkedinevent.md#*from) +* [backendUrn](_src_entities_linkedin_event_entity_.linkedinevent.md#backendurn) +* [createdAt](_src_entities_linkedin_event_entity_.linkedinevent.md#createdat) +* [dashEntityUrn](_src_entities_linkedin_event_entity_.linkedinevent.md#dashentityurn) +* [entityUrn](_src_entities_linkedin_event_entity_.linkedinevent.md#entityurn) +* [eventContent](_src_entities_linkedin_event_entity_.linkedinevent.md#eventcontent) +* [originToken](_src_entities_linkedin_event_entity_.linkedinevent.md#origintoken) +* [previousEventInConversation](_src_entities_linkedin_event_entity_.linkedinevent.md#previouseventinconversation) +* [subtype](_src_entities_linkedin_event_entity_.linkedinevent.md#subtype) ## Properties ### $type -• **$type**: _typeof_ [EVENT_TYPE](../modules/_src_entities_linkedin_event_entity_.md#event_type) +• **$type**: *typeof* [EVENT\_TYPE](../modules/_src_entities_linkedin_event_entity_.md#event_type) -_Defined in [src/entities/linkedin-event.entity.ts:6](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-event.entity.ts#L6)_ +*Defined in [src/entities/linkedin-event.entity.ts:6](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-event.entity.ts#L6)* ---- +___ -### \*from +### *from -• **\*from**: string +• ***from**: string -_Defined in [src/entities/linkedin-event.entity.ts:7](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-event.entity.ts#L7)_ +*Defined in [src/entities/linkedin-event.entity.ts:7](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-event.entity.ts#L7)* ---- +___ ### backendUrn -• **backendUrn**: string +• **backendUrn**: string -_Defined in [src/entities/linkedin-event.entity.ts:8](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-event.entity.ts#L8)_ +*Defined in [src/entities/linkedin-event.entity.ts:8](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-event.entity.ts#L8)* ---- +___ ### createdAt -• **createdAt**: number +• **createdAt**: number -_Defined in [src/entities/linkedin-event.entity.ts:9](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-event.entity.ts#L9)_ +*Defined in [src/entities/linkedin-event.entity.ts:9](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-event.entity.ts#L9)* ---- +___ ### dashEntityUrn -• **dashEntityUrn**: string +• **dashEntityUrn**: string -_Defined in [src/entities/linkedin-event.entity.ts:10](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-event.entity.ts#L10)_ +*Defined in [src/entities/linkedin-event.entity.ts:10](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-event.entity.ts#L10)* ---- +___ ### entityUrn -• **entityUrn**: [LinkedInEventUrn](../modules/_src_entities_linkedin_event_entity_.md#linkedineventurn) +• **entityUrn**: [LinkedInEventUrn](../modules/_src_entities_linkedin_event_entity_.md#linkedineventurn) -_Defined in [src/entities/linkedin-event.entity.ts:11](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-event.entity.ts#L11)_ +*Defined in [src/entities/linkedin-event.entity.ts:11](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-event.entity.ts#L11)* ---- +___ ### eventContent -• **eventContent**: unknown +• **eventContent**: unknown -_Defined in [src/entities/linkedin-event.entity.ts:12](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-event.entity.ts#L12)_ +*Defined in [src/entities/linkedin-event.entity.ts:12](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-event.entity.ts#L12)* ---- +___ ### originToken -• **originToken**: string +• **originToken**: string -_Defined in [src/entities/linkedin-event.entity.ts:13](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-event.entity.ts#L13)_ +*Defined in [src/entities/linkedin-event.entity.ts:13](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-event.entity.ts#L13)* ---- +___ ### previousEventInConversation • `Optional` **previousEventInConversation**: undefined \| string -_Defined in [src/entities/linkedin-event.entity.ts:15](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-event.entity.ts#L15)_ +*Defined in [src/entities/linkedin-event.entity.ts:15](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-event.entity.ts#L15)* ---- +___ ### subtype -• **subtype**: string +• **subtype**: string -_Defined in [src/entities/linkedin-event.entity.ts:14](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-event.entity.ts#L14)_ +*Defined in [src/entities/linkedin-event.entity.ts:14](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-event.entity.ts#L14)* diff --git a/docs/interfaces/_src_entities_linkedin_image_attribute_entity_.linkedinimageattribute.md b/docs/interfaces/_src_entities_linkedin_image_attribute_entity_.linkedinimageattribute.md index 3b7a02da..4c83ffb5 100644 --- a/docs/interfaces/_src_entities_linkedin_image_attribute_entity_.linkedinimageattribute.md +++ b/docs/interfaces/_src_entities_linkedin_image_attribute_entity_.linkedinimageattribute.md @@ -6,36 +6,36 @@ ## Hierarchy -- **LinkedInImageAttribute** +* **LinkedInImageAttribute** ## Index ### Properties -- [$type](_src_entities_linkedin_image_attribute_entity_.linkedinimageattribute.md#$type) -- [\*miniProfile](_src_entities_linkedin_image_attribute_entity_.linkedinimageattribute.md#*miniprofile) -- [sourceType](_src_entities_linkedin_image_attribute_entity_.linkedinimageattribute.md#sourcetype) +* [$type](_src_entities_linkedin_image_attribute_entity_.linkedinimageattribute.md#$type) +* [*miniProfile](_src_entities_linkedin_image_attribute_entity_.linkedinimageattribute.md#*miniprofile) +* [sourceType](_src_entities_linkedin_image_attribute_entity_.linkedinimageattribute.md#sourcetype) ## Properties ### $type -• **$type**: \"com.linkedin.voyager.common.ImageAttribute\" +• **$type**: \"com.linkedin.voyager.common.ImageAttribute\" -_Defined in [src/entities/linkedin-image-attribute.entity.ts:2](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-image-attribute.entity.ts#L2)_ +*Defined in [src/entities/linkedin-image-attribute.entity.ts:2](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-image-attribute.entity.ts#L2)* ---- +___ -### \*miniProfile +### *miniProfile -• **\*miniProfile**: string +• ***miniProfile**: string -_Defined in [src/entities/linkedin-image-attribute.entity.ts:3](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-image-attribute.entity.ts#L3)_ +*Defined in [src/entities/linkedin-image-attribute.entity.ts:3](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-image-attribute.entity.ts#L3)* ---- +___ ### sourceType -• **sourceType**: string +• **sourceType**: string -_Defined in [src/entities/linkedin-image-attribute.entity.ts:4](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-image-attribute.entity.ts#L4)_ +*Defined in [src/entities/linkedin-image-attribute.entity.ts:4](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-image-attribute.entity.ts#L4)* diff --git a/docs/interfaces/_src_entities_linkedin_image_view_model_entity_.linkedinimageviewmodel.md b/docs/interfaces/_src_entities_linkedin_image_view_model_entity_.linkedinimageviewmodel.md index 58c4c0bb..0de0249a 100644 --- a/docs/interfaces/_src_entities_linkedin_image_view_model_entity_.linkedinimageviewmodel.md +++ b/docs/interfaces/_src_entities_linkedin_image_view_model_entity_.linkedinimageviewmodel.md @@ -6,27 +6,27 @@ ## Hierarchy -- **LinkedInImageViewModel** +* **LinkedInImageViewModel** ## Index ### Properties -- [$type](_src_entities_linkedin_image_view_model_entity_.linkedinimageviewmodel.md#$type) -- [attributes](_src_entities_linkedin_image_view_model_entity_.linkedinimageviewmodel.md#attributes) +* [$type](_src_entities_linkedin_image_view_model_entity_.linkedinimageviewmodel.md#$type) +* [attributes](_src_entities_linkedin_image_view_model_entity_.linkedinimageviewmodel.md#attributes) ## Properties ### $type -• **$type**: \"com.linkedin.voyager.common.ImageViewModel\" +• **$type**: \"com.linkedin.voyager.common.ImageViewModel\" -_Defined in [src/entities/linkedin-image-view-model.entity.ts:4](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-image-view-model.entity.ts#L4)_ +*Defined in [src/entities/linkedin-image-view-model.entity.ts:4](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-image-view-model.entity.ts#L4)* ---- +___ ### attributes -• **attributes**: [LinkedInImageAttribute](_src_entities_linkedin_image_attribute_entity_.linkedinimageattribute.md)[] +• **attributes**: [LinkedInImageAttribute](_src_entities_linkedin_image_attribute_entity_.linkedinimageattribute.md)[] -_Defined in [src/entities/linkedin-image-view-model.entity.ts:5](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-image-view-model.entity.ts#L5)_ +*Defined in [src/entities/linkedin-image-view-model.entity.ts:5](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-image-view-model.entity.ts#L5)* diff --git a/docs/interfaces/_src_entities_linkedin_invitation_entity_.linkedininvitation.md b/docs/interfaces/_src_entities_linkedin_invitation_entity_.linkedininvitation.md index 63f60ecf..49450966 100644 --- a/docs/interfaces/_src_entities_linkedin_invitation_entity_.linkedininvitation.md +++ b/docs/interfaces/_src_entities_linkedin_invitation_entity_.linkedininvitation.md @@ -6,7 +6,7 @@ ## Hierarchy -- **LinkedInInvitation** +* **LinkedInInvitation** ↳ [Invitation](_src_entities_invitation_entity_.invitation.md) @@ -14,111 +14,111 @@ ### Properties -- [$type](_src_entities_linkedin_invitation_entity_.linkedininvitation.md#$type) -- [\*fromMember](_src_entities_linkedin_invitation_entity_.linkedininvitation.md#*frommember) -- [\*toMember](_src_entities_linkedin_invitation_entity_.linkedininvitation.md#*tomember) -- [customMessage](_src_entities_linkedin_invitation_entity_.linkedininvitation.md#custommessage) -- [entityUrn](_src_entities_linkedin_invitation_entity_.linkedininvitation.md#entityurn) -- [invitationType](_src_entities_linkedin_invitation_entity_.linkedininvitation.md#invitationtype) -- [invitee](_src_entities_linkedin_invitation_entity_.linkedininvitation.md#invitee) -- [mailboxItemId](_src_entities_linkedin_invitation_entity_.linkedininvitation.md#mailboxitemid) -- [sentTime](_src_entities_linkedin_invitation_entity_.linkedininvitation.md#senttime) -- [sharedSecret](_src_entities_linkedin_invitation_entity_.linkedininvitation.md#sharedsecret) -- [toMemberId](_src_entities_linkedin_invitation_entity_.linkedininvitation.md#tomemberid) -- [unseen](_src_entities_linkedin_invitation_entity_.linkedininvitation.md#unseen) +* [$type](_src_entities_linkedin_invitation_entity_.linkedininvitation.md#$type) +* [*fromMember](_src_entities_linkedin_invitation_entity_.linkedininvitation.md#*frommember) +* [*toMember](_src_entities_linkedin_invitation_entity_.linkedininvitation.md#*tomember) +* [customMessage](_src_entities_linkedin_invitation_entity_.linkedininvitation.md#custommessage) +* [entityUrn](_src_entities_linkedin_invitation_entity_.linkedininvitation.md#entityurn) +* [invitationType](_src_entities_linkedin_invitation_entity_.linkedininvitation.md#invitationtype) +* [invitee](_src_entities_linkedin_invitation_entity_.linkedininvitation.md#invitee) +* [mailboxItemId](_src_entities_linkedin_invitation_entity_.linkedininvitation.md#mailboxitemid) +* [sentTime](_src_entities_linkedin_invitation_entity_.linkedininvitation.md#senttime) +* [sharedSecret](_src_entities_linkedin_invitation_entity_.linkedininvitation.md#sharedsecret) +* [toMemberId](_src_entities_linkedin_invitation_entity_.linkedininvitation.md#tomemberid) +* [unseen](_src_entities_linkedin_invitation_entity_.linkedininvitation.md#unseen) ## Properties ### $type -• **$type**: _typeof_ [INVITATION_TYPE](../modules/_src_entities_linkedin_invitation_entity_.md#invitation_type) +• **$type**: *typeof* [INVITATION\_TYPE](../modules/_src_entities_linkedin_invitation_entity_.md#invitation_type) -_Defined in [src/entities/linkedin-invitation.entity.ts:16](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-invitation.entity.ts#L16)_ +*Defined in [src/entities/linkedin-invitation.entity.ts:16](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-invitation.entity.ts#L16)* ---- +___ -### \*fromMember +### *fromMember -• **\*fromMember**: [MiniProfileUrn](../modules/_src_entities_linkedin_mini_profile_entity_.md#miniprofileurn) +• ***fromMember**: [MiniProfileUrn](../modules/_src_entities_linkedin_mini_profile_entity_.md#miniprofileurn) -_Defined in [src/entities/linkedin-invitation.entity.ts:17](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-invitation.entity.ts#L17)_ +*Defined in [src/entities/linkedin-invitation.entity.ts:17](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-invitation.entity.ts#L17)* ---- +___ -### \*toMember +### *toMember -• **\*toMember**: [MiniProfileUrn](../modules/_src_entities_linkedin_mini_profile_entity_.md#miniprofileurn) +• ***toMember**: [MiniProfileUrn](../modules/_src_entities_linkedin_mini_profile_entity_.md#miniprofileurn) -_Defined in [src/entities/linkedin-invitation.entity.ts:18](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-invitation.entity.ts#L18)_ +*Defined in [src/entities/linkedin-invitation.entity.ts:18](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-invitation.entity.ts#L18)* ---- +___ ### customMessage -• **customMessage**: boolean +• **customMessage**: boolean -_Defined in [src/entities/linkedin-invitation.entity.ts:19](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-invitation.entity.ts#L19)_ +*Defined in [src/entities/linkedin-invitation.entity.ts:19](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-invitation.entity.ts#L19)* ---- +___ ### entityUrn -• **entityUrn**: string +• **entityUrn**: string -_Defined in [src/entities/linkedin-invitation.entity.ts:20](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-invitation.entity.ts#L20)_ +*Defined in [src/entities/linkedin-invitation.entity.ts:20](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-invitation.entity.ts#L20)* ---- +___ ### invitationType -• **invitationType**: InvitationType +• **invitationType**: InvitationType -_Defined in [src/entities/linkedin-invitation.entity.ts:21](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-invitation.entity.ts#L21)_ +*Defined in [src/entities/linkedin-invitation.entity.ts:21](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-invitation.entity.ts#L21)* ---- +___ ### invitee -• **invitee**: LinkedInProfileInvitee +• **invitee**: LinkedInProfileInvitee -_Defined in [src/entities/linkedin-invitation.entity.ts:22](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-invitation.entity.ts#L22)_ +*Defined in [src/entities/linkedin-invitation.entity.ts:22](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-invitation.entity.ts#L22)* ---- +___ ### mailboxItemId -• **mailboxItemId**: string +• **mailboxItemId**: string -_Defined in [src/entities/linkedin-invitation.entity.ts:23](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-invitation.entity.ts#L23)_ +*Defined in [src/entities/linkedin-invitation.entity.ts:23](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-invitation.entity.ts#L23)* ---- +___ ### sentTime -• **sentTime**: number +• **sentTime**: number -_Defined in [src/entities/linkedin-invitation.entity.ts:24](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-invitation.entity.ts#L24)_ +*Defined in [src/entities/linkedin-invitation.entity.ts:24](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-invitation.entity.ts#L24)* ---- +___ ### sharedSecret -• **sharedSecret**: string +• **sharedSecret**: string -_Defined in [src/entities/linkedin-invitation.entity.ts:25](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-invitation.entity.ts#L25)_ +*Defined in [src/entities/linkedin-invitation.entity.ts:25](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-invitation.entity.ts#L25)* ---- +___ ### toMemberId -• **toMemberId**: string +• **toMemberId**: string -_Defined in [src/entities/linkedin-invitation.entity.ts:26](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-invitation.entity.ts#L26)_ +*Defined in [src/entities/linkedin-invitation.entity.ts:26](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-invitation.entity.ts#L26)* ---- +___ ### unseen • `Optional` **unseen**: undefined \| false \| true -_Defined in [src/entities/linkedin-invitation.entity.ts:27](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-invitation.entity.ts#L27)_ +*Defined in [src/entities/linkedin-invitation.entity.ts:27](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-invitation.entity.ts#L27)* diff --git a/docs/interfaces/_src_entities_linkedin_job_posting_.linkedinjobposting.md b/docs/interfaces/_src_entities_linkedin_job_posting_.linkedinjobposting.md index 5ac6671a..fb018f69 100644 --- a/docs/interfaces/_src_entities_linkedin_job_posting_.linkedinjobposting.md +++ b/docs/interfaces/_src_entities_linkedin_job_posting_.linkedinjobposting.md @@ -6,90 +6,90 @@ ## Hierarchy -- **LinkedInJobPosting** +* **LinkedInJobPosting** ## Index ### Properties -- [$recipeTypes](_src_entities_linkedin_job_posting_.linkedinjobposting.md#$recipetypes) -- [$type](_src_entities_linkedin_job_posting_.linkedinjobposting.md#$type) -- [companyDetails](_src_entities_linkedin_job_posting_.linkedinjobposting.md#companydetails) -- [dashEntityUrn](_src_entities_linkedin_job_posting_.linkedinjobposting.md#dashentityurn) -- [entityUrn](_src_entities_linkedin_job_posting_.linkedinjobposting.md#entityurn) -- [formattedLocation](_src_entities_linkedin_job_posting_.linkedinjobposting.md#formattedlocation) -- [listedAt](_src_entities_linkedin_job_posting_.linkedinjobposting.md#listedat) -- [title](_src_entities_linkedin_job_posting_.linkedinjobposting.md#title) -- [workRemoteAllowed](_src_entities_linkedin_job_posting_.linkedinjobposting.md#workremoteallowed) +* [$recipeTypes](_src_entities_linkedin_job_posting_.linkedinjobposting.md#$recipetypes) +* [$type](_src_entities_linkedin_job_posting_.linkedinjobposting.md#$type) +* [companyDetails](_src_entities_linkedin_job_posting_.linkedinjobposting.md#companydetails) +* [dashEntityUrn](_src_entities_linkedin_job_posting_.linkedinjobposting.md#dashentityurn) +* [entityUrn](_src_entities_linkedin_job_posting_.linkedinjobposting.md#entityurn) +* [formattedLocation](_src_entities_linkedin_job_posting_.linkedinjobposting.md#formattedlocation) +* [listedAt](_src_entities_linkedin_job_posting_.linkedinjobposting.md#listedat) +* [title](_src_entities_linkedin_job_posting_.linkedinjobposting.md#title) +* [workRemoteAllowed](_src_entities_linkedin_job_posting_.linkedinjobposting.md#workremoteallowed) ## Properties ### $recipeTypes -• **$recipeTypes**: string[] +• **$recipeTypes**: string[] -_Defined in [src/entities/linkedin-job-posting.ts:12](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-job-posting.ts#L12)_ +*Defined in [src/entities/linkedin-job-posting.ts:12](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-job-posting.ts#L12)* ---- +___ ### $type -• **$type**: _typeof_ [JOB_POSTING_TYPE](../modules/_src_entities_linkedin_job_posting_.md#job_posting_type) +• **$type**: *typeof* [JOB\_POSTING\_TYPE](../modules/_src_entities_linkedin_job_posting_.md#job_posting_type) -_Defined in [src/entities/linkedin-job-posting.ts:11](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-job-posting.ts#L11)_ +*Defined in [src/entities/linkedin-job-posting.ts:11](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-job-posting.ts#L11)* ---- +___ ### companyDetails -• **companyDetails**: [LinkedInJobPostingCompany](_src_entities_linkedin_job_posting_.linkedinjobpostingcompany.md) +• **companyDetails**: [LinkedInJobPostingCompany](_src_entities_linkedin_job_posting_.linkedinjobpostingcompany.md) -_Defined in [src/entities/linkedin-job-posting.ts:19](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-job-posting.ts#L19)_ +*Defined in [src/entities/linkedin-job-posting.ts:19](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-job-posting.ts#L19)* ---- +___ ### dashEntityUrn -• **dashEntityUrn**: string +• **dashEntityUrn**: string -_Defined in [src/entities/linkedin-job-posting.ts:14](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-job-posting.ts#L14)_ +*Defined in [src/entities/linkedin-job-posting.ts:14](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-job-posting.ts#L14)* ---- +___ ### entityUrn -• **entityUrn**: string +• **entityUrn**: string -_Defined in [src/entities/linkedin-job-posting.ts:13](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-job-posting.ts#L13)_ +*Defined in [src/entities/linkedin-job-posting.ts:13](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-job-posting.ts#L13)* ---- +___ ### formattedLocation -• **formattedLocation**: string +• **formattedLocation**: string -_Defined in [src/entities/linkedin-job-posting.ts:15](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-job-posting.ts#L15)_ +*Defined in [src/entities/linkedin-job-posting.ts:15](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-job-posting.ts#L15)* ---- +___ ### listedAt -• **listedAt**: number +• **listedAt**: number -_Defined in [src/entities/linkedin-job-posting.ts:16](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-job-posting.ts#L16)_ +*Defined in [src/entities/linkedin-job-posting.ts:16](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-job-posting.ts#L16)* ---- +___ ### title -• **title**: string +• **title**: string -_Defined in [src/entities/linkedin-job-posting.ts:17](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-job-posting.ts#L17)_ +*Defined in [src/entities/linkedin-job-posting.ts:17](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-job-posting.ts#L17)* ---- +___ ### workRemoteAllowed -• **workRemoteAllowed**: boolean +• **workRemoteAllowed**: boolean -_Defined in [src/entities/linkedin-job-posting.ts:18](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-job-posting.ts#L18)_ +*Defined in [src/entities/linkedin-job-posting.ts:18](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-job-posting.ts#L18)* diff --git a/docs/interfaces/_src_entities_linkedin_job_posting_.linkedinjobpostingcompany.md b/docs/interfaces/_src_entities_linkedin_job_posting_.linkedinjobpostingcompany.md index 003652f8..584bd04b 100644 --- a/docs/interfaces/_src_entities_linkedin_job_posting_.linkedinjobpostingcompany.md +++ b/docs/interfaces/_src_entities_linkedin_job_posting_.linkedinjobpostingcompany.md @@ -6,45 +6,45 @@ ## Hierarchy -- **LinkedInJobPostingCompany** +* **LinkedInJobPostingCompany** ## Index ### Properties -- [$recipeTypes](_src_entities_linkedin_job_posting_.linkedinjobpostingcompany.md#$recipetypes) -- [$type](_src_entities_linkedin_job_posting_.linkedinjobpostingcompany.md#$type) -- [\*companyResolutionResult](_src_entities_linkedin_job_posting_.linkedinjobpostingcompany.md#*companyresolutionresult) -- [company](_src_entities_linkedin_job_posting_.linkedinjobpostingcompany.md#company) +* [$recipeTypes](_src_entities_linkedin_job_posting_.linkedinjobpostingcompany.md#$recipetypes) +* [$type](_src_entities_linkedin_job_posting_.linkedinjobpostingcompany.md#$type) +* [*companyResolutionResult](_src_entities_linkedin_job_posting_.linkedinjobpostingcompany.md#*companyresolutionresult) +* [company](_src_entities_linkedin_job_posting_.linkedinjobpostingcompany.md#company) ## Properties ### $recipeTypes -• **$recipeTypes**: string[] +• **$recipeTypes**: string[] -_Defined in [src/entities/linkedin-job-posting.ts:5](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-job-posting.ts#L5)_ +*Defined in [src/entities/linkedin-job-posting.ts:5](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-job-posting.ts#L5)* ---- +___ ### $type -• **$type**: \"com.linkedin.voyager.jobs.JobPostingCompany\" +• **$type**: \"com.linkedin.voyager.jobs.JobPostingCompany\" -_Defined in [src/entities/linkedin-job-posting.ts:6](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-job-posting.ts#L6)_ +*Defined in [src/entities/linkedin-job-posting.ts:6](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-job-posting.ts#L6)* ---- +___ -### \*companyResolutionResult +### *companyResolutionResult -• **\*companyResolutionResult**: string +• ***companyResolutionResult**: string -_Defined in [src/entities/linkedin-job-posting.ts:4](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-job-posting.ts#L4)_ +*Defined in [src/entities/linkedin-job-posting.ts:4](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-job-posting.ts#L4)* ---- +___ ### company -• **company**: string +• **company**: string -_Defined in [src/entities/linkedin-job-posting.ts:7](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-job-posting.ts#L7)_ +*Defined in [src/entities/linkedin-job-posting.ts:7](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-job-posting.ts#L7)* diff --git a/docs/interfaces/_src_entities_linkedin_job_search_hit_entity_.linkedinjobsearchhit.md b/docs/interfaces/_src_entities_linkedin_job_search_hit_entity_.linkedinjobsearchhit.md index b038a08e..cab7f501 100644 --- a/docs/interfaces/_src_entities_linkedin_job_search_hit_entity_.linkedinjobsearchhit.md +++ b/docs/interfaces/_src_entities_linkedin_job_search_hit_entity_.linkedinjobsearchhit.md @@ -6,54 +6,54 @@ ## Hierarchy -- **LinkedInJobSearchHit** +* **LinkedInJobSearchHit** ## Index ### Properties -- [$recipeTypes](_src_entities_linkedin_job_search_hit_entity_.linkedinjobsearchhit.md#$recipetypes) -- [$type](_src_entities_linkedin_job_search_hit_entity_.linkedinjobsearchhit.md#$type) -- [\*jobPostingResolutionResult](_src_entities_linkedin_job_search_hit_entity_.linkedinjobsearchhit.md#*jobpostingresolutionresult) -- [jobPosting](_src_entities_linkedin_job_search_hit_entity_.linkedinjobsearchhit.md#jobposting) -- [sponsored](_src_entities_linkedin_job_search_hit_entity_.linkedinjobsearchhit.md#sponsored) +* [$recipeTypes](_src_entities_linkedin_job_search_hit_entity_.linkedinjobsearchhit.md#$recipetypes) +* [$type](_src_entities_linkedin_job_search_hit_entity_.linkedinjobsearchhit.md#$type) +* [*jobPostingResolutionResult](_src_entities_linkedin_job_search_hit_entity_.linkedinjobsearchhit.md#*jobpostingresolutionresult) +* [jobPosting](_src_entities_linkedin_job_search_hit_entity_.linkedinjobsearchhit.md#jobposting) +* [sponsored](_src_entities_linkedin_job_search_hit_entity_.linkedinjobsearchhit.md#sponsored) ## Properties ### $recipeTypes -• **$recipeTypes**: string[] +• **$recipeTypes**: string[] -_Defined in [src/entities/linkedin-job-search-hit-entity.ts:3](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-job-search-hit-entity.ts#L3)_ +*Defined in [src/entities/linkedin-job-search-hit-entity.ts:3](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-job-search-hit-entity.ts#L3)* ---- +___ ### $type -• **$type**: \"com.linkedin.voyager.search.SearchJobJserp\" +• **$type**: \"com.linkedin.voyager.search.SearchJobJserp\" -_Defined in [src/entities/linkedin-job-search-hit-entity.ts:4](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-job-search-hit-entity.ts#L4)_ +*Defined in [src/entities/linkedin-job-search-hit-entity.ts:4](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-job-search-hit-entity.ts#L4)* ---- +___ -### \*jobPostingResolutionResult +### *jobPostingResolutionResult -• **\*jobPostingResolutionResult**: string +• ***jobPostingResolutionResult**: string -_Defined in [src/entities/linkedin-job-search-hit-entity.ts:2](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-job-search-hit-entity.ts#L2)_ +*Defined in [src/entities/linkedin-job-search-hit-entity.ts:2](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-job-search-hit-entity.ts#L2)* ---- +___ ### jobPosting -• **jobPosting**: string +• **jobPosting**: string -_Defined in [src/entities/linkedin-job-search-hit-entity.ts:5](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-job-search-hit-entity.ts#L5)_ +*Defined in [src/entities/linkedin-job-search-hit-entity.ts:5](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-job-search-hit-entity.ts#L5)* ---- +___ ### sponsored -• **sponsored**: boolean +• **sponsored**: boolean -_Defined in [src/entities/linkedin-job-search-hit-entity.ts:6](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-job-search-hit-entity.ts#L6)_ +*Defined in [src/entities/linkedin-job-search-hit-entity.ts:6](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-job-search-hit-entity.ts#L6)* diff --git a/docs/interfaces/_src_entities_linkedin_message_entity_.linkedinmessage.md b/docs/interfaces/_src_entities_linkedin_message_entity_.linkedinmessage.md index 16b85b8f..f067a7ab 100644 --- a/docs/interfaces/_src_entities_linkedin_message_entity_.linkedinmessage.md +++ b/docs/interfaces/_src_entities_linkedin_message_entity_.linkedinmessage.md @@ -6,45 +6,45 @@ ## Hierarchy -- **LinkedInMessage** +* **LinkedInMessage** ## Index ### Properties -- [$type](_src_entities_linkedin_message_entity_.linkedinmessage.md#$type) -- [attributedBody](_src_entities_linkedin_message_entity_.linkedinmessage.md#attributedbody) -- [body](_src_entities_linkedin_message_entity_.linkedinmessage.md#body) -- [messageBodyRenderFormat](_src_entities_linkedin_message_entity_.linkedinmessage.md#messagebodyrenderformat) +* [$type](_src_entities_linkedin_message_entity_.linkedinmessage.md#$type) +* [attributedBody](_src_entities_linkedin_message_entity_.linkedinmessage.md#attributedbody) +* [body](_src_entities_linkedin_message_entity_.linkedinmessage.md#body) +* [messageBodyRenderFormat](_src_entities_linkedin_message_entity_.linkedinmessage.md#messagebodyrenderformat) ## Properties ### $type -• **$type**: \"com.linkedin.voyager.messaging.event.MessageEvent\" +• **$type**: \"com.linkedin.voyager.messaging.event.MessageEvent\" -_Defined in [src/entities/linkedin-message.entity.ts:4](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-message.entity.ts#L4)_ +*Defined in [src/entities/linkedin-message.entity.ts:4](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-message.entity.ts#L4)* ---- +___ ### attributedBody -• **attributedBody**: [AttributeText](_src_entities_linkedin_attribute_text_entity_.attributetext.md) +• **attributedBody**: [AttributeText](_src_entities_linkedin_attribute_text_entity_.attributetext.md) -_Defined in [src/entities/linkedin-message.entity.ts:5](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-message.entity.ts#L5)_ +*Defined in [src/entities/linkedin-message.entity.ts:5](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-message.entity.ts#L5)* ---- +___ ### body -• **body**: string +• **body**: string -_Defined in [src/entities/linkedin-message.entity.ts:6](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-message.entity.ts#L6)_ +*Defined in [src/entities/linkedin-message.entity.ts:6](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-message.entity.ts#L6)* ---- +___ ### messageBodyRenderFormat -• **messageBodyRenderFormat**: string +• **messageBodyRenderFormat**: string -_Defined in [src/entities/linkedin-message.entity.ts:7](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-message.entity.ts#L7)_ +*Defined in [src/entities/linkedin-message.entity.ts:7](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-message.entity.ts#L7)* diff --git a/docs/interfaces/_src_entities_linkedin_message_event_entity_.linkedinmessageevent.md b/docs/interfaces/_src_entities_linkedin_message_event_entity_.linkedinmessageevent.md index 2de7e9b6..7f49d025 100644 --- a/docs/interfaces/_src_entities_linkedin_message_event_entity_.linkedinmessageevent.md +++ b/docs/interfaces/_src_entities_linkedin_message_event_entity_.linkedinmessageevent.md @@ -6,7 +6,7 @@ ## Hierarchy -- [LinkedInEvent](_src_entities_linkedin_event_entity_.linkedinevent.md) +* [LinkedInEvent](_src_entities_linkedin_event_entity_.linkedinevent.md) ↳ **LinkedInMessageEvent** @@ -16,122 +16,122 @@ ### Properties -- [$type](_src_entities_linkedin_message_event_entity_.linkedinmessageevent.md#$type) -- [\*from](_src_entities_linkedin_message_event_entity_.linkedinmessageevent.md#*from) -- [backendUrn](_src_entities_linkedin_message_event_entity_.linkedinmessageevent.md#backendurn) -- [createdAt](_src_entities_linkedin_message_event_entity_.linkedinmessageevent.md#createdat) -- [dashEntityUrn](_src_entities_linkedin_message_event_entity_.linkedinmessageevent.md#dashentityurn) -- [entityUrn](_src_entities_linkedin_message_event_entity_.linkedinmessageevent.md#entityurn) -- [eventContent](_src_entities_linkedin_message_event_entity_.linkedinmessageevent.md#eventcontent) -- [originToken](_src_entities_linkedin_message_event_entity_.linkedinmessageevent.md#origintoken) -- [previousEventInConversation](_src_entities_linkedin_message_event_entity_.linkedinmessageevent.md#previouseventinconversation) -- [quickReplyRecommendations](_src_entities_linkedin_message_event_entity_.linkedinmessageevent.md#quickreplyrecommendations) -- [subtype](_src_entities_linkedin_message_event_entity_.linkedinmessageevent.md#subtype) +* [$type](_src_entities_linkedin_message_event_entity_.linkedinmessageevent.md#$type) +* [*from](_src_entities_linkedin_message_event_entity_.linkedinmessageevent.md#*from) +* [backendUrn](_src_entities_linkedin_message_event_entity_.linkedinmessageevent.md#backendurn) +* [createdAt](_src_entities_linkedin_message_event_entity_.linkedinmessageevent.md#createdat) +* [dashEntityUrn](_src_entities_linkedin_message_event_entity_.linkedinmessageevent.md#dashentityurn) +* [entityUrn](_src_entities_linkedin_message_event_entity_.linkedinmessageevent.md#entityurn) +* [eventContent](_src_entities_linkedin_message_event_entity_.linkedinmessageevent.md#eventcontent) +* [originToken](_src_entities_linkedin_message_event_entity_.linkedinmessageevent.md#origintoken) +* [previousEventInConversation](_src_entities_linkedin_message_event_entity_.linkedinmessageevent.md#previouseventinconversation) +* [quickReplyRecommendations](_src_entities_linkedin_message_event_entity_.linkedinmessageevent.md#quickreplyrecommendations) +* [subtype](_src_entities_linkedin_message_event_entity_.linkedinmessageevent.md#subtype) ## Properties ### $type -• **$type**: _typeof_ [EVENT_TYPE](../modules/_src_entities_linkedin_event_entity_.md#event_type) +• **$type**: *typeof* [EVENT\_TYPE](../modules/_src_entities_linkedin_event_entity_.md#event_type) -_Inherited from [LinkedInEvent](_src_entities_linkedin_event_entity_.linkedinevent.md).[$type](_src_entities_linkedin_event_entity_.linkedinevent.md#$type)_ +*Inherited from [LinkedInEvent](_src_entities_linkedin_event_entity_.linkedinevent.md).[$type](_src_entities_linkedin_event_entity_.linkedinevent.md#$type)* -_Defined in [src/entities/linkedin-event.entity.ts:6](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-event.entity.ts#L6)_ +*Defined in [src/entities/linkedin-event.entity.ts:6](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-event.entity.ts#L6)* ---- +___ -### \*from +### *from -• **\*from**: string +• ***from**: string -*Inherited from [LinkedInEvent](_src_entities_linkedin_event_entity_.linkedinevent.md).[*from](_src_entities_linkedin_event_entity_.linkedinevent.md#_from)_ +*Inherited from [LinkedInEvent](_src_entities_linkedin_event_entity_.linkedinevent.md).[*from](_src_entities_linkedin_event_entity_.linkedinevent.md#*from)* -_Defined in [src/entities/linkedin-event.entity.ts:7](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-event.entity.ts#L7)_ +*Defined in [src/entities/linkedin-event.entity.ts:7](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-event.entity.ts#L7)* ---- +___ ### backendUrn -• **backendUrn**: string +• **backendUrn**: string -_Inherited from [LinkedInEvent](_src_entities_linkedin_event_entity_.linkedinevent.md).[backendUrn](_src_entities_linkedin_event_entity_.linkedinevent.md#backendurn)_ +*Inherited from [LinkedInEvent](_src_entities_linkedin_event_entity_.linkedinevent.md).[backendUrn](_src_entities_linkedin_event_entity_.linkedinevent.md#backendurn)* -_Defined in [src/entities/linkedin-event.entity.ts:8](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-event.entity.ts#L8)_ +*Defined in [src/entities/linkedin-event.entity.ts:8](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-event.entity.ts#L8)* ---- +___ ### createdAt -• **createdAt**: number +• **createdAt**: number -_Inherited from [LinkedInEvent](_src_entities_linkedin_event_entity_.linkedinevent.md).[createdAt](_src_entities_linkedin_event_entity_.linkedinevent.md#createdat)_ +*Inherited from [LinkedInEvent](_src_entities_linkedin_event_entity_.linkedinevent.md).[createdAt](_src_entities_linkedin_event_entity_.linkedinevent.md#createdat)* -_Defined in [src/entities/linkedin-event.entity.ts:9](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-event.entity.ts#L9)_ +*Defined in [src/entities/linkedin-event.entity.ts:9](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-event.entity.ts#L9)* ---- +___ ### dashEntityUrn -• **dashEntityUrn**: string +• **dashEntityUrn**: string -_Inherited from [LinkedInEvent](_src_entities_linkedin_event_entity_.linkedinevent.md).[dashEntityUrn](_src_entities_linkedin_event_entity_.linkedinevent.md#dashentityurn)_ +*Inherited from [LinkedInEvent](_src_entities_linkedin_event_entity_.linkedinevent.md).[dashEntityUrn](_src_entities_linkedin_event_entity_.linkedinevent.md#dashentityurn)* -_Defined in [src/entities/linkedin-event.entity.ts:10](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-event.entity.ts#L10)_ +*Defined in [src/entities/linkedin-event.entity.ts:10](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-event.entity.ts#L10)* ---- +___ ### entityUrn -• **entityUrn**: [LinkedInEventUrn](../modules/_src_entities_linkedin_event_entity_.md#linkedineventurn) +• **entityUrn**: [LinkedInEventUrn](../modules/_src_entities_linkedin_event_entity_.md#linkedineventurn) -_Inherited from [LinkedInEvent](_src_entities_linkedin_event_entity_.linkedinevent.md).[entityUrn](_src_entities_linkedin_event_entity_.linkedinevent.md#entityurn)_ +*Inherited from [LinkedInEvent](_src_entities_linkedin_event_entity_.linkedinevent.md).[entityUrn](_src_entities_linkedin_event_entity_.linkedinevent.md#entityurn)* -_Defined in [src/entities/linkedin-event.entity.ts:11](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-event.entity.ts#L11)_ +*Defined in [src/entities/linkedin-event.entity.ts:11](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-event.entity.ts#L11)* ---- +___ ### eventContent -• **eventContent**: [LinkedInMessage](_src_entities_linkedin_message_entity_.linkedinmessage.md) +• **eventContent**: [LinkedInMessage](_src_entities_linkedin_message_entity_.linkedinmessage.md) -_Overrides [LinkedInEvent](_src_entities_linkedin_event_entity_.linkedinevent.md).[eventContent](_src_entities_linkedin_event_entity_.linkedinevent.md#eventcontent)_ +*Overrides [LinkedInEvent](_src_entities_linkedin_event_entity_.linkedinevent.md).[eventContent](_src_entities_linkedin_event_entity_.linkedinevent.md#eventcontent)* -_Defined in [src/entities/linkedin-message-event.entity.ts:6](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-message-event.entity.ts#L6)_ +*Defined in [src/entities/linkedin-message-event.entity.ts:6](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-message-event.entity.ts#L6)* ---- +___ ### originToken -• **originToken**: string +• **originToken**: string -_Inherited from [LinkedInEvent](_src_entities_linkedin_event_entity_.linkedinevent.md).[originToken](_src_entities_linkedin_event_entity_.linkedinevent.md#origintoken)_ +*Inherited from [LinkedInEvent](_src_entities_linkedin_event_entity_.linkedinevent.md).[originToken](_src_entities_linkedin_event_entity_.linkedinevent.md#origintoken)* -_Defined in [src/entities/linkedin-event.entity.ts:13](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-event.entity.ts#L13)_ +*Defined in [src/entities/linkedin-event.entity.ts:13](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-event.entity.ts#L13)* ---- +___ ### previousEventInConversation • `Optional` **previousEventInConversation**: undefined \| string -_Inherited from [LinkedInEvent](_src_entities_linkedin_event_entity_.linkedinevent.md).[previousEventInConversation](_src_entities_linkedin_event_entity_.linkedinevent.md#previouseventinconversation)_ +*Inherited from [LinkedInEvent](_src_entities_linkedin_event_entity_.linkedinevent.md).[previousEventInConversation](_src_entities_linkedin_event_entity_.linkedinevent.md#previouseventinconversation)* -_Defined in [src/entities/linkedin-event.entity.ts:15](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-event.entity.ts#L15)_ +*Defined in [src/entities/linkedin-event.entity.ts:15](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-event.entity.ts#L15)* ---- +___ ### quickReplyRecommendations -• **quickReplyRecommendations**: [QuickReplayRecommendation](_src_entities_linkedin_quick_replay_recommendation_entity_.quickreplayrecommendation.md)[] +• **quickReplyRecommendations**: [QuickReplayRecommendation](_src_entities_linkedin_quick_replay_recommendation_entity_.quickreplayrecommendation.md)[] -_Defined in [src/entities/linkedin-message-event.entity.ts:7](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-message-event.entity.ts#L7)_ +*Defined in [src/entities/linkedin-message-event.entity.ts:7](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-message-event.entity.ts#L7)* ---- +___ ### subtype -• **subtype**: string +• **subtype**: string -_Inherited from [LinkedInEvent](_src_entities_linkedin_event_entity_.linkedinevent.md).[subtype](_src_entities_linkedin_event_entity_.linkedinevent.md#subtype)_ +*Inherited from [LinkedInEvent](_src_entities_linkedin_event_entity_.linkedinevent.md).[subtype](_src_entities_linkedin_event_entity_.linkedinevent.md#subtype)* -_Defined in [src/entities/linkedin-event.entity.ts:14](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-event.entity.ts#L14)_ +*Defined in [src/entities/linkedin-event.entity.ts:14](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-event.entity.ts#L14)* diff --git a/docs/interfaces/_src_entities_linkedin_mini_company_entity_.linkedinminicompany.md b/docs/interfaces/_src_entities_linkedin_mini_company_entity_.linkedinminicompany.md index f8d35ad0..d7723e36 100644 --- a/docs/interfaces/_src_entities_linkedin_mini_company_entity_.linkedinminicompany.md +++ b/docs/interfaces/_src_entities_linkedin_mini_company_entity_.linkedinminicompany.md @@ -6,7 +6,7 @@ ## Hierarchy -- **LinkedInMiniCompany** +* **LinkedInMiniCompany** ↳ [MiniCompany](_src_entities_mini_company_entity_.minicompany.md) @@ -14,84 +14,84 @@ ### Properties -- [$type](_src_entities_linkedin_mini_company_entity_.linkedinminicompany.md#$type) -- [active](_src_entities_linkedin_mini_company_entity_.linkedinminicompany.md#active) -- [entityUrn](_src_entities_linkedin_mini_company_entity_.linkedinminicompany.md#entityurn) -- [logo](_src_entities_linkedin_mini_company_entity_.linkedinminicompany.md#logo) -- [name](_src_entities_linkedin_mini_company_entity_.linkedinminicompany.md#name) -- [objectUrn](_src_entities_linkedin_mini_company_entity_.linkedinminicompany.md#objecturn) -- [showcase](_src_entities_linkedin_mini_company_entity_.linkedinminicompany.md#showcase) -- [trackingId](_src_entities_linkedin_mini_company_entity_.linkedinminicompany.md#trackingid) -- [universalName](_src_entities_linkedin_mini_company_entity_.linkedinminicompany.md#universalname) +* [$type](_src_entities_linkedin_mini_company_entity_.linkedinminicompany.md#$type) +* [active](_src_entities_linkedin_mini_company_entity_.linkedinminicompany.md#active) +* [entityUrn](_src_entities_linkedin_mini_company_entity_.linkedinminicompany.md#entityurn) +* [logo](_src_entities_linkedin_mini_company_entity_.linkedinminicompany.md#logo) +* [name](_src_entities_linkedin_mini_company_entity_.linkedinminicompany.md#name) +* [objectUrn](_src_entities_linkedin_mini_company_entity_.linkedinminicompany.md#objecturn) +* [showcase](_src_entities_linkedin_mini_company_entity_.linkedinminicompany.md#showcase) +* [trackingId](_src_entities_linkedin_mini_company_entity_.linkedinminicompany.md#trackingid) +* [universalName](_src_entities_linkedin_mini_company_entity_.linkedinminicompany.md#universalname) ## Properties ### $type -• **$type**: _typeof_ [MINI_COMPANY_TYPE](../modules/_src_entities_linkedin_mini_company_entity_.md#mini_company_type) +• **$type**: *typeof* [MINI\_COMPANY\_TYPE](../modules/_src_entities_linkedin_mini_company_entity_.md#mini_company_type) -_Defined in [src/entities/linkedin-mini-company.entity.ts:6](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-mini-company.entity.ts#L6)_ +*Defined in [src/entities/linkedin-mini-company.entity.ts:6](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-mini-company.entity.ts#L6)* ---- +___ ### active -• **active**: boolean +• **active**: boolean -_Defined in [src/entities/linkedin-mini-company.entity.ts:7](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-mini-company.entity.ts#L7)_ +*Defined in [src/entities/linkedin-mini-company.entity.ts:7](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-mini-company.entity.ts#L7)* ---- +___ ### entityUrn -• **entityUrn**: string +• **entityUrn**: string -_Defined in [src/entities/linkedin-mini-company.entity.ts:8](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-mini-company.entity.ts#L8)_ +*Defined in [src/entities/linkedin-mini-company.entity.ts:8](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-mini-company.entity.ts#L8)* ---- +___ ### logo -• **logo**: [LinkedInVectorImage](_src_entities_linkedin_vector_image_entity_.linkedinvectorimage.md) +• **logo**: [LinkedInVectorImage](_src_entities_linkedin_vector_image_entity_.linkedinvectorimage.md) -_Defined in [src/entities/linkedin-mini-company.entity.ts:9](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-mini-company.entity.ts#L9)_ +*Defined in [src/entities/linkedin-mini-company.entity.ts:9](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-mini-company.entity.ts#L9)* ---- +___ ### name -• **name**: string +• **name**: string -_Defined in [src/entities/linkedin-mini-company.entity.ts:10](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-mini-company.entity.ts#L10)_ +*Defined in [src/entities/linkedin-mini-company.entity.ts:10](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-mini-company.entity.ts#L10)* ---- +___ ### objectUrn -• **objectUrn**: string +• **objectUrn**: string -_Defined in [src/entities/linkedin-mini-company.entity.ts:11](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-mini-company.entity.ts#L11)_ +*Defined in [src/entities/linkedin-mini-company.entity.ts:11](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-mini-company.entity.ts#L11)* ---- +___ ### showcase -• **showcase**: boolean +• **showcase**: boolean -_Defined in [src/entities/linkedin-mini-company.entity.ts:12](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-mini-company.entity.ts#L12)_ +*Defined in [src/entities/linkedin-mini-company.entity.ts:12](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-mini-company.entity.ts#L12)* ---- +___ ### trackingId -• **trackingId**: string +• **trackingId**: string -_Defined in [src/entities/linkedin-mini-company.entity.ts:13](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-mini-company.entity.ts#L13)_ +*Defined in [src/entities/linkedin-mini-company.entity.ts:13](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-mini-company.entity.ts#L13)* ---- +___ ### universalName -• **universalName**: string +• **universalName**: string -_Defined in [src/entities/linkedin-mini-company.entity.ts:14](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-mini-company.entity.ts#L14)_ +*Defined in [src/entities/linkedin-mini-company.entity.ts:14](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-mini-company.entity.ts#L14)* diff --git a/docs/interfaces/_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md b/docs/interfaces/_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md index aa2adf6f..4ddabc94 100644 --- a/docs/interfaces/_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md +++ b/docs/interfaces/_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md @@ -6,7 +6,7 @@ ## Hierarchy -- **LinkedInMiniProfile** +* **LinkedInMiniProfile** ↳ [MiniProfile](_src_entities_mini_profile_entity_.miniprofile.md) @@ -14,102 +14,102 @@ ### Properties -- [$type](_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md#$type) -- [backgroundImage](_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md#backgroundimage) -- [entityUrn](_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md#entityurn) -- [firstName](_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md#firstname) -- [lastName](_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md#lastname) -- [memorailzed](_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md#memorailzed) -- [objectUrn](_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md#objecturn) -- [occupation](_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md#occupation) -- [picture](_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md#picture) -- [publicIdentifier](_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md#publicidentifier) -- [trackingId](_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md#trackingid) +* [$type](_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md#$type) +* [backgroundImage](_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md#backgroundimage) +* [entityUrn](_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md#entityurn) +* [firstName](_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md#firstname) +* [lastName](_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md#lastname) +* [memorailzed](_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md#memorailzed) +* [objectUrn](_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md#objecturn) +* [occupation](_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md#occupation) +* [picture](_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md#picture) +* [publicIdentifier](_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md#publicidentifier) +* [trackingId](_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md#trackingid) ## Properties ### $type -• **$type**: _typeof_ [MINI_PROFILE_TYPE](../modules/_src_entities_linkedin_mini_profile_entity_.md#mini_profile_type) +• **$type**: *typeof* [MINI\_PROFILE\_TYPE](../modules/_src_entities_linkedin_mini_profile_entity_.md#mini_profile_type) -_Defined in [src/entities/linkedin-mini-profile.entity.ts:8](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-mini-profile.entity.ts#L8)_ +*Defined in [src/entities/linkedin-mini-profile.entity.ts:8](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-mini-profile.entity.ts#L8)* ---- +___ ### backgroundImage -• **backgroundImage**: [LinkedInVectorImage](_src_entities_linkedin_vector_image_entity_.linkedinvectorimage.md) +• **backgroundImage**: [LinkedInVectorImage](_src_entities_linkedin_vector_image_entity_.linkedinvectorimage.md) -_Defined in [src/entities/linkedin-mini-profile.entity.ts:9](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-mini-profile.entity.ts#L9)_ +*Defined in [src/entities/linkedin-mini-profile.entity.ts:9](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-mini-profile.entity.ts#L9)* ---- +___ ### entityUrn -• **entityUrn**: [MiniProfileUrn](../modules/_src_entities_linkedin_mini_profile_entity_.md#miniprofileurn) +• **entityUrn**: [MiniProfileUrn](../modules/_src_entities_linkedin_mini_profile_entity_.md#miniprofileurn) -_Defined in [src/entities/linkedin-mini-profile.entity.ts:10](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-mini-profile.entity.ts#L10)_ +*Defined in [src/entities/linkedin-mini-profile.entity.ts:10](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-mini-profile.entity.ts#L10)* ---- +___ ### firstName -• **firstName**: string +• **firstName**: string -_Defined in [src/entities/linkedin-mini-profile.entity.ts:11](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-mini-profile.entity.ts#L11)_ +*Defined in [src/entities/linkedin-mini-profile.entity.ts:11](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-mini-profile.entity.ts#L11)* ---- +___ ### lastName -• **lastName**: string +• **lastName**: string -_Defined in [src/entities/linkedin-mini-profile.entity.ts:12](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-mini-profile.entity.ts#L12)_ +*Defined in [src/entities/linkedin-mini-profile.entity.ts:12](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-mini-profile.entity.ts#L12)* ---- +___ ### memorailzed • `Optional` **memorailzed**: undefined \| false \| true -_Defined in [src/entities/linkedin-mini-profile.entity.ts:13](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-mini-profile.entity.ts#L13)_ +*Defined in [src/entities/linkedin-mini-profile.entity.ts:13](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-mini-profile.entity.ts#L13)* ---- +___ ### objectUrn -• **objectUrn**: string +• **objectUrn**: string -_Defined in [src/entities/linkedin-mini-profile.entity.ts:14](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-mini-profile.entity.ts#L14)_ +*Defined in [src/entities/linkedin-mini-profile.entity.ts:14](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-mini-profile.entity.ts#L14)* ---- +___ ### occupation -• **occupation**: string +• **occupation**: string -_Defined in [src/entities/linkedin-mini-profile.entity.ts:15](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-mini-profile.entity.ts#L15)_ +*Defined in [src/entities/linkedin-mini-profile.entity.ts:15](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-mini-profile.entity.ts#L15)* ---- +___ ### picture • `Optional` **picture**: [LinkedInVectorImage](_src_entities_linkedin_vector_image_entity_.linkedinvectorimage.md) -_Defined in [src/entities/linkedin-mini-profile.entity.ts:16](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-mini-profile.entity.ts#L16)_ +*Defined in [src/entities/linkedin-mini-profile.entity.ts:16](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-mini-profile.entity.ts#L16)* ---- +___ ### publicIdentifier -• **publicIdentifier**: string +• **publicIdentifier**: string -_Defined in [src/entities/linkedin-mini-profile.entity.ts:17](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-mini-profile.entity.ts#L17)_ +*Defined in [src/entities/linkedin-mini-profile.entity.ts:17](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-mini-profile.entity.ts#L17)* ---- +___ ### trackingId -• **trackingId**: string +• **trackingId**: string -_Defined in [src/entities/linkedin-mini-profile.entity.ts:18](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-mini-profile.entity.ts#L18)_ +*Defined in [src/entities/linkedin-mini-profile.entity.ts:18](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-mini-profile.entity.ts#L18)* diff --git a/docs/interfaces/_src_entities_linkedin_profile_entity_.linkedinphotofilterpicture.md b/docs/interfaces/_src_entities_linkedin_profile_entity_.linkedinphotofilterpicture.md index 427a7504..17a497c8 100644 --- a/docs/interfaces/_src_entities_linkedin_profile_entity_.linkedinphotofilterpicture.md +++ b/docs/interfaces/_src_entities_linkedin_profile_entity_.linkedinphotofilterpicture.md @@ -6,60 +6,60 @@ ## Hierarchy -- **LinkedInPhotoFilterPicture** +* **LinkedInPhotoFilterPicture** ## Index ### Properties -- [$recipeTypes](_src_entities_linkedin_profile_entity_.linkedinphotofilterpicture.md#$recipetypes) -- [$type](_src_entities_linkedin_profile_entity_.linkedinphotofilterpicture.md#$type) -- [displayImageReference](_src_entities_linkedin_profile_entity_.linkedinphotofilterpicture.md#displayimagereference) -- [displayImageUrn](_src_entities_linkedin_profile_entity_.linkedinphotofilterpicture.md#displayimageurn) -- [photoFilterEditInfo](_src_entities_linkedin_profile_entity_.linkedinphotofilterpicture.md#photofiltereditinfo) +* [$recipeTypes](_src_entities_linkedin_profile_entity_.linkedinphotofilterpicture.md#$recipetypes) +* [$type](_src_entities_linkedin_profile_entity_.linkedinphotofilterpicture.md#$type) +* [displayImageReference](_src_entities_linkedin_profile_entity_.linkedinphotofilterpicture.md#displayimagereference) +* [displayImageUrn](_src_entities_linkedin_profile_entity_.linkedinphotofilterpicture.md#displayimageurn) +* [photoFilterEditInfo](_src_entities_linkedin_profile_entity_.linkedinphotofilterpicture.md#photofiltereditinfo) ## Properties ### $recipeTypes -• **$recipeTypes**: string[] +• **$recipeTypes**: string[] -_Defined in [src/entities/linkedin-profile.entity.ts:30](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L30)_ +*Defined in [src/entities/linkedin-profile.entity.ts:30](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L30)* ---- +___ ### $type -• **$type**: \"com.linkedin.voyager.dash.identity.profile.PhotoFilterPicture\" +• **$type**: \"com.linkedin.voyager.dash.identity.profile.PhotoFilterPicture\" -_Defined in [src/entities/linkedin-profile.entity.ts:29](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L29)_ +*Defined in [src/entities/linkedin-profile.entity.ts:29](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L29)* ---- +___ ### displayImageReference -• **displayImageReference**: { vectorImage: [LinkedInVectorImage](_src_entities_linkedin_vector_image_entity_.linkedinvectorimage.md) } +• **displayImageReference**: { vectorImage: [LinkedInVectorImage](_src_entities_linkedin_vector_image_entity_.linkedinvectorimage.md) } -_Defined in [src/entities/linkedin-profile.entity.ts:31](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L31)_ +*Defined in [src/entities/linkedin-profile.entity.ts:31](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L31)* #### Type declaration: -| Name | Type | -| ------------- | ----------------------------------------------------------------------------------------- | -| `vectorImage` | [LinkedInVectorImage](_src_entities_linkedin_vector_image_entity_.linkedinvectorimage.md) | +Name | Type | +------ | ------ | +`vectorImage` | [LinkedInVectorImage](_src_entities_linkedin_vector_image_entity_.linkedinvectorimage.md) | ---- +___ ### displayImageUrn -• **displayImageUrn**: string +• **displayImageUrn**: string -_Defined in [src/entities/linkedin-profile.entity.ts:34](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L34)_ +*Defined in [src/entities/linkedin-profile.entity.ts:34](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L34)* ---- +___ ### photoFilterEditInfo -• **photoFilterEditInfo**: unknown +• **photoFilterEditInfo**: unknown -_Defined in [src/entities/linkedin-profile.entity.ts:35](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L35)_ +*Defined in [src/entities/linkedin-profile.entity.ts:35](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L35)* diff --git a/docs/interfaces/_src_entities_linkedin_profile_entity_.linkedinprofile.md b/docs/interfaces/_src_entities_linkedin_profile_entity_.linkedinprofile.md index eb958f21..3f9ceec6 100644 --- a/docs/interfaces/_src_entities_linkedin_profile_entity_.linkedinprofile.md +++ b/docs/interfaces/_src_entities_linkedin_profile_entity_.linkedinprofile.md @@ -6,7 +6,7 @@ ## Hierarchy -- **LinkedInProfile** +* **LinkedInProfile** ↳ [Profile](_src_entities_profile_entity_.profile.md) @@ -14,345 +14,345 @@ ### Properties -- [$recipeTypes](_src_entities_linkedin_profile_entity_.linkedinprofile.md#$recipetypes) -- [$type](_src_entities_linkedin_profile_entity_.linkedinprofile.md#$type) -- [\*industry](_src_entities_linkedin_profile_entity_.linkedinprofile.md#*industry) -- [\*profileCertifications](_src_entities_linkedin_profile_entity_.linkedinprofile.md#*profilecertifications) -- [\*profileCourses](_src_entities_linkedin_profile_entity_.linkedinprofile.md#*profilecourses) -- [\*profileEducations](_src_entities_linkedin_profile_entity_.linkedinprofile.md#*profileeducations) -- [\*profileHonors](_src_entities_linkedin_profile_entity_.linkedinprofile.md#*profilehonors) -- [\*profileLanguages](_src_entities_linkedin_profile_entity_.linkedinprofile.md#*profilelanguages) -- [\*profileOrganizations](_src_entities_linkedin_profile_entity_.linkedinprofile.md#*profileorganizations) -- [\*profilePatents](_src_entities_linkedin_profile_entity_.linkedinprofile.md#*profilepatents) -- [\*profilePositionGroups](_src_entities_linkedin_profile_entity_.linkedinprofile.md#*profilepositiongroups) -- [\*profileProjects](_src_entities_linkedin_profile_entity_.linkedinprofile.md#*profileprojects) -- [\*profilePublications](_src_entities_linkedin_profile_entity_.linkedinprofile.md#*profilepublications) -- [\*profileSkills](_src_entities_linkedin_profile_entity_.linkedinprofile.md#*profileskills) -- [\*profileTestScores](_src_entities_linkedin_profile_entity_.linkedinprofile.md#*profiletestscores) -- [\*profileTreasuryMediaProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md#*profiletreasurymediaprofile) -- [\*profileVolunteerExperiences](_src_entities_linkedin_profile_entity_.linkedinprofile.md#*profilevolunteerexperiences) -- [defaultToActivityTab](_src_entities_linkedin_profile_entity_.linkedinprofile.md#defaulttoactivitytab) -- [educationOnProfileTopCardShown](_src_entities_linkedin_profile_entity_.linkedinprofile.md#educationonprofiletopcardshown) -- [entityUrn](_src_entities_linkedin_profile_entity_.linkedinprofile.md#entityurn) -- [firstName](_src_entities_linkedin_profile_entity_.linkedinprofile.md#firstname) -- [geoLocation](_src_entities_linkedin_profile_entity_.linkedinprofile.md#geolocation) -- [geoLocationBackfilled](_src_entities_linkedin_profile_entity_.linkedinprofile.md#geolocationbackfilled) -- [headline](_src_entities_linkedin_profile_entity_.linkedinprofile.md#headline) -- [industryUrn](_src_entities_linkedin_profile_entity_.linkedinprofile.md#industryurn) -- [lastName](_src_entities_linkedin_profile_entity_.linkedinprofile.md#lastname) -- [location](_src_entities_linkedin_profile_entity_.linkedinprofile.md#location) -- [locationName](_src_entities_linkedin_profile_entity_.linkedinprofile.md#locationname) -- [multiLocaleFirstName](_src_entities_linkedin_profile_entity_.linkedinprofile.md#multilocalefirstname) -- [multiLocaleHeadline](_src_entities_linkedin_profile_entity_.linkedinprofile.md#multilocaleheadline) -- [multiLocaleLastName](_src_entities_linkedin_profile_entity_.linkedinprofile.md#multilocalelastname) -- [objectUrn](_src_entities_linkedin_profile_entity_.linkedinprofile.md#objecturn) -- [primaryLocale](_src_entities_linkedin_profile_entity_.linkedinprofile.md#primarylocale) -- [profilePicture](_src_entities_linkedin_profile_entity_.linkedinprofile.md#profilepicture) -- [publicIdentifier](_src_entities_linkedin_profile_entity_.linkedinprofile.md#publicidentifier) -- [supportedLocales](_src_entities_linkedin_profile_entity_.linkedinprofile.md#supportedlocales) -- [trackingId](_src_entities_linkedin_profile_entity_.linkedinprofile.md#trackingid) -- [versionTag](_src_entities_linkedin_profile_entity_.linkedinprofile.md#versiontag) +* [$recipeTypes](_src_entities_linkedin_profile_entity_.linkedinprofile.md#$recipetypes) +* [$type](_src_entities_linkedin_profile_entity_.linkedinprofile.md#$type) +* [*industry](_src_entities_linkedin_profile_entity_.linkedinprofile.md#*industry) +* [*profileCertifications](_src_entities_linkedin_profile_entity_.linkedinprofile.md#*profilecertifications) +* [*profileCourses](_src_entities_linkedin_profile_entity_.linkedinprofile.md#*profilecourses) +* [*profileEducations](_src_entities_linkedin_profile_entity_.linkedinprofile.md#*profileeducations) +* [*profileHonors](_src_entities_linkedin_profile_entity_.linkedinprofile.md#*profilehonors) +* [*profileLanguages](_src_entities_linkedin_profile_entity_.linkedinprofile.md#*profilelanguages) +* [*profileOrganizations](_src_entities_linkedin_profile_entity_.linkedinprofile.md#*profileorganizations) +* [*profilePatents](_src_entities_linkedin_profile_entity_.linkedinprofile.md#*profilepatents) +* [*profilePositionGroups](_src_entities_linkedin_profile_entity_.linkedinprofile.md#*profilepositiongroups) +* [*profileProjects](_src_entities_linkedin_profile_entity_.linkedinprofile.md#*profileprojects) +* [*profilePublications](_src_entities_linkedin_profile_entity_.linkedinprofile.md#*profilepublications) +* [*profileSkills](_src_entities_linkedin_profile_entity_.linkedinprofile.md#*profileskills) +* [*profileTestScores](_src_entities_linkedin_profile_entity_.linkedinprofile.md#*profiletestscores) +* [*profileTreasuryMediaProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md#*profiletreasurymediaprofile) +* [*profileVolunteerExperiences](_src_entities_linkedin_profile_entity_.linkedinprofile.md#*profilevolunteerexperiences) +* [defaultToActivityTab](_src_entities_linkedin_profile_entity_.linkedinprofile.md#defaulttoactivitytab) +* [educationOnProfileTopCardShown](_src_entities_linkedin_profile_entity_.linkedinprofile.md#educationonprofiletopcardshown) +* [entityUrn](_src_entities_linkedin_profile_entity_.linkedinprofile.md#entityurn) +* [firstName](_src_entities_linkedin_profile_entity_.linkedinprofile.md#firstname) +* [geoLocation](_src_entities_linkedin_profile_entity_.linkedinprofile.md#geolocation) +* [geoLocationBackfilled](_src_entities_linkedin_profile_entity_.linkedinprofile.md#geolocationbackfilled) +* [headline](_src_entities_linkedin_profile_entity_.linkedinprofile.md#headline) +* [industryUrn](_src_entities_linkedin_profile_entity_.linkedinprofile.md#industryurn) +* [lastName](_src_entities_linkedin_profile_entity_.linkedinprofile.md#lastname) +* [location](_src_entities_linkedin_profile_entity_.linkedinprofile.md#location) +* [locationName](_src_entities_linkedin_profile_entity_.linkedinprofile.md#locationname) +* [multiLocaleFirstName](_src_entities_linkedin_profile_entity_.linkedinprofile.md#multilocalefirstname) +* [multiLocaleHeadline](_src_entities_linkedin_profile_entity_.linkedinprofile.md#multilocaleheadline) +* [multiLocaleLastName](_src_entities_linkedin_profile_entity_.linkedinprofile.md#multilocalelastname) +* [objectUrn](_src_entities_linkedin_profile_entity_.linkedinprofile.md#objecturn) +* [primaryLocale](_src_entities_linkedin_profile_entity_.linkedinprofile.md#primarylocale) +* [profilePicture](_src_entities_linkedin_profile_entity_.linkedinprofile.md#profilepicture) +* [publicIdentifier](_src_entities_linkedin_profile_entity_.linkedinprofile.md#publicidentifier) +* [supportedLocales](_src_entities_linkedin_profile_entity_.linkedinprofile.md#supportedlocales) +* [trackingId](_src_entities_linkedin_profile_entity_.linkedinprofile.md#trackingid) +* [versionTag](_src_entities_linkedin_profile_entity_.linkedinprofile.md#versiontag) ## Properties ### $recipeTypes -• **$recipeTypes**: string[] +• **$recipeTypes**: string[] -_Defined in [src/entities/linkedin-profile.entity.ts:57](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L57)_ +*Defined in [src/entities/linkedin-profile.entity.ts:57](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L57)* ---- +___ ### $type -• **$type**: _typeof_ [PROFILE_TYPE](../modules/_src_entities_linkedin_profile_entity_.md#profile_type) +• **$type**: *typeof* [PROFILE\_TYPE](../modules/_src_entities_linkedin_profile_entity_.md#profile_type) -_Defined in [src/entities/linkedin-profile.entity.ts:41](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L41)_ +*Defined in [src/entities/linkedin-profile.entity.ts:41](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L41)* ---- +___ -### \*industry +### *industry -• **\*industry**: string +• ***industry**: string -_Defined in [src/entities/linkedin-profile.entity.ts:42](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L42)_ +*Defined in [src/entities/linkedin-profile.entity.ts:42](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L42)* ---- +___ -### \*profileCertifications +### *profileCertifications -• **\*profileCertifications**: string +• ***profileCertifications**: string -_Defined in [src/entities/linkedin-profile.entity.ts:43](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L43)_ +*Defined in [src/entities/linkedin-profile.entity.ts:43](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L43)* ---- +___ -### \*profileCourses +### *profileCourses -• **\*profileCourses**: string +• ***profileCourses**: string -_Defined in [src/entities/linkedin-profile.entity.ts:44](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L44)_ +*Defined in [src/entities/linkedin-profile.entity.ts:44](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L44)* ---- +___ -### \*profileEducations +### *profileEducations -• **\*profileEducations**: string +• ***profileEducations**: string -_Defined in [src/entities/linkedin-profile.entity.ts:45](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L45)_ +*Defined in [src/entities/linkedin-profile.entity.ts:45](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L45)* ---- +___ -### \*profileHonors +### *profileHonors -• **\*profileHonors**: string +• ***profileHonors**: string -_Defined in [src/entities/linkedin-profile.entity.ts:46](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L46)_ +*Defined in [src/entities/linkedin-profile.entity.ts:46](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L46)* ---- +___ -### \*profileLanguages +### *profileLanguages -• **\*profileLanguages**: string +• ***profileLanguages**: string -_Defined in [src/entities/linkedin-profile.entity.ts:47](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L47)_ +*Defined in [src/entities/linkedin-profile.entity.ts:47](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L47)* ---- +___ -### \*profileOrganizations +### *profileOrganizations -• **\*profileOrganizations**: string +• ***profileOrganizations**: string -_Defined in [src/entities/linkedin-profile.entity.ts:48](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L48)_ +*Defined in [src/entities/linkedin-profile.entity.ts:48](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L48)* ---- +___ -### \*profilePatents +### *profilePatents -• **\*profilePatents**: string +• ***profilePatents**: string -_Defined in [src/entities/linkedin-profile.entity.ts:49](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L49)_ +*Defined in [src/entities/linkedin-profile.entity.ts:49](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L49)* ---- +___ -### \*profilePositionGroups +### *profilePositionGroups -• **\*profilePositionGroups**: string +• ***profilePositionGroups**: string -_Defined in [src/entities/linkedin-profile.entity.ts:50](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L50)_ +*Defined in [src/entities/linkedin-profile.entity.ts:50](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L50)* ---- +___ -### \*profileProjects +### *profileProjects -• **\*profileProjects**: string +• ***profileProjects**: string -_Defined in [src/entities/linkedin-profile.entity.ts:51](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L51)_ +*Defined in [src/entities/linkedin-profile.entity.ts:51](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L51)* ---- +___ -### \*profilePublications +### *profilePublications -• **\*profilePublications**: string +• ***profilePublications**: string -_Defined in [src/entities/linkedin-profile.entity.ts:52](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L52)_ +*Defined in [src/entities/linkedin-profile.entity.ts:52](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L52)* ---- +___ -### \*profileSkills +### *profileSkills -• **\*profileSkills**: string +• ***profileSkills**: string -_Defined in [src/entities/linkedin-profile.entity.ts:53](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L53)_ +*Defined in [src/entities/linkedin-profile.entity.ts:53](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L53)* ---- +___ -### \*profileTestScores +### *profileTestScores -• **\*profileTestScores**: string +• ***profileTestScores**: string -_Defined in [src/entities/linkedin-profile.entity.ts:54](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L54)_ +*Defined in [src/entities/linkedin-profile.entity.ts:54](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L54)* ---- +___ -### \*profileTreasuryMediaProfile +### *profileTreasuryMediaProfile -• **\*profileTreasuryMediaProfile**: string +• ***profileTreasuryMediaProfile**: string -_Defined in [src/entities/linkedin-profile.entity.ts:55](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L55)_ +*Defined in [src/entities/linkedin-profile.entity.ts:55](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L55)* ---- +___ -### \*profileVolunteerExperiences +### *profileVolunteerExperiences -• **\*profileVolunteerExperiences**: string +• ***profileVolunteerExperiences**: string -_Defined in [src/entities/linkedin-profile.entity.ts:56](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L56)_ +*Defined in [src/entities/linkedin-profile.entity.ts:56](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L56)* ---- +___ ### defaultToActivityTab -• **defaultToActivityTab**: boolean +• **defaultToActivityTab**: boolean -_Defined in [src/entities/linkedin-profile.entity.ts:58](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L58)_ +*Defined in [src/entities/linkedin-profile.entity.ts:58](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L58)* ---- +___ ### educationOnProfileTopCardShown -• **educationOnProfileTopCardShown**: boolean +• **educationOnProfileTopCardShown**: boolean -_Defined in [src/entities/linkedin-profile.entity.ts:59](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L59)_ +*Defined in [src/entities/linkedin-profile.entity.ts:59](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L59)* ---- +___ ### entityUrn -• **entityUrn**: [ProfileUrn](../modules/_src_entities_linkedin_profile_entity_.md#profileurn) +• **entityUrn**: [ProfileUrn](../modules/_src_entities_linkedin_profile_entity_.md#profileurn) -_Defined in [src/entities/linkedin-profile.entity.ts:60](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L60)_ +*Defined in [src/entities/linkedin-profile.entity.ts:60](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L60)* ---- +___ ### firstName -• **firstName**: string +• **firstName**: string -_Defined in [src/entities/linkedin-profile.entity.ts:61](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L61)_ +*Defined in [src/entities/linkedin-profile.entity.ts:61](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L61)* ---- +___ ### geoLocation -• **geoLocation**: LinkedInProfileGeoLocation +• **geoLocation**: LinkedInProfileGeoLocation -_Defined in [src/entities/linkedin-profile.entity.ts:63](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L63)_ +*Defined in [src/entities/linkedin-profile.entity.ts:63](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L63)* ---- +___ ### geoLocationBackfilled -• **geoLocationBackfilled**: boolean +• **geoLocationBackfilled**: boolean -_Defined in [src/entities/linkedin-profile.entity.ts:64](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L64)_ +*Defined in [src/entities/linkedin-profile.entity.ts:64](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L64)* ---- +___ ### headline -• **headline**: string +• **headline**: string -_Defined in [src/entities/linkedin-profile.entity.ts:65](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L65)_ +*Defined in [src/entities/linkedin-profile.entity.ts:65](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L65)* ---- +___ ### industryUrn -• **industryUrn**: string +• **industryUrn**: string -_Defined in [src/entities/linkedin-profile.entity.ts:66](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L66)_ +*Defined in [src/entities/linkedin-profile.entity.ts:66](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L66)* ---- +___ ### lastName -• **lastName**: string +• **lastName**: string -_Defined in [src/entities/linkedin-profile.entity.ts:62](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L62)_ +*Defined in [src/entities/linkedin-profile.entity.ts:62](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L62)* ---- +___ ### location -• **location**: LinkedInProfileLocation +• **location**: LinkedInProfileLocation -_Defined in [src/entities/linkedin-profile.entity.ts:67](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L67)_ +*Defined in [src/entities/linkedin-profile.entity.ts:67](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L67)* ---- +___ ### locationName -• **locationName**: string +• **locationName**: string -_Defined in [src/entities/linkedin-profile.entity.ts:68](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L68)_ +*Defined in [src/entities/linkedin-profile.entity.ts:68](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L68)* ---- +___ ### multiLocaleFirstName -• **multiLocaleFirstName**: Record +• **multiLocaleFirstName**: Record -_Defined in [src/entities/linkedin-profile.entity.ts:69](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L69)_ +*Defined in [src/entities/linkedin-profile.entity.ts:69](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L69)* ---- +___ ### multiLocaleHeadline -• **multiLocaleHeadline**: Record +• **multiLocaleHeadline**: Record -_Defined in [src/entities/linkedin-profile.entity.ts:70](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L70)_ +*Defined in [src/entities/linkedin-profile.entity.ts:70](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L70)* ---- +___ ### multiLocaleLastName -• **multiLocaleLastName**: Record +• **multiLocaleLastName**: Record -_Defined in [src/entities/linkedin-profile.entity.ts:71](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L71)_ +*Defined in [src/entities/linkedin-profile.entity.ts:71](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L71)* ---- +___ ### objectUrn -• **objectUrn**: string +• **objectUrn**: string -_Defined in [src/entities/linkedin-profile.entity.ts:72](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L72)_ +*Defined in [src/entities/linkedin-profile.entity.ts:72](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L72)* ---- +___ ### primaryLocale -• **primaryLocale**: LinkedInPrimaryLocale +• **primaryLocale**: LinkedInPrimaryLocale -_Defined in [src/entities/linkedin-profile.entity.ts:73](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L73)_ +*Defined in [src/entities/linkedin-profile.entity.ts:73](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L73)* ---- +___ ### profilePicture -• **profilePicture**: [LinkedInPhotoFilterPicture](_src_entities_linkedin_profile_entity_.linkedinphotofilterpicture.md) +• **profilePicture**: [LinkedInPhotoFilterPicture](_src_entities_linkedin_profile_entity_.linkedinphotofilterpicture.md) -_Defined in [src/entities/linkedin-profile.entity.ts:74](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L74)_ +*Defined in [src/entities/linkedin-profile.entity.ts:74](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L74)* ---- +___ ### publicIdentifier -• **publicIdentifier**: string +• **publicIdentifier**: string -_Defined in [src/entities/linkedin-profile.entity.ts:75](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L75)_ +*Defined in [src/entities/linkedin-profile.entity.ts:75](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L75)* ---- +___ ### supportedLocales -• **supportedLocales**: LinkedInPrimaryLocale[] +• **supportedLocales**: LinkedInPrimaryLocale[] -_Defined in [src/entities/linkedin-profile.entity.ts:76](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L76)_ +*Defined in [src/entities/linkedin-profile.entity.ts:76](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L76)* ---- +___ ### trackingId -• **trackingId**: string +• **trackingId**: string -_Defined in [src/entities/linkedin-profile.entity.ts:77](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L77)_ +*Defined in [src/entities/linkedin-profile.entity.ts:77](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L77)* ---- +___ ### versionTag -• **versionTag**: string +• **versionTag**: string -_Defined in [src/entities/linkedin-profile.entity.ts:78](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L78)_ +*Defined in [src/entities/linkedin-profile.entity.ts:78](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L78)* diff --git a/docs/interfaces/_src_entities_linkedin_quick_replay_recommendation_entity_.quickreplayrecommendation.md b/docs/interfaces/_src_entities_linkedin_quick_replay_recommendation_entity_.quickreplayrecommendation.md index e0dece1c..4e3a0431 100644 --- a/docs/interfaces/_src_entities_linkedin_quick_replay_recommendation_entity_.quickreplayrecommendation.md +++ b/docs/interfaces/_src_entities_linkedin_quick_replay_recommendation_entity_.quickreplayrecommendation.md @@ -6,54 +6,54 @@ ## Hierarchy -- **QuickReplayRecommendation** +* **QuickReplayRecommendation** ## Index ### Properties -- [$type](_src_entities_linkedin_quick_replay_recommendation_entity_.quickreplayrecommendation.md#$type) -- [content](_src_entities_linkedin_quick_replay_recommendation_entity_.quickreplayrecommendation.md#content) -- [objectUrn](_src_entities_linkedin_quick_replay_recommendation_entity_.quickreplayrecommendation.md#objecturn) -- [replyType](_src_entities_linkedin_quick_replay_recommendation_entity_.quickreplayrecommendation.md#replytype) -- [trackingId](_src_entities_linkedin_quick_replay_recommendation_entity_.quickreplayrecommendation.md#trackingid) +* [$type](_src_entities_linkedin_quick_replay_recommendation_entity_.quickreplayrecommendation.md#$type) +* [content](_src_entities_linkedin_quick_replay_recommendation_entity_.quickreplayrecommendation.md#content) +* [objectUrn](_src_entities_linkedin_quick_replay_recommendation_entity_.quickreplayrecommendation.md#objecturn) +* [replyType](_src_entities_linkedin_quick_replay_recommendation_entity_.quickreplayrecommendation.md#replytype) +* [trackingId](_src_entities_linkedin_quick_replay_recommendation_entity_.quickreplayrecommendation.md#trackingid) ## Properties ### $type -• **$type**: \"com.linkedin.voyager.messaging.QuickReply\" +• **$type**: \"com.linkedin.voyager.messaging.QuickReply\" -_Defined in [src/entities/linkedin-quick-replay-recommendation.entity.ts:4](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-quick-replay-recommendation.entity.ts#L4)_ +*Defined in [src/entities/linkedin-quick-replay-recommendation.entity.ts:4](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-quick-replay-recommendation.entity.ts#L4)* ---- +___ ### content -• **content**: [AttributeText](_src_entities_linkedin_attribute_text_entity_.attributetext.md) +• **content**: [AttributeText](_src_entities_linkedin_attribute_text_entity_.attributetext.md) -_Defined in [src/entities/linkedin-quick-replay-recommendation.entity.ts:5](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-quick-replay-recommendation.entity.ts#L5)_ +*Defined in [src/entities/linkedin-quick-replay-recommendation.entity.ts:5](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-quick-replay-recommendation.entity.ts#L5)* ---- +___ ### objectUrn -• **objectUrn**: string +• **objectUrn**: string -_Defined in [src/entities/linkedin-quick-replay-recommendation.entity.ts:6](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-quick-replay-recommendation.entity.ts#L6)_ +*Defined in [src/entities/linkedin-quick-replay-recommendation.entity.ts:6](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-quick-replay-recommendation.entity.ts#L6)* ---- +___ ### replyType -• **replyType**: string +• **replyType**: string -_Defined in [src/entities/linkedin-quick-replay-recommendation.entity.ts:7](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-quick-replay-recommendation.entity.ts#L7)_ +*Defined in [src/entities/linkedin-quick-replay-recommendation.entity.ts:7](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-quick-replay-recommendation.entity.ts#L7)* ---- +___ ### trackingId -• **trackingId**: string +• **trackingId**: string -_Defined in [src/entities/linkedin-quick-replay-recommendation.entity.ts:8](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-quick-replay-recommendation.entity.ts#L8)_ +*Defined in [src/entities/linkedin-quick-replay-recommendation.entity.ts:8](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-quick-replay-recommendation.entity.ts#L8)* diff --git a/docs/interfaces/_src_entities_linkedin_search_cluster_entity_.linkedinsearchcluster.md b/docs/interfaces/_src_entities_linkedin_search_cluster_entity_.linkedinsearchcluster.md index 20bdc3df..8bf0b98d 100644 --- a/docs/interfaces/_src_entities_linkedin_search_cluster_entity_.linkedinsearchcluster.md +++ b/docs/interfaces/_src_entities_linkedin_search_cluster_entity_.linkedinsearchcluster.md @@ -6,36 +6,36 @@ ## Hierarchy -- **LinkedInSearchCluster** +* **LinkedInSearchCluster** ## Index ### Properties -- [$type](_src_entities_linkedin_search_cluster_entity_.linkedinsearchcluster.md#$type) -- [elements](_src_entities_linkedin_search_cluster_entity_.linkedinsearchcluster.md#elements) -- [type](_src_entities_linkedin_search_cluster_entity_.linkedinsearchcluster.md#type) +* [$type](_src_entities_linkedin_search_cluster_entity_.linkedinsearchcluster.md#$type) +* [elements](_src_entities_linkedin_search_cluster_entity_.linkedinsearchcluster.md#elements) +* [type](_src_entities_linkedin_search_cluster_entity_.linkedinsearchcluster.md#type) ## Properties ### $type -• **$type**: \"com.linkedin.voyager.search.BlendedSearchCluster\" +• **$type**: \"com.linkedin.voyager.search.BlendedSearchCluster\" -_Defined in [src/entities/linkedin-search-cluster.entity.ts:5](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-search-cluster.entity.ts#L5)_ +*Defined in [src/entities/linkedin-search-cluster.entity.ts:5](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-search-cluster.entity.ts#L5)* ---- +___ ### elements -• **elements**: [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md)[] +• **elements**: [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md)[] -_Defined in [src/entities/linkedin-search-cluster.entity.ts:6](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-search-cluster.entity.ts#L6)_ +*Defined in [src/entities/linkedin-search-cluster.entity.ts:6](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-search-cluster.entity.ts#L6)* ---- +___ ### type -• **type**: SearchResultType +• **type**: SearchResultType -_Defined in [src/entities/linkedin-search-cluster.entity.ts:7](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-search-cluster.entity.ts#L7)_ +*Defined in [src/entities/linkedin-search-cluster.entity.ts:7](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-search-cluster.entity.ts#L7)* diff --git a/docs/interfaces/_src_entities_linkedin_search_hit_entity_.linkedinsearchhit.md b/docs/interfaces/_src_entities_linkedin_search_hit_entity_.linkedinsearchhit.md index a9c366c2..19e6198d 100644 --- a/docs/interfaces/_src_entities_linkedin_search_hit_entity_.linkedinsearchhit.md +++ b/docs/interfaces/_src_entities_linkedin_search_hit_entity_.linkedinsearchhit.md @@ -6,60 +6,60 @@ ## Type parameters -| Name | -| ---- | -| `T` | +Name | +------ | +`T` | ## Hierarchy -- **LinkedInSearchHit** +* **LinkedInSearchHit** ## Index ### Properties -- [$recipeTypes](_src_entities_linkedin_search_hit_entity_.linkedinsearchhit.md#$recipetypes) -- [$type](_src_entities_linkedin_search_hit_entity_.linkedinsearchhit.md#$type) -- [hitInfo](_src_entities_linkedin_search_hit_entity_.linkedinsearchhit.md#hitinfo) -- [targetPageInstance](_src_entities_linkedin_search_hit_entity_.linkedinsearchhit.md#targetpageinstance) -- [trackingId](_src_entities_linkedin_search_hit_entity_.linkedinsearchhit.md#trackingid) +* [$recipeTypes](_src_entities_linkedin_search_hit_entity_.linkedinsearchhit.md#$recipetypes) +* [$type](_src_entities_linkedin_search_hit_entity_.linkedinsearchhit.md#$type) +* [hitInfo](_src_entities_linkedin_search_hit_entity_.linkedinsearchhit.md#hitinfo) +* [targetPageInstance](_src_entities_linkedin_search_hit_entity_.linkedinsearchhit.md#targetpageinstance) +* [trackingId](_src_entities_linkedin_search_hit_entity_.linkedinsearchhit.md#trackingid) ## Properties ### $recipeTypes -• **$recipeTypes**: string[] +• **$recipeTypes**: string[] -_Defined in [src/entities/linkedin-search-hit-entity.ts:2](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-search-hit-entity.ts#L2)_ +*Defined in [src/entities/linkedin-search-hit-entity.ts:2](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-search-hit-entity.ts#L2)* ---- +___ ### $type -• **$type**: \"com.linkedin.voyager.search.SearchHit\" +• **$type**: \"com.linkedin.voyager.search.SearchHit\" -_Defined in [src/entities/linkedin-search-hit-entity.ts:3](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-search-hit-entity.ts#L3)_ +*Defined in [src/entities/linkedin-search-hit-entity.ts:3](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-search-hit-entity.ts#L3)* ---- +___ ### hitInfo -• **hitInfo**: T +• **hitInfo**: T -_Defined in [src/entities/linkedin-search-hit-entity.ts:4](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-search-hit-entity.ts#L4)_ +*Defined in [src/entities/linkedin-search-hit-entity.ts:4](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-search-hit-entity.ts#L4)* ---- +___ ### targetPageInstance -• **targetPageInstance**: string +• **targetPageInstance**: string -_Defined in [src/entities/linkedin-search-hit-entity.ts:5](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-search-hit-entity.ts#L5)_ +*Defined in [src/entities/linkedin-search-hit-entity.ts:5](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-search-hit-entity.ts#L5)* ---- +___ ### trackingId -• **trackingId**: string +• **trackingId**: string -_Defined in [src/entities/linkedin-search-hit-entity.ts:6](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-search-hit-entity.ts#L6)_ +*Defined in [src/entities/linkedin-search-hit-entity.ts:6](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-search-hit-entity.ts#L6)* diff --git a/docs/interfaces/_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md b/docs/interfaces/_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md index 3dc84c5d..d6f7f0e8 100644 --- a/docs/interfaces/_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md +++ b/docs/interfaces/_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md @@ -6,7 +6,7 @@ ## Hierarchy -- **LinkedInSearchHitV2** +* **LinkedInSearchHitV2** ↳ [CompanySearchHit](_src_entities_company_search_hit_entity_.companysearchhit.md) @@ -16,163 +16,163 @@ ### Properties -- [$type](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#$type) -- [\*badges](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#*badges) -- [headless](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#headless) -- [headline](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#headline) -- [image](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#image) -- [memberDistance](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#memberdistance) -- [nameMatch](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#namematch) -- [navigationUrl](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#navigationurl) -- [publicIdentifier](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#publicidentifier) -- [secondaryTitle](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#secondarytitle) -- [socialProofText](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#socialprooftext) -- [subline](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#subline) -- [targetUrn](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#targeturn) -- [title](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#title) -- [trackingId](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#trackingid) -- [trackingUrn](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#trackingurn) -- [type](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#type) +* [$type](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#$type) +* [*badges](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#*badges) +* [headless](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#headless) +* [headline](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#headline) +* [image](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#image) +* [memberDistance](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#memberdistance) +* [nameMatch](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#namematch) +* [navigationUrl](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#navigationurl) +* [publicIdentifier](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#publicidentifier) +* [secondaryTitle](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#secondarytitle) +* [socialProofText](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#socialprooftext) +* [subline](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#subline) +* [targetUrn](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#targeturn) +* [title](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#title) +* [trackingId](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#trackingid) +* [trackingUrn](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#trackingurn) +* [type](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#type) ## Properties ### $type -• **$type**: \"com.linkedin.voyager.search.SearchHitV2\" +• **$type**: \"com.linkedin.voyager.search.SearchHitV2\" -_Defined in [src/entities/linkedin-search-hit-v2.entity.ts:5](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-search-hit-v2.entity.ts#L5)_ +*Defined in [src/entities/linkedin-search-hit-v2.entity.ts:5](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-search-hit-v2.entity.ts#L5)* ---- +___ -### \*badges +### *badges -• **\*badges**: string +• ***badges**: string -_Defined in [src/entities/linkedin-search-hit-v2.entity.ts:6](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-search-hit-v2.entity.ts#L6)_ +*Defined in [src/entities/linkedin-search-hit-v2.entity.ts:6](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-search-hit-v2.entity.ts#L6)* ---- +___ ### headless -• **headless**: string +• **headless**: string -_Defined in [src/entities/linkedin-search-hit-v2.entity.ts:7](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-search-hit-v2.entity.ts#L7)_ +*Defined in [src/entities/linkedin-search-hit-v2.entity.ts:7](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-search-hit-v2.entity.ts#L7)* ---- +___ ### headline -• **headline**: [LinkedInTextViewModel](_src_entities_linkedin_text_view_model_entity_.linkedintextviewmodel.md) +• **headline**: [LinkedInTextViewModel](_src_entities_linkedin_text_view_model_entity_.linkedintextviewmodel.md) -_Defined in [src/entities/linkedin-search-hit-v2.entity.ts:8](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-search-hit-v2.entity.ts#L8)_ +*Defined in [src/entities/linkedin-search-hit-v2.entity.ts:8](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-search-hit-v2.entity.ts#L8)* ---- +___ ### image -• **image**: [LinkedInImageViewModel](_src_entities_linkedin_image_view_model_entity_.linkedinimageviewmodel.md) +• **image**: [LinkedInImageViewModel](_src_entities_linkedin_image_view_model_entity_.linkedinimageviewmodel.md) -_Defined in [src/entities/linkedin-search-hit-v2.entity.ts:9](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-search-hit-v2.entity.ts#L9)_ +*Defined in [src/entities/linkedin-search-hit-v2.entity.ts:9](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-search-hit-v2.entity.ts#L9)* ---- +___ ### memberDistance -• **memberDistance**: { $type: \"com.linkedin.voyager.common.MemberDistance\" ; value: string } +• **memberDistance**: { $type: \"com.linkedin.voyager.common.MemberDistance\" ; value: string } -_Defined in [src/entities/linkedin-search-hit-v2.entity.ts:10](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-search-hit-v2.entity.ts#L10)_ +*Defined in [src/entities/linkedin-search-hit-v2.entity.ts:10](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-search-hit-v2.entity.ts#L10)* #### Type declaration: -| Name | Type | -| ------- | ---------------------------------------------- | -| `$type` | \"com.linkedin.voyager.common.MemberDistance\" | -| `value` | string | +Name | Type | +------ | ------ | +`$type` | \"com.linkedin.voyager.common.MemberDistance\" | +`value` | string | ---- +___ ### nameMatch -• **nameMatch**: boolean +• **nameMatch**: boolean -_Defined in [src/entities/linkedin-search-hit-v2.entity.ts:14](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-search-hit-v2.entity.ts#L14)_ +*Defined in [src/entities/linkedin-search-hit-v2.entity.ts:14](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-search-hit-v2.entity.ts#L14)* ---- +___ ### navigationUrl -• **navigationUrl**: string +• **navigationUrl**: string -_Defined in [src/entities/linkedin-search-hit-v2.entity.ts:15](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-search-hit-v2.entity.ts#L15)_ +*Defined in [src/entities/linkedin-search-hit-v2.entity.ts:15](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-search-hit-v2.entity.ts#L15)* ---- +___ ### publicIdentifier -• **publicIdentifier**: string +• **publicIdentifier**: string -_Defined in [src/entities/linkedin-search-hit-v2.entity.ts:16](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-search-hit-v2.entity.ts#L16)_ +*Defined in [src/entities/linkedin-search-hit-v2.entity.ts:16](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-search-hit-v2.entity.ts#L16)* ---- +___ ### secondaryTitle -• **secondaryTitle**: [LinkedInTextViewModel](_src_entities_linkedin_text_view_model_entity_.linkedintextviewmodel.md) +• **secondaryTitle**: [LinkedInTextViewModel](_src_entities_linkedin_text_view_model_entity_.linkedintextviewmodel.md) -_Defined in [src/entities/linkedin-search-hit-v2.entity.ts:17](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-search-hit-v2.entity.ts#L17)_ +*Defined in [src/entities/linkedin-search-hit-v2.entity.ts:17](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-search-hit-v2.entity.ts#L17)* ---- +___ ### socialProofText -• **socialProofText**: string +• **socialProofText**: string -_Defined in [src/entities/linkedin-search-hit-v2.entity.ts:18](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-search-hit-v2.entity.ts#L18)_ +*Defined in [src/entities/linkedin-search-hit-v2.entity.ts:18](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-search-hit-v2.entity.ts#L18)* ---- +___ ### subline -• **subline**: [LinkedInTextViewModel](_src_entities_linkedin_text_view_model_entity_.linkedintextviewmodel.md) +• **subline**: [LinkedInTextViewModel](_src_entities_linkedin_text_view_model_entity_.linkedintextviewmodel.md) -_Defined in [src/entities/linkedin-search-hit-v2.entity.ts:19](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-search-hit-v2.entity.ts#L19)_ +*Defined in [src/entities/linkedin-search-hit-v2.entity.ts:19](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-search-hit-v2.entity.ts#L19)* ---- +___ ### targetUrn -• **targetUrn**: string +• **targetUrn**: string -_Defined in [src/entities/linkedin-search-hit-v2.entity.ts:20](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-search-hit-v2.entity.ts#L20)_ +*Defined in [src/entities/linkedin-search-hit-v2.entity.ts:20](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-search-hit-v2.entity.ts#L20)* ---- +___ ### title -• **title**: [LinkedInTextViewModel](_src_entities_linkedin_text_view_model_entity_.linkedintextviewmodel.md) +• **title**: [LinkedInTextViewModel](_src_entities_linkedin_text_view_model_entity_.linkedintextviewmodel.md) -_Defined in [src/entities/linkedin-search-hit-v2.entity.ts:21](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-search-hit-v2.entity.ts#L21)_ +*Defined in [src/entities/linkedin-search-hit-v2.entity.ts:21](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-search-hit-v2.entity.ts#L21)* ---- +___ ### trackingId -• **trackingId**: string +• **trackingId**: string -_Defined in [src/entities/linkedin-search-hit-v2.entity.ts:22](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-search-hit-v2.entity.ts#L22)_ +*Defined in [src/entities/linkedin-search-hit-v2.entity.ts:22](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-search-hit-v2.entity.ts#L22)* ---- +___ ### trackingUrn -• **trackingUrn**: string +• **trackingUrn**: string -_Defined in [src/entities/linkedin-search-hit-v2.entity.ts:23](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-search-hit-v2.entity.ts#L23)_ +*Defined in [src/entities/linkedin-search-hit-v2.entity.ts:23](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-search-hit-v2.entity.ts#L23)* ---- +___ ### type -• **type**: string +• **type**: string -_Defined in [src/entities/linkedin-search-hit-v2.entity.ts:24](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-search-hit-v2.entity.ts#L24)_ +*Defined in [src/entities/linkedin-search-hit-v2.entity.ts:24](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-search-hit-v2.entity.ts#L24)* diff --git a/docs/interfaces/_src_entities_linkedin_text_view_model_entity_.linkedintextviewmodel.md b/docs/interfaces/_src_entities_linkedin_text_view_model_entity_.linkedintextviewmodel.md index 8ef70b70..599d0ac3 100644 --- a/docs/interfaces/_src_entities_linkedin_text_view_model_entity_.linkedintextviewmodel.md +++ b/docs/interfaces/_src_entities_linkedin_text_view_model_entity_.linkedintextviewmodel.md @@ -6,36 +6,36 @@ ## Hierarchy -- **LinkedInTextViewModel** +* **LinkedInTextViewModel** ## Index ### Properties -- [$type](_src_entities_linkedin_text_view_model_entity_.linkedintextviewmodel.md#$type) -- [text](_src_entities_linkedin_text_view_model_entity_.linkedintextviewmodel.md#text) -- [textDirection](_src_entities_linkedin_text_view_model_entity_.linkedintextviewmodel.md#textdirection) +* [$type](_src_entities_linkedin_text_view_model_entity_.linkedintextviewmodel.md#$type) +* [text](_src_entities_linkedin_text_view_model_entity_.linkedintextviewmodel.md#text) +* [textDirection](_src_entities_linkedin_text_view_model_entity_.linkedintextviewmodel.md#textdirection) ## Properties ### $type -• **$type**: \"com.linkedin.voyager.common.TextViewModel\" +• **$type**: \"com.linkedin.voyager.common.TextViewModel\" -_Defined in [src/entities/linkedin-text-view-model.entity.ts:2](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-text-view-model.entity.ts#L2)_ +*Defined in [src/entities/linkedin-text-view-model.entity.ts:2](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-text-view-model.entity.ts#L2)* ---- +___ ### text -• **text**: string +• **text**: string -_Defined in [src/entities/linkedin-text-view-model.entity.ts:3](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-text-view-model.entity.ts#L3)_ +*Defined in [src/entities/linkedin-text-view-model.entity.ts:3](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-text-view-model.entity.ts#L3)* ---- +___ ### textDirection -• **textDirection**: string +• **textDirection**: string -_Defined in [src/entities/linkedin-text-view-model.entity.ts:4](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-text-view-model.entity.ts#L4)_ +*Defined in [src/entities/linkedin-text-view-model.entity.ts:4](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-text-view-model.entity.ts#L4)* diff --git a/docs/interfaces/_src_entities_linkedin_vector_artifact_entity_.linkedinvectorartifact.md b/docs/interfaces/_src_entities_linkedin_vector_artifact_entity_.linkedinvectorartifact.md index fa23f36d..dd861205 100644 --- a/docs/interfaces/_src_entities_linkedin_vector_artifact_entity_.linkedinvectorartifact.md +++ b/docs/interfaces/_src_entities_linkedin_vector_artifact_entity_.linkedinvectorartifact.md @@ -6,54 +6,54 @@ ## Hierarchy -- **LinkedInVectorArtifact** +* **LinkedInVectorArtifact** ## Index ### Properties -- [$type](_src_entities_linkedin_vector_artifact_entity_.linkedinvectorartifact.md#$type) -- [expiresAt](_src_entities_linkedin_vector_artifact_entity_.linkedinvectorartifact.md#expiresat) -- [fileIdentifyingUrlPathSegment](_src_entities_linkedin_vector_artifact_entity_.linkedinvectorartifact.md#fileidentifyingurlpathsegment) -- [height](_src_entities_linkedin_vector_artifact_entity_.linkedinvectorartifact.md#height) -- [with](_src_entities_linkedin_vector_artifact_entity_.linkedinvectorartifact.md#with) +* [$type](_src_entities_linkedin_vector_artifact_entity_.linkedinvectorartifact.md#$type) +* [expiresAt](_src_entities_linkedin_vector_artifact_entity_.linkedinvectorartifact.md#expiresat) +* [fileIdentifyingUrlPathSegment](_src_entities_linkedin_vector_artifact_entity_.linkedinvectorartifact.md#fileidentifyingurlpathsegment) +* [height](_src_entities_linkedin_vector_artifact_entity_.linkedinvectorartifact.md#height) +* [with](_src_entities_linkedin_vector_artifact_entity_.linkedinvectorartifact.md#with) ## Properties ### $type -• **$type**: \"com.linkedin.common.VectorArtifact\" +• **$type**: \"com.linkedin.common.VectorArtifact\" -_Defined in [src/entities/linkedin-vector-artifact.entity.ts:2](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-vector-artifact.entity.ts#L2)_ +*Defined in [src/entities/linkedin-vector-artifact.entity.ts:2](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-vector-artifact.entity.ts#L2)* ---- +___ ### expiresAt -• **expiresAt**: number +• **expiresAt**: number -_Defined in [src/entities/linkedin-vector-artifact.entity.ts:3](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-vector-artifact.entity.ts#L3)_ +*Defined in [src/entities/linkedin-vector-artifact.entity.ts:3](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-vector-artifact.entity.ts#L3)* ---- +___ ### fileIdentifyingUrlPathSegment -• **fileIdentifyingUrlPathSegment**: string +• **fileIdentifyingUrlPathSegment**: string -_Defined in [src/entities/linkedin-vector-artifact.entity.ts:4](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-vector-artifact.entity.ts#L4)_ +*Defined in [src/entities/linkedin-vector-artifact.entity.ts:4](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-vector-artifact.entity.ts#L4)* ---- +___ ### height -• **height**: number +• **height**: number -_Defined in [src/entities/linkedin-vector-artifact.entity.ts:5](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-vector-artifact.entity.ts#L5)_ +*Defined in [src/entities/linkedin-vector-artifact.entity.ts:5](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-vector-artifact.entity.ts#L5)* ---- +___ ### with -• **with**: number +• **with**: number -_Defined in [src/entities/linkedin-vector-artifact.entity.ts:6](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-vector-artifact.entity.ts#L6)_ +*Defined in [src/entities/linkedin-vector-artifact.entity.ts:6](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-vector-artifact.entity.ts#L6)* diff --git a/docs/interfaces/_src_entities_linkedin_vector_image_entity_.linkedinvectorimage.md b/docs/interfaces/_src_entities_linkedin_vector_image_entity_.linkedinvectorimage.md index 48deb65c..385cc5db 100644 --- a/docs/interfaces/_src_entities_linkedin_vector_image_entity_.linkedinvectorimage.md +++ b/docs/interfaces/_src_entities_linkedin_vector_image_entity_.linkedinvectorimage.md @@ -6,36 +6,36 @@ ## Hierarchy -- **LinkedInVectorImage** +* **LinkedInVectorImage** ## Index ### Properties -- [$type](_src_entities_linkedin_vector_image_entity_.linkedinvectorimage.md#$type) -- [artifacts](_src_entities_linkedin_vector_image_entity_.linkedinvectorimage.md#artifacts) -- [rootUrl](_src_entities_linkedin_vector_image_entity_.linkedinvectorimage.md#rooturl) +* [$type](_src_entities_linkedin_vector_image_entity_.linkedinvectorimage.md#$type) +* [artifacts](_src_entities_linkedin_vector_image_entity_.linkedinvectorimage.md#artifacts) +* [rootUrl](_src_entities_linkedin_vector_image_entity_.linkedinvectorimage.md#rooturl) ## Properties ### $type -• **$type**: \"com.linkedin.common.VectorImage\" +• **$type**: \"com.linkedin.common.VectorImage\" -_Defined in [src/entities/linkedin-vector-image.entity.ts:4](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-vector-image.entity.ts#L4)_ +*Defined in [src/entities/linkedin-vector-image.entity.ts:4](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-vector-image.entity.ts#L4)* ---- +___ ### artifacts -• **artifacts**: [LinkedInVectorArtifact](_src_entities_linkedin_vector_artifact_entity_.linkedinvectorartifact.md)[] +• **artifacts**: [LinkedInVectorArtifact](_src_entities_linkedin_vector_artifact_entity_.linkedinvectorartifact.md)[] -_Defined in [src/entities/linkedin-vector-image.entity.ts:5](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-vector-image.entity.ts#L5)_ +*Defined in [src/entities/linkedin-vector-image.entity.ts:5](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-vector-image.entity.ts#L5)* ---- +___ ### rootUrl -• **rootUrl**: string +• **rootUrl**: string -_Defined in [src/entities/linkedin-vector-image.entity.ts:6](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-vector-image.entity.ts#L6)_ +*Defined in [src/entities/linkedin-vector-image.entity.ts:6](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-vector-image.entity.ts#L6)* diff --git a/docs/interfaces/_src_entities_message_create_response_entity_.messageeventcreateresponse.md b/docs/interfaces/_src_entities_message_create_response_entity_.messageeventcreateresponse.md index 263c46ed..7946859c 100644 --- a/docs/interfaces/_src_entities_message_create_response_entity_.messageeventcreateresponse.md +++ b/docs/interfaces/_src_entities_message_create_response_entity_.messageeventcreateresponse.md @@ -6,7 +6,7 @@ ## Hierarchy -- [LinkedEventCreateResponse](_src_entities_linkedin_event_create_response_.linkedeventcreateresponse.md) +* [LinkedEventCreateResponse](_src_entities_linkedin_event_create_response_.linkedeventcreateresponse.md) ↳ **MessageEventCreateResponse** @@ -14,78 +14,78 @@ ### Properties -- [$type](_src_entities_message_create_response_entity_.messageeventcreateresponse.md#$type) -- [backendConversationUrn](_src_entities_message_create_response_entity_.messageeventcreateresponse.md#backendconversationurn) -- [backendEventUrn](_src_entities_message_create_response_entity_.messageeventcreateresponse.md#backendeventurn) -- [conversationUrn](_src_entities_message_create_response_entity_.messageeventcreateresponse.md#conversationurn) -- [createdAt](_src_entities_message_create_response_entity_.messageeventcreateresponse.md#createdat) -- [eventUrn](_src_entities_message_create_response_entity_.messageeventcreateresponse.md#eventurn) -- [text](_src_entities_message_create_response_entity_.messageeventcreateresponse.md#text) +* [$type](_src_entities_message_create_response_entity_.messageeventcreateresponse.md#$type) +* [backendConversationUrn](_src_entities_message_create_response_entity_.messageeventcreateresponse.md#backendconversationurn) +* [backendEventUrn](_src_entities_message_create_response_entity_.messageeventcreateresponse.md#backendeventurn) +* [conversationUrn](_src_entities_message_create_response_entity_.messageeventcreateresponse.md#conversationurn) +* [createdAt](_src_entities_message_create_response_entity_.messageeventcreateresponse.md#createdat) +* [eventUrn](_src_entities_message_create_response_entity_.messageeventcreateresponse.md#eventurn) +* [text](_src_entities_message_create_response_entity_.messageeventcreateresponse.md#text) ## Properties ### $type -• **$type**: \"com.linkedin.voyager.messaging.create.EventCreateResponse\" +• **$type**: \"com.linkedin.voyager.messaging.create.EventCreateResponse\" -_Inherited from [LinkedEventCreateResponse](_src_entities_linkedin_event_create_response_.linkedeventcreateresponse.md).[$type](_src_entities_linkedin_event_create_response_.linkedeventcreateresponse.md#$type)_ +*Inherited from [LinkedEventCreateResponse](_src_entities_linkedin_event_create_response_.linkedeventcreateresponse.md).[$type](_src_entities_linkedin_event_create_response_.linkedeventcreateresponse.md#$type)* -_Defined in [src/entities/linkedin-event-create-response.ts:2](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-event-create-response.ts#L2)_ +*Defined in [src/entities/linkedin-event-create-response.ts:2](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-event-create-response.ts#L2)* ---- +___ ### backendConversationUrn -• **backendConversationUrn**: string +• **backendConversationUrn**: string -_Inherited from [LinkedEventCreateResponse](_src_entities_linkedin_event_create_response_.linkedeventcreateresponse.md).[backendConversationUrn](_src_entities_linkedin_event_create_response_.linkedeventcreateresponse.md#backendconversationurn)_ +*Inherited from [LinkedEventCreateResponse](_src_entities_linkedin_event_create_response_.linkedeventcreateresponse.md).[backendConversationUrn](_src_entities_linkedin_event_create_response_.linkedeventcreateresponse.md#backendconversationurn)* -_Defined in [src/entities/linkedin-event-create-response.ts:3](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-event-create-response.ts#L3)_ +*Defined in [src/entities/linkedin-event-create-response.ts:3](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-event-create-response.ts#L3)* ---- +___ ### backendEventUrn -• **backendEventUrn**: string +• **backendEventUrn**: string -_Inherited from [LinkedEventCreateResponse](_src_entities_linkedin_event_create_response_.linkedeventcreateresponse.md).[backendEventUrn](_src_entities_linkedin_event_create_response_.linkedeventcreateresponse.md#backendeventurn)_ +*Inherited from [LinkedEventCreateResponse](_src_entities_linkedin_event_create_response_.linkedeventcreateresponse.md).[backendEventUrn](_src_entities_linkedin_event_create_response_.linkedeventcreateresponse.md#backendeventurn)* -_Defined in [src/entities/linkedin-event-create-response.ts:4](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-event-create-response.ts#L4)_ +*Defined in [src/entities/linkedin-event-create-response.ts:4](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-event-create-response.ts#L4)* ---- +___ ### conversationUrn -• **conversationUrn**: string +• **conversationUrn**: string -_Inherited from [LinkedEventCreateResponse](_src_entities_linkedin_event_create_response_.linkedeventcreateresponse.md).[conversationUrn](_src_entities_linkedin_event_create_response_.linkedeventcreateresponse.md#conversationurn)_ +*Inherited from [LinkedEventCreateResponse](_src_entities_linkedin_event_create_response_.linkedeventcreateresponse.md).[conversationUrn](_src_entities_linkedin_event_create_response_.linkedeventcreateresponse.md#conversationurn)* -_Defined in [src/entities/linkedin-event-create-response.ts:5](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-event-create-response.ts#L5)_ +*Defined in [src/entities/linkedin-event-create-response.ts:5](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-event-create-response.ts#L5)* ---- +___ ### createdAt -• **createdAt**: number +• **createdAt**: number -_Inherited from [LinkedEventCreateResponse](_src_entities_linkedin_event_create_response_.linkedeventcreateresponse.md).[createdAt](_src_entities_linkedin_event_create_response_.linkedeventcreateresponse.md#createdat)_ +*Inherited from [LinkedEventCreateResponse](_src_entities_linkedin_event_create_response_.linkedeventcreateresponse.md).[createdAt](_src_entities_linkedin_event_create_response_.linkedeventcreateresponse.md#createdat)* -_Defined in [src/entities/linkedin-event-create-response.ts:6](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-event-create-response.ts#L6)_ +*Defined in [src/entities/linkedin-event-create-response.ts:6](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-event-create-response.ts#L6)* ---- +___ ### eventUrn -• **eventUrn**: string +• **eventUrn**: string -_Inherited from [LinkedEventCreateResponse](_src_entities_linkedin_event_create_response_.linkedeventcreateresponse.md).[eventUrn](_src_entities_linkedin_event_create_response_.linkedeventcreateresponse.md#eventurn)_ +*Inherited from [LinkedEventCreateResponse](_src_entities_linkedin_event_create_response_.linkedeventcreateresponse.md).[eventUrn](_src_entities_linkedin_event_create_response_.linkedeventcreateresponse.md#eventurn)* -_Defined in [src/entities/linkedin-event-create-response.ts:7](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-event-create-response.ts#L7)_ +*Defined in [src/entities/linkedin-event-create-response.ts:7](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-event-create-response.ts#L7)* ---- +___ ### text -• **text**: string +• **text**: string -_Defined in [src/entities/message-create-response.entity.ts:4](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/message-create-response.entity.ts#L4)_ +*Defined in [src/entities/message-create-response.entity.ts:4](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/message-create-response.entity.ts#L4)* diff --git a/docs/interfaces/_src_entities_message_event_entity_.messageevent.md b/docs/interfaces/_src_entities_message_event_entity_.messageevent.md index a573d385..de8fe069 100644 --- a/docs/interfaces/_src_entities_message_event_entity_.messageevent.md +++ b/docs/interfaces/_src_entities_message_event_entity_.messageevent.md @@ -6,7 +6,7 @@ ## Hierarchy -- [LinkedInMessageEvent](_src_entities_linkedin_message_event_entity_.linkedinmessageevent.md) +* [LinkedInMessageEvent](_src_entities_linkedin_message_event_entity_.linkedinmessageevent.md) ↳ **MessageEvent** @@ -14,144 +14,144 @@ ### Properties -- [$type](_src_entities_message_event_entity_.messageevent.md#$type) -- [\*from](_src_entities_message_event_entity_.messageevent.md#*from) -- [backendUrn](_src_entities_message_event_entity_.messageevent.md#backendurn) -- [createdAt](_src_entities_message_event_entity_.messageevent.md#createdat) -- [dashEntityUrn](_src_entities_message_event_entity_.messageevent.md#dashentityurn) -- [entityUrn](_src_entities_message_event_entity_.messageevent.md#entityurn) -- [eventContent](_src_entities_message_event_entity_.messageevent.md#eventcontent) -- [originToken](_src_entities_message_event_entity_.messageevent.md#origintoken) -- [previousEventInConversation](_src_entities_message_event_entity_.messageevent.md#previouseventinconversation) -- [quickReplyRecommendations](_src_entities_message_event_entity_.messageevent.md#quickreplyrecommendations) -- [sentFrom](_src_entities_message_event_entity_.messageevent.md#sentfrom) -- [subtype](_src_entities_message_event_entity_.messageevent.md#subtype) -- [text](_src_entities_message_event_entity_.messageevent.md#text) +* [$type](_src_entities_message_event_entity_.messageevent.md#$type) +* [*from](_src_entities_message_event_entity_.messageevent.md#*from) +* [backendUrn](_src_entities_message_event_entity_.messageevent.md#backendurn) +* [createdAt](_src_entities_message_event_entity_.messageevent.md#createdat) +* [dashEntityUrn](_src_entities_message_event_entity_.messageevent.md#dashentityurn) +* [entityUrn](_src_entities_message_event_entity_.messageevent.md#entityurn) +* [eventContent](_src_entities_message_event_entity_.messageevent.md#eventcontent) +* [originToken](_src_entities_message_event_entity_.messageevent.md#origintoken) +* [previousEventInConversation](_src_entities_message_event_entity_.messageevent.md#previouseventinconversation) +* [quickReplyRecommendations](_src_entities_message_event_entity_.messageevent.md#quickreplyrecommendations) +* [sentFrom](_src_entities_message_event_entity_.messageevent.md#sentfrom) +* [subtype](_src_entities_message_event_entity_.messageevent.md#subtype) +* [text](_src_entities_message_event_entity_.messageevent.md#text) ## Properties ### $type -• **$type**: _typeof_ [EVENT_TYPE](../modules/_src_entities_linkedin_event_entity_.md#event_type) +• **$type**: *typeof* [EVENT\_TYPE](../modules/_src_entities_linkedin_event_entity_.md#event_type) -_Inherited from [LinkedInEvent](_src_entities_linkedin_event_entity_.linkedinevent.md).[$type](_src_entities_linkedin_event_entity_.linkedinevent.md#$type)_ +*Inherited from [LinkedInEvent](_src_entities_linkedin_event_entity_.linkedinevent.md).[$type](_src_entities_linkedin_event_entity_.linkedinevent.md#$type)* -_Defined in [src/entities/linkedin-event.entity.ts:6](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-event.entity.ts#L6)_ +*Defined in [src/entities/linkedin-event.entity.ts:6](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-event.entity.ts#L6)* ---- +___ -### \*from +### *from -• **\*from**: string +• ***from**: string -*Inherited from [LinkedInEvent](_src_entities_linkedin_event_entity_.linkedinevent.md).[*from](_src_entities_linkedin_event_entity_.linkedinevent.md#_from)_ +*Inherited from [LinkedInEvent](_src_entities_linkedin_event_entity_.linkedinevent.md).[*from](_src_entities_linkedin_event_entity_.linkedinevent.md#*from)* -_Defined in [src/entities/linkedin-event.entity.ts:7](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-event.entity.ts#L7)_ +*Defined in [src/entities/linkedin-event.entity.ts:7](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-event.entity.ts#L7)* ---- +___ ### backendUrn -• **backendUrn**: string +• **backendUrn**: string -_Inherited from [LinkedInEvent](_src_entities_linkedin_event_entity_.linkedinevent.md).[backendUrn](_src_entities_linkedin_event_entity_.linkedinevent.md#backendurn)_ +*Inherited from [LinkedInEvent](_src_entities_linkedin_event_entity_.linkedinevent.md).[backendUrn](_src_entities_linkedin_event_entity_.linkedinevent.md#backendurn)* -_Defined in [src/entities/linkedin-event.entity.ts:8](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-event.entity.ts#L8)_ +*Defined in [src/entities/linkedin-event.entity.ts:8](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-event.entity.ts#L8)* ---- +___ ### createdAt -• **createdAt**: number +• **createdAt**: number -_Inherited from [LinkedInEvent](_src_entities_linkedin_event_entity_.linkedinevent.md).[createdAt](_src_entities_linkedin_event_entity_.linkedinevent.md#createdat)_ +*Inherited from [LinkedInEvent](_src_entities_linkedin_event_entity_.linkedinevent.md).[createdAt](_src_entities_linkedin_event_entity_.linkedinevent.md#createdat)* -_Defined in [src/entities/linkedin-event.entity.ts:9](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-event.entity.ts#L9)_ +*Defined in [src/entities/linkedin-event.entity.ts:9](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-event.entity.ts#L9)* ---- +___ ### dashEntityUrn -• **dashEntityUrn**: string +• **dashEntityUrn**: string -_Inherited from [LinkedInEvent](_src_entities_linkedin_event_entity_.linkedinevent.md).[dashEntityUrn](_src_entities_linkedin_event_entity_.linkedinevent.md#dashentityurn)_ +*Inherited from [LinkedInEvent](_src_entities_linkedin_event_entity_.linkedinevent.md).[dashEntityUrn](_src_entities_linkedin_event_entity_.linkedinevent.md#dashentityurn)* -_Defined in [src/entities/linkedin-event.entity.ts:10](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-event.entity.ts#L10)_ +*Defined in [src/entities/linkedin-event.entity.ts:10](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-event.entity.ts#L10)* ---- +___ ### entityUrn -• **entityUrn**: [LinkedInEventUrn](../modules/_src_entities_linkedin_event_entity_.md#linkedineventurn) +• **entityUrn**: [LinkedInEventUrn](../modules/_src_entities_linkedin_event_entity_.md#linkedineventurn) -_Inherited from [LinkedInEvent](_src_entities_linkedin_event_entity_.linkedinevent.md).[entityUrn](_src_entities_linkedin_event_entity_.linkedinevent.md#entityurn)_ +*Inherited from [LinkedInEvent](_src_entities_linkedin_event_entity_.linkedinevent.md).[entityUrn](_src_entities_linkedin_event_entity_.linkedinevent.md#entityurn)* -_Defined in [src/entities/linkedin-event.entity.ts:11](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-event.entity.ts#L11)_ +*Defined in [src/entities/linkedin-event.entity.ts:11](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-event.entity.ts#L11)* ---- +___ ### eventContent -• **eventContent**: [LinkedInMessage](_src_entities_linkedin_message_entity_.linkedinmessage.md) +• **eventContent**: [LinkedInMessage](_src_entities_linkedin_message_entity_.linkedinmessage.md) -_Inherited from [LinkedInMessageEvent](_src_entities_linkedin_message_event_entity_.linkedinmessageevent.md).[eventContent](_src_entities_linkedin_message_event_entity_.linkedinmessageevent.md#eventcontent)_ +*Inherited from [LinkedInMessageEvent](_src_entities_linkedin_message_event_entity_.linkedinmessageevent.md).[eventContent](_src_entities_linkedin_message_event_entity_.linkedinmessageevent.md#eventcontent)* -_Overrides [LinkedInEvent](_src_entities_linkedin_event_entity_.linkedinevent.md).[eventContent](_src_entities_linkedin_event_entity_.linkedinevent.md#eventcontent)_ +*Overrides [LinkedInEvent](_src_entities_linkedin_event_entity_.linkedinevent.md).[eventContent](_src_entities_linkedin_event_entity_.linkedinevent.md#eventcontent)* -_Defined in [src/entities/linkedin-message-event.entity.ts:6](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-message-event.entity.ts#L6)_ +*Defined in [src/entities/linkedin-message-event.entity.ts:6](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-message-event.entity.ts#L6)* ---- +___ ### originToken -• **originToken**: string +• **originToken**: string -_Inherited from [LinkedInEvent](_src_entities_linkedin_event_entity_.linkedinevent.md).[originToken](_src_entities_linkedin_event_entity_.linkedinevent.md#origintoken)_ +*Inherited from [LinkedInEvent](_src_entities_linkedin_event_entity_.linkedinevent.md).[originToken](_src_entities_linkedin_event_entity_.linkedinevent.md#origintoken)* -_Defined in [src/entities/linkedin-event.entity.ts:13](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-event.entity.ts#L13)_ +*Defined in [src/entities/linkedin-event.entity.ts:13](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-event.entity.ts#L13)* ---- +___ ### previousEventInConversation • `Optional` **previousEventInConversation**: undefined \| string -_Inherited from [LinkedInEvent](_src_entities_linkedin_event_entity_.linkedinevent.md).[previousEventInConversation](_src_entities_linkedin_event_entity_.linkedinevent.md#previouseventinconversation)_ +*Inherited from [LinkedInEvent](_src_entities_linkedin_event_entity_.linkedinevent.md).[previousEventInConversation](_src_entities_linkedin_event_entity_.linkedinevent.md#previouseventinconversation)* -_Defined in [src/entities/linkedin-event.entity.ts:15](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-event.entity.ts#L15)_ +*Defined in [src/entities/linkedin-event.entity.ts:15](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-event.entity.ts#L15)* ---- +___ ### quickReplyRecommendations -• **quickReplyRecommendations**: [QuickReplayRecommendation](_src_entities_linkedin_quick_replay_recommendation_entity_.quickreplayrecommendation.md)[] +• **quickReplyRecommendations**: [QuickReplayRecommendation](_src_entities_linkedin_quick_replay_recommendation_entity_.quickreplayrecommendation.md)[] -_Inherited from [LinkedInMessageEvent](_src_entities_linkedin_message_event_entity_.linkedinmessageevent.md).[quickReplyRecommendations](_src_entities_linkedin_message_event_entity_.linkedinmessageevent.md#quickreplyrecommendations)_ +*Inherited from [LinkedInMessageEvent](_src_entities_linkedin_message_event_entity_.linkedinmessageevent.md).[quickReplyRecommendations](_src_entities_linkedin_message_event_entity_.linkedinmessageevent.md#quickreplyrecommendations)* -_Defined in [src/entities/linkedin-message-event.entity.ts:7](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-message-event.entity.ts#L7)_ +*Defined in [src/entities/linkedin-message-event.entity.ts:7](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-message-event.entity.ts#L7)* ---- +___ ### sentFrom -• **sentFrom**: [MiniProfile](_src_entities_mini_profile_entity_.miniprofile.md) +• **sentFrom**: [MiniProfile](_src_entities_mini_profile_entity_.miniprofile.md) -_Defined in [src/entities/message-event.entity.ts:6](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/message-event.entity.ts#L6)_ +*Defined in [src/entities/message-event.entity.ts:6](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/message-event.entity.ts#L6)* ---- +___ ### subtype -• **subtype**: string +• **subtype**: string -_Inherited from [LinkedInEvent](_src_entities_linkedin_event_entity_.linkedinevent.md).[subtype](_src_entities_linkedin_event_entity_.linkedinevent.md#subtype)_ +*Inherited from [LinkedInEvent](_src_entities_linkedin_event_entity_.linkedinevent.md).[subtype](_src_entities_linkedin_event_entity_.linkedinevent.md#subtype)* -_Defined in [src/entities/linkedin-event.entity.ts:14](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-event.entity.ts#L14)_ +*Defined in [src/entities/linkedin-event.entity.ts:14](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-event.entity.ts#L14)* ---- +___ ### text -• **text**: string +• **text**: string -_Defined in [src/entities/message-event.entity.ts:5](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/message-event.entity.ts#L5)_ +*Defined in [src/entities/message-event.entity.ts:5](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/message-event.entity.ts#L5)* diff --git a/docs/interfaces/_src_entities_mini_company_entity_.minicompany.md b/docs/interfaces/_src_entities_mini_company_entity_.minicompany.md index 379b25c7..d4d50e35 100644 --- a/docs/interfaces/_src_entities_mini_company_entity_.minicompany.md +++ b/docs/interfaces/_src_entities_mini_company_entity_.minicompany.md @@ -6,7 +6,7 @@ ## Hierarchy -- [LinkedInMiniCompany](_src_entities_linkedin_mini_company_entity_.linkedinminicompany.md) +* [LinkedInMiniCompany](_src_entities_linkedin_mini_company_entity_.linkedinminicompany.md) ↳ **MiniCompany** @@ -14,111 +14,111 @@ ### Properties -- [$type](_src_entities_mini_company_entity_.minicompany.md#$type) -- [active](_src_entities_mini_company_entity_.minicompany.md#active) -- [companyId](_src_entities_mini_company_entity_.minicompany.md#companyid) -- [entityUrn](_src_entities_mini_company_entity_.minicompany.md#entityurn) -- [logo](_src_entities_mini_company_entity_.minicompany.md#logo) -- [name](_src_entities_mini_company_entity_.minicompany.md#name) -- [objectUrn](_src_entities_mini_company_entity_.minicompany.md#objecturn) -- [showcase](_src_entities_mini_company_entity_.minicompany.md#showcase) -- [trackingId](_src_entities_mini_company_entity_.minicompany.md#trackingid) -- [universalName](_src_entities_mini_company_entity_.minicompany.md#universalname) +* [$type](_src_entities_mini_company_entity_.minicompany.md#$type) +* [active](_src_entities_mini_company_entity_.minicompany.md#active) +* [companyId](_src_entities_mini_company_entity_.minicompany.md#companyid) +* [entityUrn](_src_entities_mini_company_entity_.minicompany.md#entityurn) +* [logo](_src_entities_mini_company_entity_.minicompany.md#logo) +* [name](_src_entities_mini_company_entity_.minicompany.md#name) +* [objectUrn](_src_entities_mini_company_entity_.minicompany.md#objecturn) +* [showcase](_src_entities_mini_company_entity_.minicompany.md#showcase) +* [trackingId](_src_entities_mini_company_entity_.minicompany.md#trackingid) +* [universalName](_src_entities_mini_company_entity_.minicompany.md#universalname) ## Properties ### $type -• **$type**: _typeof_ [MINI_COMPANY_TYPE](../modules/_src_entities_linkedin_mini_company_entity_.md#mini_company_type) +• **$type**: *typeof* [MINI\_COMPANY\_TYPE](../modules/_src_entities_linkedin_mini_company_entity_.md#mini_company_type) -_Inherited from [LinkedInMiniCompany](_src_entities_linkedin_mini_company_entity_.linkedinminicompany.md).[$type](_src_entities_linkedin_mini_company_entity_.linkedinminicompany.md#$type)_ +*Inherited from [LinkedInMiniCompany](_src_entities_linkedin_mini_company_entity_.linkedinminicompany.md).[$type](_src_entities_linkedin_mini_company_entity_.linkedinminicompany.md#$type)* -_Defined in [src/entities/linkedin-mini-company.entity.ts:6](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-mini-company.entity.ts#L6)_ +*Defined in [src/entities/linkedin-mini-company.entity.ts:6](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-mini-company.entity.ts#L6)* ---- +___ ### active -• **active**: boolean +• **active**: boolean -_Inherited from [LinkedInMiniCompany](_src_entities_linkedin_mini_company_entity_.linkedinminicompany.md).[active](_src_entities_linkedin_mini_company_entity_.linkedinminicompany.md#active)_ +*Inherited from [LinkedInMiniCompany](_src_entities_linkedin_mini_company_entity_.linkedinminicompany.md).[active](_src_entities_linkedin_mini_company_entity_.linkedinminicompany.md#active)* -_Defined in [src/entities/linkedin-mini-company.entity.ts:7](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-mini-company.entity.ts#L7)_ +*Defined in [src/entities/linkedin-mini-company.entity.ts:7](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-mini-company.entity.ts#L7)* ---- +___ ### companyId -• **companyId**: [CompanyId](../modules/_src_entities_mini_company_entity_.md#companyid) +• **companyId**: [CompanyId](../modules/_src_entities_mini_company_entity_.md#companyid) -_Defined in [src/entities/mini-company.entity.ts:6](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/mini-company.entity.ts#L6)_ +*Defined in [src/entities/mini-company.entity.ts:6](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/mini-company.entity.ts#L6)* ---- +___ ### entityUrn -• **entityUrn**: string +• **entityUrn**: string -_Inherited from [LinkedInMiniCompany](_src_entities_linkedin_mini_company_entity_.linkedinminicompany.md).[entityUrn](_src_entities_linkedin_mini_company_entity_.linkedinminicompany.md#entityurn)_ +*Inherited from [LinkedInMiniCompany](_src_entities_linkedin_mini_company_entity_.linkedinminicompany.md).[entityUrn](_src_entities_linkedin_mini_company_entity_.linkedinminicompany.md#entityurn)* -_Defined in [src/entities/linkedin-mini-company.entity.ts:8](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-mini-company.entity.ts#L8)_ +*Defined in [src/entities/linkedin-mini-company.entity.ts:8](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-mini-company.entity.ts#L8)* ---- +___ ### logo -• **logo**: [LinkedInVectorImage](_src_entities_linkedin_vector_image_entity_.linkedinvectorimage.md) +• **logo**: [LinkedInVectorImage](_src_entities_linkedin_vector_image_entity_.linkedinvectorimage.md) -_Inherited from [LinkedInMiniCompany](_src_entities_linkedin_mini_company_entity_.linkedinminicompany.md).[logo](_src_entities_linkedin_mini_company_entity_.linkedinminicompany.md#logo)_ +*Inherited from [LinkedInMiniCompany](_src_entities_linkedin_mini_company_entity_.linkedinminicompany.md).[logo](_src_entities_linkedin_mini_company_entity_.linkedinminicompany.md#logo)* -_Defined in [src/entities/linkedin-mini-company.entity.ts:9](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-mini-company.entity.ts#L9)_ +*Defined in [src/entities/linkedin-mini-company.entity.ts:9](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-mini-company.entity.ts#L9)* ---- +___ ### name -• **name**: string +• **name**: string -_Inherited from [LinkedInMiniCompany](_src_entities_linkedin_mini_company_entity_.linkedinminicompany.md).[name](_src_entities_linkedin_mini_company_entity_.linkedinminicompany.md#name)_ +*Inherited from [LinkedInMiniCompany](_src_entities_linkedin_mini_company_entity_.linkedinminicompany.md).[name](_src_entities_linkedin_mini_company_entity_.linkedinminicompany.md#name)* -_Defined in [src/entities/linkedin-mini-company.entity.ts:10](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-mini-company.entity.ts#L10)_ +*Defined in [src/entities/linkedin-mini-company.entity.ts:10](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-mini-company.entity.ts#L10)* ---- +___ ### objectUrn -• **objectUrn**: string +• **objectUrn**: string -_Inherited from [LinkedInMiniCompany](_src_entities_linkedin_mini_company_entity_.linkedinminicompany.md).[objectUrn](_src_entities_linkedin_mini_company_entity_.linkedinminicompany.md#objecturn)_ +*Inherited from [LinkedInMiniCompany](_src_entities_linkedin_mini_company_entity_.linkedinminicompany.md).[objectUrn](_src_entities_linkedin_mini_company_entity_.linkedinminicompany.md#objecturn)* -_Defined in [src/entities/linkedin-mini-company.entity.ts:11](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-mini-company.entity.ts#L11)_ +*Defined in [src/entities/linkedin-mini-company.entity.ts:11](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-mini-company.entity.ts#L11)* ---- +___ ### showcase -• **showcase**: boolean +• **showcase**: boolean -_Inherited from [LinkedInMiniCompany](_src_entities_linkedin_mini_company_entity_.linkedinminicompany.md).[showcase](_src_entities_linkedin_mini_company_entity_.linkedinminicompany.md#showcase)_ +*Inherited from [LinkedInMiniCompany](_src_entities_linkedin_mini_company_entity_.linkedinminicompany.md).[showcase](_src_entities_linkedin_mini_company_entity_.linkedinminicompany.md#showcase)* -_Defined in [src/entities/linkedin-mini-company.entity.ts:12](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-mini-company.entity.ts#L12)_ +*Defined in [src/entities/linkedin-mini-company.entity.ts:12](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-mini-company.entity.ts#L12)* ---- +___ ### trackingId -• **trackingId**: string +• **trackingId**: string -_Inherited from [LinkedInMiniCompany](_src_entities_linkedin_mini_company_entity_.linkedinminicompany.md).[trackingId](_src_entities_linkedin_mini_company_entity_.linkedinminicompany.md#trackingid)_ +*Inherited from [LinkedInMiniCompany](_src_entities_linkedin_mini_company_entity_.linkedinminicompany.md).[trackingId](_src_entities_linkedin_mini_company_entity_.linkedinminicompany.md#trackingid)* -_Defined in [src/entities/linkedin-mini-company.entity.ts:13](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-mini-company.entity.ts#L13)_ +*Defined in [src/entities/linkedin-mini-company.entity.ts:13](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-mini-company.entity.ts#L13)* ---- +___ ### universalName -• **universalName**: string +• **universalName**: string -_Inherited from [LinkedInMiniCompany](_src_entities_linkedin_mini_company_entity_.linkedinminicompany.md).[universalName](_src_entities_linkedin_mini_company_entity_.linkedinminicompany.md#universalname)_ +*Inherited from [LinkedInMiniCompany](_src_entities_linkedin_mini_company_entity_.linkedinminicompany.md).[universalName](_src_entities_linkedin_mini_company_entity_.linkedinminicompany.md#universalname)* -_Defined in [src/entities/linkedin-mini-company.entity.ts:14](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-mini-company.entity.ts#L14)_ +*Defined in [src/entities/linkedin-mini-company.entity.ts:14](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-mini-company.entity.ts#L14)* diff --git a/docs/interfaces/_src_entities_mini_profile_entity_.miniprofile.md b/docs/interfaces/_src_entities_mini_profile_entity_.miniprofile.md index 2540628c..f5b9b0c6 100644 --- a/docs/interfaces/_src_entities_mini_profile_entity_.miniprofile.md +++ b/docs/interfaces/_src_entities_mini_profile_entity_.miniprofile.md @@ -6,7 +6,7 @@ ## Hierarchy -- [LinkedInMiniProfile](_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md) +* [LinkedInMiniProfile](_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md) ↳ **MiniProfile** @@ -14,142 +14,142 @@ ### Properties -- [$type](_src_entities_mini_profile_entity_.miniprofile.md#$type) -- [backgroundImage](_src_entities_mini_profile_entity_.miniprofile.md#backgroundimage) -- [entityUrn](_src_entities_mini_profile_entity_.miniprofile.md#entityurn) -- [firstName](_src_entities_mini_profile_entity_.miniprofile.md#firstname) -- [lastName](_src_entities_mini_profile_entity_.miniprofile.md#lastname) -- [memorailzed](_src_entities_mini_profile_entity_.miniprofile.md#memorailzed) -- [objectUrn](_src_entities_mini_profile_entity_.miniprofile.md#objecturn) -- [occupation](_src_entities_mini_profile_entity_.miniprofile.md#occupation) -- [picture](_src_entities_mini_profile_entity_.miniprofile.md#picture) -- [pictureUrls](_src_entities_mini_profile_entity_.miniprofile.md#pictureurls) -- [profileId](_src_entities_mini_profile_entity_.miniprofile.md#profileid) -- [publicIdentifier](_src_entities_mini_profile_entity_.miniprofile.md#publicidentifier) -- [trackingId](_src_entities_mini_profile_entity_.miniprofile.md#trackingid) +* [$type](_src_entities_mini_profile_entity_.miniprofile.md#$type) +* [backgroundImage](_src_entities_mini_profile_entity_.miniprofile.md#backgroundimage) +* [entityUrn](_src_entities_mini_profile_entity_.miniprofile.md#entityurn) +* [firstName](_src_entities_mini_profile_entity_.miniprofile.md#firstname) +* [lastName](_src_entities_mini_profile_entity_.miniprofile.md#lastname) +* [memorailzed](_src_entities_mini_profile_entity_.miniprofile.md#memorailzed) +* [objectUrn](_src_entities_mini_profile_entity_.miniprofile.md#objecturn) +* [occupation](_src_entities_mini_profile_entity_.miniprofile.md#occupation) +* [picture](_src_entities_mini_profile_entity_.miniprofile.md#picture) +* [pictureUrls](_src_entities_mini_profile_entity_.miniprofile.md#pictureurls) +* [profileId](_src_entities_mini_profile_entity_.miniprofile.md#profileid) +* [publicIdentifier](_src_entities_mini_profile_entity_.miniprofile.md#publicidentifier) +* [trackingId](_src_entities_mini_profile_entity_.miniprofile.md#trackingid) ## Properties ### $type -• **$type**: _typeof_ [MINI_PROFILE_TYPE](../modules/_src_entities_linkedin_mini_profile_entity_.md#mini_profile_type) +• **$type**: *typeof* [MINI\_PROFILE\_TYPE](../modules/_src_entities_linkedin_mini_profile_entity_.md#mini_profile_type) -_Inherited from [LinkedInMiniProfile](_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md).[$type](_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md#$type)_ +*Inherited from [LinkedInMiniProfile](_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md).[$type](_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md#$type)* -_Defined in [src/entities/linkedin-mini-profile.entity.ts:8](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-mini-profile.entity.ts#L8)_ +*Defined in [src/entities/linkedin-mini-profile.entity.ts:8](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-mini-profile.entity.ts#L8)* ---- +___ ### backgroundImage -• **backgroundImage**: [LinkedInVectorImage](_src_entities_linkedin_vector_image_entity_.linkedinvectorimage.md) +• **backgroundImage**: [LinkedInVectorImage](_src_entities_linkedin_vector_image_entity_.linkedinvectorimage.md) -_Inherited from [LinkedInMiniProfile](_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md).[backgroundImage](_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md#backgroundimage)_ +*Inherited from [LinkedInMiniProfile](_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md).[backgroundImage](_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md#backgroundimage)* -_Defined in [src/entities/linkedin-mini-profile.entity.ts:9](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-mini-profile.entity.ts#L9)_ +*Defined in [src/entities/linkedin-mini-profile.entity.ts:9](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-mini-profile.entity.ts#L9)* ---- +___ ### entityUrn -• **entityUrn**: [MiniProfileUrn](../modules/_src_entities_linkedin_mini_profile_entity_.md#miniprofileurn) +• **entityUrn**: [MiniProfileUrn](../modules/_src_entities_linkedin_mini_profile_entity_.md#miniprofileurn) -_Inherited from [LinkedInMiniProfile](_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md).[entityUrn](_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md#entityurn)_ +*Inherited from [LinkedInMiniProfile](_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md).[entityUrn](_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md#entityurn)* -_Defined in [src/entities/linkedin-mini-profile.entity.ts:10](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-mini-profile.entity.ts#L10)_ +*Defined in [src/entities/linkedin-mini-profile.entity.ts:10](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-mini-profile.entity.ts#L10)* ---- +___ ### firstName -• **firstName**: string +• **firstName**: string -_Inherited from [LinkedInMiniProfile](_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md).[firstName](_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md#firstname)_ +*Inherited from [LinkedInMiniProfile](_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md).[firstName](_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md#firstname)* -_Defined in [src/entities/linkedin-mini-profile.entity.ts:11](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-mini-profile.entity.ts#L11)_ +*Defined in [src/entities/linkedin-mini-profile.entity.ts:11](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-mini-profile.entity.ts#L11)* ---- +___ ### lastName -• **lastName**: string +• **lastName**: string -_Inherited from [LinkedInMiniProfile](_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md).[lastName](_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md#lastname)_ +*Inherited from [LinkedInMiniProfile](_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md).[lastName](_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md#lastname)* -_Defined in [src/entities/linkedin-mini-profile.entity.ts:12](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-mini-profile.entity.ts#L12)_ +*Defined in [src/entities/linkedin-mini-profile.entity.ts:12](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-mini-profile.entity.ts#L12)* ---- +___ ### memorailzed • `Optional` **memorailzed**: undefined \| false \| true -_Inherited from [LinkedInMiniProfile](_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md).[memorailzed](_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md#memorailzed)_ +*Inherited from [LinkedInMiniProfile](_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md).[memorailzed](_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md#memorailzed)* -_Defined in [src/entities/linkedin-mini-profile.entity.ts:13](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-mini-profile.entity.ts#L13)_ +*Defined in [src/entities/linkedin-mini-profile.entity.ts:13](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-mini-profile.entity.ts#L13)* ---- +___ ### objectUrn -• **objectUrn**: string +• **objectUrn**: string -_Inherited from [LinkedInMiniProfile](_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md).[objectUrn](_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md#objecturn)_ +*Inherited from [LinkedInMiniProfile](_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md).[objectUrn](_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md#objecturn)* -_Defined in [src/entities/linkedin-mini-profile.entity.ts:14](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-mini-profile.entity.ts#L14)_ +*Defined in [src/entities/linkedin-mini-profile.entity.ts:14](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-mini-profile.entity.ts#L14)* ---- +___ ### occupation -• **occupation**: string +• **occupation**: string -_Inherited from [LinkedInMiniProfile](_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md).[occupation](_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md#occupation)_ +*Inherited from [LinkedInMiniProfile](_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md).[occupation](_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md#occupation)* -_Defined in [src/entities/linkedin-mini-profile.entity.ts:15](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-mini-profile.entity.ts#L15)_ +*Defined in [src/entities/linkedin-mini-profile.entity.ts:15](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-mini-profile.entity.ts#L15)* ---- +___ ### picture • `Optional` **picture**: [LinkedInVectorImage](_src_entities_linkedin_vector_image_entity_.linkedinvectorimage.md) -_Inherited from [LinkedInMiniProfile](_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md).[picture](_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md#picture)_ +*Inherited from [LinkedInMiniProfile](_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md).[picture](_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md#picture)* -_Defined in [src/entities/linkedin-mini-profile.entity.ts:16](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-mini-profile.entity.ts#L16)_ +*Defined in [src/entities/linkedin-mini-profile.entity.ts:16](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-mini-profile.entity.ts#L16)* ---- +___ ### pictureUrls -• **pictureUrls**: string[] +• **pictureUrls**: string[] -_Defined in [src/entities/mini-profile.entity.ts:7](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/mini-profile.entity.ts#L7)_ +*Defined in [src/entities/mini-profile.entity.ts:7](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/mini-profile.entity.ts#L7)* ---- +___ ### profileId -• **profileId**: [ProfileId](../modules/_src_entities_mini_profile_entity_.md#profileid) +• **profileId**: [ProfileId](../modules/_src_entities_mini_profile_entity_.md#profileid) -_Defined in [src/entities/mini-profile.entity.ts:6](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/mini-profile.entity.ts#L6)_ +*Defined in [src/entities/mini-profile.entity.ts:6](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/mini-profile.entity.ts#L6)* ---- +___ ### publicIdentifier -• **publicIdentifier**: string +• **publicIdentifier**: string -_Inherited from [LinkedInMiniProfile](_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md).[publicIdentifier](_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md#publicidentifier)_ +*Inherited from [LinkedInMiniProfile](_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md).[publicIdentifier](_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md#publicidentifier)* -_Defined in [src/entities/linkedin-mini-profile.entity.ts:17](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-mini-profile.entity.ts#L17)_ +*Defined in [src/entities/linkedin-mini-profile.entity.ts:17](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-mini-profile.entity.ts#L17)* ---- +___ ### trackingId -• **trackingId**: string +• **trackingId**: string -_Inherited from [LinkedInMiniProfile](_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md).[trackingId](_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md#trackingid)_ +*Inherited from [LinkedInMiniProfile](_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md).[trackingId](_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md#trackingid)* -_Defined in [src/entities/linkedin-mini-profile.entity.ts:18](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-mini-profile.entity.ts#L18)_ +*Defined in [src/entities/linkedin-mini-profile.entity.ts:18](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-mini-profile.entity.ts#L18)* diff --git a/docs/interfaces/_src_entities_people_search_hit_entity_.peoplesearchhit.md b/docs/interfaces/_src_entities_people_search_hit_entity_.peoplesearchhit.md index 510f2be8..0d4f64a2 100644 --- a/docs/interfaces/_src_entities_people_search_hit_entity_.peoplesearchhit.md +++ b/docs/interfaces/_src_entities_people_search_hit_entity_.peoplesearchhit.md @@ -6,7 +6,7 @@ ## Hierarchy -- [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md) +* [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md) ↳ **PeopleSearchHit** @@ -14,206 +14,206 @@ ### Properties -- [$type](_src_entities_people_search_hit_entity_.peoplesearchhit.md#$type) -- [\*badges](_src_entities_people_search_hit_entity_.peoplesearchhit.md#*badges) -- [headless](_src_entities_people_search_hit_entity_.peoplesearchhit.md#headless) -- [headline](_src_entities_people_search_hit_entity_.peoplesearchhit.md#headline) -- [image](_src_entities_people_search_hit_entity_.peoplesearchhit.md#image) -- [memberDistance](_src_entities_people_search_hit_entity_.peoplesearchhit.md#memberdistance) -- [nameMatch](_src_entities_people_search_hit_entity_.peoplesearchhit.md#namematch) -- [navigationUrl](_src_entities_people_search_hit_entity_.peoplesearchhit.md#navigationurl) -- [profile](_src_entities_people_search_hit_entity_.peoplesearchhit.md#profile) -- [publicIdentifier](_src_entities_people_search_hit_entity_.peoplesearchhit.md#publicidentifier) -- [secondaryTitle](_src_entities_people_search_hit_entity_.peoplesearchhit.md#secondarytitle) -- [socialProofText](_src_entities_people_search_hit_entity_.peoplesearchhit.md#socialprooftext) -- [subline](_src_entities_people_search_hit_entity_.peoplesearchhit.md#subline) -- [targetUrn](_src_entities_people_search_hit_entity_.peoplesearchhit.md#targeturn) -- [title](_src_entities_people_search_hit_entity_.peoplesearchhit.md#title) -- [trackingId](_src_entities_people_search_hit_entity_.peoplesearchhit.md#trackingid) -- [trackingUrn](_src_entities_people_search_hit_entity_.peoplesearchhit.md#trackingurn) -- [type](_src_entities_people_search_hit_entity_.peoplesearchhit.md#type) +* [$type](_src_entities_people_search_hit_entity_.peoplesearchhit.md#$type) +* [*badges](_src_entities_people_search_hit_entity_.peoplesearchhit.md#*badges) +* [headless](_src_entities_people_search_hit_entity_.peoplesearchhit.md#headless) +* [headline](_src_entities_people_search_hit_entity_.peoplesearchhit.md#headline) +* [image](_src_entities_people_search_hit_entity_.peoplesearchhit.md#image) +* [memberDistance](_src_entities_people_search_hit_entity_.peoplesearchhit.md#memberdistance) +* [nameMatch](_src_entities_people_search_hit_entity_.peoplesearchhit.md#namematch) +* [navigationUrl](_src_entities_people_search_hit_entity_.peoplesearchhit.md#navigationurl) +* [profile](_src_entities_people_search_hit_entity_.peoplesearchhit.md#profile) +* [publicIdentifier](_src_entities_people_search_hit_entity_.peoplesearchhit.md#publicidentifier) +* [secondaryTitle](_src_entities_people_search_hit_entity_.peoplesearchhit.md#secondarytitle) +* [socialProofText](_src_entities_people_search_hit_entity_.peoplesearchhit.md#socialprooftext) +* [subline](_src_entities_people_search_hit_entity_.peoplesearchhit.md#subline) +* [targetUrn](_src_entities_people_search_hit_entity_.peoplesearchhit.md#targeturn) +* [title](_src_entities_people_search_hit_entity_.peoplesearchhit.md#title) +* [trackingId](_src_entities_people_search_hit_entity_.peoplesearchhit.md#trackingid) +* [trackingUrn](_src_entities_people_search_hit_entity_.peoplesearchhit.md#trackingurn) +* [type](_src_entities_people_search_hit_entity_.peoplesearchhit.md#type) ## Properties ### $type -• **$type**: \"com.linkedin.voyager.search.SearchHitV2\" +• **$type**: \"com.linkedin.voyager.search.SearchHitV2\" -_Inherited from [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md).[$type](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#$type)_ +*Inherited from [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md).[$type](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#$type)* -_Defined in [src/entities/linkedin-search-hit-v2.entity.ts:5](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-search-hit-v2.entity.ts#L5)_ +*Defined in [src/entities/linkedin-search-hit-v2.entity.ts:5](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-search-hit-v2.entity.ts#L5)* ---- +___ -### \*badges +### *badges -• **\*badges**: string +• ***badges**: string -*Inherited from [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md).[*badges](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#_badges)_ +*Inherited from [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md).[*badges](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#*badges)* -_Defined in [src/entities/linkedin-search-hit-v2.entity.ts:6](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-search-hit-v2.entity.ts#L6)_ +*Defined in [src/entities/linkedin-search-hit-v2.entity.ts:6](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-search-hit-v2.entity.ts#L6)* ---- +___ ### headless -• **headless**: string +• **headless**: string -_Inherited from [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md).[headless](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#headless)_ +*Inherited from [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md).[headless](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#headless)* -_Defined in [src/entities/linkedin-search-hit-v2.entity.ts:7](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-search-hit-v2.entity.ts#L7)_ +*Defined in [src/entities/linkedin-search-hit-v2.entity.ts:7](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-search-hit-v2.entity.ts#L7)* ---- +___ ### headline -• **headline**: [LinkedInTextViewModel](_src_entities_linkedin_text_view_model_entity_.linkedintextviewmodel.md) +• **headline**: [LinkedInTextViewModel](_src_entities_linkedin_text_view_model_entity_.linkedintextviewmodel.md) -_Inherited from [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md).[headline](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#headline)_ +*Inherited from [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md).[headline](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#headline)* -_Defined in [src/entities/linkedin-search-hit-v2.entity.ts:8](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-search-hit-v2.entity.ts#L8)_ +*Defined in [src/entities/linkedin-search-hit-v2.entity.ts:8](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-search-hit-v2.entity.ts#L8)* ---- +___ ### image -• **image**: [LinkedInImageViewModel](_src_entities_linkedin_image_view_model_entity_.linkedinimageviewmodel.md) +• **image**: [LinkedInImageViewModel](_src_entities_linkedin_image_view_model_entity_.linkedinimageviewmodel.md) -_Inherited from [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md).[image](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#image)_ +*Inherited from [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md).[image](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#image)* -_Defined in [src/entities/linkedin-search-hit-v2.entity.ts:9](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-search-hit-v2.entity.ts#L9)_ +*Defined in [src/entities/linkedin-search-hit-v2.entity.ts:9](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-search-hit-v2.entity.ts#L9)* ---- +___ ### memberDistance -• **memberDistance**: { $type: \"com.linkedin.voyager.common.MemberDistance\" ; value: string } +• **memberDistance**: { $type: \"com.linkedin.voyager.common.MemberDistance\" ; value: string } -_Inherited from [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md).[memberDistance](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#memberdistance)_ +*Inherited from [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md).[memberDistance](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#memberdistance)* -_Defined in [src/entities/linkedin-search-hit-v2.entity.ts:10](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-search-hit-v2.entity.ts#L10)_ +*Defined in [src/entities/linkedin-search-hit-v2.entity.ts:10](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-search-hit-v2.entity.ts#L10)* #### Type declaration: -| Name | Type | -| ------- | ---------------------------------------------- | -| `$type` | \"com.linkedin.voyager.common.MemberDistance\" | -| `value` | string | +Name | Type | +------ | ------ | +`$type` | \"com.linkedin.voyager.common.MemberDistance\" | +`value` | string | ---- +___ ### nameMatch -• **nameMatch**: boolean +• **nameMatch**: boolean -_Inherited from [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md).[nameMatch](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#namematch)_ +*Inherited from [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md).[nameMatch](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#namematch)* -_Defined in [src/entities/linkedin-search-hit-v2.entity.ts:14](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-search-hit-v2.entity.ts#L14)_ +*Defined in [src/entities/linkedin-search-hit-v2.entity.ts:14](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-search-hit-v2.entity.ts#L14)* ---- +___ ### navigationUrl -• **navigationUrl**: string +• **navigationUrl**: string -_Inherited from [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md).[navigationUrl](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#navigationurl)_ +*Inherited from [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md).[navigationUrl](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#navigationurl)* -_Defined in [src/entities/linkedin-search-hit-v2.entity.ts:15](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-search-hit-v2.entity.ts#L15)_ +*Defined in [src/entities/linkedin-search-hit-v2.entity.ts:15](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-search-hit-v2.entity.ts#L15)* ---- +___ ### profile -• **profile**: [MiniProfile](_src_entities_mini_profile_entity_.miniprofile.md) +• **profile**: [MiniProfile](_src_entities_mini_profile_entity_.miniprofile.md) -_Defined in [src/entities/people-search-hit.entity.ts:5](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/people-search-hit.entity.ts#L5)_ +*Defined in [src/entities/people-search-hit.entity.ts:5](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/people-search-hit.entity.ts#L5)* ---- +___ ### publicIdentifier -• **publicIdentifier**: string +• **publicIdentifier**: string -_Inherited from [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md).[publicIdentifier](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#publicidentifier)_ +*Inherited from [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md).[publicIdentifier](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#publicidentifier)* -_Defined in [src/entities/linkedin-search-hit-v2.entity.ts:16](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-search-hit-v2.entity.ts#L16)_ +*Defined in [src/entities/linkedin-search-hit-v2.entity.ts:16](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-search-hit-v2.entity.ts#L16)* ---- +___ ### secondaryTitle -• **secondaryTitle**: [LinkedInTextViewModel](_src_entities_linkedin_text_view_model_entity_.linkedintextviewmodel.md) +• **secondaryTitle**: [LinkedInTextViewModel](_src_entities_linkedin_text_view_model_entity_.linkedintextviewmodel.md) -_Inherited from [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md).[secondaryTitle](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#secondarytitle)_ +*Inherited from [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md).[secondaryTitle](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#secondarytitle)* -_Defined in [src/entities/linkedin-search-hit-v2.entity.ts:17](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-search-hit-v2.entity.ts#L17)_ +*Defined in [src/entities/linkedin-search-hit-v2.entity.ts:17](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-search-hit-v2.entity.ts#L17)* ---- +___ ### socialProofText -• **socialProofText**: string +• **socialProofText**: string -_Inherited from [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md).[socialProofText](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#socialprooftext)_ +*Inherited from [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md).[socialProofText](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#socialprooftext)* -_Defined in [src/entities/linkedin-search-hit-v2.entity.ts:18](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-search-hit-v2.entity.ts#L18)_ +*Defined in [src/entities/linkedin-search-hit-v2.entity.ts:18](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-search-hit-v2.entity.ts#L18)* ---- +___ ### subline -• **subline**: [LinkedInTextViewModel](_src_entities_linkedin_text_view_model_entity_.linkedintextviewmodel.md) +• **subline**: [LinkedInTextViewModel](_src_entities_linkedin_text_view_model_entity_.linkedintextviewmodel.md) -_Inherited from [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md).[subline](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#subline)_ +*Inherited from [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md).[subline](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#subline)* -_Defined in [src/entities/linkedin-search-hit-v2.entity.ts:19](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-search-hit-v2.entity.ts#L19)_ +*Defined in [src/entities/linkedin-search-hit-v2.entity.ts:19](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-search-hit-v2.entity.ts#L19)* ---- +___ ### targetUrn -• **targetUrn**: string +• **targetUrn**: string -_Inherited from [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md).[targetUrn](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#targeturn)_ +*Inherited from [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md).[targetUrn](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#targeturn)* -_Defined in [src/entities/linkedin-search-hit-v2.entity.ts:20](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-search-hit-v2.entity.ts#L20)_ +*Defined in [src/entities/linkedin-search-hit-v2.entity.ts:20](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-search-hit-v2.entity.ts#L20)* ---- +___ ### title -• **title**: [LinkedInTextViewModel](_src_entities_linkedin_text_view_model_entity_.linkedintextviewmodel.md) +• **title**: [LinkedInTextViewModel](_src_entities_linkedin_text_view_model_entity_.linkedintextviewmodel.md) -_Inherited from [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md).[title](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#title)_ +*Inherited from [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md).[title](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#title)* -_Defined in [src/entities/linkedin-search-hit-v2.entity.ts:21](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-search-hit-v2.entity.ts#L21)_ +*Defined in [src/entities/linkedin-search-hit-v2.entity.ts:21](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-search-hit-v2.entity.ts#L21)* ---- +___ ### trackingId -• **trackingId**: string +• **trackingId**: string -_Inherited from [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md).[trackingId](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#trackingid)_ +*Inherited from [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md).[trackingId](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#trackingid)* -_Defined in [src/entities/linkedin-search-hit-v2.entity.ts:22](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-search-hit-v2.entity.ts#L22)_ +*Defined in [src/entities/linkedin-search-hit-v2.entity.ts:22](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-search-hit-v2.entity.ts#L22)* ---- +___ ### trackingUrn -• **trackingUrn**: string +• **trackingUrn**: string -_Inherited from [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md).[trackingUrn](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#trackingurn)_ +*Inherited from [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md).[trackingUrn](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#trackingurn)* -_Defined in [src/entities/linkedin-search-hit-v2.entity.ts:23](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-search-hit-v2.entity.ts#L23)_ +*Defined in [src/entities/linkedin-search-hit-v2.entity.ts:23](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-search-hit-v2.entity.ts#L23)* ---- +___ ### type -• **type**: string +• **type**: string -_Inherited from [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md).[type](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#type)_ +*Inherited from [LinkedInSearchHitV2](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md).[type](_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md#type)* -_Defined in [src/entities/linkedin-search-hit-v2.entity.ts:24](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-search-hit-v2.entity.ts#L24)_ +*Defined in [src/entities/linkedin-search-hit-v2.entity.ts:24](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-search-hit-v2.entity.ts#L24)* diff --git a/docs/interfaces/_src_entities_profile_entity_.profile.md b/docs/interfaces/_src_entities_profile_entity_.profile.md index 060ccff1..69ae8775 100644 --- a/docs/interfaces/_src_entities_profile_entity_.profile.md +++ b/docs/interfaces/_src_entities_profile_entity_.profile.md @@ -6,7 +6,7 @@ ## Hierarchy -- [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md) +* [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md) ↳ **Profile** @@ -14,439 +14,439 @@ ### Properties -- [$recipeTypes](_src_entities_profile_entity_.profile.md#$recipetypes) -- [$type](_src_entities_profile_entity_.profile.md#$type) -- [\*industry](_src_entities_profile_entity_.profile.md#*industry) -- [\*profileCertifications](_src_entities_profile_entity_.profile.md#*profilecertifications) -- [\*profileCourses](_src_entities_profile_entity_.profile.md#*profilecourses) -- [\*profileEducations](_src_entities_profile_entity_.profile.md#*profileeducations) -- [\*profileHonors](_src_entities_profile_entity_.profile.md#*profilehonors) -- [\*profileLanguages](_src_entities_profile_entity_.profile.md#*profilelanguages) -- [\*profileOrganizations](_src_entities_profile_entity_.profile.md#*profileorganizations) -- [\*profilePatents](_src_entities_profile_entity_.profile.md#*profilepatents) -- [\*profilePositionGroups](_src_entities_profile_entity_.profile.md#*profilepositiongroups) -- [\*profileProjects](_src_entities_profile_entity_.profile.md#*profileprojects) -- [\*profilePublications](_src_entities_profile_entity_.profile.md#*profilepublications) -- [\*profileSkills](_src_entities_profile_entity_.profile.md#*profileskills) -- [\*profileTestScores](_src_entities_profile_entity_.profile.md#*profiletestscores) -- [\*profileTreasuryMediaProfile](_src_entities_profile_entity_.profile.md#*profiletreasurymediaprofile) -- [\*profileVolunteerExperiences](_src_entities_profile_entity_.profile.md#*profilevolunteerexperiences) -- [company](_src_entities_profile_entity_.profile.md#company) -- [defaultToActivityTab](_src_entities_profile_entity_.profile.md#defaulttoactivitytab) -- [educationOnProfileTopCardShown](_src_entities_profile_entity_.profile.md#educationonprofiletopcardshown) -- [entityUrn](_src_entities_profile_entity_.profile.md#entityurn) -- [firstName](_src_entities_profile_entity_.profile.md#firstname) -- [geoLocation](_src_entities_profile_entity_.profile.md#geolocation) -- [geoLocationBackfilled](_src_entities_profile_entity_.profile.md#geolocationbackfilled) -- [headline](_src_entities_profile_entity_.profile.md#headline) -- [industryUrn](_src_entities_profile_entity_.profile.md#industryurn) -- [lastName](_src_entities_profile_entity_.profile.md#lastname) -- [location](_src_entities_profile_entity_.profile.md#location) -- [locationName](_src_entities_profile_entity_.profile.md#locationname) -- [multiLocaleFirstName](_src_entities_profile_entity_.profile.md#multilocalefirstname) -- [multiLocaleHeadline](_src_entities_profile_entity_.profile.md#multilocaleheadline) -- [multiLocaleLastName](_src_entities_profile_entity_.profile.md#multilocalelastname) -- [objectUrn](_src_entities_profile_entity_.profile.md#objecturn) -- [pictureUrls](_src_entities_profile_entity_.profile.md#pictureurls) -- [primaryLocale](_src_entities_profile_entity_.profile.md#primarylocale) -- [profilePicture](_src_entities_profile_entity_.profile.md#profilepicture) -- [publicIdentifier](_src_entities_profile_entity_.profile.md#publicidentifier) -- [supportedLocales](_src_entities_profile_entity_.profile.md#supportedlocales) -- [trackingId](_src_entities_profile_entity_.profile.md#trackingid) -- [versionTag](_src_entities_profile_entity_.profile.md#versiontag) +* [$recipeTypes](_src_entities_profile_entity_.profile.md#$recipetypes) +* [$type](_src_entities_profile_entity_.profile.md#$type) +* [*industry](_src_entities_profile_entity_.profile.md#*industry) +* [*profileCertifications](_src_entities_profile_entity_.profile.md#*profilecertifications) +* [*profileCourses](_src_entities_profile_entity_.profile.md#*profilecourses) +* [*profileEducations](_src_entities_profile_entity_.profile.md#*profileeducations) +* [*profileHonors](_src_entities_profile_entity_.profile.md#*profilehonors) +* [*profileLanguages](_src_entities_profile_entity_.profile.md#*profilelanguages) +* [*profileOrganizations](_src_entities_profile_entity_.profile.md#*profileorganizations) +* [*profilePatents](_src_entities_profile_entity_.profile.md#*profilepatents) +* [*profilePositionGroups](_src_entities_profile_entity_.profile.md#*profilepositiongroups) +* [*profileProjects](_src_entities_profile_entity_.profile.md#*profileprojects) +* [*profilePublications](_src_entities_profile_entity_.profile.md#*profilepublications) +* [*profileSkills](_src_entities_profile_entity_.profile.md#*profileskills) +* [*profileTestScores](_src_entities_profile_entity_.profile.md#*profiletestscores) +* [*profileTreasuryMediaProfile](_src_entities_profile_entity_.profile.md#*profiletreasurymediaprofile) +* [*profileVolunteerExperiences](_src_entities_profile_entity_.profile.md#*profilevolunteerexperiences) +* [company](_src_entities_profile_entity_.profile.md#company) +* [defaultToActivityTab](_src_entities_profile_entity_.profile.md#defaulttoactivitytab) +* [educationOnProfileTopCardShown](_src_entities_profile_entity_.profile.md#educationonprofiletopcardshown) +* [entityUrn](_src_entities_profile_entity_.profile.md#entityurn) +* [firstName](_src_entities_profile_entity_.profile.md#firstname) +* [geoLocation](_src_entities_profile_entity_.profile.md#geolocation) +* [geoLocationBackfilled](_src_entities_profile_entity_.profile.md#geolocationbackfilled) +* [headline](_src_entities_profile_entity_.profile.md#headline) +* [industryUrn](_src_entities_profile_entity_.profile.md#industryurn) +* [lastName](_src_entities_profile_entity_.profile.md#lastname) +* [location](_src_entities_profile_entity_.profile.md#location) +* [locationName](_src_entities_profile_entity_.profile.md#locationname) +* [multiLocaleFirstName](_src_entities_profile_entity_.profile.md#multilocalefirstname) +* [multiLocaleHeadline](_src_entities_profile_entity_.profile.md#multilocaleheadline) +* [multiLocaleLastName](_src_entities_profile_entity_.profile.md#multilocalelastname) +* [objectUrn](_src_entities_profile_entity_.profile.md#objecturn) +* [pictureUrls](_src_entities_profile_entity_.profile.md#pictureurls) +* [primaryLocale](_src_entities_profile_entity_.profile.md#primarylocale) +* [profilePicture](_src_entities_profile_entity_.profile.md#profilepicture) +* [publicIdentifier](_src_entities_profile_entity_.profile.md#publicidentifier) +* [supportedLocales](_src_entities_profile_entity_.profile.md#supportedlocales) +* [trackingId](_src_entities_profile_entity_.profile.md#trackingid) +* [versionTag](_src_entities_profile_entity_.profile.md#versiontag) ## Properties ### $recipeTypes -• **$recipeTypes**: string[] +• **$recipeTypes**: string[] -_Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[$recipeTypes](_src_entities_linkedin_profile_entity_.linkedinprofile.md#$recipetypes)_ +*Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[$recipeTypes](_src_entities_linkedin_profile_entity_.linkedinprofile.md#$recipetypes)* -_Defined in [src/entities/linkedin-profile.entity.ts:57](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L57)_ +*Defined in [src/entities/linkedin-profile.entity.ts:57](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L57)* ---- +___ ### $type -• **$type**: _typeof_ [PROFILE_TYPE](../modules/_src_entities_linkedin_profile_entity_.md#profile_type) +• **$type**: *typeof* [PROFILE\_TYPE](../modules/_src_entities_linkedin_profile_entity_.md#profile_type) -_Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[$type](_src_entities_linkedin_profile_entity_.linkedinprofile.md#$type)_ +*Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[$type](_src_entities_linkedin_profile_entity_.linkedinprofile.md#$type)* -_Defined in [src/entities/linkedin-profile.entity.ts:41](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L41)_ +*Defined in [src/entities/linkedin-profile.entity.ts:41](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L41)* ---- +___ -### \*industry +### *industry -• **\*industry**: string +• ***industry**: string -*Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[*industry](_src_entities_linkedin_profile_entity_.linkedinprofile.md#_industry)_ +*Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[*industry](_src_entities_linkedin_profile_entity_.linkedinprofile.md#*industry)* -_Defined in [src/entities/linkedin-profile.entity.ts:42](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L42)_ +*Defined in [src/entities/linkedin-profile.entity.ts:42](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L42)* ---- +___ -### \*profileCertifications +### *profileCertifications -• **\*profileCertifications**: string +• ***profileCertifications**: string -*Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[*profileCertifications](_src_entities_linkedin_profile_entity_.linkedinprofile.md#_profilecertifications)_ +*Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[*profileCertifications](_src_entities_linkedin_profile_entity_.linkedinprofile.md#*profilecertifications)* -_Defined in [src/entities/linkedin-profile.entity.ts:43](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L43)_ +*Defined in [src/entities/linkedin-profile.entity.ts:43](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L43)* ---- +___ -### \*profileCourses +### *profileCourses -• **\*profileCourses**: string +• ***profileCourses**: string -*Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[*profileCourses](_src_entities_linkedin_profile_entity_.linkedinprofile.md#_profilecourses)_ +*Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[*profileCourses](_src_entities_linkedin_profile_entity_.linkedinprofile.md#*profilecourses)* -_Defined in [src/entities/linkedin-profile.entity.ts:44](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L44)_ +*Defined in [src/entities/linkedin-profile.entity.ts:44](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L44)* ---- +___ -### \*profileEducations +### *profileEducations -• **\*profileEducations**: string +• ***profileEducations**: string -*Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[*profileEducations](_src_entities_linkedin_profile_entity_.linkedinprofile.md#_profileeducations)_ +*Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[*profileEducations](_src_entities_linkedin_profile_entity_.linkedinprofile.md#*profileeducations)* -_Defined in [src/entities/linkedin-profile.entity.ts:45](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L45)_ +*Defined in [src/entities/linkedin-profile.entity.ts:45](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L45)* ---- +___ -### \*profileHonors +### *profileHonors -• **\*profileHonors**: string +• ***profileHonors**: string -*Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[*profileHonors](_src_entities_linkedin_profile_entity_.linkedinprofile.md#_profilehonors)_ +*Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[*profileHonors](_src_entities_linkedin_profile_entity_.linkedinprofile.md#*profilehonors)* -_Defined in [src/entities/linkedin-profile.entity.ts:46](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L46)_ +*Defined in [src/entities/linkedin-profile.entity.ts:46](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L46)* ---- +___ -### \*profileLanguages +### *profileLanguages -• **\*profileLanguages**: string +• ***profileLanguages**: string -*Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[*profileLanguages](_src_entities_linkedin_profile_entity_.linkedinprofile.md#_profilelanguages)_ +*Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[*profileLanguages](_src_entities_linkedin_profile_entity_.linkedinprofile.md#*profilelanguages)* -_Defined in [src/entities/linkedin-profile.entity.ts:47](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L47)_ +*Defined in [src/entities/linkedin-profile.entity.ts:47](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L47)* ---- +___ -### \*profileOrganizations +### *profileOrganizations -• **\*profileOrganizations**: string +• ***profileOrganizations**: string -*Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[*profileOrganizations](_src_entities_linkedin_profile_entity_.linkedinprofile.md#_profileorganizations)_ +*Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[*profileOrganizations](_src_entities_linkedin_profile_entity_.linkedinprofile.md#*profileorganizations)* -_Defined in [src/entities/linkedin-profile.entity.ts:48](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L48)_ +*Defined in [src/entities/linkedin-profile.entity.ts:48](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L48)* ---- +___ -### \*profilePatents +### *profilePatents -• **\*profilePatents**: string +• ***profilePatents**: string -*Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[*profilePatents](_src_entities_linkedin_profile_entity_.linkedinprofile.md#_profilepatents)_ +*Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[*profilePatents](_src_entities_linkedin_profile_entity_.linkedinprofile.md#*profilepatents)* -_Defined in [src/entities/linkedin-profile.entity.ts:49](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L49)_ +*Defined in [src/entities/linkedin-profile.entity.ts:49](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L49)* ---- +___ -### \*profilePositionGroups +### *profilePositionGroups -• **\*profilePositionGroups**: string +• ***profilePositionGroups**: string -*Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[*profilePositionGroups](_src_entities_linkedin_profile_entity_.linkedinprofile.md#_profilepositiongroups)_ +*Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[*profilePositionGroups](_src_entities_linkedin_profile_entity_.linkedinprofile.md#*profilepositiongroups)* -_Defined in [src/entities/linkedin-profile.entity.ts:50](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L50)_ +*Defined in [src/entities/linkedin-profile.entity.ts:50](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L50)* ---- +___ -### \*profileProjects +### *profileProjects -• **\*profileProjects**: string +• ***profileProjects**: string -*Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[*profileProjects](_src_entities_linkedin_profile_entity_.linkedinprofile.md#_profileprojects)_ +*Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[*profileProjects](_src_entities_linkedin_profile_entity_.linkedinprofile.md#*profileprojects)* -_Defined in [src/entities/linkedin-profile.entity.ts:51](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L51)_ +*Defined in [src/entities/linkedin-profile.entity.ts:51](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L51)* ---- +___ -### \*profilePublications +### *profilePublications -• **\*profilePublications**: string +• ***profilePublications**: string -*Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[*profilePublications](_src_entities_linkedin_profile_entity_.linkedinprofile.md#_profilepublications)_ +*Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[*profilePublications](_src_entities_linkedin_profile_entity_.linkedinprofile.md#*profilepublications)* -_Defined in [src/entities/linkedin-profile.entity.ts:52](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L52)_ +*Defined in [src/entities/linkedin-profile.entity.ts:52](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L52)* ---- +___ -### \*profileSkills +### *profileSkills -• **\*profileSkills**: string +• ***profileSkills**: string -*Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[*profileSkills](_src_entities_linkedin_profile_entity_.linkedinprofile.md#_profileskills)_ +*Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[*profileSkills](_src_entities_linkedin_profile_entity_.linkedinprofile.md#*profileskills)* -_Defined in [src/entities/linkedin-profile.entity.ts:53](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L53)_ +*Defined in [src/entities/linkedin-profile.entity.ts:53](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L53)* ---- +___ -### \*profileTestScores +### *profileTestScores -• **\*profileTestScores**: string +• ***profileTestScores**: string -*Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[*profileTestScores](_src_entities_linkedin_profile_entity_.linkedinprofile.md#_profiletestscores)_ +*Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[*profileTestScores](_src_entities_linkedin_profile_entity_.linkedinprofile.md#*profiletestscores)* -_Defined in [src/entities/linkedin-profile.entity.ts:54](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L54)_ +*Defined in [src/entities/linkedin-profile.entity.ts:54](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L54)* ---- +___ -### \*profileTreasuryMediaProfile +### *profileTreasuryMediaProfile -• **\*profileTreasuryMediaProfile**: string +• ***profileTreasuryMediaProfile**: string -*Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[*profileTreasuryMediaProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md#_profiletreasurymediaprofile)_ +*Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[*profileTreasuryMediaProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md#*profiletreasurymediaprofile)* -_Defined in [src/entities/linkedin-profile.entity.ts:55](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L55)_ +*Defined in [src/entities/linkedin-profile.entity.ts:55](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L55)* ---- +___ -### \*profileVolunteerExperiences +### *profileVolunteerExperiences -• **\*profileVolunteerExperiences**: string +• ***profileVolunteerExperiences**: string -*Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[*profileVolunteerExperiences](_src_entities_linkedin_profile_entity_.linkedinprofile.md#_profilevolunteerexperiences)_ +*Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[*profileVolunteerExperiences](_src_entities_linkedin_profile_entity_.linkedinprofile.md#*profilevolunteerexperiences)* -_Defined in [src/entities/linkedin-profile.entity.ts:56](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L56)_ +*Defined in [src/entities/linkedin-profile.entity.ts:56](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L56)* ---- +___ ### company -• **company**: [LinkedInCompany](_src_entities_linkedin_company_entity_.linkedincompany.md) +• **company**: [LinkedInCompany](_src_entities_linkedin_company_entity_.linkedincompany.md) -_Defined in [src/entities/profile.entity.ts:5](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/profile.entity.ts#L5)_ +*Defined in [src/entities/profile.entity.ts:5](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/profile.entity.ts#L5)* ---- +___ ### defaultToActivityTab -• **defaultToActivityTab**: boolean +• **defaultToActivityTab**: boolean -_Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[defaultToActivityTab](_src_entities_linkedin_profile_entity_.linkedinprofile.md#defaulttoactivitytab)_ +*Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[defaultToActivityTab](_src_entities_linkedin_profile_entity_.linkedinprofile.md#defaulttoactivitytab)* -_Defined in [src/entities/linkedin-profile.entity.ts:58](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L58)_ +*Defined in [src/entities/linkedin-profile.entity.ts:58](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L58)* ---- +___ ### educationOnProfileTopCardShown -• **educationOnProfileTopCardShown**: boolean +• **educationOnProfileTopCardShown**: boolean -_Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[educationOnProfileTopCardShown](_src_entities_linkedin_profile_entity_.linkedinprofile.md#educationonprofiletopcardshown)_ +*Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[educationOnProfileTopCardShown](_src_entities_linkedin_profile_entity_.linkedinprofile.md#educationonprofiletopcardshown)* -_Defined in [src/entities/linkedin-profile.entity.ts:59](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L59)_ +*Defined in [src/entities/linkedin-profile.entity.ts:59](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L59)* ---- +___ ### entityUrn -• **entityUrn**: [ProfileUrn](../modules/_src_entities_linkedin_profile_entity_.md#profileurn) +• **entityUrn**: [ProfileUrn](../modules/_src_entities_linkedin_profile_entity_.md#profileurn) -_Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[entityUrn](_src_entities_linkedin_profile_entity_.linkedinprofile.md#entityurn)_ +*Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[entityUrn](_src_entities_linkedin_profile_entity_.linkedinprofile.md#entityurn)* -_Defined in [src/entities/linkedin-profile.entity.ts:60](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L60)_ +*Defined in [src/entities/linkedin-profile.entity.ts:60](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L60)* ---- +___ ### firstName -• **firstName**: string +• **firstName**: string -_Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[firstName](_src_entities_linkedin_profile_entity_.linkedinprofile.md#firstname)_ +*Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[firstName](_src_entities_linkedin_profile_entity_.linkedinprofile.md#firstname)* -_Defined in [src/entities/linkedin-profile.entity.ts:61](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L61)_ +*Defined in [src/entities/linkedin-profile.entity.ts:61](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L61)* ---- +___ ### geoLocation -• **geoLocation**: LinkedInProfileGeoLocation +• **geoLocation**: LinkedInProfileGeoLocation -_Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[geoLocation](_src_entities_linkedin_profile_entity_.linkedinprofile.md#geolocation)_ +*Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[geoLocation](_src_entities_linkedin_profile_entity_.linkedinprofile.md#geolocation)* -_Defined in [src/entities/linkedin-profile.entity.ts:63](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L63)_ +*Defined in [src/entities/linkedin-profile.entity.ts:63](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L63)* ---- +___ ### geoLocationBackfilled -• **geoLocationBackfilled**: boolean +• **geoLocationBackfilled**: boolean -_Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[geoLocationBackfilled](_src_entities_linkedin_profile_entity_.linkedinprofile.md#geolocationbackfilled)_ +*Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[geoLocationBackfilled](_src_entities_linkedin_profile_entity_.linkedinprofile.md#geolocationbackfilled)* -_Defined in [src/entities/linkedin-profile.entity.ts:64](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L64)_ +*Defined in [src/entities/linkedin-profile.entity.ts:64](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L64)* ---- +___ ### headline -• **headline**: string +• **headline**: string -_Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[headline](_src_entities_linkedin_profile_entity_.linkedinprofile.md#headline)_ +*Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[headline](_src_entities_linkedin_profile_entity_.linkedinprofile.md#headline)* -_Defined in [src/entities/linkedin-profile.entity.ts:65](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L65)_ +*Defined in [src/entities/linkedin-profile.entity.ts:65](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L65)* ---- +___ ### industryUrn -• **industryUrn**: string +• **industryUrn**: string -_Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[industryUrn](_src_entities_linkedin_profile_entity_.linkedinprofile.md#industryurn)_ +*Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[industryUrn](_src_entities_linkedin_profile_entity_.linkedinprofile.md#industryurn)* -_Defined in [src/entities/linkedin-profile.entity.ts:66](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L66)_ +*Defined in [src/entities/linkedin-profile.entity.ts:66](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L66)* ---- +___ ### lastName -• **lastName**: string +• **lastName**: string -_Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[lastName](_src_entities_linkedin_profile_entity_.linkedinprofile.md#lastname)_ +*Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[lastName](_src_entities_linkedin_profile_entity_.linkedinprofile.md#lastname)* -_Defined in [src/entities/linkedin-profile.entity.ts:62](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L62)_ +*Defined in [src/entities/linkedin-profile.entity.ts:62](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L62)* ---- +___ ### location -• **location**: LinkedInProfileLocation +• **location**: LinkedInProfileLocation -_Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[location](_src_entities_linkedin_profile_entity_.linkedinprofile.md#location)_ +*Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[location](_src_entities_linkedin_profile_entity_.linkedinprofile.md#location)* -_Defined in [src/entities/linkedin-profile.entity.ts:67](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L67)_ +*Defined in [src/entities/linkedin-profile.entity.ts:67](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L67)* ---- +___ ### locationName -• **locationName**: string +• **locationName**: string -_Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[locationName](_src_entities_linkedin_profile_entity_.linkedinprofile.md#locationname)_ +*Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[locationName](_src_entities_linkedin_profile_entity_.linkedinprofile.md#locationname)* -_Defined in [src/entities/linkedin-profile.entity.ts:68](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L68)_ +*Defined in [src/entities/linkedin-profile.entity.ts:68](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L68)* ---- +___ ### multiLocaleFirstName -• **multiLocaleFirstName**: Record +• **multiLocaleFirstName**: Record -_Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[multiLocaleFirstName](_src_entities_linkedin_profile_entity_.linkedinprofile.md#multilocalefirstname)_ +*Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[multiLocaleFirstName](_src_entities_linkedin_profile_entity_.linkedinprofile.md#multilocalefirstname)* -_Defined in [src/entities/linkedin-profile.entity.ts:69](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L69)_ +*Defined in [src/entities/linkedin-profile.entity.ts:69](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L69)* ---- +___ ### multiLocaleHeadline -• **multiLocaleHeadline**: Record +• **multiLocaleHeadline**: Record -_Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[multiLocaleHeadline](_src_entities_linkedin_profile_entity_.linkedinprofile.md#multilocaleheadline)_ +*Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[multiLocaleHeadline](_src_entities_linkedin_profile_entity_.linkedinprofile.md#multilocaleheadline)* -_Defined in [src/entities/linkedin-profile.entity.ts:70](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L70)_ +*Defined in [src/entities/linkedin-profile.entity.ts:70](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L70)* ---- +___ ### multiLocaleLastName -• **multiLocaleLastName**: Record +• **multiLocaleLastName**: Record -_Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[multiLocaleLastName](_src_entities_linkedin_profile_entity_.linkedinprofile.md#multilocalelastname)_ +*Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[multiLocaleLastName](_src_entities_linkedin_profile_entity_.linkedinprofile.md#multilocalelastname)* -_Defined in [src/entities/linkedin-profile.entity.ts:71](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L71)_ +*Defined in [src/entities/linkedin-profile.entity.ts:71](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L71)* ---- +___ ### objectUrn -• **objectUrn**: string +• **objectUrn**: string -_Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[objectUrn](_src_entities_linkedin_profile_entity_.linkedinprofile.md#objecturn)_ +*Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[objectUrn](_src_entities_linkedin_profile_entity_.linkedinprofile.md#objecturn)* -_Defined in [src/entities/linkedin-profile.entity.ts:72](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L72)_ +*Defined in [src/entities/linkedin-profile.entity.ts:72](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L72)* ---- +___ ### pictureUrls -• **pictureUrls**: string[] +• **pictureUrls**: string[] -_Defined in [src/entities/profile.entity.ts:6](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/profile.entity.ts#L6)_ +*Defined in [src/entities/profile.entity.ts:6](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/profile.entity.ts#L6)* ---- +___ ### primaryLocale -• **primaryLocale**: LinkedInPrimaryLocale +• **primaryLocale**: LinkedInPrimaryLocale -_Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[primaryLocale](_src_entities_linkedin_profile_entity_.linkedinprofile.md#primarylocale)_ +*Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[primaryLocale](_src_entities_linkedin_profile_entity_.linkedinprofile.md#primarylocale)* -_Defined in [src/entities/linkedin-profile.entity.ts:73](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L73)_ +*Defined in [src/entities/linkedin-profile.entity.ts:73](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L73)* ---- +___ ### profilePicture -• **profilePicture**: [LinkedInPhotoFilterPicture](_src_entities_linkedin_profile_entity_.linkedinphotofilterpicture.md) +• **profilePicture**: [LinkedInPhotoFilterPicture](_src_entities_linkedin_profile_entity_.linkedinphotofilterpicture.md) -_Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[profilePicture](_src_entities_linkedin_profile_entity_.linkedinprofile.md#profilepicture)_ +*Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[profilePicture](_src_entities_linkedin_profile_entity_.linkedinprofile.md#profilepicture)* -_Defined in [src/entities/linkedin-profile.entity.ts:74](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L74)_ +*Defined in [src/entities/linkedin-profile.entity.ts:74](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L74)* ---- +___ ### publicIdentifier -• **publicIdentifier**: string +• **publicIdentifier**: string -_Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[publicIdentifier](_src_entities_linkedin_profile_entity_.linkedinprofile.md#publicidentifier)_ +*Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[publicIdentifier](_src_entities_linkedin_profile_entity_.linkedinprofile.md#publicidentifier)* -_Defined in [src/entities/linkedin-profile.entity.ts:75](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L75)_ +*Defined in [src/entities/linkedin-profile.entity.ts:75](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L75)* ---- +___ ### supportedLocales -• **supportedLocales**: LinkedInPrimaryLocale[] +• **supportedLocales**: LinkedInPrimaryLocale[] -_Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[supportedLocales](_src_entities_linkedin_profile_entity_.linkedinprofile.md#supportedlocales)_ +*Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[supportedLocales](_src_entities_linkedin_profile_entity_.linkedinprofile.md#supportedlocales)* -_Defined in [src/entities/linkedin-profile.entity.ts:76](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L76)_ +*Defined in [src/entities/linkedin-profile.entity.ts:76](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L76)* ---- +___ ### trackingId -• **trackingId**: string +• **trackingId**: string -_Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[trackingId](_src_entities_linkedin_profile_entity_.linkedinprofile.md#trackingid)_ +*Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[trackingId](_src_entities_linkedin_profile_entity_.linkedinprofile.md#trackingid)* -_Defined in [src/entities/linkedin-profile.entity.ts:77](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L77)_ +*Defined in [src/entities/linkedin-profile.entity.ts:77](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L77)* ---- +___ ### versionTag -• **versionTag**: string +• **versionTag**: string -_Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[versionTag](_src_entities_linkedin_profile_entity_.linkedinprofile.md#versiontag)_ +*Inherited from [LinkedInProfile](_src_entities_linkedin_profile_entity_.linkedinprofile.md).[versionTag](_src_entities_linkedin_profile_entity_.linkedinprofile.md#versiontag)* -_Defined in [src/entities/linkedin-profile.entity.ts:78](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L78)_ +*Defined in [src/entities/linkedin-profile.entity.ts:78](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L78)* diff --git a/docs/modules/_src_entities_conversation_entity_.md b/docs/modules/_src_entities_conversation_entity_.md index 786c30aa..a864acda 100644 --- a/docs/modules/_src_entities_conversation_entity_.md +++ b/docs/modules/_src_entities_conversation_entity_.md @@ -8,16 +8,16 @@ ### Interfaces -- [Conversation](../interfaces/_src_entities_conversation_entity_.conversation.md) +* [Conversation](../interfaces/_src_entities_conversation_entity_.conversation.md) ### Type aliases -- [ConversationId](_src_entities_conversation_entity_.md#conversationid) +* [ConversationId](_src_entities_conversation_entity_.md#conversationid) ## Type aliases ### ConversationId -Ƭ **ConversationId**: string +Ƭ **ConversationId**: string -_Defined in [src/entities/conversation.entity.ts:4](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/conversation.entity.ts#L4)_ +*Defined in [src/entities/conversation.entity.ts:4](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/conversation.entity.ts#L4)* diff --git a/docs/modules/_src_entities_index_.md b/docs/modules/_src_entities_index_.md index 9af5f824..ae7955c6 100644 --- a/docs/modules/_src_entities_index_.md +++ b/docs/modules/_src_entities_index_.md @@ -8,55 +8,55 @@ ### References -- [AttributeText](_src_entities_index_.md#attributetext) -- [BASE_COMPANY_TYPE](_src_entities_index_.md#base_company_type) -- [COMPANY_TYPE](_src_entities_index_.md#company_type) -- [CONVERSATION_TYPE](_src_entities_index_.md#conversation_type) -- [CompanySearchHit](_src_entities_index_.md#companysearchhit) -- [Conversation](_src_entities_index_.md#conversation) -- [ConversationId](_src_entities_index_.md#conversationid) -- [ConversationUrn](_src_entities_index_.md#conversationurn) -- [EVENT_TYPE](_src_entities_index_.md#event_type) -- [FeaturedType](_src_entities_index_.md#featuredtype) -- [INVITATION_TYPE](_src_entities_index_.md#invitation_type) -- [Invitation](_src_entities_index_.md#invitation) -- [JOB_POSTING_TYPE](_src_entities_index_.md#job_posting_type) -- [LinkedEventCreateResponse](_src_entities_index_.md#linkedeventcreateresponse) -- [LinkedInBaseCompany](_src_entities_index_.md#linkedinbasecompany) -- [LinkedInCollectionResponse](_src_entities_index_.md#linkedincollectionresponse) -- [LinkedInCompany](_src_entities_index_.md#linkedincompany) -- [LinkedInEvent](_src_entities_index_.md#linkedinevent) -- [LinkedInEventUrn](_src_entities_index_.md#linkedineventurn) -- [LinkedInImageAttribute](_src_entities_index_.md#linkedinimageattribute) -- [LinkedInImageViewModel](_src_entities_index_.md#linkedinimageviewmodel) -- [LinkedInInvitation](_src_entities_index_.md#linkedininvitation) -- [LinkedInJobPosting](_src_entities_index_.md#linkedinjobposting) -- [LinkedInJobPostingCompany](_src_entities_index_.md#linkedinjobpostingcompany) -- [LinkedInMessage](_src_entities_index_.md#linkedinmessage) -- [LinkedInMessageEvent](_src_entities_index_.md#linkedinmessageevent) -- [LinkedInMiniCompany](_src_entities_index_.md#linkedinminicompany) -- [LinkedInMiniProfile](_src_entities_index_.md#linkedinminiprofile) -- [LinkedInParticipantReceipts](_src_entities_index_.md#linkedinparticipantreceipts) -- [LinkedInPhotoFilterPicture](_src_entities_index_.md#linkedinphotofilterpicture) -- [LinkedInProfile](_src_entities_index_.md#linkedinprofile) -- [LinkedInSearchCluster](_src_entities_index_.md#linkedinsearchcluster) -- [LinkedInSearchHitV2](_src_entities_index_.md#linkedinsearchhitv2) -- [LinkedInTextViewModel](_src_entities_index_.md#linkedintextviewmodel) -- [LinkedInVectorArtifact](_src_entities_index_.md#linkedinvectorartifact) -- [LinkedInVectorImage](_src_entities_index_.md#linkedinvectorimage) -- [LinkedinConversation](_src_entities_index_.md#linkedinconversation) -- [MINI_COMPANY_TYPE](_src_entities_index_.md#mini_company_type) -- [MINI_PROFILE_TYPE](_src_entities_index_.md#mini_profile_type) -- [MessageEvent](_src_entities_index_.md#messageevent) -- [MessageEventCreateResponse](_src_entities_index_.md#messageeventcreateresponse) -- [MiniProfile](_src_entities_index_.md#miniprofile) -- [MiniProfileUrn](_src_entities_index_.md#miniprofileurn) -- [PROFILE_TYPE](_src_entities_index_.md#profile_type) -- [PeopleSearchHit](_src_entities_index_.md#peoplesearchhit) -- [Profile](_src_entities_index_.md#profile) -- [ProfileId](_src_entities_index_.md#profileid) -- [ProfileUrn](_src_entities_index_.md#profileurn) -- [QuickReplayRecommendation](_src_entities_index_.md#quickreplayrecommendation) +* [AttributeText](_src_entities_index_.md#attributetext) +* [BASE\_COMPANY\_TYPE](_src_entities_index_.md#base_company_type) +* [COMPANY\_TYPE](_src_entities_index_.md#company_type) +* [CONVERSATION\_TYPE](_src_entities_index_.md#conversation_type) +* [CompanySearchHit](_src_entities_index_.md#companysearchhit) +* [Conversation](_src_entities_index_.md#conversation) +* [ConversationId](_src_entities_index_.md#conversationid) +* [ConversationUrn](_src_entities_index_.md#conversationurn) +* [EVENT\_TYPE](_src_entities_index_.md#event_type) +* [FeaturedType](_src_entities_index_.md#featuredtype) +* [INVITATION\_TYPE](_src_entities_index_.md#invitation_type) +* [Invitation](_src_entities_index_.md#invitation) +* [JOB\_POSTING\_TYPE](_src_entities_index_.md#job_posting_type) +* [LinkedEventCreateResponse](_src_entities_index_.md#linkedeventcreateresponse) +* [LinkedInBaseCompany](_src_entities_index_.md#linkedinbasecompany) +* [LinkedInCollectionResponse](_src_entities_index_.md#linkedincollectionresponse) +* [LinkedInCompany](_src_entities_index_.md#linkedincompany) +* [LinkedInEvent](_src_entities_index_.md#linkedinevent) +* [LinkedInEventUrn](_src_entities_index_.md#linkedineventurn) +* [LinkedInImageAttribute](_src_entities_index_.md#linkedinimageattribute) +* [LinkedInImageViewModel](_src_entities_index_.md#linkedinimageviewmodel) +* [LinkedInInvitation](_src_entities_index_.md#linkedininvitation) +* [LinkedInJobPosting](_src_entities_index_.md#linkedinjobposting) +* [LinkedInJobPostingCompany](_src_entities_index_.md#linkedinjobpostingcompany) +* [LinkedInMessage](_src_entities_index_.md#linkedinmessage) +* [LinkedInMessageEvent](_src_entities_index_.md#linkedinmessageevent) +* [LinkedInMiniCompany](_src_entities_index_.md#linkedinminicompany) +* [LinkedInMiniProfile](_src_entities_index_.md#linkedinminiprofile) +* [LinkedInParticipantReceipts](_src_entities_index_.md#linkedinparticipantreceipts) +* [LinkedInPhotoFilterPicture](_src_entities_index_.md#linkedinphotofilterpicture) +* [LinkedInProfile](_src_entities_index_.md#linkedinprofile) +* [LinkedInSearchCluster](_src_entities_index_.md#linkedinsearchcluster) +* [LinkedInSearchHitV2](_src_entities_index_.md#linkedinsearchhitv2) +* [LinkedInTextViewModel](_src_entities_index_.md#linkedintextviewmodel) +* [LinkedInVectorArtifact](_src_entities_index_.md#linkedinvectorartifact) +* [LinkedInVectorImage](_src_entities_index_.md#linkedinvectorimage) +* [LinkedinConversation](_src_entities_index_.md#linkedinconversation) +* [MINI\_COMPANY\_TYPE](_src_entities_index_.md#mini_company_type) +* [MINI\_PROFILE\_TYPE](_src_entities_index_.md#mini_profile_type) +* [MessageEvent](_src_entities_index_.md#messageevent) +* [MessageEventCreateResponse](_src_entities_index_.md#messageeventcreateresponse) +* [MiniProfile](_src_entities_index_.md#miniprofile) +* [MiniProfileUrn](_src_entities_index_.md#miniprofileurn) +* [PROFILE\_TYPE](_src_entities_index_.md#profile_type) +* [PeopleSearchHit](_src_entities_index_.md#peoplesearchhit) +* [Profile](_src_entities_index_.md#profile) +* [ProfileId](_src_entities_index_.md#profileid) +* [ProfileUrn](_src_entities_index_.md#profileurn) +* [QuickReplayRecommendation](_src_entities_index_.md#quickreplayrecommendation) ## References @@ -64,289 +64,289 @@ Re-exports: [AttributeText](../interfaces/_src_entities_linkedin_attribute_text_entity_.attributetext.md) ---- +___ -### BASE_COMPANY_TYPE +### BASE\_COMPANY\_TYPE -Re-exports: [BASE_COMPANY_TYPE](_src_entities_linkedin_base_company_.md#base_company_type) +Re-exports: [BASE\_COMPANY\_TYPE](_src_entities_linkedin_base_company_.md#base_company_type) ---- +___ -### COMPANY_TYPE +### COMPANY\_TYPE -Re-exports: [COMPANY_TYPE](_src_entities_linkedin_company_entity_.md#company_type) +Re-exports: [COMPANY\_TYPE](_src_entities_linkedin_company_entity_.md#company_type) ---- +___ -### CONVERSATION_TYPE +### CONVERSATION\_TYPE -Re-exports: [CONVERSATION_TYPE](_src_entities_linkedin_conversation_entity_.md#conversation_type) +Re-exports: [CONVERSATION\_TYPE](_src_entities_linkedin_conversation_entity_.md#conversation_type) ---- +___ ### CompanySearchHit Re-exports: [CompanySearchHit](../interfaces/_src_entities_company_search_hit_entity_.companysearchhit.md) ---- +___ ### Conversation Re-exports: [Conversation](../interfaces/_src_entities_conversation_entity_.conversation.md) ---- +___ ### ConversationId Re-exports: [ConversationId](_src_entities_conversation_entity_.md#conversationid) ---- +___ ### ConversationUrn Re-exports: [ConversationUrn](_src_entities_linkedin_conversation_entity_.md#conversationurn) ---- +___ -### EVENT_TYPE +### EVENT\_TYPE -Re-exports: [EVENT_TYPE](_src_entities_linkedin_event_entity_.md#event_type) +Re-exports: [EVENT\_TYPE](_src_entities_linkedin_event_entity_.md#event_type) ---- +___ ### FeaturedType Re-exports: [FeaturedType](../enums/_src_entities_linkedin_conversation_entity_.featuredtype.md) ---- +___ -### INVITATION_TYPE +### INVITATION\_TYPE -Re-exports: [INVITATION_TYPE](_src_entities_linkedin_invitation_entity_.md#invitation_type) +Re-exports: [INVITATION\_TYPE](_src_entities_linkedin_invitation_entity_.md#invitation_type) ---- +___ ### Invitation Re-exports: [Invitation](../interfaces/_src_entities_invitation_entity_.invitation.md) ---- +___ -### JOB_POSTING_TYPE +### JOB\_POSTING\_TYPE -Re-exports: [JOB_POSTING_TYPE](_src_entities_linkedin_job_posting_.md#job_posting_type) +Re-exports: [JOB\_POSTING\_TYPE](_src_entities_linkedin_job_posting_.md#job_posting_type) ---- +___ ### LinkedEventCreateResponse Re-exports: [LinkedEventCreateResponse](../interfaces/_src_entities_linkedin_event_create_response_.linkedeventcreateresponse.md) ---- +___ ### LinkedInBaseCompany Re-exports: [LinkedInBaseCompany](../interfaces/_src_entities_linkedin_base_company_.linkedinbasecompany.md) ---- +___ ### LinkedInCollectionResponse Re-exports: [LinkedInCollectionResponse](../interfaces/_src_entities_linkedin_collection_response_entity_.linkedincollectionresponse.md) ---- +___ ### LinkedInCompany Re-exports: [LinkedInCompany](../interfaces/_src_entities_linkedin_company_entity_.linkedincompany.md) ---- +___ ### LinkedInEvent Re-exports: [LinkedInEvent](../interfaces/_src_entities_linkedin_event_entity_.linkedinevent.md) ---- +___ ### LinkedInEventUrn Re-exports: [LinkedInEventUrn](_src_entities_linkedin_event_entity_.md#linkedineventurn) ---- +___ ### LinkedInImageAttribute Re-exports: [LinkedInImageAttribute](../interfaces/_src_entities_linkedin_image_attribute_entity_.linkedinimageattribute.md) ---- +___ ### LinkedInImageViewModel Re-exports: [LinkedInImageViewModel](../interfaces/_src_entities_linkedin_image_view_model_entity_.linkedinimageviewmodel.md) ---- +___ ### LinkedInInvitation Re-exports: [LinkedInInvitation](../interfaces/_src_entities_linkedin_invitation_entity_.linkedininvitation.md) ---- +___ ### LinkedInJobPosting Re-exports: [LinkedInJobPosting](../interfaces/_src_entities_linkedin_job_posting_.linkedinjobposting.md) ---- +___ ### LinkedInJobPostingCompany Re-exports: [LinkedInJobPostingCompany](../interfaces/_src_entities_linkedin_job_posting_.linkedinjobpostingcompany.md) ---- +___ ### LinkedInMessage Re-exports: [LinkedInMessage](../interfaces/_src_entities_linkedin_message_entity_.linkedinmessage.md) ---- +___ ### LinkedInMessageEvent Re-exports: [LinkedInMessageEvent](../interfaces/_src_entities_linkedin_message_event_entity_.linkedinmessageevent.md) ---- +___ ### LinkedInMiniCompany Re-exports: [LinkedInMiniCompany](../interfaces/_src_entities_linkedin_mini_company_entity_.linkedinminicompany.md) ---- +___ ### LinkedInMiniProfile Re-exports: [LinkedInMiniProfile](../interfaces/_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md) ---- +___ ### LinkedInParticipantReceipts Re-exports: [LinkedInParticipantReceipts](../interfaces/_src_entities_linkedin_conversation_entity_.linkedinparticipantreceipts.md) ---- +___ ### LinkedInPhotoFilterPicture Re-exports: [LinkedInPhotoFilterPicture](../interfaces/_src_entities_linkedin_profile_entity_.linkedinphotofilterpicture.md) ---- +___ ### LinkedInProfile Re-exports: [LinkedInProfile](../interfaces/_src_entities_linkedin_profile_entity_.linkedinprofile.md) ---- +___ ### LinkedInSearchCluster Re-exports: [LinkedInSearchCluster](../interfaces/_src_entities_linkedin_search_cluster_entity_.linkedinsearchcluster.md) ---- +___ ### LinkedInSearchHitV2 Re-exports: [LinkedInSearchHitV2](../interfaces/_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md) ---- +___ ### LinkedInTextViewModel Re-exports: [LinkedInTextViewModel](../interfaces/_src_entities_linkedin_text_view_model_entity_.linkedintextviewmodel.md) ---- +___ ### LinkedInVectorArtifact Re-exports: [LinkedInVectorArtifact](../interfaces/_src_entities_linkedin_vector_artifact_entity_.linkedinvectorartifact.md) ---- +___ ### LinkedInVectorImage Re-exports: [LinkedInVectorImage](../interfaces/_src_entities_linkedin_vector_image_entity_.linkedinvectorimage.md) ---- +___ ### LinkedinConversation Re-exports: [LinkedinConversation](../interfaces/_src_entities_linkedin_conversation_entity_.linkedinconversation.md) ---- +___ -### MINI_COMPANY_TYPE +### MINI\_COMPANY\_TYPE -Re-exports: [MINI_COMPANY_TYPE](_src_entities_linkedin_mini_company_entity_.md#mini_company_type) +Re-exports: [MINI\_COMPANY\_TYPE](_src_entities_linkedin_mini_company_entity_.md#mini_company_type) ---- +___ -### MINI_PROFILE_TYPE +### MINI\_PROFILE\_TYPE -Re-exports: [MINI_PROFILE_TYPE](_src_entities_linkedin_mini_profile_entity_.md#mini_profile_type) +Re-exports: [MINI\_PROFILE\_TYPE](_src_entities_linkedin_mini_profile_entity_.md#mini_profile_type) ---- +___ ### MessageEvent Re-exports: [MessageEvent](../interfaces/_src_entities_message_event_entity_.messageevent.md) ---- +___ ### MessageEventCreateResponse Re-exports: [MessageEventCreateResponse](../interfaces/_src_entities_message_create_response_entity_.messageeventcreateresponse.md) ---- +___ ### MiniProfile Re-exports: [MiniProfile](../interfaces/_src_entities_mini_profile_entity_.miniprofile.md) ---- +___ ### MiniProfileUrn Re-exports: [MiniProfileUrn](_src_entities_linkedin_mini_profile_entity_.md#miniprofileurn) ---- +___ -### PROFILE_TYPE +### PROFILE\_TYPE -Re-exports: [PROFILE_TYPE](_src_entities_linkedin_profile_entity_.md#profile_type) +Re-exports: [PROFILE\_TYPE](_src_entities_linkedin_profile_entity_.md#profile_type) ---- +___ ### PeopleSearchHit Re-exports: [PeopleSearchHit](../interfaces/_src_entities_people_search_hit_entity_.peoplesearchhit.md) ---- +___ ### Profile Re-exports: [Profile](../interfaces/_src_entities_profile_entity_.profile.md) ---- +___ ### ProfileId Re-exports: [ProfileId](_src_entities_mini_profile_entity_.md#profileid) ---- +___ ### ProfileUrn Re-exports: [ProfileUrn](_src_entities_linkedin_profile_entity_.md#profileurn) ---- +___ ### QuickReplayRecommendation diff --git a/docs/modules/_src_entities_job_search_hit_entity_.md b/docs/modules/_src_entities_job_search_hit_entity_.md index cbd12f97..52f2ec55 100644 --- a/docs/modules/_src_entities_job_search_hit_entity_.md +++ b/docs/modules/_src_entities_job_search_hit_entity_.md @@ -8,18 +8,18 @@ ### Interfaces -- [PopulatedJobHitInfo](../interfaces/_src_entities_job_search_hit_entity_.populatedjobhitinfo.md) -- [PopulatedJobPosting](../interfaces/_src_entities_job_search_hit_entity_.populatedjobposting.md) -- [PopulatedJobPostingCompany](../interfaces/_src_entities_job_search_hit_entity_.populatedjobpostingcompany.md) +* [PopulatedJobHitInfo](../interfaces/_src_entities_job_search_hit_entity_.populatedjobhitinfo.md) +* [PopulatedJobPosting](../interfaces/_src_entities_job_search_hit_entity_.populatedjobposting.md) +* [PopulatedJobPostingCompany](../interfaces/_src_entities_job_search_hit_entity_.populatedjobpostingcompany.md) ### Type aliases -- [JobSearchHit](_src_entities_job_search_hit_entity_.md#jobsearchhit) +* [JobSearchHit](_src_entities_job_search_hit_entity_.md#jobsearchhit) ## Type aliases ### JobSearchHit -Ƭ **JobSearchHit**: [LinkedInSearchHit](../interfaces/_src_entities_linkedin_search_hit_entity_.linkedinsearchhit.md)<[PopulatedJobHitInfo](../interfaces/_src_entities_job_search_hit_entity_.populatedjobhitinfo.md)\> +Ƭ **JobSearchHit**: [LinkedInSearchHit](../interfaces/_src_entities_linkedin_search_hit_entity_.linkedinsearchhit.md)<[PopulatedJobHitInfo](../interfaces/_src_entities_job_search_hit_entity_.populatedjobhitinfo.md)\> -_Defined in [src/entities/job-search-hit.entity.ts:18](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/job-search-hit.entity.ts#L18)_ +*Defined in [src/entities/job-search-hit.entity.ts:18](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/job-search-hit.entity.ts#L18)* diff --git a/docs/modules/_src_entities_linkedin_base_company_.md b/docs/modules/_src_entities_linkedin_base_company_.md index 59f628db..d293de76 100644 --- a/docs/modules/_src_entities_linkedin_base_company_.md +++ b/docs/modules/_src_entities_linkedin_base_company_.md @@ -8,16 +8,16 @@ ### Interfaces -- [LinkedInBaseCompany](../interfaces/_src_entities_linkedin_base_company_.linkedinbasecompany.md) +* [LinkedInBaseCompany](../interfaces/_src_entities_linkedin_base_company_.linkedinbasecompany.md) ### Variables -- [BASE_COMPANY_TYPE](_src_entities_linkedin_base_company_.md#base_company_type) +* [BASE\_COMPANY\_TYPE](_src_entities_linkedin_base_company_.md#base_company_type) ## Variables -### BASE_COMPANY_TYPE +### BASE\_COMPANY\_TYPE -• `Const` **BASE_COMPANY_TYPE**: \"com.linkedin.voyager.organization.Company\" = "com.linkedin.voyager.organization.Company" +• `Const` **BASE\_COMPANY\_TYPE**: \"com.linkedin.voyager.organization.Company\" = "com.linkedin.voyager.organization.Company" -_Defined in [src/entities/linkedin-base-company.ts:3](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-base-company.ts#L3)_ +*Defined in [src/entities/linkedin-base-company.ts:3](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-base-company.ts#L3)* diff --git a/docs/modules/_src_entities_linkedin_company_entity_.md b/docs/modules/_src_entities_linkedin_company_entity_.md index 4d7afe41..445cd005 100644 --- a/docs/modules/_src_entities_linkedin_company_entity_.md +++ b/docs/modules/_src_entities_linkedin_company_entity_.md @@ -8,16 +8,16 @@ ### Interfaces -- [LinkedInCompany](../interfaces/_src_entities_linkedin_company_entity_.linkedincompany.md) +* [LinkedInCompany](../interfaces/_src_entities_linkedin_company_entity_.linkedincompany.md) ### Variables -- [COMPANY_TYPE](_src_entities_linkedin_company_entity_.md#company_type) +* [COMPANY\_TYPE](_src_entities_linkedin_company_entity_.md#company_type) ## Variables -### COMPANY_TYPE +### COMPANY\_TYPE -• `Const` **COMPANY_TYPE**: \"com.linkedin.voyager.dash.organization.Company\" = "com.linkedin.voyager.dash.organization.Company" +• `Const` **COMPANY\_TYPE**: \"com.linkedin.voyager.dash.organization.Company\" = "com.linkedin.voyager.dash.organization.Company" -_Defined in [src/entities/linkedin-company.entity.ts:3](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-company.entity.ts#L3)_ +*Defined in [src/entities/linkedin-company.entity.ts:3](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-company.entity.ts#L3)* diff --git a/docs/modules/_src_entities_linkedin_conversation_entity_.md b/docs/modules/_src_entities_linkedin_conversation_entity_.md index 2bcb8fba..18b5f607 100644 --- a/docs/modules/_src_entities_linkedin_conversation_entity_.md +++ b/docs/modules/_src_entities_linkedin_conversation_entity_.md @@ -8,33 +8,33 @@ ### Enumerations -- [FeaturedType](../enums/_src_entities_linkedin_conversation_entity_.featuredtype.md) +* [FeaturedType](../enums/_src_entities_linkedin_conversation_entity_.featuredtype.md) ### Interfaces -- [LinkedInParticipantReceipts](../interfaces/_src_entities_linkedin_conversation_entity_.linkedinparticipantreceipts.md) -- [LinkedinConversation](../interfaces/_src_entities_linkedin_conversation_entity_.linkedinconversation.md) +* [LinkedInParticipantReceipts](../interfaces/_src_entities_linkedin_conversation_entity_.linkedinparticipantreceipts.md) +* [LinkedinConversation](../interfaces/_src_entities_linkedin_conversation_entity_.linkedinconversation.md) ### Type aliases -- [ConversationUrn](_src_entities_linkedin_conversation_entity_.md#conversationurn) +* [ConversationUrn](_src_entities_linkedin_conversation_entity_.md#conversationurn) ### Variables -- [CONVERSATION_TYPE](_src_entities_linkedin_conversation_entity_.md#conversation_type) +* [CONVERSATION\_TYPE](_src_entities_linkedin_conversation_entity_.md#conversation_type) ## Type aliases ### ConversationUrn -Ƭ **ConversationUrn**: string +Ƭ **ConversationUrn**: string -_Defined in [src/entities/linkedin-conversation.entity.ts:23](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-conversation.entity.ts#L23)_ +*Defined in [src/entities/linkedin-conversation.entity.ts:23](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-conversation.entity.ts#L23)* ## Variables -### CONVERSATION_TYPE +### CONVERSATION\_TYPE -• `Const` **CONVERSATION_TYPE**: \"com.linkedin.voyager.messaging.Conversation\" = "com.linkedin.voyager.messaging.Conversation" +• `Const` **CONVERSATION\_TYPE**: \"com.linkedin.voyager.messaging.Conversation\" = "com.linkedin.voyager.messaging.Conversation" -_Defined in [src/entities/linkedin-conversation.entity.ts:21](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-conversation.entity.ts#L21)_ +*Defined in [src/entities/linkedin-conversation.entity.ts:21](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-conversation.entity.ts#L21)* diff --git a/docs/modules/_src_entities_linkedin_event_entity_.md b/docs/modules/_src_entities_linkedin_event_entity_.md index 83e0705b..9933c442 100644 --- a/docs/modules/_src_entities_linkedin_event_entity_.md +++ b/docs/modules/_src_entities_linkedin_event_entity_.md @@ -8,28 +8,28 @@ ### Interfaces -- [LinkedInEvent](../interfaces/_src_entities_linkedin_event_entity_.linkedinevent.md) +* [LinkedInEvent](../interfaces/_src_entities_linkedin_event_entity_.linkedinevent.md) ### Type aliases -- [LinkedInEventUrn](_src_entities_linkedin_event_entity_.md#linkedineventurn) +* [LinkedInEventUrn](_src_entities_linkedin_event_entity_.md#linkedineventurn) ### Variables -- [EVENT_TYPE](_src_entities_linkedin_event_entity_.md#event_type) +* [EVENT\_TYPE](_src_entities_linkedin_event_entity_.md#event_type) ## Type aliases ### LinkedInEventUrn -Ƭ **LinkedInEventUrn**: string +Ƭ **LinkedInEventUrn**: string -_Defined in [src/entities/linkedin-event.entity.ts:1](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-event.entity.ts#L1)_ +*Defined in [src/entities/linkedin-event.entity.ts:1](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-event.entity.ts#L1)* ## Variables -### EVENT_TYPE +### EVENT\_TYPE -• `Const` **EVENT_TYPE**: \"com.linkedin.voyager.messaging.Event\" = "com.linkedin.voyager.messaging.Event" +• `Const` **EVENT\_TYPE**: \"com.linkedin.voyager.messaging.Event\" = "com.linkedin.voyager.messaging.Event" -_Defined in [src/entities/linkedin-event.entity.ts:3](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-event.entity.ts#L3)_ +*Defined in [src/entities/linkedin-event.entity.ts:3](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-event.entity.ts#L3)* diff --git a/docs/modules/_src_entities_linkedin_invitation_entity_.md b/docs/modules/_src_entities_linkedin_invitation_entity_.md index 67f8e27c..d5e2455c 100644 --- a/docs/modules/_src_entities_linkedin_invitation_entity_.md +++ b/docs/modules/_src_entities_linkedin_invitation_entity_.md @@ -8,16 +8,16 @@ ### Interfaces -- [LinkedInInvitation](../interfaces/_src_entities_linkedin_invitation_entity_.linkedininvitation.md) +* [LinkedInInvitation](../interfaces/_src_entities_linkedin_invitation_entity_.linkedininvitation.md) ### Variables -- [INVITATION_TYPE](_src_entities_linkedin_invitation_entity_.md#invitation_type) +* [INVITATION\_TYPE](_src_entities_linkedin_invitation_entity_.md#invitation_type) ## Variables -### INVITATION_TYPE +### INVITATION\_TYPE -• `Const` **INVITATION_TYPE**: \"com.linkedin.voyager.relationships.invitation.Invitation\" = "com.linkedin.voyager.relationships.invitation.Invitation" +• `Const` **INVITATION\_TYPE**: \"com.linkedin.voyager.relationships.invitation.Invitation\" = "com.linkedin.voyager.relationships.invitation.Invitation" -_Defined in [src/entities/linkedin-invitation.entity.ts:13](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-invitation.entity.ts#L13)_ +*Defined in [src/entities/linkedin-invitation.entity.ts:13](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-invitation.entity.ts#L13)* diff --git a/docs/modules/_src_entities_linkedin_job_posting_.md b/docs/modules/_src_entities_linkedin_job_posting_.md index edf96493..9814f306 100644 --- a/docs/modules/_src_entities_linkedin_job_posting_.md +++ b/docs/modules/_src_entities_linkedin_job_posting_.md @@ -8,17 +8,17 @@ ### Interfaces -- [LinkedInJobPosting](../interfaces/_src_entities_linkedin_job_posting_.linkedinjobposting.md) -- [LinkedInJobPostingCompany](../interfaces/_src_entities_linkedin_job_posting_.linkedinjobpostingcompany.md) +* [LinkedInJobPosting](../interfaces/_src_entities_linkedin_job_posting_.linkedinjobposting.md) +* [LinkedInJobPostingCompany](../interfaces/_src_entities_linkedin_job_posting_.linkedinjobpostingcompany.md) ### Variables -- [JOB_POSTING_TYPE](_src_entities_linkedin_job_posting_.md#job_posting_type) +* [JOB\_POSTING\_TYPE](_src_entities_linkedin_job_posting_.md#job_posting_type) ## Variables -### JOB_POSTING_TYPE +### JOB\_POSTING\_TYPE -• `Const` **JOB_POSTING_TYPE**: \"com.linkedin.voyager.jobs.JobPosting\" = "com.linkedin.voyager.jobs.JobPosting" +• `Const` **JOB\_POSTING\_TYPE**: \"com.linkedin.voyager.jobs.JobPosting\" = "com.linkedin.voyager.jobs.JobPosting" -_Defined in [src/entities/linkedin-job-posting.ts:1](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-job-posting.ts#L1)_ +*Defined in [src/entities/linkedin-job-posting.ts:1](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-job-posting.ts#L1)* diff --git a/docs/modules/_src_entities_linkedin_job_search_hit_entity_.md b/docs/modules/_src_entities_linkedin_job_search_hit_entity_.md index 3b785ac5..bff01c5c 100644 --- a/docs/modules/_src_entities_linkedin_job_search_hit_entity_.md +++ b/docs/modules/_src_entities_linkedin_job_search_hit_entity_.md @@ -8,4 +8,4 @@ ### Interfaces -- [LinkedInJobSearchHit](../interfaces/_src_entities_linkedin_job_search_hit_entity_.linkedinjobsearchhit.md) +* [LinkedInJobSearchHit](../interfaces/_src_entities_linkedin_job_search_hit_entity_.linkedinjobsearchhit.md) diff --git a/docs/modules/_src_entities_linkedin_mini_company_entity_.md b/docs/modules/_src_entities_linkedin_mini_company_entity_.md index 37718b02..71be40d9 100644 --- a/docs/modules/_src_entities_linkedin_mini_company_entity_.md +++ b/docs/modules/_src_entities_linkedin_mini_company_entity_.md @@ -8,16 +8,16 @@ ### Interfaces -- [LinkedInMiniCompany](../interfaces/_src_entities_linkedin_mini_company_entity_.linkedinminicompany.md) +* [LinkedInMiniCompany](../interfaces/_src_entities_linkedin_mini_company_entity_.linkedinminicompany.md) ### Variables -- [MINI_COMPANY_TYPE](_src_entities_linkedin_mini_company_entity_.md#mini_company_type) +* [MINI\_COMPANY\_TYPE](_src_entities_linkedin_mini_company_entity_.md#mini_company_type) ## Variables -### MINI_COMPANY_TYPE +### MINI\_COMPANY\_TYPE -• `Const` **MINI_COMPANY_TYPE**: \"com.linkedin.voyager.entities.shared.MiniCompany\" = "com.linkedin.voyager.entities.shared.MiniCompany" +• `Const` **MINI\_COMPANY\_TYPE**: \"com.linkedin.voyager.entities.shared.MiniCompany\" = "com.linkedin.voyager.entities.shared.MiniCompany" -_Defined in [src/entities/linkedin-mini-company.entity.ts:3](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-mini-company.entity.ts#L3)_ +*Defined in [src/entities/linkedin-mini-company.entity.ts:3](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-mini-company.entity.ts#L3)* diff --git a/docs/modules/_src_entities_linkedin_mini_profile_entity_.md b/docs/modules/_src_entities_linkedin_mini_profile_entity_.md index 5dd720b8..e15b474f 100644 --- a/docs/modules/_src_entities_linkedin_mini_profile_entity_.md +++ b/docs/modules/_src_entities_linkedin_mini_profile_entity_.md @@ -8,28 +8,28 @@ ### Interfaces -- [LinkedInMiniProfile](../interfaces/_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md) +* [LinkedInMiniProfile](../interfaces/_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md) ### Type aliases -- [MiniProfileUrn](_src_entities_linkedin_mini_profile_entity_.md#miniprofileurn) +* [MiniProfileUrn](_src_entities_linkedin_mini_profile_entity_.md#miniprofileurn) ### Variables -- [MINI_PROFILE_TYPE](_src_entities_linkedin_mini_profile_entity_.md#mini_profile_type) +* [MINI\_PROFILE\_TYPE](_src_entities_linkedin_mini_profile_entity_.md#mini_profile_type) ## Type aliases ### MiniProfileUrn -Ƭ **MiniProfileUrn**: string +Ƭ **MiniProfileUrn**: string -_Defined in [src/entities/linkedin-mini-profile.entity.ts:3](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-mini-profile.entity.ts#L3)_ +*Defined in [src/entities/linkedin-mini-profile.entity.ts:3](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-mini-profile.entity.ts#L3)* ## Variables -### MINI_PROFILE_TYPE +### MINI\_PROFILE\_TYPE -• `Const` **MINI_PROFILE_TYPE**: \"com.linkedin.voyager.identity.shared.MiniProfile\" = "com.linkedin.voyager.identity.shared.MiniProfile" +• `Const` **MINI\_PROFILE\_TYPE**: \"com.linkedin.voyager.identity.shared.MiniProfile\" = "com.linkedin.voyager.identity.shared.MiniProfile" -_Defined in [src/entities/linkedin-mini-profile.entity.ts:5](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-mini-profile.entity.ts#L5)_ +*Defined in [src/entities/linkedin-mini-profile.entity.ts:5](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-mini-profile.entity.ts#L5)* diff --git a/docs/modules/_src_entities_linkedin_profile_entity_.md b/docs/modules/_src_entities_linkedin_profile_entity_.md index 16c6efc4..d9ee9e65 100644 --- a/docs/modules/_src_entities_linkedin_profile_entity_.md +++ b/docs/modules/_src_entities_linkedin_profile_entity_.md @@ -8,29 +8,29 @@ ### Interfaces -- [LinkedInPhotoFilterPicture](../interfaces/_src_entities_linkedin_profile_entity_.linkedinphotofilterpicture.md) -- [LinkedInProfile](../interfaces/_src_entities_linkedin_profile_entity_.linkedinprofile.md) +* [LinkedInPhotoFilterPicture](../interfaces/_src_entities_linkedin_profile_entity_.linkedinphotofilterpicture.md) +* [LinkedInProfile](../interfaces/_src_entities_linkedin_profile_entity_.linkedinprofile.md) ### Type aliases -- [ProfileUrn](_src_entities_linkedin_profile_entity_.md#profileurn) +* [ProfileUrn](_src_entities_linkedin_profile_entity_.md#profileurn) ### Variables -- [PROFILE_TYPE](_src_entities_linkedin_profile_entity_.md#profile_type) +* [PROFILE\_TYPE](_src_entities_linkedin_profile_entity_.md#profile_type) ## Type aliases ### ProfileUrn -Ƭ **ProfileUrn**: string +Ƭ **ProfileUrn**: string -_Defined in [src/entities/linkedin-profile.entity.ts:38](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L38)_ +*Defined in [src/entities/linkedin-profile.entity.ts:38](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L38)* ## Variables -### PROFILE_TYPE +### PROFILE\_TYPE -• `Const` **PROFILE_TYPE**: \"com.linkedin.voyager.dash.identity.profile.Profile\" = "com.linkedin.voyager.dash.identity.profile.Profile" +• `Const` **PROFILE\_TYPE**: \"com.linkedin.voyager.dash.identity.profile.Profile\" = "com.linkedin.voyager.dash.identity.profile.Profile" -_Defined in [src/entities/linkedin-profile.entity.ts:4](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/linkedin-profile.entity.ts#L4)_ +*Defined in [src/entities/linkedin-profile.entity.ts:4](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/linkedin-profile.entity.ts#L4)* diff --git a/docs/modules/_src_entities_linkedin_search_hit_entity_.md b/docs/modules/_src_entities_linkedin_search_hit_entity_.md index c6733450..2e4c466e 100644 --- a/docs/modules/_src_entities_linkedin_search_hit_entity_.md +++ b/docs/modules/_src_entities_linkedin_search_hit_entity_.md @@ -8,4 +8,4 @@ ### Interfaces -- [LinkedInSearchHit](../interfaces/_src_entities_linkedin_search_hit_entity_.linkedinsearchhit.md) +* [LinkedInSearchHit](../interfaces/_src_entities_linkedin_search_hit_entity_.linkedinsearchhit.md) diff --git a/docs/modules/_src_entities_linkedin_search_hit_v2_entity_.md b/docs/modules/_src_entities_linkedin_search_hit_v2_entity_.md index 0e82481f..a3248c8c 100644 --- a/docs/modules/_src_entities_linkedin_search_hit_v2_entity_.md +++ b/docs/modules/_src_entities_linkedin_search_hit_v2_entity_.md @@ -8,4 +8,4 @@ ### Interfaces -- [LinkedInSearchHitV2](../interfaces/_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md) +* [LinkedInSearchHitV2](../interfaces/_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md) diff --git a/docs/modules/_src_entities_mini_company_entity_.md b/docs/modules/_src_entities_mini_company_entity_.md index bad6e88b..25015282 100644 --- a/docs/modules/_src_entities_mini_company_entity_.md +++ b/docs/modules/_src_entities_mini_company_entity_.md @@ -8,16 +8,16 @@ ### Interfaces -- [MiniCompany](../interfaces/_src_entities_mini_company_entity_.minicompany.md) +* [MiniCompany](../interfaces/_src_entities_mini_company_entity_.minicompany.md) ### Type aliases -- [CompanyId](_src_entities_mini_company_entity_.md#companyid) +* [CompanyId](_src_entities_mini_company_entity_.md#companyid) ## Type aliases ### CompanyId -Ƭ **CompanyId**: string +Ƭ **CompanyId**: string -_Defined in [src/entities/mini-company.entity.ts:3](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/mini-company.entity.ts#L3)_ +*Defined in [src/entities/mini-company.entity.ts:3](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/mini-company.entity.ts#L3)* diff --git a/docs/modules/_src_entities_mini_profile_entity_.md b/docs/modules/_src_entities_mini_profile_entity_.md index ac809612..15907fae 100644 --- a/docs/modules/_src_entities_mini_profile_entity_.md +++ b/docs/modules/_src_entities_mini_profile_entity_.md @@ -8,16 +8,16 @@ ### Interfaces -- [MiniProfile](../interfaces/_src_entities_mini_profile_entity_.miniprofile.md) +* [MiniProfile](../interfaces/_src_entities_mini_profile_entity_.miniprofile.md) ### Type aliases -- [ProfileId](_src_entities_mini_profile_entity_.md#profileid) +* [ProfileId](_src_entities_mini_profile_entity_.md#profileid) ## Type aliases ### ProfileId -Ƭ **ProfileId**: string +Ƭ **ProfileId**: string -_Defined in [src/entities/mini-profile.entity.ts:3](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/entities/mini-profile.entity.ts#L3)_ +*Defined in [src/entities/mini-profile.entity.ts:3](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/entities/mini-profile.entity.ts#L3)* diff --git a/docs/modules/_src_index_.md b/docs/modules/_src_index_.md index 9e9e07c0..31e34b15 100644 --- a/docs/modules/_src_index_.md +++ b/docs/modules/_src_index_.md @@ -8,56 +8,56 @@ ### References -- [AttributeText](_src_index_.md#attributetext) -- [BASE_COMPANY_TYPE](_src_index_.md#base_company_type) -- [COMPANY_TYPE](_src_index_.md#company_type) -- [CONVERSATION_TYPE](_src_index_.md#conversation_type) -- [Client](_src_index_.md#client) -- [CompanySearchHit](_src_index_.md#companysearchhit) -- [Conversation](_src_index_.md#conversation) -- [ConversationId](_src_index_.md#conversationid) -- [ConversationUrn](_src_index_.md#conversationurn) -- [EVENT_TYPE](_src_index_.md#event_type) -- [FeaturedType](_src_index_.md#featuredtype) -- [INVITATION_TYPE](_src_index_.md#invitation_type) -- [Invitation](_src_index_.md#invitation) -- [JOB_POSTING_TYPE](_src_index_.md#job_posting_type) -- [LinkedEventCreateResponse](_src_index_.md#linkedeventcreateresponse) -- [LinkedInBaseCompany](_src_index_.md#linkedinbasecompany) -- [LinkedInCollectionResponse](_src_index_.md#linkedincollectionresponse) -- [LinkedInCompany](_src_index_.md#linkedincompany) -- [LinkedInEvent](_src_index_.md#linkedinevent) -- [LinkedInEventUrn](_src_index_.md#linkedineventurn) -- [LinkedInImageAttribute](_src_index_.md#linkedinimageattribute) -- [LinkedInImageViewModel](_src_index_.md#linkedinimageviewmodel) -- [LinkedInInvitation](_src_index_.md#linkedininvitation) -- [LinkedInJobPosting](_src_index_.md#linkedinjobposting) -- [LinkedInJobPostingCompany](_src_index_.md#linkedinjobpostingcompany) -- [LinkedInMessage](_src_index_.md#linkedinmessage) -- [LinkedInMessageEvent](_src_index_.md#linkedinmessageevent) -- [LinkedInMiniCompany](_src_index_.md#linkedinminicompany) -- [LinkedInMiniProfile](_src_index_.md#linkedinminiprofile) -- [LinkedInParticipantReceipts](_src_index_.md#linkedinparticipantreceipts) -- [LinkedInPhotoFilterPicture](_src_index_.md#linkedinphotofilterpicture) -- [LinkedInProfile](_src_index_.md#linkedinprofile) -- [LinkedInSearchCluster](_src_index_.md#linkedinsearchcluster) -- [LinkedInSearchHitV2](_src_index_.md#linkedinsearchhitv2) -- [LinkedInTextViewModel](_src_index_.md#linkedintextviewmodel) -- [LinkedInVectorArtifact](_src_index_.md#linkedinvectorartifact) -- [LinkedInVectorImage](_src_index_.md#linkedinvectorimage) -- [LinkedinConversation](_src_index_.md#linkedinconversation) -- [MINI_COMPANY_TYPE](_src_index_.md#mini_company_type) -- [MINI_PROFILE_TYPE](_src_index_.md#mini_profile_type) -- [MessageEvent](_src_index_.md#messageevent) -- [MessageEventCreateResponse](_src_index_.md#messageeventcreateresponse) -- [MiniProfile](_src_index_.md#miniprofile) -- [MiniProfileUrn](_src_index_.md#miniprofileurn) -- [PROFILE_TYPE](_src_index_.md#profile_type) -- [PeopleSearchHit](_src_index_.md#peoplesearchhit) -- [Profile](_src_index_.md#profile) -- [ProfileId](_src_index_.md#profileid) -- [ProfileUrn](_src_index_.md#profileurn) -- [QuickReplayRecommendation](_src_index_.md#quickreplayrecommendation) +* [AttributeText](_src_index_.md#attributetext) +* [BASE\_COMPANY\_TYPE](_src_index_.md#base_company_type) +* [COMPANY\_TYPE](_src_index_.md#company_type) +* [CONVERSATION\_TYPE](_src_index_.md#conversation_type) +* [Client](_src_index_.md#client) +* [CompanySearchHit](_src_index_.md#companysearchhit) +* [Conversation](_src_index_.md#conversation) +* [ConversationId](_src_index_.md#conversationid) +* [ConversationUrn](_src_index_.md#conversationurn) +* [EVENT\_TYPE](_src_index_.md#event_type) +* [FeaturedType](_src_index_.md#featuredtype) +* [INVITATION\_TYPE](_src_index_.md#invitation_type) +* [Invitation](_src_index_.md#invitation) +* [JOB\_POSTING\_TYPE](_src_index_.md#job_posting_type) +* [LinkedEventCreateResponse](_src_index_.md#linkedeventcreateresponse) +* [LinkedInBaseCompany](_src_index_.md#linkedinbasecompany) +* [LinkedInCollectionResponse](_src_index_.md#linkedincollectionresponse) +* [LinkedInCompany](_src_index_.md#linkedincompany) +* [LinkedInEvent](_src_index_.md#linkedinevent) +* [LinkedInEventUrn](_src_index_.md#linkedineventurn) +* [LinkedInImageAttribute](_src_index_.md#linkedinimageattribute) +* [LinkedInImageViewModel](_src_index_.md#linkedinimageviewmodel) +* [LinkedInInvitation](_src_index_.md#linkedininvitation) +* [LinkedInJobPosting](_src_index_.md#linkedinjobposting) +* [LinkedInJobPostingCompany](_src_index_.md#linkedinjobpostingcompany) +* [LinkedInMessage](_src_index_.md#linkedinmessage) +* [LinkedInMessageEvent](_src_index_.md#linkedinmessageevent) +* [LinkedInMiniCompany](_src_index_.md#linkedinminicompany) +* [LinkedInMiniProfile](_src_index_.md#linkedinminiprofile) +* [LinkedInParticipantReceipts](_src_index_.md#linkedinparticipantreceipts) +* [LinkedInPhotoFilterPicture](_src_index_.md#linkedinphotofilterpicture) +* [LinkedInProfile](_src_index_.md#linkedinprofile) +* [LinkedInSearchCluster](_src_index_.md#linkedinsearchcluster) +* [LinkedInSearchHitV2](_src_index_.md#linkedinsearchhitv2) +* [LinkedInTextViewModel](_src_index_.md#linkedintextviewmodel) +* [LinkedInVectorArtifact](_src_index_.md#linkedinvectorartifact) +* [LinkedInVectorImage](_src_index_.md#linkedinvectorimage) +* [LinkedinConversation](_src_index_.md#linkedinconversation) +* [MINI\_COMPANY\_TYPE](_src_index_.md#mini_company_type) +* [MINI\_PROFILE\_TYPE](_src_index_.md#mini_profile_type) +* [MessageEvent](_src_index_.md#messageevent) +* [MessageEventCreateResponse](_src_index_.md#messageeventcreateresponse) +* [MiniProfile](_src_index_.md#miniprofile) +* [MiniProfileUrn](_src_index_.md#miniprofileurn) +* [PROFILE\_TYPE](_src_index_.md#profile_type) +* [PeopleSearchHit](_src_index_.md#peoplesearchhit) +* [Profile](_src_index_.md#profile) +* [ProfileId](_src_index_.md#profileid) +* [ProfileUrn](_src_index_.md#profileurn) +* [QuickReplayRecommendation](_src_index_.md#quickreplayrecommendation) ## References @@ -65,295 +65,295 @@ Re-exports: [AttributeText](../interfaces/_src_entities_linkedin_attribute_text_entity_.attributetext.md) ---- +___ -### BASE_COMPANY_TYPE +### BASE\_COMPANY\_TYPE -Re-exports: [BASE_COMPANY_TYPE](_src_entities_linkedin_base_company_.md#base_company_type) +Re-exports: [BASE\_COMPANY\_TYPE](_src_entities_linkedin_base_company_.md#base_company_type) ---- +___ -### COMPANY_TYPE +### COMPANY\_TYPE -Re-exports: [COMPANY_TYPE](_src_entities_linkedin_company_entity_.md#company_type) +Re-exports: [COMPANY\_TYPE](_src_entities_linkedin_company_entity_.md#company_type) ---- +___ -### CONVERSATION_TYPE +### CONVERSATION\_TYPE -Re-exports: [CONVERSATION_TYPE](_src_entities_linkedin_conversation_entity_.md#conversation_type) +Re-exports: [CONVERSATION\_TYPE](_src_entities_linkedin_conversation_entity_.md#conversation_type) ---- +___ ### Client Re-exports: [Client](../classes/_src_core_client_.client.md) ---- +___ ### CompanySearchHit Re-exports: [CompanySearchHit](../interfaces/_src_entities_company_search_hit_entity_.companysearchhit.md) ---- +___ ### Conversation Re-exports: [Conversation](../interfaces/_src_entities_conversation_entity_.conversation.md) ---- +___ ### ConversationId Re-exports: [ConversationId](_src_entities_conversation_entity_.md#conversationid) ---- +___ ### ConversationUrn Re-exports: [ConversationUrn](_src_entities_linkedin_conversation_entity_.md#conversationurn) ---- +___ -### EVENT_TYPE +### EVENT\_TYPE -Re-exports: [EVENT_TYPE](_src_entities_linkedin_event_entity_.md#event_type) +Re-exports: [EVENT\_TYPE](_src_entities_linkedin_event_entity_.md#event_type) ---- +___ ### FeaturedType Re-exports: [FeaturedType](../enums/_src_entities_linkedin_conversation_entity_.featuredtype.md) ---- +___ -### INVITATION_TYPE +### INVITATION\_TYPE -Re-exports: [INVITATION_TYPE](_src_entities_linkedin_invitation_entity_.md#invitation_type) +Re-exports: [INVITATION\_TYPE](_src_entities_linkedin_invitation_entity_.md#invitation_type) ---- +___ ### Invitation Re-exports: [Invitation](../interfaces/_src_entities_invitation_entity_.invitation.md) ---- +___ -### JOB_POSTING_TYPE +### JOB\_POSTING\_TYPE -Re-exports: [JOB_POSTING_TYPE](_src_entities_linkedin_job_posting_.md#job_posting_type) +Re-exports: [JOB\_POSTING\_TYPE](_src_entities_linkedin_job_posting_.md#job_posting_type) ---- +___ ### LinkedEventCreateResponse Re-exports: [LinkedEventCreateResponse](../interfaces/_src_entities_linkedin_event_create_response_.linkedeventcreateresponse.md) ---- +___ ### LinkedInBaseCompany Re-exports: [LinkedInBaseCompany](../interfaces/_src_entities_linkedin_base_company_.linkedinbasecompany.md) ---- +___ ### LinkedInCollectionResponse Re-exports: [LinkedInCollectionResponse](../interfaces/_src_entities_linkedin_collection_response_entity_.linkedincollectionresponse.md) ---- +___ ### LinkedInCompany Re-exports: [LinkedInCompany](../interfaces/_src_entities_linkedin_company_entity_.linkedincompany.md) ---- +___ ### LinkedInEvent Re-exports: [LinkedInEvent](../interfaces/_src_entities_linkedin_event_entity_.linkedinevent.md) ---- +___ ### LinkedInEventUrn Re-exports: [LinkedInEventUrn](_src_entities_linkedin_event_entity_.md#linkedineventurn) ---- +___ ### LinkedInImageAttribute Re-exports: [LinkedInImageAttribute](../interfaces/_src_entities_linkedin_image_attribute_entity_.linkedinimageattribute.md) ---- +___ ### LinkedInImageViewModel Re-exports: [LinkedInImageViewModel](../interfaces/_src_entities_linkedin_image_view_model_entity_.linkedinimageviewmodel.md) ---- +___ ### LinkedInInvitation Re-exports: [LinkedInInvitation](../interfaces/_src_entities_linkedin_invitation_entity_.linkedininvitation.md) ---- +___ ### LinkedInJobPosting Re-exports: [LinkedInJobPosting](../interfaces/_src_entities_linkedin_job_posting_.linkedinjobposting.md) ---- +___ ### LinkedInJobPostingCompany Re-exports: [LinkedInJobPostingCompany](../interfaces/_src_entities_linkedin_job_posting_.linkedinjobpostingcompany.md) ---- +___ ### LinkedInMessage Re-exports: [LinkedInMessage](../interfaces/_src_entities_linkedin_message_entity_.linkedinmessage.md) ---- +___ ### LinkedInMessageEvent Re-exports: [LinkedInMessageEvent](../interfaces/_src_entities_linkedin_message_event_entity_.linkedinmessageevent.md) ---- +___ ### LinkedInMiniCompany Re-exports: [LinkedInMiniCompany](../interfaces/_src_entities_linkedin_mini_company_entity_.linkedinminicompany.md) ---- +___ ### LinkedInMiniProfile Re-exports: [LinkedInMiniProfile](../interfaces/_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md) ---- +___ ### LinkedInParticipantReceipts Re-exports: [LinkedInParticipantReceipts](../interfaces/_src_entities_linkedin_conversation_entity_.linkedinparticipantreceipts.md) ---- +___ ### LinkedInPhotoFilterPicture Re-exports: [LinkedInPhotoFilterPicture](../interfaces/_src_entities_linkedin_profile_entity_.linkedinphotofilterpicture.md) ---- +___ ### LinkedInProfile Re-exports: [LinkedInProfile](../interfaces/_src_entities_linkedin_profile_entity_.linkedinprofile.md) ---- +___ ### LinkedInSearchCluster Re-exports: [LinkedInSearchCluster](../interfaces/_src_entities_linkedin_search_cluster_entity_.linkedinsearchcluster.md) ---- +___ ### LinkedInSearchHitV2 Re-exports: [LinkedInSearchHitV2](../interfaces/_src_entities_linkedin_search_hit_v2_entity_.linkedinsearchhitv2.md) ---- +___ ### LinkedInTextViewModel Re-exports: [LinkedInTextViewModel](../interfaces/_src_entities_linkedin_text_view_model_entity_.linkedintextviewmodel.md) ---- +___ ### LinkedInVectorArtifact Re-exports: [LinkedInVectorArtifact](../interfaces/_src_entities_linkedin_vector_artifact_entity_.linkedinvectorartifact.md) ---- +___ ### LinkedInVectorImage Re-exports: [LinkedInVectorImage](../interfaces/_src_entities_linkedin_vector_image_entity_.linkedinvectorimage.md) ---- +___ ### LinkedinConversation Re-exports: [LinkedinConversation](../interfaces/_src_entities_linkedin_conversation_entity_.linkedinconversation.md) ---- +___ -### MINI_COMPANY_TYPE +### MINI\_COMPANY\_TYPE -Re-exports: [MINI_COMPANY_TYPE](_src_entities_linkedin_mini_company_entity_.md#mini_company_type) +Re-exports: [MINI\_COMPANY\_TYPE](_src_entities_linkedin_mini_company_entity_.md#mini_company_type) ---- +___ -### MINI_PROFILE_TYPE +### MINI\_PROFILE\_TYPE -Re-exports: [MINI_PROFILE_TYPE](_src_entities_linkedin_mini_profile_entity_.md#mini_profile_type) +Re-exports: [MINI\_PROFILE\_TYPE](_src_entities_linkedin_mini_profile_entity_.md#mini_profile_type) ---- +___ ### MessageEvent Re-exports: [MessageEvent](../interfaces/_src_entities_message_event_entity_.messageevent.md) ---- +___ ### MessageEventCreateResponse Re-exports: [MessageEventCreateResponse](../interfaces/_src_entities_message_create_response_entity_.messageeventcreateresponse.md) ---- +___ ### MiniProfile Re-exports: [MiniProfile](../interfaces/_src_entities_mini_profile_entity_.miniprofile.md) ---- +___ ### MiniProfileUrn Re-exports: [MiniProfileUrn](_src_entities_linkedin_mini_profile_entity_.md#miniprofileurn) ---- +___ -### PROFILE_TYPE +### PROFILE\_TYPE -Re-exports: [PROFILE_TYPE](_src_entities_linkedin_profile_entity_.md#profile_type) +Re-exports: [PROFILE\_TYPE](_src_entities_linkedin_profile_entity_.md#profile_type) ---- +___ ### PeopleSearchHit Re-exports: [PeopleSearchHit](../interfaces/_src_entities_people_search_hit_entity_.peoplesearchhit.md) ---- +___ ### Profile Re-exports: [Profile](../interfaces/_src_entities_profile_entity_.profile.md) ---- +___ ### ProfileId Re-exports: [ProfileId](_src_entities_mini_profile_entity_.md#profileid) ---- +___ ### ProfileUrn Re-exports: [ProfileUrn](_src_entities_linkedin_profile_entity_.md#profileurn) ---- +___ ### QuickReplayRecommendation diff --git a/docs/modules/_src_repositories_profile_repository_.md b/docs/modules/_src_repositories_profile_repository_.md index 31d3bdf1..13105eaa 100644 --- a/docs/modules/_src_repositories_profile_repository_.md +++ b/docs/modules/_src_repositories_profile_repository_.md @@ -8,11 +8,11 @@ ### Classes -- [ProfileRepository](../classes/_src_repositories_profile_repository_.profilerepository.md) +* [ProfileRepository](../classes/_src_repositories_profile_repository_.profilerepository.md) ### Functions -- [getProfilesFromResponse](_src_repositories_profile_repository_.md#getprofilesfromresponse) +* [getProfilesFromResponse](_src_repositories_profile_repository_.md#getprofilesfromresponse) ## Functions @@ -20,18 +20,18 @@ ▸ `Const`**getProfilesFromResponse**(`response`: T): Record<[ProfileId](_src_entities_mini_profile_entity_.md#profileid), [MiniProfile](../interfaces/_src_entities_mini_profile_entity_.miniprofile.md)\> -_Defined in [src/repositories/profile.repository.ts:20](https://github.com/eilonmore/linkedin-private-api/blob/84c9c15/src/repositories/profile.repository.ts#L20)_ +*Defined in [src/repositories/profile.repository.ts:20](https://github.com/brunohafonso95/linkedin-private-api/blob/466124d/src/repositories/profile.repository.ts#L20)* #### Type parameters: -| Name | Type | -| ---- | ---------------------------------------------------------------------------------------------------------------------------------------------- | -| `T` | { included: ([LinkedInMiniProfile](../interfaces/_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md) \| { $type: string })[] } | +Name | Type | +------ | ------ | +`T` | { included: ([LinkedInMiniProfile](../interfaces/_src_entities_linkedin_mini_profile_entity_.linkedinminiprofile.md) \| { $type: string })[] } | #### Parameters: -| Name | Type | -| ---------- | ---- | -| `response` | T | +Name | Type | +------ | ------ | +`response` | T | **Returns:** Record<[ProfileId](_src_entities_mini_profile_entity_.md#profileid), [MiniProfile](../interfaces/_src_entities_mini_profile_entity_.miniprofile.md)\> diff --git a/docs/modules/_src_scrollers_index_.md b/docs/modules/_src_scrollers_index_.md index 229ee9e2..6e54e941 100644 --- a/docs/modules/_src_scrollers_index_.md +++ b/docs/modules/_src_scrollers_index_.md @@ -8,11 +8,11 @@ ### References -- [ConversationScroller](_src_scrollers_index_.md#conversationscroller) -- [InvitationScroller](_src_scrollers_index_.md#invitationscroller) -- [JobSearchScroller](_src_scrollers_index_.md#jobsearchscroller) -- [MessageScroller](_src_scrollers_index_.md#messagescroller) -- [PeopleSearchScroller](_src_scrollers_index_.md#peoplesearchscroller) +* [ConversationScroller](_src_scrollers_index_.md#conversationscroller) +* [InvitationScroller](_src_scrollers_index_.md#invitationscroller) +* [JobSearchScroller](_src_scrollers_index_.md#jobsearchscroller) +* [MessageScroller](_src_scrollers_index_.md#messagescroller) +* [PeopleSearchScroller](_src_scrollers_index_.md#peoplesearchscroller) ## References @@ -20,25 +20,25 @@ Re-exports: [ConversationScroller](../classes/_src_scrollers_conversation_scroller_.conversationscroller.md) ---- +___ ### InvitationScroller Re-exports: [InvitationScroller](../classes/_src_scrollers_invitation_scroller_.invitationscroller.md) ---- +___ ### JobSearchScroller Re-exports: [JobSearchScroller](../classes/_src_scrollers_job_search_scroller_.jobsearchscroller.md) ---- +___ ### MessageScroller Re-exports: [MessageScroller](../classes/_src_scrollers_message_scroller_.messagescroller.md) ---- +___ ### PeopleSearchScroller diff --git a/docs/modules/_src_scrollers_job_search_scroller_.md b/docs/modules/_src_scrollers_job_search_scroller_.md index c20a11c6..a62fd953 100644 --- a/docs/modules/_src_scrollers_job_search_scroller_.md +++ b/docs/modules/_src_scrollers_job_search_scroller_.md @@ -8,4 +8,4 @@ ### Classes -- [JobSearchScroller](../classes/_src_scrollers_job_search_scroller_.jobsearchscroller.md) +* [JobSearchScroller](../classes/_src_scrollers_job_search_scroller_.jobsearchscroller.md) diff --git a/examples/conversation.ts b/examples/conversation.ts index 2b65a1d6..033f1000 100644 --- a/examples/conversation.ts +++ b/examples/conversation.ts @@ -11,6 +11,7 @@ const password = process.env.PASSWORD as string; const conversations = await conversationScroller.scrollNext(); const conversation = await client.conversation.getConversation({ conversationId: conversations[0].conversationId }); + const conversationAsRead = await client.conversation.markConversationAsRead({ conversationId: conversations[0].conversationId }); - console.log(conversations, conversation); + console.log(conversations, conversation, conversationAsRead); })(); diff --git a/package.json b/package.json index fa81bda5..43fdbdaf 100644 --- a/package.json +++ b/package.json @@ -29,8 +29,8 @@ "lint": "eslint -p tsconfig.json -c tslint.json", "typecheck": "eslint --ext .ts --ext .js src", "build": "rimraf dist && tsc -p tsconfig.build.json", - "test": "NODE_ENV=test jest", - "test:coverage": "yarn test -- --coverage", + "test": "NODE_ENV=test jest --maxWorkers=50%", + "test:coverage": "yarn test --maxWorkers=50% -- --coverage", "prepublish": "yarn docs && yarn build", "prepare": "yarn docs && yarn build", "docs": "rimraf docs && typedoc --plugin typedoc-plugin-markdown --out docs src" diff --git a/src/repositories/conversation.repository.ts b/src/repositories/conversation.repository.ts index 254c2938..4cbf6b61 100644 --- a/src/repositories/conversation.repository.ts +++ b/src/repositories/conversation.repository.ts @@ -21,7 +21,6 @@ const transformConversations = ({ conversations.map(conversation => { const participants = map(conversation['*participants'], participant => { const profileId = participantToProfileId(participant); - return profiles[profileId]; }) as MiniProfile[]; @@ -39,6 +38,11 @@ export class ConversationRepository { this.client = client; } + async markConversationAsRead({ conversationId }: { conversationId: ConversationId }): Promise { + await this.client.request.conversation.markConversationAsRead({ conversationId }); + return this.getConversation({ conversationId }); + } + async getConversation({ conversationId }: { conversationId: ConversationId }): Promise { const response = await this.client.request.conversation.getConversation({ conversationId }); const conversation = response.data; diff --git a/src/requests/conversation.request.ts b/src/requests/conversation.request.ts index f15f0878..1155f362 100644 --- a/src/requests/conversation.request.ts +++ b/src/requests/conversation.request.ts @@ -40,4 +40,15 @@ export class ConversationRequest { params: queryParams, }); } + + markConversationAsRead({ conversationId }: { conversationId: ConversationId }): Promise { + const payload = { + patch: { + $set: { + read: true + } + } + }; + return this.request.post(`messaging/conversations/${conversationId}`, payload); + } }