surge_api 0.20.0 → 0.22.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 +18 -0
- data/README.md +1 -1
- data/lib/surge_api/models/account_retrieve_params.rb +22 -0
- data/lib/surge_api/models/campaign.rb +0 -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 +5 -0
- data/lib/surge_api/resources/accounts.rb +20 -0
- data/lib/surge_api/resources/campaigns.rb +20 -0
- data/lib/surge_api/version.rb +1 -1
- data/lib/surge_api.rb +3 -0
- data/rbi/surge_api/models/account_retrieve_params.rbi +40 -0
- data/rbi/surge_api/models/campaign.rbi +0 -1
- 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 +5 -0
- data/rbi/surge_api/resources/accounts.rbi +14 -0
- data/rbi/surge_api/resources/campaigns.rbi +16 -0
- data/sig/surge_api/models/account_retrieve_params.rbs +20 -0
- data/sig/surge_api/models/campaign.rbs +1 -3
- 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 +4 -0
- data/sig/surge_api/resources/accounts.rbs +5 -0
- data/sig/surge_api/resources/campaigns.rbs +5 -0
- metadata +11 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 81364bbceadc7ad152045b898442649e7b8b3207eefc535a0e8636d8bdb89ead
|
|
4
|
+
data.tar.gz: cca60516b813bfcbc472bf934a9a2bccc7754511cfa674e76dd28b6482994e04
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 96dfe4fc1d1abe42a82b4321e1ccdd93763beec2595feb89c7bbfdee1e0ba7bdfaf757c5246e5cce2f1febf6185f7e9eced094e215f6a53f64336eeca3d94640
|
|
7
|
+
data.tar.gz: 8c580d749e58ad608241186d4cadfc61265299314c3c9cbecca34ca80f4e3a1c726ea4a4c6364cb9e87702113680eacea3d692d2bf7099b93f5a14fbec83ecac
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,23 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 0.22.0 (2026-08-04)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v0.21.0...v0.22.0](https://github.com/surgeapi/ruby-sdk/compare/v0.21.0...v0.22.0)
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
* **api:** add get account endpoint ([011b8a3](https://github.com/surgeapi/ruby-sdk/commit/011b8a3c03d8cf5175e58944e5783ea7974a1188))
|
|
10
|
+
* **api:** remove campaign rejected status ([c5b66f9](https://github.com/surgeapi/ruby-sdk/commit/c5b66f919658888a3bb649c91cbb13252cd468ef))
|
|
11
|
+
|
|
12
|
+
## 0.21.0 (2026-07-22)
|
|
13
|
+
|
|
14
|
+
Full Changelog: [v0.20.0...v0.21.0](https://github.com/surgeapi/ruby-sdk/compare/v0.20.0...v0.21.0)
|
|
15
|
+
|
|
16
|
+
### Features
|
|
17
|
+
|
|
18
|
+
* **api:** add resend brand verification message endpoint ([49f208a](https://github.com/surgeapi/ruby-sdk/commit/49f208ae28574f1b7ef4993d5e9bc165ee7b0f79))
|
|
19
|
+
* **stlc:** configurable CI runner and private-production-repo support in workflow templates ([7d825e7](https://github.com/surgeapi/ruby-sdk/commit/7d825e74a607a569319c08d22c2fa87b3fe9efb0))
|
|
20
|
+
|
|
3
21
|
## 0.20.0 (2026-07-14)
|
|
4
22
|
|
|
5
23
|
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::Accounts#retrieve
|
|
6
|
+
class AccountRetrieveParams < SurgeAPI::Internal::Type::BaseModel
|
|
7
|
+
extend SurgeAPI::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include SurgeAPI::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!attribute id
|
|
11
|
+
# The ID of the account to retrieve.
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :id, String
|
|
15
|
+
|
|
16
|
+
# @!method initialize(id:, request_options: {})
|
|
17
|
+
# @param id [String] The ID of the account to retrieve.
|
|
18
|
+
#
|
|
19
|
+
# @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}]
|
|
20
|
+
end
|
|
21
|
+
end
|
|
22
|
+
end
|
|
@@ -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
|
@@ -47,6 +47,8 @@ module SurgeAPI
|
|
|
47
47
|
|
|
48
48
|
AccountListParams = SurgeAPI::Models::AccountListParams
|
|
49
49
|
|
|
50
|
+
AccountRetrieveParams = SurgeAPI::Models::AccountRetrieveParams
|
|
51
|
+
|
|
50
52
|
AccountRetrieveStatusParams = SurgeAPI::Models::AccountRetrieveStatusParams
|
|
51
53
|
|
|
52
54
|
AccountStatus = SurgeAPI::Models::AccountStatus
|
|
@@ -77,6 +79,9 @@ module SurgeAPI
|
|
|
77
79
|
|
|
78
80
|
CampaignParams = SurgeAPI::Models::CampaignParams
|
|
79
81
|
|
|
82
|
+
CampaignResendBrandVerificationMessageParams =
|
|
83
|
+
SurgeAPI::Models::CampaignResendBrandVerificationMessageParams
|
|
84
|
+
|
|
80
85
|
CampaignRetrieveParams = SurgeAPI::Models::CampaignRetrieveParams
|
|
81
86
|
|
|
82
87
|
CampaignUpdateParams = SurgeAPI::Models::CampaignUpdateParams
|
|
@@ -34,6 +34,26 @@ module SurgeAPI
|
|
|
34
34
|
)
|
|
35
35
|
end
|
|
36
36
|
|
|
37
|
+
# Retrieves an Account object.
|
|
38
|
+
#
|
|
39
|
+
# @overload retrieve(id, request_options: {})
|
|
40
|
+
#
|
|
41
|
+
# @param id [String] The ID of the account to retrieve.
|
|
42
|
+
#
|
|
43
|
+
# @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
44
|
+
#
|
|
45
|
+
# @return [SurgeAPI::Models::Account]
|
|
46
|
+
#
|
|
47
|
+
# @see SurgeAPI::Models::AccountRetrieveParams
|
|
48
|
+
def retrieve(id, params = {})
|
|
49
|
+
@client.request(
|
|
50
|
+
method: :get,
|
|
51
|
+
path: ["accounts/%1$s", id],
|
|
52
|
+
model: SurgeAPI::Account,
|
|
53
|
+
options: params[:request_options]
|
|
54
|
+
)
|
|
55
|
+
end
|
|
56
|
+
|
|
37
57
|
# Some parameter documentations has been truncated, see
|
|
38
58
|
# {SurgeAPI::Models::AccountUpdateParams} for more details.
|
|
39
59
|
#
|
|
@@ -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
|
@@ -60,6 +60,7 @@ require_relative "surge_api/models/account"
|
|
|
60
60
|
require_relative "surge_api/models/account_archive_params"
|
|
61
61
|
require_relative "surge_api/models/account_create_params"
|
|
62
62
|
require_relative "surge_api/models/account_list_params"
|
|
63
|
+
require_relative "surge_api/models/account_retrieve_params"
|
|
63
64
|
require_relative "surge_api/models/account_retrieve_status_params"
|
|
64
65
|
require_relative "surge_api/models/account_status"
|
|
65
66
|
require_relative "surge_api/models/account_update_params"
|
|
@@ -76,6 +77,8 @@ require_relative "surge_api/models/campaign"
|
|
|
76
77
|
require_relative "surge_api/models/campaign_approved_webhook_event"
|
|
77
78
|
require_relative "surge_api/models/campaign_create_params"
|
|
78
79
|
require_relative "surge_api/models/campaign_list_params"
|
|
80
|
+
require_relative "surge_api/models/campaign_resend_brand_verification_message_params"
|
|
81
|
+
require_relative "surge_api/models/campaign_resend_brand_verification_message_response"
|
|
79
82
|
require_relative "surge_api/models/campaign_retrieve_params"
|
|
80
83
|
require_relative "surge_api/models/campaign_update_params"
|
|
81
84
|
require_relative "surge_api/models/contact"
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# typed: strong
|
|
2
|
+
|
|
3
|
+
module SurgeAPI
|
|
4
|
+
module Models
|
|
5
|
+
class AccountRetrieveParams < 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(SurgeAPI::AccountRetrieveParams, SurgeAPI::Internal::AnyHash)
|
|
12
|
+
end
|
|
13
|
+
|
|
14
|
+
# The ID of the account to retrieve.
|
|
15
|
+
sig { returns(String) }
|
|
16
|
+
attr_accessor :id
|
|
17
|
+
|
|
18
|
+
sig do
|
|
19
|
+
params(
|
|
20
|
+
id: String,
|
|
21
|
+
request_options: SurgeAPI::RequestOptions::OrHash
|
|
22
|
+
).returns(T.attached_class)
|
|
23
|
+
end
|
|
24
|
+
def self.new(
|
|
25
|
+
# The ID of the account to retrieve.
|
|
26
|
+
id:,
|
|
27
|
+
request_options: {}
|
|
28
|
+
)
|
|
29
|
+
end
|
|
30
|
+
|
|
31
|
+
sig do
|
|
32
|
+
override.returns(
|
|
33
|
+
{ id: String, request_options: SurgeAPI::RequestOptions }
|
|
34
|
+
)
|
|
35
|
+
end
|
|
36
|
+
def to_hash
|
|
37
|
+
end
|
|
38
|
+
end
|
|
39
|
+
end
|
|
40
|
+
end
|
|
@@ -276,7 +276,6 @@ module SurgeAPI
|
|
|
276
276
|
DEACTIVATED =
|
|
277
277
|
T.let(:deactivated, SurgeAPI::Campaign::Status::TaggedSymbol)
|
|
278
278
|
IN_REVIEW = T.let(:in_review, SurgeAPI::Campaign::Status::TaggedSymbol)
|
|
279
|
-
REJECTED = T.let(:rejected, SurgeAPI::Campaign::Status::TaggedSymbol)
|
|
280
279
|
|
|
281
280
|
sig do
|
|
282
281
|
override.returns(T::Array[SurgeAPI::Campaign::Status::TaggedSymbol])
|
|
@@ -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
|
@@ -9,6 +9,8 @@ module SurgeAPI
|
|
|
9
9
|
|
|
10
10
|
AccountListParams = SurgeAPI::Models::AccountListParams
|
|
11
11
|
|
|
12
|
+
AccountRetrieveParams = SurgeAPI::Models::AccountRetrieveParams
|
|
13
|
+
|
|
12
14
|
AccountRetrieveStatusParams = SurgeAPI::Models::AccountRetrieveStatusParams
|
|
13
15
|
|
|
14
16
|
AccountStatus = SurgeAPI::Models::AccountStatus
|
|
@@ -39,6 +41,9 @@ module SurgeAPI
|
|
|
39
41
|
|
|
40
42
|
CampaignParams = SurgeAPI::Models::CampaignParams
|
|
41
43
|
|
|
44
|
+
CampaignResendBrandVerificationMessageParams =
|
|
45
|
+
SurgeAPI::Models::CampaignResendBrandVerificationMessageParams
|
|
46
|
+
|
|
42
47
|
CampaignRetrieveParams = SurgeAPI::Models::CampaignRetrieveParams
|
|
43
48
|
|
|
44
49
|
CampaignUpdateParams = SurgeAPI::Models::CampaignUpdateParams
|
|
@@ -33,6 +33,20 @@ module SurgeAPI
|
|
|
33
33
|
)
|
|
34
34
|
end
|
|
35
35
|
|
|
36
|
+
# Retrieves an Account object.
|
|
37
|
+
sig do
|
|
38
|
+
params(
|
|
39
|
+
id: String,
|
|
40
|
+
request_options: SurgeAPI::RequestOptions::OrHash
|
|
41
|
+
).returns(SurgeAPI::Account)
|
|
42
|
+
end
|
|
43
|
+
def retrieve(
|
|
44
|
+
# The ID of the account to retrieve.
|
|
45
|
+
id,
|
|
46
|
+
request_options: {}
|
|
47
|
+
)
|
|
48
|
+
end
|
|
49
|
+
|
|
36
50
|
# Updates an Account
|
|
37
51
|
sig do
|
|
38
52
|
params(
|
|
@@ -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,20 @@
|
|
|
1
|
+
module SurgeAPI
|
|
2
|
+
module Models
|
|
3
|
+
type account_retrieve_params =
|
|
4
|
+
{ id: String } & SurgeAPI::Internal::Type::request_parameters
|
|
5
|
+
|
|
6
|
+
class AccountRetrieveParams < SurgeAPI::Internal::Type::BaseModel
|
|
7
|
+
extend SurgeAPI::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include SurgeAPI::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
attr_accessor id: String
|
|
11
|
+
|
|
12
|
+
def initialize: (
|
|
13
|
+
id: String,
|
|
14
|
+
?request_options: SurgeAPI::request_opts
|
|
15
|
+
) -> void
|
|
16
|
+
|
|
17
|
+
def to_hash: -> { id: String, request_options: SurgeAPI::RequestOptions }
|
|
18
|
+
end
|
|
19
|
+
end
|
|
20
|
+
end
|
|
@@ -83,8 +83,7 @@ module SurgeAPI
|
|
|
83
83
|
def self?.values: -> ::Array[SurgeAPI::Models::Campaign::include_]
|
|
84
84
|
end
|
|
85
85
|
|
|
86
|
-
type status =
|
|
87
|
-
:active | :canceled | :created | :deactivated | :in_review | :rejected
|
|
86
|
+
type status = :active | :canceled | :created | :deactivated | :in_review
|
|
88
87
|
|
|
89
88
|
module Status
|
|
90
89
|
extend SurgeAPI::Internal::Type::Enum
|
|
@@ -94,7 +93,6 @@ module SurgeAPI
|
|
|
94
93
|
CREATED: :created
|
|
95
94
|
DEACTIVATED: :deactivated
|
|
96
95
|
IN_REVIEW: :in_review
|
|
97
|
-
REJECTED: :rejected
|
|
98
96
|
|
|
99
97
|
def self?.values: -> ::Array[SurgeAPI::Models::Campaign::status]
|
|
100
98
|
end
|
|
@@ -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
|
@@ -7,6 +7,8 @@ module SurgeAPI
|
|
|
7
7
|
|
|
8
8
|
class AccountListParams = SurgeAPI::Models::AccountListParams
|
|
9
9
|
|
|
10
|
+
class AccountRetrieveParams = SurgeAPI::Models::AccountRetrieveParams
|
|
11
|
+
|
|
10
12
|
class AccountRetrieveStatusParams = SurgeAPI::Models::AccountRetrieveStatusParams
|
|
11
13
|
|
|
12
14
|
class AccountStatus = SurgeAPI::Models::AccountStatus
|
|
@@ -37,6 +39,8 @@ module SurgeAPI
|
|
|
37
39
|
|
|
38
40
|
module CampaignParams = SurgeAPI::Models::CampaignParams
|
|
39
41
|
|
|
42
|
+
class CampaignResendBrandVerificationMessageParams = SurgeAPI::Models::CampaignResendBrandVerificationMessageParams
|
|
43
|
+
|
|
40
44
|
class CampaignRetrieveParams = SurgeAPI::Models::CampaignRetrieveParams
|
|
41
45
|
|
|
42
46
|
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.22.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-
|
|
11
|
+
date: 2026-08-04 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: cgi
|
|
@@ -88,6 +88,7 @@ files:
|
|
|
88
88
|
- lib/surge_api/models/account_archive_params.rb
|
|
89
89
|
- lib/surge_api/models/account_create_params.rb
|
|
90
90
|
- lib/surge_api/models/account_list_params.rb
|
|
91
|
+
- lib/surge_api/models/account_retrieve_params.rb
|
|
91
92
|
- lib/surge_api/models/account_retrieve_status_params.rb
|
|
92
93
|
- lib/surge_api/models/account_status.rb
|
|
93
94
|
- lib/surge_api/models/account_update_params.rb
|
|
@@ -105,6 +106,8 @@ files:
|
|
|
105
106
|
- lib/surge_api/models/campaign_create_params.rb
|
|
106
107
|
- lib/surge_api/models/campaign_list_params.rb
|
|
107
108
|
- lib/surge_api/models/campaign_params.rb
|
|
109
|
+
- lib/surge_api/models/campaign_resend_brand_verification_message_params.rb
|
|
110
|
+
- lib/surge_api/models/campaign_resend_brand_verification_message_response.rb
|
|
108
111
|
- lib/surge_api/models/campaign_retrieve_params.rb
|
|
109
112
|
- lib/surge_api/models/campaign_update_params.rb
|
|
110
113
|
- lib/surge_api/models/contact.rb
|
|
@@ -199,6 +202,7 @@ files:
|
|
|
199
202
|
- rbi/surge_api/models/account_archive_params.rbi
|
|
200
203
|
- rbi/surge_api/models/account_create_params.rbi
|
|
201
204
|
- rbi/surge_api/models/account_list_params.rbi
|
|
205
|
+
- rbi/surge_api/models/account_retrieve_params.rbi
|
|
202
206
|
- rbi/surge_api/models/account_retrieve_status_params.rbi
|
|
203
207
|
- rbi/surge_api/models/account_status.rbi
|
|
204
208
|
- rbi/surge_api/models/account_update_params.rbi
|
|
@@ -216,6 +220,8 @@ files:
|
|
|
216
220
|
- rbi/surge_api/models/campaign_create_params.rbi
|
|
217
221
|
- rbi/surge_api/models/campaign_list_params.rbi
|
|
218
222
|
- rbi/surge_api/models/campaign_params.rbi
|
|
223
|
+
- rbi/surge_api/models/campaign_resend_brand_verification_message_params.rbi
|
|
224
|
+
- rbi/surge_api/models/campaign_resend_brand_verification_message_response.rbi
|
|
219
225
|
- rbi/surge_api/models/campaign_retrieve_params.rbi
|
|
220
226
|
- rbi/surge_api/models/campaign_update_params.rbi
|
|
221
227
|
- rbi/surge_api/models/contact.rbi
|
|
@@ -309,6 +315,7 @@ files:
|
|
|
309
315
|
- sig/surge_api/models/account_archive_params.rbs
|
|
310
316
|
- sig/surge_api/models/account_create_params.rbs
|
|
311
317
|
- sig/surge_api/models/account_list_params.rbs
|
|
318
|
+
- sig/surge_api/models/account_retrieve_params.rbs
|
|
312
319
|
- sig/surge_api/models/account_retrieve_status_params.rbs
|
|
313
320
|
- sig/surge_api/models/account_status.rbs
|
|
314
321
|
- sig/surge_api/models/account_update_params.rbs
|
|
@@ -326,6 +333,8 @@ files:
|
|
|
326
333
|
- sig/surge_api/models/campaign_create_params.rbs
|
|
327
334
|
- sig/surge_api/models/campaign_list_params.rbs
|
|
328
335
|
- sig/surge_api/models/campaign_params.rbs
|
|
336
|
+
- sig/surge_api/models/campaign_resend_brand_verification_message_params.rbs
|
|
337
|
+
- sig/surge_api/models/campaign_resend_brand_verification_message_response.rbs
|
|
329
338
|
- sig/surge_api/models/campaign_retrieve_params.rbs
|
|
330
339
|
- sig/surge_api/models/campaign_update_params.rbs
|
|
331
340
|
- sig/surge_api/models/contact.rbs
|