wefunder 1.0.0 → 1.1.0

data/lib/wefunder_generated/models/{anonymized_attribution_status.rb → referral_code_attributes_target.rb}

@@ -14,13 +14,14 @@ require 'date'
 require 'time'
 
 module WefunderGenerated
-  # Current investment status
-  class AnonymizedAttributionStatus
-    # Investment processing stage (matches /manage page)
-    attr_accessor :bucket
+  # The company or offering this code credits, or null for any company. If the target no longer exists, `id` is null and `unavailable` is true: the code credits nothing. 
+  class ReferralCodeAttributesTarget
+    attr_accessor :type
 
-    # Whether the investment appears on founder progress bar (likely to complete)
-    attr_accessor :progress_bar
+    attr_accessor :id
+
+    # Present and true when the target no longer exists.
+    attr_accessor :unavailable
 
     class EnumAttributeValidator
       attr_reader :datatype
@@ -47,8 +48,9 @@ module WefunderGenerated
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'bucket' => :'bucket',
-        :'progress_bar' => :'progress_bar'
+        :'type' => :'type',
+        :'id' => :'id',
+        :'unavailable' => :'unavailable'
       }
     end
 
@@ -60,14 +62,16 @@ module WefunderGenerated
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'bucket' => :'String',
-        :'progress_bar' => :'Boolean'
+        :'type' => :'String',
+        :'id' => :'String',
+        :'unavailable' => :'Boolean'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'id',
       ])
     end
 
@@ -75,23 +79,27 @@ module WefunderGenerated
     # @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::AnonymizedAttributionStatus` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `WefunderGenerated::ReferralCodeAttributesTarget` 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::AnonymizedAttributionStatus`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `WefunderGenerated::ReferralCodeAttributesTarget`. 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?(:'bucket')
-        self.bucket = attributes[:'bucket']
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
       end
 
-      if attributes.key?(:'progress_bar')
-        self.progress_bar = attributes[:'progress_bar']
+      if attributes.key?(:'unavailable')
+        self.unavailable = attributes[:'unavailable']
       end
     end
 
@@ -107,19 +115,19 @@ module WefunderGenerated
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      bucket_validator = EnumAttributeValidator.new('String', ["draft", "no_payment_yet", "pending", "is_ready", "confirmed", "canceled"])
-      return false unless bucket_validator.valid?(@bucket)
+      type_validator = EnumAttributeValidator.new('String', ["company", "offering"])
+      return false unless type_validator.valid?(@type)
       true
     end
 
     # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] bucket Object to be assigned
-    def bucket=(bucket)
-      validator = EnumAttributeValidator.new('String', ["draft", "no_payment_yet", "pending", "is_ready", "confirmed", "canceled"])
-      unless validator.valid?(bucket)
-        fail ArgumentError, "invalid value for \"bucket\", must be one of #{validator.allowable_values}."
+    # @param [Object] type Object to be assigned
+    def type=(type)
+      validator = EnumAttributeValidator.new('String', ["company", "offering"])
+      unless validator.valid?(type)
+        fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
       end
-      @bucket = bucket
+      @type = type
     end
 
     # Checks equality by comparing each attribute.
@@ -127,8 +135,9 @@ module WefunderGenerated
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          bucket == o.bucket &&
-          progress_bar == o.progress_bar
+          type == o.type &&
+          id == o.id &&
+          unavailable == o.unavailable
     end
 
     # @see the `==` method
@@ -140,7 +149,7 @@ module WefunderGenerated
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [bucket, progress_bar].hash
+      [type, id, unavailable].hash
     end
 
     # Builds the object from hash

data/lib/wefunder_generated/models/{spv_status_envelope.rb → referral_code_envelope.rb}

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module WefunderGenerated
-  class SpvStatusEnvelope
+  class ReferralCodeEnvelope
     attr_accessor :data
 
     attr_accessor :meta
@@ -35,8 +35,8 @@ module WefunderGenerated
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'data' => :'SpvStatus',
-        :'meta' => :'SpvWithMetaEnvelopeMeta'
+        :'data' => :'ReferralCode',
+        :'meta' => :'ReferralCodeEnvelopeMeta'
       }
     end
 
