context.dev 1.31.0 → 1.32.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 (86) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +9 -0
  3. data/README.md +1 -1
  4. data/lib/context_dev/models/ai_ai_query_response.rb +36 -1
  5. data/lib/context_dev/models/ai_extract_product_response.rb +36 -1
  6. data/lib/context_dev/models/ai_extract_products_response.rb +36 -1
  7. data/lib/context_dev/models/brand_identify_from_transaction_response.rb +36 -1
  8. data/lib/context_dev/models/brand_retrieve_by_email_response.rb +36 -1
  9. data/lib/context_dev/models/brand_retrieve_by_isin_response.rb +36 -1
  10. data/lib/context_dev/models/brand_retrieve_by_name_response.rb +36 -1
  11. data/lib/context_dev/models/brand_retrieve_by_ticker_response.rb +36 -1
  12. data/lib/context_dev/models/brand_retrieve_response.rb +36 -1
  13. data/lib/context_dev/models/brand_retrieve_simplified_response.rb +36 -1
  14. data/lib/context_dev/models/industry_retrieve_naics_response.rb +36 -1
  15. data/lib/context_dev/models/industry_retrieve_sic_response.rb +33 -1
  16. data/lib/context_dev/models/utility_prefetch_by_email_response.rb +36 -1
  17. data/lib/context_dev/models/utility_prefetch_response.rb +36 -1
  18. data/lib/context_dev/models/web_extract_competitors_response.rb +36 -1
  19. data/lib/context_dev/models/web_extract_fonts_response.rb +33 -1
  20. data/lib/context_dev/models/web_extract_params.rb +18 -1
  21. data/lib/context_dev/models/web_extract_response.rb +36 -1
  22. data/lib/context_dev/models/web_extract_styleguide_response.rb +36 -1
  23. data/lib/context_dev/models/web_screenshot_response.rb +36 -1
  24. data/lib/context_dev/models/web_search_response.rb +36 -1
  25. data/lib/context_dev/models/web_web_crawl_md_response.rb +37 -1
  26. data/lib/context_dev/models/web_web_scrape_html_response.rb +33 -1
  27. data/lib/context_dev/models/web_web_scrape_images_response.rb +36 -1
  28. data/lib/context_dev/models/web_web_scrape_md_response.rb +36 -1
  29. data/lib/context_dev/models/web_web_scrape_sitemap_response.rb +36 -1
  30. data/lib/context_dev/resources/web.rb +5 -1
  31. data/lib/context_dev/version.rb +1 -1
  32. data/rbi/context_dev/models/ai_ai_query_response.rbi +62 -0
  33. data/rbi/context_dev/models/ai_extract_product_response.rbi +65 -0
  34. data/rbi/context_dev/models/ai_extract_products_response.rbi +65 -0
  35. data/rbi/context_dev/models/brand_identify_from_transaction_response.rbi +67 -0
  36. data/rbi/context_dev/models/brand_retrieve_by_email_response.rbi +67 -0
  37. data/rbi/context_dev/models/brand_retrieve_by_isin_response.rbi +67 -0
  38. data/rbi/context_dev/models/brand_retrieve_by_name_response.rbi +67 -0
  39. data/rbi/context_dev/models/brand_retrieve_by_ticker_response.rbi +67 -0
  40. data/rbi/context_dev/models/brand_retrieve_response.rbi +65 -0
  41. data/rbi/context_dev/models/brand_retrieve_simplified_response.rbi +67 -0
  42. data/rbi/context_dev/models/industry_retrieve_naics_response.rbi +67 -0
  43. data/rbi/context_dev/models/industry_retrieve_sic_response.rbi +67 -0
  44. data/rbi/context_dev/models/utility_prefetch_by_email_response.rbi +79 -4
  45. data/rbi/context_dev/models/utility_prefetch_response.rbi +77 -4
  46. data/rbi/context_dev/models/web_extract_competitors_response.rbi +70 -3
  47. data/rbi/context_dev/models/web_extract_fonts_response.rbi +68 -3
  48. data/rbi/context_dev/models/web_extract_params.rbi +24 -0
  49. data/rbi/context_dev/models/web_extract_response.rbi +65 -3
  50. data/rbi/context_dev/models/web_extract_styleguide_response.rbi +67 -0
  51. data/rbi/context_dev/models/web_screenshot_response.rbi +65 -0
  52. data/rbi/context_dev/models/web_search_response.rbi +65 -3
  53. data/rbi/context_dev/models/web_web_crawl_md_response.rbi +71 -3
  54. data/rbi/context_dev/models/web_web_scrape_html_response.rbi +68 -3
  55. data/rbi/context_dev/models/web_web_scrape_images_response.rbi +68 -3
  56. data/rbi/context_dev/models/web_web_scrape_md_response.rbi +68 -3
  57. data/rbi/context_dev/models/web_web_scrape_sitemap_response.rbi +70 -3
  58. data/rbi/context_dev/resources/web.rbi +7 -0
  59. data/sig/context_dev/models/ai_ai_query_response.rbs +28 -0
  60. data/sig/context_dev/models/ai_extract_product_response.rbs +28 -0
  61. data/sig/context_dev/models/ai_extract_products_response.rbs +28 -0
  62. data/sig/context_dev/models/brand_identify_from_transaction_response.rbs +28 -0
  63. data/sig/context_dev/models/brand_retrieve_by_email_response.rbs +28 -0
  64. data/sig/context_dev/models/brand_retrieve_by_isin_response.rbs +28 -0
  65. data/sig/context_dev/models/brand_retrieve_by_name_response.rbs +28 -0
  66. data/sig/context_dev/models/brand_retrieve_by_ticker_response.rbs +28 -0
  67. data/sig/context_dev/models/brand_retrieve_response.rbs +28 -0
  68. data/sig/context_dev/models/brand_retrieve_simplified_response.rbs +28 -0
  69. data/sig/context_dev/models/industry_retrieve_naics_response.rbs +28 -0
  70. data/sig/context_dev/models/industry_retrieve_sic_response.rbs +28 -0
  71. data/sig/context_dev/models/utility_prefetch_by_email_response.rbs +38 -2
  72. data/sig/context_dev/models/utility_prefetch_response.rbs +38 -2
  73. data/sig/context_dev/models/web_extract_competitors_response.rbs +31 -3
  74. data/sig/context_dev/models/web_extract_fonts_response.rbs +31 -3
  75. data/sig/context_dev/models/web_extract_params.rbs +14 -0
  76. data/sig/context_dev/models/web_extract_response.rbs +31 -3
  77. data/sig/context_dev/models/web_extract_styleguide_response.rbs +28 -0
  78. data/sig/context_dev/models/web_screenshot_response.rbs +28 -0
  79. data/sig/context_dev/models/web_search_response.rbs +31 -3
  80. data/sig/context_dev/models/web_web_crawl_md_response.rbs +31 -3
  81. data/sig/context_dev/models/web_web_scrape_html_response.rbs +31 -3
  82. data/sig/context_dev/models/web_web_scrape_images_response.rbs +31 -3
  83. data/sig/context_dev/models/web_web_scrape_md_response.rbs +31 -3
  84. data/sig/context_dev/models/web_web_scrape_sitemap_response.rbs +31 -3
  85. data/sig/context_dev/resources/web.rbs +2 -0
  86. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 113f1babdb07592f8be5f9e71e90c91dbb71e247c23d4c8607ab3e41454d0134
