vitable-connect 0.5.0 → 0.6.0

data/rbi/vitable_connect/models/member_list_qualifying_life_events_params.rbi

@@ -0,0 +1,130 @@
+# typed: strong
+
+module VitableConnect
+  module Models
+    class MemberListQualifyingLifeEventsParams < VitableConnect::Internal::Type::BaseModel
+      extend VitableConnect::Internal::Type::RequestParameters::Converter
+      include VitableConnect::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            VitableConnect::MemberListQualifyingLifeEventsParams,
+            VitableConnect::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :member_id
+
+      # Items per page (default: 20, max: 100)
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :limit
+
+      sig { params(limit: Integer).void }
+      attr_writer :limit
+
+      # Page number (default: 1)
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :page
+
+      sig { params(page: Integer).void }
+      attr_writer :page
+
+      # Optional. Filter to a single QLE status; omit to return all statuses.
+      sig do
+        returns(
+          T.nilable(
+            VitableConnect::MemberListQualifyingLifeEventsParams::Status::OrSymbol
+          )
+        )
+      end
+      attr_reader :status
+
+      sig do
+        params(
+          status:
+            VitableConnect::MemberListQualifyingLifeEventsParams::Status::OrSymbol
+        ).void
+      end
+      attr_writer :status
+
+      sig do
+        params(
+          member_id: String,
+          limit: Integer,
+          page: Integer,
+          status:
+            VitableConnect::MemberListQualifyingLifeEventsParams::Status::OrSymbol,
+          request_options: VitableConnect::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        member_id:,
+        # Items per page (default: 20, max: 100)
+        limit: nil,
+        # Page number (default: 1)
+        page: nil,
+        # Optional. Filter to a single QLE status; omit to return all statuses.
+        status: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            member_id: String,
+            limit: Integer,
+            page: Integer,
+            status:
+              VitableConnect::MemberListQualifyingLifeEventsParams::Status::OrSymbol,
+            request_options: VitableConnect::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Optional. Filter to a single QLE status; omit to return all statuses.
+      module Status
+        extend VitableConnect::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              VitableConnect::MemberListQualifyingLifeEventsParams::Status
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        APPROVED =
+          T.let(
+            :approved,
+            VitableConnect::MemberListQualifyingLifeEventsParams::Status::TaggedSymbol
+          )
+        DENIED =
+          T.let(
+            :denied,
+            VitableConnect::MemberListQualifyingLifeEventsParams::Status::TaggedSymbol
+          )
+        PENDING =
+          T.let(
+            :pending,
+            VitableConnect::MemberListQualifyingLifeEventsParams::Status::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              VitableConnect::MemberListQualifyingLifeEventsParams::Status::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/vitable_connect/models/member_list_qualifying_life_events_response.rbi

@@ -0,0 +1,192 @@
+# typed: strong
+
+module VitableConnect
+  module Models
+    class MemberListQualifyingLifeEventsResponse < VitableConnect::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            VitableConnect::Models::MemberListQualifyingLifeEventsResponse,
+            VitableConnect::Internal::AnyHash
+          )
+        end
+
+      # Opaque qualifying life event identifier
+      sig { returns(String) }
+      attr_accessor :id
+
+      # - `Married` - Married
+      # - `Divorced` - Divorced
+      # - `New child` - New Child
+      # - `Court ordered` - Court Ordered
+      # - `Other` - Other
+      sig do
+        returns(
+          VitableConnect::Models::MemberListQualifyingLifeEventsResponse::EventType::TaggedSymbol
+        )
+      end
+      attr_accessor :event_type
+
+      # Custom event description when event_type is Other; otherwise normally null
+      sig { returns(T.nilable(String)) }
+      attr_accessor :other_event
+
+      # - `pending` - Pending
+      # - `approved` - Approved
+      # - `denied` - Denied
+      sig do
+        returns(
+          VitableConnect::Models::MemberListQualifyingLifeEventsResponse::Status::TaggedSymbol
+        )
+      end
+      attr_accessor :status
+
+      # When the member submitted the event
+      sig { returns(Time) }
+      attr_accessor :submitted_at
+
+      sig do
+        params(
+          id: String,
+          event_type:
+            VitableConnect::Models::MemberListQualifyingLifeEventsResponse::EventType::OrSymbol,
+          other_event: T.nilable(String),
+          status:
+            VitableConnect::Models::MemberListQualifyingLifeEventsResponse::Status::OrSymbol,
+          submitted_at: Time
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Opaque qualifying life event identifier
+        id:,
+        # - `Married` - Married
+        # - `Divorced` - Divorced
+        # - `New child` - New Child
+        # - `Court ordered` - Court Ordered
+        # - `Other` - Other
+        event_type:,
+        # Custom event description when event_type is Other; otherwise normally null
+        other_event:,
+        # - `pending` - Pending
+        # - `approved` - Approved
+        # - `denied` - Denied
+        status:,
+        # When the member submitted the event
+        submitted_at:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            event_type:
+              VitableConnect::Models::MemberListQualifyingLifeEventsResponse::EventType::TaggedSymbol,
+            other_event: T.nilable(String),
+            status:
+              VitableConnect::Models::MemberListQualifyingLifeEventsResponse::Status::TaggedSymbol,
+            submitted_at: Time
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # - `Married` - Married
+      # - `Divorced` - Divorced
+      # - `New child` - New Child
+      # - `Court ordered` - Court Ordered
+      # - `Other` - Other
+      module EventType
+        extend VitableConnect::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              VitableConnect::Models::MemberListQualifyingLifeEventsResponse::EventType
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        MARRIED =
+          T.let(
+            :Married,
+            VitableConnect::Models::MemberListQualifyingLifeEventsResponse::EventType::TaggedSymbol
+          )
+        DIVORCED =
+          T.let(
+            :Divorced,
+            VitableConnect::Models::MemberListQualifyingLifeEventsResponse::EventType::TaggedSymbol
+          )
+        NEW_CHILD =
+          T.let(
+            :"New child",
+            VitableConnect::Models::MemberListQualifyingLifeEventsResponse::EventType::TaggedSymbol
+          )
+        COURT_ORDERED =
+          T.let(
+            :"Court ordered",
+            VitableConnect::Models::MemberListQualifyingLifeEventsResponse::EventType::TaggedSymbol
+          )
+        OTHER =
+          T.let(
+            :Other,
+            VitableConnect::Models::MemberListQualifyingLifeEventsResponse::EventType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              VitableConnect::Models::MemberListQualifyingLifeEventsResponse::EventType::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # - `pending` - Pending
+      # - `approved` - Approved
+      # - `denied` - Denied
+      module Status
+        extend VitableConnect::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              VitableConnect::Models::MemberListQualifyingLifeEventsResponse::Status
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        PENDING =
+          T.let(
+            :pending,
+            VitableConnect::Models::MemberListQualifyingLifeEventsResponse::Status::TaggedSymbol
+          )
+        APPROVED =
+          T.let(
+            :approved,
+            VitableConnect::Models::MemberListQualifyingLifeEventsResponse::Status::TaggedSymbol
+          )
+        DENIED =
+          T.let(
+            :denied,
+            VitableConnect::Models::MemberListQualifyingLifeEventsResponse::Status::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              VitableConnect::Models::MemberListQualifyingLifeEventsResponse::Status::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/vitable_connect/models/member_list_response.rbi

@@ -0,0 +1,166 @@
+# typed: strong
+
+module VitableConnect
+  module Models
+    class MemberListResponse < VitableConnect::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            VitableConnect::Models::MemberListResponse,
+            VitableConnect::Internal::AnyHash
+          )
+        end
+
+      # Member's legal first name
+      sig { returns(String) }
+      attr_accessor :first_name
+
+      # Member's legal last name
+      sig { returns(String) }
+      attr_accessor :last_name
+
+      # Member's residential address
+      sig do
+        returns(T.nilable(VitableConnect::Models::MemberListResponse::Address))
+      end
+      attr_reader :address
+
+      sig do
+        params(
+          address:
+            T.nilable(
+              VitableConnect::Models::MemberListResponse::Address::OrHash
+            )
+        ).void
+      end
+      attr_writer :address
+
+      # Email address
+      sig { returns(T.nilable(String)) }
+      attr_accessor :email
+
+      # Phone number (10-digit US domestic string)
+      sig { returns(T.nilable(String)) }
+      attr_accessor :phone
+
+      # Unique member identifier with 'mbr\_' prefix
+      sig { returns(String) }
+      attr_accessor :id
+
+      # A member in the organization's directory: identity, contact details, address,
+      # and join date.
+      sig do
+        params(
+          id: String,
+          first_name: String,
+          last_name: String,
+          address:
+            T.nilable(
+              VitableConnect::Models::MemberListResponse::Address::OrHash
+            ),
+          email: T.nilable(String),
+          phone: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Unique member identifier with 'mbr\_' prefix
+        id:,
+        # Member's legal first name
+        first_name:,
+        # Member's legal last name
+        last_name:,
+        # Member's residential address
+        address: nil,
+        # Email address
+        email: nil,
+        # Phone number (10-digit US domestic string)
+        phone: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            first_name: String,
+            last_name: String,
+            address:
+              T.nilable(VitableConnect::Models::MemberListResponse::Address),
+            email: T.nilable(String),
+            phone: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Address < VitableConnect::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              VitableConnect::Models::MemberListResponse::Address,
+              VitableConnect::Internal::AnyHash
+            )
+          end
+
+        # Primary street address
+        sig { returns(String) }
+        attr_accessor :address_line_1
+
+        # City name
+        sig { returns(String) }
+        attr_accessor :city
+
+        # Two-letter state code (e.g., CA, NY)
+        sig { returns(String) }
+        attr_accessor :state
+
+        # ZIP code (5 or 9 digit)
+        sig { returns(String) }
+        attr_accessor :zipcode
+
+        # Secondary street address (apt, suite, etc.)
+        sig { returns(T.nilable(String)) }
+        attr_accessor :address_line_2
+
+        # Member's residential address
+        sig do
+          params(
+            address_line_1: String,
+            city: String,
+            state: String,
+            zipcode: String,
+            address_line_2: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Primary street address
+          address_line_1:,
+          # City name
+          city:,
+          # Two-letter state code (e.g., CA, NY)
+          state:,
+          # ZIP code (5 or 9 digit)
+          zipcode:,
+          # Secondary street address (apt, suite, etc.)
+          address_line_2: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              address_line_1: String,
+              city: String,
+              state: String,
+              zipcode: String,
+              address_line_2: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/vitable_connect/models/member_retrieve_household_params.rbi

@@ -0,0 +1,38 @@
+# typed: strong
+
+module VitableConnect
+  module Models
+    class MemberRetrieveHouseholdParams < VitableConnect::Internal::Type::BaseModel
+      extend VitableConnect::Internal::Type::RequestParameters::Converter
+      include VitableConnect::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            VitableConnect::MemberRetrieveHouseholdParams,
+            VitableConnect::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :member_id
+
+      sig do
+        params(
+          member_id: String,
+          request_options: VitableConnect::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(member_id:, request_options: {})
+      end
+
+      sig do
+        override.returns(
+          { member_id: String, request_options: VitableConnect::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end