campus_ivy 0.1.1 → 1.0.0

data/lib/campus_ivy/resources/document_status.rb

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

data/lib/campus_ivy/resources/functional_area_task.rb

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

data/lib/campus_ivy/resources/health.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module CampusIvy
+  module Resources
+    class Health
+      extend T::Sig
+
+      sig { params(client: CampusIvy::Client).void }
+      def initialize(client)
+        @client = client
+      end
+
+      sig { returns(CampusIvy::Object) }
+      def check
+        response = @client.connection.get('health/check')
+        CampusIvy::Object.new(response.body)
+      end
+
+      sig { returns(String) }
+      def ping
+        # Ping returns plain string "Pong"
+        response = @client.connection.get('health/ping')
+        response.body.to_s
+      end
+    end
+  end
+end

data/lib/campus_ivy/resources/institution_breaks_by_shift.rb

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

data/lib/campus_ivy/resources/net_price_calculator.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module CampusIvy
+  module Resources
+    class NetPriceCalculator
+      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),
+          institution_student_npc_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,
+        institution_student_npc_id_list: nil,
+        start_date: nil,
+        end_date: nil
+      )
+        params = {
+          'request.institutionStudentId' => institution_student_id,
+          'request.studentIdList' => student_id_list,
+          'request.institutionStudentNPCIdList' => institution_student_npc_id_list,
+          'request.startDate' => start_date,
+          'request.endDate' => end_date
+        }.compact
+
+        response = @client.connection.get('NetPriceCalculator', params)
+        CampusIvy::Object.new(response.body)
+      end
+    end
+  end
+end

data/lib/campus_ivy/resources/note_type.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module CampusIvy
+  module Resources
+    class NoteType
+      extend T::Sig
+
+      sig { params(client: CampusIvy::Client).void }
+      def initialize(client)
+        @client = client
+      end
+
+      sig { returns(CampusIvy::Object) }
+      def list
+        response = @client.connection.get('NoteType')
+        CampusIvy::Object.new(response.body)
+      end
+    end
+  end
+end

data/lib/campus_ivy/resources/packaging.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module CampusIvy
+  module Resources
+    class Packaging
+      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('Packaging', params)
+        CampusIvy::Object.new(response.body)
+      end
+
+      sig do
+        params(
+          students: T::Array[T::Hash[Symbol, T.untyped]],
+          file_source: T.nilable(String),
+          return_errors_only: T.nilable(T::Boolean),
+          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:,
+        file_source: nil,
+        return_errors_only: nil,
+        validate_records: nil,
+        process_records: nil,
+        return_result: nil,
+        batch_size: nil,
+        response_type: nil
+      )
+        query_params = {
+          fileSource: file_source,
+          returnErrorsOnly: return_errors_only,
+          validateRecords: validate_records,
+          processRecords: process_records,
+          returnResult: return_result,
+          batchSize: batch_size,
+          responseType: response_type
+        }.compact
+
+        response = @client.connection.post('Packaging') do |req|
+          req.params = query_params
+          req.body = students
+        end
+
+        CampusIvy::Object.new(response.body)
+      end
+    end
+  end
+end

data/lib/campus_ivy/resources/pay_list_analysis.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module CampusIvy
+  module Resources
+    class PayListAnalysis
+      extend T::Sig
+
+      sig { params(client: CampusIvy::Client).void }
+      def initialize(client)
+        @client = client
+      end
+
+      sig do
+        params(
+          award_year_id_list: T.nilable(String),
+          fund_type_id_list: T.nilable(String),
+          institution_fund_type_id_list: T.nilable(String),
+          transaction_type_id_list: T.nilable(String),
+          institution_entity_id_list: T.nilable(String),
+          institution_entity_location_id_list: T.nilable(String),
+          institution_enrollment_status_id_list: T.nilable(String),
+          student_id_list: T.nilable(String),
+          start_date: T.nilable(String),
+          end_date: T.nilable(String)
+        ).returns(CampusIvy::Object)
+      end
+      def list(
+        award_year_id_list: nil,
+        fund_type_id_list: nil,
+        institution_fund_type_id_list: nil,
+        transaction_type_id_list: nil,
+        institution_entity_id_list: nil,
+        institution_entity_location_id_list: nil,
+        institution_enrollment_status_id_list: nil,
+        student_id_list: nil,
+        start_date: nil,
+        end_date: nil
+      )
+        params = {
+          'request.awardYearIdList' => award_year_id_list,
+          'request.fundTypeIdList' => fund_type_id_list,
+          'request.institutionFundTypeIdList' => institution_fund_type_id_list,
+          'request.transactionTypeIdList' => transaction_type_id_list,
+          'request.institutionEntityIdList' => institution_entity_id_list,
+          'request.institutionEntityLocationIdList' => institution_entity_location_id_list,
+          'request.institutionEnrollmentStatusIdList' => institution_enrollment_status_id_list,
+          'request.studentIdList' => student_id_list,
+          'request.startDate' => start_date,
+          'request.endDate' => end_date
+        }.compact
+
+        response = @client.connection.get('PayListAnalysis', params)
+        CampusIvy::Object.new(response.body)
+      end
+    end
+  end
+end

