context.dev 1.36.0 → 2.0.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 +24 -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 +1036 -174
  6. data/lib/context_dev/models/monitor_create_params.rb +361 -0
  7. data/lib/context_dev/models/monitor_create_response.rb +484 -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 +507 -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 +271 -0
  22. data/lib/context_dev/models/monitor_retrieve_params.rb +20 -0
  23. data/lib/context_dev/models/monitor_retrieve_response.rb +484 -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 +368 -0
  27. data/lib/context_dev/models/monitor_update_response.rb +484 -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 +7 -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 +3792 -679
  46. data/rbi/context_dev/models/monitor_create_params.rbi +640 -0
  47. data/rbi/context_dev/models/monitor_create_response.rbi +820 -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 +332 -0
  57. data/rbi/context_dev/models/monitor_list_response.rbi +885 -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 +478 -0
  62. data/rbi/context_dev/models/monitor_retrieve_params.rbi +38 -0
  63. data/rbi/context_dev/models/monitor_retrieve_response.rbi +828 -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 +680 -0
  67. data/rbi/context_dev/models/monitor_update_response.rbi +820 -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 +13 -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 +1560 -281
  84. data/sig/context_dev/models/monitor_create_params.rbs +311 -0
  85. data/sig/context_dev/models/monitor_create_response.rbs +369 -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 +396 -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 +228 -0
  100. data/sig/context_dev/models/monitor_retrieve_params.rbs +23 -0
  101. data/sig/context_dev/models/monitor_retrieve_response.rbs +369 -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 +331 -0
  105. data/sig/context_dev/models/monitor_update_response.rbs +369 -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
@@ -92,6 +92,14 @@ module ContextDev
92
92
  # @return [ContextDev::Models::WebWebCrawlMdParams::Pdf, nil]
93
93
  optional :pdf, -> { ContextDev::WebWebCrawlMdParams::Pdf }
94
94
 
95
+ # @!attribute settle_animations
96
+ # When true, waits briefly for CSS and transition animations to settle before
97
+ # extracting each crawled page. Defaults to false. This adds a bit of latency in
98
+ # exchange for more stable output on animated pages.
99
+ #
100
+ # @return [Boolean, nil]
101
+ optional :settle_animations, ContextDev::Internal::Type::Boolean, api_name: :settleAnimations
102
+
95
103
  # @!attribute shorten_base64_images
96
104
  # Truncate base64-encoded image data in the Markdown output
97
105
  #
@@ -135,7 +143,7 @@ module ContextDev
135
143
  # @return [Integer, nil]
136
144
  optional :wait_for_ms, Integer, api_name: :waitForMs
137
145
 
138
- # @!method initialize(url:, country: nil, exclude_selectors: nil, follow_subdomains: nil, include_frames: nil, include_images: nil, include_links: nil, include_selectors: nil, max_age_ms: nil, max_depth: nil, max_pages: nil, pdf: nil, shorten_base64_images: nil, stop_after_ms: nil, timeout_ms: nil, url_regex: nil, use_main_content_only: nil, wait_for_ms: nil, request_options: {})
146
+ # @!method initialize(url:, country: nil, exclude_selectors: nil, follow_subdomains: nil, include_frames: nil, include_images: nil, include_links: nil, include_selectors: nil, max_age_ms: nil, max_depth: nil, max_pages: nil, pdf: nil, settle_animations: nil, shorten_base64_images: nil, stop_after_ms: nil, timeout_ms: nil, url_regex: nil, use_main_content_only: nil, wait_for_ms: nil, request_options: {})
139
147
  # Some parameter documentations has been truncated, see
140
148
  # {ContextDev::Models::WebWebCrawlMdParams} for more details.
141
149
  #
@@ -163,6 +171,8 @@ module ContextDev
163
171
  #
164
172
  # @param pdf [ContextDev::Models::WebWebCrawlMdParams::Pdf] PDF parsing controls. Use start/end to limit text extraction and OCR to an inclu
165
173
  #
174
+ # @param settle_animations [Boolean] When true, waits briefly for CSS and transition animations to settle before extr
175
+ #
166
176
  # @param shorten_base64_images [Boolean] Truncate base64-encoded image data in the Markdown output
167
177
  #
168
178
  # @param stop_after_ms [Integer] Soft time budget for the crawl in milliseconds. After each scrape, the crawler c
