@pnp/cli-microsoft365 6.3.0 → 6.4.0-beta.140530d

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 (212) hide show
  1. package/.devcontainer/Dockerfile +5 -2
  2. package/.eslintrc.js +4 -0
  3. package/Dockerfile +6 -3
  4. package/README.md +12 -1
  5. package/dist/Auth.js +1 -3
  6. package/dist/Command.js +1 -0
  7. package/dist/m365/aad/commands/user/user-get.js +3 -0
  8. package/dist/m365/aad/commands/user/user-license-remove.js +2 -1
  9. package/dist/m365/aad/commands/user/user-recyclebinitem-restore.js +2 -9
  10. package/dist/m365/aad/commands/user/user-set.js +3 -0
  11. package/dist/m365/aad/commands/user/user-signin-list.js +3 -0
  12. package/dist/m365/file/commands/file-list.js +5 -1
  13. package/dist/m365/flow/commands/flow-disable.js +9 -2
  14. package/dist/m365/flow/commands/flow-enable.js +9 -2
  15. package/dist/m365/flow/commands/flow-get.js +9 -2
  16. package/dist/m365/flow/commands/flow-list.js +1 -1
  17. package/dist/m365/flow/commands/flow-remove.js +2 -2
  18. package/dist/m365/flow/commands/owner/owner-ensure.js +147 -0
  19. package/dist/m365/flow/commands/owner/owner-list.js +89 -0
  20. package/dist/m365/flow/commands/owner/owner-remove.js +147 -0
  21. package/dist/m365/flow/commands/run/run-cancel.js +9 -2
  22. package/dist/m365/flow/commands/run/run-list.js +5 -2
  23. package/dist/m365/flow/commands.js +3 -0
  24. package/dist/m365/planner/commands/roster/roster-member-add.js +3 -0
  25. package/dist/m365/planner/commands/roster/roster-member-get.js +98 -0
  26. package/dist/m365/planner/commands.js +1 -0
  27. package/dist/m365/purview/commands/retentionevent/retentionevent-add.js +138 -0
  28. package/dist/m365/purview/commands/retentionlabel/retentionlabel-add.js +48 -14
  29. package/dist/m365/purview/commands.js +1 -0
  30. package/dist/m365/spfx/commands/project/project-upgrade/upgrade-1.17.0-beta.1.js +59 -0
  31. package/dist/m365/spfx/commands/project/project-upgrade.js +16 -13
  32. package/dist/m365/spfx/commands/spfx-doctor.js +43 -29
  33. package/dist/m365/spo/commands/commandset/commandset-add.js +138 -0
  34. package/dist/m365/spo/commands/commandset/commandset-get.js +128 -0
  35. package/dist/m365/spo/commands/commandset/commandset-list.js +77 -0
  36. package/dist/m365/spo/commands/commandset/commandset-remove.js +146 -0
  37. package/dist/m365/spo/commands/commandset/commandset-set.js +182 -0
  38. package/dist/m365/spo/commands/customaction/customaction-get.js +27 -7
  39. package/dist/m365/spo/commands/file/file-move.js +1 -1
  40. package/dist/m365/spo/commands/group/group-member-add.js +54 -95
  41. package/dist/m365/spo/commands/list/list-add.js +11 -8
  42. package/dist/m365/spo/commands/list/list-set.js +3 -3
  43. package/dist/m365/spo/commands/navigation/navigation-node-add.js +5 -4
  44. package/dist/m365/spo/commands/navigation/navigation-node-set.js +5 -1
  45. package/dist/m365/spo/commands/tenant/tenant-applicationcustomizer-get.js +118 -0
  46. package/dist/m365/spo/commands/term/term-get.js +68 -48
  47. package/dist/m365/spo/commands/user/user-ensure.js +105 -0
  48. package/dist/m365/spo/commands.js +7 -0
  49. package/dist/m365/todo/commands/task/task-add.js +35 -3
  50. package/dist/utils/aadGroup.js +18 -0
  51. package/dist/utils/aadUser.js +37 -0
  52. package/dist/utils/md.js +7 -0
  53. package/dist/utils/spo.js +32 -0
  54. package/docs/docs/cmd/aad/app/app-add.md +3 -3
  55. package/docs/docs/cmd/aad/approleassignment/approleassignment-add.md +5 -5
  56. package/docs/docs/cmd/aad/approleassignment/approleassignment-remove.md +3 -3
  57. package/docs/docs/cmd/aad/user/user-remove.md +1 -1
  58. package/docs/docs/cmd/cli/completion/completion-clink-update.md +4 -4
  59. package/docs/docs/cmd/flow/owner/owner-ensure.md +61 -0
  60. package/docs/docs/cmd/flow/owner/owner-list.md +90 -0
  61. package/docs/docs/cmd/flow/owner/owner-remove.md +67 -0
  62. package/docs/docs/cmd/flow/run/run-list.md +28 -0
  63. package/docs/docs/cmd/onenote/page/page-list.md +1 -1
  64. package/docs/docs/cmd/outlook/mail/mail-send.md +7 -3
  65. package/docs/docs/cmd/outlook/message/message-get.md +143 -0
  66. package/docs/docs/cmd/outlook/message/message-list.md +119 -0
  67. package/docs/docs/cmd/outlook/message/message-move.md +4 -0
  68. package/docs/docs/cmd/outlook/report/report-mailactivitycounts.md +40 -0
  69. package/docs/docs/cmd/outlook/report/report-mailactivityusercounts.md +40 -0
  70. package/docs/docs/cmd/outlook/report/report-mailactivityuserdetail.md +45 -0
  71. package/docs/docs/cmd/outlook/report/report-mailappusageappsusercounts.md +43 -0
  72. package/docs/docs/cmd/outlook/report/report-mailappusageusercounts.md +44 -0
  73. package/docs/docs/cmd/outlook/report/report-mailappusageuserdetail.md +48 -0
  74. package/docs/docs/cmd/outlook/report/report-mailappusageversionsusercounts.md +41 -0
  75. package/docs/docs/cmd/outlook/report/report-mailboxusagedetail.md +49 -0
  76. package/docs/docs/cmd/outlook/report/report-mailboxusagemailboxcount.md +37 -0
  77. package/docs/docs/cmd/outlook/report/report-mailboxusagequotastatusmailboxcounts.md +40 -0
  78. package/docs/docs/cmd/outlook/report/report-mailboxusagestorage.md +36 -0
  79. package/docs/docs/cmd/outlook/room/room-list.md +81 -0
  80. package/docs/docs/cmd/outlook/roomlist/roomlist-list.md +58 -0
  81. package/docs/docs/cmd/planner/plan/plan-add.md +3 -3
  82. package/docs/docs/cmd/planner/plan/plan-set.md +73 -7
  83. package/docs/docs/cmd/planner/roster/roster-add.md +16 -1
  84. package/docs/docs/cmd/planner/roster/roster-member-get.md +87 -0
  85. package/docs/docs/cmd/planner/task/task-add.md +230 -0
  86. package/docs/docs/cmd/planner/task/task-checklistitem-add.md +55 -0
  87. package/docs/docs/cmd/planner/task/task-checklistitem-list.md +55 -0
  88. package/docs/docs/cmd/planner/task/task-checklistitem-remove.md +4 -0
  89. package/docs/docs/cmd/planner/task/task-get.md +131 -0
  90. package/docs/docs/cmd/planner/task/task-list.md +92 -0
  91. package/docs/docs/cmd/planner/task/task-reference-add.md +46 -0
  92. package/docs/docs/cmd/planner/task/task-reference-list.md +46 -0
  93. package/docs/docs/cmd/planner/task/task-reference-remove.md +4 -0
  94. package/docs/docs/cmd/planner/task/task-remove.md +4 -0
  95. package/docs/docs/cmd/planner/task/task-set.md +230 -0
  96. package/docs/docs/cmd/planner/tenant/tenant-settings-list.md +55 -0
  97. package/docs/docs/cmd/planner/tenant/tenant-settings-set.md +55 -0
  98. package/docs/docs/cmd/pp/card/card-get.md +2 -2
  99. package/docs/docs/cmd/pp/card/card-list.md +2 -2
  100. package/docs/docs/cmd/purview/retentionevent/retentionevent-add.md +149 -0
  101. package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-add.md +7 -7
  102. package/docs/docs/cmd/purview/retentionlabel/retentionlabel-add.md +12 -0
  103. package/docs/docs/cmd/skype/report/report-activitycounts.md +38 -0
  104. package/docs/docs/cmd/skype/report/report-activityusercounts.md +38 -0
  105. package/docs/docs/cmd/skype/report/report-activityuserdetail.md +67 -0
  106. package/docs/docs/cmd/spfx/project/project-doctor.md +3 -3
  107. package/docs/docs/cmd/spfx/project/project-externalize.md +3 -3
  108. package/docs/docs/cmd/spfx/project/project-permissions-grant.md +21 -0
  109. package/docs/docs/cmd/spfx/project/project-upgrade.md +3 -3
  110. package/docs/docs/cmd/spfx/spfx-doctor.md +3 -3
  111. package/docs/docs/cmd/spo/cdn/cdn-get.md +6 -6
  112. package/docs/docs/cmd/spo/cdn/cdn-origin-add.md +3 -3
  113. package/docs/docs/cmd/spo/cdn/cdn-origin-list.md +3 -3
  114. package/docs/docs/cmd/spo/cdn/cdn-origin-remove.md +3 -3
  115. package/docs/docs/cmd/spo/cdn/cdn-policy-list.md +3 -3
  116. package/docs/docs/cmd/spo/cdn/cdn-policy-set.md +3 -3
  117. package/docs/docs/cmd/spo/cdn/cdn-set.md +3 -3
  118. package/docs/docs/cmd/spo/commandset/commandset-add.md +159 -0
  119. package/docs/docs/cmd/spo/commandset/commandset-get.md +149 -0
  120. package/docs/docs/cmd/spo/commandset/commandset-list.md +109 -0
  121. package/docs/docs/cmd/spo/commandset/commandset-remove.md +55 -0
  122. package/docs/docs/cmd/spo/commandset/commandset-set.md +71 -0
  123. package/docs/docs/cmd/spo/customaction/customaction-get.md +113 -11
  124. package/docs/docs/cmd/spo/externaluser/externaluser-list.md +2 -0
  125. package/docs/docs/cmd/spo/group/group-member-add.md +26 -4
  126. package/docs/docs/cmd/spo/hidedefaultthemes/hidedefaultthemes-get.md +2 -0
  127. package/docs/docs/cmd/spo/hidedefaultthemes/hidedefaultthemes-set.md +2 -0
  128. package/docs/docs/cmd/spo/homesite/homesite-remove.md +2 -0
  129. package/docs/docs/cmd/spo/homesite/homesite-set.md +2 -0
  130. package/docs/docs/cmd/spo/knowledgehub/knowledgehub-get.md +2 -0
  131. package/docs/docs/cmd/spo/knowledgehub/knowledgehub-remove.md +2 -0
  132. package/docs/docs/cmd/spo/knowledgehub/knowledgehub-set.md +3 -3
  133. package/docs/docs/cmd/spo/list/list-add.md +2 -2
  134. package/docs/docs/cmd/spo/list/list-set.md +2 -2
  135. package/docs/docs/cmd/spo/listitem/listitem-add.md +1 -1
  136. package/docs/docs/cmd/spo/listitem/listitem-batch-add.md +1 -1
  137. package/docs/docs/cmd/spo/listitem/listitem-set.md +1 -1
  138. package/docs/docs/cmd/spo/navigation/navigation-node-add.md +3 -3
  139. package/docs/docs/cmd/spo/navigation/navigation-node-set.md +2 -2
  140. package/docs/docs/cmd/spo/orgassetslibrary/orgassetslibrary-add.md +2 -0
  141. package/docs/docs/cmd/spo/orgassetslibrary/orgassetslibrary-list.md +2 -0
  142. package/docs/docs/cmd/spo/orgassetslibrary/orgassetslibrary-remove.md +2 -0
  143. package/docs/docs/cmd/spo/orgnewssite/orgnewssite-list.md +2 -0
  144. package/docs/docs/cmd/spo/orgnewssite/orgnewssite-remove.md +2 -0
  145. package/docs/docs/cmd/spo/orgnewssite/orgnewssite-set.md +3 -3
  146. package/docs/docs/cmd/spo/site/site-appcatalog-add.md +2 -0
  147. package/docs/docs/cmd/spo/site/site-appcatalog-remove.md +3 -3
  148. package/docs/docs/cmd/spo/site/site-commsite-enable.md +2 -0
  149. package/docs/docs/cmd/spo/site/site-list.md +3 -3
  150. package/docs/docs/cmd/spo/site/site-remove.md +3 -3
  151. package/docs/docs/cmd/spo/site/site-rename.md +3 -3
  152. package/docs/docs/cmd/spo/site/site-set.md +5 -5
  153. package/docs/docs/cmd/spo/storageentity/storageentity-remove.md +3 -3
  154. package/docs/docs/cmd/spo/storageentity/storageentity-set.md +3 -3
  155. package/docs/docs/cmd/spo/tenant/tenant-appcatalog-add.md +3 -3
  156. package/docs/docs/cmd/spo/tenant/tenant-appcatalogurl-get.md +2 -0
  157. package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-add.md +3 -3
  158. package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-get.md +142 -0
  159. package/docs/docs/cmd/spo/tenant/tenant-recyclebinitem-list.md +2 -0
  160. package/docs/docs/cmd/spo/tenant/tenant-recyclebinitem-remove.md +3 -3
  161. package/docs/docs/cmd/spo/tenant/tenant-recyclebinitem-restore.md +3 -3
  162. package/docs/docs/cmd/spo/tenant/tenant-settings-list.md +2 -0
  163. package/docs/docs/cmd/spo/tenant/tenant-settings-set.md +28 -26
  164. package/docs/docs/cmd/spo/term/term-add.md +3 -3
  165. package/docs/docs/cmd/spo/term/term-get.md +3 -3
  166. package/docs/docs/cmd/spo/term/term-group-add.md +2 -0
  167. package/docs/docs/cmd/spo/term/term-group-get.md +2 -0
  168. package/docs/docs/cmd/spo/term/term-group-list.md +2 -0
  169. package/docs/docs/cmd/spo/term/term-list.md +3 -1
  170. package/docs/docs/cmd/spo/term/term-set-add.md +3 -3
  171. package/docs/docs/cmd/spo/term/term-set-get.md +2 -0
  172. package/docs/docs/cmd/spo/term/term-set-list.md +2 -0
  173. package/docs/docs/cmd/spo/theme/theme-apply.md +3 -3
  174. package/docs/docs/cmd/spo/theme/theme-get.md +2 -0
  175. package/docs/docs/cmd/spo/theme/theme-list.md +2 -0
  176. package/docs/docs/cmd/spo/theme/theme-remove.md +2 -0
  177. package/docs/docs/cmd/spo/theme/theme-set.md +3 -3
  178. package/docs/docs/cmd/spo/user/user-ensure.md +109 -0
  179. package/docs/docs/cmd/teams/channel/channel-get.md +1 -1
  180. package/docs/docs/cmd/teams/channel/channel-member-add.md +2 -2
  181. package/docs/docs/cmd/teams/message/message-get.md +39 -4
  182. package/docs/docs/cmd/teams/message/message-list.md +41 -6
  183. package/docs/docs/cmd/teams/message/message-reply-list.md +39 -4
  184. package/docs/docs/cmd/teams/messagingsettings/messagingsettings-list.md +20 -2
  185. package/docs/docs/cmd/teams/messagingsettings/messagingsettings-set.md +8 -8
  186. package/docs/docs/cmd/teams/report/report-deviceusagedistributionusercounts.md +12 -5
  187. package/docs/docs/cmd/teams/report/report-deviceusageusercounts.md +13 -6
  188. package/docs/docs/cmd/teams/report/report-deviceusageuserdetail.md +14 -7
  189. package/docs/docs/cmd/teams/report/report-directroutingcalls.md +13 -6
  190. package/docs/docs/cmd/teams/report/report-pstncalls.md +13 -6
  191. package/docs/docs/cmd/teams/report/report-useractivitycounts.md +13 -6
  192. package/docs/docs/cmd/teams/report/report-useractivityusercounts.md +13 -6
  193. package/docs/docs/cmd/teams/report/report-useractivityuserdetail.md +13 -6
  194. package/docs/docs/cmd/teams/tab/tab-add.md +16 -0
  195. package/docs/docs/cmd/teams/tab/tab-get.md +17 -0
  196. package/docs/docs/cmd/teams/tab/tab-list.md +19 -0
  197. package/docs/docs/cmd/teams/team/team-add.md +77 -8
  198. package/docs/docs/cmd/teams/team/team-app-list.md +18 -2
  199. package/docs/docs/cmd/teams/team/team-archive.md +2 -2
  200. package/docs/docs/cmd/teams/team/team-clone.md +8 -8
  201. package/docs/docs/cmd/teams/team/team-get.md +34 -4
  202. package/docs/docs/cmd/teams/team/team-list.md +34 -3
  203. package/docs/docs/cmd/teams/team/team-remove.md +3 -3
  204. package/docs/docs/cmd/teams/team/team-set.md +8 -8
  205. package/docs/docs/cmd/teams/team/team-unarchive.md +3 -2
  206. package/docs/docs/cmd/teams/user/user-app-add.md +3 -3
  207. package/docs/docs/cmd/teams/user/user-app-list.md +18 -2
  208. package/docs/docs/cmd/teams/user/user-app-remove.md +4 -4
  209. package/docs/docs/cmd/teams/user/user-list.md +21 -4
  210. package/docs/docs/cmd/todo/task/task-add.md +47 -2
  211. package/npm-shrinkwrap.json +279 -194
  212. package/package.json +15 -14
