context.dev 2.4.0 → 2.6.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 (187) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +29 -0
  3. data/README.md +1 -1
  4. data/lib/context_dev/client.rb +4 -0
  5. data/lib/context_dev/models/ai_extract_product_params.rb +9 -1
  6. data/lib/context_dev/models/ai_extract_products_params.rb +18 -2
  7. data/lib/context_dev/models/batch_cancel_params.rb +22 -0
  8. data/lib/context_dev/models/batch_cancel_response.rb +354 -0
  9. data/lib/context_dev/models/batch_get_results_params.rb +42 -0
  10. data/lib/context_dev/models/batch_get_results_response.rb +463 -0
  11. data/lib/context_dev/models/batch_list_params.rb +94 -0
  12. data/lib/context_dev/models/batch_list_response.rb +388 -0
  13. data/lib/context_dev/models/batch_retrieve_params.rb +22 -0
  14. data/lib/context_dev/models/batch_retrieve_response.rb +390 -0
  15. data/lib/context_dev/models/batch_submit_params.rb +56 -0
  16. data/lib/context_dev/models/batch_submit_response.rb +614 -0
  17. data/lib/context_dev/models/brand_retrieve_params.rb +109 -22
  18. data/lib/context_dev/models/brand_retrieve_response.rb +4 -6
  19. data/lib/context_dev/models/brand_retrieve_simplified_params.rb +32 -3
  20. data/lib/context_dev/models/error.rb +26 -0
  21. data/lib/context_dev/models/error_count.rb +26 -0
  22. data/lib/context_dev/models/industry_retrieve_naics_params.rb +11 -1
  23. data/lib/context_dev/models/industry_retrieve_sic_params.rb +11 -1
  24. data/lib/context_dev/models/monitor_create_params.rb +147 -132
  25. data/lib/context_dev/models/monitor_create_response.rb +40 -15
  26. data/lib/context_dev/models/monitor_get_credit_usage_params.rb +30 -0
  27. data/lib/context_dev/models/monitor_get_credit_usage_response.rb +59 -0
  28. data/lib/context_dev/models/monitor_get_limits_params.rb +14 -0
  29. data/lib/context_dev/models/monitor_get_limits_response.rb +52 -0
  30. data/lib/context_dev/models/monitor_list_account_changes_params.rb +16 -7
  31. data/lib/context_dev/models/monitor_list_account_changes_response.rb +2 -1
  32. data/lib/context_dev/models/monitor_list_account_runs_params.rb +7 -10
  33. data/lib/context_dev/models/monitor_list_changes_params.rb +8 -4
  34. data/lib/context_dev/models/monitor_list_changes_response.rb +2 -1
  35. data/lib/context_dev/models/monitor_list_params.rb +18 -19
  36. data/lib/context_dev/models/monitor_list_response.rb +27 -12
  37. data/lib/context_dev/models/monitor_list_runs_params.rb +7 -10
  38. data/lib/context_dev/models/monitor_retrieve_change_response.rb +2 -1
  39. data/lib/context_dev/models/monitor_retrieve_response.rb +27 -12
  40. data/lib/context_dev/models/monitor_update_params.rb +27 -12
  41. data/lib/context_dev/models/monitor_update_response.rb +27 -12
  42. data/lib/context_dev/models/parse_handle_params.rb +199 -33
  43. data/lib/context_dev/models/utility_prefetch_params.rb +9 -1
  44. data/lib/context_dev/models/web_extract_competitors_params.rb +11 -1
  45. data/lib/context_dev/models/web_extract_fonts_params.rb +14 -4
  46. data/lib/context_dev/models/web_extract_params.rb +19 -1
  47. data/lib/context_dev/models/web_extract_styleguide_params.rb +14 -4
  48. data/lib/context_dev/models/web_screenshot_params.rb +69 -18
  49. data/lib/context_dev/models/web_screenshot_response.rb +3 -2
  50. data/lib/context_dev/models/web_search_params.rb +9 -1
  51. data/lib/context_dev/models/web_web_crawl_md_params.rb +34 -1
  52. data/lib/context_dev/models/web_web_scrape_html_params.rb +268 -29
  53. data/lib/context_dev/models/web_web_scrape_html_response.rb +93 -1
  54. data/lib/context_dev/models/web_web_scrape_images_params.rb +208 -19
  55. data/lib/context_dev/models/web_web_scrape_md_params.rb +352 -38
  56. data/lib/context_dev/models/web_web_scrape_md_response.rb +93 -1
  57. data/lib/context_dev/models/web_web_scrape_sitemap_params.rb +45 -1
  58. data/lib/context_dev/models.rb +18 -0
  59. data/lib/context_dev/resources/ai.rb +3 -1
  60. data/lib/context_dev/resources/batch.rb +155 -0
  61. data/lib/context_dev/resources/brand.rb +6 -2
  62. data/lib/context_dev/resources/industry.rb +6 -2
  63. data/lib/context_dev/resources/monitors.rb +75 -37
  64. data/lib/context_dev/resources/parse.rb +15 -11
  65. data/lib/context_dev/resources/utility.rb +3 -1
  66. data/lib/context_dev/resources/web.rb +104 -55
  67. data/lib/context_dev/version.rb +1 -1
  68. data/lib/context_dev.rb +17 -0
  69. data/rbi/context_dev/client.rbi +3 -0
  70. data/rbi/context_dev/models/ai_extract_product_params.rbi +11 -0
  71. data/rbi/context_dev/models/ai_extract_products_params.rbi +22 -0
  72. data/rbi/context_dev/models/batch_cancel_params.rbi +40 -0
  73. data/rbi/context_dev/models/batch_cancel_response.rbi +642 -0
  74. data/rbi/context_dev/models/batch_get_results_params.rbi +70 -0
  75. data/rbi/context_dev/models/batch_get_results_response.rbi +848 -0
  76. data/rbi/context_dev/models/batch_list_params.rbi +166 -0
  77. data/rbi/context_dev/models/batch_list_response.rbi +738 -0
  78. data/rbi/context_dev/models/batch_retrieve_params.rbi +40 -0
  79. data/rbi/context_dev/models/batch_retrieve_response.rbi +707 -0
  80. data/rbi/context_dev/models/batch_submit_params.rbi +105 -0
  81. data/rbi/context_dev/models/batch_submit_response.rbi +1330 -0
  82. data/rbi/context_dev/models/brand_retrieve_params.rbi +175 -64
  83. data/rbi/context_dev/models/brand_retrieve_response.rbi +8 -11
  84. data/rbi/context_dev/models/brand_retrieve_simplified_params.rbi +68 -5
  85. data/rbi/context_dev/models/error.rbi +32 -0
  86. data/rbi/context_dev/models/error_count.rbi +34 -0
  87. data/rbi/context_dev/models/industry_retrieve_naics_params.rbi +15 -0
  88. data/rbi/context_dev/models/industry_retrieve_sic_params.rbi +15 -0
  89. data/rbi/context_dev/models/monitor_create_params.rbi +280 -246
  90. data/rbi/context_dev/models/monitor_create_response.rbi +44 -11
  91. data/rbi/context_dev/models/monitor_get_credit_usage_params.rbi +60 -0
  92. data/rbi/context_dev/models/monitor_get_credit_usage_response.rbi +111 -0
  93. data/rbi/context_dev/models/monitor_get_limits_params.rbi +30 -0
  94. data/rbi/context_dev/models/monitor_get_limits_response.rbi +105 -0
  95. data/rbi/context_dev/models/monitor_list_account_changes_params.rbi +16 -0
  96. data/rbi/context_dev/models/monitor_list_account_changes_response.rbi +2 -0
  97. data/rbi/context_dev/models/monitor_list_account_runs_params.rbi +7 -6
  98. data/rbi/context_dev/models/monitor_list_changes_params.rbi +8 -0
  99. data/rbi/context_dev/models/monitor_list_changes_response.rbi +2 -0
  100. data/rbi/context_dev/models/monitor_list_params.rbi +23 -31
  101. data/rbi/context_dev/models/monitor_list_response.rbi +30 -9
  102. data/rbi/context_dev/models/monitor_list_runs_params.rbi +7 -6
  103. data/rbi/context_dev/models/monitor_retrieve_change_response.rbi +2 -0
  104. data/rbi/context_dev/models/monitor_retrieve_response.rbi +30 -9
  105. data/rbi/context_dev/models/monitor_update_params.rbi +30 -9
  106. data/rbi/context_dev/models/monitor_update_response.rbi +30 -9
  107. data/rbi/context_dev/models/parse_handle_params.rbi +400 -46
  108. data/rbi/context_dev/models/utility_prefetch_params.rbi +11 -0
  109. data/rbi/context_dev/models/web_extract_competitors_params.rbi +15 -0
  110. data/rbi/context_dev/models/web_extract_fonts_params.rbi +19 -7
  111. data/rbi/context_dev/models/web_extract_params.rbi +26 -0
  112. data/rbi/context_dev/models/web_extract_styleguide_params.rbi +19 -7
  113. data/rbi/context_dev/models/web_screenshot_params.rbi +108 -37
  114. data/rbi/context_dev/models/web_screenshot_response.rbi +4 -2
  115. data/rbi/context_dev/models/web_search_params.rbi +11 -0
  116. data/rbi/context_dev/models/web_web_crawl_md_params.rbi +53 -0
  117. data/rbi/context_dev/models/web_web_scrape_html_params.rbi +554 -49
  118. data/rbi/context_dev/models/web_web_scrape_html_response.rbi +182 -0
  119. data/rbi/context_dev/models/web_web_scrape_images_params.rbi +426 -30
  120. data/rbi/context_dev/models/web_web_scrape_md_params.rbi +742 -61
  121. data/rbi/context_dev/models/web_web_scrape_md_response.rbi +180 -0
  122. data/rbi/context_dev/models/web_web_scrape_sitemap_params.rbi +82 -0
  123. data/rbi/context_dev/models.rbi +18 -0
  124. data/rbi/context_dev/resources/ai.rbi +3 -0
  125. data/rbi/context_dev/resources/batch.rbi +120 -0
  126. data/rbi/context_dev/resources/brand.rbi +9 -1
  127. data/rbi/context_dev/resources/industry.rbi +10 -0
  128. data/rbi/context_dev/resources/monitors.rbi +67 -23
  129. data/rbi/context_dev/resources/parse.rbi +46 -19
  130. data/rbi/context_dev/resources/utility.rbi +3 -0
  131. data/rbi/context_dev/resources/web.rbi +224 -48
  132. data/sig/context_dev/client.rbs +2 -0
  133. data/sig/context_dev/models/ai_extract_product_params.rbs +12 -1
  134. data/sig/context_dev/models/ai_extract_products_params.rbs +14 -0
  135. data/sig/context_dev/models/batch_cancel_params.rbs +23 -0
  136. data/sig/context_dev/models/batch_cancel_response.rbs +266 -0
  137. data/sig/context_dev/models/batch_get_results_params.rbs +36 -0
  138. data/sig/context_dev/models/batch_get_results_response.rbs +399 -0
  139. data/sig/context_dev/models/batch_list_params.rbs +94 -0
  140. data/sig/context_dev/models/batch_list_response.rbs +304 -0
  141. data/sig/context_dev/models/batch_retrieve_params.rbs +23 -0
  142. data/sig/context_dev/models/batch_retrieve_response.rbs +290 -0
  143. data/sig/context_dev/models/batch_submit_params.rbs +52 -0
  144. data/sig/context_dev/models/batch_submit_response.rbs +542 -0
  145. data/sig/context_dev/models/brand_retrieve_params.rbs +97 -51
  146. data/sig/context_dev/models/brand_retrieve_response.rbs +2 -2
  147. data/sig/context_dev/models/brand_retrieve_simplified_params.rbs +34 -5
  148. data/sig/context_dev/models/error.rbs +15 -0
  149. data/sig/context_dev/models/error_count.rbs +15 -0
  150. data/sig/context_dev/models/industry_retrieve_naics_params.rbs +7 -0
  151. data/sig/context_dev/models/industry_retrieve_sic_params.rbs +7 -0
  152. data/sig/context_dev/models/monitor_create_params.rbs +117 -97
  153. data/sig/context_dev/models/monitor_create_response.rbs +18 -1
  154. data/sig/context_dev/models/monitor_get_credit_usage_params.rbs +32 -0
  155. data/sig/context_dev/models/monitor_get_credit_usage_response.rbs +52 -0
  156. data/sig/context_dev/models/monitor_get_limits_params.rbs +15 -0
  157. data/sig/context_dev/models/monitor_get_limits_response.rbs +43 -0
  158. data/sig/context_dev/models/monitor_list_params.rbs +8 -14
  159. data/sig/context_dev/models/monitor_list_response.rbs +13 -1
  160. data/sig/context_dev/models/monitor_retrieve_response.rbs +13 -1
  161. data/sig/context_dev/models/monitor_update_params.rbs +13 -1
  162. data/sig/context_dev/models/monitor_update_response.rbs +13 -1
  163. data/sig/context_dev/models/parse_handle_params.rbs +124 -25
  164. data/sig/context_dev/models/utility_prefetch_params.rbs +7 -0
  165. data/sig/context_dev/models/web_extract_competitors_params.rbs +12 -1
  166. data/sig/context_dev/models/web_extract_fonts_params.rbs +10 -5
  167. data/sig/context_dev/models/web_extract_params.rbs +14 -0
  168. data/sig/context_dev/models/web_extract_styleguide_params.rbs +10 -5
  169. data/sig/context_dev/models/web_screenshot_params.rbs +41 -20
  170. data/sig/context_dev/models/web_search_params.rbs +7 -0
  171. data/sig/context_dev/models/web_web_crawl_md_params.rbs +28 -1
  172. data/sig/context_dev/models/web_web_scrape_html_params.rbs +175 -47
  173. data/sig/context_dev/models/web_web_scrape_html_response.rbs +85 -0
  174. data/sig/context_dev/models/web_web_scrape_images_params.rbs +128 -38
  175. data/sig/context_dev/models/web_web_scrape_md_params.rbs +229 -62
  176. data/sig/context_dev/models/web_web_scrape_md_response.rbs +85 -0
  177. data/sig/context_dev/models/web_web_scrape_sitemap_params.rbs +35 -1
  178. data/sig/context_dev/models.rbs +18 -0
  179. data/sig/context_dev/resources/ai.rbs +1 -0
  180. data/sig/context_dev/resources/batch.rbs +41 -0
  181. data/sig/context_dev/resources/brand.rbs +3 -1
  182. data/sig/context_dev/resources/industry.rbs +2 -0
  183. data/sig/context_dev/resources/monitors.rbs +14 -4
  184. data/sig/context_dev/resources/parse.rbs +8 -5
  185. data/sig/context_dev/resources/utility.rbs +1 -0
  186. data/sig/context_dev/resources/web.rbs +47 -26
  187. metadata +53 -2
