d4h_api 2.0.0

data/lib/d4h/api/models/handler_group.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module D4H
+  module API
+    class HandlerGroup < Model
+    end
+  end
+end

data/lib/d4h/api/models/handler_group_membership.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module D4H
+  module API
+    class HandlerGroupMembership < Model
+    end
+  end
+end

data/lib/d4h/api/models/handler_qualification.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module D4H
+  module API
+    class HandlerQualification < Model
+    end
+  end
+end

data/lib/d4h/api/models/health_safety_category.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module D4H
+  module API
+    class HealthSafetyCategory < Model
+    end
+  end
+end

data/lib/d4h/api/models/health_safety_report.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module D4H
+  module API
+    class HealthSafetyReport < Model
+    end
+  end
+end

data/lib/d4h/api/models/health_safety_severity.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module D4H
+  module API
+    class HealthSafetySeverity < Model
+    end
+  end
+end

data/lib/d4h/api/models/incident.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module D4H
+  module API
+    class Incident < Model
+    end
+  end
+end

data/lib/d4h/api/models/incident_involved_injury.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module D4H
+  module API
+    class IncidentInvolvedInjury < Model
+    end
+  end
+end

data/lib/d4h/api/models/incident_involved_metadata.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module D4H
+  module API
+    class IncidentInvolvedMetadata < Model
+    end
+  end
+end

data/lib/d4h/api/models/incident_involved_person.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module D4H
+  module API
+    class IncidentInvolvedPerson < Model
+    end
+  end
+end

data/lib/d4h/api/models/location_bookmark.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module D4H
+  module API
+    class LocationBookmark < Model
+    end
+  end
+end

data/lib/d4h/api/models/member.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module D4H
+  module API
+    class Member < Model
+    end
+  end
+end

data/lib/d4h/api/models/member_custom_status.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module D4H
+  module API
+    class MemberCustomStatus < Model
+    end
+  end
+end

data/lib/d4h/api/models/member_group.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module D4H
+  module API
+    class MemberGroup < Model
+    end
+  end
+end

data/lib/d4h/api/models/member_group_membership.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module D4H
+  module API
+    class MemberGroupMembership < Model
+    end
+  end
+end

data/lib/d4h/api/models/member_qualification.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module D4H
+  module API
+    class MemberQualification < Model
+    end
+  end
+end

data/lib/d4h/api/models/member_qualification_award.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module D4H
+  module API
+    class MemberQualificationAward < Model
+    end
+  end
+end

data/lib/d4h/api/models/member_retired_reason.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module D4H
+  module API
+    class MemberRetiredReason < Model
+    end
+  end
+end

data/lib/d4h/api/models/organisation.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module D4H
+  module API
+    class Organisation < Model
+    end
+  end
+end

data/lib/d4h/api/models/repair.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module D4H
+  module API
+    class Repair < Model
+    end
+  end
+end

data/lib/d4h/api/models/resource_bundle.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module D4H
+  module API
+    class ResourceBundle < Model
+    end
+  end
+end

data/lib/d4h/api/models/role.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module D4H
+  module API
+    class Role < Model
+    end
+  end
+end

data/lib/d4h/api/models/search_result.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module D4H
+  module API
+    class SearchResult < Model
+    end
+  end
+end

data/lib/d4h/api/models/tag.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module D4H
+  module API
+    class Tag < Model
+    end
+  end
+end

data/lib/d4h/api/models/team.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module D4H
+  module API
+    class Team < Model
+    end
+  end
+end

data/lib/d4h/api/models/whiteboard.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module D4H
+  module API
+    class Whiteboard < Model
+    end
+  end
+end

data/lib/d4h/api/models/whoami.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module D4H
+  module API
+    class Whoami < Model
+    end
+  end
+end

data/lib/d4h/api/resource.rb