4
- data.tar.gz: 3d360daae866082593f3bd1c96aca5e8344a47ea8ba6b1d0d3a25f5caa8ce65c
3
+ metadata.gz: 84c6c1d646faa0e2b50484631fd24d94e14a3922f768cf5fbe22bdd829d9e0cf
4
+ data.tar.gz: 8ea87eb1159e215732cc1c8b6344be0ed139712e2cff821dcca00406ce35d5b0
5
5
  SHA512:
6
- metadata.gz: 5482ddcb84ae21fa52f1b15af283d0a9106674c9a59403183d6496d3c1d125fb070e926246ee9348b1848eff0c9859f8e26496e61e24c9198a0e0afcc6f0f204
7
- data.tar.gz: 047b20f851d1d4af45eb23986823e664a2bdcf08bffd470f519367806328ecb8a27635d3fd1e9a5a724129b05bad8242b9d6f51d0ee80391fc5adea0ff567b1e
6
+ metadata.gz: ecf08bc1935ccfa130092a303ef4f25ed6c1a776703fcb85b9fbb411897cefe18aeaca4c44bae016f264f4f69e2a08a00c1b8bdf3bb4b14c388cc80c289d36c2
7
+ data.tar.gz: ae6c0aeff49f2c3c4419e22949fe02ecc6861102221acd2dddcf88bd49daef2ae0f33af30b871430ba141bac75a7b1b727deba7def727f0d92a49b7e771918c9
data/CHANGELOG.md CHANGED
@@ -1,5 +1,14 @@
1
1
  # Changelog
2
2
 
