module Paperdrive::Client::Organizations

Instance methods related to Organizations to embed into Paperdrive::Client
arguments are compatible with the Pipedribe API.

@see developers.pipedrive.com/docs/api/v1/#!/Organizations

Public Instance Methods

add_follower_to_organization(id:, **args) click to toggle source
POST

Add a follower to an organization

@param [integer] id: @see developers.pipedrive.com/docs/api/v1/#!/Organizations/post_organizations_id_followers @return [Paperdrive::Response]

# 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) click to toggle source
GET

Get all organizations

@see developers.pipedrive.com/docs/api/v1/#!/Organizations/get_organizations @return [Paperdrive::Response]

# 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) click to toggle source
POST

Add an organization

@see developers.pipedrive.com/docs/api/v1/#!/Organizations/post_organizations @return [Paperdrive::Response]

# 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) click to toggle source
DELETE

Delete an organization

@param [integer] id: @see developers.pipedrive.com/docs/api/v1/#!/Organizations/delete_organizations_id @return [Paperdrive::Response]

# 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) click to toggle source
DELETE

Delete a follower from an organization

@param [integer] id: @param [integer] follower_id: @see developers.pipedrive.com/docs/api/v1/#!/Organizations/delete_organizations_id_followers_follower_id @return [Paperdrive::Response]

# 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) click to toggle source
DELETE

Delete multiple organizations in bulk

@see developers.pipedrive.com/docs/api/v1/#!/Organizations/delete_organizations @return [Paperdrive::Response]

# 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) click to toggle source
GET

Find organizations by name

@see developers.pipedrive.com/docs/api/v1/#!/Organizations/get_organizations_find @return [Paperdrive::Response]

# 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) click to toggle source
PUT

Merge two organizations

@param [integer] id: @see developers.pipedrive.com/docs/api/v1/#!/Organizations/put_organizations_id_merge @return [Paperdrive::Response]

# 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) click to toggle source
GET

List activities associated with an organization

@param [integer] id: @see developers.pipedrive.com/docs/api/v1/#!/Organizations/get_organizations_id_activities @return [Paperdrive::Response]

# 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) click to toggle source
GET

List deals associated with an organization

@param [integer] id: @see developers.pipedrive.com/docs/api/v1/#!/Organizations/get_organizations_id_deals @return [Paperdrive::Response]

# 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) click to toggle source
GET

Get details of an organization

@param [integer] id: @see developers.pipedrive.com/docs/api/v1/#!/Organizations/get_organizations_id @return [Paperdrive::Response]

# 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) click to toggle source
GET

List files attached to an organization

@param [integer] id: @see developers.pipedrive.com/docs/api/v1/#!/Organizations/get_organizations_id_files @return [Paperdrive::Response]

# 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) click to toggle source
GET

List followers of an organization

@param [integer] id: @see developers.pipedrive.com/docs/api/v1/#!/Organizations/get_organizations_id_followers @return [Paperdrive::Response]

# 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) click to toggle source
GET

List mail messages associated with an organization

@param [integer] id: @see developers.pipedrive.com/docs/api/v1/#!/Organizations/get_organizations_id_mailMessages @return [Paperdrive::Response]

# File lib/paperdrive/client/organizations.rb, line 114
def organization_mail_messages(id:, **args)
  params = parameters(args) do
    optional_params :start, :limit
  end
  request(:get, "organizations/#{id}/mailMessages", params)
end
organization_permitted_users(id:, **args) click to toggle source
GET

List permitted users

@param [integer] id: @see developers.pipedrive.com/docs/api/v1/#!/Organizations/get_organizations_id_permittedUsers @return [Paperdrive::Response]

# 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) click to toggle source
GET

List persons of an organization

@param [integer] id: @see developers.pipedrive.com/docs/api/v1/#!/Organizations/get_organizations_id_persons @return [Paperdrive::Response]

# 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) click to toggle source
GET

List updates about an organization

@param [integer] id: @see developers.pipedrive.com/docs/api/v1/#!/Organizations/get_organizations_id_flow @return [Paperdrive::Response]

# 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) click to toggle source
PUT

Update an organization

@param [integer] id: @see developers.pipedrive.com/docs/api/v1/#!/Organizations/put_organizations_id @return [Paperdrive::Response]

# 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