brand.dev 0.1.0.pre.alpha.13 → 0.2.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 (34) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +49 -0
  3. data/README.md +1 -1
  4. data/lib/brand_dev/internal/transport/base_client.rb +10 -2
  5. data/lib/brand_dev/models/brand_ai_query_response.rb +9 -1
  6. data/lib/brand_dev/models/brand_identify_from_transaction_response.rb +90 -43
  7. data/lib/brand_dev/models/brand_retrieve_by_ticker_response.rb +89 -43
  8. data/lib/brand_dev/models/brand_retrieve_response.rb +89 -44
  9. data/lib/brand_dev/models/brand_retrieve_simplified_response.rb +46 -19
  10. data/lib/brand_dev/models.rb +0 -2
  11. data/lib/brand_dev/resources/brand.rb +0 -27
  12. data/lib/brand_dev/version.rb +1 -1
  13. data/lib/brand_dev.rb +0 -2
  14. data/rbi/brand_dev/models/brand_ai_query_response.rbi +11 -0
  15. data/rbi/brand_dev/models/brand_identify_from_transaction_response.rbi +195 -90
  16. data/rbi/brand_dev/models/brand_retrieve_by_ticker_response.rbi +195 -90
  17. data/rbi/brand_dev/models/brand_retrieve_response.rbi +195 -88
  18. data/rbi/brand_dev/models/brand_retrieve_simplified_response.rbi +121 -25
  19. data/rbi/brand_dev/models.rbi +0 -2
  20. data/rbi/brand_dev/resources/brand.rbi +0 -19
  21. data/sig/brand_dev/models/brand_ai_query_response.rbs +7 -0
  22. data/sig/brand_dev/models/brand_identify_from_transaction_response.rbs +91 -42
  23. data/sig/brand_dev/models/brand_retrieve_by_ticker_response.rbs +91 -42
  24. data/sig/brand_dev/models/brand_retrieve_response.rbs +91 -42
  25. data/sig/brand_dev/models/brand_retrieve_simplified_response.rbs +37 -17
  26. data/sig/brand_dev/models.rbs +0 -2
  27. data/sig/brand_dev/resources/brand.rbs +0 -6
  28. metadata +4 -10
  29. data/lib/brand_dev/models/brand_search_params.rb +0 -35
  30. data/lib/brand_dev/models/brand_search_response.rb +0 -35
  31. data/rbi/brand_dev/models/brand_search_params.rbi +0 -58
  32. data/rbi/brand_dev/models/brand_search_response.rbi +0 -63
  33. data/sig/brand_dev/models/brand_search_params.rbs +0 -30
  34. data/sig/brand_dev/models/brand_search_response.rbs +0 -29
@@ -154,27 +154,19 @@ module BrandDev
154
154
  sig { params(domain: String).void }
155
155
  attr_writer :domain
156
156
 
157
- # An array of fonts used by the brand's website
158
- sig do
159
- returns(
160
- T.nilable(
161
- T::Array[
162
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Font
163
- ]
164
- )
165
- )
166
- end
167
- attr_reader :fonts
157
+ # Company email address
158
+ sig { returns(T.nilable(String)) }
159
+ attr_reader :email
168
160
 
169
- sig do
170
- params(
171
- fonts:
172
- T::Array[
173
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Font::OrHash
174
- ]
175
- ).void
176
- end
177
- attr_writer :fonts
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
178
170
 
179
171
  # An array of logos associated with the brand
180
172
  sig do
@@ -198,6 +190,13 @@ module BrandDev
198
190
  end
199
191
  attr_writer :logos
200
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
+
201
200
  # The brand's slogan
202
201
  sig { returns(T.nilable(String)) }
203
202
  attr_reader :slogan
@@ -268,14 +267,13 @@ module BrandDev
268
267
  ],
269
268
  description: String,
270
269
  domain: String,
