@itwin/access-control-client 3.7.0 → 4.0.0

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 (309) hide show
  1. package/CHANGELOG.md +116 -25
  2. package/README.md +147 -669
  3. package/lib/cjs/AccessControlClient.d.ts +26 -9
  4. package/lib/cjs/AccessControlClient.d.ts.map +1 -1
  5. package/lib/cjs/AccessControlClient.js +21 -5
  6. package/lib/cjs/AccessControlClient.js.map +1 -1
  7. package/lib/cjs/access-control-client.d.ts +30 -1
  8. package/lib/cjs/access-control-client.d.ts.map +1 -1
  9. package/lib/cjs/access-control-client.js +42 -6
  10. package/lib/cjs/access-control-client.js.map +1 -1
  11. package/lib/cjs/accessControlClientInterfaces/GroupClient.d.ts +19 -0
  12. package/lib/cjs/accessControlClientInterfaces/GroupClient.d.ts.map +1 -0
  13. package/lib/cjs/accessControlClientInterfaces/GroupClient.js +7 -0
  14. package/lib/cjs/accessControlClientInterfaces/GroupClient.js.map +1 -0
  15. package/lib/cjs/accessControlClientInterfaces/GroupMemberInvitationClient.d.ts +15 -0
  16. package/lib/cjs/accessControlClientInterfaces/GroupMemberInvitationClient.d.ts.map +1 -0
  17. package/lib/cjs/accessControlClientInterfaces/GroupMemberInvitationClient.js +7 -0
  18. package/lib/cjs/accessControlClientInterfaces/GroupMemberInvitationClient.js.map +1 -0
  19. package/lib/cjs/accessControlClientInterfaces/GroupMembersClient.d.ts +19 -0
  20. package/lib/cjs/accessControlClientInterfaces/GroupMembersClient.d.ts.map +1 -0
  21. package/lib/cjs/accessControlClientInterfaces/GroupMembersClient.js +7 -0
  22. package/lib/cjs/accessControlClientInterfaces/GroupMembersClient.js.map +1 -0
  23. package/lib/cjs/accessControlClientInterfaces/ITwinJobsClient.d.ts +12 -0
  24. package/lib/cjs/accessControlClientInterfaces/ITwinJobsClient.d.ts.map +1 -0
  25. package/lib/cjs/accessControlClientInterfaces/ITwinJobsClient.js +7 -0
  26. package/lib/cjs/accessControlClientInterfaces/ITwinJobsClient.js.map +1 -0
  27. package/lib/cjs/accessControlClientInterfaces/ItwinSharesClient.d.ts +25 -0
  28. package/lib/cjs/accessControlClientInterfaces/ItwinSharesClient.d.ts.map +1 -0
  29. package/lib/cjs/accessControlClientInterfaces/ItwinSharesClient.js +7 -0
  30. package/lib/cjs/accessControlClientInterfaces/ItwinSharesClient.js.map +1 -0
  31. package/lib/cjs/accessControlClientInterfaces/MemberInvitationsClient.d.ts +10 -0
  32. package/lib/cjs/accessControlClientInterfaces/MemberInvitationsClient.d.ts.map +1 -0
  33. package/lib/cjs/accessControlClientInterfaces/MemberInvitationsClient.js +7 -0
  34. package/lib/cjs/accessControlClientInterfaces/MemberInvitationsClient.js.map +1 -0
  35. package/lib/cjs/accessControlClientInterfaces/OwnerMembersClient .d.ts +13 -0
  36. package/lib/cjs/accessControlClientInterfaces/OwnerMembersClient .d.ts.map +1 -0
  37. package/lib/cjs/accessControlClientInterfaces/OwnerMembersClient .js +7 -0
  38. package/lib/cjs/accessControlClientInterfaces/OwnerMembersClient .js.map +1 -0
  39. package/lib/cjs/accessControlClientInterfaces/PermissionsClient.d.ts +10 -0
  40. package/lib/cjs/accessControlClientInterfaces/PermissionsClient.d.ts.map +1 -0
  41. package/lib/cjs/accessControlClientInterfaces/PermissionsClient.js +7 -0
  42. package/lib/cjs/accessControlClientInterfaces/PermissionsClient.js.map +1 -0
  43. package/lib/cjs/accessControlClientInterfaces/RolesClient.d.ts +16 -0
  44. package/lib/cjs/accessControlClientInterfaces/RolesClient.d.ts.map +1 -0
  45. package/lib/cjs/accessControlClientInterfaces/RolesClient.js +7 -0
  46. package/lib/cjs/accessControlClientInterfaces/RolesClient.js.map +1 -0
  47. package/lib/cjs/accessControlClientInterfaces/UserMembersClient.d.ts +16 -0
  48. package/lib/cjs/accessControlClientInterfaces/UserMembersClient.d.ts.map +1 -0
  49. package/lib/cjs/accessControlClientInterfaces/UserMembersClient.js +7 -0
  50. package/lib/cjs/accessControlClientInterfaces/UserMembersClient.js.map +1 -0
  51. package/lib/cjs/accessControlClientInterfaces/accessControl.d.ts +23 -0
  52. package/lib/cjs/accessControlClientInterfaces/accessControl.d.ts.map +1 -0
  53. package/lib/cjs/accessControlClientInterfaces/accessControl.js +7 -0
  54. package/lib/cjs/accessControlClientInterfaces/accessControl.js.map +1 -0
  55. package/lib/cjs/subClients/BaseClient.d.ts +88 -29
  56. package/lib/cjs/subClients/BaseClient.d.ts.map +1 -1
  57. package/lib/cjs/subClients/BaseClient.js +165 -40
  58. package/lib/cjs/subClients/BaseClient.js.map +1 -1
  59. package/lib/cjs/subClients/GroupMemberInvitationsClient.d.ts +33 -0
  60. package/lib/cjs/subClients/GroupMemberInvitationsClient.d.ts.map +1 -0
  61. package/lib/cjs/subClients/GroupMemberInvitationsClient.js +48 -0
  62. package/lib/cjs/subClients/GroupMemberInvitationsClient.js.map +1 -0
  63. package/lib/cjs/subClients/GroupMembersClient.d.ts +16 -6
  64. package/lib/cjs/subClients/GroupMembersClient.d.ts.map +1 -1
  65. package/lib/cjs/subClients/GroupMembersClient.js +22 -13
  66. package/lib/cjs/subClients/GroupMembersClient.js.map +1 -1
  67. package/lib/cjs/subClients/GroupsClient.d.ts +17 -9
  68. package/lib/cjs/subClients/GroupsClient.d.ts.map +1 -1
  69. package/lib/cjs/subClients/GroupsClient.js +22 -10
  70. package/lib/cjs/subClients/GroupsClient.js.map +1 -1
  71. package/lib/cjs/subClients/ITwinJobsClient.d.ts +12 -5
  72. package/lib/cjs/subClients/ITwinJobsClient.d.ts.map +1 -1
  73. package/lib/cjs/subClients/ITwinJobsClient.js +15 -3
  74. package/lib/cjs/subClients/ITwinJobsClient.js.map +1 -1
  75. package/lib/cjs/subClients/ItwinShares.d.ts +61 -0
  76. package/lib/cjs/subClients/ItwinShares.d.ts.map +1 -0
  77. package/lib/cjs/subClients/ItwinShares.js +77 -0
  78. package/lib/cjs/subClients/ItwinShares.js.map +1 -0
  79. package/lib/cjs/subClients/MemberInvitationsClient.d.ts +16 -3
  80. package/lib/cjs/subClients/MemberInvitationsClient.d.ts.map +1 -1
  81. package/lib/cjs/subClients/MemberInvitationsClient.js +22 -7
  82. package/lib/cjs/subClients/MemberInvitationsClient.js.map +1 -1
  83. package/lib/cjs/subClients/OwnerMembersClient.d.ts +45 -6
  84. package/lib/cjs/subClients/OwnerMembersClient.d.ts.map +1 -1
  85. package/lib/cjs/subClients/OwnerMembersClient.js +50 -10
  86. package/lib/cjs/subClients/OwnerMembersClient.js.map +1 -1
  87. package/lib/cjs/subClients/PermissionsClient.d.ts +10 -3
  88. package/lib/cjs/subClients/PermissionsClient.d.ts.map +1 -1
  89. package/lib/cjs/subClients/PermissionsClient.js +14 -2
  90. package/lib/cjs/subClients/PermissionsClient.js.map +1 -1
  91. package/lib/cjs/subClients/RolesClient.d.ts +13 -8
  92. package/lib/cjs/subClients/RolesClient.d.ts.map +1 -1
  93. package/lib/cjs/subClients/RolesClient.js +18 -6
  94. package/lib/cjs/subClients/RolesClient.js.map +1 -1
  95. package/lib/cjs/subClients/UserMembersClient.d.ts +13 -6
  96. package/lib/cjs/subClients/UserMembersClient.d.ts.map +1 -1
  97. package/lib/cjs/subClients/UserMembersClient.js +21 -9
  98. package/lib/cjs/subClients/UserMembersClient.js.map +1 -1
  99. package/lib/cjs/types/CommonApiTypes.d.ts +78 -0
  100. package/lib/cjs/types/CommonApiTypes.d.ts.map +1 -0
  101. package/lib/cjs/types/CommonApiTypes.js +7 -0
  102. package/lib/cjs/types/CommonApiTypes.js.map +1 -0
  103. package/lib/cjs/types/GroupMember.d.ts +75 -0
  104. package/lib/cjs/types/GroupMember.d.ts.map +1 -0
  105. package/lib/cjs/types/GroupMember.js +7 -0
  106. package/lib/cjs/types/GroupMember.js.map +1 -0
  107. package/lib/cjs/types/Groups.d.ts +64 -0
  108. package/lib/cjs/types/Groups.d.ts.map +1 -0
  109. package/lib/cjs/types/Groups.js +7 -0
  110. package/lib/cjs/types/Groups.js.map +1 -0
  111. package/lib/cjs/types/ITwinJob.d.ts +70 -0
  112. package/lib/cjs/types/ITwinJob.d.ts.map +1 -0
  113. package/lib/cjs/types/ITwinJob.js +7 -0
  114. package/lib/cjs/types/ITwinJob.js.map +1 -0
  115. package/lib/cjs/types/Invitations.d.ts +128 -0
  116. package/lib/cjs/types/Invitations.d.ts.map +1 -0
  117. package/lib/cjs/types/Invitations.js +7 -0
  118. package/lib/cjs/types/Invitations.js.map +1 -0
  119. package/lib/cjs/types/Members.d.ts +71 -0
  120. package/lib/cjs/types/Members.d.ts.map +1 -0
  121. package/lib/cjs/types/Members.js +7 -0
  122. package/lib/cjs/types/Members.js.map +1 -0
  123. package/lib/cjs/types/OwnerMember.d.ts +105 -0
  124. package/lib/cjs/types/OwnerMember.d.ts.map +1 -0
  125. package/lib/cjs/types/OwnerMember.js +7 -0
  126. package/lib/cjs/types/OwnerMember.js.map +1 -0
  127. package/lib/cjs/types/Permission.d.ts +5 -0
  128. package/lib/cjs/types/Permission.d.ts.map +1 -0
  129. package/lib/cjs/types/Permission.js +7 -0
  130. package/lib/cjs/types/Permission.js.map +1 -0
  131. package/lib/cjs/types/Role.d.ts +33 -0
  132. package/lib/cjs/types/Role.d.ts.map +1 -0
  133. package/lib/cjs/types/Role.js +7 -0
  134. package/lib/cjs/types/Role.js.map +1 -0
  135. package/lib/cjs/types/ShareContract.d.ts +80 -0
  136. package/lib/cjs/types/ShareContract.d.ts.map +1 -0
  137. package/lib/cjs/types/ShareContract.js +7 -0
  138. package/lib/cjs/types/ShareContract.js.map +1 -0
  139. package/lib/cjs/types/UserMembers.d.ts +115 -0
  140. package/lib/cjs/types/UserMembers.d.ts.map +1 -0
  141. package/lib/cjs/types/UserMembers.js +7 -0
  142. package/lib/cjs/types/UserMembers.js.map +1 -0
  143. package/lib/cjs/types/links.d.ts +20 -0
  144. package/lib/cjs/types/links.d.ts.map +1 -0
  145. package/lib/cjs/types/links.js +7 -0
  146. package/lib/cjs/types/links.js.map +1 -0
  147. package/lib/cjs/types/typeUtils.d.ts +42 -0
  148. package/lib/cjs/types/typeUtils.d.ts.map +1 -0
  149. package/lib/cjs/types/typeUtils.js +25 -0
  150. package/lib/cjs/types/typeUtils.js.map +1 -0
  151. package/lib/esm/AccessControlClient.d.ts +26 -9
  152. package/lib/esm/AccessControlClient.d.ts.map +1 -1
  153. package/lib/esm/AccessControlClient.js +31 -5
  154. package/lib/esm/AccessControlClient.js.map +1 -1
  155. package/lib/esm/access-control-client.d.ts +30 -1
  156. package/lib/esm/access-control-client.d.ts.map +1 -1
  157. package/lib/esm/access-control-client.js +33 -1
  158. package/lib/esm/access-control-client.js.map +1 -1
  159. package/lib/esm/accessControlClientInterfaces/GroupClient.d.ts +19 -0
  160. package/lib/esm/accessControlClientInterfaces/GroupClient.d.ts.map +1 -0
  161. package/lib/esm/accessControlClientInterfaces/GroupClient.js +6 -0
  162. package/lib/esm/accessControlClientInterfaces/GroupClient.js.map +1 -0
  163. package/lib/esm/accessControlClientInterfaces/GroupMemberInvitationClient.d.ts +15 -0
  164. package/lib/esm/accessControlClientInterfaces/GroupMemberInvitationClient.d.ts.map +1 -0
  165. package/lib/esm/accessControlClientInterfaces/GroupMemberInvitationClient.js +6 -0
  166. package/lib/esm/accessControlClientInterfaces/GroupMemberInvitationClient.js.map +1 -0
  167. package/lib/esm/accessControlClientInterfaces/GroupMembersClient.d.ts +19 -0
  168. package/lib/esm/accessControlClientInterfaces/GroupMembersClient.d.ts.map +1 -0
  169. package/lib/esm/accessControlClientInterfaces/GroupMembersClient.js +6 -0
  170. package/lib/esm/accessControlClientInterfaces/GroupMembersClient.js.map +1 -0
  171. package/lib/esm/accessControlClientInterfaces/ITwinJobsClient.d.ts +12 -0
  172. package/lib/esm/accessControlClientInterfaces/ITwinJobsClient.d.ts.map +1 -0
  173. package/lib/esm/accessControlClientInterfaces/ITwinJobsClient.js +6 -0
  174. package/lib/esm/accessControlClientInterfaces/ITwinJobsClient.js.map +1 -0
  175. package/lib/esm/accessControlClientInterfaces/ItwinSharesClient.d.ts +25 -0
  176. package/lib/esm/accessControlClientInterfaces/ItwinSharesClient.d.ts.map +1 -0
  177. package/lib/esm/accessControlClientInterfaces/ItwinSharesClient.js +6 -0
  178. package/lib/esm/accessControlClientInterfaces/ItwinSharesClient.js.map +1 -0
  179. package/lib/esm/accessControlClientInterfaces/MemberInvitationsClient.d.ts +10 -0
  180. package/lib/esm/accessControlClientInterfaces/MemberInvitationsClient.d.ts.map +1 -0
  181. package/lib/esm/accessControlClientInterfaces/MemberInvitationsClient.js +6 -0
  182. package/lib/esm/accessControlClientInterfaces/MemberInvitationsClient.js.map +1 -0
  183. package/lib/esm/accessControlClientInterfaces/OwnerMembersClient .d.ts +13 -0
  184. package/lib/esm/accessControlClientInterfaces/OwnerMembersClient .d.ts.map +1 -0
  185. package/lib/esm/accessControlClientInterfaces/OwnerMembersClient .js +6 -0
  186. package/lib/esm/accessControlClientInterfaces/OwnerMembersClient .js.map +1 -0
  187. package/lib/esm/accessControlClientInterfaces/PermissionsClient.d.ts +10 -0
  188. package/lib/esm/accessControlClientInterfaces/PermissionsClient.d.ts.map +1 -0
  189. package/lib/esm/accessControlClientInterfaces/PermissionsClient.js +6 -0
  190. package/lib/esm/accessControlClientInterfaces/PermissionsClient.js.map +1 -0
  191. package/lib/esm/accessControlClientInterfaces/RolesClient.d.ts +16 -0
  192. package/lib/esm/accessControlClientInterfaces/RolesClient.d.ts.map +1 -0
  193. package/lib/esm/accessControlClientInterfaces/RolesClient.js +6 -0
  194. package/lib/esm/accessControlClientInterfaces/RolesClient.js.map +1 -0
  195. package/lib/esm/accessControlClientInterfaces/UserMembersClient.d.ts +16 -0
  196. package/lib/esm/accessControlClientInterfaces/UserMembersClient.d.ts.map +1 -0
  197. package/lib/esm/accessControlClientInterfaces/UserMembersClient.js +6 -0
  198. package/lib/esm/accessControlClientInterfaces/UserMembersClient.js.map +1 -0
  199. package/lib/esm/accessControlClientInterfaces/accessControl.d.ts +23 -0
  200. package/lib/esm/accessControlClientInterfaces/accessControl.d.ts.map +1 -0
  201. package/lib/esm/accessControlClientInterfaces/accessControl.js +6 -0
  202. package/lib/esm/accessControlClientInterfaces/accessControl.js.map +1 -0
  203. package/lib/esm/subClients/BaseClient.d.ts +88 -29
  204. package/lib/esm/subClients/BaseClient.d.ts.map +1 -1
  205. package/lib/esm/subClients/BaseClient.js +166 -41
  206. package/lib/esm/subClients/BaseClient.js.map +1 -1
  207. package/lib/esm/subClients/GroupMemberInvitationsClient.d.ts +33 -0
  208. package/lib/esm/subClients/GroupMemberInvitationsClient.d.ts.map +1 -0
  209. package/lib/esm/subClients/GroupMemberInvitationsClient.js +44 -0
  210. package/lib/esm/subClients/GroupMemberInvitationsClient.js.map +1 -0
  211. package/lib/esm/subClients/GroupMembersClient.d.ts +16 -6
  212. package/lib/esm/subClients/GroupMembersClient.d.ts.map +1 -1
  213. package/lib/esm/subClients/GroupMembersClient.js +22 -13
  214. package/lib/esm/subClients/GroupMembersClient.js.map +1 -1
  215. package/lib/esm/subClients/GroupsClient.d.ts +17 -9
  216. package/lib/esm/subClients/GroupsClient.d.ts.map +1 -1
  217. package/lib/esm/subClients/GroupsClient.js +22 -10
  218. package/lib/esm/subClients/GroupsClient.js.map +1 -1
  219. package/lib/esm/subClients/ITwinJobsClient.d.ts +12 -5
  220. package/lib/esm/subClients/ITwinJobsClient.d.ts.map +1 -1
  221. package/lib/esm/subClients/ITwinJobsClient.js +15 -3
  222. package/lib/esm/subClients/ITwinJobsClient.js.map +1 -1
  223. package/lib/esm/subClients/ItwinShares.d.ts +61 -0
  224. package/lib/esm/subClients/ItwinShares.d.ts.map +1 -0
  225. package/lib/esm/subClients/ItwinShares.js +73 -0
  226. package/lib/esm/subClients/ItwinShares.js.map +1 -0
  227. package/lib/esm/subClients/MemberInvitationsClient.d.ts +16 -3
  228. package/lib/esm/subClients/MemberInvitationsClient.d.ts.map +1 -1
  229. package/lib/esm/subClients/MemberInvitationsClient.js +22 -7
  230. package/lib/esm/subClients/MemberInvitationsClient.js.map +1 -1
  231. package/lib/esm/subClients/OwnerMembersClient.d.ts +45 -6
  232. package/lib/esm/subClients/OwnerMembersClient.d.ts.map +1 -1
  233. package/lib/esm/subClients/OwnerMembersClient.js +50 -10
  234. package/lib/esm/subClients/OwnerMembersClient.js.map +1 -1
  235. package/lib/esm/subClients/PermissionsClient.d.ts +10 -3
  236. package/lib/esm/subClients/PermissionsClient.d.ts.map +1 -1
  237. package/lib/esm/subClients/PermissionsClient.js +14 -2
  238. package/lib/esm/subClients/PermissionsClient.js.map +1 -1
  239. package/lib/esm/subClients/RolesClient.d.ts +13 -8
  240. package/lib/esm/subClients/RolesClient.d.ts.map +1 -1
  241. package/lib/esm/subClients/RolesClient.js +18 -6
  242. package/lib/esm/subClients/RolesClient.js.map +1 -1
  243. package/lib/esm/subClients/UserMembersClient.d.ts +13 -6
  244. package/lib/esm/subClients/UserMembersClient.d.ts.map +1 -1
  245. package/lib/esm/subClients/UserMembersClient.js +21 -9
  246. package/lib/esm/subClients/UserMembersClient.js.map +1 -1
  247. package/lib/esm/types/CommonApiTypes.d.ts +78 -0
  248. package/lib/esm/types/CommonApiTypes.d.ts.map +1 -0
  249. package/lib/esm/types/CommonApiTypes.js +6 -0
  250. package/lib/esm/types/CommonApiTypes.js.map +1 -0
  251. package/lib/esm/types/GroupMember.d.ts +75 -0
  252. package/lib/esm/types/GroupMember.d.ts.map +1 -0
  253. package/lib/esm/types/GroupMember.js +6 -0
  254. package/lib/esm/types/GroupMember.js.map +1 -0
  255. package/lib/esm/types/Groups.d.ts +64 -0
  256. package/lib/esm/types/Groups.d.ts.map +1 -0
  257. package/lib/esm/types/Groups.js +6 -0
  258. package/lib/esm/types/Groups.js.map +1 -0
  259. package/lib/esm/types/ITwinJob.d.ts +70 -0
  260. package/lib/esm/types/ITwinJob.d.ts.map +1 -0
  261. package/lib/esm/types/ITwinJob.js +6 -0
  262. package/lib/esm/types/ITwinJob.js.map +1 -0
  263. package/lib/esm/types/Invitations.d.ts +128 -0
  264. package/lib/esm/types/Invitations.d.ts.map +1 -0
  265. package/lib/esm/types/Invitations.js +6 -0
  266. package/lib/esm/types/Invitations.js.map +1 -0
  267. package/lib/esm/types/Members.d.ts +71 -0
  268. package/lib/esm/types/Members.d.ts.map +1 -0
  269. package/lib/esm/types/Members.js +6 -0
  270. package/lib/esm/types/Members.js.map +1 -0
  271. package/lib/esm/types/OwnerMember.d.ts +105 -0
  272. package/lib/esm/types/OwnerMember.d.ts.map +1 -0
  273. package/lib/esm/types/OwnerMember.js +6 -0
  274. package/lib/esm/types/OwnerMember.js.map +1 -0
  275. package/lib/esm/types/Permission.d.ts +5 -0
  276. package/lib/esm/types/Permission.d.ts.map +1 -0
  277. package/lib/esm/types/Permission.js +6 -0
  278. package/lib/esm/types/Permission.js.map +1 -0
  279. package/lib/esm/types/Role.d.ts +33 -0
  280. package/lib/esm/types/Role.d.ts.map +1 -0
  281. package/lib/esm/types/Role.js +6 -0
  282. package/lib/esm/types/Role.js.map +1 -0
  283. package/lib/esm/types/ShareContract.d.ts +80 -0
  284. package/lib/esm/types/ShareContract.d.ts.map +1 -0
  285. package/lib/esm/types/ShareContract.js +6 -0
  286. package/lib/esm/types/ShareContract.js.map +1 -0
  287. package/lib/esm/types/UserMembers.d.ts +115 -0
  288. package/lib/esm/types/UserMembers.d.ts.map +1 -0
  289. package/lib/esm/types/UserMembers.js +6 -0
  290. package/lib/esm/types/UserMembers.js.map +1 -0
  291. package/lib/esm/types/links.d.ts +20 -0
  292. package/lib/esm/types/links.d.ts.map +1 -0
  293. package/lib/esm/types/links.js +6 -0
  294. package/lib/esm/types/links.js.map +1 -0
  295. package/lib/esm/types/typeUtils.d.ts +42 -0
  296. package/lib/esm/types/typeUtils.d.ts.map +1 -0
  297. package/lib/esm/types/typeUtils.js +22 -0
  298. package/lib/esm/types/typeUtils.js.map +1 -0
  299. package/package.json +59 -45
  300. package/CONTRIBUTING.md +0 -90
  301. package/GETTINGSTARTED.md +0 -35
  302. package/lib/cjs/accessControlTypes.d.ts +0 -229
  303. package/lib/cjs/accessControlTypes.d.ts.map +0 -1
  304. package/lib/cjs/accessControlTypes.js +0 -25
  305. package/lib/cjs/accessControlTypes.js.map +0 -1
  306. package/lib/esm/accessControlTypes.d.ts +0 -229
  307. package/lib/esm/accessControlTypes.d.ts.map +0 -1
  308. package/lib/esm/accessControlTypes.js +0 -22
  309. package/lib/esm/accessControlTypes.js.map +0 -1
