alfresco_api 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (522) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +7 -0
  3. data/README.md +351 -0
  4. data/Rakefile +8 -0
  5. data/alfresco_api.gemspec +45 -0
  6. data/docs/ActivitiesApi.md +74 -0
  7. data/docs/Activity.md +14 -0
  8. data/docs/ActivityEntry.md +8 -0
  9. data/docs/ActivityPaging.md +8 -0
  10. data/docs/ActivityPagingList.md +9 -0
  11. data/docs/Association.md +9 -0
  12. data/docs/AssociationBody.md +9 -0
  13. data/docs/AssociationEntry.md +8 -0
  14. data/docs/AssociationInfo.md +8 -0
  15. data/docs/AuditApi.md +495 -0
  16. data/docs/AuditApp.md +10 -0
  17. data/docs/AuditAppEntry.md +8 -0
  18. data/docs/AuditAppPaging.md +8 -0
  19. data/docs/AuditAppPagingList.md +9 -0
  20. data/docs/AuditBodyUpdate.md +8 -0
  21. data/docs/AuditEntry.md +12 -0
  22. data/docs/AuditEntryEntry.md +8 -0
  23. data/docs/AuditEntryPaging.md +8 -0
  24. data/docs/AuditEntryPagingList.md +9 -0
  25. data/docs/ChildAssociation.md +9 -0
  26. data/docs/ChildAssociationBody.md +9 -0
  27. data/docs/ChildAssociationEntry.md +8 -0
  28. data/docs/ChildAssociationInfo.md +9 -0
  29. data/docs/ClientBody.md +8 -0
  30. data/docs/Comment.md +16 -0
  31. data/docs/CommentBody.md +8 -0
  32. data/docs/CommentEntry.md +8 -0
  33. data/docs/CommentPaging.md +8 -0
  34. data/docs/CommentPagingList.md +9 -0
  35. data/docs/CommentsApi.md +251 -0
  36. data/docs/Company.md +15 -0
  37. data/docs/ContentInfo.md +11 -0
  38. data/docs/DeletedNode.md +27 -0
  39. data/docs/DeletedNodeEntry.md +8 -0
  40. data/docs/DeletedNodesPaging.md +8 -0
  41. data/docs/DeletedNodesPagingList.md +9 -0
  42. data/docs/Download.md +13 -0
  43. data/docs/DownloadBodyCreate.md +8 -0
  44. data/docs/DownloadEntry.md +8 -0
  45. data/docs/DownloadsApi.md +177 -0
  46. data/docs/Error.md +8 -0
  47. data/docs/ErrorError.md +13 -0
  48. data/docs/Favorite.md +10 -0
  49. data/docs/FavoriteBodyCreate.md +8 -0
  50. data/docs/FavoriteEntry.md +8 -0
  51. data/docs/FavoritePaging.md +8 -0
  52. data/docs/FavoritePagingList.md +9 -0
  53. data/docs/FavoriteSite.md +8 -0
  54. data/docs/FavoriteSiteBodyCreate.md +8 -0
  55. data/docs/FavoriteSiteEntry.md +8 -0
  56. data/docs/FavoritesApi.md +496 -0
  57. data/docs/Group.md +12 -0
  58. data/docs/GroupBodyCreate.md +10 -0
  59. data/docs/GroupBodyUpdate.md +8 -0
  60. data/docs/GroupEntry.md +8 -0
  61. data/docs/GroupMember.md +10 -0
  62. data/docs/GroupMemberEntry.md +8 -0
  63. data/docs/GroupMemberPaging.md +8 -0
  64. data/docs/GroupMemberPagingList.md +9 -0
  65. data/docs/GroupMembershipBodyCreate.md +9 -0
  66. data/docs/GroupPaging.md +8 -0
  67. data/docs/GroupPagingList.md +9 -0
  68. data/docs/GroupsApi.md +564 -0
  69. data/docs/NetworkQuota.md +10 -0
  70. data/docs/NetworksApi.md +189 -0
  71. data/docs/Node.md +25 -0
  72. data/docs/NodeAssociation.md +26 -0
  73. data/docs/NodeAssociationEntry.md +8 -0
  74. data/docs/NodeAssociationPaging.md +8 -0
  75. data/docs/NodeAssociationPagingList.md +10 -0
  76. data/docs/NodeBodyCopy.md +9 -0
  77. data/docs/NodeBodyCreate.md +15 -0
  78. data/docs/NodeBodyCreateAssociation.md +8 -0
  79. data/docs/NodeBodyLock.md +10 -0
  80. data/docs/NodeBodyMove.md +9 -0
  81. data/docs/NodeBodyUpdate.md +12 -0
  82. data/docs/NodeChildAssociation.md +26 -0
  83. data/docs/NodeChildAssociationEntry.md +8 -0
  84. data/docs/NodeChildAssociationPaging.md +8 -0
  85. data/docs/NodeChildAssociationPagingList.md +10 -0
  86. data/docs/NodeEntry.md +8 -0
  87. data/docs/NodePaging.md +8 -0
  88. data/docs/NodePagingList.md +10 -0
  89. data/docs/NodesApi.md +1206 -0
  90. data/docs/Pagination.md +12 -0
  91. data/docs/PasswordResetBody.md +10 -0
  92. data/docs/PathElement.md +11 -0
  93. data/docs/PathInfo.md +10 -0
  94. data/docs/PeopleApi.md +530 -0
  95. data/docs/PermissionElement.md +10 -0
  96. data/docs/PermissionsBodyUpdate.md +9 -0
  97. data/docs/PermissionsInfo.md +11 -0
  98. data/docs/Person.md +27 -0
  99. data/docs/PersonBodyCreate.md +26 -0
  100. data/docs/PersonBodyUpdate.md +26 -0
  101. data/docs/PersonEntry.md +8 -0
  102. data/docs/PersonNetwork.md +14 -0
  103. data/docs/PersonNetworkEntry.md +8 -0
  104. data/docs/PersonNetworkPaging.md +8 -0
  105. data/docs/PersonNetworkPagingList.md +9 -0
  106. data/docs/PersonPaging.md +8 -0
  107. data/docs/PersonPagingList.md +9 -0
  108. data/docs/Preference.md +9 -0
  109. data/docs/PreferenceEntry.md +8 -0
  110. data/docs/PreferencePaging.md +8 -0
  111. data/docs/PreferencePagingList.md +9 -0
  112. data/docs/PreferencesApi.md +131 -0
  113. data/docs/QueriesApi.md +206 -0
  114. data/docs/Rating.md +11 -0
  115. data/docs/RatingAggregate.md +9 -0
  116. data/docs/RatingBody.md +9 -0
  117. data/docs/RatingEntry.md +8 -0
  118. data/docs/RatingPaging.md +8 -0
  119. data/docs/RatingPagingList.md +9 -0
  120. data/docs/RatingsApi.md +248 -0
  121. data/docs/Rendition.md +10 -0
  122. data/docs/RenditionBodyCreate.md +8 -0
  123. data/docs/RenditionEntry.md +8 -0
  124. data/docs/RenditionPaging.md +8 -0
  125. data/docs/RenditionPagingList.md +9 -0
  126. data/docs/RenditionsApi.md +243 -0
  127. data/docs/RevertBody.md +9 -0
  128. data/docs/SharedLink.md +19 -0
  129. data/docs/SharedLinkBodyCreate.md +9 -0
  130. data/docs/SharedLinkBodyEmail.md +11 -0
  131. data/docs/SharedLinkEntry.md +8 -0
  132. data/docs/SharedLinkPaging.md +8 -0
  133. data/docs/SharedLinkPagingList.md +9 -0
  134. data/docs/SharedlinksApi.md +530 -0
  135. data/docs/Site.md +14 -0
  136. data/docs/SiteBodyCreate.md +11 -0
  137. data/docs/SiteBodyUpdate.md +10 -0
  138. data/docs/SiteContainer.md +9 -0
  139. data/docs/SiteContainerEntry.md +8 -0
  140. data/docs/SiteContainerPaging.md +8 -0
  141. data/docs/SiteContainerPagingList.md +9 -0
  142. data/docs/SiteEntry.md +8 -0
  143. data/docs/SiteMember.md +10 -0
  144. data/docs/SiteMemberEntry.md +8 -0
  145. data/docs/SiteMemberPaging.md +8 -0
  146. data/docs/SiteMemberPagingList.md +9 -0
  147. data/docs/SiteMembershipBodyCreate.md +9 -0
  148. data/docs/SiteMembershipBodyUpdate.md +8 -0
  149. data/docs/SiteMembershipRequest.md +11 -0
  150. data/docs/SiteMembershipRequestBodyCreate.md +10 -0
  151. data/docs/SiteMembershipRequestBodyUpdate.md +8 -0
  152. data/docs/SiteMembershipRequestEntry.md +8 -0
  153. data/docs/SiteMembershipRequestPaging.md +8 -0
  154. data/docs/SiteMembershipRequestPagingList.md +9 -0
  155. data/docs/SitePaging.md +8 -0
  156. data/docs/SitePagingList.md +9 -0
  157. data/docs/SiteRole.md +11 -0
  158. data/docs/SiteRoleEntry.md +8 -0
  159. data/docs/SiteRolePaging.md +8 -0
  160. data/docs/SiteRolePagingList.md +9 -0
  161. data/docs/SitesApi.md +1225 -0
  162. data/docs/Tag.md +9 -0
  163. data/docs/TagBody.md +8 -0
  164. data/docs/TagEntry.md +8 -0
  165. data/docs/TagPaging.md +8 -0
  166. data/docs/TagPagingList.md +9 -0
  167. data/docs/TagsApi.md +365 -0
  168. data/docs/TrashcanApi.md +474 -0
  169. data/docs/UserInfo.md +9 -0
  170. data/docs/Version.md +18 -0
  171. data/docs/VersionEntry.md +8 -0
  172. data/docs/VersionPaging.md +8 -0
  173. data/docs/VersionPagingList.md +9 -0
  174. data/docs/VersionsApi.md +311 -0
  175. data/git_push.sh +55 -0
  176. data/lib/alfresco_api.rb +208 -0
  177. data/lib/alfresco_api/api/activities_api.rb +101 -0
  178. data/lib/alfresco_api/api/audit_api.rb +558 -0
  179. data/lib/alfresco_api/api/comments_api.rb +289 -0
  180. data/lib/alfresco_api/api/downloads_api.rb +193 -0
  181. data/lib/alfresco_api/api/favorites_api.rb +555 -0
  182. data/lib/alfresco_api/api/groups_api.rb +627 -0
  183. data/lib/alfresco_api/api/networks_api.rb +217 -0
  184. data/lib/alfresco_api/api/nodes_api.rb +1314 -0
  185. data/lib/alfresco_api/api/people_api.rb +572 -0
  186. data/lib/alfresco_api/api/preferences_api.rb +159 -0
  187. data/lib/alfresco_api/api/queries_api.rb +260 -0
  188. data/lib/alfresco_api/api/ratings_api.rb +283 -0
  189. data/lib/alfresco_api/api/renditions_api.rb +271 -0
  190. data/lib/alfresco_api/api/sharedlinks_api.rb +570 -0
  191. data/lib/alfresco_api/api/sites_api.rb +1342 -0
  192. data/lib/alfresco_api/api/tags_api.rb +407 -0
  193. data/lib/alfresco_api/api/trashcan_api.rb +507 -0
  194. data/lib/alfresco_api/api/versions_api.rb +355 -0
  195. data/lib/alfresco_api/api_client.rb +389 -0
  196. data/lib/alfresco_api/api_error.rb +38 -0
  197. data/lib/alfresco_api/configuration.rb +209 -0
  198. data/lib/alfresco_api/models/activity.rb +271 -0
  199. data/lib/alfresco_api/models/activity_entry.rb +193 -0
  200. data/lib/alfresco_api/models/activity_paging.rb +188 -0
  201. data/lib/alfresco_api/models/activity_paging_list.rb +209 -0
  202. data/lib/alfresco_api/models/association.rb +207 -0
  203. data/lib/alfresco_api/models/association_body.rb +207 -0
  204. data/lib/alfresco_api/models/association_entry.rb +193 -0
  205. data/lib/alfresco_api/models/association_info.rb +193 -0
  206. data/lib/alfresco_api/models/audit_app.rb +213 -0
  207. data/lib/alfresco_api/models/audit_app_entry.rb +188 -0
  208. data/lib/alfresco_api/models/audit_app_paging.rb +188 -0
  209. data/lib/alfresco_api/models/audit_app_paging_list.rb +199 -0
  210. data/lib/alfresco_api/models/audit_body_update.rb +188 -0
  211. data/lib/alfresco_api/models/audit_entry.rb +246 -0
  212. data/lib/alfresco_api/models/audit_entry_entry.rb +188 -0
  213. data/lib/alfresco_api/models/audit_entry_paging.rb +188 -0
  214. data/lib/alfresco_api/models/audit_entry_paging_list.rb +199 -0
  215. data/lib/alfresco_api/models/child_association.rb +207 -0
  216. data/lib/alfresco_api/models/child_association_body.rb +207 -0
  217. data/lib/alfresco_api/models/child_association_entry.rb +193 -0
  218. data/lib/alfresco_api/models/child_association_info.rb +207 -0
  219. data/lib/alfresco_api/models/client_body.rb +194 -0
  220. data/lib/alfresco_api/models/comment.rb +305 -0
  221. data/lib/alfresco_api/models/comment_body.rb +193 -0
  222. data/lib/alfresco_api/models/comment_entry.rb +193 -0
  223. data/lib/alfresco_api/models/comment_paging.rb +188 -0
  224. data/lib/alfresco_api/models/comment_paging_list.rb +209 -0
  225. data/lib/alfresco_api/models/company.rb +251 -0
  226. data/lib/alfresco_api/models/content_info.rb +230 -0
  227. data/lib/alfresco_api/models/deleted_node.rb +440 -0
  228. data/lib/alfresco_api/models/deleted_node_entry.rb +188 -0
  229. data/lib/alfresco_api/models/deleted_nodes_paging.rb +188 -0
  230. data/lib/alfresco_api/models/deleted_nodes_paging_list.rb +199 -0
  231. data/lib/alfresco_api/models/download.rb +274 -0
  232. data/lib/alfresco_api/models/download_body_create.rb +195 -0
  233. data/lib/alfresco_api/models/download_entry.rb +193 -0
  234. data/lib/alfresco_api/models/error.rb +188 -0
  235. data/lib/alfresco_api/models/error_error.rb +253 -0
  236. data/lib/alfresco_api/models/favorite.rb +218 -0
  237. data/lib/alfresco_api/models/favorite_body_create.rb +193 -0
  238. data/lib/alfresco_api/models/favorite_entry.rb +193 -0
  239. data/lib/alfresco_api/models/favorite_paging.rb +188 -0
  240. data/lib/alfresco_api/models/favorite_paging_list.rb +209 -0
  241. data/lib/alfresco_api/models/favorite_site.rb +193 -0
  242. data/lib/alfresco_api/models/favorite_site_body_create.rb +193 -0
  243. data/lib/alfresco_api/models/favorite_site_entry.rb +193 -0
  244. data/lib/alfresco_api/models/group.rb +245 -0
  245. data/lib/alfresco_api/models/group_body_create.rb +218 -0
  246. data/lib/alfresco_api/models/group_body_update.rb +193 -0
  247. data/lib/alfresco_api/models/group_entry.rb +193 -0
  248. data/lib/alfresco_api/models/group_member.rb +254 -0
  249. data/lib/alfresco_api/models/group_member_entry.rb +193 -0
  250. data/lib/alfresco_api/models/group_member_paging.rb +188 -0
  251. data/lib/alfresco_api/models/group_member_paging_list.rb +199 -0
  252. data/lib/alfresco_api/models/group_membership_body_create.rb +240 -0
  253. data/lib/alfresco_api/models/group_paging.rb +188 -0
  254. data/lib/alfresco_api/models/group_paging_list.rb +199 -0
  255. data/lib/alfresco_api/models/network_quota.rb +221 -0
  256. data/lib/alfresco_api/models/node.rb +412 -0
  257. data/lib/alfresco_api/models/node_association.rb +421 -0
  258. data/lib/alfresco_api/models/node_association_entry.rb +193 -0
  259. data/lib/alfresco_api/models/node_association_paging.rb +188 -0
  260. data/lib/alfresco_api/models/node_association_paging_list.rb +208 -0
  261. data/lib/alfresco_api/models/node_body_copy.rb +219 -0
  262. data/lib/alfresco_api/models/node_body_create.rb +289 -0
  263. data/lib/alfresco_api/models/node_body_create_association.rb +188 -0
  264. data/lib/alfresco_api/models/node_body_lock.rb +271 -0
  265. data/lib/alfresco_api/models/node_body_move.rb +219 -0
  266. data/lib/alfresco_api/models/node_body_update.rb +245 -0
  267. data/lib/alfresco_api/models/node_child_association.rb +421 -0
  268. data/lib/alfresco_api/models/node_child_association_entry.rb +193 -0
  269. data/lib/alfresco_api/models/node_child_association_paging.rb +188 -0
  270. data/lib/alfresco_api/models/node_child_association_paging_list.rb +208 -0
  271. data/lib/alfresco_api/models/node_entry.rb +193 -0
  272. data/lib/alfresco_api/models/node_paging.rb +188 -0
  273. data/lib/alfresco_api/models/node_paging_list.rb +208 -0
  274. data/lib/alfresco_api/models/pagination.rb +249 -0
  275. data/lib/alfresco_api/models/password_reset_body.rb +224 -0
  276. data/lib/alfresco_api/models/path_element.rb +217 -0
  277. data/lib/alfresco_api/models/path_info.rb +208 -0
  278. data/lib/alfresco_api/models/permission_element.rb +241 -0
  279. data/lib/alfresco_api/models/permissions_body_update.rb +199 -0
  280. data/lib/alfresco_api/models/permissions_info.rb +221 -0
  281. data/lib/alfresco_api/models/person.rb +387 -0
  282. data/lib/alfresco_api/models/person_body_create.rb +378 -0
  283. data/lib/alfresco_api/models/person_body_update.rb +354 -0
  284. data/lib/alfresco_api/models/person_entry.rb +193 -0
  285. data/lib/alfresco_api/models/person_network.rb +289 -0
  286. data/lib/alfresco_api/models/person_network_entry.rb +193 -0
  287. data/lib/alfresco_api/models/person_network_paging.rb +188 -0
  288. data/lib/alfresco_api/models/person_network_paging_list.rb +209 -0
  289. data/lib/alfresco_api/models/person_paging.rb +188 -0
  290. data/lib/alfresco_api/models/person_paging_list.rb +199 -0
  291. data/lib/alfresco_api/models/preference.rb +204 -0
  292. data/lib/alfresco_api/models/preference_entry.rb +193 -0
  293. data/lib/alfresco_api/models/preference_paging.rb +188 -0
  294. data/lib/alfresco_api/models/preference_paging_list.rb +209 -0
  295. data/lib/alfresco_api/models/rating.rb +221 -0
  296. data/lib/alfresco_api/models/rating_aggregate.rb +202 -0
  297. data/lib/alfresco_api/models/rating_body.rb +244 -0
  298. data/lib/alfresco_api/models/rating_entry.rb +193 -0
  299. data/lib/alfresco_api/models/rating_paging.rb +188 -0
  300. data/lib/alfresco_api/models/rating_paging_list.rb +209 -0
  301. data/lib/alfresco_api/models/rendition.rb +239 -0
  302. data/lib/alfresco_api/models/rendition_body_create.rb +193 -0
  303. data/lib/alfresco_api/models/rendition_entry.rb +193 -0
  304. data/lib/alfresco_api/models/rendition_paging.rb +188 -0
  305. data/lib/alfresco_api/models/rendition_paging_list.rb +199 -0
  306. data/lib/alfresco_api/models/revert_body.rb +197 -0
  307. data/lib/alfresco_api/models/shared_link.rb +310 -0
  308. data/lib/alfresco_api/models/shared_link_body_create.rb +202 -0
  309. data/lib/alfresco_api/models/shared_link_body_email.rb +217 -0
  310. data/lib/alfresco_api/models/shared_link_entry.rb +193 -0
  311. data/lib/alfresco_api/models/shared_link_paging.rb +188 -0
  312. data/lib/alfresco_api/models/shared_link_paging_list.rb +209 -0
  313. data/lib/alfresco_api/models/site.rb +307 -0
  314. data/lib/alfresco_api/models/site_body_create.rb +260 -0
  315. data/lib/alfresco_api/models/site_body_update.rb +239 -0
  316. data/lib/alfresco_api/models/site_container.rb +207 -0
  317. data/lib/alfresco_api/models/site_container_entry.rb +193 -0
  318. data/lib/alfresco_api/models/site_container_paging.rb +188 -0
  319. data/lib/alfresco_api/models/site_container_paging_list.rb +209 -0
  320. data/lib/alfresco_api/models/site_entry.rb +193 -0
  321. data/lib/alfresco_api/models/site_member.rb +254 -0
  322. data/lib/alfresco_api/models/site_member_entry.rb +193 -0
  323. data/lib/alfresco_api/models/site_member_paging.rb +188 -0
  324. data/lib/alfresco_api/models/site_member_paging_list.rb +209 -0
  325. data/lib/alfresco_api/models/site_membership_body_create.rb +240 -0
  326. data/lib/alfresco_api/models/site_membership_body_update.rb +226 -0
  327. data/lib/alfresco_api/models/site_membership_request.rb +230 -0
  328. data/lib/alfresco_api/models/site_membership_request_body_create.rb +211 -0
  329. data/lib/alfresco_api/models/site_membership_request_body_update.rb +188 -0
  330. data/lib/alfresco_api/models/site_membership_request_entry.rb +193 -0
  331. data/lib/alfresco_api/models/site_membership_request_paging.rb +188 -0
  332. data/lib/alfresco_api/models/site_membership_request_paging_list.rb +209 -0
  333. data/lib/alfresco_api/models/site_paging.rb +188 -0
  334. data/lib/alfresco_api/models/site_paging_list.rb +209 -0
  335. data/lib/alfresco_api/models/site_role.rb +268 -0
  336. data/lib/alfresco_api/models/site_role_entry.rb +193 -0
  337. data/lib/alfresco_api/models/site_role_paging.rb +188 -0
  338. data/lib/alfresco_api/models/site_role_paging_list.rb +209 -0
  339. data/lib/alfresco_api/models/tag.rb +207 -0
  340. data/lib/alfresco_api/models/tag_body.rb +193 -0
  341. data/lib/alfresco_api/models/tag_entry.rb +193 -0
  342. data/lib/alfresco_api/models/tag_paging.rb +188 -0
  343. data/lib/alfresco_api/models/tag_paging_list.rb +209 -0
  344. data/lib/alfresco_api/models/user_info.rb +207 -0
  345. data/lib/alfresco_api/models/version.rb +337 -0
  346. data/lib/alfresco_api/models/version_entry.rb +188 -0
  347. data/lib/alfresco_api/models/version_paging.rb +188 -0
  348. data/lib/alfresco_api/models/version_paging_list.rb +199 -0
  349. data/lib/alfresco_api/version.rb +15 -0
  350. data/spec/api/activities_api_spec.rb +52 -0
  351. data/spec/api/audit_api_spec.rb +152 -0
  352. data/spec/api/comments_api_spec.rb +92 -0
  353. data/spec/api/downloads_api_spec.rb +73 -0
  354. data/spec/api/favorites_api_spec.rb +151 -0
  355. data/spec/api/groups_api_spec.rb +170 -0
  356. data/spec/api/networks_api_spec.rb +77 -0
  357. data/spec/api/nodes_api_spec.rb +327 -0
  358. data/spec/api/people_api_spec.rb +157 -0
  359. data/spec/api/preferences_api_spec.rb +64 -0
  360. data/spec/api/queries_api_spec.rb +86 -0
  361. data/spec/api/ratings_api_spec.rb +91 -0
  362. data/spec/api/renditions_api_spec.rb +90 -0
  363. data/spec/api/sharedlinks_api_spec.rb +157 -0
  364. data/spec/api/sites_api_spec.rb +323 -0
  365. data/spec/api/tags_api_spec.rb +118 -0
  366. data/spec/api/trashcan_api_spec.rb +143 -0
  367. data/spec/api/versions_api_spec.rb +107 -0
  368. data/spec/api_client_spec.rb +226 -0
  369. data/spec/configuration_spec.rb +42 -0
  370. data/spec/models/activity_entry_spec.rb +42 -0
  371. data/spec/models/activity_paging_list_spec.rb +48 -0
  372. data/spec/models/activity_paging_spec.rb +42 -0
  373. data/spec/models/activity_spec.rb +78 -0
  374. data/spec/models/association_body_spec.rb +48 -0
  375. data/spec/models/association_entry_spec.rb +42 -0
  376. data/spec/models/association_info_spec.rb +42 -0
  377. data/spec/models/association_spec.rb +48 -0
  378. data/spec/models/audit_app_entry_spec.rb +42 -0
  379. data/spec/models/audit_app_paging_list_spec.rb +48 -0
  380. data/spec/models/audit_app_paging_spec.rb +42 -0
  381. data/spec/models/audit_app_spec.rb +54 -0
  382. data/spec/models/audit_body_update_spec.rb +42 -0
  383. data/spec/models/audit_entry_entry_spec.rb +42 -0
  384. data/spec/models/audit_entry_paging_list_spec.rb +48 -0
  385. data/spec/models/audit_entry_paging_spec.rb +42 -0
  386. data/spec/models/audit_entry_spec.rb +66 -0
  387. data/spec/models/child_association_body_spec.rb +48 -0
  388. data/spec/models/child_association_entry_spec.rb +42 -0
  389. data/spec/models/child_association_info_spec.rb +48 -0
  390. data/spec/models/child_association_spec.rb +48 -0
  391. data/spec/models/client_body_spec.rb +42 -0
  392. data/spec/models/comment_body_spec.rb +42 -0
  393. data/spec/models/comment_entry_spec.rb +42 -0
  394. data/spec/models/comment_paging_list_spec.rb +48 -0
  395. data/spec/models/comment_paging_spec.rb +42 -0
  396. data/spec/models/comment_spec.rb +90 -0
  397. data/spec/models/company_spec.rb +84 -0
  398. data/spec/models/content_info_spec.rb +60 -0
  399. data/spec/models/deleted_node_entry_spec.rb +42 -0
  400. data/spec/models/deleted_node_spec.rb +156 -0
  401. data/spec/models/deleted_nodes_paging_list_spec.rb +48 -0
  402. data/spec/models/deleted_nodes_paging_spec.rb +42 -0
  403. data/spec/models/download_body_create_spec.rb +42 -0
  404. data/spec/models/download_entry_spec.rb +42 -0
  405. data/spec/models/download_spec.rb +76 -0
  406. data/spec/models/error_error_spec.rb +72 -0
  407. data/spec/models/error_spec.rb +42 -0
  408. data/spec/models/favorite_body_create_spec.rb +42 -0
  409. data/spec/models/favorite_entry_spec.rb +42 -0
  410. data/spec/models/favorite_paging_list_spec.rb +48 -0
  411. data/spec/models/favorite_paging_spec.rb +42 -0
  412. data/spec/models/favorite_site_body_create_spec.rb +42 -0
  413. data/spec/models/favorite_site_entry_spec.rb +42 -0
  414. data/spec/models/favorite_site_spec.rb +42 -0
  415. data/spec/models/favorite_spec.rb +54 -0
  416. data/spec/models/group_body_create_spec.rb +54 -0
  417. data/spec/models/group_body_update_spec.rb +42 -0
  418. data/spec/models/group_entry_spec.rb +42 -0
  419. data/spec/models/group_member_entry_spec.rb +42 -0
  420. data/spec/models/group_member_paging_list_spec.rb +48 -0
  421. data/spec/models/group_member_paging_spec.rb +42 -0
  422. data/spec/models/group_member_spec.rb +58 -0
  423. data/spec/models/group_membership_body_create_spec.rb +52 -0
  424. data/spec/models/group_paging_list_spec.rb +48 -0
  425. data/spec/models/group_paging_spec.rb +42 -0
  426. data/spec/models/group_spec.rb +66 -0
  427. data/spec/models/network_quota_spec.rb +54 -0
  428. data/spec/models/node_association_entry_spec.rb +42 -0
  429. data/spec/models/node_association_paging_list_spec.rb +54 -0
  430. data/spec/models/node_association_paging_spec.rb +42 -0
  431. data/spec/models/node_association_spec.rb +150 -0
  432. data/spec/models/node_body_copy_spec.rb +48 -0
  433. data/spec/models/node_body_create_association_spec.rb +42 -0
  434. data/spec/models/node_body_create_spec.rb +84 -0
  435. data/spec/models/node_body_lock_spec.rb +62 -0
  436. data/spec/models/node_body_move_spec.rb +48 -0
  437. data/spec/models/node_body_update_spec.rb +66 -0
  438. data/spec/models/node_child_association_entry_spec.rb +42 -0
  439. data/spec/models/node_child_association_paging_list_spec.rb +54 -0
  440. data/spec/models/node_child_association_paging_spec.rb +42 -0
  441. data/spec/models/node_child_association_spec.rb +150 -0
  442. data/spec/models/node_entry_spec.rb +42 -0
  443. data/spec/models/node_paging_list_spec.rb +54 -0
  444. data/spec/models/node_paging_spec.rb +42 -0
  445. data/spec/models/node_spec.rb +144 -0
  446. data/spec/models/pagination_spec.rb +66 -0
  447. data/spec/models/password_reset_body_spec.rb +54 -0
  448. data/spec/models/path_element_spec.rb +60 -0
  449. data/spec/models/path_info_spec.rb +54 -0
  450. data/spec/models/permission_element_spec.rb +58 -0
  451. data/spec/models/permissions_body_update_spec.rb +48 -0
  452. data/spec/models/permissions_info_spec.rb +60 -0
  453. data/spec/models/person_body_create_spec.rb +150 -0
  454. data/spec/models/person_body_update_spec.rb +150 -0
  455. data/spec/models/person_entry_spec.rb +42 -0
  456. data/spec/models/person_network_entry_spec.rb +42 -0
  457. data/spec/models/person_network_paging_list_spec.rb +48 -0
  458. data/spec/models/person_network_paging_spec.rb +42 -0
  459. data/spec/models/person_network_spec.rb +82 -0
  460. data/spec/models/person_paging_list_spec.rb +48 -0
  461. data/spec/models/person_paging_spec.rb +42 -0
  462. data/spec/models/person_spec.rb +156 -0
  463. data/spec/models/preference_entry_spec.rb +42 -0
  464. data/spec/models/preference_paging_list_spec.rb +48 -0
  465. data/spec/models/preference_paging_spec.rb +42 -0
  466. data/spec/models/preference_spec.rb +48 -0
  467. data/spec/models/rating_aggregate_spec.rb +48 -0
  468. data/spec/models/rating_body_spec.rb +52 -0
  469. data/spec/models/rating_entry_spec.rb +42 -0
  470. data/spec/models/rating_paging_list_spec.rb +48 -0
  471. data/spec/models/rating_paging_spec.rb +42 -0
  472. data/spec/models/rating_spec.rb +60 -0
  473. data/spec/models/rendition_body_create_spec.rb +42 -0
  474. data/spec/models/rendition_entry_spec.rb +42 -0
  475. data/spec/models/rendition_paging_list_spec.rb +48 -0
  476. data/spec/models/rendition_paging_spec.rb +42 -0
  477. data/spec/models/rendition_spec.rb +58 -0
  478. data/spec/models/revert_body_spec.rb +48 -0
  479. data/spec/models/shared_link_body_create_spec.rb +48 -0
  480. data/spec/models/shared_link_body_email_spec.rb +60 -0
  481. data/spec/models/shared_link_entry_spec.rb +42 -0
  482. data/spec/models/shared_link_paging_list_spec.rb +48 -0
  483. data/spec/models/shared_link_paging_spec.rb +42 -0
  484. data/spec/models/shared_link_spec.rb +108 -0
  485. data/spec/models/site_body_create_spec.rb +64 -0
  486. data/spec/models/site_body_update_spec.rb +58 -0
  487. data/spec/models/site_container_entry_spec.rb +42 -0
  488. data/spec/models/site_container_paging_list_spec.rb +48 -0
  489. data/spec/models/site_container_paging_spec.rb +42 -0
  490. data/spec/models/site_container_spec.rb +48 -0
  491. data/spec/models/site_entry_spec.rb +42 -0
  492. data/spec/models/site_member_entry_spec.rb +42 -0
  493. data/spec/models/site_member_paging_list_spec.rb +48 -0
  494. data/spec/models/site_member_paging_spec.rb +42 -0
  495. data/spec/models/site_member_spec.rb +58 -0
  496. data/spec/models/site_membership_body_create_spec.rb +52 -0
  497. data/spec/models/site_membership_body_update_spec.rb +46 -0
  498. data/spec/models/site_membership_request_body_create_spec.rb +54 -0
  499. data/spec/models/site_membership_request_body_update_spec.rb +42 -0
  500. data/spec/models/site_membership_request_entry_spec.rb +42 -0
  501. data/spec/models/site_membership_request_paging_list_spec.rb +48 -0
  502. data/spec/models/site_membership_request_paging_spec.rb +42 -0
  503. data/spec/models/site_membership_request_spec.rb +60 -0
  504. data/spec/models/site_paging_list_spec.rb +48 -0
  505. data/spec/models/site_paging_spec.rb +42 -0
  506. data/spec/models/site_role_entry_spec.rb +42 -0
  507. data/spec/models/site_role_paging_list_spec.rb +48 -0
  508. data/spec/models/site_role_paging_spec.rb +42 -0
  509. data/spec/models/site_role_spec.rb +64 -0
  510. data/spec/models/site_spec.rb +86 -0
  511. data/spec/models/tag_body_spec.rb +42 -0
  512. data/spec/models/tag_entry_spec.rb +42 -0
  513. data/spec/models/tag_paging_list_spec.rb +48 -0
  514. data/spec/models/tag_paging_spec.rb +42 -0
  515. data/spec/models/tag_spec.rb +48 -0
  516. data/spec/models/user_info_spec.rb +48 -0
  517. data/spec/models/version_entry_spec.rb +42 -0
  518. data/spec/models/version_paging_list_spec.rb +48 -0
  519. data/spec/models/version_paging_spec.rb +42 -0
  520. data/spec/models/version_spec.rb +102 -0
  521. data/spec/spec_helper.rb +111 -0
  522. metadata +918 -0
