prelude-sdk 0.1.0.pre.alpha.2

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 (125) hide show
  1. checksums.yaml +7 -0
  2. data/.ignore +2 -0
  3. data/CHANGELOG.md +352 -0
  4. data/README.md +217 -0
  5. data/SECURITY.md +27 -0
  6. data/lib/prelude_sdk/client.rb +87 -0
  7. data/lib/prelude_sdk/errors.rb +214 -0
  8. data/lib/prelude_sdk/file_part.rb +55 -0
  9. data/lib/prelude_sdk/internal/transport/base_client.rb +555 -0
  10. data/lib/prelude_sdk/internal/transport/pooled_net_requester.rb +209 -0
  11. data/lib/prelude_sdk/internal/type/array_of.rb +167 -0
  12. data/lib/prelude_sdk/internal/type/base_model.rb +536 -0
  13. data/lib/prelude_sdk/internal/type/base_page.rb +55 -0
  14. data/lib/prelude_sdk/internal/type/boolean.rb +77 -0
  15. data/lib/prelude_sdk/internal/type/converter.rb +300 -0
  16. data/lib/prelude_sdk/internal/type/enum.rb +131 -0
  17. data/lib/prelude_sdk/internal/type/file_input.rb +108 -0
  18. data/lib/prelude_sdk/internal/type/hash_of.rb +187 -0
  19. data/lib/prelude_sdk/internal/type/request_parameters.rb +42 -0
  20. data/lib/prelude_sdk/internal/type/union.rb +235 -0
  21. data/lib/prelude_sdk/internal/type/unknown.rb +81 -0
  22. data/lib/prelude_sdk/internal/util.rb +914 -0
  23. data/lib/prelude_sdk/internal.rb +20 -0
  24. data/lib/prelude_sdk/models/lookup_lookup_params.rb +37 -0
  25. data/lib/prelude_sdk/models/lookup_lookup_response.rb +236 -0
  26. data/lib/prelude_sdk/models/transactional_send_params.rb +84 -0
  27. data/lib/prelude_sdk/models/transactional_send_response.rb +81 -0
  28. data/lib/prelude_sdk/models/verification_check_params.rb +69 -0
  29. data/lib/prelude_sdk/models/verification_check_response.rb +67 -0
  30. data/lib/prelude_sdk/models/verification_create_params.rb +388 -0
  31. data/lib/prelude_sdk/models/verification_create_response.rb +148 -0
  32. data/lib/prelude_sdk/models/watch_predict_params.rb +191 -0
  33. data/lib/prelude_sdk/models/watch_predict_response.rb +50 -0
  34. data/lib/prelude_sdk/models/watch_send_events_params.rb +100 -0
  35. data/lib/prelude_sdk/models/watch_send_events_response.rb +41 -0
  36. data/lib/prelude_sdk/models/watch_send_feedbacks_params.rb +229 -0
  37. data/lib/prelude_sdk/models/watch_send_feedbacks_response.rb +41 -0
  38. data/lib/prelude_sdk/models.rb +55 -0
  39. data/lib/prelude_sdk/request_options.rb +77 -0
  40. data/lib/prelude_sdk/resources/lookup.rb +42 -0
  41. data/lib/prelude_sdk/resources/transactional.rb +53 -0
  42. data/lib/prelude_sdk/resources/verification.rb +76 -0
  43. data/lib/prelude_sdk/resources/watch.rb +91 -0
  44. data/lib/prelude_sdk/version.rb +5 -0
  45. data/lib/prelude_sdk.rb +71 -0
  46. data/manifest.yaml +15 -0
  47. data/rbi/prelude_sdk/client.rbi +59 -0
  48. data/rbi/prelude_sdk/errors.rbi +178 -0
  49. data/rbi/prelude_sdk/file_part.rbi +37 -0
  50. data/rbi/prelude_sdk/internal/transport/base_client.rbi +296 -0
  51. data/rbi/prelude_sdk/internal/transport/pooled_net_requester.rbi +80 -0
  52. data/rbi/prelude_sdk/internal/type/array_of.rbi +104 -0
  53. data/rbi/prelude_sdk/internal/type/base_model.rbi +304 -0
  54. data/rbi/prelude_sdk/internal/type/base_page.rbi +42 -0
  55. data/rbi/prelude_sdk/internal/type/boolean.rbi +58 -0
  56. data/rbi/prelude_sdk/internal/type/converter.rbi +162 -0
  57. data/rbi/prelude_sdk/internal/type/enum.rbi +82 -0
  58. data/rbi/prelude_sdk/internal/type/file_input.rbi +59 -0
  59. data/rbi/prelude_sdk/internal/type/hash_of.rbi +104 -0
  60. data/rbi/prelude_sdk/internal/type/request_parameters.rbi +29 -0
  61. data/rbi/prelude_sdk/internal/type/union.rbi +121 -0
  62. data/rbi/prelude_sdk/internal/type/unknown.rbi +58 -0
  63. data/rbi/prelude_sdk/internal/util.rbi +487 -0
  64. data/rbi/prelude_sdk/internal.rbi +18 -0
  65. data/rbi/prelude_sdk/models/lookup_lookup_params.rbi +78 -0
  66. data/rbi/prelude_sdk/models/lookup_lookup_response.rbi +520 -0
  67. data/rbi/prelude_sdk/models/transactional_send_params.rbi +126 -0
  68. data/rbi/prelude_sdk/models/transactional_send_response.rbi +113 -0
  69. data/rbi/prelude_sdk/models/verification_check_params.rbi +140 -0
  70. data/rbi/prelude_sdk/models/verification_check_response.rbi +149 -0
  71. data/rbi/prelude_sdk/models/verification_create_params.rbi +805 -0
  72. data/rbi/prelude_sdk/models/verification_create_response.rbi +336 -0
  73. data/rbi/prelude_sdk/models/watch_predict_params.rbi +382 -0
  74. data/rbi/prelude_sdk/models/watch_predict_response.rbi +96 -0
  75. data/rbi/prelude_sdk/models/watch_send_events_params.rbi +245 -0
  76. data/rbi/prelude_sdk/models/watch_send_events_response.rbi +82 -0
  77. data/rbi/prelude_sdk/models/watch_send_feedbacks_params.rbi +500 -0
  78. data/rbi/prelude_sdk/models/watch_send_feedbacks_response.rbi +86 -0
  79. data/rbi/prelude_sdk/models.rbi +17 -0
  80. data/rbi/prelude_sdk/request_options.rbi +59 -0
  81. data/rbi/prelude_sdk/resources/lookup.rbi +33 -0
  82. data/rbi/prelude_sdk/resources/transactional.rbi +50 -0
  83. data/rbi/prelude_sdk/resources/verification.rbi +61 -0
  84. data/rbi/prelude_sdk/resources/watch.rbi +67 -0
  85. data/rbi/prelude_sdk/version.rbi +5 -0
  86. data/sig/prelude_sdk/client.rbs +32 -0
  87. data/sig/prelude_sdk/errors.rbs +110 -0
  88. data/sig/prelude_sdk/file_part.rbs +21 -0
  89. data/sig/prelude_sdk/internal/transport/base_client.rbs +131 -0
  90. data/sig/prelude_sdk/internal/transport/pooled_net_requester.rbs +45 -0
  91. data/sig/prelude_sdk/internal/type/array_of.rbs +48 -0
  92. data/sig/prelude_sdk/internal/type/base_model.rbs +102 -0
  93. data/sig/prelude_sdk/internal/type/base_page.rbs +24 -0
  94. data/sig/prelude_sdk/internal/type/boolean.rbs +26 -0
  95. data/sig/prelude_sdk/internal/type/converter.rbs +62 -0
  96. data/sig/prelude_sdk/internal/type/enum.rbs +32 -0
  97. data/sig/prelude_sdk/internal/type/file_input.rbs +25 -0
  98. data/sig/prelude_sdk/internal/type/hash_of.rbs +48 -0
  99. data/sig/prelude_sdk/internal/type/request_parameters.rbs +19 -0
  100. data/sig/prelude_sdk/internal/type/union.rbs +52 -0
  101. data/sig/prelude_sdk/internal/type/unknown.rbs +26 -0
  102. data/sig/prelude_sdk/internal/util.rbs +185 -0
  103. data/sig/prelude_sdk/internal.rbs +9 -0
  104. data/sig/prelude_sdk/models/lookup_lookup_params.rbs +38 -0
  105. data/sig/prelude_sdk/models/lookup_lookup_response.rbs +179 -0
  106. data/sig/prelude_sdk/models/transactional_send_params.rbs +73 -0
  107. data/sig/prelude_sdk/models/transactional_send_response.rbs +66 -0
  108. data/sig/prelude_sdk/models/verification_check_params.rbs +61 -0
  109. data/sig/prelude_sdk/models/verification_check_response.rbs +67 -0
  110. data/sig/prelude_sdk/models/verification_create_params.rbs +345 -0
  111. data/sig/prelude_sdk/models/verification_create_response.rbs +136 -0
  112. data/sig/prelude_sdk/models/watch_predict_params.rbs +180 -0
  113. data/sig/prelude_sdk/models/watch_predict_response.rbs +41 -0
  114. data/sig/prelude_sdk/models/watch_send_events_params.rbs +98 -0
  115. data/sig/prelude_sdk/models/watch_send_events_response.rbs +35 -0
  116. data/sig/prelude_sdk/models/watch_send_feedbacks_params.rbs +211 -0
  117. data/sig/prelude_sdk/models/watch_send_feedbacks_response.rbs +35 -0
  118. data/sig/prelude_sdk/models.rbs +15 -0
  119. data/sig/prelude_sdk/request_options.rbs +36 -0
  120. data/sig/prelude_sdk/resources/lookup.rbs +13 -0
  121. data/sig/prelude_sdk/resources/transactional.rbs +19 -0
  122. data/sig/prelude_sdk/resources/verification.rbs +22 -0
  123. data/sig/prelude_sdk/resources/watch.rbs +25 -0
  124. data/sig/prelude_sdk/version.rbs +3 -0
  125. metadata +182 -0