@@ -65,6 +65,14 @@ module ContextDev
65
65
  # @return [ContextDev::Models::WebWebScrapeHTMLParams::Pdf, nil]
66
66
  optional :pdf, -> { ContextDev::WebWebScrapeHTMLParams::Pdf }
67
67
 
68
+ # @!attribute settle_animations
69
+ # When true, waits briefly for CSS and transition animations to settle before
70
+ # extracting HTML. Defaults to false. This adds a bit of latency in exchange for
71
+ # more stable output on animated pages.
72
+ #
73
+ # @return [Boolean, nil]
74
+ optional :settle_animations, ContextDev::Internal::Type::Boolean
75
+
68
76
  # @!attribute timeout_ms
69
77
  # Optional timeout in milliseconds for the request. If the request takes longer
70
78
  # than this value, it will be aborted with a 408 status code. Maximum allowed
@@ -87,7 +95,7 @@ module ContextDev
87
95
  # @return [Integer, nil]
88
96
  optional :wait_for_ms, Integer
89
97
 
90
- # @!method initialize(url:, country: nil, exclude_selectors: nil, headers: nil, include_frames: nil, include_selectors: nil, max_age_ms: nil, pdf: nil, timeout_ms: nil, use_main_content_only: nil, wait_for_ms: nil, request_options: {})
98
+ # @!method initialize(url:, country: nil, exclude_selectors: nil, headers: nil, include_frames: nil, include_selectors: nil, max_age_ms: nil, pdf: nil, settle_animations: nil, timeout_ms: nil, use_main_content_only: nil, wait_for_ms: nil, request_options: {})
91
99
  # Some parameter documentations has been truncated, see
92
100
  # {ContextDev::Models::WebWebScrapeHTMLParams} for more details.
93
101
  #
@@ -107,6 +115,8 @@ module ContextDev
107
115
  #
108
116
  # @param pdf [ContextDev::Models::WebWebScrapeHTMLParams::Pdf] PDF parsing controls. Use start/end to limit text extraction and OCR to an inclu
109
117
  #
118
+ # @param settle_animations [Boolean] When true, waits briefly for CSS and transition animations to settle before extr
119
+ #
110
120
  # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
111
121
  #
112
122
  # @param use_main_content_only [Boolean] When true, return only the page's main content in the HTML response, excluding h
@@ -26,7 +26,9 @@ module ContextDev
26
26
 
27
27
  # @!attribute type
28
28
  # Detected content type of the returned `html` field. Sitemaps and feeds are
29
- # surfaced as `xml`; ordinary pages are `html`.
29
+ # surfaced as `xml`; ordinary pages are `html`. Excel workbooks are surfaced as
30
+ # `xlsx`/`xls` with the extracted sheets as HTML tables; PowerPoint presentations
31
+ # are surfaced as `pptx`/`ppt` with the extracted slides as HTML.
30
32
  #
31
33
  # @return [Symbol, ContextDev::Models::WebWebScrapeHTMLResponse::Type]
32
34
  required :type, enum: -> { ContextDev::Models::WebWebScrapeHTMLResponse::Type }
@@ -320,7 +322,9 @@ module ContextDev
320
322
  end
321
323
 
322
324
  # Detected content type of the returned `html` field. Sitemaps and feeds are
323
- # surfaced as `xml`; ordinary pages are `html`.
325
+ # surfaced as `xml`; ordinary pages are `html`. Excel workbooks are surfaced as
326
+ # `xlsx`/`xls` with the extracted sheets as HTML tables; PowerPoint presentations
327
+ # are surfaced as `pptx`/`ppt` with the extracted slides as HTML.
324
328
  #
325
329
  # @see ContextDev::Models::WebWebScrapeHTMLResponse#type
326
330
  module Type
@@ -336,6 +340,10 @@ module ContextDev
336
340
  PDF = :pdf
337
341
  DOCX = :docx
338
342
  DOC = :doc
343
+ XLSX = :xlsx
344
+ XLS = :xls
345
+ PPTX = :pptx
346
+ PPT = :ppt
339
347
 
340
348
  # @!method self.values
341
349
  # @return [Array<Symbol>]
@@ -13,6 +13,15 @@ module ContextDev
13
13
  # @return [String]
