faithteams-api 2.0.1

data/Gemfile.lock

@@ -0,0 +1,171 @@
+PATH
+  remote: .
+  specs:
+    faithteams-api (2.0.1)
+      activesupport (>= 6.1.7)
+      http (~> 5.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.1.3)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
+    addressable (2.8.6)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    base64 (0.2.0)
+    bigdecimal (3.1.6)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    concurrent-ruby (1.2.3)
+    connection_pool (2.4.1)
+    crack (0.4.6)
+      bigdecimal
+      rexml
+    diff-lcs (1.5.1)
+    docile (1.4.0)
+    domain_name (0.6.20240107)
+    drb (2.2.0)
+      ruby2_keywords
+    ffi (1.16.3)
+    ffi-compiler (1.0.1)
+      ffi (>= 1.0.0)
+      rake
+    formatador (1.1.0)
+    guard (2.18.1)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.13.0)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    hashdiff (1.1.0)
+    http (5.2.0)
+      addressable (~> 2.8)
+      base64 (~> 0.1)
+      http-cookie (~> 1.0)
+      http-form_data (~> 2.2)
+      llhttp-ffi (~> 0.5.0)
+    http-cookie (1.0.5)
+      domain_name (~> 0.5)
+    http-form_data (2.3.0)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    json (2.7.1)
+    language_server-protocol (3.17.0.3)
+    listen (3.8.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    llhttp-ffi (0.5.0)
+      ffi-compiler (~> 1.0)
+      rake (~> 13.0)
+    lumberjack (1.2.10)
+    method_source (1.0.0)
+    minitest (5.22.1)
+    mutex_m (0.2.0)
+    nenv (0.3.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    parallel (1.24.0)
+    parser (3.3.0.5)
+      ast (~> 2.4.1)
+      racc
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (5.0.4)
+    racc (1.7.3)
+    rainbow (3.1.1)
+    rake (13.1.0)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    regexp_parser (2.9.0)
+    rexml (3.2.6)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.0)
+    rubocop (1.60.2)
+      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)
+    rubocop-performance (1.20.2)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (1.42.0)
+      rubocop (>= 0.87.0)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    shellany (0.0.1)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    thor (1.3.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.5.0)
+    webmock (3.20.0)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    yard (0.9.34)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug (~> 11.1)
+  faithteams-api!
+  guard-rspec (~> 4.7)
+  rake (~> 13.0)
+  rspec (~> 3.12)
+  rubocop (~> 1.42)
+  rubocop-performance (~> 1.17)
+  rubocop-rake (~> 0.6)
+  rubocop-rspec (~> 1.42)
+  simplecov (~> 0.21)
+  webmock (~> 3.18)
+  yard (~> 0.9)
+
+BUNDLED WITH
+   2.4.13

