campus_ivy 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b91ea8a262bcd0fc408fd4241eb06bc64f4e8b9290edeaaa8a81f9d30f41470
-  data.tar.gz: 8cde99cddefb22dc92b45523952b52d267dc0767d898a60879426011ddd44056
+  metadata.gz: a9f79973cef941b5c90cebb3dd9a0770fb866e007ae79142c08648db431f7a0e
+  data.tar.gz: cfb6f7d8a07f8c1cd1ba5cce8aed4fa82155f0337a41af1901c65b8d61b0b5d3
 SHA512:
-  metadata.gz: 9e3a90859cc7f155f783c85eb9e937d6a000f8d3d35a81af4e6400477e54339ba3a98a93ebf1074b8c2b2ea23e4e6ca5f2cff63339c9c13a05e0a25b25b05e35
-  data.tar.gz: 2cebc15d396c285b763363764b58ea4a2fa4dc26d3d541436a32076cc232d953730864117bcc41da7d872283856ed43ea0122825a42ef33a578a1bf6c5dc26d5
+  metadata.gz: 48df225a852d3f8fac9fa293c30cc7a14287ef79a1242ec3adb2a2a3bfaae8847b92b508dda3fd48e547fe056841fd8c8d23bbac6a4122438c6f785b25a0c822
+  data.tar.gz: ec2ac6aa6d845e7f24a2b13b519369d48581d78408a4935bc6caf96a6f2cd6dfcdbf336d541164e477492e194d20f150918fbe3543beb6619784be2eeba4872a

data/.rubocop.yml

@@ -0,0 +1,35 @@
+AllCops:
+  TargetRubyVersion: 3.2
+  NewCops: enable
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+    - 'campus_ivy.gemspec'
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Style/OpenStructUse:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Style/MissingRespondToMissing:
+  Enabled: false
+
+Gemspec/DevelopmentDependencies:
+  Enabled: false

data/CHANGELOG.md

@@ -1,5 +1,40 @@
 ## [Unreleased]
 
+## [1.0.0] - 2026-01-26
+
+### Added
+- **Attendance:** Added `Attendance` resource.
+- **Financial Aid (Awards & Disbursements):**
+  - `AwardAndDisbursementTransmission`
+  - `DisbursementBatchDetail`
+  - `Packaging`
+  - `StudentAwards`
+  - `StudentAwardTransmissionLog`
+  - `StudentDisbursementTransmissionLog`
+- **Financial Aid (COD/ISIR/R2T4):**
+  - `CODLog`, `CODResponseEC`, `CODResponsePN`, `CODResponseSP`
+  - `StudentISIR` (including `verification_request` and `update_status`)
+  - `StudentSelectedISIR`
+  - `StudentR2T4`
+- **Financial Aid (Analysis & Funding):**
+  - `NetPriceCalculator`, `PayListAnalysis`
+  - `StudentFAProgression`, `StudentFundingDetail`
+  - `StudentFundingEstimate`, `StudentRemainingBalance`
+- **Documents:**
+  - `DocumentAnalysis`, `DocumentInventory`, `DocumentStatus`
+  - `StudentDocument` (including import and blob search)
+  - `StudentDocumentHistory`, `StudentDocumentTags`
+- **System & User:**
+  - `FunctionalAreaTask`, `Health` (check & ping)
+  - `InstitutionBreaksByShift`, `NoteType`
+  - `RegisteredStudent` (list & create)
+  - `ServiceType`
+  - `StudentNote` (list & create)
+  - `StudentReference` (list & create)
+  - `UserLoginOption`, `UserNotification` (list & mark_read)
+  - `UserProfile`, `UserRole` (including xref)
+- **Client:** Exposed all new resources via `CampusIvy::Client` accessors.
+
 ## [0.1.0] - 2025-12-16
 
 ### Added

data/Rakefile

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
-require "minitest/test_task"
+require 'bundler/gem_tasks'
+require 'minitest/test_task'
 
 Minitest::TestTask.create
 

data/lib/campus_ivy/client.rb

@@ -30,5 +30,195 @@ module CampusIvy
     def account
       Resources::Account.new(self)
     end
