safetykit 0.6.0 → 0.8.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 (19) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +16 -0
  3. data/README.md +1 -1
  4. data/lib/safety_kit/client.rb +7 -0
  5. data/lib/safety_kit/internal/type/union.rb +11 -0
  6. data/lib/safety_kit/models/beta/event_create_params.rb +1519 -170
  7. data/lib/safety_kit/models/beta/event_create_response.rb +72 -30
  8. data/lib/safety_kit/resources/beta/events.rb +2 -2
  9. data/lib/safety_kit/resources/client_sessions.rb +2 -1
  10. data/lib/safety_kit/version.rb +1 -1
  11. data/rbi/safety_kit/client.rbi +5 -0
  12. data/rbi/safety_kit/models/beta/event_create_params.rbi +3142 -267
  13. data/rbi/safety_kit/models/beta/event_create_response.rbi +151 -52
  14. data/rbi/safety_kit/resources/beta/events.rbi +16 -8
  15. data/sig/safety_kit/client.rbs +2 -0
  16. data/sig/safety_kit/models/beta/event_create_params.rbs +1302 -198
  17. data/sig/safety_kit/models/beta/event_create_response.rbs +62 -20
  18. data/sig/safety_kit/resources/beta/events.rbs +1 -1
  19. metadata +1 -1
data/rbi/safety_kit/models/beta/event_create_response.rbi CHANGED
@@ -3,84 +3,183 @@
3
3
  module SafetyKit
4
4
  module Models
5
5
  module Beta
6
- class EventCreateResponse < SafetyKit::Internal::Type::BaseModel
7
- OrHash =
6
+ # Response returned after SafetyKit accepts one event or an ordered event batch.
7
+ module EventCreateResponse
8
+ extend SafetyKit::Internal::Type::Union
9
+
10
+ Variants =
8
11
  T.type_alias do
9
12
  T.any(
10
- SafetyKit::Models::Beta::EventCreateResponse,
11
- SafetyKit::Internal::AnyHash
13
+ SafetyKit::Models::Beta::EventCreateResponse::UnionMember0,
14
+ SafetyKit::Models::Beta::EventCreateResponse::UnionMember1
12
15
  )
13
16
  end
14
17
 
15
- # SafetyKit identifier for the event.
16
- sig { returns(String) }
17
- attr_accessor :event_id
18
-
19
- # Event was accepted.
20
- sig do
21
- returns(
22
- SafetyKit::Models::Beta::EventCreateResponse::Status::TaggedSymbol
23
- )
24
- end
25
- attr_accessor :status
18
+ class UnionMember0 < SafetyKit::Internal::Type::BaseModel
19
+ OrHash =
20
+ T.type_alias do
21
+ T.any(
22
+ SafetyKit::Models::Beta::EventCreateResponse::UnionMember0,
23
+ SafetyKit::Internal::AnyHash
24
+ )
25
+ end
26
26
 
27
- # Response returned after SafetyKit accepts an event.
28
- sig do
29
- params(
30
- event_id: String,
31
- status:
32
- SafetyKit::Models::Beta::EventCreateResponse::Status::OrSymbol
33
- ).returns(T.attached_class)
34
- end
35
- def self.new(
36
27
  # SafetyKit identifier for the event.
37
- event_id:,
28
+ sig { returns(String) }
29
+ attr_accessor :event_id
30
+
38
31
  # Event was accepted.
39
- status:
40
- )
41
- end
32
+ sig do
33
+ returns(
34
+ SafetyKit::Models::Beta::EventCreateResponse::UnionMember0::Status::TaggedSymbol
35
+ )
36
+ end
37
+ attr_accessor :status
42
38
 
