kentaa-api 0.3.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58138e9b4ca52fbd0e9af4db524365bfed6f349ba30fb498c2078aaeeb280dd8
-  data.tar.gz: 01b8334eb0e53bee3cc4d5bc6f48047a1ec8189348c142deeefeee9c54ac32ab
+  metadata.gz: da9bb3b58fe4533c642cd80ca677b29aff5e779aa1335ecbda2ba5c502133487
+  data.tar.gz: 3ad011c17955567de318e2e1c8f959afd3ea3f6aad8d66381f0d2c48abd7c6e5
 SHA512:
-  metadata.gz: 67f498117301de1f06b0e233fa7771cc41a8afbc41f27f3dc1a5124a1145463efeb9dae068d758fc8f867484f83973dce97972998307eea663e77a78367ed843
-  data.tar.gz: e5b371bac8cdaaccc5c133581176a1c28c364c997fecb6d7611ad60d0fb60faba2452ac7bb39e0b450db084761c8644a8c7f0768d863f5efb118e43cff945d96
+  metadata.gz: 2b00e2f9db7313a96e4d205337ae9c2a9d9872d5ff97865246a6b1b391ae47cd615c2e736eac0ea5a6e890cb553bbfa66d5ddf31b83a60dc6d48f580912a430d
+  data.tar.gz: 50f33d783a2055d71bdbf9bdc446be064bb109b71e04f6736e9dfb29b0dc670fe42001b89c218904405a218b3700c3d030fdd1c1292658b958ba77e62b9dafc3

data/.github/workflows/test.yml

@@ -0,0 +1,23 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.4', '2.5', '2.6', '2.7', '3.0']
+
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - name: Run tests
+      run: bundle exec rake

data/.gitignore

@@ -1,4 +1,5 @@
 /.bundle/
+/.idea
 /.yardoc
 /_yardoc/
 /coverage/
@@ -6,6 +7,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+.rakeTasks
 
 # rspec failure tracking
 .rspec_status

data/.rubocop.yml

@@ -1,13 +1,20 @@
 # Kentaa-API RuboCop configuration
 
-require: rubocop-rspec
+require:
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
 
 AllCops:
-  TargetRubyVersion: 2.3
+  NewCops: enable
+  TargetRubyVersion: 2.4
   DisplayCopNames: true
   DisplayStyleGuide: true
+  Exclude:
+    - 'tmp/**/*'
+    - 'vendor/**/*'
 
-Gemspec/RequiredRubyVersion:
+Layout/LineLength:
   Enabled: false
 
 Metrics/AbcSize:
@@ -22,10 +29,10 @@ Metrics/ClassLength:
 Metrics/CyclomaticComplexity:
   Enabled: false
 
-Metrics/LineLength:
+Metrics/MethodLength:
   Enabled: false
 
-Metrics/MethodLength:
+Metrics/PerceivedComplexity:
   Enabled: false
 
 RSpec/DescribedClass:
@@ -43,6 +50,15 @@ Style/Documentation:
 Style/ExpandPathArguments:
   Enabled: false
 
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
 Style/IfUnlessModifier:
   Enabled: false
 

data/Gemfile

@@ -5,5 +5,7 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in kentaa-api.gemspec
 gemspec
 
-gem 'rubocop', '~> 0.72.0'
-gem 'rubocop-rspec', '~> 1.33.0'
+gem 'rubocop', '~> 1.12.0'
+gem 'rubocop-performance', '~> 1.10.2'
+gem 'rubocop-rake', '~> 0.5.1'
+gem 'rubocop-rspec', '~> 2.2.0'

data/Gemfile.lock

@@ -1,50 +1,61 @@
 PATH
   remote: .
   specs:
