npm - @pnp/cli-microsoft365 - Versions diffs - 6.9.0-beta.289ab69 → 6.9.0-beta.bb31388 - Mend

@pnp/cli-microsoft365 6.9.0-beta.289ab69 → 6.9.0-beta.bb31388

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (1395) hide show

package/docs/docs/cmd/yammer/group/group-user-remove.mdx ADDED Viewed

@@ -0,0 +1,58 @@
+import Global from '/docs/cmd/_global.mdx';
+# yammer group user remove
+Removes a user from a Yammer group
+## Usage
+```sh
+m365 yammer group user remove [options]
+```
+## Options
+```md defintion-list
+`--groupId <groupId>`
+: The ID of the Yammer group
+`--id [id]`
+: ID of the user to remove from the group. If not specified, removes the current user
+`--confirm`
+: Don't prompt for confirmation before removing the user from the group
+```
+<Global />
+## Remarks
+:::caution
+In order to use this command, you need to grant the Azure AD application used by the CLI for Microsoft 365 the permission to the Yammer API. To do this, execute the `cli consent --service yammer` command.
+:::
+## Examples
+Remove the current user from the group with the ID `5611239081`
+```sh
+m365 yammer group user remove --groupId 5611239081
+```
+Remove the user with the ID `66622349` from the group with the ID `5611239081`
+```sh
+m365 yammer group user remove --groupId 5611239081 --id 66622349
+```
+Remove the user with the ID `66622349` from the group with the ID `5611239081` without asking for confirmation
+```sh
+m365 yammer group user remove --groupId 5611239081 --id 66622349 --confirm
+```
+## Response
+The command won't return a response on success.

package/docs/docs/cmd/yammer/message/message-add.mdx ADDED Viewed

@@ -0,0 +1,175 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+# yammer message add
+Posts a Yammer network message on behalf of the current user
+## Usage
+```sh
+m365 yammer message add [options]
+```
+## Options
+```md defintion-list
+`-b, --body <body>`
+: The text of the message body
+`--groupId [groupId]`
+: Post the message to this group, specified by ID. If this is set then the networkId is inferred from it. You must either specify `groupId`, `repliedToId`, or `directToUserIds` to send the message
+`-r, --repliedToId [repliedToId]`
+: The message ID this message is in reply to. If this is set then groupId and networkId are inferred from it. You must either specify `groupId`, `repliedToId`, or `directToUserIds` to send the message
+`-d, --directToUserIds [directToUserIds]`
+: Send a private message to one or more users, specified by ID. Alternatively, you can use the Yammer network e-mail addresses instead of the IDs. You must either specify `groupId`, `repliedToId`, or `directToUserIds` to send the message
+`--networkId [networkId]`
+: Specify the network to post a message
+```
+<Global />
+## Remarks
+:::caution
+In order to use this command, you need to grant the Azure AD application used by the CLI for Microsoft 365 the permission to the Yammer API. To do this, execute the `cli consent --service yammer` command.
+:::
+## Examples
+Replies to a message with the ID 1231231231
+```sh
+m365 yammer message add --body "Hello everyone!" --repliedToId 1231231231
+```
+Sends a private conversation to the user with the ID 1231231231
+```sh
+m365 yammer message add --body "Hello everyone!" --directToUserIds 1231231231
+```
+Sends a private conversation to multiple users by ID
+```sh
+m365 yammer message add --body "Hello everyone!" --directToUserIds "1231231231,1121312"
+```
+Sends a private conversation to the user with several e-mail addresses
+```sh
+m365 yammer message add --body "Hello everyone!" --directToUserIds "pl@nubo.eu,sc@nubo.eu"
+```
+Posts a message to the group with the ID 12312312312
+```sh
+m365 yammer message add --body "Hello everyone!" --groupId 12312312312
+```
+Posts a message to the group with the ID 12312312312 in the network 11112312
+```sh
+m365 yammer message add --body "Hello everyone!" --groupId 12312312312 --networkId 11112312
+```
+## Response
+<Tabs>
+  <TabItem value="JSON">
+  ```json
+  {
+    "id": 2000337346863105,
+    "sender_id": 36425097217,
+    "delegate_id": null,
+    "replied_to_id": null,
+    "created_at": "2022/11/11 20:59:56 +0000",
+    "network_id": 5897756673,
+    "message_type": "update",
+    "sender_type": "user",
+    "url": "https://www.yammer.com/api/v1/messages/2000337346863105",
+    "web_url": "https://www.yammer.com/contoso.onmicrosoft.com/messages/2000337346863105",
+    "group_id": 31158067201,
+    "body": {
+      "parsed": "Hello everyone!",
+      "plain": "Hello everyone!",
+      "rich": "Hello everyone!"
+    },
+    "thread_id": 2000337346863105,
+    "client_type": "O365 Api Auth",
+    "client_url": "https://api.yammer.com",
+    "system_message": false,
+    "direct_message": false,
+    "chat_client_sequence": null,
+    "language": null,
+    "notified_user_ids": [],
+    "privacy": "public",
+    "attachments": [],
+    "liked_by": {
+      "count": 0,
+      "names": []
+    },
+    "supplemental_reply": false,
+    "content_excerpt": "Hello everyone!",
+    "group_created_id": 31158067201
+  }
+  ```
+  </TabItem>
+  <TabItem value="Text">
+  ```text
+  id: 2000337648877569
+  ```
+  </TabItem>
+  <TabItem value="CSV">
+  ```csv
+  id
+  2000337749565441
+  ```
+  </TabItem>
+  <TabItem value="Markdown">
+  ```md
+  # yammer message add --body "Hello everyone!" --groupId "123412865024"
+  Date: 2023-05-16
+  ## 2269815632207872
+  Property | Value
+  ---------|-------
+  id | 2269815632207872
+  sender\_id | 1842170699776
+  created\_at | 2023/05/16 18:42:34 +0000
+  published\_at | 2023/05/16 18:42:34 +0000
+  network\_id | 98327945216
+  message\_type | update
+  sender\_type | user
+  url | https://www.yammer.com/api/v1/messages/2269815632207872
+  web\_url | https://www.yammer.com/contoso.onmicrosoft.com/messages/2269815632207872
+  group\_id | 123412865024
+  thread\_id | 2269815632207872
+  client\_type | O365 Api Auth
+  client\_url | https://api.yammer.com
+  system\_message | false
+  direct\_message | false
+  privacy | public
+  supplemental\_reply | false
+  content\_excerpt | Hello everyone!
+  group\_created\_id | 123412865024
+  ```
+  </TabItem>
+</Tabs>

