context.dev 1.30.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 (91) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +18 -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 +21 -3
  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_params.rb +2 -2
  26. data/lib/context_dev/models/web_web_crawl_md_response.rb +37 -1
  27. data/lib/context_dev/models/web_web_scrape_html_params.rb +10 -1
  28. data/lib/context_dev/models/web_web_scrape_html_response.rb +33 -1
  29. data/lib/context_dev/models/web_web_scrape_images_response.rb +36 -1
  30. data/lib/context_dev/models/web_web_scrape_md_response.rb +36 -1
  31. data/lib/context_dev/models/web_web_scrape_sitemap_response.rb +36 -1
  32. data/lib/context_dev/resources/web.rb +10 -3
  33. data/lib/context_dev/version.rb +1 -1
  34. data/rbi/context_dev/models/ai_ai_query_response.rbi +62 -0
  35. data/rbi/context_dev/models/ai_extract_product_response.rbi +65 -0
  36. data/rbi/context_dev/models/ai_extract_products_response.rbi +65 -0
  37. data/rbi/context_dev/models/brand_identify_from_transaction_response.rbi +67 -0
  38. data/rbi/context_dev/models/brand_retrieve_by_email_response.rbi +67 -0
  39. data/rbi/context_dev/models/brand_retrieve_by_isin_response.rbi +67 -0
  40. data/rbi/context_dev/models/brand_retrieve_by_name_response.rbi +67 -0
  41. data/rbi/context_dev/models/brand_retrieve_by_ticker_response.rbi +67 -0
  42. data/rbi/context_dev/models/brand_retrieve_response.rbi +65 -0
  43. data/rbi/context_dev/models/brand_retrieve_simplified_response.rbi +67 -0
  44. data/rbi/context_dev/models/industry_retrieve_naics_response.rbi +67 -0
  45. data/rbi/context_dev/models/industry_retrieve_sic_response.rbi +67 -0
  46. data/rbi/context_dev/models/utility_prefetch_by_email_response.rbi +79 -4
  47. data/rbi/context_dev/models/utility_prefetch_response.rbi +77 -4
  48. data/rbi/context_dev/models/web_extract_competitors_response.rbi +70 -3
  49. data/rbi/context_dev/models/web_extract_fonts_response.rbi +68 -3
  50. data/rbi/context_dev/models/web_extract_params.rbi +28 -2
  51. data/rbi/context_dev/models/web_extract_response.rbi +65 -3
  52. data/rbi/context_dev/models/web_extract_styleguide_response.rbi +67 -0
  53. data/rbi/context_dev/models/web_screenshot_response.rbi +65 -0
  54. data/rbi/context_dev/models/web_search_response.rbi +65 -3
  55. data/rbi/context_dev/models/web_web_crawl_md_params.rbi +4 -4
  56. data/rbi/context_dev/models/web_web_crawl_md_response.rbi +71 -3
  57. data/rbi/context_dev/models/web_web_scrape_html_params.rbi +13 -0
  58. data/rbi/context_dev/models/web_web_scrape_html_response.rbi +68 -3
  59. data/rbi/context_dev/models/web_web_scrape_images_response.rbi +68 -3
  60. data/rbi/context_dev/models/web_web_scrape_md_response.rbi +68 -3
  61. data/rbi/context_dev/models/web_web_scrape_sitemap_response.rbi +70 -3
  62. data/rbi/context_dev/resources/web.rbi +15 -3
  63. data/sig/context_dev/models/ai_ai_query_response.rbs +28 -0
  64. data/sig/context_dev/models/ai_extract_product_response.rbs +28 -0
  65. data/sig/context_dev/models/ai_extract_products_response.rbs +28 -0
  66. data/sig/context_dev/models/brand_identify_from_transaction_response.rbs +28 -0
  67. data/sig/context_dev/models/brand_retrieve_by_email_response.rbs +28 -0
  68. data/sig/context_dev/models/brand_retrieve_by_isin_response.rbs +28 -0
  69. data/sig/context_dev/models/brand_retrieve_by_name_response.rbs +28 -0
  70. data/sig/context_dev/models/brand_retrieve_by_ticker_response.rbs +28 -0
  71. data/sig/context_dev/models/brand_retrieve_response.rbs +28 -0
  72. data/sig/context_dev/models/brand_retrieve_simplified_response.rbs +28 -0
  73. data/sig/context_dev/models/industry_retrieve_naics_response.rbs +28 -0
  74. data/sig/context_dev/models/industry_retrieve_sic_response.rbs +28 -0
  75. data/sig/context_dev/models/utility_prefetch_by_email_response.rbs +38 -2
  76. data/sig/context_dev/models/utility_prefetch_response.rbs +38 -2
  77. data/sig/context_dev/models/web_extract_competitors_response.rbs +31 -3
  78. data/sig/context_dev/models/web_extract_fonts_response.rbs +31 -3
  79. data/sig/context_dev/models/web_extract_params.rbs +14 -0
  80. data/sig/context_dev/models/web_extract_response.rbs +31 -3
  81. data/sig/context_dev/models/web_extract_styleguide_response.rbs +28 -0
  82. data/sig/context_dev/models/web_screenshot_response.rbs +28 -0
  83. data/sig/context_dev/models/web_search_response.rbs +31 -3
  84. data/sig/context_dev/models/web_web_crawl_md_response.rbs +31 -3
  85. data/sig/context_dev/models/web_web_scrape_html_params.rbs +7 -0
  86. data/sig/context_dev/models/web_web_scrape_html_response.rbs +31 -3
  87. data/sig/context_dev/models/web_web_scrape_images_response.rbs +31 -3
  88. data/sig/context_dev/models/web_web_scrape_md_response.rbs +31 -3
  89. data/sig/context_dev/models/web_web_scrape_sitemap_response.rbs +31 -3
  90. data/sig/context_dev/resources/web.rbs +3 -0
  91. metadata +2 -2