@@ -106,15 +106,7 @@ module ContextDev
106
106
  )
107
107
  )
108
108
  end
109
- attr_reader :force_language
110
-
111
- sig do
112
- params(
113
- force_language:
114
- ContextDev::BrandRetrieveParams::Body::ByDomain::ForceLanguage::OrSymbol
115
- ).void
116
- end
117
- attr_writer :force_language
109
+ attr_accessor :force_language
118
110
 
119
111
  # Maximum age in milliseconds for cached brand data before the API performs a hard
120
112
  # refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms)
@@ -135,6 +127,13 @@ module ContextDev
135
127
  sig { params(max_speed: T::Boolean).void }
136
128
  attr_writer :max_speed
137
129
 
130
+ # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
131
+ sig { returns(T.nilable(T::Array[String])) }
132
+ attr_reader :tags
133
+
134
+ sig { params(tags: T::Array[String]).void }
135
+ attr_writer :tags
136
+
138
137
  # Optional timeout in milliseconds for the request. If the request takes longer
139
138
  # than this value, it will be aborted with a 408 status code. Maximum allowed
140
139
  # value is 300000ms (5 minutes).
@@ -149,9 +148,12 @@ module ContextDev
149
148
  params(
150
149
  domain: String,
151
150
  force_language:
152
- ContextDev::BrandRetrieveParams::Body::ByDomain::ForceLanguage::OrSymbol,
151
+ T.nilable(
152
+ ContextDev::BrandRetrieveParams::Body::ByDomain::ForceLanguage::OrSymbol
153
+ ),
153
154
  max_age_ms: Integer,
154
155
  max_speed: T::Boolean,
156
+ tags: T::Array[String],
155
157
  timeout_ms: Integer,
156
158
  type: Symbol
157
159
  ).returns(T.attached_class)
