growsurf-ruby 1.17.0 → 1.19.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (92) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +34 -0
  3. data/README.md +1 -1
  4. data/lib/growsurf_ruby/client.rb +0 -4
  5. data/lib/growsurf_ruby/errors.rb +128 -0
  6. data/lib/growsurf_ruby/models/campaign/campaign_custom_domain.rb +109 -0
  7. data/lib/growsurf_ruby/models/campaign/create.rb +18 -4
  8. data/lib/growsurf_ruby/models/campaign/custom_domain_set_params.rb +25 -0
  9. data/lib/growsurf_ruby/models/campaign/delete_campaign_custom_domain_response.rb +27 -0
  10. data/lib/growsurf_ruby/models/campaign/participant.rb +15 -215
  11. data/lib/growsurf_ruby/models/campaign/participant_email_params.rb +12 -8
  12. data/lib/growsurf_ruby/models/campaign/participant_list_referrals_params.rb +0 -3
  13. data/lib/growsurf_ruby/models/campaign/participant_record_transaction_params.rb +16 -2
  14. data/lib/growsurf_ruby/models/campaign/participant_refund_transaction_params.rb +16 -2
  15. data/lib/growsurf_ruby/models/campaign/reward_create_params.rb +20 -0
  16. data/lib/growsurf_ruby/models/campaign/reward_update_params.rb +20 -0
  17. data/lib/growsurf_ruby/models/campaign/webhook_create_params.rb +10 -3
  18. data/lib/growsurf_ruby/models/campaign_create_params.rb +10 -5
  19. data/lib/growsurf_ruby/models/campaign_list_referrals_params.rb +0 -3
  20. data/lib/growsurf_ruby/models/campaign_update_params.rb +4 -4
  21. data/lib/growsurf_ruby/models/commission_structure.rb +3 -0
  22. data/lib/growsurf_ruby/models/referral_list.rb +17 -1
  23. data/lib/growsurf_ruby/models.rb +0 -2
  24. data/lib/growsurf_ruby/resources/campaign/custom_domain.rb +111 -0
  25. data/lib/growsurf_ruby/resources/campaign/design.rb +3 -3
  26. data/lib/growsurf_ruby/resources/campaign/emails.rb +1 -2
  27. data/lib/growsurf_ruby/resources/campaign/installation.rb +1 -2
  28. data/lib/growsurf_ruby/resources/campaign/options.rb +4 -5
  29. data/lib/growsurf_ruby/resources/campaign/participant.rb +9 -4
  30. data/lib/growsurf_ruby/resources/campaign/program_resources.rb +1 -0
  31. data/lib/growsurf_ruby/resources/campaign/rewards.rb +17 -2
  32. data/lib/growsurf_ruby/resources/campaign/webhooks.rb +13 -3
  33. data/lib/growsurf_ruby/resources/campaign.rb +15 -9
  34. data/lib/growsurf_ruby/version.rb +1 -1
  35. data/lib/growsurf_ruby.rb +4 -3
  36. data/rbi/growsurf_ruby/client.rbi +0 -3
  37. data/rbi/growsurf_ruby/errors.rbi +64 -0
  38. data/rbi/growsurf_ruby/models/campaign/campaign_custom_domain.rbi +193 -0
  39. data/rbi/growsurf_ruby/models/campaign/create.rbi +24 -4
  40. data/rbi/growsurf_ruby/models/campaign/custom_domain_set_params.rbi +47 -0
  41. data/rbi/growsurf_ruby/models/campaign/delete_campaign_custom_domain_response.rbi +40 -0
  42. data/rbi/growsurf_ruby/models/campaign/participant.rbi +15 -292
  43. data/rbi/growsurf_ruby/models/campaign/participant_email_params.rbi +23 -16
  44. data/rbi/growsurf_ruby/models/campaign/participant_list_referrals_params.rbi +0 -15
  45. data/rbi/growsurf_ruby/models/campaign/participant_record_transaction_params.rbi +23 -4
  46. data/rbi/growsurf_ruby/models/campaign/participant_refund_transaction_params.rbi +23 -4
  47. data/rbi/growsurf_ruby/models/campaign/reward_create_params.rbi +24 -0
  48. data/rbi/growsurf_ruby/models/campaign/reward_update_params.rbi +24 -0
  49. data/rbi/growsurf_ruby/models/campaign/webhook_create_params.rbi +18 -4
  50. data/rbi/growsurf_ruby/models/campaign_create_params.rbi +6 -12
  51. data/rbi/growsurf_ruby/models/campaign_list_referrals_params.rbi +0 -15
  52. data/rbi/growsurf_ruby/models/campaign_update_params.rbi +6 -12
  53. data/rbi/growsurf_ruby/models/commission_structure.rbi +3 -0
  54. data/rbi/growsurf_ruby/models/referral_list.rbi +19 -3
  55. data/rbi/growsurf_ruby/models.rbi +0 -2
  56. data/rbi/growsurf_ruby/resources/campaign/custom_domain.rbi +91 -0
  57. data/rbi/growsurf_ruby/resources/campaign/design.rbi +3 -3
  58. data/rbi/growsurf_ruby/resources/campaign/emails.rbi +1 -2
  59. data/rbi/growsurf_ruby/resources/campaign/installation.rbi +1 -2
  60. data/rbi/growsurf_ruby/resources/campaign/options.rbi +4 -5
  61. data/rbi/growsurf_ruby/resources/campaign/participant.rbi +30 -15
  62. data/rbi/growsurf_ruby/resources/campaign/rewards.rbi +25 -2
  63. data/rbi/growsurf_ruby/resources/campaign/webhooks.rbi +21 -4
  64. data/rbi/growsurf_ruby/resources/campaign.rbi +21 -9
  65. data/sig/growsurf_ruby/client.rbs +0 -2
  66. data/sig/growsurf_ruby/errors.rbs +40 -0
  67. data/sig/growsurf_ruby/models/campaign/campaign_custom_domain.rbs +84 -0
  68. data/sig/growsurf_ruby/models/campaign/create.rbs +5 -0
  69. data/sig/growsurf_ruby/models/campaign/custom_domain_set_params.rbs +25 -0
  70. data/sig/growsurf_ruby/models/campaign/delete_campaign_custom_domain_response.rbs +18 -0
  71. data/sig/growsurf_ruby/models/campaign/participant.rbs +7 -205
  72. data/sig/growsurf_ruby/models/campaign/participant_list_referrals_params.rbs +0 -6
  73. data/sig/growsurf_ruby/models/campaign/participant_record_transaction_params.rbs +19 -5
  74. data/sig/growsurf_ruby/models/campaign/participant_refund_transaction_params.rbs +19 -5
  75. data/sig/growsurf_ruby/models/campaign_create_params.rbs +8 -12
  76. data/sig/growsurf_ruby/models/campaign_list_referrals_params.rbs +0 -6
  77. data/sig/growsurf_ruby/models/campaign_update_params.rbs +8 -12
  78. data/sig/growsurf_ruby/models/referral_list.rbs +13 -3
  79. data/sig/growsurf_ruby/models.rbs +0 -2
  80. data/sig/growsurf_ruby/resources/campaign/custom_domain.rbs +30 -0
  81. data/sig/growsurf_ruby/resources/campaign/participant.rbs +3 -2
  82. data/sig/growsurf_ruby/resources/campaign.rbs +7 -4
  83. metadata +14 -11
  84. data/lib/growsurf_ruby/models/account_create_params.rb +0 -46
  85. data/lib/growsurf_ruby/models/account_create_response.rb +0 -57
  86. data/lib/growsurf_ruby/resources/account.rb +0 -66
  87. data/rbi/growsurf_ruby/models/account_create_params.rbi +0 -73
  88. data/rbi/growsurf_ruby/models/account_create_response.rbi +0 -107
  89. data/rbi/growsurf_ruby/resources/account.rbi +0 -46
  90. data/sig/growsurf_ruby/models/account_create_params.rbs +0 -42
  91. data/sig/growsurf_ruby/models/account_create_response.rbs +0 -42
  92. data/sig/growsurf_ruby/resources/account.rbs +0 -15
