safetykit 0.14.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 +16 -0
- data/README.md +1 -1
- data/lib/safety_kit/models/beta/event_create_params.rb +962 -236
- 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 +1828 -369
- data/rbi/safety_kit/resources/beta/events.rbi +6 -4
- data/sig/safety_kit/models/beta/event_create_params.rbs +745 -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
|
|
@@ -85,6 +88,13 @@ module SafetyKit
|
|
|
85
88
|
optional :content,
|
|
86
89
|
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::UserContactEventRequest::Content] }
|
|
87
90
|
|
|
91
|
+
# @!attribute content_id
|
|
92
|
+
# Your stable identifier for the content involved in this event, such as a
|
|
93
|
+
# message, listing, page, post, profile, or uploaded media item.
|
|
94
|
+
#
|
|
95
|
+
# @return [String, nil]
|
|
96
|
+
optional :content_id, String
|
|
97
|
+
|
|
88
98
|
# @!attribute metadata
|
|
89
99
|
# Non-PII product context for filtering, segmentation, and debugging. Values may
|
|
90
100
|
# be strings, numbers, booleans, or arrays of those scalar values.
|
|
@@ -102,7 +112,7 @@ module SafetyKit
|
|
|
102
112
|
optional :resources_used,
|
|
103
113
|
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::UserContactEventRequest::ResourcesUsed] }
|
|
104
114
|
|
|
105
|
-
# @!method initialize(event_name:, target_user_id:, timestamp:, type:, user_id:, content: nil, metadata: nil, resources_used: nil)
|
|
115
|
+
# @!method initialize(event_name:, target_user_id:, timestamp:, type:, user_id:, content: nil, content_id: nil, metadata: nil, resources_used: nil)
|
|
106
116
|
# Some parameter documentations has been truncated, see
|
|
107
117
|
# {SafetyKit::Models::Beta::EventCreateParams::Body::UserContactEventRequest} for
|
|
108
118
|
# more details.
|
|
@@ -121,6 +131,8 @@ module SafetyKit
|
|
|
121
131
|
#
|
|
122
132
|
# @param content [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UserContactEventRequest::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UserContactEventRequest::Content::EventImageContent>] User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
123
133
|
#
|
|
134
|
+
# @param content_id [String] Your stable identifier for the content involved in this event, such as a message
|
|
135
|
+
#
|
|
124
136
|
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
125
137
|
#
|
|
126
138
|
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UserContactEventRequest::ResourcesUsed>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
@@ -366,6 +378,13 @@ module SafetyKit
|
|
|
366
378
|
# @return [String]
|
|
367
379
|
required :user_id, String
|
|
368
380
|
|
|
381
|
+
# @!attribute content_id
|
|
382
|
+
# Your stable identifier for the content involved in this event, such as a
|
|
383
|
+
# message, listing, page, post, profile, or uploaded media item.
|
|
384
|
+
#
|
|
385
|
+
# @return [String, nil]
|
|
386
|
+
optional :content_id, String
|
|
387
|
+
|
|
369
388
|
# @!attribute metadata
|
|
370
389
|
# Non-PII product context for filtering, segmentation, and debugging. Values may
|
|
371
390
|
# be strings, numbers, booleans, or arrays of those scalar values.
|
|
@@ -383,7 +402,7 @@ module SafetyKit
|
|
|
383
402
|
optional :resources_used,
|
|
384
403
|
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::ContentUploadedEventRequest::ResourcesUsed] }
|
|
385
404
|
|
|
386
|
-
# @!method initialize(content:, event_name:, timestamp:, type:, user_id:, metadata: nil, resources_used: nil)
|
|
405
|
+
# @!method initialize(content:, event_name:, timestamp:, type:, user_id:, content_id: nil, metadata: nil, resources_used: nil)
|
|
387
406
|
# Some parameter documentations has been truncated, see
|
|
388
407
|
# {SafetyKit::Models::Beta::EventCreateParams::Body::ContentUploadedEventRequest}
|
|
389
408
|
# for more details.
|
|
@@ -400,6 +419,8 @@ module SafetyKit
|
|
|
400
419
|
#
|
|
401
420
|
# @param user_id [String] Your stable canonical identifier for the user or account.
|
|
402
421
|
#
|
|
422
|
+
# @param content_id [String] Your stable identifier for the content involved in this event, such as a message
|
|
423
|
+
#
|
|
403
424
|
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
404
425
|
#
|
|
405
426
|
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::ContentUploadedEventRequest::ResourcesUsed>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
@@ -645,6 +666,13 @@ module SafetyKit
|
|
|
645
666
|
optional :content,
|
|
646
667
|
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content] }
|
|
647
668
|
|
|
669
|
+
# @!attribute content_id
|
|
670
|
+
# Your stable identifier for the content involved in this event, such as a
|
|
671
|
+
# message, listing, page, post, profile, or uploaded media item.
|
|
672
|
+
#
|
|
673
|
+
# @return [String, nil]
|
|
674
|
+
optional :content_id, String
|
|
675
|
+
|
|
648
676
|
# @!attribute metadata
|
|
649
677
|
# Non-PII product context for filtering, segmentation, and debugging. Values may
|
|
650
678
|
# be strings, numbers, booleans, or arrays of those scalar values.
|
|
@@ -662,7 +690,7 @@ module SafetyKit
|
|
|
662
690
|
optional :resources_used,
|
|
663
691
|
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::CreateAccountEventRequest::ResourcesUsed] }
|
|
664
692
|
|
|
665
|
-
# @!method initialize(event_name:, timestamp:, type:, user_id:, content: nil, metadata: nil, resources_used: nil)
|
|
693
|
+
# @!method initialize(event_name:, timestamp:, type:, user_id:, content: nil, content_id: nil, metadata: nil, resources_used: nil)
|
|
666
694
|
# Some parameter documentations has been truncated, see
|
|
667
695
|
# {SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest}
|
|
668
696
|
# for more details.
|
|
@@ -679,6 +707,8 @@ module SafetyKit
|
|
|
679
707
|
#
|
|
680
708
|
# @param content [Array<SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventImageContent>] User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
681
709
|
#
|
|
710
|
+
# @param content_id [String] Your stable identifier for the content involved in this event, such as a message
|
|
711
|
+
#
|
|
682
712
|
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
683
713
|
#
|
|
684
714
|
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::ResourcesUsed>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
@@ -924,6 +954,13 @@ module SafetyKit
|
|
|
924
954
|
optional :content,
|
|
925
955
|
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content] }
|
|
926
956
|
|
|
957
|
+
# @!attribute content_id
|
|
958
|
+
# Your stable identifier for the content involved in this event, such as a
|
|
959
|
+
# message, listing, page, post, profile, or uploaded media item.
|
|
960
|
+
#
|
|
961
|
+
# @return [String, nil]
|
|
962
|
+
optional :content_id, String
|
|
963
|
+
|
|
927
964
|
# @!attribute metadata
|
|
928
965
|
# Non-PII product context for filtering, segmentation, and debugging. Values may
|
|
929
966
|
# be strings, numbers, booleans, or arrays of those scalar values.
|
|
@@ -941,7 +978,7 @@ module SafetyKit
|
|
|
941
978
|
optional :resources_used,
|
|
942
979
|
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::UpdateAccountEventRequest::ResourcesUsed] }
|
|
943
980
|
|
|
944
|
-
# @!method initialize(event_name:, timestamp:, type:, user_id:, content: nil, metadata: nil, resources_used: nil)
|
|
981
|
+
# @!method initialize(event_name:, timestamp:, type:, user_id:, content: nil, content_id: nil, metadata: nil, resources_used: nil)
|
|
945
982
|
# Some parameter documentations has been truncated, see
|
|
946
983
|
# {SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest}
|
|
947
984
|
# for more details.
|
|
@@ -959,6 +996,8 @@ module SafetyKit
|
|
|
959
996
|
#
|
|
960
997
|
# @param content [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventImageContent>] User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
961
998
|
#
|
|
999
|
+
# @param content_id [String] Your stable identifier for the content involved in this event, such as a message
|
|
1000
|
+
#
|
|
962
1001
|
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
963
1002
|
#
|
|
964
1003
|
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::ResourcesUsed>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
@@ -1170,171 +1209,512 @@ module SafetyKit
|
|
|
1170
1209
|
end
|
|
1171
1210
|
end
|
|
1172
1211
|
|
|
1173
|
-
|
|
1174
|
-
|
|
1175
|
-
|
|
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
|
|
1176
1219
|
|
|
1177
|
-
|
|
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] }
|
|
1178
1226
|
|
|
1179
|
-
#
|
|
1180
|
-
|
|
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
|
|
1181
1232
|
|
|
1182
|
-
#
|
|
1183
|
-
|
|
1233
|
+
# @!attribute type
|
|
1234
|
+
#
|
|
1235
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Type]
|
|
1236
|
+
required :type, enum: -> { SafetyKit::Beta::EventCreateParams::Body::UserReportEventRequest::Type }
|
|
1184
1237
|
|
|
1185
|
-
#
|
|
1186
|
-
|
|
1238
|
+
# @!attribute user_id
|
|
1239
|
+
# Your stable canonical identifier for the user or account.
|
|
1240
|
+
#
|
|
1241
|
+
# @return [String]
|
|
1242
|
+
required :user_id, String
|
|
1187
1243
|
|
|
1188
|
-
#
|
|
1189
|
-
|
|
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] }
|
|
1190
1252
|
|
|
1191
|
-
|
|
1192
|
-
|
|
1193
|
-
|
|
1194
|
-
|
|
1195
|
-
|
|
1196
|
-
|
|
1197
|
-
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
|
|
1198
1259
|
|
|
1199
|
-
|
|
1200
|
-
|
|
1201
|
-
|
|
1202
|
-
|
|
1203
|
-
|
|
1204
|
-
|
|
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] }
|
|
1205
1267
|
|
|
1206
|
-
|
|
1207
|
-
|
|
1208
|
-
|
|
1209
|
-
|
|
1210
|
-
|
|
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] }
|
|
1211
1276
|
|
|
1212
|
-
|
|
1213
|
-
|
|
1214
|
-
|
|
1215
|
-
|
|
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
|
|
1216
1283
|
|
|
1217
|
-
|
|
1218
|
-
|
|
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.
|
|
1219
1324
|
#
|
|
1220
1325
|
# @return [String]
|
|
1221
|
-
required :
|
|
1326
|
+
required :label, String
|
|
1222
1327
|
|
|
1223
|
-
# @!
|
|
1224
|
-
#
|
|
1225
|
-
# listing text, image URLs, and similar content SafetyKit should compare or
|
|
1226
|
-
# analyze.
|
|
1328
|
+
# @!method initialize(label:)
|
|
1329
|
+
# Label category supplied with a user report.
|
|
1227
1330
|
#
|
|
1228
|
-
# @
|
|
1229
|
-
|
|
1230
|
-
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember4::UserContact::Content] }
|
|
1331
|
+
# @param label [String] Stable snake_case report label category.
|
|
1332
|
+
end
|
|
1231
1333
|
|
|
1232
|
-
|
|
1233
|
-
|
|
1234
|
-
|
|
1235
|
-
#
|
|
1236
|
-
# @return [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}, nil]
|
|
1237
|
-
optional :metadata,
|
|
1238
|
-
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember4::UserContact::Metadata] }
|
|
1334
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest#type
|
|
1335
|
+
module Type
|
|
1336
|
+
extend SafetyKit::Internal::Type::Enum
|
|
1239
1337
|
|
|
1240
|
-
|
|
1241
|
-
# Reusable resources observed during the event. Use this for emails, phone
|
|
1242
|
-
# numbers, names, addresses, social handles, URLs, payment identifiers, or similar
|
|
1243
|
-
# identifiers.
|
|
1244
|
-
#
|
|
1245
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::UserContact::ResourcesUsed>, nil]
|
|
1246
|
-
optional :resources_used,
|
|
1247
|
-
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::UnionMember4::UserContact::ResourcesUsed] }
|
|
1338
|
+
USER_REPORT = :user_report
|
|
1248
1339
|
|
|
1249
|
-
# @!method
|
|
1250
|
-
#
|
|
1251
|
-
|
|
1252
|
-
|
|
1253
|
-
|
|
1254
|
-
|
|
1255
|
-
|
|
1256
|
-
# @param event_name [String] Stable, low-cardinality product action name. Use snake_case and put dynamic valu
|
|
1257
|
-
#
|
|
1258
|
-
# @param target_user_id [String] Your stable canonical identifier for the other user in a user-to-user interactio
|
|
1259
|
-
#
|
|
1260
|
-
# @param timestamp [Time] The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
1261
|
-
#
|
|
1262
|
-
# @param user_id [String] Your stable canonical identifier for the user or account.
|
|
1263
|
-
#
|
|
1264
|
-
# @param content [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::UserContact::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::UserContact::Content::EventImageContent>] User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
1265
|
-
#
|
|
1266
|
-
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
1267
|
-
#
|
|
1268
|
-
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember4::UserContact::ResourcesUsed>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
1269
|
-
#
|
|
1270
|
-
# @param type [Symbol, :user_contact]
|
|
1340
|
+
# @!method self.values
|
|
1341
|
+
# @return [Array<Symbol>]
|
|
1342
|
+
end
|
|
1343
|
+
|
|
1344
|
+
# User-authored text content associated with an event.
|
|
1345
|
+
module Content
|
|
1346
|
+
extend SafetyKit::Internal::Type::Union
|
|
1271
1347
|
|
|
1272
1348
|
# User-authored text content associated with an event.
|
|
1273
|
-
|
|
1274
|
-
extend SafetyKit::Internal::Type::Union
|
|
1349
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventTextContent }
|
|
1275
1350
|
|
|
1276
|
-
|
|
1277
|
-
|
|
1351
|
+
# User-uploaded image content associated with an event.
|
|
1352
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventImageContent }
|
|
1278
1353
|
|
|
1279
|
-
|
|
1280
|
-
|
|
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
|
|
1281
1360
|
|
|
1282
|
-
|
|
1283
|
-
|
|
1284
|
-
|
|
1285
|
-
|
|
1286
|
-
|
|
1287
|
-
|
|
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.
|
|
1288
1425
|
|
|
1426
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventImageContent#source
|
|
1427
|
+
class Source < SafetyKit::Internal::Type::BaseModel
|
|
1289
1428
|
# @!attribute type
|
|
1290
|
-
#
|
|
1429
|
+
# URL image source.
|
|
1291
1430
|
#
|
|
1292
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1431
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventImageContent::Source::Type]
|
|
1293
1432
|
required :type,
|
|
1294
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
1433
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventImageContent::Source::Type }
|
|
1295
1434
|
|
|
1296
|
-
# @!attribute
|
|
1297
|
-
#
|
|
1435
|
+
# @!attribute url
|
|
1436
|
+
# URL of the image SafetyKit should compare or analyze.
|
|
1298
1437
|
#
|
|
1299
|
-
# @return [String
|
|
1300
|
-
|
|
1438
|
+
# @return [String]
|
|
1439
|
+
required :url, String
|
|
1301
1440
|
|
|
1302
|
-
# @!method initialize(
|
|
1303
|
-
#
|
|
1304
|
-
#
|
|
1305
|
-
# @param text [String] User-authored text SafetyKit should compare or analyze.
|
|
1441
|
+
# @!method initialize(type:, url:)
|
|
1442
|
+
# Image source information.
|
|
1306
1443
|
#
|
|
1307
|
-
# @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.
|
|
1308
1445
|
#
|
|
1309
|
-
# @param
|
|
1446
|
+
# @param url [String] URL of the image SafetyKit should compare or analyze.
|
|
1310
1447
|
|
|
1311
|
-
#
|
|
1448
|
+
# URL image source.
|
|
1312
1449
|
#
|
|
1313
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1450
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventImageContent::Source#type
|
|
1314
1451
|
module Type
|
|
1315
1452
|
extend SafetyKit::Internal::Type::Enum
|
|
1316
1453
|
|
|
1317
|
-
|
|
1454
|
+
URL = :url
|
|
1318
1455
|
|
|
1319
1456
|
# @!method self.values
|
|
1320
1457
|
# @return [Array<Symbol>]
|
|
1321
1458
|
end
|
|
1322
1459
|
end
|
|
1323
1460
|
|
|
1324
|
-
|
|
1325
|
-
|
|
1326
|
-
|
|
1327
|
-
|
|
1328
|
-
|
|
1329
|
-
required :source,
|
|
1330
|
-
-> { SafetyKit::Beta::EventCreateParams::Body::UnionMember4::UserContact::Content::EventImageContent::Source }
|
|
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
|
|
1331
1466
|
|
|
1332
|
-
|
|
1333
|
-
|
|
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.
|
|
1334
1707
|
#
|
|
1335
|
-
# @return [
|
|
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
|
|
1713
|
+
# Image content part.
|
|
1714
|
+
#
|
|
1715
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UserContact::Content::EventImageContent::Type]
|
|
1336
1716
|
required :type,
|
|
1337
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
1717
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember5::UserContact::Content::EventImageContent::Type }
|
|
1338
1718
|
|
|
1339
1719
|
# @!attribute key
|
|
1340
1720
|
# Stable field key for this content part.
|
|
@@ -1345,20 +1725,20 @@ module SafetyKit
|
|
|
1345
1725
|
# @!method initialize(source:, type:, key: nil)
|
|
1346
1726
|
# User-uploaded image content associated with an event.
|
|
1347
1727
|
#
|
|
1348
|
-
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1728
|
+
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UserContact::Content::EventImageContent::Source] Image source information.
|
|
1349
1729
|
#
|
|
1350
|
-
# @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.
|
|
1351
1731
|
#
|
|
1352
1732
|
# @param key [String] Stable field key for this content part.
|
|
1353
1733
|
|
|
1354
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1734
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UserContact::Content::EventImageContent#source
|
|
1355
1735
|
class Source < SafetyKit::Internal::Type::BaseModel
|
|
1356
1736
|
# @!attribute type
|
|
1357
1737
|
# URL image source.
|
|
1358
1738
|
#
|
|
1359
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1739
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UserContact::Content::EventImageContent::Source::Type]
|
|
1360
1740
|
required :type,
|
|
1361
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
1741
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember5::UserContact::Content::EventImageContent::Source::Type }
|
|
1362
1742
|
|
|
1363
1743
|
# @!attribute url
|
|
1364
1744
|
# URL of the image SafetyKit should compare or analyze.
|
|
@@ -1369,13 +1749,13 @@ module SafetyKit
|
|
|
1369
1749
|
# @!method initialize(type:, url:)
|
|
1370
1750
|
# Image source information.
|
|
1371
1751
|
#
|
|
1372
|
-
# @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.
|
|
1373
1753
|
#
|
|
1374
1754
|
# @param url [String] URL of the image SafetyKit should compare or analyze.
|
|
1375
1755
|
|
|
1376
1756
|
# URL image source.
|
|
1377
1757
|
#
|
|
1378
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1758
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UserContact::Content::EventImageContent::Source#type
|
|
1379
1759
|
module Type
|
|
1380
1760
|
extend SafetyKit::Internal::Type::Enum
|
|
1381
1761
|
|
|
@@ -1388,7 +1768,7 @@ module SafetyKit
|
|
|
1388
1768
|
|
|
1389
1769
|
# Image content part.
|
|
1390
1770
|
#
|
|
1391
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1771
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UserContact::Content::EventImageContent#type
|
|
1392
1772
|
module Type
|
|
1393
1773
|
extend SafetyKit::Internal::Type::Enum
|
|
1394
1774
|
|
|
@@ -1400,7 +1780,7 @@ module SafetyKit
|
|
|
1400
1780
|
end
|
|
1401
1781
|
|
|
1402
1782
|
# @!method self.variants
|
|
1403
|
-
# @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)]
|
|
1404
1784
|
end
|
|
1405
1785
|
|
|
1406
1786
|
module Metadata
|
|
@@ -1412,7 +1792,7 @@ module SafetyKit
|
|
|
1412
1792
|
|
|
1413
1793
|
variant SafetyKit::Internal::Type::Boolean
|
|
1414
1794
|
|
|
1415
|
-
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1795
|
+
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UserContact::Metadata::UnionMember3Array }
|
|
1416
1796
|
|
|
1417
1797
|
module UnionMember3
|
|
1418
1798
|
extend SafetyKit::Internal::Type::Union
|
|
@@ -1433,7 +1813,7 @@ module SafetyKit
|
|
|
1433
1813
|
# @type [SafetyKit::Internal::Type::Converter]
|
|
1434
1814
|
UnionMember3Array =
|
|
1435
1815
|
SafetyKit::Internal::Type::ArrayOf[union: -> {
|
|
1436
|
-
SafetyKit::Beta::EventCreateParams::Body::
|
|
1816
|
+
SafetyKit::Beta::EventCreateParams::Body::UnionMember5::UserContact::Metadata::UnionMember3
|
|
1437
1817
|
}]
|
|
1438
1818
|
end
|
|
1439
1819
|
|
|
@@ -1454,7 +1834,7 @@ module SafetyKit
|
|
|
1454
1834
|
|
|
1455
1835
|
# @!method initialize(type:, value:)
|
|
1456
1836
|
# Some parameter documentations has been truncated, see
|
|
1457
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1837
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UserContact::ResourcesUsed}
|
|
1458
1838
|
# for more details.
|
|
1459
1839
|
#
|
|
1460
1840
|
# Real-world or account resource used during the event, such as an email, phone
|
|
@@ -1472,9 +1852,9 @@ module SafetyKit
|
|
|
1472
1852
|
# listing text, image URLs, and similar content SafetyKit should compare or
|
|
1473
1853
|
# analyze.
|
|
1474
1854
|
#
|
|
1475
|
-
# @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>]
|
|
1476
1856
|
required :content,
|
|
1477
|
-
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
1857
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember5::ContentUploaded::Content] }
|
|
1478
1858
|
|
|
1479
1859
|
# @!attribute event_name
|
|
1480
1860
|
# Stable, low-cardinality product action name. Use snake_case and put dynamic
|
|
@@ -1500,31 +1880,38 @@ module SafetyKit
|
|
|
1500
1880
|
# @return [String]
|
|
1501
1881
|
required :user_id, String
|
|
1502
1882
|
|
|
1883
|
+
# @!attribute content_id
|
|
1884
|
+
# Your stable identifier for the content involved in this event, such as a
|
|
1885
|
+
# message, listing, page, post, profile, or uploaded media item.
|
|
1886
|
+
#
|
|
1887
|
+
# @return [String, nil]
|
|
1888
|
+
optional :content_id, String
|
|
1889
|
+
|
|
1503
1890
|
# @!attribute metadata
|
|
1504
1891
|
# Non-PII product context for filtering, segmentation, and debugging. Values may
|
|
1505
1892
|
# be strings, numbers, booleans, or arrays of those scalar values.
|
|
1506
1893
|
#
|
|
1507
1894
|
# @return [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}, nil]
|
|
1508
1895
|
optional :metadata,
|
|
1509
|
-
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
1896
|
+
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember5::ContentUploaded::Metadata] }
|
|
1510
1897
|
|
|
1511
1898
|
# @!attribute resources_used
|
|
1512
1899
|
# Reusable resources observed during the event. Use this for emails, phone
|
|
1513
1900
|
# numbers, names, addresses, social handles, URLs, payment identifiers, or similar
|
|
1514
1901
|
# identifiers.
|
|
1515
1902
|
#
|
|
1516
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1903
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::ContentUploaded::ResourcesUsed>, nil]
|
|
1517
1904
|
optional :resources_used,
|
|
1518
|
-
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::
|
|
1905
|
+
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::UnionMember5::ContentUploaded::ResourcesUsed] }
|
|
1519
1906
|
|
|
1520
|
-
# @!method initialize(content:, event_name:, timestamp:, user_id:, metadata: nil, resources_used: nil, type: :content_uploaded)
|
|
1907
|
+
# @!method initialize(content:, event_name:, timestamp:, user_id:, content_id: nil, metadata: nil, resources_used: nil, type: :content_uploaded)
|
|
1521
1908
|
# Some parameter documentations has been truncated, see
|
|
1522
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1909
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::ContentUploaded}
|
|
1523
1910
|
# for more details.
|
|
1524
1911
|
#
|
|
1525
1912
|
# A user posts, uploads, publishes, edits, or replaces content.
|
|
1526
1913
|
#
|
|
1527
|
-
# @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,
|
|
1528
1915
|
#
|
|
1529
1916
|
# @param event_name [String] Stable, low-cardinality product action name. Use snake_case and put dynamic valu
|
|
1530
1917
|
#
|
|
@@ -1532,9 +1919,11 @@ module SafetyKit
|
|
|
1532
1919
|
#
|
|
1533
1920
|
# @param user_id [String] Your stable canonical identifier for the user or account.
|
|
1534
1921
|
#
|
|
1922
|
+
# @param content_id [String] Your stable identifier for the content involved in this event, such as a message
|
|
1923
|
+
#
|
|
1535
1924
|
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
1536
1925
|
#
|
|
1537
|
-
# @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
|
|
1538
1927
|
#
|
|
1539
1928
|
# @param type [Symbol, :content_uploaded]
|
|
1540
1929
|
|
|
@@ -1543,10 +1932,10 @@ module SafetyKit
|
|
|
1543
1932
|
extend SafetyKit::Internal::Type::Union
|
|
1544
1933
|
|
|
1545
1934
|
# User-authored text content associated with an event.
|
|
1546
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
1935
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember5::ContentUploaded::Content::EventTextContent }
|
|
1547
1936
|
|
|
1548
1937
|
# User-uploaded image content associated with an event.
|
|
1549
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
1938
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember5::ContentUploaded::Content::EventImageContent }
|
|
1550
1939
|
|
|
1551
1940
|
class EventTextContent < SafetyKit::Internal::Type::BaseModel
|
|
1552
1941
|
# @!attribute text
|
|
@@ -1558,9 +1947,9 @@ module SafetyKit
|
|
|
1558
1947
|
# @!attribute type
|
|
1559
1948
|
# Text content part.
|
|
1560
1949
|
#
|
|
1561
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1950
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::ContentUploaded::Content::EventTextContent::Type]
|
|
1562
1951
|
required :type,
|
|
1563
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
1952
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember5::ContentUploaded::Content::EventTextContent::Type }
|
|
1564
1953
|
|
|
1565
1954
|
# @!attribute key
|
|
1566
1955
|
# Stable field key for this content part.
|
|
@@ -1573,13 +1962,13 @@ module SafetyKit
|
|
|
1573
1962
|
#
|
|
1574
1963
|
# @param text [String] User-authored text SafetyKit should compare or analyze.
|
|
1575
1964
|
#
|
|
1576
|
-
# @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.
|
|
1577
1966
|
#
|
|
1578
1967
|
# @param key [String] Stable field key for this content part.
|
|
1579
1968
|
|
|
1580
1969
|
# Text content part.
|
|
1581
1970
|
#
|
|
1582
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1971
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::ContentUploaded::Content::EventTextContent#type
|
|
1583
1972
|
module Type
|
|
1584
1973
|
extend SafetyKit::Internal::Type::Enum
|
|
1585
1974
|
|
|
@@ -1594,16 +1983,16 @@ module SafetyKit
|
|
|
1594
1983
|
# @!attribute source
|
|
1595
1984
|
# Image source information.
|
|
1596
1985
|
#
|
|
1597
|
-
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1986
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::ContentUploaded::Content::EventImageContent::Source]
|
|
1598
1987
|
required :source,
|
|
1599
|
-
-> { SafetyKit::Beta::EventCreateParams::Body::
|
|
1988
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::UnionMember5::ContentUploaded::Content::EventImageContent::Source }
|
|
1600
1989
|
|
|
1601
1990
|
# @!attribute type
|
|
1602
1991
|
# Image content part.
|
|
1603
1992
|
#
|
|
1604
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1993
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::ContentUploaded::Content::EventImageContent::Type]
|
|
1605
1994
|
required :type,
|
|
1606
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
1995
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember5::ContentUploaded::Content::EventImageContent::Type }
|
|
1607
1996
|
|
|
1608
1997
|
# @!attribute key
|
|
1609
1998
|
# Stable field key for this content part.
|
|
@@ -1614,20 +2003,20 @@ module SafetyKit
|
|
|
1614
2003
|
# @!method initialize(source:, type:, key: nil)
|
|
1615
2004
|
# User-uploaded image content associated with an event.
|
|
1616
2005
|
#
|
|
1617
|
-
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2006
|
+
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::ContentUploaded::Content::EventImageContent::Source] Image source information.
|
|
1618
2007
|
#
|
|
1619
|
-
# @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.
|
|
1620
2009
|
#
|
|
1621
2010
|
# @param key [String] Stable field key for this content part.
|
|
1622
2011
|
|
|
1623
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2012
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::ContentUploaded::Content::EventImageContent#source
|
|
1624
2013
|
class Source < SafetyKit::Internal::Type::BaseModel
|
|
1625
2014
|
# @!attribute type
|
|
1626
2015
|
# URL image source.
|
|
1627
2016
|
#
|
|
1628
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2017
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::ContentUploaded::Content::EventImageContent::Source::Type]
|
|
1629
2018
|
required :type,
|
|
1630
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
2019
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember5::ContentUploaded::Content::EventImageContent::Source::Type }
|
|
1631
2020
|
|
|
1632
2021
|
# @!attribute url
|
|
1633
2022
|
# URL of the image SafetyKit should compare or analyze.
|
|
@@ -1638,13 +2027,13 @@ module SafetyKit
|
|
|
1638
2027
|
# @!method initialize(type:, url:)
|
|
1639
2028
|
# Image source information.
|
|
1640
2029
|
#
|
|
1641
|
-
# @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.
|
|
1642
2031
|
#
|
|
1643
2032
|
# @param url [String] URL of the image SafetyKit should compare or analyze.
|
|
1644
2033
|
|
|
1645
2034
|
# URL image source.
|
|
1646
2035
|
#
|
|
1647
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2036
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::ContentUploaded::Content::EventImageContent::Source#type
|
|
1648
2037
|
module Type
|
|
1649
2038
|
extend SafetyKit::Internal::Type::Enum
|
|
1650
2039
|
|
|
@@ -1657,7 +2046,7 @@ module SafetyKit
|
|
|
1657
2046
|
|
|
1658
2047
|
# Image content part.
|
|
1659
2048
|
#
|
|
1660
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2049
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::ContentUploaded::Content::EventImageContent#type
|
|
1661
2050
|
module Type
|
|
1662
2051
|
extend SafetyKit::Internal::Type::Enum
|
|
1663
2052
|
|
|
@@ -1669,7 +2058,7 @@ module SafetyKit
|
|
|
1669
2058
|
end
|
|
1670
2059
|
|
|
1671
2060
|
# @!method self.variants
|
|
1672
|
-
# @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)]
|
|
1673
2062
|
end
|
|
1674
2063
|
|
|
1675
2064
|
module Metadata
|
|
@@ -1681,7 +2070,7 @@ module SafetyKit
|
|
|
1681
2070
|
|
|
1682
2071
|
variant SafetyKit::Internal::Type::Boolean
|
|
1683
2072
|
|
|
1684
|
-
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2073
|
+
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::ContentUploaded::Metadata::UnionMember3Array }
|
|
1685
2074
|
|
|
1686
2075
|
module UnionMember3
|
|
1687
2076
|
extend SafetyKit::Internal::Type::Union
|
|
@@ -1702,7 +2091,7 @@ module SafetyKit
|
|
|
1702
2091
|
# @type [SafetyKit::Internal::Type::Converter]
|
|
1703
2092
|
UnionMember3Array =
|
|
1704
2093
|
SafetyKit::Internal::Type::ArrayOf[
|
|
1705
|
-
union: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
2094
|
+
union: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember5::ContentUploaded::Metadata::UnionMember3 }
|
|
1706
2095
|
]
|
|
1707
2096
|
end
|
|
1708
2097
|
|
|
@@ -1723,7 +2112,7 @@ module SafetyKit
|
|
|
1723
2112
|
|
|
1724
2113
|
# @!method initialize(type:, value:)
|
|
1725
2114
|
# Some parameter documentations has been truncated, see
|
|
1726
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2115
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::ContentUploaded::ResourcesUsed}
|
|
1727
2116
|
# for more details.
|
|
1728
2117
|
#
|
|
1729
2118
|
# Real-world or account resource used during the event, such as an email, phone
|
|
@@ -1765,9 +2154,16 @@ module SafetyKit
|
|
|
1765
2154
|
# listing text, image URLs, and similar content SafetyKit should compare or
|
|
1766
2155
|
# analyze.
|
|
1767
2156
|
#
|
|
1768
|
-
# @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]
|
|
1769
2158
|
optional :content,
|
|
1770
|
-
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
2159
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember5::CreateAccount::Content] }
|
|
2160
|
+
|
|
2161
|
+
# @!attribute content_id
|
|
2162
|
+
# Your stable identifier for the content involved in this event, such as a
|
|
2163
|
+
# message, listing, page, post, profile, or uploaded media item.
|
|
2164
|
+
#
|
|
2165
|
+
# @return [String, nil]
|
|
2166
|
+
optional :content_id, String
|
|
1771
2167
|
|
|
1772
2168
|
# @!attribute metadata
|
|
1773
2169
|
# Non-PII product context for filtering, segmentation, and debugging. Values may
|
|
@@ -1775,20 +2171,20 @@ module SafetyKit
|
|
|
1775
2171
|
#
|
|
1776
2172
|
# @return [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}, nil]
|
|
1777
2173
|
optional :metadata,
|
|
1778
|
-
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
2174
|
+
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember5::CreateAccount::Metadata] }
|
|
1779
2175
|
|
|
1780
2176
|
# @!attribute resources_used
|
|
1781
2177
|
# Reusable resources observed during the event. Use this for emails, phone
|
|
1782
2178
|
# numbers, names, addresses, social handles, URLs, payment identifiers, or similar
|
|
1783
2179
|
# identifiers.
|
|
1784
2180
|
#
|
|
1785
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2181
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::CreateAccount::ResourcesUsed>, nil]
|
|
1786
2182
|
optional :resources_used,
|
|
1787
|
-
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::
|
|
2183
|
+
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::UnionMember5::CreateAccount::ResourcesUsed] }
|
|
1788
2184
|
|
|
1789
|
-
# @!method initialize(event_name:, timestamp:, user_id:, content: nil, metadata: nil, resources_used: nil, type: :create_account)
|
|
2185
|
+
# @!method initialize(event_name:, timestamp:, user_id:, content: nil, content_id: nil, metadata: nil, resources_used: nil, type: :create_account)
|
|
1790
2186
|
# Some parameter documentations has been truncated, see
|
|
1791
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2187
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::CreateAccount}
|
|
1792
2188
|
# for more details.
|
|
1793
2189
|
#
|
|
1794
2190
|
# A user or account is created.
|
|
@@ -1799,11 +2195,13 @@ module SafetyKit
|
|
|
1799
2195
|
#
|
|
1800
2196
|
# @param user_id [String] Your stable canonical identifier for the user or account.
|
|
1801
2197
|
#
|
|
1802
|
-
# @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,
|
|
2199
|
+
#
|
|
2200
|
+
# @param content_id [String] Your stable identifier for the content involved in this event, such as a message
|
|
1803
2201
|
#
|
|
1804
2202
|
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
1805
2203
|
#
|
|
1806
|
-
# @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
|
|
1807
2205
|
#
|
|
1808
2206
|
# @param type [Symbol, :create_account]
|
|
1809
2207
|
|
|
@@ -1812,10 +2210,10 @@ module SafetyKit
|
|
|
1812
2210
|
extend SafetyKit::Internal::Type::Union
|
|
1813
2211
|
|
|
1814
2212
|
# User-authored text content associated with an event.
|
|
1815
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
2213
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember5::CreateAccount::Content::EventTextContent }
|
|
1816
2214
|
|
|
1817
2215
|
# User-uploaded image content associated with an event.
|
|
1818
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
2216
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember5::CreateAccount::Content::EventImageContent }
|
|
1819
2217
|
|
|
1820
2218
|
class EventTextContent < SafetyKit::Internal::Type::BaseModel
|
|
1821
2219
|
# @!attribute text
|
|
@@ -1827,9 +2225,9 @@ module SafetyKit
|
|
|
1827
2225
|
# @!attribute type
|
|
1828
2226
|
# Text content part.
|
|
1829
2227
|
#
|
|
1830
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2228
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::CreateAccount::Content::EventTextContent::Type]
|
|
1831
2229
|
required :type,
|
|
1832
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
2230
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember5::CreateAccount::Content::EventTextContent::Type }
|
|
1833
2231
|
|
|
1834
2232
|
# @!attribute key
|
|
1835
2233
|
# Stable field key for this content part.
|
|
@@ -1842,13 +2240,13 @@ module SafetyKit
|
|
|
1842
2240
|
#
|
|
1843
2241
|
# @param text [String] User-authored text SafetyKit should compare or analyze.
|
|
1844
2242
|
#
|
|
1845
|
-
# @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.
|
|
1846
2244
|
#
|
|
1847
2245
|
# @param key [String] Stable field key for this content part.
|
|
1848
2246
|
|
|
1849
2247
|
# Text content part.
|
|
1850
2248
|
#
|
|
1851
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2249
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::CreateAccount::Content::EventTextContent#type
|
|
1852
2250
|
module Type
|
|
1853
2251
|
extend SafetyKit::Internal::Type::Enum
|
|
1854
2252
|
|
|
@@ -1863,16 +2261,16 @@ module SafetyKit
|
|
|
1863
2261
|
# @!attribute source
|
|
1864
2262
|
# Image source information.
|
|
1865
2263
|
#
|
|
1866
|
-
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2264
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::CreateAccount::Content::EventImageContent::Source]
|
|
1867
2265
|
required :source,
|
|
1868
|
-
-> { SafetyKit::Beta::EventCreateParams::Body::
|
|
2266
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::UnionMember5::CreateAccount::Content::EventImageContent::Source }
|
|
1869
2267
|
|
|
1870
2268
|
# @!attribute type
|
|
1871
2269
|
# Image content part.
|
|
1872
2270
|
#
|
|
1873
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2271
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::CreateAccount::Content::EventImageContent::Type]
|
|
1874
2272
|
required :type,
|
|
1875
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
2273
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember5::CreateAccount::Content::EventImageContent::Type }
|
|
1876
2274
|
|
|
1877
2275
|
# @!attribute key
|
|
1878
2276
|
# Stable field key for this content part.
|
|
@@ -1883,20 +2281,20 @@ module SafetyKit
|
|
|
1883
2281
|
# @!method initialize(source:, type:, key: nil)
|
|
1884
2282
|
# User-uploaded image content associated with an event.
|
|
1885
2283
|
#
|
|
1886
|
-
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2284
|
+
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::CreateAccount::Content::EventImageContent::Source] Image source information.
|
|
1887
2285
|
#
|
|
1888
|
-
# @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.
|
|
1889
2287
|
#
|
|
1890
2288
|
# @param key [String] Stable field key for this content part.
|
|
1891
2289
|
|
|
1892
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2290
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::CreateAccount::Content::EventImageContent#source
|
|
1893
2291
|
class Source < SafetyKit::Internal::Type::BaseModel
|
|
1894
2292
|
# @!attribute type
|
|
1895
2293
|
# URL image source.
|
|
1896
2294
|
#
|
|
1897
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2295
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::CreateAccount::Content::EventImageContent::Source::Type]
|
|
1898
2296
|
required :type,
|
|
1899
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
2297
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember5::CreateAccount::Content::EventImageContent::Source::Type }
|
|
1900
2298
|
|
|
1901
2299
|
# @!attribute url
|
|
1902
2300
|
# URL of the image SafetyKit should compare or analyze.
|
|
@@ -1907,13 +2305,13 @@ module SafetyKit
|
|
|
1907
2305
|
# @!method initialize(type:, url:)
|
|
1908
2306
|
# Image source information.
|
|
1909
2307
|
#
|
|
1910
|
-
# @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.
|
|
1911
2309
|
#
|
|
1912
2310
|
# @param url [String] URL of the image SafetyKit should compare or analyze.
|
|
1913
2311
|
|
|
1914
2312
|
# URL image source.
|
|
1915
2313
|
#
|
|
1916
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2314
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::CreateAccount::Content::EventImageContent::Source#type
|
|
1917
2315
|
module Type
|
|
1918
2316
|
extend SafetyKit::Internal::Type::Enum
|
|
1919
2317
|
|
|
@@ -1926,7 +2324,7 @@ module SafetyKit
|
|
|
1926
2324
|
|
|
1927
2325
|
# Image content part.
|
|
1928
2326
|
#
|
|
1929
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2327
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::CreateAccount::Content::EventImageContent#type
|
|
1930
2328
|
module Type
|
|
1931
2329
|
extend SafetyKit::Internal::Type::Enum
|
|
1932
2330
|
|
|
@@ -1938,7 +2336,7 @@ module SafetyKit
|
|
|
1938
2336
|
end
|
|
1939
2337
|
|
|
1940
2338
|
# @!method self.variants
|
|
1941
|
-
# @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)]
|
|
1942
2340
|
end
|
|
1943
2341
|
|
|
1944
2342
|
module Metadata
|
|
@@ -1950,7 +2348,7 @@ module SafetyKit
|
|
|
1950
2348
|
|
|
1951
2349
|
variant SafetyKit::Internal::Type::Boolean
|
|
1952
2350
|
|
|
1953
|
-
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2351
|
+
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::CreateAccount::Metadata::UnionMember3Array }
|
|
1954
2352
|
|
|
1955
2353
|
module UnionMember3
|
|
1956
2354
|
extend SafetyKit::Internal::Type::Union
|
|
@@ -1971,7 +2369,7 @@ module SafetyKit
|
|
|
1971
2369
|
# @type [SafetyKit::Internal::Type::Converter]
|
|
1972
2370
|
UnionMember3Array =
|
|
1973
2371
|
SafetyKit::Internal::Type::ArrayOf[
|
|
1974
|
-
union: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
2372
|
+
union: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember5::CreateAccount::Metadata::UnionMember3 }
|
|
1975
2373
|
]
|
|
1976
2374
|
end
|
|
1977
2375
|
|
|
@@ -1992,7 +2390,7 @@ module SafetyKit
|
|
|
1992
2390
|
|
|
1993
2391
|
# @!method initialize(type:, value:)
|
|
1994
2392
|
# Some parameter documentations has been truncated, see
|
|
1995
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2393
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::CreateAccount::ResourcesUsed}
|
|
1996
2394
|
# for more details.
|
|
1997
2395
|
#
|
|
1998
2396
|
# Real-world or account resource used during the event, such as an email, phone
|
|
@@ -2034,9 +2432,16 @@ module SafetyKit
|
|
|
2034
2432
|
# listing text, image URLs, and similar content SafetyKit should compare or
|
|
2035
2433
|
# analyze.
|
|
2036
2434
|
#
|
|
2037
|
-
# @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]
|
|
2038
2436
|
optional :content,
|
|
2039
|
-
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
2437
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember5::UpdateAccount::Content] }
|
|
2438
|
+
|
|
2439
|
+
# @!attribute content_id
|
|
2440
|
+
# Your stable identifier for the content involved in this event, such as a
|
|
2441
|
+
# message, listing, page, post, profile, or uploaded media item.
|
|
2442
|
+
#
|
|
2443
|
+
# @return [String, nil]
|
|
2444
|
+
optional :content_id, String
|
|
2040
2445
|
|
|
2041
2446
|
# @!attribute metadata
|
|
2042
2447
|
# Non-PII product context for filtering, segmentation, and debugging. Values may
|
|
@@ -2044,20 +2449,20 @@ module SafetyKit
|
|
|
2044
2449
|
#
|
|
2045
2450
|
# @return [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}, nil]
|
|
2046
2451
|
optional :metadata,
|
|
2047
|
-
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
2452
|
+
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember5::UpdateAccount::Metadata] }
|
|
2048
2453
|
|
|
2049
2454
|
# @!attribute resources_used
|
|
2050
2455
|
# Reusable resources observed during the event. Use this for emails, phone
|
|
2051
2456
|
# numbers, names, addresses, social handles, URLs, payment identifiers, or similar
|
|
2052
2457
|
# identifiers.
|
|
2053
2458
|
#
|
|
2054
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2459
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UpdateAccount::ResourcesUsed>, nil]
|
|
2055
2460
|
optional :resources_used,
|
|
2056
|
-
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::
|
|
2461
|
+
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::UnionMember5::UpdateAccount::ResourcesUsed] }
|
|
2057
2462
|
|
|
2058
|
-
# @!method initialize(event_name:, timestamp:, user_id:, content: nil, metadata: nil, resources_used: nil, type: :update_account)
|
|
2463
|
+
# @!method initialize(event_name:, timestamp:, user_id:, content: nil, content_id: nil, metadata: nil, resources_used: nil, type: :update_account)
|
|
2059
2464
|
# Some parameter documentations has been truncated, see
|
|
2060
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2465
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UpdateAccount}
|
|
2061
2466
|
# for more details.
|
|
2062
2467
|
#
|
|
2063
2468
|
# A user or account profile, contact detail, payment detail, or public bio
|
|
@@ -2069,11 +2474,13 @@ module SafetyKit
|
|
|
2069
2474
|
#
|
|
2070
2475
|
# @param user_id [String] Your stable canonical identifier for the user or account.
|
|
2071
2476
|
#
|
|
2072
|
-
# @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,
|
|
2478
|
+
#
|
|
2479
|
+
# @param content_id [String] Your stable identifier for the content involved in this event, such as a message
|
|
2073
2480
|
#
|
|
2074
2481
|
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
2075
2482
|
#
|
|
2076
|
-
# @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
|
|
2077
2484
|
#
|
|
2078
2485
|
# @param type [Symbol, :update_account]
|
|
2079
2486
|
|
|
@@ -2082,10 +2489,10 @@ module SafetyKit
|
|
|
2082
2489
|
extend SafetyKit::Internal::Type::Union
|
|
2083
2490
|
|
|
2084
2491
|
# User-authored text content associated with an event.
|
|
2085
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
2492
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember5::UpdateAccount::Content::EventTextContent }
|
|
2086
2493
|
|
|
2087
2494
|
# User-uploaded image content associated with an event.
|
|
2088
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
2495
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember5::UpdateAccount::Content::EventImageContent }
|
|
2089
2496
|
|
|
2090
2497
|
class EventTextContent < SafetyKit::Internal::Type::BaseModel
|
|
2091
2498
|
# @!attribute text
|
|
@@ -2097,9 +2504,9 @@ module SafetyKit
|
|
|
2097
2504
|
# @!attribute type
|
|
2098
2505
|
# Text content part.
|
|
2099
2506
|
#
|
|
2100
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2507
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UpdateAccount::Content::EventTextContent::Type]
|
|
2101
2508
|
required :type,
|
|
2102
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
2509
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember5::UpdateAccount::Content::EventTextContent::Type }
|
|
2103
2510
|
|
|
2104
2511
|
# @!attribute key
|
|
2105
2512
|
# Stable field key for this content part.
|
|
@@ -2112,13 +2519,13 @@ module SafetyKit
|
|
|
2112
2519
|
#
|
|
2113
2520
|
# @param text [String] User-authored text SafetyKit should compare or analyze.
|
|
2114
2521
|
#
|
|
2115
|
-
# @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.
|
|
2116
2523
|
#
|
|
2117
2524
|
# @param key [String] Stable field key for this content part.
|
|
2118
2525
|
|
|
2119
2526
|
# Text content part.
|
|
2120
2527
|
#
|
|
2121
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2528
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UpdateAccount::Content::EventTextContent#type
|
|
2122
2529
|
module Type
|
|
2123
2530
|
extend SafetyKit::Internal::Type::Enum
|
|
2124
2531
|
|
|
@@ -2133,16 +2540,16 @@ module SafetyKit
|
|
|
2133
2540
|
# @!attribute source
|
|
2134
2541
|
# Image source information.
|
|
2135
2542
|
#
|
|
2136
|
-
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2543
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UpdateAccount::Content::EventImageContent::Source]
|
|
2137
2544
|
required :source,
|
|
2138
|
-
-> { SafetyKit::Beta::EventCreateParams::Body::
|
|
2545
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::UnionMember5::UpdateAccount::Content::EventImageContent::Source }
|
|
2139
2546
|
|
|
2140
2547
|
# @!attribute type
|
|
2141
2548
|
# Image content part.
|
|
2142
2549
|
#
|
|
2143
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2550
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UpdateAccount::Content::EventImageContent::Type]
|
|
2144
2551
|
required :type,
|
|
2145
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
2552
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember5::UpdateAccount::Content::EventImageContent::Type }
|
|
2146
2553
|
|
|
2147
2554
|
# @!attribute key
|
|
2148
2555
|
# Stable field key for this content part.
|
|
@@ -2153,20 +2560,20 @@ module SafetyKit
|
|
|
2153
2560
|
# @!method initialize(source:, type:, key: nil)
|
|
2154
2561
|
# User-uploaded image content associated with an event.
|
|
2155
2562
|
#
|
|
2156
|
-
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2563
|
+
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UpdateAccount::Content::EventImageContent::Source] Image source information.
|
|
2157
2564
|
#
|
|
2158
|
-
# @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.
|
|
2159
2566
|
#
|
|
2160
2567
|
# @param key [String] Stable field key for this content part.
|
|
2161
2568
|
|
|
2162
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2569
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UpdateAccount::Content::EventImageContent#source
|
|
2163
2570
|
class Source < SafetyKit::Internal::Type::BaseModel
|
|
2164
2571
|
# @!attribute type
|
|
2165
2572
|
# URL image source.
|
|
2166
2573
|
#
|
|
2167
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2574
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UpdateAccount::Content::EventImageContent::Source::Type]
|
|
2168
2575
|
required :type,
|
|
2169
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
2576
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember5::UpdateAccount::Content::EventImageContent::Source::Type }
|
|
2170
2577
|
|
|
2171
2578
|
# @!attribute url
|
|
2172
2579
|
# URL of the image SafetyKit should compare or analyze.
|
|
@@ -2177,13 +2584,13 @@ module SafetyKit
|
|
|
2177
2584
|
# @!method initialize(type:, url:)
|
|
2178
2585
|
# Image source information.
|
|
2179
2586
|
#
|
|
2180
|
-
# @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.
|
|
2181
2588
|
#
|
|
2182
2589
|
# @param url [String] URL of the image SafetyKit should compare or analyze.
|
|
2183
2590
|
|
|
2184
2591
|
# URL image source.
|
|
2185
2592
|
#
|
|
2186
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2593
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UpdateAccount::Content::EventImageContent::Source#type
|
|
2187
2594
|
module Type
|
|
2188
2595
|
extend SafetyKit::Internal::Type::Enum
|
|
2189
2596
|
|
|
@@ -2196,7 +2603,7 @@ module SafetyKit
|
|
|
2196
2603
|
|
|
2197
2604
|
# Image content part.
|
|
2198
2605
|
#
|
|
2199
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2606
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UpdateAccount::Content::EventImageContent#type
|
|
2200
2607
|
module Type
|
|
2201
2608
|
extend SafetyKit::Internal::Type::Enum
|
|
2202
2609
|
|
|
@@ -2208,7 +2615,7 @@ module SafetyKit
|
|
|
2208
2615
|
end
|
|
2209
2616
|
|
|
2210
2617
|
# @!method self.variants
|
|
2211
|
-
# @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)]
|
|
2212
2619
|
end
|
|
2213
2620
|
|
|
2214
2621
|
module Metadata
|
|
@@ -2220,7 +2627,7 @@ module SafetyKit
|
|
|
2220
2627
|
|
|
2221
2628
|
variant SafetyKit::Internal::Type::Boolean
|
|
2222
2629
|
|
|
2223
|
-
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2630
|
+
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember5::UpdateAccount::Metadata::UnionMember3Array }
|
|
2224
2631
|
|
|
2225
2632
|
module UnionMember3
|
|
2226
2633
|
extend SafetyKit::Internal::Type::Union
|
|
@@ -2241,7 +2648,7 @@ module SafetyKit
|
|
|
2241
2648
|
# @type [SafetyKit::Internal::Type::Converter]
|
|
2242
2649
|
UnionMember3Array =
|
|
2243
2650
|
SafetyKit::Internal::Type::ArrayOf[
|
|
2244
|
-
union: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
2651
|
+
union: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember5::UpdateAccount::Metadata::UnionMember3 }
|
|
2245
2652
|
]
|
|
2246
2653
|
end
|
|
2247
2654
|
|
|
@@ -2262,7 +2669,326 @@ module SafetyKit
|
|
|
2262
2669
|
|
|
2263
2670
|
# @!method initialize(type:, value:)
|
|
2264
2671
|
# Some parameter documentations has been truncated, see
|
|
2265
|
-
# {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}
|
|
2266
2992
|
# for more details.
|
|
2267
2993
|
#
|
|
2268
2994
|
# Real-world or account resource used during the event, such as an email, phone
|
|
@@ -2275,16 +3001,16 @@ module SafetyKit
|
|
|
2275
3001
|
end
|
|
2276
3002
|
|
|
2277
3003
|
# @!method self.variants
|
|
2278
|
-
# @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)]
|
|
2279
3005
|
end
|
|
2280
3006
|
|
|
2281
3007
|
# @!method self.variants
|
|
2282
|
-
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::UserContactEventRequest, SafetyKit::Models::Beta::EventCreateParams::Body::ContentUploadedEventRequest, SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest, SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest, Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
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>)]
|
|
2283
3009
|
|
|
2284
3010
|
# @type [SafetyKit::Internal::Type::Converter]
|
|
2285
|
-
|
|
3011
|
+
UnionMember5Array =
|
|
2286
3012
|
SafetyKit::Internal::Type::ArrayOf[union: -> {
|
|
2287
|
-
SafetyKit::Beta::EventCreateParams::Body::
|
|
3013
|
+
SafetyKit::Beta::EventCreateParams::Body::UnionMember5
|
|
2288
3014
|
}]
|
|
2289
3015
|
end
|
|
2290
3016
|
end
|