caplinked-api 0.3.4 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f7cb48515db307e473f698b77afc85cce3993669
-  data.tar.gz: f0a2da6fe0a1d34e7f72b4518e7c4fa1c15ca1bd
+SHA256:
+  metadata.gz: 84d233db1d5ac47b93da237abf5d7206dc7cf945bdfb7c4c13a4eddd6988c9ff
+  data.tar.gz: 9f79e06e3695355dccccad12e787f2a721d51bf4615ad91c0a40751425864363
 SHA512:
-  metadata.gz: 3beeb4454f93cc8f3a4543af25db32a5540f5bb77669bfba06d64eecd0b8f281b5cc297fa789dac233c7b35dc7ae7cbbcb152a2e93ab4e2d481b02692209bb39
-  data.tar.gz: 7ad54e90e3db332204cf26a358f77c97db5d88d11dee417497a85b61a37ae96d3815cb787153bb07d83300e933edddd0a8954eb26937589bbf8dfba336a391ab
+  metadata.gz: 799b345376e85e6e9f3c90eff9cdd9c1de10216c9b72764fd56e1872218bbd2d0ee525b2e27c38b4894a401353e8e101524b65c5204841d76ffe355c7d46ef44
+  data.tar.gz: c5d16eb46d7a3a21f139dcbb9f5a9a2227f43a76b04cd7bc84a2ca0520e80c90420928993b1583cb8c3b67cf349daa0eb82da04787325190d36e3d19a98aae55

data/README.md

@@ -1,9 +1,12 @@
-# caplinked-api
+# caplinked-api-ruby
 
-Ruby SDK for Caplinked's API
-Documentation at https://developer.caplinked.com/docs
+## Overview
 
-Changelog at https://developer.caplinked.com/api-changelog
+Ruby (Rails) SDK for the [Caplinked API](https://developer.caplinked.com/).
+
+Core information security endpoints for managing your virtual data room capabilities around files/folders, users/groups and permissions, uploads/downloads, dynamic watermarking, DRM (digital rights management) and more.
+
+Vist [Caplinked](https://www.caplinked.com/data-protection-api/) for more information.
 
 ## Quick start guide:
 
@@ -16,6 +19,8 @@ gem 'caplinked-api'
 Assign Client
 
 ```
+require 'caplinked-api'
+
 client = Caplinked::Client.new api_host: 'sandbox.caplinked.com', api_scheme: 'https'
 
 client.api_key = 'YOUR_PUBLIC_API_KEY'
@@ -205,7 +210,7 @@ Move folder
 move_folder = client.move_folder id: folder[:id], workspace_id: 1, destination_folder_id: folder[:id]
 ```
 
-##Groups:
+## Groups:
 List all groups in workspace
 
 ```
@@ -274,7 +279,7 @@ List all group members
 list_all_group_members = client.list_all_group_members id: group[:id], workspace_id: 1
 ```
 
-##Organizations
+## Organizations
 
 Get organization info
 
@@ -308,7 +313,7 @@ show organization members
 show_organization_members = client.show_organization_members
 ```
 
-##Permissions
+## Permissions
 
 Get folder permissions
 
@@ -321,10 +326,11 @@ Update folder permissions
 update_folder_permissions = client.update_folder_permissions id: folder[:id], workspace_id: 1, group_id: group[:id], verb: 'grant', folder_action: 'download'
 ```
 
-##Teams
+## Teams
 
 Create team
 
+Note: The creating user is automatically added to a team. Trying to add the same user again will throw a Caplinked::Error.
 ```
 create_team = client.create_team team: { name: 'name', allowed_workspaces: 5, allowed_admins: 5, drm_enabled: false, watermarking: false, suppress_emails: false }
 ```
@@ -362,7 +368,7 @@ Get list of team members
 get_list_of_team_members = client.get_list_of_team_members id: team[:id]
 ```
 
-##Users
+## Users
 
 Create user
 
@@ -387,7 +393,34 @@ Delete user
 result = client.delete_user user: { id: 32523 }
 ```
 
-##Workspace
+## Watermark
+Get Watermark Setting
+
+```
+client.get_watermark id: 12345
+```
+Create Watermark Setting
+
+```
+client.create_watermark team_id: 123, custom_text: 'this is my watermark text'
+```
+Update Watermark Setting
+
+```
+client.update_watermark id: 1234, custom_text: 'new text', rotation: -45, opacity: .8
+```
+Delete Watermark Setting
+
+```
+client.delete_watermark id: 1234
+```
+List all Watermark Settings for a team
+
+```
+client.get_list_of_team_watermarks id: 3456
+```
+
+## Workspace
 List all workspaces for a team
 
 ```
@@ -395,6 +428,7 @@ list_all_workspaces_for_a_team = client.list_all_workspaces_for_a_team team_id:
 ```
 Create Workspace
 
+Note: The user creating the workspace will automatically be added to that workspace.
 ```
 create_workspace = client.create_workspace team_id: team[:id], workspace: { name: 'name'}
 ```

data/lib/caplinked/rest/groups.rb

@@ -61,7 +61,7 @@ module Caplinked
       end
 
       def add_group_member(options = {})
-        body = options.stringify_keys.slice('id', 'user_id', 'workspace_id', 'send_email')
+        body = options.stringify_keys.slice('id', 'user_id', 'email', 'workspace_id', 'send_email')
         id = body.delete('id')
         perform_post('/api/v1/groups/' + id.to_s + '/memberships', {}, body.to_json, { 'Content-Type' => 'application/json' } )
       end

data/lib/caplinked/rest/teams.rb

@@ -24,7 +24,7 @@ module Caplinked
       end
 
       def add_team_member(options = {})
-        body = options.stringify_keys.slice('id', 'user_id')
+        body = options.stringify_keys.slice('id', 'user_id', 'email')
         id = body.delete('id')
         perform_post('/api/v1/teams/' + id.to_s + '/memberships', {}, body.to_json, { 'Content-Type' => 'application/json' } )
       end

data/lib/caplinked/version.rb

@@ -14,7 +14,7 @@ module Caplinked
 
     # @return [Integer]
     def patch
-      4
+      5
     end
 
     # @return [Integer, NilClass]

metadata

@@ -1,84 +1,84 @@
 --- !ruby/object:Gem::Specification
 name: caplinked-api
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.5
 platform: ruby
 authors:
 - Jordan Fowler
 - Jazz Garcha
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-05-24 00:00:00.000000000 Z
+date: 2023-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.3'
 - !ruby/object:Gem::Dependency
   name: http
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
   name: http-form_data
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
 description: Ruby SDK for Caplinked's API.
@@ -90,6 +90,7 @@ extra_rdoc_files: []
 files:
 - README.md
 - caplinked-api.gemspec
+- lib/caplinked-api.rb
 - lib/caplinked/client.rb
 - lib/caplinked/error.rb
 - lib/caplinked/request.rb
@@ -107,29 +108,27 @@ files:
 - lib/caplinked/rest/workspaces.rb
 - lib/caplinked/utils.rb
 - lib/caplinked/version.rb
-- lib/caplinked-api.rb
 homepage: https://github.com/caplinked/caplinked-api-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.0.14
-signing_key: 
+rubygems_version: 3.2.24
+signing_key:
 specification_version: 4
 summary: Ruby SDK for Caplinked's API.
 test_files: []