@@ -0,0 +1,193 @@
1
+ # typed: strong
2
+
3
+ module GrowsurfRuby
4
+ module Models
5
+ module Campaign
6
+ class CampaignCustomDomain < GrowsurfRuby::Internal::Type::BaseModel
7
+ OrHash =
8
+ T.type_alias do
9
+ T.any(
10
+ GrowsurfRuby::Campaign::CampaignCustomDomain,
11
+ GrowsurfRuby::Internal::AnyHash
12
+ )
13
+ end
14
+
15
+ # When the domain was set, in epoch milliseconds. `null` when no domain is set.
16
+ sig { returns(T.nilable(Integer)) }
17
+ attr_accessor :created_at
18
+
19
+ # The DNS record to add at your DNS provider. `null` when no domain is set.
20
+ sig do
21
+ returns(T.nilable(GrowsurfRuby::Campaign::CampaignCustomDomain::DNSRecord))
22
+ end
23
+ attr_reader :dns_record
24
+
25
+ sig do
26
+ params(
27
+ dns_record:
28
+ T.nilable(
29
+ GrowsurfRuby::Campaign::CampaignCustomDomain::DNSRecord::OrHash
30
+ )
31
+ ).void
32
+ end
33
+ attr_writer :dns_record
34
+
35
+ # The custom domain, such as `https://refer.piedpiper.com`, or `null` when none is
36
+ # set.
37
+ sig { returns(T.nilable(String)) }
38
+ attr_accessor :domain
39
+
40
+ # Whether the domain's `CNAME` record pointed to `dns_record.value` at the last
41
+ # check. Landing pages load on the domain only when this is `true`.
42
+ sig { returns(T::Boolean) }
43
+ attr_accessor :is_verified
44
+
45
+ # When the domain record last changed, in epoch milliseconds. `null` when no
46
+ # domain is set.
47
+ sig { returns(T.nilable(Integer)) }
48
+ attr_accessor :updated_at
49
+
50
+ # When the DNS check passed, in epoch milliseconds. `null` while unverified.
51
+ sig { returns(T.nilable(Integer)) }
52
+ attr_accessor :verified_at
53
+
54
+ # The custom domain that serves a program's landing pages.
55
+ sig do
56
+ params(
57
+ created_at: T.nilable(Integer),
58
+ dns_record:
59
+ T.nilable(
60
+ GrowsurfRuby::Campaign::CampaignCustomDomain::DNSRecord::OrHash
61
+ ),
62
+ domain: T.nilable(String),
63
+ is_verified: T::Boolean,
64
+ updated_at: T.nilable(Integer),
65
+ verified_at: T.nilable(Integer)
66
+ ).returns(T.attached_class)
67
+ end
68
+ def self.new(
69
+ # When the domain was set, in epoch milliseconds. `null` when no domain is set.
70
+ created_at:,
71
+ # The DNS record to add at your DNS provider. `null` when no domain is set.
72
+ dns_record:,
73
+ # The custom domain, such as `https://refer.piedpiper.com`, or `null` when none is
74
+ # set.
75
+ domain:,
76
+ # Whether the domain's `CNAME` record pointed to `dns_record.value` at the last
77
+ # check. Landing pages load on the domain only when this is `true`.
78
+ is_verified:,
79
+ # When the domain record last changed, in epoch milliseconds. `null` when no
80
+ # domain is set.
81
+ updated_at:,
82
+ # When the DNS check passed, in epoch milliseconds. `null` while unverified.
83
+ verified_at:
84
+ )
85
+ end
86
+
87
+ sig do
88
+ override.returns(
89
+ {
90
+ created_at: T.nilable(Integer),
91
+ dns_record:
92
+ T.nilable(GrowsurfRuby::Campaign::CampaignCustomDomain::DNSRecord),
93
+ domain: T.nilable(String),
94
+ is_verified: T::Boolean,
95
+ updated_at: T.nilable(Integer),
96
+ verified_at: T.nilable(Integer)
97
+ }
98
+ )
99
+ end
100
+ def to_hash
101
+ end
102
+
103
+ class DNSRecord < GrowsurfRuby::Internal::Type::BaseModel
104
+ OrHash =
105
+ T.type_alias do
106
+ T.any(
107
+ GrowsurfRuby::Campaign::CampaignCustomDomain::DNSRecord,
108
+ GrowsurfRuby::Internal::AnyHash
109
+ )
110
+ end
111
+
112
+ # The hostname the record is for, such as `refer.piedpiper.com`.
113
+ sig { returns(String) }
114
+ attr_accessor :name
115
+
116
+ # The record type. Always `CNAME`.
117
+ sig do
118
+ returns(
119
+ GrowsurfRuby::Campaign::CampaignCustomDomain::DNSRecord::Type::TaggedSymbol
120
+ )
121
+ end
122
+ attr_accessor :type
123
+
124
+ # The record's target, such as `grow.surf`.
125
+ sig { returns(String) }
126
+ attr_accessor :value
127
+
128
+ # The DNS record to add at your DNS provider.
129
+ sig do
130
+ params(
131
+ name: String,
132
+ type:
133
+ GrowsurfRuby::Campaign::CampaignCustomDomain::DNSRecord::Type::OrSymbol,
134
+ value: String
135
+ ).returns(T.attached_class)
136
+ end
137
+ def self.new(
138
+ # The hostname the record is for, such as `refer.piedpiper.com`.
139
+ name:,
140
+ # The record type. Always `CNAME`.
141
+ type:,
142
+ # The record's target, such as `grow.surf`.
143
+ value:
144
+ )
145
+ end
146
+
147
+ sig do
148
+ override.returns(
149
+ {
150
+ name: String,
151
+ type:
152
+ GrowsurfRuby::Campaign::CampaignCustomDomain::DNSRecord::Type::TaggedSymbol,
153
+ value: String
154
+ }
155
+ )
156
+ end
157
+ def to_hash
158
+ end
159
+
160
+ # The record type. Always `CNAME`.
161
+ module Type
162
+ extend GrowsurfRuby::Internal::Type::Enum
163
+
164
+ TaggedSymbol =
165
+ T.type_alias do
166
+ T.all(
167
+ Symbol,
168
+ GrowsurfRuby::Campaign::CampaignCustomDomain::DNSRecord::Type
169
+ )
170
+ end
171
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
172
+
173
+ CNAME =
174
+ T.let(
175
+ :CNAME,
176
+ GrowsurfRuby::Campaign::CampaignCustomDomain::DNSRecord::Type::TaggedSymbol
177
+ )
178
+
179
+ sig do
180
+ override.returns(
181
+ T::Array[
182
+ GrowsurfRuby::Campaign::CampaignCustomDomain::DNSRecord::Type::TaggedSymbol
183
+ ]
184
+ )
185
+ end
186
+ def self.values
187
+ end
188
+ end
189
+ end
190
+ end
191
+ end
192
+ end
193
+ end
@@ -43,8 +43,11 @@ module GrowsurfRuby
43
43
  sig { params(is_affiliate: T::Boolean).void }