3
+ ## 1.32.0 (2026-06-11)
4
+
5
+ Full Changelog: [v1.31.0...v1.32.0](https://github.com/context-dot-dev/context-ruby-sdk/compare/v1.31.0...v1.32.0)
6
+
7
+ ### Features
8
+
9
+ * **api:** api update ([67ddd60](https://github.com/context-dot-dev/context-ruby-sdk/commit/67ddd60fffad48a4cc6697fb940f6510bc04d0cb))
10
+ * **api:** api update ([e987167](https://github.com/context-dot-dev/context-ruby-sdk/commit/e9871675c89fd313209d95cd54071fe986dd772a))
11
+
3
12
  ## 1.31.0 (2026-06-08)
4
13
 
5
14
  Full Changelog: [v1.30.0...v1.31.0](https://github.com/context-dot-dev/context-ruby-sdk/compare/v1.30.0...v1.31.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", "~> 1.31.0"
29
+ gem "context.dev", "~> 1.32.0"
30
30
  ```
31
31
 
32
32
  <!-- x-release-please-end -->
@@ -17,6 +17,13 @@ module ContextDev
17
17
  # @return [String, nil]
18
18
  optional :domain, String
19
19
 
20
+ # @!attribute key_metadata
21
+ # Metadata about the API key used for the request. Included in every response
22
+ # whenever a valid API key is provided, even when the response status is not 200.
23
+ #
24
+ # @return [ContextDev::Models::AIAIQueryResponse::KeyMetadata, nil]
25
+ optional :key_metadata, -> { ContextDev::Models::AIAIQueryResponse::KeyMetadata }
26
+
20
27
  # @!attribute status
21
28
  # Status of the response, e.g., 'ok'
22
29
  #
@@ -29,11 +36,16 @@ module ContextDev
29
36
  # @return [Array<String>, nil]
30
37
  optional :urls_analyzed, ContextDev::Internal::Type::ArrayOf[String]
31
38
 
32
- # @!method initialize(data_extracted: nil, domain: nil, status: nil, urls_analyzed: nil)
39
+ # @!method initialize(data_extracted: nil, domain: nil, key_metadata: nil, status: nil, urls_analyzed: nil)
40
+ # Some parameter documentations has been truncated, see
41
+ # {ContextDev::Models::AIAIQueryResponse} for more details.
42
+ #
33
43
  # @param data_extracted [Array<ContextDev::Models::AIAIQueryResponse::DataExtracted>] Array of extracted data points
34
44
  #
35
45
  # @param domain [String] The domain that was analyzed
36
46
  #
47
+ # @param key_metadata [ContextDev::Models::AIAIQueryResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
48
+ #
37
49
  # @param status [String] Status of the response, e.g., 'ok'
38
50
  #
39
51
  # @param urls_analyzed [Array<String>] List of URLs that were analyzed
@@ -93,6 +105,29 @@ module ContextDev
93
105
  UnionMember5Array = ContextDev::Internal::Type::ArrayOf[ContextDev::Internal::Type::Unknown]
94
106
  end
95
107
  end
108
+
109
+ # @see ContextDev::Models::AIAIQueryResponse#key_metadata
110
+ class KeyMetadata < ContextDev::Internal::Type::BaseModel
111
+ # @!attribute credits_consumed
112
+ # The number of credits consumed by this request.
113
+ #
114
+ # @return [Integer]
115
+ required :credits_consumed, Integer
116
+
117
+ # @!attribute credits_remaining
118
+ # The number of credits remaining for your organization after this request.
119
+ #
120
+ # @return [Integer]
121
+ required :credits_remaining, Integer
122
+
123
+ # @!method initialize(credits_consumed:, credits_remaining:)
124
+ # Metadata about the API key used for the request. Included in every response
125
+ # whenever a valid API key is provided, even when the response status is not 200.
126
+ #
127
+ # @param credits_consumed [Integer] The number of credits consumed by this request.
128
+ #
129
+ # @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
130
+ end
96
131
  end
97
132
  end
98
133
  end
@@ -10,6 +10,13 @@ module ContextDev
10
10
  # @return [Boolean, nil]
11
11
  optional :is_product_page, ContextDev::Internal::Type::Boolean
12
12
 
13
+ # @!attribute key_metadata
14
+ # Metadata about the API key used for the request. Included in every response
15
+ # whenever a valid API key is provided, even when the response status is not 200.
16
+ #
17
+ # @return [ContextDev::Models::AIExtractProductResponse::KeyMetadata, nil]
18
+ optional :key_metadata, -> { ContextDev::Models::AIExtractProductResponse::KeyMetadata }
19
+
13
20
  # @!attribute platform
14
21
  # The detected ecommerce platform, or null if not a product page
15
22
  #
@@ -22,13 +29,41 @@ module ContextDev
22
29
  # @return [ContextDev::Models::AIExtractProductResponse::Product, nil]
23
30
  optional :product, -> { ContextDev::Models::AIExtractProductResponse::Product }, nil?: true
24
31
 
25
- # @!method initialize(is_product_page: nil, platform: nil, product: nil)
32
+ # @!method initialize(is_product_page: nil, key_metadata: nil, platform: nil, product: nil)
33
+ # Some parameter documentations has been truncated, see
34
+ # {ContextDev::Models::AIExtractProductResponse} for more details.
35
+ #
26
36
  # @param is_product_page [Boolean] Whether the given URL is a product detail page
27
37
  #
38
+ # @param key_metadata [ContextDev::Models::AIExtractProductResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
39
+ #
28
40
  # @param platform [Symbol, ContextDev::Models::AIExtractProductResponse::Platform, nil] The detected ecommerce platform, or null if not a product page
29
41
  #
30
42
  # @param product [ContextDev::Models::AIExtractProductResponse::Product, nil] The extracted product data, or null if not a product page
31
43
 
44
+ # @see ContextDev::Models::AIExtractProductResponse#key_metadata
45
+ class KeyMetadata < ContextDev::Internal::Type::BaseModel
46
+ # @!attribute credits_consumed
47
+ # The number of credits consumed by this request.
48
+ #
49
+ # @return [Integer]
50
+ required :credits_consumed, Integer
51
+
52
+ # @!attribute credits_remaining
53
+ # The number of credits remaining for your organization after this request.
54
+ #
55
+ # @return [Integer]
56
+ required :credits_remaining, Integer
57
+
58
+ # @!method initialize(credits_consumed:, credits_remaining:)
59
+ # Metadata about the API key used for the request. Included in every response
60
+ # whenever a valid API key is provided, even when the response status is not 200.
61
+ #
62
+ # @param credits_consumed [Integer] The number of credits consumed by this request.
63
+ #
64
+ # @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
65
+ end
66
+
32
67
  # The detected ecommerce platform, or null if not a product page
33
68
  #
34
69
  # @see ContextDev::Models::AIExtractProductResponse#platform
@@ -4,6 +4,13 @@ module ContextDev
4
4
  module Models
5
5
  # @see ContextDev::Resources::AI#extract_products
6
6
  class AIExtractProductsResponse < ContextDev::Internal::Type::BaseModel
7
+ # @!attribute key_metadata
8
+ # Metadata about the API key used for the request. Included in every response
9
+ # whenever a valid API key is provided, even when the response status is not 200.
10
+ #
11
+ # @return [ContextDev::Models::AIExtractProductsResponse::KeyMetadata, nil]
12
+ optional :key_metadata, -> { ContextDev::Models::AIExtractProductsResponse::KeyMetadata }
13
+
7
14
  # @!attribute products
8
15
  # Array of products extracted from the website
9
16
  #
@@ -11,9 +18,37 @@ module ContextDev
11
18
  optional :products,
12
19
  -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::AIExtractProductsResponse::Product] }
13
20
 
14
- # @!method initialize(products: nil)
21
+ # @!method initialize(key_metadata: nil, products: nil)
22
+ # Some parameter documentations has been truncated, see
23
+ # {ContextDev::Models::AIExtractProductsResponse} for more details.
24
+ #
25
+ # @param key_metadata [ContextDev::Models::AIExtractProductsResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
26
+ #
15
27
  # @param products [Array<ContextDev::Models::AIExtractProductsResponse::Product>] Array of products extracted from the website
16
28
 
29
+ # @see ContextDev::Models::AIExtractProductsResponse#key_metadata
30
+ class KeyMetadata < ContextDev::Internal::Type::BaseModel
31
+ # @!attribute credits_consumed
32
+ # The number of credits consumed by this request.
33
+ #
34
+ # @return [Integer]
35
+ required :credits_consumed, Integer
36
+
37
+ # @!attribute credits_remaining
38
+ # The number of credits remaining for your organization after this request.
39
+ #
40
+ # @return [Integer]
41
+ required :credits_remaining, Integer
42
+
43
+ # @!method initialize(credits_consumed:, credits_remaining:)
44
+ # Metadata about the API key used for the request. Included in every response
45
+ # whenever a valid API key is provided, even when the response status is not 200.
46
+ #
47
+ # @param credits_consumed [Integer] The number of credits consumed by this request.
48
+ #
49
+ # @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
50
+ end
51
+
17
52
  class Product < ContextDev::Internal::Type::BaseModel
18
53
  # @!attribute description
19
54
  # Description of the product
@@ -16,17 +16,29 @@ module ContextDev
16
16
  # @return [Integer, nil]
17
17
  optional :code, Integer
18
18
 
19
+ # @!attribute key_metadata
20
+ # Metadata about the API key used for the request. Included in every response
21
+ # whenever a valid API key is provided, even when the response status is not 200.
22
+ #
23
+ # @return [ContextDev::Models::BrandIdentifyFromTransactionResponse::KeyMetadata, nil]
24
+ optional :key_metadata, -> { ContextDev::Models::BrandIdentifyFromTransactionResponse::KeyMetadata }
25
+
19
26
  # @!attribute status
20
27
  # Status of the response, e.g., 'ok'
21
28
  #
22
29
  # @return [String, nil]
23
30
  optional :status, String
24
31
 
25
- # @!method initialize(brand: nil, code: nil, status: nil)
32
+ # @!method initialize(brand: nil, code: nil, key_metadata: nil, status: nil)
33
+ # Some parameter documentations has been truncated, see
34
+ # {ContextDev::Models::BrandIdentifyFromTransactionResponse} for more details.
35
+ #
26
36
  # @param brand [ContextDev::Models::BrandIdentifyFromTransactionResponse::Brand] Detailed brand information
27
37
  #
28
38
  # @param code [Integer] HTTP status code
29
39
  #
40
+ # @param key_metadata [ContextDev::Models::BrandIdentifyFromTransactionResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
41
+ #
30
42
  # @param status [String] Status of the response, e.g., 'ok'
31
43
 
32
44
  # @see ContextDev::Models::BrandIdentifyFromTransactionResponse#brand
@@ -1034,6 +1046,29 @@ module ContextDev
1034
1046
  # @param ticker [String] Stock ticker symbol
1035
1047
  end
1036
1048
  end
1049
+
1050
+ # @see ContextDev::Models::BrandIdentifyFromTransactionResponse#key_metadata
1051
+ class KeyMetadata < ContextDev::Internal::Type::BaseModel
1052
+ # @!attribute credits_consumed
1053
+ # The number of credits consumed by this request.
1054
+ #
1055
+ # @return [Integer]
1056
+ required :credits_consumed, Integer
1057
+
1058
+ # @!attribute credits_remaining
1059
+ # The number of credits remaining for your organization after this request.
1060
+ #
1061
+ # @return [Integer]
1062
+ required :credits_remaining, Integer
1063
+
1064
+ # @!method initialize(credits_consumed:, credits_remaining:)
1065
+ # Metadata about the API key used for the request. Included in every response
1066
+ # whenever a valid API key is provided, even when the response status is not 200.
1067
+ #
1068
+ # @param credits_consumed [Integer] The number of credits consumed by this request.
1069
+ #
1070
+ # @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
1071
+ end
1037
1072
  end
1038
1073
  end
1039
1074
  end
@@ -16,17 +16,29 @@ module ContextDev
16
16
  # @return [Integer, nil]
17
17
  optional :code, Integer
18
18
 
19
+ # @!attribute key_metadata
20
+ # Metadata about the API key used for the request. Included in every response
21
+ # whenever a valid API key is provided, even when the response status is not 200.
22
+ #
23
+ # @return [ContextDev::Models::BrandRetrieveByEmailResponse::KeyMetadata, nil]
24
+ optional :key_metadata, -> { ContextDev::Models::BrandRetrieveByEmailResponse::KeyMetadata }
25
+
19
26
  # @!attribute status
20
27
  # Status of the response, e.g., 'ok'
21
28
  #
22
29
  # @return [String, nil]
23
30
  optional :status, String
24
31
 
25
- # @!method initialize(brand: nil, code: nil, status: nil)
32
+ # @!method initialize(brand: nil, code: nil, key_metadata: nil, status: nil)
33
+ # Some parameter documentations has been truncated, see
34
+ # {ContextDev::Models::BrandRetrieveByEmailResponse} for more details.
35
+ #
26
36
  # @param brand [ContextDev::Models::BrandRetrieveByEmailResponse::Brand] Detailed brand information
27
37
  #
28
38
  # @param code [Integer] HTTP status code
29
39
  #
40
+ # @param key_metadata [ContextDev::Models::BrandRetrieveByEmailResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
41
+ #
30
42
  # @param status [String] Status of the response, e.g., 'ok'
31
43
 
32
44
  # @see ContextDev::Models::BrandRetrieveByEmailResponse#brand
@@ -1031,6 +1043,29 @@ module ContextDev
1031
1043
  # @param ticker [String] Stock ticker symbol
1032
1044
  end
1033
1045
  end
1046
+
1047
+ # @see ContextDev::Models::BrandRetrieveByEmailResponse#key_metadata
1048
+ class KeyMetadata < ContextDev::Internal::Type::BaseModel
1049
+ # @!attribute credits_consumed
1050
+ # The number of credits consumed by this request.
1051
+ #
1052
+ # @return [Integer]
1053
+ required :credits_consumed, Integer
1054
+
1055
+ # @!attribute credits_remaining
1056
+ # The number of credits remaining for your organization after this request.
1057
+ #
1058
+ # @return [Integer]
1059
+ required :credits_remaining, Integer
1060
+
1061
+ # @!method initialize(credits_consumed:, credits_remaining:)
1062
+ # Metadata about the API key used for the request. Included in every response
1063
+ # whenever a valid API key is provided, even when the response status is not 200.
1064
+ #
1065
+ # @param credits_consumed [Integer] The number of credits consumed by this request.
1066
+ #
1067
+ # @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
1068
+ end
1034
1069
  end
1035
1070
  end
1036
1071
  end
@@ -16,17 +16,29 @@ module ContextDev
16
16
  # @return [Integer, nil]
17
17
  optional :code, Integer
18
18
 
19
+ # @!attribute key_metadata
20
+ # Metadata about the API key used for the request. Included in every response
21
+ # whenever a valid API key is provided, even when the response status is not 200.
22
+ #
23
+ # @return [ContextDev::Models::BrandRetrieveByIsinResponse::KeyMetadata, nil]
24
+ optional :key_metadata, -> { ContextDev::Models::BrandRetrieveByIsinResponse::KeyMetadata }
25
+
19
26
  # @!attribute status
20
27
  # Status of the response, e.g., 'ok'
21
28
  #
22
29
  # @return [String, nil]
23
30
  optional :status, String
24
31
 
25
- # @!method initialize(brand: nil, code: nil, status: nil)
32
+ # @!method initialize(brand: nil, code: nil, key_metadata: nil, status: nil)
33
+ # Some parameter documentations has been truncated, see
34
+ # {ContextDev::Models::BrandRetrieveByIsinResponse} for more details.
35
+ #
26
36
  # @param brand [ContextDev::Models::BrandRetrieveByIsinResponse::Brand] Detailed brand information
27
37
  #
28
38
  # @param code [Integer] HTTP status code
29
39
  #
40
+ # @param key_metadata [ContextDev::Models::BrandRetrieveByIsinResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
41
+ #
30
42
  # @param status [String] Status of the response, e.g., 'ok'
31
43
 
32
44
  # @see ContextDev::Models::BrandRetrieveByIsinResponse#brand
@@ -1030,6 +1042,29 @@ module ContextDev
1030
1042
  # @param ticker [String] Stock ticker symbol
1031
1043
  end
1032
1044
  end
1045
+
1046
+ # @see ContextDev::Models::BrandRetrieveByIsinResponse#key_metadata
1047
+ class KeyMetadata < ContextDev::Internal::Type::BaseModel
1048
+ # @!attribute credits_consumed
1049
+ # The number of credits consumed by this request.
1050
+ #
1051
+ # @return [Integer]
1052
+ required :credits_consumed, Integer
1053
+
1054
+ # @!attribute credits_remaining
1055
+ # The number of credits remaining for your organization after this request.
1056
+ #
1057
+ # @return [Integer]
1058
+ required :credits_remaining, Integer
1059
+
1060
+ # @!method initialize(credits_consumed:, credits_remaining:)
1061
+ # Metadata about the API key used for the request. Included in every response
1062
+ # whenever a valid API key is provided, even when the response status is not 200.
1063
+ #
1064
+ # @param credits_consumed [Integer] The number of credits consumed by this request.
1065
+ #
1066
+ # @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
1067
+ end
1033
1068
  end
1034
1069
  end
1035
1070
  end
@@ -16,17 +16,29 @@ module ContextDev
16
16
  # @return [Integer, nil]
17
17
  optional :code, Integer
18
18
 
19
+ # @!attribute key_metadata
20
+ # Metadata about the API key used for the request. Included in every response
21
+ # whenever a valid API key is provided, even when the response status is not 200.
22
+ #
23
+ # @return [ContextDev::Models::BrandRetrieveByNameResponse::KeyMetadata, nil]
24
+ optional :key_metadata, -> { ContextDev::Models::BrandRetrieveByNameResponse::KeyMetadata }
25
+
19
26
  # @!attribute status
20
27
  # Status of the response, e.g., 'ok'
21
28
  #
22
29
  # @return [String, nil]
23
30
  optional :status, String
24
31
 
25
- # @!method initialize(brand: nil, code: nil, status: nil)
32
+ # @!method initialize(brand: nil, code: nil, key_metadata: nil, status: nil)
33
+ # Some parameter documentations has been truncated, see
34
+ # {ContextDev::Models::BrandRetrieveByNameResponse} for more details.
35
+ #
26
36
  # @param brand [ContextDev::Models::BrandRetrieveByNameResponse::Brand] Detailed brand information
27
37
  #
28
38
  # @param code [Integer] HTTP status code
29
39
  #
40
+ # @param key_metadata [ContextDev::Models::BrandRetrieveByNameResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
41
+ #
30
42
  # @param status [String] Status of the response, e.g., 'ok'
31
43
 
32
44
  # @see ContextDev::Models::BrandRetrieveByNameResponse#brand
@@ -1030,6 +1042,29 @@ module ContextDev
1030
1042
  # @param ticker [String] Stock ticker symbol
1031
1043
  end
1032
1044
  end
1045
+
1046
+ # @see ContextDev::Models::BrandRetrieveByNameResponse#key_metadata
1047
+ class KeyMetadata < ContextDev::Internal::Type::BaseModel
1048
+ # @!attribute credits_consumed
1049
+ # The number of credits consumed by this request.
1050
+ #
1051
+ # @return [Integer]
1052
+ required :credits_consumed, Integer
1053
+
1054
+ # @!attribute credits_remaining
1055
+ # The number of credits remaining for your organization after this request.
1056
+ #
1057
+ # @return [Integer]
1058
+ required :credits_remaining, Integer
1059
+
1060
+ # @!method initialize(credits_consumed:, credits_remaining:)
1061
+ # Metadata about the API key used for the request. Included in every response
1062
+ # whenever a valid API key is provided, even when the response status is not 200.
1063
+ #
1064
+ # @param credits_consumed [Integer] The number of credits consumed by this request.
1065
+ #
1066
+ # @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
1067
+ end
1033
1068
  end
1034
1069
  end
1035
1070
  end
@@ -16,17 +16,29 @@ module ContextDev
16
16
  # @return [Integer, nil]
17
17
  optional :code, Integer
18
18
 
19
+ # @!attribute key_metadata
20
+ # Metadata about the API key used for the request. Included in every response
21
+ # whenever a valid API key is provided, even when the response status is not 200.
22
+ #
23
+ # @return [ContextDev::Models::BrandRetrieveByTickerResponse::KeyMetadata, nil]
24
+ optional :key_metadata, -> { ContextDev::Models::BrandRetrieveByTickerResponse::KeyMetadata }
25
+
19
26
  # @!attribute status
20
27
  # Status of the response, e.g., 'ok'
21
28
  #
22
29
  # @return [String, nil]
23
30
  optional :status, String
24
31
 
25
- # @!method initialize(brand: nil, code: nil, status: nil)
32
+ # @!method initialize(brand: nil, code: nil, key_metadata: nil, status: nil)
33
+ # Some parameter documentations has been truncated, see
34
+ # {ContextDev::Models::BrandRetrieveByTickerResponse} for more details.
35
+ #
26
36
  # @param brand [ContextDev::Models::BrandRetrieveByTickerResponse::Brand] Detailed brand information
27
37
  #
28
38
  # @param code [Integer] HTTP status code
29
39
  #
40
+ # @param key_metadata [ContextDev::Models::BrandRetrieveByTickerResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
41
+ #
30
42
  # @param status [String] Status of the response, e.g., 'ok'
31
43
 
32
44
  # @see ContextDev::Models::BrandRetrieveByTickerResponse#brand
@@ -1032,6 +1044,29 @@ module ContextDev
1032
1044
  # @param ticker [String] Stock ticker symbol
1033
1045
  end
1034
1046
  end
1047
+
1048
+ # @see ContextDev::Models::BrandRetrieveByTickerResponse#key_metadata
1049
+ class KeyMetadata < ContextDev::Internal::Type::BaseModel
1050
+ # @!attribute credits_consumed
1051
+ # The number of credits consumed by this request.
1052
+ #
1053
+ # @return [Integer]
1054
+ required :credits_consumed, Integer
1055
+
1056
+ # @!attribute credits_remaining
1057
+ # The number of credits remaining for your organization after this request.
1058
+ #
1059
+ # @return [Integer]
1060
+ required :credits_remaining, Integer
1061
+
1062
+ # @!method initialize(credits_consumed:, credits_remaining:)
1063
+ # Metadata about the API key used for the request. Included in every response
1064
+ # whenever a valid API key is provided, even when the response status is not 200.
1065
+ #
1066
+ # @param credits_consumed [Integer] The number of credits consumed by this request.
1067
+ #
1068
+ # @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
1069
+ end
1035
1070
  end
1036
1071
  end
1037
1072
  end
@@ -16,17 +16,29 @@ module ContextDev
16
16
  # @return [Integer, nil]
17
17
  optional :code, Integer
18
18
 
19
+ # @!attribute key_metadata
20
+ # Metadata about the API key used for the request. Included in every response
21
+ # whenever a valid API key is provided, even when the response status is not 200.
22
+ #
23
+ # @return [ContextDev::Models::BrandRetrieveResponse::KeyMetadata, nil]
24
+ optional :key_metadata, -> { ContextDev::Models::BrandRetrieveResponse::KeyMetadata }
25
+
19
26
  # @!attribute status
20
27
  # Status of the response, e.g., 'ok'
21
28
  #
22
29
  # @return [String, nil]
23
30
  optional :status, String
24
31
 
25
- # @!method initialize(brand: nil, code: nil, status: nil)
32
+ # @!method initialize(brand: nil, code: nil, key_metadata: nil, status: nil)
33
+ # Some parameter documentations has been truncated, see
34
+ # {ContextDev::Models::BrandRetrieveResponse} for more details.
35
+ #
26
36
  # @param brand [ContextDev::Models::BrandRetrieveResponse::Brand] Detailed brand information
27
37
  #
28
38
  # @param code [Integer] HTTP status code
29
39
  #
40
+ # @param key_metadata [ContextDev::Models::BrandRetrieveResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
41
+ #
30
42
  # @param status [String] Status of the response, e.g., 'ok'
31
43
 
32
44
  # @see ContextDev::Models::BrandRetrieveResponse#brand
@@ -1030,6 +1042,29 @@ module ContextDev
1030
1042
  # @param ticker [String] Stock ticker symbol
1031
1043
  end
1032
1044
  end
1045
+
1046
+ # @see ContextDev::Models::BrandRetrieveResponse#key_metadata
1047
+ class KeyMetadata < ContextDev::Internal::Type::BaseModel
1048
+ # @!attribute credits_consumed
1049
+ # The number of credits consumed by this request.
1050
+ #
1051
+ # @return [Integer]
1052
+ required :credits_consumed, Integer
1053
+
1054
+ # @!attribute credits_remaining
1055
+ # The number of credits remaining for your organization after this request.
1056
+ #
1057
+ # @return [Integer]
1058
+ required :credits_remaining, Integer
1059
+
1060
+ # @!method initialize(credits_consumed:, credits_remaining:)
1061
+ # Metadata about the API key used for the request. Included in every response
1062
+ # whenever a valid API key is provided, even when the response status is not 200.
1063
+ #
1064
+ # @param credits_consumed [Integer] The number of credits consumed by this request.
1065
+ #
1066
+ # @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
1067
+ end
1033
1068
  end
1034
1069
  end
1035
1070
  end
@@ -16,17 +16,29 @@ module ContextDev
16
16
  # @return [Integer, nil]
17
17
  optional :code, Integer
18
18
 
19
+ # @!attribute key_metadata
20
+ # Metadata about the API key used for the request. Included in every response
21
+ # whenever a valid API key is provided, even when the response status is not 200.
22
+ #
23
+ # @return [ContextDev::Models::BrandRetrieveSimplifiedResponse::KeyMetadata, nil]
24
+ optional :key_metadata, -> { ContextDev::Models::BrandRetrieveSimplifiedResponse::KeyMetadata }
25
+
19
26
  # @!attribute status
20
27
  # Status of the response, e.g., 'ok'
21
28
  #
22
29
  # @return [String, nil]
23
30
  optional :status, String
24
31
 
25
- # @!method initialize(brand: nil, code: nil, status: nil)
32
+ # @!method initialize(brand: nil, code: nil, key_metadata: nil, status: nil)
33
+ # Some parameter documentations has been truncated, see
34
+ # {ContextDev::Models::BrandRetrieveSimplifiedResponse} for more details.
35
+ #
26
36
  # @param brand [ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand] Simplified brand information
27
37
  #
28
38
  # @param code [Integer] HTTP status code of the response
29
39
  #
40
+ # @param key_metadata [ContextDev::Models::BrandRetrieveSimplifiedResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
41
+ #
30
42
  # @param status [String] Status of the response, e.g., 'ok'
31
43
 
32
44
  # @see ContextDev::Models::BrandRetrieveSimplifiedResponse#brand
@@ -302,6 +314,29 @@ module ContextDev
302
314
  end
303
315
  end
304
316
  end
317
+
318
+ # @see ContextDev::Models::BrandRetrieveSimplifiedResponse#key_metadata
319
+ class KeyMetadata < ContextDev::Internal::Type::BaseModel
320
+ # @!attribute credits_consumed
321
+ # The number of credits consumed by this request.
322
+ #
323
+ # @return [Integer]
324
+ required :credits_consumed, Integer
325
+
326
+ # @!attribute credits_remaining
327
+ # The number of credits remaining for your organization after this request.
328
+ #
329
+ # @return [Integer]
330
+ required :credits_remaining, Integer
331
+
332
+ # @!method initialize(credits_consumed:, credits_remaining:)
333
+ # Metadata about the API key used for the request. Included in every response
334
+ # whenever a valid API key is provided, even when the response status is not 200.
335
+ #
336
+ # @param credits_consumed [Integer] The number of credits consumed by this request.
337
+ #
338
+ # @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
339
+ end
305
340
  end
306
341
  end
307
342
  end