zyphr 0.1.30 → 0.1.31

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 (32) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +2 -14
  3. data/docs/DomainsApi.md +2 -290
  4. data/lib/zyphr/api/domains_api.rb +2 -254
  5. data/lib/zyphr.rb +0 -8
  6. data/spec/api/domains_api_spec.rb +0 -48
  7. data/zyphr.gemspec +1 -1
  8. metadata +1 -33
  9. data/docs/DeleteDomainResponse.md +0 -20
  10. data/docs/DeleteDomainResponseData.md +0 -20
  11. data/docs/GetDomain200Response.md +0 -20
  12. data/docs/GetDomain200ResponseMeta.md +0 -18
  13. data/docs/VerificationStatusResponse.md +0 -20
  14. data/docs/VerificationStatusResponseData.md +0 -32
  15. data/docs/VerifyDomainResponse.md +0 -20
  16. data/docs/VerifyDomainResponseData.md +0 -24
  17. data/lib/zyphr/models/delete_domain_response.rb +0 -263
  18. data/lib/zyphr/models/delete_domain_response_data.rb +0 -263
  19. data/lib/zyphr/models/get_domain200_response.rb +0 -229
  20. data/lib/zyphr/models/get_domain200_response_meta.rb +0 -220
  21. data/lib/zyphr/models/verification_status_response.rb +0 -263
  22. data/lib/zyphr/models/verification_status_response_data.rb +0 -415
  23. data/lib/zyphr/models/verify_domain_response.rb +0 -263
  24. data/lib/zyphr/models/verify_domain_response_data.rb +0 -339
  25. data/spec/models/delete_domain_response_data_spec.rb +0 -42
  26. data/spec/models/delete_domain_response_spec.rb +0 -42
  27. data/spec/models/get_domain200_response_meta_spec.rb +0 -36
  28. data/spec/models/get_domain200_response_spec.rb +0 -42
  29. data/spec/models/verification_status_response_data_spec.rb +0 -82
  30. data/spec/models/verification_status_response_spec.rb +0 -42
  31. data/spec/models/verify_domain_response_data_spec.rb +0 -58
  32. data/spec/models/verify_domain_response_spec.rb +0 -42
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 66f94994637ec053fa5f9f8b06f18100b9b36cea273a621e829a96a9fb63380d
4
- data.tar.gz: 5de6264f0d9351baf0366121f63beb2810fd386eec9b716ed9c9fe15acc0b5fd
3
+ metadata.gz: 13105132a3b74de40f61e28fea625febb8d519847ca75de7c92db81484d74947
4
+ data.tar.gz: ac2f6c5662e5ce834c23ea898446dda8d1077595999d0e8ecbca90feb690a972
5
5
  SHA512:
6
- metadata.gz: 1d36f0b3a9ce887388fc0b44407952b92826388359df2f48137a7003818e4c0a03fe2c00502cc19c5f1ee49f39a50f4a1d6a89b0c93d59a5fc32035351855b01
7
- data.tar.gz: 41e1288638d3924a86f1807dc9ac9ae08cdd5cb478699d2c3bba9592818e375d431f47e3bca0ad0850ca5076cce5d29a2c83637975a68dffca3449162270aa25
6
+ metadata.gz: c9556352fd88d718cb012929ffaa8929d681e12c285cca0021fa5fe31ab9bc2dc04888d826c756dfd1394f3ca84e42540b2f2623d6022d75258f60cf5a29711f
7
+ data.tar.gz: 30b86c16eed45cc97e9be69de2daf79bb92fdfe7ccadd31057d3900f2688c8d9aa09e768524a9d1288d5cbc74be553eec9457bed6cc64d8c345e1d9a801a60bf
data/README.md CHANGED
@@ -192,12 +192,8 @@ Class | Method | HTTP request | Description
192
192
  *Zyphr::DevicesApi* | [**get_device_stats**](docs/DevicesApi.md#get_device_stats) | **GET** /devices/stats | Get device statistics
193
193
  *Zyphr::DevicesApi* | [**list_devices**](docs/DevicesApi.md#list_devices) | **GET** /devices | List devices
194
194
  *Zyphr::DevicesApi* | [**register_device**](docs/DevicesApi.md#register_device) | **POST** /devices | Register a device
195
- *Zyphr::DomainsApi* | [**add_domain**](docs/DomainsApi.md#add_domain) | **POST** /v1/domains | Add a sending domain
196
- *Zyphr::DomainsApi* | [**delete_domain**](docs/DomainsApi.md#delete_domain) | **DELETE** /v1/domains/{id} | Remove a sending domain
197
- *Zyphr::DomainsApi* | [**get_domain**](docs/DomainsApi.md#get_domain) | **GET** /v1/domains/{id} | Get a sending domain
198
- *Zyphr::DomainsApi* | [**get_domain_verification_status**](docs/DomainsApi.md#get_domain_verification_status) | **GET** /v1/domains/{id}/verification-status | Get domain verification status
199
- *Zyphr::DomainsApi* | [**list_domains**](docs/DomainsApi.md#list_domains) | **GET** /v1/domains | List sending domains
200
- *Zyphr::DomainsApi* | [**verify_domain**](docs/DomainsApi.md#verify_domain) | **POST** /v1/domains/{id}/verify | Trigger domain verification
195
+ *Zyphr::DomainsApi* | [**add_domain**](docs/DomainsApi.md#add_domain) | **POST** /domains | Add a sending domain
196
+ *Zyphr::DomainsApi* | [**list_domains**](docs/DomainsApi.md#list_domains) | **GET** /domains | List sending domains
201
197
  *Zyphr::EmailsApi* | [**get_email**](docs/EmailsApi.md#get_email) | **GET** /emails/{id} | Get email details
202
198
  *Zyphr::EmailsApi* | [**get_email_events**](docs/EmailsApi.md#get_email_events) | **GET** /emails/{id}/events | Get email events
203
199
  *Zyphr::EmailsApi* | [**get_email_tracking**](docs/EmailsApi.md#get_email_tracking) | **GET** /emails/{id}/tracking | Get email tracking stats
@@ -408,8 +404,6 @@ Class | Method | HTTP request | Description
408
404
  - [Zyphr::CreateWaaSEventType201Response](docs/CreateWaaSEventType201Response.md)
409
405
  - [Zyphr::CreateWaaSEventTypeRequest](docs/CreateWaaSEventTypeRequest.md)
410
406
  - [Zyphr::CreateWebhookRequest](docs/CreateWebhookRequest.md)
411
- - [Zyphr::DeleteDomainResponse](docs/DeleteDomainResponse.md)
412
- - [Zyphr::DeleteDomainResponseData](docs/DeleteDomainResponseData.md)
413
407
  - [Zyphr::DeleteResult](docs/DeleteResult.md)
414
408
  - [Zyphr::DeleteResultData](docs/DeleteResultData.md)
415
409
  - [Zyphr::Device](docs/Device.md)
@@ -448,8 +442,6 @@ Class | Method | HTTP request | Description
448
442
  - [Zyphr::GenerateSubscriberToken200ResponseData](docs/GenerateSubscriberToken200ResponseData.md)
449
443
  - [Zyphr::GenerateSubscriberTokenRequest](docs/GenerateSubscriberTokenRequest.md)
450
444
  - [Zyphr::GenerateWaaSPortalToken201Response](docs/GenerateWaaSPortalToken201Response.md)
451
- - [Zyphr::GetDomain200Response](docs/GetDomain200Response.md)
452
- - [Zyphr::GetDomain200ResponseMeta](docs/GetDomain200ResponseMeta.md)
453
445
  - [Zyphr::GetWaaSEndpoint200Response](docs/GetWaaSEndpoint200Response.md)
454
446
  - [Zyphr::GetWaaSUsage200Response](docs/GetWaaSUsage200Response.md)
455
447
  - [Zyphr::InAppNotification](docs/InAppNotification.md)
@@ -662,10 +654,6 @@ Class | Method | HTTP request | Description
662
654
  - [Zyphr::ValidateResetTokenRequest](docs/ValidateResetTokenRequest.md)
663
655
  - [Zyphr::ValidateResetTokenResponse](docs/ValidateResetTokenResponse.md)
664
656
  - [Zyphr::ValidateResetTokenResponseData](docs/ValidateResetTokenResponseData.md)
665
- - [Zyphr::VerificationStatusResponse](docs/VerificationStatusResponse.md)
666
- - [Zyphr::VerificationStatusResponseData](docs/VerificationStatusResponseData.md)
667
- - [Zyphr::VerifyDomainResponse](docs/VerifyDomainResponse.md)
668
- - [Zyphr::VerifyDomainResponseData](docs/VerifyDomainResponseData.md)
669
657
  - [Zyphr::VerifySmsConfigData](docs/VerifySmsConfigData.md)
670
658
  - [Zyphr::VerifySmsConfigResponse](docs/VerifySmsConfigResponse.md)
671
659
  - [Zyphr::WaaSApplication](docs/WaaSApplication.md)
data/docs/DomainsApi.md CHANGED
@@ -4,12 +4,8 @@ All URIs are relative to *https://api.zyphr.dev/v1*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
- | [**add_domain**](DomainsApi.md#add_domain) | **POST** /v1/domains | Add a sending domain |
8
- | [**delete_domain**](DomainsApi.md#delete_domain) | **DELETE** /v1/domains/{id} | Remove a sending domain |
9
- | [**get_domain**](DomainsApi.md#get_domain) | **GET** /v1/domains/{id} | Get a sending domain |
10
- | [**get_domain_verification_status**](DomainsApi.md#get_domain_verification_status) | **GET** /v1/domains/{id}/verification-status | Get domain verification status |
11
- | [**list_domains**](DomainsApi.md#list_domains) | **GET** /v1/domains | List sending domains |
12
- | [**verify_domain**](DomainsApi.md#verify_domain) | **POST** /v1/domains/{id}/verify | Trigger domain verification |
7
+ | [**add_domain**](DomainsApi.md#add_domain) | **POST** /domains | Add a sending domain |
8
+ | [**list_domains**](DomainsApi.md#list_domains) | **GET** /domains | List sending domains |
13
9
 
14
10
 
15
11
  ## add_domain
@@ -83,219 +79,6 @@ end
83
79
  - **Accept**: application/json
84
80
 
85
81
 
86
- ## delete_domain
87
-
88
- > <DeleteDomainResponse> delete_domain(id)
89
-
90
- Remove a sending domain
91
-
92
- Remove a sending domain from the project. The domain is also detached from any SES identity that was provisioned for it. Returns 409 if the domain is still referenced by other resources (templates, scheduled sends, etc.) — those must be removed first.
93
-
94
- ### Examples
95
-
96
- ```ruby
97
- require 'time'
98
- require 'zyphr'
99
- # setup authorization
100
- Zyphr.configure do |config|
101
- # Configure API key authorization: ApiKeyAuth
102
- config.api_key['X-API-Key'] = 'YOUR API KEY'
103
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
104
- # config.api_key_prefix['X-API-Key'] = 'Bearer'
105
- end
106
-
107
- api_instance = Zyphr::DomainsApi.new
108
- id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
109
-
110
- begin
111
- # Remove a sending domain
112
- result = api_instance.delete_domain(id)
113
- p result
114
- rescue Zyphr::ApiError => e
115
- puts "Error when calling DomainsApi->delete_domain: #{e}"
116
- end
117
- ```
118
-
119
- #### Using the delete_domain_with_http_info variant
120
-
121
- This returns an Array which contains the response data, status code and headers.
122
-
123
- > <Array(<DeleteDomainResponse>, Integer, Hash)> delete_domain_with_http_info(id)
124
-
125
- ```ruby
126
- begin
127
- # Remove a sending domain
128
- data, status_code, headers = api_instance.delete_domain_with_http_info(id)
129
- p status_code # => 2xx
130
- p headers # => { ... }
131
- p data # => <DeleteDomainResponse>
132
- rescue Zyphr::ApiError => e
133
- puts "Error when calling DomainsApi->delete_domain_with_http_info: #{e}"
134
- end
135
- ```
136
-
137
- ### Parameters
138
-
139
- | Name | Type | Description | Notes |
140
- | ---- | ---- | ----------- | ----- |
141
- | **id** | **String** | | |
142
-
143
- ### Return type
144
-
145
- [**DeleteDomainResponse**](DeleteDomainResponse.md)
146
-
147
- ### Authorization
148
-
149
- [ApiKeyAuth](../README.md#ApiKeyAuth)
150
-
151
- ### HTTP request headers
152
-
153
- - **Content-Type**: Not defined
154
- - **Accept**: application/json
155
-
156
-
157
- ## get_domain
158
-
159
- > <GetDomain200Response> get_domain(id)
160
-
161
- Get a sending domain
162
-
163
- Retrieve a single sending domain by ID, including DNS records and verification counters.
164
-
165
- ### Examples
166
-
167
- ```ruby
168
- require 'time'
169
- require 'zyphr'
170
- # setup authorization
171
- Zyphr.configure do |config|
172
- # Configure API key authorization: ApiKeyAuth
173
- config.api_key['X-API-Key'] = 'YOUR API KEY'
174
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
175
- # config.api_key_prefix['X-API-Key'] = 'Bearer'
176
- end
177
-
178
- api_instance = Zyphr::DomainsApi.new
179
- id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
180
-
181
- begin
182
- # Get a sending domain
183
- result = api_instance.get_domain(id)
184
- p result
185
- rescue Zyphr::ApiError => e
186
- puts "Error when calling DomainsApi->get_domain: #{e}"
187
- end
188
- ```
189
-
190
- #### Using the get_domain_with_http_info variant
191
-
192
- This returns an Array which contains the response data, status code and headers.
193
-
194
- > <Array(<GetDomain200Response>, Integer, Hash)> get_domain_with_http_info(id)
195
-
196
- ```ruby
197
- begin
198
- # Get a sending domain
199
- data, status_code, headers = api_instance.get_domain_with_http_info(id)
200
- p status_code # => 2xx
201
- p headers # => { ... }
202
- p data # => <GetDomain200Response>
203
- rescue Zyphr::ApiError => e
204
- puts "Error when calling DomainsApi->get_domain_with_http_info: #{e}"
205
- end
206
- ```
207
-
208
- ### Parameters
209
-
210
- | Name | Type | Description | Notes |
211
- | ---- | ---- | ----------- | ----- |
212
- | **id** | **String** | | |
213
-
214
- ### Return type
215
-
216
- [**GetDomain200Response**](GetDomain200Response.md)
217
-
218
- ### Authorization
219
-
220
- [ApiKeyAuth](../README.md#ApiKeyAuth)
221
-
222
- ### HTTP request headers
223
-
224
- - **Content-Type**: Not defined
225
- - **Accept**: application/json
226
-
227
-
228
- ## get_domain_verification_status
229
-
230
- > <VerificationStatusResponse> get_domain_verification_status(id)
231
-
232
- Get domain verification status
233
-
234
- Returns the current verification status with per-record `verified` flags and aggregate counters. Useful when polling for terminal status from an AI agent (the recommended pattern is to subscribe to the `domain.verified` webhook event instead — see sc-5444).
235
-
236
- ### Examples
237
-
238
- ```ruby
239
- require 'time'
240
- require 'zyphr'
241
- # setup authorization
242
- Zyphr.configure do |config|
243
- # Configure API key authorization: ApiKeyAuth
244
- config.api_key['X-API-Key'] = 'YOUR API KEY'
245
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
246
- # config.api_key_prefix['X-API-Key'] = 'Bearer'
247
- end
248
-
249
- api_instance = Zyphr::DomainsApi.new
250
- id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Domain ID
251
-
252
- begin
253
- # Get domain verification status
254
- result = api_instance.get_domain_verification_status(id)
255
- p result
256
- rescue Zyphr::ApiError => e
257
- puts "Error when calling DomainsApi->get_domain_verification_status: #{e}"
258
- end
259
- ```
260
-
261
- #### Using the get_domain_verification_status_with_http_info variant
262
-
263
- This returns an Array which contains the response data, status code and headers.
264
-
265
- > <Array(<VerificationStatusResponse>, Integer, Hash)> get_domain_verification_status_with_http_info(id)
266
-
267
- ```ruby
268
- begin
269
- # Get domain verification status
270
- data, status_code, headers = api_instance.get_domain_verification_status_with_http_info(id)
271
- p status_code # => 2xx
272
- p headers # => { ... }
273
- p data # => <VerificationStatusResponse>
274
- rescue Zyphr::ApiError => e
275
- puts "Error when calling DomainsApi->get_domain_verification_status_with_http_info: #{e}"
276
- end
277
- ```
278
-
279
- ### Parameters
280
-
281
- | Name | Type | Description | Notes |
282
- | ---- | ---- | ----------- | ----- |
283
- | **id** | **String** | Domain ID | |
284
-
285
- ### Return type
286
-
287
- [**VerificationStatusResponse**](VerificationStatusResponse.md)
288
-
289
- ### Authorization
290
-
291
- [ApiKeyAuth](../README.md#ApiKeyAuth)
292
-
293
- ### HTTP request headers
294
-
295
- - **Content-Type**: Not defined
296
- - **Accept**: application/json
297
-
298
-
299
82
  ## list_domains
300
83
 
301
84
  > <DomainListResponse> list_domains
@@ -363,74 +146,3 @@ This endpoint does not need any parameter.
363
146
  - **Content-Type**: Not defined
364
147
  - **Accept**: application/json
365
148
 
366
-
367
- ## verify_domain
368
-
369
- > <VerifyDomainResponse> verify_domain(id)
370
-
371
- Trigger domain verification
372
-
373
- Queue an asynchronous DNS verification check. Returns immediately with a `job_id`. Poll `GET /v1/domains/{id}/verification-status` (or the higher-level `GET /v1/domains/{id}`) for the result, or subscribe to the `domain.verified` webhook event when sc-5444 ships. Returns 409 if a verification is already in progress for this domain (within the last 2 minutes).
374
-
375
- ### Examples
376
-
377
- ```ruby
378
- require 'time'
379
- require 'zyphr'
380
- # setup authorization
381
- Zyphr.configure do |config|
382
- # Configure API key authorization: ApiKeyAuth
383
- config.api_key['X-API-Key'] = 'YOUR API KEY'
384
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
385
- # config.api_key_prefix['X-API-Key'] = 'Bearer'
386
- end
387
-
388
- api_instance = Zyphr::DomainsApi.new
389
- id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
390
-
391
- begin
392
- # Trigger domain verification
393
- result = api_instance.verify_domain(id)
394
- p result
395
- rescue Zyphr::ApiError => e
396
- puts "Error when calling DomainsApi->verify_domain: #{e}"
397
- end
398
- ```
399
-
400
- #### Using the verify_domain_with_http_info variant
401
-
402
- This returns an Array which contains the response data, status code and headers.
403
-
404
- > <Array(<VerifyDomainResponse>, Integer, Hash)> verify_domain_with_http_info(id)
405
-
406
- ```ruby
407
- begin
408
- # Trigger domain verification
409
- data, status_code, headers = api_instance.verify_domain_with_http_info(id)
410
- p status_code # => 2xx
411
- p headers # => { ... }
412
- p data # => <VerifyDomainResponse>
413
- rescue Zyphr::ApiError => e
414
- puts "Error when calling DomainsApi->verify_domain_with_http_info: #{e}"
415
- end
416
- ```
417
-
418
- ### Parameters
419
-
420
- | Name | Type | Description | Notes |
421
- | ---- | ---- | ----------- | ----- |
422
- | **id** | **String** | | |
423
-
424
- ### Return type
425
-
426
- [**VerifyDomainResponse**](VerifyDomainResponse.md)
427
-
428
- ### Authorization
429
-
430
- [ApiKeyAuth](../README.md#ApiKeyAuth)
431
-
432
- ### HTTP request headers
433
-
434
- - **Content-Type**: Not defined
435
- - **Accept**: application/json
436
-
@@ -43,7 +43,7 @@ module Zyphr
43
43
  fail ArgumentError, "Missing the required parameter 'add_domain_request' when calling DomainsApi.add_domain"
44
44
  end
45
45
  # resource path
46
- local_var_path = '/v1/domains'
46
+ local_var_path = '/domains'
47
47
 
48
48
  # query parameters
49
49
  query_params = opts[:query_params] || {}
@@ -87,195 +87,6 @@ module Zyphr
87
87
  return data, status_code, headers
88
88
  end
89
89
 
90
- # Remove a sending domain
91
- # Remove a sending domain from the project. The domain is also detached from any SES identity that was provisioned for it. Returns 409 if the domain is still referenced by other resources (templates, scheduled sends, etc.) — those must be removed first.
92
- # @param id [String]
93
- # @param [Hash] opts the optional parameters
94
- # @return [DeleteDomainResponse]
95
- def delete_domain(id, opts = {})
96
- data, _status_code, _headers = delete_domain_with_http_info(id, opts)
97
- data
98
- end
99
-
100
- # Remove a sending domain
101
- # Remove a sending domain from the project. The domain is also detached from any SES identity that was provisioned for it. Returns 409 if the domain is still referenced by other resources (templates, scheduled sends, etc.) — those must be removed first.
102
- # @param id [String]
103
- # @param [Hash] opts the optional parameters
104
- # @return [Array<(DeleteDomainResponse, Integer, Hash)>] DeleteDomainResponse data, response status code and response headers
105
- def delete_domain_with_http_info(id, opts = {})
106
- if @api_client.config.debugging
107
- @api_client.config.logger.debug 'Calling API: DomainsApi.delete_domain ...'
108
- end
109
- # verify the required parameter 'id' is set
110
- if @api_client.config.client_side_validation && id.nil?
111
- fail ArgumentError, "Missing the required parameter 'id' when calling DomainsApi.delete_domain"
112
- end
113
- # resource path
114
- local_var_path = '/v1/domains/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
115
-
116
- # query parameters
117
- query_params = opts[:query_params] || {}
118
-
119
- # header parameters
120
- header_params = opts[:header_params] || {}
121
- # HTTP header 'Accept' (if needed)
122
- header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
123
-
124
- # form parameters
125
- form_params = opts[:form_params] || {}
126
-
127
- # http body (model)
128
- post_body = opts[:debug_body]
129
-
130
- # return_type
131
- return_type = opts[:debug_return_type] || 'DeleteDomainResponse'
132
-
133
- # auth_names
134
- auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
135
-
136
- new_options = opts.merge(
137
- :operation => :"DomainsApi.delete_domain",
138
- :header_params => header_params,
139
- :query_params => query_params,
140
- :form_params => form_params,
141
- :body => post_body,
142
- :auth_names => auth_names,
143
- :return_type => return_type
144
- )
145
-
146
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
147
- if @api_client.config.debugging
148
- @api_client.config.logger.debug "API called: DomainsApi#delete_domain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
149
- end
150
- return data, status_code, headers
151
- end
152
-
153
- # Get a sending domain
154
- # Retrieve a single sending domain by ID, including DNS records and verification counters.
155
- # @param id [String]
156
- # @param [Hash] opts the optional parameters
157
- # @return [GetDomain200Response]
158
- def get_domain(id, opts = {})
159
- data, _status_code, _headers = get_domain_with_http_info(id, opts)
160
- data
161
- end
162
-
163
- # Get a sending domain
164
- # Retrieve a single sending domain by ID, including DNS records and verification counters.
165
- # @param id [String]
166
- # @param [Hash] opts the optional parameters
167
- # @return [Array<(GetDomain200Response, Integer, Hash)>] GetDomain200Response data, response status code and response headers
168
- def get_domain_with_http_info(id, opts = {})
169
- if @api_client.config.debugging
170
- @api_client.config.logger.debug 'Calling API: DomainsApi.get_domain ...'
171
- end
172
- # verify the required parameter 'id' is set
173
- if @api_client.config.client_side_validation && id.nil?
174
- fail ArgumentError, "Missing the required parameter 'id' when calling DomainsApi.get_domain"
175
- end
176
- # resource path
177
- local_var_path = '/v1/domains/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
178
-
179
- # query parameters
180
- query_params = opts[:query_params] || {}
181
-
182
- # header parameters
183
- header_params = opts[:header_params] || {}
184
- # HTTP header 'Accept' (if needed)
185
- header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
186
-
187
- # form parameters
188
- form_params = opts[:form_params] || {}
189
-
190
- # http body (model)
191
- post_body = opts[:debug_body]
192
-
193
- # return_type
194
- return_type = opts[:debug_return_type] || 'GetDomain200Response'
195
-
196
- # auth_names
197
- auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
198
-
199
- new_options = opts.merge(
200
- :operation => :"DomainsApi.get_domain",
201
- :header_params => header_params,
202
- :query_params => query_params,
203
- :form_params => form_params,
204
- :body => post_body,
205
- :auth_names => auth_names,
206
- :return_type => return_type
207
- )
208
-
209
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
210
- if @api_client.config.debugging
211
- @api_client.config.logger.debug "API called: DomainsApi#get_domain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
212
- end
213
- return data, status_code, headers
214
- end
215
-
216
- # Get domain verification status
217
- # Returns the current verification status with per-record `verified` flags and aggregate counters. Useful when polling for terminal status from an AI agent (the recommended pattern is to subscribe to the `domain.verified` webhook event instead — see sc-5444).
218
- # @param id [String] Domain ID
219
- # @param [Hash] opts the optional parameters
220
- # @return [VerificationStatusResponse]
221
- def get_domain_verification_status(id, opts = {})
222
- data, _status_code, _headers = get_domain_verification_status_with_http_info(id, opts)
223
- data
224
- end
225
-
226
- # Get domain verification status
227
- # Returns the current verification status with per-record &#x60;verified&#x60; flags and aggregate counters. Useful when polling for terminal status from an AI agent (the recommended pattern is to subscribe to the &#x60;domain.verified&#x60; webhook event instead — see sc-5444).
228
- # @param id [String] Domain ID
229
- # @param [Hash] opts the optional parameters
230
- # @return [Array<(VerificationStatusResponse, Integer, Hash)>] VerificationStatusResponse data, response status code and response headers
231
- def get_domain_verification_status_with_http_info(id, opts = {})
232
- if @api_client.config.debugging
233
- @api_client.config.logger.debug 'Calling API: DomainsApi.get_domain_verification_status ...'
234
- end
235
- # verify the required parameter 'id' is set
236
- if @api_client.config.client_side_validation && id.nil?
237
- fail ArgumentError, "Missing the required parameter 'id' when calling DomainsApi.get_domain_verification_status"
238
- end
239
- # resource path
240
- local_var_path = '/v1/domains/{id}/verification-status'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
241
-
242
- # query parameters
243
- query_params = opts[:query_params] || {}
244
-
245
- # header parameters
246
- header_params = opts[:header_params] || {}
247
- # HTTP header 'Accept' (if needed)
248
- header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
249
-
250
- # form parameters
251
- form_params = opts[:form_params] || {}
252
-
253
- # http body (model)
254
- post_body = opts[:debug_body]
255
-
256
- # return_type
257
- return_type = opts[:debug_return_type] || 'VerificationStatusResponse'
258
-
259
- # auth_names
260
- auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
261
-
262
- new_options = opts.merge(
263
- :operation => :"DomainsApi.get_domain_verification_status",
264
- :header_params => header_params,
265
- :query_params => query_params,
266
- :form_params => form_params,
267
- :body => post_body,
268
- :auth_names => auth_names,
269
- :return_type => return_type
270
- )
271
-
272
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
273
- if @api_client.config.debugging
274
- @api_client.config.logger.debug "API called: DomainsApi#get_domain_verification_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
275
- end
276
- return data, status_code, headers
277
- end
278
-
279
90
  # List sending domains
280
91
  # List sending domains on the current project, with verification status and DNS records.
281
92
  # @param [Hash] opts the optional parameters
@@ -294,7 +105,7 @@ module Zyphr
294
105
  @api_client.config.logger.debug 'Calling API: DomainsApi.list_domains ...'
295
106
  end
296
107
  # resource path
297
- local_var_path = '/v1/domains'
108
+ local_var_path = '/domains'
298
109
 
299
110
  # query parameters
300
111
  query_params = opts[:query_params] || {}
@@ -332,68 +143,5 @@ module Zyphr
332
143
  end
333
144
  return data, status_code, headers
334
145
  end
335
-
336
- # Trigger domain verification
337
- # Queue an asynchronous DNS verification check. Returns immediately with a `job_id`. Poll `GET /v1/domains/{id}/verification-status` (or the higher-level `GET /v1/domains/{id}`) for the result, or subscribe to the `domain.verified` webhook event when sc-5444 ships. Returns 409 if a verification is already in progress for this domain (within the last 2 minutes).
338
- # @param id [String]
339
- # @param [Hash] opts the optional parameters
340
- # @return [VerifyDomainResponse]
341
- def verify_domain(id, opts = {})
342
- data, _status_code, _headers = verify_domain_with_http_info(id, opts)
343
- data
344
- end
345
-
346
- # Trigger domain verification
347
- # Queue an asynchronous DNS verification check. Returns immediately with a &#x60;job_id&#x60;. Poll &#x60;GET /v1/domains/{id}/verification-status&#x60; (or the higher-level &#x60;GET /v1/domains/{id}&#x60;) for the result, or subscribe to the &#x60;domain.verified&#x60; webhook event when sc-5444 ships. Returns 409 if a verification is already in progress for this domain (within the last 2 minutes).
348
- # @param id [String]
349
- # @param [Hash] opts the optional parameters
350
- # @return [Array<(VerifyDomainResponse, Integer, Hash)>] VerifyDomainResponse data, response status code and response headers
351
- def verify_domain_with_http_info(id, opts = {})
352
- if @api_client.config.debugging
353
- @api_client.config.logger.debug 'Calling API: DomainsApi.verify_domain ...'
354
- end
355
- # verify the required parameter 'id' is set
356
- if @api_client.config.client_side_validation && id.nil?
357
- fail ArgumentError, "Missing the required parameter 'id' when calling DomainsApi.verify_domain"
358
- end
359
- # resource path
360
- local_var_path = '/v1/domains/{id}/verify'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
361
-
362
- # query parameters
363
- query_params = opts[:query_params] || {}
364
-
365
- # header parameters
366
- header_params = opts[:header_params] || {}
367
- # HTTP header 'Accept' (if needed)
368
- header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
369
-
370
- # form parameters
371
- form_params = opts[:form_params] || {}
372
-
373
- # http body (model)
374
- post_body = opts[:debug_body]
375
-
376
- # return_type
377
- return_type = opts[:debug_return_type] || 'VerifyDomainResponse'
378
-
379
- # auth_names
380
- auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
381
-
382
- new_options = opts.merge(
383
- :operation => :"DomainsApi.verify_domain",
384
- :header_params => header_params,
385
- :query_params => query_params,
386
- :form_params => form_params,
387
- :body => post_body,
388
- :auth_names => auth_names,
389
- :return_type => return_type
390
- )
391
-
392
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
393
- if @api_client.config.debugging
394
- @api_client.config.logger.debug "API called: DomainsApi#verify_domain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
395
- end
396
- return data, status_code, headers
397
- end
398
146
  end
399
147
  end
data/lib/zyphr.rb CHANGED
@@ -86,8 +86,6 @@ require 'zyphr/models/create_waa_s_endpoint_response'
86
86
  require 'zyphr/models/create_waa_s_event_type201_response'
87
87
  require 'zyphr/models/create_waa_s_event_type_request'
88
88
  require 'zyphr/models/create_webhook_request'
89
- require 'zyphr/models/delete_domain_response'
90
- require 'zyphr/models/delete_domain_response_data'
91
89
  require 'zyphr/models/delete_result'
92
90
  require 'zyphr/models/delete_result_data'
93
91
  require 'zyphr/models/device'
@@ -126,8 +124,6 @@ require 'zyphr/models/generate_subscriber_token200_response'
126
124
  require 'zyphr/models/generate_subscriber_token200_response_data'
127
125
  require 'zyphr/models/generate_subscriber_token_request'
128
126
  require 'zyphr/models/generate_waa_s_portal_token201_response'
129
- require 'zyphr/models/get_domain200_response'
130
- require 'zyphr/models/get_domain200_response_meta'
131
127
  require 'zyphr/models/get_waa_s_endpoint200_response'
132
128
  require 'zyphr/models/get_waa_s_usage200_response'
133
129
  require 'zyphr/models/in_app_notification'
@@ -340,10 +336,6 @@ require 'zyphr/models/user_devices_delete_response_data'
340
336
  require 'zyphr/models/validate_reset_token_request'
341
337
  require 'zyphr/models/validate_reset_token_response'
342
338
  require 'zyphr/models/validate_reset_token_response_data'
343
- require 'zyphr/models/verification_status_response'
344
- require 'zyphr/models/verification_status_response_data'
345
- require 'zyphr/models/verify_domain_response'
346
- require 'zyphr/models/verify_domain_response_data'
347
339
  require 'zyphr/models/verify_sms_config_data'
348
340
  require 'zyphr/models/verify_sms_config_response'
349
341
  require 'zyphr/models/waa_s_application'