From 9838b2d1ec87919db639ee3c08b0cfe2cf83c0dc Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sat, 4 Apr 2026 21:34:19 +0000 Subject: [PATCH 01/82] codegen metadata --- .stats.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.stats.yml b/.stats.yml index bee881e..7569808 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 20 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-05a30711e18b0023520a660352d75595a050d1299bf0e3ee4a8cf55ded36aea2.yml -openapi_spec_hash: 8d0e1115a7d864f27c55cec3255d1e77 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-1a8a7dda98ab9f3c537f46c6192baed039be8f5680d3b9cc2cc227d5b06059ea.yml +openapi_spec_hash: 286076163f3b5111b915830dd21cc469 config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 From f07badc8bf3ef80fe032793339c05cb1f74fe2c2 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sun, 5 Apr 2026 03:10:26 +0000 Subject: [PATCH 02/82] feat(api): api update --- .stats.yml | 4 +- README.md | 10 +- .../brand_identify_from_transaction_params.rb | 65 ++ ...rand_identify_from_transaction_response.rb | 145 +++- .../models/brand_retrieve_by_email_params.rb | 65 ++ .../brand_retrieve_by_email_response.rb | 145 +++- .../models/brand_retrieve_by_isin_params.rb | 65 ++ .../models/brand_retrieve_by_isin_response.rb | 145 +++- .../models/brand_retrieve_by_name_params.rb | 65 ++ .../models/brand_retrieve_by_name_response.rb | 145 +++- .../models/brand_retrieve_by_ticker_params.rb | 65 ++ .../brand_retrieve_by_ticker_response.rb | 145 +++- lib/brand_dev/models/brand_retrieve_params.rb | 73 +- .../models/brand_retrieve_response.rb | 145 +++- lib/brand_dev/resources/brand.rb | 2 +- ...brand_identify_from_transaction_params.rbi | 325 +++++++++ ...and_identify_from_transaction_response.rbi | 648 ++++++++++++++++++ .../models/brand_retrieve_by_email_params.rbi | 325 +++++++++ .../brand_retrieve_by_email_response.rbi | 648 ++++++++++++++++++ .../models/brand_retrieve_by_isin_params.rbi | 325 +++++++++ .../brand_retrieve_by_isin_response.rbi | 648 ++++++++++++++++++ .../models/brand_retrieve_by_name_params.rbi | 325 +++++++++ .../brand_retrieve_by_name_response.rbi | 648 ++++++++++++++++++ .../brand_retrieve_by_ticker_params.rbi | 325 +++++++++ .../brand_retrieve_by_ticker_response.rbi | 648 ++++++++++++++++++ .../models/brand_retrieve_params.rbi | 334 ++++++++- .../models/brand_retrieve_response.rbi | 648 ++++++++++++++++++ rbi/brand_dev/resources/brand.rbi | 3 +- ...brand_identify_from_transaction_params.rbs | 132 +++- ...and_identify_from_transaction_response.rbs | 254 +++++++ .../models/brand_retrieve_by_email_params.rbs | 132 +++- .../brand_retrieve_by_email_response.rbs | 254 +++++++ .../models/brand_retrieve_by_isin_params.rbs | 132 +++- .../brand_retrieve_by_isin_response.rbs | 254 +++++++ .../models/brand_retrieve_by_name_params.rbs | 132 +++- .../brand_retrieve_by_name_response.rbs | 254 +++++++ .../brand_retrieve_by_ticker_params.rbs | 132 +++- .../brand_retrieve_by_ticker_response.rbs | 254 +++++++ .../models/brand_retrieve_params.rbs | 132 +++- .../models/brand_retrieve_response.rbs | 254 +++++++ 40 files changed, 9417 insertions(+), 33 deletions(-) diff --git a/.stats.yml b/.stats.yml index 7569808..7c16337 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 20 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-1a8a7dda98ab9f3c537f46c6192baed039be8f5680d3b9cc2cc227d5b06059ea.yml -openapi_spec_hash: 286076163f3b5111b915830dd21cc469 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-095758df21a0bad753cde157cc0216339f77aec5b01de9bf36d55e34770cb611.yml +openapi_spec_hash: 4d5456700d25c12524ca030bb93d4261 config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 diff --git a/README.md b/README.md index 6ac788c..98e040f 100644 --- a/README.md +++ b/README.md @@ -206,11 +206,11 @@ brand_dev.brand.retrieve(**params) Since this library does not depend on `sorbet-runtime`, it cannot provide [`T::Enum`](https://sorbet.org/docs/tenum) instances. Instead, we provide "tagged symbols" instead, which is always a primitive at runtime: ```ruby -# :albanian -puts(BrandDev::BrandRetrieveParams::ForceLanguage::ALBANIAN) +# :afrikaans +puts(BrandDev::BrandRetrieveParams::ForceLanguage::AFRIKAANS) # Revealed type: `T.all(BrandDev::BrandRetrieveParams::ForceLanguage, Symbol)` -T.reveal_type(BrandDev::BrandRetrieveParams::ForceLanguage::ALBANIAN) +T.reveal_type(BrandDev::BrandRetrieveParams::ForceLanguage::AFRIKAANS) ``` Enum parameters have a "relaxed" type, so you can either pass in enum constants or their literal value: @@ -218,13 +218,13 @@ Enum parameters have a "relaxed" type, so you can either pass in enum constants ```ruby # Using the enum constants preserves the tagged type information: brand_dev.brand.retrieve( - force_language: BrandDev::BrandRetrieveParams::ForceLanguage::ALBANIAN, + force_language: BrandDev::BrandRetrieveParams::ForceLanguage::AFRIKAANS, # … ) # Literal values are also permissible: brand_dev.brand.retrieve( - force_language: :albanian, + force_language: :afrikaans, # … ) ``` diff --git a/lib/brand_dev/models/brand_identify_from_transaction_params.rb b/lib/brand_dev/models/brand_identify_from_transaction_params.rb index 4b2fa45..86e8cbb 100644 --- a/lib/brand_dev/models/brand_identify_from_transaction_params.rb +++ b/lib/brand_dev/models/brand_identify_from_transaction_params.rb @@ -346,61 +346,126 @@ module CountryGl module ForceLanguage extend BrandDev::Internal::Type::Enum + AFRIKAANS = :afrikaans ALBANIAN = :albanian + AMHARIC = :amharic ARABIC = :arabic + ARMENIAN = :armenian + ASSAMESE = :assamese + AYMARA = :aymara AZERI = :azeri + BASQUE = :basque + BELARUSIAN = :belarusian BENGALI = :bengali + BOSNIAN = :bosnian BULGARIAN = :bulgarian + BURMESE = :burmese CANTONESE = :cantonese + CATALAN = :catalan CEBUANO = :cebuano + CHINESE = :chinese + CORSICAN = :corsican CROATIAN = :croatian CZECH = :czech DANISH = :danish DUTCH = :dutch ENGLISH = :english + ESPERANTO = :esperanto ESTONIAN = :estonian FARSI = :farsi + FIJIAN = :fijian FINNISH = :finnish FRENCH = :french + GALICIAN = :galician + GEORGIAN = :georgian GERMAN = :german + GREEK = :greek + GUARANI = :guarani + GUJARATI = :gujarati + HAITIAN_CREOLE = :"haitian-creole" HAUSA = :hausa HAWAIIAN = :hawaiian + HEBREW = :hebrew HINDI = :hindi + HMONG = :hmong HUNGARIAN = :hungarian ICELANDIC = :icelandic + IGBO = :igbo INDONESIAN = :indonesian + IRISH = :irish ITALIAN = :italian + JAPANESE = :japanese + JAVANESE = :javanese + KANNADA = :kannada KAZAKH = :kazakh + KHMER = :khmer + KINYARWANDA = :kinyarwanda KOREAN = :korean + KURDISH = :kurdish KYRGYZ = :kyrgyz + LAO = :lao LATIN = :latin LATVIAN = :latvian + LINGALA = :lingala LITHUANIAN = :lithuanian + LUXEMBOURGISH = :luxembourgish MACEDONIAN = :macedonian + MALAGASY = :malagasy + MALAY = :malay + MALAYALAM = :malayalam + MALTESE = :maltese + MAORI = :maori + MARATHI = :marathi MONGOLIAN = :mongolian NEPALI = :nepali NORWEGIAN = :norwegian + ODIA = :odia + OROMO = :oromo PASHTO = :pashto PIDGIN = :pidgin POLISH = :polish PORTUGUESE = :portuguese + PUNJABI = :punjabi + QUECHUA = :quechua ROMANIAN = :romanian RUSSIAN = :russian + SAMOAN = :samoan + SCOTTISH_GAELIC = :"scottish-gaelic" SERBIAN = :serbian + SESOTHO = :sesotho + SHONA = :shona + SINDHI = :sindhi + SINHALA = :sinhala SLOVAK = :slovak SLOVENE = :slovene SOMALI = :somali SPANISH = :spanish + SUNDANESE = :sundanese SWAHILI = :swahili SWEDISH = :swedish TAGALOG = :tagalog + TAJIK = :tajik + TAMIL = :tamil + TATAR = :tatar + TELUGU = :telugu THAI = :thai + TIBETAN = :tibetan + TIGRINYA = :tigrinya + TONGAN = :tongan + TSWANA = :tswana TURKISH = :turkish + TURKMEN = :turkmen UKRAINIAN = :ukrainian URDU = :urdu + UYGHUR = :uyghur UZBEK = :uzbek VIETNAMESE = :vietnamese WELSH = :welsh + WOLOF = :wolof + XHOSA = :xhosa + YIDDISH = :yiddish + YORUBA = :yoruba + ZULU = :zulu # @!method self.values # @return [Array] diff --git a/lib/brand_dev/models/brand_identify_from_transaction_response.rb b/lib/brand_dev/models/brand_identify_from_transaction_response.rb index bee60ee..5dfa38c 100644 --- a/lib/brand_dev/models/brand_identify_from_transaction_response.rb +++ b/lib/brand_dev/models/brand_identify_from_transaction_response.rb @@ -100,6 +100,15 @@ class Brand < BrandDev::Internal::Type::BaseModel # @return [String, nil] optional :phone, String + # @!attribute primary_language + # The primary language of the brand's website content. Detected from the HTML lang + # tag, page content analysis, or social media descriptions. + # + # @return [Symbol, BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage, nil] + optional :primary_language, + enum: -> { BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage }, + nil?: true + # @!attribute slogan # The brand's slogan # @@ -126,7 +135,7 @@ class Brand < BrandDev::Internal::Type::BaseModel # @return [String, nil] optional :title, String - # @!method initialize(address: nil, backdrops: nil, colors: nil, description: nil, domain: nil, email: nil, industries: nil, is_nsfw: nil, links: nil, logos: nil, phone: nil, slogan: nil, socials: nil, stock: nil, title: nil) + # @!method initialize(address: nil, backdrops: nil, colors: nil, description: nil, domain: nil, email: nil, industries: nil, is_nsfw: nil, links: nil, logos: nil, phone: nil, primary_language: nil, slogan: nil, socials: nil, stock: nil, title: nil) # Some parameter documentations has been truncated, see # {BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand} for more # details. @@ -155,6 +164,8 @@ class Brand < BrandDev::Internal::Type::BaseModel # # @param phone [String] Company phone number # + # @param primary_language [Symbol, BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage, nil] The primary language of the brand's website content. Detected from the HTML lang + # # @param slogan [String] The brand's slogan # # @param socials [Array] An array of social media links for the brand @@ -807,6 +818,138 @@ module Type end end + # The primary language of the brand's website content. Detected from the HTML lang + # tag, page content analysis, or social media descriptions. + # + # @see BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand#primary_language + module PrimaryLanguage + extend BrandDev::Internal::Type::Enum + + AFRIKAANS = :afrikaans + ALBANIAN = :albanian + AMHARIC = :amharic + ARABIC = :arabic + ARMENIAN = :armenian + ASSAMESE = :assamese + AYMARA = :aymara + AZERI = :azeri + BASQUE = :basque + BELARUSIAN = :belarusian + BENGALI = :bengali + BOSNIAN = :bosnian + BULGARIAN = :bulgarian + BURMESE = :burmese + CANTONESE = :cantonese + CATALAN = :catalan + CEBUANO = :cebuano + CHINESE = :chinese + CORSICAN = :corsican + CROATIAN = :croatian + CZECH = :czech + DANISH = :danish + DUTCH = :dutch + ENGLISH = :english + ESPERANTO = :esperanto + ESTONIAN = :estonian + FARSI = :farsi + FIJIAN = :fijian + FINNISH = :finnish + FRENCH = :french + GALICIAN = :galician + GEORGIAN = :georgian + GERMAN = :german + GREEK = :greek + GUARANI = :guarani + GUJARATI = :gujarati + HAITIAN_CREOLE = :"haitian-creole" + HAUSA = :hausa + HAWAIIAN = :hawaiian + HEBREW = :hebrew + HINDI = :hindi + HMONG = :hmong + HUNGARIAN = :hungarian + ICELANDIC = :icelandic + IGBO = :igbo + INDONESIAN = :indonesian + IRISH = :irish + ITALIAN = :italian + JAPANESE = :japanese + JAVANESE = :javanese + KANNADA = :kannada + KAZAKH = :kazakh + KHMER = :khmer + KINYARWANDA = :kinyarwanda + KOREAN = :korean + KURDISH = :kurdish + KYRGYZ = :kyrgyz + LAO = :lao + LATIN = :latin + LATVIAN = :latvian + LINGALA = :lingala + LITHUANIAN = :lithuanian + LUXEMBOURGISH = :luxembourgish + MACEDONIAN = :macedonian + MALAGASY = :malagasy + MALAY = :malay + MALAYALAM = :malayalam + MALTESE = :maltese + MAORI = :maori + MARATHI = :marathi + MONGOLIAN = :mongolian + NEPALI = :nepali + NORWEGIAN = :norwegian + ODIA = :odia + OROMO = :oromo + PASHTO = :pashto + PIDGIN = :pidgin + POLISH = :polish + PORTUGUESE = :portuguese + PUNJABI = :punjabi + QUECHUA = :quechua + ROMANIAN = :romanian + RUSSIAN = :russian + SAMOAN = :samoan + SCOTTISH_GAELIC = :"scottish-gaelic" + SERBIAN = :serbian + SESOTHO = :sesotho + SHONA = :shona + SINDHI = :sindhi + SINHALA = :sinhala + SLOVAK = :slovak + SLOVENE = :slovene + SOMALI = :somali + SPANISH = :spanish + SUNDANESE = :sundanese + SWAHILI = :swahili + SWEDISH = :swedish + TAGALOG = :tagalog + TAJIK = :tajik + TAMIL = :tamil + TATAR = :tatar + TELUGU = :telugu + THAI = :thai + TIBETAN = :tibetan + TIGRINYA = :tigrinya + TONGAN = :tongan + TSWANA = :tswana + TURKISH = :turkish + TURKMEN = :turkmen + UKRAINIAN = :ukrainian + URDU = :urdu + UYGHUR = :uyghur + UZBEK = :uzbek + VIETNAMESE = :vietnamese + WELSH = :welsh + WOLOF = :wolof + XHOSA = :xhosa + YIDDISH = :yiddish + YORUBA = :yoruba + ZULU = :zulu + + # @!method self.values + # @return [Array] + end + class Social < BrandDev::Internal::Type::BaseModel # @!attribute type # Type of social media, e.g., 'facebook', 'twitter' diff --git a/lib/brand_dev/models/brand_retrieve_by_email_params.rb b/lib/brand_dev/models/brand_retrieve_by_email_params.rb index 645024a..c372bea 100644 --- a/lib/brand_dev/models/brand_retrieve_by_email_params.rb +++ b/lib/brand_dev/models/brand_retrieve_by_email_params.rb @@ -55,61 +55,126 @@ class BrandRetrieveByEmailParams < BrandDev::Internal::Type::BaseModel module ForceLanguage extend BrandDev::Internal::Type::Enum + AFRIKAANS = :afrikaans ALBANIAN = :albanian + AMHARIC = :amharic ARABIC = :arabic + ARMENIAN = :armenian + ASSAMESE = :assamese + AYMARA = :aymara AZERI = :azeri + BASQUE = :basque + BELARUSIAN = :belarusian BENGALI = :bengali + BOSNIAN = :bosnian BULGARIAN = :bulgarian + BURMESE = :burmese CANTONESE = :cantonese + CATALAN = :catalan CEBUANO = :cebuano + CHINESE = :chinese + CORSICAN = :corsican CROATIAN = :croatian CZECH = :czech DANISH = :danish DUTCH = :dutch ENGLISH = :english + ESPERANTO = :esperanto ESTONIAN = :estonian FARSI = :farsi + FIJIAN = :fijian FINNISH = :finnish FRENCH = :french + GALICIAN = :galician + GEORGIAN = :georgian GERMAN = :german + GREEK = :greek + GUARANI = :guarani + GUJARATI = :gujarati + HAITIAN_CREOLE = :"haitian-creole" HAUSA = :hausa HAWAIIAN = :hawaiian + HEBREW = :hebrew HINDI = :hindi + HMONG = :hmong HUNGARIAN = :hungarian ICELANDIC = :icelandic + IGBO = :igbo INDONESIAN = :indonesian + IRISH = :irish ITALIAN = :italian + JAPANESE = :japanese + JAVANESE = :javanese + KANNADA = :kannada KAZAKH = :kazakh + KHMER = :khmer + KINYARWANDA = :kinyarwanda KOREAN = :korean + KURDISH = :kurdish KYRGYZ = :kyrgyz + LAO = :lao LATIN = :latin LATVIAN = :latvian + LINGALA = :lingala LITHUANIAN = :lithuanian + LUXEMBOURGISH = :luxembourgish MACEDONIAN = :macedonian + MALAGASY = :malagasy + MALAY = :malay + MALAYALAM = :malayalam + MALTESE = :maltese + MAORI = :maori + MARATHI = :marathi MONGOLIAN = :mongolian NEPALI = :nepali NORWEGIAN = :norwegian + ODIA = :odia + OROMO = :oromo PASHTO = :pashto PIDGIN = :pidgin POLISH = :polish PORTUGUESE = :portuguese + PUNJABI = :punjabi + QUECHUA = :quechua ROMANIAN = :romanian RUSSIAN = :russian + SAMOAN = :samoan + SCOTTISH_GAELIC = :"scottish-gaelic" SERBIAN = :serbian + SESOTHO = :sesotho + SHONA = :shona + SINDHI = :sindhi + SINHALA = :sinhala SLOVAK = :slovak SLOVENE = :slovene SOMALI = :somali SPANISH = :spanish + SUNDANESE = :sundanese SWAHILI = :swahili SWEDISH = :swedish TAGALOG = :tagalog + TAJIK = :tajik + TAMIL = :tamil + TATAR = :tatar + TELUGU = :telugu THAI = :thai + TIBETAN = :tibetan + TIGRINYA = :tigrinya + TONGAN = :tongan + TSWANA = :tswana TURKISH = :turkish + TURKMEN = :turkmen UKRAINIAN = :ukrainian URDU = :urdu + UYGHUR = :uyghur UZBEK = :uzbek VIETNAMESE = :vietnamese WELSH = :welsh + WOLOF = :wolof + XHOSA = :xhosa + YIDDISH = :yiddish + YORUBA = :yoruba + ZULU = :zulu # @!method self.values # @return [Array] diff --git a/lib/brand_dev/models/brand_retrieve_by_email_response.rb b/lib/brand_dev/models/brand_retrieve_by_email_response.rb index 5971498..81b0666 100644 --- a/lib/brand_dev/models/brand_retrieve_by_email_response.rb +++ b/lib/brand_dev/models/brand_retrieve_by_email_response.rb @@ -100,6 +100,15 @@ class Brand < BrandDev::Internal::Type::BaseModel # @return [String, nil] optional :phone, String + # @!attribute primary_language + # The primary language of the brand's website content. Detected from the HTML lang + # tag, page content analysis, or social media descriptions. + # + # @return [Symbol, BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage, nil] + optional :primary_language, + enum: -> { BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage }, + nil?: true + # @!attribute slogan # The brand's slogan # @@ -126,7 +135,7 @@ class Brand < BrandDev::Internal::Type::BaseModel # @return [String, nil] optional :title, String - # @!method initialize(address: nil, backdrops: nil, colors: nil, description: nil, domain: nil, email: nil, industries: nil, is_nsfw: nil, links: nil, logos: nil, phone: nil, slogan: nil, socials: nil, stock: nil, title: nil) + # @!method initialize(address: nil, backdrops: nil, colors: nil, description: nil, domain: nil, email: nil, industries: nil, is_nsfw: nil, links: nil, logos: nil, phone: nil, primary_language: nil, slogan: nil, socials: nil, stock: nil, title: nil) # Some parameter documentations has been truncated, see # {BrandDev::Models::BrandRetrieveByEmailResponse::Brand} for more details. # @@ -154,6 +163,8 @@ class Brand < BrandDev::Internal::Type::BaseModel # # @param phone [String] Company phone number # + # @param primary_language [Symbol, BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage, nil] The primary language of the brand's website content. Detected from the HTML lang + # # @param slogan [String] The brand's slogan # # @param socials [Array] An array of social media links for the brand @@ -803,6 +814,138 @@ module Type end end + # The primary language of the brand's website content. Detected from the HTML lang + # tag, page content analysis, or social media descriptions. + # + # @see BrandDev::Models::BrandRetrieveByEmailResponse::Brand#primary_language + module PrimaryLanguage + extend BrandDev::Internal::Type::Enum + + AFRIKAANS = :afrikaans + ALBANIAN = :albanian + AMHARIC = :amharic + ARABIC = :arabic + ARMENIAN = :armenian + ASSAMESE = :assamese + AYMARA = :aymara + AZERI = :azeri + BASQUE = :basque + BELARUSIAN = :belarusian + BENGALI = :bengali + BOSNIAN = :bosnian + BULGARIAN = :bulgarian + BURMESE = :burmese + CANTONESE = :cantonese + CATALAN = :catalan + CEBUANO = :cebuano + CHINESE = :chinese + CORSICAN = :corsican + CROATIAN = :croatian + CZECH = :czech + DANISH = :danish + DUTCH = :dutch + ENGLISH = :english + ESPERANTO = :esperanto + ESTONIAN = :estonian + FARSI = :farsi + FIJIAN = :fijian + FINNISH = :finnish + FRENCH = :french + GALICIAN = :galician + GEORGIAN = :georgian + GERMAN = :german + GREEK = :greek + GUARANI = :guarani + GUJARATI = :gujarati + HAITIAN_CREOLE = :"haitian-creole" + HAUSA = :hausa + HAWAIIAN = :hawaiian + HEBREW = :hebrew + HINDI = :hindi + HMONG = :hmong + HUNGARIAN = :hungarian + ICELANDIC = :icelandic + IGBO = :igbo + INDONESIAN = :indonesian + IRISH = :irish + ITALIAN = :italian + JAPANESE = :japanese + JAVANESE = :javanese + KANNADA = :kannada + KAZAKH = :kazakh + KHMER = :khmer + KINYARWANDA = :kinyarwanda + KOREAN = :korean + KURDISH = :kurdish + KYRGYZ = :kyrgyz + LAO = :lao + LATIN = :latin + LATVIAN = :latvian + LINGALA = :lingala + LITHUANIAN = :lithuanian + LUXEMBOURGISH = :luxembourgish + MACEDONIAN = :macedonian + MALAGASY = :malagasy + MALAY = :malay + MALAYALAM = :malayalam + MALTESE = :maltese + MAORI = :maori + MARATHI = :marathi + MONGOLIAN = :mongolian + NEPALI = :nepali + NORWEGIAN = :norwegian + ODIA = :odia + OROMO = :oromo + PASHTO = :pashto + PIDGIN = :pidgin + POLISH = :polish + PORTUGUESE = :portuguese + PUNJABI = :punjabi + QUECHUA = :quechua + ROMANIAN = :romanian + RUSSIAN = :russian + SAMOAN = :samoan + SCOTTISH_GAELIC = :"scottish-gaelic" + SERBIAN = :serbian + SESOTHO = :sesotho + SHONA = :shona + SINDHI = :sindhi + SINHALA = :sinhala + SLOVAK = :slovak + SLOVENE = :slovene + SOMALI = :somali + SPANISH = :spanish + SUNDANESE = :sundanese + SWAHILI = :swahili + SWEDISH = :swedish + TAGALOG = :tagalog + TAJIK = :tajik + TAMIL = :tamil + TATAR = :tatar + TELUGU = :telugu + THAI = :thai + TIBETAN = :tibetan + TIGRINYA = :tigrinya + TONGAN = :tongan + TSWANA = :tswana + TURKISH = :turkish + TURKMEN = :turkmen + UKRAINIAN = :ukrainian + URDU = :urdu + UYGHUR = :uyghur + UZBEK = :uzbek + VIETNAMESE = :vietnamese + WELSH = :welsh + WOLOF = :wolof + XHOSA = :xhosa + YIDDISH = :yiddish + YORUBA = :yoruba + ZULU = :zulu + + # @!method self.values + # @return [Array] + end + class Social < BrandDev::Internal::Type::BaseModel # @!attribute type # Type of social media, e.g., 'facebook', 'twitter' diff --git a/lib/brand_dev/models/brand_retrieve_by_isin_params.rb b/lib/brand_dev/models/brand_retrieve_by_isin_params.rb index 563edf8..47f176e 100644 --- a/lib/brand_dev/models/brand_retrieve_by_isin_params.rb +++ b/lib/brand_dev/models/brand_retrieve_by_isin_params.rb @@ -55,61 +55,126 @@ class BrandRetrieveByIsinParams < BrandDev::Internal::Type::BaseModel module ForceLanguage extend BrandDev::Internal::Type::Enum + AFRIKAANS = :afrikaans ALBANIAN = :albanian + AMHARIC = :amharic ARABIC = :arabic + ARMENIAN = :armenian + ASSAMESE = :assamese + AYMARA = :aymara AZERI = :azeri + BASQUE = :basque + BELARUSIAN = :belarusian BENGALI = :bengali + BOSNIAN = :bosnian BULGARIAN = :bulgarian + BURMESE = :burmese CANTONESE = :cantonese + CATALAN = :catalan CEBUANO = :cebuano + CHINESE = :chinese + CORSICAN = :corsican CROATIAN = :croatian CZECH = :czech DANISH = :danish DUTCH = :dutch ENGLISH = :english + ESPERANTO = :esperanto ESTONIAN = :estonian FARSI = :farsi + FIJIAN = :fijian FINNISH = :finnish FRENCH = :french + GALICIAN = :galician + GEORGIAN = :georgian GERMAN = :german + GREEK = :greek + GUARANI = :guarani + GUJARATI = :gujarati + HAITIAN_CREOLE = :"haitian-creole" HAUSA = :hausa HAWAIIAN = :hawaiian + HEBREW = :hebrew HINDI = :hindi + HMONG = :hmong HUNGARIAN = :hungarian ICELANDIC = :icelandic + IGBO = :igbo INDONESIAN = :indonesian + IRISH = :irish ITALIAN = :italian + JAPANESE = :japanese + JAVANESE = :javanese + KANNADA = :kannada KAZAKH = :kazakh + KHMER = :khmer + KINYARWANDA = :kinyarwanda KOREAN = :korean + KURDISH = :kurdish KYRGYZ = :kyrgyz + LAO = :lao LATIN = :latin LATVIAN = :latvian + LINGALA = :lingala LITHUANIAN = :lithuanian + LUXEMBOURGISH = :luxembourgish MACEDONIAN = :macedonian + MALAGASY = :malagasy + MALAY = :malay + MALAYALAM = :malayalam + MALTESE = :maltese + MAORI = :maori + MARATHI = :marathi MONGOLIAN = :mongolian NEPALI = :nepali NORWEGIAN = :norwegian + ODIA = :odia + OROMO = :oromo PASHTO = :pashto PIDGIN = :pidgin POLISH = :polish PORTUGUESE = :portuguese + PUNJABI = :punjabi + QUECHUA = :quechua ROMANIAN = :romanian RUSSIAN = :russian + SAMOAN = :samoan + SCOTTISH_GAELIC = :"scottish-gaelic" SERBIAN = :serbian + SESOTHO = :sesotho + SHONA = :shona + SINDHI = :sindhi + SINHALA = :sinhala SLOVAK = :slovak SLOVENE = :slovene SOMALI = :somali SPANISH = :spanish + SUNDANESE = :sundanese SWAHILI = :swahili SWEDISH = :swedish TAGALOG = :tagalog + TAJIK = :tajik + TAMIL = :tamil + TATAR = :tatar + TELUGU = :telugu THAI = :thai + TIBETAN = :tibetan + TIGRINYA = :tigrinya + TONGAN = :tongan + TSWANA = :tswana TURKISH = :turkish + TURKMEN = :turkmen UKRAINIAN = :ukrainian URDU = :urdu + UYGHUR = :uyghur UZBEK = :uzbek VIETNAMESE = :vietnamese WELSH = :welsh + WOLOF = :wolof + XHOSA = :xhosa + YIDDISH = :yiddish + YORUBA = :yoruba + ZULU = :zulu # @!method self.values # @return [Array] diff --git a/lib/brand_dev/models/brand_retrieve_by_isin_response.rb b/lib/brand_dev/models/brand_retrieve_by_isin_response.rb index 986b1c8..692656b 100644 --- a/lib/brand_dev/models/brand_retrieve_by_isin_response.rb +++ b/lib/brand_dev/models/brand_retrieve_by_isin_response.rb @@ -100,6 +100,15 @@ class Brand < BrandDev::Internal::Type::BaseModel # @return [String, nil] optional :phone, String + # @!attribute primary_language + # The primary language of the brand's website content. Detected from the HTML lang + # tag, page content analysis, or social media descriptions. + # + # @return [Symbol, BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage, nil] + optional :primary_language, + enum: -> { BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage }, + nil?: true + # @!attribute slogan # The brand's slogan # @@ -126,7 +135,7 @@ class Brand < BrandDev::Internal::Type::BaseModel # @return [String, nil] optional :title, String - # @!method initialize(address: nil, backdrops: nil, colors: nil, description: nil, domain: nil, email: nil, industries: nil, is_nsfw: nil, links: nil, logos: nil, phone: nil, slogan: nil, socials: nil, stock: nil, title: nil) + # @!method initialize(address: nil, backdrops: nil, colors: nil, description: nil, domain: nil, email: nil, industries: nil, is_nsfw: nil, links: nil, logos: nil, phone: nil, primary_language: nil, slogan: nil, socials: nil, stock: nil, title: nil) # Some parameter documentations has been truncated, see # {BrandDev::Models::BrandRetrieveByIsinResponse::Brand} for more details. # @@ -154,6 +163,8 @@ class Brand < BrandDev::Internal::Type::BaseModel # # @param phone [String] Company phone number # + # @param primary_language [Symbol, BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage, nil] The primary language of the brand's website content. Detected from the HTML lang + # # @param slogan [String] The brand's slogan # # @param socials [Array] An array of social media links for the brand @@ -803,6 +814,138 @@ module Type end end + # The primary language of the brand's website content. Detected from the HTML lang + # tag, page content analysis, or social media descriptions. + # + # @see BrandDev::Models::BrandRetrieveByIsinResponse::Brand#primary_language + module PrimaryLanguage + extend BrandDev::Internal::Type::Enum + + AFRIKAANS = :afrikaans + ALBANIAN = :albanian + AMHARIC = :amharic + ARABIC = :arabic + ARMENIAN = :armenian + ASSAMESE = :assamese + AYMARA = :aymara + AZERI = :azeri + BASQUE = :basque + BELARUSIAN = :belarusian + BENGALI = :bengali + BOSNIAN = :bosnian + BULGARIAN = :bulgarian + BURMESE = :burmese + CANTONESE = :cantonese + CATALAN = :catalan + CEBUANO = :cebuano + CHINESE = :chinese + CORSICAN = :corsican + CROATIAN = :croatian + CZECH = :czech + DANISH = :danish + DUTCH = :dutch + ENGLISH = :english + ESPERANTO = :esperanto + ESTONIAN = :estonian + FARSI = :farsi + FIJIAN = :fijian + FINNISH = :finnish + FRENCH = :french + GALICIAN = :galician + GEORGIAN = :georgian + GERMAN = :german + GREEK = :greek + GUARANI = :guarani + GUJARATI = :gujarati + HAITIAN_CREOLE = :"haitian-creole" + HAUSA = :hausa + HAWAIIAN = :hawaiian + HEBREW = :hebrew + HINDI = :hindi + HMONG = :hmong + HUNGARIAN = :hungarian + ICELANDIC = :icelandic + IGBO = :igbo + INDONESIAN = :indonesian + IRISH = :irish + ITALIAN = :italian + JAPANESE = :japanese + JAVANESE = :javanese + KANNADA = :kannada + KAZAKH = :kazakh + KHMER = :khmer + KINYARWANDA = :kinyarwanda + KOREAN = :korean + KURDISH = :kurdish + KYRGYZ = :kyrgyz + LAO = :lao + LATIN = :latin + LATVIAN = :latvian + LINGALA = :lingala + LITHUANIAN = :lithuanian + LUXEMBOURGISH = :luxembourgish + MACEDONIAN = :macedonian + MALAGASY = :malagasy + MALAY = :malay + MALAYALAM = :malayalam + MALTESE = :maltese + MAORI = :maori + MARATHI = :marathi + MONGOLIAN = :mongolian + NEPALI = :nepali + NORWEGIAN = :norwegian + ODIA = :odia + OROMO = :oromo + PASHTO = :pashto + PIDGIN = :pidgin + POLISH = :polish + PORTUGUESE = :portuguese + PUNJABI = :punjabi + QUECHUA = :quechua + ROMANIAN = :romanian + RUSSIAN = :russian + SAMOAN = :samoan + SCOTTISH_GAELIC = :"scottish-gaelic" + SERBIAN = :serbian + SESOTHO = :sesotho + SHONA = :shona + SINDHI = :sindhi + SINHALA = :sinhala + SLOVAK = :slovak + SLOVENE = :slovene + SOMALI = :somali + SPANISH = :spanish + SUNDANESE = :sundanese + SWAHILI = :swahili + SWEDISH = :swedish + TAGALOG = :tagalog + TAJIK = :tajik + TAMIL = :tamil + TATAR = :tatar + TELUGU = :telugu + THAI = :thai + TIBETAN = :tibetan + TIGRINYA = :tigrinya + TONGAN = :tongan + TSWANA = :tswana + TURKISH = :turkish + TURKMEN = :turkmen + UKRAINIAN = :ukrainian + URDU = :urdu + UYGHUR = :uyghur + UZBEK = :uzbek + VIETNAMESE = :vietnamese + WELSH = :welsh + WOLOF = :wolof + XHOSA = :xhosa + YIDDISH = :yiddish + YORUBA = :yoruba + ZULU = :zulu + + # @!method self.values + # @return [Array] + end + class Social < BrandDev::Internal::Type::BaseModel # @!attribute type # Type of social media, e.g., 'facebook', 'twitter' diff --git a/lib/brand_dev/models/brand_retrieve_by_name_params.rb b/lib/brand_dev/models/brand_retrieve_by_name_params.rb index 7502dcb..b73a58b 100644 --- a/lib/brand_dev/models/brand_retrieve_by_name_params.rb +++ b/lib/brand_dev/models/brand_retrieve_by_name_params.rb @@ -312,61 +312,126 @@ module CountryGl module ForceLanguage extend BrandDev::Internal::Type::Enum + AFRIKAANS = :afrikaans ALBANIAN = :albanian + AMHARIC = :amharic ARABIC = :arabic + ARMENIAN = :armenian + ASSAMESE = :assamese + AYMARA = :aymara AZERI = :azeri + BASQUE = :basque + BELARUSIAN = :belarusian BENGALI = :bengali + BOSNIAN = :bosnian BULGARIAN = :bulgarian + BURMESE = :burmese CANTONESE = :cantonese + CATALAN = :catalan CEBUANO = :cebuano + CHINESE = :chinese + CORSICAN = :corsican CROATIAN = :croatian CZECH = :czech DANISH = :danish DUTCH = :dutch ENGLISH = :english + ESPERANTO = :esperanto ESTONIAN = :estonian FARSI = :farsi + FIJIAN = :fijian FINNISH = :finnish FRENCH = :french + GALICIAN = :galician + GEORGIAN = :georgian GERMAN = :german + GREEK = :greek + GUARANI = :guarani + GUJARATI = :gujarati + HAITIAN_CREOLE = :"haitian-creole" HAUSA = :hausa HAWAIIAN = :hawaiian + HEBREW = :hebrew HINDI = :hindi + HMONG = :hmong HUNGARIAN = :hungarian ICELANDIC = :icelandic + IGBO = :igbo INDONESIAN = :indonesian + IRISH = :irish ITALIAN = :italian + JAPANESE = :japanese + JAVANESE = :javanese + KANNADA = :kannada KAZAKH = :kazakh + KHMER = :khmer + KINYARWANDA = :kinyarwanda KOREAN = :korean + KURDISH = :kurdish KYRGYZ = :kyrgyz + LAO = :lao LATIN = :latin LATVIAN = :latvian + LINGALA = :lingala LITHUANIAN = :lithuanian + LUXEMBOURGISH = :luxembourgish MACEDONIAN = :macedonian + MALAGASY = :malagasy + MALAY = :malay + MALAYALAM = :malayalam + MALTESE = :maltese + MAORI = :maori + MARATHI = :marathi MONGOLIAN = :mongolian NEPALI = :nepali NORWEGIAN = :norwegian + ODIA = :odia + OROMO = :oromo PASHTO = :pashto PIDGIN = :pidgin POLISH = :polish PORTUGUESE = :portuguese + PUNJABI = :punjabi + QUECHUA = :quechua ROMANIAN = :romanian RUSSIAN = :russian + SAMOAN = :samoan + SCOTTISH_GAELIC = :"scottish-gaelic" SERBIAN = :serbian + SESOTHO = :sesotho + SHONA = :shona + SINDHI = :sindhi + SINHALA = :sinhala SLOVAK = :slovak SLOVENE = :slovene SOMALI = :somali SPANISH = :spanish + SUNDANESE = :sundanese SWAHILI = :swahili SWEDISH = :swedish TAGALOG = :tagalog + TAJIK = :tajik + TAMIL = :tamil + TATAR = :tatar + TELUGU = :telugu THAI = :thai + TIBETAN = :tibetan + TIGRINYA = :tigrinya + TONGAN = :tongan + TSWANA = :tswana TURKISH = :turkish + TURKMEN = :turkmen UKRAINIAN = :ukrainian URDU = :urdu + UYGHUR = :uyghur UZBEK = :uzbek VIETNAMESE = :vietnamese WELSH = :welsh + WOLOF = :wolof + XHOSA = :xhosa + YIDDISH = :yiddish + YORUBA = :yoruba + ZULU = :zulu # @!method self.values # @return [Array] diff --git a/lib/brand_dev/models/brand_retrieve_by_name_response.rb b/lib/brand_dev/models/brand_retrieve_by_name_response.rb index f53537c..9272bc2 100644 --- a/lib/brand_dev/models/brand_retrieve_by_name_response.rb +++ b/lib/brand_dev/models/brand_retrieve_by_name_response.rb @@ -100,6 +100,15 @@ class Brand < BrandDev::Internal::Type::BaseModel # @return [String, nil] optional :phone, String + # @!attribute primary_language + # The primary language of the brand's website content. Detected from the HTML lang + # tag, page content analysis, or social media descriptions. + # + # @return [Symbol, BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage, nil] + optional :primary_language, + enum: -> { BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage }, + nil?: true + # @!attribute slogan # The brand's slogan # @@ -126,7 +135,7 @@ class Brand < BrandDev::Internal::Type::BaseModel # @return [String, nil] optional :title, String - # @!method initialize(address: nil, backdrops: nil, colors: nil, description: nil, domain: nil, email: nil, industries: nil, is_nsfw: nil, links: nil, logos: nil, phone: nil, slogan: nil, socials: nil, stock: nil, title: nil) + # @!method initialize(address: nil, backdrops: nil, colors: nil, description: nil, domain: nil, email: nil, industries: nil, is_nsfw: nil, links: nil, logos: nil, phone: nil, primary_language: nil, slogan: nil, socials: nil, stock: nil, title: nil) # Some parameter documentations has been truncated, see # {BrandDev::Models::BrandRetrieveByNameResponse::Brand} for more details. # @@ -154,6 +163,8 @@ class Brand < BrandDev::Internal::Type::BaseModel # # @param phone [String] Company phone number # + # @param primary_language [Symbol, BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage, nil] The primary language of the brand's website content. Detected from the HTML lang + # # @param slogan [String] The brand's slogan # # @param socials [Array] An array of social media links for the brand @@ -803,6 +814,138 @@ module Type end end + # The primary language of the brand's website content. Detected from the HTML lang + # tag, page content analysis, or social media descriptions. + # + # @see BrandDev::Models::BrandRetrieveByNameResponse::Brand#primary_language + module PrimaryLanguage + extend BrandDev::Internal::Type::Enum + + AFRIKAANS = :afrikaans + ALBANIAN = :albanian + AMHARIC = :amharic + ARABIC = :arabic + ARMENIAN = :armenian + ASSAMESE = :assamese + AYMARA = :aymara + AZERI = :azeri + BASQUE = :basque + BELARUSIAN = :belarusian + BENGALI = :bengali + BOSNIAN = :bosnian + BULGARIAN = :bulgarian + BURMESE = :burmese + CANTONESE = :cantonese + CATALAN = :catalan + CEBUANO = :cebuano + CHINESE = :chinese + CORSICAN = :corsican + CROATIAN = :croatian + CZECH = :czech + DANISH = :danish + DUTCH = :dutch + ENGLISH = :english + ESPERANTO = :esperanto + ESTONIAN = :estonian + FARSI = :farsi + FIJIAN = :fijian + FINNISH = :finnish + FRENCH = :french + GALICIAN = :galician + GEORGIAN = :georgian + GERMAN = :german + GREEK = :greek + GUARANI = :guarani + GUJARATI = :gujarati + HAITIAN_CREOLE = :"haitian-creole" + HAUSA = :hausa + HAWAIIAN = :hawaiian + HEBREW = :hebrew + HINDI = :hindi + HMONG = :hmong + HUNGARIAN = :hungarian + ICELANDIC = :icelandic + IGBO = :igbo + INDONESIAN = :indonesian + IRISH = :irish + ITALIAN = :italian + JAPANESE = :japanese + JAVANESE = :javanese + KANNADA = :kannada + KAZAKH = :kazakh + KHMER = :khmer + KINYARWANDA = :kinyarwanda + KOREAN = :korean + KURDISH = :kurdish + KYRGYZ = :kyrgyz + LAO = :lao + LATIN = :latin + LATVIAN = :latvian + LINGALA = :lingala + LITHUANIAN = :lithuanian + LUXEMBOURGISH = :luxembourgish + MACEDONIAN = :macedonian + MALAGASY = :malagasy + MALAY = :malay + MALAYALAM = :malayalam + MALTESE = :maltese + MAORI = :maori + MARATHI = :marathi + MONGOLIAN = :mongolian + NEPALI = :nepali + NORWEGIAN = :norwegian + ODIA = :odia + OROMO = :oromo + PASHTO = :pashto + PIDGIN = :pidgin + POLISH = :polish + PORTUGUESE = :portuguese + PUNJABI = :punjabi + QUECHUA = :quechua + ROMANIAN = :romanian + RUSSIAN = :russian + SAMOAN = :samoan + SCOTTISH_GAELIC = :"scottish-gaelic" + SERBIAN = :serbian + SESOTHO = :sesotho + SHONA = :shona + SINDHI = :sindhi + SINHALA = :sinhala + SLOVAK = :slovak + SLOVENE = :slovene + SOMALI = :somali + SPANISH = :spanish + SUNDANESE = :sundanese + SWAHILI = :swahili + SWEDISH = :swedish + TAGALOG = :tagalog + TAJIK = :tajik + TAMIL = :tamil + TATAR = :tatar + TELUGU = :telugu + THAI = :thai + TIBETAN = :tibetan + TIGRINYA = :tigrinya + TONGAN = :tongan + TSWANA = :tswana + TURKISH = :turkish + TURKMEN = :turkmen + UKRAINIAN = :ukrainian + URDU = :urdu + UYGHUR = :uyghur + UZBEK = :uzbek + VIETNAMESE = :vietnamese + WELSH = :welsh + WOLOF = :wolof + XHOSA = :xhosa + YIDDISH = :yiddish + YORUBA = :yoruba + ZULU = :zulu + + # @!method self.values + # @return [Array] + end + class Social < BrandDev::Internal::Type::BaseModel # @!attribute type # Type of social media, e.g., 'facebook', 'twitter' diff --git a/lib/brand_dev/models/brand_retrieve_by_ticker_params.rb b/lib/brand_dev/models/brand_retrieve_by_ticker_params.rb index 72ad6c6..4a8d6ff 100644 --- a/lib/brand_dev/models/brand_retrieve_by_ticker_params.rb +++ b/lib/brand_dev/models/brand_retrieve_by_ticker_params.rb @@ -62,61 +62,126 @@ class BrandRetrieveByTickerParams < BrandDev::Internal::Type::BaseModel module ForceLanguage extend BrandDev::Internal::Type::Enum + AFRIKAANS = :afrikaans ALBANIAN = :albanian + AMHARIC = :amharic ARABIC = :arabic + ARMENIAN = :armenian + ASSAMESE = :assamese + AYMARA = :aymara AZERI = :azeri + BASQUE = :basque + BELARUSIAN = :belarusian BENGALI = :bengali + BOSNIAN = :bosnian BULGARIAN = :bulgarian + BURMESE = :burmese CANTONESE = :cantonese + CATALAN = :catalan CEBUANO = :cebuano + CHINESE = :chinese + CORSICAN = :corsican CROATIAN = :croatian CZECH = :czech DANISH = :danish DUTCH = :dutch ENGLISH = :english + ESPERANTO = :esperanto ESTONIAN = :estonian FARSI = :farsi + FIJIAN = :fijian FINNISH = :finnish FRENCH = :french + GALICIAN = :galician + GEORGIAN = :georgian GERMAN = :german + GREEK = :greek + GUARANI = :guarani + GUJARATI = :gujarati + HAITIAN_CREOLE = :"haitian-creole" HAUSA = :hausa HAWAIIAN = :hawaiian + HEBREW = :hebrew HINDI = :hindi + HMONG = :hmong HUNGARIAN = :hungarian ICELANDIC = :icelandic + IGBO = :igbo INDONESIAN = :indonesian + IRISH = :irish ITALIAN = :italian + JAPANESE = :japanese + JAVANESE = :javanese + KANNADA = :kannada KAZAKH = :kazakh + KHMER = :khmer + KINYARWANDA = :kinyarwanda KOREAN = :korean + KURDISH = :kurdish KYRGYZ = :kyrgyz + LAO = :lao LATIN = :latin LATVIAN = :latvian + LINGALA = :lingala LITHUANIAN = :lithuanian + LUXEMBOURGISH = :luxembourgish MACEDONIAN = :macedonian + MALAGASY = :malagasy + MALAY = :malay + MALAYALAM = :malayalam + MALTESE = :maltese + MAORI = :maori + MARATHI = :marathi MONGOLIAN = :mongolian NEPALI = :nepali NORWEGIAN = :norwegian + ODIA = :odia + OROMO = :oromo PASHTO = :pashto PIDGIN = :pidgin POLISH = :polish PORTUGUESE = :portuguese + PUNJABI = :punjabi + QUECHUA = :quechua ROMANIAN = :romanian RUSSIAN = :russian + SAMOAN = :samoan + SCOTTISH_GAELIC = :"scottish-gaelic" SERBIAN = :serbian + SESOTHO = :sesotho + SHONA = :shona + SINDHI = :sindhi + SINHALA = :sinhala SLOVAK = :slovak SLOVENE = :slovene SOMALI = :somali SPANISH = :spanish + SUNDANESE = :sundanese SWAHILI = :swahili SWEDISH = :swedish TAGALOG = :tagalog + TAJIK = :tajik + TAMIL = :tamil + TATAR = :tatar + TELUGU = :telugu THAI = :thai + TIBETAN = :tibetan + TIGRINYA = :tigrinya + TONGAN = :tongan + TSWANA = :tswana TURKISH = :turkish + TURKMEN = :turkmen UKRAINIAN = :ukrainian URDU = :urdu + UYGHUR = :uyghur UZBEK = :uzbek VIETNAMESE = :vietnamese WELSH = :welsh + WOLOF = :wolof + XHOSA = :xhosa + YIDDISH = :yiddish + YORUBA = :yoruba + ZULU = :zulu # @!method self.values # @return [Array] diff --git a/lib/brand_dev/models/brand_retrieve_by_ticker_response.rb b/lib/brand_dev/models/brand_retrieve_by_ticker_response.rb index c5428f2..1ef699e 100644 --- a/lib/brand_dev/models/brand_retrieve_by_ticker_response.rb +++ b/lib/brand_dev/models/brand_retrieve_by_ticker_response.rb @@ -100,6 +100,15 @@ class Brand < BrandDev::Internal::Type::BaseModel # @return [String, nil] optional :phone, String + # @!attribute primary_language + # The primary language of the brand's website content. Detected from the HTML lang + # tag, page content analysis, or social media descriptions. + # + # @return [Symbol, BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage, nil] + optional :primary_language, + enum: -> { BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage }, + nil?: true + # @!attribute slogan # The brand's slogan # @@ -126,7 +135,7 @@ class Brand < BrandDev::Internal::Type::BaseModel # @return [String, nil] optional :title, String - # @!method initialize(address: nil, backdrops: nil, colors: nil, description: nil, domain: nil, email: nil, industries: nil, is_nsfw: nil, links: nil, logos: nil, phone: nil, slogan: nil, socials: nil, stock: nil, title: nil) + # @!method initialize(address: nil, backdrops: nil, colors: nil, description: nil, domain: nil, email: nil, industries: nil, is_nsfw: nil, links: nil, logos: nil, phone: nil, primary_language: nil, slogan: nil, socials: nil, stock: nil, title: nil) # Some parameter documentations has been truncated, see # {BrandDev::Models::BrandRetrieveByTickerResponse::Brand} for more details. # @@ -154,6 +163,8 @@ class Brand < BrandDev::Internal::Type::BaseModel # # @param phone [String] Company phone number # + # @param primary_language [Symbol, BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage, nil] The primary language of the brand's website content. Detected from the HTML lang + # # @param slogan [String] The brand's slogan # # @param socials [Array] An array of social media links for the brand @@ -803,6 +814,138 @@ module Type end end + # The primary language of the brand's website content. Detected from the HTML lang + # tag, page content analysis, or social media descriptions. + # + # @see BrandDev::Models::BrandRetrieveByTickerResponse::Brand#primary_language + module PrimaryLanguage + extend BrandDev::Internal::Type::Enum + + AFRIKAANS = :afrikaans + ALBANIAN = :albanian + AMHARIC = :amharic + ARABIC = :arabic + ARMENIAN = :armenian + ASSAMESE = :assamese + AYMARA = :aymara + AZERI = :azeri + BASQUE = :basque + BELARUSIAN = :belarusian + BENGALI = :bengali + BOSNIAN = :bosnian + BULGARIAN = :bulgarian + BURMESE = :burmese + CANTONESE = :cantonese + CATALAN = :catalan + CEBUANO = :cebuano + CHINESE = :chinese + CORSICAN = :corsican + CROATIAN = :croatian + CZECH = :czech + DANISH = :danish + DUTCH = :dutch + ENGLISH = :english + ESPERANTO = :esperanto + ESTONIAN = :estonian + FARSI = :farsi + FIJIAN = :fijian + FINNISH = :finnish + FRENCH = :french + GALICIAN = :galician + GEORGIAN = :georgian + GERMAN = :german + GREEK = :greek + GUARANI = :guarani + GUJARATI = :gujarati + HAITIAN_CREOLE = :"haitian-creole" + HAUSA = :hausa + HAWAIIAN = :hawaiian + HEBREW = :hebrew + HINDI = :hindi + HMONG = :hmong + HUNGARIAN = :hungarian + ICELANDIC = :icelandic + IGBO = :igbo + INDONESIAN = :indonesian + IRISH = :irish + ITALIAN = :italian + JAPANESE = :japanese + JAVANESE = :javanese + KANNADA = :kannada + KAZAKH = :kazakh + KHMER = :khmer + KINYARWANDA = :kinyarwanda + KOREAN = :korean + KURDISH = :kurdish + KYRGYZ = :kyrgyz + LAO = :lao + LATIN = :latin + LATVIAN = :latvian + LINGALA = :lingala + LITHUANIAN = :lithuanian + LUXEMBOURGISH = :luxembourgish + MACEDONIAN = :macedonian + MALAGASY = :malagasy + MALAY = :malay + MALAYALAM = :malayalam + MALTESE = :maltese + MAORI = :maori + MARATHI = :marathi + MONGOLIAN = :mongolian + NEPALI = :nepali + NORWEGIAN = :norwegian + ODIA = :odia + OROMO = :oromo + PASHTO = :pashto + PIDGIN = :pidgin + POLISH = :polish + PORTUGUESE = :portuguese + PUNJABI = :punjabi + QUECHUA = :quechua + ROMANIAN = :romanian + RUSSIAN = :russian + SAMOAN = :samoan + SCOTTISH_GAELIC = :"scottish-gaelic" + SERBIAN = :serbian + SESOTHO = :sesotho + SHONA = :shona + SINDHI = :sindhi + SINHALA = :sinhala + SLOVAK = :slovak + SLOVENE = :slovene + SOMALI = :somali + SPANISH = :spanish + SUNDANESE = :sundanese + SWAHILI = :swahili + SWEDISH = :swedish + TAGALOG = :tagalog + TAJIK = :tajik + TAMIL = :tamil + TATAR = :tatar + TELUGU = :telugu + THAI = :thai + TIBETAN = :tibetan + TIGRINYA = :tigrinya + TONGAN = :tongan + TSWANA = :tswana + TURKISH = :turkish + TURKMEN = :turkmen + UKRAINIAN = :ukrainian + URDU = :urdu + UYGHUR = :uyghur + UZBEK = :uzbek + VIETNAMESE = :vietnamese + WELSH = :welsh + WOLOF = :wolof + XHOSA = :xhosa + YIDDISH = :yiddish + YORUBA = :yoruba + ZULU = :zulu + + # @!method self.values + # @return [Array] + end + class Social < BrandDev::Internal::Type::BaseModel # @!attribute type # Type of social media, e.g., 'facebook', 'twitter' diff --git a/lib/brand_dev/models/brand_retrieve_params.rb b/lib/brand_dev/models/brand_retrieve_params.rb index 0af7caf..da16e16 100644 --- a/lib/brand_dev/models/brand_retrieve_params.rb +++ b/lib/brand_dev/models/brand_retrieve_params.rb @@ -15,8 +15,7 @@ class BrandRetrieveParams < BrandDev::Internal::Type::BaseModel required :domain, String # @!attribute force_language - # Optional parameter to force the language of the retrieved brand data. Works with - # all three lookup methods. + # Optional parameter to force the language of the retrieved brand data. # # @return [Symbol, BrandDev::Models::BrandRetrieveParams::ForceLanguage, nil] optional :force_language, enum: -> { BrandDev::BrandRetrieveParams::ForceLanguage } @@ -43,7 +42,7 @@ class BrandRetrieveParams < BrandDev::Internal::Type::BaseModel # # @param domain [String] Domain name to retrieve brand data for (e.g., 'example.com', 'google.com'). Cann # - # @param force_language [Symbol, BrandDev::Models::BrandRetrieveParams::ForceLanguage] Optional parameter to force the language of the retrieved brand data. Works with + # @param force_language [Symbol, BrandDev::Models::BrandRetrieveParams::ForceLanguage] Optional parameter to force the language of the retrieved brand data. # # @param max_speed [Boolean] Optional parameter to optimize the API call for maximum speed. When set to true, # @@ -51,66 +50,130 @@ class BrandRetrieveParams < BrandDev::Internal::Type::BaseModel # # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}] - # Optional parameter to force the language of the retrieved brand data. Works with - # all three lookup methods. + # Optional parameter to force the language of the retrieved brand data. module ForceLanguage extend BrandDev::Internal::Type::Enum + AFRIKAANS = :afrikaans ALBANIAN = :albanian + AMHARIC = :amharic ARABIC = :arabic + ARMENIAN = :armenian + ASSAMESE = :assamese + AYMARA = :aymara AZERI = :azeri + BASQUE = :basque + BELARUSIAN = :belarusian BENGALI = :bengali + BOSNIAN = :bosnian BULGARIAN = :bulgarian + BURMESE = :burmese CANTONESE = :cantonese + CATALAN = :catalan CEBUANO = :cebuano + CHINESE = :chinese + CORSICAN = :corsican CROATIAN = :croatian CZECH = :czech DANISH = :danish DUTCH = :dutch ENGLISH = :english + ESPERANTO = :esperanto ESTONIAN = :estonian FARSI = :farsi + FIJIAN = :fijian FINNISH = :finnish FRENCH = :french + GALICIAN = :galician + GEORGIAN = :georgian GERMAN = :german + GREEK = :greek + GUARANI = :guarani + GUJARATI = :gujarati + HAITIAN_CREOLE = :"haitian-creole" HAUSA = :hausa HAWAIIAN = :hawaiian + HEBREW = :hebrew HINDI = :hindi + HMONG = :hmong HUNGARIAN = :hungarian ICELANDIC = :icelandic + IGBO = :igbo INDONESIAN = :indonesian + IRISH = :irish ITALIAN = :italian + JAPANESE = :japanese + JAVANESE = :javanese + KANNADA = :kannada KAZAKH = :kazakh + KHMER = :khmer + KINYARWANDA = :kinyarwanda KOREAN = :korean + KURDISH = :kurdish KYRGYZ = :kyrgyz + LAO = :lao LATIN = :latin LATVIAN = :latvian + LINGALA = :lingala LITHUANIAN = :lithuanian + LUXEMBOURGISH = :luxembourgish MACEDONIAN = :macedonian + MALAGASY = :malagasy + MALAY = :malay + MALAYALAM = :malayalam + MALTESE = :maltese + MAORI = :maori + MARATHI = :marathi MONGOLIAN = :mongolian NEPALI = :nepali NORWEGIAN = :norwegian + ODIA = :odia + OROMO = :oromo PASHTO = :pashto PIDGIN = :pidgin POLISH = :polish PORTUGUESE = :portuguese + PUNJABI = :punjabi + QUECHUA = :quechua ROMANIAN = :romanian RUSSIAN = :russian + SAMOAN = :samoan + SCOTTISH_GAELIC = :"scottish-gaelic" SERBIAN = :serbian + SESOTHO = :sesotho + SHONA = :shona + SINDHI = :sindhi + SINHALA = :sinhala SLOVAK = :slovak SLOVENE = :slovene SOMALI = :somali SPANISH = :spanish + SUNDANESE = :sundanese SWAHILI = :swahili SWEDISH = :swedish TAGALOG = :tagalog + TAJIK = :tajik + TAMIL = :tamil + TATAR = :tatar + TELUGU = :telugu THAI = :thai + TIBETAN = :tibetan + TIGRINYA = :tigrinya + TONGAN = :tongan + TSWANA = :tswana TURKISH = :turkish + TURKMEN = :turkmen UKRAINIAN = :ukrainian URDU = :urdu + UYGHUR = :uyghur UZBEK = :uzbek VIETNAMESE = :vietnamese WELSH = :welsh + WOLOF = :wolof + XHOSA = :xhosa + YIDDISH = :yiddish + YORUBA = :yoruba + ZULU = :zulu # @!method self.values # @return [Array] diff --git a/lib/brand_dev/models/brand_retrieve_response.rb b/lib/brand_dev/models/brand_retrieve_response.rb index 66da3c9..ab01bee 100644 --- a/lib/brand_dev/models/brand_retrieve_response.rb +++ b/lib/brand_dev/models/brand_retrieve_response.rb @@ -100,6 +100,15 @@ class Brand < BrandDev::Internal::Type::BaseModel # @return [String, nil] optional :phone, String + # @!attribute primary_language + # The primary language of the brand's website content. Detected from the HTML lang + # tag, page content analysis, or social media descriptions. + # + # @return [Symbol, BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage, nil] + optional :primary_language, + enum: -> { BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage }, + nil?: true + # @!attribute slogan # The brand's slogan # @@ -126,7 +135,7 @@ class Brand < BrandDev::Internal::Type::BaseModel # @return [String, nil] optional :title, String - # @!method initialize(address: nil, backdrops: nil, colors: nil, description: nil, domain: nil, email: nil, industries: nil, is_nsfw: nil, links: nil, logos: nil, phone: nil, slogan: nil, socials: nil, stock: nil, title: nil) + # @!method initialize(address: nil, backdrops: nil, colors: nil, description: nil, domain: nil, email: nil, industries: nil, is_nsfw: nil, links: nil, logos: nil, phone: nil, primary_language: nil, slogan: nil, socials: nil, stock: nil, title: nil) # Some parameter documentations has been truncated, see # {BrandDev::Models::BrandRetrieveResponse::Brand} for more details. # @@ -154,6 +163,8 @@ class Brand < BrandDev::Internal::Type::BaseModel # # @param phone [String] Company phone number # + # @param primary_language [Symbol, BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage, nil] The primary language of the brand's website content. Detected from the HTML lang + # # @param slogan [String] The brand's slogan # # @param socials [Array] An array of social media links for the brand @@ -802,6 +813,138 @@ module Type end end + # The primary language of the brand's website content. Detected from the HTML lang + # tag, page content analysis, or social media descriptions. + # + # @see BrandDev::Models::BrandRetrieveResponse::Brand#primary_language + module PrimaryLanguage + extend BrandDev::Internal::Type::Enum + + AFRIKAANS = :afrikaans + ALBANIAN = :albanian + AMHARIC = :amharic + ARABIC = :arabic + ARMENIAN = :armenian + ASSAMESE = :assamese + AYMARA = :aymara + AZERI = :azeri + BASQUE = :basque + BELARUSIAN = :belarusian + BENGALI = :bengali + BOSNIAN = :bosnian + BULGARIAN = :bulgarian + BURMESE = :burmese + CANTONESE = :cantonese + CATALAN = :catalan + CEBUANO = :cebuano + CHINESE = :chinese + CORSICAN = :corsican + CROATIAN = :croatian + CZECH = :czech + DANISH = :danish + DUTCH = :dutch + ENGLISH = :english + ESPERANTO = :esperanto + ESTONIAN = :estonian + FARSI = :farsi + FIJIAN = :fijian + FINNISH = :finnish + FRENCH = :french + GALICIAN = :galician + GEORGIAN = :georgian + GERMAN = :german + GREEK = :greek + GUARANI = :guarani + GUJARATI = :gujarati + HAITIAN_CREOLE = :"haitian-creole" + HAUSA = :hausa + HAWAIIAN = :hawaiian + HEBREW = :hebrew + HINDI = :hindi + HMONG = :hmong + HUNGARIAN = :hungarian + ICELANDIC = :icelandic + IGBO = :igbo + INDONESIAN = :indonesian + IRISH = :irish + ITALIAN = :italian + JAPANESE = :japanese + JAVANESE = :javanese + KANNADA = :kannada + KAZAKH = :kazakh + KHMER = :khmer + KINYARWANDA = :kinyarwanda + KOREAN = :korean + KURDISH = :kurdish + KYRGYZ = :kyrgyz + LAO = :lao + LATIN = :latin + LATVIAN = :latvian + LINGALA = :lingala + LITHUANIAN = :lithuanian + LUXEMBOURGISH = :luxembourgish + MACEDONIAN = :macedonian + MALAGASY = :malagasy + MALAY = :malay + MALAYALAM = :malayalam + MALTESE = :maltese + MAORI = :maori + MARATHI = :marathi + MONGOLIAN = :mongolian + NEPALI = :nepali + NORWEGIAN = :norwegian + ODIA = :odia + OROMO = :oromo + PASHTO = :pashto + PIDGIN = :pidgin + POLISH = :polish + PORTUGUESE = :portuguese + PUNJABI = :punjabi + QUECHUA = :quechua + ROMANIAN = :romanian + RUSSIAN = :russian + SAMOAN = :samoan + SCOTTISH_GAELIC = :"scottish-gaelic" + SERBIAN = :serbian + SESOTHO = :sesotho + SHONA = :shona + SINDHI = :sindhi + SINHALA = :sinhala + SLOVAK = :slovak + SLOVENE = :slovene + SOMALI = :somali + SPANISH = :spanish + SUNDANESE = :sundanese + SWAHILI = :swahili + SWEDISH = :swedish + TAGALOG = :tagalog + TAJIK = :tajik + TAMIL = :tamil + TATAR = :tatar + TELUGU = :telugu + THAI = :thai + TIBETAN = :tibetan + TIGRINYA = :tigrinya + TONGAN = :tongan + TSWANA = :tswana + TURKISH = :turkish + TURKMEN = :turkmen + UKRAINIAN = :ukrainian + URDU = :urdu + UYGHUR = :uyghur + UZBEK = :uzbek + VIETNAMESE = :vietnamese + WELSH = :welsh + WOLOF = :wolof + XHOSA = :xhosa + YIDDISH = :yiddish + YORUBA = :yoruba + ZULU = :zulu + + # @!method self.values + # @return [Array] + end + class Social < BrandDev::Internal::Type::BaseModel # @!attribute type # Type of social media, e.g., 'facebook', 'twitter' diff --git a/lib/brand_dev/resources/brand.rb b/lib/brand_dev/resources/brand.rb index 34dfad5..0c721fe 100644 --- a/lib/brand_dev/resources/brand.rb +++ b/lib/brand_dev/resources/brand.rb @@ -13,7 +13,7 @@ class Brand # # @param domain [String] Domain name to retrieve brand data for (e.g., 'example.com', 'google.com'). Cann # - # @param force_language [Symbol, BrandDev::Models::BrandRetrieveParams::ForceLanguage] Optional parameter to force the language of the retrieved brand data. Works with + # @param force_language [Symbol, BrandDev::Models::BrandRetrieveParams::ForceLanguage] Optional parameter to force the language of the retrieved brand data. # # @param max_speed [Boolean] Optional parameter to optimize the API call for maximum speed. When set to true, # diff --git a/rbi/brand_dev/models/brand_identify_from_transaction_params.rbi b/rbi/brand_dev/models/brand_identify_from_transaction_params.rbi index 16305a9..fb85edf 100644 --- a/rbi/brand_dev/models/brand_identify_from_transaction_params.rbi +++ b/rbi/brand_dev/models/brand_identify_from_transaction_params.rbi @@ -1406,41 +1406,101 @@ module BrandDev end OrSymbol = T.type_alias { T.any(Symbol, String) } + AFRIKAANS = + T.let( + :afrikaans, + BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol + ) ALBANIAN = T.let( :albanian, BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol ) + AMHARIC = + T.let( + :amharic, + BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol + ) ARABIC = T.let( :arabic, BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol ) + ARMENIAN = + T.let( + :armenian, + BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol + ) + ASSAMESE = + T.let( + :assamese, + BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol + ) + AYMARA = + T.let( + :aymara, + BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol + ) AZERI = T.let( :azeri, BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol ) + BASQUE = + T.let( + :basque, + BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol + ) + BELARUSIAN = + T.let( + :belarusian, + BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol + ) BENGALI = T.let( :bengali, BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol ) + BOSNIAN = + T.let( + :bosnian, + BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol + ) BULGARIAN = T.let( :bulgarian, BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol ) + BURMESE = + T.let( + :burmese, + BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol + ) CANTONESE = T.let( :cantonese, BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol ) + CATALAN = + T.let( + :catalan, + BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol + ) CEBUANO = T.let( :cebuano, BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol ) + CHINESE = + T.let( + :chinese, + BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol + ) + CORSICAN = + T.let( + :corsican, + BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol + ) CROATIAN = T.let( :croatian, @@ -1466,6 +1526,11 @@ module BrandDev :english, BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol ) + ESPERANTO = + T.let( + :esperanto, + BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol + ) ESTONIAN = T.let( :estonian, @@ -1476,6 +1541,11 @@ module BrandDev :farsi, BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol ) + FIJIAN = + T.let( + :fijian, + BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol + ) FINNISH = T.let( :finnish, @@ -1486,11 +1556,41 @@ module BrandDev :french, BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol ) + GALICIAN = + T.let( + :galician, + BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol + ) + GEORGIAN = + T.let( + :georgian, + BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol + ) GERMAN = T.let( :german, BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol ) + GREEK = + T.let( + :greek, + BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol + ) + GUARANI = + T.let( + :guarani, + BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol + ) + GUJARATI = + T.let( + :gujarati, + BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol + ) + HAITIAN_CREOLE = + T.let( + :"haitian-creole", + BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol + ) HAUSA = T.let( :hausa, @@ -1501,11 +1601,21 @@ module BrandDev :hawaiian, BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol ) + HEBREW = + T.let( + :hebrew, + BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol + ) HINDI = T.let( :hindi, BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol ) + HMONG = + T.let( + :hmong, + BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol + ) HUNGARIAN = T.let( :hungarian, @@ -1516,31 +1626,76 @@ module BrandDev :icelandic, BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol ) + IGBO = + T.let( + :igbo, + BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol + ) INDONESIAN = T.let( :indonesian, BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol ) + IRISH = + T.let( + :irish, + BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol + ) ITALIAN = T.let( :italian, BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol ) + JAPANESE = + T.let( + :japanese, + BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol + ) + JAVANESE = + T.let( + :javanese, + BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol + ) + KANNADA = + T.let( + :kannada, + BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol + ) KAZAKH = T.let( :kazakh, BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol ) + KHMER = + T.let( + :khmer, + BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol + ) + KINYARWANDA = + T.let( + :kinyarwanda, + BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol + ) KOREAN = T.let( :korean, BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol ) + KURDISH = + T.let( + :kurdish, + BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol + ) KYRGYZ = T.let( :kyrgyz, BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol ) + LAO = + T.let( + :lao, + BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol + ) LATIN = T.let( :latin, @@ -1551,16 +1706,56 @@ module BrandDev :latvian, BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol ) + LINGALA = + T.let( + :lingala, + BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol + ) LITHUANIAN = T.let( :lithuanian, BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol ) + LUXEMBOURGISH = + T.let( + :luxembourgish, + BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol + ) MACEDONIAN = T.let( :macedonian, BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol ) + MALAGASY = + T.let( + :malagasy, + BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol + ) + MALAY = + T.let( + :malay, + BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol + ) + MALAYALAM = + T.let( + :malayalam, + BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol + ) + MALTESE = + T.let( + :maltese, + BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol + ) + MAORI = + T.let( + :maori, + BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol + ) + MARATHI = + T.let( + :marathi, + BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol + ) MONGOLIAN = T.let( :mongolian, @@ -1576,6 +1771,16 @@ module BrandDev :norwegian, BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol ) + ODIA = + T.let( + :odia, + BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol + ) + OROMO = + T.let( + :oromo, + BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol + ) PASHTO = T.let( :pashto, @@ -1596,6 +1801,16 @@ module BrandDev :portuguese, BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol ) + PUNJABI = + T.let( + :punjabi, + BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol + ) + QUECHUA = + T.let( + :quechua, + BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol + ) ROMANIAN = T.let( :romanian, @@ -1606,11 +1821,41 @@ module BrandDev :russian, BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol ) + SAMOAN = + T.let( + :samoan, + BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol + ) + SCOTTISH_GAELIC = + T.let( + :"scottish-gaelic", + BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol + ) SERBIAN = T.let( :serbian, BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol ) + SESOTHO = + T.let( + :sesotho, + BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol + ) + SHONA = + T.let( + :shona, + BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol + ) + SINDHI = + T.let( + :sindhi, + BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol + ) + SINHALA = + T.let( + :sinhala, + BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol + ) SLOVAK = T.let( :slovak, @@ -1631,6 +1876,11 @@ module BrandDev :spanish, BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol ) + SUNDANESE = + T.let( + :sundanese, + BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol + ) SWAHILI = T.let( :swahili, @@ -1646,16 +1896,61 @@ module BrandDev :tagalog, BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol ) + TAJIK = + T.let( + :tajik, + BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol + ) + TAMIL = + T.let( + :tamil, + BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol + ) + TATAR = + T.let( + :tatar, + BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol + ) + TELUGU = + T.let( + :telugu, + BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol + ) THAI = T.let( :thai, BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol ) + TIBETAN = + T.let( + :tibetan, + BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol + ) + TIGRINYA = + T.let( + :tigrinya, + BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol + ) + TONGAN = + T.let( + :tongan, + BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol + ) + TSWANA = + T.let( + :tswana, + BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol + ) TURKISH = T.let( :turkish, BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol ) + TURKMEN = + T.let( + :turkmen, + BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol + ) UKRAINIAN = T.let( :ukrainian, @@ -1666,6 +1961,11 @@ module BrandDev :urdu, BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol ) + UYGHUR = + T.let( + :uyghur, + BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol + ) UZBEK = T.let( :uzbek, @@ -1681,6 +1981,31 @@ module BrandDev :welsh, BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol ) + WOLOF = + T.let( + :wolof, + BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol + ) + XHOSA = + T.let( + :xhosa, + BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol + ) + YIDDISH = + T.let( + :yiddish, + BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol + ) + YORUBA = + T.let( + :yoruba, + BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol + ) + ZULU = + T.let( + :zulu, + BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol + ) sig do override.returns( diff --git a/rbi/brand_dev/models/brand_identify_from_transaction_response.rbi b/rbi/brand_dev/models/brand_identify_from_transaction_response.rbi index 02a8381..e762457 100644 --- a/rbi/brand_dev/models/brand_identify_from_transaction_response.rbi +++ b/rbi/brand_dev/models/brand_identify_from_transaction_response.rbi @@ -238,6 +238,17 @@ module BrandDev sig { params(phone: String).void } attr_writer :phone + # The primary language of the brand's website content. Detected from the HTML lang + # tag, page content analysis, or social media descriptions. + sig do + returns( + T.nilable( + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ) + end + attr_accessor :primary_language + # The brand's slogan sig { returns(T.nilable(String)) } attr_reader :slogan @@ -319,6 +330,10 @@ module BrandDev BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo::OrHash ], phone: String, + primary_language: + T.nilable( + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::OrSymbol + ), slogan: String, socials: T::Array[ @@ -352,6 +367,9 @@ module BrandDev logos: nil, # Company phone number phone: nil, + # The primary language of the brand's website content. Detected from the HTML lang + # tag, page content analysis, or social media descriptions. + primary_language: nil, # The brand's slogan slogan: nil, # An array of social media links for the brand @@ -390,6 +408,10 @@ module BrandDev BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo ], phone: String, + primary_language: + T.nilable( + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ), slogan: String, socials: T::Array[ @@ -2512,6 +2534,632 @@ module BrandDev end end + # The primary language of the brand's website content. Detected from the HTML lang + # tag, page content analysis, or social media descriptions. + module PrimaryLanguage + extend BrandDev::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + AFRIKAANS = + T.let( + :afrikaans, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ALBANIAN = + T.let( + :albanian, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + AMHARIC = + T.let( + :amharic, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ARABIC = + T.let( + :arabic, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ARMENIAN = + T.let( + :armenian, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ASSAMESE = + T.let( + :assamese, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + AYMARA = + T.let( + :aymara, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + AZERI = + T.let( + :azeri, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + BASQUE = + T.let( + :basque, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + BELARUSIAN = + T.let( + :belarusian, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + BENGALI = + T.let( + :bengali, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + BOSNIAN = + T.let( + :bosnian, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + BULGARIAN = + T.let( + :bulgarian, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + BURMESE = + T.let( + :burmese, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + CANTONESE = + T.let( + :cantonese, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + CATALAN = + T.let( + :catalan, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + CEBUANO = + T.let( + :cebuano, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + CHINESE = + T.let( + :chinese, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + CORSICAN = + T.let( + :corsican, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + CROATIAN = + T.let( + :croatian, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + CZECH = + T.let( + :czech, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + DANISH = + T.let( + :danish, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + DUTCH = + T.let( + :dutch, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ENGLISH = + T.let( + :english, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ESPERANTO = + T.let( + :esperanto, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ESTONIAN = + T.let( + :estonian, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + FARSI = + T.let( + :farsi, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + FIJIAN = + T.let( + :fijian, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + FINNISH = + T.let( + :finnish, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + FRENCH = + T.let( + :french, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + GALICIAN = + T.let( + :galician, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + GEORGIAN = + T.let( + :georgian, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + GERMAN = + T.let( + :german, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + GREEK = + T.let( + :greek, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + GUARANI = + T.let( + :guarani, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + GUJARATI = + T.let( + :gujarati, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + HAITIAN_CREOLE = + T.let( + :"haitian-creole", + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + HAUSA = + T.let( + :hausa, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + HAWAIIAN = + T.let( + :hawaiian, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + HEBREW = + T.let( + :hebrew, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + HINDI = + T.let( + :hindi, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + HMONG = + T.let( + :hmong, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + HUNGARIAN = + T.let( + :hungarian, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ICELANDIC = + T.let( + :icelandic, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + IGBO = + T.let( + :igbo, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + INDONESIAN = + T.let( + :indonesian, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + IRISH = + T.let( + :irish, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ITALIAN = + T.let( + :italian, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + JAPANESE = + T.let( + :japanese, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + JAVANESE = + T.let( + :javanese, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + KANNADA = + T.let( + :kannada, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + KAZAKH = + T.let( + :kazakh, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + KHMER = + T.let( + :khmer, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + KINYARWANDA = + T.let( + :kinyarwanda, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + KOREAN = + T.let( + :korean, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + KURDISH = + T.let( + :kurdish, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + KYRGYZ = + T.let( + :kyrgyz, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + LAO = + T.let( + :lao, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + LATIN = + T.let( + :latin, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + LATVIAN = + T.let( + :latvian, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + LINGALA = + T.let( + :lingala, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + LITHUANIAN = + T.let( + :lithuanian, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + LUXEMBOURGISH = + T.let( + :luxembourgish, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + MACEDONIAN = + T.let( + :macedonian, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + MALAGASY = + T.let( + :malagasy, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + MALAY = + T.let( + :malay, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + MALAYALAM = + T.let( + :malayalam, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + MALTESE = + T.let( + :maltese, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + MAORI = + T.let( + :maori, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + MARATHI = + T.let( + :marathi, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + MONGOLIAN = + T.let( + :mongolian, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + NEPALI = + T.let( + :nepali, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + NORWEGIAN = + T.let( + :norwegian, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ODIA = + T.let( + :odia, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + OROMO = + T.let( + :oromo, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + PASHTO = + T.let( + :pashto, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + PIDGIN = + T.let( + :pidgin, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + POLISH = + T.let( + :polish, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + PORTUGUESE = + T.let( + :portuguese, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + PUNJABI = + T.let( + :punjabi, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + QUECHUA = + T.let( + :quechua, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ROMANIAN = + T.let( + :romanian, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + RUSSIAN = + T.let( + :russian, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SAMOAN = + T.let( + :samoan, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SCOTTISH_GAELIC = + T.let( + :"scottish-gaelic", + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SERBIAN = + T.let( + :serbian, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SESOTHO = + T.let( + :sesotho, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SHONA = + T.let( + :shona, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SINDHI = + T.let( + :sindhi, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SINHALA = + T.let( + :sinhala, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SLOVAK = + T.let( + :slovak, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SLOVENE = + T.let( + :slovene, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SOMALI = + T.let( + :somali, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SPANISH = + T.let( + :spanish, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SUNDANESE = + T.let( + :sundanese, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SWAHILI = + T.let( + :swahili, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SWEDISH = + T.let( + :swedish, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + TAGALOG = + T.let( + :tagalog, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + TAJIK = + T.let( + :tajik, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + TAMIL = + T.let( + :tamil, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + TATAR = + T.let( + :tatar, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + TELUGU = + T.let( + :telugu, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + THAI = + T.let( + :thai, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + TIBETAN = + T.let( + :tibetan, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + TIGRINYA = + T.let( + :tigrinya, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + TONGAN = + T.let( + :tongan, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + TSWANA = + T.let( + :tswana, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + TURKISH = + T.let( + :turkish, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + TURKMEN = + T.let( + :turkmen, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + UKRAINIAN = + T.let( + :ukrainian, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + URDU = + T.let( + :urdu, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + UYGHUR = + T.let( + :uyghur, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + UZBEK = + T.let( + :uzbek, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + VIETNAMESE = + T.let( + :vietnamese, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + WELSH = + T.let( + :welsh, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + WOLOF = + T.let( + :wolof, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + XHOSA = + T.let( + :xhosa, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + YIDDISH = + T.let( + :yiddish, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + YORUBA = + T.let( + :yoruba, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ZULU = + T.let( + :zulu, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::PrimaryLanguage::TaggedSymbol + ] + ) + end + def self.values + end + end + class Social < BrandDev::Internal::Type::BaseModel OrHash = T.type_alias do diff --git a/rbi/brand_dev/models/brand_retrieve_by_email_params.rbi b/rbi/brand_dev/models/brand_retrieve_by_email_params.rbi index 259dd24..1f9e4fe 100644 --- a/rbi/brand_dev/models/brand_retrieve_by_email_params.rbi +++ b/rbi/brand_dev/models/brand_retrieve_by_email_params.rbi @@ -110,41 +110,101 @@ module BrandDev end OrSymbol = T.type_alias { T.any(Symbol, String) } + AFRIKAANS = + T.let( + :afrikaans, + BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol + ) ALBANIAN = T.let( :albanian, BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol ) + AMHARIC = + T.let( + :amharic, + BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol + ) ARABIC = T.let( :arabic, BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol ) + ARMENIAN = + T.let( + :armenian, + BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol + ) + ASSAMESE = + T.let( + :assamese, + BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol + ) + AYMARA = + T.let( + :aymara, + BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol + ) AZERI = T.let( :azeri, BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol ) + BASQUE = + T.let( + :basque, + BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol + ) + BELARUSIAN = + T.let( + :belarusian, + BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol + ) BENGALI = T.let( :bengali, BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol ) + BOSNIAN = + T.let( + :bosnian, + BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol + ) BULGARIAN = T.let( :bulgarian, BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol ) + BURMESE = + T.let( + :burmese, + BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol + ) CANTONESE = T.let( :cantonese, BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol ) + CATALAN = + T.let( + :catalan, + BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol + ) CEBUANO = T.let( :cebuano, BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol ) + CHINESE = + T.let( + :chinese, + BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol + ) + CORSICAN = + T.let( + :corsican, + BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol + ) CROATIAN = T.let( :croatian, @@ -170,6 +230,11 @@ module BrandDev :english, BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol ) + ESPERANTO = + T.let( + :esperanto, + BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol + ) ESTONIAN = T.let( :estonian, @@ -180,6 +245,11 @@ module BrandDev :farsi, BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol ) + FIJIAN = + T.let( + :fijian, + BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol + ) FINNISH = T.let( :finnish, @@ -190,11 +260,41 @@ module BrandDev :french, BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol ) + GALICIAN = + T.let( + :galician, + BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol + ) + GEORGIAN = + T.let( + :georgian, + BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol + ) GERMAN = T.let( :german, BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol ) + GREEK = + T.let( + :greek, + BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol + ) + GUARANI = + T.let( + :guarani, + BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol + ) + GUJARATI = + T.let( + :gujarati, + BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol + ) + HAITIAN_CREOLE = + T.let( + :"haitian-creole", + BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol + ) HAUSA = T.let( :hausa, @@ -205,11 +305,21 @@ module BrandDev :hawaiian, BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol ) + HEBREW = + T.let( + :hebrew, + BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol + ) HINDI = T.let( :hindi, BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol ) + HMONG = + T.let( + :hmong, + BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol + ) HUNGARIAN = T.let( :hungarian, @@ -220,31 +330,76 @@ module BrandDev :icelandic, BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol ) + IGBO = + T.let( + :igbo, + BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol + ) INDONESIAN = T.let( :indonesian, BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol ) + IRISH = + T.let( + :irish, + BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol + ) ITALIAN = T.let( :italian, BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol ) + JAPANESE = + T.let( + :japanese, + BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol + ) + JAVANESE = + T.let( + :javanese, + BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol + ) + KANNADA = + T.let( + :kannada, + BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol + ) KAZAKH = T.let( :kazakh, BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol ) + KHMER = + T.let( + :khmer, + BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol + ) + KINYARWANDA = + T.let( + :kinyarwanda, + BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol + ) KOREAN = T.let( :korean, BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol ) + KURDISH = + T.let( + :kurdish, + BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol + ) KYRGYZ = T.let( :kyrgyz, BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol ) + LAO = + T.let( + :lao, + BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol + ) LATIN = T.let( :latin, @@ -255,16 +410,56 @@ module BrandDev :latvian, BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol ) + LINGALA = + T.let( + :lingala, + BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol + ) LITHUANIAN = T.let( :lithuanian, BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol ) + LUXEMBOURGISH = + T.let( + :luxembourgish, + BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol + ) MACEDONIAN = T.let( :macedonian, BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol ) + MALAGASY = + T.let( + :malagasy, + BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol + ) + MALAY = + T.let( + :malay, + BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol + ) + MALAYALAM = + T.let( + :malayalam, + BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol + ) + MALTESE = + T.let( + :maltese, + BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol + ) + MAORI = + T.let( + :maori, + BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol + ) + MARATHI = + T.let( + :marathi, + BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol + ) MONGOLIAN = T.let( :mongolian, @@ -280,6 +475,16 @@ module BrandDev :norwegian, BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol ) + ODIA = + T.let( + :odia, + BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol + ) + OROMO = + T.let( + :oromo, + BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol + ) PASHTO = T.let( :pashto, @@ -300,6 +505,16 @@ module BrandDev :portuguese, BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol ) + PUNJABI = + T.let( + :punjabi, + BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol + ) + QUECHUA = + T.let( + :quechua, + BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol + ) ROMANIAN = T.let( :romanian, @@ -310,11 +525,41 @@ module BrandDev :russian, BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol ) + SAMOAN = + T.let( + :samoan, + BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol + ) + SCOTTISH_GAELIC = + T.let( + :"scottish-gaelic", + BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol + ) SERBIAN = T.let( :serbian, BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol ) + SESOTHO = + T.let( + :sesotho, + BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol + ) + SHONA = + T.let( + :shona, + BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol + ) + SINDHI = + T.let( + :sindhi, + BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol + ) + SINHALA = + T.let( + :sinhala, + BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol + ) SLOVAK = T.let( :slovak, @@ -335,6 +580,11 @@ module BrandDev :spanish, BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol ) + SUNDANESE = + T.let( + :sundanese, + BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol + ) SWAHILI = T.let( :swahili, @@ -350,16 +600,61 @@ module BrandDev :tagalog, BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol ) + TAJIK = + T.let( + :tajik, + BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol + ) + TAMIL = + T.let( + :tamil, + BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol + ) + TATAR = + T.let( + :tatar, + BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol + ) + TELUGU = + T.let( + :telugu, + BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol + ) THAI = T.let( :thai, BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol ) + TIBETAN = + T.let( + :tibetan, + BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol + ) + TIGRINYA = + T.let( + :tigrinya, + BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol + ) + TONGAN = + T.let( + :tongan, + BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol + ) + TSWANA = + T.let( + :tswana, + BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol + ) TURKISH = T.let( :turkish, BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol ) + TURKMEN = + T.let( + :turkmen, + BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol + ) UKRAINIAN = T.let( :ukrainian, @@ -370,6 +665,11 @@ module BrandDev :urdu, BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol ) + UYGHUR = + T.let( + :uyghur, + BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol + ) UZBEK = T.let( :uzbek, @@ -385,6 +685,31 @@ module BrandDev :welsh, BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol ) + WOLOF = + T.let( + :wolof, + BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol + ) + XHOSA = + T.let( + :xhosa, + BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol + ) + YIDDISH = + T.let( + :yiddish, + BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol + ) + YORUBA = + T.let( + :yoruba, + BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol + ) + ZULU = + T.let( + :zulu, + BrandDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol + ) sig do override.returns( diff --git a/rbi/brand_dev/models/brand_retrieve_by_email_response.rbi b/rbi/brand_dev/models/brand_retrieve_by_email_response.rbi index 651de97..3cd6223 100644 --- a/rbi/brand_dev/models/brand_retrieve_by_email_response.rbi +++ b/rbi/brand_dev/models/brand_retrieve_by_email_response.rbi @@ -233,6 +233,17 @@ module BrandDev sig { params(phone: String).void } attr_writer :phone + # The primary language of the brand's website content. Detected from the HTML lang + # tag, page content analysis, or social media descriptions. + sig do + returns( + T.nilable( + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ) + end + attr_accessor :primary_language + # The brand's slogan sig { returns(T.nilable(String)) } attr_reader :slogan @@ -314,6 +325,10 @@ module BrandDev BrandDev::Models::BrandRetrieveByEmailResponse::Brand::Logo::OrHash ], phone: String, + primary_language: + T.nilable( + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::OrSymbol + ), slogan: String, socials: T::Array[ @@ -347,6 +362,9 @@ module BrandDev logos: nil, # Company phone number phone: nil, + # The primary language of the brand's website content. Detected from the HTML lang + # tag, page content analysis, or social media descriptions. + primary_language: nil, # The brand's slogan slogan: nil, # An array of social media links for the brand @@ -385,6 +403,10 @@ module BrandDev BrandDev::Models::BrandRetrieveByEmailResponse::Brand::Logo ], phone: String, + primary_language: + T.nilable( + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ), slogan: String, socials: T::Array[ @@ -2507,6 +2529,632 @@ module BrandDev end end + # The primary language of the brand's website content. Detected from the HTML lang + # tag, page content analysis, or social media descriptions. + module PrimaryLanguage + extend BrandDev::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + AFRIKAANS = + T.let( + :afrikaans, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ALBANIAN = + T.let( + :albanian, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + AMHARIC = + T.let( + :amharic, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ARABIC = + T.let( + :arabic, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ARMENIAN = + T.let( + :armenian, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ASSAMESE = + T.let( + :assamese, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + AYMARA = + T.let( + :aymara, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + AZERI = + T.let( + :azeri, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + BASQUE = + T.let( + :basque, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + BELARUSIAN = + T.let( + :belarusian, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + BENGALI = + T.let( + :bengali, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + BOSNIAN = + T.let( + :bosnian, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + BULGARIAN = + T.let( + :bulgarian, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + BURMESE = + T.let( + :burmese, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + CANTONESE = + T.let( + :cantonese, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + CATALAN = + T.let( + :catalan, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + CEBUANO = + T.let( + :cebuano, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + CHINESE = + T.let( + :chinese, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + CORSICAN = + T.let( + :corsican, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + CROATIAN = + T.let( + :croatian, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + CZECH = + T.let( + :czech, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + DANISH = + T.let( + :danish, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + DUTCH = + T.let( + :dutch, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ENGLISH = + T.let( + :english, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ESPERANTO = + T.let( + :esperanto, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ESTONIAN = + T.let( + :estonian, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + FARSI = + T.let( + :farsi, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + FIJIAN = + T.let( + :fijian, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + FINNISH = + T.let( + :finnish, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + FRENCH = + T.let( + :french, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + GALICIAN = + T.let( + :galician, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + GEORGIAN = + T.let( + :georgian, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + GERMAN = + T.let( + :german, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + GREEK = + T.let( + :greek, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + GUARANI = + T.let( + :guarani, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + GUJARATI = + T.let( + :gujarati, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + HAITIAN_CREOLE = + T.let( + :"haitian-creole", + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + HAUSA = + T.let( + :hausa, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + HAWAIIAN = + T.let( + :hawaiian, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + HEBREW = + T.let( + :hebrew, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + HINDI = + T.let( + :hindi, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + HMONG = + T.let( + :hmong, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + HUNGARIAN = + T.let( + :hungarian, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ICELANDIC = + T.let( + :icelandic, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + IGBO = + T.let( + :igbo, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + INDONESIAN = + T.let( + :indonesian, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + IRISH = + T.let( + :irish, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ITALIAN = + T.let( + :italian, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + JAPANESE = + T.let( + :japanese, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + JAVANESE = + T.let( + :javanese, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + KANNADA = + T.let( + :kannada, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + KAZAKH = + T.let( + :kazakh, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + KHMER = + T.let( + :khmer, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + KINYARWANDA = + T.let( + :kinyarwanda, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + KOREAN = + T.let( + :korean, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + KURDISH = + T.let( + :kurdish, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + KYRGYZ = + T.let( + :kyrgyz, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + LAO = + T.let( + :lao, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + LATIN = + T.let( + :latin, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + LATVIAN = + T.let( + :latvian, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + LINGALA = + T.let( + :lingala, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + LITHUANIAN = + T.let( + :lithuanian, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + LUXEMBOURGISH = + T.let( + :luxembourgish, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + MACEDONIAN = + T.let( + :macedonian, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + MALAGASY = + T.let( + :malagasy, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + MALAY = + T.let( + :malay, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + MALAYALAM = + T.let( + :malayalam, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + MALTESE = + T.let( + :maltese, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + MAORI = + T.let( + :maori, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + MARATHI = + T.let( + :marathi, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + MONGOLIAN = + T.let( + :mongolian, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + NEPALI = + T.let( + :nepali, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + NORWEGIAN = + T.let( + :norwegian, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ODIA = + T.let( + :odia, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + OROMO = + T.let( + :oromo, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + PASHTO = + T.let( + :pashto, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + PIDGIN = + T.let( + :pidgin, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + POLISH = + T.let( + :polish, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + PORTUGUESE = + T.let( + :portuguese, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + PUNJABI = + T.let( + :punjabi, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + QUECHUA = + T.let( + :quechua, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ROMANIAN = + T.let( + :romanian, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + RUSSIAN = + T.let( + :russian, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SAMOAN = + T.let( + :samoan, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SCOTTISH_GAELIC = + T.let( + :"scottish-gaelic", + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SERBIAN = + T.let( + :serbian, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SESOTHO = + T.let( + :sesotho, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SHONA = + T.let( + :shona, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SINDHI = + T.let( + :sindhi, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SINHALA = + T.let( + :sinhala, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SLOVAK = + T.let( + :slovak, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SLOVENE = + T.let( + :slovene, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SOMALI = + T.let( + :somali, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SPANISH = + T.let( + :spanish, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SUNDANESE = + T.let( + :sundanese, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SWAHILI = + T.let( + :swahili, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SWEDISH = + T.let( + :swedish, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + TAGALOG = + T.let( + :tagalog, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + TAJIK = + T.let( + :tajik, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + TAMIL = + T.let( + :tamil, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + TATAR = + T.let( + :tatar, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + TELUGU = + T.let( + :telugu, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + THAI = + T.let( + :thai, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + TIBETAN = + T.let( + :tibetan, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + TIGRINYA = + T.let( + :tigrinya, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + TONGAN = + T.let( + :tongan, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + TSWANA = + T.let( + :tswana, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + TURKISH = + T.let( + :turkish, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + TURKMEN = + T.let( + :turkmen, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + UKRAINIAN = + T.let( + :ukrainian, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + URDU = + T.let( + :urdu, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + UYGHUR = + T.let( + :uyghur, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + UZBEK = + T.let( + :uzbek, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + VIETNAMESE = + T.let( + :vietnamese, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + WELSH = + T.let( + :welsh, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + WOLOF = + T.let( + :wolof, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + XHOSA = + T.let( + :xhosa, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + YIDDISH = + T.let( + :yiddish, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + YORUBA = + T.let( + :yoruba, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ZULU = + T.let( + :zulu, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::PrimaryLanguage::TaggedSymbol + ] + ) + end + def self.values + end + end + class Social < BrandDev::Internal::Type::BaseModel OrHash = T.type_alias do diff --git a/rbi/brand_dev/models/brand_retrieve_by_isin_params.rbi b/rbi/brand_dev/models/brand_retrieve_by_isin_params.rbi index d89c54d..6c22156 100644 --- a/rbi/brand_dev/models/brand_retrieve_by_isin_params.rbi +++ b/rbi/brand_dev/models/brand_retrieve_by_isin_params.rbi @@ -110,41 +110,101 @@ module BrandDev end OrSymbol = T.type_alias { T.any(Symbol, String) } + AFRIKAANS = + T.let( + :afrikaans, + BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol + ) ALBANIAN = T.let( :albanian, BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol ) + AMHARIC = + T.let( + :amharic, + BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol + ) ARABIC = T.let( :arabic, BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol ) + ARMENIAN = + T.let( + :armenian, + BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol + ) + ASSAMESE = + T.let( + :assamese, + BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol + ) + AYMARA = + T.let( + :aymara, + BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol + ) AZERI = T.let( :azeri, BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol ) + BASQUE = + T.let( + :basque, + BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol + ) + BELARUSIAN = + T.let( + :belarusian, + BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol + ) BENGALI = T.let( :bengali, BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol ) + BOSNIAN = + T.let( + :bosnian, + BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol + ) BULGARIAN = T.let( :bulgarian, BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol ) + BURMESE = + T.let( + :burmese, + BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol + ) CANTONESE = T.let( :cantonese, BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol ) + CATALAN = + T.let( + :catalan, + BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol + ) CEBUANO = T.let( :cebuano, BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol ) + CHINESE = + T.let( + :chinese, + BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol + ) + CORSICAN = + T.let( + :corsican, + BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol + ) CROATIAN = T.let( :croatian, @@ -170,6 +230,11 @@ module BrandDev :english, BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol ) + ESPERANTO = + T.let( + :esperanto, + BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol + ) ESTONIAN = T.let( :estonian, @@ -180,6 +245,11 @@ module BrandDev :farsi, BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol ) + FIJIAN = + T.let( + :fijian, + BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol + ) FINNISH = T.let( :finnish, @@ -190,11 +260,41 @@ module BrandDev :french, BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol ) + GALICIAN = + T.let( + :galician, + BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol + ) + GEORGIAN = + T.let( + :georgian, + BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol + ) GERMAN = T.let( :german, BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol ) + GREEK = + T.let( + :greek, + BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol + ) + GUARANI = + T.let( + :guarani, + BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol + ) + GUJARATI = + T.let( + :gujarati, + BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol + ) + HAITIAN_CREOLE = + T.let( + :"haitian-creole", + BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol + ) HAUSA = T.let( :hausa, @@ -205,11 +305,21 @@ module BrandDev :hawaiian, BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol ) + HEBREW = + T.let( + :hebrew, + BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol + ) HINDI = T.let( :hindi, BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol ) + HMONG = + T.let( + :hmong, + BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol + ) HUNGARIAN = T.let( :hungarian, @@ -220,31 +330,76 @@ module BrandDev :icelandic, BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol ) + IGBO = + T.let( + :igbo, + BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol + ) INDONESIAN = T.let( :indonesian, BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol ) + IRISH = + T.let( + :irish, + BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol + ) ITALIAN = T.let( :italian, BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol ) + JAPANESE = + T.let( + :japanese, + BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol + ) + JAVANESE = + T.let( + :javanese, + BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol + ) + KANNADA = + T.let( + :kannada, + BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol + ) KAZAKH = T.let( :kazakh, BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol ) + KHMER = + T.let( + :khmer, + BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol + ) + KINYARWANDA = + T.let( + :kinyarwanda, + BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol + ) KOREAN = T.let( :korean, BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol ) + KURDISH = + T.let( + :kurdish, + BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol + ) KYRGYZ = T.let( :kyrgyz, BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol ) + LAO = + T.let( + :lao, + BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol + ) LATIN = T.let( :latin, @@ -255,16 +410,56 @@ module BrandDev :latvian, BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol ) + LINGALA = + T.let( + :lingala, + BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol + ) LITHUANIAN = T.let( :lithuanian, BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol ) + LUXEMBOURGISH = + T.let( + :luxembourgish, + BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol + ) MACEDONIAN = T.let( :macedonian, BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol ) + MALAGASY = + T.let( + :malagasy, + BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol + ) + MALAY = + T.let( + :malay, + BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol + ) + MALAYALAM = + T.let( + :malayalam, + BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol + ) + MALTESE = + T.let( + :maltese, + BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol + ) + MAORI = + T.let( + :maori, + BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol + ) + MARATHI = + T.let( + :marathi, + BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol + ) MONGOLIAN = T.let( :mongolian, @@ -280,6 +475,16 @@ module BrandDev :norwegian, BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol ) + ODIA = + T.let( + :odia, + BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol + ) + OROMO = + T.let( + :oromo, + BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol + ) PASHTO = T.let( :pashto, @@ -300,6 +505,16 @@ module BrandDev :portuguese, BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol ) + PUNJABI = + T.let( + :punjabi, + BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol + ) + QUECHUA = + T.let( + :quechua, + BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol + ) ROMANIAN = T.let( :romanian, @@ -310,11 +525,41 @@ module BrandDev :russian, BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol ) + SAMOAN = + T.let( + :samoan, + BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol + ) + SCOTTISH_GAELIC = + T.let( + :"scottish-gaelic", + BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol + ) SERBIAN = T.let( :serbian, BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol ) + SESOTHO = + T.let( + :sesotho, + BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol + ) + SHONA = + T.let( + :shona, + BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol + ) + SINDHI = + T.let( + :sindhi, + BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol + ) + SINHALA = + T.let( + :sinhala, + BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol + ) SLOVAK = T.let( :slovak, @@ -335,6 +580,11 @@ module BrandDev :spanish, BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol ) + SUNDANESE = + T.let( + :sundanese, + BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol + ) SWAHILI = T.let( :swahili, @@ -350,16 +600,61 @@ module BrandDev :tagalog, BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol ) + TAJIK = + T.let( + :tajik, + BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol + ) + TAMIL = + T.let( + :tamil, + BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol + ) + TATAR = + T.let( + :tatar, + BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol + ) + TELUGU = + T.let( + :telugu, + BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol + ) THAI = T.let( :thai, BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol ) + TIBETAN = + T.let( + :tibetan, + BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol + ) + TIGRINYA = + T.let( + :tigrinya, + BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol + ) + TONGAN = + T.let( + :tongan, + BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol + ) + TSWANA = + T.let( + :tswana, + BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol + ) TURKISH = T.let( :turkish, BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol ) + TURKMEN = + T.let( + :turkmen, + BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol + ) UKRAINIAN = T.let( :ukrainian, @@ -370,6 +665,11 @@ module BrandDev :urdu, BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol ) + UYGHUR = + T.let( + :uyghur, + BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol + ) UZBEK = T.let( :uzbek, @@ -385,6 +685,31 @@ module BrandDev :welsh, BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol ) + WOLOF = + T.let( + :wolof, + BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol + ) + XHOSA = + T.let( + :xhosa, + BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol + ) + YIDDISH = + T.let( + :yiddish, + BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol + ) + YORUBA = + T.let( + :yoruba, + BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol + ) + ZULU = + T.let( + :zulu, + BrandDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol + ) sig do override.returns( diff --git a/rbi/brand_dev/models/brand_retrieve_by_isin_response.rbi b/rbi/brand_dev/models/brand_retrieve_by_isin_response.rbi index ef848f8..023fb77 100644 --- a/rbi/brand_dev/models/brand_retrieve_by_isin_response.rbi +++ b/rbi/brand_dev/models/brand_retrieve_by_isin_response.rbi @@ -231,6 +231,17 @@ module BrandDev sig { params(phone: String).void } attr_writer :phone + # The primary language of the brand's website content. Detected from the HTML lang + # tag, page content analysis, or social media descriptions. + sig do + returns( + T.nilable( + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ) + end + attr_accessor :primary_language + # The brand's slogan sig { returns(T.nilable(String)) } attr_reader :slogan @@ -312,6 +323,10 @@ module BrandDev BrandDev::Models::BrandRetrieveByIsinResponse::Brand::Logo::OrHash ], phone: String, + primary_language: + T.nilable( + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::OrSymbol + ), slogan: String, socials: T::Array[ @@ -345,6 +360,9 @@ module BrandDev logos: nil, # Company phone number phone: nil, + # The primary language of the brand's website content. Detected from the HTML lang + # tag, page content analysis, or social media descriptions. + primary_language: nil, # The brand's slogan slogan: nil, # An array of social media links for the brand @@ -383,6 +401,10 @@ module BrandDev BrandDev::Models::BrandRetrieveByIsinResponse::Brand::Logo ], phone: String, + primary_language: + T.nilable( + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ), slogan: String, socials: T::Array[ @@ -2505,6 +2527,632 @@ module BrandDev end end + # The primary language of the brand's website content. Detected from the HTML lang + # tag, page content analysis, or social media descriptions. + module PrimaryLanguage + extend BrandDev::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + AFRIKAANS = + T.let( + :afrikaans, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ALBANIAN = + T.let( + :albanian, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + AMHARIC = + T.let( + :amharic, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ARABIC = + T.let( + :arabic, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ARMENIAN = + T.let( + :armenian, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ASSAMESE = + T.let( + :assamese, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + AYMARA = + T.let( + :aymara, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + AZERI = + T.let( + :azeri, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + BASQUE = + T.let( + :basque, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + BELARUSIAN = + T.let( + :belarusian, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + BENGALI = + T.let( + :bengali, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + BOSNIAN = + T.let( + :bosnian, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + BULGARIAN = + T.let( + :bulgarian, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + BURMESE = + T.let( + :burmese, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + CANTONESE = + T.let( + :cantonese, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + CATALAN = + T.let( + :catalan, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + CEBUANO = + T.let( + :cebuano, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + CHINESE = + T.let( + :chinese, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + CORSICAN = + T.let( + :corsican, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + CROATIAN = + T.let( + :croatian, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + CZECH = + T.let( + :czech, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + DANISH = + T.let( + :danish, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + DUTCH = + T.let( + :dutch, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ENGLISH = + T.let( + :english, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ESPERANTO = + T.let( + :esperanto, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ESTONIAN = + T.let( + :estonian, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + FARSI = + T.let( + :farsi, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + FIJIAN = + T.let( + :fijian, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + FINNISH = + T.let( + :finnish, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + FRENCH = + T.let( + :french, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + GALICIAN = + T.let( + :galician, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + GEORGIAN = + T.let( + :georgian, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + GERMAN = + T.let( + :german, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + GREEK = + T.let( + :greek, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + GUARANI = + T.let( + :guarani, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + GUJARATI = + T.let( + :gujarati, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + HAITIAN_CREOLE = + T.let( + :"haitian-creole", + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + HAUSA = + T.let( + :hausa, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + HAWAIIAN = + T.let( + :hawaiian, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + HEBREW = + T.let( + :hebrew, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + HINDI = + T.let( + :hindi, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + HMONG = + T.let( + :hmong, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + HUNGARIAN = + T.let( + :hungarian, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ICELANDIC = + T.let( + :icelandic, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + IGBO = + T.let( + :igbo, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + INDONESIAN = + T.let( + :indonesian, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + IRISH = + T.let( + :irish, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ITALIAN = + T.let( + :italian, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + JAPANESE = + T.let( + :japanese, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + JAVANESE = + T.let( + :javanese, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + KANNADA = + T.let( + :kannada, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + KAZAKH = + T.let( + :kazakh, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + KHMER = + T.let( + :khmer, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + KINYARWANDA = + T.let( + :kinyarwanda, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + KOREAN = + T.let( + :korean, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + KURDISH = + T.let( + :kurdish, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + KYRGYZ = + T.let( + :kyrgyz, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + LAO = + T.let( + :lao, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + LATIN = + T.let( + :latin, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + LATVIAN = + T.let( + :latvian, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + LINGALA = + T.let( + :lingala, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + LITHUANIAN = + T.let( + :lithuanian, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + LUXEMBOURGISH = + T.let( + :luxembourgish, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + MACEDONIAN = + T.let( + :macedonian, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + MALAGASY = + T.let( + :malagasy, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + MALAY = + T.let( + :malay, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + MALAYALAM = + T.let( + :malayalam, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + MALTESE = + T.let( + :maltese, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + MAORI = + T.let( + :maori, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + MARATHI = + T.let( + :marathi, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + MONGOLIAN = + T.let( + :mongolian, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + NEPALI = + T.let( + :nepali, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + NORWEGIAN = + T.let( + :norwegian, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ODIA = + T.let( + :odia, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + OROMO = + T.let( + :oromo, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + PASHTO = + T.let( + :pashto, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + PIDGIN = + T.let( + :pidgin, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + POLISH = + T.let( + :polish, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + PORTUGUESE = + T.let( + :portuguese, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + PUNJABI = + T.let( + :punjabi, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + QUECHUA = + T.let( + :quechua, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ROMANIAN = + T.let( + :romanian, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + RUSSIAN = + T.let( + :russian, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SAMOAN = + T.let( + :samoan, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SCOTTISH_GAELIC = + T.let( + :"scottish-gaelic", + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SERBIAN = + T.let( + :serbian, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SESOTHO = + T.let( + :sesotho, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SHONA = + T.let( + :shona, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SINDHI = + T.let( + :sindhi, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SINHALA = + T.let( + :sinhala, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SLOVAK = + T.let( + :slovak, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SLOVENE = + T.let( + :slovene, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SOMALI = + T.let( + :somali, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SPANISH = + T.let( + :spanish, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SUNDANESE = + T.let( + :sundanese, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SWAHILI = + T.let( + :swahili, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SWEDISH = + T.let( + :swedish, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + TAGALOG = + T.let( + :tagalog, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + TAJIK = + T.let( + :tajik, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + TAMIL = + T.let( + :tamil, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + TATAR = + T.let( + :tatar, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + TELUGU = + T.let( + :telugu, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + THAI = + T.let( + :thai, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + TIBETAN = + T.let( + :tibetan, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + TIGRINYA = + T.let( + :tigrinya, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + TONGAN = + T.let( + :tongan, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + TSWANA = + T.let( + :tswana, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + TURKISH = + T.let( + :turkish, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + TURKMEN = + T.let( + :turkmen, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + UKRAINIAN = + T.let( + :ukrainian, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + URDU = + T.let( + :urdu, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + UYGHUR = + T.let( + :uyghur, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + UZBEK = + T.let( + :uzbek, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + VIETNAMESE = + T.let( + :vietnamese, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + WELSH = + T.let( + :welsh, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + WOLOF = + T.let( + :wolof, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + XHOSA = + T.let( + :xhosa, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + YIDDISH = + T.let( + :yiddish, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + YORUBA = + T.let( + :yoruba, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ZULU = + T.let( + :zulu, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::PrimaryLanguage::TaggedSymbol + ] + ) + end + def self.values + end + end + class Social < BrandDev::Internal::Type::BaseModel OrHash = T.type_alias do diff --git a/rbi/brand_dev/models/brand_retrieve_by_name_params.rbi b/rbi/brand_dev/models/brand_retrieve_by_name_params.rbi index f7bf618..275c3a4 100644 --- a/rbi/brand_dev/models/brand_retrieve_by_name_params.rbi +++ b/rbi/brand_dev/models/brand_retrieve_by_name_params.rbi @@ -1348,41 +1348,101 @@ module BrandDev end OrSymbol = T.type_alias { T.any(Symbol, String) } + AFRIKAANS = + T.let( + :afrikaans, + BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol + ) ALBANIAN = T.let( :albanian, BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol ) + AMHARIC = + T.let( + :amharic, + BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol + ) ARABIC = T.let( :arabic, BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol ) + ARMENIAN = + T.let( + :armenian, + BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol + ) + ASSAMESE = + T.let( + :assamese, + BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol + ) + AYMARA = + T.let( + :aymara, + BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol + ) AZERI = T.let( :azeri, BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol ) + BASQUE = + T.let( + :basque, + BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol + ) + BELARUSIAN = + T.let( + :belarusian, + BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol + ) BENGALI = T.let( :bengali, BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol ) + BOSNIAN = + T.let( + :bosnian, + BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol + ) BULGARIAN = T.let( :bulgarian, BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol ) + BURMESE = + T.let( + :burmese, + BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol + ) CANTONESE = T.let( :cantonese, BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol ) + CATALAN = + T.let( + :catalan, + BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol + ) CEBUANO = T.let( :cebuano, BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol ) + CHINESE = + T.let( + :chinese, + BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol + ) + CORSICAN = + T.let( + :corsican, + BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol + ) CROATIAN = T.let( :croatian, @@ -1408,6 +1468,11 @@ module BrandDev :english, BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol ) + ESPERANTO = + T.let( + :esperanto, + BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol + ) ESTONIAN = T.let( :estonian, @@ -1418,6 +1483,11 @@ module BrandDev :farsi, BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol ) + FIJIAN = + T.let( + :fijian, + BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol + ) FINNISH = T.let( :finnish, @@ -1428,11 +1498,41 @@ module BrandDev :french, BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol ) + GALICIAN = + T.let( + :galician, + BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol + ) + GEORGIAN = + T.let( + :georgian, + BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol + ) GERMAN = T.let( :german, BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol ) + GREEK = + T.let( + :greek, + BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol + ) + GUARANI = + T.let( + :guarani, + BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol + ) + GUJARATI = + T.let( + :gujarati, + BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol + ) + HAITIAN_CREOLE = + T.let( + :"haitian-creole", + BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol + ) HAUSA = T.let( :hausa, @@ -1443,11 +1543,21 @@ module BrandDev :hawaiian, BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol ) + HEBREW = + T.let( + :hebrew, + BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol + ) HINDI = T.let( :hindi, BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol ) + HMONG = + T.let( + :hmong, + BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol + ) HUNGARIAN = T.let( :hungarian, @@ -1458,31 +1568,76 @@ module BrandDev :icelandic, BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol ) + IGBO = + T.let( + :igbo, + BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol + ) INDONESIAN = T.let( :indonesian, BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol ) + IRISH = + T.let( + :irish, + BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol + ) ITALIAN = T.let( :italian, BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol ) + JAPANESE = + T.let( + :japanese, + BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol + ) + JAVANESE = + T.let( + :javanese, + BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol + ) + KANNADA = + T.let( + :kannada, + BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol + ) KAZAKH = T.let( :kazakh, BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol ) + KHMER = + T.let( + :khmer, + BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol + ) + KINYARWANDA = + T.let( + :kinyarwanda, + BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol + ) KOREAN = T.let( :korean, BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol ) + KURDISH = + T.let( + :kurdish, + BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol + ) KYRGYZ = T.let( :kyrgyz, BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol ) + LAO = + T.let( + :lao, + BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol + ) LATIN = T.let( :latin, @@ -1493,16 +1648,56 @@ module BrandDev :latvian, BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol ) + LINGALA = + T.let( + :lingala, + BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol + ) LITHUANIAN = T.let( :lithuanian, BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol ) + LUXEMBOURGISH = + T.let( + :luxembourgish, + BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol + ) MACEDONIAN = T.let( :macedonian, BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol ) + MALAGASY = + T.let( + :malagasy, + BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol + ) + MALAY = + T.let( + :malay, + BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol + ) + MALAYALAM = + T.let( + :malayalam, + BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol + ) + MALTESE = + T.let( + :maltese, + BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol + ) + MAORI = + T.let( + :maori, + BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol + ) + MARATHI = + T.let( + :marathi, + BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol + ) MONGOLIAN = T.let( :mongolian, @@ -1518,6 +1713,16 @@ module BrandDev :norwegian, BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol ) + ODIA = + T.let( + :odia, + BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol + ) + OROMO = + T.let( + :oromo, + BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol + ) PASHTO = T.let( :pashto, @@ -1538,6 +1743,16 @@ module BrandDev :portuguese, BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol ) + PUNJABI = + T.let( + :punjabi, + BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol + ) + QUECHUA = + T.let( + :quechua, + BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol + ) ROMANIAN = T.let( :romanian, @@ -1548,11 +1763,41 @@ module BrandDev :russian, BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol ) + SAMOAN = + T.let( + :samoan, + BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol + ) + SCOTTISH_GAELIC = + T.let( + :"scottish-gaelic", + BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol + ) SERBIAN = T.let( :serbian, BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol ) + SESOTHO = + T.let( + :sesotho, + BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol + ) + SHONA = + T.let( + :shona, + BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol + ) + SINDHI = + T.let( + :sindhi, + BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol + ) + SINHALA = + T.let( + :sinhala, + BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol + ) SLOVAK = T.let( :slovak, @@ -1573,6 +1818,11 @@ module BrandDev :spanish, BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol ) + SUNDANESE = + T.let( + :sundanese, + BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol + ) SWAHILI = T.let( :swahili, @@ -1588,16 +1838,61 @@ module BrandDev :tagalog, BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol ) + TAJIK = + T.let( + :tajik, + BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol + ) + TAMIL = + T.let( + :tamil, + BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol + ) + TATAR = + T.let( + :tatar, + BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol + ) + TELUGU = + T.let( + :telugu, + BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol + ) THAI = T.let( :thai, BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol ) + TIBETAN = + T.let( + :tibetan, + BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol + ) + TIGRINYA = + T.let( + :tigrinya, + BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol + ) + TONGAN = + T.let( + :tongan, + BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol + ) + TSWANA = + T.let( + :tswana, + BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol + ) TURKISH = T.let( :turkish, BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol ) + TURKMEN = + T.let( + :turkmen, + BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol + ) UKRAINIAN = T.let( :ukrainian, @@ -1608,6 +1903,11 @@ module BrandDev :urdu, BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol ) + UYGHUR = + T.let( + :uyghur, + BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol + ) UZBEK = T.let( :uzbek, @@ -1623,6 +1923,31 @@ module BrandDev :welsh, BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol ) + WOLOF = + T.let( + :wolof, + BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol + ) + XHOSA = + T.let( + :xhosa, + BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol + ) + YIDDISH = + T.let( + :yiddish, + BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol + ) + YORUBA = + T.let( + :yoruba, + BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol + ) + ZULU = + T.let( + :zulu, + BrandDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol + ) sig do override.returns( diff --git a/rbi/brand_dev/models/brand_retrieve_by_name_response.rbi b/rbi/brand_dev/models/brand_retrieve_by_name_response.rbi index c9b9c4e..723239d 100644 --- a/rbi/brand_dev/models/brand_retrieve_by_name_response.rbi +++ b/rbi/brand_dev/models/brand_retrieve_by_name_response.rbi @@ -231,6 +231,17 @@ module BrandDev sig { params(phone: String).void } attr_writer :phone + # The primary language of the brand's website content. Detected from the HTML lang + # tag, page content analysis, or social media descriptions. + sig do + returns( + T.nilable( + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ) + end + attr_accessor :primary_language + # The brand's slogan sig { returns(T.nilable(String)) } attr_reader :slogan @@ -312,6 +323,10 @@ module BrandDev BrandDev::Models::BrandRetrieveByNameResponse::Brand::Logo::OrHash ], phone: String, + primary_language: + T.nilable( + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::OrSymbol + ), slogan: String, socials: T::Array[ @@ -345,6 +360,9 @@ module BrandDev logos: nil, # Company phone number phone: nil, + # The primary language of the brand's website content. Detected from the HTML lang + # tag, page content analysis, or social media descriptions. + primary_language: nil, # The brand's slogan slogan: nil, # An array of social media links for the brand @@ -383,6 +401,10 @@ module BrandDev BrandDev::Models::BrandRetrieveByNameResponse::Brand::Logo ], phone: String, + primary_language: + T.nilable( + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ), slogan: String, socials: T::Array[ @@ -2505,6 +2527,632 @@ module BrandDev end end + # The primary language of the brand's website content. Detected from the HTML lang + # tag, page content analysis, or social media descriptions. + module PrimaryLanguage + extend BrandDev::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + AFRIKAANS = + T.let( + :afrikaans, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ALBANIAN = + T.let( + :albanian, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + AMHARIC = + T.let( + :amharic, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ARABIC = + T.let( + :arabic, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ARMENIAN = + T.let( + :armenian, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ASSAMESE = + T.let( + :assamese, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + AYMARA = + T.let( + :aymara, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + AZERI = + T.let( + :azeri, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + BASQUE = + T.let( + :basque, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + BELARUSIAN = + T.let( + :belarusian, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + BENGALI = + T.let( + :bengali, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + BOSNIAN = + T.let( + :bosnian, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + BULGARIAN = + T.let( + :bulgarian, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + BURMESE = + T.let( + :burmese, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + CANTONESE = + T.let( + :cantonese, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + CATALAN = + T.let( + :catalan, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + CEBUANO = + T.let( + :cebuano, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + CHINESE = + T.let( + :chinese, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + CORSICAN = + T.let( + :corsican, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + CROATIAN = + T.let( + :croatian, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + CZECH = + T.let( + :czech, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + DANISH = + T.let( + :danish, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + DUTCH = + T.let( + :dutch, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ENGLISH = + T.let( + :english, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ESPERANTO = + T.let( + :esperanto, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ESTONIAN = + T.let( + :estonian, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + FARSI = + T.let( + :farsi, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + FIJIAN = + T.let( + :fijian, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + FINNISH = + T.let( + :finnish, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + FRENCH = + T.let( + :french, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + GALICIAN = + T.let( + :galician, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + GEORGIAN = + T.let( + :georgian, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + GERMAN = + T.let( + :german, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + GREEK = + T.let( + :greek, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + GUARANI = + T.let( + :guarani, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + GUJARATI = + T.let( + :gujarati, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + HAITIAN_CREOLE = + T.let( + :"haitian-creole", + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + HAUSA = + T.let( + :hausa, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + HAWAIIAN = + T.let( + :hawaiian, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + HEBREW = + T.let( + :hebrew, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + HINDI = + T.let( + :hindi, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + HMONG = + T.let( + :hmong, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + HUNGARIAN = + T.let( + :hungarian, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ICELANDIC = + T.let( + :icelandic, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + IGBO = + T.let( + :igbo, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + INDONESIAN = + T.let( + :indonesian, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + IRISH = + T.let( + :irish, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ITALIAN = + T.let( + :italian, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + JAPANESE = + T.let( + :japanese, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + JAVANESE = + T.let( + :javanese, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + KANNADA = + T.let( + :kannada, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + KAZAKH = + T.let( + :kazakh, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + KHMER = + T.let( + :khmer, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + KINYARWANDA = + T.let( + :kinyarwanda, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + KOREAN = + T.let( + :korean, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + KURDISH = + T.let( + :kurdish, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + KYRGYZ = + T.let( + :kyrgyz, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + LAO = + T.let( + :lao, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + LATIN = + T.let( + :latin, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + LATVIAN = + T.let( + :latvian, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + LINGALA = + T.let( + :lingala, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + LITHUANIAN = + T.let( + :lithuanian, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + LUXEMBOURGISH = + T.let( + :luxembourgish, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + MACEDONIAN = + T.let( + :macedonian, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + MALAGASY = + T.let( + :malagasy, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + MALAY = + T.let( + :malay, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + MALAYALAM = + T.let( + :malayalam, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + MALTESE = + T.let( + :maltese, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + MAORI = + T.let( + :maori, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + MARATHI = + T.let( + :marathi, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + MONGOLIAN = + T.let( + :mongolian, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + NEPALI = + T.let( + :nepali, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + NORWEGIAN = + T.let( + :norwegian, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ODIA = + T.let( + :odia, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + OROMO = + T.let( + :oromo, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + PASHTO = + T.let( + :pashto, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + PIDGIN = + T.let( + :pidgin, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + POLISH = + T.let( + :polish, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + PORTUGUESE = + T.let( + :portuguese, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + PUNJABI = + T.let( + :punjabi, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + QUECHUA = + T.let( + :quechua, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ROMANIAN = + T.let( + :romanian, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + RUSSIAN = + T.let( + :russian, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SAMOAN = + T.let( + :samoan, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SCOTTISH_GAELIC = + T.let( + :"scottish-gaelic", + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SERBIAN = + T.let( + :serbian, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SESOTHO = + T.let( + :sesotho, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SHONA = + T.let( + :shona, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SINDHI = + T.let( + :sindhi, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SINHALA = + T.let( + :sinhala, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SLOVAK = + T.let( + :slovak, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SLOVENE = + T.let( + :slovene, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SOMALI = + T.let( + :somali, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SPANISH = + T.let( + :spanish, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SUNDANESE = + T.let( + :sundanese, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SWAHILI = + T.let( + :swahili, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SWEDISH = + T.let( + :swedish, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + TAGALOG = + T.let( + :tagalog, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + TAJIK = + T.let( + :tajik, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + TAMIL = + T.let( + :tamil, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + TATAR = + T.let( + :tatar, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + TELUGU = + T.let( + :telugu, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + THAI = + T.let( + :thai, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + TIBETAN = + T.let( + :tibetan, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + TIGRINYA = + T.let( + :tigrinya, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + TONGAN = + T.let( + :tongan, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + TSWANA = + T.let( + :tswana, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + TURKISH = + T.let( + :turkish, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + TURKMEN = + T.let( + :turkmen, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + UKRAINIAN = + T.let( + :ukrainian, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + URDU = + T.let( + :urdu, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + UYGHUR = + T.let( + :uyghur, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + UZBEK = + T.let( + :uzbek, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + VIETNAMESE = + T.let( + :vietnamese, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + WELSH = + T.let( + :welsh, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + WOLOF = + T.let( + :wolof, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + XHOSA = + T.let( + :xhosa, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + YIDDISH = + T.let( + :yiddish, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + YORUBA = + T.let( + :yoruba, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ZULU = + T.let( + :zulu, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + BrandDev::Models::BrandRetrieveByNameResponse::Brand::PrimaryLanguage::TaggedSymbol + ] + ) + end + def self.values + end + end + class Social < BrandDev::Internal::Type::BaseModel OrHash = T.type_alias do diff --git a/rbi/brand_dev/models/brand_retrieve_by_ticker_params.rbi b/rbi/brand_dev/models/brand_retrieve_by_ticker_params.rbi index addf9cc..19fc9f3 100644 --- a/rbi/brand_dev/models/brand_retrieve_by_ticker_params.rbi +++ b/rbi/brand_dev/models/brand_retrieve_by_ticker_params.rbi @@ -132,41 +132,101 @@ module BrandDev end OrSymbol = T.type_alias { T.any(Symbol, String) } + AFRIKAANS = + T.let( + :afrikaans, + BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol + ) ALBANIAN = T.let( :albanian, BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol ) + AMHARIC = + T.let( + :amharic, + BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol + ) ARABIC = T.let( :arabic, BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol ) + ARMENIAN = + T.let( + :armenian, + BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol + ) + ASSAMESE = + T.let( + :assamese, + BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol + ) + AYMARA = + T.let( + :aymara, + BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol + ) AZERI = T.let( :azeri, BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol ) + BASQUE = + T.let( + :basque, + BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol + ) + BELARUSIAN = + T.let( + :belarusian, + BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol + ) BENGALI = T.let( :bengali, BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol ) + BOSNIAN = + T.let( + :bosnian, + BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol + ) BULGARIAN = T.let( :bulgarian, BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol ) + BURMESE = + T.let( + :burmese, + BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol + ) CANTONESE = T.let( :cantonese, BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol ) + CATALAN = + T.let( + :catalan, + BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol + ) CEBUANO = T.let( :cebuano, BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol ) + CHINESE = + T.let( + :chinese, + BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol + ) + CORSICAN = + T.let( + :corsican, + BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol + ) CROATIAN = T.let( :croatian, @@ -192,6 +252,11 @@ module BrandDev :english, BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol ) + ESPERANTO = + T.let( + :esperanto, + BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol + ) ESTONIAN = T.let( :estonian, @@ -202,6 +267,11 @@ module BrandDev :farsi, BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol ) + FIJIAN = + T.let( + :fijian, + BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol + ) FINNISH = T.let( :finnish, @@ -212,11 +282,41 @@ module BrandDev :french, BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol ) + GALICIAN = + T.let( + :galician, + BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol + ) + GEORGIAN = + T.let( + :georgian, + BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol + ) GERMAN = T.let( :german, BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol ) + GREEK = + T.let( + :greek, + BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol + ) + GUARANI = + T.let( + :guarani, + BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol + ) + GUJARATI = + T.let( + :gujarati, + BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol + ) + HAITIAN_CREOLE = + T.let( + :"haitian-creole", + BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol + ) HAUSA = T.let( :hausa, @@ -227,11 +327,21 @@ module BrandDev :hawaiian, BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol ) + HEBREW = + T.let( + :hebrew, + BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol + ) HINDI = T.let( :hindi, BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol ) + HMONG = + T.let( + :hmong, + BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol + ) HUNGARIAN = T.let( :hungarian, @@ -242,31 +352,76 @@ module BrandDev :icelandic, BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol ) + IGBO = + T.let( + :igbo, + BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol + ) INDONESIAN = T.let( :indonesian, BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol ) + IRISH = + T.let( + :irish, + BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol + ) ITALIAN = T.let( :italian, BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol ) + JAPANESE = + T.let( + :japanese, + BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol + ) + JAVANESE = + T.let( + :javanese, + BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol + ) + KANNADA = + T.let( + :kannada, + BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol + ) KAZAKH = T.let( :kazakh, BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol ) + KHMER = + T.let( + :khmer, + BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol + ) + KINYARWANDA = + T.let( + :kinyarwanda, + BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol + ) KOREAN = T.let( :korean, BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol ) + KURDISH = + T.let( + :kurdish, + BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol + ) KYRGYZ = T.let( :kyrgyz, BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol ) + LAO = + T.let( + :lao, + BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol + ) LATIN = T.let( :latin, @@ -277,16 +432,56 @@ module BrandDev :latvian, BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol ) + LINGALA = + T.let( + :lingala, + BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol + ) LITHUANIAN = T.let( :lithuanian, BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol ) + LUXEMBOURGISH = + T.let( + :luxembourgish, + BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol + ) MACEDONIAN = T.let( :macedonian, BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol ) + MALAGASY = + T.let( + :malagasy, + BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol + ) + MALAY = + T.let( + :malay, + BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol + ) + MALAYALAM = + T.let( + :malayalam, + BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol + ) + MALTESE = + T.let( + :maltese, + BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol + ) + MAORI = + T.let( + :maori, + BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol + ) + MARATHI = + T.let( + :marathi, + BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol + ) MONGOLIAN = T.let( :mongolian, @@ -302,6 +497,16 @@ module BrandDev :norwegian, BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol ) + ODIA = + T.let( + :odia, + BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol + ) + OROMO = + T.let( + :oromo, + BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol + ) PASHTO = T.let( :pashto, @@ -322,6 +527,16 @@ module BrandDev :portuguese, BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol ) + PUNJABI = + T.let( + :punjabi, + BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol + ) + QUECHUA = + T.let( + :quechua, + BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol + ) ROMANIAN = T.let( :romanian, @@ -332,11 +547,41 @@ module BrandDev :russian, BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol ) + SAMOAN = + T.let( + :samoan, + BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol + ) + SCOTTISH_GAELIC = + T.let( + :"scottish-gaelic", + BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol + ) SERBIAN = T.let( :serbian, BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol ) + SESOTHO = + T.let( + :sesotho, + BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol + ) + SHONA = + T.let( + :shona, + BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol + ) + SINDHI = + T.let( + :sindhi, + BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol + ) + SINHALA = + T.let( + :sinhala, + BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol + ) SLOVAK = T.let( :slovak, @@ -357,6 +602,11 @@ module BrandDev :spanish, BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol ) + SUNDANESE = + T.let( + :sundanese, + BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol + ) SWAHILI = T.let( :swahili, @@ -372,16 +622,61 @@ module BrandDev :tagalog, BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol ) + TAJIK = + T.let( + :tajik, + BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol + ) + TAMIL = + T.let( + :tamil, + BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol + ) + TATAR = + T.let( + :tatar, + BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol + ) + TELUGU = + T.let( + :telugu, + BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol + ) THAI = T.let( :thai, BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol ) + TIBETAN = + T.let( + :tibetan, + BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol + ) + TIGRINYA = + T.let( + :tigrinya, + BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol + ) + TONGAN = + T.let( + :tongan, + BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol + ) + TSWANA = + T.let( + :tswana, + BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol + ) TURKISH = T.let( :turkish, BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol ) + TURKMEN = + T.let( + :turkmen, + BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol + ) UKRAINIAN = T.let( :ukrainian, @@ -392,6 +687,11 @@ module BrandDev :urdu, BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol ) + UYGHUR = + T.let( + :uyghur, + BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol + ) UZBEK = T.let( :uzbek, @@ -407,6 +707,31 @@ module BrandDev :welsh, BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol ) + WOLOF = + T.let( + :wolof, + BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol + ) + XHOSA = + T.let( + :xhosa, + BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol + ) + YIDDISH = + T.let( + :yiddish, + BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol + ) + YORUBA = + T.let( + :yoruba, + BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol + ) + ZULU = + T.let( + :zulu, + BrandDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol + ) sig do override.returns( diff --git a/rbi/brand_dev/models/brand_retrieve_by_ticker_response.rbi b/rbi/brand_dev/models/brand_retrieve_by_ticker_response.rbi index e7f80c0..1a922b2 100644 --- a/rbi/brand_dev/models/brand_retrieve_by_ticker_response.rbi +++ b/rbi/brand_dev/models/brand_retrieve_by_ticker_response.rbi @@ -233,6 +233,17 @@ module BrandDev sig { params(phone: String).void } attr_writer :phone + # The primary language of the brand's website content. Detected from the HTML lang + # tag, page content analysis, or social media descriptions. + sig do + returns( + T.nilable( + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ) + end + attr_accessor :primary_language + # The brand's slogan sig { returns(T.nilable(String)) } attr_reader :slogan @@ -314,6 +325,10 @@ module BrandDev BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo::OrHash ], phone: String, + primary_language: + T.nilable( + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::OrSymbol + ), slogan: String, socials: T::Array[ @@ -347,6 +362,9 @@ module BrandDev logos: nil, # Company phone number phone: nil, + # The primary language of the brand's website content. Detected from the HTML lang + # tag, page content analysis, or social media descriptions. + primary_language: nil, # The brand's slogan slogan: nil, # An array of social media links for the brand @@ -385,6 +403,10 @@ module BrandDev BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo ], phone: String, + primary_language: + T.nilable( + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ), slogan: String, socials: T::Array[ @@ -2507,6 +2529,632 @@ module BrandDev end end + # The primary language of the brand's website content. Detected from the HTML lang + # tag, page content analysis, or social media descriptions. + module PrimaryLanguage + extend BrandDev::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + AFRIKAANS = + T.let( + :afrikaans, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ALBANIAN = + T.let( + :albanian, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + AMHARIC = + T.let( + :amharic, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ARABIC = + T.let( + :arabic, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ARMENIAN = + T.let( + :armenian, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ASSAMESE = + T.let( + :assamese, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + AYMARA = + T.let( + :aymara, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + AZERI = + T.let( + :azeri, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + BASQUE = + T.let( + :basque, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + BELARUSIAN = + T.let( + :belarusian, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + BENGALI = + T.let( + :bengali, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + BOSNIAN = + T.let( + :bosnian, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + BULGARIAN = + T.let( + :bulgarian, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + BURMESE = + T.let( + :burmese, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + CANTONESE = + T.let( + :cantonese, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + CATALAN = + T.let( + :catalan, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + CEBUANO = + T.let( + :cebuano, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + CHINESE = + T.let( + :chinese, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + CORSICAN = + T.let( + :corsican, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + CROATIAN = + T.let( + :croatian, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + CZECH = + T.let( + :czech, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + DANISH = + T.let( + :danish, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + DUTCH = + T.let( + :dutch, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ENGLISH = + T.let( + :english, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ESPERANTO = + T.let( + :esperanto, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ESTONIAN = + T.let( + :estonian, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + FARSI = + T.let( + :farsi, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + FIJIAN = + T.let( + :fijian, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + FINNISH = + T.let( + :finnish, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + FRENCH = + T.let( + :french, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + GALICIAN = + T.let( + :galician, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + GEORGIAN = + T.let( + :georgian, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + GERMAN = + T.let( + :german, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + GREEK = + T.let( + :greek, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + GUARANI = + T.let( + :guarani, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + GUJARATI = + T.let( + :gujarati, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + HAITIAN_CREOLE = + T.let( + :"haitian-creole", + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + HAUSA = + T.let( + :hausa, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + HAWAIIAN = + T.let( + :hawaiian, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + HEBREW = + T.let( + :hebrew, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + HINDI = + T.let( + :hindi, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + HMONG = + T.let( + :hmong, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + HUNGARIAN = + T.let( + :hungarian, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ICELANDIC = + T.let( + :icelandic, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + IGBO = + T.let( + :igbo, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + INDONESIAN = + T.let( + :indonesian, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + IRISH = + T.let( + :irish, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ITALIAN = + T.let( + :italian, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + JAPANESE = + T.let( + :japanese, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + JAVANESE = + T.let( + :javanese, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + KANNADA = + T.let( + :kannada, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + KAZAKH = + T.let( + :kazakh, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + KHMER = + T.let( + :khmer, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + KINYARWANDA = + T.let( + :kinyarwanda, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + KOREAN = + T.let( + :korean, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + KURDISH = + T.let( + :kurdish, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + KYRGYZ = + T.let( + :kyrgyz, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + LAO = + T.let( + :lao, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + LATIN = + T.let( + :latin, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + LATVIAN = + T.let( + :latvian, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + LINGALA = + T.let( + :lingala, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + LITHUANIAN = + T.let( + :lithuanian, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + LUXEMBOURGISH = + T.let( + :luxembourgish, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + MACEDONIAN = + T.let( + :macedonian, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + MALAGASY = + T.let( + :malagasy, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + MALAY = + T.let( + :malay, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + MALAYALAM = + T.let( + :malayalam, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + MALTESE = + T.let( + :maltese, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + MAORI = + T.let( + :maori, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + MARATHI = + T.let( + :marathi, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + MONGOLIAN = + T.let( + :mongolian, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + NEPALI = + T.let( + :nepali, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + NORWEGIAN = + T.let( + :norwegian, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ODIA = + T.let( + :odia, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + OROMO = + T.let( + :oromo, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + PASHTO = + T.let( + :pashto, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + PIDGIN = + T.let( + :pidgin, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + POLISH = + T.let( + :polish, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + PORTUGUESE = + T.let( + :portuguese, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + PUNJABI = + T.let( + :punjabi, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + QUECHUA = + T.let( + :quechua, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ROMANIAN = + T.let( + :romanian, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + RUSSIAN = + T.let( + :russian, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SAMOAN = + T.let( + :samoan, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SCOTTISH_GAELIC = + T.let( + :"scottish-gaelic", + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SERBIAN = + T.let( + :serbian, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SESOTHO = + T.let( + :sesotho, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SHONA = + T.let( + :shona, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SINDHI = + T.let( + :sindhi, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SINHALA = + T.let( + :sinhala, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SLOVAK = + T.let( + :slovak, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SLOVENE = + T.let( + :slovene, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SOMALI = + T.let( + :somali, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SPANISH = + T.let( + :spanish, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SUNDANESE = + T.let( + :sundanese, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SWAHILI = + T.let( + :swahili, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SWEDISH = + T.let( + :swedish, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + TAGALOG = + T.let( + :tagalog, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + TAJIK = + T.let( + :tajik, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + TAMIL = + T.let( + :tamil, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + TATAR = + T.let( + :tatar, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + TELUGU = + T.let( + :telugu, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + THAI = + T.let( + :thai, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + TIBETAN = + T.let( + :tibetan, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + TIGRINYA = + T.let( + :tigrinya, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + TONGAN = + T.let( + :tongan, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + TSWANA = + T.let( + :tswana, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + TURKISH = + T.let( + :turkish, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + TURKMEN = + T.let( + :turkmen, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + UKRAINIAN = + T.let( + :ukrainian, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + URDU = + T.let( + :urdu, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + UYGHUR = + T.let( + :uyghur, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + UZBEK = + T.let( + :uzbek, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + VIETNAMESE = + T.let( + :vietnamese, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + WELSH = + T.let( + :welsh, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + WOLOF = + T.let( + :wolof, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + XHOSA = + T.let( + :xhosa, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + YIDDISH = + T.let( + :yiddish, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + YORUBA = + T.let( + :yoruba, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ZULU = + T.let( + :zulu, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::PrimaryLanguage::TaggedSymbol + ] + ) + end + def self.values + end + end + class Social < BrandDev::Internal::Type::BaseModel OrHash = T.type_alias do diff --git a/rbi/brand_dev/models/brand_retrieve_params.rbi b/rbi/brand_dev/models/brand_retrieve_params.rbi index 49194ff..822fd02 100644 --- a/rbi/brand_dev/models/brand_retrieve_params.rbi +++ b/rbi/brand_dev/models/brand_retrieve_params.rbi @@ -16,8 +16,7 @@ module BrandDev sig { returns(String) } attr_accessor :domain - # Optional parameter to force the language of the retrieved brand data. Works with - # all three lookup methods. + # Optional parameter to force the language of the retrieved brand data. sig do returns( T.nilable(BrandDev::BrandRetrieveParams::ForceLanguage::OrSymbol) @@ -64,8 +63,7 @@ module BrandDev # Domain name to retrieve brand data for (e.g., 'example.com', 'google.com'). # Cannot be used with name or ticker parameters. domain:, - # Optional parameter to force the language of the retrieved brand data. Works with - # all three lookup methods. + # Optional parameter to force the language of the retrieved brand data. force_language: nil, # Optional parameter to optimize the API call for maximum speed. When set to true, # the API will skip time-consuming operations for faster response at the cost of @@ -94,8 +92,7 @@ module BrandDev def to_hash end - # Optional parameter to force the language of the retrieved brand data. Works with - # all three lookup methods. + # Optional parameter to force the language of the retrieved brand data. module ForceLanguage extend BrandDev::Internal::Type::Enum @@ -105,41 +102,101 @@ module BrandDev end OrSymbol = T.type_alias { T.any(Symbol, String) } + AFRIKAANS = + T.let( + :afrikaans, + BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol + ) ALBANIAN = T.let( :albanian, BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol ) + AMHARIC = + T.let( + :amharic, + BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol + ) ARABIC = T.let( :arabic, BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol ) + ARMENIAN = + T.let( + :armenian, + BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol + ) + ASSAMESE = + T.let( + :assamese, + BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol + ) + AYMARA = + T.let( + :aymara, + BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol + ) AZERI = T.let( :azeri, BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol ) + BASQUE = + T.let( + :basque, + BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol + ) + BELARUSIAN = + T.let( + :belarusian, + BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol + ) BENGALI = T.let( :bengali, BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol ) + BOSNIAN = + T.let( + :bosnian, + BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol + ) BULGARIAN = T.let( :bulgarian, BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol ) + BURMESE = + T.let( + :burmese, + BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol + ) CANTONESE = T.let( :cantonese, BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol ) + CATALAN = + T.let( + :catalan, + BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol + ) CEBUANO = T.let( :cebuano, BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol ) + CHINESE = + T.let( + :chinese, + BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol + ) + CORSICAN = + T.let( + :corsican, + BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol + ) CROATIAN = T.let( :croatian, @@ -165,6 +222,11 @@ module BrandDev :english, BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol ) + ESPERANTO = + T.let( + :esperanto, + BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol + ) ESTONIAN = T.let( :estonian, @@ -175,6 +237,11 @@ module BrandDev :farsi, BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol ) + FIJIAN = + T.let( + :fijian, + BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol + ) FINNISH = T.let( :finnish, @@ -185,11 +252,41 @@ module BrandDev :french, BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol ) + GALICIAN = + T.let( + :galician, + BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol + ) + GEORGIAN = + T.let( + :georgian, + BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol + ) GERMAN = T.let( :german, BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol ) + GREEK = + T.let( + :greek, + BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol + ) + GUARANI = + T.let( + :guarani, + BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol + ) + GUJARATI = + T.let( + :gujarati, + BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol + ) + HAITIAN_CREOLE = + T.let( + :"haitian-creole", + BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol + ) HAUSA = T.let( :hausa, @@ -200,11 +297,21 @@ module BrandDev :hawaiian, BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol ) + HEBREW = + T.let( + :hebrew, + BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol + ) HINDI = T.let( :hindi, BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol ) + HMONG = + T.let( + :hmong, + BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol + ) HUNGARIAN = T.let( :hungarian, @@ -215,31 +322,76 @@ module BrandDev :icelandic, BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol ) + IGBO = + T.let( + :igbo, + BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol + ) INDONESIAN = T.let( :indonesian, BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol ) + IRISH = + T.let( + :irish, + BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol + ) ITALIAN = T.let( :italian, BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol ) + JAPANESE = + T.let( + :japanese, + BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol + ) + JAVANESE = + T.let( + :javanese, + BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol + ) + KANNADA = + T.let( + :kannada, + BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol + ) KAZAKH = T.let( :kazakh, BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol ) + KHMER = + T.let( + :khmer, + BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol + ) + KINYARWANDA = + T.let( + :kinyarwanda, + BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol + ) KOREAN = T.let( :korean, BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol ) + KURDISH = + T.let( + :kurdish, + BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol + ) KYRGYZ = T.let( :kyrgyz, BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol ) + LAO = + T.let( + :lao, + BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol + ) LATIN = T.let( :latin, @@ -250,16 +402,56 @@ module BrandDev :latvian, BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol ) + LINGALA = + T.let( + :lingala, + BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol + ) LITHUANIAN = T.let( :lithuanian, BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol ) + LUXEMBOURGISH = + T.let( + :luxembourgish, + BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol + ) MACEDONIAN = T.let( :macedonian, BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol ) + MALAGASY = + T.let( + :malagasy, + BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol + ) + MALAY = + T.let( + :malay, + BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol + ) + MALAYALAM = + T.let( + :malayalam, + BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol + ) + MALTESE = + T.let( + :maltese, + BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol + ) + MAORI = + T.let( + :maori, + BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol + ) + MARATHI = + T.let( + :marathi, + BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol + ) MONGOLIAN = T.let( :mongolian, @@ -275,6 +467,16 @@ module BrandDev :norwegian, BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol ) + ODIA = + T.let( + :odia, + BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol + ) + OROMO = + T.let( + :oromo, + BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol + ) PASHTO = T.let( :pashto, @@ -295,6 +497,16 @@ module BrandDev :portuguese, BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol ) + PUNJABI = + T.let( + :punjabi, + BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol + ) + QUECHUA = + T.let( + :quechua, + BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol + ) ROMANIAN = T.let( :romanian, @@ -305,11 +517,41 @@ module BrandDev :russian, BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol ) + SAMOAN = + T.let( + :samoan, + BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol + ) + SCOTTISH_GAELIC = + T.let( + :"scottish-gaelic", + BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol + ) SERBIAN = T.let( :serbian, BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol ) + SESOTHO = + T.let( + :sesotho, + BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol + ) + SHONA = + T.let( + :shona, + BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol + ) + SINDHI = + T.let( + :sindhi, + BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol + ) + SINHALA = + T.let( + :sinhala, + BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol + ) SLOVAK = T.let( :slovak, @@ -330,6 +572,11 @@ module BrandDev :spanish, BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol ) + SUNDANESE = + T.let( + :sundanese, + BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol + ) SWAHILI = T.let( :swahili, @@ -345,16 +592,61 @@ module BrandDev :tagalog, BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol ) + TAJIK = + T.let( + :tajik, + BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol + ) + TAMIL = + T.let( + :tamil, + BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol + ) + TATAR = + T.let( + :tatar, + BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol + ) + TELUGU = + T.let( + :telugu, + BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol + ) THAI = T.let( :thai, BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol ) + TIBETAN = + T.let( + :tibetan, + BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol + ) + TIGRINYA = + T.let( + :tigrinya, + BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol + ) + TONGAN = + T.let( + :tongan, + BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol + ) + TSWANA = + T.let( + :tswana, + BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol + ) TURKISH = T.let( :turkish, BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol ) + TURKMEN = + T.let( + :turkmen, + BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol + ) UKRAINIAN = T.let( :ukrainian, @@ -365,6 +657,11 @@ module BrandDev :urdu, BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol ) + UYGHUR = + T.let( + :uyghur, + BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol + ) UZBEK = T.let( :uzbek, @@ -380,6 +677,31 @@ module BrandDev :welsh, BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol ) + WOLOF = + T.let( + :wolof, + BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol + ) + XHOSA = + T.let( + :xhosa, + BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol + ) + YIDDISH = + T.let( + :yiddish, + BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol + ) + YORUBA = + T.let( + :yoruba, + BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol + ) + ZULU = + T.let( + :zulu, + BrandDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol + ) sig do override.returns( diff --git a/rbi/brand_dev/models/brand_retrieve_response.rbi b/rbi/brand_dev/models/brand_retrieve_response.rbi index 89c5903..c7ae557 100644 --- a/rbi/brand_dev/models/brand_retrieve_response.rbi +++ b/rbi/brand_dev/models/brand_retrieve_response.rbi @@ -218,6 +218,17 @@ module BrandDev sig { params(phone: String).void } attr_writer :phone + # The primary language of the brand's website content. Detected from the HTML lang + # tag, page content analysis, or social media descriptions. + sig do + returns( + T.nilable( + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ) + end + attr_accessor :primary_language + # The brand's slogan sig { returns(T.nilable(String)) } attr_reader :slogan @@ -294,6 +305,10 @@ module BrandDev BrandDev::Models::BrandRetrieveResponse::Brand::Logo::OrHash ], phone: String, + primary_language: + T.nilable( + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::OrSymbol + ), slogan: String, socials: T::Array[ @@ -327,6 +342,9 @@ module BrandDev logos: nil, # Company phone number phone: nil, + # The primary language of the brand's website content. Detected from the HTML lang + # tag, page content analysis, or social media descriptions. + primary_language: nil, # The brand's slogan slogan: nil, # An array of social media links for the brand @@ -359,6 +377,10 @@ module BrandDev logos: T::Array[BrandDev::Models::BrandRetrieveResponse::Brand::Logo], phone: String, + primary_language: + T.nilable( + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ), slogan: String, socials: T::Array[ @@ -2480,6 +2502,632 @@ module BrandDev end end + # The primary language of the brand's website content. Detected from the HTML lang + # tag, page content analysis, or social media descriptions. + module PrimaryLanguage + extend BrandDev::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + AFRIKAANS = + T.let( + :afrikaans, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ALBANIAN = + T.let( + :albanian, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + AMHARIC = + T.let( + :amharic, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ARABIC = + T.let( + :arabic, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ARMENIAN = + T.let( + :armenian, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ASSAMESE = + T.let( + :assamese, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + AYMARA = + T.let( + :aymara, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + AZERI = + T.let( + :azeri, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + BASQUE = + T.let( + :basque, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + BELARUSIAN = + T.let( + :belarusian, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + BENGALI = + T.let( + :bengali, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + BOSNIAN = + T.let( + :bosnian, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + BULGARIAN = + T.let( + :bulgarian, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + BURMESE = + T.let( + :burmese, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + CANTONESE = + T.let( + :cantonese, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + CATALAN = + T.let( + :catalan, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + CEBUANO = + T.let( + :cebuano, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + CHINESE = + T.let( + :chinese, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + CORSICAN = + T.let( + :corsican, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + CROATIAN = + T.let( + :croatian, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + CZECH = + T.let( + :czech, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + DANISH = + T.let( + :danish, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + DUTCH = + T.let( + :dutch, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ENGLISH = + T.let( + :english, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ESPERANTO = + T.let( + :esperanto, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ESTONIAN = + T.let( + :estonian, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + FARSI = + T.let( + :farsi, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + FIJIAN = + T.let( + :fijian, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + FINNISH = + T.let( + :finnish, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + FRENCH = + T.let( + :french, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + GALICIAN = + T.let( + :galician, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + GEORGIAN = + T.let( + :georgian, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + GERMAN = + T.let( + :german, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + GREEK = + T.let( + :greek, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + GUARANI = + T.let( + :guarani, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + GUJARATI = + T.let( + :gujarati, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + HAITIAN_CREOLE = + T.let( + :"haitian-creole", + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + HAUSA = + T.let( + :hausa, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + HAWAIIAN = + T.let( + :hawaiian, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + HEBREW = + T.let( + :hebrew, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + HINDI = + T.let( + :hindi, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + HMONG = + T.let( + :hmong, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + HUNGARIAN = + T.let( + :hungarian, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ICELANDIC = + T.let( + :icelandic, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + IGBO = + T.let( + :igbo, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + INDONESIAN = + T.let( + :indonesian, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + IRISH = + T.let( + :irish, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ITALIAN = + T.let( + :italian, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + JAPANESE = + T.let( + :japanese, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + JAVANESE = + T.let( + :javanese, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + KANNADA = + T.let( + :kannada, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + KAZAKH = + T.let( + :kazakh, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + KHMER = + T.let( + :khmer, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + KINYARWANDA = + T.let( + :kinyarwanda, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + KOREAN = + T.let( + :korean, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + KURDISH = + T.let( + :kurdish, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + KYRGYZ = + T.let( + :kyrgyz, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + LAO = + T.let( + :lao, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + LATIN = + T.let( + :latin, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + LATVIAN = + T.let( + :latvian, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + LINGALA = + T.let( + :lingala, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + LITHUANIAN = + T.let( + :lithuanian, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + LUXEMBOURGISH = + T.let( + :luxembourgish, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + MACEDONIAN = + T.let( + :macedonian, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + MALAGASY = + T.let( + :malagasy, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + MALAY = + T.let( + :malay, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + MALAYALAM = + T.let( + :malayalam, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + MALTESE = + T.let( + :maltese, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + MAORI = + T.let( + :maori, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + MARATHI = + T.let( + :marathi, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + MONGOLIAN = + T.let( + :mongolian, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + NEPALI = + T.let( + :nepali, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + NORWEGIAN = + T.let( + :norwegian, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ODIA = + T.let( + :odia, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + OROMO = + T.let( + :oromo, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + PASHTO = + T.let( + :pashto, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + PIDGIN = + T.let( + :pidgin, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + POLISH = + T.let( + :polish, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + PORTUGUESE = + T.let( + :portuguese, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + PUNJABI = + T.let( + :punjabi, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + QUECHUA = + T.let( + :quechua, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ROMANIAN = + T.let( + :romanian, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + RUSSIAN = + T.let( + :russian, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SAMOAN = + T.let( + :samoan, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SCOTTISH_GAELIC = + T.let( + :"scottish-gaelic", + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SERBIAN = + T.let( + :serbian, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SESOTHO = + T.let( + :sesotho, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SHONA = + T.let( + :shona, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SINDHI = + T.let( + :sindhi, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SINHALA = + T.let( + :sinhala, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SLOVAK = + T.let( + :slovak, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SLOVENE = + T.let( + :slovene, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SOMALI = + T.let( + :somali, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SPANISH = + T.let( + :spanish, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SUNDANESE = + T.let( + :sundanese, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SWAHILI = + T.let( + :swahili, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + SWEDISH = + T.let( + :swedish, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + TAGALOG = + T.let( + :tagalog, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + TAJIK = + T.let( + :tajik, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + TAMIL = + T.let( + :tamil, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + TATAR = + T.let( + :tatar, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + TELUGU = + T.let( + :telugu, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + THAI = + T.let( + :thai, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + TIBETAN = + T.let( + :tibetan, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + TIGRINYA = + T.let( + :tigrinya, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + TONGAN = + T.let( + :tongan, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + TSWANA = + T.let( + :tswana, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + TURKISH = + T.let( + :turkish, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + TURKMEN = + T.let( + :turkmen, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + UKRAINIAN = + T.let( + :ukrainian, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + URDU = + T.let( + :urdu, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + UYGHUR = + T.let( + :uyghur, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + UZBEK = + T.let( + :uzbek, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + VIETNAMESE = + T.let( + :vietnamese, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + WELSH = + T.let( + :welsh, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + WOLOF = + T.let( + :wolof, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + XHOSA = + T.let( + :xhosa, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + YIDDISH = + T.let( + :yiddish, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + YORUBA = + T.let( + :yoruba, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + ZULU = + T.let( + :zulu, + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + BrandDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage::TaggedSymbol + ] + ) + end + def self.values + end + end + class Social < BrandDev::Internal::Type::BaseModel OrHash = T.type_alias do diff --git a/rbi/brand_dev/resources/brand.rbi b/rbi/brand_dev/resources/brand.rbi index 40f6081..75c19a6 100644 --- a/rbi/brand_dev/resources/brand.rbi +++ b/rbi/brand_dev/resources/brand.rbi @@ -19,8 +19,7 @@ module BrandDev # Domain name to retrieve brand data for (e.g., 'example.com', 'google.com'). # Cannot be used with name or ticker parameters. domain:, - # Optional parameter to force the language of the retrieved brand data. Works with - # all three lookup methods. + # Optional parameter to force the language of the retrieved brand data. force_language: nil, # Optional parameter to optimize the API call for maximum speed. When set to true, # the API will skip time-consuming operations for faster response at the cost of diff --git a/sig/brand_dev/models/brand_identify_from_transaction_params.rbs b/sig/brand_dev/models/brand_identify_from_transaction_params.rbs index 83291e1..e9a643d 100644 --- a/sig/brand_dev/models/brand_identify_from_transaction_params.rbs +++ b/sig/brand_dev/models/brand_identify_from_transaction_params.rbs @@ -570,120 +570,250 @@ module BrandDev end type force_language = - :albanian + :afrikaans + | :albanian + | :amharic | :arabic + | :armenian + | :assamese + | :aymara | :azeri + | :basque + | :belarusian | :bengali + | :bosnian | :bulgarian + | :burmese | :cantonese + | :catalan | :cebuano + | :chinese + | :corsican | :croatian | :czech | :danish | :dutch | :english + | :esperanto | :estonian | :farsi + | :fijian | :finnish | :french + | :galician + | :georgian | :german + | :greek + | :guarani + | :gujarati + | :"haitian-creole" | :hausa | :hawaiian + | :hebrew | :hindi + | :hmong | :hungarian | :icelandic + | :igbo | :indonesian + | :irish | :italian + | :japanese + | :javanese + | :kannada | :kazakh + | :khmer + | :kinyarwanda | :korean + | :kurdish | :kyrgyz + | :lao | :latin | :latvian + | :lingala | :lithuanian + | :luxembourgish | :macedonian + | :malagasy + | :malay + | :malayalam + | :maltese + | :maori + | :marathi | :mongolian | :nepali | :norwegian + | :odia + | :oromo | :pashto | :pidgin | :polish | :portuguese + | :punjabi + | :quechua | :romanian | :russian + | :samoan + | :"scottish-gaelic" | :serbian + | :sesotho + | :shona + | :sindhi + | :sinhala | :slovak | :slovene | :somali | :spanish + | :sundanese | :swahili | :swedish | :tagalog + | :tajik + | :tamil + | :tatar + | :telugu | :thai + | :tibetan + | :tigrinya + | :tongan + | :tswana | :turkish + | :turkmen | :ukrainian | :urdu + | :uyghur | :uzbek | :vietnamese | :welsh + | :wolof + | :xhosa + | :yiddish + | :yoruba + | :zulu module ForceLanguage extend BrandDev::Internal::Type::Enum + AFRIKAANS: :afrikaans ALBANIAN: :albanian + AMHARIC: :amharic ARABIC: :arabic + ARMENIAN: :armenian + ASSAMESE: :assamese + AYMARA: :aymara AZERI: :azeri + BASQUE: :basque + BELARUSIAN: :belarusian BENGALI: :bengali + BOSNIAN: :bosnian BULGARIAN: :bulgarian + BURMESE: :burmese CANTONESE: :cantonese + CATALAN: :catalan CEBUANO: :cebuano + CHINESE: :chinese + CORSICAN: :corsican CROATIAN: :croatian CZECH: :czech DANISH: :danish DUTCH: :dutch ENGLISH: :english + ESPERANTO: :esperanto ESTONIAN: :estonian FARSI: :farsi + FIJIAN: :fijian FINNISH: :finnish FRENCH: :french + GALICIAN: :galician + GEORGIAN: :georgian GERMAN: :german + GREEK: :greek + GUARANI: :guarani + GUJARATI: :gujarati + HAITIAN_CREOLE: :"haitian-creole" HAUSA: :hausa HAWAIIAN: :hawaiian + HEBREW: :hebrew HINDI: :hindi + HMONG: :hmong HUNGARIAN: :hungarian ICELANDIC: :icelandic + IGBO: :igbo INDONESIAN: :indonesian + IRISH: :irish ITALIAN: :italian + JAPANESE: :japanese + JAVANESE: :javanese + KANNADA: :kannada KAZAKH: :kazakh + KHMER: :khmer + KINYARWANDA: :kinyarwanda KOREAN: :korean + KURDISH: :kurdish KYRGYZ: :kyrgyz + LAO: :lao LATIN: :latin LATVIAN: :latvian + LINGALA: :lingala LITHUANIAN: :lithuanian + LUXEMBOURGISH: :luxembourgish MACEDONIAN: :macedonian + MALAGASY: :malagasy + MALAY: :malay + MALAYALAM: :malayalam + MALTESE: :maltese + MAORI: :maori + MARATHI: :marathi MONGOLIAN: :mongolian NEPALI: :nepali NORWEGIAN: :norwegian + ODIA: :odia + OROMO: :oromo PASHTO: :pashto PIDGIN: :pidgin POLISH: :polish PORTUGUESE: :portuguese + PUNJABI: :punjabi + QUECHUA: :quechua ROMANIAN: :romanian RUSSIAN: :russian + SAMOAN: :samoan + SCOTTISH_GAELIC: :"scottish-gaelic" SERBIAN: :serbian + SESOTHO: :sesotho + SHONA: :shona + SINDHI: :sindhi + SINHALA: :sinhala SLOVAK: :slovak SLOVENE: :slovene SOMALI: :somali SPANISH: :spanish + SUNDANESE: :sundanese SWAHILI: :swahili SWEDISH: :swedish TAGALOG: :tagalog + TAJIK: :tajik + TAMIL: :tamil + TATAR: :tatar + TELUGU: :telugu THAI: :thai + TIBETAN: :tibetan + TIGRINYA: :tigrinya + TONGAN: :tongan + TSWANA: :tswana TURKISH: :turkish + TURKMEN: :turkmen UKRAINIAN: :ukrainian URDU: :urdu + UYGHUR: :uyghur UZBEK: :uzbek VIETNAMESE: :vietnamese WELSH: :welsh + WOLOF: :wolof + XHOSA: :xhosa + YIDDISH: :yiddish + YORUBA: :yoruba + ZULU: :zulu def self?.values: -> ::Array[BrandDev::Models::BrandIdentifyFromTransactionParams::force_language] end diff --git a/sig/brand_dev/models/brand_identify_from_transaction_response.rbs b/sig/brand_dev/models/brand_identify_from_transaction_response.rbs index 3021aa0..d141f4a 100644 --- a/sig/brand_dev/models/brand_identify_from_transaction_response.rbs +++ b/sig/brand_dev/models/brand_identify_from_transaction_response.rbs @@ -47,6 +47,7 @@ module BrandDev links: BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Links, logos: ::Array[BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo], phone: String, + primary_language: BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::primary_language?, slogan: String, socials: ::Array[BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Social], stock: BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Stock, @@ -110,6 +111,8 @@ module BrandDev def phone=: (String) -> String + attr_accessor primary_language: BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::primary_language? + attr_reader slogan: String? def slogan=: (String) -> String @@ -142,6 +145,7 @@ module BrandDev ?links: BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Links, ?logos: ::Array[BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo], ?phone: String, + ?primary_language: BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::primary_language?, ?slogan: String, ?socials: ::Array[BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Social], ?stock: BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Stock, @@ -160,6 +164,7 @@ module BrandDev links: BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Links, logos: ::Array[BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo], phone: String, + primary_language: BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::primary_language?, slogan: String, socials: ::Array[BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Social], stock: BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Stock, @@ -1039,6 +1044,255 @@ module BrandDev end end + type primary_language = + :afrikaans + | :albanian + | :amharic + | :arabic + | :armenian + | :assamese + | :aymara + | :azeri + | :basque + | :belarusian + | :bengali + | :bosnian + | :bulgarian + | :burmese + | :cantonese + | :catalan + | :cebuano + | :chinese + | :corsican + | :croatian + | :czech + | :danish + | :dutch + | :english + | :esperanto + | :estonian + | :farsi + | :fijian + | :finnish + | :french + | :galician + | :georgian + | :german + | :greek + | :guarani + | :gujarati + | :"haitian-creole" + | :hausa + | :hawaiian + | :hebrew + | :hindi + | :hmong + | :hungarian + | :icelandic + | :igbo + | :indonesian + | :irish + | :italian + | :japanese + | :javanese + | :kannada + | :kazakh + | :khmer + | :kinyarwanda + | :korean + | :kurdish + | :kyrgyz + | :lao + | :latin + | :latvian + | :lingala + | :lithuanian + | :luxembourgish + | :macedonian + | :malagasy + | :malay + | :malayalam + | :maltese + | :maori + | :marathi + | :mongolian + | :nepali + | :norwegian + | :odia + | :oromo + | :pashto + | :pidgin + | :polish + | :portuguese + | :punjabi + | :quechua + | :romanian + | :russian + | :samoan + | :"scottish-gaelic" + | :serbian + | :sesotho + | :shona + | :sindhi + | :sinhala + | :slovak + | :slovene + | :somali + | :spanish + | :sundanese + | :swahili + | :swedish + | :tagalog + | :tajik + | :tamil + | :tatar + | :telugu + | :thai + | :tibetan + | :tigrinya + | :tongan + | :tswana + | :turkish + | :turkmen + | :ukrainian + | :urdu + | :uyghur + | :uzbek + | :vietnamese + | :welsh + | :wolof + | :xhosa + | :yiddish + | :yoruba + | :zulu + + module PrimaryLanguage + extend BrandDev::Internal::Type::Enum + + AFRIKAANS: :afrikaans + ALBANIAN: :albanian + AMHARIC: :amharic + ARABIC: :arabic + ARMENIAN: :armenian + ASSAMESE: :assamese + AYMARA: :aymara + AZERI: :azeri + BASQUE: :basque + BELARUSIAN: :belarusian + BENGALI: :bengali + BOSNIAN: :bosnian + BULGARIAN: :bulgarian + BURMESE: :burmese + CANTONESE: :cantonese + CATALAN: :catalan + CEBUANO: :cebuano + CHINESE: :chinese + CORSICAN: :corsican + CROATIAN: :croatian + CZECH: :czech + DANISH: :danish + DUTCH: :dutch + ENGLISH: :english + ESPERANTO: :esperanto + ESTONIAN: :estonian + FARSI: :farsi + FIJIAN: :fijian + FINNISH: :finnish + FRENCH: :french + GALICIAN: :galician + GEORGIAN: :georgian + GERMAN: :german + GREEK: :greek + GUARANI: :guarani + GUJARATI: :gujarati + HAITIAN_CREOLE: :"haitian-creole" + HAUSA: :hausa + HAWAIIAN: :hawaiian + HEBREW: :hebrew + HINDI: :hindi + HMONG: :hmong + HUNGARIAN: :hungarian + ICELANDIC: :icelandic + IGBO: :igbo + INDONESIAN: :indonesian + IRISH: :irish + ITALIAN: :italian + JAPANESE: :japanese + JAVANESE: :javanese + KANNADA: :kannada + KAZAKH: :kazakh + KHMER: :khmer + KINYARWANDA: :kinyarwanda + KOREAN: :korean + KURDISH: :kurdish + KYRGYZ: :kyrgyz + LAO: :lao + LATIN: :latin + LATVIAN: :latvian + LINGALA: :lingala + LITHUANIAN: :lithuanian + LUXEMBOURGISH: :luxembourgish + MACEDONIAN: :macedonian + MALAGASY: :malagasy + MALAY: :malay + MALAYALAM: :malayalam + MALTESE: :maltese + MAORI: :maori + MARATHI: :marathi + MONGOLIAN: :mongolian + NEPALI: :nepali + NORWEGIAN: :norwegian + ODIA: :odia + OROMO: :oromo + PASHTO: :pashto + PIDGIN: :pidgin + POLISH: :polish + PORTUGUESE: :portuguese + PUNJABI: :punjabi + QUECHUA: :quechua + ROMANIAN: :romanian + RUSSIAN: :russian + SAMOAN: :samoan + SCOTTISH_GAELIC: :"scottish-gaelic" + SERBIAN: :serbian + SESOTHO: :sesotho + SHONA: :shona + SINDHI: :sindhi + SINHALA: :sinhala + SLOVAK: :slovak + SLOVENE: :slovene + SOMALI: :somali + SPANISH: :spanish + SUNDANESE: :sundanese + SWAHILI: :swahili + SWEDISH: :swedish + TAGALOG: :tagalog + TAJIK: :tajik + TAMIL: :tamil + TATAR: :tatar + TELUGU: :telugu + THAI: :thai + TIBETAN: :tibetan + TIGRINYA: :tigrinya + TONGAN: :tongan + TSWANA: :tswana + TURKISH: :turkish + TURKMEN: :turkmen + UKRAINIAN: :ukrainian + URDU: :urdu + UYGHUR: :uyghur + UZBEK: :uzbek + VIETNAMESE: :vietnamese + WELSH: :welsh + WOLOF: :wolof + XHOSA: :xhosa + YIDDISH: :yiddish + YORUBA: :yoruba + ZULU: :zulu + + def self?.values: -> ::Array[BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::primary_language] + end + type social = { type: String, url: String } class Social < BrandDev::Internal::Type::BaseModel diff --git a/sig/brand_dev/models/brand_retrieve_by_email_params.rbs b/sig/brand_dev/models/brand_retrieve_by_email_params.rbs index bfb843a..ad9f83f 100644 --- a/sig/brand_dev/models/brand_retrieve_by_email_params.rbs +++ b/sig/brand_dev/models/brand_retrieve_by_email_params.rbs @@ -46,120 +46,250 @@ module BrandDev } type force_language = - :albanian + :afrikaans + | :albanian + | :amharic | :arabic + | :armenian + | :assamese + | :aymara | :azeri + | :basque + | :belarusian | :bengali + | :bosnian | :bulgarian + | :burmese | :cantonese + | :catalan | :cebuano + | :chinese + | :corsican | :croatian | :czech | :danish | :dutch | :english + | :esperanto | :estonian | :farsi + | :fijian | :finnish | :french + | :galician + | :georgian | :german + | :greek + | :guarani + | :gujarati + | :"haitian-creole" | :hausa | :hawaiian + | :hebrew | :hindi + | :hmong | :hungarian | :icelandic + | :igbo | :indonesian + | :irish | :italian + | :japanese + | :javanese + | :kannada | :kazakh + | :khmer + | :kinyarwanda | :korean + | :kurdish | :kyrgyz + | :lao | :latin | :latvian + | :lingala | :lithuanian + | :luxembourgish | :macedonian + | :malagasy + | :malay + | :malayalam + | :maltese + | :maori + | :marathi | :mongolian | :nepali | :norwegian + | :odia + | :oromo | :pashto | :pidgin | :polish | :portuguese + | :punjabi + | :quechua | :romanian | :russian + | :samoan + | :"scottish-gaelic" | :serbian + | :sesotho + | :shona + | :sindhi + | :sinhala | :slovak | :slovene | :somali | :spanish + | :sundanese | :swahili | :swedish | :tagalog + | :tajik + | :tamil + | :tatar + | :telugu | :thai + | :tibetan + | :tigrinya + | :tongan + | :tswana | :turkish + | :turkmen | :ukrainian | :urdu + | :uyghur | :uzbek | :vietnamese | :welsh + | :wolof + | :xhosa + | :yiddish + | :yoruba + | :zulu module ForceLanguage extend BrandDev::Internal::Type::Enum + AFRIKAANS: :afrikaans ALBANIAN: :albanian + AMHARIC: :amharic ARABIC: :arabic + ARMENIAN: :armenian + ASSAMESE: :assamese + AYMARA: :aymara AZERI: :azeri + BASQUE: :basque + BELARUSIAN: :belarusian BENGALI: :bengali + BOSNIAN: :bosnian BULGARIAN: :bulgarian + BURMESE: :burmese CANTONESE: :cantonese + CATALAN: :catalan CEBUANO: :cebuano + CHINESE: :chinese + CORSICAN: :corsican CROATIAN: :croatian CZECH: :czech DANISH: :danish DUTCH: :dutch ENGLISH: :english + ESPERANTO: :esperanto ESTONIAN: :estonian FARSI: :farsi + FIJIAN: :fijian FINNISH: :finnish FRENCH: :french + GALICIAN: :galician + GEORGIAN: :georgian GERMAN: :german + GREEK: :greek + GUARANI: :guarani + GUJARATI: :gujarati + HAITIAN_CREOLE: :"haitian-creole" HAUSA: :hausa HAWAIIAN: :hawaiian + HEBREW: :hebrew HINDI: :hindi + HMONG: :hmong HUNGARIAN: :hungarian ICELANDIC: :icelandic + IGBO: :igbo INDONESIAN: :indonesian + IRISH: :irish ITALIAN: :italian + JAPANESE: :japanese + JAVANESE: :javanese + KANNADA: :kannada KAZAKH: :kazakh + KHMER: :khmer + KINYARWANDA: :kinyarwanda KOREAN: :korean + KURDISH: :kurdish KYRGYZ: :kyrgyz + LAO: :lao LATIN: :latin LATVIAN: :latvian + LINGALA: :lingala LITHUANIAN: :lithuanian + LUXEMBOURGISH: :luxembourgish MACEDONIAN: :macedonian + MALAGASY: :malagasy + MALAY: :malay + MALAYALAM: :malayalam + MALTESE: :maltese + MAORI: :maori + MARATHI: :marathi MONGOLIAN: :mongolian NEPALI: :nepali NORWEGIAN: :norwegian + ODIA: :odia + OROMO: :oromo PASHTO: :pashto PIDGIN: :pidgin POLISH: :polish PORTUGUESE: :portuguese + PUNJABI: :punjabi + QUECHUA: :quechua ROMANIAN: :romanian RUSSIAN: :russian + SAMOAN: :samoan + SCOTTISH_GAELIC: :"scottish-gaelic" SERBIAN: :serbian + SESOTHO: :sesotho + SHONA: :shona + SINDHI: :sindhi + SINHALA: :sinhala SLOVAK: :slovak SLOVENE: :slovene SOMALI: :somali SPANISH: :spanish + SUNDANESE: :sundanese SWAHILI: :swahili SWEDISH: :swedish TAGALOG: :tagalog + TAJIK: :tajik + TAMIL: :tamil + TATAR: :tatar + TELUGU: :telugu THAI: :thai + TIBETAN: :tibetan + TIGRINYA: :tigrinya + TONGAN: :tongan + TSWANA: :tswana TURKISH: :turkish + TURKMEN: :turkmen UKRAINIAN: :ukrainian URDU: :urdu + UYGHUR: :uyghur UZBEK: :uzbek VIETNAMESE: :vietnamese WELSH: :welsh + WOLOF: :wolof + XHOSA: :xhosa + YIDDISH: :yiddish + YORUBA: :yoruba + ZULU: :zulu def self?.values: -> ::Array[BrandDev::Models::BrandRetrieveByEmailParams::force_language] end diff --git a/sig/brand_dev/models/brand_retrieve_by_email_response.rbs b/sig/brand_dev/models/brand_retrieve_by_email_response.rbs index 790467e..e48d5e6 100644 --- a/sig/brand_dev/models/brand_retrieve_by_email_response.rbs +++ b/sig/brand_dev/models/brand_retrieve_by_email_response.rbs @@ -47,6 +47,7 @@ module BrandDev links: BrandDev::Models::BrandRetrieveByEmailResponse::Brand::Links, logos: ::Array[BrandDev::Models::BrandRetrieveByEmailResponse::Brand::Logo], phone: String, + primary_language: BrandDev::Models::BrandRetrieveByEmailResponse::Brand::primary_language?, slogan: String, socials: ::Array[BrandDev::Models::BrandRetrieveByEmailResponse::Brand::Social], stock: BrandDev::Models::BrandRetrieveByEmailResponse::Brand::Stock, @@ -110,6 +111,8 @@ module BrandDev def phone=: (String) -> String + attr_accessor primary_language: BrandDev::Models::BrandRetrieveByEmailResponse::Brand::primary_language? + attr_reader slogan: String? def slogan=: (String) -> String @@ -142,6 +145,7 @@ module BrandDev ?links: BrandDev::Models::BrandRetrieveByEmailResponse::Brand::Links, ?logos: ::Array[BrandDev::Models::BrandRetrieveByEmailResponse::Brand::Logo], ?phone: String, + ?primary_language: BrandDev::Models::BrandRetrieveByEmailResponse::Brand::primary_language?, ?slogan: String, ?socials: ::Array[BrandDev::Models::BrandRetrieveByEmailResponse::Brand::Social], ?stock: BrandDev::Models::BrandRetrieveByEmailResponse::Brand::Stock, @@ -160,6 +164,7 @@ module BrandDev links: BrandDev::Models::BrandRetrieveByEmailResponse::Brand::Links, logos: ::Array[BrandDev::Models::BrandRetrieveByEmailResponse::Brand::Logo], phone: String, + primary_language: BrandDev::Models::BrandRetrieveByEmailResponse::Brand::primary_language?, slogan: String, socials: ::Array[BrandDev::Models::BrandRetrieveByEmailResponse::Brand::Social], stock: BrandDev::Models::BrandRetrieveByEmailResponse::Brand::Stock, @@ -1039,6 +1044,255 @@ module BrandDev end end + type primary_language = + :afrikaans + | :albanian + | :amharic + | :arabic + | :armenian + | :assamese + | :aymara + | :azeri + | :basque + | :belarusian + | :bengali + | :bosnian + | :bulgarian + | :burmese + | :cantonese + | :catalan + | :cebuano + | :chinese + | :corsican + | :croatian + | :czech + | :danish + | :dutch + | :english + | :esperanto + | :estonian + | :farsi + | :fijian + | :finnish + | :french + | :galician + | :georgian + | :german + | :greek + | :guarani + | :gujarati + | :"haitian-creole" + | :hausa + | :hawaiian + | :hebrew + | :hindi + | :hmong + | :hungarian + | :icelandic + | :igbo + | :indonesian + | :irish + | :italian + | :japanese + | :javanese + | :kannada + | :kazakh + | :khmer + | :kinyarwanda + | :korean + | :kurdish + | :kyrgyz + | :lao + | :latin + | :latvian + | :lingala + | :lithuanian + | :luxembourgish + | :macedonian + | :malagasy + | :malay + | :malayalam + | :maltese + | :maori + | :marathi + | :mongolian + | :nepali + | :norwegian + | :odia + | :oromo + | :pashto + | :pidgin + | :polish + | :portuguese + | :punjabi + | :quechua + | :romanian + | :russian + | :samoan + | :"scottish-gaelic" + | :serbian + | :sesotho + | :shona + | :sindhi + | :sinhala + | :slovak + | :slovene + | :somali + | :spanish + | :sundanese + | :swahili + | :swedish + | :tagalog + | :tajik + | :tamil + | :tatar + | :telugu + | :thai + | :tibetan + | :tigrinya + | :tongan + | :tswana + | :turkish + | :turkmen + | :ukrainian + | :urdu + | :uyghur + | :uzbek + | :vietnamese + | :welsh + | :wolof + | :xhosa + | :yiddish + | :yoruba + | :zulu + + module PrimaryLanguage + extend BrandDev::Internal::Type::Enum + + AFRIKAANS: :afrikaans + ALBANIAN: :albanian + AMHARIC: :amharic + ARABIC: :arabic + ARMENIAN: :armenian + ASSAMESE: :assamese + AYMARA: :aymara + AZERI: :azeri + BASQUE: :basque + BELARUSIAN: :belarusian + BENGALI: :bengali + BOSNIAN: :bosnian + BULGARIAN: :bulgarian + BURMESE: :burmese + CANTONESE: :cantonese + CATALAN: :catalan + CEBUANO: :cebuano + CHINESE: :chinese + CORSICAN: :corsican + CROATIAN: :croatian + CZECH: :czech + DANISH: :danish + DUTCH: :dutch + ENGLISH: :english + ESPERANTO: :esperanto + ESTONIAN: :estonian + FARSI: :farsi + FIJIAN: :fijian + FINNISH: :finnish + FRENCH: :french + GALICIAN: :galician + GEORGIAN: :georgian + GERMAN: :german + GREEK: :greek + GUARANI: :guarani + GUJARATI: :gujarati + HAITIAN_CREOLE: :"haitian-creole" + HAUSA: :hausa + HAWAIIAN: :hawaiian + HEBREW: :hebrew + HINDI: :hindi + HMONG: :hmong + HUNGARIAN: :hungarian + ICELANDIC: :icelandic + IGBO: :igbo + INDONESIAN: :indonesian + IRISH: :irish + ITALIAN: :italian + JAPANESE: :japanese + JAVANESE: :javanese + KANNADA: :kannada + KAZAKH: :kazakh + KHMER: :khmer + KINYARWANDA: :kinyarwanda + KOREAN: :korean + KURDISH: :kurdish + KYRGYZ: :kyrgyz + LAO: :lao + LATIN: :latin + LATVIAN: :latvian + LINGALA: :lingala + LITHUANIAN: :lithuanian + LUXEMBOURGISH: :luxembourgish + MACEDONIAN: :macedonian + MALAGASY: :malagasy + MALAY: :malay + MALAYALAM: :malayalam + MALTESE: :maltese + MAORI: :maori + MARATHI: :marathi + MONGOLIAN: :mongolian + NEPALI: :nepali + NORWEGIAN: :norwegian + ODIA: :odia + OROMO: :oromo + PASHTO: :pashto + PIDGIN: :pidgin + POLISH: :polish + PORTUGUESE: :portuguese + PUNJABI: :punjabi + QUECHUA: :quechua + ROMANIAN: :romanian + RUSSIAN: :russian + SAMOAN: :samoan + SCOTTISH_GAELIC: :"scottish-gaelic" + SERBIAN: :serbian + SESOTHO: :sesotho + SHONA: :shona + SINDHI: :sindhi + SINHALA: :sinhala + SLOVAK: :slovak + SLOVENE: :slovene + SOMALI: :somali + SPANISH: :spanish + SUNDANESE: :sundanese + SWAHILI: :swahili + SWEDISH: :swedish + TAGALOG: :tagalog + TAJIK: :tajik + TAMIL: :tamil + TATAR: :tatar + TELUGU: :telugu + THAI: :thai + TIBETAN: :tibetan + TIGRINYA: :tigrinya + TONGAN: :tongan + TSWANA: :tswana + TURKISH: :turkish + TURKMEN: :turkmen + UKRAINIAN: :ukrainian + URDU: :urdu + UYGHUR: :uyghur + UZBEK: :uzbek + VIETNAMESE: :vietnamese + WELSH: :welsh + WOLOF: :wolof + XHOSA: :xhosa + YIDDISH: :yiddish + YORUBA: :yoruba + ZULU: :zulu + + def self?.values: -> ::Array[BrandDev::Models::BrandRetrieveByEmailResponse::Brand::primary_language] + end + type social = { type: String, url: String } class Social < BrandDev::Internal::Type::BaseModel diff --git a/sig/brand_dev/models/brand_retrieve_by_isin_params.rbs b/sig/brand_dev/models/brand_retrieve_by_isin_params.rbs index 420b71e..1cf77c0 100644 --- a/sig/brand_dev/models/brand_retrieve_by_isin_params.rbs +++ b/sig/brand_dev/models/brand_retrieve_by_isin_params.rbs @@ -46,120 +46,250 @@ module BrandDev } type force_language = - :albanian + :afrikaans + | :albanian + | :amharic | :arabic + | :armenian + | :assamese + | :aymara | :azeri + | :basque + | :belarusian | :bengali + | :bosnian | :bulgarian + | :burmese | :cantonese + | :catalan | :cebuano + | :chinese + | :corsican | :croatian | :czech | :danish | :dutch | :english + | :esperanto | :estonian | :farsi + | :fijian | :finnish | :french + | :galician + | :georgian | :german + | :greek + | :guarani + | :gujarati + | :"haitian-creole" | :hausa | :hawaiian + | :hebrew | :hindi + | :hmong | :hungarian | :icelandic + | :igbo | :indonesian + | :irish | :italian + | :japanese + | :javanese + | :kannada | :kazakh + | :khmer + | :kinyarwanda | :korean + | :kurdish | :kyrgyz + | :lao | :latin | :latvian + | :lingala | :lithuanian + | :luxembourgish | :macedonian + | :malagasy + | :malay + | :malayalam + | :maltese + | :maori + | :marathi | :mongolian | :nepali | :norwegian + | :odia + | :oromo | :pashto | :pidgin | :polish | :portuguese + | :punjabi + | :quechua | :romanian | :russian + | :samoan + | :"scottish-gaelic" | :serbian + | :sesotho + | :shona + | :sindhi + | :sinhala | :slovak | :slovene | :somali | :spanish + | :sundanese | :swahili | :swedish | :tagalog + | :tajik + | :tamil + | :tatar + | :telugu | :thai + | :tibetan + | :tigrinya + | :tongan + | :tswana | :turkish + | :turkmen | :ukrainian | :urdu + | :uyghur | :uzbek | :vietnamese | :welsh + | :wolof + | :xhosa + | :yiddish + | :yoruba + | :zulu module ForceLanguage extend BrandDev::Internal::Type::Enum + AFRIKAANS: :afrikaans ALBANIAN: :albanian + AMHARIC: :amharic ARABIC: :arabic + ARMENIAN: :armenian + ASSAMESE: :assamese + AYMARA: :aymara AZERI: :azeri + BASQUE: :basque + BELARUSIAN: :belarusian BENGALI: :bengali + BOSNIAN: :bosnian BULGARIAN: :bulgarian + BURMESE: :burmese CANTONESE: :cantonese + CATALAN: :catalan CEBUANO: :cebuano + CHINESE: :chinese + CORSICAN: :corsican CROATIAN: :croatian CZECH: :czech DANISH: :danish DUTCH: :dutch ENGLISH: :english + ESPERANTO: :esperanto ESTONIAN: :estonian FARSI: :farsi + FIJIAN: :fijian FINNISH: :finnish FRENCH: :french + GALICIAN: :galician + GEORGIAN: :georgian GERMAN: :german + GREEK: :greek + GUARANI: :guarani + GUJARATI: :gujarati + HAITIAN_CREOLE: :"haitian-creole" HAUSA: :hausa HAWAIIAN: :hawaiian + HEBREW: :hebrew HINDI: :hindi + HMONG: :hmong HUNGARIAN: :hungarian ICELANDIC: :icelandic + IGBO: :igbo INDONESIAN: :indonesian + IRISH: :irish ITALIAN: :italian + JAPANESE: :japanese + JAVANESE: :javanese + KANNADA: :kannada KAZAKH: :kazakh + KHMER: :khmer + KINYARWANDA: :kinyarwanda KOREAN: :korean + KURDISH: :kurdish KYRGYZ: :kyrgyz + LAO: :lao LATIN: :latin LATVIAN: :latvian + LINGALA: :lingala LITHUANIAN: :lithuanian + LUXEMBOURGISH: :luxembourgish MACEDONIAN: :macedonian + MALAGASY: :malagasy + MALAY: :malay + MALAYALAM: :malayalam + MALTESE: :maltese + MAORI: :maori + MARATHI: :marathi MONGOLIAN: :mongolian NEPALI: :nepali NORWEGIAN: :norwegian + ODIA: :odia + OROMO: :oromo PASHTO: :pashto PIDGIN: :pidgin POLISH: :polish PORTUGUESE: :portuguese + PUNJABI: :punjabi + QUECHUA: :quechua ROMANIAN: :romanian RUSSIAN: :russian + SAMOAN: :samoan + SCOTTISH_GAELIC: :"scottish-gaelic" SERBIAN: :serbian + SESOTHO: :sesotho + SHONA: :shona + SINDHI: :sindhi + SINHALA: :sinhala SLOVAK: :slovak SLOVENE: :slovene SOMALI: :somali SPANISH: :spanish + SUNDANESE: :sundanese SWAHILI: :swahili SWEDISH: :swedish TAGALOG: :tagalog + TAJIK: :tajik + TAMIL: :tamil + TATAR: :tatar + TELUGU: :telugu THAI: :thai + TIBETAN: :tibetan + TIGRINYA: :tigrinya + TONGAN: :tongan + TSWANA: :tswana TURKISH: :turkish + TURKMEN: :turkmen UKRAINIAN: :ukrainian URDU: :urdu + UYGHUR: :uyghur UZBEK: :uzbek VIETNAMESE: :vietnamese WELSH: :welsh + WOLOF: :wolof + XHOSA: :xhosa + YIDDISH: :yiddish + YORUBA: :yoruba + ZULU: :zulu def self?.values: -> ::Array[BrandDev::Models::BrandRetrieveByIsinParams::force_language] end diff --git a/sig/brand_dev/models/brand_retrieve_by_isin_response.rbs b/sig/brand_dev/models/brand_retrieve_by_isin_response.rbs index a6bca27..2798f88 100644 --- a/sig/brand_dev/models/brand_retrieve_by_isin_response.rbs +++ b/sig/brand_dev/models/brand_retrieve_by_isin_response.rbs @@ -47,6 +47,7 @@ module BrandDev links: BrandDev::Models::BrandRetrieveByIsinResponse::Brand::Links, logos: ::Array[BrandDev::Models::BrandRetrieveByIsinResponse::Brand::Logo], phone: String, + primary_language: BrandDev::Models::BrandRetrieveByIsinResponse::Brand::primary_language?, slogan: String, socials: ::Array[BrandDev::Models::BrandRetrieveByIsinResponse::Brand::Social], stock: BrandDev::Models::BrandRetrieveByIsinResponse::Brand::Stock, @@ -110,6 +111,8 @@ module BrandDev def phone=: (String) -> String + attr_accessor primary_language: BrandDev::Models::BrandRetrieveByIsinResponse::Brand::primary_language? + attr_reader slogan: String? def slogan=: (String) -> String @@ -142,6 +145,7 @@ module BrandDev ?links: BrandDev::Models::BrandRetrieveByIsinResponse::Brand::Links, ?logos: ::Array[BrandDev::Models::BrandRetrieveByIsinResponse::Brand::Logo], ?phone: String, + ?primary_language: BrandDev::Models::BrandRetrieveByIsinResponse::Brand::primary_language?, ?slogan: String, ?socials: ::Array[BrandDev::Models::BrandRetrieveByIsinResponse::Brand::Social], ?stock: BrandDev::Models::BrandRetrieveByIsinResponse::Brand::Stock, @@ -160,6 +164,7 @@ module BrandDev links: BrandDev::Models::BrandRetrieveByIsinResponse::Brand::Links, logos: ::Array[BrandDev::Models::BrandRetrieveByIsinResponse::Brand::Logo], phone: String, + primary_language: BrandDev::Models::BrandRetrieveByIsinResponse::Brand::primary_language?, slogan: String, socials: ::Array[BrandDev::Models::BrandRetrieveByIsinResponse::Brand::Social], stock: BrandDev::Models::BrandRetrieveByIsinResponse::Brand::Stock, @@ -1039,6 +1044,255 @@ module BrandDev end end + type primary_language = + :afrikaans + | :albanian + | :amharic + | :arabic + | :armenian + | :assamese + | :aymara + | :azeri + | :basque + | :belarusian + | :bengali + | :bosnian + | :bulgarian + | :burmese + | :cantonese + | :catalan + | :cebuano + | :chinese + | :corsican + | :croatian + | :czech + | :danish + | :dutch + | :english + | :esperanto + | :estonian + | :farsi + | :fijian + | :finnish + | :french + | :galician + | :georgian + | :german + | :greek + | :guarani + | :gujarati + | :"haitian-creole" + | :hausa + | :hawaiian + | :hebrew + | :hindi + | :hmong + | :hungarian + | :icelandic + | :igbo + | :indonesian + | :irish + | :italian + | :japanese + | :javanese + | :kannada + | :kazakh + | :khmer + | :kinyarwanda + | :korean + | :kurdish + | :kyrgyz + | :lao + | :latin + | :latvian + | :lingala + | :lithuanian + | :luxembourgish + | :macedonian + | :malagasy + | :malay + | :malayalam + | :maltese + | :maori + | :marathi + | :mongolian + | :nepali + | :norwegian + | :odia + | :oromo + | :pashto + | :pidgin + | :polish + | :portuguese + | :punjabi + | :quechua + | :romanian + | :russian + | :samoan + | :"scottish-gaelic" + | :serbian + | :sesotho + | :shona + | :sindhi + | :sinhala + | :slovak + | :slovene + | :somali + | :spanish + | :sundanese + | :swahili + | :swedish + | :tagalog + | :tajik + | :tamil + | :tatar + | :telugu + | :thai + | :tibetan + | :tigrinya + | :tongan + | :tswana + | :turkish + | :turkmen + | :ukrainian + | :urdu + | :uyghur + | :uzbek + | :vietnamese + | :welsh + | :wolof + | :xhosa + | :yiddish + | :yoruba + | :zulu + + module PrimaryLanguage + extend BrandDev::Internal::Type::Enum + + AFRIKAANS: :afrikaans + ALBANIAN: :albanian + AMHARIC: :amharic + ARABIC: :arabic + ARMENIAN: :armenian + ASSAMESE: :assamese + AYMARA: :aymara + AZERI: :azeri + BASQUE: :basque + BELARUSIAN: :belarusian + BENGALI: :bengali + BOSNIAN: :bosnian + BULGARIAN: :bulgarian + BURMESE: :burmese + CANTONESE: :cantonese + CATALAN: :catalan + CEBUANO: :cebuano + CHINESE: :chinese + CORSICAN: :corsican + CROATIAN: :croatian + CZECH: :czech + DANISH: :danish + DUTCH: :dutch + ENGLISH: :english + ESPERANTO: :esperanto + ESTONIAN: :estonian + FARSI: :farsi + FIJIAN: :fijian + FINNISH: :finnish + FRENCH: :french + GALICIAN: :galician + GEORGIAN: :georgian + GERMAN: :german + GREEK: :greek + GUARANI: :guarani + GUJARATI: :gujarati + HAITIAN_CREOLE: :"haitian-creole" + HAUSA: :hausa + HAWAIIAN: :hawaiian + HEBREW: :hebrew + HINDI: :hindi + HMONG: :hmong + HUNGARIAN: :hungarian + ICELANDIC: :icelandic + IGBO: :igbo + INDONESIAN: :indonesian + IRISH: :irish + ITALIAN: :italian + JAPANESE: :japanese + JAVANESE: :javanese + KANNADA: :kannada + KAZAKH: :kazakh + KHMER: :khmer + KINYARWANDA: :kinyarwanda + KOREAN: :korean + KURDISH: :kurdish + KYRGYZ: :kyrgyz + LAO: :lao + LATIN: :latin + LATVIAN: :latvian + LINGALA: :lingala + LITHUANIAN: :lithuanian + LUXEMBOURGISH: :luxembourgish + MACEDONIAN: :macedonian + MALAGASY: :malagasy + MALAY: :malay + MALAYALAM: :malayalam + MALTESE: :maltese + MAORI: :maori + MARATHI: :marathi + MONGOLIAN: :mongolian + NEPALI: :nepali + NORWEGIAN: :norwegian + ODIA: :odia + OROMO: :oromo + PASHTO: :pashto + PIDGIN: :pidgin + POLISH: :polish + PORTUGUESE: :portuguese + PUNJABI: :punjabi + QUECHUA: :quechua + ROMANIAN: :romanian + RUSSIAN: :russian + SAMOAN: :samoan + SCOTTISH_GAELIC: :"scottish-gaelic" + SERBIAN: :serbian + SESOTHO: :sesotho + SHONA: :shona + SINDHI: :sindhi + SINHALA: :sinhala + SLOVAK: :slovak + SLOVENE: :slovene + SOMALI: :somali + SPANISH: :spanish + SUNDANESE: :sundanese + SWAHILI: :swahili + SWEDISH: :swedish + TAGALOG: :tagalog + TAJIK: :tajik + TAMIL: :tamil + TATAR: :tatar + TELUGU: :telugu + THAI: :thai + TIBETAN: :tibetan + TIGRINYA: :tigrinya + TONGAN: :tongan + TSWANA: :tswana + TURKISH: :turkish + TURKMEN: :turkmen + UKRAINIAN: :ukrainian + URDU: :urdu + UYGHUR: :uyghur + UZBEK: :uzbek + VIETNAMESE: :vietnamese + WELSH: :welsh + WOLOF: :wolof + XHOSA: :xhosa + YIDDISH: :yiddish + YORUBA: :yoruba + ZULU: :zulu + + def self?.values: -> ::Array[BrandDev::Models::BrandRetrieveByIsinResponse::Brand::primary_language] + end + type social = { type: String, url: String } class Social < BrandDev::Internal::Type::BaseModel diff --git a/sig/brand_dev/models/brand_retrieve_by_name_params.rbs b/sig/brand_dev/models/brand_retrieve_by_name_params.rbs index 571f0ec..72d2c91 100644 --- a/sig/brand_dev/models/brand_retrieve_by_name_params.rbs +++ b/sig/brand_dev/models/brand_retrieve_by_name_params.rbs @@ -542,120 +542,250 @@ module BrandDev end type force_language = - :albanian + :afrikaans + | :albanian + | :amharic | :arabic + | :armenian + | :assamese + | :aymara | :azeri + | :basque + | :belarusian | :bengali + | :bosnian | :bulgarian + | :burmese | :cantonese + | :catalan | :cebuano + | :chinese + | :corsican | :croatian | :czech | :danish | :dutch | :english + | :esperanto | :estonian | :farsi + | :fijian | :finnish | :french + | :galician + | :georgian | :german + | :greek + | :guarani + | :gujarati + | :"haitian-creole" | :hausa | :hawaiian + | :hebrew | :hindi + | :hmong | :hungarian | :icelandic + | :igbo | :indonesian + | :irish | :italian + | :japanese + | :javanese + | :kannada | :kazakh + | :khmer + | :kinyarwanda | :korean + | :kurdish | :kyrgyz + | :lao | :latin | :latvian + | :lingala | :lithuanian + | :luxembourgish | :macedonian + | :malagasy + | :malay + | :malayalam + | :maltese + | :maori + | :marathi | :mongolian | :nepali | :norwegian + | :odia + | :oromo | :pashto | :pidgin | :polish | :portuguese + | :punjabi + | :quechua | :romanian | :russian + | :samoan + | :"scottish-gaelic" | :serbian + | :sesotho + | :shona + | :sindhi + | :sinhala | :slovak | :slovene | :somali | :spanish + | :sundanese | :swahili | :swedish | :tagalog + | :tajik + | :tamil + | :tatar + | :telugu | :thai + | :tibetan + | :tigrinya + | :tongan + | :tswana | :turkish + | :turkmen | :ukrainian | :urdu + | :uyghur | :uzbek | :vietnamese | :welsh + | :wolof + | :xhosa + | :yiddish + | :yoruba + | :zulu module ForceLanguage extend BrandDev::Internal::Type::Enum + AFRIKAANS: :afrikaans ALBANIAN: :albanian + AMHARIC: :amharic ARABIC: :arabic + ARMENIAN: :armenian + ASSAMESE: :assamese + AYMARA: :aymara AZERI: :azeri + BASQUE: :basque + BELARUSIAN: :belarusian BENGALI: :bengali + BOSNIAN: :bosnian BULGARIAN: :bulgarian + BURMESE: :burmese CANTONESE: :cantonese + CATALAN: :catalan CEBUANO: :cebuano + CHINESE: :chinese + CORSICAN: :corsican CROATIAN: :croatian CZECH: :czech DANISH: :danish DUTCH: :dutch ENGLISH: :english + ESPERANTO: :esperanto ESTONIAN: :estonian FARSI: :farsi + FIJIAN: :fijian FINNISH: :finnish FRENCH: :french + GALICIAN: :galician + GEORGIAN: :georgian GERMAN: :german + GREEK: :greek + GUARANI: :guarani + GUJARATI: :gujarati + HAITIAN_CREOLE: :"haitian-creole" HAUSA: :hausa HAWAIIAN: :hawaiian + HEBREW: :hebrew HINDI: :hindi + HMONG: :hmong HUNGARIAN: :hungarian ICELANDIC: :icelandic + IGBO: :igbo INDONESIAN: :indonesian + IRISH: :irish ITALIAN: :italian + JAPANESE: :japanese + JAVANESE: :javanese + KANNADA: :kannada KAZAKH: :kazakh + KHMER: :khmer + KINYARWANDA: :kinyarwanda KOREAN: :korean + KURDISH: :kurdish KYRGYZ: :kyrgyz + LAO: :lao LATIN: :latin LATVIAN: :latvian + LINGALA: :lingala LITHUANIAN: :lithuanian + LUXEMBOURGISH: :luxembourgish MACEDONIAN: :macedonian + MALAGASY: :malagasy + MALAY: :malay + MALAYALAM: :malayalam + MALTESE: :maltese + MAORI: :maori + MARATHI: :marathi MONGOLIAN: :mongolian NEPALI: :nepali NORWEGIAN: :norwegian + ODIA: :odia + OROMO: :oromo PASHTO: :pashto PIDGIN: :pidgin POLISH: :polish PORTUGUESE: :portuguese + PUNJABI: :punjabi + QUECHUA: :quechua ROMANIAN: :romanian RUSSIAN: :russian + SAMOAN: :samoan + SCOTTISH_GAELIC: :"scottish-gaelic" SERBIAN: :serbian + SESOTHO: :sesotho + SHONA: :shona + SINDHI: :sindhi + SINHALA: :sinhala SLOVAK: :slovak SLOVENE: :slovene SOMALI: :somali SPANISH: :spanish + SUNDANESE: :sundanese SWAHILI: :swahili SWEDISH: :swedish TAGALOG: :tagalog + TAJIK: :tajik + TAMIL: :tamil + TATAR: :tatar + TELUGU: :telugu THAI: :thai + TIBETAN: :tibetan + TIGRINYA: :tigrinya + TONGAN: :tongan + TSWANA: :tswana TURKISH: :turkish + TURKMEN: :turkmen UKRAINIAN: :ukrainian URDU: :urdu + UYGHUR: :uyghur UZBEK: :uzbek VIETNAMESE: :vietnamese WELSH: :welsh + WOLOF: :wolof + XHOSA: :xhosa + YIDDISH: :yiddish + YORUBA: :yoruba + ZULU: :zulu def self?.values: -> ::Array[BrandDev::Models::BrandRetrieveByNameParams::force_language] end diff --git a/sig/brand_dev/models/brand_retrieve_by_name_response.rbs b/sig/brand_dev/models/brand_retrieve_by_name_response.rbs index 639d119..ca2b0e5 100644 --- a/sig/brand_dev/models/brand_retrieve_by_name_response.rbs +++ b/sig/brand_dev/models/brand_retrieve_by_name_response.rbs @@ -47,6 +47,7 @@ module BrandDev links: BrandDev::Models::BrandRetrieveByNameResponse::Brand::Links, logos: ::Array[BrandDev::Models::BrandRetrieveByNameResponse::Brand::Logo], phone: String, + primary_language: BrandDev::Models::BrandRetrieveByNameResponse::Brand::primary_language?, slogan: String, socials: ::Array[BrandDev::Models::BrandRetrieveByNameResponse::Brand::Social], stock: BrandDev::Models::BrandRetrieveByNameResponse::Brand::Stock, @@ -110,6 +111,8 @@ module BrandDev def phone=: (String) -> String + attr_accessor primary_language: BrandDev::Models::BrandRetrieveByNameResponse::Brand::primary_language? + attr_reader slogan: String? def slogan=: (String) -> String @@ -142,6 +145,7 @@ module BrandDev ?links: BrandDev::Models::BrandRetrieveByNameResponse::Brand::Links, ?logos: ::Array[BrandDev::Models::BrandRetrieveByNameResponse::Brand::Logo], ?phone: String, + ?primary_language: BrandDev::Models::BrandRetrieveByNameResponse::Brand::primary_language?, ?slogan: String, ?socials: ::Array[BrandDev::Models::BrandRetrieveByNameResponse::Brand::Social], ?stock: BrandDev::Models::BrandRetrieveByNameResponse::Brand::Stock, @@ -160,6 +164,7 @@ module BrandDev links: BrandDev::Models::BrandRetrieveByNameResponse::Brand::Links, logos: ::Array[BrandDev::Models::BrandRetrieveByNameResponse::Brand::Logo], phone: String, + primary_language: BrandDev::Models::BrandRetrieveByNameResponse::Brand::primary_language?, slogan: String, socials: ::Array[BrandDev::Models::BrandRetrieveByNameResponse::Brand::Social], stock: BrandDev::Models::BrandRetrieveByNameResponse::Brand::Stock, @@ -1039,6 +1044,255 @@ module BrandDev end end + type primary_language = + :afrikaans + | :albanian + | :amharic + | :arabic + | :armenian + | :assamese + | :aymara + | :azeri + | :basque + | :belarusian + | :bengali + | :bosnian + | :bulgarian + | :burmese + | :cantonese + | :catalan + | :cebuano + | :chinese + | :corsican + | :croatian + | :czech + | :danish + | :dutch + | :english + | :esperanto + | :estonian + | :farsi + | :fijian + | :finnish + | :french + | :galician + | :georgian + | :german + | :greek + | :guarani + | :gujarati + | :"haitian-creole" + | :hausa + | :hawaiian + | :hebrew + | :hindi + | :hmong + | :hungarian + | :icelandic + | :igbo + | :indonesian + | :irish + | :italian + | :japanese + | :javanese + | :kannada + | :kazakh + | :khmer + | :kinyarwanda + | :korean + | :kurdish + | :kyrgyz + | :lao + | :latin + | :latvian + | :lingala + | :lithuanian + | :luxembourgish + | :macedonian + | :malagasy + | :malay + | :malayalam + | :maltese + | :maori + | :marathi + | :mongolian + | :nepali + | :norwegian + | :odia + | :oromo + | :pashto + | :pidgin + | :polish + | :portuguese + | :punjabi + | :quechua + | :romanian + | :russian + | :samoan + | :"scottish-gaelic" + | :serbian + | :sesotho + | :shona + | :sindhi + | :sinhala + | :slovak + | :slovene + | :somali + | :spanish + | :sundanese + | :swahili + | :swedish + | :tagalog + | :tajik + | :tamil + | :tatar + | :telugu + | :thai + | :tibetan + | :tigrinya + | :tongan + | :tswana + | :turkish + | :turkmen + | :ukrainian + | :urdu + | :uyghur + | :uzbek + | :vietnamese + | :welsh + | :wolof + | :xhosa + | :yiddish + | :yoruba + | :zulu + + module PrimaryLanguage + extend BrandDev::Internal::Type::Enum + + AFRIKAANS: :afrikaans + ALBANIAN: :albanian + AMHARIC: :amharic + ARABIC: :arabic + ARMENIAN: :armenian + ASSAMESE: :assamese + AYMARA: :aymara + AZERI: :azeri + BASQUE: :basque + BELARUSIAN: :belarusian + BENGALI: :bengali + BOSNIAN: :bosnian + BULGARIAN: :bulgarian + BURMESE: :burmese + CANTONESE: :cantonese + CATALAN: :catalan + CEBUANO: :cebuano + CHINESE: :chinese + CORSICAN: :corsican + CROATIAN: :croatian + CZECH: :czech + DANISH: :danish + DUTCH: :dutch + ENGLISH: :english + ESPERANTO: :esperanto + ESTONIAN: :estonian + FARSI: :farsi + FIJIAN: :fijian + FINNISH: :finnish + FRENCH: :french + GALICIAN: :galician + GEORGIAN: :georgian + GERMAN: :german + GREEK: :greek + GUARANI: :guarani + GUJARATI: :gujarati + HAITIAN_CREOLE: :"haitian-creole" + HAUSA: :hausa + HAWAIIAN: :hawaiian + HEBREW: :hebrew + HINDI: :hindi + HMONG: :hmong + HUNGARIAN: :hungarian + ICELANDIC: :icelandic + IGBO: :igbo + INDONESIAN: :indonesian + IRISH: :irish + ITALIAN: :italian + JAPANESE: :japanese + JAVANESE: :javanese + KANNADA: :kannada + KAZAKH: :kazakh + KHMER: :khmer + KINYARWANDA: :kinyarwanda + KOREAN: :korean + KURDISH: :kurdish + KYRGYZ: :kyrgyz + LAO: :lao + LATIN: :latin + LATVIAN: :latvian + LINGALA: :lingala + LITHUANIAN: :lithuanian + LUXEMBOURGISH: :luxembourgish + MACEDONIAN: :macedonian + MALAGASY: :malagasy + MALAY: :malay + MALAYALAM: :malayalam + MALTESE: :maltese + MAORI: :maori + MARATHI: :marathi + MONGOLIAN: :mongolian + NEPALI: :nepali + NORWEGIAN: :norwegian + ODIA: :odia + OROMO: :oromo + PASHTO: :pashto + PIDGIN: :pidgin + POLISH: :polish + PORTUGUESE: :portuguese + PUNJABI: :punjabi + QUECHUA: :quechua + ROMANIAN: :romanian + RUSSIAN: :russian + SAMOAN: :samoan + SCOTTISH_GAELIC: :"scottish-gaelic" + SERBIAN: :serbian + SESOTHO: :sesotho + SHONA: :shona + SINDHI: :sindhi + SINHALA: :sinhala + SLOVAK: :slovak + SLOVENE: :slovene + SOMALI: :somali + SPANISH: :spanish + SUNDANESE: :sundanese + SWAHILI: :swahili + SWEDISH: :swedish + TAGALOG: :tagalog + TAJIK: :tajik + TAMIL: :tamil + TATAR: :tatar + TELUGU: :telugu + THAI: :thai + TIBETAN: :tibetan + TIGRINYA: :tigrinya + TONGAN: :tongan + TSWANA: :tswana + TURKISH: :turkish + TURKMEN: :turkmen + UKRAINIAN: :ukrainian + URDU: :urdu + UYGHUR: :uyghur + UZBEK: :uzbek + VIETNAMESE: :vietnamese + WELSH: :welsh + WOLOF: :wolof + XHOSA: :xhosa + YIDDISH: :yiddish + YORUBA: :yoruba + ZULU: :zulu + + def self?.values: -> ::Array[BrandDev::Models::BrandRetrieveByNameResponse::Brand::primary_language] + end + type social = { type: String, url: String } class Social < BrandDev::Internal::Type::BaseModel diff --git a/sig/brand_dev/models/brand_retrieve_by_ticker_params.rbs b/sig/brand_dev/models/brand_retrieve_by_ticker_params.rbs index d1e430d..ec896ee 100644 --- a/sig/brand_dev/models/brand_retrieve_by_ticker_params.rbs +++ b/sig/brand_dev/models/brand_retrieve_by_ticker_params.rbs @@ -55,120 +55,250 @@ module BrandDev } type force_language = - :albanian + :afrikaans + | :albanian + | :amharic | :arabic + | :armenian + | :assamese + | :aymara | :azeri + | :basque + | :belarusian | :bengali + | :bosnian | :bulgarian + | :burmese | :cantonese + | :catalan | :cebuano + | :chinese + | :corsican | :croatian | :czech | :danish | :dutch | :english + | :esperanto | :estonian | :farsi + | :fijian | :finnish | :french + | :galician + | :georgian | :german + | :greek + | :guarani + | :gujarati + | :"haitian-creole" | :hausa | :hawaiian + | :hebrew | :hindi + | :hmong | :hungarian | :icelandic + | :igbo | :indonesian + | :irish | :italian + | :japanese + | :javanese + | :kannada | :kazakh + | :khmer + | :kinyarwanda | :korean + | :kurdish | :kyrgyz + | :lao | :latin | :latvian + | :lingala | :lithuanian + | :luxembourgish | :macedonian + | :malagasy + | :malay + | :malayalam + | :maltese + | :maori + | :marathi | :mongolian | :nepali | :norwegian + | :odia + | :oromo | :pashto | :pidgin | :polish | :portuguese + | :punjabi + | :quechua | :romanian | :russian + | :samoan + | :"scottish-gaelic" | :serbian + | :sesotho + | :shona + | :sindhi + | :sinhala | :slovak | :slovene | :somali | :spanish + | :sundanese | :swahili | :swedish | :tagalog + | :tajik + | :tamil + | :tatar + | :telugu | :thai + | :tibetan + | :tigrinya + | :tongan + | :tswana | :turkish + | :turkmen | :ukrainian | :urdu + | :uyghur | :uzbek | :vietnamese | :welsh + | :wolof + | :xhosa + | :yiddish + | :yoruba + | :zulu module ForceLanguage extend BrandDev::Internal::Type::Enum + AFRIKAANS: :afrikaans ALBANIAN: :albanian + AMHARIC: :amharic ARABIC: :arabic + ARMENIAN: :armenian + ASSAMESE: :assamese + AYMARA: :aymara AZERI: :azeri + BASQUE: :basque + BELARUSIAN: :belarusian BENGALI: :bengali + BOSNIAN: :bosnian BULGARIAN: :bulgarian + BURMESE: :burmese CANTONESE: :cantonese + CATALAN: :catalan CEBUANO: :cebuano + CHINESE: :chinese + CORSICAN: :corsican CROATIAN: :croatian CZECH: :czech DANISH: :danish DUTCH: :dutch ENGLISH: :english + ESPERANTO: :esperanto ESTONIAN: :estonian FARSI: :farsi + FIJIAN: :fijian FINNISH: :finnish FRENCH: :french + GALICIAN: :galician + GEORGIAN: :georgian GERMAN: :german + GREEK: :greek + GUARANI: :guarani + GUJARATI: :gujarati + HAITIAN_CREOLE: :"haitian-creole" HAUSA: :hausa HAWAIIAN: :hawaiian + HEBREW: :hebrew HINDI: :hindi + HMONG: :hmong HUNGARIAN: :hungarian ICELANDIC: :icelandic + IGBO: :igbo INDONESIAN: :indonesian + IRISH: :irish ITALIAN: :italian + JAPANESE: :japanese + JAVANESE: :javanese + KANNADA: :kannada KAZAKH: :kazakh + KHMER: :khmer + KINYARWANDA: :kinyarwanda KOREAN: :korean + KURDISH: :kurdish KYRGYZ: :kyrgyz + LAO: :lao LATIN: :latin LATVIAN: :latvian + LINGALA: :lingala LITHUANIAN: :lithuanian + LUXEMBOURGISH: :luxembourgish MACEDONIAN: :macedonian + MALAGASY: :malagasy + MALAY: :malay + MALAYALAM: :malayalam + MALTESE: :maltese + MAORI: :maori + MARATHI: :marathi MONGOLIAN: :mongolian NEPALI: :nepali NORWEGIAN: :norwegian + ODIA: :odia + OROMO: :oromo PASHTO: :pashto PIDGIN: :pidgin POLISH: :polish PORTUGUESE: :portuguese + PUNJABI: :punjabi + QUECHUA: :quechua ROMANIAN: :romanian RUSSIAN: :russian + SAMOAN: :samoan + SCOTTISH_GAELIC: :"scottish-gaelic" SERBIAN: :serbian + SESOTHO: :sesotho + SHONA: :shona + SINDHI: :sindhi + SINHALA: :sinhala SLOVAK: :slovak SLOVENE: :slovene SOMALI: :somali SPANISH: :spanish + SUNDANESE: :sundanese SWAHILI: :swahili SWEDISH: :swedish TAGALOG: :tagalog + TAJIK: :tajik + TAMIL: :tamil + TATAR: :tatar + TELUGU: :telugu THAI: :thai + TIBETAN: :tibetan + TIGRINYA: :tigrinya + TONGAN: :tongan + TSWANA: :tswana TURKISH: :turkish + TURKMEN: :turkmen UKRAINIAN: :ukrainian URDU: :urdu + UYGHUR: :uyghur UZBEK: :uzbek VIETNAMESE: :vietnamese WELSH: :welsh + WOLOF: :wolof + XHOSA: :xhosa + YIDDISH: :yiddish + YORUBA: :yoruba + ZULU: :zulu def self?.values: -> ::Array[BrandDev::Models::BrandRetrieveByTickerParams::force_language] end diff --git a/sig/brand_dev/models/brand_retrieve_by_ticker_response.rbs b/sig/brand_dev/models/brand_retrieve_by_ticker_response.rbs index 52b0000..1a30f5c 100644 --- a/sig/brand_dev/models/brand_retrieve_by_ticker_response.rbs +++ b/sig/brand_dev/models/brand_retrieve_by_ticker_response.rbs @@ -47,6 +47,7 @@ module BrandDev links: BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Links, logos: ::Array[BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo], phone: String, + primary_language: BrandDev::Models::BrandRetrieveByTickerResponse::Brand::primary_language?, slogan: String, socials: ::Array[BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Social], stock: BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Stock, @@ -110,6 +111,8 @@ module BrandDev def phone=: (String) -> String + attr_accessor primary_language: BrandDev::Models::BrandRetrieveByTickerResponse::Brand::primary_language? + attr_reader slogan: String? def slogan=: (String) -> String @@ -142,6 +145,7 @@ module BrandDev ?links: BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Links, ?logos: ::Array[BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo], ?phone: String, + ?primary_language: BrandDev::Models::BrandRetrieveByTickerResponse::Brand::primary_language?, ?slogan: String, ?socials: ::Array[BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Social], ?stock: BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Stock, @@ -160,6 +164,7 @@ module BrandDev links: BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Links, logos: ::Array[BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo], phone: String, + primary_language: BrandDev::Models::BrandRetrieveByTickerResponse::Brand::primary_language?, slogan: String, socials: ::Array[BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Social], stock: BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Stock, @@ -1039,6 +1044,255 @@ module BrandDev end end + type primary_language = + :afrikaans + | :albanian + | :amharic + | :arabic + | :armenian + | :assamese + | :aymara + | :azeri + | :basque + | :belarusian + | :bengali + | :bosnian + | :bulgarian + | :burmese + | :cantonese + | :catalan + | :cebuano + | :chinese + | :corsican + | :croatian + | :czech + | :danish + | :dutch + | :english + | :esperanto + | :estonian + | :farsi + | :fijian + | :finnish + | :french + | :galician + | :georgian + | :german + | :greek + | :guarani + | :gujarati + | :"haitian-creole" + | :hausa + | :hawaiian + | :hebrew + | :hindi + | :hmong + | :hungarian + | :icelandic + | :igbo + | :indonesian + | :irish + | :italian + | :japanese + | :javanese + | :kannada + | :kazakh + | :khmer + | :kinyarwanda + | :korean + | :kurdish + | :kyrgyz + | :lao + | :latin + | :latvian + | :lingala + | :lithuanian + | :luxembourgish + | :macedonian + | :malagasy + | :malay + | :malayalam + | :maltese + | :maori + | :marathi + | :mongolian + | :nepali + | :norwegian + | :odia + | :oromo + | :pashto + | :pidgin + | :polish + | :portuguese + | :punjabi + | :quechua + | :romanian + | :russian + | :samoan + | :"scottish-gaelic" + | :serbian + | :sesotho + | :shona + | :sindhi + | :sinhala + | :slovak + | :slovene + | :somali + | :spanish + | :sundanese + | :swahili + | :swedish + | :tagalog + | :tajik + | :tamil + | :tatar + | :telugu + | :thai + | :tibetan + | :tigrinya + | :tongan + | :tswana + | :turkish + | :turkmen + | :ukrainian + | :urdu + | :uyghur + | :uzbek + | :vietnamese + | :welsh + | :wolof + | :xhosa + | :yiddish + | :yoruba + | :zulu + + module PrimaryLanguage + extend BrandDev::Internal::Type::Enum + + AFRIKAANS: :afrikaans + ALBANIAN: :albanian + AMHARIC: :amharic + ARABIC: :arabic + ARMENIAN: :armenian + ASSAMESE: :assamese + AYMARA: :aymara + AZERI: :azeri + BASQUE: :basque + BELARUSIAN: :belarusian + BENGALI: :bengali + BOSNIAN: :bosnian + BULGARIAN: :bulgarian + BURMESE: :burmese + CANTONESE: :cantonese + CATALAN: :catalan + CEBUANO: :cebuano + CHINESE: :chinese + CORSICAN: :corsican + CROATIAN: :croatian + CZECH: :czech + DANISH: :danish + DUTCH: :dutch + ENGLISH: :english + ESPERANTO: :esperanto + ESTONIAN: :estonian + FARSI: :farsi + FIJIAN: :fijian + FINNISH: :finnish + FRENCH: :french + GALICIAN: :galician + GEORGIAN: :georgian + GERMAN: :german + GREEK: :greek + GUARANI: :guarani + GUJARATI: :gujarati + HAITIAN_CREOLE: :"haitian-creole" + HAUSA: :hausa + HAWAIIAN: :hawaiian + HEBREW: :hebrew + HINDI: :hindi + HMONG: :hmong + HUNGARIAN: :hungarian + ICELANDIC: :icelandic + IGBO: :igbo + INDONESIAN: :indonesian + IRISH: :irish + ITALIAN: :italian + JAPANESE: :japanese + JAVANESE: :javanese + KANNADA: :kannada + KAZAKH: :kazakh + KHMER: :khmer + KINYARWANDA: :kinyarwanda + KOREAN: :korean + KURDISH: :kurdish + KYRGYZ: :kyrgyz + LAO: :lao + LATIN: :latin + LATVIAN: :latvian + LINGALA: :lingala + LITHUANIAN: :lithuanian + LUXEMBOURGISH: :luxembourgish + MACEDONIAN: :macedonian + MALAGASY: :malagasy + MALAY: :malay + MALAYALAM: :malayalam + MALTESE: :maltese + MAORI: :maori + MARATHI: :marathi + MONGOLIAN: :mongolian + NEPALI: :nepali + NORWEGIAN: :norwegian + ODIA: :odia + OROMO: :oromo + PASHTO: :pashto + PIDGIN: :pidgin + POLISH: :polish + PORTUGUESE: :portuguese + PUNJABI: :punjabi + QUECHUA: :quechua + ROMANIAN: :romanian + RUSSIAN: :russian + SAMOAN: :samoan + SCOTTISH_GAELIC: :"scottish-gaelic" + SERBIAN: :serbian + SESOTHO: :sesotho + SHONA: :shona + SINDHI: :sindhi + SINHALA: :sinhala + SLOVAK: :slovak + SLOVENE: :slovene + SOMALI: :somali + SPANISH: :spanish + SUNDANESE: :sundanese + SWAHILI: :swahili + SWEDISH: :swedish + TAGALOG: :tagalog + TAJIK: :tajik + TAMIL: :tamil + TATAR: :tatar + TELUGU: :telugu + THAI: :thai + TIBETAN: :tibetan + TIGRINYA: :tigrinya + TONGAN: :tongan + TSWANA: :tswana + TURKISH: :turkish + TURKMEN: :turkmen + UKRAINIAN: :ukrainian + URDU: :urdu + UYGHUR: :uyghur + UZBEK: :uzbek + VIETNAMESE: :vietnamese + WELSH: :welsh + WOLOF: :wolof + XHOSA: :xhosa + YIDDISH: :yiddish + YORUBA: :yoruba + ZULU: :zulu + + def self?.values: -> ::Array[BrandDev::Models::BrandRetrieveByTickerResponse::Brand::primary_language] + end + type social = { type: String, url: String } class Social < BrandDev::Internal::Type::BaseModel diff --git a/sig/brand_dev/models/brand_retrieve_params.rbs b/sig/brand_dev/models/brand_retrieve_params.rbs index 337f549..83c2d02 100644 --- a/sig/brand_dev/models/brand_retrieve_params.rbs +++ b/sig/brand_dev/models/brand_retrieve_params.rbs @@ -46,120 +46,250 @@ module BrandDev } type force_language = - :albanian + :afrikaans + | :albanian + | :amharic | :arabic + | :armenian + | :assamese + | :aymara | :azeri + | :basque + | :belarusian | :bengali + | :bosnian | :bulgarian + | :burmese | :cantonese + | :catalan | :cebuano + | :chinese + | :corsican | :croatian | :czech | :danish | :dutch | :english + | :esperanto | :estonian | :farsi + | :fijian | :finnish | :french + | :galician + | :georgian | :german + | :greek + | :guarani + | :gujarati + | :"haitian-creole" | :hausa | :hawaiian + | :hebrew | :hindi + | :hmong | :hungarian | :icelandic + | :igbo | :indonesian + | :irish | :italian + | :japanese + | :javanese + | :kannada | :kazakh + | :khmer + | :kinyarwanda | :korean + | :kurdish | :kyrgyz + | :lao | :latin | :latvian + | :lingala | :lithuanian + | :luxembourgish | :macedonian + | :malagasy + | :malay + | :malayalam + | :maltese + | :maori + | :marathi | :mongolian | :nepali | :norwegian + | :odia + | :oromo | :pashto | :pidgin | :polish | :portuguese + | :punjabi + | :quechua | :romanian | :russian + | :samoan + | :"scottish-gaelic" | :serbian + | :sesotho + | :shona + | :sindhi + | :sinhala | :slovak | :slovene | :somali | :spanish + | :sundanese | :swahili | :swedish | :tagalog + | :tajik + | :tamil + | :tatar + | :telugu | :thai + | :tibetan + | :tigrinya + | :tongan + | :tswana | :turkish + | :turkmen | :ukrainian | :urdu + | :uyghur | :uzbek | :vietnamese | :welsh + | :wolof + | :xhosa + | :yiddish + | :yoruba + | :zulu module ForceLanguage extend BrandDev::Internal::Type::Enum + AFRIKAANS: :afrikaans ALBANIAN: :albanian + AMHARIC: :amharic ARABIC: :arabic + ARMENIAN: :armenian + ASSAMESE: :assamese + AYMARA: :aymara AZERI: :azeri + BASQUE: :basque + BELARUSIAN: :belarusian BENGALI: :bengali + BOSNIAN: :bosnian BULGARIAN: :bulgarian + BURMESE: :burmese CANTONESE: :cantonese + CATALAN: :catalan CEBUANO: :cebuano + CHINESE: :chinese + CORSICAN: :corsican CROATIAN: :croatian CZECH: :czech DANISH: :danish DUTCH: :dutch ENGLISH: :english + ESPERANTO: :esperanto ESTONIAN: :estonian FARSI: :farsi + FIJIAN: :fijian FINNISH: :finnish FRENCH: :french + GALICIAN: :galician + GEORGIAN: :georgian GERMAN: :german + GREEK: :greek + GUARANI: :guarani + GUJARATI: :gujarati + HAITIAN_CREOLE: :"haitian-creole" HAUSA: :hausa HAWAIIAN: :hawaiian + HEBREW: :hebrew HINDI: :hindi + HMONG: :hmong HUNGARIAN: :hungarian ICELANDIC: :icelandic + IGBO: :igbo INDONESIAN: :indonesian + IRISH: :irish ITALIAN: :italian + JAPANESE: :japanese + JAVANESE: :javanese + KANNADA: :kannada KAZAKH: :kazakh + KHMER: :khmer + KINYARWANDA: :kinyarwanda KOREAN: :korean + KURDISH: :kurdish KYRGYZ: :kyrgyz + LAO: :lao LATIN: :latin LATVIAN: :latvian + LINGALA: :lingala LITHUANIAN: :lithuanian + LUXEMBOURGISH: :luxembourgish MACEDONIAN: :macedonian + MALAGASY: :malagasy + MALAY: :malay + MALAYALAM: :malayalam + MALTESE: :maltese + MAORI: :maori + MARATHI: :marathi MONGOLIAN: :mongolian NEPALI: :nepali NORWEGIAN: :norwegian + ODIA: :odia + OROMO: :oromo PASHTO: :pashto PIDGIN: :pidgin POLISH: :polish PORTUGUESE: :portuguese + PUNJABI: :punjabi + QUECHUA: :quechua ROMANIAN: :romanian RUSSIAN: :russian + SAMOAN: :samoan + SCOTTISH_GAELIC: :"scottish-gaelic" SERBIAN: :serbian + SESOTHO: :sesotho + SHONA: :shona + SINDHI: :sindhi + SINHALA: :sinhala SLOVAK: :slovak SLOVENE: :slovene SOMALI: :somali SPANISH: :spanish + SUNDANESE: :sundanese SWAHILI: :swahili SWEDISH: :swedish TAGALOG: :tagalog + TAJIK: :tajik + TAMIL: :tamil + TATAR: :tatar + TELUGU: :telugu THAI: :thai + TIBETAN: :tibetan + TIGRINYA: :tigrinya + TONGAN: :tongan + TSWANA: :tswana TURKISH: :turkish + TURKMEN: :turkmen UKRAINIAN: :ukrainian URDU: :urdu + UYGHUR: :uyghur UZBEK: :uzbek VIETNAMESE: :vietnamese WELSH: :welsh + WOLOF: :wolof + XHOSA: :xhosa + YIDDISH: :yiddish + YORUBA: :yoruba + ZULU: :zulu def self?.values: -> ::Array[BrandDev::Models::BrandRetrieveParams::force_language] end diff --git a/sig/brand_dev/models/brand_retrieve_response.rbs b/sig/brand_dev/models/brand_retrieve_response.rbs index 197f884..e4bf754 100644 --- a/sig/brand_dev/models/brand_retrieve_response.rbs +++ b/sig/brand_dev/models/brand_retrieve_response.rbs @@ -47,6 +47,7 @@ module BrandDev links: BrandDev::Models::BrandRetrieveResponse::Brand::Links, logos: ::Array[BrandDev::Models::BrandRetrieveResponse::Brand::Logo], phone: String, + primary_language: BrandDev::Models::BrandRetrieveResponse::Brand::primary_language?, slogan: String, socials: ::Array[BrandDev::Models::BrandRetrieveResponse::Brand::Social], stock: BrandDev::Models::BrandRetrieveResponse::Brand::Stock, @@ -110,6 +111,8 @@ module BrandDev def phone=: (String) -> String + attr_accessor primary_language: BrandDev::Models::BrandRetrieveResponse::Brand::primary_language? + attr_reader slogan: String? def slogan=: (String) -> String @@ -142,6 +145,7 @@ module BrandDev ?links: BrandDev::Models::BrandRetrieveResponse::Brand::Links, ?logos: ::Array[BrandDev::Models::BrandRetrieveResponse::Brand::Logo], ?phone: String, + ?primary_language: BrandDev::Models::BrandRetrieveResponse::Brand::primary_language?, ?slogan: String, ?socials: ::Array[BrandDev::Models::BrandRetrieveResponse::Brand::Social], ?stock: BrandDev::Models::BrandRetrieveResponse::Brand::Stock, @@ -160,6 +164,7 @@ module BrandDev links: BrandDev::Models::BrandRetrieveResponse::Brand::Links, logos: ::Array[BrandDev::Models::BrandRetrieveResponse::Brand::Logo], phone: String, + primary_language: BrandDev::Models::BrandRetrieveResponse::Brand::primary_language?, slogan: String, socials: ::Array[BrandDev::Models::BrandRetrieveResponse::Brand::Social], stock: BrandDev::Models::BrandRetrieveResponse::Brand::Stock, @@ -1039,6 +1044,255 @@ module BrandDev end end + type primary_language = + :afrikaans + | :albanian + | :amharic + | :arabic + | :armenian + | :assamese + | :aymara + | :azeri + | :basque + | :belarusian + | :bengali + | :bosnian + | :bulgarian + | :burmese + | :cantonese + | :catalan + | :cebuano + | :chinese + | :corsican + | :croatian + | :czech + | :danish + | :dutch + | :english + | :esperanto + | :estonian + | :farsi + | :fijian + | :finnish + | :french + | :galician + | :georgian + | :german + | :greek + | :guarani + | :gujarati + | :"haitian-creole" + | :hausa + | :hawaiian + | :hebrew + | :hindi + | :hmong + | :hungarian + | :icelandic + | :igbo + | :indonesian + | :irish + | :italian + | :japanese + | :javanese + | :kannada + | :kazakh + | :khmer + | :kinyarwanda + | :korean + | :kurdish + | :kyrgyz + | :lao + | :latin + | :latvian + | :lingala + | :lithuanian + | :luxembourgish + | :macedonian + | :malagasy + | :malay + | :malayalam + | :maltese + | :maori + | :marathi + | :mongolian + | :nepali + | :norwegian + | :odia + | :oromo + | :pashto + | :pidgin + | :polish + | :portuguese + | :punjabi + | :quechua + | :romanian + | :russian + | :samoan + | :"scottish-gaelic" + | :serbian + | :sesotho + | :shona + | :sindhi + | :sinhala + | :slovak + | :slovene + | :somali + | :spanish + | :sundanese + | :swahili + | :swedish + | :tagalog + | :tajik + | :tamil + | :tatar + | :telugu + | :thai + | :tibetan + | :tigrinya + | :tongan + | :tswana + | :turkish + | :turkmen + | :ukrainian + | :urdu + | :uyghur + | :uzbek + | :vietnamese + | :welsh + | :wolof + | :xhosa + | :yiddish + | :yoruba + | :zulu + + module PrimaryLanguage + extend BrandDev::Internal::Type::Enum + + AFRIKAANS: :afrikaans + ALBANIAN: :albanian + AMHARIC: :amharic + ARABIC: :arabic + ARMENIAN: :armenian + ASSAMESE: :assamese + AYMARA: :aymara + AZERI: :azeri + BASQUE: :basque + BELARUSIAN: :belarusian + BENGALI: :bengali + BOSNIAN: :bosnian + BULGARIAN: :bulgarian + BURMESE: :burmese + CANTONESE: :cantonese + CATALAN: :catalan + CEBUANO: :cebuano + CHINESE: :chinese + CORSICAN: :corsican + CROATIAN: :croatian + CZECH: :czech + DANISH: :danish + DUTCH: :dutch + ENGLISH: :english + ESPERANTO: :esperanto + ESTONIAN: :estonian + FARSI: :farsi + FIJIAN: :fijian + FINNISH: :finnish + FRENCH: :french + GALICIAN: :galician + GEORGIAN: :georgian + GERMAN: :german + GREEK: :greek + GUARANI: :guarani + GUJARATI: :gujarati + HAITIAN_CREOLE: :"haitian-creole" + HAUSA: :hausa + HAWAIIAN: :hawaiian + HEBREW: :hebrew + HINDI: :hindi + HMONG: :hmong + HUNGARIAN: :hungarian + ICELANDIC: :icelandic + IGBO: :igbo + INDONESIAN: :indonesian + IRISH: :irish + ITALIAN: :italian + JAPANESE: :japanese + JAVANESE: :javanese + KANNADA: :kannada + KAZAKH: :kazakh + KHMER: :khmer + KINYARWANDA: :kinyarwanda + KOREAN: :korean + KURDISH: :kurdish + KYRGYZ: :kyrgyz + LAO: :lao + LATIN: :latin + LATVIAN: :latvian + LINGALA: :lingala + LITHUANIAN: :lithuanian + LUXEMBOURGISH: :luxembourgish + MACEDONIAN: :macedonian + MALAGASY: :malagasy + MALAY: :malay + MALAYALAM: :malayalam + MALTESE: :maltese + MAORI: :maori + MARATHI: :marathi + MONGOLIAN: :mongolian + NEPALI: :nepali + NORWEGIAN: :norwegian + ODIA: :odia + OROMO: :oromo + PASHTO: :pashto + PIDGIN: :pidgin + POLISH: :polish + PORTUGUESE: :portuguese + PUNJABI: :punjabi + QUECHUA: :quechua + ROMANIAN: :romanian + RUSSIAN: :russian + SAMOAN: :samoan + SCOTTISH_GAELIC: :"scottish-gaelic" + SERBIAN: :serbian + SESOTHO: :sesotho + SHONA: :shona + SINDHI: :sindhi + SINHALA: :sinhala + SLOVAK: :slovak + SLOVENE: :slovene + SOMALI: :somali + SPANISH: :spanish + SUNDANESE: :sundanese + SWAHILI: :swahili + SWEDISH: :swedish + TAGALOG: :tagalog + TAJIK: :tajik + TAMIL: :tamil + TATAR: :tatar + TELUGU: :telugu + THAI: :thai + TIBETAN: :tibetan + TIGRINYA: :tigrinya + TONGAN: :tongan + TSWANA: :tswana + TURKISH: :turkish + TURKMEN: :turkmen + UKRAINIAN: :ukrainian + URDU: :urdu + UYGHUR: :uyghur + UZBEK: :uzbek + VIETNAMESE: :vietnamese + WELSH: :welsh + WOLOF: :wolof + XHOSA: :xhosa + YIDDISH: :yiddish + YORUBA: :yoruba + ZULU: :zulu + + def self?.values: -> ::Array[BrandDev::Models::BrandRetrieveResponse::Brand::primary_language] + end + type social = { type: String, url: String } class Social < BrandDev::Internal::Type::BaseModel From 22d1e77b4b4cfd0df257f1e8018187de16ea93a0 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sun, 5 Apr 2026 15:20:58 +0000 Subject: [PATCH 03/82] feat(api): api update --- .stats.yml | 4 +- ...rand_identify_from_transaction_response.rb | 50 +++- .../brand_retrieve_by_email_response.rb | 50 +++- .../models/brand_retrieve_by_isin_response.rb | 50 +++- .../models/brand_retrieve_by_name_response.rb | 50 +++- .../brand_retrieve_by_ticker_response.rb | 50 +++- .../models/brand_retrieve_response.rb | 50 +++- ...and_identify_from_transaction_response.rbi | 217 +++++++++++++++++- .../brand_retrieve_by_email_response.rbi | 217 +++++++++++++++++- .../brand_retrieve_by_isin_response.rbi | 217 +++++++++++++++++- .../brand_retrieve_by_name_response.rbi | 217 +++++++++++++++++- .../brand_retrieve_by_ticker_response.rbi | 217 +++++++++++++++++- .../models/brand_retrieve_response.rbi | 217 +++++++++++++++++- ...and_identify_from_transaction_response.rbs | 93 +++++++- .../brand_retrieve_by_email_response.rbs | 93 +++++++- .../brand_retrieve_by_isin_response.rbs | 93 +++++++- .../brand_retrieve_by_name_response.rbs | 93 +++++++- .../brand_retrieve_by_ticker_response.rbs | 93 +++++++- .../models/brand_retrieve_response.rbs | 93 +++++++- 19 files changed, 2072 insertions(+), 92 deletions(-) diff --git a/.stats.yml b/.stats.yml index 7c16337..eb61618 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 20 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-095758df21a0bad753cde157cc0216339f77aec5b01de9bf36d55e34770cb611.yml -openapi_spec_hash: 4d5456700d25c12524ca030bb93d4261 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-f2509d0b758e88572e5a8145b8296cb330154727d9797e615ad19e44e050af26.yml +openapi_spec_hash: 40640a033ee09bda79ec066ba3744206 config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 diff --git a/lib/brand_dev/models/brand_identify_from_transaction_response.rb b/lib/brand_dev/models/brand_identify_from_transaction_response.rb index 5dfa38c..806800f 100644 --- a/lib/brand_dev/models/brand_identify_from_transaction_response.rb +++ b/lib/brand_dev/models/brand_identify_from_transaction_response.rb @@ -952,10 +952,10 @@ module PrimaryLanguage class Social < BrandDev::Internal::Type::BaseModel # @!attribute type - # Type of social media, e.g., 'facebook', 'twitter' + # Type of social media platform # - # @return [String, nil] - optional :type, String + # @return [Symbol, BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Social::Type, nil] + optional :type, enum: -> { BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Social::Type } # @!attribute url # URL of the social media page @@ -964,9 +964,51 @@ class Social < BrandDev::Internal::Type::BaseModel optional :url, String # @!method initialize(type: nil, url: nil) - # @param type [String] Type of social media, e.g., 'facebook', 'twitter' + # @param type [Symbol, BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Social::Type] Type of social media platform # # @param url [String] URL of the social media page + + # Type of social media platform + # + # @see BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Social#type + module Type + extend BrandDev::Internal::Type::Enum + + X = :x + FACEBOOK = :facebook + INSTAGRAM = :instagram + LINKEDIN = :linkedin + YOUTUBE = :youtube + PINTEREST = :pinterest + TIKTOK = :tiktok + DRIBBBLE = :dribbble + GITHUB = :github + BEHANCE = :behance + SNAPCHAT = :snapchat + WHATSAPP = :whatsapp + TELEGRAM = :telegram + LINE = :line + DISCORD = :discord + TWITCH = :twitch + VIMEO = :vimeo + IMDB = :imdb + TUMBLR = :tumblr + FLICKR = :flickr + GIPHY = :giphy + MEDIUM = :medium + SPOTIFY = :spotify + SOUNDCLOUD = :soundcloud + TRIPADVISOR = :tripadvisor + YELP = :yelp + PRODUCTHUNT = :producthunt + REDDIT = :reddit + CRUNCHBASE = :crunchbase + APPSTORE = :appstore + PLAYSTORE = :playstore + + # @!method self.values + # @return [Array] + end end # @see BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand#stock diff --git a/lib/brand_dev/models/brand_retrieve_by_email_response.rb b/lib/brand_dev/models/brand_retrieve_by_email_response.rb index 81b0666..a279015 100644 --- a/lib/brand_dev/models/brand_retrieve_by_email_response.rb +++ b/lib/brand_dev/models/brand_retrieve_by_email_response.rb @@ -948,10 +948,10 @@ module PrimaryLanguage class Social < BrandDev::Internal::Type::BaseModel # @!attribute type - # Type of social media, e.g., 'facebook', 'twitter' + # Type of social media platform # - # @return [String, nil] - optional :type, String + # @return [Symbol, BrandDev::Models::BrandRetrieveByEmailResponse::Brand::Social::Type, nil] + optional :type, enum: -> { BrandDev::Models::BrandRetrieveByEmailResponse::Brand::Social::Type } # @!attribute url # URL of the social media page @@ -960,9 +960,51 @@ class Social < BrandDev::Internal::Type::BaseModel optional :url, String # @!method initialize(type: nil, url: nil) - # @param type [String] Type of social media, e.g., 'facebook', 'twitter' + # @param type [Symbol, BrandDev::Models::BrandRetrieveByEmailResponse::Brand::Social::Type] Type of social media platform # # @param url [String] URL of the social media page + + # Type of social media platform + # + # @see BrandDev::Models::BrandRetrieveByEmailResponse::Brand::Social#type + module Type + extend BrandDev::Internal::Type::Enum + + X = :x + FACEBOOK = :facebook + INSTAGRAM = :instagram + LINKEDIN = :linkedin + YOUTUBE = :youtube + PINTEREST = :pinterest + TIKTOK = :tiktok + DRIBBBLE = :dribbble + GITHUB = :github + BEHANCE = :behance + SNAPCHAT = :snapchat + WHATSAPP = :whatsapp + TELEGRAM = :telegram + LINE = :line + DISCORD = :discord + TWITCH = :twitch + VIMEO = :vimeo + IMDB = :imdb + TUMBLR = :tumblr + FLICKR = :flickr + GIPHY = :giphy + MEDIUM = :medium + SPOTIFY = :spotify + SOUNDCLOUD = :soundcloud + TRIPADVISOR = :tripadvisor + YELP = :yelp + PRODUCTHUNT = :producthunt + REDDIT = :reddit + CRUNCHBASE = :crunchbase + APPSTORE = :appstore + PLAYSTORE = :playstore + + # @!method self.values + # @return [Array] + end end # @see BrandDev::Models::BrandRetrieveByEmailResponse::Brand#stock diff --git a/lib/brand_dev/models/brand_retrieve_by_isin_response.rb b/lib/brand_dev/models/brand_retrieve_by_isin_response.rb index 692656b..f1ea518 100644 --- a/lib/brand_dev/models/brand_retrieve_by_isin_response.rb +++ b/lib/brand_dev/models/brand_retrieve_by_isin_response.rb @@ -948,10 +948,10 @@ module PrimaryLanguage class Social < BrandDev::Internal::Type::BaseModel # @!attribute type - # Type of social media, e.g., 'facebook', 'twitter' + # Type of social media platform # - # @return [String, nil] - optional :type, String + # @return [Symbol, BrandDev::Models::BrandRetrieveByIsinResponse::Brand::Social::Type, nil] + optional :type, enum: -> { BrandDev::Models::BrandRetrieveByIsinResponse::Brand::Social::Type } # @!attribute url # URL of the social media page @@ -960,9 +960,51 @@ class Social < BrandDev::Internal::Type::BaseModel optional :url, String # @!method initialize(type: nil, url: nil) - # @param type [String] Type of social media, e.g., 'facebook', 'twitter' + # @param type [Symbol, BrandDev::Models::BrandRetrieveByIsinResponse::Brand::Social::Type] Type of social media platform # # @param url [String] URL of the social media page + + # Type of social media platform + # + # @see BrandDev::Models::BrandRetrieveByIsinResponse::Brand::Social#type + module Type + extend BrandDev::Internal::Type::Enum + + X = :x + FACEBOOK = :facebook + INSTAGRAM = :instagram + LINKEDIN = :linkedin + YOUTUBE = :youtube + PINTEREST = :pinterest + TIKTOK = :tiktok + DRIBBBLE = :dribbble + GITHUB = :github + BEHANCE = :behance + SNAPCHAT = :snapchat + WHATSAPP = :whatsapp + TELEGRAM = :telegram + LINE = :line + DISCORD = :discord + TWITCH = :twitch + VIMEO = :vimeo + IMDB = :imdb + TUMBLR = :tumblr + FLICKR = :flickr + GIPHY = :giphy + MEDIUM = :medium + SPOTIFY = :spotify + SOUNDCLOUD = :soundcloud + TRIPADVISOR = :tripadvisor + YELP = :yelp + PRODUCTHUNT = :producthunt + REDDIT = :reddit + CRUNCHBASE = :crunchbase + APPSTORE = :appstore + PLAYSTORE = :playstore + + # @!method self.values + # @return [Array] + end end # @see BrandDev::Models::BrandRetrieveByIsinResponse::Brand#stock diff --git a/lib/brand_dev/models/brand_retrieve_by_name_response.rb b/lib/brand_dev/models/brand_retrieve_by_name_response.rb index 9272bc2..d06366b 100644 --- a/lib/brand_dev/models/brand_retrieve_by_name_response.rb +++ b/lib/brand_dev/models/brand_retrieve_by_name_response.rb @@ -948,10 +948,10 @@ module PrimaryLanguage class Social < BrandDev::Internal::Type::BaseModel # @!attribute type - # Type of social media, e.g., 'facebook', 'twitter' + # Type of social media platform # - # @return [String, nil] - optional :type, String + # @return [Symbol, BrandDev::Models::BrandRetrieveByNameResponse::Brand::Social::Type, nil] + optional :type, enum: -> { BrandDev::Models::BrandRetrieveByNameResponse::Brand::Social::Type } # @!attribute url # URL of the social media page @@ -960,9 +960,51 @@ class Social < BrandDev::Internal::Type::BaseModel optional :url, String # @!method initialize(type: nil, url: nil) - # @param type [String] Type of social media, e.g., 'facebook', 'twitter' + # @param type [Symbol, BrandDev::Models::BrandRetrieveByNameResponse::Brand::Social::Type] Type of social media platform # # @param url [String] URL of the social media page + + # Type of social media platform + # + # @see BrandDev::Models::BrandRetrieveByNameResponse::Brand::Social#type + module Type + extend BrandDev::Internal::Type::Enum + + X = :x + FACEBOOK = :facebook + INSTAGRAM = :instagram + LINKEDIN = :linkedin + YOUTUBE = :youtube + PINTEREST = :pinterest + TIKTOK = :tiktok + DRIBBBLE = :dribbble + GITHUB = :github + BEHANCE = :behance + SNAPCHAT = :snapchat + WHATSAPP = :whatsapp + TELEGRAM = :telegram + LINE = :line + DISCORD = :discord + TWITCH = :twitch + VIMEO = :vimeo + IMDB = :imdb + TUMBLR = :tumblr + FLICKR = :flickr + GIPHY = :giphy + MEDIUM = :medium + SPOTIFY = :spotify + SOUNDCLOUD = :soundcloud + TRIPADVISOR = :tripadvisor + YELP = :yelp + PRODUCTHUNT = :producthunt + REDDIT = :reddit + CRUNCHBASE = :crunchbase + APPSTORE = :appstore + PLAYSTORE = :playstore + + # @!method self.values + # @return [Array] + end end # @see BrandDev::Models::BrandRetrieveByNameResponse::Brand#stock diff --git a/lib/brand_dev/models/brand_retrieve_by_ticker_response.rb b/lib/brand_dev/models/brand_retrieve_by_ticker_response.rb index 1ef699e..f2095db 100644 --- a/lib/brand_dev/models/brand_retrieve_by_ticker_response.rb +++ b/lib/brand_dev/models/brand_retrieve_by_ticker_response.rb @@ -948,10 +948,10 @@ module PrimaryLanguage class Social < BrandDev::Internal::Type::BaseModel # @!attribute type - # Type of social media, e.g., 'facebook', 'twitter' + # Type of social media platform # - # @return [String, nil] - optional :type, String + # @return [Symbol, BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Social::Type, nil] + optional :type, enum: -> { BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Social::Type } # @!attribute url # URL of the social media page @@ -960,9 +960,51 @@ class Social < BrandDev::Internal::Type::BaseModel optional :url, String # @!method initialize(type: nil, url: nil) - # @param type [String] Type of social media, e.g., 'facebook', 'twitter' + # @param type [Symbol, BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Social::Type] Type of social media platform # # @param url [String] URL of the social media page + + # Type of social media platform + # + # @see BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Social#type + module Type + extend BrandDev::Internal::Type::Enum + + X = :x + FACEBOOK = :facebook + INSTAGRAM = :instagram + LINKEDIN = :linkedin + YOUTUBE = :youtube + PINTEREST = :pinterest + TIKTOK = :tiktok + DRIBBBLE = :dribbble + GITHUB = :github + BEHANCE = :behance + SNAPCHAT = :snapchat + WHATSAPP = :whatsapp + TELEGRAM = :telegram + LINE = :line + DISCORD = :discord + TWITCH = :twitch + VIMEO = :vimeo + IMDB = :imdb + TUMBLR = :tumblr + FLICKR = :flickr + GIPHY = :giphy + MEDIUM = :medium + SPOTIFY = :spotify + SOUNDCLOUD = :soundcloud + TRIPADVISOR = :tripadvisor + YELP = :yelp + PRODUCTHUNT = :producthunt + REDDIT = :reddit + CRUNCHBASE = :crunchbase + APPSTORE = :appstore + PLAYSTORE = :playstore + + # @!method self.values + # @return [Array] + end end # @see BrandDev::Models::BrandRetrieveByTickerResponse::Brand#stock diff --git a/lib/brand_dev/models/brand_retrieve_response.rb b/lib/brand_dev/models/brand_retrieve_response.rb index ab01bee..7a57caf 100644 --- a/lib/brand_dev/models/brand_retrieve_response.rb +++ b/lib/brand_dev/models/brand_retrieve_response.rb @@ -947,10 +947,10 @@ module PrimaryLanguage class Social < BrandDev::Internal::Type::BaseModel # @!attribute type - # Type of social media, e.g., 'facebook', 'twitter' + # Type of social media platform # - # @return [String, nil] - optional :type, String + # @return [Symbol, BrandDev::Models::BrandRetrieveResponse::Brand::Social::Type, nil] + optional :type, enum: -> { BrandDev::Models::BrandRetrieveResponse::Brand::Social::Type } # @!attribute url # URL of the social media page @@ -959,9 +959,51 @@ class Social < BrandDev::Internal::Type::BaseModel optional :url, String # @!method initialize(type: nil, url: nil) - # @param type [String] Type of social media, e.g., 'facebook', 'twitter' + # @param type [Symbol, BrandDev::Models::BrandRetrieveResponse::Brand::Social::Type] Type of social media platform # # @param url [String] URL of the social media page + + # Type of social media platform + # + # @see BrandDev::Models::BrandRetrieveResponse::Brand::Social#type + module Type + extend BrandDev::Internal::Type::Enum + + X = :x + FACEBOOK = :facebook + INSTAGRAM = :instagram + LINKEDIN = :linkedin + YOUTUBE = :youtube + PINTEREST = :pinterest + TIKTOK = :tiktok + DRIBBBLE = :dribbble + GITHUB = :github + BEHANCE = :behance + SNAPCHAT = :snapchat + WHATSAPP = :whatsapp + TELEGRAM = :telegram + LINE = :line + DISCORD = :discord + TWITCH = :twitch + VIMEO = :vimeo + IMDB = :imdb + TUMBLR = :tumblr + FLICKR = :flickr + GIPHY = :giphy + MEDIUM = :medium + SPOTIFY = :spotify + SOUNDCLOUD = :soundcloud + TRIPADVISOR = :tripadvisor + YELP = :yelp + PRODUCTHUNT = :producthunt + REDDIT = :reddit + CRUNCHBASE = :crunchbase + APPSTORE = :appstore + PLAYSTORE = :playstore + + # @!method self.values + # @return [Array] + end end # @see BrandDev::Models::BrandRetrieveResponse::Brand#stock diff --git a/rbi/brand_dev/models/brand_identify_from_transaction_response.rbi b/rbi/brand_dev/models/brand_identify_from_transaction_response.rbi index e762457..435a96a 100644 --- a/rbi/brand_dev/models/brand_identify_from_transaction_response.rbi +++ b/rbi/brand_dev/models/brand_identify_from_transaction_response.rbi @@ -3169,11 +3169,22 @@ module BrandDev ) end - # Type of social media, e.g., 'facebook', 'twitter' - sig { returns(T.nilable(String)) } + # Type of social media platform + sig do + returns( + T.nilable( + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Social::Type::TaggedSymbol + ) + ) + end attr_reader :type - sig { params(type: String).void } + sig do + params( + type: + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Social::Type::OrSymbol + ).void + end attr_writer :type # URL of the social media page @@ -3183,18 +3194,212 @@ module BrandDev sig { params(url: String).void } attr_writer :url - sig { params(type: String, url: String).returns(T.attached_class) } + sig do + params( + type: + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Social::Type::OrSymbol, + url: String + ).returns(T.attached_class) + end def self.new( - # Type of social media, e.g., 'facebook', 'twitter' + # Type of social media platform type: nil, # URL of the social media page url: nil ) end - sig { override.returns({ type: String, url: String }) } + sig do + override.returns( + { + type: + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Social::Type::TaggedSymbol, + url: String + } + ) + end def to_hash end + + # Type of social media platform + module Type + extend BrandDev::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Social::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + X = + T.let( + :x, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Social::Type::TaggedSymbol + ) + FACEBOOK = + T.let( + :facebook, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Social::Type::TaggedSymbol + ) + INSTAGRAM = + T.let( + :instagram, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Social::Type::TaggedSymbol + ) + LINKEDIN = + T.let( + :linkedin, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Social::Type::TaggedSymbol + ) + YOUTUBE = + T.let( + :youtube, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Social::Type::TaggedSymbol + ) + PINTEREST = + T.let( + :pinterest, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Social::Type::TaggedSymbol + ) + TIKTOK = + T.let( + :tiktok, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Social::Type::TaggedSymbol + ) + DRIBBBLE = + T.let( + :dribbble, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Social::Type::TaggedSymbol + ) + GITHUB = + T.let( + :github, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Social::Type::TaggedSymbol + ) + BEHANCE = + T.let( + :behance, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Social::Type::TaggedSymbol + ) + SNAPCHAT = + T.let( + :snapchat, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Social::Type::TaggedSymbol + ) + WHATSAPP = + T.let( + :whatsapp, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Social::Type::TaggedSymbol + ) + TELEGRAM = + T.let( + :telegram, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Social::Type::TaggedSymbol + ) + LINE = + T.let( + :line, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Social::Type::TaggedSymbol + ) + DISCORD = + T.let( + :discord, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Social::Type::TaggedSymbol + ) + TWITCH = + T.let( + :twitch, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Social::Type::TaggedSymbol + ) + VIMEO = + T.let( + :vimeo, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Social::Type::TaggedSymbol + ) + IMDB = + T.let( + :imdb, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Social::Type::TaggedSymbol + ) + TUMBLR = + T.let( + :tumblr, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Social::Type::TaggedSymbol + ) + FLICKR = + T.let( + :flickr, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Social::Type::TaggedSymbol + ) + GIPHY = + T.let( + :giphy, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Social::Type::TaggedSymbol + ) + MEDIUM = + T.let( + :medium, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Social::Type::TaggedSymbol + ) + SPOTIFY = + T.let( + :spotify, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Social::Type::TaggedSymbol + ) + SOUNDCLOUD = + T.let( + :soundcloud, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Social::Type::TaggedSymbol + ) + TRIPADVISOR = + T.let( + :tripadvisor, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Social::Type::TaggedSymbol + ) + YELP = + T.let( + :yelp, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Social::Type::TaggedSymbol + ) + PRODUCTHUNT = + T.let( + :producthunt, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Social::Type::TaggedSymbol + ) + REDDIT = + T.let( + :reddit, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Social::Type::TaggedSymbol + ) + CRUNCHBASE = + T.let( + :crunchbase, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Social::Type::TaggedSymbol + ) + APPSTORE = + T.let( + :appstore, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Social::Type::TaggedSymbol + ) + PLAYSTORE = + T.let( + :playstore, + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Social::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Social::Type::TaggedSymbol + ] + ) + end + def self.values + end + end end class Stock < BrandDev::Internal::Type::BaseModel diff --git a/rbi/brand_dev/models/brand_retrieve_by_email_response.rbi b/rbi/brand_dev/models/brand_retrieve_by_email_response.rbi index 3cd6223..9eb6bb6 100644 --- a/rbi/brand_dev/models/brand_retrieve_by_email_response.rbi +++ b/rbi/brand_dev/models/brand_retrieve_by_email_response.rbi @@ -3164,11 +3164,22 @@ module BrandDev ) end - # Type of social media, e.g., 'facebook', 'twitter' - sig { returns(T.nilable(String)) } + # Type of social media platform + sig do + returns( + T.nilable( + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::Social::Type::TaggedSymbol + ) + ) + end attr_reader :type - sig { params(type: String).void } + sig do + params( + type: + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::Social::Type::OrSymbol + ).void + end attr_writer :type # URL of the social media page @@ -3178,18 +3189,212 @@ module BrandDev sig { params(url: String).void } attr_writer :url - sig { params(type: String, url: String).returns(T.attached_class) } + sig do + params( + type: + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::Social::Type::OrSymbol, + url: String + ).returns(T.attached_class) + end def self.new( - # Type of social media, e.g., 'facebook', 'twitter' + # Type of social media platform type: nil, # URL of the social media page url: nil ) end - sig { override.returns({ type: String, url: String }) } + sig do + override.returns( + { + type: + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::Social::Type::TaggedSymbol, + url: String + } + ) + end def to_hash end + + # Type of social media platform + module Type + extend BrandDev::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::Social::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + X = + T.let( + :x, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::Social::Type::TaggedSymbol + ) + FACEBOOK = + T.let( + :facebook, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::Social::Type::TaggedSymbol + ) + INSTAGRAM = + T.let( + :instagram, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::Social::Type::TaggedSymbol + ) + LINKEDIN = + T.let( + :linkedin, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::Social::Type::TaggedSymbol + ) + YOUTUBE = + T.let( + :youtube, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::Social::Type::TaggedSymbol + ) + PINTEREST = + T.let( + :pinterest, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::Social::Type::TaggedSymbol + ) + TIKTOK = + T.let( + :tiktok, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::Social::Type::TaggedSymbol + ) + DRIBBBLE = + T.let( + :dribbble, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::Social::Type::TaggedSymbol + ) + GITHUB = + T.let( + :github, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::Social::Type::TaggedSymbol + ) + BEHANCE = + T.let( + :behance, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::Social::Type::TaggedSymbol + ) + SNAPCHAT = + T.let( + :snapchat, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::Social::Type::TaggedSymbol + ) + WHATSAPP = + T.let( + :whatsapp, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::Social::Type::TaggedSymbol + ) + TELEGRAM = + T.let( + :telegram, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::Social::Type::TaggedSymbol + ) + LINE = + T.let( + :line, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::Social::Type::TaggedSymbol + ) + DISCORD = + T.let( + :discord, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::Social::Type::TaggedSymbol + ) + TWITCH = + T.let( + :twitch, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::Social::Type::TaggedSymbol + ) + VIMEO = + T.let( + :vimeo, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::Social::Type::TaggedSymbol + ) + IMDB = + T.let( + :imdb, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::Social::Type::TaggedSymbol + ) + TUMBLR = + T.let( + :tumblr, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::Social::Type::TaggedSymbol + ) + FLICKR = + T.let( + :flickr, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::Social::Type::TaggedSymbol + ) + GIPHY = + T.let( + :giphy, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::Social::Type::TaggedSymbol + ) + MEDIUM = + T.let( + :medium, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::Social::Type::TaggedSymbol + ) + SPOTIFY = + T.let( + :spotify, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::Social::Type::TaggedSymbol + ) + SOUNDCLOUD = + T.let( + :soundcloud, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::Social::Type::TaggedSymbol + ) + TRIPADVISOR = + T.let( + :tripadvisor, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::Social::Type::TaggedSymbol + ) + YELP = + T.let( + :yelp, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::Social::Type::TaggedSymbol + ) + PRODUCTHUNT = + T.let( + :producthunt, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::Social::Type::TaggedSymbol + ) + REDDIT = + T.let( + :reddit, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::Social::Type::TaggedSymbol + ) + CRUNCHBASE = + T.let( + :crunchbase, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::Social::Type::TaggedSymbol + ) + APPSTORE = + T.let( + :appstore, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::Social::Type::TaggedSymbol + ) + PLAYSTORE = + T.let( + :playstore, + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::Social::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::Social::Type::TaggedSymbol + ] + ) + end + def self.values + end + end end class Stock < BrandDev::Internal::Type::BaseModel diff --git a/rbi/brand_dev/models/brand_retrieve_by_isin_response.rbi b/rbi/brand_dev/models/brand_retrieve_by_isin_response.rbi index 023fb77..d9c12a4 100644 --- a/rbi/brand_dev/models/brand_retrieve_by_isin_response.rbi +++ b/rbi/brand_dev/models/brand_retrieve_by_isin_response.rbi @@ -3162,11 +3162,22 @@ module BrandDev ) end - # Type of social media, e.g., 'facebook', 'twitter' - sig { returns(T.nilable(String)) } + # Type of social media platform + sig do + returns( + T.nilable( + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::Social::Type::TaggedSymbol + ) + ) + end attr_reader :type - sig { params(type: String).void } + sig do + params( + type: + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::Social::Type::OrSymbol + ).void + end attr_writer :type # URL of the social media page @@ -3176,18 +3187,212 @@ module BrandDev sig { params(url: String).void } attr_writer :url - sig { params(type: String, url: String).returns(T.attached_class) } + sig do + params( + type: + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::Social::Type::OrSymbol, + url: String + ).returns(T.attached_class) + end def self.new( - # Type of social media, e.g., 'facebook', 'twitter' + # Type of social media platform type: nil, # URL of the social media page url: nil ) end - sig { override.returns({ type: String, url: String }) } + sig do + override.returns( + { + type: + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::Social::Type::TaggedSymbol, + url: String + } + ) + end def to_hash end + + # Type of social media platform + module Type + extend BrandDev::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::Social::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + X = + T.let( + :x, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::Social::Type::TaggedSymbol + ) + FACEBOOK = + T.let( + :facebook, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::Social::Type::TaggedSymbol + ) + INSTAGRAM = + T.let( + :instagram, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::Social::Type::TaggedSymbol + ) + LINKEDIN = + T.let( + :linkedin, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::Social::Type::TaggedSymbol + ) + YOUTUBE = + T.let( + :youtube, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::Social::Type::TaggedSymbol + ) + PINTEREST = + T.let( + :pinterest, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::Social::Type::TaggedSymbol + ) + TIKTOK = + T.let( + :tiktok, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::Social::Type::TaggedSymbol + ) + DRIBBBLE = + T.let( + :dribbble, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::Social::Type::TaggedSymbol + ) + GITHUB = + T.let( + :github, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::Social::Type::TaggedSymbol + ) + BEHANCE = + T.let( + :behance, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::Social::Type::TaggedSymbol + ) + SNAPCHAT = + T.let( + :snapchat, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::Social::Type::TaggedSymbol + ) + WHATSAPP = + T.let( + :whatsapp, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::Social::Type::TaggedSymbol + ) + TELEGRAM = + T.let( + :telegram, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::Social::Type::TaggedSymbol + ) + LINE = + T.let( + :line, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::Social::Type::TaggedSymbol + ) + DISCORD = + T.let( + :discord, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::Social::Type::TaggedSymbol + ) + TWITCH = + T.let( + :twitch, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::Social::Type::TaggedSymbol + ) + VIMEO = + T.let( + :vimeo, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::Social::Type::TaggedSymbol + ) + IMDB = + T.let( + :imdb, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::Social::Type::TaggedSymbol + ) + TUMBLR = + T.let( + :tumblr, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::Social::Type::TaggedSymbol + ) + FLICKR = + T.let( + :flickr, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::Social::Type::TaggedSymbol + ) + GIPHY = + T.let( + :giphy, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::Social::Type::TaggedSymbol + ) + MEDIUM = + T.let( + :medium, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::Social::Type::TaggedSymbol + ) + SPOTIFY = + T.let( + :spotify, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::Social::Type::TaggedSymbol + ) + SOUNDCLOUD = + T.let( + :soundcloud, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::Social::Type::TaggedSymbol + ) + TRIPADVISOR = + T.let( + :tripadvisor, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::Social::Type::TaggedSymbol + ) + YELP = + T.let( + :yelp, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::Social::Type::TaggedSymbol + ) + PRODUCTHUNT = + T.let( + :producthunt, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::Social::Type::TaggedSymbol + ) + REDDIT = + T.let( + :reddit, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::Social::Type::TaggedSymbol + ) + CRUNCHBASE = + T.let( + :crunchbase, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::Social::Type::TaggedSymbol + ) + APPSTORE = + T.let( + :appstore, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::Social::Type::TaggedSymbol + ) + PLAYSTORE = + T.let( + :playstore, + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::Social::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::Social::Type::TaggedSymbol + ] + ) + end + def self.values + end + end end class Stock < BrandDev::Internal::Type::BaseModel diff --git a/rbi/brand_dev/models/brand_retrieve_by_name_response.rbi b/rbi/brand_dev/models/brand_retrieve_by_name_response.rbi index 723239d..5277d65 100644 --- a/rbi/brand_dev/models/brand_retrieve_by_name_response.rbi +++ b/rbi/brand_dev/models/brand_retrieve_by_name_response.rbi @@ -3162,11 +3162,22 @@ module BrandDev ) end - # Type of social media, e.g., 'facebook', 'twitter' - sig { returns(T.nilable(String)) } + # Type of social media platform + sig do + returns( + T.nilable( + BrandDev::Models::BrandRetrieveByNameResponse::Brand::Social::Type::TaggedSymbol + ) + ) + end attr_reader :type - sig { params(type: String).void } + sig do + params( + type: + BrandDev::Models::BrandRetrieveByNameResponse::Brand::Social::Type::OrSymbol + ).void + end attr_writer :type # URL of the social media page @@ -3176,18 +3187,212 @@ module BrandDev sig { params(url: String).void } attr_writer :url - sig { params(type: String, url: String).returns(T.attached_class) } + sig do + params( + type: + BrandDev::Models::BrandRetrieveByNameResponse::Brand::Social::Type::OrSymbol, + url: String + ).returns(T.attached_class) + end def self.new( - # Type of social media, e.g., 'facebook', 'twitter' + # Type of social media platform type: nil, # URL of the social media page url: nil ) end - sig { override.returns({ type: String, url: String }) } + sig do + override.returns( + { + type: + BrandDev::Models::BrandRetrieveByNameResponse::Brand::Social::Type::TaggedSymbol, + url: String + } + ) + end def to_hash end + + # Type of social media platform + module Type + extend BrandDev::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::Social::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + X = + T.let( + :x, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::Social::Type::TaggedSymbol + ) + FACEBOOK = + T.let( + :facebook, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::Social::Type::TaggedSymbol + ) + INSTAGRAM = + T.let( + :instagram, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::Social::Type::TaggedSymbol + ) + LINKEDIN = + T.let( + :linkedin, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::Social::Type::TaggedSymbol + ) + YOUTUBE = + T.let( + :youtube, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::Social::Type::TaggedSymbol + ) + PINTEREST = + T.let( + :pinterest, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::Social::Type::TaggedSymbol + ) + TIKTOK = + T.let( + :tiktok, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::Social::Type::TaggedSymbol + ) + DRIBBBLE = + T.let( + :dribbble, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::Social::Type::TaggedSymbol + ) + GITHUB = + T.let( + :github, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::Social::Type::TaggedSymbol + ) + BEHANCE = + T.let( + :behance, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::Social::Type::TaggedSymbol + ) + SNAPCHAT = + T.let( + :snapchat, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::Social::Type::TaggedSymbol + ) + WHATSAPP = + T.let( + :whatsapp, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::Social::Type::TaggedSymbol + ) + TELEGRAM = + T.let( + :telegram, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::Social::Type::TaggedSymbol + ) + LINE = + T.let( + :line, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::Social::Type::TaggedSymbol + ) + DISCORD = + T.let( + :discord, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::Social::Type::TaggedSymbol + ) + TWITCH = + T.let( + :twitch, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::Social::Type::TaggedSymbol + ) + VIMEO = + T.let( + :vimeo, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::Social::Type::TaggedSymbol + ) + IMDB = + T.let( + :imdb, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::Social::Type::TaggedSymbol + ) + TUMBLR = + T.let( + :tumblr, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::Social::Type::TaggedSymbol + ) + FLICKR = + T.let( + :flickr, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::Social::Type::TaggedSymbol + ) + GIPHY = + T.let( + :giphy, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::Social::Type::TaggedSymbol + ) + MEDIUM = + T.let( + :medium, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::Social::Type::TaggedSymbol + ) + SPOTIFY = + T.let( + :spotify, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::Social::Type::TaggedSymbol + ) + SOUNDCLOUD = + T.let( + :soundcloud, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::Social::Type::TaggedSymbol + ) + TRIPADVISOR = + T.let( + :tripadvisor, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::Social::Type::TaggedSymbol + ) + YELP = + T.let( + :yelp, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::Social::Type::TaggedSymbol + ) + PRODUCTHUNT = + T.let( + :producthunt, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::Social::Type::TaggedSymbol + ) + REDDIT = + T.let( + :reddit, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::Social::Type::TaggedSymbol + ) + CRUNCHBASE = + T.let( + :crunchbase, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::Social::Type::TaggedSymbol + ) + APPSTORE = + T.let( + :appstore, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::Social::Type::TaggedSymbol + ) + PLAYSTORE = + T.let( + :playstore, + BrandDev::Models::BrandRetrieveByNameResponse::Brand::Social::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + BrandDev::Models::BrandRetrieveByNameResponse::Brand::Social::Type::TaggedSymbol + ] + ) + end + def self.values + end + end end class Stock < BrandDev::Internal::Type::BaseModel diff --git a/rbi/brand_dev/models/brand_retrieve_by_ticker_response.rbi b/rbi/brand_dev/models/brand_retrieve_by_ticker_response.rbi index 1a922b2..559368e 100644 --- a/rbi/brand_dev/models/brand_retrieve_by_ticker_response.rbi +++ b/rbi/brand_dev/models/brand_retrieve_by_ticker_response.rbi @@ -3164,11 +3164,22 @@ module BrandDev ) end - # Type of social media, e.g., 'facebook', 'twitter' - sig { returns(T.nilable(String)) } + # Type of social media platform + sig do + returns( + T.nilable( + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Social::Type::TaggedSymbol + ) + ) + end attr_reader :type - sig { params(type: String).void } + sig do + params( + type: + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Social::Type::OrSymbol + ).void + end attr_writer :type # URL of the social media page @@ -3178,18 +3189,212 @@ module BrandDev sig { params(url: String).void } attr_writer :url - sig { params(type: String, url: String).returns(T.attached_class) } + sig do + params( + type: + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Social::Type::OrSymbol, + url: String + ).returns(T.attached_class) + end def self.new( - # Type of social media, e.g., 'facebook', 'twitter' + # Type of social media platform type: nil, # URL of the social media page url: nil ) end - sig { override.returns({ type: String, url: String }) } + sig do + override.returns( + { + type: + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Social::Type::TaggedSymbol, + url: String + } + ) + end def to_hash end + + # Type of social media platform + module Type + extend BrandDev::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Social::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + X = + T.let( + :x, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Social::Type::TaggedSymbol + ) + FACEBOOK = + T.let( + :facebook, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Social::Type::TaggedSymbol + ) + INSTAGRAM = + T.let( + :instagram, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Social::Type::TaggedSymbol + ) + LINKEDIN = + T.let( + :linkedin, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Social::Type::TaggedSymbol + ) + YOUTUBE = + T.let( + :youtube, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Social::Type::TaggedSymbol + ) + PINTEREST = + T.let( + :pinterest, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Social::Type::TaggedSymbol + ) + TIKTOK = + T.let( + :tiktok, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Social::Type::TaggedSymbol + ) + DRIBBBLE = + T.let( + :dribbble, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Social::Type::TaggedSymbol + ) + GITHUB = + T.let( + :github, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Social::Type::TaggedSymbol + ) + BEHANCE = + T.let( + :behance, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Social::Type::TaggedSymbol + ) + SNAPCHAT = + T.let( + :snapchat, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Social::Type::TaggedSymbol + ) + WHATSAPP = + T.let( + :whatsapp, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Social::Type::TaggedSymbol + ) + TELEGRAM = + T.let( + :telegram, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Social::Type::TaggedSymbol + ) + LINE = + T.let( + :line, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Social::Type::TaggedSymbol + ) + DISCORD = + T.let( + :discord, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Social::Type::TaggedSymbol + ) + TWITCH = + T.let( + :twitch, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Social::Type::TaggedSymbol + ) + VIMEO = + T.let( + :vimeo, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Social::Type::TaggedSymbol + ) + IMDB = + T.let( + :imdb, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Social::Type::TaggedSymbol + ) + TUMBLR = + T.let( + :tumblr, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Social::Type::TaggedSymbol + ) + FLICKR = + T.let( + :flickr, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Social::Type::TaggedSymbol + ) + GIPHY = + T.let( + :giphy, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Social::Type::TaggedSymbol + ) + MEDIUM = + T.let( + :medium, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Social::Type::TaggedSymbol + ) + SPOTIFY = + T.let( + :spotify, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Social::Type::TaggedSymbol + ) + SOUNDCLOUD = + T.let( + :soundcloud, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Social::Type::TaggedSymbol + ) + TRIPADVISOR = + T.let( + :tripadvisor, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Social::Type::TaggedSymbol + ) + YELP = + T.let( + :yelp, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Social::Type::TaggedSymbol + ) + PRODUCTHUNT = + T.let( + :producthunt, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Social::Type::TaggedSymbol + ) + REDDIT = + T.let( + :reddit, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Social::Type::TaggedSymbol + ) + CRUNCHBASE = + T.let( + :crunchbase, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Social::Type::TaggedSymbol + ) + APPSTORE = + T.let( + :appstore, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Social::Type::TaggedSymbol + ) + PLAYSTORE = + T.let( + :playstore, + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Social::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Social::Type::TaggedSymbol + ] + ) + end + def self.values + end + end end class Stock < BrandDev::Internal::Type::BaseModel diff --git a/rbi/brand_dev/models/brand_retrieve_response.rbi b/rbi/brand_dev/models/brand_retrieve_response.rbi index c7ae557..fc1e21c 100644 --- a/rbi/brand_dev/models/brand_retrieve_response.rbi +++ b/rbi/brand_dev/models/brand_retrieve_response.rbi @@ -3137,11 +3137,22 @@ module BrandDev ) end - # Type of social media, e.g., 'facebook', 'twitter' - sig { returns(T.nilable(String)) } + # Type of social media platform + sig do + returns( + T.nilable( + BrandDev::Models::BrandRetrieveResponse::Brand::Social::Type::TaggedSymbol + ) + ) + end attr_reader :type - sig { params(type: String).void } + sig do + params( + type: + BrandDev::Models::BrandRetrieveResponse::Brand::Social::Type::OrSymbol + ).void + end attr_writer :type # URL of the social media page @@ -3151,18 +3162,212 @@ module BrandDev sig { params(url: String).void } attr_writer :url - sig { params(type: String, url: String).returns(T.attached_class) } + sig do + params( + type: + BrandDev::Models::BrandRetrieveResponse::Brand::Social::Type::OrSymbol, + url: String + ).returns(T.attached_class) + end def self.new( - # Type of social media, e.g., 'facebook', 'twitter' + # Type of social media platform type: nil, # URL of the social media page url: nil ) end - sig { override.returns({ type: String, url: String }) } + sig do + override.returns( + { + type: + BrandDev::Models::BrandRetrieveResponse::Brand::Social::Type::TaggedSymbol, + url: String + } + ) + end def to_hash end + + # Type of social media platform + module Type + extend BrandDev::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + BrandDev::Models::BrandRetrieveResponse::Brand::Social::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + X = + T.let( + :x, + BrandDev::Models::BrandRetrieveResponse::Brand::Social::Type::TaggedSymbol + ) + FACEBOOK = + T.let( + :facebook, + BrandDev::Models::BrandRetrieveResponse::Brand::Social::Type::TaggedSymbol + ) + INSTAGRAM = + T.let( + :instagram, + BrandDev::Models::BrandRetrieveResponse::Brand::Social::Type::TaggedSymbol + ) + LINKEDIN = + T.let( + :linkedin, + BrandDev::Models::BrandRetrieveResponse::Brand::Social::Type::TaggedSymbol + ) + YOUTUBE = + T.let( + :youtube, + BrandDev::Models::BrandRetrieveResponse::Brand::Social::Type::TaggedSymbol + ) + PINTEREST = + T.let( + :pinterest, + BrandDev::Models::BrandRetrieveResponse::Brand::Social::Type::TaggedSymbol + ) + TIKTOK = + T.let( + :tiktok, + BrandDev::Models::BrandRetrieveResponse::Brand::Social::Type::TaggedSymbol + ) + DRIBBBLE = + T.let( + :dribbble, + BrandDev::Models::BrandRetrieveResponse::Brand::Social::Type::TaggedSymbol + ) + GITHUB = + T.let( + :github, + BrandDev::Models::BrandRetrieveResponse::Brand::Social::Type::TaggedSymbol + ) + BEHANCE = + T.let( + :behance, + BrandDev::Models::BrandRetrieveResponse::Brand::Social::Type::TaggedSymbol + ) + SNAPCHAT = + T.let( + :snapchat, + BrandDev::Models::BrandRetrieveResponse::Brand::Social::Type::TaggedSymbol + ) + WHATSAPP = + T.let( + :whatsapp, + BrandDev::Models::BrandRetrieveResponse::Brand::Social::Type::TaggedSymbol + ) + TELEGRAM = + T.let( + :telegram, + BrandDev::Models::BrandRetrieveResponse::Brand::Social::Type::TaggedSymbol + ) + LINE = + T.let( + :line, + BrandDev::Models::BrandRetrieveResponse::Brand::Social::Type::TaggedSymbol + ) + DISCORD = + T.let( + :discord, + BrandDev::Models::BrandRetrieveResponse::Brand::Social::Type::TaggedSymbol + ) + TWITCH = + T.let( + :twitch, + BrandDev::Models::BrandRetrieveResponse::Brand::Social::Type::TaggedSymbol + ) + VIMEO = + T.let( + :vimeo, + BrandDev::Models::BrandRetrieveResponse::Brand::Social::Type::TaggedSymbol + ) + IMDB = + T.let( + :imdb, + BrandDev::Models::BrandRetrieveResponse::Brand::Social::Type::TaggedSymbol + ) + TUMBLR = + T.let( + :tumblr, + BrandDev::Models::BrandRetrieveResponse::Brand::Social::Type::TaggedSymbol + ) + FLICKR = + T.let( + :flickr, + BrandDev::Models::BrandRetrieveResponse::Brand::Social::Type::TaggedSymbol + ) + GIPHY = + T.let( + :giphy, + BrandDev::Models::BrandRetrieveResponse::Brand::Social::Type::TaggedSymbol + ) + MEDIUM = + T.let( + :medium, + BrandDev::Models::BrandRetrieveResponse::Brand::Social::Type::TaggedSymbol + ) + SPOTIFY = + T.let( + :spotify, + BrandDev::Models::BrandRetrieveResponse::Brand::Social::Type::TaggedSymbol + ) + SOUNDCLOUD = + T.let( + :soundcloud, + BrandDev::Models::BrandRetrieveResponse::Brand::Social::Type::TaggedSymbol + ) + TRIPADVISOR = + T.let( + :tripadvisor, + BrandDev::Models::BrandRetrieveResponse::Brand::Social::Type::TaggedSymbol + ) + YELP = + T.let( + :yelp, + BrandDev::Models::BrandRetrieveResponse::Brand::Social::Type::TaggedSymbol + ) + PRODUCTHUNT = + T.let( + :producthunt, + BrandDev::Models::BrandRetrieveResponse::Brand::Social::Type::TaggedSymbol + ) + REDDIT = + T.let( + :reddit, + BrandDev::Models::BrandRetrieveResponse::Brand::Social::Type::TaggedSymbol + ) + CRUNCHBASE = + T.let( + :crunchbase, + BrandDev::Models::BrandRetrieveResponse::Brand::Social::Type::TaggedSymbol + ) + APPSTORE = + T.let( + :appstore, + BrandDev::Models::BrandRetrieveResponse::Brand::Social::Type::TaggedSymbol + ) + PLAYSTORE = + T.let( + :playstore, + BrandDev::Models::BrandRetrieveResponse::Brand::Social::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + BrandDev::Models::BrandRetrieveResponse::Brand::Social::Type::TaggedSymbol + ] + ) + end + def self.values + end + end end class Stock < BrandDev::Internal::Type::BaseModel diff --git a/sig/brand_dev/models/brand_identify_from_transaction_response.rbs b/sig/brand_dev/models/brand_identify_from_transaction_response.rbs index d141f4a..490ee87 100644 --- a/sig/brand_dev/models/brand_identify_from_transaction_response.rbs +++ b/sig/brand_dev/models/brand_identify_from_transaction_response.rbs @@ -1293,20 +1293,103 @@ module BrandDev def self?.values: -> ::Array[BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::primary_language] end - type social = { type: String, url: String } + type social = + { + type: BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Social::type_, + url: String + } class Social < BrandDev::Internal::Type::BaseModel - attr_reader type: String? + attr_reader type: BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Social::type_? - def type=: (String) -> String + def type=: ( + BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Social::type_ + ) -> BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Social::type_ attr_reader url: String? def url=: (String) -> String - def initialize: (?type: String, ?url: String) -> void + def initialize: ( + ?type: BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Social::type_, + ?url: String + ) -> void + + def to_hash: -> { + type: BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Social::type_, + url: String + } + + type type_ = + :x + | :facebook + | :instagram + | :linkedin + | :youtube + | :pinterest + | :tiktok + | :dribbble + | :github + | :behance + | :snapchat + | :whatsapp + | :telegram + | :line + | :discord + | :twitch + | :vimeo + | :imdb + | :tumblr + | :flickr + | :giphy + | :medium + | :spotify + | :soundcloud + | :tripadvisor + | :yelp + | :producthunt + | :reddit + | :crunchbase + | :appstore + | :playstore - def to_hash: -> { type: String, url: String } + module Type + extend BrandDev::Internal::Type::Enum + + X: :x + FACEBOOK: :facebook + INSTAGRAM: :instagram + LINKEDIN: :linkedin + YOUTUBE: :youtube + PINTEREST: :pinterest + TIKTOK: :tiktok + DRIBBBLE: :dribbble + GITHUB: :github + BEHANCE: :behance + SNAPCHAT: :snapchat + WHATSAPP: :whatsapp + TELEGRAM: :telegram + LINE: :line + DISCORD: :discord + TWITCH: :twitch + VIMEO: :vimeo + IMDB: :imdb + TUMBLR: :tumblr + FLICKR: :flickr + GIPHY: :giphy + MEDIUM: :medium + SPOTIFY: :spotify + SOUNDCLOUD: :soundcloud + TRIPADVISOR: :tripadvisor + YELP: :yelp + PRODUCTHUNT: :producthunt + REDDIT: :reddit + CRUNCHBASE: :crunchbase + APPSTORE: :appstore + PLAYSTORE: :playstore + + def self?.values: -> ::Array[BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Social::type_] + end end type stock = { exchange: String, ticker: String } diff --git a/sig/brand_dev/models/brand_retrieve_by_email_response.rbs b/sig/brand_dev/models/brand_retrieve_by_email_response.rbs index e48d5e6..91c53b6 100644 --- a/sig/brand_dev/models/brand_retrieve_by_email_response.rbs +++ b/sig/brand_dev/models/brand_retrieve_by_email_response.rbs @@ -1293,20 +1293,103 @@ module BrandDev def self?.values: -> ::Array[BrandDev::Models::BrandRetrieveByEmailResponse::Brand::primary_language] end - type social = { type: String, url: String } + type social = + { + type: BrandDev::Models::BrandRetrieveByEmailResponse::Brand::Social::type_, + url: String + } class Social < BrandDev::Internal::Type::BaseModel - attr_reader type: String? + attr_reader type: BrandDev::Models::BrandRetrieveByEmailResponse::Brand::Social::type_? - def type=: (String) -> String + def type=: ( + BrandDev::Models::BrandRetrieveByEmailResponse::Brand::Social::type_ + ) -> BrandDev::Models::BrandRetrieveByEmailResponse::Brand::Social::type_ attr_reader url: String? def url=: (String) -> String - def initialize: (?type: String, ?url: String) -> void + def initialize: ( + ?type: BrandDev::Models::BrandRetrieveByEmailResponse::Brand::Social::type_, + ?url: String + ) -> void + + def to_hash: -> { + type: BrandDev::Models::BrandRetrieveByEmailResponse::Brand::Social::type_, + url: String + } + + type type_ = + :x + | :facebook + | :instagram + | :linkedin + | :youtube + | :pinterest + | :tiktok + | :dribbble + | :github + | :behance + | :snapchat + | :whatsapp + | :telegram + | :line + | :discord + | :twitch + | :vimeo + | :imdb + | :tumblr + | :flickr + | :giphy + | :medium + | :spotify + | :soundcloud + | :tripadvisor + | :yelp + | :producthunt + | :reddit + | :crunchbase + | :appstore + | :playstore - def to_hash: -> { type: String, url: String } + module Type + extend BrandDev::Internal::Type::Enum + + X: :x + FACEBOOK: :facebook + INSTAGRAM: :instagram + LINKEDIN: :linkedin + YOUTUBE: :youtube + PINTEREST: :pinterest + TIKTOK: :tiktok + DRIBBBLE: :dribbble + GITHUB: :github + BEHANCE: :behance + SNAPCHAT: :snapchat + WHATSAPP: :whatsapp + TELEGRAM: :telegram + LINE: :line + DISCORD: :discord + TWITCH: :twitch + VIMEO: :vimeo + IMDB: :imdb + TUMBLR: :tumblr + FLICKR: :flickr + GIPHY: :giphy + MEDIUM: :medium + SPOTIFY: :spotify + SOUNDCLOUD: :soundcloud + TRIPADVISOR: :tripadvisor + YELP: :yelp + PRODUCTHUNT: :producthunt + REDDIT: :reddit + CRUNCHBASE: :crunchbase + APPSTORE: :appstore + PLAYSTORE: :playstore + + def self?.values: -> ::Array[BrandDev::Models::BrandRetrieveByEmailResponse::Brand::Social::type_] + end end type stock = { exchange: String, ticker: String } diff --git a/sig/brand_dev/models/brand_retrieve_by_isin_response.rbs b/sig/brand_dev/models/brand_retrieve_by_isin_response.rbs index 2798f88..5300e8b 100644 --- a/sig/brand_dev/models/brand_retrieve_by_isin_response.rbs +++ b/sig/brand_dev/models/brand_retrieve_by_isin_response.rbs @@ -1293,20 +1293,103 @@ module BrandDev def self?.values: -> ::Array[BrandDev::Models::BrandRetrieveByIsinResponse::Brand::primary_language] end - type social = { type: String, url: String } + type social = + { + type: BrandDev::Models::BrandRetrieveByIsinResponse::Brand::Social::type_, + url: String + } class Social < BrandDev::Internal::Type::BaseModel - attr_reader type: String? + attr_reader type: BrandDev::Models::BrandRetrieveByIsinResponse::Brand::Social::type_? - def type=: (String) -> String + def type=: ( + BrandDev::Models::BrandRetrieveByIsinResponse::Brand::Social::type_ + ) -> BrandDev::Models::BrandRetrieveByIsinResponse::Brand::Social::type_ attr_reader url: String? def url=: (String) -> String - def initialize: (?type: String, ?url: String) -> void + def initialize: ( + ?type: BrandDev::Models::BrandRetrieveByIsinResponse::Brand::Social::type_, + ?url: String + ) -> void + + def to_hash: -> { + type: BrandDev::Models::BrandRetrieveByIsinResponse::Brand::Social::type_, + url: String + } + + type type_ = + :x + | :facebook + | :instagram + | :linkedin + | :youtube + | :pinterest + | :tiktok + | :dribbble + | :github + | :behance + | :snapchat + | :whatsapp + | :telegram + | :line + | :discord + | :twitch + | :vimeo + | :imdb + | :tumblr + | :flickr + | :giphy + | :medium + | :spotify + | :soundcloud + | :tripadvisor + | :yelp + | :producthunt + | :reddit + | :crunchbase + | :appstore + | :playstore - def to_hash: -> { type: String, url: String } + module Type + extend BrandDev::Internal::Type::Enum + + X: :x + FACEBOOK: :facebook + INSTAGRAM: :instagram + LINKEDIN: :linkedin + YOUTUBE: :youtube + PINTEREST: :pinterest + TIKTOK: :tiktok + DRIBBBLE: :dribbble + GITHUB: :github + BEHANCE: :behance + SNAPCHAT: :snapchat + WHATSAPP: :whatsapp + TELEGRAM: :telegram + LINE: :line + DISCORD: :discord + TWITCH: :twitch + VIMEO: :vimeo + IMDB: :imdb + TUMBLR: :tumblr + FLICKR: :flickr + GIPHY: :giphy + MEDIUM: :medium + SPOTIFY: :spotify + SOUNDCLOUD: :soundcloud + TRIPADVISOR: :tripadvisor + YELP: :yelp + PRODUCTHUNT: :producthunt + REDDIT: :reddit + CRUNCHBASE: :crunchbase + APPSTORE: :appstore + PLAYSTORE: :playstore + + def self?.values: -> ::Array[BrandDev::Models::BrandRetrieveByIsinResponse::Brand::Social::type_] + end end type stock = { exchange: String, ticker: String } diff --git a/sig/brand_dev/models/brand_retrieve_by_name_response.rbs b/sig/brand_dev/models/brand_retrieve_by_name_response.rbs index ca2b0e5..b165bd5 100644 --- a/sig/brand_dev/models/brand_retrieve_by_name_response.rbs +++ b/sig/brand_dev/models/brand_retrieve_by_name_response.rbs @@ -1293,20 +1293,103 @@ module BrandDev def self?.values: -> ::Array[BrandDev::Models::BrandRetrieveByNameResponse::Brand::primary_language] end - type social = { type: String, url: String } + type social = + { + type: BrandDev::Models::BrandRetrieveByNameResponse::Brand::Social::type_, + url: String + } class Social < BrandDev::Internal::Type::BaseModel - attr_reader type: String? + attr_reader type: BrandDev::Models::BrandRetrieveByNameResponse::Brand::Social::type_? - def type=: (String) -> String + def type=: ( + BrandDev::Models::BrandRetrieveByNameResponse::Brand::Social::type_ + ) -> BrandDev::Models::BrandRetrieveByNameResponse::Brand::Social::type_ attr_reader url: String? def url=: (String) -> String - def initialize: (?type: String, ?url: String) -> void + def initialize: ( + ?type: BrandDev::Models::BrandRetrieveByNameResponse::Brand::Social::type_, + ?url: String + ) -> void + + def to_hash: -> { + type: BrandDev::Models::BrandRetrieveByNameResponse::Brand::Social::type_, + url: String + } + + type type_ = + :x + | :facebook + | :instagram + | :linkedin + | :youtube + | :pinterest + | :tiktok + | :dribbble + | :github + | :behance + | :snapchat + | :whatsapp + | :telegram + | :line + | :discord + | :twitch + | :vimeo + | :imdb + | :tumblr + | :flickr + | :giphy + | :medium + | :spotify + | :soundcloud + | :tripadvisor + | :yelp + | :producthunt + | :reddit + | :crunchbase + | :appstore + | :playstore - def to_hash: -> { type: String, url: String } + module Type + extend BrandDev::Internal::Type::Enum + + X: :x + FACEBOOK: :facebook + INSTAGRAM: :instagram + LINKEDIN: :linkedin + YOUTUBE: :youtube + PINTEREST: :pinterest + TIKTOK: :tiktok + DRIBBBLE: :dribbble + GITHUB: :github + BEHANCE: :behance + SNAPCHAT: :snapchat + WHATSAPP: :whatsapp + TELEGRAM: :telegram + LINE: :line + DISCORD: :discord + TWITCH: :twitch + VIMEO: :vimeo + IMDB: :imdb + TUMBLR: :tumblr + FLICKR: :flickr + GIPHY: :giphy + MEDIUM: :medium + SPOTIFY: :spotify + SOUNDCLOUD: :soundcloud + TRIPADVISOR: :tripadvisor + YELP: :yelp + PRODUCTHUNT: :producthunt + REDDIT: :reddit + CRUNCHBASE: :crunchbase + APPSTORE: :appstore + PLAYSTORE: :playstore + + def self?.values: -> ::Array[BrandDev::Models::BrandRetrieveByNameResponse::Brand::Social::type_] + end end type stock = { exchange: String, ticker: String } diff --git a/sig/brand_dev/models/brand_retrieve_by_ticker_response.rbs b/sig/brand_dev/models/brand_retrieve_by_ticker_response.rbs index 1a30f5c..dd38bbe 100644 --- a/sig/brand_dev/models/brand_retrieve_by_ticker_response.rbs +++ b/sig/brand_dev/models/brand_retrieve_by_ticker_response.rbs @@ -1293,20 +1293,103 @@ module BrandDev def self?.values: -> ::Array[BrandDev::Models::BrandRetrieveByTickerResponse::Brand::primary_language] end - type social = { type: String, url: String } + type social = + { + type: BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Social::type_, + url: String + } class Social < BrandDev::Internal::Type::BaseModel - attr_reader type: String? + attr_reader type: BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Social::type_? - def type=: (String) -> String + def type=: ( + BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Social::type_ + ) -> BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Social::type_ attr_reader url: String? def url=: (String) -> String - def initialize: (?type: String, ?url: String) -> void + def initialize: ( + ?type: BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Social::type_, + ?url: String + ) -> void + + def to_hash: -> { + type: BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Social::type_, + url: String + } + + type type_ = + :x + | :facebook + | :instagram + | :linkedin + | :youtube + | :pinterest + | :tiktok + | :dribbble + | :github + | :behance + | :snapchat + | :whatsapp + | :telegram + | :line + | :discord + | :twitch + | :vimeo + | :imdb + | :tumblr + | :flickr + | :giphy + | :medium + | :spotify + | :soundcloud + | :tripadvisor + | :yelp + | :producthunt + | :reddit + | :crunchbase + | :appstore + | :playstore - def to_hash: -> { type: String, url: String } + module Type + extend BrandDev::Internal::Type::Enum + + X: :x + FACEBOOK: :facebook + INSTAGRAM: :instagram + LINKEDIN: :linkedin + YOUTUBE: :youtube + PINTEREST: :pinterest + TIKTOK: :tiktok + DRIBBBLE: :dribbble + GITHUB: :github + BEHANCE: :behance + SNAPCHAT: :snapchat + WHATSAPP: :whatsapp + TELEGRAM: :telegram + LINE: :line + DISCORD: :discord + TWITCH: :twitch + VIMEO: :vimeo + IMDB: :imdb + TUMBLR: :tumblr + FLICKR: :flickr + GIPHY: :giphy + MEDIUM: :medium + SPOTIFY: :spotify + SOUNDCLOUD: :soundcloud + TRIPADVISOR: :tripadvisor + YELP: :yelp + PRODUCTHUNT: :producthunt + REDDIT: :reddit + CRUNCHBASE: :crunchbase + APPSTORE: :appstore + PLAYSTORE: :playstore + + def self?.values: -> ::Array[BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Social::type_] + end end type stock = { exchange: String, ticker: String } diff --git a/sig/brand_dev/models/brand_retrieve_response.rbs b/sig/brand_dev/models/brand_retrieve_response.rbs index e4bf754..3717d34 100644 --- a/sig/brand_dev/models/brand_retrieve_response.rbs +++ b/sig/brand_dev/models/brand_retrieve_response.rbs @@ -1293,20 +1293,103 @@ module BrandDev def self?.values: -> ::Array[BrandDev::Models::BrandRetrieveResponse::Brand::primary_language] end - type social = { type: String, url: String } + type social = + { + type: BrandDev::Models::BrandRetrieveResponse::Brand::Social::type_, + url: String + } class Social < BrandDev::Internal::Type::BaseModel - attr_reader type: String? + attr_reader type: BrandDev::Models::BrandRetrieveResponse::Brand::Social::type_? - def type=: (String) -> String + def type=: ( + BrandDev::Models::BrandRetrieveResponse::Brand::Social::type_ + ) -> BrandDev::Models::BrandRetrieveResponse::Brand::Social::type_ attr_reader url: String? def url=: (String) -> String - def initialize: (?type: String, ?url: String) -> void + def initialize: ( + ?type: BrandDev::Models::BrandRetrieveResponse::Brand::Social::type_, + ?url: String + ) -> void + + def to_hash: -> { + type: BrandDev::Models::BrandRetrieveResponse::Brand::Social::type_, + url: String + } + + type type_ = + :x + | :facebook + | :instagram + | :linkedin + | :youtube + | :pinterest + | :tiktok + | :dribbble + | :github + | :behance + | :snapchat + | :whatsapp + | :telegram + | :line + | :discord + | :twitch + | :vimeo + | :imdb + | :tumblr + | :flickr + | :giphy + | :medium + | :spotify + | :soundcloud + | :tripadvisor + | :yelp + | :producthunt + | :reddit + | :crunchbase + | :appstore + | :playstore - def to_hash: -> { type: String, url: String } + module Type + extend BrandDev::Internal::Type::Enum + + X: :x + FACEBOOK: :facebook + INSTAGRAM: :instagram + LINKEDIN: :linkedin + YOUTUBE: :youtube + PINTEREST: :pinterest + TIKTOK: :tiktok + DRIBBBLE: :dribbble + GITHUB: :github + BEHANCE: :behance + SNAPCHAT: :snapchat + WHATSAPP: :whatsapp + TELEGRAM: :telegram + LINE: :line + DISCORD: :discord + TWITCH: :twitch + VIMEO: :vimeo + IMDB: :imdb + TUMBLR: :tumblr + FLICKR: :flickr + GIPHY: :giphy + MEDIUM: :medium + SPOTIFY: :spotify + SOUNDCLOUD: :soundcloud + TRIPADVISOR: :tripadvisor + YELP: :yelp + PRODUCTHUNT: :producthunt + REDDIT: :reddit + CRUNCHBASE: :crunchbase + APPSTORE: :appstore + PLAYSTORE: :playstore + + def self?.values: -> ::Array[BrandDev::Models::BrandRetrieveResponse::Brand::Social::type_] + end end type stock = { exchange: String, ticker: String } From a4d91a72d7bb1a80f9d24c9914e744437eaecbb3 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 9 Apr 2026 08:37:45 +0000 Subject: [PATCH 04/82] fix: multipart encoding for file arrays --- lib/brand_dev/internal/util.rb | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/lib/brand_dev/internal/util.rb b/lib/brand_dev/internal/util.rb index 0b8022c..4b1d42c 100644 --- a/lib/brand_dev/internal/util.rb +++ b/lib/brand_dev/internal/util.rb @@ -610,6 +610,7 @@ def encode_query_params(query) # # @return [Array(String, Enumerable)] private def encode_multipart_streaming(body) + # rubocop:disable Style/CaseEquality # RFC 1521 Section 7.2.1 says we should have 70 char maximum for boundary length boundary = SecureRandom.urlsafe_base64(46) @@ -619,7 +620,7 @@ def encode_query_params(query) in Hash body.each do |key, val| case val - in Array if val.all? { primitive?(_1) } + in Array if val.all? { primitive?(_1) || BrandDev::Internal::Type::FileInput === _1 } val.each do |v| write_multipart_chunk(y, boundary: boundary, key: key, val: v, closing: closing) end @@ -635,6 +636,7 @@ def encode_query_params(query) fused_io = fused_enum(strio) { closing.each(&:call) } [boundary, fused_io] + # rubocop:enable Style/CaseEquality end # @api private From c523c67ab269e7b2c2d6f6f50d93960d1a14da09 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 9 Apr 2026 15:46:44 +0000 Subject: [PATCH 05/82] feat(api): api update --- .stats.yml | 4 +-- .../models/brand_screenshot_params.rb | 22 ++++++++++--- lib/brand_dev/resources/brand.rb | 13 +++++--- .../models/brand_screenshot_params.rbi | 33 +++++++++++++++---- rbi/brand_dev/resources/brand.rbi | 15 ++++++--- .../models/brand_screenshot_params.rbs | 13 ++++++-- sig/brand_dev/resources/brand.rbs | 3 +- test/brand_dev/resources/brand_test.rb | 4 +-- 8 files changed, 80 insertions(+), 27 deletions(-) diff --git a/.stats.yml b/.stats.yml index eb61618..97c1cfd 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 20 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-f2509d0b758e88572e5a8145b8296cb330154727d9797e615ad19e44e050af26.yml -openapi_spec_hash: 40640a033ee09bda79ec066ba3744206 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-905e35387d755a84a2e7cd711f31eeea130e08a83bb7b39d3fa5445a187ef62f.yml +openapi_spec_hash: 205b2c17cb40ad54d76c2c06c9e5dda4 config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 diff --git a/lib/brand_dev/models/brand_screenshot_params.rb b/lib/brand_dev/models/brand_screenshot_params.rb index b2c9e5b..481064b 100644 --- a/lib/brand_dev/models/brand_screenshot_params.rb +++ b/lib/brand_dev/models/brand_screenshot_params.rb @@ -7,12 +7,20 @@ class BrandScreenshotParams < BrandDev::Internal::Type::BaseModel extend BrandDev::Internal::Type::RequestParameters::Converter include BrandDev::Internal::Type::RequestParameters + # @!attribute direct_url + # A specific URL to screenshot directly, bypassing domain resolution (e.g., + # 'https://example.com/pricing'). When provided, the screenshot is taken of this + # exact URL. + # + # @return [String, nil] + optional :direct_url, String + # @!attribute domain # Domain name to take screenshot of (e.g., 'example.com', 'google.com'). The # domain will be automatically normalized and validated. # - # @return [String] - required :domain, String + # @return [String, nil] + optional :domain, String # @!attribute full_screenshot # Optional parameter to determine screenshot type. If 'true', takes a full page @@ -26,7 +34,8 @@ class BrandScreenshotParams < BrandDev::Internal::Type::BaseModel # Optional parameter to specify which page type to screenshot. If provided, the # system will scrape the domain's links and use heuristics to find the most # appropriate URL for the specified page type (30 supported languages). If not - # provided, screenshots the main domain landing page. + # provided, screenshots the main domain landing page. Only applicable when using + # 'domain', not 'directUrl'. # # @return [Symbol, BrandDev::Models::BrandScreenshotParams::Page, nil] optional :page, enum: -> { BrandDev::BrandScreenshotParams::Page } @@ -39,10 +48,12 @@ class BrandScreenshotParams < BrandDev::Internal::Type::BaseModel # @return [Symbol, BrandDev::Models::BrandScreenshotParams::Prioritize, nil] optional :prioritize, enum: -> { BrandDev::BrandScreenshotParams::Prioritize } - # @!method initialize(domain:, full_screenshot: nil, page: nil, prioritize: nil, request_options: {}) + # @!method initialize(direct_url: nil, domain: nil, full_screenshot: nil, page: nil, prioritize: nil, request_options: {}) # Some parameter documentations has been truncated, see # {BrandDev::Models::BrandScreenshotParams} for more details. # + # @param direct_url [String] A specific URL to screenshot directly, bypassing domain resolution (e.g., 'https + # # @param domain [String] Domain name to take screenshot of (e.g., 'example.com', 'google.com'). The domai # # @param full_screenshot [Symbol, BrandDev::Models::BrandScreenshotParams::FullScreenshot] Optional parameter to determine screenshot type. If 'true', takes a full page sc @@ -69,7 +80,8 @@ module FullScreenshot # Optional parameter to specify which page type to screenshot. If provided, the # system will scrape the domain's links and use heuristics to find the most # appropriate URL for the specified page type (30 supported languages). If not - # provided, screenshots the main domain landing page. + # provided, screenshots the main domain landing page. Only applicable when using + # 'domain', not 'directUrl'. module Page extend BrandDev::Internal::Type::Enum diff --git a/lib/brand_dev/resources/brand.rb b/lib/brand_dev/resources/brand.rb index 0c721fe..6b54f98 100644 --- a/lib/brand_dev/resources/brand.rb +++ b/lib/brand_dev/resources/brand.rb @@ -465,10 +465,13 @@ def retrieve_simplified(params) # # Capture a screenshot of a website. Supports both viewport (standard browser # view) and full-page screenshots. Can also screenshot specific page types (login, - # pricing, etc.) by using heuristics to find the appropriate URL. Returns a URL to - # the uploaded screenshot image hosted on our CDN. + # pricing, etc.) by using heuristics to find the appropriate URL. Either 'domain' + # or 'directUrl' must be provided as a query parameter, but not both. Returns a + # URL to the uploaded screenshot image hosted on our CDN. # - # @overload screenshot(domain:, full_screenshot: nil, page: nil, prioritize: nil, request_options: {}) + # @overload screenshot(direct_url: nil, domain: nil, full_screenshot: nil, page: nil, prioritize: nil, request_options: {}) + # + # @param direct_url [String] A specific URL to screenshot directly, bypassing domain resolution (e.g., 'https # # @param domain [String] Domain name to take screenshot of (e.g., 'example.com', 'google.com'). The domai # @@ -483,13 +486,13 @@ def retrieve_simplified(params) # @return [BrandDev::Models::BrandScreenshotResponse] # # @see BrandDev::Models::BrandScreenshotParams - def screenshot(params) + def screenshot(params = {}) parsed, options = BrandDev::BrandScreenshotParams.dump_request(params) query = BrandDev::Internal::Util.encode_query_params(parsed) @client.request( method: :get, path: "brand/screenshot", - query: query.transform_keys(full_screenshot: "fullScreenshot"), + query: query.transform_keys(direct_url: "directUrl", full_screenshot: "fullScreenshot"), model: BrandDev::Models::BrandScreenshotResponse, options: options ) diff --git a/rbi/brand_dev/models/brand_screenshot_params.rbi b/rbi/brand_dev/models/brand_screenshot_params.rbi index 73a42ec..e0e9849 100644 --- a/rbi/brand_dev/models/brand_screenshot_params.rbi +++ b/rbi/brand_dev/models/brand_screenshot_params.rbi @@ -11,10 +11,22 @@ module BrandDev T.any(BrandDev::BrandScreenshotParams, BrandDev::Internal::AnyHash) end + # A specific URL to screenshot directly, bypassing domain resolution (e.g., + # 'https://example.com/pricing'). When provided, the screenshot is taken of this + # exact URL. + sig { returns(T.nilable(String)) } + attr_reader :direct_url + + sig { params(direct_url: String).void } + attr_writer :direct_url + # Domain name to take screenshot of (e.g., 'example.com', 'google.com'). The # domain will be automatically normalized and validated. - sig { returns(String) } - attr_accessor :domain + sig { returns(T.nilable(String)) } + attr_reader :domain + + sig { params(domain: String).void } + attr_writer :domain # Optional parameter to determine screenshot type. If 'true', takes a full page # screenshot capturing all content. If 'false' or not provided, takes a viewport @@ -37,7 +49,8 @@ module BrandDev # Optional parameter to specify which page type to screenshot. If provided, the # system will scrape the domain's links and use heuristics to find the most # appropriate URL for the specified page type (30 supported languages). If not - # provided, screenshots the main domain landing page. + # provided, screenshots the main domain landing page. Only applicable when using + # 'domain', not 'directUrl'. sig do returns(T.nilable(BrandDev::BrandScreenshotParams::Page::OrSymbol)) end @@ -65,6 +78,7 @@ module BrandDev sig do params( + direct_url: String, domain: String, full_screenshot: BrandDev::BrandScreenshotParams::FullScreenshot::OrSymbol, @@ -74,9 +88,13 @@ module BrandDev ).returns(T.attached_class) end def self.new( + # A specific URL to screenshot directly, bypassing domain resolution (e.g., + # 'https://example.com/pricing'). When provided, the screenshot is taken of this + # exact URL. + direct_url: nil, # Domain name to take screenshot of (e.g., 'example.com', 'google.com'). The # domain will be automatically normalized and validated. - domain:, + domain: nil, # Optional parameter to determine screenshot type. If 'true', takes a full page # screenshot capturing all content. If 'false' or not provided, takes a viewport # screenshot (standard browser view). @@ -84,7 +102,8 @@ module BrandDev # Optional parameter to specify which page type to screenshot. If provided, the # system will scrape the domain's links and use heuristics to find the most # appropriate URL for the specified page type (30 supported languages). If not - # provided, screenshots the main domain landing page. + # provided, screenshots the main domain landing page. Only applicable when using + # 'domain', not 'directUrl'. page: nil, # Optional parameter to prioritize screenshot capture. If 'speed', optimizes for # faster capture with basic quality. If 'quality', optimizes for higher quality @@ -97,6 +116,7 @@ module BrandDev sig do override.returns( { + direct_url: String, domain: String, full_screenshot: BrandDev::BrandScreenshotParams::FullScreenshot::OrSymbol, @@ -146,7 +166,8 @@ module BrandDev # Optional parameter to specify which page type to screenshot. If provided, the # system will scrape the domain's links and use heuristics to find the most # appropriate URL for the specified page type (30 supported languages). If not - # provided, screenshots the main domain landing page. + # provided, screenshots the main domain landing page. Only applicable when using + # 'domain', not 'directUrl'. module Page extend BrandDev::Internal::Type::Enum diff --git a/rbi/brand_dev/resources/brand.rbi b/rbi/brand_dev/resources/brand.rbi index 75c19a6..184f754 100644 --- a/rbi/brand_dev/resources/brand.rbi +++ b/rbi/brand_dev/resources/brand.rbi @@ -399,10 +399,12 @@ module BrandDev # Capture a screenshot of a website. Supports both viewport (standard browser # view) and full-page screenshots. Can also screenshot specific page types (login, - # pricing, etc.) by using heuristics to find the appropriate URL. Returns a URL to - # the uploaded screenshot image hosted on our CDN. + # pricing, etc.) by using heuristics to find the appropriate URL. Either 'domain' + # or 'directUrl' must be provided as a query parameter, but not both. Returns a + # URL to the uploaded screenshot image hosted on our CDN. sig do params( + direct_url: String, domain: String, full_screenshot: BrandDev::BrandScreenshotParams::FullScreenshot::OrSymbol, @@ -412,9 +414,13 @@ module BrandDev ).returns(BrandDev::Models::BrandScreenshotResponse) end def screenshot( + # A specific URL to screenshot directly, bypassing domain resolution (e.g., + # 'https://example.com/pricing'). When provided, the screenshot is taken of this + # exact URL. + direct_url: nil, # Domain name to take screenshot of (e.g., 'example.com', 'google.com'). The # domain will be automatically normalized and validated. - domain:, + domain: nil, # Optional parameter to determine screenshot type. If 'true', takes a full page # screenshot capturing all content. If 'false' or not provided, takes a viewport # screenshot (standard browser view). @@ -422,7 +428,8 @@ module BrandDev # Optional parameter to specify which page type to screenshot. If provided, the # system will scrape the domain's links and use heuristics to find the most # appropriate URL for the specified page type (30 supported languages). If not - # provided, screenshots the main domain landing page. + # provided, screenshots the main domain landing page. Only applicable when using + # 'domain', not 'directUrl'. page: nil, # Optional parameter to prioritize screenshot capture. If 'speed', optimizes for # faster capture with basic quality. If 'quality', optimizes for higher quality diff --git a/sig/brand_dev/models/brand_screenshot_params.rbs b/sig/brand_dev/models/brand_screenshot_params.rbs index 68737d1..711cecb 100644 --- a/sig/brand_dev/models/brand_screenshot_params.rbs +++ b/sig/brand_dev/models/brand_screenshot_params.rbs @@ -2,6 +2,7 @@ module BrandDev module Models type brand_screenshot_params = { + direct_url: String, domain: String, full_screenshot: BrandDev::Models::BrandScreenshotParams::full_screenshot, page: BrandDev::Models::BrandScreenshotParams::page, @@ -13,7 +14,13 @@ module BrandDev extend BrandDev::Internal::Type::RequestParameters::Converter include BrandDev::Internal::Type::RequestParameters - attr_accessor domain: String + attr_reader direct_url: String? + + def direct_url=: (String) -> String + + attr_reader domain: String? + + def domain=: (String) -> String attr_reader full_screenshot: BrandDev::Models::BrandScreenshotParams::full_screenshot? @@ -34,7 +41,8 @@ module BrandDev ) -> BrandDev::Models::BrandScreenshotParams::prioritize def initialize: ( - domain: String, + ?direct_url: String, + ?domain: String, ?full_screenshot: BrandDev::Models::BrandScreenshotParams::full_screenshot, ?page: BrandDev::Models::BrandScreenshotParams::page, ?prioritize: BrandDev::Models::BrandScreenshotParams::prioritize, @@ -42,6 +50,7 @@ module BrandDev ) -> void def to_hash: -> { + direct_url: String, domain: String, full_screenshot: BrandDev::Models::BrandScreenshotParams::full_screenshot, page: BrandDev::Models::BrandScreenshotParams::page, diff --git a/sig/brand_dev/resources/brand.rbs b/sig/brand_dev/resources/brand.rbs index 9b9be50..ac3bf63 100644 --- a/sig/brand_dev/resources/brand.rbs +++ b/sig/brand_dev/resources/brand.rbs @@ -108,7 +108,8 @@ module BrandDev ) -> BrandDev::Models::BrandRetrieveSimplifiedResponse def screenshot: ( - domain: String, + ?direct_url: String, + ?domain: String, ?full_screenshot: BrandDev::Models::BrandScreenshotParams::full_screenshot, ?page: BrandDev::Models::BrandScreenshotParams::page, ?prioritize: BrandDev::Models::BrandScreenshotParams::prioritize, diff --git a/test/brand_dev/resources/brand_test.rb b/test/brand_dev/resources/brand_test.rb index bbd5459..4be7ac8 100644 --- a/test/brand_dev/resources/brand_test.rb +++ b/test/brand_dev/resources/brand_test.rb @@ -267,10 +267,10 @@ def test_retrieve_simplified_required_params end end - def test_screenshot_required_params + def test_screenshot skip("Mock server tests are disabled") - response = @brand_dev.brand.screenshot(domain: "domain") + response = @brand_dev.brand.screenshot assert_pattern do response => BrandDev::Models::BrandScreenshotResponse From f04068330494b571a9b829511120e3d437cc78a1 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sun, 12 Apr 2026 14:44:40 +0000 Subject: [PATCH 06/82] codegen metadata --- .stats.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.stats.yml b/.stats.yml index 97c1cfd..f82697e 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 20 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-905e35387d755a84a2e7cd711f31eeea130e08a83bb7b39d3fa5445a187ef62f.yml -openapi_spec_hash: 205b2c17cb40ad54d76c2c06c9e5dda4 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-40b1d672fe922d8157775c48539332de9a8bff757a174db394ec5f1e3968678b.yml +openapi_spec_hash: ae60ee9eafb3bcb77ba255818e7d228d config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 From 62adcd887129bf9a8af69866f49ac2047f0a94b3 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sun, 12 Apr 2026 14:53:36 +0000 Subject: [PATCH 07/82] codegen metadata --- .stats.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.stats.yml b/.stats.yml index f82697e..4f2e69a 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 20 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-40b1d672fe922d8157775c48539332de9a8bff757a174db394ec5f1e3968678b.yml -openapi_spec_hash: ae60ee9eafb3bcb77ba255818e7d228d +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-0b41a16de26363ad6880dc82a92a24f4c44b5cd8435344720383619d6019e792.yml +openapi_spec_hash: fc92550089eb09bd802e4178bbde83c0 config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 From c245166ad76b855e35e9ef0c538f3bb5f884b63d Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sun, 12 Apr 2026 14:58:37 +0000 Subject: [PATCH 08/82] codegen metadata --- .stats.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.stats.yml b/.stats.yml index 4f2e69a..b49f2b4 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 20 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-0b41a16de26363ad6880dc82a92a24f4c44b5cd8435344720383619d6019e792.yml -openapi_spec_hash: fc92550089eb09bd802e4178bbde83c0 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-57f28dde4f89132b3ad99235eb8940391a3f6756c2fd0eafe4e2a0615aa32d50.yml +openapi_spec_hash: d7771a48eb4480cb0868d3af901fe360 config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 From d9c7d93d783cb373b59cc025fb22b3ba1a64df00 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sun, 12 Apr 2026 21:16:38 +0000 Subject: [PATCH 09/82] codegen metadata --- .stats.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.stats.yml b/.stats.yml index b49f2b4..2eee2ea 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 20 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-57f28dde4f89132b3ad99235eb8940391a3f6756c2fd0eafe4e2a0615aa32d50.yml -openapi_spec_hash: d7771a48eb4480cb0868d3af901fe360 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-4876a8799d99d7b497a352f6b873e53cff8b98019d4070e65fd272eed87ccda4.yml +openapi_spec_hash: c095133c2695510842b84cf5820a16a4 config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 From 3613e92029d5702a7b86753162c3dddda5ef88d2 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 16 Apr 2026 14:43:17 +0000 Subject: [PATCH 10/82] feat(api): api update --- .stats.yml | 4 +- .../models/brand_styleguide_response.rb | 70 ++++++++- .../models/brand_styleguide_response.rbi | 138 ++++++++++++++++++ .../models/brand_styleguide_response.rbs | 52 +++++++ 4 files changed, 261 insertions(+), 3 deletions(-) diff --git a/.stats.yml b/.stats.yml index 2eee2ea..9b7576d 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 20 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-4876a8799d99d7b497a352f6b873e53cff8b98019d4070e65fd272eed87ccda4.yml -openapi_spec_hash: c095133c2695510842b84cf5820a16a4 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-e7d0d9b555ca50f58e651f918238ee1329755f46cb962feaedec097be4c28d83.yml +openapi_spec_hash: b187dde21c352dd66cf249fbc14dd0b4 config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 diff --git a/lib/brand_dev/models/brand_styleguide_response.rb b/lib/brand_dev/models/brand_styleguide_response.rb index 3dd6496..0bd706b 100644 --- a/lib/brand_dev/models/brand_styleguide_response.rb +++ b/lib/brand_dev/models/brand_styleguide_response.rb @@ -59,6 +59,16 @@ class Styleguide < BrandDev::Internal::Type::BaseModel -> { BrandDev::Models::BrandStyleguideResponse::Styleguide::ElementSpacing }, api_name: :elementSpacing + # @!attribute font_links + # Font assets keyed by family name as it appears in fontFamily/fontFallbacks + # (non-generic names only). Clients match typography.fontFamily / fontWeight or + # button styles to pick a file URL from files. + # + # @return [Hash{Symbol=>BrandDev::Models::BrandStyleguideResponse::Styleguide::FontLink}] + required :font_links, + -> { BrandDev::Internal::Type::HashOf[BrandDev::Models::BrandStyleguideResponse::Styleguide::FontLink] }, + api_name: :fontLinks + # @!attribute mode # The primary color mode of the website design # @@ -77,7 +87,10 @@ class Styleguide < BrandDev::Internal::Type::BaseModel # @return [BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography] required :typography, -> { BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography } - # @!method initialize(colors:, components:, element_spacing:, mode:, shadows:, typography:) + # @!method initialize(colors:, components:, element_spacing:, font_links:, mode:, shadows:, typography:) + # Some parameter documentations has been truncated, see + # {BrandDev::Models::BrandStyleguideResponse::Styleguide} for more details. + # # Comprehensive styleguide data extracted from the website # # @param colors [BrandDev::Models::BrandStyleguideResponse::Styleguide::Colors] Primary colors used on the website @@ -86,6 +99,8 @@ class Styleguide < BrandDev::Internal::Type::BaseModel # # @param element_spacing [BrandDev::Models::BrandStyleguideResponse::Styleguide::ElementSpacing] Spacing system used on the website # + # @param font_links [Hash{Symbol=>BrandDev::Models::BrandStyleguideResponse::Styleguide::FontLink}] Font assets keyed by family name as it appears in fontFamily/fontFallbacks (non- + # # @param mode [Symbol, BrandDev::Models::BrandStyleguideResponse::Styleguide::Mode] The primary color mode of the website design # # @param shadows [BrandDev::Models::BrandStyleguideResponse::Styleguide::Shadows] Shadow styles used on the website @@ -692,6 +707,59 @@ class ElementSpacing < BrandDev::Internal::Type::BaseModel # @param xs [String] end + class FontLink < BrandDev::Internal::Type::BaseModel + # @!attribute files + # Upright font files keyed by weight string (e.g. "400" for regular, "500", + # "700"). Values are absolute URLs. + # + # @return [Hash{Symbol=>String}] + required :files, BrandDev::Internal::Type::HashOf[String] + + # @!attribute type + # + # @return [Symbol, BrandDev::Models::BrandStyleguideResponse::Styleguide::FontLink::Type] + required :type, enum: -> { BrandDev::Models::BrandStyleguideResponse::Styleguide::FontLink::Type } + + # @!attribute category + # Google Fonts category when type is google (e.g. sans-serif, serif, monospace, + # display, handwriting). Omitted for custom fonts when unknown. + # + # @return [String, nil] + optional :category, String + + # @!attribute display_name + # Present when type is custom: human-readable name derived from the fontLinks key + # (strip build/hash suffixes, split camelCase / PascalCase, normalize separators). + # Google entries omit this. + # + # @return [String, nil] + optional :display_name, String, api_name: :displayName + + # @!method initialize(files:, type:, category: nil, display_name: nil) + # Some parameter documentations has been truncated, see + # {BrandDev::Models::BrandStyleguideResponse::Styleguide::FontLink} for more + # details. + # + # @param files [Hash{Symbol=>String}] Upright font files keyed by weight string (e.g. "400" for regular, "500", "700") + # + # @param type [Symbol, BrandDev::Models::BrandStyleguideResponse::Styleguide::FontLink::Type] + # + # @param category [String] Google Fonts category when type is google (e.g. sans-serif, serif, monospace, di + # + # @param display_name [String] Present when type is custom: human-readable name derived from the fontLinks key + + # @see BrandDev::Models::BrandStyleguideResponse::Styleguide::FontLink#type + module Type + extend BrandDev::Internal::Type::Enum + + GOOGLE = :google + CUSTOM = :custom + + # @!method self.values + # @return [Array] + end + end + # The primary color mode of the website design # # @see BrandDev::Models::BrandStyleguideResponse::Styleguide#mode diff --git a/rbi/brand_dev/models/brand_styleguide_response.rbi b/rbi/brand_dev/models/brand_styleguide_response.rbi index 7b8bfda..a2058a7 100644 --- a/rbi/brand_dev/models/brand_styleguide_response.rbi +++ b/rbi/brand_dev/models/brand_styleguide_response.rbi @@ -137,6 +137,19 @@ module BrandDev end attr_writer :element_spacing + # Font assets keyed by family name as it appears in fontFamily/fontFallbacks + # (non-generic names only). Clients match typography.fontFamily / fontWeight or + # button styles to pick a file URL from files. + sig do + returns( + T::Hash[ + Symbol, + BrandDev::Models::BrandStyleguideResponse::Styleguide::FontLink + ] + ) + end + attr_accessor :font_links + # The primary color mode of the website design sig do returns( @@ -186,6 +199,11 @@ module BrandDev BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::OrHash, element_spacing: BrandDev::Models::BrandStyleguideResponse::Styleguide::ElementSpacing::OrHash, + font_links: + T::Hash[ + Symbol, + BrandDev::Models::BrandStyleguideResponse::Styleguide::FontLink::OrHash + ], mode: BrandDev::Models::BrandStyleguideResponse::Styleguide::Mode::OrSymbol, shadows: @@ -201,6 +219,10 @@ module BrandDev components:, # Spacing system used on the website element_spacing:, + # Font assets keyed by family name as it appears in fontFamily/fontFallbacks + # (non-generic names only). Clients match typography.fontFamily / fontWeight or + # button styles to pick a file URL from files. + font_links:, # The primary color mode of the website design mode:, # Shadow styles used on the website @@ -219,6 +241,11 @@ module BrandDev BrandDev::Models::BrandStyleguideResponse::Styleguide::Components, element_spacing: BrandDev::Models::BrandStyleguideResponse::Styleguide::ElementSpacing, + font_links: + T::Hash[ + Symbol, + BrandDev::Models::BrandStyleguideResponse::Styleguide::FontLink + ], mode: BrandDev::Models::BrandStyleguideResponse::Styleguide::Mode::TaggedSymbol, shadows: @@ -1043,6 +1070,117 @@ module BrandDev end end + class FontLink < BrandDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + BrandDev::Models::BrandStyleguideResponse::Styleguide::FontLink, + BrandDev::Internal::AnyHash + ) + end + + # Upright font files keyed by weight string (e.g. "400" for regular, "500", + # "700"). Values are absolute URLs. + sig { returns(T::Hash[Symbol, String]) } + attr_accessor :files + + sig do + returns( + BrandDev::Models::BrandStyleguideResponse::Styleguide::FontLink::Type::TaggedSymbol + ) + end + attr_accessor :type + + # Google Fonts category when type is google (e.g. sans-serif, serif, monospace, + # display, handwriting). Omitted for custom fonts when unknown. + sig { returns(T.nilable(String)) } + attr_reader :category + + sig { params(category: String).void } + attr_writer :category + + # Present when type is custom: human-readable name derived from the fontLinks key + # (strip build/hash suffixes, split camelCase / PascalCase, normalize separators). + # Google entries omit this. + sig { returns(T.nilable(String)) } + attr_reader :display_name + + sig { params(display_name: String).void } + attr_writer :display_name + + sig do + params( + files: T::Hash[Symbol, String], + type: + BrandDev::Models::BrandStyleguideResponse::Styleguide::FontLink::Type::OrSymbol, + category: String, + display_name: String + ).returns(T.attached_class) + end + def self.new( + # Upright font files keyed by weight string (e.g. "400" for regular, "500", + # "700"). Values are absolute URLs. + files:, + type:, + # Google Fonts category when type is google (e.g. sans-serif, serif, monospace, + # display, handwriting). Omitted for custom fonts when unknown. + category: nil, + # Present when type is custom: human-readable name derived from the fontLinks key + # (strip build/hash suffixes, split camelCase / PascalCase, normalize separators). + # Google entries omit this. + display_name: nil + ) + end + + sig do + override.returns( + { + files: T::Hash[Symbol, String], + type: + BrandDev::Models::BrandStyleguideResponse::Styleguide::FontLink::Type::TaggedSymbol, + category: String, + display_name: String + } + ) + end + def to_hash + end + + module Type + extend BrandDev::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + BrandDev::Models::BrandStyleguideResponse::Styleguide::FontLink::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + GOOGLE = + T.let( + :google, + BrandDev::Models::BrandStyleguideResponse::Styleguide::FontLink::Type::TaggedSymbol + ) + CUSTOM = + T.let( + :custom, + BrandDev::Models::BrandStyleguideResponse::Styleguide::FontLink::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + BrandDev::Models::BrandStyleguideResponse::Styleguide::FontLink::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + end + # The primary color mode of the website design module Mode extend BrandDev::Internal::Type::Enum diff --git a/sig/brand_dev/models/brand_styleguide_response.rbs b/sig/brand_dev/models/brand_styleguide_response.rbs index 185b941..42650de 100644 --- a/sig/brand_dev/models/brand_styleguide_response.rbs +++ b/sig/brand_dev/models/brand_styleguide_response.rbs @@ -46,6 +46,7 @@ module BrandDev colors: BrandDev::Models::BrandStyleguideResponse::Styleguide::Colors, components: BrandDev::Models::BrandStyleguideResponse::Styleguide::Components, element_spacing: BrandDev::Models::BrandStyleguideResponse::Styleguide::ElementSpacing, + font_links: ::Hash[Symbol, BrandDev::Models::BrandStyleguideResponse::Styleguide::FontLink], mode: BrandDev::Models::BrandStyleguideResponse::Styleguide::mode, shadows: BrandDev::Models::BrandStyleguideResponse::Styleguide::Shadows, typography: BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography @@ -58,6 +59,8 @@ module BrandDev attr_accessor element_spacing: BrandDev::Models::BrandStyleguideResponse::Styleguide::ElementSpacing + attr_accessor font_links: ::Hash[Symbol, BrandDev::Models::BrandStyleguideResponse::Styleguide::FontLink] + attr_accessor mode: BrandDev::Models::BrandStyleguideResponse::Styleguide::mode attr_accessor shadows: BrandDev::Models::BrandStyleguideResponse::Styleguide::Shadows @@ -68,6 +71,7 @@ module BrandDev colors: BrandDev::Models::BrandStyleguideResponse::Styleguide::Colors, components: BrandDev::Models::BrandStyleguideResponse::Styleguide::Components, element_spacing: BrandDev::Models::BrandStyleguideResponse::Styleguide::ElementSpacing, + font_links: ::Hash[Symbol, BrandDev::Models::BrandStyleguideResponse::Styleguide::FontLink], mode: BrandDev::Models::BrandStyleguideResponse::Styleguide::mode, shadows: BrandDev::Models::BrandStyleguideResponse::Styleguide::Shadows, typography: BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography @@ -77,6 +81,7 @@ module BrandDev colors: BrandDev::Models::BrandStyleguideResponse::Styleguide::Colors, components: BrandDev::Models::BrandStyleguideResponse::Styleguide::Components, element_spacing: BrandDev::Models::BrandStyleguideResponse::Styleguide::ElementSpacing, + font_links: ::Hash[Symbol, BrandDev::Models::BrandStyleguideResponse::Styleguide::FontLink], mode: BrandDev::Models::BrandStyleguideResponse::Styleguide::mode, shadows: BrandDev::Models::BrandStyleguideResponse::Styleguide::Shadows, typography: BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography @@ -562,6 +567,53 @@ module BrandDev } end + type font_link = + { + files: ::Hash[Symbol, String], + type: BrandDev::Models::BrandStyleguideResponse::Styleguide::FontLink::type_, + category: String, + display_name: String + } + + class FontLink < BrandDev::Internal::Type::BaseModel + attr_accessor files: ::Hash[Symbol, String] + + attr_accessor type: BrandDev::Models::BrandStyleguideResponse::Styleguide::FontLink::type_ + + attr_reader category: String? + + def category=: (String) -> String + + attr_reader display_name: String? + + def display_name=: (String) -> String + + def initialize: ( + files: ::Hash[Symbol, String], + type: BrandDev::Models::BrandStyleguideResponse::Styleguide::FontLink::type_, + ?category: String, + ?display_name: String + ) -> void + + def to_hash: -> { + files: ::Hash[Symbol, String], + type: BrandDev::Models::BrandStyleguideResponse::Styleguide::FontLink::type_, + category: String, + display_name: String + } + + type type_ = :google | :custom + + module Type + extend BrandDev::Internal::Type::Enum + + GOOGLE: :google + CUSTOM: :custom + + def self?.values: -> ::Array[BrandDev::Models::BrandStyleguideResponse::Styleguide::FontLink::type_] + end + end + type mode = :light | :dark module Mode From fdc741818cf6202016e5b94278590f8d1aa44079 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 17 Apr 2026 01:19:45 +0000 Subject: [PATCH 11/82] feat(api): api update --- .stats.yml | 4 ++-- .../models/brand_web_scrape_html_params.rb | 15 +++++++++++++- .../models/brand_web_scrape_md_params.rb | 12 ++++++++++- lib/brand_dev/resources/brand.rb | 14 ++++++++++--- .../models/brand_web_scrape_html_params.rbi | 20 ++++++++++++++++++- .../models/brand_web_scrape_md_params.rbi | 15 ++++++++++++++ rbi/brand_dev/resources/brand.rbi | 10 ++++++++++ .../models/brand_web_scrape_html_params.rbs | 14 +++++++++++-- .../models/brand_web_scrape_md_params.rbs | 7 +++++++ sig/brand_dev/resources/brand.rbs | 2 ++ 10 files changed, 103 insertions(+), 10 deletions(-) diff --git a/.stats.yml b/.stats.yml index 9b7576d..41aba4a 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 20 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-e7d0d9b555ca50f58e651f918238ee1329755f46cb962feaedec097be4c28d83.yml -openapi_spec_hash: b187dde21c352dd66cf249fbc14dd0b4 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-4bc00d073aa6c38b3299c9fc2e197ba9e25df5defca2508a0a0c83bf08237b00.yml +openapi_spec_hash: b68c73667402fd727825555413522ce6 config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 diff --git a/lib/brand_dev/models/brand_web_scrape_html_params.rb b/lib/brand_dev/models/brand_web_scrape_html_params.rb index 764275a..60aa4d7 100644 --- a/lib/brand_dev/models/brand_web_scrape_html_params.rb +++ b/lib/brand_dev/models/brand_web_scrape_html_params.rb @@ -13,9 +13,22 @@ class BrandWebScrapeHTMLParams < BrandDev::Internal::Type::BaseModel # @return [String] required :url, String - # @!method initialize(url:, request_options: {}) + # @!attribute max_age_ms + # Return a cached result if a prior scrape for the same parameters exists and is + # younger than this many milliseconds. Defaults to 1 day (86400000 ms) when + # omitted. Set to 0 to always scrape fresh. + # + # @return [Integer, nil] + optional :max_age_ms, Integer + + # @!method initialize(url:, max_age_ms: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {BrandDev::Models::BrandWebScrapeHTMLParams} for more details. + # # @param url [String] Full URL to scrape (must include http:// or https:// protocol) # + # @param max_age_ms [Integer] Return a cached result if a prior scrape for the same parameters exists and is y + # # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/brand_dev/models/brand_web_scrape_md_params.rb b/lib/brand_dev/models/brand_web_scrape_md_params.rb index 1159be5..a6f16fa 100644 --- a/lib/brand_dev/models/brand_web_scrape_md_params.rb +++ b/lib/brand_dev/models/brand_web_scrape_md_params.rb @@ -26,6 +26,14 @@ class BrandWebScrapeMdParams < BrandDev::Internal::Type::BaseModel # @return [Boolean, nil] optional :include_links, BrandDev::Internal::Type::Boolean + # @!attribute max_age_ms + # Return a cached result if a prior scrape for the same parameters exists and is + # younger than this many milliseconds. Defaults to 1 day (86400000 ms) when + # omitted. Set to 0 to always scrape fresh. + # + # @return [Integer, nil] + optional :max_age_ms, Integer + # @!attribute shorten_base64_images # Shorten base64-encoded image data in the Markdown output # @@ -39,7 +47,7 @@ class BrandWebScrapeMdParams < BrandDev::Internal::Type::BaseModel # @return [Boolean, nil] optional :use_main_content_only, BrandDev::Internal::Type::Boolean - # @!method initialize(url:, include_images: nil, include_links: nil, shorten_base64_images: nil, use_main_content_only: nil, request_options: {}) + # @!method initialize(url:, include_images: nil, include_links: nil, max_age_ms: nil, shorten_base64_images: nil, use_main_content_only: nil, request_options: {}) # Some parameter documentations has been truncated, see # {BrandDev::Models::BrandWebScrapeMdParams} for more details. # @@ -49,6 +57,8 @@ class BrandWebScrapeMdParams < BrandDev::Internal::Type::BaseModel # # @param include_links [Boolean] Preserve hyperlinks in Markdown output # + # @param max_age_ms [Integer] Return a cached result if a prior scrape for the same parameters exists and is y + # # @param shorten_base64_images [Boolean] Shorten base64-encoded image data in the Markdown output # # @param use_main_content_only [Boolean] Extract only the main content of the page, excluding headers, footers, sidebars, diff --git a/lib/brand_dev/resources/brand.rb b/lib/brand_dev/resources/brand.rb index 6b54f98..dc70b2f 100644 --- a/lib/brand_dev/resources/brand.rb +++ b/lib/brand_dev/resources/brand.rb @@ -531,12 +531,17 @@ def styleguide(params = {}) ) end + # Some parameter documentations has been truncated, see + # {BrandDev::Models::BrandWebScrapeHTMLParams} for more details. + # # Scrapes the given URL and returns the raw HTML content of the page. # - # @overload web_scrape_html(url:, request_options: {}) + # @overload web_scrape_html(url:, max_age_ms: nil, request_options: {}) # # @param url [String] Full URL to scrape (must include http:// or https:// protocol) # + # @param max_age_ms [Integer] Return a cached result if a prior scrape for the same parameters exists and is y + # # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [BrandDev::Models::BrandWebScrapeHTMLResponse] @@ -548,7 +553,7 @@ def web_scrape_html(params) @client.request( method: :get, path: "web/scrape/html", - query: query, + query: query.transform_keys(max_age_ms: "maxAgeMs"), model: BrandDev::Models::BrandWebScrapeHTMLResponse, options: options ) @@ -585,7 +590,7 @@ def web_scrape_images(params) # Scrapes the given URL, converts the HTML content to Markdown, and returns the # result. # - # @overload web_scrape_md(url:, include_images: nil, include_links: nil, shorten_base64_images: nil, use_main_content_only: nil, request_options: {}) + # @overload web_scrape_md(url:, include_images: nil, include_links: nil, max_age_ms: nil, shorten_base64_images: nil, use_main_content_only: nil, request_options: {}) # # @param url [String] Full URL to scrape and convert to markdown (must include http:// or https:// pro # @@ -593,6 +598,8 @@ def web_scrape_images(params) # # @param include_links [Boolean] Preserve hyperlinks in Markdown output # + # @param max_age_ms [Integer] Return a cached result if a prior scrape for the same parameters exists and is y + # # @param shorten_base64_images [Boolean] Shorten base64-encoded image data in the Markdown output # # @param use_main_content_only [Boolean] Extract only the main content of the page, excluding headers, footers, sidebars, @@ -611,6 +618,7 @@ def web_scrape_md(params) query: query.transform_keys( include_images: "includeImages", include_links: "includeLinks", + max_age_ms: "maxAgeMs", shorten_base64_images: "shortenBase64Images", use_main_content_only: "useMainContentOnly" ), diff --git a/rbi/brand_dev/models/brand_web_scrape_html_params.rbi b/rbi/brand_dev/models/brand_web_scrape_html_params.rbi index 042cf8b..ade7d3a 100644 --- a/rbi/brand_dev/models/brand_web_scrape_html_params.rbi +++ b/rbi/brand_dev/models/brand_web_scrape_html_params.rbi @@ -15,22 +15,40 @@ module BrandDev sig { returns(String) } attr_accessor :url + # Return a cached result if a prior scrape for the same parameters exists and is + # younger than this many milliseconds. Defaults to 1 day (86400000 ms) when + # omitted. Set to 0 to always scrape fresh. + sig { returns(T.nilable(Integer)) } + attr_reader :max_age_ms + + sig { params(max_age_ms: Integer).void } + attr_writer :max_age_ms + sig do params( url: String, + max_age_ms: Integer, request_options: BrandDev::RequestOptions::OrHash ).returns(T.attached_class) end def self.new( # Full URL to scrape (must include http:// or https:// protocol) url:, + # Return a cached result if a prior scrape for the same parameters exists and is + # younger than this many milliseconds. Defaults to 1 day (86400000 ms) when + # omitted. Set to 0 to always scrape fresh. + max_age_ms: nil, request_options: {} ) end sig do override.returns( - { url: String, request_options: BrandDev::RequestOptions } + { + url: String, + max_age_ms: Integer, + request_options: BrandDev::RequestOptions + } ) end def to_hash diff --git a/rbi/brand_dev/models/brand_web_scrape_md_params.rbi b/rbi/brand_dev/models/brand_web_scrape_md_params.rbi index 8f945d2..fd9db9c 100644 --- a/rbi/brand_dev/models/brand_web_scrape_md_params.rbi +++ b/rbi/brand_dev/models/brand_web_scrape_md_params.rbi @@ -30,6 +30,15 @@ module BrandDev sig { params(include_links: T::Boolean).void } attr_writer :include_links + # Return a cached result if a prior scrape for the same parameters exists and is + # younger than this many milliseconds. Defaults to 1 day (86400000 ms) when + # omitted. Set to 0 to always scrape fresh. + sig { returns(T.nilable(Integer)) } + attr_reader :max_age_ms + + sig { params(max_age_ms: Integer).void } + attr_writer :max_age_ms + # Shorten base64-encoded image data in the Markdown output sig { returns(T.nilable(T::Boolean)) } attr_reader :shorten_base64_images @@ -50,6 +59,7 @@ module BrandDev url: String, include_images: T::Boolean, include_links: T::Boolean, + max_age_ms: Integer, shorten_base64_images: T::Boolean, use_main_content_only: T::Boolean, request_options: BrandDev::RequestOptions::OrHash @@ -63,6 +73,10 @@ module BrandDev include_images: nil, # Preserve hyperlinks in Markdown output include_links: nil, + # Return a cached result if a prior scrape for the same parameters exists and is + # younger than this many milliseconds. Defaults to 1 day (86400000 ms) when + # omitted. Set to 0 to always scrape fresh. + max_age_ms: nil, # Shorten base64-encoded image data in the Markdown output shorten_base64_images: nil, # Extract only the main content of the page, excluding headers, footers, sidebars, @@ -78,6 +92,7 @@ module BrandDev url: String, include_images: T::Boolean, include_links: T::Boolean, + max_age_ms: Integer, shorten_base64_images: T::Boolean, use_main_content_only: T::Boolean, request_options: BrandDev::RequestOptions diff --git a/rbi/brand_dev/resources/brand.rbi b/rbi/brand_dev/resources/brand.rbi index 184f754..36b1529 100644 --- a/rbi/brand_dev/resources/brand.rbi +++ b/rbi/brand_dev/resources/brand.rbi @@ -470,12 +470,17 @@ module BrandDev sig do params( url: String, + max_age_ms: Integer, request_options: BrandDev::RequestOptions::OrHash ).returns(BrandDev::Models::BrandWebScrapeHTMLResponse) end def web_scrape_html( # Full URL to scrape (must include http:// or https:// protocol) url:, + # Return a cached result if a prior scrape for the same parameters exists and is + # younger than this many milliseconds. Defaults to 1 day (86400000 ms) when + # omitted. Set to 0 to always scrape fresh. + max_age_ms: nil, request_options: {} ) end @@ -503,6 +508,7 @@ module BrandDev url: String, include_images: T::Boolean, include_links: T::Boolean, + max_age_ms: Integer, shorten_base64_images: T::Boolean, use_main_content_only: T::Boolean, request_options: BrandDev::RequestOptions::OrHash @@ -516,6 +522,10 @@ module BrandDev include_images: nil, # Preserve hyperlinks in Markdown output include_links: nil, + # Return a cached result if a prior scrape for the same parameters exists and is + # younger than this many milliseconds. Defaults to 1 day (86400000 ms) when + # omitted. Set to 0 to always scrape fresh. + max_age_ms: nil, # Shorten base64-encoded image data in the Markdown output shorten_base64_images: nil, # Extract only the main content of the page, excluding headers, footers, sidebars, diff --git a/sig/brand_dev/models/brand_web_scrape_html_params.rbs b/sig/brand_dev/models/brand_web_scrape_html_params.rbs index 08c18fb..200fd52 100644 --- a/sig/brand_dev/models/brand_web_scrape_html_params.rbs +++ b/sig/brand_dev/models/brand_web_scrape_html_params.rbs @@ -1,7 +1,8 @@ module BrandDev module Models type brand_web_scrape_html_params = - { url: String } & BrandDev::Internal::Type::request_parameters + { url: String, max_age_ms: Integer } + & BrandDev::Internal::Type::request_parameters class BrandWebScrapeHTMLParams < BrandDev::Internal::Type::BaseModel extend BrandDev::Internal::Type::RequestParameters::Converter @@ -9,12 +10,21 @@ module BrandDev attr_accessor url: String + attr_reader max_age_ms: Integer? + + def max_age_ms=: (Integer) -> Integer + def initialize: ( url: String, + ?max_age_ms: Integer, ?request_options: BrandDev::request_opts ) -> void - def to_hash: -> { url: String, request_options: BrandDev::RequestOptions } + def to_hash: -> { + url: String, + max_age_ms: Integer, + request_options: BrandDev::RequestOptions + } end end end diff --git a/sig/brand_dev/models/brand_web_scrape_md_params.rbs b/sig/brand_dev/models/brand_web_scrape_md_params.rbs index 9db0c0c..310ad33 100644 --- a/sig/brand_dev/models/brand_web_scrape_md_params.rbs +++ b/sig/brand_dev/models/brand_web_scrape_md_params.rbs @@ -5,6 +5,7 @@ module BrandDev url: String, include_images: bool, include_links: bool, + max_age_ms: Integer, :shorten_base64_images => bool, use_main_content_only: bool } @@ -24,6 +25,10 @@ module BrandDev def include_links=: (bool) -> bool + attr_reader max_age_ms: Integer? + + def max_age_ms=: (Integer) -> Integer + attr_reader shorten_base64_images: bool? def shorten_base64_images=: (bool) -> bool @@ -36,6 +41,7 @@ module BrandDev url: String, ?include_images: bool, ?include_links: bool, + ?max_age_ms: Integer, ?shorten_base64_images: bool, ?use_main_content_only: bool, ?request_options: BrandDev::request_opts @@ -45,6 +51,7 @@ module BrandDev url: String, include_images: bool, include_links: bool, + max_age_ms: Integer, :shorten_base64_images => bool, use_main_content_only: bool, request_options: BrandDev::RequestOptions diff --git a/sig/brand_dev/resources/brand.rbs b/sig/brand_dev/resources/brand.rbs index ac3bf63..2833849 100644 --- a/sig/brand_dev/resources/brand.rbs +++ b/sig/brand_dev/resources/brand.rbs @@ -125,6 +125,7 @@ module BrandDev def web_scrape_html: ( url: String, + ?max_age_ms: Integer, ?request_options: BrandDev::request_opts ) -> BrandDev::Models::BrandWebScrapeHTMLResponse @@ -137,6 +138,7 @@ module BrandDev url: String, ?include_images: bool, ?include_links: bool, + ?max_age_ms: Integer, ?shorten_base64_images: bool, ?use_main_content_only: bool, ?request_options: BrandDev::request_opts From 7dbc953284d17ffdab94cc0cce1c1577bb5bb37d Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 17 Apr 2026 01:36:14 +0000 Subject: [PATCH 12/82] feat(api): api update --- .stats.yml | 4 ++-- lib/brand_dev/models/brand_web_scrape_html_params.rb | 2 +- rbi/brand_dev/models/brand_web_scrape_html_params.rbi | 4 ++-- rbi/brand_dev/resources/brand.rbi | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/.stats.yml b/.stats.yml index 41aba4a..4caa3eb 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 20 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-4bc00d073aa6c38b3299c9fc2e197ba9e25df5defca2508a0a0c83bf08237b00.yml -openapi_spec_hash: b68c73667402fd727825555413522ce6 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-f15e63fe284d980e63fbbba5b3f845f91565f43e4c0b3182bb5d8bd55fda2a51.yml +openapi_spec_hash: 5f833c91cc4541722b10451a4629c1bc config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 diff --git a/lib/brand_dev/models/brand_web_scrape_html_params.rb b/lib/brand_dev/models/brand_web_scrape_html_params.rb index 60aa4d7..30471ae 100644 --- a/lib/brand_dev/models/brand_web_scrape_html_params.rb +++ b/lib/brand_dev/models/brand_web_scrape_html_params.rb @@ -16,7 +16,7 @@ class BrandWebScrapeHTMLParams < BrandDev::Internal::Type::BaseModel # @!attribute max_age_ms # Return a cached result if a prior scrape for the same parameters exists and is # younger than this many milliseconds. Defaults to 1 day (86400000 ms) when - # omitted. Set to 0 to always scrape fresh. + # omitted. Max is 30 days (2592000000 ms). Set to 0 to always scrape fresh. # # @return [Integer, nil] optional :max_age_ms, Integer diff --git a/rbi/brand_dev/models/brand_web_scrape_html_params.rbi b/rbi/brand_dev/models/brand_web_scrape_html_params.rbi index ade7d3a..e7fd002 100644 --- a/rbi/brand_dev/models/brand_web_scrape_html_params.rbi +++ b/rbi/brand_dev/models/brand_web_scrape_html_params.rbi @@ -17,7 +17,7 @@ module BrandDev # Return a cached result if a prior scrape for the same parameters exists and is # younger than this many milliseconds. Defaults to 1 day (86400000 ms) when - # omitted. Set to 0 to always scrape fresh. + # omitted. Max is 30 days (2592000000 ms). Set to 0 to always scrape fresh. sig { returns(T.nilable(Integer)) } attr_reader :max_age_ms @@ -36,7 +36,7 @@ module BrandDev url:, # Return a cached result if a prior scrape for the same parameters exists and is # younger than this many milliseconds. Defaults to 1 day (86400000 ms) when - # omitted. Set to 0 to always scrape fresh. + # omitted. Max is 30 days (2592000000 ms). Set to 0 to always scrape fresh. max_age_ms: nil, request_options: {} ) diff --git a/rbi/brand_dev/resources/brand.rbi b/rbi/brand_dev/resources/brand.rbi index 36b1529..6911023 100644 --- a/rbi/brand_dev/resources/brand.rbi +++ b/rbi/brand_dev/resources/brand.rbi @@ -479,7 +479,7 @@ module BrandDev url:, # Return a cached result if a prior scrape for the same parameters exists and is # younger than this many milliseconds. Defaults to 1 day (86400000 ms) when - # omitted. Set to 0 to always scrape fresh. + # omitted. Max is 30 days (2592000000 ms). Set to 0 to always scrape fresh. max_age_ms: nil, request_options: {} ) From d7243b67c34ed41991ffbfd05c20c3fe91bf6b7a Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 17 Apr 2026 01:44:38 +0000 Subject: [PATCH 13/82] feat(api): api update --- .stats.yml | 4 ++-- lib/brand_dev/models/brand_web_scrape_md_params.rb | 6 +++--- lib/brand_dev/resources/brand.rb | 5 ++--- rbi/brand_dev/models/brand_web_scrape_md_params.rbi | 8 ++++---- rbi/brand_dev/resources/brand.rbi | 7 +++---- 5 files changed, 14 insertions(+), 16 deletions(-) diff --git a/.stats.yml b/.stats.yml index 4caa3eb..792fcdf 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 20 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-f15e63fe284d980e63fbbba5b3f845f91565f43e4c0b3182bb5d8bd55fda2a51.yml -openapi_spec_hash: 5f833c91cc4541722b10451a4629c1bc +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-93cf699701172f25e4f6d5053b0573eeb51a79707de94a137ac23d0aaeb76e36.yml +openapi_spec_hash: 4abd14fccd70b0cb0397776e6b5b9171 config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 diff --git a/lib/brand_dev/models/brand_web_scrape_md_params.rb b/lib/brand_dev/models/brand_web_scrape_md_params.rb index a6f16fa..ab2fb8e 100644 --- a/lib/brand_dev/models/brand_web_scrape_md_params.rb +++ b/lib/brand_dev/models/brand_web_scrape_md_params.rb @@ -8,7 +8,7 @@ class BrandWebScrapeMdParams < BrandDev::Internal::Type::BaseModel include BrandDev::Internal::Type::RequestParameters # @!attribute url - # Full URL to scrape and convert to markdown (must include http:// or https:// + # Full URL to scrape into LLM usable Markdown (must include http:// or https:// # protocol) # # @return [String] @@ -29,7 +29,7 @@ class BrandWebScrapeMdParams < BrandDev::Internal::Type::BaseModel # @!attribute max_age_ms # Return a cached result if a prior scrape for the same parameters exists and is # younger than this many milliseconds. Defaults to 1 day (86400000 ms) when - # omitted. Set to 0 to always scrape fresh. + # omitted. Max is 30 days (2592000000 ms). Set to 0 to always scrape fresh. # # @return [Integer, nil] optional :max_age_ms, Integer @@ -51,7 +51,7 @@ class BrandWebScrapeMdParams < BrandDev::Internal::Type::BaseModel # Some parameter documentations has been truncated, see # {BrandDev::Models::BrandWebScrapeMdParams} for more details. # - # @param url [String] Full URL to scrape and convert to markdown (must include http:// or https:// pro + # @param url [String] Full URL to scrape into LLM usable Markdown (must include http:// or https:// pr # # @param include_images [Boolean] Include image references in Markdown output # diff --git a/lib/brand_dev/resources/brand.rb b/lib/brand_dev/resources/brand.rb index dc70b2f..4dbc495 100644 --- a/lib/brand_dev/resources/brand.rb +++ b/lib/brand_dev/resources/brand.rb @@ -587,12 +587,11 @@ def web_scrape_images(params) # Some parameter documentations has been truncated, see # {BrandDev::Models::BrandWebScrapeMdParams} for more details. # - # Scrapes the given URL, converts the HTML content to Markdown, and returns the - # result. + # Scrapes the given URL into LLM usable Markdown. # # @overload web_scrape_md(url:, include_images: nil, include_links: nil, max_age_ms: nil, shorten_base64_images: nil, use_main_content_only: nil, request_options: {}) # - # @param url [String] Full URL to scrape and convert to markdown (must include http:// or https:// pro + # @param url [String] Full URL to scrape into LLM usable Markdown (must include http:// or https:// pr # # @param include_images [Boolean] Include image references in Markdown output # diff --git a/rbi/brand_dev/models/brand_web_scrape_md_params.rbi b/rbi/brand_dev/models/brand_web_scrape_md_params.rbi index fd9db9c..98df987 100644 --- a/rbi/brand_dev/models/brand_web_scrape_md_params.rbi +++ b/rbi/brand_dev/models/brand_web_scrape_md_params.rbi @@ -11,7 +11,7 @@ module BrandDev T.any(BrandDev::BrandWebScrapeMdParams, BrandDev::Internal::AnyHash) end - # Full URL to scrape and convert to markdown (must include http:// or https:// + # Full URL to scrape into LLM usable Markdown (must include http:// or https:// # protocol) sig { returns(String) } attr_accessor :url @@ -32,7 +32,7 @@ module BrandDev # Return a cached result if a prior scrape for the same parameters exists and is # younger than this many milliseconds. Defaults to 1 day (86400000 ms) when - # omitted. Set to 0 to always scrape fresh. + # omitted. Max is 30 days (2592000000 ms). Set to 0 to always scrape fresh. sig { returns(T.nilable(Integer)) } attr_reader :max_age_ms @@ -66,7 +66,7 @@ module BrandDev ).returns(T.attached_class) end def self.new( - # Full URL to scrape and convert to markdown (must include http:// or https:// + # Full URL to scrape into LLM usable Markdown (must include http:// or https:// # protocol) url:, # Include image references in Markdown output @@ -75,7 +75,7 @@ module BrandDev include_links: nil, # Return a cached result if a prior scrape for the same parameters exists and is # younger than this many milliseconds. Defaults to 1 day (86400000 ms) when - # omitted. Set to 0 to always scrape fresh. + # omitted. Max is 30 days (2592000000 ms). Set to 0 to always scrape fresh. max_age_ms: nil, # Shorten base64-encoded image data in the Markdown output shorten_base64_images: nil, diff --git a/rbi/brand_dev/resources/brand.rbi b/rbi/brand_dev/resources/brand.rbi index 6911023..95fe7f8 100644 --- a/rbi/brand_dev/resources/brand.rbi +++ b/rbi/brand_dev/resources/brand.rbi @@ -501,8 +501,7 @@ module BrandDev ) end - # Scrapes the given URL, converts the HTML content to Markdown, and returns the - # result. + # Scrapes the given URL into LLM usable Markdown. sig do params( url: String, @@ -515,7 +514,7 @@ module BrandDev ).returns(BrandDev::Models::BrandWebScrapeMdResponse) end def web_scrape_md( - # Full URL to scrape and convert to markdown (must include http:// or https:// + # Full URL to scrape into LLM usable Markdown (must include http:// or https:// # protocol) url:, # Include image references in Markdown output @@ -524,7 +523,7 @@ module BrandDev include_links: nil, # Return a cached result if a prior scrape for the same parameters exists and is # younger than this many milliseconds. Defaults to 1 day (86400000 ms) when - # omitted. Set to 0 to always scrape fresh. + # omitted. Max is 30 days (2592000000 ms). Set to 0 to always scrape fresh. max_age_ms: nil, # Shorten base64-encoded image data in the Markdown output shorten_base64_images: nil, From 418f6d7d52c3beb1b2142eaffdd62079a878f7dc Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 17 Apr 2026 01:56:11 +0000 Subject: [PATCH 14/82] codegen metadata --- .stats.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.stats.yml b/.stats.yml index 792fcdf..0e03d0e 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 20 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-93cf699701172f25e4f6d5053b0573eeb51a79707de94a137ac23d0aaeb76e36.yml -openapi_spec_hash: 4abd14fccd70b0cb0397776e6b5b9171 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-e1e6c71c933578dccc0c110054a5fa21347c4795dff14fd48f5873536b4ce959.yml +openapi_spec_hash: 12b5773c2b15c2f7cdce7590237a1125 config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 From 51cf238020c1726eed5601387902175c0a911963 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 17 Apr 2026 02:07:16 +0000 Subject: [PATCH 15/82] feat(api): api update --- .stats.yml | 4 ++-- lib/brand_dev/models/brand_web_scrape_sitemap_params.rb | 5 ++--- lib/brand_dev/resources/brand.rb | 6 ++---- rbi/brand_dev/models/brand_web_scrape_sitemap_params.rbi | 6 ++---- rbi/brand_dev/resources/brand.rbi | 7 ++----- 5 files changed, 10 insertions(+), 18 deletions(-) diff --git a/.stats.yml b/.stats.yml index 0e03d0e..ec6d250 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 20 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-e1e6c71c933578dccc0c110054a5fa21347c4795dff14fd48f5873536b4ce959.yml -openapi_spec_hash: 12b5773c2b15c2f7cdce7590237a1125 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-2a7727122f4ea5f9240c4c701f70f91b48f861bf5d87ec64f6904d635be5aef8.yml +openapi_spec_hash: 51884daf875aba2f255aaaf69ef1c42d config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 diff --git a/lib/brand_dev/models/brand_web_scrape_sitemap_params.rb b/lib/brand_dev/models/brand_web_scrape_sitemap_params.rb index eabba65..99ec147 100644 --- a/lib/brand_dev/models/brand_web_scrape_sitemap_params.rb +++ b/lib/brand_dev/models/brand_web_scrape_sitemap_params.rb @@ -8,8 +8,7 @@ class BrandWebScrapeSitemapParams < BrandDev::Internal::Type::BaseModel include BrandDev::Internal::Type::RequestParameters # @!attribute domain - # Domain name to crawl sitemaps for (e.g., 'example.com'). The domain will be - # automatically normalized and validated. + # Domain to build a sitemap for # # @return [String] required :domain, String @@ -25,7 +24,7 @@ class BrandWebScrapeSitemapParams < BrandDev::Internal::Type::BaseModel # Some parameter documentations has been truncated, see # {BrandDev::Models::BrandWebScrapeSitemapParams} for more details. # - # @param domain [String] Domain name to crawl sitemaps for (e.g., 'example.com'). The domain will be auto + # @param domain [String] Domain to build a sitemap for # # @param max_links [Integer] Maximum number of links to return from the sitemap crawl. Defaults to 10,000. Mi # diff --git a/lib/brand_dev/resources/brand.rb b/lib/brand_dev/resources/brand.rb index 4dbc495..885ea20 100644 --- a/lib/brand_dev/resources/brand.rb +++ b/lib/brand_dev/resources/brand.rb @@ -629,13 +629,11 @@ def web_scrape_md(params) # Some parameter documentations has been truncated, see # {BrandDev::Models::BrandWebScrapeSitemapParams} for more details. # - # Crawls the sitemap of the given domain and returns all discovered page URLs. - # Supports sitemap index files (recursive), parallel fetching with concurrency - # control, deduplication, and filters out non-page resources (images, PDFs, etc.). + # Crawl an entire website's sitemap and return all discovered page URLs # # @overload web_scrape_sitemap(domain:, max_links: nil, request_options: {}) # - # @param domain [String] Domain name to crawl sitemaps for (e.g., 'example.com'). The domain will be auto + # @param domain [String] Domain to build a sitemap for # # @param max_links [Integer] Maximum number of links to return from the sitemap crawl. Defaults to 10,000. Mi # diff --git a/rbi/brand_dev/models/brand_web_scrape_sitemap_params.rbi b/rbi/brand_dev/models/brand_web_scrape_sitemap_params.rbi index 8de9789..9fa48e2 100644 --- a/rbi/brand_dev/models/brand_web_scrape_sitemap_params.rbi +++ b/rbi/brand_dev/models/brand_web_scrape_sitemap_params.rbi @@ -14,8 +14,7 @@ module BrandDev ) end - # Domain name to crawl sitemaps for (e.g., 'example.com'). The domain will be - # automatically normalized and validated. + # Domain to build a sitemap for sig { returns(String) } attr_accessor :domain @@ -35,8 +34,7 @@ module BrandDev ).returns(T.attached_class) end def self.new( - # Domain name to crawl sitemaps for (e.g., 'example.com'). The domain will be - # automatically normalized and validated. + # Domain to build a sitemap for domain:, # Maximum number of links to return from the sitemap crawl. Defaults to 10,000. # Minimum is 1, maximum is 100,000. diff --git a/rbi/brand_dev/resources/brand.rbi b/rbi/brand_dev/resources/brand.rbi index 95fe7f8..f30aedb 100644 --- a/rbi/brand_dev/resources/brand.rbi +++ b/rbi/brand_dev/resources/brand.rbi @@ -534,9 +534,7 @@ module BrandDev ) end - # Crawls the sitemap of the given domain and returns all discovered page URLs. - # Supports sitemap index files (recursive), parallel fetching with concurrency - # control, deduplication, and filters out non-page resources (images, PDFs, etc.). + # Crawl an entire website's sitemap and return all discovered page URLs sig do params( domain: String, @@ -545,8 +543,7 @@ module BrandDev ).returns(BrandDev::Models::BrandWebScrapeSitemapResponse) end def web_scrape_sitemap( - # Domain name to crawl sitemaps for (e.g., 'example.com'). The domain will be - # automatically normalized and validated. + # Domain to build a sitemap for domain:, # Maximum number of links to return from the sitemap crawl. Defaults to 10,000. # Minimum is 1, maximum is 100,000. From 0383c2cb215ae0f5712f7a298cd4242dba735224 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 17 Apr 2026 02:18:13 +0000 Subject: [PATCH 16/82] codegen metadata --- .stats.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.stats.yml b/.stats.yml index ec6d250..ff47fd4 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 20 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-2a7727122f4ea5f9240c4c701f70f91b48f861bf5d87ec64f6904d635be5aef8.yml -openapi_spec_hash: 51884daf875aba2f255aaaf69ef1c42d +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-a3f9cb65527955359bd08122edd68527fb13d5ba8fa8279fb3892e277e1d6233.yml +openapi_spec_hash: 037b592f3b2373d9b0753ba5b7d571b5 config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 From 816eb6e5e3fa167f8492b05c27c989c0c08d86c1 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 17 Apr 2026 02:25:07 +0000 Subject: [PATCH 17/82] codegen metadata --- .stats.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.stats.yml b/.stats.yml index ff47fd4..3e31f1c 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 20 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-a3f9cb65527955359bd08122edd68527fb13d5ba8fa8279fb3892e277e1d6233.yml -openapi_spec_hash: 037b592f3b2373d9b0753ba5b7d571b5 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-41fdbb36b66c713e8073c04937010aa4b861a99b105966856e211c9aaee1fe34.yml +openapi_spec_hash: daadd24dfc43587bb323a137089edd7d config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 From 7e9e3f5012f1d11daef7795087699d3d8914ec0a Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 17 Apr 2026 21:56:19 +0000 Subject: [PATCH 18/82] feat(api): api update --- .stats.yml | 6 +- lib/brand_dev.rb | 2 - lib/brand_dev/models.rb | 2 - lib/brand_dev/models/brand_fonts_params.rb | 36 ----- lib/brand_dev/models/brand_fonts_response.rb | 100 ------------ lib/brand_dev/resources/brand.rb | 29 ---- rbi/brand_dev/models.rbi | 2 - rbi/brand_dev/models/brand_fonts_params.rbi | 60 ------- rbi/brand_dev/models/brand_fonts_response.rbi | 147 ------------------ rbi/brand_dev/resources/brand.rbi | 21 --- sig/brand_dev/models.rbs | 2 - sig/brand_dev/models/brand_fonts_params.rbs | 30 ---- sig/brand_dev/models/brand_fonts_response.rbs | 82 ---------- sig/brand_dev/resources/brand.rbs | 6 - test/brand_dev/resources/brand_test.rb | 19 --- 15 files changed, 3 insertions(+), 541 deletions(-) delete mode 100644 lib/brand_dev/models/brand_fonts_params.rb delete mode 100644 lib/brand_dev/models/brand_fonts_response.rb delete mode 100644 rbi/brand_dev/models/brand_fonts_params.rbi delete mode 100644 rbi/brand_dev/models/brand_fonts_response.rbi delete mode 100644 sig/brand_dev/models/brand_fonts_params.rbs delete mode 100644 sig/brand_dev/models/brand_fonts_response.rbs diff --git a/.stats.yml b/.stats.yml index 3e31f1c..c117657 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ -configured_endpoints: 20 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-41fdbb36b66c713e8073c04937010aa4b861a99b105966856e211c9aaee1fe34.yml -openapi_spec_hash: daadd24dfc43587bb323a137089edd7d +configured_endpoints: 19 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-135cee98ff73868b77c6dd17f5d1ccc7cd1e26a8cef266ceba1020346e11a8ef.yml +openapi_spec_hash: d9c1751a0fd999118b6d55d4931212e1 config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 diff --git a/lib/brand_dev.rb b/lib/brand_dev.rb index 391d3ad..a93b437 100644 --- a/lib/brand_dev.rb +++ b/lib/brand_dev.rb @@ -58,8 +58,6 @@ require_relative "brand_dev/models/brand_ai_products_response" require_relative "brand_dev/models/brand_ai_query_params" require_relative "brand_dev/models/brand_ai_query_response" -require_relative "brand_dev/models/brand_fonts_params" -require_relative "brand_dev/models/brand_fonts_response" require_relative "brand_dev/models/brand_identify_from_transaction_params" require_relative "brand_dev/models/brand_identify_from_transaction_response" require_relative "brand_dev/models/brand_prefetch_by_email_params" diff --git a/lib/brand_dev/models.rb b/lib/brand_dev/models.rb index 61ba941..97aa116 100644 --- a/lib/brand_dev/models.rb +++ b/lib/brand_dev/models.rb @@ -45,8 +45,6 @@ module BrandDev BrandAIQueryParams = BrandDev::Models::BrandAIQueryParams - BrandFontsParams = BrandDev::Models::BrandFontsParams - BrandIdentifyFromTransactionParams = BrandDev::Models::BrandIdentifyFromTransactionParams BrandPrefetchByEmailParams = BrandDev::Models::BrandPrefetchByEmailParams diff --git a/lib/brand_dev/models/brand_fonts_params.rb b/lib/brand_dev/models/brand_fonts_params.rb deleted file mode 100644 index 9ddb95b..0000000 --- a/lib/brand_dev/models/brand_fonts_params.rb +++ /dev/null @@ -1,36 +0,0 @@ -# frozen_string_literal: true - -module BrandDev - module Models - # @see BrandDev::Resources::Brand#fonts - class BrandFontsParams < BrandDev::Internal::Type::BaseModel - extend BrandDev::Internal::Type::RequestParameters::Converter - include BrandDev::Internal::Type::RequestParameters - - # @!attribute domain - # Domain name to extract fonts from (e.g., 'example.com', 'google.com'). The - # domain will be automatically normalized and validated. - # - # @return [String] - required :domain, String - - # @!attribute timeout_ms - # Optional timeout in milliseconds for the request. If the request takes longer - # than this value, it will be aborted with a 408 status code. Maximum allowed - # value is 300000ms (5 minutes). - # - # @return [Integer, nil] - optional :timeout_ms, Integer - - # @!method initialize(domain:, timeout_ms: nil, request_options: {}) - # Some parameter documentations has been truncated, see - # {BrandDev::Models::BrandFontsParams} for more details. - # - # @param domain [String] Domain name to extract fonts from (e.g., 'example.com', 'google.com'). The domai - # - # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th - # - # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}] - end - end -end diff --git a/lib/brand_dev/models/brand_fonts_response.rb b/lib/brand_dev/models/brand_fonts_response.rb deleted file mode 100644 index 9d6d4c4..0000000 --- a/lib/brand_dev/models/brand_fonts_response.rb +++ /dev/null @@ -1,100 +0,0 @@ -# frozen_string_literal: true - -module BrandDev - module Models - # @see BrandDev::Resources::Brand#fonts - class BrandFontsResponse < BrandDev::Internal::Type::BaseModel - # @!attribute code - # HTTP status code, e.g., 200 - # - # @return [Integer] - required :code, Integer - - # @!attribute domain - # The normalized domain that was processed - # - # @return [String] - required :domain, String - - # @!attribute fonts - # Array of font usage information - # - # @return [Array] - required :fonts, -> { BrandDev::Internal::Type::ArrayOf[BrandDev::Models::BrandFontsResponse::Font] } - - # @!attribute status - # Status of the response, e.g., 'ok' - # - # @return [String] - required :status, String - - # @!method initialize(code:, domain:, fonts:, status:) - # @param code [Integer] HTTP status code, e.g., 200 - # - # @param domain [String] The normalized domain that was processed - # - # @param fonts [Array] Array of font usage information - # - # @param status [String] Status of the response, e.g., 'ok' - - class Font < BrandDev::Internal::Type::BaseModel - # @!attribute fallbacks - # Array of fallback font families - # - # @return [Array] - required :fallbacks, BrandDev::Internal::Type::ArrayOf[String] - - # @!attribute font - # Font family name - # - # @return [String] - required :font, String - - # @!attribute num_elements - # Number of elements using this font - # - # @return [Float] - required :num_elements, Float - - # @!attribute num_words - # Number of words using this font - # - # @return [Float] - required :num_words, Float - - # @!attribute percent_elements - # Percentage of elements using this font - # - # @return [Float] - required :percent_elements, Float - - # @!attribute percent_words - # Percentage of words using this font - # - # @return [Float] - required :percent_words, Float - - # @!attribute uses - # Array of CSS selectors or element types where this font is used - # - # @return [Array] - required :uses, BrandDev::Internal::Type::ArrayOf[String] - - # @!method initialize(fallbacks:, font:, num_elements:, num_words:, percent_elements:, percent_words:, uses:) - # @param fallbacks [Array] Array of fallback font families - # - # @param font [String] Font family name - # - # @param num_elements [Float] Number of elements using this font - # - # @param num_words [Float] Number of words using this font - # - # @param percent_elements [Float] Percentage of elements using this font - # - # @param percent_words [Float] Percentage of words using this font - # - # @param uses [Array] Array of CSS selectors or element types where this font is used - end - end - end -end diff --git a/lib/brand_dev/resources/brand.rb b/lib/brand_dev/resources/brand.rb index 885ea20..b4f25e9 100644 --- a/lib/brand_dev/resources/brand.rb +++ b/lib/brand_dev/resources/brand.rb @@ -121,35 +121,6 @@ def ai_query(params) ) end - # Some parameter documentations has been truncated, see - # {BrandDev::Models::BrandFontsParams} for more details. - # - # Extract font information from a brand's website including font families, usage - # statistics, fallbacks, and element/word counts. - # - # @overload fonts(domain:, timeout_ms: nil, request_options: {}) - # - # @param domain [String] Domain name to extract fonts from (e.g., 'example.com', 'google.com'). The domai - # - # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th - # - # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}, nil] - # - # @return [BrandDev::Models::BrandFontsResponse] - # - # @see BrandDev::Models::BrandFontsParams - def fonts(params) - parsed, options = BrandDev::BrandFontsParams.dump_request(params) - query = BrandDev::Internal::Util.encode_query_params(parsed) - @client.request( - method: :get, - path: "brand/fonts", - query: query.transform_keys(timeout_ms: "timeoutMS"), - model: BrandDev::Models::BrandFontsResponse, - options: options - ) - end - # Some parameter documentations has been truncated, see # {BrandDev::Models::BrandIdentifyFromTransactionParams} for more details. # diff --git a/rbi/brand_dev/models.rbi b/rbi/brand_dev/models.rbi index d7c026f..52cc694 100644 --- a/rbi/brand_dev/models.rbi +++ b/rbi/brand_dev/models.rbi @@ -7,8 +7,6 @@ module BrandDev BrandAIQueryParams = BrandDev::Models::BrandAIQueryParams - BrandFontsParams = BrandDev::Models::BrandFontsParams - BrandIdentifyFromTransactionParams = BrandDev::Models::BrandIdentifyFromTransactionParams diff --git a/rbi/brand_dev/models/brand_fonts_params.rbi b/rbi/brand_dev/models/brand_fonts_params.rbi deleted file mode 100644 index 19b9237..0000000 --- a/rbi/brand_dev/models/brand_fonts_params.rbi +++ /dev/null @@ -1,60 +0,0 @@ -# typed: strong - -module BrandDev - module Models - class BrandFontsParams < BrandDev::Internal::Type::BaseModel - extend BrandDev::Internal::Type::RequestParameters::Converter - include BrandDev::Internal::Type::RequestParameters - - OrHash = - T.type_alias do - T.any(BrandDev::BrandFontsParams, BrandDev::Internal::AnyHash) - end - - # Domain name to extract fonts from (e.g., 'example.com', 'google.com'). The - # domain will be automatically normalized and validated. - sig { returns(String) } - attr_accessor :domain - - # Optional timeout in milliseconds for the request. If the request takes longer - # than this value, it will be aborted with a 408 status code. Maximum allowed - # value is 300000ms (5 minutes). - sig { returns(T.nilable(Integer)) } - attr_reader :timeout_ms - - sig { params(timeout_ms: Integer).void } - attr_writer :timeout_ms - - sig do - params( - domain: String, - timeout_ms: Integer, - request_options: BrandDev::RequestOptions::OrHash - ).returns(T.attached_class) - end - def self.new( - # Domain name to extract fonts from (e.g., 'example.com', 'google.com'). The - # domain will be automatically normalized and validated. - domain:, - # Optional timeout in milliseconds for the request. If the request takes longer - # than this value, it will be aborted with a 408 status code. Maximum allowed - # value is 300000ms (5 minutes). - timeout_ms: nil, - request_options: {} - ) - end - - sig do - override.returns( - { - domain: String, - timeout_ms: Integer, - request_options: BrandDev::RequestOptions - } - ) - end - def to_hash - end - end - end -end diff --git a/rbi/brand_dev/models/brand_fonts_response.rbi b/rbi/brand_dev/models/brand_fonts_response.rbi deleted file mode 100644 index 8bc3b37..0000000 --- a/rbi/brand_dev/models/brand_fonts_response.rbi +++ /dev/null @@ -1,147 +0,0 @@ -# typed: strong - -module BrandDev - module Models - class BrandFontsResponse < BrandDev::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - BrandDev::Models::BrandFontsResponse, - BrandDev::Internal::AnyHash - ) - end - - # HTTP status code, e.g., 200 - sig { returns(Integer) } - attr_accessor :code - - # The normalized domain that was processed - sig { returns(String) } - attr_accessor :domain - - # Array of font usage information - sig { returns(T::Array[BrandDev::Models::BrandFontsResponse::Font]) } - attr_accessor :fonts - - # Status of the response, e.g., 'ok' - sig { returns(String) } - attr_accessor :status - - sig do - params( - code: Integer, - domain: String, - fonts: T::Array[BrandDev::Models::BrandFontsResponse::Font::OrHash], - status: String - ).returns(T.attached_class) - end - def self.new( - # HTTP status code, e.g., 200 - code:, - # The normalized domain that was processed - domain:, - # Array of font usage information - fonts:, - # Status of the response, e.g., 'ok' - status: - ) - end - - sig do - override.returns( - { - code: Integer, - domain: String, - fonts: T::Array[BrandDev::Models::BrandFontsResponse::Font], - status: String - } - ) - end - def to_hash - end - - class Font < BrandDev::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - BrandDev::Models::BrandFontsResponse::Font, - BrandDev::Internal::AnyHash - ) - end - - # Array of fallback font families - sig { returns(T::Array[String]) } - attr_accessor :fallbacks - - # Font family name - sig { returns(String) } - attr_accessor :font - - # Number of elements using this font - sig { returns(Float) } - attr_accessor :num_elements - - # Number of words using this font - sig { returns(Float) } - attr_accessor :num_words - - # Percentage of elements using this font - sig { returns(Float) } - attr_accessor :percent_elements - - # Percentage of words using this font - sig { returns(Float) } - attr_accessor :percent_words - - # Array of CSS selectors or element types where this font is used - sig { returns(T::Array[String]) } - attr_accessor :uses - - sig do - params( - fallbacks: T::Array[String], - font: String, - num_elements: Float, - num_words: Float, - percent_elements: Float, - percent_words: Float, - uses: T::Array[String] - ).returns(T.attached_class) - end - def self.new( - # Array of fallback font families - fallbacks:, - # Font family name - font:, - # Number of elements using this font - num_elements:, - # Number of words using this font - num_words:, - # Percentage of elements using this font - percent_elements:, - # Percentage of words using this font - percent_words:, - # Array of CSS selectors or element types where this font is used - uses: - ) - end - - sig do - override.returns( - { - fallbacks: T::Array[String], - font: String, - num_elements: Float, - num_words: Float, - percent_elements: Float, - percent_words: Float, - uses: T::Array[String] - } - ) - end - def to_hash - end - end - end - end -end diff --git a/rbi/brand_dev/resources/brand.rbi b/rbi/brand_dev/resources/brand.rbi index f30aedb..1483067 100644 --- a/rbi/brand_dev/resources/brand.rbi +++ b/rbi/brand_dev/resources/brand.rbi @@ -97,27 +97,6 @@ module BrandDev ) end - # Extract font information from a brand's website including font families, usage - # statistics, fallbacks, and element/word counts. - sig do - params( - domain: String, - timeout_ms: Integer, - request_options: BrandDev::RequestOptions::OrHash - ).returns(BrandDev::Models::BrandFontsResponse) - end - def fonts( - # Domain name to extract fonts from (e.g., 'example.com', 'google.com'). The - # domain will be automatically normalized and validated. - domain:, - # Optional timeout in milliseconds for the request. If the request takes longer - # than this value, it will be aborted with a 408 status code. Maximum allowed - # value is 300000ms (5 minutes). - timeout_ms: nil, - request_options: {} - ) - end - # Endpoint specially designed for platforms that want to identify transaction data # by the transaction title. sig do diff --git a/sig/brand_dev/models.rbs b/sig/brand_dev/models.rbs index 4a5e14b..12006f3 100644 --- a/sig/brand_dev/models.rbs +++ b/sig/brand_dev/models.rbs @@ -5,8 +5,6 @@ module BrandDev class BrandAIQueryParams = BrandDev::Models::BrandAIQueryParams - class BrandFontsParams = BrandDev::Models::BrandFontsParams - class BrandIdentifyFromTransactionParams = BrandDev::Models::BrandIdentifyFromTransactionParams class BrandPrefetchByEmailParams = BrandDev::Models::BrandPrefetchByEmailParams diff --git a/sig/brand_dev/models/brand_fonts_params.rbs b/sig/brand_dev/models/brand_fonts_params.rbs deleted file mode 100644 index be6ba19..0000000 --- a/sig/brand_dev/models/brand_fonts_params.rbs +++ /dev/null @@ -1,30 +0,0 @@ -module BrandDev - module Models - type brand_fonts_params = - { domain: String, timeout_ms: Integer } - & BrandDev::Internal::Type::request_parameters - - class BrandFontsParams < BrandDev::Internal::Type::BaseModel - extend BrandDev::Internal::Type::RequestParameters::Converter - include BrandDev::Internal::Type::RequestParameters - - attr_accessor domain: String - - attr_reader timeout_ms: Integer? - - def timeout_ms=: (Integer) -> Integer - - def initialize: ( - domain: String, - ?timeout_ms: Integer, - ?request_options: BrandDev::request_opts - ) -> void - - def to_hash: -> { - domain: String, - timeout_ms: Integer, - request_options: BrandDev::RequestOptions - } - end - end -end diff --git a/sig/brand_dev/models/brand_fonts_response.rbs b/sig/brand_dev/models/brand_fonts_response.rbs deleted file mode 100644 index e149eba..0000000 --- a/sig/brand_dev/models/brand_fonts_response.rbs +++ /dev/null @@ -1,82 +0,0 @@ -module BrandDev - module Models - type brand_fonts_response = - { - code: Integer, - domain: String, - fonts: ::Array[BrandDev::Models::BrandFontsResponse::Font], - status: String - } - - class BrandFontsResponse < BrandDev::Internal::Type::BaseModel - attr_accessor code: Integer - - attr_accessor domain: String - - attr_accessor fonts: ::Array[BrandDev::Models::BrandFontsResponse::Font] - - attr_accessor status: String - - def initialize: ( - code: Integer, - domain: String, - fonts: ::Array[BrandDev::Models::BrandFontsResponse::Font], - status: String - ) -> void - - def to_hash: -> { - code: Integer, - domain: String, - fonts: ::Array[BrandDev::Models::BrandFontsResponse::Font], - status: String - } - - type font = - { - fallbacks: ::Array[String], - font: String, - num_elements: Float, - num_words: Float, - percent_elements: Float, - percent_words: Float, - uses: ::Array[String] - } - - class Font < BrandDev::Internal::Type::BaseModel - attr_accessor fallbacks: ::Array[String] - - attr_accessor font: String - - attr_accessor num_elements: Float - - attr_accessor num_words: Float - - attr_accessor percent_elements: Float - - attr_accessor percent_words: Float - - attr_accessor uses: ::Array[String] - - def initialize: ( - fallbacks: ::Array[String], - font: String, - num_elements: Float, - num_words: Float, - percent_elements: Float, - percent_words: Float, - uses: ::Array[String] - ) -> void - - def to_hash: -> { - fallbacks: ::Array[String], - font: String, - num_elements: Float, - num_words: Float, - percent_elements: Float, - percent_words: Float, - uses: ::Array[String] - } - end - end - end -end diff --git a/sig/brand_dev/resources/brand.rbs b/sig/brand_dev/resources/brand.rbs index 2833849..23b2871 100644 --- a/sig/brand_dev/resources/brand.rbs +++ b/sig/brand_dev/resources/brand.rbs @@ -28,12 +28,6 @@ module BrandDev ?request_options: BrandDev::request_opts ) -> BrandDev::Models::BrandAIQueryResponse - def fonts: ( - domain: String, - ?timeout_ms: Integer, - ?request_options: BrandDev::request_opts - ) -> BrandDev::Models::BrandFontsResponse - def identify_from_transaction: ( transaction_info: String, ?city: String, diff --git a/test/brand_dev/resources/brand_test.rb b/test/brand_dev/resources/brand_test.rb index 4be7ac8..c527210 100644 --- a/test/brand_dev/resources/brand_test.rb +++ b/test/brand_dev/resources/brand_test.rb @@ -85,25 +85,6 @@ def test_ai_query_required_params end end - def test_fonts_required_params - skip("Mock server tests are disabled") - - response = @brand_dev.brand.fonts(domain: "domain") - - assert_pattern do - response => BrandDev::Models::BrandFontsResponse - end - - assert_pattern do - response => { - code: Integer, - domain: String, - fonts: ^(BrandDev::Internal::Type::ArrayOf[BrandDev::Models::BrandFontsResponse::Font]), - status: String - } - end - end - def test_identify_from_transaction_required_params skip("Mock server tests are disabled") From de2601f83745aa577c0c7629b4621e78218dbc1b Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 17 Apr 2026 22:17:39 +0000 Subject: [PATCH 19/82] feat(api): api update --- .stats.yml | 6 +- lib/brand_dev.rb | 2 - lib/brand_dev/models.rb | 2 - .../models/brand_screenshot_params.rb | 115 --------- .../models/brand_screenshot_response.rb | 64 ----- lib/brand_dev/resources/brand.rb | 38 --- rbi/brand_dev/models.rbi | 2 - .../models/brand_screenshot_params.rbi | 236 ------------------ .../models/brand_screenshot_response.rbi | 135 ---------- rbi/brand_dev/resources/brand.rbi | 42 ---- sig/brand_dev/models.rbs | 2 - .../models/brand_screenshot_params.rbs | 109 -------- .../models/brand_screenshot_response.rbs | 63 ----- sig/brand_dev/resources/brand.rbs | 9 - test/brand_dev/resources/brand_test.rb | 20 -- 15 files changed, 3 insertions(+), 842 deletions(-) delete mode 100644 lib/brand_dev/models/brand_screenshot_params.rb delete mode 100644 lib/brand_dev/models/brand_screenshot_response.rb delete mode 100644 rbi/brand_dev/models/brand_screenshot_params.rbi delete mode 100644 rbi/brand_dev/models/brand_screenshot_response.rbi delete mode 100644 sig/brand_dev/models/brand_screenshot_params.rbs delete mode 100644 sig/brand_dev/models/brand_screenshot_response.rbs diff --git a/.stats.yml b/.stats.yml index c117657..0198e38 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ -configured_endpoints: 19 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-135cee98ff73868b77c6dd17f5d1ccc7cd1e26a8cef266ceba1020346e11a8ef.yml -openapi_spec_hash: d9c1751a0fd999118b6d55d4931212e1 +configured_endpoints: 18 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-73b75de3d3aae732e496f3828fc2c88711969e8abaae060d939da505f36cb3f8.yml +openapi_spec_hash: 30b5dacd44ef41592ba645033b3a1ca3 config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 diff --git a/lib/brand_dev.rb b/lib/brand_dev.rb index a93b437..98d3086 100644 --- a/lib/brand_dev.rb +++ b/lib/brand_dev.rb @@ -78,8 +78,6 @@ require_relative "brand_dev/models/brand_retrieve_response" require_relative "brand_dev/models/brand_retrieve_simplified_params" require_relative "brand_dev/models/brand_retrieve_simplified_response" -require_relative "brand_dev/models/brand_screenshot_params" -require_relative "brand_dev/models/brand_screenshot_response" require_relative "brand_dev/models/brand_styleguide_params" require_relative "brand_dev/models/brand_styleguide_response" require_relative "brand_dev/models/brand_web_scrape_html_params" diff --git a/lib/brand_dev/models.rb b/lib/brand_dev/models.rb index 97aa116..8c2242b 100644 --- a/lib/brand_dev/models.rb +++ b/lib/brand_dev/models.rb @@ -65,8 +65,6 @@ module BrandDev BrandRetrieveSimplifiedParams = BrandDev::Models::BrandRetrieveSimplifiedParams - BrandScreenshotParams = BrandDev::Models::BrandScreenshotParams - BrandStyleguideParams = BrandDev::Models::BrandStyleguideParams BrandWebScrapeHTMLParams = BrandDev::Models::BrandWebScrapeHTMLParams diff --git a/lib/brand_dev/models/brand_screenshot_params.rb b/lib/brand_dev/models/brand_screenshot_params.rb deleted file mode 100644 index 481064b..0000000 --- a/lib/brand_dev/models/brand_screenshot_params.rb +++ /dev/null @@ -1,115 +0,0 @@ -# frozen_string_literal: true - -module BrandDev - module Models - # @see BrandDev::Resources::Brand#screenshot - class BrandScreenshotParams < BrandDev::Internal::Type::BaseModel - extend BrandDev::Internal::Type::RequestParameters::Converter - include BrandDev::Internal::Type::RequestParameters - - # @!attribute direct_url - # A specific URL to screenshot directly, bypassing domain resolution (e.g., - # 'https://example.com/pricing'). When provided, the screenshot is taken of this - # exact URL. - # - # @return [String, nil] - optional :direct_url, String - - # @!attribute domain - # Domain name to take screenshot of (e.g., 'example.com', 'google.com'). The - # domain will be automatically normalized and validated. - # - # @return [String, nil] - optional :domain, String - - # @!attribute full_screenshot - # Optional parameter to determine screenshot type. If 'true', takes a full page - # screenshot capturing all content. If 'false' or not provided, takes a viewport - # screenshot (standard browser view). - # - # @return [Symbol, BrandDev::Models::BrandScreenshotParams::FullScreenshot, nil] - optional :full_screenshot, enum: -> { BrandDev::BrandScreenshotParams::FullScreenshot } - - # @!attribute page - # Optional parameter to specify which page type to screenshot. If provided, the - # system will scrape the domain's links and use heuristics to find the most - # appropriate URL for the specified page type (30 supported languages). If not - # provided, screenshots the main domain landing page. Only applicable when using - # 'domain', not 'directUrl'. - # - # @return [Symbol, BrandDev::Models::BrandScreenshotParams::Page, nil] - optional :page, enum: -> { BrandDev::BrandScreenshotParams::Page } - - # @!attribute prioritize - # Optional parameter to prioritize screenshot capture. If 'speed', optimizes for - # faster capture with basic quality. If 'quality', optimizes for higher quality - # with longer wait times. Defaults to 'quality' if not provided. - # - # @return [Symbol, BrandDev::Models::BrandScreenshotParams::Prioritize, nil] - optional :prioritize, enum: -> { BrandDev::BrandScreenshotParams::Prioritize } - - # @!method initialize(direct_url: nil, domain: nil, full_screenshot: nil, page: nil, prioritize: nil, request_options: {}) - # Some parameter documentations has been truncated, see - # {BrandDev::Models::BrandScreenshotParams} for more details. - # - # @param direct_url [String] A specific URL to screenshot directly, bypassing domain resolution (e.g., 'https - # - # @param domain [String] Domain name to take screenshot of (e.g., 'example.com', 'google.com'). The domai - # - # @param full_screenshot [Symbol, BrandDev::Models::BrandScreenshotParams::FullScreenshot] Optional parameter to determine screenshot type. If 'true', takes a full page sc - # - # @param page [Symbol, BrandDev::Models::BrandScreenshotParams::Page] Optional parameter to specify which page type to screenshot. If provided, the sy - # - # @param prioritize [Symbol, BrandDev::Models::BrandScreenshotParams::Prioritize] Optional parameter to prioritize screenshot capture. If 'speed', optimizes for f - # - # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}] - - # Optional parameter to determine screenshot type. If 'true', takes a full page - # screenshot capturing all content. If 'false' or not provided, takes a viewport - # screenshot (standard browser view). - module FullScreenshot - extend BrandDev::Internal::Type::Enum - - TRUE = :true - FALSE = :false - - # @!method self.values - # @return [Array] - end - - # Optional parameter to specify which page type to screenshot. If provided, the - # system will scrape the domain's links and use heuristics to find the most - # appropriate URL for the specified page type (30 supported languages). If not - # provided, screenshots the main domain landing page. Only applicable when using - # 'domain', not 'directUrl'. - module Page - extend BrandDev::Internal::Type::Enum - - LOGIN = :login - SIGNUP = :signup - BLOG = :blog - CAREERS = :careers - PRICING = :pricing - TERMS = :terms - PRIVACY = :privacy - CONTACT = :contact - - # @!method self.values - # @return [Array] - end - - # Optional parameter to prioritize screenshot capture. If 'speed', optimizes for - # faster capture with basic quality. If 'quality', optimizes for higher quality - # with longer wait times. Defaults to 'quality' if not provided. - module Prioritize - extend BrandDev::Internal::Type::Enum - - SPEED = :speed - QUALITY = :quality - - # @!method self.values - # @return [Array] - end - end - end -end diff --git a/lib/brand_dev/models/brand_screenshot_response.rb b/lib/brand_dev/models/brand_screenshot_response.rb deleted file mode 100644 index c42597d..0000000 --- a/lib/brand_dev/models/brand_screenshot_response.rb +++ /dev/null @@ -1,64 +0,0 @@ -# frozen_string_literal: true - -module BrandDev - module Models - # @see BrandDev::Resources::Brand#screenshot - class BrandScreenshotResponse < BrandDev::Internal::Type::BaseModel - # @!attribute code - # HTTP status code - # - # @return [Integer, nil] - optional :code, Integer - - # @!attribute domain - # The normalized domain that was processed - # - # @return [String, nil] - optional :domain, String - - # @!attribute screenshot - # Public URL of the uploaded screenshot image - # - # @return [String, nil] - optional :screenshot, String - - # @!attribute screenshot_type - # Type of screenshot that was captured - # - # @return [Symbol, BrandDev::Models::BrandScreenshotResponse::ScreenshotType, nil] - optional :screenshot_type, - enum: -> { BrandDev::Models::BrandScreenshotResponse::ScreenshotType }, - api_name: :screenshotType - - # @!attribute status - # Status of the response, e.g., 'ok' - # - # @return [String, nil] - optional :status, String - - # @!method initialize(code: nil, domain: nil, screenshot: nil, screenshot_type: nil, status: nil) - # @param code [Integer] HTTP status code - # - # @param domain [String] The normalized domain that was processed - # - # @param screenshot [String] Public URL of the uploaded screenshot image - # - # @param screenshot_type [Symbol, BrandDev::Models::BrandScreenshotResponse::ScreenshotType] Type of screenshot that was captured - # - # @param status [String] Status of the response, e.g., 'ok' - - # Type of screenshot that was captured - # - # @see BrandDev::Models::BrandScreenshotResponse#screenshot_type - module ScreenshotType - extend BrandDev::Internal::Type::Enum - - VIEWPORT = :viewport - FULL_PAGE = :fullPage - - # @!method self.values - # @return [Array] - end - end - end -end diff --git a/lib/brand_dev/resources/brand.rb b/lib/brand_dev/resources/brand.rb index b4f25e9..76c9ecf 100644 --- a/lib/brand_dev/resources/brand.rb +++ b/lib/brand_dev/resources/brand.rb @@ -431,44 +431,6 @@ def retrieve_simplified(params) ) end - # Some parameter documentations has been truncated, see - # {BrandDev::Models::BrandScreenshotParams} for more details. - # - # Capture a screenshot of a website. Supports both viewport (standard browser - # view) and full-page screenshots. Can also screenshot specific page types (login, - # pricing, etc.) by using heuristics to find the appropriate URL. Either 'domain' - # or 'directUrl' must be provided as a query parameter, but not both. Returns a - # URL to the uploaded screenshot image hosted on our CDN. - # - # @overload screenshot(direct_url: nil, domain: nil, full_screenshot: nil, page: nil, prioritize: nil, request_options: {}) - # - # @param direct_url [String] A specific URL to screenshot directly, bypassing domain resolution (e.g., 'https - # - # @param domain [String] Domain name to take screenshot of (e.g., 'example.com', 'google.com'). The domai - # - # @param full_screenshot [Symbol, BrandDev::Models::BrandScreenshotParams::FullScreenshot] Optional parameter to determine screenshot type. If 'true', takes a full page sc - # - # @param page [Symbol, BrandDev::Models::BrandScreenshotParams::Page] Optional parameter to specify which page type to screenshot. If provided, the sy - # - # @param prioritize [Symbol, BrandDev::Models::BrandScreenshotParams::Prioritize] Optional parameter to prioritize screenshot capture. If 'speed', optimizes for f - # - # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}, nil] - # - # @return [BrandDev::Models::BrandScreenshotResponse] - # - # @see BrandDev::Models::BrandScreenshotParams - def screenshot(params = {}) - parsed, options = BrandDev::BrandScreenshotParams.dump_request(params) - query = BrandDev::Internal::Util.encode_query_params(parsed) - @client.request( - method: :get, - path: "brand/screenshot", - query: query.transform_keys(direct_url: "directUrl", full_screenshot: "fullScreenshot"), - model: BrandDev::Models::BrandScreenshotResponse, - options: options - ) - end - # Some parameter documentations has been truncated, see # {BrandDev::Models::BrandStyleguideParams} for more details. # diff --git a/rbi/brand_dev/models.rbi b/rbi/brand_dev/models.rbi index 52cc694..f6e9101 100644 --- a/rbi/brand_dev/models.rbi +++ b/rbi/brand_dev/models.rbi @@ -29,8 +29,6 @@ module BrandDev BrandRetrieveSimplifiedParams = BrandDev::Models::BrandRetrieveSimplifiedParams - BrandScreenshotParams = BrandDev::Models::BrandScreenshotParams - BrandStyleguideParams = BrandDev::Models::BrandStyleguideParams BrandWebScrapeHTMLParams = BrandDev::Models::BrandWebScrapeHTMLParams diff --git a/rbi/brand_dev/models/brand_screenshot_params.rbi b/rbi/brand_dev/models/brand_screenshot_params.rbi deleted file mode 100644 index e0e9849..0000000 --- a/rbi/brand_dev/models/brand_screenshot_params.rbi +++ /dev/null @@ -1,236 +0,0 @@ -# typed: strong - -module BrandDev - module Models - class BrandScreenshotParams < BrandDev::Internal::Type::BaseModel - extend BrandDev::Internal::Type::RequestParameters::Converter - include BrandDev::Internal::Type::RequestParameters - - OrHash = - T.type_alias do - T.any(BrandDev::BrandScreenshotParams, BrandDev::Internal::AnyHash) - end - - # A specific URL to screenshot directly, bypassing domain resolution (e.g., - # 'https://example.com/pricing'). When provided, the screenshot is taken of this - # exact URL. - sig { returns(T.nilable(String)) } - attr_reader :direct_url - - sig { params(direct_url: String).void } - attr_writer :direct_url - - # Domain name to take screenshot of (e.g., 'example.com', 'google.com'). The - # domain will be automatically normalized and validated. - sig { returns(T.nilable(String)) } - attr_reader :domain - - sig { params(domain: String).void } - attr_writer :domain - - # Optional parameter to determine screenshot type. If 'true', takes a full page - # screenshot capturing all content. If 'false' or not provided, takes a viewport - # screenshot (standard browser view). - sig do - returns( - T.nilable(BrandDev::BrandScreenshotParams::FullScreenshot::OrSymbol) - ) - end - attr_reader :full_screenshot - - sig do - params( - full_screenshot: - BrandDev::BrandScreenshotParams::FullScreenshot::OrSymbol - ).void - end - attr_writer :full_screenshot - - # Optional parameter to specify which page type to screenshot. If provided, the - # system will scrape the domain's links and use heuristics to find the most - # appropriate URL for the specified page type (30 supported languages). If not - # provided, screenshots the main domain landing page. Only applicable when using - # 'domain', not 'directUrl'. - sig do - returns(T.nilable(BrandDev::BrandScreenshotParams::Page::OrSymbol)) - end - attr_reader :page - - sig { params(page: BrandDev::BrandScreenshotParams::Page::OrSymbol).void } - attr_writer :page - - # Optional parameter to prioritize screenshot capture. If 'speed', optimizes for - # faster capture with basic quality. If 'quality', optimizes for higher quality - # with longer wait times. Defaults to 'quality' if not provided. - sig do - returns( - T.nilable(BrandDev::BrandScreenshotParams::Prioritize::OrSymbol) - ) - end - attr_reader :prioritize - - sig do - params( - prioritize: BrandDev::BrandScreenshotParams::Prioritize::OrSymbol - ).void - end - attr_writer :prioritize - - sig do - params( - direct_url: String, - domain: String, - full_screenshot: - BrandDev::BrandScreenshotParams::FullScreenshot::OrSymbol, - page: BrandDev::BrandScreenshotParams::Page::OrSymbol, - prioritize: BrandDev::BrandScreenshotParams::Prioritize::OrSymbol, - request_options: BrandDev::RequestOptions::OrHash - ).returns(T.attached_class) - end - def self.new( - # A specific URL to screenshot directly, bypassing domain resolution (e.g., - # 'https://example.com/pricing'). When provided, the screenshot is taken of this - # exact URL. - direct_url: nil, - # Domain name to take screenshot of (e.g., 'example.com', 'google.com'). The - # domain will be automatically normalized and validated. - domain: nil, - # Optional parameter to determine screenshot type. If 'true', takes a full page - # screenshot capturing all content. If 'false' or not provided, takes a viewport - # screenshot (standard browser view). - full_screenshot: nil, - # Optional parameter to specify which page type to screenshot. If provided, the - # system will scrape the domain's links and use heuristics to find the most - # appropriate URL for the specified page type (30 supported languages). If not - # provided, screenshots the main domain landing page. Only applicable when using - # 'domain', not 'directUrl'. - page: nil, - # Optional parameter to prioritize screenshot capture. If 'speed', optimizes for - # faster capture with basic quality. If 'quality', optimizes for higher quality - # with longer wait times. Defaults to 'quality' if not provided. - prioritize: nil, - request_options: {} - ) - end - - sig do - override.returns( - { - direct_url: String, - domain: String, - full_screenshot: - BrandDev::BrandScreenshotParams::FullScreenshot::OrSymbol, - page: BrandDev::BrandScreenshotParams::Page::OrSymbol, - prioritize: BrandDev::BrandScreenshotParams::Prioritize::OrSymbol, - request_options: BrandDev::RequestOptions - } - ) - end - def to_hash - end - - # Optional parameter to determine screenshot type. If 'true', takes a full page - # screenshot capturing all content. If 'false' or not provided, takes a viewport - # screenshot (standard browser view). - module FullScreenshot - extend BrandDev::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all(Symbol, BrandDev::BrandScreenshotParams::FullScreenshot) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - TRUE = - T.let( - :true, - BrandDev::BrandScreenshotParams::FullScreenshot::TaggedSymbol - ) - FALSE = - T.let( - :false, - BrandDev::BrandScreenshotParams::FullScreenshot::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - BrandDev::BrandScreenshotParams::FullScreenshot::TaggedSymbol - ] - ) - end - def self.values - end - end - - # Optional parameter to specify which page type to screenshot. If provided, the - # system will scrape the domain's links and use heuristics to find the most - # appropriate URL for the specified page type (30 supported languages). If not - # provided, screenshots the main domain landing page. Only applicable when using - # 'domain', not 'directUrl'. - module Page - extend BrandDev::Internal::Type::Enum - - TaggedSymbol = - T.type_alias { T.all(Symbol, BrandDev::BrandScreenshotParams::Page) } - OrSymbol = T.type_alias { T.any(Symbol, String) } - - LOGIN = - T.let(:login, BrandDev::BrandScreenshotParams::Page::TaggedSymbol) - SIGNUP = - T.let(:signup, BrandDev::BrandScreenshotParams::Page::TaggedSymbol) - BLOG = T.let(:blog, BrandDev::BrandScreenshotParams::Page::TaggedSymbol) - CAREERS = - T.let(:careers, BrandDev::BrandScreenshotParams::Page::TaggedSymbol) - PRICING = - T.let(:pricing, BrandDev::BrandScreenshotParams::Page::TaggedSymbol) - TERMS = - T.let(:terms, BrandDev::BrandScreenshotParams::Page::TaggedSymbol) - PRIVACY = - T.let(:privacy, BrandDev::BrandScreenshotParams::Page::TaggedSymbol) - CONTACT = - T.let(:contact, BrandDev::BrandScreenshotParams::Page::TaggedSymbol) - - sig do - override.returns( - T::Array[BrandDev::BrandScreenshotParams::Page::TaggedSymbol] - ) - end - def self.values - end - end - - # Optional parameter to prioritize screenshot capture. If 'speed', optimizes for - # faster capture with basic quality. If 'quality', optimizes for higher quality - # with longer wait times. Defaults to 'quality' if not provided. - module Prioritize - extend BrandDev::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all(Symbol, BrandDev::BrandScreenshotParams::Prioritize) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - SPEED = - T.let( - :speed, - BrandDev::BrandScreenshotParams::Prioritize::TaggedSymbol - ) - QUALITY = - T.let( - :quality, - BrandDev::BrandScreenshotParams::Prioritize::TaggedSymbol - ) - - sig do - override.returns( - T::Array[BrandDev::BrandScreenshotParams::Prioritize::TaggedSymbol] - ) - end - def self.values - end - end - end - end -end diff --git a/rbi/brand_dev/models/brand_screenshot_response.rbi b/rbi/brand_dev/models/brand_screenshot_response.rbi deleted file mode 100644 index 8e20c38..0000000 --- a/rbi/brand_dev/models/brand_screenshot_response.rbi +++ /dev/null @@ -1,135 +0,0 @@ -# typed: strong - -module BrandDev - module Models - class BrandScreenshotResponse < BrandDev::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - BrandDev::Models::BrandScreenshotResponse, - BrandDev::Internal::AnyHash - ) - end - - # HTTP status code - sig { returns(T.nilable(Integer)) } - attr_reader :code - - sig { params(code: Integer).void } - attr_writer :code - - # The normalized domain that was processed - sig { returns(T.nilable(String)) } - attr_reader :domain - - sig { params(domain: String).void } - attr_writer :domain - - # Public URL of the uploaded screenshot image - sig { returns(T.nilable(String)) } - attr_reader :screenshot - - sig { params(screenshot: String).void } - attr_writer :screenshot - - # Type of screenshot that was captured - sig do - returns( - T.nilable( - BrandDev::Models::BrandScreenshotResponse::ScreenshotType::TaggedSymbol - ) - ) - end - attr_reader :screenshot_type - - sig do - params( - screenshot_type: - BrandDev::Models::BrandScreenshotResponse::ScreenshotType::OrSymbol - ).void - end - attr_writer :screenshot_type - - # Status of the response, e.g., 'ok' - sig { returns(T.nilable(String)) } - attr_reader :status - - sig { params(status: String).void } - attr_writer :status - - sig do - params( - code: Integer, - domain: String, - screenshot: String, - screenshot_type: - BrandDev::Models::BrandScreenshotResponse::ScreenshotType::OrSymbol, - status: String - ).returns(T.attached_class) - end - def self.new( - # HTTP status code - code: nil, - # The normalized domain that was processed - domain: nil, - # Public URL of the uploaded screenshot image - screenshot: nil, - # Type of screenshot that was captured - screenshot_type: nil, - # Status of the response, e.g., 'ok' - status: nil - ) - end - - sig do - override.returns( - { - code: Integer, - domain: String, - screenshot: String, - screenshot_type: - BrandDev::Models::BrandScreenshotResponse::ScreenshotType::TaggedSymbol, - status: String - } - ) - end - def to_hash - end - - # Type of screenshot that was captured - module ScreenshotType - extend BrandDev::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - BrandDev::Models::BrandScreenshotResponse::ScreenshotType - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - VIEWPORT = - T.let( - :viewport, - BrandDev::Models::BrandScreenshotResponse::ScreenshotType::TaggedSymbol - ) - FULL_PAGE = - T.let( - :fullPage, - BrandDev::Models::BrandScreenshotResponse::ScreenshotType::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - BrandDev::Models::BrandScreenshotResponse::ScreenshotType::TaggedSymbol - ] - ) - end - def self.values - end - end - end - end -end diff --git a/rbi/brand_dev/resources/brand.rbi b/rbi/brand_dev/resources/brand.rbi index 1483067..34eee7c 100644 --- a/rbi/brand_dev/resources/brand.rbi +++ b/rbi/brand_dev/resources/brand.rbi @@ -376,48 +376,6 @@ module BrandDev ) end - # Capture a screenshot of a website. Supports both viewport (standard browser - # view) and full-page screenshots. Can also screenshot specific page types (login, - # pricing, etc.) by using heuristics to find the appropriate URL. Either 'domain' - # or 'directUrl' must be provided as a query parameter, but not both. Returns a - # URL to the uploaded screenshot image hosted on our CDN. - sig do - params( - direct_url: String, - domain: String, - full_screenshot: - BrandDev::BrandScreenshotParams::FullScreenshot::OrSymbol, - page: BrandDev::BrandScreenshotParams::Page::OrSymbol, - prioritize: BrandDev::BrandScreenshotParams::Prioritize::OrSymbol, - request_options: BrandDev::RequestOptions::OrHash - ).returns(BrandDev::Models::BrandScreenshotResponse) - end - def screenshot( - # A specific URL to screenshot directly, bypassing domain resolution (e.g., - # 'https://example.com/pricing'). When provided, the screenshot is taken of this - # exact URL. - direct_url: nil, - # Domain name to take screenshot of (e.g., 'example.com', 'google.com'). The - # domain will be automatically normalized and validated. - domain: nil, - # Optional parameter to determine screenshot type. If 'true', takes a full page - # screenshot capturing all content. If 'false' or not provided, takes a viewport - # screenshot (standard browser view). - full_screenshot: nil, - # Optional parameter to specify which page type to screenshot. If provided, the - # system will scrape the domain's links and use heuristics to find the most - # appropriate URL for the specified page type (30 supported languages). If not - # provided, screenshots the main domain landing page. Only applicable when using - # 'domain', not 'directUrl'. - page: nil, - # Optional parameter to prioritize screenshot capture. If 'speed', optimizes for - # faster capture with basic quality. If 'quality', optimizes for higher quality - # with longer wait times. Defaults to 'quality' if not provided. - prioritize: nil, - request_options: {} - ) - end - # Automatically extract comprehensive design system information from a brand's # website including colors, typography, spacing, shadows, and UI components. # Either 'domain' or 'directUrl' must be provided as a query parameter, but not diff --git a/sig/brand_dev/models.rbs b/sig/brand_dev/models.rbs index 12006f3..198ea36 100644 --- a/sig/brand_dev/models.rbs +++ b/sig/brand_dev/models.rbs @@ -25,8 +25,6 @@ module BrandDev class BrandRetrieveSimplifiedParams = BrandDev::Models::BrandRetrieveSimplifiedParams - class BrandScreenshotParams = BrandDev::Models::BrandScreenshotParams - class BrandStyleguideParams = BrandDev::Models::BrandStyleguideParams class BrandWebScrapeHTMLParams = BrandDev::Models::BrandWebScrapeHTMLParams diff --git a/sig/brand_dev/models/brand_screenshot_params.rbs b/sig/brand_dev/models/brand_screenshot_params.rbs deleted file mode 100644 index 711cecb..0000000 --- a/sig/brand_dev/models/brand_screenshot_params.rbs +++ /dev/null @@ -1,109 +0,0 @@ -module BrandDev - module Models - type brand_screenshot_params = - { - direct_url: String, - domain: String, - full_screenshot: BrandDev::Models::BrandScreenshotParams::full_screenshot, - page: BrandDev::Models::BrandScreenshotParams::page, - prioritize: BrandDev::Models::BrandScreenshotParams::prioritize - } - & BrandDev::Internal::Type::request_parameters - - class BrandScreenshotParams < BrandDev::Internal::Type::BaseModel - extend BrandDev::Internal::Type::RequestParameters::Converter - include BrandDev::Internal::Type::RequestParameters - - attr_reader direct_url: String? - - def direct_url=: (String) -> String - - attr_reader domain: String? - - def domain=: (String) -> String - - attr_reader full_screenshot: BrandDev::Models::BrandScreenshotParams::full_screenshot? - - def full_screenshot=: ( - BrandDev::Models::BrandScreenshotParams::full_screenshot - ) -> BrandDev::Models::BrandScreenshotParams::full_screenshot - - attr_reader page: BrandDev::Models::BrandScreenshotParams::page? - - def page=: ( - BrandDev::Models::BrandScreenshotParams::page - ) -> BrandDev::Models::BrandScreenshotParams::page - - attr_reader prioritize: BrandDev::Models::BrandScreenshotParams::prioritize? - - def prioritize=: ( - BrandDev::Models::BrandScreenshotParams::prioritize - ) -> BrandDev::Models::BrandScreenshotParams::prioritize - - def initialize: ( - ?direct_url: String, - ?domain: String, - ?full_screenshot: BrandDev::Models::BrandScreenshotParams::full_screenshot, - ?page: BrandDev::Models::BrandScreenshotParams::page, - ?prioritize: BrandDev::Models::BrandScreenshotParams::prioritize, - ?request_options: BrandDev::request_opts - ) -> void - - def to_hash: -> { - direct_url: String, - domain: String, - full_screenshot: BrandDev::Models::BrandScreenshotParams::full_screenshot, - page: BrandDev::Models::BrandScreenshotParams::page, - prioritize: BrandDev::Models::BrandScreenshotParams::prioritize, - request_options: BrandDev::RequestOptions - } - - type full_screenshot = :true | :false - - module FullScreenshot - extend BrandDev::Internal::Type::Enum - - TRUE: :true - FALSE: :false - - def self?.values: -> ::Array[BrandDev::Models::BrandScreenshotParams::full_screenshot] - end - - type page = - :login - | :signup - | :blog - | :careers - | :pricing - | :terms - | :privacy - | :contact - - module Page - extend BrandDev::Internal::Type::Enum - - LOGIN: :login - SIGNUP: :signup - BLOG: :blog - CAREERS: :careers - PRICING: :pricing - TERMS: :terms - PRIVACY: :privacy - CONTACT: :contact - - def self?.values: -> ::Array[BrandDev::Models::BrandScreenshotParams::page] - end - - type prioritize = :speed | :quality - - module Prioritize - extend BrandDev::Internal::Type::Enum - - SPEED: :speed - QUALITY: :quality - - def self?.values: -> ::Array[BrandDev::Models::BrandScreenshotParams::prioritize] - end - end - end -end diff --git a/sig/brand_dev/models/brand_screenshot_response.rbs b/sig/brand_dev/models/brand_screenshot_response.rbs deleted file mode 100644 index a0c17b9..0000000 --- a/sig/brand_dev/models/brand_screenshot_response.rbs +++ /dev/null @@ -1,63 +0,0 @@ -module BrandDev - module Models - type brand_screenshot_response = - { - code: Integer, - domain: String, - screenshot: String, - screenshot_type: BrandDev::Models::BrandScreenshotResponse::screenshot_type, - status: String - } - - class BrandScreenshotResponse < BrandDev::Internal::Type::BaseModel - attr_reader code: Integer? - - def code=: (Integer) -> Integer - - attr_reader domain: String? - - def domain=: (String) -> String - - attr_reader screenshot: String? - - def screenshot=: (String) -> String - - attr_reader screenshot_type: BrandDev::Models::BrandScreenshotResponse::screenshot_type? - - def screenshot_type=: ( - BrandDev::Models::BrandScreenshotResponse::screenshot_type - ) -> BrandDev::Models::BrandScreenshotResponse::screenshot_type - - attr_reader status: String? - - def status=: (String) -> String - - def initialize: ( - ?code: Integer, - ?domain: String, - ?screenshot: String, - ?screenshot_type: BrandDev::Models::BrandScreenshotResponse::screenshot_type, - ?status: String - ) -> void - - def to_hash: -> { - code: Integer, - domain: String, - screenshot: String, - screenshot_type: BrandDev::Models::BrandScreenshotResponse::screenshot_type, - status: String - } - - type screenshot_type = :viewport | :fullPage - - module ScreenshotType - extend BrandDev::Internal::Type::Enum - - VIEWPORT: :viewport - FULL_PAGE: :fullPage - - def self?.values: -> ::Array[BrandDev::Models::BrandScreenshotResponse::screenshot_type] - end - end - end -end diff --git a/sig/brand_dev/resources/brand.rbs b/sig/brand_dev/resources/brand.rbs index 23b2871..5a48d3b 100644 --- a/sig/brand_dev/resources/brand.rbs +++ b/sig/brand_dev/resources/brand.rbs @@ -101,15 +101,6 @@ module BrandDev ?request_options: BrandDev::request_opts ) -> BrandDev::Models::BrandRetrieveSimplifiedResponse - def screenshot: ( - ?direct_url: String, - ?domain: String, - ?full_screenshot: BrandDev::Models::BrandScreenshotParams::full_screenshot, - ?page: BrandDev::Models::BrandScreenshotParams::page, - ?prioritize: BrandDev::Models::BrandScreenshotParams::prioritize, - ?request_options: BrandDev::request_opts - ) -> BrandDev::Models::BrandScreenshotResponse - def styleguide: ( ?direct_url: String, ?domain: String, diff --git a/test/brand_dev/resources/brand_test.rb b/test/brand_dev/resources/brand_test.rb index c527210..e44ef74 100644 --- a/test/brand_dev/resources/brand_test.rb +++ b/test/brand_dev/resources/brand_test.rb @@ -248,26 +248,6 @@ def test_retrieve_simplified_required_params end end - def test_screenshot - skip("Mock server tests are disabled") - - response = @brand_dev.brand.screenshot - - assert_pattern do - response => BrandDev::Models::BrandScreenshotResponse - end - - assert_pattern do - response => { - code: Integer | nil, - domain: String | nil, - screenshot: String | nil, - screenshot_type: BrandDev::Models::BrandScreenshotResponse::ScreenshotType | nil, - status: String | nil - } - end - end - def test_styleguide skip("Mock server tests are disabled") From 5129523063458daca62963d01ff1837b54c9babf Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 17 Apr 2026 23:10:57 +0000 Subject: [PATCH 20/82] feat(api): api update --- .stats.yml | 6 +- lib/brand_dev.rb | 2 - lib/brand_dev/models.rb | 2 - .../models/brand_styleguide_params.rb | 45 - .../models/brand_styleguide_response.rb | 1107 ---------- lib/brand_dev/resources/brand.rb | 33 - rbi/brand_dev/models.rbi | 2 - .../models/brand_styleguide_params.rbi | 76 - .../models/brand_styleguide_response.rbi | 1785 ----------------- rbi/brand_dev/resources/brand.rbi | 27 - sig/brand_dev/models.rbs | 2 - .../models/brand_styleguide_params.rbs | 38 - .../models/brand_styleguide_response.rbs | 945 --------- sig/brand_dev/resources/brand.rbs | 7 - test/brand_dev/resources/brand_test.rb | 19 - 15 files changed, 3 insertions(+), 4093 deletions(-) delete mode 100644 lib/brand_dev/models/brand_styleguide_params.rb delete mode 100644 lib/brand_dev/models/brand_styleguide_response.rb delete mode 100644 rbi/brand_dev/models/brand_styleguide_params.rbi delete mode 100644 rbi/brand_dev/models/brand_styleguide_response.rbi delete mode 100644 sig/brand_dev/models/brand_styleguide_params.rbs delete mode 100644 sig/brand_dev/models/brand_styleguide_response.rbs diff --git a/.stats.yml b/.stats.yml index 0198e38..957b33f 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ -configured_endpoints: 18 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-73b75de3d3aae732e496f3828fc2c88711969e8abaae060d939da505f36cb3f8.yml -openapi_spec_hash: 30b5dacd44ef41592ba645033b3a1ca3 +configured_endpoints: 17 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-db86584e77523e133c60fce82fe9c3a4957efc0ad317fd0aed1b928c7f0b2f8a.yml +openapi_spec_hash: dfc39b2ad61ed889019ffe6fcb52bcce config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 diff --git a/lib/brand_dev.rb b/lib/brand_dev.rb index 98d3086..d3aeea3 100644 --- a/lib/brand_dev.rb +++ b/lib/brand_dev.rb @@ -78,8 +78,6 @@ require_relative "brand_dev/models/brand_retrieve_response" require_relative "brand_dev/models/brand_retrieve_simplified_params" require_relative "brand_dev/models/brand_retrieve_simplified_response" -require_relative "brand_dev/models/brand_styleguide_params" -require_relative "brand_dev/models/brand_styleguide_response" require_relative "brand_dev/models/brand_web_scrape_html_params" require_relative "brand_dev/models/brand_web_scrape_html_response" require_relative "brand_dev/models/brand_web_scrape_images_params" diff --git a/lib/brand_dev/models.rb b/lib/brand_dev/models.rb index 8c2242b..d4b560b 100644 --- a/lib/brand_dev/models.rb +++ b/lib/brand_dev/models.rb @@ -65,8 +65,6 @@ module BrandDev BrandRetrieveSimplifiedParams = BrandDev::Models::BrandRetrieveSimplifiedParams - BrandStyleguideParams = BrandDev::Models::BrandStyleguideParams - BrandWebScrapeHTMLParams = BrandDev::Models::BrandWebScrapeHTMLParams BrandWebScrapeImagesParams = BrandDev::Models::BrandWebScrapeImagesParams diff --git a/lib/brand_dev/models/brand_styleguide_params.rb b/lib/brand_dev/models/brand_styleguide_params.rb deleted file mode 100644 index 1bfa838..0000000 --- a/lib/brand_dev/models/brand_styleguide_params.rb +++ /dev/null @@ -1,45 +0,0 @@ -# frozen_string_literal: true - -module BrandDev - module Models - # @see BrandDev::Resources::Brand#styleguide - class BrandStyleguideParams < BrandDev::Internal::Type::BaseModel - extend BrandDev::Internal::Type::RequestParameters::Converter - include BrandDev::Internal::Type::RequestParameters - - # @!attribute direct_url - # A specific URL to fetch the styleguide from directly, bypassing domain - # resolution (e.g., 'https://example.com/design-system'). - # - # @return [String, nil] - optional :direct_url, String - - # @!attribute domain - # Domain name to extract styleguide from (e.g., 'example.com', 'google.com'). The - # domain will be automatically normalized and validated. - # - # @return [String, nil] - optional :domain, String - - # @!attribute timeout_ms - # Optional timeout in milliseconds for the request. If the request takes longer - # than this value, it will be aborted with a 408 status code. Maximum allowed - # value is 300000ms (5 minutes). - # - # @return [Integer, nil] - optional :timeout_ms, Integer - - # @!method initialize(direct_url: nil, domain: nil, timeout_ms: nil, request_options: {}) - # Some parameter documentations has been truncated, see - # {BrandDev::Models::BrandStyleguideParams} for more details. - # - # @param direct_url [String] A specific URL to fetch the styleguide from directly, bypassing domain resolutio - # - # @param domain [String] Domain name to extract styleguide from (e.g., 'example.com', 'google.com'). The - # - # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th - # - # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}] - end - end -end diff --git a/lib/brand_dev/models/brand_styleguide_response.rb b/lib/brand_dev/models/brand_styleguide_response.rb deleted file mode 100644 index 0bd706b..0000000 --- a/lib/brand_dev/models/brand_styleguide_response.rb +++ /dev/null @@ -1,1107 +0,0 @@ -# frozen_string_literal: true - -module BrandDev - module Models - # @see BrandDev::Resources::Brand#styleguide - class BrandStyleguideResponse < BrandDev::Internal::Type::BaseModel - # @!attribute code - # HTTP status code - # - # @return [Integer, nil] - optional :code, Integer - - # @!attribute domain - # The normalized domain that was processed - # - # @return [String, nil] - optional :domain, String - - # @!attribute status - # Status of the response, e.g., 'ok' - # - # @return [String, nil] - optional :status, String - - # @!attribute styleguide - # Comprehensive styleguide data extracted from the website - # - # @return [BrandDev::Models::BrandStyleguideResponse::Styleguide, nil] - optional :styleguide, -> { BrandDev::Models::BrandStyleguideResponse::Styleguide } - - # @!method initialize(code: nil, domain: nil, status: nil, styleguide: nil) - # @param code [Integer] HTTP status code - # - # @param domain [String] The normalized domain that was processed - # - # @param status [String] Status of the response, e.g., 'ok' - # - # @param styleguide [BrandDev::Models::BrandStyleguideResponse::Styleguide] Comprehensive styleguide data extracted from the website - - # @see BrandDev::Models::BrandStyleguideResponse#styleguide - class Styleguide < BrandDev::Internal::Type::BaseModel - # @!attribute colors - # Primary colors used on the website - # - # @return [BrandDev::Models::BrandStyleguideResponse::Styleguide::Colors] - required :colors, -> { BrandDev::Models::BrandStyleguideResponse::Styleguide::Colors } - - # @!attribute components - # UI component styles - # - # @return [BrandDev::Models::BrandStyleguideResponse::Styleguide::Components] - required :components, -> { BrandDev::Models::BrandStyleguideResponse::Styleguide::Components } - - # @!attribute element_spacing - # Spacing system used on the website - # - # @return [BrandDev::Models::BrandStyleguideResponse::Styleguide::ElementSpacing] - required :element_spacing, - -> { BrandDev::Models::BrandStyleguideResponse::Styleguide::ElementSpacing }, - api_name: :elementSpacing - - # @!attribute font_links - # Font assets keyed by family name as it appears in fontFamily/fontFallbacks - # (non-generic names only). Clients match typography.fontFamily / fontWeight or - # button styles to pick a file URL from files. - # - # @return [Hash{Symbol=>BrandDev::Models::BrandStyleguideResponse::Styleguide::FontLink}] - required :font_links, - -> { BrandDev::Internal::Type::HashOf[BrandDev::Models::BrandStyleguideResponse::Styleguide::FontLink] }, - api_name: :fontLinks - - # @!attribute mode - # The primary color mode of the website design - # - # @return [Symbol, BrandDev::Models::BrandStyleguideResponse::Styleguide::Mode] - required :mode, enum: -> { BrandDev::Models::BrandStyleguideResponse::Styleguide::Mode } - - # @!attribute shadows - # Shadow styles used on the website - # - # @return [BrandDev::Models::BrandStyleguideResponse::Styleguide::Shadows] - required :shadows, -> { BrandDev::Models::BrandStyleguideResponse::Styleguide::Shadows } - - # @!attribute typography - # Typography styles used on the website - # - # @return [BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography] - required :typography, -> { BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography } - - # @!method initialize(colors:, components:, element_spacing:, font_links:, mode:, shadows:, typography:) - # Some parameter documentations has been truncated, see - # {BrandDev::Models::BrandStyleguideResponse::Styleguide} for more details. - # - # Comprehensive styleguide data extracted from the website - # - # @param colors [BrandDev::Models::BrandStyleguideResponse::Styleguide::Colors] Primary colors used on the website - # - # @param components [BrandDev::Models::BrandStyleguideResponse::Styleguide::Components] UI component styles - # - # @param element_spacing [BrandDev::Models::BrandStyleguideResponse::Styleguide::ElementSpacing] Spacing system used on the website - # - # @param font_links [Hash{Symbol=>BrandDev::Models::BrandStyleguideResponse::Styleguide::FontLink}] Font assets keyed by family name as it appears in fontFamily/fontFallbacks (non- - # - # @param mode [Symbol, BrandDev::Models::BrandStyleguideResponse::Styleguide::Mode] The primary color mode of the website design - # - # @param shadows [BrandDev::Models::BrandStyleguideResponse::Styleguide::Shadows] Shadow styles used on the website - # - # @param typography [BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography] Typography styles used on the website - - # @see BrandDev::Models::BrandStyleguideResponse::Styleguide#colors - class Colors < BrandDev::Internal::Type::BaseModel - # @!attribute accent - # Accent color (hex format) - # - # @return [String] - required :accent, String - - # @!attribute background - # Background color (hex format) - # - # @return [String] - required :background, String - - # @!attribute text - # Text color (hex format) - # - # @return [String] - required :text, String - - # @!method initialize(accent:, background:, text:) - # Primary colors used on the website - # - # @param accent [String] Accent color (hex format) - # - # @param background [String] Background color (hex format) - # - # @param text [String] Text color (hex format) - end - - # @see BrandDev::Models::BrandStyleguideResponse::Styleguide#components - class Components < BrandDev::Internal::Type::BaseModel - # @!attribute button - # Button component styles - # - # @return [BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button] - required :button, -> { BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button } - - # @!attribute card - # Card component style - # - # @return [BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Card, nil] - optional :card, -> { BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Card } - - # @!method initialize(button:, card: nil) - # UI component styles - # - # @param button [BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button] Button component styles - # - # @param card [BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Card] Card component style - - # @see BrandDev::Models::BrandStyleguideResponse::Styleguide::Components#button - class Button < BrandDev::Internal::Type::BaseModel - # @!attribute link - # - # @return [BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Link, nil] - optional :link, -> { BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Link } - - # @!attribute primary - # - # @return [BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Primary, nil] - optional :primary, - -> { BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Primary } - - # @!attribute secondary - # - # @return [BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Secondary, nil] - optional :secondary, - -> { BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Secondary } - - # @!method initialize(link: nil, primary: nil, secondary: nil) - # Button component styles - # - # @param link [BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Link] - # @param primary [BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Primary] - # @param secondary [BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Secondary] - - # @see BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button#link - class Link < BrandDev::Internal::Type::BaseModel - # @!attribute background_color - # - # @return [String] - required :background_color, String, api_name: :backgroundColor - - # @!attribute border_color - # Border color as CSS hex (#RRGGBB or #RRGGBBAA when computed border-color has - # alpha) - # - # @return [String] - required :border_color, String, api_name: :borderColor - - # @!attribute border_radius - # - # @return [String] - required :border_radius, String, api_name: :borderRadius - - # @!attribute border_style - # - # @return [String] - required :border_style, String, api_name: :borderStyle - - # @!attribute border_width - # - # @return [String] - required :border_width, String, api_name: :borderWidth - - # @!attribute box_shadow - # Computed box-shadow (comma-separated layers when present) - # - # @return [String] - required :box_shadow, String, api_name: :boxShadow - - # @!attribute color - # - # @return [String] - required :color, String - - # @!attribute css - # Ready-to-use CSS declaration block for this component style - # - # @return [String] - required :css, String - - # @!attribute font_size - # - # @return [String] - required :font_size, String, api_name: :fontSize - - # @!attribute font_weight - # - # @return [Float] - required :font_weight, Float, api_name: :fontWeight - - # @!attribute min_height - # Sampled minimum height of the button box (typically px) - # - # @return [String] - required :min_height, String, api_name: :minHeight - - # @!attribute min_width - # Sampled minimum width of the button box (typically px) - # - # @return [String] - required :min_width, String, api_name: :minWidth - - # @!attribute padding - # - # @return [String] - required :padding, String - - # @!attribute text_decoration - # - # @return [String] - required :text_decoration, String, api_name: :textDecoration - - # @!attribute font_fallbacks - # Full ordered font list from computed font-family - # - # @return [Array, nil] - optional :font_fallbacks, BrandDev::Internal::Type::ArrayOf[String], api_name: :fontFallbacks - - # @!attribute font_family - # Primary button typeface (first in fontFallbacks) - # - # @return [String, nil] - optional :font_family, String, api_name: :fontFamily - - # @!attribute text_decoration_color - # Hex color of the underline when it differs from the text color - # - # @return [String, nil] - optional :text_decoration_color, String, api_name: :textDecorationColor - - # @!method initialize(background_color:, border_color:, border_radius:, border_style:, border_width:, box_shadow:, color:, css:, font_size:, font_weight:, min_height:, min_width:, padding:, text_decoration:, font_fallbacks: nil, font_family: nil, text_decoration_color: nil) - # Some parameter documentations has been truncated, see - # {BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Link} - # for more details. - # - # @param background_color [String] - # - # @param border_color [String] Border color as CSS hex (#RRGGBB or #RRGGBBAA when computed border-color has alp - # - # @param border_radius [String] - # - # @param border_style [String] - # - # @param border_width [String] - # - # @param box_shadow [String] Computed box-shadow (comma-separated layers when present) - # - # @param color [String] - # - # @param css [String] Ready-to-use CSS declaration block for this component style - # - # @param font_size [String] - # - # @param font_weight [Float] - # - # @param min_height [String] Sampled minimum height of the button box (typically px) - # - # @param min_width [String] Sampled minimum width of the button box (typically px) - # - # @param padding [String] - # - # @param text_decoration [String] - # - # @param font_fallbacks [Array] Full ordered font list from computed font-family - # - # @param font_family [String] Primary button typeface (first in fontFallbacks) - # - # @param text_decoration_color [String] Hex color of the underline when it differs from the text color - end - - # @see BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button#primary - class Primary < BrandDev::Internal::Type::BaseModel - # @!attribute background_color - # - # @return [String] - required :background_color, String, api_name: :backgroundColor - - # @!attribute border_color - # Border color as CSS hex (#RRGGBB or #RRGGBBAA when computed border-color has - # alpha) - # - # @return [String] - required :border_color, String, api_name: :borderColor - - # @!attribute border_radius - # - # @return [String] - required :border_radius, String, api_name: :borderRadius - - # @!attribute border_style - # - # @return [String] - required :border_style, String, api_name: :borderStyle - - # @!attribute border_width - # - # @return [String] - required :border_width, String, api_name: :borderWidth - - # @!attribute box_shadow - # Computed box-shadow (comma-separated layers when present) - # - # @return [String] - required :box_shadow, String, api_name: :boxShadow - - # @!attribute color - # - # @return [String] - required :color, String - - # @!attribute css - # Ready-to-use CSS declaration block for this component style - # - # @return [String] - required :css, String - - # @!attribute font_size - # - # @return [String] - required :font_size, String, api_name: :fontSize - - # @!attribute font_weight - # - # @return [Float] - required :font_weight, Float, api_name: :fontWeight - - # @!attribute min_height - # Sampled minimum height of the button box (typically px) - # - # @return [String] - required :min_height, String, api_name: :minHeight - - # @!attribute min_width - # Sampled minimum width of the button box (typically px) - # - # @return [String] - required :min_width, String, api_name: :minWidth - - # @!attribute padding - # - # @return [String] - required :padding, String - - # @!attribute text_decoration - # - # @return [String] - required :text_decoration, String, api_name: :textDecoration - - # @!attribute font_fallbacks - # Full ordered font list from computed font-family - # - # @return [Array, nil] - optional :font_fallbacks, BrandDev::Internal::Type::ArrayOf[String], api_name: :fontFallbacks - - # @!attribute font_family - # Primary button typeface (first in fontFallbacks) - # - # @return [String, nil] - optional :font_family, String, api_name: :fontFamily - - # @!attribute text_decoration_color - # Hex color of the underline when it differs from the text color - # - # @return [String, nil] - optional :text_decoration_color, String, api_name: :textDecorationColor - - # @!method initialize(background_color:, border_color:, border_radius:, border_style:, border_width:, box_shadow:, color:, css:, font_size:, font_weight:, min_height:, min_width:, padding:, text_decoration:, font_fallbacks: nil, font_family: nil, text_decoration_color: nil) - # Some parameter documentations has been truncated, see - # {BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Primary} - # for more details. - # - # @param background_color [String] - # - # @param border_color [String] Border color as CSS hex (#RRGGBB or #RRGGBBAA when computed border-color has alp - # - # @param border_radius [String] - # - # @param border_style [String] - # - # @param border_width [String] - # - # @param box_shadow [String] Computed box-shadow (comma-separated layers when present) - # - # @param color [String] - # - # @param css [String] Ready-to-use CSS declaration block for this component style - # - # @param font_size [String] - # - # @param font_weight [Float] - # - # @param min_height [String] Sampled minimum height of the button box (typically px) - # - # @param min_width [String] Sampled minimum width of the button box (typically px) - # - # @param padding [String] - # - # @param text_decoration [String] - # - # @param font_fallbacks [Array] Full ordered font list from computed font-family - # - # @param font_family [String] Primary button typeface (first in fontFallbacks) - # - # @param text_decoration_color [String] Hex color of the underline when it differs from the text color - end - - # @see BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button#secondary - class Secondary < BrandDev::Internal::Type::BaseModel - # @!attribute background_color - # - # @return [String] - required :background_color, String, api_name: :backgroundColor - - # @!attribute border_color - # Border color as CSS hex (#RRGGBB or #RRGGBBAA when computed border-color has - # alpha) - # - # @return [String] - required :border_color, String, api_name: :borderColor - - # @!attribute border_radius - # - # @return [String] - required :border_radius, String, api_name: :borderRadius - - # @!attribute border_style - # - # @return [String] - required :border_style, String, api_name: :borderStyle - - # @!attribute border_width - # - # @return [String] - required :border_width, String, api_name: :borderWidth - - # @!attribute box_shadow - # Computed box-shadow (comma-separated layers when present) - # - # @return [String] - required :box_shadow, String, api_name: :boxShadow - - # @!attribute color - # - # @return [String] - required :color, String - - # @!attribute css - # Ready-to-use CSS declaration block for this component style - # - # @return [String] - required :css, String - - # @!attribute font_size - # - # @return [String] - required :font_size, String, api_name: :fontSize - - # @!attribute font_weight - # - # @return [Float] - required :font_weight, Float, api_name: :fontWeight - - # @!attribute min_height - # Sampled minimum height of the button box (typically px) - # - # @return [String] - required :min_height, String, api_name: :minHeight - - # @!attribute min_width - # Sampled minimum width of the button box (typically px) - # - # @return [String] - required :min_width, String, api_name: :minWidth - - # @!attribute padding - # - # @return [String] - required :padding, String - - # @!attribute text_decoration - # - # @return [String] - required :text_decoration, String, api_name: :textDecoration - - # @!attribute font_fallbacks - # Full ordered font list from computed font-family - # - # @return [Array, nil] - optional :font_fallbacks, BrandDev::Internal::Type::ArrayOf[String], api_name: :fontFallbacks - - # @!attribute font_family - # Primary button typeface (first in fontFallbacks) - # - # @return [String, nil] - optional :font_family, String, api_name: :fontFamily - - # @!attribute text_decoration_color - # Hex color of the underline when it differs from the text color - # - # @return [String, nil] - optional :text_decoration_color, String, api_name: :textDecorationColor - - # @!method initialize(background_color:, border_color:, border_radius:, border_style:, border_width:, box_shadow:, color:, css:, font_size:, font_weight:, min_height:, min_width:, padding:, text_decoration:, font_fallbacks: nil, font_family: nil, text_decoration_color: nil) - # Some parameter documentations has been truncated, see - # {BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Secondary} - # for more details. - # - # @param background_color [String] - # - # @param border_color [String] Border color as CSS hex (#RRGGBB or #RRGGBBAA when computed border-color has alp - # - # @param border_radius [String] - # - # @param border_style [String] - # - # @param border_width [String] - # - # @param box_shadow [String] Computed box-shadow (comma-separated layers when present) - # - # @param color [String] - # - # @param css [String] Ready-to-use CSS declaration block for this component style - # - # @param font_size [String] - # - # @param font_weight [Float] - # - # @param min_height [String] Sampled minimum height of the button box (typically px) - # - # @param min_width [String] Sampled minimum width of the button box (typically px) - # - # @param padding [String] - # - # @param text_decoration [String] - # - # @param font_fallbacks [Array] Full ordered font list from computed font-family - # - # @param font_family [String] Primary button typeface (first in fontFallbacks) - # - # @param text_decoration_color [String] Hex color of the underline when it differs from the text color - end - end - - # @see BrandDev::Models::BrandStyleguideResponse::Styleguide::Components#card - class Card < BrandDev::Internal::Type::BaseModel - # @!attribute background_color - # - # @return [String] - required :background_color, String, api_name: :backgroundColor - - # @!attribute border_color - # Border color as CSS hex (#RRGGBB or #RRGGBBAA when computed border-color has - # alpha) - # - # @return [String] - required :border_color, String, api_name: :borderColor - - # @!attribute border_radius - # - # @return [String] - required :border_radius, String, api_name: :borderRadius - - # @!attribute border_style - # - # @return [String] - required :border_style, String, api_name: :borderStyle - - # @!attribute border_width - # - # @return [String] - required :border_width, String, api_name: :borderWidth - - # @!attribute box_shadow - # - # @return [String] - required :box_shadow, String, api_name: :boxShadow - - # @!attribute css - # Ready-to-use CSS declaration block for this component style - # - # @return [String] - required :css, String - - # @!attribute padding - # - # @return [String] - required :padding, String - - # @!attribute text_color - # - # @return [String] - required :text_color, String, api_name: :textColor - - # @!method initialize(background_color:, border_color:, border_radius:, border_style:, border_width:, box_shadow:, css:, padding:, text_color:) - # Some parameter documentations has been truncated, see - # {BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Card} for - # more details. - # - # Card component style - # - # @param background_color [String] - # - # @param border_color [String] Border color as CSS hex (#RRGGBB or #RRGGBBAA when computed border-color has alp - # - # @param border_radius [String] - # - # @param border_style [String] - # - # @param border_width [String] - # - # @param box_shadow [String] - # - # @param css [String] Ready-to-use CSS declaration block for this component style - # - # @param padding [String] - # - # @param text_color [String] - end - end - - # @see BrandDev::Models::BrandStyleguideResponse::Styleguide#element_spacing - class ElementSpacing < BrandDev::Internal::Type::BaseModel - # @!attribute lg - # - # @return [String] - required :lg, String - - # @!attribute md - # - # @return [String] - required :md, String - - # @!attribute sm - # - # @return [String] - required :sm, String - - # @!attribute xl - # - # @return [String] - required :xl, String - - # @!attribute xs - # - # @return [String] - required :xs, String - - # @!method initialize(lg:, md:, sm:, xl:, xs:) - # Spacing system used on the website - # - # @param lg [String] - # @param md [String] - # @param sm [String] - # @param xl [String] - # @param xs [String] - end - - class FontLink < BrandDev::Internal::Type::BaseModel - # @!attribute files - # Upright font files keyed by weight string (e.g. "400" for regular, "500", - # "700"). Values are absolute URLs. - # - # @return [Hash{Symbol=>String}] - required :files, BrandDev::Internal::Type::HashOf[String] - - # @!attribute type - # - # @return [Symbol, BrandDev::Models::BrandStyleguideResponse::Styleguide::FontLink::Type] - required :type, enum: -> { BrandDev::Models::BrandStyleguideResponse::Styleguide::FontLink::Type } - - # @!attribute category - # Google Fonts category when type is google (e.g. sans-serif, serif, monospace, - # display, handwriting). Omitted for custom fonts when unknown. - # - # @return [String, nil] - optional :category, String - - # @!attribute display_name - # Present when type is custom: human-readable name derived from the fontLinks key - # (strip build/hash suffixes, split camelCase / PascalCase, normalize separators). - # Google entries omit this. - # - # @return [String, nil] - optional :display_name, String, api_name: :displayName - - # @!method initialize(files:, type:, category: nil, display_name: nil) - # Some parameter documentations has been truncated, see - # {BrandDev::Models::BrandStyleguideResponse::Styleguide::FontLink} for more - # details. - # - # @param files [Hash{Symbol=>String}] Upright font files keyed by weight string (e.g. "400" for regular, "500", "700") - # - # @param type [Symbol, BrandDev::Models::BrandStyleguideResponse::Styleguide::FontLink::Type] - # - # @param category [String] Google Fonts category when type is google (e.g. sans-serif, serif, monospace, di - # - # @param display_name [String] Present when type is custom: human-readable name derived from the fontLinks key - - # @see BrandDev::Models::BrandStyleguideResponse::Styleguide::FontLink#type - module Type - extend BrandDev::Internal::Type::Enum - - GOOGLE = :google - CUSTOM = :custom - - # @!method self.values - # @return [Array] - end - end - - # The primary color mode of the website design - # - # @see BrandDev::Models::BrandStyleguideResponse::Styleguide#mode - module Mode - extend BrandDev::Internal::Type::Enum - - LIGHT = :light - DARK = :dark - - # @!method self.values - # @return [Array] - end - - # @see BrandDev::Models::BrandStyleguideResponse::Styleguide#shadows - class Shadows < BrandDev::Internal::Type::BaseModel - # @!attribute inner - # - # @return [String] - required :inner, String - - # @!attribute lg - # - # @return [String] - required :lg, String - - # @!attribute md - # - # @return [String] - required :md, String - - # @!attribute sm - # - # @return [String] - required :sm, String - - # @!attribute xl - # - # @return [String] - required :xl, String - - # @!method initialize(inner:, lg:, md:, sm:, xl:) - # Shadow styles used on the website - # - # @param inner [String] - # @param lg [String] - # @param md [String] - # @param sm [String] - # @param xl [String] - end - - # @see BrandDev::Models::BrandStyleguideResponse::Styleguide#typography - class Typography < BrandDev::Internal::Type::BaseModel - # @!attribute headings - # Heading styles - # - # @return [BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings] - required :headings, -> { BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings } - - # @!attribute p_ - # - # @return [BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::P, nil] - optional :p_, -> { BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::P }, api_name: :p - - # @!method initialize(headings:, p_: nil) - # Typography styles used on the website - # - # @param headings [BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings] Heading styles - # - # @param p_ [BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::P] - - # @see BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography#headings - class Headings < BrandDev::Internal::Type::BaseModel - # @!attribute h1 - # - # @return [BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H1, nil] - optional :h1, -> { BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H1 } - - # @!attribute h2 - # - # @return [BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H2, nil] - optional :h2, -> { BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H2 } - - # @!attribute h3 - # - # @return [BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H3, nil] - optional :h3, -> { BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H3 } - - # @!attribute h4 - # - # @return [BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H4, nil] - optional :h4, -> { BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H4 } - - # @!method initialize(h1: nil, h2: nil, h3: nil, h4: nil) - # Heading styles - # - # @param h1 [BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H1] - # @param h2 [BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H2] - # @param h3 [BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H3] - # @param h4 [BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H4] - - # @see BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings#h1 - class H1 < BrandDev::Internal::Type::BaseModel - # @!attribute font_fallbacks - # Full ordered font list from resolved computed font-family - # - # @return [Array] - required :font_fallbacks, BrandDev::Internal::Type::ArrayOf[String], api_name: :fontFallbacks - - # @!attribute font_family - # Primary face (first family in the computed stack) - # - # @return [String] - required :font_family, String, api_name: :fontFamily - - # @!attribute font_size - # - # @return [String] - required :font_size, String, api_name: :fontSize - - # @!attribute font_weight - # - # @return [Float] - required :font_weight, Float, api_name: :fontWeight - - # @!attribute letter_spacing - # - # @return [String] - required :letter_spacing, String, api_name: :letterSpacing - - # @!attribute line_height - # - # @return [String] - required :line_height, String, api_name: :lineHeight - - # @!method initialize(font_fallbacks:, font_family:, font_size:, font_weight:, letter_spacing:, line_height:) - # @param font_fallbacks [Array] Full ordered font list from resolved computed font-family - # - # @param font_family [String] Primary face (first family in the computed stack) - # - # @param font_size [String] - # - # @param font_weight [Float] - # - # @param letter_spacing [String] - # - # @param line_height [String] - end - - # @see BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings#h2 - class H2 < BrandDev::Internal::Type::BaseModel - # @!attribute font_fallbacks - # Full ordered font list from resolved computed font-family - # - # @return [Array] - required :font_fallbacks, BrandDev::Internal::Type::ArrayOf[String], api_name: :fontFallbacks - - # @!attribute font_family - # Primary face (first family in the computed stack) - # - # @return [String] - required :font_family, String, api_name: :fontFamily - - # @!attribute font_size - # - # @return [String] - required :font_size, String, api_name: :fontSize - - # @!attribute font_weight - # - # @return [Float] - required :font_weight, Float, api_name: :fontWeight - - # @!attribute letter_spacing - # - # @return [String] - required :letter_spacing, String, api_name: :letterSpacing - - # @!attribute line_height - # - # @return [String] - required :line_height, String, api_name: :lineHeight - - # @!method initialize(font_fallbacks:, font_family:, font_size:, font_weight:, letter_spacing:, line_height:) - # @param font_fallbacks [Array] Full ordered font list from resolved computed font-family - # - # @param font_family [String] Primary face (first family in the computed stack) - # - # @param font_size [String] - # - # @param font_weight [Float] - # - # @param letter_spacing [String] - # - # @param line_height [String] - end - - # @see BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings#h3 - class H3 < BrandDev::Internal::Type::BaseModel - # @!attribute font_fallbacks - # Full ordered font list from resolved computed font-family - # - # @return [Array] - required :font_fallbacks, BrandDev::Internal::Type::ArrayOf[String], api_name: :fontFallbacks - - # @!attribute font_family - # Primary face (first family in the computed stack) - # - # @return [String] - required :font_family, String, api_name: :fontFamily - - # @!attribute font_size - # - # @return [String] - required :font_size, String, api_name: :fontSize - - # @!attribute font_weight - # - # @return [Float] - required :font_weight, Float, api_name: :fontWeight - - # @!attribute letter_spacing - # - # @return [String] - required :letter_spacing, String, api_name: :letterSpacing - - # @!attribute line_height - # - # @return [String] - required :line_height, String, api_name: :lineHeight - - # @!method initialize(font_fallbacks:, font_family:, font_size:, font_weight:, letter_spacing:, line_height:) - # @param font_fallbacks [Array] Full ordered font list from resolved computed font-family - # - # @param font_family [String] Primary face (first family in the computed stack) - # - # @param font_size [String] - # - # @param font_weight [Float] - # - # @param letter_spacing [String] - # - # @param line_height [String] - end - - # @see BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings#h4 - class H4 < BrandDev::Internal::Type::BaseModel - # @!attribute font_fallbacks - # Full ordered font list from resolved computed font-family - # - # @return [Array] - required :font_fallbacks, BrandDev::Internal::Type::ArrayOf[String], api_name: :fontFallbacks - - # @!attribute font_family - # Primary face (first family in the computed stack) - # - # @return [String] - required :font_family, String, api_name: :fontFamily - - # @!attribute font_size - # - # @return [String] - required :font_size, String, api_name: :fontSize - - # @!attribute font_weight - # - # @return [Float] - required :font_weight, Float, api_name: :fontWeight - - # @!attribute letter_spacing - # - # @return [String] - required :letter_spacing, String, api_name: :letterSpacing - - # @!attribute line_height - # - # @return [String] - required :line_height, String, api_name: :lineHeight - - # @!method initialize(font_fallbacks:, font_family:, font_size:, font_weight:, letter_spacing:, line_height:) - # @param font_fallbacks [Array] Full ordered font list from resolved computed font-family - # - # @param font_family [String] Primary face (first family in the computed stack) - # - # @param font_size [String] - # - # @param font_weight [Float] - # - # @param letter_spacing [String] - # - # @param line_height [String] - end - end - - # @see BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography#p_ - class P < BrandDev::Internal::Type::BaseModel - # @!attribute font_fallbacks - # Full ordered font list from resolved computed font-family - # - # @return [Array] - required :font_fallbacks, BrandDev::Internal::Type::ArrayOf[String], api_name: :fontFallbacks - - # @!attribute font_family - # Primary face (first family in the computed stack) - # - # @return [String] - required :font_family, String, api_name: :fontFamily - - # @!attribute font_size - # - # @return [String] - required :font_size, String, api_name: :fontSize - - # @!attribute font_weight - # - # @return [Float] - required :font_weight, Float, api_name: :fontWeight - - # @!attribute letter_spacing - # - # @return [String] - required :letter_spacing, String, api_name: :letterSpacing - - # @!attribute line_height - # - # @return [String] - required :line_height, String, api_name: :lineHeight - - # @!method initialize(font_fallbacks:, font_family:, font_size:, font_weight:, letter_spacing:, line_height:) - # @param font_fallbacks [Array] Full ordered font list from resolved computed font-family - # - # @param font_family [String] Primary face (first family in the computed stack) - # - # @param font_size [String] - # - # @param font_weight [Float] - # - # @param letter_spacing [String] - # - # @param line_height [String] - end - end - end - end - end -end diff --git a/lib/brand_dev/resources/brand.rb b/lib/brand_dev/resources/brand.rb index 76c9ecf..8c97a4d 100644 --- a/lib/brand_dev/resources/brand.rb +++ b/lib/brand_dev/resources/brand.rb @@ -431,39 +431,6 @@ def retrieve_simplified(params) ) end - # Some parameter documentations has been truncated, see - # {BrandDev::Models::BrandStyleguideParams} for more details. - # - # Automatically extract comprehensive design system information from a brand's - # website including colors, typography, spacing, shadows, and UI components. - # Either 'domain' or 'directUrl' must be provided as a query parameter, but not - # both. - # - # @overload styleguide(direct_url: nil, domain: nil, timeout_ms: nil, request_options: {}) - # - # @param direct_url [String] A specific URL to fetch the styleguide from directly, bypassing domain resolutio - # - # @param domain [String] Domain name to extract styleguide from (e.g., 'example.com', 'google.com'). The - # - # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th - # - # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}, nil] - # - # @return [BrandDev::Models::BrandStyleguideResponse] - # - # @see BrandDev::Models::BrandStyleguideParams - def styleguide(params = {}) - parsed, options = BrandDev::BrandStyleguideParams.dump_request(params) - query = BrandDev::Internal::Util.encode_query_params(parsed) - @client.request( - method: :get, - path: "brand/styleguide", - query: query.transform_keys(direct_url: "directUrl", timeout_ms: "timeoutMS"), - model: BrandDev::Models::BrandStyleguideResponse, - options: options - ) - end - # Some parameter documentations has been truncated, see # {BrandDev::Models::BrandWebScrapeHTMLParams} for more details. # diff --git a/rbi/brand_dev/models.rbi b/rbi/brand_dev/models.rbi index f6e9101..cc9e1a6 100644 --- a/rbi/brand_dev/models.rbi +++ b/rbi/brand_dev/models.rbi @@ -29,8 +29,6 @@ module BrandDev BrandRetrieveSimplifiedParams = BrandDev::Models::BrandRetrieveSimplifiedParams - BrandStyleguideParams = BrandDev::Models::BrandStyleguideParams - BrandWebScrapeHTMLParams = BrandDev::Models::BrandWebScrapeHTMLParams BrandWebScrapeImagesParams = BrandDev::Models::BrandWebScrapeImagesParams diff --git a/rbi/brand_dev/models/brand_styleguide_params.rbi b/rbi/brand_dev/models/brand_styleguide_params.rbi deleted file mode 100644 index d38bf66..0000000 --- a/rbi/brand_dev/models/brand_styleguide_params.rbi +++ /dev/null @@ -1,76 +0,0 @@ -# typed: strong - -module BrandDev - module Models - class BrandStyleguideParams < BrandDev::Internal::Type::BaseModel - extend BrandDev::Internal::Type::RequestParameters::Converter - include BrandDev::Internal::Type::RequestParameters - - OrHash = - T.type_alias do - T.any(BrandDev::BrandStyleguideParams, BrandDev::Internal::AnyHash) - end - - # A specific URL to fetch the styleguide from directly, bypassing domain - # resolution (e.g., 'https://example.com/design-system'). - sig { returns(T.nilable(String)) } - attr_reader :direct_url - - sig { params(direct_url: String).void } - attr_writer :direct_url - - # Domain name to extract styleguide from (e.g., 'example.com', 'google.com'). The - # domain will be automatically normalized and validated. - sig { returns(T.nilable(String)) } - attr_reader :domain - - sig { params(domain: String).void } - attr_writer :domain - - # Optional timeout in milliseconds for the request. If the request takes longer - # than this value, it will be aborted with a 408 status code. Maximum allowed - # value is 300000ms (5 minutes). - sig { returns(T.nilable(Integer)) } - attr_reader :timeout_ms - - sig { params(timeout_ms: Integer).void } - attr_writer :timeout_ms - - sig do - params( - direct_url: String, - domain: String, - timeout_ms: Integer, - request_options: BrandDev::RequestOptions::OrHash - ).returns(T.attached_class) - end - def self.new( - # A specific URL to fetch the styleguide from directly, bypassing domain - # resolution (e.g., 'https://example.com/design-system'). - direct_url: nil, - # Domain name to extract styleguide from (e.g., 'example.com', 'google.com'). The - # domain will be automatically normalized and validated. - domain: nil, - # Optional timeout in milliseconds for the request. If the request takes longer - # than this value, it will be aborted with a 408 status code. Maximum allowed - # value is 300000ms (5 minutes). - timeout_ms: nil, - request_options: {} - ) - end - - sig do - override.returns( - { - direct_url: String, - domain: String, - timeout_ms: Integer, - request_options: BrandDev::RequestOptions - } - ) - end - def to_hash - end - end - end -end diff --git a/rbi/brand_dev/models/brand_styleguide_response.rbi b/rbi/brand_dev/models/brand_styleguide_response.rbi deleted file mode 100644 index a2058a7..0000000 --- a/rbi/brand_dev/models/brand_styleguide_response.rbi +++ /dev/null @@ -1,1785 +0,0 @@ -# typed: strong - -module BrandDev - module Models - class BrandStyleguideResponse < BrandDev::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - BrandDev::Models::BrandStyleguideResponse, - BrandDev::Internal::AnyHash - ) - end - - # HTTP status code - sig { returns(T.nilable(Integer)) } - attr_reader :code - - sig { params(code: Integer).void } - attr_writer :code - - # The normalized domain that was processed - sig { returns(T.nilable(String)) } - attr_reader :domain - - sig { params(domain: String).void } - attr_writer :domain - - # Status of the response, e.g., 'ok' - sig { returns(T.nilable(String)) } - attr_reader :status - - sig { params(status: String).void } - attr_writer :status - - # Comprehensive styleguide data extracted from the website - sig do - returns( - T.nilable(BrandDev::Models::BrandStyleguideResponse::Styleguide) - ) - end - attr_reader :styleguide - - sig do - params( - styleguide: - BrandDev::Models::BrandStyleguideResponse::Styleguide::OrHash - ).void - end - attr_writer :styleguide - - sig do - params( - code: Integer, - domain: String, - status: String, - styleguide: - BrandDev::Models::BrandStyleguideResponse::Styleguide::OrHash - ).returns(T.attached_class) - end - def self.new( - # HTTP status code - code: nil, - # The normalized domain that was processed - domain: nil, - # Status of the response, e.g., 'ok' - status: nil, - # Comprehensive styleguide data extracted from the website - styleguide: nil - ) - end - - sig do - override.returns( - { - code: Integer, - domain: String, - status: String, - styleguide: BrandDev::Models::BrandStyleguideResponse::Styleguide - } - ) - end - def to_hash - end - - class Styleguide < BrandDev::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - BrandDev::Models::BrandStyleguideResponse::Styleguide, - BrandDev::Internal::AnyHash - ) - end - - # Primary colors used on the website - sig do - returns(BrandDev::Models::BrandStyleguideResponse::Styleguide::Colors) - end - attr_reader :colors - - sig do - params( - colors: - BrandDev::Models::BrandStyleguideResponse::Styleguide::Colors::OrHash - ).void - end - attr_writer :colors - - # UI component styles - sig do - returns( - BrandDev::Models::BrandStyleguideResponse::Styleguide::Components - ) - end - attr_reader :components - - sig do - params( - components: - BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::OrHash - ).void - end - attr_writer :components - - # Spacing system used on the website - sig do - returns( - BrandDev::Models::BrandStyleguideResponse::Styleguide::ElementSpacing - ) - end - attr_reader :element_spacing - - sig do - params( - element_spacing: - BrandDev::Models::BrandStyleguideResponse::Styleguide::ElementSpacing::OrHash - ).void - end - attr_writer :element_spacing - - # Font assets keyed by family name as it appears in fontFamily/fontFallbacks - # (non-generic names only). Clients match typography.fontFamily / fontWeight or - # button styles to pick a file URL from files. - sig do - returns( - T::Hash[ - Symbol, - BrandDev::Models::BrandStyleguideResponse::Styleguide::FontLink - ] - ) - end - attr_accessor :font_links - - # The primary color mode of the website design - sig do - returns( - BrandDev::Models::BrandStyleguideResponse::Styleguide::Mode::TaggedSymbol - ) - end - attr_accessor :mode - - # Shadow styles used on the website - sig do - returns( - BrandDev::Models::BrandStyleguideResponse::Styleguide::Shadows - ) - end - attr_reader :shadows - - sig do - params( - shadows: - BrandDev::Models::BrandStyleguideResponse::Styleguide::Shadows::OrHash - ).void - end - attr_writer :shadows - - # Typography styles used on the website - sig do - returns( - BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography - ) - end - attr_reader :typography - - sig do - params( - typography: - BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::OrHash - ).void - end - attr_writer :typography - - # Comprehensive styleguide data extracted from the website - sig do - params( - colors: - BrandDev::Models::BrandStyleguideResponse::Styleguide::Colors::OrHash, - components: - BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::OrHash, - element_spacing: - BrandDev::Models::BrandStyleguideResponse::Styleguide::ElementSpacing::OrHash, - font_links: - T::Hash[ - Symbol, - BrandDev::Models::BrandStyleguideResponse::Styleguide::FontLink::OrHash - ], - mode: - BrandDev::Models::BrandStyleguideResponse::Styleguide::Mode::OrSymbol, - shadows: - BrandDev::Models::BrandStyleguideResponse::Styleguide::Shadows::OrHash, - typography: - BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::OrHash - ).returns(T.attached_class) - end - def self.new( - # Primary colors used on the website - colors:, - # UI component styles - components:, - # Spacing system used on the website - element_spacing:, - # Font assets keyed by family name as it appears in fontFamily/fontFallbacks - # (non-generic names only). Clients match typography.fontFamily / fontWeight or - # button styles to pick a file URL from files. - font_links:, - # The primary color mode of the website design - mode:, - # Shadow styles used on the website - shadows:, - # Typography styles used on the website - typography: - ) - end - - sig do - override.returns( - { - colors: - BrandDev::Models::BrandStyleguideResponse::Styleguide::Colors, - components: - BrandDev::Models::BrandStyleguideResponse::Styleguide::Components, - element_spacing: - BrandDev::Models::BrandStyleguideResponse::Styleguide::ElementSpacing, - font_links: - T::Hash[ - Symbol, - BrandDev::Models::BrandStyleguideResponse::Styleguide::FontLink - ], - mode: - BrandDev::Models::BrandStyleguideResponse::Styleguide::Mode::TaggedSymbol, - shadows: - BrandDev::Models::BrandStyleguideResponse::Styleguide::Shadows, - typography: - BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography - } - ) - end - def to_hash - end - - class Colors < BrandDev::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - BrandDev::Models::BrandStyleguideResponse::Styleguide::Colors, - BrandDev::Internal::AnyHash - ) - end - - # Accent color (hex format) - sig { returns(String) } - attr_accessor :accent - - # Background color (hex format) - sig { returns(String) } - attr_accessor :background - - # Text color (hex format) - sig { returns(String) } - attr_accessor :text - - # Primary colors used on the website - sig do - params(accent: String, background: String, text: String).returns( - T.attached_class - ) - end - def self.new( - # Accent color (hex format) - accent:, - # Background color (hex format) - background:, - # Text color (hex format) - text: - ) - end - - sig do - override.returns( - { accent: String, background: String, text: String } - ) - end - def to_hash - end - end - - class Components < BrandDev::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - BrandDev::Models::BrandStyleguideResponse::Styleguide::Components, - BrandDev::Internal::AnyHash - ) - end - - # Button component styles - sig do - returns( - BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button - ) - end - attr_reader :button - - sig do - params( - button: - BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::OrHash - ).void - end - attr_writer :button - - # Card component style - sig do - returns( - T.nilable( - BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Card - ) - ) - end - attr_reader :card - - sig do - params( - card: - BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Card::OrHash - ).void - end - attr_writer :card - - # UI component styles - sig do - params( - button: - BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::OrHash, - card: - BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Card::OrHash - ).returns(T.attached_class) - end - def self.new( - # Button component styles - button:, - # Card component style - card: nil - ) - end - - sig do - override.returns( - { - button: - BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button, - card: - BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Card - } - ) - end - def to_hash - end - - class Button < BrandDev::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button, - BrandDev::Internal::AnyHash - ) - end - - sig do - returns( - T.nilable( - BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Link - ) - ) - end - attr_reader :link - - sig do - params( - link: - BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Link::OrHash - ).void - end - attr_writer :link - - sig do - returns( - T.nilable( - BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Primary - ) - ) - end - attr_reader :primary - - sig do - params( - primary: - BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Primary::OrHash - ).void - end - attr_writer :primary - - sig do - returns( - T.nilable( - BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Secondary - ) - ) - end - attr_reader :secondary - - sig do - params( - secondary: - BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Secondary::OrHash - ).void - end - attr_writer :secondary - - # Button component styles - sig do - params( - link: - BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Link::OrHash, - primary: - BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Primary::OrHash, - secondary: - BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Secondary::OrHash - ).returns(T.attached_class) - end - def self.new(link: nil, primary: nil, secondary: nil) - end - - sig do - override.returns( - { - link: - BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Link, - primary: - BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Primary, - secondary: - BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Secondary - } - ) - end - def to_hash - end - - class Link < BrandDev::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Link, - BrandDev::Internal::AnyHash - ) - end - - sig { returns(String) } - attr_accessor :background_color - - # Border color as CSS hex (#RRGGBB or #RRGGBBAA when computed border-color has - # alpha) - sig { returns(String) } - attr_accessor :border_color - - sig { returns(String) } - attr_accessor :border_radius - - sig { returns(String) } - attr_accessor :border_style - - sig { returns(String) } - attr_accessor :border_width - - # Computed box-shadow (comma-separated layers when present) - sig { returns(String) } - attr_accessor :box_shadow - - sig { returns(String) } - attr_accessor :color - - # Ready-to-use CSS declaration block for this component style - sig { returns(String) } - attr_accessor :css - - sig { returns(String) } - attr_accessor :font_size - - sig { returns(Float) } - attr_accessor :font_weight - - # Sampled minimum height of the button box (typically px) - sig { returns(String) } - attr_accessor :min_height - - # Sampled minimum width of the button box (typically px) - sig { returns(String) } - attr_accessor :min_width - - sig { returns(String) } - attr_accessor :padding - - sig { returns(String) } - attr_accessor :text_decoration - - # Full ordered font list from computed font-family - sig { returns(T.nilable(T::Array[String])) } - attr_reader :font_fallbacks - - sig { params(font_fallbacks: T::Array[String]).void } - attr_writer :font_fallbacks - - # Primary button typeface (first in fontFallbacks) - sig { returns(T.nilable(String)) } - attr_reader :font_family - - sig { params(font_family: String).void } - attr_writer :font_family - - # Hex color of the underline when it differs from the text color - sig { returns(T.nilable(String)) } - attr_reader :text_decoration_color - - sig { params(text_decoration_color: String).void } - attr_writer :text_decoration_color - - sig do - params( - background_color: String, - border_color: String, - border_radius: String, - border_style: String, - border_width: String, - box_shadow: String, - color: String, - css: String, - font_size: String, - font_weight: Float, - min_height: String, - min_width: String, - padding: String, - text_decoration: String, - font_fallbacks: T::Array[String], - font_family: String, - text_decoration_color: String - ).returns(T.attached_class) - end - def self.new( - background_color:, - # Border color as CSS hex (#RRGGBB or #RRGGBBAA when computed border-color has - # alpha) - border_color:, - border_radius:, - border_style:, - border_width:, - # Computed box-shadow (comma-separated layers when present) - box_shadow:, - color:, - # Ready-to-use CSS declaration block for this component style - css:, - font_size:, - font_weight:, - # Sampled minimum height of the button box (typically px) - min_height:, - # Sampled minimum width of the button box (typically px) - min_width:, - padding:, - text_decoration:, - # Full ordered font list from computed font-family - font_fallbacks: nil, - # Primary button typeface (first in fontFallbacks) - font_family: nil, - # Hex color of the underline when it differs from the text color - text_decoration_color: nil - ) - end - - sig do - override.returns( - { - background_color: String, - border_color: String, - border_radius: String, - border_style: String, - border_width: String, - box_shadow: String, - color: String, - css: String, - font_size: String, - font_weight: Float, - min_height: String, - min_width: String, - padding: String, - text_decoration: String, - font_fallbacks: T::Array[String], - font_family: String, - text_decoration_color: String - } - ) - end - def to_hash - end - end - - class Primary < BrandDev::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Primary, - BrandDev::Internal::AnyHash - ) - end - - sig { returns(String) } - attr_accessor :background_color - - # Border color as CSS hex (#RRGGBB or #RRGGBBAA when computed border-color has - # alpha) - sig { returns(String) } - attr_accessor :border_color - - sig { returns(String) } - attr_accessor :border_radius - - sig { returns(String) } - attr_accessor :border_style - - sig { returns(String) } - attr_accessor :border_width - - # Computed box-shadow (comma-separated layers when present) - sig { returns(String) } - attr_accessor :box_shadow - - sig { returns(String) } - attr_accessor :color - - # Ready-to-use CSS declaration block for this component style - sig { returns(String) } - attr_accessor :css - - sig { returns(String) } - attr_accessor :font_size - - sig { returns(Float) } - attr_accessor :font_weight - - # Sampled minimum height of the button box (typically px) - sig { returns(String) } - attr_accessor :min_height - - # Sampled minimum width of the button box (typically px) - sig { returns(String) } - attr_accessor :min_width - - sig { returns(String) } - attr_accessor :padding - - sig { returns(String) } - attr_accessor :text_decoration - - # Full ordered font list from computed font-family - sig { returns(T.nilable(T::Array[String])) } - attr_reader :font_fallbacks - - sig { params(font_fallbacks: T::Array[String]).void } - attr_writer :font_fallbacks - - # Primary button typeface (first in fontFallbacks) - sig { returns(T.nilable(String)) } - attr_reader :font_family - - sig { params(font_family: String).void } - attr_writer :font_family - - # Hex color of the underline when it differs from the text color - sig { returns(T.nilable(String)) } - attr_reader :text_decoration_color - - sig { params(text_decoration_color: String).void } - attr_writer :text_decoration_color - - sig do - params( - background_color: String, - border_color: String, - border_radius: String, - border_style: String, - border_width: String, - box_shadow: String, - color: String, - css: String, - font_size: String, - font_weight: Float, - min_height: String, - min_width: String, - padding: String, - text_decoration: String, - font_fallbacks: T::Array[String], - font_family: String, - text_decoration_color: String - ).returns(T.attached_class) - end - def self.new( - background_color:, - # Border color as CSS hex (#RRGGBB or #RRGGBBAA when computed border-color has - # alpha) - border_color:, - border_radius:, - border_style:, - border_width:, - # Computed box-shadow (comma-separated layers when present) - box_shadow:, - color:, - # Ready-to-use CSS declaration block for this component style - css:, - font_size:, - font_weight:, - # Sampled minimum height of the button box (typically px) - min_height:, - # Sampled minimum width of the button box (typically px) - min_width:, - padding:, - text_decoration:, - # Full ordered font list from computed font-family - font_fallbacks: nil, - # Primary button typeface (first in fontFallbacks) - font_family: nil, - # Hex color of the underline when it differs from the text color - text_decoration_color: nil - ) - end - - sig do - override.returns( - { - background_color: String, - border_color: String, - border_radius: String, - border_style: String, - border_width: String, - box_shadow: String, - color: String, - css: String, - font_size: String, - font_weight: Float, - min_height: String, - min_width: String, - padding: String, - text_decoration: String, - font_fallbacks: T::Array[String], - font_family: String, - text_decoration_color: String - } - ) - end - def to_hash - end - end - - class Secondary < BrandDev::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Secondary, - BrandDev::Internal::AnyHash - ) - end - - sig { returns(String) } - attr_accessor :background_color - - # Border color as CSS hex (#RRGGBB or #RRGGBBAA when computed border-color has - # alpha) - sig { returns(String) } - attr_accessor :border_color - - sig { returns(String) } - attr_accessor :border_radius - - sig { returns(String) } - attr_accessor :border_style - - sig { returns(String) } - attr_accessor :border_width - - # Computed box-shadow (comma-separated layers when present) - sig { returns(String) } - attr_accessor :box_shadow - - sig { returns(String) } - attr_accessor :color - - # Ready-to-use CSS declaration block for this component style - sig { returns(String) } - attr_accessor :css - - sig { returns(String) } - attr_accessor :font_size - - sig { returns(Float) } - attr_accessor :font_weight - - # Sampled minimum height of the button box (typically px) - sig { returns(String) } - attr_accessor :min_height - - # Sampled minimum width of the button box (typically px) - sig { returns(String) } - attr_accessor :min_width - - sig { returns(String) } - attr_accessor :padding - - sig { returns(String) } - attr_accessor :text_decoration - - # Full ordered font list from computed font-family - sig { returns(T.nilable(T::Array[String])) } - attr_reader :font_fallbacks - - sig { params(font_fallbacks: T::Array[String]).void } - attr_writer :font_fallbacks - - # Primary button typeface (first in fontFallbacks) - sig { returns(T.nilable(String)) } - attr_reader :font_family - - sig { params(font_family: String).void } - attr_writer :font_family - - # Hex color of the underline when it differs from the text color - sig { returns(T.nilable(String)) } - attr_reader :text_decoration_color - - sig { params(text_decoration_color: String).void } - attr_writer :text_decoration_color - - sig do - params( - background_color: String, - border_color: String, - border_radius: String, - border_style: String, - border_width: String, - box_shadow: String, - color: String, - css: String, - font_size: String, - font_weight: Float, - min_height: String, - min_width: String, - padding: String, - text_decoration: String, - font_fallbacks: T::Array[String], - font_family: String, - text_decoration_color: String - ).returns(T.attached_class) - end - def self.new( - background_color:, - # Border color as CSS hex (#RRGGBB or #RRGGBBAA when computed border-color has - # alpha) - border_color:, - border_radius:, - border_style:, - border_width:, - # Computed box-shadow (comma-separated layers when present) - box_shadow:, - color:, - # Ready-to-use CSS declaration block for this component style - css:, - font_size:, - font_weight:, - # Sampled minimum height of the button box (typically px) - min_height:, - # Sampled minimum width of the button box (typically px) - min_width:, - padding:, - text_decoration:, - # Full ordered font list from computed font-family - font_fallbacks: nil, - # Primary button typeface (first in fontFallbacks) - font_family: nil, - # Hex color of the underline when it differs from the text color - text_decoration_color: nil - ) - end - - sig do - override.returns( - { - background_color: String, - border_color: String, - border_radius: String, - border_style: String, - border_width: String, - box_shadow: String, - color: String, - css: String, - font_size: String, - font_weight: Float, - min_height: String, - min_width: String, - padding: String, - text_decoration: String, - font_fallbacks: T::Array[String], - font_family: String, - text_decoration_color: String - } - ) - end - def to_hash - end - end - end - - class Card < BrandDev::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Card, - BrandDev::Internal::AnyHash - ) - end - - sig { returns(String) } - attr_accessor :background_color - - # Border color as CSS hex (#RRGGBB or #RRGGBBAA when computed border-color has - # alpha) - sig { returns(String) } - attr_accessor :border_color - - sig { returns(String) } - attr_accessor :border_radius - - sig { returns(String) } - attr_accessor :border_style - - sig { returns(String) } - attr_accessor :border_width - - sig { returns(String) } - attr_accessor :box_shadow - - # Ready-to-use CSS declaration block for this component style - sig { returns(String) } - attr_accessor :css - - sig { returns(String) } - attr_accessor :padding - - sig { returns(String) } - attr_accessor :text_color - - # Card component style - sig do - params( - background_color: String, - border_color: String, - border_radius: String, - border_style: String, - border_width: String, - box_shadow: String, - css: String, - padding: String, - text_color: String - ).returns(T.attached_class) - end - def self.new( - background_color:, - # Border color as CSS hex (#RRGGBB or #RRGGBBAA when computed border-color has - # alpha) - border_color:, - border_radius:, - border_style:, - border_width:, - box_shadow:, - # Ready-to-use CSS declaration block for this component style - css:, - padding:, - text_color: - ) - end - - sig do - override.returns( - { - background_color: String, - border_color: String, - border_radius: String, - border_style: String, - border_width: String, - box_shadow: String, - css: String, - padding: String, - text_color: String - } - ) - end - def to_hash - end - end - end - - class ElementSpacing < BrandDev::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - BrandDev::Models::BrandStyleguideResponse::Styleguide::ElementSpacing, - BrandDev::Internal::AnyHash - ) - end - - sig { returns(String) } - attr_accessor :lg - - sig { returns(String) } - attr_accessor :md - - sig { returns(String) } - attr_accessor :sm - - sig { returns(String) } - attr_accessor :xl - - sig { returns(String) } - attr_accessor :xs - - # Spacing system used on the website - sig do - params( - lg: String, - md: String, - sm: String, - xl: String, - xs: String - ).returns(T.attached_class) - end - def self.new(lg:, md:, sm:, xl:, xs:) - end - - sig do - override.returns( - { lg: String, md: String, sm: String, xl: String, xs: String } - ) - end - def to_hash - end - end - - class FontLink < BrandDev::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - BrandDev::Models::BrandStyleguideResponse::Styleguide::FontLink, - BrandDev::Internal::AnyHash - ) - end - - # Upright font files keyed by weight string (e.g. "400" for regular, "500", - # "700"). Values are absolute URLs. - sig { returns(T::Hash[Symbol, String]) } - attr_accessor :files - - sig do - returns( - BrandDev::Models::BrandStyleguideResponse::Styleguide::FontLink::Type::TaggedSymbol - ) - end - attr_accessor :type - - # Google Fonts category when type is google (e.g. sans-serif, serif, monospace, - # display, handwriting). Omitted for custom fonts when unknown. - sig { returns(T.nilable(String)) } - attr_reader :category - - sig { params(category: String).void } - attr_writer :category - - # Present when type is custom: human-readable name derived from the fontLinks key - # (strip build/hash suffixes, split camelCase / PascalCase, normalize separators). - # Google entries omit this. - sig { returns(T.nilable(String)) } - attr_reader :display_name - - sig { params(display_name: String).void } - attr_writer :display_name - - sig do - params( - files: T::Hash[Symbol, String], - type: - BrandDev::Models::BrandStyleguideResponse::Styleguide::FontLink::Type::OrSymbol, - category: String, - display_name: String - ).returns(T.attached_class) - end - def self.new( - # Upright font files keyed by weight string (e.g. "400" for regular, "500", - # "700"). Values are absolute URLs. - files:, - type:, - # Google Fonts category when type is google (e.g. sans-serif, serif, monospace, - # display, handwriting). Omitted for custom fonts when unknown. - category: nil, - # Present when type is custom: human-readable name derived from the fontLinks key - # (strip build/hash suffixes, split camelCase / PascalCase, normalize separators). - # Google entries omit this. - display_name: nil - ) - end - - sig do - override.returns( - { - files: T::Hash[Symbol, String], - type: - BrandDev::Models::BrandStyleguideResponse::Styleguide::FontLink::Type::TaggedSymbol, - category: String, - display_name: String - } - ) - end - def to_hash - end - - module Type - extend BrandDev::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - BrandDev::Models::BrandStyleguideResponse::Styleguide::FontLink::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - GOOGLE = - T.let( - :google, - BrandDev::Models::BrandStyleguideResponse::Styleguide::FontLink::Type::TaggedSymbol - ) - CUSTOM = - T.let( - :custom, - BrandDev::Models::BrandStyleguideResponse::Styleguide::FontLink::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - BrandDev::Models::BrandStyleguideResponse::Styleguide::FontLink::Type::TaggedSymbol - ] - ) - end - def self.values - end - end - end - - # The primary color mode of the website design - module Mode - extend BrandDev::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - BrandDev::Models::BrandStyleguideResponse::Styleguide::Mode - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - LIGHT = - T.let( - :light, - BrandDev::Models::BrandStyleguideResponse::Styleguide::Mode::TaggedSymbol - ) - DARK = - T.let( - :dark, - BrandDev::Models::BrandStyleguideResponse::Styleguide::Mode::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - BrandDev::Models::BrandStyleguideResponse::Styleguide::Mode::TaggedSymbol - ] - ) - end - def self.values - end - end - - class Shadows < BrandDev::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - BrandDev::Models::BrandStyleguideResponse::Styleguide::Shadows, - BrandDev::Internal::AnyHash - ) - end - - sig { returns(String) } - attr_accessor :inner - - sig { returns(String) } - attr_accessor :lg - - sig { returns(String) } - attr_accessor :md - - sig { returns(String) } - attr_accessor :sm - - sig { returns(String) } - attr_accessor :xl - - # Shadow styles used on the website - sig do - params( - inner: String, - lg: String, - md: String, - sm: String, - xl: String - ).returns(T.attached_class) - end - def self.new(inner:, lg:, md:, sm:, xl:) - end - - sig do - override.returns( - { inner: String, lg: String, md: String, sm: String, xl: String } - ) - end - def to_hash - end - end - - class Typography < BrandDev::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography, - BrandDev::Internal::AnyHash - ) - end - - # Heading styles - sig do - returns( - BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings - ) - end - attr_reader :headings - - sig do - params( - headings: - BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::OrHash - ).void - end - attr_writer :headings - - sig do - returns( - T.nilable( - BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::P - ) - ) - end - attr_reader :p_ - - sig do - params( - p_: - BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::P::OrHash - ).void - end - attr_writer :p_ - - # Typography styles used on the website - sig do - params( - headings: - BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::OrHash, - p_: - BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::P::OrHash - ).returns(T.attached_class) - end - def self.new( - # Heading styles - headings:, - p_: nil - ) - end - - sig do - override.returns( - { - headings: - BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings, - p_: - BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::P - } - ) - end - def to_hash - end - - class Headings < BrandDev::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings, - BrandDev::Internal::AnyHash - ) - end - - sig do - returns( - T.nilable( - BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H1 - ) - ) - end - attr_reader :h1 - - sig do - params( - h1: - BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H1::OrHash - ).void - end - attr_writer :h1 - - sig do - returns( - T.nilable( - BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H2 - ) - ) - end - attr_reader :h2 - - sig do - params( - h2: - BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H2::OrHash - ).void - end - attr_writer :h2 - - sig do - returns( - T.nilable( - BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H3 - ) - ) - end - attr_reader :h3 - - sig do - params( - h3: - BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H3::OrHash - ).void - end - attr_writer :h3 - - sig do - returns( - T.nilable( - BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H4 - ) - ) - end - attr_reader :h4 - - sig do - params( - h4: - BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H4::OrHash - ).void - end - attr_writer :h4 - - # Heading styles - sig do - params( - h1: - BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H1::OrHash, - h2: - BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H2::OrHash, - h3: - BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H3::OrHash, - h4: - BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H4::OrHash - ).returns(T.attached_class) - end - def self.new(h1: nil, h2: nil, h3: nil, h4: nil) - end - - sig do - override.returns( - { - h1: - BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H1, - h2: - BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H2, - h3: - BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H3, - h4: - BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H4 - } - ) - end - def to_hash - end - - class H1 < BrandDev::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H1, - BrandDev::Internal::AnyHash - ) - end - - # Full ordered font list from resolved computed font-family - sig { returns(T::Array[String]) } - attr_accessor :font_fallbacks - - # Primary face (first family in the computed stack) - sig { returns(String) } - attr_accessor :font_family - - sig { returns(String) } - attr_accessor :font_size - - sig { returns(Float) } - attr_accessor :font_weight - - sig { returns(String) } - attr_accessor :letter_spacing - - sig { returns(String) } - attr_accessor :line_height - - sig do - params( - font_fallbacks: T::Array[String], - font_family: String, - font_size: String, - font_weight: Float, - letter_spacing: String, - line_height: String - ).returns(T.attached_class) - end - def self.new( - # Full ordered font list from resolved computed font-family - font_fallbacks:, - # Primary face (first family in the computed stack) - font_family:, - font_size:, - font_weight:, - letter_spacing:, - line_height: - ) - end - - sig do - override.returns( - { - font_fallbacks: T::Array[String], - font_family: String, - font_size: String, - font_weight: Float, - letter_spacing: String, - line_height: String - } - ) - end - def to_hash - end - end - - class H2 < BrandDev::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H2, - BrandDev::Internal::AnyHash - ) - end - - # Full ordered font list from resolved computed font-family - sig { returns(T::Array[String]) } - attr_accessor :font_fallbacks - - # Primary face (first family in the computed stack) - sig { returns(String) } - attr_accessor :font_family - - sig { returns(String) } - attr_accessor :font_size - - sig { returns(Float) } - attr_accessor :font_weight - - sig { returns(String) } - attr_accessor :letter_spacing - - sig { returns(String) } - attr_accessor :line_height - - sig do - params( - font_fallbacks: T::Array[String], - font_family: String, - font_size: String, - font_weight: Float, - letter_spacing: String, - line_height: String - ).returns(T.attached_class) - end - def self.new( - # Full ordered font list from resolved computed font-family - font_fallbacks:, - # Primary face (first family in the computed stack) - font_family:, - font_size:, - font_weight:, - letter_spacing:, - line_height: - ) - end - - sig do - override.returns( - { - font_fallbacks: T::Array[String], - font_family: String, - font_size: String, - font_weight: Float, - letter_spacing: String, - line_height: String - } - ) - end - def to_hash - end - end - - class H3 < BrandDev::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H3, - BrandDev::Internal::AnyHash - ) - end - - # Full ordered font list from resolved computed font-family - sig { returns(T::Array[String]) } - attr_accessor :font_fallbacks - - # Primary face (first family in the computed stack) - sig { returns(String) } - attr_accessor :font_family - - sig { returns(String) } - attr_accessor :font_size - - sig { returns(Float) } - attr_accessor :font_weight - - sig { returns(String) } - attr_accessor :letter_spacing - - sig { returns(String) } - attr_accessor :line_height - - sig do - params( - font_fallbacks: T::Array[String], - font_family: String, - font_size: String, - font_weight: Float, - letter_spacing: String, - line_height: String - ).returns(T.attached_class) - end - def self.new( - # Full ordered font list from resolved computed font-family - font_fallbacks:, - # Primary face (first family in the computed stack) - font_family:, - font_size:, - font_weight:, - letter_spacing:, - line_height: - ) - end - - sig do - override.returns( - { - font_fallbacks: T::Array[String], - font_family: String, - font_size: String, - font_weight: Float, - letter_spacing: String, - line_height: String - } - ) - end - def to_hash - end - end - - class H4 < BrandDev::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H4, - BrandDev::Internal::AnyHash - ) - end - - # Full ordered font list from resolved computed font-family - sig { returns(T::Array[String]) } - attr_accessor :font_fallbacks - - # Primary face (first family in the computed stack) - sig { returns(String) } - attr_accessor :font_family - - sig { returns(String) } - attr_accessor :font_size - - sig { returns(Float) } - attr_accessor :font_weight - - sig { returns(String) } - attr_accessor :letter_spacing - - sig { returns(String) } - attr_accessor :line_height - - sig do - params( - font_fallbacks: T::Array[String], - font_family: String, - font_size: String, - font_weight: Float, - letter_spacing: String, - line_height: String - ).returns(T.attached_class) - end - def self.new( - # Full ordered font list from resolved computed font-family - font_fallbacks:, - # Primary face (first family in the computed stack) - font_family:, - font_size:, - font_weight:, - letter_spacing:, - line_height: - ) - end - - sig do - override.returns( - { - font_fallbacks: T::Array[String], - font_family: String, - font_size: String, - font_weight: Float, - letter_spacing: String, - line_height: String - } - ) - end - def to_hash - end - end - end - - class P < BrandDev::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::P, - BrandDev::Internal::AnyHash - ) - end - - # Full ordered font list from resolved computed font-family - sig { returns(T::Array[String]) } - attr_accessor :font_fallbacks - - # Primary face (first family in the computed stack) - sig { returns(String) } - attr_accessor :font_family - - sig { returns(String) } - attr_accessor :font_size - - sig { returns(Float) } - attr_accessor :font_weight - - sig { returns(String) } - attr_accessor :letter_spacing - - sig { returns(String) } - attr_accessor :line_height - - sig do - params( - font_fallbacks: T::Array[String], - font_family: String, - font_size: String, - font_weight: Float, - letter_spacing: String, - line_height: String - ).returns(T.attached_class) - end - def self.new( - # Full ordered font list from resolved computed font-family - font_fallbacks:, - # Primary face (first family in the computed stack) - font_family:, - font_size:, - font_weight:, - letter_spacing:, - line_height: - ) - end - - sig do - override.returns( - { - font_fallbacks: T::Array[String], - font_family: String, - font_size: String, - font_weight: Float, - letter_spacing: String, - line_height: String - } - ) - end - def to_hash - end - end - end - end - end - end -end diff --git a/rbi/brand_dev/resources/brand.rbi b/rbi/brand_dev/resources/brand.rbi index 34eee7c..ad4dc98 100644 --- a/rbi/brand_dev/resources/brand.rbi +++ b/rbi/brand_dev/resources/brand.rbi @@ -376,33 +376,6 @@ module BrandDev ) end - # Automatically extract comprehensive design system information from a brand's - # website including colors, typography, spacing, shadows, and UI components. - # Either 'domain' or 'directUrl' must be provided as a query parameter, but not - # both. - sig do - params( - direct_url: String, - domain: String, - timeout_ms: Integer, - request_options: BrandDev::RequestOptions::OrHash - ).returns(BrandDev::Models::BrandStyleguideResponse) - end - def styleguide( - # A specific URL to fetch the styleguide from directly, bypassing domain - # resolution (e.g., 'https://example.com/design-system'). - direct_url: nil, - # Domain name to extract styleguide from (e.g., 'example.com', 'google.com'). The - # domain will be automatically normalized and validated. - domain: nil, - # Optional timeout in milliseconds for the request. If the request takes longer - # than this value, it will be aborted with a 408 status code. Maximum allowed - # value is 300000ms (5 minutes). - timeout_ms: nil, - request_options: {} - ) - end - # Scrapes the given URL and returns the raw HTML content of the page. sig do params( diff --git a/sig/brand_dev/models.rbs b/sig/brand_dev/models.rbs index 198ea36..b59f35c 100644 --- a/sig/brand_dev/models.rbs +++ b/sig/brand_dev/models.rbs @@ -25,8 +25,6 @@ module BrandDev class BrandRetrieveSimplifiedParams = BrandDev::Models::BrandRetrieveSimplifiedParams - class BrandStyleguideParams = BrandDev::Models::BrandStyleguideParams - class BrandWebScrapeHTMLParams = BrandDev::Models::BrandWebScrapeHTMLParams class BrandWebScrapeImagesParams = BrandDev::Models::BrandWebScrapeImagesParams diff --git a/sig/brand_dev/models/brand_styleguide_params.rbs b/sig/brand_dev/models/brand_styleguide_params.rbs deleted file mode 100644 index 0d98deb..0000000 --- a/sig/brand_dev/models/brand_styleguide_params.rbs +++ /dev/null @@ -1,38 +0,0 @@ -module BrandDev - module Models - type brand_styleguide_params = - { direct_url: String, domain: String, timeout_ms: Integer } - & BrandDev::Internal::Type::request_parameters - - class BrandStyleguideParams < BrandDev::Internal::Type::BaseModel - extend BrandDev::Internal::Type::RequestParameters::Converter - include BrandDev::Internal::Type::RequestParameters - - attr_reader direct_url: String? - - def direct_url=: (String) -> String - - attr_reader domain: String? - - def domain=: (String) -> String - - attr_reader timeout_ms: Integer? - - def timeout_ms=: (Integer) -> Integer - - def initialize: ( - ?direct_url: String, - ?domain: String, - ?timeout_ms: Integer, - ?request_options: BrandDev::request_opts - ) -> void - - def to_hash: -> { - direct_url: String, - domain: String, - timeout_ms: Integer, - request_options: BrandDev::RequestOptions - } - end - end -end diff --git a/sig/brand_dev/models/brand_styleguide_response.rbs b/sig/brand_dev/models/brand_styleguide_response.rbs deleted file mode 100644 index 42650de..0000000 --- a/sig/brand_dev/models/brand_styleguide_response.rbs +++ /dev/null @@ -1,945 +0,0 @@ -module BrandDev - module Models - type brand_styleguide_response = - { - code: Integer, - domain: String, - status: String, - styleguide: BrandDev::Models::BrandStyleguideResponse::Styleguide - } - - class BrandStyleguideResponse < BrandDev::Internal::Type::BaseModel - attr_reader code: Integer? - - def code=: (Integer) -> Integer - - attr_reader domain: String? - - def domain=: (String) -> String - - attr_reader status: String? - - def status=: (String) -> String - - attr_reader styleguide: BrandDev::Models::BrandStyleguideResponse::Styleguide? - - def styleguide=: ( - BrandDev::Models::BrandStyleguideResponse::Styleguide - ) -> BrandDev::Models::BrandStyleguideResponse::Styleguide - - def initialize: ( - ?code: Integer, - ?domain: String, - ?status: String, - ?styleguide: BrandDev::Models::BrandStyleguideResponse::Styleguide - ) -> void - - def to_hash: -> { - code: Integer, - domain: String, - status: String, - styleguide: BrandDev::Models::BrandStyleguideResponse::Styleguide - } - - type styleguide = - { - colors: BrandDev::Models::BrandStyleguideResponse::Styleguide::Colors, - components: BrandDev::Models::BrandStyleguideResponse::Styleguide::Components, - element_spacing: BrandDev::Models::BrandStyleguideResponse::Styleguide::ElementSpacing, - font_links: ::Hash[Symbol, BrandDev::Models::BrandStyleguideResponse::Styleguide::FontLink], - mode: BrandDev::Models::BrandStyleguideResponse::Styleguide::mode, - shadows: BrandDev::Models::BrandStyleguideResponse::Styleguide::Shadows, - typography: BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography - } - - class Styleguide < BrandDev::Internal::Type::BaseModel - attr_accessor colors: BrandDev::Models::BrandStyleguideResponse::Styleguide::Colors - - attr_accessor components: BrandDev::Models::BrandStyleguideResponse::Styleguide::Components - - attr_accessor element_spacing: BrandDev::Models::BrandStyleguideResponse::Styleguide::ElementSpacing - - attr_accessor font_links: ::Hash[Symbol, BrandDev::Models::BrandStyleguideResponse::Styleguide::FontLink] - - attr_accessor mode: BrandDev::Models::BrandStyleguideResponse::Styleguide::mode - - attr_accessor shadows: BrandDev::Models::BrandStyleguideResponse::Styleguide::Shadows - - attr_accessor typography: BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography - - def initialize: ( - colors: BrandDev::Models::BrandStyleguideResponse::Styleguide::Colors, - components: BrandDev::Models::BrandStyleguideResponse::Styleguide::Components, - element_spacing: BrandDev::Models::BrandStyleguideResponse::Styleguide::ElementSpacing, - font_links: ::Hash[Symbol, BrandDev::Models::BrandStyleguideResponse::Styleguide::FontLink], - mode: BrandDev::Models::BrandStyleguideResponse::Styleguide::mode, - shadows: BrandDev::Models::BrandStyleguideResponse::Styleguide::Shadows, - typography: BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography - ) -> void - - def to_hash: -> { - colors: BrandDev::Models::BrandStyleguideResponse::Styleguide::Colors, - components: BrandDev::Models::BrandStyleguideResponse::Styleguide::Components, - element_spacing: BrandDev::Models::BrandStyleguideResponse::Styleguide::ElementSpacing, - font_links: ::Hash[Symbol, BrandDev::Models::BrandStyleguideResponse::Styleguide::FontLink], - mode: BrandDev::Models::BrandStyleguideResponse::Styleguide::mode, - shadows: BrandDev::Models::BrandStyleguideResponse::Styleguide::Shadows, - typography: BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography - } - - type colors = { accent: String, background: String, text: String } - - class Colors < BrandDev::Internal::Type::BaseModel - attr_accessor accent: String - - attr_accessor background: String - - attr_accessor text: String - - def initialize: ( - accent: String, - background: String, - text: String - ) -> void - - def to_hash: -> { accent: String, background: String, text: String } - end - - type components = - { - button: BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button, - card: BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Card - } - - class Components < BrandDev::Internal::Type::BaseModel - attr_accessor button: BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button - - attr_reader card: BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Card? - - def card=: ( - BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Card - ) -> BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Card - - def initialize: ( - button: BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button, - ?card: BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Card - ) -> void - - def to_hash: -> { - button: BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button, - card: BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Card - } - - type button = - { - link: BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Link, - primary: BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Primary, - secondary: BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Secondary - } - - class Button < BrandDev::Internal::Type::BaseModel - attr_reader link: BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Link? - - def link=: ( - BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Link - ) -> BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Link - - attr_reader primary: BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Primary? - - def primary=: ( - BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Primary - ) -> BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Primary - - attr_reader secondary: BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Secondary? - - def secondary=: ( - BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Secondary - ) -> BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Secondary - - def initialize: ( - ?link: BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Link, - ?primary: BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Primary, - ?secondary: BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Secondary - ) -> void - - def to_hash: -> { - link: BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Link, - primary: BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Primary, - secondary: BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Secondary - } - - type link = - { - background_color: String, - border_color: String, - border_radius: String, - border_style: String, - border_width: String, - box_shadow: String, - color: String, - css: String, - font_size: String, - font_weight: Float, - min_height: String, - min_width: String, - padding: String, - text_decoration: String, - font_fallbacks: ::Array[String], - font_family: String, - text_decoration_color: String - } - - class Link < BrandDev::Internal::Type::BaseModel - attr_accessor background_color: String - - attr_accessor border_color: String - - attr_accessor border_radius: String - - attr_accessor border_style: String - - attr_accessor border_width: String - - attr_accessor box_shadow: String - - attr_accessor color: String - - attr_accessor css: String - - attr_accessor font_size: String - - attr_accessor font_weight: Float - - attr_accessor min_height: String - - attr_accessor min_width: String - - attr_accessor padding: String - - attr_accessor text_decoration: String - - attr_reader font_fallbacks: ::Array[String]? - - def font_fallbacks=: (::Array[String]) -> ::Array[String] - - attr_reader font_family: String? - - def font_family=: (String) -> String - - attr_reader text_decoration_color: String? - - def text_decoration_color=: (String) -> String - - def initialize: ( - background_color: String, - border_color: String, - border_radius: String, - border_style: String, - border_width: String, - box_shadow: String, - color: String, - css: String, - font_size: String, - font_weight: Float, - min_height: String, - min_width: String, - padding: String, - text_decoration: String, - ?font_fallbacks: ::Array[String], - ?font_family: String, - ?text_decoration_color: String - ) -> void - - def to_hash: -> { - background_color: String, - border_color: String, - border_radius: String, - border_style: String, - border_width: String, - box_shadow: String, - color: String, - css: String, - font_size: String, - font_weight: Float, - min_height: String, - min_width: String, - padding: String, - text_decoration: String, - font_fallbacks: ::Array[String], - font_family: String, - text_decoration_color: String - } - end - - type primary = - { - background_color: String, - border_color: String, - border_radius: String, - border_style: String, - border_width: String, - box_shadow: String, - color: String, - css: String, - font_size: String, - font_weight: Float, - min_height: String, - min_width: String, - padding: String, - text_decoration: String, - font_fallbacks: ::Array[String], - font_family: String, - text_decoration_color: String - } - - class Primary < BrandDev::Internal::Type::BaseModel - attr_accessor background_color: String - - attr_accessor border_color: String - - attr_accessor border_radius: String - - attr_accessor border_style: String - - attr_accessor border_width: String - - attr_accessor box_shadow: String - - attr_accessor color: String - - attr_accessor css: String - - attr_accessor font_size: String - - attr_accessor font_weight: Float - - attr_accessor min_height: String - - attr_accessor min_width: String - - attr_accessor padding: String - - attr_accessor text_decoration: String - - attr_reader font_fallbacks: ::Array[String]? - - def font_fallbacks=: (::Array[String]) -> ::Array[String] - - attr_reader font_family: String? - - def font_family=: (String) -> String - - attr_reader text_decoration_color: String? - - def text_decoration_color=: (String) -> String - - def initialize: ( - background_color: String, - border_color: String, - border_radius: String, - border_style: String, - border_width: String, - box_shadow: String, - color: String, - css: String, - font_size: String, - font_weight: Float, - min_height: String, - min_width: String, - padding: String, - text_decoration: String, - ?font_fallbacks: ::Array[String], - ?font_family: String, - ?text_decoration_color: String - ) -> void - - def to_hash: -> { - background_color: String, - border_color: String, - border_radius: String, - border_style: String, - border_width: String, - box_shadow: String, - color: String, - css: String, - font_size: String, - font_weight: Float, - min_height: String, - min_width: String, - padding: String, - text_decoration: String, - font_fallbacks: ::Array[String], - font_family: String, - text_decoration_color: String - } - end - - type secondary = - { - background_color: String, - border_color: String, - border_radius: String, - border_style: String, - border_width: String, - box_shadow: String, - color: String, - css: String, - font_size: String, - font_weight: Float, - min_height: String, - min_width: String, - padding: String, - text_decoration: String, - font_fallbacks: ::Array[String], - font_family: String, - text_decoration_color: String - } - - class Secondary < BrandDev::Internal::Type::BaseModel - attr_accessor background_color: String - - attr_accessor border_color: String - - attr_accessor border_radius: String - - attr_accessor border_style: String - - attr_accessor border_width: String - - attr_accessor box_shadow: String - - attr_accessor color: String - - attr_accessor css: String - - attr_accessor font_size: String - - attr_accessor font_weight: Float - - attr_accessor min_height: String - - attr_accessor min_width: String - - attr_accessor padding: String - - attr_accessor text_decoration: String - - attr_reader font_fallbacks: ::Array[String]? - - def font_fallbacks=: (::Array[String]) -> ::Array[String] - - attr_reader font_family: String? - - def font_family=: (String) -> String - - attr_reader text_decoration_color: String? - - def text_decoration_color=: (String) -> String - - def initialize: ( - background_color: String, - border_color: String, - border_radius: String, - border_style: String, - border_width: String, - box_shadow: String, - color: String, - css: String, - font_size: String, - font_weight: Float, - min_height: String, - min_width: String, - padding: String, - text_decoration: String, - ?font_fallbacks: ::Array[String], - ?font_family: String, - ?text_decoration_color: String - ) -> void - - def to_hash: -> { - background_color: String, - border_color: String, - border_radius: String, - border_style: String, - border_width: String, - box_shadow: String, - color: String, - css: String, - font_size: String, - font_weight: Float, - min_height: String, - min_width: String, - padding: String, - text_decoration: String, - font_fallbacks: ::Array[String], - font_family: String, - text_decoration_color: String - } - end - end - - type card = - { - background_color: String, - border_color: String, - border_radius: String, - border_style: String, - border_width: String, - box_shadow: String, - css: String, - padding: String, - text_color: String - } - - class Card < BrandDev::Internal::Type::BaseModel - attr_accessor background_color: String - - attr_accessor border_color: String - - attr_accessor border_radius: String - - attr_accessor border_style: String - - attr_accessor border_width: String - - attr_accessor box_shadow: String - - attr_accessor css: String - - attr_accessor padding: String - - attr_accessor text_color: String - - def initialize: ( - background_color: String, - border_color: String, - border_radius: String, - border_style: String, - border_width: String, - box_shadow: String, - css: String, - padding: String, - text_color: String - ) -> void - - def to_hash: -> { - background_color: String, - border_color: String, - border_radius: String, - border_style: String, - border_width: String, - box_shadow: String, - css: String, - padding: String, - text_color: String - } - end - end - - type element_spacing = - { lg: String, md: String, sm: String, xl: String, xs: String } - - class ElementSpacing < BrandDev::Internal::Type::BaseModel - attr_accessor lg: String - - attr_accessor md: String - - attr_accessor sm: String - - attr_accessor xl: String - - attr_accessor xs: String - - def initialize: ( - lg: String, - md: String, - sm: String, - xl: String, - xs: String - ) -> void - - def to_hash: -> { - lg: String, - md: String, - sm: String, - xl: String, - xs: String - } - end - - type font_link = - { - files: ::Hash[Symbol, String], - type: BrandDev::Models::BrandStyleguideResponse::Styleguide::FontLink::type_, - category: String, - display_name: String - } - - class FontLink < BrandDev::Internal::Type::BaseModel - attr_accessor files: ::Hash[Symbol, String] - - attr_accessor type: BrandDev::Models::BrandStyleguideResponse::Styleguide::FontLink::type_ - - attr_reader category: String? - - def category=: (String) -> String - - attr_reader display_name: String? - - def display_name=: (String) -> String - - def initialize: ( - files: ::Hash[Symbol, String], - type: BrandDev::Models::BrandStyleguideResponse::Styleguide::FontLink::type_, - ?category: String, - ?display_name: String - ) -> void - - def to_hash: -> { - files: ::Hash[Symbol, String], - type: BrandDev::Models::BrandStyleguideResponse::Styleguide::FontLink::type_, - category: String, - display_name: String - } - - type type_ = :google | :custom - - module Type - extend BrandDev::Internal::Type::Enum - - GOOGLE: :google - CUSTOM: :custom - - def self?.values: -> ::Array[BrandDev::Models::BrandStyleguideResponse::Styleguide::FontLink::type_] - end - end - - type mode = :light | :dark - - module Mode - extend BrandDev::Internal::Type::Enum - - LIGHT: :light - DARK: :dark - - def self?.values: -> ::Array[BrandDev::Models::BrandStyleguideResponse::Styleguide::mode] - end - - type shadows = - { inner: String, lg: String, md: String, sm: String, xl: String } - - class Shadows < BrandDev::Internal::Type::BaseModel - attr_accessor inner: String - - attr_accessor lg: String - - attr_accessor md: String - - attr_accessor sm: String - - attr_accessor xl: String - - def initialize: ( - inner: String, - lg: String, - md: String, - sm: String, - xl: String - ) -> void - - def to_hash: -> { - inner: String, - lg: String, - md: String, - sm: String, - xl: String - } - end - - type typography = - { - headings: BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings, - p_: BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::P - } - - class Typography < BrandDev::Internal::Type::BaseModel - attr_accessor headings: BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings - - attr_reader p_: BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::P? - - def p_=: ( - BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::P - ) -> BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::P - - def initialize: ( - headings: BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings, - ?p_: BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::P - ) -> void - - def to_hash: -> { - headings: BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings, - p_: BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::P - } - - type headings = - { - :h1 => BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H1, - :h2 => BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H2, - :h3 => BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H3, - :h4 => BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H4 - } - - class Headings < BrandDev::Internal::Type::BaseModel - attr_reader h1: BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H1? - - def h1=: ( - BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H1 - ) -> BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H1 - - attr_reader h2: BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H2? - - def h2=: ( - BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H2 - ) -> BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H2 - - attr_reader h3: BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H3? - - def h3=: ( - BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H3 - ) -> BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H3 - - attr_reader h4: BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H4? - - def h4=: ( - BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H4 - ) -> BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H4 - - def initialize: ( - ?h1: BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H1, - ?h2: BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H2, - ?h3: BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H3, - ?h4: BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H4 - ) -> void - - def to_hash: -> { - :h1 => BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H1, - :h2 => BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H2, - :h3 => BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H3, - :h4 => BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H4 - } - - type h1 = - { - font_fallbacks: ::Array[String], - font_family: String, - font_size: String, - font_weight: Float, - letter_spacing: String, - line_height: String - } - - class H1 < BrandDev::Internal::Type::BaseModel - attr_accessor font_fallbacks: ::Array[String] - - attr_accessor font_family: String - - attr_accessor font_size: String - - attr_accessor font_weight: Float - - attr_accessor letter_spacing: String - - attr_accessor line_height: String - - def initialize: ( - font_fallbacks: ::Array[String], - font_family: String, - font_size: String, - font_weight: Float, - letter_spacing: String, - line_height: String - ) -> void - - def to_hash: -> { - font_fallbacks: ::Array[String], - font_family: String, - font_size: String, - font_weight: Float, - letter_spacing: String, - line_height: String - } - end - - type h2 = - { - font_fallbacks: ::Array[String], - font_family: String, - font_size: String, - font_weight: Float, - letter_spacing: String, - line_height: String - } - - class H2 < BrandDev::Internal::Type::BaseModel - attr_accessor font_fallbacks: ::Array[String] - - attr_accessor font_family: String - - attr_accessor font_size: String - - attr_accessor font_weight: Float - - attr_accessor letter_spacing: String - - attr_accessor line_height: String - - def initialize: ( - font_fallbacks: ::Array[String], - font_family: String, - font_size: String, - font_weight: Float, - letter_spacing: String, - line_height: String - ) -> void - - def to_hash: -> { - font_fallbacks: ::Array[String], - font_family: String, - font_size: String, - font_weight: Float, - letter_spacing: String, - line_height: String - } - end - - type h3 = - { - font_fallbacks: ::Array[String], - font_family: String, - font_size: String, - font_weight: Float, - letter_spacing: String, - line_height: String - } - - class H3 < BrandDev::Internal::Type::BaseModel - attr_accessor font_fallbacks: ::Array[String] - - attr_accessor font_family: String - - attr_accessor font_size: String - - attr_accessor font_weight: Float - - attr_accessor letter_spacing: String - - attr_accessor line_height: String - - def initialize: ( - font_fallbacks: ::Array[String], - font_family: String, - font_size: String, - font_weight: Float, - letter_spacing: String, - line_height: String - ) -> void - - def to_hash: -> { - font_fallbacks: ::Array[String], - font_family: String, - font_size: String, - font_weight: Float, - letter_spacing: String, - line_height: String - } - end - - type h4 = - { - font_fallbacks: ::Array[String], - font_family: String, - font_size: String, - font_weight: Float, - letter_spacing: String, - line_height: String - } - - class H4 < BrandDev::Internal::Type::BaseModel - attr_accessor font_fallbacks: ::Array[String] - - attr_accessor font_family: String - - attr_accessor font_size: String - - attr_accessor font_weight: Float - - attr_accessor letter_spacing: String - - attr_accessor line_height: String - - def initialize: ( - font_fallbacks: ::Array[String], - font_family: String, - font_size: String, - font_weight: Float, - letter_spacing: String, - line_height: String - ) -> void - - def to_hash: -> { - font_fallbacks: ::Array[String], - font_family: String, - font_size: String, - font_weight: Float, - letter_spacing: String, - line_height: String - } - end - end - - type p_ = - { - font_fallbacks: ::Array[String], - font_family: String, - font_size: String, - font_weight: Float, - letter_spacing: String, - line_height: String - } - - class P < BrandDev::Internal::Type::BaseModel - attr_accessor font_fallbacks: ::Array[String] - - attr_accessor font_family: String - - attr_accessor font_size: String - - attr_accessor font_weight: Float - - attr_accessor letter_spacing: String - - attr_accessor line_height: String - - def initialize: ( - font_fallbacks: ::Array[String], - font_family: String, - font_size: String, - font_weight: Float, - letter_spacing: String, - line_height: String - ) -> void - - def to_hash: -> { - font_fallbacks: ::Array[String], - font_family: String, - font_size: String, - font_weight: Float, - letter_spacing: String, - line_height: String - } - end - end - end - end - end -end diff --git a/sig/brand_dev/resources/brand.rbs b/sig/brand_dev/resources/brand.rbs index 5a48d3b..1b34625 100644 --- a/sig/brand_dev/resources/brand.rbs +++ b/sig/brand_dev/resources/brand.rbs @@ -101,13 +101,6 @@ module BrandDev ?request_options: BrandDev::request_opts ) -> BrandDev::Models::BrandRetrieveSimplifiedResponse - def styleguide: ( - ?direct_url: String, - ?domain: String, - ?timeout_ms: Integer, - ?request_options: BrandDev::request_opts - ) -> BrandDev::Models::BrandStyleguideResponse - def web_scrape_html: ( url: String, ?max_age_ms: Integer, diff --git a/test/brand_dev/resources/brand_test.rb b/test/brand_dev/resources/brand_test.rb index e44ef74..9778007 100644 --- a/test/brand_dev/resources/brand_test.rb +++ b/test/brand_dev/resources/brand_test.rb @@ -248,25 +248,6 @@ def test_retrieve_simplified_required_params end end - def test_styleguide - skip("Mock server tests are disabled") - - response = @brand_dev.brand.styleguide - - assert_pattern do - response => BrandDev::Models::BrandStyleguideResponse - end - - assert_pattern do - response => { - code: Integer | nil, - domain: String | nil, - status: String | nil, - styleguide: BrandDev::Models::BrandStyleguideResponse::Styleguide | nil - } - end - end - def test_web_scrape_html_required_params skip("Mock server tests are disabled") From 93dcfee9c2635974a204ae85d237c83845f5eb0d Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 17 Apr 2026 23:45:49 +0000 Subject: [PATCH 21/82] feat(api): api update --- .stats.yml | 4 +-- .../brand_identify_from_transaction_params.rb | 1 - .../models/brand_retrieve_by_name_params.rb | 10 ++++---- lib/brand_dev/resources/brand.rb | 22 +++++++--------- ...brand_identify_from_transaction_params.rbi | 2 -- .../models/brand_retrieve_by_name_params.rbi | 12 ++++----- rbi/brand_dev/resources/brand.rbi | 25 ++++++++----------- 7 files changed, 32 insertions(+), 44 deletions(-) diff --git a/.stats.yml b/.stats.yml index 957b33f..d1e595c 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 17 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-db86584e77523e133c60fce82fe9c3a4957efc0ad317fd0aed1b928c7f0b2f8a.yml -openapi_spec_hash: dfc39b2ad61ed889019ffe6fcb52bcce +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-d2e5adb24c5fcf4801996dc77d972711ae67b658a8d2a0ea8e18bb0856489b90.yml +openapi_spec_hash: 3796c471b7905708bfc8ea905abff5a5 config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 diff --git a/lib/brand_dev/models/brand_identify_from_transaction_params.rb b/lib/brand_dev/models/brand_identify_from_transaction_params.rb index 86e8cbb..d9e9898 100644 --- a/lib/brand_dev/models/brand_identify_from_transaction_params.rb +++ b/lib/brand_dev/models/brand_identify_from_transaction_params.rb @@ -35,7 +35,6 @@ class BrandIdentifyFromTransactionParams < BrandDev::Internal::Type::BaseModel # @!attribute high_confidence_only # When set to true, the API will perform an additional verification steps to # ensure the identified brand matches the transaction with high confidence. - # Defaults to false. # # @return [Boolean, nil] optional :high_confidence_only, BrandDev::Internal::Type::Boolean diff --git a/lib/brand_dev/models/brand_retrieve_by_name_params.rb b/lib/brand_dev/models/brand_retrieve_by_name_params.rb index b73a58b..ab5707b 100644 --- a/lib/brand_dev/models/brand_retrieve_by_name_params.rb +++ b/lib/brand_dev/models/brand_retrieve_by_name_params.rb @@ -15,8 +15,8 @@ class BrandRetrieveByNameParams < BrandDev::Internal::Type::BaseModel required :name, String # @!attribute country_gl - # Optional country code (GL parameter) to specify the country. This affects the - # geographic location used for search queries. + # Optional country code hint (GL parameter) to specify the country for the company + # name. # # @return [Symbol, BrandDev::Models::BrandRetrieveByNameParams::CountryGl, nil] optional :country_gl, enum: -> { BrandDev::BrandRetrieveByNameParams::CountryGl } @@ -49,7 +49,7 @@ class BrandRetrieveByNameParams < BrandDev::Internal::Type::BaseModel # # @param name [String] Company name to retrieve brand data for (e.g., 'Apple Inc', 'Microsoft Corporati # - # @param country_gl [Symbol, BrandDev::Models::BrandRetrieveByNameParams::CountryGl] Optional country code (GL parameter) to specify the country. This affects the ge + # @param country_gl [Symbol, BrandDev::Models::BrandRetrieveByNameParams::CountryGl] Optional country code hint (GL parameter) to specify the country for the company # # @param force_language [Symbol, BrandDev::Models::BrandRetrieveByNameParams::ForceLanguage] Optional parameter to force the language of the retrieved brand data. # @@ -59,8 +59,8 @@ class BrandRetrieveByNameParams < BrandDev::Internal::Type::BaseModel # # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}] - # Optional country code (GL parameter) to specify the country. This affects the - # geographic location used for search queries. + # Optional country code hint (GL parameter) to specify the country for the company + # name. module CountryGl extend BrandDev::Internal::Type::Enum diff --git a/lib/brand_dev/resources/brand.rb b/lib/brand_dev/resources/brand.rb index 8c97a4d..f409173 100644 --- a/lib/brand_dev/resources/brand.rb +++ b/lib/brand_dev/resources/brand.rb @@ -230,9 +230,8 @@ def prefetch_by_email(params) # {BrandDev::Models::BrandRetrieveByEmailParams} for more details. # # Retrieve brand information using an email address while detecting disposable and - # free email addresses. This endpoint extracts the domain from the email address - # and returns brand data for that domain. Disposable and free email addresses - # (like gmail.com, yahoo.com) will throw a 422 error. + # free email addresses. Disposable and free email addresses (like gmail.com, + # yahoo.com) will throw a 422 error. # # @overload retrieve_by_email(email:, force_language: nil, max_speed: nil, timeout_ms: nil, request_options: {}) # @@ -265,8 +264,7 @@ def retrieve_by_email(params) # {BrandDev::Models::BrandRetrieveByIsinParams} for more details. # # Retrieve brand information using an ISIN (International Securities - # Identification Number). This endpoint looks up the company associated with the - # ISIN and returns its brand data. + # Identification Number). # # @overload retrieve_by_isin(isin:, force_language: nil, max_speed: nil, timeout_ms: nil, request_options: {}) # @@ -298,14 +296,13 @@ def retrieve_by_isin(params) # Some parameter documentations has been truncated, see # {BrandDev::Models::BrandRetrieveByNameParams} for more details. # - # Retrieve brand information using a company name. This endpoint searches for the - # company by name and returns its brand data. + # Retrieve brand information using a company name. # # @overload retrieve_by_name(name:, country_gl: nil, force_language: nil, max_speed: nil, timeout_ms: nil, request_options: {}) # # @param name [String] Company name to retrieve brand data for (e.g., 'Apple Inc', 'Microsoft Corporati # - # @param country_gl [Symbol, BrandDev::Models::BrandRetrieveByNameParams::CountryGl] Optional country code (GL parameter) to specify the country. This affects the ge + # @param country_gl [Symbol, BrandDev::Models::BrandRetrieveByNameParams::CountryGl] Optional country code hint (GL parameter) to specify the country for the company # # @param force_language [Symbol, BrandDev::Models::BrandRetrieveByNameParams::ForceLanguage] Optional parameter to force the language of the retrieved brand data. # @@ -333,8 +330,7 @@ def retrieve_by_name(params) # Some parameter documentations has been truncated, see # {BrandDev::Models::BrandRetrieveByTickerParams} for more details. # - # Retrieve brand information using a stock ticker symbol. This endpoint looks up - # the company associated with the ticker and returns its brand data. + # Retrieve brand information using a stock ticker symbol. # # @overload retrieve_by_ticker(ticker:, force_language: nil, max_speed: nil, ticker_exchange: nil, timeout_ms: nil, request_options: {}) # @@ -405,8 +401,8 @@ def retrieve_naics(params) # {BrandDev::Models::BrandRetrieveSimplifiedParams} for more details. # # Returns a simplified version of brand data containing only essential - # information: domain, title, colors, logos, and backdrops. This endpoint is - # optimized for faster responses and reduced data transfer. + # information: domain, title, colors, logos, and backdrops. Optimized for faster + # responses and reduced data transfer. # # @overload retrieve_simplified(domain:, timeout_ms: nil, request_options: {}) # @@ -529,7 +525,7 @@ def web_scrape_md(params) # Some parameter documentations has been truncated, see # {BrandDev::Models::BrandWebScrapeSitemapParams} for more details. # - # Crawl an entire website's sitemap and return all discovered page URLs + # Crawl an entire website's sitemap and return all discovered page URLs. # # @overload web_scrape_sitemap(domain:, max_links: nil, request_options: {}) # diff --git a/rbi/brand_dev/models/brand_identify_from_transaction_params.rbi b/rbi/brand_dev/models/brand_identify_from_transaction_params.rbi index fb85edf..b1a5fb8 100644 --- a/rbi/brand_dev/models/brand_identify_from_transaction_params.rbi +++ b/rbi/brand_dev/models/brand_identify_from_transaction_params.rbi @@ -64,7 +64,6 @@ module BrandDev # When set to true, the API will perform an additional verification steps to # ensure the identified brand matches the transaction with high confidence. - # Defaults to false. sig { returns(T.nilable(T::Boolean)) } attr_reader :high_confidence_only @@ -132,7 +131,6 @@ module BrandDev force_language: nil, # When set to true, the API will perform an additional verification steps to # ensure the identified brand matches the transaction with high confidence. - # Defaults to false. high_confidence_only: nil, # Optional parameter to optimize the API call for maximum speed. When set to true, # the API will skip time-consuming operations for faster response at the cost of diff --git a/rbi/brand_dev/models/brand_retrieve_by_name_params.rbi b/rbi/brand_dev/models/brand_retrieve_by_name_params.rbi index 275c3a4..82ecc67 100644 --- a/rbi/brand_dev/models/brand_retrieve_by_name_params.rbi +++ b/rbi/brand_dev/models/brand_retrieve_by_name_params.rbi @@ -19,8 +19,8 @@ module BrandDev sig { returns(String) } attr_accessor :name - # Optional country code (GL parameter) to specify the country. This affects the - # geographic location used for search queries. + # Optional country code hint (GL parameter) to specify the country for the company + # name. sig do returns( T.nilable(BrandDev::BrandRetrieveByNameParams::CountryGl::OrSymbol) @@ -86,8 +86,8 @@ module BrandDev # Company name to retrieve brand data for (e.g., 'Apple Inc', 'Microsoft # Corporation'). Must be 3-30 characters. name:, - # Optional country code (GL parameter) to specify the country. This affects the - # geographic location used for search queries. + # Optional country code hint (GL parameter) to specify the country for the company + # name. country_gl: nil, # Optional parameter to force the language of the retrieved brand data. force_language: nil, @@ -120,8 +120,8 @@ module BrandDev def to_hash end - # Optional country code (GL parameter) to specify the country. This affects the - # geographic location used for search queries. + # Optional country code hint (GL parameter) to specify the country for the company + # name. module CountryGl extend BrandDev::Internal::Type::Enum diff --git a/rbi/brand_dev/resources/brand.rbi b/rbi/brand_dev/resources/brand.rbi index ad4dc98..5cc9cc2 100644 --- a/rbi/brand_dev/resources/brand.rbi +++ b/rbi/brand_dev/resources/brand.rbi @@ -127,7 +127,6 @@ module BrandDev force_language: nil, # When set to true, the API will perform an additional verification steps to # ensure the identified brand matches the transaction with high confidence. - # Defaults to false. high_confidence_only: nil, # Optional parameter to optimize the API call for maximum speed. When set to true, # the API will skip time-consuming operations for faster response at the cost of @@ -195,9 +194,8 @@ module BrandDev end # Retrieve brand information using an email address while detecting disposable and - # free email addresses. This endpoint extracts the domain from the email address - # and returns brand data for that domain. Disposable and free email addresses - # (like gmail.com, yahoo.com) will throw a 422 error. + # free email addresses. Disposable and free email addresses (like gmail.com, + # yahoo.com) will throw a 422 error. sig do params( email: String, @@ -228,8 +226,7 @@ module BrandDev end # Retrieve brand information using an ISIN (International Securities - # Identification Number). This endpoint looks up the company associated with the - # ISIN and returns its brand data. + # Identification Number). sig do params( isin: String, @@ -259,8 +256,7 @@ module BrandDev ) end - # Retrieve brand information using a company name. This endpoint searches for the - # company by name and returns its brand data. + # Retrieve brand information using a company name. sig do params( name: String, @@ -276,8 +272,8 @@ module BrandDev # Company name to retrieve brand data for (e.g., 'Apple Inc', 'Microsoft # Corporation'). Must be 3-30 characters. name:, - # Optional country code (GL parameter) to specify the country. This affects the - # geographic location used for search queries. + # Optional country code hint (GL parameter) to specify the country for the company + # name. country_gl: nil, # Optional parameter to force the language of the retrieved brand data. force_language: nil, @@ -293,8 +289,7 @@ module BrandDev ) end - # Retrieve brand information using a stock ticker symbol. This endpoint looks up - # the company associated with the ticker and returns its brand data. + # Retrieve brand information using a stock ticker symbol. sig do params( ticker: String, @@ -356,8 +351,8 @@ module BrandDev end # Returns a simplified version of brand data containing only essential - # information: domain, title, colors, logos, and backdrops. This endpoint is - # optimized for faster responses and reduced data transfer. + # information: domain, title, colors, logos, and backdrops. Optimized for faster + # responses and reduced data transfer. sig do params( domain: String, @@ -444,7 +439,7 @@ module BrandDev ) end - # Crawl an entire website's sitemap and return all discovered page URLs + # Crawl an entire website's sitemap and return all discovered page URLs. sig do params( domain: String, From 8f82145769a2d825ab755cf3a4a2e2f3db64c0ad Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sat, 18 Apr 2026 00:09:30 +0000 Subject: [PATCH 22/82] feat(api): api update --- .stats.yml | 6 +- lib/brand_dev.rb | 2 - lib/brand_dev/models.rb | 2 - .../models/brand_retrieve_naics_params.rb | 54 ----- .../models/brand_retrieve_naics_response.rb | 83 -------- lib/brand_dev/resources/brand.rb | 36 ---- rbi/brand_dev/models.rbi | 2 - .../models/brand_retrieve_naics_params.rbi | 86 -------- .../models/brand_retrieve_naics_response.rbi | 187 ------------------ rbi/brand_dev/resources/brand.rbi | 28 --- sig/brand_dev/models.rbs | 2 - .../models/brand_retrieve_naics_params.rbs | 47 ----- .../models/brand_retrieve_naics_response.rbs | 84 -------- sig/brand_dev/resources/brand.rbs | 8 - test/brand_dev/resources/brand_test.rb | 19 -- 15 files changed, 3 insertions(+), 643 deletions(-) delete mode 100644 lib/brand_dev/models/brand_retrieve_naics_params.rb delete mode 100644 lib/brand_dev/models/brand_retrieve_naics_response.rb delete mode 100644 rbi/brand_dev/models/brand_retrieve_naics_params.rbi delete mode 100644 rbi/brand_dev/models/brand_retrieve_naics_response.rbi delete mode 100644 sig/brand_dev/models/brand_retrieve_naics_params.rbs delete mode 100644 sig/brand_dev/models/brand_retrieve_naics_response.rbs diff --git a/.stats.yml b/.stats.yml index d1e595c..f73f1bc 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ -configured_endpoints: 17 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-d2e5adb24c5fcf4801996dc77d972711ae67b658a8d2a0ea8e18bb0856489b90.yml -openapi_spec_hash: 3796c471b7905708bfc8ea905abff5a5 +configured_endpoints: 16 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-071c7e9274f7e2f76732f22559fe8b4b75043a73c2c4af74ad2cc429d4bae357.yml +openapi_spec_hash: e7c47fbf61de6e2e9339f1dbb428cb8e config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 diff --git a/lib/brand_dev.rb b/lib/brand_dev.rb index d3aeea3..ffc0c59 100644 --- a/lib/brand_dev.rb +++ b/lib/brand_dev.rb @@ -72,8 +72,6 @@ require_relative "brand_dev/models/brand_retrieve_by_name_response" require_relative "brand_dev/models/brand_retrieve_by_ticker_params" require_relative "brand_dev/models/brand_retrieve_by_ticker_response" -require_relative "brand_dev/models/brand_retrieve_naics_params" -require_relative "brand_dev/models/brand_retrieve_naics_response" require_relative "brand_dev/models/brand_retrieve_params" require_relative "brand_dev/models/brand_retrieve_response" require_relative "brand_dev/models/brand_retrieve_simplified_params" diff --git a/lib/brand_dev/models.rb b/lib/brand_dev/models.rb index d4b560b..2576dbc 100644 --- a/lib/brand_dev/models.rb +++ b/lib/brand_dev/models.rb @@ -59,8 +59,6 @@ module BrandDev BrandRetrieveByTickerParams = BrandDev::Models::BrandRetrieveByTickerParams - BrandRetrieveNaicsParams = BrandDev::Models::BrandRetrieveNaicsParams - BrandRetrieveParams = BrandDev::Models::BrandRetrieveParams BrandRetrieveSimplifiedParams = BrandDev::Models::BrandRetrieveSimplifiedParams diff --git a/lib/brand_dev/models/brand_retrieve_naics_params.rb b/lib/brand_dev/models/brand_retrieve_naics_params.rb deleted file mode 100644 index 09ca547..0000000 --- a/lib/brand_dev/models/brand_retrieve_naics_params.rb +++ /dev/null @@ -1,54 +0,0 @@ -# frozen_string_literal: true - -module BrandDev - module Models - # @see BrandDev::Resources::Brand#retrieve_naics - class BrandRetrieveNaicsParams < BrandDev::Internal::Type::BaseModel - extend BrandDev::Internal::Type::RequestParameters::Converter - include BrandDev::Internal::Type::RequestParameters - - # @!attribute input - # Brand domain or title to retrieve NAICS code for. If a valid domain is provided - # in `input`, it will be used for classification, otherwise, we will search for - # the brand using the provided title. - # - # @return [String] - required :input, String - - # @!attribute max_results - # Maximum number of NAICS codes to return. Must be between 1 and 10. Defaults - # to 5. - # - # @return [Integer, nil] - optional :max_results, Integer - - # @!attribute min_results - # Minimum number of NAICS codes to return. Must be at least 1. Defaults to 1. - # - # @return [Integer, nil] - optional :min_results, Integer - - # @!attribute timeout_ms - # Optional timeout in milliseconds for the request. If the request takes longer - # than this value, it will be aborted with a 408 status code. Maximum allowed - # value is 300000ms (5 minutes). - # - # @return [Integer, nil] - optional :timeout_ms, Integer - - # @!method initialize(input:, max_results: nil, min_results: nil, timeout_ms: nil, request_options: {}) - # Some parameter documentations has been truncated, see - # {BrandDev::Models::BrandRetrieveNaicsParams} for more details. - # - # @param input [String] Brand domain or title to retrieve NAICS code for. If a valid domain is provided - # - # @param max_results [Integer] Maximum number of NAICS codes to return. Must be between 1 and 10. Defaults to 5 - # - # @param min_results [Integer] Minimum number of NAICS codes to return. Must be at least 1. Defaults to 1. - # - # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th - # - # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}] - end - end -end diff --git a/lib/brand_dev/models/brand_retrieve_naics_response.rb b/lib/brand_dev/models/brand_retrieve_naics_response.rb deleted file mode 100644 index afe0d7f..0000000 --- a/lib/brand_dev/models/brand_retrieve_naics_response.rb +++ /dev/null @@ -1,83 +0,0 @@ -# frozen_string_literal: true - -module BrandDev - module Models - # @see BrandDev::Resources::Brand#retrieve_naics - class BrandRetrieveNaicsResponse < BrandDev::Internal::Type::BaseModel - # @!attribute codes - # Array of NAICS codes and titles. - # - # @return [Array, nil] - optional :codes, - -> { BrandDev::Internal::Type::ArrayOf[BrandDev::Models::BrandRetrieveNaicsResponse::Code] } - - # @!attribute domain - # Domain found for the brand - # - # @return [String, nil] - optional :domain, String - - # @!attribute status - # Status of the response, e.g., 'ok' - # - # @return [String, nil] - optional :status, String - - # @!attribute type - # Industry classification type, for naics api it will be `naics` - # - # @return [String, nil] - optional :type, String - - # @!method initialize(codes: nil, domain: nil, status: nil, type: nil) - # @param codes [Array] Array of NAICS codes and titles. - # - # @param domain [String] Domain found for the brand - # - # @param status [String] Status of the response, e.g., 'ok' - # - # @param type [String] Industry classification type, for naics api it will be `naics` - - class Code < BrandDev::Internal::Type::BaseModel - # @!attribute code - # NAICS code - # - # @return [String] - required :code, String - - # @!attribute confidence - # Confidence level for how well this NAICS code matches the company description - # - # @return [Symbol, BrandDev::Models::BrandRetrieveNaicsResponse::Code::Confidence] - required :confidence, enum: -> { BrandDev::Models::BrandRetrieveNaicsResponse::Code::Confidence } - - # @!attribute name - # NAICS title - # - # @return [String] - required :name, String - - # @!method initialize(code:, confidence:, name:) - # @param code [String] NAICS code - # - # @param confidence [Symbol, BrandDev::Models::BrandRetrieveNaicsResponse::Code::Confidence] Confidence level for how well this NAICS code matches the company description - # - # @param name [String] NAICS title - - # Confidence level for how well this NAICS code matches the company description - # - # @see BrandDev::Models::BrandRetrieveNaicsResponse::Code#confidence - module Confidence - extend BrandDev::Internal::Type::Enum - - HIGH = :high - MEDIUM = :medium - LOW = :low - - # @!method self.values - # @return [Array] - end - end - end - end -end diff --git a/lib/brand_dev/resources/brand.rb b/lib/brand_dev/resources/brand.rb index f409173..0071eaf 100644 --- a/lib/brand_dev/resources/brand.rb +++ b/lib/brand_dev/resources/brand.rb @@ -361,42 +361,6 @@ def retrieve_by_ticker(params) ) end - # Some parameter documentations has been truncated, see - # {BrandDev::Models::BrandRetrieveNaicsParams} for more details. - # - # Endpoint to classify any brand into a 2022 NAICS code. - # - # @overload retrieve_naics(input:, max_results: nil, min_results: nil, timeout_ms: nil, request_options: {}) - # - # @param input [String] Brand domain or title to retrieve NAICS code for. If a valid domain is provided - # - # @param max_results [Integer] Maximum number of NAICS codes to return. Must be between 1 and 10. Defaults to 5 - # - # @param min_results [Integer] Minimum number of NAICS codes to return. Must be at least 1. Defaults to 1. - # - # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th - # - # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}, nil] - # - # @return [BrandDev::Models::BrandRetrieveNaicsResponse] - # - # @see BrandDev::Models::BrandRetrieveNaicsParams - def retrieve_naics(params) - parsed, options = BrandDev::BrandRetrieveNaicsParams.dump_request(params) - query = BrandDev::Internal::Util.encode_query_params(parsed) - @client.request( - method: :get, - path: "brand/naics", - query: query.transform_keys( - max_results: "maxResults", - min_results: "minResults", - timeout_ms: "timeoutMS" - ), - model: BrandDev::Models::BrandRetrieveNaicsResponse, - options: options - ) - end - # Some parameter documentations has been truncated, see # {BrandDev::Models::BrandRetrieveSimplifiedParams} for more details. # diff --git a/rbi/brand_dev/models.rbi b/rbi/brand_dev/models.rbi index cc9e1a6..7b4fbfc 100644 --- a/rbi/brand_dev/models.rbi +++ b/rbi/brand_dev/models.rbi @@ -22,8 +22,6 @@ module BrandDev BrandRetrieveByTickerParams = BrandDev::Models::BrandRetrieveByTickerParams - BrandRetrieveNaicsParams = BrandDev::Models::BrandRetrieveNaicsParams - BrandRetrieveParams = BrandDev::Models::BrandRetrieveParams BrandRetrieveSimplifiedParams = diff --git a/rbi/brand_dev/models/brand_retrieve_naics_params.rbi b/rbi/brand_dev/models/brand_retrieve_naics_params.rbi deleted file mode 100644 index 7659cff..0000000 --- a/rbi/brand_dev/models/brand_retrieve_naics_params.rbi +++ /dev/null @@ -1,86 +0,0 @@ -# typed: strong - -module BrandDev - module Models - class BrandRetrieveNaicsParams < BrandDev::Internal::Type::BaseModel - extend BrandDev::Internal::Type::RequestParameters::Converter - include BrandDev::Internal::Type::RequestParameters - - OrHash = - T.type_alias do - T.any(BrandDev::BrandRetrieveNaicsParams, BrandDev::Internal::AnyHash) - end - - # Brand domain or title to retrieve NAICS code for. If a valid domain is provided - # in `input`, it will be used for classification, otherwise, we will search for - # the brand using the provided title. - sig { returns(String) } - attr_accessor :input - - # Maximum number of NAICS codes to return. Must be between 1 and 10. Defaults - # to 5. - sig { returns(T.nilable(Integer)) } - attr_reader :max_results - - sig { params(max_results: Integer).void } - attr_writer :max_results - - # Minimum number of NAICS codes to return. Must be at least 1. Defaults to 1. - sig { returns(T.nilable(Integer)) } - attr_reader :min_results - - sig { params(min_results: Integer).void } - attr_writer :min_results - - # Optional timeout in milliseconds for the request. If the request takes longer - # than this value, it will be aborted with a 408 status code. Maximum allowed - # value is 300000ms (5 minutes). - sig { returns(T.nilable(Integer)) } - attr_reader :timeout_ms - - sig { params(timeout_ms: Integer).void } - attr_writer :timeout_ms - - sig do - params( - input: String, - max_results: Integer, - min_results: Integer, - timeout_ms: Integer, - request_options: BrandDev::RequestOptions::OrHash - ).returns(T.attached_class) - end - def self.new( - # Brand domain or title to retrieve NAICS code for. If a valid domain is provided - # in `input`, it will be used for classification, otherwise, we will search for - # the brand using the provided title. - input:, - # Maximum number of NAICS codes to return. Must be between 1 and 10. Defaults - # to 5. - max_results: nil, - # Minimum number of NAICS codes to return. Must be at least 1. Defaults to 1. - min_results: nil, - # Optional timeout in milliseconds for the request. If the request takes longer - # than this value, it will be aborted with a 408 status code. Maximum allowed - # value is 300000ms (5 minutes). - timeout_ms: nil, - request_options: {} - ) - end - - sig do - override.returns( - { - input: String, - max_results: Integer, - min_results: Integer, - timeout_ms: Integer, - request_options: BrandDev::RequestOptions - } - ) - end - def to_hash - end - end - end -end diff --git a/rbi/brand_dev/models/brand_retrieve_naics_response.rbi b/rbi/brand_dev/models/brand_retrieve_naics_response.rbi deleted file mode 100644 index 4af6011..0000000 --- a/rbi/brand_dev/models/brand_retrieve_naics_response.rbi +++ /dev/null @@ -1,187 +0,0 @@ -# typed: strong - -module BrandDev - module Models - class BrandRetrieveNaicsResponse < BrandDev::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - BrandDev::Models::BrandRetrieveNaicsResponse, - BrandDev::Internal::AnyHash - ) - end - - # Array of NAICS codes and titles. - sig do - returns( - T.nilable( - T::Array[BrandDev::Models::BrandRetrieveNaicsResponse::Code] - ) - ) - end - attr_reader :codes - - sig do - params( - codes: - T::Array[BrandDev::Models::BrandRetrieveNaicsResponse::Code::OrHash] - ).void - end - attr_writer :codes - - # Domain found for the brand - sig { returns(T.nilable(String)) } - attr_reader :domain - - sig { params(domain: String).void } - attr_writer :domain - - # Status of the response, e.g., 'ok' - sig { returns(T.nilable(String)) } - attr_reader :status - - sig { params(status: String).void } - attr_writer :status - - # Industry classification type, for naics api it will be `naics` - sig { returns(T.nilable(String)) } - attr_reader :type - - sig { params(type: String).void } - attr_writer :type - - sig do - params( - codes: - T::Array[ - BrandDev::Models::BrandRetrieveNaicsResponse::Code::OrHash - ], - domain: String, - status: String, - type: String - ).returns(T.attached_class) - end - def self.new( - # Array of NAICS codes and titles. - codes: nil, - # Domain found for the brand - domain: nil, - # Status of the response, e.g., 'ok' - status: nil, - # Industry classification type, for naics api it will be `naics` - type: nil - ) - end - - sig do - override.returns( - { - codes: T::Array[BrandDev::Models::BrandRetrieveNaicsResponse::Code], - domain: String, - status: String, - type: String - } - ) - end - def to_hash - end - - class Code < BrandDev::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - BrandDev::Models::BrandRetrieveNaicsResponse::Code, - BrandDev::Internal::AnyHash - ) - end - - # NAICS code - sig { returns(String) } - attr_accessor :code - - # Confidence level for how well this NAICS code matches the company description - sig do - returns( - BrandDev::Models::BrandRetrieveNaicsResponse::Code::Confidence::TaggedSymbol - ) - end - attr_accessor :confidence - - # NAICS title - sig { returns(String) } - attr_accessor :name - - sig do - params( - code: String, - confidence: - BrandDev::Models::BrandRetrieveNaicsResponse::Code::Confidence::OrSymbol, - name: String - ).returns(T.attached_class) - end - def self.new( - # NAICS code - code:, - # Confidence level for how well this NAICS code matches the company description - confidence:, - # NAICS title - name: - ) - end - - sig do - override.returns( - { - code: String, - confidence: - BrandDev::Models::BrandRetrieveNaicsResponse::Code::Confidence::TaggedSymbol, - name: String - } - ) - end - def to_hash - end - - # Confidence level for how well this NAICS code matches the company description - module Confidence - extend BrandDev::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - BrandDev::Models::BrandRetrieveNaicsResponse::Code::Confidence - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - HIGH = - T.let( - :high, - BrandDev::Models::BrandRetrieveNaicsResponse::Code::Confidence::TaggedSymbol - ) - MEDIUM = - T.let( - :medium, - BrandDev::Models::BrandRetrieveNaicsResponse::Code::Confidence::TaggedSymbol - ) - LOW = - T.let( - :low, - BrandDev::Models::BrandRetrieveNaicsResponse::Code::Confidence::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - BrandDev::Models::BrandRetrieveNaicsResponse::Code::Confidence::TaggedSymbol - ] - ) - end - def self.values - end - end - end - end - end -end diff --git a/rbi/brand_dev/resources/brand.rbi b/rbi/brand_dev/resources/brand.rbi index 5cc9cc2..bd85f84 100644 --- a/rbi/brand_dev/resources/brand.rbi +++ b/rbi/brand_dev/resources/brand.rbi @@ -322,34 +322,6 @@ module BrandDev ) end - # Endpoint to classify any brand into a 2022 NAICS code. - sig do - params( - input: String, - max_results: Integer, - min_results: Integer, - timeout_ms: Integer, - request_options: BrandDev::RequestOptions::OrHash - ).returns(BrandDev::Models::BrandRetrieveNaicsResponse) - end - def retrieve_naics( - # Brand domain or title to retrieve NAICS code for. If a valid domain is provided - # in `input`, it will be used for classification, otherwise, we will search for - # the brand using the provided title. - input:, - # Maximum number of NAICS codes to return. Must be between 1 and 10. Defaults - # to 5. - max_results: nil, - # Minimum number of NAICS codes to return. Must be at least 1. Defaults to 1. - min_results: nil, - # Optional timeout in milliseconds for the request. If the request takes longer - # than this value, it will be aborted with a 408 status code. Maximum allowed - # value is 300000ms (5 minutes). - timeout_ms: nil, - request_options: {} - ) - end - # Returns a simplified version of brand data containing only essential # information: domain, title, colors, logos, and backdrops. Optimized for faster # responses and reduced data transfer. diff --git a/sig/brand_dev/models.rbs b/sig/brand_dev/models.rbs index b59f35c..2354e18 100644 --- a/sig/brand_dev/models.rbs +++ b/sig/brand_dev/models.rbs @@ -19,8 +19,6 @@ module BrandDev class BrandRetrieveByTickerParams = BrandDev::Models::BrandRetrieveByTickerParams - class BrandRetrieveNaicsParams = BrandDev::Models::BrandRetrieveNaicsParams - class BrandRetrieveParams = BrandDev::Models::BrandRetrieveParams class BrandRetrieveSimplifiedParams = BrandDev::Models::BrandRetrieveSimplifiedParams diff --git a/sig/brand_dev/models/brand_retrieve_naics_params.rbs b/sig/brand_dev/models/brand_retrieve_naics_params.rbs deleted file mode 100644 index 0824424..0000000 --- a/sig/brand_dev/models/brand_retrieve_naics_params.rbs +++ /dev/null @@ -1,47 +0,0 @@ -module BrandDev - module Models - type brand_retrieve_naics_params = - { - input: String, - max_results: Integer, - min_results: Integer, - timeout_ms: Integer - } - & BrandDev::Internal::Type::request_parameters - - class BrandRetrieveNaicsParams < BrandDev::Internal::Type::BaseModel - extend BrandDev::Internal::Type::RequestParameters::Converter - include BrandDev::Internal::Type::RequestParameters - - attr_accessor input: String - - attr_reader max_results: Integer? - - def max_results=: (Integer) -> Integer - - attr_reader min_results: Integer? - - def min_results=: (Integer) -> Integer - - attr_reader timeout_ms: Integer? - - def timeout_ms=: (Integer) -> Integer - - def initialize: ( - input: String, - ?max_results: Integer, - ?min_results: Integer, - ?timeout_ms: Integer, - ?request_options: BrandDev::request_opts - ) -> void - - def to_hash: -> { - input: String, - max_results: Integer, - min_results: Integer, - timeout_ms: Integer, - request_options: BrandDev::RequestOptions - } - end - end -end diff --git a/sig/brand_dev/models/brand_retrieve_naics_response.rbs b/sig/brand_dev/models/brand_retrieve_naics_response.rbs deleted file mode 100644 index 94a52c6..0000000 --- a/sig/brand_dev/models/brand_retrieve_naics_response.rbs +++ /dev/null @@ -1,84 +0,0 @@ -module BrandDev - module Models - type brand_retrieve_naics_response = - { - codes: ::Array[BrandDev::Models::BrandRetrieveNaicsResponse::Code], - domain: String, - status: String, - type: String - } - - class BrandRetrieveNaicsResponse < BrandDev::Internal::Type::BaseModel - attr_reader codes: ::Array[BrandDev::Models::BrandRetrieveNaicsResponse::Code]? - - def codes=: ( - ::Array[BrandDev::Models::BrandRetrieveNaicsResponse::Code] - ) -> ::Array[BrandDev::Models::BrandRetrieveNaicsResponse::Code] - - attr_reader domain: String? - - def domain=: (String) -> String - - attr_reader status: String? - - def status=: (String) -> String - - attr_reader type: String? - - def type=: (String) -> String - - def initialize: ( - ?codes: ::Array[BrandDev::Models::BrandRetrieveNaicsResponse::Code], - ?domain: String, - ?status: String, - ?type: String - ) -> void - - def to_hash: -> { - codes: ::Array[BrandDev::Models::BrandRetrieveNaicsResponse::Code], - domain: String, - status: String, - type: String - } - - type code = - { - code: String, - confidence: BrandDev::Models::BrandRetrieveNaicsResponse::Code::confidence, - name: String - } - - class Code < BrandDev::Internal::Type::BaseModel - attr_accessor code: String - - attr_accessor confidence: BrandDev::Models::BrandRetrieveNaicsResponse::Code::confidence - - attr_accessor name: String - - def initialize: ( - code: String, - confidence: BrandDev::Models::BrandRetrieveNaicsResponse::Code::confidence, - name: String - ) -> void - - def to_hash: -> { - code: String, - confidence: BrandDev::Models::BrandRetrieveNaicsResponse::Code::confidence, - name: String - } - - type confidence = :high | :medium | :low - - module Confidence - extend BrandDev::Internal::Type::Enum - - HIGH: :high - MEDIUM: :medium - LOW: :low - - def self?.values: -> ::Array[BrandDev::Models::BrandRetrieveNaicsResponse::Code::confidence] - end - end - end - end -end diff --git a/sig/brand_dev/resources/brand.rbs b/sig/brand_dev/resources/brand.rbs index 1b34625..f154b72 100644 --- a/sig/brand_dev/resources/brand.rbs +++ b/sig/brand_dev/resources/brand.rbs @@ -87,14 +87,6 @@ module BrandDev ?request_options: BrandDev::request_opts ) -> BrandDev::Models::BrandRetrieveByTickerResponse - def retrieve_naics: ( - input: String, - ?max_results: Integer, - ?min_results: Integer, - ?timeout_ms: Integer, - ?request_options: BrandDev::request_opts - ) -> BrandDev::Models::BrandRetrieveNaicsResponse - def retrieve_simplified: ( domain: String, ?timeout_ms: Integer, diff --git a/test/brand_dev/resources/brand_test.rb b/test/brand_dev/resources/brand_test.rb index 9778007..7b77af2 100644 --- a/test/brand_dev/resources/brand_test.rb +++ b/test/brand_dev/resources/brand_test.rb @@ -211,25 +211,6 @@ def test_retrieve_by_ticker_required_params end end - def test_retrieve_naics_required_params - skip("Mock server tests are disabled") - - response = @brand_dev.brand.retrieve_naics(input: "input") - - assert_pattern do - response => BrandDev::Models::BrandRetrieveNaicsResponse - end - - assert_pattern do - response => { - codes: ^(BrandDev::Internal::Type::ArrayOf[BrandDev::Models::BrandRetrieveNaicsResponse::Code]) | nil, - domain: String | nil, - status: String | nil, - type: String | nil - } - end - end - def test_retrieve_simplified_required_params skip("Mock server tests are disabled") From d3d25602c339827788f1897ed902f025d9b6a302 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sat, 18 Apr 2026 00:20:45 +0000 Subject: [PATCH 23/82] codegen metadata --- .stats.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.stats.yml b/.stats.yml index f73f1bc..57b9c33 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 16 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-071c7e9274f7e2f76732f22559fe8b4b75043a73c2c4af74ad2cc429d4bae357.yml -openapi_spec_hash: e7c47fbf61de6e2e9339f1dbb428cb8e +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-13cb1b1b133273b7f4a26ff8772f162417a05342c56bfe26ec427bba0d54c8c3.yml +openapi_spec_hash: 45b57e0ecd3ab113e260ed2329ef5fa2 config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 From 9fcd4e003c71f89b46ed29ab9f31aaa8fd34b173 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sun, 19 Apr 2026 17:36:31 +0000 Subject: [PATCH 24/82] codegen metadata --- .stats.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.stats.yml b/.stats.yml index 57b9c33..53e55d8 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 16 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-13cb1b1b133273b7f4a26ff8772f162417a05342c56bfe26ec427bba0d54c8c3.yml -openapi_spec_hash: 45b57e0ecd3ab113e260ed2329ef5fa2 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-356ccbb6bb3c12841b88bd036ef68cc2d5ee48d0bec0ccc4f50479ad4dbb5993.yml +openapi_spec_hash: f9ba30cd05421a6bef83f86d1c96bb82 config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 From 26aa262ffcd0e82c130a73f5bf4258a02d5d687d Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sun, 19 Apr 2026 18:04:36 +0000 Subject: [PATCH 25/82] feat(api): api update --- .stats.yml | 4 ++-- .../models/brand_web_scrape_sitemap_params.rb | 11 ++++++++++- lib/brand_dev/resources/brand.rb | 6 ++++-- .../models/brand_web_scrape_sitemap_params.rbi | 13 +++++++++++++ rbi/brand_dev/resources/brand.rbi | 4 ++++ .../models/brand_web_scrape_sitemap_params.rbs | 8 +++++++- sig/brand_dev/resources/brand.rbs | 1 + 7 files changed, 41 insertions(+), 6 deletions(-) diff --git a/.stats.yml b/.stats.yml index 53e55d8..0a349a1 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 16 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-356ccbb6bb3c12841b88bd036ef68cc2d5ee48d0bec0ccc4f50479ad4dbb5993.yml -openapi_spec_hash: f9ba30cd05421a6bef83f86d1c96bb82 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-b6262c6c346b4e4c6db18bc0c74585bb0b1d8f239048e893e76de2fcfd15ce01.yml +openapi_spec_hash: 157593d2318122199aedd86d7755f941 config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 diff --git a/lib/brand_dev/models/brand_web_scrape_sitemap_params.rb b/lib/brand_dev/models/brand_web_scrape_sitemap_params.rb index 99ec147..07e2e2c 100644 --- a/lib/brand_dev/models/brand_web_scrape_sitemap_params.rb +++ b/lib/brand_dev/models/brand_web_scrape_sitemap_params.rb @@ -20,7 +20,14 @@ class BrandWebScrapeSitemapParams < BrandDev::Internal::Type::BaseModel # @return [Integer, nil] optional :max_links, Integer - # @!method initialize(domain:, max_links: nil, request_options: {}) + # @!attribute url_regex + # Optional RE2-compatible regex pattern. Only URLs matching this pattern are + # returned and counted against maxLinks. + # + # @return [String, nil] + optional :url_regex, String + + # @!method initialize(domain:, max_links: nil, url_regex: nil, request_options: {}) # Some parameter documentations has been truncated, see # {BrandDev::Models::BrandWebScrapeSitemapParams} for more details. # @@ -28,6 +35,8 @@ class BrandWebScrapeSitemapParams < BrandDev::Internal::Type::BaseModel # # @param max_links [Integer] Maximum number of links to return from the sitemap crawl. Defaults to 10,000. Mi # + # @param url_regex [String] Optional RE2-compatible regex pattern. Only URLs matching this pattern are retur + # # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/brand_dev/resources/brand.rb b/lib/brand_dev/resources/brand.rb index 0071eaf..6bb2b48 100644 --- a/lib/brand_dev/resources/brand.rb +++ b/lib/brand_dev/resources/brand.rb @@ -491,12 +491,14 @@ def web_scrape_md(params) # # Crawl an entire website's sitemap and return all discovered page URLs. # - # @overload web_scrape_sitemap(domain:, max_links: nil, request_options: {}) + # @overload web_scrape_sitemap(domain:, max_links: nil, url_regex: nil, request_options: {}) # # @param domain [String] Domain to build a sitemap for # # @param max_links [Integer] Maximum number of links to return from the sitemap crawl. Defaults to 10,000. Mi # + # @param url_regex [String] Optional RE2-compatible regex pattern. Only URLs matching this pattern are retur + # # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [BrandDev::Models::BrandWebScrapeSitemapResponse] @@ -508,7 +510,7 @@ def web_scrape_sitemap(params) @client.request( method: :get, path: "web/scrape/sitemap", - query: query.transform_keys(max_links: "maxLinks"), + query: query.transform_keys(max_links: "maxLinks", url_regex: "urlRegex"), model: BrandDev::Models::BrandWebScrapeSitemapResponse, options: options ) diff --git a/rbi/brand_dev/models/brand_web_scrape_sitemap_params.rbi b/rbi/brand_dev/models/brand_web_scrape_sitemap_params.rbi index 9fa48e2..58ba807 100644 --- a/rbi/brand_dev/models/brand_web_scrape_sitemap_params.rbi +++ b/rbi/brand_dev/models/brand_web_scrape_sitemap_params.rbi @@ -26,10 +26,19 @@ module BrandDev sig { params(max_links: Integer).void } attr_writer :max_links + # Optional RE2-compatible regex pattern. Only URLs matching this pattern are + # returned and counted against maxLinks. + sig { returns(T.nilable(String)) } + attr_reader :url_regex + + sig { params(url_regex: String).void } + attr_writer :url_regex + sig do params( domain: String, max_links: Integer, + url_regex: String, request_options: BrandDev::RequestOptions::OrHash ).returns(T.attached_class) end @@ -39,6 +48,9 @@ module BrandDev # Maximum number of links to return from the sitemap crawl. Defaults to 10,000. # Minimum is 1, maximum is 100,000. max_links: nil, + # Optional RE2-compatible regex pattern. Only URLs matching this pattern are + # returned and counted against maxLinks. + url_regex: nil, request_options: {} ) end @@ -48,6 +60,7 @@ module BrandDev { domain: String, max_links: Integer, + url_regex: String, request_options: BrandDev::RequestOptions } ) diff --git a/rbi/brand_dev/resources/brand.rbi b/rbi/brand_dev/resources/brand.rbi index bd85f84..11fda07 100644 --- a/rbi/brand_dev/resources/brand.rbi +++ b/rbi/brand_dev/resources/brand.rbi @@ -416,6 +416,7 @@ module BrandDev params( domain: String, max_links: Integer, + url_regex: String, request_options: BrandDev::RequestOptions::OrHash ).returns(BrandDev::Models::BrandWebScrapeSitemapResponse) end @@ -425,6 +426,9 @@ module BrandDev # Maximum number of links to return from the sitemap crawl. Defaults to 10,000. # Minimum is 1, maximum is 100,000. max_links: nil, + # Optional RE2-compatible regex pattern. Only URLs matching this pattern are + # returned and counted against maxLinks. + url_regex: nil, request_options: {} ) end diff --git a/sig/brand_dev/models/brand_web_scrape_sitemap_params.rbs b/sig/brand_dev/models/brand_web_scrape_sitemap_params.rbs index c7a3eef..e0d37f2 100644 --- a/sig/brand_dev/models/brand_web_scrape_sitemap_params.rbs +++ b/sig/brand_dev/models/brand_web_scrape_sitemap_params.rbs @@ -1,7 +1,7 @@ module BrandDev module Models type brand_web_scrape_sitemap_params = - { domain: String, max_links: Integer } + { domain: String, max_links: Integer, url_regex: String } & BrandDev::Internal::Type::request_parameters class BrandWebScrapeSitemapParams < BrandDev::Internal::Type::BaseModel @@ -14,15 +14,21 @@ module BrandDev def max_links=: (Integer) -> Integer + attr_reader url_regex: String? + + def url_regex=: (String) -> String + def initialize: ( domain: String, ?max_links: Integer, + ?url_regex: String, ?request_options: BrandDev::request_opts ) -> void def to_hash: -> { domain: String, max_links: Integer, + url_regex: String, request_options: BrandDev::RequestOptions } end diff --git a/sig/brand_dev/resources/brand.rbs b/sig/brand_dev/resources/brand.rbs index f154b72..a8d0e0c 100644 --- a/sig/brand_dev/resources/brand.rbs +++ b/sig/brand_dev/resources/brand.rbs @@ -117,6 +117,7 @@ module BrandDev def web_scrape_sitemap: ( domain: String, ?max_links: Integer, + ?url_regex: String, ?request_options: BrandDev::request_opts ) -> BrandDev::Models::BrandWebScrapeSitemapResponse From 023298019046efe040606dad7220b842436a7a95 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 21 Apr 2026 13:44:25 +0000 Subject: [PATCH 26/82] codegen metadata --- .stats.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.stats.yml b/.stats.yml index 0a349a1..069181b 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 16 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-b6262c6c346b4e4c6db18bc0c74585bb0b1d8f239048e893e76de2fcfd15ce01.yml -openapi_spec_hash: 157593d2318122199aedd86d7755f941 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-9515e3e36a3c0be3fdd397d0e2934cf9c2accbe74b04711dcccb107ced266329.yml +openapi_spec_hash: 9409c01546e85f69aba881fb1d34c061 config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 From 67421f29c40507b6b9499d80e788914dcf3526b4 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 23 Apr 2026 03:39:48 +0000 Subject: [PATCH 27/82] chore(internal): more robust bootstrap script --- scripts/bootstrap | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/bootstrap b/scripts/bootstrap index 3487864..a5e1b80 100755 --- a/scripts/bootstrap +++ b/scripts/bootstrap @@ -4,7 +4,7 @@ set -e cd -- "$(dirname -- "$0")/.." -if [ -f "Brewfile" ] && [ "$(uname -s)" = "Darwin" ] && [ "$SKIP_BREW" != "1" ] && [ -t 0 ]; then +if [ -f "Brewfile" ] && [ "$(uname -s)" = "Darwin" ] && [ "${SKIP_BREW:-}" != "1" ] && [ -t 0 ]; then brew bundle check >/dev/null 2>&1 || { echo -n "==> Install Homebrew dependencies? (y/N): " read -r response From c20c69336c2b0a12ed217430f19648f7d5d415f1 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 23 Apr 2026 13:55:27 +0000 Subject: [PATCH 28/82] codegen metadata --- .stats.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.stats.yml b/.stats.yml index 069181b..2008d73 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 16 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-9515e3e36a3c0be3fdd397d0e2934cf9c2accbe74b04711dcccb107ced266329.yml -openapi_spec_hash: 9409c01546e85f69aba881fb1d34c061 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-bad99401f1babc6e34ab94e1700768545292825447e43fecbbfe426ae89c594c.yml +openapi_spec_hash: 2b40ce701c90ae2cb9f89ee7b52bbf5b config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 From 53929a404ec27e40072dab7db319060ce9356fdf Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 24 Apr 2026 01:01:44 +0000 Subject: [PATCH 29/82] feat(api): api update --- .stats.yml | 4 ++-- .../models/brand_web_scrape_html_params.rb | 12 +++++++++++- .../models/brand_web_scrape_md_params.rb | 12 +++++++++++- lib/brand_dev/resources/brand.rb | 11 ++++++++--- .../models/brand_web_scrape_html_params.rbi | 15 +++++++++++++++ .../models/brand_web_scrape_md_params.rbi | 15 +++++++++++++++ rbi/brand_dev/resources/brand.rbi | 10 ++++++++++ .../models/brand_web_scrape_html_params.rbs | 8 +++++++- .../models/brand_web_scrape_md_params.rbs | 7 +++++++ sig/brand_dev/resources/brand.rbs | 2 ++ 10 files changed, 88 insertions(+), 8 deletions(-) diff --git a/.stats.yml b/.stats.yml index 2008d73..2168363 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 16 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-bad99401f1babc6e34ab94e1700768545292825447e43fecbbfe426ae89c594c.yml -openapi_spec_hash: 2b40ce701c90ae2cb9f89ee7b52bbf5b +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-5feeb635e8e8c4d52f5ab3e689888134427dae866a0c5264a31598a538673130.yml +openapi_spec_hash: 9619b7626bbad5468f41623726e229c9 config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 diff --git a/lib/brand_dev/models/brand_web_scrape_html_params.rb b/lib/brand_dev/models/brand_web_scrape_html_params.rb index 30471ae..aeb3932 100644 --- a/lib/brand_dev/models/brand_web_scrape_html_params.rb +++ b/lib/brand_dev/models/brand_web_scrape_html_params.rb @@ -21,7 +21,15 @@ class BrandWebScrapeHTMLParams < BrandDev::Internal::Type::BaseModel # @return [Integer, nil] optional :max_age_ms, Integer - # @!method initialize(url:, max_age_ms: nil, request_options: {}) + # @!attribute parse_pdf + # When true (default), PDF URLs are fetched and their text layer is extracted and + # returned wrapped in …. When false, PDF URLs are skipped + # and a 400 WEBSITE_ACCESS_ERROR is returned. + # + # @return [Boolean, nil] + optional :parse_pdf, BrandDev::Internal::Type::Boolean + + # @!method initialize(url:, max_age_ms: nil, parse_pdf: nil, request_options: {}) # Some parameter documentations has been truncated, see # {BrandDev::Models::BrandWebScrapeHTMLParams} for more details. # @@ -29,6 +37,8 @@ class BrandWebScrapeHTMLParams < BrandDev::Internal::Type::BaseModel # # @param max_age_ms [Integer] Return a cached result if a prior scrape for the same parameters exists and is y # + # @param parse_pdf [Boolean] When true (default), PDF URLs are fetched and their text layer is extracted and + # # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/brand_dev/models/brand_web_scrape_md_params.rb b/lib/brand_dev/models/brand_web_scrape_md_params.rb index ab2fb8e..df3521f 100644 --- a/lib/brand_dev/models/brand_web_scrape_md_params.rb +++ b/lib/brand_dev/models/brand_web_scrape_md_params.rb @@ -34,6 +34,14 @@ class BrandWebScrapeMdParams < BrandDev::Internal::Type::BaseModel # @return [Integer, nil] optional :max_age_ms, Integer + # @!attribute parse_pdf + # When true (default), PDF URLs are fetched and their text layer is extracted and + # converted to Markdown. When false, PDF URLs are skipped and a 400 + # WEBSITE_ACCESS_ERROR is returned. + # + # @return [Boolean, nil] + optional :parse_pdf, BrandDev::Internal::Type::Boolean + # @!attribute shorten_base64_images # Shorten base64-encoded image data in the Markdown output # @@ -47,7 +55,7 @@ class BrandWebScrapeMdParams < BrandDev::Internal::Type::BaseModel # @return [Boolean, nil] optional :use_main_content_only, BrandDev::Internal::Type::Boolean - # @!method initialize(url:, include_images: nil, include_links: nil, max_age_ms: nil, shorten_base64_images: nil, use_main_content_only: nil, request_options: {}) + # @!method initialize(url:, include_images: nil, include_links: nil, max_age_ms: nil, parse_pdf: nil, shorten_base64_images: nil, use_main_content_only: nil, request_options: {}) # Some parameter documentations has been truncated, see # {BrandDev::Models::BrandWebScrapeMdParams} for more details. # @@ -59,6 +67,8 @@ class BrandWebScrapeMdParams < BrandDev::Internal::Type::BaseModel # # @param max_age_ms [Integer] Return a cached result if a prior scrape for the same parameters exists and is y # + # @param parse_pdf [Boolean] When true (default), PDF URLs are fetched and their text layer is extracted and + # # @param shorten_base64_images [Boolean] Shorten base64-encoded image data in the Markdown output # # @param use_main_content_only [Boolean] Extract only the main content of the page, excluding headers, footers, sidebars, diff --git a/lib/brand_dev/resources/brand.rb b/lib/brand_dev/resources/brand.rb index 6bb2b48..beaf4bf 100644 --- a/lib/brand_dev/resources/brand.rb +++ b/lib/brand_dev/resources/brand.rb @@ -396,12 +396,14 @@ def retrieve_simplified(params) # # Scrapes the given URL and returns the raw HTML content of the page. # - # @overload web_scrape_html(url:, max_age_ms: nil, request_options: {}) + # @overload web_scrape_html(url:, max_age_ms: nil, parse_pdf: nil, request_options: {}) # # @param url [String] Full URL to scrape (must include http:// or https:// protocol) # # @param max_age_ms [Integer] Return a cached result if a prior scrape for the same parameters exists and is y # + # @param parse_pdf [Boolean] When true (default), PDF URLs are fetched and their text layer is extracted and + # # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [BrandDev::Models::BrandWebScrapeHTMLResponse] @@ -413,7 +415,7 @@ def web_scrape_html(params) @client.request( method: :get, path: "web/scrape/html", - query: query.transform_keys(max_age_ms: "maxAgeMs"), + query: query.transform_keys(max_age_ms: "maxAgeMs", parse_pdf: "parsePDF"), model: BrandDev::Models::BrandWebScrapeHTMLResponse, options: options ) @@ -449,7 +451,7 @@ def web_scrape_images(params) # # Scrapes the given URL into LLM usable Markdown. # - # @overload web_scrape_md(url:, include_images: nil, include_links: nil, max_age_ms: nil, shorten_base64_images: nil, use_main_content_only: nil, request_options: {}) + # @overload web_scrape_md(url:, include_images: nil, include_links: nil, max_age_ms: nil, parse_pdf: nil, shorten_base64_images: nil, use_main_content_only: nil, request_options: {}) # # @param url [String] Full URL to scrape into LLM usable Markdown (must include http:// or https:// pr # @@ -459,6 +461,8 @@ def web_scrape_images(params) # # @param max_age_ms [Integer] Return a cached result if a prior scrape for the same parameters exists and is y # + # @param parse_pdf [Boolean] When true (default), PDF URLs are fetched and their text layer is extracted and + # # @param shorten_base64_images [Boolean] Shorten base64-encoded image data in the Markdown output # # @param use_main_content_only [Boolean] Extract only the main content of the page, excluding headers, footers, sidebars, @@ -478,6 +482,7 @@ def web_scrape_md(params) include_images: "includeImages", include_links: "includeLinks", max_age_ms: "maxAgeMs", + parse_pdf: "parsePDF", shorten_base64_images: "shortenBase64Images", use_main_content_only: "useMainContentOnly" ), diff --git a/rbi/brand_dev/models/brand_web_scrape_html_params.rbi b/rbi/brand_dev/models/brand_web_scrape_html_params.rbi index e7fd002..dc549bf 100644 --- a/rbi/brand_dev/models/brand_web_scrape_html_params.rbi +++ b/rbi/brand_dev/models/brand_web_scrape_html_params.rbi @@ -24,10 +24,20 @@ module BrandDev sig { params(max_age_ms: Integer).void } attr_writer :max_age_ms + # When true (default), PDF URLs are fetched and their text layer is extracted and + # returned wrapped in …. When false, PDF URLs are skipped + # and a 400 WEBSITE_ACCESS_ERROR is returned. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :parse_pdf + + sig { params(parse_pdf: T::Boolean).void } + attr_writer :parse_pdf + sig do params( url: String, max_age_ms: Integer, + parse_pdf: T::Boolean, request_options: BrandDev::RequestOptions::OrHash ).returns(T.attached_class) end @@ -38,6 +48,10 @@ module BrandDev # younger than this many milliseconds. Defaults to 1 day (86400000 ms) when # omitted. Max is 30 days (2592000000 ms). Set to 0 to always scrape fresh. max_age_ms: nil, + # When true (default), PDF URLs are fetched and their text layer is extracted and + # returned wrapped in …. When false, PDF URLs are skipped + # and a 400 WEBSITE_ACCESS_ERROR is returned. + parse_pdf: nil, request_options: {} ) end @@ -47,6 +61,7 @@ module BrandDev { url: String, max_age_ms: Integer, + parse_pdf: T::Boolean, request_options: BrandDev::RequestOptions } ) diff --git a/rbi/brand_dev/models/brand_web_scrape_md_params.rbi b/rbi/brand_dev/models/brand_web_scrape_md_params.rbi index 98df987..ad30542 100644 --- a/rbi/brand_dev/models/brand_web_scrape_md_params.rbi +++ b/rbi/brand_dev/models/brand_web_scrape_md_params.rbi @@ -39,6 +39,15 @@ module BrandDev sig { params(max_age_ms: Integer).void } attr_writer :max_age_ms + # When true (default), PDF URLs are fetched and their text layer is extracted and + # converted to Markdown. When false, PDF URLs are skipped and a 400 + # WEBSITE_ACCESS_ERROR is returned. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :parse_pdf + + sig { params(parse_pdf: T::Boolean).void } + attr_writer :parse_pdf + # Shorten base64-encoded image data in the Markdown output sig { returns(T.nilable(T::Boolean)) } attr_reader :shorten_base64_images @@ -60,6 +69,7 @@ module BrandDev include_images: T::Boolean, include_links: T::Boolean, max_age_ms: Integer, + parse_pdf: T::Boolean, shorten_base64_images: T::Boolean, use_main_content_only: T::Boolean, request_options: BrandDev::RequestOptions::OrHash @@ -77,6 +87,10 @@ module BrandDev # younger than this many milliseconds. Defaults to 1 day (86400000 ms) when # omitted. Max is 30 days (2592000000 ms). Set to 0 to always scrape fresh. max_age_ms: nil, + # When true (default), PDF URLs are fetched and their text layer is extracted and + # converted to Markdown. When false, PDF URLs are skipped and a 400 + # WEBSITE_ACCESS_ERROR is returned. + parse_pdf: nil, # Shorten base64-encoded image data in the Markdown output shorten_base64_images: nil, # Extract only the main content of the page, excluding headers, footers, sidebars, @@ -93,6 +107,7 @@ module BrandDev include_images: T::Boolean, include_links: T::Boolean, max_age_ms: Integer, + parse_pdf: T::Boolean, shorten_base64_images: T::Boolean, use_main_content_only: T::Boolean, request_options: BrandDev::RequestOptions diff --git a/rbi/brand_dev/resources/brand.rbi b/rbi/brand_dev/resources/brand.rbi index 11fda07..e48b6b3 100644 --- a/rbi/brand_dev/resources/brand.rbi +++ b/rbi/brand_dev/resources/brand.rbi @@ -348,6 +348,7 @@ module BrandDev params( url: String, max_age_ms: Integer, + parse_pdf: T::Boolean, request_options: BrandDev::RequestOptions::OrHash ).returns(BrandDev::Models::BrandWebScrapeHTMLResponse) end @@ -358,6 +359,10 @@ module BrandDev # younger than this many milliseconds. Defaults to 1 day (86400000 ms) when # omitted. Max is 30 days (2592000000 ms). Set to 0 to always scrape fresh. max_age_ms: nil, + # When true (default), PDF URLs are fetched and their text layer is extracted and + # returned wrapped in …. When false, PDF URLs are skipped + # and a 400 WEBSITE_ACCESS_ERROR is returned. + parse_pdf: nil, request_options: {} ) end @@ -385,6 +390,7 @@ module BrandDev include_images: T::Boolean, include_links: T::Boolean, max_age_ms: Integer, + parse_pdf: T::Boolean, shorten_base64_images: T::Boolean, use_main_content_only: T::Boolean, request_options: BrandDev::RequestOptions::OrHash @@ -402,6 +408,10 @@ module BrandDev # younger than this many milliseconds. Defaults to 1 day (86400000 ms) when # omitted. Max is 30 days (2592000000 ms). Set to 0 to always scrape fresh. max_age_ms: nil, + # When true (default), PDF URLs are fetched and their text layer is extracted and + # converted to Markdown. When false, PDF URLs are skipped and a 400 + # WEBSITE_ACCESS_ERROR is returned. + parse_pdf: nil, # Shorten base64-encoded image data in the Markdown output shorten_base64_images: nil, # Extract only the main content of the page, excluding headers, footers, sidebars, diff --git a/sig/brand_dev/models/brand_web_scrape_html_params.rbs b/sig/brand_dev/models/brand_web_scrape_html_params.rbs index 200fd52..0e5e804 100644 --- a/sig/brand_dev/models/brand_web_scrape_html_params.rbs +++ b/sig/brand_dev/models/brand_web_scrape_html_params.rbs @@ -1,7 +1,7 @@ module BrandDev module Models type brand_web_scrape_html_params = - { url: String, max_age_ms: Integer } + { url: String, max_age_ms: Integer, parse_pdf: bool } & BrandDev::Internal::Type::request_parameters class BrandWebScrapeHTMLParams < BrandDev::Internal::Type::BaseModel @@ -14,15 +14,21 @@ module BrandDev def max_age_ms=: (Integer) -> Integer + attr_reader parse_pdf: bool? + + def parse_pdf=: (bool) -> bool + def initialize: ( url: String, ?max_age_ms: Integer, + ?parse_pdf: bool, ?request_options: BrandDev::request_opts ) -> void def to_hash: -> { url: String, max_age_ms: Integer, + parse_pdf: bool, request_options: BrandDev::RequestOptions } end diff --git a/sig/brand_dev/models/brand_web_scrape_md_params.rbs b/sig/brand_dev/models/brand_web_scrape_md_params.rbs index 310ad33..5d32b5a 100644 --- a/sig/brand_dev/models/brand_web_scrape_md_params.rbs +++ b/sig/brand_dev/models/brand_web_scrape_md_params.rbs @@ -6,6 +6,7 @@ module BrandDev include_images: bool, include_links: bool, max_age_ms: Integer, + parse_pdf: bool, :shorten_base64_images => bool, use_main_content_only: bool } @@ -29,6 +30,10 @@ module BrandDev def max_age_ms=: (Integer) -> Integer + attr_reader parse_pdf: bool? + + def parse_pdf=: (bool) -> bool + attr_reader shorten_base64_images: bool? def shorten_base64_images=: (bool) -> bool @@ -42,6 +47,7 @@ module BrandDev ?include_images: bool, ?include_links: bool, ?max_age_ms: Integer, + ?parse_pdf: bool, ?shorten_base64_images: bool, ?use_main_content_only: bool, ?request_options: BrandDev::request_opts @@ -52,6 +58,7 @@ module BrandDev include_images: bool, include_links: bool, max_age_ms: Integer, + parse_pdf: bool, :shorten_base64_images => bool, use_main_content_only: bool, request_options: BrandDev::RequestOptions diff --git a/sig/brand_dev/resources/brand.rbs b/sig/brand_dev/resources/brand.rbs index a8d0e0c..8e7e1e7 100644 --- a/sig/brand_dev/resources/brand.rbs +++ b/sig/brand_dev/resources/brand.rbs @@ -96,6 +96,7 @@ module BrandDev def web_scrape_html: ( url: String, ?max_age_ms: Integer, + ?parse_pdf: bool, ?request_options: BrandDev::request_opts ) -> BrandDev::Models::BrandWebScrapeHTMLResponse @@ -109,6 +110,7 @@ module BrandDev ?include_images: bool, ?include_links: bool, ?max_age_ms: Integer, + ?parse_pdf: bool, ?shorten_base64_images: bool, ?use_main_content_only: bool, ?request_options: BrandDev::request_opts From 82f99f70cb3753d51c8d7befa710962a96b52f34 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 24 Apr 2026 01:56:06 +0000 Subject: [PATCH 30/82] feat(api): api update --- .stats.yml | 4 ++-- .../models/brand_ai_product_response.rb | 16 +++++++++++++++- .../models/brand_ai_products_response.rb | 16 +++++++++++++++- .../models/brand_ai_product_response.rbi | 14 ++++++++++++++ .../models/brand_ai_products_response.rbi | 14 ++++++++++++++ .../models/brand_ai_product_response.rbs | 5 +++++ .../models/brand_ai_products_response.rbs | 5 +++++ 7 files changed, 70 insertions(+), 4 deletions(-) diff --git a/.stats.yml b/.stats.yml index 2168363..c2c1aed 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 16 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-5feeb635e8e8c4d52f5ab3e689888134427dae866a0c5264a31598a538673130.yml -openapi_spec_hash: 9619b7626bbad5468f41623726e229c9 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-a79be9698f9c8908538102f0ea3ed43ce85be94c723f81ce3f7143b6dd394c62.yml +openapi_spec_hash: 840d5e6c9fd1710942bd61ab08f7f411 config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 diff --git a/lib/brand_dev/models/brand_ai_product_response.rb b/lib/brand_dev/models/brand_ai_product_response.rb index b55be6d..99694f7 100644 --- a/lib/brand_dev/models/brand_ai_product_response.rb +++ b/lib/brand_dev/models/brand_ai_product_response.rb @@ -70,6 +70,15 @@ class Product < BrandDev::Internal::Type::BaseModel # @return [String] required :name, String + # @!attribute sku + # Stock Keeping Unit (product identifier). Extracted from structured data (JSON-LD + # Product.sku), microdata, meta tags, platform-specific identifiers (e.g. Amazon + # ASIN, Etsy listing ID), or visible SKU/Model/Item # text. Null if no identifier + # is found. + # + # @return [String, nil] + required :sku, String, nil?: true + # @!attribute tags # Tags associated with the product # @@ -128,7 +137,10 @@ class Product < BrandDev::Internal::Type::BaseModel # @return [String, nil] optional :url, String, nil?: true - # @!method initialize(description:, features:, images:, name:, tags:, target_audience:, billing_frequency: nil, category: nil, currency: nil, image_url: nil, price: nil, pricing_model: nil, url: nil) + # @!method initialize(description:, features:, images:, name:, sku:, tags:, target_audience:, billing_frequency: nil, category: nil, currency: nil, image_url: nil, price: nil, pricing_model: nil, url: nil) + # Some parameter documentations has been truncated, see + # {BrandDev::Models::BrandAIProductResponse::Product} for more details. + # # The extracted product data, or null if not a product page # # @param description [String] Description of the product @@ -139,6 +151,8 @@ class Product < BrandDev::Internal::Type::BaseModel # # @param name [String] Name of the product # + # @param sku [String, nil] Stock Keeping Unit (product identifier). Extracted from structured data (JSON-LD + # # @param tags [Array] Tags associated with the product # # @param target_audience [Array] Target audience for the product (array of strings) diff --git a/lib/brand_dev/models/brand_ai_products_response.rb b/lib/brand_dev/models/brand_ai_products_response.rb index 217e1b5..d297629 100644 --- a/lib/brand_dev/models/brand_ai_products_response.rb +++ b/lib/brand_dev/models/brand_ai_products_response.rb @@ -39,6 +39,15 @@ class Product < BrandDev::Internal::Type::BaseModel # @return [String] required :name, String + # @!attribute sku + # Stock Keeping Unit (product identifier). Extracted from structured data (JSON-LD + # Product.sku), microdata, meta tags, platform-specific identifiers (e.g. Amazon + # ASIN, Etsy listing ID), or visible SKU/Model/Item # text. Null if no identifier + # is found. + # + # @return [String, nil] + required :sku, String, nil?: true + # @!attribute tags # Tags associated with the product # @@ -97,7 +106,10 @@ class Product < BrandDev::Internal::Type::BaseModel # @return [String, nil] optional :url, String, nil?: true - # @!method initialize(description:, features:, images:, name:, tags:, target_audience:, billing_frequency: nil, category: nil, currency: nil, image_url: nil, price: nil, pricing_model: nil, url: nil) + # @!method initialize(description:, features:, images:, name:, sku:, tags:, target_audience:, billing_frequency: nil, category: nil, currency: nil, image_url: nil, price: nil, pricing_model: nil, url: nil) + # Some parameter documentations has been truncated, see + # {BrandDev::Models::BrandAIProductsResponse::Product} for more details. + # # @param description [String] Description of the product # # @param features [Array] List of product features @@ -106,6 +118,8 @@ class Product < BrandDev::Internal::Type::BaseModel # # @param name [String] Name of the product # + # @param sku [String, nil] Stock Keeping Unit (product identifier). Extracted from structured data (JSON-LD + # # @param tags [Array] Tags associated with the product # # @param target_audience [Array] Target audience for the product (array of strings) diff --git a/rbi/brand_dev/models/brand_ai_product_response.rbi b/rbi/brand_dev/models/brand_ai_product_response.rbi index 4eadc37..4fae330 100644 --- a/rbi/brand_dev/models/brand_ai_product_response.rbi +++ b/rbi/brand_dev/models/brand_ai_product_response.rbi @@ -146,6 +146,13 @@ module BrandDev sig { returns(String) } attr_accessor :name + # Stock Keeping Unit (product identifier). Extracted from structured data (JSON-LD + # Product.sku), microdata, meta tags, platform-specific identifiers (e.g. Amazon + # ASIN, Etsy listing ID), or visible SKU/Model/Item # text. Null if no identifier + # is found. + sig { returns(T.nilable(String)) } + attr_accessor :sku + # Tags associated with the product sig { returns(T::Array[String]) } attr_accessor :tags @@ -201,6 +208,7 @@ module BrandDev features: T::Array[String], images: T::Array[String], name: String, + sku: T.nilable(String), tags: T::Array[String], target_audience: T::Array[String], billing_frequency: @@ -227,6 +235,11 @@ module BrandDev images:, # Name of the product name:, + # Stock Keeping Unit (product identifier). Extracted from structured data (JSON-LD + # Product.sku), microdata, meta tags, platform-specific identifiers (e.g. Amazon + # ASIN, Etsy listing ID), or visible SKU/Model/Item # text. Null if no identifier + # is found. + sku:, # Tags associated with the product tags:, # Target audience for the product (array of strings) @@ -255,6 +268,7 @@ module BrandDev features: T::Array[String], images: T::Array[String], name: String, + sku: T.nilable(String), tags: T::Array[String], target_audience: T::Array[String], billing_frequency: diff --git a/rbi/brand_dev/models/brand_ai_products_response.rbi b/rbi/brand_dev/models/brand_ai_products_response.rbi index 1aa1dfc..8febe9a 100644 --- a/rbi/brand_dev/models/brand_ai_products_response.rbi +++ b/rbi/brand_dev/models/brand_ai_products_response.rbi @@ -77,6 +77,13 @@ module BrandDev sig { returns(String) } attr_accessor :name + # Stock Keeping Unit (product identifier). Extracted from structured data (JSON-LD + # Product.sku), microdata, meta tags, platform-specific identifiers (e.g. Amazon + # ASIN, Etsy listing ID), or visible SKU/Model/Item # text. Null if no identifier + # is found. + sig { returns(T.nilable(String)) } + attr_accessor :sku + # Tags associated with the product sig { returns(T::Array[String]) } attr_accessor :tags @@ -131,6 +138,7 @@ module BrandDev features: T::Array[String], images: T::Array[String], name: String, + sku: T.nilable(String), tags: T::Array[String], target_audience: T::Array[String], billing_frequency: @@ -157,6 +165,11 @@ module BrandDev images:, # Name of the product name:, + # Stock Keeping Unit (product identifier). Extracted from structured data (JSON-LD + # Product.sku), microdata, meta tags, platform-specific identifiers (e.g. Amazon + # ASIN, Etsy listing ID), or visible SKU/Model/Item # text. Null if no identifier + # is found. + sku:, # Tags associated with the product tags:, # Target audience for the product (array of strings) @@ -185,6 +198,7 @@ module BrandDev features: T::Array[String], images: T::Array[String], name: String, + sku: T.nilable(String), tags: T::Array[String], target_audience: T::Array[String], billing_frequency: diff --git a/sig/brand_dev/models/brand_ai_product_response.rbs b/sig/brand_dev/models/brand_ai_product_response.rbs index 4524a38..a36ea6b 100644 --- a/sig/brand_dev/models/brand_ai_product_response.rbs +++ b/sig/brand_dev/models/brand_ai_product_response.rbs @@ -47,6 +47,7 @@ module BrandDev features: ::Array[String], images: ::Array[String], name: String, + sku: String?, tags: ::Array[String], target_audience: ::Array[String], billing_frequency: BrandDev::Models::BrandAIProductResponse::Product::billing_frequency?, @@ -67,6 +68,8 @@ module BrandDev attr_accessor name: String + attr_accessor sku: String? + attr_accessor tags: ::Array[String] attr_accessor target_audience: ::Array[String] @@ -90,6 +93,7 @@ module BrandDev features: ::Array[String], images: ::Array[String], name: String, + sku: String?, tags: ::Array[String], target_audience: ::Array[String], ?billing_frequency: BrandDev::Models::BrandAIProductResponse::Product::billing_frequency?, @@ -106,6 +110,7 @@ module BrandDev features: ::Array[String], images: ::Array[String], name: String, + sku: String?, tags: ::Array[String], target_audience: ::Array[String], billing_frequency: BrandDev::Models::BrandAIProductResponse::Product::billing_frequency?, diff --git a/sig/brand_dev/models/brand_ai_products_response.rbs b/sig/brand_dev/models/brand_ai_products_response.rbs index 6023ca2..88f88a6 100644 --- a/sig/brand_dev/models/brand_ai_products_response.rbs +++ b/sig/brand_dev/models/brand_ai_products_response.rbs @@ -24,6 +24,7 @@ module BrandDev features: ::Array[String], images: ::Array[String], name: String, + sku: String?, tags: ::Array[String], target_audience: ::Array[String], billing_frequency: BrandDev::Models::BrandAIProductsResponse::Product::billing_frequency?, @@ -44,6 +45,8 @@ module BrandDev attr_accessor name: String + attr_accessor sku: String? + attr_accessor tags: ::Array[String] attr_accessor target_audience: ::Array[String] @@ -67,6 +70,7 @@ module BrandDev features: ::Array[String], images: ::Array[String], name: String, + sku: String?, tags: ::Array[String], target_audience: ::Array[String], ?billing_frequency: BrandDev::Models::BrandAIProductsResponse::Product::billing_frequency?, @@ -83,6 +87,7 @@ module BrandDev features: ::Array[String], images: ::Array[String], name: String, + sku: String?, tags: ::Array[String], target_audience: ::Array[String], billing_frequency: BrandDev::Models::BrandAIProductsResponse::Product::billing_frequency?, From ac2bf07be9f7b5a636016c3f2ec55ca48b5ae971 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 24 Apr 2026 02:03:03 +0000 Subject: [PATCH 31/82] feat(api): api update --- .stats.yml | 4 ++-- lib/brand_dev/models/brand_ai_product_response.rb | 10 ++-------- lib/brand_dev/models/brand_ai_products_response.rb | 10 ++-------- rbi/brand_dev/models/brand_ai_product_response.rbi | 10 ++-------- rbi/brand_dev/models/brand_ai_products_response.rbi | 10 ++-------- 5 files changed, 10 insertions(+), 34 deletions(-) diff --git a/.stats.yml b/.stats.yml index c2c1aed..5d1e9ce 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 16 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-a79be9698f9c8908538102f0ea3ed43ce85be94c723f81ce3f7143b6dd394c62.yml -openapi_spec_hash: 840d5e6c9fd1710942bd61ab08f7f411 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-2952aaffb14241bbdb6df2c3f4a83d21527a969cc1ed03f0ee4b3399973891a5.yml +openapi_spec_hash: ea489ac04d293ed777fefb705782e165 config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 diff --git a/lib/brand_dev/models/brand_ai_product_response.rb b/lib/brand_dev/models/brand_ai_product_response.rb index 99694f7..ef4b2b9 100644 --- a/lib/brand_dev/models/brand_ai_product_response.rb +++ b/lib/brand_dev/models/brand_ai_product_response.rb @@ -71,10 +71,7 @@ class Product < BrandDev::Internal::Type::BaseModel required :name, String # @!attribute sku - # Stock Keeping Unit (product identifier). Extracted from structured data (JSON-LD - # Product.sku), microdata, meta tags, platform-specific identifiers (e.g. Amazon - # ASIN, Etsy listing ID), or visible SKU/Model/Item # text. Null if no identifier - # is found. + # Stock Keeping Unit (product identifier). Null if no identifier is found. # # @return [String, nil] required :sku, String, nil?: true @@ -138,9 +135,6 @@ class Product < BrandDev::Internal::Type::BaseModel optional :url, String, nil?: true # @!method initialize(description:, features:, images:, name:, sku:, tags:, target_audience:, billing_frequency: nil, category: nil, currency: nil, image_url: nil, price: nil, pricing_model: nil, url: nil) - # Some parameter documentations has been truncated, see - # {BrandDev::Models::BrandAIProductResponse::Product} for more details. - # # The extracted product data, or null if not a product page # # @param description [String] Description of the product @@ -151,7 +145,7 @@ class Product < BrandDev::Internal::Type::BaseModel # # @param name [String] Name of the product # - # @param sku [String, nil] Stock Keeping Unit (product identifier). Extracted from structured data (JSON-LD + # @param sku [String, nil] Stock Keeping Unit (product identifier). Null if no identifier is found. # # @param tags [Array] Tags associated with the product # diff --git a/lib/brand_dev/models/brand_ai_products_response.rb b/lib/brand_dev/models/brand_ai_products_response.rb index d297629..aab78c9 100644 --- a/lib/brand_dev/models/brand_ai_products_response.rb +++ b/lib/brand_dev/models/brand_ai_products_response.rb @@ -40,10 +40,7 @@ class Product < BrandDev::Internal::Type::BaseModel required :name, String # @!attribute sku - # Stock Keeping Unit (product identifier). Extracted from structured data (JSON-LD - # Product.sku), microdata, meta tags, platform-specific identifiers (e.g. Amazon - # ASIN, Etsy listing ID), or visible SKU/Model/Item # text. Null if no identifier - # is found. + # Stock Keeping Unit (product identifier). Null if no identifier is found. # # @return [String, nil] required :sku, String, nil?: true @@ -107,9 +104,6 @@ class Product < BrandDev::Internal::Type::BaseModel optional :url, String, nil?: true # @!method initialize(description:, features:, images:, name:, sku:, tags:, target_audience:, billing_frequency: nil, category: nil, currency: nil, image_url: nil, price: nil, pricing_model: nil, url: nil) - # Some parameter documentations has been truncated, see - # {BrandDev::Models::BrandAIProductsResponse::Product} for more details. - # # @param description [String] Description of the product # # @param features [Array] List of product features @@ -118,7 +112,7 @@ class Product < BrandDev::Internal::Type::BaseModel # # @param name [String] Name of the product # - # @param sku [String, nil] Stock Keeping Unit (product identifier). Extracted from structured data (JSON-LD + # @param sku [String, nil] Stock Keeping Unit (product identifier). Null if no identifier is found. # # @param tags [Array] Tags associated with the product # diff --git a/rbi/brand_dev/models/brand_ai_product_response.rbi b/rbi/brand_dev/models/brand_ai_product_response.rbi index 4fae330..153843d 100644 --- a/rbi/brand_dev/models/brand_ai_product_response.rbi +++ b/rbi/brand_dev/models/brand_ai_product_response.rbi @@ -146,10 +146,7 @@ module BrandDev sig { returns(String) } attr_accessor :name - # Stock Keeping Unit (product identifier). Extracted from structured data (JSON-LD - # Product.sku), microdata, meta tags, platform-specific identifiers (e.g. Amazon - # ASIN, Etsy listing ID), or visible SKU/Model/Item # text. Null if no identifier - # is found. + # Stock Keeping Unit (product identifier). Null if no identifier is found. sig { returns(T.nilable(String)) } attr_accessor :sku @@ -235,10 +232,7 @@ module BrandDev images:, # Name of the product name:, - # Stock Keeping Unit (product identifier). Extracted from structured data (JSON-LD - # Product.sku), microdata, meta tags, platform-specific identifiers (e.g. Amazon - # ASIN, Etsy listing ID), or visible SKU/Model/Item # text. Null if no identifier - # is found. + # Stock Keeping Unit (product identifier). Null if no identifier is found. sku:, # Tags associated with the product tags:, diff --git a/rbi/brand_dev/models/brand_ai_products_response.rbi b/rbi/brand_dev/models/brand_ai_products_response.rbi index 8febe9a..41c376e 100644 --- a/rbi/brand_dev/models/brand_ai_products_response.rbi +++ b/rbi/brand_dev/models/brand_ai_products_response.rbi @@ -77,10 +77,7 @@ module BrandDev sig { returns(String) } attr_accessor :name - # Stock Keeping Unit (product identifier). Extracted from structured data (JSON-LD - # Product.sku), microdata, meta tags, platform-specific identifiers (e.g. Amazon - # ASIN, Etsy listing ID), or visible SKU/Model/Item # text. Null if no identifier - # is found. + # Stock Keeping Unit (product identifier). Null if no identifier is found. sig { returns(T.nilable(String)) } attr_accessor :sku @@ -165,10 +162,7 @@ module BrandDev images:, # Name of the product name:, - # Stock Keeping Unit (product identifier). Extracted from structured data (JSON-LD - # Product.sku), microdata, meta tags, platform-specific identifiers (e.g. Amazon - # ASIN, Etsy listing ID), or visible SKU/Model/Item # text. Null if no identifier - # is found. + # Stock Keeping Unit (product identifier). Null if no identifier is found. sku:, # Tags associated with the product tags:, From a43574ff5893076110a6f6464a6e4a4bc8729162 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sat, 25 Apr 2026 19:34:06 +0000 Subject: [PATCH 32/82] codegen metadata --- .stats.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.stats.yml b/.stats.yml index 5d1e9ce..31233ea 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 16 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-2952aaffb14241bbdb6df2c3f4a83d21527a969cc1ed03f0ee4b3399973891a5.yml -openapi_spec_hash: ea489ac04d293ed777fefb705782e165 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-0556b1d48d8bff03ed38b606fdb77620a74cc8e0df9dadd3445d20a0662cea5d.yml +openapi_spec_hash: 953bc57b3ad20e8dba19cecf23ef0425 config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 From ca48f5d705b4d1cbcf27da2f9778f31d8c9bf850 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sat, 25 Apr 2026 23:41:35 +0000 Subject: [PATCH 33/82] codegen metadata --- .stats.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.stats.yml b/.stats.yml index 31233ea..e319589 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 16 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-0556b1d48d8bff03ed38b606fdb77620a74cc8e0df9dadd3445d20a0662cea5d.yml -openapi_spec_hash: 953bc57b3ad20e8dba19cecf23ef0425 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-83beb1a8b5d19a48d62b81a81c14badd01dab69a3b636d63dc70199de3644d0d.yml +openapi_spec_hash: eeb3bbf7ccb4d14e0288cc88045dd007 config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 From 283f2676e5ef02cccf00ce078b38e63ccd9d3387 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sun, 26 Apr 2026 02:24:48 +0000 Subject: [PATCH 34/82] feat(api): api update --- .stats.yml | 4 ++-- lib/brand_dev/resources/brand.rb | 19 +++++++------------ rbi/brand_dev/resources/brand.rbi | 19 +++++++------------ 3 files changed, 16 insertions(+), 26 deletions(-) diff --git a/.stats.yml b/.stats.yml index e319589..9399718 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 16 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-83beb1a8b5d19a48d62b81a81c14badd01dab69a3b636d63dc70199de3644d0d.yml -openapi_spec_hash: eeb3bbf7ccb4d14e0288cc88045dd007 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-2c2882c6fc2b0cd3a9cc19fd1a01f969b9333a96f8bc53f83b0c3e051ddc97c4.yml +openapi_spec_hash: af01b87a25eeafec960c95f31acab235 config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 diff --git a/lib/brand_dev/resources/brand.rb b/lib/brand_dev/resources/brand.rb index beaf4bf..08f015b 100644 --- a/lib/brand_dev/resources/brand.rb +++ b/lib/brand_dev/resources/brand.rb @@ -39,9 +39,8 @@ def retrieve(params) # Some parameter documentations has been truncated, see # {BrandDev::Models::BrandAIProductParams} for more details. # - # Beta feature: Given a single URL, determines if it is a product detail page, - # classifies the platform/product type, and extracts the product information. - # Supports Amazon, TikTok Shop, Etsy, and generic ecommerce sites. + # Given a single URL, determines if it is a product page and extracts the product + # information. # # @overload ai_product(url:, timeout_ms: nil, request_options: {}) # @@ -65,9 +64,9 @@ def ai_product(params) ) end - # Beta feature: Extract product information from a brand's website. We will - # analyze the website and return a list of products with details such as name, - # description, image, pricing, features, and more. + # Extract product information from a brand's website. We will analyze the website + # and return a list of products with details such as name, description, image, + # pricing, features, and more. # # @overload ai_products(body:, request_options: {}) # @@ -168,9 +167,7 @@ def identify_from_transaction(params) # {BrandDev::Models::BrandPrefetchParams} for more details. # # Signal that you may fetch brand data for a particular domain soon to improve - # latency. This endpoint does not charge credits and is available for paid - # customers to optimize future requests. [You must be on a paid plan to use this - # endpoint] + # latency. # # @overload prefetch(domain:, timeout_ms: nil, request_options: {}) # @@ -200,9 +197,7 @@ def prefetch(params) # Signal that you may fetch brand data for a particular domain soon to improve # latency. This endpoint accepts an email address, extracts the domain from it, # validates that it's not a disposable or free email provider, and queues the - # domain for prefetching. This endpoint does not charge credits and is available - # for paid customers to optimize future requests. [You must be on a paid plan to - # use this endpoint] + # domain for prefetching. # # @overload prefetch_by_email(email:, timeout_ms: nil, request_options: {}) # diff --git a/rbi/brand_dev/resources/brand.rbi b/rbi/brand_dev/resources/brand.rbi index e48b6b3..a63f8cf 100644 --- a/rbi/brand_dev/resources/brand.rbi +++ b/rbi/brand_dev/resources/brand.rbi @@ -33,9 +33,8 @@ module BrandDev ) end - # Beta feature: Given a single URL, determines if it is a product detail page, - # classifies the platform/product type, and extracts the product information. - # Supports Amazon, TikTok Shop, Etsy, and generic ecommerce sites. + # Given a single URL, determines if it is a product page and extracts the product + # information. sig do params( url: String, @@ -53,9 +52,9 @@ module BrandDev ) end - # Beta feature: Extract product information from a brand's website. We will - # analyze the website and return a list of products with details such as name, - # description, image, pricing, features, and more. + # Extract product information from a brand's website. We will analyze the website + # and return a list of products with details such as name, description, image, + # pricing, features, and more. sig do params( body: @@ -146,9 +145,7 @@ module BrandDev end # Signal that you may fetch brand data for a particular domain soon to improve - # latency. This endpoint does not charge credits and is available for paid - # customers to optimize future requests. [You must be on a paid plan to use this - # endpoint] + # latency. sig do params( domain: String, @@ -170,9 +167,7 @@ module BrandDev # Signal that you may fetch brand data for a particular domain soon to improve # latency. This endpoint accepts an email address, extracts the domain from it, # validates that it's not a disposable or free email provider, and queues the - # domain for prefetching. This endpoint does not charge credits and is available - # for paid customers to optimize future requests. [You must be on a paid plan to - # use this endpoint] + # domain for prefetching. sig do params( email: String, From 830701fdc9b6573392750588b07b35c5a819325c Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sun, 26 Apr 2026 19:24:28 +0000 Subject: [PATCH 35/82] codegen metadata --- .stats.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.stats.yml b/.stats.yml index 9399718..f6a695d 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 16 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-2c2882c6fc2b0cd3a9cc19fd1a01f969b9333a96f8bc53f83b0c3e051ddc97c4.yml -openapi_spec_hash: af01b87a25eeafec960c95f31acab235 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-e80ff2bd2c88a023bfab185593d9bbc03d81b79b46b178a724b67ffffa504fc8.yml +openapi_spec_hash: fc81cc80368feba40e621e9449f03c6a config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 From 3c1db2ecd33a5f92eaf9c37dab6ee7956a38f379 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sun, 26 Apr 2026 23:25:45 +0000 Subject: [PATCH 36/82] feat(api): api update --- .stats.yml | 4 +- .../models/brand_ai_product_params.rb | 12 +++++- .../models/brand_ai_products_params.rb | 24 ++++++++++- lib/brand_dev/resources/brand.rb | 4 +- .../models/brand_ai_product_params.rbi | 15 +++++++ .../models/brand_ai_products_params.rbi | 42 ++++++++++++++++++- rbi/brand_dev/resources/brand.rbi | 5 +++ .../models/brand_ai_product_params.rbs | 8 +++- .../models/brand_ai_products_params.rbs | 26 +++++++++++- sig/brand_dev/resources/brand.rbs | 1 + 10 files changed, 130 insertions(+), 11 deletions(-) diff --git a/.stats.yml b/.stats.yml index f6a695d..c591270 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 16 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-e80ff2bd2c88a023bfab185593d9bbc03d81b79b46b178a724b67ffffa504fc8.yml -openapi_spec_hash: fc81cc80368feba40e621e9449f03c6a +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-632b293af91698403da1bcaf3fb91259636c772e5071a2dd0fc63c42cb591307.yml +openapi_spec_hash: d03dc81f33ef92c74aa3b5dea35cdeae config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 diff --git a/lib/brand_dev/models/brand_ai_product_params.rb b/lib/brand_dev/models/brand_ai_product_params.rb index bf0806d..cdd12ce 100644 --- a/lib/brand_dev/models/brand_ai_product_params.rb +++ b/lib/brand_dev/models/brand_ai_product_params.rb @@ -13,6 +13,14 @@ class BrandAIProductParams < BrandDev::Internal::Type::BaseModel # @return [String] required :url, String + # @!attribute max_age_ms + # Return a cached result if a prior scrape for the same parameters exists and is + # younger than this many milliseconds. Defaults to 7 days (604800000 ms) when + # omitted. Max is 30 days (2592000000 ms). Set to 0 to always scrape fresh. + # + # @return [Integer, nil] + optional :max_age_ms, Integer, api_name: :maxAgeMs + # @!attribute timeout_ms # Optional timeout in milliseconds for the request. Maximum allowed value is # 300000ms (5 minutes). @@ -20,12 +28,14 @@ class BrandAIProductParams < BrandDev::Internal::Type::BaseModel # @return [Integer, nil] optional :timeout_ms, Integer, api_name: :timeoutMS - # @!method initialize(url:, timeout_ms: nil, request_options: {}) + # @!method initialize(url:, max_age_ms: nil, timeout_ms: nil, request_options: {}) # Some parameter documentations has been truncated, see # {BrandDev::Models::BrandAIProductParams} for more details. # # @param url [String] The product page URL to extract product data from. # + # @param max_age_ms [Integer] Return a cached result if a prior scrape for the same parameters exists and is y + # # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. Maximum allowed value is 30000 # # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}] diff --git a/lib/brand_dev/models/brand_ai_products_params.rb b/lib/brand_dev/models/brand_ai_products_params.rb index 534bbea..332de91 100644 --- a/lib/brand_dev/models/brand_ai_products_params.rb +++ b/lib/brand_dev/models/brand_ai_products_params.rb @@ -30,6 +30,14 @@ class ByDomain < BrandDev::Internal::Type::BaseModel # @return [String] required :domain, String + # @!attribute max_age_ms + # Return a cached result if a prior scrape for the same parameters exists and is + # younger than this many milliseconds. Defaults to 7 days (604800000 ms) when + # omitted. Max is 30 days (2592000000 ms). Set to 0 to always scrape fresh. + # + # @return [Integer, nil] + optional :max_age_ms, Integer, api_name: :maxAgeMs + # @!attribute max_products # Maximum number of products to extract. # @@ -43,12 +51,14 @@ class ByDomain < BrandDev::Internal::Type::BaseModel # @return [Integer, nil] optional :timeout_ms, Integer, api_name: :timeoutMS - # @!method initialize(domain:, max_products: nil, timeout_ms: nil) + # @!method initialize(domain:, max_age_ms: nil, max_products: nil, timeout_ms: nil) # Some parameter documentations has been truncated, see # {BrandDev::Models::BrandAIProductsParams::Body::ByDomain} for more details. # # @param domain [String] The domain name to analyze. # + # @param max_age_ms [Integer] Return a cached result if a prior scrape for the same parameters exists and is y + # # @param max_products [Integer] Maximum number of products to extract. # # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. Maximum allowed value is 30000 @@ -62,6 +72,14 @@ class ByDirectURL < BrandDev::Internal::Type::BaseModel # @return [String] required :direct_url, String, api_name: :directUrl + # @!attribute max_age_ms + # Return a cached result if a prior scrape for the same parameters exists and is + # younger than this many milliseconds. Defaults to 7 days (604800000 ms) when + # omitted. Max is 30 days (2592000000 ms). Set to 0 to always scrape fresh. + # + # @return [Integer, nil] + optional :max_age_ms, Integer, api_name: :maxAgeMs + # @!attribute max_products # Maximum number of products to extract. # @@ -75,12 +93,14 @@ class ByDirectURL < BrandDev::Internal::Type::BaseModel # @return [Integer, nil] optional :timeout_ms, Integer, api_name: :timeoutMS - # @!method initialize(direct_url:, max_products: nil, timeout_ms: nil) + # @!method initialize(direct_url:, max_age_ms: nil, max_products: nil, timeout_ms: nil) # Some parameter documentations has been truncated, see # {BrandDev::Models::BrandAIProductsParams::Body::ByDirectURL} for more details. # # @param direct_url [String] A specific URL to use directly as the starting point for extraction without doma # + # @param max_age_ms [Integer] Return a cached result if a prior scrape for the same parameters exists and is y + # # @param max_products [Integer] Maximum number of products to extract. # # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. Maximum allowed value is 30000 diff --git a/lib/brand_dev/resources/brand.rb b/lib/brand_dev/resources/brand.rb index 08f015b..674a151 100644 --- a/lib/brand_dev/resources/brand.rb +++ b/lib/brand_dev/resources/brand.rb @@ -42,10 +42,12 @@ def retrieve(params) # Given a single URL, determines if it is a product page and extracts the product # information. # - # @overload ai_product(url:, timeout_ms: nil, request_options: {}) + # @overload ai_product(url:, max_age_ms: nil, timeout_ms: nil, request_options: {}) # # @param url [String] The product page URL to extract product data from. # + # @param max_age_ms [Integer] Return a cached result if a prior scrape for the same parameters exists and is y + # # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. Maximum allowed value is 30000 # # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}, nil] diff --git a/rbi/brand_dev/models/brand_ai_product_params.rbi b/rbi/brand_dev/models/brand_ai_product_params.rbi index 509b118..e7c48bb 100644 --- a/rbi/brand_dev/models/brand_ai_product_params.rbi +++ b/rbi/brand_dev/models/brand_ai_product_params.rbi @@ -15,6 +15,15 @@ module BrandDev sig { returns(String) } attr_accessor :url + # Return a cached result if a prior scrape for the same parameters exists and is + # younger than this many milliseconds. Defaults to 7 days (604800000 ms) when + # omitted. Max is 30 days (2592000000 ms). Set to 0 to always scrape fresh. + sig { returns(T.nilable(Integer)) } + attr_reader :max_age_ms + + sig { params(max_age_ms: Integer).void } + attr_writer :max_age_ms + # Optional timeout in milliseconds for the request. Maximum allowed value is # 300000ms (5 minutes). sig { returns(T.nilable(Integer)) } @@ -26,6 +35,7 @@ module BrandDev sig do params( url: String, + max_age_ms: Integer, timeout_ms: Integer, request_options: BrandDev::RequestOptions::OrHash ).returns(T.attached_class) @@ -33,6 +43,10 @@ module BrandDev def self.new( # The product page URL to extract product data from. url:, + # Return a cached result if a prior scrape for the same parameters exists and is + # younger than this many milliseconds. Defaults to 7 days (604800000 ms) when + # omitted. Max is 30 days (2592000000 ms). Set to 0 to always scrape fresh. + max_age_ms: nil, # Optional timeout in milliseconds for the request. Maximum allowed value is # 300000ms (5 minutes). timeout_ms: nil, @@ -44,6 +58,7 @@ module BrandDev override.returns( { url: String, + max_age_ms: Integer, timeout_ms: Integer, request_options: BrandDev::RequestOptions } diff --git a/rbi/brand_dev/models/brand_ai_products_params.rbi b/rbi/brand_dev/models/brand_ai_products_params.rbi index b4d5d75..8f8cefd 100644 --- a/rbi/brand_dev/models/brand_ai_products_params.rbi +++ b/rbi/brand_dev/models/brand_ai_products_params.rbi @@ -73,6 +73,15 @@ module BrandDev sig { returns(String) } attr_accessor :domain + # Return a cached result if a prior scrape for the same parameters exists and is + # younger than this many milliseconds. Defaults to 7 days (604800000 ms) when + # omitted. Max is 30 days (2592000000 ms). Set to 0 to always scrape fresh. + sig { returns(T.nilable(Integer)) } + attr_reader :max_age_ms + + sig { params(max_age_ms: Integer).void } + attr_writer :max_age_ms + # Maximum number of products to extract. sig { returns(T.nilable(Integer)) } attr_reader :max_products @@ -91,6 +100,7 @@ module BrandDev sig do params( domain: String, + max_age_ms: Integer, max_products: Integer, timeout_ms: Integer ).returns(T.attached_class) @@ -98,6 +108,10 @@ module BrandDev def self.new( # The domain name to analyze. domain:, + # Return a cached result if a prior scrape for the same parameters exists and is + # younger than this many milliseconds. Defaults to 7 days (604800000 ms) when + # omitted. Max is 30 days (2592000000 ms). Set to 0 to always scrape fresh. + max_age_ms: nil, # Maximum number of products to extract. max_products: nil, # Optional timeout in milliseconds for the request. Maximum allowed value is @@ -108,7 +122,12 @@ module BrandDev sig do override.returns( - { domain: String, max_products: Integer, timeout_ms: Integer } + { + domain: String, + max_age_ms: Integer, + max_products: Integer, + timeout_ms: Integer + } ) end def to_hash @@ -129,6 +148,15 @@ module BrandDev sig { returns(String) } attr_accessor :direct_url + # Return a cached result if a prior scrape for the same parameters exists and is + # younger than this many milliseconds. Defaults to 7 days (604800000 ms) when + # omitted. Max is 30 days (2592000000 ms). Set to 0 to always scrape fresh. + sig { returns(T.nilable(Integer)) } + attr_reader :max_age_ms + + sig { params(max_age_ms: Integer).void } + attr_writer :max_age_ms + # Maximum number of products to extract. sig { returns(T.nilable(Integer)) } attr_reader :max_products @@ -147,6 +175,7 @@ module BrandDev sig do params( direct_url: String, + max_age_ms: Integer, max_products: Integer, timeout_ms: Integer ).returns(T.attached_class) @@ -155,6 +184,10 @@ module BrandDev # A specific URL to use directly as the starting point for extraction without # domain resolution. direct_url:, + # Return a cached result if a prior scrape for the same parameters exists and is + # younger than this many milliseconds. Defaults to 7 days (604800000 ms) when + # omitted. Max is 30 days (2592000000 ms). Set to 0 to always scrape fresh. + max_age_ms: nil, # Maximum number of products to extract. max_products: nil, # Optional timeout in milliseconds for the request. Maximum allowed value is @@ -165,7 +198,12 @@ module BrandDev sig do override.returns( - { direct_url: String, max_products: Integer, timeout_ms: Integer } + { + direct_url: String, + max_age_ms: Integer, + max_products: Integer, + timeout_ms: Integer + } ) end def to_hash diff --git a/rbi/brand_dev/resources/brand.rbi b/rbi/brand_dev/resources/brand.rbi index a63f8cf..b6a9196 100644 --- a/rbi/brand_dev/resources/brand.rbi +++ b/rbi/brand_dev/resources/brand.rbi @@ -38,6 +38,7 @@ module BrandDev sig do params( url: String, + max_age_ms: Integer, timeout_ms: Integer, request_options: BrandDev::RequestOptions::OrHash ).returns(BrandDev::Models::BrandAIProductResponse) @@ -45,6 +46,10 @@ module BrandDev def ai_product( # The product page URL to extract product data from. url:, + # Return a cached result if a prior scrape for the same parameters exists and is + # younger than this many milliseconds. Defaults to 7 days (604800000 ms) when + # omitted. Max is 30 days (2592000000 ms). Set to 0 to always scrape fresh. + max_age_ms: nil, # Optional timeout in milliseconds for the request. Maximum allowed value is # 300000ms (5 minutes). timeout_ms: nil, diff --git a/sig/brand_dev/models/brand_ai_product_params.rbs b/sig/brand_dev/models/brand_ai_product_params.rbs index d3c1a3c..6e94987 100644 --- a/sig/brand_dev/models/brand_ai_product_params.rbs +++ b/sig/brand_dev/models/brand_ai_product_params.rbs @@ -1,7 +1,7 @@ module BrandDev module Models type brand_ai_product_params = - { url: String, timeout_ms: Integer } + { url: String, max_age_ms: Integer, timeout_ms: Integer } & BrandDev::Internal::Type::request_parameters class BrandAIProductParams < BrandDev::Internal::Type::BaseModel @@ -10,18 +10,24 @@ module BrandDev attr_accessor url: String + attr_reader max_age_ms: Integer? + + def max_age_ms=: (Integer) -> Integer + attr_reader timeout_ms: Integer? def timeout_ms=: (Integer) -> Integer def initialize: ( url: String, + ?max_age_ms: Integer, ?timeout_ms: Integer, ?request_options: BrandDev::request_opts ) -> void def to_hash: -> { url: String, + max_age_ms: Integer, timeout_ms: Integer, request_options: BrandDev::RequestOptions } diff --git a/sig/brand_dev/models/brand_ai_products_params.rbs b/sig/brand_dev/models/brand_ai_products_params.rbs index a67e944..5cb8741 100644 --- a/sig/brand_dev/models/brand_ai_products_params.rbs +++ b/sig/brand_dev/models/brand_ai_products_params.rbs @@ -28,11 +28,20 @@ module BrandDev extend BrandDev::Internal::Type::Union type by_domain = - { domain: String, max_products: Integer, timeout_ms: Integer } + { + domain: String, + max_age_ms: Integer, + max_products: Integer, + timeout_ms: Integer + } class ByDomain < BrandDev::Internal::Type::BaseModel attr_accessor domain: String + attr_reader max_age_ms: Integer? + + def max_age_ms=: (Integer) -> Integer + attr_reader max_products: Integer? def max_products=: (Integer) -> Integer @@ -43,23 +52,34 @@ module BrandDev def initialize: ( domain: String, + ?max_age_ms: Integer, ?max_products: Integer, ?timeout_ms: Integer ) -> void def to_hash: -> { domain: String, + max_age_ms: Integer, max_products: Integer, timeout_ms: Integer } end type by_direct_url = - { direct_url: String, max_products: Integer, timeout_ms: Integer } + { + direct_url: String, + max_age_ms: Integer, + max_products: Integer, + timeout_ms: Integer + } class ByDirectURL < BrandDev::Internal::Type::BaseModel attr_accessor direct_url: String + attr_reader max_age_ms: Integer? + + def max_age_ms=: (Integer) -> Integer + attr_reader max_products: Integer? def max_products=: (Integer) -> Integer @@ -70,12 +90,14 @@ module BrandDev def initialize: ( direct_url: String, + ?max_age_ms: Integer, ?max_products: Integer, ?timeout_ms: Integer ) -> void def to_hash: -> { direct_url: String, + max_age_ms: Integer, max_products: Integer, timeout_ms: Integer } diff --git a/sig/brand_dev/resources/brand.rbs b/sig/brand_dev/resources/brand.rbs index 8e7e1e7..696a678 100644 --- a/sig/brand_dev/resources/brand.rbs +++ b/sig/brand_dev/resources/brand.rbs @@ -11,6 +11,7 @@ module BrandDev def ai_product: ( url: String, + ?max_age_ms: Integer, ?timeout_ms: Integer, ?request_options: BrandDev::request_opts ) -> BrandDev::Models::BrandAIProductResponse From c5921ab5e04c5a0cf08ca6673662f31fc4dcde80 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 28 Apr 2026 03:39:06 +0000 Subject: [PATCH 37/82] feat: support setting headers via env --- lib/brand_dev/client.rb | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/lib/brand_dev/client.rb b/lib/brand_dev/client.rb index b62f44f..8c78c8d 100644 --- a/lib/brand_dev/client.rb +++ b/lib/brand_dev/client.rb @@ -58,6 +58,19 @@ def initialize( raise ArgumentError.new("api_key is required, and can be set via environ: \"BRAND_DEV_API_KEY\"") end + headers = {} + custom_headers_env = ENV["BRAND_DEV_CUSTOM_HEADERS"] + unless custom_headers_env.nil? + parsed = {} + custom_headers_env.split("\n").each do |line| + colon = line.index(":") + unless colon.nil? + parsed[line[0...colon].strip] = line[(colon + 1)..].strip + end + end + headers = parsed.merge(headers) + end + @api_key = api_key.to_s super( @@ -65,7 +78,8 @@ def initialize( timeout: timeout, max_retries: max_retries, initial_retry_delay: initial_retry_delay, - max_retry_delay: max_retry_delay + max_retry_delay: max_retry_delay, + headers: headers ) @brand = BrandDev::Resources::Brand.new(client: self) From bfeaf50d1e7ef4a37945206337bfdeafa39b8444 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 30 Apr 2026 05:45:48 +0000 Subject: [PATCH 38/82] codegen metadata --- .stats.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.stats.yml b/.stats.yml index c591270..725fb75 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 16 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-632b293af91698403da1bcaf3fb91259636c772e5071a2dd0fc63c42cb591307.yml +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-632b293af91698403da1bcaf3fb91259636c772e5071a2dd0fc63c42cb591307.yml openapi_spec_hash: d03dc81f33ef92c74aa3b5dea35cdeae config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 From 140c5aa76c3e52086a301de12e8fbf2bf816e296 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 1 May 2026 04:29:32 +0000 Subject: [PATCH 39/82] codegen metadata --- .stats.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.stats.yml b/.stats.yml index 725fb75..a6057b7 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 16 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-632b293af91698403da1bcaf3fb91259636c772e5071a2dd0fc63c42cb591307.yml +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-c651aa591ed6b1a64ece1e0e6336b2d11daed5ed258bd511edcbec96d9567d1b.yml openapi_spec_hash: d03dc81f33ef92c74aa3b5dea35cdeae config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 From 80e2d8b61925cb7a062423ea70613953d349201b Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 1 May 2026 15:01:17 +0000 Subject: [PATCH 40/82] feat(api): api update --- .stats.yml | 4 ++-- .../models/brand_web_scrape_html_params.rb | 10 +++++++++- .../models/brand_web_scrape_md_params.rb | 10 +++++++++- lib/brand_dev/resources/brand.rb | 15 ++++++++++++--- .../models/brand_web_scrape_html_params.rbi | 11 +++++++++++ .../models/brand_web_scrape_md_params.rbi | 11 +++++++++++ rbi/brand_dev/resources/brand.rbi | 6 ++++++ .../models/brand_web_scrape_html_params.rbs | 13 ++++++++++++- .../models/brand_web_scrape_md_params.rbs | 7 +++++++ sig/brand_dev/resources/brand.rbs | 2 ++ 10 files changed, 81 insertions(+), 8 deletions(-) diff --git a/.stats.yml b/.stats.yml index a6057b7..6eedefc 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 16 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-c651aa591ed6b1a64ece1e0e6336b2d11daed5ed258bd511edcbec96d9567d1b.yml -openapi_spec_hash: d03dc81f33ef92c74aa3b5dea35cdeae +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-ca091b4b323baadb654b7292374b8712b6de260f3c1f8f0944caf20795f608ad.yml +openapi_spec_hash: 2bc6f537bfa055541621423722ea85f2 config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 diff --git a/lib/brand_dev/models/brand_web_scrape_html_params.rb b/lib/brand_dev/models/brand_web_scrape_html_params.rb index aeb3932..01115b5 100644 --- a/lib/brand_dev/models/brand_web_scrape_html_params.rb +++ b/lib/brand_dev/models/brand_web_scrape_html_params.rb @@ -13,6 +13,12 @@ class BrandWebScrapeHTMLParams < BrandDev::Internal::Type::BaseModel # @return [String] required :url, String + # @!attribute include_frames + # When true, iframes are rendered inline into the returned HTML. + # + # @return [Boolean, nil] + optional :include_frames, BrandDev::Internal::Type::Boolean + # @!attribute max_age_ms # Return a cached result if a prior scrape for the same parameters exists and is # younger than this many milliseconds. Defaults to 1 day (86400000 ms) when @@ -29,12 +35,14 @@ class BrandWebScrapeHTMLParams < BrandDev::Internal::Type::BaseModel # @return [Boolean, nil] optional :parse_pdf, BrandDev::Internal::Type::Boolean - # @!method initialize(url:, max_age_ms: nil, parse_pdf: nil, request_options: {}) + # @!method initialize(url:, include_frames: nil, max_age_ms: nil, parse_pdf: nil, request_options: {}) # Some parameter documentations has been truncated, see # {BrandDev::Models::BrandWebScrapeHTMLParams} for more details. # # @param url [String] Full URL to scrape (must include http:// or https:// protocol) # + # @param include_frames [Boolean] When true, iframes are rendered inline into the returned HTML. + # # @param max_age_ms [Integer] Return a cached result if a prior scrape for the same parameters exists and is y # # @param parse_pdf [Boolean] When true (default), PDF URLs are fetched and their text layer is extracted and diff --git a/lib/brand_dev/models/brand_web_scrape_md_params.rb b/lib/brand_dev/models/brand_web_scrape_md_params.rb index df3521f..2d23939 100644 --- a/lib/brand_dev/models/brand_web_scrape_md_params.rb +++ b/lib/brand_dev/models/brand_web_scrape_md_params.rb @@ -14,6 +14,12 @@ class BrandWebScrapeMdParams < BrandDev::Internal::Type::BaseModel # @return [String] required :url, String + # @!attribute include_frames + # When true, the contents of iframes are rendered to Markdown. + # + # @return [Boolean, nil] + optional :include_frames, BrandDev::Internal::Type::Boolean + # @!attribute include_images # Include image references in Markdown output # @@ -55,12 +61,14 @@ class BrandWebScrapeMdParams < BrandDev::Internal::Type::BaseModel # @return [Boolean, nil] optional :use_main_content_only, BrandDev::Internal::Type::Boolean - # @!method initialize(url:, include_images: nil, include_links: nil, max_age_ms: nil, parse_pdf: nil, shorten_base64_images: nil, use_main_content_only: nil, request_options: {}) + # @!method initialize(url:, include_frames: nil, include_images: nil, include_links: nil, max_age_ms: nil, parse_pdf: nil, shorten_base64_images: nil, use_main_content_only: nil, request_options: {}) # Some parameter documentations has been truncated, see # {BrandDev::Models::BrandWebScrapeMdParams} for more details. # # @param url [String] Full URL to scrape into LLM usable Markdown (must include http:// or https:// pr # + # @param include_frames [Boolean] When true, the contents of iframes are rendered to Markdown. + # # @param include_images [Boolean] Include image references in Markdown output # # @param include_links [Boolean] Preserve hyperlinks in Markdown output diff --git a/lib/brand_dev/resources/brand.rb b/lib/brand_dev/resources/brand.rb index 674a151..6fa4b3a 100644 --- a/lib/brand_dev/resources/brand.rb +++ b/lib/brand_dev/resources/brand.rb @@ -393,10 +393,12 @@ def retrieve_simplified(params) # # Scrapes the given URL and returns the raw HTML content of the page. # - # @overload web_scrape_html(url:, max_age_ms: nil, parse_pdf: nil, request_options: {}) + # @overload web_scrape_html(url:, include_frames: nil, max_age_ms: nil, parse_pdf: nil, request_options: {}) # # @param url [String] Full URL to scrape (must include http:// or https:// protocol) # + # @param include_frames [Boolean] When true, iframes are rendered inline into the returned HTML. + # # @param max_age_ms [Integer] Return a cached result if a prior scrape for the same parameters exists and is y # # @param parse_pdf [Boolean] When true (default), PDF URLs are fetched and their text layer is extracted and @@ -412,7 +414,11 @@ def web_scrape_html(params) @client.request( method: :get, path: "web/scrape/html", - query: query.transform_keys(max_age_ms: "maxAgeMs", parse_pdf: "parsePDF"), + query: query.transform_keys( + include_frames: "includeFrames", + max_age_ms: "maxAgeMs", + parse_pdf: "parsePDF" + ), model: BrandDev::Models::BrandWebScrapeHTMLResponse, options: options ) @@ -448,10 +454,12 @@ def web_scrape_images(params) # # Scrapes the given URL into LLM usable Markdown. # - # @overload web_scrape_md(url:, include_images: nil, include_links: nil, max_age_ms: nil, parse_pdf: nil, shorten_base64_images: nil, use_main_content_only: nil, request_options: {}) + # @overload web_scrape_md(url:, include_frames: nil, include_images: nil, include_links: nil, max_age_ms: nil, parse_pdf: nil, shorten_base64_images: nil, use_main_content_only: nil, request_options: {}) # # @param url [String] Full URL to scrape into LLM usable Markdown (must include http:// or https:// pr # + # @param include_frames [Boolean] When true, the contents of iframes are rendered to Markdown. + # # @param include_images [Boolean] Include image references in Markdown output # # @param include_links [Boolean] Preserve hyperlinks in Markdown output @@ -476,6 +484,7 @@ def web_scrape_md(params) method: :get, path: "web/scrape/markdown", query: query.transform_keys( + include_frames: "includeFrames", include_images: "includeImages", include_links: "includeLinks", max_age_ms: "maxAgeMs", diff --git a/rbi/brand_dev/models/brand_web_scrape_html_params.rbi b/rbi/brand_dev/models/brand_web_scrape_html_params.rbi index dc549bf..3a9b60e 100644 --- a/rbi/brand_dev/models/brand_web_scrape_html_params.rbi +++ b/rbi/brand_dev/models/brand_web_scrape_html_params.rbi @@ -15,6 +15,13 @@ module BrandDev sig { returns(String) } attr_accessor :url + # When true, iframes are rendered inline into the returned HTML. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_frames + + sig { params(include_frames: T::Boolean).void } + attr_writer :include_frames + # Return a cached result if a prior scrape for the same parameters exists and is # younger than this many milliseconds. Defaults to 1 day (86400000 ms) when # omitted. Max is 30 days (2592000000 ms). Set to 0 to always scrape fresh. @@ -36,6 +43,7 @@ module BrandDev sig do params( url: String, + include_frames: T::Boolean, max_age_ms: Integer, parse_pdf: T::Boolean, request_options: BrandDev::RequestOptions::OrHash @@ -44,6 +52,8 @@ module BrandDev def self.new( # Full URL to scrape (must include http:// or https:// protocol) url:, + # When true, iframes are rendered inline into the returned HTML. + include_frames: nil, # Return a cached result if a prior scrape for the same parameters exists and is # younger than this many milliseconds. Defaults to 1 day (86400000 ms) when # omitted. Max is 30 days (2592000000 ms). Set to 0 to always scrape fresh. @@ -60,6 +70,7 @@ module BrandDev override.returns( { url: String, + include_frames: T::Boolean, max_age_ms: Integer, parse_pdf: T::Boolean, request_options: BrandDev::RequestOptions diff --git a/rbi/brand_dev/models/brand_web_scrape_md_params.rbi b/rbi/brand_dev/models/brand_web_scrape_md_params.rbi index ad30542..ce90801 100644 --- a/rbi/brand_dev/models/brand_web_scrape_md_params.rbi +++ b/rbi/brand_dev/models/brand_web_scrape_md_params.rbi @@ -16,6 +16,13 @@ module BrandDev sig { returns(String) } attr_accessor :url + # When true, the contents of iframes are rendered to Markdown. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_frames + + sig { params(include_frames: T::Boolean).void } + attr_writer :include_frames + # Include image references in Markdown output sig { returns(T.nilable(T::Boolean)) } attr_reader :include_images @@ -66,6 +73,7 @@ module BrandDev sig do params( url: String, + include_frames: T::Boolean, include_images: T::Boolean, include_links: T::Boolean, max_age_ms: Integer, @@ -79,6 +87,8 @@ module BrandDev # Full URL to scrape into LLM usable Markdown (must include http:// or https:// # protocol) url:, + # When true, the contents of iframes are rendered to Markdown. + include_frames: nil, # Include image references in Markdown output include_images: nil, # Preserve hyperlinks in Markdown output @@ -104,6 +114,7 @@ module BrandDev override.returns( { url: String, + include_frames: T::Boolean, include_images: T::Boolean, include_links: T::Boolean, max_age_ms: Integer, diff --git a/rbi/brand_dev/resources/brand.rbi b/rbi/brand_dev/resources/brand.rbi index b6a9196..5f02fc0 100644 --- a/rbi/brand_dev/resources/brand.rbi +++ b/rbi/brand_dev/resources/brand.rbi @@ -347,6 +347,7 @@ module BrandDev sig do params( url: String, + include_frames: T::Boolean, max_age_ms: Integer, parse_pdf: T::Boolean, request_options: BrandDev::RequestOptions::OrHash @@ -355,6 +356,8 @@ module BrandDev def web_scrape_html( # Full URL to scrape (must include http:// or https:// protocol) url:, + # When true, iframes are rendered inline into the returned HTML. + include_frames: nil, # Return a cached result if a prior scrape for the same parameters exists and is # younger than this many milliseconds. Defaults to 1 day (86400000 ms) when # omitted. Max is 30 days (2592000000 ms). Set to 0 to always scrape fresh. @@ -387,6 +390,7 @@ module BrandDev sig do params( url: String, + include_frames: T::Boolean, include_images: T::Boolean, include_links: T::Boolean, max_age_ms: Integer, @@ -400,6 +404,8 @@ module BrandDev # Full URL to scrape into LLM usable Markdown (must include http:// or https:// # protocol) url:, + # When true, the contents of iframes are rendered to Markdown. + include_frames: nil, # Include image references in Markdown output include_images: nil, # Preserve hyperlinks in Markdown output diff --git a/sig/brand_dev/models/brand_web_scrape_html_params.rbs b/sig/brand_dev/models/brand_web_scrape_html_params.rbs index 0e5e804..7a6a2bf 100644 --- a/sig/brand_dev/models/brand_web_scrape_html_params.rbs +++ b/sig/brand_dev/models/brand_web_scrape_html_params.rbs @@ -1,7 +1,12 @@ module BrandDev module Models type brand_web_scrape_html_params = - { url: String, max_age_ms: Integer, parse_pdf: bool } + { + url: String, + include_frames: bool, + max_age_ms: Integer, + parse_pdf: bool + } & BrandDev::Internal::Type::request_parameters class BrandWebScrapeHTMLParams < BrandDev::Internal::Type::BaseModel @@ -10,6 +15,10 @@ module BrandDev attr_accessor url: String + attr_reader include_frames: bool? + + def include_frames=: (bool) -> bool + attr_reader max_age_ms: Integer? def max_age_ms=: (Integer) -> Integer @@ -20,6 +29,7 @@ module BrandDev def initialize: ( url: String, + ?include_frames: bool, ?max_age_ms: Integer, ?parse_pdf: bool, ?request_options: BrandDev::request_opts @@ -27,6 +37,7 @@ module BrandDev def to_hash: -> { url: String, + include_frames: bool, max_age_ms: Integer, parse_pdf: bool, request_options: BrandDev::RequestOptions diff --git a/sig/brand_dev/models/brand_web_scrape_md_params.rbs b/sig/brand_dev/models/brand_web_scrape_md_params.rbs index 5d32b5a..ca9fc9e 100644 --- a/sig/brand_dev/models/brand_web_scrape_md_params.rbs +++ b/sig/brand_dev/models/brand_web_scrape_md_params.rbs @@ -3,6 +3,7 @@ module BrandDev type brand_web_scrape_md_params = { url: String, + include_frames: bool, include_images: bool, include_links: bool, max_age_ms: Integer, @@ -18,6 +19,10 @@ module BrandDev attr_accessor url: String + attr_reader include_frames: bool? + + def include_frames=: (bool) -> bool + attr_reader include_images: bool? def include_images=: (bool) -> bool @@ -44,6 +49,7 @@ module BrandDev def initialize: ( url: String, + ?include_frames: bool, ?include_images: bool, ?include_links: bool, ?max_age_ms: Integer, @@ -55,6 +61,7 @@ module BrandDev def to_hash: -> { url: String, + include_frames: bool, include_images: bool, include_links: bool, max_age_ms: Integer, diff --git a/sig/brand_dev/resources/brand.rbs b/sig/brand_dev/resources/brand.rbs index 696a678..054a461 100644 --- a/sig/brand_dev/resources/brand.rbs +++ b/sig/brand_dev/resources/brand.rbs @@ -96,6 +96,7 @@ module BrandDev def web_scrape_html: ( url: String, + ?include_frames: bool, ?max_age_ms: Integer, ?parse_pdf: bool, ?request_options: BrandDev::request_opts @@ -108,6 +109,7 @@ module BrandDev def web_scrape_md: ( url: String, + ?include_frames: bool, ?include_images: bool, ?include_links: bool, ?max_age_ms: Integer, From 2e93c177a7e818df9de785ac89363cba814eaad8 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Wed, 6 May 2026 22:08:39 +0000 Subject: [PATCH 41/82] feat(api): api update --- .stats.yml | 4 +- .../models/brand_web_scrape_images_params.rb | 69 +++++- .../brand_web_scrape_images_response.rb | 109 +++++++-- lib/brand_dev/resources/brand.rb | 20 +- .../models/brand_web_scrape_images_params.rbi | 116 ++++++++- .../brand_web_scrape_images_response.rbi | 225 ++++++++++++++++-- rbi/brand_dev/resources/brand.rbi | 17 +- .../models/brand_web_scrape_images_params.rbs | 66 ++++- .../brand_web_scrape_images_response.rbs | 89 ++++++- sig/brand_dev/resources/brand.rbs | 2 + 10 files changed, 656 insertions(+), 61 deletions(-) diff --git a/.stats.yml b/.stats.yml index 6eedefc..71256d4 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 16 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-ca091b4b323baadb654b7292374b8712b6de260f3c1f8f0944caf20795f608ad.yml -openapi_spec_hash: 2bc6f537bfa055541621423722ea85f2 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-f4118654961d5928e40ebe0771eb12f9aa1ca68cf9268bf3400eb1ab8b4dae1a.yml +openapi_spec_hash: ff26efd9c23ca8d4ed2c84f1716280c4 config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 diff --git a/lib/brand_dev/models/brand_web_scrape_images_params.rb b/lib/brand_dev/models/brand_web_scrape_images_params.rb index 7cc7159..7b05029 100644 --- a/lib/brand_dev/models/brand_web_scrape_images_params.rb +++ b/lib/brand_dev/models/brand_web_scrape_images_params.rb @@ -8,15 +8,78 @@ class BrandWebScrapeImagesParams < BrandDev::Internal::Type::BaseModel include BrandDev::Internal::Type::RequestParameters # @!attribute url - # Full URL to scrape images from (must include http:// or https:// protocol) + # Page URL to inspect. Must include http:// or https://. # # @return [String] required :url, String - # @!method initialize(url:, request_options: {}) - # @param url [String] Full URL to scrape images from (must include http:// or https:// protocol) + # @!attribute enrichment + # Optional per-image processing, sent as deep-object query params such as + # enrichment[resolution]=true. + # + # @return [BrandDev::Models::BrandWebScrapeImagesParams::Enrichment, nil] + optional :enrichment, -> { BrandDev::BrandWebScrapeImagesParams::Enrichment } + + # @!attribute max_age_ms + # Reuse a cached result this many milliseconds old or newer. Default: 86400000 (1 + # day). Set to 0 to bypass cache. Maximum: 2592000000 (30 days). + # + # @return [Integer, nil] + optional :max_age_ms, Integer + + # @!method initialize(url:, enrichment: nil, max_age_ms: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {BrandDev::Models::BrandWebScrapeImagesParams} for more details. + # + # @param url [String] Page URL to inspect. Must include http:// or https://. + # + # @param enrichment [BrandDev::Models::BrandWebScrapeImagesParams::Enrichment] Optional per-image processing, sent as deep-object query params such as enrichme + # + # @param max_age_ms [Integer] Reuse a cached result this many milliseconds old or newer. Default: 86400000 (1 # # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}] + + class Enrichment < BrandDev::Internal::Type::BaseModel + # @!attribute classification + # Classify each image by visual asset type. + # + # @return [Boolean, nil] + optional :classification, BrandDev::Internal::Type::Boolean + + # @!attribute hosted_url + # Host materializable images on the Brand.dev CDN and return their URL and MIME + # type. + # + # @return [Boolean, nil] + optional :hosted_url, BrandDev::Internal::Type::Boolean, api_name: :hostedUrl + + # @!attribute max_time_per_ms + # Per-image enrichment timeout in milliseconds. Default: 6000. Maximum: 60000. + # + # @return [Integer, nil] + optional :max_time_per_ms, Integer, api_name: :maxTimePerMs + + # @!attribute resolution + # Measure image width and height when possible. + # + # @return [Boolean, nil] + optional :resolution, BrandDev::Internal::Type::Boolean + + # @!method initialize(classification: nil, hosted_url: nil, max_time_per_ms: nil, resolution: nil) + # Some parameter documentations has been truncated, see + # {BrandDev::Models::BrandWebScrapeImagesParams::Enrichment} for more details. + # + # Optional per-image processing, sent as deep-object query params such as + # enrichment[resolution]=true. + # + # @param classification [Boolean] Classify each image by visual asset type. + # + # @param hosted_url [Boolean] Host materializable images on the Brand.dev CDN and return their URL and MIME ty + # + # @param max_time_per_ms [Integer] Per-image enrichment timeout in milliseconds. Default: 6000. Maximum: 60000. + # + # @param resolution [Boolean] Measure image width and height when possible. + end end end end diff --git a/lib/brand_dev/models/brand_web_scrape_images_response.rb b/lib/brand_dev/models/brand_web_scrape_images_response.rb index 01852b5..fae9ebb 100644 --- a/lib/brand_dev/models/brand_web_scrape_images_response.rb +++ b/lib/brand_dev/models/brand_web_scrape_images_response.rb @@ -5,66 +5,74 @@ module Models # @see BrandDev::Resources::Brand#web_scrape_images class BrandWebScrapeImagesResponse < BrandDev::Internal::Type::BaseModel # @!attribute images - # Array of scraped images + # Images found on the page. # # @return [Array] required :images, -> { BrandDev::Internal::Type::ArrayOf[BrandDev::Models::BrandWebScrapeImagesResponse::Image] } # @!attribute success - # Indicates success + # Always true on success. # # @return [Boolean, BrandDev::Models::BrandWebScrapeImagesResponse::Success] required :success, enum: -> { BrandDev::Models::BrandWebScrapeImagesResponse::Success } # @!attribute url - # The URL that was scraped + # Page URL that was scraped. # # @return [String] required :url, String # @!method initialize(images:, success:, url:) - # @param images [Array] Array of scraped images + # @param images [Array] Images found on the page. # - # @param success [Boolean, BrandDev::Models::BrandWebScrapeImagesResponse::Success] Indicates success + # @param success [Boolean, BrandDev::Models::BrandWebScrapeImagesResponse::Success] Always true on success. # - # @param url [String] The URL that was scraped + # @param url [String] Page URL that was scraped. class Image < BrandDev::Internal::Type::BaseModel # @!attribute alt - # Alt text of the image, or null if not present + # Image alt text, or null when unavailable. # # @return [String, nil] required :alt, String, nil?: true # @!attribute element - # The HTML element the image was found in + # Where the image was found. # # @return [Symbol, BrandDev::Models::BrandWebScrapeImagesResponse::Image::Element] required :element, enum: -> { BrandDev::Models::BrandWebScrapeImagesResponse::Image::Element } # @!attribute src - # The image source - can be a URL, inline HTML (for SVGs), or a base64 data URI + # Original image value: URL, inline SVG or HTML, or base64 data URI. # # @return [String] required :src, String # @!attribute type - # The type/format of the src value + # Format of src. # # @return [Symbol, BrandDev::Models::BrandWebScrapeImagesResponse::Image::Type] required :type, enum: -> { BrandDev::Models::BrandWebScrapeImagesResponse::Image::Type } - # @!method initialize(alt:, element:, src:, type:) - # @param alt [String, nil] Alt text of the image, or null if not present + # @!attribute enrichment + # Requested metadata for images that could be processed. # - # @param element [Symbol, BrandDev::Models::BrandWebScrapeImagesResponse::Image::Element] The HTML element the image was found in + # @return [BrandDev::Models::BrandWebScrapeImagesResponse::Image::Enrichment, nil] + optional :enrichment, -> { BrandDev::Models::BrandWebScrapeImagesResponse::Image::Enrichment } + + # @!method initialize(alt:, element:, src:, type:, enrichment: nil) + # @param alt [String, nil] Image alt text, or null when unavailable. + # + # @param element [Symbol, BrandDev::Models::BrandWebScrapeImagesResponse::Image::Element] Where the image was found. + # + # @param src [String] Original image value: URL, inline SVG or HTML, or base64 data URI. # - # @param src [String] The image source - can be a URL, inline HTML (for SVGs), or a base64 data URI + # @param type [Symbol, BrandDev::Models::BrandWebScrapeImagesResponse::Image::Type] Format of src. # - # @param type [Symbol, BrandDev::Models::BrandWebScrapeImagesResponse::Image::Type] The type/format of the src value + # @param enrichment [BrandDev::Models::BrandWebScrapeImagesResponse::Image::Enrichment] Requested metadata for images that could be processed. - # The HTML element the image was found in + # Where the image was found. # # @see BrandDev::Models::BrandWebScrapeImagesResponse::Image#element module Element @@ -84,7 +92,7 @@ module Element # @return [Array] end - # The type/format of the src value + # Format of src. # # @see BrandDev::Models::BrandWebScrapeImagesResponse::Image#type module Type @@ -97,9 +105,74 @@ module Type # @!method self.values # @return [Array] end + + # @see BrandDev::Models::BrandWebScrapeImagesResponse::Image#enrichment + class Enrichment < BrandDev::Internal::Type::BaseModel + # @!attribute height + # Image height in pixels, when measured. + # + # @return [Integer, nil] + optional :height, Integer + + # @!attribute mimetype + # Detected MIME type, when hosted. + # + # @return [String, nil] + optional :mimetype, String + + # @!attribute type + # Visual asset category, when classified. + # + # @return [Symbol, BrandDev::Models::BrandWebScrapeImagesResponse::Image::Enrichment::Type, nil] + optional :type, enum: -> { BrandDev::Models::BrandWebScrapeImagesResponse::Image::Enrichment::Type } + + # @!attribute url + # Brand.dev CDN URL, when hosted. + # + # @return [String, nil] + optional :url, String + + # @!attribute width + # Image width in pixels, when measured. + # + # @return [Integer, nil] + optional :width, Integer + + # @!method initialize(height: nil, mimetype: nil, type: nil, url: nil, width: nil) + # Requested metadata for images that could be processed. + # + # @param height [Integer] Image height in pixels, when measured. + # + # @param mimetype [String] Detected MIME type, when hosted. + # + # @param type [Symbol, BrandDev::Models::BrandWebScrapeImagesResponse::Image::Enrichment::Type] Visual asset category, when classified. + # + # @param url [String] Brand.dev CDN URL, when hosted. + # + # @param width [Integer] Image width in pixels, when measured. + + # Visual asset category, when classified. + # + # @see BrandDev::Models::BrandWebScrapeImagesResponse::Image::Enrichment#type + module Type + extend BrandDev::Internal::Type::Enum + + PHOTOGRAPHY = :photography + ILLUSTRATION = :illustration + LOGO = :logo + WORDMARK = :wordmark + ICON = :icon + PATTERN = :pattern + GRAPHIC = :graphic + OTHER = :other + + # @!method self.values + # @return [Array] + end + end end - # Indicates success + # Always true on success. # # @see BrandDev::Models::BrandWebScrapeImagesResponse#success module Success diff --git a/lib/brand_dev/resources/brand.rb b/lib/brand_dev/resources/brand.rb index 6fa4b3a..6e213e5 100644 --- a/lib/brand_dev/resources/brand.rb +++ b/lib/brand_dev/resources/brand.rb @@ -424,13 +424,21 @@ def web_scrape_html(params) ) end - # Scrapes all images from the given URL. Extracts images from img, svg, - # picture/source, link, and video elements including inline SVGs, base64 data - # URIs, and standard URLs. + # Some parameter documentations has been truncated, see + # {BrandDev::Models::BrandWebScrapeImagesParams} for more details. + # + # Extract image assets from a web page, including standard URLs, inline SVGs, data + # URIs, responsive image sources, metadata, CSS backgrounds, video posters, and + # embeds. The base request costs 1 credit; enrichment costs 1 credit per returned + # image. + # + # @overload web_scrape_images(url:, enrichment: nil, max_age_ms: nil, request_options: {}) + # + # @param url [String] Page URL to inspect. Must include http:// or https://. # - # @overload web_scrape_images(url:, request_options: {}) + # @param enrichment [BrandDev::Models::BrandWebScrapeImagesParams::Enrichment] Optional per-image processing, sent as deep-object query params such as enrichme # - # @param url [String] Full URL to scrape images from (must include http:// or https:// protocol) + # @param max_age_ms [Integer] Reuse a cached result this many milliseconds old or newer. Default: 86400000 (1 # # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}, nil] # @@ -443,7 +451,7 @@ def web_scrape_images(params) @client.request( method: :get, path: "web/scrape/images", - query: query, + query: query.transform_keys(max_age_ms: "maxAgeMs"), model: BrandDev::Models::BrandWebScrapeImagesResponse, options: options ) diff --git a/rbi/brand_dev/models/brand_web_scrape_images_params.rbi b/rbi/brand_dev/models/brand_web_scrape_images_params.rbi index 23a0654..f972368 100644 --- a/rbi/brand_dev/models/brand_web_scrape_images_params.rbi +++ b/rbi/brand_dev/models/brand_web_scrape_images_params.rbi @@ -14,30 +14,140 @@ module BrandDev ) end - # Full URL to scrape images from (must include http:// or https:// protocol) + # Page URL to inspect. Must include http:// or https://. sig { returns(String) } attr_accessor :url + # Optional per-image processing, sent as deep-object query params such as + # enrichment[resolution]=true. + sig do + returns(T.nilable(BrandDev::BrandWebScrapeImagesParams::Enrichment)) + end + attr_reader :enrichment + + sig do + params( + enrichment: BrandDev::BrandWebScrapeImagesParams::Enrichment::OrHash + ).void + end + attr_writer :enrichment + + # Reuse a cached result this many milliseconds old or newer. Default: 86400000 (1 + # day). Set to 0 to bypass cache. Maximum: 2592000000 (30 days). + sig { returns(T.nilable(Integer)) } + attr_reader :max_age_ms + + sig { params(max_age_ms: Integer).void } + attr_writer :max_age_ms + sig do params( url: String, + enrichment: BrandDev::BrandWebScrapeImagesParams::Enrichment::OrHash, + max_age_ms: Integer, request_options: BrandDev::RequestOptions::OrHash ).returns(T.attached_class) end def self.new( - # Full URL to scrape images from (must include http:// or https:// protocol) + # Page URL to inspect. Must include http:// or https://. url:, + # Optional per-image processing, sent as deep-object query params such as + # enrichment[resolution]=true. + enrichment: nil, + # Reuse a cached result this many milliseconds old or newer. Default: 86400000 (1 + # day). Set to 0 to bypass cache. Maximum: 2592000000 (30 days). + max_age_ms: nil, request_options: {} ) end sig do override.returns( - { url: String, request_options: BrandDev::RequestOptions } + { + url: String, + enrichment: BrandDev::BrandWebScrapeImagesParams::Enrichment, + max_age_ms: Integer, + request_options: BrandDev::RequestOptions + } ) end def to_hash end + + class Enrichment < BrandDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + BrandDev::BrandWebScrapeImagesParams::Enrichment, + BrandDev::Internal::AnyHash + ) + end + + # Classify each image by visual asset type. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :classification + + sig { params(classification: T::Boolean).void } + attr_writer :classification + + # Host materializable images on the Brand.dev CDN and return their URL and MIME + # type. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :hosted_url + + sig { params(hosted_url: T::Boolean).void } + attr_writer :hosted_url + + # Per-image enrichment timeout in milliseconds. Default: 6000. Maximum: 60000. + sig { returns(T.nilable(Integer)) } + attr_reader :max_time_per_ms + + sig { params(max_time_per_ms: Integer).void } + attr_writer :max_time_per_ms + + # Measure image width and height when possible. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :resolution + + sig { params(resolution: T::Boolean).void } + attr_writer :resolution + + # Optional per-image processing, sent as deep-object query params such as + # enrichment[resolution]=true. + sig do + params( + classification: T::Boolean, + hosted_url: T::Boolean, + max_time_per_ms: Integer, + resolution: T::Boolean + ).returns(T.attached_class) + end + def self.new( + # Classify each image by visual asset type. + classification: nil, + # Host materializable images on the Brand.dev CDN and return their URL and MIME + # type. + hosted_url: nil, + # Per-image enrichment timeout in milliseconds. Default: 6000. Maximum: 60000. + max_time_per_ms: nil, + # Measure image width and height when possible. + resolution: nil + ) + end + + sig do + override.returns( + { + classification: T::Boolean, + hosted_url: T::Boolean, + max_time_per_ms: Integer, + resolution: T::Boolean + } + ) + end + def to_hash + end + end end end end diff --git a/rbi/brand_dev/models/brand_web_scrape_images_response.rbi b/rbi/brand_dev/models/brand_web_scrape_images_response.rbi index 6700b0a..6d7ce29 100644 --- a/rbi/brand_dev/models/brand_web_scrape_images_response.rbi +++ b/rbi/brand_dev/models/brand_web_scrape_images_response.rbi @@ -11,13 +11,13 @@ module BrandDev ) end - # Array of scraped images + # Images found on the page. sig do returns(T::Array[BrandDev::Models::BrandWebScrapeImagesResponse::Image]) end attr_accessor :images - # Indicates success + # Always true on success. sig do returns( BrandDev::Models::BrandWebScrapeImagesResponse::Success::TaggedBoolean @@ -25,7 +25,7 @@ module BrandDev end attr_accessor :success - # The URL that was scraped + # Page URL that was scraped. sig { returns(String) } attr_accessor :url @@ -41,11 +41,11 @@ module BrandDev ).returns(T.attached_class) end def self.new( - # Array of scraped images + # Images found on the page. images:, - # Indicates success + # Always true on success. success:, - # The URL that was scraped + # Page URL that was scraped. url: ) end @@ -73,11 +73,11 @@ module BrandDev ) end - # Alt text of the image, or null if not present + # Image alt text, or null when unavailable. sig { returns(T.nilable(String)) } attr_accessor :alt - # The HTML element the image was found in + # Where the image was found. sig do returns( BrandDev::Models::BrandWebScrapeImagesResponse::Image::Element::TaggedSymbol @@ -85,11 +85,11 @@ module BrandDev end attr_accessor :element - # The image source - can be a URL, inline HTML (for SVGs), or a base64 data URI + # Original image value: URL, inline SVG or HTML, or base64 data URI. sig { returns(String) } attr_accessor :src - # The type/format of the src value + # Format of src. sig do returns( BrandDev::Models::BrandWebScrapeImagesResponse::Image::Type::TaggedSymbol @@ -97,6 +97,24 @@ module BrandDev end attr_accessor :type + # Requested metadata for images that could be processed. + sig do + returns( + T.nilable( + BrandDev::Models::BrandWebScrapeImagesResponse::Image::Enrichment + ) + ) + end + attr_reader :enrichment + + sig do + params( + enrichment: + BrandDev::Models::BrandWebScrapeImagesResponse::Image::Enrichment::OrHash + ).void + end + attr_writer :enrichment + sig do params( alt: T.nilable(String), @@ -104,18 +122,22 @@ module BrandDev BrandDev::Models::BrandWebScrapeImagesResponse::Image::Element::OrSymbol, src: String, type: - BrandDev::Models::BrandWebScrapeImagesResponse::Image::Type::OrSymbol + BrandDev::Models::BrandWebScrapeImagesResponse::Image::Type::OrSymbol, + enrichment: + BrandDev::Models::BrandWebScrapeImagesResponse::Image::Enrichment::OrHash ).returns(T.attached_class) end def self.new( - # Alt text of the image, or null if not present + # Image alt text, or null when unavailable. alt:, - # The HTML element the image was found in + # Where the image was found. element:, - # The image source - can be a URL, inline HTML (for SVGs), or a base64 data URI + # Original image value: URL, inline SVG or HTML, or base64 data URI. src:, - # The type/format of the src value - type: + # Format of src. + type:, + # Requested metadata for images that could be processed. + enrichment: nil ) end @@ -127,14 +149,16 @@ module BrandDev BrandDev::Models::BrandWebScrapeImagesResponse::Image::Element::TaggedSymbol, src: String, type: - BrandDev::Models::BrandWebScrapeImagesResponse::Image::Type::TaggedSymbol + BrandDev::Models::BrandWebScrapeImagesResponse::Image::Type::TaggedSymbol, + enrichment: + BrandDev::Models::BrandWebScrapeImagesResponse::Image::Enrichment } ) end def to_hash end - # The HTML element the image was found in + # Where the image was found. module Element extend BrandDev::Internal::Type::Enum @@ -204,7 +228,7 @@ module BrandDev end end - # The type/format of the src value + # Format of src. module Type extend BrandDev::Internal::Type::Enum @@ -243,9 +267,170 @@ module BrandDev def self.values end end + + class Enrichment < BrandDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + BrandDev::Models::BrandWebScrapeImagesResponse::Image::Enrichment, + BrandDev::Internal::AnyHash + ) + end + + # Image height in pixels, when measured. + sig { returns(T.nilable(Integer)) } + attr_reader :height + + sig { params(height: Integer).void } + attr_writer :height + + # Detected MIME type, when hosted. + sig { returns(T.nilable(String)) } + attr_reader :mimetype + + sig { params(mimetype: String).void } + attr_writer :mimetype + + # Visual asset category, when classified. + sig do + returns( + T.nilable( + BrandDev::Models::BrandWebScrapeImagesResponse::Image::Enrichment::Type::TaggedSymbol + ) + ) + end + attr_reader :type + + sig do + params( + type: + BrandDev::Models::BrandWebScrapeImagesResponse::Image::Enrichment::Type::OrSymbol + ).void + end + attr_writer :type + + # Brand.dev CDN URL, when hosted. + sig { returns(T.nilable(String)) } + attr_reader :url + + sig { params(url: String).void } + attr_writer :url + + # Image width in pixels, when measured. + sig { returns(T.nilable(Integer)) } + attr_reader :width + + sig { params(width: Integer).void } + attr_writer :width + + # Requested metadata for images that could be processed. + sig do + params( + height: Integer, + mimetype: String, + type: + BrandDev::Models::BrandWebScrapeImagesResponse::Image::Enrichment::Type::OrSymbol, + url: String, + width: Integer + ).returns(T.attached_class) + end + def self.new( + # Image height in pixels, when measured. + height: nil, + # Detected MIME type, when hosted. + mimetype: nil, + # Visual asset category, when classified. + type: nil, + # Brand.dev CDN URL, when hosted. + url: nil, + # Image width in pixels, when measured. + width: nil + ) + end + + sig do + override.returns( + { + height: Integer, + mimetype: String, + type: + BrandDev::Models::BrandWebScrapeImagesResponse::Image::Enrichment::Type::TaggedSymbol, + url: String, + width: Integer + } + ) + end + def to_hash + end + + # Visual asset category, when classified. + module Type + extend BrandDev::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + BrandDev::Models::BrandWebScrapeImagesResponse::Image::Enrichment::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + PHOTOGRAPHY = + T.let( + :photography, + BrandDev::Models::BrandWebScrapeImagesResponse::Image::Enrichment::Type::TaggedSymbol + ) + ILLUSTRATION = + T.let( + :illustration, + BrandDev::Models::BrandWebScrapeImagesResponse::Image::Enrichment::Type::TaggedSymbol + ) + LOGO = + T.let( + :logo, + BrandDev::Models::BrandWebScrapeImagesResponse::Image::Enrichment::Type::TaggedSymbol + ) + WORDMARK = + T.let( + :wordmark, + BrandDev::Models::BrandWebScrapeImagesResponse::Image::Enrichment::Type::TaggedSymbol + ) + ICON = + T.let( + :icon, + BrandDev::Models::BrandWebScrapeImagesResponse::Image::Enrichment::Type::TaggedSymbol + ) + PATTERN = + T.let( + :pattern, + BrandDev::Models::BrandWebScrapeImagesResponse::Image::Enrichment::Type::TaggedSymbol + ) + GRAPHIC = + T.let( + :graphic, + BrandDev::Models::BrandWebScrapeImagesResponse::Image::Enrichment::Type::TaggedSymbol + ) + OTHER = + T.let( + :other, + BrandDev::Models::BrandWebScrapeImagesResponse::Image::Enrichment::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + BrandDev::Models::BrandWebScrapeImagesResponse::Image::Enrichment::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + end end - # Indicates success + # Always true on success. module Success extend BrandDev::Internal::Type::Enum diff --git a/rbi/brand_dev/resources/brand.rbi b/rbi/brand_dev/resources/brand.rbi index 5f02fc0..b8f4d10 100644 --- a/rbi/brand_dev/resources/brand.rbi +++ b/rbi/brand_dev/resources/brand.rbi @@ -370,18 +370,27 @@ module BrandDev ) end - # Scrapes all images from the given URL. Extracts images from img, svg, - # picture/source, link, and video elements including inline SVGs, base64 data - # URIs, and standard URLs. + # Extract image assets from a web page, including standard URLs, inline SVGs, data + # URIs, responsive image sources, metadata, CSS backgrounds, video posters, and + # embeds. The base request costs 1 credit; enrichment costs 1 credit per returned + # image. sig do params( url: String, + enrichment: BrandDev::BrandWebScrapeImagesParams::Enrichment::OrHash, + max_age_ms: Integer, request_options: BrandDev::RequestOptions::OrHash ).returns(BrandDev::Models::BrandWebScrapeImagesResponse) end def web_scrape_images( - # Full URL to scrape images from (must include http:// or https:// protocol) + # Page URL to inspect. Must include http:// or https://. url:, + # Optional per-image processing, sent as deep-object query params such as + # enrichment[resolution]=true. + enrichment: nil, + # Reuse a cached result this many milliseconds old or newer. Default: 86400000 (1 + # day). Set to 0 to bypass cache. Maximum: 2592000000 (30 days). + max_age_ms: nil, request_options: {} ) end diff --git a/sig/brand_dev/models/brand_web_scrape_images_params.rbs b/sig/brand_dev/models/brand_web_scrape_images_params.rbs index daa60b3..fa99b37 100644 --- a/sig/brand_dev/models/brand_web_scrape_images_params.rbs +++ b/sig/brand_dev/models/brand_web_scrape_images_params.rbs @@ -1,7 +1,12 @@ module BrandDev module Models type brand_web_scrape_images_params = - { url: String } & BrandDev::Internal::Type::request_parameters + { + url: String, + enrichment: BrandDev::BrandWebScrapeImagesParams::Enrichment, + max_age_ms: Integer + } + & BrandDev::Internal::Type::request_parameters class BrandWebScrapeImagesParams < BrandDev::Internal::Type::BaseModel extend BrandDev::Internal::Type::RequestParameters::Converter @@ -9,12 +14,69 @@ module BrandDev attr_accessor url: String + attr_reader enrichment: BrandDev::BrandWebScrapeImagesParams::Enrichment? + + def enrichment=: ( + BrandDev::BrandWebScrapeImagesParams::Enrichment + ) -> BrandDev::BrandWebScrapeImagesParams::Enrichment + + attr_reader max_age_ms: Integer? + + def max_age_ms=: (Integer) -> Integer + def initialize: ( url: String, + ?enrichment: BrandDev::BrandWebScrapeImagesParams::Enrichment, + ?max_age_ms: Integer, ?request_options: BrandDev::request_opts ) -> void - def to_hash: -> { url: String, request_options: BrandDev::RequestOptions } + def to_hash: -> { + url: String, + enrichment: BrandDev::BrandWebScrapeImagesParams::Enrichment, + max_age_ms: Integer, + request_options: BrandDev::RequestOptions + } + + type enrichment = + { + classification: bool, + hosted_url: bool, + max_time_per_ms: Integer, + resolution: bool + } + + class Enrichment < BrandDev::Internal::Type::BaseModel + attr_reader classification: bool? + + def classification=: (bool) -> bool + + attr_reader hosted_url: bool? + + def hosted_url=: (bool) -> bool + + attr_reader max_time_per_ms: Integer? + + def max_time_per_ms=: (Integer) -> Integer + + attr_reader resolution: bool? + + def resolution=: (bool) -> bool + + def initialize: ( + ?classification: bool, + ?hosted_url: bool, + ?max_time_per_ms: Integer, + ?resolution: bool + ) -> void + + def to_hash: -> { + classification: bool, + hosted_url: bool, + max_time_per_ms: Integer, + resolution: bool + } + end end end end diff --git a/sig/brand_dev/models/brand_web_scrape_images_response.rbs b/sig/brand_dev/models/brand_web_scrape_images_response.rbs index 5c4390f..84a05c0 100644 --- a/sig/brand_dev/models/brand_web_scrape_images_response.rbs +++ b/sig/brand_dev/models/brand_web_scrape_images_response.rbs @@ -31,7 +31,8 @@ module BrandDev alt: String?, element: BrandDev::Models::BrandWebScrapeImagesResponse::Image::element, src: String, - type: BrandDev::Models::BrandWebScrapeImagesResponse::Image::type_ + type: BrandDev::Models::BrandWebScrapeImagesResponse::Image::type_, + enrichment: BrandDev::Models::BrandWebScrapeImagesResponse::Image::Enrichment } class Image < BrandDev::Internal::Type::BaseModel @@ -43,18 +44,26 @@ module BrandDev attr_accessor type: BrandDev::Models::BrandWebScrapeImagesResponse::Image::type_ + attr_reader enrichment: BrandDev::Models::BrandWebScrapeImagesResponse::Image::Enrichment? + + def enrichment=: ( + BrandDev::Models::BrandWebScrapeImagesResponse::Image::Enrichment + ) -> BrandDev::Models::BrandWebScrapeImagesResponse::Image::Enrichment + def initialize: ( alt: String?, element: BrandDev::Models::BrandWebScrapeImagesResponse::Image::element, src: String, - type: BrandDev::Models::BrandWebScrapeImagesResponse::Image::type_ + type: BrandDev::Models::BrandWebScrapeImagesResponse::Image::type_, + ?enrichment: BrandDev::Models::BrandWebScrapeImagesResponse::Image::Enrichment ) -> void def to_hash: -> { alt: String?, element: BrandDev::Models::BrandWebScrapeImagesResponse::Image::element, src: String, - type: BrandDev::Models::BrandWebScrapeImagesResponse::Image::type_ + type: BrandDev::Models::BrandWebScrapeImagesResponse::Image::type_, + enrichment: BrandDev::Models::BrandWebScrapeImagesResponse::Image::Enrichment } type element = @@ -95,6 +104,80 @@ module BrandDev def self?.values: -> ::Array[BrandDev::Models::BrandWebScrapeImagesResponse::Image::type_] end + + type enrichment = + { + height: Integer, + mimetype: String, + type: BrandDev::Models::BrandWebScrapeImagesResponse::Image::Enrichment::type_, + url: String, + width: Integer + } + + class Enrichment < BrandDev::Internal::Type::BaseModel + attr_reader height: Integer? + + def height=: (Integer) -> Integer + + attr_reader mimetype: String? + + def mimetype=: (String) -> String + + attr_reader type: BrandDev::Models::BrandWebScrapeImagesResponse::Image::Enrichment::type_? + + def type=: ( + BrandDev::Models::BrandWebScrapeImagesResponse::Image::Enrichment::type_ + ) -> BrandDev::Models::BrandWebScrapeImagesResponse::Image::Enrichment::type_ + + attr_reader url: String? + + def url=: (String) -> String + + attr_reader width: Integer? + + def width=: (Integer) -> Integer + + def initialize: ( + ?height: Integer, + ?mimetype: String, + ?type: BrandDev::Models::BrandWebScrapeImagesResponse::Image::Enrichment::type_, + ?url: String, + ?width: Integer + ) -> void + + def to_hash: -> { + height: Integer, + mimetype: String, + type: BrandDev::Models::BrandWebScrapeImagesResponse::Image::Enrichment::type_, + url: String, + width: Integer + } + + type type_ = + :photography + | :illustration + | :logo + | :wordmark + | :icon + | :pattern + | :graphic + | :other + + module Type + extend BrandDev::Internal::Type::Enum + + PHOTOGRAPHY: :photography + ILLUSTRATION: :illustration + LOGO: :logo + WORDMARK: :wordmark + ICON: :icon + PATTERN: :pattern + GRAPHIC: :graphic + OTHER: :other + + def self?.values: -> ::Array[BrandDev::Models::BrandWebScrapeImagesResponse::Image::Enrichment::type_] + end + end end type success = true diff --git a/sig/brand_dev/resources/brand.rbs b/sig/brand_dev/resources/brand.rbs index 054a461..ed97ac9 100644 --- a/sig/brand_dev/resources/brand.rbs +++ b/sig/brand_dev/resources/brand.rbs @@ -104,6 +104,8 @@ module BrandDev def web_scrape_images: ( url: String, + ?enrichment: BrandDev::BrandWebScrapeImagesParams::Enrichment, + ?max_age_ms: Integer, ?request_options: BrandDev::request_opts ) -> BrandDev::Models::BrandWebScrapeImagesResponse From d4ee671db627d6d979533c4502acd93b86b74b7c Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Wed, 6 May 2026 23:08:43 +0000 Subject: [PATCH 42/82] feat(api): api update --- .stats.yml | 4 +-- .../models/brand_retrieve_by_email_params.rb | 13 ++++++- .../models/brand_retrieve_by_isin_params.rb | 13 ++++++- .../models/brand_retrieve_by_name_params.rb | 13 ++++++- .../models/brand_retrieve_by_ticker_params.rb | 13 ++++++- lib/brand_dev/models/brand_retrieve_params.rb | 13 ++++++- .../brand_retrieve_simplified_params.rb | 13 ++++++- .../models/brand_web_scrape_images_params.rb | 4 +-- lib/brand_dev/resources/brand.rb | 36 ++++++++++++------- .../models/brand_retrieve_by_email_params.rbi | 17 +++++++++ .../models/brand_retrieve_by_isin_params.rbi | 17 +++++++++ .../models/brand_retrieve_by_name_params.rbi | 17 +++++++++ .../brand_retrieve_by_ticker_params.rbi | 17 +++++++++ .../models/brand_retrieve_params.rbi | 17 +++++++++ .../brand_retrieve_simplified_params.rbi | 17 +++++++++ .../models/brand_web_scrape_images_params.rbi | 4 +-- rbi/brand_dev/resources/brand.rbi | 36 +++++++++++++++++++ .../models/brand_retrieve_by_email_params.rbs | 7 ++++ .../models/brand_retrieve_by_isin_params.rbs | 7 ++++ .../models/brand_retrieve_by_name_params.rbs | 7 ++++ .../brand_retrieve_by_ticker_params.rbs | 7 ++++ .../models/brand_retrieve_params.rbs | 7 ++++ .../brand_retrieve_simplified_params.rbs | 8 ++++- sig/brand_dev/resources/brand.rbs | 6 ++++ 24 files changed, 288 insertions(+), 25 deletions(-) diff --git a/.stats.yml b/.stats.yml index 71256d4..399384d 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 16 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-f4118654961d5928e40ebe0771eb12f9aa1ca68cf9268bf3400eb1ab8b4dae1a.yml -openapi_spec_hash: ff26efd9c23ca8d4ed2c84f1716280c4 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-e299f3a9f343788f804eb0f7d71c609bf811bea363547ead01482e54612c3b37.yml +openapi_spec_hash: 4d17210ddd28eca4c39f89e5b864d066 config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 diff --git a/lib/brand_dev/models/brand_retrieve_by_email_params.rb b/lib/brand_dev/models/brand_retrieve_by_email_params.rb index c372bea..3ed52aa 100644 --- a/lib/brand_dev/models/brand_retrieve_by_email_params.rb +++ b/lib/brand_dev/models/brand_retrieve_by_email_params.rb @@ -21,6 +21,15 @@ class BrandRetrieveByEmailParams < BrandDev::Internal::Type::BaseModel # @return [Symbol, BrandDev::Models::BrandRetrieveByEmailParams::ForceLanguage, nil] optional :force_language, enum: -> { BrandDev::BrandRetrieveByEmailParams::ForceLanguage } + # @!attribute max_age_ms + # Maximum age in milliseconds for cached brand data before the API performs a hard + # refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms) + # are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1 + # year. + # + # @return [Integer, nil] + optional :max_age_ms, Integer + # @!attribute max_speed # Optional parameter to optimize the API call for maximum speed. When set to true, # the API will skip time-consuming operations for faster response at the cost of @@ -37,7 +46,7 @@ class BrandRetrieveByEmailParams < BrandDev::Internal::Type::BaseModel # @return [Integer, nil] optional :timeout_ms, Integer - # @!method initialize(email:, force_language: nil, max_speed: nil, timeout_ms: nil, request_options: {}) + # @!method initialize(email:, force_language: nil, max_age_ms: nil, max_speed: nil, timeout_ms: nil, request_options: {}) # Some parameter documentations has been truncated, see # {BrandDev::Models::BrandRetrieveByEmailParams} for more details. # @@ -45,6 +54,8 @@ class BrandRetrieveByEmailParams < BrandDev::Internal::Type::BaseModel # # @param force_language [Symbol, BrandDev::Models::BrandRetrieveByEmailParams::ForceLanguage] Optional parameter to force the language of the retrieved brand data. # + # @param max_age_ms [Integer] Maximum age in milliseconds for cached brand data before the API performs a hard + # # @param max_speed [Boolean] Optional parameter to optimize the API call for maximum speed. When set to true, # # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th diff --git a/lib/brand_dev/models/brand_retrieve_by_isin_params.rb b/lib/brand_dev/models/brand_retrieve_by_isin_params.rb index 47f176e..09aa0c7 100644 --- a/lib/brand_dev/models/brand_retrieve_by_isin_params.rb +++ b/lib/brand_dev/models/brand_retrieve_by_isin_params.rb @@ -21,6 +21,15 @@ class BrandRetrieveByIsinParams < BrandDev::Internal::Type::BaseModel # @return [Symbol, BrandDev::Models::BrandRetrieveByIsinParams::ForceLanguage, nil] optional :force_language, enum: -> { BrandDev::BrandRetrieveByIsinParams::ForceLanguage } + # @!attribute max_age_ms + # Maximum age in milliseconds for cached brand data before the API performs a hard + # refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms) + # are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1 + # year. + # + # @return [Integer, nil] + optional :max_age_ms, Integer + # @!attribute max_speed # Optional parameter to optimize the API call for maximum speed. When set to true, # the API will skip time-consuming operations for faster response at the cost of @@ -37,7 +46,7 @@ class BrandRetrieveByIsinParams < BrandDev::Internal::Type::BaseModel # @return [Integer, nil] optional :timeout_ms, Integer - # @!method initialize(isin:, force_language: nil, max_speed: nil, timeout_ms: nil, request_options: {}) + # @!method initialize(isin:, force_language: nil, max_age_ms: nil, max_speed: nil, timeout_ms: nil, request_options: {}) # Some parameter documentations has been truncated, see # {BrandDev::Models::BrandRetrieveByIsinParams} for more details. # @@ -45,6 +54,8 @@ class BrandRetrieveByIsinParams < BrandDev::Internal::Type::BaseModel # # @param force_language [Symbol, BrandDev::Models::BrandRetrieveByIsinParams::ForceLanguage] Optional parameter to force the language of the retrieved brand data. # + # @param max_age_ms [Integer] Maximum age in milliseconds for cached brand data before the API performs a hard + # # @param max_speed [Boolean] Optional parameter to optimize the API call for maximum speed. When set to true, # # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th diff --git a/lib/brand_dev/models/brand_retrieve_by_name_params.rb b/lib/brand_dev/models/brand_retrieve_by_name_params.rb index ab5707b..df3c932 100644 --- a/lib/brand_dev/models/brand_retrieve_by_name_params.rb +++ b/lib/brand_dev/models/brand_retrieve_by_name_params.rb @@ -27,6 +27,15 @@ class BrandRetrieveByNameParams < BrandDev::Internal::Type::BaseModel # @return [Symbol, BrandDev::Models::BrandRetrieveByNameParams::ForceLanguage, nil] optional :force_language, enum: -> { BrandDev::BrandRetrieveByNameParams::ForceLanguage } + # @!attribute max_age_ms + # Maximum age in milliseconds for cached brand data before the API performs a hard + # refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms) + # are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1 + # year. + # + # @return [Integer, nil] + optional :max_age_ms, Integer + # @!attribute max_speed # Optional parameter to optimize the API call for maximum speed. When set to true, # the API will skip time-consuming operations for faster response at the cost of @@ -43,7 +52,7 @@ class BrandRetrieveByNameParams < BrandDev::Internal::Type::BaseModel # @return [Integer, nil] optional :timeout_ms, Integer - # @!method initialize(name:, country_gl: nil, force_language: nil, max_speed: nil, timeout_ms: nil, request_options: {}) + # @!method initialize(name:, country_gl: nil, force_language: nil, max_age_ms: nil, max_speed: nil, timeout_ms: nil, request_options: {}) # Some parameter documentations has been truncated, see # {BrandDev::Models::BrandRetrieveByNameParams} for more details. # @@ -53,6 +62,8 @@ class BrandRetrieveByNameParams < BrandDev::Internal::Type::BaseModel # # @param force_language [Symbol, BrandDev::Models::BrandRetrieveByNameParams::ForceLanguage] Optional parameter to force the language of the retrieved brand data. # + # @param max_age_ms [Integer] Maximum age in milliseconds for cached brand data before the API performs a hard + # # @param max_speed [Boolean] Optional parameter to optimize the API call for maximum speed. When set to true, # # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th diff --git a/lib/brand_dev/models/brand_retrieve_by_ticker_params.rb b/lib/brand_dev/models/brand_retrieve_by_ticker_params.rb index 4a8d6ff..dde7e12 100644 --- a/lib/brand_dev/models/brand_retrieve_by_ticker_params.rb +++ b/lib/brand_dev/models/brand_retrieve_by_ticker_params.rb @@ -20,6 +20,15 @@ class BrandRetrieveByTickerParams < BrandDev::Internal::Type::BaseModel # @return [Symbol, BrandDev::Models::BrandRetrieveByTickerParams::ForceLanguage, nil] optional :force_language, enum: -> { BrandDev::BrandRetrieveByTickerParams::ForceLanguage } + # @!attribute max_age_ms + # Maximum age in milliseconds for cached brand data before the API performs a hard + # refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms) + # are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1 + # year. + # + # @return [Integer, nil] + optional :max_age_ms, Integer + # @!attribute max_speed # Optional parameter to optimize the API call for maximum speed. When set to true, # the API will skip time-consuming operations for faster response at the cost of @@ -42,7 +51,7 @@ class BrandRetrieveByTickerParams < BrandDev::Internal::Type::BaseModel # @return [Integer, nil] optional :timeout_ms, Integer - # @!method initialize(ticker:, force_language: nil, max_speed: nil, ticker_exchange: nil, timeout_ms: nil, request_options: {}) + # @!method initialize(ticker:, force_language: nil, max_age_ms: nil, max_speed: nil, ticker_exchange: nil, timeout_ms: nil, request_options: {}) # Some parameter documentations has been truncated, see # {BrandDev::Models::BrandRetrieveByTickerParams} for more details. # @@ -50,6 +59,8 @@ class BrandRetrieveByTickerParams < BrandDev::Internal::Type::BaseModel # # @param force_language [Symbol, BrandDev::Models::BrandRetrieveByTickerParams::ForceLanguage] Optional parameter to force the language of the retrieved brand data. # + # @param max_age_ms [Integer] Maximum age in milliseconds for cached brand data before the API performs a hard + # # @param max_speed [Boolean] Optional parameter to optimize the API call for maximum speed. When set to true, # # @param ticker_exchange [Symbol, BrandDev::Models::BrandRetrieveByTickerParams::TickerExchange] Optional stock exchange for the ticker. Defaults to NASDAQ if not specified. diff --git a/lib/brand_dev/models/brand_retrieve_params.rb b/lib/brand_dev/models/brand_retrieve_params.rb index da16e16..d4e70c5 100644 --- a/lib/brand_dev/models/brand_retrieve_params.rb +++ b/lib/brand_dev/models/brand_retrieve_params.rb @@ -20,6 +20,15 @@ class BrandRetrieveParams < BrandDev::Internal::Type::BaseModel # @return [Symbol, BrandDev::Models::BrandRetrieveParams::ForceLanguage, nil] optional :force_language, enum: -> { BrandDev::BrandRetrieveParams::ForceLanguage } + # @!attribute max_age_ms + # Maximum age in milliseconds for cached brand data before the API performs a hard + # refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms) + # are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1 + # year. + # + # @return [Integer, nil] + optional :max_age_ms, Integer + # @!attribute max_speed # Optional parameter to optimize the API call for maximum speed. When set to true, # the API will skip time-consuming operations for faster response at the cost of @@ -36,7 +45,7 @@ class BrandRetrieveParams < BrandDev::Internal::Type::BaseModel # @return [Integer, nil] optional :timeout_ms, Integer - # @!method initialize(domain:, force_language: nil, max_speed: nil, timeout_ms: nil, request_options: {}) + # @!method initialize(domain:, force_language: nil, max_age_ms: nil, max_speed: nil, timeout_ms: nil, request_options: {}) # Some parameter documentations has been truncated, see # {BrandDev::Models::BrandRetrieveParams} for more details. # @@ -44,6 +53,8 @@ class BrandRetrieveParams < BrandDev::Internal::Type::BaseModel # # @param force_language [Symbol, BrandDev::Models::BrandRetrieveParams::ForceLanguage] Optional parameter to force the language of the retrieved brand data. # + # @param max_age_ms [Integer] Maximum age in milliseconds for cached brand data before the API performs a hard + # # @param max_speed [Boolean] Optional parameter to optimize the API call for maximum speed. When set to true, # # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th diff --git a/lib/brand_dev/models/brand_retrieve_simplified_params.rb b/lib/brand_dev/models/brand_retrieve_simplified_params.rb index ce11be6..b6e2ef5 100644 --- a/lib/brand_dev/models/brand_retrieve_simplified_params.rb +++ b/lib/brand_dev/models/brand_retrieve_simplified_params.rb @@ -13,6 +13,15 @@ class BrandRetrieveSimplifiedParams < BrandDev::Internal::Type::BaseModel # @return [String] required :domain, String + # @!attribute max_age_ms + # Maximum age in milliseconds for cached brand data before the API performs a hard + # refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms) + # are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1 + # year. + # + # @return [Integer, nil] + optional :max_age_ms, Integer + # @!attribute timeout_ms # Optional timeout in milliseconds for the request. If the request takes longer # than this value, it will be aborted with a 408 status code. Maximum allowed @@ -21,12 +30,14 @@ class BrandRetrieveSimplifiedParams < BrandDev::Internal::Type::BaseModel # @return [Integer, nil] optional :timeout_ms, Integer - # @!method initialize(domain:, timeout_ms: nil, request_options: {}) + # @!method initialize(domain:, max_age_ms: nil, timeout_ms: nil, request_options: {}) # Some parameter documentations has been truncated, see # {BrandDev::Models::BrandRetrieveSimplifiedParams} for more details. # # @param domain [String] Domain name to retrieve simplified brand data for # + # @param max_age_ms [Integer] Maximum age in milliseconds for cached brand data before the API performs a hard + # # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th # # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}] diff --git a/lib/brand_dev/models/brand_web_scrape_images_params.rb b/lib/brand_dev/models/brand_web_scrape_images_params.rb index 7b05029..f23863c 100644 --- a/lib/brand_dev/models/brand_web_scrape_images_params.rb +++ b/lib/brand_dev/models/brand_web_scrape_images_params.rb @@ -54,7 +54,7 @@ class Enrichment < BrandDev::Internal::Type::BaseModel optional :hosted_url, BrandDev::Internal::Type::Boolean, api_name: :hostedUrl # @!attribute max_time_per_ms - # Per-image enrichment timeout in milliseconds. Default: 6000. Maximum: 60000. + # Per-image enrichment timeout in milliseconds. Default: 30000. Maximum: 60000. # # @return [Integer, nil] optional :max_time_per_ms, Integer, api_name: :maxTimePerMs @@ -76,7 +76,7 @@ class Enrichment < BrandDev::Internal::Type::BaseModel # # @param hosted_url [Boolean] Host materializable images on the Brand.dev CDN and return their URL and MIME ty # - # @param max_time_per_ms [Integer] Per-image enrichment timeout in milliseconds. Default: 6000. Maximum: 60000. + # @param max_time_per_ms [Integer] Per-image enrichment timeout in milliseconds. Default: 30000. Maximum: 60000. # # @param resolution [Boolean] Measure image width and height when possible. end diff --git a/lib/brand_dev/resources/brand.rb b/lib/brand_dev/resources/brand.rb index 6e213e5..b7f8647 100644 --- a/lib/brand_dev/resources/brand.rb +++ b/lib/brand_dev/resources/brand.rb @@ -9,12 +9,14 @@ class Brand # Retrieve logos, backdrops, colors, industry, description, and more from any # domain # - # @overload retrieve(domain:, force_language: nil, max_speed: nil, timeout_ms: nil, request_options: {}) + # @overload retrieve(domain:, force_language: nil, max_age_ms: nil, max_speed: nil, timeout_ms: nil, request_options: {}) # # @param domain [String] Domain name to retrieve brand data for (e.g., 'example.com', 'google.com'). Cann # # @param force_language [Symbol, BrandDev::Models::BrandRetrieveParams::ForceLanguage] Optional parameter to force the language of the retrieved brand data. # + # @param max_age_ms [Integer] Maximum age in milliseconds for cached brand data before the API performs a hard + # # @param max_speed [Boolean] Optional parameter to optimize the API call for maximum speed. When set to true, # # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th @@ -30,7 +32,7 @@ def retrieve(params) @client.request( method: :get, path: "brand/retrieve", - query: query.transform_keys(max_speed: "maxSpeed", timeout_ms: "timeoutMS"), + query: query.transform_keys(max_age_ms: "maxAgeMs", max_speed: "maxSpeed", timeout_ms: "timeoutMS"), model: BrandDev::Models::BrandRetrieveResponse, options: options ) @@ -230,12 +232,14 @@ def prefetch_by_email(params) # free email addresses. Disposable and free email addresses (like gmail.com, # yahoo.com) will throw a 422 error. # - # @overload retrieve_by_email(email:, force_language: nil, max_speed: nil, timeout_ms: nil, request_options: {}) + # @overload retrieve_by_email(email:, force_language: nil, max_age_ms: nil, max_speed: nil, timeout_ms: nil, request_options: {}) # # @param email [String] Email address to retrieve brand data for (e.g., 'contact@example.com'). The doma # # @param force_language [Symbol, BrandDev::Models::BrandRetrieveByEmailParams::ForceLanguage] Optional parameter to force the language of the retrieved brand data. # + # @param max_age_ms [Integer] Maximum age in milliseconds for cached brand data before the API performs a hard + # # @param max_speed [Boolean] Optional parameter to optimize the API call for maximum speed. When set to true, # # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th @@ -251,7 +255,7 @@ def retrieve_by_email(params) @client.request( method: :get, path: "brand/retrieve-by-email", - query: query.transform_keys(max_speed: "maxSpeed", timeout_ms: "timeoutMS"), + query: query.transform_keys(max_age_ms: "maxAgeMs", max_speed: "maxSpeed", timeout_ms: "timeoutMS"), model: BrandDev::Models::BrandRetrieveByEmailResponse, options: options ) @@ -263,12 +267,14 @@ def retrieve_by_email(params) # Retrieve brand information using an ISIN (International Securities # Identification Number). # - # @overload retrieve_by_isin(isin:, force_language: nil, max_speed: nil, timeout_ms: nil, request_options: {}) + # @overload retrieve_by_isin(isin:, force_language: nil, max_age_ms: nil, max_speed: nil, timeout_ms: nil, request_options: {}) # # @param isin [String] ISIN (International Securities Identification Number) to retrieve brand data for # # @param force_language [Symbol, BrandDev::Models::BrandRetrieveByIsinParams::ForceLanguage] Optional parameter to force the language of the retrieved brand data. # + # @param max_age_ms [Integer] Maximum age in milliseconds for cached brand data before the API performs a hard + # # @param max_speed [Boolean] Optional parameter to optimize the API call for maximum speed. When set to true, # # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th @@ -284,7 +290,7 @@ def retrieve_by_isin(params) @client.request( method: :get, path: "brand/retrieve-by-isin", - query: query.transform_keys(max_speed: "maxSpeed", timeout_ms: "timeoutMS"), + query: query.transform_keys(max_age_ms: "maxAgeMs", max_speed: "maxSpeed", timeout_ms: "timeoutMS"), model: BrandDev::Models::BrandRetrieveByIsinResponse, options: options ) @@ -295,7 +301,7 @@ def retrieve_by_isin(params) # # Retrieve brand information using a company name. # - # @overload retrieve_by_name(name:, country_gl: nil, force_language: nil, max_speed: nil, timeout_ms: nil, request_options: {}) + # @overload retrieve_by_name(name:, country_gl: nil, force_language: nil, max_age_ms: nil, max_speed: nil, timeout_ms: nil, request_options: {}) # # @param name [String] Company name to retrieve brand data for (e.g., 'Apple Inc', 'Microsoft Corporati # @@ -303,6 +309,8 @@ def retrieve_by_isin(params) # # @param force_language [Symbol, BrandDev::Models::BrandRetrieveByNameParams::ForceLanguage] Optional parameter to force the language of the retrieved brand data. # + # @param max_age_ms [Integer] Maximum age in milliseconds for cached brand data before the API performs a hard + # # @param max_speed [Boolean] Optional parameter to optimize the API call for maximum speed. When set to true, # # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th @@ -318,7 +326,7 @@ def retrieve_by_name(params) @client.request( method: :get, path: "brand/retrieve-by-name", - query: query.transform_keys(max_speed: "maxSpeed", timeout_ms: "timeoutMS"), + query: query.transform_keys(max_age_ms: "maxAgeMs", max_speed: "maxSpeed", timeout_ms: "timeoutMS"), model: BrandDev::Models::BrandRetrieveByNameResponse, options: options ) @@ -329,12 +337,14 @@ def retrieve_by_name(params) # # Retrieve brand information using a stock ticker symbol. # - # @overload retrieve_by_ticker(ticker:, force_language: nil, max_speed: nil, ticker_exchange: nil, timeout_ms: nil, request_options: {}) + # @overload retrieve_by_ticker(ticker:, force_language: nil, max_age_ms: nil, max_speed: nil, ticker_exchange: nil, timeout_ms: nil, request_options: {}) # # @param ticker [String] Stock ticker symbol to retrieve brand data for (e.g., 'AAPL', 'GOOGL', 'BRK.A'). # # @param force_language [Symbol, BrandDev::Models::BrandRetrieveByTickerParams::ForceLanguage] Optional parameter to force the language of the retrieved brand data. # + # @param max_age_ms [Integer] Maximum age in milliseconds for cached brand data before the API performs a hard + # # @param max_speed [Boolean] Optional parameter to optimize the API call for maximum speed. When set to true, # # @param ticker_exchange [Symbol, BrandDev::Models::BrandRetrieveByTickerParams::TickerExchange] Optional stock exchange for the ticker. Defaults to NASDAQ if not specified. @@ -352,7 +362,7 @@ def retrieve_by_ticker(params) @client.request( method: :get, path: "brand/retrieve-by-ticker", - query: query.transform_keys(max_speed: "maxSpeed", timeout_ms: "timeoutMS"), + query: query.transform_keys(max_age_ms: "maxAgeMs", max_speed: "maxSpeed", timeout_ms: "timeoutMS"), model: BrandDev::Models::BrandRetrieveByTickerResponse, options: options ) @@ -365,10 +375,12 @@ def retrieve_by_ticker(params) # information: domain, title, colors, logos, and backdrops. Optimized for faster # responses and reduced data transfer. # - # @overload retrieve_simplified(domain:, timeout_ms: nil, request_options: {}) + # @overload retrieve_simplified(domain:, max_age_ms: nil, timeout_ms: nil, request_options: {}) # # @param domain [String] Domain name to retrieve simplified brand data for # + # @param max_age_ms [Integer] Maximum age in milliseconds for cached brand data before the API performs a hard + # # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th # # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}, nil] @@ -382,7 +394,7 @@ def retrieve_simplified(params) @client.request( method: :get, path: "brand/retrieve-simplified", - query: query.transform_keys(timeout_ms: "timeoutMS"), + query: query.transform_keys(max_age_ms: "maxAgeMs", timeout_ms: "timeoutMS"), model: BrandDev::Models::BrandRetrieveSimplifiedResponse, options: options ) diff --git a/rbi/brand_dev/models/brand_retrieve_by_email_params.rbi b/rbi/brand_dev/models/brand_retrieve_by_email_params.rbi index 1f9e4fe..bd4e3eb 100644 --- a/rbi/brand_dev/models/brand_retrieve_by_email_params.rbi +++ b/rbi/brand_dev/models/brand_retrieve_by_email_params.rbi @@ -38,6 +38,16 @@ module BrandDev end attr_writer :force_language + # Maximum age in milliseconds for cached brand data before the API performs a hard + # refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms) + # are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1 + # year. + sig { returns(T.nilable(Integer)) } + attr_reader :max_age_ms + + sig { params(max_age_ms: Integer).void } + attr_writer :max_age_ms + # Optional parameter to optimize the API call for maximum speed. When set to true, # the API will skip time-consuming operations for faster response at the cost of # less comprehensive data. @@ -61,6 +71,7 @@ module BrandDev email: String, force_language: BrandDev::BrandRetrieveByEmailParams::ForceLanguage::OrSymbol, + max_age_ms: Integer, max_speed: T::Boolean, timeout_ms: Integer, request_options: BrandDev::RequestOptions::OrHash @@ -73,6 +84,11 @@ module BrandDev email:, # Optional parameter to force the language of the retrieved brand data. force_language: nil, + # Maximum age in milliseconds for cached brand data before the API performs a hard + # refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms) + # are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1 + # year. + max_age_ms: nil, # Optional parameter to optimize the API call for maximum speed. When set to true, # the API will skip time-consuming operations for faster response at the cost of # less comprehensive data. @@ -91,6 +107,7 @@ module BrandDev email: String, force_language: BrandDev::BrandRetrieveByEmailParams::ForceLanguage::OrSymbol, + max_age_ms: Integer, max_speed: T::Boolean, timeout_ms: Integer, request_options: BrandDev::RequestOptions diff --git a/rbi/brand_dev/models/brand_retrieve_by_isin_params.rbi b/rbi/brand_dev/models/brand_retrieve_by_isin_params.rbi index 6c22156..8e2299e 100644 --- a/rbi/brand_dev/models/brand_retrieve_by_isin_params.rbi +++ b/rbi/brand_dev/models/brand_retrieve_by_isin_params.rbi @@ -38,6 +38,16 @@ module BrandDev end attr_writer :force_language + # Maximum age in milliseconds for cached brand data before the API performs a hard + # refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms) + # are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1 + # year. + sig { returns(T.nilable(Integer)) } + attr_reader :max_age_ms + + sig { params(max_age_ms: Integer).void } + attr_writer :max_age_ms + # Optional parameter to optimize the API call for maximum speed. When set to true, # the API will skip time-consuming operations for faster response at the cost of # less comprehensive data. @@ -61,6 +71,7 @@ module BrandDev isin: String, force_language: BrandDev::BrandRetrieveByIsinParams::ForceLanguage::OrSymbol, + max_age_ms: Integer, max_speed: T::Boolean, timeout_ms: Integer, request_options: BrandDev::RequestOptions::OrHash @@ -73,6 +84,11 @@ module BrandDev isin:, # Optional parameter to force the language of the retrieved brand data. force_language: nil, + # Maximum age in milliseconds for cached brand data before the API performs a hard + # refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms) + # are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1 + # year. + max_age_ms: nil, # Optional parameter to optimize the API call for maximum speed. When set to true, # the API will skip time-consuming operations for faster response at the cost of # less comprehensive data. @@ -91,6 +107,7 @@ module BrandDev isin: String, force_language: BrandDev::BrandRetrieveByIsinParams::ForceLanguage::OrSymbol, + max_age_ms: Integer, max_speed: T::Boolean, timeout_ms: Integer, request_options: BrandDev::RequestOptions diff --git a/rbi/brand_dev/models/brand_retrieve_by_name_params.rbi b/rbi/brand_dev/models/brand_retrieve_by_name_params.rbi index 82ecc67..817df65 100644 --- a/rbi/brand_dev/models/brand_retrieve_by_name_params.rbi +++ b/rbi/brand_dev/models/brand_retrieve_by_name_params.rbi @@ -53,6 +53,16 @@ module BrandDev end attr_writer :force_language + # Maximum age in milliseconds for cached brand data before the API performs a hard + # refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms) + # are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1 + # year. + sig { returns(T.nilable(Integer)) } + attr_reader :max_age_ms + + sig { params(max_age_ms: Integer).void } + attr_writer :max_age_ms + # Optional parameter to optimize the API call for maximum speed. When set to true, # the API will skip time-consuming operations for faster response at the cost of # less comprehensive data. @@ -77,6 +87,7 @@ module BrandDev country_gl: BrandDev::BrandRetrieveByNameParams::CountryGl::OrSymbol, force_language: BrandDev::BrandRetrieveByNameParams::ForceLanguage::OrSymbol, + max_age_ms: Integer, max_speed: T::Boolean, timeout_ms: Integer, request_options: BrandDev::RequestOptions::OrHash @@ -91,6 +102,11 @@ module BrandDev country_gl: nil, # Optional parameter to force the language of the retrieved brand data. force_language: nil, + # Maximum age in milliseconds for cached brand data before the API performs a hard + # refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms) + # are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1 + # year. + max_age_ms: nil, # Optional parameter to optimize the API call for maximum speed. When set to true, # the API will skip time-consuming operations for faster response at the cost of # less comprehensive data. @@ -111,6 +127,7 @@ module BrandDev BrandDev::BrandRetrieveByNameParams::CountryGl::OrSymbol, force_language: BrandDev::BrandRetrieveByNameParams::ForceLanguage::OrSymbol, + max_age_ms: Integer, max_speed: T::Boolean, timeout_ms: Integer, request_options: BrandDev::RequestOptions diff --git a/rbi/brand_dev/models/brand_retrieve_by_ticker_params.rbi b/rbi/brand_dev/models/brand_retrieve_by_ticker_params.rbi index 19fc9f3..e058cef 100644 --- a/rbi/brand_dev/models/brand_retrieve_by_ticker_params.rbi +++ b/rbi/brand_dev/models/brand_retrieve_by_ticker_params.rbi @@ -37,6 +37,16 @@ module BrandDev end attr_writer :force_language + # Maximum age in milliseconds for cached brand data before the API performs a hard + # refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms) + # are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1 + # year. + sig { returns(T.nilable(Integer)) } + attr_reader :max_age_ms + + sig { params(max_age_ms: Integer).void } + attr_writer :max_age_ms + # Optional parameter to optimize the API call for maximum speed. When set to true, # the API will skip time-consuming operations for faster response at the cost of # less comprehensive data. @@ -78,6 +88,7 @@ module BrandDev ticker: String, force_language: BrandDev::BrandRetrieveByTickerParams::ForceLanguage::OrSymbol, + max_age_ms: Integer, max_speed: T::Boolean, ticker_exchange: BrandDev::BrandRetrieveByTickerParams::TickerExchange::OrSymbol, @@ -91,6 +102,11 @@ module BrandDev ticker:, # Optional parameter to force the language of the retrieved brand data. force_language: nil, + # Maximum age in milliseconds for cached brand data before the API performs a hard + # refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms) + # are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1 + # year. + max_age_ms: nil, # Optional parameter to optimize the API call for maximum speed. When set to true, # the API will skip time-consuming operations for faster response at the cost of # less comprehensive data. @@ -111,6 +127,7 @@ module BrandDev ticker: String, force_language: BrandDev::BrandRetrieveByTickerParams::ForceLanguage::OrSymbol, + max_age_ms: Integer, max_speed: T::Boolean, ticker_exchange: BrandDev::BrandRetrieveByTickerParams::TickerExchange::OrSymbol, diff --git a/rbi/brand_dev/models/brand_retrieve_params.rbi b/rbi/brand_dev/models/brand_retrieve_params.rbi index 822fd02..0562680 100644 --- a/rbi/brand_dev/models/brand_retrieve_params.rbi +++ b/rbi/brand_dev/models/brand_retrieve_params.rbi @@ -31,6 +31,16 @@ module BrandDev end attr_writer :force_language + # Maximum age in milliseconds for cached brand data before the API performs a hard + # refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms) + # are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1 + # year. + sig { returns(T.nilable(Integer)) } + attr_reader :max_age_ms + + sig { params(max_age_ms: Integer).void } + attr_writer :max_age_ms + # Optional parameter to optimize the API call for maximum speed. When set to true, # the API will skip time-consuming operations for faster response at the cost of # less comprehensive data. Works with all three lookup methods. @@ -54,6 +64,7 @@ module BrandDev domain: String, force_language: BrandDev::BrandRetrieveParams::ForceLanguage::OrSymbol, + max_age_ms: Integer, max_speed: T::Boolean, timeout_ms: Integer, request_options: BrandDev::RequestOptions::OrHash @@ -65,6 +76,11 @@ module BrandDev domain:, # Optional parameter to force the language of the retrieved brand data. force_language: nil, + # Maximum age in milliseconds for cached brand data before the API performs a hard + # refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms) + # are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1 + # year. + max_age_ms: nil, # Optional parameter to optimize the API call for maximum speed. When set to true, # the API will skip time-consuming operations for faster response at the cost of # less comprehensive data. Works with all three lookup methods. @@ -83,6 +99,7 @@ module BrandDev domain: String, force_language: BrandDev::BrandRetrieveParams::ForceLanguage::OrSymbol, + max_age_ms: Integer, max_speed: T::Boolean, timeout_ms: Integer, request_options: BrandDev::RequestOptions diff --git a/rbi/brand_dev/models/brand_retrieve_simplified_params.rbi b/rbi/brand_dev/models/brand_retrieve_simplified_params.rbi index 25da429..a4c9138 100644 --- a/rbi/brand_dev/models/brand_retrieve_simplified_params.rbi +++ b/rbi/brand_dev/models/brand_retrieve_simplified_params.rbi @@ -18,6 +18,16 @@ module BrandDev sig { returns(String) } attr_accessor :domain + # Maximum age in milliseconds for cached brand data before the API performs a hard + # refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms) + # are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1 + # year. + sig { returns(T.nilable(Integer)) } + attr_reader :max_age_ms + + sig { params(max_age_ms: Integer).void } + attr_writer :max_age_ms + # Optional timeout in milliseconds for the request. If the request takes longer # than this value, it will be aborted with a 408 status code. Maximum allowed # value is 300000ms (5 minutes). @@ -30,6 +40,7 @@ module BrandDev sig do params( domain: String, + max_age_ms: Integer, timeout_ms: Integer, request_options: BrandDev::RequestOptions::OrHash ).returns(T.attached_class) @@ -37,6 +48,11 @@ module BrandDev def self.new( # Domain name to retrieve simplified brand data for domain:, + # Maximum age in milliseconds for cached brand data before the API performs a hard + # refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms) + # are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1 + # year. + max_age_ms: nil, # Optional timeout in milliseconds for the request. If the request takes longer # than this value, it will be aborted with a 408 status code. Maximum allowed # value is 300000ms (5 minutes). @@ -49,6 +65,7 @@ module BrandDev override.returns( { domain: String, + max_age_ms: Integer, timeout_ms: Integer, request_options: BrandDev::RequestOptions } diff --git a/rbi/brand_dev/models/brand_web_scrape_images_params.rbi b/rbi/brand_dev/models/brand_web_scrape_images_params.rbi index f972368..b73e330 100644 --- a/rbi/brand_dev/models/brand_web_scrape_images_params.rbi +++ b/rbi/brand_dev/models/brand_web_scrape_images_params.rbi @@ -98,7 +98,7 @@ module BrandDev sig { params(hosted_url: T::Boolean).void } attr_writer :hosted_url - # Per-image enrichment timeout in milliseconds. Default: 6000. Maximum: 60000. + # Per-image enrichment timeout in milliseconds. Default: 30000. Maximum: 60000. sig { returns(T.nilable(Integer)) } attr_reader :max_time_per_ms @@ -128,7 +128,7 @@ module BrandDev # Host materializable images on the Brand.dev CDN and return their URL and MIME # type. hosted_url: nil, - # Per-image enrichment timeout in milliseconds. Default: 6000. Maximum: 60000. + # Per-image enrichment timeout in milliseconds. Default: 30000. Maximum: 60000. max_time_per_ms: nil, # Measure image width and height when possible. resolution: nil diff --git a/rbi/brand_dev/resources/brand.rbi b/rbi/brand_dev/resources/brand.rbi index b8f4d10..5b548fb 100644 --- a/rbi/brand_dev/resources/brand.rbi +++ b/rbi/brand_dev/resources/brand.rbi @@ -10,6 +10,7 @@ module BrandDev domain: String, force_language: BrandDev::BrandRetrieveParams::ForceLanguage::OrSymbol, + max_age_ms: Integer, max_speed: T::Boolean, timeout_ms: Integer, request_options: BrandDev::RequestOptions::OrHash @@ -21,6 +22,11 @@ module BrandDev domain:, # Optional parameter to force the language of the retrieved brand data. force_language: nil, + # Maximum age in milliseconds for cached brand data before the API performs a hard + # refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms) + # are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1 + # year. + max_age_ms: nil, # Optional parameter to optimize the API call for maximum speed. When set to true, # the API will skip time-consuming operations for faster response at the cost of # less comprehensive data. Works with all three lookup methods. @@ -201,6 +207,7 @@ module BrandDev email: String, force_language: BrandDev::BrandRetrieveByEmailParams::ForceLanguage::OrSymbol, + max_age_ms: Integer, max_speed: T::Boolean, timeout_ms: Integer, request_options: BrandDev::RequestOptions::OrHash @@ -213,6 +220,11 @@ module BrandDev email:, # Optional parameter to force the language of the retrieved brand data. force_language: nil, + # Maximum age in milliseconds for cached brand data before the API performs a hard + # refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms) + # are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1 + # year. + max_age_ms: nil, # Optional parameter to optimize the API call for maximum speed. When set to true, # the API will skip time-consuming operations for faster response at the cost of # less comprehensive data. @@ -232,6 +244,7 @@ module BrandDev isin: String, force_language: BrandDev::BrandRetrieveByIsinParams::ForceLanguage::OrSymbol, + max_age_ms: Integer, max_speed: T::Boolean, timeout_ms: Integer, request_options: BrandDev::RequestOptions::OrHash @@ -244,6 +257,11 @@ module BrandDev isin:, # Optional parameter to force the language of the retrieved brand data. force_language: nil, + # Maximum age in milliseconds for cached brand data before the API performs a hard + # refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms) + # are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1 + # year. + max_age_ms: nil, # Optional parameter to optimize the API call for maximum speed. When set to true, # the API will skip time-consuming operations for faster response at the cost of # less comprehensive data. @@ -263,6 +281,7 @@ module BrandDev country_gl: BrandDev::BrandRetrieveByNameParams::CountryGl::OrSymbol, force_language: BrandDev::BrandRetrieveByNameParams::ForceLanguage::OrSymbol, + max_age_ms: Integer, max_speed: T::Boolean, timeout_ms: Integer, request_options: BrandDev::RequestOptions::OrHash @@ -277,6 +296,11 @@ module BrandDev country_gl: nil, # Optional parameter to force the language of the retrieved brand data. force_language: nil, + # Maximum age in milliseconds for cached brand data before the API performs a hard + # refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms) + # are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1 + # year. + max_age_ms: nil, # Optional parameter to optimize the API call for maximum speed. When set to true, # the API will skip time-consuming operations for faster response at the cost of # less comprehensive data. @@ -295,6 +319,7 @@ module BrandDev ticker: String, force_language: BrandDev::BrandRetrieveByTickerParams::ForceLanguage::OrSymbol, + max_age_ms: Integer, max_speed: T::Boolean, ticker_exchange: BrandDev::BrandRetrieveByTickerParams::TickerExchange::OrSymbol, @@ -308,6 +333,11 @@ module BrandDev ticker:, # Optional parameter to force the language of the retrieved brand data. force_language: nil, + # Maximum age in milliseconds for cached brand data before the API performs a hard + # refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms) + # are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1 + # year. + max_age_ms: nil, # Optional parameter to optimize the API call for maximum speed. When set to true, # the API will skip time-consuming operations for faster response at the cost of # less comprehensive data. @@ -328,6 +358,7 @@ module BrandDev sig do params( domain: String, + max_age_ms: Integer, timeout_ms: Integer, request_options: BrandDev::RequestOptions::OrHash ).returns(BrandDev::Models::BrandRetrieveSimplifiedResponse) @@ -335,6 +366,11 @@ module BrandDev def retrieve_simplified( # Domain name to retrieve simplified brand data for domain:, + # Maximum age in milliseconds for cached brand data before the API performs a hard + # refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms) + # are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1 + # year. + max_age_ms: nil, # Optional timeout in milliseconds for the request. If the request takes longer # than this value, it will be aborted with a 408 status code. Maximum allowed # value is 300000ms (5 minutes). diff --git a/sig/brand_dev/models/brand_retrieve_by_email_params.rbs b/sig/brand_dev/models/brand_retrieve_by_email_params.rbs index ad9f83f..f53aaf3 100644 --- a/sig/brand_dev/models/brand_retrieve_by_email_params.rbs +++ b/sig/brand_dev/models/brand_retrieve_by_email_params.rbs @@ -4,6 +4,7 @@ module BrandDev { email: String, force_language: BrandDev::Models::BrandRetrieveByEmailParams::force_language, + max_age_ms: Integer, max_speed: bool, timeout_ms: Integer } @@ -21,6 +22,10 @@ module BrandDev BrandDev::Models::BrandRetrieveByEmailParams::force_language ) -> BrandDev::Models::BrandRetrieveByEmailParams::force_language + attr_reader max_age_ms: Integer? + + def max_age_ms=: (Integer) -> Integer + attr_reader max_speed: bool? def max_speed=: (bool) -> bool @@ -32,6 +37,7 @@ module BrandDev def initialize: ( email: String, ?force_language: BrandDev::Models::BrandRetrieveByEmailParams::force_language, + ?max_age_ms: Integer, ?max_speed: bool, ?timeout_ms: Integer, ?request_options: BrandDev::request_opts @@ -40,6 +46,7 @@ module BrandDev def to_hash: -> { email: String, force_language: BrandDev::Models::BrandRetrieveByEmailParams::force_language, + max_age_ms: Integer, max_speed: bool, timeout_ms: Integer, request_options: BrandDev::RequestOptions diff --git a/sig/brand_dev/models/brand_retrieve_by_isin_params.rbs b/sig/brand_dev/models/brand_retrieve_by_isin_params.rbs index 1cf77c0..8b4466c 100644 --- a/sig/brand_dev/models/brand_retrieve_by_isin_params.rbs +++ b/sig/brand_dev/models/brand_retrieve_by_isin_params.rbs @@ -4,6 +4,7 @@ module BrandDev { isin: String, force_language: BrandDev::Models::BrandRetrieveByIsinParams::force_language, + max_age_ms: Integer, max_speed: bool, timeout_ms: Integer } @@ -21,6 +22,10 @@ module BrandDev BrandDev::Models::BrandRetrieveByIsinParams::force_language ) -> BrandDev::Models::BrandRetrieveByIsinParams::force_language + attr_reader max_age_ms: Integer? + + def max_age_ms=: (Integer) -> Integer + attr_reader max_speed: bool? def max_speed=: (bool) -> bool @@ -32,6 +37,7 @@ module BrandDev def initialize: ( isin: String, ?force_language: BrandDev::Models::BrandRetrieveByIsinParams::force_language, + ?max_age_ms: Integer, ?max_speed: bool, ?timeout_ms: Integer, ?request_options: BrandDev::request_opts @@ -40,6 +46,7 @@ module BrandDev def to_hash: -> { isin: String, force_language: BrandDev::Models::BrandRetrieveByIsinParams::force_language, + max_age_ms: Integer, max_speed: bool, timeout_ms: Integer, request_options: BrandDev::RequestOptions diff --git a/sig/brand_dev/models/brand_retrieve_by_name_params.rbs b/sig/brand_dev/models/brand_retrieve_by_name_params.rbs index 72d2c91..f5f75d0 100644 --- a/sig/brand_dev/models/brand_retrieve_by_name_params.rbs +++ b/sig/brand_dev/models/brand_retrieve_by_name_params.rbs @@ -5,6 +5,7 @@ module BrandDev name: String, country_gl: BrandDev::Models::BrandRetrieveByNameParams::country_gl, force_language: BrandDev::Models::BrandRetrieveByNameParams::force_language, + max_age_ms: Integer, max_speed: bool, timeout_ms: Integer } @@ -28,6 +29,10 @@ module BrandDev BrandDev::Models::BrandRetrieveByNameParams::force_language ) -> BrandDev::Models::BrandRetrieveByNameParams::force_language + attr_reader max_age_ms: Integer? + + def max_age_ms=: (Integer) -> Integer + attr_reader max_speed: bool? def max_speed=: (bool) -> bool @@ -40,6 +45,7 @@ module BrandDev name: String, ?country_gl: BrandDev::Models::BrandRetrieveByNameParams::country_gl, ?force_language: BrandDev::Models::BrandRetrieveByNameParams::force_language, + ?max_age_ms: Integer, ?max_speed: bool, ?timeout_ms: Integer, ?request_options: BrandDev::request_opts @@ -49,6 +55,7 @@ module BrandDev name: String, country_gl: BrandDev::Models::BrandRetrieveByNameParams::country_gl, force_language: BrandDev::Models::BrandRetrieveByNameParams::force_language, + max_age_ms: Integer, max_speed: bool, timeout_ms: Integer, request_options: BrandDev::RequestOptions diff --git a/sig/brand_dev/models/brand_retrieve_by_ticker_params.rbs b/sig/brand_dev/models/brand_retrieve_by_ticker_params.rbs index ec896ee..9cbb459 100644 --- a/sig/brand_dev/models/brand_retrieve_by_ticker_params.rbs +++ b/sig/brand_dev/models/brand_retrieve_by_ticker_params.rbs @@ -4,6 +4,7 @@ module BrandDev { ticker: String, force_language: BrandDev::Models::BrandRetrieveByTickerParams::force_language, + max_age_ms: Integer, max_speed: bool, ticker_exchange: BrandDev::Models::BrandRetrieveByTickerParams::ticker_exchange, timeout_ms: Integer @@ -22,6 +23,10 @@ module BrandDev BrandDev::Models::BrandRetrieveByTickerParams::force_language ) -> BrandDev::Models::BrandRetrieveByTickerParams::force_language + attr_reader max_age_ms: Integer? + + def max_age_ms=: (Integer) -> Integer + attr_reader max_speed: bool? def max_speed=: (bool) -> bool @@ -39,6 +44,7 @@ module BrandDev def initialize: ( ticker: String, ?force_language: BrandDev::Models::BrandRetrieveByTickerParams::force_language, + ?max_age_ms: Integer, ?max_speed: bool, ?ticker_exchange: BrandDev::Models::BrandRetrieveByTickerParams::ticker_exchange, ?timeout_ms: Integer, @@ -48,6 +54,7 @@ module BrandDev def to_hash: -> { ticker: String, force_language: BrandDev::Models::BrandRetrieveByTickerParams::force_language, + max_age_ms: Integer, max_speed: bool, ticker_exchange: BrandDev::Models::BrandRetrieveByTickerParams::ticker_exchange, timeout_ms: Integer, diff --git a/sig/brand_dev/models/brand_retrieve_params.rbs b/sig/brand_dev/models/brand_retrieve_params.rbs index 83c2d02..74a3500 100644 --- a/sig/brand_dev/models/brand_retrieve_params.rbs +++ b/sig/brand_dev/models/brand_retrieve_params.rbs @@ -4,6 +4,7 @@ module BrandDev { domain: String, force_language: BrandDev::Models::BrandRetrieveParams::force_language, + max_age_ms: Integer, max_speed: bool, timeout_ms: Integer } @@ -21,6 +22,10 @@ module BrandDev BrandDev::Models::BrandRetrieveParams::force_language ) -> BrandDev::Models::BrandRetrieveParams::force_language + attr_reader max_age_ms: Integer? + + def max_age_ms=: (Integer) -> Integer + attr_reader max_speed: bool? def max_speed=: (bool) -> bool @@ -32,6 +37,7 @@ module BrandDev def initialize: ( domain: String, ?force_language: BrandDev::Models::BrandRetrieveParams::force_language, + ?max_age_ms: Integer, ?max_speed: bool, ?timeout_ms: Integer, ?request_options: BrandDev::request_opts @@ -40,6 +46,7 @@ module BrandDev def to_hash: -> { domain: String, force_language: BrandDev::Models::BrandRetrieveParams::force_language, + max_age_ms: Integer, max_speed: bool, timeout_ms: Integer, request_options: BrandDev::RequestOptions diff --git a/sig/brand_dev/models/brand_retrieve_simplified_params.rbs b/sig/brand_dev/models/brand_retrieve_simplified_params.rbs index 113778d..8720f7c 100644 --- a/sig/brand_dev/models/brand_retrieve_simplified_params.rbs +++ b/sig/brand_dev/models/brand_retrieve_simplified_params.rbs @@ -1,7 +1,7 @@ module BrandDev module Models type brand_retrieve_simplified_params = - { domain: String, timeout_ms: Integer } + { domain: String, max_age_ms: Integer, timeout_ms: Integer } & BrandDev::Internal::Type::request_parameters class BrandRetrieveSimplifiedParams < BrandDev::Internal::Type::BaseModel @@ -10,18 +10,24 @@ module BrandDev attr_accessor domain: String + attr_reader max_age_ms: Integer? + + def max_age_ms=: (Integer) -> Integer + attr_reader timeout_ms: Integer? def timeout_ms=: (Integer) -> Integer def initialize: ( domain: String, + ?max_age_ms: Integer, ?timeout_ms: Integer, ?request_options: BrandDev::request_opts ) -> void def to_hash: -> { domain: String, + max_age_ms: Integer, timeout_ms: Integer, request_options: BrandDev::RequestOptions } diff --git a/sig/brand_dev/resources/brand.rbs b/sig/brand_dev/resources/brand.rbs index ed97ac9..496ec4d 100644 --- a/sig/brand_dev/resources/brand.rbs +++ b/sig/brand_dev/resources/brand.rbs @@ -4,6 +4,7 @@ module BrandDev def retrieve: ( domain: String, ?force_language: BrandDev::Models::BrandRetrieveParams::force_language, + ?max_age_ms: Integer, ?max_speed: bool, ?timeout_ms: Integer, ?request_options: BrandDev::request_opts @@ -57,6 +58,7 @@ module BrandDev def retrieve_by_email: ( email: String, ?force_language: BrandDev::Models::BrandRetrieveByEmailParams::force_language, + ?max_age_ms: Integer, ?max_speed: bool, ?timeout_ms: Integer, ?request_options: BrandDev::request_opts @@ -65,6 +67,7 @@ module BrandDev def retrieve_by_isin: ( isin: String, ?force_language: BrandDev::Models::BrandRetrieveByIsinParams::force_language, + ?max_age_ms: Integer, ?max_speed: bool, ?timeout_ms: Integer, ?request_options: BrandDev::request_opts @@ -74,6 +77,7 @@ module BrandDev name: String, ?country_gl: BrandDev::Models::BrandRetrieveByNameParams::country_gl, ?force_language: BrandDev::Models::BrandRetrieveByNameParams::force_language, + ?max_age_ms: Integer, ?max_speed: bool, ?timeout_ms: Integer, ?request_options: BrandDev::request_opts @@ -82,6 +86,7 @@ module BrandDev def retrieve_by_ticker: ( ticker: String, ?force_language: BrandDev::Models::BrandRetrieveByTickerParams::force_language, + ?max_age_ms: Integer, ?max_speed: bool, ?ticker_exchange: BrandDev::Models::BrandRetrieveByTickerParams::ticker_exchange, ?timeout_ms: Integer, @@ -90,6 +95,7 @@ module BrandDev def retrieve_simplified: ( domain: String, + ?max_age_ms: Integer, ?timeout_ms: Integer, ?request_options: BrandDev::request_opts ) -> BrandDev::Models::BrandRetrieveSimplifiedResponse From a11472b4b6789dd31ef45a456f70e2a176477a96 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 7 May 2026 02:27:19 +0000 Subject: [PATCH 43/82] codegen metadata --- .stats.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.stats.yml b/.stats.yml index 399384d..4178b18 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 16 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-e299f3a9f343788f804eb0f7d71c609bf811bea363547ead01482e54612c3b37.yml -openapi_spec_hash: 4d17210ddd28eca4c39f89e5b864d066 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-084a13c80f616458adab7dd3da1df26c7b18002770bf0c866a61fbde2ab5a1e2.yml +openapi_spec_hash: e7b22a44a4023bc6a89508368636b3a6 config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 From 2a47d733b2de2acd65d6bc262833f4474f76a48f Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 7 May 2026 03:01:51 +0000 Subject: [PATCH 44/82] feat(api): api update --- .stats.yml | 4 +-- .../models/brand_ai_product_params.rb | 7 ++--- .../models/brand_ai_products_params.rb | 14 +++++----- .../models/brand_web_scrape_html_params.rb | 12 ++++++++- .../models/brand_web_scrape_images_params.rb | 12 ++++++++- .../models/brand_web_scrape_md_params.rb | 12 ++++++++- .../models/brand_web_scrape_sitemap_params.rb | 12 ++++++++- lib/brand_dev/resources/brand.rb | 26 +++++++++++++------ .../models/brand_ai_product_params.rbi | 10 ++++--- .../models/brand_ai_products_params.rbi | 20 ++++++++------ .../models/brand_web_scrape_html_params.rbi | 15 +++++++++++ .../models/brand_web_scrape_images_params.rbi | 15 +++++++++++ .../models/brand_web_scrape_md_params.rbi | 15 +++++++++++ .../brand_web_scrape_sitemap_params.rbi | 15 +++++++++++ rbi/brand_dev/resources/brand.rbi | 25 ++++++++++++++++-- .../models/brand_web_scrape_html_params.rbs | 9 ++++++- .../models/brand_web_scrape_images_params.rbs | 9 ++++++- .../models/brand_web_scrape_md_params.rbs | 7 +++++ .../brand_web_scrape_sitemap_params.rbs | 13 +++++++++- sig/brand_dev/resources/brand.rbs | 4 +++ 20 files changed, 216 insertions(+), 40 deletions(-) diff --git a/.stats.yml b/.stats.yml index 4178b18..3647616 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 16 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-084a13c80f616458adab7dd3da1df26c7b18002770bf0c866a61fbde2ab5a1e2.yml -openapi_spec_hash: e7b22a44a4023bc6a89508368636b3a6 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-f930a89f5fccd44dd6548fce8ae69ab2d966dd10a3e3dfa128a8894089a34d1a.yml +openapi_spec_hash: d21ebf5fac677f08d74a9153fb57f9af config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 diff --git a/lib/brand_dev/models/brand_ai_product_params.rb b/lib/brand_dev/models/brand_ai_product_params.rb index cdd12ce..a25c685 100644 --- a/lib/brand_dev/models/brand_ai_product_params.rb +++ b/lib/brand_dev/models/brand_ai_product_params.rb @@ -22,8 +22,9 @@ class BrandAIProductParams < BrandDev::Internal::Type::BaseModel optional :max_age_ms, Integer, api_name: :maxAgeMs # @!attribute timeout_ms - # Optional timeout in milliseconds for the request. Maximum allowed value is - # 300000ms (5 minutes). + # Optional timeout in milliseconds for the request. If the request takes longer + # than this value, it will be aborted with a 408 status code. Maximum allowed + # value is 300000ms (5 minutes). # # @return [Integer, nil] optional :timeout_ms, Integer, api_name: :timeoutMS @@ -36,7 +37,7 @@ class BrandAIProductParams < BrandDev::Internal::Type::BaseModel # # @param max_age_ms [Integer] Return a cached result if a prior scrape for the same parameters exists and is y # - # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. Maximum allowed value is 30000 + # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th # # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}] end diff --git a/lib/brand_dev/models/brand_ai_products_params.rb b/lib/brand_dev/models/brand_ai_products_params.rb index 332de91..20399b4 100644 --- a/lib/brand_dev/models/brand_ai_products_params.rb +++ b/lib/brand_dev/models/brand_ai_products_params.rb @@ -45,8 +45,9 @@ class ByDomain < BrandDev::Internal::Type::BaseModel optional :max_products, Integer, api_name: :maxProducts # @!attribute timeout_ms - # Optional timeout in milliseconds for the request. Maximum allowed value is - # 300000ms (5 minutes). + # Optional timeout in milliseconds for the request. If the request takes longer + # than this value, it will be aborted with a 408 status code. Maximum allowed + # value is 300000ms (5 minutes). # # @return [Integer, nil] optional :timeout_ms, Integer, api_name: :timeoutMS @@ -61,7 +62,7 @@ class ByDomain < BrandDev::Internal::Type::BaseModel # # @param max_products [Integer] Maximum number of products to extract. # - # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. Maximum allowed value is 30000 + # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th end class ByDirectURL < BrandDev::Internal::Type::BaseModel @@ -87,8 +88,9 @@ class ByDirectURL < BrandDev::Internal::Type::BaseModel optional :max_products, Integer, api_name: :maxProducts # @!attribute timeout_ms - # Optional timeout in milliseconds for the request. Maximum allowed value is - # 300000ms (5 minutes). + # Optional timeout in milliseconds for the request. If the request takes longer + # than this value, it will be aborted with a 408 status code. Maximum allowed + # value is 300000ms (5 minutes). # # @return [Integer, nil] optional :timeout_ms, Integer, api_name: :timeoutMS @@ -103,7 +105,7 @@ class ByDirectURL < BrandDev::Internal::Type::BaseModel # # @param max_products [Integer] Maximum number of products to extract. # - # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. Maximum allowed value is 30000 + # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th end # @!method self.variants diff --git a/lib/brand_dev/models/brand_web_scrape_html_params.rb b/lib/brand_dev/models/brand_web_scrape_html_params.rb index 01115b5..2b7e73b 100644 --- a/lib/brand_dev/models/brand_web_scrape_html_params.rb +++ b/lib/brand_dev/models/brand_web_scrape_html_params.rb @@ -35,7 +35,15 @@ class BrandWebScrapeHTMLParams < BrandDev::Internal::Type::BaseModel # @return [Boolean, nil] optional :parse_pdf, BrandDev::Internal::Type::Boolean - # @!method initialize(url:, include_frames: nil, max_age_ms: nil, parse_pdf: nil, request_options: {}) + # @!attribute timeout_ms + # Optional timeout in milliseconds for the request. If the request takes longer + # than this value, it will be aborted with a 408 status code. Maximum allowed + # value is 300000ms (5 minutes). + # + # @return [Integer, nil] + optional :timeout_ms, Integer + + # @!method initialize(url:, include_frames: nil, max_age_ms: nil, parse_pdf: nil, timeout_ms: nil, request_options: {}) # Some parameter documentations has been truncated, see # {BrandDev::Models::BrandWebScrapeHTMLParams} for more details. # @@ -47,6 +55,8 @@ class BrandWebScrapeHTMLParams < BrandDev::Internal::Type::BaseModel # # @param parse_pdf [Boolean] When true (default), PDF URLs are fetched and their text layer is extracted and # + # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th + # # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/brand_dev/models/brand_web_scrape_images_params.rb b/lib/brand_dev/models/brand_web_scrape_images_params.rb index f23863c..99bb317 100644 --- a/lib/brand_dev/models/brand_web_scrape_images_params.rb +++ b/lib/brand_dev/models/brand_web_scrape_images_params.rb @@ -27,7 +27,15 @@ class BrandWebScrapeImagesParams < BrandDev::Internal::Type::BaseModel # @return [Integer, nil] optional :max_age_ms, Integer - # @!method initialize(url:, enrichment: nil, max_age_ms: nil, request_options: {}) + # @!attribute timeout_ms + # Optional timeout in milliseconds for the request. If the request takes longer + # than this value, it will be aborted with a 408 status code. Maximum allowed + # value is 300000ms (5 minutes). + # + # @return [Integer, nil] + optional :timeout_ms, Integer + + # @!method initialize(url:, enrichment: nil, max_age_ms: nil, timeout_ms: nil, request_options: {}) # Some parameter documentations has been truncated, see # {BrandDev::Models::BrandWebScrapeImagesParams} for more details. # @@ -37,6 +45,8 @@ class BrandWebScrapeImagesParams < BrandDev::Internal::Type::BaseModel # # @param max_age_ms [Integer] Reuse a cached result this many milliseconds old or newer. Default: 86400000 (1 # + # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th + # # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}] class Enrichment < BrandDev::Internal::Type::BaseModel diff --git a/lib/brand_dev/models/brand_web_scrape_md_params.rb b/lib/brand_dev/models/brand_web_scrape_md_params.rb index 2d23939..72edf09 100644 --- a/lib/brand_dev/models/brand_web_scrape_md_params.rb +++ b/lib/brand_dev/models/brand_web_scrape_md_params.rb @@ -54,6 +54,14 @@ class BrandWebScrapeMdParams < BrandDev::Internal::Type::BaseModel # @return [Boolean, nil] optional :shorten_base64_images, BrandDev::Internal::Type::Boolean + # @!attribute timeout_ms + # Optional timeout in milliseconds for the request. If the request takes longer + # than this value, it will be aborted with a 408 status code. Maximum allowed + # value is 300000ms (5 minutes). + # + # @return [Integer, nil] + optional :timeout_ms, Integer + # @!attribute use_main_content_only # Extract only the main content of the page, excluding headers, footers, sidebars, # and navigation @@ -61,7 +69,7 @@ class BrandWebScrapeMdParams < BrandDev::Internal::Type::BaseModel # @return [Boolean, nil] optional :use_main_content_only, BrandDev::Internal::Type::Boolean - # @!method initialize(url:, include_frames: nil, include_images: nil, include_links: nil, max_age_ms: nil, parse_pdf: nil, shorten_base64_images: nil, use_main_content_only: nil, request_options: {}) + # @!method initialize(url:, include_frames: nil, include_images: nil, include_links: nil, max_age_ms: nil, parse_pdf: nil, shorten_base64_images: nil, timeout_ms: nil, use_main_content_only: nil, request_options: {}) # Some parameter documentations has been truncated, see # {BrandDev::Models::BrandWebScrapeMdParams} for more details. # @@ -79,6 +87,8 @@ class BrandWebScrapeMdParams < BrandDev::Internal::Type::BaseModel # # @param shorten_base64_images [Boolean] Shorten base64-encoded image data in the Markdown output # + # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th + # # @param use_main_content_only [Boolean] Extract only the main content of the page, excluding headers, footers, sidebars, # # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}] diff --git a/lib/brand_dev/models/brand_web_scrape_sitemap_params.rb b/lib/brand_dev/models/brand_web_scrape_sitemap_params.rb index 07e2e2c..39a13fb 100644 --- a/lib/brand_dev/models/brand_web_scrape_sitemap_params.rb +++ b/lib/brand_dev/models/brand_web_scrape_sitemap_params.rb @@ -20,6 +20,14 @@ class BrandWebScrapeSitemapParams < BrandDev::Internal::Type::BaseModel # @return [Integer, nil] optional :max_links, Integer + # @!attribute timeout_ms + # Optional timeout in milliseconds for the request. If the request takes longer + # than this value, it will be aborted with a 408 status code. Maximum allowed + # value is 300000ms (5 minutes). + # + # @return [Integer, nil] + optional :timeout_ms, Integer + # @!attribute url_regex # Optional RE2-compatible regex pattern. Only URLs matching this pattern are # returned and counted against maxLinks. @@ -27,7 +35,7 @@ class BrandWebScrapeSitemapParams < BrandDev::Internal::Type::BaseModel # @return [String, nil] optional :url_regex, String - # @!method initialize(domain:, max_links: nil, url_regex: nil, request_options: {}) + # @!method initialize(domain:, max_links: nil, timeout_ms: nil, url_regex: nil, request_options: {}) # Some parameter documentations has been truncated, see # {BrandDev::Models::BrandWebScrapeSitemapParams} for more details. # @@ -35,6 +43,8 @@ class BrandWebScrapeSitemapParams < BrandDev::Internal::Type::BaseModel # # @param max_links [Integer] Maximum number of links to return from the sitemap crawl. Defaults to 10,000. Mi # + # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th + # # @param url_regex [String] Optional RE2-compatible regex pattern. Only URLs matching this pattern are retur # # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}] diff --git a/lib/brand_dev/resources/brand.rb b/lib/brand_dev/resources/brand.rb index b7f8647..5b37fa0 100644 --- a/lib/brand_dev/resources/brand.rb +++ b/lib/brand_dev/resources/brand.rb @@ -50,7 +50,7 @@ def retrieve(params) # # @param max_age_ms [Integer] Return a cached result if a prior scrape for the same parameters exists and is y # - # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. Maximum allowed value is 30000 + # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th # # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}, nil] # @@ -405,7 +405,7 @@ def retrieve_simplified(params) # # Scrapes the given URL and returns the raw HTML content of the page. # - # @overload web_scrape_html(url:, include_frames: nil, max_age_ms: nil, parse_pdf: nil, request_options: {}) + # @overload web_scrape_html(url:, include_frames: nil, max_age_ms: nil, parse_pdf: nil, timeout_ms: nil, request_options: {}) # # @param url [String] Full URL to scrape (must include http:// or https:// protocol) # @@ -415,6 +415,8 @@ def retrieve_simplified(params) # # @param parse_pdf [Boolean] When true (default), PDF URLs are fetched and their text layer is extracted and # + # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th + # # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [BrandDev::Models::BrandWebScrapeHTMLResponse] @@ -429,7 +431,8 @@ def web_scrape_html(params) query: query.transform_keys( include_frames: "includeFrames", max_age_ms: "maxAgeMs", - parse_pdf: "parsePDF" + parse_pdf: "parsePDF", + timeout_ms: "timeoutMS" ), model: BrandDev::Models::BrandWebScrapeHTMLResponse, options: options @@ -444,7 +447,7 @@ def web_scrape_html(params) # embeds. The base request costs 1 credit; enrichment costs 1 credit per returned # image. # - # @overload web_scrape_images(url:, enrichment: nil, max_age_ms: nil, request_options: {}) + # @overload web_scrape_images(url:, enrichment: nil, max_age_ms: nil, timeout_ms: nil, request_options: {}) # # @param url [String] Page URL to inspect. Must include http:// or https://. # @@ -452,6 +455,8 @@ def web_scrape_html(params) # # @param max_age_ms [Integer] Reuse a cached result this many milliseconds old or newer. Default: 86400000 (1 # + # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th + # # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [BrandDev::Models::BrandWebScrapeImagesResponse] @@ -463,7 +468,7 @@ def web_scrape_images(params) @client.request( method: :get, path: "web/scrape/images", - query: query.transform_keys(max_age_ms: "maxAgeMs"), + query: query.transform_keys(max_age_ms: "maxAgeMs", timeout_ms: "timeoutMS"), model: BrandDev::Models::BrandWebScrapeImagesResponse, options: options ) @@ -474,7 +479,7 @@ def web_scrape_images(params) # # Scrapes the given URL into LLM usable Markdown. # - # @overload web_scrape_md(url:, include_frames: nil, include_images: nil, include_links: nil, max_age_ms: nil, parse_pdf: nil, shorten_base64_images: nil, use_main_content_only: nil, request_options: {}) + # @overload web_scrape_md(url:, include_frames: nil, include_images: nil, include_links: nil, max_age_ms: nil, parse_pdf: nil, shorten_base64_images: nil, timeout_ms: nil, use_main_content_only: nil, request_options: {}) # # @param url [String] Full URL to scrape into LLM usable Markdown (must include http:// or https:// pr # @@ -490,6 +495,8 @@ def web_scrape_images(params) # # @param shorten_base64_images [Boolean] Shorten base64-encoded image data in the Markdown output # + # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th + # # @param use_main_content_only [Boolean] Extract only the main content of the page, excluding headers, footers, sidebars, # # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}, nil] @@ -510,6 +517,7 @@ def web_scrape_md(params) max_age_ms: "maxAgeMs", parse_pdf: "parsePDF", shorten_base64_images: "shortenBase64Images", + timeout_ms: "timeoutMS", use_main_content_only: "useMainContentOnly" ), model: BrandDev::Models::BrandWebScrapeMdResponse, @@ -522,12 +530,14 @@ def web_scrape_md(params) # # Crawl an entire website's sitemap and return all discovered page URLs. # - # @overload web_scrape_sitemap(domain:, max_links: nil, url_regex: nil, request_options: {}) + # @overload web_scrape_sitemap(domain:, max_links: nil, timeout_ms: nil, url_regex: nil, request_options: {}) # # @param domain [String] Domain to build a sitemap for # # @param max_links [Integer] Maximum number of links to return from the sitemap crawl. Defaults to 10,000. Mi # + # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th + # # @param url_regex [String] Optional RE2-compatible regex pattern. Only URLs matching this pattern are retur # # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}, nil] @@ -541,7 +551,7 @@ def web_scrape_sitemap(params) @client.request( method: :get, path: "web/scrape/sitemap", - query: query.transform_keys(max_links: "maxLinks", url_regex: "urlRegex"), + query: query.transform_keys(max_links: "maxLinks", timeout_ms: "timeoutMS", url_regex: "urlRegex"), model: BrandDev::Models::BrandWebScrapeSitemapResponse, options: options ) diff --git a/rbi/brand_dev/models/brand_ai_product_params.rbi b/rbi/brand_dev/models/brand_ai_product_params.rbi index e7c48bb..028c18b 100644 --- a/rbi/brand_dev/models/brand_ai_product_params.rbi +++ b/rbi/brand_dev/models/brand_ai_product_params.rbi @@ -24,8 +24,9 @@ module BrandDev sig { params(max_age_ms: Integer).void } attr_writer :max_age_ms - # Optional timeout in milliseconds for the request. Maximum allowed value is - # 300000ms (5 minutes). + # Optional timeout in milliseconds for the request. If the request takes longer + # than this value, it will be aborted with a 408 status code. Maximum allowed + # value is 300000ms (5 minutes). sig { returns(T.nilable(Integer)) } attr_reader :timeout_ms @@ -47,8 +48,9 @@ module BrandDev # younger than this many milliseconds. Defaults to 7 days (604800000 ms) when # omitted. Max is 30 days (2592000000 ms). Set to 0 to always scrape fresh. max_age_ms: nil, - # Optional timeout in milliseconds for the request. Maximum allowed value is - # 300000ms (5 minutes). + # Optional timeout in milliseconds for the request. If the request takes longer + # than this value, it will be aborted with a 408 status code. Maximum allowed + # value is 300000ms (5 minutes). timeout_ms: nil, request_options: {} ) diff --git a/rbi/brand_dev/models/brand_ai_products_params.rbi b/rbi/brand_dev/models/brand_ai_products_params.rbi index 8f8cefd..421447c 100644 --- a/rbi/brand_dev/models/brand_ai_products_params.rbi +++ b/rbi/brand_dev/models/brand_ai_products_params.rbi @@ -89,8 +89,9 @@ module BrandDev sig { params(max_products: Integer).void } attr_writer :max_products - # Optional timeout in milliseconds for the request. Maximum allowed value is - # 300000ms (5 minutes). + # Optional timeout in milliseconds for the request. If the request takes longer + # than this value, it will be aborted with a 408 status code. Maximum allowed + # value is 300000ms (5 minutes). sig { returns(T.nilable(Integer)) } attr_reader :timeout_ms @@ -114,8 +115,9 @@ module BrandDev max_age_ms: nil, # Maximum number of products to extract. max_products: nil, - # Optional timeout in milliseconds for the request. Maximum allowed value is - # 300000ms (5 minutes). + # Optional timeout in milliseconds for the request. If the request takes longer + # than this value, it will be aborted with a 408 status code. Maximum allowed + # value is 300000ms (5 minutes). timeout_ms: nil ) end @@ -164,8 +166,9 @@ module BrandDev sig { params(max_products: Integer).void } attr_writer :max_products - # Optional timeout in milliseconds for the request. Maximum allowed value is - # 300000ms (5 minutes). + # Optional timeout in milliseconds for the request. If the request takes longer + # than this value, it will be aborted with a 408 status code. Maximum allowed + # value is 300000ms (5 minutes). sig { returns(T.nilable(Integer)) } attr_reader :timeout_ms @@ -190,8 +193,9 @@ module BrandDev max_age_ms: nil, # Maximum number of products to extract. max_products: nil, - # Optional timeout in milliseconds for the request. Maximum allowed value is - # 300000ms (5 minutes). + # Optional timeout in milliseconds for the request. If the request takes longer + # than this value, it will be aborted with a 408 status code. Maximum allowed + # value is 300000ms (5 minutes). timeout_ms: nil ) end diff --git a/rbi/brand_dev/models/brand_web_scrape_html_params.rbi b/rbi/brand_dev/models/brand_web_scrape_html_params.rbi index 3a9b60e..610523b 100644 --- a/rbi/brand_dev/models/brand_web_scrape_html_params.rbi +++ b/rbi/brand_dev/models/brand_web_scrape_html_params.rbi @@ -40,12 +40,22 @@ module BrandDev sig { params(parse_pdf: T::Boolean).void } attr_writer :parse_pdf + # Optional timeout in milliseconds for the request. If the request takes longer + # than this value, it will be aborted with a 408 status code. Maximum allowed + # value is 300000ms (5 minutes). + sig { returns(T.nilable(Integer)) } + attr_reader :timeout_ms + + sig { params(timeout_ms: Integer).void } + attr_writer :timeout_ms + sig do params( url: String, include_frames: T::Boolean, max_age_ms: Integer, parse_pdf: T::Boolean, + timeout_ms: Integer, request_options: BrandDev::RequestOptions::OrHash ).returns(T.attached_class) end @@ -62,6 +72,10 @@ module BrandDev # returned wrapped in …. When false, PDF URLs are skipped # and a 400 WEBSITE_ACCESS_ERROR is returned. parse_pdf: nil, + # Optional timeout in milliseconds for the request. If the request takes longer + # than this value, it will be aborted with a 408 status code. Maximum allowed + # value is 300000ms (5 minutes). + timeout_ms: nil, request_options: {} ) end @@ -73,6 +87,7 @@ module BrandDev include_frames: T::Boolean, max_age_ms: Integer, parse_pdf: T::Boolean, + timeout_ms: Integer, request_options: BrandDev::RequestOptions } ) diff --git a/rbi/brand_dev/models/brand_web_scrape_images_params.rbi b/rbi/brand_dev/models/brand_web_scrape_images_params.rbi index b73e330..2aca4e2 100644 --- a/rbi/brand_dev/models/brand_web_scrape_images_params.rbi +++ b/rbi/brand_dev/models/brand_web_scrape_images_params.rbi @@ -40,11 +40,21 @@ module BrandDev sig { params(max_age_ms: Integer).void } attr_writer :max_age_ms + # Optional timeout in milliseconds for the request. If the request takes longer + # than this value, it will be aborted with a 408 status code. Maximum allowed + # value is 300000ms (5 minutes). + sig { returns(T.nilable(Integer)) } + attr_reader :timeout_ms + + sig { params(timeout_ms: Integer).void } + attr_writer :timeout_ms + sig do params( url: String, enrichment: BrandDev::BrandWebScrapeImagesParams::Enrichment::OrHash, max_age_ms: Integer, + timeout_ms: Integer, request_options: BrandDev::RequestOptions::OrHash ).returns(T.attached_class) end @@ -57,6 +67,10 @@ module BrandDev # Reuse a cached result this many milliseconds old or newer. Default: 86400000 (1 # day). Set to 0 to bypass cache. Maximum: 2592000000 (30 days). max_age_ms: nil, + # Optional timeout in milliseconds for the request. If the request takes longer + # than this value, it will be aborted with a 408 status code. Maximum allowed + # value is 300000ms (5 minutes). + timeout_ms: nil, request_options: {} ) end @@ -67,6 +81,7 @@ module BrandDev url: String, enrichment: BrandDev::BrandWebScrapeImagesParams::Enrichment, max_age_ms: Integer, + timeout_ms: Integer, request_options: BrandDev::RequestOptions } ) diff --git a/rbi/brand_dev/models/brand_web_scrape_md_params.rbi b/rbi/brand_dev/models/brand_web_scrape_md_params.rbi index ce90801..b7c2086 100644 --- a/rbi/brand_dev/models/brand_web_scrape_md_params.rbi +++ b/rbi/brand_dev/models/brand_web_scrape_md_params.rbi @@ -62,6 +62,15 @@ module BrandDev sig { params(shorten_base64_images: T::Boolean).void } attr_writer :shorten_base64_images + # Optional timeout in milliseconds for the request. If the request takes longer + # than this value, it will be aborted with a 408 status code. Maximum allowed + # value is 300000ms (5 minutes). + sig { returns(T.nilable(Integer)) } + attr_reader :timeout_ms + + sig { params(timeout_ms: Integer).void } + attr_writer :timeout_ms + # Extract only the main content of the page, excluding headers, footers, sidebars, # and navigation sig { returns(T.nilable(T::Boolean)) } @@ -79,6 +88,7 @@ module BrandDev max_age_ms: Integer, parse_pdf: T::Boolean, shorten_base64_images: T::Boolean, + timeout_ms: Integer, use_main_content_only: T::Boolean, request_options: BrandDev::RequestOptions::OrHash ).returns(T.attached_class) @@ -103,6 +113,10 @@ module BrandDev parse_pdf: nil, # Shorten base64-encoded image data in the Markdown output shorten_base64_images: nil, + # Optional timeout in milliseconds for the request. If the request takes longer + # than this value, it will be aborted with a 408 status code. Maximum allowed + # value is 300000ms (5 minutes). + timeout_ms: nil, # Extract only the main content of the page, excluding headers, footers, sidebars, # and navigation use_main_content_only: nil, @@ -120,6 +134,7 @@ module BrandDev max_age_ms: Integer, parse_pdf: T::Boolean, shorten_base64_images: T::Boolean, + timeout_ms: Integer, use_main_content_only: T::Boolean, request_options: BrandDev::RequestOptions } diff --git a/rbi/brand_dev/models/brand_web_scrape_sitemap_params.rbi b/rbi/brand_dev/models/brand_web_scrape_sitemap_params.rbi index 58ba807..6af0348 100644 --- a/rbi/brand_dev/models/brand_web_scrape_sitemap_params.rbi +++ b/rbi/brand_dev/models/brand_web_scrape_sitemap_params.rbi @@ -26,6 +26,15 @@ module BrandDev sig { params(max_links: Integer).void } attr_writer :max_links + # Optional timeout in milliseconds for the request. If the request takes longer + # than this value, it will be aborted with a 408 status code. Maximum allowed + # value is 300000ms (5 minutes). + sig { returns(T.nilable(Integer)) } + attr_reader :timeout_ms + + sig { params(timeout_ms: Integer).void } + attr_writer :timeout_ms + # Optional RE2-compatible regex pattern. Only URLs matching this pattern are # returned and counted against maxLinks. sig { returns(T.nilable(String)) } @@ -38,6 +47,7 @@ module BrandDev params( domain: String, max_links: Integer, + timeout_ms: Integer, url_regex: String, request_options: BrandDev::RequestOptions::OrHash ).returns(T.attached_class) @@ -48,6 +58,10 @@ module BrandDev # Maximum number of links to return from the sitemap crawl. Defaults to 10,000. # Minimum is 1, maximum is 100,000. max_links: nil, + # Optional timeout in milliseconds for the request. If the request takes longer + # than this value, it will be aborted with a 408 status code. Maximum allowed + # value is 300000ms (5 minutes). + timeout_ms: nil, # Optional RE2-compatible regex pattern. Only URLs matching this pattern are # returned and counted against maxLinks. url_regex: nil, @@ -60,6 +74,7 @@ module BrandDev { domain: String, max_links: Integer, + timeout_ms: Integer, url_regex: String, request_options: BrandDev::RequestOptions } diff --git a/rbi/brand_dev/resources/brand.rbi b/rbi/brand_dev/resources/brand.rbi index 5b548fb..784cbf3 100644 --- a/rbi/brand_dev/resources/brand.rbi +++ b/rbi/brand_dev/resources/brand.rbi @@ -56,8 +56,9 @@ module BrandDev # younger than this many milliseconds. Defaults to 7 days (604800000 ms) when # omitted. Max is 30 days (2592000000 ms). Set to 0 to always scrape fresh. max_age_ms: nil, - # Optional timeout in milliseconds for the request. Maximum allowed value is - # 300000ms (5 minutes). + # Optional timeout in milliseconds for the request. If the request takes longer + # than this value, it will be aborted with a 408 status code. Maximum allowed + # value is 300000ms (5 minutes). timeout_ms: nil, request_options: {} ) @@ -386,6 +387,7 @@ module BrandDev include_frames: T::Boolean, max_age_ms: Integer, parse_pdf: T::Boolean, + timeout_ms: Integer, request_options: BrandDev::RequestOptions::OrHash ).returns(BrandDev::Models::BrandWebScrapeHTMLResponse) end @@ -402,6 +404,10 @@ module BrandDev # returned wrapped in …. When false, PDF URLs are skipped # and a 400 WEBSITE_ACCESS_ERROR is returned. parse_pdf: nil, + # Optional timeout in milliseconds for the request. If the request takes longer + # than this value, it will be aborted with a 408 status code. Maximum allowed + # value is 300000ms (5 minutes). + timeout_ms: nil, request_options: {} ) end @@ -415,6 +421,7 @@ module BrandDev url: String, enrichment: BrandDev::BrandWebScrapeImagesParams::Enrichment::OrHash, max_age_ms: Integer, + timeout_ms: Integer, request_options: BrandDev::RequestOptions::OrHash ).returns(BrandDev::Models::BrandWebScrapeImagesResponse) end @@ -427,6 +434,10 @@ module BrandDev # Reuse a cached result this many milliseconds old or newer. Default: 86400000 (1 # day). Set to 0 to bypass cache. Maximum: 2592000000 (30 days). max_age_ms: nil, + # Optional timeout in milliseconds for the request. If the request takes longer + # than this value, it will be aborted with a 408 status code. Maximum allowed + # value is 300000ms (5 minutes). + timeout_ms: nil, request_options: {} ) end @@ -441,6 +452,7 @@ module BrandDev max_age_ms: Integer, parse_pdf: T::Boolean, shorten_base64_images: T::Boolean, + timeout_ms: Integer, use_main_content_only: T::Boolean, request_options: BrandDev::RequestOptions::OrHash ).returns(BrandDev::Models::BrandWebScrapeMdResponse) @@ -465,6 +477,10 @@ module BrandDev parse_pdf: nil, # Shorten base64-encoded image data in the Markdown output shorten_base64_images: nil, + # Optional timeout in milliseconds for the request. If the request takes longer + # than this value, it will be aborted with a 408 status code. Maximum allowed + # value is 300000ms (5 minutes). + timeout_ms: nil, # Extract only the main content of the page, excluding headers, footers, sidebars, # and navigation use_main_content_only: nil, @@ -477,6 +493,7 @@ module BrandDev params( domain: String, max_links: Integer, + timeout_ms: Integer, url_regex: String, request_options: BrandDev::RequestOptions::OrHash ).returns(BrandDev::Models::BrandWebScrapeSitemapResponse) @@ -487,6 +504,10 @@ module BrandDev # Maximum number of links to return from the sitemap crawl. Defaults to 10,000. # Minimum is 1, maximum is 100,000. max_links: nil, + # Optional timeout in milliseconds for the request. If the request takes longer + # than this value, it will be aborted with a 408 status code. Maximum allowed + # value is 300000ms (5 minutes). + timeout_ms: nil, # Optional RE2-compatible regex pattern. Only URLs matching this pattern are # returned and counted against maxLinks. url_regex: nil, diff --git a/sig/brand_dev/models/brand_web_scrape_html_params.rbs b/sig/brand_dev/models/brand_web_scrape_html_params.rbs index 7a6a2bf..0a52d29 100644 --- a/sig/brand_dev/models/brand_web_scrape_html_params.rbs +++ b/sig/brand_dev/models/brand_web_scrape_html_params.rbs @@ -5,7 +5,8 @@ module BrandDev url: String, include_frames: bool, max_age_ms: Integer, - parse_pdf: bool + parse_pdf: bool, + timeout_ms: Integer } & BrandDev::Internal::Type::request_parameters @@ -27,11 +28,16 @@ module BrandDev def parse_pdf=: (bool) -> bool + attr_reader timeout_ms: Integer? + + def timeout_ms=: (Integer) -> Integer + def initialize: ( url: String, ?include_frames: bool, ?max_age_ms: Integer, ?parse_pdf: bool, + ?timeout_ms: Integer, ?request_options: BrandDev::request_opts ) -> void @@ -40,6 +46,7 @@ module BrandDev include_frames: bool, max_age_ms: Integer, parse_pdf: bool, + timeout_ms: Integer, request_options: BrandDev::RequestOptions } end diff --git a/sig/brand_dev/models/brand_web_scrape_images_params.rbs b/sig/brand_dev/models/brand_web_scrape_images_params.rbs index fa99b37..9168457 100644 --- a/sig/brand_dev/models/brand_web_scrape_images_params.rbs +++ b/sig/brand_dev/models/brand_web_scrape_images_params.rbs @@ -4,7 +4,8 @@ module BrandDev { url: String, enrichment: BrandDev::BrandWebScrapeImagesParams::Enrichment, - max_age_ms: Integer + max_age_ms: Integer, + timeout_ms: Integer } & BrandDev::Internal::Type::request_parameters @@ -24,10 +25,15 @@ module BrandDev def max_age_ms=: (Integer) -> Integer + attr_reader timeout_ms: Integer? + + def timeout_ms=: (Integer) -> Integer + def initialize: ( url: String, ?enrichment: BrandDev::BrandWebScrapeImagesParams::Enrichment, ?max_age_ms: Integer, + ?timeout_ms: Integer, ?request_options: BrandDev::request_opts ) -> void @@ -35,6 +41,7 @@ module BrandDev url: String, enrichment: BrandDev::BrandWebScrapeImagesParams::Enrichment, max_age_ms: Integer, + timeout_ms: Integer, request_options: BrandDev::RequestOptions } diff --git a/sig/brand_dev/models/brand_web_scrape_md_params.rbs b/sig/brand_dev/models/brand_web_scrape_md_params.rbs index ca9fc9e..e4c764d 100644 --- a/sig/brand_dev/models/brand_web_scrape_md_params.rbs +++ b/sig/brand_dev/models/brand_web_scrape_md_params.rbs @@ -9,6 +9,7 @@ module BrandDev max_age_ms: Integer, parse_pdf: bool, :shorten_base64_images => bool, + timeout_ms: Integer, use_main_content_only: bool } & BrandDev::Internal::Type::request_parameters @@ -43,6 +44,10 @@ module BrandDev def shorten_base64_images=: (bool) -> bool + attr_reader timeout_ms: Integer? + + def timeout_ms=: (Integer) -> Integer + attr_reader use_main_content_only: bool? def use_main_content_only=: (bool) -> bool @@ -55,6 +60,7 @@ module BrandDev ?max_age_ms: Integer, ?parse_pdf: bool, ?shorten_base64_images: bool, + ?timeout_ms: Integer, ?use_main_content_only: bool, ?request_options: BrandDev::request_opts ) -> void @@ -67,6 +73,7 @@ module BrandDev max_age_ms: Integer, parse_pdf: bool, :shorten_base64_images => bool, + timeout_ms: Integer, use_main_content_only: bool, request_options: BrandDev::RequestOptions } diff --git a/sig/brand_dev/models/brand_web_scrape_sitemap_params.rbs b/sig/brand_dev/models/brand_web_scrape_sitemap_params.rbs index e0d37f2..b336628 100644 --- a/sig/brand_dev/models/brand_web_scrape_sitemap_params.rbs +++ b/sig/brand_dev/models/brand_web_scrape_sitemap_params.rbs @@ -1,7 +1,12 @@ module BrandDev module Models type brand_web_scrape_sitemap_params = - { domain: String, max_links: Integer, url_regex: String } + { + domain: String, + max_links: Integer, + timeout_ms: Integer, + url_regex: String + } & BrandDev::Internal::Type::request_parameters class BrandWebScrapeSitemapParams < BrandDev::Internal::Type::BaseModel @@ -14,6 +19,10 @@ module BrandDev def max_links=: (Integer) -> Integer + attr_reader timeout_ms: Integer? + + def timeout_ms=: (Integer) -> Integer + attr_reader url_regex: String? def url_regex=: (String) -> String @@ -21,6 +30,7 @@ module BrandDev def initialize: ( domain: String, ?max_links: Integer, + ?timeout_ms: Integer, ?url_regex: String, ?request_options: BrandDev::request_opts ) -> void @@ -28,6 +38,7 @@ module BrandDev def to_hash: -> { domain: String, max_links: Integer, + timeout_ms: Integer, url_regex: String, request_options: BrandDev::RequestOptions } diff --git a/sig/brand_dev/resources/brand.rbs b/sig/brand_dev/resources/brand.rbs index 496ec4d..caae57e 100644 --- a/sig/brand_dev/resources/brand.rbs +++ b/sig/brand_dev/resources/brand.rbs @@ -105,6 +105,7 @@ module BrandDev ?include_frames: bool, ?max_age_ms: Integer, ?parse_pdf: bool, + ?timeout_ms: Integer, ?request_options: BrandDev::request_opts ) -> BrandDev::Models::BrandWebScrapeHTMLResponse @@ -112,6 +113,7 @@ module BrandDev url: String, ?enrichment: BrandDev::BrandWebScrapeImagesParams::Enrichment, ?max_age_ms: Integer, + ?timeout_ms: Integer, ?request_options: BrandDev::request_opts ) -> BrandDev::Models::BrandWebScrapeImagesResponse @@ -123,6 +125,7 @@ module BrandDev ?max_age_ms: Integer, ?parse_pdf: bool, ?shorten_base64_images: bool, + ?timeout_ms: Integer, ?use_main_content_only: bool, ?request_options: BrandDev::request_opts ) -> BrandDev::Models::BrandWebScrapeMdResponse @@ -130,6 +133,7 @@ module BrandDev def web_scrape_sitemap: ( domain: String, ?max_links: Integer, + ?timeout_ms: Integer, ?url_regex: String, ?request_options: BrandDev::request_opts ) -> BrandDev::Models::BrandWebScrapeSitemapResponse From cd834b4821c2107f10f92b8ee717daa63622ac42 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sat, 9 May 2026 01:36:03 +0000 Subject: [PATCH 45/82] feat(api): api update --- .stats.yml | 4 ++-- .../models/brand_web_scrape_html_params.rb | 11 ++++++++- .../models/brand_web_scrape_images_params.rb | 11 ++++++++- .../models/brand_web_scrape_md_params.rb | 11 ++++++++- lib/brand_dev/resources/brand.rb | 24 ++++++++++++++----- .../models/brand_web_scrape_html_params.rbi | 13 ++++++++++ .../models/brand_web_scrape_images_params.rbi | 13 ++++++++++ .../models/brand_web_scrape_md_params.rbi | 13 ++++++++++ rbi/brand_dev/resources/brand.rbi | 12 ++++++++++ .../models/brand_web_scrape_html_params.rbs | 9 ++++++- .../models/brand_web_scrape_images_params.rbs | 9 ++++++- .../models/brand_web_scrape_md_params.rbs | 9 ++++++- sig/brand_dev/resources/brand.rbs | 3 +++ 13 files changed, 128 insertions(+), 14 deletions(-) diff --git a/.stats.yml b/.stats.yml index 3647616..7d8efa9 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 16 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-f930a89f5fccd44dd6548fce8ae69ab2d966dd10a3e3dfa128a8894089a34d1a.yml -openapi_spec_hash: d21ebf5fac677f08d74a9153fb57f9af +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-1e7156456cea5c8586e6e3b189d0477cb84176c9d5ff3c2dce4baee36137fe8b.yml +openapi_spec_hash: a5e97fe34f248eb0927baf52debaf79a config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 diff --git a/lib/brand_dev/models/brand_web_scrape_html_params.rb b/lib/brand_dev/models/brand_web_scrape_html_params.rb index 2b7e73b..697f43b 100644 --- a/lib/brand_dev/models/brand_web_scrape_html_params.rb +++ b/lib/brand_dev/models/brand_web_scrape_html_params.rb @@ -43,7 +43,14 @@ class BrandWebScrapeHTMLParams < BrandDev::Internal::Type::BaseModel # @return [Integer, nil] optional :timeout_ms, Integer - # @!method initialize(url:, include_frames: nil, max_age_ms: nil, parse_pdf: nil, timeout_ms: nil, request_options: {}) + # @!attribute wait_for_ms + # Optional browser wait time in milliseconds after initial page load. Min: 0. Max: + # 30000 (30 seconds). + # + # @return [Integer, nil] + optional :wait_for_ms, Integer + + # @!method initialize(url:, include_frames: nil, max_age_ms: nil, parse_pdf: nil, timeout_ms: nil, wait_for_ms: nil, request_options: {}) # Some parameter documentations has been truncated, see # {BrandDev::Models::BrandWebScrapeHTMLParams} for more details. # @@ -57,6 +64,8 @@ class BrandWebScrapeHTMLParams < BrandDev::Internal::Type::BaseModel # # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th # + # @param wait_for_ms [Integer] Optional browser wait time in milliseconds after initial page load. Min: 0. Max: + # # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/brand_dev/models/brand_web_scrape_images_params.rb b/lib/brand_dev/models/brand_web_scrape_images_params.rb index 99bb317..806500c 100644 --- a/lib/brand_dev/models/brand_web_scrape_images_params.rb +++ b/lib/brand_dev/models/brand_web_scrape_images_params.rb @@ -35,7 +35,14 @@ class BrandWebScrapeImagesParams < BrandDev::Internal::Type::BaseModel # @return [Integer, nil] optional :timeout_ms, Integer - # @!method initialize(url:, enrichment: nil, max_age_ms: nil, timeout_ms: nil, request_options: {}) + # @!attribute wait_for_ms + # Optional browser wait time in milliseconds after initial page load before + # collecting images. Min: 0. Max: 30000 (30 seconds). + # + # @return [Integer, nil] + optional :wait_for_ms, Integer + + # @!method initialize(url:, enrichment: nil, max_age_ms: nil, timeout_ms: nil, wait_for_ms: nil, request_options: {}) # Some parameter documentations has been truncated, see # {BrandDev::Models::BrandWebScrapeImagesParams} for more details. # @@ -47,6 +54,8 @@ class BrandWebScrapeImagesParams < BrandDev::Internal::Type::BaseModel # # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th # + # @param wait_for_ms [Integer] Optional browser wait time in milliseconds after initial page load before collec + # # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}] class Enrichment < BrandDev::Internal::Type::BaseModel diff --git a/lib/brand_dev/models/brand_web_scrape_md_params.rb b/lib/brand_dev/models/brand_web_scrape_md_params.rb index 72edf09..521492f 100644 --- a/lib/brand_dev/models/brand_web_scrape_md_params.rb +++ b/lib/brand_dev/models/brand_web_scrape_md_params.rb @@ -69,7 +69,14 @@ class BrandWebScrapeMdParams < BrandDev::Internal::Type::BaseModel # @return [Boolean, nil] optional :use_main_content_only, BrandDev::Internal::Type::Boolean - # @!method initialize(url:, include_frames: nil, include_images: nil, include_links: nil, max_age_ms: nil, parse_pdf: nil, shorten_base64_images: nil, timeout_ms: nil, use_main_content_only: nil, request_options: {}) + # @!attribute wait_for_ms + # Optional browser wait time in milliseconds after initial page load before + # converting the page to Markdown. Min: 0. Max: 30000 (30 seconds). + # + # @return [Integer, nil] + optional :wait_for_ms, Integer + + # @!method initialize(url:, include_frames: nil, include_images: nil, include_links: nil, max_age_ms: nil, parse_pdf: nil, shorten_base64_images: nil, timeout_ms: nil, use_main_content_only: nil, wait_for_ms: nil, request_options: {}) # Some parameter documentations has been truncated, see # {BrandDev::Models::BrandWebScrapeMdParams} for more details. # @@ -91,6 +98,8 @@ class BrandWebScrapeMdParams < BrandDev::Internal::Type::BaseModel # # @param use_main_content_only [Boolean] Extract only the main content of the page, excluding headers, footers, sidebars, # + # @param wait_for_ms [Integer] Optional browser wait time in milliseconds after initial page load before conver + # # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/brand_dev/resources/brand.rb b/lib/brand_dev/resources/brand.rb index 5b37fa0..b03f1d7 100644 --- a/lib/brand_dev/resources/brand.rb +++ b/lib/brand_dev/resources/brand.rb @@ -405,7 +405,7 @@ def retrieve_simplified(params) # # Scrapes the given URL and returns the raw HTML content of the page. # - # @overload web_scrape_html(url:, include_frames: nil, max_age_ms: nil, parse_pdf: nil, timeout_ms: nil, request_options: {}) + # @overload web_scrape_html(url:, include_frames: nil, max_age_ms: nil, parse_pdf: nil, timeout_ms: nil, wait_for_ms: nil, request_options: {}) # # @param url [String] Full URL to scrape (must include http:// or https:// protocol) # @@ -417,6 +417,8 @@ def retrieve_simplified(params) # # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th # + # @param wait_for_ms [Integer] Optional browser wait time in milliseconds after initial page load. Min: 0. Max: + # # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [BrandDev::Models::BrandWebScrapeHTMLResponse] @@ -432,7 +434,8 @@ def web_scrape_html(params) include_frames: "includeFrames", max_age_ms: "maxAgeMs", parse_pdf: "parsePDF", - timeout_ms: "timeoutMS" + timeout_ms: "timeoutMS", + wait_for_ms: "waitForMs" ), model: BrandDev::Models::BrandWebScrapeHTMLResponse, options: options @@ -447,7 +450,7 @@ def web_scrape_html(params) # embeds. The base request costs 1 credit; enrichment costs 1 credit per returned # image. # - # @overload web_scrape_images(url:, enrichment: nil, max_age_ms: nil, timeout_ms: nil, request_options: {}) + # @overload web_scrape_images(url:, enrichment: nil, max_age_ms: nil, timeout_ms: nil, wait_for_ms: nil, request_options: {}) # # @param url [String] Page URL to inspect. Must include http:// or https://. # @@ -457,6 +460,8 @@ def web_scrape_html(params) # # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th # + # @param wait_for_ms [Integer] Optional browser wait time in milliseconds after initial page load before collec + # # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [BrandDev::Models::BrandWebScrapeImagesResponse] @@ -468,7 +473,11 @@ def web_scrape_images(params) @client.request( method: :get, path: "web/scrape/images", - query: query.transform_keys(max_age_ms: "maxAgeMs", timeout_ms: "timeoutMS"), + query: query.transform_keys( + max_age_ms: "maxAgeMs", + timeout_ms: "timeoutMS", + wait_for_ms: "waitForMs" + ), model: BrandDev::Models::BrandWebScrapeImagesResponse, options: options ) @@ -479,7 +488,7 @@ def web_scrape_images(params) # # Scrapes the given URL into LLM usable Markdown. # - # @overload web_scrape_md(url:, include_frames: nil, include_images: nil, include_links: nil, max_age_ms: nil, parse_pdf: nil, shorten_base64_images: nil, timeout_ms: nil, use_main_content_only: nil, request_options: {}) + # @overload web_scrape_md(url:, include_frames: nil, include_images: nil, include_links: nil, max_age_ms: nil, parse_pdf: nil, shorten_base64_images: nil, timeout_ms: nil, use_main_content_only: nil, wait_for_ms: nil, request_options: {}) # # @param url [String] Full URL to scrape into LLM usable Markdown (must include http:// or https:// pr # @@ -499,6 +508,8 @@ def web_scrape_images(params) # # @param use_main_content_only [Boolean] Extract only the main content of the page, excluding headers, footers, sidebars, # + # @param wait_for_ms [Integer] Optional browser wait time in milliseconds after initial page load before conver + # # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [BrandDev::Models::BrandWebScrapeMdResponse] @@ -518,7 +529,8 @@ def web_scrape_md(params) parse_pdf: "parsePDF", shorten_base64_images: "shortenBase64Images", timeout_ms: "timeoutMS", - use_main_content_only: "useMainContentOnly" + use_main_content_only: "useMainContentOnly", + wait_for_ms: "waitForMs" ), model: BrandDev::Models::BrandWebScrapeMdResponse, options: options diff --git a/rbi/brand_dev/models/brand_web_scrape_html_params.rbi b/rbi/brand_dev/models/brand_web_scrape_html_params.rbi index 610523b..1574814 100644 --- a/rbi/brand_dev/models/brand_web_scrape_html_params.rbi +++ b/rbi/brand_dev/models/brand_web_scrape_html_params.rbi @@ -49,6 +49,14 @@ module BrandDev sig { params(timeout_ms: Integer).void } attr_writer :timeout_ms + # Optional browser wait time in milliseconds after initial page load. Min: 0. Max: + # 30000 (30 seconds). + sig { returns(T.nilable(Integer)) } + attr_reader :wait_for_ms + + sig { params(wait_for_ms: Integer).void } + attr_writer :wait_for_ms + sig do params( url: String, @@ -56,6 +64,7 @@ module BrandDev max_age_ms: Integer, parse_pdf: T::Boolean, timeout_ms: Integer, + wait_for_ms: Integer, request_options: BrandDev::RequestOptions::OrHash ).returns(T.attached_class) end @@ -76,6 +85,9 @@ module BrandDev # than this value, it will be aborted with a 408 status code. Maximum allowed # value is 300000ms (5 minutes). timeout_ms: nil, + # Optional browser wait time in milliseconds after initial page load. Min: 0. Max: + # 30000 (30 seconds). + wait_for_ms: nil, request_options: {} ) end @@ -88,6 +100,7 @@ module BrandDev max_age_ms: Integer, parse_pdf: T::Boolean, timeout_ms: Integer, + wait_for_ms: Integer, request_options: BrandDev::RequestOptions } ) diff --git a/rbi/brand_dev/models/brand_web_scrape_images_params.rbi b/rbi/brand_dev/models/brand_web_scrape_images_params.rbi index 2aca4e2..fa6a304 100644 --- a/rbi/brand_dev/models/brand_web_scrape_images_params.rbi +++ b/rbi/brand_dev/models/brand_web_scrape_images_params.rbi @@ -49,12 +49,21 @@ module BrandDev sig { params(timeout_ms: Integer).void } attr_writer :timeout_ms + # Optional browser wait time in milliseconds after initial page load before + # collecting images. Min: 0. Max: 30000 (30 seconds). + sig { returns(T.nilable(Integer)) } + attr_reader :wait_for_ms + + sig { params(wait_for_ms: Integer).void } + attr_writer :wait_for_ms + sig do params( url: String, enrichment: BrandDev::BrandWebScrapeImagesParams::Enrichment::OrHash, max_age_ms: Integer, timeout_ms: Integer, + wait_for_ms: Integer, request_options: BrandDev::RequestOptions::OrHash ).returns(T.attached_class) end @@ -71,6 +80,9 @@ module BrandDev # than this value, it will be aborted with a 408 status code. Maximum allowed # value is 300000ms (5 minutes). timeout_ms: nil, + # Optional browser wait time in milliseconds after initial page load before + # collecting images. Min: 0. Max: 30000 (30 seconds). + wait_for_ms: nil, request_options: {} ) end @@ -82,6 +94,7 @@ module BrandDev enrichment: BrandDev::BrandWebScrapeImagesParams::Enrichment, max_age_ms: Integer, timeout_ms: Integer, + wait_for_ms: Integer, request_options: BrandDev::RequestOptions } ) diff --git a/rbi/brand_dev/models/brand_web_scrape_md_params.rbi b/rbi/brand_dev/models/brand_web_scrape_md_params.rbi index b7c2086..99fb2df 100644 --- a/rbi/brand_dev/models/brand_web_scrape_md_params.rbi +++ b/rbi/brand_dev/models/brand_web_scrape_md_params.rbi @@ -79,6 +79,14 @@ module BrandDev sig { params(use_main_content_only: T::Boolean).void } attr_writer :use_main_content_only + # Optional browser wait time in milliseconds after initial page load before + # converting the page to Markdown. Min: 0. Max: 30000 (30 seconds). + sig { returns(T.nilable(Integer)) } + attr_reader :wait_for_ms + + sig { params(wait_for_ms: Integer).void } + attr_writer :wait_for_ms + sig do params( url: String, @@ -90,6 +98,7 @@ module BrandDev shorten_base64_images: T::Boolean, timeout_ms: Integer, use_main_content_only: T::Boolean, + wait_for_ms: Integer, request_options: BrandDev::RequestOptions::OrHash ).returns(T.attached_class) end @@ -120,6 +129,9 @@ module BrandDev # Extract only the main content of the page, excluding headers, footers, sidebars, # and navigation use_main_content_only: nil, + # Optional browser wait time in milliseconds after initial page load before + # converting the page to Markdown. Min: 0. Max: 30000 (30 seconds). + wait_for_ms: nil, request_options: {} ) end @@ -136,6 +148,7 @@ module BrandDev shorten_base64_images: T::Boolean, timeout_ms: Integer, use_main_content_only: T::Boolean, + wait_for_ms: Integer, request_options: BrandDev::RequestOptions } ) diff --git a/rbi/brand_dev/resources/brand.rbi b/rbi/brand_dev/resources/brand.rbi index 784cbf3..f8953a3 100644 --- a/rbi/brand_dev/resources/brand.rbi +++ b/rbi/brand_dev/resources/brand.rbi @@ -388,6 +388,7 @@ module BrandDev max_age_ms: Integer, parse_pdf: T::Boolean, timeout_ms: Integer, + wait_for_ms: Integer, request_options: BrandDev::RequestOptions::OrHash ).returns(BrandDev::Models::BrandWebScrapeHTMLResponse) end @@ -408,6 +409,9 @@ module BrandDev # than this value, it will be aborted with a 408 status code. Maximum allowed # value is 300000ms (5 minutes). timeout_ms: nil, + # Optional browser wait time in milliseconds after initial page load. Min: 0. Max: + # 30000 (30 seconds). + wait_for_ms: nil, request_options: {} ) end @@ -422,6 +426,7 @@ module BrandDev enrichment: BrandDev::BrandWebScrapeImagesParams::Enrichment::OrHash, max_age_ms: Integer, timeout_ms: Integer, + wait_for_ms: Integer, request_options: BrandDev::RequestOptions::OrHash ).returns(BrandDev::Models::BrandWebScrapeImagesResponse) end @@ -438,6 +443,9 @@ module BrandDev # than this value, it will be aborted with a 408 status code. Maximum allowed # value is 300000ms (5 minutes). timeout_ms: nil, + # Optional browser wait time in milliseconds after initial page load before + # collecting images. Min: 0. Max: 30000 (30 seconds). + wait_for_ms: nil, request_options: {} ) end @@ -454,6 +462,7 @@ module BrandDev shorten_base64_images: T::Boolean, timeout_ms: Integer, use_main_content_only: T::Boolean, + wait_for_ms: Integer, request_options: BrandDev::RequestOptions::OrHash ).returns(BrandDev::Models::BrandWebScrapeMdResponse) end @@ -484,6 +493,9 @@ module BrandDev # Extract only the main content of the page, excluding headers, footers, sidebars, # and navigation use_main_content_only: nil, + # Optional browser wait time in milliseconds after initial page load before + # converting the page to Markdown. Min: 0. Max: 30000 (30 seconds). + wait_for_ms: nil, request_options: {} ) end diff --git a/sig/brand_dev/models/brand_web_scrape_html_params.rbs b/sig/brand_dev/models/brand_web_scrape_html_params.rbs index 0a52d29..00d3338 100644 --- a/sig/brand_dev/models/brand_web_scrape_html_params.rbs +++ b/sig/brand_dev/models/brand_web_scrape_html_params.rbs @@ -6,7 +6,8 @@ module BrandDev include_frames: bool, max_age_ms: Integer, parse_pdf: bool, - timeout_ms: Integer + timeout_ms: Integer, + wait_for_ms: Integer } & BrandDev::Internal::Type::request_parameters @@ -32,12 +33,17 @@ module BrandDev def timeout_ms=: (Integer) -> Integer + attr_reader wait_for_ms: Integer? + + def wait_for_ms=: (Integer) -> Integer + def initialize: ( url: String, ?include_frames: bool, ?max_age_ms: Integer, ?parse_pdf: bool, ?timeout_ms: Integer, + ?wait_for_ms: Integer, ?request_options: BrandDev::request_opts ) -> void @@ -47,6 +53,7 @@ module BrandDev max_age_ms: Integer, parse_pdf: bool, timeout_ms: Integer, + wait_for_ms: Integer, request_options: BrandDev::RequestOptions } end diff --git a/sig/brand_dev/models/brand_web_scrape_images_params.rbs b/sig/brand_dev/models/brand_web_scrape_images_params.rbs index 9168457..dc6a42f 100644 --- a/sig/brand_dev/models/brand_web_scrape_images_params.rbs +++ b/sig/brand_dev/models/brand_web_scrape_images_params.rbs @@ -5,7 +5,8 @@ module BrandDev url: String, enrichment: BrandDev::BrandWebScrapeImagesParams::Enrichment, max_age_ms: Integer, - timeout_ms: Integer + timeout_ms: Integer, + wait_for_ms: Integer } & BrandDev::Internal::Type::request_parameters @@ -29,11 +30,16 @@ module BrandDev def timeout_ms=: (Integer) -> Integer + attr_reader wait_for_ms: Integer? + + def wait_for_ms=: (Integer) -> Integer + def initialize: ( url: String, ?enrichment: BrandDev::BrandWebScrapeImagesParams::Enrichment, ?max_age_ms: Integer, ?timeout_ms: Integer, + ?wait_for_ms: Integer, ?request_options: BrandDev::request_opts ) -> void @@ -42,6 +48,7 @@ module BrandDev enrichment: BrandDev::BrandWebScrapeImagesParams::Enrichment, max_age_ms: Integer, timeout_ms: Integer, + wait_for_ms: Integer, request_options: BrandDev::RequestOptions } diff --git a/sig/brand_dev/models/brand_web_scrape_md_params.rbs b/sig/brand_dev/models/brand_web_scrape_md_params.rbs index e4c764d..2d80d2b 100644 --- a/sig/brand_dev/models/brand_web_scrape_md_params.rbs +++ b/sig/brand_dev/models/brand_web_scrape_md_params.rbs @@ -10,7 +10,8 @@ module BrandDev parse_pdf: bool, :shorten_base64_images => bool, timeout_ms: Integer, - use_main_content_only: bool + use_main_content_only: bool, + wait_for_ms: Integer } & BrandDev::Internal::Type::request_parameters @@ -52,6 +53,10 @@ module BrandDev def use_main_content_only=: (bool) -> bool + attr_reader wait_for_ms: Integer? + + def wait_for_ms=: (Integer) -> Integer + def initialize: ( url: String, ?include_frames: bool, @@ -62,6 +67,7 @@ module BrandDev ?shorten_base64_images: bool, ?timeout_ms: Integer, ?use_main_content_only: bool, + ?wait_for_ms: Integer, ?request_options: BrandDev::request_opts ) -> void @@ -75,6 +81,7 @@ module BrandDev :shorten_base64_images => bool, timeout_ms: Integer, use_main_content_only: bool, + wait_for_ms: Integer, request_options: BrandDev::RequestOptions } end diff --git a/sig/brand_dev/resources/brand.rbs b/sig/brand_dev/resources/brand.rbs index caae57e..ff845c7 100644 --- a/sig/brand_dev/resources/brand.rbs +++ b/sig/brand_dev/resources/brand.rbs @@ -106,6 +106,7 @@ module BrandDev ?max_age_ms: Integer, ?parse_pdf: bool, ?timeout_ms: Integer, + ?wait_for_ms: Integer, ?request_options: BrandDev::request_opts ) -> BrandDev::Models::BrandWebScrapeHTMLResponse @@ -114,6 +115,7 @@ module BrandDev ?enrichment: BrandDev::BrandWebScrapeImagesParams::Enrichment, ?max_age_ms: Integer, ?timeout_ms: Integer, + ?wait_for_ms: Integer, ?request_options: BrandDev::request_opts ) -> BrandDev::Models::BrandWebScrapeImagesResponse @@ -127,6 +129,7 @@ module BrandDev ?shorten_base64_images: bool, ?timeout_ms: Integer, ?use_main_content_only: bool, + ?wait_for_ms: Integer, ?request_options: BrandDev::request_opts ) -> BrandDev::Models::BrandWebScrapeMdResponse From c1bebc54ac22374b4c12c074ff438fd14d05b0f9 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sun, 10 May 2026 16:07:15 +0000 Subject: [PATCH 46/82] feat(api): api update --- .stats.yml | 4 +- .../models/brand_web_scrape_html_params.rb | 50 +++++++++-- .../models/brand_web_scrape_md_params.rb | 50 +++++++++-- lib/brand_dev/resources/brand.rb | 10 +-- .../models/brand_web_scrape_html_params.rbi | 86 ++++++++++++++++--- .../models/brand_web_scrape_md_params.rbi | 86 ++++++++++++++++--- rbi/brand_dev/resources/brand.rbi | 18 ++-- .../models/brand_web_scrape_html_params.rbs | 36 ++++++-- .../models/brand_web_scrape_md_params.rbs | 36 ++++++-- sig/brand_dev/resources/brand.rbs | 4 +- 10 files changed, 308 insertions(+), 72 deletions(-) diff --git a/.stats.yml b/.stats.yml index 7d8efa9..dd6dd37 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 16 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-1e7156456cea5c8586e6e3b189d0477cb84176c9d5ff3c2dce4baee36137fe8b.yml -openapi_spec_hash: a5e97fe34f248eb0927baf52debaf79a +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-2ed135a665bd4f01ec462096a6e19597f06356121646256cee090d1156fbfd45.yml +openapi_spec_hash: 03039640f82e64d738a57f3d3af4445e config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 diff --git a/lib/brand_dev/models/brand_web_scrape_html_params.rb b/lib/brand_dev/models/brand_web_scrape_html_params.rb index 697f43b..ce7df60 100644 --- a/lib/brand_dev/models/brand_web_scrape_html_params.rb +++ b/lib/brand_dev/models/brand_web_scrape_html_params.rb @@ -27,13 +27,12 @@ class BrandWebScrapeHTMLParams < BrandDev::Internal::Type::BaseModel # @return [Integer, nil] optional :max_age_ms, Integer - # @!attribute parse_pdf - # When true (default), PDF URLs are fetched and their text layer is extracted and - # returned wrapped in …. When false, PDF URLs are skipped - # and a 400 WEBSITE_ACCESS_ERROR is returned. + # @!attribute pdf + # PDF parsing controls. Use start/end to limit text extraction and OCR to an + # inclusive 1-based page range. # - # @return [Boolean, nil] - optional :parse_pdf, BrandDev::Internal::Type::Boolean + # @return [BrandDev::Models::BrandWebScrapeHTMLParams::Pdf, nil] + optional :pdf, -> { BrandDev::BrandWebScrapeHTMLParams::Pdf } # @!attribute timeout_ms # Optional timeout in milliseconds for the request. If the request takes longer @@ -50,7 +49,7 @@ class BrandWebScrapeHTMLParams < BrandDev::Internal::Type::BaseModel # @return [Integer, nil] optional :wait_for_ms, Integer - # @!method initialize(url:, include_frames: nil, max_age_ms: nil, parse_pdf: nil, timeout_ms: nil, wait_for_ms: nil, request_options: {}) + # @!method initialize(url:, include_frames: nil, max_age_ms: nil, pdf: nil, timeout_ms: nil, wait_for_ms: nil, request_options: {}) # Some parameter documentations has been truncated, see # {BrandDev::Models::BrandWebScrapeHTMLParams} for more details. # @@ -60,13 +59,48 @@ class BrandWebScrapeHTMLParams < BrandDev::Internal::Type::BaseModel # # @param max_age_ms [Integer] Return a cached result if a prior scrape for the same parameters exists and is y # - # @param parse_pdf [Boolean] When true (default), PDF URLs are fetched and their text layer is extracted and + # @param pdf [BrandDev::Models::BrandWebScrapeHTMLParams::Pdf] PDF parsing controls. Use start/end to limit text extraction and OCR to an inclu # # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th # # @param wait_for_ms [Integer] Optional browser wait time in milliseconds after initial page load. Min: 0. Max: # # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}] + + class Pdf < BrandDev::Internal::Type::BaseModel + # @!attribute end_ + # Last 1-based PDF page to parse. When omitted, parsing ends at the last page. + # Must be greater than or equal to start when both are provided. + # + # @return [Integer, nil] + optional :end_, Integer, api_name: :end + + # @!attribute should_parse + # When true, PDF URLs are fetched and parsed. When false, PDF URLs are skipped and + # a 400 WEBSITE_ACCESS_ERROR is returned. + # + # @return [Boolean, nil] + optional :should_parse, BrandDev::Internal::Type::Boolean, api_name: :shouldParse + + # @!attribute start + # First 1-based PDF page to parse. When omitted, parsing starts at the first page. + # + # @return [Integer, nil] + optional :start, Integer + + # @!method initialize(end_: nil, should_parse: nil, start: nil) + # Some parameter documentations has been truncated, see + # {BrandDev::Models::BrandWebScrapeHTMLParams::Pdf} for more details. + # + # PDF parsing controls. Use start/end to limit text extraction and OCR to an + # inclusive 1-based page range. + # + # @param end_ [Integer] Last 1-based PDF page to parse. When omitted, parsing ends at the last page. Mus + # + # @param should_parse [Boolean] When true, PDF URLs are fetched and parsed. When false, PDF URLs are skipped and + # + # @param start [Integer] First 1-based PDF page to parse. When omitted, parsing starts at the first page. + end end end end diff --git a/lib/brand_dev/models/brand_web_scrape_md_params.rb b/lib/brand_dev/models/brand_web_scrape_md_params.rb index 521492f..8511327 100644 --- a/lib/brand_dev/models/brand_web_scrape_md_params.rb +++ b/lib/brand_dev/models/brand_web_scrape_md_params.rb @@ -40,13 +40,12 @@ class BrandWebScrapeMdParams < BrandDev::Internal::Type::BaseModel # @return [Integer, nil] optional :max_age_ms, Integer - # @!attribute parse_pdf - # When true (default), PDF URLs are fetched and their text layer is extracted and - # converted to Markdown. When false, PDF URLs are skipped and a 400 - # WEBSITE_ACCESS_ERROR is returned. + # @!attribute pdf + # PDF parsing controls. Use start/end to limit text extraction and OCR to an + # inclusive 1-based page range. # - # @return [Boolean, nil] - optional :parse_pdf, BrandDev::Internal::Type::Boolean + # @return [BrandDev::Models::BrandWebScrapeMdParams::Pdf, nil] + optional :pdf, -> { BrandDev::BrandWebScrapeMdParams::Pdf } # @!attribute shorten_base64_images # Shorten base64-encoded image data in the Markdown output @@ -76,7 +75,7 @@ class BrandWebScrapeMdParams < BrandDev::Internal::Type::BaseModel # @return [Integer, nil] optional :wait_for_ms, Integer - # @!method initialize(url:, include_frames: nil, include_images: nil, include_links: nil, max_age_ms: nil, parse_pdf: nil, shorten_base64_images: nil, timeout_ms: nil, use_main_content_only: nil, wait_for_ms: nil, request_options: {}) + # @!method initialize(url:, include_frames: nil, include_images: nil, include_links: nil, max_age_ms: nil, pdf: nil, shorten_base64_images: nil, timeout_ms: nil, use_main_content_only: nil, wait_for_ms: nil, request_options: {}) # Some parameter documentations has been truncated, see # {BrandDev::Models::BrandWebScrapeMdParams} for more details. # @@ -90,7 +89,7 @@ class BrandWebScrapeMdParams < BrandDev::Internal::Type::BaseModel # # @param max_age_ms [Integer] Return a cached result if a prior scrape for the same parameters exists and is y # - # @param parse_pdf [Boolean] When true (default), PDF URLs are fetched and their text layer is extracted and + # @param pdf [BrandDev::Models::BrandWebScrapeMdParams::Pdf] PDF parsing controls. Use start/end to limit text extraction and OCR to an inclu # # @param shorten_base64_images [Boolean] Shorten base64-encoded image data in the Markdown output # @@ -101,6 +100,41 @@ class BrandWebScrapeMdParams < BrandDev::Internal::Type::BaseModel # @param wait_for_ms [Integer] Optional browser wait time in milliseconds after initial page load before conver # # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}] + + class Pdf < BrandDev::Internal::Type::BaseModel + # @!attribute end_ + # Last 1-based PDF page to parse. When omitted, parsing ends at the last page. + # Must be greater than or equal to start when both are provided. + # + # @return [Integer, nil] + optional :end_, Integer, api_name: :end + + # @!attribute should_parse + # When true, PDF URLs are fetched and parsed. When false, PDF URLs are skipped and + # a 400 WEBSITE_ACCESS_ERROR is returned. + # + # @return [Boolean, nil] + optional :should_parse, BrandDev::Internal::Type::Boolean, api_name: :shouldParse + + # @!attribute start + # First 1-based PDF page to parse. When omitted, parsing starts at the first page. + # + # @return [Integer, nil] + optional :start, Integer + + # @!method initialize(end_: nil, should_parse: nil, start: nil) + # Some parameter documentations has been truncated, see + # {BrandDev::Models::BrandWebScrapeMdParams::Pdf} for more details. + # + # PDF parsing controls. Use start/end to limit text extraction and OCR to an + # inclusive 1-based page range. + # + # @param end_ [Integer] Last 1-based PDF page to parse. When omitted, parsing ends at the last page. Mus + # + # @param should_parse [Boolean] When true, PDF URLs are fetched and parsed. When false, PDF URLs are skipped and + # + # @param start [Integer] First 1-based PDF page to parse. When omitted, parsing starts at the first page. + end end end end diff --git a/lib/brand_dev/resources/brand.rb b/lib/brand_dev/resources/brand.rb index b03f1d7..ddc0aa3 100644 --- a/lib/brand_dev/resources/brand.rb +++ b/lib/brand_dev/resources/brand.rb @@ -405,7 +405,7 @@ def retrieve_simplified(params) # # Scrapes the given URL and returns the raw HTML content of the page. # - # @overload web_scrape_html(url:, include_frames: nil, max_age_ms: nil, parse_pdf: nil, timeout_ms: nil, wait_for_ms: nil, request_options: {}) + # @overload web_scrape_html(url:, include_frames: nil, max_age_ms: nil, pdf: nil, timeout_ms: nil, wait_for_ms: nil, request_options: {}) # # @param url [String] Full URL to scrape (must include http:// or https:// protocol) # @@ -413,7 +413,7 @@ def retrieve_simplified(params) # # @param max_age_ms [Integer] Return a cached result if a prior scrape for the same parameters exists and is y # - # @param parse_pdf [Boolean] When true (default), PDF URLs are fetched and their text layer is extracted and + # @param pdf [BrandDev::Models::BrandWebScrapeHTMLParams::Pdf] PDF parsing controls. Use start/end to limit text extraction and OCR to an inclu # # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th # @@ -433,7 +433,6 @@ def web_scrape_html(params) query: query.transform_keys( include_frames: "includeFrames", max_age_ms: "maxAgeMs", - parse_pdf: "parsePDF", timeout_ms: "timeoutMS", wait_for_ms: "waitForMs" ), @@ -488,7 +487,7 @@ def web_scrape_images(params) # # Scrapes the given URL into LLM usable Markdown. # - # @overload web_scrape_md(url:, include_frames: nil, include_images: nil, include_links: nil, max_age_ms: nil, parse_pdf: nil, shorten_base64_images: nil, timeout_ms: nil, use_main_content_only: nil, wait_for_ms: nil, request_options: {}) + # @overload web_scrape_md(url:, include_frames: nil, include_images: nil, include_links: nil, max_age_ms: nil, pdf: nil, shorten_base64_images: nil, timeout_ms: nil, use_main_content_only: nil, wait_for_ms: nil, request_options: {}) # # @param url [String] Full URL to scrape into LLM usable Markdown (must include http:// or https:// pr # @@ -500,7 +499,7 @@ def web_scrape_images(params) # # @param max_age_ms [Integer] Return a cached result if a prior scrape for the same parameters exists and is y # - # @param parse_pdf [Boolean] When true (default), PDF URLs are fetched and their text layer is extracted and + # @param pdf [BrandDev::Models::BrandWebScrapeMdParams::Pdf] PDF parsing controls. Use start/end to limit text extraction and OCR to an inclu # # @param shorten_base64_images [Boolean] Shorten base64-encoded image data in the Markdown output # @@ -526,7 +525,6 @@ def web_scrape_md(params) include_images: "includeImages", include_links: "includeLinks", max_age_ms: "maxAgeMs", - parse_pdf: "parsePDF", shorten_base64_images: "shortenBase64Images", timeout_ms: "timeoutMS", use_main_content_only: "useMainContentOnly", diff --git a/rbi/brand_dev/models/brand_web_scrape_html_params.rbi b/rbi/brand_dev/models/brand_web_scrape_html_params.rbi index 1574814..a6eb50b 100644 --- a/rbi/brand_dev/models/brand_web_scrape_html_params.rbi +++ b/rbi/brand_dev/models/brand_web_scrape_html_params.rbi @@ -31,14 +31,13 @@ module BrandDev sig { params(max_age_ms: Integer).void } attr_writer :max_age_ms - # When true (default), PDF URLs are fetched and their text layer is extracted and - # returned wrapped in …. When false, PDF URLs are skipped - # and a 400 WEBSITE_ACCESS_ERROR is returned. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :parse_pdf + # PDF parsing controls. Use start/end to limit text extraction and OCR to an + # inclusive 1-based page range. + sig { returns(T.nilable(BrandDev::BrandWebScrapeHTMLParams::Pdf)) } + attr_reader :pdf - sig { params(parse_pdf: T::Boolean).void } - attr_writer :parse_pdf + sig { params(pdf: BrandDev::BrandWebScrapeHTMLParams::Pdf::OrHash).void } + attr_writer :pdf # Optional timeout in milliseconds for the request. If the request takes longer # than this value, it will be aborted with a 408 status code. Maximum allowed @@ -62,7 +61,7 @@ module BrandDev url: String, include_frames: T::Boolean, max_age_ms: Integer, - parse_pdf: T::Boolean, + pdf: BrandDev::BrandWebScrapeHTMLParams::Pdf::OrHash, timeout_ms: Integer, wait_for_ms: Integer, request_options: BrandDev::RequestOptions::OrHash @@ -77,10 +76,9 @@ module BrandDev # younger than this many milliseconds. Defaults to 1 day (86400000 ms) when # omitted. Max is 30 days (2592000000 ms). Set to 0 to always scrape fresh. max_age_ms: nil, - # When true (default), PDF URLs are fetched and their text layer is extracted and - # returned wrapped in …. When false, PDF URLs are skipped - # and a 400 WEBSITE_ACCESS_ERROR is returned. - parse_pdf: nil, + # PDF parsing controls. Use start/end to limit text extraction and OCR to an + # inclusive 1-based page range. + pdf: nil, # Optional timeout in milliseconds for the request. If the request takes longer # than this value, it will be aborted with a 408 status code. Maximum allowed # value is 300000ms (5 minutes). @@ -98,7 +96,7 @@ module BrandDev url: String, include_frames: T::Boolean, max_age_ms: Integer, - parse_pdf: T::Boolean, + pdf: BrandDev::BrandWebScrapeHTMLParams::Pdf, timeout_ms: Integer, wait_for_ms: Integer, request_options: BrandDev::RequestOptions @@ -107,6 +105,68 @@ module BrandDev end def to_hash end + + class Pdf < BrandDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + BrandDev::BrandWebScrapeHTMLParams::Pdf, + BrandDev::Internal::AnyHash + ) + end + + # Last 1-based PDF page to parse. When omitted, parsing ends at the last page. + # Must be greater than or equal to start when both are provided. + sig { returns(T.nilable(Integer)) } + attr_reader :end_ + + sig { params(end_: Integer).void } + attr_writer :end_ + + # When true, PDF URLs are fetched and parsed. When false, PDF URLs are skipped and + # a 400 WEBSITE_ACCESS_ERROR is returned. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :should_parse + + sig { params(should_parse: T::Boolean).void } + attr_writer :should_parse + + # First 1-based PDF page to parse. When omitted, parsing starts at the first page. + sig { returns(T.nilable(Integer)) } + attr_reader :start + + sig { params(start: Integer).void } + attr_writer :start + + # PDF parsing controls. Use start/end to limit text extraction and OCR to an + # inclusive 1-based page range. + sig do + params( + end_: Integer, + should_parse: T::Boolean, + start: Integer + ).returns(T.attached_class) + end + def self.new( + # Last 1-based PDF page to parse. When omitted, parsing ends at the last page. + # Must be greater than or equal to start when both are provided. + end_: nil, + # When true, PDF URLs are fetched and parsed. When false, PDF URLs are skipped and + # a 400 WEBSITE_ACCESS_ERROR is returned. + should_parse: nil, + # First 1-based PDF page to parse. When omitted, parsing starts at the first page. + start: nil + ) + end + + sig do + override.returns( + { end_: Integer, should_parse: T::Boolean, start: Integer } + ) + end + def to_hash + end + end end end end diff --git a/rbi/brand_dev/models/brand_web_scrape_md_params.rbi b/rbi/brand_dev/models/brand_web_scrape_md_params.rbi index 99fb2df..c3454c9 100644 --- a/rbi/brand_dev/models/brand_web_scrape_md_params.rbi +++ b/rbi/brand_dev/models/brand_web_scrape_md_params.rbi @@ -46,14 +46,13 @@ module BrandDev sig { params(max_age_ms: Integer).void } attr_writer :max_age_ms - # When true (default), PDF URLs are fetched and their text layer is extracted and - # converted to Markdown. When false, PDF URLs are skipped and a 400 - # WEBSITE_ACCESS_ERROR is returned. - sig { returns(T.nilable(T::Boolean)) } - attr_reader :parse_pdf + # PDF parsing controls. Use start/end to limit text extraction and OCR to an + # inclusive 1-based page range. + sig { returns(T.nilable(BrandDev::BrandWebScrapeMdParams::Pdf)) } + attr_reader :pdf - sig { params(parse_pdf: T::Boolean).void } - attr_writer :parse_pdf + sig { params(pdf: BrandDev::BrandWebScrapeMdParams::Pdf::OrHash).void } + attr_writer :pdf # Shorten base64-encoded image data in the Markdown output sig { returns(T.nilable(T::Boolean)) } @@ -94,7 +93,7 @@ module BrandDev include_images: T::Boolean, include_links: T::Boolean, max_age_ms: Integer, - parse_pdf: T::Boolean, + pdf: BrandDev::BrandWebScrapeMdParams::Pdf::OrHash, shorten_base64_images: T::Boolean, timeout_ms: Integer, use_main_content_only: T::Boolean, @@ -116,10 +115,9 @@ module BrandDev # younger than this many milliseconds. Defaults to 1 day (86400000 ms) when # omitted. Max is 30 days (2592000000 ms). Set to 0 to always scrape fresh. max_age_ms: nil, - # When true (default), PDF URLs are fetched and their text layer is extracted and - # converted to Markdown. When false, PDF URLs are skipped and a 400 - # WEBSITE_ACCESS_ERROR is returned. - parse_pdf: nil, + # PDF parsing controls. Use start/end to limit text extraction and OCR to an + # inclusive 1-based page range. + pdf: nil, # Shorten base64-encoded image data in the Markdown output shorten_base64_images: nil, # Optional timeout in milliseconds for the request. If the request takes longer @@ -144,7 +142,7 @@ module BrandDev include_images: T::Boolean, include_links: T::Boolean, max_age_ms: Integer, - parse_pdf: T::Boolean, + pdf: BrandDev::BrandWebScrapeMdParams::Pdf, shorten_base64_images: T::Boolean, timeout_ms: Integer, use_main_content_only: T::Boolean, @@ -155,6 +153,68 @@ module BrandDev end def to_hash end + + class Pdf < BrandDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + BrandDev::BrandWebScrapeMdParams::Pdf, + BrandDev::Internal::AnyHash + ) + end + + # Last 1-based PDF page to parse. When omitted, parsing ends at the last page. + # Must be greater than or equal to start when both are provided. + sig { returns(T.nilable(Integer)) } + attr_reader :end_ + + sig { params(end_: Integer).void } + attr_writer :end_ + + # When true, PDF URLs are fetched and parsed. When false, PDF URLs are skipped and + # a 400 WEBSITE_ACCESS_ERROR is returned. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :should_parse + + sig { params(should_parse: T::Boolean).void } + attr_writer :should_parse + + # First 1-based PDF page to parse. When omitted, parsing starts at the first page. + sig { returns(T.nilable(Integer)) } + attr_reader :start + + sig { params(start: Integer).void } + attr_writer :start + + # PDF parsing controls. Use start/end to limit text extraction and OCR to an + # inclusive 1-based page range. + sig do + params( + end_: Integer, + should_parse: T::Boolean, + start: Integer + ).returns(T.attached_class) + end + def self.new( + # Last 1-based PDF page to parse. When omitted, parsing ends at the last page. + # Must be greater than or equal to start when both are provided. + end_: nil, + # When true, PDF URLs are fetched and parsed. When false, PDF URLs are skipped and + # a 400 WEBSITE_ACCESS_ERROR is returned. + should_parse: nil, + # First 1-based PDF page to parse. When omitted, parsing starts at the first page. + start: nil + ) + end + + sig do + override.returns( + { end_: Integer, should_parse: T::Boolean, start: Integer } + ) + end + def to_hash + end + end end end end diff --git a/rbi/brand_dev/resources/brand.rbi b/rbi/brand_dev/resources/brand.rbi index f8953a3..421d7a3 100644 --- a/rbi/brand_dev/resources/brand.rbi +++ b/rbi/brand_dev/resources/brand.rbi @@ -386,7 +386,7 @@ module BrandDev url: String, include_frames: T::Boolean, max_age_ms: Integer, - parse_pdf: T::Boolean, + pdf: BrandDev::BrandWebScrapeHTMLParams::Pdf::OrHash, timeout_ms: Integer, wait_for_ms: Integer, request_options: BrandDev::RequestOptions::OrHash @@ -401,10 +401,9 @@ module BrandDev # younger than this many milliseconds. Defaults to 1 day (86400000 ms) when # omitted. Max is 30 days (2592000000 ms). Set to 0 to always scrape fresh. max_age_ms: nil, - # When true (default), PDF URLs are fetched and their text layer is extracted and - # returned wrapped in …. When false, PDF URLs are skipped - # and a 400 WEBSITE_ACCESS_ERROR is returned. - parse_pdf: nil, + # PDF parsing controls. Use start/end to limit text extraction and OCR to an + # inclusive 1-based page range. + pdf: nil, # Optional timeout in milliseconds for the request. If the request takes longer # than this value, it will be aborted with a 408 status code. Maximum allowed # value is 300000ms (5 minutes). @@ -458,7 +457,7 @@ module BrandDev include_images: T::Boolean, include_links: T::Boolean, max_age_ms: Integer, - parse_pdf: T::Boolean, + pdf: BrandDev::BrandWebScrapeMdParams::Pdf::OrHash, shorten_base64_images: T::Boolean, timeout_ms: Integer, use_main_content_only: T::Boolean, @@ -480,10 +479,9 @@ module BrandDev # younger than this many milliseconds. Defaults to 1 day (86400000 ms) when # omitted. Max is 30 days (2592000000 ms). Set to 0 to always scrape fresh. max_age_ms: nil, - # When true (default), PDF URLs are fetched and their text layer is extracted and - # converted to Markdown. When false, PDF URLs are skipped and a 400 - # WEBSITE_ACCESS_ERROR is returned. - parse_pdf: nil, + # PDF parsing controls. Use start/end to limit text extraction and OCR to an + # inclusive 1-based page range. + pdf: nil, # Shorten base64-encoded image data in the Markdown output shorten_base64_images: nil, # Optional timeout in milliseconds for the request. If the request takes longer diff --git a/sig/brand_dev/models/brand_web_scrape_html_params.rbs b/sig/brand_dev/models/brand_web_scrape_html_params.rbs index 00d3338..b9e9f8f 100644 --- a/sig/brand_dev/models/brand_web_scrape_html_params.rbs +++ b/sig/brand_dev/models/brand_web_scrape_html_params.rbs @@ -5,7 +5,7 @@ module BrandDev url: String, include_frames: bool, max_age_ms: Integer, - parse_pdf: bool, + pdf: BrandDev::BrandWebScrapeHTMLParams::Pdf, timeout_ms: Integer, wait_for_ms: Integer } @@ -25,9 +25,11 @@ module BrandDev def max_age_ms=: (Integer) -> Integer - attr_reader parse_pdf: bool? + attr_reader pdf: BrandDev::BrandWebScrapeHTMLParams::Pdf? - def parse_pdf=: (bool) -> bool + def pdf=: ( + BrandDev::BrandWebScrapeHTMLParams::Pdf + ) -> BrandDev::BrandWebScrapeHTMLParams::Pdf attr_reader timeout_ms: Integer? @@ -41,7 +43,7 @@ module BrandDev url: String, ?include_frames: bool, ?max_age_ms: Integer, - ?parse_pdf: bool, + ?pdf: BrandDev::BrandWebScrapeHTMLParams::Pdf, ?timeout_ms: Integer, ?wait_for_ms: Integer, ?request_options: BrandDev::request_opts @@ -51,11 +53,35 @@ module BrandDev url: String, include_frames: bool, max_age_ms: Integer, - parse_pdf: bool, + pdf: BrandDev::BrandWebScrapeHTMLParams::Pdf, timeout_ms: Integer, wait_for_ms: Integer, request_options: BrandDev::RequestOptions } + + type pdf = { end_: Integer, should_parse: bool, start: Integer } + + class Pdf < BrandDev::Internal::Type::BaseModel + attr_reader end_: Integer? + + def end_=: (Integer) -> Integer + + attr_reader should_parse: bool? + + def should_parse=: (bool) -> bool + + attr_reader start: Integer? + + def start=: (Integer) -> Integer + + def initialize: ( + ?end_: Integer, + ?should_parse: bool, + ?start: Integer + ) -> void + + def to_hash: -> { end_: Integer, should_parse: bool, start: Integer } + end end end end diff --git a/sig/brand_dev/models/brand_web_scrape_md_params.rbs b/sig/brand_dev/models/brand_web_scrape_md_params.rbs index 2d80d2b..5924c4c 100644 --- a/sig/brand_dev/models/brand_web_scrape_md_params.rbs +++ b/sig/brand_dev/models/brand_web_scrape_md_params.rbs @@ -7,7 +7,7 @@ module BrandDev include_images: bool, include_links: bool, max_age_ms: Integer, - parse_pdf: bool, + pdf: BrandDev::BrandWebScrapeMdParams::Pdf, :shorten_base64_images => bool, timeout_ms: Integer, use_main_content_only: bool, @@ -37,9 +37,11 @@ module BrandDev def max_age_ms=: (Integer) -> Integer - attr_reader parse_pdf: bool? + attr_reader pdf: BrandDev::BrandWebScrapeMdParams::Pdf? - def parse_pdf=: (bool) -> bool + def pdf=: ( + BrandDev::BrandWebScrapeMdParams::Pdf + ) -> BrandDev::BrandWebScrapeMdParams::Pdf attr_reader shorten_base64_images: bool? @@ -63,7 +65,7 @@ module BrandDev ?include_images: bool, ?include_links: bool, ?max_age_ms: Integer, - ?parse_pdf: bool, + ?pdf: BrandDev::BrandWebScrapeMdParams::Pdf, ?shorten_base64_images: bool, ?timeout_ms: Integer, ?use_main_content_only: bool, @@ -77,13 +79,37 @@ module BrandDev include_images: bool, include_links: bool, max_age_ms: Integer, - parse_pdf: bool, + pdf: BrandDev::BrandWebScrapeMdParams::Pdf, :shorten_base64_images => bool, timeout_ms: Integer, use_main_content_only: bool, wait_for_ms: Integer, request_options: BrandDev::RequestOptions } + + type pdf = { end_: Integer, should_parse: bool, start: Integer } + + class Pdf < BrandDev::Internal::Type::BaseModel + attr_reader end_: Integer? + + def end_=: (Integer) -> Integer + + attr_reader should_parse: bool? + + def should_parse=: (bool) -> bool + + attr_reader start: Integer? + + def start=: (Integer) -> Integer + + def initialize: ( + ?end_: Integer, + ?should_parse: bool, + ?start: Integer + ) -> void + + def to_hash: -> { end_: Integer, should_parse: bool, start: Integer } + end end end end diff --git a/sig/brand_dev/resources/brand.rbs b/sig/brand_dev/resources/brand.rbs index ff845c7..ab51a1c 100644 --- a/sig/brand_dev/resources/brand.rbs +++ b/sig/brand_dev/resources/brand.rbs @@ -104,7 +104,7 @@ module BrandDev url: String, ?include_frames: bool, ?max_age_ms: Integer, - ?parse_pdf: bool, + ?pdf: BrandDev::BrandWebScrapeHTMLParams::Pdf, ?timeout_ms: Integer, ?wait_for_ms: Integer, ?request_options: BrandDev::request_opts @@ -125,7 +125,7 @@ module BrandDev ?include_images: bool, ?include_links: bool, ?max_age_ms: Integer, - ?parse_pdf: bool, + ?pdf: BrandDev::BrandWebScrapeMdParams::Pdf, ?shorten_base64_images: bool, ?timeout_ms: Integer, ?use_main_content_only: bool, From a11b807cd4d1108f74b1f545bb2d590f09568775 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 11 May 2026 01:42:35 +0000 Subject: [PATCH 47/82] codegen metadata --- .stats.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.stats.yml b/.stats.yml index dd6dd37..decd771 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 16 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-2ed135a665bd4f01ec462096a6e19597f06356121646256cee090d1156fbfd45.yml -openapi_spec_hash: 03039640f82e64d738a57f3d3af4445e +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-9d3ae65f98566401c376518084a07e8ff20ecd2742b26b82ba72b35f63c6b6ca.yml +openapi_spec_hash: bc97527ca3317e0665ed1bf48caf85c8 config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 From 22cacc42bdcdbd193860242d02f64db983c4b0fb Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 11 May 2026 01:46:59 +0000 Subject: [PATCH 48/82] codegen metadata --- .stats.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.stats.yml b/.stats.yml index decd771..b047dd6 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 16 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-9d3ae65f98566401c376518084a07e8ff20ecd2742b26b82ba72b35f63c6b6ca.yml -openapi_spec_hash: bc97527ca3317e0665ed1bf48caf85c8 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-1a6ed1d226f13ac921b4cc545f03accce635e59b7b3150b12cc7d53d262e513d.yml +openapi_spec_hash: 9c0246fcd737ffd9c984d4e9ebc64736 config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 From 9e7cbab0ff3c85029befb343c95ef4d4437abff9 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Wed, 13 May 2026 02:57:41 +0000 Subject: [PATCH 49/82] ci: pin GitHub Actions to commit SHAs Pin all GitHub Actions referenced in generated workflows (both first-party `actions/*` and third-party) to immutable commit SHAs. Updating pinned actions is now a deliberate codegen-side bump rather than implicit on every workflow run. --- .github/workflows/ci.yml | 14 +++++++------- .github/workflows/publish-gem.yml | 4 ++-- .github/workflows/release-doctor.yml | 2 +- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 7f2d985..9036734 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -26,9 +26,9 @@ jobs: github.repository == 'stainless-sdks/brand.dev-ruby' && (github.event_name == 'push' || github.event.pull_request.head.repo.fork) && (github.event_name != 'push' || github.event.head_commit.message != 'codegen metadata') steps: - - uses: actions/checkout@v6 + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 - name: Set up Ruby - uses: ruby/setup-ruby@v1 + uses: ruby/setup-ruby@c4e5b1316158f92e3d49443a9d58b31d25ac0f8f # v1.306.0 with: bundler-cache: false - run: |- @@ -39,7 +39,7 @@ jobs: github.repository == 'stainless-sdks/brand.dev-ruby' && !startsWith(github.ref, 'refs/heads/stl/') id: github-oidc - uses: actions/github-script@v8 + uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8.0.0 with: script: core.setOutput('github_token', await core.getIDToken()); @@ -60,9 +60,9 @@ jobs: if: github.event_name == 'push' || github.event.pull_request.head.repo.fork steps: - - uses: actions/checkout@v6 + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 - name: Set up Ruby - uses: ruby/setup-ruby@v1 + uses: ruby/setup-ruby@c4e5b1316158f92e3d49443a9d58b31d25ac0f8f # v1.306.0 with: bundler-cache: false - run: |- @@ -76,9 +76,9 @@ jobs: runs-on: ${{ github.repository == 'stainless-sdks/brand.dev-ruby' && 'depot-ubuntu-24.04' || 'ubuntu-latest' }} if: github.event_name == 'push' || github.event.pull_request.head.repo.fork steps: - - uses: actions/checkout@v6 + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 - name: Set up Ruby - uses: ruby/setup-ruby@v1 + uses: ruby/setup-ruby@c4e5b1316158f92e3d49443a9d58b31d25ac0f8f # v1.306.0 with: bundler-cache: false - run: |- diff --git a/.github/workflows/publish-gem.yml b/.github/workflows/publish-gem.yml index 05489ff..68e2b95 100644 --- a/.github/workflows/publish-gem.yml +++ b/.github/workflows/publish-gem.yml @@ -14,9 +14,9 @@ jobs: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v6 + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 - name: Set up Ruby - uses: ruby/setup-ruby@v1 + uses: ruby/setup-ruby@c4e5b1316158f92e3d49443a9d58b31d25ac0f8f # v1.306.0 with: bundler-cache: false - run: |- diff --git a/.github/workflows/release-doctor.yml b/.github/workflows/release-doctor.yml index 54e2e26..7e642cc 100644 --- a/.github/workflows/release-doctor.yml +++ b/.github/workflows/release-doctor.yml @@ -12,7 +12,7 @@ jobs: if: github.repository == 'context-dot-dev/deprecated-brand-ruby-sdk' && (github.event_name == 'push' || github.event_name == 'workflow_dispatch' || startsWith(github.head_ref, 'release-please') || github.head_ref == 'next') steps: - - uses: actions/checkout@v6 + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 - name: Check release environment run: | From 1b864c845999011a26c433ddd801c050aed7a197 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 14 May 2026 03:55:18 +0000 Subject: [PATCH 50/82] fix(client): elide content type header on requests without body --- lib/brand_dev/internal/transport/base_client.rb | 2 ++ test/brand_dev/client_test.rb | 9 +++++---- 2 files changed, 7 insertions(+), 4 deletions(-) diff --git a/lib/brand_dev/internal/transport/base_client.rb b/lib/brand_dev/internal/transport/base_client.rb index 74ae2ef..b7847ac 100644 --- a/lib/brand_dev/internal/transport/base_client.rb +++ b/lib/brand_dev/internal/transport/base_client.rb @@ -306,6 +306,8 @@ def initialize( BrandDev::Internal::Util.deep_merge(*[req[:body], opts[:extra_body]].compact) end + headers.delete("content-type") if body.nil? + url = BrandDev::Internal::Util.join_parsed_uri( @base_url_components, {**req, path: path, query: query} diff --git a/test/brand_dev/client_test.rb b/test/brand_dev/client_test.rb index ece2b3a..63c1257 100644 --- a/test/brand_dev/client_test.rb +++ b/test/brand_dev/client_test.rb @@ -206,8 +206,8 @@ def test_client_redirect_307 assert_equal(recorded.method, _1.method) assert_equal(recorded.body, _1.body) assert_equal( - recorded.headers.transform_keys(&:downcase).fetch("content-type"), - _1.headers.transform_keys(&:downcase).fetch("content-type") + recorded.headers.transform_keys(&:downcase)["content-type"], + _1.headers.transform_keys(&:downcase)["content-type"] ) end end @@ -300,8 +300,9 @@ def test_default_headers brand_dev.brand.retrieve(domain: "domain") assert_requested(:any, /./) do |req| - headers = req.headers.transform_keys(&:downcase).fetch_values("accept", "content-type") - headers.each { refute_empty(_1) } + headers = req.headers.transform_keys(&:downcase) + expected = req.body.nil? ? ["accept"] : %w[accept content-type] + headers.fetch_values(*expected).each { refute_empty(_1) } end end end From 515175b9a0ad0bc2b820b0e285f231e6699629a5 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sat, 16 May 2026 16:26:26 +0000 Subject: [PATCH 51/82] codegen metadata --- .stats.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.stats.yml b/.stats.yml index b047dd6..7381cdd 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 16 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-1a6ed1d226f13ac921b4cc545f03accce635e59b7b3150b12cc7d53d262e513d.yml -openapi_spec_hash: 9c0246fcd737ffd9c984d4e9ebc64736 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-12e9deaf43f690da9fa9319d4e93e4f8f6184e09badcc83e2b1f0c4891cf6ce3.yml +openapi_spec_hash: b18735a3f4c73c37fbb60515c9b8c346 config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 From cb4667428bcbb524d722ac8f8f93bae082be4a09 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sat, 16 May 2026 16:51:04 +0000 Subject: [PATCH 52/82] codegen metadata --- .stats.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.stats.yml b/.stats.yml index 7381cdd..5f9bc77 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 16 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-12e9deaf43f690da9fa9319d4e93e4f8f6184e09badcc83e2b1f0c4891cf6ce3.yml -openapi_spec_hash: b18735a3f4c73c37fbb60515c9b8c346 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-ea848da22c7fabe9073064f70f12a618993846ecc5dfedbc24a0326b9f1f6fdb.yml +openapi_spec_hash: 284bb75c275d0084eb650847c4076fe4 config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 From 64e5f1106ea355f509fe44f369ddc6670e15f0e7 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sat, 16 May 2026 17:13:03 +0000 Subject: [PATCH 53/82] codegen metadata --- .stats.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.stats.yml b/.stats.yml index 5f9bc77..b034d58 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 16 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-ea848da22c7fabe9073064f70f12a618993846ecc5dfedbc24a0326b9f1f6fdb.yml -openapi_spec_hash: 284bb75c275d0084eb650847c4076fe4 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-5cf59db203bea5af40ea44e7ffc26b503361856a760e997da46e64528dd15b46.yml +openapi_spec_hash: a1273d28c2439dae91074a21b866740c config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 From 4ae15f322bfd0c11e19a5438716cc318e9b8c2bf Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sat, 16 May 2026 17:21:40 +0000 Subject: [PATCH 54/82] codegen metadata --- .stats.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.stats.yml b/.stats.yml index b034d58..1d491ca 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 16 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-5cf59db203bea5af40ea44e7ffc26b503361856a760e997da46e64528dd15b46.yml -openapi_spec_hash: a1273d28c2439dae91074a21b866740c +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-cce6310a59a9676fe3aad74b5a24bbc5f1899767b71b3c912e34d50496d2d03f.yml +openapi_spec_hash: 9e97e5d4745c4fdbbc3269e9013d4094 config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 From ab2ccb17a6ba8b61840a59b1f3a7f3ccc5aa7ad6 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 19 May 2026 14:27:18 +0000 Subject: [PATCH 55/82] feat(api): api update --- .stats.yml | 4 ++-- lib/brand_dev/resources/brand.rb | 4 ++-- rbi/brand_dev/resources/brand.rbi | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/.stats.yml b/.stats.yml index 1d491ca..1891309 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 16 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-cce6310a59a9676fe3aad74b5a24bbc5f1899767b71b3c912e34d50496d2d03f.yml -openapi_spec_hash: 9e97e5d4745c4fdbbc3269e9013d4094 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-1bc9121ee0f64a15a503b5ec2a7836edfb1e2bf561d22f598ff3cf8f40381a9c.yml +openapi_spec_hash: e4980adb7bd8a6a37a1dbb7f35585b79 config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 diff --git a/lib/brand_dev/resources/brand.rb b/lib/brand_dev/resources/brand.rb index ddc0aa3..3d0b691 100644 --- a/lib/brand_dev/resources/brand.rb +++ b/lib/brand_dev/resources/brand.rb @@ -446,8 +446,8 @@ def web_scrape_html(params) # # Extract image assets from a web page, including standard URLs, inline SVGs, data # URIs, responsive image sources, metadata, CSS backgrounds, video posters, and - # embeds. The base request costs 1 credit; enrichment costs 1 credit per returned - # image. + # embeds. The base request costs 1 credit. When enrichment is enabled, the entire + # call costs 5 credits. # # @overload web_scrape_images(url:, enrichment: nil, max_age_ms: nil, timeout_ms: nil, wait_for_ms: nil, request_options: {}) # diff --git a/rbi/brand_dev/resources/brand.rbi b/rbi/brand_dev/resources/brand.rbi index 421d7a3..9a7558d 100644 --- a/rbi/brand_dev/resources/brand.rbi +++ b/rbi/brand_dev/resources/brand.rbi @@ -417,8 +417,8 @@ module BrandDev # Extract image assets from a web page, including standard URLs, inline SVGs, data # URIs, responsive image sources, metadata, CSS backgrounds, video posters, and - # embeds. The base request costs 1 credit; enrichment costs 1 credit per returned - # image. + # embeds. The base request costs 1 credit. When enrichment is enabled, the entire + # call costs 5 credits. sig do params( url: String, From 4900ffb14068b5447967bf61a0e335d9fed6a59d Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sat, 30 May 2026 18:04:51 +0000 Subject: [PATCH 56/82] codegen metadata --- .stats.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.stats.yml b/.stats.yml index 1891309..a6a8eef 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 16 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-1bc9121ee0f64a15a503b5ec2a7836edfb1e2bf561d22f598ff3cf8f40381a9c.yml -openapi_spec_hash: e4980adb7bd8a6a37a1dbb7f35585b79 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-0b3011817c67eccaecd7deffad948f2fcd5408a04c584c3de83d69129e8bbea9.yml +openapi_spec_hash: a35cd63ce6fc1124b4ef13f63e7e29cb config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 From 2f567ab7e2828569fc5ca63a0fbd20c57dd4dafe Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sun, 31 May 2026 19:16:41 +0000 Subject: [PATCH 57/82] codegen metadata --- .stats.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.stats.yml b/.stats.yml index a6a8eef..81725ad 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 16 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-0b3011817c67eccaecd7deffad948f2fcd5408a04c584c3de83d69129e8bbea9.yml -openapi_spec_hash: a35cd63ce6fc1124b4ef13f63e7e29cb +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-f17d27c370b0b4d6ac476ac3b6bdfcb099c7c877d7f9de5e170219601dac00ba.yml +openapi_spec_hash: 89afb32832b6c8768d0150089a026e1b config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 From c9c0d37462d7c5a100c32e9e40a76c201f5831f7 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sun, 31 May 2026 20:16:21 +0000 Subject: [PATCH 58/82] codegen metadata --- .stats.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.stats.yml b/.stats.yml index 81725ad..b9027d8 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 16 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-f17d27c370b0b4d6ac476ac3b6bdfcb099c7c877d7f9de5e170219601dac00ba.yml -openapi_spec_hash: 89afb32832b6c8768d0150089a026e1b +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-10ec1bc74f69831a4fbc461c6defa14030681cbeebb351760fe8e5ce5d1c3421.yml +openapi_spec_hash: 393bb6cb95846763248d6f737271e653 config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 From 6fd671315f130903279b1ac7295f76540ec793d8 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sun, 31 May 2026 21:54:42 +0000 Subject: [PATCH 59/82] codegen metadata --- .stats.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.stats.yml b/.stats.yml index b9027d8..12206a6 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 16 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-10ec1bc74f69831a4fbc461c6defa14030681cbeebb351760fe8e5ce5d1c3421.yml -openapi_spec_hash: 393bb6cb95846763248d6f737271e653 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-c534e82e2da624a7c3d9843652132db3791a91eef51c777d039e23e3d45f1ece.yml +openapi_spec_hash: 4c260d71b003474c4d29754cf928fc2d config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 From e4653de7f023f61344c76c95d6afa622966df69e Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sun, 31 May 2026 23:16:49 +0000 Subject: [PATCH 60/82] codegen metadata --- .stats.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.stats.yml b/.stats.yml index 12206a6..049c672 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 16 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-c534e82e2da624a7c3d9843652132db3791a91eef51c777d039e23e3d45f1ece.yml -openapi_spec_hash: 4c260d71b003474c4d29754cf928fc2d +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-e432c523efb3bfd0f768b85458c715480ce33b2289b1505971819502e72a220c.yml +openapi_spec_hash: ddef4e7240549c27374c98bac65a44da config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 From 147091ac7840e09b91718ee549dd004f529fac06 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 1 Jun 2026 02:49:39 +0000 Subject: [PATCH 61/82] codegen metadata --- .stats.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.stats.yml b/.stats.yml index 049c672..3843818 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 16 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-e432c523efb3bfd0f768b85458c715480ce33b2289b1505971819502e72a220c.yml -openapi_spec_hash: ddef4e7240549c27374c98bac65a44da +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-e4447a53f29d624f1458d2d56b406e12b124333eda14bb67aa6497d7bbf1e705.yml +openapi_spec_hash: df5979d99fd7c4e6546c5dadcbd47b5e config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 From df9c0633eb879c5f70af499b43841bbb93364de5 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 1 Jun 2026 21:02:50 +0000 Subject: [PATCH 62/82] codegen metadata --- .stats.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.stats.yml b/.stats.yml index 3843818..f805046 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 16 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-e4447a53f29d624f1458d2d56b406e12b124333eda14bb67aa6497d7bbf1e705.yml -openapi_spec_hash: df5979d99fd7c4e6546c5dadcbd47b5e +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-86ee5da44d1b12e8bda41916b716e48f4c7634c539bef7bf5335f55a34616ac8.yml +openapi_spec_hash: d8c32416241035412c6b07aab88395cb config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 From 75537f68d5414a6f94aae7ffc376883b953f1ec4 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sat, 6 Jun 2026 10:43:57 +0000 Subject: [PATCH 63/82] codegen metadata --- .stats.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.stats.yml b/.stats.yml index f805046..41f55e4 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 16 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-86ee5da44d1b12e8bda41916b716e48f4c7634c539bef7bf5335f55a34616ac8.yml -openapi_spec_hash: d8c32416241035412c6b07aab88395cb +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-19f8905993677bfe20e73de262153f3ff68507ed685031d1514f76eaca40cd06.yml +openapi_spec_hash: d36d3ca40ef653a89660b2967d6f592e config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 From 024b8092bc79d6ed4616fe4b83993c07c93233f3 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sat, 6 Jun 2026 11:06:09 +0000 Subject: [PATCH 64/82] codegen metadata --- .stats.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.stats.yml b/.stats.yml index 41f55e4..bc82c92 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 16 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-19f8905993677bfe20e73de262153f3ff68507ed685031d1514f76eaca40cd06.yml -openapi_spec_hash: d36d3ca40ef653a89660b2967d6f592e +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-2fd1d538ce72b2e2a8cc6ab0d00638b30c2c156e5cf273d91ba6618564b2a696.yml +openapi_spec_hash: a1ba1d14a1e783d5d494d95a9188e710 config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 From 86191d35ff397f5c84ac498f5caa9e2e439bc53c Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sat, 6 Jun 2026 11:09:23 +0000 Subject: [PATCH 65/82] codegen metadata --- .stats.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.stats.yml b/.stats.yml index bc82c92..2b9672e 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 16 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-2fd1d538ce72b2e2a8cc6ab0d00638b30c2c156e5cf273d91ba6618564b2a696.yml -openapi_spec_hash: a1ba1d14a1e783d5d494d95a9188e710 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-141a124a7556308d98115f190fc73a433ab39286ebad780604f8eb076ca23e48.yml +openapi_spec_hash: 434ca3f02912e54b70d3c85f3e317954 config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 From bf6d7887d1eaef302ac98b2dbfde9079b17872ca Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sat, 6 Jun 2026 11:55:19 +0000 Subject: [PATCH 66/82] codegen metadata --- .stats.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.stats.yml b/.stats.yml index 2b9672e..4c45902 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 16 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-141a124a7556308d98115f190fc73a433ab39286ebad780604f8eb076ca23e48.yml -openapi_spec_hash: 434ca3f02912e54b70d3c85f3e317954 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-68b097a33ef54d278ffead558342d6dde258f1f42ce5f74d8cff16b925dd5510.yml +openapi_spec_hash: bb9c40c477e932de35d100f4e0e85b3e config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 From c7844bf1d3c8b454fb0bee944920a15b0cb2b06c Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sat, 6 Jun 2026 14:07:46 +0000 Subject: [PATCH 67/82] feat(api): api update --- .stats.yml | 4 ++-- .../models/brand_web_scrape_html_params.rb | 12 ++++++++++- .../models/brand_web_scrape_images_params.rb | 12 ++++++++++- .../models/brand_web_scrape_md_params.rb | 12 ++++++++++- .../models/brand_web_scrape_sitemap_params.rb | 12 ++++++++++- lib/brand_dev/resources/brand.rb | 16 +++++++++++---- .../models/brand_web_scrape_html_params.rbi | 15 ++++++++++++++ .../models/brand_web_scrape_images_params.rbi | 15 ++++++++++++++ .../models/brand_web_scrape_md_params.rbi | 15 ++++++++++++++ .../brand_web_scrape_sitemap_params.rbi | 15 ++++++++++++++ rbi/brand_dev/resources/brand.rbi | 20 +++++++++++++++++++ .../models/brand_web_scrape_html_params.rbs | 7 +++++++ .../models/brand_web_scrape_images_params.rbs | 7 +++++++ .../models/brand_web_scrape_md_params.rbs | 7 +++++++ .../brand_web_scrape_sitemap_params.rbs | 7 +++++++ sig/brand_dev/resources/brand.rbs | 4 ++++ 16 files changed, 170 insertions(+), 10 deletions(-) diff --git a/.stats.yml b/.stats.yml index 4c45902..a162a04 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 16 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-68b097a33ef54d278ffead558342d6dde258f1f42ce5f74d8cff16b925dd5510.yml -openapi_spec_hash: bb9c40c477e932de35d100f4e0e85b3e +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-6ed467d40802bbe92c036743ad980f3cb986626e18a8e3b743e05382eee00b97.yml +openapi_spec_hash: 5fb10c717fc138f1202f8395b37713db config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 diff --git a/lib/brand_dev/models/brand_web_scrape_html_params.rb b/lib/brand_dev/models/brand_web_scrape_html_params.rb index ce7df60..79c3173 100644 --- a/lib/brand_dev/models/brand_web_scrape_html_params.rb +++ b/lib/brand_dev/models/brand_web_scrape_html_params.rb @@ -13,6 +13,14 @@ class BrandWebScrapeHTMLParams < BrandDev::Internal::Type::BaseModel # @return [String] required :url, String + # @!attribute headers + # Optional outbound HTTP headers forwarded only to the target URL, sent as + # deep-object query params such as headers[X-Custom]=value. When provided, caching + # is bypassed: the result is neither read from nor written to cache. + # + # @return [Hash{Symbol=>String}, nil] + optional :headers, BrandDev::Internal::Type::HashOf[String] + # @!attribute include_frames # When true, iframes are rendered inline into the returned HTML. # @@ -49,12 +57,14 @@ class BrandWebScrapeHTMLParams < BrandDev::Internal::Type::BaseModel # @return [Integer, nil] optional :wait_for_ms, Integer - # @!method initialize(url:, include_frames: nil, max_age_ms: nil, pdf: nil, timeout_ms: nil, wait_for_ms: nil, request_options: {}) + # @!method initialize(url:, headers: nil, include_frames: nil, max_age_ms: nil, pdf: nil, timeout_ms: nil, wait_for_ms: nil, request_options: {}) # Some parameter documentations has been truncated, see # {BrandDev::Models::BrandWebScrapeHTMLParams} for more details. # # @param url [String] Full URL to scrape (must include http:// or https:// protocol) # + # @param headers [Hash{Symbol=>String}] Optional outbound HTTP headers forwarded only to the target URL, sent as deep-ob + # # @param include_frames [Boolean] When true, iframes are rendered inline into the returned HTML. # # @param max_age_ms [Integer] Return a cached result if a prior scrape for the same parameters exists and is y diff --git a/lib/brand_dev/models/brand_web_scrape_images_params.rb b/lib/brand_dev/models/brand_web_scrape_images_params.rb index 806500c..cf734bb 100644 --- a/lib/brand_dev/models/brand_web_scrape_images_params.rb +++ b/lib/brand_dev/models/brand_web_scrape_images_params.rb @@ -20,6 +20,14 @@ class BrandWebScrapeImagesParams < BrandDev::Internal::Type::BaseModel # @return [BrandDev::Models::BrandWebScrapeImagesParams::Enrichment, nil] optional :enrichment, -> { BrandDev::BrandWebScrapeImagesParams::Enrichment } + # @!attribute headers + # Optional outbound HTTP headers forwarded only to the target URL, sent as + # deep-object query params such as headers[X-Custom]=value. When provided, caching + # is bypassed: the result is neither read from nor written to cache. + # + # @return [Hash{Symbol=>String}, nil] + optional :headers, BrandDev::Internal::Type::HashOf[String] + # @!attribute max_age_ms # Reuse a cached result this many milliseconds old or newer. Default: 86400000 (1 # day). Set to 0 to bypass cache. Maximum: 2592000000 (30 days). @@ -42,7 +50,7 @@ class BrandWebScrapeImagesParams < BrandDev::Internal::Type::BaseModel # @return [Integer, nil] optional :wait_for_ms, Integer - # @!method initialize(url:, enrichment: nil, max_age_ms: nil, timeout_ms: nil, wait_for_ms: nil, request_options: {}) + # @!method initialize(url:, enrichment: nil, headers: nil, max_age_ms: nil, timeout_ms: nil, wait_for_ms: nil, request_options: {}) # Some parameter documentations has been truncated, see # {BrandDev::Models::BrandWebScrapeImagesParams} for more details. # @@ -50,6 +58,8 @@ class BrandWebScrapeImagesParams < BrandDev::Internal::Type::BaseModel # # @param enrichment [BrandDev::Models::BrandWebScrapeImagesParams::Enrichment] Optional per-image processing, sent as deep-object query params such as enrichme # + # @param headers [Hash{Symbol=>String}] Optional outbound HTTP headers forwarded only to the target URL, sent as deep-ob + # # @param max_age_ms [Integer] Reuse a cached result this many milliseconds old or newer. Default: 86400000 (1 # # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th diff --git a/lib/brand_dev/models/brand_web_scrape_md_params.rb b/lib/brand_dev/models/brand_web_scrape_md_params.rb index 8511327..2854860 100644 --- a/lib/brand_dev/models/brand_web_scrape_md_params.rb +++ b/lib/brand_dev/models/brand_web_scrape_md_params.rb @@ -14,6 +14,14 @@ class BrandWebScrapeMdParams < BrandDev::Internal::Type::BaseModel # @return [String] required :url, String + # @!attribute headers + # Optional outbound HTTP headers forwarded only to the target URL, sent as + # deep-object query params such as headers[X-Custom]=value. When provided, caching + # is bypassed: the result is neither read from nor written to cache. + # + # @return [Hash{Symbol=>String}, nil] + optional :headers, BrandDev::Internal::Type::HashOf[String] + # @!attribute include_frames # When true, the contents of iframes are rendered to Markdown. # @@ -75,12 +83,14 @@ class BrandWebScrapeMdParams < BrandDev::Internal::Type::BaseModel # @return [Integer, nil] optional :wait_for_ms, Integer - # @!method initialize(url:, include_frames: nil, include_images: nil, include_links: nil, max_age_ms: nil, pdf: nil, shorten_base64_images: nil, timeout_ms: nil, use_main_content_only: nil, wait_for_ms: nil, request_options: {}) + # @!method initialize(url:, headers: nil, include_frames: nil, include_images: nil, include_links: nil, max_age_ms: nil, pdf: nil, shorten_base64_images: nil, timeout_ms: nil, use_main_content_only: nil, wait_for_ms: nil, request_options: {}) # Some parameter documentations has been truncated, see # {BrandDev::Models::BrandWebScrapeMdParams} for more details. # # @param url [String] Full URL to scrape into LLM usable Markdown (must include http:// or https:// pr # + # @param headers [Hash{Symbol=>String}] Optional outbound HTTP headers forwarded only to the target URL, sent as deep-ob + # # @param include_frames [Boolean] When true, the contents of iframes are rendered to Markdown. # # @param include_images [Boolean] Include image references in Markdown output diff --git a/lib/brand_dev/models/brand_web_scrape_sitemap_params.rb b/lib/brand_dev/models/brand_web_scrape_sitemap_params.rb index 39a13fb..28b67ed 100644 --- a/lib/brand_dev/models/brand_web_scrape_sitemap_params.rb +++ b/lib/brand_dev/models/brand_web_scrape_sitemap_params.rb @@ -13,6 +13,14 @@ class BrandWebScrapeSitemapParams < BrandDev::Internal::Type::BaseModel # @return [String] required :domain, String + # @!attribute headers + # Optional outbound HTTP headers forwarded only to the target URL, sent as + # deep-object query params such as headers[X-Custom]=value. When provided, caching + # is bypassed: the result is neither read from nor written to cache. + # + # @return [Hash{Symbol=>String}, nil] + optional :headers, BrandDev::Internal::Type::HashOf[String] + # @!attribute max_links # Maximum number of links to return from the sitemap crawl. Defaults to 10,000. # Minimum is 1, maximum is 100,000. @@ -35,12 +43,14 @@ class BrandWebScrapeSitemapParams < BrandDev::Internal::Type::BaseModel # @return [String, nil] optional :url_regex, String - # @!method initialize(domain:, max_links: nil, timeout_ms: nil, url_regex: nil, request_options: {}) + # @!method initialize(domain:, headers: nil, max_links: nil, timeout_ms: nil, url_regex: nil, request_options: {}) # Some parameter documentations has been truncated, see # {BrandDev::Models::BrandWebScrapeSitemapParams} for more details. # # @param domain [String] Domain to build a sitemap for # + # @param headers [Hash{Symbol=>String}] Optional outbound HTTP headers forwarded only to the target URL, sent as deep-ob + # # @param max_links [Integer] Maximum number of links to return from the sitemap crawl. Defaults to 10,000. Mi # # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th diff --git a/lib/brand_dev/resources/brand.rb b/lib/brand_dev/resources/brand.rb index 3d0b691..0f1cb9c 100644 --- a/lib/brand_dev/resources/brand.rb +++ b/lib/brand_dev/resources/brand.rb @@ -405,10 +405,12 @@ def retrieve_simplified(params) # # Scrapes the given URL and returns the raw HTML content of the page. # - # @overload web_scrape_html(url:, include_frames: nil, max_age_ms: nil, pdf: nil, timeout_ms: nil, wait_for_ms: nil, request_options: {}) + # @overload web_scrape_html(url:, headers: nil, include_frames: nil, max_age_ms: nil, pdf: nil, timeout_ms: nil, wait_for_ms: nil, request_options: {}) # # @param url [String] Full URL to scrape (must include http:// or https:// protocol) # + # @param headers [Hash{Symbol=>String}] Optional outbound HTTP headers forwarded only to the target URL, sent as deep-ob + # # @param include_frames [Boolean] When true, iframes are rendered inline into the returned HTML. # # @param max_age_ms [Integer] Return a cached result if a prior scrape for the same parameters exists and is y @@ -449,12 +451,14 @@ def web_scrape_html(params) # embeds. The base request costs 1 credit. When enrichment is enabled, the entire # call costs 5 credits. # - # @overload web_scrape_images(url:, enrichment: nil, max_age_ms: nil, timeout_ms: nil, wait_for_ms: nil, request_options: {}) + # @overload web_scrape_images(url:, enrichment: nil, headers: nil, max_age_ms: nil, timeout_ms: nil, wait_for_ms: nil, request_options: {}) # # @param url [String] Page URL to inspect. Must include http:// or https://. # # @param enrichment [BrandDev::Models::BrandWebScrapeImagesParams::Enrichment] Optional per-image processing, sent as deep-object query params such as enrichme # + # @param headers [Hash{Symbol=>String}] Optional outbound HTTP headers forwarded only to the target URL, sent as deep-ob + # # @param max_age_ms [Integer] Reuse a cached result this many milliseconds old or newer. Default: 86400000 (1 # # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th @@ -487,10 +491,12 @@ def web_scrape_images(params) # # Scrapes the given URL into LLM usable Markdown. # - # @overload web_scrape_md(url:, include_frames: nil, include_images: nil, include_links: nil, max_age_ms: nil, pdf: nil, shorten_base64_images: nil, timeout_ms: nil, use_main_content_only: nil, wait_for_ms: nil, request_options: {}) + # @overload web_scrape_md(url:, headers: nil, include_frames: nil, include_images: nil, include_links: nil, max_age_ms: nil, pdf: nil, shorten_base64_images: nil, timeout_ms: nil, use_main_content_only: nil, wait_for_ms: nil, request_options: {}) # # @param url [String] Full URL to scrape into LLM usable Markdown (must include http:// or https:// pr # + # @param headers [Hash{Symbol=>String}] Optional outbound HTTP headers forwarded only to the target URL, sent as deep-ob + # # @param include_frames [Boolean] When true, the contents of iframes are rendered to Markdown. # # @param include_images [Boolean] Include image references in Markdown output @@ -540,10 +546,12 @@ def web_scrape_md(params) # # Crawl an entire website's sitemap and return all discovered page URLs. # - # @overload web_scrape_sitemap(domain:, max_links: nil, timeout_ms: nil, url_regex: nil, request_options: {}) + # @overload web_scrape_sitemap(domain:, headers: nil, max_links: nil, timeout_ms: nil, url_regex: nil, request_options: {}) # # @param domain [String] Domain to build a sitemap for # + # @param headers [Hash{Symbol=>String}] Optional outbound HTTP headers forwarded only to the target URL, sent as deep-ob + # # @param max_links [Integer] Maximum number of links to return from the sitemap crawl. Defaults to 10,000. Mi # # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th diff --git a/rbi/brand_dev/models/brand_web_scrape_html_params.rbi b/rbi/brand_dev/models/brand_web_scrape_html_params.rbi index a6eb50b..3e99101 100644 --- a/rbi/brand_dev/models/brand_web_scrape_html_params.rbi +++ b/rbi/brand_dev/models/brand_web_scrape_html_params.rbi @@ -15,6 +15,15 @@ module BrandDev sig { returns(String) } attr_accessor :url + # Optional outbound HTTP headers forwarded only to the target URL, sent as + # deep-object query params such as headers[X-Custom]=value. When provided, caching + # is bypassed: the result is neither read from nor written to cache. + sig { returns(T.nilable(T::Hash[Symbol, String])) } + attr_reader :headers + + sig { params(headers: T::Hash[Symbol, String]).void } + attr_writer :headers + # When true, iframes are rendered inline into the returned HTML. sig { returns(T.nilable(T::Boolean)) } attr_reader :include_frames @@ -59,6 +68,7 @@ module BrandDev sig do params( url: String, + headers: T::Hash[Symbol, String], include_frames: T::Boolean, max_age_ms: Integer, pdf: BrandDev::BrandWebScrapeHTMLParams::Pdf::OrHash, @@ -70,6 +80,10 @@ module BrandDev def self.new( # Full URL to scrape (must include http:// or https:// protocol) url:, + # Optional outbound HTTP headers forwarded only to the target URL, sent as + # deep-object query params such as headers[X-Custom]=value. When provided, caching + # is bypassed: the result is neither read from nor written to cache. + headers: nil, # When true, iframes are rendered inline into the returned HTML. include_frames: nil, # Return a cached result if a prior scrape for the same parameters exists and is @@ -94,6 +108,7 @@ module BrandDev override.returns( { url: String, + headers: T::Hash[Symbol, String], include_frames: T::Boolean, max_age_ms: Integer, pdf: BrandDev::BrandWebScrapeHTMLParams::Pdf, diff --git a/rbi/brand_dev/models/brand_web_scrape_images_params.rbi b/rbi/brand_dev/models/brand_web_scrape_images_params.rbi index fa6a304..c2a21ab 100644 --- a/rbi/brand_dev/models/brand_web_scrape_images_params.rbi +++ b/rbi/brand_dev/models/brand_web_scrape_images_params.rbi @@ -32,6 +32,15 @@ module BrandDev end attr_writer :enrichment + # Optional outbound HTTP headers forwarded only to the target URL, sent as + # deep-object query params such as headers[X-Custom]=value. When provided, caching + # is bypassed: the result is neither read from nor written to cache. + sig { returns(T.nilable(T::Hash[Symbol, String])) } + attr_reader :headers + + sig { params(headers: T::Hash[Symbol, String]).void } + attr_writer :headers + # Reuse a cached result this many milliseconds old or newer. Default: 86400000 (1 # day). Set to 0 to bypass cache. Maximum: 2592000000 (30 days). sig { returns(T.nilable(Integer)) } @@ -61,6 +70,7 @@ module BrandDev params( url: String, enrichment: BrandDev::BrandWebScrapeImagesParams::Enrichment::OrHash, + headers: T::Hash[Symbol, String], max_age_ms: Integer, timeout_ms: Integer, wait_for_ms: Integer, @@ -73,6 +83,10 @@ module BrandDev # Optional per-image processing, sent as deep-object query params such as # enrichment[resolution]=true. enrichment: nil, + # Optional outbound HTTP headers forwarded only to the target URL, sent as + # deep-object query params such as headers[X-Custom]=value. When provided, caching + # is bypassed: the result is neither read from nor written to cache. + headers: nil, # Reuse a cached result this many milliseconds old or newer. Default: 86400000 (1 # day). Set to 0 to bypass cache. Maximum: 2592000000 (30 days). max_age_ms: nil, @@ -92,6 +106,7 @@ module BrandDev { url: String, enrichment: BrandDev::BrandWebScrapeImagesParams::Enrichment, + headers: T::Hash[Symbol, String], max_age_ms: Integer, timeout_ms: Integer, wait_for_ms: Integer, diff --git a/rbi/brand_dev/models/brand_web_scrape_md_params.rbi b/rbi/brand_dev/models/brand_web_scrape_md_params.rbi index c3454c9..25bf9c6 100644 --- a/rbi/brand_dev/models/brand_web_scrape_md_params.rbi +++ b/rbi/brand_dev/models/brand_web_scrape_md_params.rbi @@ -16,6 +16,15 @@ module BrandDev sig { returns(String) } attr_accessor :url + # Optional outbound HTTP headers forwarded only to the target URL, sent as + # deep-object query params such as headers[X-Custom]=value. When provided, caching + # is bypassed: the result is neither read from nor written to cache. + sig { returns(T.nilable(T::Hash[Symbol, String])) } + attr_reader :headers + + sig { params(headers: T::Hash[Symbol, String]).void } + attr_writer :headers + # When true, the contents of iframes are rendered to Markdown. sig { returns(T.nilable(T::Boolean)) } attr_reader :include_frames @@ -89,6 +98,7 @@ module BrandDev sig do params( url: String, + headers: T::Hash[Symbol, String], include_frames: T::Boolean, include_images: T::Boolean, include_links: T::Boolean, @@ -105,6 +115,10 @@ module BrandDev # Full URL to scrape into LLM usable Markdown (must include http:// or https:// # protocol) url:, + # Optional outbound HTTP headers forwarded only to the target URL, sent as + # deep-object query params such as headers[X-Custom]=value. When provided, caching + # is bypassed: the result is neither read from nor written to cache. + headers: nil, # When true, the contents of iframes are rendered to Markdown. include_frames: nil, # Include image references in Markdown output @@ -138,6 +152,7 @@ module BrandDev override.returns( { url: String, + headers: T::Hash[Symbol, String], include_frames: T::Boolean, include_images: T::Boolean, include_links: T::Boolean, diff --git a/rbi/brand_dev/models/brand_web_scrape_sitemap_params.rbi b/rbi/brand_dev/models/brand_web_scrape_sitemap_params.rbi index 6af0348..1a7a1be 100644 --- a/rbi/brand_dev/models/brand_web_scrape_sitemap_params.rbi +++ b/rbi/brand_dev/models/brand_web_scrape_sitemap_params.rbi @@ -18,6 +18,15 @@ module BrandDev sig { returns(String) } attr_accessor :domain + # Optional outbound HTTP headers forwarded only to the target URL, sent as + # deep-object query params such as headers[X-Custom]=value. When provided, caching + # is bypassed: the result is neither read from nor written to cache. + sig { returns(T.nilable(T::Hash[Symbol, String])) } + attr_reader :headers + + sig { params(headers: T::Hash[Symbol, String]).void } + attr_writer :headers + # Maximum number of links to return from the sitemap crawl. Defaults to 10,000. # Minimum is 1, maximum is 100,000. sig { returns(T.nilable(Integer)) } @@ -46,6 +55,7 @@ module BrandDev sig do params( domain: String, + headers: T::Hash[Symbol, String], max_links: Integer, timeout_ms: Integer, url_regex: String, @@ -55,6 +65,10 @@ module BrandDev def self.new( # Domain to build a sitemap for domain:, + # Optional outbound HTTP headers forwarded only to the target URL, sent as + # deep-object query params such as headers[X-Custom]=value. When provided, caching + # is bypassed: the result is neither read from nor written to cache. + headers: nil, # Maximum number of links to return from the sitemap crawl. Defaults to 10,000. # Minimum is 1, maximum is 100,000. max_links: nil, @@ -73,6 +87,7 @@ module BrandDev override.returns( { domain: String, + headers: T::Hash[Symbol, String], max_links: Integer, timeout_ms: Integer, url_regex: String, diff --git a/rbi/brand_dev/resources/brand.rbi b/rbi/brand_dev/resources/brand.rbi index 9a7558d..c7dfab4 100644 --- a/rbi/brand_dev/resources/brand.rbi +++ b/rbi/brand_dev/resources/brand.rbi @@ -384,6 +384,7 @@ module BrandDev sig do params( url: String, + headers: T::Hash[Symbol, String], include_frames: T::Boolean, max_age_ms: Integer, pdf: BrandDev::BrandWebScrapeHTMLParams::Pdf::OrHash, @@ -395,6 +396,10 @@ module BrandDev def web_scrape_html( # Full URL to scrape (must include http:// or https:// protocol) url:, + # Optional outbound HTTP headers forwarded only to the target URL, sent as + # deep-object query params such as headers[X-Custom]=value. When provided, caching + # is bypassed: the result is neither read from nor written to cache. + headers: nil, # When true, iframes are rendered inline into the returned HTML. include_frames: nil, # Return a cached result if a prior scrape for the same parameters exists and is @@ -423,6 +428,7 @@ module BrandDev params( url: String, enrichment: BrandDev::BrandWebScrapeImagesParams::Enrichment::OrHash, + headers: T::Hash[Symbol, String], max_age_ms: Integer, timeout_ms: Integer, wait_for_ms: Integer, @@ -435,6 +441,10 @@ module BrandDev # Optional per-image processing, sent as deep-object query params such as # enrichment[resolution]=true. enrichment: nil, + # Optional outbound HTTP headers forwarded only to the target URL, sent as + # deep-object query params such as headers[X-Custom]=value. When provided, caching + # is bypassed: the result is neither read from nor written to cache. + headers: nil, # Reuse a cached result this many milliseconds old or newer. Default: 86400000 (1 # day). Set to 0 to bypass cache. Maximum: 2592000000 (30 days). max_age_ms: nil, @@ -453,6 +463,7 @@ module BrandDev sig do params( url: String, + headers: T::Hash[Symbol, String], include_frames: T::Boolean, include_images: T::Boolean, include_links: T::Boolean, @@ -469,6 +480,10 @@ module BrandDev # Full URL to scrape into LLM usable Markdown (must include http:// or https:// # protocol) url:, + # Optional outbound HTTP headers forwarded only to the target URL, sent as + # deep-object query params such as headers[X-Custom]=value. When provided, caching + # is bypassed: the result is neither read from nor written to cache. + headers: nil, # When true, the contents of iframes are rendered to Markdown. include_frames: nil, # Include image references in Markdown output @@ -502,6 +517,7 @@ module BrandDev sig do params( domain: String, + headers: T::Hash[Symbol, String], max_links: Integer, timeout_ms: Integer, url_regex: String, @@ -511,6 +527,10 @@ module BrandDev def web_scrape_sitemap( # Domain to build a sitemap for domain:, + # Optional outbound HTTP headers forwarded only to the target URL, sent as + # deep-object query params such as headers[X-Custom]=value. When provided, caching + # is bypassed: the result is neither read from nor written to cache. + headers: nil, # Maximum number of links to return from the sitemap crawl. Defaults to 10,000. # Minimum is 1, maximum is 100,000. max_links: nil, diff --git a/sig/brand_dev/models/brand_web_scrape_html_params.rbs b/sig/brand_dev/models/brand_web_scrape_html_params.rbs index b9e9f8f..d9348ab 100644 --- a/sig/brand_dev/models/brand_web_scrape_html_params.rbs +++ b/sig/brand_dev/models/brand_web_scrape_html_params.rbs @@ -3,6 +3,7 @@ module BrandDev type brand_web_scrape_html_params = { url: String, + headers: ::Hash[Symbol, String], include_frames: bool, max_age_ms: Integer, pdf: BrandDev::BrandWebScrapeHTMLParams::Pdf, @@ -17,6 +18,10 @@ module BrandDev attr_accessor url: String + attr_reader headers: ::Hash[Symbol, String]? + + def headers=: (::Hash[Symbol, String]) -> ::Hash[Symbol, String] + attr_reader include_frames: bool? def include_frames=: (bool) -> bool @@ -41,6 +46,7 @@ module BrandDev def initialize: ( url: String, + ?headers: ::Hash[Symbol, String], ?include_frames: bool, ?max_age_ms: Integer, ?pdf: BrandDev::BrandWebScrapeHTMLParams::Pdf, @@ -51,6 +57,7 @@ module BrandDev def to_hash: -> { url: String, + headers: ::Hash[Symbol, String], include_frames: bool, max_age_ms: Integer, pdf: BrandDev::BrandWebScrapeHTMLParams::Pdf, diff --git a/sig/brand_dev/models/brand_web_scrape_images_params.rbs b/sig/brand_dev/models/brand_web_scrape_images_params.rbs index dc6a42f..ce198db 100644 --- a/sig/brand_dev/models/brand_web_scrape_images_params.rbs +++ b/sig/brand_dev/models/brand_web_scrape_images_params.rbs @@ -4,6 +4,7 @@ module BrandDev { url: String, enrichment: BrandDev::BrandWebScrapeImagesParams::Enrichment, + headers: ::Hash[Symbol, String], max_age_ms: Integer, timeout_ms: Integer, wait_for_ms: Integer @@ -22,6 +23,10 @@ module BrandDev BrandDev::BrandWebScrapeImagesParams::Enrichment ) -> BrandDev::BrandWebScrapeImagesParams::Enrichment + attr_reader headers: ::Hash[Symbol, String]? + + def headers=: (::Hash[Symbol, String]) -> ::Hash[Symbol, String] + attr_reader max_age_ms: Integer? def max_age_ms=: (Integer) -> Integer @@ -37,6 +42,7 @@ module BrandDev def initialize: ( url: String, ?enrichment: BrandDev::BrandWebScrapeImagesParams::Enrichment, + ?headers: ::Hash[Symbol, String], ?max_age_ms: Integer, ?timeout_ms: Integer, ?wait_for_ms: Integer, @@ -46,6 +52,7 @@ module BrandDev def to_hash: -> { url: String, enrichment: BrandDev::BrandWebScrapeImagesParams::Enrichment, + headers: ::Hash[Symbol, String], max_age_ms: Integer, timeout_ms: Integer, wait_for_ms: Integer, diff --git a/sig/brand_dev/models/brand_web_scrape_md_params.rbs b/sig/brand_dev/models/brand_web_scrape_md_params.rbs index 5924c4c..9c6c9ef 100644 --- a/sig/brand_dev/models/brand_web_scrape_md_params.rbs +++ b/sig/brand_dev/models/brand_web_scrape_md_params.rbs @@ -3,6 +3,7 @@ module BrandDev type brand_web_scrape_md_params = { url: String, + headers: ::Hash[Symbol, String], include_frames: bool, include_images: bool, include_links: bool, @@ -21,6 +22,10 @@ module BrandDev attr_accessor url: String + attr_reader headers: ::Hash[Symbol, String]? + + def headers=: (::Hash[Symbol, String]) -> ::Hash[Symbol, String] + attr_reader include_frames: bool? def include_frames=: (bool) -> bool @@ -61,6 +66,7 @@ module BrandDev def initialize: ( url: String, + ?headers: ::Hash[Symbol, String], ?include_frames: bool, ?include_images: bool, ?include_links: bool, @@ -75,6 +81,7 @@ module BrandDev def to_hash: -> { url: String, + headers: ::Hash[Symbol, String], include_frames: bool, include_images: bool, include_links: bool, diff --git a/sig/brand_dev/models/brand_web_scrape_sitemap_params.rbs b/sig/brand_dev/models/brand_web_scrape_sitemap_params.rbs index b336628..4f27532 100644 --- a/sig/brand_dev/models/brand_web_scrape_sitemap_params.rbs +++ b/sig/brand_dev/models/brand_web_scrape_sitemap_params.rbs @@ -3,6 +3,7 @@ module BrandDev type brand_web_scrape_sitemap_params = { domain: String, + headers: ::Hash[Symbol, String], max_links: Integer, timeout_ms: Integer, url_regex: String @@ -15,6 +16,10 @@ module BrandDev attr_accessor domain: String + attr_reader headers: ::Hash[Symbol, String]? + + def headers=: (::Hash[Symbol, String]) -> ::Hash[Symbol, String] + attr_reader max_links: Integer? def max_links=: (Integer) -> Integer @@ -29,6 +34,7 @@ module BrandDev def initialize: ( domain: String, + ?headers: ::Hash[Symbol, String], ?max_links: Integer, ?timeout_ms: Integer, ?url_regex: String, @@ -37,6 +43,7 @@ module BrandDev def to_hash: -> { domain: String, + headers: ::Hash[Symbol, String], max_links: Integer, timeout_ms: Integer, url_regex: String, diff --git a/sig/brand_dev/resources/brand.rbs b/sig/brand_dev/resources/brand.rbs index ab51a1c..e89f8c4 100644 --- a/sig/brand_dev/resources/brand.rbs +++ b/sig/brand_dev/resources/brand.rbs @@ -102,6 +102,7 @@ module BrandDev def web_scrape_html: ( url: String, + ?headers: ::Hash[Symbol, String], ?include_frames: bool, ?max_age_ms: Integer, ?pdf: BrandDev::BrandWebScrapeHTMLParams::Pdf, @@ -113,6 +114,7 @@ module BrandDev def web_scrape_images: ( url: String, ?enrichment: BrandDev::BrandWebScrapeImagesParams::Enrichment, + ?headers: ::Hash[Symbol, String], ?max_age_ms: Integer, ?timeout_ms: Integer, ?wait_for_ms: Integer, @@ -121,6 +123,7 @@ module BrandDev def web_scrape_md: ( url: String, + ?headers: ::Hash[Symbol, String], ?include_frames: bool, ?include_images: bool, ?include_links: bool, @@ -135,6 +138,7 @@ module BrandDev def web_scrape_sitemap: ( domain: String, + ?headers: ::Hash[Symbol, String], ?max_links: Integer, ?timeout_ms: Integer, ?url_regex: String, From c9207c764f8b17c1852fdc4611f85a2077b3c425 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sat, 6 Jun 2026 15:16:44 +0000 Subject: [PATCH 68/82] codegen metadata --- .stats.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.stats.yml b/.stats.yml index a162a04..747631f 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 16 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-6ed467d40802bbe92c036743ad980f3cb986626e18a8e3b743e05382eee00b97.yml -openapi_spec_hash: 5fb10c717fc138f1202f8395b37713db +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-481daa177869e994747e1970f2344d2e429788465e1993bca093510c2d8aa5a9.yml +openapi_spec_hash: 860a045bcc1420095a4a77d2b4f656e2 config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 From f6a3cd492f1f7e6d412fb34172809db980126423 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sun, 7 Jun 2026 15:13:57 +0000 Subject: [PATCH 69/82] feat(api): api update --- .stats.yml | 4 +- .../models/brand_web_scrape_html_response.rb | 40 ++++++++- .../models/brand_web_scrape_html_response.rbi | 86 ++++++++++++++++++- .../models/brand_web_scrape_html_response.rbs | 22 +++++ test/brand_dev/resources/brand_test.rb | 1 + 5 files changed, 146 insertions(+), 7 deletions(-) diff --git a/.stats.yml b/.stats.yml index 747631f..1544577 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 16 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-481daa177869e994747e1970f2344d2e429788465e1993bca093510c2d8aa5a9.yml -openapi_spec_hash: 860a045bcc1420095a4a77d2b4f656e2 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-554674c982facf89dfb61a919d7585a1c6a18c8253a58f67f9c6d77f1defa669.yml +openapi_spec_hash: 2520368979ea4359e5d6d47de1d15eda config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 diff --git a/lib/brand_dev/models/brand_web_scrape_html_response.rb b/lib/brand_dev/models/brand_web_scrape_html_response.rb index 634c23e..4b7d15e 100644 --- a/lib/brand_dev/models/brand_web_scrape_html_response.rb +++ b/lib/brand_dev/models/brand_web_scrape_html_response.rb @@ -5,7 +5,9 @@ module Models # @see BrandDev::Resources::Brand#web_scrape_html class BrandWebScrapeHTMLResponse < BrandDev::Internal::Type::BaseModel # @!attribute html - # Raw HTML content of the page + # The scraped content of the page. For normal pages this is the raw HTML. When the + # page is a sitemap or feed served behind an XSL stylesheet (which browsers render + # into HTML), this is the underlying XML instead — see the `type` field. # # @return [String] required :html, String @@ -16,17 +18,29 @@ class BrandWebScrapeHTMLResponse < BrandDev::Internal::Type::BaseModel # @return [Boolean, BrandDev::Models::BrandWebScrapeHTMLResponse::Success] required :success, enum: -> { BrandDev::Models::BrandWebScrapeHTMLResponse::Success } + # @!attribute type + # Detected content type of the returned `html` field. Sitemaps and feeds are + # surfaced as `xml`; ordinary pages are `html`. + # + # @return [Symbol, BrandDev::Models::BrandWebScrapeHTMLResponse::Type] + required :type, enum: -> { BrandDev::Models::BrandWebScrapeHTMLResponse::Type } + # @!attribute url # The URL that was scraped # # @return [String] required :url, String - # @!method initialize(html:, success:, url:) - # @param html [String] Raw HTML content of the page + # @!method initialize(html:, success:, type:, url:) + # Some parameter documentations has been truncated, see + # {BrandDev::Models::BrandWebScrapeHTMLResponse} for more details. + # + # @param html [String] The scraped content of the page. For normal pages this is the raw HTML. When the # # @param success [Boolean, BrandDev::Models::BrandWebScrapeHTMLResponse::Success] Indicates success # + # @param type [Symbol, BrandDev::Models::BrandWebScrapeHTMLResponse::Type] Detected content type of the returned `html` field. Sitemaps and feeds are surfa + # # @param url [String] The URL that was scraped # Indicates success @@ -40,6 +54,26 @@ module Success # @!method self.values # @return [Array] end + + # Detected content type of the returned `html` field. Sitemaps and feeds are + # surfaced as `xml`; ordinary pages are `html`. + # + # @see BrandDev::Models::BrandWebScrapeHTMLResponse#type + module Type + extend BrandDev::Internal::Type::Enum + + HTML = :html + XML = :xml + JSON = :json + TEXT = :text + CSV = :csv + MARKDOWN = :markdown + SVG = :svg + PDF = :pdf + + # @!method self.values + # @return [Array] + end end end end diff --git a/rbi/brand_dev/models/brand_web_scrape_html_response.rbi b/rbi/brand_dev/models/brand_web_scrape_html_response.rbi index 62e0ea6..0b856f4 100644 --- a/rbi/brand_dev/models/brand_web_scrape_html_response.rbi +++ b/rbi/brand_dev/models/brand_web_scrape_html_response.rbi @@ -11,7 +11,9 @@ module BrandDev ) end - # Raw HTML content of the page + # The scraped content of the page. For normal pages this is the raw HTML. When the + # page is a sitemap or feed served behind an XSL stylesheet (which browsers render + # into HTML), this is the underlying XML instead — see the `type` field. sig { returns(String) } attr_accessor :html @@ -23,6 +25,15 @@ module BrandDev end attr_accessor :success + # Detected content type of the returned `html` field. Sitemaps and feeds are + # surfaced as `xml`; ordinary pages are `html`. + sig do + returns( + BrandDev::Models::BrandWebScrapeHTMLResponse::Type::TaggedSymbol + ) + end + attr_accessor :type + # The URL that was scraped sig { returns(String) } attr_accessor :url @@ -32,14 +43,20 @@ module BrandDev html: String, success: BrandDev::Models::BrandWebScrapeHTMLResponse::Success::OrBoolean, + type: BrandDev::Models::BrandWebScrapeHTMLResponse::Type::OrSymbol, url: String ).returns(T.attached_class) end def self.new( - # Raw HTML content of the page + # The scraped content of the page. For normal pages this is the raw HTML. When the + # page is a sitemap or feed served behind an XSL stylesheet (which browsers render + # into HTML), this is the underlying XML instead — see the `type` field. html:, # Indicates success success:, + # Detected content type of the returned `html` field. Sitemaps and feeds are + # surfaced as `xml`; ordinary pages are `html`. + type:, # The URL that was scraped url: ) @@ -51,6 +68,8 @@ module BrandDev html: String, success: BrandDev::Models::BrandWebScrapeHTMLResponse::Success::TaggedBoolean, + type: + BrandDev::Models::BrandWebScrapeHTMLResponse::Type::TaggedSymbol, url: String } ) @@ -87,6 +106,69 @@ module BrandDev def self.values end end + + # Detected content type of the returned `html` field. Sitemaps and feeds are + # surfaced as `xml`; ordinary pages are `html`. + module Type + extend BrandDev::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all(Symbol, BrandDev::Models::BrandWebScrapeHTMLResponse::Type) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + HTML = + T.let( + :html, + BrandDev::Models::BrandWebScrapeHTMLResponse::Type::TaggedSymbol + ) + XML = + T.let( + :xml, + BrandDev::Models::BrandWebScrapeHTMLResponse::Type::TaggedSymbol + ) + JSON = + T.let( + :json, + BrandDev::Models::BrandWebScrapeHTMLResponse::Type::TaggedSymbol + ) + TEXT = + T.let( + :text, + BrandDev::Models::BrandWebScrapeHTMLResponse::Type::TaggedSymbol + ) + CSV = + T.let( + :csv, + BrandDev::Models::BrandWebScrapeHTMLResponse::Type::TaggedSymbol + ) + MARKDOWN = + T.let( + :markdown, + BrandDev::Models::BrandWebScrapeHTMLResponse::Type::TaggedSymbol + ) + SVG = + T.let( + :svg, + BrandDev::Models::BrandWebScrapeHTMLResponse::Type::TaggedSymbol + ) + PDF = + T.let( + :pdf, + BrandDev::Models::BrandWebScrapeHTMLResponse::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + BrandDev::Models::BrandWebScrapeHTMLResponse::Type::TaggedSymbol + ] + ) + end + def self.values + end + end end end end diff --git a/sig/brand_dev/models/brand_web_scrape_html_response.rbs b/sig/brand_dev/models/brand_web_scrape_html_response.rbs index c33095e..54927c8 100644 --- a/sig/brand_dev/models/brand_web_scrape_html_response.rbs +++ b/sig/brand_dev/models/brand_web_scrape_html_response.rbs @@ -4,6 +4,7 @@ module BrandDev { html: String, success: BrandDev::Models::BrandWebScrapeHTMLResponse::success, + type: BrandDev::Models::BrandWebScrapeHTMLResponse::type_, url: String } @@ -12,17 +13,21 @@ module BrandDev attr_accessor success: BrandDev::Models::BrandWebScrapeHTMLResponse::success + attr_accessor type: BrandDev::Models::BrandWebScrapeHTMLResponse::type_ + attr_accessor url: String def initialize: ( html: String, success: BrandDev::Models::BrandWebScrapeHTMLResponse::success, + type: BrandDev::Models::BrandWebScrapeHTMLResponse::type_, url: String ) -> void def to_hash: -> { html: String, success: BrandDev::Models::BrandWebScrapeHTMLResponse::success, + type: BrandDev::Models::BrandWebScrapeHTMLResponse::type_, url: String } @@ -35,6 +40,23 @@ module BrandDev def self?.values: -> ::Array[BrandDev::Models::BrandWebScrapeHTMLResponse::success] end + + type type_ = :html | :xml | :json | :text | :csv | :markdown | :svg | :pdf + + module Type + extend BrandDev::Internal::Type::Enum + + HTML: :html + XML: :xml + JSON: :json + TEXT: :text + CSV: :csv + MARKDOWN: :markdown + SVG: :svg + PDF: :pdf + + def self?.values: -> ::Array[BrandDev::Models::BrandWebScrapeHTMLResponse::type_] + end end end end diff --git a/test/brand_dev/resources/brand_test.rb b/test/brand_dev/resources/brand_test.rb index 7b77af2..d803878 100644 --- a/test/brand_dev/resources/brand_test.rb +++ b/test/brand_dev/resources/brand_test.rb @@ -242,6 +242,7 @@ def test_web_scrape_html_required_params response => { html: String, success: BrandDev::Models::BrandWebScrapeHTMLResponse::Success, + type: BrandDev::Models::BrandWebScrapeHTMLResponse::Type, url: String } end From bab38c3ae6ca2e10722028a4b85c980d1a8c4573 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sun, 7 Jun 2026 22:03:59 +0000 Subject: [PATCH 70/82] feat(api): api update --- .stats.yml | 4 +-- .../models/brand_web_scrape_html_params.rb | 22 +++++++++++++- .../models/brand_web_scrape_md_params.rb | 22 +++++++++++++- lib/brand_dev/resources/brand.rb | 16 ++++++++-- .../models/brand_web_scrape_html_params.rbi | 30 +++++++++++++++++++ .../models/brand_web_scrape_md_params.rbi | 30 +++++++++++++++++++ rbi/brand_dev/resources/brand.rbi | 20 +++++++++++++ .../models/brand_web_scrape_html_params.rbs | 14 +++++++++ .../models/brand_web_scrape_md_params.rbs | 14 +++++++++ sig/brand_dev/resources/brand.rbs | 4 +++ 10 files changed, 170 insertions(+), 6 deletions(-) diff --git a/.stats.yml b/.stats.yml index 1544577..74edb1a 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 16 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-554674c982facf89dfb61a919d7585a1c6a18c8253a58f67f9c6d77f1defa669.yml -openapi_spec_hash: 2520368979ea4359e5d6d47de1d15eda +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-43306d74a09e6e1f57977311aaf406e54538a4dc5a4c4ee544fa2f0deef85ab2.yml +openapi_spec_hash: 2a58ccda9d329901cac7d782ad49c848 config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 diff --git a/lib/brand_dev/models/brand_web_scrape_html_params.rb b/lib/brand_dev/models/brand_web_scrape_html_params.rb index 79c3173..4c46840 100644 --- a/lib/brand_dev/models/brand_web_scrape_html_params.rb +++ b/lib/brand_dev/models/brand_web_scrape_html_params.rb @@ -13,6 +13,14 @@ class BrandWebScrapeHTMLParams < BrandDev::Internal::Type::BaseModel # @return [String] required :url, String + # @!attribute exclude_selectors + # CSS selectors to remove from the result. Applied after includeSelectors. + # Exclusion takes precedence: an element matching both is removed. Examples: + # "nav", "footer", ".ad-banner", "[aria-hidden=true]". + # + # @return [Array, nil] + optional :exclude_selectors, BrandDev::Internal::Type::ArrayOf[String] + # @!attribute headers # Optional outbound HTTP headers forwarded only to the target URL, sent as # deep-object query params such as headers[X-Custom]=value. When provided, caching @@ -27,6 +35,14 @@ class BrandWebScrapeHTMLParams < BrandDev::Internal::Type::BaseModel # @return [Boolean, nil] optional :include_frames, BrandDev::Internal::Type::Boolean + # @!attribute include_selectors + # CSS selectors. When provided, only matching subtrees (and their descendants) are + # kept and everything else is dropped. When omitted, the entire document is kept. + # Examples: "article.main", "#content", "[role=main]". + # + # @return [Array, nil] + optional :include_selectors, BrandDev::Internal::Type::ArrayOf[String] + # @!attribute max_age_ms # Return a cached result if a prior scrape for the same parameters exists and is # younger than this many milliseconds. Defaults to 1 day (86400000 ms) when @@ -57,16 +73,20 @@ class BrandWebScrapeHTMLParams < BrandDev::Internal::Type::BaseModel # @return [Integer, nil] optional :wait_for_ms, Integer - # @!method initialize(url:, headers: nil, include_frames: nil, max_age_ms: nil, pdf: nil, timeout_ms: nil, wait_for_ms: nil, request_options: {}) + # @!method initialize(url:, exclude_selectors: nil, headers: nil, include_frames: nil, include_selectors: nil, max_age_ms: nil, pdf: nil, timeout_ms: nil, wait_for_ms: nil, request_options: {}) # Some parameter documentations has been truncated, see # {BrandDev::Models::BrandWebScrapeHTMLParams} for more details. # # @param url [String] Full URL to scrape (must include http:// or https:// protocol) # + # @param exclude_selectors [Array] CSS selectors to remove from the result. Applied after includeSelectors. Exclusi + # # @param headers [Hash{Symbol=>String}] Optional outbound HTTP headers forwarded only to the target URL, sent as deep-ob # # @param include_frames [Boolean] When true, iframes are rendered inline into the returned HTML. # + # @param include_selectors [Array] CSS selectors. When provided, only matching subtrees (and their descendants) are + # # @param max_age_ms [Integer] Return a cached result if a prior scrape for the same parameters exists and is y # # @param pdf [BrandDev::Models::BrandWebScrapeHTMLParams::Pdf] PDF parsing controls. Use start/end to limit text extraction and OCR to an inclu diff --git a/lib/brand_dev/models/brand_web_scrape_md_params.rb b/lib/brand_dev/models/brand_web_scrape_md_params.rb index 2854860..ecabcfc 100644 --- a/lib/brand_dev/models/brand_web_scrape_md_params.rb +++ b/lib/brand_dev/models/brand_web_scrape_md_params.rb @@ -14,6 +14,14 @@ class BrandWebScrapeMdParams < BrandDev::Internal::Type::BaseModel # @return [String] required :url, String + # @!attribute exclude_selectors + # CSS selectors to remove before conversion to Markdown. Applied after + # includeSelectors. Exclusion takes precedence: an element matching both is + # removed. Examples: "nav", "footer", ".ad-banner", "[aria-hidden=true]". + # + # @return [Array, nil] + optional :exclude_selectors, BrandDev::Internal::Type::ArrayOf[String] + # @!attribute headers # Optional outbound HTTP headers forwarded only to the target URL, sent as # deep-object query params such as headers[X-Custom]=value. When provided, caching @@ -40,6 +48,14 @@ class BrandWebScrapeMdParams < BrandDev::Internal::Type::BaseModel # @return [Boolean, nil] optional :include_links, BrandDev::Internal::Type::Boolean + # @!attribute include_selectors + # CSS selectors. When provided, only matching HTML subtrees (and their + # descendants) are kept before conversion to Markdown. When omitted, the entire + # document is kept. Examples: "article.main", "#content", "[role=main]". + # + # @return [Array, nil] + optional :include_selectors, BrandDev::Internal::Type::ArrayOf[String] + # @!attribute max_age_ms # Return a cached result if a prior scrape for the same parameters exists and is # younger than this many milliseconds. Defaults to 1 day (86400000 ms) when @@ -83,12 +99,14 @@ class BrandWebScrapeMdParams < BrandDev::Internal::Type::BaseModel # @return [Integer, nil] optional :wait_for_ms, Integer - # @!method initialize(url:, headers: nil, include_frames: nil, include_images: nil, include_links: nil, max_age_ms: nil, pdf: nil, shorten_base64_images: nil, timeout_ms: nil, use_main_content_only: nil, wait_for_ms: nil, request_options: {}) + # @!method initialize(url:, exclude_selectors: nil, headers: nil, include_frames: nil, include_images: nil, include_links: nil, include_selectors: nil, max_age_ms: nil, pdf: nil, shorten_base64_images: nil, timeout_ms: nil, use_main_content_only: nil, wait_for_ms: nil, request_options: {}) # Some parameter documentations has been truncated, see # {BrandDev::Models::BrandWebScrapeMdParams} for more details. # # @param url [String] Full URL to scrape into LLM usable Markdown (must include http:// or https:// pr # + # @param exclude_selectors [Array] CSS selectors to remove before conversion to Markdown. Applied after includeSele + # # @param headers [Hash{Symbol=>String}] Optional outbound HTTP headers forwarded only to the target URL, sent as deep-ob # # @param include_frames [Boolean] When true, the contents of iframes are rendered to Markdown. @@ -97,6 +115,8 @@ class BrandWebScrapeMdParams < BrandDev::Internal::Type::BaseModel # # @param include_links [Boolean] Preserve hyperlinks in Markdown output # + # @param include_selectors [Array] CSS selectors. When provided, only matching HTML subtrees (and their descendants + # # @param max_age_ms [Integer] Return a cached result if a prior scrape for the same parameters exists and is y # # @param pdf [BrandDev::Models::BrandWebScrapeMdParams::Pdf] PDF parsing controls. Use start/end to limit text extraction and OCR to an inclu diff --git a/lib/brand_dev/resources/brand.rb b/lib/brand_dev/resources/brand.rb index 0f1cb9c..cd448f1 100644 --- a/lib/brand_dev/resources/brand.rb +++ b/lib/brand_dev/resources/brand.rb @@ -405,14 +405,18 @@ def retrieve_simplified(params) # # Scrapes the given URL and returns the raw HTML content of the page. # - # @overload web_scrape_html(url:, headers: nil, include_frames: nil, max_age_ms: nil, pdf: nil, timeout_ms: nil, wait_for_ms: nil, request_options: {}) + # @overload web_scrape_html(url:, exclude_selectors: nil, headers: nil, include_frames: nil, include_selectors: nil, max_age_ms: nil, pdf: nil, timeout_ms: nil, wait_for_ms: nil, request_options: {}) # # @param url [String] Full URL to scrape (must include http:// or https:// protocol) # + # @param exclude_selectors [Array] CSS selectors to remove from the result. Applied after includeSelectors. Exclusi + # # @param headers [Hash{Symbol=>String}] Optional outbound HTTP headers forwarded only to the target URL, sent as deep-ob # # @param include_frames [Boolean] When true, iframes are rendered inline into the returned HTML. # + # @param include_selectors [Array] CSS selectors. When provided, only matching subtrees (and their descendants) are + # # @param max_age_ms [Integer] Return a cached result if a prior scrape for the same parameters exists and is y # # @param pdf [BrandDev::Models::BrandWebScrapeHTMLParams::Pdf] PDF parsing controls. Use start/end to limit text extraction and OCR to an inclu @@ -433,7 +437,9 @@ def web_scrape_html(params) method: :get, path: "web/scrape/html", query: query.transform_keys( + exclude_selectors: "excludeSelectors", include_frames: "includeFrames", + include_selectors: "includeSelectors", max_age_ms: "maxAgeMs", timeout_ms: "timeoutMS", wait_for_ms: "waitForMs" @@ -491,10 +497,12 @@ def web_scrape_images(params) # # Scrapes the given URL into LLM usable Markdown. # - # @overload web_scrape_md(url:, headers: nil, include_frames: nil, include_images: nil, include_links: nil, max_age_ms: nil, pdf: nil, shorten_base64_images: nil, timeout_ms: nil, use_main_content_only: nil, wait_for_ms: nil, request_options: {}) + # @overload web_scrape_md(url:, exclude_selectors: nil, headers: nil, include_frames: nil, include_images: nil, include_links: nil, include_selectors: nil, max_age_ms: nil, pdf: nil, shorten_base64_images: nil, timeout_ms: nil, use_main_content_only: nil, wait_for_ms: nil, request_options: {}) # # @param url [String] Full URL to scrape into LLM usable Markdown (must include http:// or https:// pr # + # @param exclude_selectors [Array] CSS selectors to remove before conversion to Markdown. Applied after includeSele + # # @param headers [Hash{Symbol=>String}] Optional outbound HTTP headers forwarded only to the target URL, sent as deep-ob # # @param include_frames [Boolean] When true, the contents of iframes are rendered to Markdown. @@ -503,6 +511,8 @@ def web_scrape_images(params) # # @param include_links [Boolean] Preserve hyperlinks in Markdown output # + # @param include_selectors [Array] CSS selectors. When provided, only matching HTML subtrees (and their descendants + # # @param max_age_ms [Integer] Return a cached result if a prior scrape for the same parameters exists and is y # # @param pdf [BrandDev::Models::BrandWebScrapeMdParams::Pdf] PDF parsing controls. Use start/end to limit text extraction and OCR to an inclu @@ -527,9 +537,11 @@ def web_scrape_md(params) method: :get, path: "web/scrape/markdown", query: query.transform_keys( + exclude_selectors: "excludeSelectors", include_frames: "includeFrames", include_images: "includeImages", include_links: "includeLinks", + include_selectors: "includeSelectors", max_age_ms: "maxAgeMs", shorten_base64_images: "shortenBase64Images", timeout_ms: "timeoutMS", diff --git a/rbi/brand_dev/models/brand_web_scrape_html_params.rbi b/rbi/brand_dev/models/brand_web_scrape_html_params.rbi index 3e99101..b765e76 100644 --- a/rbi/brand_dev/models/brand_web_scrape_html_params.rbi +++ b/rbi/brand_dev/models/brand_web_scrape_html_params.rbi @@ -15,6 +15,15 @@ module BrandDev sig { returns(String) } attr_accessor :url + # CSS selectors to remove from the result. Applied after includeSelectors. + # Exclusion takes precedence: an element matching both is removed. Examples: + # "nav", "footer", ".ad-banner", "[aria-hidden=true]". + sig { returns(T.nilable(T::Array[String])) } + attr_reader :exclude_selectors + + sig { params(exclude_selectors: T::Array[String]).void } + attr_writer :exclude_selectors + # Optional outbound HTTP headers forwarded only to the target URL, sent as # deep-object query params such as headers[X-Custom]=value. When provided, caching # is bypassed: the result is neither read from nor written to cache. @@ -31,6 +40,15 @@ module BrandDev sig { params(include_frames: T::Boolean).void } attr_writer :include_frames + # CSS selectors. When provided, only matching subtrees (and their descendants) are + # kept and everything else is dropped. When omitted, the entire document is kept. + # Examples: "article.main", "#content", "[role=main]". + sig { returns(T.nilable(T::Array[String])) } + attr_reader :include_selectors + + sig { params(include_selectors: T::Array[String]).void } + attr_writer :include_selectors + # Return a cached result if a prior scrape for the same parameters exists and is # younger than this many milliseconds. Defaults to 1 day (86400000 ms) when # omitted. Max is 30 days (2592000000 ms). Set to 0 to always scrape fresh. @@ -68,8 +86,10 @@ module BrandDev sig do params( url: String, + exclude_selectors: T::Array[String], headers: T::Hash[Symbol, String], include_frames: T::Boolean, + include_selectors: T::Array[String], max_age_ms: Integer, pdf: BrandDev::BrandWebScrapeHTMLParams::Pdf::OrHash, timeout_ms: Integer, @@ -80,12 +100,20 @@ module BrandDev def self.new( # Full URL to scrape (must include http:// or https:// protocol) url:, + # CSS selectors to remove from the result. Applied after includeSelectors. + # Exclusion takes precedence: an element matching both is removed. Examples: + # "nav", "footer", ".ad-banner", "[aria-hidden=true]". + exclude_selectors: nil, # Optional outbound HTTP headers forwarded only to the target URL, sent as # deep-object query params such as headers[X-Custom]=value. When provided, caching # is bypassed: the result is neither read from nor written to cache. headers: nil, # When true, iframes are rendered inline into the returned HTML. include_frames: nil, + # CSS selectors. When provided, only matching subtrees (and their descendants) are + # kept and everything else is dropped. When omitted, the entire document is kept. + # Examples: "article.main", "#content", "[role=main]". + include_selectors: nil, # Return a cached result if a prior scrape for the same parameters exists and is # younger than this many milliseconds. Defaults to 1 day (86400000 ms) when # omitted. Max is 30 days (2592000000 ms). Set to 0 to always scrape fresh. @@ -108,8 +136,10 @@ module BrandDev override.returns( { url: String, + exclude_selectors: T::Array[String], headers: T::Hash[Symbol, String], include_frames: T::Boolean, + include_selectors: T::Array[String], max_age_ms: Integer, pdf: BrandDev::BrandWebScrapeHTMLParams::Pdf, timeout_ms: Integer, diff --git a/rbi/brand_dev/models/brand_web_scrape_md_params.rbi b/rbi/brand_dev/models/brand_web_scrape_md_params.rbi index 25bf9c6..26b3d7e 100644 --- a/rbi/brand_dev/models/brand_web_scrape_md_params.rbi +++ b/rbi/brand_dev/models/brand_web_scrape_md_params.rbi @@ -16,6 +16,15 @@ module BrandDev sig { returns(String) } attr_accessor :url + # CSS selectors to remove before conversion to Markdown. Applied after + # includeSelectors. Exclusion takes precedence: an element matching both is + # removed. Examples: "nav", "footer", ".ad-banner", "[aria-hidden=true]". + sig { returns(T.nilable(T::Array[String])) } + attr_reader :exclude_selectors + + sig { params(exclude_selectors: T::Array[String]).void } + attr_writer :exclude_selectors + # Optional outbound HTTP headers forwarded only to the target URL, sent as # deep-object query params such as headers[X-Custom]=value. When provided, caching # is bypassed: the result is neither read from nor written to cache. @@ -46,6 +55,15 @@ module BrandDev sig { params(include_links: T::Boolean).void } attr_writer :include_links + # CSS selectors. When provided, only matching HTML subtrees (and their + # descendants) are kept before conversion to Markdown. When omitted, the entire + # document is kept. Examples: "article.main", "#content", "[role=main]". + sig { returns(T.nilable(T::Array[String])) } + attr_reader :include_selectors + + sig { params(include_selectors: T::Array[String]).void } + attr_writer :include_selectors + # Return a cached result if a prior scrape for the same parameters exists and is # younger than this many milliseconds. Defaults to 1 day (86400000 ms) when # omitted. Max is 30 days (2592000000 ms). Set to 0 to always scrape fresh. @@ -98,10 +116,12 @@ module BrandDev sig do params( url: String, + exclude_selectors: T::Array[String], headers: T::Hash[Symbol, String], include_frames: T::Boolean, include_images: T::Boolean, include_links: T::Boolean, + include_selectors: T::Array[String], max_age_ms: Integer, pdf: BrandDev::BrandWebScrapeMdParams::Pdf::OrHash, shorten_base64_images: T::Boolean, @@ -115,6 +135,10 @@ module BrandDev # Full URL to scrape into LLM usable Markdown (must include http:// or https:// # protocol) url:, + # CSS selectors to remove before conversion to Markdown. Applied after + # includeSelectors. Exclusion takes precedence: an element matching both is + # removed. Examples: "nav", "footer", ".ad-banner", "[aria-hidden=true]". + exclude_selectors: nil, # Optional outbound HTTP headers forwarded only to the target URL, sent as # deep-object query params such as headers[X-Custom]=value. When provided, caching # is bypassed: the result is neither read from nor written to cache. @@ -125,6 +149,10 @@ module BrandDev include_images: nil, # Preserve hyperlinks in Markdown output include_links: nil, + # CSS selectors. When provided, only matching HTML subtrees (and their + # descendants) are kept before conversion to Markdown. When omitted, the entire + # document is kept. Examples: "article.main", "#content", "[role=main]". + include_selectors: nil, # Return a cached result if a prior scrape for the same parameters exists and is # younger than this many milliseconds. Defaults to 1 day (86400000 ms) when # omitted. Max is 30 days (2592000000 ms). Set to 0 to always scrape fresh. @@ -152,10 +180,12 @@ module BrandDev override.returns( { url: String, + exclude_selectors: T::Array[String], headers: T::Hash[Symbol, String], include_frames: T::Boolean, include_images: T::Boolean, include_links: T::Boolean, + include_selectors: T::Array[String], max_age_ms: Integer, pdf: BrandDev::BrandWebScrapeMdParams::Pdf, shorten_base64_images: T::Boolean, diff --git a/rbi/brand_dev/resources/brand.rbi b/rbi/brand_dev/resources/brand.rbi index c7dfab4..0a8f686 100644 --- a/rbi/brand_dev/resources/brand.rbi +++ b/rbi/brand_dev/resources/brand.rbi @@ -384,8 +384,10 @@ module BrandDev sig do params( url: String, + exclude_selectors: T::Array[String], headers: T::Hash[Symbol, String], include_frames: T::Boolean, + include_selectors: T::Array[String], max_age_ms: Integer, pdf: BrandDev::BrandWebScrapeHTMLParams::Pdf::OrHash, timeout_ms: Integer, @@ -396,12 +398,20 @@ module BrandDev def web_scrape_html( # Full URL to scrape (must include http:// or https:// protocol) url:, + # CSS selectors to remove from the result. Applied after includeSelectors. + # Exclusion takes precedence: an element matching both is removed. Examples: + # "nav", "footer", ".ad-banner", "[aria-hidden=true]". + exclude_selectors: nil, # Optional outbound HTTP headers forwarded only to the target URL, sent as # deep-object query params such as headers[X-Custom]=value. When provided, caching # is bypassed: the result is neither read from nor written to cache. headers: nil, # When true, iframes are rendered inline into the returned HTML. include_frames: nil, + # CSS selectors. When provided, only matching subtrees (and their descendants) are + # kept and everything else is dropped. When omitted, the entire document is kept. + # Examples: "article.main", "#content", "[role=main]". + include_selectors: nil, # Return a cached result if a prior scrape for the same parameters exists and is # younger than this many milliseconds. Defaults to 1 day (86400000 ms) when # omitted. Max is 30 days (2592000000 ms). Set to 0 to always scrape fresh. @@ -463,10 +473,12 @@ module BrandDev sig do params( url: String, + exclude_selectors: T::Array[String], headers: T::Hash[Symbol, String], include_frames: T::Boolean, include_images: T::Boolean, include_links: T::Boolean, + include_selectors: T::Array[String], max_age_ms: Integer, pdf: BrandDev::BrandWebScrapeMdParams::Pdf::OrHash, shorten_base64_images: T::Boolean, @@ -480,6 +492,10 @@ module BrandDev # Full URL to scrape into LLM usable Markdown (must include http:// or https:// # protocol) url:, + # CSS selectors to remove before conversion to Markdown. Applied after + # includeSelectors. Exclusion takes precedence: an element matching both is + # removed. Examples: "nav", "footer", ".ad-banner", "[aria-hidden=true]". + exclude_selectors: nil, # Optional outbound HTTP headers forwarded only to the target URL, sent as # deep-object query params such as headers[X-Custom]=value. When provided, caching # is bypassed: the result is neither read from nor written to cache. @@ -490,6 +506,10 @@ module BrandDev include_images: nil, # Preserve hyperlinks in Markdown output include_links: nil, + # CSS selectors. When provided, only matching HTML subtrees (and their + # descendants) are kept before conversion to Markdown. When omitted, the entire + # document is kept. Examples: "article.main", "#content", "[role=main]". + include_selectors: nil, # Return a cached result if a prior scrape for the same parameters exists and is # younger than this many milliseconds. Defaults to 1 day (86400000 ms) when # omitted. Max is 30 days (2592000000 ms). Set to 0 to always scrape fresh. diff --git a/sig/brand_dev/models/brand_web_scrape_html_params.rbs b/sig/brand_dev/models/brand_web_scrape_html_params.rbs index d9348ab..bc62d76 100644 --- a/sig/brand_dev/models/brand_web_scrape_html_params.rbs +++ b/sig/brand_dev/models/brand_web_scrape_html_params.rbs @@ -3,8 +3,10 @@ module BrandDev type brand_web_scrape_html_params = { url: String, + exclude_selectors: ::Array[String], headers: ::Hash[Symbol, String], include_frames: bool, + include_selectors: ::Array[String], max_age_ms: Integer, pdf: BrandDev::BrandWebScrapeHTMLParams::Pdf, timeout_ms: Integer, @@ -18,6 +20,10 @@ module BrandDev attr_accessor url: String + attr_reader exclude_selectors: ::Array[String]? + + def exclude_selectors=: (::Array[String]) -> ::Array[String] + attr_reader headers: ::Hash[Symbol, String]? def headers=: (::Hash[Symbol, String]) -> ::Hash[Symbol, String] @@ -26,6 +32,10 @@ module BrandDev def include_frames=: (bool) -> bool + attr_reader include_selectors: ::Array[String]? + + def include_selectors=: (::Array[String]) -> ::Array[String] + attr_reader max_age_ms: Integer? def max_age_ms=: (Integer) -> Integer @@ -46,8 +56,10 @@ module BrandDev def initialize: ( url: String, + ?exclude_selectors: ::Array[String], ?headers: ::Hash[Symbol, String], ?include_frames: bool, + ?include_selectors: ::Array[String], ?max_age_ms: Integer, ?pdf: BrandDev::BrandWebScrapeHTMLParams::Pdf, ?timeout_ms: Integer, @@ -57,8 +69,10 @@ module BrandDev def to_hash: -> { url: String, + exclude_selectors: ::Array[String], headers: ::Hash[Symbol, String], include_frames: bool, + include_selectors: ::Array[String], max_age_ms: Integer, pdf: BrandDev::BrandWebScrapeHTMLParams::Pdf, timeout_ms: Integer, diff --git a/sig/brand_dev/models/brand_web_scrape_md_params.rbs b/sig/brand_dev/models/brand_web_scrape_md_params.rbs index 9c6c9ef..c456713 100644 --- a/sig/brand_dev/models/brand_web_scrape_md_params.rbs +++ b/sig/brand_dev/models/brand_web_scrape_md_params.rbs @@ -3,10 +3,12 @@ module BrandDev type brand_web_scrape_md_params = { url: String, + exclude_selectors: ::Array[String], headers: ::Hash[Symbol, String], include_frames: bool, include_images: bool, include_links: bool, + include_selectors: ::Array[String], max_age_ms: Integer, pdf: BrandDev::BrandWebScrapeMdParams::Pdf, :shorten_base64_images => bool, @@ -22,6 +24,10 @@ module BrandDev attr_accessor url: String + attr_reader exclude_selectors: ::Array[String]? + + def exclude_selectors=: (::Array[String]) -> ::Array[String] + attr_reader headers: ::Hash[Symbol, String]? def headers=: (::Hash[Symbol, String]) -> ::Hash[Symbol, String] @@ -38,6 +44,10 @@ module BrandDev def include_links=: (bool) -> bool + attr_reader include_selectors: ::Array[String]? + + def include_selectors=: (::Array[String]) -> ::Array[String] + attr_reader max_age_ms: Integer? def max_age_ms=: (Integer) -> Integer @@ -66,10 +76,12 @@ module BrandDev def initialize: ( url: String, + ?exclude_selectors: ::Array[String], ?headers: ::Hash[Symbol, String], ?include_frames: bool, ?include_images: bool, ?include_links: bool, + ?include_selectors: ::Array[String], ?max_age_ms: Integer, ?pdf: BrandDev::BrandWebScrapeMdParams::Pdf, ?shorten_base64_images: bool, @@ -81,10 +93,12 @@ module BrandDev def to_hash: -> { url: String, + exclude_selectors: ::Array[String], headers: ::Hash[Symbol, String], include_frames: bool, include_images: bool, include_links: bool, + include_selectors: ::Array[String], max_age_ms: Integer, pdf: BrandDev::BrandWebScrapeMdParams::Pdf, :shorten_base64_images => bool, diff --git a/sig/brand_dev/resources/brand.rbs b/sig/brand_dev/resources/brand.rbs index e89f8c4..5c85996 100644 --- a/sig/brand_dev/resources/brand.rbs +++ b/sig/brand_dev/resources/brand.rbs @@ -102,8 +102,10 @@ module BrandDev def web_scrape_html: ( url: String, + ?exclude_selectors: ::Array[String], ?headers: ::Hash[Symbol, String], ?include_frames: bool, + ?include_selectors: ::Array[String], ?max_age_ms: Integer, ?pdf: BrandDev::BrandWebScrapeHTMLParams::Pdf, ?timeout_ms: Integer, @@ -123,10 +125,12 @@ module BrandDev def web_scrape_md: ( url: String, + ?exclude_selectors: ::Array[String], ?headers: ::Hash[Symbol, String], ?include_frames: bool, ?include_images: bool, ?include_links: bool, + ?include_selectors: ::Array[String], ?max_age_ms: Integer, ?pdf: BrandDev::BrandWebScrapeMdParams::Pdf, ?shorten_base64_images: bool, From 8a0ed7982a6242ec55e24658696ed33cc7067aa3 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 8 Jun 2026 20:10:33 +0000 Subject: [PATCH 71/82] codegen metadata --- .stats.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.stats.yml b/.stats.yml index 74edb1a..f2df728 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 16 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-43306d74a09e6e1f57977311aaf406e54538a4dc5a4c4ee544fa2f0deef85ab2.yml -openapi_spec_hash: 2a58ccda9d329901cac7d782ad49c848 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-d4cdc8c2c8bb0012c2368aeae40ed20f3c93ea68dcd9892db18aa1e06642203d.yml +openapi_spec_hash: e71b8ca8fa8041c8628f82afed471199 config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 From 54ad2b8833f19a4b11c23b1e3a6dad2bc7b194e4 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 8 Jun 2026 21:01:41 +0000 Subject: [PATCH 72/82] feat(api): api update --- .stats.yml | 4 ++-- .../models/brand_web_scrape_html_params.rb | 11 ++++++++++- lib/brand_dev/resources/brand.rb | 5 ++++- .../models/brand_web_scrape_html_params.rbi | 13 +++++++++++++ rbi/brand_dev/resources/brand.rbi | 4 ++++ .../models/brand_web_scrape_html_params.rbs | 7 +++++++ sig/brand_dev/resources/brand.rbs | 1 + 7 files changed, 41 insertions(+), 4 deletions(-) diff --git a/.stats.yml b/.stats.yml index f2df728..db86bba 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 16 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-d4cdc8c2c8bb0012c2368aeae40ed20f3c93ea68dcd9892db18aa1e06642203d.yml -openapi_spec_hash: e71b8ca8fa8041c8628f82afed471199 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-661aa162bbdbb94bfa2a225feb7be095dec450591814eda5d5f7cbd10e0d131d.yml +openapi_spec_hash: 3dc831d586372da3b88e4636213de7f0 config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 diff --git a/lib/brand_dev/models/brand_web_scrape_html_params.rb b/lib/brand_dev/models/brand_web_scrape_html_params.rb index 4c46840..1b9f341 100644 --- a/lib/brand_dev/models/brand_web_scrape_html_params.rb +++ b/lib/brand_dev/models/brand_web_scrape_html_params.rb @@ -66,6 +66,13 @@ class BrandWebScrapeHTMLParams < BrandDev::Internal::Type::BaseModel # @return [Integer, nil] optional :timeout_ms, Integer + # @!attribute use_main_content_only + # When true, return only the page's main content in the HTML response, excluding + # headers, footers, sidebars, and navigation when detectable. + # + # @return [Boolean, nil] + optional :use_main_content_only, BrandDev::Internal::Type::Boolean + # @!attribute wait_for_ms # Optional browser wait time in milliseconds after initial page load. Min: 0. Max: # 30000 (30 seconds). @@ -73,7 +80,7 @@ class BrandWebScrapeHTMLParams < BrandDev::Internal::Type::BaseModel # @return [Integer, nil] optional :wait_for_ms, Integer - # @!method initialize(url:, exclude_selectors: nil, headers: nil, include_frames: nil, include_selectors: nil, max_age_ms: nil, pdf: nil, timeout_ms: nil, wait_for_ms: nil, request_options: {}) + # @!method initialize(url:, exclude_selectors: nil, headers: nil, include_frames: nil, include_selectors: nil, max_age_ms: nil, pdf: nil, timeout_ms: nil, use_main_content_only: nil, wait_for_ms: nil, request_options: {}) # Some parameter documentations has been truncated, see # {BrandDev::Models::BrandWebScrapeHTMLParams} for more details. # @@ -93,6 +100,8 @@ class BrandWebScrapeHTMLParams < BrandDev::Internal::Type::BaseModel # # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th # + # @param use_main_content_only [Boolean] When true, return only the page's main content in the HTML response, excluding h + # # @param wait_for_ms [Integer] Optional browser wait time in milliseconds after initial page load. Min: 0. Max: # # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}] diff --git a/lib/brand_dev/resources/brand.rb b/lib/brand_dev/resources/brand.rb index cd448f1..f961194 100644 --- a/lib/brand_dev/resources/brand.rb +++ b/lib/brand_dev/resources/brand.rb @@ -405,7 +405,7 @@ def retrieve_simplified(params) # # Scrapes the given URL and returns the raw HTML content of the page. # - # @overload web_scrape_html(url:, exclude_selectors: nil, headers: nil, include_frames: nil, include_selectors: nil, max_age_ms: nil, pdf: nil, timeout_ms: nil, wait_for_ms: nil, request_options: {}) + # @overload web_scrape_html(url:, exclude_selectors: nil, headers: nil, include_frames: nil, include_selectors: nil, max_age_ms: nil, pdf: nil, timeout_ms: nil, use_main_content_only: nil, wait_for_ms: nil, request_options: {}) # # @param url [String] Full URL to scrape (must include http:// or https:// protocol) # @@ -423,6 +423,8 @@ def retrieve_simplified(params) # # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th # + # @param use_main_content_only [Boolean] When true, return only the page's main content in the HTML response, excluding h + # # @param wait_for_ms [Integer] Optional browser wait time in milliseconds after initial page load. Min: 0. Max: # # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}, nil] @@ -442,6 +444,7 @@ def web_scrape_html(params) include_selectors: "includeSelectors", max_age_ms: "maxAgeMs", timeout_ms: "timeoutMS", + use_main_content_only: "useMainContentOnly", wait_for_ms: "waitForMs" ), model: BrandDev::Models::BrandWebScrapeHTMLResponse, diff --git a/rbi/brand_dev/models/brand_web_scrape_html_params.rbi b/rbi/brand_dev/models/brand_web_scrape_html_params.rbi index b765e76..bfea543 100644 --- a/rbi/brand_dev/models/brand_web_scrape_html_params.rbi +++ b/rbi/brand_dev/models/brand_web_scrape_html_params.rbi @@ -75,6 +75,14 @@ module BrandDev sig { params(timeout_ms: Integer).void } attr_writer :timeout_ms + # When true, return only the page's main content in the HTML response, excluding + # headers, footers, sidebars, and navigation when detectable. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :use_main_content_only + + sig { params(use_main_content_only: T::Boolean).void } + attr_writer :use_main_content_only + # Optional browser wait time in milliseconds after initial page load. Min: 0. Max: # 30000 (30 seconds). sig { returns(T.nilable(Integer)) } @@ -93,6 +101,7 @@ module BrandDev max_age_ms: Integer, pdf: BrandDev::BrandWebScrapeHTMLParams::Pdf::OrHash, timeout_ms: Integer, + use_main_content_only: T::Boolean, wait_for_ms: Integer, request_options: BrandDev::RequestOptions::OrHash ).returns(T.attached_class) @@ -125,6 +134,9 @@ module BrandDev # than this value, it will be aborted with a 408 status code. Maximum allowed # value is 300000ms (5 minutes). timeout_ms: nil, + # When true, return only the page's main content in the HTML response, excluding + # headers, footers, sidebars, and navigation when detectable. + use_main_content_only: nil, # Optional browser wait time in milliseconds after initial page load. Min: 0. Max: # 30000 (30 seconds). wait_for_ms: nil, @@ -143,6 +155,7 @@ module BrandDev max_age_ms: Integer, pdf: BrandDev::BrandWebScrapeHTMLParams::Pdf, timeout_ms: Integer, + use_main_content_only: T::Boolean, wait_for_ms: Integer, request_options: BrandDev::RequestOptions } diff --git a/rbi/brand_dev/resources/brand.rbi b/rbi/brand_dev/resources/brand.rbi index 0a8f686..62cd442 100644 --- a/rbi/brand_dev/resources/brand.rbi +++ b/rbi/brand_dev/resources/brand.rbi @@ -391,6 +391,7 @@ module BrandDev max_age_ms: Integer, pdf: BrandDev::BrandWebScrapeHTMLParams::Pdf::OrHash, timeout_ms: Integer, + use_main_content_only: T::Boolean, wait_for_ms: Integer, request_options: BrandDev::RequestOptions::OrHash ).returns(BrandDev::Models::BrandWebScrapeHTMLResponse) @@ -423,6 +424,9 @@ module BrandDev # than this value, it will be aborted with a 408 status code. Maximum allowed # value is 300000ms (5 minutes). timeout_ms: nil, + # When true, return only the page's main content in the HTML response, excluding + # headers, footers, sidebars, and navigation when detectable. + use_main_content_only: nil, # Optional browser wait time in milliseconds after initial page load. Min: 0. Max: # 30000 (30 seconds). wait_for_ms: nil, diff --git a/sig/brand_dev/models/brand_web_scrape_html_params.rbs b/sig/brand_dev/models/brand_web_scrape_html_params.rbs index bc62d76..62cf372 100644 --- a/sig/brand_dev/models/brand_web_scrape_html_params.rbs +++ b/sig/brand_dev/models/brand_web_scrape_html_params.rbs @@ -10,6 +10,7 @@ module BrandDev max_age_ms: Integer, pdf: BrandDev::BrandWebScrapeHTMLParams::Pdf, timeout_ms: Integer, + use_main_content_only: bool, wait_for_ms: Integer } & BrandDev::Internal::Type::request_parameters @@ -50,6 +51,10 @@ module BrandDev def timeout_ms=: (Integer) -> Integer + attr_reader use_main_content_only: bool? + + def use_main_content_only=: (bool) -> bool + attr_reader wait_for_ms: Integer? def wait_for_ms=: (Integer) -> Integer @@ -63,6 +68,7 @@ module BrandDev ?max_age_ms: Integer, ?pdf: BrandDev::BrandWebScrapeHTMLParams::Pdf, ?timeout_ms: Integer, + ?use_main_content_only: bool, ?wait_for_ms: Integer, ?request_options: BrandDev::request_opts ) -> void @@ -76,6 +82,7 @@ module BrandDev max_age_ms: Integer, pdf: BrandDev::BrandWebScrapeHTMLParams::Pdf, timeout_ms: Integer, + use_main_content_only: bool, wait_for_ms: Integer, request_options: BrandDev::RequestOptions } diff --git a/sig/brand_dev/resources/brand.rbs b/sig/brand_dev/resources/brand.rbs index 5c85996..306a1f3 100644 --- a/sig/brand_dev/resources/brand.rbs +++ b/sig/brand_dev/resources/brand.rbs @@ -109,6 +109,7 @@ module BrandDev ?max_age_ms: Integer, ?pdf: BrandDev::BrandWebScrapeHTMLParams::Pdf, ?timeout_ms: Integer, + ?use_main_content_only: bool, ?wait_for_ms: Integer, ?request_options: BrandDev::request_opts ) -> BrandDev::Models::BrandWebScrapeHTMLResponse From 628530d6d814a90dcb3f6aaccb839bcf0e022521 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 8 Jun 2026 21:48:19 +0000 Subject: [PATCH 73/82] codegen metadata --- .stats.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.stats.yml b/.stats.yml index db86bba..5dbaf4e 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 16 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-661aa162bbdbb94bfa2a225feb7be095dec450591814eda5d5f7cbd10e0d131d.yml -openapi_spec_hash: 3dc831d586372da3b88e4636213de7f0 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-437213902ba1307c7c8733d00945a188a7aa6af9e5c1f7fa1a8ffcc0f692efc8.yml +openapi_spec_hash: 0141ce3e02c643164e5a09eb2f2e89b4 config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 From 20d96f34c4016b3739a41020ad1e7cb00736c6a4 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 11 Jun 2026 01:11:11 +0000 Subject: [PATCH 74/82] feat(api): api update --- .stats.yml | 4 +- lib/brand_dev/internal/type/base_model.rb | 2 +- .../models/brand_ai_product_response.rb | 37 ++++++++- .../models/brand_ai_products_response.rb | 37 ++++++++- .../models/brand_ai_query_response.rb | 37 ++++++++- ...rand_identify_from_transaction_response.rb | 37 ++++++++- .../brand_prefetch_by_email_response.rb | 37 ++++++++- .../models/brand_prefetch_response.rb | 37 ++++++++- .../brand_retrieve_by_email_response.rb | 37 ++++++++- .../models/brand_retrieve_by_isin_response.rb | 37 ++++++++- .../models/brand_retrieve_by_name_response.rb | 37 ++++++++- .../brand_retrieve_by_ticker_response.rb | 37 ++++++++- .../models/brand_retrieve_response.rb | 37 ++++++++- .../brand_retrieve_simplified_response.rb | 37 ++++++++- .../models/brand_web_scrape_html_response.rb | 34 +++++++- .../brand_web_scrape_images_response.rb | 37 ++++++++- .../models/brand_web_scrape_md_response.rb | 37 ++++++++- .../brand_web_scrape_sitemap_response.rb | 37 ++++++++- .../models/brand_ai_product_response.rbi | 64 +++++++++++++++ .../models/brand_ai_products_response.rbi | 65 +++++++++++++++ .../models/brand_ai_query_response.rbi | 62 ++++++++++++++ ...and_identify_from_transaction_response.rbi | 67 +++++++++++++++ .../brand_prefetch_by_email_response.rbi | 81 ++++++++++++++++++- .../models/brand_prefetch_response.rbi | 78 +++++++++++++++++- .../brand_retrieve_by_email_response.rbi | 65 +++++++++++++++ .../brand_retrieve_by_isin_response.rbi | 65 +++++++++++++++ .../brand_retrieve_by_name_response.rbi | 65 +++++++++++++++ .../brand_retrieve_by_ticker_response.rbi | 67 +++++++++++++++ .../models/brand_retrieve_response.rbi | 62 ++++++++++++++ .../brand_retrieve_simplified_response.rbi | 67 +++++++++++++++ .../models/brand_web_scrape_html_response.rbi | 71 +++++++++++++++- .../brand_web_scrape_images_response.rbi | 71 +++++++++++++++- .../models/brand_web_scrape_md_response.rbi | 71 +++++++++++++++- .../brand_web_scrape_sitemap_response.rbi | 73 ++++++++++++++++- .../models/brand_ai_product_response.rbs | 28 +++++++ .../models/brand_ai_products_response.rbs | 32 +++++++- .../models/brand_ai_query_response.rbs | 28 +++++++ ...and_identify_from_transaction_response.rbs | 28 +++++++ .../brand_prefetch_by_email_response.rbs | 40 ++++++++- .../models/brand_prefetch_response.rbs | 40 ++++++++- .../brand_retrieve_by_email_response.rbs | 28 +++++++ .../brand_retrieve_by_isin_response.rbs | 28 +++++++ .../brand_retrieve_by_name_response.rbs | 28 +++++++ .../brand_retrieve_by_ticker_response.rbs | 28 +++++++ .../models/brand_retrieve_response.rbs | 28 +++++++ .../brand_retrieve_simplified_response.rbs | 28 +++++++ .../models/brand_web_scrape_html_response.rbs | 34 +++++++- .../brand_web_scrape_images_response.rbs | 34 +++++++- .../models/brand_web_scrape_md_response.rbs | 34 +++++++- .../brand_web_scrape_sitemap_response.rbs | 34 +++++++- test/brand_dev/resources/brand_test.rb | 24 +++++- 51 files changed, 2153 insertions(+), 60 deletions(-) diff --git a/.stats.yml b/.stats.yml index 5dbaf4e..503623e 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 16 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-437213902ba1307c7c8733d00945a188a7aa6af9e5c1f7fa1a8ffcc0f692efc8.yml -openapi_spec_hash: 0141ce3e02c643164e5a09eb2f2e89b4 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-5545bb30aeac61ddb7d2b84ada399e9cd1cdc531a494b41e2ccf720056bdd437.yml +openapi_spec_hash: 554a88e7acd677dd0acac34b3900e5c6 config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 diff --git a/lib/brand_dev/internal/type/base_model.rb b/lib/brand_dev/internal/type/base_model.rb index f6f1397..102ee4e 100644 --- a/lib/brand_dev/internal/type/base_model.rb +++ b/lib/brand_dev/internal/type/base_model.rb @@ -442,7 +442,7 @@ def deep_to_h = self.class.recursively_to_h(@data, convert: false) # brand_retrieve_response => { # brand: brand, # code: code, - # status: status + # key_metadata: key_metadata # } def deconstruct_keys(keys) (keys || self.class.known_fields.keys) diff --git a/lib/brand_dev/models/brand_ai_product_response.rb b/lib/brand_dev/models/brand_ai_product_response.rb index ef4b2b9..89c082f 100644 --- a/lib/brand_dev/models/brand_ai_product_response.rb +++ b/lib/brand_dev/models/brand_ai_product_response.rb @@ -10,6 +10,13 @@ class BrandAIProductResponse < BrandDev::Internal::Type::BaseModel # @return [Boolean, nil] optional :is_product_page, BrandDev::Internal::Type::Boolean + # @!attribute key_metadata + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @return [BrandDev::Models::BrandAIProductResponse::KeyMetadata, nil] + optional :key_metadata, -> { BrandDev::Models::BrandAIProductResponse::KeyMetadata } + # @!attribute platform # The detected ecommerce platform, or null if not a product page # @@ -22,13 +29,41 @@ class BrandAIProductResponse < BrandDev::Internal::Type::BaseModel # @return [BrandDev::Models::BrandAIProductResponse::Product, nil] optional :product, -> { BrandDev::Models::BrandAIProductResponse::Product }, nil?: true - # @!method initialize(is_product_page: nil, platform: nil, product: nil) + # @!method initialize(is_product_page: nil, key_metadata: nil, platform: nil, product: nil) + # Some parameter documentations has been truncated, see + # {BrandDev::Models::BrandAIProductResponse} for more details. + # # @param is_product_page [Boolean] Whether the given URL is a product detail page # + # @param key_metadata [BrandDev::Models::BrandAIProductResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when + # # @param platform [Symbol, BrandDev::Models::BrandAIProductResponse::Platform, nil] The detected ecommerce platform, or null if not a product page # # @param product [BrandDev::Models::BrandAIProductResponse::Product, nil] The extracted product data, or null if not a product page + # @see BrandDev::Models::BrandAIProductResponse#key_metadata + class KeyMetadata < BrandDev::Internal::Type::BaseModel + # @!attribute credits_consumed + # The number of credits consumed by this request. + # + # @return [Integer] + required :credits_consumed, Integer + + # @!attribute credits_remaining + # The number of credits remaining for your organization after this request. + # + # @return [Integer] + required :credits_remaining, Integer + + # @!method initialize(credits_consumed:, credits_remaining:) + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @param credits_consumed [Integer] The number of credits consumed by this request. + # + # @param credits_remaining [Integer] The number of credits remaining for your organization after this request. + end + # The detected ecommerce platform, or null if not a product page # # @see BrandDev::Models::BrandAIProductResponse#platform diff --git a/lib/brand_dev/models/brand_ai_products_response.rb b/lib/brand_dev/models/brand_ai_products_response.rb index aab78c9..0832c47 100644 --- a/lib/brand_dev/models/brand_ai_products_response.rb +++ b/lib/brand_dev/models/brand_ai_products_response.rb @@ -4,6 +4,13 @@ module BrandDev module Models # @see BrandDev::Resources::Brand#ai_products class BrandAIProductsResponse < BrandDev::Internal::Type::BaseModel + # @!attribute key_metadata + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @return [BrandDev::Models::BrandAIProductsResponse::KeyMetadata, nil] + optional :key_metadata, -> { BrandDev::Models::BrandAIProductsResponse::KeyMetadata } + # @!attribute products # Array of products extracted from the website # @@ -11,9 +18,37 @@ class BrandAIProductsResponse < BrandDev::Internal::Type::BaseModel optional :products, -> { BrandDev::Internal::Type::ArrayOf[BrandDev::Models::BrandAIProductsResponse::Product] } - # @!method initialize(products: nil) + # @!method initialize(key_metadata: nil, products: nil) + # Some parameter documentations has been truncated, see + # {BrandDev::Models::BrandAIProductsResponse} for more details. + # + # @param key_metadata [BrandDev::Models::BrandAIProductsResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when + # # @param products [Array] Array of products extracted from the website + # @see BrandDev::Models::BrandAIProductsResponse#key_metadata + class KeyMetadata < BrandDev::Internal::Type::BaseModel + # @!attribute credits_consumed + # The number of credits consumed by this request. + # + # @return [Integer] + required :credits_consumed, Integer + + # @!attribute credits_remaining + # The number of credits remaining for your organization after this request. + # + # @return [Integer] + required :credits_remaining, Integer + + # @!method initialize(credits_consumed:, credits_remaining:) + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @param credits_consumed [Integer] The number of credits consumed by this request. + # + # @param credits_remaining [Integer] The number of credits remaining for your organization after this request. + end + class Product < BrandDev::Internal::Type::BaseModel # @!attribute description # Description of the product diff --git a/lib/brand_dev/models/brand_ai_query_response.rb b/lib/brand_dev/models/brand_ai_query_response.rb index b18da00..eed9465 100644 --- a/lib/brand_dev/models/brand_ai_query_response.rb +++ b/lib/brand_dev/models/brand_ai_query_response.rb @@ -17,6 +17,13 @@ class BrandAIQueryResponse < BrandDev::Internal::Type::BaseModel # @return [String, nil] optional :domain, String + # @!attribute key_metadata + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @return [BrandDev::Models::BrandAIQueryResponse::KeyMetadata, nil] + optional :key_metadata, -> { BrandDev::Models::BrandAIQueryResponse::KeyMetadata } + # @!attribute status # Status of the response, e.g., 'ok' # @@ -29,11 +36,16 @@ class BrandAIQueryResponse < BrandDev::Internal::Type::BaseModel # @return [Array, nil] optional :urls_analyzed, BrandDev::Internal::Type::ArrayOf[String] - # @!method initialize(data_extracted: nil, domain: nil, status: nil, urls_analyzed: nil) + # @!method initialize(data_extracted: nil, domain: nil, key_metadata: nil, status: nil, urls_analyzed: nil) + # Some parameter documentations has been truncated, see + # {BrandDev::Models::BrandAIQueryResponse} for more details. + # # @param data_extracted [Array] Array of extracted data points # # @param domain [String] The domain that was analyzed # + # @param key_metadata [BrandDev::Models::BrandAIQueryResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when + # # @param status [String] Status of the response, e.g., 'ok' # # @param urls_analyzed [Array] List of URLs that were analyzed @@ -93,6 +105,29 @@ module DatapointValue UnionMember5Array = BrandDev::Internal::Type::ArrayOf[BrandDev::Internal::Type::Unknown] end end + + # @see BrandDev::Models::BrandAIQueryResponse#key_metadata + class KeyMetadata < BrandDev::Internal::Type::BaseModel + # @!attribute credits_consumed + # The number of credits consumed by this request. + # + # @return [Integer] + required :credits_consumed, Integer + + # @!attribute credits_remaining + # The number of credits remaining for your organization after this request. + # + # @return [Integer] + required :credits_remaining, Integer + + # @!method initialize(credits_consumed:, credits_remaining:) + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @param credits_consumed [Integer] The number of credits consumed by this request. + # + # @param credits_remaining [Integer] The number of credits remaining for your organization after this request. + end end end end diff --git a/lib/brand_dev/models/brand_identify_from_transaction_response.rb b/lib/brand_dev/models/brand_identify_from_transaction_response.rb index 806800f..119a025 100644 --- a/lib/brand_dev/models/brand_identify_from_transaction_response.rb +++ b/lib/brand_dev/models/brand_identify_from_transaction_response.rb @@ -16,17 +16,29 @@ class BrandIdentifyFromTransactionResponse < BrandDev::Internal::Type::BaseModel # @return [Integer, nil] optional :code, Integer + # @!attribute key_metadata + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @return [BrandDev::Models::BrandIdentifyFromTransactionResponse::KeyMetadata, nil] + optional :key_metadata, -> { BrandDev::Models::BrandIdentifyFromTransactionResponse::KeyMetadata } + # @!attribute status # Status of the response, e.g., 'ok' # # @return [String, nil] optional :status, String - # @!method initialize(brand: nil, code: nil, status: nil) + # @!method initialize(brand: nil, code: nil, key_metadata: nil, status: nil) + # Some parameter documentations has been truncated, see + # {BrandDev::Models::BrandIdentifyFromTransactionResponse} for more details. + # # @param brand [BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand] Detailed brand information # # @param code [Integer] HTTP status code # + # @param key_metadata [BrandDev::Models::BrandIdentifyFromTransactionResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when + # # @param status [String] Status of the response, e.g., 'ok' # @see BrandDev::Models::BrandIdentifyFromTransactionResponse#brand @@ -1034,6 +1046,29 @@ class Stock < BrandDev::Internal::Type::BaseModel # @param ticker [String] Stock ticker symbol end end + + # @see BrandDev::Models::BrandIdentifyFromTransactionResponse#key_metadata + class KeyMetadata < BrandDev::Internal::Type::BaseModel + # @!attribute credits_consumed + # The number of credits consumed by this request. + # + # @return [Integer] + required :credits_consumed, Integer + + # @!attribute credits_remaining + # The number of credits remaining for your organization after this request. + # + # @return [Integer] + required :credits_remaining, Integer + + # @!method initialize(credits_consumed:, credits_remaining:) + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @param credits_consumed [Integer] The number of credits consumed by this request. + # + # @param credits_remaining [Integer] The number of credits remaining for your organization after this request. + end end end end diff --git a/lib/brand_dev/models/brand_prefetch_by_email_response.rb b/lib/brand_dev/models/brand_prefetch_by_email_response.rb index cf93c18..7489760 100644 --- a/lib/brand_dev/models/brand_prefetch_by_email_response.rb +++ b/lib/brand_dev/models/brand_prefetch_by_email_response.rb @@ -10,6 +10,13 @@ class BrandPrefetchByEmailResponse < BrandDev::Internal::Type::BaseModel # @return [String, nil] optional :domain, String + # @!attribute key_metadata + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @return [BrandDev::Models::BrandPrefetchByEmailResponse::KeyMetadata, nil] + optional :key_metadata, -> { BrandDev::Models::BrandPrefetchByEmailResponse::KeyMetadata } + # @!attribute message # Success message # @@ -22,12 +29,40 @@ class BrandPrefetchByEmailResponse < BrandDev::Internal::Type::BaseModel # @return [String, nil] optional :status, String - # @!method initialize(domain: nil, message: nil, status: nil) + # @!method initialize(domain: nil, key_metadata: nil, message: nil, status: nil) + # Some parameter documentations has been truncated, see + # {BrandDev::Models::BrandPrefetchByEmailResponse} for more details. + # # @param domain [String] The domain that was queued for prefetching # + # @param key_metadata [BrandDev::Models::BrandPrefetchByEmailResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when + # # @param message [String] Success message # # @param status [String] Status of the response, e.g., 'ok' + + # @see BrandDev::Models::BrandPrefetchByEmailResponse#key_metadata + class KeyMetadata < BrandDev::Internal::Type::BaseModel + # @!attribute credits_consumed + # The number of credits consumed by this request. + # + # @return [Integer] + required :credits_consumed, Integer + + # @!attribute credits_remaining + # The number of credits remaining for your organization after this request. + # + # @return [Integer] + required :credits_remaining, Integer + + # @!method initialize(credits_consumed:, credits_remaining:) + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @param credits_consumed [Integer] The number of credits consumed by this request. + # + # @param credits_remaining [Integer] The number of credits remaining for your organization after this request. + end end end end diff --git a/lib/brand_dev/models/brand_prefetch_response.rb b/lib/brand_dev/models/brand_prefetch_response.rb index 20186df..4246b11 100644 --- a/lib/brand_dev/models/brand_prefetch_response.rb +++ b/lib/brand_dev/models/brand_prefetch_response.rb @@ -10,6 +10,13 @@ class BrandPrefetchResponse < BrandDev::Internal::Type::BaseModel # @return [String, nil] optional :domain, String + # @!attribute key_metadata + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @return [BrandDev::Models::BrandPrefetchResponse::KeyMetadata, nil] + optional :key_metadata, -> { BrandDev::Models::BrandPrefetchResponse::KeyMetadata } + # @!attribute message # Success message # @@ -22,12 +29,40 @@ class BrandPrefetchResponse < BrandDev::Internal::Type::BaseModel # @return [String, nil] optional :status, String - # @!method initialize(domain: nil, message: nil, status: nil) + # @!method initialize(domain: nil, key_metadata: nil, message: nil, status: nil) + # Some parameter documentations has been truncated, see + # {BrandDev::Models::BrandPrefetchResponse} for more details. + # # @param domain [String] The domain that was queued for prefetching # + # @param key_metadata [BrandDev::Models::BrandPrefetchResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when + # # @param message [String] Success message # # @param status [String] Status of the response, e.g., 'ok' + + # @see BrandDev::Models::BrandPrefetchResponse#key_metadata + class KeyMetadata < BrandDev::Internal::Type::BaseModel + # @!attribute credits_consumed + # The number of credits consumed by this request. + # + # @return [Integer] + required :credits_consumed, Integer + + # @!attribute credits_remaining + # The number of credits remaining for your organization after this request. + # + # @return [Integer] + required :credits_remaining, Integer + + # @!method initialize(credits_consumed:, credits_remaining:) + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @param credits_consumed [Integer] The number of credits consumed by this request. + # + # @param credits_remaining [Integer] The number of credits remaining for your organization after this request. + end end end end diff --git a/lib/brand_dev/models/brand_retrieve_by_email_response.rb b/lib/brand_dev/models/brand_retrieve_by_email_response.rb index a279015..99d6b32 100644 --- a/lib/brand_dev/models/brand_retrieve_by_email_response.rb +++ b/lib/brand_dev/models/brand_retrieve_by_email_response.rb @@ -16,17 +16,29 @@ class BrandRetrieveByEmailResponse < BrandDev::Internal::Type::BaseModel # @return [Integer, nil] optional :code, Integer + # @!attribute key_metadata + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @return [BrandDev::Models::BrandRetrieveByEmailResponse::KeyMetadata, nil] + optional :key_metadata, -> { BrandDev::Models::BrandRetrieveByEmailResponse::KeyMetadata } + # @!attribute status # Status of the response, e.g., 'ok' # # @return [String, nil] optional :status, String - # @!method initialize(brand: nil, code: nil, status: nil) + # @!method initialize(brand: nil, code: nil, key_metadata: nil, status: nil) + # Some parameter documentations has been truncated, see + # {BrandDev::Models::BrandRetrieveByEmailResponse} for more details. + # # @param brand [BrandDev::Models::BrandRetrieveByEmailResponse::Brand] Detailed brand information # # @param code [Integer] HTTP status code # + # @param key_metadata [BrandDev::Models::BrandRetrieveByEmailResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when + # # @param status [String] Status of the response, e.g., 'ok' # @see BrandDev::Models::BrandRetrieveByEmailResponse#brand @@ -1030,6 +1042,29 @@ class Stock < BrandDev::Internal::Type::BaseModel # @param ticker [String] Stock ticker symbol end end + + # @see BrandDev::Models::BrandRetrieveByEmailResponse#key_metadata + class KeyMetadata < BrandDev::Internal::Type::BaseModel + # @!attribute credits_consumed + # The number of credits consumed by this request. + # + # @return [Integer] + required :credits_consumed, Integer + + # @!attribute credits_remaining + # The number of credits remaining for your organization after this request. + # + # @return [Integer] + required :credits_remaining, Integer + + # @!method initialize(credits_consumed:, credits_remaining:) + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @param credits_consumed [Integer] The number of credits consumed by this request. + # + # @param credits_remaining [Integer] The number of credits remaining for your organization after this request. + end end end end diff --git a/lib/brand_dev/models/brand_retrieve_by_isin_response.rb b/lib/brand_dev/models/brand_retrieve_by_isin_response.rb index f1ea518..6b379bb 100644 --- a/lib/brand_dev/models/brand_retrieve_by_isin_response.rb +++ b/lib/brand_dev/models/brand_retrieve_by_isin_response.rb @@ -16,17 +16,29 @@ class BrandRetrieveByIsinResponse < BrandDev::Internal::Type::BaseModel # @return [Integer, nil] optional :code, Integer + # @!attribute key_metadata + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @return [BrandDev::Models::BrandRetrieveByIsinResponse::KeyMetadata, nil] + optional :key_metadata, -> { BrandDev::Models::BrandRetrieveByIsinResponse::KeyMetadata } + # @!attribute status # Status of the response, e.g., 'ok' # # @return [String, nil] optional :status, String - # @!method initialize(brand: nil, code: nil, status: nil) + # @!method initialize(brand: nil, code: nil, key_metadata: nil, status: nil) + # Some parameter documentations has been truncated, see + # {BrandDev::Models::BrandRetrieveByIsinResponse} for more details. + # # @param brand [BrandDev::Models::BrandRetrieveByIsinResponse::Brand] Detailed brand information # # @param code [Integer] HTTP status code # + # @param key_metadata [BrandDev::Models::BrandRetrieveByIsinResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when + # # @param status [String] Status of the response, e.g., 'ok' # @see BrandDev::Models::BrandRetrieveByIsinResponse#brand @@ -1030,6 +1042,29 @@ class Stock < BrandDev::Internal::Type::BaseModel # @param ticker [String] Stock ticker symbol end end + + # @see BrandDev::Models::BrandRetrieveByIsinResponse#key_metadata + class KeyMetadata < BrandDev::Internal::Type::BaseModel + # @!attribute credits_consumed + # The number of credits consumed by this request. + # + # @return [Integer] + required :credits_consumed, Integer + + # @!attribute credits_remaining + # The number of credits remaining for your organization after this request. + # + # @return [Integer] + required :credits_remaining, Integer + + # @!method initialize(credits_consumed:, credits_remaining:) + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @param credits_consumed [Integer] The number of credits consumed by this request. + # + # @param credits_remaining [Integer] The number of credits remaining for your organization after this request. + end end end end diff --git a/lib/brand_dev/models/brand_retrieve_by_name_response.rb b/lib/brand_dev/models/brand_retrieve_by_name_response.rb index d06366b..f8529f9 100644 --- a/lib/brand_dev/models/brand_retrieve_by_name_response.rb +++ b/lib/brand_dev/models/brand_retrieve_by_name_response.rb @@ -16,17 +16,29 @@ class BrandRetrieveByNameResponse < BrandDev::Internal::Type::BaseModel # @return [Integer, nil] optional :code, Integer + # @!attribute key_metadata + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @return [BrandDev::Models::BrandRetrieveByNameResponse::KeyMetadata, nil] + optional :key_metadata, -> { BrandDev::Models::BrandRetrieveByNameResponse::KeyMetadata } + # @!attribute status # Status of the response, e.g., 'ok' # # @return [String, nil] optional :status, String - # @!method initialize(brand: nil, code: nil, status: nil) + # @!method initialize(brand: nil, code: nil, key_metadata: nil, status: nil) + # Some parameter documentations has been truncated, see + # {BrandDev::Models::BrandRetrieveByNameResponse} for more details. + # # @param brand [BrandDev::Models::BrandRetrieveByNameResponse::Brand] Detailed brand information # # @param code [Integer] HTTP status code # + # @param key_metadata [BrandDev::Models::BrandRetrieveByNameResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when + # # @param status [String] Status of the response, e.g., 'ok' # @see BrandDev::Models::BrandRetrieveByNameResponse#brand @@ -1030,6 +1042,29 @@ class Stock < BrandDev::Internal::Type::BaseModel # @param ticker [String] Stock ticker symbol end end + + # @see BrandDev::Models::BrandRetrieveByNameResponse#key_metadata + class KeyMetadata < BrandDev::Internal::Type::BaseModel + # @!attribute credits_consumed + # The number of credits consumed by this request. + # + # @return [Integer] + required :credits_consumed, Integer + + # @!attribute credits_remaining + # The number of credits remaining for your organization after this request. + # + # @return [Integer] + required :credits_remaining, Integer + + # @!method initialize(credits_consumed:, credits_remaining:) + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @param credits_consumed [Integer] The number of credits consumed by this request. + # + # @param credits_remaining [Integer] The number of credits remaining for your organization after this request. + end end end end diff --git a/lib/brand_dev/models/brand_retrieve_by_ticker_response.rb b/lib/brand_dev/models/brand_retrieve_by_ticker_response.rb index f2095db..77ffc78 100644 --- a/lib/brand_dev/models/brand_retrieve_by_ticker_response.rb +++ b/lib/brand_dev/models/brand_retrieve_by_ticker_response.rb @@ -16,17 +16,29 @@ class BrandRetrieveByTickerResponse < BrandDev::Internal::Type::BaseModel # @return [Integer, nil] optional :code, Integer + # @!attribute key_metadata + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @return [BrandDev::Models::BrandRetrieveByTickerResponse::KeyMetadata, nil] + optional :key_metadata, -> { BrandDev::Models::BrandRetrieveByTickerResponse::KeyMetadata } + # @!attribute status # Status of the response, e.g., 'ok' # # @return [String, nil] optional :status, String - # @!method initialize(brand: nil, code: nil, status: nil) + # @!method initialize(brand: nil, code: nil, key_metadata: nil, status: nil) + # Some parameter documentations has been truncated, see + # {BrandDev::Models::BrandRetrieveByTickerResponse} for more details. + # # @param brand [BrandDev::Models::BrandRetrieveByTickerResponse::Brand] Detailed brand information # # @param code [Integer] HTTP status code # + # @param key_metadata [BrandDev::Models::BrandRetrieveByTickerResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when + # # @param status [String] Status of the response, e.g., 'ok' # @see BrandDev::Models::BrandRetrieveByTickerResponse#brand @@ -1030,6 +1042,29 @@ class Stock < BrandDev::Internal::Type::BaseModel # @param ticker [String] Stock ticker symbol end end + + # @see BrandDev::Models::BrandRetrieveByTickerResponse#key_metadata + class KeyMetadata < BrandDev::Internal::Type::BaseModel + # @!attribute credits_consumed + # The number of credits consumed by this request. + # + # @return [Integer] + required :credits_consumed, Integer + + # @!attribute credits_remaining + # The number of credits remaining for your organization after this request. + # + # @return [Integer] + required :credits_remaining, Integer + + # @!method initialize(credits_consumed:, credits_remaining:) + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @param credits_consumed [Integer] The number of credits consumed by this request. + # + # @param credits_remaining [Integer] The number of credits remaining for your organization after this request. + end end end end diff --git a/lib/brand_dev/models/brand_retrieve_response.rb b/lib/brand_dev/models/brand_retrieve_response.rb index 7a57caf..3c0a5fb 100644 --- a/lib/brand_dev/models/brand_retrieve_response.rb +++ b/lib/brand_dev/models/brand_retrieve_response.rb @@ -16,17 +16,29 @@ class BrandRetrieveResponse < BrandDev::Internal::Type::BaseModel # @return [Integer, nil] optional :code, Integer + # @!attribute key_metadata + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @return [BrandDev::Models::BrandRetrieveResponse::KeyMetadata, nil] + optional :key_metadata, -> { BrandDev::Models::BrandRetrieveResponse::KeyMetadata } + # @!attribute status # Status of the response, e.g., 'ok' # # @return [String, nil] optional :status, String - # @!method initialize(brand: nil, code: nil, status: nil) + # @!method initialize(brand: nil, code: nil, key_metadata: nil, status: nil) + # Some parameter documentations has been truncated, see + # {BrandDev::Models::BrandRetrieveResponse} for more details. + # # @param brand [BrandDev::Models::BrandRetrieveResponse::Brand] Detailed brand information # # @param code [Integer] HTTP status code # + # @param key_metadata [BrandDev::Models::BrandRetrieveResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when + # # @param status [String] Status of the response, e.g., 'ok' # @see BrandDev::Models::BrandRetrieveResponse#brand @@ -1029,6 +1041,29 @@ class Stock < BrandDev::Internal::Type::BaseModel # @param ticker [String] Stock ticker symbol end end + + # @see BrandDev::Models::BrandRetrieveResponse#key_metadata + class KeyMetadata < BrandDev::Internal::Type::BaseModel + # @!attribute credits_consumed + # The number of credits consumed by this request. + # + # @return [Integer] + required :credits_consumed, Integer + + # @!attribute credits_remaining + # The number of credits remaining for your organization after this request. + # + # @return [Integer] + required :credits_remaining, Integer + + # @!method initialize(credits_consumed:, credits_remaining:) + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @param credits_consumed [Integer] The number of credits consumed by this request. + # + # @param credits_remaining [Integer] The number of credits remaining for your organization after this request. + end end end end diff --git a/lib/brand_dev/models/brand_retrieve_simplified_response.rb b/lib/brand_dev/models/brand_retrieve_simplified_response.rb index 0a15397..975277e 100644 --- a/lib/brand_dev/models/brand_retrieve_simplified_response.rb +++ b/lib/brand_dev/models/brand_retrieve_simplified_response.rb @@ -16,17 +16,29 @@ class BrandRetrieveSimplifiedResponse < BrandDev::Internal::Type::BaseModel # @return [Integer, nil] optional :code, Integer + # @!attribute key_metadata + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @return [BrandDev::Models::BrandRetrieveSimplifiedResponse::KeyMetadata, nil] + optional :key_metadata, -> { BrandDev::Models::BrandRetrieveSimplifiedResponse::KeyMetadata } + # @!attribute status # Status of the response, e.g., 'ok' # # @return [String, nil] optional :status, String - # @!method initialize(brand: nil, code: nil, status: nil) + # @!method initialize(brand: nil, code: nil, key_metadata: nil, status: nil) + # Some parameter documentations has been truncated, see + # {BrandDev::Models::BrandRetrieveSimplifiedResponse} for more details. + # # @param brand [BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand] Simplified brand information # # @param code [Integer] HTTP status code of the response # + # @param key_metadata [BrandDev::Models::BrandRetrieveSimplifiedResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when + # # @param status [String] Status of the response, e.g., 'ok' # @see BrandDev::Models::BrandRetrieveSimplifiedResponse#brand @@ -302,6 +314,29 @@ module Type end end end + + # @see BrandDev::Models::BrandRetrieveSimplifiedResponse#key_metadata + class KeyMetadata < BrandDev::Internal::Type::BaseModel + # @!attribute credits_consumed + # The number of credits consumed by this request. + # + # @return [Integer] + required :credits_consumed, Integer + + # @!attribute credits_remaining + # The number of credits remaining for your organization after this request. + # + # @return [Integer] + required :credits_remaining, Integer + + # @!method initialize(credits_consumed:, credits_remaining:) + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @param credits_consumed [Integer] The number of credits consumed by this request. + # + # @param credits_remaining [Integer] The number of credits remaining for your organization after this request. + end end end end diff --git a/lib/brand_dev/models/brand_web_scrape_html_response.rb b/lib/brand_dev/models/brand_web_scrape_html_response.rb index 4b7d15e..fc61d41 100644 --- a/lib/brand_dev/models/brand_web_scrape_html_response.rb +++ b/lib/brand_dev/models/brand_web_scrape_html_response.rb @@ -31,7 +31,14 @@ class BrandWebScrapeHTMLResponse < BrandDev::Internal::Type::BaseModel # @return [String] required :url, String - # @!method initialize(html:, success:, type:, url:) + # @!attribute key_metadata + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @return [BrandDev::Models::BrandWebScrapeHTMLResponse::KeyMetadata, nil] + optional :key_metadata, -> { BrandDev::Models::BrandWebScrapeHTMLResponse::KeyMetadata } + + # @!method initialize(html:, success:, type:, url:, key_metadata: nil) # Some parameter documentations has been truncated, see # {BrandDev::Models::BrandWebScrapeHTMLResponse} for more details. # @@ -42,6 +49,8 @@ class BrandWebScrapeHTMLResponse < BrandDev::Internal::Type::BaseModel # @param type [Symbol, BrandDev::Models::BrandWebScrapeHTMLResponse::Type] Detected content type of the returned `html` field. Sitemaps and feeds are surfa # # @param url [String] The URL that was scraped + # + # @param key_metadata [BrandDev::Models::BrandWebScrapeHTMLResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when # Indicates success # @@ -74,6 +83,29 @@ module Type # @!method self.values # @return [Array] end + + # @see BrandDev::Models::BrandWebScrapeHTMLResponse#key_metadata + class KeyMetadata < BrandDev::Internal::Type::BaseModel + # @!attribute credits_consumed + # The number of credits consumed by this request. + # + # @return [Integer] + required :credits_consumed, Integer + + # @!attribute credits_remaining + # The number of credits remaining for your organization after this request. + # + # @return [Integer] + required :credits_remaining, Integer + + # @!method initialize(credits_consumed:, credits_remaining:) + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @param credits_consumed [Integer] The number of credits consumed by this request. + # + # @param credits_remaining [Integer] The number of credits remaining for your organization after this request. + end end end end diff --git a/lib/brand_dev/models/brand_web_scrape_images_response.rb b/lib/brand_dev/models/brand_web_scrape_images_response.rb index fae9ebb..5a31fbe 100644 --- a/lib/brand_dev/models/brand_web_scrape_images_response.rb +++ b/lib/brand_dev/models/brand_web_scrape_images_response.rb @@ -23,12 +23,24 @@ class BrandWebScrapeImagesResponse < BrandDev::Internal::Type::BaseModel # @return [String] required :url, String - # @!method initialize(images:, success:, url:) + # @!attribute key_metadata + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @return [BrandDev::Models::BrandWebScrapeImagesResponse::KeyMetadata, nil] + optional :key_metadata, -> { BrandDev::Models::BrandWebScrapeImagesResponse::KeyMetadata } + + # @!method initialize(images:, success:, url:, key_metadata: nil) + # Some parameter documentations has been truncated, see + # {BrandDev::Models::BrandWebScrapeImagesResponse} for more details. + # # @param images [Array] Images found on the page. # # @param success [Boolean, BrandDev::Models::BrandWebScrapeImagesResponse::Success] Always true on success. # # @param url [String] Page URL that was scraped. + # + # @param key_metadata [BrandDev::Models::BrandWebScrapeImagesResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when class Image < BrandDev::Internal::Type::BaseModel # @!attribute alt @@ -183,6 +195,29 @@ module Success # @!method self.values # @return [Array] end + + # @see BrandDev::Models::BrandWebScrapeImagesResponse#key_metadata + class KeyMetadata < BrandDev::Internal::Type::BaseModel + # @!attribute credits_consumed + # The number of credits consumed by this request. + # + # @return [Integer] + required :credits_consumed, Integer + + # @!attribute credits_remaining + # The number of credits remaining for your organization after this request. + # + # @return [Integer] + required :credits_remaining, Integer + + # @!method initialize(credits_consumed:, credits_remaining:) + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @param credits_consumed [Integer] The number of credits consumed by this request. + # + # @param credits_remaining [Integer] The number of credits remaining for your organization after this request. + end end end end diff --git a/lib/brand_dev/models/brand_web_scrape_md_response.rb b/lib/brand_dev/models/brand_web_scrape_md_response.rb index ed96763..4f3300d 100644 --- a/lib/brand_dev/models/brand_web_scrape_md_response.rb +++ b/lib/brand_dev/models/brand_web_scrape_md_response.rb @@ -22,12 +22,24 @@ class BrandWebScrapeMdResponse < BrandDev::Internal::Type::BaseModel # @return [String] required :url, String - # @!method initialize(markdown:, success:, url:) + # @!attribute key_metadata + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @return [BrandDev::Models::BrandWebScrapeMdResponse::KeyMetadata, nil] + optional :key_metadata, -> { BrandDev::Models::BrandWebScrapeMdResponse::KeyMetadata } + + # @!method initialize(markdown:, success:, url:, key_metadata: nil) + # Some parameter documentations has been truncated, see + # {BrandDev::Models::BrandWebScrapeMdResponse} for more details. + # # @param markdown [String] Page content converted to GitHub Flavored Markdown # # @param success [Boolean, BrandDev::Models::BrandWebScrapeMdResponse::Success] Indicates success # # @param url [String] The URL that was scraped + # + # @param key_metadata [BrandDev::Models::BrandWebScrapeMdResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when # Indicates success # @@ -40,6 +52,29 @@ module Success # @!method self.values # @return [Array] end + + # @see BrandDev::Models::BrandWebScrapeMdResponse#key_metadata + class KeyMetadata < BrandDev::Internal::Type::BaseModel + # @!attribute credits_consumed + # The number of credits consumed by this request. + # + # @return [Integer] + required :credits_consumed, Integer + + # @!attribute credits_remaining + # The number of credits remaining for your organization after this request. + # + # @return [Integer] + required :credits_remaining, Integer + + # @!method initialize(credits_consumed:, credits_remaining:) + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @param credits_consumed [Integer] The number of credits consumed by this request. + # + # @param credits_remaining [Integer] The number of credits remaining for your organization after this request. + end end end end diff --git a/lib/brand_dev/models/brand_web_scrape_sitemap_response.rb b/lib/brand_dev/models/brand_web_scrape_sitemap_response.rb index a442381..38ab124 100644 --- a/lib/brand_dev/models/brand_web_scrape_sitemap_response.rb +++ b/lib/brand_dev/models/brand_web_scrape_sitemap_response.rb @@ -28,7 +28,17 @@ class BrandWebScrapeSitemapResponse < BrandDev::Internal::Type::BaseModel # @return [Array] required :urls, BrandDev::Internal::Type::ArrayOf[String] - # @!method initialize(domain:, meta:, success:, urls:) + # @!attribute key_metadata + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @return [BrandDev::Models::BrandWebScrapeSitemapResponse::KeyMetadata, nil] + optional :key_metadata, -> { BrandDev::Models::BrandWebScrapeSitemapResponse::KeyMetadata } + + # @!method initialize(domain:, meta:, success:, urls:, key_metadata: nil) + # Some parameter documentations has been truncated, see + # {BrandDev::Models::BrandWebScrapeSitemapResponse} for more details. + # # @param domain [String] The normalized domain that was crawled # # @param meta [BrandDev::Models::BrandWebScrapeSitemapResponse::Meta] Metadata about the sitemap crawl operation @@ -36,6 +46,8 @@ class BrandWebScrapeSitemapResponse < BrandDev::Internal::Type::BaseModel # @param success [Boolean, BrandDev::Models::BrandWebScrapeSitemapResponse::Success] Indicates success # # @param urls [Array] Array of discovered page URLs from the sitemap (max 500) + # + # @param key_metadata [BrandDev::Models::BrandWebScrapeSitemapResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when # @see BrandDev::Models::BrandWebScrapeSitemapResponse#meta class Meta < BrandDev::Internal::Type::BaseModel @@ -86,6 +98,29 @@ module Success # @!method self.values # @return [Array] end + + # @see BrandDev::Models::BrandWebScrapeSitemapResponse#key_metadata + class KeyMetadata < BrandDev::Internal::Type::BaseModel + # @!attribute credits_consumed + # The number of credits consumed by this request. + # + # @return [Integer] + required :credits_consumed, Integer + + # @!attribute credits_remaining + # The number of credits remaining for your organization after this request. + # + # @return [Integer] + required :credits_remaining, Integer + + # @!method initialize(credits_consumed:, credits_remaining:) + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @param credits_consumed [Integer] The number of credits consumed by this request. + # + # @param credits_remaining [Integer] The number of credits remaining for your organization after this request. + end end end end diff --git a/rbi/brand_dev/models/brand_ai_product_response.rbi b/rbi/brand_dev/models/brand_ai_product_response.rbi index 153843d..dbab0fd 100644 --- a/rbi/brand_dev/models/brand_ai_product_response.rbi +++ b/rbi/brand_dev/models/brand_ai_product_response.rbi @@ -18,6 +18,23 @@ module BrandDev sig { params(is_product_page: T::Boolean).void } attr_writer :is_product_page + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + returns( + T.nilable(BrandDev::Models::BrandAIProductResponse::KeyMetadata) + ) + end + attr_reader :key_metadata + + sig do + params( + key_metadata: + BrandDev::Models::BrandAIProductResponse::KeyMetadata::OrHash + ).void + end + attr_writer :key_metadata + # The detected ecommerce platform, or null if not a product page sig do returns( @@ -45,6 +62,8 @@ module BrandDev sig do params( is_product_page: T::Boolean, + key_metadata: + BrandDev::Models::BrandAIProductResponse::KeyMetadata::OrHash, platform: T.nilable( BrandDev::Models::BrandAIProductResponse::Platform::OrSymbol @@ -56,6 +75,9 @@ module BrandDev def self.new( # Whether the given URL is a product detail page is_product_page: nil, + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + key_metadata: nil, # The detected ecommerce platform, or null if not a product page platform: nil, # The extracted product data, or null if not a product page @@ -67,6 +89,7 @@ module BrandDev override.returns( { is_product_page: T::Boolean, + key_metadata: BrandDev::Models::BrandAIProductResponse::KeyMetadata, platform: T.nilable( BrandDev::Models::BrandAIProductResponse::Platform::TaggedSymbol @@ -79,6 +102,47 @@ module BrandDev def to_hash end + class KeyMetadata < BrandDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + BrandDev::Models::BrandAIProductResponse::KeyMetadata, + BrandDev::Internal::AnyHash + ) + end + + # The number of credits consumed by this request. + sig { returns(Integer) } + attr_accessor :credits_consumed + + # The number of credits remaining for your organization after this request. + sig { returns(Integer) } + attr_accessor :credits_remaining + + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + params(credits_consumed: Integer, credits_remaining: Integer).returns( + T.attached_class + ) + end + def self.new( + # The number of credits consumed by this request. + credits_consumed:, + # The number of credits remaining for your organization after this request. + credits_remaining: + ) + end + + sig do + override.returns( + { credits_consumed: Integer, credits_remaining: Integer } + ) + end + def to_hash + end + end + # The detected ecommerce platform, or null if not a product page module Platform extend BrandDev::Internal::Type::Enum diff --git a/rbi/brand_dev/models/brand_ai_products_response.rbi b/rbi/brand_dev/models/brand_ai_products_response.rbi index 41c376e..97f60e3 100644 --- a/rbi/brand_dev/models/brand_ai_products_response.rbi +++ b/rbi/brand_dev/models/brand_ai_products_response.rbi @@ -11,6 +11,23 @@ module BrandDev ) end + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + returns( + T.nilable(BrandDev::Models::BrandAIProductsResponse::KeyMetadata) + ) + end + attr_reader :key_metadata + + sig do + params( + key_metadata: + BrandDev::Models::BrandAIProductsResponse::KeyMetadata::OrHash + ).void + end + attr_writer :key_metadata + # Array of products extracted from the website sig do returns( @@ -31,11 +48,16 @@ module BrandDev sig do params( + key_metadata: + BrandDev::Models::BrandAIProductsResponse::KeyMetadata::OrHash, products: T::Array[BrandDev::Models::BrandAIProductsResponse::Product::OrHash] ).returns(T.attached_class) end def self.new( + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + key_metadata: nil, # Array of products extracted from the website products: nil ) @@ -44,6 +66,8 @@ module BrandDev sig do override.returns( { + key_metadata: + BrandDev::Models::BrandAIProductsResponse::KeyMetadata, products: T::Array[BrandDev::Models::BrandAIProductsResponse::Product] } @@ -52,6 +76,47 @@ module BrandDev def to_hash end + class KeyMetadata < BrandDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + BrandDev::Models::BrandAIProductsResponse::KeyMetadata, + BrandDev::Internal::AnyHash + ) + end + + # The number of credits consumed by this request. + sig { returns(Integer) } + attr_accessor :credits_consumed + + # The number of credits remaining for your organization after this request. + sig { returns(Integer) } + attr_accessor :credits_remaining + + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + params(credits_consumed: Integer, credits_remaining: Integer).returns( + T.attached_class + ) + end + def self.new( + # The number of credits consumed by this request. + credits_consumed:, + # The number of credits remaining for your organization after this request. + credits_remaining: + ) + end + + sig do + override.returns( + { credits_consumed: Integer, credits_remaining: Integer } + ) + end + def to_hash + end + end + class Product < BrandDev::Internal::Type::BaseModel OrHash = T.type_alias do diff --git a/rbi/brand_dev/models/brand_ai_query_response.rbi b/rbi/brand_dev/models/brand_ai_query_response.rbi index d7bc1c1..76363dd 100644 --- a/rbi/brand_dev/models/brand_ai_query_response.rbi +++ b/rbi/brand_dev/models/brand_ai_query_response.rbi @@ -38,6 +38,21 @@ module BrandDev sig { params(domain: String).void } attr_writer :domain + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + returns(T.nilable(BrandDev::Models::BrandAIQueryResponse::KeyMetadata)) + end + attr_reader :key_metadata + + sig do + params( + key_metadata: + BrandDev::Models::BrandAIQueryResponse::KeyMetadata::OrHash + ).void + end + attr_writer :key_metadata + # Status of the response, e.g., 'ok' sig { returns(T.nilable(String)) } attr_reader :status @@ -59,6 +74,8 @@ module BrandDev BrandDev::Models::BrandAIQueryResponse::DataExtracted::OrHash ], domain: String, + key_metadata: + BrandDev::Models::BrandAIQueryResponse::KeyMetadata::OrHash, status: String, urls_analyzed: T::Array[String] ).returns(T.attached_class) @@ -68,6 +85,9 @@ module BrandDev data_extracted: nil, # The domain that was analyzed domain: nil, + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + key_metadata: nil, # Status of the response, e.g., 'ok' status: nil, # List of URLs that were analyzed @@ -81,6 +101,7 @@ module BrandDev data_extracted: T::Array[BrandDev::Models::BrandAIQueryResponse::DataExtracted], domain: String, + key_metadata: BrandDev::Models::BrandAIQueryResponse::KeyMetadata, status: String, urls_analyzed: T::Array[String] } @@ -200,6 +221,47 @@ module BrandDev ) end end + + class KeyMetadata < BrandDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + BrandDev::Models::BrandAIQueryResponse::KeyMetadata, + BrandDev::Internal::AnyHash + ) + end + + # The number of credits consumed by this request. + sig { returns(Integer) } + attr_accessor :credits_consumed + + # The number of credits remaining for your organization after this request. + sig { returns(Integer) } + attr_accessor :credits_remaining + + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + params(credits_consumed: Integer, credits_remaining: Integer).returns( + T.attached_class + ) + end + def self.new( + # The number of credits consumed by this request. + credits_consumed:, + # The number of credits remaining for your organization after this request. + credits_remaining: + ) + end + + sig do + override.returns( + { credits_consumed: Integer, credits_remaining: Integer } + ) + end + def to_hash + end + end end end end diff --git a/rbi/brand_dev/models/brand_identify_from_transaction_response.rbi b/rbi/brand_dev/models/brand_identify_from_transaction_response.rbi index 435a96a..7379fad 100644 --- a/rbi/brand_dev/models/brand_identify_from_transaction_response.rbi +++ b/rbi/brand_dev/models/brand_identify_from_transaction_response.rbi @@ -36,6 +36,25 @@ module BrandDev sig { params(code: Integer).void } attr_writer :code + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + returns( + T.nilable( + BrandDev::Models::BrandIdentifyFromTransactionResponse::KeyMetadata + ) + ) + end + attr_reader :key_metadata + + sig do + params( + key_metadata: + BrandDev::Models::BrandIdentifyFromTransactionResponse::KeyMetadata::OrHash + ).void + end + attr_writer :key_metadata + # Status of the response, e.g., 'ok' sig { returns(T.nilable(String)) } attr_reader :status @@ -48,6 +67,8 @@ module BrandDev brand: BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::OrHash, code: Integer, + key_metadata: + BrandDev::Models::BrandIdentifyFromTransactionResponse::KeyMetadata::OrHash, status: String ).returns(T.attached_class) end @@ -56,6 +77,9 @@ module BrandDev brand: nil, # HTTP status code code: nil, + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + key_metadata: nil, # Status of the response, e.g., 'ok' status: nil ) @@ -67,6 +91,8 @@ module BrandDev brand: BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand, code: Integer, + key_metadata: + BrandDev::Models::BrandIdentifyFromTransactionResponse::KeyMetadata, status: String } ) @@ -3443,6 +3469,47 @@ module BrandDev end end end + + class KeyMetadata < BrandDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + BrandDev::Models::BrandIdentifyFromTransactionResponse::KeyMetadata, + BrandDev::Internal::AnyHash + ) + end + + # The number of credits consumed by this request. + sig { returns(Integer) } + attr_accessor :credits_consumed + + # The number of credits remaining for your organization after this request. + sig { returns(Integer) } + attr_accessor :credits_remaining + + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + params(credits_consumed: Integer, credits_remaining: Integer).returns( + T.attached_class + ) + end + def self.new( + # The number of credits consumed by this request. + credits_consumed:, + # The number of credits remaining for your organization after this request. + credits_remaining: + ) + end + + sig do + override.returns( + { credits_consumed: Integer, credits_remaining: Integer } + ) + end + def to_hash + end + end end end end diff --git a/rbi/brand_dev/models/brand_prefetch_by_email_response.rbi b/rbi/brand_dev/models/brand_prefetch_by_email_response.rbi index cc66aa0..6994d41 100644 --- a/rbi/brand_dev/models/brand_prefetch_by_email_response.rbi +++ b/rbi/brand_dev/models/brand_prefetch_by_email_response.rbi @@ -18,6 +18,23 @@ module BrandDev sig { params(domain: String).void } attr_writer :domain + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + returns( + T.nilable(BrandDev::Models::BrandPrefetchByEmailResponse::KeyMetadata) + ) + end + attr_reader :key_metadata + + sig do + params( + key_metadata: + BrandDev::Models::BrandPrefetchByEmailResponse::KeyMetadata::OrHash + ).void + end + attr_writer :key_metadata + # Success message sig { returns(T.nilable(String)) } attr_reader :message @@ -33,13 +50,20 @@ module BrandDev attr_writer :status sig do - params(domain: String, message: String, status: String).returns( - T.attached_class - ) + params( + domain: String, + key_metadata: + BrandDev::Models::BrandPrefetchByEmailResponse::KeyMetadata::OrHash, + message: String, + status: String + ).returns(T.attached_class) end def self.new( # The domain that was queued for prefetching domain: nil, + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + key_metadata: nil, # Success message message: nil, # Status of the response, e.g., 'ok' @@ -48,10 +72,59 @@ module BrandDev end sig do - override.returns({ domain: String, message: String, status: String }) + override.returns( + { + domain: String, + key_metadata: + BrandDev::Models::BrandPrefetchByEmailResponse::KeyMetadata, + message: String, + status: String + } + ) end def to_hash end + + class KeyMetadata < BrandDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + BrandDev::Models::BrandPrefetchByEmailResponse::KeyMetadata, + BrandDev::Internal::AnyHash + ) + end + + # The number of credits consumed by this request. + sig { returns(Integer) } + attr_accessor :credits_consumed + + # The number of credits remaining for your organization after this request. + sig { returns(Integer) } + attr_accessor :credits_remaining + + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + params(credits_consumed: Integer, credits_remaining: Integer).returns( + T.attached_class + ) + end + def self.new( + # The number of credits consumed by this request. + credits_consumed:, + # The number of credits remaining for your organization after this request. + credits_remaining: + ) + end + + sig do + override.returns( + { credits_consumed: Integer, credits_remaining: Integer } + ) + end + def to_hash + end + end end end end diff --git a/rbi/brand_dev/models/brand_prefetch_response.rbi b/rbi/brand_dev/models/brand_prefetch_response.rbi index 585fb3a..56987f4 100644 --- a/rbi/brand_dev/models/brand_prefetch_response.rbi +++ b/rbi/brand_dev/models/brand_prefetch_response.rbi @@ -18,6 +18,21 @@ module BrandDev sig { params(domain: String).void } attr_writer :domain + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + returns(T.nilable(BrandDev::Models::BrandPrefetchResponse::KeyMetadata)) + end + attr_reader :key_metadata + + sig do + params( + key_metadata: + BrandDev::Models::BrandPrefetchResponse::KeyMetadata::OrHash + ).void + end + attr_writer :key_metadata + # Success message sig { returns(T.nilable(String)) } attr_reader :message @@ -33,13 +48,20 @@ module BrandDev attr_writer :status sig do - params(domain: String, message: String, status: String).returns( - T.attached_class - ) + params( + domain: String, + key_metadata: + BrandDev::Models::BrandPrefetchResponse::KeyMetadata::OrHash, + message: String, + status: String + ).returns(T.attached_class) end def self.new( # The domain that was queued for prefetching domain: nil, + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + key_metadata: nil, # Success message message: nil, # Status of the response, e.g., 'ok' @@ -48,10 +70,58 @@ module BrandDev end sig do - override.returns({ domain: String, message: String, status: String }) + override.returns( + { + domain: String, + key_metadata: BrandDev::Models::BrandPrefetchResponse::KeyMetadata, + message: String, + status: String + } + ) end def to_hash end + + class KeyMetadata < BrandDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + BrandDev::Models::BrandPrefetchResponse::KeyMetadata, + BrandDev::Internal::AnyHash + ) + end + + # The number of credits consumed by this request. + sig { returns(Integer) } + attr_accessor :credits_consumed + + # The number of credits remaining for your organization after this request. + sig { returns(Integer) } + attr_accessor :credits_remaining + + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + params(credits_consumed: Integer, credits_remaining: Integer).returns( + T.attached_class + ) + end + def self.new( + # The number of credits consumed by this request. + credits_consumed:, + # The number of credits remaining for your organization after this request. + credits_remaining: + ) + end + + sig do + override.returns( + { credits_consumed: Integer, credits_remaining: Integer } + ) + end + def to_hash + end + end end end end diff --git a/rbi/brand_dev/models/brand_retrieve_by_email_response.rbi b/rbi/brand_dev/models/brand_retrieve_by_email_response.rbi index 9eb6bb6..a9cac87 100644 --- a/rbi/brand_dev/models/brand_retrieve_by_email_response.rbi +++ b/rbi/brand_dev/models/brand_retrieve_by_email_response.rbi @@ -33,6 +33,23 @@ module BrandDev sig { params(code: Integer).void } attr_writer :code + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + returns( + T.nilable(BrandDev::Models::BrandRetrieveByEmailResponse::KeyMetadata) + ) + end + attr_reader :key_metadata + + sig do + params( + key_metadata: + BrandDev::Models::BrandRetrieveByEmailResponse::KeyMetadata::OrHash + ).void + end + attr_writer :key_metadata + # Status of the response, e.g., 'ok' sig { returns(T.nilable(String)) } attr_reader :status @@ -44,6 +61,8 @@ module BrandDev params( brand: BrandDev::Models::BrandRetrieveByEmailResponse::Brand::OrHash, code: Integer, + key_metadata: + BrandDev::Models::BrandRetrieveByEmailResponse::KeyMetadata::OrHash, status: String ).returns(T.attached_class) end @@ -52,6 +71,9 @@ module BrandDev brand: nil, # HTTP status code code: nil, + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + key_metadata: nil, # Status of the response, e.g., 'ok' status: nil ) @@ -62,6 +84,8 @@ module BrandDev { brand: BrandDev::Models::BrandRetrieveByEmailResponse::Brand, code: Integer, + key_metadata: + BrandDev::Models::BrandRetrieveByEmailResponse::KeyMetadata, status: String } ) @@ -3438,6 +3462,47 @@ module BrandDev end end end + + class KeyMetadata < BrandDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + BrandDev::Models::BrandRetrieveByEmailResponse::KeyMetadata, + BrandDev::Internal::AnyHash + ) + end + + # The number of credits consumed by this request. + sig { returns(Integer) } + attr_accessor :credits_consumed + + # The number of credits remaining for your organization after this request. + sig { returns(Integer) } + attr_accessor :credits_remaining + + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + params(credits_consumed: Integer, credits_remaining: Integer).returns( + T.attached_class + ) + end + def self.new( + # The number of credits consumed by this request. + credits_consumed:, + # The number of credits remaining for your organization after this request. + credits_remaining: + ) + end + + sig do + override.returns( + { credits_consumed: Integer, credits_remaining: Integer } + ) + end + def to_hash + end + end end end end diff --git a/rbi/brand_dev/models/brand_retrieve_by_isin_response.rbi b/rbi/brand_dev/models/brand_retrieve_by_isin_response.rbi index d9c12a4..275a79c 100644 --- a/rbi/brand_dev/models/brand_retrieve_by_isin_response.rbi +++ b/rbi/brand_dev/models/brand_retrieve_by_isin_response.rbi @@ -31,6 +31,23 @@ module BrandDev sig { params(code: Integer).void } attr_writer :code + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + returns( + T.nilable(BrandDev::Models::BrandRetrieveByIsinResponse::KeyMetadata) + ) + end + attr_reader :key_metadata + + sig do + params( + key_metadata: + BrandDev::Models::BrandRetrieveByIsinResponse::KeyMetadata::OrHash + ).void + end + attr_writer :key_metadata + # Status of the response, e.g., 'ok' sig { returns(T.nilable(String)) } attr_reader :status @@ -42,6 +59,8 @@ module BrandDev params( brand: BrandDev::Models::BrandRetrieveByIsinResponse::Brand::OrHash, code: Integer, + key_metadata: + BrandDev::Models::BrandRetrieveByIsinResponse::KeyMetadata::OrHash, status: String ).returns(T.attached_class) end @@ -50,6 +69,9 @@ module BrandDev brand: nil, # HTTP status code code: nil, + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + key_metadata: nil, # Status of the response, e.g., 'ok' status: nil ) @@ -60,6 +82,8 @@ module BrandDev { brand: BrandDev::Models::BrandRetrieveByIsinResponse::Brand, code: Integer, + key_metadata: + BrandDev::Models::BrandRetrieveByIsinResponse::KeyMetadata, status: String } ) @@ -3436,6 +3460,47 @@ module BrandDev end end end + + class KeyMetadata < BrandDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + BrandDev::Models::BrandRetrieveByIsinResponse::KeyMetadata, + BrandDev::Internal::AnyHash + ) + end + + # The number of credits consumed by this request. + sig { returns(Integer) } + attr_accessor :credits_consumed + + # The number of credits remaining for your organization after this request. + sig { returns(Integer) } + attr_accessor :credits_remaining + + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + params(credits_consumed: Integer, credits_remaining: Integer).returns( + T.attached_class + ) + end + def self.new( + # The number of credits consumed by this request. + credits_consumed:, + # The number of credits remaining for your organization after this request. + credits_remaining: + ) + end + + sig do + override.returns( + { credits_consumed: Integer, credits_remaining: Integer } + ) + end + def to_hash + end + end end end end diff --git a/rbi/brand_dev/models/brand_retrieve_by_name_response.rbi b/rbi/brand_dev/models/brand_retrieve_by_name_response.rbi index 5277d65..7b345bf 100644 --- a/rbi/brand_dev/models/brand_retrieve_by_name_response.rbi +++ b/rbi/brand_dev/models/brand_retrieve_by_name_response.rbi @@ -31,6 +31,23 @@ module BrandDev sig { params(code: Integer).void } attr_writer :code + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + returns( + T.nilable(BrandDev::Models::BrandRetrieveByNameResponse::KeyMetadata) + ) + end + attr_reader :key_metadata + + sig do + params( + key_metadata: + BrandDev::Models::BrandRetrieveByNameResponse::KeyMetadata::OrHash + ).void + end + attr_writer :key_metadata + # Status of the response, e.g., 'ok' sig { returns(T.nilable(String)) } attr_reader :status @@ -42,6 +59,8 @@ module BrandDev params( brand: BrandDev::Models::BrandRetrieveByNameResponse::Brand::OrHash, code: Integer, + key_metadata: + BrandDev::Models::BrandRetrieveByNameResponse::KeyMetadata::OrHash, status: String ).returns(T.attached_class) end @@ -50,6 +69,9 @@ module BrandDev brand: nil, # HTTP status code code: nil, + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + key_metadata: nil, # Status of the response, e.g., 'ok' status: nil ) @@ -60,6 +82,8 @@ module BrandDev { brand: BrandDev::Models::BrandRetrieveByNameResponse::Brand, code: Integer, + key_metadata: + BrandDev::Models::BrandRetrieveByNameResponse::KeyMetadata, status: String } ) @@ -3436,6 +3460,47 @@ module BrandDev end end end + + class KeyMetadata < BrandDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + BrandDev::Models::BrandRetrieveByNameResponse::KeyMetadata, + BrandDev::Internal::AnyHash + ) + end + + # The number of credits consumed by this request. + sig { returns(Integer) } + attr_accessor :credits_consumed + + # The number of credits remaining for your organization after this request. + sig { returns(Integer) } + attr_accessor :credits_remaining + + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + params(credits_consumed: Integer, credits_remaining: Integer).returns( + T.attached_class + ) + end + def self.new( + # The number of credits consumed by this request. + credits_consumed:, + # The number of credits remaining for your organization after this request. + credits_remaining: + ) + end + + sig do + override.returns( + { credits_consumed: Integer, credits_remaining: Integer } + ) + end + def to_hash + end + end end end end diff --git a/rbi/brand_dev/models/brand_retrieve_by_ticker_response.rbi b/rbi/brand_dev/models/brand_retrieve_by_ticker_response.rbi index 559368e..69fa4c4 100644 --- a/rbi/brand_dev/models/brand_retrieve_by_ticker_response.rbi +++ b/rbi/brand_dev/models/brand_retrieve_by_ticker_response.rbi @@ -33,6 +33,25 @@ module BrandDev sig { params(code: Integer).void } attr_writer :code + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + returns( + T.nilable( + BrandDev::Models::BrandRetrieveByTickerResponse::KeyMetadata + ) + ) + end + attr_reader :key_metadata + + sig do + params( + key_metadata: + BrandDev::Models::BrandRetrieveByTickerResponse::KeyMetadata::OrHash + ).void + end + attr_writer :key_metadata + # Status of the response, e.g., 'ok' sig { returns(T.nilable(String)) } attr_reader :status @@ -44,6 +63,8 @@ module BrandDev params( brand: BrandDev::Models::BrandRetrieveByTickerResponse::Brand::OrHash, code: Integer, + key_metadata: + BrandDev::Models::BrandRetrieveByTickerResponse::KeyMetadata::OrHash, status: String ).returns(T.attached_class) end @@ -52,6 +73,9 @@ module BrandDev brand: nil, # HTTP status code code: nil, + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + key_metadata: nil, # Status of the response, e.g., 'ok' status: nil ) @@ -62,6 +86,8 @@ module BrandDev { brand: BrandDev::Models::BrandRetrieveByTickerResponse::Brand, code: Integer, + key_metadata: + BrandDev::Models::BrandRetrieveByTickerResponse::KeyMetadata, status: String } ) @@ -3438,6 +3464,47 @@ module BrandDev end end end + + class KeyMetadata < BrandDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + BrandDev::Models::BrandRetrieveByTickerResponse::KeyMetadata, + BrandDev::Internal::AnyHash + ) + end + + # The number of credits consumed by this request. + sig { returns(Integer) } + attr_accessor :credits_consumed + + # The number of credits remaining for your organization after this request. + sig { returns(Integer) } + attr_accessor :credits_remaining + + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + params(credits_consumed: Integer, credits_remaining: Integer).returns( + T.attached_class + ) + end + def self.new( + # The number of credits consumed by this request. + credits_consumed:, + # The number of credits remaining for your organization after this request. + credits_remaining: + ) + end + + sig do + override.returns( + { credits_consumed: Integer, credits_remaining: Integer } + ) + end + def to_hash + end + end end end end diff --git a/rbi/brand_dev/models/brand_retrieve_response.rbi b/rbi/brand_dev/models/brand_retrieve_response.rbi index fc1e21c..7a71e9c 100644 --- a/rbi/brand_dev/models/brand_retrieve_response.rbi +++ b/rbi/brand_dev/models/brand_retrieve_response.rbi @@ -29,6 +29,21 @@ module BrandDev sig { params(code: Integer).void } attr_writer :code + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + returns(T.nilable(BrandDev::Models::BrandRetrieveResponse::KeyMetadata)) + end + attr_reader :key_metadata + + sig do + params( + key_metadata: + BrandDev::Models::BrandRetrieveResponse::KeyMetadata::OrHash + ).void + end + attr_writer :key_metadata + # Status of the response, e.g., 'ok' sig { returns(T.nilable(String)) } attr_reader :status @@ -40,6 +55,8 @@ module BrandDev params( brand: BrandDev::Models::BrandRetrieveResponse::Brand::OrHash, code: Integer, + key_metadata: + BrandDev::Models::BrandRetrieveResponse::KeyMetadata::OrHash, status: String ).returns(T.attached_class) end @@ -48,6 +65,9 @@ module BrandDev brand: nil, # HTTP status code code: nil, + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + key_metadata: nil, # Status of the response, e.g., 'ok' status: nil ) @@ -58,6 +78,7 @@ module BrandDev { brand: BrandDev::Models::BrandRetrieveResponse::Brand, code: Integer, + key_metadata: BrandDev::Models::BrandRetrieveResponse::KeyMetadata, status: String } ) @@ -3411,6 +3432,47 @@ module BrandDev end end end + + class KeyMetadata < BrandDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + BrandDev::Models::BrandRetrieveResponse::KeyMetadata, + BrandDev::Internal::AnyHash + ) + end + + # The number of credits consumed by this request. + sig { returns(Integer) } + attr_accessor :credits_consumed + + # The number of credits remaining for your organization after this request. + sig { returns(Integer) } + attr_accessor :credits_remaining + + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + params(credits_consumed: Integer, credits_remaining: Integer).returns( + T.attached_class + ) + end + def self.new( + # The number of credits consumed by this request. + credits_consumed:, + # The number of credits remaining for your organization after this request. + credits_remaining: + ) + end + + sig do + override.returns( + { credits_consumed: Integer, credits_remaining: Integer } + ) + end + def to_hash + end + end end end end diff --git a/rbi/brand_dev/models/brand_retrieve_simplified_response.rbi b/rbi/brand_dev/models/brand_retrieve_simplified_response.rbi index fa582fd..a52b2b5 100644 --- a/rbi/brand_dev/models/brand_retrieve_simplified_response.rbi +++ b/rbi/brand_dev/models/brand_retrieve_simplified_response.rbi @@ -34,6 +34,25 @@ module BrandDev sig { params(code: Integer).void } attr_writer :code + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + returns( + T.nilable( + BrandDev::Models::BrandRetrieveSimplifiedResponse::KeyMetadata + ) + ) + end + attr_reader :key_metadata + + sig do + params( + key_metadata: + BrandDev::Models::BrandRetrieveSimplifiedResponse::KeyMetadata::OrHash + ).void + end + attr_writer :key_metadata + # Status of the response, e.g., 'ok' sig { returns(T.nilable(String)) } attr_reader :status @@ -46,6 +65,8 @@ module BrandDev brand: BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::OrHash, code: Integer, + key_metadata: + BrandDev::Models::BrandRetrieveSimplifiedResponse::KeyMetadata::OrHash, status: String ).returns(T.attached_class) end @@ -54,6 +75,9 @@ module BrandDev brand: nil, # HTTP status code of the response code: nil, + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + key_metadata: nil, # Status of the response, e.g., 'ok' status: nil ) @@ -64,6 +88,8 @@ module BrandDev { brand: BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand, code: Integer, + key_metadata: + BrandDev::Models::BrandRetrieveSimplifiedResponse::KeyMetadata, status: String } ) @@ -758,6 +784,47 @@ module BrandDev end end end + + class KeyMetadata < BrandDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + BrandDev::Models::BrandRetrieveSimplifiedResponse::KeyMetadata, + BrandDev::Internal::AnyHash + ) + end + + # The number of credits consumed by this request. + sig { returns(Integer) } + attr_accessor :credits_consumed + + # The number of credits remaining for your organization after this request. + sig { returns(Integer) } + attr_accessor :credits_remaining + + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + params(credits_consumed: Integer, credits_remaining: Integer).returns( + T.attached_class + ) + end + def self.new( + # The number of credits consumed by this request. + credits_consumed:, + # The number of credits remaining for your organization after this request. + credits_remaining: + ) + end + + sig do + override.returns( + { credits_consumed: Integer, credits_remaining: Integer } + ) + end + def to_hash + end + end end end end diff --git a/rbi/brand_dev/models/brand_web_scrape_html_response.rbi b/rbi/brand_dev/models/brand_web_scrape_html_response.rbi index 0b856f4..90d5c54 100644 --- a/rbi/brand_dev/models/brand_web_scrape_html_response.rbi +++ b/rbi/brand_dev/models/brand_web_scrape_html_response.rbi @@ -38,13 +38,32 @@ module BrandDev sig { returns(String) } attr_accessor :url + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + returns( + T.nilable(BrandDev::Models::BrandWebScrapeHTMLResponse::KeyMetadata) + ) + end + attr_reader :key_metadata + + sig do + params( + key_metadata: + BrandDev::Models::BrandWebScrapeHTMLResponse::KeyMetadata::OrHash + ).void + end + attr_writer :key_metadata + sig do params( html: String, success: BrandDev::Models::BrandWebScrapeHTMLResponse::Success::OrBoolean, type: BrandDev::Models::BrandWebScrapeHTMLResponse::Type::OrSymbol, - url: String + url: String, + key_metadata: + BrandDev::Models::BrandWebScrapeHTMLResponse::KeyMetadata::OrHash ).returns(T.attached_class) end def self.new( @@ -58,7 +77,10 @@ module BrandDev # surfaced as `xml`; ordinary pages are `html`. type:, # The URL that was scraped - url: + url:, + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + key_metadata: nil ) end @@ -70,7 +92,9 @@ module BrandDev BrandDev::Models::BrandWebScrapeHTMLResponse::Success::TaggedBoolean, type: BrandDev::Models::BrandWebScrapeHTMLResponse::Type::TaggedSymbol, - url: String + url: String, + key_metadata: + BrandDev::Models::BrandWebScrapeHTMLResponse::KeyMetadata } ) end @@ -169,6 +193,47 @@ module BrandDev def self.values end end + + class KeyMetadata < BrandDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + BrandDev::Models::BrandWebScrapeHTMLResponse::KeyMetadata, + BrandDev::Internal::AnyHash + ) + end + + # The number of credits consumed by this request. + sig { returns(Integer) } + attr_accessor :credits_consumed + + # The number of credits remaining for your organization after this request. + sig { returns(Integer) } + attr_accessor :credits_remaining + + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + params(credits_consumed: Integer, credits_remaining: Integer).returns( + T.attached_class + ) + end + def self.new( + # The number of credits consumed by this request. + credits_consumed:, + # The number of credits remaining for your organization after this request. + credits_remaining: + ) + end + + sig do + override.returns( + { credits_consumed: Integer, credits_remaining: Integer } + ) + end + def to_hash + end + end end end end diff --git a/rbi/brand_dev/models/brand_web_scrape_images_response.rbi b/rbi/brand_dev/models/brand_web_scrape_images_response.rbi index 6d7ce29..b42906b 100644 --- a/rbi/brand_dev/models/brand_web_scrape_images_response.rbi +++ b/rbi/brand_dev/models/brand_web_scrape_images_response.rbi @@ -29,6 +29,23 @@ module BrandDev sig { returns(String) } attr_accessor :url + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + returns( + T.nilable(BrandDev::Models::BrandWebScrapeImagesResponse::KeyMetadata) + ) + end + attr_reader :key_metadata + + sig do + params( + key_metadata: + BrandDev::Models::BrandWebScrapeImagesResponse::KeyMetadata::OrHash + ).void + end + attr_writer :key_metadata + sig do params( images: @@ -37,7 +54,9 @@ module BrandDev ], success: BrandDev::Models::BrandWebScrapeImagesResponse::Success::OrBoolean, - url: String + url: String, + key_metadata: + BrandDev::Models::BrandWebScrapeImagesResponse::KeyMetadata::OrHash ).returns(T.attached_class) end def self.new( @@ -46,7 +65,10 @@ module BrandDev # Always true on success. success:, # Page URL that was scraped. - url: + url:, + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + key_metadata: nil ) end @@ -57,7 +79,9 @@ module BrandDev T::Array[BrandDev::Models::BrandWebScrapeImagesResponse::Image], success: BrandDev::Models::BrandWebScrapeImagesResponse::Success::TaggedBoolean, - url: String + url: String, + key_metadata: + BrandDev::Models::BrandWebScrapeImagesResponse::KeyMetadata } ) end @@ -459,6 +483,47 @@ module BrandDev def self.values end end + + class KeyMetadata < BrandDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + BrandDev::Models::BrandWebScrapeImagesResponse::KeyMetadata, + BrandDev::Internal::AnyHash + ) + end + + # The number of credits consumed by this request. + sig { returns(Integer) } + attr_accessor :credits_consumed + + # The number of credits remaining for your organization after this request. + sig { returns(Integer) } + attr_accessor :credits_remaining + + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + params(credits_consumed: Integer, credits_remaining: Integer).returns( + T.attached_class + ) + end + def self.new( + # The number of credits consumed by this request. + credits_consumed:, + # The number of credits remaining for your organization after this request. + credits_remaining: + ) + end + + sig do + override.returns( + { credits_consumed: Integer, credits_remaining: Integer } + ) + end + def to_hash + end + end end end end diff --git a/rbi/brand_dev/models/brand_web_scrape_md_response.rbi b/rbi/brand_dev/models/brand_web_scrape_md_response.rbi index b5ab6e8..647912a 100644 --- a/rbi/brand_dev/models/brand_web_scrape_md_response.rbi +++ b/rbi/brand_dev/models/brand_web_scrape_md_response.rbi @@ -27,12 +27,31 @@ module BrandDev sig { returns(String) } attr_accessor :url + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + returns( + T.nilable(BrandDev::Models::BrandWebScrapeMdResponse::KeyMetadata) + ) + end + attr_reader :key_metadata + + sig do + params( + key_metadata: + BrandDev::Models::BrandWebScrapeMdResponse::KeyMetadata::OrHash + ).void + end + attr_writer :key_metadata + sig do params( markdown: String, success: BrandDev::Models::BrandWebScrapeMdResponse::Success::OrBoolean, - url: String + url: String, + key_metadata: + BrandDev::Models::BrandWebScrapeMdResponse::KeyMetadata::OrHash ).returns(T.attached_class) end def self.new( @@ -41,7 +60,10 @@ module BrandDev # Indicates success success:, # The URL that was scraped - url: + url:, + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + key_metadata: nil ) end @@ -51,7 +73,9 @@ module BrandDev markdown: String, success: BrandDev::Models::BrandWebScrapeMdResponse::Success::TaggedBoolean, - url: String + url: String, + key_metadata: + BrandDev::Models::BrandWebScrapeMdResponse::KeyMetadata } ) end @@ -87,6 +111,47 @@ module BrandDev def self.values end end + + class KeyMetadata < BrandDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + BrandDev::Models::BrandWebScrapeMdResponse::KeyMetadata, + BrandDev::Internal::AnyHash + ) + end + + # The number of credits consumed by this request. + sig { returns(Integer) } + attr_accessor :credits_consumed + + # The number of credits remaining for your organization after this request. + sig { returns(Integer) } + attr_accessor :credits_remaining + + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + params(credits_consumed: Integer, credits_remaining: Integer).returns( + T.attached_class + ) + end + def self.new( + # The number of credits consumed by this request. + credits_consumed:, + # The number of credits remaining for your organization after this request. + credits_remaining: + ) + end + + sig do + override.returns( + { credits_consumed: Integer, credits_remaining: Integer } + ) + end + def to_hash + end + end end end end diff --git a/rbi/brand_dev/models/brand_web_scrape_sitemap_response.rbi b/rbi/brand_dev/models/brand_web_scrape_sitemap_response.rbi index 333f297..c5cc99e 100644 --- a/rbi/brand_dev/models/brand_web_scrape_sitemap_response.rbi +++ b/rbi/brand_dev/models/brand_web_scrape_sitemap_response.rbi @@ -38,13 +38,34 @@ module BrandDev sig { returns(T::Array[String]) } attr_accessor :urls + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + returns( + T.nilable( + BrandDev::Models::BrandWebScrapeSitemapResponse::KeyMetadata + ) + ) + end + attr_reader :key_metadata + + sig do + params( + key_metadata: + BrandDev::Models::BrandWebScrapeSitemapResponse::KeyMetadata::OrHash + ).void + end + attr_writer :key_metadata + sig do params( domain: String, meta: BrandDev::Models::BrandWebScrapeSitemapResponse::Meta::OrHash, success: BrandDev::Models::BrandWebScrapeSitemapResponse::Success::OrBoolean, - urls: T::Array[String] + urls: T::Array[String], + key_metadata: + BrandDev::Models::BrandWebScrapeSitemapResponse::KeyMetadata::OrHash ).returns(T.attached_class) end def self.new( @@ -55,7 +76,10 @@ module BrandDev # Indicates success success:, # Array of discovered page URLs from the sitemap (max 500) - urls: + urls:, + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + key_metadata: nil ) end @@ -66,7 +90,9 @@ module BrandDev meta: BrandDev::Models::BrandWebScrapeSitemapResponse::Meta, success: BrandDev::Models::BrandWebScrapeSitemapResponse::Success::TaggedBoolean, - urls: T::Array[String] + urls: T::Array[String], + key_metadata: + BrandDev::Models::BrandWebScrapeSitemapResponse::KeyMetadata } ) end @@ -162,6 +188,47 @@ module BrandDev def self.values end end + + class KeyMetadata < BrandDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + BrandDev::Models::BrandWebScrapeSitemapResponse::KeyMetadata, + BrandDev::Internal::AnyHash + ) + end + + # The number of credits consumed by this request. + sig { returns(Integer) } + attr_accessor :credits_consumed + + # The number of credits remaining for your organization after this request. + sig { returns(Integer) } + attr_accessor :credits_remaining + + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + params(credits_consumed: Integer, credits_remaining: Integer).returns( + T.attached_class + ) + end + def self.new( + # The number of credits consumed by this request. + credits_consumed:, + # The number of credits remaining for your organization after this request. + credits_remaining: + ) + end + + sig do + override.returns( + { credits_consumed: Integer, credits_remaining: Integer } + ) + end + def to_hash + end + end end end end diff --git a/sig/brand_dev/models/brand_ai_product_response.rbs b/sig/brand_dev/models/brand_ai_product_response.rbs index a36ea6b..4bb8f40 100644 --- a/sig/brand_dev/models/brand_ai_product_response.rbs +++ b/sig/brand_dev/models/brand_ai_product_response.rbs @@ -3,6 +3,7 @@ module BrandDev type brand_ai_product_response = { is_product_page: bool, + key_metadata: BrandDev::Models::BrandAIProductResponse::KeyMetadata, platform: BrandDev::Models::BrandAIProductResponse::platform?, product: BrandDev::Models::BrandAIProductResponse::Product? } @@ -12,22 +13,49 @@ module BrandDev def is_product_page=: (bool) -> bool + attr_reader key_metadata: BrandDev::Models::BrandAIProductResponse::KeyMetadata? + + def key_metadata=: ( + BrandDev::Models::BrandAIProductResponse::KeyMetadata + ) -> BrandDev::Models::BrandAIProductResponse::KeyMetadata + attr_accessor platform: BrandDev::Models::BrandAIProductResponse::platform? attr_accessor product: BrandDev::Models::BrandAIProductResponse::Product? def initialize: ( ?is_product_page: bool, + ?key_metadata: BrandDev::Models::BrandAIProductResponse::KeyMetadata, ?platform: BrandDev::Models::BrandAIProductResponse::platform?, ?product: BrandDev::Models::BrandAIProductResponse::Product? ) -> void def to_hash: -> { is_product_page: bool, + key_metadata: BrandDev::Models::BrandAIProductResponse::KeyMetadata, platform: BrandDev::Models::BrandAIProductResponse::platform?, product: BrandDev::Models::BrandAIProductResponse::Product? } + type key_metadata = + { credits_consumed: Integer, credits_remaining: Integer } + + class KeyMetadata < BrandDev::Internal::Type::BaseModel + attr_accessor credits_consumed: Integer + + attr_accessor credits_remaining: Integer + + def initialize: ( + credits_consumed: Integer, + credits_remaining: Integer + ) -> void + + def to_hash: -> { + credits_consumed: Integer, + credits_remaining: Integer + } + end + type platform = :amazon | :tiktok_shop | :etsy | :generic module Platform diff --git a/sig/brand_dev/models/brand_ai_products_response.rbs b/sig/brand_dev/models/brand_ai_products_response.rbs index 88f88a6..d136d98 100644 --- a/sig/brand_dev/models/brand_ai_products_response.rbs +++ b/sig/brand_dev/models/brand_ai_products_response.rbs @@ -1,9 +1,18 @@ module BrandDev module Models type brand_ai_products_response = - { products: ::Array[BrandDev::Models::BrandAIProductsResponse::Product] } + { + key_metadata: BrandDev::Models::BrandAIProductsResponse::KeyMetadata, + products: ::Array[BrandDev::Models::BrandAIProductsResponse::Product] + } class BrandAIProductsResponse < BrandDev::Internal::Type::BaseModel + attr_reader key_metadata: BrandDev::Models::BrandAIProductsResponse::KeyMetadata? + + def key_metadata=: ( + BrandDev::Models::BrandAIProductsResponse::KeyMetadata + ) -> BrandDev::Models::BrandAIProductsResponse::KeyMetadata + attr_reader products: ::Array[BrandDev::Models::BrandAIProductsResponse::Product]? def products=: ( @@ -11,13 +20,34 @@ module BrandDev ) -> ::Array[BrandDev::Models::BrandAIProductsResponse::Product] def initialize: ( + ?key_metadata: BrandDev::Models::BrandAIProductsResponse::KeyMetadata, ?products: ::Array[BrandDev::Models::BrandAIProductsResponse::Product] ) -> void def to_hash: -> { + key_metadata: BrandDev::Models::BrandAIProductsResponse::KeyMetadata, products: ::Array[BrandDev::Models::BrandAIProductsResponse::Product] } + type key_metadata = + { credits_consumed: Integer, credits_remaining: Integer } + + class KeyMetadata < BrandDev::Internal::Type::BaseModel + attr_accessor credits_consumed: Integer + + attr_accessor credits_remaining: Integer + + def initialize: ( + credits_consumed: Integer, + credits_remaining: Integer + ) -> void + + def to_hash: -> { + credits_consumed: Integer, + credits_remaining: Integer + } + end + type product = { description: String, diff --git a/sig/brand_dev/models/brand_ai_query_response.rbs b/sig/brand_dev/models/brand_ai_query_response.rbs index c77d58f..f9676e4 100644 --- a/sig/brand_dev/models/brand_ai_query_response.rbs +++ b/sig/brand_dev/models/brand_ai_query_response.rbs @@ -4,6 +4,7 @@ module BrandDev { data_extracted: ::Array[BrandDev::Models::BrandAIQueryResponse::DataExtracted], domain: String, + key_metadata: BrandDev::Models::BrandAIQueryResponse::KeyMetadata, status: String, urls_analyzed: ::Array[String] } @@ -19,6 +20,12 @@ module BrandDev def domain=: (String) -> String + attr_reader key_metadata: BrandDev::Models::BrandAIQueryResponse::KeyMetadata? + + def key_metadata=: ( + BrandDev::Models::BrandAIQueryResponse::KeyMetadata + ) -> BrandDev::Models::BrandAIQueryResponse::KeyMetadata + attr_reader status: String? def status=: (String) -> String @@ -30,6 +37,7 @@ module BrandDev def initialize: ( ?data_extracted: ::Array[BrandDev::Models::BrandAIQueryResponse::DataExtracted], ?domain: String, + ?key_metadata: BrandDev::Models::BrandAIQueryResponse::KeyMetadata, ?status: String, ?urls_analyzed: ::Array[String] ) -> void @@ -37,6 +45,7 @@ module BrandDev def to_hash: -> { data_extracted: ::Array[BrandDev::Models::BrandAIQueryResponse::DataExtracted], domain: String, + key_metadata: BrandDev::Models::BrandAIQueryResponse::KeyMetadata, status: String, urls_analyzed: ::Array[String] } @@ -88,6 +97,25 @@ module BrandDev UnionMember5Array: BrandDev::Internal::Type::Converter end end + + type key_metadata = + { credits_consumed: Integer, credits_remaining: Integer } + + class KeyMetadata < BrandDev::Internal::Type::BaseModel + attr_accessor credits_consumed: Integer + + attr_accessor credits_remaining: Integer + + def initialize: ( + credits_consumed: Integer, + credits_remaining: Integer + ) -> void + + def to_hash: -> { + credits_consumed: Integer, + credits_remaining: Integer + } + end end end end diff --git a/sig/brand_dev/models/brand_identify_from_transaction_response.rbs b/sig/brand_dev/models/brand_identify_from_transaction_response.rbs index 490ee87..0a66533 100644 --- a/sig/brand_dev/models/brand_identify_from_transaction_response.rbs +++ b/sig/brand_dev/models/brand_identify_from_transaction_response.rbs @@ -4,6 +4,7 @@ module BrandDev { brand: BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand, code: Integer, + key_metadata: BrandDev::Models::BrandIdentifyFromTransactionResponse::KeyMetadata, status: String } @@ -18,6 +19,12 @@ module BrandDev def code=: (Integer) -> Integer + attr_reader key_metadata: BrandDev::Models::BrandIdentifyFromTransactionResponse::KeyMetadata? + + def key_metadata=: ( + BrandDev::Models::BrandIdentifyFromTransactionResponse::KeyMetadata + ) -> BrandDev::Models::BrandIdentifyFromTransactionResponse::KeyMetadata + attr_reader status: String? def status=: (String) -> String @@ -25,12 +32,14 @@ module BrandDev def initialize: ( ?brand: BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand, ?code: Integer, + ?key_metadata: BrandDev::Models::BrandIdentifyFromTransactionResponse::KeyMetadata, ?status: String ) -> void def to_hash: -> { brand: BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand, code: Integer, + key_metadata: BrandDev::Models::BrandIdentifyFromTransactionResponse::KeyMetadata, status: String } @@ -1408,6 +1417,25 @@ module BrandDev def to_hash: -> { exchange: String, ticker: String } end end + + type key_metadata = + { credits_consumed: Integer, credits_remaining: Integer } + + class KeyMetadata < BrandDev::Internal::Type::BaseModel + attr_accessor credits_consumed: Integer + + attr_accessor credits_remaining: Integer + + def initialize: ( + credits_consumed: Integer, + credits_remaining: Integer + ) -> void + + def to_hash: -> { + credits_consumed: Integer, + credits_remaining: Integer + } + end end end end diff --git a/sig/brand_dev/models/brand_prefetch_by_email_response.rbs b/sig/brand_dev/models/brand_prefetch_by_email_response.rbs index c26b10e..b7a8370 100644 --- a/sig/brand_dev/models/brand_prefetch_by_email_response.rbs +++ b/sig/brand_dev/models/brand_prefetch_by_email_response.rbs @@ -1,13 +1,24 @@ module BrandDev module Models type brand_prefetch_by_email_response = - { domain: String, message: String, status: String } + { + domain: String, + key_metadata: BrandDev::Models::BrandPrefetchByEmailResponse::KeyMetadata, + message: String, + status: String + } class BrandPrefetchByEmailResponse < BrandDev::Internal::Type::BaseModel attr_reader domain: String? def domain=: (String) -> String + attr_reader key_metadata: BrandDev::Models::BrandPrefetchByEmailResponse::KeyMetadata? + + def key_metadata=: ( + BrandDev::Models::BrandPrefetchByEmailResponse::KeyMetadata + ) -> BrandDev::Models::BrandPrefetchByEmailResponse::KeyMetadata + attr_reader message: String? def message=: (String) -> String @@ -18,11 +29,36 @@ module BrandDev def initialize: ( ?domain: String, + ?key_metadata: BrandDev::Models::BrandPrefetchByEmailResponse::KeyMetadata, ?message: String, ?status: String ) -> void - def to_hash: -> { domain: String, message: String, status: String } + def to_hash: -> { + domain: String, + key_metadata: BrandDev::Models::BrandPrefetchByEmailResponse::KeyMetadata, + message: String, + status: String + } + + type key_metadata = + { credits_consumed: Integer, credits_remaining: Integer } + + class KeyMetadata < BrandDev::Internal::Type::BaseModel + attr_accessor credits_consumed: Integer + + attr_accessor credits_remaining: Integer + + def initialize: ( + credits_consumed: Integer, + credits_remaining: Integer + ) -> void + + def to_hash: -> { + credits_consumed: Integer, + credits_remaining: Integer + } + end end end end diff --git a/sig/brand_dev/models/brand_prefetch_response.rbs b/sig/brand_dev/models/brand_prefetch_response.rbs index 97c2006..a3f5f03 100644 --- a/sig/brand_dev/models/brand_prefetch_response.rbs +++ b/sig/brand_dev/models/brand_prefetch_response.rbs @@ -1,13 +1,24 @@ module BrandDev module Models type brand_prefetch_response = - { domain: String, message: String, status: String } + { + domain: String, + key_metadata: BrandDev::Models::BrandPrefetchResponse::KeyMetadata, + message: String, + status: String + } class BrandPrefetchResponse < BrandDev::Internal::Type::BaseModel attr_reader domain: String? def domain=: (String) -> String + attr_reader key_metadata: BrandDev::Models::BrandPrefetchResponse::KeyMetadata? + + def key_metadata=: ( + BrandDev::Models::BrandPrefetchResponse::KeyMetadata + ) -> BrandDev::Models::BrandPrefetchResponse::KeyMetadata + attr_reader message: String? def message=: (String) -> String @@ -18,11 +29,36 @@ module BrandDev def initialize: ( ?domain: String, + ?key_metadata: BrandDev::Models::BrandPrefetchResponse::KeyMetadata, ?message: String, ?status: String ) -> void - def to_hash: -> { domain: String, message: String, status: String } + def to_hash: -> { + domain: String, + key_metadata: BrandDev::Models::BrandPrefetchResponse::KeyMetadata, + message: String, + status: String + } + + type key_metadata = + { credits_consumed: Integer, credits_remaining: Integer } + + class KeyMetadata < BrandDev::Internal::Type::BaseModel + attr_accessor credits_consumed: Integer + + attr_accessor credits_remaining: Integer + + def initialize: ( + credits_consumed: Integer, + credits_remaining: Integer + ) -> void + + def to_hash: -> { + credits_consumed: Integer, + credits_remaining: Integer + } + end end end end diff --git a/sig/brand_dev/models/brand_retrieve_by_email_response.rbs b/sig/brand_dev/models/brand_retrieve_by_email_response.rbs index 91c53b6..554a22a 100644 --- a/sig/brand_dev/models/brand_retrieve_by_email_response.rbs +++ b/sig/brand_dev/models/brand_retrieve_by_email_response.rbs @@ -4,6 +4,7 @@ module BrandDev { brand: BrandDev::Models::BrandRetrieveByEmailResponse::Brand, code: Integer, + key_metadata: BrandDev::Models::BrandRetrieveByEmailResponse::KeyMetadata, status: String } @@ -18,6 +19,12 @@ module BrandDev def code=: (Integer) -> Integer + attr_reader key_metadata: BrandDev::Models::BrandRetrieveByEmailResponse::KeyMetadata? + + def key_metadata=: ( + BrandDev::Models::BrandRetrieveByEmailResponse::KeyMetadata + ) -> BrandDev::Models::BrandRetrieveByEmailResponse::KeyMetadata + attr_reader status: String? def status=: (String) -> String @@ -25,12 +32,14 @@ module BrandDev def initialize: ( ?brand: BrandDev::Models::BrandRetrieveByEmailResponse::Brand, ?code: Integer, + ?key_metadata: BrandDev::Models::BrandRetrieveByEmailResponse::KeyMetadata, ?status: String ) -> void def to_hash: -> { brand: BrandDev::Models::BrandRetrieveByEmailResponse::Brand, code: Integer, + key_metadata: BrandDev::Models::BrandRetrieveByEmailResponse::KeyMetadata, status: String } @@ -1408,6 +1417,25 @@ module BrandDev def to_hash: -> { exchange: String, ticker: String } end end + + type key_metadata = + { credits_consumed: Integer, credits_remaining: Integer } + + class KeyMetadata < BrandDev::Internal::Type::BaseModel + attr_accessor credits_consumed: Integer + + attr_accessor credits_remaining: Integer + + def initialize: ( + credits_consumed: Integer, + credits_remaining: Integer + ) -> void + + def to_hash: -> { + credits_consumed: Integer, + credits_remaining: Integer + } + end end end end diff --git a/sig/brand_dev/models/brand_retrieve_by_isin_response.rbs b/sig/brand_dev/models/brand_retrieve_by_isin_response.rbs index 5300e8b..0294cd8 100644 --- a/sig/brand_dev/models/brand_retrieve_by_isin_response.rbs +++ b/sig/brand_dev/models/brand_retrieve_by_isin_response.rbs @@ -4,6 +4,7 @@ module BrandDev { brand: BrandDev::Models::BrandRetrieveByIsinResponse::Brand, code: Integer, + key_metadata: BrandDev::Models::BrandRetrieveByIsinResponse::KeyMetadata, status: String } @@ -18,6 +19,12 @@ module BrandDev def code=: (Integer) -> Integer + attr_reader key_metadata: BrandDev::Models::BrandRetrieveByIsinResponse::KeyMetadata? + + def key_metadata=: ( + BrandDev::Models::BrandRetrieveByIsinResponse::KeyMetadata + ) -> BrandDev::Models::BrandRetrieveByIsinResponse::KeyMetadata + attr_reader status: String? def status=: (String) -> String @@ -25,12 +32,14 @@ module BrandDev def initialize: ( ?brand: BrandDev::Models::BrandRetrieveByIsinResponse::Brand, ?code: Integer, + ?key_metadata: BrandDev::Models::BrandRetrieveByIsinResponse::KeyMetadata, ?status: String ) -> void def to_hash: -> { brand: BrandDev::Models::BrandRetrieveByIsinResponse::Brand, code: Integer, + key_metadata: BrandDev::Models::BrandRetrieveByIsinResponse::KeyMetadata, status: String } @@ -1408,6 +1417,25 @@ module BrandDev def to_hash: -> { exchange: String, ticker: String } end end + + type key_metadata = + { credits_consumed: Integer, credits_remaining: Integer } + + class KeyMetadata < BrandDev::Internal::Type::BaseModel + attr_accessor credits_consumed: Integer + + attr_accessor credits_remaining: Integer + + def initialize: ( + credits_consumed: Integer, + credits_remaining: Integer + ) -> void + + def to_hash: -> { + credits_consumed: Integer, + credits_remaining: Integer + } + end end end end diff --git a/sig/brand_dev/models/brand_retrieve_by_name_response.rbs b/sig/brand_dev/models/brand_retrieve_by_name_response.rbs index b165bd5..62447be 100644 --- a/sig/brand_dev/models/brand_retrieve_by_name_response.rbs +++ b/sig/brand_dev/models/brand_retrieve_by_name_response.rbs @@ -4,6 +4,7 @@ module BrandDev { brand: BrandDev::Models::BrandRetrieveByNameResponse::Brand, code: Integer, + key_metadata: BrandDev::Models::BrandRetrieveByNameResponse::KeyMetadata, status: String } @@ -18,6 +19,12 @@ module BrandDev def code=: (Integer) -> Integer + attr_reader key_metadata: BrandDev::Models::BrandRetrieveByNameResponse::KeyMetadata? + + def key_metadata=: ( + BrandDev::Models::BrandRetrieveByNameResponse::KeyMetadata + ) -> BrandDev::Models::BrandRetrieveByNameResponse::KeyMetadata + attr_reader status: String? def status=: (String) -> String @@ -25,12 +32,14 @@ module BrandDev def initialize: ( ?brand: BrandDev::Models::BrandRetrieveByNameResponse::Brand, ?code: Integer, + ?key_metadata: BrandDev::Models::BrandRetrieveByNameResponse::KeyMetadata, ?status: String ) -> void def to_hash: -> { brand: BrandDev::Models::BrandRetrieveByNameResponse::Brand, code: Integer, + key_metadata: BrandDev::Models::BrandRetrieveByNameResponse::KeyMetadata, status: String } @@ -1408,6 +1417,25 @@ module BrandDev def to_hash: -> { exchange: String, ticker: String } end end + + type key_metadata = + { credits_consumed: Integer, credits_remaining: Integer } + + class KeyMetadata < BrandDev::Internal::Type::BaseModel + attr_accessor credits_consumed: Integer + + attr_accessor credits_remaining: Integer + + def initialize: ( + credits_consumed: Integer, + credits_remaining: Integer + ) -> void + + def to_hash: -> { + credits_consumed: Integer, + credits_remaining: Integer + } + end end end end diff --git a/sig/brand_dev/models/brand_retrieve_by_ticker_response.rbs b/sig/brand_dev/models/brand_retrieve_by_ticker_response.rbs index dd38bbe..92a4295 100644 --- a/sig/brand_dev/models/brand_retrieve_by_ticker_response.rbs +++ b/sig/brand_dev/models/brand_retrieve_by_ticker_response.rbs @@ -4,6 +4,7 @@ module BrandDev { brand: BrandDev::Models::BrandRetrieveByTickerResponse::Brand, code: Integer, + key_metadata: BrandDev::Models::BrandRetrieveByTickerResponse::KeyMetadata, status: String } @@ -18,6 +19,12 @@ module BrandDev def code=: (Integer) -> Integer + attr_reader key_metadata: BrandDev::Models::BrandRetrieveByTickerResponse::KeyMetadata? + + def key_metadata=: ( + BrandDev::Models::BrandRetrieveByTickerResponse::KeyMetadata + ) -> BrandDev::Models::BrandRetrieveByTickerResponse::KeyMetadata + attr_reader status: String? def status=: (String) -> String @@ -25,12 +32,14 @@ module BrandDev def initialize: ( ?brand: BrandDev::Models::BrandRetrieveByTickerResponse::Brand, ?code: Integer, + ?key_metadata: BrandDev::Models::BrandRetrieveByTickerResponse::KeyMetadata, ?status: String ) -> void def to_hash: -> { brand: BrandDev::Models::BrandRetrieveByTickerResponse::Brand, code: Integer, + key_metadata: BrandDev::Models::BrandRetrieveByTickerResponse::KeyMetadata, status: String } @@ -1408,6 +1417,25 @@ module BrandDev def to_hash: -> { exchange: String, ticker: String } end end + + type key_metadata = + { credits_consumed: Integer, credits_remaining: Integer } + + class KeyMetadata < BrandDev::Internal::Type::BaseModel + attr_accessor credits_consumed: Integer + + attr_accessor credits_remaining: Integer + + def initialize: ( + credits_consumed: Integer, + credits_remaining: Integer + ) -> void + + def to_hash: -> { + credits_consumed: Integer, + credits_remaining: Integer + } + end end end end diff --git a/sig/brand_dev/models/brand_retrieve_response.rbs b/sig/brand_dev/models/brand_retrieve_response.rbs index 3717d34..3996a47 100644 --- a/sig/brand_dev/models/brand_retrieve_response.rbs +++ b/sig/brand_dev/models/brand_retrieve_response.rbs @@ -4,6 +4,7 @@ module BrandDev { brand: BrandDev::Models::BrandRetrieveResponse::Brand, code: Integer, + key_metadata: BrandDev::Models::BrandRetrieveResponse::KeyMetadata, status: String } @@ -18,6 +19,12 @@ module BrandDev def code=: (Integer) -> Integer + attr_reader key_metadata: BrandDev::Models::BrandRetrieveResponse::KeyMetadata? + + def key_metadata=: ( + BrandDev::Models::BrandRetrieveResponse::KeyMetadata + ) -> BrandDev::Models::BrandRetrieveResponse::KeyMetadata + attr_reader status: String? def status=: (String) -> String @@ -25,12 +32,14 @@ module BrandDev def initialize: ( ?brand: BrandDev::Models::BrandRetrieveResponse::Brand, ?code: Integer, + ?key_metadata: BrandDev::Models::BrandRetrieveResponse::KeyMetadata, ?status: String ) -> void def to_hash: -> { brand: BrandDev::Models::BrandRetrieveResponse::Brand, code: Integer, + key_metadata: BrandDev::Models::BrandRetrieveResponse::KeyMetadata, status: String } @@ -1408,6 +1417,25 @@ module BrandDev def to_hash: -> { exchange: String, ticker: String } end end + + type key_metadata = + { credits_consumed: Integer, credits_remaining: Integer } + + class KeyMetadata < BrandDev::Internal::Type::BaseModel + attr_accessor credits_consumed: Integer + + attr_accessor credits_remaining: Integer + + def initialize: ( + credits_consumed: Integer, + credits_remaining: Integer + ) -> void + + def to_hash: -> { + credits_consumed: Integer, + credits_remaining: Integer + } + end end end end diff --git a/sig/brand_dev/models/brand_retrieve_simplified_response.rbs b/sig/brand_dev/models/brand_retrieve_simplified_response.rbs index d442524..2795098 100644 --- a/sig/brand_dev/models/brand_retrieve_simplified_response.rbs +++ b/sig/brand_dev/models/brand_retrieve_simplified_response.rbs @@ -4,6 +4,7 @@ module BrandDev { brand: BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand, code: Integer, + key_metadata: BrandDev::Models::BrandRetrieveSimplifiedResponse::KeyMetadata, status: String } @@ -18,6 +19,12 @@ module BrandDev def code=: (Integer) -> Integer + attr_reader key_metadata: BrandDev::Models::BrandRetrieveSimplifiedResponse::KeyMetadata? + + def key_metadata=: ( + BrandDev::Models::BrandRetrieveSimplifiedResponse::KeyMetadata + ) -> BrandDev::Models::BrandRetrieveSimplifiedResponse::KeyMetadata + attr_reader status: String? def status=: (String) -> String @@ -25,12 +32,14 @@ module BrandDev def initialize: ( ?brand: BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand, ?code: Integer, + ?key_metadata: BrandDev::Models::BrandRetrieveSimplifiedResponse::KeyMetadata, ?status: String ) -> void def to_hash: -> { brand: BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand, code: Integer, + key_metadata: BrandDev::Models::BrandRetrieveSimplifiedResponse::KeyMetadata, status: String } @@ -307,6 +316,25 @@ module BrandDev end end end + + type key_metadata = + { credits_consumed: Integer, credits_remaining: Integer } + + class KeyMetadata < BrandDev::Internal::Type::BaseModel + attr_accessor credits_consumed: Integer + + attr_accessor credits_remaining: Integer + + def initialize: ( + credits_consumed: Integer, + credits_remaining: Integer + ) -> void + + def to_hash: -> { + credits_consumed: Integer, + credits_remaining: Integer + } + end end end end diff --git a/sig/brand_dev/models/brand_web_scrape_html_response.rbs b/sig/brand_dev/models/brand_web_scrape_html_response.rbs index 54927c8..8421893 100644 --- a/sig/brand_dev/models/brand_web_scrape_html_response.rbs +++ b/sig/brand_dev/models/brand_web_scrape_html_response.rbs @@ -5,7 +5,8 @@ module BrandDev html: String, success: BrandDev::Models::BrandWebScrapeHTMLResponse::success, type: BrandDev::Models::BrandWebScrapeHTMLResponse::type_, - url: String + url: String, + key_metadata: BrandDev::Models::BrandWebScrapeHTMLResponse::KeyMetadata } class BrandWebScrapeHTMLResponse < BrandDev::Internal::Type::BaseModel @@ -17,18 +18,26 @@ module BrandDev attr_accessor url: String + attr_reader key_metadata: BrandDev::Models::BrandWebScrapeHTMLResponse::KeyMetadata? + + def key_metadata=: ( + BrandDev::Models::BrandWebScrapeHTMLResponse::KeyMetadata + ) -> BrandDev::Models::BrandWebScrapeHTMLResponse::KeyMetadata + def initialize: ( html: String, success: BrandDev::Models::BrandWebScrapeHTMLResponse::success, type: BrandDev::Models::BrandWebScrapeHTMLResponse::type_, - url: String + url: String, + ?key_metadata: BrandDev::Models::BrandWebScrapeHTMLResponse::KeyMetadata ) -> void def to_hash: -> { html: String, success: BrandDev::Models::BrandWebScrapeHTMLResponse::success, type: BrandDev::Models::BrandWebScrapeHTMLResponse::type_, - url: String + url: String, + key_metadata: BrandDev::Models::BrandWebScrapeHTMLResponse::KeyMetadata } type success = true @@ -57,6 +66,25 @@ module BrandDev def self?.values: -> ::Array[BrandDev::Models::BrandWebScrapeHTMLResponse::type_] end + + type key_metadata = + { credits_consumed: Integer, credits_remaining: Integer } + + class KeyMetadata < BrandDev::Internal::Type::BaseModel + attr_accessor credits_consumed: Integer + + attr_accessor credits_remaining: Integer + + def initialize: ( + credits_consumed: Integer, + credits_remaining: Integer + ) -> void + + def to_hash: -> { + credits_consumed: Integer, + credits_remaining: Integer + } + end end end end diff --git a/sig/brand_dev/models/brand_web_scrape_images_response.rbs b/sig/brand_dev/models/brand_web_scrape_images_response.rbs index 84a05c0..eae3057 100644 --- a/sig/brand_dev/models/brand_web_scrape_images_response.rbs +++ b/sig/brand_dev/models/brand_web_scrape_images_response.rbs @@ -4,7 +4,8 @@ module BrandDev { images: ::Array[BrandDev::Models::BrandWebScrapeImagesResponse::Image], success: BrandDev::Models::BrandWebScrapeImagesResponse::success, - url: String + url: String, + key_metadata: BrandDev::Models::BrandWebScrapeImagesResponse::KeyMetadata } class BrandWebScrapeImagesResponse < BrandDev::Internal::Type::BaseModel @@ -14,16 +15,24 @@ module BrandDev attr_accessor url: String + attr_reader key_metadata: BrandDev::Models::BrandWebScrapeImagesResponse::KeyMetadata? + + def key_metadata=: ( + BrandDev::Models::BrandWebScrapeImagesResponse::KeyMetadata + ) -> BrandDev::Models::BrandWebScrapeImagesResponse::KeyMetadata + def initialize: ( images: ::Array[BrandDev::Models::BrandWebScrapeImagesResponse::Image], success: BrandDev::Models::BrandWebScrapeImagesResponse::success, - url: String + url: String, + ?key_metadata: BrandDev::Models::BrandWebScrapeImagesResponse::KeyMetadata ) -> void def to_hash: -> { images: ::Array[BrandDev::Models::BrandWebScrapeImagesResponse::Image], success: BrandDev::Models::BrandWebScrapeImagesResponse::success, - url: String + url: String, + key_metadata: BrandDev::Models::BrandWebScrapeImagesResponse::KeyMetadata } type image = @@ -189,6 +198,25 @@ module BrandDev def self?.values: -> ::Array[BrandDev::Models::BrandWebScrapeImagesResponse::success] end + + type key_metadata = + { credits_consumed: Integer, credits_remaining: Integer } + + class KeyMetadata < BrandDev::Internal::Type::BaseModel + attr_accessor credits_consumed: Integer + + attr_accessor credits_remaining: Integer + + def initialize: ( + credits_consumed: Integer, + credits_remaining: Integer + ) -> void + + def to_hash: -> { + credits_consumed: Integer, + credits_remaining: Integer + } + end end end end diff --git a/sig/brand_dev/models/brand_web_scrape_md_response.rbs b/sig/brand_dev/models/brand_web_scrape_md_response.rbs index e6db5eb..1f17332 100644 --- a/sig/brand_dev/models/brand_web_scrape_md_response.rbs +++ b/sig/brand_dev/models/brand_web_scrape_md_response.rbs @@ -4,7 +4,8 @@ module BrandDev { markdown: String, success: BrandDev::Models::BrandWebScrapeMdResponse::success, - url: String + url: String, + key_metadata: BrandDev::Models::BrandWebScrapeMdResponse::KeyMetadata } class BrandWebScrapeMdResponse < BrandDev::Internal::Type::BaseModel @@ -14,16 +15,24 @@ module BrandDev attr_accessor url: String + attr_reader key_metadata: BrandDev::Models::BrandWebScrapeMdResponse::KeyMetadata? + + def key_metadata=: ( + BrandDev::Models::BrandWebScrapeMdResponse::KeyMetadata + ) -> BrandDev::Models::BrandWebScrapeMdResponse::KeyMetadata + def initialize: ( markdown: String, success: BrandDev::Models::BrandWebScrapeMdResponse::success, - url: String + url: String, + ?key_metadata: BrandDev::Models::BrandWebScrapeMdResponse::KeyMetadata ) -> void def to_hash: -> { markdown: String, success: BrandDev::Models::BrandWebScrapeMdResponse::success, - url: String + url: String, + key_metadata: BrandDev::Models::BrandWebScrapeMdResponse::KeyMetadata } type success = true @@ -35,6 +44,25 @@ module BrandDev def self?.values: -> ::Array[BrandDev::Models::BrandWebScrapeMdResponse::success] end + + type key_metadata = + { credits_consumed: Integer, credits_remaining: Integer } + + class KeyMetadata < BrandDev::Internal::Type::BaseModel + attr_accessor credits_consumed: Integer + + attr_accessor credits_remaining: Integer + + def initialize: ( + credits_consumed: Integer, + credits_remaining: Integer + ) -> void + + def to_hash: -> { + credits_consumed: Integer, + credits_remaining: Integer + } + end end end end diff --git a/sig/brand_dev/models/brand_web_scrape_sitemap_response.rbs b/sig/brand_dev/models/brand_web_scrape_sitemap_response.rbs index dc249ab..acc04a6 100644 --- a/sig/brand_dev/models/brand_web_scrape_sitemap_response.rbs +++ b/sig/brand_dev/models/brand_web_scrape_sitemap_response.rbs @@ -5,7 +5,8 @@ module BrandDev domain: String, meta: BrandDev::Models::BrandWebScrapeSitemapResponse::Meta, success: BrandDev::Models::BrandWebScrapeSitemapResponse::success, - urls: ::Array[String] + urls: ::Array[String], + key_metadata: BrandDev::Models::BrandWebScrapeSitemapResponse::KeyMetadata } class BrandWebScrapeSitemapResponse < BrandDev::Internal::Type::BaseModel @@ -17,18 +18,26 @@ module BrandDev attr_accessor urls: ::Array[String] + attr_reader key_metadata: BrandDev::Models::BrandWebScrapeSitemapResponse::KeyMetadata? + + def key_metadata=: ( + BrandDev::Models::BrandWebScrapeSitemapResponse::KeyMetadata + ) -> BrandDev::Models::BrandWebScrapeSitemapResponse::KeyMetadata + def initialize: ( domain: String, meta: BrandDev::Models::BrandWebScrapeSitemapResponse::Meta, success: BrandDev::Models::BrandWebScrapeSitemapResponse::success, - urls: ::Array[String] + urls: ::Array[String], + ?key_metadata: BrandDev::Models::BrandWebScrapeSitemapResponse::KeyMetadata ) -> void def to_hash: -> { domain: String, meta: BrandDev::Models::BrandWebScrapeSitemapResponse::Meta, success: BrandDev::Models::BrandWebScrapeSitemapResponse::success, - urls: ::Array[String] + urls: ::Array[String], + key_metadata: BrandDev::Models::BrandWebScrapeSitemapResponse::KeyMetadata } type meta = @@ -72,6 +81,25 @@ module BrandDev def self?.values: -> ::Array[BrandDev::Models::BrandWebScrapeSitemapResponse::success] end + + type key_metadata = + { credits_consumed: Integer, credits_remaining: Integer } + + class KeyMetadata < BrandDev::Internal::Type::BaseModel + attr_accessor credits_consumed: Integer + + attr_accessor credits_remaining: Integer + + def initialize: ( + credits_consumed: Integer, + credits_remaining: Integer + ) -> void + + def to_hash: -> { + credits_consumed: Integer, + credits_remaining: Integer + } + end end end end diff --git a/test/brand_dev/resources/brand_test.rb b/test/brand_dev/resources/brand_test.rb index d803878..29de43f 100644 --- a/test/brand_dev/resources/brand_test.rb +++ b/test/brand_dev/resources/brand_test.rb @@ -16,6 +16,7 @@ def test_retrieve_required_params response => { brand: BrandDev::Models::BrandRetrieveResponse::Brand | nil, code: Integer | nil, + key_metadata: BrandDev::Models::BrandRetrieveResponse::KeyMetadata | nil, status: String | nil } end @@ -33,6 +34,7 @@ def test_ai_product_required_params assert_pattern do response => { is_product_page: BrandDev::Internal::Type::Boolean | nil, + key_metadata: BrandDev::Models::BrandAIProductResponse::KeyMetadata | nil, platform: BrandDev::Models::BrandAIProductResponse::Platform | nil, product: BrandDev::Models::BrandAIProductResponse::Product | nil } @@ -50,6 +52,7 @@ def test_ai_products_required_params assert_pattern do response => { + key_metadata: BrandDev::Models::BrandAIProductsResponse::KeyMetadata | nil, products: ^(BrandDev::Internal::Type::ArrayOf[BrandDev::Models::BrandAIProductsResponse::Product]) | nil } end @@ -79,6 +82,7 @@ def test_ai_query_required_params response => { data_extracted: ^(BrandDev::Internal::Type::ArrayOf[BrandDev::Models::BrandAIQueryResponse::DataExtracted]) | nil, domain: String | nil, + key_metadata: BrandDev::Models::BrandAIQueryResponse::KeyMetadata | nil, status: String | nil, urls_analyzed: ^(BrandDev::Internal::Type::ArrayOf[String]) | nil } @@ -98,6 +102,7 @@ def test_identify_from_transaction_required_params response => { brand: BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand | nil, code: Integer | nil, + key_metadata: BrandDev::Models::BrandIdentifyFromTransactionResponse::KeyMetadata | nil, status: String | nil } end @@ -115,6 +120,7 @@ def test_prefetch_required_params assert_pattern do response => { domain: String | nil, + key_metadata: BrandDev::Models::BrandPrefetchResponse::KeyMetadata | nil, message: String | nil, status: String | nil } @@ -133,6 +139,7 @@ def test_prefetch_by_email_required_params assert_pattern do response => { domain: String | nil, + key_metadata: BrandDev::Models::BrandPrefetchByEmailResponse::KeyMetadata | nil, message: String | nil, status: String | nil } @@ -152,6 +159,7 @@ def test_retrieve_by_email_required_params response => { brand: BrandDev::Models::BrandRetrieveByEmailResponse::Brand | nil, code: Integer | nil, + key_metadata: BrandDev::Models::BrandRetrieveByEmailResponse::KeyMetadata | nil, status: String | nil } end @@ -170,6 +178,7 @@ def test_retrieve_by_isin_required_params response => { brand: BrandDev::Models::BrandRetrieveByIsinResponse::Brand | nil, code: Integer | nil, + key_metadata: BrandDev::Models::BrandRetrieveByIsinResponse::KeyMetadata | nil, status: String | nil } end @@ -188,6 +197,7 @@ def test_retrieve_by_name_required_params response => { brand: BrandDev::Models::BrandRetrieveByNameResponse::Brand | nil, code: Integer | nil, + key_metadata: BrandDev::Models::BrandRetrieveByNameResponse::KeyMetadata | nil, status: String | nil } end @@ -206,6 +216,7 @@ def test_retrieve_by_ticker_required_params response => { brand: BrandDev::Models::BrandRetrieveByTickerResponse::Brand | nil, code: Integer | nil, + key_metadata: BrandDev::Models::BrandRetrieveByTickerResponse::KeyMetadata | nil, status: String | nil } end @@ -224,6 +235,7 @@ def test_retrieve_simplified_required_params response => { brand: BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand | nil, code: Integer | nil, + key_metadata: BrandDev::Models::BrandRetrieveSimplifiedResponse::KeyMetadata | nil, status: String | nil } end @@ -243,7 +255,8 @@ def test_web_scrape_html_required_params html: String, success: BrandDev::Models::BrandWebScrapeHTMLResponse::Success, type: BrandDev::Models::BrandWebScrapeHTMLResponse::Type, - url: String + url: String, + key_metadata: BrandDev::Models::BrandWebScrapeHTMLResponse::KeyMetadata | nil } end end @@ -261,7 +274,8 @@ def test_web_scrape_images_required_params response => { images: ^(BrandDev::Internal::Type::ArrayOf[BrandDev::Models::BrandWebScrapeImagesResponse::Image]), success: BrandDev::Models::BrandWebScrapeImagesResponse::Success, - url: String + url: String, + key_metadata: BrandDev::Models::BrandWebScrapeImagesResponse::KeyMetadata | nil } end end @@ -279,7 +293,8 @@ def test_web_scrape_md_required_params response => { markdown: String, success: BrandDev::Models::BrandWebScrapeMdResponse::Success, - url: String + url: String, + key_metadata: BrandDev::Models::BrandWebScrapeMdResponse::KeyMetadata | nil } end end @@ -298,7 +313,8 @@ def test_web_scrape_sitemap_required_params domain: String, meta: BrandDev::Models::BrandWebScrapeSitemapResponse::Meta, success: BrandDev::Models::BrandWebScrapeSitemapResponse::Success, - urls: ^(BrandDev::Internal::Type::ArrayOf[String]) + urls: ^(BrandDev::Internal::Type::ArrayOf[String]), + key_metadata: BrandDev::Models::BrandWebScrapeSitemapResponse::KeyMetadata | nil } end end From 2bc0949944a5b41a2f21f67fb19a44b037b65777 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 11 Jun 2026 11:16:06 +0000 Subject: [PATCH 75/82] codegen metadata --- .stats.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.stats.yml b/.stats.yml index 503623e..1090a51 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 16 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-5545bb30aeac61ddb7d2b84ada399e9cd1cdc531a494b41e2ccf720056bdd437.yml -openapi_spec_hash: 554a88e7acd677dd0acac34b3900e5c6 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-3bfe60884f1e3f19275b10d8d6d7d5ce22d7cd7aff6847eb433d8a9b77c2ecc7.yml +openapi_spec_hash: d6bd2e085a73b0a5d6ddfa20d5949094 config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 From 71269a9843e8a7d01f19f17889bc553c266d5a69 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 16 Jun 2026 17:36:07 +0000 Subject: [PATCH 76/82] feat(api): api update --- lib/brand_dev/internal/transport/base_client.rb | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/lib/brand_dev/internal/transport/base_client.rb b/lib/brand_dev/internal/transport/base_client.rb index b7847ac..111dc4a 100644 --- a/lib/brand_dev/internal/transport/base_client.rb +++ b/lib/brand_dev/internal/transport/base_client.rb @@ -306,7 +306,10 @@ def initialize( BrandDev::Internal::Util.deep_merge(*[req[:body], opts[:extra_body]].compact) end - headers.delete("content-type") if body.nil? + # Generated methods always pass `req[:body]` for operations that define a + # request body, so only elide the content-type header when the operation + # has no body at all, not when an optional body param was omitted. + headers.delete("content-type") if body.nil? && !req.key?(:body) url = BrandDev::Internal::Util.join_parsed_uri( @base_url_components, From f01cd6ccbfc3fe3a65058a2f30e3eb38cd8fcdf1 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 16 Jun 2026 23:16:29 +0000 Subject: [PATCH 77/82] codegen metadata --- .stats.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.stats.yml b/.stats.yml index 1090a51..8066585 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 16 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-3bfe60884f1e3f19275b10d8d6d7d5ce22d7cd7aff6847eb433d8a9b77c2ecc7.yml -openapi_spec_hash: d6bd2e085a73b0a5d6ddfa20d5949094 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-8fc464c01db0ca1150918b073df5e6b3dc4983268a3f2db1ee07b66a16b0a5fc.yml +openapi_spec_hash: 53f4527ee9daaed3e8da72bdda5657b5 config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 From 29df8d63546e19deb48cd4e6f5c54b535beb85d8 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 18 Jun 2026 12:03:46 +0000 Subject: [PATCH 78/82] feat(api): api update --- .stats.yml | 4 +- .../models/brand_web_scrape_html_response.rb | 257 +++++++++- .../models/brand_web_scrape_md_response.rb | 257 +++++++++- .../models/brand_web_scrape_html_response.rbi | 475 ++++++++++++++++++ .../models/brand_web_scrape_md_response.rbi | 474 +++++++++++++++++ .../models/brand_web_scrape_html_response.rbs | 219 ++++++++ .../models/brand_web_scrape_md_response.rbs | 219 ++++++++ test/brand_dev/resources/brand_test.rb | 2 + 8 files changed, 1903 insertions(+), 4 deletions(-) diff --git a/.stats.yml b/.stats.yml index 8066585..868ac28 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 16 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-8fc464c01db0ca1150918b073df5e6b3dc4983268a3f2db1ee07b66a16b0a5fc.yml -openapi_spec_hash: 53f4527ee9daaed3e8da72bdda5657b5 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-06023f50b1343cf31237929fe1dbbe0a8992e99eaf720daf333e190a483ca7ea.yml +openapi_spec_hash: 65b215730d00bd4ef3cd998df33b2de0 config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 diff --git a/lib/brand_dev/models/brand_web_scrape_html_response.rb b/lib/brand_dev/models/brand_web_scrape_html_response.rb index fc61d41..3ba63bf 100644 --- a/lib/brand_dev/models/brand_web_scrape_html_response.rb +++ b/lib/brand_dev/models/brand_web_scrape_html_response.rb @@ -12,6 +12,12 @@ class BrandWebScrapeHTMLResponse < BrandDev::Internal::Type::BaseModel # @return [String] required :html, String + # @!attribute metadata + # Metadata extracted from the scraped page HTML. + # + # @return [BrandDev::Models::BrandWebScrapeHTMLResponse::Metadata] + required :metadata, -> { BrandDev::Models::BrandWebScrapeHTMLResponse::Metadata } + # @!attribute success # Indicates success # @@ -38,12 +44,14 @@ class BrandWebScrapeHTMLResponse < BrandDev::Internal::Type::BaseModel # @return [BrandDev::Models::BrandWebScrapeHTMLResponse::KeyMetadata, nil] optional :key_metadata, -> { BrandDev::Models::BrandWebScrapeHTMLResponse::KeyMetadata } - # @!method initialize(html:, success:, type:, url:, key_metadata: nil) + # @!method initialize(html:, metadata:, success:, type:, url:, key_metadata: nil) # Some parameter documentations has been truncated, see # {BrandDev::Models::BrandWebScrapeHTMLResponse} for more details. # # @param html [String] The scraped content of the page. For normal pages this is the raw HTML. When the # + # @param metadata [BrandDev::Models::BrandWebScrapeHTMLResponse::Metadata] Metadata extracted from the scraped page HTML. + # # @param success [Boolean, BrandDev::Models::BrandWebScrapeHTMLResponse::Success] Indicates success # # @param type [Symbol, BrandDev::Models::BrandWebScrapeHTMLResponse::Type] Detected content type of the returned `html` field. Sitemaps and feeds are surfa @@ -52,6 +60,253 @@ class BrandWebScrapeHTMLResponse < BrandDev::Internal::Type::BaseModel # # @param key_metadata [BrandDev::Models::BrandWebScrapeHTMLResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when + # @see BrandDev::Models::BrandWebScrapeHTMLResponse#metadata + class Metadata < BrandDev::Internal::Type::BaseModel + # @!attribute final_url + # Final URL scraped after redirects or scraper fallback, when known. Falls back to + # sourceUrl when unavailable. + # + # @return [String] + required :final_url, String, api_name: :finalUrl + + # @!attribute source_url + # Original URL requested by the caller. + # + # @return [String] + required :source_url, String, api_name: :sourceUrl + + # @!attribute additional_meta + # Additional non-social meta tags not promoted to top-level metadata fields. + # + # @return [Hash{Symbol=>String, Array}, nil] + optional :additional_meta, + -> { BrandDev::Internal::Type::HashOf[union: BrandDev::Models::BrandWebScrapeHTMLResponse::Metadata::AdditionalMeta] }, + api_name: :additionalMeta + + # @!attribute alternates + # Resolved alternate links from link rel=alternate tags. + # + # @return [Array, nil] + optional :alternates, + -> { BrandDev::Internal::Type::ArrayOf[BrandDev::Models::BrandWebScrapeHTMLResponse::Metadata::Alternate] } + + # @!attribute author + # Author metadata, when present. + # + # @return [String, nil] + optional :author, String + + # @!attribute canonical_url + # Resolved canonical URL, when present. + # + # @return [String, nil] + optional :canonical_url, String, api_name: :canonicalUrl + + # @!attribute description + # Best description extracted from standard, Open Graph, or Twitter metadata. + # + # @return [String, nil] + optional :description, String + + # @!attribute favicon + # Resolved favicon URL, when present. + # + # @return [String, nil] + optional :favicon, String + + # @!attribute image + # Primary resolved preview image from Open Graph, Twitter, or image metadata. + # + # @return [String, nil] + optional :image, String + + # @!attribute json_ld + # JSON-LD structured data blocks parsed from the page. + # + # @return [ArrayObject}>, nil] + optional :json_ld, + BrandDev::Internal::Type::ArrayOf[BrandDev::Internal::Type::HashOf[BrandDev::Internal::Type::Unknown]], + api_name: :jsonLd + + # @!attribute keywords + # Keywords extracted from the page's keywords meta tag. + # + # @return [Array, nil] + optional :keywords, BrandDev::Internal::Type::ArrayOf[String] + + # @!attribute language + # Language extracted from html lang or language meta tags. + # + # @return [String, nil] + optional :language, String + + # @!attribute modified_time + # Modified timestamp/date from page metadata, when present. + # + # @return [String, nil] + optional :modified_time, String, api_name: :modifiedTime + + # @!attribute open_graph + # Open Graph metadata with the og: prefix removed and keys camel-cased. + # + # @return [Hash{Symbol=>String, Array}, nil] + optional :open_graph, + -> { BrandDev::Internal::Type::HashOf[union: BrandDev::Models::BrandWebScrapeHTMLResponse::Metadata::OpenGraph] }, + api_name: :openGraph + + # @!attribute published_time + # Published timestamp/date from page metadata, when present. + # + # @return [String, nil] + optional :published_time, String, api_name: :publishedTime + + # @!attribute robots + # Robots meta directive, when present. + # + # @return [String, nil] + optional :robots, String + + # @!attribute site_name + # Site or application name from page metadata. + # + # @return [String, nil] + optional :site_name, String, api_name: :siteName + + # @!attribute title + # Best title extracted from the page. + # + # @return [String, nil] + optional :title, String + + # @!attribute twitter + # Twitter card metadata with the twitter: prefix removed and keys camel-cased. + # + # @return [Hash{Symbol=>String, Array}, nil] + optional :twitter, + -> { BrandDev::Internal::Type::HashOf[union: BrandDev::Models::BrandWebScrapeHTMLResponse::Metadata::Twitter] } + + # @!method initialize(final_url:, source_url:, additional_meta: nil, alternates: nil, author: nil, canonical_url: nil, description: nil, favicon: nil, image: nil, json_ld: nil, keywords: nil, language: nil, modified_time: nil, open_graph: nil, published_time: nil, robots: nil, site_name: nil, title: nil, twitter: nil) + # Some parameter documentations has been truncated, see + # {BrandDev::Models::BrandWebScrapeHTMLResponse::Metadata} for more details. + # + # Metadata extracted from the scraped page HTML. + # + # @param final_url [String] Final URL scraped after redirects or scraper fallback, when known. Falls back to + # + # @param source_url [String] Original URL requested by the caller. + # + # @param additional_meta [Hash{Symbol=>String, Array}] Additional non-social meta tags not promoted to top-level metadata fields. + # + # @param alternates [Array] Resolved alternate links from link rel=alternate tags. + # + # @param author [String] Author metadata, when present. + # + # @param canonical_url [String] Resolved canonical URL, when present. + # + # @param description [String] Best description extracted from standard, Open Graph, or Twitter metadata. + # + # @param favicon [String] Resolved favicon URL, when present. + # + # @param image [String] Primary resolved preview image from Open Graph, Twitter, or image metadata. + # + # @param json_ld [ArrayObject}>] JSON-LD structured data blocks parsed from the page. + # + # @param keywords [Array] Keywords extracted from the page's keywords meta tag. + # + # @param language [String] Language extracted from html lang or language meta tags. + # + # @param modified_time [String] Modified timestamp/date from page metadata, when present. + # + # @param open_graph [Hash{Symbol=>String, Array}] Open Graph metadata with the og: prefix removed and keys camel-cased. + # + # @param published_time [String] Published timestamp/date from page metadata, when present. + # + # @param robots [String] Robots meta directive, when present. + # + # @param site_name [String] Site or application name from page metadata. + # + # @param title [String] Best title extracted from the page. + # + # @param twitter [Hash{Symbol=>String, Array}] Twitter card metadata with the twitter: prefix removed and keys camel-cased. + + module AdditionalMeta + extend BrandDev::Internal::Type::Union + + variant String + + variant -> { BrandDev::Models::BrandWebScrapeHTMLResponse::Metadata::AdditionalMeta::StringArray } + + # @!method self.variants + # @return [Array(String, Array)] + + # @type [BrandDev::Internal::Type::Converter] + StringArray = BrandDev::Internal::Type::ArrayOf[String] + end + + class Alternate < BrandDev::Internal::Type::BaseModel + # @!attribute href + # Resolved alternate URL. + # + # @return [String] + required :href, String + + # @!attribute hreflang + # Language or locale for the alternate URL, when present. + # + # @return [String, nil] + optional :hreflang, String + + # @!attribute title + # Alternate resource title, when present. + # + # @return [String, nil] + optional :title, String + + # @!attribute type + # Alternate resource MIME type, when present. + # + # @return [String, nil] + optional :type, String + + # @!method initialize(href:, hreflang: nil, title: nil, type: nil) + # @param href [String] Resolved alternate URL. + # + # @param hreflang [String] Language or locale for the alternate URL, when present. + # + # @param title [String] Alternate resource title, when present. + # + # @param type [String] Alternate resource MIME type, when present. + end + + module OpenGraph + extend BrandDev::Internal::Type::Union + + variant String + + variant -> { BrandDev::Models::BrandWebScrapeHTMLResponse::Metadata::OpenGraph::StringArray } + + # @!method self.variants + # @return [Array(String, Array)] + + # @type [BrandDev::Internal::Type::Converter] + StringArray = BrandDev::Internal::Type::ArrayOf[String] + end + + module Twitter + extend BrandDev::Internal::Type::Union + + variant String + + variant -> { BrandDev::Models::BrandWebScrapeHTMLResponse::Metadata::Twitter::StringArray } + + # @!method self.variants + # @return [Array(String, Array)] + + # @type [BrandDev::Internal::Type::Converter] + StringArray = BrandDev::Internal::Type::ArrayOf[String] + end + end + # Indicates success # # @see BrandDev::Models::BrandWebScrapeHTMLResponse#success diff --git a/lib/brand_dev/models/brand_web_scrape_md_response.rb b/lib/brand_dev/models/brand_web_scrape_md_response.rb index 4f3300d..00f8b2a 100644 --- a/lib/brand_dev/models/brand_web_scrape_md_response.rb +++ b/lib/brand_dev/models/brand_web_scrape_md_response.rb @@ -10,6 +10,12 @@ class BrandWebScrapeMdResponse < BrandDev::Internal::Type::BaseModel # @return [String] required :markdown, String + # @!attribute metadata + # Metadata extracted from the scraped page HTML. + # + # @return [BrandDev::Models::BrandWebScrapeMdResponse::Metadata] + required :metadata, -> { BrandDev::Models::BrandWebScrapeMdResponse::Metadata } + # @!attribute success # Indicates success # @@ -29,18 +35,267 @@ class BrandWebScrapeMdResponse < BrandDev::Internal::Type::BaseModel # @return [BrandDev::Models::BrandWebScrapeMdResponse::KeyMetadata, nil] optional :key_metadata, -> { BrandDev::Models::BrandWebScrapeMdResponse::KeyMetadata } - # @!method initialize(markdown:, success:, url:, key_metadata: nil) + # @!method initialize(markdown:, metadata:, success:, url:, key_metadata: nil) # Some parameter documentations has been truncated, see # {BrandDev::Models::BrandWebScrapeMdResponse} for more details. # # @param markdown [String] Page content converted to GitHub Flavored Markdown # + # @param metadata [BrandDev::Models::BrandWebScrapeMdResponse::Metadata] Metadata extracted from the scraped page HTML. + # # @param success [Boolean, BrandDev::Models::BrandWebScrapeMdResponse::Success] Indicates success # # @param url [String] The URL that was scraped # # @param key_metadata [BrandDev::Models::BrandWebScrapeMdResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when + # @see BrandDev::Models::BrandWebScrapeMdResponse#metadata + class Metadata < BrandDev::Internal::Type::BaseModel + # @!attribute final_url + # Final URL scraped after redirects or scraper fallback, when known. Falls back to + # sourceUrl when unavailable. + # + # @return [String] + required :final_url, String, api_name: :finalUrl + + # @!attribute source_url + # Original URL requested by the caller. + # + # @return [String] + required :source_url, String, api_name: :sourceUrl + + # @!attribute additional_meta + # Additional non-social meta tags not promoted to top-level metadata fields. + # + # @return [Hash{Symbol=>String, Array}, nil] + optional :additional_meta, + -> { BrandDev::Internal::Type::HashOf[union: BrandDev::Models::BrandWebScrapeMdResponse::Metadata::AdditionalMeta] }, + api_name: :additionalMeta + + # @!attribute alternates + # Resolved alternate links from link rel=alternate tags. + # + # @return [Array, nil] + optional :alternates, + -> { BrandDev::Internal::Type::ArrayOf[BrandDev::Models::BrandWebScrapeMdResponse::Metadata::Alternate] } + + # @!attribute author + # Author metadata, when present. + # + # @return [String, nil] + optional :author, String + + # @!attribute canonical_url + # Resolved canonical URL, when present. + # + # @return [String, nil] + optional :canonical_url, String, api_name: :canonicalUrl + + # @!attribute description + # Best description extracted from standard, Open Graph, or Twitter metadata. + # + # @return [String, nil] + optional :description, String + + # @!attribute favicon + # Resolved favicon URL, when present. + # + # @return [String, nil] + optional :favicon, String + + # @!attribute image + # Primary resolved preview image from Open Graph, Twitter, or image metadata. + # + # @return [String, nil] + optional :image, String + + # @!attribute json_ld + # JSON-LD structured data blocks parsed from the page. + # + # @return [ArrayObject}>, nil] + optional :json_ld, + BrandDev::Internal::Type::ArrayOf[BrandDev::Internal::Type::HashOf[BrandDev::Internal::Type::Unknown]], + api_name: :jsonLd + + # @!attribute keywords + # Keywords extracted from the page's keywords meta tag. + # + # @return [Array, nil] + optional :keywords, BrandDev::Internal::Type::ArrayOf[String] + + # @!attribute language + # Language extracted from html lang or language meta tags. + # + # @return [String, nil] + optional :language, String + + # @!attribute modified_time + # Modified timestamp/date from page metadata, when present. + # + # @return [String, nil] + optional :modified_time, String, api_name: :modifiedTime + + # @!attribute open_graph + # Open Graph metadata with the og: prefix removed and keys camel-cased. + # + # @return [Hash{Symbol=>String, Array}, nil] + optional :open_graph, + -> { BrandDev::Internal::Type::HashOf[union: BrandDev::Models::BrandWebScrapeMdResponse::Metadata::OpenGraph] }, + api_name: :openGraph + + # @!attribute published_time + # Published timestamp/date from page metadata, when present. + # + # @return [String, nil] + optional :published_time, String, api_name: :publishedTime + + # @!attribute robots + # Robots meta directive, when present. + # + # @return [String, nil] + optional :robots, String + + # @!attribute site_name + # Site or application name from page metadata. + # + # @return [String, nil] + optional :site_name, String, api_name: :siteName + + # @!attribute title + # Best title extracted from the page. + # + # @return [String, nil] + optional :title, String + + # @!attribute twitter + # Twitter card metadata with the twitter: prefix removed and keys camel-cased. + # + # @return [Hash{Symbol=>String, Array}, nil] + optional :twitter, + -> { BrandDev::Internal::Type::HashOf[union: BrandDev::Models::BrandWebScrapeMdResponse::Metadata::Twitter] } + + # @!method initialize(final_url:, source_url:, additional_meta: nil, alternates: nil, author: nil, canonical_url: nil, description: nil, favicon: nil, image: nil, json_ld: nil, keywords: nil, language: nil, modified_time: nil, open_graph: nil, published_time: nil, robots: nil, site_name: nil, title: nil, twitter: nil) + # Some parameter documentations has been truncated, see + # {BrandDev::Models::BrandWebScrapeMdResponse::Metadata} for more details. + # + # Metadata extracted from the scraped page HTML. + # + # @param final_url [String] Final URL scraped after redirects or scraper fallback, when known. Falls back to + # + # @param source_url [String] Original URL requested by the caller. + # + # @param additional_meta [Hash{Symbol=>String, Array}] Additional non-social meta tags not promoted to top-level metadata fields. + # + # @param alternates [Array] Resolved alternate links from link rel=alternate tags. + # + # @param author [String] Author metadata, when present. + # + # @param canonical_url [String] Resolved canonical URL, when present. + # + # @param description [String] Best description extracted from standard, Open Graph, or Twitter metadata. + # + # @param favicon [String] Resolved favicon URL, when present. + # + # @param image [String] Primary resolved preview image from Open Graph, Twitter, or image metadata. + # + # @param json_ld [ArrayObject}>] JSON-LD structured data blocks parsed from the page. + # + # @param keywords [Array] Keywords extracted from the page's keywords meta tag. + # + # @param language [String] Language extracted from html lang or language meta tags. + # + # @param modified_time [String] Modified timestamp/date from page metadata, when present. + # + # @param open_graph [Hash{Symbol=>String, Array}] Open Graph metadata with the og: prefix removed and keys camel-cased. + # + # @param published_time [String] Published timestamp/date from page metadata, when present. + # + # @param robots [String] Robots meta directive, when present. + # + # @param site_name [String] Site or application name from page metadata. + # + # @param title [String] Best title extracted from the page. + # + # @param twitter [Hash{Symbol=>String, Array}] Twitter card metadata with the twitter: prefix removed and keys camel-cased. + + module AdditionalMeta + extend BrandDev::Internal::Type::Union + + variant String + + variant -> { BrandDev::Models::BrandWebScrapeMdResponse::Metadata::AdditionalMeta::StringArray } + + # @!method self.variants + # @return [Array(String, Array)] + + # @type [BrandDev::Internal::Type::Converter] + StringArray = BrandDev::Internal::Type::ArrayOf[String] + end + + class Alternate < BrandDev::Internal::Type::BaseModel + # @!attribute href + # Resolved alternate URL. + # + # @return [String] + required :href, String + + # @!attribute hreflang + # Language or locale for the alternate URL, when present. + # + # @return [String, nil] + optional :hreflang, String + + # @!attribute title + # Alternate resource title, when present. + # + # @return [String, nil] + optional :title, String + + # @!attribute type + # Alternate resource MIME type, when present. + # + # @return [String, nil] + optional :type, String + + # @!method initialize(href:, hreflang: nil, title: nil, type: nil) + # @param href [String] Resolved alternate URL. + # + # @param hreflang [String] Language or locale for the alternate URL, when present. + # + # @param title [String] Alternate resource title, when present. + # + # @param type [String] Alternate resource MIME type, when present. + end + + module OpenGraph + extend BrandDev::Internal::Type::Union + + variant String + + variant -> { BrandDev::Models::BrandWebScrapeMdResponse::Metadata::OpenGraph::StringArray } + + # @!method self.variants + # @return [Array(String, Array)] + + # @type [BrandDev::Internal::Type::Converter] + StringArray = BrandDev::Internal::Type::ArrayOf[String] + end + + module Twitter + extend BrandDev::Internal::Type::Union + + variant String + + variant -> { BrandDev::Models::BrandWebScrapeMdResponse::Metadata::Twitter::StringArray } + + # @!method self.variants + # @return [Array(String, Array)] + + # @type [BrandDev::Internal::Type::Converter] + StringArray = BrandDev::Internal::Type::ArrayOf[String] + end + end + # Indicates success # # @see BrandDev::Models::BrandWebScrapeMdResponse#success diff --git a/rbi/brand_dev/models/brand_web_scrape_html_response.rbi b/rbi/brand_dev/models/brand_web_scrape_html_response.rbi index 90d5c54..ffcc98f 100644 --- a/rbi/brand_dev/models/brand_web_scrape_html_response.rbi +++ b/rbi/brand_dev/models/brand_web_scrape_html_response.rbi @@ -17,6 +17,18 @@ module BrandDev sig { returns(String) } attr_accessor :html + # Metadata extracted from the scraped page HTML. + sig { returns(BrandDev::Models::BrandWebScrapeHTMLResponse::Metadata) } + attr_reader :metadata + + sig do + params( + metadata: + BrandDev::Models::BrandWebScrapeHTMLResponse::Metadata::OrHash + ).void + end + attr_writer :metadata + # Indicates success sig do returns( @@ -58,6 +70,8 @@ module BrandDev sig do params( html: String, + metadata: + BrandDev::Models::BrandWebScrapeHTMLResponse::Metadata::OrHash, success: BrandDev::Models::BrandWebScrapeHTMLResponse::Success::OrBoolean, type: BrandDev::Models::BrandWebScrapeHTMLResponse::Type::OrSymbol, @@ -71,6 +85,8 @@ module BrandDev # page is a sitemap or feed served behind an XSL stylesheet (which browsers render # into HTML), this is the underlying XML instead — see the `type` field. html:, + # Metadata extracted from the scraped page HTML. + metadata:, # Indicates success success:, # Detected content type of the returned `html` field. Sitemaps and feeds are @@ -88,6 +104,7 @@ module BrandDev override.returns( { html: String, + metadata: BrandDev::Models::BrandWebScrapeHTMLResponse::Metadata, success: BrandDev::Models::BrandWebScrapeHTMLResponse::Success::TaggedBoolean, type: @@ -101,6 +118,464 @@ module BrandDev def to_hash end + class Metadata < BrandDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + BrandDev::Models::BrandWebScrapeHTMLResponse::Metadata, + BrandDev::Internal::AnyHash + ) + end + + # Final URL scraped after redirects or scraper fallback, when known. Falls back to + # sourceUrl when unavailable. + sig { returns(String) } + attr_accessor :final_url + + # Original URL requested by the caller. + sig { returns(String) } + attr_accessor :source_url + + # Additional non-social meta tags not promoted to top-level metadata fields. + sig do + returns( + T.nilable( + T::Hash[ + Symbol, + BrandDev::Models::BrandWebScrapeHTMLResponse::Metadata::AdditionalMeta::Variants + ] + ) + ) + end + attr_reader :additional_meta + + sig do + params( + additional_meta: + T::Hash[ + Symbol, + BrandDev::Models::BrandWebScrapeHTMLResponse::Metadata::AdditionalMeta::Variants + ] + ).void + end + attr_writer :additional_meta + + # Resolved alternate links from link rel=alternate tags. + sig do + returns( + T.nilable( + T::Array[ + BrandDev::Models::BrandWebScrapeHTMLResponse::Metadata::Alternate + ] + ) + ) + end + attr_reader :alternates + + sig do + params( + alternates: + T::Array[ + BrandDev::Models::BrandWebScrapeHTMLResponse::Metadata::Alternate::OrHash + ] + ).void + end + attr_writer :alternates + + # Author metadata, when present. + sig { returns(T.nilable(String)) } + attr_reader :author + + sig { params(author: String).void } + attr_writer :author + + # Resolved canonical URL, when present. + sig { returns(T.nilable(String)) } + attr_reader :canonical_url + + sig { params(canonical_url: String).void } + attr_writer :canonical_url + + # Best description extracted from standard, Open Graph, or Twitter metadata. + sig { returns(T.nilable(String)) } + attr_reader :description + + sig { params(description: String).void } + attr_writer :description + + # Resolved favicon URL, when present. + sig { returns(T.nilable(String)) } + attr_reader :favicon + + sig { params(favicon: String).void } + attr_writer :favicon + + # Primary resolved preview image from Open Graph, Twitter, or image metadata. + sig { returns(T.nilable(String)) } + attr_reader :image + + sig { params(image: String).void } + attr_writer :image + + # JSON-LD structured data blocks parsed from the page. + sig { returns(T.nilable(T::Array[T::Hash[Symbol, T.anything]])) } + attr_reader :json_ld + + sig { params(json_ld: T::Array[T::Hash[Symbol, T.anything]]).void } + attr_writer :json_ld + + # Keywords extracted from the page's keywords meta tag. + sig { returns(T.nilable(T::Array[String])) } + attr_reader :keywords + + sig { params(keywords: T::Array[String]).void } + attr_writer :keywords + + # Language extracted from html lang or language meta tags. + sig { returns(T.nilable(String)) } + attr_reader :language + + sig { params(language: String).void } + attr_writer :language + + # Modified timestamp/date from page metadata, when present. + sig { returns(T.nilable(String)) } + attr_reader :modified_time + + sig { params(modified_time: String).void } + attr_writer :modified_time + + # Open Graph metadata with the og: prefix removed and keys camel-cased. + sig do + returns( + T.nilable( + T::Hash[ + Symbol, + BrandDev::Models::BrandWebScrapeHTMLResponse::Metadata::OpenGraph::Variants + ] + ) + ) + end + attr_reader :open_graph + + sig do + params( + open_graph: + T::Hash[ + Symbol, + BrandDev::Models::BrandWebScrapeHTMLResponse::Metadata::OpenGraph::Variants + ] + ).void + end + attr_writer :open_graph + + # Published timestamp/date from page metadata, when present. + sig { returns(T.nilable(String)) } + attr_reader :published_time + + sig { params(published_time: String).void } + attr_writer :published_time + + # Robots meta directive, when present. + sig { returns(T.nilable(String)) } + attr_reader :robots + + sig { params(robots: String).void } + attr_writer :robots + + # Site or application name from page metadata. + sig { returns(T.nilable(String)) } + attr_reader :site_name + + sig { params(site_name: String).void } + attr_writer :site_name + + # Best title extracted from the page. + sig { returns(T.nilable(String)) } + attr_reader :title + + sig { params(title: String).void } + attr_writer :title + + # Twitter card metadata with the twitter: prefix removed and keys camel-cased. + sig do + returns( + T.nilable( + T::Hash[ + Symbol, + BrandDev::Models::BrandWebScrapeHTMLResponse::Metadata::Twitter::Variants + ] + ) + ) + end + attr_reader :twitter + + sig do + params( + twitter: + T::Hash[ + Symbol, + BrandDev::Models::BrandWebScrapeHTMLResponse::Metadata::Twitter::Variants + ] + ).void + end + attr_writer :twitter + + # Metadata extracted from the scraped page HTML. + sig do + params( + final_url: String, + source_url: String, + additional_meta: + T::Hash[ + Symbol, + BrandDev::Models::BrandWebScrapeHTMLResponse::Metadata::AdditionalMeta::Variants + ], + alternates: + T::Array[ + BrandDev::Models::BrandWebScrapeHTMLResponse::Metadata::Alternate::OrHash + ], + author: String, + canonical_url: String, + description: String, + favicon: String, + image: String, + json_ld: T::Array[T::Hash[Symbol, T.anything]], + keywords: T::Array[String], + language: String, + modified_time: String, + open_graph: + T::Hash[ + Symbol, + BrandDev::Models::BrandWebScrapeHTMLResponse::Metadata::OpenGraph::Variants + ], + published_time: String, + robots: String, + site_name: String, + title: String, + twitter: + T::Hash[ + Symbol, + BrandDev::Models::BrandWebScrapeHTMLResponse::Metadata::Twitter::Variants + ] + ).returns(T.attached_class) + end + def self.new( + # Final URL scraped after redirects or scraper fallback, when known. Falls back to + # sourceUrl when unavailable. + final_url:, + # Original URL requested by the caller. + source_url:, + # Additional non-social meta tags not promoted to top-level metadata fields. + additional_meta: nil, + # Resolved alternate links from link rel=alternate tags. + alternates: nil, + # Author metadata, when present. + author: nil, + # Resolved canonical URL, when present. + canonical_url: nil, + # Best description extracted from standard, Open Graph, or Twitter metadata. + description: nil, + # Resolved favicon URL, when present. + favicon: nil, + # Primary resolved preview image from Open Graph, Twitter, or image metadata. + image: nil, + # JSON-LD structured data blocks parsed from the page. + json_ld: nil, + # Keywords extracted from the page's keywords meta tag. + keywords: nil, + # Language extracted from html lang or language meta tags. + language: nil, + # Modified timestamp/date from page metadata, when present. + modified_time: nil, + # Open Graph metadata with the og: prefix removed and keys camel-cased. + open_graph: nil, + # Published timestamp/date from page metadata, when present. + published_time: nil, + # Robots meta directive, when present. + robots: nil, + # Site or application name from page metadata. + site_name: nil, + # Best title extracted from the page. + title: nil, + # Twitter card metadata with the twitter: prefix removed and keys camel-cased. + twitter: nil + ) + end + + sig do + override.returns( + { + final_url: String, + source_url: String, + additional_meta: + T::Hash[ + Symbol, + BrandDev::Models::BrandWebScrapeHTMLResponse::Metadata::AdditionalMeta::Variants + ], + alternates: + T::Array[ + BrandDev::Models::BrandWebScrapeHTMLResponse::Metadata::Alternate + ], + author: String, + canonical_url: String, + description: String, + favicon: String, + image: String, + json_ld: T::Array[T::Hash[Symbol, T.anything]], + keywords: T::Array[String], + language: String, + modified_time: String, + open_graph: + T::Hash[ + Symbol, + BrandDev::Models::BrandWebScrapeHTMLResponse::Metadata::OpenGraph::Variants + ], + published_time: String, + robots: String, + site_name: String, + title: String, + twitter: + T::Hash[ + Symbol, + BrandDev::Models::BrandWebScrapeHTMLResponse::Metadata::Twitter::Variants + ] + } + ) + end + def to_hash + end + + module AdditionalMeta + extend BrandDev::Internal::Type::Union + + Variants = T.type_alias { T.any(String, T::Array[String]) } + + sig do + override.returns( + T::Array[ + BrandDev::Models::BrandWebScrapeHTMLResponse::Metadata::AdditionalMeta::Variants + ] + ) + end + def self.variants + end + + StringArray = + T.let( + BrandDev::Internal::Type::ArrayOf[String], + BrandDev::Internal::Type::Converter + ) + end + + class Alternate < BrandDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + BrandDev::Models::BrandWebScrapeHTMLResponse::Metadata::Alternate, + BrandDev::Internal::AnyHash + ) + end + + # Resolved alternate URL. + sig { returns(String) } + attr_accessor :href + + # Language or locale for the alternate URL, when present. + sig { returns(T.nilable(String)) } + attr_reader :hreflang + + sig { params(hreflang: String).void } + attr_writer :hreflang + + # Alternate resource title, when present. + sig { returns(T.nilable(String)) } + attr_reader :title + + sig { params(title: String).void } + attr_writer :title + + # Alternate resource MIME type, when present. + sig { returns(T.nilable(String)) } + attr_reader :type + + sig { params(type: String).void } + attr_writer :type + + sig do + params( + href: String, + hreflang: String, + title: String, + type: String + ).returns(T.attached_class) + end + def self.new( + # Resolved alternate URL. + href:, + # Language or locale for the alternate URL, when present. + hreflang: nil, + # Alternate resource title, when present. + title: nil, + # Alternate resource MIME type, when present. + type: nil + ) + end + + sig do + override.returns( + { href: String, hreflang: String, title: String, type: String } + ) + end + def to_hash + end + end + + module OpenGraph + extend BrandDev::Internal::Type::Union + + Variants = T.type_alias { T.any(String, T::Array[String]) } + + sig do + override.returns( + T::Array[ + BrandDev::Models::BrandWebScrapeHTMLResponse::Metadata::OpenGraph::Variants + ] + ) + end + def self.variants + end + + StringArray = + T.let( + BrandDev::Internal::Type::ArrayOf[String], + BrandDev::Internal::Type::Converter + ) + end + + module Twitter + extend BrandDev::Internal::Type::Union + + Variants = T.type_alias { T.any(String, T::Array[String]) } + + sig do + override.returns( + T::Array[ + BrandDev::Models::BrandWebScrapeHTMLResponse::Metadata::Twitter::Variants + ] + ) + end + def self.variants + end + + StringArray = + T.let( + BrandDev::Internal::Type::ArrayOf[String], + BrandDev::Internal::Type::Converter + ) + end + end + # Indicates success module Success extend BrandDev::Internal::Type::Enum diff --git a/rbi/brand_dev/models/brand_web_scrape_md_response.rbi b/rbi/brand_dev/models/brand_web_scrape_md_response.rbi index 647912a..64b1f16 100644 --- a/rbi/brand_dev/models/brand_web_scrape_md_response.rbi +++ b/rbi/brand_dev/models/brand_web_scrape_md_response.rbi @@ -15,6 +15,17 @@ module BrandDev sig { returns(String) } attr_accessor :markdown + # Metadata extracted from the scraped page HTML. + sig { returns(BrandDev::Models::BrandWebScrapeMdResponse::Metadata) } + attr_reader :metadata + + sig do + params( + metadata: BrandDev::Models::BrandWebScrapeMdResponse::Metadata::OrHash + ).void + end + attr_writer :metadata + # Indicates success sig do returns( @@ -47,6 +58,8 @@ module BrandDev sig do params( markdown: String, + metadata: + BrandDev::Models::BrandWebScrapeMdResponse::Metadata::OrHash, success: BrandDev::Models::BrandWebScrapeMdResponse::Success::OrBoolean, url: String, @@ -57,6 +70,8 @@ module BrandDev def self.new( # Page content converted to GitHub Flavored Markdown markdown:, + # Metadata extracted from the scraped page HTML. + metadata:, # Indicates success success:, # The URL that was scraped @@ -71,6 +86,7 @@ module BrandDev override.returns( { markdown: String, + metadata: BrandDev::Models::BrandWebScrapeMdResponse::Metadata, success: BrandDev::Models::BrandWebScrapeMdResponse::Success::TaggedBoolean, url: String, @@ -82,6 +98,464 @@ module BrandDev def to_hash end + class Metadata < BrandDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + BrandDev::Models::BrandWebScrapeMdResponse::Metadata, + BrandDev::Internal::AnyHash + ) + end + + # Final URL scraped after redirects or scraper fallback, when known. Falls back to + # sourceUrl when unavailable. + sig { returns(String) } + attr_accessor :final_url + + # Original URL requested by the caller. + sig { returns(String) } + attr_accessor :source_url + + # Additional non-social meta tags not promoted to top-level metadata fields. + sig do + returns( + T.nilable( + T::Hash[ + Symbol, + BrandDev::Models::BrandWebScrapeMdResponse::Metadata::AdditionalMeta::Variants + ] + ) + ) + end + attr_reader :additional_meta + + sig do + params( + additional_meta: + T::Hash[ + Symbol, + BrandDev::Models::BrandWebScrapeMdResponse::Metadata::AdditionalMeta::Variants + ] + ).void + end + attr_writer :additional_meta + + # Resolved alternate links from link rel=alternate tags. + sig do + returns( + T.nilable( + T::Array[ + BrandDev::Models::BrandWebScrapeMdResponse::Metadata::Alternate + ] + ) + ) + end + attr_reader :alternates + + sig do + params( + alternates: + T::Array[ + BrandDev::Models::BrandWebScrapeMdResponse::Metadata::Alternate::OrHash + ] + ).void + end + attr_writer :alternates + + # Author metadata, when present. + sig { returns(T.nilable(String)) } + attr_reader :author + + sig { params(author: String).void } + attr_writer :author + + # Resolved canonical URL, when present. + sig { returns(T.nilable(String)) } + attr_reader :canonical_url + + sig { params(canonical_url: String).void } + attr_writer :canonical_url + + # Best description extracted from standard, Open Graph, or Twitter metadata. + sig { returns(T.nilable(String)) } + attr_reader :description + + sig { params(description: String).void } + attr_writer :description + + # Resolved favicon URL, when present. + sig { returns(T.nilable(String)) } + attr_reader :favicon + + sig { params(favicon: String).void } + attr_writer :favicon + + # Primary resolved preview image from Open Graph, Twitter, or image metadata. + sig { returns(T.nilable(String)) } + attr_reader :image + + sig { params(image: String).void } + attr_writer :image + + # JSON-LD structured data blocks parsed from the page. + sig { returns(T.nilable(T::Array[T::Hash[Symbol, T.anything]])) } + attr_reader :json_ld + + sig { params(json_ld: T::Array[T::Hash[Symbol, T.anything]]).void } + attr_writer :json_ld + + # Keywords extracted from the page's keywords meta tag. + sig { returns(T.nilable(T::Array[String])) } + attr_reader :keywords + + sig { params(keywords: T::Array[String]).void } + attr_writer :keywords + + # Language extracted from html lang or language meta tags. + sig { returns(T.nilable(String)) } + attr_reader :language + + sig { params(language: String).void } + attr_writer :language + + # Modified timestamp/date from page metadata, when present. + sig { returns(T.nilable(String)) } + attr_reader :modified_time + + sig { params(modified_time: String).void } + attr_writer :modified_time + + # Open Graph metadata with the og: prefix removed and keys camel-cased. + sig do + returns( + T.nilable( + T::Hash[ + Symbol, + BrandDev::Models::BrandWebScrapeMdResponse::Metadata::OpenGraph::Variants + ] + ) + ) + end + attr_reader :open_graph + + sig do + params( + open_graph: + T::Hash[ + Symbol, + BrandDev::Models::BrandWebScrapeMdResponse::Metadata::OpenGraph::Variants + ] + ).void + end + attr_writer :open_graph + + # Published timestamp/date from page metadata, when present. + sig { returns(T.nilable(String)) } + attr_reader :published_time + + sig { params(published_time: String).void } + attr_writer :published_time + + # Robots meta directive, when present. + sig { returns(T.nilable(String)) } + attr_reader :robots + + sig { params(robots: String).void } + attr_writer :robots + + # Site or application name from page metadata. + sig { returns(T.nilable(String)) } + attr_reader :site_name + + sig { params(site_name: String).void } + attr_writer :site_name + + # Best title extracted from the page. + sig { returns(T.nilable(String)) } + attr_reader :title + + sig { params(title: String).void } + attr_writer :title + + # Twitter card metadata with the twitter: prefix removed and keys camel-cased. + sig do + returns( + T.nilable( + T::Hash[ + Symbol, + BrandDev::Models::BrandWebScrapeMdResponse::Metadata::Twitter::Variants + ] + ) + ) + end + attr_reader :twitter + + sig do + params( + twitter: + T::Hash[ + Symbol, + BrandDev::Models::BrandWebScrapeMdResponse::Metadata::Twitter::Variants + ] + ).void + end + attr_writer :twitter + + # Metadata extracted from the scraped page HTML. + sig do + params( + final_url: String, + source_url: String, + additional_meta: + T::Hash[ + Symbol, + BrandDev::Models::BrandWebScrapeMdResponse::Metadata::AdditionalMeta::Variants + ], + alternates: + T::Array[ + BrandDev::Models::BrandWebScrapeMdResponse::Metadata::Alternate::OrHash + ], + author: String, + canonical_url: String, + description: String, + favicon: String, + image: String, + json_ld: T::Array[T::Hash[Symbol, T.anything]], + keywords: T::Array[String], + language: String, + modified_time: String, + open_graph: + T::Hash[ + Symbol, + BrandDev::Models::BrandWebScrapeMdResponse::Metadata::OpenGraph::Variants + ], + published_time: String, + robots: String, + site_name: String, + title: String, + twitter: + T::Hash[ + Symbol, + BrandDev::Models::BrandWebScrapeMdResponse::Metadata::Twitter::Variants + ] + ).returns(T.attached_class) + end + def self.new( + # Final URL scraped after redirects or scraper fallback, when known. Falls back to + # sourceUrl when unavailable. + final_url:, + # Original URL requested by the caller. + source_url:, + # Additional non-social meta tags not promoted to top-level metadata fields. + additional_meta: nil, + # Resolved alternate links from link rel=alternate tags. + alternates: nil, + # Author metadata, when present. + author: nil, + # Resolved canonical URL, when present. + canonical_url: nil, + # Best description extracted from standard, Open Graph, or Twitter metadata. + description: nil, + # Resolved favicon URL, when present. + favicon: nil, + # Primary resolved preview image from Open Graph, Twitter, or image metadata. + image: nil, + # JSON-LD structured data blocks parsed from the page. + json_ld: nil, + # Keywords extracted from the page's keywords meta tag. + keywords: nil, + # Language extracted from html lang or language meta tags. + language: nil, + # Modified timestamp/date from page metadata, when present. + modified_time: nil, + # Open Graph metadata with the og: prefix removed and keys camel-cased. + open_graph: nil, + # Published timestamp/date from page metadata, when present. + published_time: nil, + # Robots meta directive, when present. + robots: nil, + # Site or application name from page metadata. + site_name: nil, + # Best title extracted from the page. + title: nil, + # Twitter card metadata with the twitter: prefix removed and keys camel-cased. + twitter: nil + ) + end + + sig do + override.returns( + { + final_url: String, + source_url: String, + additional_meta: + T::Hash[ + Symbol, + BrandDev::Models::BrandWebScrapeMdResponse::Metadata::AdditionalMeta::Variants + ], + alternates: + T::Array[ + BrandDev::Models::BrandWebScrapeMdResponse::Metadata::Alternate + ], + author: String, + canonical_url: String, + description: String, + favicon: String, + image: String, + json_ld: T::Array[T::Hash[Symbol, T.anything]], + keywords: T::Array[String], + language: String, + modified_time: String, + open_graph: + T::Hash[ + Symbol, + BrandDev::Models::BrandWebScrapeMdResponse::Metadata::OpenGraph::Variants + ], + published_time: String, + robots: String, + site_name: String, + title: String, + twitter: + T::Hash[ + Symbol, + BrandDev::Models::BrandWebScrapeMdResponse::Metadata::Twitter::Variants + ] + } + ) + end + def to_hash + end + + module AdditionalMeta + extend BrandDev::Internal::Type::Union + + Variants = T.type_alias { T.any(String, T::Array[String]) } + + sig do + override.returns( + T::Array[ + BrandDev::Models::BrandWebScrapeMdResponse::Metadata::AdditionalMeta::Variants + ] + ) + end + def self.variants + end + + StringArray = + T.let( + BrandDev::Internal::Type::ArrayOf[String], + BrandDev::Internal::Type::Converter + ) + end + + class Alternate < BrandDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + BrandDev::Models::BrandWebScrapeMdResponse::Metadata::Alternate, + BrandDev::Internal::AnyHash + ) + end + + # Resolved alternate URL. + sig { returns(String) } + attr_accessor :href + + # Language or locale for the alternate URL, when present. + sig { returns(T.nilable(String)) } + attr_reader :hreflang + + sig { params(hreflang: String).void } + attr_writer :hreflang + + # Alternate resource title, when present. + sig { returns(T.nilable(String)) } + attr_reader :title + + sig { params(title: String).void } + attr_writer :title + + # Alternate resource MIME type, when present. + sig { returns(T.nilable(String)) } + attr_reader :type + + sig { params(type: String).void } + attr_writer :type + + sig do + params( + href: String, + hreflang: String, + title: String, + type: String + ).returns(T.attached_class) + end + def self.new( + # Resolved alternate URL. + href:, + # Language or locale for the alternate URL, when present. + hreflang: nil, + # Alternate resource title, when present. + title: nil, + # Alternate resource MIME type, when present. + type: nil + ) + end + + sig do + override.returns( + { href: String, hreflang: String, title: String, type: String } + ) + end + def to_hash + end + end + + module OpenGraph + extend BrandDev::Internal::Type::Union + + Variants = T.type_alias { T.any(String, T::Array[String]) } + + sig do + override.returns( + T::Array[ + BrandDev::Models::BrandWebScrapeMdResponse::Metadata::OpenGraph::Variants + ] + ) + end + def self.variants + end + + StringArray = + T.let( + BrandDev::Internal::Type::ArrayOf[String], + BrandDev::Internal::Type::Converter + ) + end + + module Twitter + extend BrandDev::Internal::Type::Union + + Variants = T.type_alias { T.any(String, T::Array[String]) } + + sig do + override.returns( + T::Array[ + BrandDev::Models::BrandWebScrapeMdResponse::Metadata::Twitter::Variants + ] + ) + end + def self.variants + end + + StringArray = + T.let( + BrandDev::Internal::Type::ArrayOf[String], + BrandDev::Internal::Type::Converter + ) + end + end + # Indicates success module Success extend BrandDev::Internal::Type::Enum diff --git a/sig/brand_dev/models/brand_web_scrape_html_response.rbs b/sig/brand_dev/models/brand_web_scrape_html_response.rbs index 8421893..572015b 100644 --- a/sig/brand_dev/models/brand_web_scrape_html_response.rbs +++ b/sig/brand_dev/models/brand_web_scrape_html_response.rbs @@ -3,6 +3,7 @@ module BrandDev type brand_web_scrape_html_response = { html: String, + metadata: BrandDev::Models::BrandWebScrapeHTMLResponse::Metadata, success: BrandDev::Models::BrandWebScrapeHTMLResponse::success, type: BrandDev::Models::BrandWebScrapeHTMLResponse::type_, url: String, @@ -12,6 +13,8 @@ module BrandDev class BrandWebScrapeHTMLResponse < BrandDev::Internal::Type::BaseModel attr_accessor html: String + attr_accessor metadata: BrandDev::Models::BrandWebScrapeHTMLResponse::Metadata + attr_accessor success: BrandDev::Models::BrandWebScrapeHTMLResponse::success attr_accessor type: BrandDev::Models::BrandWebScrapeHTMLResponse::type_ @@ -26,6 +29,7 @@ module BrandDev def initialize: ( html: String, + metadata: BrandDev::Models::BrandWebScrapeHTMLResponse::Metadata, success: BrandDev::Models::BrandWebScrapeHTMLResponse::success, type: BrandDev::Models::BrandWebScrapeHTMLResponse::type_, url: String, @@ -34,12 +38,227 @@ module BrandDev def to_hash: -> { html: String, + metadata: BrandDev::Models::BrandWebScrapeHTMLResponse::Metadata, success: BrandDev::Models::BrandWebScrapeHTMLResponse::success, type: BrandDev::Models::BrandWebScrapeHTMLResponse::type_, url: String, key_metadata: BrandDev::Models::BrandWebScrapeHTMLResponse::KeyMetadata } + type metadata = + { + final_url: String, + source_url: String, + additional_meta: ::Hash[Symbol, BrandDev::Models::BrandWebScrapeHTMLResponse::Metadata::additional_meta], + alternates: ::Array[BrandDev::Models::BrandWebScrapeHTMLResponse::Metadata::Alternate], + author: String, + canonical_url: String, + description: String, + favicon: String, + image: String, + json_ld: ::Array[::Hash[Symbol, top]], + keywords: ::Array[String], + language: String, + modified_time: String, + open_graph: ::Hash[Symbol, BrandDev::Models::BrandWebScrapeHTMLResponse::Metadata::open_graph], + published_time: String, + robots: String, + site_name: String, + title: String, + twitter: ::Hash[Symbol, BrandDev::Models::BrandWebScrapeHTMLResponse::Metadata::twitter] + } + + class Metadata < BrandDev::Internal::Type::BaseModel + attr_accessor final_url: String + + attr_accessor source_url: String + + attr_reader additional_meta: ::Hash[Symbol, BrandDev::Models::BrandWebScrapeHTMLResponse::Metadata::additional_meta]? + + def additional_meta=: ( + ::Hash[Symbol, BrandDev::Models::BrandWebScrapeHTMLResponse::Metadata::additional_meta] + ) -> ::Hash[Symbol, BrandDev::Models::BrandWebScrapeHTMLResponse::Metadata::additional_meta] + + attr_reader alternates: ::Array[BrandDev::Models::BrandWebScrapeHTMLResponse::Metadata::Alternate]? + + def alternates=: ( + ::Array[BrandDev::Models::BrandWebScrapeHTMLResponse::Metadata::Alternate] + ) -> ::Array[BrandDev::Models::BrandWebScrapeHTMLResponse::Metadata::Alternate] + + attr_reader author: String? + + def author=: (String) -> String + + attr_reader canonical_url: String? + + def canonical_url=: (String) -> String + + attr_reader description: String? + + def description=: (String) -> String + + attr_reader favicon: String? + + def favicon=: (String) -> String + + attr_reader image: String? + + def image=: (String) -> String + + attr_reader json_ld: ::Array[::Hash[Symbol, top]]? + + def json_ld=: ( + ::Array[::Hash[Symbol, top]] + ) -> ::Array[::Hash[Symbol, top]] + + attr_reader keywords: ::Array[String]? + + def keywords=: (::Array[String]) -> ::Array[String] + + attr_reader language: String? + + def language=: (String) -> String + + attr_reader modified_time: String? + + def modified_time=: (String) -> String + + attr_reader open_graph: ::Hash[Symbol, BrandDev::Models::BrandWebScrapeHTMLResponse::Metadata::open_graph]? + + def open_graph=: ( + ::Hash[Symbol, BrandDev::Models::BrandWebScrapeHTMLResponse::Metadata::open_graph] + ) -> ::Hash[Symbol, BrandDev::Models::BrandWebScrapeHTMLResponse::Metadata::open_graph] + + attr_reader published_time: String? + + def published_time=: (String) -> String + + attr_reader robots: String? + + def robots=: (String) -> String + + attr_reader site_name: String? + + def site_name=: (String) -> String + + attr_reader title: String? + + def title=: (String) -> String + + attr_reader twitter: ::Hash[Symbol, BrandDev::Models::BrandWebScrapeHTMLResponse::Metadata::twitter]? + + def twitter=: ( + ::Hash[Symbol, BrandDev::Models::BrandWebScrapeHTMLResponse::Metadata::twitter] + ) -> ::Hash[Symbol, BrandDev::Models::BrandWebScrapeHTMLResponse::Metadata::twitter] + + def initialize: ( + final_url: String, + source_url: String, + ?additional_meta: ::Hash[Symbol, BrandDev::Models::BrandWebScrapeHTMLResponse::Metadata::additional_meta], + ?alternates: ::Array[BrandDev::Models::BrandWebScrapeHTMLResponse::Metadata::Alternate], + ?author: String, + ?canonical_url: String, + ?description: String, + ?favicon: String, + ?image: String, + ?json_ld: ::Array[::Hash[Symbol, top]], + ?keywords: ::Array[String], + ?language: String, + ?modified_time: String, + ?open_graph: ::Hash[Symbol, BrandDev::Models::BrandWebScrapeHTMLResponse::Metadata::open_graph], + ?published_time: String, + ?robots: String, + ?site_name: String, + ?title: String, + ?twitter: ::Hash[Symbol, BrandDev::Models::BrandWebScrapeHTMLResponse::Metadata::twitter] + ) -> void + + def to_hash: -> { + final_url: String, + source_url: String, + additional_meta: ::Hash[Symbol, BrandDev::Models::BrandWebScrapeHTMLResponse::Metadata::additional_meta], + alternates: ::Array[BrandDev::Models::BrandWebScrapeHTMLResponse::Metadata::Alternate], + author: String, + canonical_url: String, + description: String, + favicon: String, + image: String, + json_ld: ::Array[::Hash[Symbol, top]], + keywords: ::Array[String], + language: String, + modified_time: String, + open_graph: ::Hash[Symbol, BrandDev::Models::BrandWebScrapeHTMLResponse::Metadata::open_graph], + published_time: String, + robots: String, + site_name: String, + title: String, + twitter: ::Hash[Symbol, BrandDev::Models::BrandWebScrapeHTMLResponse::Metadata::twitter] + } + + type additional_meta = String | ::Array[String] + + module AdditionalMeta + extend BrandDev::Internal::Type::Union + + def self?.variants: -> ::Array[BrandDev::Models::BrandWebScrapeHTMLResponse::Metadata::additional_meta] + + StringArray: BrandDev::Internal::Type::Converter + end + + type alternate = + { href: String, hreflang: String, title: String, type: String } + + class Alternate < BrandDev::Internal::Type::BaseModel + attr_accessor href: String + + attr_reader hreflang: String? + + def hreflang=: (String) -> String + + attr_reader title: String? + + def title=: (String) -> String + + attr_reader type: String? + + def type=: (String) -> String + + def initialize: ( + href: String, + ?hreflang: String, + ?title: String, + ?type: String + ) -> void + + def to_hash: -> { + href: String, + hreflang: String, + title: String, + type: String + } + end + + type open_graph = String | ::Array[String] + + module OpenGraph + extend BrandDev::Internal::Type::Union + + def self?.variants: -> ::Array[BrandDev::Models::BrandWebScrapeHTMLResponse::Metadata::open_graph] + + StringArray: BrandDev::Internal::Type::Converter + end + + type twitter = String | ::Array[String] + + module Twitter + extend BrandDev::Internal::Type::Union + + def self?.variants: -> ::Array[BrandDev::Models::BrandWebScrapeHTMLResponse::Metadata::twitter] + + StringArray: BrandDev::Internal::Type::Converter + end + end + type success = true module Success diff --git a/sig/brand_dev/models/brand_web_scrape_md_response.rbs b/sig/brand_dev/models/brand_web_scrape_md_response.rbs index 1f17332..01aaf8a 100644 --- a/sig/brand_dev/models/brand_web_scrape_md_response.rbs +++ b/sig/brand_dev/models/brand_web_scrape_md_response.rbs @@ -3,6 +3,7 @@ module BrandDev type brand_web_scrape_md_response = { markdown: String, + metadata: BrandDev::Models::BrandWebScrapeMdResponse::Metadata, success: BrandDev::Models::BrandWebScrapeMdResponse::success, url: String, key_metadata: BrandDev::Models::BrandWebScrapeMdResponse::KeyMetadata @@ -11,6 +12,8 @@ module BrandDev class BrandWebScrapeMdResponse < BrandDev::Internal::Type::BaseModel attr_accessor markdown: String + attr_accessor metadata: BrandDev::Models::BrandWebScrapeMdResponse::Metadata + attr_accessor success: BrandDev::Models::BrandWebScrapeMdResponse::success attr_accessor url: String @@ -23,6 +26,7 @@ module BrandDev def initialize: ( markdown: String, + metadata: BrandDev::Models::BrandWebScrapeMdResponse::Metadata, success: BrandDev::Models::BrandWebScrapeMdResponse::success, url: String, ?key_metadata: BrandDev::Models::BrandWebScrapeMdResponse::KeyMetadata @@ -30,11 +34,226 @@ module BrandDev def to_hash: -> { markdown: String, + metadata: BrandDev::Models::BrandWebScrapeMdResponse::Metadata, success: BrandDev::Models::BrandWebScrapeMdResponse::success, url: String, key_metadata: BrandDev::Models::BrandWebScrapeMdResponse::KeyMetadata } + type metadata = + { + final_url: String, + source_url: String, + additional_meta: ::Hash[Symbol, BrandDev::Models::BrandWebScrapeMdResponse::Metadata::additional_meta], + alternates: ::Array[BrandDev::Models::BrandWebScrapeMdResponse::Metadata::Alternate], + author: String, + canonical_url: String, + description: String, + favicon: String, + image: String, + json_ld: ::Array[::Hash[Symbol, top]], + keywords: ::Array[String], + language: String, + modified_time: String, + open_graph: ::Hash[Symbol, BrandDev::Models::BrandWebScrapeMdResponse::Metadata::open_graph], + published_time: String, + robots: String, + site_name: String, + title: String, + twitter: ::Hash[Symbol, BrandDev::Models::BrandWebScrapeMdResponse::Metadata::twitter] + } + + class Metadata < BrandDev::Internal::Type::BaseModel + attr_accessor final_url: String + + attr_accessor source_url: String + + attr_reader additional_meta: ::Hash[Symbol, BrandDev::Models::BrandWebScrapeMdResponse::Metadata::additional_meta]? + + def additional_meta=: ( + ::Hash[Symbol, BrandDev::Models::BrandWebScrapeMdResponse::Metadata::additional_meta] + ) -> ::Hash[Symbol, BrandDev::Models::BrandWebScrapeMdResponse::Metadata::additional_meta] + + attr_reader alternates: ::Array[BrandDev::Models::BrandWebScrapeMdResponse::Metadata::Alternate]? + + def alternates=: ( + ::Array[BrandDev::Models::BrandWebScrapeMdResponse::Metadata::Alternate] + ) -> ::Array[BrandDev::Models::BrandWebScrapeMdResponse::Metadata::Alternate] + + attr_reader author: String? + + def author=: (String) -> String + + attr_reader canonical_url: String? + + def canonical_url=: (String) -> String + + attr_reader description: String? + + def description=: (String) -> String + + attr_reader favicon: String? + + def favicon=: (String) -> String + + attr_reader image: String? + + def image=: (String) -> String + + attr_reader json_ld: ::Array[::Hash[Symbol, top]]? + + def json_ld=: ( + ::Array[::Hash[Symbol, top]] + ) -> ::Array[::Hash[Symbol, top]] + + attr_reader keywords: ::Array[String]? + + def keywords=: (::Array[String]) -> ::Array[String] + + attr_reader language: String? + + def language=: (String) -> String + + attr_reader modified_time: String? + + def modified_time=: (String) -> String + + attr_reader open_graph: ::Hash[Symbol, BrandDev::Models::BrandWebScrapeMdResponse::Metadata::open_graph]? + + def open_graph=: ( + ::Hash[Symbol, BrandDev::Models::BrandWebScrapeMdResponse::Metadata::open_graph] + ) -> ::Hash[Symbol, BrandDev::Models::BrandWebScrapeMdResponse::Metadata::open_graph] + + attr_reader published_time: String? + + def published_time=: (String) -> String + + attr_reader robots: String? + + def robots=: (String) -> String + + attr_reader site_name: String? + + def site_name=: (String) -> String + + attr_reader title: String? + + def title=: (String) -> String + + attr_reader twitter: ::Hash[Symbol, BrandDev::Models::BrandWebScrapeMdResponse::Metadata::twitter]? + + def twitter=: ( + ::Hash[Symbol, BrandDev::Models::BrandWebScrapeMdResponse::Metadata::twitter] + ) -> ::Hash[Symbol, BrandDev::Models::BrandWebScrapeMdResponse::Metadata::twitter] + + def initialize: ( + final_url: String, + source_url: String, + ?additional_meta: ::Hash[Symbol, BrandDev::Models::BrandWebScrapeMdResponse::Metadata::additional_meta], + ?alternates: ::Array[BrandDev::Models::BrandWebScrapeMdResponse::Metadata::Alternate], + ?author: String, + ?canonical_url: String, + ?description: String, + ?favicon: String, + ?image: String, + ?json_ld: ::Array[::Hash[Symbol, top]], + ?keywords: ::Array[String], + ?language: String, + ?modified_time: String, + ?open_graph: ::Hash[Symbol, BrandDev::Models::BrandWebScrapeMdResponse::Metadata::open_graph], + ?published_time: String, + ?robots: String, + ?site_name: String, + ?title: String, + ?twitter: ::Hash[Symbol, BrandDev::Models::BrandWebScrapeMdResponse::Metadata::twitter] + ) -> void + + def to_hash: -> { + final_url: String, + source_url: String, + additional_meta: ::Hash[Symbol, BrandDev::Models::BrandWebScrapeMdResponse::Metadata::additional_meta], + alternates: ::Array[BrandDev::Models::BrandWebScrapeMdResponse::Metadata::Alternate], + author: String, + canonical_url: String, + description: String, + favicon: String, + image: String, + json_ld: ::Array[::Hash[Symbol, top]], + keywords: ::Array[String], + language: String, + modified_time: String, + open_graph: ::Hash[Symbol, BrandDev::Models::BrandWebScrapeMdResponse::Metadata::open_graph], + published_time: String, + robots: String, + site_name: String, + title: String, + twitter: ::Hash[Symbol, BrandDev::Models::BrandWebScrapeMdResponse::Metadata::twitter] + } + + type additional_meta = String | ::Array[String] + + module AdditionalMeta + extend BrandDev::Internal::Type::Union + + def self?.variants: -> ::Array[BrandDev::Models::BrandWebScrapeMdResponse::Metadata::additional_meta] + + StringArray: BrandDev::Internal::Type::Converter + end + + type alternate = + { href: String, hreflang: String, title: String, type: String } + + class Alternate < BrandDev::Internal::Type::BaseModel + attr_accessor href: String + + attr_reader hreflang: String? + + def hreflang=: (String) -> String + + attr_reader title: String? + + def title=: (String) -> String + + attr_reader type: String? + + def type=: (String) -> String + + def initialize: ( + href: String, + ?hreflang: String, + ?title: String, + ?type: String + ) -> void + + def to_hash: -> { + href: String, + hreflang: String, + title: String, + type: String + } + end + + type open_graph = String | ::Array[String] + + module OpenGraph + extend BrandDev::Internal::Type::Union + + def self?.variants: -> ::Array[BrandDev::Models::BrandWebScrapeMdResponse::Metadata::open_graph] + + StringArray: BrandDev::Internal::Type::Converter + end + + type twitter = String | ::Array[String] + + module Twitter + extend BrandDev::Internal::Type::Union + + def self?.variants: -> ::Array[BrandDev::Models::BrandWebScrapeMdResponse::Metadata::twitter] + + StringArray: BrandDev::Internal::Type::Converter + end + end + type success = true module Success diff --git a/test/brand_dev/resources/brand_test.rb b/test/brand_dev/resources/brand_test.rb index 29de43f..8607902 100644 --- a/test/brand_dev/resources/brand_test.rb +++ b/test/brand_dev/resources/brand_test.rb @@ -253,6 +253,7 @@ def test_web_scrape_html_required_params assert_pattern do response => { html: String, + metadata: BrandDev::Models::BrandWebScrapeHTMLResponse::Metadata, success: BrandDev::Models::BrandWebScrapeHTMLResponse::Success, type: BrandDev::Models::BrandWebScrapeHTMLResponse::Type, url: String, @@ -292,6 +293,7 @@ def test_web_scrape_md_required_params assert_pattern do response => { markdown: String, + metadata: BrandDev::Models::BrandWebScrapeMdResponse::Metadata, success: BrandDev::Models::BrandWebScrapeMdResponse::Success, url: String, key_metadata: BrandDev::Models::BrandWebScrapeMdResponse::KeyMetadata | nil From 7beed63c284a11ef91eb537f57a3532de73effcd Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 18 Jun 2026 23:50:36 +0000 Subject: [PATCH 79/82] codegen metadata --- .stats.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.stats.yml b/.stats.yml index 868ac28..addea7a 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 16 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-06023f50b1343cf31237929fe1dbbe0a8992e99eaf720daf333e190a483ca7ea.yml -openapi_spec_hash: 65b215730d00bd4ef3cd998df33b2de0 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-2e475f1afc64a3d78fe8472156f5be342e36f15f60b55cdab0dd382ebe81375d.yml +openapi_spec_hash: 906e55f0fe3cb5dd15ca30e8dc3a36a9 config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 From fa4b67da957d248a49a46faa58f07be5039aa3d7 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 19 Jun 2026 14:43:35 +0000 Subject: [PATCH 80/82] feat(api): api update --- .stats.yml | 4 ++-- .../models/brand_web_scrape_html_response.rb | 2 ++ .../models/brand_web_scrape_html_response.rbi | 10 ++++++++++ .../models/brand_web_scrape_html_response.rbs | 14 +++++++++++++- 4 files changed, 27 insertions(+), 3 deletions(-) diff --git a/.stats.yml b/.stats.yml index addea7a..8e6b1e3 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 16 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-2e475f1afc64a3d78fe8472156f5be342e36f15f60b55cdab0dd382ebe81375d.yml -openapi_spec_hash: 906e55f0fe3cb5dd15ca30e8dc3a36a9 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-82a6478e390d1dbed9d0ae2757952ae47a377218d3e3ad3440ffa525ac39d8e7.yml +openapi_spec_hash: b1bc219822a30b09ceb38d670107f5cf config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 diff --git a/lib/brand_dev/models/brand_web_scrape_html_response.rb b/lib/brand_dev/models/brand_web_scrape_html_response.rb index 3ba63bf..9b4aa88 100644 --- a/lib/brand_dev/models/brand_web_scrape_html_response.rb +++ b/lib/brand_dev/models/brand_web_scrape_html_response.rb @@ -334,6 +334,8 @@ module Type MARKDOWN = :markdown SVG = :svg PDF = :pdf + DOCX = :docx + DOC = :doc # @!method self.values # @return [Array] diff --git a/rbi/brand_dev/models/brand_web_scrape_html_response.rbi b/rbi/brand_dev/models/brand_web_scrape_html_response.rbi index ffcc98f..9eeabe3 100644 --- a/rbi/brand_dev/models/brand_web_scrape_html_response.rbi +++ b/rbi/brand_dev/models/brand_web_scrape_html_response.rbi @@ -657,6 +657,16 @@ module BrandDev :pdf, BrandDev::Models::BrandWebScrapeHTMLResponse::Type::TaggedSymbol ) + DOCX = + T.let( + :docx, + BrandDev::Models::BrandWebScrapeHTMLResponse::Type::TaggedSymbol + ) + DOC = + T.let( + :doc, + BrandDev::Models::BrandWebScrapeHTMLResponse::Type::TaggedSymbol + ) sig do override.returns( diff --git a/sig/brand_dev/models/brand_web_scrape_html_response.rbs b/sig/brand_dev/models/brand_web_scrape_html_response.rbs index 572015b..4ab51ea 100644 --- a/sig/brand_dev/models/brand_web_scrape_html_response.rbs +++ b/sig/brand_dev/models/brand_web_scrape_html_response.rbs @@ -269,7 +269,17 @@ module BrandDev def self?.values: -> ::Array[BrandDev::Models::BrandWebScrapeHTMLResponse::success] end - type type_ = :html | :xml | :json | :text | :csv | :markdown | :svg | :pdf + type type_ = + :html + | :xml + | :json + | :text + | :csv + | :markdown + | :svg + | :pdf + | :docx + | :doc module Type extend BrandDev::Internal::Type::Enum @@ -282,6 +292,8 @@ module BrandDev MARKDOWN: :markdown SVG: :svg PDF: :pdf + DOCX: :docx + DOC: :doc def self?.values: -> ::Array[BrandDev::Models::BrandWebScrapeHTMLResponse::type_] end From 41496ac926f3c114f15d13bd0d4598ba6c11533a Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 25 Jun 2026 08:44:15 +0000 Subject: [PATCH 81/82] codegen metadata --- .stats.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.stats.yml b/.stats.yml index 8e6b1e3..77bc30a 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 16 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-82a6478e390d1dbed9d0ae2757952ae47a377218d3e3ad3440ffa525ac39d8e7.yml -openapi_spec_hash: b1bc219822a30b09ceb38d670107f5cf +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev/brand.dev-099ed9515b0e036a1afc6a4fb6c5a5f768a78160df084ffb6dd546eb354fb526.yml +openapi_spec_hash: 0aa5154a5822db3536a5f76583b4de1f config_hash: 91cf2dcefb99c39eb9cd3e98e15d6011 From c09fcffa4268b07bbf4bdd6d3fd2c066c23524ac Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 25 Jun 2026 08:45:14 +0000 Subject: [PATCH 82/82] release: 1.3.0 --- .release-please-manifest.json | 2 +- CHANGELOG.md | 53 +++++++++++++++++++++++++++++++++++ Gemfile.lock | 2 +- README.md | 2 +- lib/brand_dev/version.rb | 2 +- 5 files changed, 57 insertions(+), 4 deletions(-) diff --git a/.release-please-manifest.json b/.release-please-manifest.json index d0ab664..2a8f4ff 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "1.2.0" + ".": "1.3.0" } \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index 38b8462..c9b24d1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,58 @@ # Changelog +## 1.3.0 (2026-06-25) + +Full Changelog: [v1.2.0...v1.3.0](https://github.com/context-dot-dev/deprecated-brand-ruby-sdk/compare/v1.2.0...v1.3.0) + +### Features + +* **api:** api update ([fa4b67d](https://github.com/context-dot-dev/deprecated-brand-ruby-sdk/commit/fa4b67da957d248a49a46faa58f07be5039aa3d7)) +* **api:** api update ([29df8d6](https://github.com/context-dot-dev/deprecated-brand-ruby-sdk/commit/29df8d63546e19deb48cd4e6f5c54b535beb85d8)) +* **api:** api update ([71269a9](https://github.com/context-dot-dev/deprecated-brand-ruby-sdk/commit/71269a9843e8a7d01f19f17889bc553c266d5a69)) +* **api:** api update ([20d96f3](https://github.com/context-dot-dev/deprecated-brand-ruby-sdk/commit/20d96f34c4016b3739a41020ad1e7cb00736c6a4)) +* **api:** api update ([54ad2b8](https://github.com/context-dot-dev/deprecated-brand-ruby-sdk/commit/54ad2b8833f19a4b11c23b1e3a6dad2bc7b194e4)) +* **api:** api update ([bab38c3](https://github.com/context-dot-dev/deprecated-brand-ruby-sdk/commit/bab38c3ae6ca2e10722028a4b85c980d1a8c4573)) +* **api:** api update ([f6a3cd4](https://github.com/context-dot-dev/deprecated-brand-ruby-sdk/commit/f6a3cd492f1f7e6d412fb34172809db980126423)) +* **api:** api update ([c7844bf](https://github.com/context-dot-dev/deprecated-brand-ruby-sdk/commit/c7844bf1d3c8b454fb0bee944920a15b0cb2b06c)) +* **api:** api update ([ab2ccb1](https://github.com/context-dot-dev/deprecated-brand-ruby-sdk/commit/ab2ccb17a6ba8b61840a59b1f3a7f3ccc5aa7ad6)) +* **api:** api update ([c1bebc5](https://github.com/context-dot-dev/deprecated-brand-ruby-sdk/commit/c1bebc54ac22374b4c12c074ff438fd14d05b0f9)) +* **api:** api update ([cd834b4](https://github.com/context-dot-dev/deprecated-brand-ruby-sdk/commit/cd834b4821c2107f10f92b8ee717daa63622ac42)) +* **api:** api update ([2a47d73](https://github.com/context-dot-dev/deprecated-brand-ruby-sdk/commit/2a47d733b2de2acd65d6bc262833f4474f76a48f)) +* **api:** api update ([d4ee671](https://github.com/context-dot-dev/deprecated-brand-ruby-sdk/commit/d4ee671db627d6d979533c4502acd93b86b74b7c)) +* **api:** api update ([2e93c17](https://github.com/context-dot-dev/deprecated-brand-ruby-sdk/commit/2e93c177a7e818df9de785ac89363cba814eaad8)) +* **api:** api update ([80e2d8b](https://github.com/context-dot-dev/deprecated-brand-ruby-sdk/commit/80e2d8b61925cb7a062423ea70613953d349201b)) +* **api:** api update ([3c1db2e](https://github.com/context-dot-dev/deprecated-brand-ruby-sdk/commit/3c1db2ecd33a5f92eaf9c37dab6ee7956a38f379)) +* **api:** api update ([283f267](https://github.com/context-dot-dev/deprecated-brand-ruby-sdk/commit/283f2676e5ef02cccf00ce078b38e63ccd9d3387)) +* **api:** api update ([ac2bf07](https://github.com/context-dot-dev/deprecated-brand-ruby-sdk/commit/ac2bf07be9f7b5a636016c3f2ec55ca48b5ae971)) +* **api:** api update ([82f99f7](https://github.com/context-dot-dev/deprecated-brand-ruby-sdk/commit/82f99f70cb3753d51c8d7befa710962a96b52f34)) +* **api:** api update ([53929a4](https://github.com/context-dot-dev/deprecated-brand-ruby-sdk/commit/53929a404ec27e40072dab7db319060ce9356fdf)) +* **api:** api update ([26aa262](https://github.com/context-dot-dev/deprecated-brand-ruby-sdk/commit/26aa262ffcd0e82c130a73f5bf4258a02d5d687d)) +* **api:** api update ([8f82145](https://github.com/context-dot-dev/deprecated-brand-ruby-sdk/commit/8f82145769a2d825ab755cf3a4a2e2f3db64c0ad)) +* **api:** api update ([93dcfee](https://github.com/context-dot-dev/deprecated-brand-ruby-sdk/commit/93dcfee9c2635974a204ae85d237c83845f5eb0d)) +* **api:** api update ([5129523](https://github.com/context-dot-dev/deprecated-brand-ruby-sdk/commit/5129523063458daca62963d01ff1837b54c9babf)) +* **api:** api update ([de2601f](https://github.com/context-dot-dev/deprecated-brand-ruby-sdk/commit/de2601f83745aa577c0c7629b4621e78218dbc1b)) +* **api:** api update ([7e9e3f5](https://github.com/context-dot-dev/deprecated-brand-ruby-sdk/commit/7e9e3f5012f1d11daef7795087699d3d8914ec0a)) +* **api:** api update ([51cf238](https://github.com/context-dot-dev/deprecated-brand-ruby-sdk/commit/51cf238020c1726eed5601387902175c0a911963)) +* **api:** api update ([d7243b6](https://github.com/context-dot-dev/deprecated-brand-ruby-sdk/commit/d7243b67c34ed41991ffbfd05c20c3fe91bf6b7a)) +* **api:** api update ([7dbc953](https://github.com/context-dot-dev/deprecated-brand-ruby-sdk/commit/7dbc953284d17ffdab94cc0cce1c1577bb5bb37d)) +* **api:** api update ([fdc7418](https://github.com/context-dot-dev/deprecated-brand-ruby-sdk/commit/fdc741818cf6202016e5b94278590f8d1aa44079)) +* **api:** api update ([3613e92](https://github.com/context-dot-dev/deprecated-brand-ruby-sdk/commit/3613e92029d5702a7b86753162c3dddda5ef88d2)) +* **api:** api update ([c523c67](https://github.com/context-dot-dev/deprecated-brand-ruby-sdk/commit/c523c67ab269e7b2c2d6f6f50d93960d1a14da09)) +* **api:** api update ([22d1e77](https://github.com/context-dot-dev/deprecated-brand-ruby-sdk/commit/22d1e77b4b4cfd0df257f1e8018187de16ea93a0)) +* **api:** api update ([f07badc](https://github.com/context-dot-dev/deprecated-brand-ruby-sdk/commit/f07badc8bf3ef80fe032793339c05cb1f74fe2c2)) +* support setting headers via env ([c5921ab](https://github.com/context-dot-dev/deprecated-brand-ruby-sdk/commit/c5921ab5e04c5a0cf08ca6673662f31fc4dcde80)) + + +### Bug Fixes + +* **client:** elide content type header on requests without body ([1b864c8](https://github.com/context-dot-dev/deprecated-brand-ruby-sdk/commit/1b864c845999011a26c433ddd801c050aed7a197)) +* multipart encoding for file arrays ([a4d91a7](https://github.com/context-dot-dev/deprecated-brand-ruby-sdk/commit/a4d91a72d7bb1a80f9d24c9914e744437eaecbb3)) + + +### Chores + +* **internal:** more robust bootstrap script ([67421f2](https://github.com/context-dot-dev/deprecated-brand-ruby-sdk/commit/67421f29c40507b6b9499d80e788914dcf3526b4)) + ## 1.2.0 (2026-04-03) Full Changelog: [v1.1.0...v1.2.0](https://github.com/context-dot-dev/deprecated-brand-ruby-sdk/compare/v1.1.0...v1.2.0) diff --git a/Gemfile.lock b/Gemfile.lock index da284c1..afeaf85 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -11,7 +11,7 @@ GIT PATH remote: . specs: - brand.dev (1.2.0) + brand.dev (1.3.0) cgi connection_pool diff --git a/README.md b/README.md index 98e040f..ba5fa6b 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ To use this gem, install via Bundler by adding the following to your application ```ruby -gem "brand.dev", "~> 1.2.0" +gem "brand.dev", "~> 1.3.0" ``` diff --git a/lib/brand_dev/version.rb b/lib/brand_dev/version.rb index d4aea6c..ff350c4 100644 --- a/lib/brand_dev/version.rb +++ b/lib/brand_dev/version.rb @@ -1,5 +1,5 @@ # frozen_string_literal: true module BrandDev - VERSION = "1.2.0" + VERSION = "1.3.0" end