supersaas-api-client 1.1.1 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 43c876c27f4bc637ce610661c4db2a17d759f5c5d9edc1fc8b0c5fa44618563c
-  data.tar.gz: d51433a0686154e7b829626deb77f376a7aa9b3e2f6711c045973192c9484dad
+  metadata.gz: 71f6ba86e7f24695dc5e409697c2e51e6eacbc8a4f092a4905d761c13349e397
+  data.tar.gz: 595c57b1f7bd7ffef07e69f20fdd094335822698600af75dcc68941b78c3cf84
 SHA512:
-  metadata.gz: '0964ed2b094ee239eefaa06605110181d4c5294d56c4f1b8967c7036474932c12cd330179021335fc33312b280e1d923eafd4c4c2a8c44c4532222c480786198'
-  data.tar.gz: 535e50d5495659bd3db3b547f010c24e39c9834ffc9c7368d9b0040a93789ca5061dc7804f7bebc7045a5a81ab0217818bd1c7785fc3d83afb02d718382b30af
+  metadata.gz: fc9a86a050f306cd6d8a845453d41ea124e4202531c5a2fe7483a8ea693fa522963e7bd0f15d36905b8689bd4e7338ed72ee72db4bbb31b872719ceb3da5155d
+  data.tar.gz: cd85cf6f149ed8c42026bd1c3f3397428d0de95c753553e93c3c4f2927abdec6d1e27702d568cf84d5b448d5d4be80d9a86d76ccd3a004f3825aee6b7768b85d

data/.github/workflows/actions.yaml

@@ -0,0 +1,21 @@
+name: SuperSaaS Ruby API Client CI
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        ruby: ['3.0', '3.1', '3.2', '3.3', 'head', 'jruby', 'jruby-head']
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - run: bundle exec rake

data/.gitignore

@@ -6,6 +6,8 @@
 /pkg/
 /spec/reports/
 /tmp/