14
14
  required :url, String
15
15
 
16
+ # @!attribute dedupe
17
+ # When true, visually duplicate images are removed: every image is loaded and
18
+ # perceptually hashed, and only the highest-resolution copy of each duplicate
19
+ # group is kept. Images that cannot be downloaded or hashed are kept. Default:
20
+ # false.
21
+ #
22
+ # @return [Boolean, nil]
23
+ optional :dedupe, ContextDev::Internal::Type::Boolean
24
+
16
25
  # @!attribute enrichment
17
26
  # Optional per-image processing, sent as deep-object query params such as
18
27
  # enrichment[resolution]=true.
@@ -50,12 +59,14 @@ module ContextDev
50
59
  # @return [Integer, nil]
51
60
  optional :wait_for_ms, Integer
52
61
 
53
- # @!method initialize(url:, enrichment: nil, headers: nil, max_age_ms: nil, timeout_ms: nil, wait_for_ms: nil, request_options: {})
62
+ # @!method initialize(url:, dedupe: nil, enrichment: nil, headers: nil, max_age_ms: nil, timeout_ms: nil, wait_for_ms: nil, request_options: {})
54
63
  # Some parameter documentations has been truncated, see
55
64
  # {ContextDev::Models::WebWebScrapeImagesParams} for more details.
56
65
  #
57
66
  # @param url [String] Page URL to inspect. Must include http:// or https://.
58
67
  #
68
+ # @param dedupe [Boolean] When true, visually duplicate images are removed: every image is loaded and perc
69
+ #
59
70
  # @param enrichment [ContextDev::Models::WebWebScrapeImagesParams::Enrichment] Optional per-image processing, sent as deep-object query params such as enrichme
60
71
  #
61
72
  # @param headers [Hash{Symbol=>String}] Optional outbound HTTP headers forwarded only to the target URL, sent as deep-ob
@@ -78,6 +78,14 @@ module ContextDev
78
78
  # @return [ContextDev::Models::WebWebScrapeMdParams::Pdf, nil]
79
79
  optional :pdf, -> { ContextDev::WebWebScrapeMdParams::Pdf }
80
80
 
81
+ # @!attribute settle_animations
82
+ # When true, waits briefly for CSS and transition animations to settle before
83
+ # converting to Markdown. Defaults to false. This adds a bit of latency in
84
+ # exchange for more stable output on animated pages.
85
+ #
86
+ # @return [Boolean, nil]
87
+ optional :settle_animations, ContextDev::Internal::Type::Boolean
88
+
81
89
  # @!attribute shorten_base64_images
82
90
  # Shorten base64-encoded image data in the Markdown output
83
91
  #
@@ -106,7 +114,7 @@ module ContextDev
106
114
  # @return [Integer, nil]
107
115
  optional :wait_for_ms, Integer
108
116
 
109
- # @!method initialize(url:, country: nil, exclude_selectors: nil, headers: nil, include_frames: nil, include_images: nil, include_links: nil, include_selectors: nil, max_age_ms: nil, pdf: nil, shorten_base64_images: nil, timeout_ms: nil, use_main_content_only: nil, wait_for_ms: nil, request_options: {})
117
+ # @!method initialize(url:, country: nil, exclude_selectors: nil, headers: nil, include_frames: nil, include_images: nil, include_links: nil, include_selectors: nil, max_age_ms: nil, pdf: nil, settle_animations: nil, shorten_base64_images: nil, timeout_ms: nil, use_main_content_only: nil, wait_for_ms: nil, request_options: {})
110
118
  # Some parameter documentations has been truncated, see
111
119
  # {ContextDev::Models::WebWebScrapeMdParams} for more details.
112
120
  #
@@ -130,6 +138,8 @@ module ContextDev
130
138
  #
131
139
  # @param pdf [ContextDev::Models::WebWebScrapeMdParams::Pdf] PDF parsing controls. Use start/end to limit text extraction and OCR to an inclu
132
140
  #
141
+ # @param settle_animations [Boolean] When true, waits briefly for CSS and transition animations to settle before conv
142
+ #
133
143
  # @param shorten_base64_images [Boolean] Shorten base64-encoded image data in the Markdown output
134
144
  #
135
145
  # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
