context.dev 1.36.0 → 2.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (162) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +35 -0
  3. data/README.md +16 -9
  4. data/lib/context_dev/client.rb +7 -0
  5. data/lib/context_dev/models/brand_retrieve_params.rb +1079 -174
  6. data/lib/context_dev/models/monitor_create_params.rb +364 -0
  7. data/lib/context_dev/models/monitor_create_response.rb +608 -0
  8. data/lib/context_dev/models/monitor_delete_params.rb +20 -0
  9. data/lib/context_dev/models/monitor_delete_response.rb +22 -0
  10. data/lib/context_dev/models/monitor_list_account_changes_params.rb +93 -0
  11. data/lib/context_dev/models/monitor_list_account_changes_response.rb +199 -0
  12. data/lib/context_dev/models/monitor_list_account_runs_params.rb +55 -0
  13. data/lib/context_dev/models/monitor_list_account_runs_response.rb +227 -0
  14. data/lib/context_dev/models/monitor_list_changes_params.rb +57 -0
  15. data/lib/context_dev/models/monitor_list_changes_response.rb +198 -0
  16. data/lib/context_dev/models/monitor_list_params.rb +161 -0
  17. data/lib/context_dev/models/monitor_list_response.rb +631 -0
  18. data/lib/context_dev/models/monitor_list_runs_params.rb +62 -0
  19. data/lib/context_dev/models/monitor_list_runs_response.rb +227 -0
  20. data/lib/context_dev/models/monitor_retrieve_change_params.rb +20 -0
  21. data/lib/context_dev/models/monitor_retrieve_change_response.rb +264 -0
  22. data/lib/context_dev/models/monitor_retrieve_params.rb +20 -0
  23. data/lib/context_dev/models/monitor_retrieve_response.rb +608 -0
  24. data/lib/context_dev/models/monitor_run_params.rb +20 -0
  25. data/lib/context_dev/models/monitor_run_response.rb +35 -0
  26. data/lib/context_dev/models/monitor_update_params.rb +371 -0
  27. data/lib/context_dev/models/monitor_update_response.rb +608 -0
  28. data/lib/context_dev/models/utility_prefetch_params.rb +70 -6
  29. data/lib/context_dev/models/utility_prefetch_response.rb +23 -1
  30. data/lib/context_dev/models/web_extract_response.rb +17 -1
  31. data/lib/context_dev/models/web_web_crawl_md_params.rb +11 -1
  32. data/lib/context_dev/models/web_web_scrape_html_params.rb +11 -1
  33. data/lib/context_dev/models/web_web_scrape_html_response.rb +10 -2
  34. data/lib/context_dev/models/web_web_scrape_images_params.rb +12 -1
  35. data/lib/context_dev/models/web_web_scrape_md_params.rb +11 -1
  36. data/lib/context_dev/models.rb +20 -12
  37. data/lib/context_dev/resources/ai.rb +0 -33
  38. data/lib/context_dev/resources/brand.rb +9 -204
  39. data/lib/context_dev/resources/monitors.rb +352 -0
  40. data/lib/context_dev/resources/utility.rb +9 -35
  41. data/lib/context_dev/resources/web.rb +14 -4
  42. data/lib/context_dev/version.rb +1 -1
  43. data/lib/context_dev.rb +23 -14
  44. data/rbi/context_dev/client.rbi +6 -0
  45. data/rbi/context_dev/models/brand_retrieve_params.rbi +3858 -678
  46. data/rbi/context_dev/models/monitor_create_params.rbi +641 -0
  47. data/rbi/context_dev/models/monitor_create_response.rbi +1020 -0
  48. data/rbi/context_dev/models/monitor_delete_params.rbi +35 -0
  49. data/rbi/context_dev/models/monitor_delete_response.rbi +29 -0
  50. data/rbi/context_dev/models/monitor_list_account_changes_params.rbi +211 -0
  51. data/rbi/context_dev/models/monitor_list_account_changes_response.rbi +376 -0
  52. data/rbi/context_dev/models/monitor_list_account_runs_params.rbi +125 -0
  53. data/rbi/context_dev/models/monitor_list_account_runs_response.rbi +464 -0
  54. data/rbi/context_dev/models/monitor_list_changes_params.rbi +91 -0
  55. data/rbi/context_dev/models/monitor_list_changes_response.rbi +372 -0
  56. data/rbi/context_dev/models/monitor_list_params.rbi +335 -0
  57. data/rbi/context_dev/models/monitor_list_response.rbi +1089 -0
  58. data/rbi/context_dev/models/monitor_list_runs_params.rbi +125 -0
  59. data/rbi/context_dev/models/monitor_list_runs_response.rbi +455 -0
  60. data/rbi/context_dev/models/monitor_retrieve_change_params.rbi +38 -0
  61. data/rbi/context_dev/models/monitor_retrieve_change_response.rbi +469 -0
  62. data/rbi/context_dev/models/monitor_retrieve_params.rbi +38 -0
  63. data/rbi/context_dev/models/monitor_retrieve_response.rbi +1028 -0
  64. data/rbi/context_dev/models/monitor_run_params.rbi +35 -0
  65. data/rbi/context_dev/models/monitor_run_response.rbi +48 -0
  66. data/rbi/context_dev/models/monitor_update_params.rbi +681 -0
  67. data/rbi/context_dev/models/monitor_update_response.rbi +1020 -0
  68. data/rbi/context_dev/models/utility_prefetch_params.rbi +129 -7
  69. data/rbi/context_dev/models/utility_prefetch_response.rbi +55 -3
  70. data/rbi/context_dev/models/web_extract_response.rbi +10 -0
  71. data/rbi/context_dev/models/web_web_crawl_md_params.rbi +15 -0
  72. data/rbi/context_dev/models/web_web_scrape_html_params.rbi +15 -0
  73. data/rbi/context_dev/models/web_web_scrape_html_response.rbi +29 -3
  74. data/rbi/context_dev/models/web_web_scrape_images_params.rbi +17 -0
  75. data/rbi/context_dev/models/web_web_scrape_md_params.rbi +15 -0
  76. data/rbi/context_dev/models.rbi +23 -15
  77. data/rbi/context_dev/resources/ai.rbi +0 -28
  78. data/rbi/context_dev/resources/brand.rbi +16 -228
  79. data/rbi/context_dev/resources/monitors.rbi +286 -0
  80. data/rbi/context_dev/resources/utility.rbi +14 -29
  81. data/rbi/context_dev/resources/web.rbi +21 -0
  82. data/sig/context_dev/client.rbs +2 -0
  83. data/sig/context_dev/models/brand_retrieve_params.rbs +1586 -281
  84. data/sig/context_dev/models/monitor_create_params.rbs +301 -0
  85. data/sig/context_dev/models/monitor_create_response.rbs +433 -0
  86. data/sig/context_dev/models/monitor_delete_params.rbs +23 -0
  87. data/sig/context_dev/models/monitor_delete_response.rbs +15 -0
  88. data/sig/context_dev/models/monitor_list_account_changes_params.rbs +104 -0
  89. data/sig/context_dev/models/monitor_list_account_changes_response.rbs +176 -0
  90. data/sig/context_dev/models/monitor_list_account_runs_params.rbs +58 -0
  91. data/sig/context_dev/models/monitor_list_account_runs_response.rbs +184 -0
  92. data/sig/context_dev/models/monitor_list_changes_params.rbs +61 -0
  93. data/sig/context_dev/models/monitor_list_changes_response.rbs +176 -0
  94. data/sig/context_dev/models/monitor_list_params.rbs +160 -0
  95. data/sig/context_dev/models/monitor_list_response.rbs +460 -0
  96. data/sig/context_dev/models/monitor_list_runs_params.rbs +63 -0
  97. data/sig/context_dev/models/monitor_list_runs_response.rbs +184 -0
  98. data/sig/context_dev/models/monitor_retrieve_change_params.rbs +23 -0
  99. data/sig/context_dev/models/monitor_retrieve_change_response.rbs +221 -0
  100. data/sig/context_dev/models/monitor_retrieve_params.rbs +23 -0
  101. data/sig/context_dev/models/monitor_retrieve_response.rbs +433 -0
  102. data/sig/context_dev/models/monitor_run_params.rbs +23 -0
  103. data/sig/context_dev/models/monitor_run_response.rbs +18 -0
  104. data/sig/context_dev/models/monitor_update_params.rbs +321 -0
  105. data/sig/context_dev/models/monitor_update_response.rbs +433 -0
  106. data/sig/context_dev/models/utility_prefetch_params.rbs +52 -4
  107. data/sig/context_dev/models/utility_prefetch_response.rbs +22 -3
  108. data/sig/context_dev/models/web_extract_response.rbs +5 -0
  109. data/sig/context_dev/models/web_web_crawl_md_params.rbs +7 -0
  110. data/sig/context_dev/models/web_web_scrape_html_params.rbs +7 -0
  111. data/sig/context_dev/models/web_web_scrape_html_response.rbs +8 -0
  112. data/sig/context_dev/models/web_web_scrape_images_params.rbs +7 -0
  113. data/sig/context_dev/models/web_web_scrape_md_params.rbs +7 -0
  114. data/sig/context_dev/models.rbs +20 -12
  115. data/sig/context_dev/resources/ai.rbs +0 -8
  116. data/sig/context_dev/resources/brand.rbs +1 -56
  117. data/sig/context_dev/resources/monitors.rbs +101 -0
  118. data/sig/context_dev/resources/utility.rbs +2 -7
  119. data/sig/context_dev/resources/web.rbs +4 -0
  120. metadata +71 -44
  121. data/lib/context_dev/models/ai_ai_query_params.rb +0 -235
  122. data/lib/context_dev/models/ai_ai_query_response.rb +0 -133
  123. data/lib/context_dev/models/brand_identify_from_transaction_params.rb +0 -474
  124. data/lib/context_dev/models/brand_identify_from_transaction_response.rb +0 -1074
  125. data/lib/context_dev/models/brand_retrieve_by_email_params.rb +0 -195
  126. data/lib/context_dev/models/brand_retrieve_by_email_response.rb +0 -1071
  127. data/lib/context_dev/models/brand_retrieve_by_isin_params.rb +0 -195
  128. data/lib/context_dev/models/brand_retrieve_by_isin_response.rb +0 -1070
  129. data/lib/context_dev/models/brand_retrieve_by_name_params.rb +0 -452
  130. data/lib/context_dev/models/brand_retrieve_by_name_response.rb +0 -1070
  131. data/lib/context_dev/models/brand_retrieve_by_ticker_params.rb +0 -283
  132. data/lib/context_dev/models/brand_retrieve_by_ticker_response.rb +0 -1072
  133. data/lib/context_dev/models/utility_prefetch_by_email_params.rb +0 -37
  134. data/lib/context_dev/models/utility_prefetch_by_email_response.rb +0 -68
  135. data/rbi/context_dev/models/ai_ai_query_params.rbi +0 -504
  136. data/rbi/context_dev/models/ai_ai_query_response.rbi +0 -267
  137. data/rbi/context_dev/models/brand_identify_from_transaction_params.rbi +0 -2020
  138. data/rbi/context_dev/models/brand_identify_from_transaction_response.rbi +0 -3515
  139. data/rbi/context_dev/models/brand_retrieve_by_email_params.rbi +0 -743
  140. data/rbi/context_dev/models/brand_retrieve_by_email_response.rbi +0 -3511
  141. data/rbi/context_dev/models/brand_retrieve_by_isin_params.rbi +0 -743
  142. data/rbi/context_dev/models/brand_retrieve_by_isin_response.rbi +0 -3510
  143. data/rbi/context_dev/models/brand_retrieve_by_name_params.rbi +0 -1982
  144. data/rbi/context_dev/models/brand_retrieve_by_name_response.rbi +0 -3510
  145. data/rbi/context_dev/models/brand_retrieve_by_ticker_params.rbi +0 -1153
  146. data/rbi/context_dev/models/brand_retrieve_by_ticker_response.rbi +0 -3512
  147. data/rbi/context_dev/models/utility_prefetch_by_email_params.rbi +0 -65
  148. data/rbi/context_dev/models/utility_prefetch_by_email_response.rbi +0 -132
  149. data/sig/context_dev/models/ai_ai_query_params.rbs +0 -218
  150. data/sig/context_dev/models/ai_ai_query_response.rbs +0 -121
  151. data/sig/context_dev/models/brand_identify_from_transaction_params.rbs +0 -822
  152. data/sig/context_dev/models/brand_identify_from_transaction_response.rbs +0 -1441
  153. data/sig/context_dev/models/brand_retrieve_by_email_params.rbs +0 -305
  154. data/sig/context_dev/models/brand_retrieve_by_email_response.rbs +0 -1441
  155. data/sig/context_dev/models/brand_retrieve_by_isin_params.rbs +0 -305
  156. data/sig/context_dev/models/brand_retrieve_by_isin_response.rbs +0 -1441
  157. data/sig/context_dev/models/brand_retrieve_by_name_params.rbs +0 -801
  158. data/sig/context_dev/models/brand_retrieve_by_name_response.rbs +0 -1441
  159. data/sig/context_dev/models/brand_retrieve_by_ticker_params.rbs +0 -467
  160. data/sig/context_dev/models/brand_retrieve_by_ticker_response.rbs +0 -1441
  161. data/sig/context_dev/models/utility_prefetch_by_email_params.rbs +0 -30
  162. data/sig/context_dev/models/utility_prefetch_by_email_response.rbs +0 -64
