brand.dev 0.0.1.pre.alpha.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 (102) hide show
  1. checksums.yaml +7 -0
  2. data/README.md +229 -0
  3. data/SECURITY.md +23 -0
  4. data/lib/brand_dev/client.rb +74 -0
  5. data/lib/brand_dev/errors.rb +192 -0
  6. data/lib/brand_dev/file_part.rb +55 -0
  7. data/lib/brand_dev/internal/transport/base_client.rb +555 -0
  8. data/lib/brand_dev/internal/transport/pooled_net_requester.rb +209 -0
  9. data/lib/brand_dev/internal/type/array_of.rb +162 -0
  10. data/lib/brand_dev/internal/type/base_model.rb +484 -0
  11. data/lib/brand_dev/internal/type/base_page.rb +55 -0
  12. data/lib/brand_dev/internal/type/boolean.rb +71 -0
  13. data/lib/brand_dev/internal/type/converter.rb +292 -0
  14. data/lib/brand_dev/internal/type/enum.rb +120 -0
  15. data/lib/brand_dev/internal/type/file_input.rb +103 -0
  16. data/lib/brand_dev/internal/type/hash_of.rb +182 -0
  17. data/lib/brand_dev/internal/type/request_parameters.rb +42 -0
  18. data/lib/brand_dev/internal/type/union.rb +227 -0
  19. data/lib/brand_dev/internal/type/unknown.rb +75 -0
  20. data/lib/brand_dev/internal/util.rb +915 -0
  21. data/lib/brand_dev/internal.rb +20 -0
  22. data/lib/brand_dev/models/brand_identify_from_transaction_params.rb +22 -0
  23. data/lib/brand_dev/models/brand_identify_from_transaction_response.rb +435 -0
  24. data/lib/brand_dev/models/brand_retrieve_by_ticker_params.rb +22 -0
  25. data/lib/brand_dev/models/brand_retrieve_by_ticker_response.rb +432 -0
  26. data/lib/brand_dev/models/brand_retrieve_naics_params.rb +27 -0
  27. data/lib/brand_dev/models/brand_retrieve_naics_response.rb +61 -0
  28. data/lib/brand_dev/models/brand_retrieve_params.rb +91 -0
  29. data/lib/brand_dev/models/brand_retrieve_response.rb +432 -0
  30. data/lib/brand_dev/models/brand_search_params.rb +22 -0
  31. data/lib/brand_dev/models/brand_search_response.rb +35 -0
  32. data/lib/brand_dev/models.rb +51 -0
  33. data/lib/brand_dev/request_options.rb +77 -0
  34. data/lib/brand_dev/resources/brand.rb +130 -0
  35. data/lib/brand_dev/version.rb +5 -0
  36. data/lib/brand_dev.rb +64 -0
  37. data/manifest.yaml +15 -0
  38. data/rbi/brand_dev/client.rbi +49 -0
  39. data/rbi/brand_dev/errors.rbi +162 -0
  40. data/rbi/brand_dev/file_part.rbi +37 -0
  41. data/rbi/brand_dev/internal/transport/base_client.rbi +293 -0
  42. data/rbi/brand_dev/internal/transport/pooled_net_requester.rbi +79 -0
  43. data/rbi/brand_dev/internal/type/array_of.rbi +104 -0
  44. data/rbi/brand_dev/internal/type/base_model.rbi +302 -0
  45. data/rbi/brand_dev/internal/type/base_page.rbi +42 -0
  46. data/rbi/brand_dev/internal/type/boolean.rbi +56 -0
  47. data/rbi/brand_dev/internal/type/converter.rbi +162 -0
  48. data/rbi/brand_dev/internal/type/enum.rbi +82 -0
  49. data/rbi/brand_dev/internal/type/file_input.rbi +59 -0
  50. data/rbi/brand_dev/internal/type/hash_of.rbi +104 -0
  51. data/rbi/brand_dev/internal/type/request_parameters.rbi +29 -0
  52. data/rbi/brand_dev/internal/type/union.rbi +116 -0
  53. data/rbi/brand_dev/internal/type/unknown.rbi +56 -0
  54. data/rbi/brand_dev/internal/util.rbi +485 -0
  55. data/rbi/brand_dev/internal.rbi +16 -0
  56. data/rbi/brand_dev/models/brand_identify_from_transaction_params.rbi +46 -0
  57. data/rbi/brand_dev/models/brand_identify_from_transaction_response.rbi +981 -0
  58. data/rbi/brand_dev/models/brand_retrieve_by_ticker_params.rbi +43 -0
  59. data/rbi/brand_dev/models/brand_retrieve_by_ticker_response.rbi +976 -0
  60. data/rbi/brand_dev/models/brand_retrieve_naics_params.rbi +44 -0
  61. data/rbi/brand_dev/models/brand_retrieve_naics_response.rbi +127 -0
  62. data/rbi/brand_dev/models/brand_retrieve_params.rbi +344 -0
  63. data/rbi/brand_dev/models/brand_retrieve_response.rbi +949 -0
  64. data/rbi/brand_dev/models/brand_search_params.rbi +40 -0
  65. data/rbi/brand_dev/models/brand_search_response.rbi +63 -0
  66. data/rbi/brand_dev/models.rbi +14 -0
  67. data/rbi/brand_dev/request_options.rbi +59 -0
  68. data/rbi/brand_dev/resources/brand.rbi +89 -0
  69. data/rbi/brand_dev/version.rbi +5 -0
  70. data/sig/brand_dev/client.rbs +26 -0
  71. data/sig/brand_dev/errors.rbs +101 -0
  72. data/sig/brand_dev/file_part.rbs +21 -0
  73. data/sig/brand_dev/internal/transport/base_client.rbs +131 -0
  74. data/sig/brand_dev/internal/transport/pooled_net_requester.rbs +45 -0
  75. data/sig/brand_dev/internal/type/array_of.rbs +48 -0
  76. data/sig/brand_dev/internal/type/base_model.rbs +102 -0
  77. data/sig/brand_dev/internal/type/base_page.rbs +24 -0
  78. data/sig/brand_dev/internal/type/boolean.rbs +26 -0
  79. data/sig/brand_dev/internal/type/converter.rbs +56 -0
  80. data/sig/brand_dev/internal/type/enum.rbs +32 -0
  81. data/sig/brand_dev/internal/type/file_input.rbs +25 -0
  82. data/sig/brand_dev/internal/type/hash_of.rbs +48 -0
  83. data/sig/brand_dev/internal/type/request_parameters.rbs +17 -0
  84. data/sig/brand_dev/internal/type/union.rbs +52 -0
  85. data/sig/brand_dev/internal/type/unknown.rbs +26 -0
  86. data/sig/brand_dev/internal/util.rbs +185 -0
  87. data/sig/brand_dev/internal.rbs +9 -0
  88. data/sig/brand_dev/models/brand_identify_from_transaction_params.rbs +24 -0
  89. data/sig/brand_dev/models/brand_identify_from_transaction_response.rbs +418 -0
  90. data/sig/brand_dev/models/brand_retrieve_by_ticker_params.rbs +23 -0
  91. data/sig/brand_dev/models/brand_retrieve_by_ticker_response.rbs +418 -0
  92. data/sig/brand_dev/models/brand_retrieve_naics_params.rbs +23 -0
  93. data/sig/brand_dev/models/brand_retrieve_naics_response.rbs +61 -0
  94. data/sig/brand_dev/models/brand_retrieve_params.rbs +148 -0
  95. data/sig/brand_dev/models/brand_retrieve_response.rbs +418 -0
  96. data/sig/brand_dev/models/brand_search_params.rbs +23 -0
  97. data/sig/brand_dev/models/brand_search_response.rbs +29 -0
  98. data/sig/brand_dev/models.rbs +11 -0
  99. data/sig/brand_dev/request_options.rbs +34 -0
  100. data/sig/brand_dev/resources/brand.rbs +33 -0
  101. data/sig/brand_dev/version.rbs +3 -0
  102. metadata +160 -0