@@ -36,6 +36,25 @@ module ContextDev
36
36
  sig { params(code: Integer).void }
37
37
  attr_writer :code
38
38
 
39
+ # Metadata about the API key used for the request. Included in every response
40
+ # whenever a valid API key is provided, even when the response status is not 200.
41
+ sig do
42
+ returns(
43
+ T.nilable(
44
+ ContextDev::Models::BrandIdentifyFromTransactionResponse::KeyMetadata
45
+ )
46
+ )
47
+ end
48
+ attr_reader :key_metadata
49
+
50
+ sig do
51
+ params(
52
+ key_metadata:
53
+ ContextDev::Models::BrandIdentifyFromTransactionResponse::KeyMetadata::OrHash
54
+ ).void
55
+ end
56
+ attr_writer :key_metadata
57
+
39
58
  # Status of the response, e.g., 'ok'
40
59
  sig { returns(T.nilable(String)) }
41
60
  attr_reader :status
@@ -48,6 +67,8 @@ module ContextDev
48
67
  brand:
49
68
  ContextDev::Models::BrandIdentifyFromTransactionResponse::Brand::OrHash,
50
69
  code: Integer,
70
+ key_metadata:
71
+ ContextDev::Models::BrandIdentifyFromTransactionResponse::KeyMetadata::OrHash,
51
72
  status: String
52
73
  ).returns(T.attached_class)
53
74
  end
@@ -56,6 +77,9 @@ module ContextDev
56
77
  brand: nil,
57
78
  # HTTP status code
58
79
  code: nil,
80
+ # Metadata about the API key used for the request. Included in every response
81
+ # whenever a valid API key is provided, even when the response status is not 200.
82
+ key_metadata: nil,
59
83
  # Status of the response, e.g., 'ok'
60
84
  status: nil
61
85
  )
@@ -67,6 +91,8 @@ module ContextDev
67
91
  brand:
68
92
  ContextDev::Models::BrandIdentifyFromTransactionResponse::Brand,
69
93
  code: Integer,
94
+ key_metadata:
95
+ ContextDev::Models::BrandIdentifyFromTransactionResponse::KeyMetadata,
70
96
  status: String
71
97
  }