@@ -169,6 +171,8 @@ module ContextDev
169
171
  # the API will skip time-consuming operations for faster response at the cost of
170
172
  # less comprehensive data.
171
173
  max_speed: nil,
174
+ # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
175
+ tags: nil,
172
176
  # Optional timeout in milliseconds for the request. If the request takes longer
173
177
  # than this value, it will be aborted with a 408 status code. Maximum allowed
174
178
  # value is 300000ms (5 minutes).
@@ -184,9 +188,12 @@ module ContextDev
184
188
  domain: String,
185
189
  type: Symbol,
186
190
  force_language:
187
- ContextDev::BrandRetrieveParams::Body::ByDomain::ForceLanguage::OrSymbol,
191
+ T.nilable(
192
+ ContextDev::BrandRetrieveParams::Body::ByDomain::ForceLanguage::OrSymbol
193
+ ),
188
194
  max_age_ms: Integer,
189
195
  max_speed: T::Boolean,
196
+ tags: T::Array[String],
190
197
  timeout_ms: Integer
191
198
  }
192
199
  )
@@ -851,15 +858,7 @@ module ContextDev
851
858
  )
852
859
  )
853
860
  end
854
- attr_reader :force_language
855
-
856
- sig do
857
- params(
858
- force_language:
859
- ContextDev::BrandRetrieveParams::Body::ByName::ForceLanguage::OrSymbol
860
- ).void
861
- end
862
- attr_writer :force_language
861
+ attr_accessor :force_language
863
862
 
