pikarin / code-assignment-leads-listing Goto Github PK

Your task is to build API endpoints that will Create, Read, Update, and Delete leads.

You will need the following Models along with the corresponding values (in addition to IDs and timestamps):

• Lead
  • First name
  • Last name
  • Email
  • Phone
  • Electric Bill
• Address
  • Street
  • City
  • State Abbreviation
  • Zip code

Each Lead should have one Address established by a One-to-One relationship

• This endpoint should accept the following data (parenthesis includes expected validation criteria):
  • First name (required, max of 255 characters)
  • Last name (required, max of 255 characters)
  • Email (required, RFC compliant email address)
  • Electric bill (required, integer)
  • Street (required, max of 255 characters)
  • City (required, max of 255 characters)
  • State Abbreviation (required, exactly 2 characters)
  • Zip code (required, exactly 5 characters)
• A Lead and a related Address should be created
• The Lead and related Address should be returned in a JSON response

• This endpoint should accept the following data (parenthesis includes expected validation criteria):
  • Lead id (required, Lead id passed in should exist in the Leads table in the database)
  • Phone (required, numeric, exactly 10 characters)
• The Lead matching the passed in Lead ID should be updated to add / update the passed in Phone
• The Lead and related Address should be returned in a JSON response

• This endpoint should accept a Lead ID
• The Lead and related Address matching the Lead ID should be soft deleted
  • All fields except IDs and Timestamps should be set to NULL
• A success response should be returned

• This endpoint should accept a Lead ID
• The Lead and related Address should be returned in a JSON response

• This endpoint should accept an optional quality query parameter
  • The acceptable values for quality can be standard or premium
    • The quality of a lead should be determined by whether or not the Electric Bill is above or below a configureable threshold. This value should default to 250, and should be able to be updated via your .env file
• If no quality parameter is submitted, all (non-soft-deleted) Leads and related Addresses should be returned in a JSON response
• If the quality parameter is equal to premium, all (non-soft-deleted) Leads and related Addresses equal to or above the configurable threshold should be returned
• If the quality parameter is equal to standard, all (non-soft-deleted) Leads and related Addresses below the configurable threshold should be returned

• Use Laravel best practices where possible
  • Your Controller should have minimal logic
  • You should use a Repository to interact with the database
  • API requests should be validated
• We will manually test your API endpoints. Automated tests (like PHPUnit) are not required