72
98
  )
@@ -3443,6 +3469,47 @@ module ContextDev
3443
3469
  end
3444
3470
  end
3445
3471
  end
3472
+
3473
+ class KeyMetadata < ContextDev::Internal::Type::BaseModel
3474
+ OrHash =
3475
+ T.type_alias do
3476
+ T.any(
3477
+ ContextDev::Models::BrandIdentifyFromTransactionResponse::KeyMetadata,
3478
+ ContextDev::Internal::AnyHash
3479
+ )
3480
+ end
3481
+
3482
+ # The number of credits consumed by this request.
3483
+ sig { returns(Integer) }
3484
+ attr_accessor :credits_consumed
3485
+
3486
+ # The number of credits remaining for your organization after this request.
3487
+ sig { returns(Integer) }
3488
+ attr_accessor :credits_remaining
3489
+
3490
+ # Metadata about the API key used for the request. Included in every response
3491
+ # whenever a valid API key is provided, even when the response status is not 200.
3492
+ sig do
3493
+ params(credits_consumed: Integer, credits_remaining: Integer).returns(
3494
+ T.attached_class
3495
+ )
3496
+ end
3497
+ def self.new(
3498
+ # The number of credits consumed by this request.
3499
+ credits_consumed:,
3500
+ # The number of credits remaining for your organization after this request.
3501
+ credits_remaining:
3502
+ )
3503
+ end
3504
+
3505
+ sig do
3506
+ override.returns(
3507
+ { credits_consumed: Integer, credits_remaining: Integer }
3508
+ )
3509
+ end
3510
+ def to_hash
3511
+ end
3512
+ end
3446
3513
  end
3447
3514
  end
3448
3515
  end
@@ -33,6 +33,25 @@ module ContextDev
33
33
  sig { params(code: Integer).void }
34
34
  attr_writer :code
35
35
 
36
+ # Metadata about the API key used for the request. Included in every response
37
+ # whenever a valid API key is provided, even when the response status is not 200.
38
+ sig do
39
+ returns(
40
+ T.nilable(
41
+ ContextDev::Models::BrandRetrieveByEmailResponse::KeyMetadata
42
+ )
43
+ )
44
+ end
45
+ attr_reader :key_metadata
46
+
47
+ sig do
48
+ params(
49
+ key_metadata:
50
+ ContextDev::Models::BrandRetrieveByEmailResponse::KeyMetadata::OrHash
51
+ ).void
52
+ end
53
+ attr_writer :key_metadata
54
+
36
55
  # Status of the response, e.g., 'ok'
37
56
  sig { returns(T.nilable(String)) }
38
57
  attr_reader :status
@@ -45,6 +64,8 @@ module ContextDev
45
64
  brand:
46
65
  ContextDev::Models::BrandRetrieveByEmailResponse::Brand::OrHash,
47
66
  code: Integer,
67
+ key_metadata:
68
+ ContextDev::Models::BrandRetrieveByEmailResponse::KeyMetadata::OrHash,
48
69
  status: String
49
70
  ).returns(T.attached_class)
50
71
  end
@@ -53,6 +74,9 @@ module ContextDev
53
74
  brand: nil,
54
75
  # HTTP status code
55
76
  code: nil,
77
+ # Metadata about the API key used for the request. Included in every response
78
+ # whenever a valid API key is provided, even when the response status is not 200.
79
+ key_metadata: nil,
56
80
  # Status of the response, e.g., 'ok'
57
81
  status: nil
58
82
  )
@@ -63,6 +87,8 @@ module ContextDev
63
87
  {
64
88
  brand: ContextDev::Models::BrandRetrieveByEmailResponse::Brand,
65
89
  code: Integer,
90
+ key_metadata:
91
+ ContextDev::Models::BrandRetrieveByEmailResponse::KeyMetadata,
66
92
  status: String
67
93
  }
68
94
  )
@@ -3439,6 +3465,47 @@ module ContextDev
3439
3465
  end
3440
3466
  end
3441
3467
  end