@@ -112,3 +112,233 @@ Adds a Microsoft Planner task with the name _My Planner Task_ for plan with the
112
112
  ```sh
113
113
  m365 planner task add --title "My Planner Task" --planId "8QZEH7b3wkSbGQobscsM5gADCBa" --bucketId "IK8tuFTwQEa5vTonM7ZMRZgAKdna" --appliedCategories "category1,category3" --previewType "noPreview"
114
114
  ```
115
+
116
+ ## Response
117
+
118
+ ### Standard response
119
+
120
+ === "JSON"
121
+
122
+ ```json
123
+ {
124
+ "planId": "oUHpnKBFekqfGE_PS6GGUZcAFY7b",
125
+ "bucketId": "vncYUXCRBke28qMLB-d4xJcACtNz",
126
+ "title": "Important task",
127
+ "orderHint": "8585269241124027581",
128
+ "assigneePriority": "",
129
+ "percentComplete": 50,
130
+ "startDateTime": "2023-01-20T00:00:00Z",
131
+ "createdDateTime": "2023-01-25T21:39:33.0748226Z",
132
+ "dueDateTime": "2023-02-15T00:00:00Z",
133
+ "hasDescription": false,
134
+ "previewType": "automatic",
135
+ "completedDateTime": null,
136
+ "completedBy": null,
137
+ "referenceCount": 0,
138
+ "checklistItemCount": 0,
139
+ "activeChecklistItemCount": 0,
140
+ "conversationThreadId": null,
141
+ "priority": 5,
142
+ "id": "D-ys8Ef4kEuwYG4r68Um3pcAAe9M",
143
+ "createdBy": {
144
+ "user": {
145
+ "displayName": null,
146
+ "id": "b2091e18-7882-4efe-b7d1-90703f5a5c65"
147
+ },
148
+ "application": {
149
+ "displayName": null,
150
+ "id": "31359c7f-bd7e-475c-86db-fdb8c937548e"
151
+ }
152
+ },
153
+ "appliedCategories": {},
154
+ "assignments": {}
155
+ }
156
+ ```
157
+
158
+ === "Text"
159
+
160
+ ```text
161
+ activeChecklistItemCount: 0
162
+ appliedCategories : {}
163
+ assigneePriority :
164
+ assignments : {}
165
+ bucketId : vncYUXCRBke28qMLB-d4xJcACtNz
166
+ checklistItemCount : 0
167
+ completedBy : null
168
+ completedDateTime : null
169
+ conversationThreadId : null
170
+ createdBy : {"user":{"displayName":null,"id":"b2091e18-7882-4efe-b7d1-90703f5a5c65"},"application":{"displayName":null,"id":"31359c7f-bd7e-475c-86db-fdb8c937548e"}}
171
+ createdDateTime : 2023-01-25T21:44:10.6044385Z
172
+ dueDateTime : 2023-02-15T00:00:00Z
173
+ hasDescription : false
174
+ id : D-ys8Ef4kEuwYG4r68Um3pcAAe9M
175
+ orderHint : 8585269238348731422
176
+ percentComplete : 50
177
+ planId : oUHpnKBFekqfGE_PS6GGUZcAFY7b
178
+ previewType : automatic
179
+ priority : 5
180
+ referenceCount : 0
181
+ references : {}
182
+ startDateTime : 2023-01-20T00:00:00Z
183
+ title : Important task
184
+ ```
185
+
186
+ === "CSV"
187
+
188
+ ```csv
189
+ planId,bucketId,title,orderHint,assigneePriority,percentComplete,startDateTime,createdDateTime,dueDateTime,hasDescription,previewType,completedDateTime,completedBy,referenceCount,checklistItemCount,activeChecklistItemCount,conversationThreadId,priority,id,createdBy,appliedCategories,assignments
190
+ oUHpnKBFekqfGE_PS6GGUZcAFY7b,vncYUXCRBke28qMLB-d4xJcACtNz,Important task,8585269237867589640,,50,2023-01-20T00:00:00Z,2023-01-25T21:44:58.7186167Z,2023-02-15T00:00:00Z,,automatic,,,0,0,0,,5,D-ys8Ef4kEuwYG4r68Um3pcAAe9M,"{""user"":{""displayName"":null,""id"":""b2091e18-7882-4efe-b7d1-90703f5a5c65""},""application"":{""displayName"":null,""id"":""31359c7f-bd7e-475c-86db-fdb8c937548e""}}",{},{}
191
+ ```
192
+
193
+ === "Markdown"
194
+
195
+ ```md
196
+ # planner task add --planId "oUHpnKBFekqfGE_PS6GGUZcAFY7b" --bucketName "To do" --startDateTime "2023-01-20" --dueDateTime "2023-02-15" --percentComplete "50" --title "Important task"
197
+
198
+ Date: 25/1/2023
199
+
200
+ ## Important task (D-ys8Ef4kEuwYG4r68Um3pcAAe9M)
201
+
202
+ Property | Value
203
+ ---------|-------
204
+ planId | oUHpnKBFekqfGE\_PS6GGUZcAFY7b
205
+ bucketId | vncYUXCRBke28qMLB-d4xJcACtNz
206
+ title | Important task
207
+ orderHint | 8585269235419217847
208
+ assigneePriority |
209
+ percentComplete | 50
210
+ startDateTime | 2023-01-20T00:00:00Z
211
+ createdDateTime | 2023-01-25T21:49:03.555796Z
212
+ dueDateTime | 2023-02-15T00:00:00Z
213
+ hasDescription | false
214
+ previewType | automatic
215
+ completedDateTime | null
216
+ completedBy | null
217
+ referenceCount | 0
218
+ checklistItemCount | 0
219
+ activeChecklistItemCount | 0
220
+ conversationThreadId | null
221
+ priority | 5
222
+ id | D-ys8Ef4kEuwYG4r68Um3pcAAe9M
223
+ createdBy | {"user":{"displayName":null,"id":"b2091e18-7882-4efe-b7d1-90703f5a5c65"},"application":{"displayName":null,"id":"31359c7f-bd7e-475c-86db-fdb8c937548e"}}
224
+ appliedCategories | {}
225
+ assignments | {}
226
+ ```
227
+
228
+ ### `description`, `previewType` response
229
+
230
+ === "JSON"
231
+
232
+ ```json
233
+ {
234
+ "planId": "oUHpnKBFekqfGE_PS6GGUZcAFY7b",
235
+ "bucketId": "vncYUXCRBke28qMLB-d4xJcACtNz",
236
+ "title": "Important task",
237
+ "orderHint": "8585269241124027581",
238
+ "assigneePriority": "",
239
+ "percentComplete": 50,
240
+ "startDateTime": "2023-01-20T00:00:00Z",
241
+ "createdDateTime": "2023-01-25T21:39:33.0748226Z",
242
+ "dueDateTime": "2023-02-15T00:00:00Z",
243
+ "hasDescription": true,
244
+ "previewType": "automatic",
245
+ "completedDateTime": null,
246
+ "completedBy": null,
247
+ "referenceCount": 0,
248
+ "checklistItemCount": 0,
249
+ "activeChecklistItemCount": 0,
250
+ "conversationThreadId": null,
251
+ "priority": 5,
252
+ "id": "D-ys8Ef4kEuwYG4r68Um3pcAAe9M",
253
+ "createdBy": {
254
+ "user": {
255
+ "displayName": null,
256
+ "id": "b2091e18-7882-4efe-b7d1-90703f5a5c65"
257
+ },
258
+ "application": {
259
+ "displayName": null,
260
+ "id": "31359c7f-bd7e-475c-86db-fdb8c937548e"
261
+ }
262
+ },
263
+ "appliedCategories": {},
264
+ "assignments": {},
265
+ "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
266
+ "references": {},
267
+ "checklist": {}
268
+ }
269
+ ```
270
+
271
+ === "Text"
272
+
273
+ ```txt
274
+ activeChecklistItemCount: 0
275
+ appliedCategories : {}
276
+ assigneePriority :
277
+ assignments : {}
278
+ bucketId : vncYUXCRBke28qMLB-d4xJcACtNz
279
+ checklist : {}
280
+ checklistItemCount : 0
281
+ completedBy : null
282
+ completedDateTime : null
283
+ conversationThreadId : null
284
+ createdBy : {"user":{"displayName":null,"id":"b2091e18-7882-4efe-b7d1-90703f5a5c65"},"application":{"displayName":null,"id":"31359c7f-bd7e-475c-86db-fdb8c937548e"}}
285
+ createdDateTime : 2023-01-25T21:44:10.6044385Z
286
+ description : Lorem ipsum dolor sit amet, consectetur adipiscing elit.
287
+ dueDateTime : 2023-02-15T00:00:00Z
288
+ hasDescription : true
289
+ id : D-ys8Ef4kEuwYG4r68Um3pcAAe9M
290
+ orderHint : 8585269238348731422
291
+ percentComplete : 50
292
+ planId : oUHpnKBFekqfGE_PS6GGUZcAFY7b
293
+ previewType : automatic
294
+ priority : 5
295
+ referenceCount : 0
296
+ references : {}
297
+ startDateTime : 2023-01-20T00:00:00Z
298
+ title : Important task
299
+ ```
300
+
301
+ === "CSV"
302
+
303
+ ```csv
304
+ planId,bucketId,title,orderHint,assigneePriority,percentComplete,startDateTime,createdDateTime,dueDateTime,hasDescription,previewType,completedDateTime,completedBy,referenceCount,checklistItemCount,activeChecklistItemCount,conversationThreadId,priority,id,createdBy,appliedCategories,assignments,description,references,checklist
305
+ oUHpnKBFekqfGE_PS6GGUZcAFY7b,vncYUXCRBke28qMLB-d4xJcACtNz,Important task,8585269237867589640,,50,2023-01-20T00:00:00Z,2023-01-25T21:44:58.7186167Z,2023-02-15T00:00:00Z,1,automatic,,,0,0,0,,5,D-ys8Ef4kEuwYG4r68Um3pcAAe9M,"{""user"":{""displayName"":null,""id"":""b2091e18-7882-4efe-b7d1-90703f5a5c65""},""application"":{""displayName"":null,""id"":""31359c7f-bd7e-475c-86db-fdb8c937548e""}}",{},{},"Lorem ipsum dolor sit amet, consectetur adipiscing elit.",{},{}
306
+ ```
307
+
308
+ === "Markdown"
309
+
310
+ ```md
311
+ # planner task add --planId "oUHpnKBFekqfGE_PS6GGUZcAFY7b" --bucketName "To do" --startDateTime "2023-01-20" --dueDateTime "2023-02-15" --percentComplete "50" --title "Important task" --description "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
312
+
313
+ Date: 25/1/2023
314
+
315
+ ## Important task (D-ys8Ef4kEuwYG4r68Um3pcAAe9M)
316
+
317
+ Property | Value
318
+ ---------|-------
319
+ planId | oUHpnKBFekqfGE\_PS6GGUZcAFY7b
320
+ bucketId | vncYUXCRBke28qMLB-d4xJcACtNz
321
+ title | Important task
322
+ orderHint | 8585269235419217847
323
+ assigneePriority |
324
+ percentComplete | 50
325
+ startDateTime | 2023-01-20T00:00:00Z
326
+ createdDateTime | 2023-01-25T21:49:03.555796Z
327
+ dueDateTime | 2023-02-15T00:00:00Z
328
+ hasDescription | true
329
+ previewType | automatic
330
+ completedDateTime | null
331
+ completedBy | null
332
+ referenceCount | 0
333
+ checklistItemCount | 0
334
+ activeChecklistItemCount | 0
335
+ conversationThreadId | null
336
+ priority | 5
337
+ id | D-ys8Ef4kEuwYG4r68Um3pcAAe9M
338
+ createdBy | {"user":{"displayName":null,"id":"b2091e18-7882-4efe-b7d1-90703f5a5c65"},"application":{"displayName":null,"id":"31359c7f-bd7e-475c-86db-fdb8c937548e"}}
339
+ appliedCategories | {}
340
+ assignments | {}
341
+ description | Lorem ipsum dolor sit amet, consectetur adipiscing elit.
342
+ references | {}
343
+ checklist | {}
344
+ ```
@@ -34,3 +34,58 @@ Adds a checked checklist item with title _My checklist item_ to a Microsoft Plan
34
34
  ```sh
35
35
  m365 planner task checklistitem add --taskId 2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2 --title "My checklist item" --isChecked
36
36
  ```