@@ -39,31 +39,39 @@ module ContextDev
39
39
  mod.define_sorbet_constant!(const) { T.type_alias { mod.to_sorbet_type } }
40
40
  end
41
41
 
42
- AIAIQueryParams = ContextDev::Models::AIAIQueryParams
43
-
44
42
  AIExtractProductParams = ContextDev::Models::AIExtractProductParams
45
43
 
46
44
  AIExtractProductsParams = ContextDev::Models::AIExtractProductsParams
47
45
 
48
- BrandIdentifyFromTransactionParams = ContextDev::Models::BrandIdentifyFromTransactionParams
46
+ BrandRetrieveParams = ContextDev::Models::BrandRetrieveParams
49
47
 
50
- BrandRetrieveByEmailParams = ContextDev::Models::BrandRetrieveByEmailParams
48
+ BrandRetrieveSimplifiedParams = ContextDev::Models::BrandRetrieveSimplifiedParams
51
49
 
52
- BrandRetrieveByIsinParams = ContextDev::Models::BrandRetrieveByIsinParams
50
+ IndustryRetrieveNaicsParams = ContextDev::Models::IndustryRetrieveNaicsParams
53
51
 
54
- BrandRetrieveByNameParams = ContextDev::Models::BrandRetrieveByNameParams
52
+ IndustryRetrieveSicParams = ContextDev::Models::IndustryRetrieveSicParams
55
53
 
56
- BrandRetrieveByTickerParams = ContextDev::Models::BrandRetrieveByTickerParams
54
+ MonitorCreateParams = ContextDev::Models::MonitorCreateParams
57
55
 
58
- BrandRetrieveParams = ContextDev::Models::BrandRetrieveParams
56
+ MonitorDeleteParams = ContextDev::Models::MonitorDeleteParams
59
57
 
60
- BrandRetrieveSimplifiedParams = ContextDev::Models::BrandRetrieveSimplifiedParams
58
+ MonitorListAccountChangesParams = ContextDev::Models::MonitorListAccountChangesParams
61
59
 
62
- IndustryRetrieveNaicsParams = ContextDev::Models::IndustryRetrieveNaicsParams
60
+ MonitorListAccountRunsParams = ContextDev::Models::MonitorListAccountRunsParams
63
61
 
64
- IndustryRetrieveSicParams = ContextDev::Models::IndustryRetrieveSicParams
62
+ MonitorListChangesParams = ContextDev::Models::MonitorListChangesParams
63
+
64
+ MonitorListParams = ContextDev::Models::MonitorListParams
65
+
66
+ MonitorListRunsParams = ContextDev::Models::MonitorListRunsParams
67
+
68
+ MonitorRetrieveChangeParams = ContextDev::Models::MonitorRetrieveChangeParams
69
+
70
+ MonitorRetrieveParams = ContextDev::Models::MonitorRetrieveParams
71
+
72
+ MonitorRunParams = ContextDev::Models::MonitorRunParams
65
73
 
66
- UtilityPrefetchByEmailParams = ContextDev::Models::UtilityPrefetchByEmailParams
74
+ MonitorUpdateParams = ContextDev::Models::MonitorUpdateParams
67
75
 
68
76
  UtilityPrefetchParams = ContextDev::Models::UtilityPrefetchParams
69
77
 
@@ -3,39 +3,6 @@
3
3
  module ContextDev
4
4
  module Resources
5
5
  class AI
6
- # Some parameter documentations has been truncated, see
7
- # {ContextDev::Models::AIAIQueryParams} for more details.
8
- #
9
- # Use AI to extract specific data points from a brand's website. The AI will crawl
10
- # the website and extract the requested information based on the provided data
11
- # points.
12
- #
13
- # @overload ai_query(data_to_extract:, domain:, specific_pages: nil, timeout_ms: nil, request_options: {})
14
- #
15
- # @param data_to_extract [Array<ContextDev::Models::AIAIQueryParams::DataToExtract>] Array of data points to extract from the website
16
- #
17
- # @param domain [String] The domain name to analyze
18
- #
19
- # @param specific_pages [ContextDev::Models::AIAIQueryParams::SpecificPages] Optional object specifying which pages to analyze
20
- #
21
- # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
22
- #
23
- # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
24
- #
25
- # @return [ContextDev::Models::AIAIQueryResponse]
26
- #
27
- # @see ContextDev::Models::AIAIQueryParams
28
- def ai_query(params)
29
- parsed, options = ContextDev::AIAIQueryParams.dump_request(params)
30
- @client.request(
31
- method: :post,
32
- path: "brand/ai/query",
33
- body: parsed,
34
- model: ContextDev::Models::AIAIQueryResponse,
35
- options: options
36
- )
37
- end
38
-
39
6
  # Some parameter documentations has been truncated, see