3468
+
3469
+ class KeyMetadata < ContextDev::Internal::Type::BaseModel
3470
+ OrHash =
3471
+ T.type_alias do
3472
+ T.any(
3473
+ ContextDev::Models::BrandRetrieveByEmailResponse::KeyMetadata,
3474
+ ContextDev::Internal::AnyHash
3475
+ )
3476
+ end
3477
+
3478
+ # The number of credits consumed by this request.
3479
+ sig { returns(Integer) }
3480
+ attr_accessor :credits_consumed
3481
+
3482
+ # The number of credits remaining for your organization after this request.
3483
+ sig { returns(Integer) }
3484
+ attr_accessor :credits_remaining
3485
+
3486
+ # Metadata about the API key used for the request. Included in every response
3487
+ # whenever a valid API key is provided, even when the response status is not 200.
3488
+ sig do
3489
+ params(credits_consumed: Integer, credits_remaining: Integer).returns(
3490
+ T.attached_class
3491
+ )
3492
+ end
3493
+ def self.new(
3494
+ # The number of credits consumed by this request.
3495
+ credits_consumed:,
3496
+ # The number of credits remaining for your organization after this request.
3497
+ credits_remaining:
3498
+ )
3499
+ end
3500
+
3501
+ sig do
3502
+ override.returns(
3503
+ { credits_consumed: Integer, credits_remaining: Integer }
3504
+ )
3505
+ end
3506
+ def to_hash
3507
+ end
3508
+ end
3442
3509
  end
3443
3510
  end
3444
3511
  end
@@ -33,6 +33,25 @@ module ContextDev
33
33
  sig { params(code: Integer).void }
34
34
  attr_writer :code
35
35
 
36
+ # Metadata about the API key used for the request. Included in every response
37
+ # whenever a valid API key is provided, even when the response status is not 200.
38
+ sig do
39
+ returns(
40
+ T.nilable(
41
+ ContextDev::Models::BrandRetrieveByIsinResponse::KeyMetadata
42
+ )
43
+ )
44
+ end
45
+ attr_reader :key_metadata
46
+
47
+ sig do
48
+ params(
49
+ key_metadata:
50
+ ContextDev::Models::BrandRetrieveByIsinResponse::KeyMetadata::OrHash
51
+ ).void
52
+ end
53
+ attr_writer :key_metadata
54
+
36
55
  # Status of the response, e.g., 'ok'
37
56
  sig { returns(T.nilable(String)) }
38
57
  attr_reader :status
@@ -44,6 +63,8 @@ module ContextDev
44
63
  params(
45
64
  brand: ContextDev::Models::BrandRetrieveByIsinResponse::Brand::OrHash,
46
65
  code: Integer,
66
+ key_metadata:
67
+ ContextDev::Models::BrandRetrieveByIsinResponse::KeyMetadata::OrHash,
47
68
  status: String
48
69
  ).returns(T.attached_class)
49
70
  end
@@ -52,6 +73,9 @@ module ContextDev
52
73
  brand: nil,
53
74
  # HTTP status code
54
75
  code: nil,
76
+ # Metadata about the API key used for the request. Included in every response
77
+ # whenever a valid API key is provided, even when the response status is not 200.
78
+ key_metadata: nil,
55
79
  # Status of the response, e.g., 'ok'
56
80
  status: nil
57
81
  )
@@ -62,6 +86,8 @@ module ContextDev
62
86
  {
63
87
  brand: ContextDev::Models::BrandRetrieveByIsinResponse::Brand,
64
88
  code: Integer,
89
+ key_metadata:
90
+ ContextDev::Models::BrandRetrieveByIsinResponse::KeyMetadata,
65
91
  status: String
66
92
  }
67
93
  )
@@ -3438,6 +3464,47 @@ module ContextDev
3438
3464
  end
3439
3465
  end
3440
3466
  end