44
44
  attr_writer :is_affiliate
45
45
 
46
- # The language of the participant's portal and program emails. Must be one of the
47
- # program's languages. Applied only when this request creates the participant.
46
+ # The language of the participant's portal and program emails. Stored when it is
47
+ # one of the program's languages. A regional tag maps to its language (for
48
+ # example, `es-MX` is stored as `es`). Any other value is ignored and the
49
+ # program's base language applies. Applied only when this request creates the
50
+ # participant.
48
51
  sig { returns(T.nilable(GrowsurfRuby::Campaign::Language::OrSymbol)) }
49
52
  attr_reader :language
50
53
 
@@ -94,6 +97,13 @@ module GrowsurfRuby
94
97
  end
95
98
  attr_writer :referral_status
96
99
 
100
+ # When the participant was referred, in Unix milliseconds. Used only with a valid
101
+ # `referredBy`. If you omit `referralStatus`, GrowSurf compares this time with
102
+ # the program's referral credit window to set it. Defaults to the time of the
103
+ # request.
104
+ sig { returns(T.nilable(Integer)) }
105
+ attr_accessor :referred_at
106
+
97
107
  # Referrer participant ID or email address.
98
108
  sig { returns(T.nilable(String)) }
99
109
  attr_reader :referred_by
@@ -114,6 +124,7 @@ module GrowsurfRuby
114
124
  mobile_instance_id: String,