@@ -0,0 +1,1342 @@
1
+ =begin
2
+ #Alfresco Content Services REST API
3
+
4
+ #**Core API** Provides access to the core features of Alfresco Content Services.
5
+
6
+ OpenAPI spec version: 1
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.2.3
10
+
11
+ =end
12
+
13
+ require "uri"
14
+
15
+ module AlfrescoAPI
16
+ class SitesApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+
23
+ # Create a site
24
+ # **Note:** this endpoint is available in Alfresco 5.2 and newer versions. Creates a default site with the given details. Unless explicitly specified, the site id will be generated from the site title. The site id must be unique and only contain alphanumeric and/or dash characters. Note: the id of a site cannot be updated once the site has been created. For example, to create a public site called \"Marketing\" the following body could be used: ```JSON { \"title\": \"Marketing\", \"visibility\": \"PUBLIC\" } ``` The creation of the (surf) configuration files required by Share can be skipped via the **skipConfiguration** query parameter. **Note:** if skipped then such a site will **not** work within Share. The addition of the site to the user's site favorites can be skipped via the **skipAddToFavorites** query parameter. The creator will be added as a member with Site Manager role. When you create a site, a container called **documentLibrary** is created for you in the new site. This container is the root folder for content stored in the site.
25
+ # @param site_body_create The site details
26
+ # @param [Hash] opts the optional parameters
27
+ # @option opts [BOOLEAN] :skip_configuration Flag to indicate whether the Share-specific (surf) configuration files for the site should not be created. (default to false)
28
+ # @option opts [BOOLEAN] :skip_add_to_favorites Flag to indicate whether the site should not be added to the user's site favorites. (default to false)
29
+ # @option opts [Array<String>] :fields A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter.
30
+ # @return [SiteEntry]
31
+ def create_site(site_body_create, opts = {})
32
+ data, _status_code, _headers = create_site_with_http_info(site_body_create, opts)
33
+ return data
34
+ end
35
+
36
+ # Create a site
37
+ # **Note:** this endpoint is available in Alfresco 5.2 and newer versions. Creates a default site with the given details. Unless explicitly specified, the site id will be generated from the site title. The site id must be unique and only contain alphanumeric and/or dash characters. Note: the id of a site cannot be updated once the site has been created. For example, to create a public site called \&quot;Marketing\&quot; the following body could be used: &#x60;&#x60;&#x60;JSON { \&quot;title\&quot;: \&quot;Marketing\&quot;, \&quot;visibility\&quot;: \&quot;PUBLIC\&quot; } &#x60;&#x60;&#x60; The creation of the (surf) configuration files required by Share can be skipped via the **skipConfiguration** query parameter. **Note:** if skipped then such a site will **not** work within Share. The addition of the site to the user&#39;s site favorites can be skipped via the **skipAddToFavorites** query parameter. The creator will be added as a member with Site Manager role. When you create a site, a container called **documentLibrary** is created for you in the new site. This container is the root folder for content stored in the site.
38
+ # @param site_body_create The site details
39
+ # @param [Hash] opts the optional parameters
40
+ # @option opts [BOOLEAN] :skip_configuration Flag to indicate whether the Share-specific (surf) configuration files for the site should not be created.
41
+ # @option opts [BOOLEAN] :skip_add_to_favorites Flag to indicate whether the site should not be added to the user&#39;s site favorites.
42
+ # @option opts [Array<String>] :fields A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter.
43
+ # @return [Array<(SiteEntry, Fixnum, Hash)>] SiteEntry data, response status code and response headers
44
+ def create_site_with_http_info(site_body_create, opts = {})
45
+ if @api_client.config.debugging
46
+ @api_client.config.logger.debug "Calling API: SitesApi.create_site ..."
47
+ end
48
+ # verify the required parameter 'site_body_create' is set
49
+ if @api_client.config.client_side_validation && site_body_create.nil?
50
+ fail ArgumentError, "Missing the required parameter 'site_body_create' when calling SitesApi.create_site"
51
+ end
52
+ # resource path
53
+ local_var_path = "/sites"
54
+
55
+ # query parameters
56
+ query_params = {}
57
+ query_params[:'skipConfiguration'] = opts[:'skip_configuration'] if !opts[:'skip_configuration'].nil?
58
+ query_params[:'skipAddToFavorites'] = opts[:'skip_add_to_favorites'] if !opts[:'skip_add_to_favorites'].nil?
59
+ query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
60
+
61
+ # header parameters
62
+ header_params = {}
63
+ # HTTP header 'Accept' (if needed)
64
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
65
+ # HTTP header 'Content-Type'
66
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
67
+
68
+ # form parameters
69
+ form_params = {}
70
+
71
+ # http body (model)
72
+ post_body = @api_client.object_to_http_body(site_body_create)
73
+ auth_names = ['basicAuth']
74
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
75
+ :header_params => header_params,
76
+ :query_params => query_params,
77
+ :form_params => form_params,
78
+ :body => post_body,
79
+ :auth_names => auth_names,
80
+ :return_type => 'SiteEntry')
81
+ if @api_client.config.debugging
82
+ @api_client.config.logger.debug "API called: SitesApi#create_site\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
83
+ end
84
+ return data, status_code, headers
85
+ end
86
+
87
+ # Create a site membership
88
+ # Creates a site membership for person **personId** on site **siteId**. You can set the **role** to one of four types: * SiteConsumer * SiteCollaborator * SiteContributor * SiteManager **Note:** You can create more than one site membership by specifying a list of people in the JSON body like this: ```JSON [ { \"role\": \"SiteConsumer\", \"id\": \"joe\" }, { \"role\": \"SiteConsumer\", \"id\": \"fred\" } ] ``` If you specify a list as input, then a paginated list rather than an entry is returned in the response body. For example: ```JSON { \"list\": { \"pagination\": { \"count\": 2, \"hasMoreItems\": false, \"totalItems\": 2, \"skipCount\": 0, \"maxItems\": 100 }, \"entries\": [ { \"entry\": { ... } }, { \"entry\": { ... } } ] } } ```
89
+ # @param site_id The identifier of a site.
90
+ # @param site_membership_body_create The person to add and their role
91
+ # @param [Hash] opts the optional parameters
92
+ # @option opts [Array<String>] :fields A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter.
93
+ # @return [SiteMemberEntry]
94
+ def create_site_membership(site_id, site_membership_body_create, opts = {})
95
+ data, _status_code, _headers = create_site_membership_with_http_info(site_id, site_membership_body_create, opts)
96
+ return data
97
+ end
98
+
99
+ # Create a site membership
100
+ # Creates a site membership for person **personId** on site **siteId**. You can set the **role** to one of four types: * SiteConsumer * SiteCollaborator * SiteContributor * SiteManager **Note:** You can create more than one site membership by specifying a list of people in the JSON body like this: &#x60;&#x60;&#x60;JSON [ { \&quot;role\&quot;: \&quot;SiteConsumer\&quot;, \&quot;id\&quot;: \&quot;joe\&quot; }, { \&quot;role\&quot;: \&quot;SiteConsumer\&quot;, \&quot;id\&quot;: \&quot;fred\&quot; } ] &#x60;&#x60;&#x60; If you specify a list as input, then a paginated list rather than an entry is returned in the response body. For example: &#x60;&#x60;&#x60;JSON { \&quot;list\&quot;: { \&quot;pagination\&quot;: { \&quot;count\&quot;: 2, \&quot;hasMoreItems\&quot;: false, \&quot;totalItems\&quot;: 2, \&quot;skipCount\&quot;: 0, \&quot;maxItems\&quot;: 100 }, \&quot;entries\&quot;: [ { \&quot;entry\&quot;: { ... } }, { \&quot;entry\&quot;: { ... } } ] } } &#x60;&#x60;&#x60;
101
+ # @param site_id The identifier of a site.
102
+ # @param site_membership_body_create The person to add and their role
103
+ # @param [Hash] opts the optional parameters
104
+ # @option opts [Array<String>] :fields A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter.
105
+ # @return [Array<(SiteMemberEntry, Fixnum, Hash)>] SiteMemberEntry data, response status code and response headers
106
+ def create_site_membership_with_http_info(site_id, site_membership_body_create, opts = {})
107
+ if @api_client.config.debugging
108
+ @api_client.config.logger.debug "Calling API: SitesApi.create_site_membership ..."
109
+ end
110
+ # verify the required parameter 'site_id' is set
111
+ if @api_client.config.client_side_validation && site_id.nil?
112
+ fail ArgumentError, "Missing the required parameter 'site_id' when calling SitesApi.create_site_membership"
113
+ end
114
+ # verify the required parameter 'site_membership_body_create' is set
115
+ if @api_client.config.client_side_validation && site_membership_body_create.nil?
116
+ fail ArgumentError, "Missing the required parameter 'site_membership_body_create' when calling SitesApi.create_site_membership"
117
+ end
118
+ # resource path
119
+ local_var_path = "/sites/{siteId}/members".sub('{' + 'siteId' + '}', site_id.to_s)
120
+
121
+ # query parameters
122
+ query_params = {}
123
+ query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
124
+
125
+ # header parameters
126
+ header_params = {}
127
+ # HTTP header 'Accept' (if needed)
128
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
129
+ # HTTP header 'Content-Type'
130
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
131
+
132
+ # form parameters
133
+ form_params = {}
134
+
135
+ # http body (model)
136
+ post_body = @api_client.object_to_http_body(site_membership_body_create)
137
+ auth_names = ['basicAuth']
138
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
139
+ :header_params => header_params,
140
+ :query_params => query_params,
141
+ :form_params => form_params,
142
+ :body => post_body,
143
+ :auth_names => auth_names,
144
+ :return_type => 'SiteMemberEntry')
145
+ if @api_client.config.debugging
146
+ @api_client.config.logger.debug "API called: SitesApi#create_site_membership\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
147
+ end
148
+ return data, status_code, headers
149
+ end
150
+
151
+ # Create a site membership request
152
+ # Create a site membership request for yourself on the site with the identifier of **id**, specified in the JSON body. The result of the request differs depending on the type of site. * For a **public** site, you join the site immediately as a SiteConsumer. * For a **moderated** site, your request is added to the site membership request list. The request waits for approval from the Site Manager. * You cannot request membership of a **private** site. Members are invited by the site administrator. You can use the `-me-` string in place of `<personId>` to specify the currently authenticated user. **Note:** You can create site membership requests for more than one site by specifying a list of sites in the JSON body like this: ```JSON [ { \"message\": \"Please can you add me\", \"id\": \"test-site-1\", \"title\": \"Request for test site 1\", }, { \"message\": \"Please can you add me\", \"id\": \"test-site-2\", \"title\": \"Request for test site 2\", } ] ``` If you specify a list as input, then a paginated list rather than an entry is returned in the response body. For example: ```JSON { \"list\": { \"pagination\": { \"count\": 2, \"hasMoreItems\": false, \"totalItems\": 2, \"skipCount\": 0, \"maxItems\": 100 }, \"entries\": [ { \"entry\": { ... } }, { \"entry\": { ... } } ] } } ```
153
+ # @param person_id The identifier of a person.
154
+ # @param site_membership_request_body_create Site membership request details
155
+ # @param [Hash] opts the optional parameters
156
+ # @option opts [Array<String>] :fields A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter.
157
+ # @return [SiteMembershipRequestEntry]
158
+ def create_site_membership_request_for_person(person_id, site_membership_request_body_create, opts = {})
159
+ data, _status_code, _headers = create_site_membership_request_for_person_with_http_info(person_id, site_membership_request_body_create, opts)
160
+ return data
161
+ end
162
+
163
+ # Create a site membership request
164
+ # Create a site membership request for yourself on the site with the identifier of **id**, specified in the JSON body. The result of the request differs depending on the type of site. * For a **public** site, you join the site immediately as a SiteConsumer. * For a **moderated** site, your request is added to the site membership request list. The request waits for approval from the Site Manager. * You cannot request membership of a **private** site. Members are invited by the site administrator. You can use the &#x60;-me-&#x60; string in place of &#x60;&lt;personId&gt;&#x60; to specify the currently authenticated user. **Note:** You can create site membership requests for more than one site by specifying a list of sites in the JSON body like this: &#x60;&#x60;&#x60;JSON [ { \&quot;message\&quot;: \&quot;Please can you add me\&quot;, \&quot;id\&quot;: \&quot;test-site-1\&quot;, \&quot;title\&quot;: \&quot;Request for test site 1\&quot;, }, { \&quot;message\&quot;: \&quot;Please can you add me\&quot;, \&quot;id\&quot;: \&quot;test-site-2\&quot;, \&quot;title\&quot;: \&quot;Request for test site 2\&quot;, } ] &#x60;&#x60;&#x60; If you specify a list as input, then a paginated list rather than an entry is returned in the response body. For example: &#x60;&#x60;&#x60;JSON { \&quot;list\&quot;: { \&quot;pagination\&quot;: { \&quot;count\&quot;: 2, \&quot;hasMoreItems\&quot;: false, \&quot;totalItems\&quot;: 2, \&quot;skipCount\&quot;: 0, \&quot;maxItems\&quot;: 100 }, \&quot;entries\&quot;: [ { \&quot;entry\&quot;: { ... } }, { \&quot;entry\&quot;: { ... } } ] } } &#x60;&#x60;&#x60;
165
+ # @param person_id The identifier of a person.
166
+ # @param site_membership_request_body_create Site membership request details
167
+ # @param [Hash] opts the optional parameters
168
+ # @option opts [Array<String>] :fields A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter.
169
+ # @return [Array<(SiteMembershipRequestEntry, Fixnum, Hash)>] SiteMembershipRequestEntry data, response status code and response headers
170
+ def create_site_membership_request_for_person_with_http_info(person_id, site_membership_request_body_create, opts = {})
171
+ if @api_client.config.debugging
172
+ @api_client.config.logger.debug "Calling API: SitesApi.create_site_membership_request_for_person ..."
173
+ end
174
+ # verify the required parameter 'person_id' is set
175
+ if @api_client.config.client_side_validation && person_id.nil?
176
+ fail ArgumentError, "Missing the required parameter 'person_id' when calling SitesApi.create_site_membership_request_for_person"
177
+ end
178
+ # verify the required parameter 'site_membership_request_body_create' is set
179
+ if @api_client.config.client_side_validation && site_membership_request_body_create.nil?
180
+ fail ArgumentError, "Missing the required parameter 'site_membership_request_body_create' when calling SitesApi.create_site_membership_request_for_person"
181
+ end
182
+ # resource path
183
+ local_var_path = "/people/{personId}/site-membership-requests".sub('{' + 'personId' + '}', person_id.to_s)
184
+
185
+ # query parameters
186
+ query_params = {}
187
+ query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
188
+
189
+ # header parameters
190
+ header_params = {}
191
+ # HTTP header 'Accept' (if needed)
192
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
193
+ # HTTP header 'Content-Type'
194
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
195
+
196
+ # form parameters
197
+ form_params = {}
198
+
199
+ # http body (model)
200
+ post_body = @api_client.object_to_http_body(site_membership_request_body_create)
201
+ auth_names = ['basicAuth']
202
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
203
+ :header_params => header_params,
204
+ :query_params => query_params,
205
+ :form_params => form_params,
206
+ :body => post_body,
207
+ :auth_names => auth_names,
208
+ :return_type => 'SiteMembershipRequestEntry')
209
+ if @api_client.config.debugging
210
+ @api_client.config.logger.debug "API called: SitesApi#create_site_membership_request_for_person\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
211
+ end
212
+ return data, status_code, headers
213
+ end
214
+
215
+ # Delete a site
216
+ # **Note:** this endpoint is available in Alfresco 5.2 and newer versions. Deletes the site with **siteId**.
217
+ # @param site_id The identifier of a site.
218
+ # @param [Hash] opts the optional parameters
219
+ # @option opts [BOOLEAN] :permanent Flag to indicate whether the site should be permanently deleted i.e. bypass the trashcan. (default to false)
220
+ # @return [nil]
221
+ def delete_site(site_id, opts = {})
222
+ delete_site_with_http_info(site_id, opts)
223
+ return nil
224
+ end
225
+
226
+ # Delete a site
227
+ # **Note:** this endpoint is available in Alfresco 5.2 and newer versions. Deletes the site with **siteId**.
228
+ # @param site_id The identifier of a site.
229
+ # @param [Hash] opts the optional parameters
230
+ # @option opts [BOOLEAN] :permanent Flag to indicate whether the site should be permanently deleted i.e. bypass the trashcan.
231
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
232
+ def delete_site_with_http_info(site_id, opts = {})
233
+ if @api_client.config.debugging
234
+ @api_client.config.logger.debug "Calling API: SitesApi.delete_site ..."
235
+ end
236
+ # verify the required parameter 'site_id' is set
237
+ if @api_client.config.client_side_validation && site_id.nil?
238
+ fail ArgumentError, "Missing the required parameter 'site_id' when calling SitesApi.delete_site"
239
+ end
240
+ # resource path
241
+ local_var_path = "/sites/{siteId}".sub('{' + 'siteId' + '}', site_id.to_s)
242
+
243
+ # query parameters
244
+ query_params = {}
245
+ query_params[:'permanent'] = opts[:'permanent'] if !opts[:'permanent'].nil?
246
+
247
+ # header parameters
248
+ header_params = {}
249
+ # HTTP header 'Accept' (if needed)
250
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
251
+ # HTTP header 'Content-Type'
252
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
253
+
254
+ # form parameters
255
+ form_params = {}
256
+
257
+ # http body (model)
258
+ post_body = nil
259
+ auth_names = ['basicAuth']
260
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
261
+ :header_params => header_params,
262
+ :query_params => query_params,
263
+ :form_params => form_params,
264
+ :body => post_body,
265
+ :auth_names => auth_names)
266
+ if @api_client.config.debugging
267
+ @api_client.config.logger.debug "API called: SitesApi#delete_site\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
268
+ end
269
+ return data, status_code, headers
270
+ end
271
+
272
+ # Delete a site membership
273
+ # Deletes person **personId** as a member of site **siteId**. You can use the `-me-` string in place of `<personId>` to specify the currently authenticated user.
274
+ # @param site_id The identifier of a site.
275
+ # @param person_id The identifier of a person.
276
+ # @param [Hash] opts the optional parameters
277
+ # @return [nil]
278
+ def delete_site_membership(site_id, person_id, opts = {})
279
+ delete_site_membership_with_http_info(site_id, person_id, opts)
280
+ return nil
281
+ end
282
+
283
+ # Delete a site membership
284
+ # Deletes person **personId** as a member of site **siteId**. You can use the &#x60;-me-&#x60; string in place of &#x60;&lt;personId&gt;&#x60; to specify the currently authenticated user.
285
+ # @param site_id The identifier of a site.
286
+ # @param person_id The identifier of a person.
287
+ # @param [Hash] opts the optional parameters
288
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
289
+ def delete_site_membership_with_http_info(site_id, person_id, opts = {})
290
+ if @api_client.config.debugging
291
+ @api_client.config.logger.debug "Calling API: SitesApi.delete_site_membership ..."
292
+ end
293
+ # verify the required parameter 'site_id' is set
294
+ if @api_client.config.client_side_validation && site_id.nil?
295
+ fail ArgumentError, "Missing the required parameter 'site_id' when calling SitesApi.delete_site_membership"
296
+ end
297
+ # verify the required parameter 'person_id' is set
298
+ if @api_client.config.client_side_validation && person_id.nil?
299
+ fail ArgumentError, "Missing the required parameter 'person_id' when calling SitesApi.delete_site_membership"
300
+ end
301
+ # resource path
302
+ local_var_path = "/sites/{siteId}/members/{personId}".sub('{' + 'siteId' + '}', site_id.to_s).sub('{' + 'personId' + '}', person_id.to_s)
303
+
304
+ # query parameters
305
+ query_params = {}
306
+
307
+ # header parameters
308
+ header_params = {}
309
+ # HTTP header 'Accept' (if needed)
310
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
311
+ # HTTP header 'Content-Type'
312
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
313
+
314
+ # form parameters
315
+ form_params = {}
316
+
317
+ # http body (model)
318
+ post_body = nil
319
+ auth_names = ['basicAuth']
320
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
321
+ :header_params => header_params,
322
+ :query_params => query_params,
323
+ :form_params => form_params,
324
+ :body => post_body,
325
+ :auth_names => auth_names)
326
+ if @api_client.config.debugging
327
+ @api_client.config.logger.debug "API called: SitesApi#delete_site_membership\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
328
+ end
329
+ return data, status_code, headers
330
+ end
331
+
332
+ # Delete a site membership
333
+ # Deletes person **personId** as a member of site **siteId**. You can use the `-me-` string in place of `<personId>` to specify the currently authenticated user.
334
+ # @param person_id The identifier of a person.
335
+ # @param site_id The identifier of a site.
336
+ # @param [Hash] opts the optional parameters
337
+ # @return [nil]
338
+ def delete_site_membership_for_person(person_id, site_id, opts = {})
339
+ delete_site_membership_for_person_with_http_info(person_id, site_id, opts)
340
+ return nil
341
+ end
342
+
343
+ # Delete a site membership
344
+ # Deletes person **personId** as a member of site **siteId**. You can use the &#x60;-me-&#x60; string in place of &#x60;&lt;personId&gt;&#x60; to specify the currently authenticated user.
345
+ # @param person_id The identifier of a person.
346
+ # @param site_id The identifier of a site.
347
+ # @param [Hash] opts the optional parameters
348
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
349
+ def delete_site_membership_for_person_with_http_info(person_id, site_id, opts = {})
350
+ if @api_client.config.debugging
351
+ @api_client.config.logger.debug "Calling API: SitesApi.delete_site_membership_for_person ..."
352
+ end
353
+ # verify the required parameter 'person_id' is set
354
+ if @api_client.config.client_side_validation && person_id.nil?
355
+ fail ArgumentError, "Missing the required parameter 'person_id' when calling SitesApi.delete_site_membership_for_person"
356
+ end
357
+ # verify the required parameter 'site_id' is set
358
+ if @api_client.config.client_side_validation && site_id.nil?
359
+ fail ArgumentError, "Missing the required parameter 'site_id' when calling SitesApi.delete_site_membership_for_person"
360
+ end
361
+ # resource path
362
+ local_var_path = "/people/{personId}/sites/{siteId}".sub('{' + 'personId' + '}', person_id.to_s).sub('{' + 'siteId' + '}', site_id.to_s)
363
+
364
+ # query parameters
365
+ query_params = {}
366
+
367
+ # header parameters
368
+ header_params = {}
369
+ # HTTP header 'Accept' (if needed)
370
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
371
+ # HTTP header 'Content-Type'
372
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
373
+
374
+ # form parameters
375
+ form_params = {}
376
+
377
+ # http body (model)
378
+ post_body = nil
379
+ auth_names = ['basicAuth']
380
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
381
+ :header_params => header_params,
382
+ :query_params => query_params,
383
+ :form_params => form_params,
384
+ :body => post_body,
385
+ :auth_names => auth_names)
386
+ if @api_client.config.debugging
387
+ @api_client.config.logger.debug "API called: SitesApi#delete_site_membership_for_person\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
388
+ end
389
+ return data, status_code, headers
390
+ end
391
+
392
+ # Delete a site membership request
393
+ # Deletes the site membership request to site **siteId** for person **personId**. You can use the `-me-` string in place of `<personId>` to specify the currently authenticated user.
394
+ # @param person_id The identifier of a person.
395
+ # @param site_id The identifier of a site.
396
+ # @param [Hash] opts the optional parameters
397
+ # @return [nil]
398
+ def delete_site_membership_request_for_person(person_id, site_id, opts = {})
399
+ delete_site_membership_request_for_person_with_http_info(person_id, site_id, opts)
400
+ return nil
401
+ end
402
+
403
+ # Delete a site membership request
404
+ # Deletes the site membership request to site **siteId** for person **personId**. You can use the &#x60;-me-&#x60; string in place of &#x60;&lt;personId&gt;&#x60; to specify the currently authenticated user.
405
+ # @param person_id The identifier of a person.
406
+ # @param site_id The identifier of a site.
407
+ # @param [Hash] opts the optional parameters
408
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
409
+ def delete_site_membership_request_for_person_with_http_info(person_id, site_id, opts = {})
410
+ if @api_client.config.debugging
411
+ @api_client.config.logger.debug "Calling API: SitesApi.delete_site_membership_request_for_person ..."
412
+ end
413
+ # verify the required parameter 'person_id' is set
414
+ if @api_client.config.client_side_validation && person_id.nil?
415
+ fail ArgumentError, "Missing the required parameter 'person_id' when calling SitesApi.delete_site_membership_request_for_person"
416
+ end
417
+ # verify the required parameter 'site_id' is set
418
+ if @api_client.config.client_side_validation && site_id.nil?
419
+ fail ArgumentError, "Missing the required parameter 'site_id' when calling SitesApi.delete_site_membership_request_for_person"
420
+ end
421
+ # resource path
422
+ local_var_path = "/people/{personId}/site-membership-requests/{siteId}".sub('{' + 'personId' + '}', person_id.to_s).sub('{' + 'siteId' + '}', site_id.to_s)
423
+
424
+ # query parameters
425
+ query_params = {}
426
+
427
+ # header parameters
428
+ header_params = {}
429
+ # HTTP header 'Accept' (if needed)
430
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
431
+ # HTTP header 'Content-Type'
432
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
433
+
434
+ # form parameters
435
+ form_params = {}
436
+
437
+ # http body (model)
438
+ post_body = nil
439
+ auth_names = ['basicAuth']
440
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
441
+ :header_params => header_params,
442
+ :query_params => query_params,
443
+ :form_params => form_params,
444
+ :body => post_body,
445
+ :auth_names => auth_names)
446
+ if @api_client.config.debugging
447
+ @api_client.config.logger.debug "API called: SitesApi#delete_site_membership_request_for_person\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
448
+ end
449
+ return data, status_code, headers
450
+ end
451
+
452
+ # Get a site
453
+ # Gets information for site **siteId**. You can use the **relations** parameter to include one or more related entities in a single response and so reduce network traffic. The entity types in Alfresco are organized in a tree structure. The **sites** entity has two children, **containers** and **members**. The following relations parameter returns all the container and member objects related to the site **siteId**: ``` containers,members ```
454
+ # @param site_id The identifier of a site.
455
+ # @param [Hash] opts the optional parameters
456
+ # @option opts [Array<String>] :relations Use the relations parameter to include one or more related entities in a single response.
457
+ # @option opts [Array<String>] :fields A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter.
458
+ # @return [SiteEntry]
459
+ def get_site(site_id, opts = {})
460
+ data, _status_code, _headers = get_site_with_http_info(site_id, opts)
461
+ return data
462
+ end
463
+
464
+ # Get a site
465
+ # Gets information for site **siteId**. You can use the **relations** parameter to include one or more related entities in a single response and so reduce network traffic. The entity types in Alfresco are organized in a tree structure. The **sites** entity has two children, **containers** and **members**. The following relations parameter returns all the container and member objects related to the site **siteId**: &#x60;&#x60;&#x60; containers,members &#x60;&#x60;&#x60;
466
+ # @param site_id The identifier of a site.
467
+ # @param [Hash] opts the optional parameters
468
+ # @option opts [Array<String>] :relations Use the relations parameter to include one or more related entities in a single response.
469
+ # @option opts [Array<String>] :fields A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter.
470
+ # @return [Array<(SiteEntry, Fixnum, Hash)>] SiteEntry data, response status code and response headers
471
+ def get_site_with_http_info(site_id, opts = {})
472
+ if @api_client.config.debugging
473
+ @api_client.config.logger.debug "Calling API: SitesApi.get_site ..."
474
+ end
475
+ # verify the required parameter 'site_id' is set
476
+ if @api_client.config.client_side_validation && site_id.nil?
477
+ fail ArgumentError, "Missing the required parameter 'site_id' when calling SitesApi.get_site"
478
+ end
479
+ # resource path
480
+ local_var_path = "/sites/{siteId}".sub('{' + 'siteId' + '}', site_id.to_s)
481
+
482
+ # query parameters
483
+ query_params = {}
484
+ query_params[:'relations'] = @api_client.build_collection_param(opts[:'relations'], :csv) if !opts[:'relations'].nil?
485
+ query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
486
+
487
+ # header parameters
488
+ header_params = {}
489
+ # HTTP header 'Accept' (if needed)
490
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
491
+ # HTTP header 'Content-Type'
492
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
493
+
494
+ # form parameters
495
+ form_params = {}
496
+
497
+ # http body (model)
498
+ post_body = nil
499
+ auth_names = ['basicAuth']
500
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
501
+ :header_params => header_params,
502
+ :query_params => query_params,
503
+ :form_params => form_params,
504
+ :body => post_body,
505
+ :auth_names => auth_names,
506
+ :return_type => 'SiteEntry')
507
+ if @api_client.config.debugging
508
+ @api_client.config.logger.debug "API called: SitesApi#get_site\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
509
+ end
510
+ return data, status_code, headers
511
+ end
512
+
513
+ # Get a site container
514
+ # Gets information on the container **containerId** in site **siteId**.
515
+ # @param site_id The identifier of a site.
516
+ # @param container_id The unique identifier of a site container.
517
+ # @param [Hash] opts the optional parameters
518
+ # @option opts [Array<String>] :fields A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter.
519
+ # @return [SiteContainerEntry]
520
+ def get_site_container(site_id, container_id, opts = {})
521
+ data, _status_code, _headers = get_site_container_with_http_info(site_id, container_id, opts)
522
+ return data
523
+ end
524
+
525
+ # Get a site container
526
+ # Gets information on the container **containerId** in site **siteId**.
527
+ # @param site_id The identifier of a site.
528
+ # @param container_id The unique identifier of a site container.
529
+ # @param [Hash] opts the optional parameters
530
+ # @option opts [Array<String>] :fields A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter.
531
+ # @return [Array<(SiteContainerEntry, Fixnum, Hash)>] SiteContainerEntry data, response status code and response headers
532
+ def get_site_container_with_http_info(site_id, container_id, opts = {})
533
+ if @api_client.config.debugging
534
+ @api_client.config.logger.debug "Calling API: SitesApi.get_site_container ..."
535
+ end
536
+ # verify the required parameter 'site_id' is set
537
+ if @api_client.config.client_side_validation && site_id.nil?
538
+ fail ArgumentError, "Missing the required parameter 'site_id' when calling SitesApi.get_site_container"
539
+ end
540
+ # verify the required parameter 'container_id' is set
541
+ if @api_client.config.client_side_validation && container_id.nil?
542
+ fail ArgumentError, "Missing the required parameter 'container_id' when calling SitesApi.get_site_container"
543
+ end
544
+ # resource path
545
+ local_var_path = "/sites/{siteId}/containers/{containerId}".sub('{' + 'siteId' + '}', site_id.to_s).sub('{' + 'containerId' + '}', container_id.to_s)
546
+
547
+ # query parameters
548
+ query_params = {}
549
+ query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
550
+
551
+ # header parameters
552
+ header_params = {}
553
+ # HTTP header 'Accept' (if needed)
554
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
555
+ # HTTP header 'Content-Type'
556
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
557
+
558
+ # form parameters
559
+ form_params = {}
560
+
561
+ # http body (model)
562
+ post_body = nil
563
+ auth_names = ['basicAuth']
564
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
565
+ :header_params => header_params,
566
+ :query_params => query_params,
567
+ :form_params => form_params,
568
+ :body => post_body,
569
+ :auth_names => auth_names,
570
+ :return_type => 'SiteContainerEntry')
571
+ if @api_client.config.debugging
572
+ @api_client.config.logger.debug "API called: SitesApi#get_site_container\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
573
+ end
574
+ return data, status_code, headers
575
+ end
576
+
577
+ # Get a site membership
578
+ # Gets site membership information for person **personId** on site **siteId**. You can use the `-me-` string in place of `<personId>` to specify the currently authenticated user.
579
+ # @param site_id The identifier of a site.
580
+ # @param person_id The identifier of a person.
581
+ # @param [Hash] opts the optional parameters
582
+ # @option opts [Array<String>] :fields A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter.
583
+ # @return [SiteMemberEntry]
584
+ def get_site_membership(site_id, person_id, opts = {})
585
+ data, _status_code, _headers = get_site_membership_with_http_info(site_id, person_id, opts)
586
+ return data
587
+ end
588
+
589
+ # Get a site membership
590
+ # Gets site membership information for person **personId** on site **siteId**. You can use the &#x60;-me-&#x60; string in place of &#x60;&lt;personId&gt;&#x60; to specify the currently authenticated user.
591
+ # @param site_id The identifier of a site.
592
+ # @param person_id The identifier of a person.
593
+ # @param [Hash] opts the optional parameters
594
+ # @option opts [Array<String>] :fields A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter.
595
+ # @return [Array<(SiteMemberEntry, Fixnum, Hash)>] SiteMemberEntry data, response status code and response headers
596
+ def get_site_membership_with_http_info(site_id, person_id, opts = {})
597
+ if @api_client.config.debugging
598
+ @api_client.config.logger.debug "Calling API: SitesApi.get_site_membership ..."
599
+ end
600
+ # verify the required parameter 'site_id' is set
601
+ if @api_client.config.client_side_validation && site_id.nil?
602
+ fail ArgumentError, "Missing the required parameter 'site_id' when calling SitesApi.get_site_membership"
603
+ end
604
+ # verify the required parameter 'person_id' is set
605
+ if @api_client.config.client_side_validation && person_id.nil?
606
+ fail ArgumentError, "Missing the required parameter 'person_id' when calling SitesApi.get_site_membership"
607
+ end
608
+ # resource path
609
+ local_var_path = "/sites/{siteId}/members/{personId}".sub('{' + 'siteId' + '}', site_id.to_s).sub('{' + 'personId' + '}', person_id.to_s)
610
+
611
+ # query parameters
612
+ query_params = {}
613
+ query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
614
+
615
+ # header parameters
616
+ header_params = {}
617
+ # HTTP header 'Accept' (if needed)
618
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
619
+ # HTTP header 'Content-Type'
620
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
621
+
622
+ # form parameters
623
+ form_params = {}
624
+
625
+ # http body (model)
626
+ post_body = nil
627
+ auth_names = ['basicAuth']
628
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
629
+ :header_params => header_params,
630
+ :query_params => query_params,
631
+ :form_params => form_params,
632
+ :body => post_body,
633
+ :auth_names => auth_names,
634
+ :return_type => 'SiteMemberEntry')
635
+ if @api_client.config.debugging
636
+ @api_client.config.logger.debug "API called: SitesApi#get_site_membership\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
637
+ end
638
+ return data, status_code, headers
639
+ end
640
+
641
+ # Get a site membership
642
+ # Gets site membership information for person **personId** on site **siteId**. You can use the `-me-` string in place of `<personId>` to specify the currently authenticated user.
643
+ # @param person_id The identifier of a person.
644
+ # @param site_id The identifier of a site.
645
+ # @param [Hash] opts the optional parameters
646
+ # @return [SiteRoleEntry]
647
+ def get_site_membership_for_person(person_id, site_id, opts = {})
648
+ data, _status_code, _headers = get_site_membership_for_person_with_http_info(person_id, site_id, opts)
649
+ return data
650
+ end
651
+
652
+ # Get a site membership
653
+ # Gets site membership information for person **personId** on site **siteId**. You can use the &#x60;-me-&#x60; string in place of &#x60;&lt;personId&gt;&#x60; to specify the currently authenticated user.
654
+ # @param person_id The identifier of a person.
655
+ # @param site_id The identifier of a site.
656
+ # @param [Hash] opts the optional parameters
657
+ # @return [Array<(SiteRoleEntry, Fixnum, Hash)>] SiteRoleEntry data, response status code and response headers
658
+ def get_site_membership_for_person_with_http_info(person_id, site_id, opts = {})
659
+ if @api_client.config.debugging
660
+ @api_client.config.logger.debug "Calling API: SitesApi.get_site_membership_for_person ..."
661
+ end
662
+ # verify the required parameter 'person_id' is set
663
+ if @api_client.config.client_side_validation && person_id.nil?
664
+ fail ArgumentError, "Missing the required parameter 'person_id' when calling SitesApi.get_site_membership_for_person"
665
+ end
666
+ # verify the required parameter 'site_id' is set
667
+ if @api_client.config.client_side_validation && site_id.nil?
668
+ fail ArgumentError, "Missing the required parameter 'site_id' when calling SitesApi.get_site_membership_for_person"
669
+ end
670
+ # resource path
671
+ local_var_path = "/people/{personId}/sites/{siteId}".sub('{' + 'personId' + '}', person_id.to_s).sub('{' + 'siteId' + '}', site_id.to_s)
672
+
673
+ # query parameters
674
+ query_params = {}
675
+
676
+ # header parameters
677
+ header_params = {}
678
+ # HTTP header 'Accept' (if needed)
679
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
680
+ # HTTP header 'Content-Type'
681
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
682
+
683
+ # form parameters
684
+ form_params = {}
685
+
686
+ # http body (model)
687
+ post_body = nil
688
+ auth_names = ['basicAuth']
689
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
690
+ :header_params => header_params,
691
+ :query_params => query_params,
692
+ :form_params => form_params,
693
+ :body => post_body,
694
+ :auth_names => auth_names,
695
+ :return_type => 'SiteRoleEntry')
696
+ if @api_client.config.debugging
697
+ @api_client.config.logger.debug "API called: SitesApi#get_site_membership_for_person\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
698
+ end
699
+ return data, status_code, headers
700
+ end
701
+
702
+ # Get a site membership request
703
+ # Gets the site membership request for site **siteId** for person **personId**, if one exists. You can use the `-me-` string in place of `<personId>` to specify the currently authenticated user.
704
+ # @param person_id The identifier of a person.
705
+ # @param site_id The identifier of a site.
706
+ # @param [Hash] opts the optional parameters
707
+ # @option opts [Array<String>] :fields A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter.
708
+ # @return [SiteMembershipRequestEntry]
709
+ def get_site_membership_request_for_person(person_id, site_id, opts = {})
710
+ data, _status_code, _headers = get_site_membership_request_for_person_with_http_info(person_id, site_id, opts)
711
+ return data
712
+ end
713
+
714
+ # Get a site membership request
715
+ # Gets the site membership request for site **siteId** for person **personId**, if one exists. You can use the &#x60;-me-&#x60; string in place of &#x60;&lt;personId&gt;&#x60; to specify the currently authenticated user.
716
+ # @param person_id The identifier of a person.
717
+ # @param site_id The identifier of a site.
718
+ # @param [Hash] opts the optional parameters
719
+ # @option opts [Array<String>] :fields A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter.
720
+ # @return [Array<(SiteMembershipRequestEntry, Fixnum, Hash)>] SiteMembershipRequestEntry data, response status code and response headers
721
+ def get_site_membership_request_for_person_with_http_info(person_id, site_id, opts = {})
722
+ if @api_client.config.debugging
723
+ @api_client.config.logger.debug "Calling API: SitesApi.get_site_membership_request_for_person ..."
724
+ end
725
+ # verify the required parameter 'person_id' is set
726
+ if @api_client.config.client_side_validation && person_id.nil?
727
+ fail ArgumentError, "Missing the required parameter 'person_id' when calling SitesApi.get_site_membership_request_for_person"
728
+ end
729
+ # verify the required parameter 'site_id' is set
730
+ if @api_client.config.client_side_validation && site_id.nil?
731
+ fail ArgumentError, "Missing the required parameter 'site_id' when calling SitesApi.get_site_membership_request_for_person"
732
+ end
733
+ # resource path
734
+ local_var_path = "/people/{personId}/site-membership-requests/{siteId}".sub('{' + 'personId' + '}', person_id.to_s).sub('{' + 'siteId' + '}', site_id.to_s)
735
+
736
+ # query parameters
737
+ query_params = {}
738
+ query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
739
+
740
+ # header parameters
741
+ header_params = {}
742
+ # HTTP header 'Accept' (if needed)
743
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
744
+ # HTTP header 'Content-Type'
745
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
746
+
747
+ # form parameters
748
+ form_params = {}
749
+
750
+ # http body (model)
751
+ post_body = nil
752
+ auth_names = ['basicAuth']
753
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
754
+ :header_params => header_params,
755
+ :query_params => query_params,
756
+ :form_params => form_params,
757
+ :body => post_body,
758
+ :auth_names => auth_names,
759
+ :return_type => 'SiteMembershipRequestEntry')
760
+ if @api_client.config.debugging
761
+ @api_client.config.logger.debug "API called: SitesApi#get_site_membership_request_for_person\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
762
+ end
763
+ return data, status_code, headers
764
+ end
765
+
766
+ # List site containers
767
+ # Gets a list of containers for the site **siteId**.
768
+ # @param site_id The identifier of a site.
769
+ # @param [Hash] opts the optional parameters
770
+ # @option opts [Integer] :skip_count The number of entities that exist in the collection before those included in this list. If not supplied then the default value is 0. (default to 0)
771
+ # @option opts [Integer] :max_items The maximum number of items to return in the list. If not supplied then the default value is 100. (default to 100)
772
+ # @option opts [Array<String>] :fields A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter.
773
+ # @return [SiteContainerPaging]
774
+ def list_site_containers(site_id, opts = {})
775
+ data, _status_code, _headers = list_site_containers_with_http_info(site_id, opts)
776
+ return data
777
+ end
778
+
779
+ # List site containers
780
+ # Gets a list of containers for the site **siteId**.
781
+ # @param site_id The identifier of a site.
782
+ # @param [Hash] opts the optional parameters
783
+ # @option opts [Integer] :skip_count The number of entities that exist in the collection before those included in this list. If not supplied then the default value is 0.
784
+ # @option opts [Integer] :max_items The maximum number of items to return in the list. If not supplied then the default value is 100.
785
+ # @option opts [Array<String>] :fields A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter.
786
+ # @return [Array<(SiteContainerPaging, Fixnum, Hash)>] SiteContainerPaging data, response status code and response headers
787
+ def list_site_containers_with_http_info(site_id, opts = {})
788
+ if @api_client.config.debugging
789
+ @api_client.config.logger.debug "Calling API: SitesApi.list_site_containers ..."
790
+ end
791
+ # verify the required parameter 'site_id' is set
792
+ if @api_client.config.client_side_validation && site_id.nil?
793
+ fail ArgumentError, "Missing the required parameter 'site_id' when calling SitesApi.list_site_containers"
794
+ end
795
+ if @api_client.config.client_side_validation && !opts[:'skip_count'].nil? && opts[:'skip_count'] < 0
796
+ fail ArgumentError, 'invalid value for "opts[:"skip_count"]" when calling SitesApi.list_site_containers, must be greater than or equal to 0.'
797
+ end
798
+
799
+ if @api_client.config.client_side_validation && !opts[:'max_items'].nil? && opts[:'max_items'] < 1
800
+ fail ArgumentError, 'invalid value for "opts[:"max_items"]" when calling SitesApi.list_site_containers, must be greater than or equal to 1.'
801
+ end
802
+
803
+ # resource path
804
+ local_var_path = "/sites/{siteId}/containers".sub('{' + 'siteId' + '}', site_id.to_s)
805
+
806
+ # query parameters
807
+ query_params = {}
808
+ query_params[:'skipCount'] = opts[:'skip_count'] if !opts[:'skip_count'].nil?
809
+ query_params[:'maxItems'] = opts[:'max_items'] if !opts[:'max_items'].nil?
810
+ query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
811
+
812
+ # header parameters
813
+ header_params = {}
814
+ # HTTP header 'Accept' (if needed)
815
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
816
+ # HTTP header 'Content-Type'
817
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
818
+
819
+ # form parameters
820
+ form_params = {}
821
+
822
+ # http body (model)
823
+ post_body = nil
824
+ auth_names = ['basicAuth']
825
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
826
+ :header_params => header_params,
827
+ :query_params => query_params,
828
+ :form_params => form_params,
829
+ :body => post_body,
830
+ :auth_names => auth_names,
831
+ :return_type => 'SiteContainerPaging')
832
+ if @api_client.config.debugging
833
+ @api_client.config.logger.debug "API called: SitesApi#list_site_containers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
834
+ end
835
+ return data, status_code, headers
836
+ end
837
+
838
+ # List site membership requests
839
+ # Gets a list of the current site membership requests for person **personId**. You can use the `-me-` string in place of `<personId>` to specify the currently authenticated user.
840
+ # @param person_id The identifier of a person.
841
+ # @param [Hash] opts the optional parameters
842
+ # @option opts [Integer] :skip_count The number of entities that exist in the collection before those included in this list. If not supplied then the default value is 0. (default to 0)
843
+ # @option opts [Integer] :max_items The maximum number of items to return in the list. If not supplied then the default value is 100. (default to 100)
844
+ # @option opts [Array<String>] :fields A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter.
845
+ # @return [SiteMembershipRequestPaging]
846
+ def list_site_membership_requests_for_person(person_id, opts = {})
847
+ data, _status_code, _headers = list_site_membership_requests_for_person_with_http_info(person_id, opts)
848
+ return data
849
+ end
850
+
851
+ # List site membership requests
852
+ # Gets a list of the current site membership requests for person **personId**. You can use the &#x60;-me-&#x60; string in place of &#x60;&lt;personId&gt;&#x60; to specify the currently authenticated user.
853
+ # @param person_id The identifier of a person.
854
+ # @param [Hash] opts the optional parameters
855
+ # @option opts [Integer] :skip_count The number of entities that exist in the collection before those included in this list. If not supplied then the default value is 0.
856
+ # @option opts [Integer] :max_items The maximum number of items to return in the list. If not supplied then the default value is 100.
857
+ # @option opts [Array<String>] :fields A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter.
858
+ # @return [Array<(SiteMembershipRequestPaging, Fixnum, Hash)>] SiteMembershipRequestPaging data, response status code and response headers
859
+ def list_site_membership_requests_for_person_with_http_info(person_id, opts = {})
860
+ if @api_client.config.debugging
861
+ @api_client.config.logger.debug "Calling API: SitesApi.list_site_membership_requests_for_person ..."
862
+ end
863
+ # verify the required parameter 'person_id' is set
864
+ if @api_client.config.client_side_validation && person_id.nil?
865
+ fail ArgumentError, "Missing the required parameter 'person_id' when calling SitesApi.list_site_membership_requests_for_person"
866
+ end
867
+ if @api_client.config.client_side_validation && !opts[:'skip_count'].nil? && opts[:'skip_count'] < 0
868
+ fail ArgumentError, 'invalid value for "opts[:"skip_count"]" when calling SitesApi.list_site_membership_requests_for_person, must be greater than or equal to 0.'
869
+ end
870
+
871
+ if @api_client.config.client_side_validation && !opts[:'max_items'].nil? && opts[:'max_items'] < 1
872
+ fail ArgumentError, 'invalid value for "opts[:"max_items"]" when calling SitesApi.list_site_membership_requests_for_person, must be greater than or equal to 1.'
873
+ end
874
+
875
+ # resource path
876
+ local_var_path = "/people/{personId}/site-membership-requests".sub('{' + 'personId' + '}', person_id.to_s)
877
+
878
+ # query parameters
879
+ query_params = {}
880
+ query_params[:'skipCount'] = opts[:'skip_count'] if !opts[:'skip_count'].nil?
881
+ query_params[:'maxItems'] = opts[:'max_items'] if !opts[:'max_items'].nil?
882
+ query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
883
+
884
+ # header parameters
885
+ header_params = {}
886
+ # HTTP header 'Accept' (if needed)
887
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
888
+ # HTTP header 'Content-Type'
889
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
890
+
891
+ # form parameters
892
+ form_params = {}
893
+
894
+ # http body (model)
895
+ post_body = nil
896
+ auth_names = ['basicAuth']
897
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
898
+ :header_params => header_params,
899
+ :query_params => query_params,
900
+ :form_params => form_params,
901
+ :body => post_body,
902
+ :auth_names => auth_names,
903
+ :return_type => 'SiteMembershipRequestPaging')
904
+ if @api_client.config.debugging
905
+ @api_client.config.logger.debug "API called: SitesApi#list_site_membership_requests_for_person\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
906
+ end
907
+ return data, status_code, headers
908
+ end
909
+
910
+ # List site memberships
911
+ # Gets a list of site memberships for site **siteId**.
912
+ # @param site_id The identifier of a site.
913
+ # @param [Hash] opts the optional parameters
914
+ # @option opts [Integer] :skip_count The number of entities that exist in the collection before those included in this list. If not supplied then the default value is 0. (default to 0)
915
+ # @option opts [Integer] :max_items The maximum number of items to return in the list. If not supplied then the default value is 100. (default to 100)
916
+ # @option opts [Array<String>] :fields A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter.
917
+ # @return [SiteMemberPaging]
918
+ def list_site_memberships(site_id, opts = {})
919
+ data, _status_code, _headers = list_site_memberships_with_http_info(site_id, opts)
920
+ return data
921
+ end
922
+
923
+ # List site memberships
924
+ # Gets a list of site memberships for site **siteId**.
925
+ # @param site_id The identifier of a site.
926
+ # @param [Hash] opts the optional parameters
927
+ # @option opts [Integer] :skip_count The number of entities that exist in the collection before those included in this list. If not supplied then the default value is 0.
928
+ # @option opts [Integer] :max_items The maximum number of items to return in the list. If not supplied then the default value is 100.
929
+ # @option opts [Array<String>] :fields A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter.
930
+ # @return [Array<(SiteMemberPaging, Fixnum, Hash)>] SiteMemberPaging data, response status code and response headers
931
+ def list_site_memberships_with_http_info(site_id, opts = {})
932
+ if @api_client.config.debugging
933
+ @api_client.config.logger.debug "Calling API: SitesApi.list_site_memberships ..."
934
+ end
935
+ # verify the required parameter 'site_id' is set
936
+ if @api_client.config.client_side_validation && site_id.nil?
937
+ fail ArgumentError, "Missing the required parameter 'site_id' when calling SitesApi.list_site_memberships"
938
+ end
939
+ if @api_client.config.client_side_validation && !opts[:'skip_count'].nil? && opts[:'skip_count'] < 0
940
+ fail ArgumentError, 'invalid value for "opts[:"skip_count"]" when calling SitesApi.list_site_memberships, must be greater than or equal to 0.'
941
+ end
942
+
943
+ if @api_client.config.client_side_validation && !opts[:'max_items'].nil? && opts[:'max_items'] < 1
944
+ fail ArgumentError, 'invalid value for "opts[:"max_items"]" when calling SitesApi.list_site_memberships, must be greater than or equal to 1.'
945
+ end
946
+
947
+ # resource path
948
+ local_var_path = "/sites/{siteId}/members".sub('{' + 'siteId' + '}', site_id.to_s)
949
+
950
+ # query parameters
951
+ query_params = {}
952
+ query_params[:'skipCount'] = opts[:'skip_count'] if !opts[:'skip_count'].nil?
953
+ query_params[:'maxItems'] = opts[:'max_items'] if !opts[:'max_items'].nil?
954
+ query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
955
+
956
+ # header parameters
957
+ header_params = {}
958
+ # HTTP header 'Accept' (if needed)
959
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
960
+ # HTTP header 'Content-Type'
961
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
962
+
963
+ # form parameters
964
+ form_params = {}
965
+
966
+ # http body (model)
967
+ post_body = nil
968
+ auth_names = ['basicAuth']
969
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
970
+ :header_params => header_params,
971
+ :query_params => query_params,
972
+ :form_params => form_params,
973
+ :body => post_body,
974
+ :auth_names => auth_names,
975
+ :return_type => 'SiteMemberPaging')
976
+ if @api_client.config.debugging
977
+ @api_client.config.logger.debug "API called: SitesApi#list_site_memberships\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
978
+ end
979
+ return data, status_code, headers
980
+ end
981
+
982
+ # List site memberships
983
+ # Gets a list of site membership information for person **personId**. You can use the `-me-` string in place of `<personId>` to specify the currently authenticated user. You can use the **where** parameter to filter the returned sites by **visibility** or site **preset**. Example to filter by **visibility**, use any one of: ``` (visibility='PRIVATE') (visibility='PUBLIC') (visibility='MODERATED') ``` Example to filter by site **preset**: ``` (preset='site-dashboard') ``` The default sort order for the returned list is for sites to be sorted by ascending title. You can override the default by using the **orderBy** parameter. You can specify one or more of the following fields in the **orderBy** parameter: * id * title * role
984
+ # @param person_id The identifier of a person.
985
+ # @param [Hash] opts the optional parameters
986
+ # @option opts [Integer] :skip_count The number of entities that exist in the collection before those included in this list. If not supplied then the default value is 0. (default to 0)
987
+ # @option opts [Integer] :max_items The maximum number of items to return in the list. If not supplied then the default value is 100. (default to 100)
988
+ # @option opts [Array<String>] :order_by A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to sort the list by one or more fields. Each field has a default sort order, which is normally ascending order. Read the API method implementation notes above to check if any fields used in this method have a descending default search order. To sort the entities in a specific order, you can use the **ASC** and **DESC** keywords for any field.
989
+ # @option opts [Array<String>] :relations Use the relations parameter to include one or more related entities in a single response.
990
+ # @option opts [Array<String>] :fields A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter.
991
+ # @option opts [String] :where A string to restrict the returned objects by using a predicate.
992
+ # @return [SiteRolePaging]
993
+ def list_site_memberships_for_person(person_id, opts = {})
994
+ data, _status_code, _headers = list_site_memberships_for_person_with_http_info(person_id, opts)
995
+ return data
996
+ end
997
+
998
+ # List site memberships
999
+ # Gets a list of site membership information for person **personId**. You can use the &#x60;-me-&#x60; string in place of &#x60;&lt;personId&gt;&#x60; to specify the currently authenticated user. You can use the **where** parameter to filter the returned sites by **visibility** or site **preset**. Example to filter by **visibility**, use any one of: &#x60;&#x60;&#x60; (visibility&#x3D;&#39;PRIVATE&#39;) (visibility&#x3D;&#39;PUBLIC&#39;) (visibility&#x3D;&#39;MODERATED&#39;) &#x60;&#x60;&#x60; Example to filter by site **preset**: &#x60;&#x60;&#x60; (preset&#x3D;&#39;site-dashboard&#39;) &#x60;&#x60;&#x60; The default sort order for the returned list is for sites to be sorted by ascending title. You can override the default by using the **orderBy** parameter. You can specify one or more of the following fields in the **orderBy** parameter: * id * title * role
1000
+ # @param person_id The identifier of a person.
1001
+ # @param [Hash] opts the optional parameters
1002
+ # @option opts [Integer] :skip_count The number of entities that exist in the collection before those included in this list. If not supplied then the default value is 0.
1003
+ # @option opts [Integer] :max_items The maximum number of items to return in the list. If not supplied then the default value is 100.
1004
+ # @option opts [Array<String>] :order_by A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to sort the list by one or more fields. Each field has a default sort order, which is normally ascending order. Read the API method implementation notes above to check if any fields used in this method have a descending default search order. To sort the entities in a specific order, you can use the **ASC** and **DESC** keywords for any field.
1005
+ # @option opts [Array<String>] :relations Use the relations parameter to include one or more related entities in a single response.
1006
+ # @option opts [Array<String>] :fields A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter.
1007
+ # @option opts [String] :where A string to restrict the returned objects by using a predicate.
1008
+ # @return [Array<(SiteRolePaging, Fixnum, Hash)>] SiteRolePaging data, response status code and response headers
1009
+ def list_site_memberships_for_person_with_http_info(person_id, opts = {})
1010
+ if @api_client.config.debugging
1011
+ @api_client.config.logger.debug "Calling API: SitesApi.list_site_memberships_for_person ..."
1012
+ end
1013
+ # verify the required parameter 'person_id' is set
1014
+ if @api_client.config.client_side_validation && person_id.nil?
1015
+ fail ArgumentError, "Missing the required parameter 'person_id' when calling SitesApi.list_site_memberships_for_person"
1016
+ end
1017
+ if @api_client.config.client_side_validation && !opts[:'skip_count'].nil? && opts[:'skip_count'] < 0
1018
+ fail ArgumentError, 'invalid value for "opts[:"skip_count"]" when calling SitesApi.list_site_memberships_for_person, must be greater than or equal to 0.'
1019
+ end
1020
+
1021
+ if @api_client.config.client_side_validation && !opts[:'max_items'].nil? && opts[:'max_items'] < 1
1022
+ fail ArgumentError, 'invalid value for "opts[:"max_items"]" when calling SitesApi.list_site_memberships_for_person, must be greater than or equal to 1.'
1023
+ end
1024
+
1025
+ # resource path
1026
+ local_var_path = "/people/{personId}/sites".sub('{' + 'personId' + '}', person_id.to_s)
1027
+
1028
+ # query parameters
1029
+ query_params = {}
1030
+ query_params[:'skipCount'] = opts[:'skip_count'] if !opts[:'skip_count'].nil?
1031
+ query_params[:'maxItems'] = opts[:'max_items'] if !opts[:'max_items'].nil?
1032
+ query_params[:'orderBy'] = @api_client.build_collection_param(opts[:'order_by'], :csv) if !opts[:'order_by'].nil?
1033
+ query_params[:'relations'] = @api_client.build_collection_param(opts[:'relations'], :csv) if !opts[:'relations'].nil?
1034
+ query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
1035
+ query_params[:'where'] = opts[:'where'] if !opts[:'where'].nil?
1036
+
1037
+ # header parameters
1038
+ header_params = {}
1039
+ # HTTP header 'Accept' (if needed)
1040
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1041
+ # HTTP header 'Content-Type'
1042
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1043
+
1044
+ # form parameters
1045
+ form_params = {}
1046
+
1047
+ # http body (model)
1048
+ post_body = nil
1049
+ auth_names = ['basicAuth']
1050
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1051
+ :header_params => header_params,
1052
+ :query_params => query_params,
1053
+ :form_params => form_params,
1054
+ :body => post_body,
1055
+ :auth_names => auth_names,
1056
+ :return_type => 'SiteRolePaging')
1057
+ if @api_client.config.debugging
1058
+ @api_client.config.logger.debug "API called: SitesApi#list_site_memberships_for_person\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1059
+ end
1060
+ return data, status_code, headers
1061
+ end
1062
+
1063
+ # List sites
1064
+ # Gets a list of sites in this repository. You can use the **where** parameter to filter the returned sites by **visibility** or site **preset**. Example to filter by **visibility**, use any one of: ``` (visibility='PRIVATE') (visibility='PUBLIC') (visibility='MODERATED') ``` Example to filter by site **preset**: ``` (preset='site-dashboard') ``` The default sort order for the returned list is for sites to be sorted by ascending title. You can override the default by using the **orderBy** parameter. You can specify one or more of the following fields in the **orderBy** parameter: * id * title * description You can use the **relations** parameter to include one or more related entities in a single response and so reduce network traffic. The entity types in Alfresco are organized in a tree structure. The **sites** entity has two children, **containers** and **members**. The following relations parameter returns all the container and member objects related to each site: ``` containers,members ```
1065
+ # @param [Hash] opts the optional parameters
1066
+ # @option opts [Integer] :skip_count The number of entities that exist in the collection before those included in this list. If not supplied then the default value is 0. (default to 0)
1067
+ # @option opts [Integer] :max_items The maximum number of items to return in the list. If not supplied then the default value is 100. (default to 100)
1068
+ # @option opts [Array<String>] :order_by A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to sort the list by one or more fields. Each field has a default sort order, which is normally ascending order. Read the API method implementation notes above to check if any fields used in this method have a descending default search order. To sort the entities in a specific order, you can use the **ASC** and **DESC** keywords for any field.
1069
+ # @option opts [Array<String>] :relations Use the relations parameter to include one or more related entities in a single response.
1070
+ # @option opts [Array<String>] :fields A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter.
1071
+ # @option opts [String] :where A string to restrict the returned objects by using a predicate.
1072
+ # @return [SitePaging]
1073
+ def list_sites(opts = {})
1074
+ data, _status_code, _headers = list_sites_with_http_info(opts)
1075
+ return data
1076
+ end
1077
+
1078
+ # List sites
1079
+ # Gets a list of sites in this repository. You can use the **where** parameter to filter the returned sites by **visibility** or site **preset**. Example to filter by **visibility**, use any one of: &#x60;&#x60;&#x60; (visibility&#x3D;&#39;PRIVATE&#39;) (visibility&#x3D;&#39;PUBLIC&#39;) (visibility&#x3D;&#39;MODERATED&#39;) &#x60;&#x60;&#x60; Example to filter by site **preset**: &#x60;&#x60;&#x60; (preset&#x3D;&#39;site-dashboard&#39;) &#x60;&#x60;&#x60; The default sort order for the returned list is for sites to be sorted by ascending title. You can override the default by using the **orderBy** parameter. You can specify one or more of the following fields in the **orderBy** parameter: * id * title * description You can use the **relations** parameter to include one or more related entities in a single response and so reduce network traffic. The entity types in Alfresco are organized in a tree structure. The **sites** entity has two children, **containers** and **members**. The following relations parameter returns all the container and member objects related to each site: &#x60;&#x60;&#x60; containers,members &#x60;&#x60;&#x60;
1080
+ # @param [Hash] opts the optional parameters
1081
+ # @option opts [Integer] :skip_count The number of entities that exist in the collection before those included in this list. If not supplied then the default value is 0.
1082
+ # @option opts [Integer] :max_items The maximum number of items to return in the list. If not supplied then the default value is 100.
1083
+ # @option opts [Array<String>] :order_by A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to sort the list by one or more fields. Each field has a default sort order, which is normally ascending order. Read the API method implementation notes above to check if any fields used in this method have a descending default search order. To sort the entities in a specific order, you can use the **ASC** and **DESC** keywords for any field.
1084
+ # @option opts [Array<String>] :relations Use the relations parameter to include one or more related entities in a single response.
1085
+ # @option opts [Array<String>] :fields A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter.
1086
+ # @option opts [String] :where A string to restrict the returned objects by using a predicate.
1087
+ # @return [Array<(SitePaging, Fixnum, Hash)>] SitePaging data, response status code and response headers
1088
+ def list_sites_with_http_info(opts = {})
1089
+ if @api_client.config.debugging
1090
+ @api_client.config.logger.debug "Calling API: SitesApi.list_sites ..."
1091
+ end
1092
+ if @api_client.config.client_side_validation && !opts[:'skip_count'].nil? && opts[:'skip_count'] < 0
1093
+ fail ArgumentError, 'invalid value for "opts[:"skip_count"]" when calling SitesApi.list_sites, must be greater than or equal to 0.'
1094
+ end
1095
+
1096
+ if @api_client.config.client_side_validation && !opts[:'max_items'].nil? && opts[:'max_items'] < 1
1097
+ fail ArgumentError, 'invalid value for "opts[:"max_items"]" when calling SitesApi.list_sites, must be greater than or equal to 1.'
1098
+ end
1099
+
1100
+ # resource path
1101
+ local_var_path = "/sites"
1102
+
1103
+ # query parameters
1104
+ query_params = {}
1105
+ query_params[:'skipCount'] = opts[:'skip_count'] if !opts[:'skip_count'].nil?
1106
+ query_params[:'maxItems'] = opts[:'max_items'] if !opts[:'max_items'].nil?
1107
+ query_params[:'orderBy'] = @api_client.build_collection_param(opts[:'order_by'], :csv) if !opts[:'order_by'].nil?
1108
+ query_params[:'relations'] = @api_client.build_collection_param(opts[:'relations'], :csv) if !opts[:'relations'].nil?
1109
+ query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
1110
+ query_params[:'where'] = opts[:'where'] if !opts[:'where'].nil?
1111
+
1112
+ # header parameters
1113
+ header_params = {}
1114
+ # HTTP header 'Accept' (if needed)
1115
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1116
+ # HTTP header 'Content-Type'
1117
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1118
+
1119
+ # form parameters
1120
+ form_params = {}
1121
+
1122
+ # http body (model)
1123
+ post_body = nil
1124
+ auth_names = ['basicAuth']
1125
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1126
+ :header_params => header_params,
1127
+ :query_params => query_params,
1128
+ :form_params => form_params,
1129
+ :body => post_body,
1130
+ :auth_names => auth_names,
1131
+ :return_type => 'SitePaging')
1132
+ if @api_client.config.debugging
1133
+ @api_client.config.logger.debug "API called: SitesApi#list_sites\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1134
+ end
1135
+ return data, status_code, headers
1136
+ end
1137
+
1138
+ # Update a site
1139
+ # **Note:** this endpoint is available in Alfresco 5.2 and newer versions. Update the details for the given site **siteId**. Site Manager or otherwise a (site) admin can update title, description or visibility. Note: the id of a site cannot be updated once the site has been created.
1140
+ # @param site_id The identifier of a site.
1141
+ # @param site_body_update The site information to update.
1142
+ # @param [Hash] opts the optional parameters
1143
+ # @option opts [Array<String>] :fields A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter.
1144
+ # @return [SiteEntry]
1145
+ def update_site(site_id, site_body_update, opts = {})
1146
+ data, _status_code, _headers = update_site_with_http_info(site_id, site_body_update, opts)
1147
+ return data
1148
+ end
1149
+
1150
+ # Update a site
1151
+ # **Note:** this endpoint is available in Alfresco 5.2 and newer versions. Update the details for the given site **siteId**. Site Manager or otherwise a (site) admin can update title, description or visibility. Note: the id of a site cannot be updated once the site has been created.
1152
+ # @param site_id The identifier of a site.
1153
+ # @param site_body_update The site information to update.
1154
+ # @param [Hash] opts the optional parameters
1155
+ # @option opts [Array<String>] :fields A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter.
1156
+ # @return [Array<(SiteEntry, Fixnum, Hash)>] SiteEntry data, response status code and response headers
1157
+ def update_site_with_http_info(site_id, site_body_update, opts = {})
1158
+ if @api_client.config.debugging
1159
+ @api_client.config.logger.debug "Calling API: SitesApi.update_site ..."
1160
+ end
1161
+ # verify the required parameter 'site_id' is set
1162
+ if @api_client.config.client_side_validation && site_id.nil?
1163
+ fail ArgumentError, "Missing the required parameter 'site_id' when calling SitesApi.update_site"
1164
+ end
1165
+ # verify the required parameter 'site_body_update' is set
1166
+ if @api_client.config.client_side_validation && site_body_update.nil?
1167
+ fail ArgumentError, "Missing the required parameter 'site_body_update' when calling SitesApi.update_site"
1168
+ end
1169
+ # resource path
1170
+ local_var_path = "/sites/{siteId}".sub('{' + 'siteId' + '}', site_id.to_s)
1171
+
1172
+ # query parameters
1173
+ query_params = {}
1174
+ query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
1175
+
1176
+ # header parameters
1177
+ header_params = {}
1178
+ # HTTP header 'Accept' (if needed)
1179
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1180
+ # HTTP header 'Content-Type'
1181
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1182
+
1183
+ # form parameters
1184
+ form_params = {}
1185
+
1186
+ # http body (model)
1187
+ post_body = @api_client.object_to_http_body(site_body_update)
1188
+ auth_names = ['basicAuth']
1189
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
1190
+ :header_params => header_params,
1191
+ :query_params => query_params,
1192
+ :form_params => form_params,
1193
+ :body => post_body,
1194
+ :auth_names => auth_names,
1195
+ :return_type => 'SiteEntry')
1196
+ if @api_client.config.debugging
1197
+ @api_client.config.logger.debug "API called: SitesApi#update_site\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1198
+ end
1199
+ return data, status_code, headers
1200
+ end
1201
+
1202
+ # Update a site membership
1203
+ # Update the membership of person **personId** in site **siteId**. You can use the `-me-` string in place of `<personId>` to specify the currently authenticated user. You can set the **role** to one of four types: * SiteConsumer * SiteCollaborator * SiteContributor * SiteManager
1204
+ # @param site_id The identifier of a site.
1205
+ # @param person_id The identifier of a person.
1206
+ # @param site_membership_body_update The persons new role
1207
+ # @param [Hash] opts the optional parameters
1208
+ # @option opts [Array<String>] :fields A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter.
1209
+ # @return [SiteMemberEntry]
1210
+ def update_site_membership(site_id, person_id, site_membership_body_update, opts = {})
1211
+ data, _status_code, _headers = update_site_membership_with_http_info(site_id, person_id, site_membership_body_update, opts)
1212
+ return data
1213
+ end
1214
+
1215
+ # Update a site membership
1216
+ # Update the membership of person **personId** in site **siteId**. You can use the &#x60;-me-&#x60; string in place of &#x60;&lt;personId&gt;&#x60; to specify the currently authenticated user. You can set the **role** to one of four types: * SiteConsumer * SiteCollaborator * SiteContributor * SiteManager
1217
+ # @param site_id The identifier of a site.
1218
+ # @param person_id The identifier of a person.
1219
+ # @param site_membership_body_update The persons new role
1220
+ # @param [Hash] opts the optional parameters
1221
+ # @option opts [Array<String>] :fields A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter.
1222
+ # @return [Array<(SiteMemberEntry, Fixnum, Hash)>] SiteMemberEntry data, response status code and response headers
1223
+ def update_site_membership_with_http_info(site_id, person_id, site_membership_body_update, opts = {})
1224
+ if @api_client.config.debugging
1225
+ @api_client.config.logger.debug "Calling API: SitesApi.update_site_membership ..."
1226
+ end
1227
+ # verify the required parameter 'site_id' is set
1228
+ if @api_client.config.client_side_validation && site_id.nil?
1229
+ fail ArgumentError, "Missing the required parameter 'site_id' when calling SitesApi.update_site_membership"
1230
+ end
1231
+ # verify the required parameter 'person_id' is set
1232
+ if @api_client.config.client_side_validation && person_id.nil?
1233
+ fail ArgumentError, "Missing the required parameter 'person_id' when calling SitesApi.update_site_membership"
1234
+ end
1235
+ # verify the required parameter 'site_membership_body_update' is set
1236
+ if @api_client.config.client_side_validation && site_membership_body_update.nil?
1237
+ fail ArgumentError, "Missing the required parameter 'site_membership_body_update' when calling SitesApi.update_site_membership"
1238
+ end
1239
+ # resource path
1240
+ local_var_path = "/sites/{siteId}/members/{personId}".sub('{' + 'siteId' + '}', site_id.to_s).sub('{' + 'personId' + '}', person_id.to_s)
1241
+
1242
+ # query parameters
1243
+ query_params = {}
1244
+ query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
1245
+
1246
+ # header parameters
1247
+ header_params = {}
1248
+ # HTTP header 'Accept' (if needed)
1249
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1250
+ # HTTP header 'Content-Type'
1251
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1252
+
1253
+ # form parameters
1254
+ form_params = {}
1255
+
1256
+ # http body (model)
1257
+ post_body = @api_client.object_to_http_body(site_membership_body_update)
1258
+ auth_names = ['basicAuth']
1259
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
1260
+ :header_params => header_params,
1261
+ :query_params => query_params,
1262
+ :form_params => form_params,
1263
+ :body => post_body,
1264
+ :auth_names => auth_names,
1265
+ :return_type => 'SiteMemberEntry')
1266
+ if @api_client.config.debugging
1267
+ @api_client.config.logger.debug "API called: SitesApi#update_site_membership\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1268
+ end
1269
+ return data, status_code, headers
1270
+ end
1271
+
1272
+ # Update a site membership request
1273
+ # Updates the message for the site membership request to site **siteId** for person **personId**. You can use the `-me-` string in place of `<personId>` to specify the currently authenticated user.
1274
+ # @param person_id The identifier of a person.
1275
+ # @param site_id The identifier of a site.
1276
+ # @param site_membership_request_body_update The new message to display
1277
+ # @param [Hash] opts the optional parameters
1278
+ # @option opts [Array<String>] :fields A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter.
1279
+ # @return [SiteMembershipRequestEntry]
1280
+ def update_site_membership_request_for_person(person_id, site_id, site_membership_request_body_update, opts = {})
1281
+ data, _status_code, _headers = update_site_membership_request_for_person_with_http_info(person_id, site_id, site_membership_request_body_update, opts)
1282
+ return data
1283
+ end
1284
+
1285
+ # Update a site membership request
1286
+ # Updates the message for the site membership request to site **siteId** for person **personId**. You can use the &#x60;-me-&#x60; string in place of &#x60;&lt;personId&gt;&#x60; to specify the currently authenticated user.
1287
+ # @param person_id The identifier of a person.
1288
+ # @param site_id The identifier of a site.
1289
+ # @param site_membership_request_body_update The new message to display
1290
+ # @param [Hash] opts the optional parameters
1291
+ # @option opts [Array<String>] :fields A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter.
1292
+ # @return [Array<(SiteMembershipRequestEntry, Fixnum, Hash)>] SiteMembershipRequestEntry data, response status code and response headers
1293
+ def update_site_membership_request_for_person_with_http_info(person_id, site_id, site_membership_request_body_update, opts = {})
1294
+ if @api_client.config.debugging
1295
+ @api_client.config.logger.debug "Calling API: SitesApi.update_site_membership_request_for_person ..."
1296
+ end
1297
+ # verify the required parameter 'person_id' is set
1298
+ if @api_client.config.client_side_validation && person_id.nil?
1299
+ fail ArgumentError, "Missing the required parameter 'person_id' when calling SitesApi.update_site_membership_request_for_person"
1300
+ end
1301
+ # verify the required parameter 'site_id' is set
1302
+ if @api_client.config.client_side_validation && site_id.nil?
1303
+ fail ArgumentError, "Missing the required parameter 'site_id' when calling SitesApi.update_site_membership_request_for_person"
1304
+ end
1305
+ # verify the required parameter 'site_membership_request_body_update' is set
1306
+ if @api_client.config.client_side_validation && site_membership_request_body_update.nil?
1307
+ fail ArgumentError, "Missing the required parameter 'site_membership_request_body_update' when calling SitesApi.update_site_membership_request_for_person"
1308
+ end
1309
+ # resource path
1310
+ local_var_path = "/people/{personId}/site-membership-requests/{siteId}".sub('{' + 'personId' + '}', person_id.to_s).sub('{' + 'siteId' + '}', site_id.to_s)
1311
+
1312
+ # query parameters
1313
+ query_params = {}
1314
+ query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
1315
+
1316
+ # header parameters
1317
+ header_params = {}
1318
+ # HTTP header 'Accept' (if needed)
1319
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1320
+ # HTTP header 'Content-Type'
1321
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1322
+
1323
+ # form parameters
1324
+ form_params = {}
1325
+
1326
+ # http body (model)
1327
+ post_body = @api_client.object_to_http_body(site_membership_request_body_update)
1328
+ auth_names = ['basicAuth']
1329
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
1330
+ :header_params => header_params,
1331
+ :query_params => query_params,
1332
+ :form_params => form_params,
1333
+ :body => post_body,
1334
+ :auth_names => auth_names,
1335
+ :return_type => 'SiteMembershipRequestEntry')
1336
+ if @api_client.config.debugging
1337
+ @api_client.config.logger.debug "API called: SitesApi#update_site_membership_request_for_person\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1338
+ end
1339
+ return data, status_code, headers
1340
+ end
1341
+ end
1342
+ end