wefunder 0.1.0.beta1

data/lib/wefunder_generated/models/syndicate_member_attributes.rb

@@ -0,0 +1,650 @@
+=begin
+#Wefunder API v2
+
+#OAuth 2.0 API for accessing Wefunder data programmatically.  ## Authentication  This API uses OAuth 2.0 for authentication. To get started:  1. Create an OAuth application at `/oauth/applications` 2. Get your Client ID and Client Secret 3. Implement the OAuth 2.0 Authorization Code flow 4. Use the access token to make API requests  ## Versioning  The API is versioned by the dated `Wefunder-Version` request header (`YYYY-MM-DD`), never by the URL. Resolution is header → your application's pinned version → latest; every response carries `Wefunder-Version` (the version that handled it) and `Wefunder-Version-Latest`. An unknown value returns `400 invalid_request` naming the valid versions. Current: `2026-10-01`.  ## Rate Limits  - Standard API: 1,000 requests/hour per token - Admin API: 10,000 requests/hour per token  ## Base URL  All API requests should be made to: `https://api.wefunder.com` (no version in the path). 
+
+The version of the OpenAPI document: 2.0
+Contact: api@wefunder.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.10.0
+
+=end
+
+require 'date'
+require 'time'
+
+module WefunderGenerated
+  class SyndicateMemberAttributes
+    # Internal integer id. Deprecated — use `user` (`usr_...`) instead.
+    attr_accessor :user_id
+
+    # The member's user id (`usr_...`); null for invitees who haven't signed up.
+    attr_accessor :user
+
+    attr_accessor :user_name
+
+    # **Moderator-only.** User email (or invite_email for pending invitees). Requires the requesting user to be a manager/operator of the syndicate. 
+    attr_accessor :user_email
+
+    # Current role (creator, manager, member, invitee, applicant, exiled, resigned, etc.)
+    attr_accessor :role
+
+    # The role the member was invited as
+    attr_accessor :invite_role
+
+    # Permission level within the syndicate
+    attr_accessor :syndicate_permission
+
+    # Custom title for the member
+    attr_accessor :title
+
+    # Display order position
+    attr_accessor :sort_order
+
+    # Override carry percentage for this member
+    attr_accessor :carry_percentage_override
+
+    # Carry discount granted to this member, in percent.
+    attr_accessor :carry_discount_percentage
+
+    # Management fee discount granted to this member, in percent.
+    attr_accessor :management_fee_discount_percentage
+
+    # Whether the member is listed on the public syndicate page.
+    attr_accessor :public_on_syndicate_profile
+
+    # Investor interest tags from the user's profile. Empty for invitees.
+    attr_accessor :interests
+
+    # Investment stage preference tags. Empty for invitees.
+    attr_accessor :stage_preferences
+
+    # 'Looking for' tags from the user's profile. Empty for invitees.
+    attr_accessor :looking_for
+
+    attr_accessor :linkedin_url
+
+    attr_accessor :twitter_url
+
+    attr_accessor :website
+
+    # User's state or region. Omitted, with city and country, when the user hides their location.
+    attr_accessor :state
+
+    # User profile photo URL (null for invitees without a user account)
+    attr_accessor :avatar_url
+
+    # User bio with fallback chain (bio -> thesis -> about). Null for invitees without a user account.
+    attr_accessor :bio
+
+    # User's city
+    attr_accessor :city
+
+    # User's country
+    attr_accessor :country
+
+    # ISO 8601 timestamp of user's last login. Null for invitees without a user account.
+    attr_accessor :last_activity_at
+
+    # Relative path to user's profile (e.g. '/janedoe'). Null for invitees without a user account.
+    attr_accessor :profile_url
+
+    # 'Can help with' tags from the user's investor profile. Empty array for invitees.
+    attr_accessor :tags
+
+    # ISO 8601 join date (alias for created_at)
+    attr_accessor :joined_at
+
+    # **Moderator-only.** Total invested in syndicate deals, in whole dollars, as a string.
+    attr_accessor :investment_total
+
+    # Number of syndicate deals the member has invested in
+    attr_accessor :deal_count
+
+    # **Moderator-only.** Whether the user is an accredited investor. Only included when the requesting user is a manager/operator. 
+    attr_accessor :accredited
+
+    # **Moderator-only.** Full legal name of the user. Only included when the requesting user is a manager/operator. 
+    attr_accessor :legal_name
+
+    # **Moderator-only.** Whether the current moderator has starred this member. Only included when the requesting user is a manager/operator. 
+    attr_accessor :starred
+
+    # **Moderator-only.** Labels assigned by moderators via ClubMemberLabel. Only included when the requesting user is a manager/operator. 
+    attr_accessor :private_tags
+
+    attr_accessor :created_at
+
+    attr_accessor :updated_at
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'user_id' => :'user_id',
+        :'user' => :'user',
+        :'user_name' => :'user_name',
+        :'user_email' => :'user_email',
+        :'role' => :'role',
+        :'invite_role' => :'invite_role',
+        :'syndicate_permission' => :'syndicate_permission',
+        :'title' => :'title',
+        :'sort_order' => :'sort_order',
+        :'carry_percentage_override' => :'carry_percentage_override',
+        :'carry_discount_percentage' => :'carry_discount_percentage',
+        :'management_fee_discount_percentage' => :'management_fee_discount_percentage',
+        :'public_on_syndicate_profile' => :'public_on_syndicate_profile',
+        :'interests' => :'interests',
+        :'stage_preferences' => :'stage_preferences',
+        :'looking_for' => :'looking_for',
+        :'linkedin_url' => :'linkedin_url',
+        :'twitter_url' => :'twitter_url',
+        :'website' => :'website',
+        :'state' => :'state',
+        :'avatar_url' => :'avatar_url',
+        :'bio' => :'bio',
+        :'city' => :'city',
+        :'country' => :'country',
+        :'last_activity_at' => :'last_activity_at',
+        :'profile_url' => :'profile_url',
+        :'tags' => :'tags',
+        :'joined_at' => :'joined_at',
+        :'investment_total' => :'investment_total',
+        :'deal_count' => :'deal_count',
+        :'accredited' => :'accredited',
+        :'legal_name' => :'legal_name',
+        :'starred' => :'starred',
+        :'private_tags' => :'private_tags',
+        :'created_at' => :'created_at',
+        :'updated_at' => :'updated_at'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'user_id' => :'Integer',
+        :'user' => :'String',
+        :'user_name' => :'String',
+        :'user_email' => :'String',
+        :'role' => :'String',
+        :'invite_role' => :'String',
+        :'syndicate_permission' => :'String',
+        :'title' => :'String',
+        :'sort_order' => :'Integer',
+        :'carry_percentage_override' => :'Integer',
+        :'carry_discount_percentage' => :'Float',
+        :'management_fee_discount_percentage' => :'Float',
+        :'public_on_syndicate_profile' => :'Boolean',
+        :'interests' => :'Array<String>',
+        :'stage_preferences' => :'Array<String>',
+        :'looking_for' => :'Array<String>',
+        :'linkedin_url' => :'String',
+        :'twitter_url' => :'String',
+        :'website' => :'String',
+        :'state' => :'String',
+        :'avatar_url' => :'String',
+        :'bio' => :'String',
+        :'city' => :'String',
+        :'country' => :'String',
+        :'last_activity_at' => :'Time',
+        :'profile_url' => :'String',
+        :'tags' => :'Array<String>',
+        :'joined_at' => :'Time',
+        :'investment_total' => :'String',
+        :'deal_count' => :'Integer',
+        :'accredited' => :'Boolean',
+        :'legal_name' => :'String',
+        :'starred' => :'Boolean',
+        :'private_tags' => :'Array<String>',
+        :'created_at' => :'Time',
+        :'updated_at' => :'Time'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'user_id',
+        :'user',
+        :'user_name',
+        :'user_email',
+        :'invite_role',
+        :'title',
+        :'sort_order',
+        :'carry_percentage_override',
+        :'carry_discount_percentage',
+        :'management_fee_discount_percentage',
+        :'linkedin_url',
+        :'twitter_url',
+        :'website',
+        :'state',
+        :'avatar_url',
+        :'bio',
+        :'city',
+        :'country',
+        :'last_activity_at',
+        :'profile_url',
+        :'investment_total',
+        :'deal_count',
+        :'legal_name',
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `WefunderGenerated::SyndicateMemberAttributes` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `WefunderGenerated::SyndicateMemberAttributes`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'user_id')
+        self.user_id = attributes[:'user_id']
+      end
+
+      if attributes.key?(:'user')
+        self.user = attributes[:'user']
+      end
+
+      if attributes.key?(:'user_name')
+        self.user_name = attributes[:'user_name']
+      end
+
+      if attributes.key?(:'user_email')
+        self.user_email = attributes[:'user_email']
+      end
+
+      if attributes.key?(:'role')
+        self.role = attributes[:'role']
+      end
+
+      if attributes.key?(:'invite_role')
+        self.invite_role = attributes[:'invite_role']
+      end
+
+      if attributes.key?(:'syndicate_permission')
+        self.syndicate_permission = attributes[:'syndicate_permission']
+      end
+
+      if attributes.key?(:'title')
+        self.title = attributes[:'title']
+      end
+
+      if attributes.key?(:'sort_order')
+        self.sort_order = attributes[:'sort_order']
+      end
+
+      if attributes.key?(:'carry_percentage_override')
+        self.carry_percentage_override = attributes[:'carry_percentage_override']
+      end
+
+      if attributes.key?(:'carry_discount_percentage')
+        self.carry_discount_percentage = attributes[:'carry_discount_percentage']
+      end
+
+      if attributes.key?(:'management_fee_discount_percentage')
+        self.management_fee_discount_percentage = attributes[:'management_fee_discount_percentage']
+      end
+
+      if attributes.key?(:'public_on_syndicate_profile')
+        self.public_on_syndicate_profile = attributes[:'public_on_syndicate_profile']
+      end
+
+      if attributes.key?(:'interests')
+        if (value = attributes[:'interests']).is_a?(Array)
+          self.interests = value
+        end
+      end
+
+      if attributes.key?(:'stage_preferences')
+        if (value = attributes[:'stage_preferences']).is_a?(Array)
+          self.stage_preferences = value
+        end
+      end
+
+      if attributes.key?(:'looking_for')
+        if (value = attributes[:'looking_for']).is_a?(Array)
+          self.looking_for = value
+        end
+      end
+
+      if attributes.key?(:'linkedin_url')
+        self.linkedin_url = attributes[:'linkedin_url']
+      end
+
+      if attributes.key?(:'twitter_url')
+        self.twitter_url = attributes[:'twitter_url']
+      end
+
+      if attributes.key?(:'website')
+        self.website = attributes[:'website']
+      end
+
+      if attributes.key?(:'state')
+        self.state = attributes[:'state']
+      end
+
+      if attributes.key?(:'avatar_url')
+        self.avatar_url = attributes[:'avatar_url']
+      end
+
+      if attributes.key?(:'bio')
+        self.bio = attributes[:'bio']
+      end
+
+      if attributes.key?(:'city')
+        self.city = attributes[:'city']
+      end
+
+      if attributes.key?(:'country')
+        self.country = attributes[:'country']
+      end
+
+      if attributes.key?(:'last_activity_at')
+        self.last_activity_at = attributes[:'last_activity_at']
+      end
+
+      if attributes.key?(:'profile_url')
+        self.profile_url = attributes[:'profile_url']
+      end
+
+      if attributes.key?(:'tags')
+        if (value = attributes[:'tags']).is_a?(Array)
+          self.tags = value
+        end
+      end
+
+      if attributes.key?(:'joined_at')
+        self.joined_at = attributes[:'joined_at']
+      end
+
+      if attributes.key?(:'investment_total')
+        self.investment_total = attributes[:'investment_total']
+      end
+
+      if attributes.key?(:'deal_count')
+        self.deal_count = attributes[:'deal_count']
+      end
+
+      if attributes.key?(:'accredited')
+        self.accredited = attributes[:'accredited']
+      end
+
+      if attributes.key?(:'legal_name')
+        self.legal_name = attributes[:'legal_name']
+      end
+
+      if attributes.key?(:'starred')
+        self.starred = attributes[:'starred']
+      end
+
+      if attributes.key?(:'private_tags')
+        if (value = attributes[:'private_tags']).is_a?(Array)
+          self.private_tags = value
+        end
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      end
+
+      if attributes.key?(:'updated_at')
+        self.updated_at = attributes[:'updated_at']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if !@carry_percentage_override.nil? && @carry_percentage_override > 100
+        invalid_properties.push('invalid value for "carry_percentage_override", must be smaller than or equal to 100.')
+      end
+
+      if !@carry_percentage_override.nil? && @carry_percentage_override < 1
+        invalid_properties.push('invalid value for "carry_percentage_override", must be greater than or equal to 1.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      syndicate_permission_validator = EnumAttributeValidator.new('String', ["full_access", "operator"])
+      return false unless syndicate_permission_validator.valid?(@syndicate_permission)
+      return false if !@carry_percentage_override.nil? && @carry_percentage_override > 100
+      return false if !@carry_percentage_override.nil? && @carry_percentage_override < 1
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] syndicate_permission Object to be assigned
+    def syndicate_permission=(syndicate_permission)
+      validator = EnumAttributeValidator.new('String', ["full_access", "operator"])
+      unless validator.valid?(syndicate_permission)
+        fail ArgumentError, "invalid value for \"syndicate_permission\", must be one of #{validator.allowable_values}."
+      end
+      @syndicate_permission = syndicate_permission
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] carry_percentage_override Value to be assigned
+    def carry_percentage_override=(carry_percentage_override)
+      if !carry_percentage_override.nil? && carry_percentage_override > 100
+        fail ArgumentError, 'invalid value for "carry_percentage_override", must be smaller than or equal to 100.'
+      end
+
+      if !carry_percentage_override.nil? && carry_percentage_override < 1
+        fail ArgumentError, 'invalid value for "carry_percentage_override", must be greater than or equal to 1.'
+      end
+
+      @carry_percentage_override = carry_percentage_override
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          user_id == o.user_id &&
+          user == o.user &&
+          user_name == o.user_name &&
+          user_email == o.user_email &&
+          role == o.role &&
+          invite_role == o.invite_role &&
+          syndicate_permission == o.syndicate_permission &&
+          title == o.title &&
+          sort_order == o.sort_order &&
+          carry_percentage_override == o.carry_percentage_override &&
+          carry_discount_percentage == o.carry_discount_percentage &&
+          management_fee_discount_percentage == o.management_fee_discount_percentage &&
+          public_on_syndicate_profile == o.public_on_syndicate_profile &&
+          interests == o.interests &&
+          stage_preferences == o.stage_preferences &&
+          looking_for == o.looking_for &&
+          linkedin_url == o.linkedin_url &&
+          twitter_url == o.twitter_url &&
+          website == o.website &&
+          state == o.state &&
+          avatar_url == o.avatar_url &&
+          bio == o.bio &&
+          city == o.city &&
+          country == o.country &&
+          last_activity_at == o.last_activity_at &&
+          profile_url == o.profile_url &&
+          tags == o.tags &&
+          joined_at == o.joined_at &&
+          investment_total == o.investment_total &&
+          deal_count == o.deal_count &&
+          accredited == o.accredited &&
+          legal_name == o.legal_name &&
+          starred == o.starred &&
+          private_tags == o.private_tags &&
+          created_at == o.created_at &&
+          updated_at == o.updated_at
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [user_id, user, user_name, user_email, role, invite_role, syndicate_permission, title, sort_order, carry_percentage_override, carry_discount_percentage, management_fee_discount_percentage, public_on_syndicate_profile, interests, stage_preferences, looking_for, linkedin_url, twitter_url, website, state, avatar_url, bio, city, country, last_activity_at, profile_url, tags, joined_at, investment_total, deal_count, accredited, legal_name, starred, private_tags, created_at, updated_at].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = WefunderGenerated.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end