115
125
  referral_status:
116
126
  GrowsurfRuby::Campaign::Create::ReferralStatus::OrSymbol,
127
+ referred_at: T.nilable(Integer),
117
128
  referred_by: String
118
129
  ).returns(T.attached_class)
119
130
  end
@@ -127,8 +138,11 @@ module GrowsurfRuby
127
138
  # a non-affiliate without `affiliateStatus`. Existing participants are returned
128
139
  # unchanged.
129
140
  is_affiliate: nil,
130
- # The language of the participant's portal and program emails. Must be one of the
131
- # program's languages. Applied only when this request creates the participant.
141
+ # The language of the participant's portal and program emails. Stored when it is
142
+ # one of the program's languages. A regional tag maps to its language (for
143
+ # example, `es-MX` is stored as `es`). Any other value is ignored and the
144
+ # program's base language applies. Applied only when this request creates the
145
+ # participant.
132
146
  language: nil,
133
147
  last_name: nil,
134
148
  # Shallow custom metadata object.
@@ -142,6 +156,11 @@ module GrowsurfRuby
142
156
  # (`CREDIT_AWARDED`, `CREDIT_PENDING`, or `CREDIT_EXPIRED`); left unset when no
143
157
  # referrer resolves.
144
158
  referral_status: nil,