+/supersaas-api-client/
 .DS_Store
 .idea/*
-*.gem
+*.gem
+*.swp

data/.rubocop.yml

@@ -0,0 +1 @@
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,296 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2024-01-17 11:07:18 UTC using RuboCop version 1.60.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 2
+# Configuration parameters: Severity, Include.
+# Include: **/*.gemspec
+Gemspec/RequiredRubyVersion:
+  Exclude:
+    - 'supersaas-api-client.gemspec'
+    - 'supersaas-api-client/supersaas-api-client.gemspec'
+
+# Offense count: 8
+# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
+Metrics/AbcSize:
+  Max: 72
+
+# Offense count: 2
+# Configuration parameters: CountComments, CountAsOne.
+Metrics/ClassLength:
+  Max: 200
+
+# Offense count: 3
+# Configuration parameters: AllowedMethods, AllowedPatterns.
+Metrics/CyclomaticComplexity:
+  Max: 20
+
+# Offense count: 9
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+Metrics/MethodLength:
+  Max: 71
+
+# Offense count: 7
+# Configuration parameters: CountKeywordArgs.
+Metrics/ParameterLists:
+  MaxOptionalParameters: 9
+  Max: 10
+
+# Offense count: 3
+# Configuration parameters: AllowedMethods, AllowedPatterns.
+Metrics/PerceivedComplexity:
+  Max: 17
+
+# Offense count: 1
+# Configuration parameters: ExpectMatchingDefinition, CheckDefinitionPathHierarchy, CheckDefinitionPathHierarchyRoots, Regex, IgnoreExecutableScripts, AllowedAcronyms.
+# CheckDefinitionPathHierarchyRoots: lib, spec, test, src
+# AllowedAcronyms: CLI, DSL, ACL, API, ASCII, CPU, CSS, DNS, EOF, GUID, HTML, HTTP, HTTPS, ID, IP, JSON, LHS, QPS, RAM, RHS, RPC, SLA, SMTP, SQL, SSH, TCP, TLS, TTL, UDP, UI, UID, UUID, URI, URL, UTF8, VM, XML, XMPP, XSRF, XSS
+Naming/FileName:
+  Exclude:
+    - 'lib/supersaas-api-client.rb'
+
+# Offense count: 22
+# Configuration parameters: EnforcedStyle, CheckMethodNames, CheckSymbols, AllowedIdentifiers, AllowedPatterns.
+# SupportedStyles: snake_case, normalcase, non_integer
+# AllowedIdentifiers: capture3, iso8601, rfc1123_date, rfc822, rfc2822, rfc3339, x86_64
+Naming/VariableNumber:
+  Exclude:
+    - 'lib/supersaas-api-client/api/appointments.rb'
+    - 'lib/supersaas-api-client/api/users.rb'
+    - 'lib/supersaas-api-client/models/appointment.rb'
+    - 'test/appointments_test.rb'
+    - 'test/users_test.rb'
+
+# Offense count: 18
+# Configuration parameters: AllowedConstants.
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 6
+# This cop supports safe autocorrection (--autocorrect).
+Style/IfUnlessModifier:
+  Exclude:
+    - 'lib/supersaas-api-client/api/base_api.rb'
+    - 'lib/supersaas-api-client/client.rb'
+
+# Offense count: 5
+# Configuration parameters: AllowedMethods.
+# AllowedMethods: respond_to_missing?
+Style/OptionalBooleanParameter:
+  Exclude:
+    - 'lib/supersaas-api-client/api/appointments.rb'
+
+# Offense count: 6
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns.
+# URISchemes: http, https
+Layout/LineLength:
+  Max: 191
+
+Gemspec/DeprecatedAttributeAssignment: # new in 1.30
+  Enabled: true
+Gemspec/DevelopmentDependencies: # new in 1.44
+  Enabled: false
+Gemspec/RequireMFA: # new in 1.23
+  Enabled: true
+Layout/LineContinuationLeadingSpace: # new in 1.31
+  Enabled: true
+Layout/LineContinuationSpacing: # new in 1.31
+  Enabled: true
+Layout/LineEndStringConcatenationIndentation: # new in 1.18
+  Enabled: true
+Layout/SpaceBeforeBrackets: # new in 1.7
+  Enabled: true
+Lint/AmbiguousAssignment: # new in 1.7
+  Enabled: true
+Lint/AmbiguousOperatorPrecedence: # new in 1.21
+  Enabled: true
+Lint/AmbiguousRange: # new in 1.19
+  Enabled: true
+Lint/ConstantOverwrittenInRescue: # new in 1.31
+  Enabled: true
+Lint/DeprecatedConstants: # new in 1.8
+  Enabled: true
+Lint/DuplicateBranch: # new in 1.3
+  Enabled: true
+Lint/DuplicateMagicComment: # new in 1.37
+  Enabled: true
+Lint/DuplicateMatchPattern: # new in 1.50
+  Enabled: true
+Lint/DuplicateRegexpCharacterClassElement: # new in 1.1
+  Enabled: true
+Lint/EmptyBlock: # new in 1.1
+  Enabled: true
+Lint/EmptyClass: # new in 1.3
+  Enabled: true
+Lint/EmptyInPattern: # new in 1.16
+  Enabled: true
+Lint/IncompatibleIoSelectWithFiberScheduler: # new in 1.21
+  Enabled: true
+Lint/ItWithoutArgumentsInBlock: # new in 1.59
+  Enabled: true
+Lint/LambdaWithoutLiteralBlock: # new in 1.8
+  Enabled: true
+Lint/LiteralAssignmentInCondition: # new in 1.58
+  Enabled: true
+Lint/MixedCaseRange: # new in 1.53
+  Enabled: true
+Lint/NoReturnInBeginEndBlocks: # new in 1.2
+  Enabled: true
+Lint/NonAtomicFileOperation: # new in 1.31
+  Enabled: true
+Lint/NumberedParameterAssignment: # new in 1.9
+  Enabled: true
+Lint/OrAssignmentToConstant: # new in 1.9
+  Enabled: true
+Lint/RedundantDirGlobSort: # new in 1.8
+  Enabled: true
+Lint/RedundantRegexpQuantifiers: # new in 1.53
+  Enabled: true
+Lint/RefinementImportMethods: # new in 1.27
+  Enabled: true
+Lint/RequireRangeParentheses: # new in 1.32
+  Enabled: true
+Lint/RequireRelativeSelfPath: # new in 1.22
+  Enabled: true
+Lint/SymbolConversion: # new in 1.9
+  Enabled: true
+Lint/ToEnumArguments: # new in 1.1
+  Enabled: true
+Lint/TripleQuotes: # new in 1.9
+  Enabled: true
+Lint/UnexpectedBlockArity: # new in 1.5
+  Enabled: true
+Lint/UnmodifiedReduceAccumulator: # new in 1.1
+  Enabled: true
+Lint/UselessRescue: # new in 1.43
+  Enabled: true
+Lint/UselessRuby2Keywords: # new in 1.23
+  Enabled: true
+Metrics/CollectionLiteralLength: # new in 1.47
+  Enabled: true
+Naming/BlockForwarding: # new in 1.24
+  Enabled: true
+Security/CompoundHash: # new in 1.28
+  Enabled: true
+Security/IoMethods: # new in 1.22
+  Enabled: true
+Style/ArgumentsForwarding: # new in 1.1
+  Enabled: true
+Style/ArrayIntersect: # new in 1.40
+  Enabled: true
+Style/CollectionCompact: # new in 1.2
+  Enabled: true
+Style/ComparableClamp: # new in 1.44
+  Enabled: true
+Style/ConcatArrayLiterals: # new in 1.41
+  Enabled: true
+Style/DataInheritance: # new in 1.49
+  Enabled: true
+Style/DirEmpty: # new in 1.48
+  Enabled: true
+Style/DocumentDynamicEvalDefinition: # new in 1.1
+  Enabled: true
+Style/EmptyHeredoc: # new in 1.32
+  Enabled: true
+Style/EndlessMethod: # new in 1.8
+  Enabled: true
+Style/EnvHome: # new in 1.29
+  Enabled: true
+Style/ExactRegexpMatch: # new in 1.51
+  Enabled: true
+Style/FetchEnvVar: # new in 1.28
+  Enabled: true
+Style/FileEmpty: # new in 1.48
+  Enabled: true
+Style/FileRead: # new in 1.24
+  Enabled: true
+Style/FileWrite: # new in 1.24
+  Enabled: true
+Style/HashConversion: # new in 1.10
+  Enabled: true
+Style/HashExcept: # new in 1.7
+  Enabled: true
+Style/IfWithBooleanLiteralBranches: # new in 1.9
+  Enabled: true
+Style/InPatternThen: # new in 1.16
+  Enabled: true
+Style/MagicCommentFormat: # new in 1.35
+  Enabled: true
+Style/MapCompactWithConditionalBlock: # new in 1.30
+  Enabled: true
+Style/MapToHash: # new in 1.24
+  Enabled: true
+Style/MapToSet: # new in 1.42
+  Enabled: true
+Style/MinMaxComparison: # new in 1.42
+  Enabled: true
+Style/MultilineInPatternThen: # new in 1.16
+  Enabled: true
+Style/NegatedIfElseCondition: # new in 1.2
+  Enabled: true
+Style/NestedFileDirname: # new in 1.26
+  Enabled: true
+Style/NilLambda: # new in 1.3
+  Enabled: true
+Style/NumberedParameters: # new in 1.22
+  Enabled: true
+Style/NumberedParametersLimit: # new in 1.22
+  Enabled: true
+Style/ObjectThen: # new in 1.28
+  Enabled: true
+Style/OpenStructUse: # new in 1.23
+  Enabled: true
+Style/OperatorMethodCall: # new in 1.37
+  Enabled: true
+Style/QuotedSymbols: # new in 1.16
+  Enabled: true
+Style/RedundantArgument: # new in 1.4
+  Enabled: true
+Style/RedundantArrayConstructor: # new in 1.52
+  Enabled: true
+Style/RedundantConstantBase: # new in 1.40
+  Enabled: true
+Style/RedundantCurrentDirectoryInPath: # new in 1.53
+  Enabled: true
+Style/RedundantDoubleSplatHashBraces: # new in 1.41
+  Enabled: true
+Style/RedundantEach: # new in 1.38
+  Enabled: true
+Style/RedundantFilterChain: # new in 1.52
+  Enabled: true
+Style/RedundantHeredocDelimiterQuotes: # new in 1.45
+  Enabled: true
+Style/RedundantInitialize: # new in 1.27
+  Enabled: true
+Style/RedundantLineContinuation: # new in 1.49
+  Enabled: true
+Style/RedundantRegexpArgument: # new in 1.53
+  Enabled: true
+Style/RedundantRegexpConstructor: # new in 1.52
+  Enabled: true
+Style/RedundantSelfAssignmentBranch: # new in 1.19
+  Enabled: true
+Style/RedundantStringEscape: # new in 1.37
+  Enabled: true
+Style/ReturnNilInPredicateMethodDefinition: # new in 1.53
+  Enabled: true
+Style/SelectByRegexp: # new in 1.22
+  Enabled: true
+Style/SingleLineDoEndBlock: # new in 1.57
+  Enabled: true
+Style/StringChars: # new in 1.12
+  Enabled: true
+Style/SuperWithArgsParentheses: # new in 1.58
+  Enabled: true
+Style/SwapValues: # new in 1.1
+  Enabled: true
+Style/YAMLFileRead: # new in 1.53
+  Enabled: true
+
+AllCops:
+  SuggestExtensions: false