+
+    sig { returns(CampusIvy::Resources::Attendance) }
+    def attendance
+      Resources::Attendance.new(self)
+    end
+
+    sig { returns(CampusIvy::Resources::AwardAndDisbursementTransmission) }
+    def award_and_disbursement_transmission
+      Resources::AwardAndDisbursementTransmission.new(self)
+    end
+
+    sig { returns(CampusIvy::Resources::DisbursementBatchDetail) }
+    def disbursement_batch_detail
+      Resources::DisbursementBatchDetail.new(self)
+    end
+
+    sig { returns(CampusIvy::Resources::Packaging) }
+    def packaging
+      Resources::Packaging.new(self)
+    end
+
+    sig { returns(CampusIvy::Resources::StudentAwards) }
+    def student_awards
+      Resources::StudentAwards.new(self)
+    end
+
+    sig { returns(CampusIvy::Resources::StudentAwardTransmissionLog) }
+    def student_award_transmission_log
+      Resources::StudentAwardTransmissionLog.new(self)
+    end
+
+    sig { returns(CampusIvy::Resources::StudentDisbursementTransmissionLog) }
+    def student_disbursement_transmission_log
+      Resources::StudentDisbursementTransmissionLog.new(self)
+    end
+
+    sig { returns(CampusIvy::Resources::CODLog) }
+    def cod_log
+      Resources::CODLog.new(self)
+    end
+
+    sig { returns(CampusIvy::Resources::CODResponseEC) }
+    def cod_response_ec
+      Resources::CODResponseEC.new(self)
+    end
+
+    sig { returns(CampusIvy::Resources::CODResponsePN) }
+    def cod_response_pn
+      Resources::CODResponsePN.new(self)
+    end
+
+    sig { returns(CampusIvy::Resources::CODResponseSP) }
+    def cod_response_sp
+      Resources::CODResponseSP.new(self)
+    end
+
+    sig { returns(CampusIvy::Resources::StudentISIR) }
+    def student_isir
+      Resources::StudentISIR.new(self)
+    end
+
+    sig { returns(CampusIvy::Resources::StudentSelectedISIR) }
+    def student_selected_isir
+      Resources::StudentSelectedISIR.new(self)
+    end
+
+    sig { returns(CampusIvy::Resources::StudentR2T4) }
+    def student_r2t4
+      Resources::StudentR2T4.new(self)
+    end
+
+    sig { returns(CampusIvy::Resources::NetPriceCalculator) }
+    def net_price_calculator
+      Resources::NetPriceCalculator.new(self)
+    end
+
+    sig { returns(CampusIvy::Resources::PayListAnalysis) }
+    def pay_list_analysis
+      Resources::PayListAnalysis.new(self)
+    end
+
+    sig { returns(CampusIvy::Resources::StudentFAProgression) }
+    def student_fa_progression
+      Resources::StudentFAProgression.new(self)
+    end
+
+    sig { returns(CampusIvy::Resources::StudentFundingDetail) }
+    def student_funding_detail
+      Resources::StudentFundingDetail.new(self)
+    end
+
+    sig { returns(CampusIvy::Resources::StudentFundingEstimate) }
+    def student_funding_estimate
+      Resources::StudentFundingEstimate.new(self)
+    end
+
+    sig { returns(CampusIvy::Resources::StudentRemainingBalance) }
+    def student_remaining_balance
+      Resources::StudentRemainingBalance.new(self)
+    end
+
+    sig { returns(CampusIvy::Resources::DocumentAnalysis) }
+    def document_analysis
+      Resources::DocumentAnalysis.new(self)
+    end
+
+    sig { returns(CampusIvy::Resources::DocumentInventory) }
+    def document_inventory
+      Resources::DocumentInventory.new(self)
+    end
+
+    sig { returns(CampusIvy::Resources::DocumentStatus) }
+    def document_status
+      Resources::DocumentStatus.new(self)
+    end
+
+    sig { returns(CampusIvy::Resources::StudentDocument) }
+    def student_document
+      Resources::StudentDocument.new(self)
+    end
+
+    sig { returns(CampusIvy::Resources::StudentDocumentHistory) }
+    def student_document_history
+      Resources::StudentDocumentHistory.new(self)
+    end
+
+    sig { returns(CampusIvy::Resources::StudentDocumentTags) }
+    def student_document_tags
+      Resources::StudentDocumentTags.new(self)
+    end
+
+    sig { returns(CampusIvy::Resources::FunctionalAreaTask) }
+    def functional_area_task
+      Resources::FunctionalAreaTask.new(self)
+    end
+
+    sig { returns(CampusIvy::Resources::Health) }
+    def health
+      Resources::Health.new(self)
+    end
+
+    sig { returns(CampusIvy::Resources::InstitutionBreaksByShift) }
+    def institution_breaks_by_shift
+      Resources::InstitutionBreaksByShift.new(self)
+    end
+
+    sig { returns(CampusIvy::Resources::NoteType) }
+    def note_type
+      Resources::NoteType.new(self)
+    end
+
+    sig { returns(CampusIvy::Resources::RegisteredStudent) }
+    def registered_student
+      Resources::RegisteredStudent.new(self)
+    end
+
+    sig { returns(CampusIvy::Resources::ServiceType) }
+    def service_type
+      Resources::ServiceType.new(self)
+    end
+
+    sig { returns(CampusIvy::Resources::StudentNote) }
+    def student_note
+      Resources::StudentNote.new(self)
+    end
+
+    sig { returns(CampusIvy::Resources::StudentReference) }
+    def student_reference
+      Resources::StudentReference.new(self)
+    end
+
+    sig { returns(CampusIvy::Resources::UserLoginOption) }
+    def user_login_option
+      Resources::UserLoginOption.new(self)
+    end
+
+    sig { returns(CampusIvy::Resources::UserNotification) }
+    def user_notification
+      Resources::UserNotification.new(self)
+    end
+
+    sig { returns(CampusIvy::Resources::UserProfile) }
+    def user_profile
+      Resources::UserProfile.new(self)
+    end
+
+    sig { returns(CampusIvy::Resources::UserRole) }
+    def user_role
+      Resources::UserRole.new(self)
+    end
   end
 end