@@ -2,45 +2,53 @@
2
2
  * @module AccessControlClient
3
3
  */
4
4
  import type { AccessToken } from "@itwin/core-bentley";
5
- import type { AccessControlAPIResponse, Group, GroupUpdate, IGroupsClient } from "../accessControlTypes";
5
+ import type { IGroupsClient } from "../accessControlClientInterfaces/GroupClient";
6
+ import type { BentleyAPIResponse } from "../types/CommonApiTypes";
7
+ import type { Group, MultipleGroupsResponse, SingleGroupResponse } from "../types/Groups";
6
8
  import { BaseClient } from "./BaseClient";
9
+ /** Client API to perform iTwin group operations.
10
+ */
7
11
  export declare class GroupsClient extends BaseClient implements IGroupsClient {
12
+ /** Create a new GroupsClient instance
13
+ * @param url Optional base URL for the access control service. If not provided, defaults to base url.
14
+ */
8
15
  constructor(url?: string);
9
16
  /** Retrieves a list of available user roles that are defined for a specified iTwin
10
17
  * @param accessToken The client access token string
11
18
  * @param iTwinId The id of the iTwin
12
19
  * @returns Group[]
13
20
  */
14
- getITwinGroupsAsync(accessToken: AccessToken, iTwinId: string, additionalHeaders?: {
15
- [key: string]: string;
16
- }): Promise<AccessControlAPIResponse<Group[]>>;
21
+ getITwinGroups(accessToken: AccessToken, iTwinId: string): Promise<BentleyAPIResponse<MultipleGroupsResponse>>;
17
22
  /** Retrieves the specified role for the specified iTwin
18
23
  * @param accessToken The client access token string
19
24
  * @param iTwinId The id of the iTwin
20
25
  * @returns Group
21
26
  */
22
- getITwinGroupAsync(accessToken: AccessToken, iTwinId: string, groupId: string): Promise<AccessControlAPIResponse<Group>>;
27
+ getITwinGroup(accessToken: AccessToken, iTwinId: string, groupId: string): Promise<BentleyAPIResponse<SingleGroupResponse>>;
23
28
  /** Creates a new iTwin group
24
29
  * @param accessToken The client access token string
25
30
  * @param iTwinId The id of the iTwin
26
31
  * @param group The group to be created
27
32
  * @returns Group
28
33
  */
29
- createITwinGroupAsync(accessToken: AccessToken, iTwinId: string, group: Group): Promise<AccessControlAPIResponse<Group>>;
34
+ createITwinGroup(accessToken: AccessToken, iTwinId: string, group: Pick<Group, "name" | "description">): Promise<BentleyAPIResponse<SingleGroupResponse>>;
30
35
  /** Delete the specified iTwin group
31
36
  * @param accessToken The client access token string
32
37
  * @param iTwinId The id of the iTwin
33
38
  * @param groupId The id of the group to remove
34
39
  * @returns No Content
35
40
  */
36
- deleteITwinGroupAsync(accessToken: AccessToken, iTwinId: string, groupId: string): Promise<AccessControlAPIResponse<undefined>>;
41
+ deleteITwinGroup(accessToken: AccessToken, iTwinId: string, groupId: string): Promise<BentleyAPIResponse<undefined>>;
37
42
  /** Update the specified iTwin group
38
43
  * @param accessToken The client access token string
39
44
  * @param iTwinId The id of the iTwin
40
45
  * @param groupId The id of the role to update
41
46
  * @param group The updated group
42
- * @returns Role
47
+ * @returns Group that was updated
43
48
  */
44
- updateITwinGroupAsync(accessToken: AccessToken, iTwinId: string, groupId: string, group: GroupUpdate): Promise<AccessControlAPIResponse<Group>>;
49
+ updateITwinGroup(accessToken: AccessToken, iTwinId: string, groupId: string, group: Partial<Pick<Group, "name" | "description"> & {
50
+ members: string[];
51
+ imsGroups: string[];
52
+ }>): Promise<BentleyAPIResponse<SingleGroupResponse>>;
45
53
  }