data/Guardfile

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exist?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Rails files
+  rails = dsl.rails(view_extensions: %w(erb haml slim))
+
+  # Rails config changes
+  watch(rails.spec_helper)     { rspec.spec_dir }
+end

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Tithe.ly
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,85 @@
+# FaithTeams API
+FaithTeams API client gem for use with FaithTeams API. See [FaithTeams API Documentation](https://api.faithteams.com/docs) for more information.
+
+## Overview and Purpose
+It provides a wrapper around the FaithTeams API and includes the following collection of classes and methods for each API version that can be used to interact with the FaithTeams API:
+
+* `FaithTeams::API::V*::Connection` - Takes FaithTeams credentials (`user_id` and `password`) and is responsible for:
+    * establishing and validating a connection to the FaithTeams API
+    * providing the underlying methods used by the various API resources to make specific API calls.
+    * handling request errors.
+* `FaithTeams::API::V*::Gateway` - Takes a `FaithTeams::Connection` and is responsible for providing a collection of API resources.
+* `FaithTeams::API::V*::Resource` - Provides CRUD functionality for each resource.
+* `FaithTeams::API::V*::Error::*` - All necessary errors.
+* `FaithTeams::API::V*::Entity::*` - All necessary entities.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "faithteams"
+```
+
+And then execute:
+
+`bundle install`
+
+Or install it yourself as:
+
+`gem install faithteams`
+
+## Contributing
+
+### How to Contribute
+
+1. Adhere to the [Code of Conduct](./CODE_OF_CONDUCT.md)
+1. Fork the project.
+1. Create a new branch for your feature: `git checkout -b feature-name`.
+1. Commit your changes: `git commit -m 'Add new feature'`. Please reference a GitHub issue if applicable. See [linking a pull request to an issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue).  Please be sure to include an appropriate entry in the [CHANGELOG.md](./CHANGELOG.md).
+1. Push to your branch: `git push origin feature-name`.
+1. Open a pull request. Please add information about why this is necessary, citing specific examples if possible.
+
+### Code of Conduct
+
+This project has a [Code of Conduct](./CODE_OF_CONDUCT.md). Please read through this document and ensure compliance before contributing.
+
+### Contributor Guidelines
+
+Contributions should adhere to the [API Client Gateway Resource Interface](./guides/api_client_interface.md).  Additional API endpoints should be added to the Thunder Client Collection with appropriate tests included.
+
+## Testing
+
+To run the tests in the gem: `bundle exec rspec`
+
+To run a specific test, use a pattern: `bundle exec rspec -P "**/contribution_spec.rb"`
+
+Use the Thunder Client extension for VS Code to test/inspect API calls.
+
+## Gem Publishing
+
+General instructions for publishing a gem are available in this [RubyGems guide](https://guides.rubygems.org/publishing/#publishing-to-rubygemsorg).
+
+1. Make sure you have a [RubyGems account](https://rubygems.org/sign_in).
+1. Ensure the gem can be built and is at the correct version number: `bundle exec rake install`
+1. Publish the gem `gem push pkg/faithteams-api-2.0.0.gem
+
+## License
+
+This project is licensed under the [MIT License](./LICENSE).
+
+## Contact and Bug Reports
+
+You can contact the project maintainers or file a bug report through GitHub Issues on this repository. Please provide complete details so that your question or issue may be resolved as soon as possible.
+
+[comment]: <> (TODO: Add FaithTeams contact information)
+
+## Project Status
+
+This project is being actively maintained and is stable for production use.
+
+## Tithe.ly
+
+![Tithe.ly Logo](https://assets-global.website-files.com/5f6a31379c9e2712518b8d6c/61fbe41d8e639d18d7c516b7_Logomark.svg)
+
+With tools like text and email messaging, custom church apps and websites, church management software, and digital giving, [Tithe.ly](https://tithe.ly/) provides the tools you need to engage with your church online, stay connected, increase generosity, and simplify the lives of your staff.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "faithteams"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/faithteams-api.gemspec

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require_relative "lib/faithteams/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "faithteams-api"
+  spec.version       = FaithTeams::VERSION
+  spec.authors       = ["Tithe.ly Integrations"]
+  spec.email         = ["integrations@tithe.ly"]
+
+  spec.summary       = "A Faithteams API client gem."
+  spec.description   = "Provides methods and utilities for interacting with the faithteams API."
+  spec.homepage      = "https://github.com/tithely/faithteams-api"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.0.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/tithely/faithteams-api"
+  spec.metadata["changelog_uri"] = "https://github.com/tithely/faithteams-api/blob/master/doc/CHANGELOG.md"
+  spec.metadata["github_repo"] = "https://github.com/tithely/faithteams-api"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path("..", __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", ">= 6.1.7"
+  spec.add_dependency "http", "~> 5.1"
+
+  spec.add_development_dependency "byebug", "~> 11.1"
+  spec.add_development_dependency "guard-rspec", "~> 4.7"
+  spec.add_development_dependency "simplecov", "~> 0.21"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.12"
+  spec.add_development_dependency "rubocop", "~> 1.42"
+  spec.add_development_dependency "rubocop-performance", "~> 1.17"
+  spec.add_development_dependency "rubocop-rake", "~> 0.6"
+  spec.add_development_dependency "rubocop-rspec", "~> 1.42"
+  spec.add_development_dependency "webmock", "~> 3.18"
+  spec.add_development_dependency "yard", "~> 0.9"
+end

data/guides/api_client_interface.md

@@ -0,0 +1,18 @@
+# API Client Interface (ACI)
+
+The ACI should provide at minimum the following functions in its Gateway to allow interaction with the client API in a standard way. These resources should descend from a common base that provides authentication and a request mechanism (via HTTP gem).
+- batch
+- contribution
+- contribution_type
+- fund
+- person
+
+The methods above return an object that should have the following methods:
+- **find(id:)** - Finds a single record by id. Returns an entity or nil.
+- **search(\*\*args)** - Potentially returns multiple records given various parameters. Returns an array of entities or empty array.
+- **create(entity:)** - Create a new record. Returns entity or nil on failure.
+- **update(entity:)** - Update an existing record. Returns boolean.
+- **delete(id:)** - Remove an existing record. Returns boolean.
+- **<nested_resource>(resource_id:)** - This is another resource which is nested under the current resource (e.g. /people/:person_id/emails/:email_id). The nested resource would be the same as if the it was at the top level in the Gateway. We would then call it with something like this to find emails on a specific person:
+gateway.person.email(person_id: <id>).search(<param>: <param-value>)
+Any method can raise an exception on failure.

data/guides/release-process.md

@@ -0,0 +1,11 @@
+# Release Process
+
+1. Branch off of the commit you want to release (`git checkout -b x.x.x`).
+1. Update the changelog version information and make sure that all changes to be released have been documented.
+1. Bump the version number in `lib/faithteams/version.rb` to the version to be released.
+1. Create a PR, look for approvals and merge this in to master.
+1. Tag master at the new commit with the version number (`git tag -a x.x.x`).
+1. Push this tag up to origin `git push origin x.x.x`.
+1. Head over to GitHub to create a [new release](https://github.com/tithely/faithteams-api/releases/new). Make sure to select the tag that you just pushed, place the version number as the release name and copy in the associated changelog contents into the description. Publish this release.
+1. This will kick off a deploy action which you can watch [here](https://github.com/tithely/faithteams-api/actions?query=workflow%3A%22Ruby+Gem%22).
+1. Once the action completes, verify the new version of the package is available [here](https://github.com/tithely/faithteams-api/packages).

data/lib/faithteams/api/v2/connection.rb

@@ -0,0 +1,142 @@
+# frozen_string_literal: true
+
+require "uri"
+require_relative "error"
+
+module FaithTeams
+  module API
+    module V2
+      # Faithteams API v2 connection
+      class Connection
+        # Specific base urls for different resources
+        ENDPOINT_BASE_URLS = {
+          "authenticate" => "https://app.faithteams.com/api/v2",
+          "batches" => "https://api-v2.faithteams.com",
+          "contributions" => "https://api-v2.faithteams.com",
+          "contributiontypes" => "https://api-v2.faithteams.com",
+          "funds" => "https://api-v2.faithteams.com",
+          "people" => "https://app.faithteams.com/api/v2"
+        }
+
+        attr_reader :user_id, :password
+
+        # @param user_id [String]
+        # @param password [String]
+        def initialize(user_id:, password:)
+          raise ArgumentError.new("A user_id is required") if user_id.blank?
+          raise ArgumentError.new("A password is required") if password.blank?
+
+          @user_id = user_id
+          @password = password
+        end
+
+        # Is the connection to FaithTeams valid?
+        # @return [Boolean]
+        def valid?
+          get(path: "/contributiontypes")
+          true
+        rescue Error::Request
+          false
+        end
+
+        # @param path [String]
+        # @param params [Hash] Parameters to send with the request
+        # @return [Hash]
+        # @raise [Error::Request]
+        def get(path:, params: {})
+          request_and_parse(method: :get, path: path, params: params)
+        end
+
+        # @param path [String]
+        # @param body [Hash, nil] Body to send
+        # @return [Hash]
+        # @raise [Error::Request]
+        def post(path:, body: nil)
+          request_and_parse(method: :post, path: path, body: body)
+        end
+
+        # Request an endpoint from faithteams, checking for errors
+        # @param method [String] :get or :post
+        # @param path [String] Path to the endpoint relative to ENDPOINT_BASE_URLS
+        # @param params [Hash] Request parameters
+        # @param body [Hash] Body to send
+        # @return [HTTP::Response] Results of the request
+        # @raise [Error::Request] Caller is responsible for capturing the error if needed
+        def request(method: :get, path:, params: {}, body: {})
+          url = "#{base_url(path: path)}#{path}"
+
+          retries ||= 0
+          response = nil
+          loop do
+            retries += 1
+
+            case method.to_s
+            when "post"
+              response = http.post(url, json: body)
+            else # get
+              response = http.get(url, params: params)
+            end
+            break if response.status != 401 || retries >= 2
+
+            authenticate
+          end
+
+          raise Error::Request.new(response: response, message: "Request unsuccessful (#{response.status})") unless response.status.success?
+
+          response
+        end
+
+        # Request an endpoint from faithteams and parse the response
+        # @param method [String] :get or :post
+        # @param path [String] Path to the endpoint relative to ENDPOINT_BASE_URLS
+        # @param params [Hash] Request parameters
+        # @param body [Hash] Body to send
+        # @return [Hash] Contents of the body
+        # @raise [Error::Request] Caller is responsible for capturing the error if needed
+        def request_and_parse(method: "get", path:, params: {}, body: {})
+          response = request(method: method, path: path, params: params, body: body)
+          begin
+            response_body = response.parse(:json)
+          rescue JSON::ParserError
+            raise Error::Request.new(response: response, message: "Failed to parse JSON")
+          end
+
+          # raise errors when "status" = 200 but "success" = false
+          raise Error::Request.new(response: response, message: "Request unsuccessful") unless response_body["success"] == true
+
+          response_body
+        end
+
+        # @return [Resource::User]
+        def user_resource
+          @user_resource ||= Resource::User.new(connection: self)
+        end
+
+        private
+
+        # @return [HTTP::Client]
+        def http
+          @http ||= HTTP.headers("Token" => "#{auth_token}")
+        end
+
+        # @param path [String]
+        # @return [String]
+        def base_url(path:)
+          ENDPOINT_BASE_URLS[path.split("/")[1]]
+        end
+
+        # Set the auth_token for these requests
+        # @return [String]
+        def auth_token
+          @auth_token ||= user_resource.authenticate
+        end
+
+        # Resets existing auth_token and re-authenticates
+        def authenticate
+          @auth_token = nil
+          auth_token
+        end
+      end
+    end
+  end
+end

data/lib/faithteams/api/v2/entity/base.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module FaithTeams
+  module API
+    module V2
+      # Wraps entities returned from the faithteams api.
+      module Entity
+        # Common entity functionality
+        class Base
+          # New instance of the class.
+          def initialize(attributes:)
+            @attributes = attributes
+          end
+
+          # @return [Hash]
+          def to_h
+            attributes
+          end
+
+          # @return [Boolean]
+          def saved?
+            !!read_attribute(:id)
+          end
+
+          private
+
+          attr_reader :attributes
+
+          def read_attribute(attribute)
+            attributes[attribute.to_s]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/faithteams/api/v2/entity/batch.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module FaithTeams
+  module API
+    module V2
+      module Entity
+        # Wraps an faithteams batch object
+        class Batch < Base
+          # @return [Integer, nil]
+          def batch_id
+            read_attribute(:batchId)
+          end
+          alias_method :id, :batch_id
+
+          # @return [Array<FaithTeams::API::V2::Entity::Contributions>]
+          def contributions
+            records = read_attribute(:contributions)
+            return [] unless records.present?
+
+            records.group_by { |r| r["parentId"] }
+              .values
+              .map { FaithTeams::API::V2::Entity::Contribution.new(attributes: _1) }
+          end
+
+          # @return [String, nil]
+          def created_datetime
+            read_attribute(:dtm).presence
+          end
+
+          # @return [Integer, nil]
+          def org_id
+            read_attribute(:orgId)
+          end
+
+          # @return [String, nil] "O" for open, "C" for closed, "D" for deleted
+          def status
+            read_attribute(:status).presence
+          end
+
+          # @return [Boolean]
+          def open?
+            status == "O"
+          end
+
+          # @return [Boolean]
+          def deleted?
+            status == "D"
+          end
+
+          # @return [String, nil]
+          def title
+            read_attribute(:title).presence
+          end
+
+          # @return [String, nil]
+          def updated_datetime
+            read_attribute(:updatedDtm).presence
+          end
+
+          # @return [Integer, nil]
+          def updated_user_id
+            read_attribute(:updatedUser)
+          end
+        end
+      end
+    end
+  end
+end