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
@@ -159,27 +159,19 @@ module BrandDev
159
159
  sig { params(domain: String).void }
160
160
  attr_writer :domain
161
161
 
162
- # An array of fonts used by the brand's website
163
- sig do
164
- returns(
165
- T.nilable(
166
- T::Array[
167
- BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Font
168
- ]
169
- )
170
- )
171
- end
172
- attr_reader :fonts
162
+ # Company email address
163
+ sig { returns(T.nilable(String)) }
164
+ attr_reader :email
173
165
 
174
- sig do
175
- params(
176
- fonts:
177
- T::Array[
178
- BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Font::OrHash
179
- ]
180
- ).void
181
- end
182
- attr_writer :fonts
166
+ sig { params(email: String).void }
167
+ attr_writer :email
168
+
169
+ # Indicates whether the brand content is not safe for work (NSFW)
170
+ sig { returns(T.nilable(T::Boolean)) }
171
+ attr_reader :is_nsfw
172
+
173
+ sig { params(is_nsfw: T::Boolean).void }
174
+ attr_writer :is_nsfw
183
175
 
184
176
  # An array of logos associated with the brand
185
177
  sig do
@@ -203,6 +195,13 @@ module BrandDev
203
195
  end
204
196
  attr_writer :logos
205
197
 
198
+ # Company phone number
199
+ sig { returns(T.nilable(String)) }
200
+ attr_reader :phone
201
+
202
+ sig { params(phone: String).void }
203
+ attr_writer :phone
204
+
206
205
  # The brand's slogan
207
206
  sig { returns(T.nilable(String)) }
208
207
  attr_reader :slogan
@@ -273,14 +272,13 @@ module BrandDev
273
272
  ],
274
273
  description: String,
275
274
  domain: String,
276
- fonts:
277
- T::Array[
278
- BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Font::OrHash
279
- ],
275
+ email: String,
276
+ is_nsfw: T::Boolean,
280
277
  logos:
281
278
  T::Array[
282
279
  BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo::OrHash
283
280
  ],
281
+ phone: String,
284
282
  slogan: String,
285
283
  socials:
286
284
  T::Array[
@@ -302,10 +300,14 @@ module BrandDev
302
300
  description: nil,
303
301
  # The domain name of the brand
304
302
  domain: nil,
305
- # An array of fonts used by the brand's website
306
- fonts: nil,
303
+ # Company email address
304
+ email: nil,
305
+ # Indicates whether the brand content is not safe for work (NSFW)
306
+ is_nsfw: nil,
307
307
  # An array of logos associated with the brand
308
308
  logos: nil,
309
+ # Company phone number
310
+ phone: nil,
309
311
  # The brand's slogan
310
312
  slogan: nil,
311
313
  # An array of social media links for the brand
@@ -333,14 +335,13 @@ module BrandDev
333
335
  ],
334
336
  description: String,
335
337
  domain: String,
336
- fonts:
337
- T::Array[
338
- BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Font
339
- ],
338
+ email: String,
339
+ is_nsfw: T::Boolean,
340
340
  logos:
341
341
  T::Array[
342
342
  BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo
343
343
  ],
344
+ phone: String,
344
345
  slogan: String,
345
346
  socials:
346
347
  T::Array[
@@ -599,6 +600,13 @@ module BrandDev
599
600
  )
600
601
  end
601
602
 
603
+ # Aspect ratio of the image (width/height)
604
+ sig { returns(T.nilable(Float)) }
605
+ attr_reader :aspect_ratio
606
+
607
+ sig { params(aspect_ratio: Float).void }
608
+ attr_writer :aspect_ratio
609
+
602
610
  # Height of the image in pixels
603
611
  sig { returns(T.nilable(Integer)) }
604
612
  attr_reader :height
@@ -615,9 +623,15 @@ module BrandDev
615
623
 
616
624
  # Resolution of the backdrop image
617
625
  sig do
618
- params(height: Integer, width: Integer).returns(T.attached_class)
626
+ params(
627
+ aspect_ratio: Float,
628
+ height: Integer,
629
+ width: Integer
630
+ ).returns(T.attached_class)
619
631
  end
620
632
  def self.new(
633
+ # Aspect ratio of the image (width/height)
634
+ aspect_ratio: nil,
621
635
  # Height of the image in pixels
622
636
  height: nil,
623
637
  # Width of the image in pixels
@@ -625,7 +639,11 @@ module BrandDev
625
639
  )
626
640
  end
627
641
 