data/Gemfile

@@ -1,3 +1,5 @@
-source "https://rubygems.org"
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
-gemspec
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+gemspec

data/Gemfile.lock

@@ -1,13 +1,39 @@
 PATH
   remote: .
   specs:
-    supersaas-api-client (1.1.1)
+    supersaas-api-client (2.0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    minitest (5.14.0)
-    rake (13.0.1)
+    ast (2.4.2)
+    json (2.7.1)
+    language_server-protocol (3.17.0.3)
+    minitest (5.20.0)
+    parallel (1.24.0)
+    parser (3.3.0.4)
+      ast (~> 2.4.1)
+      racc
+    racc (1.7.3)
+    rainbow (3.1.1)
+    rake (13.1.0)
+    regexp_parser (2.9.0)
+    rexml (3.2.6)
+    rubocop (1.60.0)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.30.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (2.5.0)
 
 PLATFORMS
   ruby
@@ -16,7 +42,8 @@ DEPENDENCIES
   bundler
   minitest
   rake
+  rubocop
   supersaas-api-client!
 
 BUNDLED WITH
-   1.17.3
+   2.3.12

data/README.md

@@ -1,33 +1,29 @@
 # SuperSaaS Ruby API Client
 
-Online bookings/appointments/calendars in Ruby using the SuperSaaS scheduling platform - https://supersaas.com
+Manage appointments, users, and other object on the [SuperSaaS appointment scheduling](https://www.supersaas.com/) platform in Ruby.
 
-The SuperSaaS API provides services that can be used to add online booking and scheduling functionality to an existing website or CRM software.
+The SuperSaaS API provides endpoints that can be used to read or update information from your SuperSaaS account. 
+This can be useful to build an integration with back-end system or to extract information to generate reports.
 
 ## Prerequisites
 
 1. [Register for a (free) SuperSaaS account](https://www.supersaas.com/accounts/new), and
-2. get your account name and API key on the [Account Info](https://www.supersaas.com/accounts/edit) page.
+2. Get your account name and API key on the [Account Info](https://www.supersaas.com/accounts/edit) page.
 
-##### Dependencies
+### Dependencies
 
-Ruby 1.9 or greater.
-
-No external libraries. Only the native `json` and `net/http` standard libs are used.
+No external dependencies. Only the `json` and `net/http` gems from the ruby standard library are used.
 
 ## Installation
 
-1: Gemfile
-
-The SuperSaaS Ruby API Client is available from RubyGems and can be included in your project GemFile. Note, the supersaas-api-client may update major versions with breaking changes, so it's recommended to use a major version when expressing the gem dependency. e.g.
+Install with:
 
-    gem 'supersaas-api-client', '~> 1'
+    $ gem install supersaas-api-client
 
-2: System Gem
+Alternatively, you can use `bundler` to install it by adding this line to you Gemfile. 
+The supersaas-api-client may update major versions with breaking changes, so it's recommended to use a major version when expressing the gem dependency. e.g.
 
-You can install the SuperSaaS Ruby API Client globally by using the gem command. Open a terminal and enter the following command:
-
-    $ gem install supersaas-api-client
+    gem 'supersaas-api-client', '~> 2'
 
 ## Configuration
 
@@ -67,59 +63,63 @@ Details of the data structures, parameters, and values can be found on the devel
 
 https://www.supersaas.com/info/dev
 
-#### List Schedules
-
-Get all account schedules:
-
-    Supersaas::Client.instance.schedules.list #=> [<Supersaas::Schedule>, ...]
-    
-#### List Resource
-
-Get all services/resources by `schedule_id`:
-
-    Supersaas::Client.instance.schedules.resources(12345) #=> [<Supersaas::Resource>, ...]    
-
-_Note: does not work for capacity type schedules._
-
 #### Create User
 
-Create a user with user attributes params:
+Create a user with user attributes params `create(attributes, user_id = nil, webhook = nil, duplicate = nil)`.
+If webhook=true is present it will trigger any webhooks connected to the account.
+To avoid a ‘create’ action from being automatically interpreted as an ‘update’, you can add the parameter duplicate=raise, then error `422 Unprocessable Entity` will be raised.
+If in your database your user has id 1234 then you can supply a foreign key in format 1234fk in `user_id` (optional) which you can use to identify user:
+If validation fails for any field then error `422 Unprocessable Entity` will be raised and any additional information will be printed to your log.
+Data fields that you can supply can be found [here.](https://www.supersaas.com/info/dev/user_api)
 
-    Supersaas::Client.instance.users.create({name: 'name@name.com', full_name: 'Example Name', email: 'example@example.com'}) #=> http://www.supersaas.com/api/users/12345.json
+    Supersaas::Client.instance.users.create({name: 'name@name.com', full_name: 'Example Name', email: 'example@example.com'}, '1234fk', true, 'raise') #=> http://www.supersaas.com/api/users/1234.json
 
 #### Update User
 
-Update a user by `user_id` with user attributes params:
+Update a user by `user_id` with user attributes params `update(user_id, attributes, webhook = nil, notfound = nil)`.
+If webhook=true is present it will trigger any webhooks connected to the account.
+To avoid automatically creating a new record, you can add the parameter notfound=error or notfound=ignore to return a 404 Not Found or 200 OK respectively.
+If the `user_id` does not exist 404 error will be raised.
+You only need to specify the attributes you wish to update:
 
-    Supersaas::Client.instance.users.update(12345, {full_name: 'New Name'}) #=> nil
+    Supersaas::Client.instance.users.update(12345, {full_name: 'New Name'}, true, "ignore") #=> nil
     
 #### Delete User
 
-Delete a single user by `user_id`:
+Delete a single user by `user_id`, and if the user does not exist 404 error will be raised.
 
     Supersaas::Client.instance.users.delete(12345) #=> nil
     
 #### Get User
 
-Get a single user by `user_id`:
+Get a single user by `user_id`, and if the user does not exist 404 error will be raised:
 
     Supersaas::Client.instance.users.get(12345) #=> <Supersaas::User>
 
 #### List Users
 
-Get all users with optional `form` and `limit`/`offset` pagination params:
+Get all users with optional `form` and `limit`/`offset` pagination params, `list(form = nil, limit = nil, offset = nil)`.
+User can have a form attached, and setting `form=true` shows the data:
 
     Supersaas::Client.instance.users.list(false, 25, 0) #=> [<Supersaas::User>, ...]
 
+#### List Fields of User object
+
+Get all the fields available to user object:
+
+    Supersaas::Client.instance.users.field_list #=> [<Supersaas::FieldList>, ...]
+
 #### Create Appointment/Booking
 
-Create an appointment by `schedule_id` and `user_id` with appointment attributes and `form` and `webhook` params:
+Create an appointment with `schedule_id`, and `user_id(optional)` (see API documentation on [create new](https://www.supersaas.com/info/dev/appointment_api#bookings_api)) appointment attributes and optional `form` and `webhook` params,
+`create(schedule_id, user_id, attributes, form = nil, webhook = nil)`:
 
     Supersaas::Client.instance.appointments.create(12345, 67890, {full_name: 'Example Name', email: 'example@example.com', slot_id: 12345}, true, true) #=> http://www.supersaas.com/api/bookings/12345.json
 
 #### Update Appointment/Booking
 
-Update an appointment by `schedule_id` and `appointment_id` with appointment attributes params:
+Update an appointment by `schedule_id` and `appointment_id` with appointment attributes, see the above link,
+`update(schedule_id, appointment_id, attributes, form = nil, webhook = nil)`:
 
     Supersaas::Client.instance.appointments.update(12345, 67890, {full_name: 'New Name'}) #=> nil
 
@@ -137,56 +137,113 @@ Get a single appointment by `schedule_id` and `appointment_id`:
 
 #### List Appointments/Bookings
 
-List appointments by `schedule_id`, with `form` and `start_time` and `limit` view params:
+List appointments by `schedule_id`, with `form` and `start_time` and `limit` view params,
+`list(schedule_id, form = nil, start_time = nil, limit = nil)`:
 
     Supersaas::Client.instance.appointments.list(12345, 67890, true, true) #=> [<Supersaas::Appointment>, ...]
 
 #### Get Agenda
 
-Get agenda (upcoming) appointments by `schedule_id` and `user_id`, with `from_time` view param:
+Get agenda (upcoming) appointments by `schedule_id` and `user_id`, with `from_time` view param ([see](https://www.supersaas.com/info/dev/appointment_api#agenda),
+`agenda(schedule_id, user_id, from_time = nil, slot = false)`:
 
     Supersaas::Client.instance.appointments.agenda(12345, 67890, '2018-01-31 00:00:00') #=> [<Supersaas::Appointment>, ...]
 
 #### Get Agenda Slots
 
-Get agenda (upcoming) slots by `schedule_id` and `user_id`, with `from_time` view param:
+Get agenda (upcoming) slots by `schedule_id` and `user_id`, with `from_time` view param,
+`agenda_slots(schedule_id, user_id, from_time = nil)`:
 
     Supersaas::Client.instance.appointments.agenda_slots(12345, 67890, '2018-01-31 00:00:00') #=> [<Supersaas::Slot>, ...]    
 
-_Note: works only for capacity type schedules._
+_Note: only works for capacity type schedules._
 
 #### Get Available Appointments/Bookings
 
-Get available appointments by `schedule_id`, with `from` time and `length_minutes` and `resource` params:
+Get available appointments by `schedule_id`, with `from` time and `length_minutes` and `resource` params ([see](https://www.supersaas.com/info/dev/appointment_api#availability_api),
+`available(schedule_id, from_time, length_minutes = nil, resource = nil, full = nil, limit = nil)`:
 
     Supersaas::Client.instance.appointments.available(12345, '2018-01-31 00:00:00', 15, 'My Class') #=> [<Supersaas::Appointment>, ...]
 
 #### Get Recent Changes
 
-Get recently changed appointments by `schedule_id`, with `from` time, `to` time and `slot` view param:
+Get recently changed appointments by `schedule_id`, with `from` time, `to` time, `user` user, `slot` view params (see [docs](https://www.supersaas.com/info/dev/appointment_api#recent_changes)),
+`changes(schedule_id, from_time = nil, to = nil, slot = false, user = nil, limit = nil, offset = nil)`:
 
     Supersaas::Client.instance.appointments.changes(12345, '2018-01-31 00:00:00', '2019-01-31 00:00:00',  true) #=> [<Supersaas::Appointment>, ...]
 
 
 #### Get list of appointments
 
-Get list of appointments by `schedule_id`, with `today`,`from` time, `to` time and `slot` view param:
+Get list of appointments by `schedule_id`, with `today`,`from` time, `to` time and `slot` view params (see [docs](https://www.supersaas.com/info/dev/appointment_api#range)),
+`range(schedule_id, today = false, from_time = nil, to = nil, slot = false, user = nil, resource_id = nil, service_id = nil, limit = nil, offset = nil)`:
 
     Supersaas::Client.instance.appointments.range(12345, false, '2018-01-31 00:00:00', '2019-01-31 00:00:00', true) #=> [<Supersaas::Appointment>, ...]/[<Supersaas::Slot>, ...]
 
+#### List Forms
 
-#### List Template Forms
-
-Get all forms by template `superform_id`, with `from_time` param:
+Get all forms by template `superform_id`, with `from_time`, and `user` params ([see](https://www.supersaas.com/info/dev/form_api)):
 
     Supersaas::Client.instance.forms.list(12345, '2018-01-31 00:00:00') #=> [<Supersaas::Form>, ...]
 
 #### Get Form
 
-Get a single form by `form_id`:
+Get a single form by `form_id`, will raise 404 error if not found:
 
     Supersaas::Client.instance.forms.get(12345) #=> <Supersaas::Form>
 
+#### Get a list of SuperForms
+
+Get a list of Form templates (SuperForms):
+
+    Supersaas::Client.instance.forms.forms #=> [<Supersaas::SuperForm>, ...]
+
+#### List Promotions
+
+Get a list of promotional coupon codes with paging parameters `limit` and `offset` (see [docs](https://www.supersaas.com/info/dev/promotion_api)),
+`list(template_form_id, from_time = nil, user = nil)`:
+
+    Supersaas::Client.instance.promotions.list #=> [<Supersaas::Promotion>, ...]
+
+#### Get a single coupon code
+
+Retrieve information about a single coupon code use with `promotion_code`:
+
+    Supersaas::Client.instance.promotions.promotion(12345) #=> <Supersaas::Promotion>
+
+#### Duplicate promotion code
+
+Duplicate a template promotion by giving (new) `id` and `template_code` in that order:
+
+    Supersaas::Client.instance.promotions.duplicate_promotion_code(12345) #=> nil
+
+#### List Groups in an account
+
+List Groups in an account ([see](https://www.supersaas.com/info/dev/information_api)):
+
+    Supersaas::Client.instance.groups.list #=> [<Supersaas::Group>, ...]
+
+#### List Schedules
+
+Get all account schedules:
+
+    Supersaas::Client.instance.schedules.list #=> [<Supersaas::Schedule>, ...]
+
+#### List Services / Resources
+
+Get all services/resources by `schedule_id`:
+
+    Supersaas::Client.instance.schedules.resources(12345) #=> [<Supersaas::Resource>, ...]    
+
+_Note: does not work for capacity type schedules._
+
+#### List Fields of a Schedule
+
+Get all the available fields of a schedule by `schedule_id`:
+
+    Supersaas::Client.instance.schedules.field_list(12345) #=> [<Supersaas::FieldList>, ...]
+
+
 ## Examples
 
 The ./examples folder contains several executable Ruby scripts demonstrating how to use the API Client for common requests.
@@ -226,19 +283,16 @@ The API Client raises a custom exception for HTTP errors and invalid input. Resc
       # Handle error
     end
 
-Validation errors are assigned to the response model. e.g.
+Some errors have more information and are printed to the log before raising the error e.g.
 
     appointment = Supersaas::Client.instance.appointments.create(12345, {bad_field_name: ''})
-    appointment.errors #=> [{"status":"400","title":"Bad request: unknown attribute 'bad_field_name' for Booking."}]
+    "Error 400, Bad request: unknown attribute 'bad_field_name' for Booking."
 
 ## Additional Information
 
 + [SuperSaaS Registration](https://www.supersaas.com/accounts/new)
 + [Product Documentation](https://www.supersaas.com/info/support)
 + [Developer Documentation](https://www.supersaas.com/info/dev)
-+ [Python API Client](https://github.com/SuperSaaS/supersaas-python-api-client)
-+ [PHP API Client](https://github.com/SuperSaaS/supersaas-php-api-client)
-+ [NodeJS API Client](https://github.com/SuperSaaS/supersaas-nodejs-api-client)
 
 Contact: [support@supersaas.com](mailto:support@supersaas.com)