ResponseDefinitions.php 2.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * @copyright Copyright (c) 2023 Kate Döen <kate.doeen@nextcloud.com>
  5. *
  6. * @author Kate Döen <kate.doeen@nextcloud.com>
  7. *
  8. * @license GNU AGPL version 3 or any later version
  9. *
  10. * This program is free software: you can redistribute it and/or modify
  11. * it under the terms of the GNU Affero General Public License as
  12. * published by the Free Software Foundation, either version 3 of the
  13. * License, or (at your option) any later version.
  14. *
  15. * This program is distributed in the hope that it will be useful,
  16. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18. * GNU Affero General Public License for more details.
  19. *
  20. * You should have received a copy of the GNU Affero General Public License
  21. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  22. *
  23. */
  24. namespace OCA\Provisioning_API;
  25. /**
  26. * @psalm-type Provisioning_APIUserDetailsQuota = array{
  27. * free?: float|int,
  28. * quota?: float|int|string,
  29. * relative?: float|int,
  30. * total?: float|int,
  31. * used?: float|int,
  32. * }
  33. *
  34. * @psalm-type Provisioning_APIUserDetails = array{
  35. * additional_mail: string[],
  36. * additional_mailScope?: string[],
  37. * address: string,
  38. * addressScope?: string,
  39. * avatarScope?: string,
  40. * backend: string,
  41. * backendCapabilities: array{
  42. * setDisplayName: bool,
  43. * setPassword: bool
  44. * },
  45. * biography: string,
  46. * biographyScope?: string,
  47. * display-name: string,
  48. * displayname: string,
  49. * displaynameScope?: string,
  50. * email: ?string,
  51. * emailScope?: string,
  52. * enabled?: bool,
  53. * fediverse: string,
  54. * fediverseScope?: string,
  55. * groups: string[],
  56. * headline: string,
  57. * headlineScope?: string,
  58. * id: string,
  59. * language: string,
  60. * lastLogin: int,
  61. * locale: string,
  62. * manager: string,
  63. * notify_email: ?string,
  64. * organisation: string,
  65. * organisationScope?: string,
  66. * phone: string,
  67. * phoneScope?: string,
  68. * profile_enabled: string,
  69. * profile_enabledScope?: string,
  70. * quota: Provisioning_APIUserDetailsQuota,
  71. * role: string,
  72. * roleScope?: string,
  73. * storageLocation?: string,
  74. * subadmin: string[],
  75. * twitter: string,
  76. * twitterScope?: string,
  77. * website: string,
  78. * websiteScope?: string,
  79. * }
  80. *
  81. * @psalm-type Provisioning_APIGroupDetails = array{
  82. * id: string,
  83. * displayname: string,
  84. * usercount: bool|int,
  85. * disabled: bool|int,
  86. * canAdd: bool,
  87. * canRemove: bool,
  88. * }
  89. */
  90. class ResponseDefinitions {
  91. }