context.dev 2.4.0 → 2.5.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 (133) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +16 -0
  3. data/README.md +1 -1
  4. data/lib/context_dev/models/ai_extract_product_params.rb +9 -1
  5. data/lib/context_dev/models/ai_extract_products_params.rb +18 -2
  6. data/lib/context_dev/models/brand_retrieve_params.rb +109 -22
  7. data/lib/context_dev/models/brand_retrieve_response.rb +4 -6
  8. data/lib/context_dev/models/brand_retrieve_simplified_params.rb +32 -3
  9. data/lib/context_dev/models/industry_retrieve_naics_params.rb +11 -1
  10. data/lib/context_dev/models/industry_retrieve_sic_params.rb +11 -1
  11. data/lib/context_dev/models/monitor_create_params.rb +6 -5
  12. data/lib/context_dev/models/monitor_create_response.rb +6 -5
  13. data/lib/context_dev/models/monitor_get_credit_usage_params.rb +30 -0
  14. data/lib/context_dev/models/monitor_get_credit_usage_response.rb +59 -0
  15. data/lib/context_dev/models/monitor_get_limits_params.rb +14 -0
  16. data/lib/context_dev/models/monitor_get_limits_response.rb +52 -0
  17. data/lib/context_dev/models/monitor_list_account_changes_params.rb +16 -7
  18. data/lib/context_dev/models/monitor_list_account_changes_response.rb +2 -1
  19. data/lib/context_dev/models/monitor_list_account_runs_params.rb +7 -10
  20. data/lib/context_dev/models/monitor_list_changes_params.rb +8 -4
  21. data/lib/context_dev/models/monitor_list_changes_response.rb +2 -1
  22. data/lib/context_dev/models/monitor_list_params.rb +18 -19
  23. data/lib/context_dev/models/monitor_list_response.rb +6 -5
  24. data/lib/context_dev/models/monitor_list_runs_params.rb +7 -10
  25. data/lib/context_dev/models/monitor_retrieve_change_response.rb +2 -1
  26. data/lib/context_dev/models/monitor_retrieve_response.rb +6 -5
  27. data/lib/context_dev/models/monitor_update_params.rb +6 -5
  28. data/lib/context_dev/models/monitor_update_response.rb +6 -5
  29. data/lib/context_dev/models/parse_handle_params.rb +199 -33
  30. data/lib/context_dev/models/utility_prefetch_params.rb +9 -1
  31. data/lib/context_dev/models/web_extract_competitors_params.rb +11 -1
  32. data/lib/context_dev/models/web_extract_fonts_params.rb +14 -4
  33. data/lib/context_dev/models/web_extract_params.rb +19 -1
  34. data/lib/context_dev/models/web_extract_styleguide_params.rb +14 -4
  35. data/lib/context_dev/models/web_screenshot_params.rb +69 -18
  36. data/lib/context_dev/models/web_screenshot_response.rb +3 -2
  37. data/lib/context_dev/models/web_search_params.rb +9 -1
  38. data/lib/context_dev/models/web_web_crawl_md_params.rb +34 -1
  39. data/lib/context_dev/models/web_web_scrape_html_params.rb +268 -29
  40. data/lib/context_dev/models/web_web_scrape_images_params.rb +208 -19
  41. data/lib/context_dev/models/web_web_scrape_md_params.rb +352 -38
  42. data/lib/context_dev/models/web_web_scrape_sitemap_params.rb +45 -1
  43. data/lib/context_dev/models.rb +4 -0
  44. data/lib/context_dev/resources/ai.rb +3 -1
  45. data/lib/context_dev/resources/brand.rb +6 -2
  46. data/lib/context_dev/resources/industry.rb +6 -2
  47. data/lib/context_dev/resources/monitors.rb +70 -32
  48. data/lib/context_dev/resources/parse.rb +15 -11
  49. data/lib/context_dev/resources/utility.rb +3 -1
  50. data/lib/context_dev/resources/web.rb +104 -55
  51. data/lib/context_dev/version.rb +1 -1
  52. data/lib/context_dev.rb +4 -0
  53. data/rbi/context_dev/models/ai_extract_product_params.rbi +11 -0
  54. data/rbi/context_dev/models/ai_extract_products_params.rbi +22 -0
  55. data/rbi/context_dev/models/brand_retrieve_params.rbi +175 -64
  56. data/rbi/context_dev/models/brand_retrieve_response.rbi +8 -11
  57. data/rbi/context_dev/models/brand_retrieve_simplified_params.rbi +68 -5
  58. data/rbi/context_dev/models/industry_retrieve_naics_params.rbi +15 -0
  59. data/rbi/context_dev/models/industry_retrieve_sic_params.rbi +15 -0
  60. data/rbi/context_dev/models/monitor_create_params.rbi +6 -4
  61. data/rbi/context_dev/models/monitor_create_response.rbi +6 -4
  62. data/rbi/context_dev/models/monitor_get_credit_usage_params.rbi +60 -0
  63. data/rbi/context_dev/models/monitor_get_credit_usage_response.rbi +111 -0
  64. data/rbi/context_dev/models/monitor_get_limits_params.rbi +30 -0
  65. data/rbi/context_dev/models/monitor_get_limits_response.rbi +105 -0
  66. data/rbi/context_dev/models/monitor_list_account_changes_params.rbi +16 -0
  67. data/rbi/context_dev/models/monitor_list_account_changes_response.rbi +2 -0
  68. data/rbi/context_dev/models/monitor_list_account_runs_params.rbi +7 -6
  69. data/rbi/context_dev/models/monitor_list_changes_params.rbi +8 -0
  70. data/rbi/context_dev/models/monitor_list_changes_response.rbi +2 -0
  71. data/rbi/context_dev/models/monitor_list_params.rbi +23 -31
  72. data/rbi/context_dev/models/monitor_list_response.rbi +6 -4
  73. data/rbi/context_dev/models/monitor_list_runs_params.rbi +7 -6
  74. data/rbi/context_dev/models/monitor_retrieve_change_response.rbi +2 -0
  75. data/rbi/context_dev/models/monitor_retrieve_response.rbi +6 -4
  76. data/rbi/context_dev/models/monitor_update_params.rbi +6 -4
  77. data/rbi/context_dev/models/monitor_update_response.rbi +6 -4
  78. data/rbi/context_dev/models/parse_handle_params.rbi +400 -46
  79. data/rbi/context_dev/models/utility_prefetch_params.rbi +11 -0
  80. data/rbi/context_dev/models/web_extract_competitors_params.rbi +15 -0
  81. data/rbi/context_dev/models/web_extract_fonts_params.rbi +19 -7
  82. data/rbi/context_dev/models/web_extract_params.rbi +26 -0
  83. data/rbi/context_dev/models/web_extract_styleguide_params.rbi +19 -7
  84. data/rbi/context_dev/models/web_screenshot_params.rbi +108 -37
  85. data/rbi/context_dev/models/web_screenshot_response.rbi +4 -2
  86. data/rbi/context_dev/models/web_search_params.rbi +11 -0
  87. data/rbi/context_dev/models/web_web_crawl_md_params.rbi +53 -0
  88. data/rbi/context_dev/models/web_web_scrape_html_params.rbi +554 -49
  89. data/rbi/context_dev/models/web_web_scrape_images_params.rbi +426 -30
  90. data/rbi/context_dev/models/web_web_scrape_md_params.rbi +742 -61
  91. data/rbi/context_dev/models/web_web_scrape_sitemap_params.rbi +82 -0
  92. data/rbi/context_dev/models.rbi +4 -0
  93. data/rbi/context_dev/resources/ai.rbi +3 -0
  94. data/rbi/context_dev/resources/brand.rbi +9 -1
  95. data/rbi/context_dev/resources/industry.rbi +10 -0
  96. data/rbi/context_dev/resources/monitors.rbi +55 -11
  97. data/rbi/context_dev/resources/parse.rbi +46 -19
  98. data/rbi/context_dev/resources/utility.rbi +3 -0
  99. data/rbi/context_dev/resources/web.rbi +224 -48
  100. data/sig/context_dev/models/ai_extract_product_params.rbs +12 -1
  101. data/sig/context_dev/models/ai_extract_products_params.rbs +14 -0
  102. data/sig/context_dev/models/brand_retrieve_params.rbs +97 -51
  103. data/sig/context_dev/models/brand_retrieve_response.rbs +2 -2
  104. data/sig/context_dev/models/brand_retrieve_simplified_params.rbs +34 -5
  105. data/sig/context_dev/models/industry_retrieve_naics_params.rbs +7 -0
  106. data/sig/context_dev/models/industry_retrieve_sic_params.rbs +7 -0
  107. data/sig/context_dev/models/monitor_get_credit_usage_params.rbs +32 -0
  108. data/sig/context_dev/models/monitor_get_credit_usage_response.rbs +52 -0
  109. data/sig/context_dev/models/monitor_get_limits_params.rbs +15 -0
  110. data/sig/context_dev/models/monitor_get_limits_response.rbs +43 -0
  111. data/sig/context_dev/models/monitor_list_params.rbs +8 -14
  112. data/sig/context_dev/models/parse_handle_params.rbs +124 -25
  113. data/sig/context_dev/models/utility_prefetch_params.rbs +7 -0
  114. data/sig/context_dev/models/web_extract_competitors_params.rbs +12 -1
  115. data/sig/context_dev/models/web_extract_fonts_params.rbs +10 -5
  116. data/sig/context_dev/models/web_extract_params.rbs +14 -0
  117. data/sig/context_dev/models/web_extract_styleguide_params.rbs +10 -5
  118. data/sig/context_dev/models/web_screenshot_params.rbs +41 -20
  119. data/sig/context_dev/models/web_search_params.rbs +7 -0
  120. data/sig/context_dev/models/web_web_crawl_md_params.rbs +28 -1
  121. data/sig/context_dev/models/web_web_scrape_html_params.rbs +175 -47
  122. data/sig/context_dev/models/web_web_scrape_images_params.rbs +128 -38
  123. data/sig/context_dev/models/web_web_scrape_md_params.rbs +229 -62
  124. data/sig/context_dev/models/web_web_scrape_sitemap_params.rbs +35 -1
  125. data/sig/context_dev/models.rbs +4 -0
  126. data/sig/context_dev/resources/ai.rbs +1 -0
  127. data/sig/context_dev/resources/brand.rbs +3 -1
  128. data/sig/context_dev/resources/industry.rbs +2 -0
  129. data/sig/context_dev/resources/monitors.rbs +12 -2
  130. data/sig/context_dev/resources/parse.rbs +8 -5
  131. data/sig/context_dev/resources/utility.rbs +1 -0
  132. data/sig/context_dev/resources/web.rbs +47 -26
  133. metadata +14 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 6e76a9e12d2d02a5a2fabf5f621579b215d278c973e9b88eb9c032ea9c5fee8f