@@ -50,13 +50,13 @@ module WefunderGenerated
     # @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::SpvStatusEnvelope` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `WefunderGenerated::ReferralCodeEnvelope` 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::SpvStatusEnvelope`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `WefunderGenerated::ReferralCodeEnvelope`. 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
       }

data/lib/wefunder_generated/models/{spv_with_meta_envelope_meta.rb → referral_code_envelope_meta.rb}

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module WefunderGenerated
-  class SpvWithMetaEnvelopeMeta
+  class ReferralCodeEnvelopeMeta
     attr_accessor :request_id
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -46,13 +46,13 @@ module WefunderGenerated
     # @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::SpvWithMetaEnvelopeMeta` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `WefunderGenerated::ReferralCodeEnvelopeMeta` 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::SpvWithMetaEnvelopeMeta`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `WefunderGenerated::ReferralCodeEnvelopeMeta`. 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
       }

data/lib/wefunder_generated/models/{partner_investor_list_envelope.rb → referral_code_list_envelope.rb}

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module WefunderGenerated
-  class PartnerInvestorListEnvelope
+  class ReferralCodeListEnvelope
     attr_accessor :data
 
     attr_accessor :meta
@@ -35,8 +35,8 @@ module WefunderGenerated
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'data' => :'Array<PartnerInvestor>',
-        :'meta' => :'PaginationMeta'
+        :'data' => :'Array<ReferralCode>',
+        :'meta' => :'ReferralCodeListEnvelopeMeta'
       }
     end
 
@@ -50,13 +50,13 @@ module WefunderGenerated
     # @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::PartnerInvestorListEnvelope` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `WefunderGenerated::ReferralCodeListEnvelope` 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::PartnerInvestorListEnvelope`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `WefunderGenerated::ReferralCodeListEnvelope`. 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
       }

data/lib/wefunder_generated/models/{attribution_campaign_summary.rb → referral_code_list_envelope_meta.rb}

@@ -14,26 +14,27 @@ require 'date'
 require 'time'
 
 module WefunderGenerated
-  class AttributionCampaignSummary
-    attr_accessor :id
+  class ReferralCodeListEnvelopeMeta
+    attr_accessor :has_more
 
-    attr_accessor :company_name
+    attr_accessor :page_count
 
-    attr_accessor :company_id
+    # Present when has_more is true.
+    attr_accessor :next_cursor
 
-    attr_accessor :state
+    # Maximum active codes allowed for this application.
+    attr_accessor :active_limit
 
-    # 1=anonymized, 2=detailed (future)
-    attr_accessor :access_level
+    attr_accessor :request_id
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'id' => :'id',
-        :'company_name' => :'company_name',
-        :'company_id' => :'company_id',
-        :'state' => :'state',
-        :'access_level' => :'access_level'
+        :'has_more' => :'has_more',
+        :'page_count' => :'page_count',
+        :'next_cursor' => :'next_cursor',
+        :'active_limit' => :'active_limit',
+        :'request_id' => :'request_id'
       }
     end
 
@@ -45,11 +46,11 @@ module WefunderGenerated
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'id' => :'Integer',
-        :'company_name' => :'String',
-        :'company_id' => :'Integer',
-        :'state' => :'String',
-        :'access_level' => :'Integer'
+        :'has_more' => :'Boolean',
+        :'page_count' => :'Integer',
+        :'next_cursor' => :'Integer',
+        :'active_limit' => :'Integer',
+        :'request_id' => :'String'
       }
     end
 
@@ -63,35 +64,35 @@ module WefunderGenerated
     # @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::AttributionCampaignSummary` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `WefunderGenerated::ReferralCodeListEnvelopeMeta` 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::AttributionCampaignSummary`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `WefunderGenerated::ReferralCodeListEnvelopeMeta`. 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?(:'id')
-        self.id = attributes[:'id']
+      if attributes.key?(:'has_more')
+        self.has_more = attributes[:'has_more']
       end
 