3467
+
3468
+ class KeyMetadata < ContextDev::Internal::Type::BaseModel
3469
+ OrHash =
3470
+ T.type_alias do
3471
+ T.any(
3472
+ ContextDev::Models::BrandRetrieveByIsinResponse::KeyMetadata,
3473
+ ContextDev::Internal::AnyHash
3474
+ )
3475
+ end
3476
+
3477
+ # The number of credits consumed by this request.
3478
+ sig { returns(Integer) }
3479
+ attr_accessor :credits_consumed
3480
+
3481
+ # The number of credits remaining for your organization after this request.
3482
+ sig { returns(Integer) }
3483
+ attr_accessor :credits_remaining
3484
+
3485
+ # Metadata about the API key used for the request. Included in every response
3486
+ # whenever a valid API key is provided, even when the response status is not 200.
3487
+ sig do
3488
+ params(credits_consumed: Integer, credits_remaining: Integer).returns(
3489
+ T.attached_class
3490
+ )
3491
+ end
3492
+ def self.new(
3493
+ # The number of credits consumed by this request.
3494
+ credits_consumed:,
3495
+ # The number of credits remaining for your organization after this request.
3496
+ credits_remaining:
3497
+ )
3498
+ end
3499
+
3500
+ sig do
3501
+ override.returns(
3502
+ { credits_consumed: Integer, credits_remaining: Integer }
3503
+ )
3504
+ end
3505
+ def to_hash
3506
+ end
3507
+ end
3441
3508
  end
3442
3509
  end
3443
3510
  end
@@ -33,6 +33,25 @@ module ContextDev
33
33
  sig { params(code: Integer).void }
34
34
  attr_writer :code
35
35
 
36
+ # Metadata about the API key used for the request. Included in every response
37
+ # whenever a valid API key is provided, even when the response status is not 200.
38
+ sig do
39
+ returns(
40
+ T.nilable(
41
+ ContextDev::Models::BrandRetrieveByNameResponse::KeyMetadata
42
+ )
43
+ )
44
+ end
45
+ attr_reader :key_metadata
46
+
47
+ sig do
48
+ params(
49
+ key_metadata:
50
+ ContextDev::Models::BrandRetrieveByNameResponse::KeyMetadata::OrHash
51
+ ).void
52
+ end
53
+ attr_writer :key_metadata
54
+
36
55
  # Status of the response, e.g., 'ok'
37
56
  sig { returns(T.nilable(String)) }
38
57
  attr_reader :status
@@ -44,6 +63,8 @@ module ContextDev
44
63
  params(
45
64
  brand: ContextDev::Models::BrandRetrieveByNameResponse::Brand::OrHash,
46
65
  code: Integer,
66
+ key_metadata:
67
+ ContextDev::Models::BrandRetrieveByNameResponse::KeyMetadata::OrHash,
47
68
  status: String
48
69
  ).returns(T.attached_class)
49
70
  end
@@ -52,6 +73,9 @@ module ContextDev
52
73
  brand: nil,
53
74
  # HTTP status code
54
75
  code: nil,
76
+ # Metadata about the API key used for the request. Included in every response
77
+ # whenever a valid API key is provided, even when the response status is not 200.
78
+ key_metadata: nil,
55
79
  # Status of the response, e.g., 'ok'
56
80
  status: nil
57
81
  )
@@ -62,6 +86,8 @@ module ContextDev
62
86
  {
63
87
  brand: ContextDev::Models::BrandRetrieveByNameResponse::Brand,
64
88
  code: Integer,
89
+ key_metadata:
90
+ ContextDev::Models::BrandRetrieveByNameResponse::KeyMetadata,
65
91
  status: String
66
92
  }
67
93
  )
@@ -3438,6 +3464,47 @@ module ContextDev
3438
3464
  end
3439
3465
  end
3440
3466
  end