37
+
38
+ ## Response
39
+
40
+ === "JSON"
41
+
42
+ ```json
43
+ {
44
+ "b65db83e-d777-49db-8cdd-57a41b86f48c": {
45
+ "isChecked": false,
46
+ "title": "Communicate with customer",
47
+ "orderHint": "8585269221832287402",
48
+ "lastModifiedDateTime": "2023-01-25T22:11:42.2488405Z",
49
+ "lastModifiedBy": {
50
+ "user": {
51
+ "displayName": null,
52
+ "id": "b2091e18-7882-4efe-b7d1-90703f5a5c65"
53
+ }
54
+ }
55
+ }
56
+ }
57
+ ```
58
+
59
+ === "Text"
60
+
61
+ ```txt
62
+ id : b65db83e-d777-49db-8cdd-57a41b86f48c
63
+ isChecked: false
64
+ title : Communicate with customer
65
+ ```
66
+
67
+ === "CSV"
68
+
69
+ ```csv
70
+ id,title,isChecked
71
+ b65db83e-d777-49db-8cdd-57a41b86f48c,Communicate with customer,
72
+ ```
73
+
74
+ === "Markdown"
75
+
76
+ ```md
77
+ # planner task checklistitem add --taskId "OopX1ANphEu7Lm4-0tVtl5cAFRGQ" --title "Communicate with customer"
78
+
79
+ Date: 25/1/2023
80
+
81
+ ## Communicate with customer (b65db83e-d777-49db-8cdd-57a41b86f48c)
82
+
83
+ Property | Value
84
+ ---------|-------
85
+ id | b65db83e-d777-49db-8cdd-57a41b86f48c
86
+ isChecked | false
87
+ title | Communicate with customer
88
+ orderHint | 8585269209601773376
89
+ lastModifiedDateTime | 2023-01-25T22:32:05.3002431Z
90
+ lastModifiedBy | {"user":{"displayName":null,"id":"b2091e18-7882-4efe-b7d1-90703f5a5c65"}}
91
+ ```
@@ -22,3 +22,58 @@ Lists the checklist items of a Planner task.
22
22
  ```sh
23
23
  m365 planner task checklistitem list --taskId 'vzCcZoOv-U27PwydxHB8opcADJo-'
24
24
  ```