-      if attributes.key?(:'company_name')
-        self.company_name = attributes[:'company_name']
+      if attributes.key?(:'page_count')
+        self.page_count = attributes[:'page_count']
       end
 
-      if attributes.key?(:'company_id')
-        self.company_id = attributes[:'company_id']
+      if attributes.key?(:'next_cursor')
+        self.next_cursor = attributes[:'next_cursor']
       end
 
-      if attributes.key?(:'state')
-        self.state = attributes[:'state']
+      if attributes.key?(:'active_limit')
+        self.active_limit = attributes[:'active_limit']
       end
 
-      if attributes.key?(:'access_level')
-        self.access_level = attributes[:'access_level']
+      if attributes.key?(:'request_id')
+        self.request_id = attributes[:'request_id']
       end
     end
 
@@ -115,11 +116,11 @@ module WefunderGenerated
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          id == o.id &&
-          company_name == o.company_name &&
-          company_id == o.company_id &&
-          state == o.state &&
-          access_level == o.access_level
+          has_more == o.has_more &&
+          page_count == o.page_count &&
+          next_cursor == o.next_cursor &&
+          active_limit == o.active_limit &&
+          request_id == o.request_id
     end
 
     # @see the `==` method
@@ -131,7 +132,7 @@ module WefunderGenerated
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, company_name, company_id, state, access_level].hash
+      [has_more, page_count, next_cursor, active_limit, request_id].hash
     end
 
     # Builds the object from hash

data/lib/wefunder_generated/models/{spv_status_attributes.rb → referral_code_stats_company.rb}

@@ -14,20 +14,26 @@ require 'date'
 require 'time'
 
 module WefunderGenerated
-  class SpvStatusAttributes
-    attr_accessor :status
+  class ReferralCodeStatsCompany
+    attr_accessor :company
 
-    # The offering is awaiting Wefunder review before it can open.
-    attr_accessor :requires_ops_review
+    # What your app may see for this company, from its installation on it.
+    attr_accessor :level
 
-    # A disbursement is queued for this SPV but funds have not moved yet.
-    attr_accessor :disbursement_scheduled
+    # Where the company's founders verify referrals in their own dashboard.
+    attr_accessor :verification_url
 
-    # Estimated date funds will be disbursed — 3 business days from when the close executed and the SPV entered the disbursement queue. Present only while `status` is `closing` (awaiting disbursement); null before close and once funds have moved.
-    attr_accessor :expected_disbursement_at
+    # Counts level only. The first week this company has cells for.
+    attr_accessor :in_scope_since
 
-    # The investor roster has been finalized.
-    attr_accessor :finalized_investor_list
+    # Counts level only. Every completed week since in_scope_since.
+    attr_accessor :weeks
+
+    # Anonymized or full level only, replacing `weeks`. Anonymized rows carry opaque `investment` and `investor` tokens, `week`, `amount_tier`, `status` and `time_to_invest`; full rows carry the investment id, the investor's name and email, the exact `amount`, `status`, `clicked_at`, `applied_at` and the UTM attribution. 
+    attr_accessor :investments
+
+    # Present when the company has more rows; pass it as `investments_cursor` with `company_id`.
+    attr_accessor :investments_next_cursor
 
     class EnumAttributeValidator
       attr_reader :datatype
@@ -54,11 +60,13 @@ module WefunderGenerated
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'status' => :'status',
-        :'requires_ops_review' => :'requires_ops_review',
-        :'disbursement_scheduled' => :'disbursement_scheduled',
-        :'expected_disbursement_at' => :'expected_disbursement_at',
-        :'finalized_investor_list' => :'finalized_investor_list'
+        :'company' => :'company',
+        :'level' => :'level',
+        :'verification_url' => :'verification_url',
+        :'in_scope_since' => :'in_scope_since',
+        :'weeks' => :'weeks',
+        :'investments' => :'investments',
+        :'investments_next_cursor' => :'investments_next_cursor'
       }
     end
 
