late-sdk 0.0.587 → 0.0.589

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 (35) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +8 -0
  3. data/docs/PreflightSmsRegistration200Response.md +24 -0
  4. data/docs/PreflightSmsRegistration200ResponseAdvisoriesInner.md +24 -0
  5. data/docs/PreflightSmsRegistration200ResponseComposed.md +20 -0
  6. data/docs/PreflightSmsRegistrationRequest.md +26 -0
  7. data/docs/RespondToSmsRegistrationReview200Response.md +18 -0
  8. data/docs/RespondToSmsRegistrationReviewRequest.md +20 -0
  9. data/docs/SMSApi.md +142 -0
  10. data/docs/StartSmsRegistrationRequest.md +2 -0
  11. data/docs/WebhooksApi.md +2 -2
  12. data/lib/zernio-sdk/api/sms_api.rb +142 -0
  13. data/lib/zernio-sdk/api/webhooks_api.rb +4 -4
  14. data/lib/zernio-sdk/models/preflight_sms_registration200_response.rb +211 -0
  15. data/lib/zernio-sdk/models/preflight_sms_registration200_response_advisories_inner.rb +212 -0
  16. data/lib/zernio-sdk/models/preflight_sms_registration200_response_composed.rb +157 -0
  17. data/lib/zernio-sdk/models/preflight_sms_registration_request.rb +290 -0
  18. data/lib/zernio-sdk/models/respond_to_sms_registration_review200_response.rb +181 -0
  19. data/lib/zernio-sdk/models/respond_to_sms_registration_review_request.rb +198 -0
  20. data/lib/zernio-sdk/models/start_sms_registration_request.rb +39 -1
  21. data/lib/zernio-sdk/version.rb +1 -1
  22. data/lib/zernio-sdk.rb +6 -0
  23. data/openapi.yaml +105 -2
  24. data/spec/api/sms_api_spec.rb +25 -0
  25. data/spec/api/webhooks_api_spec.rb +2 -2
  26. data/spec/models/preflight_sms_registration200_response_advisories_inner_spec.rb +58 -0
  27. data/spec/models/preflight_sms_registration200_response_composed_spec.rb +42 -0
  28. data/spec/models/preflight_sms_registration200_response_spec.rb +58 -0
  29. data/spec/models/preflight_sms_registration_request_spec.rb +64 -0
  30. data/spec/models/respond_to_sms_registration_review200_response_spec.rb +40 -0
  31. data/spec/models/respond_to_sms_registration_review_request_spec.rb +42 -0
  32. data/spec/models/start_sms_registration_request_spec.rb +6 -0
  33. data/zernio-sdk-0.0.589.gem +0 -0
  34. metadata +26 -2
  35. data/zernio-sdk-0.0.587.gem +0 -0
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: a9cadd1fb1f6680d283d30ef6c065ffe44016557999c1845abae44745bd50e33
4
- data.tar.gz: 17dffd1d21700dbddaff6983886f539e10e77e0f641859687e596a6fb0bd052e
3
+ metadata.gz: f1f45cb9c0f0dff9d01f046946c7813dcb33df1498ea4570e4852075451405fa
4
+ data.tar.gz: 220ab293327dbf3f474440ab5606dea4e2182a4a3ed523c4dc93dfee8673325d
5
5
  SHA512:
6
- metadata.gz: 6f5eca35a8a3e12afa5a7c49402ea27e691a835bbf15c57d6e778c15eae6a2771dc841abdddc129c6700f0efffa11e7ac3f667668a1c0ae72edc3fffdeedcfd0
7
- data.tar.gz: 252faaa26da766102832d975a8f40d52f78532518b56141aa13444e028cf0f83b51d6415298960741976a8829ad0bfeb13bbb02bba022f32ca1733732c0b3ef2
6
+ metadata.gz: 8c5dc19845c44d2e075fd8ad3aff99b52a6988c9b7841535c25614fab94e000e3b050ad76e1ca913a3c360e34b4998fe85dc0f2eeef9889927b5cb43684ed965
7
+ data.tar.gz: a25665555cfda6e39810da4a1dc3d48a5b3d35d7179a022dc4b4aaf49980ac9715406b362a84e9d2bc1da79f0135f4e075e4a92b54334ac8917c0f8af536e2ff
data/README.md CHANGED
@@ -425,8 +425,10 @@ Class | Method | HTTP request | Description
425
425
  *Zernio::SMSApi* | [**list_sms_registrations**](docs/SMSApi.md#list_sms_registrations) | **GET** /v1/sms/registrations | List carrier registrations
426
426
  *Zernio::SMSApi* | [**list_sms_sender_ids**](docs/SMSApi.md#list_sms_sender_ids) | **GET** /v1/sms/sender-ids | List alphanumeric sender IDs
427
427
  *Zernio::SMSApi* | [**lookup_sms_number**](docs/SMSApi.md#lookup_sms_number) | **GET** /v1/sms/lookup | Look up carrier + line type
428
+ *Zernio::SMSApi* | [**preflight_sms_registration**](docs/SMSApi.md#preflight_sms_registration) | **POST** /v1/sms/registrations/preflight | Pre-check a carrier registration
428
429
  *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
429
430
  *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
431
+ *Zernio::SMSApi* | [**respond_to_sms_registration_review**](docs/SMSApi.md#respond_to_sms_registration_review) | **POST** /v1/sms/registrations/{id}/respond | Reply to a change request
430
432
  *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
431
433
  *Zernio::SMSApi* | [**send_sms**](docs/SMSApi.md#send_sms) | **POST** /v1/sms/messages | Send an SMS/MMS
432
434
  *Zernio::SMSApi* | [**share_sms_registration**](docs/SMSApi.md#share_sms_registration) | **POST** /v1/sms/registrations/share | Create a registration share link
@@ -1561,6 +1563,10 @@ Class | Method | HTTP request | Description
1561
1563
  - [Zernio::PostUpdateResponse](docs/PostUpdateResponse.md)
1562
1564
  - [Zernio::PostUserId](docs/PostUserId.md)
1563
1565
  - [Zernio::PostsListResponse](docs/PostsListResponse.md)
1566
+ - [Zernio::PreflightSmsRegistration200Response](docs/PreflightSmsRegistration200Response.md)
1567
+ - [Zernio::PreflightSmsRegistration200ResponseAdvisoriesInner](docs/PreflightSmsRegistration200ResponseAdvisoriesInner.md)
1568
+ - [Zernio::PreflightSmsRegistration200ResponseComposed](docs/PreflightSmsRegistration200ResponseComposed.md)
1569
+ - [Zernio::PreflightSmsRegistrationRequest](docs/PreflightSmsRegistrationRequest.md)
1564
1570
  - [Zernio::Profile](docs/Profile.md)
1565
1571
  - [Zernio::ProfileCreateResponse](docs/ProfileCreateResponse.md)
1566
1572
  - [Zernio::ProfileDeleteResponse](docs/ProfileDeleteResponse.md)
@@ -1621,6 +1627,8 @@ Class | Method | HTTP request | Description
1621
1627
  - [Zernio::RespondToPhoneNumberReviewer200Response](docs/RespondToPhoneNumberReviewer200Response.md)
1622
1628
  - [Zernio::RespondToPhoneNumberReviewerRequest](docs/RespondToPhoneNumberReviewerRequest.md)
1623
1629
  - [Zernio::RespondToPhoneNumberReviewerRequestDocumentsInner](docs/RespondToPhoneNumberReviewerRequestDocumentsInner.md)
1630
+ - [Zernio::RespondToSmsRegistrationReview200Response](docs/RespondToSmsRegistrationReview200Response.md)
1631
+ - [Zernio::RespondToSmsRegistrationReviewRequest](docs/RespondToSmsRegistrationReviewRequest.md)
1624
1632
  - [Zernio::RestoreWorkflowVersion200Response](docs/RestoreWorkflowVersion200Response.md)
1625
1633
  - [Zernio::RestoreWorkflowVersion200ResponseWorkflow](docs/RestoreWorkflowVersion200ResponseWorkflow.md)
1626
1634
  - [Zernio::RetweetPost200Response](docs/RetweetPost200Response.md)
@@ -0,0 +1,24 @@
1
+ # Zernio::PreflightSmsRegistration200Response
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **composed** | [**PreflightSmsRegistration200ResponseComposed**](PreflightSmsRegistration200ResponseComposed.md) | | [optional] |
8
+ | **advisories** | [**Array<PreflightSmsRegistration200ResponseAdvisoriesInner>**](PreflightSmsRegistration200ResponseAdvisoriesInner.md) | | [optional] |
9
+ | **verdict** | **String** | | [optional] |
10
+ | **ai_unavailable** | **Boolean** | True when the AI portion of the check could not run; advisories then contain only deterministic findings. | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'zernio-sdk'
16
+
17
+ instance = Zernio::PreflightSmsRegistration200Response.new(
18
+ composed: null,
19
+ advisories: null,
20
+ verdict: null,
21
+ ai_unavailable: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,24 @@
1
+ # Zernio::PreflightSmsRegistration200ResponseAdvisoriesInner
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **field** | **String** | The payload field the finding is about, when attributable. | [optional] |
8
+ | **code** | **String** | Stable rule id for deterministic findings; absent on AI findings. | [optional] |
9
+ | **concern** | **String** | | [optional] |
10
+ | **severity** | **String** | | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'zernio-sdk'
16
+
17
+ instance = Zernio::PreflightSmsRegistration200ResponseAdvisoriesInner.new(
18
+ field: null,
19
+ code: null,
20
+ concern: null,
21
+ severity: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,20 @@
1
+ # Zernio::PreflightSmsRegistration200ResponseComposed
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **brand** | **Object** | | [optional] |
8
+ | **campaign** | **Object** | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'zernio-sdk'
14
+
15
+ instance = Zernio::PreflightSmsRegistration200ResponseComposed.new(
16
+ brand: null,
17
+ campaign: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,26 @@
1
+ # Zernio::PreflightSmsRegistrationRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **registration_type** | **String** | | |
8
+ | **phone_numbers** | **Array<String>** | | [optional] |
9
+ | **brand** | **Object** | Same shape as the registration `brand`. | |
10
+ | **campaign** | **Object** | Same shape as the registration `campaign`. | |
11
+ | **messaging_brand_name** | **String** | | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'zernio-sdk'
17
+
18
+ instance = Zernio::PreflightSmsRegistrationRequest.new(
19
+ registration_type: null,
20
+ phone_numbers: null,
21
+ brand: null,
22
+ campaign: null,
23
+ messaging_brand_name: null
24
+ )
25
+ ```
26
+
@@ -0,0 +1,18 @@
1
+ # Zernio::RespondToSmsRegistrationReview200Response
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **status** | **String** | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'zernio-sdk'
13
+
14
+ instance = Zernio::RespondToSmsRegistrationReview200Response.new(
15
+ status: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,20 @@
1
+ # Zernio::RespondToSmsRegistrationReviewRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **note** | **String** | Answer for the reviewer. Required when no files are sent. | [optional] |
8
+ | **files** | **Array<String>** | Hosted document URLs returned by POST /v1/sms/opt-in-proof. | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'zernio-sdk'
14
+
15
+ instance = Zernio::RespondToSmsRegistrationReviewRequest.new(
16
+ note: null,
17
+ files: null
18
+ )
19
+ ```
20
+
data/docs/SMSApi.md CHANGED
@@ -15,8 +15,10 @@ All URIs are relative to *https://zernio.com/api*
15
15
  | [**list_sms_registrations**](SMSApi.md#list_sms_registrations) | **GET** /v1/sms/registrations | List carrier registrations |
16
16
  | [**list_sms_sender_ids**](SMSApi.md#list_sms_sender_ids) | **GET** /v1/sms/sender-ids | List alphanumeric sender IDs |
17
17
  | [**lookup_sms_number**](SMSApi.md#lookup_sms_number) | **GET** /v1/sms/lookup | Look up carrier + line type |
18
+ | [**preflight_sms_registration**](SMSApi.md#preflight_sms_registration) | **POST** /v1/sms/registrations/preflight | Pre-check a carrier registration |
18
19
  | [**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 |
19
20
  | [**resend_sms_registration_otp**](SMSApi.md#resend_sms_registration_otp) | **POST** /v1/sms/registrations/{id}/resend-otp | Re-send the sole-prop OTP |
21
+ | [**respond_to_sms_registration_review**](SMSApi.md#respond_to_sms_registration_review) | **POST** /v1/sms/registrations/{id}/respond | Reply to a change request |
20
22
  | [**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 |
21
23
  | [**send_sms**](SMSApi.md#send_sms) | **POST** /v1/sms/messages | Send an SMS/MMS |
22
24
  | [**share_sms_registration**](SMSApi.md#share_sms_registration) | **POST** /v1/sms/registrations/share | Create a registration share link |
@@ -786,6 +788,75 @@ end
786
788
  - **Accept**: application/json
787
789
 
788
790
 
791
+ ## preflight_sms_registration
792
+
793
+ > <PreflightSmsRegistration200Response> preflight_sms_registration(preflight_sms_registration_request)
794
+
795
+ Pre-check a carrier registration
796
+
797
+ Dry-run of `POST /v1/sms/registrations` for 10DLC: validates and composes the exact brand/campaign payloads a submission would store (branding, disclosures, auto-replies), runs deterministic compliance lints plus an AI reviewer over them, and returns the findings WITHOUT creating anything. Use it to fix issues before submitting; `block` severity findings indicate a near-certain carrier rejection.
798
+
799
+ ### Examples
800
+
801
+ ```ruby
802
+ require 'time'
803
+ require 'zernio-sdk'
804
+ # setup authorization
805
+ Zernio.configure do |config|
806
+ # Configure Bearer authorization (JWT): bearerAuth
807
+ config.access_token = 'YOUR_BEARER_TOKEN'
808
+ end
809
+
810
+ api_instance = Zernio::SMSApi.new
811
+ preflight_sms_registration_request = Zernio::PreflightSmsRegistrationRequest.new({registration_type: 'standard_10dlc', brand: 3.56, campaign: 3.56}) # PreflightSmsRegistrationRequest |
812
+
813
+ begin
814
+ # Pre-check a carrier registration
815
+ result = api_instance.preflight_sms_registration(preflight_sms_registration_request)
816
+ p result
817
+ rescue Zernio::ApiError => e
818
+ puts "Error when calling SMSApi->preflight_sms_registration: #{e}"
819
+ end
820
+ ```
821
+
822
+ #### Using the preflight_sms_registration_with_http_info variant
823
+
824
+ This returns an Array which contains the response data, status code and headers.
825
+
826
+ > <Array(<PreflightSmsRegistration200Response>, Integer, Hash)> preflight_sms_registration_with_http_info(preflight_sms_registration_request)
827
+
828
+ ```ruby
829
+ begin
830
+ # Pre-check a carrier registration
831
+ data, status_code, headers = api_instance.preflight_sms_registration_with_http_info(preflight_sms_registration_request)
832
+ p status_code # => 2xx
833
+ p headers # => { ... }
834
+ p data # => <PreflightSmsRegistration200Response>
835
+ rescue Zernio::ApiError => e
836
+ puts "Error when calling SMSApi->preflight_sms_registration_with_http_info: #{e}"
837
+ end
838
+ ```
839
+
840
+ ### Parameters
841
+
842
+ | Name | Type | Description | Notes |
843
+ | ---- | ---- | ----------- | ----- |
844
+ | **preflight_sms_registration_request** | [**PreflightSmsRegistrationRequest**](PreflightSmsRegistrationRequest.md) | | |
845
+
846
+ ### Return type
847
+
848
+ [**PreflightSmsRegistration200Response**](PreflightSmsRegistration200Response.md)
849
+
850
+ ### Authorization
851
+
852
+ [bearerAuth](../README.md#bearerAuth)
853
+
854
+ ### HTTP request headers
855
+
856
+ - **Content-Type**: application/json
857
+ - **Accept**: application/json
858
+
859
+
789
860
  ## request_sms_sender_id_limit_increase
790
861
 
791
862
  > <RequestSmsSenderIdLimitIncrease200Response> request_sms_sender_id_limit_increase(request_sms_sender_id_limit_increase_request)
@@ -924,6 +995,77 @@ end
924
995
  - **Accept**: application/json
925
996
 
926
997
 
998
+ ## respond_to_sms_registration_review
999
+
1000
+ > <RespondToSmsRegistrationReview200Response> respond_to_sms_registration_review(id, respond_to_sms_registration_review_request)
1001
+
1002
+ Reply to a change request
1003
+
1004
+ Replies to a reviewer change request on a registration in `changes_requested` state: a note, hosted document URLs (from `POST /v1/sms/opt-in-proof`), or both, sent together. The registration returns to `requested` (back in review) — no need to resubmit the whole registration. To change the submitted brand/campaign fields themselves, resubmit via `POST /v1/sms/registrations` with `resubmitRequestId` instead.
1005
+
1006
+ ### Examples
1007
+
1008
+ ```ruby
1009
+ require 'time'
1010
+ require 'zernio-sdk'
1011
+ # setup authorization
1012
+ Zernio.configure do |config|
1013
+ # Configure Bearer authorization (JWT): bearerAuth
1014
+ config.access_token = 'YOUR_BEARER_TOKEN'
1015
+ end
1016
+
1017
+ api_instance = Zernio::SMSApi.new
1018
+ id = 'id_example' # String |
1019
+ respond_to_sms_registration_review_request = Zernio::RespondToSmsRegistrationReviewRequest.new # RespondToSmsRegistrationReviewRequest |
1020
+
1021
+ begin
1022
+ # Reply to a change request
1023
+ result = api_instance.respond_to_sms_registration_review(id, respond_to_sms_registration_review_request)
1024
+ p result
1025
+ rescue Zernio::ApiError => e
1026
+ puts "Error when calling SMSApi->respond_to_sms_registration_review: #{e}"
1027
+ end
1028
+ ```
1029
+
1030
+ #### Using the respond_to_sms_registration_review_with_http_info variant
1031
+
1032
+ This returns an Array which contains the response data, status code and headers.
1033
+
1034
+ > <Array(<RespondToSmsRegistrationReview200Response>, Integer, Hash)> respond_to_sms_registration_review_with_http_info(id, respond_to_sms_registration_review_request)
1035
+
1036
+ ```ruby
1037
+ begin
1038
+ # Reply to a change request
1039
+ data, status_code, headers = api_instance.respond_to_sms_registration_review_with_http_info(id, respond_to_sms_registration_review_request)
1040
+ p status_code # => 2xx
1041
+ p headers # => { ... }
1042
+ p data # => <RespondToSmsRegistrationReview200Response>
1043
+ rescue Zernio::ApiError => e
1044
+ puts "Error when calling SMSApi->respond_to_sms_registration_review_with_http_info: #{e}"
1045
+ end
1046
+ ```
1047
+
1048
+ ### Parameters
1049
+
1050
+ | Name | Type | Description | Notes |
1051
+ | ---- | ---- | ----------- | ----- |
1052
+ | **id** | **String** | | |
1053
+ | **respond_to_sms_registration_review_request** | [**RespondToSmsRegistrationReviewRequest**](RespondToSmsRegistrationReviewRequest.md) | | |
1054
+
1055
+ ### Return type
1056
+
1057
+ [**RespondToSmsRegistrationReview200Response**](RespondToSmsRegistrationReview200Response.md)
1058
+
1059
+ ### Authorization
1060
+
1061
+ [bearerAuth](../README.md#bearerAuth)
1062
+
1063
+ ### HTTP request headers
1064
+
1065
+ - **Content-Type**: application/json
1066
+ - **Accept**: application/json
1067
+
1068
+
927
1069
  ## reuse_sms_registration_for_number
928
1070
 
929
1071
  > <ReuseSmsRegistrationForNumber200Response> reuse_sms_registration_for_number(id)
@@ -8,6 +8,7 @@
8
8
  | **phone_numbers** | **Array&lt;String&gt;** | Your numbers this registration covers. | |
9
9
  | **brand** | [**StartSmsRegistrationRequestBrand**](StartSmsRegistrationRequestBrand.md) | | [optional] |
10
10
  | **campaign** | [**StartSmsRegistrationRequestCampaign**](StartSmsRegistrationRequestCampaign.md) | | [optional] |
11
+ | **messaging_brand_name** | **String** | DBA / trade name used to brand message content (samples and auto-replies) when it differs from the legal name, e.g. a sole proprietor texting under a business name. The legal &#x60;brand.displayName&#x60; is still what the carrier vets. | [optional] |
11
12
  | **wizard_values** | **Hash&lt;String, String&gt;** | Raw dashboard-wizard answers, stored only to prefill edit-and-resubmit. API integrators can omit. | [optional] |
12
13
  | **resubmit_request_id** | **String** | Resubmit a registration that was returned for changes — updates it in place instead of creating a new one. | [optional] |
13
14
  | **toll_free** | [**StartSmsRegistrationRequestTollFree**](StartSmsRegistrationRequestTollFree.md) | | [optional] |
@@ -22,6 +23,7 @@ instance = Zernio::StartSmsRegistrationRequest.new(
22
23
  phone_numbers: null,
23
24
  brand: null,
24
25
  campaign: null,
26
+ messaging_brand_name: null,
25
27
  wizard_values: null,
26
28
  resubmit_request_id: null,
27
29
  toll_free: null
data/docs/WebhooksApi.md CHANGED
@@ -18,7 +18,7 @@ All URIs are relative to *https://zernio.com/api*
18
18
 
19
19
  Create webhook
20
20
 
21
- Create a new webhook configuration. Maximum 10 webhooks per user. `name`, `url` and `events` are required. `url` must be a valid URL and `events` must contain at least one event. Whitespace is trimmed from `url` before validation. Webhooks are automatically disabled after 10 consecutive delivery failures.
21
+ Create a new webhook configuration. Maximum 50 webhooks per user. `name`, `url` and `events` are required. `url` must be a valid URL and `events` must contain at least one event. Whitespace is trimmed from `url` before validation. Webhooks are automatically disabled after 10 consecutive delivery failures.
22
22
 
23
23
  ### Examples
24
24
 
@@ -237,7 +237,7 @@ end
237
237
 
238
238
  List webhooks
239
239
 
240
- Retrieve all configured webhooks for the authenticated user. Supports up to 10 webhooks per user.
240
+ Retrieve all configured webhooks for the authenticated user. Supports up to 50 webhooks per user.
241
241
 
242
242
  ### Examples
243
243
 
@@ -732,6 +732,74 @@ module Zernio
732
732
  return data, status_code, headers
733
733
  end
734
734
 
735
+ # Pre-check a carrier registration
736
+ # Dry-run of `POST /v1/sms/registrations` for 10DLC: validates and composes the exact brand/campaign payloads a submission would store (branding, disclosures, auto-replies), runs deterministic compliance lints plus an AI reviewer over them, and returns the findings WITHOUT creating anything. Use it to fix issues before submitting; `block` severity findings indicate a near-certain carrier rejection.
737
+ # @param preflight_sms_registration_request [PreflightSmsRegistrationRequest]
738
+ # @param [Hash] opts the optional parameters
739
+ # @return [PreflightSmsRegistration200Response]
740
+ def preflight_sms_registration(preflight_sms_registration_request, opts = {})
741
+ data, _status_code, _headers = preflight_sms_registration_with_http_info(preflight_sms_registration_request, opts)
742
+ data
743
+ end
744
+
745
+ # Pre-check a carrier registration
746
+ # Dry-run of &#x60;POST /v1/sms/registrations&#x60; for 10DLC: validates and composes the exact brand/campaign payloads a submission would store (branding, disclosures, auto-replies), runs deterministic compliance lints plus an AI reviewer over them, and returns the findings WITHOUT creating anything. Use it to fix issues before submitting; &#x60;block&#x60; severity findings indicate a near-certain carrier rejection.
747
+ # @param preflight_sms_registration_request [PreflightSmsRegistrationRequest]
748
+ # @param [Hash] opts the optional parameters
749
+ # @return [Array<(PreflightSmsRegistration200Response, Integer, Hash)>] PreflightSmsRegistration200Response data, response status code and response headers
750
+ def preflight_sms_registration_with_http_info(preflight_sms_registration_request, opts = {})
751
+ if @api_client.config.debugging
752
+ @api_client.config.logger.debug 'Calling API: SMSApi.preflight_sms_registration ...'
753
+ end
754
+ # verify the required parameter 'preflight_sms_registration_request' is set
755
+ if @api_client.config.client_side_validation && preflight_sms_registration_request.nil?
756
+ fail ArgumentError, "Missing the required parameter 'preflight_sms_registration_request' when calling SMSApi.preflight_sms_registration"
757
+ end
758
+ # resource path
759
+ local_var_path = '/v1/sms/registrations/preflight'
760
+
761
+ # query parameters
762
+ query_params = opts[:query_params] || {}
763
+
764
+ # header parameters
765
+ header_params = opts[:header_params] || {}
766
+ # HTTP header 'Accept' (if needed)
767
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
768
+ # HTTP header 'Content-Type'
769
+ content_type = @api_client.select_header_content_type(['application/json'])
770
+ if !content_type.nil?
771
+ header_params['Content-Type'] = content_type
772
+ end
773
+
774
+ # form parameters
775
+ form_params = opts[:form_params] || {}
776
+
777
+ # http body (model)
778
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(preflight_sms_registration_request)
779
+
780
+ # return_type
781
+ return_type = opts[:debug_return_type] || 'PreflightSmsRegistration200Response'
782
+
783
+ # auth_names
784
+ auth_names = opts[:debug_auth_names] || ['bearerAuth']
785
+
786
+ new_options = opts.merge(
787
+ :operation => :"SMSApi.preflight_sms_registration",
788
+ :header_params => header_params,
789
+ :query_params => query_params,
790
+ :form_params => form_params,
791
+ :body => post_body,
792
+ :auth_names => auth_names,
793
+ :return_type => return_type
794
+ )
795
+
796
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
797
+ if @api_client.config.debugging
798
+ @api_client.config.logger.debug "API called: SMSApi#preflight_sms_registration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
799
+ end
800
+ return data, status_code, headers
801
+ end
802
+
735
803
  # Request a higher sender ID daily limit
736
804
  # 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.
737
805
  # @param request_sms_sender_id_limit_increase_request [RequestSmsSenderIdLimitIncreaseRequest]
@@ -863,6 +931,80 @@ module Zernio
863
931
  return data, status_code, headers
864
932
  end
865
933
 
934
+ # Reply to a change request
935
+ # Replies to a reviewer change request on a registration in `changes_requested` state: a note, hosted document URLs (from `POST /v1/sms/opt-in-proof`), or both, sent together. The registration returns to `requested` (back in review) — no need to resubmit the whole registration. To change the submitted brand/campaign fields themselves, resubmit via `POST /v1/sms/registrations` with `resubmitRequestId` instead.
936
+ # @param id [String]
937
+ # @param respond_to_sms_registration_review_request [RespondToSmsRegistrationReviewRequest]
938
+ # @param [Hash] opts the optional parameters
939
+ # @return [RespondToSmsRegistrationReview200Response]
940
+ def respond_to_sms_registration_review(id, respond_to_sms_registration_review_request, opts = {})
941
+ data, _status_code, _headers = respond_to_sms_registration_review_with_http_info(id, respond_to_sms_registration_review_request, opts)
942
+ data
943
+ end
944
+
945
+ # Reply to a change request
946
+ # Replies to a reviewer change request on a registration in &#x60;changes_requested&#x60; state: a note, hosted document URLs (from &#x60;POST /v1/sms/opt-in-proof&#x60;), or both, sent together. The registration returns to &#x60;requested&#x60; (back in review) — no need to resubmit the whole registration. To change the submitted brand/campaign fields themselves, resubmit via &#x60;POST /v1/sms/registrations&#x60; with &#x60;resubmitRequestId&#x60; instead.
947
+ # @param id [String]
948
+ # @param respond_to_sms_registration_review_request [RespondToSmsRegistrationReviewRequest]
949
+ # @param [Hash] opts the optional parameters
950
+ # @return [Array<(RespondToSmsRegistrationReview200Response, Integer, Hash)>] RespondToSmsRegistrationReview200Response data, response status code and response headers
951
+ def respond_to_sms_registration_review_with_http_info(id, respond_to_sms_registration_review_request, opts = {})
952
+ if @api_client.config.debugging
953
+ @api_client.config.logger.debug 'Calling API: SMSApi.respond_to_sms_registration_review ...'
954
+ end
955
+ # verify the required parameter 'id' is set
956
+ if @api_client.config.client_side_validation && id.nil?
957
+ fail ArgumentError, "Missing the required parameter 'id' when calling SMSApi.respond_to_sms_registration_review"
958
+ end
959
+ # verify the required parameter 'respond_to_sms_registration_review_request' is set
960
+ if @api_client.config.client_side_validation && respond_to_sms_registration_review_request.nil?
961
+ fail ArgumentError, "Missing the required parameter 'respond_to_sms_registration_review_request' when calling SMSApi.respond_to_sms_registration_review"
962
+ end
963
+ # resource path
964
+ local_var_path = '/v1/sms/registrations/{id}/respond'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
965
+
966
+ # query parameters
967
+ query_params = opts[:query_params] || {}
968
+
969
+ # header parameters
970
+ header_params = opts[:header_params] || {}
971
+ # HTTP header 'Accept' (if needed)
972
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
973
+ # HTTP header 'Content-Type'
974
+ content_type = @api_client.select_header_content_type(['application/json'])
975
+ if !content_type.nil?
976
+ header_params['Content-Type'] = content_type
977
+ end
978
+
979
+ # form parameters
980
+ form_params = opts[:form_params] || {}
981
+
982
+ # http body (model)
983
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(respond_to_sms_registration_review_request)
984
+
985
+ # return_type
986
+ return_type = opts[:debug_return_type] || 'RespondToSmsRegistrationReview200Response'
987
+
988
+ # auth_names
989
+ auth_names = opts[:debug_auth_names] || ['bearerAuth']
990
+
991
+ new_options = opts.merge(
992
+ :operation => :"SMSApi.respond_to_sms_registration_review",
993
+ :header_params => header_params,
994
+ :query_params => query_params,
995
+ :form_params => form_params,
996
+ :body => post_body,
997
+ :auth_names => auth_names,
998
+ :return_type => return_type
999
+ )
1000
+
1001
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1002
+ if @api_client.config.debugging
1003
+ @api_client.config.logger.debug "API called: SMSApi#respond_to_sms_registration_review\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1004
+ end
1005
+ return data, status_code, headers
1006
+ end
1007
+
866
1008
  # Add number to SMS registration
867
1009
  # Attaches this number to your existing approved 10DLC campaign instead of running a fresh registration: the number inherits the campaign's approval (no new brand or campaign, no extra carrier fee). Enable SMS on the number first (`POST /v1/phone-numbers/{id}/sms`; its response tells you whether a reusable registration exists).
868
1010
  # @param id [String]
@@ -20,7 +20,7 @@ module Zernio
20
20
  @api_client = api_client
21
21
  end
22
22
  # Create webhook
23
- # Create a new webhook configuration. Maximum 10 webhooks per user. `name`, `url` and `events` are required. `url` must be a valid URL and `events` must contain at least one event. Whitespace is trimmed from `url` before validation. Webhooks are automatically disabled after 10 consecutive delivery failures.
23
+ # Create a new webhook configuration. Maximum 50 webhooks per user. `name`, `url` and `events` are required. `url` must be a valid URL and `events` must contain at least one event. Whitespace is trimmed from `url` before validation. Webhooks are automatically disabled after 10 consecutive delivery failures.
24
24
  # @param create_webhook_settings_request [CreateWebhookSettingsRequest]
25
25
  # @param [Hash] opts the optional parameters
26
26
  # @return [UpdateWebhookSettings200Response]
@@ -30,7 +30,7 @@ module Zernio
30
30
  end
31
31
 
32
32
  # Create webhook
33
- # Create a new webhook configuration. Maximum 10 webhooks per user. &#x60;name&#x60;, &#x60;url&#x60; and &#x60;events&#x60; are required. &#x60;url&#x60; must be a valid URL and &#x60;events&#x60; must contain at least one event. Whitespace is trimmed from &#x60;url&#x60; before validation. Webhooks are automatically disabled after 10 consecutive delivery failures.
33
+ # Create a new webhook configuration. Maximum 50 webhooks per user. &#x60;name&#x60;, &#x60;url&#x60; and &#x60;events&#x60; are required. &#x60;url&#x60; must be a valid URL and &#x60;events&#x60; must contain at least one event. Whitespace is trimmed from &#x60;url&#x60; before validation. Webhooks are automatically disabled after 10 consecutive delivery failures.
34
34
  # @param create_webhook_settings_request [CreateWebhookSettingsRequest]
35
35
  # @param [Hash] opts the optional parameters
36
36
  # @return [Array<(UpdateWebhookSettings200Response, Integer, Hash)>] UpdateWebhookSettings200Response data, response status code and response headers
@@ -271,7 +271,7 @@ module Zernio
271
271
  end
272
272
 
273
273
  # List webhooks
274
- # Retrieve all configured webhooks for the authenticated user. Supports up to 10 webhooks per user.
274
+ # Retrieve all configured webhooks for the authenticated user. Supports up to 50 webhooks per user.
275
275
  # @param [Hash] opts the optional parameters
276
276
  # @return [GetWebhookSettings200Response]
277
277
  def get_webhook_settings(opts = {})
@@ -280,7 +280,7 @@ module Zernio
280
280
  end
281
281
 
282
282
  # List webhooks
283
- # Retrieve all configured webhooks for the authenticated user. Supports up to 10 webhooks per user.
283
+ # Retrieve all configured webhooks for the authenticated user. Supports up to 50 webhooks per user.
284
284
  # @param [Hash] opts the optional parameters
285
285
  # @return [Array<(GetWebhookSettings200Response, Integer, Hash)>] GetWebhookSettings200Response data, response status code and response headers
286
286
  def get_webhook_settings_with_http_info(opts = {})