4
- data.tar.gz: 5bd0dda46235f5c51359bb91ad1bc53df70f13cb2f49120b6b1b4c5a23958389
3
+ metadata.gz: 441310ead23b6111ba1f51ac02adc5ee730e83a200712f0462a93da65bc9839f
4
+ data.tar.gz: 503cc3805332b56e8f3f16c8aaf39aee232e417dcd912450925cd1fe89dc9671
5
5
  SHA512:
6
- metadata.gz: c2c06bbf5e65076e9867a7beb132b243ecea991290c8c2a8492a0de26936225c1fa7346f0486f9889aa41d1f3b96f5e544d69269d964523169611b2e8256e849
7
- data.tar.gz: 4a4e5d37a6a84ce2854b1dba0eb854312964a144a914db69f418f796b29aeed0e54102ce9b0c3bd03877f26bec65ed5b4979e10675fa547707509d4c1d609334
6
+ metadata.gz: ed1f83de696ab32087ae193f0d89ec188528b4a4671851962526b4c9dfcf31d159d9aa970ba9c6c766c5b910cfd91c509335853c06d0893126ef963330dc85f4
7
+ data.tar.gz: 6b3bddf5bdc32cf2b76a6971d227af43ca209f95f1bc555aec3a9477b24560f757590f92b9c98abeb42ce1acd2c0a7190f72fd8becee750f1653ed73a9ef270c
data/CHANGELOG.md CHANGED
@@ -1,5 +1,21 @@
1
1
  # Changelog
