zyphr 0.1.33 → 0.1.35
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +27 -13
- data/docs/AuthEmailOTPApi.md +384 -0
- data/docs/CheckEmailOtpAvailability200Response.md +18 -0
- data/docs/{PhoneAuthAvailabilityResponseData.md → CheckEmailOtpAvailability200ResponseData.md} +2 -2
- data/docs/DomainsApi.md +73 -0
- data/docs/InboundAttachmentUrlResponse.md +20 -0
- data/docs/InboundAttachmentUrlResponseData.md +22 -0
- data/docs/InboundEmail.md +48 -0
- data/docs/InboundEmailApi.md +235 -0
- data/docs/InboundEmailAttachment.md +24 -0
- data/docs/InboundEmailFrom.md +20 -0
- data/docs/InboundEmailListResponse.md +20 -0
- data/docs/InboundEmailListResponseMeta.md +24 -0
- data/docs/InboundEmailResponse.md +20 -0
- data/docs/PhoneAuthAvailabilityResponse.md +1 -1
- data/docs/SendEmailOtpRegistrationRequest.md +18 -0
- data/docs/SetDomainInboundRequest.md +18 -0
- data/docs/VerifyEmailOtpLoginRequest.md +22 -0
- data/docs/VerifyEmailOtpRegistrationRequest.md +24 -0
- data/lib/zyphr/api/auth_email_otp_api.rb +351 -0
- data/lib/zyphr/api/domains_api.rb +72 -0
- data/lib/zyphr/api/inbound_email_api.rb +234 -0
- data/lib/zyphr/models/check_email_otp_availability200_response.rb +220 -0
- data/lib/zyphr/models/{phone_auth_availability_response_data.rb → check_email_otp_availability200_response_data.rb} +3 -3
- data/lib/zyphr/models/inbound_attachment_url_response.rb +229 -0
- data/lib/zyphr/models/inbound_attachment_url_response_data.rb +240 -0
- data/lib/zyphr/models/inbound_email.rb +441 -0
- data/lib/zyphr/models/inbound_email_attachment.rb +250 -0
- data/lib/zyphr/models/inbound_email_from.rb +230 -0
- data/lib/zyphr/models/inbound_email_list_response.rb +231 -0
- data/lib/zyphr/models/inbound_email_list_response_meta.rb +247 -0
- data/lib/zyphr/models/inbound_email_response.rb +229 -0
- data/lib/zyphr/models/phone_auth_availability_response.rb +1 -1
- data/lib/zyphr/models/send_email_otp_registration_request.rb +237 -0
- data/lib/zyphr/models/set_domain_inbound_request.rb +220 -0
- data/lib/zyphr/models/verify_email_otp_login_request.rb +272 -0
- data/lib/zyphr/models/verify_email_otp_registration_request.rb +281 -0
- data/lib/zyphr.rb +16 -1
- data/spec/api/auth_email_otp_api_spec.rb +94 -0
- data/spec/api/domains_api_spec.rb +13 -0
- data/spec/api/inbound_email_api_spec.rb +76 -0
- data/spec/models/{phone_auth_availability_response_data_spec.rb → check_email_otp_availability200_response_data_spec.rb} +6 -6
- data/spec/models/check_email_otp_availability200_response_spec.rb +36 -0
- data/spec/models/inbound_attachment_url_response_data_spec.rb +48 -0
- data/spec/models/inbound_attachment_url_response_spec.rb +42 -0
- data/spec/models/inbound_email_attachment_spec.rb +54 -0
- data/spec/models/inbound_email_from_spec.rb +42 -0
- data/spec/models/inbound_email_list_response_meta_spec.rb +54 -0
- data/spec/models/inbound_email_list_response_spec.rb +42 -0
- data/spec/models/inbound_email_response_spec.rb +42 -0
- data/spec/models/inbound_email_spec.rb +142 -0
- data/spec/models/send_email_otp_registration_request_spec.rb +36 -0
- data/spec/models/set_domain_inbound_request_spec.rb +36 -0
- data/spec/models/verify_email_otp_login_request_spec.rb +48 -0
- data/spec/models/verify_email_otp_registration_request_spec.rb +54 -0
- data/zyphr.gemspec +1 -1
- metadata +470 -410
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: bbc90277332c8fd92e70a3dab17024c962e58c650f1331956da643d2cadb0aa0
|
|
4
|
+
data.tar.gz: 77cfebd35228ba5910ab9c3b460923fad441e067c4f2dd346ca87a06beefcc46
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 54011e02c71f5a0f3957eff79192beacc31519aec82545501a6ddf8583edb191767b77216d490400ec1f200f45bdf0d1685be166d47239e827644a57b76c9a89
|
|
7
|
+
data.tar.gz: dd0bb3b0099dcf756113f5295c72ec8e22a8476c4c55f8ffcccddca11414b08aa46fe8978179b94deb49d6e131c23f1febe0e6cda9c5fa10e3bebf6ae5c884d7
|
data/README.md
CHANGED
|
@@ -95,13 +95,6 @@ require 'zyphr'
|
|
|
95
95
|
|
|
96
96
|
# Setup authorization
|
|
97
97
|
Zyphr.configure do |config|
|
|
98
|
-
# Configure API key authorization: ApplicationSecret
|
|
99
|
-
config.api_key['X-Application-Secret'] = 'YOUR API KEY'
|
|
100
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
101
|
-
# config.api_key_prefix['X-Application-Secret'] = 'Bearer'
|
|
102
|
-
# Configure faraday connection
|
|
103
|
-
config.configure_faraday_connection { |connection| 'YOUR CONNECTION CONFIG PROC' }
|
|
104
|
-
|
|
105
98
|
# Configure API key authorization: ApplicationPublicKey
|
|
106
99
|
config.api_key['X-Application-Key'] = 'YOUR API KEY'
|
|
107
100
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -110,15 +103,14 @@ Zyphr.configure do |config|
|
|
|
110
103
|
config.configure_faraday_connection { |connection| 'YOUR CONNECTION CONFIG PROC' }
|
|
111
104
|
end
|
|
112
105
|
|
|
113
|
-
api_instance = Zyphr::
|
|
114
|
-
bulk_upsert_auth_email_templates_request = Zyphr::BulkUpsertAuthEmailTemplatesRequest.new # BulkUpsertAuthEmailTemplatesRequest |
|
|
106
|
+
api_instance = Zyphr::AuthEmailOTPApi.new
|
|
115
107
|
|
|
116
108
|
begin
|
|
117
|
-
#
|
|
118
|
-
result = api_instance.
|
|
109
|
+
#Check email OTP availability
|
|
110
|
+
result = api_instance.check_email_otp_availability
|
|
119
111
|
p result
|
|
120
112
|
rescue Zyphr::ApiError => e
|
|
121
|
-
puts "Exception when calling
|
|
113
|
+
puts "Exception when calling AuthEmailOTPApi->check_email_otp_availability: #{e}"
|
|
122
114
|
end
|
|
123
115
|
|
|
124
116
|
```
|
|
@@ -129,6 +121,11 @@ All URIs are relative to *https://api.zyphr.dev/v1*
|
|
|
129
121
|
|
|
130
122
|
Class | Method | HTTP request | Description
|
|
131
123
|
------------ | ------------- | ------------- | -------------
|
|
124
|
+
*Zyphr::AuthEmailOTPApi* | [**check_email_otp_availability**](docs/AuthEmailOTPApi.md#check_email_otp_availability) | **GET** /auth/email-otp/available | Check email OTP availability
|
|
125
|
+
*Zyphr::AuthEmailOTPApi* | [**send_email_otp_login**](docs/AuthEmailOTPApi.md#send_email_otp_login) | **POST** /auth/email-otp/login/send | Send email OTP for login
|
|
126
|
+
*Zyphr::AuthEmailOTPApi* | [**send_email_otp_registration**](docs/AuthEmailOTPApi.md#send_email_otp_registration) | **POST** /auth/email-otp/register/send | Send email OTP for registration
|
|
127
|
+
*Zyphr::AuthEmailOTPApi* | [**verify_email_otp_login**](docs/AuthEmailOTPApi.md#verify_email_otp_login) | **POST** /auth/email-otp/login/verify | Verify email OTP login
|
|
128
|
+
*Zyphr::AuthEmailOTPApi* | [**verify_email_otp_registration**](docs/AuthEmailOTPApi.md#verify_email_otp_registration) | **POST** /auth/email-otp/register/verify | Verify email OTP registration
|
|
132
129
|
*Zyphr::AuthEmailTemplatesApi* | [**bulk_upsert_auth_email_templates**](docs/AuthEmailTemplatesApi.md#bulk_upsert_auth_email_templates) | **PUT** /auth/email-templates | Bulk-upsert auth email templates
|
|
133
130
|
*Zyphr::AuthEmailTemplatesApi* | [**delete_auth_email_template**](docs/AuthEmailTemplatesApi.md#delete_auth_email_template) | **DELETE** /auth/email-templates/{type} | Remove a tenant override
|
|
134
131
|
*Zyphr::AuthEmailTemplatesApi* | [**get_auth_email_template**](docs/AuthEmailTemplatesApi.md#get_auth_email_template) | **GET** /auth/email-templates/{type} | Get an auth email template
|
|
@@ -209,6 +206,7 @@ Class | Method | HTTP request | Description
|
|
|
209
206
|
*Zyphr::DomainsApi* | [**get_domain**](docs/DomainsApi.md#get_domain) | **GET** /domains/{id} | Get a sending domain
|
|
210
207
|
*Zyphr::DomainsApi* | [**get_domain_verification_status**](docs/DomainsApi.md#get_domain_verification_status) | **GET** /domains/{id}/verification-status | Get domain verification status
|
|
211
208
|
*Zyphr::DomainsApi* | [**list_domains**](docs/DomainsApi.md#list_domains) | **GET** /domains | List sending domains
|
|
209
|
+
*Zyphr::DomainsApi* | [**set_domain_inbound**](docs/DomainsApi.md#set_domain_inbound) | **PUT** /domains/{id}/inbound | Enable or disable inbound email for a domain
|
|
212
210
|
*Zyphr::DomainsApi* | [**verify_domain**](docs/DomainsApi.md#verify_domain) | **POST** /domains/{id}/verify | Trigger domain verification
|
|
213
211
|
*Zyphr::EmailsApi* | [**get_email**](docs/EmailsApi.md#get_email) | **GET** /emails/{id} | Get email details
|
|
214
212
|
*Zyphr::EmailsApi* | [**get_email_events**](docs/EmailsApi.md#get_email_events) | **GET** /emails/{id}/events | Get email events
|
|
@@ -219,6 +217,9 @@ Class | Method | HTTP request | Description
|
|
|
219
217
|
*Zyphr::ExecutionsApi* | [**cancel_execution**](docs/ExecutionsApi.md#cancel_execution) | **POST** /executions/{id}/cancel | Cancel a running execution
|
|
220
218
|
*Zyphr::ExecutionsApi* | [**get_execution**](docs/ExecutionsApi.md#get_execution) | **GET** /executions/{id} | Get a workflow execution
|
|
221
219
|
*Zyphr::ExecutionsApi* | [**retry_execution**](docs/ExecutionsApi.md#retry_execution) | **POST** /executions/{id}/retry | Retry a failed or cancelled execution
|
|
220
|
+
*Zyphr::InboundEmailApi* | [**get_inbound_attachment_url**](docs/InboundEmailApi.md#get_inbound_attachment_url) | **GET** /inbound-emails/{id}/attachments/{attachmentId} | Get an attachment download URL
|
|
221
|
+
*Zyphr::InboundEmailApi* | [**get_inbound_email**](docs/InboundEmailApi.md#get_inbound_email) | **GET** /inbound-emails/{id} | Get a received email
|
|
222
|
+
*Zyphr::InboundEmailApi* | [**list_inbound_emails**](docs/InboundEmailApi.md#list_inbound_emails) | **GET** /inbound-emails | List received emails
|
|
222
223
|
*Zyphr::InboxApi* | [**archive_inbox_notification**](docs/InboxApi.md#archive_inbox_notification) | **POST** /inbox/{id}/archive | Archive a notification
|
|
223
224
|
*Zyphr::InboxApi* | [**archive_subscriber_notification**](docs/InboxApi.md#archive_subscriber_notification) | **POST** /subscriber-inbox/{id}/archive | Archive a notification
|
|
224
225
|
*Zyphr::InboxApi* | [**delete_inbox_notification**](docs/InboxApi.md#delete_inbox_notification) | **DELETE** /inbox/{id} | Delete a notification
|
|
@@ -405,6 +406,8 @@ Class | Method | HTTP request | Description
|
|
|
405
406
|
- [Zyphr::Category](docs/Category.md)
|
|
406
407
|
- [Zyphr::CategoryListResponse](docs/CategoryListResponse.md)
|
|
407
408
|
- [Zyphr::CategoryResponse](docs/CategoryResponse.md)
|
|
409
|
+
- [Zyphr::CheckEmailOtpAvailability200Response](docs/CheckEmailOtpAvailability200Response.md)
|
|
410
|
+
- [Zyphr::CheckEmailOtpAvailability200ResponseData](docs/CheckEmailOtpAvailability200ResponseData.md)
|
|
408
411
|
- [Zyphr::ConfirmEmailVerificationRequest](docs/ConfirmEmailVerificationRequest.md)
|
|
409
412
|
- [Zyphr::ConfirmEmailVerificationResponse](docs/ConfirmEmailVerificationResponse.md)
|
|
410
413
|
- [Zyphr::ConfirmEmailVerificationResponseData](docs/ConfirmEmailVerificationResponseData.md)
|
|
@@ -478,6 +481,14 @@ Class | Method | HTTP request | Description
|
|
|
478
481
|
- [Zyphr::GetWaaSEndpoint200Response](docs/GetWaaSEndpoint200Response.md)
|
|
479
482
|
- [Zyphr::GetWaaSUsage200Response](docs/GetWaaSUsage200Response.md)
|
|
480
483
|
- [Zyphr::InAppNotification](docs/InAppNotification.md)
|
|
484
|
+
- [Zyphr::InboundAttachmentUrlResponse](docs/InboundAttachmentUrlResponse.md)
|
|
485
|
+
- [Zyphr::InboundAttachmentUrlResponseData](docs/InboundAttachmentUrlResponseData.md)
|
|
486
|
+
- [Zyphr::InboundEmail](docs/InboundEmail.md)
|
|
487
|
+
- [Zyphr::InboundEmailAttachment](docs/InboundEmailAttachment.md)
|
|
488
|
+
- [Zyphr::InboundEmailFrom](docs/InboundEmailFrom.md)
|
|
489
|
+
- [Zyphr::InboundEmailListResponse](docs/InboundEmailListResponse.md)
|
|
490
|
+
- [Zyphr::InboundEmailListResponseMeta](docs/InboundEmailListResponseMeta.md)
|
|
491
|
+
- [Zyphr::InboundEmailResponse](docs/InboundEmailResponse.md)
|
|
481
492
|
- [Zyphr::InboxListMeta](docs/InboxListMeta.md)
|
|
482
493
|
- [Zyphr::InboxListResponse](docs/InboxListResponse.md)
|
|
483
494
|
- [Zyphr::InboxNotificationResponse](docs/InboxNotificationResponse.md)
|
|
@@ -547,7 +558,6 @@ Class | Method | HTTP request | Description
|
|
|
547
558
|
- [Zyphr::PayloadTooLargeErrorError](docs/PayloadTooLargeErrorError.md)
|
|
548
559
|
- [Zyphr::PayloadTooLargeErrorErrorDetails](docs/PayloadTooLargeErrorErrorDetails.md)
|
|
549
560
|
- [Zyphr::PhoneAuthAvailabilityResponse](docs/PhoneAuthAvailabilityResponse.md)
|
|
550
|
-
- [Zyphr::PhoneAuthAvailabilityResponseData](docs/PhoneAuthAvailabilityResponseData.md)
|
|
551
561
|
- [Zyphr::PhoneLoginVerifyRequest](docs/PhoneLoginVerifyRequest.md)
|
|
552
562
|
- [Zyphr::PhoneOtpSendRequest](docs/PhoneOtpSendRequest.md)
|
|
553
563
|
- [Zyphr::PhoneOtpSentResponse](docs/PhoneOtpSentResponse.md)
|
|
@@ -597,6 +607,7 @@ Class | Method | HTTP request | Description
|
|
|
597
607
|
- [Zyphr::SendBatchSmsData](docs/SendBatchSmsData.md)
|
|
598
608
|
- [Zyphr::SendBatchSmsRequest](docs/SendBatchSmsRequest.md)
|
|
599
609
|
- [Zyphr::SendBatchSmsResponse](docs/SendBatchSmsResponse.md)
|
|
610
|
+
- [Zyphr::SendEmailOtpRegistrationRequest](docs/SendEmailOtpRegistrationRequest.md)
|
|
600
611
|
- [Zyphr::SendEmailRequest](docs/SendEmailRequest.md)
|
|
601
612
|
- [Zyphr::SendEmailResponse](docs/SendEmailResponse.md)
|
|
602
613
|
- [Zyphr::SendEmailResponseData](docs/SendEmailResponseData.md)
|
|
@@ -625,6 +636,7 @@ Class | Method | HTTP request | Description
|
|
|
625
636
|
- [Zyphr::SessionListResponse](docs/SessionListResponse.md)
|
|
626
637
|
- [Zyphr::SessionListResponseData](docs/SessionListResponseData.md)
|
|
627
638
|
- [Zyphr::SessionListResponseDataSessionInfo](docs/SessionListResponseDataSessionInfo.md)
|
|
639
|
+
- [Zyphr::SetDomainInboundRequest](docs/SetDomainInboundRequest.md)
|
|
628
640
|
- [Zyphr::SetPreferencesRequest](docs/SetPreferencesRequest.md)
|
|
629
641
|
- [Zyphr::SetPreferencesRequestPreferencesInner](docs/SetPreferencesRequestPreferencesInner.md)
|
|
630
642
|
- [Zyphr::SignInAnonymouslyRequest](docs/SignInAnonymouslyRequest.md)
|
|
@@ -707,6 +719,8 @@ Class | Method | HTTP request | Description
|
|
|
707
719
|
- [Zyphr::VerificationStatusResponseData](docs/VerificationStatusResponseData.md)
|
|
708
720
|
- [Zyphr::VerifyDomainResponse](docs/VerifyDomainResponse.md)
|
|
709
721
|
- [Zyphr::VerifyDomainResponseData](docs/VerifyDomainResponseData.md)
|
|
722
|
+
- [Zyphr::VerifyEmailOtpLoginRequest](docs/VerifyEmailOtpLoginRequest.md)
|
|
723
|
+
- [Zyphr::VerifyEmailOtpRegistrationRequest](docs/VerifyEmailOtpRegistrationRequest.md)
|
|
710
724
|
- [Zyphr::VerifySmsConfigData](docs/VerifySmsConfigData.md)
|
|
711
725
|
- [Zyphr::VerifySmsConfigResponse](docs/VerifySmsConfigResponse.md)
|
|
712
726
|
- [Zyphr::WaaSApplication](docs/WaaSApplication.md)
|
|
@@ -0,0 +1,384 @@
|
|
|
1
|
+
# Zyphr::AuthEmailOTPApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.zyphr.dev/v1*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**check_email_otp_availability**](AuthEmailOTPApi.md#check_email_otp_availability) | **GET** /auth/email-otp/available | Check email OTP availability |
|
|
8
|
+
| [**send_email_otp_login**](AuthEmailOTPApi.md#send_email_otp_login) | **POST** /auth/email-otp/login/send | Send email OTP for login |
|
|
9
|
+
| [**send_email_otp_registration**](AuthEmailOTPApi.md#send_email_otp_registration) | **POST** /auth/email-otp/register/send | Send email OTP for registration |
|
|
10
|
+
| [**verify_email_otp_login**](AuthEmailOTPApi.md#verify_email_otp_login) | **POST** /auth/email-otp/login/verify | Verify email OTP login |
|
|
11
|
+
| [**verify_email_otp_registration**](AuthEmailOTPApi.md#verify_email_otp_registration) | **POST** /auth/email-otp/register/verify | Verify email OTP registration |
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
## check_email_otp_availability
|
|
15
|
+
|
|
16
|
+
> <CheckEmailOtpAvailability200Response> check_email_otp_availability
|
|
17
|
+
|
|
18
|
+
Check email OTP availability
|
|
19
|
+
|
|
20
|
+
Check if numeric email OTP authentication is available for this application. Requires a verified sending domain on the project.
|
|
21
|
+
|
|
22
|
+
### Examples
|
|
23
|
+
|
|
24
|
+
```ruby
|
|
25
|
+
require 'time'
|
|
26
|
+
require 'zyphr'
|
|
27
|
+
# setup authorization
|
|
28
|
+
Zyphr.configure do |config|
|
|
29
|
+
# Configure API key authorization: ApplicationPublicKey
|
|
30
|
+
config.api_key['X-Application-Key'] = 'YOUR API KEY'
|
|
31
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
32
|
+
# config.api_key_prefix['X-Application-Key'] = 'Bearer'
|
|
33
|
+
end
|
|
34
|
+
|
|
35
|
+
api_instance = Zyphr::AuthEmailOTPApi.new
|
|
36
|
+
|
|
37
|
+
begin
|
|
38
|
+
# Check email OTP availability
|
|
39
|
+
result = api_instance.check_email_otp_availability
|
|
40
|
+
p result
|
|
41
|
+
rescue Zyphr::ApiError => e
|
|
42
|
+
puts "Error when calling AuthEmailOTPApi->check_email_otp_availability: #{e}"
|
|
43
|
+
end
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
#### Using the check_email_otp_availability_with_http_info variant
|
|
47
|
+
|
|
48
|
+
This returns an Array which contains the response data, status code and headers.
|
|
49
|
+
|
|
50
|
+
> <Array(<CheckEmailOtpAvailability200Response>, Integer, Hash)> check_email_otp_availability_with_http_info
|
|
51
|
+
|
|
52
|
+
```ruby
|
|
53
|
+
begin
|
|
54
|
+
# Check email OTP availability
|
|
55
|
+
data, status_code, headers = api_instance.check_email_otp_availability_with_http_info
|
|
56
|
+
p status_code # => 2xx
|
|
57
|
+
p headers # => { ... }
|
|
58
|
+
p data # => <CheckEmailOtpAvailability200Response>
|
|
59
|
+
rescue Zyphr::ApiError => e
|
|
60
|
+
puts "Error when calling AuthEmailOTPApi->check_email_otp_availability_with_http_info: #{e}"
|
|
61
|
+
end
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
### Parameters
|
|
65
|
+
|
|
66
|
+
This endpoint does not need any parameter.
|
|
67
|
+
|
|
68
|
+
### Return type
|
|
69
|
+
|
|
70
|
+
[**CheckEmailOtpAvailability200Response**](CheckEmailOtpAvailability200Response.md)
|
|
71
|
+
|
|
72
|
+
### Authorization
|
|
73
|
+
|
|
74
|
+
[ApplicationPublicKey](../README.md#ApplicationPublicKey)
|
|
75
|
+
|
|
76
|
+
### HTTP request headers
|
|
77
|
+
|
|
78
|
+
- **Content-Type**: Not defined
|
|
79
|
+
- **Accept**: application/json
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
## send_email_otp_login
|
|
83
|
+
|
|
84
|
+
> <PhoneOtpSentResponse> send_email_otp_login(send_email_otp_registration_request)
|
|
85
|
+
|
|
86
|
+
Send email OTP for login
|
|
87
|
+
|
|
88
|
+
Send a numeric verification code to an existing user's email address for login.
|
|
89
|
+
|
|
90
|
+
### Examples
|
|
91
|
+
|
|
92
|
+
```ruby
|
|
93
|
+
require 'time'
|
|
94
|
+
require 'zyphr'
|
|
95
|
+
# setup authorization
|
|
96
|
+
Zyphr.configure do |config|
|
|
97
|
+
# Configure API key authorization: ApplicationSecret
|
|
98
|
+
config.api_key['X-Application-Secret'] = 'YOUR API KEY'
|
|
99
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
100
|
+
# config.api_key_prefix['X-Application-Secret'] = 'Bearer'
|
|
101
|
+
|
|
102
|
+
# Configure API key authorization: ApplicationPublicKey
|
|
103
|
+
config.api_key['X-Application-Key'] = 'YOUR API KEY'
|
|
104
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
105
|
+
# config.api_key_prefix['X-Application-Key'] = 'Bearer'
|
|
106
|
+
end
|
|
107
|
+
|
|
108
|
+
api_instance = Zyphr::AuthEmailOTPApi.new
|
|
109
|
+
send_email_otp_registration_request = Zyphr::SendEmailOtpRegistrationRequest.new({email: 'email_example'}) # SendEmailOtpRegistrationRequest |
|
|
110
|
+
|
|
111
|
+
begin
|
|
112
|
+
# Send email OTP for login
|
|
113
|
+
result = api_instance.send_email_otp_login(send_email_otp_registration_request)
|
|
114
|
+
p result
|
|
115
|
+
rescue Zyphr::ApiError => e
|
|
116
|
+
puts "Error when calling AuthEmailOTPApi->send_email_otp_login: #{e}"
|
|
117
|
+
end
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
#### Using the send_email_otp_login_with_http_info variant
|
|
121
|
+
|
|
122
|
+
This returns an Array which contains the response data, status code and headers.
|
|
123
|
+
|
|
124
|
+
> <Array(<PhoneOtpSentResponse>, Integer, Hash)> send_email_otp_login_with_http_info(send_email_otp_registration_request)
|
|
125
|
+
|
|
126
|
+
```ruby
|
|
127
|
+
begin
|
|
128
|
+
# Send email OTP for login
|
|
129
|
+
data, status_code, headers = api_instance.send_email_otp_login_with_http_info(send_email_otp_registration_request)
|
|
130
|
+
p status_code # => 2xx
|
|
131
|
+
p headers # => { ... }
|
|
132
|
+
p data # => <PhoneOtpSentResponse>
|
|
133
|
+
rescue Zyphr::ApiError => e
|
|
134
|
+
puts "Error when calling AuthEmailOTPApi->send_email_otp_login_with_http_info: #{e}"
|
|
135
|
+
end
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
### Parameters
|
|
139
|
+
|
|
140
|
+
| Name | Type | Description | Notes |
|
|
141
|
+
| ---- | ---- | ----------- | ----- |
|
|
142
|
+
| **send_email_otp_registration_request** | [**SendEmailOtpRegistrationRequest**](SendEmailOtpRegistrationRequest.md) | | |
|
|
143
|
+
|
|
144
|
+
### Return type
|
|
145
|
+
|
|
146
|
+
[**PhoneOtpSentResponse**](PhoneOtpSentResponse.md)
|
|
147
|
+
|
|
148
|
+
### Authorization
|
|
149
|
+
|
|
150
|
+
[ApplicationSecret](../README.md#ApplicationSecret), [ApplicationPublicKey](../README.md#ApplicationPublicKey)
|
|
151
|
+
|
|
152
|
+
### HTTP request headers
|
|
153
|
+
|
|
154
|
+
- **Content-Type**: application/json
|
|
155
|
+
- **Accept**: application/json
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
## send_email_otp_registration
|
|
159
|
+
|
|
160
|
+
> <PhoneOtpSentResponse> send_email_otp_registration(send_email_otp_registration_request)
|
|
161
|
+
|
|
162
|
+
Send email OTP for registration
|
|
163
|
+
|
|
164
|
+
Send a numeric verification code to an email address for new user registration.
|
|
165
|
+
|
|
166
|
+
### Examples
|
|
167
|
+
|
|
168
|
+
```ruby
|
|
169
|
+
require 'time'
|
|
170
|
+
require 'zyphr'
|
|
171
|
+
# setup authorization
|
|
172
|
+
Zyphr.configure do |config|
|
|
173
|
+
# Configure API key authorization: ApplicationSecret
|
|
174
|
+
config.api_key['X-Application-Secret'] = 'YOUR API KEY'
|
|
175
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
176
|
+
# config.api_key_prefix['X-Application-Secret'] = 'Bearer'
|
|
177
|
+
|
|
178
|
+
# Configure API key authorization: ApplicationPublicKey
|
|
179
|
+
config.api_key['X-Application-Key'] = 'YOUR API KEY'
|
|
180
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
181
|
+
# config.api_key_prefix['X-Application-Key'] = 'Bearer'
|
|
182
|
+
end
|
|
183
|
+
|
|
184
|
+
api_instance = Zyphr::AuthEmailOTPApi.new
|
|
185
|
+
send_email_otp_registration_request = Zyphr::SendEmailOtpRegistrationRequest.new({email: 'email_example'}) # SendEmailOtpRegistrationRequest |
|
|
186
|
+
|
|
187
|
+
begin
|
|
188
|
+
# Send email OTP for registration
|
|
189
|
+
result = api_instance.send_email_otp_registration(send_email_otp_registration_request)
|
|
190
|
+
p result
|
|
191
|
+
rescue Zyphr::ApiError => e
|
|
192
|
+
puts "Error when calling AuthEmailOTPApi->send_email_otp_registration: #{e}"
|
|
193
|
+
end
|
|
194
|
+
```
|
|
195
|
+
|
|
196
|
+
#### Using the send_email_otp_registration_with_http_info variant
|
|
197
|
+
|
|
198
|
+
This returns an Array which contains the response data, status code and headers.
|
|
199
|
+
|
|
200
|
+
> <Array(<PhoneOtpSentResponse>, Integer, Hash)> send_email_otp_registration_with_http_info(send_email_otp_registration_request)
|
|
201
|
+
|
|
202
|
+
```ruby
|
|
203
|
+
begin
|
|
204
|
+
# Send email OTP for registration
|
|
205
|
+
data, status_code, headers = api_instance.send_email_otp_registration_with_http_info(send_email_otp_registration_request)
|
|
206
|
+
p status_code # => 2xx
|
|
207
|
+
p headers # => { ... }
|
|
208
|
+
p data # => <PhoneOtpSentResponse>
|
|
209
|
+
rescue Zyphr::ApiError => e
|
|
210
|
+
puts "Error when calling AuthEmailOTPApi->send_email_otp_registration_with_http_info: #{e}"
|
|
211
|
+
end
|
|
212
|
+
```
|
|
213
|
+
|
|
214
|
+
### Parameters
|
|
215
|
+
|
|
216
|
+
| Name | Type | Description | Notes |
|
|
217
|
+
| ---- | ---- | ----------- | ----- |
|
|
218
|
+
| **send_email_otp_registration_request** | [**SendEmailOtpRegistrationRequest**](SendEmailOtpRegistrationRequest.md) | | |
|
|
219
|
+
|
|
220
|
+
### Return type
|
|
221
|
+
|
|
222
|
+
[**PhoneOtpSentResponse**](PhoneOtpSentResponse.md)
|
|
223
|
+
|
|
224
|
+
### Authorization
|
|
225
|
+
|
|
226
|
+
[ApplicationSecret](../README.md#ApplicationSecret), [ApplicationPublicKey](../README.md#ApplicationPublicKey)
|
|
227
|
+
|
|
228
|
+
### HTTP request headers
|
|
229
|
+
|
|
230
|
+
- **Content-Type**: application/json
|
|
231
|
+
- **Accept**: application/json
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
## verify_email_otp_login
|
|
235
|
+
|
|
236
|
+
> <AuthLoginResponse> verify_email_otp_login(verify_email_otp_login_request)
|
|
237
|
+
|
|
238
|
+
Verify email OTP login
|
|
239
|
+
|
|
240
|
+
Verify the numeric code and login an existing user. If MFA is enabled, returns mfa_required with a challenge token.
|
|
241
|
+
|
|
242
|
+
### Examples
|
|
243
|
+
|
|
244
|
+
```ruby
|
|
245
|
+
require 'time'
|
|
246
|
+
require 'zyphr'
|
|
247
|
+
# setup authorization
|
|
248
|
+
Zyphr.configure do |config|
|
|
249
|
+
# Configure API key authorization: ApplicationSecret
|
|
250
|
+
config.api_key['X-Application-Secret'] = 'YOUR API KEY'
|
|
251
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
252
|
+
# config.api_key_prefix['X-Application-Secret'] = 'Bearer'
|
|
253
|
+
|
|
254
|
+
# Configure API key authorization: ApplicationPublicKey
|
|
255
|
+
config.api_key['X-Application-Key'] = 'YOUR API KEY'
|
|
256
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
257
|
+
# config.api_key_prefix['X-Application-Key'] = 'Bearer'
|
|
258
|
+
end
|
|
259
|
+
|
|
260
|
+
api_instance = Zyphr::AuthEmailOTPApi.new
|
|
261
|
+
verify_email_otp_login_request = Zyphr::VerifyEmailOtpLoginRequest.new({email: 'email_example', code: 'code_example'}) # VerifyEmailOtpLoginRequest |
|
|
262
|
+
|
|
263
|
+
begin
|
|
264
|
+
# Verify email OTP login
|
|
265
|
+
result = api_instance.verify_email_otp_login(verify_email_otp_login_request)
|
|
266
|
+
p result
|
|
267
|
+
rescue Zyphr::ApiError => e
|
|
268
|
+
puts "Error when calling AuthEmailOTPApi->verify_email_otp_login: #{e}"
|
|
269
|
+
end
|
|
270
|
+
```
|
|
271
|
+
|
|
272
|
+
#### Using the verify_email_otp_login_with_http_info variant
|
|
273
|
+
|
|
274
|
+
This returns an Array which contains the response data, status code and headers.
|
|
275
|
+
|
|
276
|
+
> <Array(<AuthLoginResponse>, Integer, Hash)> verify_email_otp_login_with_http_info(verify_email_otp_login_request)
|
|
277
|
+
|
|
278
|
+
```ruby
|
|
279
|
+
begin
|
|
280
|
+
# Verify email OTP login
|
|
281
|
+
data, status_code, headers = api_instance.verify_email_otp_login_with_http_info(verify_email_otp_login_request)
|
|
282
|
+
p status_code # => 2xx
|
|
283
|
+
p headers # => { ... }
|
|
284
|
+
p data # => <AuthLoginResponse>
|
|
285
|
+
rescue Zyphr::ApiError => e
|
|
286
|
+
puts "Error when calling AuthEmailOTPApi->verify_email_otp_login_with_http_info: #{e}"
|
|
287
|
+
end
|
|
288
|
+
```
|
|
289
|
+
|
|
290
|
+
### Parameters
|
|
291
|
+
|
|
292
|
+
| Name | Type | Description | Notes |
|
|
293
|
+
| ---- | ---- | ----------- | ----- |
|
|
294
|
+
| **verify_email_otp_login_request** | [**VerifyEmailOtpLoginRequest**](VerifyEmailOtpLoginRequest.md) | | |
|
|
295
|
+
|
|
296
|
+
### Return type
|
|
297
|
+
|
|
298
|
+
[**AuthLoginResponse**](AuthLoginResponse.md)
|
|
299
|
+
|
|
300
|
+
### Authorization
|
|
301
|
+
|
|
302
|
+
[ApplicationSecret](../README.md#ApplicationSecret), [ApplicationPublicKey](../README.md#ApplicationPublicKey)
|
|
303
|
+
|
|
304
|
+
### HTTP request headers
|
|
305
|
+
|
|
306
|
+
- **Content-Type**: application/json
|
|
307
|
+
- **Accept**: application/json
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
## verify_email_otp_registration
|
|
311
|
+
|
|
312
|
+
> <AuthResultResponse> verify_email_otp_registration(verify_email_otp_registration_request)
|
|
313
|
+
|
|
314
|
+
Verify email OTP registration
|
|
315
|
+
|
|
316
|
+
Verify the numeric code and create a new user account with the email address.
|
|
317
|
+
|
|
318
|
+
### Examples
|
|
319
|
+
|
|
320
|
+
```ruby
|
|
321
|
+
require 'time'
|
|
322
|
+
require 'zyphr'
|
|
323
|
+
# setup authorization
|
|
324
|
+
Zyphr.configure do |config|
|
|
325
|
+
# Configure API key authorization: ApplicationSecret
|
|
326
|
+
config.api_key['X-Application-Secret'] = 'YOUR API KEY'
|
|
327
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
328
|
+
# config.api_key_prefix['X-Application-Secret'] = 'Bearer'
|
|
329
|
+
|
|
330
|
+
# Configure API key authorization: ApplicationPublicKey
|
|
331
|
+
config.api_key['X-Application-Key'] = 'YOUR API KEY'
|
|
332
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
333
|
+
# config.api_key_prefix['X-Application-Key'] = 'Bearer'
|
|
334
|
+
end
|
|
335
|
+
|
|
336
|
+
api_instance = Zyphr::AuthEmailOTPApi.new
|
|
337
|
+
verify_email_otp_registration_request = Zyphr::VerifyEmailOtpRegistrationRequest.new({email: 'email_example', code: 'code_example'}) # VerifyEmailOtpRegistrationRequest |
|
|
338
|
+
|
|
339
|
+
begin
|
|
340
|
+
# Verify email OTP registration
|
|
341
|
+
result = api_instance.verify_email_otp_registration(verify_email_otp_registration_request)
|
|
342
|
+
p result
|
|
343
|
+
rescue Zyphr::ApiError => e
|
|
344
|
+
puts "Error when calling AuthEmailOTPApi->verify_email_otp_registration: #{e}"
|
|
345
|
+
end
|
|
346
|
+
```
|
|
347
|
+
|
|
348
|
+
#### Using the verify_email_otp_registration_with_http_info variant
|
|
349
|
+
|
|
350
|
+
This returns an Array which contains the response data, status code and headers.
|
|
351
|
+
|
|
352
|
+
> <Array(<AuthResultResponse>, Integer, Hash)> verify_email_otp_registration_with_http_info(verify_email_otp_registration_request)
|
|
353
|
+
|
|
354
|
+
```ruby
|
|
355
|
+
begin
|
|
356
|
+
# Verify email OTP registration
|
|
357
|
+
data, status_code, headers = api_instance.verify_email_otp_registration_with_http_info(verify_email_otp_registration_request)
|
|
358
|
+
p status_code # => 2xx
|
|
359
|
+
p headers # => { ... }
|
|
360
|
+
p data # => <AuthResultResponse>
|
|
361
|
+
rescue Zyphr::ApiError => e
|
|
362
|
+
puts "Error when calling AuthEmailOTPApi->verify_email_otp_registration_with_http_info: #{e}"
|
|
363
|
+
end
|
|
364
|
+
```
|
|
365
|
+
|
|
366
|
+
### Parameters
|
|
367
|
+
|
|
368
|
+
| Name | Type | Description | Notes |
|
|
369
|
+
| ---- | ---- | ----------- | ----- |
|
|
370
|
+
| **verify_email_otp_registration_request** | [**VerifyEmailOtpRegistrationRequest**](VerifyEmailOtpRegistrationRequest.md) | | |
|
|
371
|
+
|
|
372
|
+
### Return type
|
|
373
|
+
|
|
374
|
+
[**AuthResultResponse**](AuthResultResponse.md)
|
|
375
|
+
|
|
376
|
+
### Authorization
|
|
377
|
+
|
|
378
|
+
[ApplicationSecret](../README.md#ApplicationSecret), [ApplicationPublicKey](../README.md#ApplicationPublicKey)
|
|
379
|
+
|
|
380
|
+
### HTTP request headers
|
|
381
|
+
|
|
382
|
+
- **Content-Type**: application/json
|
|
383
|
+
- **Accept**: application/json
|
|
384
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Zyphr::CheckEmailOtpAvailability200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **data** | [**CheckEmailOtpAvailability200ResponseData**](CheckEmailOtpAvailability200ResponseData.md) | | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'zyphr'
|
|
13
|
+
|
|
14
|
+
instance = Zyphr::CheckEmailOtpAvailability200Response.new(
|
|
15
|
+
data: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
data/docs/{PhoneAuthAvailabilityResponseData.md → CheckEmailOtpAvailability200ResponseData.md}
RENAMED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# Zyphr::
|
|
1
|
+
# Zyphr::CheckEmailOtpAvailability200ResponseData
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
```ruby
|
|
13
13
|
require 'zyphr'
|
|
14
14
|
|
|
15
|
-
instance = Zyphr::
|
|
15
|
+
instance = Zyphr::CheckEmailOtpAvailability200ResponseData.new(
|
|
16
16
|
available: null,
|
|
17
17
|
message: null
|
|
18
18
|
)
|
data/docs/DomainsApi.md
CHANGED
|
@@ -9,6 +9,7 @@ All URIs are relative to *https://api.zyphr.dev/v1*
|
|
|
9
9
|
| [**get_domain**](DomainsApi.md#get_domain) | **GET** /domains/{id} | Get a sending domain |
|
|
10
10
|
| [**get_domain_verification_status**](DomainsApi.md#get_domain_verification_status) | **GET** /domains/{id}/verification-status | Get domain verification status |
|
|
11
11
|
| [**list_domains**](DomainsApi.md#list_domains) | **GET** /domains | List sending domains |
|
|
12
|
+
| [**set_domain_inbound**](DomainsApi.md#set_domain_inbound) | **PUT** /domains/{id}/inbound | Enable or disable inbound email for a domain |
|
|
12
13
|
| [**verify_domain**](DomainsApi.md#verify_domain) | **POST** /domains/{id}/verify | Trigger domain verification |
|
|
13
14
|
|
|
14
15
|
|
|
@@ -364,6 +365,78 @@ This endpoint does not need any parameter.
|
|
|
364
365
|
- **Accept**: application/json
|
|
365
366
|
|
|
366
367
|
|
|
368
|
+
## set_domain_inbound
|
|
369
|
+
|
|
370
|
+
> set_domain_inbound(id, set_domain_inbound_request)
|
|
371
|
+
|
|
372
|
+
Enable or disable inbound email for a domain
|
|
373
|
+
|
|
374
|
+
Toggle email receiving for a domain. When enabled, the domain's DNS records gain an MX record on the `inbound.` subdomain that the tenant must publish. Requires a plan with inbound email (Starter+).
|
|
375
|
+
|
|
376
|
+
### Examples
|
|
377
|
+
|
|
378
|
+
```ruby
|
|
379
|
+
require 'time'
|
|
380
|
+
require 'zyphr'
|
|
381
|
+
# setup authorization
|
|
382
|
+
Zyphr.configure do |config|
|
|
383
|
+
# Configure API key authorization: ApiKeyAuth
|
|
384
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
385
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
386
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
387
|
+
end
|
|
388
|
+
|
|
389
|
+
api_instance = Zyphr::DomainsApi.new
|
|
390
|
+
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
391
|
+
set_domain_inbound_request = Zyphr::SetDomainInboundRequest.new # SetDomainInboundRequest |
|
|
392
|
+
|
|
393
|
+
begin
|
|
394
|
+
# Enable or disable inbound email for a domain
|
|
395
|
+
api_instance.set_domain_inbound(id, set_domain_inbound_request)
|
|
396
|
+
rescue Zyphr::ApiError => e
|
|
397
|
+
puts "Error when calling DomainsApi->set_domain_inbound: #{e}"
|
|
398
|
+
end
|
|
399
|
+
```
|
|
400
|
+
|
|
401
|
+
#### Using the set_domain_inbound_with_http_info variant
|
|
402
|
+
|
|
403
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
404
|
+
|
|
405
|
+
> <Array(nil, Integer, Hash)> set_domain_inbound_with_http_info(id, set_domain_inbound_request)
|
|
406
|
+
|
|
407
|
+
```ruby
|
|
408
|
+
begin
|
|
409
|
+
# Enable or disable inbound email for a domain
|
|
410
|
+
data, status_code, headers = api_instance.set_domain_inbound_with_http_info(id, set_domain_inbound_request)
|
|
411
|
+
p status_code # => 2xx
|
|
412
|
+
p headers # => { ... }
|
|
413
|
+
p data # => nil
|
|
414
|
+
rescue Zyphr::ApiError => e
|
|
415
|
+
puts "Error when calling DomainsApi->set_domain_inbound_with_http_info: #{e}"
|
|
416
|
+
end
|
|
417
|
+
```
|
|
418
|
+
|
|
419
|
+
### Parameters
|
|
420
|
+
|
|
421
|
+
| Name | Type | Description | Notes |
|
|
422
|
+
| ---- | ---- | ----------- | ----- |
|
|
423
|
+
| **id** | **String** | | |
|
|
424
|
+
| **set_domain_inbound_request** | [**SetDomainInboundRequest**](SetDomainInboundRequest.md) | | |
|
|
425
|
+
|
|
426
|
+
### Return type
|
|
427
|
+
|
|
428
|
+
nil (empty response body)
|
|
429
|
+
|
|
430
|
+
### Authorization
|
|
431
|
+
|
|
432
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
433
|
+
|
|
434
|
+
### HTTP request headers
|
|
435
|
+
|
|
436
|
+
- **Content-Type**: application/json
|
|
437
|
+
- **Accept**: Not defined
|
|
438
|
+
|
|
439
|
+
|
|
367
440
|
## verify_domain
|
|
368
441
|
|
|
369
442
|
> <VerifyDomainResponse> verify_domain(id)
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Zyphr::InboundAttachmentUrlResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **data** | [**InboundAttachmentUrlResponseData**](InboundAttachmentUrlResponseData.md) | | [optional] |
|
|
8
|
+
| **meta** | [**RequestMeta**](RequestMeta.md) | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'zyphr'
|
|
14
|
+
|
|
15
|
+
instance = Zyphr::InboundAttachmentUrlResponse.new(
|
|
16
|
+
data: null,
|
|
17
|
+
meta: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Zyphr::InboundAttachmentUrlResponseData
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **download_url** | **String** | Short-lived presigned S3 download URL | [optional] |
|
|
8
|
+
| **filename** | **String** | | [optional] |
|
|
9
|
+
| **content_type** | **String** | | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'zyphr'
|
|
15
|
+
|
|
16
|
+
instance = Zyphr::InboundAttachmentUrlResponseData.new(
|
|
17
|
+
download_url: null,
|
|
18
|
+
filename: null,
|
|
19
|
+
content_type: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|