159
+ # When the participant was referred, in Unix milliseconds. Used only with a valid
160
+ # `referredBy`. If you omit `referralStatus`, GrowSurf compares this time with
161
+ # the program's referral credit window to set it. Defaults to the time of the
162
+ # request.
163
+ referred_at: nil,
145
164
  # Referrer participant ID or email address.
146
165
  referred_by: nil
147
166
  )
@@ -161,6 +180,7 @@ module GrowsurfRuby
161
180
  mobile_instance_id: String,
162
181
  referral_status:
163
182
  GrowsurfRuby::Campaign::Create::ReferralStatus::OrSymbol,
183
+ referred_at: T.nilable(Integer),
164
184
  referred_by: String
165
185
  }
166
186
  )
@@ -0,0 +1,47 @@
1
+ # typed: strong
2
+
3
+ module GrowsurfRuby
4
+ module Models
5
+ module Campaign
6
+ class CustomDomainSetParams < GrowsurfRuby::Internal::Type::BaseModel
7
+ extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
8
+ include GrowsurfRuby::Internal::Type::RequestParameters
9
+
10
+ OrHash =
11
+ T.type_alias do
12
+ T.any(
13
+ GrowsurfRuby::Campaign::CustomDomainSetParams,
14
+ GrowsurfRuby::Internal::AnyHash
15
+ )
16
+ end
17
+
18
+ # The hostname to serve the program's landing pages from, with or without
19
+ # `https://`. Up to 255 characters.
20
+ sig { returns(String) }
21
+ attr_accessor :domain
22
+
23
+ sig do
24
+ params(
25
+ domain: String,
26
+ request_options: GrowsurfRuby::RequestOptions::OrHash
27
+ ).returns(T.attached_class)
28
+ end
29
+ def self.new(
30
+ # The hostname to serve the program's landing pages from, with or without
31
+ # `https://`. Up to 255 characters.
32
+ domain:,
33
+ request_options: {}
34
+ )
35
+ end
36
+
37
+ sig do
38
+ override.returns(
39
+ { domain: String, request_options: GrowsurfRuby::RequestOptions }
40
+ )
41
+ end
42
+ def to_hash
43
+ end
44
+ end
45
+ end
46
+ end
47
+ end
@@ -0,0 +1,40 @@
1
+ # typed: strong
2
+
3
+ module GrowsurfRuby
4
+ module Models
5
+ module Campaign
6
+ class DeleteCampaignCustomDomainResponse < GrowsurfRuby::Internal::Type::BaseModel
7
+ OrHash =
8
+ T.type_alias do
9
+ T.any(
10
+ GrowsurfRuby::Models::Campaign::DeleteCampaignCustomDomainResponse,
11
+ GrowsurfRuby::Internal::AnyHash
12
+ )
13
+ end
14
+
15
+ # The custom domain that was removed, such as `https://refer.piedpiper.com`.
16
+ sig { returns(String) }
17
+ attr_accessor :domain
18
+
19
+ # Whether the custom domain was removed.
20
+ sig { returns(T::Boolean) }
21
+ attr_accessor :success
22
+
23
+ sig do
24
+ params(domain: String, success: T::Boolean).returns(T.attached_class)
25
+ end
26
+ def self.new(
27
+ # The custom domain that was removed, such as `https://refer.piedpiper.com`.
28
+ domain:,
29
+ # Whether the custom domain was removed.
30
+ success:
31
+ )
32
+ end
33
+
34
+ sig { override.returns({ domain: String, success: T::Boolean }) }
35
+ def to_hash
36
+ end
37
+ end
38
+ end
39
+ end
40
+ end
@@ -213,6 +213,12 @@ module GrowsurfRuby
213
213
  sig { params(prev_monthly_referral_count: Integer).void }
