README.md in barkibu-kb-0.16.2 vs README.md in barkibu-kb-0.17.0
- old
+ new
@@ -68,10 +68,12 @@
- `destroy!`
- deletes the entity in the Knowledge Base
- throws a `KB::Error` exception if something went wrong
- `contracts`
- returns all the KB::PetContract associated with this pet parent
+- `referrals`
+ - returns all the KB::Referral associated with this pet parent
#### Assessment 📄
`KB::Assessment` represents a read-only resource exposing:
@@ -159,9 +161,17 @@
- arg: `filters` hash of filters
- returns: and array of Dog Breed instances matching the filters
- `cats` (alias for all(species: 'cat'))
- arg: `filters` hash of filters
- returns: and array of Cat Breed instances matching the filters
+
+#### Referral
+`KB::Referral` represets a referral resource
+
+- `create`
+ - arg: `pet_parent_key`, `attributes` to initialize the entity
+ - returns: the raw attributes of the Referral instance
+ - throws an `KB::Error` exception if something went wrong
### Make an ActiveRecord wrap a KB entity
The `KB::Concerns::AsKBWrapper` concern has been created in order to easily make an ActiveRecord model wrap a KB model.