data/lib/campus_ivy/object.rb

@@ -18,7 +18,7 @@ module CampusIvy
       )
     end
 
-    def method_missing(method, *args, &block)
+    def method_missing(method, *args, &)
       if encoding_aware? && method.to_s.end_with?('=')
         super
       else

data/lib/campus_ivy/resources/attendance.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module CampusIvy
+  module Resources
+    class Attendance
+      extend T::Sig
+
+      sig { params(client: CampusIvy::Client).void }
+      def initialize(client)
+        @client = client
+      end
+
+      sig do
+        params(
+          institution_import_file_id: T.nilable(Integer),
+          import_processing_status_id: T.nilable(String),
+          student_id: T.nilable(String),
+          has_errors: T.nilable(T::Boolean),
+          has_warnings: T.nilable(T::Boolean),
+          start_date: T.nilable(String),
+          end_date: T.nilable(String)
+        ).returns(CampusIvy::Object)
+      end
+      def list(
+        institution_import_file_id: nil,
+        import_processing_status_id: nil,
+        student_id: nil,
+        has_errors: nil,
+        has_warnings: nil,
+        start_date: nil,
+        end_date: nil
+      )
+        params = {
+          'request.institutionImportFileId' => institution_import_file_id,
+          'request.importProcessingStatusId' => import_processing_status_id,
+          'request.studentId' => student_id,
+          'request.hasErrors' => has_errors,
+          'request.hasWarnings' => has_warnings,
+          'request.startDate' => start_date,
+          'request.endDate' => end_date
+        }.compact
+
+        response = @client.connection.get('Attendance', params)
+        CampusIvy::Object.new(response.body)
+      end
+
+      sig do
+        params(
+          students_attendances: T::Array[T::Hash[Symbol, T.untyped]],
+          file_source: T.nilable(String),
+          validate_records: T.nilable(T::Boolean),
+          process_records: T.nilable(T::Boolean),
+          return_result: T.nilable(T::Boolean),
+          batch_size: T.nilable(Integer),
+          response_type: T.nilable(String)
+        ).returns(CampusIvy::Object)
+      end
+      def import(
+        students_attendances:,
+        file_source: nil,
+        validate_records: nil,
+        process_records: nil,
+        return_result: nil,
+        batch_size: nil,
+        response_type: nil
+      )
+        query_params = {
+          fileSource: file_source,
+          validateRecords: validate_records,
+          processRecords: process_records,
+          returnResult: return_result,
+          batchSize: batch_size,
+          responseType: response_type
+        }.compact
+
+        response = @client.connection.post('Attendance') do |req|
+          req.params = query_params
+          req.body = students_attendances
+        end
+
+        CampusIvy::Object.new(response.body)
+      end
+    end
+  end
+end