data/lib/campus_ivy/resources/registered_student.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module CampusIvy
+  module Resources
+    class RegisteredStudent
+      extend T::Sig
+
+      sig { params(client: CampusIvy::Client).void }
+      def initialize(client)
+        @client = client
+      end
+
+      sig do
+        params(
+          student_id: String,
+          registered_student_id: T.nilable(String),
+          email_address: T.nilable(String),
+          first_name: T.nilable(String),
+          last_name: T.nilable(String),
+          mobile_phone_number: T.nilable(String),
+          dob: T.nilable(String),
+          address1: T.nilable(String),
+          address2: T.nilable(String),
+          city: T.nilable(String),
+          state: T.nilable(String),
+          zip: T.nilable(String),
+          country: T.nilable(String)
+        ).returns(CampusIvy::Object)
+      end
+      def create(
+        student_id:,
+        registered_student_id: nil,
+        email_address: nil,
+        first_name: nil,
+        last_name: nil,
+        mobile_phone_number: nil,
+        dob: nil,
+        address1: nil,
+        address2: nil,
+        city: nil,
+        state: nil,
+        zip: nil,
+        country: nil
+      )
+        payload = {
+          StudentId: student_id,
+          RegisteredStudentId: registered_student_id,
+          EmailAddress: email_address,
+          FirstName: first_name,
+          LastName: last_name,
+          MobilePhoneNumber: mobile_phone_number,
+          DOB: dob,
+          Address1: address1,
+          Address2: address2,
+          City: city,
+          State: state,
+          Zip: zip,
+          Country: country
+        }.compact
+
+        response = @client.connection.post('RegisteredStudent') do |req|
+          req.body = payload
+        end
+        CampusIvy::Object.new(response.body)
+      end
+
+      sig do
+        params(
+          student_id: T.nilable(String),
+          email_address: T.nilable(String)
+        ).returns(CampusIvy::Object)
+      end
+      def list(student_id: nil, email_address: nil)
+        params = {
+          'request.studentId' => student_id,
+          'request.emailAddress' => email_address
+        }.compact
+
+        response = @client.connection.get('RegisteredStudent', params)
+        CampusIvy::Object.new(response.body)
+      end
+    end
+  end
+end

data/lib/campus_ivy/resources/service_type.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module CampusIvy
+  module Resources
+    class ServiceType
+      extend T::Sig
+
+      sig { params(client: CampusIvy::Client).void }
+      def initialize(client)
+        @client = client
+      end
+
+      sig { returns(CampusIvy::Object) }
+      def list
+        response = @client.connection.get('serviceType')
+        CampusIvy::Object.new(response.body)
+      end
+    end
+  end
+end

data/lib/campus_ivy/resources/student_award_transmission_log.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module CampusIvy
+  module Resources
+    class StudentAwardTransmissionLog
+      extend T::Sig
+
+      sig { params(client: CampusIvy::Client).void }
+      def initialize(client)
+        @client = client
+      end
+
+      sig do
+        params(
+          batch_sync_id: T.nilable(Integer),
+          integration_system: T.nilable(String),
+          is_current: T.nilable(T::Boolean),
+          integration_award_posted_status: T.nilable(String),
+          student_id: T.nilable(String),
+          message_wild_card: T.nilable(String),
+          institution_student_award_id: T.nilable(Integer),
+          institution_student_id: T.nilable(Integer),
+          institution_disbursement_batch_header_id_list: T.nilable(String),
+          is_status_update: T.nilable(T::Boolean),
+          is_academic_year_update: T.nilable(T::Boolean),
+          batch_date: T.nilable(String),
+          start_date: T.nilable(String),
+          end_date: T.nilable(String)
+        ).returns(CampusIvy::Object)
+      end
+      def list(
+        batch_sync_id: nil,
+        integration_system: nil,
+        is_current: nil,
+        integration_award_posted_status: nil,
+        student_id: nil,
+        message_wild_card: nil,
+        institution_student_award_id: nil,
+        institution_student_id: nil,
+        institution_disbursement_batch_header_id_list: nil,
+        is_status_update: nil,
+        is_academic_year_update: nil,
+        batch_date: nil,
+        start_date: nil,
+        end_date: nil
+      )
+        params = {
+          'request.batchSyncId' => batch_sync_id,
+          'request.integrationSystem' => integration_system,
+          'request.isCurrent' => is_current,
+          'request.integrationAwardPostedStatus' => integration_award_posted_status,
+          'request.studentId' => student_id,
+          'request.messageWildCard' => message_wild_card,
+          'request.institutionStudentAwardId' => institution_student_award_id,
+          'request.institutionStudentId' => institution_student_id,
+          'request.institutionDisbursementBatchHeaderIdList' => institution_disbursement_batch_header_id_list,
+          'request.isStatusUpdate' => is_status_update,
+          'request.isAcademicYearUpdate' => is_academic_year_update,
+          'request.batchDate' => batch_date,
+          'request.startDate' => start_date,
+          'request.endDate' => end_date
+        }.compact
+
+        response = @client.connection.get('StudentAwardTransmissionLog', params)
+        CampusIvy::Object.new(response.body)
+      end
+    end
+  end
+end

data/lib/campus_ivy/resources/student_awards.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module CampusIvy
+  module Resources
+    class StudentAwards
+      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('StudentAwards', params)
+        CampusIvy::Object.new(response.body)
+      end
+
+      sig { params(award_year_id: Integer).returns(CampusIvy::Object) }
+      def get_pell_grant_min_max(award_year_id:)
+        response = @client.connection.get("StudentAwards/GetPellGrantMinMax/#{award_year_id}")
+        CampusIvy::Object.new(response.body)
+      end
+    end
+  end
+end

data/lib/campus_ivy/resources/student_disbursement_transmission_log.rb

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