moderation_api 2.16.0 → 2.17.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +8 -0
- data/README.md +1 -1
- data/lib/moderation_api/models/webhook_event.rb +93 -93
- data/lib/moderation_api/version.rb +1 -1
- data/rbi/moderation_api/models/webhook_event.rbi +141 -141
- data/sig/moderation_api/models/webhook_event.rbs +100 -100
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 8d06166f679bb017ff6a3277860f748562e5e88bbe4657f501d07503285ec05a
|
|
4
|
+
data.tar.gz: d5696f29a66d95cc37dc48f5093142ab769a33274c820ef1c071c8d3f339e2fe
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: ed85222e962a4798a3345e456ac17c1e39c3d1e8ddf1e6e3bbdb7b8bb63e1d8ada7449c3fdde6318fe6a69dc1691f0e19322d41a8bbaa01df10c3099f94b5912
|
|
7
|
+
data.tar.gz: d16b9f5f991583b2a96e1015b3ea1d39e894238939ff020857166c3ce52d0614fdf1b699aff9013aee194cec29dae8a1cbeb57597b91ef6ccd600f29b838bb9d
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,13 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 2.17.0 (2026-05-08)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v2.16.0...v2.17.0](https://github.com/moderation-api/sdk-ruby/compare/v2.16.0...v2.17.0)
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
* **api:** api update ([5cc0a27](https://github.com/moderation-api/sdk-ruby/commit/5cc0a27adbffaaf0a4e0f601ca87b781df81d3dd))
|
|
10
|
+
|
|
3
11
|
## 2.16.0 (2026-05-08)
|
|
4
12
|
|
|
5
13
|
Full Changelog: [v2.15.0...v2.16.0](https://github.com/moderation-api/sdk-ruby/compare/v2.15.0...v2.16.0)
|
data/README.md
CHANGED
|
@@ -21,7 +21,7 @@ module ModerationAPI
|
|
|
21
21
|
|
|
22
22
|
variant :"author.action", -> { ModerationAPI::WebhookEvent::AuthorAction }
|
|
23
23
|
|
|
24
|
-
variant :"queue_item.
|
|
24
|
+
variant :"queue_item.resolved", -> { ModerationAPI::WebhookEvent::QueueItemResolved }
|
|
25
25
|
|
|
26
26
|
variant :"queue_item.action", -> { ModerationAPI::WebhookEvent::QueueItemAction }
|
|
27
27
|
|
|
@@ -2342,7 +2342,7 @@ module ModerationAPI
|
|
|
2342
2342
|
end
|
|
2343
2343
|
end
|
|
2344
2344
|
|
|
2345
|
-
class
|
|
2345
|
+
class QueueItemResolved < ModerationAPI::Internal::Type::BaseModel
|
|
2346
2346
|
# @!attribute id
|
|
2347
2347
|
# Stable event ID. Use this to dedupe retries.
|
|
2348
2348
|
#
|
|
@@ -2362,59 +2362,59 @@ module ModerationAPI
|
|
|
2362
2362
|
|
|
2363
2363
|
# @!attribute data
|
|
2364
2364
|
#
|
|
2365
|
-
# @return [ModerationAPI::Models::WebhookEvent::
|
|
2366
|
-
required :data, -> { ModerationAPI::WebhookEvent::
|
|
2365
|
+
# @return [ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data]
|
|
2366
|
+
required :data, -> { ModerationAPI::WebhookEvent::QueueItemResolved::Data }
|
|
2367
2367
|
|
|
2368
2368
|
# @!attribute type
|
|
2369
2369
|
# The event type.
|
|
2370
2370
|
#
|
|
2371
|
-
# @return [Symbol, :"queue_item.
|
|
2372
|
-
required :type, const: :"queue_item.
|
|
2371
|
+
# @return [Symbol, :"queue_item.resolved"]
|
|
2372
|
+
required :type, const: :"queue_item.resolved"
|
|
2373
2373
|
|
|
2374
|
-
# @!method initialize(id:, created:, data:, api_version: :v2, type: :"queue_item.
|
|
2374
|
+
# @!method initialize(id:, created:, data:, api_version: :v2, type: :"queue_item.resolved")
|
|
2375
2375
|
# @param id [String] Stable event ID. Use this to dedupe retries.
|
|
2376
2376
|
#
|
|
2377
2377
|
# @param created [Time] ISO 8601 timestamp of when the event was emitted.
|
|
2378
2378
|
#
|
|
2379
|
-
# @param data [ModerationAPI::Models::WebhookEvent::
|
|
2379
|
+
# @param data [ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data]
|
|
2380
2380
|
#
|
|
2381
2381
|
# @param api_version [Symbol, :v2]
|
|
2382
2382
|
#
|
|
2383
|
-
# @param type [Symbol, :"queue_item.
|
|
2383
|
+
# @param type [Symbol, :"queue_item.resolved"] The event type.
|
|
2384
2384
|
|
|
2385
|
-
# @see ModerationAPI::Models::WebhookEvent::
|
|
2385
|
+
# @see ModerationAPI::Models::WebhookEvent::QueueItemResolved#data
|
|
2386
2386
|
class Data < ModerationAPI::Internal::Type::BaseModel
|
|
2387
2387
|
# @!attribute object
|
|
2388
2388
|
#
|
|
2389
|
-
# @return [ModerationAPI::Models::WebhookEvent::
|
|
2390
|
-
required :object, -> { ModerationAPI::WebhookEvent::
|
|
2389
|
+
# @return [ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object]
|
|
2390
|
+
required :object, -> { ModerationAPI::WebhookEvent::QueueItemResolved::Data::Object }
|
|
2391
2391
|
|
|
2392
2392
|
# @!method initialize(object:)
|
|
2393
|
-
# @param object [ModerationAPI::Models::WebhookEvent::
|
|
2393
|
+
# @param object [ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object]
|
|
2394
2394
|
|
|
2395
|
-
# @see ModerationAPI::Models::WebhookEvent::
|
|
2395
|
+
# @see ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data#object
|
|
2396
2396
|
class Object < ModerationAPI::Internal::Type::BaseModel
|
|
2397
2397
|
# @!attribute item
|
|
2398
2398
|
#
|
|
2399
|
-
# @return [ModerationAPI::Models::WebhookEvent::
|
|
2400
|
-
required :item, -> { ModerationAPI::WebhookEvent::
|
|
2399
|
+
# @return [ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Item]
|
|
2400
|
+
required :item, -> { ModerationAPI::WebhookEvent::QueueItemResolved::Data::Object::Item }
|
|
2401
2401
|
|
|
2402
2402
|
# @!attribute author
|
|
2403
2403
|
#
|
|
2404
|
-
# @return [ModerationAPI::Models::WebhookEvent::
|
|
2405
|
-
optional :author, -> { ModerationAPI::WebhookEvent::
|
|
2404
|
+
# @return [ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Author, nil]
|
|
2405
|
+
optional :author, -> { ModerationAPI::WebhookEvent::QueueItemResolved::Data::Object::Author }
|
|
2406
2406
|
|
|
2407
2407
|
# @!attribute queue
|
|
2408
2408
|
#
|
|
2409
|
-
# @return [ModerationAPI::Models::WebhookEvent::
|
|
2410
|
-
optional :queue, -> { ModerationAPI::WebhookEvent::
|
|
2409
|
+
# @return [ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Queue, nil]
|
|
2410
|
+
optional :queue, -> { ModerationAPI::WebhookEvent::QueueItemResolved::Data::Object::Queue }
|
|
2411
2411
|
|
|
2412
2412
|
# @!method initialize(item:, author: nil, queue: nil)
|
|
2413
|
-
# @param item [ModerationAPI::Models::WebhookEvent::
|
|
2414
|
-
# @param author [ModerationAPI::Models::WebhookEvent::
|
|
2415
|
-
# @param queue [ModerationAPI::Models::WebhookEvent::
|
|
2413
|
+
# @param item [ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Item]
|
|
2414
|
+
# @param author [ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Author]
|
|
2415
|
+
# @param queue [ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Queue]
|
|
2416
2416
|
|
|
2417
|
-
# @see ModerationAPI::Models::WebhookEvent::
|
|
2417
|
+
# @see ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object#item
|
|
2418
2418
|
class Item < ModerationAPI::Internal::Type::BaseModel
|
|
2419
2419
|
# @!attribute id
|
|
2420
2420
|
# Content ID from your system
|
|
@@ -2438,9 +2438,9 @@ module ModerationAPI
|
|
|
2438
2438
|
# @!attribute content
|
|
2439
2439
|
# The original content payload
|
|
2440
2440
|
#
|
|
2441
|
-
# @return [ModerationAPI::Models::WebhookEvent::
|
|
2441
|
+
# @return [ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Item::Content::Text, ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Item::Content::Image, ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Item::Content::Video, ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Item::Content::Audio, ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Item::Content::Object]
|
|
2442
2442
|
required :content,
|
|
2443
|
-
union: -> { ModerationAPI::WebhookEvent::
|
|
2443
|
+
union: -> { ModerationAPI::WebhookEvent::QueueItemResolved::Data::Object::Item::Content }
|
|
2444
2444
|
|
|
2445
2445
|
# @!attribute conversation_id
|
|
2446
2446
|
# Conversation grouping ID, if any
|
|
@@ -2457,10 +2457,10 @@ module ModerationAPI
|
|
|
2457
2457
|
# @!attribute labels
|
|
2458
2458
|
# Moderation labels applied to the content
|
|
2459
2459
|
#
|
|
2460
|
-
# @return [Array<ModerationAPI::Models::WebhookEvent::
|
|
2460
|
+
# @return [Array<ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Item::Label>, nil]
|
|
2461
2461
|
required :labels,
|
|
2462
2462
|
-> {
|
|
2463
|
-
ModerationAPI::Internal::Type::ArrayOf[ModerationAPI::WebhookEvent::
|
|
2463
|
+
ModerationAPI::Internal::Type::ArrayOf[ModerationAPI::WebhookEvent::QueueItemResolved::Data::Object::Item::Label]
|
|
2464
2464
|
},
|
|
2465
2465
|
nil?: true
|
|
2466
2466
|
|
|
@@ -2475,10 +2475,10 @@ module ModerationAPI
|
|
|
2475
2475
|
# configured content type but can be overridden per request via the moderation API
|
|
2476
2476
|
# `type` field.
|
|
2477
2477
|
#
|
|
2478
|
-
# @return [Symbol, ModerationAPI::Models::WebhookEvent::
|
|
2478
|
+
# @return [Symbol, ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Item::MetaType, nil]
|
|
2479
2479
|
required :meta_type,
|
|
2480
2480
|
enum: -> {
|
|
2481
|
-
ModerationAPI::WebhookEvent::
|
|
2481
|
+
ModerationAPI::WebhookEvent::QueueItemResolved::Data::Object::Item::MetaType
|
|
2482
2482
|
},
|
|
2483
2483
|
nil?: true
|
|
2484
2484
|
|
|
@@ -2498,8 +2498,8 @@ module ModerationAPI
|
|
|
2498
2498
|
|
|
2499
2499
|
# @!method initialize(id:, author_id:, channel_key:, content:, conversation_id:, flagged:, labels:, language:, meta_type:, metadata:, timestamp:)
|
|
2500
2500
|
# Some parameter documentations has been truncated, see
|
|
2501
|
-
# {ModerationAPI::Models::WebhookEvent::
|
|
2502
|
-
#
|
|
2501
|
+
# {ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Item} for
|
|
2502
|
+
# more details.
|
|
2503
2503
|
#
|
|
2504
2504
|
# @param id [String] Content ID from your system
|
|
2505
2505
|
#
|
|
@@ -2507,17 +2507,17 @@ module ModerationAPI
|
|
|
2507
2507
|
#
|
|
2508
2508
|
# @param channel_key [String, nil] The channel the content was submitted to, identified by your customer-defined ch
|
|
2509
2509
|
#
|
|
2510
|
-
# @param content [ModerationAPI::Models::WebhookEvent::
|
|
2510
|
+
# @param content [ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Item::Content::Text, ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Item::Content::Image, ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Item::Content::Video, ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Item::Content::Audio, ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Item::Content::Object] The original content payload
|
|
2511
2511
|
#
|
|
2512
2512
|
# @param conversation_id [String, nil] Conversation grouping ID, if any
|
|
2513
2513
|
#
|
|
2514
2514
|
# @param flagged [Boolean, nil] Whether the content was flagged by moderation
|
|
2515
2515
|
#
|
|
2516
|
-
# @param labels [Array<ModerationAPI::Models::WebhookEvent::
|
|
2516
|
+
# @param labels [Array<ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Item::Label>, nil] Moderation labels applied to the content
|
|
2517
2517
|
#
|
|
2518
2518
|
# @param language [String, nil] Detected ISO language code, if available
|
|
2519
2519
|
#
|
|
2520
|
-
# @param meta_type [Symbol, ModerationAPI::Models::WebhookEvent::
|
|
2520
|
+
# @param meta_type [Symbol, ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Item::MetaType, nil] High-level content type (e.g. message, post, comment). Defaults to the channel's
|
|
2521
2521
|
#
|
|
2522
2522
|
# @param metadata [Hash{Symbol=>Object}, nil] Arbitrary key/value metadata. Top-level keys are strings.
|
|
2523
2523
|
#
|
|
@@ -2525,24 +2525,24 @@ module ModerationAPI
|
|
|
2525
2525
|
|
|
2526
2526
|
# The original content payload
|
|
2527
2527
|
#
|
|
2528
|
-
# @see ModerationAPI::Models::WebhookEvent::
|
|
2528
|
+
# @see ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Item#content
|
|
2529
2529
|
module Content
|
|
2530
2530
|
extend ModerationAPI::Internal::Type::Union
|
|
2531
2531
|
|
|
2532
2532
|
# Text
|
|
2533
|
-
variant -> { ModerationAPI::WebhookEvent::
|
|
2533
|
+
variant -> { ModerationAPI::WebhookEvent::QueueItemResolved::Data::Object::Item::Content::Text }
|
|
2534
2534
|
|
|
2535
2535
|
# Image
|
|
2536
|
-
variant -> { ModerationAPI::WebhookEvent::
|
|
2536
|
+
variant -> { ModerationAPI::WebhookEvent::QueueItemResolved::Data::Object::Item::Content::Image }
|
|
2537
2537
|
|
|
2538
2538
|
# Video
|
|
2539
|
-
variant -> { ModerationAPI::WebhookEvent::
|
|
2539
|
+
variant -> { ModerationAPI::WebhookEvent::QueueItemResolved::Data::Object::Item::Content::Video }
|
|
2540
2540
|
|
|
2541
2541
|
# Audio
|
|
2542
|
-
variant -> { ModerationAPI::WebhookEvent::
|
|
2542
|
+
variant -> { ModerationAPI::WebhookEvent::QueueItemResolved::Data::Object::Item::Content::Audio }
|
|
2543
2543
|
|
|
2544
2544
|
# Object
|
|
2545
|
-
variant -> { ModerationAPI::WebhookEvent::
|
|
2545
|
+
variant -> { ModerationAPI::WebhookEvent::QueueItemResolved::Data::Object::Item::Content::Object }
|
|
2546
2546
|
|
|
2547
2547
|
class Text < ModerationAPI::Internal::Type::BaseModel
|
|
2548
2548
|
# @!attribute text
|
|
@@ -2585,7 +2585,7 @@ module ModerationAPI
|
|
|
2585
2585
|
|
|
2586
2586
|
# @!method initialize(data: nil, url: nil, type: :image)
|
|
2587
2587
|
# Some parameter documentations has been truncated, see
|
|
2588
|
-
# {ModerationAPI::Models::WebhookEvent::
|
|
2588
|
+
# {ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Item::Content::Image}
|
|
2589
2589
|
# for more details.
|
|
2590
2590
|
#
|
|
2591
2591
|
# Image
|
|
@@ -2641,9 +2641,9 @@ module ModerationAPI
|
|
|
2641
2641
|
# @!attribute data
|
|
2642
2642
|
# Values in the object. Can be mixed content types.
|
|
2643
2643
|
#
|
|
2644
|
-
# @return [Hash{Symbol=>ModerationAPI::Models::WebhookEvent::
|
|
2644
|
+
# @return [Hash{Symbol=>ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Item::Content::Object::Data::Text, ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Item::Content::Object::Data::Image, ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Item::Content::Object::Data::Video, ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Item::Content::Object::Data::Audio}]
|
|
2645
2645
|
required :data,
|
|
2646
|
-
-> { ModerationAPI::Internal::Type::HashOf[union: ModerationAPI::WebhookEvent::
|
|
2646
|
+
-> { ModerationAPI::Internal::Type::HashOf[union: ModerationAPI::WebhookEvent::QueueItemResolved::Data::Object::Item::Content::Object::Data] }
|
|
2647
2647
|
|
|
2648
2648
|
# @!attribute type
|
|
2649
2649
|
#
|
|
@@ -2653,7 +2653,7 @@ module ModerationAPI
|
|
|
2653
2653
|
# @!method initialize(data:, type: :object)
|
|
2654
2654
|
# Object
|
|
2655
2655
|
#
|
|
2656
|
-
# @param data [Hash{Symbol=>ModerationAPI::Models::WebhookEvent::
|
|
2656
|
+
# @param data [Hash{Symbol=>ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Item::Content::Object::Data::Text, ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Item::Content::Object::Data::Image, ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Item::Content::Object::Data::Video, ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Item::Content::Object::Data::Audio}] Values in the object. Can be mixed content types.
|
|
2657
2657
|
#
|
|
2658
2658
|
# @param type [Symbol, :object]
|
|
2659
2659
|
|
|
@@ -2662,16 +2662,16 @@ module ModerationAPI
|
|
|
2662
2662
|
extend ModerationAPI::Internal::Type::Union
|
|
2663
2663
|
|
|
2664
2664
|
# Text
|
|
2665
|
-
variant -> { ModerationAPI::WebhookEvent::
|
|
2665
|
+
variant -> { ModerationAPI::WebhookEvent::QueueItemResolved::Data::Object::Item::Content::Object::Data::Text }
|
|
2666
2666
|
|
|
2667
2667
|
# Image
|
|
2668
|
-
variant -> { ModerationAPI::WebhookEvent::
|
|
2668
|
+
variant -> { ModerationAPI::WebhookEvent::QueueItemResolved::Data::Object::Item::Content::Object::Data::Image }
|
|
2669
2669
|
|
|
2670
2670
|
# Video
|
|
2671
|
-
variant -> { ModerationAPI::WebhookEvent::
|
|
2671
|
+
variant -> { ModerationAPI::WebhookEvent::QueueItemResolved::Data::Object::Item::Content::Object::Data::Video }
|
|
2672
2672
|
|
|
2673
2673
|
# Audio
|
|
2674
|
-
variant -> { ModerationAPI::WebhookEvent::
|
|
2674
|
+
variant -> { ModerationAPI::WebhookEvent::QueueItemResolved::Data::Object::Item::Content::Object::Data::Audio }
|
|
2675
2675
|
|
|
2676
2676
|
class Text < ModerationAPI::Internal::Type::BaseModel
|
|
2677
2677
|
# @!attribute text
|
|
@@ -2714,7 +2714,7 @@ module ModerationAPI
|
|
|
2714
2714
|
|
|
2715
2715
|
# @!method initialize(data: nil, url: nil, type: :image)
|
|
2716
2716
|
# Some parameter documentations has been truncated, see
|
|
2717
|
-
# {ModerationAPI::Models::WebhookEvent::
|
|
2717
|
+
# {ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Item::Content::Object::Data::Image}
|
|
2718
2718
|
# for more details.
|
|
2719
2719
|
#
|
|
2720
2720
|
# Image
|
|
@@ -2767,12 +2767,12 @@ module ModerationAPI
|
|
|
2767
2767
|
end
|
|
2768
2768
|
|
|
2769
2769
|
# @!method self.variants
|
|
2770
|
-
# @return [Array(ModerationAPI::Models::WebhookEvent::
|
|
2770
|
+
# @return [Array(ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Item::Content::Object::Data::Text, ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Item::Content::Object::Data::Image, ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Item::Content::Object::Data::Video, ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Item::Content::Object::Data::Audio)]
|
|
2771
2771
|
end
|
|
2772
2772
|
end
|
|
2773
2773
|
|
|
2774
2774
|
# @!method self.variants
|
|
2775
|
-
# @return [Array(ModerationAPI::Models::WebhookEvent::
|
|
2775
|
+
# @return [Array(ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Item::Content::Text, ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Item::Content::Image, ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Item::Content::Video, ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Item::Content::Audio, ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Item::Content::Object)]
|
|
2776
2776
|
end
|
|
2777
2777
|
|
|
2778
2778
|
class Label < ModerationAPI::Internal::Type::BaseModel
|
|
@@ -2802,9 +2802,9 @@ module ModerationAPI
|
|
|
2802
2802
|
|
|
2803
2803
|
# @!attribute matches
|
|
2804
2804
|
#
|
|
2805
|
-
# @return [Array<ModerationAPI::Models::WebhookEvent::
|
|
2805
|
+
# @return [Array<ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Item::Label::Match>, nil]
|
|
2806
2806
|
optional :matches,
|
|
2807
|
-
-> { ModerationAPI::Internal::Type::ArrayOf[ModerationAPI::WebhookEvent::
|
|
2807
|
+
-> { ModerationAPI::Internal::Type::ArrayOf[ModerationAPI::WebhookEvent::QueueItemResolved::Data::Object::Item::Label::Match] }
|
|
2808
2808
|
|
|
2809
2809
|
# @!method initialize(label:, score:, flagged: nil, manual: nil, matches: nil)
|
|
2810
2810
|
# @param label [String] The label name
|
|
@@ -2815,7 +2815,7 @@ module ModerationAPI
|
|
|
2815
2815
|
#
|
|
2816
2816
|
# @param manual [Boolean] True if the label was applied manually by a moderator
|
|
2817
2817
|
#
|
|
2818
|
-
# @param matches [Array<ModerationAPI::Models::WebhookEvent::
|
|
2818
|
+
# @param matches [Array<ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Item::Label::Match>]
|
|
2819
2819
|
|
|
2820
2820
|
class Match < ModerationAPI::Internal::Type::BaseModel
|
|
2821
2821
|
# @!attribute match
|
|
@@ -2853,9 +2853,9 @@ module ModerationAPI
|
|
|
2853
2853
|
|
|
2854
2854
|
# @!attribute signals
|
|
2855
2855
|
#
|
|
2856
|
-
# @return [ModerationAPI::Models::WebhookEvent::
|
|
2856
|
+
# @return [ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Item::Label::Match::Signals, nil]
|
|
2857
2857
|
optional :signals,
|
|
2858
|
-
-> { ModerationAPI::WebhookEvent::
|
|
2858
|
+
-> { ModerationAPI::WebhookEvent::QueueItemResolved::Data::Object::Item::Label::Match::Signals }
|
|
2859
2859
|
|
|
2860
2860
|
# @!method initialize(match:, probability:, span:, entity_type: nil, mask: nil, reasons: nil, signals: nil)
|
|
2861
2861
|
# @param match [String] The matched substring
|
|
@@ -2870,9 +2870,9 @@ module ModerationAPI
|
|
|
2870
2870
|
#
|
|
2871
2871
|
# @param reasons [Array<String>]
|
|
2872
2872
|
#
|
|
2873
|
-
# @param signals [ModerationAPI::Models::WebhookEvent::
|
|
2873
|
+
# @param signals [ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Item::Label::Match::Signals]
|
|
2874
2874
|
|
|
2875
|
-
# @see ModerationAPI::Models::WebhookEvent::
|
|
2875
|
+
# @see ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Item::Label::Match#signals
|
|
2876
2876
|
class Signals < ModerationAPI::Internal::Type::BaseModel
|
|
2877
2877
|
# @!attribute bot_protection
|
|
2878
2878
|
#
|
|
@@ -2881,10 +2881,10 @@ module ModerationAPI
|
|
|
2881
2881
|
|
|
2882
2882
|
# @!attribute brand_impersonation
|
|
2883
2883
|
#
|
|
2884
|
-
# @return [ModerationAPI::Models::WebhookEvent::
|
|
2884
|
+
# @return [ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Item::Label::Match::Signals::BrandImpersonation, nil]
|
|
2885
2885
|
required :brand_impersonation,
|
|
2886
2886
|
-> {
|
|
2887
|
-
ModerationAPI::WebhookEvent::
|
|
2887
|
+
ModerationAPI::WebhookEvent::QueueItemResolved::Data::Object::Item::Label::Match::Signals::BrandImpersonation
|
|
2888
2888
|
},
|
|
2889
2889
|
nil?: true
|
|
2890
2890
|
|
|
@@ -2925,7 +2925,7 @@ module ModerationAPI
|
|
|
2925
2925
|
|
|
2926
2926
|
# @!method initialize(bot_protection:, brand_impersonation:, domain_age_days:, final_url:, has_email_setup:, has_suspicious_characters:, is_link_shortener:, is_reported:, redirect_count:)
|
|
2927
2927
|
# @param bot_protection [Boolean, nil]
|
|
2928
|
-
# @param brand_impersonation [ModerationAPI::Models::WebhookEvent::
|
|
2928
|
+
# @param brand_impersonation [ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Item::Label::Match::Signals::BrandImpersonation, nil]
|
|
2929
2929
|
# @param domain_age_days [Float, nil]
|
|
2930
2930
|
# @param final_url [String, nil]
|
|
2931
2931
|
# @param has_email_setup [Boolean, nil]
|
|
@@ -2934,7 +2934,7 @@ module ModerationAPI
|
|
|
2934
2934
|
# @param is_reported [Boolean]
|
|
2935
2935
|
# @param redirect_count [Float, nil]
|
|
2936
2936
|
|
|
2937
|
-
# @see ModerationAPI::Models::WebhookEvent::
|
|
2937
|
+
# @see ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Item::Label::Match::Signals#brand_impersonation
|
|
2938
2938
|
class BrandImpersonation < ModerationAPI::Internal::Type::BaseModel
|
|
2939
2939
|
# @!attribute brand
|
|
2940
2940
|
#
|
|
@@ -2958,7 +2958,7 @@ module ModerationAPI
|
|
|
2958
2958
|
# configured content type but can be overridden per request via the moderation API
|
|
2959
2959
|
# `type` field.
|
|
2960
2960
|
#
|
|
2961
|
-
# @see ModerationAPI::Models::WebhookEvent::
|
|
2961
|
+
# @see ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Item#meta_type
|
|
2962
2962
|
module MetaType
|
|
2963
2963
|
extend ModerationAPI::Internal::Type::Enum
|
|
2964
2964
|
|
|
@@ -2976,7 +2976,7 @@ module ModerationAPI
|
|
|
2976
2976
|
end
|
|
2977
2977
|
end
|
|
2978
2978
|
|
|
2979
|
-
# @see ModerationAPI::Models::WebhookEvent::
|
|
2979
|
+
# @see ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object#author
|
|
2980
2980
|
class Author < ModerationAPI::Internal::Type::BaseModel
|
|
2981
2981
|
# @!attribute id
|
|
2982
2982
|
# Author ID in Moderation API
|
|
@@ -2987,9 +2987,9 @@ module ModerationAPI
|
|
|
2987
2987
|
# @!attribute block
|
|
2988
2988
|
# Block or suspension details, if applicable. Null if the author is enabled.
|
|
2989
2989
|
#
|
|
2990
|
-
# @return [ModerationAPI::Models::WebhookEvent::
|
|
2990
|
+
# @return [ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Author::Block, nil]
|
|
2991
2991
|
required :block,
|
|
2992
|
-
-> { ModerationAPI::WebhookEvent::
|
|
2992
|
+
-> { ModerationAPI::WebhookEvent::QueueItemResolved::Data::Object::Author::Block },
|
|
2993
2993
|
nil?: true
|
|
2994
2994
|
|
|
2995
2995
|
# @!attribute first_seen
|
|
@@ -3008,36 +3008,36 @@ module ModerationAPI
|
|
|
3008
3008
|
# Additional metadata provided by your system. We recommend including any relevant
|
|
3009
3009
|
# information that may assist in the moderation process.
|
|
3010
3010
|
#
|
|
3011
|
-
# @return [ModerationAPI::Models::WebhookEvent::
|
|
3012
|
-
required :metadata, -> { ModerationAPI::WebhookEvent::
|
|
3011
|
+
# @return [ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Author::Metadata]
|
|
3012
|
+
required :metadata, -> { ModerationAPI::WebhookEvent::QueueItemResolved::Data::Object::Author::Metadata }
|
|
3013
3013
|
|
|
3014
3014
|
# @!attribute metrics
|
|
3015
3015
|
#
|
|
3016
|
-
# @return [ModerationAPI::Models::WebhookEvent::
|
|
3017
|
-
required :metrics, -> { ModerationAPI::WebhookEvent::
|
|
3016
|
+
# @return [ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Author::Metrics]
|
|
3017
|
+
required :metrics, -> { ModerationAPI::WebhookEvent::QueueItemResolved::Data::Object::Author::Metrics }
|
|
3018
3018
|
|
|
3019
3019
|
# @!attribute risk_evaluation
|
|
3020
3020
|
# Risk assessment details, if available.
|
|
3021
3021
|
#
|
|
3022
|
-
# @return [ModerationAPI::Models::WebhookEvent::
|
|
3022
|
+
# @return [ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Author::RiskEvaluation, nil]
|
|
3023
3023
|
required :risk_evaluation,
|
|
3024
3024
|
-> {
|
|
3025
|
-
ModerationAPI::WebhookEvent::
|
|
3025
|
+
ModerationAPI::WebhookEvent::QueueItemResolved::Data::Object::Author::RiskEvaluation
|
|
3026
3026
|
},
|
|
3027
3027
|
nil?: true
|
|
3028
3028
|
|
|
3029
3029
|
# @!attribute status
|
|
3030
3030
|
# Current author status
|
|
3031
3031
|
#
|
|
3032
|
-
# @return [Symbol, ModerationAPI::Models::WebhookEvent::
|
|
3032
|
+
# @return [Symbol, ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Author::Status]
|
|
3033
3033
|
required :status,
|
|
3034
|
-
enum: -> { ModerationAPI::WebhookEvent::
|
|
3034
|
+
enum: -> { ModerationAPI::WebhookEvent::QueueItemResolved::Data::Object::Author::Status }
|
|
3035
3035
|
|
|
3036
3036
|
# @!attribute trust_level
|
|
3037
3037
|
#
|
|
3038
|
-
# @return [ModerationAPI::Models::WebhookEvent::
|
|
3038
|
+
# @return [ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Author::TrustLevel]
|
|
3039
3039
|
required :trust_level,
|
|
3040
|
-
-> { ModerationAPI::WebhookEvent::
|
|
3040
|
+
-> { ModerationAPI::WebhookEvent::QueueItemResolved::Data::Object::Author::TrustLevel }
|
|
3041
3041
|
|
|
3042
3042
|
# @!attribute company
|
|
3043
3043
|
# The author's company or organization
|
|
@@ -3083,26 +3083,26 @@ module ModerationAPI
|
|
|
3083
3083
|
|
|
3084
3084
|
# @!method initialize(id:, block:, first_seen:, last_seen:, metadata:, metrics:, risk_evaluation:, status:, trust_level:, company: nil, email: nil, external_id: nil, external_link: nil, last_incident: nil, name: nil, profile_picture: nil)
|
|
3085
3085
|
# Some parameter documentations has been truncated, see
|
|
3086
|
-
# {ModerationAPI::Models::WebhookEvent::
|
|
3086
|
+
# {ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Author}
|
|
3087
3087
|
# for more details.
|
|
3088
3088
|
#
|
|
3089
3089
|
# @param id [String] Author ID in Moderation API
|
|
3090
3090
|
#
|
|
3091
|
-
# @param block [ModerationAPI::Models::WebhookEvent::
|
|
3091
|
+
# @param block [ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Author::Block, nil] Block or suspension details, if applicable. Null if the author is enabled.
|
|
3092
3092
|
#
|
|
3093
3093
|
# @param first_seen [Float] Timestamp when author first appeared
|
|
3094
3094
|
#
|
|
3095
3095
|
# @param last_seen [Float] Timestamp of last activity
|
|
3096
3096
|
#
|
|
3097
|
-
# @param metadata [ModerationAPI::Models::WebhookEvent::
|
|
3097
|
+
# @param metadata [ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Author::Metadata] Additional metadata provided by your system. We recommend including any relevant
|
|
3098
3098
|
#
|
|
3099
|
-
# @param metrics [ModerationAPI::Models::WebhookEvent::
|
|
3099
|
+
# @param metrics [ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Author::Metrics]
|
|
3100
3100
|
#
|
|
3101
|
-
# @param risk_evaluation [ModerationAPI::Models::WebhookEvent::
|
|
3101
|
+
# @param risk_evaluation [ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Author::RiskEvaluation, nil] Risk assessment details, if available.
|
|
3102
3102
|
#
|
|
3103
|
-
# @param status [Symbol, ModerationAPI::Models::WebhookEvent::
|
|
3103
|
+
# @param status [Symbol, ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Author::Status] Current author status
|
|
3104
3104
|
#
|
|
3105
|
-
# @param trust_level [ModerationAPI::Models::WebhookEvent::
|
|
3105
|
+
# @param trust_level [ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Author::TrustLevel]
|
|
3106
3106
|
#
|
|
3107
3107
|
# @param company [String, nil] The author's company or organization
|
|
3108
3108
|
#
|
|
@@ -3118,7 +3118,7 @@ module ModerationAPI
|
|
|
3118
3118
|
#
|
|
3119
3119
|
# @param profile_picture [String, nil] URL of the author's profile picture
|
|
3120
3120
|
|
|
3121
|
-
# @see ModerationAPI::Models::WebhookEvent::
|
|
3121
|
+
# @see ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Author#block
|
|
3122
3122
|
class Block < ModerationAPI::Internal::Type::BaseModel
|
|
3123
3123
|
# @!attribute reason
|
|
3124
3124
|
# The moderators reason why the author was blocked or suspended.
|
|
@@ -3140,7 +3140,7 @@ module ModerationAPI
|
|
|
3140
3140
|
# @param until_ [Float, nil] The timestamp until which they are blocked if the author is suspended.
|
|
3141
3141
|
end
|
|
3142
3142
|
|
|
3143
|
-
# @see ModerationAPI::Models::WebhookEvent::
|
|
3143
|
+
# @see ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Author#metadata
|
|
3144
3144
|
class Metadata < ModerationAPI::Internal::Type::BaseModel
|
|
3145
3145
|
# @!attribute email_verified
|
|
3146
3146
|
# Whether the author's email is verified
|
|
@@ -3179,7 +3179,7 @@ module ModerationAPI
|
|
|
3179
3179
|
# @param phone_verified [Boolean, nil] Whether the author's phone number is verified
|
|
3180
3180
|
end
|
|
3181
3181
|
|
|
3182
|
-
# @see ModerationAPI::Models::WebhookEvent::
|
|
3182
|
+
# @see ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Author#metrics
|
|
3183
3183
|
class Metrics < ModerationAPI::Internal::Type::BaseModel
|
|
3184
3184
|
# @!attribute flagged_content
|
|
3185
3185
|
# Number of flagged content pieces
|
|
@@ -3202,7 +3202,7 @@ module ModerationAPI
|
|
|
3202
3202
|
|
|
3203
3203
|
# @!method initialize(flagged_content:, total_content:, average_sentiment: nil)
|
|
3204
3204
|
# Some parameter documentations has been truncated, see
|
|
3205
|
-
# {ModerationAPI::Models::WebhookEvent::
|
|
3205
|
+
# {ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Author::Metrics}
|
|
3206
3206
|
# for more details.
|
|
3207
3207
|
#
|
|
3208
3208
|
# @param flagged_content [Float] Number of flagged content pieces
|
|
@@ -3212,7 +3212,7 @@ module ModerationAPI
|
|
|
3212
3212
|
# @param average_sentiment [Float, nil] Average sentiment score of content (-1 to 1). Requires a sentiment model in your
|
|
3213
3213
|
end
|
|
3214
3214
|
|
|
3215
|
-
# @see ModerationAPI::Models::WebhookEvent::
|
|
3215
|
+
# @see ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Author#risk_evaluation
|
|
3216
3216
|
class RiskEvaluation < ModerationAPI::Internal::Type::BaseModel
|
|
3217
3217
|
# @!attribute risk_level
|
|
3218
3218
|
# Calculated risk level based on more than 10 behavioral signals.
|
|
@@ -3228,7 +3228,7 @@ module ModerationAPI
|
|
|
3228
3228
|
|
|
3229
3229
|
# Current author status
|
|
3230
3230
|
#
|
|
3231
|
-
# @see ModerationAPI::Models::WebhookEvent::
|
|
3231
|
+
# @see ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Author#status
|
|
3232
3232
|
module Status
|
|
3233
3233
|
extend ModerationAPI::Internal::Type::Enum
|
|
3234
3234
|
|
|
@@ -3240,7 +3240,7 @@ module ModerationAPI
|
|
|
3240
3240
|
# @return [Array<Symbol>]
|
|
3241
3241
|
end
|
|
3242
3242
|
|
|
3243
|
-
# @see ModerationAPI::Models::WebhookEvent::
|
|
3243
|
+
# @see ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object::Author#trust_level
|
|
3244
3244
|
class TrustLevel < ModerationAPI::Internal::Type::BaseModel
|
|
3245
3245
|
# @!attribute level
|
|
3246
3246
|
# Author trust level (-1, 0, 1, 2, 3, or 4)
|
|
@@ -3261,7 +3261,7 @@ module ModerationAPI
|
|
|
3261
3261
|
end
|
|
3262
3262
|
end
|
|
3263
3263
|
|
|
3264
|
-
# @see ModerationAPI::Models::WebhookEvent::
|
|
3264
|
+
# @see ModerationAPI::Models::WebhookEvent::QueueItemResolved::Data::Object#queue
|
|
3265
3265
|
class Queue < ModerationAPI::Internal::Type::BaseModel
|
|
3266
3266
|
# @!attribute id
|
|
3267
3267
|
#
|
|
@@ -6225,7 +6225,7 @@ module ModerationAPI
|
|
|
6225
6225
|
end
|
|
6226
6226
|
|
|
6227
6227
|
# @!method self.variants
|
|
6228
|
-
# @return [Array(ModerationAPI::Models::WebhookEvent::AuthorBlocked, ModerationAPI::Models::WebhookEvent::AuthorUnblocked, ModerationAPI::Models::WebhookEvent::AuthorSuspended, ModerationAPI::Models::WebhookEvent::AuthorUpdated, ModerationAPI::Models::WebhookEvent::AuthorTrustLevelChanged, ModerationAPI::Models::WebhookEvent::AuthorAction, ModerationAPI::Models::WebhookEvent::
|
|
6228
|
+
# @return [Array(ModerationAPI::Models::WebhookEvent::AuthorBlocked, ModerationAPI::Models::WebhookEvent::AuthorUnblocked, ModerationAPI::Models::WebhookEvent::AuthorSuspended, ModerationAPI::Models::WebhookEvent::AuthorUpdated, ModerationAPI::Models::WebhookEvent::AuthorTrustLevelChanged, ModerationAPI::Models::WebhookEvent::AuthorAction, ModerationAPI::Models::WebhookEvent::QueueItemResolved, ModerationAPI::Models::WebhookEvent::QueueItemAction, ModerationAPI::Models::WebhookEvent::QueueItemRejected, ModerationAPI::Models::WebhookEvent::QueueItemAllowed)]
|
|
6229
6229
|
end
|
|
6230
6230
|
end
|
|
6231
6231
|
end
|