25
+
26
+ ## Response
27
+
28
+ === "JSON"
29
+
30
+ ```json
31
+ {
32
+ "4e3c8841-560c-436e-ba06-cc7731680d59": {
33
+ "isChecked": false,
34
+ "title": "Communicate with customer",
35
+ "orderHint": "8585269209601773376",
36
+ "lastModifiedDateTime": "2023-01-25T22:32:05.3002431Z",
37
+ "lastModifiedBy": {
38
+ "user": {
39
+ "displayName": null,
40
+ "id": "b2091e18-7882-4efe-b7d1-90703f5a5c65"
41
+ }
42
+ }
43
+ }
44
+ }
45
+ ```
46
+
47
+ === "Text"
48
+
49
+ ```txt
50
+ id title isChecked
51
+ ------------------------------------ ------------------------- ---------
52
+ 4e3c8841-560c-436e-ba06-cc7731680d59 Communicate with customer false
53
+ ```
54
+
55
+ === "CSV"
56
+
57
+ ```csv
58
+ id,title,isChecked
59
+ 4e3c8841-560c-436e-ba06-cc7731680d59,Communicate with customer,
60
+ ```
61
+
62
+ === "Markdown"
63
+
64
+ ```md
65
+ # planner task checklistitem list --taskId "OopX1ANphEu7Lm4-0tVtl5cAFRGQ"
66
+
67
+ Date: 25/1/2023
68
+
69
+ ## Communicate with customer (4e3c8841-560c-436e-ba06-cc7731680d59)
70
+
71
+ Property | Value
72
+ ---------|-------
73
+ id | 4e3c8841-560c-436e-ba06-cc7731680d59
74
+ isChecked | false
75
+ title | Communicate with customer
76
+ orderHint | 8585269209601773376
77
+ lastModifiedDateTime | 2023-01-25T22:32:05.3002431Z
78
+ lastModifiedBy | {"user":{"displayName":null,"id":"b2091e18-7882-4efe-b7d1-90703f5a5c65"}}
79
+ ```
@@ -34,3 +34,7 @@ Removes a checklist item with the id _40012_ from the Planner task with the id _
34
34
  ```sh
35
35
  m365 planner task checklistitem remove --id "40012" --taskId "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2" --confirm
36
36
  ```
