alfresco_api 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- 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,271 @@
|
|
|
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 RenditionsApi
|
|
17
|
+
attr_accessor :api_client
|
|
18
|
+
|
|
19
|
+
def initialize(api_client = ApiClient.default)
|
|
20
|
+
@api_client = api_client
|
|
21
|
+
end
|
|
22
|
+
|
|
23
|
+
# Create rendition
|
|
24
|
+
# **Note:** this endpoint is available in Alfresco 5.2 and newer versions. An asynchronous request to create a rendition for file **nodeId**. The rendition is specified by name **id** in the request body: ```JSON { \"id\":\"doclib\" } ```
|
|
25
|
+
# @param node_id The identifier of a node.
|
|
26
|
+
# @param rendition_body_create The rendition \"id\".
|
|
27
|
+
# @param [Hash] opts the optional parameters
|
|
28
|
+
# @return [nil]
|
|
29
|
+
def create_rendition(node_id, rendition_body_create, opts = {})
|
|
30
|
+
create_rendition_with_http_info(node_id, rendition_body_create, opts)
|
|
31
|
+
return nil
|
|
32
|
+
end
|
|
33
|
+
|
|
34
|
+
# Create rendition
|
|
35
|
+
# **Note:** this endpoint is available in Alfresco 5.2 and newer versions. An asynchronous request to create a rendition for file **nodeId**. The rendition is specified by name **id** in the request body: ```JSON { \"id\":\"doclib\" } ```
|
|
36
|
+
# @param node_id The identifier of a node.
|
|
37
|
+
# @param rendition_body_create The rendition \"id\".
|
|
38
|
+
# @param [Hash] opts the optional parameters
|
|
39
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
40
|
+
def create_rendition_with_http_info(node_id, rendition_body_create, opts = {})
|
|
41
|
+
if @api_client.config.debugging
|
|
42
|
+
@api_client.config.logger.debug "Calling API: RenditionsApi.create_rendition ..."
|
|
43
|
+
end
|
|
44
|
+
# verify the required parameter 'node_id' is set
|
|
45
|
+
if @api_client.config.client_side_validation && node_id.nil?
|
|
46
|
+
fail ArgumentError, "Missing the required parameter 'node_id' when calling RenditionsApi.create_rendition"
|
|
47
|
+
end
|
|
48
|
+
# verify the required parameter 'rendition_body_create' is set
|
|
49
|
+
if @api_client.config.client_side_validation && rendition_body_create.nil?
|
|
50
|
+
fail ArgumentError, "Missing the required parameter 'rendition_body_create' when calling RenditionsApi.create_rendition"
|
|
51
|
+
end
|
|
52
|
+
# resource path
|
|
53
|
+
local_var_path = "/nodes/{nodeId}/renditions".sub('{' + 'nodeId' + '}', node_id.to_s)
|
|
54
|
+
|
|
55
|
+
# query parameters
|
|
56
|
+
query_params = {}
|
|
57
|
+
|
|
58
|
+
# header parameters
|
|
59
|
+
header_params = {}
|
|
60
|
+
# HTTP header 'Accept' (if needed)
|
|
61
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
62
|
+
# HTTP header 'Content-Type'
|
|
63
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
64
|
+
|
|
65
|
+
# form parameters
|
|
66
|
+
form_params = {}
|
|
67
|
+
|
|
68
|
+
# http body (model)
|
|
69
|
+
post_body = @api_client.object_to_http_body(rendition_body_create)
|
|
70
|
+
auth_names = ['basicAuth']
|
|
71
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
|
72
|
+
:header_params => header_params,
|
|
73
|
+
:query_params => query_params,
|
|
74
|
+
:form_params => form_params,
|
|
75
|
+
:body => post_body,
|
|
76
|
+
:auth_names => auth_names)
|
|
77
|
+
if @api_client.config.debugging
|
|
78
|
+
@api_client.config.logger.debug "API called: RenditionsApi#create_rendition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
79
|
+
end
|
|
80
|
+
return data, status_code, headers
|
|
81
|
+
end
|
|
82
|
+
|
|
83
|
+
# Get rendition information
|
|
84
|
+
# **Note:** this endpoint is available in Alfresco 5.2 and newer versions. Gets the rendition information for **renditionId** of file **nodeId**.
|
|
85
|
+
# @param node_id The identifier of a node.
|
|
86
|
+
# @param rendition_id The name of a thumbnail rendition, for example *doclib*, or *pdf*.
|
|
87
|
+
# @param [Hash] opts the optional parameters
|
|
88
|
+
# @return [RenditionEntry]
|
|
89
|
+
def get_rendition(node_id, rendition_id, opts = {})
|
|
90
|
+
data, _status_code, _headers = get_rendition_with_http_info(node_id, rendition_id, opts)
|
|
91
|
+
return data
|
|
92
|
+
end
|
|
93
|
+
|
|
94
|
+
# Get rendition information
|
|
95
|
+
# **Note:** this endpoint is available in Alfresco 5.2 and newer versions. Gets the rendition information for **renditionId** of file **nodeId**.
|
|
96
|
+
# @param node_id The identifier of a node.
|
|
97
|
+
# @param rendition_id The name of a thumbnail rendition, for example *doclib*, or *pdf*.
|
|
98
|
+
# @param [Hash] opts the optional parameters
|
|
99
|
+
# @return [Array<(RenditionEntry, Fixnum, Hash)>] RenditionEntry data, response status code and response headers
|
|
100
|
+
def get_rendition_with_http_info(node_id, rendition_id, opts = {})
|
|
101
|
+
if @api_client.config.debugging
|
|
102
|
+
@api_client.config.logger.debug "Calling API: RenditionsApi.get_rendition ..."
|
|
103
|
+
end
|
|
104
|
+
# verify the required parameter 'node_id' is set
|
|
105
|
+
if @api_client.config.client_side_validation && node_id.nil?
|
|
106
|
+
fail ArgumentError, "Missing the required parameter 'node_id' when calling RenditionsApi.get_rendition"
|
|
107
|
+
end
|
|
108
|
+
# verify the required parameter 'rendition_id' is set
|
|
109
|
+
if @api_client.config.client_side_validation && rendition_id.nil?
|
|
110
|
+
fail ArgumentError, "Missing the required parameter 'rendition_id' when calling RenditionsApi.get_rendition"
|
|
111
|
+
end
|
|
112
|
+
# resource path
|
|
113
|
+
local_var_path = "/nodes/{nodeId}/renditions/{renditionId}".sub('{' + 'nodeId' + '}', node_id.to_s).sub('{' + 'renditionId' + '}', rendition_id.to_s)
|
|
114
|
+
|
|
115
|
+
# query parameters
|
|
116
|
+
query_params = {}
|
|
117
|
+
|
|
118
|
+
# header parameters
|
|
119
|
+
header_params = {}
|
|
120
|
+
# HTTP header 'Accept' (if needed)
|
|
121
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
122
|
+
# HTTP header 'Content-Type'
|
|
123
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
124
|
+
|
|
125
|
+
# form parameters
|
|
126
|
+
form_params = {}
|
|
127
|
+
|
|
128
|
+
# http body (model)
|
|
129
|
+
post_body = nil
|
|
130
|
+
auth_names = ['basicAuth']
|
|
131
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
132
|
+
:header_params => header_params,
|
|
133
|
+
:query_params => query_params,
|
|
134
|
+
:form_params => form_params,
|
|
135
|
+
:body => post_body,
|
|
136
|
+
:auth_names => auth_names,
|
|
137
|
+
:return_type => 'RenditionEntry')
|
|
138
|
+
if @api_client.config.debugging
|
|
139
|
+
@api_client.config.logger.debug "API called: RenditionsApi#get_rendition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
140
|
+
end
|
|
141
|
+
return data, status_code, headers
|
|
142
|
+
end
|
|
143
|
+
|
|
144
|
+
# Get rendition content
|
|
145
|
+
# **Note:** this endpoint is available in Alfresco 5.2 and newer versions. Gets the rendition content for **renditionId** of file **nodeId**.
|
|
146
|
+
# @param node_id The identifier of a node.
|
|
147
|
+
# @param rendition_id The name of a thumbnail rendition, for example *doclib*, or *pdf*.
|
|
148
|
+
# @param [Hash] opts the optional parameters
|
|
149
|
+
# @option opts [BOOLEAN] :attachment **true** enables a web browser to download the file as an attachment. **false** means a web browser may preview the file in a new tab or window, but not download the file. You can only set this parameter to **false** if the content type of the file is in the supported list; for example, certain image files and PDF files. If the content type is not supported for preview, then a value of **false** is ignored, and the attachment will be returned in the response. (default to true)
|
|
150
|
+
# @option opts [DateTime] :if_modified_since Only returns the content if it has been modified since the date provided. Use the date format defined by HTTP. For example, `Wed, 09 Mar 2016 16:56:34 GMT`.
|
|
151
|
+
# @option opts [BOOLEAN] :placeholder If **true** and there is no rendition for this **nodeId** and **renditionId**, then the placeholder image for the mime type of this rendition is returned, rather than a 404 response. (default to false)
|
|
152
|
+
# @return [nil]
|
|
153
|
+
def get_rendition_content(node_id, rendition_id, opts = {})
|
|
154
|
+
get_rendition_content_with_http_info(node_id, rendition_id, opts)
|
|
155
|
+
return nil
|
|
156
|
+
end
|
|
157
|
+
|
|
158
|
+
# Get rendition content
|
|
159
|
+
# **Note:** this endpoint is available in Alfresco 5.2 and newer versions. Gets the rendition content for **renditionId** of file **nodeId**.
|
|
160
|
+
# @param node_id The identifier of a node.
|
|
161
|
+
# @param rendition_id The name of a thumbnail rendition, for example *doclib*, or *pdf*.
|
|
162
|
+
# @param [Hash] opts the optional parameters
|
|
163
|
+
# @option opts [BOOLEAN] :attachment **true** enables a web browser to download the file as an attachment. **false** means a web browser may preview the file in a new tab or window, but not download the file. You can only set this parameter to **false** if the content type of the file is in the supported list; for example, certain image files and PDF files. If the content type is not supported for preview, then a value of **false** is ignored, and the attachment will be returned in the response.
|
|
164
|
+
# @option opts [DateTime] :if_modified_since Only returns the content if it has been modified since the date provided. Use the date format defined by HTTP. For example, `Wed, 09 Mar 2016 16:56:34 GMT`.
|
|
165
|
+
# @option opts [BOOLEAN] :placeholder If **true** and there is no rendition for this **nodeId** and **renditionId**, then the placeholder image for the mime type of this rendition is returned, rather than a 404 response.
|
|
166
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
167
|
+
def get_rendition_content_with_http_info(node_id, rendition_id, opts = {})
|
|
168
|
+
if @api_client.config.debugging
|
|
169
|
+
@api_client.config.logger.debug "Calling API: RenditionsApi.get_rendition_content ..."
|
|
170
|
+
end
|
|
171
|
+
# verify the required parameter 'node_id' is set
|
|
172
|
+
if @api_client.config.client_side_validation && node_id.nil?
|
|
173
|
+
fail ArgumentError, "Missing the required parameter 'node_id' when calling RenditionsApi.get_rendition_content"
|
|
174
|
+
end
|
|
175
|
+
# verify the required parameter 'rendition_id' is set
|
|
176
|
+
if @api_client.config.client_side_validation && rendition_id.nil?
|
|
177
|
+
fail ArgumentError, "Missing the required parameter 'rendition_id' when calling RenditionsApi.get_rendition_content"
|
|
178
|
+
end
|
|
179
|
+
# resource path
|
|
180
|
+
local_var_path = "/nodes/{nodeId}/renditions/{renditionId}/content".sub('{' + 'nodeId' + '}', node_id.to_s).sub('{' + 'renditionId' + '}', rendition_id.to_s)
|
|
181
|
+
|
|
182
|
+
# query parameters
|
|
183
|
+
query_params = {}
|
|
184
|
+
query_params[:'attachment'] = opts[:'attachment'] if !opts[:'attachment'].nil?
|
|
185
|
+
query_params[:'placeholder'] = opts[:'placeholder'] if !opts[:'placeholder'].nil?
|
|
186
|
+
|
|
187
|
+
# header parameters
|
|
188
|
+
header_params = {}
|
|
189
|
+
# HTTP header 'Accept' (if needed)
|
|
190
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
191
|
+
# HTTP header 'Content-Type'
|
|
192
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
193
|
+
header_params[:'If-Modified-Since'] = opts[:'if_modified_since'] if !opts[:'if_modified_since'].nil?
|
|
194
|
+
|
|
195
|
+
# form parameters
|
|
196
|
+
form_params = {}
|
|
197
|
+
|
|
198
|
+
# http body (model)
|
|
199
|
+
post_body = nil
|
|
200
|
+
auth_names = ['basicAuth']
|
|
201
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
202
|
+
:header_params => header_params,
|
|
203
|
+
:query_params => query_params,
|
|
204
|
+
:form_params => form_params,
|
|
205
|
+
:body => post_body,
|
|
206
|
+
:auth_names => auth_names)
|
|
207
|
+
if @api_client.config.debugging
|
|
208
|
+
@api_client.config.logger.debug "API called: RenditionsApi#get_rendition_content\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
209
|
+
end
|
|
210
|
+
return data, status_code, headers
|
|
211
|
+
end
|
|
212
|
+
|
|
213
|
+
# List renditions
|
|
214
|
+
# **Note:** this endpoint is available in Alfresco 5.2 and newer versions. Gets a list of the rendition information for each rendition of the the file **nodeId**, including the rendition id. Each rendition returned has a **status**: CREATED means it is available to view or download, NOT_CREATED means the rendition can be requested. You can use the **where** parameter to filter the returned renditions by **status**. For example, the following **where** clause will return just the CREATED renditions: ``` (status='CREATED') ```
|
|
215
|
+
# @param node_id The identifier of a node.
|
|
216
|
+
# @param [Hash] opts the optional parameters
|
|
217
|
+
# @option opts [String] :where A string to restrict the returned objects by using a predicate.
|
|
218
|
+
# @return [RenditionPaging]
|
|
219
|
+
def list_renditions(node_id, opts = {})
|
|
220
|
+
data, _status_code, _headers = list_renditions_with_http_info(node_id, opts)
|
|
221
|
+
return data
|
|
222
|
+
end
|
|
223
|
+
|
|
224
|
+
# List renditions
|
|
225
|
+
# **Note:** this endpoint is available in Alfresco 5.2 and newer versions. Gets a list of the rendition information for each rendition of the the file **nodeId**, including the rendition id. Each rendition returned has a **status**: CREATED means it is available to view or download, NOT_CREATED means the rendition can be requested. You can use the **where** parameter to filter the returned renditions by **status**. For example, the following **where** clause will return just the CREATED renditions: ``` (status='CREATED') ```
|
|
226
|
+
# @param node_id The identifier of a node.
|
|
227
|
+
# @param [Hash] opts the optional parameters
|
|
228
|
+
# @option opts [String] :where A string to restrict the returned objects by using a predicate.
|
|
229
|
+
# @return [Array<(RenditionPaging, Fixnum, Hash)>] RenditionPaging data, response status code and response headers
|
|
230
|
+
def list_renditions_with_http_info(node_id, opts = {})
|
|
231
|
+
if @api_client.config.debugging
|
|
232
|
+
@api_client.config.logger.debug "Calling API: RenditionsApi.list_renditions ..."
|
|
233
|
+
end
|
|
234
|
+
# verify the required parameter 'node_id' is set
|
|
235
|
+
if @api_client.config.client_side_validation && node_id.nil?
|
|
236
|
+
fail ArgumentError, "Missing the required parameter 'node_id' when calling RenditionsApi.list_renditions"
|
|
237
|
+
end
|
|
238
|
+
# resource path
|
|
239
|
+
local_var_path = "/nodes/{nodeId}/renditions".sub('{' + 'nodeId' + '}', node_id.to_s)
|
|
240
|
+
|
|
241
|
+
# query parameters
|
|
242
|
+
query_params = {}
|
|
243
|
+
query_params[:'where'] = opts[:'where'] if !opts[:'where'].nil?
|
|
244
|
+
|
|
245
|
+
# header parameters
|
|
246
|
+
header_params = {}
|
|
247
|
+
# HTTP header 'Accept' (if needed)
|
|
248
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
249
|
+
# HTTP header 'Content-Type'
|
|
250
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
251
|
+
|
|
252
|
+
# form parameters
|
|
253
|
+
form_params = {}
|
|
254
|
+
|
|
255
|
+
# http body (model)
|
|
256
|
+
post_body = nil
|
|
257
|
+
auth_names = ['basicAuth']
|
|
258
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
259
|
+
:header_params => header_params,
|
|
260
|
+
:query_params => query_params,
|
|
261
|
+
:form_params => form_params,
|
|
262
|
+
:body => post_body,
|
|
263
|
+
:auth_names => auth_names,
|
|
264
|
+
:return_type => 'RenditionPaging')
|
|
265
|
+
if @api_client.config.debugging
|
|
266
|
+
@api_client.config.logger.debug "API called: RenditionsApi#list_renditions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
267
|
+
end
|
|
268
|
+
return data, status_code, headers
|
|
269
|
+
end
|
|
270
|
+
end
|
|
271
|
+
end
|
|
@@ -0,0 +1,570 @@
|
|
|
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 SharedlinksApi
|
|
17
|
+
attr_accessor :api_client
|
|
18
|
+
|
|
19
|
+
def initialize(api_client = ApiClient.default)
|
|
20
|
+
@api_client = api_client
|
|
21
|
+
end
|
|
22
|
+
|
|
23
|
+
# Create a shared link to a file
|
|
24
|
+
# **Note:** this endpoint is available in Alfresco 5.2 and newer versions. Create a shared link to the file **nodeId** in the request body. Also, an optional expiry date could be set, so the shared link would become invalid when the expiry date is reached. For example: ```JSON { \"nodeId\": \"1ff9da1a-ee2f-4b9c-8c34-3333333333\", \"expiresAt\": \"2017-03-23T23:00:00.000+0000\" } ``` **Note:** You can create shared links to more than one file specifying a list of **nodeId**s in the JSON body like this: ```JSON [ { \"nodeId\": \"1ff9da1a-ee2f-4b9c-8c34-4444444444\" }, { \"nodeId\": \"1ff9da1a-ee2f-4b9c-8c34-5555555555\" } ] ``` 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\": { ... } } ] } } ```
|
|
25
|
+
# @param shared_link_body_create The nodeId to create a shared link for.
|
|
26
|
+
# @param [Hash] opts the optional parameters
|
|
27
|
+
# @option opts [Array<String>] :include Returns additional information about the shared link, the following optional fields can be requested: * allowableOperations * path
|
|
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 [SharedLinkEntry]
|
|
30
|
+
def create_shared_link(shared_link_body_create, opts = {})
|
|
31
|
+
data, _status_code, _headers = create_shared_link_with_http_info(shared_link_body_create, opts)
|
|
32
|
+
return data
|
|
33
|
+
end
|
|
34
|
+
|
|
35
|
+
# Create a shared link to a file
|
|
36
|
+
# **Note:** this endpoint is available in Alfresco 5.2 and newer versions. Create a shared link to the file **nodeId** in the request body. Also, an optional expiry date could be set, so the shared link would become invalid when the expiry date is reached. For example: ```JSON { \"nodeId\": \"1ff9da1a-ee2f-4b9c-8c34-3333333333\", \"expiresAt\": \"2017-03-23T23:00:00.000+0000\" } ``` **Note:** You can create shared links to more than one file specifying a list of **nodeId**s in the JSON body like this: ```JSON [ { \"nodeId\": \"1ff9da1a-ee2f-4b9c-8c34-4444444444\" }, { \"nodeId\": \"1ff9da1a-ee2f-4b9c-8c34-5555555555\" } ] ``` 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\": { ... } } ] } } ```
|
|
37
|
+
# @param shared_link_body_create The nodeId to create a shared link for.
|
|
38
|
+
# @param [Hash] opts the optional parameters
|
|
39
|
+
# @option opts [Array<String>] :include Returns additional information about the shared link, the following optional fields can be requested: * allowableOperations * path
|
|
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<(SharedLinkEntry, Fixnum, Hash)>] SharedLinkEntry data, response status code and response headers
|
|
42
|
+
def create_shared_link_with_http_info(shared_link_body_create, opts = {})
|
|
43
|
+
if @api_client.config.debugging
|
|
44
|
+
@api_client.config.logger.debug "Calling API: SharedlinksApi.create_shared_link ..."
|
|
45
|
+
end
|
|
46
|
+
# verify the required parameter 'shared_link_body_create' is set
|
|
47
|
+
if @api_client.config.client_side_validation && shared_link_body_create.nil?
|
|
48
|
+
fail ArgumentError, "Missing the required parameter 'shared_link_body_create' when calling SharedlinksApi.create_shared_link"
|
|
49
|
+
end
|
|
50
|
+
# resource path
|
|
51
|
+
local_var_path = "/shared-links"
|
|
52
|
+
|
|
53
|
+
# query parameters
|
|
54
|
+
query_params = {}
|
|
55
|
+
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
|
56
|
+
query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
|
|
57
|
+
|
|
58
|
+
# header parameters
|
|
59
|
+
header_params = {}
|
|
60
|
+
# HTTP header 'Accept' (if needed)
|
|
61
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
62
|
+
# HTTP header 'Content-Type'
|
|
63
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
64
|
+
|
|
65
|
+
# form parameters
|
|
66
|
+
form_params = {}
|
|
67
|
+
|
|
68
|
+
# http body (model)
|
|
69
|
+
post_body = @api_client.object_to_http_body(shared_link_body_create)
|
|
70
|
+
auth_names = ['basicAuth']
|
|
71
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
|
72
|
+
:header_params => header_params,
|
|
73
|
+
:query_params => query_params,
|
|
74
|
+
:form_params => form_params,
|
|
75
|
+
:body => post_body,
|
|
76
|
+
:auth_names => auth_names,
|
|
77
|
+
:return_type => 'SharedLinkEntry')
|
|
78
|
+
if @api_client.config.debugging
|
|
79
|
+
@api_client.config.logger.debug "API called: SharedlinksApi#create_shared_link\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
80
|
+
end
|
|
81
|
+
return data, status_code, headers
|
|
82
|
+
end
|
|
83
|
+
|
|
84
|
+
# Deletes a shared link
|
|
85
|
+
# **Note:** this endpoint is available in Alfresco 5.2 and newer versions. Deletes the shared link with identifier **sharedId**.
|
|
86
|
+
# @param shared_id The identifier of a shared link to a file.
|
|
87
|
+
# @param [Hash] opts the optional parameters
|
|
88
|
+
# @return [nil]
|
|
89
|
+
def delete_shared_link(shared_id, opts = {})
|
|
90
|
+
delete_shared_link_with_http_info(shared_id, opts)
|
|
91
|
+
return nil
|
|
92
|
+
end
|
|
93
|
+
|
|
94
|
+
# Deletes a shared link
|
|
95
|
+
# **Note:** this endpoint is available in Alfresco 5.2 and newer versions. Deletes the shared link with identifier **sharedId**.
|
|
96
|
+
# @param shared_id The identifier of a shared link to a file.
|
|
97
|
+
# @param [Hash] opts the optional parameters
|
|
98
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
99
|
+
def delete_shared_link_with_http_info(shared_id, opts = {})
|
|
100
|
+
if @api_client.config.debugging
|
|
101
|
+
@api_client.config.logger.debug "Calling API: SharedlinksApi.delete_shared_link ..."
|
|
102
|
+
end
|
|
103
|
+
# verify the required parameter 'shared_id' is set
|
|
104
|
+
if @api_client.config.client_side_validation && shared_id.nil?
|
|
105
|
+
fail ArgumentError, "Missing the required parameter 'shared_id' when calling SharedlinksApi.delete_shared_link"
|
|
106
|
+
end
|
|
107
|
+
# resource path
|
|
108
|
+
local_var_path = "/shared-links/{sharedId}".sub('{' + 'sharedId' + '}', shared_id.to_s)
|
|
109
|
+
|
|
110
|
+
# query parameters
|
|
111
|
+
query_params = {}
|
|
112
|
+
|
|
113
|
+
# header parameters
|
|
114
|
+
header_params = {}
|
|
115
|
+
# HTTP header 'Accept' (if needed)
|
|
116
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
117
|
+
# HTTP header 'Content-Type'
|
|
118
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
119
|
+
|
|
120
|
+
# form parameters
|
|
121
|
+
form_params = {}
|
|
122
|
+
|
|
123
|
+
# http body (model)
|
|
124
|
+
post_body = nil
|
|
125
|
+
auth_names = ['basicAuth']
|
|
126
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
|
127
|
+
:header_params => header_params,
|
|
128
|
+
:query_params => query_params,
|
|
129
|
+
:form_params => form_params,
|
|
130
|
+
:body => post_body,
|
|
131
|
+
:auth_names => auth_names)
|
|
132
|
+
if @api_client.config.debugging
|
|
133
|
+
@api_client.config.logger.debug "API called: SharedlinksApi#delete_shared_link\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
134
|
+
end
|
|
135
|
+
return data, status_code, headers
|
|
136
|
+
end
|
|
137
|
+
|
|
138
|
+
# Email shared link
|
|
139
|
+
# **Note:** this endpoint is available in Alfresco 5.2 and newer versions. Sends email with app-specific url including identifier **sharedId**. The client and recipientEmails properties are mandatory in the request body. For example, to email a shared link with minimum info: ```JSON { \"client\": \"myClient\", \"recipientEmails\": [\"john.doe@acme.com\", \"joe.bloggs@acme.com\"] } ``` A plain text message property can be optionally provided in the request body to customise the sent email. Also, a locale property can be optionally provided in the request body to send the emails in a particular language (if the locale is supported by Alfresco). For example, to email a shared link with a messages and a locale: ```JSON { \"client\": \"myClient\", \"recipientEmails\": [\"john.doe@acme.com\", \"joe.bloggs@acme.com\"], \"message\": \"myMessage\", \"locale\":\"en-GB\" } ``` **Note:** The client must be registered before you can send a shared link email. See [server documentation]. However, out-of-the-box share is registered as a default client, so you could pass **share** as the client name: ```JSON { \"client\": \"share\", \"recipientEmails\": [\"john.doe@acme.com\"] } ```
|
|
140
|
+
# @param shared_id The identifier of a shared link to a file.
|
|
141
|
+
# @param shared_link_body_email The shared link email to send.
|
|
142
|
+
# @param [Hash] opts the optional parameters
|
|
143
|
+
# @return [nil]
|
|
144
|
+
def email_shared_link(shared_id, shared_link_body_email, opts = {})
|
|
145
|
+
email_shared_link_with_http_info(shared_id, shared_link_body_email, opts)
|
|
146
|
+
return nil
|
|
147
|
+
end
|
|
148
|
+
|
|
149
|
+
# Email shared link
|
|
150
|
+
# **Note:** this endpoint is available in Alfresco 5.2 and newer versions. Sends email with app-specific url including identifier **sharedId**. The client and recipientEmails properties are mandatory in the request body. For example, to email a shared link with minimum info: ```JSON { \"client\": \"myClient\", \"recipientEmails\": [\"john.doe@acme.com\", \"joe.bloggs@acme.com\"] } ``` A plain text message property can be optionally provided in the request body to customise the sent email. Also, a locale property can be optionally provided in the request body to send the emails in a particular language (if the locale is supported by Alfresco). For example, to email a shared link with a messages and a locale: ```JSON { \"client\": \"myClient\", \"recipientEmails\": [\"john.doe@acme.com\", \"joe.bloggs@acme.com\"], \"message\": \"myMessage\", \"locale\":\"en-GB\" } ``` **Note:** The client must be registered before you can send a shared link email. See [server documentation]. However, out-of-the-box share is registered as a default client, so you could pass **share** as the client name: ```JSON { \"client\": \"share\", \"recipientEmails\": [\"john.doe@acme.com\"] } ```
|
|
151
|
+
# @param shared_id The identifier of a shared link to a file.
|
|
152
|
+
# @param shared_link_body_email The shared link email to send.
|
|
153
|
+
# @param [Hash] opts the optional parameters
|
|
154
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
155
|
+
def email_shared_link_with_http_info(shared_id, shared_link_body_email, opts = {})
|
|
156
|
+
if @api_client.config.debugging
|
|
157
|
+
@api_client.config.logger.debug "Calling API: SharedlinksApi.email_shared_link ..."
|
|
158
|
+
end
|
|
159
|
+
# verify the required parameter 'shared_id' is set
|
|
160
|
+
if @api_client.config.client_side_validation && shared_id.nil?
|
|
161
|
+
fail ArgumentError, "Missing the required parameter 'shared_id' when calling SharedlinksApi.email_shared_link"
|
|
162
|
+
end
|
|
163
|
+
# verify the required parameter 'shared_link_body_email' is set
|
|
164
|
+
if @api_client.config.client_side_validation && shared_link_body_email.nil?
|
|
165
|
+
fail ArgumentError, "Missing the required parameter 'shared_link_body_email' when calling SharedlinksApi.email_shared_link"
|
|
166
|
+
end
|
|
167
|
+
# resource path
|
|
168
|
+
local_var_path = "/shared-links/{sharedId}/email".sub('{' + 'sharedId' + '}', shared_id.to_s)
|
|
169
|
+
|
|
170
|
+
# query parameters
|
|
171
|
+
query_params = {}
|
|
172
|
+
|
|
173
|
+
# header parameters
|
|
174
|
+
header_params = {}
|
|
175
|
+
# HTTP header 'Accept' (if needed)
|
|
176
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
177
|
+
# HTTP header 'Content-Type'
|
|
178
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
179
|
+
|
|
180
|
+
# form parameters
|
|
181
|
+
form_params = {}
|
|
182
|
+
|
|
183
|
+
# http body (model)
|
|
184
|
+
post_body = @api_client.object_to_http_body(shared_link_body_email)
|
|
185
|
+
auth_names = ['basicAuth']
|
|
186
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
|
187
|
+
:header_params => header_params,
|
|
188
|
+
:query_params => query_params,
|
|
189
|
+
:form_params => form_params,
|
|
190
|
+
:body => post_body,
|
|
191
|
+
:auth_names => auth_names)
|
|
192
|
+
if @api_client.config.debugging
|
|
193
|
+
@api_client.config.logger.debug "API called: SharedlinksApi#email_shared_link\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
194
|
+
end
|
|
195
|
+
return data, status_code, headers
|
|
196
|
+
end
|
|
197
|
+
|
|
198
|
+
# Get a shared link
|
|
199
|
+
# **Note:** this endpoint is available in Alfresco 5.2 and newer versions. Gets minimal information for the file with shared link identifier **sharedId**. **Note:** No authentication is required to call this endpoint.
|
|
200
|
+
# @param shared_id The identifier of a shared link to a file.
|
|
201
|
+
# @param [Hash] opts the optional parameters
|
|
202
|
+
# @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.
|
|
203
|
+
# @return [SharedLinkEntry]
|
|
204
|
+
def get_shared_link(shared_id, opts = {})
|
|
205
|
+
data, _status_code, _headers = get_shared_link_with_http_info(shared_id, opts)
|
|
206
|
+
return data
|
|
207
|
+
end
|
|
208
|
+
|
|
209
|
+
# Get a shared link
|
|
210
|
+
# **Note:** this endpoint is available in Alfresco 5.2 and newer versions. Gets minimal information for the file with shared link identifier **sharedId**. **Note:** No authentication is required to call this endpoint.
|
|
211
|
+
# @param shared_id The identifier of a shared link to a file.
|
|
212
|
+
# @param [Hash] opts the optional parameters
|
|
213
|
+
# @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.
|
|
214
|
+
# @return [Array<(SharedLinkEntry, Fixnum, Hash)>] SharedLinkEntry data, response status code and response headers
|
|
215
|
+
def get_shared_link_with_http_info(shared_id, opts = {})
|
|
216
|
+
if @api_client.config.debugging
|
|
217
|
+
@api_client.config.logger.debug "Calling API: SharedlinksApi.get_shared_link ..."
|
|
218
|
+
end
|
|
219
|
+
# verify the required parameter 'shared_id' is set
|
|
220
|
+
if @api_client.config.client_side_validation && shared_id.nil?
|
|
221
|
+
fail ArgumentError, "Missing the required parameter 'shared_id' when calling SharedlinksApi.get_shared_link"
|
|
222
|
+
end
|
|
223
|
+
# resource path
|
|
224
|
+
local_var_path = "/shared-links/{sharedId}".sub('{' + 'sharedId' + '}', shared_id.to_s)
|
|
225
|
+
|
|
226
|
+
# query parameters
|
|
227
|
+
query_params = {}
|
|
228
|
+
query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
|
|
229
|
+
|
|
230
|
+
# header parameters
|
|
231
|
+
header_params = {}
|
|
232
|
+
# HTTP header 'Accept' (if needed)
|
|
233
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
234
|
+
# HTTP header 'Content-Type'
|
|
235
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
236
|
+
|
|
237
|
+
# form parameters
|
|
238
|
+
form_params = {}
|
|
239
|
+
|
|
240
|
+
# http body (model)
|
|
241
|
+
post_body = nil
|
|
242
|
+
auth_names = ['basicAuth']
|
|
243
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
244
|
+
:header_params => header_params,
|
|
245
|
+
:query_params => query_params,
|
|
246
|
+
:form_params => form_params,
|
|
247
|
+
:body => post_body,
|
|
248
|
+
:auth_names => auth_names,
|
|
249
|
+
:return_type => 'SharedLinkEntry')
|
|
250
|
+
if @api_client.config.debugging
|
|
251
|
+
@api_client.config.logger.debug "API called: SharedlinksApi#get_shared_link\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
252
|
+
end
|
|
253
|
+
return data, status_code, headers
|
|
254
|
+
end
|
|
255
|
+
|
|
256
|
+
# Get shared link content
|
|
257
|
+
# **Note:** this endpoint is available in Alfresco 5.2 and newer versions. Gets the content of the file with shared link identifier **sharedId**. **Note:** No authentication is required to call this endpoint.
|
|
258
|
+
# @param shared_id The identifier of a shared link to a file.
|
|
259
|
+
# @param [Hash] opts the optional parameters
|
|
260
|
+
# @option opts [BOOLEAN] :attachment **true** enables a web browser to download the file as an attachment. **false** means a web browser may preview the file in a new tab or window, but not download the file. You can only set this parameter to **false** if the content type of the file is in the supported list; for example, certain image files and PDF files. If the content type is not supported for preview, then a value of **false** is ignored, and the attachment will be returned in the response. (default to true)
|
|
261
|
+
# @option opts [DateTime] :if_modified_since Only returns the content if it has been modified since the date provided. Use the date format defined by HTTP. For example, `Wed, 09 Mar 2016 16:56:34 GMT`.
|
|
262
|
+
# @return [nil]
|
|
263
|
+
def get_shared_link_content(shared_id, opts = {})
|
|
264
|
+
get_shared_link_content_with_http_info(shared_id, opts)
|
|
265
|
+
return nil
|
|
266
|
+
end
|
|
267
|
+
|
|
268
|
+
# Get shared link content
|
|
269
|
+
# **Note:** this endpoint is available in Alfresco 5.2 and newer versions. Gets the content of the file with shared link identifier **sharedId**. **Note:** No authentication is required to call this endpoint.
|
|
270
|
+
# @param shared_id The identifier of a shared link to a file.
|
|
271
|
+
# @param [Hash] opts the optional parameters
|
|
272
|
+
# @option opts [BOOLEAN] :attachment **true** enables a web browser to download the file as an attachment. **false** means a web browser may preview the file in a new tab or window, but not download the file. You can only set this parameter to **false** if the content type of the file is in the supported list; for example, certain image files and PDF files. If the content type is not supported for preview, then a value of **false** is ignored, and the attachment will be returned in the response.
|
|
273
|
+
# @option opts [DateTime] :if_modified_since Only returns the content if it has been modified since the date provided. Use the date format defined by HTTP. For example, `Wed, 09 Mar 2016 16:56:34 GMT`.
|
|
274
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
275
|
+
def get_shared_link_content_with_http_info(shared_id, opts = {})
|
|
276
|
+
if @api_client.config.debugging
|
|
277
|
+
@api_client.config.logger.debug "Calling API: SharedlinksApi.get_shared_link_content ..."
|
|
278
|
+
end
|
|
279
|
+
# verify the required parameter 'shared_id' is set
|
|
280
|
+
if @api_client.config.client_side_validation && shared_id.nil?
|
|
281
|
+
fail ArgumentError, "Missing the required parameter 'shared_id' when calling SharedlinksApi.get_shared_link_content"
|
|
282
|
+
end
|
|
283
|
+
# resource path
|
|
284
|
+
local_var_path = "/shared-links/{sharedId}/content".sub('{' + 'sharedId' + '}', shared_id.to_s)
|
|
285
|
+
|
|
286
|
+
# query parameters
|
|
287
|
+
query_params = {}
|
|
288
|
+
query_params[:'attachment'] = opts[:'attachment'] if !opts[:'attachment'].nil?
|
|
289
|
+
|
|
290
|
+
# header parameters
|
|
291
|
+
header_params = {}
|
|
292
|
+
# HTTP header 'Accept' (if needed)
|
|
293
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
294
|
+
# HTTP header 'Content-Type'
|
|
295
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
296
|
+
header_params[:'If-Modified-Since'] = opts[:'if_modified_since'] if !opts[:'if_modified_since'].nil?
|
|
297
|
+
|
|
298
|
+
# form parameters
|
|
299
|
+
form_params = {}
|
|
300
|
+
|
|
301
|
+
# http body (model)
|
|
302
|
+
post_body = nil
|
|
303
|
+
auth_names = ['basicAuth']
|
|
304
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
305
|
+
:header_params => header_params,
|
|
306
|
+
:query_params => query_params,
|
|
307
|
+
:form_params => form_params,
|
|
308
|
+
:body => post_body,
|
|
309
|
+
:auth_names => auth_names)
|
|
310
|
+
if @api_client.config.debugging
|
|
311
|
+
@api_client.config.logger.debug "API called: SharedlinksApi#get_shared_link_content\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
312
|
+
end
|
|
313
|
+
return data, status_code, headers
|
|
314
|
+
end
|
|
315
|
+
|
|
316
|
+
# Get shared link rendition information
|
|
317
|
+
# **Note:** this endpoint is available in Alfresco 5.2 and newer versions. Gets rendition information for the file with shared link identifier **sharedId**. This API method returns rendition information where the rendition status is CREATED, which means the rendition is available to view/download. **Note:** No authentication is required to call this endpoint.
|
|
318
|
+
# @param shared_id The identifier of a shared link to a file.
|
|
319
|
+
# @param rendition_id The name of a thumbnail rendition, for example *doclib*, or *pdf*.
|
|
320
|
+
# @param [Hash] opts the optional parameters
|
|
321
|
+
# @return [RenditionEntry]
|
|
322
|
+
def get_shared_link_rendition(shared_id, rendition_id, opts = {})
|
|
323
|
+
data, _status_code, _headers = get_shared_link_rendition_with_http_info(shared_id, rendition_id, opts)
|
|
324
|
+
return data
|
|
325
|
+
end
|
|
326
|
+
|
|
327
|
+
# Get shared link rendition information
|
|
328
|
+
# **Note:** this endpoint is available in Alfresco 5.2 and newer versions. Gets rendition information for the file with shared link identifier **sharedId**. This API method returns rendition information where the rendition status is CREATED, which means the rendition is available to view/download. **Note:** No authentication is required to call this endpoint.
|
|
329
|
+
# @param shared_id The identifier of a shared link to a file.
|
|
330
|
+
# @param rendition_id The name of a thumbnail rendition, for example *doclib*, or *pdf*.
|
|
331
|
+
# @param [Hash] opts the optional parameters
|
|
332
|
+
# @return [Array<(RenditionEntry, Fixnum, Hash)>] RenditionEntry data, response status code and response headers
|
|
333
|
+
def get_shared_link_rendition_with_http_info(shared_id, rendition_id, opts = {})
|
|
334
|
+
if @api_client.config.debugging
|
|
335
|
+
@api_client.config.logger.debug "Calling API: SharedlinksApi.get_shared_link_rendition ..."
|
|
336
|
+
end
|
|
337
|
+
# verify the required parameter 'shared_id' is set
|
|
338
|
+
if @api_client.config.client_side_validation && shared_id.nil?
|
|
339
|
+
fail ArgumentError, "Missing the required parameter 'shared_id' when calling SharedlinksApi.get_shared_link_rendition"
|
|
340
|
+
end
|
|
341
|
+
# verify the required parameter 'rendition_id' is set
|
|
342
|
+
if @api_client.config.client_side_validation && rendition_id.nil?
|
|
343
|
+
fail ArgumentError, "Missing the required parameter 'rendition_id' when calling SharedlinksApi.get_shared_link_rendition"
|
|
344
|
+
end
|
|
345
|
+
# resource path
|
|
346
|
+
local_var_path = "/shared-links/{sharedId}/renditions/{renditionId}".sub('{' + 'sharedId' + '}', shared_id.to_s).sub('{' + 'renditionId' + '}', rendition_id.to_s)
|
|
347
|
+
|
|
348
|
+
# query parameters
|
|
349
|
+
query_params = {}
|
|
350
|
+
|
|
351
|
+
# header parameters
|
|
352
|
+
header_params = {}
|
|
353
|
+
# HTTP header 'Accept' (if needed)
|
|
354
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
355
|
+
# HTTP header 'Content-Type'
|
|
356
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
357
|
+
|
|
358
|
+
# form parameters
|
|
359
|
+
form_params = {}
|
|
360
|
+
|
|
361
|
+
# http body (model)
|
|
362
|
+
post_body = nil
|
|
363
|
+
auth_names = ['basicAuth']
|
|
364
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
365
|
+
:header_params => header_params,
|
|
366
|
+
:query_params => query_params,
|
|
367
|
+
:form_params => form_params,
|
|
368
|
+
:body => post_body,
|
|
369
|
+
:auth_names => auth_names,
|
|
370
|
+
:return_type => 'RenditionEntry')
|
|
371
|
+
if @api_client.config.debugging
|
|
372
|
+
@api_client.config.logger.debug "API called: SharedlinksApi#get_shared_link_rendition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
373
|
+
end
|
|
374
|
+
return data, status_code, headers
|
|
375
|
+
end
|
|
376
|
+
|
|
377
|
+
# Get shared link rendition content
|
|
378
|
+
# **Note:** this endpoint is available in Alfresco 5.2 and newer versions. Gets the rendition content for file with shared link identifier **sharedId**. **Note:** No authentication is required to call this endpoint.
|
|
379
|
+
# @param shared_id The identifier of a shared link to a file.
|
|
380
|
+
# @param rendition_id The name of a thumbnail rendition, for example *doclib*, or *pdf*.
|
|
381
|
+
# @param [Hash] opts the optional parameters
|
|
382
|
+
# @option opts [BOOLEAN] :attachment **true** enables a web browser to download the file as an attachment. **false** means a web browser may preview the file in a new tab or window, but not download the file. You can only set this parameter to **false** if the content type of the file is in the supported list; for example, certain image files and PDF files. If the content type is not supported for preview, then a value of **false** is ignored, and the attachment will be returned in the response. (default to true)
|
|
383
|
+
# @option opts [DateTime] :if_modified_since Only returns the content if it has been modified since the date provided. Use the date format defined by HTTP. For example, `Wed, 09 Mar 2016 16:56:34 GMT`.
|
|
384
|
+
# @return [nil]
|
|
385
|
+
def get_shared_link_rendition_content(shared_id, rendition_id, opts = {})
|
|
386
|
+
get_shared_link_rendition_content_with_http_info(shared_id, rendition_id, opts)
|
|
387
|
+
return nil
|
|
388
|
+
end
|
|
389
|
+
|
|
390
|
+
# Get shared link rendition content
|
|
391
|
+
# **Note:** this endpoint is available in Alfresco 5.2 and newer versions. Gets the rendition content for file with shared link identifier **sharedId**. **Note:** No authentication is required to call this endpoint.
|
|
392
|
+
# @param shared_id The identifier of a shared link to a file.
|
|
393
|
+
# @param rendition_id The name of a thumbnail rendition, for example *doclib*, or *pdf*.
|
|
394
|
+
# @param [Hash] opts the optional parameters
|
|
395
|
+
# @option opts [BOOLEAN] :attachment **true** enables a web browser to download the file as an attachment. **false** means a web browser may preview the file in a new tab or window, but not download the file. You can only set this parameter to **false** if the content type of the file is in the supported list; for example, certain image files and PDF files. If the content type is not supported for preview, then a value of **false** is ignored, and the attachment will be returned in the response.
|
|
396
|
+
# @option opts [DateTime] :if_modified_since Only returns the content if it has been modified since the date provided. Use the date format defined by HTTP. For example, `Wed, 09 Mar 2016 16:56:34 GMT`.
|
|
397
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
398
|
+
def get_shared_link_rendition_content_with_http_info(shared_id, rendition_id, opts = {})
|
|
399
|
+
if @api_client.config.debugging
|
|
400
|
+
@api_client.config.logger.debug "Calling API: SharedlinksApi.get_shared_link_rendition_content ..."
|
|
401
|
+
end
|
|
402
|
+
# verify the required parameter 'shared_id' is set
|
|
403
|
+
if @api_client.config.client_side_validation && shared_id.nil?
|
|
404
|
+
fail ArgumentError, "Missing the required parameter 'shared_id' when calling SharedlinksApi.get_shared_link_rendition_content"
|
|
405
|
+
end
|
|
406
|
+
# verify the required parameter 'rendition_id' is set
|
|
407
|
+
if @api_client.config.client_side_validation && rendition_id.nil?
|
|
408
|
+
fail ArgumentError, "Missing the required parameter 'rendition_id' when calling SharedlinksApi.get_shared_link_rendition_content"
|
|
409
|
+
end
|
|
410
|
+
# resource path
|
|
411
|
+
local_var_path = "/shared-links/{sharedId}/renditions/{renditionId}/content".sub('{' + 'sharedId' + '}', shared_id.to_s).sub('{' + 'renditionId' + '}', rendition_id.to_s)
|
|
412
|
+
|
|
413
|
+
# query parameters
|
|
414
|
+
query_params = {}
|
|
415
|
+
query_params[:'attachment'] = opts[:'attachment'] if !opts[:'attachment'].nil?
|
|
416
|
+
|
|
417
|
+
# header parameters
|
|
418
|
+
header_params = {}
|
|
419
|
+
# HTTP header 'Accept' (if needed)
|
|
420
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
421
|
+
# HTTP header 'Content-Type'
|
|
422
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
423
|
+
header_params[:'If-Modified-Since'] = opts[:'if_modified_since'] if !opts[:'if_modified_since'].nil?
|
|
424
|
+
|
|
425
|
+
# form parameters
|
|
426
|
+
form_params = {}
|
|
427
|
+
|
|
428
|
+
# http body (model)
|
|
429
|
+
post_body = nil
|
|
430
|
+
auth_names = ['basicAuth']
|
|
431
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
432
|
+
:header_params => header_params,
|
|
433
|
+
:query_params => query_params,
|
|
434
|
+
:form_params => form_params,
|
|
435
|
+
:body => post_body,
|
|
436
|
+
:auth_names => auth_names)
|
|
437
|
+
if @api_client.config.debugging
|
|
438
|
+
@api_client.config.logger.debug "API called: SharedlinksApi#get_shared_link_rendition_content\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
439
|
+
end
|
|
440
|
+
return data, status_code, headers
|
|
441
|
+
end
|
|
442
|
+
|
|
443
|
+
# List renditions for a shared link
|
|
444
|
+
# **Note:** this endpoint is available in Alfresco 5.2 and newer versions. Gets a list of the rendition information for the file with shared link identifier **sharedId**. This API method returns rendition information, including the rendition id, for each rendition where the rendition status is CREATED, which means the rendition is available to view/download. **Note:** No authentication is required to call this endpoint.
|
|
445
|
+
# @param shared_id The identifier of a shared link to a file.
|
|
446
|
+
# @param [Hash] opts the optional parameters
|
|
447
|
+
# @return [RenditionPaging]
|
|
448
|
+
def list_shared_link_renditions(shared_id, opts = {})
|
|
449
|
+
data, _status_code, _headers = list_shared_link_renditions_with_http_info(shared_id, opts)
|
|
450
|
+
return data
|
|
451
|
+
end
|
|
452
|
+
|
|
453
|
+
# List renditions for a shared link
|
|
454
|
+
# **Note:** this endpoint is available in Alfresco 5.2 and newer versions. Gets a list of the rendition information for the file with shared link identifier **sharedId**. This API method returns rendition information, including the rendition id, for each rendition where the rendition status is CREATED, which means the rendition is available to view/download. **Note:** No authentication is required to call this endpoint.
|
|
455
|
+
# @param shared_id The identifier of a shared link to a file.
|
|
456
|
+
# @param [Hash] opts the optional parameters
|
|
457
|
+
# @return [Array<(RenditionPaging, Fixnum, Hash)>] RenditionPaging data, response status code and response headers
|
|
458
|
+
def list_shared_link_renditions_with_http_info(shared_id, opts = {})
|
|
459
|
+
if @api_client.config.debugging
|
|
460
|
+
@api_client.config.logger.debug "Calling API: SharedlinksApi.list_shared_link_renditions ..."
|
|
461
|
+
end
|
|
462
|
+
# verify the required parameter 'shared_id' is set
|
|
463
|
+
if @api_client.config.client_side_validation && shared_id.nil?
|
|
464
|
+
fail ArgumentError, "Missing the required parameter 'shared_id' when calling SharedlinksApi.list_shared_link_renditions"
|
|
465
|
+
end
|
|
466
|
+
# resource path
|
|
467
|
+
local_var_path = "/shared-links/{sharedId}/renditions".sub('{' + 'sharedId' + '}', shared_id.to_s)
|
|
468
|
+
|
|
469
|
+
# query parameters
|
|
470
|
+
query_params = {}
|
|
471
|
+
|
|
472
|
+
# header parameters
|
|
473
|
+
header_params = {}
|
|
474
|
+
# HTTP header 'Accept' (if needed)
|
|
475
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
476
|
+
# HTTP header 'Content-Type'
|
|
477
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
478
|
+
|
|
479
|
+
# form parameters
|
|
480
|
+
form_params = {}
|
|
481
|
+
|
|
482
|
+
# http body (model)
|
|
483
|
+
post_body = nil
|
|
484
|
+
auth_names = ['basicAuth']
|
|
485
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
486
|
+
:header_params => header_params,
|
|
487
|
+
:query_params => query_params,
|
|
488
|
+
:form_params => form_params,
|
|
489
|
+
:body => post_body,
|
|
490
|
+
:auth_names => auth_names,
|
|
491
|
+
:return_type => 'RenditionPaging')
|
|
492
|
+
if @api_client.config.debugging
|
|
493
|
+
@api_client.config.logger.debug "API called: SharedlinksApi#list_shared_link_renditions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
494
|
+
end
|
|
495
|
+
return data, status_code, headers
|
|
496
|
+
end
|
|
497
|
+
|
|
498
|
+
# List shared links
|
|
499
|
+
# **Note:** this endpoint is available in Alfresco 5.2 and newer versions. Get a list of links that the current user has read permission on source node. The list is ordered in descending modified order. **Note:** The list of links is eventually consistent so newly created shared links may not appear immediately.
|
|
500
|
+
# @param [Hash] opts the optional parameters
|
|
501
|
+
# @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)
|
|
502
|
+
# @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)
|
|
503
|
+
# @option opts [String] :where Optionally filter the list by \"sharedByUser\" userid of person who shared the link (can also use -me-) * ```where=(sharedByUser='jbloggs')``` * ```where=(sharedByUser='-me-')```
|
|
504
|
+
# @option opts [Array<String>] :include Returns additional information about the shared link, the following optional fields can be requested: * allowableOperations * path
|
|
505
|
+
# @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.
|
|
506
|
+
# @return [SharedLinkPaging]
|
|
507
|
+
def list_shared_links(opts = {})
|
|
508
|
+
data, _status_code, _headers = list_shared_links_with_http_info(opts)
|
|
509
|
+
return data
|
|
510
|
+
end
|
|
511
|
+
|
|
512
|
+
# List shared links
|
|
513
|
+
# **Note:** this endpoint is available in Alfresco 5.2 and newer versions. Get a list of links that the current user has read permission on source node. The list is ordered in descending modified order. **Note:** The list of links is eventually consistent so newly created shared links may not appear immediately.
|
|
514
|
+
# @param [Hash] opts the optional parameters
|
|
515
|
+
# @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.
|
|
516
|
+
# @option opts [Integer] :max_items The maximum number of items to return in the list. If not supplied then the default value is 100.
|
|
517
|
+
# @option opts [String] :where Optionally filter the list by \"sharedByUser\" userid of person who shared the link (can also use -me-) * ```where=(sharedByUser='jbloggs')``` * ```where=(sharedByUser='-me-')```
|
|
518
|
+
# @option opts [Array<String>] :include Returns additional information about the shared link, the following optional fields can be requested: * allowableOperations * path
|
|
519
|
+
# @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.
|
|
520
|
+
# @return [Array<(SharedLinkPaging, Fixnum, Hash)>] SharedLinkPaging data, response status code and response headers
|
|
521
|
+
def list_shared_links_with_http_info(opts = {})
|
|
522
|
+
if @api_client.config.debugging
|
|
523
|
+
@api_client.config.logger.debug "Calling API: SharedlinksApi.list_shared_links ..."
|
|
524
|
+
end
|
|
525
|
+
if @api_client.config.client_side_validation && !opts[:'skip_count'].nil? && opts[:'skip_count'] < 0
|
|
526
|
+
fail ArgumentError, 'invalid value for "opts[:"skip_count"]" when calling SharedlinksApi.list_shared_links, must be greater than or equal to 0.'
|
|
527
|
+
end
|
|
528
|
+
|
|
529
|
+
if @api_client.config.client_side_validation && !opts[:'max_items'].nil? && opts[:'max_items'] < 1
|
|
530
|
+
fail ArgumentError, 'invalid value for "opts[:"max_items"]" when calling SharedlinksApi.list_shared_links, must be greater than or equal to 1.'
|
|
531
|
+
end
|
|
532
|
+
|
|
533
|
+
# resource path
|
|
534
|
+
local_var_path = "/shared-links"
|
|
535
|
+
|
|
536
|
+
# query parameters
|
|
537
|
+
query_params = {}
|
|
538
|
+
query_params[:'skipCount'] = opts[:'skip_count'] if !opts[:'skip_count'].nil?
|
|
539
|
+
query_params[:'maxItems'] = opts[:'max_items'] if !opts[:'max_items'].nil?
|
|
540
|
+
query_params[:'where'] = opts[:'where'] if !opts[:'where'].nil?
|
|
541
|
+
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
|
|
542
|
+
query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
|
|
543
|
+
|
|
544
|
+
# header parameters
|
|
545
|
+
header_params = {}
|
|
546
|
+
# HTTP header 'Accept' (if needed)
|
|
547
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
548
|
+
# HTTP header 'Content-Type'
|
|
549
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
550
|
+
|
|
551
|
+
# form parameters
|
|
552
|
+
form_params = {}
|
|
553
|
+
|
|
554
|
+
# http body (model)
|
|
555
|
+
post_body = nil
|
|
556
|
+
auth_names = ['basicAuth']
|
|
557
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
558
|
+
:header_params => header_params,
|
|
559
|
+
:query_params => query_params,
|
|
560
|
+
:form_params => form_params,
|
|
561
|
+
:body => post_body,
|
|
562
|
+
:auth_names => auth_names,
|
|
563
|
+
:return_type => 'SharedLinkPaging')
|
|
564
|
+
if @api_client.config.debugging
|
|
565
|
+
@api_client.config.logger.debug "API called: SharedlinksApi#list_shared_links\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
566
|
+
end
|
|
567
|
+
return data, status_code, headers
|
|
568
|
+
end
|
|
569
|
+
end
|
|
570
|
+
end
|