@@ -0,0 +1,171 @@
+# frozen_string_literal: true
+
+module D4H
+  module API
+    # Public: Base class for all D4H API resource endpoints.
+    #
+    # Provides HTTP verb helpers (GET, POST, PUT, PATCH, DELETE), automatic
+    # Bearer token authentication, error handling, and a pagination helper
+    # for fetching all pages of a list endpoint.
+    #
+    # Subclasses must define a `SUB_URL` constant (e.g. "members", "tags")
+    # and implement whichever CRUD methods the API supports for that resource.
+    #
+    # Examples
+    #
+    #   class TagResource < Resource
+    #     SUB_URL = "tags"
+    #
+    #     def list(**params)
+    #       Collection.new(get_request(resource_url, params: params).body, model_class: Tag)
+    #     end
+    #
+    #     def show(id:)
+    #       Tag.new(get_request("#{resource_url}/#{id}").body)
+    #     end
+    #   end
+    class Resource
+      # Public: Returns the Client instance this resource is bound to.
+      attr_reader :client
+
+      # Public: Initialize a Resource bound to a Client.
+      #
+      # client - A D4H::API::Client instance.
+      def initialize(client)
+        @client = client
+      end
+
+      # Public: Returns the context-scoped base path (e.g. "v3/team/42").
+      def base_path
+        client.base_path
+      end
+
+      # Public: Returns the full resource URL path (e.g. "v3/team/42/tags").
+      #
+      # Built from the client's base_path and the subclass's SUB_URL constant.
+      def resource_url
+        "#{base_path}/#{self.class::SUB_URL}"
+      end
+
+      # Public: Perform a GET request.
+      #
+      # url     - The URL path to request.
+      # params  - Optional Hash of query parameters (default: {}).
+      # headers - Optional Hash of additional HTTP headers (default: {}).
+      #
+      # Returns the Faraday::Response on success.
+      # Raises D4H::API::Error on non-2xx status.
+      def get_request(url, params: {}, headers: {})
+        handle_response(client.connection.get(url, params, default_headers.merge(headers)))
+      end
+
+      # Public: Perform a POST request.
+      #
+      # url     - The URL path to request.
+      # body    - The Hash request body to send.
+      # headers - Optional Hash of additional HTTP headers (default: {}).
+      #
+      # Returns the Faraday::Response on success.
+      # Raises D4H::API::Error on non-2xx status.
+      def post_request(url, body:, headers: {})
+        handle_response(client.connection.post(url, body, default_headers.merge(headers)))
+      end
+
+      # Public: Perform a PUT request.
+      #
+      # Used by DocumentResource, which requires PUT for updates per the D4H API.
+      #
+      # url     - The URL path to request.
+      # body    - The Hash request body to send.
+      # headers - Optional Hash of additional HTTP headers (default: {}).
+      #
+      # Returns the Faraday::Response on success.
+      # Raises D4H::API::Error on non-2xx status.
+      def put_request(url, body:, headers: {})
+        handle_response(client.connection.put(url, body, default_headers.merge(headers)))
+      end
+
+      # Public: Perform a PATCH request.
+      #
+      # Used by most resources for updates.
+      #
+      # url     - The URL path to request.
+      # body    - The Hash request body to send (default: {}).
+      # headers - Optional Hash of additional HTTP headers (default: {}).
+      #
+      # Returns the Faraday::Response on success.
+      # Raises D4H::API::Error on non-2xx status.
+      def patch_request(url, body: {}, headers: {})
+        handle_response(client.connection.patch(url, body, default_headers.merge(headers)))
+      end
+
+      # Public: Perform a DELETE request.
+      #
+      # url     - The URL path to request.
+      # params  - Optional Hash of query parameters (default: {}).
+      # headers - Optional Hash of additional HTTP headers (default: {}).
+      #
+      # Returns the Faraday::Response on success.
+      # Raises D4H::API::Error on non-2xx status.
+      def delete_request(url, params: {}, headers: {})
+        handle_response(client.connection.delete(url, params, default_headers.merge(headers)))
+      end
+
+      # Internal: Returns the default Authorization header for all requests.
+      def default_headers
+        {Authorization: "Bearer #{client.api_key}"}
+      end
+
+      # Internal: Check the HTTP response status and raise on errors.
+      #
+      # response - A Faraday::Response object.
+      #
+      # Returns the response if status is 2xx.
+      # Raises D4H::API::RetriableError for transient errors (429, 5xx) after
+      # all retry attempts have been exhausted by the Faraday retry middleware.
+      # Raises D4H::API::Error for all other non-2xx responses.
+      def handle_response(response)
+        return response if (200..299).cover?(response.status)
+
+        body = response.body || {}
+        message = [body["error"], body["message"]].compact.join(": ")
+
+        raise RetriableError, message if Client::RETRIABLE_STATUSES.include?(response.status)
+
+        raise Error, message
+      end
+
+      private
+
+      # Internal: Fetch all pages of a list endpoint and return a single Collection.
+      #
+      # Iterates through pages starting at page 0, accumulating results until
+      # all records are fetched (based on totalSize) or the API returns an
+      # empty page.
+      #
+      # params      - A Hash of query parameters. :size defaults to 250.
+      # model_class - The Model subclass to wrap results in (e.g. Member, Tag).
+      #
+      # Returns a Collection containing all results across all pages.
+      def paginate_all(params, model_class:)
+        params[:size] ||= 250
+        all_results = []
+        page = params.fetch(:page, 0)
+
+        loop do
+          response = get_request(resource_url, params: params.merge(page: page)).body
+          results = response["results"] || []
+          all_results.concat(results)
+          break if all_results.size >= response["totalSize"] || results.empty?
+
+          page += 1
+        end
+
+        Collection.new(
+          {"results" => all_results, "page" => 0, "pageSize" => all_results.size, "totalSize" => all_results.size},
+          model_class: model_class,
+        )
+      end
+    end
+  end
+end