@@ -70,18 +78,19 @@ module WefunderGenerated
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'status' => :'String',
-        :'requires_ops_review' => :'Boolean',
-        :'disbursement_scheduled' => :'Boolean',
-        :'expected_disbursement_at' => :'Time',
-        :'finalized_investor_list' => :'Boolean'
+        :'company' => :'String',
+        :'level' => :'String',
+        :'verification_url' => :'String',
+        :'in_scope_since' => :'String',
+        :'weeks' => :'Array<ReferralCohort>',
+        :'investments' => :'Array<Hash<String, Object>>',
+        :'investments_next_cursor' => :'Integer'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'expected_disbursement_at',
       ])
     end
 
@@ -89,35 +98,47 @@ module WefunderGenerated
     # @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::SpvStatusAttributes` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `WefunderGenerated::ReferralCodeStatsCompany` 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::SpvStatusAttributes`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `WefunderGenerated::ReferralCodeStatsCompany`. 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?(:'status')
-        self.status = attributes[:'status']
+      if attributes.key?(:'company')
+        self.company = attributes[:'company']
+      end
+
+      if attributes.key?(:'level')
+        self.level = attributes[:'level']
       end
 
-      if attributes.key?(:'requires_ops_review')
-        self.requires_ops_review = attributes[:'requires_ops_review']
+      if attributes.key?(:'verification_url')
+        self.verification_url = attributes[:'verification_url']
       end
 
-      if attributes.key?(:'disbursement_scheduled')
-        self.disbursement_scheduled = attributes[:'disbursement_scheduled']
+      if attributes.key?(:'in_scope_since')
+        self.in_scope_since = attributes[:'in_scope_since']
       end
 
-      if attributes.key?(:'expected_disbursement_at')
-        self.expected_disbursement_at = attributes[:'expected_disbursement_at']
+      if attributes.key?(:'weeks')
+        if (value = attributes[:'weeks']).is_a?(Array)
+          self.weeks = value
+        end
+      end
+
+      if attributes.key?(:'investments')
+        if (value = attributes[:'investments']).is_a?(Array)
+          self.investments = value
+        end
       end
 
-      if attributes.key?(:'finalized_investor_list')
-        self.finalized_investor_list = attributes[:'finalized_investor_list']
+      if attributes.key?(:'investments_next_cursor')
+        self.investments_next_cursor = attributes[:'investments_next_cursor']
       end
     end
 
@@ -133,19 +154,19 @@ module WefunderGenerated
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      status_validator = EnumAttributeValidator.new('String', ["draft", "open", "closing", "closed", "canceled"])
-      return false unless status_validator.valid?(@status)
+      level_validator = EnumAttributeValidator.new('String', ["counts", "anonymized", "full"])
+      return false unless level_validator.valid?(@level)
       true
     end
 
     # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] status Object to be assigned
-    def status=(status)
-      validator = EnumAttributeValidator.new('String', ["draft", "open", "closing", "closed", "canceled"])
-      unless validator.valid?(status)
-        fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
+    # @param [Object] level Object to be assigned
+    def level=(level)
+      validator = EnumAttributeValidator.new('String', ["counts", "anonymized", "full"])
+      unless validator.valid?(level)
+        fail ArgumentError, "invalid value for \"level\", must be one of #{validator.allowable_values}."
       end
-      @status = status
+      @level = level
     end
 
     # Checks equality by comparing each attribute.
@@ -153,11 +174,13 @@ module WefunderGenerated
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          status == o.status &&
-          requires_ops_review == o.requires_ops_review &&
-          disbursement_scheduled == o.disbursement_scheduled &&
-          expected_disbursement_at == o.expected_disbursement_at &&
-          finalized_investor_list == o.finalized_investor_list
+          company == o.company &&
+          level == o.level &&
+          verification_url == o.verification_url &&
+          in_scope_since == o.in_scope_since &&
+          weeks == o.weeks &&
+          investments == o.investments &&
+          investments_next_cursor == o.investments_next_cursor
     end
 
     # @see the `==` method
@@ -169,7 +192,7 @@ module WefunderGenerated
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [status, requires_ops_review, disbursement_scheduled, expected_disbursement_at, finalized_investor_list].hash
+      [company, level, verification_url, in_scope_since, weeks, investments, investments_next_cursor].hash
     end
 
     # Builds the object from hash