46
54
  //# sourceMappingURL=GroupsClient.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"GroupsClient.d.ts","sourceRoot":"","sources":["../../../src/subClients/GroupsClient.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,KAAK,EAAE,wBAAwB,EAAE,KAAK,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AACzG,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,qBAAa,YAAa,SAAQ,UAAW,YAAW,aAAa;gBAChD,GAAG,CAAC,EAAE,MAAM;IAI/B;;;;QAII;IACS,mBAAmB,CAC9B,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,iBAAiB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,GAC5C,OAAO,CAAC,wBAAwB,CAAC,KAAK,EAAE,CAAC,CAAC;IAK7C;;;;QAII;IACS,kBAAkB,CAC7B,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,wBAAwB,CAAC,KAAK,CAAC,CAAC;IAK3C;;;;;QAKI;IACS,qBAAqB,CAChC,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,KAAK,EAAE,KAAK,GACX,OAAO,CAAC,wBAAwB,CAAC,KAAK,CAAC,CAAC;IAK3C;;;;;QAKI;IACS,qBAAqB,CAChC,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,wBAAwB,CAAC,SAAS,CAAC,CAAC;IAK/C;;;;;;QAMI;IACS,qBAAqB,CAChC,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,EACf,KAAK,EAAE,WAAW,GACjB,OAAO,CAAC,wBAAwB,CAAC,KAAK,CAAC,CAAC;CAI5C"}
