brand.dev 0.10.0 → 0.11.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.
- checksums.yaml +4 -4
 - data/CHANGELOG.md +8 -0
 - data/README.md +1 -1
 - data/lib/brand_dev/models/brand_retrieve_by_email_params.rb +116 -0
 - data/lib/brand_dev/models/brand_retrieve_by_email_response.rb +850 -0
 - data/lib/brand_dev/models.rb +2 -0
 - data/lib/brand_dev/resources/brand.rb +34 -0
 - data/lib/brand_dev/version.rb +1 -1
 - data/lib/brand_dev.rb +2 -0
 - data/rbi/brand_dev/models/brand_retrieve_by_email_params.rbi +386 -0
 - data/rbi/brand_dev/models/brand_retrieve_by_email_response.rbi +2590 -0
 - data/rbi/brand_dev/models.rbi +2 -0
 - data/rbi/brand_dev/resources/brand.rbi +33 -0
 - data/sig/brand_dev/models/brand_retrieve_by_email_params.rbs +162 -0
 - data/sig/brand_dev/models/brand_retrieve_by_email_response.rbs +1076 -0
 - data/sig/brand_dev/models.rbs +2 -0
 - data/sig/brand_dev/resources/brand.rbs +8 -0
 - metadata +8 -2
 
    
        checksums.yaml
    CHANGED
    
    | 
         @@ -1,7 +1,7 @@ 
     | 
|
| 
       1 
1 
     | 
    
         
             
            ---
         
     | 
| 
       2 
2 
     | 
    
         
             
            SHA256:
         
     | 
| 
       3 
     | 
    
         
            -
              metadata.gz:  
     | 
| 
       4 
     | 
    
         
            -
              data.tar.gz:  
     | 
| 
      
 3 
     | 
    
         
            +
              metadata.gz: 920a850b162b14fe50b1e7d8340033876fc5db6f65efbbe29d42be24fcc72e0c
         
     | 
| 
      
 4 
     | 
    
         
            +
              data.tar.gz: 1f5f0c158d3043af09cc51136e79c167fd2eb6828c6dae46eeb30687fdc8f283
         
     | 
| 
       5 
5 
     | 
    
         
             
            SHA512:
         
     | 
| 
       6 
     | 
    
         
            -
              metadata.gz:  
     | 
| 
       7 
     | 
    
         
            -
              data.tar.gz:  
     | 
| 
      
 6 
     | 
    
         
            +
              metadata.gz: eab77e1e67836bd1073ccfaaaaa4c8b54cc2fa3a172162dbb8d78fd5666daa968d23e100fcaa77d4263fbbe08b081fb609ea0fced6b926b4426aec680c10f9b4
         
     | 
| 
      
 7 
     | 
    
         
            +
              data.tar.gz: 1d84ee54df246a557339922007418db42325442c18fa35ef41d7ac4979c5a9c7ebf5bf0582d206c8136422186d625641f04285f4f40730e26c4732ed30082487
         
     | 
    
        data/CHANGELOG.md
    CHANGED
    
    | 
         @@ -1,5 +1,13 @@ 
     | 
|
| 
       1 
1 
     | 
    
         
             
            # Changelog
         
     | 
| 
       2 
2 
     | 
    
         | 
| 
      
 3 
     | 
    
         
            +
            ## 0.11.0 (2025-10-31)
         
     | 
| 
      
 4 
     | 
    
         
            +
             
     | 