864
863
  # Maximum age in milliseconds for cached brand data before the API performs a hard
865
864
  # refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms)
@@ -880,6 +879,13 @@ module ContextDev
880
879
  sig { params(max_speed: T::Boolean).void }
881
880
  attr_writer :max_speed
882
881
 
882
+ # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
883
+ sig { returns(T.nilable(T::Array[String])) }
884
+ attr_reader :tags
885
+
886
+ sig { params(tags: T::Array[String]).void }
887
+ attr_writer :tags
888
+
883
889
  # Optional timeout in milliseconds for the request. If the request takes longer
884
890
  # than this value, it will be aborted with a 408 status code. Maximum allowed
885
891
  # value is 300000ms (5 minutes).
@@ -896,9 +902,12 @@ module ContextDev
896
902
  name: String,
897
903
  country_gl: String,
898
904
  force_language:
899
- ContextDev::BrandRetrieveParams::Body::ByName::ForceLanguage::OrSymbol,
905
+ T.nilable(
906
+ ContextDev::BrandRetrieveParams::Body::ByName::ForceLanguage::OrSymbol
907
+ ),
900
908
  max_age_ms: Integer,
901
909
  max_speed: T::Boolean,
910
+ tags: T::Array[String],
902
911
  timeout_ms: Integer,
903
912
  type: Symbol
904
913
  ).returns(T.attached_class)
@@ -919,6 +928,8 @@ module ContextDev
919
928
  # the API will skip time-consuming operations for faster response at the cost of
920
929
  # less comprehensive data.
921
930
  max_speed: nil,
931
+ # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
932
+ tags: nil,
922
933
  # Optional timeout in milliseconds for the request. If the request takes longer
923
934
  # than this value, it will be aborted with a 408 status code. Maximum allowed
924
935
  # value is 300000ms (5 minutes).
@@ -935,9 +946,12 @@ module ContextDev
935
946
  type: Symbol,
936
947
  country_gl: String,
937
948
  force_language:
938
- ContextDev::BrandRetrieveParams::Body::ByName::ForceLanguage::OrSymbol,
949
+ T.nilable(
950
+ ContextDev::BrandRetrieveParams::Body::ByName::ForceLanguage::OrSymbol
951
+ ),
939
952
  max_age_ms: Integer,
940
953
  max_speed: T::Boolean,
954
+ tags: T::Array[String],
941
955
  timeout_ms: Integer
942
956
  }
943
957
  )
@@ -1594,15 +1608,7 @@ module ContextDev
1594
1608
  )
1595
1609
  )
1596
1610
  end
1597
- attr_reader :force_language
1598
-
1599
- sig do
1600
- params(
1601
- force_language:
1602
- ContextDev::BrandRetrieveParams::Body::ByEmail::ForceLanguage::OrSymbol
1603
- ).void
1604
- end
1605
- attr_writer :force_language
1611
+ attr_accessor :force_language
1606
1612
 
1607
1613
  # Maximum age in milliseconds for cached brand data before the API performs a hard
1608
1614
  # refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms)
@@ -1623,6 +1629,13 @@ module ContextDev
1623
1629
  sig { params(max_speed: T::Boolean).void }
1624
1630
  attr_writer :max_speed
1625
1631
 
1632
+ # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
1633
+ sig { returns(T.nilable(T::Array[String])) }
1634
+ attr_reader :tags
1635
+
1636
+ sig { params(tags: T::Array[String]).void }
1637
+ attr_writer :tags
1638
+
1626
1639
  # Optional timeout in milliseconds for the request. If the request takes longer
1627
1640
  # than this value, it will be aborted with a 408 status code. Maximum allowed
1628
1641
  # value is 300000ms (5 minutes).
