ResponseDefinitions.php 6.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * SPDX-FileCopyrightText: 2023 Nextcloud GmbH and Nextcloud contributors
  5. * SPDX-License-Identifier: AGPL-3.0-or-later
  6. */
  7. namespace OCA\Files_Sharing;
  8. /**
  9. * @psalm-type Files_SharingShare = array{
  10. * attributes: ?string,
  11. * can_delete: bool,
  12. * can_edit: bool,
  13. * displayname_file_owner: string,
  14. * displayname_owner: string,
  15. * expiration: ?string,
  16. * file_parent: int,
  17. * file_source: int,
  18. * file_target: string,
  19. * has_preview: bool,
  20. * hide_download: 0|1,
  21. * id: string,
  22. * item_mtime: int,
  23. * item_permissions?: int,
  24. * item_size: float|int,
  25. * item_source: int,
  26. * item_type: 'file'|'folder',
  27. * label: string,
  28. * mail_send: 0|1,
  29. * mimetype: string,
  30. * note: string,
  31. * parent: null,
  32. * password?: null|string,
  33. * password_expiration_time?: ?string,
  34. * path: ?string,
  35. * permissions: int,
  36. * send_password_by_talk?: bool,
  37. * share_type: int,
  38. * share_with?: null|string,
  39. * share_with_avatar?: string,
  40. * share_with_displayname?: string,
  41. * share_with_displayname_unique?: ?string,
  42. * share_with_link?: string,
  43. * status?: array{clearAt: int|null, icon: ?string, message: ?string, status: string},
  44. * stime: int,
  45. * storage: int,
  46. * storage_id: string,
  47. * token: ?string,
  48. * uid_file_owner: string,
  49. * uid_owner: string,
  50. * url?: string,
  51. * }
  52. *
  53. * @psalm-type Files_SharingDeletedShare = array{
  54. * id: string,
  55. * share_type: int,
  56. * uid_owner: string,
  57. * displayname_owner: string,
  58. * permissions: int,
  59. * stime: int,
  60. * uid_file_owner: string,
  61. * displayname_file_owner: string,
  62. * path: string,
  63. * item_type: string,
  64. * mimetype: string,
  65. * storage: int,
  66. * item_source: int,
  67. * file_source: int,
  68. * file_parent: int,
  69. * file_target: int,
  70. * expiration: string|null,
  71. * share_with: string|null,
  72. * share_with_displayname: string|null,
  73. * share_with_link: string|null,
  74. * }
  75. *
  76. * @psalm-type Files_SharingRemoteShare = array{
  77. * accepted: bool,
  78. * file_id: int|null,
  79. * id: int,
  80. * mimetype: string|null,
  81. * mountpoint: string,
  82. * mtime: int|null,
  83. * name: string,
  84. * owner: string,
  85. * parent: int|null,
  86. * permissions: int|null,
  87. * remote: string,
  88. * remote_id: string,
  89. * share_token: string,
  90. * share_type: int,
  91. * type: string|null,
  92. * user: string,
  93. * }
  94. *
  95. * @psalm-type Files_SharingSharee = array{
  96. * count: int|null,
  97. * label: string,
  98. * }
  99. *
  100. * @psalm-type Files_SharingShareeValue = array{
  101. * shareType: int,
  102. * shareWith: string,
  103. * }
  104. *
  105. * @psalm-type Files_SharingShareeUser = Files_SharingSharee&array{
  106. * subline: string,
  107. * icon: string,
  108. * shareWithDisplayNameUnique: string,
  109. * status: array{
  110. * status: string,
  111. * message: string,
  112. * icon: string,
  113. * clearAt: int|null,
  114. * },
  115. * value: Files_SharingShareeValue,
  116. * }
  117. *
  118. * @psalm-type Files_SharingShareeRemoteGroup = Files_SharingSharee&array{
  119. * guid: string,
  120. * name: string,
  121. * value: Files_SharingShareeValue&array{
  122. * server: string,
  123. * }
  124. * }
  125. *
  126. * @psalm-type Files_SharingLookup = array{
  127. * value: string,
  128. * verified: int,
  129. * }
  130. *
  131. * @psalm-type Files_SharingShareeLookup = Files_SharingSharee&array{
  132. * extra: array{
  133. * federationId: string,
  134. * name: Files_SharingLookup|null,
  135. * email: Files_SharingLookup|null,
  136. * address: Files_SharingLookup|null,
  137. * website: Files_SharingLookup|null,
  138. * twitter: Files_SharingLookup|null,
  139. * phone: Files_SharingLookup|null,
  140. * twitter_signature: Files_SharingLookup|null,
  141. * website_signature: Files_SharingLookup|null,
  142. * userid: Files_SharingLookup|null,
  143. * },
  144. * value: Files_SharingShareeValue&array{
  145. * globalScale: bool,
  146. * }
  147. * }
  148. *
  149. * @psalm-type Files_SharingShareeEmail = Files_SharingSharee&array{
  150. * uuid: string,
  151. * name: string,
  152. * type: string,
  153. * shareWithDisplayNameUnique: string,
  154. * value: Files_SharingShareeValue,
  155. * }
  156. *
  157. * @psalm-type Files_SharingShareeRemote = Files_SharingSharee&array{
  158. * uuid: string,
  159. * name: string,
  160. * type: string,
  161. * value: Files_SharingShareeValue&array{
  162. * server: string,
  163. * }
  164. * }
  165. *
  166. * @psalm-type Files_SharingShareeCircle = Files_SharingSharee&array{
  167. * shareWithDescription: string,
  168. * value: Files_SharingShareeValue&array{
  169. * circle: string,
  170. * }
  171. * }
  172. *
  173. * @psalm-type Files_SharingShareesSearchResult = array{
  174. * exact: array{
  175. * circles: Files_SharingShareeCircle[],
  176. * emails: Files_SharingShareeEmail[],
  177. * groups: Files_SharingSharee[],
  178. * remote_groups: Files_SharingShareeRemoteGroup[],
  179. * remotes: Files_SharingShareeRemote[],
  180. * rooms: Files_SharingSharee[],
  181. * users: Files_SharingShareeUser[],
  182. * },
  183. * circles: Files_SharingShareeCircle[],
  184. * emails: Files_SharingShareeEmail[],
  185. * groups: Files_SharingSharee[],
  186. * lookup: Files_SharingShareeLookup[],
  187. * remote_groups: Files_SharingShareeRemoteGroup[],
  188. * remotes: Files_SharingShareeRemote[],
  189. * rooms: Files_SharingSharee[],
  190. * users: Files_SharingShareeUser[],
  191. * lookupEnabled: bool,
  192. * }
  193. *
  194. * @psalm-type Files_SharingShareesRecommendedResult = array{
  195. * exact: array{
  196. * emails: Files_SharingShareeEmail[],
  197. * groups: Files_SharingSharee[],
  198. * remote_groups: Files_SharingShareeRemoteGroup[],
  199. * remotes: Files_SharingShareeRemote[],
  200. * users: Files_SharingShareeUser[],
  201. * },
  202. * emails: Files_SharingShareeEmail[],
  203. * groups: Files_SharingSharee[],
  204. * remote_groups: Files_SharingShareeRemoteGroup[],
  205. * remotes: Files_SharingShareeRemote[],
  206. * users: Files_SharingShareeUser[],
  207. * }
  208. *
  209. * @psalm-type Files_SharingShareInfo = array{
  210. * id: int,
  211. * parentId: int,
  212. * mtime: int,
  213. * name: string,
  214. * permissions: int,
  215. * mimetype: string,
  216. * size: int|float,
  217. * type: string,
  218. * etag: string,
  219. * children?: array<string, mixed>[],
  220. * }
  221. */
  222. class ResponseDefinitions {
  223. }