37
+
38
+ ## Response
39
+
40
+ The command won't return a response on success.
@@ -55,3 +55,134 @@ Retrieve the specified planner task with the title _My Planner Task_ from the bu
55
55
  ```sh
56
56
  m365 planner task get --title "My Planner Task" --bucketName "My Planner Bucket" --planTitle "My Planner Plan" --ownerGroupName "My Planner Group"
57
57
  ```
58
+
59
+ ## Response
60
+
61
+ === "JSON"
62
+
63
+ ```json
64
+ {
65
+ "planId": "oUHpnKBFekqfGE_PS6GGUZcAFY7b",
66
+ "bucketId": "vncYUXCRBke28qMLB-d4xJcACtNz",
67
+ "title": "Important task",
68
+ "orderHint": "8585269235419217847",
69
+ "assigneePriority": "",
70
+ "percentComplete": 50,
71
+ "startDateTime": "2023-01-20T00:00:00Z",
72
+ "createdDateTime": "2023-01-25T21:49:03.555796Z",
73
+ "dueDateTime": "2023-02-15T00:00:00Z",
74
+ "hasDescription": true,
75
+ "previewType": "automatic",
76
+ "completedDateTime": null,
77
+ "completedBy": null,
78
+ "referenceCount": 0,
79
+ "checklistItemCount": 2,
80
+ "activeChecklistItemCount": 2,
81
+ "conversationThreadId": null,
82
+ "priority": 5,
83
+ "id": "OopX1ANphEu7Lm4-0tVtl5cAFRGQ",
84
+ "createdBy": {
85
+ "user": {
86
+ "displayName": null,
87
+ "id": "b2091e18-7882-4efe-b7d1-90703f5a5c65"
88
+ },
89
+ "application": {
90
+ "displayName": null,
91
+ "id": "31359c7f-bd7e-475c-86db-fdb8c937548e"
92
+ }
93
+ },
94
+ "appliedCategories": {},
95
+ "assignments": {},
96
+ "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
97
+ "references": {},
98
+ "checklist": {
99
+ "4e3c8841-560c-436e-ba06-cc7731680d59": {
100
+ "isChecked": false,
101
+ "title": "Communicate with customer",
102
+ "orderHint": "8585269209601773376",
103
+ "lastModifiedDateTime": "2023-01-25T22:32:05.3002431Z",
104
+ "lastModifiedBy": {
105
+ "user": {
106
+ "displayName": null,
107
+ "id": "b2091e18-7882-4efe-b7d1-90703f5a5c65"
108
+ }
109
+ }
110
+ }
111
+ }
112
+ }
113
+ ```
114
+
115
+ === "Text"
116
+
117
+ ```txt
118
+ activeChecklistItemCount: 1
119
+ appliedCategories : {}
120
+ assigneePriority :
121
+ assignments : {}
122
+ bucketId : vncYUXCRBke28qMLB-d4xJcACtNz
123
+ checklist : {"4e3c8841-560c-436e-ba06-cc7731680d59":{"isChecked":false,"title":"Communicate with customer","orderHint":"8585269209601773376","lastModifiedDateTime":"2023-01-25T22:32:05.3002431Z","lastModifiedBy":{"user":{"displayName":null,"id":"b2091e18-7882-4efe-b7d1-90703f5a5c65"}}}}
124
+ checklistItemCount : 1
125
+ completedBy : null
126
+ completedDateTime : null
127
+ conversationThreadId : null
128
+ createdBy : {"user":{"displayName":null,"id":"b2091e18-7882-4efe-b7d1-90703f5a5c65"},"application":{"displayName":null,"id":"31359c7f-bd7e-475c-86db-fdb8c937548e"}}
129
+ createdDateTime : 2023-01-25T21:49:03.555796Z
130
+ description : Lorem ipsum dolor sit amet, consectetur adipiscing elit.
131
+ dueDateTime : 2023-02-15T00:00:00Z
132
+ hasDescription : true
133
+ id : OopX1ANphEu7Lm4-0tVtl5cAFRGQ
134
+ orderHint : 8585269235419217847
135
+ percentComplete : 50
136
+ planId : oUHpnKBFekqfGE_PS6GGUZcAFY7b
137
+ previewType : automatic
138
+ priority : 5
139
+ referenceCount : 0
140
+ references : {}
141
+ startDateTime : 2023-01-20T00:00:00Z
142
+ title : Important task
143
+ ```
144
+
145
+ === "CSV"
146
+
147
+ ```csv
148
+ planId,bucketId,title,orderHint,assigneePriority,percentComplete,startDateTime,createdDateTime,dueDateTime,hasDescription,previewType,completedDateTime,completedBy,referenceCount,checklistItemCount,activeChecklistItemCount,conversationThreadId,priority,id,createdBy,appliedCategories,assignments,description,references,checklist
149
+ oUHpnKBFekqfGE_PS6GGUZcAFY7b,vncYUXCRBke28qMLB-d4xJcACtNz,Important task,8585269235419217847,,50,2023-01-20T00:00:00Z,2023-01-25T21:49:03.555796Z,2023-02-15T00:00:00Z,1,automatic,,,0,1,1,,5,OopX1ANphEu7Lm4-0tVtl5cAFRGQ,"{""user"":{""displayName"":null,""id"":""b2091e18-7882-4efe-b7d1-90703f5a5c65""},""application"":{""displayName"":null,""id"":""31359c7f-bd7e-475c-86db-fdb8c937548e""}}",{},{},"Lorem ipsum dolor sit amet, consectetur adipiscing elit.",{},"{""4e3c8841-560c-436e-ba06-cc7731680d59"":{""isChecked"":false,""title"":""Communicate with customer"",""orderHint"":""8585269209601773376"",""lastModifiedDateTime"":""2023-01-25T22:32:05.3002431Z"",""lastModifiedBy"":{""user"":{""displayName"":null,""id"":""b2091e18-7882-4efe-b7d1-90703f5a5c65""}}}}"
150
+ ```
151
+
152
+ === "Markdown"
153
+
154
+ ```md
155
+ # planner task get --id "OopX1ANphEu7Lm4-0tVtl5cAFRGQ"
156
+
157
+ Date: 25/1/2023
158
+
159
+ ## Important task (OopX1ANphEu7Lm4-0tVtl5cAFRGQ)
160
+
161
+ Property | Value
162
+ ---------|-------
163
+ planId | oUHpnKBFekqfGE\_PS6GGUZcAFY7b
164
+ bucketId | vncYUXCRBke28qMLB-d4xJcACtNz
165
+ title | Important task
166
+ orderHint | 8585269235419217847
167
+ assigneePriority |
168
+ percentComplete | 50
169
+ startDateTime | 2023-01-20T00:00:00Z
170
+ createdDateTime | 2023-01-25T21:49:03.555796Z
171
+ dueDateTime | 2023-02-15T00:00:00Z
172
+ hasDescription | true
173
+ previewType | automatic
174
+ completedDateTime | null
175
+ completedBy | null
176
+ referenceCount | 0
177
+ checklistItemCount | 1
178
+ activeChecklistItemCount | 1
179
+ conversationThreadId | null
180
+ priority | 5
181
+ id | OopX1ANphEu7Lm4-0tVtl5cAFRGQ
182
+ createdBy | {"user":{"displayName":null,"id":"b2091e18-7882-4efe-b7d1-90703f5a5c65"},"application":{"displayName":null,"id":"31359c7f-bd7e-475c-86db-fdb8c937548e"}}
183
+ appliedCategories | {}
184
+ assignments | {}
185
+ description | Lorem ipsum dolor sit amet, consectetur adipiscing elit.
186
+ references | {}
187
+ checklist | {"4e3c8841-560c-436e-ba06-cc7731680d59":{"isChecked":false,"title":"Communicate with customer","orderHint":"8585269209601773376","lastModifiedDateTime":"2023-01-25T22:32:05.3002431Z","lastModifiedBy":{"user":{"displayName":null,"id":"b2091e18-7882-4efe-b7d1-90703f5a5c65"}}}}
188
+ ```
@@ -72,3 +72,95 @@ List the Microsoft Planner tasks in the bucket _My Bucket_ belonging to plan _My
72
72
  ```sh
73
73
  m365 planner task list --bucketName "My Bucket" --planTitle "My Plan" --ownerGroupName "My Group"
74
74
  ```