@@ -0,0 +1,96 @@
1
+ # typed: strong
2
+
3
+ module PreludeSDK
4
+ module Models
5
+ class WatchPredictResponse < PreludeSDK::Internal::Type::BaseModel
6
+ OrHash =
7
+ T.type_alias do
8
+ T.any(
9
+ PreludeSDK::Models::WatchPredictResponse,
10
+ PreludeSDK::Internal::AnyHash
11
+ )
12
+ end
13
+
14
+ # The prediction identifier.
15
+ sig { returns(String) }
16
+ attr_accessor :id
17
+
18
+ # The prediction outcome.
19
+ sig do
20
+ returns(
21
+ PreludeSDK::Models::WatchPredictResponse::Prediction::TaggedSymbol
22
+ )
23
+ end
24
+ attr_accessor :prediction
25
+
26
+ # A string that identifies this specific request. Report it back to us to help us
27
+ # diagnose your issues.
28
+ sig { returns(String) }
29
+ attr_accessor :request_id
30
+
31
+ sig do
32
+ params(
33
+ id: String,
34
+ prediction:
35
+ PreludeSDK::Models::WatchPredictResponse::Prediction::OrSymbol,
36
+ request_id: String
37
+ ).returns(T.attached_class)
38
+ end
39
+ def self.new(
40
+ # The prediction identifier.
41
+ id:,
42
+ # The prediction outcome.
43
+ prediction:,
44
+ # A string that identifies this specific request. Report it back to us to help us
45
+ # diagnose your issues.
46
+ request_id:
47
+ )
48
+ end
49
+
50
+ sig do
51
+ override.returns(
52
+ {
53
+ id: String,
54
+ prediction:
55
+ PreludeSDK::Models::WatchPredictResponse::Prediction::TaggedSymbol,
56
+ request_id: String
57
+ }
58
+ )
59
+ end
60
+ def to_hash
61
+ end
62
+
63
+ # The prediction outcome.
64
+ module Prediction
65
+ extend PreludeSDK::Internal::Type::Enum
66
+
67
+ TaggedSymbol =
68
+ T.type_alias do
69
+ T.all(Symbol, PreludeSDK::Models::WatchPredictResponse::Prediction)
70
+ end
71
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
72
+
73
+ LEGITIMATE =
74
+ T.let(
75
+ :legitimate,
76
+ PreludeSDK::Models::WatchPredictResponse::Prediction::TaggedSymbol
77
+ )
78
+ SUSPICIOUS =
79
+ T.let(
80
+ :suspicious,
81
+ PreludeSDK::Models::WatchPredictResponse::Prediction::TaggedSymbol
82
+ )
83
+
84
+ sig do
85
+ override.returns(
86
+ T::Array[
87
+ PreludeSDK::Models::WatchPredictResponse::Prediction::TaggedSymbol
88
+ ]
89
+ )
90
+ end
91
+ def self.values
92
+ end
93
+ end
94
+ end
95
+ end
96
+ end
@@ -0,0 +1,245 @@
1
+ # typed: strong
2
+
3
+ module PreludeSDK
4
+ module Models
5
+ class WatchSendEventsParams < PreludeSDK::Internal::Type::BaseModel
6
+ extend PreludeSDK::Internal::Type::RequestParameters::Converter
7
+ include PreludeSDK::Internal::Type::RequestParameters
8
+
9
+ OrHash =
10
+ T.type_alias do
11
+ T.any(
12
+ PreludeSDK::WatchSendEventsParams,
13
+ PreludeSDK::Internal::AnyHash
14
+ )
15
+ end
16
+
17
+ # A list of events to dispatch.
18
+ sig { returns(T::Array[PreludeSDK::WatchSendEventsParams::Event]) }
19
+ attr_accessor :events
20
+
21
+ sig do
22
+ params(
23
+ events: T::Array[PreludeSDK::WatchSendEventsParams::Event::OrHash],
24
+ request_options: PreludeSDK::RequestOptions::OrHash
25
+ ).returns(T.attached_class)
26
+ end
27
+ def self.new(
28
+ # A list of events to dispatch.
29
+ events:,
30
+ request_options: {}
31
+ )
32
+ end
33
+
34
+ sig do
35
+ override.returns(
36
+ {
37
+ events: T::Array[PreludeSDK::WatchSendEventsParams::Event],
38
+ request_options: PreludeSDK::RequestOptions
39
+ }
40
+ )
41
+ end
42
+ def to_hash
43
+ end
44
+
45
+ class Event < PreludeSDK::Internal::Type::BaseModel
46
+ OrHash =
47
+ T.type_alias do
48
+ T.any(
49
+ PreludeSDK::WatchSendEventsParams::Event,
50
+ PreludeSDK::Internal::AnyHash
51
+ )
52
+ end
53
+
54
+ # A confidence level you want to assign to the event.
55
+ sig do
56
+ returns(
57
+ PreludeSDK::WatchSendEventsParams::Event::Confidence::OrSymbol
58
+ )
59
+ end
60
+ attr_accessor :confidence
61
+
62
+ # A label to describe what the event refers to.
63
+ sig { returns(String) }
64
+ attr_accessor :label
65
+
66
+ # The event target. Only supports phone numbers for now.
67
+ sig { returns(PreludeSDK::WatchSendEventsParams::Event::Target) }
68
+ attr_reader :target
69
+
70
+ sig do
71
+ params(
72
+ target: PreludeSDK::WatchSendEventsParams::Event::Target::OrHash
73
+ ).void
74
+ end
75
+ attr_writer :target
76
+
77
+ sig do
78
+ params(
79
+ confidence:
80
+ PreludeSDK::WatchSendEventsParams::Event::Confidence::OrSymbol,
81
+ label: String,
82
+ target: PreludeSDK::WatchSendEventsParams::Event::Target::OrHash
83
+ ).returns(T.attached_class)
84
+ end
85
+ def self.new(
86
+ # A confidence level you want to assign to the event.
87
+ confidence:,
88
+ # A label to describe what the event refers to.
89
+ label:,
90
+ # The event target. Only supports phone numbers for now.
91
+ target:
92
+ )
93
+ end
94
+
95
+ sig do
96
+ override.returns(
97
+ {
98
+ confidence:
99
+ PreludeSDK::WatchSendEventsParams::Event::Confidence::OrSymbol,
100
+ label: String,
101
+ target: PreludeSDK::WatchSendEventsParams::Event::Target
102
+ }
103
+ )
104
+ end
105
+ def to_hash
106
+ end
107
+
108
+ # A confidence level you want to assign to the event.
109
+ module Confidence
110
+ extend PreludeSDK::Internal::Type::Enum
111
+
112
+ TaggedSymbol =
113
+ T.type_alias do
114
+ T.all(
115
+ Symbol,
116
+ PreludeSDK::WatchSendEventsParams::Event::Confidence
117
+ )
118
+ end
119
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
120
+
121
+ MAXIMUM =
122
+ T.let(
123
+ :maximum,
124
+ PreludeSDK::WatchSendEventsParams::Event::Confidence::TaggedSymbol
125
+ )
126
+ HIGH =
127
+ T.let(
128
+ :high,
129
+ PreludeSDK::WatchSendEventsParams::Event::Confidence::TaggedSymbol
130
+ )
131
+ NEUTRAL =
132
+ T.let(
133
+ :neutral,
134
+ PreludeSDK::WatchSendEventsParams::Event::Confidence::TaggedSymbol
135
+ )
136
+ LOW =
137
+ T.let(
138
+ :low,
139
+ PreludeSDK::WatchSendEventsParams::Event::Confidence::TaggedSymbol
140
+ )
141
+ MINIMUM =
142
+ T.let(
143
+ :minimum,
144
+ PreludeSDK::WatchSendEventsParams::Event::Confidence::TaggedSymbol
145
+ )
146
+
147
+ sig do
148
+ override.returns(
149
+ T::Array[
150
+ PreludeSDK::WatchSendEventsParams::Event::Confidence::TaggedSymbol
151
+ ]
152
+ )
153
+ end
154
+ def self.values
155
+ end
156
+ end
157
+
158
+ class Target < PreludeSDK::Internal::Type::BaseModel
159
+ OrHash =
160
+ T.type_alias do
161
+ T.any(
162
+ PreludeSDK::WatchSendEventsParams::Event::Target,
163
+ PreludeSDK::Internal::AnyHash
164
+ )
165
+ end
166
+
167
+ # The type of the target. Either "phone_number" or "email_address".
168
+ sig do
169
+ returns(
170
+ PreludeSDK::WatchSendEventsParams::Event::Target::Type::OrSymbol
171
+ )
172
+ end
173
+ attr_accessor :type
174
+
175
+ # An E.164 formatted phone number or an email address.
176
+ sig { returns(String) }
177
+ attr_accessor :value
178
+
179
+ # The event target. Only supports phone numbers for now.
180
+ sig do
181
+ params(
182
+ type:
183
+ PreludeSDK::WatchSendEventsParams::Event::Target::Type::OrSymbol,
184
+ value: String
185
+ ).returns(T.attached_class)
186
+ end
187
+ def self.new(
188
+ # The type of the target. Either "phone_number" or "email_address".
189
+ type:,
190
+ # An E.164 formatted phone number or an email address.
191
+ value:
192
+ )
193
+ end
194
+
195
+ sig do
196
+ override.returns(
197
+ {
198
+ type:
199
+ PreludeSDK::WatchSendEventsParams::Event::Target::Type::OrSymbol,
200
+ value: String
201
+ }
202
+ )
203
+ end
204
+ def to_hash
205
+ end
206
+
207
+ # The type of the target. Either "phone_number" or "email_address".
208
+ module Type
209
+ extend PreludeSDK::Internal::Type::Enum
210
+
211
+ TaggedSymbol =
212
+ T.type_alias do
213
+ T.all(
214
+ Symbol,
215
+ PreludeSDK::WatchSendEventsParams::Event::Target::Type
216
+ )
217
+ end
218
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
219
+
220
+ PHONE_NUMBER =
221
+ T.let(
222
+ :phone_number,
223
+ PreludeSDK::WatchSendEventsParams::Event::Target::Type::TaggedSymbol
224
+ )
225
+ EMAIL_ADDRESS =
226
+ T.let(
227
+ :email_address,
228
+ PreludeSDK::WatchSendEventsParams::Event::Target::Type::TaggedSymbol
229
+ )
230
+
231
+ sig do
232
+ override.returns(
233
+ T::Array[
234
+ PreludeSDK::WatchSendEventsParams::Event::Target::Type::TaggedSymbol
235
+ ]
236
+ )
237
+ end
238
+ def self.values
239
+ end
240
+ end
241
+ end
242
+ end
243
+ end
244
+ end
245
+ end
@@ -0,0 +1,82 @@
1
+ # typed: strong
2
+
3
+ module PreludeSDK
4
+ module Models
5
+ class WatchSendEventsResponse < PreludeSDK::Internal::Type::BaseModel
6
+ OrHash =
7
+ T.type_alias do
8
+ T.any(
9
+ PreludeSDK::Models::WatchSendEventsResponse,
10
+ PreludeSDK::Internal::AnyHash
11
+ )
12
+ end
13
+
14
+ # A string that identifies this specific request. Report it back to us to help us
15
+ # diagnose your issues.
16
+ sig { returns(String) }
17
+ attr_accessor :request_id
18
+
19
+ # The status of the events dispatch.
20
+ sig do
21
+ returns(
22
+ PreludeSDK::Models::WatchSendEventsResponse::Status::TaggedSymbol
23
+ )
24
+ end
25
+ attr_accessor :status
26
+
27
+ sig do
28
+ params(
29
+ request_id: String,
30
+ status: PreludeSDK::Models::WatchSendEventsResponse::Status::OrSymbol
31
+ ).returns(T.attached_class)
32
+ end
33
+ def self.new(
34
+ # A string that identifies this specific request. Report it back to us to help us
35
+ # diagnose your issues.
36
+ request_id:,
37
+ # The status of the events dispatch.
38
+ status:
39
+ )
40
+ end
41
+
42
+ sig do
43
+ override.returns(
44
+ {
45
+ request_id: String,
46
+ status:
47
+ PreludeSDK::Models::WatchSendEventsResponse::Status::TaggedSymbol
48
+ }
49
+ )
50
+ end
51
+ def to_hash
52
+ end
53
+
54
+ # The status of the events dispatch.
55
+ module Status
56
+ extend PreludeSDK::Internal::Type::Enum
57
+
58
+ TaggedSymbol =
59
+ T.type_alias do
60
+ T.all(Symbol, PreludeSDK::Models::WatchSendEventsResponse::Status)
61
+ end
62
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
63
+
64
+ SUCCESS =
65
+ T.let(
66
+ :success,
67
+ PreludeSDK::Models::WatchSendEventsResponse::Status::TaggedSymbol
68
+ )
69
+
70
+ sig do
71
+ override.returns(
72
+ T::Array[
73
+ PreludeSDK::Models::WatchSendEventsResponse::Status::TaggedSymbol
74
+ ]
75
+ )
76
+ end
77
+ def self.values
78
+ end
79
+ end
80
+ end
81
+ end
82
+ end