Module: Paperdrive::Client::Organizations
- Includes:
- Parameters
- Included in:
- Paperdrive::Client
- Defined in:
- lib/paperdrive/client/organizations.rb
Overview
Instance methods related to Organizations to embed into Paperdrive::Client
arguments are compatible with the Pipedribe API.
Instance Method Summary collapse
-
#add_follower_to_organization(id:, **args) ⇒ Paperdrive::Response
- POST
-
Add a follower to an organization.
-
#all_organizations(**args) ⇒ Paperdrive::Response
- GET
-
Get all organizations.
-
#create_organization(**args) ⇒ Paperdrive::Response
- POST
-
Add an organization.
-
#delete_organization(id:, **args) ⇒ Paperdrive::Response
- DELETE
-
Delete an organization.
-
#delete_organization_follower(id:, follower_id:, **args) ⇒ Paperdrive::Response
- DELETE
-
Delete a follower from an organization.
-
#delete_organizations(**args) ⇒ Paperdrive::Response
- DELETE
-
Delete multiple organizations in bulk.
-
#find_organizations_by_name(**args) ⇒ Paperdrive::Response
- GET
-
Find organizations by name.
-
#merge_organizations(id:, **args) ⇒ Paperdrive::Response
- PUT
-
Merge two organizations.
-
#organization_activities(id:, **args) ⇒ Paperdrive::Response
- GET
-
List activities associated with an organization.
-
#organization_deals(id:, **args) ⇒ Paperdrive::Response
- GET
-
List deals associated with an organization.
-
#organization_detail(id:, **args) ⇒ Paperdrive::Response
- GET
-
Get details of an organization.
-
#organization_files(id:, **args) ⇒ Paperdrive::Response
- GET
-
List files attached to an organization.
-
#organization_followers(id:, **args) ⇒ Paperdrive::Response
- GET
-
List followers of an organization.
-
#organization_mail_messages(id:, **args) ⇒ Paperdrive::Response
- GET
-
List mail messages associated with an organization.
-
#organization_permitted_users(id:, **args) ⇒ Paperdrive::Response
- GET
-
List permitted users.
-
#organization_persons(id:, **args) ⇒ Paperdrive::Response
- GET
-
List persons of an organization.
-
#organization_updates(id:, **args) ⇒ Paperdrive::Response
- GET
-
List updates about an organization.
-
#update_organization(id:, **args) ⇒ Paperdrive::Response
- PUT
-
Update an organization.
Instance Method Details
#add_follower_to_organization(id:, **args) ⇒ Paperdrive::Response
- POST
-
Add a follower to an organization
162 163 164 165 166 167 168 |
# File 'lib/paperdrive/client/organizations.rb', line 162 def add_follower_to_organization(id:, **args) params = parameters(args) do required_params :user_id optional_params :user_id end request(:post, "organizations/#{id}/followers", params) end |
#all_organizations(**args) ⇒ Paperdrive::Response
- GET
-
Get all organizations
18 19 20 21 22 23 |
# File 'lib/paperdrive/client/organizations.rb', line 18 def all_organizations(**args) params = parameters(args) do optional_params :user_id, :filter_id, :first_char, :start, :limit, :sort end request(:get, 'organizations', params) end |
#create_organization(**args) ⇒ Paperdrive::Response
- POST
-
Add an organization
149 150 151 152 153 154 155 |
# File 'lib/paperdrive/client/organizations.rb', line 149 def create_organization(**args) params = parameters(args) do required_params :name optional_params :name, :owner_id, :visible_to, :add_time end request(:post, 'organizations', params) end |
#delete_organization(id:, **args) ⇒ Paperdrive::Response
- DELETE
-
Delete an organization
212 213 214 215 216 217 |
# File 'lib/paperdrive/client/organizations.rb', line 212 def delete_organization(id:, **args) params = parameters(args) do optional_params end request(:delete, "organizations/#{id}", params) end |
#delete_organization_follower(id:, follower_id:, **args) ⇒ Paperdrive::Response
- DELETE
-
Delete a follower from an organization
225 226 227 228 229 230 |
# File 'lib/paperdrive/client/organizations.rb', line 225 def delete_organization_follower(id:, follower_id:, **args) params = parameters(args) do optional_params end request(:delete, "organizations/#{id}/followers/#{follower_id}", params) end |
#delete_organizations(**args) ⇒ Paperdrive::Response
- DELETE
-
Delete multiple organizations in bulk
199 200 201 202 203 204 205 |
# File 'lib/paperdrive/client/organizations.rb', line 199 def delete_organizations(**args) params = parameters(args) do required_params :ids optional_params :ids end request(:delete, 'organizations', params) end |
#find_organizations_by_name(**args) ⇒ Paperdrive::Response
- GET
-
Find organizations by name
29 30 31 32 33 34 35 |
# File 'lib/paperdrive/client/organizations.rb', line 29 def find_organizations_by_name(**args) params = parameters(args) do required_params :term optional_params :term, :start, :limit end request(:get, 'organizations/find', params) end |
#merge_organizations(id:, **args) ⇒ Paperdrive::Response
- PUT
-
Merge two organizations
187 188 189 190 191 192 193 |
# File 'lib/paperdrive/client/organizations.rb', line 187 def merge_organizations(id:, **args) params = parameters(args) do required_params :merge_with_id optional_params :merge_with_id end request(:put, "organizations/#{id}/merge", params) end |
#organization_activities(id:, **args) ⇒ Paperdrive::Response
- GET
-
List activities associated with an organization
54 55 56 57 58 59 |
# File 'lib/paperdrive/client/organizations.rb', line 54 def organization_activities(id:, **args) params = parameters(args) do optional_params :start, :limit, :done, :exclude end request(:get, "organizations/#{id}/activities", params) end |
#organization_deals(id:, **args) ⇒ Paperdrive::Response
- GET
-
List deals associated with an organization
66 67 68 69 70 71 |
# File 'lib/paperdrive/client/organizations.rb', line 66 def organization_deals(id:, **args) params = parameters(args) do optional_params :start, :limit, :status, :sort, :only_primary_association end request(:get, "organizations/#{id}/deals", params) end |
#organization_detail(id:, **args) ⇒ Paperdrive::Response
- GET
-
Get details of an organization
42 43 44 45 46 47 |
# File 'lib/paperdrive/client/organizations.rb', line 42 def organization_detail(id:, **args) params = parameters(args) do optional_params end request(:get, "organizations/#{id}", params) end |
#organization_files(id:, **args) ⇒ Paperdrive::Response
- GET
-
List files attached to an organization
78 79 80 81 82 83 |
# File 'lib/paperdrive/client/organizations.rb', line 78 def organization_files(id:, **args) params = parameters(args) do optional_params :start, :limit, :include_deleted_files, :sort end request(:get, "organizations/#{id}/files", params) end |
#organization_followers(id:, **args) ⇒ Paperdrive::Response
- GET
-
List followers of an organization
102 103 104 105 106 107 |
# File 'lib/paperdrive/client/organizations.rb', line 102 def organization_followers(id:, **args) params = parameters(args) do optional_params end request(:get, "organizations/#{id}/followers", params) end |
#organization_mail_messages(id:, **args) ⇒ Paperdrive::Response
- GET
-
List mail messages associated with an organization
114 115 116 117 118 119 |
# File 'lib/paperdrive/client/organizations.rb', line 114 def (id:, **args) params = parameters(args) do optional_params :start, :limit end request(:get, "organizations/#{id}/mailMessages", params) end |
#organization_permitted_users(id:, **args) ⇒ Paperdrive::Response
- GET
-
List permitted users
126 127 128 129 130 131 |
# File 'lib/paperdrive/client/organizations.rb', line 126 def organization_permitted_users(id:, **args) params = parameters(args) do optional_params :access_level end request(:get, "organizations/#{id}/permittedUsers", params) end |
#organization_persons(id:, **args) ⇒ Paperdrive::Response
- GET
-
List persons of an organization
138 139 140 141 142 143 |
# File 'lib/paperdrive/client/organizations.rb', line 138 def organization_persons(id:, **args) params = parameters(args) do optional_params :start, :limit end request(:get, "organizations/#{id}/persons", params) end |
#organization_updates(id:, **args) ⇒ Paperdrive::Response
- GET
-
List updates about an organization
90 91 92 93 94 95 |
# File 'lib/paperdrive/client/organizations.rb', line 90 def organization_updates(id:, **args) params = parameters(args) do optional_params :start, :limit end request(:get, "organizations/#{id}/flow", params) end |
#update_organization(id:, **args) ⇒ Paperdrive::Response
- PUT
-
Update an organization
175 176 177 178 179 180 |
# File 'lib/paperdrive/client/organizations.rb', line 175 def update_organization(id:, **args) params = parameters(args) do optional_params :name, :owner_id, :visible_to end request(:put, "organizations/#{id}", params) end |