campus_ivy 0.1.1 → 1.0.0

data/lib/campus_ivy/resources/student_document.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+module CampusIvy
+  module Resources
+    class StudentDocument
+      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),
+          student_document_id: T.nilable(Integer),
+          document_status_id: T.nilable(Integer),
+          start_date: T.nilable(String),
+          end_date: T.nilable(String),
+          include_blob: T.nilable(T::Boolean)
+        ).returns(CampusIvy::Object)
+      end
+      def list(
+        institution_student_id: nil,
+        student_id_list: nil,
+        student_document_id: nil,
+        document_status_id: nil,
+        start_date: nil,
+        end_date: nil,
+        include_blob: nil
+      )
+        params = {
+          'request.institutionStudentId' => institution_student_id,
+          'request.studentIdList' => student_id_list,
+          'request.studentDocumentId' => student_document_id,
+          'request.documentStatusId' => document_status_id,
+          'request.startDate' => start_date,
+          'request.endDate' => end_date,
+          'request.includeBlob' => include_blob
+        }.compact
+
+        response = @client.connection.get('StudentDocument', params)
+        CampusIvy::Object.new(response.body)
+      end
+
+      sig do
+        params(
+          students_documents: T::Array[T::Hash[Symbol, T.untyped]],
+          validate_records: T.nilable(T::Boolean),
+          process_records: T.nilable(T::Boolean),
+          batch_size: T.nilable(Integer),
+          return_result: T.nilable(T::Boolean),
+          response_type: T.nilable(String)
+        ).returns(CampusIvy::Object)
+      end
+      def import(
+        students_documents:,
+        validate_records: nil,
+        process_records: nil,
+        batch_size: nil,
+        return_result: nil,
+        response_type: nil
+      )
+        params = {
+          validateRecords: validate_records,
+          processRecords: process_records,
+          batchSize: batch_size,
+          returnResult: return_result,
+          responseType: response_type
+        }.compact
+
+        response = @client.connection.post('StudentDocument') do |req|
+          req.params = params
+          req.body = students_documents
+        end
+        CampusIvy::Object.new(response.body)
+      end
+
+      sig do
+        params(
+          institution_student_id: Integer,
+          student_document_id: Integer,
+          blob_search: T::Boolean
+        ).returns(CampusIvy::Object)
+      end
+      def search_blob(
+        institution_student_id:,
+        student_document_id:,
+        blob_search: true
+      )
+        params = {
+          'request.institutionStudentId' => institution_student_id,
+          'request.studentDocumentId' => student_document_id,
+          'request.blobSearch' => blob_search
+        }
+        response = @client.connection.get('StudentDocument/Blob/Search', params)
+        CampusIvy::Object.new(response.body)
+      end
+
+      sig { params(id: Integer).returns(CampusIvy::Object) }
+      def status_options(id:)
+        response = @client.connection.get("StudentDocument/#{id}/StatusOption")
+        CampusIvy::Object.new(response.body)
+      end
+    end
+  end
+end

data/lib/campus_ivy/resources/student_document_history.rb

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

data/lib/campus_ivy/resources/student_document_tags.rb

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

data/lib/campus_ivy/resources/student_fa_progression.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module CampusIvy
+  module Resources
+    class StudentFAProgression
+      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),
+          lead_source: T.nilable(String),
+          include_enrollment_update: T.nilable(T::Boolean),
+          include_isir_update: T.nilable(T::Boolean),
+          include_document_update: T.nilable(T::Boolean),
+          include_notification_update: T.nilable(T::Boolean),
+          include_funding_estimate_update: T.nilable(T::Boolean),
+          include_disbursement_update: T.nilable(T::Boolean),
+          start_date: T.nilable(String),
+          end_date: T.nilable(String)
+        ).returns(CampusIvy::Object)
+      end
+      def list(
+        institution_student_id: nil,
+        student_id_list: nil,
+        lead_source: nil,
+        include_enrollment_update: nil,
+        include_isir_update: nil,
+        include_document_update: nil,
+        include_notification_update: nil,
+        include_funding_estimate_update: nil,
+        include_disbursement_update: nil,
+        start_date: nil,
+        end_date: nil
+      )
+        params = {
+          'request.institutionStudentId' => institution_student_id,
+          'request.studentIdList' => student_id_list,
+          'request.leadSource' => lead_source,
+          'request.includeEnrollmentUpdate' => include_enrollment_update,
+          'request.includeISIRUpdate' => include_isir_update,
+          'request.includeDocumentUpdate' => include_document_update,
+          'request.includeNotificationUpdate' => include_notification_update,
+          'request.includeFundingEstimateUpdate' => include_funding_estimate_update,
+          'request.includeDisbursementUpdate' => include_disbursement_update,
+          'request.startDate' => start_date,
+          'request.endDate' => end_date
+        }.compact
+
+        response = @client.connection.get('StudentFAProgression', params)
+        CampusIvy::Object.new(response.body)
+      end
+    end
+  end
+end

