brand.dev 0.1.0.pre.alpha.3 → 0.1.0.pre.alpha.4
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 +13 -0
- data/README.md +1 -1
- data/lib/brand_dev/models/brand_retrieve_params.rb +14 -1
- data/lib/brand_dev/resources/brand.rb +7 -2
- data/lib/brand_dev/version.rb +1 -1
- data/rbi/brand_dev/models/brand_retrieve_params.rbi +15 -0
- data/rbi/brand_dev/resources/brand.rbi +5 -0
- data/sig/brand_dev/models/brand_retrieve_params.rbs +8 -1
- data/sig/brand_dev/resources/brand.rbs +1 -0
- metadata +1 -1
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: b7838f8c194543e8e3ba05ae68343cc13ea4aed8ceabcb0502530061da5a41ac
|
4
|
+
data.tar.gz: 9036c6faf4fee43e86625466038184bd93b1c3118ccfcdc132b2d00dabf30fe3
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: c7b864fff0ccfb6e158d491159cbed2efbb9e497245f5c35779b010ddfa74e43538a228cd7041623da7d806c19a1288ddeea4db6983a3b4a7caf9776e4642613
|
7
|
+
data.tar.gz: 1e7fc08296c8f69cc226b9f84337a48fc90043f1943057f4892841a412200c7a17bb827cd4a34db3b8a983ad4464ea7d877e4213eae8cefb9338b2452e015f15
|
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,18 @@
|
|
1
1
|
# Changelog
|
2
2
|
|
3
|
+
## 0.1.0-alpha.4 (2025-06-06)
|
4
|
+
|
5
|
+
Full Changelog: [v0.1.0-alpha.3...v0.1.0-alpha.4](https://github.com/brand-dot-dev/ruby-sdk/compare/v0.1.0-alpha.3...v0.1.0-alpha.4)
|
6
|
+
|
7
|
+
### Features
|
8
|
+
|
9
|
+
* **api:** manual updates ([05a611f](https://github.com/brand-dot-dev/ruby-sdk/commit/05a611fe140468f965dbb41c0d8250d3dd84a9aa))
|
10
|
+
|
11
|
+
|
12
|
+
### Chores
|
13
|
+
|
14
|
+
* **internal:** codegen related update ([b850fe2](https://github.com/brand-dot-dev/ruby-sdk/commit/b850fe270f6c9e7d63b380a6bdcdb9c0c6b6b65f))
|
15
|
+
|
3
16
|
## 0.1.0-alpha.3 (2025-06-06)
|
4
17
|
|
5
18
|
Full Changelog: [v0.1.0-alpha.2...v0.1.0-alpha.3](https://github.com/brand-dot-dev/ruby-sdk/compare/v0.1.0-alpha.2...v0.1.0-alpha.3)
|
data/README.md
CHANGED
@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
|
|
15
15
|
<!-- x-release-please-start-version -->
|
16
16
|
|
17
17
|
```ruby
|
18
|
-
gem "brand.dev", "~> 0.1.0.pre.alpha.
|
18
|
+
gem "brand.dev", "~> 0.1.0.pre.alpha.4"
|
19
19
|
```
|
20
20
|
|
21
21
|
<!-- x-release-please-end -->
|
@@ -19,11 +19,24 @@ module BrandDev
|
|
19
19
|
# @return [Symbol, BrandDev::Models::BrandRetrieveParams::ForceLanguage, nil]
|
20
20
|
optional :force_language, enum: -> { BrandDev::BrandRetrieveParams::ForceLanguage }
|
21
21
|
|
22
|
-
# @!
|
22
|
+
# @!attribute max_speed
|
23
|
+
# Optional parameter to optimize the API call for maximum speed. When set to true,
|
24
|
+
# the API will skip social media data extraction and external service calls (like
|
25
|
+
# Crunchbase) to return results faster with basic brand information only.
|
26
|
+
#
|
27
|
+
# @return [Boolean, nil]
|
28
|
+
optional :max_speed, BrandDev::Internal::Type::Boolean
|
29
|
+
|
30
|
+
# @!method initialize(domain:, force_language: nil, max_speed: nil, request_options: {})
|
31
|
+
# Some parameter documentations has been truncated, see
|
32
|
+
# {BrandDev::Models::BrandRetrieveParams} for more details.
|
33
|
+
#
|
23
34
|
# @param domain [String] Domain name to retrieve brand data for
|
24
35
|
#
|
25
36
|
# @param force_language [Symbol, BrandDev::Models::BrandRetrieveParams::ForceLanguage] Optional parameter to force the language of the retrieved brand data
|
26
37
|
#
|
38
|
+
# @param max_speed [Boolean] Optional parameter to optimize the API call for maximum speed. When set to true,
|
39
|
+
#
|
27
40
|
# @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}]
|
28
41
|
|
29
42
|
# Optional parameter to force the language of the retrieved brand data
|
@@ -3,14 +3,19 @@
|
|
3
3
|
module BrandDev
|
4
4
|
module Resources
|
5
5
|
class Brand
|
6
|
+
# Some parameter documentations has been truncated, see
|
7
|
+
# {BrandDev::Models::BrandRetrieveParams} for more details.
|
8
|
+
#
|
6
9
|
# Retrieve brand data by domain
|
7
10
|
#
|
8
|
-
# @overload retrieve(domain:, force_language: nil, request_options: {})
|
11
|
+
# @overload retrieve(domain:, force_language: nil, max_speed: nil, request_options: {})
|
9
12
|
#
|
10
13
|
# @param domain [String] Domain name to retrieve brand data for
|
11
14
|
#
|
12
15
|
# @param force_language [Symbol, BrandDev::Models::BrandRetrieveParams::ForceLanguage] Optional parameter to force the language of the retrieved brand data
|
13
16
|
#
|
17
|
+
# @param max_speed [Boolean] Optional parameter to optimize the API call for maximum speed. When set to true,
|
18
|
+
#
|
14
19
|
# @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}, nil]
|
15
20
|
#
|
16
21
|
# @return [BrandDev::Models::BrandRetrieveResponse]
|
@@ -21,7 +26,7 @@ module BrandDev
|
|
21
26
|
@client.request(
|
22
27
|
method: :get,
|
23
28
|
path: "brand/retrieve",
|
24
|
-
query: parsed,
|
29
|
+
query: parsed.transform_keys(max_speed: "maxSpeed"),
|
25
30
|
model: BrandDev::Models::BrandRetrieveResponse,
|
26
31
|
options: options
|
27
32
|
)
|
data/lib/brand_dev/version.rb
CHANGED
@@ -30,11 +30,21 @@ module BrandDev
|
|
30
30
|
end
|
31
31
|
attr_writer :force_language
|
32
32
|
|
33
|
+
# Optional parameter to optimize the API call for maximum speed. When set to true,
|
34
|
+
# the API will skip social media data extraction and external service calls (like
|
35
|
+
# Crunchbase) to return results faster with basic brand information only.
|
36
|
+
sig { returns(T.nilable(T::Boolean)) }
|
37
|
+
attr_reader :max_speed
|
38
|
+
|
39
|
+
sig { params(max_speed: T::Boolean).void }
|
40
|
+
attr_writer :max_speed
|
41
|
+
|
33
42
|
sig do
|
34
43
|
params(
|
35
44
|
domain: String,
|
36
45
|
force_language:
|
37
46
|
BrandDev::BrandRetrieveParams::ForceLanguage::OrSymbol,
|
47
|
+
max_speed: T::Boolean,
|
38
48
|
request_options: BrandDev::RequestOptions::OrHash
|
39
49
|
).returns(T.attached_class)
|
40
50
|
end
|
@@ -43,6 +53,10 @@ module BrandDev
|
|
43
53
|
domain:,
|
44
54
|
# Optional parameter to force the language of the retrieved brand data
|
45
55
|
force_language: nil,
|
56
|
+
# Optional parameter to optimize the API call for maximum speed. When set to true,
|
57
|
+
# the API will skip social media data extraction and external service calls (like
|
58
|
+
# Crunchbase) to return results faster with basic brand information only.
|
59
|
+
max_speed: nil,
|
46
60
|
request_options: {}
|
47
61
|
)
|
48
62
|
end
|
@@ -53,6 +67,7 @@ module BrandDev
|
|
53
67
|
domain: String,
|
54
68
|
force_language:
|
55
69
|
BrandDev::BrandRetrieveParams::ForceLanguage::OrSymbol,
|
70
|
+
max_speed: T::Boolean,
|
56
71
|
request_options: BrandDev::RequestOptions
|
57
72
|
}
|
58
73
|
)
|
@@ -9,6 +9,7 @@ module BrandDev
|
|
9
9
|
domain: String,
|
10
10
|
force_language:
|
11
11
|
BrandDev::BrandRetrieveParams::ForceLanguage::OrSymbol,
|
12
|
+
max_speed: T::Boolean,
|
12
13
|
request_options: BrandDev::RequestOptions::OrHash
|
13
14
|
).returns(BrandDev::Models::BrandRetrieveResponse)
|
14
15
|
end
|
@@ -17,6 +18,10 @@ module BrandDev
|
|
17
18
|
domain:,
|
18
19
|
# Optional parameter to force the language of the retrieved brand data
|
19
20
|
force_language: nil,
|
21
|
+
# Optional parameter to optimize the API call for maximum speed. When set to true,
|
22
|
+
# the API will skip social media data extraction and external service calls (like
|
23
|
+
# Crunchbase) to return results faster with basic brand information only.
|
24
|
+
max_speed: nil,
|
20
25
|
request_options: {}
|
21
26
|
)
|
22
27
|
end
|
@@ -3,7 +3,8 @@ module BrandDev
|
|
3
3
|
type brand_retrieve_params =
|
4
4
|
{
|
5
5
|
domain: String,
|
6
|
-
force_language: BrandDev::Models::BrandRetrieveParams::force_language
|
6
|
+
force_language: BrandDev::Models::BrandRetrieveParams::force_language,
|
7
|
+
max_speed: bool
|
7
8
|
}
|
8
9
|
& BrandDev::Internal::Type::request_parameters
|
9
10
|
|
@@ -19,15 +20,21 @@ module BrandDev
|
|
19
20
|
BrandDev::Models::BrandRetrieveParams::force_language
|
20
21
|
) -> BrandDev::Models::BrandRetrieveParams::force_language
|
21
22
|
|
23
|
+
attr_reader max_speed: bool?
|
24
|
+
|
25
|
+
def max_speed=: (bool) -> bool
|
26
|
+
|
22
27
|
def initialize: (
|
23
28
|
domain: String,
|
24
29
|
?force_language: BrandDev::Models::BrandRetrieveParams::force_language,
|
30
|
+
?max_speed: bool,
|
25
31
|
?request_options: BrandDev::request_opts
|
26
32
|
) -> void
|
27
33
|
|
28
34
|
def to_hash: -> {
|
29
35
|
domain: String,
|
30
36
|
force_language: BrandDev::Models::BrandRetrieveParams::force_language,
|
37
|
+
max_speed: bool,
|
31
38
|
request_options: BrandDev::RequestOptions
|
32
39
|
}
|
33
40
|
|