module Paperdrive::Client::OrganizationFields

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

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

Public Instance Methods

all_organization_fields(**args) click to toggle source
GET

Get all organization fields

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

# File lib/paperdrive/client/organization_fields.rb, line 18
def all_organization_fields(**args)
  params = parameters(args) do
    optional_params
  end
  request(:get, 'organizationFields', params)
end
create_organization_field(**args) click to toggle source
POST

Add a new organization field

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

# File lib/paperdrive/client/organization_fields.rb, line 41
def create_organization_field(**args)
  params = parameters(args) do
    required_params :name, :field_type
    optional_params :name, :field_type, :options
  end
  request(:post, 'organizationFields', params)
end
delete_organization_field(id:, **args) click to toggle source
DELETE

Delete an organization field

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

# File lib/paperdrive/client/organization_fields.rb, line 79
def delete_organization_field(id:, **args)
  params = parameters(args) do
    optional_params
  end
  request(:delete, "organizationFields/#{id}", params)
end
delete_organization_fields(**args) click to toggle source
DELETE

Delete multiple organization fields in bulk

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

# File lib/paperdrive/client/organization_fields.rb, line 66
def delete_organization_fields(**args)
  params = parameters(args) do
    required_params :ids
    optional_params :ids
  end
  request(:delete, 'organizationFields', params)
end
organization_field(id:, **args) click to toggle source
GET

Get one organization field

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

# File lib/paperdrive/client/organization_fields.rb, line 30
def organization_field(id:, **args)
  params = parameters(args) do
    optional_params
  end
  request(:get, "organizationFields/#{id}", params)
end
update_organization_field(id:, **args) click to toggle source
PUT

Update an organization field

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

# File lib/paperdrive/client/organization_fields.rb, line 54
def update_organization_field(id:, **args)
  params = parameters(args) do
    required_params :name
    optional_params :name, :options
  end
  request(:put, "organizationFields/#{id}", params)
end