data/lib/d4h/api/resources/animal_group_membership_resource.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module D4H
+  module API
+    class AnimalGroupMembershipResource < Resource
+      SUB_URL = "animal-group-memberships"
+
+      def list(**params)
+        Collection.new(get_request(resource_url, params: params).body, model_class: AnimalGroupMembership)
+      end
+
+      def list_all(**params)
+        paginate_all(params, model_class: AnimalGroupMembership)
+      end
+
+      def show(id:)
+        AnimalGroupMembership.new(get_request("#{resource_url}/#{id}").body)
+      end
+    end
+  end
+end

data/lib/d4h/api/resources/animal_group_resource.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module D4H
+  module API
+    class AnimalGroupResource < Resource
+      SUB_URL = "animal-groups"
+
+      def list(**params)
+        Collection.new(get_request(resource_url, params: params).body, model_class: AnimalGroup)
+      end
+
+      def list_all(**params)
+        paginate_all(params, model_class: AnimalGroup)
+      end
+
+      def show(id:)
+        AnimalGroup.new(get_request("#{resource_url}/#{id}").body)
+      end
+
+      def create(data)
+        AnimalGroup.new(post_request(resource_url, body: data).body)
+      end
+
+      def update(id:, **params)
+        AnimalGroup.new(patch_request("#{resource_url}/#{id}", body: params).body)
+      end
+
+      def destroy(id:)
+        delete_request("#{resource_url}/#{id}")
+      end
+    end
+  end
+end

data/lib/d4h/api/resources/animal_qualification_resource.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module D4H
+  module API
+    class AnimalQualificationResource < Resource
+      SUB_URL = "animal-qualifications"
+
+      def list(**params)
+        Collection.new(get_request(resource_url, params: params).body, model_class: AnimalQualification)
+      end
+
+      def list_all(**params)
+        paginate_all(params, model_class: AnimalQualification)
+      end
+
+      def show(id:)
+        AnimalQualification.new(get_request("#{resource_url}/#{id}").body)
+      end
+    end
+  end
+end