@@ -1639,9 +1652,12 @@ module ContextDev
1639
1652
  params(
1640
1653
  email: String,
1641
1654
  force_language:
1642
- ContextDev::BrandRetrieveParams::Body::ByEmail::ForceLanguage::OrSymbol,
1655
+ T.nilable(
1656
+ ContextDev::BrandRetrieveParams::Body::ByEmail::ForceLanguage::OrSymbol
1657
+ ),
1643
1658
  max_age_ms: Integer,
1644
1659
  max_speed: T::Boolean,
1660
+ tags: T::Array[String],
1645
1661
  timeout_ms: Integer,
1646
1662
  type: Symbol
1647
1663
  ).returns(T.attached_class)
@@ -1659,6 +1675,8 @@ module ContextDev
1659
1675
  # the API will skip time-consuming operations for faster response at the cost of
1660
1676
  # less comprehensive data.
1661
1677
  max_speed: nil,
1678
+ # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
1679
+ tags: nil,
1662
1680
  # Optional timeout in milliseconds for the request. If the request takes longer
1663
1681
  # than this value, it will be aborted with a 408 status code. Maximum allowed
1664
1682
  # value is 300000ms (5 minutes).
@@ -1674,9 +1692,12 @@ module ContextDev
1674
1692
  email: String,
1675
1693
  type: Symbol,
1676
1694
  force_language:
1677
- ContextDev::BrandRetrieveParams::Body::ByEmail::ForceLanguage::OrSymbol,
1695
+ T.nilable(
1696
+ ContextDev::BrandRetrieveParams::Body::ByEmail::ForceLanguage::OrSymbol
1697
+ ),
1678
1698
  max_age_ms: Integer,
1679
1699
  max_speed: T::Boolean,
1700
+ tags: T::Array[String],
1680
1701
  timeout_ms: Integer
1681
1702
  }
1682
1703
  )
@@ -2333,15 +2354,7 @@ module ContextDev
2333
2354
  )
2334
2355
  )
2335
2356
  end
2336
- attr_reader :force_language
2337
-
2338
- sig do
2339
- params(
2340
- force_language:
2341
- ContextDev::BrandRetrieveParams::Body::ByTicker::ForceLanguage::OrSymbol
2342
- ).void
2343
- end
2344
- attr_writer :force_language
2357
+ attr_accessor :force_language
2345
2358
 
2346
2359
  # Maximum age in milliseconds for cached brand data before the API performs a hard
2347
2360
  # refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms)
@@ -2362,6 +2375,13 @@ module ContextDev
2362
2375
  sig { params(max_speed: T::Boolean).void }
2363
2376
  attr_writer :max_speed
2364
2377
 
2378
+ # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
2379
+ sig { returns(T.nilable(T::Array[String])) }
2380
+ attr_reader :tags
2381
+
2382
+ sig { params(tags: T::Array[String]).void }
2383
+ attr_writer :tags
2384
+
2365
2385
  # Optional stock exchange for the ticker. Defaults to NASDAQ if not specified.
2366
2386
  sig { returns(T.nilable(String)) }
2367
2387
  attr_reader :ticker_exchange
@@ -2384,9 +2404,12 @@ module ContextDev
2384
2404
  params(
2385
2405
  ticker: String,
2386
2406
  force_language:
2387
- ContextDev::BrandRetrieveParams::Body::ByTicker::ForceLanguage::OrSymbol,
2407
+ T.nilable(
2408
+ ContextDev::BrandRetrieveParams::Body::ByTicker::ForceLanguage::OrSymbol
2409
+ ),
2388
2410
  max_age_ms: Integer,
2389
2411
  max_speed: T::Boolean,
2412
+ tags: T::Array[String],
2390
2413
  ticker_exchange: String,
2391
2414
  timeout_ms: Integer,
2392
2415
  type: Symbol
@@ -2405,6 +2428,8 @@ module ContextDev
2405
2428
  # the API will skip time-consuming operations for faster response at the cost of
2406
2429
  # less comprehensive data.
2407
2430
  max_speed: nil,
2431
+ # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
2432
+ tags: nil,
2408
2433
  # Optional stock exchange for the ticker. Defaults to NASDAQ if not specified.
2409
2434
  ticker_exchange: nil,
2410
2435
  # Optional timeout in milliseconds for the request. If the request takes longer
@@ -2422,9 +2447,12 @@ module ContextDev
2422
2447
  ticker: String,
2423
2448
  type: Symbol,
2424
2449
  force_language:
2425
- ContextDev::BrandRetrieveParams::Body::ByTicker::ForceLanguage::OrSymbol,
2450
+ T.nilable(
2451
+ ContextDev::BrandRetrieveParams::Body::ByTicker::ForceLanguage::OrSymbol
2452
+ ),
2426
2453
  max_age_ms: Integer,
2427
2454
  max_speed: T::Boolean,
2455
+ tags: T::Array[String],
2428
2456
  ticker_exchange: String,
2429
2457
  timeout_ms: Integer
2430
2458
  }
@@ -3077,6 +3105,13 @@ module ContextDev
3077
3105
  sig { returns(Symbol) }
3078
3106
  attr_accessor :type
3079
3107
 
3108
+ # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
3109
+ sig { returns(T.nilable(T::Array[String])) }
3110
+ attr_reader :tags
3111
+
3112
+ sig { params(tags: T::Array[String]).void }
3113
+ attr_writer :tags
3114
+
3080
3115
  # Optional timeout in milliseconds for the request. If the request takes longer
3081
3116
  # than this value, it will be aborted with a 408 status code. Maximum allowed
3082
3117
  # value is 300000ms (5 minutes).
@@ -3094,6 +3129,7 @@ module ContextDev
3094
3129
  sig do