214
214
  attr_writer :prev_monthly_referral_count
215
215
 
216
+ # When this referred signup counted as a lead for the referrer, in Unix
217
+ # milliseconds. Set only when the program's `referralTrigger` is `CUSTOM`.
218
+ # Lead-event Campaign Rewards and commissions use it.
219
+ sig { returns(T.nilable(Integer)) }
220
+ attr_accessor :referral_lead_qualified_at
221
+
216
222
  sig { returns(T.nilable(T::Array[String])) }
217
223
  attr_reader :referrals
218
224
 
@@ -343,6 +349,7 @@ module GrowsurfRuby
343
349
  paypal_email_address: String,
344
350
  prev_monthly_rank: Integer,
345
351
  prev_monthly_referral_count: Integer,
352
+ referral_lead_qualified_at: T.nilable(Integer),
346
353
  referrals: T::Array[String],
347
354
  referral_source: GrowsurfRuby::Campaign::ReferralSource::OrSymbol,
348
355
  referral_status: GrowsurfRuby::Campaign::ReferralStatus::OrSymbol,
@@ -414,6 +421,10 @@ module GrowsurfRuby
414
421
  paypal_email_address: nil,
415
422
  prev_monthly_rank: nil,
416
423
  prev_monthly_referral_count: nil,
424
+ # When this referred signup counted as a lead for the referrer, in Unix
425
+ # milliseconds. Set only when the program's `referralTrigger` is `CUSTOM`.
426
+ # Lead-event Campaign Rewards and commissions use it.
427
+ referral_lead_qualified_at: nil,
417
428
  referrals: nil,
418
429
  referral_source: nil,
419
430
  referral_status: nil,
@@ -466,6 +477,7 @@ module GrowsurfRuby
466
477
  paypal_email_address: String,
467
478
  prev_monthly_rank: Integer,
468
479
  prev_monthly_referral_count: Integer,
480
+ referral_lead_qualified_at: T.nilable(Integer),
469
481
  referrals: T::Array[String],
470
482
  referral_source:
471
483
  GrowsurfRuby::Campaign::ReferralSource::TaggedSymbol,
@@ -584,7 +596,9 @@ module GrowsurfRuby
584
596
  end
585
597
  end
586
598
 
587
- class Referrer < GrowsurfRuby::Internal::Type::BaseModel
599
+ # The participant's referrer. It has the same fields as a `Participant`. Its own
600
+ # `referrer` is always `null`.
601
+ class Referrer < GrowsurfRuby::Models::Campaign::CampaignParticipant
588
602
  OrHash =
589
603
  T.type_alias do
590
604
  T.any(
@@ -592,297 +606,6 @@ module GrowsurfRuby
592
606
  GrowsurfRuby::Internal::AnyHash
593
607
  )
594
608
  end
