vantaca 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 17d644bafa17b33e40ce3695a575773dc6a4c32500b20463e5a85849d9e7f7ce
+  data.tar.gz: 1d1644fde830360cec3b38860f124528a32411613b5d0d4693866f01f2984bcf
+SHA512:
+  metadata.gz: 69c22312ab4573a406982fed1c14ada85cc2bbeed1b4dbc197266ffda5e6b07d924588575739feeb6b1887a7c04b916b53d7017dde71cfce1712cd6b3959c9fe
+  data.tar.gz: 205fef825382c52847c32aa83d8ae304cd7bd74372e40602e22aa97fbcb3af181ae1a3eb7c5169d077bdc350d42ac9c0bdf173bd2ab428a3b322a6a474e92093

data/.github/workflows/ruby.yml

@@ -0,0 +1,30 @@
+name: RSpec
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ ubuntu ]
+        ruby: [ 4.0, head ]
+
+    runs-on: ${{ matrix.os }}-latest
+    continue-on-error: ${{ endsWith(matrix.ruby, 'head') || matrix.ruby == 'debug' }}
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically:
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rake

data/.rubocop.yml

@@ -0,0 +1,58 @@
+plugins:
+  - rubocop-rake
+
+AllCops:
+  TargetRubyVersion: 4.0
+  # Always enable new cops, disabling manually when they don't fit.
+  EnabledByDefault: true
+  NewCops: enable
+
+# ------------------------------------------------------------------------------
+# Cops excluded for specific directories
+# ------------------------------------------------------------------------------
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+
+Style/Copyright:
+  AutocorrectNotice: |
+    # Copyright (c) Valencia Management Group
+    # All rights reserved.
+  Notice: |
+    Copyright \(c\) Valencia Management Group
+    All rights reserved.
+
+# ------------------------------------------------------------------------------
+# Cops that should not be run
+# ------------------------------------------------------------------------------
+
+Layout/MultilineMethodArgumentLineBreaks:
+  Enabled: false
+
+# Recommends `::File` instead of `File`
+Lint/ConstantResolution:
+  Enabled: false
+
+# Recommends Integer(xxx, 10) instead of xxx.to_i
+Lint/NumberConversion:
+  Enabled: false
+
+Style/ConstantVisibility:
+  Enabled: false
+
+# Every method should be documented, but I'm not *that* professional.
+Style/DocumentationMethod:
+  Enabled: false
+
+# Converts `.to eq 1` to `.to(eq(1))`
+Style/MethodCallWithArgsParentheses:
+  Enabled: false
+
+# This is just for setting HTTParty's request headers
+Style/StringHashKeys:
+  Enabled: false
+
+# Forbids the use of "rubocop:disable"
+Style/DisableCopsWithinSourceCodeDirective:
+  Enabled: false

data/.vscode/settings.json

@@ -0,0 +1,14 @@
+{
+    "[ruby]": {
+        "editor.rulers": [120],
+        "editor.tabSize": 2,
+    },
+    "[yaml]": {
+        "editor.rulers": [120],
+        "editor.tabSize": 2,
+    },
+    "files.insertFinalNewline": true,
+    "files.trimTrailingWhitespace": true,
+    "ruby.intellisense": false,
+    "ruby.useLanguageServer": true
+}

data/Gemfile

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# Copyright (c) Valencia Management Group
+# All rights reserved.
+
+source 'https://rubygems.org'
+
+gemspec
+
+# Gem management
+gem 'bundler', '~> 4.0'
+
+# Deployment tasks
+gem 'rake', '~> 13.0'
+
+# Test with RSpec
+gem 'rspec', '~> 3.12'
+
+# Ruby code linting
+gem 'rubocop', '~> 1.54'
+
+# Rubocop - rake cops
+gem 'rubocop-rake', '~> 0.6'
+
+# Rubocop - rspec cops
+gem 'rubocop-rspec', '~> 3.0'
+
+# Replay full HTTP interactions
+gem 'vcr', '~> 6.2'
+
+# Mock HTTP requests so that we're not hitting the actual Vantaca servers
+gem 'webmock', '~> 3.18'
+
+# Output logging
+gem 'logger', '~> 1.7'