75
+
76
+ ## Response
77
+
78
+ === "JSON"
79
+
80
+ ```json
81
+ [
82
+ {
83
+ "planId": "oUHpnKBFekqfGE_PS6GGUZcAFY7b",
84
+ "bucketId": "vncYUXCRBke28qMLB-d4xJcACtNz",
85
+ "title": "Important task",
86
+ "orderHint": "8585269235419217847",
87
+ "assigneePriority": "",
88
+ "percentComplete": 50,
89
+ "startDateTime": "2023-01-20T00:00:00Z",
90
+ "createdDateTime": "2023-01-25T21:49:03.555796Z",
91
+ "dueDateTime": "2023-02-15T00:00:00Z",
92
+ "hasDescription": true,
93
+ "previewType": "automatic",
94
+ "completedDateTime": null,
95
+ "completedBy": null,
96
+ "referenceCount": 0,
97
+ "checklistItemCount": 1,
98
+ "activeChecklistItemCount": 1,
99
+ "conversationThreadId": null,
100
+ "priority": 5,
101
+ "id": "OopX1ANphEu7Lm4-0tVtl5cAFRGQ",
102
+ "createdBy": {
103
+ "user": {
104
+ "displayName": null,
105
+ "id": "b2091e18-7882-4efe-b7d1-90703f5a5c65"
106
+ },
107
+ "application": {
108
+ "displayName": null,
109
+ "id": "31359c7f-bd7e-475c-86db-fdb8c937548e"
110
+ }
111
+ },
112
+ "appliedCategories": {},
113
+ "assignments": {}
114
+ }
115
+ ]
116
+ ```
117
+
118
+ === "Text"
119
+
120
+ ```txt
121
+ id title startDateTime dueDateTime completedDateTime
122
+ ---------------------------- -------------- -------------------- -------------------- -----------------
123
+ OopX1ANphEu7Lm4-0tVtl5cAFRGQ Important task 2023-01-20T00:00:00Z 2023-02-15T00:00:00Z null
124
+ ```
125
+
126
+ === "CSV"
127
+
128
+ ```csv
129
+ id,title,startDateTime,dueDateTime,completedDateTime
130
+ OopX1ANphEu7Lm4-0tVtl5cAFRGQ,Important task,2023-01-20T00:00:00Z,2023-02-15T00:00:00Z,
131
+ ```
132
+
133
+ === "Markdown"
134
+
135
+ ```md
136
+ # planner task list --planId "oUHpnKBFekqfGE_PS6GGUZcAFY7b" --bucketName "To do"
137
+
138
+ Date: 25/1/2023
139
+
140
+ ## Important task (OopX1ANphEu7Lm4-0tVtl5cAFRGQ)
141
+
142
+ Property | Value
143
+ ---------|-------
144
+ planId | oUHpnKBFekqfGE\_PS6GGUZcAFY7b
145
+ bucketId | vncYUXCRBke28qMLB-d4xJcACtNz
146
+ title | Important task
147
+ orderHint | 8585269235419217847
148
+ assigneePriority |
149
+ percentComplete | 50
150
+ startDateTime | 2023-01-20T00:00:00Z
151
+ createdDateTime | 2023-01-25T21:49:03.555796Z
152
+ dueDateTime | 2023-02-15T00:00:00Z
153
+ hasDescription | true
154
+ previewType | automatic
155
+ completedDateTime | null
156
+ completedBy | null
157
+ referenceCount | 0
158
+ checklistItemCount | 1
159
+ activeChecklistItemCount | 1
160
+ conversationThreadId | null
161
+ priority | 5
162
+ id | OopX1ANphEu7Lm4-0tVtl5cAFRGQ
163
+ createdBy | {"user":{"displayName":null,"id":"b2091e18-7882-4efe-b7d1-90703f5a5c65"},"application":{"displayName":null,"id":"31359c7f-bd7e-475c-86db-fdb8c937548e"}}
164
+ appliedCategories | {}
165
+ assignments | {}
166
+ ```
@@ -43,3 +43,49 @@ Add a new reference with the url _https://www.microsoft.com_ and with the type E
43
43
  ```sh
44
44
  m365 planner task reference add --taskId "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2" --url "https://www.microsoft.com" --type "Excel"
45
45
  ```
