safetykit 0.30.0 → 0.31.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (30) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +8 -0
  3. data/README.md +1 -1
  4. data/lib/safety_kit/client.rb +6 -0
  5. data/lib/safety_kit/models/async_create_async_params.rb +4968 -0
  6. data/lib/safety_kit/models/async_create_async_response.rb +39 -0
  7. data/lib/safety_kit/models.rb +2 -0
  8. data/lib/safety_kit/resources/async.rb +44 -0
  9. data/lib/safety_kit/resources/beta/events.rb +0 -28
  10. data/lib/safety_kit/version.rb +1 -1
  11. data/lib/safety_kit.rb +3 -2
  12. data/rbi/safety_kit/client.rbi +5 -0
  13. data/rbi/safety_kit/models/async_create_async_params.rbi +10349 -0
  14. data/rbi/safety_kit/models/async_create_async_response.rbi +81 -0
  15. data/rbi/safety_kit/models.rbi +2 -0
  16. data/rbi/safety_kit/resources/async.rbi +53 -0
  17. data/rbi/safety_kit/resources/beta/events.rbi +0 -39
  18. data/sig/safety_kit/client.rbs +2 -0
  19. data/sig/safety_kit/models/async_create_async_params.rbs +3892 -0
  20. data/sig/safety_kit/models/async_create_async_response.rbs +35 -0
  21. data/sig/safety_kit/models.rbs +2 -0
  22. data/sig/safety_kit/resources/async.rbs +12 -0
  23. data/sig/safety_kit/resources/beta/events.rbs +0 -5
  24. metadata +11 -8
  25. data/lib/safety_kit/models/beta/event_create_async_params.rb +0 -4981
  26. data/lib/safety_kit/models/beta/event_create_async_response.rb +0 -41
  27. data/rbi/safety_kit/models/beta/event_create_async_params.rbi +0 -10356
  28. data/rbi/safety_kit/models/beta/event_create_async_response.rbi +0 -87
  29. data/sig/safety_kit/models/beta/event_create_async_params.rbs +0 -3897
  30. data/sig/safety_kit/models/beta/event_create_async_response.rbs +0 -37
@@ -0,0 +1,39 @@
1
+ # frozen_string_literal: true
2
+
3
+ module SafetyKit
4
+ module Models
5
+ # @see SafetyKit::Resources::Async#create_async
6
+ class AsyncCreateAsyncResponse < SafetyKit::Internal::Type::BaseModel
7
+ # @!attribute queued_events
8
+ # Number of events queued from the request.
9
+ #
10
+ # @return [Integer]
11
+ required :queued_events, Integer
12
+
13
+ # @!attribute status
14
+ # Events were queued for asynchronous ingestion.
15
+ #
16
+ # @return [Symbol, SafetyKit::Models::AsyncCreateAsyncResponse::Status]
17
+ required :status, enum: -> { SafetyKit::Models::AsyncCreateAsyncResponse::Status }
18
+
19
+ # @!method initialize(queued_events:, status:)
20
+ # Response returned after SafetyKit queues one event or an ordered event batch.
21
+ #
22
+ # @param queued_events [Integer] Number of events queued from the request.
23
+ #
24
+ # @param status [Symbol, SafetyKit::Models::AsyncCreateAsyncResponse::Status] Events were queued for asynchronous ingestion.
25
+
26
+ # Events were queued for asynchronous ingestion.
27
+ #
28
+ # @see SafetyKit::Models::AsyncCreateAsyncResponse#status
29
+ module Status
30
+ extend SafetyKit::Internal::Type::Enum
31
+
32
+ QUEUED = :queued
33
+
34
+ # @!method self.values
35
+ # @return [Array<Symbol>]
36
+ end
37
+ end
38
+ end
39
+ end
@@ -41,6 +41,8 @@ module SafetyKit
41
41
 
42
42
  AgentDecisionCreateAgentDecisionParams = SafetyKit::Models::AgentDecisionCreateAgentDecisionParams
43
43
 
44
+ AsyncCreateAsyncParams = SafetyKit::Models::AsyncCreateAsyncParams
45
+
44
46
  Beta = SafetyKit::Models::Beta
45
47
 