data/lib/campus_ivy/resources/student_funding_detail.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module CampusIvy
+  module Resources
+    class StudentFundingDetail
+      extend T::Sig
+
+      sig { params(client: CampusIvy::Client).void }
+      def initialize(client)
+        @client = client
+      end
+
+      sig do
+        params(
+          cutoff_date: String,
+          disbursement_date_start: String,
+          disbursement_date_end: String,
+          award_date_start: String,
+          award_date_end: String,
+          institution_student_id: T.nilable(Integer),
+          award_year_id_list: T.nilable(String),
+          fund_type_id_list: T.nilable(String),
+          institution_fund_type_id_list: T.nilable(String),
+          institution_entity_location_id_list: T.nilable(String),
+          institution_entity_id_list: T.nilable(String),
+          institution_student_disbursement_status_id_list: T.nilable(String),
+          institution_enrollment_status_id_list: T.nilable(String)
+        ).returns(CampusIvy::Object)
+      end
+      def list(
+        cutoff_date:,
+        disbursement_date_start:,
+        disbursement_date_end:,
+        award_date_start:,
+        award_date_end:,
+        institution_student_id: nil,
+        award_year_id_list: nil,
+        fund_type_id_list: nil,
+        institution_fund_type_id_list: nil,
+        institution_entity_location_id_list: nil,
+        institution_entity_id_list: nil,
+        institution_student_disbursement_status_id_list: nil,
+        institution_enrollment_status_id_list: nil
+      )
+        params = {
+          'request.cutOffDate' => cutoff_date,
+          'request.disbursementDate_Start' => disbursement_date_start,
+          'request.disbursementDate_End' => disbursement_date_end,
+          'request.awardDate_Start' => award_date_start,
+          'request.awardDate_End' => award_date_end,
+          'request.institutionStudentId' => institution_student_id,
+          'request.awardYearIdList' => award_year_id_list,
+          'request.fundTypeIdList' => fund_type_id_list,
+          'request.institutionFundTypeIdList' => institution_fund_type_id_list,
+          'request.institutionEntityLocationIdList' => institution_entity_location_id_list,
+          'request.institutionEntityIdList' => institution_entity_id_list,
+          'request.institutionStudentDisbursementStatusIdList' => institution_student_disbursement_status_id_list,
+          'request.institutionEnrollmentStatusIdList' => institution_enrollment_status_id_list
+        }.compact
+
+        response = @client.connection.get('StudentFundingDetail', params)
+        CampusIvy::Object.new(response.body)
+      end
+    end
+  end
+end

data/lib/campus_ivy/resources/student_funding_estimate.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module CampusIvy
+  module Resources
+    class StudentFundingEstimate
+      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('StudentFundingEstimate', params)
+        CampusIvy::Object.new(response.body)
+      end
+    end
+  end
+end

