safetykit 0.7.0 → 0.9.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +16 -0
- data/README.md +1 -1
- data/lib/safety_kit/internal/type/union.rb +11 -0
- data/lib/safety_kit/models/beta/event_create_params.rb +1324 -171
- data/lib/safety_kit/models/beta/event_create_response.rb +72 -30
- data/lib/safety_kit/resources/beta/events.rb +2 -2
- data/lib/safety_kit/version.rb +1 -1
- data/rbi/safety_kit/models/beta/event_create_params.rbi +2746 -267
- data/rbi/safety_kit/models/beta/event_create_response.rbi +151 -52
- data/rbi/safety_kit/resources/beta/events.rbi +16 -8
- data/sig/safety_kit/models/beta/event_create_params.rbs +1106 -198
- data/sig/safety_kit/models/beta/event_create_response.rbs +62 -20
- data/sig/safety_kit/resources/beta/events.rbs +1 -1
- metadata +1 -1
|
@@ -9,42 +9,42 @@ module SafetyKit
|
|
|
9
9
|
include SafetyKit::Internal::Type::RequestParameters
|
|
10
10
|
|
|
11
11
|
# @!attribute body
|
|
12
|
-
# Backend event to send to SafetyKit. Send events from
|
|
13
|
-
# has happened in your product. Do not send these
|
|
14
|
-
# or mobile client.
|
|
12
|
+
# Backend event or ordered batch of events to send to SafetyKit. Send events from
|
|
13
|
+
# your server after an action has happened in your product. Do not send these
|
|
14
|
+
# events directly from a browser or mobile client.
|
|
15
15
|
#
|
|
16
|
-
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::UserContact, SafetyKit::Models::Beta::EventCreateParams::Body::ContentUploaded, SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccount, SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccount]
|
|
16
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::UserContactEventRequest, SafetyKit::Models::Beta::EventCreateParams::Body::ContentUploadedEventRequest, SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest, SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest, Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::UserContact, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::ContentUploaded, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::CreateAccount, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::UpdateAccount>]
|
|
17
17
|
required :body, union: -> { SafetyKit::Beta::EventCreateParams::Body }
|
|
18
18
|
|
|
19
19
|
# @!method initialize(body:, request_options: {})
|
|
20
20
|
# Some parameter documentations has been truncated, see
|
|
21
21
|
# {SafetyKit::Models::Beta::EventCreateParams} for more details.
|
|
22
22
|
#
|
|
23
|
-
# @param body [SafetyKit::Models::Beta::EventCreateParams::Body::UserContact, SafetyKit::Models::Beta::EventCreateParams::Body::ContentUploaded, SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccount, SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccount] Backend event to send to SafetyKit. Send events from
|
|
23
|
+
# @param body [SafetyKit::Models::Beta::EventCreateParams::Body::UserContactEventRequest, SafetyKit::Models::Beta::EventCreateParams::Body::ContentUploadedEventRequest, SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest, SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest, Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::UserContact, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::ContentUploaded, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::CreateAccount, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::UpdateAccount>] Backend event or ordered batch of events to send to SafetyKit. Send events from
|
|
24
24
|
#
|
|
25
25
|
# @param request_options [SafetyKit::RequestOptions, Hash{Symbol=>Object}]
|
|
26
26
|
|
|
27
|
-
# Backend event to send to SafetyKit. Send events from
|
|
28
|
-
# has happened in your product. Do not send these
|
|
29
|
-
# or mobile client.
|
|
27
|
+
# Backend event or ordered batch of events to send to SafetyKit. Send events from
|
|
28
|
+
# your server after an action has happened in your product. Do not send these
|
|
29
|
+
# events directly from a browser or mobile client.
|
|
30
30
|
module Body
|
|
31
31
|
extend SafetyKit::Internal::Type::Union
|
|
32
32
|
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
# A user contacts, transacts with, or otherwise interacts with another user. SafetyKit records both users' perspectives with a shared event_id.
|
|
36
|
-
variant :user_contact, -> { SafetyKit::Beta::EventCreateParams::Body::UserContact }
|
|
33
|
+
# A user contacts, transacts with, or otherwise interacts with another user.
|
|
34
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UserContactEventRequest }
|
|
37
35
|
|
|
38
36
|
# A user posts, uploads, publishes, edits, or replaces content.
|
|
39
|
-
variant
|
|
37
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::ContentUploadedEventRequest }
|
|
40
38
|
|
|
41
39
|
# A user or account is created.
|
|
42
|
-
variant
|
|
40
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::CreateAccountEventRequest }
|
|
43
41
|
|
|
44
42
|
# A user or account profile, contact detail, payment detail, or public bio changes.
|
|
45
|
-
variant
|
|
43
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UpdateAccountEventRequest }
|
|
44
|
+
|
|
45
|
+
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4Array }
|
|
46
46
|
|
|
47
|
-
class
|
|
47
|
+
class UserContactEventRequest < SafetyKit::Internal::Type::BaseModel
|
|
48
48
|
# @!attribute counterparty_user_id
|
|
49
49
|
# Your stable canonical identifier for the other user in a user-to-user
|
|
50
50
|
# interaction.
|
|
@@ -67,8 +67,8 @@ module SafetyKit
|
|
|
67
67
|
|
|
68
68
|
# @!attribute type
|
|
69
69
|
#
|
|
70
|
-
# @return [Symbol,
|
|
71
|
-
required :type,
|
|
70
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UserContactEventRequest::Type]
|
|
71
|
+
required :type, enum: -> { SafetyKit::Beta::EventCreateParams::Body::UserContactEventRequest::Type }
|
|
72
72
|
|
|
73
73
|
# @!attribute user_id
|
|
74
74
|
# Your stable canonical identifier for the user or account.
|
|
@@ -81,9 +81,9 @@ module SafetyKit
|
|
|
81
81
|
# listing text, image URLs, and similar content SafetyKit should compare or
|
|
82
82
|
# analyze.
|
|
83
83
|
#
|
|
84
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
84
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UserContactEventRequest::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UserContactEventRequest::Content::EventImageContent>, nil]
|
|
85
85
|
optional :content,
|
|
86
|
-
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
86
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::UserContactEventRequest::Content] }
|
|
87
87
|
|
|
88
88
|
# @!attribute metadata
|
|
89
89
|
# Non-PII product context for filtering, segmentation, and debugging. Values may
|
|
@@ -91,24 +91,23 @@ module SafetyKit
|
|
|
91
91
|
#
|
|
92
92
|
# @return [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}, nil]
|
|
93
93
|
optional :metadata,
|
|
94
|
-
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
94
|
+
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::UserContactEventRequest::Metadata] }
|
|
95
95
|
|
|
96
96
|
# @!attribute resources_used
|
|
97
97
|
# Reusable resources observed during the event. Use this for emails, phone
|
|
98
98
|
# numbers, names, addresses, social handles, URLs, payment identifiers, or similar
|
|
99
99
|
# identifiers.
|
|
100
100
|
#
|
|
101
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
101
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UserContactEventRequest::ResourcesUsed>, nil]
|
|
102
102
|
optional :resources_used,
|
|
103
|
-
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::
|
|
103
|
+
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::UserContactEventRequest::ResourcesUsed] }
|
|
104
104
|
|
|
105
|
-
# @!method initialize(counterparty_user_id:, event_name:, timestamp:, user_id:, content: nil, metadata: nil, resources_used: nil
|
|
105
|
+
# @!method initialize(counterparty_user_id:, event_name:, timestamp:, type:, user_id:, content: nil, metadata: nil, resources_used: nil)
|
|
106
106
|
# Some parameter documentations has been truncated, see
|
|
107
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
108
|
-
# details.
|
|
107
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UserContactEventRequest} for
|
|
108
|
+
# more details.
|
|
109
109
|
#
|
|
110
110
|
# A user contacts, transacts with, or otherwise interacts with another user.
|
|
111
|
-
# SafetyKit records both users' perspectives with a shared event_id.
|
|
112
111
|
#
|
|
113
112
|
# @param counterparty_user_id [String] Your stable canonical identifier for the other user in a user-to-user interactio
|
|
114
113
|
#
|
|
@@ -116,25 +115,35 @@ module SafetyKit
|
|
|
116
115
|
#
|
|
117
116
|
# @param timestamp [Time] The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
118
117
|
#
|
|
118
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UserContactEventRequest::Type]
|
|
119
|
+
#
|
|
119
120
|
# @param user_id [String] Your stable canonical identifier for the user or account.
|
|
120
121
|
#
|
|
121
|
-
# @param content [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
122
|
+
# @param content [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UserContactEventRequest::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UserContactEventRequest::Content::EventImageContent>] User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
122
123
|
#
|
|
123
124
|
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
124
125
|
#
|
|
125
|
-
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
126
|
-
|
|
127
|
-
#
|
|
126
|
+
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UserContactEventRequest::ResourcesUsed>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
127
|
+
|
|
128
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UserContactEventRequest#type
|
|
129
|
+
module Type
|
|
130
|
+
extend SafetyKit::Internal::Type::Enum
|
|
131
|
+
|
|
132
|
+
USER_CONTACT = :user_contact
|
|
133
|
+
|
|
134
|
+
# @!method self.values
|
|
135
|
+
# @return [Array<Symbol>]
|
|
136
|
+
end
|
|
128
137
|
|
|
129
138
|
# User-authored text content associated with an event.
|
|
130
139
|
module Content
|
|
131
140
|
extend SafetyKit::Internal::Type::Union
|
|
132
141
|
|
|
133
142
|
# User-authored text content associated with an event.
|
|
134
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
143
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UserContactEventRequest::Content::EventTextContent }
|
|
135
144
|
|
|
136
145
|
# User-uploaded image content associated with an event.
|
|
137
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
146
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UserContactEventRequest::Content::EventImageContent }
|
|
138
147
|
|
|
139
148
|
class EventTextContent < SafetyKit::Internal::Type::BaseModel
|
|
140
149
|
# @!attribute text
|
|
@@ -146,9 +155,9 @@ module SafetyKit
|
|
|
146
155
|
# @!attribute type
|
|
147
156
|
# Text content part.
|
|
148
157
|
#
|
|
149
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
158
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UserContactEventRequest::Content::EventTextContent::Type]
|
|
150
159
|
required :type,
|
|
151
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
160
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UserContactEventRequest::Content::EventTextContent::Type }
|
|
152
161
|
|
|
153
162
|
# @!attribute key
|
|
154
163
|
# Stable field key for this content part.
|
|
@@ -161,13 +170,13 @@ module SafetyKit
|
|
|
161
170
|
#
|
|
162
171
|
# @param text [String] User-authored text SafetyKit should compare or analyze.
|
|
163
172
|
#
|
|
164
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
173
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UserContactEventRequest::Content::EventTextContent::Type] Text content part.
|
|
165
174
|
#
|
|
166
175
|
# @param key [String] Stable field key for this content part.
|
|
167
176
|
|
|
168
177
|
# Text content part.
|
|
169
178
|
#
|
|
170
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
179
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UserContactEventRequest::Content::EventTextContent#type
|
|
171
180
|
module Type
|
|
172
181
|
extend SafetyKit::Internal::Type::Enum
|
|
173
182
|
|
|
@@ -182,16 +191,16 @@ module SafetyKit
|
|
|
182
191
|
# @!attribute source
|
|
183
192
|
# Image source information.
|
|
184
193
|
#
|
|
185
|
-
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
194
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::UserContactEventRequest::Content::EventImageContent::Source]
|
|
186
195
|
required :source,
|
|
187
|
-
-> { SafetyKit::Beta::EventCreateParams::Body::
|
|
196
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::UserContactEventRequest::Content::EventImageContent::Source }
|
|
188
197
|
|
|
189
198
|
# @!attribute type
|
|
190
199
|
# Image content part.
|
|
191
200
|
#
|
|
192
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
201
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UserContactEventRequest::Content::EventImageContent::Type]
|
|
193
202
|
required :type,
|
|
194
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
203
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UserContactEventRequest::Content::EventImageContent::Type }
|
|
195
204
|
|
|
196
205
|
# @!attribute key
|
|
197
206
|
# Stable field key for this content part.
|
|
@@ -202,20 +211,20 @@ module SafetyKit
|
|
|
202
211
|
# @!method initialize(source:, type:, key: nil)
|
|
203
212
|
# User-uploaded image content associated with an event.
|
|
204
213
|
#
|
|
205
|
-
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
214
|
+
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::UserContactEventRequest::Content::EventImageContent::Source] Image source information.
|
|
206
215
|
#
|
|
207
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
216
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UserContactEventRequest::Content::EventImageContent::Type] Image content part.
|
|
208
217
|
#
|
|
209
218
|
# @param key [String] Stable field key for this content part.
|
|
210
219
|
|
|
211
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
220
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UserContactEventRequest::Content::EventImageContent#source
|
|
212
221
|
class Source < SafetyKit::Internal::Type::BaseModel
|
|
213
222
|
# @!attribute type
|
|
214
223
|
# URL image source.
|
|
215
224
|
#
|
|
216
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
225
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UserContactEventRequest::Content::EventImageContent::Source::Type]
|
|
217
226
|
required :type,
|
|
218
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
227
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UserContactEventRequest::Content::EventImageContent::Source::Type }
|
|
219
228
|
|
|
220
229
|
# @!attribute url
|
|
221
230
|
# URL of the image SafetyKit should compare or analyze.
|
|
@@ -226,13 +235,13 @@ module SafetyKit
|
|
|
226
235
|
# @!method initialize(type:, url:)
|
|
227
236
|
# Image source information.
|
|
228
237
|
#
|
|
229
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
238
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UserContactEventRequest::Content::EventImageContent::Source::Type] URL image source.
|
|
230
239
|
#
|
|
231
240
|
# @param url [String] URL of the image SafetyKit should compare or analyze.
|
|
232
241
|
|
|
233
242
|
# URL image source.
|
|
234
243
|
#
|
|
235
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
244
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UserContactEventRequest::Content::EventImageContent::Source#type
|
|
236
245
|
module Type
|
|
237
246
|
extend SafetyKit::Internal::Type::Enum
|
|
238
247
|
|
|
@@ -245,7 +254,7 @@ module SafetyKit
|
|
|
245
254
|
|
|
246
255
|
# Image content part.
|
|
247
256
|
#
|
|
248
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
257
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UserContactEventRequest::Content::EventImageContent#type
|
|
249
258
|
module Type
|
|
250
259
|
extend SafetyKit::Internal::Type::Enum
|
|
251
260
|
|
|
@@ -257,7 +266,7 @@ module SafetyKit
|
|
|
257
266
|
end
|
|
258
267
|
|
|
259
268
|
# @!method self.variants
|
|
260
|
-
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
269
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::UserContactEventRequest::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UserContactEventRequest::Content::EventImageContent)]
|
|
261
270
|
end
|
|
262
271
|
|
|
263
272
|
module Metadata
|
|
@@ -269,7 +278,7 @@ module SafetyKit
|
|
|
269
278
|
|
|
270
279
|
variant SafetyKit::Internal::Type::Boolean
|
|
271
280
|
|
|
272
|
-
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
281
|
+
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::UserContactEventRequest::Metadata::UnionMember3Array }
|
|
273
282
|
|
|
274
283
|
module UnionMember3
|
|
275
284
|
extend SafetyKit::Internal::Type::Union
|
|
@@ -290,7 +299,7 @@ module SafetyKit
|
|
|
290
299
|
# @type [SafetyKit::Internal::Type::Converter]
|
|
291
300
|
UnionMember3Array =
|
|
292
301
|
SafetyKit::Internal::Type::ArrayOf[union: -> {
|
|
293
|
-
SafetyKit::Beta::EventCreateParams::Body::
|
|
302
|
+
SafetyKit::Beta::EventCreateParams::Body::UserContactEventRequest::Metadata::UnionMember3
|
|
294
303
|
}]
|
|
295
304
|
end
|
|
296
305
|
|
|
@@ -304,14 +313,14 @@ module SafetyKit
|
|
|
304
313
|
|
|
305
314
|
# @!attribute value
|
|
306
315
|
# Resource value used during the event. SafetyKit stores a normalized hash of this
|
|
307
|
-
# value, not the raw value.
|
|
316
|
+
# value, not the raw value. When type is url, this must be a valid URL.
|
|
308
317
|
#
|
|
309
318
|
# @return [String]
|
|
310
319
|
required :value, String
|
|
311
320
|
|
|
312
321
|
# @!method initialize(type:, value:)
|
|
313
322
|
# Some parameter documentations has been truncated, see
|
|
314
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
323
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UserContactEventRequest::ResourcesUsed}
|
|
315
324
|
# for more details.
|
|
316
325
|
#
|
|
317
326
|
# Real-world or account resource used during the event, such as an email, phone
|
|
@@ -323,15 +332,15 @@ module SafetyKit
|
|
|
323
332
|
end
|
|
324
333
|
end
|
|
325
334
|
|
|
326
|
-
class
|
|
335
|
+
class ContentUploadedEventRequest < SafetyKit::Internal::Type::BaseModel
|
|
327
336
|
# @!attribute content
|
|
328
337
|
# User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
329
338
|
# listing text, image URLs, and similar content SafetyKit should compare or
|
|
330
339
|
# analyze.
|
|
331
340
|
#
|
|
332
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
341
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::ContentUploadedEventRequest::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::ContentUploadedEventRequest::Content::EventImageContent>]
|
|
333
342
|
required :content,
|
|
334
|
-
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
343
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::ContentUploadedEventRequest::Content] }
|
|
335
344
|
|
|
336
345
|
# @!attribute event_name
|
|
337
346
|
# Stable, low-cardinality product action name. Use snake_case and put dynamic
|
|
@@ -348,8 +357,8 @@ module SafetyKit
|
|
|
348
357
|
|
|
349
358
|
# @!attribute type
|
|
350
359
|
#
|
|
351
|
-
# @return [Symbol,
|
|
352
|
-
required :type,
|
|
360
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::ContentUploadedEventRequest::Type]
|
|
361
|
+
required :type, enum: -> { SafetyKit::Beta::EventCreateParams::Body::ContentUploadedEventRequest::Type }
|
|
353
362
|
|
|
354
363
|
# @!attribute user_id
|
|
355
364
|
# Your stable canonical identifier for the user or account.
|
|
@@ -363,47 +372,47 @@ module SafetyKit
|
|
|
363
372
|
#
|
|
364
373
|
# @return [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}, nil]
|
|
365
374
|
optional :metadata,
|
|
366
|
-
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
375
|
+
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::ContentUploadedEventRequest::Metadata] }
|
|
367
376
|
|
|
368
377
|
# @!attribute resources_used
|
|
369
378
|
# Reusable resources observed during the event. Use this for emails, phone
|
|
370
379
|
# numbers, names, addresses, social handles, URLs, payment identifiers, or similar
|
|
371
380
|
# identifiers.
|
|
372
381
|
#
|
|
373
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
382
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::ContentUploadedEventRequest::ResourcesUsed>, nil]
|
|
374
383
|
optional :resources_used,
|
|
375
|
-
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::
|
|
384
|
+
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::ContentUploadedEventRequest::ResourcesUsed] }
|
|
376
385
|
|
|
377
|
-
# @!method initialize(content:, event_name:, timestamp:, user_id:, metadata: nil, resources_used: nil
|
|
386
|
+
# @!method initialize(content:, event_name:, timestamp:, type:, user_id:, metadata: nil, resources_used: nil)
|
|
378
387
|
# Some parameter documentations has been truncated, see
|
|
379
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
380
|
-
# details.
|
|
388
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::ContentUploadedEventRequest}
|
|
389
|
+
# for more details.
|
|
381
390
|
#
|
|
382
391
|
# A user posts, uploads, publishes, edits, or replaces content.
|
|
383
392
|
#
|
|
384
|
-
# @param content [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
393
|
+
# @param content [Array<SafetyKit::Models::Beta::EventCreateParams::Body::ContentUploadedEventRequest::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::ContentUploadedEventRequest::Content::EventImageContent>] User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
385
394
|
#
|
|
386
395
|
# @param event_name [String] Stable, low-cardinality product action name. Use snake_case and put dynamic valu
|
|
387
396
|
#
|
|
388
397
|
# @param timestamp [Time] The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
389
398
|
#
|
|
399
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::ContentUploadedEventRequest::Type]
|
|
400
|
+
#
|
|
390
401
|
# @param user_id [String] Your stable canonical identifier for the user or account.
|
|
391
402
|
#
|
|
392
403
|
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
393
404
|
#
|
|
394
|
-
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
395
|
-
#
|
|
396
|
-
# @param type [Symbol, :content_uploaded]
|
|
405
|
+
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::ContentUploadedEventRequest::ResourcesUsed>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
397
406
|
|
|
398
407
|
# User-authored text content associated with an event.
|
|
399
408
|
module Content
|
|
400
409
|
extend SafetyKit::Internal::Type::Union
|
|
401
410
|
|
|
402
411
|
# User-authored text content associated with an event.
|
|
403
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
412
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::ContentUploadedEventRequest::Content::EventTextContent }
|
|
404
413
|
|
|
405
414
|
# User-uploaded image content associated with an event.
|
|
406
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
415
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::ContentUploadedEventRequest::Content::EventImageContent }
|
|
407
416
|
|
|
408
417
|
class EventTextContent < SafetyKit::Internal::Type::BaseModel
|
|
409
418
|
# @!attribute text
|
|
@@ -415,9 +424,9 @@ module SafetyKit
|
|
|
415
424
|
# @!attribute type
|
|
416
425
|
# Text content part.
|
|
417
426
|
#
|
|
418
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
427
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::ContentUploadedEventRequest::Content::EventTextContent::Type]
|
|
419
428
|
required :type,
|
|
420
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
429
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::ContentUploadedEventRequest::Content::EventTextContent::Type }
|
|
421
430
|
|
|
422
431
|
# @!attribute key
|
|
423
432
|
# Stable field key for this content part.
|
|
@@ -430,13 +439,13 @@ module SafetyKit
|
|
|
430
439
|
#
|
|
431
440
|
# @param text [String] User-authored text SafetyKit should compare or analyze.
|
|
432
441
|
#
|
|
433
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
442
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::ContentUploadedEventRequest::Content::EventTextContent::Type] Text content part.
|
|
434
443
|
#
|
|
435
444
|
# @param key [String] Stable field key for this content part.
|
|
436
445
|
|
|
437
446
|
# Text content part.
|
|
438
447
|
#
|
|
439
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
448
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::ContentUploadedEventRequest::Content::EventTextContent#type
|
|
440
449
|
module Type
|
|
441
450
|
extend SafetyKit::Internal::Type::Enum
|
|
442
451
|
|
|
@@ -451,16 +460,16 @@ module SafetyKit
|
|
|
451
460
|
# @!attribute source
|
|
452
461
|
# Image source information.
|
|
453
462
|
#
|
|
454
|
-
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
463
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::ContentUploadedEventRequest::Content::EventImageContent::Source]
|
|
455
464
|
required :source,
|
|
456
|
-
-> { SafetyKit::Beta::EventCreateParams::Body::
|
|
465
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::ContentUploadedEventRequest::Content::EventImageContent::Source }
|
|
457
466
|
|
|
458
467
|
# @!attribute type
|
|
459
468
|
# Image content part.
|
|
460
469
|
#
|
|
461
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
470
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::ContentUploadedEventRequest::Content::EventImageContent::Type]
|
|
462
471
|
required :type,
|
|
463
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
472
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::ContentUploadedEventRequest::Content::EventImageContent::Type }
|
|
464
473
|
|
|
465
474
|
# @!attribute key
|
|
466
475
|
# Stable field key for this content part.
|
|
@@ -471,20 +480,20 @@ module SafetyKit
|
|
|
471
480
|
# @!method initialize(source:, type:, key: nil)
|
|
472
481
|
# User-uploaded image content associated with an event.
|
|
473
482
|
#
|
|
474
|
-
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
483
|
+
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::ContentUploadedEventRequest::Content::EventImageContent::Source] Image source information.
|
|
475
484
|
#
|
|
476
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
485
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::ContentUploadedEventRequest::Content::EventImageContent::Type] Image content part.
|
|
477
486
|
#
|
|
478
487
|
# @param key [String] Stable field key for this content part.
|
|
479
488
|
|
|
480
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
489
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::ContentUploadedEventRequest::Content::EventImageContent#source
|
|
481
490
|
class Source < SafetyKit::Internal::Type::BaseModel
|
|
482
491
|
# @!attribute type
|
|
483
492
|
# URL image source.
|
|
484
493
|
#
|
|
485
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
494
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::ContentUploadedEventRequest::Content::EventImageContent::Source::Type]
|
|
486
495
|
required :type,
|
|
487
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
496
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::ContentUploadedEventRequest::Content::EventImageContent::Source::Type }
|
|
488
497
|
|
|
489
498
|
# @!attribute url
|
|
490
499
|
# URL of the image SafetyKit should compare or analyze.
|
|
@@ -495,13 +504,13 @@ module SafetyKit
|
|
|
495
504
|
# @!method initialize(type:, url:)
|
|
496
505
|
# Image source information.
|
|
497
506
|
#
|
|
498
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
507
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::ContentUploadedEventRequest::Content::EventImageContent::Source::Type] URL image source.
|
|
499
508
|
#
|
|
500
509
|
# @param url [String] URL of the image SafetyKit should compare or analyze.
|
|
501
510
|
|
|
502
511
|
# URL image source.
|
|
503
512
|
#
|
|
504
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
513
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::ContentUploadedEventRequest::Content::EventImageContent::Source#type
|
|
505
514
|
module Type
|
|
506
515
|
extend SafetyKit::Internal::Type::Enum
|
|
507
516
|
|
|
@@ -514,7 +523,7 @@ module SafetyKit
|
|
|
514
523
|
|
|
515
524
|
# Image content part.
|
|
516
525
|
#
|
|
517
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
526
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::ContentUploadedEventRequest::Content::EventImageContent#type
|
|
518
527
|
module Type
|
|
519
528
|
extend SafetyKit::Internal::Type::Enum
|
|
520
529
|
|
|
@@ -526,7 +535,17 @@ module SafetyKit
|
|
|
526
535
|
end
|
|
527
536
|
|
|
528
537
|
# @!method self.variants
|
|
529
|
-
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
538
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::ContentUploadedEventRequest::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::ContentUploadedEventRequest::Content::EventImageContent)]
|
|
539
|
+
end
|
|
540
|
+
|
|
541
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::ContentUploadedEventRequest#type
|
|
542
|
+
module Type
|
|
543
|
+
extend SafetyKit::Internal::Type::Enum
|
|
544
|
+
|
|
545
|
+
CONTENT_UPLOADED = :content_uploaded
|
|
546
|
+
|
|
547
|
+
# @!method self.values
|
|
548
|
+
# @return [Array<Symbol>]
|
|
530
549
|
end
|
|
531
550
|
|
|
532
551
|
module Metadata
|
|
@@ -538,7 +557,7 @@ module SafetyKit
|
|
|
538
557
|
|
|
539
558
|
variant SafetyKit::Internal::Type::Boolean
|
|
540
559
|
|
|
541
|
-
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
560
|
+
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::ContentUploadedEventRequest::Metadata::UnionMember3Array }
|
|
542
561
|
|
|
543
562
|
module UnionMember3
|
|
544
563
|
extend SafetyKit::Internal::Type::Union
|
|
@@ -558,9 +577,9 @@ module SafetyKit
|
|
|
558
577
|
|
|
559
578
|
# @type [SafetyKit::Internal::Type::Converter]
|
|
560
579
|
UnionMember3Array =
|
|
561
|
-
SafetyKit::Internal::Type::ArrayOf[
|
|
562
|
-
SafetyKit::Beta::EventCreateParams::Body::
|
|
563
|
-
|
|
580
|
+
SafetyKit::Internal::Type::ArrayOf[
|
|
581
|
+
union: -> { SafetyKit::Beta::EventCreateParams::Body::ContentUploadedEventRequest::Metadata::UnionMember3 }
|
|
582
|
+
]
|
|
564
583
|
end
|
|
565
584
|
|
|
566
585
|
class ResourcesUsed < SafetyKit::Internal::Type::BaseModel
|
|
@@ -573,14 +592,14 @@ module SafetyKit
|
|
|
573
592
|
|
|
574
593
|
# @!attribute value
|
|
575
594
|
# Resource value used during the event. SafetyKit stores a normalized hash of this
|
|
576
|
-
# value, not the raw value.
|
|
595
|
+
# value, not the raw value. When type is url, this must be a valid URL.
|
|
577
596
|
#
|
|
578
597
|
# @return [String]
|
|
579
598
|
required :value, String
|
|
580
599
|
|
|
581
600
|
# @!method initialize(type:, value:)
|
|
582
601
|
# Some parameter documentations has been truncated, see
|
|
583
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
602
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::ContentUploadedEventRequest::ResourcesUsed}
|
|
584
603
|
# for more details.
|
|
585
604
|
#
|
|
586
605
|
# Real-world or account resource used during the event, such as an email, phone
|
|
@@ -592,7 +611,7 @@ module SafetyKit
|
|
|
592
611
|
end
|
|
593
612
|
end
|
|
594
613
|
|
|
595
|
-
class
|
|
614
|
+
class CreateAccountEventRequest < SafetyKit::Internal::Type::BaseModel
|
|
596
615
|
# @!attribute event_name
|
|
597
616
|
# Stable, low-cardinality product action name. Use snake_case and put dynamic
|
|
598
617
|
# values in typed fields, content, resources_used, or metadata.
|
|
@@ -608,8 +627,8 @@ module SafetyKit
|
|
|
608
627
|
|
|
609
628
|
# @!attribute type
|
|
610
629
|
#
|
|
611
|
-
# @return [Symbol,
|
|
612
|
-
required :type,
|
|
630
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Type]
|
|
631
|
+
required :type, enum: -> { SafetyKit::Beta::EventCreateParams::Body::CreateAccountEventRequest::Type }
|
|
613
632
|
|
|
614
633
|
# @!attribute user_id
|
|
615
634
|
# Your stable canonical identifier for the user or account.
|
|
@@ -622,9 +641,9 @@ module SafetyKit
|
|
|
622
641
|
# listing text, image URLs, and similar content SafetyKit should compare or
|
|
623
642
|
# analyze.
|
|
624
643
|
#
|
|
625
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
644
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventImageContent>, nil]
|
|
626
645
|
optional :content,
|
|
627
|
-
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
646
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content] }
|
|
628
647
|
|
|
629
648
|
# @!attribute metadata
|
|
630
649
|
# Non-PII product context for filtering, segmentation, and debugging. Values may
|
|
@@ -632,21 +651,21 @@ module SafetyKit
|
|
|
632
651
|
#
|
|
633
652
|
# @return [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}, nil]
|
|
634
653
|
optional :metadata,
|
|
635
|
-
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
654
|
+
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::CreateAccountEventRequest::Metadata] }
|
|
636
655
|
|
|
637
656
|
# @!attribute resources_used
|
|
638
657
|
# Reusable resources observed during the event. Use this for emails, phone
|
|
639
658
|
# numbers, names, addresses, social handles, URLs, payment identifiers, or similar
|
|
640
659
|
# identifiers.
|
|
641
660
|
#
|
|
642
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
661
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::ResourcesUsed>, nil]
|
|
643
662
|
optional :resources_used,
|
|
644
|
-
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::
|
|
663
|
+
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::CreateAccountEventRequest::ResourcesUsed] }
|
|
645
664
|
|
|
646
|
-
# @!method initialize(event_name:, timestamp:, user_id:, content: nil, metadata: nil, resources_used: nil
|
|
665
|
+
# @!method initialize(event_name:, timestamp:, type:, user_id:, content: nil, metadata: nil, resources_used: nil)
|
|
647
666
|
# Some parameter documentations has been truncated, see
|
|
648
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
649
|
-
# details.
|
|
667
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest}
|
|
668
|
+
# for more details.
|
|
650
669
|
#
|
|
651
670
|
# A user or account is created.
|
|
652
671
|
#
|
|
@@ -654,25 +673,35 @@ module SafetyKit
|
|
|
654
673
|
#
|
|
655
674
|
# @param timestamp [Time] The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
656
675
|
#
|
|
676
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Type]
|
|
677
|
+
#
|
|
657
678
|
# @param user_id [String] Your stable canonical identifier for the user or account.
|
|
658
679
|
#
|
|
659
|
-
# @param content [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
680
|
+
# @param content [Array<SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventImageContent>] User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
660
681
|
#
|
|
661
682
|
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
662
683
|
#
|
|
663
|
-
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
664
|
-
|
|
665
|
-
#
|
|
684
|
+
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::ResourcesUsed>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
685
|
+
|
|
686
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest#type
|
|
687
|
+
module Type
|
|
688
|
+
extend SafetyKit::Internal::Type::Enum
|
|
689
|
+
|
|
690
|
+
CREATE_ACCOUNT = :create_account
|
|
691
|
+
|
|
692
|
+
# @!method self.values
|
|
693
|
+
# @return [Array<Symbol>]
|
|
694
|
+
end
|
|
666
695
|
|
|
667
696
|
# User-authored text content associated with an event.
|
|
668
697
|
module Content
|
|
669
698
|
extend SafetyKit::Internal::Type::Union
|
|
670
699
|
|
|
671
700
|
# User-authored text content associated with an event.
|
|
672
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
701
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventTextContent }
|
|
673
702
|
|
|
674
703
|
# User-uploaded image content associated with an event.
|
|
675
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
704
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventImageContent }
|
|
676
705
|
|
|
677
706
|
class EventTextContent < SafetyKit::Internal::Type::BaseModel
|
|
678
707
|
# @!attribute text
|
|
@@ -684,9 +713,9 @@ module SafetyKit
|
|
|
684
713
|
# @!attribute type
|
|
685
714
|
# Text content part.
|
|
686
715
|
#
|
|
687
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
716
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventTextContent::Type]
|
|
688
717
|
required :type,
|
|
689
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
718
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventTextContent::Type }
|
|
690
719
|
|
|
691
720
|
# @!attribute key
|
|
692
721
|
# Stable field key for this content part.
|
|
@@ -699,13 +728,13 @@ module SafetyKit
|
|
|
699
728
|
#
|
|
700
729
|
# @param text [String] User-authored text SafetyKit should compare or analyze.
|
|
701
730
|
#
|
|
702
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
731
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventTextContent::Type] Text content part.
|
|
703
732
|
#
|
|
704
733
|
# @param key [String] Stable field key for this content part.
|
|
705
734
|
|
|
706
735
|
# Text content part.
|
|
707
736
|
#
|
|
708
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
737
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventTextContent#type
|
|
709
738
|
module Type
|
|
710
739
|
extend SafetyKit::Internal::Type::Enum
|
|
711
740
|
|
|
@@ -720,16 +749,16 @@ module SafetyKit
|
|
|
720
749
|
# @!attribute source
|
|
721
750
|
# Image source information.
|
|
722
751
|
#
|
|
723
|
-
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
752
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventImageContent::Source]
|
|
724
753
|
required :source,
|
|
725
|
-
-> { SafetyKit::Beta::EventCreateParams::Body::
|
|
754
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventImageContent::Source }
|
|
726
755
|
|
|
727
756
|
# @!attribute type
|
|
728
757
|
# Image content part.
|
|
729
758
|
#
|
|
730
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
759
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventImageContent::Type]
|
|
731
760
|
required :type,
|
|
732
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
761
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventImageContent::Type }
|
|
733
762
|
|
|
734
763
|
# @!attribute key
|
|
735
764
|
# Stable field key for this content part.
|
|
@@ -740,20 +769,20 @@ module SafetyKit
|
|
|
740
769
|
# @!method initialize(source:, type:, key: nil)
|
|
741
770
|
# User-uploaded image content associated with an event.
|
|
742
771
|
#
|
|
743
|
-
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
772
|
+
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventImageContent::Source] Image source information.
|
|
744
773
|
#
|
|
745
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
774
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventImageContent::Type] Image content part.
|
|
746
775
|
#
|
|
747
776
|
# @param key [String] Stable field key for this content part.
|
|
748
777
|
|
|
749
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
778
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventImageContent#source
|
|
750
779
|
class Source < SafetyKit::Internal::Type::BaseModel
|
|
751
780
|
# @!attribute type
|
|
752
781
|
# URL image source.
|
|
753
782
|
#
|
|
754
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
783
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventImageContent::Source::Type]
|
|
755
784
|
required :type,
|
|
756
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
785
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventImageContent::Source::Type }
|
|
757
786
|
|
|
758
787
|
# @!attribute url
|
|
759
788
|
# URL of the image SafetyKit should compare or analyze.
|
|
@@ -764,13 +793,13 @@ module SafetyKit
|
|
|
764
793
|
# @!method initialize(type:, url:)
|
|
765
794
|
# Image source information.
|
|
766
795
|
#
|
|
767
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
796
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventImageContent::Source::Type] URL image source.
|
|
768
797
|
#
|
|
769
798
|
# @param url [String] URL of the image SafetyKit should compare or analyze.
|
|
770
799
|
|
|
771
800
|
# URL image source.
|
|
772
801
|
#
|
|
773
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
802
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventImageContent::Source#type
|
|
774
803
|
module Type
|
|
775
804
|
extend SafetyKit::Internal::Type::Enum
|
|
776
805
|
|
|
@@ -783,7 +812,7 @@ module SafetyKit
|
|
|
783
812
|
|
|
784
813
|
# Image content part.
|
|
785
814
|
#
|
|
786
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
815
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventImageContent#type
|
|
787
816
|
module Type
|
|
788
817
|
extend SafetyKit::Internal::Type::Enum
|
|
789
818
|
|
|
@@ -795,7 +824,7 @@ module SafetyKit
|
|
|
795
824
|
end
|
|
796
825
|
|
|
797
826
|
# @!method self.variants
|
|
798
|
-
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
827
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventImageContent)]
|
|
799
828
|
end
|
|
800
829
|
|
|
801
830
|
module Metadata
|
|
@@ -807,7 +836,7 @@ module SafetyKit
|
|
|
807
836
|
|
|
808
837
|
variant SafetyKit::Internal::Type::Boolean
|
|
809
838
|
|
|
810
|
-
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
839
|
+
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Metadata::UnionMember3Array }
|
|
811
840
|
|
|
812
841
|
module UnionMember3
|
|
813
842
|
extend SafetyKit::Internal::Type::Union
|
|
@@ -828,7 +857,7 @@ module SafetyKit
|
|
|
828
857
|
# @type [SafetyKit::Internal::Type::Converter]
|
|
829
858
|
UnionMember3Array =
|
|
830
859
|
SafetyKit::Internal::Type::ArrayOf[union: -> {
|
|
831
|
-
SafetyKit::Beta::EventCreateParams::Body::
|
|
860
|
+
SafetyKit::Beta::EventCreateParams::Body::CreateAccountEventRequest::Metadata::UnionMember3
|
|
832
861
|
}]
|
|
833
862
|
end
|
|
834
863
|
|
|
@@ -842,14 +871,14 @@ module SafetyKit
|
|
|
842
871
|
|
|
843
872
|
# @!attribute value
|
|
844
873
|
# Resource value used during the event. SafetyKit stores a normalized hash of this
|
|
845
|
-
# value, not the raw value.
|
|
874
|
+
# value, not the raw value. When type is url, this must be a valid URL.
|
|
846
875
|
#
|
|
847
876
|
# @return [String]
|
|
848
877
|
required :value, String
|
|
849
878
|
|
|
850
879
|
# @!method initialize(type:, value:)
|
|
851
880
|
# Some parameter documentations has been truncated, see
|
|
852
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
881
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::ResourcesUsed}
|
|
853
882
|
# for more details.
|
|
854
883
|
#
|
|
855
884
|
# Real-world or account resource used during the event, such as an email, phone
|
|
@@ -861,7 +890,7 @@ module SafetyKit
|
|
|
861
890
|
end
|
|
862
891
|
end
|
|
863
892
|
|
|
864
|
-
class
|
|
893
|
+
class UpdateAccountEventRequest < SafetyKit::Internal::Type::BaseModel
|
|
865
894
|
# @!attribute event_name
|
|
866
895
|
# Stable, low-cardinality product action name. Use snake_case and put dynamic
|
|
867
896
|
# values in typed fields, content, resources_used, or metadata.
|
|
@@ -877,8 +906,8 @@ module SafetyKit
|
|
|
877
906
|
|
|
878
907
|
# @!attribute type
|
|
879
908
|
#
|
|
880
|
-
# @return [Symbol,
|
|
881
|
-
required :type,
|
|
909
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Type]
|
|
910
|
+
required :type, enum: -> { SafetyKit::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Type }
|
|
882
911
|
|
|
883
912
|
# @!attribute user_id
|
|
884
913
|
# Your stable canonical identifier for the user or account.
|
|
@@ -891,9 +920,9 @@ module SafetyKit
|
|
|
891
920
|
# listing text, image URLs, and similar content SafetyKit should compare or
|
|
892
921
|
# analyze.
|
|
893
922
|
#
|
|
894
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
923
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventImageContent>, nil]
|
|
895
924
|
optional :content,
|
|
896
|
-
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
925
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content] }
|
|
897
926
|
|
|
898
927
|
# @!attribute metadata
|
|
899
928
|
# Non-PII product context for filtering, segmentation, and debugging. Values may
|
|
@@ -901,21 +930,21 @@ module SafetyKit
|
|
|
901
930
|
#
|
|
902
931
|
# @return [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}, nil]
|
|
903
932
|
optional :metadata,
|
|
904
|
-
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
933
|
+
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Metadata] }
|
|
905
934
|
|
|
906
935
|
# @!attribute resources_used
|
|
907
936
|
# Reusable resources observed during the event. Use this for emails, phone
|
|
908
937
|
# numbers, names, addresses, social handles, URLs, payment identifiers, or similar
|
|
909
938
|
# identifiers.
|
|
910
939
|
#
|
|
911
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
940
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::ResourcesUsed>, nil]
|
|
912
941
|
optional :resources_used,
|
|
913
|
-
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::
|
|
942
|
+
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::UpdateAccountEventRequest::ResourcesUsed] }
|
|
914
943
|
|
|
915
|
-
# @!method initialize(event_name:, timestamp:, user_id:, content: nil, metadata: nil, resources_used: nil
|
|
944
|
+
# @!method initialize(event_name:, timestamp:, type:, user_id:, content: nil, metadata: nil, resources_used: nil)
|
|
916
945
|
# Some parameter documentations has been truncated, see
|
|
917
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
918
|
-
# details.
|
|
946
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest}
|
|
947
|
+
# for more details.
|
|
919
948
|
#
|
|
920
949
|
# A user or account profile, contact detail, payment detail, or public bio
|
|
921
950
|
# changes.
|
|
@@ -924,25 +953,35 @@ module SafetyKit
|
|
|
924
953
|
#
|
|
925
954
|
# @param timestamp [Time] The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
926
955
|
#
|
|
956
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Type]
|
|
957
|
+
#
|
|
927
958
|
# @param user_id [String] Your stable canonical identifier for the user or account.
|
|
928
959
|
#
|
|
929
|
-
# @param content [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
960
|
+
# @param content [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventImageContent>] User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
930
961
|
#
|
|
931
962
|
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
932
963
|
#
|
|
933
|
-
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
934
|
-
|
|
935
|
-
#
|
|
964
|
+
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::ResourcesUsed>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
965
|
+
|
|
966
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest#type
|
|
967
|
+
module Type
|
|
968
|
+
extend SafetyKit::Internal::Type::Enum
|
|
969
|
+
|
|
970
|
+
UPDATE_ACCOUNT = :update_account
|
|
971
|
+
|
|
972
|
+
# @!method self.values
|
|
973
|
+
# @return [Array<Symbol>]
|
|
974
|
+
end
|
|
936
975
|
|
|
937
976
|
# User-authored text content associated with an event.
|
|
938
977
|
module Content
|
|
939
978
|
extend SafetyKit::Internal::Type::Union
|
|
940
979
|
|
|
941
980
|
# User-authored text content associated with an event.
|
|
942
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
981
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventTextContent }
|
|
943
982
|
|
|
944
983
|
# User-uploaded image content associated with an event.
|
|
945
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
984
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventImageContent }
|
|
946
985
|
|
|
947
986
|
class EventTextContent < SafetyKit::Internal::Type::BaseModel
|
|
948
987
|
# @!attribute text
|
|
@@ -954,9 +993,9 @@ module SafetyKit
|
|
|
954
993
|
# @!attribute type
|
|
955
994
|
# Text content part.
|
|
956
995
|
#
|
|
957
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
996
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventTextContent::Type]
|
|
958
997
|
required :type,
|
|
959
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
998
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventTextContent::Type }
|
|
960
999
|
|
|
961
1000
|
# @!attribute key
|
|
962
1001
|
# Stable field key for this content part.
|
|
@@ -969,13 +1008,13 @@ module SafetyKit
|
|
|
969
1008
|
#
|
|
970
1009
|
# @param text [String] User-authored text SafetyKit should compare or analyze.
|
|
971
1010
|
#
|
|
972
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1011
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventTextContent::Type] Text content part.
|
|
973
1012
|
#
|
|
974
1013
|
# @param key [String] Stable field key for this content part.
|
|
975
1014
|
|
|
976
1015
|
# Text content part.
|
|
977
1016
|
#
|
|
978
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1017
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventTextContent#type
|
|
979
1018
|
module Type
|
|
980
1019
|
extend SafetyKit::Internal::Type::Enum
|
|
981
1020
|
|
|
@@ -990,16 +1029,16 @@ module SafetyKit
|
|
|
990
1029
|
# @!attribute source
|
|
991
1030
|
# Image source information.
|
|
992
1031
|
#
|
|
993
|
-
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1032
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventImageContent::Source]
|
|
994
1033
|
required :source,
|
|
995
|
-
-> { SafetyKit::Beta::EventCreateParams::Body::
|
|
1034
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventImageContent::Source }
|
|
996
1035
|
|
|
997
1036
|
# @!attribute type
|
|
998
1037
|
# Image content part.
|
|
999
1038
|
#
|
|
1000
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1039
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventImageContent::Type]
|
|
1001
1040
|
required :type,
|
|
1002
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
1041
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventImageContent::Type }
|
|
1003
1042
|
|
|
1004
1043
|
# @!attribute key
|
|
1005
1044
|
# Stable field key for this content part.
|
|
@@ -1010,20 +1049,20 @@ module SafetyKit
|
|
|
1010
1049
|
# @!method initialize(source:, type:, key: nil)
|
|
1011
1050
|
# User-uploaded image content associated with an event.
|
|
1012
1051
|
#
|
|
1013
|
-
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1052
|
+
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventImageContent::Source] Image source information.
|
|
1014
1053
|
#
|
|
1015
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1054
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventImageContent::Type] Image content part.
|
|
1016
1055
|
#
|
|
1017
1056
|
# @param key [String] Stable field key for this content part.
|
|
1018
1057
|
|
|
1019
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1058
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventImageContent#source
|
|
1020
1059
|
class Source < SafetyKit::Internal::Type::BaseModel
|
|
1021
1060
|
# @!attribute type
|
|
1022
1061
|
# URL image source.
|
|
1023
1062
|
#
|
|
1024
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1063
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventImageContent::Source::Type]
|
|
1025
1064
|
required :type,
|
|
1026
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
1065
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventImageContent::Source::Type }
|
|
1027
1066
|
|
|
1028
1067
|
# @!attribute url
|
|
1029
1068
|
# URL of the image SafetyKit should compare or analyze.
|
|
@@ -1034,13 +1073,13 @@ module SafetyKit
|
|
|
1034
1073
|
# @!method initialize(type:, url:)
|
|
1035
1074
|
# Image source information.
|
|
1036
1075
|
#
|
|
1037
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1076
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventImageContent::Source::Type] URL image source.
|
|
1038
1077
|
#
|
|
1039
1078
|
# @param url [String] URL of the image SafetyKit should compare or analyze.
|
|
1040
1079
|
|
|
1041
1080
|
# URL image source.
|
|
1042
1081
|
#
|
|
1043
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1082
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventImageContent::Source#type
|
|
1044
1083
|
module Type
|
|
1045
1084
|
extend SafetyKit::Internal::Type::Enum
|
|
1046
1085
|
|
|
@@ -1053,7 +1092,7 @@ module SafetyKit
|
|
|
1053
1092
|
|
|
1054
1093
|
# Image content part.
|
|
1055
1094
|
#
|
|
1056
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1095
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventImageContent#type
|
|
1057
1096
|
module Type
|
|
1058
1097
|
extend SafetyKit::Internal::Type::Enum
|
|
1059
1098
|
|
|
@@ -1065,7 +1104,7 @@ module SafetyKit
|
|
|
1065
1104
|
end
|
|
1066
1105
|
|
|
1067
1106
|
# @!method self.variants
|
|
1068
|
-
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1107
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventImageContent)]
|
|
1069
1108
|
end
|
|
1070
1109
|
|
|
1071
1110
|
module Metadata
|
|
@@ -1077,7 +1116,7 @@ module SafetyKit
|
|
|
1077
1116
|
|
|
1078
1117
|
variant SafetyKit::Internal::Type::Boolean
|
|
1079
1118
|
|
|
1080
|
-
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1119
|
+
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Metadata::UnionMember3Array }
|
|
1081
1120
|
|
|
1082
1121
|
module UnionMember3
|
|
1083
1122
|
extend SafetyKit::Internal::Type::Union
|
|
@@ -1098,7 +1137,7 @@ module SafetyKit
|
|
|
1098
1137
|
# @type [SafetyKit::Internal::Type::Converter]
|
|
1099
1138
|
UnionMember3Array =
|
|
1100
1139
|
SafetyKit::Internal::Type::ArrayOf[union: -> {
|
|
1101
|
-
SafetyKit::Beta::EventCreateParams::Body::
|
|
1140
|
+
SafetyKit::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Metadata::UnionMember3
|
|
1102
1141
|
}]
|
|
1103
1142
|
end
|
|
1104
1143
|
|
|
@@ -1112,14 +1151,14 @@ module SafetyKit
|
|
|
1112
1151
|
|
|
1113
1152
|
# @!attribute value
|
|
1114
1153
|
# Resource value used during the event. SafetyKit stores a normalized hash of this
|
|
1115
|
-
# value, not the raw value.
|
|
1154
|
+
# value, not the raw value. When type is url, this must be a valid URL.
|
|
1116
1155
|
#
|
|
1117
1156
|
# @return [String]
|
|
1118
1157
|
required :value, String
|
|
1119
1158
|
|
|
1120
1159
|
# @!method initialize(type:, value:)
|
|
1121
1160
|
# Some parameter documentations has been truncated, see
|
|
1122
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1161
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::ResourcesUsed}
|
|
1123
1162
|
# for more details.
|
|
1124
1163
|
#
|
|
1125
1164
|
# Real-world or account resource used during the event, such as an email, phone
|
|
@@ -1131,8 +1170,1122 @@ module SafetyKit
|
|
|
1131
1170
|
end
|
|
1132
1171
|
end
|
|
1133
1172
|
|
|
1173
|
+
# A user contacts, transacts with, or otherwise interacts with another user.
|
|
1174
|
+
module UnionMember4
|
|
1175
|
+
extend SafetyKit::Internal::Type::Union
|
|
1176
|
+
|
|
1177
|
+
discriminator :type
|
|
1178
|
+
|
|
1179
|
+
# A user contacts, transacts with, or otherwise interacts with another user.
|
|
1180
|
+
variant :user_contact, -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember4::UserContact }
|
|
1181
|
+
|
|
1182
|
+
# A user posts, uploads, publishes, edits, or replaces content.
|
|
1183
|
+
variant :content_uploaded, -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember4::ContentUploaded }
|
|
1184
|
+
|
|
1185
|
+
# A user or account is created.
|
|
1186
|
+
variant :create_account, -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember4::CreateAccount }
|
|
1187
|
+
|
|
1188
|
+
# A user or account profile, contact detail, payment detail, or public bio changes.
|
|
1189
|
+
variant :update_account, -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember4::UpdateAccount }
|
|
1190
|
+
|
|
1191
|
+
class UserContact < SafetyKit::Internal::Type::BaseModel
|
|
1192
|
+
# @!attribute counterparty_user_id
|
|
1193
|
+
# Your stable canonical identifier for the other user in a user-to-user
|
|
1194
|
+
# interaction.
|
|
1195
|
+
#
|
|
1196
|
+
# @return [String]
|
|
1197
|
+
required :counterparty_user_id, String
|
|
1198
|
+
|
|
1199
|
+
# @!attribute event_name
|
|
1200
|
+
# Stable, low-cardinality product action name. Use snake_case and put dynamic
|
|
1201
|
+
# values in typed fields, content, resources_used, or metadata.
|
|
1202
|
+
#
|
|
1203
|
+
# @return [String]
|
|
1204
|
+
required :event_name, String
|
|
1205
|
+
|
|
1206
|
+
# @!attribute timestamp
|
|
1207
|
+
# The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
1208
|
+
#
|
|
1209
|
+
# @return [Time]
|
|
1210
|
+
required :timestamp, Time
|
|
1211
|
+
|
|
1212
|
+
# @!attribute type
|
|
1213
|
+
#
|
|
1214
|
+
# @return [Symbol, :user_contact]
|
|
1215
|
+
required :type, const: :user_contact
|
|
1216
|
+
|
|
1217
|
+
# @!attribute user_id
|
|
1218
|
+
# Your stable canonical identifier for the user or account.
|
|
1219
|
+
#
|
|
1220
|
+
# @return [String]
|
|
1221
|
+
required :user_id, String
|
|
1222
|
+
|
|
1223
|
+
# @!attribute content
|
|
1224
|
+
# User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
1225
|
+
# listing text, image URLs, and similar content SafetyKit should compare or
|
|
1226
|
+
# analyze.
|
|
1227
|
+
#
|
|
1228
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::UserContact::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::UserContact::Content::EventImageContent>, nil]
|
|
1229
|
+
optional :content,
|
|
1230
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember4::UserContact::Content] }
|
|
1231
|
+
|
|
1232
|
+
# @!attribute metadata
|
|
1233
|
+
# Non-PII product context for filtering, segmentation, and debugging. Values may
|
|
1234
|
+
# be strings, numbers, booleans, or arrays of those scalar values.
|
|
1235
|
+
#
|
|
1236
|
+
# @return [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}, nil]
|
|
1237
|
+
optional :metadata,
|
|
1238
|
+
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember4::UserContact::Metadata] }
|
|
1239
|
+
|
|
1240
|
+
# @!attribute resources_used
|
|
1241
|
+
# Reusable resources observed during the event. Use this for emails, phone
|
|
1242
|
+
# numbers, names, addresses, social handles, URLs, payment identifiers, or similar
|
|
1243
|
+
# identifiers.
|
|
1244
|
+
#
|
|
1245
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::UserContact::ResourcesUsed>, nil]
|
|
1246
|
+
optional :resources_used,
|
|
1247
|
+
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::UnionMember4::UserContact::ResourcesUsed] }
|
|
1248
|
+
|
|
1249
|
+
# @!method initialize(counterparty_user_id:, event_name:, timestamp:, user_id:, content: nil, metadata: nil, resources_used: nil, type: :user_contact)
|
|
1250
|
+
# Some parameter documentations has been truncated, see
|
|
1251
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::UserContact}
|
|
1252
|
+
# for more details.
|
|
1253
|
+
#
|
|
1254
|
+
# A user contacts, transacts with, or otherwise interacts with another user.
|
|
1255
|
+
#
|
|
1256
|
+
# @param counterparty_user_id [String] Your stable canonical identifier for the other user in a user-to-user interactio
|
|
1257
|
+
#
|
|
1258
|
+
# @param event_name [String] Stable, low-cardinality product action name. Use snake_case and put dynamic valu
|
|
1259
|
+
#
|
|
1260
|
+
# @param timestamp [Time] The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
1261
|
+
#
|
|
1262
|
+
# @param user_id [String] Your stable canonical identifier for the user or account.
|
|
1263
|
+
#
|
|
1264
|
+
# @param content [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::UserContact::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::UserContact::Content::EventImageContent>] User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
1265
|
+
#
|
|
1266
|
+
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
1267
|
+
#
|
|
1268
|
+
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::UserContact::ResourcesUsed>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
1269
|
+
#
|
|
1270
|
+
# @param type [Symbol, :user_contact]
|
|
1271
|
+
|
|
1272
|
+
# User-authored text content associated with an event.
|
|
1273
|
+
module Content
|
|
1274
|
+
extend SafetyKit::Internal::Type::Union
|
|
1275
|
+
|
|
1276
|
+
# User-authored text content associated with an event.
|
|
1277
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember4::UserContact::Content::EventTextContent }
|
|
1278
|
+
|
|
1279
|
+
# User-uploaded image content associated with an event.
|
|
1280
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember4::UserContact::Content::EventImageContent }
|
|
1281
|
+
|
|
1282
|
+
class EventTextContent < SafetyKit::Internal::Type::BaseModel
|
|
1283
|
+
# @!attribute text
|
|
1284
|
+
# User-authored text SafetyKit should compare or analyze.
|
|
1285
|
+
#
|
|
1286
|
+
# @return [String]
|
|
1287
|
+
required :text, String
|
|
1288
|
+
|
|
1289
|
+
# @!attribute type
|
|
1290
|
+
# Text content part.
|
|
1291
|
+
#
|
|
1292
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::UserContact::Content::EventTextContent::Type]
|
|
1293
|
+
required :type,
|
|
1294
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember4::UserContact::Content::EventTextContent::Type }
|
|
1295
|
+
|
|
1296
|
+
# @!attribute key
|
|
1297
|
+
# Stable field key for this content part.
|
|
1298
|
+
#
|
|
1299
|
+
# @return [String, nil]
|
|
1300
|
+
optional :key, String
|
|
1301
|
+
|
|
1302
|
+
# @!method initialize(text:, type:, key: nil)
|
|
1303
|
+
# User-authored text content associated with an event.
|
|
1304
|
+
#
|
|
1305
|
+
# @param text [String] User-authored text SafetyKit should compare or analyze.
|
|
1306
|
+
#
|
|
1307
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::UserContact::Content::EventTextContent::Type] Text content part.
|
|
1308
|
+
#
|
|
1309
|
+
# @param key [String] Stable field key for this content part.
|
|
1310
|
+
|
|
1311
|
+
# Text content part.
|
|
1312
|
+
#
|
|
1313
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::UserContact::Content::EventTextContent#type
|
|
1314
|
+
module Type
|
|
1315
|
+
extend SafetyKit::Internal::Type::Enum
|
|
1316
|
+
|
|
1317
|
+
TEXT = :text
|
|
1318
|
+
|
|
1319
|
+
# @!method self.values
|
|
1320
|
+
# @return [Array<Symbol>]
|
|
1321
|
+
end
|
|
1322
|
+
end
|
|
1323
|
+
|
|
1324
|
+
class EventImageContent < SafetyKit::Internal::Type::BaseModel
|
|
1325
|
+
# @!attribute source
|
|
1326
|
+
# Image source information.
|
|
1327
|
+
#
|
|
1328
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::UserContact::Content::EventImageContent::Source]
|
|
1329
|
+
required :source,
|
|
1330
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::UnionMember4::UserContact::Content::EventImageContent::Source }
|
|
1331
|
+
|
|
1332
|
+
# @!attribute type
|
|
1333
|
+
# Image content part.
|
|
1334
|
+
#
|
|
1335
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::UserContact::Content::EventImageContent::Type]
|
|
1336
|
+
required :type,
|
|
1337
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember4::UserContact::Content::EventImageContent::Type }
|
|
1338
|
+
|
|
1339
|
+
# @!attribute key
|
|
1340
|
+
# Stable field key for this content part.
|
|
1341
|
+
#
|
|
1342
|
+
# @return [String, nil]
|
|
1343
|
+
optional :key, String
|
|
1344
|
+
|
|
1345
|
+
# @!method initialize(source:, type:, key: nil)
|
|
1346
|
+
# User-uploaded image content associated with an event.
|
|
1347
|
+
#
|
|
1348
|
+
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::UserContact::Content::EventImageContent::Source] Image source information.
|
|
1349
|
+
#
|
|
1350
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::UserContact::Content::EventImageContent::Type] Image content part.
|
|
1351
|
+
#
|
|
1352
|
+
# @param key [String] Stable field key for this content part.
|
|
1353
|
+
|
|
1354
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::UserContact::Content::EventImageContent#source
|
|
1355
|
+
class Source < SafetyKit::Internal::Type::BaseModel
|
|
1356
|
+
# @!attribute type
|
|
1357
|
+
# URL image source.
|
|
1358
|
+
#
|
|
1359
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::UserContact::Content::EventImageContent::Source::Type]
|
|
1360
|
+
required :type,
|
|
1361
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember4::UserContact::Content::EventImageContent::Source::Type }
|
|
1362
|
+
|
|
1363
|
+
# @!attribute url
|
|
1364
|
+
# URL of the image SafetyKit should compare or analyze.
|
|
1365
|
+
#
|
|
1366
|
+
# @return [String]
|
|
1367
|
+
required :url, String
|
|
1368
|
+
|
|
1369
|
+
# @!method initialize(type:, url:)
|
|
1370
|
+
# Image source information.
|
|
1371
|
+
#
|
|
1372
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::UserContact::Content::EventImageContent::Source::Type] URL image source.
|
|
1373
|
+
#
|
|
1374
|
+
# @param url [String] URL of the image SafetyKit should compare or analyze.
|
|
1375
|
+
|
|
1376
|
+
# URL image source.
|
|
1377
|
+
#
|
|
1378
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::UserContact::Content::EventImageContent::Source#type
|
|
1379
|
+
module Type
|
|
1380
|
+
extend SafetyKit::Internal::Type::Enum
|
|
1381
|
+
|
|
1382
|
+
URL = :url
|
|
1383
|
+
|
|
1384
|
+
# @!method self.values
|
|
1385
|
+
# @return [Array<Symbol>]
|
|
1386
|
+
end
|
|
1387
|
+
end
|
|
1388
|
+
|
|
1389
|
+
# Image content part.
|
|
1390
|
+
#
|
|
1391
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::UserContact::Content::EventImageContent#type
|
|
1392
|
+
module Type
|
|
1393
|
+
extend SafetyKit::Internal::Type::Enum
|
|
1394
|
+
|
|
1395
|
+
IMAGE = :image
|
|
1396
|
+
|
|
1397
|
+
# @!method self.values
|
|
1398
|
+
# @return [Array<Symbol>]
|
|
1399
|
+
end
|
|
1400
|
+
end
|
|
1401
|
+
|
|
1402
|
+
# @!method self.variants
|
|
1403
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::UserContact::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::UserContact::Content::EventImageContent)]
|
|
1404
|
+
end
|
|
1405
|
+
|
|
1406
|
+
module Metadata
|
|
1407
|
+
extend SafetyKit::Internal::Type::Union
|
|
1408
|
+
|
|
1409
|
+
variant String
|
|
1410
|
+
|
|
1411
|
+
variant Float
|
|
1412
|
+
|
|
1413
|
+
variant SafetyKit::Internal::Type::Boolean
|
|
1414
|
+
|
|
1415
|
+
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::UserContact::Metadata::UnionMember3Array }
|
|
1416
|
+
|
|
1417
|
+
module UnionMember3
|
|
1418
|
+
extend SafetyKit::Internal::Type::Union
|
|
1419
|
+
|
|
1420
|
+
variant String
|
|
1421
|
+
|
|
1422
|
+
variant Float
|
|
1423
|
+
|
|
1424
|
+
variant SafetyKit::Internal::Type::Boolean
|
|
1425
|
+
|
|
1426
|
+
# @!method self.variants
|
|
1427
|
+
# @return [Array(String, Float, Boolean)]
|
|
1428
|
+
end
|
|
1429
|
+
|
|
1430
|
+
# @!method self.variants
|
|
1431
|
+
# @return [Array(String, Float, Boolean, Array<String, Float, Boolean>)]
|
|
1432
|
+
|
|
1433
|
+
# @type [SafetyKit::Internal::Type::Converter]
|
|
1434
|
+
UnionMember3Array =
|
|
1435
|
+
SafetyKit::Internal::Type::ArrayOf[union: -> {
|
|
1436
|
+
SafetyKit::Beta::EventCreateParams::Body::UnionMember4::UserContact::Metadata::UnionMember3
|
|
1437
|
+
}]
|
|
1438
|
+
end
|
|
1439
|
+
|
|
1440
|
+
class ResourcesUsed < SafetyKit::Internal::Type::BaseModel
|
|
1441
|
+
# @!attribute type
|
|
1442
|
+
# Resource family, such as email, phone, name, address, url, instagram, tiktok,
|
|
1443
|
+
# youtube, linkedin, or another stable snake_case identifier.
|
|
1444
|
+
#
|
|
1445
|
+
# @return [String]
|
|
1446
|
+
required :type, String
|
|
1447
|
+
|
|
1448
|
+
# @!attribute value
|
|
1449
|
+
# Resource value used during the event. SafetyKit stores a normalized hash of this
|
|
1450
|
+
# value, not the raw value. When type is url, this must be a valid URL.
|
|
1451
|
+
#
|
|
1452
|
+
# @return [String]
|
|
1453
|
+
required :value, String
|
|
1454
|
+
|
|
1455
|
+
# @!method initialize(type:, value:)
|
|
1456
|
+
# Some parameter documentations has been truncated, see
|
|
1457
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::UserContact::ResourcesUsed}
|
|
1458
|
+
# for more details.
|
|
1459
|
+
#
|
|
1460
|
+
# Real-world or account resource used during the event, such as an email, phone
|
|
1461
|
+
# number, address, URL, social handle, or payment identifier.
|
|
1462
|
+
#
|
|
1463
|
+
# @param type [String] Resource family, such as email, phone, name, address, url, instagram, tiktok, yo
|
|
1464
|
+
#
|
|
1465
|
+
# @param value [String] Resource value used during the event. SafetyKit stores a normalized hash of this
|
|
1466
|
+
end
|
|
1467
|
+
end
|
|
1468
|
+
|
|
1469
|
+
class ContentUploaded < SafetyKit::Internal::Type::BaseModel
|
|
1470
|
+
# @!attribute content
|
|
1471
|
+
# User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
1472
|
+
# listing text, image URLs, and similar content SafetyKit should compare or
|
|
1473
|
+
# analyze.
|
|
1474
|
+
#
|
|
1475
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::ContentUploaded::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::ContentUploaded::Content::EventImageContent>]
|
|
1476
|
+
required :content,
|
|
1477
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember4::ContentUploaded::Content] }
|
|
1478
|
+
|
|
1479
|
+
# @!attribute event_name
|
|
1480
|
+
# Stable, low-cardinality product action name. Use snake_case and put dynamic
|
|
1481
|
+
# values in typed fields, content, resources_used, or metadata.
|
|
1482
|
+
#
|
|
1483
|
+
# @return [String]
|
|
1484
|
+
required :event_name, String
|
|
1485
|
+
|
|
1486
|
+
# @!attribute timestamp
|
|
1487
|
+
# The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
1488
|
+
#
|
|
1489
|
+
# @return [Time]
|
|
1490
|
+
required :timestamp, Time
|
|
1491
|
+
|
|
1492
|
+
# @!attribute type
|
|
1493
|
+
#
|
|
1494
|
+
# @return [Symbol, :content_uploaded]
|
|
1495
|
+
required :type, const: :content_uploaded
|
|
1496
|
+
|
|
1497
|
+
# @!attribute user_id
|
|
1498
|
+
# Your stable canonical identifier for the user or account.
|
|
1499
|
+
#
|
|
1500
|
+
# @return [String]
|
|
1501
|
+
required :user_id, String
|
|
1502
|
+
|
|
1503
|
+
# @!attribute metadata
|
|
1504
|
+
# Non-PII product context for filtering, segmentation, and debugging. Values may
|
|
1505
|
+
# be strings, numbers, booleans, or arrays of those scalar values.
|
|
1506
|
+
#
|
|
1507
|
+
# @return [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}, nil]
|
|
1508
|
+
optional :metadata,
|
|
1509
|
+
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember4::ContentUploaded::Metadata] }
|
|
1510
|
+
|
|
1511
|
+
# @!attribute resources_used
|
|
1512
|
+
# Reusable resources observed during the event. Use this for emails, phone
|
|
1513
|
+
# numbers, names, addresses, social handles, URLs, payment identifiers, or similar
|
|
1514
|
+
# identifiers.
|
|
1515
|
+
#
|
|
1516
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::ContentUploaded::ResourcesUsed>, nil]
|
|
1517
|
+
optional :resources_used,
|
|
1518
|
+
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::UnionMember4::ContentUploaded::ResourcesUsed] }
|
|
1519
|
+
|
|
1520
|
+
# @!method initialize(content:, event_name:, timestamp:, user_id:, metadata: nil, resources_used: nil, type: :content_uploaded)
|
|
1521
|
+
# Some parameter documentations has been truncated, see
|
|
1522
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::ContentUploaded}
|
|
1523
|
+
# for more details.
|
|
1524
|
+
#
|
|
1525
|
+
# A user posts, uploads, publishes, edits, or replaces content.
|
|
1526
|
+
#
|
|
1527
|
+
# @param content [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::ContentUploaded::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::ContentUploaded::Content::EventImageContent>] User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
1528
|
+
#
|
|
1529
|
+
# @param event_name [String] Stable, low-cardinality product action name. Use snake_case and put dynamic valu
|
|
1530
|
+
#
|
|
1531
|
+
# @param timestamp [Time] The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
1532
|
+
#
|
|
1533
|
+
# @param user_id [String] Your stable canonical identifier for the user or account.
|
|
1534
|
+
#
|
|
1535
|
+
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
1536
|
+
#
|
|
1537
|
+
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::ContentUploaded::ResourcesUsed>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
1538
|
+
#
|
|
1539
|
+
# @param type [Symbol, :content_uploaded]
|
|
1540
|
+
|
|
1541
|
+
# User-authored text content associated with an event.
|
|
1542
|
+
module Content
|
|
1543
|
+
extend SafetyKit::Internal::Type::Union
|
|
1544
|
+
|
|
1545
|
+
# User-authored text content associated with an event.
|
|
1546
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember4::ContentUploaded::Content::EventTextContent }
|
|
1547
|
+
|
|
1548
|
+
# User-uploaded image content associated with an event.
|
|
1549
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember4::ContentUploaded::Content::EventImageContent }
|
|
1550
|
+
|
|
1551
|
+
class EventTextContent < SafetyKit::Internal::Type::BaseModel
|
|
1552
|
+
# @!attribute text
|
|
1553
|
+
# User-authored text SafetyKit should compare or analyze.
|
|
1554
|
+
#
|
|
1555
|
+
# @return [String]
|
|
1556
|
+
required :text, String
|
|
1557
|
+
|
|
1558
|
+
# @!attribute type
|
|
1559
|
+
# Text content part.
|
|
1560
|
+
#
|
|
1561
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::ContentUploaded::Content::EventTextContent::Type]
|
|
1562
|
+
required :type,
|
|
1563
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember4::ContentUploaded::Content::EventTextContent::Type }
|
|
1564
|
+
|
|
1565
|
+
# @!attribute key
|
|
1566
|
+
# Stable field key for this content part.
|
|
1567
|
+
#
|
|
1568
|
+
# @return [String, nil]
|
|
1569
|
+
optional :key, String
|
|
1570
|
+
|
|
1571
|
+
# @!method initialize(text:, type:, key: nil)
|
|
1572
|
+
# User-authored text content associated with an event.
|
|
1573
|
+
#
|
|
1574
|
+
# @param text [String] User-authored text SafetyKit should compare or analyze.
|
|
1575
|
+
#
|
|
1576
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::ContentUploaded::Content::EventTextContent::Type] Text content part.
|
|
1577
|
+
#
|
|
1578
|
+
# @param key [String] Stable field key for this content part.
|
|
1579
|
+
|
|
1580
|
+
# Text content part.
|
|
1581
|
+
#
|
|
1582
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::ContentUploaded::Content::EventTextContent#type
|
|
1583
|
+
module Type
|
|
1584
|
+
extend SafetyKit::Internal::Type::Enum
|
|
1585
|
+
|
|
1586
|
+
TEXT = :text
|
|
1587
|
+
|
|
1588
|
+
# @!method self.values
|
|
1589
|
+
# @return [Array<Symbol>]
|
|
1590
|
+
end
|
|
1591
|
+
end
|
|
1592
|
+
|
|
1593
|
+
class EventImageContent < SafetyKit::Internal::Type::BaseModel
|
|
1594
|
+
# @!attribute source
|
|
1595
|
+
# Image source information.
|
|
1596
|
+
#
|
|
1597
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::ContentUploaded::Content::EventImageContent::Source]
|
|
1598
|
+
required :source,
|
|
1599
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::UnionMember4::ContentUploaded::Content::EventImageContent::Source }
|
|
1600
|
+
|
|
1601
|
+
# @!attribute type
|
|
1602
|
+
# Image content part.
|
|
1603
|
+
#
|
|
1604
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::ContentUploaded::Content::EventImageContent::Type]
|
|
1605
|
+
required :type,
|
|
1606
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember4::ContentUploaded::Content::EventImageContent::Type }
|
|
1607
|
+
|
|
1608
|
+
# @!attribute key
|
|
1609
|
+
# Stable field key for this content part.
|
|
1610
|
+
#
|
|
1611
|
+
# @return [String, nil]
|
|
1612
|
+
optional :key, String
|
|
1613
|
+
|
|
1614
|
+
# @!method initialize(source:, type:, key: nil)
|
|
1615
|
+
# User-uploaded image content associated with an event.
|
|
1616
|
+
#
|
|
1617
|
+
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::ContentUploaded::Content::EventImageContent::Source] Image source information.
|
|
1618
|
+
#
|
|
1619
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::ContentUploaded::Content::EventImageContent::Type] Image content part.
|
|
1620
|
+
#
|
|
1621
|
+
# @param key [String] Stable field key for this content part.
|
|
1622
|
+
|
|
1623
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::ContentUploaded::Content::EventImageContent#source
|
|
1624
|
+
class Source < SafetyKit::Internal::Type::BaseModel
|
|
1625
|
+
# @!attribute type
|
|
1626
|
+
# URL image source.
|
|
1627
|
+
#
|
|
1628
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::ContentUploaded::Content::EventImageContent::Source::Type]
|
|
1629
|
+
required :type,
|
|
1630
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember4::ContentUploaded::Content::EventImageContent::Source::Type }
|
|
1631
|
+
|
|
1632
|
+
# @!attribute url
|
|
1633
|
+
# URL of the image SafetyKit should compare or analyze.
|
|
1634
|
+
#
|
|
1635
|
+
# @return [String]
|
|
1636
|
+
required :url, String
|
|
1637
|
+
|
|
1638
|
+
# @!method initialize(type:, url:)
|
|
1639
|
+
# Image source information.
|
|
1640
|
+
#
|
|
1641
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::ContentUploaded::Content::EventImageContent::Source::Type] URL image source.
|
|
1642
|
+
#
|
|
1643
|
+
# @param url [String] URL of the image SafetyKit should compare or analyze.
|
|
1644
|
+
|
|
1645
|
+
# URL image source.
|
|
1646
|
+
#
|
|
1647
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::ContentUploaded::Content::EventImageContent::Source#type
|
|
1648
|
+
module Type
|
|
1649
|
+
extend SafetyKit::Internal::Type::Enum
|
|
1650
|
+
|
|
1651
|
+
URL = :url
|
|
1652
|
+
|
|
1653
|
+
# @!method self.values
|
|
1654
|
+
# @return [Array<Symbol>]
|
|
1655
|
+
end
|
|
1656
|
+
end
|
|
1657
|
+
|
|
1658
|
+
# Image content part.
|
|
1659
|
+
#
|
|
1660
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::ContentUploaded::Content::EventImageContent#type
|
|
1661
|
+
module Type
|
|
1662
|
+
extend SafetyKit::Internal::Type::Enum
|
|
1663
|
+
|
|
1664
|
+
IMAGE = :image
|
|
1665
|
+
|
|
1666
|
+
# @!method self.values
|
|
1667
|
+
# @return [Array<Symbol>]
|
|
1668
|
+
end
|
|
1669
|
+
end
|
|
1670
|
+
|
|
1671
|
+
# @!method self.variants
|
|
1672
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::ContentUploaded::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::ContentUploaded::Content::EventImageContent)]
|
|
1673
|
+
end
|
|
1674
|
+
|
|
1675
|
+
module Metadata
|
|
1676
|
+
extend SafetyKit::Internal::Type::Union
|
|
1677
|
+
|
|
1678
|
+
variant String
|
|
1679
|
+
|
|
1680
|
+
variant Float
|
|
1681
|
+
|
|
1682
|
+
variant SafetyKit::Internal::Type::Boolean
|
|
1683
|
+
|
|
1684
|
+
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::ContentUploaded::Metadata::UnionMember3Array }
|
|
1685
|
+
|
|
1686
|
+
module UnionMember3
|
|
1687
|
+
extend SafetyKit::Internal::Type::Union
|
|
1688
|
+
|
|
1689
|
+
variant String
|
|
1690
|
+
|
|
1691
|
+
variant Float
|
|
1692
|
+
|
|
1693
|
+
variant SafetyKit::Internal::Type::Boolean
|
|
1694
|
+
|
|
1695
|
+
# @!method self.variants
|
|
1696
|
+
# @return [Array(String, Float, Boolean)]
|
|
1697
|
+
end
|
|
1698
|
+
|
|
1699
|
+
# @!method self.variants
|
|
1700
|
+
# @return [Array(String, Float, Boolean, Array<String, Float, Boolean>)]
|
|
1701
|
+
|
|
1702
|
+
# @type [SafetyKit::Internal::Type::Converter]
|
|
1703
|
+
UnionMember3Array =
|
|
1704
|
+
SafetyKit::Internal::Type::ArrayOf[
|
|
1705
|
+
union: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember4::ContentUploaded::Metadata::UnionMember3 }
|
|
1706
|
+
]
|
|
1707
|
+
end
|
|
1708
|
+
|
|
1709
|
+
class ResourcesUsed < SafetyKit::Internal::Type::BaseModel
|
|
1710
|
+
# @!attribute type
|
|
1711
|
+
# Resource family, such as email, phone, name, address, url, instagram, tiktok,
|
|
1712
|
+
# youtube, linkedin, or another stable snake_case identifier.
|
|
1713
|
+
#
|
|
1714
|
+
# @return [String]
|
|
1715
|
+
required :type, String
|
|
1716
|
+
|
|
1717
|
+
# @!attribute value
|
|
1718
|
+
# Resource value used during the event. SafetyKit stores a normalized hash of this
|
|
1719
|
+
# value, not the raw value. When type is url, this must be a valid URL.
|
|
1720
|
+
#
|
|
1721
|
+
# @return [String]
|
|
1722
|
+
required :value, String
|
|
1723
|
+
|
|
1724
|
+
# @!method initialize(type:, value:)
|
|
1725
|
+
# Some parameter documentations has been truncated, see
|
|
1726
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::ContentUploaded::ResourcesUsed}
|
|
1727
|
+
# for more details.
|
|
1728
|
+
#
|
|
1729
|
+
# Real-world or account resource used during the event, such as an email, phone
|
|
1730
|
+
# number, address, URL, social handle, or payment identifier.
|
|
1731
|
+
#
|
|
1732
|
+
# @param type [String] Resource family, such as email, phone, name, address, url, instagram, tiktok, yo
|
|
1733
|
+
#
|
|
1734
|
+
# @param value [String] Resource value used during the event. SafetyKit stores a normalized hash of this
|
|
1735
|
+
end
|
|
1736
|
+
end
|
|
1737
|
+
|
|
1738
|
+
class CreateAccount < SafetyKit::Internal::Type::BaseModel
|
|
1739
|
+
# @!attribute event_name
|
|
1740
|
+
# Stable, low-cardinality product action name. Use snake_case and put dynamic
|
|
1741
|
+
# values in typed fields, content, resources_used, or metadata.
|
|
1742
|
+
#
|
|
1743
|
+
# @return [String]
|
|
1744
|
+
required :event_name, String
|
|
1745
|
+
|
|
1746
|
+
# @!attribute timestamp
|
|
1747
|
+
# The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
1748
|
+
#
|
|
1749
|
+
# @return [Time]
|
|
1750
|
+
required :timestamp, Time
|
|
1751
|
+
|
|
1752
|
+
# @!attribute type
|
|
1753
|
+
#
|
|
1754
|
+
# @return [Symbol, :create_account]
|
|
1755
|
+
required :type, const: :create_account
|
|
1756
|
+
|
|
1757
|
+
# @!attribute user_id
|
|
1758
|
+
# Your stable canonical identifier for the user or account.
|
|
1759
|
+
#
|
|
1760
|
+
# @return [String]
|
|
1761
|
+
required :user_id, String
|
|
1762
|
+
|
|
1763
|
+
# @!attribute content
|
|
1764
|
+
# User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
1765
|
+
# listing text, image URLs, and similar content SafetyKit should compare or
|
|
1766
|
+
# analyze.
|
|
1767
|
+
#
|
|
1768
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::CreateAccount::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::CreateAccount::Content::EventImageContent>, nil]
|
|
1769
|
+
optional :content,
|
|
1770
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember4::CreateAccount::Content] }
|
|
1771
|
+
|
|
1772
|
+
# @!attribute metadata
|
|
1773
|
+
# Non-PII product context for filtering, segmentation, and debugging. Values may
|
|
1774
|
+
# be strings, numbers, booleans, or arrays of those scalar values.
|
|
1775
|
+
#
|
|
1776
|
+
# @return [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}, nil]
|
|
1777
|
+
optional :metadata,
|
|
1778
|
+
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember4::CreateAccount::Metadata] }
|
|
1779
|
+
|
|
1780
|
+
# @!attribute resources_used
|
|
1781
|
+
# Reusable resources observed during the event. Use this for emails, phone
|
|
1782
|
+
# numbers, names, addresses, social handles, URLs, payment identifiers, or similar
|
|
1783
|
+
# identifiers.
|
|
1784
|
+
#
|
|
1785
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::CreateAccount::ResourcesUsed>, nil]
|
|
1786
|
+
optional :resources_used,
|
|
1787
|
+
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::UnionMember4::CreateAccount::ResourcesUsed] }
|
|
1788
|
+
|
|
1789
|
+
# @!method initialize(event_name:, timestamp:, user_id:, content: nil, metadata: nil, resources_used: nil, type: :create_account)
|
|
1790
|
+
# Some parameter documentations has been truncated, see
|
|
1791
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::CreateAccount}
|
|
1792
|
+
# for more details.
|
|
1793
|
+
#
|
|
1794
|
+
# A user or account is created.
|
|
1795
|
+
#
|
|
1796
|
+
# @param event_name [String] Stable, low-cardinality product action name. Use snake_case and put dynamic valu
|
|
1797
|
+
#
|
|
1798
|
+
# @param timestamp [Time] The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
1799
|
+
#
|
|
1800
|
+
# @param user_id [String] Your stable canonical identifier for the user or account.
|
|
1801
|
+
#
|
|
1802
|
+
# @param content [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::CreateAccount::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::CreateAccount::Content::EventImageContent>] User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
1803
|
+
#
|
|
1804
|
+
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
1805
|
+
#
|
|
1806
|
+
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::CreateAccount::ResourcesUsed>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
1807
|
+
#
|
|
1808
|
+
# @param type [Symbol, :create_account]
|
|
1809
|
+
|
|
1810
|
+
# User-authored text content associated with an event.
|
|
1811
|
+
module Content
|
|
1812
|
+
extend SafetyKit::Internal::Type::Union
|
|
1813
|
+
|
|
1814
|
+
# User-authored text content associated with an event.
|
|
1815
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember4::CreateAccount::Content::EventTextContent }
|
|
1816
|
+
|
|
1817
|
+
# User-uploaded image content associated with an event.
|
|
1818
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember4::CreateAccount::Content::EventImageContent }
|
|
1819
|
+
|
|
1820
|
+
class EventTextContent < SafetyKit::Internal::Type::BaseModel
|
|
1821
|
+
# @!attribute text
|
|
1822
|
+
# User-authored text SafetyKit should compare or analyze.
|
|
1823
|
+
#
|
|
1824
|
+
# @return [String]
|
|
1825
|
+
required :text, String
|
|
1826
|
+
|
|
1827
|
+
# @!attribute type
|
|
1828
|
+
# Text content part.
|
|
1829
|
+
#
|
|
1830
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::CreateAccount::Content::EventTextContent::Type]
|
|
1831
|
+
required :type,
|
|
1832
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember4::CreateAccount::Content::EventTextContent::Type }
|
|
1833
|
+
|
|
1834
|
+
# @!attribute key
|
|
1835
|
+
# Stable field key for this content part.
|
|
1836
|
+
#
|
|
1837
|
+
# @return [String, nil]
|
|
1838
|
+
optional :key, String
|
|
1839
|
+
|
|
1840
|
+
# @!method initialize(text:, type:, key: nil)
|
|
1841
|
+
# User-authored text content associated with an event.
|
|
1842
|
+
#
|
|
1843
|
+
# @param text [String] User-authored text SafetyKit should compare or analyze.
|
|
1844
|
+
#
|
|
1845
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::CreateAccount::Content::EventTextContent::Type] Text content part.
|
|
1846
|
+
#
|
|
1847
|
+
# @param key [String] Stable field key for this content part.
|
|
1848
|
+
|
|
1849
|
+
# Text content part.
|
|
1850
|
+
#
|
|
1851
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::CreateAccount::Content::EventTextContent#type
|
|
1852
|
+
module Type
|
|
1853
|
+
extend SafetyKit::Internal::Type::Enum
|
|
1854
|
+
|
|
1855
|
+
TEXT = :text
|
|
1856
|
+
|
|
1857
|
+
# @!method self.values
|
|
1858
|
+
# @return [Array<Symbol>]
|
|
1859
|
+
end
|
|
1860
|
+
end
|
|
1861
|
+
|
|
1862
|
+
class EventImageContent < SafetyKit::Internal::Type::BaseModel
|
|
1863
|
+
# @!attribute source
|
|
1864
|
+
# Image source information.
|
|
1865
|
+
#
|
|
1866
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::CreateAccount::Content::EventImageContent::Source]
|
|
1867
|
+
required :source,
|
|
1868
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::UnionMember4::CreateAccount::Content::EventImageContent::Source }
|
|
1869
|
+
|
|
1870
|
+
# @!attribute type
|
|
1871
|
+
# Image content part.
|
|
1872
|
+
#
|
|
1873
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::CreateAccount::Content::EventImageContent::Type]
|
|
1874
|
+
required :type,
|
|
1875
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember4::CreateAccount::Content::EventImageContent::Type }
|
|
1876
|
+
|
|
1877
|
+
# @!attribute key
|
|
1878
|
+
# Stable field key for this content part.
|
|
1879
|
+
#
|
|
1880
|
+
# @return [String, nil]
|
|
1881
|
+
optional :key, String
|
|
1882
|
+
|
|
1883
|
+
# @!method initialize(source:, type:, key: nil)
|
|
1884
|
+
# User-uploaded image content associated with an event.
|
|
1885
|
+
#
|
|
1886
|
+
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::CreateAccount::Content::EventImageContent::Source] Image source information.
|
|
1887
|
+
#
|
|
1888
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::CreateAccount::Content::EventImageContent::Type] Image content part.
|
|
1889
|
+
#
|
|
1890
|
+
# @param key [String] Stable field key for this content part.
|
|
1891
|
+
|
|
1892
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::CreateAccount::Content::EventImageContent#source
|
|
1893
|
+
class Source < SafetyKit::Internal::Type::BaseModel
|
|
1894
|
+
# @!attribute type
|
|
1895
|
+
# URL image source.
|
|
1896
|
+
#
|
|
1897
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::CreateAccount::Content::EventImageContent::Source::Type]
|
|
1898
|
+
required :type,
|
|
1899
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember4::CreateAccount::Content::EventImageContent::Source::Type }
|
|
1900
|
+
|
|
1901
|
+
# @!attribute url
|
|
1902
|
+
# URL of the image SafetyKit should compare or analyze.
|
|
1903
|
+
#
|
|
1904
|
+
# @return [String]
|
|
1905
|
+
required :url, String
|
|
1906
|
+
|
|
1907
|
+
# @!method initialize(type:, url:)
|
|
1908
|
+
# Image source information.
|
|
1909
|
+
#
|
|
1910
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::CreateAccount::Content::EventImageContent::Source::Type] URL image source.
|
|
1911
|
+
#
|
|
1912
|
+
# @param url [String] URL of the image SafetyKit should compare or analyze.
|
|
1913
|
+
|
|
1914
|
+
# URL image source.
|
|
1915
|
+
#
|
|
1916
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::CreateAccount::Content::EventImageContent::Source#type
|
|
1917
|
+
module Type
|
|
1918
|
+
extend SafetyKit::Internal::Type::Enum
|
|
1919
|
+
|
|
1920
|
+
URL = :url
|
|
1921
|
+
|
|
1922
|
+
# @!method self.values
|
|
1923
|
+
# @return [Array<Symbol>]
|
|
1924
|
+
end
|
|
1925
|
+
end
|
|
1926
|
+
|
|
1927
|
+
# Image content part.
|
|
1928
|
+
#
|
|
1929
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::CreateAccount::Content::EventImageContent#type
|
|
1930
|
+
module Type
|
|
1931
|
+
extend SafetyKit::Internal::Type::Enum
|
|
1932
|
+
|
|
1933
|
+
IMAGE = :image
|
|
1934
|
+
|
|
1935
|
+
# @!method self.values
|
|
1936
|
+
# @return [Array<Symbol>]
|
|
1937
|
+
end
|
|
1938
|
+
end
|
|
1939
|
+
|
|
1940
|
+
# @!method self.variants
|
|
1941
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::CreateAccount::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::CreateAccount::Content::EventImageContent)]
|
|
1942
|
+
end
|
|
1943
|
+
|
|
1944
|
+
module Metadata
|
|
1945
|
+
extend SafetyKit::Internal::Type::Union
|
|
1946
|
+
|
|
1947
|
+
variant String
|
|
1948
|
+
|
|
1949
|
+
variant Float
|
|
1950
|
+
|
|
1951
|
+
variant SafetyKit::Internal::Type::Boolean
|
|
1952
|
+
|
|
1953
|
+
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::CreateAccount::Metadata::UnionMember3Array }
|
|
1954
|
+
|
|
1955
|
+
module UnionMember3
|
|
1956
|
+
extend SafetyKit::Internal::Type::Union
|
|
1957
|
+
|
|
1958
|
+
variant String
|
|
1959
|
+
|
|
1960
|
+
variant Float
|
|
1961
|
+
|
|
1962
|
+
variant SafetyKit::Internal::Type::Boolean
|
|
1963
|
+
|
|
1964
|
+
# @!method self.variants
|
|
1965
|
+
# @return [Array(String, Float, Boolean)]
|
|
1966
|
+
end
|
|
1967
|
+
|
|
1968
|
+
# @!method self.variants
|
|
1969
|
+
# @return [Array(String, Float, Boolean, Array<String, Float, Boolean>)]
|
|
1970
|
+
|
|
1971
|
+
# @type [SafetyKit::Internal::Type::Converter]
|
|
1972
|
+
UnionMember3Array =
|
|
1973
|
+
SafetyKit::Internal::Type::ArrayOf[
|
|
1974
|
+
union: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember4::CreateAccount::Metadata::UnionMember3 }
|
|
1975
|
+
]
|
|
1976
|
+
end
|
|
1977
|
+
|
|
1978
|
+
class ResourcesUsed < SafetyKit::Internal::Type::BaseModel
|
|
1979
|
+
# @!attribute type
|
|
1980
|
+
# Resource family, such as email, phone, name, address, url, instagram, tiktok,
|
|
1981
|
+
# youtube, linkedin, or another stable snake_case identifier.
|
|
1982
|
+
#
|
|
1983
|
+
# @return [String]
|
|
1984
|
+
required :type, String
|
|
1985
|
+
|
|
1986
|
+
# @!attribute value
|
|
1987
|
+
# Resource value used during the event. SafetyKit stores a normalized hash of this
|
|
1988
|
+
# value, not the raw value. When type is url, this must be a valid URL.
|
|
1989
|
+
#
|
|
1990
|
+
# @return [String]
|
|
1991
|
+
required :value, String
|
|
1992
|
+
|
|
1993
|
+
# @!method initialize(type:, value:)
|
|
1994
|
+
# Some parameter documentations has been truncated, see
|
|
1995
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::CreateAccount::ResourcesUsed}
|
|
1996
|
+
# for more details.
|
|
1997
|
+
#
|
|
1998
|
+
# Real-world or account resource used during the event, such as an email, phone
|
|
1999
|
+
# number, address, URL, social handle, or payment identifier.
|
|
2000
|
+
#
|
|
2001
|
+
# @param type [String] Resource family, such as email, phone, name, address, url, instagram, tiktok, yo
|
|
2002
|
+
#
|
|
2003
|
+
# @param value [String] Resource value used during the event. SafetyKit stores a normalized hash of this
|
|
2004
|
+
end
|
|
2005
|
+
end
|
|
2006
|
+
|
|
2007
|
+
class UpdateAccount < SafetyKit::Internal::Type::BaseModel
|
|
2008
|
+
# @!attribute event_name
|
|
2009
|
+
# Stable, low-cardinality product action name. Use snake_case and put dynamic
|
|
2010
|
+
# values in typed fields, content, resources_used, or metadata.
|
|
2011
|
+
#
|
|
2012
|
+
# @return [String]
|
|
2013
|
+
required :event_name, String
|
|
2014
|
+
|
|
2015
|
+
# @!attribute timestamp
|
|
2016
|
+
# The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
2017
|
+
#
|
|
2018
|
+
# @return [Time]
|
|
2019
|
+
required :timestamp, Time
|
|
2020
|
+
|
|
2021
|
+
# @!attribute type
|
|
2022
|
+
#
|
|
2023
|
+
# @return [Symbol, :update_account]
|
|
2024
|
+
required :type, const: :update_account
|
|
2025
|
+
|
|
2026
|
+
# @!attribute user_id
|
|
2027
|
+
# Your stable canonical identifier for the user or account.
|
|
2028
|
+
#
|
|
2029
|
+
# @return [String]
|
|
2030
|
+
required :user_id, String
|
|
2031
|
+
|
|
2032
|
+
# @!attribute content
|
|
2033
|
+
# User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
2034
|
+
# listing text, image URLs, and similar content SafetyKit should compare or
|
|
2035
|
+
# analyze.
|
|
2036
|
+
#
|
|
2037
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::UpdateAccount::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::UpdateAccount::Content::EventImageContent>, nil]
|
|
2038
|
+
optional :content,
|
|
2039
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember4::UpdateAccount::Content] }
|
|
2040
|
+
|
|
2041
|
+
# @!attribute metadata
|
|
2042
|
+
# Non-PII product context for filtering, segmentation, and debugging. Values may
|
|
2043
|
+
# be strings, numbers, booleans, or arrays of those scalar values.
|
|
2044
|
+
#
|
|
2045
|
+
# @return [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}, nil]
|
|
2046
|
+
optional :metadata,
|
|
2047
|
+
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember4::UpdateAccount::Metadata] }
|
|
2048
|
+
|
|
2049
|
+
# @!attribute resources_used
|
|
2050
|
+
# Reusable resources observed during the event. Use this for emails, phone
|
|
2051
|
+
# numbers, names, addresses, social handles, URLs, payment identifiers, or similar
|
|
2052
|
+
# identifiers.
|
|
2053
|
+
#
|
|
2054
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::UpdateAccount::ResourcesUsed>, nil]
|
|
2055
|
+
optional :resources_used,
|
|
2056
|
+
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::UnionMember4::UpdateAccount::ResourcesUsed] }
|
|
2057
|
+
|
|
2058
|
+
# @!method initialize(event_name:, timestamp:, user_id:, content: nil, metadata: nil, resources_used: nil, type: :update_account)
|
|
2059
|
+
# Some parameter documentations has been truncated, see
|
|
2060
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::UpdateAccount}
|
|
2061
|
+
# for more details.
|
|
2062
|
+
#
|
|
2063
|
+
# A user or account profile, contact detail, payment detail, or public bio
|
|
2064
|
+
# changes.
|
|
2065
|
+
#
|
|
2066
|
+
# @param event_name [String] Stable, low-cardinality product action name. Use snake_case and put dynamic valu
|
|
2067
|
+
#
|
|
2068
|
+
# @param timestamp [Time] The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
2069
|
+
#
|
|
2070
|
+
# @param user_id [String] Your stable canonical identifier for the user or account.
|
|
2071
|
+
#
|
|
2072
|
+
# @param content [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::UpdateAccount::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::UpdateAccount::Content::EventImageContent>] User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
2073
|
+
#
|
|
2074
|
+
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
2075
|
+
#
|
|
2076
|
+
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::UpdateAccount::ResourcesUsed>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
2077
|
+
#
|
|
2078
|
+
# @param type [Symbol, :update_account]
|
|
2079
|
+
|
|
2080
|
+
# User-authored text content associated with an event.
|
|
2081
|
+
module Content
|
|
2082
|
+
extend SafetyKit::Internal::Type::Union
|
|
2083
|
+
|
|
2084
|
+
# User-authored text content associated with an event.
|
|
2085
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember4::UpdateAccount::Content::EventTextContent }
|
|
2086
|
+
|
|
2087
|
+
# User-uploaded image content associated with an event.
|
|
2088
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember4::UpdateAccount::Content::EventImageContent }
|
|
2089
|
+
|
|
2090
|
+
class EventTextContent < SafetyKit::Internal::Type::BaseModel
|
|
2091
|
+
# @!attribute text
|
|
2092
|
+
# User-authored text SafetyKit should compare or analyze.
|
|
2093
|
+
#
|
|
2094
|
+
# @return [String]
|
|
2095
|
+
required :text, String
|
|
2096
|
+
|
|
2097
|
+
# @!attribute type
|
|
2098
|
+
# Text content part.
|
|
2099
|
+
#
|
|
2100
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::UpdateAccount::Content::EventTextContent::Type]
|
|
2101
|
+
required :type,
|
|
2102
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember4::UpdateAccount::Content::EventTextContent::Type }
|
|
2103
|
+
|
|
2104
|
+
# @!attribute key
|
|
2105
|
+
# Stable field key for this content part.
|
|
2106
|
+
#
|
|
2107
|
+
# @return [String, nil]
|
|
2108
|
+
optional :key, String
|
|
2109
|
+
|
|
2110
|
+
# @!method initialize(text:, type:, key: nil)
|
|
2111
|
+
# User-authored text content associated with an event.
|
|
2112
|
+
#
|
|
2113
|
+
# @param text [String] User-authored text SafetyKit should compare or analyze.
|
|
2114
|
+
#
|
|
2115
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::UpdateAccount::Content::EventTextContent::Type] Text content part.
|
|
2116
|
+
#
|
|
2117
|
+
# @param key [String] Stable field key for this content part.
|
|
2118
|
+
|
|
2119
|
+
# Text content part.
|
|
2120
|
+
#
|
|
2121
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::UpdateAccount::Content::EventTextContent#type
|
|
2122
|
+
module Type
|
|
2123
|
+
extend SafetyKit::Internal::Type::Enum
|
|
2124
|
+
|
|
2125
|
+
TEXT = :text
|
|
2126
|
+
|
|
2127
|
+
# @!method self.values
|
|
2128
|
+
# @return [Array<Symbol>]
|
|
2129
|
+
end
|
|
2130
|
+
end
|
|
2131
|
+
|
|
2132
|
+
class EventImageContent < SafetyKit::Internal::Type::BaseModel
|
|
2133
|
+
# @!attribute source
|
|
2134
|
+
# Image source information.
|
|
2135
|
+
#
|
|
2136
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::UpdateAccount::Content::EventImageContent::Source]
|
|
2137
|
+
required :source,
|
|
2138
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::UnionMember4::UpdateAccount::Content::EventImageContent::Source }
|
|
2139
|
+
|
|
2140
|
+
# @!attribute type
|
|
2141
|
+
# Image content part.
|
|
2142
|
+
#
|
|
2143
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::UpdateAccount::Content::EventImageContent::Type]
|
|
2144
|
+
required :type,
|
|
2145
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember4::UpdateAccount::Content::EventImageContent::Type }
|
|
2146
|
+
|
|
2147
|
+
# @!attribute key
|
|
2148
|
+
# Stable field key for this content part.
|
|
2149
|
+
#
|
|
2150
|
+
# @return [String, nil]
|
|
2151
|
+
optional :key, String
|
|
2152
|
+
|
|
2153
|
+
# @!method initialize(source:, type:, key: nil)
|
|
2154
|
+
# User-uploaded image content associated with an event.
|
|
2155
|
+
#
|
|
2156
|
+
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::UpdateAccount::Content::EventImageContent::Source] Image source information.
|
|
2157
|
+
#
|
|
2158
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::UpdateAccount::Content::EventImageContent::Type] Image content part.
|
|
2159
|
+
#
|
|
2160
|
+
# @param key [String] Stable field key for this content part.
|
|
2161
|
+
|
|
2162
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::UpdateAccount::Content::EventImageContent#source
|
|
2163
|
+
class Source < SafetyKit::Internal::Type::BaseModel
|
|
2164
|
+
# @!attribute type
|
|
2165
|
+
# URL image source.
|
|
2166
|
+
#
|
|
2167
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::UpdateAccount::Content::EventImageContent::Source::Type]
|
|
2168
|
+
required :type,
|
|
2169
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember4::UpdateAccount::Content::EventImageContent::Source::Type }
|
|
2170
|
+
|
|
2171
|
+
# @!attribute url
|
|
2172
|
+
# URL of the image SafetyKit should compare or analyze.
|
|
2173
|
+
#
|
|
2174
|
+
# @return [String]
|
|
2175
|
+
required :url, String
|
|
2176
|
+
|
|
2177
|
+
# @!method initialize(type:, url:)
|
|
2178
|
+
# Image source information.
|
|
2179
|
+
#
|
|
2180
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::UpdateAccount::Content::EventImageContent::Source::Type] URL image source.
|
|
2181
|
+
#
|
|
2182
|
+
# @param url [String] URL of the image SafetyKit should compare or analyze.
|
|
2183
|
+
|
|
2184
|
+
# URL image source.
|
|
2185
|
+
#
|
|
2186
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::UpdateAccount::Content::EventImageContent::Source#type
|
|
2187
|
+
module Type
|
|
2188
|
+
extend SafetyKit::Internal::Type::Enum
|
|
2189
|
+
|
|
2190
|
+
URL = :url
|
|
2191
|
+
|
|
2192
|
+
# @!method self.values
|
|
2193
|
+
# @return [Array<Symbol>]
|
|
2194
|
+
end
|
|
2195
|
+
end
|
|
2196
|
+
|
|
2197
|
+
# Image content part.
|
|
2198
|
+
#
|
|
2199
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::UpdateAccount::Content::EventImageContent#type
|
|
2200
|
+
module Type
|
|
2201
|
+
extend SafetyKit::Internal::Type::Enum
|
|
2202
|
+
|
|
2203
|
+
IMAGE = :image
|
|
2204
|
+
|
|
2205
|
+
# @!method self.values
|
|
2206
|
+
# @return [Array<Symbol>]
|
|
2207
|
+
end
|
|
2208
|
+
end
|
|
2209
|
+
|
|
2210
|
+
# @!method self.variants
|
|
2211
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::UpdateAccount::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::UpdateAccount::Content::EventImageContent)]
|
|
2212
|
+
end
|
|
2213
|
+
|
|
2214
|
+
module Metadata
|
|
2215
|
+
extend SafetyKit::Internal::Type::Union
|
|
2216
|
+
|
|
2217
|
+
variant String
|
|
2218
|
+
|
|
2219
|
+
variant Float
|
|
2220
|
+
|
|
2221
|
+
variant SafetyKit::Internal::Type::Boolean
|
|
2222
|
+
|
|
2223
|
+
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::UpdateAccount::Metadata::UnionMember3Array }
|
|
2224
|
+
|
|
2225
|
+
module UnionMember3
|
|
2226
|
+
extend SafetyKit::Internal::Type::Union
|
|
2227
|
+
|
|
2228
|
+
variant String
|
|
2229
|
+
|
|
2230
|
+
variant Float
|
|
2231
|
+
|
|
2232
|
+
variant SafetyKit::Internal::Type::Boolean
|
|
2233
|
+
|
|
2234
|
+
# @!method self.variants
|
|
2235
|
+
# @return [Array(String, Float, Boolean)]
|
|
2236
|
+
end
|
|
2237
|
+
|
|
2238
|
+
# @!method self.variants
|
|
2239
|
+
# @return [Array(String, Float, Boolean, Array<String, Float, Boolean>)]
|
|
2240
|
+
|
|
2241
|
+
# @type [SafetyKit::Internal::Type::Converter]
|
|
2242
|
+
UnionMember3Array =
|
|
2243
|
+
SafetyKit::Internal::Type::ArrayOf[
|
|
2244
|
+
union: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember4::UpdateAccount::Metadata::UnionMember3 }
|
|
2245
|
+
]
|
|
2246
|
+
end
|
|
2247
|
+
|
|
2248
|
+
class ResourcesUsed < SafetyKit::Internal::Type::BaseModel
|
|
2249
|
+
# @!attribute type
|
|
2250
|
+
# Resource family, such as email, phone, name, address, url, instagram, tiktok,
|
|
2251
|
+
# youtube, linkedin, or another stable snake_case identifier.
|
|
2252
|
+
#
|
|
2253
|
+
# @return [String]
|
|
2254
|
+
required :type, String
|
|
2255
|
+
|
|
2256
|
+
# @!attribute value
|
|
2257
|
+
# Resource value used during the event. SafetyKit stores a normalized hash of this
|
|
2258
|
+
# value, not the raw value. When type is url, this must be a valid URL.
|
|
2259
|
+
#
|
|
2260
|
+
# @return [String]
|
|
2261
|
+
required :value, String
|
|
2262
|
+
|
|
2263
|
+
# @!method initialize(type:, value:)
|
|
2264
|
+
# Some parameter documentations has been truncated, see
|
|
2265
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::UpdateAccount::ResourcesUsed}
|
|
2266
|
+
# for more details.
|
|
2267
|
+
#
|
|
2268
|
+
# Real-world or account resource used during the event, such as an email, phone
|
|
2269
|
+
# number, address, URL, social handle, or payment identifier.
|
|
2270
|
+
#
|
|
2271
|
+
# @param type [String] Resource family, such as email, phone, name, address, url, instagram, tiktok, yo
|
|
2272
|
+
#
|
|
2273
|
+
# @param value [String] Resource value used during the event. SafetyKit stores a normalized hash of this
|
|
2274
|
+
end
|
|
2275
|
+
end
|
|
2276
|
+
|
|
2277
|
+
# @!method self.variants
|
|
2278
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::UserContact, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::ContentUploaded, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::CreateAccount, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::UpdateAccount)]
|
|
2279
|
+
end
|
|
2280
|
+
|
|
1134
2281
|
# @!method self.variants
|
|
1135
|
-
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::UserContact, SafetyKit::Models::Beta::EventCreateParams::Body::ContentUploaded, SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccount, SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccount)]
|
|
2282
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::UserContactEventRequest, SafetyKit::Models::Beta::EventCreateParams::Body::ContentUploadedEventRequest, SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest, SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest, Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::UserContact, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::ContentUploaded, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::CreateAccount, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::UpdateAccount>)]
|
|
2283
|
+
|
|
2284
|
+
# @type [SafetyKit::Internal::Type::Converter]
|
|
2285
|
+
UnionMember4Array =
|
|
2286
|
+
SafetyKit::Internal::Type::ArrayOf[union: -> {
|
|
2287
|
+
SafetyKit::Beta::EventCreateParams::Body::UnionMember4
|
|
2288
|
+
}]
|
|
1136
2289
|
end
|
|
1137
2290
|
end
|
|
1138
2291
|
end
|