43
- sig do
44
- override.returns(
45
- {
39
+ sig do
40
+ params(
46
41
  event_id: String,
47
42
  status:
48
- SafetyKit::Models::Beta::EventCreateResponse::Status::TaggedSymbol
49
- }
43
+ SafetyKit::Models::Beta::EventCreateResponse::UnionMember0::Status::OrSymbol
44
+ ).returns(T.attached_class)
45
+ end
46
+ def self.new(
47
+ # SafetyKit identifier for the event.
48
+ event_id:,
49
+ # Event was accepted.
50
+ status:
50
51
  )
51
- end
52
- def to_hash
53
- end
52
+ end
53
+
54
+ sig do
55
+ override.returns(
56
+ {
57
+ event_id: String,
58
+ status:
59
+ SafetyKit::Models::Beta::EventCreateResponse::UnionMember0::Status::TaggedSymbol
60
+ }
61
+ )
62
+ end
63
+ def to_hash
64
+ end
65
+
66
+ # Event was accepted.
67
+ module Status
68
+ extend SafetyKit::Internal::Type::Enum
54
69
 
55
- # Event was accepted.
56
- module Status
57
- extend SafetyKit::Internal::Type::Enum
70
+ TaggedSymbol =
71
+ T.type_alias do
72
+ T.all(
73
+ Symbol,
74
+ SafetyKit::Models::Beta::EventCreateResponse::UnionMember0::Status
75
+ )
76
+ end
77
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
58
78
 
59
- TaggedSymbol =
79
+ OK =
80
+ T.let(
81
+ :ok,
82
+ SafetyKit::Models::Beta::EventCreateResponse::UnionMember0::Status::TaggedSymbol
83
+ )
84
+
85
+ sig do
86
+ override.returns(
87
+ T::Array[
88
+ SafetyKit::Models::Beta::EventCreateResponse::UnionMember0::Status::TaggedSymbol
89
+ ]
90
+ )
91
+ end
92
+ def self.values
93
+ end
94
+ end
95
+ end
96
+
97
+ class UnionMember1 < SafetyKit::Internal::Type::BaseModel
98
+ OrHash =
60
99
  T.type_alias do
61
- T.all(
62
- Symbol,
63
- SafetyKit::Models::Beta::EventCreateResponse::Status
100
+ T.any(
101
+ SafetyKit::Models::Beta::EventCreateResponse::UnionMember1,
102
+ SafetyKit::Internal::AnyHash
64
103
  )
65
104
  end
66
- OrSymbol = T.type_alias { T.any(Symbol, String) }
67
105
 
68
- OK =
69
- T.let(
70
- :ok,
71
- SafetyKit::Models::Beta::EventCreateResponse::Status::TaggedSymbol
106
+ # SafetyKit identifiers for the accepted events, in request order.
107
+ sig { returns(T::Array[String]) }
108
+ attr_accessor :event_ids
109
+
110
+ # Events were accepted.
111
+ sig do
112
+ returns(
113
+ SafetyKit::Models::Beta::EventCreateResponse::UnionMember1::Status::TaggedSymbol
72
114
  )
115
+ end
116
+ attr_accessor :status
117
+
118
+ sig do
119
+ params(
120
+ event_ids: T::Array[String],
121
+ status:
122
+ SafetyKit::Models::Beta::EventCreateResponse::UnionMember1::Status::OrSymbol
123
+ ).returns(T.attached_class)
124
+ end
125
+ def self.new(
126
+ # SafetyKit identifiers for the accepted events, in request order.
127
+ event_ids:,
128
+ # Events were accepted.
129
+ status:
130
+ )
131
+ end
73
132
 
74
133
  sig do
75
134
  override.returns(
76
- T::Array[
77
- SafetyKit::Models::Beta::EventCreateResponse::Status::TaggedSymbol
78
- ]
135
+ {
136
+ event_ids: T::Array[String],
137
+ status:
138
+ SafetyKit::Models::Beta::EventCreateResponse::UnionMember1::Status::TaggedSymbol
139
+ }
79
140
  )
80
141
  end
81
- def self.values
142
+ def to_hash
143
+ end
144
+
145
+ # Events were accepted.
146
+ module Status
147
+ extend SafetyKit::Internal::Type::Enum
148
+
149
+ TaggedSymbol =
150
+ T.type_alias do
151
+ T.all(
152
+ Symbol,
153
+ SafetyKit::Models::Beta::EventCreateResponse::UnionMember1::Status
154
+ )
155
+ end
156
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
157
+
158
+ OK =
159
+ T.let(
160
+ :ok,
161
+ SafetyKit::Models::Beta::EventCreateResponse::UnionMember1::Status::TaggedSymbol
162
+ )
163
+
164
+ sig do
165
+ override.returns(
166
+ T::Array[
167
+ SafetyKit::Models::Beta::EventCreateResponse::UnionMember1::Status::TaggedSymbol
168
+ ]
169
+ )
170
+ end
171
+ def self.values
172
+ end
82
173
  end
83
174
  end
175
+
176
+ sig do
177
+ override.returns(
178
+ T::Array[SafetyKit::Models::Beta::EventCreateResponse::Variants]
179
+ )
180
+ end
181
+ def self.variants
182
+ end
84
183
  end
85
184
  end
86
185
  end
data/rbi/safety_kit/resources/beta/events.rbi CHANGED
@@ -13,18 +13,26 @@ module SafetyKit
13
13
  params(
14
14
  body:
15
15
  T.any(
16
- SafetyKit::Beta::EventCreateParams::Body::UserContact::OrHash,
17
- SafetyKit::Beta::EventCreateParams::Body::ContentUploaded::OrHash,
18
- SafetyKit::Beta::EventCreateParams::Body::CreateAccount::OrHash,
19
- SafetyKit::Beta::EventCreateParams::Body::UpdateAccount::OrHash
16
+ SafetyKit::Beta::EventCreateParams::Body::UserContactEventRequest::OrHash,
17
+ SafetyKit::Beta::EventCreateParams::Body::ContentUploadedEventRequest::OrHash,
18
+ SafetyKit::Beta::EventCreateParams::Body::CreateAccountEventRequest::OrHash,
19
+ SafetyKit::Beta::EventCreateParams::Body::UpdateAccountEventRequest::OrHash,
20
+ T::Array[
21
+ T.any(
22
+ SafetyKit::Beta::EventCreateParams::Body::UnionMember4::UserContact::OrHash,
23
+ SafetyKit::Beta::EventCreateParams::Body::UnionMember4::ContentUploaded::OrHash,
24
+ SafetyKit::Beta::EventCreateParams::Body::UnionMember4::CreateAccount::OrHash,
25
+ SafetyKit::Beta::EventCreateParams::Body::UnionMember4::UpdateAccount::OrHash
26
+ )
27
+ ]
20
28
  ),
21
29
  request_options: SafetyKit::RequestOptions::OrHash
22
- ).returns(SafetyKit::Models::Beta::EventCreateResponse)
30
+ ).returns(SafetyKit::Models::Beta::EventCreateResponse::Variants)
23
31
  end
24
32
  def create(
25
- # Backend event to send to SafetyKit. Send events from your server after an action
26
- # has happened in your product. Do not send these events directly from a browser
27
- # or mobile client.
33
+ # Backend event or ordered batch of events to send to SafetyKit. Send events from
34
+ # your server after an action has happened in your product. Do not send these
35
+ # events directly from a browser or mobile client.
28
36
  body:,
29
37
  request_options: {}
30
38
  )
data/sig/safety_kit/client.rbs CHANGED
@@ -22,6 +22,8 @@ module SafetyKit
22
22
 
23
23
  private def auth_headers: -> ::Hash[String, String]
24
24
 
25
+ def base_url_overridden?: -> bool
26
+
25
27
  def initialize: (
26
28
  ?api_key: String?,
27
29
  ?base_url: String?,