data/lib/campus_ivy/resources/student_isir.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module CampusIvy
+  module Resources
+    class StudentISIR
+      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('StudentISIR', params)
+        CampusIvy::Object.new(response.body)
+      end
+
+      sig { params(institution_isir_id: Integer).returns(CampusIvy::Object) }
+      def verification_request(institution_isir_id:)
+        params = {
+          'institutionISIRId' => institution_isir_id
+        }
+        response = @client.connection.get('studentisir/verification-request', params)
+        CampusIvy::Object.new(response.body)
+      end
+
+      sig do
+        params(
+          institution_isir_id: Integer,
+          is_documents_cleared: T.nilable(T::Boolean),
+          is_isir_cleared: T.nilable(T::Boolean),
+          processing_status_id: T.nilable(String)
+        ).returns(CampusIvy::Object)
+      end
+      def update_status(
+        institution_isir_id:,
+        is_documents_cleared: nil,
+        is_isir_cleared: nil,
+        processing_status_id: nil
+      )
+        payload = {
+          InstitutionISIRId: institution_isir_id,
+          IsDocumentsCleared: is_documents_cleared,
+          IsISIRCleared: is_isir_cleared,
+          ProcessingStatusId: processing_status_id
+        }.compact
+
+        response = @client.connection.post('UpdateStudentISIRStatus') do |req|
+          req.body = payload
+        end
+        CampusIvy::Object.new(response.body)
+      end
+    end
+  end
+end

data/lib/campus_ivy/resources/student_note.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module CampusIvy
+  module Resources
+    class StudentNote
+      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),
+          student_note_id: T.nilable(Integer),
+          note_type_id: T.nilable(Integer),
+          start_date: T.nilable(String),
+          end_date: T.nilable(String)
+        ).returns(CampusIvy::Object)
+      end
+      def list(
+        institution_student_id: nil,
+        student_id_list: nil,
+        student_note_id: nil,
+        note_type_id: nil,
+        start_date: nil,
+        end_date: nil
+      )
+        params = {
+          'request.institutionStudentId' => institution_student_id,
+          'request.studentIdList' => student_id_list,
+          'request.studentNoteId' => student_note_id,
+          'request.noteTypeId' => note_type_id,
+          'request.startDate' => start_date,
+          'request.endDate' => end_date
+        }.compact
+
+        response = @client.connection.get('StudentNote', params)
+        CampusIvy::Object.new(response.body)
+      end
+
+      sig do
+        params(
+          student_id: String,
+          note_type_id: Integer,
+          note: String,
+          subject: String
+        ).returns(CampusIvy::Object)
+      end
+      def create(
+        student_id:,
+        note_type_id:,
+        note:,
+        subject:
+      )
+        payload = {
+          StudentId: student_id,
+          NoteTypeId: note_type_id,
+          Note: note,
+          Subject: subject
+        }
+
+        response = @client.connection.post('StudentNote') do |req|
+          req.body = payload
+        end
+        CampusIvy::Object.new(response.body)
+      end
+    end
+  end
+end

data/lib/campus_ivy/resources/student_r2t4.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module CampusIvy
+  module Resources
+    class StudentR2T4
+      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('StudentR2T4', params)
+        CampusIvy::Object.new(response.body)
+      end
+    end
+  end
+end

data/lib/campus_ivy/resources/student_reference.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module CampusIvy
+  module Resources
+    class StudentReference
+      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('StudentReference', params)
+        CampusIvy::Object.new(response.body)
+      end
+
+      sig do
+        params(
+          student_id: String,
+          reference_id: T.nilable(String),
+          reference1: T.nilable(String),
+          reference2: T.nilable(String),
+          reference3: T.nilable(String),
+          reference4: T.nilable(String),
+          reference5: T.nilable(String)
+        ).returns(CampusIvy::Object)
+      end
+      def create(
+        student_id:,
+        reference_id: nil,
+        reference1: nil,
+        reference2: nil,
+        reference3: nil,
+        reference4: nil,
+        reference5: nil
+      )
+        payload = {
+          StudentId: student_id,
+          ReferenceId: reference_id,
+          Reference1: reference1,
+          Reference2: reference2,
+          Reference3: reference3,
+          Reference4: reference4,
+          Reference5: reference5
+        }.compact
+
+        response = @client.connection.post('StudentReference') do |req|
+          req.body = payload
+        end
+        CampusIvy::Object.new(response.body)
+      end
+    end
+  end
+end

data/lib/campus_ivy/resources/student_remaining_balance.rb

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

data/lib/campus_ivy/resources/student_selected_isir.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module CampusIvy
+  module Resources
+    class StudentSelectedISIR
+      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('StudentSelectedISIR', params)
+        CampusIvy::Object.new(response.body)
+      end
+    end
+  end
+end