@@ -7,187 +7,1092 @@ module ContextDev
7
7
  extend ContextDev::Internal::Type::RequestParameters::Converter
8
8
  include ContextDev::Internal::Type::RequestParameters
9
9
 
10
- # @!attribute domain
11
- # Domain name to retrieve brand data for (e.g., 'example.com', 'google.com').
12
- # Cannot be used with name or ticker parameters.
10
+ # @!attribute body
11
+ # Exactly one lookup type must be provided.
13
12
  #
14
- # @return [String]
15
- required :domain, String
13
+ # @return [ContextDev::Models::BrandRetrieveParams::Body::ByDomain, ContextDev::Models::BrandRetrieveParams::Body::ByName, ContextDev::Models::BrandRetrieveParams::Body::ByEmail, ContextDev::Models::BrandRetrieveParams::Body::ByTicker, ContextDev::Models::BrandRetrieveParams::Body::ByDirectURL, ContextDev::Models::BrandRetrieveParams::Body::ByTransaction]
14
+ required :body, union: -> { ContextDev::BrandRetrieveParams::Body }
16
15
 
17
- # @!attribute force_language
18
- # Optional parameter to force the language of the retrieved brand data.
16
+ # @!method initialize(body:, request_options: {})
17
+ # @param body [ContextDev::Models::BrandRetrieveParams::Body::ByDomain, ContextDev::Models::BrandRetrieveParams::Body::ByName, ContextDev::Models::BrandRetrieveParams::Body::ByEmail, ContextDev::Models::BrandRetrieveParams::Body::ByTicker, ContextDev::Models::BrandRetrieveParams::Body::ByDirectURL, ContextDev::Models::BrandRetrieveParams::Body::ByTransaction] Exactly one lookup type must be provided.
19
18
  #
20
- # @return [Symbol, ContextDev::Models::BrandRetrieveParams::ForceLanguage, nil]
21
- optional :force_language, enum: -> { ContextDev::BrandRetrieveParams::ForceLanguage }
22
-
23
- # @!attribute max_age_ms
24
- # Maximum age in milliseconds for cached brand data before the API performs a hard
25
- # refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms)
26
- # are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1
27
- # year.
28
- #
29
- # @return [Integer, nil]
30
- optional :max_age_ms, Integer
19
+ # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
31
20
 
32
- # @!attribute max_speed
33
- # Optional parameter to optimize the API call for maximum speed. When set to true,
34
- # the API will skip time-consuming operations for faster response at the cost of
35
- # less comprehensive data. Works with all three lookup methods.
36
- #
37
- # @return [Boolean, nil]
38
- optional :max_speed, ContextDev::Internal::Type::Boolean
21
+ # Exactly one lookup type must be provided.
22
+ module Body
23
+ extend ContextDev::Internal::Type::Union
39
24
 
40
- # @!attribute timeout_ms
41
- # Optional timeout in milliseconds for the request. If the request takes longer
42
- # than this value, it will be aborted with a 408 status code. Maximum allowed
43
- # value is 300000ms (5 minutes).
44
- #
45
- # @return [Integer, nil]
46
- optional :timeout_ms, Integer
25
+ discriminator :type
47
26
 
