brand.dev 0.2.0 → 0.3.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 (39) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +26 -0
  3. data/README.md +1 -1
  4. data/lib/brand_dev/internal/transport/base_client.rb +1 -1
  5. data/lib/brand_dev/internal/type/array_of.rb +1 -0
  6. data/lib/brand_dev/internal/type/base_model.rb +3 -1
  7. data/lib/brand_dev/internal/type/converter.rb +27 -0
  8. data/lib/brand_dev/internal/type/hash_of.rb +1 -0
  9. data/lib/brand_dev/internal/type/union.rb +9 -7
  10. data/lib/brand_dev/models/brand_identify_from_transaction_response.rb +311 -1
  11. data/lib/brand_dev/models/brand_retrieve_params.rb +32 -9
  12. data/lib/brand_dev/models/brand_retrieve_response.rb +310 -1
  13. data/lib/brand_dev/models.rb +0 -2
  14. data/lib/brand_dev/resources/brand.rb +10 -32
  15. data/lib/brand_dev/version.rb +1 -1
  16. data/lib/brand_dev.rb +0 -2
  17. data/rbi/brand_dev/internal/transport/base_client.rbi +1 -1
  18. data/rbi/brand_dev/internal/type/converter.rbi +54 -0
  19. data/rbi/brand_dev/internal/type/union.rbi +9 -2
  20. data/rbi/brand_dev/models/brand_identify_from_transaction_response.rbi +1409 -0
  21. data/rbi/brand_dev/models/brand_retrieve_params.rbi +48 -10
  22. data/rbi/brand_dev/models/brand_retrieve_response.rbi +1409 -0
  23. data/rbi/brand_dev/models.rbi +0 -2
  24. data/rbi/brand_dev/resources/brand.rbi +18 -24
  25. data/sig/brand_dev/internal/transport/base_client.rbs +1 -1
  26. data/sig/brand_dev/internal/type/converter.rbs +17 -0
  27. data/sig/brand_dev/internal/type/union.rbs +2 -2
  28. data/sig/brand_dev/models/brand_identify_from_transaction_response.rbs +558 -0
  29. data/sig/brand_dev/models/brand_retrieve_params.rbs +18 -2
  30. data/sig/brand_dev/models/brand_retrieve_response.rbs +558 -0
  31. data/sig/brand_dev/models.rbs +0 -2
  32. data/sig/brand_dev/resources/brand.rbs +3 -7
  33. metadata +2 -8
  34. data/lib/brand_dev/models/brand_retrieve_by_ticker_params.rb +0 -35
  35. data/lib/brand_dev/models/brand_retrieve_by_ticker_response.rb +0 -478
  36. data/rbi/brand_dev/models/brand_retrieve_by_ticker_params.rbi +0 -61
  37. data/rbi/brand_dev/models/brand_retrieve_by_ticker_response.rbi +0 -1081
  38. data/sig/brand_dev/models/brand_retrieve_by_ticker_params.rbs +0 -30
  39. data/sig/brand_dev/models/brand_retrieve_by_ticker_response.rbs +0 -467