595
-
596
- sig { returns(T.nilable(String)) }
597
- attr_reader :id
598
-
599
- sig { params(id: String).void }
600
- attr_writer :id
601
-
602
- sig { returns(T.nilable(Integer)) }
603
- attr_reader :created_at
604
-
605
- sig { params(created_at: Integer).void }
606
- attr_writer :created_at
607
-
608
- sig { returns(T.nilable(String)) }
609
- attr_reader :email
610
-
611
- sig { params(email: String).void }
612
- attr_writer :email
613
-
614
- sig { returns(T.nilable(String)) }
615
- attr_accessor :fingerprint
616
-
617
- sig { returns(T.nilable(String)) }
618
- attr_accessor :first_name
619
-
620
- sig { returns(T.nilable(String)) }
621
- attr_reader :fraud_reason_code
622
-
623
- sig { params(fraud_reason_code: String).void }
624
- attr_writer :fraud_reason_code
625
-
626
- sig do
627
- returns(
628
- T.nilable(GrowsurfRuby::Campaign::FraudRiskLevel::TaggedSymbol)
629
- )
630
- end
631
- attr_reader :fraud_risk_level
632
-
633
- sig do
634
- params(
635
- fraud_risk_level: GrowsurfRuby::Campaign::FraudRiskLevel::OrSymbol
636
- ).void
637
- end
638
- attr_writer :fraud_risk_level
639
-
640
- sig { returns(T.nilable(Integer)) }
641
- attr_reader :impression_count
642
-
643
- sig { params(impression_count: Integer).void }
644
- attr_writer :impression_count
645
-
646
- sig { returns(T.nilable(Integer)) }
647
- attr_reader :invite_count
648
-
649
- sig { params(invite_count: Integer).void }
650
- attr_writer :invite_count
651
-
652
- sig { returns(T.nilable(String)) }
653
- attr_accessor :ip_address
654
-
655
- sig { returns(T.nilable(T::Boolean)) }
656
- attr_reader :is_winner
657
-
658
- sig { params(is_winner: T::Boolean).void }
659
- attr_writer :is_winner
660
-
661
- sig { returns(T.nilable(String)) }
662
- attr_accessor :last_name
663
-
664
- # The number of pending referrals the participant made that have not converted
665
- # into successful referrals yet.
666
- sig { returns(T.nilable(Integer)) }
667
- attr_reader :lead_count
668
-
669
- sig { params(lead_count: Integer).void }
670
- attr_writer :lead_count
671
-
672
- # Shallow custom metadata object.
673
- sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
674
- attr_reader :metadata
675
-
676
- sig { params(metadata: T::Hash[Symbol, T.anything]).void }
677
- attr_writer :metadata
678
-
679
- sig { returns(T.nilable(Integer)) }
680
- attr_reader :monthly_rank
681
-
682
- sig { params(monthly_rank: Integer).void }
683
- attr_writer :monthly_rank
684
-
685
- sig { returns(T.nilable(Integer)) }
686
- attr_reader :monthly_referral_count
687
-
688
- sig { params(monthly_referral_count: Integer).void }
689
- attr_writer :monthly_referral_count
690
-
691
- sig { returns(T.nilable(T::Array[String])) }
692
- attr_reader :monthly_referrals
693
-
694
- sig { params(monthly_referrals: T::Array[String]).void }
695
- attr_writer :monthly_referrals
696
-
697
- sig { returns(T.nilable(Integer)) }
698
- attr_reader :prev_monthly_rank
699
-
700
- sig { params(prev_monthly_rank: Integer).void }
701
- attr_writer :prev_monthly_rank
702
-
703
- sig { returns(T.nilable(Integer)) }
704
- attr_reader :prev_monthly_referral_count
705
-
706
- sig { params(prev_monthly_referral_count: Integer).void }
707
- attr_writer :prev_monthly_referral_count
708
-
709
- sig { returns(T.nilable(Integer)) }
710
- attr_reader :rank
711
-
712
- sig { params(rank: Integer).void }
713
- attr_writer :rank
714
-
715
- sig { returns(T.nilable(Integer)) }
716
- attr_reader :referral_count
717
-
718
- sig { params(referral_count: Integer).void }
719
- attr_writer :referral_count
720
-
721
- sig { returns(T.nilable(T::Array[String])) }
722
- attr_reader :referrals
723
-
724
- sig { params(referrals: T::Array[String]).void }
725
- attr_writer :referrals
726
-
727
- sig do
728
- returns(
729
- T.nilable(GrowsurfRuby::Campaign::ReferralSource::TaggedSymbol)
730
- )
731
- end
732
- attr_reader :referral_source
733
-
734
- sig do
735
- params(
736
- referral_source: GrowsurfRuby::Campaign::ReferralSource::OrSymbol
737
- ).void
738
- end
739
- attr_writer :referral_source
740
-
741
- sig do
742
- returns(
743
- T.nilable(GrowsurfRuby::Campaign::ReferralStatus::TaggedSymbol)
744
- )
745
- end
746
- attr_reader :referral_status
747
-
748
- sig do
749
- params(
750
- referral_status: GrowsurfRuby::Campaign::ReferralStatus::OrSymbol
751
- ).void
752
- end
753
- attr_writer :referral_status
754
-
755
- sig { returns(T.nilable(T::Hash[Symbol, Integer])) }
756
- attr_reader :share_count
757
-
758
- sig { params(share_count: T::Hash[Symbol, Integer]).void }
759
- attr_writer :share_count
760
-
761
- sig { returns(T.nilable(String)) }
762
- attr_reader :share_url
763
-
764
- sig { params(share_url: String).void }
765
- attr_writer :share_url
766
-
767
- sig { returns(T.nilable(Integer)) }
768
- attr_reader :unique_impression_count
769
-
770
- sig { params(unique_impression_count: Integer).void }
771
- attr_writer :unique_impression_count
772
-
773
- sig { returns(T.nilable(T::Boolean)) }
774
- attr_reader :unsubscribed
775
-
776
- sig { params(unsubscribed: T::Boolean).void }
777
- attr_writer :unsubscribed
778
-
779
- sig do
780
- params(
781
- id: String,
782
- created_at: Integer,
783
- email: String,
784
- fingerprint: T.nilable(String),
785
- first_name: T.nilable(String),
786
- fraud_reason_code: String,
787
- fraud_risk_level:
788
- GrowsurfRuby::Campaign::FraudRiskLevel::OrSymbol,
789
- impression_count: Integer,
790
- invite_count: Integer,
791
- ip_address: T.nilable(String),
792
- is_winner: T::Boolean,
793
- last_name: T.nilable(String),
794
- lead_count: Integer,
795
- metadata: T::Hash[Symbol, T.anything],
796
- monthly_rank: Integer,
797
- monthly_referral_count: Integer,
798
- monthly_referrals: T::Array[String],
799
- prev_monthly_rank: Integer,
800
- prev_monthly_referral_count: Integer,
801
- rank: Integer,
802
- referral_count: Integer,
803
- referrals: T::Array[String],
804
- referral_source: GrowsurfRuby::Campaign::ReferralSource::OrSymbol,
805
- referral_status: GrowsurfRuby::Campaign::ReferralStatus::OrSymbol,
806
- share_count: T::Hash[Symbol, Integer],
807
- share_url: String,
808
- unique_impression_count: Integer,
809
- unsubscribed: T::Boolean
810
- ).returns(T.attached_class)
811
- end
812
- def self.new(
813
- id: nil,
814
- created_at: nil,
815
- email: nil,
816
- fingerprint: nil,
817
- first_name: nil,
818
- fraud_reason_code: nil,
819
- fraud_risk_level: nil,
820
- impression_count: nil,
821
- invite_count: nil,
822
- ip_address: nil,
823
- is_winner: nil,
824
- last_name: nil,
825
- # The number of pending referrals the participant made that have not converted
826
- # into successful referrals yet.
827
- lead_count: nil,
828
- # Shallow custom metadata object.
829
- metadata: nil,
830
- monthly_rank: nil,
831
- monthly_referral_count: nil,
832
- monthly_referrals: nil,
833
- prev_monthly_rank: nil,
834
- prev_monthly_referral_count: nil,
835
- rank: nil,
836
- referral_count: nil,
837
- referrals: nil,
838
- referral_source: nil,
839
- referral_status: nil,
840
- share_count: nil,
841
- share_url: nil,
842
- unique_impression_count: nil,
843
- unsubscribed: nil
844
- )
845
- end
846
-
847
- sig do
848
- override.returns(
849
- {
850
- id: String,
851
- created_at: Integer,
852
- email: String,
853
- fingerprint: T.nilable(String),
854
- first_name: T.nilable(String),
855
- fraud_reason_code: String,
856
- fraud_risk_level:
857
- GrowsurfRuby::Campaign::FraudRiskLevel::TaggedSymbol,
858
- impression_count: Integer,
859
- invite_count: Integer,
860
- ip_address: T.nilable(String),
861
- is_winner: T::Boolean,
862
- last_name: T.nilable(String),
863
- lead_count: Integer,
864
- metadata: T::Hash[Symbol, T.anything],
865
- monthly_rank: Integer,
866
- monthly_referral_count: Integer,
867
- monthly_referrals: T::Array[String],
868
- prev_monthly_rank: Integer,
869
- prev_monthly_referral_count: Integer,
870
- rank: Integer,
871
- referral_count: Integer,
872
- referrals: T::Array[String],
873
- referral_source:
874
- GrowsurfRuby::Campaign::ReferralSource::TaggedSymbol,
875
- referral_status:
876
- GrowsurfRuby::Campaign::ReferralStatus::TaggedSymbol,
877
- share_count: T::Hash[Symbol, Integer],
878
- share_url: String,
879
- unique_impression_count: Integer,
880
- unsubscribed: T::Boolean
881
- }
882
- )
883
- end
884
- def to_hash
885
- end
886
609
  end
887
610
  end
888
611
  end