safetykit 0.37.0 → 0.39.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.
@@ -1,513 +0,0 @@
1
- # typed: strong
2
-
3
- module SafetyKit
4
- module Models
5
- class DataUpdateSettingsParams < SafetyKit::Internal::Type::BaseModel
6
- extend SafetyKit::Internal::Type::RequestParameters::Converter
7
- include SafetyKit::Internal::Type::RequestParameters
8
-
9
- OrHash =
10
- T.type_alias do
11
- T.any(
12
- SafetyKit::DataUpdateSettingsParams,
13
- SafetyKit::Internal::AnyHash
14
- )
15
- end
16
-
17
- # The namespace to ingest data into
18
- sig { returns(String) }
19
- attr_accessor :namespace
20
-
21
- # Schema mapping field names to their definitions. Use content_type to specify
22
- # which fields contain URLs that should be processed (images, videos, or
23
- # websites), datetime fields, or 'metadata' for fields that should be stored but
24
- # not indexed. Use display_hint to provide UI rendering hints.
25
- sig do
26
- returns(T::Hash[Symbol, SafetyKit::DataUpdateSettingsParams::Schema])
27
- end
28
- attr_accessor :schema
29
-
30
- sig do
31
- params(
32
- namespace: String,
33
- schema:
34
- T::Hash[
35
- Symbol,
36
- SafetyKit::DataUpdateSettingsParams::Schema::OrHash
37
- ],
38
- request_options: SafetyKit::RequestOptions::OrHash
39
- ).returns(T.attached_class)
40
- end
41
- def self.new(
42
- # The namespace to ingest data into
43
- namespace:,
44
- # Schema mapping field names to their definitions. Use content_type to specify
45
- # which fields contain URLs that should be processed (images, videos, or
46
- # websites), datetime fields, or 'metadata' for fields that should be stored but
47
- # not indexed. Use display_hint to provide UI rendering hints.
48
- schema:,
49
- request_options: {}
50
- )
51
- end
52
-
53
- sig do
54
- override.returns(
55
- {
56
- namespace: String,
57
- schema:
58
- T::Hash[Symbol, SafetyKit::DataUpdateSettingsParams::Schema],
59
- request_options: SafetyKit::RequestOptions
60
- }
61
- )
62
- end
63
- def to_hash
64
- end
65
-
66
- class Schema < SafetyKit::Internal::Type::BaseModel
67
- OrHash =
68
- T.type_alias do
69
- T.any(
70
- SafetyKit::DataUpdateSettingsParams::Schema,
71
- SafetyKit::Internal::AnyHash
72
- )
73
- end
74
-
75
- # The parent object namespace this field belongs to, creating a parent-child
76
- # relationship with that namespace.
77
- sig { returns(T.nilable(String)) }
78
- attr_reader :belongs_to
79
-
80
- sig { params(belongs_to: String).void }
81
- attr_writer :belongs_to
82
-
83
- # The type of content (image_url, video_url, audio_url, website_url, datetime,
84
- # metadata, or card). When specified as a URL type, SafetyKit will process the
85
- # URL. Use 'metadata' for fields that should be stored but not indexed.
86
- sig do
87
- returns(
88
- T.nilable(
89
- SafetyKit::DataUpdateSettingsParams::Schema::ContentType::OrSymbol
90
- )
91
- )
92
- end
93
- attr_reader :content_type
94
-
95
- sig do
96
- params(
97
- content_type:
98
- SafetyKit::DataUpdateSettingsParams::Schema::ContentType::OrSymbol
99
- ).void
100
- end
101
- attr_writer :content_type
102
-
103
- # Display hint for UI rendering of this field
104
- sig do
105
- returns(
106
- T.nilable(SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint)
107
- )
108
- end
109
- attr_reader :display_hint
110
-
111
- sig do
112
- params(
113
- display_hint:
114
- SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint::OrHash
115
- ).void
116
- end
117
- attr_writer :display_hint
118
-
119
- # Maximum amount of this field to include when sending to AI models. For text
120
- # fields, this is the character limit. For array fields (e.g. image URLs), this is
121
- # the maximum number of items.
122
- sig { returns(T.nilable(Integer)) }
123
- attr_reader :field_limit
124
-
125
- sig { params(field_limit: Integer).void }
126
- attr_writer :field_limit
127
-
128
- # Optional parser to apply before indexing this field.
129
- sig do
130
- returns(
131
- T.nilable(
132
- SafetyKit::DataUpdateSettingsParams::Schema::IngestAs::OrSymbol
133
- )
134
- )
135
- end
136
- attr_reader :ingest_as
137
-
138
- sig do
139
- params(
140
- ingest_as:
141
- SafetyKit::DataUpdateSettingsParams::Schema::IngestAs::OrSymbol
142
- ).void
143
- end
144
- attr_writer :ingest_as
145
-
146
- # Schema definition for a data field
147
- sig do
148
- params(
149
- belongs_to: String,
150
- content_type:
151
- SafetyKit::DataUpdateSettingsParams::Schema::ContentType::OrSymbol,
152
- display_hint:
153
- SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint::OrHash,
154
- field_limit: Integer,
155
- ingest_as:
156
- SafetyKit::DataUpdateSettingsParams::Schema::IngestAs::OrSymbol
157
- ).returns(T.attached_class)
158
- end
159
- def self.new(
160
- # The parent object namespace this field belongs to, creating a parent-child
161
- # relationship with that namespace.
162
- belongs_to: nil,
163
- # The type of content (image_url, video_url, audio_url, website_url, datetime,
164
- # metadata, or card). When specified as a URL type, SafetyKit will process the
165
- # URL. Use 'metadata' for fields that should be stored but not indexed.
166
- content_type: nil,
167
- # Display hint for UI rendering of this field
168
- display_hint: nil,
169
- # Maximum amount of this field to include when sending to AI models. For text
170
- # fields, this is the character limit. For array fields (e.g. image URLs), this is
171
- # the maximum number of items.
172
- field_limit: nil,
173
- # Optional parser to apply before indexing this field.
174
- ingest_as: nil
175
- )
176
- end
177
-
178
- sig do
179
- override.returns(
180
- {
181
- belongs_to: String,
182
- content_type:
183
- SafetyKit::DataUpdateSettingsParams::Schema::ContentType::OrSymbol,
184
- display_hint:
185
- SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint,
186
- field_limit: Integer,
187
- ingest_as:
188
- SafetyKit::DataUpdateSettingsParams::Schema::IngestAs::OrSymbol
189
- }
190
- )
191
- end
192
- def to_hash
193
- end
194
-
195
- # The type of content (image_url, video_url, audio_url, website_url, datetime,
196
- # metadata, or card). When specified as a URL type, SafetyKit will process the
197
- # URL. Use 'metadata' for fields that should be stored but not indexed.
198
- module ContentType
199
- extend SafetyKit::Internal::Type::Enum
200
-
201
- TaggedSymbol =
202
- T.type_alias do
203
- T.all(
204
- Symbol,
205
- SafetyKit::DataUpdateSettingsParams::Schema::ContentType
206
- )
207
- end
208
- OrSymbol = T.type_alias { T.any(Symbol, String) }
209
-
210
- IMAGE_URL =
211
- T.let(
212
- :image_url,
213
- SafetyKit::DataUpdateSettingsParams::Schema::ContentType::TaggedSymbol
214
- )
215
- VIDEO_URL =
216
- T.let(
217
- :video_url,
218
- SafetyKit::DataUpdateSettingsParams::Schema::ContentType::TaggedSymbol
219
- )
220
- AUDIO_URL =
221
- T.let(
222
- :audio_url,
223
- SafetyKit::DataUpdateSettingsParams::Schema::ContentType::TaggedSymbol
224
- )
225
- WEBSITE_URL =
226
- T.let(
227
- :website_url,
228
- SafetyKit::DataUpdateSettingsParams::Schema::ContentType::TaggedSymbol
229
- )
230
- DATETIME =
231
- T.let(
232
- :datetime,
233
- SafetyKit::DataUpdateSettingsParams::Schema::ContentType::TaggedSymbol
234
- )
235
- METADATA =
236
- T.let(
237
- :metadata,
238
- SafetyKit::DataUpdateSettingsParams::Schema::ContentType::TaggedSymbol
239
- )
240
- CARD =
241
- T.let(
242
- :card,
243
- SafetyKit::DataUpdateSettingsParams::Schema::ContentType::TaggedSymbol
244
- )
245
-
246
- sig do
247
- override.returns(
248
- T::Array[
249
- SafetyKit::DataUpdateSettingsParams::Schema::ContentType::TaggedSymbol
250
- ]
251
- )
252
- end
253
- def self.values
254
- end
255
- end
256
-
257
- class DisplayHint < SafetyKit::Internal::Type::BaseModel
258
- OrHash =
259
- T.type_alias do
260
- T.any(
261
- SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint,
262
- SafetyKit::Internal::AnyHash
263
- )
264
- end
265
-
266
- # Hide this field from default UI display.
267
- sig { returns(T.nilable(T::Boolean)) }
268
- attr_reader :hidden
269
-
270
- sig { params(hidden: T::Boolean).void }
271
- attr_writer :hidden
272
-
273
- # Display label to show for this field in the UI
274
- sig { returns(T.nilable(String)) }
275
- attr_reader :name
276
-
277
- sig { params(name: String).void }
278
- attr_writer :name
279
-
280
- # The display hint type
281
- sig do
282
- returns(
283
- T.nilable(
284
- SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint::Type::OrSymbol
285
- )
286
- )
287
- end
288
- attr_reader :type
289
-
290
- sig do
291
- params(
292
- type:
293
- SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint::Type::OrSymbol
294
- ).void
295
- end
296
- attr_writer :type
297
-
298
- # Display hint for UI rendering of this field
299
- sig do
300
- params(
301
- hidden: T::Boolean,
302
- name: String,
303
- type:
304
- SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint::Type::OrSymbol
305
- ).returns(T.attached_class)
306
- end
307
- def self.new(
308
- # Hide this field from default UI display.
309
- hidden: nil,
310
- # Display label to show for this field in the UI
311
- name: nil,
312
- # The display hint type
313
- type: nil
314
- )
315
- end
316
-
317
- sig do
318
- override.returns(
319
- {
320
- hidden: T::Boolean,
321
- name: String,
322
- type:
323
- SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint::Type::OrSymbol
324
- }
325
- )
326
- end
327
- def to_hash
328
- end
329
-
330
- # The display hint type
331
- module Type
332
- extend SafetyKit::Internal::Type::Enum
333
-
334
- TaggedSymbol =
335
- T.type_alias do
336
- T.all(
337
- Symbol,
338
- SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint::Type
339
- )
340
- end
341
- OrSymbol = T.type_alias { T.any(Symbol, String) }
342
-
343
- TITLE =
344
- T.let(
345
- :title,
346
- SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint::Type::TaggedSymbol
347
- )
348
- SUBTITLE =
349
- T.let(
350
- :subtitle,
351
- SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint::Type::TaggedSymbol
352
- )
353
- CATEGORY =
354
- T.let(
355
- :category,
356
- SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint::Type::TaggedSymbol
357
- )
358
- IDENTIFIER =
359
- T.let(
360
- :identifier,
361
- SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint::Type::TaggedSymbol
362
- )
363
- CANONICAL_URL =
364
- T.let(
365
- :canonical_url,
366
- SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint::Type::TaggedSymbol
367
- )
368
- STATUS =
369
- T.let(
370
- :status,
371
- SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint::Type::TaggedSymbol
372
- )
373
- PRIMARY_TAG_SET =
374
- T.let(
375
- :primary_tag_set,
376
- SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint::Type::TaggedSymbol
377
- )
378
- TAG_SET =
379
- T.let(
380
- :tag_set,
381
- SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint::Type::TaggedSymbol
382
- )
383
- TIMESTAMP =
384
- T.let(
385
- :timestamp,
386
- SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint::Type::TaggedSymbol
387
- )
388
- RATING =
389
- T.let(
390
- :rating,
391
- SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint::Type::TaggedSymbol
392
- )
393
- SUMMARY =
394
- T.let(
395
- :summary,
396
- SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint::Type::TaggedSymbol
397
- )
398
- PROFILE_IMAGE =
399
- T.let(
400
- :profile_image,
401
- SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint::Type::TaggedSymbol
402
- )
403
- PRIMARY_IMAGE =
404
- T.let(
405
- :primary_image,
406
- SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint::Type::TaggedSymbol
407
- )
408
- IMAGE_SET =
409
- T.let(
410
- :image_set,
411
- SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint::Type::TaggedSymbol
412
- )
413
- VIDEO_SET =
414
- T.let(
415
- :video_set,
416
- SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint::Type::TaggedSymbol
417
- )
418
- AUDIO_SET =
419
- T.let(
420
- :audio_set,
421
- SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint::Type::TaggedSymbol
422
- )
423
- BODY =
424
- T.let(
425
- :body,
426
- SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint::Type::TaggedSymbol
427
- )
428
- THREAD =
429
- T.let(
430
- :thread,
431
- SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint::Type::TaggedSymbol
432
- )
433
- MESSAGE =
434
- T.let(
435
- :message,
436
- SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint::Type::TaggedSymbol
437
- )
438
- PROFILE =
439
- T.let(
440
- :profile,
441
- SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint::Type::TaggedSymbol
442
- )
443
- MONEY =
444
- T.let(
445
- :money,
446
- SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint::Type::TaggedSymbol
447
- )
448
- LOCATION =
449
- T.let(
450
- :location,
451
- SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint::Type::TaggedSymbol
452
- )
453
- ATTRIBUTE_GROUP =
454
- T.let(
455
- :attribute_group,
456
- SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint::Type::TaggedSymbol
457
- )
458
- ATTRIBUTE =
459
- T.let(
460
- :attribute,
461
- SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint::Type::TaggedSymbol
462
- )
463
-
464
- sig do
465
- override.returns(
466
- T::Array[
467
- SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint::Type::TaggedSymbol
468
- ]
469
- )
470
- end
471
- def self.values
472
- end
473
- end
474
- end
475
-
476
- # Optional parser to apply before indexing this field.
477
- module IngestAs
478
- extend SafetyKit::Internal::Type::Enum
479
-
480
- TaggedSymbol =
481
- T.type_alias do
482
- T.all(
483
- Symbol,
484
- SafetyKit::DataUpdateSettingsParams::Schema::IngestAs
485
- )
486
- end
487
- OrSymbol = T.type_alias { T.any(Symbol, String) }
488
-
489
- FLOAT =
490
- T.let(
491
- :float,
492
- SafetyKit::DataUpdateSettingsParams::Schema::IngestAs::TaggedSymbol
493
- )
494
- DATETIME =
495
- T.let(
496
- :datetime,
497
- SafetyKit::DataUpdateSettingsParams::Schema::IngestAs::TaggedSymbol
498
- )
499
-
500
- sig do
501
- override.returns(
502
- T::Array[
503
- SafetyKit::DataUpdateSettingsParams::Schema::IngestAs::TaggedSymbol
504
- ]
505
- )
506
- end
507
- def self.values
508
- end
509
- end
510
- end
511
- end
512
- end
513
- end
@@ -1,74 +0,0 @@
1
- # typed: strong
2
-
3
- module SafetyKit
4
- module Models
5
- class DataUpdateSettingsResponse < SafetyKit::Internal::Type::BaseModel
6
- OrHash =
7
- T.type_alias do
8
- T.any(
9
- SafetyKit::Models::DataUpdateSettingsResponse,
10
- SafetyKit::Internal::AnyHash
11
- )
12
- end
13
-
14
- sig { returns(String) }
15
- attr_accessor :namespace
16
-
17
- sig do
18
- returns(
19
- SafetyKit::Models::DataUpdateSettingsResponse::Status::TaggedSymbol
20
- )
21
- end
22
- attr_accessor :status
23
-
24
- # Namespace configuration was stored.
25
- sig do
26
- params(
27
- namespace: String,
28
- status:
29
- SafetyKit::Models::DataUpdateSettingsResponse::Status::OrSymbol
30
- ).returns(T.attached_class)
31
- end
32
- def self.new(namespace:, status:)
33
- end
34
-
35
- sig do
36
- override.returns(
37
- {
38
- namespace: String,
39
- status:
40
- SafetyKit::Models::DataUpdateSettingsResponse::Status::TaggedSymbol
41
- }
42
- )
43
- end
44
- def to_hash
45
- end
46
-
47
- module Status
48
- extend SafetyKit::Internal::Type::Enum
49
-
50
- TaggedSymbol =
51
- T.type_alias do
52
- T.all(Symbol, SafetyKit::Models::DataUpdateSettingsResponse::Status)
53
- end
54
- OrSymbol = T.type_alias { T.any(Symbol, String) }
55
-
56
- UPDATED =
57
- T.let(
58
- :updated,
59
- SafetyKit::Models::DataUpdateSettingsResponse::Status::TaggedSymbol
60
- )
61
-
62
- sig do
63
- override.returns(
64
- T::Array[
65
- SafetyKit::Models::DataUpdateSettingsResponse::Status::TaggedSymbol
66
- ]
67
- )
68
- end
69
- def self.values
70
- end
71
- end
72
- end
73
- end
74
- end