-    kentaa-api (0.3.0)
+    kentaa-api (0.6.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     addressable (2.5.2)
       public_suffix (>= 2.0.2, < 4.0)
-    ast (2.4.0)
+    ast (2.4.2)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
-    diff-lcs (1.3)
+    diff-lcs (1.4.4)
     hashdiff (0.3.7)
-    jaro_winkler (1.5.3)
-    parallel (1.17.0)
-    parser (2.6.3.0)
-      ast (~> 2.4.0)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
     public_suffix (3.0.3)
     rainbow (3.0.0)
-    rake (10.5.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.2)
+    rake (13.0.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-    rubocop (0.72.0)
-      jaro_winkler (~> 1.5.1)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.12.0)
       parallel (~> 1.10)
-      parser (>= 2.6)
+      parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
-    rubocop-rspec (1.33.0)
-      rubocop (>= 0.60.0)
-    ruby-progressbar (1.10.1)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    rubocop-performance (1.10.2)
+      rubocop (>= 0.90.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rake (0.5.1)
+      rubocop
+    rubocop-rspec (2.2.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.11.0)
     safe_yaml (1.0.4)
-    unicode-display_width (1.6.0)
+    unicode-display_width (2.0.0)
     webmock (2.3.2)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
@@ -54,13 +65,15 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.14)
+  bundler (~> 2.0)
   kentaa-api!
-  rake (~> 10.0)
+  rake (~> 13.0)
   rspec (~> 3.0)
-  rubocop (~> 0.72.0)
-  rubocop-rspec (~> 1.33.0)
+  rubocop (~> 1.12.0)
+  rubocop-performance (~> 1.10.2)
+  rubocop-rake (~> 0.5.1)
+  rubocop-rspec (~> 2.2.0)
   webmock (~> 2.3, >= 2.3.2)
 
 BUNDLED WITH
-   1.17.1
+   2.2.3

data/README.md

@@ -1,10 +1,32 @@
 # Kentaa API
 
 [![Gem Version](https://badge.fury.io/rb/kentaa-api.svg)](https://badge.fury.io/rb/kentaa-api)
-[![Build Status](https://travis-ci.org/KentaaNL/kentaa-api.svg?branch=master)](https://travis-ci.org/KentaaNL/kentaa-api)
+[![Build Status](https://github.com/KentaaNL/kentaa-api/actions/workflows/test.yml/badge.svg)](https://github.com/KentaaNL/kentaa-api/actions)
 [![Code Climate](https://codeclimate.com/github/KentaaNL/kentaa-api/badges/gpa.svg)](https://codeclimate.com/github/KentaaNL/kentaa-api)
 
-This gem provides a Ruby library for communicating with the [Kentaa API](https://api.kentaa.nl/v1/doc).
+This gem provides a Ruby library for communicating with the [Kentaa API](https://developer.kentaa.nl/kentaa-api/).
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Usage](#usage)
+  - [Actions](#actions)
+  - [Donation forms](#donation-forms)
+  - [Donations](#donations)
+  - [Manual donations](#manual-donations)
+  - [Newsletter subscriptions](#newsletter-subscriptions)
+  - [Performances](#performances)
+  - [Projects](#projects)
+  - [Recurring donors](#recurring-donors)
+  - [Segments](#segments)
+  - [Sites](#sites)
+  - [Teams](#teams)
+  - [Users](#users)
+  - [Pagination](#pagination)
+- [Error handling](#error-handling)
+- [Development](#development)
+- [Contributing](#contributing)
+- [License](#license)
 
 ## Installation
 
@@ -24,143 +46,418 @@ Or install it yourself as:
 
 ## Usage
 
-### Initialization
-
-Create the client with your API key:
+Create a Kentaa API client using your API key:
 
 ```ruby
 require 'kentaa/api'
 
-config = Kentaa::Api::Config.new('your_api_key')
-client = Kentaa::Api::Client.new(config)
+client = Kentaa::Api::Client.new(api_key: 'your_api_key')
 ```
 
-### Retrieving data
+The client is created for the production environment by default. If you want to use the testing environment, then add `test: true`:
 
-All endpoints use the same convention for retrieving data. The methods `list` and `all` are used for retrieving multiple resources. The method `get` is used for retrieving a single resource.
+```ruby
+client = Kentaa::Api::Client.new(api_key: 'your_api_key', test: true)
+```
 
-The `list` method on the endpoint returns an [Enumerable](https://ruby-doc.org/core/Enumerable.html) object:
+### Actions
 
 ```ruby
-actions = client.actions.list
-
-actions.each { |a| puts a.title }
-actions.first
+# List Actions
+actions = client.actions       # paginated
+actions = client.actions.all   # non-paginated
+
+actions.each do |action|
+  action.title  # => "Lorem ipsum"
+  action.url  # => "https://demo1.kentaa.nl/actie/john-doe"
+end
+
+# Get Action by ID or slug
+action = client.actions.get(1)
+action = client.actions.get("john-doe")
+
+action.title  # => "Lorem ipsum"
+action.url  # => "https://demo1.kentaa.nl/actie/john-doe"
+
+# Create a new Action
+action = client.actions.create(
+  title: "Lorem ipsum",
+  description: "Dolorum animi qui nihil iure dolore velit.",
+  owner_id: 1
+)
+
+action.id  # => 1
+action.title  # => "Lorem ipsum"
+action.description  # => "Dolorum animi qui nihil iure dolore velit."
+action.owner  # => Kentaa::Api::Resources::User
+
+# Update an Action
+action = client.actions.update(1, title: "Foobar")
+
+action.title  # => "Foobar"
 ```
 
-The results might be part of a paginated set. You can query the next page by doing:
+See also the [Kentaa API docs](https://developer.kentaa.nl/kentaa-api/#actions) and [Kentaa::Api::Resources::Action](lib/kentaa/api/resources/action.rb) for all available properties.
+
+### Donation forms
 
 ```ruby
-actions = client.actions.list(page: actions.next_page) if actions.next_page?
+# List Donation forms
+donation_forms = client.donation_forms       # paginated
+donation_forms = client.donation_forms.all   # non-paginated
+
+donation_forms.each do |form|
+  form.title  # => "Lorem ipsum dolor sit amet"
+  form.url  # => "https://demo1.kentaa.nl/form"
+end
+
+# Get Donation form
+form = client.donation_forms.get(1)
+
+form.title  # => "Lorem ipsum dolor sit amet"
+form.owner  # => Kentaa::Api::Resources::User
+form.url  # => "https://demo1.kentaa.nl/form"
+form.total_amount  # => BigDecimal("95.0")
 ```
 
-See also `Kentaa::Api::Resources::List` for the available methods for pagination.
+See also the [Kentaa API docs](https://developer.kentaa.nl/kentaa-api/#donation-forms) and [Kentaa::Api::Resources::DonationForm](lib/kentaa/api/resources/donation_form.rb) for all available properties.
 
-The `all` method on the endpoint returns an [Enumerator](https://ruby-doc.org/core/Enumerator.html) and will iterate automatically through all pages to retrieve the requested data.
+### Donations
 
 ```ruby
-actions = client.actions.all
-
-actions.each { |a| puts a.title }
-actions.first(100)
+# List Donations
+donations = client.donations       # paginated
+donations = client.donations.all   # non-paginated
+
+donations.each do |donations|
+  donation.first_name  # => "John"
+  donation.last_name  # => "Doe"
+end
+
+# Get Donation
+donation = client.donations.get(1)
+
+donation.first_name  # => "John"
+donation.last_name  # => "Doe"
+donation.amount  # => BigDecimal("15.0")
+donation.entity  # => Kentaa::Api::Resources::Site
 ```
 
-### Requests
+See also the [Kentaa API docs](https://developer.kentaa.nl/kentaa-api/#donations) and [Kentaa::Api::Resources::Donation](lib/kentaa/api/resources/donation.rb) for all available properties.
 
-Below a summary of the supported requests per endpoint.
+### Manual donations
 
-#### Actions
+```ruby
+# List Manual donations
+donations = client.manual_donations       # paginated
+donations = client.manual_donations.all   # non-paginated
+
+donations.each do |donations|
+  donation.first_name  # => "John"
+  donation.last_name  # => "Doe"
+end
+
+# Get Manual donation
+donation = client.manual_donations.get(1)
+
+donation.first_name  # => "John"
+donation.last_name  # => "Doe"
+donation.amount  # => BigDecimal("15.0")
+donation.entity  # => Kentaa::Api::Resources::Site
+
+# Create a Manual donation
+donation = client.manual_donations.create(
+  first_name: "John",
+  last_name: "Doe",
+  amount: "15.0"
+)
+
+donation.id  # => 1
+donation.first_name  # => "John"
+donation.last_name  # => "Doe"
+donation.amount  # => BigDecimal("15.0")
+donation.entity  # => Kentaa::Api::Resources::Site
+
+# Update a Manual donation
+donation = client.manual_donations.update(1, first_name: "Jane")
+
+donation.first_name  # => "Jane"
+
+# Delete a Manual donation
+client.manual_donations.delete(1)
+```
+
+See also the [Kentaa API docs](https://developer.kentaa.nl/kentaa-api/#manual-donations) and [Kentaa::Api::Resources::ManualDonation](lib/kentaa/api/resources/manual_donation.rb) for all available properties.
+
+### Newsletter subscriptions
 
 ```ruby
-actions = client.actions.list             # get actions (paginated)
-actions = client.actions.all              # get all actions (non-paginated)
+# List Newsletter subscriptions
+newsletter_subscriptions = client.newsletter_subscriptions       # paginated
+newsletter_subscriptions = client.newsletter_subscriptions.all   # non-paginated
+
+newsletter_subscriptions.each do |subscription|
+  subscription.email  # => "john.doe@kentaa.nl"
+  subscription.subscription_url  # => "https://demo1.kentaa.nl"
+end
+
+# Get Newsletter subscription
+subscription = client.newsletter_subscriptions.get(1)
 
-action = client.actions.get(1)            # query action by ID
-action = client.actions.get("john-doe")   # query action by slug
+subscription.email  # => "john.doe@kentaa.nl"
+subscription.subscription_url  # => "https://demo1.kentaa.nl"
 ```
 
-See also the [Kentaa API docs](https://api.kentaa.nl/v1/doc/actions).
+See also the [Kentaa API docs](https://developer.kentaa.nl/kentaa-api/#newsletter-subscriptions) and [Kentaa::Api::Resources::NewsletterSubscription](lib/kentaa/api/resources/newsletter_subscription.rb) for all available properties.
 
-#### Donations
+### Performances
+
+Performances are available on an [Kentaa::Api::Resources::Action](lib/kentaa/api/resources/action.rb), so you first need to retrieve an Action.
 
 ```ruby
-donations = client.donations.list    # get donations (paginated)
-donations = client.donations.all     # get all donations (non-paginated)
+action = client.actions.get(1)
+
+# List Performances
+performances = action.performances       # paginated
+performances = action.performances.all   # non-paginated
+
+performances.each do |performance|
+  performance.title  # => "First tour"
+  performance.distance  # => BigDecimal("65.25")
+end
+
+# Get Performance
+donation = action.performances.get(1)
+
+performance.title  # => "First tour"
+performance.distance  # => BigDecimal("65.25")
+
+# Create a Performance
+performance = action.performances.create(
+  title: "First tour",
+  performance_type: "biking",
+  performance_at: Time.now,
+  distance: "65.25"
+)
 
-donation = client.donations.get(1)   # query donation by ID
+performance.title  # => "First tour"
+performance.distance  # => BigDecimal("65.25")
+
+# Update a Performance
+performance = action.performance.update(1, title: "Big tour")
+
+performance.title  # => "Big tour"
+
+# Delete a Performance
+action.performance.delete(1)
 ```
 
-See also the [Kentaa API docs](https://api.kentaa.nl/v1/doc/donations).
+See also the [Kentaa API docs](https://developer.kentaa.nl/kentaa-api/#performances) and [Kentaa::Api::Resources::Performance](lib/kentaa/api/resources/performance.rb) for all available properties.
 
-#### Newsletter subscriptions
+### Projects
 
 ```ruby
-newsletter_subscriptions = client.newsletter_subscriptions.all    # get newsletter subscriptions (paginated)
-newsletter_subscriptions = client.newsletter_subscriptions.list   # get all newsletter subscriptions (non-paginated)
+# List Projects
+projects = client.projects       # paginated
+projects = client.projects.all   # non-paginated
+
+projects.each do |project|
+  project.title  # => "Dignissimos provident rerum enim alias magni asperna..."
+  project.target_amount  # => 250000
+end
+
+# Get Project by ID or slug
+project = client.projects.get(1)
+project = client.projects.get("project")
+
+project.title  # => "Dignissimos provident rerum enim alias magni asperna..."
+project.target_amount  # => 250000
+project.url  # => "https://demo1.kentaa.nl/project/dignissimos-provident-rerum-enim-alias-magni-asperna"
+```
+
+See also the [Kentaa API docs](https://developer.kentaa.nl/kentaa-api/#projects) and [Kentaa::Api::Resources::Project](lib/kentaa/api/resources/project.rb) for all available properties.
 
+### Recurring donors
 
-newsletter_subscriptions = client.newsletter_subscriptions.get(1) # query newsletter subscription by ID
+```ruby
+# List Recurring donors
+recurring_donors = client.recurring_donors       # paginated
+recurring_donors = client.recurring_donors.all   # non-paginated
+
+recurring_donors.each do |recurring_donor|
+  recurring_donor.first_name  # => "John"
+  recurring_donor.last_name  # => "Doe"
+end
+
+# Get Recurring donor
+recurring_donor = client.recurring_donors.get(1)
+
+recurring_donor.first_name  # => "John"
+recurring_donor.last_name  # => "Doe"
+recurring_donor.amount  # => BigDecimal("15.0")
+recurring_donor.entity  # => Kentaa::Api::Resources::DonationForm
 ```
 
-See also the [Kentaa API docs](https://api.kentaa.nl/v1/doc/newsletter-subscriptions).
+See also the [Kentaa API docs](https://developer.kentaa.nl/kentaa-api/#recurring-donors) and [Kentaa::Api::Resources::RecurringDonor](lib/kentaa/api/resources/recurring_donor.rb) for all available properties.
 
-#### Projects
+### Segments
 
 ```ruby
-projects = client.projects.list            # get projects (paginated)
-projects = client.projects.all             # get all projects (non-paginated)
-
-project = client.projects.get(1)           # query project by ID
-project = client.projects.get("project")   # query project by slug
+# List Segments
+segments = client.segments       # paginated
+segments = client.segments.all   # non-paginated
+
+segments.each do |segment|
+  segment.name  # => "Segment 2"
+  segment.url  # => "https://segment-2.demo1.kentaa.nl/"
+end
+
+# Get Segment
+segment = client.segments.get(1)
+
+segment.name  # => "Segment 2"
+segment.title  # => "Aut est maxime nostrum."
+segment.url  # => "https://segment-2.demo1.kentaa.nl/"
+segment.target_amount  # => 2685
 ```
 
-See also the [Kentaa API docs](https://api.kentaa.nl/v1/doc/projects).
+See also the [Kentaa API docs](https://developer.kentaa.nl/kentaa-api/#segments) and [Kentaa::Api::Resources::Segment](lib/kentaa/api/resources/segment.rb) for all available properties.
+
+### Sites
 
-#### Segments
+The only method here is `current`, since there is only one site per API key.
 
 ```ruby
-segments = client.segments.list    # get segments (paginated)
-segments = client.segments.all     # get all segments (non-paginated)
+# Get current Site
+site = client.sites.current
 
-segment = client.segments.get(1)   # query segment by ID
+site.title  # => "Aut est maxime nostrum."
+site.description  # => "Maiores ut velit fugiat eos. Quae est nostrum rerum aut et nihil. Sequi eveniet occaecati et est corporis et enim."
+site.url  # => "https://demo1.kentaa.nl/"
 ```
 
-See also the [Kentaa API docs](https://api.kentaa.nl/v1/doc/segments).
+See also the [Kentaa API docs](https://developer.kentaa.nl/kentaa-api/#sites) and [Kentaa::Api::Resources::Site](lib/kentaa/api/resources/site.rb) for all available properties.
 
-#### Sites
+### Teams
 
-The only method here is `current`, since there is only one site.
+```ruby
+# List Teams
+teams = client.teams       # paginated
+teams = client.teams.all   # non-paginated
+
+teams.each do |team|
+  team.name  # => "Asperiores beatae voluptate qui."
+  team.url  # => "https://demo1.kentaa.nl/team/asperiores-beatae-voluptate-qui"
+end
+
+# Get Team by ID or slug
+team = client.teams.get(1)
+team = client.teams.get("team")
+
+team.name  # => "Asperiores beatae voluptate qui."
+team.url  # => "https://demo1.kentaa.nl/team/asperiores-beatae-voluptate-qui"
+team.total_amount  # => BigDecimal("225.0")
+```
+
+See also the [Kentaa API docs](https://developer.kentaa.nl/kentaa-api/#teams) and [Kentaa::Api::Resources::Team](lib/kentaa/api/resources/team.rb) for all available properties.
+
+### Users
 
 ```ruby
-site = client.sites.current    # get the current site
+# List Users
+users = client.users       # paginated
+users = client.users.all   # non-paginated
+
+users.each do |user|
+  user.first_name  # => "John"
+  user.last_name  # => "Doe"
+end
+
+# Get User
+user = client.users.get(1)
+
+user.first_name  # => "John"
+user.last_name  # => "Doe"
+
+# Create an User
+user = client.users.create(
+  first_name: "John",
+  last_name: "Doe"
+)
+
+user.id  # => 1
+user.first_name  # => "John"
+user.last_name  # => "Doe"
+
+# Update an User
+user = client.users.update(1, first_name: "Jane")
+
+user.first_name  # => "Jane"
+
+# Authenticate an User
+user = client.users.auth(email: "john.doe@kentaa.nl", password: "secret")
+
+user.id  # => 1
+user.first_name  # => "John"
+user.last_name  # => "Doe"
 ```
 
-See also the [Kentaa API docs](https://api.kentaa.nl/v1/doc/sites).
+See also the [Kentaa API docs](https://developer.kentaa.nl/kentaa-api/#users) and [Kentaa::Api::Resources::User](lib/kentaa/api/resources/user.rb) for all available properties.
+
+### Pagination
 
-#### Teams
+All List actions return paginated results in an [Enumerable](https://ruby-doc.org/core/Enumerable.html) object. The default page size is 25, but you can can customize this by setting the `per_page` parameter.
 
 ```ruby
-teams = client.teams.list          # get teams (paginated)
-teams = client.teams.all           # get all teams (non-paginated)
+actions = client.actions(per_page: 100)
 
-team = client.teams.get(1)         # query team by ID
-team = client.teams.get("team")    # query team by slug
+actions.each do |action|
+  action.title  # => "Lorem ipsum"
+  action.url  # => "https://demo1.kentaa.nl/actie/john-doe"
+end
 ```
 
-See also the [Kentaa API docs](https://api.kentaa.nl/v1/doc/teams).
+You can iterate through the pages using the `.next` method and checking the result. For example:
+
+```ruby
+actions = client.actions
+
+loop do  
+  actions.each do |action|
+    # Do something with actions
+  end
 
+  actions = actions.next
+  break if actions.nil?
+end
+```
 
-#### Users
+The `all` method on the endpoint returns a lazy [Enumerator](https://ruby-doc.org/core/Enumerator.html) and will automatically iterate through all pages and retrieve the requested data.
 
 ```ruby
-users = client.users.list          # get users (paginated)
-users = client.users.all           # get all users (non-paginated)
+actions = client.actions.all
 
-user = client.users.get(1)         # query user by ID
+actions.each do |action|
+  action.title  # => "Lorem ipsum"
+  action.url  # => "https://demo1.kentaa.nl/actie/john-doe"
+end
 ```
 
-See also the [Kentaa API docs](https://api.kentaa.nl/v1/doc/users).
+See [Kentaa::Api::Resources::List](lib/kentaa/api/resources/list.rb) for all available pagination methods.
+
+## Error handling
 
+All responses that are not HTTP status 20x will result in a [Kentaa::Api::RequestError](lib/kentaa/api/exception.rb).
+
+```ruby
+begin
+  client.actions.get("invalid")
+rescue Kentaa::Api::RequestError => e
+  e.message  # => "404: Requested resource was not found."
+  e.http_code  # => 404
+  e.errors  # => Array[Kentaa::Api::Resources::Error]
+end
+```
 
 ## Development