caplinked-api-ruby

gem 'caplinked-api'

require 'caplinked-api'

client = Caplinked::Client.new api_host: 'sandbox.caplinked.com', api_scheme: 'https'

client.api_key = 'YOUR_PUBLIC_API_KEY'
client.api_secret_key = 'YOUR_SECRET_API_KEY'
client.api_user_token = 'USER_RESOURCE_IDENTIFIER_TOKEN'

# Info about the current user (in this case John Smith, an organization admin)

client.get_user_info

# response
{
  "id": 9818,
  "first_name": "John",
  "last_name": "Smith",
  "email": "john@example.com",
  "time_zone": "Pacific Time (US & Canada)",
  "user_token": "fc39b9012e47a5713932094065e17fb7ab76e83d"
}

# As an organization admin, list all members of your organization

client.show_organization_members

# response
{
  "users": [
    {
      "id": 9818,
      "first_name": "John",
      "last_name": "Smith",
      "email": "john@example.com",
      "time_zone": "Pacific Time (US & Canada)",
      "user_token": "fc39b9012e47a5713932094065e17fb7ab76e83d"
      "organization_admin": true
    },
    {
      "id": 9820,
      "first_name": "Jina",
      "last_name": "Baker",
      "email": "jina@example.com",
      "time_zone": "Pacific Time (US & Canada)",
      "user_token": "e05b83c6714120fb87a176241bc2031f22f5cf4a",
      "organization_admin": false
    }
  ]
}

# Switch to Jina's user token

client.api_user_token = 'e05b83c6714120fb87a176241bc2031f22f5cf4a'

client.get_user_info 

# response
{
  "id": 9820,
  "first_name": "Jina",
  "last_name": "Baker",
  "email": "jina@example.com",
  "time_zone": "Pacific Time (US & Canada)",
  "user_token": "e05b83c6714120fb87a176241bc2031f22f5cf4a"
}

get_workspace_activities = client.client.get_workspace_activities workspace_id: 1, user_id: user[:id]

create_zip_file = client.create_zip_file workspace_id: 1, download: { folder_ids: [folder[:id], folder[:id]] }

single_file_download = client.single_file_download file_id: file_info[:id], workspace_id: 1

download_status = client.download_status workspace_id: 1

delete_download = client.delete_download id: download[:id], workspace_id: 1

get_zip = client.get_zip id: download[:id], workspace_id: 1

new_file = client.upload_file workspace_id: 1, folder_id: 1, file_name: 'test_photo.jpg', file: File.read('/your/local/test_photo.jpg')

file_info = client.get_file_info id: new_file[:id], workspace_id: 1

delete_file = client.delete_file workspace_id: 1, id: file_info[:id]

update_file = client.update_file_info workspace_id: 1, id: file_info[:id], 'file[title]': 'name', 'file[index]': file[:index]

copy_file = client.copy_file id: file_info[:id], workspace_id: 1, destination_folder_id: folder[:id]

move_file = client.move_file id: file_info[:id], workspace_id: 1, destination_folder_id: folder[:id]

create_a_new_folder = client.create_a_new_folder workspace_id: 1, parent_id: folder[:id], name: 'name'

delete_folder = client.delete_folder workspace_id: 1, id: folder[:id]

get_folder_info = client.get_folder_info workspace_id: 1, id: folder[:id]

update_folder_info = client.update_folder_info id: folder[:id], workspace_id: 1, folder: { name: 'name', index: folder[:index]}

copy_folder = client.copy_folder id: folder[:id], workspace_id: 1, destination_folder_id: folder[:id]

move_folder = client.move_folder id: folder[:id], workspace_id: 1, destination_folder_id: folder[:id]

list_all_groups_in_workspace = client.list_all_groups_in_workspace workspace_id: 1

create_group = client.create_group group: {name: 'name', workspace_id: 1, file_managing_abilities: false}

update_group = client.update_group id: group[:id], workspace_id: 1, group: {name: 'name', file_managing_abilities: true}

get_group_info = client.get_group_info id: group[:id], workspace_id: 1

get_group_info = client.get_group_info id: group[:id], workspace_id: 1

update_group_drm = client.update_group_drm id: group[:id], workspace_id: 1, group: {drm_enabled: true, drm_expires_after: 'YYYY-MM-DD'}

disable_drm_expiration = client.disable_drm_expiration id: group[:id], workspace_id: 1

watermarking_for_group = client.watermarking_for_group id: group[:id], workspace_id: 1, group: {watermarking: true}

enable_access_expiration = client.enable_access_expiration id: group[:id], workspace_id: 1, group: {expire_workspace_access_at: "YYYY-MM-DD"}

disable_access_expiration = client.disable_access_expiration id: group[:id], workspace_id: 1

add_group_member = client.add_group_member id: group[:id], user_id: user[:id], workspace_id: 1, send_email: false

remove_group_member = client.remove_group_member id: group[:id], user_id: user[:id], workspace_id: 1

list_all_group_members = client.list_all_group_members id: group[:id], workspace_id: 1

get_organization_info = client.get_organization_info

update_organization_info = client.update_organization_info name: 'name', description: 'description', location: 'location', billing_email: 'billing email address', url: 'url'

update_organization_support_info = client.update_organization_support_info email: 'support email', phone_number: 'support phone number', website: 'support website'

add_organization_member = client.add_organization_member user_id: user[:id]

remove_organization_member = client.remove_organization_member user_id: 101

show_organization_members = client.show_organization_members

get_folder_permissions = client.get_folder_permissions id: folder[:id], workspace_id: 1, group_id: group[:id]

update_folder_permissions = client.update_folder_permissions id: folder[:id], workspace_id: 1, group_id: group[:id], verb: 'grant', folder_action: 'download'

create_team = client.create_team team: { name: 'name', allowed_workspaces: 5, allowed_admins: 5, drm_enabled: false, watermarking: false, suppress_emails: false }

get_team_list = client.get_list_of_teams

get_team_info = client.get_team_info id: team[:id]

update_team = client.update_team_info id: 183, team: { name: 'name', allowed_workspaces: 10, allowed_admins: 10, drm_enabled: true, watermarking: true, suppress_emails: true }

add_team_member = client.add_team_member id: team[:id], user_id: user[:id]

remove_team_member = client.remove_team_member id: team[:id], user_id: user[:id]

get_list_of_team_members = client.get_list_of_team_members id: team[:id]

create_user = client.create_user user: { email: 'email address', first_name: 'first name', last_name: 'last name', time_zone: "Pacific Time (US & Canada)" }

get_user_info = client.get_user_info

update_user = client.update_user user: { email: 'new email address'}

result = client.delete_user user: { id: 32523 }

client.get_watermark id: 12345

client.create_watermark team_id: 123, custom_text: 'this is my watermark text'

client.update_watermark id: 1234, custom_text: 'new text', rotation: -45, opacity: .8

client.delete_watermark id: 1234

client.get_list_of_team_watermarks id: 3456

list_all_workspaces_for_a_team = client.list_all_workspaces_for_a_team team_id: team[:id]

create_workspace = client.create_workspace team_id: team[:id], workspace: { name: 'name'}

get_workspace_info = client.get_workspace_info id: workspace[:id]

update_workspace_info = client.update_workspace_info id: workspace[:id], workspace: {name: "name name"}