data/lib/campus_ivy/resources/award_and_disbursement_transmission.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module CampusIvy
+  module Resources
+    class AwardAndDisbursementTransmission
+      extend T::Sig
+
+      sig { params(client: CampusIvy::Client).void }
+      def initialize(client)
+        @client = client
+      end
+
+      sig do
+        params(
+          start_date: T.nilable(String),
+          end_date: T.nilable(String)
+        ).returns(CampusIvy::Object)
+      end
+      def list(start_date: nil, end_date: nil)
+        params = {
+          'request.startDate' => start_date,
+          'request.endDate' => end_date
+        }.compact
+
+        response = @client.connection.get('AwardAndDisbursementTransmission', params)
+        CampusIvy::Object.new(response.body)
+      end
+    end
+  end
+end

data/lib/campus_ivy/resources/cod_log.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module CampusIvy
+  module Resources
+    class CODLog
+      extend T::Sig
+
+      sig { params(client: CampusIvy::Client).void }
+      def initialize(client)
+        @client = client
+      end
+
+      sig do
+        params(
+          financial_award_id: T.nilable(String),
+          document_id: T.nilable(String),
+          ssn: T.nilable(String),
+          start_date: T.nilable(String),
+          end_date: T.nilable(String)
+        ).returns(CampusIvy::Object)
+      end
+      def list(
+        financial_award_id: nil,
+        document_id: nil,
+        ssn: nil,
+        start_date: nil,
+        end_date: nil
+      )
+        params = {
+          'request.financialAwardId' => financial_award_id,
+          'request.documentId' => document_id,
+          'request.ssn' => ssn,
+          'request.startDate' => start_date,
+          'request.endDate' => end_date
+        }.compact
+
+        response = @client.connection.get('CODLog', params)
+        CampusIvy::Object.new(response.body)
+      end
+    end
+  end
+end

data/lib/campus_ivy/resources/cod_response_ec.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module CampusIvy
+  module Resources
+    class CODResponseEC
+      extend T::Sig
+
+      sig { params(client: CampusIvy::Client).void }
+      def initialize(client)
+        @client = client
+      end
+
+      sig do
+        params(
+          institution_student_id: T.nilable(Integer),
+          student_id_list: T.nilable(String),
+          start_date: T.nilable(String),
+          end_date: T.nilable(String)
+        ).returns(CampusIvy::Object)
+      end
+      def list(
+        institution_student_id: nil,
+        student_id_list: nil,
+        start_date: nil,
+        end_date: nil
+      )
+        params = {
+          'request.institutionStudentId' => institution_student_id,
+          'request.studentIdList' => student_id_list,
+          'request.startDate' => start_date,
+          'request.endDate' => end_date
+        }.compact
+
+        response = @client.connection.get('CODResponseEC', params)
+        CampusIvy::Object.new(response.body)
+      end
+    end
+  end
+end

data/lib/campus_ivy/resources/cod_response_pn.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module CampusIvy
+  module Resources
+    class CODResponsePN
+      extend T::Sig
+
+      sig { params(client: CampusIvy::Client).void }
+      def initialize(client)
+        @client = client
+      end
+
+      sig do
+        params(
+          institution_student_id: T.nilable(Integer),
+          student_id_list: T.nilable(String),
+          start_date: T.nilable(String),
+          end_date: T.nilable(String)
+        ).returns(CampusIvy::Object)
+      end
+      def list(
+        institution_student_id: nil,
+        student_id_list: nil,
+        start_date: nil,
+        end_date: nil
+      )
+        params = {
+          'request.institutionStudentId' => institution_student_id,
+          'request.studentIdList' => student_id_list,
+          'request.startDate' => start_date,
+          'request.endDate' => end_date
+        }.compact
+
+        response = @client.connection.get('CODResponsePN', params)
+        CampusIvy::Object.new(response.body)
+      end
+    end
+  end
+end