3467
+
3468
+ class KeyMetadata < ContextDev::Internal::Type::BaseModel
3469
+ OrHash =
3470
+ T.type_alias do
3471
+ T.any(
3472
+ ContextDev::Models::BrandRetrieveByNameResponse::KeyMetadata,
3473
+ ContextDev::Internal::AnyHash
3474
+ )
3475
+ end
3476
+
3477
+ # The number of credits consumed by this request.
3478
+ sig { returns(Integer) }
3479
+ attr_accessor :credits_consumed
3480
+
3481
+ # The number of credits remaining for your organization after this request.
3482
+ sig { returns(Integer) }
3483
+ attr_accessor :credits_remaining
3484
+
3485
+ # Metadata about the API key used for the request. Included in every response
3486
+ # whenever a valid API key is provided, even when the response status is not 200.
3487
+ sig do
3488
+ params(credits_consumed: Integer, credits_remaining: Integer).returns(
3489
+ T.attached_class
3490
+ )
3491
+ end
3492
+ def self.new(
3493
+ # The number of credits consumed by this request.
3494
+ credits_consumed:,
3495
+ # The number of credits remaining for your organization after this request.
3496
+ credits_remaining:
3497
+ )
3498
+ end
3499
+
3500
+ sig do
3501
+ override.returns(
3502
+ { credits_consumed: Integer, credits_remaining: Integer }
3503
+ )
3504
+ end
3505
+ def to_hash
3506
+ end
3507
+ end
3441
3508
  end
3442
3509
  end
3443
3510
  end
@@ -34,6 +34,25 @@ module ContextDev
34
34
  sig { params(code: Integer).void }
35
35
  attr_writer :code
36
36
 
37
+ # Metadata about the API key used for the request. Included in every response
38
+ # whenever a valid API key is provided, even when the response status is not 200.
39
+ sig do
40
+ returns(
41
+ T.nilable(
42
+ ContextDev::Models::BrandRetrieveByTickerResponse::KeyMetadata
43
+ )
44
+ )
45
+ end
46
+ attr_reader :key_metadata
47
+
48
+ sig do
49
+ params(
50
+ key_metadata:
51
+ ContextDev::Models::BrandRetrieveByTickerResponse::KeyMetadata::OrHash
52
+ ).void
53
+ end
54
+ attr_writer :key_metadata
55
+
37
56
  # Status of the response, e.g., 'ok'
38
57
  sig { returns(T.nilable(String)) }
39
58
  attr_reader :status
@@ -46,6 +65,8 @@ module ContextDev
46
65
  brand:
47
66
  ContextDev::Models::BrandRetrieveByTickerResponse::Brand::OrHash,
48
67
  code: Integer,
68
+ key_metadata:
69
+ ContextDev::Models::BrandRetrieveByTickerResponse::KeyMetadata::OrHash,
49
70
  status: String
50
71
  ).returns(T.attached_class)
51
72
  end
@@ -54,6 +75,9 @@ module ContextDev
54
75
  brand: nil,
55
76
  # HTTP status code
56
77
  code: nil,
78
+ # Metadata about the API key used for the request. Included in every response
79
+ # whenever a valid API key is provided, even when the response status is not 200.
80
+ key_metadata: nil,
57
81
  # Status of the response, e.g., 'ok'
58
82
  status: nil
59
83
  )
@@ -64,6 +88,8 @@ module ContextDev
64
88
  {
65
89
  brand: ContextDev::Models::BrandRetrieveByTickerResponse::Brand,
66
90
  code: Integer,
91
+ key_metadata:
92
+ ContextDev::Models::BrandRetrieveByTickerResponse::KeyMetadata,
67
93
  status: String
68
94
  }
69
95
  )
@@ -3440,6 +3466,47 @@ module ContextDev
3440
3466
  end
3441
3467
  end
3442
3468
  end
3469
+
3470
+ class KeyMetadata < ContextDev::Internal::Type::BaseModel
3471
+ OrHash =
3472
+ T.type_alias do
3473
+ T.any(
3474
+ ContextDev::Models::BrandRetrieveByTickerResponse::KeyMetadata,
3475
+ ContextDev::Internal::AnyHash
3476
+ )
3477
+ end
3478
+
3479
+ # The number of credits consumed by this request.
3480
+ sig { returns(Integer) }
3481
+ attr_accessor :credits_consumed
3482
+
3483
+ # The number of credits remaining for your organization after this request.
3484
+ sig { returns(Integer) }
3485
+ attr_accessor :credits_remaining
3486
+
3487
+ # Metadata about the API key used for the request. Included in every response
3488
+ # whenever a valid API key is provided, even when the response status is not 200.
3489
+ sig do
3490
+ params(credits_consumed: Integer, credits_remaining: Integer).returns(
3491
+ T.attached_class
3492
+ )
3493
+ end
3494
+ def self.new(
3495
+ # The number of credits consumed by this request.
3496
+ credits_consumed:,
3497
+ # The number of credits remaining for your organization after this request.
3498
+ credits_remaining:
3499
+ )
3500
+ end
3501
+
3502
+ sig do
3503
+ override.returns(
3504
+ { credits_consumed: Integer, credits_remaining: Integer }
3505
+ )
3506
+ end
3507
+ def to_hash
3508
+ end
3509
+ end
3443
3510
  end
