brand.dev 0.27.0 → 0.28.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +14 -0
- data/README.md +1 -1
- data/lib/brand_dev/models/brand_identify_from_transaction_params.rb +11 -1
- data/lib/brand_dev/models/brand_web_scrape_md_params.rb +9 -1
- data/lib/brand_dev/resources/brand.rb +11 -3
- data/lib/brand_dev/version.rb +1 -1
- data/rbi/brand_dev/models/brand_identify_from_transaction_params.rbi +15 -0
- data/rbi/brand_dev/models/brand_web_scrape_md_params.rbi +11 -0
- data/rbi/brand_dev/resources/brand.rbi +8 -0
- data/sig/brand_dev/models/brand_identify_from_transaction_params.rbs +7 -0
- data/sig/brand_dev/models/brand_web_scrape_md_params.rbs +12 -1
- data/sig/brand_dev/resources/brand.rbs +2 -0
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: b08a446d47e44525b19b98dc2de388bdf629936ee50d29b07744acab598cd8e6
|
|
4
|
+
data.tar.gz: 16fdf55175d7e06c83536fd5646d925a5c2cc5440d1f5802a2c41506b9dbfe4e
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: e6aa9372e2f6b43828750f4313eae61bd4429a7412dac53a4f5002bfbad900419b7ec91397b275148d4d6d2e56b1ee74e92334ed40178c51ffd80f5429c124a4
|
|
7
|
+
data.tar.gz: adf3ff257d6656ddc5d3232678a1d807b3a4c5fe386e5f28ad71ec388c65bc5868d315c93400a597b5794fa731f10cf23cb0fbcb6c7d5e8787516a0b941b1cc0
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,19 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 0.28.0 (2026-03-01)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v0.27.0...v0.28.0](https://github.com/brand-dot-dev/ruby-sdk/compare/v0.27.0...v0.28.0)
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
* **api:** api update ([e331b46](https://github.com/brand-dot-dev/ruby-sdk/commit/e331b462ba84b3bf7e1415b30446dd0415fefd8e))
|
|
10
|
+
* **api:** api update ([2a8660e](https://github.com/brand-dot-dev/ruby-sdk/commit/2a8660ed1f64a46657919b4d7cd314ea47e4d8c6))
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
### Bug Fixes
|
|
14
|
+
|
|
15
|
+
* properly mock time in ruby ci tests ([3d3021f](https://github.com/brand-dot-dev/ruby-sdk/commit/3d3021f8b4b775084459fa5559e9dec7d856b4be))
|
|
16
|
+
|
|
3
17
|
## 0.27.0 (2026-02-24)
|
|
4
18
|
|
|
5
19
|
Full Changelog: [v0.26.0...v0.27.0](https://github.com/brand-dot-dev/ruby-sdk/compare/v0.26.0...v0.27.0)
|
data/README.md
CHANGED
|
@@ -32,6 +32,14 @@ module BrandDev
|
|
|
32
32
|
# @return [Symbol, BrandDev::Models::BrandIdentifyFromTransactionParams::ForceLanguage, nil]
|
|
33
33
|
optional :force_language, enum: -> { BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage }
|
|
34
34
|
|
|
35
|
+
# @!attribute high_confidence_only
|
|
36
|
+
# When set to true, the API will perform an additional verification steps to
|
|
37
|
+
# ensure the identified brand matches the transaction with high confidence.
|
|
38
|
+
# Defaults to false.
|
|
39
|
+
#
|
|
40
|
+
# @return [Boolean, nil]
|
|
41
|
+
optional :high_confidence_only, BrandDev::Internal::Type::Boolean
|
|
42
|
+
|
|
35
43
|
# @!attribute max_speed
|
|
36
44
|
# Optional parameter to optimize the API call for maximum speed. When set to true,
|
|
37
45
|
# the API will skip time-consuming operations for faster response at the cost of
|
|
@@ -61,7 +69,7 @@ module BrandDev
|
|
|
61
69
|
# @return [Integer, nil]
|
|
62
70
|
optional :timeout_ms, Integer
|
|
63
71
|
|
|
64
|
-
# @!method initialize(transaction_info:, city: nil, country_gl: nil, force_language: nil, max_speed: nil, mcc: nil, phone: nil, timeout_ms: nil, request_options: {})
|
|
72
|
+
# @!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, request_options: {})
|
|
65
73
|
# Some parameter documentations has been truncated, see
|
|
66
74
|
# {BrandDev::Models::BrandIdentifyFromTransactionParams} for more details.
|
|
67
75
|
#
|
|
@@ -73,6 +81,8 @@ module BrandDev
|
|
|
73
81
|
#
|
|
74
82
|
# @param force_language [Symbol, BrandDev::Models::BrandIdentifyFromTransactionParams::ForceLanguage] Optional parameter to force the language of the retrieved brand data.
|
|
75
83
|
#
|
|
84
|
+
# @param high_confidence_only [Boolean] When set to true, the API will perform an additional verification steps to ensur
|
|
85
|
+
#
|
|
76
86
|
# @param max_speed [Boolean] Optional parameter to optimize the API call for maximum speed. When set to true,
|
|
77
87
|
#
|
|
78
88
|
# @param mcc [String] Optional Merchant Category Code (MCC) to help identify the business category/ind
|
|
@@ -26,7 +26,13 @@ module BrandDev
|
|
|
26
26
|
# @return [Boolean, nil]
|
|
27
27
|
optional :include_links, BrandDev::Internal::Type::Boolean
|
|
28
28
|
|
|
29
|
-
# @!
|
|
29
|
+
# @!attribute shorten_base64_images
|
|
30
|
+
# Shorten base64-encoded image data in the Markdown output
|
|
31
|
+
#
|
|
32
|
+
# @return [Boolean, nil]
|
|
33
|
+
optional :shorten_base64_images, BrandDev::Internal::Type::Boolean
|
|
34
|
+
|
|
35
|
+
# @!method initialize(url:, include_images: nil, include_links: nil, shorten_base64_images: nil, request_options: {})
|
|
30
36
|
# Some parameter documentations has been truncated, see
|
|
31
37
|
# {BrandDev::Models::BrandWebScrapeMdParams} for more details.
|
|
32
38
|
#
|
|
@@ -36,6 +42,8 @@ module BrandDev
|
|
|
36
42
|
#
|
|
37
43
|
# @param include_links [Boolean] Preserve hyperlinks in Markdown output
|
|
38
44
|
#
|
|
45
|
+
# @param shorten_base64_images [Boolean] Shorten base64-encoded image data in the Markdown output
|
|
46
|
+
#
|
|
39
47
|
# @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}]
|
|
40
48
|
end
|
|
41
49
|
end
|
|
@@ -164,7 +164,7 @@ module BrandDev
|
|
|
164
164
|
# Endpoint specially designed for platforms that want to identify transaction data
|
|
165
165
|
# by the transaction title.
|
|
166
166
|
#
|
|
167
|
-
# @overload identify_from_transaction(transaction_info:, city: nil, country_gl: nil, force_language: nil, max_speed: nil, mcc: nil, phone: nil, timeout_ms: nil, request_options: {})
|
|
167
|
+
# @overload identify_from_transaction(transaction_info:, city: nil, country_gl: nil, force_language: nil, high_confidence_only: nil, max_speed: nil, mcc: nil, phone: nil, timeout_ms: nil, request_options: {})
|
|
168
168
|
#
|
|
169
169
|
# @param transaction_info [String] Transaction information to identify the brand
|
|
170
170
|
#
|
|
@@ -174,6 +174,8 @@ module BrandDev
|
|
|
174
174
|
#
|
|
175
175
|
# @param force_language [Symbol, BrandDev::Models::BrandIdentifyFromTransactionParams::ForceLanguage] Optional parameter to force the language of the retrieved brand data.
|
|
176
176
|
#
|
|
177
|
+
# @param high_confidence_only [Boolean] When set to true, the API will perform an additional verification steps to ensur
|
|
178
|
+
#
|
|
177
179
|
# @param max_speed [Boolean] Optional parameter to optimize the API call for maximum speed. When set to true,
|
|
178
180
|
#
|
|
179
181
|
# @param mcc [String] Optional Merchant Category Code (MCC) to help identify the business category/ind
|
|
@@ -579,7 +581,7 @@ module BrandDev
|
|
|
579
581
|
# (GFM), and returns the result. Uses automatic proxy escalation to handle blocked
|
|
580
582
|
# sites.
|
|
581
583
|
#
|
|
582
|
-
# @overload web_scrape_md(url:, include_images: nil, include_links: nil, request_options: {})
|
|
584
|
+
# @overload web_scrape_md(url:, include_images: nil, include_links: nil, shorten_base64_images: nil, request_options: {})
|
|
583
585
|
#
|
|
584
586
|
# @param url [String] Full URL to scrape and convert to markdown (must include http:// or https:// pro
|
|
585
587
|
#
|
|
@@ -587,6 +589,8 @@ module BrandDev
|
|
|
587
589
|
#
|
|
588
590
|
# @param include_links [Boolean] Preserve hyperlinks in Markdown output
|
|
589
591
|
#
|
|
592
|
+
# @param shorten_base64_images [Boolean] Shorten base64-encoded image data in the Markdown output
|
|
593
|
+
#
|
|
590
594
|
# @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
591
595
|
#
|
|
592
596
|
# @return [BrandDev::Models::BrandWebScrapeMdResponse]
|
|
@@ -597,7 +601,11 @@ module BrandDev
|
|
|
597
601
|
@client.request(
|
|
598
602
|
method: :get,
|
|
599
603
|
path: "web/scrape/markdown",
|
|
600
|
-
query: parsed.transform_keys(
|
|
604
|
+
query: parsed.transform_keys(
|
|
605
|
+
include_images: "includeImages",
|
|
606
|
+
include_links: "includeLinks",
|
|
607
|
+
shorten_base64_images: "shortenBase64Images"
|
|
608
|
+
),
|
|
601
609
|
model: BrandDev::Models::BrandWebScrapeMdResponse,
|
|
602
610
|
options: options
|
|
603
611
|
)
|
data/lib/brand_dev/version.rb
CHANGED
|
@@ -62,6 +62,15 @@ module BrandDev
|
|
|
62
62
|
end
|
|
63
63
|
attr_writer :force_language
|
|
64
64
|
|
|
65
|
+
# When set to true, the API will perform an additional verification steps to
|
|
66
|
+
# ensure the identified brand matches the transaction with high confidence.
|
|
67
|
+
# Defaults to false.
|
|
68
|
+
sig { returns(T.nilable(T::Boolean)) }
|
|
69
|
+
attr_reader :high_confidence_only
|
|
70
|
+
|
|
71
|
+
sig { params(high_confidence_only: T::Boolean).void }
|
|
72
|
+
attr_writer :high_confidence_only
|
|
73
|
+
|
|
65
74
|
# Optional parameter to optimize the API call for maximum speed. When set to true,
|
|
66
75
|
# the API will skip time-consuming operations for faster response at the cost of
|
|
67
76
|
# less comprehensive data.
|
|
@@ -103,6 +112,7 @@ module BrandDev
|
|
|
103
112
|
BrandDev::BrandIdentifyFromTransactionParams::CountryGl::OrSymbol,
|
|
104
113
|
force_language:
|
|
105
114
|
BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::OrSymbol,
|
|
115
|
+
high_confidence_only: T::Boolean,
|
|
106
116
|
max_speed: T::Boolean,
|
|
107
117
|
mcc: String,
|
|
108
118
|
phone: Float,
|
|
@@ -120,6 +130,10 @@ module BrandDev
|
|
|
120
130
|
country_gl: nil,
|
|
121
131
|
# Optional parameter to force the language of the retrieved brand data.
|
|
122
132
|
force_language: nil,
|
|
133
|
+
# When set to true, the API will perform an additional verification steps to
|
|
134
|
+
# ensure the identified brand matches the transaction with high confidence.
|
|
135
|
+
# Defaults to false.
|
|
136
|
+
high_confidence_only: nil,
|
|
123
137
|
# Optional parameter to optimize the API call for maximum speed. When set to true,
|
|
124
138
|
# the API will skip time-consuming operations for faster response at the cost of
|
|
125
139
|
# less comprehensive data.
|
|
@@ -146,6 +160,7 @@ module BrandDev
|
|
|
146
160
|
BrandDev::BrandIdentifyFromTransactionParams::CountryGl::OrSymbol,
|
|
147
161
|
force_language:
|
|
148
162
|
BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::OrSymbol,
|
|
163
|
+
high_confidence_only: T::Boolean,
|
|
149
164
|
max_speed: T::Boolean,
|
|
150
165
|
mcc: String,
|
|
151
166
|
phone: Float,
|
|
@@ -30,11 +30,19 @@ module BrandDev
|
|
|
30
30
|
sig { params(include_links: T::Boolean).void }
|
|
31
31
|
attr_writer :include_links
|
|
32
32
|
|
|
33
|
+
# Shorten base64-encoded image data in the Markdown output
|
|
34
|
+
sig { returns(T.nilable(T::Boolean)) }
|
|
35
|
+
attr_reader :shorten_base64_images
|
|
36
|
+
|
|
37
|
+
sig { params(shorten_base64_images: T::Boolean).void }
|
|
38
|
+
attr_writer :shorten_base64_images
|
|
39
|
+
|
|
33
40
|
sig do
|
|
34
41
|
params(
|
|
35
42
|
url: String,
|
|
36
43
|
include_images: T::Boolean,
|
|
37
44
|
include_links: T::Boolean,
|
|
45
|
+
shorten_base64_images: T::Boolean,
|
|
38
46
|
request_options: BrandDev::RequestOptions::OrHash
|
|
39
47
|
).returns(T.attached_class)
|
|
40
48
|
end
|
|
@@ -46,6 +54,8 @@ module BrandDev
|
|
|
46
54
|
include_images: nil,
|
|
47
55
|
# Preserve hyperlinks in Markdown output
|
|
48
56
|
include_links: nil,
|
|
57
|
+
# Shorten base64-encoded image data in the Markdown output
|
|
58
|
+
shorten_base64_images: nil,
|
|
49
59
|
request_options: {}
|
|
50
60
|
)
|
|
51
61
|
end
|
|
@@ -56,6 +66,7 @@ module BrandDev
|
|
|
56
66
|
url: String,
|
|
57
67
|
include_images: T::Boolean,
|
|
58
68
|
include_links: T::Boolean,
|
|
69
|
+
shorten_base64_images: T::Boolean,
|
|
59
70
|
request_options: BrandDev::RequestOptions
|
|
60
71
|
}
|
|
61
72
|
)
|
|
@@ -140,6 +140,7 @@ module BrandDev
|
|
|
140
140
|
BrandDev::BrandIdentifyFromTransactionParams::CountryGl::OrSymbol,
|
|
141
141
|
force_language:
|
|
142
142
|
BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::OrSymbol,
|
|
143
|
+
high_confidence_only: T::Boolean,
|
|
143
144
|
max_speed: T::Boolean,
|
|
144
145
|
mcc: String,
|
|
145
146
|
phone: Float,
|
|
@@ -157,6 +158,10 @@ module BrandDev
|
|
|
157
158
|
country_gl: nil,
|
|
158
159
|
# Optional parameter to force the language of the retrieved brand data.
|
|
159
160
|
force_language: nil,
|
|
161
|
+
# When set to true, the API will perform an additional verification steps to
|
|
162
|
+
# ensure the identified brand matches the transaction with high confidence.
|
|
163
|
+
# Defaults to false.
|
|
164
|
+
high_confidence_only: nil,
|
|
160
165
|
# Optional parameter to optimize the API call for maximum speed. When set to true,
|
|
161
166
|
# the API will skip time-consuming operations for faster response at the cost of
|
|
162
167
|
# less comprehensive data.
|
|
@@ -507,6 +512,7 @@ module BrandDev
|
|
|
507
512
|
url: String,
|
|
508
513
|
include_images: T::Boolean,
|
|
509
514
|
include_links: T::Boolean,
|
|
515
|
+
shorten_base64_images: T::Boolean,
|
|
510
516
|
request_options: BrandDev::RequestOptions::OrHash
|
|
511
517
|
).returns(BrandDev::Models::BrandWebScrapeMdResponse)
|
|
512
518
|
end
|
|
@@ -518,6 +524,8 @@ module BrandDev
|
|
|
518
524
|
include_images: nil,
|
|
519
525
|
# Preserve hyperlinks in Markdown output
|
|
520
526
|
include_links: nil,
|
|
527
|
+
# Shorten base64-encoded image data in the Markdown output
|
|
528
|
+
shorten_base64_images: nil,
|
|
521
529
|
request_options: {}
|
|
522
530
|
)
|
|
523
531
|
end
|
|
@@ -6,6 +6,7 @@ module BrandDev
|
|
|
6
6
|
city: String,
|
|
7
7
|
country_gl: BrandDev::Models::BrandIdentifyFromTransactionParams::country_gl,
|
|
8
8
|
force_language: BrandDev::Models::BrandIdentifyFromTransactionParams::force_language,
|
|
9
|
+
high_confidence_only: bool,
|
|
9
10
|
max_speed: bool,
|
|
10
11
|
mcc: String,
|
|
11
12
|
phone: Float,
|
|
@@ -35,6 +36,10 @@ module BrandDev
|
|
|
35
36
|
BrandDev::Models::BrandIdentifyFromTransactionParams::force_language
|
|
36
37
|
) -> BrandDev::Models::BrandIdentifyFromTransactionParams::force_language
|
|
37
38
|
|
|
39
|
+
attr_reader high_confidence_only: bool?
|
|
40
|
+
|
|
41
|
+
def high_confidence_only=: (bool) -> bool
|
|
42
|
+
|
|
38
43
|
attr_reader max_speed: bool?
|
|
39
44
|
|
|
40
45
|
def max_speed=: (bool) -> bool
|
|
@@ -56,6 +61,7 @@ module BrandDev
|
|
|
56
61
|
?city: String,
|
|
57
62
|
?country_gl: BrandDev::Models::BrandIdentifyFromTransactionParams::country_gl,
|
|
58
63
|
?force_language: BrandDev::Models::BrandIdentifyFromTransactionParams::force_language,
|
|
64
|
+
?high_confidence_only: bool,
|
|
59
65
|
?max_speed: bool,
|
|
60
66
|
?mcc: String,
|
|
61
67
|
?phone: Float,
|
|
@@ -68,6 +74,7 @@ module BrandDev
|
|
|
68
74
|
city: String,
|
|
69
75
|
country_gl: BrandDev::Models::BrandIdentifyFromTransactionParams::country_gl,
|
|
70
76
|
force_language: BrandDev::Models::BrandIdentifyFromTransactionParams::force_language,
|
|
77
|
+
high_confidence_only: bool,
|
|
71
78
|
max_speed: bool,
|
|
72
79
|
mcc: String,
|
|
73
80
|
phone: Float,
|
|
@@ -1,7 +1,12 @@
|
|
|
1
1
|
module BrandDev
|
|
2
2
|
module Models
|
|
3
3
|
type brand_web_scrape_md_params =
|
|
4
|
-
{
|
|
4
|
+
{
|
|
5
|
+
url: String,
|
|
6
|
+
include_images: bool,
|
|
7
|
+
include_links: bool,
|
|
8
|
+
:shorten_base64_images => bool
|
|
9
|
+
}
|
|
5
10
|
& BrandDev::Internal::Type::request_parameters
|
|
6
11
|
|
|
7
12
|
class BrandWebScrapeMdParams < BrandDev::Internal::Type::BaseModel
|
|
@@ -18,10 +23,15 @@ module BrandDev
|
|
|
18
23
|
|
|
19
24
|
def include_links=: (bool) -> bool
|
|
20
25
|
|
|
26
|
+
attr_reader shorten_base64_images: bool?
|
|
27
|
+
|
|
28
|
+
def shorten_base64_images=: (bool) -> bool
|
|
29
|
+
|
|
21
30
|
def initialize: (
|
|
22
31
|
url: String,
|
|
23
32
|
?include_images: bool,
|
|
24
33
|
?include_links: bool,
|
|
34
|
+
?shorten_base64_images: bool,
|
|
25
35
|
?request_options: BrandDev::request_opts
|
|
26
36
|
) -> void
|
|
27
37
|
|
|
@@ -29,6 +39,7 @@ module BrandDev
|
|
|
29
39
|
url: String,
|
|
30
40
|
include_images: bool,
|
|
31
41
|
include_links: bool,
|
|
42
|
+
:shorten_base64_images => bool,
|
|
32
43
|
request_options: BrandDev::RequestOptions
|
|
33
44
|
}
|
|
34
45
|
end
|
|
@@ -42,6 +42,7 @@ module BrandDev
|
|
|
42
42
|
?city: String,
|
|
43
43
|
?country_gl: BrandDev::Models::BrandIdentifyFromTransactionParams::country_gl,
|
|
44
44
|
?force_language: BrandDev::Models::BrandIdentifyFromTransactionParams::force_language,
|
|
45
|
+
?high_confidence_only: bool,
|
|
45
46
|
?max_speed: bool,
|
|
46
47
|
?mcc: String,
|
|
47
48
|
?phone: Float,
|
|
@@ -138,6 +139,7 @@ module BrandDev
|
|
|
138
139
|
url: String,
|
|
139
140
|
?include_images: bool,
|
|
140
141
|
?include_links: bool,
|
|
142
|
+
?shorten_base64_images: bool,
|
|
141
143
|
?request_options: BrandDev::request_opts
|
|
142
144
|
) -> BrandDev::Models::BrandWebScrapeMdResponse
|
|
143
145
|
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: brand.dev
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.28.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Brand Dev
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2026-02
|
|
11
|
+
date: 2026-03-02 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: cgi
|