alfresco_api 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/Gemfile +7 -0
- data/README.md +351 -0
- data/Rakefile +8 -0
- data/alfresco_api.gemspec +45 -0
- data/docs/ActivitiesApi.md +74 -0
- data/docs/Activity.md +14 -0
- data/docs/ActivityEntry.md +8 -0
- data/docs/ActivityPaging.md +8 -0
- data/docs/ActivityPagingList.md +9 -0
- data/docs/Association.md +9 -0
- data/docs/AssociationBody.md +9 -0
- data/docs/AssociationEntry.md +8 -0
- data/docs/AssociationInfo.md +8 -0
- data/docs/AuditApi.md +495 -0
- data/docs/AuditApp.md +10 -0
- data/docs/AuditAppEntry.md +8 -0
- data/docs/AuditAppPaging.md +8 -0
- data/docs/AuditAppPagingList.md +9 -0
- data/docs/AuditBodyUpdate.md +8 -0
- data/docs/AuditEntry.md +12 -0
- data/docs/AuditEntryEntry.md +8 -0
- data/docs/AuditEntryPaging.md +8 -0
- data/docs/AuditEntryPagingList.md +9 -0
- data/docs/ChildAssociation.md +9 -0
- data/docs/ChildAssociationBody.md +9 -0
- data/docs/ChildAssociationEntry.md +8 -0
- data/docs/ChildAssociationInfo.md +9 -0
- data/docs/ClientBody.md +8 -0
- data/docs/Comment.md +16 -0
- data/docs/CommentBody.md +8 -0
- data/docs/CommentEntry.md +8 -0
- data/docs/CommentPaging.md +8 -0
- data/docs/CommentPagingList.md +9 -0
- data/docs/CommentsApi.md +251 -0
- data/docs/Company.md +15 -0
- data/docs/ContentInfo.md +11 -0
- data/docs/DeletedNode.md +27 -0
- data/docs/DeletedNodeEntry.md +8 -0
- data/docs/DeletedNodesPaging.md +8 -0
- data/docs/DeletedNodesPagingList.md +9 -0
- data/docs/Download.md +13 -0
- data/docs/DownloadBodyCreate.md +8 -0
- data/docs/DownloadEntry.md +8 -0
- data/docs/DownloadsApi.md +177 -0
- data/docs/Error.md +8 -0
- data/docs/ErrorError.md +13 -0
- data/docs/Favorite.md +10 -0
- data/docs/FavoriteBodyCreate.md +8 -0
- data/docs/FavoriteEntry.md +8 -0
- data/docs/FavoritePaging.md +8 -0
- data/docs/FavoritePagingList.md +9 -0
- data/docs/FavoriteSite.md +8 -0
- data/docs/FavoriteSiteBodyCreate.md +8 -0
- data/docs/FavoriteSiteEntry.md +8 -0
- data/docs/FavoritesApi.md +496 -0
- data/docs/Group.md +12 -0
- data/docs/GroupBodyCreate.md +10 -0
- data/docs/GroupBodyUpdate.md +8 -0
- data/docs/GroupEntry.md +8 -0
- data/docs/GroupMember.md +10 -0
- data/docs/GroupMemberEntry.md +8 -0
- data/docs/GroupMemberPaging.md +8 -0
- data/docs/GroupMemberPagingList.md +9 -0
- data/docs/GroupMembershipBodyCreate.md +9 -0
- data/docs/GroupPaging.md +8 -0
- data/docs/GroupPagingList.md +9 -0
- data/docs/GroupsApi.md +564 -0
- data/docs/NetworkQuota.md +10 -0
- data/docs/NetworksApi.md +189 -0
- data/docs/Node.md +25 -0
- data/docs/NodeAssociation.md +26 -0
- data/docs/NodeAssociationEntry.md +8 -0
- data/docs/NodeAssociationPaging.md +8 -0
- data/docs/NodeAssociationPagingList.md +10 -0
- data/docs/NodeBodyCopy.md +9 -0
- data/docs/NodeBodyCreate.md +15 -0
- data/docs/NodeBodyCreateAssociation.md +8 -0
- data/docs/NodeBodyLock.md +10 -0
- data/docs/NodeBodyMove.md +9 -0
- data/docs/NodeBodyUpdate.md +12 -0
- data/docs/NodeChildAssociation.md +26 -0
- data/docs/NodeChildAssociationEntry.md +8 -0
- data/docs/NodeChildAssociationPaging.md +8 -0
- data/docs/NodeChildAssociationPagingList.md +10 -0
- data/docs/NodeEntry.md +8 -0
- data/docs/NodePaging.md +8 -0
- data/docs/NodePagingList.md +10 -0
- data/docs/NodesApi.md +1206 -0
- data/docs/Pagination.md +12 -0
- data/docs/PasswordResetBody.md +10 -0
- data/docs/PathElement.md +11 -0
- data/docs/PathInfo.md +10 -0
- data/docs/PeopleApi.md +530 -0
- data/docs/PermissionElement.md +10 -0
- data/docs/PermissionsBodyUpdate.md +9 -0
- data/docs/PermissionsInfo.md +11 -0
- data/docs/Person.md +27 -0
- data/docs/PersonBodyCreate.md +26 -0
- data/docs/PersonBodyUpdate.md +26 -0
- data/docs/PersonEntry.md +8 -0
- data/docs/PersonNetwork.md +14 -0
- data/docs/PersonNetworkEntry.md +8 -0
- data/docs/PersonNetworkPaging.md +8 -0
- data/docs/PersonNetworkPagingList.md +9 -0
- data/docs/PersonPaging.md +8 -0
- data/docs/PersonPagingList.md +9 -0
- data/docs/Preference.md +9 -0
- data/docs/PreferenceEntry.md +8 -0
- data/docs/PreferencePaging.md +8 -0
- data/docs/PreferencePagingList.md +9 -0
- data/docs/PreferencesApi.md +131 -0
- data/docs/QueriesApi.md +206 -0
- data/docs/Rating.md +11 -0
- data/docs/RatingAggregate.md +9 -0
- data/docs/RatingBody.md +9 -0
- data/docs/RatingEntry.md +8 -0
- data/docs/RatingPaging.md +8 -0
- data/docs/RatingPagingList.md +9 -0
- data/docs/RatingsApi.md +248 -0
- data/docs/Rendition.md +10 -0
- data/docs/RenditionBodyCreate.md +8 -0
- data/docs/RenditionEntry.md +8 -0
- data/docs/RenditionPaging.md +8 -0
- data/docs/RenditionPagingList.md +9 -0
- data/docs/RenditionsApi.md +243 -0
- data/docs/RevertBody.md +9 -0
- data/docs/SharedLink.md +19 -0
- data/docs/SharedLinkBodyCreate.md +9 -0
- data/docs/SharedLinkBodyEmail.md +11 -0
- data/docs/SharedLinkEntry.md +8 -0
- data/docs/SharedLinkPaging.md +8 -0
- data/docs/SharedLinkPagingList.md +9 -0
- data/docs/SharedlinksApi.md +530 -0
- data/docs/Site.md +14 -0
- data/docs/SiteBodyCreate.md +11 -0
- data/docs/SiteBodyUpdate.md +10 -0
- data/docs/SiteContainer.md +9 -0
- data/docs/SiteContainerEntry.md +8 -0
- data/docs/SiteContainerPaging.md +8 -0
- data/docs/SiteContainerPagingList.md +9 -0
- data/docs/SiteEntry.md +8 -0
- data/docs/SiteMember.md +10 -0
- data/docs/SiteMemberEntry.md +8 -0
- data/docs/SiteMemberPaging.md +8 -0
- data/docs/SiteMemberPagingList.md +9 -0
- data/docs/SiteMembershipBodyCreate.md +9 -0
- data/docs/SiteMembershipBodyUpdate.md +8 -0
- data/docs/SiteMembershipRequest.md +11 -0
- data/docs/SiteMembershipRequestBodyCreate.md +10 -0
- data/docs/SiteMembershipRequestBodyUpdate.md +8 -0
- data/docs/SiteMembershipRequestEntry.md +8 -0
- data/docs/SiteMembershipRequestPaging.md +8 -0
- data/docs/SiteMembershipRequestPagingList.md +9 -0
- data/docs/SitePaging.md +8 -0
- data/docs/SitePagingList.md +9 -0
- data/docs/SiteRole.md +11 -0
- data/docs/SiteRoleEntry.md +8 -0
- data/docs/SiteRolePaging.md +8 -0
- data/docs/SiteRolePagingList.md +9 -0
- data/docs/SitesApi.md +1225 -0
- data/docs/Tag.md +9 -0
- data/docs/TagBody.md +8 -0
- data/docs/TagEntry.md +8 -0
- data/docs/TagPaging.md +8 -0
- data/docs/TagPagingList.md +9 -0
- data/docs/TagsApi.md +365 -0
- data/docs/TrashcanApi.md +474 -0
- data/docs/UserInfo.md +9 -0
- data/docs/Version.md +18 -0
- data/docs/VersionEntry.md +8 -0
- data/docs/VersionPaging.md +8 -0
- data/docs/VersionPagingList.md +9 -0
- data/docs/VersionsApi.md +311 -0
- data/git_push.sh +55 -0
- data/lib/alfresco_api.rb +208 -0
- data/lib/alfresco_api/api/activities_api.rb +101 -0
- data/lib/alfresco_api/api/audit_api.rb +558 -0
- data/lib/alfresco_api/api/comments_api.rb +289 -0
- data/lib/alfresco_api/api/downloads_api.rb +193 -0
- data/lib/alfresco_api/api/favorites_api.rb +555 -0
- data/lib/alfresco_api/api/groups_api.rb +627 -0
- data/lib/alfresco_api/api/networks_api.rb +217 -0
- data/lib/alfresco_api/api/nodes_api.rb +1314 -0
- data/lib/alfresco_api/api/people_api.rb +572 -0
- data/lib/alfresco_api/api/preferences_api.rb +159 -0
- data/lib/alfresco_api/api/queries_api.rb +260 -0
- data/lib/alfresco_api/api/ratings_api.rb +283 -0
- data/lib/alfresco_api/api/renditions_api.rb +271 -0
- data/lib/alfresco_api/api/sharedlinks_api.rb +570 -0
- data/lib/alfresco_api/api/sites_api.rb +1342 -0
- data/lib/alfresco_api/api/tags_api.rb +407 -0
- data/lib/alfresco_api/api/trashcan_api.rb +507 -0
- data/lib/alfresco_api/api/versions_api.rb +355 -0
- data/lib/alfresco_api/api_client.rb +389 -0
- data/lib/alfresco_api/api_error.rb +38 -0
- data/lib/alfresco_api/configuration.rb +209 -0
- data/lib/alfresco_api/models/activity.rb +271 -0
- data/lib/alfresco_api/models/activity_entry.rb +193 -0
- data/lib/alfresco_api/models/activity_paging.rb +188 -0
- data/lib/alfresco_api/models/activity_paging_list.rb +209 -0
- data/lib/alfresco_api/models/association.rb +207 -0
- data/lib/alfresco_api/models/association_body.rb +207 -0
- data/lib/alfresco_api/models/association_entry.rb +193 -0
- data/lib/alfresco_api/models/association_info.rb +193 -0
- data/lib/alfresco_api/models/audit_app.rb +213 -0
- data/lib/alfresco_api/models/audit_app_entry.rb +188 -0
- data/lib/alfresco_api/models/audit_app_paging.rb +188 -0
- data/lib/alfresco_api/models/audit_app_paging_list.rb +199 -0
- data/lib/alfresco_api/models/audit_body_update.rb +188 -0
- data/lib/alfresco_api/models/audit_entry.rb +246 -0
- data/lib/alfresco_api/models/audit_entry_entry.rb +188 -0
- data/lib/alfresco_api/models/audit_entry_paging.rb +188 -0
- data/lib/alfresco_api/models/audit_entry_paging_list.rb +199 -0
- data/lib/alfresco_api/models/child_association.rb +207 -0
- data/lib/alfresco_api/models/child_association_body.rb +207 -0
- data/lib/alfresco_api/models/child_association_entry.rb +193 -0
- data/lib/alfresco_api/models/child_association_info.rb +207 -0
- data/lib/alfresco_api/models/client_body.rb +194 -0
- data/lib/alfresco_api/models/comment.rb +305 -0
- data/lib/alfresco_api/models/comment_body.rb +193 -0
- data/lib/alfresco_api/models/comment_entry.rb +193 -0
- data/lib/alfresco_api/models/comment_paging.rb +188 -0
- data/lib/alfresco_api/models/comment_paging_list.rb +209 -0
- data/lib/alfresco_api/models/company.rb +251 -0
- data/lib/alfresco_api/models/content_info.rb +230 -0
- data/lib/alfresco_api/models/deleted_node.rb +440 -0
- data/lib/alfresco_api/models/deleted_node_entry.rb +188 -0
- data/lib/alfresco_api/models/deleted_nodes_paging.rb +188 -0
- data/lib/alfresco_api/models/deleted_nodes_paging_list.rb +199 -0
- data/lib/alfresco_api/models/download.rb +274 -0
- data/lib/alfresco_api/models/download_body_create.rb +195 -0
- data/lib/alfresco_api/models/download_entry.rb +193 -0
- data/lib/alfresco_api/models/error.rb +188 -0
- data/lib/alfresco_api/models/error_error.rb +253 -0
- data/lib/alfresco_api/models/favorite.rb +218 -0
- data/lib/alfresco_api/models/favorite_body_create.rb +193 -0
- data/lib/alfresco_api/models/favorite_entry.rb +193 -0
- data/lib/alfresco_api/models/favorite_paging.rb +188 -0
- data/lib/alfresco_api/models/favorite_paging_list.rb +209 -0
- data/lib/alfresco_api/models/favorite_site.rb +193 -0
- data/lib/alfresco_api/models/favorite_site_body_create.rb +193 -0
- data/lib/alfresco_api/models/favorite_site_entry.rb +193 -0
- data/lib/alfresco_api/models/group.rb +245 -0
- data/lib/alfresco_api/models/group_body_create.rb +218 -0
- data/lib/alfresco_api/models/group_body_update.rb +193 -0
- data/lib/alfresco_api/models/group_entry.rb +193 -0
- data/lib/alfresco_api/models/group_member.rb +254 -0
- data/lib/alfresco_api/models/group_member_entry.rb +193 -0
- data/lib/alfresco_api/models/group_member_paging.rb +188 -0
- data/lib/alfresco_api/models/group_member_paging_list.rb +199 -0
- data/lib/alfresco_api/models/group_membership_body_create.rb +240 -0
- data/lib/alfresco_api/models/group_paging.rb +188 -0
- data/lib/alfresco_api/models/group_paging_list.rb +199 -0
- data/lib/alfresco_api/models/network_quota.rb +221 -0
- data/lib/alfresco_api/models/node.rb +412 -0
- data/lib/alfresco_api/models/node_association.rb +421 -0
- data/lib/alfresco_api/models/node_association_entry.rb +193 -0
- data/lib/alfresco_api/models/node_association_paging.rb +188 -0
- data/lib/alfresco_api/models/node_association_paging_list.rb +208 -0
- data/lib/alfresco_api/models/node_body_copy.rb +219 -0
- data/lib/alfresco_api/models/node_body_create.rb +289 -0
- data/lib/alfresco_api/models/node_body_create_association.rb +188 -0
- data/lib/alfresco_api/models/node_body_lock.rb +271 -0
- data/lib/alfresco_api/models/node_body_move.rb +219 -0
- data/lib/alfresco_api/models/node_body_update.rb +245 -0
- data/lib/alfresco_api/models/node_child_association.rb +421 -0
- data/lib/alfresco_api/models/node_child_association_entry.rb +193 -0
- data/lib/alfresco_api/models/node_child_association_paging.rb +188 -0
- data/lib/alfresco_api/models/node_child_association_paging_list.rb +208 -0
- data/lib/alfresco_api/models/node_entry.rb +193 -0
- data/lib/alfresco_api/models/node_paging.rb +188 -0
- data/lib/alfresco_api/models/node_paging_list.rb +208 -0
- data/lib/alfresco_api/models/pagination.rb +249 -0
- data/lib/alfresco_api/models/password_reset_body.rb +224 -0
- data/lib/alfresco_api/models/path_element.rb +217 -0
- data/lib/alfresco_api/models/path_info.rb +208 -0
- data/lib/alfresco_api/models/permission_element.rb +241 -0
- data/lib/alfresco_api/models/permissions_body_update.rb +199 -0
- data/lib/alfresco_api/models/permissions_info.rb +221 -0
- data/lib/alfresco_api/models/person.rb +387 -0
- data/lib/alfresco_api/models/person_body_create.rb +378 -0
- data/lib/alfresco_api/models/person_body_update.rb +354 -0
- data/lib/alfresco_api/models/person_entry.rb +193 -0
- data/lib/alfresco_api/models/person_network.rb +289 -0
- data/lib/alfresco_api/models/person_network_entry.rb +193 -0
- data/lib/alfresco_api/models/person_network_paging.rb +188 -0
- data/lib/alfresco_api/models/person_network_paging_list.rb +209 -0
- data/lib/alfresco_api/models/person_paging.rb +188 -0
- data/lib/alfresco_api/models/person_paging_list.rb +199 -0
- data/lib/alfresco_api/models/preference.rb +204 -0
- data/lib/alfresco_api/models/preference_entry.rb +193 -0
- data/lib/alfresco_api/models/preference_paging.rb +188 -0
- data/lib/alfresco_api/models/preference_paging_list.rb +209 -0
- data/lib/alfresco_api/models/rating.rb +221 -0
- data/lib/alfresco_api/models/rating_aggregate.rb +202 -0
- data/lib/alfresco_api/models/rating_body.rb +244 -0
- data/lib/alfresco_api/models/rating_entry.rb +193 -0
- data/lib/alfresco_api/models/rating_paging.rb +188 -0
- data/lib/alfresco_api/models/rating_paging_list.rb +209 -0
- data/lib/alfresco_api/models/rendition.rb +239 -0
- data/lib/alfresco_api/models/rendition_body_create.rb +193 -0
- data/lib/alfresco_api/models/rendition_entry.rb +193 -0
- data/lib/alfresco_api/models/rendition_paging.rb +188 -0
- data/lib/alfresco_api/models/rendition_paging_list.rb +199 -0
- data/lib/alfresco_api/models/revert_body.rb +197 -0
- data/lib/alfresco_api/models/shared_link.rb +310 -0
- data/lib/alfresco_api/models/shared_link_body_create.rb +202 -0
- data/lib/alfresco_api/models/shared_link_body_email.rb +217 -0
- data/lib/alfresco_api/models/shared_link_entry.rb +193 -0
- data/lib/alfresco_api/models/shared_link_paging.rb +188 -0
- data/lib/alfresco_api/models/shared_link_paging_list.rb +209 -0
- data/lib/alfresco_api/models/site.rb +307 -0
- data/lib/alfresco_api/models/site_body_create.rb +260 -0
- data/lib/alfresco_api/models/site_body_update.rb +239 -0
- data/lib/alfresco_api/models/site_container.rb +207 -0
- data/lib/alfresco_api/models/site_container_entry.rb +193 -0
- data/lib/alfresco_api/models/site_container_paging.rb +188 -0
- data/lib/alfresco_api/models/site_container_paging_list.rb +209 -0
- data/lib/alfresco_api/models/site_entry.rb +193 -0
- data/lib/alfresco_api/models/site_member.rb +254 -0
- data/lib/alfresco_api/models/site_member_entry.rb +193 -0
- data/lib/alfresco_api/models/site_member_paging.rb +188 -0
- data/lib/alfresco_api/models/site_member_paging_list.rb +209 -0
- data/lib/alfresco_api/models/site_membership_body_create.rb +240 -0
- data/lib/alfresco_api/models/site_membership_body_update.rb +226 -0
- data/lib/alfresco_api/models/site_membership_request.rb +230 -0
- data/lib/alfresco_api/models/site_membership_request_body_create.rb +211 -0
- data/lib/alfresco_api/models/site_membership_request_body_update.rb +188 -0
- data/lib/alfresco_api/models/site_membership_request_entry.rb +193 -0
- data/lib/alfresco_api/models/site_membership_request_paging.rb +188 -0
- data/lib/alfresco_api/models/site_membership_request_paging_list.rb +209 -0
- data/lib/alfresco_api/models/site_paging.rb +188 -0
- data/lib/alfresco_api/models/site_paging_list.rb +209 -0
- data/lib/alfresco_api/models/site_role.rb +268 -0
- data/lib/alfresco_api/models/site_role_entry.rb +193 -0
- data/lib/alfresco_api/models/site_role_paging.rb +188 -0
- data/lib/alfresco_api/models/site_role_paging_list.rb +209 -0
- data/lib/alfresco_api/models/tag.rb +207 -0
- data/lib/alfresco_api/models/tag_body.rb +193 -0
- data/lib/alfresco_api/models/tag_entry.rb +193 -0
- data/lib/alfresco_api/models/tag_paging.rb +188 -0
- data/lib/alfresco_api/models/tag_paging_list.rb +209 -0
- data/lib/alfresco_api/models/user_info.rb +207 -0
- data/lib/alfresco_api/models/version.rb +337 -0
- data/lib/alfresco_api/models/version_entry.rb +188 -0
- data/lib/alfresco_api/models/version_paging.rb +188 -0
- data/lib/alfresco_api/models/version_paging_list.rb +199 -0
- data/lib/alfresco_api/version.rb +15 -0
- data/spec/api/activities_api_spec.rb +52 -0
- data/spec/api/audit_api_spec.rb +152 -0
- data/spec/api/comments_api_spec.rb +92 -0
- data/spec/api/downloads_api_spec.rb +73 -0
- data/spec/api/favorites_api_spec.rb +151 -0
- data/spec/api/groups_api_spec.rb +170 -0
- data/spec/api/networks_api_spec.rb +77 -0
- data/spec/api/nodes_api_spec.rb +327 -0
- data/spec/api/people_api_spec.rb +157 -0
- data/spec/api/preferences_api_spec.rb +64 -0
- data/spec/api/queries_api_spec.rb +86 -0
- data/spec/api/ratings_api_spec.rb +91 -0
- data/spec/api/renditions_api_spec.rb +90 -0
- data/spec/api/sharedlinks_api_spec.rb +157 -0
- data/spec/api/sites_api_spec.rb +323 -0
- data/spec/api/tags_api_spec.rb +118 -0
- data/spec/api/trashcan_api_spec.rb +143 -0
- data/spec/api/versions_api_spec.rb +107 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/activity_entry_spec.rb +42 -0
- data/spec/models/activity_paging_list_spec.rb +48 -0
- data/spec/models/activity_paging_spec.rb +42 -0
- data/spec/models/activity_spec.rb +78 -0
- data/spec/models/association_body_spec.rb +48 -0
- data/spec/models/association_entry_spec.rb +42 -0
- data/spec/models/association_info_spec.rb +42 -0
- data/spec/models/association_spec.rb +48 -0
- data/spec/models/audit_app_entry_spec.rb +42 -0
- data/spec/models/audit_app_paging_list_spec.rb +48 -0
- data/spec/models/audit_app_paging_spec.rb +42 -0
- data/spec/models/audit_app_spec.rb +54 -0
- data/spec/models/audit_body_update_spec.rb +42 -0
- data/spec/models/audit_entry_entry_spec.rb +42 -0
- data/spec/models/audit_entry_paging_list_spec.rb +48 -0
- data/spec/models/audit_entry_paging_spec.rb +42 -0
- data/spec/models/audit_entry_spec.rb +66 -0
- data/spec/models/child_association_body_spec.rb +48 -0
- data/spec/models/child_association_entry_spec.rb +42 -0
- data/spec/models/child_association_info_spec.rb +48 -0
- data/spec/models/child_association_spec.rb +48 -0
- data/spec/models/client_body_spec.rb +42 -0
- data/spec/models/comment_body_spec.rb +42 -0
- data/spec/models/comment_entry_spec.rb +42 -0
- data/spec/models/comment_paging_list_spec.rb +48 -0
- data/spec/models/comment_paging_spec.rb +42 -0
- data/spec/models/comment_spec.rb +90 -0
- data/spec/models/company_spec.rb +84 -0
- data/spec/models/content_info_spec.rb +60 -0
- data/spec/models/deleted_node_entry_spec.rb +42 -0
- data/spec/models/deleted_node_spec.rb +156 -0
- data/spec/models/deleted_nodes_paging_list_spec.rb +48 -0
- data/spec/models/deleted_nodes_paging_spec.rb +42 -0
- data/spec/models/download_body_create_spec.rb +42 -0
- data/spec/models/download_entry_spec.rb +42 -0
- data/spec/models/download_spec.rb +76 -0
- data/spec/models/error_error_spec.rb +72 -0
- data/spec/models/error_spec.rb +42 -0
- data/spec/models/favorite_body_create_spec.rb +42 -0
- data/spec/models/favorite_entry_spec.rb +42 -0
- data/spec/models/favorite_paging_list_spec.rb +48 -0
- data/spec/models/favorite_paging_spec.rb +42 -0
- data/spec/models/favorite_site_body_create_spec.rb +42 -0
- data/spec/models/favorite_site_entry_spec.rb +42 -0
- data/spec/models/favorite_site_spec.rb +42 -0
- data/spec/models/favorite_spec.rb +54 -0
- data/spec/models/group_body_create_spec.rb +54 -0
- data/spec/models/group_body_update_spec.rb +42 -0
- data/spec/models/group_entry_spec.rb +42 -0
- data/spec/models/group_member_entry_spec.rb +42 -0
- data/spec/models/group_member_paging_list_spec.rb +48 -0
- data/spec/models/group_member_paging_spec.rb +42 -0
- data/spec/models/group_member_spec.rb +58 -0
- data/spec/models/group_membership_body_create_spec.rb +52 -0
- data/spec/models/group_paging_list_spec.rb +48 -0
- data/spec/models/group_paging_spec.rb +42 -0
- data/spec/models/group_spec.rb +66 -0
- data/spec/models/network_quota_spec.rb +54 -0
- data/spec/models/node_association_entry_spec.rb +42 -0
- data/spec/models/node_association_paging_list_spec.rb +54 -0
- data/spec/models/node_association_paging_spec.rb +42 -0
- data/spec/models/node_association_spec.rb +150 -0
- data/spec/models/node_body_copy_spec.rb +48 -0
- data/spec/models/node_body_create_association_spec.rb +42 -0
- data/spec/models/node_body_create_spec.rb +84 -0
- data/spec/models/node_body_lock_spec.rb +62 -0
- data/spec/models/node_body_move_spec.rb +48 -0
- data/spec/models/node_body_update_spec.rb +66 -0
- data/spec/models/node_child_association_entry_spec.rb +42 -0
- data/spec/models/node_child_association_paging_list_spec.rb +54 -0
- data/spec/models/node_child_association_paging_spec.rb +42 -0
- data/spec/models/node_child_association_spec.rb +150 -0
- data/spec/models/node_entry_spec.rb +42 -0
- data/spec/models/node_paging_list_spec.rb +54 -0
- data/spec/models/node_paging_spec.rb +42 -0
- data/spec/models/node_spec.rb +144 -0
- data/spec/models/pagination_spec.rb +66 -0
- data/spec/models/password_reset_body_spec.rb +54 -0
- data/spec/models/path_element_spec.rb +60 -0
- data/spec/models/path_info_spec.rb +54 -0
- data/spec/models/permission_element_spec.rb +58 -0
- data/spec/models/permissions_body_update_spec.rb +48 -0
- data/spec/models/permissions_info_spec.rb +60 -0
- data/spec/models/person_body_create_spec.rb +150 -0
- data/spec/models/person_body_update_spec.rb +150 -0
- data/spec/models/person_entry_spec.rb +42 -0
- data/spec/models/person_network_entry_spec.rb +42 -0
- data/spec/models/person_network_paging_list_spec.rb +48 -0
- data/spec/models/person_network_paging_spec.rb +42 -0
- data/spec/models/person_network_spec.rb +82 -0
- data/spec/models/person_paging_list_spec.rb +48 -0
- data/spec/models/person_paging_spec.rb +42 -0
- data/spec/models/person_spec.rb +156 -0
- data/spec/models/preference_entry_spec.rb +42 -0
- data/spec/models/preference_paging_list_spec.rb +48 -0
- data/spec/models/preference_paging_spec.rb +42 -0
- data/spec/models/preference_spec.rb +48 -0
- data/spec/models/rating_aggregate_spec.rb +48 -0
- data/spec/models/rating_body_spec.rb +52 -0
- data/spec/models/rating_entry_spec.rb +42 -0
- data/spec/models/rating_paging_list_spec.rb +48 -0
- data/spec/models/rating_paging_spec.rb +42 -0
- data/spec/models/rating_spec.rb +60 -0
- data/spec/models/rendition_body_create_spec.rb +42 -0
- data/spec/models/rendition_entry_spec.rb +42 -0
- data/spec/models/rendition_paging_list_spec.rb +48 -0
- data/spec/models/rendition_paging_spec.rb +42 -0
- data/spec/models/rendition_spec.rb +58 -0
- data/spec/models/revert_body_spec.rb +48 -0
- data/spec/models/shared_link_body_create_spec.rb +48 -0
- data/spec/models/shared_link_body_email_spec.rb +60 -0
- data/spec/models/shared_link_entry_spec.rb +42 -0
- data/spec/models/shared_link_paging_list_spec.rb +48 -0
- data/spec/models/shared_link_paging_spec.rb +42 -0
- data/spec/models/shared_link_spec.rb +108 -0
- data/spec/models/site_body_create_spec.rb +64 -0
- data/spec/models/site_body_update_spec.rb +58 -0
- data/spec/models/site_container_entry_spec.rb +42 -0
- data/spec/models/site_container_paging_list_spec.rb +48 -0
- data/spec/models/site_container_paging_spec.rb +42 -0
- data/spec/models/site_container_spec.rb +48 -0
- data/spec/models/site_entry_spec.rb +42 -0
- data/spec/models/site_member_entry_spec.rb +42 -0
- data/spec/models/site_member_paging_list_spec.rb +48 -0
- data/spec/models/site_member_paging_spec.rb +42 -0
- data/spec/models/site_member_spec.rb +58 -0
- data/spec/models/site_membership_body_create_spec.rb +52 -0
- data/spec/models/site_membership_body_update_spec.rb +46 -0
- data/spec/models/site_membership_request_body_create_spec.rb +54 -0
- data/spec/models/site_membership_request_body_update_spec.rb +42 -0
- data/spec/models/site_membership_request_entry_spec.rb +42 -0
- data/spec/models/site_membership_request_paging_list_spec.rb +48 -0
- data/spec/models/site_membership_request_paging_spec.rb +42 -0
- data/spec/models/site_membership_request_spec.rb +60 -0
- data/spec/models/site_paging_list_spec.rb +48 -0
- data/spec/models/site_paging_spec.rb +42 -0
- data/spec/models/site_role_entry_spec.rb +42 -0
- data/spec/models/site_role_paging_list_spec.rb +48 -0
- data/spec/models/site_role_paging_spec.rb +42 -0
- data/spec/models/site_role_spec.rb +64 -0
- data/spec/models/site_spec.rb +86 -0
- data/spec/models/tag_body_spec.rb +42 -0
- data/spec/models/tag_entry_spec.rb +42 -0
- data/spec/models/tag_paging_list_spec.rb +48 -0
- data/spec/models/tag_paging_spec.rb +42 -0
- data/spec/models/tag_spec.rb +48 -0
- data/spec/models/user_info_spec.rb +48 -0
- data/spec/models/version_entry_spec.rb +42 -0
- data/spec/models/version_paging_list_spec.rb +48 -0
- data/spec/models/version_paging_spec.rb +42 -0
- data/spec/models/version_spec.rb +102 -0
- data/spec/spec_helper.rb +111 -0
- metadata +918 -0
@@ -0,0 +1,159 @@
|
|
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 PreferencesApi
|
17
|
+
attr_accessor :api_client
|
18
|
+
|
19
|
+
def initialize(api_client = ApiClient.default)
|
20
|
+
@api_client = api_client
|
21
|
+
end
|
22
|
+
|
23
|
+
# Get a preference
|
24
|
+
# Gets a specific preference for person **personId**. You can use the `-me-` string in place of `<personId>` to specify the currently authenticated user.
|
25
|
+
# @param person_id The identifier of a person.
|
26
|
+
# @param preference_name The name of the preference.
|
27
|
+
# @param [Hash] opts the optional parameters
|
28
|
+
# @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.
|
29
|
+
# @return [PreferenceEntry]
|
30
|
+
def get_preference(person_id, preference_name, opts = {})
|
31
|
+
data, _status_code, _headers = get_preference_with_http_info(person_id, preference_name, opts)
|
32
|
+
return data
|
33
|
+
end
|
34
|
+
|
35
|
+
# Get a preference
|
36
|
+
# Gets a specific preference for person **personId**. You can use the `-me-` string in place of `<personId>` to specify the currently authenticated user.
|
37
|
+
# @param person_id The identifier of a person.
|
38
|
+
# @param preference_name The name of the preference.
|
39
|
+
# @param [Hash] opts the optional parameters
|
40
|
+
# @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.
|
41
|
+
# @return [Array<(PreferenceEntry, Fixnum, Hash)>] PreferenceEntry data, response status code and response headers
|
42
|
+
def get_preference_with_http_info(person_id, preference_name, opts = {})
|
43
|
+
if @api_client.config.debugging
|
44
|
+
@api_client.config.logger.debug "Calling API: PreferencesApi.get_preference ..."
|
45
|
+
end
|
46
|
+
# verify the required parameter 'person_id' is set
|
47
|
+
if @api_client.config.client_side_validation && person_id.nil?
|
48
|
+
fail ArgumentError, "Missing the required parameter 'person_id' when calling PreferencesApi.get_preference"
|
49
|
+
end
|
50
|
+
# verify the required parameter 'preference_name' is set
|
51
|
+
if @api_client.config.client_side_validation && preference_name.nil?
|
52
|
+
fail ArgumentError, "Missing the required parameter 'preference_name' when calling PreferencesApi.get_preference"
|
53
|
+
end
|
54
|
+
# resource path
|
55
|
+
local_var_path = "/people/{personId}/preferences/{preferenceName}".sub('{' + 'personId' + '}', person_id.to_s).sub('{' + 'preferenceName' + '}', preference_name.to_s)
|
56
|
+
|
57
|
+
# query parameters
|
58
|
+
query_params = {}
|
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 = nil
|
73
|
+
auth_names = ['basicAuth']
|
74
|
+
data, status_code, headers = @api_client.call_api(:GET, 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 => 'PreferenceEntry')
|
81
|
+
if @api_client.config.debugging
|
82
|
+
@api_client.config.logger.debug "API called: PreferencesApi#get_preference\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
83
|
+
end
|
84
|
+
return data, status_code, headers
|
85
|
+
end
|
86
|
+
|
87
|
+
# List preferences
|
88
|
+
# Gets a list of preferences for person **personId**. You can use the `-me-` string in place of `<personId>` to specify the currently authenticated user. Note that each preference consists of an **id** and a **value**. The **value** can be of any JSON type.
|
89
|
+
# @param person_id The identifier of a person.
|
90
|
+
# @param [Hash] opts the optional parameters
|
91
|
+
# @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)
|
92
|
+
# @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)
|
93
|
+
# @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.
|
94
|
+
# @return [PreferencePaging]
|
95
|
+
def list_preferences(person_id, opts = {})
|
96
|
+
data, _status_code, _headers = list_preferences_with_http_info(person_id, opts)
|
97
|
+
return data
|
98
|
+
end
|
99
|
+
|
100
|
+
# List preferences
|
101
|
+
# Gets a list of preferences for person **personId**. You can use the `-me-` string in place of `<personId>` to specify the currently authenticated user. Note that each preference consists of an **id** and a **value**. The **value** can be of any JSON type.
|
102
|
+
# @param person_id The identifier of a person.
|
103
|
+
# @param [Hash] opts the optional parameters
|
104
|
+
# @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.
|
105
|
+
# @option opts [Integer] :max_items The maximum number of items to return in the list. If not supplied then the default value is 100.
|
106
|
+
# @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.
|
107
|
+
# @return [Array<(PreferencePaging, Fixnum, Hash)>] PreferencePaging data, response status code and response headers
|
108
|
+
def list_preferences_with_http_info(person_id, opts = {})
|
109
|
+
if @api_client.config.debugging
|
110
|
+
@api_client.config.logger.debug "Calling API: PreferencesApi.list_preferences ..."
|
111
|
+
end
|
112
|
+
# verify the required parameter 'person_id' is set
|
113
|
+
if @api_client.config.client_side_validation && person_id.nil?
|
114
|
+
fail ArgumentError, "Missing the required parameter 'person_id' when calling PreferencesApi.list_preferences"
|
115
|
+
end
|
116
|
+
if @api_client.config.client_side_validation && !opts[:'skip_count'].nil? && opts[:'skip_count'] < 0
|
117
|
+
fail ArgumentError, 'invalid value for "opts[:"skip_count"]" when calling PreferencesApi.list_preferences, must be greater than or equal to 0.'
|
118
|
+
end
|
119
|
+
|
120
|
+
if @api_client.config.client_side_validation && !opts[:'max_items'].nil? && opts[:'max_items'] < 1
|
121
|
+
fail ArgumentError, 'invalid value for "opts[:"max_items"]" when calling PreferencesApi.list_preferences, must be greater than or equal to 1.'
|
122
|
+
end
|
123
|
+
|
124
|
+
# resource path
|
125
|
+
local_var_path = "/people/{personId}/preferences".sub('{' + 'personId' + '}', person_id.to_s)
|
126
|
+
|
127
|
+
# query parameters
|
128
|
+
query_params = {}
|
129
|
+
query_params[:'skipCount'] = opts[:'skip_count'] if !opts[:'skip_count'].nil?
|
130
|
+
query_params[:'maxItems'] = opts[:'max_items'] if !opts[:'max_items'].nil?
|
131
|
+
query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
|
132
|
+
|
133
|
+
# header parameters
|
134
|
+
header_params = {}
|
135
|
+
# HTTP header 'Accept' (if needed)
|
136
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
137
|
+
# HTTP header 'Content-Type'
|
138
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
139
|
+
|
140
|
+
# form parameters
|
141
|
+
form_params = {}
|
142
|
+
|
143
|
+
# http body (model)
|
144
|
+
post_body = nil
|
145
|
+
auth_names = ['basicAuth']
|
146
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
147
|
+
:header_params => header_params,
|
148
|
+
:query_params => query_params,
|
149
|
+
:form_params => form_params,
|
150
|
+
:body => post_body,
|
151
|
+
:auth_names => auth_names,
|
152
|
+
:return_type => 'PreferencePaging')
|
153
|
+
if @api_client.config.debugging
|
154
|
+
@api_client.config.logger.debug "API called: PreferencesApi#list_preferences\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
155
|
+
end
|
156
|
+
return data, status_code, headers
|
157
|
+
end
|
158
|
+
end
|
159
|
+
end
|
@@ -0,0 +1,260 @@
|
|
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 QueriesApi
|
17
|
+
attr_accessor :api_client
|
18
|
+
|
19
|
+
def initialize(api_client = ApiClient.default)
|
20
|
+
@api_client = api_client
|
21
|
+
end
|
22
|
+
|
23
|
+
# Find nodes
|
24
|
+
# **Note:** this endpoint is available in Alfresco 5.2 and newer versions. Gets a list of nodes that match the given search criteria. The search term is used to look for nodes that match against name, title, description, full text content or tags. The search term: - must contain a minimum of 3 alphanumeric characters - allows \"quoted term\" - can optionally use '*' for wildcard matching By default, file and folder types will be searched unless a specific type is provided as a query parameter. By default, the search will be across the repository unless a specific root node id is provided to start the search from. You can sort the result list using the **orderBy** parameter. You can specify one or more of the following fields in the **orderBy** parameter: * name * modifiedAt * createdAt
|
25
|
+
# @param term The term to search for.
|
26
|
+
# @param [Hash] opts the optional parameters
|
27
|
+
# @option opts [String] :root_node_id The id of the node to start the search from. Supports the aliases -my-, -root- and -shared-.
|
28
|
+
# @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)
|
29
|
+
# @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)
|
30
|
+
# @option opts [String] :node_type Restrict the returned results to only those of the given node type and its sub-types
|
31
|
+
# @option opts [Array<String>] :include Returns additional information about the node. The following optional fields can be requested: * allowableOperations * aspectNames * isLink * isLocked * path * properties
|
32
|
+
# @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.
|
33
|
+
# @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.
|
34
|
+
# @return [NodePaging]
|
35
|
+
def find_nodes(term, opts = {})
|
36
|
+
data, _status_code, _headers = find_nodes_with_http_info(term, opts)
|
37
|
+
return data
|
38
|
+
end
|
39
|
+
|
40
|
+
# Find nodes
|
41
|
+
# **Note:** this endpoint is available in Alfresco 5.2 and newer versions. Gets a list of nodes that match the given search criteria. The search term is used to look for nodes that match against name, title, description, full text content or tags. The search term: - must contain a minimum of 3 alphanumeric characters - allows \"quoted term\" - can optionally use '*' for wildcard matching By default, file and folder types will be searched unless a specific type is provided as a query parameter. By default, the search will be across the repository unless a specific root node id is provided to start the search from. You can sort the result list using the **orderBy** parameter. You can specify one or more of the following fields in the **orderBy** parameter: * name * modifiedAt * createdAt
|
42
|
+
# @param term The term to search for.
|
43
|
+
# @param [Hash] opts the optional parameters
|
44
|
+
# @option opts [String] :root_node_id The id of the node to start the search from. Supports the aliases -my-, -root- and -shared-.
|
45
|
+
# @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.
|
46
|
+
# @option opts [Integer] :max_items The maximum number of items to return in the list. If not supplied then the default value is 100.
|
47
|
+
# @option opts [String] :node_type Restrict the returned results to only those of the given node type and its sub-types
|
48
|
+
# @option opts [Array<String>] :include Returns additional information about the node. The following optional fields can be requested: * allowableOperations * aspectNames * isLink * isLocked * path * properties
|
49
|
+
# @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.
|
50
|
+
# @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.
|
51
|
+
# @return [Array<(NodePaging, Fixnum, Hash)>] NodePaging data, response status code and response headers
|
52
|
+
def find_nodes_with_http_info(term, opts = {})
|
53
|
+
if @api_client.config.debugging
|
54
|
+
@api_client.config.logger.debug "Calling API: QueriesApi.find_nodes ..."
|
55
|
+
end
|
56
|
+
# verify the required parameter 'term' is set
|
57
|
+
if @api_client.config.client_side_validation && term.nil?
|
58
|
+
fail ArgumentError, "Missing the required parameter 'term' when calling QueriesApi.find_nodes"
|
59
|
+
end
|
60
|
+
if @api_client.config.client_side_validation && !opts[:'skip_count'].nil? && opts[:'skip_count'] < 0
|
61
|
+
fail ArgumentError, 'invalid value for "opts[:"skip_count"]" when calling QueriesApi.find_nodes, must be greater than or equal to 0.'
|
62
|
+
end
|
63
|
+
|
64
|
+
if @api_client.config.client_side_validation && !opts[:'max_items'].nil? && opts[:'max_items'] < 1
|
65
|
+
fail ArgumentError, 'invalid value for "opts[:"max_items"]" when calling QueriesApi.find_nodes, must be greater than or equal to 1.'
|
66
|
+
end
|
67
|
+
|
68
|
+
# resource path
|
69
|
+
local_var_path = "/queries/nodes"
|
70
|
+
|
71
|
+
# query parameters
|
72
|
+
query_params = {}
|
73
|
+
query_params[:'term'] = term
|
74
|
+
query_params[:'rootNodeId'] = opts[:'root_node_id'] if !opts[:'root_node_id'].nil?
|
75
|
+
query_params[:'skipCount'] = opts[:'skip_count'] if !opts[:'skip_count'].nil?
|
76
|
+
query_params[:'maxItems'] = opts[:'max_items'] if !opts[:'max_items'].nil?
|
77
|
+
query_params[:'nodeType'] = opts[:'node_type'] if !opts[:'node_type'].nil?
|
78
|
+
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
79
|
+
query_params[:'orderBy'] = @api_client.build_collection_param(opts[:'order_by'], :csv) if !opts[:'order_by'].nil?
|
80
|
+
query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
|
81
|
+
|
82
|
+
# header parameters
|
83
|
+
header_params = {}
|
84
|
+
# HTTP header 'Accept' (if needed)
|
85
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
86
|
+
# HTTP header 'Content-Type'
|
87
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
88
|
+
|
89
|
+
# form parameters
|
90
|
+
form_params = {}
|
91
|
+
|
92
|
+
# http body (model)
|
93
|
+
post_body = nil
|
94
|
+
auth_names = ['basicAuth']
|
95
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
96
|
+
:header_params => header_params,
|
97
|
+
:query_params => query_params,
|
98
|
+
:form_params => form_params,
|
99
|
+
:body => post_body,
|
100
|
+
:auth_names => auth_names,
|
101
|
+
:return_type => 'NodePaging')
|
102
|
+
if @api_client.config.debugging
|
103
|
+
@api_client.config.logger.debug "API called: QueriesApi#find_nodes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
104
|
+
end
|
105
|
+
return data, status_code, headers
|
106
|
+
end
|
107
|
+
|
108
|
+
# Find people
|
109
|
+
# **Note:** this endpoint is available in Alfresco 5.2 and newer versions. Gets a list of people that match the given search criteria. The search term is used to look for matches against person id, firstname and lastname. The search term: - must contain a minimum of 2 alphanumeric characters - can optionally use '*' for wildcard matching within the term You can sort the result list using the **orderBy** parameter. You can specify one or more of the following fields in the **orderBy** parameter: * id * firstName * lastName
|
110
|
+
# @param term The term to search for.
|
111
|
+
# @param [Hash] opts the optional parameters
|
112
|
+
# @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)
|
113
|
+
# @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)
|
114
|
+
# @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.
|
115
|
+
# @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.
|
116
|
+
# @return [PersonPaging]
|
117
|
+
def find_people(term, opts = {})
|
118
|
+
data, _status_code, _headers = find_people_with_http_info(term, opts)
|
119
|
+
return data
|
120
|
+
end
|
121
|
+
|
122
|
+
# Find people
|
123
|
+
# **Note:** this endpoint is available in Alfresco 5.2 and newer versions. Gets a list of people that match the given search criteria. The search term is used to look for matches against person id, firstname and lastname. The search term: - must contain a minimum of 2 alphanumeric characters - can optionally use '*' for wildcard matching within the term You can sort the result list using the **orderBy** parameter. You can specify one or more of the following fields in the **orderBy** parameter: * id * firstName * lastName
|
124
|
+
# @param term The term to search for.
|
125
|
+
# @param [Hash] opts the optional parameters
|
126
|
+
# @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.
|
127
|
+
# @option opts [Integer] :max_items The maximum number of items to return in the list. If not supplied then the default value is 100.
|
128
|
+
# @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.
|
129
|
+
# @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.
|
130
|
+
# @return [Array<(PersonPaging, Fixnum, Hash)>] PersonPaging data, response status code and response headers
|
131
|
+
def find_people_with_http_info(term, opts = {})
|
132
|
+
if @api_client.config.debugging
|
133
|
+
@api_client.config.logger.debug "Calling API: QueriesApi.find_people ..."
|
134
|
+
end
|
135
|
+
# verify the required parameter 'term' is set
|
136
|
+
if @api_client.config.client_side_validation && term.nil?
|
137
|
+
fail ArgumentError, "Missing the required parameter 'term' when calling QueriesApi.find_people"
|
138
|
+
end
|
139
|
+
if @api_client.config.client_side_validation && !opts[:'skip_count'].nil? && opts[:'skip_count'] < 0
|
140
|
+
fail ArgumentError, 'invalid value for "opts[:"skip_count"]" when calling QueriesApi.find_people, must be greater than or equal to 0.'
|
141
|
+
end
|
142
|
+
|
143
|
+
if @api_client.config.client_side_validation && !opts[:'max_items'].nil? && opts[:'max_items'] < 1
|
144
|
+
fail ArgumentError, 'invalid value for "opts[:"max_items"]" when calling QueriesApi.find_people, must be greater than or equal to 1.'
|
145
|
+
end
|
146
|
+
|
147
|
+
# resource path
|
148
|
+
local_var_path = "/queries/people"
|
149
|
+
|
150
|
+
# query parameters
|
151
|
+
query_params = {}
|
152
|
+
query_params[:'term'] = term
|
153
|
+
query_params[:'skipCount'] = opts[:'skip_count'] if !opts[:'skip_count'].nil?
|
154
|
+
query_params[:'maxItems'] = opts[:'max_items'] if !opts[:'max_items'].nil?
|
155
|
+
query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
|
156
|
+
query_params[:'orderBy'] = @api_client.build_collection_param(opts[:'order_by'], :csv) if !opts[:'order_by'].nil?
|
157
|
+
|
158
|
+
# header parameters
|
159
|
+
header_params = {}
|
160
|
+
# HTTP header 'Accept' (if needed)
|
161
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
162
|
+
# HTTP header 'Content-Type'
|
163
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
164
|
+
|
165
|
+
# form parameters
|
166
|
+
form_params = {}
|
167
|
+
|
168
|
+
# http body (model)
|
169
|
+
post_body = nil
|
170
|
+
auth_names = ['basicAuth']
|
171
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
172
|
+
:header_params => header_params,
|
173
|
+
:query_params => query_params,
|
174
|
+
:form_params => form_params,
|
175
|
+
:body => post_body,
|
176
|
+
:auth_names => auth_names,
|
177
|
+
:return_type => 'PersonPaging')
|
178
|
+
if @api_client.config.debugging
|
179
|
+
@api_client.config.logger.debug "API called: QueriesApi#find_people\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
180
|
+
end
|
181
|
+
return data, status_code, headers
|
182
|
+
end
|
183
|
+
|
184
|
+
# Find sites
|
185
|
+
# **Note:** this endpoint is available in Alfresco 5.2 and newer versions. Gets a list of sites that match the given search criteria. The search term is used to look for sites that match against site id, title or description. The search term: - must contain a minimum of 2 alphanumeric characters - can optionally use '*' for wildcard matching within the term The default sort order for the returned list is for sites to be sorted by ascending id. 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
|
186
|
+
# @param term The term to search for.
|
187
|
+
# @param [Hash] opts the optional parameters
|
188
|
+
# @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)
|
189
|
+
# @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)
|
190
|
+
# @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.
|
191
|
+
# @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.
|
192
|
+
# @return [SitePaging]
|
193
|
+
def find_sites(term, opts = {})
|
194
|
+
data, _status_code, _headers = find_sites_with_http_info(term, opts)
|
195
|
+
return data
|
196
|
+
end
|
197
|
+
|
198
|
+
# Find sites
|
199
|
+
# **Note:** this endpoint is available in Alfresco 5.2 and newer versions. Gets a list of sites that match the given search criteria. The search term is used to look for sites that match against site id, title or description. The search term: - must contain a minimum of 2 alphanumeric characters - can optionally use '*' for wildcard matching within the term The default sort order for the returned list is for sites to be sorted by ascending id. 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
|
200
|
+
# @param term The term to search for.
|
201
|
+
# @param [Hash] opts the optional parameters
|
202
|
+
# @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.
|
203
|
+
# @option opts [Integer] :max_items The maximum number of items to return in the list. If not supplied then the default value is 100.
|
204
|
+
# @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.
|
205
|
+
# @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.
|
206
|
+
# @return [Array<(SitePaging, Fixnum, Hash)>] SitePaging data, response status code and response headers
|
207
|
+
def find_sites_with_http_info(term, opts = {})
|
208
|
+
if @api_client.config.debugging
|
209
|
+
@api_client.config.logger.debug "Calling API: QueriesApi.find_sites ..."
|
210
|
+
end
|
211
|
+
# verify the required parameter 'term' is set
|
212
|
+
if @api_client.config.client_side_validation && term.nil?
|
213
|
+
fail ArgumentError, "Missing the required parameter 'term' when calling QueriesApi.find_sites"
|
214
|
+
end
|
215
|
+
if @api_client.config.client_side_validation && !opts[:'skip_count'].nil? && opts[:'skip_count'] < 0
|
216
|
+
fail ArgumentError, 'invalid value for "opts[:"skip_count"]" when calling QueriesApi.find_sites, must be greater than or equal to 0.'
|
217
|
+
end
|
218
|
+
|
219
|
+
if @api_client.config.client_side_validation && !opts[:'max_items'].nil? && opts[:'max_items'] < 1
|
220
|
+
fail ArgumentError, 'invalid value for "opts[:"max_items"]" when calling QueriesApi.find_sites, must be greater than or equal to 1.'
|
221
|
+
end
|
222
|
+
|
223
|
+
# resource path
|
224
|
+
local_var_path = "/queries/sites"
|
225
|
+
|
226
|
+
# query parameters
|
227
|
+
query_params = {}
|
228
|
+
query_params[:'term'] = term
|
229
|
+
query_params[:'skipCount'] = opts[:'skip_count'] if !opts[:'skip_count'].nil?
|
230
|
+
query_params[:'maxItems'] = opts[:'max_items'] if !opts[:'max_items'].nil?
|
231
|
+
query_params[:'orderBy'] = @api_client.build_collection_param(opts[:'order_by'], :csv) if !opts[:'order_by'].nil?
|
232
|
+
query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
|
233
|
+
|
234
|
+
# header parameters
|
235
|
+
header_params = {}
|
236
|
+
# HTTP header 'Accept' (if needed)
|
237
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
238
|
+
# HTTP header 'Content-Type'
|
239
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
240
|
+
|
241
|
+
# form parameters
|
242
|
+
form_params = {}
|
243
|
+
|
244
|
+
# http body (model)
|
245
|
+
post_body = nil
|
246
|
+
auth_names = ['basicAuth']
|
247
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
248
|
+
:header_params => header_params,
|
249
|
+
:query_params => query_params,
|
250
|
+
:form_params => form_params,
|
251
|
+
:body => post_body,
|
252
|
+
:auth_names => auth_names,
|
253
|
+
:return_type => 'SitePaging')
|
254
|
+
if @api_client.config.debugging
|
255
|
+
@api_client.config.logger.debug "API called: QueriesApi#find_sites\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
256
|
+
end
|
257
|
+
return data, status_code, headers
|
258
|
+
end
|
259
|
+
end
|
260
|
+
end
|
@@ -0,0 +1,283 @@
|
|
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 RatingsApi
|
17
|
+
attr_accessor :api_client
|
18
|
+
|
19
|
+
def initialize(api_client = ApiClient.default)
|
20
|
+
@api_client = api_client
|
21
|
+
end
|
22
|
+
|
23
|
+
# Create a rating
|
24
|
+
# Create a rating for the node with identifier **nodeId**
|
25
|
+
# @param node_id The identifier of a node.
|
26
|
+
# @param rating_body_create For \"myRating\" the type is specific to the rating scheme, boolean for the likes and an integer for the fiveStar. For example, to \"like\" a file the following body would be used: ```JSON { \"id\": \"likes\", \"myRating\": true } ```
|
27
|
+
# @param [Hash] opts the optional parameters
|
28
|
+
# @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.
|
29
|
+
# @return [RatingEntry]
|
30
|
+
def create_rating(node_id, rating_body_create, opts = {})
|
31
|
+
data, _status_code, _headers = create_rating_with_http_info(node_id, rating_body_create, opts)
|
32
|
+
return data
|
33
|
+
end
|
34
|
+
|
35
|
+
# Create a rating
|
36
|
+
# Create a rating for the node with identifier **nodeId**
|
37
|
+
# @param node_id The identifier of a node.
|
38
|
+
# @param rating_body_create For \"myRating\" the type is specific to the rating scheme, boolean for the likes and an integer for the fiveStar. For example, to \"like\" a file the following body would be used: ```JSON { \"id\": \"likes\", \"myRating\": true } ```
|
39
|
+
# @param [Hash] opts the optional parameters
|
40
|
+
# @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.
|
41
|
+
# @return [Array<(RatingEntry, Fixnum, Hash)>] RatingEntry data, response status code and response headers
|
42
|
+
def create_rating_with_http_info(node_id, rating_body_create, opts = {})
|
43
|
+
if @api_client.config.debugging
|
44
|
+
@api_client.config.logger.debug "Calling API: RatingsApi.create_rating ..."
|
45
|
+
end
|
46
|
+
# verify the required parameter 'node_id' is set
|
47
|
+
if @api_client.config.client_side_validation && node_id.nil?
|
48
|
+
fail ArgumentError, "Missing the required parameter 'node_id' when calling RatingsApi.create_rating"
|
49
|
+
end
|
50
|
+
# verify the required parameter 'rating_body_create' is set
|
51
|
+
if @api_client.config.client_side_validation && rating_body_create.nil?
|
52
|
+
fail ArgumentError, "Missing the required parameter 'rating_body_create' when calling RatingsApi.create_rating"
|
53
|
+
end
|
54
|
+
# resource path
|
55
|
+
local_var_path = "/nodes/{nodeId}/ratings".sub('{' + 'nodeId' + '}', node_id.to_s)
|
56
|
+
|
57
|
+
# query parameters
|
58
|
+
query_params = {}
|
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(rating_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 => 'RatingEntry')
|
81
|
+
if @api_client.config.debugging
|
82
|
+
@api_client.config.logger.debug "API called: RatingsApi#create_rating\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
83
|
+
end
|
84
|
+
return data, status_code, headers
|
85
|
+
end
|
86
|
+
|
87
|
+
# Delete a rating
|
88
|
+
# Deletes rating **ratingId** from node **nodeId**.
|
89
|
+
# @param node_id The identifier of a node.
|
90
|
+
# @param rating_id The identifier of a rating.
|
91
|
+
# @param [Hash] opts the optional parameters
|
92
|
+
# @return [nil]
|
93
|
+
def delete_rating(node_id, rating_id, opts = {})
|
94
|
+
delete_rating_with_http_info(node_id, rating_id, opts)
|
95
|
+
return nil
|
96
|
+
end
|
97
|
+
|
98
|
+
# Delete a rating
|
99
|
+
# Deletes rating **ratingId** from node **nodeId**.
|
100
|
+
# @param node_id The identifier of a node.
|
101
|
+
# @param rating_id The identifier of a rating.
|
102
|
+
# @param [Hash] opts the optional parameters
|
103
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
104
|
+
def delete_rating_with_http_info(node_id, rating_id, opts = {})
|
105
|
+
if @api_client.config.debugging
|
106
|
+
@api_client.config.logger.debug "Calling API: RatingsApi.delete_rating ..."
|
107
|
+
end
|
108
|
+
# verify the required parameter 'node_id' is set
|
109
|
+
if @api_client.config.client_side_validation && node_id.nil?
|
110
|
+
fail ArgumentError, "Missing the required parameter 'node_id' when calling RatingsApi.delete_rating"
|
111
|
+
end
|
112
|
+
# verify the required parameter 'rating_id' is set
|
113
|
+
if @api_client.config.client_side_validation && rating_id.nil?
|
114
|
+
fail ArgumentError, "Missing the required parameter 'rating_id' when calling RatingsApi.delete_rating"
|
115
|
+
end
|
116
|
+
# resource path
|
117
|
+
local_var_path = "/nodes/{nodeId}/ratings/{ratingId}".sub('{' + 'nodeId' + '}', node_id.to_s).sub('{' + 'ratingId' + '}', rating_id.to_s)
|
118
|
+
|
119
|
+
# query parameters
|
120
|
+
query_params = {}
|
121
|
+
|
122
|
+
# header parameters
|
123
|
+
header_params = {}
|
124
|
+
# HTTP header 'Accept' (if needed)
|
125
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
126
|
+
# HTTP header 'Content-Type'
|
127
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
128
|
+
|
129
|
+
# form parameters
|
130
|
+
form_params = {}
|
131
|
+
|
132
|
+
# http body (model)
|
133
|
+
post_body = nil
|
134
|
+
auth_names = ['basicAuth']
|
135
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
136
|
+
:header_params => header_params,
|
137
|
+
:query_params => query_params,
|
138
|
+
:form_params => form_params,
|
139
|
+
:body => post_body,
|
140
|
+
:auth_names => auth_names)
|
141
|
+
if @api_client.config.debugging
|
142
|
+
@api_client.config.logger.debug "API called: RatingsApi#delete_rating\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
143
|
+
end
|
144
|
+
return data, status_code, headers
|
145
|
+
end
|
146
|
+
|
147
|
+
# Get a rating
|
148
|
+
# Get the specific rating **ratingId** on node **nodeId**.
|
149
|
+
# @param node_id The identifier of a node.
|
150
|
+
# @param rating_id The identifier of a rating.
|
151
|
+
# @param [Hash] opts the optional parameters
|
152
|
+
# @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.
|
153
|
+
# @return [RatingEntry]
|
154
|
+
def get_rating(node_id, rating_id, opts = {})
|
155
|
+
data, _status_code, _headers = get_rating_with_http_info(node_id, rating_id, opts)
|
156
|
+
return data
|
157
|
+
end
|
158
|
+
|
159
|
+
# Get a rating
|
160
|
+
# Get the specific rating **ratingId** on node **nodeId**.
|
161
|
+
# @param node_id The identifier of a node.
|
162
|
+
# @param rating_id The identifier of a rating.
|
163
|
+
# @param [Hash] opts the optional parameters
|
164
|
+
# @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.
|
165
|
+
# @return [Array<(RatingEntry, Fixnum, Hash)>] RatingEntry data, response status code and response headers
|
166
|
+
def get_rating_with_http_info(node_id, rating_id, opts = {})
|
167
|
+
if @api_client.config.debugging
|
168
|
+
@api_client.config.logger.debug "Calling API: RatingsApi.get_rating ..."
|
169
|
+
end
|
170
|
+
# verify the required parameter 'node_id' is set
|
171
|
+
if @api_client.config.client_side_validation && node_id.nil?
|
172
|
+
fail ArgumentError, "Missing the required parameter 'node_id' when calling RatingsApi.get_rating"
|
173
|
+
end
|
174
|
+
# verify the required parameter 'rating_id' is set
|
175
|
+
if @api_client.config.client_side_validation && rating_id.nil?
|
176
|
+
fail ArgumentError, "Missing the required parameter 'rating_id' when calling RatingsApi.get_rating"
|
177
|
+
end
|
178
|
+
# resource path
|
179
|
+
local_var_path = "/nodes/{nodeId}/ratings/{ratingId}".sub('{' + 'nodeId' + '}', node_id.to_s).sub('{' + 'ratingId' + '}', rating_id.to_s)
|
180
|
+
|
181
|
+
# query parameters
|
182
|
+
query_params = {}
|
183
|
+
query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
|
184
|
+
|
185
|
+
# header parameters
|
186
|
+
header_params = {}
|
187
|
+
# HTTP header 'Accept' (if needed)
|
188
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
189
|
+
# HTTP header 'Content-Type'
|
190
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
191
|
+
|
192
|
+
# form parameters
|
193
|
+
form_params = {}
|
194
|
+
|
195
|
+
# http body (model)
|
196
|
+
post_body = nil
|
197
|
+
auth_names = ['basicAuth']
|
198
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
199
|
+
:header_params => header_params,
|
200
|
+
:query_params => query_params,
|
201
|
+
:form_params => form_params,
|
202
|
+
:body => post_body,
|
203
|
+
:auth_names => auth_names,
|
204
|
+
:return_type => 'RatingEntry')
|
205
|
+
if @api_client.config.debugging
|
206
|
+
@api_client.config.logger.debug "API called: RatingsApi#get_rating\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
207
|
+
end
|
208
|
+
return data, status_code, headers
|
209
|
+
end
|
210
|
+
|
211
|
+
# List ratings
|
212
|
+
# Gets a list of ratings for node **nodeId**.
|
213
|
+
# @param node_id The identifier of a node.
|
214
|
+
# @param [Hash] opts the optional parameters
|
215
|
+
# @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)
|
216
|
+
# @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)
|
217
|
+
# @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.
|
218
|
+
# @return [RatingPaging]
|
219
|
+
def list_ratings(node_id, opts = {})
|
220
|
+
data, _status_code, _headers = list_ratings_with_http_info(node_id, opts)
|
221
|
+
return data
|
222
|
+
end
|
223
|
+
|
224
|
+
# List ratings
|
225
|
+
# Gets a list of ratings for node **nodeId**.
|
226
|
+
# @param node_id The identifier of a node.
|
227
|
+
# @param [Hash] opts the optional parameters
|
228
|
+
# @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.
|
229
|
+
# @option opts [Integer] :max_items The maximum number of items to return in the list. If not supplied then the default value is 100.
|
230
|
+
# @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.
|
231
|
+
# @return [Array<(RatingPaging, Fixnum, Hash)>] RatingPaging data, response status code and response headers
|
232
|
+
def list_ratings_with_http_info(node_id, opts = {})
|
233
|
+
if @api_client.config.debugging
|
234
|
+
@api_client.config.logger.debug "Calling API: RatingsApi.list_ratings ..."
|
235
|
+
end
|
236
|
+
# verify the required parameter 'node_id' is set
|
237
|
+
if @api_client.config.client_side_validation && node_id.nil?
|
238
|
+
fail ArgumentError, "Missing the required parameter 'node_id' when calling RatingsApi.list_ratings"
|
239
|
+
end
|
240
|
+
if @api_client.config.client_side_validation && !opts[:'skip_count'].nil? && opts[:'skip_count'] < 0
|
241
|
+
fail ArgumentError, 'invalid value for "opts[:"skip_count"]" when calling RatingsApi.list_ratings, must be greater than or equal to 0.'
|
242
|
+
end
|
243
|
+
|
244
|
+
if @api_client.config.client_side_validation && !opts[:'max_items'].nil? && opts[:'max_items'] < 1
|
245
|
+
fail ArgumentError, 'invalid value for "opts[:"max_items"]" when calling RatingsApi.list_ratings, must be greater than or equal to 1.'
|
246
|
+
end
|
247
|
+
|
248
|
+
# resource path
|
249
|
+
local_var_path = "/nodes/{nodeId}/ratings".sub('{' + 'nodeId' + '}', node_id.to_s)
|
250
|
+
|
251
|
+
# query parameters
|
252
|
+
query_params = {}
|
253
|
+
query_params[:'skipCount'] = opts[:'skip_count'] if !opts[:'skip_count'].nil?
|
254
|
+
query_params[:'maxItems'] = opts[:'max_items'] if !opts[:'max_items'].nil?
|
255
|
+
query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
|
256
|
+
|
257
|
+
# header parameters
|
258
|
+
header_params = {}
|
259
|
+
# HTTP header 'Accept' (if needed)
|
260
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
261
|
+
# HTTP header 'Content-Type'
|
262
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
263
|
+
|
264
|
+
# form parameters
|
265
|
+
form_params = {}
|
266
|
+
|
267
|
+
# http body (model)
|
268
|
+
post_body = nil
|
269
|
+
auth_names = ['basicAuth']
|
270
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
271
|
+
:header_params => header_params,
|
272
|
+
:query_params => query_params,
|
273
|
+
:form_params => form_params,
|
274
|
+
:body => post_body,
|
275
|
+
:auth_names => auth_names,
|
276
|
+
:return_type => 'RatingPaging')
|
277
|
+
if @api_client.config.debugging
|
278
|
+
@api_client.config.logger.debug "API called: RatingsApi#list_ratings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
279
|
+
end
|
280
|
+
return data, status_code, headers
|
281
|
+
end
|
282
|
+
end
|
283
|
+
end
|