46
+
47
+ ## Response
48
+
49
+ === "JSON"
50
+
51
+ ```json
52
+ {
53
+ "https%3A//microsoft%2Ecom": {
54
+ "alias": null,
55
+ "type": null,
56
+ "previewPriority": "8585269190192498871PB",
57
+ "lastModifiedDateTime": "2023-01-25T23:05:26.24332Z",
58
+ "lastModifiedBy": {
59
+ "user": {
60
+ "displayName": null,
61
+ "id": "b2091e18-7882-4efe-b7d1-90703f5a5c65"
62
+ }
63
+ }
64
+ }
65
+ }
66
+ ```
67
+
68
+ === "Text"
69
+
70
+ ```txt
71
+ https%3A//microsoft%2Ecom: {"alias":null,"type":null,"previewPriority":"8585269190192498871PB","lastModifiedDateTime":"2023-01-25T23:05:26.24332Z","lastModifiedBy":{"user":{"displayName":null,"id":"b2091e18-7882-4efe-b7d1-90703f5a5c65"}}}
72
+ ```
73
+
74
+ === "CSV"
75
+
76
+ ```csv
77
+ https%3A//microsoft%2Ecom
78
+ "{""alias"":null,""type"":null,""previewPriority"":""8585269190192498871PB"",""lastModifiedDateTime"":""2023-01-25T23:05:26.24332Z"",""lastModifiedBy"":{""user"":{""displayName"":null,""id"":""b2091e18-7882-4efe-b7d1-90703f5a5c65""}}}"
79
+ ```
80
+
81
+ === "Markdown"
82
+
83
+ ```md
84
+ # planner task reference add --taskId "OopX1ANphEu7Lm4-0tVtl5cAFRGQ" --url "https://microsoft.com"
85
+
86
+ Date: 4/2/2023
87
+
88
+ Property | Value
89
+ ---------|-------
90
+ https%3A//microsoft%2Ecom | {"alias":null,"type":null,"previewPriority":"8585269190192498871PB;","lastModifiedDateTime":"2023-01-25T23:05:26.24332Z","lastModifiedBy":{"user":{"displayName":null,"id":"b2091e18-7882-4efe-b7d1-90703f5a5c65"}}}
91
+ ```