surge_api 0.20.0 → 0.21.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 +9 -0
- data/README.md +1 -1
- data/lib/surge_api/models/campaign_resend_brand_verification_message_params.rb +22 -0
- data/lib/surge_api/models/campaign_resend_brand_verification_message_response.rb +31 -0
- data/lib/surge_api/models.rb +3 -0
- data/lib/surge_api/resources/campaigns.rb +20 -0
- data/lib/surge_api/version.rb +1 -1
- data/lib/surge_api.rb +2 -0
- data/rbi/surge_api/models/campaign_resend_brand_verification_message_params.rbi +43 -0
- data/rbi/surge_api/models/campaign_resend_brand_verification_message_response.rbi +77 -0
- data/rbi/surge_api/models.rbi +3 -0
- data/rbi/surge_api/resources/campaigns.rbi +16 -0
- data/sig/surge_api/models/campaign_resend_brand_verification_message_params.rbs +23 -0
- data/sig/surge_api/models/campaign_resend_brand_verification_message_response.rbs +30 -0
- data/sig/surge_api/models.rbs +2 -0
- data/sig/surge_api/resources/campaigns.rbs +5 -0
- metadata +8 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: bf70e2dc494e17135e948383614cf4a98b4710b5cc11ef211a7a4abeb62bfd26
|
|
4
|
+
data.tar.gz: 0bfd0eb5612a801a91a5d3dc0910de65ce1ed7c245466af750734e63902de8a9
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 229908ae959ad10bbc76146860cb9ed15b8f05a872fb8d651ec1160acd733bfcb10c6f0465395d7c4bec0fa4b11a5883b25ad8e912fe804c1741c4955bbea11b
|
|
7
|
+
data.tar.gz: 9cfb4c1a4474c9663bd9f590a0f2ef034d544ebe2b14369e152702d2e01981a759c4c3f05b23d3f58351b42a5b0d17f97364423fe80ea209843f58007b8f0df8
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,14 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 0.21.0 (2026-07-22)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v0.20.0...v0.21.0](https://github.com/surgeapi/ruby-sdk/compare/v0.20.0...v0.21.0)
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
* **api:** add resend brand verification message endpoint ([49f208a](https://github.com/surgeapi/ruby-sdk/commit/49f208ae28574f1b7ef4993d5e9bc165ee7b0f79))
|
|
10
|
+
* **stlc:** configurable CI runner and private-production-repo support in workflow templates ([7d825e7](https://github.com/surgeapi/ruby-sdk/commit/7d825e74a607a569319c08d22c2fa87b3fe9efb0))
|
|
11
|
+
|
|
3
12
|
## 0.20.0 (2026-07-14)
|
|
4
13
|
|
|
5
14
|
Full Changelog: [v0.19.0...v0.20.0](https://github.com/surgeapi/ruby-sdk/compare/v0.19.0...v0.20.0)
|
data/README.md
CHANGED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module SurgeAPI
|
|
4
|
+
module Models
|
|
5
|
+
# @see SurgeAPI::Resources::Campaigns#resend_brand_verification_message
|
|
6
|
+
class CampaignResendBrandVerificationMessageParams < SurgeAPI::Internal::Type::BaseModel
|
|
7
|
+
extend SurgeAPI::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include SurgeAPI::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!attribute account_id
|
|
11
|
+
# The account whose brand verification OTP should be sent.
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :account_id, String
|
|
15
|
+
|
|
16
|
+
# @!method initialize(account_id:, request_options: {})
|
|
17
|
+
# @param account_id [String] The account whose brand verification OTP should be sent.
|
|
18
|
+
#
|
|
19
|
+
# @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}]
|
|
20
|
+
end
|
|
21
|
+
end
|
|
22
|
+
end
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module SurgeAPI
|
|
4
|
+
module Models
|
|
5
|
+
# @see SurgeAPI::Resources::Campaigns#resend_brand_verification_message
|
|
6
|
+
class CampaignResendBrandVerificationMessageResponse < SurgeAPI::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute status
|
|
8
|
+
# Indicates the OTP send job was enqueued successfully.
|
|
9
|
+
#
|
|
10
|
+
# @return [Symbol, SurgeAPI::Models::CampaignResendBrandVerificationMessageResponse::Status]
|
|
11
|
+
required :status, enum: -> { SurgeAPI::Models::CampaignResendBrandVerificationMessageResponse::Status }
|
|
12
|
+
|
|
13
|
+
# @!method initialize(status:)
|
|
14
|
+
# Response when a brand verification OTP send has been enqueued
|
|
15
|
+
#
|
|
16
|
+
# @param status [Symbol, SurgeAPI::Models::CampaignResendBrandVerificationMessageResponse::Status] Indicates the OTP send job was enqueued successfully.
|
|
17
|
+
|
|
18
|
+
# Indicates the OTP send job was enqueued successfully.
|
|
19
|
+
#
|
|
20
|
+
# @see SurgeAPI::Models::CampaignResendBrandVerificationMessageResponse#status
|
|
21
|
+
module Status
|
|
22
|
+
extend SurgeAPI::Internal::Type::Enum
|
|
23
|
+
|
|
24
|
+
ENQUEUED = :enqueued
|
|
25
|
+
|
|
26
|
+
# @!method self.values
|
|
27
|
+
# @return [Array<Symbol>]
|
|
28
|
+
end
|
|
29
|
+
end
|
|
30
|
+
end
|
|
31
|
+
end
|
data/lib/surge_api/models.rb
CHANGED
|
@@ -77,6 +77,9 @@ module SurgeAPI
|
|
|
77
77
|
|
|
78
78
|
CampaignParams = SurgeAPI::Models::CampaignParams
|
|
79
79
|
|
|
80
|
+
CampaignResendBrandVerificationMessageParams =
|
|
81
|
+
SurgeAPI::Models::CampaignResendBrandVerificationMessageParams
|
|
82
|
+
|
|
80
83
|
CampaignRetrieveParams = SurgeAPI::Models::CampaignRetrieveParams
|
|
81
84
|
|
|
82
85
|
CampaignUpdateParams = SurgeAPI::Models::CampaignUpdateParams
|
|
@@ -111,6 +111,26 @@ module SurgeAPI
|
|
|
111
111
|
)
|
|
112
112
|
end
|
|
113
113
|
|
|
114
|
+
# Enqueues an SMS OTP for a sole proprietor brand awaiting identity verification.
|
|
115
|
+
#
|
|
116
|
+
# @overload resend_brand_verification_message(account_id, request_options: {})
|
|
117
|
+
#
|
|
118
|
+
# @param account_id [String] The account whose brand verification OTP should be sent.
|
|
119
|
+
#
|
|
120
|
+
# @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
121
|
+
#
|
|
122
|
+
# @return [SurgeAPI::Models::CampaignResendBrandVerificationMessageResponse]
|
|
123
|
+
#
|
|
124
|
+
# @see SurgeAPI::Models::CampaignResendBrandVerificationMessageParams
|
|
125
|
+
def resend_brand_verification_message(account_id, params = {})
|
|
126
|
+
@client.request(
|
|
127
|
+
method: :post,
|
|
128
|
+
path: ["accounts/%1$s/brand_verification_messages", account_id],
|
|
129
|
+
model: SurgeAPI::Models::CampaignResendBrandVerificationMessageResponse,
|
|
130
|
+
options: params[:request_options]
|
|
131
|
+
)
|
|
132
|
+
end
|
|
133
|
+
|
|
114
134
|
# @api private
|
|
115
135
|
#
|
|
116
136
|
# @param client [SurgeAPI::Client]
|
data/lib/surge_api/version.rb
CHANGED
data/lib/surge_api.rb
CHANGED
|
@@ -76,6 +76,8 @@ require_relative "surge_api/models/campaign"
|
|
|
76
76
|
require_relative "surge_api/models/campaign_approved_webhook_event"
|
|
77
77
|
require_relative "surge_api/models/campaign_create_params"
|
|
78
78
|
require_relative "surge_api/models/campaign_list_params"
|
|
79
|
+
require_relative "surge_api/models/campaign_resend_brand_verification_message_params"
|
|
80
|
+
require_relative "surge_api/models/campaign_resend_brand_verification_message_response"
|
|
79
81
|
require_relative "surge_api/models/campaign_retrieve_params"
|
|
80
82
|
require_relative "surge_api/models/campaign_update_params"
|
|
81
83
|
require_relative "surge_api/models/contact"
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# typed: strong
|
|
2
|
+
|
|
3
|
+
module SurgeAPI
|
|
4
|
+
module Models
|
|
5
|
+
class CampaignResendBrandVerificationMessageParams < SurgeAPI::Internal::Type::BaseModel
|
|
6
|
+
extend SurgeAPI::Internal::Type::RequestParameters::Converter
|
|
7
|
+
include SurgeAPI::Internal::Type::RequestParameters
|
|
8
|
+
|
|
9
|
+
OrHash =
|
|
10
|
+
T.type_alias do
|
|
11
|
+
T.any(
|
|
12
|
+
SurgeAPI::CampaignResendBrandVerificationMessageParams,
|
|
13
|
+
SurgeAPI::Internal::AnyHash
|
|
14
|
+
)
|
|
15
|
+
end
|
|
16
|
+
|
|
17
|
+
# The account whose brand verification OTP should be sent.
|
|
18
|
+
sig { returns(String) }
|
|
19
|
+
attr_accessor :account_id
|
|
20
|
+
|
|
21
|
+
sig do
|
|
22
|
+
params(
|
|
23
|
+
account_id: String,
|
|
24
|
+
request_options: SurgeAPI::RequestOptions::OrHash
|
|
25
|
+
).returns(T.attached_class)
|
|
26
|
+
end
|
|
27
|
+
def self.new(
|
|
28
|
+
# The account whose brand verification OTP should be sent.
|
|
29
|
+
account_id:,
|
|
30
|
+
request_options: {}
|
|
31
|
+
)
|
|
32
|
+
end
|
|
33
|
+
|
|
34
|
+
sig do
|
|
35
|
+
override.returns(
|
|
36
|
+
{ account_id: String, request_options: SurgeAPI::RequestOptions }
|
|
37
|
+
)
|
|
38
|
+
end
|
|
39
|
+
def to_hash
|
|
40
|
+
end
|
|
41
|
+
end
|
|
42
|
+
end
|
|
43
|
+
end
|
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
# typed: strong
|
|
2
|
+
|
|
3
|
+
module SurgeAPI
|
|
4
|
+
module Models
|
|
5
|
+
class CampaignResendBrandVerificationMessageResponse < SurgeAPI::Internal::Type::BaseModel
|
|
6
|
+
OrHash =
|
|
7
|
+
T.type_alias do
|
|
8
|
+
T.any(
|
|
9
|
+
SurgeAPI::Models::CampaignResendBrandVerificationMessageResponse,
|
|
10
|
+
SurgeAPI::Internal::AnyHash
|
|
11
|
+
)
|
|
12
|
+
end
|
|
13
|
+
|
|
14
|
+
# Indicates the OTP send job was enqueued successfully.
|
|
15
|
+
sig do
|
|
16
|
+
returns(
|
|
17
|
+
SurgeAPI::Models::CampaignResendBrandVerificationMessageResponse::Status::TaggedSymbol
|
|
18
|
+
)
|
|
19
|
+
end
|
|
20
|
+
attr_accessor :status
|
|
21
|
+
|
|
22
|
+
# Response when a brand verification OTP send has been enqueued
|
|
23
|
+
sig do
|
|
24
|
+
params(
|
|
25
|
+
status:
|
|
26
|
+
SurgeAPI::Models::CampaignResendBrandVerificationMessageResponse::Status::OrSymbol
|
|
27
|
+
).returns(T.attached_class)
|
|
28
|
+
end
|
|
29
|
+
def self.new(
|
|
30
|
+
# Indicates the OTP send job was enqueued successfully.
|
|
31
|
+
status:
|
|
32
|
+
)
|
|
33
|
+
end
|
|
34
|
+
|
|
35
|
+
sig do
|
|
36
|
+
override.returns(
|
|
37
|
+
{
|
|
38
|
+
status:
|
|
39
|
+
SurgeAPI::Models::CampaignResendBrandVerificationMessageResponse::Status::TaggedSymbol
|
|
40
|
+
}
|
|
41
|
+
)
|
|
42
|
+
end
|
|
43
|
+
def to_hash
|
|
44
|
+
end
|
|
45
|
+
|
|
46
|
+
# Indicates the OTP send job was enqueued successfully.
|
|
47
|
+
module Status
|
|
48
|
+
extend SurgeAPI::Internal::Type::Enum
|
|
49
|
+
|
|
50
|
+
TaggedSymbol =
|
|
51
|
+
T.type_alias do
|
|
52
|
+
T.all(
|
|
53
|
+
Symbol,
|
|
54
|
+
SurgeAPI::Models::CampaignResendBrandVerificationMessageResponse::Status
|
|
55
|
+
)
|
|
56
|
+
end
|
|
57
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
|
58
|
+
|
|
59
|
+
ENQUEUED =
|
|
60
|
+
T.let(
|
|
61
|
+
:enqueued,
|
|
62
|
+
SurgeAPI::Models::CampaignResendBrandVerificationMessageResponse::Status::TaggedSymbol
|
|
63
|
+
)
|
|
64
|
+
|
|
65
|
+
sig do
|
|
66
|
+
override.returns(
|
|
67
|
+
T::Array[
|
|
68
|
+
SurgeAPI::Models::CampaignResendBrandVerificationMessageResponse::Status::TaggedSymbol
|
|
69
|
+
]
|
|
70
|
+
)
|
|
71
|
+
end
|
|
72
|
+
def self.values
|
|
73
|
+
end
|
|
74
|
+
end
|
|
75
|
+
end
|
|
76
|
+
end
|
|
77
|
+
end
|
data/rbi/surge_api/models.rbi
CHANGED
|
@@ -39,6 +39,9 @@ module SurgeAPI
|
|
|
39
39
|
|
|
40
40
|
CampaignParams = SurgeAPI::Models::CampaignParams
|
|
41
41
|
|
|
42
|
+
CampaignResendBrandVerificationMessageParams =
|
|
43
|
+
SurgeAPI::Models::CampaignResendBrandVerificationMessageParams
|
|
44
|
+
|
|
42
45
|
CampaignRetrieveParams = SurgeAPI::Models::CampaignRetrieveParams
|
|
43
46
|
|
|
44
47
|
CampaignUpdateParams = SurgeAPI::Models::CampaignUpdateParams
|
|
@@ -85,6 +85,22 @@ module SurgeAPI
|
|
|
85
85
|
)
|
|
86
86
|
end
|
|
87
87
|
|
|
88
|
+
# Enqueues an SMS OTP for a sole proprietor brand awaiting identity verification.
|
|
89
|
+
sig do
|
|
90
|
+
params(
|
|
91
|
+
account_id: String,
|
|
92
|
+
request_options: SurgeAPI::RequestOptions::OrHash
|
|
93
|
+
).returns(
|
|
94
|
+
SurgeAPI::Models::CampaignResendBrandVerificationMessageResponse
|
|
95
|
+
)
|
|
96
|
+
end
|
|
97
|
+
def resend_brand_verification_message(
|
|
98
|
+
# The account whose brand verification OTP should be sent.
|
|
99
|
+
account_id,
|
|
100
|
+
request_options: {}
|
|
101
|
+
)
|
|
102
|
+
end
|
|
103
|
+
|
|
88
104
|
# @api private
|
|
89
105
|
sig { params(client: SurgeAPI::Client).returns(T.attached_class) }
|
|
90
106
|
def self.new(client:)
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
module SurgeAPI
|
|
2
|
+
module Models
|
|
3
|
+
type campaign_resend_brand_verification_message_params =
|
|
4
|
+
{ account_id: String } & SurgeAPI::Internal::Type::request_parameters
|
|
5
|
+
|
|
6
|
+
class CampaignResendBrandVerificationMessageParams < SurgeAPI::Internal::Type::BaseModel
|
|
7
|
+
extend SurgeAPI::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include SurgeAPI::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
attr_accessor account_id: String
|
|
11
|
+
|
|
12
|
+
def initialize: (
|
|
13
|
+
account_id: String,
|
|
14
|
+
?request_options: SurgeAPI::request_opts
|
|
15
|
+
) -> void
|
|
16
|
+
|
|
17
|
+
def to_hash: -> {
|
|
18
|
+
account_id: String,
|
|
19
|
+
request_options: SurgeAPI::RequestOptions
|
|
20
|
+
}
|
|
21
|
+
end
|
|
22
|
+
end
|
|
23
|
+
end
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
module SurgeAPI
|
|
2
|
+
module Models
|
|
3
|
+
type campaign_resend_brand_verification_message_response =
|
|
4
|
+
{
|
|
5
|
+
status: SurgeAPI::Models::CampaignResendBrandVerificationMessageResponse::status
|
|
6
|
+
}
|
|
7
|
+
|
|
8
|
+
class CampaignResendBrandVerificationMessageResponse < SurgeAPI::Internal::Type::BaseModel
|
|
9
|
+
attr_accessor status: SurgeAPI::Models::CampaignResendBrandVerificationMessageResponse::status
|
|
10
|
+
|
|
11
|
+
def initialize: (
|
|
12
|
+
status: SurgeAPI::Models::CampaignResendBrandVerificationMessageResponse::status
|
|
13
|
+
) -> void
|
|
14
|
+
|
|
15
|
+
def to_hash: -> {
|
|
16
|
+
status: SurgeAPI::Models::CampaignResendBrandVerificationMessageResponse::status
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
type status = :enqueued
|
|
20
|
+
|
|
21
|
+
module Status
|
|
22
|
+
extend SurgeAPI::Internal::Type::Enum
|
|
23
|
+
|
|
24
|
+
ENQUEUED: :enqueued
|
|
25
|
+
|
|
26
|
+
def self?.values: -> ::Array[SurgeAPI::Models::CampaignResendBrandVerificationMessageResponse::status]
|
|
27
|
+
end
|
|
28
|
+
end
|
|
29
|
+
end
|
|
30
|
+
end
|
data/sig/surge_api/models.rbs
CHANGED
|
@@ -37,6 +37,8 @@ module SurgeAPI
|
|
|
37
37
|
|
|
38
38
|
module CampaignParams = SurgeAPI::Models::CampaignParams
|
|
39
39
|
|
|
40
|
+
class CampaignResendBrandVerificationMessageParams = SurgeAPI::Models::CampaignResendBrandVerificationMessageParams
|
|
41
|
+
|
|
40
42
|
class CampaignRetrieveParams = SurgeAPI::Models::CampaignRetrieveParams
|
|
41
43
|
|
|
42
44
|
class CampaignUpdateParams = SurgeAPI::Models::CampaignUpdateParams
|
|
@@ -25,6 +25,11 @@ module SurgeAPI
|
|
|
25
25
|
?request_options: SurgeAPI::request_opts
|
|
26
26
|
) -> SurgeAPI::Internal::Cursor[SurgeAPI::Campaign]
|
|
27
27
|
|
|
28
|
+
def resend_brand_verification_message: (
|
|
29
|
+
String account_id,
|
|
30
|
+
?request_options: SurgeAPI::request_opts
|
|
31
|
+
) -> SurgeAPI::Models::CampaignResendBrandVerificationMessageResponse
|
|
32
|
+
|
|
28
33
|
def initialize: (client: SurgeAPI::Client) -> void
|
|
29
34
|
end
|
|
30
35
|
end
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: surge_api
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.21.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Surge
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2026-07-
|
|
11
|
+
date: 2026-07-22 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: cgi
|
|
@@ -105,6 +105,8 @@ files:
|
|
|
105
105
|
- lib/surge_api/models/campaign_create_params.rb
|
|
106
106
|
- lib/surge_api/models/campaign_list_params.rb
|
|
107
107
|
- lib/surge_api/models/campaign_params.rb
|
|
108
|
+
- lib/surge_api/models/campaign_resend_brand_verification_message_params.rb
|
|
109
|
+
- lib/surge_api/models/campaign_resend_brand_verification_message_response.rb
|
|
108
110
|
- lib/surge_api/models/campaign_retrieve_params.rb
|
|
109
111
|
- lib/surge_api/models/campaign_update_params.rb
|
|
110
112
|
- lib/surge_api/models/contact.rb
|
|
@@ -216,6 +218,8 @@ files:
|
|
|
216
218
|
- rbi/surge_api/models/campaign_create_params.rbi
|
|
217
219
|
- rbi/surge_api/models/campaign_list_params.rbi
|
|
218
220
|
- rbi/surge_api/models/campaign_params.rbi
|
|
221
|
+
- rbi/surge_api/models/campaign_resend_brand_verification_message_params.rbi
|
|
222
|
+
- rbi/surge_api/models/campaign_resend_brand_verification_message_response.rbi
|
|
219
223
|
- rbi/surge_api/models/campaign_retrieve_params.rbi
|
|
220
224
|
- rbi/surge_api/models/campaign_update_params.rbi
|
|
221
225
|
- rbi/surge_api/models/contact.rbi
|
|
@@ -326,6 +330,8 @@ files:
|
|
|
326
330
|
- sig/surge_api/models/campaign_create_params.rbs
|
|
327
331
|
- sig/surge_api/models/campaign_list_params.rbs
|
|
328
332
|
- sig/surge_api/models/campaign_params.rbs
|
|
333
|
+
- sig/surge_api/models/campaign_resend_brand_verification_message_params.rbs
|
|
334
|
+
- sig/surge_api/models/campaign_resend_brand_verification_message_response.rbs
|
|
329
335
|
- sig/surge_api/models/campaign_retrieve_params.rbs
|
|
330
336
|
- sig/surge_api/models/campaign_update_params.rbs
|
|
331
337
|
- sig/surge_api/models/contact.rbs
|