zernio-sdk 0.0.533 → 0.0.535

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.
Files changed (38) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +13 -0
  3. data/docs/CreateSmsSenderId200Response.md +22 -0
  4. data/docs/CreateSmsSenderIdRequest.md +18 -0
  5. data/docs/DeleteSmsSenderId200Response.md +18 -0
  6. data/docs/ListSmsSenderIds200Response.md +20 -0
  7. data/docs/ListSmsSenderIds200ResponseBudget.md +24 -0
  8. data/docs/ListSmsSenderIds200ResponseBudgetPendingRequest.md +22 -0
  9. data/docs/ListSmsSenderIds200ResponseSenderIdsInner.md +24 -0
  10. data/docs/RequestSmsSenderIdLimitIncrease200Response.md +20 -0
  11. data/docs/RequestSmsSenderIdLimitIncreaseRequest.md +20 -0
  12. data/docs/SMSApi.md +276 -1
  13. data/docs/SendSmsRequest.md +1 -1
  14. data/lib/zernio-sdk/api/sms_api.rb +256 -2
  15. data/lib/zernio-sdk/models/create_sms_sender_id200_response.rb +166 -0
  16. data/lib/zernio-sdk/models/create_sms_sender_id_request.rb +183 -0
  17. data/lib/zernio-sdk/models/delete_sms_sender_id200_response.rb +147 -0
  18. data/lib/zernio-sdk/models/list_sms_sender_ids200_response.rb +158 -0
  19. data/lib/zernio-sdk/models/list_sms_sender_ids200_response_budget.rb +178 -0
  20. data/lib/zernio-sdk/models/list_sms_sender_ids200_response_budget_pending_request.rb +167 -0
  21. data/lib/zernio-sdk/models/list_sms_sender_ids200_response_sender_ids_inner.rb +175 -0
  22. data/lib/zernio-sdk/models/request_sms_sender_id_limit_increase200_response.rb +156 -0
  23. data/lib/zernio-sdk/models/request_sms_sender_id_limit_increase_request.rb +210 -0
  24. data/lib/zernio-sdk/models/send_sms_request.rb +1 -1
  25. data/lib/zernio-sdk/version.rb +1 -1
  26. data/lib/zernio-sdk.rb +9 -0
  27. data/openapi.yaml +164 -8
  28. data/spec/api/sms_api_spec.rb +47 -1
  29. data/spec/models/create_sms_sender_id200_response_spec.rb +48 -0
  30. data/spec/models/create_sms_sender_id_request_spec.rb +36 -0
  31. data/spec/models/delete_sms_sender_id200_response_spec.rb +36 -0
  32. data/spec/models/list_sms_sender_ids200_response_budget_pending_request_spec.rb +48 -0
  33. data/spec/models/list_sms_sender_ids200_response_budget_spec.rb +54 -0
  34. data/spec/models/list_sms_sender_ids200_response_sender_ids_inner_spec.rb +54 -0
  35. data/spec/models/list_sms_sender_ids200_response_spec.rb +42 -0
  36. data/spec/models/request_sms_sender_id_limit_increase200_response_spec.rb +42 -0
  37. data/spec/models/request_sms_sender_id_limit_increase_request_spec.rb +42 -0
  38. metadata +37 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 672e78e5f11272b5a89080eb85d5f6acf82bd6eedd406c7fc3b2a07f54e79adc
4
- data.tar.gz: b82290e579ddb86b52baadd6ea2f517aaf57bb5cdd67c50df656cd5918388b4a
3
+ metadata.gz: a478c13d9784e262336e7000fb772b470ea13c915b02053f7aa9bb9229a476ff
4
+ data.tar.gz: 70c691402056555eb47886bac8615b7a519a967e5a1394156555021cf6a5ba89
5
5
  SHA512:
6
- metadata.gz: f48c0fdd733cf16ee7181d46dbbeefbf8802374397ebc4038c505e68f2afbf36688d636457dbfefe4130636db276da16efcab826761dbe27c2c3c538363f54d6
7
- data.tar.gz: '0739f8bb10a105d90588605fc38a9777d90537fa35a44a54b393a68214d8dd42fc9972c5f22b62c1a62ba1707b5f5af4b68e0c85a3f22eff753c91f73d42f945'
6
+ metadata.gz: cf46fd3aa57897a7bcfa6b5cf95f9a8726da6e8a03f7ffa40ed219d60c95dc0bc31dbca3e3fbab22626bfbb7adc378ad20e1f26d1fae59280854ef4deb48a8f9
7
+ data.tar.gz: c422c8519e4003d90053951efcfbc439ecb4cfb1f18ca80822641f062fb67704e1047faa93950c484762e9985a05e4d060f19fde23878fab8fb333b3b33db902
data/README.md CHANGED
@@ -400,13 +400,17 @@ Class | Method | HTTP request | Description
400
400
  *Zernio::ReviewsApi* | [**list_inbox_reviews**](docs/ReviewsApi.md#list_inbox_reviews) | **GET** /v1/inbox/reviews | List reviews
401
401
  *Zernio::ReviewsApi* | [**reply_to_inbox_review**](docs/ReviewsApi.md#reply_to_inbox_review) | **POST** /v1/inbox/reviews/{reviewId}/reply | Reply to review
402
402
  *Zernio::SMSApi* | [**appeal_sms_registration**](docs/SMSApi.md#appeal_sms_registration) | **POST** /v1/sms/registrations/{id}/appeal | Appeal a rejected campaign
403
+ *Zernio::SMSApi* | [**create_sms_sender_id**](docs/SMSApi.md#create_sms_sender_id) | **POST** /v1/sms/sender-ids | Create an alphanumeric sender ID
403
404
  *Zernio::SMSApi* | [**deactivate_sms_registration**](docs/SMSApi.md#deactivate_sms_registration) | **DELETE** /v1/sms/registrations/{id} | Deactivate a brand/campaign registration
405
+ *Zernio::SMSApi* | [**delete_sms_sender_id**](docs/SMSApi.md#delete_sms_sender_id) | **DELETE** /v1/sms/sender-ids/{id} | Delete an alphanumeric sender ID
404
406
  *Zernio::SMSApi* | [**disable_sms_on_number**](docs/SMSApi.md#disable_sms_on_number) | **DELETE** /v1/phone-numbers/{id}/sms | Disable SMS on a number
405
407
  *Zernio::SMSApi* | [**enable_sms_on_number**](docs/SMSApi.md#enable_sms_on_number) | **POST** /v1/phone-numbers/{id}/sms | Enable SMS on a number
406
408
  *Zernio::SMSApi* | [**get_sms_registration**](docs/SMSApi.md#get_sms_registration) | **GET** /v1/sms/registrations/{id} | Get a carrier registration
407
409
  *Zernio::SMSApi* | [**list_sms_opt_outs**](docs/SMSApi.md#list_sms_opt_outs) | **GET** /v1/sms/opt-outs | List SMS opt-outs
408
410
  *Zernio::SMSApi* | [**list_sms_registrations**](docs/SMSApi.md#list_sms_registrations) | **GET** /v1/sms/registrations | List carrier registrations
411
+ *Zernio::SMSApi* | [**list_sms_sender_ids**](docs/SMSApi.md#list_sms_sender_ids) | **GET** /v1/sms/sender-ids | List alphanumeric sender IDs
409
412
  *Zernio::SMSApi* | [**lookup_sms_number**](docs/SMSApi.md#lookup_sms_number) | **GET** /v1/sms/lookup | Look up carrier + line type
413
+ *Zernio::SMSApi* | [**request_sms_sender_id_limit_increase**](docs/SMSApi.md#request_sms_sender_id_limit_increase) | **POST** /v1/sms/sender-ids/limit-request | Request a higher sender ID daily limit
410
414
  *Zernio::SMSApi* | [**resend_sms_registration_otp**](docs/SMSApi.md#resend_sms_registration_otp) | **POST** /v1/sms/registrations/{id}/resend-otp | Re-send the sole-prop OTP
411
415
  *Zernio::SMSApi* | [**reuse_sms_registration_for_number**](docs/SMSApi.md#reuse_sms_registration_for_number) | **POST** /v1/phone-numbers/{id}/sms/reuse-registration | Add number to SMS registration
412
416
  *Zernio::SMSApi* | [**send_sms**](docs/SMSApi.md#send_sms) | **POST** /v1/sms/messages | Send an SMS/MMS
@@ -785,6 +789,8 @@ Class | Method | HTTP request | Description
785
789
  - [Zernio::CreateSequenceRequestStepsInner](docs/CreateSequenceRequestStepsInner.md)
786
790
  - [Zernio::CreateSequenceRequestStepsInnerTemplate](docs/CreateSequenceRequestStepsInnerTemplate.md)
787
791
  - [Zernio::CreateSequenceRequestStepsInnerTemplateVariableMappingValue](docs/CreateSequenceRequestStepsInnerTemplateVariableMappingValue.md)
792
+ - [Zernio::CreateSmsSenderId200Response](docs/CreateSmsSenderId200Response.md)
793
+ - [Zernio::CreateSmsSenderIdRequest](docs/CreateSmsSenderIdRequest.md)
788
794
  - [Zernio::CreateStandaloneAd201Response](docs/CreateStandaloneAd201Response.md)
789
795
  - [Zernio::CreateStandaloneAd201ResponseOneOf](docs/CreateStandaloneAd201ResponseOneOf.md)
790
796
  - [Zernio::CreateStandaloneAd201ResponseOneOf1](docs/CreateStandaloneAd201ResponseOneOf1.md)
@@ -857,6 +863,7 @@ Class | Method | HTTP request | Description
857
863
  - [Zernio::DeleteInboxComment200Response](docs/DeleteInboxComment200Response.md)
858
864
  - [Zernio::DeleteInboxReviewReply200Response](docs/DeleteInboxReviewReply200Response.md)
859
865
  - [Zernio::DeleteInboxReviewReplyRequest](docs/DeleteInboxReviewReplyRequest.md)
866
+ - [Zernio::DeleteSmsSenderId200Response](docs/DeleteSmsSenderId200Response.md)
860
867
  - [Zernio::DeleteWhatsappBusinessUsernameRequest](docs/DeleteWhatsappBusinessUsernameRequest.md)
861
868
  - [Zernio::DialVoiceWebCall200Response](docs/DialVoiceWebCall200Response.md)
862
869
  - [Zernio::DialVoiceWebCallRequest](docs/DialVoiceWebCallRequest.md)
@@ -1408,6 +1415,10 @@ Class | Method | HTTP request | Description
1408
1415
  - [Zernio::ListSmsRegistrations200Response](docs/ListSmsRegistrations200Response.md)
1409
1416
  - [Zernio::ListSmsRegistrations200ResponseRegistrationsInner](docs/ListSmsRegistrations200ResponseRegistrationsInner.md)
1410
1417
  - [Zernio::ListSmsRegistrations200ResponseRegistrationsInnerThroughput](docs/ListSmsRegistrations200ResponseRegistrationsInnerThroughput.md)
1418
+ - [Zernio::ListSmsSenderIds200Response](docs/ListSmsSenderIds200Response.md)
1419
+ - [Zernio::ListSmsSenderIds200ResponseBudget](docs/ListSmsSenderIds200ResponseBudget.md)
1420
+ - [Zernio::ListSmsSenderIds200ResponseBudgetPendingRequest](docs/ListSmsSenderIds200ResponseBudgetPendingRequest.md)
1421
+ - [Zernio::ListSmsSenderIds200ResponseSenderIdsInner](docs/ListSmsSenderIds200ResponseSenderIdsInner.md)
1411
1422
  - [Zernio::ListSnapchatProfiles200Response](docs/ListSnapchatProfiles200Response.md)
1412
1423
  - [Zernio::ListSnapchatProfiles200ResponsePublicProfilesInner](docs/ListSnapchatProfiles200ResponsePublicProfilesInner.md)
1413
1424
  - [Zernio::ListTrackingTagSharedAccounts200Response](docs/ListTrackingTagSharedAccounts200Response.md)
@@ -1533,6 +1544,8 @@ Class | Method | HTTP request | Description
1533
1544
  - [Zernio::ReplyToInboxReviewRequest](docs/ReplyToInboxReviewRequest.md)
1534
1545
  - [Zernio::ReplyToMention200Response](docs/ReplyToMention200Response.md)
1535
1546
  - [Zernio::ReplyToMentionRequest](docs/ReplyToMentionRequest.md)
1547
+ - [Zernio::RequestSmsSenderIdLimitIncrease200Response](docs/RequestSmsSenderIdLimitIncrease200Response.md)
1548
+ - [Zernio::RequestSmsSenderIdLimitIncreaseRequest](docs/RequestSmsSenderIdLimitIncreaseRequest.md)
1536
1549
  - [Zernio::ResendSmsRegistrationOtp200Response](docs/ResendSmsRegistrationOtp200Response.md)
1537
1550
  - [Zernio::ReserveRfPrediction201Response](docs/ReserveRfPrediction201Response.md)
1538
1551
  - [Zernio::ReserveRfPredictionRequest](docs/ReserveRfPredictionRequest.md)
@@ -0,0 +1,22 @@
1
+ # Zernio::CreateSmsSenderId200Response
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | Sender ID resource id. | [optional] |
8
+ | **sender_id** | **String** | | [optional] |
9
+ | **is_active** | **Boolean** | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'zernio-sdk'
15
+
16
+ instance = Zernio::CreateSmsSenderId200Response.new(
17
+ id: null,
18
+ sender_id: null,
19
+ is_active: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,18 @@
1
+ # Zernio::CreateSmsSenderIdRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **sender_id** | **String** | The sender ID recipients will see (3-11 letters/digits/spaces, at least one letter, no leading/trailing space). | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'zernio-sdk'
13
+
14
+ instance = Zernio::CreateSmsSenderIdRequest.new(
15
+ sender_id: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,18 @@
1
+ # Zernio::DeleteSmsSenderId200Response
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **deleted** | **Boolean** | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'zernio-sdk'
13
+
14
+ instance = Zernio::DeleteSmsSenderId200Response.new(
15
+ deleted: null
16
+ )
17
+ ```
18
+
@@ -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)
@@ -724,7 +999,7 @@ end
724
999
 
725
1000
  Send an SMS/MMS
726
1001
 
727
- Sends an SMS (or MMS when `mediaUrls` is set) from one of your SMS-enabled numbers. At least one of `text` / `mediaUrls` is required. Both numbers are normalized to E.164, so `from` matches regardless of formatting and replies thread into the same inbox conversation. US numbers must have an approved carrier registration (`/v1/sms/registrations`) before messages deliver. **Idempotency:** send an `Idempotency-Key` header to make retries safe: same key + same body replays the original response instead of sending a second message; same key + different body returns 422; a key still in flight returns 409.
1002
+ Sends an SMS (or MMS when `mediaUrls` is set) from one of your SMS-enabled numbers, or from an approved alphanumeric sender ID (`/v1/sms/sender-ids`). At least one of `text` / `mediaUrls` is required. Numbers are normalized to E.164, so `from` matches regardless of formatting and replies thread into the same inbox conversation. US numbers must have an approved carrier registration (`/v1/sms/registrations`) before messages deliver. **Alphanumeric sender IDs** are one-way and international only: they cannot reach the US, Canada, or Puerto Rico (403), are text-only (no MMS), and recipients cannot reply. Some destination countries substitute a numeric sender to ensure delivery. **Idempotency:** send an `Idempotency-Key` header to make retries safe: same key + same body replays the original response instead of sending a second message; same key + different body returns 422; a key still in flight returns 409.
728
1003
 
729
1004
  ### Examples
730
1005
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **from** | **String** | One of your SMS-enabled numbers (E.164; formatting is normalized). | |
7
+ | **from** | **String** | One of your SMS-enabled numbers (E.164; formatting is normalized), or an approved alphanumeric sender ID (3-11 letters/digits/spaces, created via &#x60;/v1/sms/sender-ids&#x60;). | |
8
8
  | **to** | **String** | Recipient number (E.164). | |
9
9
  | **text** | **String** | Message body. Required unless &#x60;mediaUrls&#x60; is set. Max 10 SMS segments (1530 GSM-7 or 670 unicode characters). | [optional] |
10
10
  | **media_urls** | **Array&lt;String&gt;** | Public media URLs to attach (sends as MMS). Max 10. | [optional] |