Module: Insightly2::DSL::CustomFields

Included in:

Insightly2::DSL

Defined in:

lib/insightly2/dsl/custom_fields.rb

Instance Method Summary

• #get_custom_field(id: nil) ⇒ Insightly2::Resources::CustomField^?

  GET /v2.1/CustomFields/id Get a custom field.

• #get_custom_fields ⇒ Array^?

  GET /v2.1/CustomFields Get a list of custom fields.

Instance Method Details

#get_custom_field(id: nil) ⇒ Insightly2::Resources::CustomField^?

GET /v2.1/CustomFields/id Get a custom field.

Parameters:

• id (String, Fixnum) (defaults to: nil) —

  A CustomField’s ID.

Returns:

• (Insightly2::Resources::CustomField, nil) —

  .

Raises:

• (ArgumentError) —

  If the method arguments are blank.

# File 'lib/insightly2/dsl/custom_fields.rb', line 10

def get_custom_field(id: nil)
  raise ArgumentError, "ID cannot be blank" if id.blank?
  Resources::CustomField.parse(request(:get, "CustomFields/#{id}"))
end

#get_custom_fields ⇒ Array^?

GET /v2.1/CustomFields Get a list of custom fields.

Returns:

• (Array, nil) —

  .

# File 'lib/insightly2/dsl/custom_fields.rb', line 18

def get_custom_fields
  Resources::CustomField.parse(request(:get, "CustomFields"))
end