| 
      
 5 
     | 
    
         
            +
            Full Changelog: [v0.10.0...v0.11.0](https://github.com/brand-dot-dev/ruby-sdk/compare/v0.10.0...v0.11.0)
         
     | 
| 
      
 6 
     | 
    
         
            +
             
     | 
| 
      
 7 
     | 
    
         
            +
            ### Features
         
     | 
| 
      
 8 
     | 
    
         
            +
             
     | 
| 
      
 9 
     | 
    
         
            +
            * **api:** manual updates ([f8b29b1](https://github.com/brand-dot-dev/ruby-sdk/commit/f8b29b1ab6d654d4fd664ad46c19dd5cb0073972))
         
     | 
| 
      
 10 
     | 
    
         
            +
             
     | 
| 
       3 
11 
     | 
    
         
             
            ## 0.10.0 (2025-10-30)
         
     | 
| 
       4 
12 
     | 
    
         | 
| 
       5 
13 
     | 
    
         
             
            Full Changelog: [v0.9.0...v0.10.0](https://github.com/brand-dot-dev/ruby-sdk/compare/v0.9.0...v0.10.0)
         
     | 
    
        data/README.md
    CHANGED
    
    
| 
         @@ -0,0 +1,116 @@ 
     | 
|
| 
      
 1 
     | 
    
         
            +
            # frozen_string_literal: true
         
     | 
| 
      
 2 
     | 
    
         
            +
             
     | 
| 
      
 3 
     | 
    
         
            +
            module BrandDev
         
     | 
| 
      
 4 
     | 
    
         
            +
              module Models
         
     | 
| 
      
 5 
     | 
    
         
            +
                # @see BrandDev::Resources::Brand#retrieve_by_email
         
     | 
| 
      
 6 
     | 
    
         
            +
                class BrandRetrieveByEmailParams < BrandDev::Internal::Type::BaseModel
         
     | 
| 
      
 7 
     | 
    
         
            +
                  extend BrandDev::Internal::Type::RequestParameters::Converter
         
     | 
| 
      
 8 
     | 
    
         
            +
                  include BrandDev::Internal::Type::RequestParameters
         
     | 
| 
      
 9 
     | 
    
         
            +
             
     | 
| 
      
 10 
     | 
    
         
            +
                  # @!attribute email
         
     | 
| 
      
 11 
     | 
    
         
            +
                  #   Email address to retrieve brand data for (e.g., 'contact@example.com'). The
         
     | 
| 
      
 12 
     | 
    
         
            +
                  #   domain will be extracted from the email. Free email providers (gmail.com,
         
     | 
| 
      
 13 
     | 
    
         
            +
                  #   yahoo.com, etc.) and disposable email addresses are not allowed.
         
     | 
| 
      
 14 
     | 
    
         
            +
                  #
         
     | 
| 
      
 15 
     | 
    
         
            +
                  #   @return [String]
         
     | 
| 
      
 16 
     | 
    
         
            +
                  required :email, String
         
     | 
| 
      
 17 
     | 
    
         
            +
             
     | 
| 
      
 18 
     | 
    
         
            +
                  # @!attribute force_language
         
     | 
| 
      
 19 
     | 
    
         
            +
                  #   Optional parameter to force the language of the retrieved brand data.
         
     | 
| 
      
 20 
     | 
    
         
            +
                  #
         
     | 
| 
      
 21 
     | 
    
         
            +
                  #   @return [Symbol, BrandDev::Models::BrandRetrieveByEmailParams::ForceLanguage, nil]
         
     | 
| 
      
 22 
     | 
    
         
            +
                  optional :force_language, enum: -> { BrandDev::BrandRetrieveByEmailParams::ForceLanguage }
         
     | 
| 
      
 23 
     | 
    
         
            +
             
     | 
| 
      
 24 
     | 
    
         
            +
                  # @!attribute max_speed
         
     | 
| 
      
 25 
     | 
    
         
            +
                  #   Optional parameter to optimize the API call for maximum speed. When set to true,
         
     | 
| 
      
 26 
     | 
    
         
            +
                  #   the API will skip time-consuming operations for faster response at the cost of
         
     | 
| 
      
 27 
     | 
    
         
            +
                  #   less comprehensive data.
         
     | 
| 
      
 28 
     | 
    
         
            +
                  #
         
     | 
| 
      
 29 
     | 
    
         
            +
                  #   @return [Boolean, nil]
         
     | 
| 
      
 30 
     | 
    
         
            +
                  optional :max_speed, BrandDev::Internal::Type::Boolean
         
     | 
| 
      
 31 
     | 
    
         
            +
             
     | 
| 
      
 32 
     | 
    
         
            +
                  # @!attribute timeout_ms
         
     | 
| 
      
 33 
     | 
    
         
            +
                  #   Optional timeout in milliseconds for the request. If the request takes longer
         
     | 
| 
      
 34 
     | 
    
         
            +
                  #   than this value, it will be aborted with a 408 status code. Maximum allowed
         
     | 
| 
      
 35 
     | 
    
         
            +
                  #   value is 300000ms (5 minutes).
         
     | 
| 
      
 36 
     | 
    
         
            +
                  #
         
     | 
| 
      
 37 
     | 
    
         
            +
                  #   @return [Integer, nil]
         
     | 
| 
      
 38 
     | 
    
         
            +
                  optional :timeout_ms, Integer
         
     | 
| 
      
 39 
     | 
    
         
            +
             
     | 
| 
      
 40 
     | 
    
         
            +
                  # @!method initialize(email:, force_language: nil, max_speed: nil, timeout_ms: nil, request_options: {})
         
     | 
| 
      
 41 
     | 
    
         
            +
                  #   Some parameter documentations has been truncated, see
         
     | 
| 
      
 42 
     | 
    
         
            +
                  #   {BrandDev::Models::BrandRetrieveByEmailParams} for more details.
         
     | 
| 
      
 43 
     | 
    
         
            +
                  #
         
     | 
| 
      
 44 
     | 
    
         
            +
                  #   @param email [String] Email address to retrieve brand data for (e.g., 'contact@example.com'). The doma
         
     | 
| 
      
 45 
     | 
    
         
            +
                  #
         
     | 
| 
      
 46 
     | 
    
         
            +
                  #   @param force_language [Symbol, BrandDev::Models::BrandRetrieveByEmailParams::ForceLanguage] Optional parameter to force the language of the retrieved brand data.
         
     | 
| 
      
 47 
     | 
    
         
            +
                  #
         
     | 
| 
      
 48 
     | 
    
         
            +
                  #   @param max_speed [Boolean] Optional parameter to optimize the API call for maximum speed. When set to true,
         
     | 
| 
      
 49 
     | 
    
         
            +
                  #
         
     | 
| 
      
 50 
     | 
    
         
            +
                  #   @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
         
     | 
| 
      
 51 
     | 
    
         
            +
                  #
         
     | 
| 
      
 52 
     | 
    
         
            +
                  #   @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}]
         
     | 
| 
      
 53 
     | 
    
         
            +
             
     | 
| 
      
 54 
     | 
    
         
            +
                  # Optional parameter to force the language of the retrieved brand data.
         
     | 
| 
      
 55 
     | 
    
         
            +
                  module ForceLanguage
         
     | 
| 
      
 56 
     | 
    
         
            +
                    extend BrandDev::Internal::Type::Enum
         
     | 
| 
      
 57 
     | 
    
         
            +
             
     | 
| 
      
 58 
     | 
    
         
            +
                    ALBANIAN = :albanian
         
     | 
| 
      
 59 
     | 
    
         
            +
                    ARABIC = :arabic
         
     | 
| 
      
 60 
     | 
    
         
            +
                    AZERI = :azeri
         
     | 
| 
      
 61 
     | 
    
         
            +
                    BENGALI = :bengali
         
     | 
| 
      
 62 
     | 
    
         
            +
                    BULGARIAN = :bulgarian
         
     | 
| 
      
 63 
     | 
    
         
            +
                    CEBUANO = :cebuano
         
     | 
| 
      
 64 
     | 
    
         
            +
                    CROATIAN = :croatian
         
     | 
| 
      
 65 
     | 
    
         
            +
                    CZECH = :czech
         
     | 
| 
      
 66 
     | 
    
         
            +
                    DANISH = :danish
         
     | 
| 
      
 67 
     | 
    
         
            +
                    DUTCH = :dutch
         
     | 
| 
      
 68 
     | 
    
         
            +
                    ENGLISH = :english
         
     | 
| 
      
 69 
     | 
    
         
            +
                    ESTONIAN = :estonian
         
     | 
| 
      
 70 
     | 
    
         
            +
                    FARSI = :farsi
         
     | 
| 
      
 71 
     | 
    
         
            +
                    FINNISH = :finnish
         
     | 
| 
      
 72 
     | 
    
         
            +
                    FRENCH = :french
         
     | 
| 
      
 73 
     | 
    
         
            +
                    GERMAN = :german
         
     | 
| 
      
 74 
     | 
    
         
            +
                    HAUSA = :hausa
         
     | 
| 
      
 75 
     | 
    
         
            +
                    HAWAIIAN = :hawaiian
         
     | 
| 
      
 76 
     | 
    
         
            +
                    HINDI = :hindi
         
     | 
| 
      
 77 
     | 
    
         
            +
                    HUNGARIAN = :hungarian
         
     | 
| 
      
 78 
     | 
    
         
            +
                    ICELANDIC = :icelandic
         
     | 
| 
      
 79 
     | 
    
         
            +
                    INDONESIAN = :indonesian
         
     | 
| 
      
 80 
     | 
    
         
            +
                    ITALIAN = :italian
         
     | 
| 
      
 81 
     | 
    
         
            +
                    KAZAKH = :kazakh
         
     | 
| 
      
 82 
     | 
    
         
            +
                    KYRGYZ = :kyrgyz
         
     | 
| 
      
 83 
     | 
    
         
            +
                    LATIN = :latin
         
     | 
| 
      
 84 
     | 
    
         
            +
                    LATVIAN = :latvian
         
     | 
| 
      
 85 
     | 
    
         
            +
                    LITHUANIAN = :lithuanian
         
     | 
| 
      
 86 
     | 
    
         
            +
                    MACEDONIAN = :macedonian
         
     | 
| 
      
 87 
     | 
    
         
            +
                    MONGOLIAN = :mongolian
         
     | 
| 
      
 88 
     | 
    
         
            +
                    NEPALI = :nepali
         
     | 
| 
      
 89 
     | 
    
         
            +
                    NORWEGIAN = :norwegian
         
     | 
| 
      
 90 
     | 
    
         
            +
                    PASHTO = :pashto
         
     | 
| 
      
 91 
     | 
    
         
            +
                    PIDGIN = :pidgin
         
     | 
| 
      
 92 
     | 
    
         
            +
                    POLISH = :polish
         
     | 
| 
      
 93 
     | 
    
         
            +
                    PORTUGUESE = :portuguese
         
     | 
| 
      
 94 
     | 
    
         
            +
                    ROMANIAN = :romanian
         
     | 
| 
      
 95 
     | 
    
         
            +
                    RUSSIAN = :russian
         
     | 
| 
      
 96 
     | 
    
         
            +
                    SERBIAN = :serbian
         
     | 
| 
      
 97 
     | 
    
         
            +
                    SLOVAK = :slovak
         
     | 
| 
      
 98 
     | 
    
         
            +
                    SLOVENE = :slovene
         
     | 
| 
      
 99 
     | 
    
         
            +
                    SOMALI = :somali
         
     | 
| 
      
 100 
     | 
    
         
            +
                    SPANISH = :spanish
         
     | 
| 
      
 101 
     | 
    
         
            +
                    SWAHILI = :swahili
         
     | 
| 
      
 102 
     | 
    
         
            +
                    SWEDISH = :swedish
         
     | 
| 
      
 103 
     | 
    
         
            +
                    TAGALOG = :tagalog
         
     | 
| 
      
 104 
     | 
    
         
            +
                    TURKISH = :turkish
         
     | 
| 
      
 105 
     | 
    
         
            +
                    UKRAINIAN = :ukrainian
         
     | 
| 
      
 106 
     | 
    
         
            +
                    URDU = :urdu
         
     | 
| 
      
 107 
     | 
    
         
            +
                    UZBEK = :uzbek
         
     | 
| 
      
 108 
     | 
    
         
            +
                    VIETNAMESE = :vietnamese
         
     | 
| 
      
 109 
     | 
    
         
            +
                    WELSH = :welsh
         
     | 
| 
      
 110 
     | 
    
         
            +
             
     | 
| 
      
 111 
     | 
    
         
            +
                    # @!method self.values
         
     | 
| 
      
 112 
     | 
    
         
            +
                    #   @return [Array<Symbol>]
         
     | 
| 
      
 113 
     | 
    
         
            +
                  end
         
     | 
| 
      
 114 
     | 
    
         
            +
                end
         
     | 
| 
      
 115 
     | 
    
         
            +
              end
         
     | 
| 
      
 116 
     | 
    
         
            +
            end
         
     |