48
- # @!method initialize(domain:, force_language: nil, max_age_ms: nil, max_speed: nil, timeout_ms: nil, request_options: {})
49
- # Some parameter documentations has been truncated, see
50
- # {ContextDev::Models::BrandRetrieveParams} for more details.
51
- #
52
- # @param domain [String] Domain name to retrieve brand data for (e.g., 'example.com', 'google.com'). Cann
53
- #
54
- # @param force_language [Symbol, ContextDev::Models::BrandRetrieveParams::ForceLanguage] Optional parameter to force the language of the retrieved brand data.
55
- #
56
- # @param max_age_ms [Integer] Maximum age in milliseconds for cached brand data before the API performs a hard
57
- #
58
- # @param max_speed [Boolean] Optional parameter to optimize the API call for maximum speed. When set to true,
59
- #
60
- # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
61
- #
62
- # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
27
+ # Retrieve brand data by domain. Cannot be combined with name, email, or ticker.
28
+ variant :by_domain, -> { ContextDev::BrandRetrieveParams::Body::ByDomain }
29
+
30
+ # Retrieve brand data by company name. Cannot be combined with domain, email, or ticker.
31
+ variant :by_name, -> { ContextDev::BrandRetrieveParams::Body::ByName }
32
+
33
+ # Retrieve brand data by email address. The domain is extracted from the email. Free and disposable email providers are rejected with 422. Cannot be combined with domain, name, or ticker.
34
+ variant :by_email, -> { ContextDev::BrandRetrieveParams::Body::ByEmail }
35
+
36
+ # Retrieve brand data by stock ticker. Cannot be combined with domain, name, or email.
37
+ variant :by_ticker, -> { ContextDev::BrandRetrieveParams::Body::ByTicker }
38
+
39
+ # Retrieve brand data by fetching the provided URL directly. Note: if you use this, brand data is fetched only from the provided URL — not from the entire internet — so results are limited to what that single page contains. No domain resolution, database lookup, or cross-source enrichment is performed. Cannot be combined with domain, name, email, or ticker.
40
+ variant :by_direct_url, -> { ContextDev::BrandRetrieveParams::Body::ByDirectURL }
41
+
42
+ # Identify brand data from a transaction descriptor. Cannot be combined with domain, name, email, or ticker.
43
+ variant :by_transaction, -> { ContextDev::BrandRetrieveParams::Body::ByTransaction }
44
+
45
+ class ByDomain < ContextDev::Internal::Type::BaseModel
46
+ # @!attribute domain
47
+ # Domain name to retrieve brand data for (e.g., 'stripe.com').
48
+ #
49
+ # @return [String]
50
+ required :domain, String
51
+
52
+ # @!attribute type
53
+ # Discriminator for domain-based brand retrieval.
54
+ #
55
+ # @return [Symbol, :by_domain]
56
+ required :type, const: :by_domain
57
+
58
+ # @!attribute force_language
59
+ #
60
+ # @return [Symbol, ContextDev::Models::BrandRetrieveParams::Body::ByDomain::ForceLanguage, nil]
61
+ optional :force_language, enum: -> { ContextDev::BrandRetrieveParams::Body::ByDomain::ForceLanguage }
62
+
63
+ # @!attribute max_age_ms
64
+ # Maximum age in milliseconds for cached brand data before the API performs a hard
65
+ # refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms)
66
+ # are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1
67
+ # year.
68
+ #
69
+ # @return [Integer, nil]
70
+ optional :max_age_ms, Integer, api_name: :maxAgeMs
71
+
72
+ # @!attribute max_speed
73
+ # Optional parameter to optimize the API call for maximum speed. When set to true,
74
+ # the API will skip time-consuming operations for faster response at the cost of
75
+ # less comprehensive data.
76
+ #
77
+ # @return [Boolean, nil]
78
+ optional :max_speed, ContextDev::Internal::Type::Boolean, api_name: :maxSpeed
79
+
80
+ # @!attribute timeout_ms
81
+ # Optional timeout in milliseconds for the request. If the request takes longer
82
+ # than this value, it will be aborted with a 408 status code. Maximum allowed
83
+ # value is 300000ms (5 minutes).
84
+ #
85
+ # @return [Integer, nil]
86
+ optional :timeout_ms, Integer, api_name: :timeoutMS
87
+
88
+ # @!method initialize(domain:, force_language: nil, max_age_ms: nil, max_speed: nil, timeout_ms: nil, type: :by_domain)
89
+ # Some parameter documentations has been truncated, see
90
+ # {ContextDev::Models::BrandRetrieveParams::Body::ByDomain} for more details.
91
+ #
92
+ # Retrieve brand data by domain. Cannot be combined with name, email, or ticker.
93
+ #
94
+ # @param domain [String] Domain name to retrieve brand data for (e.g., 'stripe.com').
95
+ #
96
+ # @param force_language [Symbol, ContextDev::Models::BrandRetrieveParams::Body::ByDomain::ForceLanguage]
97
+ #
98
+ # @param max_age_ms [Integer] Maximum age in milliseconds for cached brand data before the API performs a hard
99
+ #
100
+ # @param max_speed [Boolean] Optional parameter to optimize the API call for maximum speed. When set to true,
101
+ #
102
+ # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
103
+ #
104
+ # @param type [Symbol, :by_domain] Discriminator for domain-based brand retrieval.
105
+
106
+ # @see ContextDev::Models::BrandRetrieveParams::Body::ByDomain#force_language
107
+ module ForceLanguage
108
+ extend ContextDev::Internal::Type::Enum
109
+
110
+ AFRIKAANS = :afrikaans
111
+ ALBANIAN = :albanian
112
+ AMHARIC = :amharic
113
+ ARABIC = :arabic
114
+ ARMENIAN = :armenian
115
+ ASSAMESE = :assamese
116
+ AYMARA = :aymara
117
+ AZERI = :azeri
118
+ BASQUE = :basque
119
+ BELARUSIAN = :belarusian
120
+ BENGALI = :bengali
121
+ BOSNIAN = :bosnian
122
+ BULGARIAN = :bulgarian
123
+ BURMESE = :burmese
124
+ CANTONESE = :cantonese
125
+ CATALAN = :catalan
126
+ CEBUANO = :cebuano
127
+ CHINESE = :chinese
128
+ CORSICAN = :corsican
129
+ CROATIAN = :croatian
130
+ CZECH = :czech
131
+ DANISH = :danish
132
+ DUTCH = :dutch
133
+ ENGLISH = :english
134
+ ESPERANTO = :esperanto
135
+ ESTONIAN = :estonian
136
+ FARSI = :farsi
137
+ FIJIAN = :fijian
138
+ FINNISH = :finnish
139
+ FRENCH = :french
140
+ GALICIAN = :galician
141
+ GEORGIAN = :georgian
142
+ GERMAN = :german
143
+ GREEK = :greek
144
+ GUARANI = :guarani
145
+ GUJARATI = :gujarati
146
+ HAITIAN_CREOLE = :"haitian-creole"
147
+ HAUSA = :hausa
148
+ HAWAIIAN = :hawaiian
149
+ HEBREW = :hebrew
150
+ HINDI = :hindi
151
+ HMONG = :hmong
152
+ HUNGARIAN = :hungarian
153
+ ICELANDIC = :icelandic
154
+ IGBO = :igbo
155
+ INDONESIAN = :indonesian
156
+ IRISH = :irish
157
+ ITALIAN = :italian
158
+ JAPANESE = :japanese
159
+ JAVANESE = :javanese
160
+ KANNADA = :kannada
161
+ KAZAKH = :kazakh
162
+ KHMER = :khmer
163
+ KINYARWANDA = :kinyarwanda
164
+ KOREAN = :korean
165
+ KURDISH = :kurdish
166
+ KYRGYZ = :kyrgyz
167
+ LAO = :lao
168
+ LATIN = :latin
169
+ LATVIAN = :latvian
170
+ LINGALA = :lingala
171
+ LITHUANIAN = :lithuanian
172
+ LUXEMBOURGISH = :luxembourgish
173
+ MACEDONIAN = :macedonian
174
+ MALAGASY = :malagasy
175
+ MALAY = :malay
176
+ MALAYALAM = :malayalam
177
+ MALTESE = :maltese
178
+ MAORI = :maori
179
+ MARATHI = :marathi
180
+ MONGOLIAN = :mongolian
181
+ NEPALI = :nepali
182
+ NORWEGIAN = :norwegian
183
+ ODIA = :odia
184
+ OROMO = :oromo
185
+ PASHTO = :pashto
186
+ PIDGIN = :pidgin
187
+ POLISH = :polish
188
+ PORTUGUESE = :portuguese
189
+ PUNJABI = :punjabi
190
+ QUECHUA = :quechua
191
+ ROMANIAN = :romanian
192
+ RUSSIAN = :russian
193
+ SAMOAN = :samoan
194
+ SCOTTISH_GAELIC = :"scottish-gaelic"
195
+ SERBIAN = :serbian
196
+ SESOTHO = :sesotho
197
+ SHONA = :shona
198
+ SINDHI = :sindhi
199
+ SINHALA = :sinhala
200
+ SLOVAK = :slovak
201
+ SLOVENE = :slovene
202
+ SOMALI = :somali
203
+ SPANISH = :spanish
204
+ SUNDANESE = :sundanese
205
+ SWAHILI = :swahili
206
+ SWEDISH = :swedish
207
+ TAGALOG = :tagalog
208
+ TAJIK = :tajik
209
+ TAMIL = :tamil
210
+ TATAR = :tatar
211
+ TELUGU = :telugu
212
+ THAI = :thai
213
+ TIBETAN = :tibetan
214
+ TIGRINYA = :tigrinya
215
+ TONGAN = :tongan
216
+ TSWANA = :tswana
217
+ TURKISH = :turkish
218
+ TURKMEN = :turkmen
219
+ UKRAINIAN = :ukrainian
220
+ URDU = :urdu
221
+ UYGHUR = :uyghur
222
+ UZBEK = :uzbek
223
+ VIETNAMESE = :vietnamese
224
+ WELSH = :welsh
225
+ WOLOF = :wolof
226
+ XHOSA = :xhosa
227
+ YIDDISH = :yiddish
228
+ YORUBA = :yoruba
229
+ ZULU = :zulu
230
+
231
+ # @!method self.values
232
+ # @return [Array<Symbol>]
233
+ end
234
+ end
235
+
236
+ class ByName < ContextDev::Internal::Type::BaseModel
237
+ # @!attribute name
238
+ # Company name to retrieve brand data for (e.g., 'Apple Inc').
239
+ #
240
+ # @return [String]
241
+ required :name, String
242
+
243
+ # @!attribute type
244
+ # Discriminator for name-based brand retrieval.
245
+ #
246
+ # @return [Symbol, :by_name]
247
+ required :type, const: :by_name
248
+
249
+ # @!attribute country_gl
250
+ # Optional country code hint (GL parameter) to specify the country when looking up
251
+ # by company name.
252
+ #
253
+ # @return [String, nil]
254
+ optional :country_gl, String
255
+
256
+ # @!attribute force_language
257
+ #
258
+ # @return [Symbol, ContextDev::Models::BrandRetrieveParams::Body::ByName::ForceLanguage, nil]
259
+ optional :force_language, enum: -> { ContextDev::BrandRetrieveParams::Body::ByName::ForceLanguage }
260
+
261
+ # @!attribute max_age_ms
262
+ # Maximum age in milliseconds for cached brand data before the API performs a hard
263
+ # refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms)
264
+ # are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1
265
+ # year.
266
+ #
267
+ # @return [Integer, nil]
268
+ optional :max_age_ms, Integer, api_name: :maxAgeMs
269
+
270
+ # @!attribute max_speed
271
+ # Optional parameter to optimize the API call for maximum speed. When set to true,
272
+ # the API will skip time-consuming operations for faster response at the cost of
273
+ # less comprehensive data.
274
+ #
275
+ # @return [Boolean, nil]
276
+ optional :max_speed, ContextDev::Internal::Type::Boolean, api_name: :maxSpeed
277
+
278
+ # @!attribute timeout_ms
279
+ # Optional timeout in milliseconds for the request. If the request takes longer
280
+ # than this value, it will be aborted with a 408 status code. Maximum allowed
281
+ # value is 300000ms (5 minutes).
282
+ #
283
+ # @return [Integer, nil]
284
+ optional :timeout_ms, Integer, api_name: :timeoutMS
285
+
286
+ # @!method initialize(name:, country_gl: nil, force_language: nil, max_age_ms: nil, max_speed: nil, timeout_ms: nil, type: :by_name)
287
+ # Some parameter documentations has been truncated, see
288
+ # {ContextDev::Models::BrandRetrieveParams::Body::ByName} for more details.
289
+ #
290
+ # Retrieve brand data by company name. Cannot be combined with domain, email, or
291
+ # ticker.
292
+ #
293
+ # @param name [String] Company name to retrieve brand data for (e.g., 'Apple Inc').
294
+ #
295
+ # @param country_gl [String] Optional country code hint (GL parameter) to specify the country when looking up
296
+ #
297
+ # @param force_language [Symbol, ContextDev::Models::BrandRetrieveParams::Body::ByName::ForceLanguage]
298
+ #
299
+ # @param max_age_ms [Integer] Maximum age in milliseconds for cached brand data before the API performs a hard
300
+ #
301
+ # @param max_speed [Boolean] Optional parameter to optimize the API call for maximum speed. When set to true,
302
+ #
303
+ # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
304
+ #
305
+ # @param type [Symbol, :by_name] Discriminator for name-based brand retrieval.
306
+
307
+ # @see ContextDev::Models::BrandRetrieveParams::Body::ByName#force_language
308
+ module ForceLanguage
309
+ extend ContextDev::Internal::Type::Enum
310
+
311
+ AFRIKAANS = :afrikaans
312
+ ALBANIAN = :albanian
313
+ AMHARIC = :amharic
314
+ ARABIC = :arabic
315
+ ARMENIAN = :armenian
316
+ ASSAMESE = :assamese
317
+ AYMARA = :aymara
318
+ AZERI = :azeri
319
+ BASQUE = :basque
320
+ BELARUSIAN = :belarusian
321
+ BENGALI = :bengali
322
+ BOSNIAN = :bosnian
323
+ BULGARIAN = :bulgarian
324
+ BURMESE = :burmese
325
+ CANTONESE = :cantonese
326
+ CATALAN = :catalan
327
+ CEBUANO = :cebuano
328
+ CHINESE = :chinese
329
+ CORSICAN = :corsican
330
+ CROATIAN = :croatian
331
+ CZECH = :czech
332
+ DANISH = :danish
333
+ DUTCH = :dutch
334
+ ENGLISH = :english
335
+ ESPERANTO = :esperanto
336
+ ESTONIAN = :estonian
337
+ FARSI = :farsi
338
+ FIJIAN = :fijian
339
+ FINNISH = :finnish
340
+ FRENCH = :french
341
+ GALICIAN = :galician
342
+ GEORGIAN = :georgian
343
+ GERMAN = :german
344
+ GREEK = :greek
345
+ GUARANI = :guarani
346
+ GUJARATI = :gujarati
347
+ HAITIAN_CREOLE = :"haitian-creole"
348
+ HAUSA = :hausa
349
+ HAWAIIAN = :hawaiian
350
+ HEBREW = :hebrew
351
+ HINDI = :hindi
352
+ HMONG = :hmong
353
+ HUNGARIAN = :hungarian
354
+ ICELANDIC = :icelandic
355
+ IGBO = :igbo
356
+ INDONESIAN = :indonesian
357
+ IRISH = :irish
358
+ ITALIAN = :italian
359
+ JAPANESE = :japanese
360
+ JAVANESE = :javanese
361
+ KANNADA = :kannada
362
+ KAZAKH = :kazakh
363
+ KHMER = :khmer
364
+ KINYARWANDA = :kinyarwanda
365
+ KOREAN = :korean
366
+ KURDISH = :kurdish
367
+ KYRGYZ = :kyrgyz
368
+ LAO = :lao
369
+ LATIN = :latin
370
+ LATVIAN = :latvian
371
+ LINGALA = :lingala
372
+ LITHUANIAN = :lithuanian
373
+ LUXEMBOURGISH = :luxembourgish
374
+ MACEDONIAN = :macedonian
375
+ MALAGASY = :malagasy
376
+ MALAY = :malay
377
+ MALAYALAM = :malayalam
378
+ MALTESE = :maltese
379
+ MAORI = :maori
380
+ MARATHI = :marathi
381
+ MONGOLIAN = :mongolian
382
+ NEPALI = :nepali
383
+ NORWEGIAN = :norwegian
384
+ ODIA = :odia
385
+ OROMO = :oromo
386
+ PASHTO = :pashto
387
+ PIDGIN = :pidgin
388
+ POLISH = :polish
389
+ PORTUGUESE = :portuguese
390
+ PUNJABI = :punjabi
391
+ QUECHUA = :quechua
392
+ ROMANIAN = :romanian
393
+ RUSSIAN = :russian
394
+ SAMOAN = :samoan
395
+ SCOTTISH_GAELIC = :"scottish-gaelic"
396
+ SERBIAN = :serbian
397
+ SESOTHO = :sesotho
398
+ SHONA = :shona
399
+ SINDHI = :sindhi
400
+ SINHALA = :sinhala
401
+ SLOVAK = :slovak
402
+ SLOVENE = :slovene
403
+ SOMALI = :somali
404
+ SPANISH = :spanish
405
+ SUNDANESE = :sundanese
406
+ SWAHILI = :swahili
407
+ SWEDISH = :swedish
408
+ TAGALOG = :tagalog
409
+ TAJIK = :tajik
410
+ TAMIL = :tamil
411
+ TATAR = :tatar
412
+ TELUGU = :telugu
413
+ THAI = :thai
414
+ TIBETAN = :tibetan
415
+ TIGRINYA = :tigrinya
416
+ TONGAN = :tongan
417
+ TSWANA = :tswana
418
+ TURKISH = :turkish
419
+ TURKMEN = :turkmen
420
+ UKRAINIAN = :ukrainian
421
+ URDU = :urdu
422
+ UYGHUR = :uyghur
423
+ UZBEK = :uzbek
424
+ VIETNAMESE = :vietnamese
425
+ WELSH = :welsh
426
+ WOLOF = :wolof
427
+ XHOSA = :xhosa
428
+ YIDDISH = :yiddish
429
+ YORUBA = :yoruba
430
+ ZULU = :zulu
431
+
432
+ # @!method self.values
433
+ # @return [Array<Symbol>]
434
+ end
435
+ end
436
+
437
+ class ByEmail < ContextDev::Internal::Type::BaseModel
438
+ # @!attribute email
439
+ # Email address to retrieve brand data for (e.g., 'jane@stripe.com').
440
+ #
441
+ # @return [String]
442
+ required :email, String
443
+
444
+ # @!attribute type
445
+ # Discriminator for email-based brand retrieval.
446
+ #
447
+ # @return [Symbol, :by_email]
448
+ required :type, const: :by_email
449
+
450
+ # @!attribute force_language
451
+ #
452
+ # @return [Symbol, ContextDev::Models::BrandRetrieveParams::Body::ByEmail::ForceLanguage, nil]
453
+ optional :force_language, enum: -> { ContextDev::BrandRetrieveParams::Body::ByEmail::ForceLanguage }
454
+
455
+ # @!attribute max_age_ms
456
+ # Maximum age in milliseconds for cached brand data before the API performs a hard
457
+ # refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms)
458
+ # are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1
459
+ # year.
460
+ #
461
+ # @return [Integer, nil]
462
+ optional :max_age_ms, Integer, api_name: :maxAgeMs
463
+
464
+ # @!attribute max_speed
465
+ # Optional parameter to optimize the API call for maximum speed. When set to true,
466
+ # the API will skip time-consuming operations for faster response at the cost of
467
+ # less comprehensive data.
468
+ #
469
+ # @return [Boolean, nil]
470
+ optional :max_speed, ContextDev::Internal::Type::Boolean, api_name: :maxSpeed
471
+
472
+ # @!attribute timeout_ms
473
+ # Optional timeout in milliseconds for the request. If the request takes longer
474
+ # than this value, it will be aborted with a 408 status code. Maximum allowed
475
+ # value is 300000ms (5 minutes).
476
+ #
477
+ # @return [Integer, nil]
478
+ optional :timeout_ms, Integer, api_name: :timeoutMS
479
+
480
+ # @!method initialize(email:, force_language: nil, max_age_ms: nil, max_speed: nil, timeout_ms: nil, type: :by_email)
481
+ # Some parameter documentations has been truncated, see
482
+ # {ContextDev::Models::BrandRetrieveParams::Body::ByEmail} for more details.
483
+ #
484
+ # Retrieve brand data by email address. The domain is extracted from the email.
485
+ # Free and disposable email providers are rejected with 422. Cannot be combined
486
+ # with domain, name, or ticker.
487
+ #
488
+ # @param email [String] Email address to retrieve brand data for (e.g., 'jane@stripe.com').
489
+ #
490
+ # @param force_language [Symbol, ContextDev::Models::BrandRetrieveParams::Body::ByEmail::ForceLanguage]
491
+ #
492
+ # @param max_age_ms [Integer] Maximum age in milliseconds for cached brand data before the API performs a hard
493
+ #
494
+ # @param max_speed [Boolean] Optional parameter to optimize the API call for maximum speed. When set to true,
495
+ #
496
+ # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
497
+ #
498
+ # @param type [Symbol, :by_email] Discriminator for email-based brand retrieval.
499
+
500
+ # @see ContextDev::Models::BrandRetrieveParams::Body::ByEmail#force_language
501
+ module ForceLanguage
502
+ extend ContextDev::Internal::Type::Enum
503
+
504
+ AFRIKAANS = :afrikaans
505
+ ALBANIAN = :albanian
506
+ AMHARIC = :amharic
507
+ ARABIC = :arabic
508
+ ARMENIAN = :armenian
509
+ ASSAMESE = :assamese
510
+ AYMARA = :aymara
511
+ AZERI = :azeri
512
+ BASQUE = :basque
513
+ BELARUSIAN = :belarusian
514
+ BENGALI = :bengali
515
+ BOSNIAN = :bosnian
516
+ BULGARIAN = :bulgarian
517
+ BURMESE = :burmese
518
+ CANTONESE = :cantonese
519
+ CATALAN = :catalan
520
+ CEBUANO = :cebuano
521
+ CHINESE = :chinese
522
+ CORSICAN = :corsican
523
+ CROATIAN = :croatian
524
+ CZECH = :czech
525
+ DANISH = :danish
526
+ DUTCH = :dutch
527
+ ENGLISH = :english
528
+ ESPERANTO = :esperanto
529
+ ESTONIAN = :estonian
530
+ FARSI = :farsi
531
+ FIJIAN = :fijian
532
+ FINNISH = :finnish
533
+ FRENCH = :french
534
+ GALICIAN = :galician
535
+ GEORGIAN = :georgian
536
+ GERMAN = :german
537
+ GREEK = :greek
538
+ GUARANI = :guarani
539
+ GUJARATI = :gujarati
540
+ HAITIAN_CREOLE = :"haitian-creole"
541
+ HAUSA = :hausa
542
+ HAWAIIAN = :hawaiian
543
+ HEBREW = :hebrew
544
+ HINDI = :hindi
545
+ HMONG = :hmong
546
+ HUNGARIAN = :hungarian
547
+ ICELANDIC = :icelandic
548
+ IGBO = :igbo
549
+ INDONESIAN = :indonesian
550
+ IRISH = :irish
551
+ ITALIAN = :italian
552
+ JAPANESE = :japanese
553
+ JAVANESE = :javanese
554
+ KANNADA = :kannada
555
+ KAZAKH = :kazakh
556
+ KHMER = :khmer
557
+ KINYARWANDA = :kinyarwanda
558
+ KOREAN = :korean
559
+ KURDISH = :kurdish
560
+ KYRGYZ = :kyrgyz
561
+ LAO = :lao
562
+ LATIN = :latin
563
+ LATVIAN = :latvian
564
+ LINGALA = :lingala
565
+ LITHUANIAN = :lithuanian
566
+ LUXEMBOURGISH = :luxembourgish
567
+ MACEDONIAN = :macedonian
568
+ MALAGASY = :malagasy
569
+ MALAY = :malay
570
+ MALAYALAM = :malayalam
571
+ MALTESE = :maltese
572
+ MAORI = :maori
573
+ MARATHI = :marathi
574
+ MONGOLIAN = :mongolian
575
+ NEPALI = :nepali
576
+ NORWEGIAN = :norwegian
577
+ ODIA = :odia
578
+ OROMO = :oromo
579
+ PASHTO = :pashto
580
+ PIDGIN = :pidgin
581
+ POLISH = :polish
582
+ PORTUGUESE = :portuguese
583
+ PUNJABI = :punjabi
584
+ QUECHUA = :quechua
585
+ ROMANIAN = :romanian
586
+ RUSSIAN = :russian
587
+ SAMOAN = :samoan
588
+ SCOTTISH_GAELIC = :"scottish-gaelic"
589
+ SERBIAN = :serbian
590
+ SESOTHO = :sesotho
591
+ SHONA = :shona
592
+ SINDHI = :sindhi
593
+ SINHALA = :sinhala
594
+ SLOVAK = :slovak
595
+ SLOVENE = :slovene
596
+ SOMALI = :somali
597
+ SPANISH = :spanish
598
+ SUNDANESE = :sundanese
599
+ SWAHILI = :swahili
600
+ SWEDISH = :swedish
601
+ TAGALOG = :tagalog
602
+ TAJIK = :tajik
603
+ TAMIL = :tamil
604
+ TATAR = :tatar
605
+ TELUGU = :telugu
606
+ THAI = :thai
607
+ TIBETAN = :tibetan
608
+ TIGRINYA = :tigrinya
609
+ TONGAN = :tongan
610
+ TSWANA = :tswana
611
+ TURKISH = :turkish
612
+ TURKMEN = :turkmen
613
+ UKRAINIAN = :ukrainian
614
+ URDU = :urdu
615
+ UYGHUR = :uyghur
616
+ UZBEK = :uzbek
617
+ VIETNAMESE = :vietnamese
618
+ WELSH = :welsh
619
+ WOLOF = :wolof
620
+ XHOSA = :xhosa
621
+ YIDDISH = :yiddish
622
+ YORUBA = :yoruba
623
+ ZULU = :zulu
624
+
625
+ # @!method self.values
626
+ # @return [Array<Symbol>]
627
+ end
628
+ end
629
+
630
+ class ByTicker < ContextDev::Internal::Type::BaseModel
631
+ # @!attribute ticker
632
+ # Stock ticker symbol to retrieve brand data for (e.g., 'AAPL').
633
+ #
634
+ # @return [String]
635
+ required :ticker, String
636
+
637
+ # @!attribute type
638
+ # Discriminator for ticker-based brand retrieval.
639
+ #
640
+ # @return [Symbol, :by_ticker]
641
+ required :type, const: :by_ticker
642
+
643
+ # @!attribute force_language
644
+ #
645
+ # @return [Symbol, ContextDev::Models::BrandRetrieveParams::Body::ByTicker::ForceLanguage, nil]
646
+ optional :force_language, enum: -> { ContextDev::BrandRetrieveParams::Body::ByTicker::ForceLanguage }
647
+
648
+ # @!attribute max_age_ms
649
+ # Maximum age in milliseconds for cached brand data before the API performs a hard
650
+ # refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms)
651
+ # are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1
652
+ # year.
653
+ #
654
+ # @return [Integer, nil]
655
+ optional :max_age_ms, Integer, api_name: :maxAgeMs
656
+
657
+ # @!attribute max_speed
658
+ # Optional parameter to optimize the API call for maximum speed. When set to true,
659
+ # the API will skip time-consuming operations for faster response at the cost of
660
+ # less comprehensive data.
661
+ #
662
+ # @return [Boolean, nil]
663
+ optional :max_speed, ContextDev::Internal::Type::Boolean, api_name: :maxSpeed
664
+
665
+ # @!attribute ticker_exchange
666
+ # Optional stock exchange for the ticker. Defaults to NASDAQ if not specified.
667
+ #
668
+ # @return [String, nil]
669
+ optional :ticker_exchange, String
670
+
671
+ # @!attribute timeout_ms
672
+ # Optional timeout in milliseconds for the request. If the request takes longer
673
+ # than this value, it will be aborted with a 408 status code. Maximum allowed
674
+ # value is 300000ms (5 minutes).
675
+ #
676
+ # @return [Integer, nil]
677
+ optional :timeout_ms, Integer, api_name: :timeoutMS
678
+
679
+ # @!method initialize(ticker:, force_language: nil, max_age_ms: nil, max_speed: nil, ticker_exchange: nil, timeout_ms: nil, type: :by_ticker)
680
+ # Some parameter documentations has been truncated, see
681
+ # {ContextDev::Models::BrandRetrieveParams::Body::ByTicker} for more details.
682
+ #
683
+ # Retrieve brand data by stock ticker. Cannot be combined with domain, name, or
684
+ # email.
685
+ #
686
+ # @param ticker [String] Stock ticker symbol to retrieve brand data for (e.g., 'AAPL').
687
+ #
688
+ # @param force_language [Symbol, ContextDev::Models::BrandRetrieveParams::Body::ByTicker::ForceLanguage]
689
+ #
690
+ # @param max_age_ms [Integer] Maximum age in milliseconds for cached brand data before the API performs a hard
691
+ #
692
+ # @param max_speed [Boolean] Optional parameter to optimize the API call for maximum speed. When set to true,
693
+ #
694
+ # @param ticker_exchange [String] Optional stock exchange for the ticker. Defaults to NASDAQ if not specified.
695
+ #
696
+ # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
697
+ #
698
+ # @param type [Symbol, :by_ticker] Discriminator for ticker-based brand retrieval.
699
+
700
+ # @see ContextDev::Models::BrandRetrieveParams::Body::ByTicker#force_language
701
+ module ForceLanguage
702
+ extend ContextDev::Internal::Type::Enum
703
+
704
+ AFRIKAANS = :afrikaans
705
+ ALBANIAN = :albanian
706
+ AMHARIC = :amharic
707
+ ARABIC = :arabic
708
+ ARMENIAN = :armenian
709
+ ASSAMESE = :assamese
710
+ AYMARA = :aymara
711
+ AZERI = :azeri
712
+ BASQUE = :basque
713
+ BELARUSIAN = :belarusian
714
+ BENGALI = :bengali
715
+ BOSNIAN = :bosnian
716
+ BULGARIAN = :bulgarian
717
+ BURMESE = :burmese
718
+ CANTONESE = :cantonese
719
+ CATALAN = :catalan
720
+ CEBUANO = :cebuano
721
+ CHINESE = :chinese
722
+ CORSICAN = :corsican
723
+ CROATIAN = :croatian
724
+ CZECH = :czech
725
+ DANISH = :danish
726
+ DUTCH = :dutch
727
+ ENGLISH = :english
728
+ ESPERANTO = :esperanto
729
+ ESTONIAN = :estonian
730
+ FARSI = :farsi
731
+ FIJIAN = :fijian
732
+ FINNISH = :finnish
733
+ FRENCH = :french
734
+ GALICIAN = :galician
735
+ GEORGIAN = :georgian
736
+ GERMAN = :german
737
+ GREEK = :greek
738
+ GUARANI = :guarani
739
+ GUJARATI = :gujarati
740
+ HAITIAN_CREOLE = :"haitian-creole"
741
+ HAUSA = :hausa
742
+ HAWAIIAN = :hawaiian
743
+ HEBREW = :hebrew
744
+ HINDI = :hindi
745
+ HMONG = :hmong
746
+ HUNGARIAN = :hungarian
747
+ ICELANDIC = :icelandic
748
+ IGBO = :igbo
749
+ INDONESIAN = :indonesian
750
+ IRISH = :irish
751
+ ITALIAN = :italian
752
+ JAPANESE = :japanese
753
+ JAVANESE = :javanese
754
+ KANNADA = :kannada
755
+ KAZAKH = :kazakh
756
+ KHMER = :khmer
757
+ KINYARWANDA = :kinyarwanda
758
+ KOREAN = :korean
759
+ KURDISH = :kurdish
760
+ KYRGYZ = :kyrgyz
761
+ LAO = :lao
762
+ LATIN = :latin
763
+ LATVIAN = :latvian
764
+ LINGALA = :lingala
765
+ LITHUANIAN = :lithuanian
766
+ LUXEMBOURGISH = :luxembourgish
767
+ MACEDONIAN = :macedonian
768
+ MALAGASY = :malagasy
769
+ MALAY = :malay
770
+ MALAYALAM = :malayalam
771
+ MALTESE = :maltese
772
+ MAORI = :maori
773
+ MARATHI = :marathi
774
+ MONGOLIAN = :mongolian
775
+ NEPALI = :nepali
776
+ NORWEGIAN = :norwegian
777
+ ODIA = :odia
778
+ OROMO = :oromo
779
+ PASHTO = :pashto
780
+ PIDGIN = :pidgin
781
+ POLISH = :polish
782
+ PORTUGUESE = :portuguese
783
+ PUNJABI = :punjabi
784
+ QUECHUA = :quechua
785
+ ROMANIAN = :romanian
786
+ RUSSIAN = :russian
787
+ SAMOAN = :samoan
788
+ SCOTTISH_GAELIC = :"scottish-gaelic"
789
+ SERBIAN = :serbian
790
+ SESOTHO = :sesotho
791
+ SHONA = :shona
792
+ SINDHI = :sindhi
793
+ SINHALA = :sinhala
794
+ SLOVAK = :slovak
795
+ SLOVENE = :slovene
796
+ SOMALI = :somali
797
+ SPANISH = :spanish
798
+ SUNDANESE = :sundanese
799
+ SWAHILI = :swahili
800
+ SWEDISH = :swedish
801
+ TAGALOG = :tagalog
802
+ TAJIK = :tajik
803
+ TAMIL = :tamil
804
+ TATAR = :tatar
805
+ TELUGU = :telugu
806
+ THAI = :thai
807
+ TIBETAN = :tibetan
808
+ TIGRINYA = :tigrinya
809
+ TONGAN = :tongan
810
+ TSWANA = :tswana
811
+ TURKISH = :turkish
812
+ TURKMEN = :turkmen
813
+ UKRAINIAN = :ukrainian
814
+ URDU = :urdu
815
+ UYGHUR = :uyghur
816
+ UZBEK = :uzbek
817
+ VIETNAMESE = :vietnamese
818
+ WELSH = :welsh
819
+ WOLOF = :wolof
820
+ XHOSA = :xhosa
821
+ YIDDISH = :yiddish
822
+ YORUBA = :yoruba
823
+ ZULU = :zulu
824
+
825
+ # @!method self.values
826
+ # @return [Array<Symbol>]
827
+ end
828
+ end
829
+
830
+ class ByDirectURL < ContextDev::Internal::Type::BaseModel
831
+ # @!attribute direct_url
832
+ # Full http(s) URL to fetch brand data from (e.g.,
833
+ # 'https://stripe.com/enterprise'). Only this URL is fetched — not the entire
834
+ # internet.
835
+ #
836
+ # @return [String]
837
+ required :direct_url, String
838
+
839
+ # @!attribute type
840
+ # Discriminator for direct-URL-based brand retrieval.
841
+ #
842
+ # @return [Symbol, :by_direct_url]
843
+ required :type, const: :by_direct_url
844
+
845
+ # @!attribute timeout_ms
846
+ # Optional timeout in milliseconds for the request. If the request takes longer
847
+ # than this value, it will be aborted with a 408 status code. Maximum allowed
848
+ # value is 300000ms (5 minutes).
849
+ #
850
+ # @return [Integer, nil]
851
+ optional :timeout_ms, Integer, api_name: :timeoutMS
852
+
853
+ # @!method initialize(direct_url:, timeout_ms: nil, type: :by_direct_url)
854
+ # Some parameter documentations has been truncated, see
855
+ # {ContextDev::Models::BrandRetrieveParams::Body::ByDirectURL} for more details.
856
+ #
857
+ # Retrieve brand data by fetching the provided URL directly. Note: if you use
858
+ # this, brand data is fetched only from the provided URL — not from the entire
859
+ # internet — so results are limited to what that single page contains. No domain
860
+ # resolution, database lookup, or cross-source enrichment is performed. Cannot be
861
+ # combined with domain, name, email, or ticker.
862
+ #
863
+ # @param direct_url [String] Full http(s) URL to fetch brand data from (e.g., 'https://stripe.com/enterprise'
864
+ #
865
+ # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
866
+ #
867
+ # @param type [Symbol, :by_direct_url] Discriminator for direct-URL-based brand retrieval.
868
+ end
869
+
870
+ class ByTransaction < ContextDev::Internal::Type::BaseModel
871
+ # @!attribute transaction_info
872
+ # Transaction information to identify the brand.
873
+ #
874
+ # @return [String]
875
+ required :transaction_info, String
876
+
877
+ # @!attribute type
878
+ # Discriminator for transaction-based brand retrieval.
879
+ #
880
+ # @return [Symbol, :by_transaction]
881
+ required :type, const: :by_transaction
882
+
883
+ # @!attribute city
884
+ # Optional city name to prioritize when searching for the brand.
885
+ #
886
+ # @return [String, nil]
887
+ optional :city, String
888
+
889
+ # @!attribute country_gl
890
+ # Optional country code hint (GL parameter) to specify the country when
891
+ # identifying a transaction.
892
+ #
893
+ # @return [String, nil]
894
+ optional :country_gl, String
895
+
896
+ # @!attribute force_language
897
+ #
898
+ # @return [Symbol, ContextDev::Models::BrandRetrieveParams::Body::ByTransaction::ForceLanguage, nil]
899
+ optional :force_language, enum: -> { ContextDev::BrandRetrieveParams::Body::ByTransaction::ForceLanguage }
900
+
901
+ # @!attribute high_confidence_only
902
+ # When set to true, the API performs additional verification to ensure the
903
+ # identified brand matches the transaction with high confidence.
904
+ #
905
+ # @return [Boolean, nil]
906
+ optional :high_confidence_only, ContextDev::Internal::Type::Boolean
907
+
908
+ # @!attribute max_speed
909
+ # Optional parameter to optimize the API call for maximum speed. When set to true,
910
+ # the API will skip time-consuming operations for faster response at the cost of
911
+ # less comprehensive data.
912
+ #
913
+ # @return [Boolean, nil]
914
+ optional :max_speed, ContextDev::Internal::Type::Boolean, api_name: :maxSpeed
915
+
916
+ # @!attribute mcc
917
+ # Optional Merchant Category Code (MCC) to help identify the business category or
918
+ # industry.
919
+ #
920
+ # @return [Integer, nil]
921
+ optional :mcc, Integer
922
+
923
+ # @!attribute phone
924
+ # Optional phone number from the transaction to help verify brand match.
925
+ #
926
+ # @return [Float, nil]
927
+ optional :phone, Float
928
+
929
+ # @!attribute timeout_ms
930
+ # Optional timeout in milliseconds for the request. If the request takes longer
931
+ # than this value, it will be aborted with a 408 status code. Maximum allowed
932
+ # value is 300000ms (5 minutes).
933
+ #
934
+ # @return [Integer, nil]
935
+ optional :timeout_ms, Integer, api_name: :timeoutMS
936
+
937
+ # @!method initialize(transaction_info:, city: nil, country_gl: nil, force_language: nil, high_confidence_only: nil, max_speed: nil, mcc: nil, phone: nil, timeout_ms: nil, type: :by_transaction)
938
+ # Some parameter documentations has been truncated, see
939
+ # {ContextDev::Models::BrandRetrieveParams::Body::ByTransaction} for more details.
940
+ #
941
+ # Identify brand data from a transaction descriptor. Cannot be combined with
942
+ # domain, name, email, or ticker.
943
+ #
944
+ # @param transaction_info [String] Transaction information to identify the brand.
945
+ #
946
+ # @param city [String] Optional city name to prioritize when searching for the brand.
947
+ #
948
+ # @param country_gl [String] Optional country code hint (GL parameter) to specify the country when identifyin
949
+ #
950
+ # @param force_language [Symbol, ContextDev::Models::BrandRetrieveParams::Body::ByTransaction::ForceLanguage]
951
+ #
952
+ # @param high_confidence_only [Boolean] When set to true, the API performs additional verification to ensure the identif
953
+ #
954
+ # @param max_speed [Boolean] Optional parameter to optimize the API call for maximum speed. When set to true,
955
+ #
956
+ # @param mcc [Integer] Optional Merchant Category Code (MCC) to help identify the business category or
957
+ #
958
+ # @param phone [Float] Optional phone number from the transaction to help verify brand match.
959
+ #
960
+ # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
961
+ #
962
+ # @param type [Symbol, :by_transaction] Discriminator for transaction-based brand retrieval.
963
+
964
+ # @see ContextDev::Models::BrandRetrieveParams::Body::ByTransaction#force_language
965
+ module ForceLanguage
966
+ extend ContextDev::Internal::Type::Enum
967
+
968
+ AFRIKAANS = :afrikaans
969
+ ALBANIAN = :albanian
970
+ AMHARIC = :amharic
971
+ ARABIC = :arabic
972
+ ARMENIAN = :armenian
973
+ ASSAMESE = :assamese
974
+ AYMARA = :aymara
975
+ AZERI = :azeri
976
+ BASQUE = :basque
977
+ BELARUSIAN = :belarusian
978
+ BENGALI = :bengali
979
+ BOSNIAN = :bosnian
980
+ BULGARIAN = :bulgarian
981
+ BURMESE = :burmese
982
+ CANTONESE = :cantonese
983
+ CATALAN = :catalan
984
+ CEBUANO = :cebuano
985
+ CHINESE = :chinese
986
+ CORSICAN = :corsican
987
+ CROATIAN = :croatian
988
+ CZECH = :czech
989
+ DANISH = :danish
990
+ DUTCH = :dutch
991
+ ENGLISH = :english
992
+ ESPERANTO = :esperanto
993
+ ESTONIAN = :estonian
994
+ FARSI = :farsi
995
+ FIJIAN = :fijian
996
+ FINNISH = :finnish
997
+ FRENCH = :french
998
+ GALICIAN = :galician
999
+ GEORGIAN = :georgian
1000
+ GERMAN = :german
1001
+ GREEK = :greek
1002
+ GUARANI = :guarani
1003
+ GUJARATI = :gujarati
1004
+ HAITIAN_CREOLE = :"haitian-creole"
1005
+ HAUSA = :hausa
1006
+ HAWAIIAN = :hawaiian
1007
+ HEBREW = :hebrew
1008
+ HINDI = :hindi
1009
+ HMONG = :hmong
1010
+ HUNGARIAN = :hungarian
1011
+ ICELANDIC = :icelandic
1012
+ IGBO = :igbo
1013
+ INDONESIAN = :indonesian
1014
+ IRISH = :irish
1015
+ ITALIAN = :italian
1016
+ JAPANESE = :japanese
1017
+ JAVANESE = :javanese
1018
+ KANNADA = :kannada
1019
+ KAZAKH = :kazakh
1020
+ KHMER = :khmer
1021
+ KINYARWANDA = :kinyarwanda
1022
+ KOREAN = :korean
1023
+ KURDISH = :kurdish
1024
+ KYRGYZ = :kyrgyz
1025
+ LAO = :lao
1026
+ LATIN = :latin
1027
+ LATVIAN = :latvian
1028
+ LINGALA = :lingala
1029
+ LITHUANIAN = :lithuanian
1030
+ LUXEMBOURGISH = :luxembourgish
1031
+ MACEDONIAN = :macedonian
1032
+ MALAGASY = :malagasy
1033
+ MALAY = :malay
1034
+ MALAYALAM = :malayalam
1035
+ MALTESE = :maltese
1036
+ MAORI = :maori
1037
+ MARATHI = :marathi
1038
+ MONGOLIAN = :mongolian
1039
+ NEPALI = :nepali
1040
+ NORWEGIAN = :norwegian
1041
+ ODIA = :odia
1042
+ OROMO = :oromo
1043
+ PASHTO = :pashto
1044
+ PIDGIN = :pidgin
1045
+ POLISH = :polish
1046
+ PORTUGUESE = :portuguese
1047
+ PUNJABI = :punjabi
1048
+ QUECHUA = :quechua
1049
+ ROMANIAN = :romanian
1050
+ RUSSIAN = :russian
1051
+ SAMOAN = :samoan
1052
+ SCOTTISH_GAELIC = :"scottish-gaelic"
1053
+ SERBIAN = :serbian
1054
+ SESOTHO = :sesotho
1055
+ SHONA = :shona
1056
+ SINDHI = :sindhi
1057
+ SINHALA = :sinhala
1058
+ SLOVAK = :slovak
1059
+ SLOVENE = :slovene
1060
+ SOMALI = :somali
1061
+ SPANISH = :spanish
1062
+ SUNDANESE = :sundanese
1063
+ SWAHILI = :swahili
1064
+ SWEDISH = :swedish
1065
+ TAGALOG = :tagalog
1066
+ TAJIK = :tajik
1067
+ TAMIL = :tamil
1068
+ TATAR = :tatar
1069
+ TELUGU = :telugu
1070
+ THAI = :thai
1071
+ TIBETAN = :tibetan
1072
+ TIGRINYA = :tigrinya
1073
+ TONGAN = :tongan
1074
+ TSWANA = :tswana
1075
+ TURKISH = :turkish
1076
+ TURKMEN = :turkmen
1077
+ UKRAINIAN = :ukrainian
1078
+ URDU = :urdu
1079
+ UYGHUR = :uyghur
1080
+ UZBEK = :uzbek
1081
+ VIETNAMESE = :vietnamese
1082
+ WELSH = :welsh
1083
+ WOLOF = :wolof
1084
+ XHOSA = :xhosa
1085
+ YIDDISH = :yiddish
1086
+ YORUBA = :yoruba
1087
+ ZULU = :zulu
1088
+
1089
+ # @!method self.values
1090
+ # @return [Array<Symbol>]
1091
+ end
1092
+ end
63
1093
 
