iwoca 1.0.0 → 1.1.0

data/lib/iwoca/customer_generator.rb

@@ -3,7 +3,9 @@
 require 'faker'
 
 module Iwoca
-  # This class can be used to generate fake customers for test purposes
+  # This class can be used to generate fake customers for test purposes.
+  # It is based on the minimum data requirements described here:
+  # https://iwoca.stoplight.io/docs/lapi-uk/branches/2.1.0/2c44db4bf20fb-meeting-minimum-data-requirements
   class CustomerGenerator
     attr_accessor :id, :first_name, :last_name, :email, :phone, :address, :date_of_birth, :city
     attr_accessor :postcode
@@ -13,7 +15,7 @@ module Iwoca
       first_name: Faker::Name.first_name,
       last_name: Faker::Name.last_name,
       email: Faker::Internet.email,
-      phone: Faker::PhoneNumber.phone_number,
+      phone: Faker::PhoneNumber.cell_phone_in_e164,
       address: Faker::Address.street_address,
       date_of_birth: Faker::Date.birthday(min_age: 23, max_age: 65),
       city: Faker::Address.city,
@@ -21,7 +23,7 @@ module Iwoca
     }.freeze
 
     def self.generate(params = {})
-      new(params).generate
+      new(DEFAULTS.merge(params)).generate
     end
 
     def initialize(params = {})
@@ -35,59 +37,50 @@ module Iwoca
     def generate
       {
         data: {
-          application: {
-            company: company_information,
-            people: [user_information],
-            requested_products: {
-              credit_facility: {
-                approval: {
-                  amount: 123_123,
-                  duration: 12,
-                  detailed_purpose: 'business loan'
-                }
-              }
-            }
-          }
+          company: company_information,
+          people: [user_information]
         }
       }
     end
 
     def company_information
       {
+        company_number: '09525857',
         last_12_months_turnover: {
-          amount: 0.0
+          amount: 70_000,
+          valid_from: "2019-08-24T14:15:22Z"
         },
         registered_company_name: 'HOKO LTD',
-        industry: 'B | Mining and Quarrying',
-        company_number: '09525857',
-        type: 'limited_liability_company',
         trading_from_date: '2015-05-22',
+        type: 'limited_liability_company',
+        industry: 'B | Mining and Quarrying',
+        vat_status: {
+          is_vat_registered: true,
+          registered_over_3_months: true,
+        },
         registered_address: {
           postcode: 'W1T 3NF',
           street_line_1: 'Berners House',
           street_line_2: '47-48 Berners Street',
           town: 'London',
           country: 'GB'
-        },
-        vat_status: {
-          is_vat_registered: true
         }
       }
     end
 
     def user_information
       {
+        date_of_birth: date_of_birth,
+        emails: emails,
         uid: SecureRandom.uuid,
         first_name: first_name,
         last_name: last_name,
-        date_of_birth: date_of_birth,
-        roles: %w[applicant shareholder guarantor director],
         phones: phones,
-        emails: emails,
+        roles: %w[applicant shareholder guarantor director],
         residential_addresses: residential_addresses,
         privacy_policy: {
           agreed: true,
-          datetime: DateTime.now
+          valid_from: DateTime.now - 1
         }
       }
     end
