vitable-connect 0.4.0 → 0.6.0

data/rbi/vitable_connect/models/member_retrieve_household_response.rbi

@@ -0,0 +1,251 @@
+# typed: strong
+
+module VitableConnect
+  module Models
+    class MemberRetrieveHouseholdResponse < VitableConnect::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            VitableConnect::Models::MemberRetrieveHouseholdResponse,
+            VitableConnect::Internal::AnyHash
+          )
+        end
+
+      sig do
+        returns(
+          T::Array[
+            VitableConnect::Models::MemberRetrieveHouseholdResponse::Data
+          ]
+        )
+      end
+      attr_accessor :data
+
+      # Unpaginated `{"data": [...]}` list of the members of a member's household.
+      sig do
+        params(
+          data:
+            T::Array[
+              VitableConnect::Models::MemberRetrieveHouseholdResponse::Data::OrHash
+            ]
+        ).returns(T.attached_class)
+      end
+      def self.new(data:)
+      end
+
+      sig do
+        override.returns(
+          {
+            data:
+              T::Array[
+                VitableConnect::Models::MemberRetrieveHouseholdResponse::Data
+              ]
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Data < VitableConnect::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              VitableConnect::Models::MemberRetrieveHouseholdResponse::Data,
+              VitableConnect::Internal::AnyHash
+            )
+          end
+
+        # Date of birth (YYYY-MM-DD)
+        sig { returns(Date) }
+        attr_accessor :date_of_birth
+
+        # Household member's first name
+        sig { returns(String) }
+        attr_accessor :first_name
+
+        # Whether this participant is a household admin (the account holder always is)
+        sig { returns(T::Boolean) }
+        attr_accessor :household_admin_in
+
+        # Household member's last name
+        sig { returns(String) }
+        attr_accessor :last_name
+
+        # - `Account Holder` - Account Holder
+        # - `Dependent` - Dependent
+        # - `Inactive` - Inactive
+        sig do
+          returns(
+            VitableConnect::Models::MemberRetrieveHouseholdResponse::Data::MemberType::TaggedSymbol
+          )
+        end
+        attr_accessor :member_type
+
+        # - `Child` - Child
+        # - `Spouse` - Spouse
+        # - `Roommate` - Roommate
+        # - `Other` - Other
+        sig do
+          returns(
+            T.nilable(
+              VitableConnect::Models::MemberRetrieveHouseholdResponse::Data::Relationship::TaggedSymbol
+            )
+          )
+        end
+        attr_accessor :relationship
+
+        # Member identifier with 'mbr\_' prefix
+        sig { returns(String) }
+        attr_accessor :member_id
+
+        # Wire serializer for :class:`HouseholdMemberDTO` (one household participant).
+        sig do
+          params(
+            date_of_birth: Date,
+            first_name: String,
+            household_admin_in: T::Boolean,
+            last_name: String,
+            member_id: String,
+            member_type:
+              VitableConnect::Models::MemberRetrieveHouseholdResponse::Data::MemberType::OrSymbol,
+            relationship:
+              T.nilable(
+                VitableConnect::Models::MemberRetrieveHouseholdResponse::Data::Relationship::OrSymbol
+              )
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Date of birth (YYYY-MM-DD)
+          date_of_birth:,
+          # Household member's first name
+          first_name:,
+          # Whether this participant is a household admin (the account holder always is)
+          household_admin_in:,
+          # Household member's last name
+          last_name:,
+          # Member identifier with 'mbr\_' prefix
+          member_id:,
+          # - `Account Holder` - Account Holder
+          # - `Dependent` - Dependent
+          # - `Inactive` - Inactive
+          member_type:,
+          # - `Child` - Child
+          # - `Spouse` - Spouse
+          # - `Roommate` - Roommate
+          # - `Other` - Other
+          relationship: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              date_of_birth: Date,
+              first_name: String,
+              household_admin_in: T::Boolean,
+              last_name: String,
+              member_id: String,
+              member_type:
+                VitableConnect::Models::MemberRetrieveHouseholdResponse::Data::MemberType::TaggedSymbol,
+              relationship:
+                T.nilable(
+                  VitableConnect::Models::MemberRetrieveHouseholdResponse::Data::Relationship::TaggedSymbol
+                )
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # - `Account Holder` - Account Holder
+        # - `Dependent` - Dependent
+        # - `Inactive` - Inactive
+        module MemberType
+          extend VitableConnect::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                VitableConnect::Models::MemberRetrieveHouseholdResponse::Data::MemberType
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          ACCOUNT_HOLDER =
+            T.let(
+              :"Account Holder",
+              VitableConnect::Models::MemberRetrieveHouseholdResponse::Data::MemberType::TaggedSymbol
+            )
+          DEPENDENT =
+            T.let(
+              :Dependent,
+              VitableConnect::Models::MemberRetrieveHouseholdResponse::Data::MemberType::TaggedSymbol
+            )
+          INACTIVE =
+            T.let(
+              :Inactive,
+              VitableConnect::Models::MemberRetrieveHouseholdResponse::Data::MemberType::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                VitableConnect::Models::MemberRetrieveHouseholdResponse::Data::MemberType::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        # - `Child` - Child
+        # - `Spouse` - Spouse
+        # - `Roommate` - Roommate
+        # - `Other` - Other
+        module Relationship
+          extend VitableConnect::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                VitableConnect::Models::MemberRetrieveHouseholdResponse::Data::Relationship
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          CHILD =
+            T.let(
+              :Child,
+              VitableConnect::Models::MemberRetrieveHouseholdResponse::Data::Relationship::TaggedSymbol
+            )
+          SPOUSE =
+            T.let(
+              :Spouse,
+              VitableConnect::Models::MemberRetrieveHouseholdResponse::Data::Relationship::TaggedSymbol
+            )
+          ROOMMATE =
+            T.let(
+              :Roommate,
+              VitableConnect::Models::MemberRetrieveHouseholdResponse::Data::Relationship::TaggedSymbol
+            )
+          OTHER =
+            T.let(
+              :Other,
+              VitableConnect::Models::MemberRetrieveHouseholdResponse::Data::Relationship::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                VitableConnect::Models::MemberRetrieveHouseholdResponse::Data::Relationship::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/vitable_connect/models/member_retrieve_params.rbi

@@ -0,0 +1,38 @@
+# typed: strong
+
+module VitableConnect
+  module Models
+    class MemberRetrieveParams < VitableConnect::Internal::Type::BaseModel
+      extend VitableConnect::Internal::Type::RequestParameters::Converter
+      include VitableConnect::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            VitableConnect::MemberRetrieveParams,
+            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

data/rbi/vitable_connect/models/member_retrieve_response.rbi

@@ -0,0 +1,312 @@
+# typed: strong
+
+module VitableConnect
+  module Models
+    class MemberRetrieveResponse < VitableConnect::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            VitableConnect::Models::MemberRetrieveResponse,
+            VitableConnect::Internal::AnyHash
+          )
+        end
+
+      # A member's profile: identity, contact details, address, demographics, and
+      # onboarding status.
+      sig { returns(VitableConnect::Models::MemberRetrieveResponse::Data) }
+      attr_reader :data
+
+      sig do
+        params(
+          data: VitableConnect::Models::MemberRetrieveResponse::Data::OrHash
+        ).void
+      end
+      attr_writer :data
+
+      # Response containing a single member resource.
+      sig do
+        params(
+          data: VitableConnect::Models::MemberRetrieveResponse::Data::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # A member's profile: identity, contact details, address, demographics, and
+        # onboarding status.
+        data:
+      )
+      end
+
+      sig do
+        override.returns(
+          { data: VitableConnect::Models::MemberRetrieveResponse::Data }
+        )
+      end
+      def to_hash
+      end
+
+      class Data < VitableConnect::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              VitableConnect::Models::MemberRetrieveResponse::Data,
+              VitableConnect::Internal::AnyHash
+            )
+          end
+
+        # Member's age in years, derived from date of birth
+        sig { returns(Integer) }
+        attr_accessor :age
+
+        # Date of birth (YYYY-MM-DD)
+        sig { returns(Date) }
+        attr_accessor :date_of_birth
+
+        # 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::MemberRetrieveResponse::Data::Address
+            )
+          )
+        end
+        attr_reader :address
+
+        sig do
+          params(
+            address:
+              T.nilable(
+                VitableConnect::Models::MemberRetrieveResponse::Data::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
+
+        # Member's preferred language code (e.g., en, es)
+        sig { returns(T.nilable(String)) }
+        attr_accessor :preferred_language
+
+        # Sex assigned at birth, if provided
+        sig { returns(T.nilable(String)) }
+        attr_accessor :sex_at_birth
+
+        # Whether the member uses tobacco, if known
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_accessor :tobacco_status
+
+        # Unique member identifier with 'mbr\_' prefix
+        sig { returns(String) }
+        attr_accessor :id
+
+        # Member's full name
+        sig { returns(String) }
+        attr_accessor :name
+
+        # Member profile status (onboarded or pending onboarding)
+        sig do
+          returns(
+            VitableConnect::Models::MemberRetrieveResponse::Data::Status::TaggedSymbol
+          )
+        end
+        attr_accessor :status
+
+        # A member's profile: identity, contact details, address, demographics, and
+        # onboarding status.
+        sig do
+          params(
+            id: String,
+            age: Integer,
+            date_of_birth: Date,
+            first_name: String,
+            last_name: String,
+            name: String,
+            status:
+              VitableConnect::Models::MemberRetrieveResponse::Data::Status::OrSymbol,
+            address:
+              T.nilable(
+                VitableConnect::Models::MemberRetrieveResponse::Data::Address::OrHash
+              ),
+            email: T.nilable(String),
+            phone: T.nilable(String),
+            preferred_language: T.nilable(String),
+            sex_at_birth: T.nilable(String),
+            tobacco_status: T.nilable(T::Boolean)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Unique member identifier with 'mbr\_' prefix
+          id:,
+          # Member's age in years, derived from date of birth
+          age:,
+          # Date of birth (YYYY-MM-DD)
+          date_of_birth:,
+          # Member's legal first name
+          first_name:,
+          # Member's legal last name
+          last_name:,
+          # Member's full name
+          name:,
+          # Member profile status (onboarded or pending onboarding)
+          status:,
+          # Member's residential address
+          address: nil,
+          # Email address
+          email: nil,
+          # Phone number (10-digit US domestic string)
+          phone: nil,
+          # Member's preferred language code (e.g., en, es)
+          preferred_language: nil,
+          # Sex assigned at birth, if provided
+          sex_at_birth: nil,
+          # Whether the member uses tobacco, if known
+          tobacco_status: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              age: Integer,
+              date_of_birth: Date,
+              first_name: String,
+              last_name: String,
+              name: String,
+              status:
+                VitableConnect::Models::MemberRetrieveResponse::Data::Status::TaggedSymbol,
+              address:
+                T.nilable(
+                  VitableConnect::Models::MemberRetrieveResponse::Data::Address
+                ),
+              email: T.nilable(String),
+              phone: T.nilable(String),
+              preferred_language: T.nilable(String),
+              sex_at_birth: T.nilable(String),
+              tobacco_status: T.nilable(T::Boolean)
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Member profile status (onboarded or pending onboarding)
+        module Status
+          extend VitableConnect::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                VitableConnect::Models::MemberRetrieveResponse::Data::Status
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          ONBOARDED =
+            T.let(
+              :onboarded,
+              VitableConnect::Models::MemberRetrieveResponse::Data::Status::TaggedSymbol
+            )
+          PENDING_ONBOARDING =
+            T.let(
+              :pending_onboarding,
+              VitableConnect::Models::MemberRetrieveResponse::Data::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                VitableConnect::Models::MemberRetrieveResponse::Data::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        class Address < VitableConnect::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                VitableConnect::Models::MemberRetrieveResponse::Data::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
+end