zernio-sdk 0.0.543 → 0.0.545
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/README.md +53 -4
- data/docs/AdAudiencesApi.md +5 -5
- data/docs/AdCampaignsApi.md +142 -0
- data/docs/AdsApi.md +795 -37
- data/docs/CreateAdCampaign201Response.md +24 -0
- data/docs/CreateAdCampaignRequest.md +32 -0
- data/docs/CreateAdCreative201Response.md +20 -0
- data/docs/CreateAdCreativeRequest.md +40 -0
- data/docs/CreateAdCreativeRequestCarouselCardsInner.md +26 -0
- data/docs/CreateSmsSenderId200Response.md +22 -0
- data/docs/CreateSmsSenderIdRequest.md +18 -0
- data/docs/CreateStandaloneAd200Response.md +22 -0
- data/docs/CreateStandaloneAd200ResponseResultsInner.md +22 -0
- data/docs/CreateStandaloneAdRequest.md +4 -0
- data/docs/DeleteAdCreative200Response.md +20 -0
- data/docs/DeleteSmsSenderId200Response.md +18 -0
- data/docs/DiscordApi.md +153 -1
- data/docs/{ListDiscordGuildMembers200ResponseDataInner.md → DiscordGuildMember.md} +3 -3
- data/docs/{ListDiscordGuildMembers200ResponseDataInnerUser.md → DiscordGuildMemberUser.md} +2 -2
- data/docs/DuplicateAd200Response.md +22 -0
- data/docs/DuplicateAdRequest.md +28 -0
- data/docs/DuplicateAdSet200Response.md +22 -0
- data/docs/DuplicateAdSetRequest.md +36 -0
- data/docs/GetAdCreative200Response.md +18 -0
- data/docs/GetDiscordGuildMember200Response.md +18 -0
- data/docs/ListAdCreatives200Response.md +22 -0
- data/docs/ListAdImages200Response.md +22 -0
- data/docs/ListAdLabels200Response.md +22 -0
- data/docs/ListDiscordGuildMembers200Response.md +1 -1
- data/docs/ListHighDemandPeriods200Response.md +22 -0
- data/docs/ListMetaBusinesses200Response.md +20 -0
- data/docs/ListSmsSenderIds200Response.md +20 -0
- data/docs/ListSmsSenderIds200ResponseBudget.md +24 -0
- data/docs/ListSmsSenderIds200ResponseBudgetPendingRequest.md +22 -0
- data/docs/ListSmsSenderIds200ResponseSenderIdsInner.md +24 -0
- data/docs/RequestSmsSenderIdLimitIncrease200Response.md +20 -0
- data/docs/RequestSmsSenderIdLimitIncreaseRequest.md +20 -0
- data/docs/SMSApi.md +275 -0
- data/docs/SearchDiscordGuildMembers200Response.md +18 -0
- data/docs/UpdateAdCreative200Response.md +22 -0
- data/docs/UpdateAdCreativeRequest.md +20 -0
- data/docs/WhatsAppApi.md +72 -0
- data/lib/zernio-sdk/api/ad_audiences_api.rb +4 -4
- data/lib/zernio-sdk/api/ad_campaigns_api.rb +142 -0
- data/lib/zernio-sdk/api/ads_api.rb +829 -51
- data/lib/zernio-sdk/api/discord_api.rb +174 -2
- data/lib/zernio-sdk/api/sms_api.rb +254 -0
- data/lib/zernio-sdk/api/whats_app_api.rb +70 -0
- data/lib/zernio-sdk/models/create_ad_campaign201_response.rb +210 -0
- data/lib/zernio-sdk/models/create_ad_campaign_request.rb +343 -0
- data/lib/zernio-sdk/models/create_ad_creative201_response.rb +157 -0
- data/lib/zernio-sdk/models/create_ad_creative_request.rb +424 -0
- data/lib/zernio-sdk/models/create_ad_creative_request_carousel_cards_inner.rb +255 -0
- data/lib/zernio-sdk/models/create_sms_sender_id200_response.rb +166 -0
- data/lib/zernio-sdk/models/create_sms_sender_id_request.rb +183 -0
- data/lib/zernio-sdk/models/create_standalone_ad200_response.rb +201 -0
- data/lib/zernio-sdk/models/create_standalone_ad200_response_results_inner.rb +212 -0
- data/lib/zernio-sdk/models/create_standalone_ad_request.rb +23 -1
- data/lib/zernio-sdk/models/delete_ad_creative200_response.rb +156 -0
- data/lib/zernio-sdk/models/delete_sms_sender_id200_response.rb +147 -0
- data/lib/zernio-sdk/models/{list_discord_guild_members200_response_data_inner.rb → discord_guild_member.rb} +5 -4
- data/lib/zernio-sdk/models/{list_discord_guild_members200_response_data_inner_user.rb → discord_guild_member_user.rb} +3 -3
- data/lib/zernio-sdk/models/duplicate_ad200_response.rb +200 -0
- data/lib/zernio-sdk/models/duplicate_ad_request.rb +243 -0
- data/lib/zernio-sdk/models/duplicate_ad_set200_response.rb +201 -0
- data/lib/zernio-sdk/models/duplicate_ad_set_request.rb +302 -0
- data/lib/zernio-sdk/models/get_ad_creative200_response.rb +148 -0
- data/lib/zernio-sdk/models/get_discord_guild_member200_response.rb +147 -0
- data/lib/zernio-sdk/models/list_ad_creatives200_response.rb +167 -0
- data/lib/zernio-sdk/models/list_ad_images200_response.rb +167 -0
- data/lib/zernio-sdk/models/list_ad_labels200_response.rb +167 -0
- data/lib/zernio-sdk/models/list_discord_guild_members200_response.rb +1 -1
- data/lib/zernio-sdk/models/list_high_demand_periods200_response.rb +168 -0
- data/lib/zernio-sdk/models/list_meta_businesses200_response.rb +158 -0
- data/lib/zernio-sdk/models/list_sms_sender_ids200_response.rb +158 -0
- data/lib/zernio-sdk/models/list_sms_sender_ids200_response_budget.rb +178 -0
- data/lib/zernio-sdk/models/list_sms_sender_ids200_response_budget_pending_request.rb +167 -0
- data/lib/zernio-sdk/models/list_sms_sender_ids200_response_sender_ids_inner.rb +175 -0
- data/lib/zernio-sdk/models/request_sms_sender_id_limit_increase200_response.rb +156 -0
- data/lib/zernio-sdk/models/request_sms_sender_id_limit_increase_request.rb +210 -0
- data/lib/zernio-sdk/models/search_discord_guild_members200_response.rb +149 -0
- data/lib/zernio-sdk/models/update_ad_creative200_response.rb +165 -0
- data/lib/zernio-sdk/models/update_ad_creative_request.rb +200 -0
- data/lib/zernio-sdk/version.rb +1 -1
- data/lib/zernio-sdk.rb +33 -3
- data/openapi.yaml +741 -28
- data/spec/api/ad_audiences_api_spec.rb +2 -2
- data/spec/api/ad_campaigns_api_spec.rb +25 -0
- data/spec/api/ads_api_spec.rb +143 -1
- data/spec/api/discord_api_spec.rb +30 -1
- data/spec/api/sms_api_spec.rb +46 -0
- data/spec/api/whats_app_api_spec.rb +13 -0
- data/spec/models/create_ad_campaign201_response_spec.rb +58 -0
- data/spec/models/create_ad_campaign_request_spec.rb +94 -0
- data/spec/models/create_ad_creative201_response_spec.rb +42 -0
- data/spec/models/create_ad_creative_request_carousel_cards_inner_spec.rb +60 -0
- data/spec/models/create_ad_creative_request_spec.rb +106 -0
- data/spec/models/create_sms_sender_id200_response_spec.rb +48 -0
- data/spec/models/create_sms_sender_id_request_spec.rb +36 -0
- data/spec/models/create_standalone_ad200_response_results_inner_spec.rb +56 -0
- data/spec/models/create_standalone_ad200_response_spec.rb +52 -0
- data/spec/models/create_standalone_ad_request_spec.rb +16 -0
- data/spec/models/delete_ad_creative200_response_spec.rb +42 -0
- data/spec/models/delete_sms_sender_id200_response_spec.rb +36 -0
- data/spec/models/{list_discord_guild_members200_response_data_inner_spec.rb → discord_guild_member_spec.rb} +6 -6
- data/spec/models/{list_discord_guild_members200_response_data_inner_user_spec.rb → discord_guild_member_user_spec.rb} +6 -6
- data/spec/models/duplicate_ad200_response_spec.rb +52 -0
- data/spec/models/duplicate_ad_request_spec.rb +74 -0
- data/spec/models/duplicate_ad_set200_response_spec.rb +52 -0
- data/spec/models/duplicate_ad_set_request_spec.rb +102 -0
- data/spec/models/get_ad_creative200_response_spec.rb +36 -0
- data/spec/models/get_discord_guild_member200_response_spec.rb +36 -0
- data/spec/models/list_ad_creatives200_response_spec.rb +48 -0
- data/spec/models/list_ad_images200_response_spec.rb +48 -0
- data/spec/models/list_ad_labels200_response_spec.rb +48 -0
- data/spec/models/list_high_demand_periods200_response_spec.rb +48 -0
- data/spec/models/list_meta_businesses200_response_spec.rb +42 -0
- data/spec/models/list_sms_sender_ids200_response_budget_pending_request_spec.rb +48 -0
- data/spec/models/list_sms_sender_ids200_response_budget_spec.rb +54 -0
- data/spec/models/list_sms_sender_ids200_response_sender_ids_inner_spec.rb +54 -0
- data/spec/models/list_sms_sender_ids200_response_spec.rb +42 -0
- data/spec/models/request_sms_sender_id_limit_increase200_response_spec.rb +42 -0
- data/spec/models/request_sms_sender_id_limit_increase_request_spec.rb +42 -0
- data/spec/models/search_discord_guild_members200_response_spec.rb +36 -0
- data/spec/models/update_ad_creative200_response_spec.rb +48 -0
- data/spec/models/update_ad_creative_request_spec.rb +42 -0
- metadata +133 -13
- data/docs/InboxApi.md +0 -79
- data/lib/zernio-sdk/api/inbox_api.rb +0 -92
- data/spec/api/inbox_api_spec.rb +0 -48
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Zernio::ListAdCreatives200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **ad_account_id** | **String** | | [optional] |
|
|
8
|
+
| **data** | **Array<Object>** | | [optional] |
|
|
9
|
+
| **paging** | [**QueryAdInsights200ResponsePaging**](QueryAdInsights200ResponsePaging.md) | | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'zernio-sdk'
|
|
15
|
+
|
|
16
|
+
instance = Zernio::ListAdCreatives200Response.new(
|
|
17
|
+
ad_account_id: null,
|
|
18
|
+
data: null,
|
|
19
|
+
paging: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Zernio::ListAdImages200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **ad_account_id** | **String** | | [optional] |
|
|
8
|
+
| **data** | **Array<Object>** | | [optional] |
|
|
9
|
+
| **paging** | [**QueryAdInsights200ResponsePaging**](QueryAdInsights200ResponsePaging.md) | | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'zernio-sdk'
|
|
15
|
+
|
|
16
|
+
instance = Zernio::ListAdImages200Response.new(
|
|
17
|
+
ad_account_id: null,
|
|
18
|
+
data: null,
|
|
19
|
+
paging: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Zernio::ListAdLabels200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **ad_account_id** | **String** | | [optional] |
|
|
8
|
+
| **data** | **Array<Object>** | | [optional] |
|
|
9
|
+
| **paging** | [**QueryAdInsights200ResponsePaging**](QueryAdInsights200ResponsePaging.md) | | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'zernio-sdk'
|
|
15
|
+
|
|
16
|
+
instance = Zernio::ListAdLabels200Response.new(
|
|
17
|
+
ad_account_id: null,
|
|
18
|
+
data: null,
|
|
19
|
+
paging: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **data** | [**Array<
|
|
7
|
+
| **data** | [**Array<DiscordGuildMember>**](DiscordGuildMember.md) | | [optional] |
|
|
8
8
|
| **pagination** | [**ListDiscordGuildMembers200ResponsePagination**](ListDiscordGuildMembers200ResponsePagination.md) | | [optional] |
|
|
9
9
|
|
|
10
10
|
## Example
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Zernio::ListHighDemandPeriods200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **object_id** | **String** | The campaign / ad set id the schedules belong to. | [optional] |
|
|
8
|
+
| **data** | **Array<Object>** | | [optional] |
|
|
9
|
+
| **paging** | [**QueryAdInsights200ResponsePaging**](QueryAdInsights200ResponsePaging.md) | | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'zernio-sdk'
|
|
15
|
+
|
|
16
|
+
instance = Zernio::ListHighDemandPeriods200Response.new(
|
|
17
|
+
object_id: null,
|
|
18
|
+
data: null,
|
|
19
|
+
paging: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Zernio::ListMetaBusinesses200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **data** | **Array<Object>** | | [optional] |
|
|
8
|
+
| **paging** | [**QueryAdInsights200ResponsePaging**](QueryAdInsights200ResponsePaging.md) | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'zernio-sdk'
|
|
14
|
+
|
|
15
|
+
instance = Zernio::ListMetaBusinesses200Response.new(
|
|
16
|
+
data: null,
|
|
17
|
+
paging: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Zernio::ListSmsSenderIds200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **sender_ids** | [**Array<ListSmsSenderIds200ResponseSenderIdsInner>**](ListSmsSenderIds200ResponseSenderIdsInner.md) | | [optional] |
|
|
8
|
+
| **budget** | [**ListSmsSenderIds200ResponseBudget**](ListSmsSenderIds200ResponseBudget.md) | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'zernio-sdk'
|
|
14
|
+
|
|
15
|
+
instance = Zernio::ListSmsSenderIds200Response.new(
|
|
16
|
+
sender_ids: null,
|
|
17
|
+
budget: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# Zernio::ListSmsSenderIds200ResponseBudget
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **cap** | **Integer** | Daily message cap (raisable via `/v1/sms/sender-ids/limit-request`). | [optional] |
|
|
8
|
+
| **used_today** | **Integer** | Messages already counted against today's cap. | [optional] |
|
|
9
|
+
| **level** | **Integer** | Cap tier (Level 1 = 500/day). | [optional] |
|
|
10
|
+
| **pending_request** | [**ListSmsSenderIds200ResponseBudgetPendingRequest**](ListSmsSenderIds200ResponseBudgetPendingRequest.md) | | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'zernio-sdk'
|
|
16
|
+
|
|
17
|
+
instance = Zernio::ListSmsSenderIds200ResponseBudget.new(
|
|
18
|
+
cap: null,
|
|
19
|
+
used_today: null,
|
|
20
|
+
level: null,
|
|
21
|
+
pending_request: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Zernio::ListSmsSenderIds200ResponseBudgetPendingRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **requested_cap** | **Integer** | | [optional] |
|
|
8
|
+
| **level** | **Integer** | | [optional] |
|
|
9
|
+
| **requested_at** | **Time** | | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'zernio-sdk'
|
|
15
|
+
|
|
16
|
+
instance = Zernio::ListSmsSenderIds200ResponseBudgetPendingRequest.new(
|
|
17
|
+
requested_cap: null,
|
|
18
|
+
level: null,
|
|
19
|
+
requested_at: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# Zernio::ListSmsSenderIds200ResponseSenderIdsInner
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | | [optional] |
|
|
8
|
+
| **sender_id** | **String** | | [optional] |
|
|
9
|
+
| **is_active** | **Boolean** | | [optional] |
|
|
10
|
+
| **created_at** | **Time** | | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'zernio-sdk'
|
|
16
|
+
|
|
17
|
+
instance = Zernio::ListSmsSenderIds200ResponseSenderIdsInner.new(
|
|
18
|
+
id: null,
|
|
19
|
+
sender_id: null,
|
|
20
|
+
is_active: null,
|
|
21
|
+
created_at: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Zernio::RequestSmsSenderIdLimitIncrease200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **requested** | **Boolean** | | [optional] |
|
|
8
|
+
| **requested_cap** | **Integer** | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'zernio-sdk'
|
|
14
|
+
|
|
15
|
+
instance = Zernio::RequestSmsSenderIdLimitIncrease200Response.new(
|
|
16
|
+
requested: null,
|
|
17
|
+
requested_cap: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Zernio::RequestSmsSenderIdLimitIncreaseRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **requested_cap** | **Integer** | Desired daily message cap. Must exceed the current cap. | |
|
|
8
|
+
| **reason** | **String** | Use case and audience (what you send, to whom, opt-in status). | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'zernio-sdk'
|
|
14
|
+
|
|
15
|
+
instance = Zernio::RequestSmsSenderIdLimitIncreaseRequest.new(
|
|
16
|
+
requested_cap: null,
|
|
17
|
+
reason: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
data/docs/SMSApi.md
CHANGED
|
@@ -5,13 +5,17 @@ All URIs are relative to *https://zernio.com/api*
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
7
|
| [**appeal_sms_registration**](SMSApi.md#appeal_sms_registration) | **POST** /v1/sms/registrations/{id}/appeal | Appeal a rejected campaign |
|
|
8
|
+
| [**create_sms_sender_id**](SMSApi.md#create_sms_sender_id) | **POST** /v1/sms/sender-ids | Create an alphanumeric sender ID |
|
|
8
9
|
| [**deactivate_sms_registration**](SMSApi.md#deactivate_sms_registration) | **DELETE** /v1/sms/registrations/{id} | Deactivate a brand/campaign registration |
|
|
10
|
+
| [**delete_sms_sender_id**](SMSApi.md#delete_sms_sender_id) | **DELETE** /v1/sms/sender-ids/{id} | Delete an alphanumeric sender ID |
|
|
9
11
|
| [**disable_sms_on_number**](SMSApi.md#disable_sms_on_number) | **DELETE** /v1/phone-numbers/{id}/sms | Disable SMS on a number |
|
|
10
12
|
| [**enable_sms_on_number**](SMSApi.md#enable_sms_on_number) | **POST** /v1/phone-numbers/{id}/sms | Enable SMS on a number |
|
|
11
13
|
| [**get_sms_registration**](SMSApi.md#get_sms_registration) | **GET** /v1/sms/registrations/{id} | Get a carrier registration |
|
|
12
14
|
| [**list_sms_opt_outs**](SMSApi.md#list_sms_opt_outs) | **GET** /v1/sms/opt-outs | List SMS opt-outs |
|
|
13
15
|
| [**list_sms_registrations**](SMSApi.md#list_sms_registrations) | **GET** /v1/sms/registrations | List carrier registrations |
|
|
16
|
+
| [**list_sms_sender_ids**](SMSApi.md#list_sms_sender_ids) | **GET** /v1/sms/sender-ids | List alphanumeric sender IDs |
|
|
14
17
|
| [**lookup_sms_number**](SMSApi.md#lookup_sms_number) | **GET** /v1/sms/lookup | Look up carrier + line type |
|
|
18
|
+
| [**request_sms_sender_id_limit_increase**](SMSApi.md#request_sms_sender_id_limit_increase) | **POST** /v1/sms/sender-ids/limit-request | Request a higher sender ID daily limit |
|
|
15
19
|
| [**resend_sms_registration_otp**](SMSApi.md#resend_sms_registration_otp) | **POST** /v1/sms/registrations/{id}/resend-otp | Re-send the sole-prop OTP |
|
|
16
20
|
| [**reuse_sms_registration_for_number**](SMSApi.md#reuse_sms_registration_for_number) | **POST** /v1/phone-numbers/{id}/sms/reuse-registration | Add number to SMS registration |
|
|
17
21
|
| [**send_sms**](SMSApi.md#send_sms) | **POST** /v1/sms/messages | Send an SMS/MMS |
|
|
@@ -93,6 +97,75 @@ end
|
|
|
93
97
|
- **Accept**: application/json
|
|
94
98
|
|
|
95
99
|
|
|
100
|
+
## create_sms_sender_id
|
|
101
|
+
|
|
102
|
+
> <CreateSmsSenderId200Response> create_sms_sender_id(create_sms_sender_id_request)
|
|
103
|
+
|
|
104
|
+
Create an alphanumeric sender ID
|
|
105
|
+
|
|
106
|
+
Registers an alphanumeric sender ID (e.g. `ZERNIO`) — a branded `from` for one-way international SMS. No phone number purchase or carrier registration is needed; once created, pass it as `from` on `POST /v1/sms/messages`. Constraints: 3-11 characters (letters, digits, spaces; at least one letter). Sends cannot reach the US, Canada, or Puerto Rico, are text-only, and recipients cannot reply. Sender IDs that impersonate well-known brands or institutions are rejected, and an ID already registered by another workspace returns 409 (active sender IDs are globally unique, first-come-first-served). Creating the same sender ID again is a no-op (re-activates it after a delete).
|
|
107
|
+
|
|
108
|
+
### Examples
|
|
109
|
+
|
|
110
|
+
```ruby
|
|
111
|
+
require 'time'
|
|
112
|
+
require 'zernio-sdk'
|
|
113
|
+
# setup authorization
|
|
114
|
+
Zernio.configure do |config|
|
|
115
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
116
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
117
|
+
end
|
|
118
|
+
|
|
119
|
+
api_instance = Zernio::SMSApi.new
|
|
120
|
+
create_sms_sender_id_request = Zernio::CreateSmsSenderIdRequest.new({sender_id: 'sender_id_example'}) # CreateSmsSenderIdRequest |
|
|
121
|
+
|
|
122
|
+
begin
|
|
123
|
+
# Create an alphanumeric sender ID
|
|
124
|
+
result = api_instance.create_sms_sender_id(create_sms_sender_id_request)
|
|
125
|
+
p result
|
|
126
|
+
rescue Zernio::ApiError => e
|
|
127
|
+
puts "Error when calling SMSApi->create_sms_sender_id: #{e}"
|
|
128
|
+
end
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
#### Using the create_sms_sender_id_with_http_info variant
|
|
132
|
+
|
|
133
|
+
This returns an Array which contains the response data, status code and headers.
|
|
134
|
+
|
|
135
|
+
> <Array(<CreateSmsSenderId200Response>, Integer, Hash)> create_sms_sender_id_with_http_info(create_sms_sender_id_request)
|
|
136
|
+
|
|
137
|
+
```ruby
|
|
138
|
+
begin
|
|
139
|
+
# Create an alphanumeric sender ID
|
|
140
|
+
data, status_code, headers = api_instance.create_sms_sender_id_with_http_info(create_sms_sender_id_request)
|
|
141
|
+
p status_code # => 2xx
|
|
142
|
+
p headers # => { ... }
|
|
143
|
+
p data # => <CreateSmsSenderId200Response>
|
|
144
|
+
rescue Zernio::ApiError => e
|
|
145
|
+
puts "Error when calling SMSApi->create_sms_sender_id_with_http_info: #{e}"
|
|
146
|
+
end
|
|
147
|
+
```
|
|
148
|
+
|
|
149
|
+
### Parameters
|
|
150
|
+
|
|
151
|
+
| Name | Type | Description | Notes |
|
|
152
|
+
| ---- | ---- | ----------- | ----- |
|
|
153
|
+
| **create_sms_sender_id_request** | [**CreateSmsSenderIdRequest**](CreateSmsSenderIdRequest.md) | | |
|
|
154
|
+
|
|
155
|
+
### Return type
|
|
156
|
+
|
|
157
|
+
[**CreateSmsSenderId200Response**](CreateSmsSenderId200Response.md)
|
|
158
|
+
|
|
159
|
+
### Authorization
|
|
160
|
+
|
|
161
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
162
|
+
|
|
163
|
+
### HTTP request headers
|
|
164
|
+
|
|
165
|
+
- **Content-Type**: application/json
|
|
166
|
+
- **Accept**: application/json
|
|
167
|
+
|
|
168
|
+
|
|
96
169
|
## deactivate_sms_registration
|
|
97
170
|
|
|
98
171
|
> <DeactivateSmsRegistration200Response> deactivate_sms_registration(id)
|
|
@@ -162,6 +235,75 @@ end
|
|
|
162
235
|
- **Accept**: application/json
|
|
163
236
|
|
|
164
237
|
|
|
238
|
+
## delete_sms_sender_id
|
|
239
|
+
|
|
240
|
+
> <DeleteSmsSenderId200Response> delete_sms_sender_id(id)
|
|
241
|
+
|
|
242
|
+
Delete an alphanumeric sender ID
|
|
243
|
+
|
|
244
|
+
Deactivates the sender ID so it can no longer send. Re-creating the same sender ID via `POST /v1/sms/sender-ids` re-activates it.
|
|
245
|
+
|
|
246
|
+
### Examples
|
|
247
|
+
|
|
248
|
+
```ruby
|
|
249
|
+
require 'time'
|
|
250
|
+
require 'zernio-sdk'
|
|
251
|
+
# setup authorization
|
|
252
|
+
Zernio.configure do |config|
|
|
253
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
254
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
255
|
+
end
|
|
256
|
+
|
|
257
|
+
api_instance = Zernio::SMSApi.new
|
|
258
|
+
id = 'id_example' # String | Sender ID resource id.
|
|
259
|
+
|
|
260
|
+
begin
|
|
261
|
+
# Delete an alphanumeric sender ID
|
|
262
|
+
result = api_instance.delete_sms_sender_id(id)
|
|
263
|
+
p result
|
|
264
|
+
rescue Zernio::ApiError => e
|
|
265
|
+
puts "Error when calling SMSApi->delete_sms_sender_id: #{e}"
|
|
266
|
+
end
|
|
267
|
+
```
|
|
268
|
+
|
|
269
|
+
#### Using the delete_sms_sender_id_with_http_info variant
|
|
270
|
+
|
|
271
|
+
This returns an Array which contains the response data, status code and headers.
|
|
272
|
+
|
|
273
|
+
> <Array(<DeleteSmsSenderId200Response>, Integer, Hash)> delete_sms_sender_id_with_http_info(id)
|
|
274
|
+
|
|
275
|
+
```ruby
|
|
276
|
+
begin
|
|
277
|
+
# Delete an alphanumeric sender ID
|
|
278
|
+
data, status_code, headers = api_instance.delete_sms_sender_id_with_http_info(id)
|
|
279
|
+
p status_code # => 2xx
|
|
280
|
+
p headers # => { ... }
|
|
281
|
+
p data # => <DeleteSmsSenderId200Response>
|
|
282
|
+
rescue Zernio::ApiError => e
|
|
283
|
+
puts "Error when calling SMSApi->delete_sms_sender_id_with_http_info: #{e}"
|
|
284
|
+
end
|
|
285
|
+
```
|
|
286
|
+
|
|
287
|
+
### Parameters
|
|
288
|
+
|
|
289
|
+
| Name | Type | Description | Notes |
|
|
290
|
+
| ---- | ---- | ----------- | ----- |
|
|
291
|
+
| **id** | **String** | Sender ID resource id. | |
|
|
292
|
+
|
|
293
|
+
### Return type
|
|
294
|
+
|
|
295
|
+
[**DeleteSmsSenderId200Response**](DeleteSmsSenderId200Response.md)
|
|
296
|
+
|
|
297
|
+
### Authorization
|
|
298
|
+
|
|
299
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
300
|
+
|
|
301
|
+
### HTTP request headers
|
|
302
|
+
|
|
303
|
+
- **Content-Type**: Not defined
|
|
304
|
+
- **Accept**: application/json
|
|
305
|
+
|
|
306
|
+
|
|
165
307
|
## disable_sms_on_number
|
|
166
308
|
|
|
167
309
|
> <DisableSmsOnNumber200Response> disable_sms_on_number(id)
|
|
@@ -511,6 +653,70 @@ end
|
|
|
511
653
|
- **Accept**: application/json
|
|
512
654
|
|
|
513
655
|
|
|
656
|
+
## list_sms_sender_ids
|
|
657
|
+
|
|
658
|
+
> <ListSmsSenderIds200Response> list_sms_sender_ids
|
|
659
|
+
|
|
660
|
+
List alphanumeric sender IDs
|
|
661
|
+
|
|
662
|
+
### Examples
|
|
663
|
+
|
|
664
|
+
```ruby
|
|
665
|
+
require 'time'
|
|
666
|
+
require 'zernio-sdk'
|
|
667
|
+
# setup authorization
|
|
668
|
+
Zernio.configure do |config|
|
|
669
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
670
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
671
|
+
end
|
|
672
|
+
|
|
673
|
+
api_instance = Zernio::SMSApi.new
|
|
674
|
+
|
|
675
|
+
begin
|
|
676
|
+
# List alphanumeric sender IDs
|
|
677
|
+
result = api_instance.list_sms_sender_ids
|
|
678
|
+
p result
|
|
679
|
+
rescue Zernio::ApiError => e
|
|
680
|
+
puts "Error when calling SMSApi->list_sms_sender_ids: #{e}"
|
|
681
|
+
end
|
|
682
|
+
```
|
|
683
|
+
|
|
684
|
+
#### Using the list_sms_sender_ids_with_http_info variant
|
|
685
|
+
|
|
686
|
+
This returns an Array which contains the response data, status code and headers.
|
|
687
|
+
|
|
688
|
+
> <Array(<ListSmsSenderIds200Response>, Integer, Hash)> list_sms_sender_ids_with_http_info
|
|
689
|
+
|
|
690
|
+
```ruby
|
|
691
|
+
begin
|
|
692
|
+
# List alphanumeric sender IDs
|
|
693
|
+
data, status_code, headers = api_instance.list_sms_sender_ids_with_http_info
|
|
694
|
+
p status_code # => 2xx
|
|
695
|
+
p headers # => { ... }
|
|
696
|
+
p data # => <ListSmsSenderIds200Response>
|
|
697
|
+
rescue Zernio::ApiError => e
|
|
698
|
+
puts "Error when calling SMSApi->list_sms_sender_ids_with_http_info: #{e}"
|
|
699
|
+
end
|
|
700
|
+
```
|
|
701
|
+
|
|
702
|
+
### Parameters
|
|
703
|
+
|
|
704
|
+
This endpoint does not need any parameter.
|
|
705
|
+
|
|
706
|
+
### Return type
|
|
707
|
+
|
|
708
|
+
[**ListSmsSenderIds200Response**](ListSmsSenderIds200Response.md)
|
|
709
|
+
|
|
710
|
+
### Authorization
|
|
711
|
+
|
|
712
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
713
|
+
|
|
714
|
+
### HTTP request headers
|
|
715
|
+
|
|
716
|
+
- **Content-Type**: Not defined
|
|
717
|
+
- **Accept**: application/json
|
|
718
|
+
|
|
719
|
+
|
|
514
720
|
## lookup_sms_number
|
|
515
721
|
|
|
516
722
|
> <LookupSmsNumber200Response> lookup_sms_number(number)
|
|
@@ -580,6 +786,75 @@ end
|
|
|
580
786
|
- **Accept**: application/json
|
|
581
787
|
|
|
582
788
|
|
|
789
|
+
## request_sms_sender_id_limit_increase
|
|
790
|
+
|
|
791
|
+
> <RequestSmsSenderIdLimitIncrease200Response> request_sms_sender_id_limit_increase(request_sms_sender_id_limit_increase_request)
|
|
792
|
+
|
|
793
|
+
Request a higher sender ID daily limit
|
|
794
|
+
|
|
795
|
+
Asks support to raise the workspace's daily sender-ID message cap. There is no self-serve raise: the request (desired cap + use case) is reviewed manually, usually within a business day.
|
|
796
|
+
|
|
797
|
+
### Examples
|
|
798
|
+
|
|
799
|
+
```ruby
|
|
800
|
+
require 'time'
|
|
801
|
+
require 'zernio-sdk'
|
|
802
|
+
# setup authorization
|
|
803
|
+
Zernio.configure do |config|
|
|
804
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
805
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
806
|
+
end
|
|
807
|
+
|
|
808
|
+
api_instance = Zernio::SMSApi.new
|
|
809
|
+
request_sms_sender_id_limit_increase_request = Zernio::RequestSmsSenderIdLimitIncreaseRequest.new({requested_cap: 37, reason: 'reason_example'}) # RequestSmsSenderIdLimitIncreaseRequest |
|
|
810
|
+
|
|
811
|
+
begin
|
|
812
|
+
# Request a higher sender ID daily limit
|
|
813
|
+
result = api_instance.request_sms_sender_id_limit_increase(request_sms_sender_id_limit_increase_request)
|
|
814
|
+
p result
|
|
815
|
+
rescue Zernio::ApiError => e
|
|
816
|
+
puts "Error when calling SMSApi->request_sms_sender_id_limit_increase: #{e}"
|
|
817
|
+
end
|
|
818
|
+
```
|
|
819
|
+
|
|
820
|
+
#### Using the request_sms_sender_id_limit_increase_with_http_info variant
|
|
821
|
+
|
|
822
|
+
This returns an Array which contains the response data, status code and headers.
|
|
823
|
+
|
|
824
|
+
> <Array(<RequestSmsSenderIdLimitIncrease200Response>, Integer, Hash)> request_sms_sender_id_limit_increase_with_http_info(request_sms_sender_id_limit_increase_request)
|
|
825
|
+
|
|
826
|
+
```ruby
|
|
827
|
+
begin
|
|
828
|
+
# Request a higher sender ID daily limit
|
|
829
|
+
data, status_code, headers = api_instance.request_sms_sender_id_limit_increase_with_http_info(request_sms_sender_id_limit_increase_request)
|
|
830
|
+
p status_code # => 2xx
|
|
831
|
+
p headers # => { ... }
|
|
832
|
+
p data # => <RequestSmsSenderIdLimitIncrease200Response>
|
|
833
|
+
rescue Zernio::ApiError => e
|
|
834
|
+
puts "Error when calling SMSApi->request_sms_sender_id_limit_increase_with_http_info: #{e}"
|
|
835
|
+
end
|
|
836
|
+
```
|
|
837
|
+
|
|
838
|
+
### Parameters
|
|
839
|
+
|
|
840
|
+
| Name | Type | Description | Notes |
|
|
841
|
+
| ---- | ---- | ----------- | ----- |
|
|
842
|
+
| **request_sms_sender_id_limit_increase_request** | [**RequestSmsSenderIdLimitIncreaseRequest**](RequestSmsSenderIdLimitIncreaseRequest.md) | | |
|
|
843
|
+
|
|
844
|
+
### Return type
|
|
845
|
+
|
|
846
|
+
[**RequestSmsSenderIdLimitIncrease200Response**](RequestSmsSenderIdLimitIncrease200Response.md)
|
|
847
|
+
|
|
848
|
+
### Authorization
|
|
849
|
+
|
|
850
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
851
|
+
|
|
852
|
+
### HTTP request headers
|
|
853
|
+
|
|
854
|
+
- **Content-Type**: application/json
|
|
855
|
+
- **Accept**: application/json
|
|
856
|
+
|
|
857
|
+
|
|
583
858
|
## resend_sms_registration_otp
|
|
584
859
|
|
|
585
860
|
> <ResendSmsRegistrationOtp200Response> resend_sms_registration_otp(id)
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Zernio::SearchDiscordGuildMembers200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **data** | [**Array<DiscordGuildMember>**](DiscordGuildMember.md) | | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'zernio-sdk'
|
|
13
|
+
|
|
14
|
+
instance = Zernio::SearchDiscordGuildMembers200Response.new(
|
|
15
|
+
data: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Zernio::UpdateAdCreative200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **creative_id** | **String** | | [optional] |
|
|
8
|
+
| **name** | **String** | | [optional] |
|
|
9
|
+
| **message** | **String** | | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'zernio-sdk'
|
|
15
|
+
|
|
16
|
+
instance = Zernio::UpdateAdCreative200Response.new(
|
|
17
|
+
creative_id: null,
|
|
18
|
+
name: null,
|
|
19
|
+
message: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Zernio::UpdateAdCreativeRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **account_id** | **String** | Zernio SocialAccount id (posting or ads variant) used to resolve the Meta token. | |
|
|
8
|
+
| **name** | **String** | | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'zernio-sdk'
|
|
14
|
+
|
|
15
|
+
instance = Zernio::UpdateAdCreativeRequest.new(
|
|
16
|
+
account_id: null,
|
|
17
|
+
name: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|