data/Gemfile.lock

@@ -0,0 +1,153 @@
+PATH
+  remote: .
+  specs:
+    vantaca (0.3.0)
+      httparty (~> 0.24)
+      zeitwerk (~> 2.7)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.9)
+      public_suffix (>= 2.0.2, < 8.0)
+    ast (2.4.3)
+    bigdecimal (4.0.1)
+    crack (1.0.1)
+      bigdecimal
+      rexml
+    csv (3.3.5)
+    diff-lcs (1.6.2)
+    hashdiff (1.2.1)
+    httparty (0.24.2)
+      csv
+      mini_mime (>= 1.0.0)
+      multi_xml (>= 0.5.2)
+    json (2.19.1)
+    json-schema (6.2.0)
+      addressable (~> 2.8)
+      bigdecimal (>= 3.1, < 5)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
+    logger (1.7.0)
+    mcp (0.8.0)
+      json-schema (>= 4.1)
+    mini_mime (1.1.5)
+    multi_xml (0.8.1)
+      bigdecimal (>= 3.1, < 5)
+    parallel (1.27.0)
+    parser (3.3.10.2)
+      ast (~> 2.4.1)
+      racc
+    prism (1.9.0)
+    public_suffix (7.0.5)
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (13.3.1)
+    regexp_parser (2.11.3)
+    rexml (3.4.4)
+    rspec (3.13.2)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.6)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.8)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.7)
+    rubocop (1.85.1)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      mcp (~> 0.6)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.49.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.49.1)
+      parser (>= 3.3.7.2)
+      prism (~> 1.7)
+    rubocop-rake (0.7.1)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.72.1)
+    rubocop-rspec (3.9.0)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.81)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.2.0)
+    vcr (6.4.0)
+    webmock (3.26.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    zeitwerk (2.7.5)
+
+PLATFORMS
+  arm64-darwin-25
+  ruby
+
+DEPENDENCIES
+  bundler (~> 4.0)
+  logger (~> 1.7)
+  rake (~> 13.0)
+  rspec (~> 3.12)
+  rubocop (~> 1.54)
+  rubocop-rake (~> 0.6)
+  rubocop-rspec (~> 3.0)
+  vantaca!
+  vcr (~> 6.2)
+  webmock (~> 3.18)
+
+CHECKSUMS
+  addressable (2.8.9) sha256=cc154fcbe689711808a43601dee7b980238ce54368d23e127421753e46895485
+  ast (2.4.3) sha256=954615157c1d6a382bc27d690d973195e79db7f55e9765ac7c481c60bdb4d383
+  bigdecimal (4.0.1) sha256=8b07d3d065a9f921c80ceaea7c9d4ae596697295b584c296fe599dd0ad01c4a7
+  crack (1.0.1) sha256=ff4a10390cd31d66440b7524eb1841874db86201d5b70032028553130b6d4c7e
+  csv (3.3.5) sha256=6e5134ac3383ef728b7f02725d9872934f523cb40b961479f69cf3afa6c8e73f
+  diff-lcs (1.6.2) sha256=9ae0d2cba7d4df3075fe8cd8602a8604993efc0dfa934cff568969efb1909962
+  hashdiff (1.2.1) sha256=9c079dbc513dfc8833ab59c0c2d8f230fa28499cc5efb4b8dd276cf931457cd1
+  httparty (0.24.2) sha256=8fca6a54aa0c4aa4303a0fd33e5e2156175d6a5334f714263b458abd7fda9c38
+  json (2.19.1) sha256=dd94fdc59e48bff85913829a32350b3148156bc4fd2a95a2568a78b11344082d
+  json-schema (6.2.0) sha256=e8bff46ed845a22c1ab2bd0d7eccf831c01fe23bb3920caa4c74db4306813666
+  language_server-protocol (3.17.0.5) sha256=fd1e39a51a28bf3eec959379985a72e296e9f9acfce46f6a79d31ca8760803cc
+  lint_roller (1.1.0) sha256=2c0c845b632a7d172cb849cc90c1bce937a28c5c8ccccb50dfd46a485003cc87
+  logger (1.7.0) sha256=196edec7cc44b66cfb40f9755ce11b392f21f7967696af15d274dde7edff0203
+  mcp (0.8.0) sha256=ae8bd146bb8e168852866fd26f805f52744f6326afb3211e073f78a95e0c34fb
+  mini_mime (1.1.5) sha256=8681b7e2e4215f2a159f9400b5816d85e9d8c6c6b491e96a12797e798f8bccef
+  multi_xml (0.8.1) sha256=addba0290bac34e9088bfe73dc4878530297a82a7bbd66cb44dcd0a4b86edf5a
+  parallel (1.27.0) sha256=4ac151e1806b755fb4e2dc2332cbf0e54f2e24ba821ff2d3dcf86bf6dc4ae130
+  parser (3.3.10.2) sha256=6f60c84aa4bdcedb6d1a2434b738fe8a8136807b6adc8f7f53b97da9bc4e9357
+  prism (1.9.0) sha256=7b530c6a9f92c24300014919c9dcbc055bf4cdf51ec30aed099b06cd6674ef85
+  public_suffix (7.0.5) sha256=1a8bb08f1bbea19228d3bed6e5ed908d1cb4f7c2726d18bd9cadf60bc676f623
+  racc (1.8.1) sha256=4a7f6929691dbec8b5209a0b373bc2614882b55fc5d2e447a21aaa691303d62f
+  rainbow (3.1.1) sha256=039491aa3a89f42efa1d6dec2fc4e62ede96eb6acd95e52f1ad581182b79bc6a
+  rake (13.3.1) sha256=8c9e89d09f66a26a01264e7e3480ec0607f0c497a861ef16063604b1b08eb19c
+  regexp_parser (2.11.3) sha256=ca13f381a173b7a93450e53459075c9b76a10433caadcb2f1180f2c741fc55a4
+  rexml (3.4.4) sha256=19e0a2c3425dfbf2d4fc1189747bdb2f849b6c5e74180401b15734bc97b5d142
+  rspec (3.13.2) sha256=206284a08ad798e61f86d7ca3e376718d52c0bc944626b2349266f239f820587
+  rspec-core (3.13.6) sha256=a8823c6411667b60a8bca135364351dda34cd55e44ff94c4be4633b37d828b2d
+  rspec-expectations (3.13.5) sha256=33a4d3a1d95060aea4c94e9f237030a8f9eae5615e9bd85718fe3a09e4b58836
+  rspec-mocks (3.13.8) sha256=086ad3d3d17533f4237643de0b5c42f04b66348c28bf6b9c2d3f4a3b01af1d47
+  rspec-support (3.13.7) sha256=0640e5570872aafefd79867901deeeeb40b0c9875a36b983d85f54fb7381c47c
+  rubocop (1.85.1) sha256=3dbcf9e961baa4c376eeeb2a03913dca5e3987033b04d38fa538aa1e7406cc77
+  rubocop-ast (1.49.1) sha256=4412f3ee70f6fe4546cc489548e0f6fcf76cafcfa80fa03af67098ffed755035
+  rubocop-rake (0.7.1) sha256=3797f2b6810c3e9df7376c26d5f44f3475eda59eb1adc38e6f62ecf027cbae4d
+  rubocop-rspec (3.9.0) sha256=8fa70a3619408237d789aeecfb9beef40576acc855173e60939d63332fdb55e2
+  ruby-progressbar (1.13.0) sha256=80fc9c47a9b640d6834e0dc7b3c94c9df37f08cb072b7761e4a71e22cff29b33
+  unicode-display_width (3.2.0) sha256=0cdd96b5681a5949cdbc2c55e7b420facae74c4aaf9a9815eee1087cb1853c42
+  unicode-emoji (4.2.0) sha256=519e69150f75652e40bf736106cfbc8f0f73aa3fb6a65afe62fefa7f80b0f80f
+  vantaca (0.3.0)
+  vcr (6.4.0) sha256=077ac92cc16efc5904eb90492a18153b5e6ca5398046d8a249a7c96a9ea24ae6
+  webmock (3.26.1) sha256=4f696fb57c90a827c20aadb2d4f9058bbff10f7f043bd0d4c3f58791143b1cd7
+  zeitwerk (2.7.5) sha256=d8da92128c09ea6ec62c949011b00ed4a20242b255293dd66bf41545398f73dd
+
+BUNDLED WITH
+  4.0.6

data/README.md

@@ -0,0 +1,3 @@
+# Vantaca API Gem
+
+[![Build Status](https://github.com/ValenciaMgmt/Vantaca/workflows/RSpec/badge.svg?branch=master)](https://github.com/ValenciaMgmt/Vantaca/actions?query=workflow%3A%22RSpec%22)

data/Rakefile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+# Copyright (c) Valencia Management Group
+# All rights reserved.
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/vantaca/action_items.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+# Copyright (c) Valencia Management Group
+# All rights reserved.
+
+module Vantaca
+  # Methods which interact with Action Items
+  module ActionItems
+    # Load all active action categories.
+    #
+    # @return [Array<Vantaca::Models::ActionCategory>] active action categories
+    def action_categories
+      response = get('/read/actionCategoryList')
+
+      return [] unless response
+
+      Array(response).map { Vantaca::Models::ActionCategory.new(it) }
+    end
+
+    def action_types
+      response = get('/read/actionTypeList')
+
+      return [] unless response
+
+      Array(response).map { Vantaca::Models::ActionType.new(it) }
+    end
+  end
+end

data/lib/vantaca/addresses.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# Copyright (c) Valencia Management Group
+# All rights reserved.
+
+module Vantaca
+  # Methods which allow creation, modification, and deletion of homeowner addresses.
+  module Addresses
+    def create_address(homeowner_id, address_attributes)
+      post('/write/addressCreate', address_attributes.merge(hoid: homeowner_id))
+    end
+
+    def update_address(address_id, address_attributes)
+      post('/write/addressUpdate', address_attributes.merge(addrID: address_id))
+    end
+
+    def delete_address(address_id)
+      post('/write/addressDestroy', { addrID: address_id })
+    end
+  end
+end

data/lib/vantaca/client.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+# Copyright (c) Valencia Management Group
+# All rights reserved.
+
+require 'logger'
+
+module Vantaca
+  # The client which enables communication with the Vantaca API
+  class Client
+    include HTTParty
+
+    include Vantaca::ActionItems
+    include Vantaca::Addresses
+    include Vantaca::Communities
+    include Vantaca::Documents
+    include Vantaca::Emails
+    include Vantaca::Ledger
+    include Vantaca::Owners
+    include Vantaca::Phones
+    include Vantaca::Providers
+
+    headers 'Content-Type' => 'application/json'
+
+    base_uri 'https://service-e.vantaca.net/'
+
+    attr_accessor :logger
+
+    def initialize(logger: IO::NULL)
+      @logger = logger_for(logger)
+    end
+
+    def get(endpoint, **query)
+      response = self.class.get endpoint, query: query.merge(default_params)
+
+      raise_exception(response) unless (200..299).include? response.code
+
+      response.parsed_response
+    end
+
+    def put(endpoint, body, **query)
+      response = self.class.put endpoint, query: query.merge(default_params), body: body.to_json
+
+      raise_exception(response) unless response.code == 200
+
+      response.parsed_response
+    end
+
+    def post(endpoint, body, **query)
+      response = self.class.post endpoint, query: query.merge(default_params), body: body.to_json
+
+      raise_exception(response) unless response.code == 200
+
+      # This is always going to be `nil` for POST requests, but it doesn't hurt to be consistent.
+      response.parsed_response
+    end
+
+    def download(endpoint, **params)
+      raise ArgumentError, 'Vantaca::Client#download requires a block' unless block_given?
+
+      Tempfile.open('download') do |file|
+        file.binmode
+
+        file.write download_raw_data(endpoint, **params)
+
+        yield file
+      end
+    end
+
+    protected
+
+    def default_params = Vantaca.configuration.to_params
+
+    def raise_exception(response)
+      case response.code
+      when 404 then raise Vantaca::Errors::NotFoundError, response
+      when 400..499 then raise Vantaca::Errors::ClientError, response
+      when 500..599
+        # These errors can largely be ignored - it's not our fault
+        raise Vantaca::Errors::TimeoutError, response if response.response.message['Timeout expired']
+
+        raise Vantaca::Errors::InternalError, response
+      else
+        # As far as I'm aware, Vantaca does not return 100 - 199 or 205 - 399.
+        raise Vantaca::Errors::ApiError, response
+      end
+    end
+
+    def download_raw_data(endpoint, **query)
+      response = self.class.get(
+        endpoint,
+        headers: { 'Content-Type' => 'application/octet-stream' },
+        query: query.merge(default_params)
+      )
+
+      raise_exception(response) unless response.code == 200
+
+      response
+    end
+
+    def logger_for(logger)
+      return logger if logger.is_a?(::Logger)
+
+      return Vantaca.configuration.logger if logger == IO::NULL && Vantaca.configuration.logger
+
+      ::Logger.new(logger)
+    end
+  end
+end

data/lib/vantaca/communities.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+# Copyright (c) Valencia Management Group
+# All rights reserved.
+
+module Vantaca
+  # Methods which load general information, but not owners, of one or more communities.
+  module Communities
+    COMMUNITY_PARAMETERS = { charges: :includeCharges, late_fees: :includeLateFees }.freeze
+
+    # Load a list of all communities actively managed.
+    #
+    # @return [Array<Vantaca::Models::Community>] An array of all communities managed.
+    def communities(**options)
+      params = community_parameters(nil, options)
+
+      get('/read/Association', **params).map { Vantaca::Models::Community.new(it) }
+    end
+
+    # Load a single community by its abbreviation.
+    #
+    # @param assoc_code [String] The 2-4 character association code of the community
+    # @return [Vantaca::Models::Community] The community with the indicated association code.
+    def community(assoc_code, **options)
+      params = community_parameters(assoc_code, options)
+
+      response = get('/read/Association', **params)
+
+      # The API sends a 204 No Content response if there's no matching community.
+      raise Vantaca::Errors::NotFoundError unless response
+
+      Vantaca::Models::Community.new response.first
+    end
+
+    protected
+
+    def community_parameters(community, options)
+      params = { assocCode: community }
+
+      COMMUNITY_PARAMETERS.values_at(*Array(options[:include])).compact.each do |vantaca_parameter|
+        params[vantaca_parameter] = true
+      end
+
+      params.compact
+    end
+  end
+end

data/lib/vantaca/configuration.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+# Copyright (c) Valencia Management Group
+# All rights reserved.
+
+module Vantaca
+  # The basic configuration object for the Vantaca client. I wish these weren't passed in the URL...
+  class Configuration
+    attr_reader :login, :password, :company, :logger
+
+    def company=(input)
+      raise ArgumentError, 'Invalid Vantaca company name' unless input&.match?(/\A\w+\z/)
+
+      @company = input
+    end
+
+    def login=(input)
+      raise ArgumentError, 'Invalid Vantaca login' unless input&.match?(/\A\w+\z/)
+
+      @login = input
+    end
+
+    def password=(input)
+      raise ArgumentError, 'Invalid Vantaca password' unless input&.match?(/\A\w+\z/)
+
+      @password = input
+    end
+
+    def logger=(new_logger)
+      raise ArgumentError, 'Logger must be an instance of the Logger class' unless new_logger.is_a?(::Logger)
+
+      @logger = new_logger
+    end
+
+    def to_params
+      {
+        company: @company,
+        login: @login,
+        pwd: @password
+      }
+    end
+  end
+end

data/lib/vantaca/documents.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+# Copyright (c) Valencia Management Group
+# All rights reserved.
+
+module Vantaca
+  # Methods which fetch lists of documents or a document itself
+  module Documents
+    def documents(community:)
+      response = get('/read/Association', assocCode: community, includeDocuments: true)
+
+      return [] unless response
+
+      response.dig(0, 'documents').map { Vantaca::Models::Document.new(it) }
+    end
+
+    # Download an actual file
+    # TODO: Add the zip=true parameter and unzip the file using Rubyzip
+    def document(community:, image_id:, &)
+      raise ArgumentError, 'Vantaca::Client#document requires a block' unless block_given?
+
+      download('/read/getDocument', assocCode: community, imgID: image_id, &)
+    end
+  end
+end

data/lib/vantaca/emails.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# Copyright (c) Valencia Management Group
+# All rights reserved.
+
+module Vantaca
+  # Methods which allow creation, modification, and deletion of homeowner email addresses.
+  module Emails
+    # @param homeowner_id [Integer] The ID of the homeowner
+    # @param email_attrs [Hash] The email address details
+    # @option email_attrs [String] :email (required) The email address
+    # @option email_attrs [Boolean] :isPrimary Whether this is the primary email address
+    # @option email_attrs [String] :label Optional label for the email address (e.g., 'Work', 'Personal')
+    # @return [nil] The API response from the email creation endpoint
+    def create_email_address(homeowner_id, email_attrs)
+      post('/write/emailCreate', email_attrs.merge(hoid: homeowner_id))
+    end
+
+    # @param email_address_id [Integer] The ID of the email address to update
+    # @param email_attrs [Hash] The updated email address details
+    # @option email_attrs [String] :email (required) The email address
+    # @option email_attrs [Boolean] :isPrimary Whether this is the primary email address
+    # @option email_attrs [String] :label Optional label for the email address (e.g., 'Work', 'Personal')
+    # @return [nil] The API response from the email update endpoint
+    def update_email_address(email_address_id, email_attrs)
+      post('/write/emailUpdate', email_attrs.merge(emailID: email_address_id))
+    end
+
+    # @param email_address_id [Integer] The ID of the email address to delete
+    # @return [nil] The API response from the email deletion endpoint
+    def delete_email_address(email_address_id)
+      post('/write/emailDestroy', { emailID: email_address_id })
+    end
+  end
+end

data/lib/vantaca/errors.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+# Copyright (c) Valencia Management Group
+# All rights reserved.
+
+module Vantaca
+  module Errors
+    # The base error class which more specific API error classes inherit from.
+    class ApiError < ::RuntimeError
+      DEFAULT_MESSAGE = 'An unknown error occurred.'
+
+      def initialize(response = nil)
+        @response = response
+
+        super()
+      end
+
+      def to_s
+        return self.class::DEFAULT_MESSAGE unless @response
+
+        format(
+          '%<code>s: %<message>s (%<uri>s)',
+          code: @response.code,
+          # Vantaca doesn't put the error message in the response body - it's in the status header!
+          message: @response.response.message,
+          uri: filtered_uri
+        )
+      end
+
+      def filtered_uri = @response.request.last_uri.to_s.gsub(/(company|login|pwd)=(?:[a-z0-9]+)/i, '\1=[FILTERED]')
+    end
+
+    # The client submitted invalid information.
+    class ClientError < ApiError
+      DEFAULT_MESSAGE = 'An unknown client error occurred.'
+    end
+
+    # A request was made for a key/query that doesn't exist.
+    class NotFoundError < ClientError
+      DEFAULT_MESSAGE = 'The requested resource could not be found.'
+    end
+
+    # Something happened but we don't know what and it's probably not our fault.
+    class InternalError < ApiError
+      DEFAULT_MESSAGE = 'An unknown internal error occurred.'
+    end
+
+    # The API took too long to respond, but everything might be fine later.
+    class TimeoutError < InternalError
+      DEFAULT_MESSAGE = 'The request timed out. Please try again in a moment.'
+    end
+  end
+end