package/docs/docs/cmd/yammer/message/message-get.mdx ADDED Viewed

@@ -0,0 +1,148 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+# yammer message get
+Returns a Yammer message
+## Usage
+```sh
+m365 yammer message get [options]
+```
+## Options
+```md defintion-list
+`--id <id>`
+: The id of the Yammer message
+```
+<Global />
+## Remarks
+:::caution
+In order to use this command, you need to grant the Azure AD application used by the CLI for Microsoft 365 the permission to the Yammer API. To do this, execute the `cli consent --service yammer` command.
+:::
+## Examples
+Returns the Yammer message with the id 1239871123
+```sh
+m365 yammer message get --id 1239871123
+```
+Returns the Yammer message with the id 1239871123 in JSON format
+```sh
+m365 yammer message get --id 1239871123 --output json
+```
+## Response
+<Tabs>
+  <TabItem value="JSON">
+  ```json
+  {
+    "id": 2000337749565441,
+    "sender_id": 36425097217,
+    "delegate_id": null,
+    "replied_to_id": null,
+    "created_at": "2022/11/11 21:00:20 +0000",
+    "network_id": 5897756673,
+    "message_type": "update",
+    "sender_type": "user",
+    "url": "https://www.yammer.com/api/v1/messages/2000337749565441",
+    "web_url": "https://www.yammer.com/contoso.onmicrosoft.com/messages/2000337749565441",
+    "group_id": 31158067201,
+    "body": {
+      "parsed": "Hello everyone!",
+      "plain": "Hello everyone!",
+      "rich": "Hello everyone!"
+    },
+    "thread_id": 2000337749565441,
+    "client_type": "O365 Api Auth",
+    "client_url": "https://api.yammer.com",
+    "system_message": false,
+    "direct_message": false,
+    "chat_client_sequence": null,
+    "language": "no",
+    "notified_user_ids": [],
+    "privacy": "public",
+    "attachments": [],
+    "liked_by": {
+      "count": 0,
+      "names": []
+    },
+    "supplemental_reply": false,
+    "content_excerpt": "Hello everyone!"
+  }
+  ```
+  </TabItem>
+  <TabItem value="Text">
+  ```text
+  content_excerpt: Hello everyone!
+  created_at     : 2022/11/11 21:00:20 +0000
+  direct_message : false
+  group_id       : 31158067201
+  id             : 2000337749565441
+  message_type   : update
+  privacy        : public
+  replied_to_id  : null
+  sender_id      : 36425097217
+  system_message : false
+  thread_id      : 2000337749565441
+  ```
+  </TabItem>
+  <TabItem value="CSV">
+  ```csv
+  id,sender_id,replied_to_id,thread_id,group_id,created_at,direct_message,system_message,privacy,message_type,content_excerpt
+  2000337749565441,36425097217,,2000337749565441,31158067201,2022/11/11 21:00:20 +0000,,,public,update,Hello everyone!
+  ```
+  </TabItem>
+  <TabItem value="Markdown">
+  ```md
+  # yammer message get --id "2269815632207872"
+  Date: 2023-05-16
+  ## 2269815632207872
+  Property | Value
+  ---------|-------
+  id | 2269815632207872
+  sender\_id | 1842170699776
+  created\_at | 2023/05/16 18:42:34 +0000
+  published\_at | 2023/05/16 18:42:34 +0000
+  network\_id | 98327945216
+  message\_type | update
+  sender\_type | user
+  url | https://www.yammer.com/api/v1/messages/2269815632207872
+  web\_url | https://www.yammer.com/contoso.onmicrosoft.com/messages/2269815632207872
+  group\_id | 123412865024
+  thread\_id | 2269815632207872
+  client\_type | O365 Api Auth
+  client\_url | https://api.yammer.com
+  system\_message | false
+  direct\_message | false
+  language | no
+  privacy | public
+  supplemental\_reply | false
+  content\_excerpt | Hello everyone!
+  ```
+  </TabItem>
+</Tabs>