3095
3130
  params(
3096
3131
  direct_url: String,
3132
+ tags: T::Array[String],
3097
3133
  timeout_ms: Integer,
3098
3134
  type: Symbol
3099
3135
  ).returns(T.attached_class)
@@ -3103,6 +3139,8 @@ module ContextDev
3103
3139
  # 'https://stripe.com/enterprise'). Only this URL is fetched — not the entire
3104
3140
  # internet.
3105
3141
  direct_url:,
3142
+ # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
3143
+ tags: nil,
3106
3144
  # Optional timeout in milliseconds for the request. If the request takes longer
3107
3145
  # than this value, it will be aborted with a 408 status code. Maximum allowed
3108
3146
  # value is 300000ms (5 minutes).
@@ -3114,7 +3152,12 @@ module ContextDev
3114
3152
 
3115
3153
  sig do
3116
3154
  override.returns(
3117
- { direct_url: String, type: Symbol, timeout_ms: Integer }
3155
+ {
3156
+ direct_url: String,
3157
+ type: Symbol,
3158
+ tags: T::Array[String],
3159
+ timeout_ms: Integer
3160
+ }
3118
3161
  )
3119
3162
  end
3120
3163
  def to_hash
@@ -3160,15 +3203,7 @@ module ContextDev
3160
3203
  )
3161
3204
  )
3162
3205
  end
3163
- attr_reader :force_language
3164
-
3165
- sig do
3166
- params(
3167
- force_language:
3168
- ContextDev::BrandRetrieveParams::Body::ByTransaction::ForceLanguage::OrSymbol
3169
- ).void
3170
- end
3171
- attr_writer :force_language
3206
+ attr_accessor :force_language
3172
3207
 
3173
3208
  # When set to true, the API performs additional verification to ensure the
3174
3209
  # identified brand matches the transaction with high confidence.
@@ -3189,19 +3224,48 @@ module ContextDev
3189
3224
 
3190
3225
  # Optional Merchant Category Code (MCC) to help identify the business category or
3191
3226
  # industry.
3192
- sig { returns(T.nilable(Integer)) }
3227
+ sig do
3228
+ returns(
3229
+ T.nilable(
3230
+ ContextDev::BrandRetrieveParams::Body::ByTransaction::Mcc::Variants
3231
+ )
3232
+ )
3233
+ end
3193
3234
  attr_reader :mcc
3194
3235
 
3195
- sig { params(mcc: Integer).void }
3236
+ sig do
3237
+ params(
3238
+ mcc:
3239
+ ContextDev::BrandRetrieveParams::Body::ByTransaction::Mcc::Variants
3240
+ ).void
3241
+ end
3196
3242
  attr_writer :mcc
3197
3243
 
3198
3244
  # Optional phone number from the transaction to help verify brand match.
3199
- sig { returns(T.nilable(Float)) }
3245
+ sig do
3246
+ returns(
3247
+ T.nilable(
3248
+ ContextDev::BrandRetrieveParams::Body::ByTransaction::Phone::Variants
3249
+ )
3250
+ )
3251
+ end
3200
3252
  attr_reader :phone
3201
3253
 
3202
- sig { params(phone: Float).void }
3254
+ sig do
3255
+ params(
3256
+ phone:
3257
+ ContextDev::BrandRetrieveParams::Body::ByTransaction::Phone::Variants
3258
+ ).void
3259
+ end
3203
3260
  attr_writer :phone
3204
3261
 
3262
+ # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
3263
+ sig { returns(T.nilable(T::Array[String])) }
3264
+ attr_reader :tags
3265
+
3266
+ sig { params(tags: T::Array[String]).void }
3267
+ attr_writer :tags
3268
+
3205
3269
  # Optional timeout in milliseconds for the request. If the request takes longer
3206
3270
  # than this value, it will be aborted with a 408 status code. Maximum allowed
3207
3271
  # value is 300000ms (5 minutes).
@@ -3219,11 +3283,16 @@ module ContextDev
3219
3283
  city: String,
3220
3284
  country_gl: String,
3221
3285
  force_language:
3222
- ContextDev::BrandRetrieveParams::Body::ByTransaction::ForceLanguage::OrSymbol,
3286
+ T.nilable(
3287
+ ContextDev::BrandRetrieveParams::Body::ByTransaction::ForceLanguage::OrSymbol
3288
+ ),
3223
3289
  high_confidence_only: T::Boolean,
3224
3290
  max_speed: T::Boolean,
3225
- mcc: Integer,
3226
- phone: Float,
3291
+ mcc:
3292
+ ContextDev::BrandRetrieveParams::Body::ByTransaction::Mcc::Variants,
3293
+ phone:
3294
+ ContextDev::BrandRetrieveParams::Body::ByTransaction::Phone::Variants,
3295
+ tags: T::Array[String],
3227
3296
  timeout_ms: Integer,
3228
3297
  type: Symbol
3229
3298
  ).returns(T.attached_class)
@@ -3249,6 +3318,8 @@ module ContextDev
3249
3318
  mcc: nil,
3250
3319
  # Optional phone number from the transaction to help verify brand match.
3251
3320
  phone: nil,
3321
+ # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
3322
+ tags: nil,
3252
3323
  # Optional timeout in milliseconds for the request. If the request takes longer
3253
3324
  # than this value, it will be aborted with a 408 status code. Maximum allowed
3254
3325
  # value is 300000ms (5 minutes).
@@ -3266,11 +3337,16 @@ module ContextDev
3266
3337
  city: String,
3267
3338
  country_gl: String,
3268
3339
  force_language:
3269
- ContextDev::BrandRetrieveParams::Body::ByTransaction::ForceLanguage::OrSymbol,
3340
+ T.nilable(
3341
+ ContextDev::BrandRetrieveParams::Body::ByTransaction::ForceLanguage::OrSymbol
3342
+ ),
3270
3343
  high_confidence_only: T::Boolean,
3271
3344
  max_speed: T::Boolean,
3272
- mcc: Integer,
3273
- phone: Float,
3345
+ mcc:
3346
+ ContextDev::BrandRetrieveParams::Body::ByTransaction::Mcc::Variants,
3347
+ phone:
3348
+ ContextDev::BrandRetrieveParams::Body::ByTransaction::Phone::Variants,
3349
+ tags: T::Array[String],
3274
3350
  timeout_ms: Integer
3275
3351
  }
3276
3352
  )
@@ -3901,6 +3977,41 @@ module ContextDev
3901
3977
  def self.values
3902
3978
  end
3903
3979
  end
3980
+
3981
+ # Optional Merchant Category Code (MCC) to help identify the business category or
3982
+ # industry.
3983
+ module Mcc
3984
+ extend ContextDev::Internal::Type::Union
3985
+
3986
+ Variants = T.type_alias { T.any(String, Float) }
3987
+
3988
+ sig do
3989
+ override.returns(
3990
+ T::Array[
3991
+ ContextDev::BrandRetrieveParams::Body::ByTransaction::Mcc::Variants
3992
+ ]
3993
+ )
3994
+ end
3995
+ def self.variants
3996
+ end
3997
+ end
3998
+
3999
+ # Optional phone number from the transaction to help verify brand match.
4000
+ module Phone
4001
+ extend ContextDev::Internal::Type::Union
4002
+
4003
+ Variants = T.type_alias { T.any(String, Float) }
4004
+
4005
+ sig do
4006
+ override.returns(
4007
+ T::Array[
4008
+ ContextDev::BrandRetrieveParams::Body::ByTransaction::Phone::Variants
4009
+ ]
4010
+ )
4011
+ end
4012
+ def self.variants
4013
+ end
4014
+ end
3904
4015
  end
3905
4016
 
3906
4017
  sig do
@@ -247,8 +247,7 @@ module ContextDev
247
247
  sig { params(phone: String).void }
248
248
  attr_writer :phone
249
249
 
250
- # The primary language of the brand's website content. Detected from the HTML lang
251
- # tag, page content analysis, or social media descriptions.
250
+ # Language to force for the retrieved brand data.
252
251
  sig do