3444
3511
  end
3445
3512
  end
@@ -31,6 +31,23 @@ module ContextDev
31
31
  sig { params(code: Integer).void }
32
32
  attr_writer :code
33
33
 
34
+ # Metadata about the API key used for the request. Included in every response
35
+ # whenever a valid API key is provided, even when the response status is not 200.
36
+ sig do
37
+ returns(
38
+ T.nilable(ContextDev::Models::BrandRetrieveResponse::KeyMetadata)
39
+ )
40
+ end
41
+ attr_reader :key_metadata
42
+
43
+ sig do
44
+ params(
45
+ key_metadata:
46
+ ContextDev::Models::BrandRetrieveResponse::KeyMetadata::OrHash
47
+ ).void
48
+ end
49
+ attr_writer :key_metadata
50
+
34
51
  # Status of the response, e.g., 'ok'
35
52
  sig { returns(T.nilable(String)) }
36
53
  attr_reader :status
@@ -42,6 +59,8 @@ module ContextDev
42
59
  params(
43
60
  brand: ContextDev::Models::BrandRetrieveResponse::Brand::OrHash,
44
61
  code: Integer,
62
+ key_metadata:
63
+ ContextDev::Models::BrandRetrieveResponse::KeyMetadata::OrHash,
45
64
  status: String
46
65
  ).returns(T.attached_class)
47
66
  end
@@ -50,6 +69,9 @@ module ContextDev
50
69
  brand: nil,
51
70
  # HTTP status code
52
71
  code: nil,
72
+ # Metadata about the API key used for the request. Included in every response
73
+ # whenever a valid API key is provided, even when the response status is not 200.
74
+ key_metadata: nil,
53
75
  # Status of the response, e.g., 'ok'
54
76
  status: nil
55
77
  )
@@ -60,6 +82,8 @@ module ContextDev
60
82
  {
61
83
  brand: ContextDev::Models::BrandRetrieveResponse::Brand,
62
84
  code: Integer,
85
+ key_metadata:
86
+ ContextDev::Models::BrandRetrieveResponse::KeyMetadata,
63
87
  status: String
64
88
  }
65
89
  )
@@ -3422,6 +3446,47 @@ module ContextDev
3422
3446
  end
3423
3447
  end
3424
3448
  end
3449
+
3450
+ class KeyMetadata < ContextDev::Internal::Type::BaseModel
3451
+ OrHash =
3452
+ T.type_alias do
3453
+ T.any(
3454
+ ContextDev::Models::BrandRetrieveResponse::KeyMetadata,
3455
+ ContextDev::Internal::AnyHash
3456
+ )
3457
+ end
3458
+
3459
+ # The number of credits consumed by this request.
3460
+ sig { returns(Integer) }
3461
+ attr_accessor :credits_consumed
3462
+
3463
+ # The number of credits remaining for your organization after this request.
3464
+ sig { returns(Integer) }
3465
+ attr_accessor :credits_remaining
3466
+
3467
+ # Metadata about the API key used for the request. Included in every response
3468
+ # whenever a valid API key is provided, even when the response status is not 200.
3469
+ sig do
3470
+ params(credits_consumed: Integer, credits_remaining: Integer).returns(
3471
+ T.attached_class
3472
+ )
3473
+ end
3474
+ def self.new(
3475
+ # The number of credits consumed by this request.
3476
+ credits_consumed:,
3477
+ # The number of credits remaining for your organization after this request.
3478
+ credits_remaining:
3479
+ )
3480
+ end
3481
+
3482
+ sig do
3483
+ override.returns(
3484
+ { credits_consumed: Integer, credits_remaining: Integer }
3485
+ )
3486
+ end
3487
+ def to_hash
3488
+ end
3489
+ end
3425
3490
  end