628
- sig { override.returns({ height: Integer, width: Integer }) }
642
+ sig do
643
+ override.returns(
644
+ { aspect_ratio: Float, height: Integer, width: Integer }
645
+ )
646
+ end
629
647
  def to_hash
630
648
  end
631
649
  end
@@ -668,43 +686,6 @@ module BrandDev
668
686
  end
669
687
  end
670
688
 
671
- class Font < BrandDev::Internal::Type::BaseModel
672
- OrHash =
673
- T.type_alias do
674
- T.any(
675
- BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Font,
676
- BrandDev::Internal::AnyHash
677
- )
678
- end
679
-
680
- # Name of the font
681
- sig { returns(T.nilable(String)) }
682
- attr_reader :name
683
-
684
- sig { params(name: String).void }
685
- attr_writer :name
686
-
687
- # Usage of the font, e.g., 'title', 'body', 'button'
688
- sig { returns(T.nilable(String)) }
689
- attr_reader :usage
690
-
691
- sig { params(usage: String).void }
692
- attr_writer :usage
693
-
694
- sig { params(name: String, usage: String).returns(T.attached_class) }
695
- def self.new(
696
- # Name of the font
697
- name: nil,
698
- # Usage of the font, e.g., 'title', 'body', 'button'
699
- usage: nil
700
- )
701
- end
702
-
703
- sig { override.returns({ name: String, usage: String }) }
704
- def to_hash
705
- end
706
- end
707
-
708
689
  class Logo < BrandDev::Internal::Type::BaseModel
709
690
  OrHash =
710
691
  T.type_alias do
@@ -736,18 +717,24 @@ module BrandDev
736
717
  end
737
718
  attr_writer :colors
738
719
 
739
- # Group identifier for logos
740
- sig { returns(T.nilable(Integer)) }
741
- attr_reader :group
742
-
743
- sig { params(group: Integer).void }
744
- attr_writer :group
745
-
746
- # Mode of the logo, e.g., 'dark', 'light'
747
- sig { returns(T.nilable(String)) }
720
+ # Indicates when this logo is best used: 'light' = best for light mode, 'dark' =
721
+ # best for dark mode, 'has_opaque_background' = can be used for either as image
722
+ # has its own background
723
+ sig do
724
+ returns(
725
+ T.nilable(
726
+ BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo::Mode::TaggedSymbol
727
+ )
728
+ )
729
+ end
748
730
  attr_reader :mode
749
731
 
750
- sig { params(mode: String).void }
732
+ sig do
733
+ params(
734
+ mode:
735
+ BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo::Mode::OrSymbol
736
+ ).void
737
+ end
751
738
  attr_writer :mode
752
739
 
753
740
  # Resolution of the logo image
@@ -768,7 +755,25 @@ module BrandDev
768
755
  end
769
756
  attr_writer :resolution
770
757
 
771
- # URL of the logo image
758
+ # Type of the logo based on resolution (e.g., 'icon', 'logo')
759
+ sig do
760
+ returns(
761
+ T.nilable(
762
+ BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo::Type::TaggedSymbol
763
+ )
764
+ )
765
+ end
766
+ attr_reader :type
767
+
768
+ sig do
769
+ params(
770
+ type:
771
+ BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo::Type::OrSymbol
772
+ ).void
773
+ end
774
+ attr_writer :type
775
+
776
+ # CDN hosted url of the logo (ready for display)
772
777
  sig { returns(T.nilable(String)) }
773
778
  attr_reader :url
774
779
 
@@ -781,23 +786,27 @@ module BrandDev
781
786
  T::Array[
782
787
  BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo::Color::OrHash
783
788
  ],
784
- group: Integer,
785
- mode: String,
789
+ mode:
790
+ BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo::Mode::OrSymbol,
786
791
  resolution:
787
792
  BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo::Resolution::OrHash,
793
+ type:
794
+ BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo::Type::OrSymbol,
788
795
  url: String
789
796
  ).returns(T.attached_class)
790
797
  end
791
798
  def self.new(
792
799
  # Array of colors in the logo
793
800
  colors: nil,
794
- # Group identifier for logos
795
- group: nil,
796
- # Mode of the logo, e.g., 'dark', 'light'
801
+ # Indicates when this logo is best used: 'light' = best for light mode, 'dark' =
802
+ # best for dark mode, 'has_opaque_background' = can be used for either as image
803
+ # has its own background
797
804
  mode: nil,
798
805
  # Resolution of the logo image
799
806
  resolution: nil,
800
- # URL of the logo image
807
+ # Type of the logo based on resolution (e.g., 'icon', 'logo')
808
+ type: nil,
809
+ # CDN hosted url of the logo (ready for display)
801
810
  url: nil
802
811
  )