@@ -1,1081 +0,0 @@
1
- # typed: strong
2
-
3
- module BrandDev
4
- module Models
5
- class BrandRetrieveByTickerResponse < BrandDev::Internal::Type::BaseModel
6
- OrHash =
7
- T.type_alias do
8
- T.any(
9
- BrandDev::Models::BrandRetrieveByTickerResponse,
10
- BrandDev::Internal::AnyHash
11
- )
12
- end
13
-
14
- # Detailed brand information
15
- sig do
16
- returns(
17
- T.nilable(BrandDev::Models::BrandRetrieveByTickerResponse::Brand)
18
- )
19
- end
20
- attr_reader :brand
21
-
22
- sig do
23
- params(
24
- brand: BrandDev::Models::BrandRetrieveByTickerResponse::Brand::OrHash
25
- ).void
26
- end
27
- attr_writer :brand
28
-
29
- # HTTP status code
30
- sig { returns(T.nilable(Integer)) }
31
- attr_reader :code
32
-
33
- sig { params(code: Integer).void }
34
- attr_writer :code
35
-
36
- # Status of the response, e.g., 'ok'
37
- sig { returns(T.nilable(String)) }
38
- attr_reader :status
39
-
40
- sig { params(status: String).void }
41
- attr_writer :status
42
-
43
- sig do
44
- params(
45
- brand: BrandDev::Models::BrandRetrieveByTickerResponse::Brand::OrHash,
46
- code: Integer,
47
- status: String
48
- ).returns(T.attached_class)
49
- end
50
- def self.new(
51
- # Detailed brand information
52
- brand: nil,
53
- # HTTP status code
54
- code: nil,
55
- # Status of the response, e.g., 'ok'
56
- status: nil
57
- )
58
- end
59
-
60
- sig do
61
- override.returns(
62
- {
63
- brand: BrandDev::Models::BrandRetrieveByTickerResponse::Brand,
64
- code: Integer,
65
- status: String
66
- }
67
- )
68
- end
69
- def to_hash
70
- end
71
-
72
- class Brand < BrandDev::Internal::Type::BaseModel
73
- OrHash =
74
- T.type_alias do
75
- T.any(
76
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand,
77
- BrandDev::Internal::AnyHash
78
- )
79
- end
80
-
81
- # Physical address of the brand
82
- sig do
83
- returns(
84
- T.nilable(
85
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Address
86
- )
87
- )
88
- end
89
- attr_reader :address
90
-
91
- sig do
92
- params(
93
- address:
94
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Address::OrHash
95
- ).void
96
- end
97
- attr_writer :address
98
-
99
- # An array of backdrop images for the brand
100
- sig do
101
- returns(
102
- T.nilable(
103
- T::Array[
104
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Backdrop
105
- ]
106
- )
107
- )
108
- end
109
- attr_reader :backdrops
110
-
111
- sig do
112
- params(
113
- backdrops:
114
- T::Array[
115
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Backdrop::OrHash
116
- ]
117
- ).void
118
- end
119
- attr_writer :backdrops
120
-
121
- # An array of brand colors
122
- sig do
123
- returns(
124
- T.nilable(
125
- T::Array[
126
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Color
127
- ]
128
- )
129
- )
130
- end
131
- attr_reader :colors
132
-
133
- sig do
134
- params(
135
- colors:
136
- T::Array[
137
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Color::OrHash
138
- ]
139
- ).void
140
- end
141
- attr_writer :colors
142
-
143
- # A brief description of the brand
144
- sig { returns(T.nilable(String)) }
145
- attr_reader :description
146
-
147
- sig { params(description: String).void }
148
- attr_writer :description
149
-
150
- # The domain name of the brand
151
- sig { returns(T.nilable(String)) }
152
- attr_reader :domain
153
-
154
- sig { params(domain: String).void }
155
- attr_writer :domain
156
-
157
- # Company email address
158
- sig { returns(T.nilable(String)) }
159
- attr_reader :email
160
-
161
- sig { params(email: String).void }
162
- attr_writer :email
163
-
164
- # Indicates whether the brand content is not safe for work (NSFW)
165
- sig { returns(T.nilable(T::Boolean)) }
166
- attr_reader :is_nsfw
167
-
168
- sig { params(is_nsfw: T::Boolean).void }
169
- attr_writer :is_nsfw
170
-
171
- # An array of logos associated with the brand
172
- sig do
173
- returns(
174
- T.nilable(
175
- T::Array[
176
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo
177
- ]
178
- )
179
- )
180
- end
181
- attr_reader :logos
182
-
183
- sig do
184
- params(
185
- logos:
186
- T::Array[
187
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo::OrHash
188
- ]
189
- ).void
190
- end
191
- attr_writer :logos
192
-
193
- # Company phone number
194
- sig { returns(T.nilable(String)) }
195
- attr_reader :phone
196
-
197
- sig { params(phone: String).void }
198
- attr_writer :phone
199
-
200
- # The brand's slogan
201
- sig { returns(T.nilable(String)) }
202
- attr_reader :slogan
203
-
204
- sig { params(slogan: String).void }
205
- attr_writer :slogan
206
-
207
- # An array of social media links for the brand
208
- sig do
209
- returns(
210
- T.nilable(
211
- T::Array[
212
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Social
213
- ]
214
- )
215
- )
216
- end
217
- attr_reader :socials
218
-
219
- sig do
220
- params(
221
- socials:
222
- T::Array[
223
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Social::OrHash
224
- ]
225
- ).void
226
- end
227
- attr_writer :socials
228
-
229
- # Stock market information for this brand (will be null if not a publicly traded
230
- # company)
231
- sig do
232
- returns(
233
- T.nilable(
234
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Stock
235
- )
236
- )
237
- end
238
- attr_reader :stock
239
-
240
- sig do
241
- params(
242
- stock:
243
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Stock::OrHash
244
- ).void
245
- end
246
- attr_writer :stock
247
-
248
- # The title or name of the brand
249
- sig { returns(T.nilable(String)) }
250
- attr_reader :title
251
-
252
- sig { params(title: String).void }
253
- attr_writer :title
254
-
255
- # Detailed brand information
256
- sig do
257
- params(
258
- address:
259
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Address::OrHash,
260
- backdrops:
261
- T::Array[
262
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Backdrop::OrHash
263
- ],
264
- colors:
265
- T::Array[
266
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Color::OrHash
267
- ],
268
- description: String,
269
- domain: String,
270
- email: String,
271
- is_nsfw: T::Boolean,
272
- logos:
273
- T::Array[
274
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo::OrHash
275
- ],
276
- phone: String,
277
- slogan: String,
278
- socials:
279
- T::Array[
280
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Social::OrHash
281
- ],
282
- stock:
283
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Stock::OrHash,
284
- title: String
285
- ).returns(T.attached_class)
286
- end
287
- def self.new(
288
- # Physical address of the brand
289
- address: nil,
290
- # An array of backdrop images for the brand
291
- backdrops: nil,
292
- # An array of brand colors
293
- colors: nil,
294
- # A brief description of the brand
295
- description: nil,
296
- # The domain name of the brand
297
- domain: nil,
298
- # Company email address
299
- email: nil,
300
- # Indicates whether the brand content is not safe for work (NSFW)
301
- is_nsfw: nil,
302
- # An array of logos associated with the brand
303
- logos: nil,
304
- # Company phone number
305
- phone: nil,
306
- # The brand's slogan
307
- slogan: nil,
308
- # An array of social media links for the brand
309
- socials: nil,
310
- # Stock market information for this brand (will be null if not a publicly traded
311
- # company)
312
- stock: nil,
313
- # The title or name of the brand
314
- title: nil
315
- )
316
- end
317
-
318
- sig do
319
- override.returns(
320
- {
321
- address:
322
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Address,
323
- backdrops:
324
- T::Array[
325
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Backdrop
326
- ],
327
- colors:
328
- T::Array[
329
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Color
330
- ],
331
- description: String,
332
- domain: String,
333
- email: String,
334
- is_nsfw: T::Boolean,
335
- logos:
336
- T::Array[
337
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo
338
- ],
339
- phone: String,
340
- slogan: String,
341
- socials:
342
- T::Array[
343
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Social
344
- ],
345
- stock:
346
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Stock,
347
- title: String
348
- }
349
- )
350
- end
351
- def to_hash
352
- end
353
-
354
- class Address < BrandDev::Internal::Type::BaseModel
355
- OrHash =
356
- T.type_alias do
357
- T.any(
358
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Address,
359
- BrandDev::Internal::AnyHash
360
- )
361
- end
362
-
363
- # City name
364
- sig { returns(T.nilable(String)) }
365
- attr_reader :city
366
-
367
- sig { params(city: String).void }
368
- attr_writer :city
369
-
370
- # Country name
371
- sig { returns(T.nilable(String)) }
372
- attr_reader :country
373
-
374
- sig { params(country: String).void }
375
- attr_writer :country
376
-
377
- # Country code
378
- sig { returns(T.nilable(String)) }
379
- attr_reader :country_code
380
-
381
- sig { params(country_code: String).void }
382
- attr_writer :country_code
383
-
384
- # Postal or ZIP code
385
- sig { returns(T.nilable(String)) }
386
- attr_reader :postal_code
387
-
388
- sig { params(postal_code: String).void }
389
- attr_writer :postal_code
390
-
391
- # State or province code
392
- sig { returns(T.nilable(String)) }
393
- attr_reader :state_code
394
-
395
- sig { params(state_code: String).void }
396
- attr_writer :state_code
397
-
398
- # State or province name
399
- sig { returns(T.nilable(String)) }
400
- attr_reader :state_province
401
-
402
- sig { params(state_province: String).void }
403
- attr_writer :state_province
404
-
405
- # Street address
406
- sig { returns(T.nilable(String)) }
407
- attr_reader :street
408
-
409
- sig { params(street: String).void }
410
- attr_writer :street
411
-
412
- # Physical address of the brand
413
- sig do
414
- params(
415
- city: String,
416
- country: String,
417
- country_code: String,
418
- postal_code: String,
419
- state_code: String,
420
- state_province: String,
421
- street: String
422
- ).returns(T.attached_class)
423
- end
424
- def self.new(
425
- # City name
426
- city: nil,
427
- # Country name
428
- country: nil,
429
- # Country code
430
- country_code: nil,
431
- # Postal or ZIP code
432
- postal_code: nil,
433
- # State or province code
434
- state_code: nil,
435
- # State or province name
436
- state_province: nil,
437
- # Street address
438
- street: nil
439
- )
440
- end
441
-
442
- sig do
443
- override.returns(
444
- {
445
- city: String,
446
- country: String,
447
- country_code: String,
448
- postal_code: String,
449
- state_code: String,
450
- state_province: String,
451
- street: String
452
- }
453
- )
454
- end
455
- def to_hash
456
- end
457
- end
458
-
459
- class Backdrop < BrandDev::Internal::Type::BaseModel
460
- OrHash =
461
- T.type_alias do
462
- T.any(
463
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Backdrop,
464
- BrandDev::Internal::AnyHash
465
- )
466
- end
467
-
468
- # Array of colors in the backdrop image
469
- sig do
470
- returns(
471
- T.nilable(
472
- T::Array[
473
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Backdrop::Color
474
- ]
475
- )
476
- )
477
- end
478
- attr_reader :colors
479
-
480
- sig do
481
- params(
482
- colors:
483
- T::Array[
484
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Backdrop::Color::OrHash
485
- ]
486
- ).void
487
- end
488
- attr_writer :colors
489
-
490
- # Resolution of the backdrop image
491
- sig do
492
- returns(
493
- T.nilable(
494
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Backdrop::Resolution
495
- )
496
- )
497
- end
498
- attr_reader :resolution
499
-
500
- sig do
501
- params(
502
- resolution:
503
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Backdrop::Resolution::OrHash
504
- ).void
505
- end
506
- attr_writer :resolution
507
-
508
- # URL of the backdrop image
509
- sig { returns(T.nilable(String)) }
510
- attr_reader :url
511
-
512
- sig { params(url: String).void }
513
- attr_writer :url
514
-
515
- sig do
516
- params(
517
- colors:
518
- T::Array[
519
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Backdrop::Color::OrHash
520
- ],
521
- resolution:
522
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Backdrop::Resolution::OrHash,
523
- url: String
524
- ).returns(T.attached_class)
525
- end
526
- def self.new(
527
- # Array of colors in the backdrop image
528
- colors: nil,
529
- # Resolution of the backdrop image
530
- resolution: nil,
531
- # URL of the backdrop image
532
- url: nil
533
- )
534
- end
535
-
536
- sig do
537
- override.returns(
538
- {
539
- colors:
540
- T::Array[
541
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Backdrop::Color
542
- ],
543
- resolution:
544
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Backdrop::Resolution,
545
- url: String
546
- }
547
- )
548
- end
549
- def to_hash
550
- end
551
-
552
- class Color < BrandDev::Internal::Type::BaseModel
553
- OrHash =
554
- T.type_alias do
555
- T.any(
556
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Backdrop::Color,
557
- BrandDev::Internal::AnyHash
558
- )
559
- end
560
-
561
- # Color in hexadecimal format
562
- sig { returns(T.nilable(String)) }
563
- attr_reader :hex
564
-
565
- sig { params(hex: String).void }
566
- attr_writer :hex
567
-
568
- # Name of the color
569
- sig { returns(T.nilable(String)) }
570
- attr_reader :name
571
-
572
- sig { params(name: String).void }
573
- attr_writer :name
574
-
575
- sig { params(hex: String, name: String).returns(T.attached_class) }
576
- def self.new(
577
- # Color in hexadecimal format
578
- hex: nil,
579
- # Name of the color
580
- name: nil
581
- )
582
- end
583
-
584
- sig { override.returns({ hex: String, name: String }) }
585
- def to_hash
586
- end
587
- end
588
-
589
- class Resolution < BrandDev::Internal::Type::BaseModel
590
- OrHash =
591
- T.type_alias do
592
- T.any(
593
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Backdrop::Resolution,
594
- BrandDev::Internal::AnyHash
595
- )
596
- end
597
-
598
- # Aspect ratio of the image (width/height)
599
- sig { returns(T.nilable(Float)) }
600
- attr_reader :aspect_ratio
601
-
602
- sig { params(aspect_ratio: Float).void }
603
- attr_writer :aspect_ratio
604
-
605
- # Height of the image in pixels
606
- sig { returns(T.nilable(Integer)) }
607
- attr_reader :height
608
-
609
- sig { params(height: Integer).void }
610
- attr_writer :height
611
-
612
- # Width of the image in pixels
613
- sig { returns(T.nilable(Integer)) }
614
- attr_reader :width
615
-
616
- sig { params(width: Integer).void }
617
- attr_writer :width
618
-
619
- # Resolution of the backdrop image
620
- sig do
621
- params(
622
- aspect_ratio: Float,
623
- height: Integer,
624
- width: Integer
625
- ).returns(T.attached_class)
626
- end
627
- def self.new(
628
- # Aspect ratio of the image (width/height)
629
- aspect_ratio: nil,
630
- # Height of the image in pixels
631
- height: nil,
632
- # Width of the image in pixels
633
- width: nil
634
- )
635
- end
636
-
637
- sig do
638
- override.returns(
639
- { aspect_ratio: Float, height: Integer, width: Integer }
640
- )
641
- end
642
- def to_hash
643
- end
644
- end
645
- end
646
-
647
- class Color < BrandDev::Internal::Type::BaseModel
648
- OrHash =
649
- T.type_alias do
650
- T.any(
651
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Color,
652
- BrandDev::Internal::AnyHash
653
- )
654
- end
655
-
656
- # Color in hexadecimal format
657
- sig { returns(T.nilable(String)) }
658
- attr_reader :hex
659
-
660
- sig { params(hex: String).void }
661
- attr_writer :hex
662
-
663
- # Name of the color
664
- sig { returns(T.nilable(String)) }
665
- attr_reader :name
666
-
667
- sig { params(name: String).void }
668
- attr_writer :name
669
-
670
- sig { params(hex: String, name: String).returns(T.attached_class) }
671
- def self.new(
672
- # Color in hexadecimal format
673
- hex: nil,
674
- # Name of the color
675
- name: nil
676
- )
677
- end
678
-
679
- sig { override.returns({ hex: String, name: String }) }
680
- def to_hash
681
- end
682
- end
683
-
684
- class Logo < BrandDev::Internal::Type::BaseModel
685
- OrHash =
686
- T.type_alias do
687
- T.any(
688
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo,
689
- BrandDev::Internal::AnyHash
690
- )
691
- end
692
-
693
- # Array of colors in the logo
694
- sig do
695
- returns(
696
- T.nilable(
697
- T::Array[
698
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo::Color
699
- ]
700
- )
701
- )
702
- end
703
- attr_reader :colors
704
-
705
- sig do
706
- params(
707
- colors:
708
- T::Array[
709
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo::Color::OrHash
710
- ]
711
- ).void
712
- end
713
- attr_writer :colors
714
-
715
- # Indicates when this logo is best used: 'light' = best for light mode, 'dark' =
716
- # best for dark mode, 'has_opaque_background' = can be used for either as image
717
- # has its own background
718
- sig do
719
- returns(
720
- T.nilable(
721
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo::Mode::TaggedSymbol
722
- )
723
- )
724
- end
725
- attr_reader :mode
726
-
727
- sig do
728
- params(
729
- mode:
730
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo::Mode::OrSymbol
731
- ).void
732
- end
733
- attr_writer :mode
734
-
735
- # Resolution of the logo image
736
- sig do
737
- returns(
738
- T.nilable(
739
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo::Resolution
740
- )
741
- )
742
- end
743
- attr_reader :resolution
744
-
745
- sig do
746
- params(
747
- resolution:
748
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo::Resolution::OrHash
749
- ).void
750
- end
751
- attr_writer :resolution
752
-
753
- # Type of the logo based on resolution (e.g., 'icon', 'logo')
754
- sig do
755
- returns(
756
- T.nilable(
757
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo::Type::TaggedSymbol
758
- )
759
- )
760
- end
761
- attr_reader :type
762
-
763
- sig do
764
- params(
765
- type:
766
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo::Type::OrSymbol
767
- ).void
768
- end
769
- attr_writer :type
770
-
771
- # CDN hosted url of the logo (ready for display)
772
- sig { returns(T.nilable(String)) }
773
- attr_reader :url
774
-
775
- sig { params(url: String).void }
776
- attr_writer :url
777
-
778
- sig do
779
- params(
780
- colors:
781
- T::Array[
782
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo::Color::OrHash
783
- ],
784
- mode:
785
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo::Mode::OrSymbol,
786
- resolution:
787
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo::Resolution::OrHash,
788
- type:
789
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo::Type::OrSymbol,
790
- url: String
791
- ).returns(T.attached_class)
792
- end
793
- def self.new(
794
- # Array of colors in the logo
795
- colors: nil,
796
- # Indicates when this logo is best used: 'light' = best for light mode, 'dark' =
797
- # best for dark mode, 'has_opaque_background' = can be used for either as image
798
- # has its own background
799
- mode: nil,
800
- # Resolution of the logo image
801
- resolution: nil,
802
- # Type of the logo based on resolution (e.g., 'icon', 'logo')
803
- type: nil,
804
- # CDN hosted url of the logo (ready for display)
805
- url: nil
806
- )
807
- end
808
-
809
- sig do
810
- override.returns(
811
- {
812
- colors:
813
- T::Array[
814
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo::Color
815
- ],
816
- mode:
817
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo::Mode::TaggedSymbol,
818
- resolution:
819
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo::Resolution,
820
- type:
821
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo::Type::TaggedSymbol,
822
- url: String
823
- }
824
- )
825
- end
826
- def to_hash
827
- end
828
-
829
- class Color < BrandDev::Internal::Type::BaseModel
830
- OrHash =
831
- T.type_alias do
832
- T.any(
833
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo::Color,
834
- BrandDev::Internal::AnyHash
835
- )
836
- end
837
-
838
- # Color in hexadecimal format
839
- sig { returns(T.nilable(String)) }
840
- attr_reader :hex
841
-
842
- sig { params(hex: String).void }
843
- attr_writer :hex
844
-
845
- # Name of the color
846
- sig { returns(T.nilable(String)) }
847
- attr_reader :name
848
-
849
- sig { params(name: String).void }
850
- attr_writer :name
851
-
852
- sig { params(hex: String, name: String).returns(T.attached_class) }
853
- def self.new(
854
- # Color in hexadecimal format
855
- hex: nil,
856
- # Name of the color
857
- name: nil
858
- )
859
- end
860
-
861
- sig { override.returns({ hex: String, name: String }) }
862
- def to_hash
863
- end
864
- end
865
-
866
- # Indicates when this logo is best used: 'light' = best for light mode, 'dark' =
867
- # best for dark mode, 'has_opaque_background' = can be used for either as image
868
- # has its own background
869
- module Mode
870
- extend BrandDev::Internal::Type::Enum
871
-
872
- TaggedSymbol =
873
- T.type_alias do
874
- T.all(
875
- Symbol,
876
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo::Mode
877
- )
878
- end
879
- OrSymbol = T.type_alias { T.any(Symbol, String) }
880
-
881
- LIGHT =
882
- T.let(
883
- :light,
884
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo::Mode::TaggedSymbol
885
- )
886
- DARK =
887
- T.let(
888
- :dark,
889
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo::Mode::TaggedSymbol
890
- )
891
- HAS_OPAQUE_BACKGROUND =
892
- T.let(
893
- :has_opaque_background,
894
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo::Mode::TaggedSymbol
895
- )
896
-
897
- sig do
898
- override.returns(
899
- T::Array[
900
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo::Mode::TaggedSymbol
901
- ]
902
- )
903
- end
904
- def self.values
905
- end
906
- end
907
-
908
- class Resolution < BrandDev::Internal::Type::BaseModel
909
- OrHash =
910
- T.type_alias do
911
- T.any(
912
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo::Resolution,
913
- BrandDev::Internal::AnyHash
914
- )
915
- end
916
-
917
- # Aspect ratio of the image (width/height)
918
- sig { returns(T.nilable(Float)) }
919
- attr_reader :aspect_ratio
920
-
921
- sig { params(aspect_ratio: Float).void }
922
- attr_writer :aspect_ratio
923
-
924
- # Height of the image in pixels
925
- sig { returns(T.nilable(Integer)) }
926
- attr_reader :height
927
-
928
- sig { params(height: Integer).void }
929
- attr_writer :height
930
-
931
- # Width of the image in pixels
932
- sig { returns(T.nilable(Integer)) }
933
- attr_reader :width
934
-
935
- sig { params(width: Integer).void }
936
- attr_writer :width
937
-
938
- # Resolution of the logo image
939
- sig do
940
- params(
941
- aspect_ratio: Float,
942
- height: Integer,
943
- width: Integer
944
- ).returns(T.attached_class)
945
- end
946
- def self.new(
947
- # Aspect ratio of the image (width/height)
948
- aspect_ratio: nil,
949
- # Height of the image in pixels
950
- height: nil,
951
- # Width of the image in pixels
952
- width: nil
953
- )
954
- end
955
-
956
- sig do
957
- override.returns(
958
- { aspect_ratio: Float, height: Integer, width: Integer }
959
- )
960
- end
961
- def to_hash
962
- end
963
- end
964
-
965
- # Type of the logo based on resolution (e.g., 'icon', 'logo')
966
- module Type
967
- extend BrandDev::Internal::Type::Enum
968
-
969
- TaggedSymbol =
970
- T.type_alias do
971
- T.all(
972
- Symbol,
973
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo::Type
974
- )
975
- end
976
- OrSymbol = T.type_alias { T.any(Symbol, String) }
977
-
978
- ICON =
979
- T.let(
980
- :icon,
981
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo::Type::TaggedSymbol
982
- )
983
- LOGO =
984
- T.let(
985
- :logo,
986
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo::Type::TaggedSymbol
987
- )
988
-
989
- sig do
990
- override.returns(
991
- T::Array[
992
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo::Type::TaggedSymbol
993
- ]
994
- )
995
- end
996
- def self.values
997
- end
998
- end
999
- end
1000
-
1001
- class Social < BrandDev::Internal::Type::BaseModel
1002
- OrHash =
1003
- T.type_alias do
1004
- T.any(
1005
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Social,
1006
- BrandDev::Internal::AnyHash
1007
- )
1008
- end
1009
-
1010
- # Type of social media, e.g., 'facebook', 'twitter'
1011
- sig { returns(T.nilable(String)) }
1012
- attr_reader :type
1013
-
1014
- sig { params(type: String).void }
1015
- attr_writer :type
1016
-
1017
- # URL of the social media page
1018
- sig { returns(T.nilable(String)) }
1019
- attr_reader :url
1020
-
1021
- sig { params(url: String).void }
1022
- attr_writer :url
1023
-
1024
- sig { params(type: String, url: String).returns(T.attached_class) }
1025
- def self.new(
1026
- # Type of social media, e.g., 'facebook', 'twitter'
1027
- type: nil,
1028
- # URL of the social media page
1029
- url: nil
1030
- )
1031
- end
1032
-
1033
- sig { override.returns({ type: String, url: String }) }
1034
- def to_hash
1035
- end
1036
- end
1037
-
1038
- class Stock < BrandDev::Internal::Type::BaseModel
1039
- OrHash =
1040
- T.type_alias do
1041
- T.any(
1042
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Stock,
1043
- BrandDev::Internal::AnyHash
1044
- )
1045
- end
1046
-
1047
- # Stock exchange name
1048
- sig { returns(T.nilable(String)) }
1049
- attr_reader :exchange
1050
-
1051
- sig { params(exchange: String).void }
1052
- attr_writer :exchange
1053
-
1054
- # Stock ticker symbol
1055
- sig { returns(T.nilable(String)) }
1056
- attr_reader :ticker
1057
-
1058
- sig { params(ticker: String).void }
1059
- attr_writer :ticker
1060
-
1061
- # Stock market information for this brand (will be null if not a publicly traded
1062
- # company)
1063
- sig do
1064
- params(exchange: String, ticker: String).returns(T.attached_class)
1065
- end
1066
- def self.new(
1067
- # Stock exchange name
1068
- exchange: nil,
1069
- # Stock ticker symbol
1070
- ticker: nil
1071
- )
1072
- end
1073
-
1074
- sig { override.returns({ exchange: String, ticker: String }) }
1075
- def to_hash
1076
- end
1077
- end
1078
- end
1079
- end
1080
- end
1081
- end