@@ -0,0 +1,485 @@
1
+ # typed: strong
2
+
3
+ module BrandDev
4
+ module Internal
5
+ # @api private
6
+ module Util
7
+ extend BrandDev::Internal::Util::SorbetRuntimeSupport
8
+
9
+ # @api private
10
+ sig { returns(Float) }
11
+ def self.monotonic_secs
12
+ end
13
+
14
+ # @api private
15
+ sig do
16
+ params(ns: T.any(Module, T::Class[T.anything])).returns(
17
+ T::Enumerable[T.any(Module, T::Class[T.anything])]
18
+ )
19
+ end
20
+ def self.walk_namespaces(ns)
21
+ end
22
+
23
+ class << self
24
+ # @api private
25
+ sig { returns(String) }
26
+ def arch
27
+ end
28
+
29
+ # @api private
30
+ sig { returns(String) }
31
+ def os
32
+ end
33
+ end
34
+
35
+ class << self
36
+ # @api private
37
+ sig { params(input: T.anything).returns(T::Boolean) }
38
+ def primitive?(input)
39
+ end
40
+
41
+ # @api private
42
+ sig do
43
+ params(input: T.any(String, T::Boolean)).returns(
44
+ T.any(T::Boolean, T.anything)
45
+ )
46
+ end
47
+ def coerce_boolean(input)
48
+ end
49
+
50
+ # @api private
51
+ sig do
52
+ params(input: T.any(String, T::Boolean)).returns(
53
+ T.nilable(T::Boolean)
54
+ )
55
+ end
56
+ def coerce_boolean!(input)
57
+ end
58
+
59
+ # @api private
60
+ sig do
61
+ params(input: T.any(String, Integer)).returns(
62
+ T.any(Integer, T.anything)
63
+ )
64
+ end
65
+ def coerce_integer(input)
66
+ end
67
+
68
+ # @api private
69
+ sig do
70
+ params(input: T.any(String, Integer, Float)).returns(
71
+ T.any(Float, T.anything)
72
+ )
73
+ end
74
+ def coerce_float(input)
75
+ end
76
+
77
+ # @api private
78
+ sig do
79
+ params(input: T.anything).returns(
80
+ T.any(T::Hash[T.anything, T.anything], T.anything)
81
+ )
82
+ end
83
+ def coerce_hash(input)
84
+ end
85
+
86
+ # @api private
87
+ sig do
88
+ params(input: T.anything).returns(
89
+ T.nilable(T::Hash[T.anything, T.anything])
90
+ )
91
+ end
92
+ def coerce_hash!(input)
93
+ end
94
+ end
95
+
96
+ class << self
97
+ # @api private
98
+ sig do
99
+ params(lhs: T.anything, rhs: T.anything, concat: T::Boolean).returns(
100
+ T.anything
101
+ )
102
+ end
103
+ private def deep_merge_lr(lhs, rhs, concat: false)
104
+ end
105
+
106
+ # @api private
107
+ #
108
+ # Recursively merge one hash with another. If the values at a given key are not
109
+ # both hashes, just take the new value.
110
+ sig do
111
+ params(
112
+ values: T::Array[T.anything],
113
+ sentinel: T.nilable(T.anything),
114
+ concat: T::Boolean
115
+ ).returns(T.anything)
116
+ end
117
+ def deep_merge(
118
+ *values,
119
+ # the value to return if no values are provided.
120
+ sentinel: nil,
121
+ # whether to merge sequences by concatenation.
122
+ concat: false
123
+ )
124
+ end
125
+
126
+ # @api private
127
+ sig do
128
+ params(
129
+ data:
130
+ T.any(
131
+ BrandDev::Internal::AnyHash,
132
+ T::Array[T.anything],
133
+ T.anything
134
+ ),
135
+ pick:
136
+ T.nilable(
137
+ T.any(
138
+ Symbol,
139
+ Integer,
140
+ T::Array[T.any(Symbol, Integer)],
141
+ T.proc.params(arg0: T.anything).returns(T.anything)
142
+ )
143
+ ),
144
+ blk: T.nilable(T.proc.returns(T.anything))
145
+ ).returns(T.nilable(T.anything))
146
+ end
147
+ def dig(data, pick, &blk)
148
+ end
149
+ end
150
+
151
+ class << self
152
+ # @api private
153
+ sig { params(uri: URI::Generic).returns(String) }
154
+ def uri_origin(uri)
155
+ end
156
+
157
+ # @api private
158
+ sig { params(path: T.any(String, T::Array[String])).returns(String) }
159
+ def interpolate_path(path)
160
+ end
161
+ end
162
+
163
+ class << self
164
+ # @api private
165
+ sig do
166
+ params(query: T.nilable(String)).returns(
167
+ T::Hash[String, T::Array[String]]
168
+ )
169
+ end
170
+ def decode_query(query)
171
+ end
172
+
173
+ # @api private
174
+ sig do
175
+ params(
176
+ query:
177
+ T.nilable(
178
+ T::Hash[String, T.nilable(T.any(T::Array[String], String))]
179
+ )
180
+ ).returns(T.nilable(String))
181
+ end
182
+ def encode_query(query)
183
+ end
184
+ end
185
+
186
+ ParsedUri =
187
+ T.type_alias do
188
+ {
189
+ scheme: T.nilable(String),
190
+ host: T.nilable(String),
191
+ port: T.nilable(Integer),
192
+ path: T.nilable(String),
193
+ query: T::Hash[String, T::Array[String]]
194
+ }
195
+ end
196
+
197
+ class << self
198
+ # @api private
199
+ sig do
200
+ params(url: T.any(URI::Generic, String)).returns(
201
+ BrandDev::Internal::Util::ParsedUri
202
+ )
203
+ end
204
+ def parse_uri(url)
205
+ end
206
+
207
+ # @api private
208
+ sig do
209
+ params(parsed: BrandDev::Internal::Util::ParsedUri).returns(
210
+ URI::Generic
211
+ )
212
+ end
213
+ def unparse_uri(parsed)
214
+ end
215
+
216
+ # @api private
217
+ sig do
218
+ params(
219
+ lhs: BrandDev::Internal::Util::ParsedUri,
220
+ rhs: BrandDev::Internal::Util::ParsedUri
221
+ ).returns(URI::Generic)
222
+ end
223
+ def join_parsed_uri(lhs, rhs)
224
+ end
225
+ end
226
+
227
+ class << self
228
+ # @api private
229
+ sig do
230
+ params(
231
+ headers:
232
+ T::Hash[
233
+ String,
234
+ T.nilable(
235
+ T.any(
236
+ String,
237
+ Integer,
238
+ T::Array[T.nilable(T.any(String, Integer))]
239
+ )
240
+ )
241
+ ]
242
+ ).returns(T::Hash[String, String])
243
+ end
244
+ def normalized_headers(*headers)
245
+ end
246
+ end
247
+
248
+ # @api private
249
+ #
250
+ # An adapter that satisfies the IO interface required by `::IO.copy_stream`
251
+ class ReadIOAdapter
252
+ # @api private
253
+ sig { returns(T.nilable(T::Boolean)) }
254
+ def close?
255
+ end
256
+
257
+ # @api private
258
+ sig { void }
259
+ def close
260
+ end
261
+
262
+ # @api private
263
+ sig { params(max_len: T.nilable(Integer)).returns(String) }
264
+ private def read_enum(max_len)
265
+ end
266
+
267
+ # @api private
268
+ sig do
269
+ params(
270
+ max_len: T.nilable(Integer),
271
+ out_string: T.nilable(String)
272
+ ).returns(T.nilable(String))
273
+ end
274
+ def read(max_len = nil, out_string = nil)
275
+ end
276
+
277
+ # @api private
278
+ sig do
279
+ params(
280
+ src: T.any(String, Pathname, StringIO, T::Enumerable[String]),
281
+ blk: T.proc.params(arg0: String).void
282
+ ).returns(T.attached_class)
283
+ end
284
+ def self.new(src, &blk)
285
+ end
286
+ end
287
+
288
+ class << self
289
+ sig do
290
+ params(blk: T.proc.params(y: Enumerator::Yielder).void).returns(
291
+ T::Enumerable[String]
292
+ )
293
+ end
294
+ def writable_enum(&blk)
295
+ end
296
+ end
297
+
298
+ JSON_CONTENT =
299
+ T.let(%r{^application/(?:vnd(?:\.[^.]+)*\+)?json(?!l)}, Regexp)
300
+ JSONL_CONTENT =
301
+ T.let(%r{^application/(:?x-(?:n|l)djson)|(:?(?:x-)?jsonl)}, Regexp)
302
+
303
+ class << self
304
+ # @api private
305
+ sig do
306
+ params(
307
+ y: Enumerator::Yielder,
308
+ val: T.anything,
309
+ closing: T::Array[T.proc.void],
310
+ content_type: T.nilable(String)
311
+ ).void
312
+ end
313
+ private def write_multipart_content(
314
+ y,
315
+ val:,
316
+ closing:,
317
+ content_type: nil
318
+ )
319
+ end
320
+
321
+ # @api private
322
+ sig do
323
+ params(
324
+ y: Enumerator::Yielder,
325
+ boundary: String,
326
+ key: T.any(Symbol, String),
327
+ val: T.anything,
328
+ closing: T::Array[T.proc.void]
329
+ ).void
330
+ end
331
+ private def write_multipart_chunk(y, boundary:, key:, val:, closing:)
332
+ end
333
+
334
+ # @api private
335
+ sig do
336
+ params(body: T.anything).returns([String, T::Enumerable[String]])
337
+ end
338
+ private def encode_multipart_streaming(body)
339
+ end
340
+
341
+ # @api private
342
+ sig do
343
+ params(headers: T::Hash[String, String], body: T.anything).returns(
344
+ T.anything
345
+ )
346
+ end
347
+ def encode_content(headers, body)
348
+ end
349
+
350
+ # @api private
351
+ #
352
+ # https://www.iana.org/assignments/character-sets/character-sets.xhtml
353
+ sig { params(content_type: String, text: String).void }
354
+ def force_charset!(content_type, text:)
355
+ end
356
+
357
+ # @api private
358
+ #
359
+ # Assumes each chunk in stream has `Encoding::BINARY`.
360
+ sig do
361
+ params(
362
+ headers: T.any(T::Hash[String, String], Net::HTTPHeader),
363
+ stream: T::Enumerable[String],
364
+ suppress_error: T::Boolean
365
+ ).returns(T.anything)
366
+ end
367
+ def decode_content(headers, stream:, suppress_error: false)
368
+ end
369
+ end
370
+
371
+ class << self
372
+ # @api private
373
+ #
374
+ # https://doc.rust-lang.org/std/iter/trait.FusedIterator.html
375
+ sig do
376
+ params(
377
+ enum: T::Enumerable[T.anything],
378
+ external: T::Boolean,
379
+ close: T.proc.void
380
+ ).returns(T::Enumerable[T.anything])
381
+ end
382
+ def fused_enum(enum, external: false, &close)
383
+ end
384
+
385
+ # @api private
386
+ sig { params(enum: T.nilable(T::Enumerable[T.anything])).void }
387
+ def close_fused!(enum)
388
+ end
389
+
390
+ # @api private
391
+ sig do
392
+ params(
393
+ enum: T.nilable(T::Enumerable[T.anything]),
394
+ blk: T.proc.params(arg0: Enumerator::Yielder).void
395
+ ).returns(T::Enumerable[T.anything])
396
+ end
397
+ def chain_fused(enum, &blk)
398
+ end
399
+ end
400
+
401
+ ServerSentEvent =
402
+ T.type_alias do
403
+ {
404
+ event: T.nilable(String),
405
+ data: T.nilable(String),
406
+ id: T.nilable(String),
407
+ retry: T.nilable(Integer)
408
+ }
409
+ end
410
+
411
+ class << self
412
+ # @api private
413
+ #
414
+ # Assumes Strings have been forced into having `Encoding::BINARY`.
415
+ #
416
+ # This decoder is responsible for reassembling lines split across multiple
417
+ # fragments.
418
+ sig do
419
+ params(enum: T::Enumerable[String]).returns(T::Enumerable[String])
420
+ end
421
+ def decode_lines(enum)
422
+ end
423
+
424
+ # @api private
425
+ #
426
+ # https://html.spec.whatwg.org/multipage/server-sent-events.html#parsing-an-event-stream
427
+ #
428
+ # Assumes that `lines` has been decoded with `#decode_lines`.
429
+ sig do
430
+ params(lines: T::Enumerable[String]).returns(
431
+ T::Enumerable[BrandDev::Internal::Util::ServerSentEvent]
432
+ )
433
+ end
434
+ def decode_sse(lines)
435
+ end
436
+ end
437
+
438
+ # @api private
439
+ module SorbetRuntimeSupport
440
+ class MissingSorbetRuntimeError < ::RuntimeError
441
+ end
442
+
443
+ # @api private
444
+ sig { returns(T::Hash[Symbol, T.anything]) }
445
+ private def sorbet_runtime_constants
446
+ end
447
+
448
+ # @api private
449
+ sig { params(name: Symbol).void }
450
+ def const_missing(name)
451
+ end
452
+
453
+ # @api private
454
+ sig { params(name: Symbol).returns(T::Boolean) }
455
+ def sorbet_constant_defined?(name)
456
+ end
457
+
458
+ # @api private
459
+ sig { params(name: Symbol, blk: T.proc.returns(T.anything)).void }
460
+ def define_sorbet_constant!(name, &blk)
461
+ end
462
+
463
+ # @api private
464
+ sig { returns(T.anything) }
465
+ def to_sorbet_type
466
+ end
467
+
468
+ class << self
469
+ # @api private
470
+ sig do
471
+ params(
472
+ type:
473
+ T.any(
474
+ BrandDev::Internal::Util::SorbetRuntimeSupport,
475
+ T.anything
476
+ )
477
+ ).returns(T.anything)
478
+ end
479
+ def to_sorbet_type(type)
480
+ end
481
+ end
482
+ end
483
+ end
484
+ end
485
+ end
@@ -0,0 +1,16 @@
1
+ # typed: strong
2
+
3
+ module BrandDev
4
+ module Internal
5
+ extend BrandDev::Internal::Util::SorbetRuntimeSupport
6
+
7
+ # Due to the current WIP status of Shapes support in Sorbet, types referencing
8
+ # this alias might be refined in the future.
9
+ AnyHash = T.type_alias { T::Hash[Symbol, T.anything] }
10
+
11
+ FileInput =
12
+ T.type_alias { T.any(Pathname, StringIO, IO, String, BrandDev::FilePart) }
13
+
14
+ OMIT = T.let(Object.new.freeze, T.anything)
15
+ end
16
+ end
@@ -0,0 +1,46 @@
1
+ # typed: strong
2
+
3
+ module BrandDev
4
+ module Models
5
+ class BrandIdentifyFromTransactionParams < BrandDev::Internal::Type::BaseModel
6
+ extend BrandDev::Internal::Type::RequestParameters::Converter
7
+ include BrandDev::Internal::Type::RequestParameters
8
+
9
+ OrHash =
10
+ T.type_alias do
11
+ T.any(
12
+ BrandDev::BrandIdentifyFromTransactionParams,
13
+ BrandDev::Internal::AnyHash
14
+ )
15
+ end
16
+
17
+ # Transaction information to identify the brand
18
+ sig { returns(String) }
19
+ attr_accessor :transaction_info
20
+
21
+ sig do
22
+ params(
23
+ transaction_info: String,
24
+ request_options: BrandDev::RequestOptions::OrHash
25
+ ).returns(T.attached_class)
26
+ end
27
+ def self.new(
28
+ # Transaction information to identify the brand
29
+ transaction_info:,
30
+ request_options: {}
31
+ )
32
+ end
33
+
34
+ sig do
35
+ override.returns(
36
+ {
37
+ transaction_info: String,
38
+ request_options: BrandDev::RequestOptions
39
+ }
40
+ )
41
+ end
42
+ def to_hash
43
+ end
44
+ end
45
+ end
46
+ end