1
+ {"version":3,"file":"GroupsClient.d.ts","sourceRoot":"","sources":["../../../src/subClients/GroupsClient.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,8CAA8C,CAAC;AAClF,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAClE,OAAO,KAAK,EAAE,KAAK,EAAE,sBAAsB,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AAC1F,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C;GACG;AACH,qBAAa,YAAa,SAAQ,UAAW,YAAW,aAAa;IACnE;;OAEG;gBACgB,GAAG,CAAC,EAAE,MAAM;IAI/B;;;;QAII;IACS,cAAc,CACzB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,kBAAkB,CAAC,sBAAsB,CAAC,CAAC;IAKtD;;;;QAII;IACS,aAAa,CACxB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,CAAC;IAKnD;;;;;QAKI;IACS,gBAAgB,CAC3B,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,KAAK,EAAE,IAAI,CAAE,KAAK,EAAE,MAAM,GAAG,aAAa,CAAC,GAC1C,OAAO,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,CAAC;IAKnD;;;;;QAKI;IACS,gBAAgB,CAC3B,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;IAKzC;;;;;;QAMI;IACS,gBAAgB,CAC3B,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,EACf,KAAK,EAAE,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,GAAG,aAAa,CAAC,GAAG;QAAE,OAAO,EAAE,MAAM,EAAE,CAAC;QAAC,SAAS,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC,GAC/F,OAAO,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,CAAC;CAIpD"}
@@ -1,5 +1,17 @@
1
+ /*---------------------------------------------------------------------------------------------
2
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
3
+ * See LICENSE.md in the project root for license terms and full copyright notice.
4
+ *--------------------------------------------------------------------------------------------*/
5
+ /** @packageDocumentation
6
+ * @module AccessControlClient
7
+ */
1
8
  import { BaseClient } from "./BaseClient";
9
+ /** Client API to perform iTwin group operations.
10
+ */
2
11
  export class GroupsClient extends BaseClient {
12
+ /** Create a new GroupsClient instance
13
+ * @param url Optional base URL for the access control service. If not provided, defaults to base url.
14
+ */
3
15
  constructor(url) {
4
16
  super(url);
5
17
  }
@@ -8,18 +20,18 @@ export class GroupsClient extends BaseClient {
8
20
  * @param iTwinId The id of the iTwin
9
21
  * @returns Group[]
10
22
  */
11
- async getITwinGroupsAsync(accessToken, iTwinId, additionalHeaders) {
23
+ async getITwinGroups(accessToken, iTwinId) {
12
24
  const url = `${this._baseUrl}/${iTwinId}/groups`;
13
- return this.sendGenericAPIRequest(accessToken, "GET", url, undefined, "groups", additionalHeaders);
25
+ return this.sendGenericAPIRequest(accessToken, "GET", url);
14
26
  }
15
27
  /** Retrieves the specified role for the specified iTwin
16
28
  * @param accessToken The client access token string
17
29
  * @param iTwinId The id of the iTwin
18
30
  * @returns Group
19
31
  */
20
- async getITwinGroupAsync(accessToken, iTwinId, groupId) {
32
+ async getITwinGroup(accessToken, iTwinId, groupId) {
21
33
  const url = `${this._baseUrl}/${iTwinId}/groups/${groupId}`;
22
- return this.sendGenericAPIRequest(accessToken, "GET", url, undefined, "group");
34
+ return this.sendGenericAPIRequest(accessToken, "GET", url);
23
35
  }
24
36
  /** Creates a new iTwin group
25
37
  * @param accessToken The client access token string
@@ -27,9 +39,9 @@ export class GroupsClient extends BaseClient {
27
39
  * @param group The group to be created
28
40
  * @returns Group
29
41
  */
30
- async createITwinGroupAsync(accessToken, iTwinId, group) {
42
+ async createITwinGroup(accessToken, iTwinId, group) {
31
43
  const url = `${this._baseUrl}/${iTwinId}/groups`;
32
- return this.sendGenericAPIRequest(accessToken, "POST", url, group, "group");
44
+ return this.sendGenericAPIRequest(accessToken, "POST", url, group);
33
45
  }
34
46
  /** Delete the specified iTwin group
35
47
  * @param accessToken The client access token string
@@ -37,7 +49,7 @@ export class GroupsClient extends BaseClient {
37
49
  * @param groupId The id of the group to remove
38
50
  * @returns No Content
39
51
  */
40
- async deleteITwinGroupAsync(accessToken, iTwinId, groupId) {
52
+ async deleteITwinGroup(accessToken, iTwinId, groupId) {
41
53
  const url = `${this._baseUrl}/${iTwinId}/groups/${groupId}`;
42
54
  return this.sendGenericAPIRequest(accessToken, "DELETE", url);
43
55
  }
@@ -46,11 +58,11 @@ export class GroupsClient extends BaseClient {
46
58
  * @param iTwinId The id of the iTwin
47
59
  * @param groupId The id of the role to update
48
60
  * @param group The updated group
49
- * @returns Role
61
+ * @returns Group that was updated
50
62
  */
51
- async updateITwinGroupAsync(accessToken, iTwinId, groupId, group) {
63
+ async updateITwinGroup(accessToken, iTwinId, groupId, group) {
52
64
  const url = `${this._baseUrl}/${iTwinId}/groups/${groupId}`;
53
- return this.sendGenericAPIRequest(accessToken, "PATCH", url, group, "group");
65
+ return this.sendGenericAPIRequest(accessToken, "PATCH", url, group);
54
66
  }
55
67
  }
56
68
  //# sourceMappingURL=GroupsClient.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"GroupsClient.js","sourceRoot":"","sources":["../../../src/subClients/GroupsClient.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,MAAM,OAAO,YAAa,SAAQ,UAAU;IAC1C,YAAmB,GAAY;QAC7B,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;IAED;;;;QAII;IACG,KAAK,CAAC,mBAAmB,CAC9B,WAAwB,EACxB,OAAe,EACf,iBAA6C;QAE7C,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,SAAS,CAAC;QACjD,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,QAAQ,EAAE,iBAAiB,CAAC,CAAC;IACrG,CAAC;IAED;;;;QAII;IACG,KAAK,CAAC,kBAAkB,CAC7B,WAAwB,EACxB,OAAe,EACf,OAAe;QAEf,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,WAAW,OAAO,EAAE,CAAC;QAC5D,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IACjF,CAAC;IAED;;;;;QAKI;IACG,KAAK,CAAC,qBAAqB,CAChC,WAAwB,EACxB,OAAe,EACf,KAAY;QAEZ,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,SAAS,CAAC;QACjD,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;IAC9E,CAAC;IAED;;;;;QAKI;IACG,KAAK,CAAC,qBAAqB,CAChC,WAAwB,EACxB,OAAe,EACf,OAAe;QAEf,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,WAAW,OAAO,EAAE,CAAC;QAC5D,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;QAMI;IACG,KAAK,CAAC,qBAAqB,CAChC,WAAwB,EACxB,OAAe,EACf,OAAe,EACf,KAAkB;QAElB,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,WAAW,OAAO,EAAE,CAAC;QAC5D,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;IAC/E,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module AccessControlClient\n */\nimport type { AccessToken } from \"@itwin/core-bentley\";\nimport type { AccessControlAPIResponse, Group, GroupUpdate, IGroupsClient } from \"../accessControlTypes\";\nimport { BaseClient } from \"./BaseClient\";\n\nexport class GroupsClient extends BaseClient implements IGroupsClient{\n public constructor(url?: string) {\n super(url);\n }\n\n /** Retrieves a list of available user roles that are defined for a specified iTwin\n * @param accessToken The client access token string\n * @param iTwinId The id of the iTwin\n * @returns Group[]\n */\n public async getITwinGroupsAsync(\n accessToken: AccessToken,\n iTwinId: string,\n additionalHeaders?: { [key: string]: string }\n ): Promise<AccessControlAPIResponse<Group[]>>{\n const url = `${this._baseUrl}/${iTwinId}/groups`;\n return this.sendGenericAPIRequest(accessToken, \"GET\", url, undefined, \"groups\", additionalHeaders);\n }\n\n /** Retrieves the specified role for the specified iTwin\n * @param accessToken The client access token string\n * @param iTwinId The id of the iTwin\n * @returns Group\n */\n public async getITwinGroupAsync(\n accessToken: AccessToken,\n iTwinId: string,\n groupId: string,\n ): Promise<AccessControlAPIResponse<Group>>{\n const url = `${this._baseUrl}/${iTwinId}/groups/${groupId}`;\n return this.sendGenericAPIRequest(accessToken, \"GET\", url, undefined, \"group\");\n }\n\n /** Creates a new iTwin group\n * @param accessToken The client access token string\n * @param iTwinId The id of the iTwin\n * @param group The group to be created\n * @returns Group\n */\n public async createITwinGroupAsync(\n accessToken: AccessToken,\n iTwinId: string,\n group: Group\n ): Promise<AccessControlAPIResponse<Group>>{\n const url = `${this._baseUrl}/${iTwinId}/groups`;\n return this.sendGenericAPIRequest(accessToken, \"POST\", url, group, \"group\");\n }\n\n /** Delete the specified iTwin group\n * @param accessToken The client access token string\n * @param iTwinId The id of the iTwin\n * @param groupId The id of the group to remove\n * @returns No Content\n */\n public async deleteITwinGroupAsync(\n accessToken: AccessToken,\n iTwinId: string,\n groupId: string,\n ): Promise<AccessControlAPIResponse<undefined>>{\n const url = `${this._baseUrl}/${iTwinId}/groups/${groupId}`;\n return this.sendGenericAPIRequest(accessToken, \"DELETE\", url);\n }\n\n /** Update the specified iTwin group\n * @param accessToken The client access token string\n * @param iTwinId The id of the iTwin\n * @param groupId The id of the role to update\n * @param group The updated group\n * @returns Role\n */\n public async updateITwinGroupAsync(\n accessToken: AccessToken,\n iTwinId: string,\n groupId: string,\n group: GroupUpdate\n ): Promise<AccessControlAPIResponse<Group>>{\n const url = `${this._baseUrl}/${iTwinId}/groups/${groupId}`;\n return this.sendGenericAPIRequest(accessToken, \"PATCH\", url, group, \"group\");\n }\n}\n"]}
1
+ {"version":3,"file":"GroupsClient.js","sourceRoot":"","sources":["../../../src/subClients/GroupsClient.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAMH,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C;GACG;AACH,MAAM,OAAO,YAAa,SAAQ,UAAU;IAC1C;;OAEG;IACH,YAAmB,GAAY;QAC7B,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;IAED;;;;QAII;IACG,KAAK,CAAC,cAAc,CACzB,WAAwB,EACxB,OAAe;QAEf,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,SAAS,CAAC;QACjD,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;IAC7D,CAAC;IAED;;;;QAII;IACG,KAAK,CAAC,aAAa,CACxB,WAAwB,EACxB,OAAe,EACf,OAAe;QAEf,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,WAAW,OAAO,EAAE,CAAC;QAC5D,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;QAKI;IACG,KAAK,CAAC,gBAAgB,CAC3B,WAAwB,EACxB,OAAe,EACf,KAA2C;QAE3C,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,SAAS,CAAC;QACjD,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,MAAM,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;IACrE,CAAC;IAED;;;;;QAKI;IACG,KAAK,CAAC,gBAAgB,CAC3B,WAAwB,EACxB,OAAe,EACf,OAAe;QAEf,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,WAAW,OAAO,EAAE,CAAC;QAC5D,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;QAMI;IACG,KAAK,CAAC,gBAAgB,CAC3B,WAAwB,EACxB,OAAe,EACf,OAAe,EACf,KAAgG;QAEhG,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,WAAW,OAAO,EAAE,CAAC;QAC5D,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,OAAO,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;IACtE,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module AccessControlClient\n */\n\nimport type { AccessToken } from \"@itwin/core-bentley\";\nimport type { IGroupsClient } from \"../accessControlClientInterfaces/GroupClient\";\nimport type { BentleyAPIResponse } from \"../types/CommonApiTypes\";\nimport type { Group, MultipleGroupsResponse, SingleGroupResponse } from \"../types/Groups\";\nimport { BaseClient } from \"./BaseClient\";\n\n/** Client API to perform iTwin group operations.\n */\nexport class GroupsClient extends BaseClient implements IGroupsClient{\n /** Create a new GroupsClient instance\n * @param url Optional base URL for the access control service. If not provided, defaults to base url.\n */\n public constructor(url?: string) {\n super(url);\n }\n\n /** Retrieves a list of available user roles that are defined for a specified iTwin\n * @param accessToken The client access token string\n * @param iTwinId The id of the iTwin\n * @returns Group[]\n */\n public async getITwinGroups(\n accessToken: AccessToken,\n iTwinId: string\n ): Promise<BentleyAPIResponse<MultipleGroupsResponse>>{\n const url = `${this._baseUrl}/${iTwinId}/groups`;\n return this.sendGenericAPIRequest(accessToken, \"GET\", url);\n }\n\n /** Retrieves the specified role for the specified iTwin\n * @param accessToken The client access token string\n * @param iTwinId The id of the iTwin\n * @returns Group\n */\n public async getITwinGroup(\n accessToken: AccessToken,\n iTwinId: string,\n groupId: string,\n ): Promise<BentleyAPIResponse<SingleGroupResponse>>{\n const url = `${this._baseUrl}/${iTwinId}/groups/${groupId}`;\n return this.sendGenericAPIRequest(accessToken, \"GET\", url);\n }\n\n /** Creates a new iTwin group\n * @param accessToken The client access token string\n * @param iTwinId The id of the iTwin\n * @param group The group to be created\n * @returns Group\n */\n public async createITwinGroup(\n accessToken: AccessToken,\n iTwinId: string,\n group: Pick< Group, \"name\" | \"description\">\n ): Promise<BentleyAPIResponse<SingleGroupResponse>>{\n const url = `${this._baseUrl}/${iTwinId}/groups`;\n return this.sendGenericAPIRequest(accessToken, \"POST\", url, group);\n }\n\n /** Delete the specified iTwin group\n * @param accessToken The client access token string\n * @param iTwinId The id of the iTwin\n * @param groupId The id of the group to remove\n * @returns No Content\n */\n public async deleteITwinGroup(\n accessToken: AccessToken,\n iTwinId: string,\n groupId: string,\n ): Promise<BentleyAPIResponse<undefined>>{\n const url = `${this._baseUrl}/${iTwinId}/groups/${groupId}`;\n return this.sendGenericAPIRequest(accessToken, \"DELETE\", url);\n }\n\n /** Update the specified iTwin group\n * @param accessToken The client access token string\n * @param iTwinId The id of the iTwin\n * @param groupId The id of the role to update\n * @param group The updated group\n * @returns Group that was updated\n */\n public async updateITwinGroup(\n accessToken: AccessToken,\n iTwinId: string,\n groupId: string,\n group: Partial<Pick<Group, \"name\" | \"description\"> & { members: string[]; imsGroups: string[] }>\n ): Promise<BentleyAPIResponse<SingleGroupResponse>>{\n const url = `${this._baseUrl}/${iTwinId}/groups/${groupId}`;\n return this.sendGenericAPIRequest(accessToken, \"PATCH\", url, group);\n }\n}\n"]}
@@ -2,9 +2,16 @@
2
2
  * @module AccessControlClient
3
3
  */
4
4
  import type { AccessToken } from "@itwin/core-bentley";
5
- import type { AccessControlAPIResponse, AccessControlResultMode, IITwinJobsClient, ITwinJob, ITwinJobActions } from "../accessControlTypes";
5
+ import type { IITwinJobsClient } from "../accessControlClientInterfaces/ITwinJobsClient";
6
+ import type { BentleyAPIResponse, ResultMode } from "../types/CommonApiTypes";
7
+ import type { ITwinJob, ITwinJobActions } from "../types/ITwinJob";
6
8
  import { BaseClient } from "./BaseClient";
9
+ /** Client API to perform iTwin job operations.
10
+ */
7
11
  export declare class ITwinJobsClient extends BaseClient implements IITwinJobsClient {
12
+ /** Create a new ITwinJobsClient instance
13
+ * @param url Optional base URL for the access control service. If not provided, defaults to base url.
14
+ */
8
15
  constructor(url?: string);
9
16
  /** Create a new iTwin Job
10
17
  * @param accessToken The client access token string
@@ -12,7 +19,7 @@ export declare class ITwinJobsClient extends BaseClient implements IITwinJobsCli
12
19
  * @param iTwinActions The actions of the iTwin Job
13
20
  * @returns ITwin Job
14
21
  */
15
- createITwinJobAsync(accessToken: AccessToken, iTwinId: string, iTwinJobActions: ITwinJobActions): Promise<AccessControlAPIResponse<ITwinJob>>;
22
+ createITwinJob(accessToken: AccessToken, iTwinId: string, iTwinJobActions: ITwinJobActions): Promise<BentleyAPIResponse<ITwinJob>>;
16
23
  /** Gets an iTwin Job.
17
24
  * @param accessToken The client access token string
18
25
  * @param iTwinId The id of the iTwin
@@ -20,19 +27,19 @@ export declare class ITwinJobsClient extends BaseClient implements IITwinJobsCli
20
27
  * @param resultMode (Optional) Access Control result mode: minimal or representation (defaults to minimal)
21
28
  * @returns ITwin Job
22
29
  */
23
- getITwinJobAsync(accessToken: AccessToken, iTwinId: string, iTwinJobId: string, resultMode?: AccessControlResultMode): Promise<AccessControlAPIResponse<ITwinJob>>;
30
+ getITwinJob<T extends ResultMode = "minimal">(accessToken: AccessToken, iTwinId: string, iTwinJobId: string, resultMode?: T): Promise<BentleyAPIResponse<T extends "representation" ? ITwinJob : Omit<ITwinJob, "error">>>;
24
31
  /** Gets an iTwin Job.
25
32
  * @param accessToken The client access token string
26
33
  * @param iTwinId The id of the iTwin
27
34
  * @param iTwinJobId The id of the iTwin Job
28
35
  * @returns ITwin Job Actions
29
36
  */
30
- getITwinJobActionsAsync(accessToken: AccessToken, iTwinId: string, iTwinJobId?: string): Promise<AccessControlAPIResponse<ITwinJobActions>>;
37
+ getITwinJobActions(accessToken: AccessToken, iTwinId: string, iTwinJobId?: string): Promise<BentleyAPIResponse<ITwinJobActions>>;
31
38
  /**
32
39
  * Format result mode parameter into a headers entry
33
40
  * @param resultMode (Optional) Access Control result mode
34
41
  * @protected
35
42
  */
36
- protected getResultModeHeaders(resultMode?: AccessControlResultMode): Record<string, string>;
43
+ protected getResultModeHeaders(resultMode?: ResultMode): Record<string, string>;
37
44
  }
38
45
  //# sourceMappingURL=ITwinJobsClient.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"ITwinJobsClient.d.ts","sourceRoot":"","sources":["../../../src/subClients/ITwinJobsClient.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,KAAK,EAAE,wBAAwB,EAAE,uBAAuB,EAAE,gBAAgB,EAAE,QAAQ,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAC5I,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,qBAAa,eAAgB,SAAQ,UAAW,YAAW,gBAAgB;gBACtD,GAAG,CAAC,EAAE,MAAM;IAI/B;;;;;SAKK;IACQ,mBAAmB,CAC9B,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,eAAe,EAAE,eAAe,GAC/B,OAAO,CAAC,wBAAwB,CAAC,QAAQ,CAAC,CAAC;IAK9C;;;;;;SAMK;IACQ,gBAAgB,CAC3B,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAClB,UAAU,CAAC,EAAE,uBAAuB,GACnC,OAAO,CAAC,wBAAwB,CAAC,QAAQ,CAAC,CAAC;IAM9C;;;;;SAKK;IACQ,uBAAuB,CAClC,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,UAAU,CAAC,EAAE,MAAM,GAClB,OAAO,CAAC,wBAAwB,CAAC,eAAe,CAAC,CAAC;IAKrD;;;;OAIG;IACH,SAAS,CAAC,oBAAoB,CAAC,UAAU,GAAE,uBAAmC,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;CAKxG"}
1
+ {"version":3,"file":"ITwinJobsClient.d.ts","sourceRoot":"","sources":["../../../src/subClients/ITwinJobsClient.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kDAAkD,CAAC;AACzF,OAAO,KAAK,EAAE,kBAAkB,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAC9E,OAAO,KAAK,EAAE,QAAQ,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACnE,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C;GACG;AACH,qBAAa,eAAgB,SAAQ,UAAW,YAAW,gBAAgB;IACzE;;OAEG;gBACgB,GAAG,CAAC,EAAE,MAAM;IAI/B;;;;;SAKK;IACQ,cAAc,CACzB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,eAAe,EAAE,eAAe,GAC/B,OAAO,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC;IAKxC;;;;;;SAMK;IACQ,WAAW,CAAC,CAAC,SAAS,UAAU,GAAG,SAAS,EACvD,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAClB,UAAU,CAAC,EAAE,CAAC,GACb,OAAO,CAAC,kBAAkB,CAAC,CAAC,SAAS,gBAAgB,GAAG,QAAQ,GAAG,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC;IAM/F;;;;;SAKK;IACQ,kBAAkB,CAC7B,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,UAAU,CAAC,EAAE,MAAM,GAClB,OAAO,CAAC,kBAAkB,CAAC,eAAe,CAAC,CAAC;IAK/C;;;;OAIG;IACH,SAAS,CAAC,oBAAoB,CAAC,UAAU,GAAE,UAAsB,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;CAK3F"}
@@ -1,5 +1,17 @@
1
+ /*---------------------------------------------------------------------------------------------
2
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
3
+ * See LICENSE.md in the project root for license terms and full copyright notice.
4
+ *--------------------------------------------------------------------------------------------*/
5
+ /** @packageDocumentation
6
+ * @module AccessControlClient
7
+ */
1
8
  import { BaseClient } from "./BaseClient";
9
+ /** Client API to perform iTwin job operations.
10
+ */
2
11
  export class ITwinJobsClient extends BaseClient {
12
+ /** Create a new ITwinJobsClient instance
13
+ * @param url Optional base URL for the access control service. If not provided, defaults to base url.
14
+ */
3
15
  constructor(url) {
4
16
  super(url);
5
17
  }
@@ -9,7 +21,7 @@ export class ITwinJobsClient extends BaseClient {
9
21
  * @param iTwinActions The actions of the iTwin Job
10
22
  * @returns ITwin Job
11
23
  */
12
- async createITwinJobAsync(accessToken, iTwinId, iTwinJobActions) {
24
+ async createITwinJob(accessToken, iTwinId, iTwinJobActions) {
13
25
  const url = `${this._baseUrl}/${iTwinId}/jobs`;
14
26
  return this.sendGenericAPIRequest(accessToken, "POST", url, { actions: iTwinJobActions });
15
27
  }
@@ -20,7 +32,7 @@ export class ITwinJobsClient extends BaseClient {
20
32
  * @param resultMode (Optional) Access Control result mode: minimal or representation (defaults to minimal)
21
33
  * @returns ITwin Job
22
34
  */
23
- async getITwinJobAsync(accessToken, iTwinId, iTwinJobId, resultMode) {
35
+ async getITwinJob(accessToken, iTwinId, iTwinJobId, resultMode) {
24
36
  const headers = this.getResultModeHeaders(resultMode);
25
37
  const url = `${this._baseUrl}/${iTwinId}/jobs/${iTwinJobId}`;
26
38
  return this.sendGenericAPIRequest(accessToken, "GET", url, undefined, undefined, headers);
@@ -31,7 +43,7 @@ export class ITwinJobsClient extends BaseClient {
31
43
  * @param iTwinJobId The id of the iTwin Job
32
44
  * @returns ITwin Job Actions
33
45
  */
34
- async getITwinJobActionsAsync(accessToken, iTwinId, iTwinJobId) {
46
+ async getITwinJobActions(accessToken, iTwinId, iTwinJobId) {
35
47
  const url = `${this._baseUrl}/${iTwinId}/jobs/${iTwinJobId}/actions`;
36
48
  return this.sendGenericAPIRequest(accessToken, "GET", url, undefined, "actions");
37
49
  }
@@ -1 +1 @@
1
- {"version":3,"file":"ITwinJobsClient.js","sourceRoot":"","sources":["../../../src/subClients/ITwinJobsClient.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,MAAM,OAAO,eAAgB,SAAQ,UAAU;IAC7C,YAAmB,GAAY;QAC7B,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;IAED;;;;;SAKK;IACE,KAAK,CAAC,mBAAmB,CAC9B,WAAwB,EACxB,OAAe,EACf,eAAgC;QAEhC,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,OAAO,CAAC;QAC/C,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,MAAM,EAAE,GAAG,EAAE,EAAE,OAAO,EAAE,eAAe,EAAE,CAAC,CAAC;IAC5F,CAAC;IAED;;;;;;SAMK;IACE,KAAK,CAAC,gBAAgB,CAC3B,WAAwB,EACxB,OAAe,EACf,UAAkB,EAClB,UAAoC;QAEpC,MAAM,OAAO,GAAG,IAAI,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC;QACtD,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,SAAS,UAAU,EAAE,CAAC;QAC7D,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IAC5F,CAAC;IAED;;;;;SAKK;IACE,KAAK,CAAC,uBAAuB,CAClC,WAAwB,EACxB,OAAe,EACf,UAAmB;QAEnB,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,SAAS,UAAU,UAAU,CAAC;QACrE,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;IACnF,CAAC;IAED;;;;OAIG;IACO,oBAAoB,CAAC,aAAsC,SAAS;QAC5E,OAAO;YACL,MAAM,EAAE,UAAU,UAAU,EAAE;SAC/B,CAAC;IACJ,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module AccessControlClient\n */\nimport type { AccessToken } from \"@itwin/core-bentley\";\nimport type { AccessControlAPIResponse, AccessControlResultMode, IITwinJobsClient, ITwinJob, ITwinJobActions } from \"../accessControlTypes\";\nimport { BaseClient } from \"./BaseClient\";\n\nexport class ITwinJobsClient extends BaseClient implements IITwinJobsClient {\n public constructor(url?: string) {\n super(url);\n }\n\n /** Create a new iTwin Job\n * @param accessToken The client access token string\n * @param iTwinId The id of the iTwin\n * @param iTwinActions The actions of the iTwin Job\n * @returns ITwin Job\n */\n public async createITwinJobAsync(\n accessToken: AccessToken,\n iTwinId: string,\n iTwinJobActions: ITwinJobActions\n ): Promise<AccessControlAPIResponse<ITwinJob>> {\n const url = `${this._baseUrl}/${iTwinId}/jobs`;\n return this.sendGenericAPIRequest(accessToken, \"POST\", url, { actions: iTwinJobActions });\n }\n\n /** Gets an iTwin Job.\n * @param accessToken The client access token string\n * @param iTwinId The id of the iTwin\n * @param iTwinJobId The id of the iTwin Job\n * @param resultMode (Optional) Access Control result mode: minimal or representation (defaults to minimal)\n * @returns ITwin Job\n */\n public async getITwinJobAsync(\n accessToken: AccessToken,\n iTwinId: string,\n iTwinJobId: string,\n resultMode?: AccessControlResultMode\n ): Promise<AccessControlAPIResponse<ITwinJob>> {\n const headers = this.getResultModeHeaders(resultMode);\n const url = `${this._baseUrl}/${iTwinId}/jobs/${iTwinJobId}`;\n return this.sendGenericAPIRequest(accessToken, \"GET\", url, undefined, undefined, headers);\n }\n\n /** Gets an iTwin Job.\n * @param accessToken The client access token string\n * @param iTwinId The id of the iTwin\n * @param iTwinJobId The id of the iTwin Job\n * @returns ITwin Job Actions\n */\n public async getITwinJobActionsAsync(\n accessToken: AccessToken,\n iTwinId: string,\n iTwinJobId?: string\n ): Promise<AccessControlAPIResponse<ITwinJobActions>> {\n const url = `${this._baseUrl}/${iTwinId}/jobs/${iTwinJobId}/actions`;\n return this.sendGenericAPIRequest(accessToken, \"GET\", url, undefined, \"actions\");\n }\n\n /**\n * Format result mode parameter into a headers entry\n * @param resultMode (Optional) Access Control result mode\n * @protected\n */\n protected getResultModeHeaders(resultMode: AccessControlResultMode = \"minimal\"): Record<string, string> {\n return {\n prefer: `return=${resultMode}`,\n };\n }\n}\n"]}
1
+ {"version":3,"file":"ITwinJobsClient.js","sourceRoot":"","sources":["../../../src/subClients/ITwinJobsClient.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAMH,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C;GACG;AACH,MAAM,OAAO,eAAgB,SAAQ,UAAU;IAC7C;;OAEG;IACH,YAAmB,GAAY;QAC7B,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;IAED;;;;;SAKK;IACE,KAAK,CAAC,cAAc,CACzB,WAAwB,EACxB,OAAe,EACf,eAAgC;QAEhC,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,OAAO,CAAC;QAC/C,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,MAAM,EAAE,GAAG,EAAE,EAAE,OAAO,EAAE,eAAe,EAAE,CAAC,CAAC;IAC5F,CAAC;IAED;;;;;;SAMK;IACE,KAAK,CAAC,WAAW,CACtB,WAAwB,EACxB,OAAe,EACf,UAAkB,EAClB,UAAc;QAEd,MAAM,OAAO,GAAG,IAAI,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC;QACtD,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,SAAS,UAAU,EAAE,CAAC;QAC7D,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IAC5F,CAAC;IAED;;;;;SAKK;IACE,KAAK,CAAC,kBAAkB,CAC7B,WAAwB,EACxB,OAAe,EACf,UAAmB;QAEnB,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,SAAS,UAAU,UAAU,CAAC;QACrE,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;IACnF,CAAC;IAED;;;;OAIG;IACO,oBAAoB,CAAC,aAAyB,SAAS;QAC/D,OAAO;YACL,MAAM,EAAE,UAAU,UAAU,EAAE;SAC/B,CAAC;IACJ,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module AccessControlClient\n */\n\nimport type { AccessToken } from \"@itwin/core-bentley\";\nimport type { IITwinJobsClient } from \"../accessControlClientInterfaces/ITwinJobsClient\";\nimport type { BentleyAPIResponse, ResultMode } from \"../types/CommonApiTypes\";\nimport type { ITwinJob, ITwinJobActions } from \"../types/ITwinJob\";\nimport { BaseClient } from \"./BaseClient\";\n\n/** Client API to perform iTwin job operations.\n */\nexport class ITwinJobsClient extends BaseClient implements IITwinJobsClient {\n /** Create a new ITwinJobsClient instance\n * @param url Optional base URL for the access control service. If not provided, defaults to base url.\n */\n public constructor(url?: string) {\n super(url);\n }\n\n /** Create a new iTwin Job\n * @param accessToken The client access token string\n * @param iTwinId The id of the iTwin\n * @param iTwinActions The actions of the iTwin Job\n * @returns ITwin Job\n */\n public async createITwinJob(\n accessToken: AccessToken,\n iTwinId: string,\n iTwinJobActions: ITwinJobActions\n ): Promise<BentleyAPIResponse<ITwinJob>> {\n const url = `${this._baseUrl}/${iTwinId}/jobs`;\n return this.sendGenericAPIRequest(accessToken, \"POST\", url, { actions: iTwinJobActions });\n }\n\n /** Gets an iTwin Job.\n * @param accessToken The client access token string\n * @param iTwinId The id of the iTwin\n * @param iTwinJobId The id of the iTwin Job\n * @param resultMode (Optional) Access Control result mode: minimal or representation (defaults to minimal)\n * @returns ITwin Job\n */\n public async getITwinJob<T extends ResultMode = \"minimal\">(\n accessToken: AccessToken,\n iTwinId: string,\n iTwinJobId: string,\n resultMode?: T\n ): Promise<BentleyAPIResponse<T extends \"representation\" ? ITwinJob : Omit<ITwinJob, \"error\">>> {\n const headers = this.getResultModeHeaders(resultMode);\n const url = `${this._baseUrl}/${iTwinId}/jobs/${iTwinJobId}`;\n return this.sendGenericAPIRequest(accessToken, \"GET\", url, undefined, undefined, headers);\n }\n\n /** Gets an iTwin Job.\n * @param accessToken The client access token string\n * @param iTwinId The id of the iTwin\n * @param iTwinJobId The id of the iTwin Job\n * @returns ITwin Job Actions\n */\n public async getITwinJobActions(\n accessToken: AccessToken,\n iTwinId: string,\n iTwinJobId?: string\n ): Promise<BentleyAPIResponse<ITwinJobActions>> {\n const url = `${this._baseUrl}/${iTwinId}/jobs/${iTwinJobId}/actions`;\n return this.sendGenericAPIRequest(accessToken, \"GET\", url, undefined, \"actions\");\n }\n\n /**\n * Format result mode parameter into a headers entry\n * @param resultMode (Optional) Access Control result mode\n * @protected\n */\n protected getResultModeHeaders(resultMode: ResultMode = \"minimal\"): Record<string, string> {\n return {\n prefer: `return=${resultMode}`,\n };\n }\n}\n"]}
@@ -0,0 +1,61 @@
1
+ /** @packageDocumentation
2
+ * @module AccessControlClient
3
+ */
4
+ import type { AccessToken } from "@itwin/core-bentley";
5
+ import type { IITwinSharesClient } from "../accessControlClientInterfaces/ItwinSharesClient";
6
+ import type { BentleyAPIResponse } from "../types/CommonApiTypes";
7
+ import type { MultiShareContractResponse, ShareContract, SingleShareContractResponse } from "../types/ShareContract";
8
+ import { BaseClient } from "./BaseClient";
9
+ /** Client API to perform iTwin share operations.
10
+ * @beta
11
+ */
12
+ export declare class ITwinSharesClient extends BaseClient implements IITwinSharesClient {
13
+ /** Create a new ITwinSharesClient instance
14
+ * @param url Optional base URL for the access control service. If not provided, defaults to base url.
15
+ */
16
+ constructor(url?: string);
17
+ /** Create a new iTwin share
18
+ * @param accessToken The client access token string
19
+ * @param iTwinId The id of the iTwin
20
+ * @param iTwinShare The details of the iTwin share to be created
21
+ * @remarks
22
+ * #### Create
23
+ * Creating an iTwin Share allows your iTwin to be publicly accessible, enabling anyone with the `shareKey` to view its data without needing to sign in. To use a share, take the value of the `shareKey` property and prepend it with the `Basic` prefix in the authorization header of your request.
24
+ *
25
+ * #### Share Contract
26
+ * Each share is governed by a share contract that specifies the APIs available for the share and its associated iTwin.
27
+ * Only an iTwin admin can create iTwin Shares, and only a maximum of 10 shares can be active at a time per application that created it.
28
+ * The share contract expires after 90 days unless a shorter expiration is specified in the request body, with 90 days being the maximum duration. If the expiration property in the request body is left empty, it will default to the maximum duration from the moment of creation.
29
+ * A share can be revoked at any time using the Revoke iTwin Share endpoint.
30
+ * @returns ITwin Share
31
+ * @beta
32
+ */
33
+ createITwinShare(accessToken: AccessToken, iTwinId: string, iTwinShare: Partial<Pick<ShareContract, "shareContract"> & {
34
+ expiration: string | null;
35
+ }>): Promise<BentleyAPIResponse<SingleShareContractResponse>>;
36
+ /** Get iTwin share
37
+ * @param accessToken The client access token string
38
+ * @param iTwinId The id of the iTwin
39
+ * @param sharedId The id of the iTwin share to be retrieved
40
+ * @returns The iTwin share details
41
+ * @beta
42
+ */
43
+ getITwinShare(accessToken: AccessToken, iTwinId: string, sharedId: string): Promise<BentleyAPIResponse<SingleShareContractResponse>>;
44
+ /** Get iTwin shares
45
+ * @param accessToken The client access token string
46
+ * @param iTwinId The id of the iTwin
47
+ * @param sharedId The id of the iTwin share to be retrieved
48
+ * @returns The iTwin share details
49
+ * @beta
50
+ */
51
+ getITwinShares(accessToken: AccessToken, iTwinId: string): Promise<BentleyAPIResponse<MultiShareContractResponse>>;
52
+ /** Revoke iTwin share
53
+ * @param accessToken The client access token string
54
+ * @param iTwinId The id of the iTwin
55
+ * @param sharedId The id of the iTwin share to be revoked
56
+ * @returns No Content
57
+ * @beta
58
+ */
59
+ revokeITwinShare(accessToken: AccessToken, iTwinId: string, sharedId: string): Promise<BentleyAPIResponse<undefined>>;
60
+ }
61
+ //# sourceMappingURL=ItwinShares.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ItwinShares.d.ts","sourceRoot":"","sources":["../../../src/subClients/ItwinShares.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,oDAAoD,CAAC;AAC7F,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAClE,OAAO,KAAK,EAAE,0BAA0B,EAAE,aAAa,EAAE,2BAA2B,EAAE,MAAM,wBAAwB,CAAC;AACrH,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C;;GAEG;AACH,qBAAa,iBACX,SAAQ,UACR,YAAW,kBAAkB;IAE7B;;OAEG;gBACgB,GAAG,CAAC,EAAE,MAAM;IAI/B;;;;;;;;;;;;;;;OAeG;IACU,gBAAgB,CAC3B,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,eAAe,CAAC,GAAG;QAAE,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;KAAE,CAAC,GACxF,OAAO,CAAC,kBAAkB,CAAC,2BAA2B,CAAC,CAAC;IAKzD;;;;;;KAMC;IACU,aAAa,CACxB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,kBAAkB,CAAC,2BAA2B,CAAC,CAAC;IAK3D;;;;;;OAMG;IACU,cAAc,CACzB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,kBAAkB,CAAC,0BAA0B,CAAC,CAAC;IAKxD;;;;;;KAMC;IACU,gBAAgB,CAC3B,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;CAK1C"}
@@ -0,0 +1,73 @@
1
+ /*---------------------------------------------------------------------------------------------
2
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
3
+ * See LICENSE.md in the project root for license terms and full copyright notice.
4
+ *--------------------------------------------------------------------------------------------*/
5
+ /** @packageDocumentation
6
+ * @module AccessControlClient
7
+ */
8
+ import { BaseClient } from "./BaseClient";
9
+ /** Client API to perform iTwin share operations.
10
+ * @beta
11
+ */
12
+ export class ITwinSharesClient extends BaseClient {
13
+ /** Create a new ITwinSharesClient instance
14
+ * @param url Optional base URL for the access control service. If not provided, defaults to base url.
15
+ */
16
+ constructor(url) {
17
+ super(url);
18
+ }
19
+ /** Create a new iTwin share
20
+ * @param accessToken The client access token string
21
+ * @param iTwinId The id of the iTwin
22
+ * @param iTwinShare The details of the iTwin share to be created
23
+ * @remarks
24
+ * #### Create
25
+ * Creating an iTwin Share allows your iTwin to be publicly accessible, enabling anyone with the `shareKey` to view its data without needing to sign in. To use a share, take the value of the `shareKey` property and prepend it with the `Basic` prefix in the authorization header of your request.
26
+ *
27
+ * #### Share Contract
28
+ * Each share is governed by a share contract that specifies the APIs available for the share and its associated iTwin.
29
+ * Only an iTwin admin can create iTwin Shares, and only a maximum of 10 shares can be active at a time per application that created it.
30
+ * The share contract expires after 90 days unless a shorter expiration is specified in the request body, with 90 days being the maximum duration. If the expiration property in the request body is left empty, it will default to the maximum duration from the moment of creation.
31
+ * A share can be revoked at any time using the Revoke iTwin Share endpoint.
32
+ * @returns ITwin Share
33
+ * @beta
34
+ */
35
+ async createITwinShare(accessToken, iTwinId, iTwinShare) {
36
+ const url = `${this._baseUrl}/${iTwinId}/shares`;
37
+ return this.sendGenericAPIRequest(accessToken, "POST", url, iTwinShare);
38
+ }
39
+ /** Get iTwin share
40
+ * @param accessToken The client access token string
41
+ * @param iTwinId The id of the iTwin
42
+ * @param sharedId The id of the iTwin share to be retrieved
43
+ * @returns The iTwin share details
44
+ * @beta
45
+ */
46
+ async getITwinShare(accessToken, iTwinId, sharedId) {
47
+ const url = `${this._baseUrl}/${iTwinId}/shares/${sharedId}`;
48
+ return this.sendGenericAPIRequest(accessToken, "GET", url);
49
+ }
50
+ /** Get iTwin shares
51
+ * @param accessToken The client access token string
52
+ * @param iTwinId The id of the iTwin
53
+ * @param sharedId The id of the iTwin share to be retrieved
54
+ * @returns The iTwin share details
55
+ * @beta
56
+ */
57
+ async getITwinShares(accessToken, iTwinId) {
58
+ const url = `${this._baseUrl}/${iTwinId}/shares`;
59
+ return this.sendGenericAPIRequest(accessToken, "GET", url);
60
+ }
61
+ /** Revoke iTwin share
62
+ * @param accessToken The client access token string
63
+ * @param iTwinId The id of the iTwin
64
+ * @param sharedId The id of the iTwin share to be revoked
65
+ * @returns No Content
66
+ * @beta
67
+ */
68
+ async revokeITwinShare(accessToken, iTwinId, sharedId) {
69
+ const url = `${this._baseUrl}/${iTwinId}/shares/${sharedId}`;
70
+ return this.sendGenericAPIRequest(accessToken, "DELETE", url);
71
+ }
72
+ }
73
+ //# sourceMappingURL=ItwinShares.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ItwinShares.js","sourceRoot":"","sources":["../../../src/subClients/ItwinShares.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAMH,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C;;GAEG;AACH,MAAM,OAAO,iBACX,SAAQ,UAAU;IAGlB;;OAEG;IACH,YAAmB,GAAY;QAC7B,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACI,KAAK,CAAC,gBAAgB,CAC3B,WAAwB,EACxB,OAAe,EACf,UAAyF;QAEzF,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,SAAS,CAAC;QACjD,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,MAAM,EAAE,GAAG,EAAE,UAAU,CAAC,CAAC;IAC1E,CAAC;IAEC;;;;;;KAMC;IACI,KAAK,CAAC,aAAa,CACxB,WAAwB,EACxB,OAAe,EACf,QAAgB;QAEhB,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,WAAW,QAAQ,EAAE,CAAC;QAC7D,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,cAAc,CACzB,WAAwB,EACxB,OAAe;QAEf,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,SAAS,CAAC;QACjD,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;IAC7D,CAAC;IAEC;;;;;;KAMC;IACI,KAAK,CAAC,gBAAgB,CAC3B,WAAwB,EACxB,OAAe,EACf,QAAgB;QAEhB,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,WAAW,QAAQ,EAAE,CAAC;QAC7D,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC;IAChE,CAAC;CAEF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module AccessControlClient\n */\n\nimport type { AccessToken } from \"@itwin/core-bentley\";\nimport type { IITwinSharesClient } from \"../accessControlClientInterfaces/ItwinSharesClient\";\nimport type { BentleyAPIResponse } from \"../types/CommonApiTypes\";\nimport type { MultiShareContractResponse, ShareContract, SingleShareContractResponse } from \"../types/ShareContract\";\nimport { BaseClient } from \"./BaseClient\";\n\n/** Client API to perform iTwin share operations.\n * @beta\n */\nexport class ITwinSharesClient\n extends BaseClient\n implements IITwinSharesClient\n{\n /** Create a new ITwinSharesClient instance\n * @param url Optional base URL for the access control service. If not provided, defaults to base url.\n */\n public constructor(url?: string) {\n super(url);\n }\n\n /** Create a new iTwin share\n * @param accessToken The client access token string\n * @param iTwinId The id of the iTwin\n * @param iTwinShare The details of the iTwin share to be created\n * @remarks\n * #### Create\n * Creating an iTwin Share allows your iTwin to be publicly accessible, enabling anyone with the `shareKey` to view its data without needing to sign in. To use a share, take the value of the `shareKey` property and prepend it with the `Basic` prefix in the authorization header of your request.\n *\n * #### Share Contract\n * Each share is governed by a share contract that specifies the APIs available for the share and its associated iTwin.\n * Only an iTwin admin can create iTwin Shares, and only a maximum of 10 shares can be active at a time per application that created it.\n * The share contract expires after 90 days unless a shorter expiration is specified in the request body, with 90 days being the maximum duration. If the expiration property in the request body is left empty, it will default to the maximum duration from the moment of creation.\n * A share can be revoked at any time using the Revoke iTwin Share endpoint.\n * @returns ITwin Share\n * @beta\n */\n public async createITwinShare(\n accessToken: AccessToken,\n iTwinId: string,\n iTwinShare: Partial<Pick<ShareContract, \"shareContract\"> & { expiration: string | null }>\n ): Promise<BentleyAPIResponse<SingleShareContractResponse>> {\n const url = `${this._baseUrl}/${iTwinId}/shares`;\n return this.sendGenericAPIRequest(accessToken, \"POST\", url, iTwinShare);\n }\n\n /** Get iTwin share\n * @param accessToken The client access token string\n * @param iTwinId The id of the iTwin\n * @param sharedId The id of the iTwin share to be retrieved\n * @returns The iTwin share details\n * @beta\n */\n public async getITwinShare(\n accessToken: AccessToken,\n iTwinId: string,\n sharedId: string,\n ): Promise<BentleyAPIResponse<SingleShareContractResponse>> {\n const url = `${this._baseUrl}/${iTwinId}/shares/${sharedId}`;\n return this.sendGenericAPIRequest(accessToken, \"GET\", url);\n }\n\n /** Get iTwin shares\n * @param accessToken The client access token string\n * @param iTwinId The id of the iTwin\n * @param sharedId The id of the iTwin share to be retrieved\n * @returns The iTwin share details\n * @beta\n */\n public async getITwinShares(\n accessToken: AccessToken,\n iTwinId: string,\n ): Promise<BentleyAPIResponse<MultiShareContractResponse>> {\n const url = `${this._baseUrl}/${iTwinId}/shares`;\n return this.sendGenericAPIRequest(accessToken, \"GET\", url);\n }\n\n /** Revoke iTwin share\n * @param accessToken The client access token string\n * @param iTwinId The id of the iTwin\n * @param sharedId The id of the iTwin share to be revoked\n * @returns No Content\n * @beta\n */\n public async revokeITwinShare(\n accessToken: AccessToken,\n iTwinId: string,\n sharedId: string,\n ): Promise<BentleyAPIResponse<undefined>> {\n const url = `${this._baseUrl}/${iTwinId}/shares/${sharedId}`;\n return this.sendGenericAPIRequest(accessToken, \"DELETE\", url);\n }\n\n}\n"]}
@@ -2,16 +2,29 @@
2
2
  * @module AccessControlClient
3
3
  */
4
4
  import type { AccessToken } from "@itwin/core-bentley";
5
- import type { AccessControlAPIResponse, AccessControlQueryArg, IMemberInvitationsClient, MemberInvitation } from "../accessControlTypes";
5
+ import type { IMemberInvitationsClient } from "../accessControlClientInterfaces/MemberInvitationsClient";
6
+ import type { BentleyAPIResponse, ODataQueryParams } from "../types/CommonApiTypes";
7
+ import type { MultipleMemberInvitationResponse } from "../types/Invitations";
6
8
  import { BaseClient } from "./BaseClient";
9
+ /** Client API to perform iTwin member invitation operations.
10
+ */
7
11
  export declare class MemberInvitationsClient extends BaseClient implements IMemberInvitationsClient {
12
+ /** Create a new MemberInvitationsClient instance
13
+ * @param url Optional base URL for the access control service. If not provided, defaults to base url.
14
+ */
8
15
  constructor(url?: string);
9
16
  /** Retrieves a list of iTwin member invitations.
10
17
  * @param accessToken The client access token string
11
18
  * @param iTwinId The id of the iTwin
12
19
  * @returns Array of member invitations
13
20
  */
14
- queryITwinMemberInvitationsAsync(accessToken: AccessToken, iTwinId: string, arg?: AccessControlQueryArg): Promise<AccessControlAPIResponse<MemberInvitation[]>>;
15
- deleteITwinMemberInvitationAsync(accessToken: AccessToken, iTwinId: string, invitationId: string): Promise<AccessControlAPIResponse<undefined>>;
21
+ queryITwinMemberInvitations(accessToken: AccessToken, iTwinId: string, arg?: Pick<ODataQueryParams, "top" | "skip">): Promise<BentleyAPIResponse<MultipleMemberInvitationResponse>>;
22
+ /** Deletes a member invitations.
23
+ * @param accessToken The client access token string
24
+ * @param iTwinId The id of the iTwin
25
+ * @param invitationId The id of the invitation id
26
+ * @returns No Content
27
+ */
28
+ deleteITwinMemberInvitation(accessToken: AccessToken, iTwinId: string, invitationId: string): Promise<BentleyAPIResponse<undefined>>;
16
29
  }
17
30
  //# sourceMappingURL=MemberInvitationsClient.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"MemberInvitationsClient.d.ts","sourceRoot":"","sources":["../../../src/subClients/MemberInvitationsClient.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,KAAK,EACV,wBAAwB,EACxB,qBAAqB,EACrB,wBAAwB,EACxB,gBAAgB,EACjB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,qBAAa,uBACX,SAAQ,UACR,YAAW,wBAAwB;gBAChB,GAAG,CAAC,EAAE,MAAM;IAI/B;;;;OAIG;IACU,gCAAgC,CAC3C,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,GAAG,CAAC,EAAE,qBAAqB,GAC1B,OAAO,CAAC,wBAAwB,CAAC,gBAAgB,EAAE,CAAC,CAAC;IAgB3C,gCAAgC,CAC3C,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,YAAY,EAAE,MAAM,GACnB,OAAO,CAAC,wBAAwB,CAAC,SAAS,CAAC,CAAC;CAIhD"}
1
+ {"version":3,"file":"MemberInvitationsClient.d.ts","sourceRoot":"","sources":["../../../src/subClients/MemberInvitationsClient.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,0DAA0D,CAAC;AACzG,OAAO,KAAK,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AACpF,OAAO,KAAK,EAAE,gCAAgC,EAAE,MAAM,sBAAsB,CAAC;AAC7E,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C;GACG;AACH,qBAAa,uBACX,SAAQ,UACR,YAAW,wBAAwB;IACnC;;OAEG;gBACgB,GAAG,CAAC,EAAE,MAAM;IAI/B;;;;OAIG;IACU,2BAA2B,CACtC,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,GAAG,CAAC,EAAE,IAAI,CAAC,gBAAgB,EAAE,KAAK,GAAG,MAAM,CAAC,GAC3C,OAAO,CAAC,kBAAkB,CAAC,gCAAgC,CAAC,CAAC;IAahE;;;;;OAKG;IACU,2BAA2B,CACtC,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,EACf,YAAY,EAAE,MAAM,GACnB,OAAO,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;CAI1C"}
@@ -1,5 +1,17 @@
1
+ /*---------------------------------------------------------------------------------------------
2
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
3
+ * See LICENSE.md in the project root for license terms and full copyright notice.
4
+ *--------------------------------------------------------------------------------------------*/
5
+ /** @packageDocumentation
6
+ * @module AccessControlClient
7
+ */
1
8
  import { BaseClient } from "./BaseClient";
9
+ /** Client API to perform iTwin member invitation operations.
10
+ */
2
11
  export class MemberInvitationsClient extends BaseClient {
12
+ /** Create a new MemberInvitationsClient instance
13
+ * @param url Optional base URL for the access control service. If not provided, defaults to base url.
14
+ */
3
15
  constructor(url) {
4
16
  super(url);
5
17
  }
@@ -8,14 +20,17 @@ export class MemberInvitationsClient extends BaseClient {
8
20
  * @param iTwinId The id of the iTwin
9
21
  * @returns Array of member invitations
10
22
  */
11
- async queryITwinMemberInvitationsAsync(accessToken, iTwinId, arg) {
12
- let url = `${this._baseUrl}/${iTwinId}/members/invitations`;
13
- if (arg) {
14
- url += `?${this.getQueryString(arg)}`;
15
- }
16
- return this.sendGenericAPIRequest(accessToken, "GET", url, undefined, "invitations");
23
+ async queryITwinMemberInvitations(accessToken, iTwinId, arg) {
24
+ const url = `${this._baseUrl}/${iTwinId}/members/invitations${arg ? `?${this.getQueryString(MemberInvitationsClient.paginationParamMapping, { top: arg.top, skip: arg.skip })}` : ''}`;
25
+ return this.sendGenericAPIRequest(accessToken, "GET", url, undefined);
17
26
  }
18
- async deleteITwinMemberInvitationAsync(accessToken, iTwinId, invitationId) {
27
+ /** Deletes a member invitations.
28
+ * @param accessToken The client access token string
29
+ * @param iTwinId The id of the iTwin
30
+ * @param invitationId The id of the invitation id
31
+ * @returns No Content
32
+ */
33
+ async deleteITwinMemberInvitation(accessToken, iTwinId, invitationId) {
19
34
  const url = `${this._baseUrl}/${iTwinId}/members/invitations/${invitationId}`;
20
35
  return this.sendGenericAPIRequest(accessToken, "DELETE", url);
21
36
  }
@@ -1 +1 @@
1
- {"version":3,"file":"MemberInvitationsClient.js","sourceRoot":"","sources":["../../../src/subClients/MemberInvitationsClient.ts"],"names":[],"mappings":"AAcA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,MAAM,OAAO,uBACX,SAAQ,UAAU;IAElB,YAAmB,GAAY;QAC7B,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,gCAAgC,CAC3C,WAAwB,EACxB,OAAe,EACf,GAA2B;QAE3B,IAAI,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,sBAAsB,CAAC;QAE5D,IAAI,GAAG,EAAE;YACP,GAAG,IAAI,IAAI,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE,CAAC;SACvC;QAED,OAAO,IAAI,CAAC,qBAAqB,CAC/B,WAAW,EACX,KAAK,EACL,GAAG,EACH,SAAS,EACT,aAAa,CACd,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,gCAAgC,CAC3C,WAAwB,EACxB,OAAe,EACf,YAAoB;QAEpB,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,wBAAwB,YAAY,EAAE,CAAC;QAC9E,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC;IAChE,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module AccessControlClient\n */\nimport type { AccessToken } from \"@itwin/core-bentley\";\nimport type {\n AccessControlAPIResponse,\n AccessControlQueryArg,\n IMemberInvitationsClient,\n MemberInvitation,\n} from \"../accessControlTypes\";\nimport { BaseClient } from \"./BaseClient\";\n\nexport class MemberInvitationsClient\n extends BaseClient\n implements IMemberInvitationsClient {\n public constructor(url?: string) {\n super(url);\n }\n\n /** Retrieves a list of iTwin member invitations.\n * @param accessToken The client access token string\n * @param iTwinId The id of the iTwin\n * @returns Array of member invitations\n */\n public async queryITwinMemberInvitationsAsync(\n accessToken: AccessToken,\n iTwinId: string,\n arg?: AccessControlQueryArg\n ): Promise<AccessControlAPIResponse<MemberInvitation[]>> {\n let url = `${this._baseUrl}/${iTwinId}/members/invitations`;\n\n if (arg) {\n url += `?${this.getQueryString(arg)}`;\n }\n\n return this.sendGenericAPIRequest(\n accessToken,\n \"GET\",\n url,\n undefined,\n \"invitations\"\n );\n }\n\n public async deleteITwinMemberInvitationAsync(\n accessToken: AccessToken,\n iTwinId: string,\n invitationId: string\n ): Promise<AccessControlAPIResponse<undefined>> {\n const url = `${this._baseUrl}/${iTwinId}/members/invitations/${invitationId}`;\n return this.sendGenericAPIRequest(accessToken, \"DELETE\", url);\n }\n}\n"]}
1
+ {"version":3,"file":"MemberInvitationsClient.js","sourceRoot":"","sources":["../../../src/subClients/MemberInvitationsClient.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAMH,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C;GACG;AACH,MAAM,OAAO,uBACX,SAAQ,UAAU;IAElB;;OAEG;IACH,YAAmB,GAAY;QAC7B,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,2BAA2B,CACtC,WAAwB,EACxB,OAAe,EACf,GAA4C;QAE5C,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,uBACrC,GAAG,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,cAAc,CAAC,uBAAuB,CAAC,sBAAsB,EAAE,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,EACtH,EAAE,CAAC;QAEH,OAAO,IAAI,CAAC,qBAAqB,CAC/B,WAAW,EACX,KAAK,EACL,GAAG,EACH,SAAS,CACV,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,2BAA2B,CACtC,WAAwB,EACxB,OAAe,EACf,YAAoB;QAEpB,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,OAAO,wBAAwB,YAAY,EAAE,CAAC;QAC9E,OAAO,IAAI,CAAC,qBAAqB,CAAC,WAAW,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC;IAChE,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module AccessControlClient\n */\n\nimport type { AccessToken } from \"@itwin/core-bentley\";\nimport type { IMemberInvitationsClient } from \"../accessControlClientInterfaces/MemberInvitationsClient\";\nimport type { BentleyAPIResponse, ODataQueryParams } from \"../types/CommonApiTypes\";\nimport type { MultipleMemberInvitationResponse } from \"../types/Invitations\";\nimport { BaseClient } from \"./BaseClient\";\n\n/** Client API to perform iTwin member invitation operations.\n */\nexport class MemberInvitationsClient\n extends BaseClient\n implements IMemberInvitationsClient {\n /** Create a new MemberInvitationsClient instance\n * @param url Optional base URL for the access control service. If not provided, defaults to base url.\n */\n public constructor(url?: string) {\n super(url);\n }\n\n /** Retrieves a list of iTwin member invitations.\n * @param accessToken The client access token string\n * @param iTwinId The id of the iTwin\n * @returns Array of member invitations\n */\n public async queryITwinMemberInvitations(\n accessToken: AccessToken,\n iTwinId: string,\n arg?: Pick<ODataQueryParams, \"top\" | \"skip\">\n ): Promise<BentleyAPIResponse<MultipleMemberInvitationResponse>> {\n const url = `${this._baseUrl}/${iTwinId}/members/invitations${\n arg ? `?${this.getQueryString(MemberInvitationsClient.paginationParamMapping, { top: arg.top, skip: arg.skip })}` : ''\n }`;\n\n return this.sendGenericAPIRequest(\n accessToken,\n \"GET\",\n url,\n undefined,\n );\n }\n\n /** Deletes a member invitations.\n * @param accessToken The client access token string\n * @param iTwinId The id of the iTwin\n * @param invitationId The id of the invitation id\n * @returns No Content\n */\n public async deleteITwinMemberInvitation(\n accessToken: AccessToken,\n iTwinId: string,\n invitationId: string\n ): Promise<BentleyAPIResponse<undefined>> {\n const url = `${this._baseUrl}/${iTwinId}/members/invitations/${invitationId}`;\n return this.sendGenericAPIRequest(accessToken, \"DELETE\", url);\n }\n}\n"]}