271
- fonts:
272
- T::Array[
273
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Font::OrHash
274
- ],
270
+ email: String,
271
+ is_nsfw: T::Boolean,
275
272
  logos:
276
273
  T::Array[
277
274
  BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo::OrHash
278
275
  ],
276
+ phone: String,
279
277
  slogan: String,
280
278
  socials:
281
279
  T::Array[
@@ -297,10 +295,14 @@ module BrandDev
297
295
  description: nil,
298
296
  # The domain name of the brand
299
297
  domain: nil,
300
- # An array of fonts used by the brand's website
301
- fonts: 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
302
  # An array of logos associated with the brand
303
303
  logos: nil,
304
+ # Company phone number
305
+ phone: nil,
304
306
  # The brand's slogan
305
307
  slogan: nil,
306
308
  # An array of social media links for the brand
@@ -328,14 +330,13 @@ module BrandDev
328
330
  ],
329
331
  description: String,
330
332
  domain: String,
331
- fonts:
332
- T::Array[
333
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Font
334
- ],
333
+ email: String,
334
+ is_nsfw: T::Boolean,
335
335
  logos:
336
336
  T::Array[
337
337
  BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo
338
338
  ],
339
+ phone: String,
339
340
  slogan: String,
340
341
  socials:
341
342
  T::Array[
@@ -594,6 +595,13 @@ module BrandDev
594
595
  )
595
596
  end
596
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
+
597
605
  # Height of the image in pixels
598
606
  sig { returns(T.nilable(Integer)) }
599
607
  attr_reader :height
@@ -610,9 +618,15 @@ module BrandDev
610
618
 
611
619
  # Resolution of the backdrop image
612
620
  sig do
613
- params(height: Integer, width: Integer).returns(T.attached_class)
621
+ params(
622
+ aspect_ratio: Float,
623
+ height: Integer,
624
+ width: Integer
625
+ ).returns(T.attached_class)
614
626
  end
615
627
  def self.new(
628
+ # Aspect ratio of the image (width/height)
629
+ aspect_ratio: nil,
616
630
  # Height of the image in pixels
617
631
  height: nil,
618
632
  # Width of the image in pixels
@@ -620,7 +634,11 @@ module BrandDev
620
634
  )
621
635
  end
622
636
 
623
- sig { override.returns({ height: Integer, width: Integer }) }
637
+ sig do
638
+ override.returns(
639
+ { aspect_ratio: Float, height: Integer, width: Integer }
640
+ )
641
+ end
624
642
  def to_hash
625
643
  end
626
644
  end
@@ -663,43 +681,6 @@ module BrandDev
663
681
  end
664
682
  end
665
683
 
666
- class Font < BrandDev::Internal::Type::BaseModel
667
- OrHash =
668
- T.type_alias do
669
- T.any(
670
- BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Font,
671
- BrandDev::Internal::AnyHash
672
- )
673
- end
674
-
675
- # Name of the font
676
- sig { returns(T.nilable(String)) }
677
- attr_reader :name
678
-
679
- sig { params(name: String).void }
680
- attr_writer :name
681
-
682
- # Usage of the font, e.g., 'title', 'body', 'button'
683
- sig { returns(T.nilable(String)) }
684
- attr_reader :usage
685
-
686
- sig { params(usage: String).void }
687
- attr_writer :usage
688
-
689
- sig { params(name: String, usage: String).returns(T.attached_class) }
690
- def self.new(
691
- # Name of the font
692
- name: nil,
693
- # Usage of the font, e.g., 'title', 'body', 'button'
694
- usage: nil
695
- )
696
- end
697
-
698
- sig { override.returns({ name: String, usage: String }) }
699
- def to_hash
700
- end
701
- end
702
-
703
684
  class Logo < BrandDev::Internal::Type::BaseModel
704
685
  OrHash =
705
686
  T.type_alias do
@@ -731,18 +712,24 @@ module BrandDev
731
712
  end
732
713
  attr_writer :colors