46
48
  ClientSessionCreateSessionParams = SafetyKit::Models::ClientSessionCreateSessionParams
@@ -0,0 +1,44 @@
1
+ # frozen_string_literal: true
2
+
3
+ module SafetyKit
4
+ module Resources
5
+ # Beta. Send backend events for account, content, user interaction, report, and
6
+ # moderation activity.
7
+ class Async
8
+ # Some parameter documentations has been truncated, see
9
+ # {SafetyKit::Models::AsyncCreateAsyncParams} for more details.
10
+ #
11
+ # Beta. Queue backend events for asynchronous ingestion. This endpoint accepts the
12
+ # same request body as POST /v1/events, writes one SQS message per event, and
13
+ # returns after the events are queued. SafetyKit later processes the queued events
14
+ # through the standard event ingestion path.
15
+ #
16
+ # @overload create_async(body:, request_options: {})
17
+ #
18
+ # @param body [SafetyKit::Models::AsyncCreateAsyncParams::Body::UserContactEventRequest, SafetyKit::Models::AsyncCreateAsyncParams::Body::ContentUploadedEventRequest, SafetyKit::Models::AsyncCreateAsyncParams::Body::ProductChangedEventRequest, SafetyKit::Models::AsyncCreateAsyncParams::Body::CreateAccountEventRequest, SafetyKit::Models::AsyncCreateAsyncParams::Body::UpdateAccountEventRequest, SafetyKit::Models::AsyncCreateAsyncParams::Body::UserReportEventRequest, SafetyKit::Models::AsyncCreateAsyncParams::Body::ModerationDecisionEventRequest, Array<SafetyKit::Models::AsyncCreateAsyncParams::Body::UnionMember7::UserContact, SafetyKit::Models::AsyncCreateAsyncParams::Body::UnionMember7::ContentUploaded, SafetyKit::Models::AsyncCreateAsyncParams::Body::UnionMember7::ProductChanged, SafetyKit::Models::AsyncCreateAsyncParams::Body::UnionMember7::CreateAccount, SafetyKit::Models::AsyncCreateAsyncParams::Body::UnionMember7::UpdateAccount, SafetyKit::Models::AsyncCreateAsyncParams::Body::UnionMember7::UserReport, SafetyKit::Models::AsyncCreateAsyncParams::Body::UnionMember7::ModerationDecision>] Backend event or ordered batch of events to send to SafetyKit. Send events from
19
+ #
20
+ # @param request_options [SafetyKit::RequestOptions, Hash{Symbol=>Object}, nil]
21
+ #
22
+ # @return [SafetyKit::Models::AsyncCreateAsyncResponse]
23
+ #
24
+ # @see SafetyKit::Models::AsyncCreateAsyncParams
25
+ def create_async(params)
26
+ parsed, options = SafetyKit::AsyncCreateAsyncParams.dump_request(params)
27
+ @client.request(
28
+ method: :post,
29
+ path: "v1/async/events",
30
+ body: parsed[:body],
31
+ model: SafetyKit::Models::AsyncCreateAsyncResponse,
32
+ options: options
33
+ )
34
+ end
35
+
36
+ # @api private
37
+ #
38
+ # @param client [SafetyKit::Client]
39
+ def initialize(client:)
40
+ @client = client
41
+ end
42
+ end
43
+ end
44
+ end
@@ -35,34 +35,6 @@ module SafetyKit
35
35
  )
36
36
  end
37
37
 
