Module: Paperdrive::Client::OrganizationRelationships

Includes:
Parameters
Included in:
Paperdrive::Client
Defined in:
lib/paperdrive/client/organization_relationships.rb

Overview

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

See Also:

Instance Method Summary collapse

Instance Method Details

#all_organization_relationships(**args) ⇒ Paperdrive::Response

GET

Get all relationships for organization

Returns:

See Also:



18
19
20
21
22
23
24
 
# File 'lib/paperdrive/client/organization_relationships.rb', line 18

def all_organization_relationships(**args)
  params = parameters(args) do
    required_params :org_id
    optional_params :org_id
  end
  request(:get, 'organizationRelationships', params)
end

#create_organization_relationship(**args) ⇒ Paperdrive::Response

POST

Create an organization relationship

Returns:

See Also:



42
43
44
45
46
47
48
 
# File 'lib/paperdrive/client/organization_relationships.rb', line 42

def create_organization_relationship(**args)
  params = parameters(args) do
    required_params :type, :rel_owner_org_id, :rel_linked_org_id
    optional_params :org_id, :type, :rel_owner_org_id, :rel_linked_org_id
  end
  request(:post, 'organizationRelationships', params)
end

#delete_organization_relationship(id:, **args) ⇒ Paperdrive::Response

DELETE

Delete an organization relationship

Parameters:

  • id: (integer)

Returns:

See Also:



67
68
69
70
71
72
 
# File 'lib/paperdrive/client/organization_relationships.rb', line 67

def delete_organization_relationship(id:, **args)
  params = parameters(args) do
    optional_params
  end
  request(:delete, "organizationRelationships/#{id}", params)
end

#organization_relationship(id:, **args) ⇒ Paperdrive::Response

GET

Get one organization relationship

Parameters:

  • id: (integer)

Returns:

See Also:



31
32
33
34
35
36
 
# File 'lib/paperdrive/client/organization_relationships.rb', line 31

def organization_relationship(id:, **args)
  params = parameters(args) do
    optional_params :org_id
  end
  request(:get, "organizationRelationships/#{id}", params)
end

#update_organization_relationship(id:, **args) ⇒ Paperdrive::Response

PUT

Update an organization relationship

Parameters:

  • id: (integer)

Returns:

See Also:



55
56
57
58
59
60
 
# File 'lib/paperdrive/client/organization_relationships.rb', line 55

def update_organization_relationship(id:, **args)
  params = parameters(args) do
    optional_params :org_id, :type, :rel_owner_org_id, :rel_linked_org_id
  end
  request(:put, "organizationRelationships/#{id}", params)
end