40
7
  # {ContextDev::Models::AIExtractProductParams} for more details.
41
8
  #
@@ -3,23 +3,13 @@
3
3
  module ContextDev
4
4
  module Resources
5
5
  class Brand
6
- # Some parameter documentations has been truncated, see
7
- # {ContextDev::Models::BrandRetrieveParams} for more details.
8
- #
9
- # Retrieve logos, backdrops, colors, industry, description, and more from any
10
- # domain
11
- #
12
- # @overload retrieve(domain:, force_language: nil, max_age_ms: nil, max_speed: nil, timeout_ms: nil, request_options: {})
13
- #
14
- # @param domain [String] Domain name to retrieve brand data for (e.g., 'example.com', 'google.com'). Cann
6
+ # Retrieve logos, backdrops, colors, industry, description, and more. Provide
7
+ # exactly one lookup identifier in the request body: a domain, company name, email
8
+ # address, stock ticker, or transaction descriptor.
15
9
  #
16
- # @param force_language [Symbol, ContextDev::Models::BrandRetrieveParams::ForceLanguage] Optional parameter to force the language of the retrieved brand data.
10
+ # @overload retrieve(body:, request_options: {})
17
11
  #
18
- # @param max_age_ms [Integer] Maximum age in milliseconds for cached brand data before the API performs a hard
19
- #
20
- # @param max_speed [Boolean] Optional parameter to optimize the API call for maximum speed. When set to true,
21
- #
22
- # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
12
+ # @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::ByTransaction] Exactly one lookup type must be provided.
23
13
  #
24
14
  # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
25
15
  #
@@ -28,202 +18,15 @@ module ContextDev
28
18
  # @see ContextDev::Models::BrandRetrieveParams
29
19
  def retrieve(params)
30
20
  parsed, options = ContextDev::BrandRetrieveParams.dump_request(params)
31
- query = ContextDev::Internal::Util.encode_query_params(parsed)
32
21
  @client.request(
33
- method: :get,
22
+ method: :post,
34
23
  path: "brand/retrieve",
35
- query: query.transform_keys(max_age_ms: "maxAgeMs", max_speed: "maxSpeed", timeout_ms: "timeoutMS"),
24
+ body: parsed[:body],
36
25
  model: ContextDev::Models::BrandRetrieveResponse,
37
26
  options: options
38
27
  )
39
28
  end
40
29
 