data/lib/d4h/api/resources/animal_resource.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module D4H
+  module API
+    class AnimalResource < Resource
+      SUB_URL = "animals"
+
+      def list(**params)
+        Collection.new(get_request(resource_url, params: params).body, model_class: Animal)
+      end
+
+      def list_all(**params)
+        paginate_all(params, model_class: Animal)
+      end
+
+      def show(id:)
+        Animal.new(get_request("#{resource_url}/#{id}").body)
+      end
+    end
+  end
+end

data/lib/d4h/api/resources/attendance_resource.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module D4H
+  module API
+    class AttendanceResource < Resource
+      SUB_URL = "attendance"
+
+      def list(**params)
+        Collection.new(get_request(resource_url, params: params).body, model_class: Attendance)
+      end
+
+      def list_all(**params)
+        paginate_all(params, model_class: Attendance)
+      end
+
+      def show(id:)
+        Attendance.new(get_request("#{resource_url}/#{id}").body)
+      end
+
+      def create(data)
+        Attendance.new(post_request(resource_url, body: data).body)
+      end
+    end
+  end
+end

data/lib/d4h/api/resources/custom_field_for_entity_resource.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module D4H
+  module API
+    class CustomFieldForEntityResource < Resource
+      SUB_URL = "custom-field-options"
+
+      def list(**params)
+        Collection.new(get_request(resource_url, params: params).body, model_class: CustomFieldForEntity)
+      end
+
+      def show(id:)
+        CustomFieldForEntity.new(get_request("#{resource_url}/#{id}").body)
+      end
+    end
+  end
+end

data/lib/d4h/api/resources/custom_field_resource.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module D4H
+  module API
+    class CustomFieldResource < Resource
+      SUB_URL = "custom-fields"
+
+      def list(**params)
+        Collection.new(get_request(resource_url, params: params).body, model_class: CustomField)
+      end
+
+      def list_all(**params)
+        paginate_all(params, model_class: CustomField)
+      end
+
+      def show(id:)
+        CustomField.new(get_request("#{resource_url}/#{id}").body)
+      end
+
+      def create(data)
+        CustomField.new(post_request(resource_url, body: data).body)
+      end
+
+      def update(id:, **params)
+        CustomField.new(patch_request("#{resource_url}/#{id}", body: params).body)
+      end
+
+      def destroy(id:)
+        delete_request("#{resource_url}/#{id}")
+      end
+    end
+  end
+end

data/lib/d4h/api/resources/customer_identifier_resource.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module D4H
+  module API
+    class CustomerIdentifierResource < Resource
+      SUB_URL = "customer-identifiers"
+
+      def list(**params)
+        Collection.new(get_request(resource_url, params: params).body, model_class: CustomerIdentifier)
+      end
+
+      def list_all(**params)
+        paginate_all(params, model_class: CustomerIdentifier)
+      end
+    end
+  end
+end

data/lib/d4h/api/resources/d4h_module_resource.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module D4H
+  module API
+    class D4hModuleResource < Resource
+      SUB_URL = "modules"
+
+      def list(**params)
+        Collection.new(get_request(resource_url, params: params).body, model_class: D4hModule)
+      end
+
+      def list_all(**params)
+        paginate_all(params, model_class: D4hModule)
+      end
+    end
+  end
+end

data/lib/d4h/api/resources/d4h_task_resource.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module D4H
+  module API
+    class D4hTaskResource < Resource
+      SUB_URL = "tasks"
+
+      def list(**params)
+        Collection.new(get_request(resource_url, params: params).body, model_class: D4hTask)
+      end
+
+      def list_all(**params)
+        paginate_all(params, model_class: D4hTask)
+      end
+    end
+  end
+end