@unipile/sdk 2.1.0 → 2.21.0

package/dist/sdk.gen.js

@@ -242,7 +242,10 @@ class UnipileMessaging extends HeyApiClient {
     /**
      * List all Chats
      *
-     * 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.
+     * 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/getinboxchatslist">List inbox Chats</a> instead if not supported by the provider.
+     * Filters are applied with an AND logic if supported by the provider.
+     *
      */
     getChatsList(options) {
         return (options.client ?? this.client).get({
@@ -266,7 +269,10 @@ class UnipileMessaging extends HeyApiClient {
     /**
      * List Inbox Chats
      *
-     * 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.
+     * 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.
+     *
      */
     getInboxChatsList(options) {
         return (options.client ?? this.client).get({
@@ -331,12 +337,8 @@ class UnipileMessaging extends HeyApiClient {
      * Start a Chat
      *
      * Starts a new 1to1 or group chat by sending the first message.
-     * <br/>
-     * 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).
-     * <br/>
-     * 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.
-     * <br/>
-     * Multipart supported, refer to <a href="https://developer.unipile.com/v2.0/reference/api-usage#sending-files">Sending Files</a>.
+     * Use <a href="https://developer.unipile.com/v2.0/reference/sendmessage">Send a Message</a> if a conversation already exist with the wanted user(s).
+     * Use <a href="https://developer.unipile.com/v2.0/reference/startchatfrominbox">Start a Chat from Inbox</a> if the provider uses the inbox concept.<br/><br/>Multipart supported, refer to <a href="https://developer.unipile.com/v2.0/reference/api-usage#sending-files">Sending Files</a>.
      */
     startChat(options) {
         return (options.client ?? this.client).post({
@@ -353,13 +355,8 @@ class UnipileMessaging extends HeyApiClient {
      * Start a Chat from Inbox
      *
      * Starts a new 1to1 or group chat in the given inbox by sending the first message.
-     * <br/>
-     * 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).
-     * <br/>
-     * 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.
-     *
-     * <br/>
-     * Multipart supported, refer to <a href="https://developer.unipile.com/v2.0/reference/api-usage#sending-files">Sending Files</a>.
+     * Use <a href="https://developer.unipile.com/v2.0/reference/sendmessage">Send a Message</a> if a conversation already exist with the wanted user(s).
+     * Use <a href="https://developer.unipile.com/v2.0/reference/startchat">Start a Chat</a> instead if the provider does not use the inbox concept.<br/><br/>Multipart supported, refer to <a href="https://developer.unipile.com/v2.0/reference/api-usage#sending-files">Sending Files</a>.
      */
     startChatFromInbox(options) {
         return (options.client ?? this.client).post({
@@ -388,7 +385,6 @@ class UnipileMessaging extends HeyApiClient {
      * Delete a Message
      *
      * Deletes one of your own messages. Depending of the provider, the message might still be visible as deleted.
-     * <br />
      * Trying to delete the message of another user will fail.
      */
     deleteMessage(options) {
@@ -414,10 +410,7 @@ class UnipileMessaging extends HeyApiClient {
      * Send a Message
      *
      * Sends a message in the specified chat.
-     * <br/>
-     * 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.
-     * <br/>
-     * Multipart supported, refer to <a href="https://developer.unipile.com/v2.0/reference/api-usage#sending-files">Sending Files</a>.
+     * Use <a href="https://developer.unipile.com/v2.0/reference/startchat">Start a Chat</a> or <a href="https://developer.unipile.com/v2.0/reference/startchatfrominbox">Start a Chat from Inbox</a> if no conversation has been started with the specified user or group of users yet.<br/><br/>Multipart supported, refer to <a href="https://developer.unipile.com/v2.0/reference/api-usage#sending-files">Sending Files</a>.
      */
     sendMessage(options) {
         return (options.client ?? this.client).post({
@@ -450,7 +443,6 @@ class UnipileMessaging extends HeyApiClient {
      * Modify a Message
      *
      * Modifies one of the account's owner messages.
-     * <br/>
      * Trying to modify the message of another user will fail.
      */
     modifyMessage(options) {
@@ -469,7 +461,7 @@ class UnipileMessaging extends HeyApiClient {
      *
      * Marks a message sent in the chat by another user as read by you.
      * Trying to mark your own messages as read will fail.
-     * 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.
+     * This does not affect the read status of the chat. Use <a href="https://developer.unipile.com/v2.0/reference/updatechat">Update a Chat</a> to mark a chat as read.
      */
     readMessage(options) {
         return (options.client ?? this.client).post({
@@ -482,7 +474,6 @@ class UnipileMessaging extends HeyApiClient {
      * List all Chat Participants
      *
      * Returns a list of participants in the specified group chat. For 1to1 chats, the unique participant is given in the chat object.
-     * <br />
      * Trying to retrieve the list of participants of a 1to1 chat will fail.
      */
     getParticipantsList(options) {
@@ -496,7 +487,6 @@ class UnipileMessaging extends HeyApiClient {
      * Add a Chat Participant
      *
      * Adds a new user as participant of chat if you have the rights to. Providers might requires an admin role or some permissions.
-     * <br />
      * Trying to add a participant into a 1to1 chat can fail depending on the provider.
      */
     addParticipant(options) {
@@ -514,7 +504,6 @@ class UnipileMessaging extends HeyApiClient {
      * Remove a Chat Participant
      *
      * Removes a participant user from a chat if you have the rights to. Providers might requires an admin role or some permissions.
-     * <br />
      * Trying to remove a participant from a 1to1 chat will fail.
      */
     removeParticipant(options) {
@@ -527,7 +516,9 @@ class UnipileMessaging extends HeyApiClient {
     /**
      * Remove a Message Reaction
      *
-     * Removes a reaction of the account's owner from a message. Trying to remove a reaction from another user will fail.
+     * Removes a reaction of the account's owner from a message.
+     * Trying to remove a reaction from another user will fail.
+     *
      */
     removeMessageReaction(options) {
         return (options.client ?? this.client).delete({
@@ -619,7 +610,7 @@ class UnipileEmails extends HeyApiClient {
     /**
      * List all Emails
      *
-     * Returns a list of emails in the account mailbox. Emails are returned sorted by their `date`, with the most recent appearing first.
+     * Returns a list of emails in the account mailbox. Emails are returned sorted by their `date`, with the most recent appearing first. Search mode applies when `q`, `from`, `to`, or `any_email` is set. Filter mode applies for browse-only queries (dates, folder scope, read/starred/attachment status).
      */
     getEmailsList(options) {
         return (options.client ?? this.client).get({
@@ -631,7 +622,7 @@ class UnipileEmails extends HeyApiClient {
     /**
      * List folder Emails
      *
-     * 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.
+     * 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. Search mode applies when `q`, `from`, `to`, or `any_email` is set. Filter mode applies for browse-only queries (dates, read/starred/attachment status).
      */
     getFolderEmailsList(options) {
         return (options.client ?? this.client).get({
@@ -731,9 +722,7 @@ class UnipileEmails extends HeyApiClient {
     /**
      * Send an Email
      *
-     * Sends an Email to the recipients in the `to`, `cc`, and `bcc`.
-     * <br/>
-     * Multipart supported, refer to <a href="https://developer.unipile.com/v2.0/reference/api-usage#sending-files">Sending Files</a>.
+     * Sends an Email to the recipients in the `to`, `cc`, and `bcc`.<br/><br/>Multipart supported, refer to <a href="https://developer.unipile.com/v2.0/reference/api-usage#sending-files">Sending Files</a>.
      */
     sendEmail(options) {
         return (options.client ?? this.client).post({
@@ -761,9 +750,7 @@ class UnipileEmails extends HeyApiClient {
     /**
      * Create a Draft
      *
-     * Creates a new Draft in the draft folder of the provider. Use <a href="@todo">Send a Draft</a> to send the Email later.
-     * <br/>
-     * Multipart supported, refer to <a href="https://developer.unipile.com/v2.0/reference/api-usage#sending-files">Sending Files</a>.
+     * Creates a new Draft in the draft folder of the provider. Use <a href="@todo">Send a Draft</a> to send the Email later.<br/><br/>Multipart supported, refer to <a href="https://developer.unipile.com/v2.0/reference/api-usage#sending-files">Sending Files</a>.
      */
     createDraft(options) {
         return (options.client ?? this.client).post({
@@ -803,9 +790,7 @@ class UnipileEmails extends HeyApiClient {
     /**
      * Update a Draft
      *
-     * Updates the specified Draft by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
-     * <br/>
-     * Multipart supported, refer to <a href="https://developer.unipile.com/v2.0/reference/api-usage#sending-files">Sending Files</a>.
+     * Updates the specified Draft by setting the values of the parameters passed. Any parameters not provided will be left unchanged.<br/><br/>Multipart supported, refer to <a href="https://developer.unipile.com/v2.0/reference/api-usage#sending-files">Sending Files</a>.
      */
     updateDraft(options) {
         return (options.client ?? this.client).patch({
@@ -933,9 +918,7 @@ class UnipileUsers extends HeyApiClient {
     /**
      * Update a User Profile
      *
-     * Updates the specified User profile. Use `me` as `user_id` to update the account owner profile.
-     * <br/>
-     * Multipart supported, refer to <a href="https://developer.unipile.com/v2.0/reference/api-usage#sending-files">Sending Files</a>.
+     * Updates the specified User profile. Use `me` as `user_id` to update the account owner profile.<br/><br/>Multipart supported, refer to <a href="https://developer.unipile.com/v2.0/reference/api-usage#sending-files">Sending Files</a>.
      */
     updateUserProfile(options) {
         return (options.client ?? this.client).patch({
@@ -1159,9 +1142,7 @@ class UnipilePosts extends HeyApiClient {
     /**
      * Create a Post
      *
-     * Creates a new post.
-     * <br/>
-     * Multipart supported, refer to <a href="https://developer.unipile.com/v2.0/reference/api-usage#sending-files">Sending Files</a>.
+     * Creates a new post.<br/><br/>Multipart supported, refer to <a href="https://developer.unipile.com/v2.0/reference/api-usage#sending-files">Sending Files</a>.
      */
     createPost(options) {
         return (options.client ?? this.client).post({
@@ -1193,7 +1174,9 @@ class UnipilePosts extends HeyApiClient {
     /**
      * List all Post's Reactions
      *
-     * 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.
+     * 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.
+     *
      */
     getPostReactionsList(options) {
         return (options.client ?? this.client).get({
@@ -1233,9 +1216,7 @@ class UnipilePosts extends HeyApiClient {
     /**
      * Add Comment to a Post
      *
-     * Adds a comment to a post.
-     * <br/>
-     * Multipart supported, refer to <a href="https://developer.unipile.com/v2.0/reference/api-usage#sending-files">Sending Files</a>.
+     * Adds a comment to a post.<br/><br/>Multipart supported, refer to <a href="https://developer.unipile.com/v2.0/reference/api-usage#sending-files">Sending Files</a>.
      */
     addPostComment(options) {
         return (options.client ?? this.client).post({
@@ -1279,9 +1260,7 @@ class UnipilePosts extends HeyApiClient {
     /**
      * Reply to a Comment
      *
-     * Replies to a particular comment.
-     * <br/>
-     * Multipart supported, refer to <a href="https://developer.unipile.com/v2.0/reference/api-usage#sending-files">Sending Files</a>.
+     * Replies to a particular comment.<br/><br/>Multipart supported, refer to <a href="https://developer.unipile.com/v2.0/reference/api-usage#sending-files">Sending Files</a>.
      */
     replyToComment(options) {
         return (options.client ?? this.client).post({
@@ -1578,6 +1557,18 @@ class UnipileLinkedIn extends HeyApiClient {
             ...options
         });
     }
+    /**
+     * List Managed Company Pages
+     *
+     * Returns a list of company pages for which the account user is an administrator.
+     */
+    getManagedCompanyPages(options) {
+        return (options.client ?? this.client).get({
+            security: [{ name: 'X-API-KEY', type: 'apiKey' }],
+            url: '/v2/{account_id}/linkedin/company/pages',
+            ...options
+        });
+    }
     /**
      * Get a Company Profile
      *
@@ -1746,8 +1737,7 @@ class UnipileLinkedIn extends HeyApiClient {
      * Create a Job Posting Draft
      *
      * Creates a new job posting as draft.
-     * <br/>
-     * 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.
+     * Use <a href="https://developer.unipile.com/v2.0/reference/publishclassicjobposting">Publish a Job Posting</a> to publish the job once you are ready.
      *
      */
     createClassicJobPostingDraft(options) {
@@ -2029,6 +2019,8 @@ class UnipileLinkedIn extends HeyApiClient {
      * Create a Job Posting Draft in an Existing Project
      *
      * Creates a new job posting as draft in a new project.
+     * Use <a href="https://developer.unipile.com/v2.0/reference/publishrecruiterjobposting">Publish a Job Posting</a> to publish the job once you are ready.
+     *
      */
     createRecruiterJobPostingDraftInExistingProject(options) {
         return (options.client ?? this.client).post({
@@ -2069,8 +2061,7 @@ class UnipileLinkedIn extends HeyApiClient {
      * Create a Job Posting Draft in a New Project
      *
      * Creates a new job posting as draft in a new project.
-     * <br/>
-     * 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.
+     * Use <a href="https://developer.unipile.com/v2.0/reference/publishrecruiterjobposting">Publish a Job Posting</a> to publish the job once you are ready.
      *
      */
     createRecruiterJobPostingDraftInNewProject(options) {
@@ -2412,10 +2403,42 @@ class UnipileCustomAuth extends HeyApiClient {
             }
         });
     }
+    /**
+     * Request Checkpoint
+     *
+     * Request a checkpoint for the given authentication intent. This can be used to request a different type of checkpoint if the first one was not successful.
+     */
+    requestCheckpoint(options) {
+        return (options.client ?? this.client).post({
+            security: [{ name: 'X-API-KEY', type: 'apiKey' }],
+            url: '/v2/auth/checkpoint/request',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Resend Checkpoint Notification or Code
+     *
+     * Resend the notification or code for the current checkpoint of the given authentication intent. Use Request Checkpoint to request a different checkpoint.
+     */
+    resendCheckpoint(options) {
+        return (options.client ?? this.client).post({
+            security: [{ name: 'X-API-KEY', type: 'apiKey' }],
+            url: '/v2/auth/checkpoint/resend',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
     /**
      * Start Auth Intent
      *
-     * 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.
+     * 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/createauthlink">Create Auth Link</a> to let Unipile handle everything for you.
      */
     startAuthIntent(options) {
         return (options?.client ?? this.client).post({