2
2
 
3
+ ## 2.5.0 (2026-07-22)
4
+
5
+ Full Changelog: [v2.4.0...v2.5.0](https://github.com/context-dot-dev/context-ruby-sdk/compare/v2.4.0...v2.5.0)
6
+
7
+ ### Features
8
+
9
+ * **api:** api update ([5af0d4b](https://github.com/context-dot-dev/context-ruby-sdk/commit/5af0d4b1954673356f6200967dbea5ea61685025))
10
+ * **api:** api update ([28793d8](https://github.com/context-dot-dev/context-ruby-sdk/commit/28793d84ed93dcf457aaf3f346056f2480f37724))
11
+ * **api:** api update ([c9c4475](https://github.com/context-dot-dev/context-ruby-sdk/commit/c9c447554772879c742d72ac88174a75fbff599a))
12
+ * **api:** api update ([72e6d90](https://github.com/context-dot-dev/context-ruby-sdk/commit/72e6d90baaeeb9181482488e7b49e511597d2175))
13
+ * **api:** api update ([2574f7d](https://github.com/context-dot-dev/context-ruby-sdk/commit/2574f7db809d8480db2b7ae2705fd2de6a1ce2ff))
14
+ * **api:** api update ([8fb7d29](https://github.com/context-dot-dev/context-ruby-sdk/commit/8fb7d29835d4ffe7eb53b1619d3da20fa45df52c))
15
+ * **api:** api update ([f5684a3](https://github.com/context-dot-dev/context-ruby-sdk/commit/f5684a355f24bf6a80aa904f09087a899f2121aa))
16
+ * **api:** manual updates ([2a83a5f](https://github.com/context-dot-dev/context-ruby-sdk/commit/2a83a5f976bf2b75964ea56ff07f99872acd5022))
17
+ * **stlc:** configurable CI runner and private-production-repo support in workflow templates ([f1c36e9](https://github.com/context-dot-dev/context-ruby-sdk/commit/f1c36e95f04eb617aa1769ba9cd21e3dad7bc5ee))
18
+
3
19
  ## 2.4.0 (2026-07-12)
4
20
 
5
21
  Full Changelog: [v2.3.0...v2.4.0](https://github.com/context-dot-dev/context-ruby-sdk/compare/v2.3.0...v2.4.0)
data/README.md CHANGED
@@ -26,7 +26,7 @@ To use this gem, install via Bundler by adding the following to your application
26
26
  <!-- x-release-please-start-version -->
27
27
 
28
28
  ```ruby
29
- gem "context.dev", "~> 2.4.0"
29
+ gem "context.dev", "~> 2.5.0"
30
30
  ```
31
31
 
32
32
  <!-- x-release-please-end -->
@@ -21,6 +21,12 @@ module ContextDev
21
21
  # @return [Integer, nil]
22
22
  optional :max_age_ms, Integer, api_name: :maxAgeMs
23
23
 
24
+ # @!attribute tags
25
+ # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
26
+ #
27
+ # @return [Array<String>, nil]
28
+ optional :tags, ContextDev::Internal::Type::ArrayOf[String]
29
+
24
30
  # @!attribute timeout_ms
25
31
  # Optional timeout in milliseconds for the request. If the request takes longer
26
32
  # than this value, it will be aborted with a 408 status code. Maximum allowed
@@ -29,7 +35,7 @@ module ContextDev
29
35
  # @return [Integer, nil]
30
36
  optional :timeout_ms, Integer, api_name: :timeoutMS
31
37
 
32
- # @!method initialize(url:, max_age_ms: nil, timeout_ms: nil, request_options: {})
38
+ # @!method initialize(url:, max_age_ms: nil, tags: nil, timeout_ms: nil, request_options: {})
33
39
  # Some parameter documentations has been truncated, see
34
40
  # {ContextDev::Models::AIExtractProductParams} for more details.
35
41
  #
@@ -37,6 +43,8 @@ module ContextDev
37
43
  #
38
44
  # @param max_age_ms [Integer] Return a cached result if a prior scrape for the same parameters exists and is y
39
45
  #
46
+ # @param tags [Array<String>] Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
47
+ #
40
48
  # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
41
49
  #
42
50
  # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
@@ -44,6 +44,12 @@ module ContextDev
44
44
  # @return [Integer, nil]
45
45
  optional :max_products, Integer, api_name: :maxProducts
46
46
 
47
+ # @!attribute tags
48
+ # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
49
+ #
50
+ # @return [Array<String>, nil]
51
+ optional :tags, ContextDev::Internal::Type::ArrayOf[String]
52
+
47
53
  # @!attribute timeout_ms
48
54
  # Optional timeout in milliseconds for the request. If the request takes longer
49
55
  # than this value, it will be aborted with a 408 status code. Maximum allowed
@@ -52,7 +58,7 @@ module ContextDev
52
58
  # @return [Integer, nil]
53
59
  optional :timeout_ms, Integer, api_name: :timeoutMS
54
60
 
55
- # @!method initialize(domain:, max_age_ms: nil, max_products: nil, timeout_ms: nil)
61
+ # @!method initialize(domain:, max_age_ms: nil, max_products: nil, tags: nil, timeout_ms: nil)
56
62
  # Some parameter documentations has been truncated, see
57
63
  # {ContextDev::Models::AIExtractProductsParams::Body::ByDomain} for more details.
58
64
  #
@@ -62,6 +68,8 @@ module ContextDev
62
68
  #
63
69
  # @param max_products [Integer] Maximum number of products to extract.
64
70
  #
71
+ # @param tags [Array<String>] Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
72
+ #
65
73
  # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
66
74
  end
67
75
 
@@ -87,6 +95,12 @@ module ContextDev
87
95
  # @return [Integer, nil]
88
96
  optional :max_products, Integer, api_name: :maxProducts
89
97
 
98
+ # @!attribute tags
99
+ # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
100
+ #
101
+ # @return [Array<String>, nil]
102
+ optional :tags, ContextDev::Internal::Type::ArrayOf[String]
103
+
90
104
  # @!attribute timeout_ms
91
105
  # Optional timeout in milliseconds for the request. If the request takes longer
92
106
  # than this value, it will be aborted with a 408 status code. Maximum allowed
@@ -95,7 +109,7 @@ module ContextDev
95
109
  # @return [Integer, nil]
96
110
  optional :timeout_ms, Integer, api_name: :timeoutMS
97
111
 
98
- # @!method initialize(direct_url:, max_age_ms: nil, max_products: nil, timeout_ms: nil)
112
+ # @!method initialize(direct_url:, max_age_ms: nil, max_products: nil, tags: nil, timeout_ms: nil)
99
113
  # Some parameter documentations has been truncated, see
100
114
  # {ContextDev::Models::AIExtractProductsParams::Body::ByDirectURL} for more
101
115
  # details.
@@ -106,6 +120,8 @@ module ContextDev
106
120
  #
107
121
  # @param max_products [Integer] Maximum number of products to extract.
108
122
  #
123
+ # @param tags [Array<String>] Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
124
+ #
109
125
  # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
110
126
  end
111
127
 
@@ -58,7 +58,9 @@ module ContextDev
58
58
  # @!attribute force_language
59
59
  #
60
60
  # @return [Symbol, ContextDev::Models::BrandRetrieveParams::Body::ByDomain::ForceLanguage, nil]
61
- optional :force_language, enum: -> { ContextDev::BrandRetrieveParams::Body::ByDomain::ForceLanguage }
61
+ optional :force_language,
62
+ enum: -> { ContextDev::BrandRetrieveParams::Body::ByDomain::ForceLanguage },
63
+ nil?: true
62
64
 
63
65
  # @!attribute max_age_ms
64
66
  # Maximum age in milliseconds for cached brand data before the API performs a hard
@@ -77,6 +79,12 @@ module ContextDev
77
79
  # @return [Boolean, nil]
78
80
  optional :max_speed, ContextDev::Internal::Type::Boolean, api_name: :maxSpeed
79
81
 
82
+ # @!attribute tags
83
+ # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
84
+ #
85
+ # @return [Array<String>, nil]
86
+ optional :tags, ContextDev::Internal::Type::ArrayOf[String]
87
+
80
88
  # @!attribute timeout_ms
81
89
  # Optional timeout in milliseconds for the request. If the request takes longer
82
90
  # than this value, it will be aborted with a 408 status code. Maximum allowed
@@ -85,7 +93,7 @@ module ContextDev
85
93
  # @return [Integer, nil]
86
94
  optional :timeout_ms, Integer, api_name: :timeoutMS
87
95
 
88
- # @!method initialize(domain:, force_language: nil, max_age_ms: nil, max_speed: nil, timeout_ms: nil, type: :by_domain)
96
+ # @!method initialize(domain:, force_language: nil, max_age_ms: nil, max_speed: nil, tags: nil, timeout_ms: nil, type: :by_domain)
89
97
  # Some parameter documentations has been truncated, see
90
98
  # {ContextDev::Models::BrandRetrieveParams::Body::ByDomain} for more details.
91
99
  #
@@ -93,12 +101,14 @@ module ContextDev
93
101
  #
94
102
  # @param domain [String] Domain name to retrieve brand data for (e.g., 'stripe.com').
95
103
  #
96
- # @param force_language [Symbol, ContextDev::Models::BrandRetrieveParams::Body::ByDomain::ForceLanguage]
104
+ # @param force_language [Symbol, ContextDev::Models::BrandRetrieveParams::Body::ByDomain::ForceLanguage, nil]
97
105
  #
98
106
  # @param max_age_ms [Integer] Maximum age in milliseconds for cached brand data before the API performs a hard
99
107
  #
100
108
  # @param max_speed [Boolean] Optional parameter to optimize the API call for maximum speed. When set to true,
101
109
  #
110
+ # @param tags [Array<String>] Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
111
+ #
102
112
  # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
103
113
  #
104
114
  # @param type [Symbol, :by_domain] Discriminator for domain-based brand retrieval.
@@ -256,7 +266,9 @@ module ContextDev
256
266
  # @!attribute force_language
257
267
  #
258
268
  # @return [Symbol, ContextDev::Models::BrandRetrieveParams::Body::ByName::ForceLanguage, nil]
259
- optional :force_language, enum: -> { ContextDev::BrandRetrieveParams::Body::ByName::ForceLanguage }
269
+ optional :force_language,
270
+ enum: -> { ContextDev::BrandRetrieveParams::Body::ByName::ForceLanguage },
271
+ nil?: true
260
272
 
261
273
  # @!attribute max_age_ms
262
274
  # Maximum age in milliseconds for cached brand data before the API performs a hard
@@ -275,6 +287,12 @@ module ContextDev
275
287
  # @return [Boolean, nil]
276
288
  optional :max_speed, ContextDev::Internal::Type::Boolean, api_name: :maxSpeed
277
289
 
290
+ # @!attribute tags
291
+ # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
292
+ #
293
+ # @return [Array<String>, nil]
294
+ optional :tags, ContextDev::Internal::Type::ArrayOf[String]
295
+
278
296
  # @!attribute timeout_ms
279
297
  # Optional timeout in milliseconds for the request. If the request takes longer
280
298
  # than this value, it will be aborted with a 408 status code. Maximum allowed
@@ -283,7 +301,7 @@ module ContextDev
283
301
  # @return [Integer, nil]
284
302
  optional :timeout_ms, Integer, api_name: :timeoutMS
285
303
 
286
- # @!method initialize(name:, country_gl: nil, force_language: nil, max_age_ms: nil, max_speed: nil, timeout_ms: nil, type: :by_name)
304
+ # @!method initialize(name:, country_gl: nil, force_language: nil, max_age_ms: nil, max_speed: nil, tags: nil, timeout_ms: nil, type: :by_name)
287
305
  # Some parameter documentations has been truncated, see
288
306
  # {ContextDev::Models::BrandRetrieveParams::Body::ByName} for more details.
289
307
  #
@@ -294,12 +312,14 @@ module ContextDev
294
312
  #
295
313
  # @param country_gl [String] Optional country code hint (GL parameter) to specify the country when looking up
296
314
  #
297
- # @param force_language [Symbol, ContextDev::Models::BrandRetrieveParams::Body::ByName::ForceLanguage]
315
+ # @param force_language [Symbol, ContextDev::Models::BrandRetrieveParams::Body::ByName::ForceLanguage, nil]
298
316
  #
299
317
  # @param max_age_ms [Integer] Maximum age in milliseconds for cached brand data before the API performs a hard
300
318
  #
301
319
  # @param max_speed [Boolean] Optional parameter to optimize the API call for maximum speed. When set to true,
302
320
  #
321
+ # @param tags [Array<String>] Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
322
+ #
303
323
  # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
304
324
  #
305
325
  # @param type [Symbol, :by_name] Discriminator for name-based brand retrieval.
@@ -450,7 +470,9 @@ module ContextDev
450
470
  # @!attribute force_language
451
471
  #
452
472
  # @return [Symbol, ContextDev::Models::BrandRetrieveParams::Body::ByEmail::ForceLanguage, nil]
453
- optional :force_language, enum: -> { ContextDev::BrandRetrieveParams::Body::ByEmail::ForceLanguage }
473
+ optional :force_language,
474
+ enum: -> { ContextDev::BrandRetrieveParams::Body::ByEmail::ForceLanguage },
475
+ nil?: true
454
476
 
455
477
  # @!attribute max_age_ms
456
478
  # Maximum age in milliseconds for cached brand data before the API performs a hard
@@ -469,6 +491,12 @@ module ContextDev
469
491
  # @return [Boolean, nil]
470
492
  optional :max_speed, ContextDev::Internal::Type::Boolean, api_name: :maxSpeed
471
493
 
494
+ # @!attribute tags
495
+ # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
496
+ #
497
+ # @return [Array<String>, nil]
498
+ optional :tags, ContextDev::Internal::Type::ArrayOf[String]
499
+
472
500
  # @!attribute timeout_ms
473
501
  # Optional timeout in milliseconds for the request. If the request takes longer
474
502
  # than this value, it will be aborted with a 408 status code. Maximum allowed
@@ -477,7 +505,7 @@ module ContextDev
477
505
  # @return [Integer, nil]
478
506
  optional :timeout_ms, Integer, api_name: :timeoutMS
479
507
 
480
- # @!method initialize(email:, force_language: nil, max_age_ms: nil, max_speed: nil, timeout_ms: nil, type: :by_email)
508
+ # @!method initialize(email:, force_language: nil, max_age_ms: nil, max_speed: nil, tags: nil, timeout_ms: nil, type: :by_email)
481
509
  # Some parameter documentations has been truncated, see
482
510
  # {ContextDev::Models::BrandRetrieveParams::Body::ByEmail} for more details.
483
511
  #
@@ -487,12 +515,14 @@ module ContextDev
487
515
  #
488
516
  # @param email [String] Email address to retrieve brand data for (e.g., 'jane@stripe.com').
489
517
  #
490
- # @param force_language [Symbol, ContextDev::Models::BrandRetrieveParams::Body::ByEmail::ForceLanguage]
518
+ # @param force_language [Symbol, ContextDev::Models::BrandRetrieveParams::Body::ByEmail::ForceLanguage, nil]
491
519
  #
492
520
  # @param max_age_ms [Integer] Maximum age in milliseconds for cached brand data before the API performs a hard
493
521
  #
494
522
  # @param max_speed [Boolean] Optional parameter to optimize the API call for maximum speed. When set to true,
495
523
  #
524
+ # @param tags [Array<String>] Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
525
+ #
496
526
  # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
497
527
  #
498
528
  # @param type [Symbol, :by_email] Discriminator for email-based brand retrieval.
@@ -643,7 +673,9 @@ module ContextDev
643
673
  # @!attribute force_language
644
674
  #
645
675
  # @return [Symbol, ContextDev::Models::BrandRetrieveParams::Body::ByTicker::ForceLanguage, nil]
646
- optional :force_language, enum: -> { ContextDev::BrandRetrieveParams::Body::ByTicker::ForceLanguage }
676
+ optional :force_language,
677
+ enum: -> { ContextDev::BrandRetrieveParams::Body::ByTicker::ForceLanguage },
678
+ nil?: true
647
679
 
648
680
  # @!attribute max_age_ms
649
681
  # Maximum age in milliseconds for cached brand data before the API performs a hard
@@ -662,6 +694,12 @@ module ContextDev
662
694
  # @return [Boolean, nil]
663
695
  optional :max_speed, ContextDev::Internal::Type::Boolean, api_name: :maxSpeed
664
696
 
697
+ # @!attribute tags
698
+ # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
699
+ #
700
+ # @return [Array<String>, nil]
701
+ optional :tags, ContextDev::Internal::Type::ArrayOf[String]
702
+
665
703
  # @!attribute ticker_exchange
666
704
  # Optional stock exchange for the ticker. Defaults to NASDAQ if not specified.
667
705
  #
@@ -676,7 +714,7 @@ module ContextDev
676
714
  # @return [Integer, nil]
677
715
  optional :timeout_ms, Integer, api_name: :timeoutMS
678
716
 
679
- # @!method initialize(ticker:, force_language: nil, max_age_ms: nil, max_speed: nil, ticker_exchange: nil, timeout_ms: nil, type: :by_ticker)
717
+ # @!method initialize(ticker:, force_language: nil, max_age_ms: nil, max_speed: nil, tags: nil, ticker_exchange: nil, timeout_ms: nil, type: :by_ticker)
680
718
  # Some parameter documentations has been truncated, see
681
719
  # {ContextDev::Models::BrandRetrieveParams::Body::ByTicker} for more details.
682
720
  #
@@ -685,12 +723,14 @@ module ContextDev
685
723
  #
686
724
  # @param ticker [String] Stock ticker symbol to retrieve brand data for (e.g., 'AAPL').
687
725
  #
688
- # @param force_language [Symbol, ContextDev::Models::BrandRetrieveParams::Body::ByTicker::ForceLanguage]
726
+ # @param force_language [Symbol, ContextDev::Models::BrandRetrieveParams::Body::ByTicker::ForceLanguage, nil]
689
727
  #
690
728
  # @param max_age_ms [Integer] Maximum age in milliseconds for cached brand data before the API performs a hard
691
729
  #
692
730
  # @param max_speed [Boolean] Optional parameter to optimize the API call for maximum speed. When set to true,
693
731
  #
732
+ # @param tags [Array<String>] Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
733
+ #
694
734
  # @param ticker_exchange [String] Optional stock exchange for the ticker. Defaults to NASDAQ if not specified.
695
735
  #
696
736
  # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
@@ -842,6 +882,12 @@ module ContextDev
842
882
  # @return [Symbol, :by_direct_url]
843
883
  required :type, const: :by_direct_url
844
884
 
885
+ # @!attribute tags
886
+ # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
887
+ #
888
+ # @return [Array<String>, nil]
889
+ optional :tags, ContextDev::Internal::Type::ArrayOf[String]
890
+
845
891
  # @!attribute timeout_ms
846
892
  # Optional timeout in milliseconds for the request. If the request takes longer
847
893
  # than this value, it will be aborted with a 408 status code. Maximum allowed
@@ -850,7 +896,7 @@ module ContextDev
850
896
  # @return [Integer, nil]
851
897
  optional :timeout_ms, Integer, api_name: :timeoutMS
852
898
 
853
- # @!method initialize(direct_url:, timeout_ms: nil, type: :by_direct_url)
899
+ # @!method initialize(direct_url:, tags: nil, timeout_ms: nil, type: :by_direct_url)
854
900
  # Some parameter documentations has been truncated, see
855
901
  # {ContextDev::Models::BrandRetrieveParams::Body::ByDirectURL} for more details.
856
902
  #
@@ -862,6 +908,8 @@ module ContextDev
862
908
  #
863
909
  # @param direct_url [String] Full http(s) URL to fetch brand data from (e.g., 'https://stripe.com/enterprise'
864
910
  #
911
+ # @param tags [Array<String>] Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
912
+ #
865
913
  # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
866
914
  #
867
915
  # @param type [Symbol, :by_direct_url] Discriminator for direct-URL-based brand retrieval.
@@ -896,7 +944,9 @@ module ContextDev
896
944
  # @!attribute force_language
897
945
  #
898
946
  # @return [Symbol, ContextDev::Models::BrandRetrieveParams::Body::ByTransaction::ForceLanguage, nil]
899
- optional :force_language, enum: -> { ContextDev::BrandRetrieveParams::Body::ByTransaction::ForceLanguage }
947
+ optional :force_language,
948
+ enum: -> { ContextDev::BrandRetrieveParams::Body::ByTransaction::ForceLanguage },
949
+ nil?: true
900
950
 
901
951
  # @!attribute high_confidence_only
902
952
  # When set to true, the API performs additional verification to ensure the
@@ -917,14 +967,20 @@ module ContextDev
917
967
  # Optional Merchant Category Code (MCC) to help identify the business category or
918
968
  # industry.
919
969
  #
920
- # @return [Integer, nil]
921
- optional :mcc, Integer
970
+ # @return [String, Float, nil]
971
+ optional :mcc, union: -> { ContextDev::BrandRetrieveParams::Body::ByTransaction::Mcc }
922
972
 
923
973
  # @!attribute phone
924
974
  # Optional phone number from the transaction to help verify brand match.
925
975
  #
926
- # @return [Float, nil]
927
- optional :phone, Float
976
+ # @return [String, Float, nil]
977
+ optional :phone, union: -> { ContextDev::BrandRetrieveParams::Body::ByTransaction::Phone }
978
+
979
+ # @!attribute tags
980
+ # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
981
+ #
982
+ # @return [Array<String>, nil]
983
+ optional :tags, ContextDev::Internal::Type::ArrayOf[String]
928
984
 
929
985
  # @!attribute timeout_ms
930
986
  # Optional timeout in milliseconds for the request. If the request takes longer
@@ -934,7 +990,7 @@ module ContextDev
934
990
  # @return [Integer, nil]
935
991
  optional :timeout_ms, Integer, api_name: :timeoutMS
936
992
 
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)
993
+ # @!method initialize(transaction_info:, city: nil, country_gl: nil, force_language: nil, high_confidence_only: nil, max_speed: nil, mcc: nil, phone: nil, tags: nil, timeout_ms: nil, type: :by_transaction)
938
994
  # Some parameter documentations has been truncated, see
939
995
  # {ContextDev::Models::BrandRetrieveParams::Body::ByTransaction} for more details.
940
996
  #
@@ -947,15 +1003,17 @@ module ContextDev
947
1003
  #
948
1004
  # @param country_gl [String] Optional country code hint (GL parameter) to specify the country when identifyin
949
1005
  #
950
- # @param force_language [Symbol, ContextDev::Models::BrandRetrieveParams::Body::ByTransaction::ForceLanguage]
1006
+ # @param force_language [Symbol, ContextDev::Models::BrandRetrieveParams::Body::ByTransaction::ForceLanguage, nil]
951
1007
  #
952
1008
  # @param high_confidence_only [Boolean] When set to true, the API performs additional verification to ensure the identif
953
1009
  #
954
1010
  # @param max_speed [Boolean] Optional parameter to optimize the API call for maximum speed. When set to true,
955
1011
  #
956
- # @param mcc [Integer] Optional Merchant Category Code (MCC) to help identify the business category or
1012
+ # @param mcc [String, Float] Optional Merchant Category Code (MCC) to help identify the business category or
957
1013
  #
958
- # @param phone [Float] Optional phone number from the transaction to help verify brand match.
1014
+ # @param phone [String, Float] Optional phone number from the transaction to help verify brand match.
1015
+ #
1016
+ # @param tags [Array<String>] Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
959
1017
  #
960
1018
  # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
961
1019
  #
@@ -1089,6 +1147,35 @@ module ContextDev
1089
1147
  # @!method self.values
1090
1148
  # @return [Array<Symbol>]
1091
1149
  end
1150
+
1151
+ # Optional Merchant Category Code (MCC) to help identify the business category or
1152
+ # industry.
1153
+ #
1154
+ # @see ContextDev::Models::BrandRetrieveParams::Body::ByTransaction#mcc
1155
+ module Mcc
1156
+ extend ContextDev::Internal::Type::Union
1157
+
1158
+ variant String
1159
+
1160
+ variant Float
1161
+
1162
+ # @!method self.variants
1163
+ # @return [Array(String, Float)]
1164
+ end
1165
+
1166
+ # Optional phone number from the transaction to help verify brand match.
1167
+ #
1168
+ # @see ContextDev::Models::BrandRetrieveParams::Body::ByTransaction#phone
1169
+ module Phone
1170
+ extend ContextDev::Internal::Type::Union
1171
+
1172
+ variant String
1173
+
1174
+ variant Float
1175
+
1176
+ # @!method self.variants
1177
+ # @return [Array(String, Float)]
1178
+ end
1092
1179
  end
1093
1180
 
1094
1181
  # @!method self.variants
@@ -113,8 +113,7 @@ module ContextDev
113
113
  optional :phone, String
114
114
 
115
115
  # @!attribute primary_language
116
- # The primary language of the brand's website content. Detected from the HTML lang
117
- # tag, page content analysis, or social media descriptions.
116
+ # Language to force for the retrieved brand data.
118
117
  #
119
118
  # @return [Symbol, ContextDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage, nil]
120
119
  optional :primary_language,
@@ -175,7 +174,7 @@ module ContextDev
175
174
  #
176
175
  # @param phone [String] Company phone number
177
176
  #
178
- # @param primary_language [Symbol, ContextDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage, nil] The primary language of the brand's website content. Detected from the HTML lang
177
+ # @param primary_language [Symbol, ContextDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage, nil] Language to force for the retrieved brand data.
179
178
  #
180
179
  # @param slogan [String] The brand's slogan
181
180
  #
@@ -468,7 +467,6 @@ module ContextDev
468
467
  STREAMING_PLATFORMS_VIDEO_MUSIC_AUDIO = :"Streaming Platforms (Video, Music, Audio)"
469
468
  GAMING_INTERACTIVE_ENTERTAINMENT = :"Gaming & Interactive Entertainment"
470
469
  CREATOR_ECONOMY_INFLUENCER_PLATFORMS = :"Creator Economy & Influencer Platforms"
471
- ADVERTISING_ADTECH_MEDIA_BUYING = :"Advertising, Adtech & Media Buying"
472
470
  FILM_TV_PRODUCTION_STUDIOS = :"Film, TV & Production Studios"
473
471
  EVENTS_VENUES_LIVE_ENTERTAINMENT = :"Events, Venues & Live Entertainment"
474
472
  VIRTUAL_WORLDS_METAVERSE_EXPERIENCES = :"Virtual Worlds & Metaverse Experiences"
@@ -529,6 +527,7 @@ module ContextDev
529
527
  STREETWEAR_EMERGING_LUXURY = :"Streetwear & Emerging Luxury"
530
528
  COUTURE_MADE_TO_MEASURE = :"Couture & Made-to-Measure"
531
529
  NEWS_PUBLISHING_JOURNALISM = :"News Publishing & Journalism"
530
+ ADVERTISING_ADTECH_MEDIA_BUYING = :"Advertising, Adtech & Media Buying"
532
531
  DIGITAL_MEDIA_CONTENT_PLATFORMS = :"Digital Media & Content Platforms"
533
532
  BROADCASTING_TV_RADIO = :"Broadcasting (TV & Radio)"
534
533
  PODCASTING_AUDIO_MEDIA = :"Podcasting & Audio Media"
@@ -826,8 +825,7 @@ module ContextDev
826
825
  end
827
826
  end
828
827
 
829
- # The primary language of the brand's website content. Detected from the HTML lang
830
- # tag, page content analysis, or social media descriptions.
828
+ # Language to force for the retrieved brand data.
831
829
  #
832
830
  # @see ContextDev::Models::BrandRetrieveResponse::Brand#primary_language
833
831
  module PrimaryLanguage
@@ -20,7 +20,21 @@ module ContextDev
20
20
  # year.
21
21
  #
22
22
  # @return [Integer, nil]
23
- optional :max_age_ms, Integer
23
+ optional :max_age_ms, Integer, nil?: true
24
+
25
+ # @!attribute tags
26
+ # Optional comma-separated caller-defined tags for tracking this request. Tags are
27
+ # recorded on the request's usage log and can be used to filter usage on the
28
+ # dashboard usage page. Up to 20 tags, each 1-50 characters.
29
+ #
30
+ # @return [Array<String>, nil]
31
+ optional :tags, ContextDev::Internal::Type::ArrayOf[String]
32
+
33
+ # @!attribute theme
34
+ # Optional theme preference used when selecting brand assets.
35
+ #
36
+ # @return [Symbol, ContextDev::Models::BrandRetrieveSimplifiedParams::Theme, nil]
37
+ optional :theme, enum: -> { ContextDev::BrandRetrieveSimplifiedParams::Theme }
24
38
 
25
39
  # @!attribute timeout_ms
26
40
  # Optional timeout in milliseconds for the request. If the request takes longer
@@ -30,17 +44,32 @@ module ContextDev
30
44
  # @return [Integer, nil]
31
45
  optional :timeout_ms, Integer
32
46
 
33
- # @!method initialize(domain:, max_age_ms: nil, timeout_ms: nil, request_options: {})
47
+ # @!method initialize(domain:, max_age_ms: nil, tags: nil, theme: nil, timeout_ms: nil, request_options: {})
34
48
  # Some parameter documentations has been truncated, see
35
49
  # {ContextDev::Models::BrandRetrieveSimplifiedParams} for more details.
36
50
  #
37
51
  # @param domain [String] Domain name to retrieve simplified brand data for
38
52
  #
39
- # @param max_age_ms [Integer] Maximum age in milliseconds for cached brand data before the API performs a hard
53
+ # @param max_age_ms [Integer, nil] Maximum age in milliseconds for cached brand data before the API performs a hard
54
+ #
55
+ # @param tags [Array<String>] Optional comma-separated caller-defined tags for tracking this request. Tags are
56
+ #
57
+ # @param theme [Symbol, ContextDev::Models::BrandRetrieveSimplifiedParams::Theme] Optional theme preference used when selecting brand assets.
40
58
  #
41
59
  # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
42
60
  #
43
61
  # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
62
+
63
+ # Optional theme preference used when selecting brand assets.
64
+ module Theme
65
+ extend ContextDev::Internal::Type::Enum
66
+
67
+ LIGHT = :light
68
+ DARK = :dark
69
+
70
+ # @!method self.values
71
+ # @return [Array<Symbol>]
72
+ end
44
73
  end
45
74
  end
46
75
  end
@@ -28,6 +28,14 @@ module ContextDev
28
28
  # @return [Integer, nil]
29
29
  optional :min_results, Integer
30
30
 
31
+ # @!attribute tags
32
+ # Optional comma-separated caller-defined tags for tracking this request. Tags are
33
+ # recorded on the request's usage log and can be used to filter usage on the
34
+ # dashboard usage page. Up to 20 tags, each 1-50 characters.
35
+ #
36
+ # @return [Array<String>, nil]
37
+ optional :tags, ContextDev::Internal::Type::ArrayOf[String]
38
+
31
39
  # @!attribute timeout_ms
32
40
  # Optional timeout in milliseconds for the request. If the request takes longer
33
41
  # than this value, it will be aborted with a 408 status code. Maximum allowed
@@ -36,7 +44,7 @@ module ContextDev
36
44
  # @return [Integer, nil]
37
45
  optional :timeout_ms, Integer
38
46
 
39
- # @!method initialize(input:, max_results: nil, min_results: nil, timeout_ms: nil, request_options: {})
47
+ # @!method initialize(input:, max_results: nil, min_results: nil, tags: nil, timeout_ms: nil, request_options: {})
40
48
  # Some parameter documentations has been truncated, see
41
49
  # {ContextDev::Models::IndustryRetrieveNaicsParams} for more details.
42
50
  #
@@ -46,6 +54,8 @@ module ContextDev
46
54
  #
47
55
  # @param min_results [Integer] Minimum number of NAICS codes to return. Must be at least 1. Defaults to 1.
48
56
  #
57
+ # @param tags [Array<String>] Optional comma-separated caller-defined tags for tracking this request. Tags are
58
+ #
49
59
  # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
50
60
  #
51
61
  # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
@@ -27,6 +27,14 @@ module ContextDev
27
27
  # @return [Integer, nil]
28
28
  optional :min_results, Integer
29
29
 
30
+ # @!attribute tags
31
+ # Optional comma-separated caller-defined tags for tracking this request. Tags are
32
+ # recorded on the request's usage log and can be used to filter usage on the
33
+ # dashboard usage page. Up to 20 tags, each 1-50 characters.
34
+ #
35
+ # @return [Array<String>, nil]
36
+ optional :tags, ContextDev::Internal::Type::ArrayOf[String]
37
+
30
38
  # @!attribute timeout_ms
31
39
  # Optional timeout in milliseconds for the request. If the request takes longer
32
40
  # than this value, it will be aborted with a 408 status code. Maximum allowed
@@ -43,7 +51,7 @@ module ContextDev
43
51
  # @return [Symbol, ContextDev::Models::IndustryRetrieveSicParams::Type, nil]
44
52
  optional :type, enum: -> { ContextDev::IndustryRetrieveSicParams::Type }
45
53
 
46
- # @!method initialize(input:, max_results: nil, min_results: nil, timeout_ms: nil, type: nil, request_options: {})
54
+ # @!method initialize(input:, max_results: nil, min_results: nil, tags: nil, timeout_ms: nil, type: nil, request_options: {})
47
55
  # Some parameter documentations has been truncated, see
48
56
  # {ContextDev::Models::IndustryRetrieveSicParams} for more details.
49
57
  #
@@ -53,6 +61,8 @@ module ContextDev
53
61
  #
54
62
  # @param min_results [Integer] Minimum number of SIC codes to return. Must be at least 1. Defaults to 1.
55
63
  #
64
+ # @param tags [Array<String>] Optional comma-separated caller-defined tags for tracking this request. Tags are
65
+ #
56
66
  # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
57
67
  #
58
68
  # @param type [Symbol, ContextDev::Models::IndustryRetrieveSicParams::Type] Which SIC dataset to classify against. `original_sic` uses the 1987 Standard Ind