3426
3491
  end
3427
3492
  end
@@ -34,6 +34,25 @@ module ContextDev
34
34
  sig { params(code: Integer).void }
35
35
  attr_writer :code
36
36
 
37
+ # Metadata about the API key used for the request. Included in every response
38
+ # whenever a valid API key is provided, even when the response status is not 200.
39
+ sig do
40
+ returns(
41
+ T.nilable(
42
+ ContextDev::Models::BrandRetrieveSimplifiedResponse::KeyMetadata
43
+ )
44
+ )
45
+ end
46
+ attr_reader :key_metadata
47
+
48
+ sig do
49
+ params(
50
+ key_metadata:
51
+ ContextDev::Models::BrandRetrieveSimplifiedResponse::KeyMetadata::OrHash
52
+ ).void
53
+ end
54
+ attr_writer :key_metadata
55
+
37
56
  # Status of the response, e.g., 'ok'
38
57
  sig { returns(T.nilable(String)) }
39
58
  attr_reader :status
@@ -46,6 +65,8 @@ module ContextDev
46
65
  brand:
47
66
  ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::OrHash,
48
67
  code: Integer,
68
+ key_metadata:
69
+ ContextDev::Models::BrandRetrieveSimplifiedResponse::KeyMetadata::OrHash,
49
70
  status: String
50
71
  ).returns(T.attached_class)
51
72
  end
@@ -54,6 +75,9 @@ module ContextDev
54
75
  brand: nil,
55
76
  # HTTP status code of the response
56
77
  code: nil,
78
+ # Metadata about the API key used for the request. Included in every response
79
+ # whenever a valid API key is provided, even when the response status is not 200.
80
+ key_metadata: nil,
57
81
  # Status of the response, e.g., 'ok'
58
82
  status: nil
59
83
  )
@@ -64,6 +88,8 @@ module ContextDev
64
88
  {
65
89
  brand: ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand,
66
90
  code: Integer,
91
+ key_metadata:
92
+ ContextDev::Models::BrandRetrieveSimplifiedResponse::KeyMetadata,
67
93
  status: String
68
94
  }
69
95
  )
@@ -758,6 +784,47 @@ module ContextDev
758
784
  end
759
785
  end
760
786
  end
787
+
788
+ class KeyMetadata < ContextDev::Internal::Type::BaseModel
789
+ OrHash =
790
+ T.type_alias do
791
+ T.any(
792
+ ContextDev::Models::BrandRetrieveSimplifiedResponse::KeyMetadata,
793
+ ContextDev::Internal::AnyHash
794
+ )
795
+ end
796
+
797
+ # The number of credits consumed by this request.
798
+ sig { returns(Integer) }
799
+ attr_accessor :credits_consumed
800
+
801
+ # The number of credits remaining for your organization after this request.
802
+ sig { returns(Integer) }
803
+ attr_accessor :credits_remaining
804
+
805
+ # Metadata about the API key used for the request. Included in every response
806
+ # whenever a valid API key is provided, even when the response status is not 200.
807
+ sig do
808
+ params(credits_consumed: Integer, credits_remaining: Integer).returns(
809
+ T.attached_class
810
+ )
811
+ end
812
+ def self.new(
813
+ # The number of credits consumed by this request.
814
+ credits_consumed:,
815
+ # The number of credits remaining for your organization after this request.
816
+ credits_remaining:
817
+ )
818
+ end
819
+
820
+ sig do
821
+ override.returns(
822
+ { credits_consumed: Integer, credits_remaining: Integer }
823
+ )
824
+ end
825
+ def to_hash
826
+ end
827
+ end
761
828
  end
762
829
  end
763
830
  end