data/lib/campus_ivy/resources/cod_response_sp.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module CampusIvy
+  module Resources
+    class CODResponseSP
+      extend T::Sig
+
+      sig { params(client: CampusIvy::Client).void }
+      def initialize(client)
+        @client = client
+      end
+
+      sig do
+        params(
+          institution_student_id: T.nilable(Integer),
+          student_id_list: T.nilable(String),
+          start_date: T.nilable(String),
+          end_date: T.nilable(String)
+        ).returns(CampusIvy::Object)
+      end
+      def list(
+        institution_student_id: nil,
+        student_id_list: nil,
+        start_date: nil,
+        end_date: nil
+      )
+        params = {
+          'request.institutionStudentId' => institution_student_id,
+          'request.studentIdList' => student_id_list,
+          'request.startDate' => start_date,
+          'request.endDate' => end_date
+        }.compact
+
+        response = @client.connection.get('CODResponseSP', params)
+        CampusIvy::Object.new(response.body)
+      end
+    end
+  end
+end

data/lib/campus_ivy/resources/disbursement_batch_detail.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module CampusIvy
+  module Resources
+    class DisbursementBatchDetail
+      extend T::Sig
+
+      sig { params(client: CampusIvy::Client).void }
+      def initialize(client)
+        @client = client
+      end
+
+      sig do
+        params(
+          institution_disbursement_batch_header_id_list: T.nilable(String),
+          start_date: T.nilable(String),
+          end_date: T.nilable(String)
+        ).returns(CampusIvy::Object)
+      end
+      def list(
+        institution_disbursement_batch_header_id_list: nil,
+        start_date: nil,
+        end_date: nil
+      )
+        params = {
+          'request.institutionDisbursementBatchHeaderIdList' => institution_disbursement_batch_header_id_list,
+          'request.startDate' => start_date,
+          'request.endDate' => end_date
+        }.compact
+
+        response = @client.connection.get('DisbursementBatchDetail', params)
+        CampusIvy::Object.new(response.body)
+      end
+    end
+  end
+end

data/lib/campus_ivy/resources/document_analysis.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module CampusIvy
+  module Resources
+    class DocumentAnalysis
+      extend T::Sig
+
+      sig { params(client: CampusIvy::Client).void }
+      def initialize(client)
+        @client = client
+      end
+
+      sig do
+        params(
+          institution_student_id: T.nilable(Integer),
+          student_id_list: T.nilable(String),
+          start_date: T.nilable(String),
+          end_date: T.nilable(String)
+        ).returns(CampusIvy::Object)
+      end
+      def list(
+        institution_student_id: nil,
+        student_id_list: nil,
+        start_date: nil,
+        end_date: nil
+      )
+        params = {
+          'request.institutionStudentId' => institution_student_id,
+          'request.studentIdList' => student_id_list,
+          'request.startDate' => start_date,
+          'request.endDate' => end_date
+        }.compact
+
+        response = @client.connection.get('DocumentAnalysis', params)
+        CampusIvy::Object.new(response.body)
+      end
+    end
+  end
+end

data/lib/campus_ivy/resources/document_inventory.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module CampusIvy
+  module Resources
+    class DocumentInventory
+      extend T::Sig
+
+      sig { params(client: CampusIvy::Client).void }
+      def initialize(client)
+        @client = client
+      end
+
+      sig do
+        params(
+          institution_document_id_list: T.nilable(String),
+          start_date: T.nilable(String),
+          end_date: T.nilable(String)
+        ).returns(CampusIvy::Object)
+      end
+      def list(
+        institution_document_id_list: nil,
+        start_date: nil,
+        end_date: nil
+      )
+        params = {
+          'request.institutionDocumentIdList' => institution_document_id_list,
+          'request.startDate' => start_date,
+          'request.endDate' => end_date
+        }.compact
+
+        response = @client.connection.get('DocumentInventory', params)
+        CampusIvy::Object.new(response.body)
+      end
+    end
+  end
+end