41
- # Some parameter documentations has been truncated, see
42
- # {ContextDev::Models::BrandIdentifyFromTransactionParams} for more details.
43
- #
44
- # Endpoint specially designed for platforms that want to identify transaction data
45
- # by the transaction title.
46
- #
47
- # @overload identify_from_transaction(transaction_info:, city: nil, country_gl: nil, force_language: nil, high_confidence_only: nil, max_speed: nil, mcc: nil, phone: nil, timeout_ms: nil, request_options: {})
48
- #
49
- # @param transaction_info [String] Transaction information to identify the brand
50
- #
51
- # @param city [String] Optional city name to prioritize when searching for the brand.
52
- #
53
- # @param country_gl [Symbol, ContextDev::Models::BrandIdentifyFromTransactionParams::CountryGl] Optional country code (GL parameter) to specify the country. This affects the ge
54
- #
55
- # @param force_language [Symbol, ContextDev::Models::BrandIdentifyFromTransactionParams::ForceLanguage] Optional parameter to force the language of the retrieved brand data.
56
- #
57
- # @param high_confidence_only [Boolean] When set to true, the API will perform an additional verification steps to ensur
58
- #
59
- # @param max_speed [Boolean] Optional parameter to optimize the API call for maximum speed. When set to true,
60
- #
61
- # @param mcc [String] Optional Merchant Category Code (MCC) to help identify the business category/ind
62
- #
63
- # @param phone [Float] Optional phone number from the transaction to help verify brand match.
64
- #
65
- # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
66
- #
67
- # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
68
- #
69
- # @return [ContextDev::Models::BrandIdentifyFromTransactionResponse]
70
- #
71
- # @see ContextDev::Models::BrandIdentifyFromTransactionParams
72
- def identify_from_transaction(params)
73
- parsed, options = ContextDev::BrandIdentifyFromTransactionParams.dump_request(params)
74
- query = ContextDev::Internal::Util.encode_query_params(parsed)
75
- @client.request(
76
- method: :get,
77
- path: "brand/transaction_identifier",
78
- query: query.transform_keys(max_speed: "maxSpeed", timeout_ms: "timeoutMS"),
79
- model: ContextDev::Models::BrandIdentifyFromTransactionResponse,
80
- options: options
81
- )
82
- end
83
-
84
- # Some parameter documentations has been truncated, see
85
- # {ContextDev::Models::BrandRetrieveByEmailParams} for more details.
86
- #
87
- # Retrieve brand information using an email address while detecting disposable and
88
- # free email addresses. Disposable and free email addresses (like gmail.com,
89
- # yahoo.com) will throw a 422 error.
90
- #
91
- # @overload retrieve_by_email(email:, force_language: nil, max_age_ms: nil, max_speed: nil, timeout_ms: nil, request_options: {})
92
- #
93
- # @param email [String] Email address to retrieve brand data for (e.g., 'contact@example.com'). The doma
94
- #
95
- # @param force_language [Symbol, ContextDev::Models::BrandRetrieveByEmailParams::ForceLanguage] Optional parameter to force the language of the retrieved brand data.
96
- #
97
- # @param max_age_ms [Integer] Maximum age in milliseconds for cached brand data before the API performs a hard
98
- #
99
- # @param max_speed [Boolean] Optional parameter to optimize the API call for maximum speed. When set to true,
100
- #
101
- # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
102
- #
103
- # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
104
- #
105
- # @return [ContextDev::Models::BrandRetrieveByEmailResponse]
106
- #
107
- # @see ContextDev::Models::BrandRetrieveByEmailParams
108
- def retrieve_by_email(params)
109
- parsed, options = ContextDev::BrandRetrieveByEmailParams.dump_request(params)
110
- query = ContextDev::Internal::Util.encode_query_params(parsed)
111
- @client.request(
112
- method: :get,
113
- path: "brand/retrieve-by-email",
114
- query: query.transform_keys(max_age_ms: "maxAgeMs", max_speed: "maxSpeed", timeout_ms: "timeoutMS"),
115
- model: ContextDev::Models::BrandRetrieveByEmailResponse,
116
- options: options
117
- )
118
- end
119
-
120
- # Some parameter documentations has been truncated, see
121
- # {ContextDev::Models::BrandRetrieveByIsinParams} for more details.
122
- #
123
- # Retrieve brand information using an ISIN (International Securities
124
- # Identification Number).
125
- #
126
- # @overload retrieve_by_isin(isin:, force_language: nil, max_age_ms: nil, max_speed: nil, timeout_ms: nil, request_options: {})
127
- #
128
- # @param isin [String] ISIN (International Securities Identification Number) to retrieve brand data for
129
- #
130
- # @param force_language [Symbol, ContextDev::Models::BrandRetrieveByIsinParams::ForceLanguage] Optional parameter to force the language of the retrieved brand data.
131
- #
132
- # @param max_age_ms [Integer] Maximum age in milliseconds for cached brand data before the API performs a hard
133
- #
134
- # @param max_speed [Boolean] Optional parameter to optimize the API call for maximum speed. When set to true,
135
- #
136
- # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
137
- #
138
- # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
139
- #
140
- # @return [ContextDev::Models::BrandRetrieveByIsinResponse]
141
- #
142
- # @see ContextDev::Models::BrandRetrieveByIsinParams
143
- def retrieve_by_isin(params)
144
- parsed, options = ContextDev::BrandRetrieveByIsinParams.dump_request(params)
145
- query = ContextDev::Internal::Util.encode_query_params(parsed)
146
- @client.request(
147
- method: :get,
148
- path: "brand/retrieve-by-isin",
149
- query: query.transform_keys(max_age_ms: "maxAgeMs", max_speed: "maxSpeed", timeout_ms: "timeoutMS"),
150
- model: ContextDev::Models::BrandRetrieveByIsinResponse,
151
- options: options
152
- )
153
- end
154
-
155
- # Some parameter documentations has been truncated, see
156
- # {ContextDev::Models::BrandRetrieveByNameParams} for more details.
157
- #
158
- # Retrieve brand information using a company name.
159
- #
160
- # @overload retrieve_by_name(name:, country_gl: nil, force_language: nil, max_age_ms: nil, max_speed: nil, timeout_ms: nil, request_options: {})
161
- #
162
- # @param name [String] Company name to retrieve brand data for (e.g., 'Apple Inc', 'Microsoft Corporati
163
- #
164
- # @param country_gl [Symbol, ContextDev::Models::BrandRetrieveByNameParams::CountryGl] Optional country code hint (GL parameter) to specify the country for the company
165
- #
166
- # @param force_language [Symbol, ContextDev::Models::BrandRetrieveByNameParams::ForceLanguage] Optional parameter to force the language of the retrieved brand data.
167
- #
168
- # @param max_age_ms [Integer] Maximum age in milliseconds for cached brand data before the API performs a hard
169
- #
170
- # @param max_speed [Boolean] Optional parameter to optimize the API call for maximum speed. When set to true,
171
- #
172
- # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
173
- #
174
- # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
175
- #
176
- # @return [ContextDev::Models::BrandRetrieveByNameResponse]
177
- #
178
- # @see ContextDev::Models::BrandRetrieveByNameParams
179
- def retrieve_by_name(params)
180
- parsed, options = ContextDev::BrandRetrieveByNameParams.dump_request(params)
181
- query = ContextDev::Internal::Util.encode_query_params(parsed)
182
- @client.request(
183
- method: :get,
184
- path: "brand/retrieve-by-name",
185
- query: query.transform_keys(max_age_ms: "maxAgeMs", max_speed: "maxSpeed", timeout_ms: "timeoutMS"),
186
- model: ContextDev::Models::BrandRetrieveByNameResponse,
187
- options: options
188
- )
189
- end
190
-
191
- # Some parameter documentations has been truncated, see
192
- # {ContextDev::Models::BrandRetrieveByTickerParams} for more details.
193
- #
194
- # Retrieve brand information using a stock ticker symbol.
195
- #
196
- # @overload retrieve_by_ticker(ticker:, force_language: nil, max_age_ms: nil, max_speed: nil, ticker_exchange: nil, timeout_ms: nil, request_options: {})
197
- #
198
- # @param ticker [String] Stock ticker symbol to retrieve brand data for (e.g., 'AAPL', 'GOOGL', 'BRK.A').
199
- #
200
- # @param force_language [Symbol, ContextDev::Models::BrandRetrieveByTickerParams::ForceLanguage] Optional parameter to force the language of the retrieved brand data.
201
- #
202
- # @param max_age_ms [Integer] Maximum age in milliseconds for cached brand data before the API performs a hard
203
- #
204
- # @param max_speed [Boolean] Optional parameter to optimize the API call for maximum speed. When set to true,
205
- #
206
- # @param ticker_exchange [Symbol, ContextDev::Models::BrandRetrieveByTickerParams::TickerExchange] Optional stock exchange for the ticker. Defaults to NASDAQ if not specified.
207
- #
208
- # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
209
- #
210
- # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
211
- #
212
- # @return [ContextDev::Models::BrandRetrieveByTickerResponse]
213
- #
214
- # @see ContextDev::Models::BrandRetrieveByTickerParams
215
- def retrieve_by_ticker(params)
216
- parsed, options = ContextDev::BrandRetrieveByTickerParams.dump_request(params)
217
- query = ContextDev::Internal::Util.encode_query_params(parsed)
218
- @client.request(
219
- method: :get,
220
- path: "brand/retrieve-by-ticker",
221
- query: query.transform_keys(max_age_ms: "maxAgeMs", max_speed: "maxSpeed", timeout_ms: "timeoutMS"),
222
- model: ContextDev::Models::BrandRetrieveByTickerResponse,
223
- options: options
224
- )
225
- end
226
-
227
30
  # Some parameter documentations has been truncated, see
228
31
  # {ContextDev::Models::BrandRetrieveSimplifiedParams} for more details.
229
32
  #