@@ -95,7 +88,6 @@ module Iwoca
     def phones
       [
         {
-          uid: SecureRandom.uuid,
           number: phone,
           type: 'primary'
         }
@@ -105,8 +97,11 @@ module Iwoca
     def emails
       [
         {
-          uid: SecureRandom.uuid,
           email: email,
+          marketing_opt_in: {
+            agreed: true,
+            valid_from: DateTime.now
+          },
           type: 'primary'
         }
       ]
@@ -115,14 +110,12 @@ module Iwoca
     def residential_addresses
       [
         {
-          uid: SecureRandom.uuid,
-          town: city,
+          country: 'GB',
+          residential_status: 'owner_no_mortgage',
           street_line_1: address,
           street_line_2: '',
-          country: 'GB',
-          postcode: postcode,
-          house_number: '10',
-          residential_status: 'owner_no_mortgage'
+          town: city,
+          postcode: postcode
         }
       ]
     end

data/lib/iwoca/schemas/customer_payload.json

@@ -0,0 +1,542 @@
+{
+  "additionalProperties": false,
+  "description": "The customers endpoint. This holds state information about the customer.",
+  "properties": {
+    "data": {
+      "additionalProperties": false,
+      "properties": {
+        "company": {
+          "$ref": "#/definitions/company"
+        },
+        "correlation_id": {
+          "description": "Provided by partners to identify a customer in the optional quote_data endpoint payload posted to iwoca.",
+          "format": "uuid",
+          "type": "string"
+        },
+        "external_customer_id": {
+          "description": "Only used if you've set up a custom integration that requires iwoca to use your unique customer id.",
+          "type": "string"
+        },
+        "people": {
+          "description": "People associated with the company including the applicant and any other directors, shareholders or loan guarantors you wish to submit. For every customer there should be exactly one person with the role of 'applicant' that is also a 'director' and 'guarantor'.",
+          "items": {
+            "$ref": "#/definitions/person"
+          },
+          "type": "array"
+        }
+      },
+      "type": "object"
+    }
+  },
+  "title": "customer_payload",
+  "type": "object",
+  "definitions": {
+    "company": {
+      "additionalProperties": false,
+      "properties": {
+        "company_number": {
+          "description": "Company number as on Companies House.",
+          "maxLength": 50,
+          "type": "string"
+        },
+        "has_card_based_transactions": {
+          "type": "boolean"
+        },
+        "industry": {
+          "description": "Recommended format is one of: Agriculture, Forestry & Fishing / Architecture & Engineering / Business Support Services (e.g. recruitment or security) / Car Dealers, Garages & Mechanics / Cleaning, Landscaping & Gardening / Construction (e.g. builders, civil engineer or electrician) / Education & Training / Finance & Insurance / Health & Care (e.g. day-care, doctors or care homes) / Hotels, Restaurants & Pubs / IT & Communications/ Leisure / Other Services (e.g. hairdressers or travel agents) / Manufacturing, Food Processing & Printing / Professional Services (e.g. accounting or consulting) / Property & Real Estate / Publishing, Film & Media Production / Retail (online or offline) / Transport & Logistics (e.g. taxis, couriers or storage) / Wholesale / Other.",
+          "type": "string"
+        },
+        "last_12_months_profit": {
+          "additionalProperties": false,
+          "description": "Estimated profit over the last 12 months. For a young business without a full year of trading, the profit to date should be given. A negative value denotes a loss.",
+          "properties": {
+            "amount": {
+              "description": "Pre-tax amount submitted by customer in local currency. Note that this differs from monthly_non_business_income which is post-tax.",
+              "type": "number"
+            },
+            "valid_from": {
+              "description": "Datetime when user submitted data, with expected ISO 8601 format.",
+              "format": "date-time",
+              "type": "string"
+            }
+          },
+          "type": "object"
+        },
+        "last_12_months_turnover": {
+          "additionalProperties": false,
+          "description": "Estimated revenue over the last 12 months. For a young business without a full year of revenue, revenue to date should be given.",
+          "properties": {
+            "amount": {
+              "description": "Amount submitted by customer in local currency or other estimate.",
+              "type": "number"
+            },
+            "valid_from": {
+              "description": "Datetime when user submitted data, with expected ISO 8601 format.",
+              "format": "date-time",
+              "type": "string"
+            }
+          },
+          "type": "object"
+        },
+        "number_of_employees": {
+          "type": "integer"
+        },
+        "online_sales_percentage": {
+          "type": "integer"
+        },
+        "overdraft_status": {
+          "additionalProperties": false,
+          "properties": {
+            "has_overdraft": {
+              "description": "Specifies whether the user claims their company has a business overdraft.",
+              "type": "boolean"
+            },
+            "total_overdraft_limit": {
+              "description": "User declaration for total overdraft limit available to the company. If the company has multiple overdrafts, the sum of the limits should be used.",
+              "type": "number"
+            }
+          },
+          "type": "object"
+        },
+        "registered_address": {
+          "$ref": "#/definitions/company_address"
+        },
+        "registered_company_name": {
+          "description": "Registered company name for a registered business such as a limited company, as on Companies House.",
+          "maxLength": 200,
+          "type": "string"
+        },
+        "third_party_providers": {
+          "description": "Details of third-party providers used by the business such as Xero, eBay, PayPal or others.",
+          "items": {
+            "additionalProperties": false,
+            "properties": {
+              "name": {
+                "maxLength": 200,
+                "type": "string"
+              },
+              "type": {
+                "enum": ["ecommerce", "software", "bank"],
+                "type": "string"
+              }
+            },
+            "required": ["name", "type"],
+            "type": "object"
+          },
+          "type": "array"
+        },
+        "trading_address": {
+          "$ref": "#/definitions/company_address"
+        },
+        "trading_from_date": {
+          "description": "Date when company started trading, with expected ISO 8601 format.",
+          "format": "date",
+          "type": "string"
+        },
+        "trading_name": {
+          "description": "Primary company name used for sole traders and ordinary partnerships, otherwise registered name will typically be used.",
+          "maxLength": 200,
+          "type": "string"
+        },
+        "type": {
+          "enum": [
+            "limited_liability_company",
+            "sole_trader",
+            "ordinary_partnership",
+            "limited_liability_partnership",
+            "public_limited_company",
+            "other"
+          ],
+          "type": "string"
+        },
+        "vat_status": {
+          "additionalProperties": false,
+          "description": "Information on the company's VAT registration status.",
+          "properties": {
+            "is_vat_registered": {
+              "type": "boolean"
+            },
+            "registered_over_3_months": {
+              "type": "boolean"
+            },
+            "vat_number": {
+              "type": "string"
+            }
+          },
+          "type": "object"
+        },
+        "website": {
+          "description": "Company website.",
+          "format": "uri",
+          "maxLength": 200,
+          "type": "string"
+        }
+      },
+      "title": "company",
+      "type": "object"
+    },
+    "company_address": {
+      "additionalProperties": false,
+      "properties": {
+        "country": {
+          "enum": ["GB", "DE", "OTHER"],
+          "maxLength": 5,
+          "type": "string"
+        },
+        "postcode": {
+          "maxLength": 250,
+          "type": "string"
+        },
+        "street_line_1": {
+          "maxLength": 250,
+          "type": "string"
+        },
+        "street_line_2": {
+          "maxLength": 250,
+          "type": "string"
+        },
+        "town": {
+          "maxLength": 250,
+          "type": "string"
+        }
+      },
+      "title": "company_address",
+      "type": "object"
+    },
+    "person": {
+      "additionalProperties": false,
+      "properties": {
+        "date_of_birth": {
+          "description": "Date with expected ISO 8601 format.",
+          "format": "date",
+          "type": "string"
+        },
+        "emails": {
+          "items": {
+            "additionalProperties": false,
+            "properties": {
+              "email": {
+                "description": "Contact email address with format user@example.com (ideally not a generic address such as info@...).",
+                "format": "email",
+                "maxLength": 254,
+                "type": "string"
+              },
+              "marketing_opt_in": {
+                "$ref": "#/definitions/marketing_opt_in"
+              },
+              "type": {
+                "enum": ["primary", "secondary"],
+                "type": "string"
+              }
+            },
+            "required": ["email"],
+            "type": "object"
+          },
+          "type": "array"
+        },
+        "first_name": {
+          "description": "Middle name is not required.",
+          "maxLength": 100,
+          "type": "string"
+        },
+        "how_did_you_find_us": {
+          "properties": {
+            "answer": {
+              "description": "Enum denoting where the customer heard about us.",
+              "enum": [
+                "letter",
+                "search_engine",
+                "friend_or_press",
+                "advisor",
+                "email",
+                "online_advert",
+                "phone_call",
+                "no_answer",
+                "train_or_bus_ad",
+                "radio"
+              ],
+              "type": "string"
+            },
+            "details": {
+              "description": "Additional Details.",
+              "maxLength": 50,
+              "type": "string"
+            }
+          },
+          "type": "object"
+        },
+        "last_name": {
+          "maxLength": 100,
+          "type": "string"
+        },
+        "monthly_business_income": {
+          "additionalProperties": false,
+          "description": "The person's personal income or takings from the business per month.",
+          "properties": {
+            "amount": {
+              "description": "Post-tax amount submitted by customer in local currency.",
+              "type": "number"
+            },
+            "valid_from": {
+              "description": "Datetime when user submitted data, with expected ISO 8601 format.",
+              "format": "date-time",
+              "type": "string"
+            }
+          },
+          "type": "object"
+        },
+        "monthly_non_business_income": {
+          "additionalProperties": false,
+          "description": "All income from other jobs, pension etc. Required for lending to sole traders.",
+          "properties": {
+            "amount": {
+              "description": "Post-tax amount submitted by customer in local currency.",
+              "type": "number"
+            },
+            "valid_from": {
+              "description": "Datetime when user submitted data, with expected ISO 8601 format.",
+              "format": "date-time",
+              "type": "string"
+            }
+          },
+          "type": "object"
+        },
+        "monthly_non_housing_expenses": {
+          "additionalProperties": false,
+          "description": "All essential personal expenses, apart from housing. For example, food, transport and other loan repayments. Required for lending to sole traders.",
+          "properties": {
+            "amount": {
+              "description": "Amount submitted by customer in local currency.",
+              "type": "number"
+            },
+            "valid_from": {
+              "description": "Datetime when user submitted data, with expected ISO 8601 format.",
+              "format": "date-time",
+              "type": "string"
+            }
+          },
+          "type": "object"
+        },
+        "monthly_other_household_income": {
+          "additionalProperties": false,
+          "description": "Total income from other members of the applicant's household such as their wife or husband. Does not include their own income.",
+          "properties": {
+            "amount": {
+              "type": "number"
+            },
+            "valid_from": {
+              "description": "Datetime when user submitted data, with expected ISO 8601 format.",
+              "format": "date-time",
+              "type": "string"
+            }
+          },
+          "type": "object"
+        },
+        "number_of_dependents": {
+          "additionalProperties": false,
+          "description": "Number of people that are financially dependent on the person (such as children or people in their care).",
+          "properties": {
+            "count": {
+              "type": "integer"
+            },
+            "valid_from": {
+              "description": "Datetime when user submitted data, with expected ISO 8601 format.",
+              "format": "date-time",
+              "type": "string"
+            }
+          },
+          "type": "object"
+        },
+        "phones": {
+          "items": {
+            "additionalProperties": false,
+            "description": "Contact phone numbers. It's preferable to have both a primary and secondary phone number for the applicant if available.",
+            "properties": {
+              "number": {
+                "description": "Quite flexible, can handle with/without country code, e.g. +447778473883 / 07778473883.",
+                "maxLength": 20,
+                "type": "string"
+              },
+              "type": {
+                "description": "The applicant must have at least one primary number.",
+                "enum": ["primary", "secondary"]
+              }
+            },
+            "required": ["number"],
+            "type": "object"
+          },
+          "type": "array"
+        },
+        "privacy_policy": {
+          "additionalProperties": false,
+          "description": "Required to retrieve an automated decision. This field denotes both that the customer agrees to the iwoca privacy policy AND that they have received reasonable, visible notice that iwoca will perform a soft credit check.",
+          "properties": {
+            "agreed": {
+              "description": "Specify whether the user has agreed to the iwoca privacy policy.",
+              "type": "boolean"
+            },
+            "valid_from": {
+              "description": "Datetime when they agreed or disagreed with the iwoca privacy policy, with expected ISO 8601 format.",
+              "format": "date-time",
+              "type": "string"
+            }
+          },
+          "type": "object"
+        },
+        "residential_addresses": {
+          "items": {
+            "$ref": "#/definitions/address"
+          },
+          "type": "array"
+        },
+        "roles": {
+          "description": "There should only be one applicant but there may be multiple people with the other roles.",
+          "items": {
+            "enum": [
+              "shareholder",
+              "applicant",
+              "director",
+              "guarantor",
+              "partner",
+              "other",
+              "beneficial_owner"
+            ],
+            "type": "string"
+          },
+          "type": "array"
+        },
+        "title": {
+          "enum": [
+            "mr",
+            "ms",
+            "mrs",
+            "miss",
+            "doctor",
+            "professor",
+            "sir",
+            "lord",
+            "lady",
+            "baron",
+            "baroness",
+            "rev",
+            "other"
+          ],
+          "type": "string"
+        },
+        "uid": {
+          "description": "Unique identifier created and stored by the partner which will allow you to retrieve/update this data in the future.",
+          "format": "uuid",
+          "type": "string"
+        }
+      },
+      "required": ["uid"],
+      "title": "person",
+      "type": "object"
+    },
+    "marketing_opt_in": {
+      "additionalProperties": false,
+      "properties": {
+        "agreed": {
+          "description": "Specify if user has opted in to receive marketing emails from iwoca.",
+          "type": "boolean"
+        },
+        "valid_from": {
+          "description": "Datetime when they opted in or out of marketing emails, with expected ISO 8601 format.",
+          "format": "date-time",
+          "type": "string"
+        }
+      },
+      "title": "marketing_opt_in",
+      "type": "object"
+    },
+    "address": {
+      "additionalProperties": false,
+      "properties": {
+        "country": {
+          "enum": ["GB", "DE", "OTHER"],
+          "maxLength": 5,
+          "type": "string"
+        },
+        "date_from": {
+          "description": "Date with expected ISO 8601 format, for example, '2016-10-23'. Optionally specify the date when they moved to this address. This date can be an estimate.",
+          "example": "2016-10-23",
+          "format": "date",
+          "type": "string"
+        },
+        "equifax_token": {
+          "description": "Equifax's PTCABS token. If you have access to this, providing it here could help us retrieve credit information more consistently.",
+          "maxLength": 250,
+          "type": "string"
+        },
+        "flat_number": {
+          "maxLength": 250,
+          "type": "string"
+        },
+        "house_name": {
+          "maxLength": 250,
+          "type": "string"
+        },
+        "house_number": {
+          "maxLength": 250,
+          "type": "string"
+        },
+        "monthly_housing_expenses": {
+          "additionalProperties": false,
+          "description": "Monthly cost of rent or mortgage, depending on residential status, at this address. Required for lending to sole traders.",
+          "properties": {
+            "amount": {
+              "type": "number"
+            },
+            "valid_from": {
+              "description": "Datetime when user submitted data, with expected ISO 8601 format.",
+              "format": "date-time",
+              "type": "string"
+            }
+          },
+          "type": "object"
+        },
+        "postcode": {
+          "maxLength": 250,
+          "type": "string"
+        },
+        "property_value": {
+          "additionalProperties": false,
+          "description": "Estimated value of house or flat specified by address.",
+          "properties": {
+            "amount": {
+              "description": "Amount in local currency.",
+              "type": "number"
+            },
+            "valid_from": {
+              "description": "Datetime when user submitted data, with expected ISO 8601 format.",
+              "format": "date-time",
+              "type": "string"
+            }
+          },
+          "type": "object"
+        },
+        "residential_status": {
+          "description": "The rent_free option covers situations where they are living in a property that they don't own but they are not paying rent (e.g. living with parents or family).",
+          "enum": ["tenant", "owner_with_mortgage", "owner_no_mortgage", "rent_free"],
+          "type": "string"
+        },
+        "street_line_1": {
+          "description": "The first line of the customer's address. For best results, this should include their flat or house name or number where possible.",
+          "maxLength": 250,
+          "type": "string"
+        },
+        "street_line_2": {
+          "description": "The second line of the customer's address. For best results, this should include their street number where possible and applicable.",
+          "maxLength": 250,
+          "type": "string"
+        },
+        "town": {
+          "maxLength": 250,
+          "type": "string"
+        }
+      },
+      "title": "address",
+      "type": "object"
+    }
+  }
+}