safetykit 0.15.0 → 0.16.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 +8 -0
- data/README.md +1 -1
- data/lib/safety_kit/models/beta/event_create_params.rb +891 -237
- data/lib/safety_kit/resources/beta/events.rb +1 -1
- data/lib/safety_kit/version.rb +1 -1
- data/rbi/safety_kit/models/beta/event_create_params.rbi +1662 -307
- data/rbi/safety_kit/resources/beta/events.rbi +6 -4
- data/sig/safety_kit/models/beta/event_create_params.rbs +689 -179
- metadata +1 -1
|
@@ -13,14 +13,14 @@ module SafetyKit
|
|
|
13
13
|
# your server after an action has happened in your product. Do not send these
|
|
14
14
|
# events directly from a browser or mobile client.
|
|
15
15
|
#
|
|
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::
|
|
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, SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest, Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UserContact, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::ContentUploaded, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::CreateAccount, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UpdateAccount, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UserReport>]
|
|
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::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::
|
|
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, SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest, Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UserContact, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::ContentUploaded, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::CreateAccount, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UpdateAccount, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UserReport>] 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
|
|
|
@@ -42,7 +42,10 @@ module SafetyKit
|
|
|
42
42
|
# A user or account profile, contact detail, payment detail, or public bio changes.
|
|
43
43
|
variant -> { SafetyKit::Beta::EventCreateParams::Body::UpdateAccountEventRequest }
|
|
44
44
|
|
|
45
|
-
|
|
45
|
+
# A user-submitted report. Use user_id for the reporter, content and content_id for the report itself, and target_user_id or target_content_id for what was reported.
|
|
46
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UserReportEventRequest }
|
|
47
|
+
|
|
48
|
+
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5Array }
|
|
46
49
|
|
|
47
50
|
class UserContactEventRequest < SafetyKit::Internal::Type::BaseModel
|
|
48
51
|
# @!attribute event_name
|
|
@@ -1206,180 +1209,512 @@ module SafetyKit
|
|
|
1206
1209
|
end
|
|
1207
1210
|
end
|
|
1208
1211
|
|
|
1209
|
-
|
|
1210
|
-
|
|
1211
|
-
|
|
1212
|
+
class UserReportEventRequest < SafetyKit::Internal::Type::BaseModel
|
|
1213
|
+
# @!attribute event_name
|
|
1214
|
+
# Stable, low-cardinality product action name. Use snake_case and put dynamic
|
|
1215
|
+
# values in typed fields, content, resources_used, or metadata.
|
|
1216
|
+
#
|
|
1217
|
+
# @return [String]
|
|
1218
|
+
required :event_name, String
|
|
1212
1219
|
|
|
1213
|
-
|
|
1220
|
+
# @!attribute labels
|
|
1221
|
+
# One or more label categories supplied with the report.
|
|
1222
|
+
#
|
|
1223
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Label>]
|
|
1224
|
+
required :labels,
|
|
1225
|
+
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::UserReportEventRequest::Label] }
|
|
1214
1226
|
|
|
1215
|
-
#
|
|
1216
|
-
|
|
1227
|
+
# @!attribute timestamp
|
|
1228
|
+
# The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
1229
|
+
#
|
|
1230
|
+
# @return [Time]
|
|
1231
|
+
required :timestamp, Time
|
|
1217
1232
|
|
|
1218
|
-
#
|
|
1219
|
-
|
|
1233
|
+
# @!attribute type
|
|
1234
|
+
#
|
|
1235
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Type]
|
|
1236
|
+
required :type, enum: -> { SafetyKit::Beta::EventCreateParams::Body::UserReportEventRequest::Type }
|
|
1220
1237
|
|
|
1221
|
-
#
|
|
1222
|
-
|
|
1238
|
+
# @!attribute user_id
|
|
1239
|
+
# Your stable canonical identifier for the user or account.
|
|
1240
|
+
#
|
|
1241
|
+
# @return [String]
|
|
1242
|
+
required :user_id, String
|
|
1223
1243
|
|
|
1224
|
-
#
|
|
1225
|
-
|
|
1244
|
+
# @!attribute content
|
|
1245
|
+
# User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
1246
|
+
# listing text, image URLs, and similar content SafetyKit should compare or
|
|
1247
|
+
# analyze.
|
|
1248
|
+
#
|
|
1249
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventImageContent>, nil]
|
|
1250
|
+
optional :content,
|
|
1251
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::UserReportEventRequest::Content] }
|
|
1226
1252
|
|
|
1227
|
-
|
|
1228
|
-
|
|
1229
|
-
|
|
1230
|
-
|
|
1231
|
-
|
|
1232
|
-
|
|
1233
|
-
required :event_name, String
|
|
1253
|
+
# @!attribute content_id
|
|
1254
|
+
# Your stable identifier for the content involved in this event, such as a
|
|
1255
|
+
# message, listing, page, post, profile, or uploaded media item.
|
|
1256
|
+
#
|
|
1257
|
+
# @return [String, nil]
|
|
1258
|
+
optional :content_id, String
|
|
1234
1259
|
|
|
1235
|
-
|
|
1236
|
-
|
|
1237
|
-
|
|
1238
|
-
|
|
1239
|
-
|
|
1240
|
-
|
|
1260
|
+
# @!attribute metadata
|
|
1261
|
+
# Non-PII product context for filtering, segmentation, and debugging. Values may
|
|
1262
|
+
# be strings, numbers, booleans, or arrays of those scalar values.
|
|
1263
|
+
#
|
|
1264
|
+
# @return [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}, nil]
|
|
1265
|
+
optional :metadata,
|
|
1266
|
+
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::UserReportEventRequest::Metadata] }
|
|
1241
1267
|
|
|
1242
|
-
|
|
1243
|
-
|
|
1244
|
-
|
|
1245
|
-
|
|
1246
|
-
|
|
1268
|
+
# @!attribute resources_used
|
|
1269
|
+
# Reusable resources observed during the event. Use this for emails, phone
|
|
1270
|
+
# numbers, names, addresses, social handles, URLs, payment identifiers, or similar
|
|
1271
|
+
# identifiers.
|
|
1272
|
+
#
|
|
1273
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::ResourcesUsed>, nil]
|
|
1274
|
+
optional :resources_used,
|
|
1275
|
+
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::UserReportEventRequest::ResourcesUsed] }
|
|
1247
1276
|
|
|
1248
|
-
|
|
1249
|
-
|
|
1250
|
-
|
|
1251
|
-
|
|
1277
|
+
# @!attribute target_content_id
|
|
1278
|
+
# Your stable identifier for the user-owned content that is the target of a
|
|
1279
|
+
# report.
|
|
1280
|
+
#
|
|
1281
|
+
# @return [String, nil]
|
|
1282
|
+
optional :target_content_id, String
|
|
1252
1283
|
|
|
1253
|
-
|
|
1254
|
-
|
|
1284
|
+
# @!attribute target_user_id
|
|
1285
|
+
# Your stable canonical identifier for the user being reported.
|
|
1286
|
+
#
|
|
1287
|
+
# @return [String, nil]
|
|
1288
|
+
optional :target_user_id, String
|
|
1289
|
+
|
|
1290
|
+
# @!method initialize(event_name:, labels:, timestamp:, type:, user_id:, content: nil, content_id: nil, metadata: nil, resources_used: nil, target_content_id: nil, target_user_id: nil)
|
|
1291
|
+
# Some parameter documentations has been truncated, see
|
|
1292
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest} for
|
|
1293
|
+
# more details.
|
|
1294
|
+
#
|
|
1295
|
+
# A user-submitted report. Use user_id for the reporter, content and content_id
|
|
1296
|
+
# for the report itself, and target_user_id or target_content_id for what was
|
|
1297
|
+
# reported.
|
|
1298
|
+
#
|
|
1299
|
+
# @param event_name [String] Stable, low-cardinality product action name. Use snake_case and put dynamic valu
|
|
1300
|
+
#
|
|
1301
|
+
# @param labels [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Label>] One or more label categories supplied with the report.
|
|
1302
|
+
#
|
|
1303
|
+
# @param timestamp [Time] The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
1304
|
+
#
|
|
1305
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Type]
|
|
1306
|
+
#
|
|
1307
|
+
# @param user_id [String] Your stable canonical identifier for the user or account.
|
|
1308
|
+
#
|
|
1309
|
+
# @param content [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventImageContent>] User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
1310
|
+
#
|
|
1311
|
+
# @param content_id [String] Your stable identifier for the content involved in this event, such as a message
|
|
1312
|
+
#
|
|
1313
|
+
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
1314
|
+
#
|
|
1315
|
+
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::ResourcesUsed>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
1316
|
+
#
|
|
1317
|
+
# @param target_content_id [String] Your stable identifier for the user-owned content that is the target of a report
|
|
1318
|
+
#
|
|
1319
|
+
# @param target_user_id [String] Your stable canonical identifier for the user being reported.
|
|
1320
|
+
|
|
1321
|
+
class Label < SafetyKit::Internal::Type::BaseModel
|
|
1322
|
+
# @!attribute label
|
|
1323
|
+
# Stable snake_case report label category.
|
|
1255
1324
|
#
|
|
1256
1325
|
# @return [String]
|
|
1257
|
-
required :
|
|
1326
|
+
required :label, String
|
|
1258
1327
|
|
|
1259
|
-
# @!
|
|
1260
|
-
#
|
|
1261
|
-
# listing text, image URLs, and similar content SafetyKit should compare or
|
|
1262
|
-
# analyze.
|
|
1328
|
+
# @!method initialize(label:)
|
|
1329
|
+
# Label category supplied with a user report.
|
|
1263
1330
|
#
|
|
1264
|
-
# @
|
|
1265
|
-
|
|
1266
|
-
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember4::UserContact::Content] }
|
|
1331
|
+
# @param label [String] Stable snake_case report label category.
|
|
1332
|
+
end
|
|
1267
1333
|
|
|
1268
|
-
|
|
1269
|
-
|
|
1270
|
-
|
|
1271
|
-
#
|
|
1272
|
-
# @return [String, nil]
|
|
1273
|
-
optional :content_id, String
|
|
1334
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest#type
|
|
1335
|
+
module Type
|
|
1336
|
+
extend SafetyKit::Internal::Type::Enum
|
|
1274
1337
|
|
|
1275
|
-
|
|
1276
|
-
# Non-PII product context for filtering, segmentation, and debugging. Values may
|
|
1277
|
-
# be strings, numbers, booleans, or arrays of those scalar values.
|
|
1278
|
-
#
|
|
1279
|
-
# @return [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}, nil]
|
|
1280
|
-
optional :metadata,
|
|
1281
|
-
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember4::UserContact::Metadata] }
|
|
1338
|
+
USER_REPORT = :user_report
|
|
1282
1339
|
|
|
1283
|
-
# @!
|
|
1284
|
-
#
|
|
1285
|
-
|
|
1286
|
-
# identifiers.
|
|
1287
|
-
#
|
|
1288
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::UserContact::ResourcesUsed>, nil]
|
|
1289
|
-
optional :resources_used,
|
|
1290
|
-
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::UnionMember4::UserContact::ResourcesUsed] }
|
|
1340
|
+
# @!method self.values
|
|
1341
|
+
# @return [Array<Symbol>]
|
|
1342
|
+
end
|
|
1291
1343
|
|
|
1292
|
-
|
|
1293
|
-
|
|
1294
|
-
|
|
1295
|
-
# for more details.
|
|
1296
|
-
#
|
|
1297
|
-
# A user contacts, transacts with, or otherwise interacts with another user.
|
|
1298
|
-
#
|
|
1299
|
-
# @param event_name [String] Stable, low-cardinality product action name. Use snake_case and put dynamic valu
|
|
1300
|
-
#
|
|
1301
|
-
# @param target_user_id [String] Your stable canonical identifier for the other user in a user-to-user interactio
|
|
1302
|
-
#
|
|
1303
|
-
# @param timestamp [Time] The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
1304
|
-
#
|
|
1305
|
-
# @param user_id [String] Your stable canonical identifier for the user or account.
|
|
1306
|
-
#
|
|
1307
|
-
# @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,
|
|
1308
|
-
#
|
|
1309
|
-
# @param content_id [String] Your stable identifier for the content involved in this event, such as a message
|
|
1310
|
-
#
|
|
1311
|
-
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
1312
|
-
#
|
|
1313
|
-
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::UserContact::ResourcesUsed>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
1314
|
-
#
|
|
1315
|
-
# @param type [Symbol, :user_contact]
|
|
1344
|
+
# User-authored text content associated with an event.
|
|
1345
|
+
module Content
|
|
1346
|
+
extend SafetyKit::Internal::Type::Union
|
|
1316
1347
|
|
|
1317
1348
|
# User-authored text content associated with an event.
|
|
1318
|
-
|
|
1319
|
-
extend SafetyKit::Internal::Type::Union
|
|
1349
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventTextContent }
|
|
1320
1350
|
|
|
1321
|
-
|
|
1322
|
-
|
|
1351
|
+
# User-uploaded image content associated with an event.
|
|
1352
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventImageContent }
|
|
1323
1353
|
|
|
1324
|
-
|
|
1325
|
-
|
|
1354
|
+
class EventTextContent < SafetyKit::Internal::Type::BaseModel
|
|
1355
|
+
# @!attribute text
|
|
1356
|
+
# User-authored text SafetyKit should compare or analyze.
|
|
1357
|
+
#
|
|
1358
|
+
# @return [String]
|
|
1359
|
+
required :text, String
|
|
1326
1360
|
|
|
1327
|
-
|
|
1328
|
-
|
|
1329
|
-
|
|
1330
|
-
|
|
1331
|
-
|
|
1332
|
-
|
|
1361
|
+
# @!attribute type
|
|
1362
|
+
# Text content part.
|
|
1363
|
+
#
|
|
1364
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventTextContent::Type]
|
|
1365
|
+
required :type,
|
|
1366
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventTextContent::Type }
|
|
1367
|
+
|
|
1368
|
+
# @!attribute key
|
|
1369
|
+
# Stable field key for this content part.
|
|
1370
|
+
#
|
|
1371
|
+
# @return [String, nil]
|
|
1372
|
+
optional :key, String
|
|
1373
|
+
|
|
1374
|
+
# @!method initialize(text:, type:, key: nil)
|
|
1375
|
+
# User-authored text content associated with an event.
|
|
1376
|
+
#
|
|
1377
|
+
# @param text [String] User-authored text SafetyKit should compare or analyze.
|
|
1378
|
+
#
|
|
1379
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventTextContent::Type] Text content part.
|
|
1380
|
+
#
|
|
1381
|
+
# @param key [String] Stable field key for this content part.
|
|
1382
|
+
|
|
1383
|
+
# Text content part.
|
|
1384
|
+
#
|
|
1385
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventTextContent#type
|
|
1386
|
+
module Type
|
|
1387
|
+
extend SafetyKit::Internal::Type::Enum
|
|
1388
|
+
|
|
1389
|
+
TEXT = :text
|
|
1390
|
+
|
|
1391
|
+
# @!method self.values
|
|
1392
|
+
# @return [Array<Symbol>]
|
|
1393
|
+
end
|
|
1394
|
+
end
|
|
1395
|
+
|
|
1396
|
+
class EventImageContent < SafetyKit::Internal::Type::BaseModel
|
|
1397
|
+
# @!attribute source
|
|
1398
|
+
# Image source information.
|
|
1399
|
+
#
|
|
1400
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventImageContent::Source]
|
|
1401
|
+
required :source,
|
|
1402
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventImageContent::Source }
|
|
1403
|
+
|
|
1404
|
+
# @!attribute type
|
|
1405
|
+
# Image content part.
|
|
1406
|
+
#
|
|
1407
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventImageContent::Type]
|
|
1408
|
+
required :type,
|
|
1409
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventImageContent::Type }
|
|
1410
|
+
|
|
1411
|
+
# @!attribute key
|
|
1412
|
+
# Stable field key for this content part.
|
|
1413
|
+
#
|
|
1414
|
+
# @return [String, nil]
|
|
1415
|
+
optional :key, String
|
|
1416
|
+
|
|
1417
|
+
# @!method initialize(source:, type:, key: nil)
|
|
1418
|
+
# User-uploaded image content associated with an event.
|
|
1419
|
+
#
|
|
1420
|
+
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventImageContent::Source] Image source information.
|
|
1421
|
+
#
|
|
1422
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventImageContent::Type] Image content part.
|
|
1423
|
+
#
|
|
1424
|
+
# @param key [String] Stable field key for this content part.
|
|
1333
1425
|
|
|
1426
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventImageContent#source
|
|
1427
|
+
class Source < SafetyKit::Internal::Type::BaseModel
|
|
1334
1428
|
# @!attribute type
|
|
1335
|
-
#
|
|
1429
|
+
# URL image source.
|
|
1336
1430
|
#
|
|
1337
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1431
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventImageContent::Source::Type]
|
|
1338
1432
|
required :type,
|
|
1339
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
1433
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventImageContent::Source::Type }
|
|
1340
1434
|
|
|
1341
|
-
# @!attribute
|
|
1342
|
-
#
|
|
1435
|
+
# @!attribute url
|
|
1436
|
+
# URL of the image SafetyKit should compare or analyze.
|
|
1343
1437
|
#
|
|
1344
|
-
# @return [String
|
|
1345
|
-
|
|
1438
|
+
# @return [String]
|
|
1439
|
+
required :url, String
|
|
1346
1440
|
|
|
1347
|
-
# @!method initialize(
|
|
1348
|
-
#
|
|
1349
|
-
#
|
|
1350
|
-
# @param text [String] User-authored text SafetyKit should compare or analyze.
|
|
1441
|
+
# @!method initialize(type:, url:)
|
|
1442
|
+
# Image source information.
|
|
1351
1443
|
#
|
|
1352
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1444
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventImageContent::Source::Type] URL image source.
|
|
1353
1445
|
#
|
|
1354
|
-
# @param
|
|
1446
|
+
# @param url [String] URL of the image SafetyKit should compare or analyze.
|
|
1355
1447
|
|
|
1356
|
-
#
|
|
1448
|
+
# URL image source.
|
|
1357
1449
|
#
|
|
1358
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1450
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventImageContent::Source#type
|
|
1359
1451
|
module Type
|
|
1360
1452
|
extend SafetyKit::Internal::Type::Enum
|
|
1361
1453
|
|
|
1362
|
-
|
|
1454
|
+
URL = :url
|
|
1363
1455
|
|
|
1364
1456
|
# @!method self.values
|
|
1365
1457
|
# @return [Array<Symbol>]
|
|
1366
1458
|
end
|
|
1367
1459
|
end
|
|
1368
1460
|
|
|
1369
|
-
|
|
1370
|
-
|
|
1371
|
-
|
|
1372
|
-
|
|
1373
|
-
|
|
1374
|
-
|
|
1375
|
-
|
|
1376
|
-
|
|
1377
|
-
# @!
|
|
1461
|
+
# Image content part.
|
|
1462
|
+
#
|
|
1463
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventImageContent#type
|
|
1464
|
+
module Type
|
|
1465
|
+
extend SafetyKit::Internal::Type::Enum
|
|
1466
|
+
|
|
1467
|
+
IMAGE = :image
|
|
1468
|
+
|
|
1469
|
+
# @!method self.values
|
|
1470
|
+
# @return [Array<Symbol>]
|
|
1471
|
+
end
|
|
1472
|
+
end
|
|
1473
|
+
|
|
1474
|
+
# @!method self.variants
|
|
1475
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventImageContent)]
|
|
1476
|
+
end
|
|
1477
|
+
|
|
1478
|
+
module Metadata
|
|
1479
|
+
extend SafetyKit::Internal::Type::Union
|
|
1480
|
+
|
|
1481
|
+
variant String
|
|
1482
|
+
|
|
1483
|
+
variant Float
|
|
1484
|
+
|
|
1485
|
+
variant SafetyKit::Internal::Type::Boolean
|
|
1486
|
+
|
|
1487
|
+
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Metadata::UnionMember3Array }
|
|
1488
|
+
|
|
1489
|
+
module UnionMember3
|
|
1490
|
+
extend SafetyKit::Internal::Type::Union
|
|
1491
|
+
|
|
1492
|
+
variant String
|
|
1493
|
+
|
|
1494
|
+
variant Float
|
|
1495
|
+
|
|
1496
|
+
variant SafetyKit::Internal::Type::Boolean
|
|
1497
|
+
|
|
1498
|
+
# @!method self.variants
|
|
1499
|
+
# @return [Array(String, Float, Boolean)]
|
|
1500
|
+
end
|
|
1501
|
+
|
|
1502
|
+
# @!method self.variants
|
|
1503
|
+
# @return [Array(String, Float, Boolean, Array<String, Float, Boolean>)]
|
|
1504
|
+
|
|
1505
|
+
# @type [SafetyKit::Internal::Type::Converter]
|
|
1506
|
+
UnionMember3Array =
|
|
1507
|
+
SafetyKit::Internal::Type::ArrayOf[union: -> {
|
|
1508
|
+
SafetyKit::Beta::EventCreateParams::Body::UserReportEventRequest::Metadata::UnionMember3
|
|
1509
|
+
}]
|
|
1510
|
+
end
|
|
1511
|
+
|
|
1512
|
+
class ResourcesUsed < SafetyKit::Internal::Type::BaseModel
|
|
1513
|
+
# @!attribute type
|
|
1514
|
+
# Resource family, such as email, phone, name, address, url, instagram, tiktok,
|
|
1515
|
+
# youtube, linkedin, or another stable snake_case identifier.
|
|
1516
|
+
#
|
|
1517
|
+
# @return [String]
|
|
1518
|
+
required :type, String
|
|
1519
|
+
|
|
1520
|
+
# @!attribute value
|
|
1521
|
+
# Resource value used during the event. SafetyKit stores a normalized hash of this
|
|
1522
|
+
# value, not the raw value. When type is url, this must be a valid URL.
|
|
1523
|
+
#
|
|
1524
|
+
# @return [String]
|
|
1525
|
+
required :value, String
|
|
1526
|
+
|
|
1527
|
+
# @!method initialize(type:, value:)
|
|
1528
|
+
# Some parameter documentations has been truncated, see
|
|
1529
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::ResourcesUsed}
|
|
1530
|
+
# for more details.
|
|
1531
|
+
#
|
|
1532
|
+
# Real-world or account resource used during the event, such as an email, phone
|
|
1533
|
+
# number, address, URL, social handle, or payment identifier.
|
|
1534
|
+
#
|
|
1535
|
+
# @param type [String] Resource family, such as email, phone, name, address, url, instagram, tiktok, yo
|
|
1536
|
+
#
|
|
1537
|
+
# @param value [String] Resource value used during the event. SafetyKit stores a normalized hash of this
|
|
1538
|
+
end
|
|
1539
|
+
end
|
|
1540
|
+
|
|
1541
|
+
# A user contacts, transacts with, or otherwise interacts with another user.
|
|
1542
|
+
module UnionMember5
|
|
1543
|
+
extend SafetyKit::Internal::Type::Union
|
|
1544
|
+
|
|
1545
|
+
discriminator :type
|
|
1546
|
+
|
|
1547
|
+
# A user contacts, transacts with, or otherwise interacts with another user.
|
|
1548
|
+
variant :user_contact, -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember5::UserContact }
|
|
1549
|
+
|
|
1550
|
+
# A user posts, uploads, publishes, edits, or replaces content.
|
|
1551
|
+
variant :content_uploaded, -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember5::ContentUploaded }
|
|
1552
|
+
|
|
1553
|
+
# A user or account is created.
|
|
1554
|
+
variant :create_account, -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember5::CreateAccount }
|
|
1555
|
+
|
|
1556
|
+
# A user or account profile, contact detail, payment detail, or public bio changes.
|
|
1557
|
+
variant :update_account, -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember5::UpdateAccount }
|
|
1558
|
+
|
|
1559
|
+
# A user-submitted report. Use user_id for the reporter, content and content_id for the report itself, and target_user_id or target_content_id for what was reported.
|
|
1560
|
+
variant :user_report, -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember5::UserReport }
|
|
1561
|
+
|
|
1562
|
+
class UserContact < SafetyKit::Internal::Type::BaseModel
|
|
1563
|
+
# @!attribute event_name
|
|
1564
|
+
# Stable, low-cardinality product action name. Use snake_case and put dynamic
|
|
1565
|
+
# values in typed fields, content, resources_used, or metadata.
|
|
1566
|
+
#
|
|
1567
|
+
# @return [String]
|
|
1568
|
+
required :event_name, String
|
|
1569
|
+
|
|
1570
|
+
# @!attribute target_user_id
|
|
1571
|
+
# Your stable canonical identifier for the other user in a user-to-user
|
|
1572
|
+
# interaction.
|
|
1573
|
+
#
|
|
1574
|
+
# @return [String]
|
|
1575
|
+
required :target_user_id, String
|
|
1576
|
+
|
|
1577
|
+
# @!attribute timestamp
|
|
1578
|
+
# The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
1579
|
+
#
|
|
1580
|
+
# @return [Time]
|
|
1581
|
+
required :timestamp, Time
|
|
1582
|
+
|
|
1583
|
+
# @!attribute type
|
|
1584
|
+
#
|
|
1585
|
+
# @return [Symbol, :user_contact]
|
|
1586
|
+
required :type, const: :user_contact
|
|
1587
|
+
|
|
1588
|
+
# @!attribute user_id
|
|
1589
|
+
# Your stable canonical identifier for the user or account.
|
|
1590
|
+
#
|
|
1591
|
+
# @return [String]
|
|
1592
|
+
required :user_id, String
|
|
1593
|
+
|
|
1594
|
+
# @!attribute content
|
|
1595
|
+
# User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
1596
|
+
# listing text, image URLs, and similar content SafetyKit should compare or
|
|
1597
|
+
# analyze.
|
|
1598
|
+
#
|
|
1599
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UserContact::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UserContact::Content::EventImageContent>, nil]
|
|
1600
|
+
optional :content,
|
|
1601
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember5::UserContact::Content] }
|
|
1602
|
+
|
|
1603
|
+
# @!attribute content_id
|
|
1604
|
+
# Your stable identifier for the content involved in this event, such as a
|
|
1605
|
+
# message, listing, page, post, profile, or uploaded media item.
|
|
1606
|
+
#
|
|
1607
|
+
# @return [String, nil]
|
|
1608
|
+
optional :content_id, String
|
|
1609
|
+
|
|
1610
|
+
# @!attribute metadata
|
|
1611
|
+
# Non-PII product context for filtering, segmentation, and debugging. Values may
|
|
1612
|
+
# be strings, numbers, booleans, or arrays of those scalar values.
|
|
1613
|
+
#
|
|
1614
|
+
# @return [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}, nil]
|
|
1615
|
+
optional :metadata,
|
|
1616
|
+
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember5::UserContact::Metadata] }
|
|
1617
|
+
|
|
1618
|
+
# @!attribute resources_used
|
|
1619
|
+
# Reusable resources observed during the event. Use this for emails, phone
|
|
1620
|
+
# numbers, names, addresses, social handles, URLs, payment identifiers, or similar
|
|
1621
|
+
# identifiers.
|
|
1622
|
+
#
|
|
1623
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UserContact::ResourcesUsed>, nil]
|
|
1624
|
+
optional :resources_used,
|
|
1625
|
+
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::UnionMember5::UserContact::ResourcesUsed] }
|
|
1626
|
+
|
|
1627
|
+
# @!method initialize(event_name:, target_user_id:, timestamp:, user_id:, content: nil, content_id: nil, metadata: nil, resources_used: nil, type: :user_contact)
|
|
1628
|
+
# Some parameter documentations has been truncated, see
|
|
1629
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UserContact}
|
|
1630
|
+
# for more details.
|
|
1631
|
+
#
|
|
1632
|
+
# A user contacts, transacts with, or otherwise interacts with another user.
|
|
1633
|
+
#
|
|
1634
|
+
# @param event_name [String] Stable, low-cardinality product action name. Use snake_case and put dynamic valu
|
|
1635
|
+
#
|
|
1636
|
+
# @param target_user_id [String] Your stable canonical identifier for the other user in a user-to-user interactio
|
|
1637
|
+
#
|
|
1638
|
+
# @param timestamp [Time] The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
1639
|
+
#
|
|
1640
|
+
# @param user_id [String] Your stable canonical identifier for the user or account.
|
|
1641
|
+
#
|
|
1642
|
+
# @param content [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UserContact::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UserContact::Content::EventImageContent>] User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
1643
|
+
#
|
|
1644
|
+
# @param content_id [String] Your stable identifier for the content involved in this event, such as a message
|
|
1645
|
+
#
|
|
1646
|
+
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
1647
|
+
#
|
|
1648
|
+
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UserContact::ResourcesUsed>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
1649
|
+
#
|
|
1650
|
+
# @param type [Symbol, :user_contact]
|
|
1651
|
+
|
|
1652
|
+
# User-authored text content associated with an event.
|
|
1653
|
+
module Content
|
|
1654
|
+
extend SafetyKit::Internal::Type::Union
|
|
1655
|
+
|
|
1656
|
+
# User-authored text content associated with an event.
|
|
1657
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember5::UserContact::Content::EventTextContent }
|
|
1658
|
+
|
|
1659
|
+
# User-uploaded image content associated with an event.
|
|
1660
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember5::UserContact::Content::EventImageContent }
|
|
1661
|
+
|
|
1662
|
+
class EventTextContent < SafetyKit::Internal::Type::BaseModel
|
|
1663
|
+
# @!attribute text
|
|
1664
|
+
# User-authored text SafetyKit should compare or analyze.
|
|
1665
|
+
#
|
|
1666
|
+
# @return [String]
|
|
1667
|
+
required :text, String
|
|
1668
|
+
|
|
1669
|
+
# @!attribute type
|
|
1670
|
+
# Text content part.
|
|
1671
|
+
#
|
|
1672
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UserContact::Content::EventTextContent::Type]
|
|
1673
|
+
required :type,
|
|
1674
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember5::UserContact::Content::EventTextContent::Type }
|
|
1675
|
+
|
|
1676
|
+
# @!attribute key
|
|
1677
|
+
# Stable field key for this content part.
|
|
1678
|
+
#
|
|
1679
|
+
# @return [String, nil]
|
|
1680
|
+
optional :key, String
|
|
1681
|
+
|
|
1682
|
+
# @!method initialize(text:, type:, key: nil)
|
|
1683
|
+
# User-authored text content associated with an event.
|
|
1684
|
+
#
|
|
1685
|
+
# @param text [String] User-authored text SafetyKit should compare or analyze.
|
|
1686
|
+
#
|
|
1687
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UserContact::Content::EventTextContent::Type] Text content part.
|
|
1688
|
+
#
|
|
1689
|
+
# @param key [String] Stable field key for this content part.
|
|
1690
|
+
|
|
1691
|
+
# Text content part.
|
|
1692
|
+
#
|
|
1693
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UserContact::Content::EventTextContent#type
|
|
1694
|
+
module Type
|
|
1695
|
+
extend SafetyKit::Internal::Type::Enum
|
|
1696
|
+
|
|
1697
|
+
TEXT = :text
|
|
1698
|
+
|
|
1699
|
+
# @!method self.values
|
|
1700
|
+
# @return [Array<Symbol>]
|
|
1701
|
+
end
|
|
1702
|
+
end
|
|
1703
|
+
|
|
1704
|
+
class EventImageContent < SafetyKit::Internal::Type::BaseModel
|
|
1705
|
+
# @!attribute source
|
|
1706
|
+
# Image source information.
|
|
1707
|
+
#
|
|
1708
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UserContact::Content::EventImageContent::Source]
|
|
1709
|
+
required :source,
|
|
1710
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::UnionMember5::UserContact::Content::EventImageContent::Source }
|
|
1711
|
+
|
|
1712
|
+
# @!attribute type
|
|
1378
1713
|
# Image content part.
|
|
1379
1714
|
#
|
|
1380
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1715
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UserContact::Content::EventImageContent::Type]
|
|
1381
1716
|
required :type,
|
|
1382
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
1717
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember5::UserContact::Content::EventImageContent::Type }
|
|
1383
1718
|
|
|
1384
1719
|
# @!attribute key
|
|
1385
1720
|
# Stable field key for this content part.
|
|
@@ -1390,20 +1725,20 @@ module SafetyKit
|
|
|
1390
1725
|
# @!method initialize(source:, type:, key: nil)
|
|
1391
1726
|
# User-uploaded image content associated with an event.
|
|
1392
1727
|
#
|
|
1393
|
-
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1728
|
+
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UserContact::Content::EventImageContent::Source] Image source information.
|
|
1394
1729
|
#
|
|
1395
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1730
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UserContact::Content::EventImageContent::Type] Image content part.
|
|
1396
1731
|
#
|
|
1397
1732
|
# @param key [String] Stable field key for this content part.
|
|
1398
1733
|
|
|
1399
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1734
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UserContact::Content::EventImageContent#source
|
|
1400
1735
|
class Source < SafetyKit::Internal::Type::BaseModel
|
|
1401
1736
|
# @!attribute type
|
|
1402
1737
|
# URL image source.
|
|
1403
1738
|
#
|
|
1404
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1739
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UserContact::Content::EventImageContent::Source::Type]
|
|
1405
1740
|
required :type,
|
|
1406
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
1741
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember5::UserContact::Content::EventImageContent::Source::Type }
|
|
1407
1742
|
|
|
1408
1743
|
# @!attribute url
|
|
1409
1744
|
# URL of the image SafetyKit should compare or analyze.
|
|
@@ -1414,13 +1749,13 @@ module SafetyKit
|
|
|
1414
1749
|
# @!method initialize(type:, url:)
|
|
1415
1750
|
# Image source information.
|
|
1416
1751
|
#
|
|
1417
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1752
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UserContact::Content::EventImageContent::Source::Type] URL image source.
|
|
1418
1753
|
#
|
|
1419
1754
|
# @param url [String] URL of the image SafetyKit should compare or analyze.
|
|
1420
1755
|
|
|
1421
1756
|
# URL image source.
|
|
1422
1757
|
#
|
|
1423
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1758
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UserContact::Content::EventImageContent::Source#type
|
|
1424
1759
|
module Type
|
|
1425
1760
|
extend SafetyKit::Internal::Type::Enum
|
|
1426
1761
|
|
|
@@ -1433,7 +1768,7 @@ module SafetyKit
|
|
|
1433
1768
|
|
|
1434
1769
|
# Image content part.
|
|
1435
1770
|
#
|
|
1436
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1771
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UserContact::Content::EventImageContent#type
|
|
1437
1772
|
module Type
|
|
1438
1773
|
extend SafetyKit::Internal::Type::Enum
|
|
1439
1774
|
|
|
@@ -1445,7 +1780,7 @@ module SafetyKit
|
|
|
1445
1780
|
end
|
|
1446
1781
|
|
|
1447
1782
|
# @!method self.variants
|
|
1448
|
-
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1783
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UserContact::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UserContact::Content::EventImageContent)]
|
|
1449
1784
|
end
|
|
1450
1785
|
|
|
1451
1786
|
module Metadata
|
|
@@ -1457,7 +1792,7 @@ module SafetyKit
|
|
|
1457
1792
|
|
|
1458
1793
|
variant SafetyKit::Internal::Type::Boolean
|
|
1459
1794
|
|
|
1460
|
-
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1795
|
+
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UserContact::Metadata::UnionMember3Array }
|
|
1461
1796
|
|
|
1462
1797
|
module UnionMember3
|
|
1463
1798
|
extend SafetyKit::Internal::Type::Union
|
|
@@ -1478,7 +1813,7 @@ module SafetyKit
|
|
|
1478
1813
|
# @type [SafetyKit::Internal::Type::Converter]
|
|
1479
1814
|
UnionMember3Array =
|
|
1480
1815
|
SafetyKit::Internal::Type::ArrayOf[union: -> {
|
|
1481
|
-
SafetyKit::Beta::EventCreateParams::Body::
|
|
1816
|
+
SafetyKit::Beta::EventCreateParams::Body::UnionMember5::UserContact::Metadata::UnionMember3
|
|
1482
1817
|
}]
|
|
1483
1818
|
end
|
|
1484
1819
|
|
|
@@ -1499,7 +1834,7 @@ module SafetyKit
|
|
|
1499
1834
|
|
|
1500
1835
|
# @!method initialize(type:, value:)
|
|
1501
1836
|
# Some parameter documentations has been truncated, see
|
|
1502
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1837
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UserContact::ResourcesUsed}
|
|
1503
1838
|
# for more details.
|
|
1504
1839
|
#
|
|
1505
1840
|
# Real-world or account resource used during the event, such as an email, phone
|
|
@@ -1517,9 +1852,9 @@ module SafetyKit
|
|
|
1517
1852
|
# listing text, image URLs, and similar content SafetyKit should compare or
|
|
1518
1853
|
# analyze.
|
|
1519
1854
|
#
|
|
1520
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1855
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::ContentUploaded::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::ContentUploaded::Content::EventImageContent>]
|
|
1521
1856
|
required :content,
|
|
1522
|
-
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
1857
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember5::ContentUploaded::Content] }
|
|
1523
1858
|
|
|
1524
1859
|
# @!attribute event_name
|
|
1525
1860
|
# Stable, low-cardinality product action name. Use snake_case and put dynamic
|
|
@@ -1558,25 +1893,25 @@ module SafetyKit
|
|
|
1558
1893
|
#
|
|
1559
1894
|
# @return [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}, nil]
|
|
1560
1895
|
optional :metadata,
|
|
1561
|
-
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
1896
|
+
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember5::ContentUploaded::Metadata] }
|
|
1562
1897
|
|
|
1563
1898
|
# @!attribute resources_used
|
|
1564
1899
|
# Reusable resources observed during the event. Use this for emails, phone
|
|
1565
1900
|
# numbers, names, addresses, social handles, URLs, payment identifiers, or similar
|
|
1566
1901
|
# identifiers.
|
|
1567
1902
|
#
|
|
1568
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1903
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::ContentUploaded::ResourcesUsed>, nil]
|
|
1569
1904
|
optional :resources_used,
|
|
1570
|
-
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::
|
|
1905
|
+
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::UnionMember5::ContentUploaded::ResourcesUsed] }
|
|
1571
1906
|
|
|
1572
1907
|
# @!method initialize(content:, event_name:, timestamp:, user_id:, content_id: nil, metadata: nil, resources_used: nil, type: :content_uploaded)
|
|
1573
1908
|
# Some parameter documentations has been truncated, see
|
|
1574
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1909
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::ContentUploaded}
|
|
1575
1910
|
# for more details.
|
|
1576
1911
|
#
|
|
1577
1912
|
# A user posts, uploads, publishes, edits, or replaces content.
|
|
1578
1913
|
#
|
|
1579
|
-
# @param content [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1914
|
+
# @param content [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::ContentUploaded::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::ContentUploaded::Content::EventImageContent>] User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
1580
1915
|
#
|
|
1581
1916
|
# @param event_name [String] Stable, low-cardinality product action name. Use snake_case and put dynamic valu
|
|
1582
1917
|
#
|
|
@@ -1588,7 +1923,7 @@ module SafetyKit
|
|
|
1588
1923
|
#
|
|
1589
1924
|
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
1590
1925
|
#
|
|
1591
|
-
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1926
|
+
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::ContentUploaded::ResourcesUsed>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
1592
1927
|
#
|
|
1593
1928
|
# @param type [Symbol, :content_uploaded]
|
|
1594
1929
|
|
|
@@ -1597,10 +1932,10 @@ module SafetyKit
|
|
|
1597
1932
|
extend SafetyKit::Internal::Type::Union
|
|
1598
1933
|
|
|
1599
1934
|
# User-authored text content associated with an event.
|
|
1600
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
1935
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember5::ContentUploaded::Content::EventTextContent }
|
|
1601
1936
|
|
|
1602
1937
|
# User-uploaded image content associated with an event.
|
|
1603
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
1938
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember5::ContentUploaded::Content::EventImageContent }
|
|
1604
1939
|
|
|
1605
1940
|
class EventTextContent < SafetyKit::Internal::Type::BaseModel
|
|
1606
1941
|
# @!attribute text
|
|
@@ -1612,9 +1947,9 @@ module SafetyKit
|
|
|
1612
1947
|
# @!attribute type
|
|
1613
1948
|
# Text content part.
|
|
1614
1949
|
#
|
|
1615
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1950
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::ContentUploaded::Content::EventTextContent::Type]
|
|
1616
1951
|
required :type,
|
|
1617
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
1952
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember5::ContentUploaded::Content::EventTextContent::Type }
|
|
1618
1953
|
|
|
1619
1954
|
# @!attribute key
|
|
1620
1955
|
# Stable field key for this content part.
|
|
@@ -1627,13 +1962,13 @@ module SafetyKit
|
|
|
1627
1962
|
#
|
|
1628
1963
|
# @param text [String] User-authored text SafetyKit should compare or analyze.
|
|
1629
1964
|
#
|
|
1630
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1965
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::ContentUploaded::Content::EventTextContent::Type] Text content part.
|
|
1631
1966
|
#
|
|
1632
1967
|
# @param key [String] Stable field key for this content part.
|
|
1633
1968
|
|
|
1634
1969
|
# Text content part.
|
|
1635
1970
|
#
|
|
1636
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1971
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::ContentUploaded::Content::EventTextContent#type
|
|
1637
1972
|
module Type
|
|
1638
1973
|
extend SafetyKit::Internal::Type::Enum
|
|
1639
1974
|
|
|
@@ -1648,16 +1983,16 @@ module SafetyKit
|
|
|
1648
1983
|
# @!attribute source
|
|
1649
1984
|
# Image source information.
|
|
1650
1985
|
#
|
|
1651
|
-
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1986
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::ContentUploaded::Content::EventImageContent::Source]
|
|
1652
1987
|
required :source,
|
|
1653
|
-
-> { SafetyKit::Beta::EventCreateParams::Body::
|
|
1988
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::UnionMember5::ContentUploaded::Content::EventImageContent::Source }
|
|
1654
1989
|
|
|
1655
1990
|
# @!attribute type
|
|
1656
1991
|
# Image content part.
|
|
1657
1992
|
#
|
|
1658
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1993
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::ContentUploaded::Content::EventImageContent::Type]
|
|
1659
1994
|
required :type,
|
|
1660
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
1995
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember5::ContentUploaded::Content::EventImageContent::Type }
|
|
1661
1996
|
|
|
1662
1997
|
# @!attribute key
|
|
1663
1998
|
# Stable field key for this content part.
|
|
@@ -1668,20 +2003,20 @@ module SafetyKit
|
|
|
1668
2003
|
# @!method initialize(source:, type:, key: nil)
|
|
1669
2004
|
# User-uploaded image content associated with an event.
|
|
1670
2005
|
#
|
|
1671
|
-
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2006
|
+
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::ContentUploaded::Content::EventImageContent::Source] Image source information.
|
|
1672
2007
|
#
|
|
1673
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2008
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::ContentUploaded::Content::EventImageContent::Type] Image content part.
|
|
1674
2009
|
#
|
|
1675
2010
|
# @param key [String] Stable field key for this content part.
|
|
1676
2011
|
|
|
1677
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2012
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::ContentUploaded::Content::EventImageContent#source
|
|
1678
2013
|
class Source < SafetyKit::Internal::Type::BaseModel
|
|
1679
2014
|
# @!attribute type
|
|
1680
2015
|
# URL image source.
|
|
1681
2016
|
#
|
|
1682
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2017
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::ContentUploaded::Content::EventImageContent::Source::Type]
|
|
1683
2018
|
required :type,
|
|
1684
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
2019
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember5::ContentUploaded::Content::EventImageContent::Source::Type }
|
|
1685
2020
|
|
|
1686
2021
|
# @!attribute url
|
|
1687
2022
|
# URL of the image SafetyKit should compare or analyze.
|
|
@@ -1692,13 +2027,13 @@ module SafetyKit
|
|
|
1692
2027
|
# @!method initialize(type:, url:)
|
|
1693
2028
|
# Image source information.
|
|
1694
2029
|
#
|
|
1695
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2030
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::ContentUploaded::Content::EventImageContent::Source::Type] URL image source.
|
|
1696
2031
|
#
|
|
1697
2032
|
# @param url [String] URL of the image SafetyKit should compare or analyze.
|
|
1698
2033
|
|
|
1699
2034
|
# URL image source.
|
|
1700
2035
|
#
|
|
1701
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2036
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::ContentUploaded::Content::EventImageContent::Source#type
|
|
1702
2037
|
module Type
|
|
1703
2038
|
extend SafetyKit::Internal::Type::Enum
|
|
1704
2039
|
|
|
@@ -1711,7 +2046,7 @@ module SafetyKit
|
|
|
1711
2046
|
|
|
1712
2047
|
# Image content part.
|
|
1713
2048
|
#
|
|
1714
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2049
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::ContentUploaded::Content::EventImageContent#type
|
|
1715
2050
|
module Type
|
|
1716
2051
|
extend SafetyKit::Internal::Type::Enum
|
|
1717
2052
|
|
|
@@ -1723,7 +2058,7 @@ module SafetyKit
|
|
|
1723
2058
|
end
|
|
1724
2059
|
|
|
1725
2060
|
# @!method self.variants
|
|
1726
|
-
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2061
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::ContentUploaded::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::ContentUploaded::Content::EventImageContent)]
|
|
1727
2062
|
end
|
|
1728
2063
|
|
|
1729
2064
|
module Metadata
|
|
@@ -1735,7 +2070,7 @@ module SafetyKit
|
|
|
1735
2070
|
|
|
1736
2071
|
variant SafetyKit::Internal::Type::Boolean
|
|
1737
2072
|
|
|
1738
|
-
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2073
|
+
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::ContentUploaded::Metadata::UnionMember3Array }
|
|
1739
2074
|
|
|
1740
2075
|
module UnionMember3
|
|
1741
2076
|
extend SafetyKit::Internal::Type::Union
|
|
@@ -1756,7 +2091,7 @@ module SafetyKit
|
|
|
1756
2091
|
# @type [SafetyKit::Internal::Type::Converter]
|
|
1757
2092
|
UnionMember3Array =
|
|
1758
2093
|
SafetyKit::Internal::Type::ArrayOf[
|
|
1759
|
-
union: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
2094
|
+
union: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember5::ContentUploaded::Metadata::UnionMember3 }
|
|
1760
2095
|
]
|
|
1761
2096
|
end
|
|
1762
2097
|
|
|
@@ -1777,7 +2112,7 @@ module SafetyKit
|
|
|
1777
2112
|
|
|
1778
2113
|
# @!method initialize(type:, value:)
|
|
1779
2114
|
# Some parameter documentations has been truncated, see
|
|
1780
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2115
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::ContentUploaded::ResourcesUsed}
|
|
1781
2116
|
# for more details.
|
|
1782
2117
|
#
|
|
1783
2118
|
# Real-world or account resource used during the event, such as an email, phone
|
|
@@ -1819,9 +2154,9 @@ module SafetyKit
|
|
|
1819
2154
|
# listing text, image URLs, and similar content SafetyKit should compare or
|
|
1820
2155
|
# analyze.
|
|
1821
2156
|
#
|
|
1822
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2157
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::CreateAccount::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::CreateAccount::Content::EventImageContent>, nil]
|
|
1823
2158
|
optional :content,
|
|
1824
|
-
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
2159
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember5::CreateAccount::Content] }
|
|
1825
2160
|
|
|
1826
2161
|
# @!attribute content_id
|
|
1827
2162
|
# Your stable identifier for the content involved in this event, such as a
|
|
@@ -1836,20 +2171,20 @@ module SafetyKit
|
|
|
1836
2171
|
#
|
|
1837
2172
|
# @return [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}, nil]
|
|
1838
2173
|
optional :metadata,
|
|
1839
|
-
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
2174
|
+
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember5::CreateAccount::Metadata] }
|
|
1840
2175
|
|
|
1841
2176
|
# @!attribute resources_used
|
|
1842
2177
|
# Reusable resources observed during the event. Use this for emails, phone
|
|
1843
2178
|
# numbers, names, addresses, social handles, URLs, payment identifiers, or similar
|
|
1844
2179
|
# identifiers.
|
|
1845
2180
|
#
|
|
1846
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2181
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::CreateAccount::ResourcesUsed>, nil]
|
|
1847
2182
|
optional :resources_used,
|
|
1848
|
-
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::
|
|
2183
|
+
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::UnionMember5::CreateAccount::ResourcesUsed] }
|
|
1849
2184
|
|
|
1850
2185
|
# @!method initialize(event_name:, timestamp:, user_id:, content: nil, content_id: nil, metadata: nil, resources_used: nil, type: :create_account)
|
|
1851
2186
|
# Some parameter documentations has been truncated, see
|
|
1852
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2187
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::CreateAccount}
|
|
1853
2188
|
# for more details.
|
|
1854
2189
|
#
|
|
1855
2190
|
# A user or account is created.
|
|
@@ -1860,13 +2195,13 @@ module SafetyKit
|
|
|
1860
2195
|
#
|
|
1861
2196
|
# @param user_id [String] Your stable canonical identifier for the user or account.
|
|
1862
2197
|
#
|
|
1863
|
-
# @param content [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2198
|
+
# @param content [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::CreateAccount::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::CreateAccount::Content::EventImageContent>] User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
1864
2199
|
#
|
|
1865
2200
|
# @param content_id [String] Your stable identifier for the content involved in this event, such as a message
|
|
1866
2201
|
#
|
|
1867
2202
|
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
1868
2203
|
#
|
|
1869
|
-
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2204
|
+
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::CreateAccount::ResourcesUsed>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
1870
2205
|
#
|
|
1871
2206
|
# @param type [Symbol, :create_account]
|
|
1872
2207
|
|
|
@@ -1875,10 +2210,10 @@ module SafetyKit
|
|
|
1875
2210
|
extend SafetyKit::Internal::Type::Union
|
|
1876
2211
|
|
|
1877
2212
|
# User-authored text content associated with an event.
|
|
1878
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
2213
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember5::CreateAccount::Content::EventTextContent }
|
|
1879
2214
|
|
|
1880
2215
|
# User-uploaded image content associated with an event.
|
|
1881
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
2216
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember5::CreateAccount::Content::EventImageContent }
|
|
1882
2217
|
|
|
1883
2218
|
class EventTextContent < SafetyKit::Internal::Type::BaseModel
|
|
1884
2219
|
# @!attribute text
|
|
@@ -1890,9 +2225,9 @@ module SafetyKit
|
|
|
1890
2225
|
# @!attribute type
|
|
1891
2226
|
# Text content part.
|
|
1892
2227
|
#
|
|
1893
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2228
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::CreateAccount::Content::EventTextContent::Type]
|
|
1894
2229
|
required :type,
|
|
1895
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
2230
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember5::CreateAccount::Content::EventTextContent::Type }
|
|
1896
2231
|
|
|
1897
2232
|
# @!attribute key
|
|
1898
2233
|
# Stable field key for this content part.
|
|
@@ -1905,13 +2240,13 @@ module SafetyKit
|
|
|
1905
2240
|
#
|
|
1906
2241
|
# @param text [String] User-authored text SafetyKit should compare or analyze.
|
|
1907
2242
|
#
|
|
1908
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2243
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::CreateAccount::Content::EventTextContent::Type] Text content part.
|
|
1909
2244
|
#
|
|
1910
2245
|
# @param key [String] Stable field key for this content part.
|
|
1911
2246
|
|
|
1912
2247
|
# Text content part.
|
|
1913
2248
|
#
|
|
1914
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2249
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::CreateAccount::Content::EventTextContent#type
|
|
1915
2250
|
module Type
|
|
1916
2251
|
extend SafetyKit::Internal::Type::Enum
|
|
1917
2252
|
|
|
@@ -1926,16 +2261,16 @@ module SafetyKit
|
|
|
1926
2261
|
# @!attribute source
|
|
1927
2262
|
# Image source information.
|
|
1928
2263
|
#
|
|
1929
|
-
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2264
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::CreateAccount::Content::EventImageContent::Source]
|
|
1930
2265
|
required :source,
|
|
1931
|
-
-> { SafetyKit::Beta::EventCreateParams::Body::
|
|
2266
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::UnionMember5::CreateAccount::Content::EventImageContent::Source }
|
|
1932
2267
|
|
|
1933
2268
|
# @!attribute type
|
|
1934
2269
|
# Image content part.
|
|
1935
2270
|
#
|
|
1936
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2271
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::CreateAccount::Content::EventImageContent::Type]
|
|
1937
2272
|
required :type,
|
|
1938
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
2273
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember5::CreateAccount::Content::EventImageContent::Type }
|
|
1939
2274
|
|
|
1940
2275
|
# @!attribute key
|
|
1941
2276
|
# Stable field key for this content part.
|
|
@@ -1946,20 +2281,20 @@ module SafetyKit
|
|
|
1946
2281
|
# @!method initialize(source:, type:, key: nil)
|
|
1947
2282
|
# User-uploaded image content associated with an event.
|
|
1948
2283
|
#
|
|
1949
|
-
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2284
|
+
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::CreateAccount::Content::EventImageContent::Source] Image source information.
|
|
1950
2285
|
#
|
|
1951
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2286
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::CreateAccount::Content::EventImageContent::Type] Image content part.
|
|
1952
2287
|
#
|
|
1953
2288
|
# @param key [String] Stable field key for this content part.
|
|
1954
2289
|
|
|
1955
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2290
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::CreateAccount::Content::EventImageContent#source
|
|
1956
2291
|
class Source < SafetyKit::Internal::Type::BaseModel
|
|
1957
2292
|
# @!attribute type
|
|
1958
2293
|
# URL image source.
|
|
1959
2294
|
#
|
|
1960
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2295
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::CreateAccount::Content::EventImageContent::Source::Type]
|
|
1961
2296
|
required :type,
|
|
1962
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
2297
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember5::CreateAccount::Content::EventImageContent::Source::Type }
|
|
1963
2298
|
|
|
1964
2299
|
# @!attribute url
|
|
1965
2300
|
# URL of the image SafetyKit should compare or analyze.
|
|
@@ -1970,13 +2305,13 @@ module SafetyKit
|
|
|
1970
2305
|
# @!method initialize(type:, url:)
|
|
1971
2306
|
# Image source information.
|
|
1972
2307
|
#
|
|
1973
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2308
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::CreateAccount::Content::EventImageContent::Source::Type] URL image source.
|
|
1974
2309
|
#
|
|
1975
2310
|
# @param url [String] URL of the image SafetyKit should compare or analyze.
|
|
1976
2311
|
|
|
1977
2312
|
# URL image source.
|
|
1978
2313
|
#
|
|
1979
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2314
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::CreateAccount::Content::EventImageContent::Source#type
|
|
1980
2315
|
module Type
|
|
1981
2316
|
extend SafetyKit::Internal::Type::Enum
|
|
1982
2317
|
|
|
@@ -1989,7 +2324,7 @@ module SafetyKit
|
|
|
1989
2324
|
|
|
1990
2325
|
# Image content part.
|
|
1991
2326
|
#
|
|
1992
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2327
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::CreateAccount::Content::EventImageContent#type
|
|
1993
2328
|
module Type
|
|
1994
2329
|
extend SafetyKit::Internal::Type::Enum
|
|
1995
2330
|
|
|
@@ -2001,7 +2336,7 @@ module SafetyKit
|
|
|
2001
2336
|
end
|
|
2002
2337
|
|
|
2003
2338
|
# @!method self.variants
|
|
2004
|
-
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2339
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::CreateAccount::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::CreateAccount::Content::EventImageContent)]
|
|
2005
2340
|
end
|
|
2006
2341
|
|
|
2007
2342
|
module Metadata
|
|
@@ -2013,7 +2348,7 @@ module SafetyKit
|
|
|
2013
2348
|
|
|
2014
2349
|
variant SafetyKit::Internal::Type::Boolean
|
|
2015
2350
|
|
|
2016
|
-
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2351
|
+
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::CreateAccount::Metadata::UnionMember3Array }
|
|
2017
2352
|
|
|
2018
2353
|
module UnionMember3
|
|
2019
2354
|
extend SafetyKit::Internal::Type::Union
|
|
@@ -2034,7 +2369,7 @@ module SafetyKit
|
|
|
2034
2369
|
# @type [SafetyKit::Internal::Type::Converter]
|
|
2035
2370
|
UnionMember3Array =
|
|
2036
2371
|
SafetyKit::Internal::Type::ArrayOf[
|
|
2037
|
-
union: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
2372
|
+
union: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember5::CreateAccount::Metadata::UnionMember3 }
|
|
2038
2373
|
]
|
|
2039
2374
|
end
|
|
2040
2375
|
|
|
@@ -2055,7 +2390,7 @@ module SafetyKit
|
|
|
2055
2390
|
|
|
2056
2391
|
# @!method initialize(type:, value:)
|
|
2057
2392
|
# Some parameter documentations has been truncated, see
|
|
2058
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2393
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::CreateAccount::ResourcesUsed}
|
|
2059
2394
|
# for more details.
|
|
2060
2395
|
#
|
|
2061
2396
|
# Real-world or account resource used during the event, such as an email, phone
|
|
@@ -2097,9 +2432,9 @@ module SafetyKit
|
|
|
2097
2432
|
# listing text, image URLs, and similar content SafetyKit should compare or
|
|
2098
2433
|
# analyze.
|
|
2099
2434
|
#
|
|
2100
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2435
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UpdateAccount::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UpdateAccount::Content::EventImageContent>, nil]
|
|
2101
2436
|
optional :content,
|
|
2102
|
-
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
2437
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember5::UpdateAccount::Content] }
|
|
2103
2438
|
|
|
2104
2439
|
# @!attribute content_id
|
|
2105
2440
|
# Your stable identifier for the content involved in this event, such as a
|
|
@@ -2114,20 +2449,20 @@ module SafetyKit
|
|
|
2114
2449
|
#
|
|
2115
2450
|
# @return [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}, nil]
|
|
2116
2451
|
optional :metadata,
|
|
2117
|
-
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
2452
|
+
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember5::UpdateAccount::Metadata] }
|
|
2118
2453
|
|
|
2119
2454
|
# @!attribute resources_used
|
|
2120
2455
|
# Reusable resources observed during the event. Use this for emails, phone
|
|
2121
2456
|
# numbers, names, addresses, social handles, URLs, payment identifiers, or similar
|
|
2122
2457
|
# identifiers.
|
|
2123
2458
|
#
|
|
2124
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2459
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UpdateAccount::ResourcesUsed>, nil]
|
|
2125
2460
|
optional :resources_used,
|
|
2126
|
-
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::
|
|
2461
|
+
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::UnionMember5::UpdateAccount::ResourcesUsed] }
|
|
2127
2462
|
|
|
2128
2463
|
# @!method initialize(event_name:, timestamp:, user_id:, content: nil, content_id: nil, metadata: nil, resources_used: nil, type: :update_account)
|
|
2129
2464
|
# Some parameter documentations has been truncated, see
|
|
2130
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2465
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UpdateAccount}
|
|
2131
2466
|
# for more details.
|
|
2132
2467
|
#
|
|
2133
2468
|
# A user or account profile, contact detail, payment detail, or public bio
|
|
@@ -2139,13 +2474,13 @@ module SafetyKit
|
|
|
2139
2474
|
#
|
|
2140
2475
|
# @param user_id [String] Your stable canonical identifier for the user or account.
|
|
2141
2476
|
#
|
|
2142
|
-
# @param content [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2477
|
+
# @param content [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UpdateAccount::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UpdateAccount::Content::EventImageContent>] User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
2143
2478
|
#
|
|
2144
2479
|
# @param content_id [String] Your stable identifier for the content involved in this event, such as a message
|
|
2145
2480
|
#
|
|
2146
2481
|
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
2147
2482
|
#
|
|
2148
|
-
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2483
|
+
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UpdateAccount::ResourcesUsed>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
2149
2484
|
#
|
|
2150
2485
|
# @param type [Symbol, :update_account]
|
|
2151
2486
|
|
|
@@ -2154,10 +2489,10 @@ module SafetyKit
|
|
|
2154
2489
|
extend SafetyKit::Internal::Type::Union
|
|
2155
2490
|
|
|
2156
2491
|
# User-authored text content associated with an event.
|
|
2157
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
2492
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember5::UpdateAccount::Content::EventTextContent }
|
|
2158
2493
|
|
|
2159
2494
|
# User-uploaded image content associated with an event.
|
|
2160
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
2495
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember5::UpdateAccount::Content::EventImageContent }
|
|
2161
2496
|
|
|
2162
2497
|
class EventTextContent < SafetyKit::Internal::Type::BaseModel
|
|
2163
2498
|
# @!attribute text
|
|
@@ -2169,9 +2504,9 @@ module SafetyKit
|
|
|
2169
2504
|
# @!attribute type
|
|
2170
2505
|
# Text content part.
|
|
2171
2506
|
#
|
|
2172
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2507
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UpdateAccount::Content::EventTextContent::Type]
|
|
2173
2508
|
required :type,
|
|
2174
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
2509
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember5::UpdateAccount::Content::EventTextContent::Type }
|
|
2175
2510
|
|
|
2176
2511
|
# @!attribute key
|
|
2177
2512
|
# Stable field key for this content part.
|
|
@@ -2184,13 +2519,13 @@ module SafetyKit
|
|
|
2184
2519
|
#
|
|
2185
2520
|
# @param text [String] User-authored text SafetyKit should compare or analyze.
|
|
2186
2521
|
#
|
|
2187
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2522
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UpdateAccount::Content::EventTextContent::Type] Text content part.
|
|
2188
2523
|
#
|
|
2189
2524
|
# @param key [String] Stable field key for this content part.
|
|
2190
2525
|
|
|
2191
2526
|
# Text content part.
|
|
2192
2527
|
#
|
|
2193
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2528
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UpdateAccount::Content::EventTextContent#type
|
|
2194
2529
|
module Type
|
|
2195
2530
|
extend SafetyKit::Internal::Type::Enum
|
|
2196
2531
|
|
|
@@ -2205,16 +2540,16 @@ module SafetyKit
|
|
|
2205
2540
|
# @!attribute source
|
|
2206
2541
|
# Image source information.
|
|
2207
2542
|
#
|
|
2208
|
-
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2543
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UpdateAccount::Content::EventImageContent::Source]
|
|
2209
2544
|
required :source,
|
|
2210
|
-
-> { SafetyKit::Beta::EventCreateParams::Body::
|
|
2545
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::UnionMember5::UpdateAccount::Content::EventImageContent::Source }
|
|
2211
2546
|
|
|
2212
2547
|
# @!attribute type
|
|
2213
2548
|
# Image content part.
|
|
2214
2549
|
#
|
|
2215
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2550
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UpdateAccount::Content::EventImageContent::Type]
|
|
2216
2551
|
required :type,
|
|
2217
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
2552
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember5::UpdateAccount::Content::EventImageContent::Type }
|
|
2218
2553
|
|
|
2219
2554
|
# @!attribute key
|
|
2220
2555
|
# Stable field key for this content part.
|
|
@@ -2225,20 +2560,20 @@ module SafetyKit
|
|
|
2225
2560
|
# @!method initialize(source:, type:, key: nil)
|
|
2226
2561
|
# User-uploaded image content associated with an event.
|
|
2227
2562
|
#
|
|
2228
|
-
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2563
|
+
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UpdateAccount::Content::EventImageContent::Source] Image source information.
|
|
2229
2564
|
#
|
|
2230
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2565
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UpdateAccount::Content::EventImageContent::Type] Image content part.
|
|
2231
2566
|
#
|
|
2232
2567
|
# @param key [String] Stable field key for this content part.
|
|
2233
2568
|
|
|
2234
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2569
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UpdateAccount::Content::EventImageContent#source
|
|
2235
2570
|
class Source < SafetyKit::Internal::Type::BaseModel
|
|
2236
2571
|
# @!attribute type
|
|
2237
2572
|
# URL image source.
|
|
2238
2573
|
#
|
|
2239
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2574
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UpdateAccount::Content::EventImageContent::Source::Type]
|
|
2240
2575
|
required :type,
|
|
2241
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
2576
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember5::UpdateAccount::Content::EventImageContent::Source::Type }
|
|
2242
2577
|
|
|
2243
2578
|
# @!attribute url
|
|
2244
2579
|
# URL of the image SafetyKit should compare or analyze.
|
|
@@ -2249,13 +2584,13 @@ module SafetyKit
|
|
|
2249
2584
|
# @!method initialize(type:, url:)
|
|
2250
2585
|
# Image source information.
|
|
2251
2586
|
#
|
|
2252
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2587
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UpdateAccount::Content::EventImageContent::Source::Type] URL image source.
|
|
2253
2588
|
#
|
|
2254
2589
|
# @param url [String] URL of the image SafetyKit should compare or analyze.
|
|
2255
2590
|
|
|
2256
2591
|
# URL image source.
|
|
2257
2592
|
#
|
|
2258
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2593
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UpdateAccount::Content::EventImageContent::Source#type
|
|
2259
2594
|
module Type
|
|
2260
2595
|
extend SafetyKit::Internal::Type::Enum
|
|
2261
2596
|
|
|
@@ -2268,7 +2603,7 @@ module SafetyKit
|
|
|
2268
2603
|
|
|
2269
2604
|
# Image content part.
|
|
2270
2605
|
#
|
|
2271
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2606
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UpdateAccount::Content::EventImageContent#type
|
|
2272
2607
|
module Type
|
|
2273
2608
|
extend SafetyKit::Internal::Type::Enum
|
|
2274
2609
|
|
|
@@ -2280,7 +2615,7 @@ module SafetyKit
|
|
|
2280
2615
|
end
|
|
2281
2616
|
|
|
2282
2617
|
# @!method self.variants
|
|
2283
|
-
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2618
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UpdateAccount::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UpdateAccount::Content::EventImageContent)]
|
|
2284
2619
|
end
|
|
2285
2620
|
|
|
2286
2621
|
module Metadata
|
|
@@ -2292,7 +2627,7 @@ module SafetyKit
|
|
|
2292
2627
|
|
|
2293
2628
|
variant SafetyKit::Internal::Type::Boolean
|
|
2294
2629
|
|
|
2295
|
-
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2630
|
+
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UpdateAccount::Metadata::UnionMember3Array }
|
|
2296
2631
|
|
|
2297
2632
|
module UnionMember3
|
|
2298
2633
|
extend SafetyKit::Internal::Type::Union
|
|
@@ -2313,7 +2648,7 @@ module SafetyKit
|
|
|
2313
2648
|
# @type [SafetyKit::Internal::Type::Converter]
|
|
2314
2649
|
UnionMember3Array =
|
|
2315
2650
|
SafetyKit::Internal::Type::ArrayOf[
|
|
2316
|
-
union: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
2651
|
+
union: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember5::UpdateAccount::Metadata::UnionMember3 }
|
|
2317
2652
|
]
|
|
2318
2653
|
end
|
|
2319
2654
|
|
|
@@ -2334,7 +2669,326 @@ module SafetyKit
|
|
|
2334
2669
|
|
|
2335
2670
|
# @!method initialize(type:, value:)
|
|
2336
2671
|
# Some parameter documentations has been truncated, see
|
|
2337
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2672
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UpdateAccount::ResourcesUsed}
|
|
2673
|
+
# for more details.
|
|
2674
|
+
#
|
|
2675
|
+
# Real-world or account resource used during the event, such as an email, phone
|
|
2676
|
+
# number, address, URL, social handle, or payment identifier.
|
|
2677
|
+
#
|
|
2678
|
+
# @param type [String] Resource family, such as email, phone, name, address, url, instagram, tiktok, yo
|
|
2679
|
+
#
|
|
2680
|
+
# @param value [String] Resource value used during the event. SafetyKit stores a normalized hash of this
|
|
2681
|
+
end
|
|
2682
|
+
end
|
|
2683
|
+
|
|
2684
|
+
class UserReport < SafetyKit::Internal::Type::BaseModel
|
|
2685
|
+
# @!attribute event_name
|
|
2686
|
+
# Stable, low-cardinality product action name. Use snake_case and put dynamic
|
|
2687
|
+
# values in typed fields, content, resources_used, or metadata.
|
|
2688
|
+
#
|
|
2689
|
+
# @return [String]
|
|
2690
|
+
required :event_name, String
|
|
2691
|
+
|
|
2692
|
+
# @!attribute labels
|
|
2693
|
+
# One or more label categories supplied with the report.
|
|
2694
|
+
#
|
|
2695
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UserReport::Label>]
|
|
2696
|
+
required :labels,
|
|
2697
|
+
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::UnionMember5::UserReport::Label] }
|
|
2698
|
+
|
|
2699
|
+
# @!attribute timestamp
|
|
2700
|
+
# The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
2701
|
+
#
|
|
2702
|
+
# @return [Time]
|
|
2703
|
+
required :timestamp, Time
|
|
2704
|
+
|
|
2705
|
+
# @!attribute type
|
|
2706
|
+
#
|
|
2707
|
+
# @return [Symbol, :user_report]
|
|
2708
|
+
required :type, const: :user_report
|
|
2709
|
+
|
|
2710
|
+
# @!attribute user_id
|
|
2711
|
+
# Your stable canonical identifier for the user or account.
|
|
2712
|
+
#
|
|
2713
|
+
# @return [String]
|
|
2714
|
+
required :user_id, String
|
|
2715
|
+
|
|
2716
|
+
# @!attribute content
|
|
2717
|
+
# User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
2718
|
+
# listing text, image URLs, and similar content SafetyKit should compare or
|
|
2719
|
+
# analyze.
|
|
2720
|
+
#
|
|
2721
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UserReport::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UserReport::Content::EventImageContent>, nil]
|
|
2722
|
+
optional :content,
|
|
2723
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember5::UserReport::Content] }
|
|
2724
|
+
|
|
2725
|
+
# @!attribute content_id
|
|
2726
|
+
# Your stable identifier for the content involved in this event, such as a
|
|
2727
|
+
# message, listing, page, post, profile, or uploaded media item.
|
|
2728
|
+
#
|
|
2729
|
+
# @return [String, nil]
|
|
2730
|
+
optional :content_id, String
|
|
2731
|
+
|
|
2732
|
+
# @!attribute metadata
|
|
2733
|
+
# Non-PII product context for filtering, segmentation, and debugging. Values may
|
|
2734
|
+
# be strings, numbers, booleans, or arrays of those scalar values.
|
|
2735
|
+
#
|
|
2736
|
+
# @return [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}, nil]
|
|
2737
|
+
optional :metadata,
|
|
2738
|
+
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember5::UserReport::Metadata] }
|
|
2739
|
+
|
|
2740
|
+
# @!attribute resources_used
|
|
2741
|
+
# Reusable resources observed during the event. Use this for emails, phone
|
|
2742
|
+
# numbers, names, addresses, social handles, URLs, payment identifiers, or similar
|
|
2743
|
+
# identifiers.
|
|
2744
|
+
#
|
|
2745
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UserReport::ResourcesUsed>, nil]
|
|
2746
|
+
optional :resources_used,
|
|
2747
|
+
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::UnionMember5::UserReport::ResourcesUsed] }
|
|
2748
|
+
|
|
2749
|
+
# @!attribute target_content_id
|
|
2750
|
+
# Your stable identifier for the user-owned content that is the target of a
|
|
2751
|
+
# report.
|
|
2752
|
+
#
|
|
2753
|
+
# @return [String, nil]
|
|
2754
|
+
optional :target_content_id, String
|
|
2755
|
+
|
|
2756
|
+
# @!attribute target_user_id
|
|
2757
|
+
# Your stable canonical identifier for the user being reported.
|
|
2758
|
+
#
|
|
2759
|
+
# @return [String, nil]
|
|
2760
|
+
optional :target_user_id, String
|
|
2761
|
+
|
|
2762
|
+
# @!method initialize(event_name:, labels:, timestamp:, user_id:, content: nil, content_id: nil, metadata: nil, resources_used: nil, target_content_id: nil, target_user_id: nil, type: :user_report)
|
|
2763
|
+
# Some parameter documentations has been truncated, see
|
|
2764
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UserReport} for
|
|
2765
|
+
# more details.
|
|
2766
|
+
#
|
|
2767
|
+
# A user-submitted report. Use user_id for the reporter, content and content_id
|
|
2768
|
+
# for the report itself, and target_user_id or target_content_id for what was
|
|
2769
|
+
# reported.
|
|
2770
|
+
#
|
|
2771
|
+
# @param event_name [String] Stable, low-cardinality product action name. Use snake_case and put dynamic valu
|
|
2772
|
+
#
|
|
2773
|
+
# @param labels [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UserReport::Label>] One or more label categories supplied with the report.
|
|
2774
|
+
#
|
|
2775
|
+
# @param timestamp [Time] The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
2776
|
+
#
|
|
2777
|
+
# @param user_id [String] Your stable canonical identifier for the user or account.
|
|
2778
|
+
#
|
|
2779
|
+
# @param content [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UserReport::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UserReport::Content::EventImageContent>] User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
2780
|
+
#
|
|
2781
|
+
# @param content_id [String] Your stable identifier for the content involved in this event, such as a message
|
|
2782
|
+
#
|
|
2783
|
+
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
2784
|
+
#
|
|
2785
|
+
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UserReport::ResourcesUsed>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
2786
|
+
#
|
|
2787
|
+
# @param target_content_id [String] Your stable identifier for the user-owned content that is the target of a report
|
|
2788
|
+
#
|
|
2789
|
+
# @param target_user_id [String] Your stable canonical identifier for the user being reported.
|
|
2790
|
+
#
|
|
2791
|
+
# @param type [Symbol, :user_report]
|
|
2792
|
+
|
|
2793
|
+
class Label < SafetyKit::Internal::Type::BaseModel
|
|
2794
|
+
# @!attribute label
|
|
2795
|
+
# Stable snake_case report label category.
|
|
2796
|
+
#
|
|
2797
|
+
# @return [String]
|
|
2798
|
+
required :label, String
|
|
2799
|
+
|
|
2800
|
+
# @!method initialize(label:)
|
|
2801
|
+
# Label category supplied with a user report.
|
|
2802
|
+
#
|
|
2803
|
+
# @param label [String] Stable snake_case report label category.
|
|
2804
|
+
end
|
|
2805
|
+
|
|
2806
|
+
# User-authored text content associated with an event.
|
|
2807
|
+
module Content
|
|
2808
|
+
extend SafetyKit::Internal::Type::Union
|
|
2809
|
+
|
|
2810
|
+
# User-authored text content associated with an event.
|
|
2811
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember5::UserReport::Content::EventTextContent }
|
|
2812
|
+
|
|
2813
|
+
# User-uploaded image content associated with an event.
|
|
2814
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember5::UserReport::Content::EventImageContent }
|
|
2815
|
+
|
|
2816
|
+
class EventTextContent < SafetyKit::Internal::Type::BaseModel
|
|
2817
|
+
# @!attribute text
|
|
2818
|
+
# User-authored text SafetyKit should compare or analyze.
|
|
2819
|
+
#
|
|
2820
|
+
# @return [String]
|
|
2821
|
+
required :text, String
|
|
2822
|
+
|
|
2823
|
+
# @!attribute type
|
|
2824
|
+
# Text content part.
|
|
2825
|
+
#
|
|
2826
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UserReport::Content::EventTextContent::Type]
|
|
2827
|
+
required :type,
|
|
2828
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember5::UserReport::Content::EventTextContent::Type }
|
|
2829
|
+
|
|
2830
|
+
# @!attribute key
|
|
2831
|
+
# Stable field key for this content part.
|
|
2832
|
+
#
|
|
2833
|
+
# @return [String, nil]
|
|
2834
|
+
optional :key, String
|
|
2835
|
+
|
|
2836
|
+
# @!method initialize(text:, type:, key: nil)
|
|
2837
|
+
# User-authored text content associated with an event.
|
|
2838
|
+
#
|
|
2839
|
+
# @param text [String] User-authored text SafetyKit should compare or analyze.
|
|
2840
|
+
#
|
|
2841
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UserReport::Content::EventTextContent::Type] Text content part.
|
|
2842
|
+
#
|
|
2843
|
+
# @param key [String] Stable field key for this content part.
|
|
2844
|
+
|
|
2845
|
+
# Text content part.
|
|
2846
|
+
#
|
|
2847
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UserReport::Content::EventTextContent#type
|
|
2848
|
+
module Type
|
|
2849
|
+
extend SafetyKit::Internal::Type::Enum
|
|
2850
|
+
|
|
2851
|
+
TEXT = :text
|
|
2852
|
+
|
|
2853
|
+
# @!method self.values
|
|
2854
|
+
# @return [Array<Symbol>]
|
|
2855
|
+
end
|
|
2856
|
+
end
|
|
2857
|
+
|
|
2858
|
+
class EventImageContent < SafetyKit::Internal::Type::BaseModel
|
|
2859
|
+
# @!attribute source
|
|
2860
|
+
# Image source information.
|
|
2861
|
+
#
|
|
2862
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UserReport::Content::EventImageContent::Source]
|
|
2863
|
+
required :source,
|
|
2864
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::UnionMember5::UserReport::Content::EventImageContent::Source }
|
|
2865
|
+
|
|
2866
|
+
# @!attribute type
|
|
2867
|
+
# Image content part.
|
|
2868
|
+
#
|
|
2869
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UserReport::Content::EventImageContent::Type]
|
|
2870
|
+
required :type,
|
|
2871
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember5::UserReport::Content::EventImageContent::Type }
|
|
2872
|
+
|
|
2873
|
+
# @!attribute key
|
|
2874
|
+
# Stable field key for this content part.
|
|
2875
|
+
#
|
|
2876
|
+
# @return [String, nil]
|
|
2877
|
+
optional :key, String
|
|
2878
|
+
|
|
2879
|
+
# @!method initialize(source:, type:, key: nil)
|
|
2880
|
+
# User-uploaded image content associated with an event.
|
|
2881
|
+
#
|
|
2882
|
+
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UserReport::Content::EventImageContent::Source] Image source information.
|
|
2883
|
+
#
|
|
2884
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UserReport::Content::EventImageContent::Type] Image content part.
|
|
2885
|
+
#
|
|
2886
|
+
# @param key [String] Stable field key for this content part.
|
|
2887
|
+
|
|
2888
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UserReport::Content::EventImageContent#source
|
|
2889
|
+
class Source < SafetyKit::Internal::Type::BaseModel
|
|
2890
|
+
# @!attribute type
|
|
2891
|
+
# URL image source.
|
|
2892
|
+
#
|
|
2893
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UserReport::Content::EventImageContent::Source::Type]
|
|
2894
|
+
required :type,
|
|
2895
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember5::UserReport::Content::EventImageContent::Source::Type }
|
|
2896
|
+
|
|
2897
|
+
# @!attribute url
|
|
2898
|
+
# URL of the image SafetyKit should compare or analyze.
|
|
2899
|
+
#
|
|
2900
|
+
# @return [String]
|
|
2901
|
+
required :url, String
|
|
2902
|
+
|
|
2903
|
+
# @!method initialize(type:, url:)
|
|
2904
|
+
# Image source information.
|
|
2905
|
+
#
|
|
2906
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UserReport::Content::EventImageContent::Source::Type] URL image source.
|
|
2907
|
+
#
|
|
2908
|
+
# @param url [String] URL of the image SafetyKit should compare or analyze.
|
|
2909
|
+
|
|
2910
|
+
# URL image source.
|
|
2911
|
+
#
|
|
2912
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UserReport::Content::EventImageContent::Source#type
|
|
2913
|
+
module Type
|
|
2914
|
+
extend SafetyKit::Internal::Type::Enum
|
|
2915
|
+
|
|
2916
|
+
URL = :url
|
|
2917
|
+
|
|
2918
|
+
# @!method self.values
|
|
2919
|
+
# @return [Array<Symbol>]
|
|
2920
|
+
end
|
|
2921
|
+
end
|
|
2922
|
+
|
|
2923
|
+
# Image content part.
|
|
2924
|
+
#
|
|
2925
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UserReport::Content::EventImageContent#type
|
|
2926
|
+
module Type
|
|
2927
|
+
extend SafetyKit::Internal::Type::Enum
|
|
2928
|
+
|
|
2929
|
+
IMAGE = :image
|
|
2930
|
+
|
|
2931
|
+
# @!method self.values
|
|
2932
|
+
# @return [Array<Symbol>]
|
|
2933
|
+
end
|
|
2934
|
+
end
|
|
2935
|
+
|
|
2936
|
+
# @!method self.variants
|
|
2937
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UserReport::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UserReport::Content::EventImageContent)]
|
|
2938
|
+
end
|
|
2939
|
+
|
|
2940
|
+
module Metadata
|
|
2941
|
+
extend SafetyKit::Internal::Type::Union
|
|
2942
|
+
|
|
2943
|
+
variant String
|
|
2944
|
+
|
|
2945
|
+
variant Float
|
|
2946
|
+
|
|
2947
|
+
variant SafetyKit::Internal::Type::Boolean
|
|
2948
|
+
|
|
2949
|
+
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UserReport::Metadata::UnionMember3Array }
|
|
2950
|
+
|
|
2951
|
+
module UnionMember3
|
|
2952
|
+
extend SafetyKit::Internal::Type::Union
|
|
2953
|
+
|
|
2954
|
+
variant String
|
|
2955
|
+
|
|
2956
|
+
variant Float
|
|
2957
|
+
|
|
2958
|
+
variant SafetyKit::Internal::Type::Boolean
|
|
2959
|
+
|
|
2960
|
+
# @!method self.variants
|
|
2961
|
+
# @return [Array(String, Float, Boolean)]
|
|
2962
|
+
end
|
|
2963
|
+
|
|
2964
|
+
# @!method self.variants
|
|
2965
|
+
# @return [Array(String, Float, Boolean, Array<String, Float, Boolean>)]
|
|
2966
|
+
|
|
2967
|
+
# @type [SafetyKit::Internal::Type::Converter]
|
|
2968
|
+
UnionMember3Array =
|
|
2969
|
+
SafetyKit::Internal::Type::ArrayOf[union: -> {
|
|
2970
|
+
SafetyKit::Beta::EventCreateParams::Body::UnionMember5::UserReport::Metadata::UnionMember3
|
|
2971
|
+
}]
|
|
2972
|
+
end
|
|
2973
|
+
|
|
2974
|
+
class ResourcesUsed < SafetyKit::Internal::Type::BaseModel
|
|
2975
|
+
# @!attribute type
|
|
2976
|
+
# Resource family, such as email, phone, name, address, url, instagram, tiktok,
|
|
2977
|
+
# youtube, linkedin, or another stable snake_case identifier.
|
|
2978
|
+
#
|
|
2979
|
+
# @return [String]
|
|
2980
|
+
required :type, String
|
|
2981
|
+
|
|
2982
|
+
# @!attribute value
|
|
2983
|
+
# Resource value used during the event. SafetyKit stores a normalized hash of this
|
|
2984
|
+
# value, not the raw value. When type is url, this must be a valid URL.
|
|
2985
|
+
#
|
|
2986
|
+
# @return [String]
|
|
2987
|
+
required :value, String
|
|
2988
|
+
|
|
2989
|
+
# @!method initialize(type:, value:)
|
|
2990
|
+
# Some parameter documentations has been truncated, see
|
|
2991
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UserReport::ResourcesUsed}
|
|
2338
2992
|
# for more details.
|
|
2339
2993
|
#
|
|
2340
2994
|
# Real-world or account resource used during the event, such as an email, phone
|
|
@@ -2347,16 +3001,16 @@ module SafetyKit
|
|
|
2347
3001
|
end
|
|
2348
3002
|
|
|
2349
3003
|
# @!method self.variants
|
|
2350
|
-
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3004
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UserContact, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::ContentUploaded, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::CreateAccount, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UpdateAccount, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UserReport)]
|
|
2351
3005
|
end
|
|
2352
3006
|
|
|
2353
3007
|
# @!method self.variants
|
|
2354
|
-
# @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::
|
|
3008
|
+
# @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, SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest, Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UserContact, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::ContentUploaded, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::CreateAccount, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UpdateAccount, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UserReport>)]
|
|
2355
3009
|
|
|
2356
3010
|
# @type [SafetyKit::Internal::Type::Converter]
|
|
2357
|
-
|
|
3011
|
+
UnionMember5Array =
|
|
2358
3012
|
SafetyKit::Internal::Type::ArrayOf[union: -> {
|
|
2359
|
-
SafetyKit::Beta::EventCreateParams::Body::
|
|
3013
|
+
SafetyKit::Beta::EventCreateParams::Body::UnionMember5
|
|
2360
3014
|
}]
|
|
2361
3015
|
end
|
|
2362
3016
|
end
|