64
- # Optional parameter to force the language of the retrieved brand data.
65
- module ForceLanguage
66
- extend ContextDev::Internal::Type::Enum
67
-
68
- AFRIKAANS = :afrikaans
69
- ALBANIAN = :albanian
70
- AMHARIC = :amharic
71
- ARABIC = :arabic
72
- ARMENIAN = :armenian
73
- ASSAMESE = :assamese
74
- AYMARA = :aymara
75
- AZERI = :azeri
76
- BASQUE = :basque
77
- BELARUSIAN = :belarusian
78
- BENGALI = :bengali
79
- BOSNIAN = :bosnian
80
- BULGARIAN = :bulgarian
81
- BURMESE = :burmese
82
- CANTONESE = :cantonese
83
- CATALAN = :catalan
84
- CEBUANO = :cebuano
85
- CHINESE = :chinese
86
- CORSICAN = :corsican
87
- CROATIAN = :croatian
88
- CZECH = :czech
89
- DANISH = :danish
90
- DUTCH = :dutch
91
- ENGLISH = :english
92
- ESPERANTO = :esperanto
93
- ESTONIAN = :estonian
94
- FARSI = :farsi
95
- FIJIAN = :fijian
96
- FINNISH = :finnish
97
- FRENCH = :french
98
- GALICIAN = :galician
99
- GEORGIAN = :georgian
100
- GERMAN = :german
101
- GREEK = :greek
102
- GUARANI = :guarani
103
- GUJARATI = :gujarati
104
- HAITIAN_CREOLE = :"haitian-creole"
105
- HAUSA = :hausa
106
- HAWAIIAN = :hawaiian
107
- HEBREW = :hebrew
108
- HINDI = :hindi
109
- HMONG = :hmong
110
- HUNGARIAN = :hungarian
111
- ICELANDIC = :icelandic
112
- IGBO = :igbo
113
- INDONESIAN = :indonesian
114
- IRISH = :irish
115
- ITALIAN = :italian
116
- JAPANESE = :japanese
117
- JAVANESE = :javanese
118
- KANNADA = :kannada
119
- KAZAKH = :kazakh
120
- KHMER = :khmer
121
- KINYARWANDA = :kinyarwanda
122
- KOREAN = :korean
123
- KURDISH = :kurdish
124
- KYRGYZ = :kyrgyz
125
- LAO = :lao
126
- LATIN = :latin
127
- LATVIAN = :latvian
128
- LINGALA = :lingala
129
- LITHUANIAN = :lithuanian
130
- LUXEMBOURGISH = :luxembourgish
131
- MACEDONIAN = :macedonian
132
- MALAGASY = :malagasy
133
- MALAY = :malay
134
- MALAYALAM = :malayalam
135
- MALTESE = :maltese
136
- MAORI = :maori
137
- MARATHI = :marathi
138
- MONGOLIAN = :mongolian
139
- NEPALI = :nepali
140
- NORWEGIAN = :norwegian
141
- ODIA = :odia
142
- OROMO = :oromo
143
- PASHTO = :pashto
144
- PIDGIN = :pidgin
145
- POLISH = :polish
146
- PORTUGUESE = :portuguese
147
- PUNJABI = :punjabi
148
- QUECHUA = :quechua
149
- ROMANIAN = :romanian
150
- RUSSIAN = :russian
151
- SAMOAN = :samoan
152
- SCOTTISH_GAELIC = :"scottish-gaelic"
153
- SERBIAN = :serbian
154
- SESOTHO = :sesotho
155
- SHONA = :shona
156
- SINDHI = :sindhi
157
- SINHALA = :sinhala
158
- SLOVAK = :slovak
159
- SLOVENE = :slovene
160
- SOMALI = :somali
161
- SPANISH = :spanish
162
- SUNDANESE = :sundanese
163
- SWAHILI = :swahili
164
- SWEDISH = :swedish
165
- TAGALOG = :tagalog
166
- TAJIK = :tajik
167
- TAMIL = :tamil
168
- TATAR = :tatar
169
- TELUGU = :telugu
170
- THAI = :thai
171
- TIBETAN = :tibetan
172
- TIGRINYA = :tigrinya
173
- TONGAN = :tongan
174
- TSWANA = :tswana
175
- TURKISH = :turkish
176
- TURKMEN = :turkmen
177
- UKRAINIAN = :ukrainian
178
- URDU = :urdu
179
- UYGHUR = :uyghur
180
- UZBEK = :uzbek
181
- VIETNAMESE = :vietnamese
182
- WELSH = :welsh
183
- WOLOF = :wolof
184
- XHOSA = :xhosa
185
- YIDDISH = :yiddish
186
- YORUBA = :yoruba
187
- ZULU = :zulu
188
-
189
- # @!method self.values
190
- # @return [Array<Symbol>]
1094
+ # @!method self.variants
1095
+ # @return [Array(ContextDev::Models::BrandRetrieveParams::Body::ByDomain, ContextDev::Models::BrandRetrieveParams::Body::ByName, ContextDev::Models::BrandRetrieveParams::Body::ByEmail, ContextDev::Models::BrandRetrieveParams::Body::ByTicker, ContextDev::Models::BrandRetrieveParams::Body::ByDirectURL, ContextDev::Models::BrandRetrieveParams::Body::ByTransaction)]
191
1096
  end
192
1097
  end
193
1098
  end