38
- # Some parameter documentations has been truncated, see
39
- # {SafetyKit::Models::Beta::EventCreateAsyncParams} for more details.
40
- #
41
- # Beta. Queue backend events for asynchronous ingestion. This endpoint accepts the
42
- # same request body as POST /v1/events, writes one SQS message per event, and
43
- # returns after the events are queued. SafetyKit later processes the queued events
44
- # through the standard event ingestion path.
45
- #
46
- # @overload create_async(body:, request_options: {})
47
- #
48
- # @param body [SafetyKit::Models::Beta::EventCreateAsyncParams::Body::UserContactEventRequest, SafetyKit::Models::Beta::EventCreateAsyncParams::Body::ContentUploadedEventRequest, SafetyKit::Models::Beta::EventCreateAsyncParams::Body::ProductChangedEventRequest, SafetyKit::Models::Beta::EventCreateAsyncParams::Body::CreateAccountEventRequest, SafetyKit::Models::Beta::EventCreateAsyncParams::Body::UpdateAccountEventRequest, SafetyKit::Models::Beta::EventCreateAsyncParams::Body::UserReportEventRequest, SafetyKit::Models::Beta::EventCreateAsyncParams::Body::ModerationDecisionEventRequest, Array<SafetyKit::Models::Beta::EventCreateAsyncParams::Body::UnionMember7::UserContact, SafetyKit::Models::Beta::EventCreateAsyncParams::Body::UnionMember7::ContentUploaded, SafetyKit::Models::Beta::EventCreateAsyncParams::Body::UnionMember7::ProductChanged, SafetyKit::Models::Beta::EventCreateAsyncParams::Body::UnionMember7::CreateAccount, SafetyKit::Models::Beta::EventCreateAsyncParams::Body::UnionMember7::UpdateAccount, SafetyKit::Models::Beta::EventCreateAsyncParams::Body::UnionMember7::UserReport, SafetyKit::Models::Beta::EventCreateAsyncParams::Body::UnionMember7::ModerationDecision>] Backend event or ordered batch of events to send to SafetyKit. Send events from
49
- #
50
- # @param request_options [SafetyKit::RequestOptions, Hash{Symbol=>Object}, nil]
51
- #
52
- # @return [SafetyKit::Models::Beta::EventCreateAsyncResponse]
53
- #
54
- # @see SafetyKit::Models::Beta::EventCreateAsyncParams
55
- def create_async(params)
56
- parsed, options = SafetyKit::Beta::EventCreateAsyncParams.dump_request(params)
57
- @client.request(
58
- method: :post,
59
- path: "v1/events/async",
60
- body: parsed[:body],
61
- model: SafetyKit::Models::Beta::EventCreateAsyncResponse,
62
- options: options
63
- )
64
- end
65
-
66
38
  # @api private
67
39
  #
68
40
  # @param client [SafetyKit::Client]
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module SafetyKit
4
- VERSION = "0.30.0"
4
+ VERSION = "0.31.0"
5
5
  end
data/lib/safety_kit.rb CHANGED
@@ -54,8 +54,8 @@ require_relative "safety_kit/internal/transport/pooled_net_requester"
54
54
  require_relative "safety_kit/client"
55
55
  require_relative "safety_kit/models/agent_decision_create_agent_decision_params"
56
56
  require_relative "safety_kit/models/agent_decision_create_agent_decision_response"
57
- require_relative "safety_kit/models/beta/event_create_async_params"
58
- require_relative "safety_kit/models/beta/event_create_async_response"
57
+ require_relative "safety_kit/models/async_create_async_params"
58
+ require_relative "safety_kit/models/async_create_async_response"
59
59
  require_relative "safety_kit/models/beta/event_create_params"
60
60
  require_relative "safety_kit/models/beta/event_create_response"
61
61
  require_relative "safety_kit/models/client_session_create_session_params"
@@ -79,6 +79,7 @@ require_relative "safety_kit/models/stream_add_transcript_params"
79
79
  require_relative "safety_kit/models/stream_add_transcript_response"
80
80
  require_relative "safety_kit/models"
81
81
  require_relative "safety_kit/resources/agent_decisions"
82
+ require_relative "safety_kit/resources/async"
82
83
  require_relative "safety_kit/resources/beta"
83
84
  require_relative "safety_kit/resources/beta/events"
84
85
  require_relative "safety_kit/resources/client_sessions"
@@ -27,6 +27,11 @@ module SafetyKit
27
27
  sig { returns(SafetyKit::Resources::AgentDecisions) }
28
28
  attr_reader :agent_decisions
29
29
 
30
+ # Beta. Send backend events for account, content, user interaction, report, and
31
+ # moderation activity.
32
+ sig { returns(SafetyKit::Resources::Async) }
33
+ attr_reader :async
34
+
30
35
  # Beta. Create browser-safe Webapp SDK session tokens from authenticated
31
36
  # server-side code.
32
37
  sig { returns(SafetyKit::Resources::ClientSessions) }