733
714
 
734
- # Group identifier for logos
735
- sig { returns(T.nilable(Integer)) }
736
- attr_reader :group
737
-
738
- sig { params(group: Integer).void }
739
- attr_writer :group
740
-
741
- # Mode of the logo, e.g., 'dark', 'light'
742
- sig { returns(T.nilable(String)) }
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
743
725
  attr_reader :mode
744
726
 
745
- sig { params(mode: String).void }
727
+ sig do
728
+ params(
729
+ mode:
730
+ BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo::Mode::OrSymbol
731
+ ).void
732
+ end
746
733
  attr_writer :mode
747
734
 
748
735
  # Resolution of the logo image
@@ -763,7 +750,25 @@ module BrandDev
763
750
  end
764
751
  attr_writer :resolution
765
752
 
766
- # URL of the logo image
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)
767
772
  sig { returns(T.nilable(String)) }
768
773
  attr_reader :url
769
774
 
@@ -776,23 +781,27 @@ module BrandDev
776
781
  T::Array[
777
782
  BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo::Color::OrHash
778
783
  ],
779
- group: Integer,
780
- mode: String,
784
+ mode:
785
+ BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo::Mode::OrSymbol,
781
786
  resolution:
782
787
  BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo::Resolution::OrHash,
788
+ type:
789
+ BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo::Type::OrSymbol,
783
790
  url: String
784
791
  ).returns(T.attached_class)
785
792
  end
786
793
  def self.new(
787
794
  # Array of colors in the logo
788
795
  colors: nil,
789
- # Group identifier for logos
790
- group: nil,
791
- # Mode of the logo, e.g., 'dark', 'light'
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
792
799
  mode: nil,
793
800
  # Resolution of the logo image
794
801
  resolution: nil,
795
- # URL of the logo image
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)
796
805
  url: nil
797
806
  )
798
807
  end
@@ -804,10 +813,12 @@ module BrandDev
804
813
  T::Array[
805
814
  BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo::Color
806
815
  ],
807
- group: Integer,
808
- mode: String,
816
+ mode:
817
+ BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo::Mode::TaggedSymbol,
809
818
  resolution:
810
819
  BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo::Resolution,
820
+ type:
821
+ BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo::Type::TaggedSymbol,
811
822
  url: String
812
823
  }
813
824
  )
@@ -852,6 +863,48 @@ module BrandDev
852
863
  end
853
864
  end
854
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
+
855
908
  class Resolution < BrandDev::Internal::Type::BaseModel
856
909
  OrHash =
857
910
  T.type_alias do
@@ -861,6 +914,13 @@ module BrandDev
861
914
  )
862
915
  end
863
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
+
864
924
  # Height of the image in pixels
865
925
  sig { returns(T.nilable(Integer)) }
866
926
  attr_reader :height
@@ -877,9 +937,15 @@ module BrandDev
877
937
 
878
938
  # Resolution of the logo image
879
939
  sig do
880
- params(height: Integer, width: Integer).returns(T.attached_class)
940
+ params(
941
+ aspect_ratio: Float,
942
+ height: Integer,
943
+ width: Integer
944
+ ).returns(T.attached_class)
881
945
  end
882
946
  def self.new(
947
+ # Aspect ratio of the image (width/height)
948
+ aspect_ratio: nil,
883
949
  # Height of the image in pixels
884
950
  height: nil,
885
951
  # Width of the image in pixels
@@ -887,10 +953,49 @@ module BrandDev
887
953
  )
888
954
  end
889
955
 
890
- sig { override.returns({ height: Integer, width: Integer }) }
956
+ sig do
957
+ override.returns(
958
+ { aspect_ratio: Float, height: Integer, width: Integer }
959
+ )
960
+ end
891
961
  def to_hash
892
962
  end
893
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
894
999
  end
895
1000
 
896
1001
  class Social < BrandDev::Internal::Type::BaseModel