@unipile/sdk 2.0.0 → 2.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -7
- package/dist/client/client.gen.d.ts +3 -0
- package/dist/client/client.gen.d.ts.map +1 -0
- package/dist/client/client.gen.js +238 -0
- package/dist/client/index.d.ts +9 -0
- package/dist/client/index.d.ts.map +1 -0
- package/dist/client/index.js +17 -0
- package/dist/client/types.gen.d.ts +118 -0
- package/dist/client/types.gen.d.ts.map +1 -0
- package/dist/client/types.gen.js +3 -0
- package/dist/client/utils.gen.d.ts +34 -0
- package/dist/client/utils.gen.d.ts.map +1 -0
- package/dist/client/utils.gen.js +241 -0
- package/dist/client.gen.d.ts +13 -0
- package/dist/client.gen.d.ts.map +1 -0
- package/dist/client.gen.js +6 -0
- package/dist/core/auth.gen.d.ts +19 -0
- package/dist/core/auth.gen.d.ts.map +1 -0
- package/dist/core/auth.gen.js +18 -0
- package/dist/core/bodySerializer.gen.d.ts +26 -0
- package/dist/core/bodySerializer.gen.d.ts.map +1 -0
- package/dist/core/bodySerializer.gen.js +60 -0
- package/dist/core/params.gen.d.ts +44 -0
- package/dist/core/params.gen.d.ts.map +1 -0
- package/dist/core/params.gen.js +104 -0
- package/dist/core/pathSerializer.gen.d.ts +34 -0
- package/dist/core/pathSerializer.gen.d.ts.map +1 -0
- package/dist/core/pathSerializer.gen.js +115 -0
- package/dist/core/queryKeySerializer.gen.d.ts +19 -0
- package/dist/core/queryKeySerializer.gen.d.ts.map +1 -0
- package/dist/core/queryKeySerializer.gen.js +98 -0
- package/dist/core/serverSentEvents.gen.d.ts +72 -0
- package/dist/core/serverSentEvents.gen.d.ts.map +1 -0
- package/dist/core/serverSentEvents.gen.js +137 -0
- package/dist/core/types.gen.d.ts +79 -0
- package/dist/core/types.gen.d.ts.map +1 -0
- package/dist/core/types.gen.js +3 -0
- package/dist/core/utils.gen.d.ts +20 -0
- package/dist/core/utils.gen.d.ts.map +1 -0
- package/dist/core/utils.gen.js +93 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +16 -0
- package/dist/sdk.gen.d.ts +1187 -0
- package/dist/sdk.gen.d.ts.map +1 -0
- package/dist/sdk.gen.js +2605 -0
- package/dist/types.gen.d.ts +41328 -0
- package/dist/types.gen.d.ts.map +1 -0
- package/dist/types.gen.js +3 -0
- package/package.json +6 -2
|
@@ -0,0 +1,1187 @@
|
|
|
1
|
+
import type { Client, Options as Options2, TDataShape } from './client';
|
|
2
|
+
import type { AcceptRelationRequestData, AcceptRelationRequestResponses, AddMessageReactionData, AddMessageReactionResponses, AddParticipantData, AddParticipantResponses, AddPostCommentData, AddPostCommentReactionData, AddPostCommentReactionResponses, AddPostCommentResponses, AddPostReactionData, AddPostReactionResponses, BrowseSalesAccountListData, BrowseSalesAccountListResponses, BrowseSalesLeadListData, BrowseSalesLeadListResponses, CancelRelationRequestData, CancelRelationRequestResponses, CloseClassicJobPostingData, CloseClassicJobPostingResponses, CloseRecruiterJobPostingData, CloseRecruiterJobPostingResponses, CreateAuthLinkData, CreateAuthLinkResponses, CreateCalendarData, CreateCalendarEventData, CreateCalendarEventResponses, CreateCalendarResponses, CreateClassicJobPostingDraftData, CreateClassicJobPostingDraftResponses, CreateDraftData, CreateDraftResponses, CreateFolderData, CreateFolderResponses, CreatePostData, CreatePostResponses, CreateRecruiterHiringProjectData, CreateRecruiterHiringProjectResponses, CreateRecruiterJobPostingDraftInExistingProjectData, CreateRecruiterJobPostingDraftInExistingProjectResponses, CreateRecruiterJobPostingDraftInNewProjectData, CreateRecruiterJobPostingDraftInNewProjectResponses, CreateRelationRequestData, CreateRelationRequestResponses, CreateWebhookEndpointData, CreateWebhookEndpointResponses, DeleteCalendarData, DeleteCalendarEventData, DeleteCalendarEventResponses, DeleteCalendarResponses, DeleteChatData, DeleteChatResponses, DeleteDraftData, DeleteDraftResponses, DeleteFolderData, DeleteFolderResponses, DeleteMessageData, DeleteMessageResponses, DeletePostCommentData, DeletePostCommentResponses, DeletePostData, DeletePostResponses, DeleteRelationData, DeleteRelationResponses, DeleteWebhookEndpointData, DeleteWebhookEndpointResponses, EditClassicJobPostingData, EditClassicJobPostingResponses, EditRecruiterHiringProjectData, EditRecruiterHiringProjectResponses, EditRecruiterJobPostingData, EditRecruiterJobPostingResponses, EndorseClassicMemberSkillData, EndorseClassicMemberSkillResponses, FollowUserData, FollowUserResponses, ForwardMessageData, ForwardMessageResponses, GetAccountData, GetAccountResponses, GetAttachment1Data, GetAttachment1Responses, GetAttachmentData, GetAttachmentResponses, GetAvailableContractsData, GetAvailableContractsResponses, GetCalendarData, GetCalendarEventData, GetCalendarEventListData, GetCalendarEventListResponses, GetCalendarEventResponses, GetCalendarResponses, GetCalendarsListData, GetCalendarsListResponses, GetChatData, GetChatResponses, GetChatsListData, GetChatsListResponses, GetClassicApplicantByIdData, GetClassicApplicantByIdResponses, GetClassicApplicantResumeData, GetClassicApplicantResumeResponses, GetClassicApplicantsData, GetClassicApplicantsResponses, GetClassicCompanyProfileData, GetClassicCompanyProfileResponses, GetClassicJobPostingBudgetData, GetClassicJobPostingBudgetResponses, GetClassicJobPostingData, GetClassicJobPostingResponses, GetClassicSearchParametersData, GetClassicSearchParametersResponses, GetDraftData, GetDraftResponses, GetDraftsListData, GetDraftsListResponses, GetEmailContactsListData, GetEmailContactsListResponses, GetEmailData, GetEmailResponses, GetEmailsListData, GetEmailsListResponses, GetFolderData, GetFolderEmailsListData, GetFolderEmailsListResponses, GetFolderResponses, GetFoldersListData, GetFoldersListResponses, GetInboxChatsListData, GetInboxChatsListResponses, GetInboxesListData, GetInboxesListResponses, GetInmailCreditsData, GetInmailCreditsResponses, GetMessageData, GetMessageReactionsListData, GetMessageReactionsListResponses, GetMessageResponses, GetMessagesListData, GetMessagesListResponses, GetParticipantsListData, GetParticipantsListResponses, GetPostCommentReactionsListData, GetPostCommentReactionsListResponses, GetPostCommentRepliesListData, GetPostCommentRepliesListResponses, GetPostCommentsListData, GetPostCommentsListResponses, GetPostData, GetPostReactionsListData, GetPostReactionsListResponses, GetPostResponses, GetPostsListData, GetPostsListResponses, GetRecruiterApplicantByIdData, GetRecruiterApplicantByIdResponses, GetRecruiterApplicantResumeData, GetRecruiterApplicantResumeResponses, GetRecruiterHiringProjectData, GetRecruiterHiringProjectListData, GetRecruiterHiringProjectListResponses, GetRecruiterHiringProjectResponses, GetRecruiterJobPostingBudgetData, GetRecruiterJobPostingBudgetResponses, GetRecruiterJobPostingByIdData, GetRecruiterJobPostingByIdResponses, GetRecruiterJobPostingByProjectIdData, GetRecruiterJobPostingByProjectIdResponses, GetRecruiterJobPostingListData, GetRecruiterJobPostingListResponses, GetRecruiterPipelineCandidatesData, GetRecruiterPipelineCandidatesResponses, GetRecruiterSearchParametersData, GetRecruiterSearchParametersResponses, GetRecruiterTalentPoolApplicantsData, GetRecruiterTalentPoolApplicantsResponses, GetRelationRequestsListData, GetRelationRequestsListResponses, GetSalesAccountListsData, GetSalesAccountListsResponses, GetSalesLeadListsData, GetSalesLeadListsResponses, GetSalesSearchParametersData, GetSalesSearchParametersResponses, GetThreadData, GetThreadResponses, GetUserChatData, GetUserChatResponses, GetUserCommentsListData, GetUserCommentsListResponses, GetUserProfileData, GetUserProfileResponses, GetUserReactionsListData, GetUserReactionsListResponses, GetUserRelationsData, GetUserRelationsResponses, GetWebhookEndpointData, GetWebhookEndpointResponses, ListAccountsData, ListAccountsResponses, ListClassicUserJobPostingsData, ListClassicUserJobPostingsResponses, ListUserFollowersData, ListUserFollowersResponses, ListUserFollowingData, ListUserFollowingResponses, ListWebhookConversationsData, ListWebhookConversationsResponses, ListWebhookEndpointsData, ListWebhookEndpointsResponses, ModifyEmailData, ModifyEmailResponses, ModifyMessageData, ModifyMessageResponses, PerformClassicCompaniesSearchData, PerformClassicCompaniesSearchResponses, PerformClassicJobsSearchData, PerformClassicJobsSearchResponses, PerformClassicPeopleSearchData, PerformClassicPeopleSearchResponses, PerformClassicPostsSearchData, PerformClassicPostsSearchResponses, PerformClassicSearchFromUrlData, PerformClassicSearchFromUrlResponses, PerformRecruiterPeopleSearchData, PerformRecruiterPeopleSearchFromTalentPoolData, PerformRecruiterPeopleSearchFromTalentPoolResponses, PerformRecruiterPeopleSearchResponses, PerformRecruiterSearchFromUrlData, PerformRecruiterSearchFromUrlResponses, PerformSalesCompaniesSearchData, PerformSalesCompaniesSearchResponses, PerformSalesPeopleSearchData, PerformSalesPeopleSearchResponses, PerformSalesSearchFromUrlData, PerformSalesSearchFromUrlResponses, ProxyRequestData, ProxyRequestResponses, PublishClassicJobPostingData, PublishClassicJobPostingResponses, PublishRecruiterJobPostingData, PublishRecruiterJobPostingResponses, ReadEmailData, ReadEmailResponses, ReadMessageData, ReadMessageResponses, RemoveAccountData, RemoveAccountResponses, RemoveMessageReactionData, RemoveMessageReactionResponses, RemoveParticipantData, RemoveParticipantResponses, RemovePostCommentReactionData, RemovePostCommentReactionResponses, RemovePostReactionData, RemovePostReactionResponses, ReplyToCommentData, ReplyToCommentResponses, SaveRecruiterCandidateToPipelineData, SaveRecruiterCandidateToPipelineResponses, SaveSalesAccountToListData, SaveSalesAccountToListResponses, SaveSalesLeadToListData, SaveSalesLeadToListResponses, SearchLocationsData, SearchLocationsResponses, SelectContractData, SelectContractResponses, SendDraftData, SendDraftResponses, SendEmailData, SendEmailResponses, SendMessageData, SendMessageResponses, SetComposingStatusData, SetComposingStatusResponses, SetPresenceData, SetPresenceResponses, SolveCheckpointData, SolveCheckpointResponses, StartAuthIntentData, StartAuthIntentResponses, StartChatData, StartChatFromInboxData, StartChatFromInboxResponses, StartChatResponses, SubmitClassicCompanyOtpCodeData, SubmitClassicCompanyOtpCodeResponses, SubmitRecruiterOtpCodeData, SubmitRecruiterOtpCodeResponses, TrashEmailData, TrashEmailResponses, UnfollowUserData, UnfollowUserResponses, UnreadEmailData, UnreadEmailResponses, UpdateAccountData, UpdateAccountResponses, UpdateCalendarData, UpdateCalendarEventData, UpdateCalendarEventResponses, UpdateCalendarResponses, UpdateChatData, UpdateChatResponses, UpdateDraftData, UpdateDraftResponses, UpdateFolderData, UpdateFolderResponses, UpdatePostCommentData, UpdatePostCommentResponses, UpdatePostData, UpdatePostResponses, UpdateUserProfileData, UpdateUserProfileResponses, UpdateWebhookEndpointData, UpdateWebhookEndpointResponses, VerifyClassicCompanyMemberIdentityData, VerifyClassicCompanyMemberIdentityResponses, VerifyRecruiterCompanyMemberIdentityData, VerifyRecruiterCompanyMemberIdentityResponses, VisitUserProfileData, VisitUserProfileResponses } from './types.gen';
|
|
3
|
+
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options2<TData, ThrowOnError> & {
|
|
4
|
+
/**
|
|
5
|
+
* You can provide a client instance returned by `createClient()` instead of
|
|
6
|
+
* individual options. This might be also useful if you want to implement a
|
|
7
|
+
* custom client.
|
|
8
|
+
*/
|
|
9
|
+
client?: Client;
|
|
10
|
+
/**
|
|
11
|
+
* You can pass arbitrary values through the `meta` object. This can be
|
|
12
|
+
* used to access values that aren't defined as part of the SDK function.
|
|
13
|
+
*/
|
|
14
|
+
meta?: Record<string, unknown>;
|
|
15
|
+
};
|
|
16
|
+
declare class HeyApiClient {
|
|
17
|
+
protected client: Client;
|
|
18
|
+
constructor(args?: {
|
|
19
|
+
client?: Client;
|
|
20
|
+
});
|
|
21
|
+
}
|
|
22
|
+
declare class HeyApiRegistry<T> {
|
|
23
|
+
private readonly defaultKey;
|
|
24
|
+
private readonly instances;
|
|
25
|
+
get(key?: string): T;
|
|
26
|
+
set(value: T, key?: string): void;
|
|
27
|
+
}
|
|
28
|
+
declare class HeyApiRegistry2<T> {
|
|
29
|
+
private readonly defaultKey;
|
|
30
|
+
private readonly instances;
|
|
31
|
+
get(key?: string): T;
|
|
32
|
+
set(value: T, key?: string): void;
|
|
33
|
+
}
|
|
34
|
+
declare class HeyApiRegistry3<T> {
|
|
35
|
+
private readonly defaultKey;
|
|
36
|
+
private readonly instances;
|
|
37
|
+
get(key?: string): T;
|
|
38
|
+
set(value: T, key?: string): void;
|
|
39
|
+
}
|
|
40
|
+
declare class HeyApiRegistry4<T> {
|
|
41
|
+
private readonly defaultKey;
|
|
42
|
+
private readonly instances;
|
|
43
|
+
get(key?: string): T;
|
|
44
|
+
set(value: T, key?: string): void;
|
|
45
|
+
}
|
|
46
|
+
declare class HeyApiRegistry5<T> {
|
|
47
|
+
private readonly defaultKey;
|
|
48
|
+
private readonly instances;
|
|
49
|
+
get(key?: string): T;
|
|
50
|
+
set(value: T, key?: string): void;
|
|
51
|
+
}
|
|
52
|
+
declare class HeyApiRegistry6<T> {
|
|
53
|
+
private readonly defaultKey;
|
|
54
|
+
private readonly instances;
|
|
55
|
+
get(key?: string): T;
|
|
56
|
+
set(value: T, key?: string): void;
|
|
57
|
+
}
|
|
58
|
+
declare class HeyApiRegistry7<T> {
|
|
59
|
+
private readonly defaultKey;
|
|
60
|
+
private readonly instances;
|
|
61
|
+
get(key?: string): T;
|
|
62
|
+
set(value: T, key?: string): void;
|
|
63
|
+
}
|
|
64
|
+
declare class HeyApiRegistry8<T> {
|
|
65
|
+
private readonly defaultKey;
|
|
66
|
+
private readonly instances;
|
|
67
|
+
get(key?: string): T;
|
|
68
|
+
set(value: T, key?: string): void;
|
|
69
|
+
}
|
|
70
|
+
declare class HeyApiRegistry9<T> {
|
|
71
|
+
private readonly defaultKey;
|
|
72
|
+
private readonly instances;
|
|
73
|
+
get(key?: string): T;
|
|
74
|
+
set(value: T, key?: string): void;
|
|
75
|
+
}
|
|
76
|
+
declare class HeyApiRegistry10<T> {
|
|
77
|
+
private readonly defaultKey;
|
|
78
|
+
private readonly instances;
|
|
79
|
+
get(key?: string): T;
|
|
80
|
+
set(value: T, key?: string): void;
|
|
81
|
+
}
|
|
82
|
+
declare class HeyApiRegistry11<T> {
|
|
83
|
+
private readonly defaultKey;
|
|
84
|
+
private readonly instances;
|
|
85
|
+
get(key?: string): T;
|
|
86
|
+
set(value: T, key?: string): void;
|
|
87
|
+
}
|
|
88
|
+
export declare class UnipileMessaging extends HeyApiClient {
|
|
89
|
+
static readonly __registry: HeyApiRegistry<UnipileMessaging>;
|
|
90
|
+
constructor(args?: {
|
|
91
|
+
client?: Client;
|
|
92
|
+
key?: string;
|
|
93
|
+
});
|
|
94
|
+
/**
|
|
95
|
+
* List all Chats
|
|
96
|
+
*
|
|
97
|
+
* Returns a list of account's chats, whatever the inbox they belong to. The chats are returned sorted by their last message date, with the most recent appearing first. You might want to use the <a href="https://developer.unipile.com/v2.0/reference/get_v2-account-id-inboxes-inbox-id-chats">List inbox Chats</a> instead if not supported by the provider. Filters are applied with an AND logic if supported by the provider.
|
|
98
|
+
*/
|
|
99
|
+
getChatsList<ThrowOnError extends boolean = false>(options: Options<GetChatsListData, ThrowOnError>): import("./client").RequestResult<GetChatsListResponses, unknown, ThrowOnError, "fields">;
|
|
100
|
+
/**
|
|
101
|
+
* List all Inboxes
|
|
102
|
+
*
|
|
103
|
+
* Returns a list of the account's Inboxes.
|
|
104
|
+
*/
|
|
105
|
+
getInboxesList<ThrowOnError extends boolean = false>(options: Options<GetInboxesListData, ThrowOnError>): import("./client").RequestResult<GetInboxesListResponses, unknown, ThrowOnError, "fields">;
|
|
106
|
+
/**
|
|
107
|
+
* List Inbox Chats
|
|
108
|
+
*
|
|
109
|
+
* Returns a list of account's chats from a specific inbox. The chats are returned sorted by their last message date, with the most recent appearing first. Filters are applied with an AND logic if supported by the provider.
|
|
110
|
+
*/
|
|
111
|
+
getInboxChatsList<ThrowOnError extends boolean = false>(options: Options<GetInboxChatsListData, ThrowOnError>): import("./client").RequestResult<GetInboxChatsListResponses, unknown, ThrowOnError, "fields">;
|
|
112
|
+
/**
|
|
113
|
+
* Delete a Chat
|
|
114
|
+
*
|
|
115
|
+
* Deletes a chat if supported by the provider.
|
|
116
|
+
*/
|
|
117
|
+
deleteChat<ThrowOnError extends boolean = false>(options: Options<DeleteChatData, ThrowOnError>): import("./client").RequestResult<DeleteChatResponses, unknown, ThrowOnError, "fields">;
|
|
118
|
+
/**
|
|
119
|
+
* Get a Chat
|
|
120
|
+
*
|
|
121
|
+
* Retrieves a Chat object.
|
|
122
|
+
*/
|
|
123
|
+
getChat<ThrowOnError extends boolean = false>(options: Options<GetChatData, ThrowOnError>): import("./client").RequestResult<GetChatResponses, unknown, ThrowOnError, "fields">;
|
|
124
|
+
/**
|
|
125
|
+
* Update a Chat
|
|
126
|
+
*
|
|
127
|
+
* Updates the specified chat by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
128
|
+
*/
|
|
129
|
+
updateChat<ThrowOnError extends boolean = false>(options: Options<UpdateChatData, ThrowOnError>): import("./client").RequestResult<UpdateChatResponses, unknown, ThrowOnError, "fields">;
|
|
130
|
+
/**
|
|
131
|
+
* Get a User Chat
|
|
132
|
+
*
|
|
133
|
+
* Resolves chat identifiers associated with the specified User. Depending on the provider, the result may include chats with or without message history, and may return multiple matches across inboxes or contexts.
|
|
134
|
+
*/
|
|
135
|
+
getUserChat<ThrowOnError extends boolean = false>(options: Options<GetUserChatData, ThrowOnError>): import("./client").RequestResult<GetUserChatResponses, unknown, ThrowOnError, "fields">;
|
|
136
|
+
/**
|
|
137
|
+
* Start a Chat
|
|
138
|
+
*
|
|
139
|
+
* Starts a new 1to1 or group chat by sending the first message.
|
|
140
|
+
* <br/>
|
|
141
|
+
* Use <a href="https://developer.unipile.com/v2.0/reference/post_v2-account-id-chats-chat-id-messages-send">Send a Message</a> if a conversation already exist with the wanted user(s).
|
|
142
|
+
* <br/>
|
|
143
|
+
* Use <a href="https://developer.unipile.com/v2.0/reference/post_v2-account-id-inboxes-inbox-id-chats">Start a Chat from Inbox</a> if the provider uses the inbox concept.
|
|
144
|
+
* <br/>
|
|
145
|
+
* Multipart supported, refer to <a href="https://developer.unipile.com/v2.0/reference/api-usage#sending-files">Sending Files</a>.
|
|
146
|
+
*/
|
|
147
|
+
startChat<ThrowOnError extends boolean = false>(options: Options<StartChatData, ThrowOnError>): import("./client").RequestResult<StartChatResponses, unknown, ThrowOnError, "fields">;
|
|
148
|
+
/**
|
|
149
|
+
* Start a Chat from Inbox
|
|
150
|
+
*
|
|
151
|
+
* Starts a new 1to1 or group chat in the given inbox by sending the first message.
|
|
152
|
+
* <br/>
|
|
153
|
+
* Use <a href="https://developer.unipile.com/v2.0/reference/post_v2-account-id-chats-chat-id-messages-send">Send a Message</a> if a conversation already exist with the wanted user(s).
|
|
154
|
+
* <br/>
|
|
155
|
+
* Use <a href="https://developer.unipile.com/v2.0/reference/post_v2-account-id-chats-send">Start a Chat</a> instead if the provider does not use the inbox concept.
|
|
156
|
+
*
|
|
157
|
+
* <br/>
|
|
158
|
+
* Multipart supported, refer to <a href="https://developer.unipile.com/v2.0/reference/api-usage#sending-files">Sending Files</a>.
|
|
159
|
+
*/
|
|
160
|
+
startChatFromInbox<ThrowOnError extends boolean = false>(options: Options<StartChatFromInboxData, ThrowOnError>): import("./client").RequestResult<StartChatFromInboxResponses, unknown, ThrowOnError, "fields">;
|
|
161
|
+
/**
|
|
162
|
+
* List all Chat Messages
|
|
163
|
+
*
|
|
164
|
+
* Returns a list of messages in a chat. The messages are returned sorted by their timestamp, with the most recent appearing first.
|
|
165
|
+
*/
|
|
166
|
+
getMessagesList<ThrowOnError extends boolean = false>(options: Options<GetMessagesListData, ThrowOnError>): import("./client").RequestResult<GetMessagesListResponses, unknown, ThrowOnError, "fields">;
|
|
167
|
+
/**
|
|
168
|
+
* Delete a Message
|
|
169
|
+
*
|
|
170
|
+
* Deletes one of your own messages. Depending of the provider, the message might still be visible as deleted.
|
|
171
|
+
* <br />
|
|
172
|
+
* Trying to delete the message of another user will fail.
|
|
173
|
+
*/
|
|
174
|
+
deleteMessage<ThrowOnError extends boolean = false>(options: Options<DeleteMessageData, ThrowOnError>): import("./client").RequestResult<DeleteMessageResponses, unknown, ThrowOnError, "fields">;
|
|
175
|
+
/**
|
|
176
|
+
* Get a Message
|
|
177
|
+
*
|
|
178
|
+
* Retrieves a message object.
|
|
179
|
+
*/
|
|
180
|
+
getMessage<ThrowOnError extends boolean = false>(options: Options<GetMessageData, ThrowOnError>): import("./client").RequestResult<GetMessageResponses, unknown, ThrowOnError, "fields">;
|
|
181
|
+
/**
|
|
182
|
+
* Send a Message
|
|
183
|
+
*
|
|
184
|
+
* Sends a message in the specified chat.
|
|
185
|
+
* <br/>
|
|
186
|
+
* Use <a href="https://developer.unipile.com/v2.0/reference/post_v2-account-id-chats-send">Start a Chat</a> if you don't have a conversation with the wanted user(s) yet.
|
|
187
|
+
* <br/>
|
|
188
|
+
* Multipart supported, refer to <a href="https://developer.unipile.com/v2.0/reference/api-usage#sending-files">Sending Files</a>.
|
|
189
|
+
*/
|
|
190
|
+
sendMessage<ThrowOnError extends boolean = false>(options: Options<SendMessageData, ThrowOnError>): import("./client").RequestResult<SendMessageResponses, unknown, ThrowOnError, "fields">;
|
|
191
|
+
/**
|
|
192
|
+
* Forward a Message
|
|
193
|
+
*
|
|
194
|
+
* Forwards a message to another chat.
|
|
195
|
+
*/
|
|
196
|
+
forwardMessage<ThrowOnError extends boolean = false>(options: Options<ForwardMessageData, ThrowOnError>): import("./client").RequestResult<ForwardMessageResponses, unknown, ThrowOnError, "fields">;
|
|
197
|
+
/**
|
|
198
|
+
* Modify a Message
|
|
199
|
+
*
|
|
200
|
+
* Modifies one of the account's owner messages.
|
|
201
|
+
* <br/>
|
|
202
|
+
* Trying to modify the message of another user will fail.
|
|
203
|
+
*/
|
|
204
|
+
modifyMessage<ThrowOnError extends boolean = false>(options: Options<ModifyMessageData, ThrowOnError>): import("./client").RequestResult<ModifyMessageResponses, unknown, ThrowOnError, "fields">;
|
|
205
|
+
/**
|
|
206
|
+
* Read a Message
|
|
207
|
+
*
|
|
208
|
+
* Marks a message sent in the chat by another user as read by you.
|
|
209
|
+
* Trying to mark your own messages as read will fail.
|
|
210
|
+
* This does not affect the read status of the chat. Use <a href="https://developer.unipile.com/v2.0/reference/patch_v2-account-id-chats-chat-id">Update a Chat</a> to mark a chat as read.
|
|
211
|
+
*/
|
|
212
|
+
readMessage<ThrowOnError extends boolean = false>(options: Options<ReadMessageData, ThrowOnError>): import("./client").RequestResult<ReadMessageResponses, unknown, ThrowOnError, "fields">;
|
|
213
|
+
/**
|
|
214
|
+
* List all Chat Participants
|
|
215
|
+
*
|
|
216
|
+
* Returns a list of participants in the specified group chat. For 1to1 chats, the unique participant is given in the chat object.
|
|
217
|
+
* <br />
|
|
218
|
+
* Trying to retrieve the list of participants of a 1to1 chat will fail.
|
|
219
|
+
*/
|
|
220
|
+
getParticipantsList<ThrowOnError extends boolean = false>(options: Options<GetParticipantsListData, ThrowOnError>): import("./client").RequestResult<GetParticipantsListResponses, unknown, ThrowOnError, "fields">;
|
|
221
|
+
/**
|
|
222
|
+
* Add a Chat Participant
|
|
223
|
+
*
|
|
224
|
+
* Adds a new user as participant of chat if you have the rights to. Providers might requires an admin role or some permissions.
|
|
225
|
+
* <br />
|
|
226
|
+
* Trying to add a participant into a 1to1 chat can fail depending on the provider.
|
|
227
|
+
*/
|
|
228
|
+
addParticipant<ThrowOnError extends boolean = false>(options: Options<AddParticipantData, ThrowOnError>): import("./client").RequestResult<AddParticipantResponses, unknown, ThrowOnError, "fields">;
|
|
229
|
+
/**
|
|
230
|
+
* Remove a Chat Participant
|
|
231
|
+
*
|
|
232
|
+
* Removes a participant user from a chat if you have the rights to. Providers might requires an admin role or some permissions.
|
|
233
|
+
* <br />
|
|
234
|
+
* Trying to remove a participant from a 1to1 chat will fail.
|
|
235
|
+
*/
|
|
236
|
+
removeParticipant<ThrowOnError extends boolean = false>(options: Options<RemoveParticipantData, ThrowOnError>): import("./client").RequestResult<RemoveParticipantResponses, unknown, ThrowOnError, "fields">;
|
|
237
|
+
/**
|
|
238
|
+
* Remove a Message Reaction
|
|
239
|
+
*
|
|
240
|
+
* Removes a reaction of the account's owner from a message. Trying to remove a reaction from another user will fail.
|
|
241
|
+
*/
|
|
242
|
+
removeMessageReaction<ThrowOnError extends boolean = false>(options: Options<RemoveMessageReactionData, ThrowOnError>): import("./client").RequestResult<RemoveMessageReactionResponses, unknown, ThrowOnError, "fields">;
|
|
243
|
+
/**
|
|
244
|
+
* List all Message's Reactions
|
|
245
|
+
*
|
|
246
|
+
* Returns the list of reactions made to a message. Reaction counts are given with the Message object. This is useful to show a detailed list of all reactions and their author.
|
|
247
|
+
*/
|
|
248
|
+
getMessageReactionsList<ThrowOnError extends boolean = false>(options: Options<GetMessageReactionsListData, ThrowOnError>): import("./client").RequestResult<GetMessageReactionsListResponses, unknown, ThrowOnError, "fields">;
|
|
249
|
+
/**
|
|
250
|
+
* Add a Message Reaction
|
|
251
|
+
*
|
|
252
|
+
* Adds a reaction to a message. Some providers only allow the use of a limited list of emojis, trying to react with an unsupported emoji will fail.
|
|
253
|
+
*/
|
|
254
|
+
addMessageReaction<ThrowOnError extends boolean = false>(options: Options<AddMessageReactionData, ThrowOnError>): import("./client").RequestResult<AddMessageReactionResponses, unknown, ThrowOnError, "fields">;
|
|
255
|
+
/**
|
|
256
|
+
* Get a Message Attachment
|
|
257
|
+
*
|
|
258
|
+
* Download the attachment file of a message.
|
|
259
|
+
*/
|
|
260
|
+
getAttachment<ThrowOnError extends boolean = false>(options: Options<GetAttachmentData, ThrowOnError>): import("./client").RequestResult<GetAttachmentResponses, unknown, ThrowOnError, "fields">;
|
|
261
|
+
/**
|
|
262
|
+
* Set Presence
|
|
263
|
+
*
|
|
264
|
+
* Sets the presence of the user.
|
|
265
|
+
*/
|
|
266
|
+
setPresence<ThrowOnError extends boolean = false>(options: Options<SetPresenceData, ThrowOnError>): import("./client").RequestResult<SetPresenceResponses, unknown, ThrowOnError, "fields">;
|
|
267
|
+
/**
|
|
268
|
+
* Set Composing Status
|
|
269
|
+
*
|
|
270
|
+
* Sets the composing status of the user in a chat.
|
|
271
|
+
*/
|
|
272
|
+
setComposingStatus<ThrowOnError extends boolean = false>(options: Options<SetComposingStatusData, ThrowOnError>): import("./client").RequestResult<SetComposingStatusResponses, unknown, ThrowOnError, "fields">;
|
|
273
|
+
}
|
|
274
|
+
export declare class UnipileEmails extends HeyApiClient {
|
|
275
|
+
static readonly __registry: HeyApiRegistry2<UnipileEmails>;
|
|
276
|
+
constructor(args?: {
|
|
277
|
+
client?: Client;
|
|
278
|
+
key?: string;
|
|
279
|
+
});
|
|
280
|
+
/**
|
|
281
|
+
* List all Emails
|
|
282
|
+
*
|
|
283
|
+
* Returns a list of emails in the account mailbox. Emails are returned sorted by their `date`, with the most recent appearing first.
|
|
284
|
+
*/
|
|
285
|
+
getEmailsList<ThrowOnError extends boolean = false>(options: Options<GetEmailsListData, ThrowOnError>): import("./client").RequestResult<GetEmailsListResponses, unknown, ThrowOnError, "fields">;
|
|
286
|
+
/**
|
|
287
|
+
* List folder Emails
|
|
288
|
+
*
|
|
289
|
+
* Returns a list of emails in the specific folder of the account mailbox. Emails are returned sorted by their `date`, with the most recent appearing first.
|
|
290
|
+
*/
|
|
291
|
+
getFolderEmailsList<ThrowOnError extends boolean = false>(options: Options<GetFolderEmailsListData, ThrowOnError>): import("./client").RequestResult<GetFolderEmailsListResponses, unknown, ThrowOnError, "fields">;
|
|
292
|
+
/**
|
|
293
|
+
* Get a Thread
|
|
294
|
+
*
|
|
295
|
+
* Returns a list of emails belonging to the specific thread. Emails are returned sorted by their `date`, with the most recent appearing first.
|
|
296
|
+
*/
|
|
297
|
+
getThread<ThrowOnError extends boolean = false>(options: Options<GetThreadData, ThrowOnError>): import("./client").RequestResult<GetThreadResponses, unknown, ThrowOnError, "fields">;
|
|
298
|
+
/**
|
|
299
|
+
* Trash an Email
|
|
300
|
+
*
|
|
301
|
+
* Moves the specified Email to the trash.
|
|
302
|
+
*/
|
|
303
|
+
trashEmail<ThrowOnError extends boolean = false>(options: Options<TrashEmailData, ThrowOnError>): import("./client").RequestResult<TrashEmailResponses, unknown, ThrowOnError, "fields">;
|
|
304
|
+
/**
|
|
305
|
+
* Get an Email
|
|
306
|
+
*
|
|
307
|
+
* Retrieve the specified Email.
|
|
308
|
+
*/
|
|
309
|
+
getEmail<ThrowOnError extends boolean = false>(options: Options<GetEmailData, ThrowOnError>): import("./client").RequestResult<GetEmailResponses, unknown, ThrowOnError, "fields">;
|
|
310
|
+
/**
|
|
311
|
+
* Get an Email Attachment
|
|
312
|
+
*
|
|
313
|
+
* Download the attachment file of an Email.
|
|
314
|
+
*/
|
|
315
|
+
getAttachment1<ThrowOnError extends boolean = false>(options: Options<GetAttachment1Data, ThrowOnError>): import("./client").RequestResult<GetAttachment1Responses, unknown, ThrowOnError, "fields">;
|
|
316
|
+
/**
|
|
317
|
+
* Modify an Email
|
|
318
|
+
*
|
|
319
|
+
* Modifies the folder(s) and/or provider-specific properties on the specified Email.
|
|
320
|
+
*/
|
|
321
|
+
modifyEmail<ThrowOnError extends boolean = false>(options: Options<ModifyEmailData, ThrowOnError>): import("./client").RequestResult<ModifyEmailResponses, unknown, ThrowOnError, "fields">;
|
|
322
|
+
/**
|
|
323
|
+
* Unread an Email
|
|
324
|
+
*
|
|
325
|
+
* Mark the specified Email as unread.
|
|
326
|
+
*/
|
|
327
|
+
unreadEmail<ThrowOnError extends boolean = false>(options: Options<UnreadEmailData, ThrowOnError>): import("./client").RequestResult<UnreadEmailResponses, unknown, ThrowOnError, "fields">;
|
|
328
|
+
/**
|
|
329
|
+
* Read an Email
|
|
330
|
+
*
|
|
331
|
+
* Mark the specified Email as read.
|
|
332
|
+
*/
|
|
333
|
+
readEmail<ThrowOnError extends boolean = false>(options: Options<ReadEmailData, ThrowOnError>): import("./client").RequestResult<ReadEmailResponses, unknown, ThrowOnError, "fields">;
|
|
334
|
+
/**
|
|
335
|
+
* Send an Email
|
|
336
|
+
*
|
|
337
|
+
* Sends an Email to the recipients in the `to`, `cc`, and `bcc`.
|
|
338
|
+
* <br/>
|
|
339
|
+
* Multipart supported, refer to <a href="https://developer.unipile.com/v2.0/reference/api-usage#sending-files">Sending Files</a>.
|
|
340
|
+
*/
|
|
341
|
+
sendEmail<ThrowOnError extends boolean = false>(options: Options<SendEmailData, ThrowOnError>): import("./client").RequestResult<SendEmailResponses, unknown, ThrowOnError, "fields">;
|
|
342
|
+
/**
|
|
343
|
+
* List all Drafts
|
|
344
|
+
*
|
|
345
|
+
* Returns a list of the account drafts. Drafts are returned sorted by their creation date, with the most recent appearing first.
|
|
346
|
+
*/
|
|
347
|
+
getDraftsList<ThrowOnError extends boolean = false>(options: Options<GetDraftsListData, ThrowOnError>): import("./client").RequestResult<GetDraftsListResponses, unknown, ThrowOnError, "fields">;
|
|
348
|
+
/**
|
|
349
|
+
* Create a Draft
|
|
350
|
+
*
|
|
351
|
+
* Creates a new Draft in the draft folder of the provider. Use <a href="@todo">Send a Draft</a> to send the Email later.
|
|
352
|
+
* <br/>
|
|
353
|
+
* Multipart supported, refer to <a href="https://developer.unipile.com/v2.0/reference/api-usage#sending-files">Sending Files</a>.
|
|
354
|
+
*/
|
|
355
|
+
createDraft<ThrowOnError extends boolean = false>(options: Options<CreateDraftData, ThrowOnError>): import("./client").RequestResult<CreateDraftResponses, unknown, ThrowOnError, "fields">;
|
|
356
|
+
/**
|
|
357
|
+
* Delete a Draft
|
|
358
|
+
*
|
|
359
|
+
* Permanently deletes the specified Draft.
|
|
360
|
+
*/
|
|
361
|
+
deleteDraft<ThrowOnError extends boolean = false>(options: Options<DeleteDraftData, ThrowOnError>): import("./client").RequestResult<DeleteDraftResponses, unknown, ThrowOnError, "fields">;
|
|
362
|
+
/**
|
|
363
|
+
* Get a Draft
|
|
364
|
+
*
|
|
365
|
+
* Retrieve the specified Draft.
|
|
366
|
+
*/
|
|
367
|
+
getDraft<ThrowOnError extends boolean = false>(options: Options<GetDraftData, ThrowOnError>): import("./client").RequestResult<GetDraftResponses, unknown, ThrowOnError, "fields">;
|
|
368
|
+
/**
|
|
369
|
+
* Update a Draft
|
|
370
|
+
*
|
|
371
|
+
* Updates the specified Draft by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
372
|
+
* <br/>
|
|
373
|
+
* Multipart supported, refer to <a href="https://developer.unipile.com/v2.0/reference/api-usage#sending-files">Sending Files</a>.
|
|
374
|
+
*/
|
|
375
|
+
updateDraft<ThrowOnError extends boolean = false>(options: Options<UpdateDraftData, ThrowOnError>): import("./client").RequestResult<UpdateDraftResponses, unknown, ThrowOnError, "fields">;
|
|
376
|
+
/**
|
|
377
|
+
* Send a Draft
|
|
378
|
+
*
|
|
379
|
+
* Sends the specified Draft to the recipients in the `to`, `cc`, and `bcc` fields of the draft.
|
|
380
|
+
*/
|
|
381
|
+
sendDraft<ThrowOnError extends boolean = false>(options: Options<SendDraftData, ThrowOnError>): import("./client").RequestResult<SendDraftResponses, unknown, ThrowOnError, "fields">;
|
|
382
|
+
/**
|
|
383
|
+
* List all Folders
|
|
384
|
+
*
|
|
385
|
+
* Returns a list of folders in the account mailbox.
|
|
386
|
+
*/
|
|
387
|
+
getFoldersList<ThrowOnError extends boolean = false>(options: Options<GetFoldersListData, ThrowOnError>): import("./client").RequestResult<GetFoldersListResponses, unknown, ThrowOnError, "fields">;
|
|
388
|
+
/**
|
|
389
|
+
* Create a Folder
|
|
390
|
+
*
|
|
391
|
+
* Creates a new Folder in the account mailbox.
|
|
392
|
+
*/
|
|
393
|
+
createFolder<ThrowOnError extends boolean = false>(options: Options<CreateFolderData, ThrowOnError>): import("./client").RequestResult<CreateFolderResponses, unknown, ThrowOnError, "fields">;
|
|
394
|
+
/**
|
|
395
|
+
* Delete a Folder
|
|
396
|
+
*
|
|
397
|
+
* Deletes the specified Folder
|
|
398
|
+
*/
|
|
399
|
+
deleteFolder<ThrowOnError extends boolean = false>(options: Options<DeleteFolderData, ThrowOnError>): import("./client").RequestResult<DeleteFolderResponses, unknown, ThrowOnError, "fields">;
|
|
400
|
+
/**
|
|
401
|
+
* Get a Folder
|
|
402
|
+
*
|
|
403
|
+
* Retrieves the specified Folder
|
|
404
|
+
*/
|
|
405
|
+
getFolder<ThrowOnError extends boolean = false>(options: Options<GetFolderData, ThrowOnError>): import("./client").RequestResult<GetFolderResponses, unknown, ThrowOnError, "fields">;
|
|
406
|
+
/**
|
|
407
|
+
* Update a Folder
|
|
408
|
+
*
|
|
409
|
+
* Updates the specified Folder by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
410
|
+
*/
|
|
411
|
+
updateFolder<ThrowOnError extends boolean = false>(options: Options<UpdateFolderData, ThrowOnError>): import("./client").RequestResult<UpdateFolderResponses, unknown, ThrowOnError, "fields">;
|
|
412
|
+
/**
|
|
413
|
+
* List email contacts
|
|
414
|
+
*
|
|
415
|
+
* Returns a list of contacts from the email provider.
|
|
416
|
+
*/
|
|
417
|
+
getEmailContactsList<ThrowOnError extends boolean = false>(options: Options<GetEmailContactsListData, ThrowOnError>): import("./client").RequestResult<GetEmailContactsListResponses, unknown, ThrowOnError, "fields">;
|
|
418
|
+
}
|
|
419
|
+
export declare class UnipileUsers extends HeyApiClient {
|
|
420
|
+
static readonly __registry: HeyApiRegistry3<UnipileUsers>;
|
|
421
|
+
constructor(args?: {
|
|
422
|
+
client?: Client;
|
|
423
|
+
key?: string;
|
|
424
|
+
});
|
|
425
|
+
/**
|
|
426
|
+
* Get a User Profile
|
|
427
|
+
*
|
|
428
|
+
* Retrieves the specified User profile. Use `me` as `user_id` to specify the owner of the connected account.
|
|
429
|
+
*/
|
|
430
|
+
getUserProfile<ThrowOnError extends boolean = false>(options: Options<GetUserProfileData, ThrowOnError>): import("./client").RequestResult<GetUserProfileResponses, unknown, ThrowOnError, "fields">;
|
|
431
|
+
/**
|
|
432
|
+
* Update a User Profile
|
|
433
|
+
*
|
|
434
|
+
* Updates the specified User profile. Use `me` as `user_id` to update the account owner profile.
|
|
435
|
+
* <br/>
|
|
436
|
+
* Multipart supported, refer to <a href="https://developer.unipile.com/v2.0/reference/api-usage#sending-files">Sending Files</a>.
|
|
437
|
+
*/
|
|
438
|
+
updateUserProfile<ThrowOnError extends boolean = false>(options: Options<UpdateUserProfileData, ThrowOnError>): import("./client").RequestResult<UpdateUserProfileResponses, unknown, ThrowOnError, "fields">;
|
|
439
|
+
/**
|
|
440
|
+
* Report a Profile Visit
|
|
441
|
+
*
|
|
442
|
+
* Report to the provider that you have visited a given user profile. This can be used to simulate engagement and activity.
|
|
443
|
+
*/
|
|
444
|
+
visitUserProfile<ThrowOnError extends boolean = false>(options: Options<VisitUserProfileData, ThrowOnError>): import("./client").RequestResult<VisitUserProfileResponses, unknown, ThrowOnError, "fields">;
|
|
445
|
+
/**
|
|
446
|
+
* List Relations of a User
|
|
447
|
+
*
|
|
448
|
+
* Returns a list of bi-directional relations for the specified User. Use `me` as `user_id` to specify the owner of the connected account.
|
|
449
|
+
*/
|
|
450
|
+
getUserRelations<ThrowOnError extends boolean = false>(options: Options<GetUserRelationsData, ThrowOnError>): import("./client").RequestResult<GetUserRelationsResponses, unknown, ThrowOnError, "fields">;
|
|
451
|
+
/**
|
|
452
|
+
* Delete a Relation
|
|
453
|
+
*
|
|
454
|
+
* Deletes a bi-directional relation with another user. For uni-directional relations, use `Unfollow User` instead.
|
|
455
|
+
*/
|
|
456
|
+
deleteRelation<ThrowOnError extends boolean = false>(options: Options<DeleteRelationData, ThrowOnError>): import("./client").RequestResult<DeleteRelationResponses, unknown, ThrowOnError, "fields">;
|
|
457
|
+
/**
|
|
458
|
+
* List all pending Relation / Follow requests
|
|
459
|
+
*
|
|
460
|
+
* Returns a list of pending relation / follow requests that have been sent or received by the owner of the account.
|
|
461
|
+
*/
|
|
462
|
+
getRelationRequestsList<ThrowOnError extends boolean = false>(options: Options<GetRelationRequestsListData, ThrowOnError>): import("./client").RequestResult<GetRelationRequestsListResponses, unknown, ThrowOnError, "fields">;
|
|
463
|
+
/**
|
|
464
|
+
* Send a Relation request
|
|
465
|
+
*
|
|
466
|
+
* Sends a bi-directional relation request to a user. Trying to send a relation request to an existing relation will fail. For uni-directional relations, use `Follow User` instead.
|
|
467
|
+
*/
|
|
468
|
+
createRelationRequest<ThrowOnError extends boolean = false>(options: Options<CreateRelationRequestData, ThrowOnError>): import("./client").RequestResult<CreateRelationRequestResponses, unknown, ThrowOnError, "fields">;
|
|
469
|
+
/**
|
|
470
|
+
* Cancel or Refuse a Relation / Follow request
|
|
471
|
+
*
|
|
472
|
+
* Cancels the relation / follow request if sent by the owner of the account to another user. Refuses the relation / follow request if received by the owner of the account from another user.
|
|
473
|
+
*/
|
|
474
|
+
cancelRelationRequest<ThrowOnError extends boolean = false>(options: Options<CancelRelationRequestData, ThrowOnError>): import("./client").RequestResult<CancelRelationRequestResponses, unknown, ThrowOnError, "fields">;
|
|
475
|
+
/**
|
|
476
|
+
* Accept a Relation request
|
|
477
|
+
*
|
|
478
|
+
* Accepts a received relation request from another user. Trying to accept a sent relation request will fail.
|
|
479
|
+
*/
|
|
480
|
+
acceptRelationRequest<ThrowOnError extends boolean = false>(options: Options<AcceptRelationRequestData, ThrowOnError>): import("./client").RequestResult<AcceptRelationRequestResponses, unknown, ThrowOnError, "fields">;
|
|
481
|
+
/**
|
|
482
|
+
* List Followers of a User
|
|
483
|
+
*
|
|
484
|
+
* Returns a list of followers of the specified User. Set `me` as `user_id` to specify the owner of the connected account.
|
|
485
|
+
*/
|
|
486
|
+
listUserFollowers<ThrowOnError extends boolean = false>(options: Options<ListUserFollowersData, ThrowOnError>): import("./client").RequestResult<ListUserFollowersResponses, unknown, ThrowOnError, "fields">;
|
|
487
|
+
/**
|
|
488
|
+
* List Following of a User
|
|
489
|
+
*
|
|
490
|
+
* Returns a list of Users followed by the specified User. Set `me` as `user_id` to specify the owner of the connected account.
|
|
491
|
+
*/
|
|
492
|
+
listUserFollowing<ThrowOnError extends boolean = false>(options: Options<ListUserFollowingData, ThrowOnError>): import("./client").RequestResult<ListUserFollowingResponses, unknown, ThrowOnError, "fields">;
|
|
493
|
+
/**
|
|
494
|
+
* Follow a User
|
|
495
|
+
*
|
|
496
|
+
* Follows a user. Trying to follow an already followed User will fail. For bi-directional relations, use `Send Relation Request` instead. If the User has a private profile, this will create a Follow Request.
|
|
497
|
+
*/
|
|
498
|
+
followUser<ThrowOnError extends boolean = false>(options: Options<FollowUserData, ThrowOnError>): import("./client").RequestResult<FollowUserResponses, unknown, ThrowOnError, "fields">;
|
|
499
|
+
/**
|
|
500
|
+
* Unfollow a User
|
|
501
|
+
*
|
|
502
|
+
* Unfollows a user. Trying to unfollow a not followed User will fail.
|
|
503
|
+
*/
|
|
504
|
+
unfollowUser<ThrowOnError extends boolean = false>(options: Options<UnfollowUserData, ThrowOnError>): import("./client").RequestResult<UnfollowUserResponses, unknown, ThrowOnError, "fields">;
|
|
505
|
+
/**
|
|
506
|
+
* List all User's Posts
|
|
507
|
+
*
|
|
508
|
+
* Returns a list of posts created or shared by a user. Use `me` as `user_id` to specify the owner of the connected account.
|
|
509
|
+
*/
|
|
510
|
+
getPostsList<ThrowOnError extends boolean = false>(options: Options<GetPostsListData, ThrowOnError>): import("./client").RequestResult<GetPostsListResponses, unknown, ThrowOnError, "fields">;
|
|
511
|
+
}
|
|
512
|
+
export declare class UnipilePosts extends HeyApiClient {
|
|
513
|
+
static readonly __registry: HeyApiRegistry4<UnipilePosts>;
|
|
514
|
+
constructor(args?: {
|
|
515
|
+
client?: Client;
|
|
516
|
+
key?: string;
|
|
517
|
+
});
|
|
518
|
+
/**
|
|
519
|
+
* List all User's Posts
|
|
520
|
+
*
|
|
521
|
+
* Returns a list of posts created or shared by a user. Use `me` as `user_id` to specify the owner of the connected account.
|
|
522
|
+
*/
|
|
523
|
+
getPostsList<ThrowOnError extends boolean = false>(options: Options<GetPostsListData, ThrowOnError>): import("./client").RequestResult<GetPostsListResponses, unknown, ThrowOnError, "fields">;
|
|
524
|
+
/**
|
|
525
|
+
* Delete a Post
|
|
526
|
+
*
|
|
527
|
+
* Deletes a post created by the owner of the account. Trying to delete a post created by another user will fail.
|
|
528
|
+
*/
|
|
529
|
+
deletePost<ThrowOnError extends boolean = false>(options: Options<DeletePostData, ThrowOnError>): import("./client").RequestResult<DeletePostResponses, unknown, ThrowOnError, "fields">;
|
|
530
|
+
/**
|
|
531
|
+
* Get a Post
|
|
532
|
+
*
|
|
533
|
+
* Retrieves the specified post.
|
|
534
|
+
*/
|
|
535
|
+
getPost<ThrowOnError extends boolean = false>(options: Options<GetPostData, ThrowOnError>): import("./client").RequestResult<GetPostResponses, unknown, ThrowOnError, "fields">;
|
|
536
|
+
/**
|
|
537
|
+
* Update a Post
|
|
538
|
+
*
|
|
539
|
+
* Updates an existing post.
|
|
540
|
+
*/
|
|
541
|
+
updatePost<ThrowOnError extends boolean = false>(options: Options<UpdatePostData, ThrowOnError>): import("./client").RequestResult<UpdatePostResponses, unknown, ThrowOnError, "fields">;
|
|
542
|
+
/**
|
|
543
|
+
* Create a Post
|
|
544
|
+
*
|
|
545
|
+
* Creates a new post.
|
|
546
|
+
* <br/>
|
|
547
|
+
* Multipart supported, refer to <a href="https://developer.unipile.com/v2.0/reference/api-usage#sending-files">Sending Files</a>.
|
|
548
|
+
*/
|
|
549
|
+
createPost<ThrowOnError extends boolean = false>(options: Options<CreatePostData, ThrowOnError>): import("./client").RequestResult<CreatePostResponses, unknown, ThrowOnError, "fields">;
|
|
550
|
+
/**
|
|
551
|
+
* Remove Reaction from a Post
|
|
552
|
+
*
|
|
553
|
+
* Removes a reaction from a post.
|
|
554
|
+
*/
|
|
555
|
+
removePostReaction<ThrowOnError extends boolean = false>(options: Options<RemovePostReactionData, ThrowOnError>): import("./client").RequestResult<RemovePostReactionResponses, unknown, ThrowOnError, "fields">;
|
|
556
|
+
/**
|
|
557
|
+
* List all Post's Reactions
|
|
558
|
+
*
|
|
559
|
+
* Returns the list of reactions made to a post. Reaction counts are given with the Post object. This is useful to show a detailed list of all reactions and their author. LIMITATIONS: On Instagram, the list is always limited to a maximum of 100 reactions.
|
|
560
|
+
*/
|
|
561
|
+
getPostReactionsList<ThrowOnError extends boolean = false>(options: Options<GetPostReactionsListData, ThrowOnError>): import("./client").RequestResult<GetPostReactionsListResponses, unknown, ThrowOnError, "fields">;
|
|
562
|
+
/**
|
|
563
|
+
* Add Reaction to a Post
|
|
564
|
+
*
|
|
565
|
+
* Adds a reaction to a post.
|
|
566
|
+
*/
|
|
567
|
+
addPostReaction<ThrowOnError extends boolean = false>(options: Options<AddPostReactionData, ThrowOnError>): import("./client").RequestResult<AddPostReactionResponses, unknown, ThrowOnError, "fields">;
|
|
568
|
+
/**
|
|
569
|
+
* List all Post's Comments
|
|
570
|
+
*
|
|
571
|
+
* Returns a list of post comments. The comments are returned sorted by their creation date, with the most recent appearing first.
|
|
572
|
+
*/
|
|
573
|
+
getPostCommentsList<ThrowOnError extends boolean = false>(options: Options<GetPostCommentsListData, ThrowOnError>): import("./client").RequestResult<GetPostCommentsListResponses, unknown, ThrowOnError, "fields">;
|
|
574
|
+
/**
|
|
575
|
+
* Add Comment to a Post
|
|
576
|
+
*
|
|
577
|
+
* Adds a comment to a post.
|
|
578
|
+
* <br/>
|
|
579
|
+
* Multipart supported, refer to <a href="https://developer.unipile.com/v2.0/reference/api-usage#sending-files">Sending Files</a>.
|
|
580
|
+
*/
|
|
581
|
+
addPostComment<ThrowOnError extends boolean = false>(options: Options<AddPostCommentData, ThrowOnError>): import("./client").RequestResult<AddPostCommentResponses, unknown, ThrowOnError, "fields">;
|
|
582
|
+
/**
|
|
583
|
+
* Delete Comment from a Post
|
|
584
|
+
*
|
|
585
|
+
* Deletes a comment of the account's owner from a post. Trying to delete a comment from another user will fail.
|
|
586
|
+
*/
|
|
587
|
+
deletePostComment<ThrowOnError extends boolean = false>(options: Options<DeletePostCommentData, ThrowOnError>): import("./client").RequestResult<DeletePostCommentResponses, unknown, ThrowOnError, "fields">;
|
|
588
|
+
/**
|
|
589
|
+
* Update a Comment
|
|
590
|
+
*
|
|
591
|
+
* Updates an existing comment.
|
|
592
|
+
*/
|
|
593
|
+
updatePostComment<ThrowOnError extends boolean = false>(options: Options<UpdatePostCommentData, ThrowOnError>): import("./client").RequestResult<UpdatePostCommentResponses, unknown, ThrowOnError, "fields">;
|
|
594
|
+
/**
|
|
595
|
+
* Reply to a Comment
|
|
596
|
+
*
|
|
597
|
+
* Replies to a particular comment.
|
|
598
|
+
* <br/>
|
|
599
|
+
* Multipart supported, refer to <a href="https://developer.unipile.com/v2.0/reference/api-usage#sending-files">Sending Files</a>.
|
|
600
|
+
*/
|
|
601
|
+
replyToComment<ThrowOnError extends boolean = false>(options: Options<ReplyToCommentData, ThrowOnError>): import("./client").RequestResult<ReplyToCommentResponses, unknown, ThrowOnError, "fields">;
|
|
602
|
+
/**
|
|
603
|
+
* List all Comment's Replies
|
|
604
|
+
*
|
|
605
|
+
* Returns the list of replies to a comment. The replies are returned sorted by their creation date, with the most recent appearing first.
|
|
606
|
+
*/
|
|
607
|
+
getPostCommentRepliesList<ThrowOnError extends boolean = false>(options: Options<GetPostCommentRepliesListData, ThrowOnError>): import("./client").RequestResult<GetPostCommentRepliesListResponses, unknown, ThrowOnError, "fields">;
|
|
608
|
+
/**
|
|
609
|
+
* Remove Reaction from a Comment
|
|
610
|
+
*
|
|
611
|
+
* Removes a reaction of the account's owner from a comment. Trying to remove a reaction from another user will fail.
|
|
612
|
+
*/
|
|
613
|
+
removePostCommentReaction<ThrowOnError extends boolean = false>(options: Options<RemovePostCommentReactionData, ThrowOnError>): import("./client").RequestResult<RemovePostCommentReactionResponses, unknown, ThrowOnError, "fields">;
|
|
614
|
+
/**
|
|
615
|
+
* List all Comment's Reactions
|
|
616
|
+
*
|
|
617
|
+
* Returns the list of reactions made to a comment. Reaction counts are given with the Comment object. This is useful to show a detailed list of all reactions and their author.
|
|
618
|
+
*/
|
|
619
|
+
getPostCommentReactionsList<ThrowOnError extends boolean = false>(options: Options<GetPostCommentReactionsListData, ThrowOnError>): import("./client").RequestResult<GetPostCommentReactionsListResponses, unknown, ThrowOnError, "fields">;
|
|
620
|
+
/**
|
|
621
|
+
* Add Reaction to a Comment
|
|
622
|
+
*
|
|
623
|
+
* Adds a reaction to a post.
|
|
624
|
+
*/
|
|
625
|
+
addPostCommentReaction<ThrowOnError extends boolean = false>(options: Options<AddPostCommentReactionData, ThrowOnError>): import("./client").RequestResult<AddPostCommentReactionResponses, unknown, ThrowOnError, "fields">;
|
|
626
|
+
/**
|
|
627
|
+
* List all User Comments
|
|
628
|
+
*
|
|
629
|
+
* Returns the list of comments made by a user to posts. Use `me` as `user_id` to specify the owner of the connected account.
|
|
630
|
+
*/
|
|
631
|
+
getUserCommentsList<ThrowOnError extends boolean = false>(options: Options<GetUserCommentsListData, ThrowOnError>): import("./client").RequestResult<GetUserCommentsListResponses, unknown, ThrowOnError, "fields">;
|
|
632
|
+
/**
|
|
633
|
+
* List all User Reactions
|
|
634
|
+
*
|
|
635
|
+
* Returns the list of reactions made by a user to posts. Use `me` as `user_id` to specify the owner of the connected account.
|
|
636
|
+
*/
|
|
637
|
+
getUserReactionsList<ThrowOnError extends boolean = false>(options: Options<GetUserReactionsListData, ThrowOnError>): import("./client").RequestResult<GetUserReactionsListResponses, unknown, ThrowOnError, "fields">;
|
|
638
|
+
}
|
|
639
|
+
export declare class UnipileCalendar extends HeyApiClient {
|
|
640
|
+
static readonly __registry: HeyApiRegistry5<UnipileCalendar>;
|
|
641
|
+
constructor(args?: {
|
|
642
|
+
client?: Client;
|
|
643
|
+
key?: string;
|
|
644
|
+
});
|
|
645
|
+
/**
|
|
646
|
+
* List all Calendars
|
|
647
|
+
*
|
|
648
|
+
* Returns a list of calendars.
|
|
649
|
+
*/
|
|
650
|
+
getCalendarsList<ThrowOnError extends boolean = false>(options: Options<GetCalendarsListData, ThrowOnError>): import("./client").RequestResult<GetCalendarsListResponses, unknown, ThrowOnError, "fields">;
|
|
651
|
+
/**
|
|
652
|
+
* Create a Calendar
|
|
653
|
+
*
|
|
654
|
+
* Create a new calendar.
|
|
655
|
+
*/
|
|
656
|
+
createCalendar<ThrowOnError extends boolean = false>(options: Options<CreateCalendarData, ThrowOnError>): import("./client").RequestResult<CreateCalendarResponses, unknown, ThrowOnError, "fields">;
|
|
657
|
+
/**
|
|
658
|
+
* Delete a Calendar
|
|
659
|
+
*
|
|
660
|
+
* Delete the specified calendar.
|
|
661
|
+
*/
|
|
662
|
+
deleteCalendar<ThrowOnError extends boolean = false>(options: Options<DeleteCalendarData, ThrowOnError>): import("./client").RequestResult<DeleteCalendarResponses, unknown, ThrowOnError, "fields">;
|
|
663
|
+
/**
|
|
664
|
+
* Get a Calendar
|
|
665
|
+
*
|
|
666
|
+
* Retrieves the specified Calendar.
|
|
667
|
+
*/
|
|
668
|
+
getCalendar<ThrowOnError extends boolean = false>(options: Options<GetCalendarData, ThrowOnError>): import("./client").RequestResult<GetCalendarResponses, unknown, ThrowOnError, "fields">;
|
|
669
|
+
/**
|
|
670
|
+
* Update a Calendar
|
|
671
|
+
*
|
|
672
|
+
* Updates the specified calendar by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
673
|
+
*/
|
|
674
|
+
updateCalendar<ThrowOnError extends boolean = false>(options: Options<UpdateCalendarData, ThrowOnError>): import("./client").RequestResult<UpdateCalendarResponses, unknown, ThrowOnError, "fields">;
|
|
675
|
+
/**
|
|
676
|
+
* List all calendar events
|
|
677
|
+
*
|
|
678
|
+
* Returns a list of calendar events.
|
|
679
|
+
*/
|
|
680
|
+
getCalendarEventList<ThrowOnError extends boolean = false>(options: Options<GetCalendarEventListData, ThrowOnError>): import("./client").RequestResult<GetCalendarEventListResponses, unknown, ThrowOnError, "fields">;
|
|
681
|
+
/**
|
|
682
|
+
* Create a calendar event
|
|
683
|
+
*
|
|
684
|
+
* Create a brand new calendar event.
|
|
685
|
+
*/
|
|
686
|
+
createCalendarEvent<ThrowOnError extends boolean = false>(options: Options<CreateCalendarEventData, ThrowOnError>): import("./client").RequestResult<CreateCalendarEventResponses, unknown, ThrowOnError, "fields">;
|
|
687
|
+
/**
|
|
688
|
+
* Delete a Calendar event
|
|
689
|
+
*
|
|
690
|
+
* Delete the specified calendar event.
|
|
691
|
+
*/
|
|
692
|
+
deleteCalendarEvent<ThrowOnError extends boolean = false>(options: Options<DeleteCalendarEventData, ThrowOnError>): import("./client").RequestResult<DeleteCalendarEventResponses, unknown, ThrowOnError, "fields">;
|
|
693
|
+
/**
|
|
694
|
+
* Get a calendar event
|
|
695
|
+
*
|
|
696
|
+
* Retrieves a calendar event object.
|
|
697
|
+
*/
|
|
698
|
+
getCalendarEvent<ThrowOnError extends boolean = false>(options: Options<GetCalendarEventData, ThrowOnError>): import("./client").RequestResult<GetCalendarEventResponses, unknown, ThrowOnError, "fields">;
|
|
699
|
+
/**
|
|
700
|
+
* Update a calendar event
|
|
701
|
+
*
|
|
702
|
+
* Updates the specified calendar by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
703
|
+
*/
|
|
704
|
+
updateCalendarEvent<ThrowOnError extends boolean = false>(options: Options<UpdateCalendarEventData, ThrowOnError>): import("./client").RequestResult<UpdateCalendarEventResponses, unknown, ThrowOnError, "fields">;
|
|
705
|
+
}
|
|
706
|
+
export declare class UnipileLinkedIn extends HeyApiClient {
|
|
707
|
+
static readonly __registry: HeyApiRegistry6<UnipileLinkedIn>;
|
|
708
|
+
constructor(args?: {
|
|
709
|
+
client?: Client;
|
|
710
|
+
key?: string;
|
|
711
|
+
});
|
|
712
|
+
/**
|
|
713
|
+
* Perform a Request to any LinkedIn API Endpoint
|
|
714
|
+
*
|
|
715
|
+
* Allows advanced users to implement any LinkedIn feature that is not yet supported by our platform.
|
|
716
|
+
*/
|
|
717
|
+
proxyRequest<ThrowOnError extends boolean = false>(options: Options<ProxyRequestData, ThrowOnError>): import("./client").RequestResult<ProxyRequestResponses, unknown, ThrowOnError, "fields">;
|
|
718
|
+
/**
|
|
719
|
+
* Get InMail Credits
|
|
720
|
+
*
|
|
721
|
+
* Retrieves InMail credits by service or for all subscribed services.
|
|
722
|
+
*/
|
|
723
|
+
getInmailCredits<ThrowOnError extends boolean = false>(options: Options<GetInmailCreditsData, ThrowOnError>): import("./client").RequestResult<GetInmailCreditsResponses, unknown, ThrowOnError, "fields">;
|
|
724
|
+
/**
|
|
725
|
+
* List Available Contracts
|
|
726
|
+
*
|
|
727
|
+
* Returns a list of Recruiter/Sales Navigator contracts associated with your account.
|
|
728
|
+
*/
|
|
729
|
+
getAvailableContracts<ThrowOnError extends boolean = false>(options: Options<GetAvailableContractsData, ThrowOnError>): import("./client").RequestResult<GetAvailableContractsResponses, unknown, ThrowOnError, "fields">;
|
|
730
|
+
/**
|
|
731
|
+
* Select a Contract
|
|
732
|
+
*
|
|
733
|
+
* Activates a given Recruiter/Sales Navigator contract on your account.
|
|
734
|
+
*/
|
|
735
|
+
selectContract<ThrowOnError extends boolean = false>(options: Options<SelectContractData, ThrowOnError>): import("./client").RequestResult<SelectContractResponses, unknown, ThrowOnError, "fields">;
|
|
736
|
+
/**
|
|
737
|
+
* Get a Company Profile
|
|
738
|
+
*
|
|
739
|
+
* Retrieves the specified company profile.
|
|
740
|
+
*/
|
|
741
|
+
getClassicCompanyProfile<ThrowOnError extends boolean = false>(options: Options<GetClassicCompanyProfileData, ThrowOnError>): import("./client").RequestResult<GetClassicCompanyProfileResponses, unknown, ThrowOnError, "fields">;
|
|
742
|
+
/**
|
|
743
|
+
* Verify Company Member Identity
|
|
744
|
+
*
|
|
745
|
+
* Verifies member identity by submitting an email address.
|
|
746
|
+
*/
|
|
747
|
+
verifyClassicCompanyMemberIdentity<ThrowOnError extends boolean = false>(options: Options<VerifyClassicCompanyMemberIdentityData, ThrowOnError>): import("./client").RequestResult<VerifyClassicCompanyMemberIdentityResponses, unknown, ThrowOnError, "fields">;
|
|
748
|
+
/**
|
|
749
|
+
* Submit Otp Verification Code
|
|
750
|
+
*
|
|
751
|
+
* Completes the process of member identity verification.
|
|
752
|
+
*/
|
|
753
|
+
submitClassicCompanyOtpCode<ThrowOnError extends boolean = false>(options: Options<SubmitClassicCompanyOtpCodeData, ThrowOnError>): import("./client").RequestResult<SubmitClassicCompanyOtpCodeResponses, unknown, ThrowOnError, "fields">;
|
|
754
|
+
/**
|
|
755
|
+
* Endorse a Member's Skill
|
|
756
|
+
*
|
|
757
|
+
* Validates a given skill for one of your relations.
|
|
758
|
+
*/
|
|
759
|
+
endorseClassicMemberSkill<ThrowOnError extends boolean = false>(options: Options<EndorseClassicMemberSkillData, ThrowOnError>): import("./client").RequestResult<EndorseClassicMemberSkillResponses, unknown, ThrowOnError, "fields">;
|
|
760
|
+
/**
|
|
761
|
+
* List Search Parameters
|
|
762
|
+
*
|
|
763
|
+
* Returns a list of parameters to be used in the search route.
|
|
764
|
+
*/
|
|
765
|
+
getClassicSearchParameters<ThrowOnError extends boolean = false>(options: Options<GetClassicSearchParametersData, ThrowOnError>): import("./client").RequestResult<GetClassicSearchParametersResponses, unknown, ThrowOnError, "fields">;
|
|
766
|
+
/**
|
|
767
|
+
* Perform Classic Search from URL
|
|
768
|
+
*
|
|
769
|
+
* Returns a list of results from a LinkedIn Classic search URL.
|
|
770
|
+
*/
|
|
771
|
+
performClassicSearchFromUrl<ThrowOnError extends boolean = false>(options: Options<PerformClassicSearchFromUrlData, ThrowOnError>): import("./client").RequestResult<PerformClassicSearchFromUrlResponses, unknown, ThrowOnError, "fields">;
|
|
772
|
+
/**
|
|
773
|
+
* Perform People Search
|
|
774
|
+
*
|
|
775
|
+
* Returns a list of people from search results.
|
|
776
|
+
*/
|
|
777
|
+
performClassicPeopleSearch<ThrowOnError extends boolean = false>(options: Options<PerformClassicPeopleSearchData, ThrowOnError>): import("./client").RequestResult<PerformClassicPeopleSearchResponses, unknown, ThrowOnError, "fields">;
|
|
778
|
+
/**
|
|
779
|
+
* Perform Companies Search
|
|
780
|
+
*
|
|
781
|
+
* Returns a list of companies from search results.
|
|
782
|
+
*/
|
|
783
|
+
performClassicCompaniesSearch<ThrowOnError extends boolean = false>(options: Options<PerformClassicCompaniesSearchData, ThrowOnError>): import("./client").RequestResult<PerformClassicCompaniesSearchResponses, unknown, ThrowOnError, "fields">;
|
|
784
|
+
/**
|
|
785
|
+
* Perform Posts Search
|
|
786
|
+
*
|
|
787
|
+
* Returns a list of posts from search results.
|
|
788
|
+
*/
|
|
789
|
+
performClassicPostsSearch<ThrowOnError extends boolean = false>(options: Options<PerformClassicPostsSearchData, ThrowOnError>): import("./client").RequestResult<PerformClassicPostsSearchResponses, unknown, ThrowOnError, "fields">;
|
|
790
|
+
/**
|
|
791
|
+
* Perform Jobs Search
|
|
792
|
+
*
|
|
793
|
+
* Returns a list of job postings from search results.
|
|
794
|
+
*/
|
|
795
|
+
performClassicJobsSearch<ThrowOnError extends boolean = false>(options: Options<PerformClassicJobsSearchData, ThrowOnError>): import("./client").RequestResult<PerformClassicJobsSearchResponses, unknown, ThrowOnError, "fields">;
|
|
796
|
+
/**
|
|
797
|
+
* List User Job Postings
|
|
798
|
+
*
|
|
799
|
+
* Returns a list of job postings created by the current user.
|
|
800
|
+
*/
|
|
801
|
+
listClassicUserJobPostings<ThrowOnError extends boolean = false>(options: Options<ListClassicUserJobPostingsData, ThrowOnError>): import("./client").RequestResult<ListClassicUserJobPostingsResponses, unknown, ThrowOnError, "fields">;
|
|
802
|
+
/**
|
|
803
|
+
* Create a Job Posting Draft
|
|
804
|
+
*
|
|
805
|
+
* Creates a new job posting as draft.
|
|
806
|
+
* <br/>
|
|
807
|
+
* Use <a href="https://developer.unipile.com/v2.0/reference/post_v2-account-id-linkedin-jobs-job-id-publish">Publish a Job Posting Draft</a> to publish the job once you are ready.
|
|
808
|
+
*
|
|
809
|
+
*/
|
|
810
|
+
createClassicJobPostingDraft<ThrowOnError extends boolean = false>(options: Options<CreateClassicJobPostingDraftData, ThrowOnError>): import("./client").RequestResult<CreateClassicJobPostingDraftResponses, unknown, ThrowOnError, "fields">;
|
|
811
|
+
/**
|
|
812
|
+
* Get a Job Posting
|
|
813
|
+
*
|
|
814
|
+
* Retrieves a job posting by its ID.
|
|
815
|
+
*/
|
|
816
|
+
getClassicJobPosting<ThrowOnError extends boolean = false>(options: Options<GetClassicJobPostingData, ThrowOnError>): import("./client").RequestResult<GetClassicJobPostingResponses, unknown, ThrowOnError, "fields">;
|
|
817
|
+
/**
|
|
818
|
+
* Edit an existing Job Posting
|
|
819
|
+
*
|
|
820
|
+
* Edits a job posting created by the current user.
|
|
821
|
+
*/
|
|
822
|
+
editClassicJobPosting<ThrowOnError extends boolean = false>(options: Options<EditClassicJobPostingData, ThrowOnError>): import("./client").RequestResult<EditClassicJobPostingResponses, unknown, ThrowOnError, "fields">;
|
|
823
|
+
/**
|
|
824
|
+
* Get the Budget for a Job Posting
|
|
825
|
+
*
|
|
826
|
+
* Returns available budget ranges, recommended budgets, and estimated impact.
|
|
827
|
+
*/
|
|
828
|
+
getClassicJobPostingBudget<ThrowOnError extends boolean = false>(options: Options<GetClassicJobPostingBudgetData, ThrowOnError>): import("./client").RequestResult<GetClassicJobPostingBudgetResponses, unknown, ThrowOnError, "fields">;
|
|
829
|
+
/**
|
|
830
|
+
* Publish a Job Posting
|
|
831
|
+
*
|
|
832
|
+
* Publishes a job posting with specific budget options.
|
|
833
|
+
*/
|
|
834
|
+
publishClassicJobPosting<ThrowOnError extends boolean = false>(options: Options<PublishClassicJobPostingData, ThrowOnError>): import("./client").RequestResult<PublishClassicJobPostingResponses, unknown, ThrowOnError, "fields">;
|
|
835
|
+
/**
|
|
836
|
+
* Close a Job Posting
|
|
837
|
+
*
|
|
838
|
+
* Closes a job posting so applications cannot be submitted anymore.
|
|
839
|
+
*/
|
|
840
|
+
closeClassicJobPosting<ThrowOnError extends boolean = false>(options: Options<CloseClassicJobPostingData, ThrowOnError>): import("./client").RequestResult<CloseClassicJobPostingResponses, unknown, ThrowOnError, "fields">;
|
|
841
|
+
/**
|
|
842
|
+
* List Job Posting Applicants
|
|
843
|
+
*
|
|
844
|
+
* Returns a list of the applicants to a job posting.
|
|
845
|
+
*/
|
|
846
|
+
getClassicApplicants<ThrowOnError extends boolean = false>(options: Options<GetClassicApplicantsData, ThrowOnError>): import("./client").RequestResult<GetClassicApplicantsResponses, unknown, ThrowOnError, "fields">;
|
|
847
|
+
/**
|
|
848
|
+
* Get an Applicant
|
|
849
|
+
*
|
|
850
|
+
* Retrieves an applicant by ID.
|
|
851
|
+
*/
|
|
852
|
+
getClassicApplicantById<ThrowOnError extends boolean = false>(options: Options<GetClassicApplicantByIdData, ThrowOnError>): import("./client").RequestResult<GetClassicApplicantByIdResponses, unknown, ThrowOnError, "fields">;
|
|
853
|
+
/**
|
|
854
|
+
* Get an Applicant's Resume
|
|
855
|
+
*
|
|
856
|
+
* Downloads the resume of a given applicant.
|
|
857
|
+
*/
|
|
858
|
+
getClassicApplicantResume<ThrowOnError extends boolean = false>(options: Options<GetClassicApplicantResumeData, ThrowOnError>): import("./client").RequestResult<GetClassicApplicantResumeResponses, unknown, ThrowOnError, "fields">;
|
|
859
|
+
/**
|
|
860
|
+
* List Projects
|
|
861
|
+
*
|
|
862
|
+
* Returns a list of hiring projects created in the current contract scope.
|
|
863
|
+
*/
|
|
864
|
+
getRecruiterHiringProjectList<ThrowOnError extends boolean = false>(options: Options<GetRecruiterHiringProjectListData, ThrowOnError>): import("./client").RequestResult<GetRecruiterHiringProjectListResponses, unknown, ThrowOnError, "fields">;
|
|
865
|
+
/**
|
|
866
|
+
* Create a New Project
|
|
867
|
+
*
|
|
868
|
+
* Creates a new project in the current contract.
|
|
869
|
+
*/
|
|
870
|
+
createRecruiterHiringProject<ThrowOnError extends boolean = false>(options: Options<CreateRecruiterHiringProjectData, ThrowOnError>): import("./client").RequestResult<CreateRecruiterHiringProjectResponses, unknown, ThrowOnError, "fields">;
|
|
871
|
+
/**
|
|
872
|
+
* Get a Project
|
|
873
|
+
*
|
|
874
|
+
* Retrieves the specified hiring project.
|
|
875
|
+
*/
|
|
876
|
+
getRecruiterHiringProject<ThrowOnError extends boolean = false>(options: Options<GetRecruiterHiringProjectData, ThrowOnError>): import("./client").RequestResult<GetRecruiterHiringProjectResponses, unknown, ThrowOnError, "fields">;
|
|
877
|
+
/**
|
|
878
|
+
* Edit a Project
|
|
879
|
+
*
|
|
880
|
+
* Edits the specified hiring project.
|
|
881
|
+
*/
|
|
882
|
+
editRecruiterHiringProject<ThrowOnError extends boolean = false>(options: Options<EditRecruiterHiringProjectData, ThrowOnError>): import("./client").RequestResult<EditRecruiterHiringProjectResponses, unknown, ThrowOnError, "fields">;
|
|
883
|
+
/**
|
|
884
|
+
* List Job Posting Applicants
|
|
885
|
+
*
|
|
886
|
+
* Returns a list of applicants from the talent pool of a project.
|
|
887
|
+
*/
|
|
888
|
+
getRecruiterTalentPoolApplicants<ThrowOnError extends boolean = false>(options: Options<GetRecruiterTalentPoolApplicantsData, ThrowOnError>): import("./client").RequestResult<GetRecruiterTalentPoolApplicantsResponses, unknown, ThrowOnError, "fields">;
|
|
889
|
+
/**
|
|
890
|
+
* Get an Applicant
|
|
891
|
+
*
|
|
892
|
+
* Retrieves an applicant by ID.
|
|
893
|
+
*/
|
|
894
|
+
getRecruiterApplicantById<ThrowOnError extends boolean = false>(options: Options<GetRecruiterApplicantByIdData, ThrowOnError>): import("./client").RequestResult<GetRecruiterApplicantByIdResponses, unknown, ThrowOnError, "fields">;
|
|
895
|
+
/**
|
|
896
|
+
* Get an Applicant's Resume
|
|
897
|
+
*
|
|
898
|
+
* Downloads the resume of a given applicant.
|
|
899
|
+
*/
|
|
900
|
+
getRecruiterApplicantResume<ThrowOnError extends boolean = false>(options: Options<GetRecruiterApplicantResumeData, ThrowOnError>): import("./client").RequestResult<GetRecruiterApplicantResumeResponses, unknown, ThrowOnError, "fields">;
|
|
901
|
+
/**
|
|
902
|
+
* List Pipeline Candidates
|
|
903
|
+
*
|
|
904
|
+
* Returns a list of candidates from the pipeline of a project.
|
|
905
|
+
*/
|
|
906
|
+
getRecruiterPipelineCandidates<ThrowOnError extends boolean = false>(options: Options<GetRecruiterPipelineCandidatesData, ThrowOnError>): import("./client").RequestResult<GetRecruiterPipelineCandidatesResponses, unknown, ThrowOnError, "fields">;
|
|
907
|
+
/**
|
|
908
|
+
* Save a Candidate
|
|
909
|
+
*
|
|
910
|
+
* Saves a candidate to the pipeline of a project
|
|
911
|
+
*/
|
|
912
|
+
saveRecruiterCandidateToPipeline<ThrowOnError extends boolean = false>(options: Options<SaveRecruiterCandidateToPipelineData, ThrowOnError>): import("./client").RequestResult<SaveRecruiterCandidateToPipelineResponses, unknown, ThrowOnError, "fields">;
|
|
913
|
+
/**
|
|
914
|
+
* Perform People Search From Talent Pool
|
|
915
|
+
*
|
|
916
|
+
* Returns a list of people from search results.
|
|
917
|
+
*/
|
|
918
|
+
performRecruiterPeopleSearchFromTalentPool<ThrowOnError extends boolean = false>(options: Options<PerformRecruiterPeopleSearchFromTalentPoolData, ThrowOnError>): import("./client").RequestResult<PerformRecruiterPeopleSearchFromTalentPoolResponses, unknown, ThrowOnError, "fields">;
|
|
919
|
+
/**
|
|
920
|
+
* Get a Job Posting by Project
|
|
921
|
+
*
|
|
922
|
+
* Retrieves a job posting by project.
|
|
923
|
+
*/
|
|
924
|
+
getRecruiterJobPostingByProjectId<ThrowOnError extends boolean = false>(options: Options<GetRecruiterJobPostingByProjectIdData, ThrowOnError>): import("./client").RequestResult<GetRecruiterJobPostingByProjectIdResponses, unknown, ThrowOnError, "fields">;
|
|
925
|
+
/**
|
|
926
|
+
* Create a Job Posting Draft in an Existing Project
|
|
927
|
+
*
|
|
928
|
+
* Creates a new job posting as draft in a new project.
|
|
929
|
+
*/
|
|
930
|
+
createRecruiterJobPostingDraftInExistingProject<ThrowOnError extends boolean = false>(options: Options<CreateRecruiterJobPostingDraftInExistingProjectData, ThrowOnError>): import("./client").RequestResult<CreateRecruiterJobPostingDraftInExistingProjectResponses, unknown, ThrowOnError, "fields">;
|
|
931
|
+
/**
|
|
932
|
+
* Get the Budget for a Job Posting
|
|
933
|
+
*
|
|
934
|
+
* Returns available budget ranges, recommended budgets, and estimated impact.
|
|
935
|
+
*/
|
|
936
|
+
getRecruiterJobPostingBudget<ThrowOnError extends boolean = false>(options: Options<GetRecruiterJobPostingBudgetData, ThrowOnError>): import("./client").RequestResult<GetRecruiterJobPostingBudgetResponses, unknown, ThrowOnError, "fields">;
|
|
937
|
+
/**
|
|
938
|
+
* List Job Postings
|
|
939
|
+
*
|
|
940
|
+
* Returns a list of job postings created by the current user or related job posters.
|
|
941
|
+
*/
|
|
942
|
+
getRecruiterJobPostingList<ThrowOnError extends boolean = false>(options: Options<GetRecruiterJobPostingListData, ThrowOnError>): import("./client").RequestResult<GetRecruiterJobPostingListResponses, unknown, ThrowOnError, "fields">;
|
|
943
|
+
/**
|
|
944
|
+
* Create a Job Posting Draft in a New Project
|
|
945
|
+
*
|
|
946
|
+
* Creates a new job posting as draft in a new project.
|
|
947
|
+
* <br/>
|
|
948
|
+
* Use <a href="https://developer.unipile.com/v2.0/reference/post_v2-account-id-linkedin-recruiter-projects-project-id-jobs-job-id-publish">Publish a Job Posting Draft</a> to publish the job once you are ready.
|
|
949
|
+
*
|
|
950
|
+
*/
|
|
951
|
+
createRecruiterJobPostingDraftInNewProject<ThrowOnError extends boolean = false>(options: Options<CreateRecruiterJobPostingDraftInNewProjectData, ThrowOnError>): import("./client").RequestResult<CreateRecruiterJobPostingDraftInNewProjectResponses, unknown, ThrowOnError, "fields">;
|
|
952
|
+
/**
|
|
953
|
+
* Edit an Existing Job Posting
|
|
954
|
+
*
|
|
955
|
+
* Edits an existing job posting from a project.
|
|
956
|
+
*/
|
|
957
|
+
editRecruiterJobPosting<ThrowOnError extends boolean = false>(options: Options<EditRecruiterJobPostingData, ThrowOnError>): import("./client").RequestResult<EditRecruiterJobPostingResponses, unknown, ThrowOnError, "fields">;
|
|
958
|
+
/**
|
|
959
|
+
* Publish a Job Posting
|
|
960
|
+
*
|
|
961
|
+
* Publishes a job posting with specific budget options.
|
|
962
|
+
*/
|
|
963
|
+
publishRecruiterJobPosting<ThrowOnError extends boolean = false>(options: Options<PublishRecruiterJobPostingData, ThrowOnError>): import("./client").RequestResult<PublishRecruiterJobPostingResponses, unknown, ThrowOnError, "fields">;
|
|
964
|
+
/**
|
|
965
|
+
* Close a Job Posting
|
|
966
|
+
*
|
|
967
|
+
* Closes a job posting so applications cannot be submitted anymore.
|
|
968
|
+
*/
|
|
969
|
+
closeRecruiterJobPosting<ThrowOnError extends boolean = false>(options: Options<CloseRecruiterJobPostingData, ThrowOnError>): import("./client").RequestResult<CloseRecruiterJobPostingResponses, unknown, ThrowOnError, "fields">;
|
|
970
|
+
/**
|
|
971
|
+
* Get a Job Posting
|
|
972
|
+
*
|
|
973
|
+
* Retrieves a job posting by its ID.
|
|
974
|
+
*/
|
|
975
|
+
getRecruiterJobPostingById<ThrowOnError extends boolean = false>(options: Options<GetRecruiterJobPostingByIdData, ThrowOnError>): import("./client").RequestResult<GetRecruiterJobPostingByIdResponses, unknown, ThrowOnError, "fields">;
|
|
976
|
+
/**
|
|
977
|
+
* Perform Recruiter Search from URL
|
|
978
|
+
*
|
|
979
|
+
* Returns a list of results from a LinkedIn Recruiter search URL.
|
|
980
|
+
*/
|
|
981
|
+
performRecruiterSearchFromUrl<ThrowOnError extends boolean = false>(options: Options<PerformRecruiterSearchFromUrlData, ThrowOnError>): import("./client").RequestResult<PerformRecruiterSearchFromUrlResponses, unknown, ThrowOnError, "fields">;
|
|
982
|
+
/**
|
|
983
|
+
* List Search Parameters
|
|
984
|
+
*
|
|
985
|
+
* Returns a list of parameters to be used in Recruiter search endpoints.
|
|
986
|
+
*/
|
|
987
|
+
getRecruiterSearchParameters<ThrowOnError extends boolean = false>(options: Options<GetRecruiterSearchParametersData, ThrowOnError>): import("./client").RequestResult<GetRecruiterSearchParametersResponses, unknown, ThrowOnError, "fields">;
|
|
988
|
+
/**
|
|
989
|
+
* Perform People Search
|
|
990
|
+
*
|
|
991
|
+
* Returns a list of people from search results.
|
|
992
|
+
*/
|
|
993
|
+
performRecruiterPeopleSearch<ThrowOnError extends boolean = false>(options: Options<PerformRecruiterPeopleSearchData, ThrowOnError>): import("./client").RequestResult<PerformRecruiterPeopleSearchResponses, unknown, ThrowOnError, "fields">;
|
|
994
|
+
/**
|
|
995
|
+
* Verify Company Member Identity
|
|
996
|
+
*
|
|
997
|
+
* Verifies member identity by submitting an email address.
|
|
998
|
+
*/
|
|
999
|
+
verifyRecruiterCompanyMemberIdentity<ThrowOnError extends boolean = false>(options: Options<VerifyRecruiterCompanyMemberIdentityData, ThrowOnError>): import("./client").RequestResult<VerifyRecruiterCompanyMemberIdentityResponses, unknown, ThrowOnError, "fields">;
|
|
1000
|
+
/**
|
|
1001
|
+
* Submit Otp Verification Code
|
|
1002
|
+
*
|
|
1003
|
+
* Completes the process of member identity verification.
|
|
1004
|
+
*/
|
|
1005
|
+
submitRecruiterOtpCode<ThrowOnError extends boolean = false>(options: Options<SubmitRecruiterOtpCodeData, ThrowOnError>): import("./client").RequestResult<SubmitRecruiterOtpCodeResponses, unknown, ThrowOnError, "fields">;
|
|
1006
|
+
/**
|
|
1007
|
+
* Perform Search from URL
|
|
1008
|
+
*
|
|
1009
|
+
* Returns a list of results from a LinkedIn Sales navigator search URL.
|
|
1010
|
+
*/
|
|
1011
|
+
performSalesSearchFromUrl<ThrowOnError extends boolean = false>(options: Options<PerformSalesSearchFromUrlData, ThrowOnError>): import("./client").RequestResult<PerformSalesSearchFromUrlResponses, unknown, ThrowOnError, "fields">;
|
|
1012
|
+
/**
|
|
1013
|
+
* List Search Parameters
|
|
1014
|
+
*
|
|
1015
|
+
* Returns a list of parameters to be used in Sales navigator search endpoints.
|
|
1016
|
+
*/
|
|
1017
|
+
getSalesSearchParameters<ThrowOnError extends boolean = false>(options: Options<GetSalesSearchParametersData, ThrowOnError>): import("./client").RequestResult<GetSalesSearchParametersResponses, unknown, ThrowOnError, "fields">;
|
|
1018
|
+
/**
|
|
1019
|
+
* Perform People Search
|
|
1020
|
+
*
|
|
1021
|
+
* Returns a list of people from search results.
|
|
1022
|
+
*/
|
|
1023
|
+
performSalesPeopleSearch<ThrowOnError extends boolean = false>(options: Options<PerformSalesPeopleSearchData, ThrowOnError>): import("./client").RequestResult<PerformSalesPeopleSearchResponses, unknown, ThrowOnError, "fields">;
|
|
1024
|
+
/**
|
|
1025
|
+
* Perform Companies Search
|
|
1026
|
+
*
|
|
1027
|
+
* Returns a list of companies from search results.
|
|
1028
|
+
*/
|
|
1029
|
+
performSalesCompaniesSearch<ThrowOnError extends boolean = false>(options: Options<PerformSalesCompaniesSearchData, ThrowOnError>): import("./client").RequestResult<PerformSalesCompaniesSearchResponses, unknown, ThrowOnError, "fields">;
|
|
1030
|
+
/**
|
|
1031
|
+
* Get Leads Lists
|
|
1032
|
+
*
|
|
1033
|
+
* Returns your leads lists.
|
|
1034
|
+
*/
|
|
1035
|
+
getSalesLeadLists<ThrowOnError extends boolean = false>(options: Options<GetSalesLeadListsData, ThrowOnError>): import("./client").RequestResult<GetSalesLeadListsResponses, unknown, ThrowOnError, "fields">;
|
|
1036
|
+
/**
|
|
1037
|
+
* Browse a Lead List
|
|
1038
|
+
*
|
|
1039
|
+
* Returns the leads that have been saved in the given list.
|
|
1040
|
+
*/
|
|
1041
|
+
browseSalesLeadList<ThrowOnError extends boolean = false>(options: Options<BrowseSalesLeadListData, ThrowOnError>): import("./client").RequestResult<BrowseSalesLeadListResponses, unknown, ThrowOnError, "fields">;
|
|
1042
|
+
/**
|
|
1043
|
+
* Save a Lead To a List
|
|
1044
|
+
*
|
|
1045
|
+
* Add a lead to an existing list
|
|
1046
|
+
*/
|
|
1047
|
+
saveSalesLeadToList<ThrowOnError extends boolean = false>(options: Options<SaveSalesLeadToListData, ThrowOnError>): import("./client").RequestResult<SaveSalesLeadToListResponses, unknown, ThrowOnError, "fields">;
|
|
1048
|
+
/**
|
|
1049
|
+
* Get Accounts Lists
|
|
1050
|
+
*
|
|
1051
|
+
* Returns your accounts lists.
|
|
1052
|
+
*/
|
|
1053
|
+
getSalesAccountLists<ThrowOnError extends boolean = false>(options: Options<GetSalesAccountListsData, ThrowOnError>): import("./client").RequestResult<GetSalesAccountListsResponses, unknown, ThrowOnError, "fields">;
|
|
1054
|
+
/**
|
|
1055
|
+
* Browse an Account List
|
|
1056
|
+
*
|
|
1057
|
+
* Returns the accounts that have been saved in the given list.
|
|
1058
|
+
*/
|
|
1059
|
+
browseSalesAccountList<ThrowOnError extends boolean = false>(options: Options<BrowseSalesAccountListData, ThrowOnError>): import("./client").RequestResult<BrowseSalesAccountListResponses, unknown, ThrowOnError, "fields">;
|
|
1060
|
+
/**
|
|
1061
|
+
* Save an Account To a List
|
|
1062
|
+
*
|
|
1063
|
+
* Add an account to an existing list
|
|
1064
|
+
*/
|
|
1065
|
+
saveSalesAccountToList<ThrowOnError extends boolean = false>(options: Options<SaveSalesAccountToListData, ThrowOnError>): import("./client").RequestResult<SaveSalesAccountToListResponses, unknown, ThrowOnError, "fields">;
|
|
1066
|
+
}
|
|
1067
|
+
export declare class UnipileInstagram extends HeyApiClient {
|
|
1068
|
+
static readonly __registry: HeyApiRegistry7<UnipileInstagram>;
|
|
1069
|
+
constructor(args?: {
|
|
1070
|
+
client?: Client;
|
|
1071
|
+
key?: string;
|
|
1072
|
+
});
|
|
1073
|
+
/**
|
|
1074
|
+
* Search locations
|
|
1075
|
+
*
|
|
1076
|
+
* Return a list of Instagram locations. Use `latitude` and `longitude` to orient search query results by influencing their relevance ranking. When a search query is performed, locations that are considered most relevant in relation to the provided geographic coordinates are prioritized in the results. This can be used to tag a Post with a location.
|
|
1077
|
+
*/
|
|
1078
|
+
searchLocations<ThrowOnError extends boolean = false>(options: Options<SearchLocationsData, ThrowOnError>): import("./client").RequestResult<SearchLocationsResponses, unknown, ThrowOnError, "fields">;
|
|
1079
|
+
}
|
|
1080
|
+
export declare class UnipileCustomAuth extends HeyApiClient {
|
|
1081
|
+
static readonly __registry: HeyApiRegistry8<UnipileCustomAuth>;
|
|
1082
|
+
constructor(args?: {
|
|
1083
|
+
client?: Client;
|
|
1084
|
+
key?: string;
|
|
1085
|
+
});
|
|
1086
|
+
/**
|
|
1087
|
+
* Solve a Checkpoint
|
|
1088
|
+
*
|
|
1089
|
+
* Solve the current checkpoint for the given authentication intent.
|
|
1090
|
+
*/
|
|
1091
|
+
solveCheckpoint<ThrowOnError extends boolean = false>(options: Options<SolveCheckpointData, ThrowOnError>): import("./client").RequestResult<SolveCheckpointResponses, unknown, ThrowOnError, "fields">;
|
|
1092
|
+
/**
|
|
1093
|
+
* Start Auth Intent
|
|
1094
|
+
*
|
|
1095
|
+
* Start an auth intent for a provider. This might require handling of checkpoints and oauth flows depending on the provider. Use <a href="https://developer.unipile.com/v2.0/reference/post_v2-auth-link">Create Auth Link</a> to let Unipile handle everything for you.
|
|
1096
|
+
*/
|
|
1097
|
+
startAuthIntent<ThrowOnError extends boolean = false>(options?: Options<StartAuthIntentData, ThrowOnError>): import("./client").RequestResult<StartAuthIntentResponses, unknown, ThrowOnError, "fields">;
|
|
1098
|
+
}
|
|
1099
|
+
export declare class UnipileHostedAuth extends HeyApiClient {
|
|
1100
|
+
static readonly __registry: HeyApiRegistry9<UnipileHostedAuth>;
|
|
1101
|
+
constructor(args?: {
|
|
1102
|
+
client?: Client;
|
|
1103
|
+
key?: string;
|
|
1104
|
+
});
|
|
1105
|
+
/**
|
|
1106
|
+
* Create Auth Link
|
|
1107
|
+
*
|
|
1108
|
+
* Create a link to the hosted authentication wizard for the user to authenticate with the provider.
|
|
1109
|
+
*/
|
|
1110
|
+
createAuthLink<ThrowOnError extends boolean = false>(options?: Options<CreateAuthLinkData, ThrowOnError>): import("./client").RequestResult<CreateAuthLinkResponses, unknown, ThrowOnError, "fields">;
|
|
1111
|
+
}
|
|
1112
|
+
export declare class UnipileAccounts extends HeyApiClient {
|
|
1113
|
+
static readonly __registry: HeyApiRegistry10<UnipileAccounts>;
|
|
1114
|
+
constructor(args?: {
|
|
1115
|
+
client?: Client;
|
|
1116
|
+
key?: string;
|
|
1117
|
+
});
|
|
1118
|
+
/**
|
|
1119
|
+
* Remove an Account
|
|
1120
|
+
*
|
|
1121
|
+
* Remove an Account from Unipile by its ID. This action is irreversible and will remove all data associated with the Account.
|
|
1122
|
+
*/
|
|
1123
|
+
removeAccount<ThrowOnError extends boolean = false>(options: Options<RemoveAccountData, ThrowOnError>): import("./client").RequestResult<RemoveAccountResponses, unknown, ThrowOnError, "fields">;
|
|
1124
|
+
/**
|
|
1125
|
+
* Get an Account
|
|
1126
|
+
*
|
|
1127
|
+
* Retrieve an Account.
|
|
1128
|
+
*/
|
|
1129
|
+
getAccount<ThrowOnError extends boolean = false>(options: Options<GetAccountData, ThrowOnError>): import("./client").RequestResult<GetAccountResponses, unknown, ThrowOnError, "fields">;
|
|
1130
|
+
/**
|
|
1131
|
+
* Update an Account
|
|
1132
|
+
*
|
|
1133
|
+
* Update an Account by ID.
|
|
1134
|
+
*/
|
|
1135
|
+
updateAccount<ThrowOnError extends boolean = false>(options: Options<UpdateAccountData, ThrowOnError>): import("./client").RequestResult<UpdateAccountResponses, unknown, ThrowOnError, "fields">;
|
|
1136
|
+
/**
|
|
1137
|
+
* List all Accounts
|
|
1138
|
+
*
|
|
1139
|
+
* Returns a list of all Accounts associated with the current Application. The accounts are returned sorted alphabeticaly on `name`.
|
|
1140
|
+
*/
|
|
1141
|
+
listAccounts<ThrowOnError extends boolean = false>(options?: Options<ListAccountsData, ThrowOnError>): import("./client").RequestResult<ListAccountsResponses, unknown, ThrowOnError, "fields">;
|
|
1142
|
+
}
|
|
1143
|
+
export declare class UnipileWebhooks extends HeyApiClient {
|
|
1144
|
+
static readonly __registry: HeyApiRegistry11<UnipileWebhooks>;
|
|
1145
|
+
constructor(args?: {
|
|
1146
|
+
client?: Client;
|
|
1147
|
+
key?: string;
|
|
1148
|
+
});
|
|
1149
|
+
/**
|
|
1150
|
+
* List all Webhook Conversations
|
|
1151
|
+
*
|
|
1152
|
+
* Returns a list of all Webhook Conversations associated with the current Application. The conversations are returned sorted by their creation date, with the most recent appearing first.
|
|
1153
|
+
*/
|
|
1154
|
+
listWebhookConversations<ThrowOnError extends boolean = false>(options: Options<ListWebhookConversationsData, ThrowOnError>): import("./client").RequestResult<ListWebhookConversationsResponses, unknown, ThrowOnError, "fields">;
|
|
1155
|
+
/**
|
|
1156
|
+
* List all Webhook Endpoints
|
|
1157
|
+
*
|
|
1158
|
+
* Returns a list of all Webhook Endpoints associated with the current Application.
|
|
1159
|
+
*/
|
|
1160
|
+
listWebhookEndpoints<ThrowOnError extends boolean = false>(options?: Options<ListWebhookEndpointsData, ThrowOnError>): import("./client").RequestResult<ListWebhookEndpointsResponses, unknown, ThrowOnError, "fields">;
|
|
1161
|
+
/**
|
|
1162
|
+
* Create a Webhook Endpoint
|
|
1163
|
+
*
|
|
1164
|
+
* Creates a new webhook endpoint.
|
|
1165
|
+
*/
|
|
1166
|
+
createWebhookEndpoint<ThrowOnError extends boolean = false>(options: Options<CreateWebhookEndpointData, ThrowOnError>): import("./client").RequestResult<CreateWebhookEndpointResponses, unknown, ThrowOnError, "fields">;
|
|
1167
|
+
/**
|
|
1168
|
+
* Delete a Webhook Endpoint
|
|
1169
|
+
*
|
|
1170
|
+
* Deletes a webhook endpoint by ID.
|
|
1171
|
+
*/
|
|
1172
|
+
deleteWebhookEndpoint<ThrowOnError extends boolean = false>(options: Options<DeleteWebhookEndpointData, ThrowOnError>): import("./client").RequestResult<DeleteWebhookEndpointResponses, unknown, ThrowOnError, "fields">;
|
|
1173
|
+
/**
|
|
1174
|
+
* Get a Webhook Endpoint
|
|
1175
|
+
*
|
|
1176
|
+
* Retrieves a webhook endpoint by ID.
|
|
1177
|
+
*/
|
|
1178
|
+
getWebhookEndpoint<ThrowOnError extends boolean = false>(options: Options<GetWebhookEndpointData, ThrowOnError>): import("./client").RequestResult<GetWebhookEndpointResponses, unknown, ThrowOnError, "fields">;
|
|
1179
|
+
/**
|
|
1180
|
+
* Update a Webhook Endpoint
|
|
1181
|
+
*
|
|
1182
|
+
* Updates a webhook endpoint by ID.
|
|
1183
|
+
*/
|
|
1184
|
+
updateWebhookEndpoint<ThrowOnError extends boolean = false>(options: Options<UpdateWebhookEndpointData, ThrowOnError>): import("./client").RequestResult<UpdateWebhookEndpointResponses, unknown, ThrowOnError, "fields">;
|
|
1185
|
+
}
|
|
1186
|
+
export {};
|
|
1187
|
+
//# sourceMappingURL=sdk.gen.d.ts.map
|