package/docs/docs/cmd/yammer/message/message-like-set.mdx ADDED Viewed

@@ -0,0 +1,58 @@
+import Global from '/docs/cmd/_global.mdx';
+# yammer message like set
+Likes or unlikes a Yammer message
+## Usage
+```sh
+m365 yammer message like set [options]
+```
+## Options
+```md defintion-list
+`--messageId <messageId>`
+: The id of the Yammer message
+`--enable [enable]`
+: Set to `true` to like a message. Set to `false` to unlike it. Default `true`
+`--confirm`
+: Don't prompt for confirmation before unliking a message
+```
+<Global />
+## Remarks
+:::caution
+In order to use this command, you need to grant the Azure AD application used by the CLI for Microsoft 365 the permission to the Yammer API. To do this, execute the `cli consent --service yammer` command.
+:::
+## Examples
+Likes the message with the ID `5611239081`
+```sh
+m365 yammer message like set --messageId 5611239081
+```
+Unlike the message with the ID `5611239081`
+```sh
+m365 yammer message like set --messageId 5611239081 --enable false
+```
+Unlike the message with the ID `5611239081` without asking for confirmation
+```sh
+m365 yammer message like set --messageId 5611239081 --enable false --confirm
+```
+## Response
+The command won't return a response on success.

package/docs/docs/cmd/yammer/message/message-list.mdx ADDED Viewed