253
252
  returns(
254
253
  T.nilable(
@@ -372,8 +371,7 @@ module ContextDev
372
371
  logos: nil,
373
372
  # Company phone number
374
373
  phone: nil,
375
- # The primary language of the brand's website content. Detected from the HTML lang
376
- # tag, page content analysis, or social media descriptions.
374
+ # Language to force for the retrieved brand data.
377
375
  primary_language: nil,
378
376
  # The brand's slogan
379
377
  slogan: nil,
@@ -1280,11 +1278,6 @@ module ContextDev
1280
1278
  :"Creator Economy & Influencer Platforms",
1281
1279
  ContextDev::Models::BrandRetrieveResponse::Brand::Industries::Eic::Subindustry::TaggedSymbol
1282
1280
  )
1283
- ADVERTISING_ADTECH_MEDIA_BUYING =
1284
- T.let(
1285
- :"Advertising, Adtech & Media Buying",
1286
- ContextDev::Models::BrandRetrieveResponse::Brand::Industries::Eic::Subindustry::TaggedSymbol
1287
- )
1288
1281
  FILM_TV_PRODUCTION_STUDIOS =
1289
1282
  T.let(
1290
1283
  :"Film, TV & Production Studios",
@@ -1585,6 +1578,11 @@ module ContextDev
1585
1578
  :"News Publishing & Journalism",
1586
1579
  ContextDev::Models::BrandRetrieveResponse::Brand::Industries::Eic::Subindustry::TaggedSymbol
1587
1580
  )
1581
+ ADVERTISING_ADTECH_MEDIA_BUYING =
1582
+ T.let(
1583
+ :"Advertising, Adtech & Media Buying",
1584
+ ContextDev::Models::BrandRetrieveResponse::Brand::Industries::Eic::Subindustry::TaggedSymbol
1585
+ )
1588
1586
  DIGITAL_MEDIA_CONTENT_PLATFORMS =
1589
1587
  T.let(
1590
1588
  :"Digital Media & Content Platforms",
@@ -2537,8 +2535,7 @@ module ContextDev
2537
2535
  end
2538
2536
  end
2539
2537
 
2540
- # The primary language of the brand's website content. Detected from the HTML lang
2541
- # tag, page content analysis, or social media descriptions.
2538
+ # Language to force for the retrieved brand data.
2542
2539
  module PrimaryLanguage
2543
2540
  extend ContextDev::Internal::Type::Enum
2544
2541
 
@@ -23,10 +23,31 @@ module ContextDev
23
23
  # are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1
24
24
  # year.
25
25
  sig { returns(T.nilable(Integer)) }
26
- attr_reader :max_age_ms
26
+ attr_accessor :max_age_ms
27
27
 
28
- sig { params(max_age_ms: Integer).void }
29
- attr_writer :max_age_ms
28
+ # Optional comma-separated caller-defined tags for tracking this request. Tags are
29
+ # recorded on the request's usage log and can be used to filter usage on the
30
+ # dashboard usage page. Up to 20 tags, each 1-50 characters.
31
+ sig { returns(T.nilable(T::Array[String])) }
32
+ attr_reader :tags
33
+
34
+ sig { params(tags: T::Array[String]).void }
35
+ attr_writer :tags
36
+
37
+ # Optional theme preference used when selecting brand assets.
38
+ sig do
39
+ returns(
40
+ T.nilable(ContextDev::BrandRetrieveSimplifiedParams::Theme::OrSymbol)
41
+ )
42
+ end
43
+ attr_reader :theme
44
+
45
+ sig do
46
+ params(
47
+ theme: ContextDev::BrandRetrieveSimplifiedParams::Theme::OrSymbol
48
+ ).void
49
+ end
50
+ attr_writer :theme
30
51
 
31
52
  # Optional timeout in milliseconds for the request. If the request takes longer
32
53
  # than this value, it will be aborted with a 408 status code. Maximum allowed
@@ -40,7 +61,9 @@ module ContextDev
40
61
  sig do
41
62
  params(
42
63
  domain: String,
43
- max_age_ms: Integer,
64
+ max_age_ms: T.nilable(Integer),
65
+ tags: T::Array[String],
66
+ theme: ContextDev::BrandRetrieveSimplifiedParams::Theme::OrSymbol,
44
67
  timeout_ms: Integer,
45
68
  request_options: ContextDev::RequestOptions::OrHash
46
69
  ).returns(T.attached_class)
@@ -53,6 +76,12 @@ module ContextDev
53
76
  # are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1
54
77
  # year.
55
78
  max_age_ms: nil,
79
+ # Optional comma-separated caller-defined tags for tracking this request. Tags are
80
+ # recorded on the request's usage log and can be used to filter usage on the
81
+ # dashboard usage page. Up to 20 tags, each 1-50 characters.
82
+ tags: nil,
83
+ # Optional theme preference used when selecting brand assets.
84
+ theme: nil,
56
85
  # Optional timeout in milliseconds for the request. If the request takes longer
57
86
  # than this value, it will be aborted with a 408 status code. Maximum allowed
58
87
  # value is 300000ms (5 minutes).
@@ -65,7 +94,9 @@ module ContextDev
65
94
  override.returns(
66
95
  {
67
96
  domain: String,
68
- max_age_ms: Integer,
97
+ max_age_ms: T.nilable(Integer),
98
+ tags: T::Array[String],
99
+ theme: ContextDev::BrandRetrieveSimplifiedParams::Theme::OrSymbol,
69
100
  timeout_ms: Integer,
70
101
  request_options: ContextDev::RequestOptions
71
102
  }
@@ -73,6 +104,38 @@ module ContextDev
73
104
  end
74
105
  def to_hash
75
106
  end
107
+
108
+ # Optional theme preference used when selecting brand assets.
109
+ module Theme
110
+ extend ContextDev::Internal::Type::Enum
111
+
112
+ TaggedSymbol =
113
+ T.type_alias do
114
+ T.all(Symbol, ContextDev::BrandRetrieveSimplifiedParams::Theme)
115
+ end
116
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
117
+
118
+ LIGHT =
119
+ T.let(
120
+ :light,
121
+ ContextDev::BrandRetrieveSimplifiedParams::Theme::TaggedSymbol
122
+ )
123
+ DARK =
124
+ T.let(
125
+ :dark,
126
+ ContextDev::BrandRetrieveSimplifiedParams::Theme::TaggedSymbol
127
+ )
128
+
129
+ sig do
130
+ override.returns(
131
+ T::Array[
132
+ ContextDev::BrandRetrieveSimplifiedParams::Theme::TaggedSymbol
133
+ ]
134
+ )
135
+ end
136
+ def self.values
137
+ end
138
+ end
76
139
  end
77
140
  end
78
141
  end
@@ -0,0 +1,32 @@
1
+ # typed: strong
2
+
3
+ module ContextDev
4
+ module Models
5
+ class Error < ContextDev::Internal::Type::BaseModel
6
+ OrHash =
7
+ T.type_alias { T.any(ContextDev::Error, ContextDev::Internal::AnyHash) }
8
+
9
+ # Batch error code.
10
+ sig { returns(String) }
11
+ attr_accessor :code
12
+
13
+ # Batch error message.
14
+ sig { returns(String) }
15
+ attr_accessor :message
16
+
17
+ # Why the batch failed.
18
+ sig { params(code: String, message: String).returns(T.attached_class) }
19
+ def self.new(
20
+ # Batch error code.
21
+ code:,
22
+ # Batch error message.
23
+ message:
24
+ )
25
+ end
26
+
27
+ sig { override.returns({ code: String, message: String }) }
28
+ def to_hash
29
+ end
30
+ end
31
+ end
32
+ end
@@ -0,0 +1,34 @@
1
+ # typed: strong
2
+
3
+ module ContextDev
4
+ module Models
5
+ class ErrorCount < ContextDev::Internal::Type::BaseModel
6
+ OrHash =
7
+ T.type_alias do
8
+ T.any(ContextDev::ErrorCount, ContextDev::Internal::AnyHash)
9
+ end
10
+
11
+ # Error code for these failures.
12
+ sig { returns(String) }
13
+ attr_accessor :code
14
+
15
+ # Pages that failed with this code.
16
+ sig { returns(Integer) }
17
+ attr_accessor :count
18
+
19
+ # Page failures sharing one error code.
20
+ sig { params(code: String, count: Integer).returns(T.attached_class) }
21
+ def self.new(
22
+ # Error code for these failures.
23
+ code:,
24
+ # Pages that failed with this code.
25
+ count:
26
+ )
27
+ end
28
+
29
+ sig { override.returns({ code: String, count: Integer }) }
30
+ def to_hash
31
+ end
32
+ end
33
+ end
34
+ end