803
812
  end
@@ -809,10 +818,12 @@ module BrandDev
809
818
  T::Array[
810
819
  BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo::Color
811
820
  ],
812
- group: Integer,
813
- mode: String,
821
+ mode:
822
+ BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo::Mode::TaggedSymbol,
814
823
  resolution:
815
824
  BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo::Resolution,
825
+ type:
826
+ BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo::Type::TaggedSymbol,
816
827
  url: String
817
828
  }
818
829
  )
@@ -857,6 +868,48 @@ module BrandDev
857
868
  end
858
869
  end
859
870
 
871
+ # Indicates when this logo is best used: 'light' = best for light mode, 'dark' =
872
+ # best for dark mode, 'has_opaque_background' = can be used for either as image
873
+ # has its own background
874
+ module Mode
875
+ extend BrandDev::Internal::Type::Enum
876
+
877
+ TaggedSymbol =
878
+ T.type_alias do
879
+ T.all(
880
+ Symbol,
881
+ BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo::Mode
882
+ )
883
+ end
884
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
885
+
886
+ LIGHT =
887
+ T.let(
888
+ :light,
889
+ BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo::Mode::TaggedSymbol
890
+ )
891
+ DARK =
892
+ T.let(
893
+ :dark,
894
+ BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo::Mode::TaggedSymbol
895
+ )
896
+ HAS_OPAQUE_BACKGROUND =
897
+ T.let(
898
+ :has_opaque_background,
899
+ BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo::Mode::TaggedSymbol
900
+ )
901
+
902
+ sig do
903
+ override.returns(
904
+ T::Array[
905
+ BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo::Mode::TaggedSymbol
906
+ ]
907
+ )
908
+ end
909
+ def self.values
910
+ end
911
+ end
912
+
860
913
  class Resolution < BrandDev::Internal::Type::BaseModel
861
914
  OrHash =
862
915
  T.type_alias do
@@ -866,6 +919,13 @@ module BrandDev
866
919
  )
867
920
  end
868
921
 
922
+ # Aspect ratio of the image (width/height)
923
+ sig { returns(T.nilable(Float)) }
924
+ attr_reader :aspect_ratio
925
+
926
+ sig { params(aspect_ratio: Float).void }
927
+ attr_writer :aspect_ratio
928
+
869
929
  # Height of the image in pixels
870
930
  sig { returns(T.nilable(Integer)) }
871
931
  attr_reader :height
@@ -882,9 +942,15 @@ module BrandDev
882
942
 
883
943
  # Resolution of the logo image
884
944
  sig do
885
- params(height: Integer, width: Integer).returns(T.attached_class)
945
+ params(
946
+ aspect_ratio: Float,
947
+ height: Integer,
948
+ width: Integer
949
+ ).returns(T.attached_class)
886
950
  end
887
951
  def self.new(
952
+ # Aspect ratio of the image (width/height)
953
+ aspect_ratio: nil,
888
954
  # Height of the image in pixels
889
955
  height: nil,
890
956
  # Width of the image in pixels
@@ -892,10 +958,49 @@ module BrandDev
892
958
  )
893
959
  end
894
960
 
895
- sig { override.returns({ height: Integer, width: Integer }) }
961
+ sig do
962
+ override.returns(
963
+ { aspect_ratio: Float, height: Integer, width: Integer }
964
+ )
965
+ end
896
966
  def to_hash
897
967
  end
898
968
  end
969
+
970
+ # Type of the logo based on resolution (e.g., 'icon', 'logo')
971
+ module Type
972
+ extend BrandDev::Internal::Type::Enum
973
+
974
+ TaggedSymbol =
975
+ T.type_alias do
976
+ T.all(
977
+ Symbol,
978
+ BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo::Type
979
+ )
980
+ end
981
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
982
+
983
+ ICON =
984
+ T.let(
985
+ :icon,
986
+ BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo::Type::TaggedSymbol
987
+ )
988
+ LOGO =
989
+ T.let(
990
+ :logo,
991
+ BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo::Type::TaggedSymbol
992
+ )
993
+
994
+ sig do
995
+ override.returns(
996
+ T::Array[
997
+ BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo::Type::TaggedSymbol
998
+ ]
999
+ )
1000
+ end
1001
+ def self.values
1002
+ end
1003
+ end
899
1004
  end
900
1005
 
901
1006
  class Social < BrandDev::Internal::Type::BaseModel