@@ -0,0 +1,201 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+# yammer message list
+Returns all accessible messages from the user's Yammer network
+## Usage
+```sh
+m365 yammer message list [options]
+```
+## Options
+```md defintion-list
+`--olderThanId [olderThanId]`
+: Returns messages older than the message ID specified as a numeric string
+`--threaded`
+: Will only return the thread starter (first message) for each thread. This parameter is intended for apps which need to display message threads collapsed
+`-f, --feedType [feedType]`
+: Returns messages from a specific feed. Available options: `All`, `Top`, `My`, `Following`, `Sent`, `Private`, `Received`. Default `All`
+`--groupId [groupId]`
+: Returns the messages from a specific group
+`--threadId [threadId]`
+: Returns the messages from a specific thread
+`--limit [limit]`
+: Limits the messages returned
+```
+<Global />
+## Remarks
+:::caution
+In order to use this command, you need to grant the Azure AD application used by the CLI for Microsoft 365 the permission to the Yammer API. To do this, execute the `cli consent --service yammer` command.
+:::
+Feed types
+- All: Corresponds to “All” conversations in the Yammer web interface
+- Top: The algorithmic feed for the user that corresponds to "Top" conversations. The Top conversations feed is the feed currently shown in the Yammer mobile apps
+- My: The user’s feed, based on the selection they have made between "Following" and "Top" conversations
+- Following: The "Following" feed which is conversations involving people and topics that the user is following
+- Sent: All messages sent by the user
+- Private: Private messages received by the user
+- Received: All messages received by the user
+## Examples
+Returns all Yammer network messages
+```sh
+m365 yammer message list
+```
+Returns all Yammer network messages older than the message ID 5611239081
+```sh
+m365 yammer message list --olderThanId 5611239081
+```
+Returns all Yammer network thread starter (first message) for each thread
+```sh
+m365 yammer message list --threaded
+```
+Returns the first 10 Yammer network messages
+```sh
+m365 yammer message list --limit 10
+```
+Returns the first 10 Yammer network messages from the Yammer group 312891231
+```sh
+m365 yammer message list --groupId 312891231 --limit 10
+```
+Returns the first 10 Yammer network messages from thread 5611239081
+```sh
+m365 yammer message list --threadId 5611239081 --limit 10
+```
+Returns the first 20 Yammer message from the sent feed of the user
+```sh
+m365 yammer message list --feedType Sent --limit 20
+```
+## Response
+<Tabs>
+  <TabItem value="JSON">
+  ```json
+  [
+    {
+      "id": 2000337749565441,
+      "sender_id": 36425097217,
+      "delegate_id": null,
+      "replied_to_id": null,
+      "created_at": "2022/11/11 20:59:10 +0000",
+      "network_id": 5897756673,
+      "message_type": "update",
+      "sender_type": "user",
+      "url": "https://www.yammer.com/api/v1/messages/2000336575053825",
+      "web_url": "https://www.yammer.com/contoso.onmicrosoft.com/messages/2000336575053825",
+      "group_id": 31158067201,
+      "body": {
+        "parsed": "Hello everyone!",
+        "plain": "Hello everyone!",
+        "rich": "Hello everyone!"
+      },
+      "thread_id": 2000337749565441,
+      "client_type": "O365 Api Auth",
+      "client_url": "https://api.yammer.com",
+      "system_message": false,
+      "direct_message": false,
+      "chat_client_sequence": null,
+      "language": "no",
+      "notified_user_ids": [],
+      "privacy": "public",
+      "attachments": [],
+      "liked_by": {
+        "count": 0,
+        "names": []
+      },
+      "supplemental_reply": false,
+      "content_excerpt": "Hello everyone!",
+      "group_created_id": 31158067201,
+      "shortBody": "Hello everyone!"
+    }
+  ]
+  ```
+  </TabItem>
+  <TabItem value="Text">
+  ```text
+  id                replied_to_id  thread_id         group_id     shortBody
+  ----------------  -------------  ----------------  -----------  ---------------
+  2000337749565441  null           2000337749565441  31158067201  Hello everyone!
+  ```
+  </TabItem>
+  <TabItem value="CSV">
+  ```csv
+  id,replied_to_id,thread_id,group_id,shortBody
+  2000337749565441,,2000337749565441,31158067201,Hello everyone!
+  ```
+  </TabItem>
+  <TabItem value="Markdown">
+  ```md
+  # yammer message list --limit "1" --feedType "All"
+  Date: 2023-05-16
+  ## 2269815632207872
+  Property | Value
+  ---------|-------
+  id | 2269815632207872
+  sender\_id | 1842170699776
+  created\_at | 2023/05/16 18:42:34 +0000
+  published\_at | 2023/05/16 18:42:34 +0000
+  network\_id | 98327945216
+  message\_type | update
+  sender\_type | user
+  url | https://www.yammer.com/api/v1/messages/2269815632207872
+  web\_url | https://www.yammer.com/contoso.onmicrosoft.com/messages/2269815632207872
+  group\_id | 123412865024
+  thread\_id | 2269815632207872
+  client\_type | O365 Api Auth
+  client\_url | https://api.yammer.com
+  system\_message | false
+  direct\_message | false
+  language | no
+  privacy | public
+  supplemental\_reply | false
+  content\_excerpt | Hello everyone!
+  group\_created\_id | 123412865024
+  shortBody | Hello everyone!
+  ```
+  </TabItem>
+</Tabs>

package/docs/docs/cmd/yammer/message/message-remove.mdx ADDED Viewed

@@ -0,0 +1,55 @@
+import Global from '/docs/cmd/_global.mdx';
+# yammer message remove
+Removes a Yammer message
+## Usage
+```sh
+m365 yammer message remove [options]
+```
+## Options
+```md defintion-list
+`--id <id>`
+: The id of the Yammer message
+`--confirm`
+: Don't prompt for confirming removing the Yammer message
+```
+<Global />
+## Remarks
+:::caution
+In order to use this command, you need to grant the Azure AD application used by the CLI for Microsoft 365 the permission to the Yammer API. To do this, execute the `cli consent --service yammer` command.
+:::
+To remove a message, you must either:
+- have posted the message yourself
+- be an administrator of the group the message was posted to or
+- be an admin of the network the message is in
+## Examples
+Removes the Yammer message with the id _1239871123_
+```sh
+m365 yammer message remove --id 1239871123
+```
+Removes the Yammer message with the id _1239871123_ without prompting for confirmation.
+```sh
+m365 yammer message remove --id 1239871123 --confirm
+```
+## Response
+The command won't return a response on success.